listWaitlistEntriesWithHttpInfo method

Future<Response> listWaitlistEntriesWithHttpInfo({
  1. int? limit,
  2. int? offset,
  3. String? query,
  4. String? status,
  5. String? orderBy,
})

List all waitlist entries

Retrieve a list of waitlist entries for the instance. Entries are ordered by creation date in descending order by default. Supports filtering by email address or status and pagination with limit and offset parameters.

Note: This method returns the HTTP Response.

Parameters:

  • 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 with limit.

  • String query: Filter waitlist entries by email_address or id

  • String status: Filter waitlist entries by their status

  • String orderBy: Specify the order of results. Supported values are: - created_at - email_address - invited_at Use + for ascending or - for descending order. Defaults to -created_at.

Implementation

Future<http.Response> listWaitlistEntriesWithHttpInfo({
  int? limit,
  int? offset,
  String? query,
  String? status,
  String? orderBy,
}) async {
  // ignore: prefer_const_declarations
  final path = r'/waitlist_entries';

  // ignore: prefer_final_locals
  Object? postBody;

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

  if (limit != null) {
    queryParams.addAll(_queryParams('', 'limit', limit));
  }
  if (offset != null) {
    queryParams.addAll(_queryParams('', 'offset', offset));
  }
  if (query != null) {
    queryParams.addAll(_queryParams('', 'query', query));
  }
  if (status != null) {
    queryParams.addAll(_queryParams('', 'status', status));
  }
  if (orderBy != null) {
    queryParams.addAll(_queryParams('', 'order_by', orderBy));
  }

  const contentTypes = <String>[];

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