<!--- auto generated by `bin/console docs:generate-scripts-reference` in the shopware project, don't edit this file manually -->
# {{ title }} script services reference

{% for service in services %}
{% if service.link is not null %}
## [{{ service.name|raw }}]({{ service.link }}) {{ service.marker }}
{% else %}
## {{ service.name|raw }} {{ service.marker }}

{% endif %}

{% if service.deprecated %}
**Deprecated:** {{ service.deprecated|raw }}

{% endif %}
{{ service.summary|raw }}
{{ service.description|raw }}

{% for method in service.methods %}
### {{ method.title }}

{% if method.deprecated %}
**Deprecated:** {{ method.deprecated|raw }}

{% endif %}
* {{ method.summary|raw }}

    {{ method.description|replace({"\n": "\n\t"})|raw }}
{% if method.return is not empty %}
* **Returns** {{ method.return.type }}

    {{ method.return.description }}
{% endif %}
{% if method.arguments is not empty %}
* **Arguments:**
{% for argument in method.arguments %}
    * *{{ argument.type }}* **{{ argument.name }}**: {{ argument.description }}
{% if argument.default is not null %}

        Default: `{{ argument.default }}`
{% endif %}
{% endfor %}
{% endif %}
{% if method.examples is not empty %}
* **Examples:**
{% for example in method.examples %}
    * {{ example.description|raw }}

        {% verbatim %}{% raw %}{% endverbatim %}
        ```{{ example.extension }}
{# somehow the rendering breaks if we use two tabs in the replace #}
        {{ example.src|replace({"\n": "\n\t\t"})|raw }}
        ```
        {% verbatim %}{% endraw %}{% endverbatim %}
{% endfor %}
{% endif %}
{% endfor %}
_________
{% endfor %}