@spec active_policy() :: map()

Returns the active policy and its validation (Legacy).

Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

@spec get_active_policy_v2(keyword()) :: map()

Get the active policy and its validation by policy type (V2 Beta).

Returns the active policy and its validation for a specific policy type.

Note: This endpoint is currently in beta and subject to change. Contact your Fireblocks Customer Success Manager or send an email to csm@fireblocks.com.

Endpoint Permissions: Owner, Admin, Non-Signing Admin.

Options:

• :policyType (list of String.t/0) - Required. One or more policy types to filter by. Can be repeated for multiple types. Valid values: TRANSFER, STAKE, CONTRACT_CALL, TYPED_MESSAGE, APPROVE, MINT, BURN, RAW, COMPLIANCE, DEPLOYMENT, PROGRAM_CALL, DAPP_CONNECTION, UPGRADE, ORDER, AML_CHAINALYSIS_V2_SCREENING, AML_CHAINALYSIS_V2_POST_SCREENING, AML_ELLIPTIC_HOLISTIC_SCREENING, AML_ELLIPTIC_HOLISTIC_POST_SCREENING, TR_NOTABENE_SCREENING, TR_NOTABENE_POST_SCREENING.

@spec get_draft() :: map()

Returns the active draft and its validation (Legacy).

Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

@spec get_draft_v2(keyword()) :: map()

Get the active draft by policy type (V2 Beta).

Returns the active draft and its validation for a specific policy type.

Note: These endpoints are currently in beta and might be subject to changes.

Endpoint Permissions: Owner, Admin, Non-Signing Admin.

Options:

• :policyType (list of String.t/0) - Required. One or more policy types to filter by. Can be repeated for multiple types. Valid values: TRANSFER, STAKE, CONTRACT_CALL, TYPED_MESSAGE, APPROVE, MINT, BURN, RAW, COMPLIANCE, DEPLOYMENT, PROGRAM_CALL, DAPP_CONNECTION, UPGRADE, ORDER, AML_CHAINALYSIS_V2_SCREENING, AML_CHAINALYSIS_V2_POST_SCREENING, AML_ELLIPTIC_HOLISTIC_SCREENING, AML_ELLIPTIC_HOLISTIC_POST_SCREENING, TR_NOTABENE_SCREENING, TR_NOTABENE_POST_SCREENING.

@spec publish_draft(
  keyword(),
  String.t()
) :: map()

Send a publish request for a draft by its ID (Legacy).

Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

Options:

• :draftId (String.t/0) - Required. The unique identifier of the draft to publish.

@spec publish_draft_v2(
  keyword(),
  String.t()
) :: map()

Send a publish request for a draft by ID and policy types (V2 Beta).

Sends a publish request for a certain draft ID and returns the result.

Note: These endpoints are currently in beta and might be subject to changes. Contact your Fireblocks Customer Success Manager or send an email to csm@fireblocks.com.

Endpoint Permissions: Owner, Admin, Non-Signing Admin.

Options:

• :policyTypes (list of String.t/0) - Required. One or more policy types this draft applies to. Valid values: TRANSFER, STAKE, CONTRACT_CALL, TYPED_MESSAGE, APPROVE, MINT, BURN, RAW, COMPLIANCE, DEPLOYMENT, PROGRAM_CALL, DAPP_CONNECTION, UPGRADE, ORDER, AML_CHAINALYSIS_V2_SCREENING, AML_CHAINALYSIS_V2_POST_SCREENING, AML_ELLIPTIC_HOLISTIC_SCREENING, AML_ELLIPTIC_HOLISTIC_POST_SCREENING, TR_NOTABENE_SCREENING, TR_NOTABENE_POST_SCREENING.

• :draftId (String.t/0) - Required. The unique identifier of the draft to publish.

@spec publish_policy_rules(
  keyword(),
  String.t()
) :: map()

Publish a set of policy rules directly (Legacy).

Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

Options:

• :rules (list of map/0) - Required. List of policy rule maps to publish directly.

@spec update_draft(
  keyword(),
  String.t()
) :: map()

Update the draft with a new set of rules (Legacy).

Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

Options:

• :rules (list of map/0) - Required. List of policy rule maps to set as the new draft.

@spec update_draft_v2(
  keyword(),
  String.t()
) :: map()

Update the draft with a new set of rules by policy types (V2 Beta).

Updates the draft and returns its validation for specific policy types.

Note: These endpoints are currently in beta and might be subject to changes.

Endpoint Permissions: Owner, Admin, Non-Signing Admin.

Options:

• :policyTypes (list of String.t/0) - Required. One or more policy types this draft applies to. Valid values: TRANSFER, STAKE, CONTRACT_CALL, TYPED_MESSAGE, APPROVE, MINT, BURN, RAW, COMPLIANCE, DEPLOYMENT, PROGRAM_CALL, DAPP_CONNECTION, UPGRADE, ORDER, AML_CHAINALYSIS_V2_SCREENING, AML_CHAINALYSIS_V2_POST_SCREENING, AML_ELLIPTIC_HOLISTIC_SCREENING, AML_ELLIPTIC_HOLISTIC_POST_SCREENING, TR_NOTABENE_SCREENING, TR_NOTABENE_POST_SCREENING.

• :rules (list of map/0) - Required. Array of V2 PolicyRule maps to set as the new draft.