getTemplateList method
List all templates
Returns a list of all templates. The templates are returned sorted by position.
Parameters:
-
String templateType (required): The type of templates to list (email or SMS)
-
bool paginated: Whether to paginate the results. If true, the results will be paginated. If false, the results will not be paginated.
-
int limit: Applies a limit to the number of results returned. Can be used for paginating the results together with
offset
. -
int offset: Skip the first
offset
results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction withlimit
.
Implementation
Future<List<Template>?> getTemplateList(
String templateType, {
bool? paginated,
int? limit,
int? offset,
}) async {
final response = await getTemplateListWithHttpInfo(
templateType,
paginated: paginated,
limit: limit,
offset: offset,
);
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
// When a remote server returns no body with a status of 204, we shall not decode it.
// At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
// FormatException when trying to decode an empty string.
if (response.body.isNotEmpty &&
response.statusCode != HttpStatus.noContent) {
final responseBody = await _decodeBodyBytes(response);
return (await apiClient.deserializeAsync(responseBody, 'List<Template>')
as List)
.cast<Template>()
.toList(growable: false);
}
return null;
}