spinen/connectwise-procurement-php-client

Spinen's PHP ConnectWise Client for Procurement API generated by Swagger Code Generator.

dev-master 2017-09-06 18:29 UTC

Requires

• php: >=5.6
• ext-curl: *
• ext-json: *
• ext-mbstring: *

Requires (Dev)

• friendsofphp/php-cs-fixer: ~1.12
• phpunit/phpunit: ~4.8
• satooshi/php-coveralls: ~1.0
• squizlabs/php_codesniffer: ~2.6

mit

• Spinen
• Swagger and contributors

• api
• client
• sdk
• spinen
• connectwise

README

ConnectWise Procurement API

This PHP package is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 3.0.0-beta
• Build package: io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.6.0 and later

Installation & Usage

Composer

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

composer require spinen/connectwise-procurement-php-client

Or modify your composer.json file:

{
    "require": {
        "spinen/connectwise-procurement-php-client": "^3.0.0-beta"
    }
}

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/connectwise-procurement-php-client/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

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

// Configure HTTP basic authorization: BasicAuth
Spinen\ConnectWise\Clients\Procurement\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Spinen\ConnectWise\Clients\Procurement\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Spinen\ConnectWise\Clients\Procurement\Api\AdjustmentDetailsApi();
$id = 56; // int | 
$conditions = "conditions_example"; // string | 

try {
    $result = $api_instance->procurementAdjustmentsIdDetailsCountGet($id, $conditions);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdjustmentDetailsApi->procurementAdjustmentsIdDetailsCountGet: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://api-na.myconnectwise.net/v4_6_release/apis/3.0

Class	Method	HTTP request	Description
AdjustmentDetailsApi	procurementAdjustmentsIdDetailsCountGet	GET /procurement/adjustments/{id}/details/count
AdjustmentDetailsApi	procurementAdjustmentsIdDetailsDetailIdDelete	DELETE /procurement/adjustments/{id}/details/{detailId}
AdjustmentDetailsApi	procurementAdjustmentsIdDetailsDetailIdGet	GET /procurement/adjustments/{id}/details/{detailId}
AdjustmentDetailsApi	procurementAdjustmentsIdDetailsGet	GET /procurement/adjustments/{id}/details
AdjustmentDetailsApi	procurementAdjustmentsIdDetailsPost	POST /procurement/adjustments/{id}/details
AdjustmentTypesApi	procurementAdjustmentsTypesCountGet	GET /procurement/adjustments/types/count
AdjustmentTypesApi	procurementAdjustmentsTypesGet	GET /procurement/adjustments/types
AdjustmentTypesApi	procurementAdjustmentsTypesIdDelete	DELETE /procurement/adjustments/types/{id}
AdjustmentTypesApi	procurementAdjustmentsTypesIdGet	GET /procurement/adjustments/types/{id}
AdjustmentTypesApi	procurementAdjustmentsTypesIdPatch	PATCH /procurement/adjustments/types/{id}
AdjustmentTypesApi	procurementAdjustmentsTypesIdPut	PUT /procurement/adjustments/types/{id}
AdjustmentTypesApi	procurementAdjustmentsTypesPost	POST /procurement/adjustments/types
AdjustmentsApi	procurementAdjustmentsCountGet	GET /procurement/adjustments/count
AdjustmentsApi	procurementAdjustmentsGet	GET /procurement/adjustments
AdjustmentsApi	procurementAdjustmentsIdDelete	DELETE /procurement/adjustments/{id}
AdjustmentsApi	procurementAdjustmentsIdGet	GET /procurement/adjustments/{id}
AdjustmentsApi	procurementAdjustmentsIdPatch	PATCH /procurement/adjustments/{id}
AdjustmentsApi	procurementAdjustmentsIdPut	PUT /procurement/adjustments/{id}
AdjustmentsApi	procurementAdjustmentsPost	POST /procurement/adjustments
CatalogComponentsApi	procurementCatalogIdComponentsComponentIdDelete	DELETE /procurement/catalog/{id}/components/{componentId}
CatalogComponentsApi	procurementCatalogIdComponentsComponentIdGet	GET /procurement/catalog/{id}/components/{componentId}
CatalogComponentsApi	procurementCatalogIdComponentsComponentIdPatch	PATCH /procurement/catalog/{id}/components/{componentId}
CatalogComponentsApi	procurementCatalogIdComponentsComponentIdPut	PUT /procurement/catalog/{id}/components/{componentId}
CatalogComponentsApi	procurementCatalogIdComponentsCountGet	GET /procurement/catalog/{id}/components/count
CatalogComponentsApi	procurementCatalogIdComponentsGet	GET /procurement/catalog/{id}/components
CatalogComponentsApi	procurementCatalogIdComponentsPost	POST /procurement/catalog/{id}/components
CatalogsItemApi	procurementCatalogCatalogItemIdentifierQuantityOnHandGet	GET /procurement/catalog/{catalogItemIdentifier}/quantityOnHand
CatalogsItemApi	procurementCatalogCountGet	GET /procurement/catalog/count
CatalogsItemApi	procurementCatalogGet	GET /procurement/catalog
CatalogsItemApi	procurementCatalogIdDelete	DELETE /procurement/catalog/{id}
CatalogsItemApi	procurementCatalogIdGet	GET /procurement/catalog/{id}
CatalogsItemApi	procurementCatalogIdPatch	PATCH /procurement/catalog/{id}
CatalogsItemApi	procurementCatalogIdPut	PUT /procurement/catalog/{id}
CatalogsItemApi	procurementCatalogPost	POST /procurement/catalog
CategoriesApi	procurementCategoriesCountGet	GET /procurement/categories/count
CategoriesApi	procurementCategoriesGet	GET /procurement/categories
CategoriesApi	procurementCategoriesIdDelete	DELETE /procurement/categories/{id}
CategoriesApi	procurementCategoriesIdGet	GET /procurement/categories/{id}
CategoriesApi	procurementCategoriesIdPatch	PATCH /procurement/categories/{id}
CategoriesApi	procurementCategoriesIdPut	PUT /procurement/categories/{id}
CategoriesApi	procurementCategoriesPost	POST /procurement/categories
ManufacturersApi	procurementManufacturersCountGet	GET /procurement/manufacturers/count
ManufacturersApi	procurementManufacturersGet	GET /procurement/manufacturers
ManufacturersApi	procurementManufacturersIdDelete	DELETE /procurement/manufacturers/{id}
ManufacturersApi	procurementManufacturersIdGet	GET /procurement/manufacturers/{id}
ManufacturersApi	procurementManufacturersIdPatch	PATCH /procurement/manufacturers/{id}
ManufacturersApi	procurementManufacturersIdPut	PUT /procurement/manufacturers/{id}
ManufacturersApi	procurementManufacturersPost	POST /procurement/manufacturers
PricingBreaksApi	procurementPricingschedulesSchedIdDetailsDetailIdBreaksBreakIdDelete	DELETE /procurement/pricingschedules/{schedId}/details/{detailId}/breaks/{breakId}
PricingBreaksApi	procurementPricingschedulesSchedIdDetailsDetailIdBreaksBreakIdGet	GET /procurement/pricingschedules/{schedId}/details/{detailId}/breaks/{breakId}
PricingBreaksApi	procurementPricingschedulesSchedIdDetailsDetailIdBreaksBreakIdPatch	PATCH /procurement/pricingschedules/{schedId}/details/{detailId}/breaks/{breakId}
PricingBreaksApi	procurementPricingschedulesSchedIdDetailsDetailIdBreaksBreakIdPut	PUT /procurement/pricingschedules/{schedId}/details/{detailId}/breaks/{breakId}
PricingBreaksApi	procurementPricingschedulesSchedIdDetailsDetailIdBreaksCountGet	GET /procurement/pricingschedules/{schedId}/details/{detailId}/breaks/count
PricingBreaksApi	procurementPricingschedulesSchedIdDetailsDetailIdBreaksGet	GET /procurement/pricingschedules/{schedId}/details/{detailId}/breaks
PricingBreaksApi	procurementPricingschedulesSchedIdDetailsDetailIdBreaksPost	POST /procurement/pricingschedules/{schedId}/details/{detailId}/breaks
PricingDetailsApi	procurementPricingschedulesIdDetailsCountGet	GET /procurement/pricingschedules/{id}/details/count
PricingDetailsApi	procurementPricingschedulesIdDetailsDetailIDDelete	DELETE /procurement/pricingschedules/{id}/details/{detailID}
PricingDetailsApi	procurementPricingschedulesIdDetailsDetailIDGet	GET /procurement/pricingschedules/{id}/details/{detailID}
PricingDetailsApi	procurementPricingschedulesIdDetailsDetailIDPatch	PATCH /procurement/pricingschedules/{id}/details/{detailID}
PricingDetailsApi	procurementPricingschedulesIdDetailsDetailIDPut	PUT /procurement/pricingschedules/{id}/details/{detailID}
PricingDetailsApi	procurementPricingschedulesIdDetailsGet	GET /procurement/pricingschedules/{id}/details
PricingDetailsApi	procurementPricingschedulesIdDetailsPost	POST /procurement/pricingschedules/{id}/details
PricingSchedulesApi	procurementPricingschedulesCountGet	GET /procurement/pricingschedules/count
PricingSchedulesApi	procurementPricingschedulesGet	GET /procurement/pricingschedules
PricingSchedulesApi	procurementPricingschedulesIdDelete	DELETE /procurement/pricingschedules/{id}
PricingSchedulesApi	procurementPricingschedulesIdGet	GET /procurement/pricingschedules/{id}
PricingSchedulesApi	procurementPricingschedulesIdPatch	PATCH /procurement/pricingschedules/{id}
PricingSchedulesApi	procurementPricingschedulesIdPut	PUT /procurement/pricingschedules/{id}
PricingSchedulesApi	procurementPricingschedulesPost	POST /procurement/pricingschedules
ProductComponentsApi	procurementProductsIdComponentsComponentIdDelete	DELETE /procurement/products/{id}/components/{componentId}
ProductComponentsApi	procurementProductsIdComponentsComponentIdGet	GET /procurement/products/{id}/components/{componentId}
ProductComponentsApi	procurementProductsIdComponentsComponentIdPatch	PATCH /procurement/products/{id}/components/{componentId}
ProductComponentsApi	procurementProductsIdComponentsComponentIdPut	PUT /procurement/products/{id}/components/{componentId}
ProductComponentsApi	procurementProductsIdComponentsCountGet	GET /procurement/products/{id}/components/count
ProductComponentsApi	procurementProductsIdComponentsGet	GET /procurement/products/{id}/components
ProductComponentsApi	procurementProductsIdComponentsPost	POST /procurement/products/{id}/components
ProductPickingShippingDetailsApi	procurementProductsIdPickingShippingDetailsCountGet	GET /procurement/products/{id}/pickingShippingDetails/count
ProductPickingShippingDetailsApi	procurementProductsIdPickingShippingDetailsGet	GET /procurement/products/{id}/pickingShippingDetails
ProductPickingShippingDetailsApi	procurementProductsIdPickingShippingDetailsPickingShippingDetailIdDelete	DELETE /procurement/products/{id}/pickingShippingDetails/{pickingShippingDetailId}
ProductPickingShippingDetailsApi	procurementProductsIdPickingShippingDetailsPickingShippingDetailIdGet	GET /procurement/products/{id}/pickingShippingDetails/{pickingShippingDetailId}
ProductPickingShippingDetailsApi	procurementProductsIdPickingShippingDetailsPickingShippingDetailIdPatch	PATCH /procurement/products/{id}/pickingShippingDetails/{pickingShippingDetailId}
ProductPickingShippingDetailsApi	procurementProductsIdPickingShippingDetailsPickingShippingDetailIdPut	PUT /procurement/products/{id}/pickingShippingDetails/{pickingShippingDetailId}
ProductPickingShippingDetailsApi	procurementProductsIdPickingShippingDetailsPost	POST /procurement/products/{id}/pickingShippingDetails
ProductTypesApi	procurementTypesCountGet	GET /procurement/types/count
ProductTypesApi	procurementTypesGet	GET /procurement/types
ProductTypesApi	procurementTypesIdDelete	DELETE /procurement/types/{id}
ProductTypesApi	procurementTypesIdGet	GET /procurement/types/{id}
ProductTypesApi	procurementTypesIdPatch	PATCH /procurement/types/{id}
ProductTypesApi	procurementTypesIdPut	PUT /procurement/types/{id}
ProductTypesApi	procurementTypesPost	POST /procurement/types
ProductsItemApi	procurementProductsCountGet	GET /procurement/products/count
ProductsItemApi	procurementProductsGet	GET /procurement/products
ProductsItemApi	procurementProductsIdDelete	DELETE /procurement/products/{id}
ProductsItemApi	procurementProductsIdGet	GET /procurement/products/{id}
ProductsItemApi	procurementProductsIdPatch	PATCH /procurement/products/{id}
ProductsItemApi	procurementProductsIdPut	PUT /procurement/products/{id}
ProductsItemApi	procurementProductsPost	POST /procurement/products
PurchaseOrderLineItemsApi	procurementPurchaseordersIdLineitemsCountGet	GET /procurement/purchaseorders/{id}/lineitems/count
PurchaseOrderLineItemsApi	procurementPurchaseordersIdLineitemsGet	GET /procurement/purchaseorders/{id}/lineitems
PurchaseOrderLineItemsApi	procurementPurchaseordersIdLineitemsLineItemIdDelete	DELETE /procurement/purchaseorders/{id}/lineitems/{lineItemId}
PurchaseOrderLineItemsApi	procurementPurchaseordersIdLineitemsLineItemIdGet	GET /procurement/purchaseorders/{id}/lineitems/{lineItemId}
PurchaseOrderLineItemsApi	procurementPurchaseordersIdLineitemsLineItemIdPatch	PATCH /procurement/purchaseorders/{id}/lineitems/{lineItemId}
PurchaseOrderLineItemsApi	procurementPurchaseordersIdLineitemsLineItemIdPut	PUT /procurement/purchaseorders/{id}/lineitems/{lineItemId}
PurchaseOrderLineItemsApi	procurementPurchaseordersIdLineitemsPost	POST /procurement/purchaseorders/{id}/lineitems
PurchaseOrdersApi	procurementPurchaseordersCountGet	GET /procurement/purchaseorders/count
PurchaseOrdersApi	procurementPurchaseordersGet	GET /procurement/purchaseorders
PurchaseOrdersApi	procurementPurchaseordersIdDelete	DELETE /procurement/purchaseorders/{id}
PurchaseOrdersApi	procurementPurchaseordersIdGet	GET /procurement/purchaseorders/{id}
PurchaseOrdersApi	procurementPurchaseordersIdPatch	PATCH /procurement/purchaseorders/{id}
PurchaseOrdersApi	procurementPurchaseordersIdPut	PUT /procurement/purchaseorders/{id}
PurchaseOrdersApi	procurementPurchaseordersPost	POST /procurement/purchaseorders
RMAActionsApi	procurementRmaActionsCountGet	GET /procurement/rmaActions/count
RMAActionsApi	procurementRmaActionsGet	GET /procurement/rmaActions
RMAActionsApi	procurementRmaActionsIdDelete	DELETE /procurement/rmaActions/{id}
RMAActionsApi	procurementRmaActionsIdGet	GET /procurement/rmaActions/{id}
RMAActionsApi	procurementRmaActionsIdPatch	PATCH /procurement/rmaActions/{id}
RMAActionsApi	procurementRmaActionsIdPut	PUT /procurement/rmaActions/{id}
RMAActionsApi	procurementRmaActionsPost	POST /procurement/rmaActions
RMADispositionsApi	procurementRMADispositionsCountGet	GET /procurement/RMADispositions/count
RMADispositionsApi	procurementRMADispositionsGet	GET /procurement/RMADispositions
RMADispositionsApi	procurementRMADispositionsIdDelete	DELETE /procurement/RMADispositions/{id}
RMADispositionsApi	procurementRMADispositionsIdGet	GET /procurement/RMADispositions/{id}
RMADispositionsApi	procurementRMADispositionsIdPatch	PATCH /procurement/RMADispositions/{id}
RMADispositionsApi	procurementRMADispositionsIdPut	PUT /procurement/RMADispositions/{id}
RMADispositionsApi	procurementRMADispositionsPost	POST /procurement/RMADispositions
ShipmentMethodsApi	procurementShipmentmethodsCountGet	GET /procurement/shipmentmethods/count
ShipmentMethodsApi	procurementShipmentmethodsGet	GET /procurement/shipmentmethods
ShipmentMethodsApi	procurementShipmentmethodsIdDelete	DELETE /procurement/shipmentmethods/{id}
ShipmentMethodsApi	procurementShipmentmethodsIdGet	GET /procurement/shipmentmethods/{id}
ShipmentMethodsApi	procurementShipmentmethodsIdPatch	PATCH /procurement/shipmentmethods/{id}
ShipmentMethodsApi	procurementShipmentmethodsIdPut	PUT /procurement/shipmentmethods/{id}
ShipmentMethodsApi	procurementShipmentmethodsPost	POST /procurement/shipmentmethods
SubCategoriesApi	procurementCategoriesIdSubcategoriesCountGet	GET /procurement/categories/{id}/subcategories/count
SubCategoriesApi	procurementCategoriesIdSubcategoriesGet	GET /procurement/categories/{id}/subcategories
SubCategoriesApi	procurementCategoriesIdSubcategoriesPost	POST /procurement/categories/{id}/subcategories
SubCategoriesApi	procurementCategoriesIdSubcategoriesSubcategoryIDDelete	DELETE /procurement/categories/{id}/subcategories/{subcategoryID}
SubCategoriesApi	procurementCategoriesIdSubcategoriesSubcategoryIDGet	GET /procurement/categories/{id}/subcategories/{subcategoryID}
SubCategoriesApi	procurementCategoriesIdSubcategoriesSubcategoryIDPatch	PATCH /procurement/categories/{id}/subcategories/{subcategoryID}
SubCategoriesApi	procurementCategoriesIdSubcategoriesSubcategoryIDPut	PUT /procurement/categories/{id}/subcategories/{subcategoryID}
UnitOfMeasureConversionsApi	procurementUnitOfMeasuresIdConversionsConversionIdDelete	DELETE /procurement/unitOfMeasures/{id}/conversions/{conversionId}
UnitOfMeasureConversionsApi	procurementUnitOfMeasuresIdConversionsConversionIdGet	GET /procurement/unitOfMeasures/{id}/conversions/{conversionId}
UnitOfMeasureConversionsApi	procurementUnitOfMeasuresIdConversionsConversionIdPatch	PATCH /procurement/unitOfMeasures/{id}/conversions/{conversionId}
UnitOfMeasureConversionsApi	procurementUnitOfMeasuresIdConversionsConversionIdPut	PUT /procurement/unitOfMeasures/{id}/conversions/{conversionId}
UnitOfMeasureConversionsApi	procurementUnitOfMeasuresIdConversionsCountGet	GET /procurement/unitOfMeasures/{id}/conversions/count
UnitOfMeasureConversionsApi	procurementUnitOfMeasuresIdConversionsGet	GET /procurement/unitOfMeasures/{id}/conversions
UnitOfMeasureConversionsApi	procurementUnitOfMeasuresIdConversionsPost	POST /procurement/unitOfMeasures/{id}/conversions
UnitOfMeasuresApi	procurementUnitOfMeasuresCountGet	GET /procurement/unitOfMeasures/count
UnitOfMeasuresApi	procurementUnitOfMeasuresGet	GET /procurement/unitOfMeasures
UnitOfMeasuresApi	procurementUnitOfMeasuresIdDelete	DELETE /procurement/unitOfMeasures/{id}
UnitOfMeasuresApi	procurementUnitOfMeasuresIdGet	GET /procurement/unitOfMeasures/{id}
UnitOfMeasuresApi	procurementUnitOfMeasuresIdPatch	PATCH /procurement/unitOfMeasures/{id}
UnitOfMeasuresApi	procurementUnitOfMeasuresIdPut	PUT /procurement/unitOfMeasures/{id}
UnitOfMeasuresApi	procurementUnitOfMeasuresPost	POST /procurement/unitOfMeasures

Documentation For Models

• Adjustment
• AdjustmentDetail
• AdjustmentReference
• AdjustmentType
• AdjustmentTypeReference
• AgreementReference
• BillingTermsReference
• CatalogComponent
• CatalogItem
• CatalogItemReference
• Category
• CompanyReference
• ContactReference
• Conversion
• Count
• CountryReference
• EntityTypeReference
• Error
• IvItemReference
• Manufacturer
• ManufacturerReference
• Metadata
• OpportunityStatusReference
• PatchOperation
• PricingBreak
• PricingDetail
• PricingSchedule
• ProductCategoryReference
• ProductComponent
• ProductItem
• ProductItemReference
• ProductPickingShippingDetail
• ProductRecurring
• ProductSubCategoryReference
• ProductType
• ProductTypeReference
• PurchaseOrder
• PurchaseOrderLineItem
• PurchaseOrderStatusReference
• RMAAction
• RMADisposition
• SLAReference
• ShipmentMethod
• ShipmentMethodReference
• SiteReference
• SubCategory
• TaxCodeReference
• UnitOfMeasure
• UnitOfMeasureReference
• ValidationError
• WarehouseBinReference
• WarehouseReference

Documentation For Authorization

BasicAuth

• Type: HTTP basic authentication