Hey,

I would highly need an API to handle the user management which means:

• Add/Remove person to a project with provided role
• List persons of a project

I haven't seen that in the documentation yet.
What is your opinion on that?

Thanks!

We've added a few new API endpoints to manage Bundles in Crowdin - https://developer.crowdin.com/api/v2/#tag/Bundles

It would be great to add the new methods to the corresponding class - BundleApi.php and include tests.

The two AbstractTestApi::mockRequest implementations have a bug (likely typo) where it will never assert the called body & header as the assertion is testing the same values ($params['body'] vs $params['body']).

This is masking 41 failures:

$ docker run -v $(pwd):/app --rm php:8.1-cli bash -c "cd app && vendor/bin/phpunit"
PHPUnit 9.6.13 by Sebastian Bergmann and contributors.

Warning:       Your XML configuration validates against a deprecated schema.
Suggestion:    Migrate your XML configuration using "--migrate-configuration"!

..F....F...F....F..F....F....F..F.....F...F..........F.F...F...  63 / 396 ( 15%)
F...F..F....F.........F..F................F......F..F.F...F.... 126 / 396 ( 31%)
..F.......FE.F......F.F.F....F..F......F......FF..F.....F...... 189 / 396 ( 47%)
....F...F.F............F....................................... 252 / 396 ( 63%)
............................................................... 315 / 396 ( 79%)
............................................................... 378 / 396 ( 95%)
..................                                              396 / 396 (100%)

Time: 00:00.798, Memory: 18.00 MB
#...
ERRORS!
Tests: 396, Assertions: 1819, Errors: 1, Failures: 41.

API Reference:

• Bundles (crowdin.com)
• Bundles (Crowdin Enterprise)

When updating SourceStrings we get a 500 Internal Server Error. We're using a simple request like this:

    public function updateString($sourceId, $value): void
    {
        $sourceString = $this->client->sourceString->get($this->projectId, $sourceId);
        if (!$sourceString || $sourceString->getText() == $value) {
            return;
        }

        $sourceString->setText($value);
        $newString = $this->client->sourceString->update($sourceString);
    }

Should be CrowdinApiClient\FrameworkSupport\Laravel.

#71

The glossary download method here

New API endpoints:

• List Report Settings Templates
• Add Report Settings Template
• Get Report Settings Template
• Edit Report Settings Template
• Delete Report Settings Template

These new endpoints should be reflected in this API client and covered by Unit tests.

Crowdin added 3 new API endpoints that should be also added to the corresponding sections of this API Client.

• api.projects.glossaries.concordance.post
• api.projects.translations.alignment.post
• api.projects.tms.concordance.post

New code should be covered by Unit tests in the same way as the rest of the code.

Crowdin has recently added new endpoints for managing custom applications. Support for these endpoints is missing in this Crowdin API client.

We need to add support for the following endpoints:

• Get Application Data
• Update or Restore Application Data
• Add Application Data
• Delete Application Data
• Edit Application Data

API Reference - api.projects.strings.get

Currently, we have very few simple examples in the Readme and it would be great to have more examples that would include more complex workflows:

• adding a file to the Crowdin project (add storage, add file)
• updating a file (add storage, update or restore file)
• build project (start to build, check build status in a loop, download project translations)
• upload/download TM
• upload/download Glossary

It's better to create a separate file for these examples like here.

Crowdin Rest API now supports the API methods for TM (Translation Memory) segments management.

New API methods:

• List TM Segments
• Create TM Segment
• Get TM Segment
• Delete TM Segment

It should be added to this API client as well as the corresponding unit tests.

Letter case is matter. So, retrieving should look like config('crowdin').

#72

Crowdin recently added a bunch of new API methods to manage Strings Exporter settings for some file formats.

The new methods need to be added to this API Client.

API Reference:

• List Project Strings Exporter Settings
• Add Project Strings Exporter Settings
• Get Project Strings Exporter Settings
• Delete Project Strings Exporter Settings
• Edit Project Strings Exporter Settings

Crowdin Rest API now supports an API method that allows downloading file preview.

New API method:

• Download File Preview

It should be added to this API client as well as the corresponding unit tests.

Hello,

I am testing a paginated reader in akeneo/nelson as follow:

        $results = [];
        $offset = 0;
        do {
            $objectCollection = $this->crowdinClient->translationStatus->getBranchProgress(
                $projectId,
                $branchId,
                ['offset' => $offset, 'limit'=>50]
            );
            foreach ($objectCollection->getIterator() as $item) {
                $results[]=$item;
            }
            $offset += $objectCollection->getPagination()['limit'];
        } while (!$objectCollection->isEmpty());

        return $results;

And i found it clumsy having to use the foreach iterator to just populate the results.
Having a public getter like CrowdinApiClient\ModelCollection::toArray() would be usefull imho.

The resulting pagination would be like

        $results = [];
        $offset = 0;
        do {
            $objectCollection = $this->crowdinClient->translationStatus->getBranchProgress(
                $projectId,
                $branchId,
                ['offset' => $offset, 'limit'=>50]
            );
            $results += $objectCollection->toArray();
            $offset += $objectCollection->getPagination()['limit'];
        } while (!$objectCollection->isEmpty());

        return $results;

Note, this could also be a CrowdinApiClient\ModelCollection::__toArray() method to reflect this RFC (still under discussion) https://wiki.php.net/rfc/to-array

According to the API, there should be a way to specify the needed exportFields when exporting a glossary - https://developer.crowdin.com/api/v2/#operation/api.glossaries.exports.post

However there is no such parameter here -

We've added new API methods to the "Source Files" section that would be great to reflect in this API Client.

• Download Project File Format Settings Custom Segmentation
• Reset Project File Format Settings Custom Segmentation
• List Project File Format Settings
• Add Project File Format Settings
• Get Project File Format Settings
• Delete Project File Format Settings
• Edit Project File Format Settings

Crowdin has recently released new endpoints for the Applications API. We need to add support for them in the Crowdin API client as well.

API reference:

• List Application Installations
• Install Application
• Get Application Installation
• Delete Application Installation
• Edit Application Installation

Crowdin Rest API now supports the qaChecksIgnorableCategories field on the Projects API.

This field allows you to retrieve the list of QA Check categories that can be ignored for a Crowdin project.

Affected API methods:

• Add project (request schema)
• Project settings response model
• Edit Project (request schema)

It should be reflected in this API client and the corresponding unit tests should be updated.

Several String Translation API endpoints have been enhanced with new parameters support: labelIds, excludeLabelIds. These parameters should be added to this API client.

References:

• List Translation Approvals
• List Translation Votes

When trying to fetch machine translations of some strings we get a 500 Internal Server Error. We're using a request like this:

$machineTranslation = $this->crowdin->machineTranslationEngine->translateViaMT(
    $mtId,
    [
        'sourceLanguageId' => 'de',
        'targetLanguageId' => 'hr',
        'strings' => [
            'Test Eins',
            'Test Zwei',
        ],
    ]
);

The machine translation engine used supports the language pair and this requests worked before.

API Reference:

• Invite User
• Delete User
• Edit User

We've added a new API methods section - Organization-Webhooks. It's a webhooks that allow you to collect information about events that happen in your Crowdin account/organization.

It would be great to reflect these API changes in the API Client.

Note: the events list is different for crowdin.com and Crowdin Enterprise APIs.

Added new request fields - api.projects.distributions.post

+ distribution response object and patch are also updated

crowdin.com and Crowdin Enterprise

Firstly, thank you for this interface!

We are upgrading PHP from 8.0 to 8.1 and are getting the following error:

Error: During inheritance of IteratorAggregate: Uncaught Whoops\Exception\ErrorException: Return type of CrowdinApiClient\Collection::getIterator() should either be compatible with IteratorAggregate::getIterator(): Traversable, or the #[\ReturnTypeWillChange] attribute should be used to temporarily suppress the notice

Anyways, I'm more than happy to create a PR to add the suppression attribute if that would be helpful.

Crowdin Rest API now supports API methods that allow to manage screenshot labels.

New API methods:

• Assign Label to Screenshots
• Unassign Label from Screenshots

It should be added to this API client as well as the corresponding unit tests.

The "Documentation" pipeline is broken - https://github.com/crowdin/crowdin-api-client-php/actions/runs/6146736115/job/16676694101

Probably, something was changed in the phpdoc Docker container and the command should be fixed.

https://github.com/crowdin/crowdin-api-client-php/blob/master/.github/workflows/docs.yml#L24

Ive downloaded the repository and placed it in my project.

I can require it (path is correct), but I get an error. Any idea what’s wrong?

<?php 

require 'scripts/libs/src/CrowdinApiClient/Crowdin.php';

use CrowdinApiClient\Crowdin;

Class 'CrowdinApiClient\Http\Client\CrowdinHttpClientFactory' not found

Crowdin Enterprise reference

Hello,

Another question, following #113 .

Still with this paginated reader, I found that I have to make a useless empty API call to have an empty collection and exit the loop:

        $results = [];
        $offset = 0;
        do {
            $objectCollection = $this->crowdinClient->translationStatus->getBranchProgress(
                $projectId,
                $branchId,
                ['offset' => $offset, 'limit'=>50]
            );
            foreach ($objectCollection->getIterator() as $item) {
                $results[]=$item;
            }
            $offset += $objectCollection->getPagination()['limit'];
        } while (!$objectCollection->isEmpty());

        return $results;

I think I could add something like this to avoid this useless call:

        $results = [];
        $offset = 0;
        do {
            // call API with a limit = 50
        } while (!$objectCollection->isEmpty() || !$objectCollection->count() <= 50);


        return $results;

but it is also very clumsy and easy to forget. We may add the logic to test collection->count() < $limit in the client and return the info in the model to facilitate user pagination.

The Readme. md image does not load on coming back from another file.

Note - Issue only in Github 'Default Dark' theme.

First, go to the repository home page where you will see the readme contents below, now go to any file and come back again to see the readme file doesn't load this time. I tried something by removing specific images for a light theme but that doesn't work cause now it shows light theme images in dark theme settings.
I am working on it and will find out what's the issue.

Note - Checked the Github doc for adding theme-specific images and found that we are doing it correctly. (https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#specifying-the-theme-an-image-is-shown-to)

Crowdin added new API endpoint - String Batch Operations.

It would be great to add the new method to this API client as well as the corresponding unit tests.

We're happy to announce a significant update for Crowdin Glossaries that allows managing the terminology in a more advanced way.

There are a lot of new things and some changes in the Crowdin API.

New APIs:

• List Concepts
• Get Concept
• Update Concept
• Delete Concept

Updates:

• Export Glossary - new possible values for format and exportFields
• Import Glossary - new possible values for scheme

The translationOfTermId is deprecated and the conceptId added in:

• List Terms (+ additional properties in the response)
• Add Term (+ new request parameters like status, type, gender, note, url)
• Clear Glossary

Edit Term - new path options

All of these changes should be reflected in this API Client.

API Reference:

• Build Project Directory Translation (crowdin.com)
• Build Project Directory Translation (Crowdin Enterprise)

This project is using friendsofphp/php-cs-fixer in version 2, which is not maintained anymore.

Migrating to v3 can be done by following this guide : https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/blob/v3.3.0/UPGRADE-v3.md

Crowdin recently released a big update of the reports functionality. Now, when calculating the price for translation in Cost Estimation and Translation Cost reports, we have introduced a new feature that allows you to include the cost of proofreading if the source text matches the Translation Memory (TM) or Machine Translation (MT) results.

The reports API was updated as well. The legacy Cost Estimate (including Fuzzy mode) and Translation Cost reports were deprecated in favor of the new Cost-Estimation Post-Editing and Translation Costs Post-Editing reports. The legacy reports will be removed in future releases.

API reference:

• Generate Report (crowdin.com)
• Generate Group Report (Crowdin Enterprise)
• Generate Organization Report (Crowdin Enterprise)
• Generate Report (Crowdin Enterprise)

The Report Settings Template API was also affected (refer to the API Docs for details).

Several Screenshots API endpoints have been enhanced with the new parameter support: labelIds. It should be added to this API client.

References:

• Add Screenshot
• Edit Screenshot
• Get Screenshot (response)

It would be great if the model \CrowdinApiClient\Model\Progress could not only contain the languageId but the languageName.

This would save tons of request (or caching) on my side to build status dashboards, ...

what do you think?

This property was removed from the API:

https://github.com/crowdin/crowdin-api-client-php/search?q=defaultProjectId

Also, the defaultProjectIds property is missing, it should be added. https://developer.crowdin.com/api/v2/#operation/api.tms.get

New API endpoints:

• api.projects.tasks.settings-templates.getMany
• api.projects.tasks.settings-templates.post
• api.projects.tasks.settings-templates.get
• api.projects.tasks.settings-templates.delete
• api.projects.tasks.settings-templates.patch

Crowdin Enterprise endpoints are almost the same, but there is some difference in template config:

• api.projects.tasks.settings-templates.getMany
• api.projects.tasks.settings-templates.post
• api.projects.tasks.settings-templates.get
• api.projects.tasks.settings-templates.delete
• api.projects.tasks.settings-templates.patch

The Distribution creation API has been changed. Now you can create a distribution with the following parameters:

• bundleIds - array of bundle ids

The following parameters have been deprecated:

• format
• exportPattern
• labelIds

A Distribution response has also been changed. Now it contains the bundleIds field. The format, exportPattern, and labelIds fields are deprecated.

In addition, the fileIds request parameter is now optional.

All the changes are described in the API documentation.

We've added new possible import options for files:

• Add File: new ImportOptions possible value - Docx File Import Options (including the response)

• Update or Restore File: new ImportOptions possible value - Docx File Import Options (including the response)

• Edit File: new /importOptions/* path parameters

So these changes should be reflected in this API Client.

The Source Files API now supports the possibility to specify the context for the whole file. We need to add support for the context property to this Crowdin API client.

References:

• Add File
• Edit File
• Get file (response)

The crowdin.com and Crowdin Enterprise API docs were moved to the developer.crowdin.com domain instead of support.crowdin.com, so the URLs in the method annotations should be updated.

For crowdin.com:

https://support.crowdin.com/api/v2/* -> https://developer.crowdin.com/api/v2/*

For Crowdin Enterprise:

https://support.crowdin.com/enterprise/api/* -> https://developer.crowdin.com/enterprise/api/v2/*

Crowdin API has a new Notifications API that allows sending notifications to the project and organization members. It would be great to add support for this API in this Crowdin API client.

API reference:

• Send Notification to Authenticated User (crowdin.com)
• Send Notification To Project Members (crowdin.com and Crowdin Enterprise)
• Send Notification To Organization Members (Crowdin Enterprise)

The \CrowdinApiClient\Api\TranslationApi::uploadTranslations function is missing the content-type "application/json" header.
This results in a 415 unsupported media type response.
Steps to reproduce:

1. Create a storage e.g:
   1.1 $storage = $this->crowdin->storage->create(new \SplFileObject($file));
2. Try to upload the storage as a translation file e.g:

$this->crowdin->translation->uploadTranslations($crowdinProjectId, $languageId, [
    'storageId' => $storage->getId(),
    'fileId' => $fileId,
]); 

API Reference:

• api.mts.translations.post (crowdin.com)
• api.mts.translations.post (Crowdin Enterprise)