abusezero 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
data/lib/abusezero.rb ADDED
@@ -0,0 +1,4 @@
1
+ require_relative 'abusezero/client'
2
+ module AbuseZero
3
+ VERSION = '0.1.0'
4
+ end
data/sig/abusezero.rbs ADDED
@@ -0,0 +1,188 @@
1
+ module AbuseZero
2
+ class Client < Core
3
+ def workspaces: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "data" => Array[{ "object" => String }], "next_cursor" => String | nil })
4
+ def me: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "credential" => String, "person" => { "name" => String | nil, "email" => String | nil } | nil, "app" => { "id" => String, "name" => String | nil } | nil, "api_key" => { "id" => String, "name" => String | nil, "type" => String } | nil, "machine_client" => { "id" => String, "name" => String | nil } | nil, "workspace" => { "id" => String, "name" => String | nil } | nil, "role" => String | nil, "permissions" => Array[String], "scopes" => Array[String] })
5
+ def api_keys: (?{ ?"cursor" => String, ?"limit" => Integer } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "data" => Array[{ "object" => String, "id" => String, "name" => String, "type" => String, "scopes" => Array[String], "prefix" => String | nil, "last_four" => String | nil, "value" => String | nil, "status" => String, "replacement_available" => bool, "expires_at" => String | nil, "last_used_at" => String | nil, "created_at" => String | nil }], "next_cursor" => String | nil })
6
+ def create_api_key: (?{ "name" => String, "type" => String, ?"scopes" => Array[String], ?"expires_in_days" => Integer | nil } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String, "name" => String, "type" => String, "scopes" => Array[String], "prefix" => String | nil, "last_four" => String | nil, "value" => String | nil, "status" => String, "replacement_available" => bool, "expires_at" => String | nil, "last_used_at" => String | nil, "created_at" => String | nil, "secret" => String })
7
+ def update_api_key: (?{ ?"name" => String, ?"scopes" => Array[String], ?"expires_in_days" => Integer | nil } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String, "name" => String, "type" => String, "scopes" => Array[String], "prefix" => String | nil, "last_four" => String | nil, "value" => String | nil, "status" => String, "replacement_available" => bool, "expires_at" => String | nil, "last_used_at" => String | nil, "created_at" => String | nil })
8
+ def roll_api_key: (?{ "overlap_hours" => Numeric | Numeric | Numeric } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String, "name" => String, "type" => String, "scopes" => Array[String], "prefix" => String | nil, "last_four" => String | nil, "value" => String | nil, "status" => String, "replacement_available" => bool, "expires_at" => String | nil, "last_used_at" => String | nil, "created_at" => String | nil, "secret" => String, "previous" => { "id" => String | nil, "expires_at" => String | nil } })
9
+ def show_api_key_replacement: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String, "name" => String, "type" => String, "scopes" => Array[String], "prefix" => String | nil, "last_four" => String | nil, "value" => String | nil, "status" => String, "replacement_available" => bool, "expires_at" => String | nil, "last_used_at" => String | nil, "created_at" => String | nil, "secret" => String })
10
+ def revoke_api_key: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String, "name" => String, "type" => String, "scopes" => Array[String], "prefix" => String | nil, "last_four" => String | nil, "value" => String | nil, "status" => String, "replacement_available" => bool, "expires_at" => String | nil, "last_used_at" => String | nil, "created_at" => String | nil })
11
+ def machine_clients: (?{ ?"cursor" => String, ?"limit" => Integer, ?"view" => String } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "data" => Array[{ "object" => String, "id" => String | nil, "name" => String, "scopes" => Array[String], "member" => { "name" => String | nil, "email" => String | nil, "role" => String | nil, "you" => bool, "former" => bool } | nil, "created_at" => String | nil, "last_used_at" => String | nil }], "next_cursor" => String | nil })
12
+ def create_machine_client: (?{ "name" => String, "scopes" => Array[String] } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String | nil, "name" => String, "scopes" => Array[String], "member" => { "name" => String | nil, "email" => String | nil, "role" => String | nil, "you" => bool, "former" => bool } | nil, "created_at" => String | nil, "last_used_at" => String | nil, "secret" => String, "token_endpoint" => String, "audience" => String })
13
+ def rotate_machine_client_secret: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String | nil, "secret" => String })
14
+ def revoke_machine_client: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String | nil, "deleted" => bool })
15
+ def authorized_apps: (?{ ?"cursor" => String, ?"limit" => Integer, ?"view" => String } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "data" => Array[{ "object" => String, "id" => String | nil, "name" => String, "trust" => String, "destination" => String | nil, "scopes" => Array[String], "member" => { "name" => String | nil, "email" => String | nil, "role" => String | nil, "you" => bool, "former" => bool } | nil, "approved_at" => String | nil }], "next_cursor" => String | nil })
16
+ def disconnect_authorized_app: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String | nil, "deleted" => bool })
17
+ def members: (?{ ?"cursor" => String, ?"limit" => Integer } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "data" => Array[{ "object" => String, "id" => String | nil, "name" => String | nil, "email" => String, "role" => String, "permissions" => Array[String], "invited_at" => String | nil, "joined_at" => String | nil, "last_sign_in_at" => String | nil, "you" => bool }], "next_cursor" => String | nil })
18
+ def update_member: (?{ ?"role" => String, ?"permissions" => Array[String] } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String | nil, "name" => String | nil, "email" => String, "role" => String, "permissions" => Array[String], "invited_at" => String | nil, "joined_at" => String | nil, "last_sign_in_at" => String | nil, "you" => bool })
19
+ def remove_member: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String | nil, "deleted" => bool })
20
+ def invitations: (?{ ?"cursor" => String, ?"limit" => Integer } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "data" => Array[{ "object" => String, "id" => String | nil, "email" => String, "role" => String, "invited_by" => String | nil, "status" => String, "created_at" => String | nil, "expires_at" => String | nil }], "next_cursor" => String | nil })
21
+ def invite_member: (?{ "email" => String, "role" => String } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String | nil, "email" => String, "role" => String, "invited_by" => String | nil, "status" => String, "created_at" => String | nil, "expires_at" => String | nil })
22
+ def resend_invitation: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String | nil, "email" => String, "role" => String, "invited_by" => String | nil, "status" => String, "created_at" => String | nil, "expires_at" => String | nil })
23
+ def cancel_invitation: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String | nil, "email" => String, "role" => String, "invited_by" => String | nil, "status" => String, "created_at" => String | nil, "expires_at" => String | nil })
24
+ def workspace_settings: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String, "name" => String, "icon" => { "updated_at" => String | nil } | nil, "time_zone" => String | nil, "website" => String | nil, "product_type" => { "type" => String, ?"other" => String } | nil, "data_retention" => { "evidence_days" => Integer, "max_days" => Integer, "options" => Array[Integer] } })
25
+ def update_workspace_settings: (?{ ?"name" => String, ?"website" => String | nil, ?"product_type" => { "type" => String, ?"other" => String } | nil, ?"time_zone" => String } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String, "name" => String, "icon" => { "updated_at" => String | nil } | nil, "time_zone" => String | nil, "website" => String | nil, "product_type" => { "type" => String, ?"other" => String } | nil, "data_retention" => { "evidence_days" => Integer, "max_days" => Integer, "options" => Array[Integer] } })
26
+ def upload_workspace_icon: (?{ "image" => String } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String, "state" => String })
27
+ def remove_workspace_icon: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String, "name" => String, "icon" => { "updated_at" => String | nil } | nil, "time_zone" => String | nil, "website" => String | nil, "product_type" => { "type" => String, ?"other" => String } | nil, "data_retention" => { "evidence_days" => Integer, "max_days" => Integer, "options" => Array[Integer] } })
28
+ def workspace_icon_upload: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String, "state" => String })
29
+ def set_data_retention: (?{ "evidence_days" => Integer } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String, "name" => String, "icon" => { "updated_at" => String | nil } | nil, "time_zone" => String | nil, "website" => String | nil, "product_type" => { "type" => String, ?"other" => String } | nil, "data_retention" => { "evidence_days" => Integer, "max_days" => Integer, "options" => Array[Integer] } })
30
+ def setup_progress: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "steps" => Array[{ "step" => String, "done" => bool }], "complete" => bool, "finished" => bool, "dismissed" => bool | nil })
31
+ def finish_setup: (?{ ?"website" => String | nil, ?"product_type" => { "type" => String, ?"other" => String } | nil, ?"time_zone" => String | nil } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "steps" => Array[{ "step" => String, "done" => bool }], "complete" => bool, "finished" => bool, "dismissed" => bool | nil })
32
+ def dismiss_setup_guide: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "steps" => Array[{ "step" => String, "done" => bool }], "complete" => bool, "finished" => bool, "dismissed" => bool | nil })
33
+ def leave_workspace: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "workspace" => String })
34
+ def evaluations: (?{ ?"cursor" => String, ?"limit" => Integer, ?"result" => String, ?"benefit" => String, ?"query" => String, ?"days" => Integer } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "data" => Array[{ "object" => String }], "next_cursor" => String | nil })
35
+ def evaluate: (?{ "benefit" => String, "claim_id" => String, "subject" => { ?"external_id" => String, "email" => String, ?"email_verified" => bool }, ?"context" => { ?"ip" => String | nil, ?"user_agent" => String, ?"session_id" => String } | nil, ?"identifiers" => { ?"device_id" => String, ?"device_token" => String, ?"browser_cookie_id" => String, ?"payment" => { "provider" => String, "scope" => String, "fingerprint" => String }, ?"phone_hash" => { "algorithm" => String, "key_version" => String, "value" => String }, ?"phone_verified" => bool, ?"custom" => Array[{ "key" => String, "value_hash" => { "algorithm" => String, "key_version" => String, "value" => String } }] }, ?"request" => { "method" => String, "url" => String, "headers" => Hash[String, untyped] } } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String, "result" => String, "risk" => { "score" => Numeric | nil, "band" => String }, "reason" => { "code" => String, "message" => String, ?"rule" => String } | nil, ?"outcome" => { "state" => String, "due_at" => String | nil } | nil, "source" => String } | { "object" => String, "status" => String, "reason" => String, "source" => String } | { "source" => String, "claim_id" => String, "result" => String, "error" => AbuseZero::Error })
36
+ def evaluation_filters: (?{ ?"days" => Integer } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "days" => Integer | nil, "benefits" => Array[String], "results" => Array[String], "reasons" => Array[{ "code" => String, "label" => String }] })
37
+ def get_evaluation: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String, "benefit" => String | nil, "claim_id" => String | nil, "result" => String, "reason" => { "code" => String, "message" => String, ?"rule" => String } | nil, "outcome" => { "state" => String | nil, ?"due_at" => String | nil }, "policy_version" => Numeric | nil, "created_at" => String | nil, "mode" => String, ?"observed_result" => String | nil, "risk" => { "score" => Numeric | nil, "band" => String }, "inputs" => { "email" => String, "ip" => String, "user_id" => String, "phone" => String, "payment" => String, "device" => String, "browser" => String }, "browser_data" => String | nil, "policy" => { "id" => String | nil, "version" => Numeric | nil }, "access_list_entry" => { "id" => String | nil, "kind" => String, "type" => String | nil, "value" => String | nil } | nil })
38
+ def evaluation_graph: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String })
39
+ def evaluation_evidence: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String, "benefit" => String | nil, "claim_id" => String | nil, "result" => String, "reason" => { "code" => String, "message" => String, ?"rule" => String } | nil, "outcome" => { "state" => String | nil, ?"due_at" => String | nil }, "policy_version" => Numeric | nil, "created_at" => String | nil, "mode" => String, ?"observed_result" => String | nil, "risk" => { "score" => Numeric | nil, "band" => String }, "signals" => Array[{ "family" => String, "assessment" => String }], "inputs" => { "email" => String, "ip" => String, "user_id" => String, "phone" => String, "payment" => String, "device" => String, "browser" => String }, "browser_data" => String | nil, "policy" => { "id" => String | nil, "version" => Numeric | nil }, "access_list_entry" => { "id" => String | nil, "kind" => String, "type" => String | nil, "value" => String | nil } | nil, "evidence" => { "request" => Hash[String, untyped] | nil, "device_profile" => { "status" => String, "expires_at" => String | nil } } })
40
+ def outcomes: (?{ ?"cursor" => String, ?"limit" => Integer } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "data" => Array[{ "object" => String }], "next_cursor" => String | nil })
41
+ def get_outcome: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String })
42
+ def outcome: (?{ "outcome" => String, ?"reason" => String, ?"external_outcome_id" => String } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String })
43
+ def dry_run_evaluation: (?{ "benefit" => String, "claim_id" => String, "subject" => { ?"external_id" => String, "email" => String, ?"email_verified" => bool }, ?"context" => { ?"ip" => String | nil, ?"user_agent" => String, ?"session_id" => String } | nil, ?"identifiers" => { ?"device_id" => String, ?"device_token" => String, ?"browser_cookie_id" => String, ?"payment" => { "provider" => String, "scope" => String, "fingerprint" => String }, ?"phone_hash" => { "algorithm" => String, "key_version" => String, "value" => String }, ?"phone_verified" => bool, ?"custom" => Array[{ "key" => String, "value_hash" => { "algorithm" => String, "key_version" => String, "value" => String } }] }, ?"request" => { "method" => String, "url" => String, "headers" => Hash[String, untyped] } } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "dry_run" => bool, "result" => String, "risk" => { "score" => Numeric | nil, "band" => String }, "reason" => { "code" => String, "message" => String, ?"rule" => String } | nil, "inputs" => { "email" => String, "ip" => String, "user_id" => String, "phone" => String, "payment" => String, "device" => String, "browser" => String } } | { "object" => String, "status" => String, "reason" => String })
44
+ def simulate: (?{ "benefit_id" => String, "policy_key" => String } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String })
45
+ def replay: (?{ "benefit_id" => String, "policy_key" => String } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String })
46
+ def benefits: (?{ ?"cursor" => String, ?"limit" => Integer } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "data" => Array[{ "object" => String }], "next_cursor" => String | nil })
47
+ def create_benefit: (?{ "name" => String, "key" => String, "config" => { ?"automation" => String, ?"outcome_tracking" => String, ?"missing_outcome_behavior" => String, ?"eligibility" => { "kind" => String } | { "kind" => String, "period" => String, "timezone" => String } | { "kind" => String, "days" => Integer }, ?"value" => { "amount" => Numeric, "currency" => String } }, "policy_key" => String, "protection_mode" => String } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String })
48
+ def get_benefit: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String })
49
+ def update_benefit: (?{ "name" => String, "config" => { ?"automation" => String, ?"outcome_tracking" => String, ?"missing_outcome_behavior" => String, ?"eligibility" => { "kind" => String } | { "kind" => String, "period" => String, "timezone" => String } | { "kind" => String, "days" => Integer }, ?"value" => { "amount" => Numeric, "currency" => String } }, "policy_key" => String, "protection_mode" => String, "revision" => Integer } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String })
50
+ def delete_benefit: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String | nil, "deleted" => bool })
51
+ def policies: (?{ ?"cursor" => String, ?"limit" => Integer } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "data" => Array[{ "object" => String }], "next_cursor" => String | nil })
52
+ def create_policy: (?{ "name" => String, "key" => String, "definition" => { ?"base" => String, ?"risk_threshold" => Integer | nil, "default_result" => String, "rules" => Array[{ "id" => String, "name" => String, "result" => String, "when" => untyped, ?"enabled" => bool, ?"note" => String }] } } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String })
53
+ def get_policy: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String })
54
+ def update_policy: (?{ "name" => String, "definition" => { ?"base" => String, ?"risk_threshold" => Integer | nil, "default_result" => String, "rules" => Array[{ "id" => String, "name" => String, "result" => String, "when" => untyped, ?"enabled" => bool, ?"note" => String }] }, "revision" => Integer, ?"restored_from" => Integer } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String })
55
+ def delete_policy: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String | nil, "deleted" => bool })
56
+ def duplicate_policy: (?{ "name" => String, "key" => String } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String })
57
+ def policy_versions: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "data" => Array[{ "object" => String }], "next_cursor" => String | nil })
58
+ def get_policy_version: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String })
59
+ def policy_signals: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "data" => Array[{ "object" => String }], "next_cursor" => String | nil })
60
+ def access_lists: (?{ ?"cursor" => String, ?"limit" => Integer, ?"value" => String } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "data" => Array[{ "object" => String }], "next_cursor" => String | nil })
61
+ def add_access_list_entries: (?{ "kind" => String, "type" => String, ?"value" => String, ?"values" => Array[String], ?"benefit_ids" => Array[String], "reason" => String, ?"expires_at" => String | nil, ?"expires_in_days" => Integer | nil } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String })
62
+ def get_access_list_entry: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String })
63
+ def delete_access_list_entry: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String | nil, "deleted" => bool })
64
+ def update_access_list_entry: (?{ ?"kind" => String, ?"benefit_ids" => Array[String], ?"reason" => String, ?"expires_at" => String | nil, ?"expires_in_days" => Integer | nil } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String })
65
+ def look_up_identifier: (?{ "value" => String } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "type" => String | nil, "matches" => Array[{ "object" => String, "kind" => String, "id" => String, "result" => String | nil, "benefit" => String | nil } | { "object" => String, "kind" => String, "count" => Integer, "capped" => bool, "days" => Numeric } | { "object" => String, "kind" => String, "count" => Integer, "capped" => bool } | { "object" => String, "kind" => String, "id" => String, "key" => String, "name" => String } | { "object" => String, "kind" => String, "id" => String, "key" => String, "name" => String } | { "object" => String, "kind" => String, "id" => String, "key" => String, "name" => String } | { "object" => String, "kind" => String, "id" => String, "list" => String, "type" => String } | { "object" => String, "kind" => String, "id" => String, "name" => String } | { "object" => String, "kind" => String, "id" => String, "url" => String } | { "object" => String, "kind" => String, "id" => String, "email" => String } | { "object" => String, "kind" => String, "id" => String, "file_name" => String | nil } | { "object" => String, "kind" => String, "id" => String, "key" => String }] })
66
+ def custom_identifiers: (?{ ?"cursor" => String, ?"limit" => Integer } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "data" => Array[{ "object" => String }], "next_cursor" => String | nil })
67
+ def register_custom_identifier: (?{ "key" => String, "key_version" => String, "description" => String } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String })
68
+ def get_custom_identifier: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String })
69
+ def delete_custom_identifier: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String | nil, "deleted" => bool })
70
+ def imports: (?{ ?"cursor" => String, ?"limit" => Integer } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "data" => Array[{ "object" => String }], "next_cursor" => String | nil })
71
+ def import_claim_history: (?{ "rows" => Array[{ ?"benefit" => String, "subject" => { "email" => String, ?"external_id" => String }, ?"granted_on" => String, ?"granted_time" => String, ?"occurred_at" => String, ?"claim_id" => String, ?"identifiers" => { ?"payment" => { "provider" => String, "scope" => String, "fingerprint" => String } } }], ?"benefit" => String, ?"time_zone" => String, ?"file_name" => String, ?"confirm" => bool } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String })
72
+ def create_csv_import: (?{ ?"benefit" => String, ?"time_zone" => String, ?"file_name" => String, ?"rows" => Integer, ?"payment" => { "provider" => String, "scope" => String }, ?"confirm" => bool } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String })
73
+ def get_import: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String })
74
+ def list_import_problems: (?{ ?"cursor" => String, ?"limit" => Integer } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "data" => Array[{ "object" => String }], "next_cursor" => String | nil })
75
+ def import_problems_download: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "url" => String })
76
+ def confirm_import: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String })
77
+ def discard_import: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String })
78
+ def fix_import_row: (?{ "row" => Integer, "cells" => { ?"email" => String, ?"benefit" => String, ?"granted_on" => String, ?"granted_time" => String, ?"occurred_at" => String, ?"user_id" => String, ?"claim_id" => String, ?"payment_fingerprint" => String } } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "import" => String, "row" => Integer, "state" => String, "kind" => String | nil, "field" => String | nil })
79
+ def skip_import_row: (?{ "row" => Integer } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String })
80
+ def exports: (?{ ?"cursor" => String, ?"limit" => Integer } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "data" => Array[{ "object" => String }], "next_cursor" => String | nil })
81
+ def request_export: (?{ ?"days" => Integer, ?"include_evidence" => bool } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String, "status" => String, "status_url" => String })
82
+ def get_export: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String })
83
+ def export_download: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String })
84
+ def request_workspace_export: (?{ "password" => String, ?"encryption" => String } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "export" => { "id" => String, "state" => String, "requested_by_you" => bool, "requested_at" => String | nil, "completed_at" => String | nil, "expires_at" => String | nil, "parts" => Integer | nil, "bytes" => Integer | nil, "can_delete" => bool } | nil, "next_allowed_at" => String | nil })
85
+ def workspace_export: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "export" => { "id" => String, "state" => String, "requested_by_you" => bool, "requested_at" => String | nil, "completed_at" => String | nil, "expires_at" => String | nil, "parts" => Integer | nil, "bytes" => Integer | nil, "can_delete" => bool } | nil, "next_allowed_at" => String | nil })
86
+ def workspace_export_download: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String, "expires_at" => String | nil, "links_expire_at" => String | nil, "parts" => Array[{ "part" => Integer, "bytes" => Integer, "file_name" => String, "url" => String }] })
87
+ def delete_workspace_export: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "export" => { "id" => String, "state" => String, "requested_by_you" => bool, "requested_at" => String | nil, "completed_at" => String | nil, "expires_at" => String | nil, "parts" => Integer | nil, "bytes" => Integer | nil, "can_delete" => bool } | nil, "next_allowed_at" => String | nil })
88
+ def dry_run_data_deletion: (?{ "selector" => { "kind" => String, "user" => String, "email" => bool } | { "kind" => String } } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String })
89
+ def data_deletions: (?{ ?"cursor" => String, ?"limit" => Integer } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "data" => Array[{ "object" => String }], "next_cursor" => String | nil })
90
+ def request_data_deletion: (?{ "selector" => { "kind" => String, "user" => String, "email" => bool } | { "kind" => String } } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String, "status" => String, "status_url" => String })
91
+ def get_data_deletion: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String })
92
+ def analytics: (?{ ?"days" => Integer } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "data" => Array[{ "object" => String }], "next_cursor" => String | nil })
93
+ def overview: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "hours" => Numeric, "evaluations" => { "total" => Integer, "allowed" => Integer, "denied" => Integer, "waiting_for_confirmation" => Integer }, "previous" => { "total" => Integer, "allowed" => Integer, "denied" => Integer, "waiting_for_confirmation" => Integer }, "api_requests" => { "total" => Integer, "errors" => Integer }, "last_evaluation_at" => String | nil, "browser_issue" => String | nil, "latest_evaluations" => Array[{ "object" => String, "id" => String, "benefit" => String, "claim_id" => String, "result" => String, "mode" => String, "observed_result" => String | nil, "reason" => { "code" => String, "message" => String } | nil, "outcome" => { "state" => String | nil }, "policy_version" => Numeric | nil, "browser_data" => String | nil, "created_at" => String | nil }] })
94
+ def benefit_value: (?{ ?"days" => Integer, ?"currency" => String, ?"benefit" => String } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "currency" => String, "from" => String, "to" => String, "delivered" => Numeric, "saved" => Numeric, "benefits" => Array[{ "benefit" => String | nil, "value" => { "amount" => Numeric, "currency" => String } | nil, "delivered" => Numeric, "saved" => Numeric }] })
95
+ def denial_reasons: (?{ ?"days" => Integer, ?"benefit" => String } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "benefit" => String | nil, "from" => String, "to" => String, "denied" => Integer, "reasons" => Array[{ "code" => String, "label" => String, "count" => Integer }] })
96
+ def request_logs: (?{ ?"cursor" => String, ?"limit" => Integer, ?"status" => String, ?"key_id" => String } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "data" => Array[{ "object" => String }], "next_cursor" => String | nil })
97
+ def get_request_log: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String })
98
+ def audit_logs: (?{ ?"cursor" => String, ?"limit" => Integer } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "data" => Array[{ "object" => String }], "next_cursor" => String | nil })
99
+ def get_audit_log: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String })
100
+ def account_status: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "workspace" => String, "plan" => { "plan" => String, "name" => String, "interval" => String | nil, "enterprise" => bool, "renews_at" => String | nil, "ends_at" => String | nil }, "credits" => { "available" => Integer, "allowance" => Integer, "pay_as_you_go" => Integer, "per_evaluation" => Integer, "evaluations_left" => Integer, "state" => String }, "limits" => { "protected_benefits" => { "used" => Integer, "limit" => Integer }, "custom_policies" => { "used" => Integer, "limit" => Integer }, "team_seats" => { "used" => Integer, "limit" => Integer }, "retention_days" => Integer, "rate" => Integer }, "auto_reload" => { "enabled" => bool } })
101
+ def integration_status: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "status" => String, "api_keys" => { "state" => String, "next_step" => String | nil }, "browser_script" => { "state" => String, "next_step" => String | nil }, "evaluations" => { "state" => String, "next_step" => String | nil }, "outcomes" => { "state" => String, "next_step" => String | nil }, "webhooks" => { "state" => String, "next_step" => String | nil }, "credits" => { "state" => String, "next_step" => String | nil }, "checked_at" => String | nil })
102
+ def events: (?{ ?"cursor" => String, ?"limit" => Integer, ?"wait" => Integer } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "data" => Array[{ "object" => String, "id" => String, "type" => String, "api_version" => String, "created_at" => String | nil, "workspace" => String, "test" => bool, "data" => { "object" => String, "state" => String, "available" => Integer, "evaluations_left" => Integer, "days_left" => Integer | nil } | { "object" => String, "state" => String, "available" => Integer, "evaluations_left" => Integer, "days_left" => nil } | { "object" => String, "status" => String, "purpose" => String } | { "object" => String, "status" => String, "purpose" => String, "confirmation_required" => bool } | { "plan" => String, "name" => String, "interval" => String | nil, "object" => String, "previous" => { "plan" => String, "name" => String, "interval" => String | nil } | nil } | { "object" => String, "id" => String, "status" => String } | { "object" => String, "id" => String, "name" => String, "type" => String, "expires_at" => String | nil, "created_at" => String | nil } | { "object" => String, "id" => String, "name" => String, "type" => String, "expires_at" => String | nil, "created_at" => String | nil } | { "object" => String, "id" => String, "name" => String | nil, "role" => String, "joined_at" => String | nil } | { "object" => String, "status" => String, "owner" => { "id" => String, "name" => String | nil } | nil, "new_owner" => { "id" => String, "name" => String | nil } | nil } | { "object" => String, "day" => String, "limit" => Integer } | Hash[String, untyped] }], "next_cursor" => String, "has_more" => bool })
103
+ def browser_collection: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "origins" => Array[String], "revision" => Integer, "sites" => Array[{ "origin" => String, "listed" => bool, "first_seen_at" => String | nil, "last_seen_at" => String | nil, "sdk_version" => String | nil }], "issue" => String | nil, "issue_since" => String | nil, "coverage" => { "days" => Numeric, "total" => Integer, "collected" => Integer, "consent_declined" => Integer, "not_loaded" => Integer, "blocked" => Integer, "timed_out" => Integer, "failed" => Integer, "site_not_listed" => Integer, "sdk_outdated" => Integer, "expired" => Integer, "not_passed_on" => Integer, "not_sent" => Integer }, "notices" => Array[String] })
104
+ def update_browser_collection: (?{ "origins" => Array[String], ?"revision" => Integer } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "origins" => Array[String], "revision" => Integer, "sites" => Array[{ "origin" => String, "listed" => bool, "first_seen_at" => String | nil, "last_seen_at" => String | nil, "sdk_version" => String | nil }], "issue" => String | nil, "issue_since" => String | nil, "coverage" => { "days" => Numeric, "total" => Integer, "collected" => Integer, "consent_declined" => Integer, "not_loaded" => Integer, "blocked" => Integer, "timed_out" => Integer, "failed" => Integer, "site_not_listed" => Integer, "sdk_outdated" => Integer, "expired" => Integer, "not_passed_on" => Integer, "not_sent" => Integer }, "notices" => Array[String] })
105
+ def browser_script: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "script" => String | nil, "sdk_version" => String, "publishable_key" => String | nil })
106
+ def webhook_endpoints: (?{ ?"cursor" => String, ?"limit" => Integer } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "data" => Array[{ "object" => String }], "next_cursor" => String | nil })
107
+ def create_webhook_endpoint: (?{ "url" => String, "events" => Array[String], ?"benefit_ids" => Array[String], ?"denied_only" => bool } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String | nil, "url" => String, "description" => nil, "events" => Array[String], "benefits" => Array[String | nil], "denied_only" => bool, "status" => String, "disabled_reason" => String | nil, "last_success_at" => String | nil, "revision" => Integer, "created_at" => String | nil, "updated_at" => String | nil })
108
+ def get_webhook_endpoint: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String })
109
+ def update_webhook_endpoint: (?{ "revision" => Integer, ?"url" => String, ?"events" => Array[String], ?"benefit_ids" => Array[String], ?"denied_only" => bool } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String | nil, "url" => String, "description" => nil, "events" => Array[String], "benefits" => Array[String | nil], "denied_only" => bool, "status" => String, "disabled_reason" => String | nil, "last_success_at" => String | nil, "revision" => Integer, "created_at" => String | nil, "updated_at" => String | nil })
110
+ def delete_webhook_endpoint: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String | nil, "deleted" => bool })
111
+ def send_webhook_test: (?{ ?"type" => String } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String })
112
+ def enable_webhook_endpoint: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String | nil, "url" => String, "description" => nil, "events" => Array[String], "benefits" => Array[String | nil], "denied_only" => bool, "status" => String, "disabled_reason" => String | nil, "last_success_at" => String | nil, "revision" => Integer, "created_at" => String | nil, "updated_at" => String | nil })
113
+ def disable_webhook_endpoint: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String | nil, "url" => String, "description" => nil, "events" => Array[String], "benefits" => Array[String | nil], "denied_only" => bool, "status" => String, "disabled_reason" => String | nil, "last_success_at" => String | nil, "revision" => Integer, "created_at" => String | nil, "updated_at" => String | nil })
114
+ def webhook_signing_secret: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "endpoint" => String | nil, "secret" => String })
115
+ def rotate_webhook_signing_secret: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String | nil, "url" => String, "description" => nil, "events" => Array[String], "benefits" => Array[String | nil], "denied_only" => bool, "status" => String, "disabled_reason" => String | nil, "last_success_at" => String | nil, "revision" => Integer, "created_at" => String | nil, "updated_at" => String | nil })
116
+ def webhook_usage: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "day" => String, "deliveries" => Integer, "limit" => Integer, "limit_reached" => bool, "resets_at" => String | nil })
117
+ def webhook_deliveries: (?{ ?"cursor" => String, ?"limit" => Integer, ?"endpoint_id" => String, ?"status" => String, ?"type" => String, ?"event_id" => String } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "data" => Array[{ "object" => String }], "next_cursor" => String | nil })
118
+ def get_webhook_delivery: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String })
119
+ def resend_webhook_delivery: (?{ ?"target" => String } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String })
120
+ def plan: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "plan" => String, "name" => String, "interval" => String | nil, "subscribed" => bool, "renews_at" => String | nil, "ends_at" => String | nil, "scheduled_change" => { "plan" => String, "name" => String, "interval" => String | nil, "at" => String | nil } | nil, "enterprise" => bool, "payment" => { "state" => String, "due_at" => String | nil }, "limits" => { "protected_benefits" => Integer, "custom_policies" => Integer, "team_seats" => Integer, "retention_days" => Integer, "rate" => Integer }, "over_limit" => { "state" => String, "grace_until" => String | nil, "items" => Array[{ "kind" => String, "id" => String | nil, "name" => String, "paused" => bool, "will_pause" => bool }] } | nil })
121
+ def usage: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "credits" => { "available" => Integer, "allowance" => Integer, "pay_as_you_go" => Integer, "per_evaluation" => Integer }, "usage" => { "absolute" => { "allowance_credits" => { "used" => Integer, "total" => Integer }, "pay_as_you_go_credits" => { "used" => Integer, "total" => Integer }, "protected_benefits" => { "used" => Integer, "total" => Integer }, "team_seats" => { "used" => Integer, "total" => Integer } }, "allowance" => { "allowance_credits" => { "used" => Integer, "total" => Integer }, "pay_as_you_go_credits" => { "used" => Integer, "total" => Integer }, "protected_benefits" => { "used" => Integer, "total" => Integer }, "team_seats" => { "used" => Integer, "total" => Integer } } | nil }, "auto_reload" => { "enabled" => bool, "capped" => bool, "threshold" => Integer | nil, "amount_dollars" => Integer | nil, "monthly_cap_dollars" => Integer | nil } })
122
+ def credit_history: (?{ ?"cursor" => String, ?"activity" => String, ?"direction" => String, ?"days" => Numeric | Numeric | Numeric | Numeric, ?"from" => String, ?"to" => String } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "data" => Array[{ "object" => String, "date" => String, "daily_total" => bool, "activity" => String, "sources" => Array[String], "credits" => Integer, "plans" => Array[String], "enterprise_plans" => Array[String] }], "next_cursor" => String | nil })
123
+ def daily_usage: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "time_zone" => String, "days" => Array[{ "day" => String, "credits" => Integer, "top_benefit" => { "name" => String, "evaluations" => Integer } | nil }] })
124
+ def enterprise_plans: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "data" => Array[{ "object" => String, "name" => String, "active" => bool, "added_at" => String | nil, "ends_at" => String | nil, "grants" => { "credits" => Integer, "credit_cadence" => String | nil, "credit_expiry" => String | nil, "credit_expiry_days" => Integer | nil, "team_seats" => Integer, "protected_benefits" => Integer, "custom_policies" => Integer | nil, "rate" => Integer | nil, "burst" => Integer | nil, "concurrency" => Integer | nil, "retention_days" => Integer | nil } }], "next_cursor" => String | nil })
125
+ def preview_enterprise_plan_code: (?{ "code" => String } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "plan" => { "name" => String, "description" => String | nil, "credits" => Integer, "credit_cadence" => String | nil, "credit_expiry" => String | nil, "credit_expiry_days" => Integer | nil, "team_seats" => Integer, "protected_benefits" => Integer, "custom_policies" => Integer | nil, "rate" => Integer | nil, "burst" => Integer | nil, "concurrency" => Integer | nil, "retention_days" => Integer | nil, "duration_months" => Integer | nil } })
126
+ def upcoming_charge: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "data" => Array[{ "object" => String, "kind" => String, "amount_cents" => Integer, "at" => String | nil, "payment_method" => String | nil, "discounted" => bool }], "next_cursor" => String | nil })
127
+ def invoices: (?{ ?"cursor" => String } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "data" => Array[{ "object" => String, "number" => String | nil, "created_at" => String | nil, "status" => String, "description" => String, "period" => { "start" => String | nil, "end" => String | nil } | nil, "total_cents" => Integer, "paid_cents" => Integer, "due_cents" => Integer, "refunded_cents" => Integer, "payable" => bool, "url" => String | nil }], "next_cursor" => String | nil, "outstanding_cents" => Integer | nil })
128
+ def payment_methods: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "data" => Array[{ "object" => String, "id" => String | nil, "type" => String, "brand" => String | nil, "last4" => String | nil, "exp_month" => Integer | nil, "exp_year" => Integer | nil, "label" => String, "default" => bool, "backup" => Integer | nil, "declined" => bool, "expired" => bool }], "next_cursor" => String | nil })
129
+ def billing_details: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "name" => String, "email" => String, "uses_account_email" => bool, "address" => { "line1" => String, "line2" => String, "city" => String, "state" => String, "postal_code" => String, "country" => String } | nil, "tax_id" => { "type" => String, "value" => String } | nil })
130
+ def update_billing_details: (?{ "name" => String, "email" => String | String, "address" => { "line1" => String, "line2" => String, "city" => String, "state" => String, "postal_code" => String, "country" => String | String }, "tax_id" => { "type" => String, "value" => String } | nil } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "name" => String, "email" => String, "uses_account_email" => bool, "address" => { "line1" => String, "line2" => String, "city" => String, "state" => String, "postal_code" => String, "country" => String } | nil, "tax_id" => { "type" => String, "value" => String } | nil })
131
+ def get_payment: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String | nil, "kind" => String, "status" => String, "payment_page_url" => String | nil, "credits" => Integer | nil, "bonus_credits" => Integer | nil, "scheduled" => bool })
132
+ def quote_plan_change: (?{ "plan" => String, ?"interval" => String | nil, ?"promo_code" => String } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String | nil, "plan" => String, "interval" => String | nil, "direction" => String, "timing" => String, "confirmable" => bool, "charge_now_cents" => Integer, "renewal_cents" => Integer, "credits_now" => Integer, "effective_at" => String | nil, "expires_at" => String | nil, "next_charge" => { "amount_cents" => Integer, "at" => String | nil, "discounted" => bool } | nil, "promotion" => { "code" => String, "amount_cents" => Integer, "full_cents" => Integer, "duration" => String } | nil })
133
+ def set_low_credit_alert: (?{ "credits" => Integer | nil } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "credits" => Integer | nil })
134
+ def choose_what_stays_active: (?{ "kind" => String, "keep_active" => String, "pause" => String } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "status" => String })
135
+ def set_auto_reload: (?{ "enabled" => bool, "threshold" => Integer | nil, "amount_dollars" => Integer | nil, ?"monthly_cap_dollars" => Integer | nil } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "enabled" => bool, "capped" => bool, "threshold" => Integer | nil, "amount_dollars" => Integer | nil, "monthly_cap_dollars" => Integer | nil, "spent_this_month_dollars" => Integer })
136
+ def buy_credits: (?{ "amount_dollars" => Integer } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String | nil, "kind" => String, "status" => String, "payment_page_url" => String | nil, "credits" => Integer | nil, "bonus_credits" => Integer | nil, "scheduled" => bool })
137
+ def retry_credit_purchase: (?{ ?"payment_method_id" => String } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String | nil, "kind" => String, "status" => String, "payment_page_url" => String | nil, "credits" => Integer | nil, "bonus_credits" => Integer | nil, "scheduled" => bool })
138
+ def confirm_plan_change: (?{ ?"payment_method_id" => String } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String | nil, "kind" => String, "status" => String, "payment_page_url" => String | nil, "credits" => Integer | nil, "bonus_credits" => Integer | nil, "scheduled" => bool })
139
+ def undo_scheduled_downgrade: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "status" => String })
140
+ def resume_subscription: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "status" => String })
141
+ def pay_overdue_invoice: (?{ ?"invoice_number" => String, ?"payment_method_id" => String } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String | nil, "kind" => String, "status" => String, "payment_page_url" => String | nil, "credits" => Integer | nil, "bonus_credits" => Integer | nil, "scheduled" => bool })
142
+ def set_default_payment_method: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "status" => String, "overdue_invoices" => Array[{ "number" => String | nil, "amount_cents" => Integer, "status" => String }] })
143
+ def move_backup_payment_method: (?{ "direction" => String } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "status" => String, "overdue_invoices" => Array[{ "number" => String | nil, "amount_cents" => Integer, "status" => String }] })
144
+ def remove_payment_method: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "status" => String, "overdue_invoices" => Array[{ "number" => String | nil, "amount_cents" => Integer, "status" => String }] })
145
+ def redeem_enterprise_plan_code: (?{ "code" => String } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "status" => String, "plan" => String | nil })
146
+ def create_billing_approval_link: (?{ "kind" => String, ?"plan" => String, ?"interval" => String } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String, "kind" => String, "plan" => String | nil, "interval" => String | nil, "status" => String, "approval_url" => String | nil, "expires_at" => String | nil, "completed_at" => String | nil })
147
+ def billing_approval_link: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String, "kind" => String, "plan" => String | nil, "interval" => String | nil, "status" => String, "approval_url" => String | nil, "expires_at" => String | nil, "completed_at" => String | nil })
148
+ def update_account_name: (?{ "name" => String } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "name" => String })
149
+ def email_preferences: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "members_and_invitations" => bool, "imports_and_exports" => bool, "integration_alerts" => bool, "weekly_summary" => bool })
150
+ def update_email_preferences: (?{ ?"members_and_invitations" => bool, ?"imports_and_exports" => bool, ?"integration_alerts" => bool, ?"weekly_summary" => bool } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "members_and_invitations" => bool, "imports_and_exports" => bool, "integration_alerts" => bool, "weekly_summary" => bool })
151
+ def notifications: (?{ ?"filter" => String, ?"cursor" => String } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "data" => Array[{ "object" => String, "id" => String, "workspace" => String | nil, "kind" => String, "title" => String, "snippet" => String, "unread" => bool, "count" => Integer, "updated_at" => String | nil, "actions" => Array[{ "id" => String, "label" => String }], "resolved" => String | nil }], "next_cursor" => String | nil, "unread_count" => Integer })
152
+ def mark_notification: (?{ "read" => bool } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String, "workspace" => String | nil, "kind" => String, "title" => String, "snippet" => String, "unread" => bool, "count" => Integer, "updated_at" => String | nil, "actions" => Array[{ "id" => String, "label" => String }], "resolved" => String | nil, "unread_count" => Integer })
153
+ def mark_all_notifications_read: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "unread_count" => Integer })
154
+ def run_notification_action: (?{ "action" => String } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String, "workspace" => String | nil, "kind" => String, "title" => String, "snippet" => String, "unread" => bool, "count" => Integer, "updated_at" => String | nil, "actions" => Array[{ "id" => String, "label" => String }], "resolved" => String | nil, "unread_count" => Integer })
155
+ def contact_support: (?{ "subject" => String, "message" => String, "topic" => String, ?"request_id" => String } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String, "status" => String, "created_at" => String | nil, "updated_at" => String | nil })
156
+ def support_tickets: (?{ ?"cursor" => String, ?"limit" => Integer } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "data" => Array[{ "object" => String, "id" => String, "status" => String, "created_at" => String | nil, "updated_at" => String | nil }], "next_cursor" => String | nil })
157
+ def send_feedback: (?{ "message" => String, ?"page" => String } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "sent" => bool })
158
+ end
159
+ class PublicClient < Core
160
+ def pricing: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "currency" => String, "credits_per_evaluation" => Integer, "plans" => Array[{ "object" => String, "plan" => String, "name" => String, "prices" => { "month" => { "amount_cents" => Integer, "credits" => Integer } | nil, "year" => { "amount_cents" => Integer, "credits" => Integer } | nil }, "includes" => { "protected_benefits" => Integer, "team_seats" => Integer, "data_retention_days" => Integer, "traffic" => { "rate_per_second" => Integer, "burst" => Integer, "concurrency" => Integer } } }], "credit_packs" => { "credits_per_dollar" => Integer, "amounts" => Array[Integer], "custom_amount_step" => Integer, "custom_amount_max" => Integer, "first_purchase_multiplier" => Integer }, "yearly" => { "rollover_percent" => Integer, "converted_credit_expiry_months" => Integer }, "every_plan" => { "custom_policies" => Integer, "webhook_endpoints" => Integer, "webhook_resends_per_endpoint_per_hour" => Integer, "webhook_deliveries_per_day" => Integer }, "enterprise" => { "contact" => String }, "url" => String })
161
+ def price_quote: (?{ "plan" => String, ?"interval" => String, ?"amount" => Integer } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "plan" => String, "interval" => String | nil, "currency" => String, "amount_cents" => Integer, "credits" => Integer, "bonus_credits" => Integer, "total_credits" => Integer })
162
+ def docs: (?{ ?"cursor" => String, ?"limit" => Integer } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "data" => Array[{ "object" => String, "path" => String, "title" => String, "description" => String | nil, "url" => String, "updated_at" => String }], "next_cursor" => String | nil })
163
+ def search_docs: (?{ "query" => String, ?"limit" => Integer } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "data" => Array[{ "object" => String, "path" => String, "title" => String, "url" => String, "snippet" => String, "updated_at" => String }], "next_cursor" => String | nil })
164
+ def public_docs_page: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "path" => String, "title" => String, "description" => String | nil, "url" => String, "updated_at" => String, "markdown" => String })
165
+ def help_articles: (?{ ?"cursor" => String, ?"limit" => Integer } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "data" => Array[{ "object" => String, "path" => String, "title" => String, "description" => String | nil, "url" => String, "updated_at" => String }], "next_cursor" => String | nil })
166
+ def search_help: (?{ "query" => String, ?"limit" => Integer } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "data" => Array[{ "object" => String, "path" => String, "title" => String, "url" => String, "snippet" => String, "updated_at" => String }], "next_cursor" => String | nil })
167
+ def public_help_article: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "path" => String, "title" => String, "description" => String | nil, "url" => String, "updated_at" => String, "markdown" => String })
168
+ def openapi: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "version" => String, "document" => Hash[String, untyped] })
169
+ def actions: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "data" => Array[{ "object" => String, "id" => String, "summary" => String, "method" => String, "path" => String, "scope" => String, "sign_in" => bool, "mcp_tool" => String | nil, "cli_command" => String | nil, "mutation" => bool, "destructive" => bool }], "next_cursor" => String | nil })
170
+ def error_codes: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "data" => Array[{ "object" => String, "code" => String, "status" => Integer, "type" => String, "meaning" => String, "retryable" => bool, "next_step" => String, "docs_url" => String }], "next_cursor" => String | nil })
171
+ def reason_codes: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "data" => Array[{ "object" => String, "code" => String, "label" => String, "message" => String, "meaning" => String | nil, "docs_url" => String }], "next_cursor" => String | nil })
172
+ def webhook_event_types: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "data" => Array[{ "object" => String, "type" => String, "description" => String, "example" => { "object" => String, "id" => String, "type" => String, "api_version" => String, "created_at" => String, "workspace" => String, "data" => Hash[String, untyped] } }], "next_cursor" => String | nil })
173
+ def conditions: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "data" => Array[{ "object" => String, "key" => String, "label" => String, "group" => String, "type" => String, ?"values" => Array[String], ?"min" => Numeric, ?"max" => Numeric, ?"integer" => bool }], "next_cursor" => String | nil })
174
+ def glossary: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "terms" => Array[{ "term" => String, "definition" => String }], "faq" => Array[{ "section" => String | nil, "question" => String, "answer" => String }], "url" => String, "faq_url" => String, "updated_at" => String })
175
+ def legal_documents: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "data" => Array[{ "object" => String, "document" => String, "title" => String, "version" => String, "effective_date" => String, "url" => String, "updated_at" => String }], "next_cursor" => String | nil })
176
+ def legal_document: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "document" => String, "title" => String, "version" => String, "effective_date" => String, "url" => String, "updated_at" => String, "markdown" => String })
177
+ def changelog: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "url" => String, "entries" => Array[{ "id" => String, "title" => String, "date" => String, "markdown" => String }], "updated_at" => String })
178
+ def blog_posts: (?{ ?"cursor" => String, ?"limit" => Integer } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "data" => Array[{ "object" => String, "slug" => String, "title" => String, "description" => String | nil, "url" => String, "published_on" => String | nil, "revised_on" => String | nil, "authors" => Array[String], "tags" => Array[String], "updated_at" => String }], "next_cursor" => String | nil })
179
+ def blog_post: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "slug" => String, "title" => String, "description" => String | nil, "url" => String, "published_on" => String | nil, "revised_on" => String | nil, "authors" => Array[String], "tags" => Array[String], "updated_at" => String, "markdown" => String })
180
+ def versions: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "api" => String, "npm" => { "package" => String, "version" => String }, "browser_script" => { "version" => String, "url" => String }, "skill" => { "version" => String, "url" => String } | nil })
181
+ def service_status: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "status" => String, "checked_at" => String })
182
+ def contacts: (?Hash[String, untyped] input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "support" => { "email" => String, "form" => String | nil, "api" => String }, "sales" => { "form" => String, "api" => String }, "security" => { "email" => String } })
183
+ def contact_sales: (?{ "name" => String, "email" => String, "message" => String } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "received" => bool })
184
+ def contact_support: (?{ "email" => String, "subject" => String, "message" => String, "topic" => String, ?"name" => String, ?"workspace_id" => String, ?"request_id" => String } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "reference" => String, "email" => String })
185
+ def start_onboarding: (?{ "workspace_name" => String, "plan" => String, ?"interval" => String, ?"credit_pack_dollars" => Integer } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String, "approval_url" => String, "secret" => String, "expires_at" => String, "workspace_name" => String, "plan" => String, "interval" => String | nil, "credit_pack_dollars" => Integer | nil, "amount_cents" => Integer })
186
+ def onboarding_status: (?{ "secret" => String, ?"wait" => Integer } input, ?path: Hash[String, String | Integer], ?idempotency_key: String?) -> ({ "object" => String, "id" => String, "status" => String, "expires_at" => String, "workspace" => String | nil, "sign_in" => { "token_endpoint" => String, "grant_type" => String, "client_id" => String } | nil })
187
+ end
188
+ end
data/sig/core.rbs ADDED
@@ -0,0 +1,20 @@
1
+ module AbuseZero
2
+ VERSION: String
3
+ class Core
4
+ def initialize: (?key: String?, ?access_token: String?, ?workspace: String?, ?outage: String, ?agent: String?, ?base_url: String, ?transport: untyped) -> void
5
+ def close: () -> void
6
+ end
7
+ class Error < StandardError
8
+ attr_reader code: String
9
+ attr_reader status: Integer
10
+ attr_reader request_id: String?
11
+ attr_reader retryable: bool
12
+ attr_reader docs_url: String?
13
+ end
14
+ class WebhookVerificationError < StandardError
15
+ end
16
+ def self.incoming_request: (method: String, url: String, headers: Hash[String, String]) -> Hash[String, untyped]
17
+ def self.create_phone_hash: (secret: String, key_version: String, e164: String) -> Hash[String, String]
18
+ def self.create_custom_identifier: (secret: String, key_version: String, key: String, value: String) -> Hash[String, untyped]
19
+ def self.verify_webhook: (payload: String, headers: Hash[String, String], secret: String | Array[String?], ?tolerance_seconds: Numeric, ?now: Numeric) -> Hash[String, untyped]
20
+ end
metadata ADDED
@@ -0,0 +1,73 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: abusezero
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - AbuseZero
8
+ bindir: bin
9
+ cert_chain: []
10
+ date: 2026-11-12 00:00:00.000000000 Z
11
+ dependencies:
12
+ - !ruby/object:Gem::Dependency
13
+ name: base64
14
+ requirement: !ruby/object:Gem::Requirement
15
+ requirements:
16
+ - - ">="
17
+ - !ruby/object:Gem::Version
18
+ version: '0.2'
19
+ - - "<"
20
+ - !ruby/object:Gem::Version
21
+ version: '1'
22
+ type: :runtime
23
+ prerelease: false
24
+ version_requirements: !ruby/object:Gem::Requirement
25
+ requirements:
26
+ - - ">="
27
+ - !ruby/object:Gem::Version
28
+ version: '0.2'
29
+ - - "<"
30
+ - !ruby/object:Gem::Version
31
+ version: '1'
32
+ executables: []
33
+ extensions: []
34
+ extra_rdoc_files: []
35
+ files:
36
+ - API.md
37
+ - LICENSE
38
+ - README.md
39
+ - THIRD-PARTY-NOTICES
40
+ - examples/evaluate.rb
41
+ - examples/frameworks.md
42
+ - lib/abusezero.rb
43
+ - lib/abusezero/client.rb
44
+ - lib/abusezero/core.rb
45
+ - lib/abusezero/operations.json
46
+ - sig/abusezero.rbs
47
+ - sig/core.rbs
48
+ homepage: https://abusezero.com
49
+ licenses:
50
+ - Nonstandard
51
+ metadata:
52
+ homepage_uri: https://abusezero.com
53
+ documentation_uri: https://docs.abusezero.com/docs/tools/ruby-sdk
54
+ source_code_uri: https://github.com/abusezero/abusezero-ruby
55
+ rubygems_mfa_required: 'true'
56
+ rdoc_options: []
57
+ require_paths:
58
+ - lib
59
+ required_ruby_version: !ruby/object:Gem::Requirement
60
+ requirements:
61
+ - - ">="
62
+ - !ruby/object:Gem::Version
63
+ version: '3.3'
64
+ required_rubygems_version: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ requirements: []
70
+ rubygems_version: 4.0.23
71
+ specification_version: 4
72
+ summary: 'The official AbuseZero Ruby SDK: abuse prevention API for SaaS.'
73
+ test_files: []