getAllInboxesWithHttpInfo method

Future<Response> getAllInboxesWithHttpInfo({ int? page, int? size, String? sort, bool? favourite, String? search, String? tag, bool? teamAccess, DateTime? since, DateTime? before, String? inboxType, String? domainId, })

List All Inboxes Paginated

List inboxes in paginated form. The results are available on the content property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative getInboxes method returns a full list of inboxes but is limited to 100 results.

Note: This method returns the HTTP Response.

Parameters:

• int page: Optional page index in list pagination

• int size: Optional page size in list pagination

• String sort: Optional createdAt sort direction ASC or DESC

• bool favourite: Optionally filter results for favourites only

• String search: Optionally filter by search words partial matching ID, tags, name, and email address

• String tag: Optionally filter by tags. Will return inboxes that include given tags

• bool teamAccess: DEPRECATED. Optionally filter by team access.

• DateTime since: Optional filter by created after given date time

• DateTime before: Optional filter by created before given date time

• String inboxType: Optional filter by inbox type

• String domainId: Optional domain ID filter

Implementation

Future<Response> getAllInboxesWithHttpInfo({ int? page, int? size, String? sort, bool? favourite, String? search, String? tag, bool? teamAccess, DateTime? since, DateTime? before, String? inboxType, String? domainId, }) async {
  // ignore: prefer_const_declarations
  final path = r'/inboxes/paginated';

  // ignore: prefer_final_locals
  Object? postBody;

  final queryParams = <QueryParam>[];
  final headerParams = <String, String>{};
  final formParams = <String, String>{};

  if (page != null) {
    queryParams.addAll(_queryParams('', 'page', page));
  }
  if (size != null) {
    queryParams.addAll(_queryParams('', 'size', size));
  }
  if (sort != null) {
    queryParams.addAll(_queryParams('', 'sort', sort));
  }
  if (favourite != null) {
    queryParams.addAll(_queryParams('', 'favourite', favourite));
  }
  if (search != null) {
    queryParams.addAll(_queryParams('', 'search', search));
  }
  if (tag != null) {
    queryParams.addAll(_queryParams('', 'tag', tag));
  }
  if (teamAccess != null) {
    queryParams.addAll(_queryParams('', 'teamAccess', teamAccess));
  }
  if (since != null) {
    queryParams.addAll(_queryParams('', 'since', since));
  }
  if (before != null) {
    queryParams.addAll(_queryParams('', 'before', before));
  }
  if (inboxType != null) {
    queryParams.addAll(_queryParams('', 'inboxType', inboxType));
  }
  if (domainId != null) {
    queryParams.addAll(_queryParams('', 'domainId', domainId));
  }

  const contentTypes = <String>[];


  return apiClient.invokeAPI(
    path,
    'GET',
    queryParams,
    postBody,
    headerParams,
    formParams,
    contentTypes.isEmpty ? null : contentTypes.first,
  );
}