LogpointApi.Core.UserDefinedList (logpoint_api v2.0.1)

Copy Markdown View Source

Manage user-defined lists in Logpoint.

Wraps the User Defined Lists API.

Summary

Functions

Import a static list from CSV or TXT content.

List user defined lists.

Functions

import_static(client, name, content)

@spec import_static(LogpointApi.Data.Client.t(), String.t(), String.t()) ::
  {:ok, map()} | {:error, term()}

Import a static list from CSV or TXT content.

list(client, params \\ %{})

@spec list(LogpointApi.Data.Client.t(), map()) :: {:ok, map()} | {:error, term()}

List user defined lists.

Supported keys in params:

  • :limit - maximum number of lists to return
  • :page - page number for pagination
  • :return_all_data - when true, returns all list data

Examples

UserDefinedList.list(client)
UserDefinedList.list(client, %{limit: 25, page: 2})