View Source cfapi_client_api (cfapi v1.0.1)

-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 with the admin server. Used to retrieve all target segments for certain account id.

authenticate(Ctx, Optional)

-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()}.

get_all_segments(Ctx, EnvironmentUUID)

-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()}.

Retrieve all segments. Used to retrieve all segments for certain account id.

get_all_segments(Ctx, EnvironmentUUID, Optional)

-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_evaluation_by_identifier(Ctx, EnvironmentUUID, Feature, 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 feature evaluations for target

get_evaluation_by_identifier(Ctx, EnvironmentUUID, Feature, Target, Optional)

-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_evaluations(Ctx, EnvironmentUUID, 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 feature evaluations for target

get_evaluations(Ctx, EnvironmentUUID, Target, Optional)

-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_feature_config(Ctx, EnvironmentUUID)

-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 all feature flags activations All feature flags with activations in project environment

get_feature_config(Ctx, EnvironmentUUID, Optional)

-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_by_identifier(Ctx, Identifier, EnvironmentUUID)

-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

get_feature_config_by_identifier(Ctx, Identifier, EnvironmentUUID, Optional)

-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_segment_by_identifier(Ctx, Identifier, EnvironmentUUID)

-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()}.

Retrieve a segment by identifier Used to retrieve a segment for a certain account id by identifier

get_segment_by_identifier(Ctx, Identifier, EnvironmentUUID, Optional)

-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()}.

stream(Ctx, APIKey)

-spec stream(ctx:ctx(), binary()) ->
          {ok, [], cfapi_utils:response_info()} |
          {ok, hackney:client_ref()} |
          {error, term(), cfapi_utils:response_info()}.

Stream endpoint.

stream(Ctx, APIKey, Optional)

-spec stream(ctx:ctx(), binary(), maps:map()) ->
          {ok, [], cfapi_utils:response_info()} |
          {ok, hackney:client_ref()} |
          {error, term(), cfapi_utils:response_info()}.

Settings View Source cfapi_client_api (cfapi v1.0.1)

Link to this section Summary

Functions

Link to this section Functions

authenticate(Ctx)