README

Connect your software to POEditor with this simple API

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/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@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');




$apiInstance = new OpenAPI\Client\Api\ContributorsApi(
    // 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()
);
$api_token = 'api_token_example'; // string
$id = 'id_example'; // string | The id of project
$name = 'name_example'; // string | The name of contributor
$email = 'email_example'; // string | The email of contributor
$language = 'language_example'; // string | The language code (Required if adding a contributor)
$admin = 56; // int | Set it to 1 for adding as administrator

try {
    $result = $apiInstance->contributorsAddPost($api_token, $id, $name, $email, $language, $admin);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContributorsApi->contributorsAddPost: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.poeditor.com/v2

Models

• ContributorsListResponse
• ContributorsListResponseAllOf
• ContributorsListResponseAllOfResult
• ContributorsListResponseAllOfResultContributors
• ContributorsListResponseAllOfResultPermissions
• ContributorsListResponseAllOfResultProject
• LanguagesListLong
• LanguagesListLongLanguagesInner
• LanguagesListLongResponse
• LanguagesListLongResponseAllOf
• LanguagesListShort
• LanguagesListShortLanguagesInner
• LanguagesListShortResponse
• LanguagesListShortResponseAllOf
• ProjectExportResponse
• ProjectExportResponseAllOf
• ProjectExportResponseAllOfResult
• ProjectList
• ProjectListProjectsInner
• ProjectListResponse
• ProjectListResponseAllOf
• ProjectLong
• ProjectLongProject
• ProjectSyncResponse
• ProjectSyncResponseAllOf
• ProjectUploadResponse
• ProjectUploadResponseAllOf
• ProjectViewResponse
• ProjectViewResponseAllOf
• Response
• ResponseResponse
• TermAddCommentResponse
• TermAddCommentResponseAllOf
• TermAddedResponse
• TermAddedResponseAllOf
• TermDeletedResponse
• TermDeletedResponseAllOf
• TermUpdatedResponse
• TermUpdatedResponseAllOf
• TermsFull
• TermsFullTerms
• TermsListFull
• TermsListFullResponse
• TermsListFullResponseAllOf
• TermsListFullTermsInner
• TermsListFullTermsInnerTranslation
• TermsLong
• TermsLongTerms
• TermsShortAdded
• TermsShortAddedTerms
• TermsShortComment
• TermsShortCommentTerms
• TermsShortDeleted
• TermsShortDeletedTerms
• TermsShortUpdated
• TermsShortUpdatedTerms
• TermsTranslationsResponse
• TranslationAddedResponse
• TranslationAddedResponseAllOf
• TranslationDeletedResponse
• TranslationDeletedResponseAllOf
• TranslationUpdatedResponse
• TranslationUpdatedResponseAllOf
• TranslationsLong
• TranslationsShort
• TranslationsShortAdded
• TranslationsShortDeleted
• TranslationsShortResponse
• TranslationsShortResponseAllOf
• TranslationsShortTranslations
• TranslationsShortUpdated

Authorization

All endpoints do not require authorization.

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.0.3
• Build package: org.openapitools.codegen.languages.PhpClientCodegen