ventureleap/leap-one-product-sdk

Maintainers

Details

github.com/ventureleap/leap-one-product-sdk

Homepage

Source

Issues

Installs: 13 515

Dependents: 2

Suggesters: 0

Security: 0

Stars: 0

Watchers: 2

Forks: 0

Open Issues: 0

dev-master 2021-04-22 12:22 UTC

Requires

Requires (Dev)

proprietary aae29f0db6769dc17b1e0e031f83a68487f97bdb

phpapisdkswagger

This package is auto-updated.

Last update: 2024-06-10 15:17:21 UTC

README

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

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

  • API version: 1.0.0
  • Build package: io.swagger.codegen.v3.generators.php.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

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

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/ventureleap/leap-one-product-sdk.git"
    }
  ],
  "require": {
    "ventureleap/leap-one-product-sdk": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/SwaggerClient-php/vendor/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 API key authorization: apiKey
$config = VentureLeap\ProductService\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = VentureLeap\ProductService\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new VentureLeap\ProductService\Api\ConfigurationEntryApi(
    // 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
);
$id = "id_example"; // string | 

try {
    $apiInstance->deleteConfigurationEntryItem($id);
} catch (Exception $e) {
    echo 'Exception when calling ConfigurationEntryApi->deleteConfigurationEntryItem: ', $e->getMessage(), PHP_EOL;
}

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

$apiInstance = new VentureLeap\ProductService\Api\ConfigurationEntryApi(
    // 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
);
$key = "key_example"; // string | 
$sub_key = "sub_key_example"; // string | 
$value = "value_example"; // string | 
$application_id = "application_id_example"; // string | 
$page = 1; // int | The collection page number
$items_per_page = 30; // int | The number of items per page
$pagination = true; // bool | Enable or disable pagination

try {
    $result = $apiInstance->getConfigurationEntryCollection($key, $sub_key, $value, $application_id, $page, $items_per_page, $pagination);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConfigurationEntryApi->getConfigurationEntryCollection: ', $e->getMessage(), PHP_EOL;
}

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

$apiInstance = new VentureLeap\ProductService\Api\ConfigurationEntryApi(
    // 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
);
$id = "id_example"; // string | 

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

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

$apiInstance = new VentureLeap\ProductService\Api\ConfigurationEntryApi(
    // 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
);
$body = new \VentureLeap\ProductService\Model\ConfigurationEntryJsonldConfigurationWrite(); // \VentureLeap\ProductService\Model\ConfigurationEntryJsonldConfigurationWrite | The new ConfigurationEntry resource

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

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

$apiInstance = new VentureLeap\ProductService\Api\ConfigurationEntryApi(
    // 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
);
$id = "id_example"; // string | 
$body = new \VentureLeap\ProductService\Model\ConfigurationEntryJsonldConfigurationWrite(); // \VentureLeap\ProductService\Model\ConfigurationEntryJsonldConfigurationWrite | The updated ConfigurationEntry resource

try {
    $result = $apiInstance->putConfigurationEntryItem($id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConfigurationEntryApi->putConfigurationEntryItem: ', $e->getMessage(), PHP_EOL;
}
?>

Documentation for API Endpoints

All URIs are relative to /

Class Method HTTP request Description
ConfigurationEntryApi deleteConfigurationEntryItem DELETE /product/configuration_entries/{id} Removes the ConfigurationEntry resource.
ConfigurationEntryApi getConfigurationEntryCollection GET /product/configuration_entries Retrieves the collection of ConfigurationEntry resources.
ConfigurationEntryApi getConfigurationEntryItem GET /product/configuration_entries/{id} Retrieves a ConfigurationEntry resource.
ConfigurationEntryApi postConfigurationEntryCollection POST /product/configuration_entries Creates a ConfigurationEntry resource.
ConfigurationEntryApi putConfigurationEntryItem PUT /product/configuration_entries/{id} Replaces the ConfigurationEntry resource.
PriceListApi deletePriceListItem DELETE /product/price_lists/{id} Removes the PriceList resource.
PriceListApi getPriceListCollection GET /product/price_lists Retrieves the collection of PriceList resources.
PriceListApi getPriceListItem GET /product/price_lists/{id} Retrieves a PriceList resource.
PriceListApi patchPriceListItem PATCH /product/price_lists/{id} Updates the PriceList resource.
PriceListApi postPriceListCollection POST /product/price_lists Creates a PriceList resource.
PriceListApi putPriceListItem PUT /product/price_lists/{id} Replaces the PriceList resource.
PriceListProductApi deletePriceListProductItem DELETE /product/price_list_products/{id} Removes the PriceListProduct resource.
PriceListProductApi getPriceListProductCollection GET /product/price_list_products Retrieves the collection of PriceListProduct resources.
PriceListProductApi getPriceListProductItem GET /product/price_list_products/{id} Retrieves a PriceListProduct resource.
PriceListProductApi patchPriceListProductItem PATCH /product/price_list_products/{id} Updates the PriceListProduct resource.
PriceListProductApi postPriceListProductCollection POST /product/price_list_products Creates a PriceListProduct resource.
PriceListProductApi putPriceListProductItem PUT /product/price_list_products/{id} Replaces the PriceListProduct resource.
ProductApi deleteProductItem DELETE /product/products/{id} Removes the Product resource.
ProductApi getProductCollection GET /product/products Retrieves the collection of Product resources.
ProductApi getProductItem GET /product/products/{id} Retrieves a Product resource.
ProductApi postProductCollection POST /product/products Creates a Product resource.
ProductApi putProductItem PUT /product/products/{id} Replaces the Product resource.
ProductCategoryApi deleteProductCategoryItem DELETE /product/product_categories/{id} Removes the ProductCategory resource.
ProductCategoryApi getProductCategoryCollection GET /product/product_categories Retrieves the collection of ProductCategory resources.
ProductCategoryApi getProductCategoryItem GET /product/product_categories/{id} Retrieves a ProductCategory resource.
ProductCategoryApi postProductCategoryCollection POST /product/product_categories Creates a ProductCategory resource.
ProductCategoryApi putProductCategoryItem PUT /product/product_categories/{id} Replaces the ProductCategory resource.

Documentation For Models

Documentation For Authorization

apiKey

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

Author