jalismrs/stalactite-data-client

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

1.5.0 2023-08-03 07:50 UTC

This package is auto-updated.

Last update: 2024-11-03 10:19:22 UTC


README

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

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

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/jalismrs/stalactite-data-client.git"
    }
  ],
  "require": {
    "jalismrs/stalactite-data-client": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

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



// Configure API key authorization: StalactiteToken
$config = Jalismrs\Stalactite\Client\Data\Configuration::getDefaultConfiguration()->setApiKey('X-API-TOKEN', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Jalismrs\Stalactite\Client\Data\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-TOKEN', 'Bearer');


$apiInstance = new Jalismrs\Stalactite\Client\Data\Api\CustomersApi(
    // 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
);
$create_customer_request = new \Jalismrs\Stalactite\Client\Data\Model\CreateCustomerRequest(); // \Jalismrs\Stalactite\Client\Data\Model\CreateCustomerRequest

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

API Endpoints

All URIs are relative to https://stalactite.jalis.pro/data

Models

Authorization

Authentication schemes defined for the API:

StalactiteToken

  • Type: API key
  • API key parameter name: X-API-TOKEN
  • Location: HTTP header

HealthToken

  • Type: API key
  • API key parameter name: X-HEALTH-TOKEN
  • Location: HTTP header

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

  • API version: 1.5.0
    • Package version: 1.5.0
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen