ventureleap / leap-one-rating-sdk
Installs: 13 267
Dependents: 2
Suggesters: 0
Security: 0
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 0
Requires
- php: >=5.5
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^6.2
Requires (Dev)
- friendsofphp/php-cs-fixer: ~1.12
- phpunit/phpunit: ^4.8
- squizlabs/php_codesniffer: ~2.6
This package is auto-updated.
Last update: 2025-02-22 01:11:11 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-rating-sdk.git"
}
],
"require": {
"ventureleap/leap-one-rating-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\RatingService\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = VentureLeap\RatingService\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer'); $apiInstance = new VentureLeap\RatingService\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\RatingService\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = VentureLeap\RatingService\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer'); $apiInstance = new VentureLeap\RatingService\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 try { $result = $apiInstance->getConfigurationEntryCollection($key, $sub_key, $value, $application_id, $page); print_r($result); } catch (Exception $e) { echo 'Exception when calling ConfigurationEntryApi->getConfigurationEntryCollection: ', $e->getMessage(), PHP_EOL; } // Configure API key authorization: apiKey $config = VentureLeap\RatingService\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = VentureLeap\RatingService\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer'); $apiInstance = new VentureLeap\RatingService\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\RatingService\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = VentureLeap\RatingService\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer'); $apiInstance = new VentureLeap\RatingService\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\RatingService\Model\ConfigurationEntryJsonldConfigurationWrite(); // \VentureLeap\RatingService\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\RatingService\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = VentureLeap\RatingService\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer'); $apiInstance = new VentureLeap\RatingService\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\RatingService\Model\ConfigurationEntryJsonldConfigurationWrite(); // \VentureLeap\RatingService\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 /rating/configuration_entries/{id} | Removes the ConfigurationEntry resource. |
ConfigurationEntryApi | getConfigurationEntryCollection | GET /rating/configuration_entries | Retrieves the collection of ConfigurationEntry resources. |
ConfigurationEntryApi | getConfigurationEntryItem | GET /rating/configuration_entries/{id} | Retrieves a ConfigurationEntry resource. |
ConfigurationEntryApi | postConfigurationEntryCollection | POST /rating/configuration_entries | Creates a ConfigurationEntry resource. |
ConfigurationEntryApi | putConfigurationEntryItem | PUT /rating/configuration_entries/{id} | Replaces the ConfigurationEntry resource. |
RatingApi | deleteRatingItem | DELETE /rating/ratings/{id} | Removes the Rating resource. |
RatingApi | findAverageRatingRatingItem | GET /rating/ratings/{productUuid}/average-rating/ | Retrieves a Rating resource. |
RatingApi | getRatingCollection | GET /rating/ratings | Retrieves the collection of Rating resources. |
RatingApi | getRatingItem | GET /rating/ratings/{id} | Retrieves a Rating resource. |
RatingApi | postRatingCollection | POST /rating/ratings | Creates a Rating resource. |
RatingApi | putRatingItem | PUT /rating/ratings/{id} | Replaces the Rating resource. |
Documentation For Models
- AverageRating
- ConfigurationEntryJsonldConfigurationRead
- ConfigurationEntryJsonldConfigurationWrite
- InlineResponse200
- InlineResponse2001
- InlineResponse200Hydrasearch
- InlineResponse200HydrasearchHydramapping
- InlineResponse200Hydraview
- RatingJsonldRatingRead
- RatingJsonldRatingWrite
Documentation For Authorization
apiKey
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header