OpenAPIClient-php

This is the Stateset One API based on The OpenAPI Specification.

Introduction

This API definition is intended to to be a good starting point for describing your API in OpenAPI/Swagger format.

OpenAPI Specification

The goal of The OpenAPI Specification is to define a standard, language-agnostic interface to REST APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. When properly defined via OpenAPI, a consumer can understand and interact with the remote service with a minimal amount of implementation logic. Similar to what interfaces have done for lower-level programming, OpenAPI removes the guesswork in calling the service.

For more information, please visit http://stateset.com/support.

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

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



// Configure API key authorization: api_key
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('api_key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_key', 'Bearer');

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


$apiInstance = new OpenAPI\Client\Api\AccountsApi(
    // 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
);
$limit = 3.4; // float | The number of items to return
$offset = 3.4; // float | Filter users without email
$order_direction = 'order_direction_example'; // string | Direction to return accounts

try {
    $result = $apiInstance->getAccountByName($limit, $offset, $order_direction);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountsApi->getAccountByName: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.stateset.com/v1

Class	Method	HTTP request	Description
AccountsApi	getAccountByName	GET /accounts	Get account by account name
AccountsApi	getAccountByName_0	GET /accounts/{id}	Get account by account name
BillOfMaterialsApi	createBillofMaterials	POST /billofmaterials	Create a new bill of materials
BillOfMaterialsApi	deleteBillOfMaterials	DELETE /billofmaterials/{id}	Delete Bill of Materials
BillOfMaterialsApi	getBillOfMaterialsById	GET /billofmaterials/{id}	Get bill of materials by id
BillOfMaterialsApi	getBillofMaterials	GET /billofmaterials	Get bill of materials
BillOfMaterialsApi	updateBillOfMaterials	PUT /billofmaterials/{id}	Updated bill of materials
BillOfMaterialsLineItemsApi	getBillOfMaterialsItemById	GET /billofmaterialsitems	Get bill of materials item by id
BillOfMaterialsLineItemsApi	getBillOfMaterialsLineItemById	GET /billofmaterialsitems/{id}	Get bill of materials line item by id
BillOfMaterialsLineItemsApi	updateBillOfMaterialsLineItem	PUT /billofmaterialsitems/{id}	Updated billofmaterials line item
CustomersApi	deleteCustomers	DELETE /customers/{id}	Delete customers
CustomersApi	getCustomers	GET /customers	Get customer by id
CustomersApi	updateCustomers	PUT /customers/{id}	Update customers
InventoryItemsApi	createInventoryItems	POST /inventoryitems	Create a new inventory items
InventoryItemsApi	getInventoryItemById	GET /inventoryitems/{id}	Get inventory items by id
InventoryItemsApi	getInventoryItems	GET /inventoryitems	Get inventory items
InventoryItemsApi	updateInventoryItem	PUT /inventoryitems/{id}	Updated inventory items
ManufactureOrderLineItemsApi	getManufactureItemById	GET /manufactureorderitems	Get manufactureItem by id
ManufactureOrderLineItemsApi	getManufactureLineItemById	GET /manufactureorderitems/{id}	Get manufacture line item by id
ManufactureOrderLineItemsApi	updateManufactureLineItem	PUT /manufactureorderitems/{id}	Updated manufacture line item
ManufactureOrdersApi	getManufactureOrderById	GET /manufactureorders/{id}	Get manufacture order by id
ManufactureOrdersApi	getManufactureOrders	GET /manufactureorders	Get account by manufacture order id
ManufactureOrdersApi	updateManufactureOrder	PUT /manufactureorders/{id}	Updated manufacture order
MessagesApi	createMessage	POST /messages	Create a new message
MessagesApi	deleteMessage	DELETE /messages/{id}	Delete message
MessagesApi	getMessageById	GET /messages/{id}	Get message by id
MessagesApi	getMessages	GET /messages	Get messages
MessagesApi	updateMessage	PUT /messages/{id}	Updated message
NotesApi	createNote	POST /notes	Create a new note
NotesApi	deleteInventoryItem	DELETE /inventoryitems/{id}	Delete Inventory Items
NotesApi	deleteNotes	DELETE /notes/{id}	Delete notes
NotesApi	getCustomersById	GET /customers/{id}	Get customers by id
NotesApi	getNotes	GET /notes	Get notes
NotesApi	getNotesById	GET /notes/{id}	Get notes by id
NotesApi	updateNotes	PUT /notes/{id}	Updated notes
ReturnLineItemsApi	getReturnItemById	GET /returnitems	Get returnItem by id
ReturnLineItemsApi	getReturnLineItemById	GET /returnitems/{id}	Get return line item by id
ReturnLineItemsApi	updateReturnLineItem	PUT /returnitems/{id}	Updated return line item
ReturnsApi	createReturn	POST /returns	Create a new return
ReturnsApi	deleteReturn	DELETE /returns/{id}	Delete return
ReturnsApi	getReturnById	GET /returns/{id}	Get return by id
ReturnsApi	getReturns	GET /returns	Get returns
ReturnsApi	updateReturn	PUT /returns/{id}	Updated return
WarrantiesApi	createWarranty	POST /warranties	Create a new warranty
WarrantiesApi	getWarranties	GET /warranties	Get warranties
WarrantyApi	deleteWarranty	DELETE /warranties/{id}	Delete warranty
WarrantyApi	getWarrantyById	GET /warranties/{id}	Get warranty by id
WarrantyApi	updateWarranty	PUT /warranties/{id}	Updated warranty
WarrantyLineItemsApi	getWarrantyItemById	GET /warrantyitems	Get warrantyItem by id
WarrantyLineItemsApi	getWarrantyLineItemById	GET /warrantyitems/{id}	Get warranty line item by id
WarrantyLineItemsApi	updateWarrantyLineItem	PUT /warrantyitems/{id}	Updated warranty line item
WorkOrderLineItemsApi	getWorkItemById	GET /workorderitems	Get work order item by id
WorkOrderLineItemsApi	getWorkLineItemById	GET /workorderitems/{id}	Get work line item by id
WorkOrderLineItemsApi	updateWorkLineItem	PUT /workorderitems/{id}	Updated work line item
WorkOrdersApi	getWorkOrderById	GET /workorders/{id}	Get work order by id
WorkOrdersApi	getWorkOrdes	GET /workorders	Get account by work order id
WorkOrdersApi	updateWorkOrder	PUT /workorders/{id}	Updated work order

Models

• Accounts
• BillOfMaterials
• BillOfMaterialsLineItem
• Customers
• InventoryItems
• ManufactureOrder
• ManufactureOrderLineItem
• Messages
• ModelReturn
• Notes
• Problem
• ReturnItem
• Warranty
• WarrantyItem
• WorkOrder
• WorkOrderLineItems

Authorization

Authentication schemes defined for the API:

main_auth

• Type: OAuth
• Flow: implicit
• Authorization URL: https://api.stateset.com/v1/oauth/dialog
• Scopes:
  • read:users: read users info
  • write:users: modify or remove users

api_key

• Type: API key
• API key parameter name: api_key
• Location: HTTP header

basic_auth

• Type: HTTP basic authentication

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

[email protected]

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Build package: org.openapitools.codegen.languages.PhpClientCodegen