ventureleap/leap-one-audit-log-sdk

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

$apiInstance = new VentureLeap\AuditLogService\Api\AuditLogEntryApi(
    // 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
);
$entity_uuid = "entity_uuid_example"; // string | 
$user_uuid = "user_uuid_example"; // string | 
$entity_type = "entity_type_example"; // string | 
$order_uuid = "order_uuid_example"; // string | 
$order_user_uuid = "order_user_uuid_example"; // string | 
$order_entity_uuid = "order_entity_uuid_example"; // string | 
$order_entity_type = "order_entity_type_example"; // string | 
$order_url = "order_url_example"; // string | 
$order_body = "order_body_example"; // string | 
$order_entry_type = "order_entry_type_example"; // string | 
$order_application_id = "order_application_id_example"; // string | 
$order_created_at = "order_created_at_example"; // string | 
$order_updated_at = "order_updated_at_example"; // string | 
$page = 1; // int | The collection page number

try {
    $result = $apiInstance->getAuditLogEntryCollection($entity_uuid, $user_uuid, $entity_type, $order_uuid, $order_user_uuid, $order_entity_uuid, $order_entity_type, $order_url, $order_body, $order_entry_type, $order_application_id, $order_created_at, $order_updated_at, $page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuditLogEntryApi->getAuditLogEntryCollection: ', $e->getMessage(), PHP_EOL;
}

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

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

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

$apiInstance = new VentureLeap\AuditLogService\Api\AuditLogEntryApi(
    // 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\AuditLogService\Model\AuditLogEntryJsonldAuditLogEntryWrite(); // \VentureLeap\AuditLogService\Model\AuditLogEntryJsonldAuditLogEntryWrite | The new AuditLogEntry resource

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

Documentation for API Endpoints

All URIs are relative to /

Class	Method	HTTP request	Description
AuditLogEntryApi	getAuditLogEntryCollection	GET /audit-log/audit_log_entries	Retrieves the collection of AuditLogEntry resources.
AuditLogEntryApi	getAuditLogEntryItem	GET /audit-log/audit_log_entries/{id}	Retrieves a AuditLogEntry resource.
AuditLogEntryApi	postAuditLogEntryCollection	POST /audit-log/audit_log_entries	Creates a AuditLogEntry resource.
ConfigurationEntryApi	deleteConfigurationEntryItem	DELETE /audit-log/configuration_entries/{id}	Removes the ConfigurationEntry resource.
ConfigurationEntryApi	getConfigurationEntryCollection	GET /audit-log/configuration_entries	Retrieves the collection of ConfigurationEntry resources.
ConfigurationEntryApi	getConfigurationEntryItem	GET /audit-log/configuration_entries/{id}	Retrieves a ConfigurationEntry resource.
ConfigurationEntryApi	postConfigurationEntryCollection	POST /audit-log/configuration_entries	Creates a ConfigurationEntry resource.
ConfigurationEntryApi	putConfigurationEntryItem	PUT /audit-log/configuration_entries/{id}	Replaces the ConfigurationEntry resource.

Documentation For Models

• AuditLogEntryJsonldAuditLogEntryRead
• AuditLogEntryJsonldAuditLogEntryWrite
• ConfigurationEntryJsonldConfigurationRead
• ConfigurationEntryJsonldConfigurationWrite
• InlineResponse200
• InlineResponse2001
• InlineResponse200Hydrasearch
• InlineResponse200HydrasearchHydramapping
• InlineResponse200Hydraview

Documentation For Authorization

apiKey

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

Author