Skip to content

CatalogApi.md

Latest commit

 

History

History
456 lines (309 loc) · 12.8 KB

CatalogApi.md

File metadata and controls

456 lines (309 loc) · 12.8 KB

SynergiTech\Iplicit\CatalogApi

All URIs are relative to https://api.iplicit.com, except if the operation defines another base path.

Method HTTP request Description
addCatalogItem() PUT /api/Catalog/{catalogName} Add an item to a catalog
deleteCatalogItem() DELETE /api/Catalog/{catalogName}/{idOrCode} Delete an item in a catalog
getAllCatalogs() GET /api/Catalog Get a list of all catalogs
getCatalog() GET /api/Catalog/{catalogName} Get all items in a catalog
lockCatalogItem() POST /api/Catalog/{catalogName}/{idOrCode}/lock Lock a catalog item
replaceCatalogItems() POST /api/Catalog/{catalogName} Replace all items in a catalog
unlockCatalogItem() POST /api/Catalog/{catalogName}/{idOrCode}/unlock Unlock a catalog item
updateCatalogItem() PATCH /api/Catalog/{catalogName}/{idOrCode} Update an item in a catalog

addCatalogItem()

addCatalogItem($catalogName, $catalogItemCreate)

Add an item to a catalog

Example

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



$apiInstance = new SynergiTech\Iplicit\Api\CatalogApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$catalogName = 'catalogName_example'; // string | Name of the catalog
$catalogItemCreate = new \SynergiTech\Iplicit\Model\CatalogItemCreate(); // \SynergiTech\Iplicit\Model\CatalogItemCreate |

try {
    $apiInstance->addCatalogItem($catalogName, $catalogItemCreate);
} catch (Exception $e) {
    echo 'Exception when calling CatalogApi->addCatalogItem: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
catalogName string Name of the catalog
catalogItemCreate \SynergiTech\Iplicit\Model\CatalogItemCreate [optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: Not defined

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

deleteCatalogItem()

deleteCatalogItem($catalogName, $idOrCode)

Delete an item in a catalog

Example

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



$apiInstance = new SynergiTech\Iplicit\Api\CatalogApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$catalogName = 'catalogName_example'; // string | Name of the catalog
$idOrCode = 'idOrCode_example'; // string | Id or code of the catalog item

try {
    $apiInstance->deleteCatalogItem($catalogName, $idOrCode);
} catch (Exception $e) {
    echo 'Exception when calling CatalogApi->deleteCatalogItem: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
catalogName string Name of the catalog
idOrCode string Id or code of the catalog item

Return 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]

getAllCatalogs()

getAllCatalogs(): \SynergiTech\Iplicit\Model\CatalogItem[]

Get a list of all catalogs

Example

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



$apiInstance = new SynergiTech\Iplicit\Api\CatalogApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);

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

Parameters

This endpoint does not need any parameter.

Return type

\SynergiTech\Iplicit\Model\CatalogItem[]

Authorization

No authorization required

HTTP request headers

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

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

getCatalog()

getCatalog($catalogName): \SynergiTech\Iplicit\Model\CatalogItem[]

Get all items in a catalog

Example

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



$apiInstance = new SynergiTech\Iplicit\Api\CatalogApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$catalogName = 'catalogName_example'; // string | Name of the catalog

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

Parameters

Name Type Description Notes
catalogName string Name of the catalog

Return type

\SynergiTech\Iplicit\Model\CatalogItem[]

Authorization

No authorization required

HTTP request headers

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

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

lockCatalogItem()

lockCatalogItem($catalogName, $idOrCode, $catalogItem)

Lock a catalog item

Example

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



$apiInstance = new SynergiTech\Iplicit\Api\CatalogApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$catalogName = 'catalogName_example'; // string | Name of the catalog to update
$idOrCode = 'idOrCode_example'; // string | Id or code of the catalog item
$catalogItem = new \SynergiTech\Iplicit\Model\CatalogItem(); // \SynergiTech\Iplicit\Model\CatalogItem |

try {
    $apiInstance->lockCatalogItem($catalogName, $idOrCode, $catalogItem);
} catch (Exception $e) {
    echo 'Exception when calling CatalogApi->lockCatalogItem: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
catalogName string Name of the catalog to update
idOrCode string Id or code of the catalog item
catalogItem \SynergiTech\Iplicit\Model\CatalogItem [optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: Not defined

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

replaceCatalogItems()

replaceCatalogItems($catalogName, $catalogItemCreate)

Replace all items in a catalog

Example

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



$apiInstance = new SynergiTech\Iplicit\Api\CatalogApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$catalogName = 'catalogName_example'; // string | Name of the catalog
$catalogItemCreate = array(new \SynergiTech\Iplicit\Model\CatalogItemCreate()); // \SynergiTech\Iplicit\Model\CatalogItemCreate[] |

try {
    $apiInstance->replaceCatalogItems($catalogName, $catalogItemCreate);
} catch (Exception $e) {
    echo 'Exception when calling CatalogApi->replaceCatalogItems: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
catalogName string Name of the catalog
catalogItemCreate \SynergiTech\Iplicit\Model\CatalogItemCreate[] [optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: Not defined

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

unlockCatalogItem()

unlockCatalogItem($catalogName, $idOrCode, $catalogItem)

Unlock a catalog item

Example

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



$apiInstance = new SynergiTech\Iplicit\Api\CatalogApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$catalogName = 'catalogName_example'; // string | Name of the catalog to update
$idOrCode = 'idOrCode_example'; // string | Id or code of the catalog item
$catalogItem = new \SynergiTech\Iplicit\Model\CatalogItem(); // \SynergiTech\Iplicit\Model\CatalogItem |

try {
    $apiInstance->unlockCatalogItem($catalogName, $idOrCode, $catalogItem);
} catch (Exception $e) {
    echo 'Exception when calling CatalogApi->unlockCatalogItem: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
catalogName string Name of the catalog to update
idOrCode string Id or code of the catalog item
catalogItem \SynergiTech\Iplicit\Model\CatalogItem [optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: Not defined

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

updateCatalogItem()

updateCatalogItem($catalogName, $idOrCode, $catalogItemUpdate)

Update an item in a catalog

Example

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



$apiInstance = new SynergiTech\Iplicit\Api\CatalogApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$catalogName = 'catalogName_example'; // string | Name of the catalog
$idOrCode = 'idOrCode_example'; // string | Id or code of the catalog item
$catalogItemUpdate = new \SynergiTech\Iplicit\Model\CatalogItemUpdate(); // \SynergiTech\Iplicit\Model\CatalogItemUpdate |

try {
    $apiInstance->updateCatalogItem($catalogName, $idOrCode, $catalogItemUpdate);
} catch (Exception $e) {
    echo 'Exception when calling CatalogApi->updateCatalogItem: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
catalogName string Name of the catalog
idOrCode string Id or code of the catalog item
catalogItemUpdate \SynergiTech\Iplicit\Model\CatalogItemUpdate [optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: Not defined

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