Class: Devdraft::LiquidationAddressesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/devdraft/api/liquidation_addresses_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LiquidationAddressesApi

Returns a new instance of LiquidationAddressesApi.



19
20
21
 
# File 'lib/devdraft/api/liquidation_addresses_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/devdraft/api/liquidation_addresses_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#liquidation_address_controller_create_liquidation_address(customer_id, create_liquidation_address_dto, opts = {}) ⇒ LiquidationAddressResponseDto

Create a new liquidation address for a customer

Create a new liquidation address for a customer. Liquidation addresses allow        customers to automatically liquidate cryptocurrency holdings to fiat or other        stablecoins based on configured parameters.        **Required fields:**       - chain: Blockchain network (ethereum, polygon, arbitrum, base)       - currency: Stablecoin currency (usdc, eurc, dai, pyusd, usdt)       - address: Valid blockchain address        **At least one destination must be specified:**       - external_account_id: External bank        - prefunded_account_id: Developer's prefunded account       - bridge_wallet_id: Bridge wallet       - destination_address: Crypto wallet address        **Payment Rails:**       Different payment rails have different requirements:       - ACH: Requires external_account_id, supports destination_ach_reference       - SEPA: Requires external_account_id, supports destination_sepa_reference       - Wire: Requires external_account_id, supports destination_wire_message       - Crypto: Requires destination_address, supports destination_blockchain_memo

Parameters:

  • customer_id (String) —

    Unique identifier for the customer

  • create_liquidation_address_dto (CreateLiquidationAddressDto)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/devdraft/api/liquidation_addresses_api.rb', line 28

def liquidation_address_controller_create_liquidation_address(customer_id, create_liquidation_address_dto, opts = {})
  data, _status_code, _headers = liquidation_address_controller_create_liquidation_address_with_http_info(customer_id, create_liquidation_address_dto, opts)
  data
end

#liquidation_address_controller_create_liquidation_address_with_http_info(customer_id, create_liquidation_address_dto, opts = {}) ⇒ Array<(LiquidationAddressResponseDto, Integer, Hash)>

Create a new liquidation address for a customer

Create a new liquidation address for a customer. Liquidation addresses allow        customers to automatically liquidate cryptocurrency holdings to fiat or other        stablecoins based on configured parameters.        **Required fields:**       - chain: Blockchain network (ethereum, polygon, arbitrum, base)       - currency: Stablecoin currency (usdc, eurc, dai, pyusd, usdt)       - address: Valid blockchain address        **At least one destination must be specified:**       - external_account_id: External bank        - prefunded_account_id: Developer&#39;s prefunded account       - bridge_wallet_id: Bridge wallet       - destination_address: Crypto wallet address        **Payment Rails:**       Different payment rails have different requirements:       - ACH: Requires external_account_id, supports destination_ach_reference       - SEPA: Requires external_account_id, supports destination_sepa_reference       - Wire: Requires external_account_id, supports destination_wire_message       - Crypto: Requires destination_address, supports destination_blockchain_memo

Parameters:

  • customer_id (String) —

    Unique identifier for the customer

  • create_liquidation_address_dto (CreateLiquidationAddressDto)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/devdraft/api/liquidation_addresses_api.rb', line 39

def liquidation_address_controller_create_liquidation_address_with_http_info(customer_id, create_liquidation_address_dto, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LiquidationAddressesApi.liquidation_address_controller_create_liquidation_address ...'
  end
  # verify the required parameter 'customer_id' is set
  if @api_client.config.client_side_validation && customer_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_id' when calling LiquidationAddressesApi.liquidation_address_controller_create_liquidation_address"
  end
  # verify the required parameter 'create_liquidation_address_dto' is set
  if @api_client.config.client_side_validation && create_liquidation_address_dto.nil?
    fail ArgumentError, "Missing the required parameter 'create_liquidation_address_dto' when calling LiquidationAddressesApi.liquidation_address_controller_create_liquidation_address"
  end
  # resource path
  local_var_path = '/api/v0/customers/{customerId}/liquidation_addresses'.sub('{' + 'customerId' + '}', CGI.escape(customer_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(create_liquidation_address_dto)

  # return_type
  return_type = opts[:debug_return_type] || 'LiquidationAddressResponseDto'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"LiquidationAddressesApi.liquidation_address_controller_create_liquidation_address",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LiquidationAddressesApi#liquidation_address_controller_create_liquidation_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#liquidation_address_controller_get_liquidation_address(customer_id, liquidation_address_id, opts = {}) ⇒ LiquidationAddressResponseDto

Get a specific liquidation address Retrieve a specific liquidation address by its ID for a given customer.

Parameters:

  • customer_id (String) —

    Unique identifier for the customer

  • liquidation_address_id (String) —

    Unique identifier for the liquidation address

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



102
103
104
105
 
# File 'lib/devdraft/api/liquidation_addresses_api.rb', line 102

def liquidation_address_controller_get_liquidation_address(customer_id, liquidation_address_id, opts = {})
  data, _status_code, _headers = liquidation_address_controller_get_liquidation_address_with_http_info(customer_id, liquidation_address_id, opts)
  data
end

#liquidation_address_controller_get_liquidation_address_with_http_info(customer_id, liquidation_address_id, opts = {}) ⇒ Array<(LiquidationAddressResponseDto, Integer, Hash)>

Get a specific liquidation address Retrieve a specific liquidation address by its ID for a given customer.

Parameters:

  • customer_id (String) —

    Unique identifier for the customer

  • liquidation_address_id (String) —

    Unique identifier for the liquidation address

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/devdraft/api/liquidation_addresses_api.rb', line 113

def liquidation_address_controller_get_liquidation_address_with_http_info(customer_id, liquidation_address_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LiquidationAddressesApi.liquidation_address_controller_get_liquidation_address ...'
  end
  # verify the required parameter 'customer_id' is set
  if @api_client.config.client_side_validation && customer_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_id' when calling LiquidationAddressesApi.liquidation_address_controller_get_liquidation_address"
  end
  # verify the required parameter 'liquidation_address_id' is set
  if @api_client.config.client_side_validation && liquidation_address_id.nil?
    fail ArgumentError, "Missing the required parameter 'liquidation_address_id' when calling LiquidationAddressesApi.liquidation_address_controller_get_liquidation_address"
  end
  # resource path
  local_var_path = '/api/v0/customers/{customerId}/liquidation_addresses/{liquidationAddressId}'.sub('{' + 'customerId' + '}', CGI.escape(customer_id.to_s)).sub('{' + 'liquidationAddressId' + '}', CGI.escape(liquidation_address_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LiquidationAddressResponseDto'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"LiquidationAddressesApi.liquidation_address_controller_get_liquidation_address",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LiquidationAddressesApi#liquidation_address_controller_get_liquidation_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#liquidation_address_controller_get_liquidation_addresses(customer_id, opts = {}) ⇒ Array<LiquidationAddressResponseDto>

Get all liquidation addresses for a customer Retrieve all liquidation addresses associated with a specific customer.

Parameters:

  • customer_id (String) —

    Unique identifier for the customer

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



170
171
172
173
 
# File 'lib/devdraft/api/liquidation_addresses_api.rb', line 170

def liquidation_address_controller_get_liquidation_addresses(customer_id, opts = {})
  data, _status_code, _headers = liquidation_address_controller_get_liquidation_addresses_with_http_info(customer_id, opts)
  data
end

#liquidation_address_controller_get_liquidation_addresses_with_http_info(customer_id, opts = {}) ⇒ Array<(Array<LiquidationAddressResponseDto>, Integer, Hash)>

Get all liquidation addresses for a customer Retrieve all liquidation addresses associated with a specific customer.

Parameters:

  • customer_id (String) —

    Unique identifier for the customer

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<LiquidationAddressResponseDto>, Integer, Hash)>) —

    Array<LiquidationAddressResponseDto> data, response status code and response headers



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/devdraft/api/liquidation_addresses_api.rb', line 180

def liquidation_address_controller_get_liquidation_addresses_with_http_info(customer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LiquidationAddressesApi.liquidation_address_controller_get_liquidation_addresses ...'
  end
  # verify the required parameter 'customer_id' is set
  if @api_client.config.client_side_validation && customer_id.nil?
    fail ArgumentError, "Missing the required parameter 'customer_id' when calling LiquidationAddressesApi.liquidation_address_controller_get_liquidation_addresses"
  end
  # resource path
  local_var_path = '/api/v0/customers/{customerId}/liquidation_addresses'.sub('{' + 'customerId' + '}', CGI.escape(customer_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<LiquidationAddressResponseDto>'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"LiquidationAddressesApi.liquidation_address_controller_get_liquidation_addresses",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LiquidationAddressesApi#liquidation_address_controller_get_liquidation_addresses\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end