ventureleap/leap-one-configuration-sdk

dev-master 2022-05-10 14:16 UTC

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

proprietary

• Swagger and contributors

• php
• api
• sdk
• swagger

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-configuration-sdk.git"
    }
  ],
  "require": {
    "ventureleap/leap-one-configuration-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\ConfigurationService\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = VentureLeap\ConfigurationService\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new VentureLeap\ConfigurationService\Api\ApplicationApi(
    // 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->deleteApplicationItem($id);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationApi->deleteApplicationItem: ', $e->getMessage(), PHP_EOL;
}

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

$apiInstance = new VentureLeap\ConfigurationService\Api\ApplicationApi(
    // 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->getApplicationItem($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationApi->getApplicationItem: ', $e->getMessage(), PHP_EOL;
}

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

$apiInstance = new VentureLeap\ConfigurationService\Api\ApplicationApi(
    // 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\ConfigurationService\Model\ApplicationJsonldAppplicationWrite(); // \VentureLeap\ConfigurationService\Model\ApplicationJsonldAppplicationWrite | The new Application resource

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

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

$apiInstance = new VentureLeap\ConfigurationService\Api\ApplicationApi(
    // 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\ConfigurationService\Model\ApplicationJsonldAppplicationWrite(); // \VentureLeap\ConfigurationService\Model\ApplicationJsonldAppplicationWrite | The updated Application resource

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

Documentation for API Endpoints

All URIs are relative to /

Class	Method	HTTP request	Description
ApplicationApi	deleteApplicationItem	DELETE /configuration/applications/{id}	Removes the Application resource.
ApplicationApi	getApplicationItem	GET /configuration/applications/{id}	Retrieves a Application resource.
ApplicationApi	postApplicationCollection	POST /configuration/applications	Creates a Application resource.
ApplicationApi	putApplicationItem	PUT /configuration/applications/{id}	Replaces the Application resource.
ConfigurationEntryApi	deleteConfigurationEntryItem	DELETE /configuration/configuration_entries/{id}	Removes the ConfigurationEntry resource.
ConfigurationEntryApi	getConfigurationEntryCollection	GET /configuration/configuration_entries	Retrieves the collection of ConfigurationEntry resources.
ConfigurationEntryApi	getConfigurationEntryItem	GET /configuration/configuration_entries/{id}	Retrieves a ConfigurationEntry resource.
ConfigurationEntryApi	postConfigurationEntryCollection	POST /configuration/configuration_entries	Creates a ConfigurationEntry resource.
ConfigurationEntryApi	putConfigurationEntryItem	PUT /configuration/configuration_entries/{id}	Replaces the ConfigurationEntry resource.
TokenApi	postCredentialsItem	POST /configuration/get-token	Get JWT token to login.
TokenApi	postCredentialsItemForPublicToken	POST /configuration/get-public-token	Get a public JWT token

Documentation For Models

• ApplicationJsonldAppplicationRead
• ApplicationJsonldAppplicationWrite
• ConfigurationEntryJsonldConfigurationRead
• ConfigurationEntryJsonldConfigurationWrite
• Credentials
• InlineResponse200
• InlineResponse200Hydrasearch
• InlineResponse200HydrasearchHydramapping
• InlineResponse200Hydraview
• Token

Documentation For Authorization

apiKey

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

Author