smartgammadev / payrolls_v3

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: v3
• Package 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/smartgammadev/payrolls_v3.git"
    }
  ],
  "require": {
    "smartgammadev/payrolls_v3": "*@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');


$apiInstance = new EvoliaV3\SDK\AdminApi(
    // 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
);

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

Documentation for API Endpoints

All URIs are relative to https://virtserver.swaggerhub.com/troopshr/EvoliaV3/v3

Class	Method	HTTP request	Description
AdminApi	initProject	POST /api/v3/admin/initialization	Used to create (if needed) the local SQLite Database And create the default appID/appSecret
CandidatesApi	importCandidate	POST /api/v3/candidates	Import the Candidate
CandidatesApi	searchCandidate	GET /api/v3/candidates/{idAgency}/{numSecu}/{numSecuCle}	Test if the Candidate exists
CandidatesApi	updateCandidate	PUT /api/v3/candidates	Update the Candidate
CandidatesApi	updateDpaes	PUT /api/v3/candidates/dpaes	Update the Candidate with DPAE information
ClientsApi	findClientsBySiret	GET /api/v3/clients/{registrationNumber}/{agencyId}	This endpoint is used to search the siret in the DB from the NIC and the Siret
ClientsApi	importClient	POST /api/v3/clients	Import the Customer
ClientsApi	updateClient	PUT /api/v3/clients/{idRef}	update the Customer
ContractsApi	importContract	POST /api/v3/contracts	Import the Contract
ContractsApi	updateContract	PUT /api/v3/contracts/{contractId}	Update the Contract information
HomeApi	getHealth	GET /health	This endpoint is used to test the server's health
ReferencesApi	getReferences	GET /api/v3/references	Get all the references from the database
TimesheetApi	importTimesheet	POST /api/v3/timesheet	Import Timesheet
TokenApi	refreshToken	POST /api/v3/token/refresh
TokenApi	revokeToken	DELETE /api/v3/token/{refreshToken}
TokenApi	userLogin	POST /api/v3/token	user authentication and token generation
UserApi	login	POST /api/v3/user/login
UserApi	registerUser	POST /api/v3/user/registeruser
UserApi	revokeUser	DELETE /api/v3/user/{userName}

Documentation For Models

• AppErrorResponse
• AuthenticationResponse
• Candidate
• CandidateDpae
• CandidateResult
• ClientRequest
• Contract
• ContractChanges
• ContractualData
• EResult
• ErrorDetails
• HealthCheck
• MissionPlace
• PayrollItemsPart
• ProblemDetails
• ReferenceItem
• ReferencesResponse
• RefreshTokenRequest
• SiretQueryResult
• SuccessResponse
• Timesheet
• User
• UserLoginRequest
• UserRegistrationRequest
• WorkDays

Documentation For Authorization

JWT_Bearer_Token

• Type: HTTP bearer authentication

Author