coinbase-sdk 0.0.7 → 0.0.8

data/lib/coinbase/client/api/external_addresses_api.rb

@@ -0,0 +1,242 @@
+=begin
+#Coinbase Platform API
+
+#This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.
+
+The version of the OpenAPI document: 0.0.1-alpha
+Contact: yuga.cohler@coinbase.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.5.0
+
+=end
+
+require 'cgi'
+
+module Coinbase::Client
+  class ExternalAddressesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get the balance of an asset in an external address
+    # Get the balance of an asset in an external address
+    # @param network_id [String] The ID of the blockchain network
+    # @param address_id [String] The ID of the address to fetch the balance for
+    # @param asset_id [String] The ID of the asset to fetch the balance for
+    # @param [Hash] opts the optional parameters
+    # @return [Balance]
+    def get_external_address_balance(network_id, address_id, asset_id, opts = {})
+      data, _status_code, _headers = get_external_address_balance_with_http_info(network_id, address_id, asset_id, opts)
+      data
+    end
+
+    # Get the balance of an asset in an external address
+    # Get the balance of an asset in an external address
+    # @param network_id [String] The ID of the blockchain network
+    # @param address_id [String] The ID of the address to fetch the balance for
+    # @param asset_id [String] The ID of the asset to fetch the balance for
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Balance, Integer, Hash)>] Balance data, response status code and response headers
+    def get_external_address_balance_with_http_info(network_id, address_id, asset_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ExternalAddressesApi.get_external_address_balance ...'
+      end
+      # verify the required parameter 'network_id' is set
+      if @api_client.config.client_side_validation && network_id.nil?
+        fail ArgumentError, "Missing the required parameter 'network_id' when calling ExternalAddressesApi.get_external_address_balance"
+      end
+      # verify the required parameter 'address_id' is set
+      if @api_client.config.client_side_validation && address_id.nil?
+        fail ArgumentError, "Missing the required parameter 'address_id' when calling ExternalAddressesApi.get_external_address_balance"
+      end
+      # verify the required parameter 'asset_id' is set
+      if @api_client.config.client_side_validation && asset_id.nil?
+        fail ArgumentError, "Missing the required parameter 'asset_id' when calling ExternalAddressesApi.get_external_address_balance"
+      end
+      # resource path
+      local_var_path = '/v1/networks/{network_id}/addresses/{address_id}/balances/{asset_id}'.sub('{' + 'network_id' + '}', CGI.escape(network_id.to_s)).sub('{' + 'address_id' + '}', CGI.escape(address_id.to_s)).sub('{' + 'asset_id' + '}', CGI.escape(asset_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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Balance'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"ExternalAddressesApi.get_external_address_balance",
+        :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: ExternalAddressesApi#get_external_address_balance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get the balances of an external address
+    # List all of the balances of an external address
+    # @param network_id [String] The ID of the blockchain network
+    # @param address_id [String] The ID of the address to fetch the balance for
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :page A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
+    # @return [AddressBalanceList]
+    def list_external_address_balances(network_id, address_id, opts = {})
+      data, _status_code, _headers = list_external_address_balances_with_http_info(network_id, address_id, opts)
+      data
+    end
+
+    # Get the balances of an external address
+    # List all of the balances of an external address
+    # @param network_id [String] The ID of the blockchain network
+    # @param address_id [String] The ID of the address to fetch the balance for
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :page A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
+    # @return [Array<(AddressBalanceList, Integer, Hash)>] AddressBalanceList data, response status code and response headers
+    def list_external_address_balances_with_http_info(network_id, address_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ExternalAddressesApi.list_external_address_balances ...'
+      end
+      # verify the required parameter 'network_id' is set
+      if @api_client.config.client_side_validation && network_id.nil?
+        fail ArgumentError, "Missing the required parameter 'network_id' when calling ExternalAddressesApi.list_external_address_balances"
+      end
+      # verify the required parameter 'address_id' is set
+      if @api_client.config.client_side_validation && address_id.nil?
+        fail ArgumentError, "Missing the required parameter 'address_id' when calling ExternalAddressesApi.list_external_address_balances"
+      end
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'].to_s.length > 5000
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling ExternalAddressesApi.list_external_address_balances, the character length must be smaller than or equal to 5000.'
+      end
+
+      # resource path
+      local_var_path = '/v1/networks/{network_id}/addresses/{address_id}/balances'.sub('{' + 'network_id' + '}', CGI.escape(network_id.to_s)).sub('{' + 'address_id' + '}', CGI.escape(address_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AddressBalanceList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"ExternalAddressesApi.list_external_address_balances",
+        :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: ExternalAddressesApi#list_external_address_balances\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Request faucet funds for external address.
+    # Request faucet funds to be sent to external address.
+    # @param network_id [String] The ID of the wallet the address belongs to.
+    # @param address_id [String] The onchain address of the address that is being fetched.
+    # @param [Hash] opts the optional parameters
+    # @return [FaucetTransaction]
+    def request_external_faucet_funds(network_id, address_id, opts = {})
+      data, _status_code, _headers = request_external_faucet_funds_with_http_info(network_id, address_id, opts)
+      data
+    end
+
+    # Request faucet funds for external address.
+    # Request faucet funds to be sent to external address.
+    # @param network_id [String] The ID of the wallet the address belongs to.
+    # @param address_id [String] The onchain address of the address that is being fetched.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(FaucetTransaction, Integer, Hash)>] FaucetTransaction data, response status code and response headers
+    def request_external_faucet_funds_with_http_info(network_id, address_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ExternalAddressesApi.request_external_faucet_funds ...'
+      end
+      # verify the required parameter 'network_id' is set
+      if @api_client.config.client_side_validation && network_id.nil?
+        fail ArgumentError, "Missing the required parameter 'network_id' when calling ExternalAddressesApi.request_external_faucet_funds"
+      end
+      # verify the required parameter 'address_id' is set
+      if @api_client.config.client_side_validation && address_id.nil?
+        fail ArgumentError, "Missing the required parameter 'address_id' when calling ExternalAddressesApi.request_external_faucet_funds"
+      end
+      # resource path
+      local_var_path = '/v1/networks/{network_id}/addresses/{address_id}/faucet'.sub('{' + 'network_id' + '}', CGI.escape(network_id.to_s)).sub('{' + 'address_id' + '}', CGI.escape(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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'FaucetTransaction'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"ExternalAddressesApi.request_external_faucet_funds",
+        :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: ExternalAddressesApi#request_external_faucet_funds\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/coinbase/client/api/stake_api.rb

@@ -21,23 +21,27 @@ module Coinbase::Client
     end
     # Build a new staking operation
     # Build a new staking operation
+    # @param build_staking_operation_request [BuildStakingOperationRequest] 
     # @param [Hash] opts the optional parameters
-    # @option opts [BuildStakingOperationRequest] :build_staking_operation_request 
     # @return [StakingOperation]
-    def build_staking_operation(opts = {})
-      data, _status_code, _headers = build_staking_operation_with_http_info(opts)
+    def build_staking_operation(build_staking_operation_request, opts = {})
+      data, _status_code, _headers = build_staking_operation_with_http_info(build_staking_operation_request, opts)
       data
     end
 
     # Build a new staking operation
     # Build a new staking operation
+    # @param build_staking_operation_request [BuildStakingOperationRequest] 
     # @param [Hash] opts the optional parameters
-    # @option opts [BuildStakingOperationRequest] :build_staking_operation_request 
     # @return [Array<(StakingOperation, Integer, Hash)>] StakingOperation data, response status code and response headers
-    def build_staking_operation_with_http_info(opts = {})
+    def build_staking_operation_with_http_info(build_staking_operation_request, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: StakeApi.build_staking_operation ...'
       end
+      # verify the required parameter 'build_staking_operation_request' is set
+      if @api_client.config.client_side_validation && build_staking_operation_request.nil?
+        fail ArgumentError, "Missing the required parameter 'build_staking_operation_request' when calling StakeApi.build_staking_operation"
+      end
       # resource path
       local_var_path = '/v1/stake/build'
 
@@ -58,7 +62,7 @@ module Coinbase::Client
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'build_staking_operation_request'])
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(build_staking_operation_request)
 
       # return_type
       return_type = opts[:debug_return_type] || 'StakingOperation'
@@ -82,5 +86,151 @@ module Coinbase::Client
       end
       return data, status_code, headers
     end
+
+    # Fetch staking rewards
+    # Fetch staking rewards for a list of addresses
+    # @param fetch_staking_rewards_request [FetchStakingRewardsRequest] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 50.
+    # @option opts [String] :page A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
+    # @return [FetchStakingRewards200Response]
+    def fetch_staking_rewards(fetch_staking_rewards_request, opts = {})
+      data, _status_code, _headers = fetch_staking_rewards_with_http_info(fetch_staking_rewards_request, opts)
+      data
+    end
+
+    # Fetch staking rewards
+    # Fetch staking rewards for a list of addresses
+    # @param fetch_staking_rewards_request [FetchStakingRewardsRequest] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 50.
+    # @option opts [String] :page A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
+    # @return [Array<(FetchStakingRewards200Response, Integer, Hash)>] FetchStakingRewards200Response data, response status code and response headers
+    def fetch_staking_rewards_with_http_info(fetch_staking_rewards_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StakeApi.fetch_staking_rewards ...'
+      end
+      # verify the required parameter 'fetch_staking_rewards_request' is set
+      if @api_client.config.client_side_validation && fetch_staking_rewards_request.nil?
+        fail ArgumentError, "Missing the required parameter 'fetch_staking_rewards_request' when calling StakeApi.fetch_staking_rewards"
+      end
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'].to_s.length > 5000
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling StakeApi.fetch_staking_rewards, the character length must be smaller than or equal to 5000.'
+      end
+
+      # resource path
+      local_var_path = '/v1/stake/rewards/search'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # 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(fetch_staking_rewards_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'FetchStakingRewards200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"StakeApi.fetch_staking_rewards",
+        :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: StakeApi#fetch_staking_rewards\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get staking context
+    # Get staking context for an address
+    # @param get_staking_context_request [GetStakingContextRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [StakingContext]
+    def get_staking_context(get_staking_context_request, opts = {})
+      data, _status_code, _headers = get_staking_context_with_http_info(get_staking_context_request, opts)
+      data
+    end
+
+    # Get staking context
+    # Get staking context for an address
+    # @param get_staking_context_request [GetStakingContextRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(StakingContext, Integer, Hash)>] StakingContext data, response status code and response headers
+    def get_staking_context_with_http_info(get_staking_context_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StakeApi.get_staking_context ...'
+      end
+      # verify the required parameter 'get_staking_context_request' is set
+      if @api_client.config.client_side_validation && get_staking_context_request.nil?
+        fail ArgumentError, "Missing the required parameter 'get_staking_context_request' when calling StakeApi.get_staking_context"
+      end
+      # resource path
+      local_var_path = '/v1/stake/context'
+
+      # 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'])
+      # 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(get_staking_context_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'StakingContext'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"StakeApi.get_staking_context",
+        :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: StakeApi#get_staking_context\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

data/lib/coinbase/client/api/transfer_api.rb

@@ -0,0 +1,114 @@
+=begin
+#Coinbase Platform API
+
+#This is the OpenAPI 3.0 specification for the Coinbase Platform APIs, used in conjunction with the Coinbase Platform SDKs.
+
+The version of the OpenAPI document: 0.0.1-alpha
+Contact: yuga.cohler@coinbase.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.5.0
+
+=end
+
+require 'cgi'
+
+module Coinbase::Client
+  class TransferApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Build a new transfer
+    # Build a new transfer object without tracking anything server-side.
+    # @param network_id [String] The ID of the blockchain network
+    # @param address_id [String] The ID of the address to transfer from
+    # @param amount [String] The amount to transfer
+    # @param asset_id [String] The ID of the asset to transfer
+    # @param destination [String] The destination address
+    # @param [Hash] opts the optional parameters
+    # @return [Transfer]
+    def build_transfer(network_id, address_id, amount, asset_id, destination, opts = {})
+      data, _status_code, _headers = build_transfer_with_http_info(network_id, address_id, amount, asset_id, destination, opts)
+      data
+    end
+
+    # Build a new transfer
+    # Build a new transfer object without tracking anything server-side.
+    # @param network_id [String] The ID of the blockchain network
+    # @param address_id [String] The ID of the address to transfer from
+    # @param amount [String] The amount to transfer
+    # @param asset_id [String] The ID of the asset to transfer
+    # @param destination [String] The destination address
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Transfer, Integer, Hash)>] Transfer data, response status code and response headers
+    def build_transfer_with_http_info(network_id, address_id, amount, asset_id, destination, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TransferApi.build_transfer ...'
+      end
+      # verify the required parameter 'network_id' is set
+      if @api_client.config.client_side_validation && network_id.nil?
+        fail ArgumentError, "Missing the required parameter 'network_id' when calling TransferApi.build_transfer"
+      end
+      # verify the required parameter 'address_id' is set
+      if @api_client.config.client_side_validation && address_id.nil?
+        fail ArgumentError, "Missing the required parameter 'address_id' when calling TransferApi.build_transfer"
+      end
+      # verify the required parameter 'amount' is set
+      if @api_client.config.client_side_validation && amount.nil?
+        fail ArgumentError, "Missing the required parameter 'amount' when calling TransferApi.build_transfer"
+      end
+      # verify the required parameter 'asset_id' is set
+      if @api_client.config.client_side_validation && asset_id.nil?
+        fail ArgumentError, "Missing the required parameter 'asset_id' when calling TransferApi.build_transfer"
+      end
+      # verify the required parameter 'destination' is set
+      if @api_client.config.client_side_validation && destination.nil?
+        fail ArgumentError, "Missing the required parameter 'destination' when calling TransferApi.build_transfer"
+      end
+      # resource path
+      local_var_path = '/v1/transfers/build'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'network_id'] = network_id
+      query_params[:'address_id'] = address_id
+      query_params[:'amount'] = amount
+      query_params[:'asset_id'] = asset_id
+      query_params[:'destination'] = destination
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Transfer'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"TransferApi.build_transfer",
+        :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: TransferApi#build_transfer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end