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

Class	Method	HTTP request
CustomersApi	createCustomer	POST /customers
CustomersApi	deleteCustomer	DELETE /customers/{uid}
CustomersApi	getCustomer	GET /customers/{uid}
CustomersApi	getCustomerBy	GET /customers/by
CustomersApi	getCustomers	GET /customers
CustomersApi	updateCustomer	PUT /customers/{uid}
CustomersAccessApi	getCustomerAccessClearance	GET /customers/{customerUid}/access/{domainUid}
CustomersAccessApi	getMyCustomerAccessClearance	GET /customers/me/access/{uid}
CustomersMeApi	getMeAsCustomer	GET /customers/me
CustomersRelationsApi	getCustomerRelations	GET /customers/{uid}/relations
CustomersRelationsApi	getMyCustomerRelations	GET /customers/me/relations
DomainsApi	createDomain	POST /domains
DomainsApi	deleteDomain	DELETE /domains/{uid}
DomainsApi	getDomain	GET /domains/{uid}
DomainsApi	getDomainBy	GET /domains/by
DomainsApi	getDomains	GET /domains
DomainsApi	getDomainsNames	GET /domains/names
DomainsApi	getDomainsNamesActive	GET /domains/names/active
DomainsApi	updateDomain	PUT /domains/{uid}
DomainsRelationsApi	addCustomerRelations	POST /domains/{uid}/relations/customers
DomainsRelationsApi	addUserRelations	POST /domains/{uid}/relations/users
DomainsRelationsApi	getDomainRelations	GET /domains/{uid}/relations
HealthApi	getApiHealth	GET /health
PermissionsApi	createPermission	POST /permissions
PermissionsApi	deletePermission	DELETE /permissions/{uid}
PermissionsApi	getPermission	GET /permissions/{uid}
PermissionsApi	getPermissions	GET /permissions
PermissionsApi	updatePermission	PUT /permissions/{uid}
PostsApi	addPostPermissions	POST /posts/{uid}/permissions
PostsApi	createPost	POST /posts
PostsApi	deletePost	DELETE /posts/{uid}
PostsApi	deletePostPermissions	DELETE /posts/{uid}/permissions
PostsApi	getPost	GET /posts/{uid}
PostsApi	getPostUser	GET /posts/{uid}/users
PostsApi	getPosts	GET /posts
PostsApi	updatePost	PUT /posts/{uid}
RelationsApi	deleteDomainCustomerRelation	DELETE /relations/customers/{uid}
RelationsApi	deleteDomainUserRelation	DELETE /relations/users/{uid}
UsersApi	createUser	POST /users
UsersApi	deleteUser	DELETE /users/{uid}
UsersApi	getUser	GET /users/{uid}
UsersApi	getUserBy	GET /users/by
UsersApi	getUserSubordinates	GET /users/{uid}/subordinates
UsersApi	getUsers	GET /users
UsersApi	updateUser	PUT /users/{uid}
UsersAccessClearancesApi	getMyAccessClearances	GET /users/me/access/{domainUid}
UsersAccessClearancesApi	getUserAccessClearances	GET /users/{userUid}/access/{domainUid}
UsersLeadsApi	addUserLeads	POST /users/{uid}/leads
UsersLeadsApi	getUserLeads	GET /users/{uid}/leads
UsersLeadsApi	removeUserLeads	DELETE /users/{uid}/leads
UsersMeApi	getMeAsUser	GET /users/me
UsersMeApi	getMyLeads	GET /users/me/leads
UsersMeApi	getMyPosts	GET /users/me/posts
UsersMeApi	getMySubordinates	GET /users/me/subordinates
UsersPostsApi	addUserPosts	POST /users/{uid}/posts
UsersPostsApi	getUserPosts	GET /users/{uid}/posts
UsersPostsApi	removeUserPosts	DELETE /users/{uid}/posts
UsersRelationsApi	getMyDomainRelations	GET /users/me/relations
UsersRelationsApi	getUserDomainRelations	GET /users/{uid}/relations

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

jalismrs / stalactite-data-client

Maintainers

Details