2021-06-02 17:00:32 +03:00
|
|
|
# Documentation
|
|
|
|
|
|
2022-11-17 12:18:34 +03:00
|
|
|
* [Dealing with `civicrm/composer-compile-plugin` prompts](compilation_prompt.md)
|
|
|
|
|
+ [Disable compilation prompts during the installation](compilation_prompt.md#disable-compilation-prompts-during-the-installation)
|
|
|
|
|
+ [I've chosen something else, now API client doesn't work!](compilation_prompt.md#ive-chosen-something-else-now-api-client-doesnt-work)
|
|
|
|
|
+ [Disabling compilation prompts manually](compilation_prompt.md#disabling-compilation-prompts-manually)
|
2021-06-02 17:00:32 +03:00
|
|
|
* [Client structure](structure.md)
|
|
|
|
|
+ [Design principles](structure.md#design-principles)
|
|
|
|
|
+ [Resource groups](structure.md#resource-groups)
|
|
|
|
|
* [Usage](usage/usage.md)
|
|
|
|
|
+ [Instantiation](usage/instantiation.md)
|
|
|
|
|
+ [Sending a request](usage/sending_a_request.md)
|
|
|
|
|
+ [Choosing correct resource group, DTOs, and method](usage/sending_a_request.md#choosing-correct-resource-group-dtos-and-method)
|
|
|
|
|
+ [Sending a request](usage/sending_a_request.md#sending-a-request)
|
|
|
|
|
+ [Dealing with exceptions](usage/sending_a_request.md#dealing-with-exceptions)
|
|
|
|
|
+ [Error handling](usage/error_handling.md)
|
|
|
|
|
+ [Examples](usage/examples)
|
|
|
|
|
+ [How to create an order](usage/examples/create_order.md)
|
|
|
|
|
+ [How to receive the list of orders](usage/examples/fetch_orders.md)
|
|
|
|
|
+ [How to handle all Client's exceptions](usage/examples/complete_error_handling_example.md)
|
|
|
|
|
+ [Event handling](usage/event_handing.md)
|
|
|
|
|
* [Customization](customization/customization.md)
|
|
|
|
|
+ [Controlling HTTP abstraction layer](customization/different_psr_implementations.md)
|
|
|
|
|
+ [Customizing request and response processing](customization/pipelines/implementing_a_handler.md)
|
|
|
|
|
+ [Using a predefined handler](customization/pipelines/using_a_predefined_handler.md)
|
|
|
|
|
+ [Built-in handlers](customization/pipelines/using_a_predefined_handler.md#built-in-handlers)
|
|
|
|
|
+ [Modifying the default pipeline](customization/pipelines/using_a_predefined_handler.md#modifying-the-default-pipeline)
|
|
|
|
|
+ [Constructing the pipeline from scratch](customization/pipelines/using_a_predefined_handler.md#constructing-the-pipeline-from-scratch)
|
|
|
|
|
+ [Implementing a handler](customization/pipelines/implementing_a_handler.md)
|
2021-11-25 11:02:42 +03:00
|
|
|
+ [Implementing custom API methods](customization/implementing_custom_api_methods.md)
|
2021-06-02 17:00:32 +03:00
|
|
|
* [Troubleshooting](troubleshooting.md)
|
2021-11-25 11:02:42 +03:00
|
|
|
* [PHPDoc](https://retailcrm.github.io/api-client-php/)
|
