Packages
harness_ff_erlang_client_api

1.0.4
1.0.4 1.0.3 1.0.2 1.0.1 1.0.0
OpenAPI Client libary for Harness Feature Flags Erlang Server SDK
HexDocs
Current section
Files
Jump to
Readme 5 Versions 3 Dependencies 1 Dependant Files Activity
harness_ff_erlang_client_api src cfapi_client_api.erl
Raw
src/cfapi_client_api.erl

-module(cfapi_client_api).

-export([authenticate/1, authenticate/2,
         get_all_segments/2, get_all_segments/3,
         get_evaluation_by_identifier/4, get_evaluation_by_identifier/5,
         get_evaluations/3, get_evaluations/4,
         get_feature_config/2, get_feature_config/3,
         get_feature_config_by_identifier/3, get_feature_config_by_identifier/4,
         get_segment_by_identifier/3, get_segment_by_identifier/4,
         stream/2, stream/3]).



%% @doc Authenticate with the admin server.
%% Used to retrieve all target segments for certain account id.
-spec authenticate(ctx:ctx()) -> {ok, cfapi_authentication_response:cfapi_authentication_response(), cfapi_utils:response_info()} | {ok, hackney:client_ref()} | {error, term(), cfapi_utils:response_info()}.
authenticate(Ctx) ->
    authenticate(Ctx, #{}).

-spec authenticate(ctx:ctx(), maps:map()) -> {ok, cfapi_authentication_response:cfapi_authentication_response(), cfapi_utils:response_info()} | {ok, hackney:client_ref()} | {error, term(), cfapi_utils:response_info()}.
authenticate(Ctx, Optional) ->
    OptionalParams = maps:get(params, Optional, #{}),
    Cfg = maps:get(cfg, Optional, application:get_env(kuberl, config, #{})),

    Method = post,
    Path = [<<"/client/auth">>],
    QS = [],
    Headers = [],
    Body1 = OptionalParams,
    ContentTypeHeader = cfapi_utils:select_header_content_type([<<"application/json">>]),
    Opts = maps:get(hackney_opts, Optional, []),

    cfapi_utils:request(Ctx, Method, [Path], QS, ContentTypeHeader++Headers, Body1, Opts, Cfg).

%% @doc Retrieve all segments.
%% Used to retrieve all segments for certain account id.
-spec get_all_segments(ctx:ctx(), binary()) -> {ok, [cfapi_segment:cfapi_segment()], cfapi_utils:response_info()} | {ok, hackney:client_ref()} | {error, term(), cfapi_utils:response_info()}.
get_all_segments(Ctx, EnvironmentUUID) ->
    get_all_segments(Ctx, EnvironmentUUID, #{}).

-spec get_all_segments(ctx:ctx(), binary(), maps:map()) -> {ok, [cfapi_segment:cfapi_segment()], cfapi_utils:response_info()} | {ok, hackney:client_ref()} | {error, term(), cfapi_utils:response_info()}.
get_all_segments(Ctx, EnvironmentUUID, Optional) ->
    _OptionalParams = maps:get(params, Optional, #{}),
    Cfg = maps:get(cfg, Optional, application:get_env(kuberl, config, #{})),

    Method = get,
    Path = [<<"/client/env/", EnvironmentUUID/binary, "/target-segments">>],
    QS = lists:flatten([])++cfapi_utils:optional_params(['cluster'], _OptionalParams),
    Headers = [],
    Body1 = [],
    ContentTypeHeader = cfapi_utils:select_header_content_type([]),
    Opts = maps:get(hackney_opts, Optional, []),

    cfapi_utils:request(Ctx, Method, [Path], QS, ContentTypeHeader++Headers, Body1, Opts, Cfg).

%% @doc Get feature evaluations for target
%% 
-spec get_evaluation_by_identifier(ctx:ctx(), binary(), binary(), binary()) -> {ok, cfapi_evaluation:cfapi_evaluation(), cfapi_utils:response_info()} | {ok, hackney:client_ref()} | {error, term(), cfapi_utils:response_info()}.
get_evaluation_by_identifier(Ctx, EnvironmentUUID, Feature, Target) ->
    get_evaluation_by_identifier(Ctx, EnvironmentUUID, Feature, Target, #{}).

-spec get_evaluation_by_identifier(ctx:ctx(), binary(), binary(), binary(), maps:map()) -> {ok, cfapi_evaluation:cfapi_evaluation(), cfapi_utils:response_info()} | {ok, hackney:client_ref()} | {error, term(), cfapi_utils:response_info()}.
get_evaluation_by_identifier(Ctx, EnvironmentUUID, Feature, Target, Optional) ->
    _OptionalParams = maps:get(params, Optional, #{}),
    Cfg = maps:get(cfg, Optional, application:get_env(kuberl, config, #{})),

    Method = get,
    Path = [<<"/client/env/", EnvironmentUUID/binary, "/target/", Target, "/evaluations/", Feature, "">>],
    QS = lists:flatten([])++cfapi_utils:optional_params(['cluster'], _OptionalParams),
    Headers = [],
    Body1 = [],
    ContentTypeHeader = cfapi_utils:select_header_content_type([]),
    Opts = maps:get(hackney_opts, Optional, []),

    cfapi_utils:request(Ctx, Method, [Path], QS, ContentTypeHeader++Headers, Body1, Opts, Cfg).

%% @doc Get feature evaluations for target
%% 
-spec get_evaluations(ctx:ctx(), binary(), binary()) -> {ok, cfapi_get_evaluations_200_response:cfapi_get_evaluations_200_response(), cfapi_utils:response_info()} | {ok, hackney:client_ref()} | {error, term(), cfapi_utils:response_info()}.
get_evaluations(Ctx, EnvironmentUUID, Target) ->
    get_evaluations(Ctx, EnvironmentUUID, Target, #{}).

-spec get_evaluations(ctx:ctx(), binary(), binary(), maps:map()) -> {ok, cfapi_get_evaluations_200_response:cfapi_get_evaluations_200_response(), cfapi_utils:response_info()} | {ok, hackney:client_ref()} | {error, term(), cfapi_utils:response_info()}.
get_evaluations(Ctx, EnvironmentUUID, Target, Optional) ->
    _OptionalParams = maps:get(params, Optional, #{}),
    Cfg = maps:get(cfg, Optional, application:get_env(kuberl, config, #{})),

    Method = get,
    Path = [<<"/client/env/", EnvironmentUUID/binary, "/target/", Target, "/evaluations">>],
    QS = lists:flatten([])++cfapi_utils:optional_params(['cluster'], _OptionalParams),
    Headers = [],
    Body1 = [],
    ContentTypeHeader = cfapi_utils:select_header_content_type([]),
    Opts = maps:get(hackney_opts, Optional, []),

    cfapi_utils:request(Ctx, Method, [Path], QS, ContentTypeHeader++Headers, Body1, Opts, Cfg).

%% @doc Get all feature flags activations
%% All feature flags with activations in project environment
-spec get_feature_config(ctx:ctx(), binary()) -> {ok, [cfapi_feature_config:cfapi_feature_config()], cfapi_utils:response_info()} | {ok, hackney:client_ref()} | {error, term(), cfapi_utils:response_info()}.
get_feature_config(Ctx, EnvironmentUUID) ->
    get_feature_config(Ctx, EnvironmentUUID, #{}).

-spec get_feature_config(ctx:ctx(), binary(), maps:map()) -> {ok, [cfapi_feature_config:cfapi_feature_config()], cfapi_utils:response_info()} | {ok, hackney:client_ref()} | {error, term(), cfapi_utils:response_info()}.
get_feature_config(Ctx, EnvironmentUUID, Optional) ->
    _OptionalParams = maps:get(params, Optional, #{}),
    Cfg = maps:get(cfg, Optional, application:get_env(kuberl, config, #{})),
    Method = get,
    Path = [<<"/client/env/", EnvironmentUUID/binary, "/feature-configs">>],
    QS = lists:flatten([])++cfapi_utils:optional_params(['cluster'], _OptionalParams),
    Headers = [],
    Body1 = [],
    ContentTypeHeader = cfapi_utils:select_header_content_type([]),
    Opts = maps:get(hackney_opts, Optional, []),

    cfapi_utils:request(Ctx, Method, [Path], QS, ContentTypeHeader++Headers, Body1, Opts, Cfg).

%% @doc Get feature config
%% 
-spec get_feature_config_by_identifier(ctx:ctx(), binary(), binary()) -> {ok, cfapi_feature_config:cfapi_feature_config(), cfapi_utils:response_info()} | {ok, hackney:client_ref()} | {error, term(), cfapi_utils:response_info()}.
get_feature_config_by_identifier(Ctx, Identifier, EnvironmentUUID) ->
    get_feature_config_by_identifier(Ctx, Identifier, EnvironmentUUID, #{}).

-spec get_feature_config_by_identifier(ctx:ctx(), binary(), binary(), maps:map()) -> {ok, cfapi_feature_config:cfapi_feature_config(), cfapi_utils:response_info()} | {ok, hackney:client_ref()} | {error, term(), cfapi_utils:response_info()}.
get_feature_config_by_identifier(Ctx, Identifier, EnvironmentUUID, Optional) ->
    _OptionalParams = maps:get(params, Optional, #{}),
    Cfg = maps:get(cfg, Optional, application:get_env(kuberl, config, #{})),

    Method = get,
    Path = [<<"/client/env/", EnvironmentUUID/binary, "/feature-configs/", Identifier, "">>],
    QS = lists:flatten([])++cfapi_utils:optional_params(['cluster'], _OptionalParams),
    Headers = [],
    Body1 = [],
    ContentTypeHeader = cfapi_utils:select_header_content_type([]),
    Opts = maps:get(hackney_opts, Optional, []),

    cfapi_utils:request(Ctx, Method, [Path], QS, ContentTypeHeader++Headers, Body1, Opts, Cfg).

%% @doc Retrieve a segment by identifier
%% Used to retrieve a segment for a certain account id by identifier
-spec get_segment_by_identifier(ctx:ctx(), binary(), binary()) -> {ok, cfapi_segment:cfapi_segment(), cfapi_utils:response_info()} | {ok, hackney:client_ref()} | {error, term(), cfapi_utils:response_info()}.
get_segment_by_identifier(Ctx, Identifier, EnvironmentUUID) ->
    get_segment_by_identifier(Ctx, Identifier, EnvironmentUUID, #{}).

-spec get_segment_by_identifier(ctx:ctx(), binary(), binary(), maps:map()) -> {ok, cfapi_segment:cfapi_segment(), cfapi_utils:response_info()} | {ok, hackney:client_ref()} | {error, term(), cfapi_utils:response_info()}.
get_segment_by_identifier(Ctx, Identifier, EnvironmentUUID, Optional) ->
    _OptionalParams = maps:get(params, Optional, #{}),
    Cfg = maps:get(cfg, Optional, application:get_env(kuberl, config, #{})),

    Method = get,
    Path = [<<"/client/env/", EnvironmentUUID/binary, "/target-segments/", Identifier, "">>],
    QS = lists:flatten([])++cfapi_utils:optional_params(['cluster'], _OptionalParams),
    Headers = [],
    Body1 = [],
    ContentTypeHeader = cfapi_utils:select_header_content_type([]),
    Opts = maps:get(hackney_opts, Optional, []),

    cfapi_utils:request(Ctx, Method, [Path], QS, ContentTypeHeader++Headers, Body1, Opts, Cfg).

%% @doc Stream endpoint.
%% 
-spec stream(ctx:ctx(), binary()) -> {ok, [], cfapi_utils:response_info()} | {ok, hackney:client_ref()} | {error, term(), cfapi_utils:response_info()}.
stream(Ctx, APIKey) ->
    stream(Ctx, APIKey, #{}).

-spec stream(ctx:ctx(), binary(), maps:map()) -> {ok, [], cfapi_utils:response_info()} | {ok, hackney:client_ref()} | {error, term(), cfapi_utils:response_info()}.
stream(Ctx, APIKey, Optional) ->
    _OptionalParams = maps:get(params, Optional, #{}),
    Cfg = maps:get(cfg, Optional, application:get_env(kuberl, config, #{})),

    Method = get,
    Path = [<<"/stream">>],
    QS = lists:flatten([])++cfapi_utils:optional_params(['cluster'], _OptionalParams),
    Headers = [  {<<"API-Key">>, APIKey}]++cfapi_utils:optional_params([], _OptionalParams),
    Body1 = [],
    ContentTypeHeader = cfapi_utils:select_header_content_type([]),
    Opts = maps:get(hackney_opts, Optional, []),

    cfapi_utils:request(Ctx, Method, [Path], QS, ContentTypeHeader++Headers, Body1, Opts, Cfg).
Operator	Description	Example
name:	Match package name. Supports * wildcards and repo/package form	name:phx* or name:hexpm/phoenix
description:	Full-text search of package descriptions	description:auth
depends:	Packages depending on a given package. Supports repo:package form	depends:ecto or depends:hexpm:ecto
build_tool:	Filter by build tool	build_tool:mix
updated_after:	Packages updated after an ISO8601 datetime	updated_after:2025-01-01T00:00:00Z
extra:	Match custom metadata (key,value). Nested keys are separated by commas	extra:license,MIT