Skip to content

GRG-Professional-Services/caelum-php-client

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SwaggerClient-php

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: 2022-06-10T08:58:29Z
  • 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/GRG-Professional-Services/caelum-php-client.git"
    }
  ],
  "require": {
    "GRG-Professional-Services/caelum-php-client": "*@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: api_key
$config = CaelumPhpClient\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = CaelumPhpClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$apiInstance = new CaelumPhpClient\Api\AuthApi(
    // 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 \CaelumPhpClient\Model\SignInModel(); // \CaelumPhpClient\Model\SignInModel | 

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

Documentation for API Endpoints

All URIs are relative to https://apigw.caelumai.com

Class Method HTTP request Description
AuthApi apiV1AuthSigninPost POST /api/v1/auth/signin SignIn
DefaultApi apiV1DocumentsDocIdGet GET /api/v1/documents/{docId}
DefaultApi apiV1DocumentsUploadPost POST /api/v1/documents/upload
DocumentsApi apiV1DocumentsGet GET /api/v1/documents List
QueuesApi apiV1QueuesGet GET /api/v1/queues List

Documentation For Models

Documentation For Authorization

api_key

  • Type: API key
  • API key parameter name: x-api-key
  • Location: HTTP header

Author

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published