Skip to content

Latest commit

 

History

History
138 lines (99 loc) · 4.29 KB

README.md

File metadata and controls

138 lines (99 loc) · 4.29 KB
Raw

EquisoftPlan SDK

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/kronostechnologies/equisoft-plan-sdk-php.git"
    }
  ],
  "require": {
    "kronostechnologies/equisoft-plan-sdk-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/EquisoftPlan SDK/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

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



// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftPlan\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftPlan\Api\CommandApi(
    // 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
);
$cmdCopyFNA = new \Equisoft\SDK\EquisoftPlan\Model\CmdCopyFNA(); // \Equisoft\SDK\EquisoftPlan\Model\CmdCopyFNA

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

API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
CommandApi cmdCopyFNA POST /fna/api/v2/cmd/copy/fna
OrganizationsApi getOrganization GET /fna/api/v2/organizations/{id}
OrganizationsApi listOrganizationUsers GET /fna/api/v2/organizations/{id}/users
OrganizationsApi listOrganizations GET /fna/api/v2/organizations
PlansApi listPlans GET /fna/api/v2/plans
PlansV1Api getPlan GET /fna/api/fna/{id} Returns the plan
UsersApi getUser GET /fna/api/v2/users/{id}
UsersApi getUserContext GET /fna/api/v2/userContext

Models

Authorization

Authentication schemes defined for the API:

OAuth2

  • Type: OAuth
  • Flow: implicit
  • Authorization URL: https://secure.kronos-web.com/oauth/authorize
  • Scopes:
    • fna:fna: Grants all access to plan/fna (deprecated)
    • plan:plan: Grants all access to plan/fna
    • plan:plan:create: Creation access on plan
    • plan:organization: Grants all access to plan/organizations
    • plan:user: Grants all access to plan/users

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: latest
    • Package version: dev-9.16.3
    • Generator version: 7.7.0-equisoft1
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen