Class: Chainalysis::V1Client

Inherits:
BaseClient show all
Defined in:
lib/chainalysis/client.rb

Overview

Client for V1 API endpoints

Constant Summary

Constants inherited from BaseClient

BaseClient::ADMIN_URL, BaseClient::BASE_URL, BaseClient::VERSION

Instance Attribute Summary

Attributes inherited from BaseClient

#adapter, #api_key

Instance Method Summary collapse

Methods inherited from BaseClient

#initialize

Constructor Details

This class inherits a constructor from Chainalysis::BaseClient

Instance Method Details

#assign_alert(alert_identifier:, alert_assignee:) ⇒ Object 



159
160
161
162
 
# File 'lib/chainalysis/client.rb', line 159

def assign_alert(alert_identifier:, alert_assignee:)
  post_request("v1/alerts/#{alert_identifier}/assignment",
               { alertAssignee: alert_assignee })
end

#delete_deposit_address(user_id:, asset:, address:) ⇒ Object 



150
151
152
 
# File 'lib/chainalysis/client.rb', line 150

def delete_deposit_address(user_id:, asset:, address:)
  delete_request("v1/users/#{user_id}/depositaddresses/#{asset}/#{address}")
end

#delete_withdrawal_address(user_id:, asset:, address:) ⇒ Object 



134
135
136
 
# File 'lib/chainalysis/client.rb', line 134

def delete_withdrawal_address(user_id:, asset:, address:)
  delete_request("v1/users/#{user_id}/withdrawaladdresses/#{asset}/#{address}")
end

#get_alert_activity(alert_identifier:) ⇒ Object 



170
171
172
 
# File 'lib/chainalysis/client.rb', line 170

def get_alert_activity(alert_identifier:)
  get_request("v1/alerts/#{alert_identifier}/activity")
end

#get_alerts(params = {}) ⇒ Object

Alert endpoints



155
156
157
 
# File 'lib/chainalysis/client.rb', line 155

def get_alerts(params = {})
  get_request('v1/alerts/', params)
end

#get_deposit_addresses(user_id:, limit: nil, offset: nil) ⇒ Object 



143
144
145
146
147
148
 
# File 'lib/chainalysis/client.rb', line 143

def get_deposit_addresses(user_id:, limit: nil, offset: nil)
  params = {}
  params[:limit] = limit if limit
  params[:offset] = offset if offset
  get_request("v1/users/#{user_id}/depositaddresses", params)
end

#get_received_transfers(user_id:, limit: nil, offset: nil) ⇒ Object 



104
105
106
107
108
109
 
# File 'lib/chainalysis/client.rb', line 104

def get_received_transfers(user_id:, limit: nil, offset: nil)
  params = {}
  params[:limit] = limit if limit
  params[:offset] = offset if offset
  get_request("v1/users/#{user_id}/transfers/received", params)
end

#get_sent_transfers(user_id:, limit: nil, offset: nil) ⇒ Object 



115
116
117
118
119
120
 
# File 'lib/chainalysis/client.rb', line 115

def get_sent_transfers(user_id:, limit: nil, offset: nil)
  params = {}
  params[:limit] = limit if limit
  params[:offset] = offset if offset
  get_request("v1/users/#{user_id}/transfers/sent", params)
end

#get_user(user_id:) ⇒ Object 



182
183
184
 
# File 'lib/chainalysis/client.rb', line 182

def get_user(user_id:)
  get_request("v1/users/#{user_id}")
end

#get_users(limit: nil, offset: nil) ⇒ Object

User endpoints



175
176
177
178
179
180
 
# File 'lib/chainalysis/client.rb', line 175

def get_users(limit: nil, offset: nil)
  params = {}
  params[:limit] = limit if limit
  params[:offset] = offset if offset
  get_request('v1/users/', params)
end

#get_withdrawal_addresses(user_id:, limit: nil, offset: nil) ⇒ Object 



127
128
129
130
131
132
 
# File 'lib/chainalysis/client.rb', line 127

def get_withdrawal_addresses(user_id:, limit: nil, offset: nil)
  params = {}
  params[:limit] = limit if limit
  params[:offset] = offset if offset
  get_request("v1/users/#{user_id}/withdrawaladdresses", params)
end

#register_deposit_addresses(user_id:, addresses:) ⇒ Object

Deposit address endpoints



139
140
141
 
# File 'lib/chainalysis/client.rb', line 139

def register_deposit_addresses(user_id:, addresses:)
  post_request("v1/users/#{user_id}/depositaddresses", addresses)
end

#register_received_transfer(user_id:, transfers:) ⇒ Object

Transfer endpoints



100
101
102
 
# File 'lib/chainalysis/client.rb', line 100

def register_received_transfer(user_id:, transfers:)
  post_request("v1/users/#{user_id}/transfers/received", transfers)
end

#register_sent_transfer(user_id:, transfers:) ⇒ Object 



111
112
113
 
# File 'lib/chainalysis/client.rb', line 111

def register_sent_transfer(user_id:, transfers:)
  post_request("v1/users/#{user_id}/transfers/sent", transfers)
end

#register_withdrawal_addresses(user_id:, addresses:) ⇒ Object

Withdrawal address endpoints



123
124
125
 
# File 'lib/chainalysis/client.rb', line 123

def register_withdrawal_addresses(user_id:, addresses:)
  post_request("v1/users/#{user_id}/withdrawaladdresses", addresses)
end

#rename_users(renames:) ⇒ Object 



186
187
188
 
# File 'lib/chainalysis/client.rb', line 186

def rename_users(renames:)
  post_request('v1/users/rename', renames)
end

#update_alert_status(alert_identifier:, status:, comment: nil) ⇒ Object 



164
165
166
167
168
 
# File 'lib/chainalysis/client.rb', line 164

def update_alert_status(alert_identifier:, status:, comment: nil)
  body = { status: status }
  body[:comment] = comment if comment
  post_request("v1/alerts/#{alert_identifier}/statuses", body)
end