|
| 1 | +# {{moduleName}}.{{classname}}{{#description}} |
| 2 | + |
| 3 | +{{description}}{{/description}} |
| 4 | + |
| 5 | +All URIs are relative to *{{basePath}}* |
| 6 | + |
| 7 | +Method | HTTP request | Description |
| 8 | +------------- | ------------- | ------------- |
| 9 | +{{#operations}}{{#operation}}[**{{operationId}}**]({{classname}}.md#{{operationId}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{summary}}{{/summary}} |
| 10 | +{{/operation}}{{/operations}} |
| 11 | + |
| 12 | +{{#operations}} |
| 13 | +{{#operation}} |
| 14 | +# **{{{operationId}}}** |
| 15 | +> {{#returnType}}{{{returnType}}} {{/returnType}}{{{operationId}}}({{#requiredParams}}{{^defaultValue}}{{paramName}}{{^-last}}, {{/-last}}{{/defaultValue}}{{/requiredParams}}) |
| 16 | + |
| 17 | +{{#notes}} |
| 18 | +{{{notes}}} |
| 19 | +{{/notes}} |
| 20 | + |
| 21 | +### Example |
| 22 | + |
| 23 | + |
| 24 | +```typescript |
| 25 | +import { {{{moduleName}}} } from '{{{projectName}}}'; |
| 26 | +import * as fs from 'fs'; |
| 27 | + |
| 28 | +const configuration = {{{moduleName}}}.createConfiguration(); |
| 29 | +const apiInstance = new {{{moduleName}}}.{{classname}}(configuration); |
| 30 | + |
| 31 | +{{#hasParams}} |
| 32 | +let body:{{{moduleName}}}.{{classname}}{{operationIdCamelCase}}Request = { |
| 33 | +{{#allParams}} |
| 34 | + // {{{dataType}}}{{#description}} | {{{description}}}{{/description}}{{^required}} (optional){{/required}} |
| 35 | + {{paramName}}: {{{example}}}, |
| 36 | +{{/allParams}} |
| 37 | +}; |
| 38 | +{{/hasParams}} |
| 39 | +{{^hasParams}} |
| 40 | +let body:any = {}; |
| 41 | +{{/hasParams}} |
| 42 | + |
| 43 | +apiInstance.{{{operationId}}}(body).then((data:any) => { |
| 44 | + console.log('API called successfully. Returned data: ' + data); |
| 45 | +}).catch((error:any) => console.error(error)); |
| 46 | +``` |
| 47 | + |
| 48 | + |
| 49 | +### Parameters |
| 50 | +{{^hasParams}}This endpoint does not need any parameter.{{/hasParams}}{{#allParams}}{{#-last}} |
| 51 | +Name | Type | Description | Notes |
| 52 | +------------- | ------------- | ------------- | -------------{{/-last}}{{/allParams}} |
| 53 | +{{#allParams}}{{^defaultValue}} **{{paramName}}** | {{^isPrimitiveType}}**{{{dataType}}}**{{/isPrimitiveType}}{{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}| {{description}} | |
| 54 | +{{/defaultValue}}{{/allParams}}{{#allParams}}{{#defaultValue}} **{{paramName}}** | {{^isPrimitiveType}}{{^isEnum}}**{{dataType}}**{{/isEnum}}{{/isPrimitiveType}}{{#isPrimitiveType}}[**{{dataType}}**]{{/isPrimitiveType}}{{#isEnum}}{{#allowableValues}}{{#enumVars}}{{#-first}}**Array<{{/-first}}{{value}}{{^-last}} | {{/-last}}{{#-last}}>**{{/-last}}{{/enumVars}}{{/allowableValues}}{{/isEnum}} | {{description}} |{{^required}} (optional){{/required}} defaults to {{{.}}} |
| 55 | +{{/defaultValue}}{{/allParams}} |
| 56 | + |
| 57 | +### Return type |
| 58 | + |
| 59 | +{{#returnType}}{{#returnTypeIsPrimitive}}**{{{returnType}}}**{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}**{{{returnType}}}**{{/returnTypeIsPrimitive}}{{/returnType}}{{^returnType}}void (empty response body){{/returnType}} |
| 60 | + |
| 61 | +### Authorization |
| 62 | + |
| 63 | +{{^authMethods}}No authorization required{{/authMethods}}{{#authMethods}}[{{{name}}}](README.md#{{{name}}}){{^-last}}, {{/-last}}{{/authMethods}} |
| 64 | + |
| 65 | +### HTTP request headers |
| 66 | + |
| 67 | + - **Content-Type**: {{#consumes}}{{{mediaType}}}{{^-last}}, {{/-last}}{{/consumes}}{{^consumes}}Not defined{{/consumes}} |
| 68 | + - **Accept**: {{#produces}}{{{mediaType}}}{{^-last}}, {{/-last}}{{/produces}}{{^produces}}Not defined{{/produces}} |
| 69 | + |
| 70 | +{{#responses.0}} |
| 71 | + |
| 72 | +### HTTP response details |
| 73 | +| Status code | Description | Response headers | |
| 74 | +|-------------|-------------|------------------| |
| 75 | +{{#responses}} |
| 76 | +**{{code}}** | {{message}} | {{#headers}} * {{baseName}} - {{description}} <br> {{/headers}}{{^headers.0}} - {{/headers.0}} | |
| 77 | +{{/responses}} |
| 78 | +{{/responses.0}} |
| 79 | + |
| 80 | +[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md) |
| 81 | + |
| 82 | +{{/operation}} |
| 83 | +{{/operations}} |
| 84 | + |
0 commit comments