coinbase-sdk 0.0.14 → 0.1.0

data/lib/coinbase/client/models/staking_reward_usd_value.rb

@@ -0,0 +1,257 @@
+=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.7.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Coinbase::Client
+  # The USD value of the reward
+  class StakingRewardUSDValue
+    # The value of the reward in USD
+    attr_accessor :amount
+
+    # The conversion price from native currency to USD
+    attr_accessor :conversion_price
+
+    # The time of the conversion in UTC.
+    attr_accessor :conversion_time
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'amount' => :'amount',
+        :'conversion_price' => :'conversion_price',
+        :'conversion_time' => :'conversion_time'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'amount' => :'String',
+        :'conversion_price' => :'String',
+        :'conversion_time' => :'Time'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Coinbase::Client::StakingRewardUSDValue` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Coinbase::Client::StakingRewardUSDValue`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'amount')
+        self.amount = attributes[:'amount']
+      else
+        self.amount = nil
+      end
+
+      if attributes.key?(:'conversion_price')
+        self.conversion_price = attributes[:'conversion_price']
+      else
+        self.conversion_price = nil
+      end
+
+      if attributes.key?(:'conversion_time')
+        self.conversion_time = attributes[:'conversion_time']
+      else
+        self.conversion_time = nil
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @amount.nil?
+        invalid_properties.push('invalid value for "amount", amount cannot be nil.')
+      end
+
+      if @conversion_price.nil?
+        invalid_properties.push('invalid value for "conversion_price", conversion_price cannot be nil.')
+      end
+
+      if @conversion_time.nil?
+        invalid_properties.push('invalid value for "conversion_time", conversion_time cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @amount.nil?
+      return false if @conversion_price.nil?
+      return false if @conversion_time.nil?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          amount == o.amount &&
+          conversion_price == o.conversion_price &&
+          conversion_time == o.conversion_time
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [amount, conversion_price, conversion_time].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = Coinbase::Client.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/coinbase/client/models/transaction.rb

@@ -16,25 +16,28 @@ require 'time'
 module Coinbase::Client
   # An onchain transaction.
   class Transaction
-    # The ID of the blockchain network
+    # The ID of the blockchain network.
     attr_accessor :network_id
 
-    # The onchain address of the sender
+    # The onchain address of the sender.
     attr_accessor :from_address_id
 
+    # The onchain address of the recipient.
+    attr_accessor :to_address_id
+
     # The unsigned payload of the transaction. This is the payload that needs to be signed by the sender.
     attr_accessor :unsigned_payload
 
     # The signed payload of the transaction. This is the payload that has been signed by the sender.
     attr_accessor :signed_payload
 
-    # The hash of the transaction
+    # The hash of the transaction.
     attr_accessor :transaction_hash
 
     # The link to view the transaction on a block explorer. This is optional and may not be present for all transactions.
     attr_accessor :transaction_link
 
-    # The status of the transaction
+    # The status of the transaction.
     attr_accessor :status
 
     class EnumAttributeValidator
@@ -64,6 +67,7 @@ module Coinbase::Client
       {
         :'network_id' => :'network_id',
         :'from_address_id' => :'from_address_id',
+        :'to_address_id' => :'to_address_id',
         :'unsigned_payload' => :'unsigned_payload',
         :'signed_payload' => :'signed_payload',
         :'transaction_hash' => :'transaction_hash',
@@ -82,6 +86,7 @@ module Coinbase::Client
       {
         :'network_id' => :'String',
         :'from_address_id' => :'String',
+        :'to_address_id' => :'String',
         :'unsigned_payload' => :'String',
         :'signed_payload' => :'String',
         :'transaction_hash' => :'String',
@@ -123,6 +128,10 @@ module Coinbase::Client
         self.from_address_id = nil
       end
 
+      if attributes.key?(:'to_address_id')
+        self.to_address_id = attributes[:'to_address_id']
+      end
+
       if attributes.key?(:'unsigned_payload')
         self.unsigned_payload = attributes[:'unsigned_payload']
       else
@@ -180,7 +189,7 @@ module Coinbase::Client
       return false if @from_address_id.nil?
       return false if @unsigned_payload.nil?
       return false if @status.nil?
-      status_validator = EnumAttributeValidator.new('String', ["pending", "signed", "broadcast", "complete", "failed"])
+      status_validator = EnumAttributeValidator.new('String', ["pending", "signed", "broadcast", "complete", "failed", "unknown_default_open_api"])
       return false unless status_validator.valid?(@status)
       true
     end
@@ -188,7 +197,7 @@ module Coinbase::Client
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] status Object to be assigned
     def status=(status)
-      validator = EnumAttributeValidator.new('String', ["pending", "signed", "broadcast", "complete", "failed"])
+      validator = EnumAttributeValidator.new('String', ["pending", "signed", "broadcast", "complete", "failed", "unknown_default_open_api"])
       unless validator.valid?(status)
         fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
       end
@@ -202,6 +211,7 @@ module Coinbase::Client
       self.class == o.class &&
           network_id == o.network_id &&
           from_address_id == o.from_address_id &&
+          to_address_id == o.to_address_id &&
           unsigned_payload == o.unsigned_payload &&
           signed_payload == o.signed_payload &&
           transaction_hash == o.transaction_hash &&
@@ -218,7 +228,7 @@ module Coinbase::Client
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [network_id, from_address_id, unsigned_payload, signed_payload, transaction_hash, transaction_link, status].hash
+      [network_id, from_address_id, to_address_id, unsigned_payload, signed_payload, transaction_hash, transaction_link, status].hash
     end
 
     # Builds the object from hash

data/lib/coinbase/client/models/transaction_type.rb

@@ -16,9 +16,10 @@ require 'time'
 module Coinbase::Client
   class TransactionType
     TRANSFER = "transfer".freeze
+    UNKNOWN_DEFAULT_OPEN_API = "unknown_default_open_api".freeze
 
     def self.all_vars
-      @all_vars ||= [TRANSFER].freeze
+      @all_vars ||= [TRANSFER, UNKNOWN_DEFAULT_OPEN_API].freeze
     end
 
     # Builds the enum from string

data/lib/coinbase/client/models/transfer.rb

@@ -41,6 +41,45 @@ module Coinbase::Client
 
     attr_accessor :transaction
 
+    attr_accessor :sponsored_send
+
+    # The unsigned payload of the transfer. This is the payload that needs to be signed by the sender.
+    attr_accessor :unsigned_payload
+
+    # The signed payload of the transfer. This is the payload that has been signed by the sender.
+    attr_accessor :signed_payload
+
+    # The hash of the transfer transaction
+    attr_accessor :transaction_hash
+
+    # The status of the transfer
+    attr_accessor :status
+
+    # Whether the transfer uses sponsored gas
+    attr_accessor :gasless
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -52,7 +91,13 @@ module Coinbase::Client
         :'asset_id' => :'asset_id',
         :'asset' => :'asset',
         :'transfer_id' => :'transfer_id',
-        :'transaction' => :'transaction'
+        :'transaction' => :'transaction',
+        :'sponsored_send' => :'sponsored_send',
+        :'unsigned_payload' => :'unsigned_payload',
+        :'signed_payload' => :'signed_payload',
+        :'transaction_hash' => :'transaction_hash',
+        :'status' => :'status',
+        :'gasless' => :'gasless'
       }
     end
 
@@ -72,7 +117,13 @@ module Coinbase::Client
         :'asset_id' => :'String',
         :'asset' => :'Asset',
         :'transfer_id' => :'String',
-        :'transaction' => :'Transaction'
+        :'transaction' => :'Transaction',
+        :'sponsored_send' => :'SponsoredSend',
+        :'unsigned_payload' => :'String',
+        :'signed_payload' => :'String',
+        :'transaction_hash' => :'String',
+        :'status' => :'String',
+        :'gasless' => :'Boolean'
       }
     end
 
@@ -147,8 +198,32 @@ module Coinbase::Client
 
       if attributes.key?(:'transaction')
         self.transaction = attributes[:'transaction']
+      end
+
+      if attributes.key?(:'sponsored_send')
+        self.sponsored_send = attributes[:'sponsored_send']
+      end
+
+      if attributes.key?(:'unsigned_payload')
+        self.unsigned_payload = attributes[:'unsigned_payload']
+      end
+
+      if attributes.key?(:'signed_payload')
+        self.signed_payload = attributes[:'signed_payload']
+      end
+
+      if attributes.key?(:'transaction_hash')
+        self.transaction_hash = attributes[:'transaction_hash']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'gasless')
+        self.gasless = attributes[:'gasless']
       else
-        self.transaction = nil
+        self.gasless = nil
       end
     end
 
@@ -189,8 +264,8 @@ module Coinbase::Client
         invalid_properties.push('invalid value for "transfer_id", transfer_id cannot be nil.')
       end
 
-      if @transaction.nil?
-        invalid_properties.push('invalid value for "transaction", transaction cannot be nil.')
+      if @gasless.nil?
+        invalid_properties.push('invalid value for "gasless", gasless cannot be nil.')
       end
 
       invalid_properties
@@ -208,10 +283,22 @@ module Coinbase::Client
       return false if @asset_id.nil?
       return false if @asset.nil?
       return false if @transfer_id.nil?
-      return false if @transaction.nil?
+      status_validator = EnumAttributeValidator.new('String', ["pending", "broadcast", "complete", "failed", "unknown_default_open_api"])
+      return false unless status_validator.valid?(@status)
+      return false if @gasless.nil?
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["pending", "broadcast", "complete", "failed", "unknown_default_open_api"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -225,7 +312,13 @@ module Coinbase::Client
           asset_id == o.asset_id &&
           asset == o.asset &&
           transfer_id == o.transfer_id &&
-          transaction == o.transaction
+          transaction == o.transaction &&
+          sponsored_send == o.sponsored_send &&
+          unsigned_payload == o.unsigned_payload &&
+          signed_payload == o.signed_payload &&
+          transaction_hash == o.transaction_hash &&
+          status == o.status &&
+          gasless == o.gasless
     end
 
     # @see the `==` method
@@ -237,7 +330,7 @@ module Coinbase::Client
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [network_id, wallet_id, address_id, destination, amount, asset_id, asset, transfer_id, transaction].hash
+      [network_id, wallet_id, address_id, destination, amount, asset_id, asset, transfer_id, transaction, sponsored_send, unsigned_payload, signed_payload, transaction_hash, status, gasless].hash
     end
 
     # Builds the object from hash

data/lib/coinbase/client/models/validator.rb

@@ -25,11 +25,32 @@ module Coinbase::Client
     # The ID of the asset that the validator helps stake.
     attr_accessor :asset_id
 
-    # The status of the validator.
     attr_accessor :status
 
     attr_accessor :details
 
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -52,7 +73,7 @@ module Coinbase::Client
         :'validator_id' => :'String',
         :'network_id' => :'String',
         :'asset_id' => :'String',
-        :'status' => :'String',
+        :'status' => :'ValidatorStatus',
         :'details' => :'ValidatorDetails'
       }
     end

data/lib/coinbase/client/models/validator_status.rb

@@ -0,0 +1,52 @@
+=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.7.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Coinbase::Client
+  class ValidatorStatus
+    UNKNOWN = "unknown".freeze
+    PROVISIONING = "provisioning".freeze
+    PROVISIONED = "provisioned".freeze
+    DEPOSITED = "deposited".freeze
+    PENDING_ACTIVATION = "pending_activation".freeze
+    ACTIVE = "active".freeze
+    EXITING = "exiting".freeze
+    EXITED = "exited".freeze
+    WITHDRAWAL_AVAILABLE = "withdrawal_available".freeze
+    WITHDRAWAL_COMPLETE = "withdrawal_complete".freeze
+    ACTIVE_SLASHED = "active_slashed".freeze
+    EXITED_SLASHED = "exited_slashed".freeze
+    REAPED = "reaped".freeze
+    UNKNOWN_DEFAULT_OPEN_API = "unknown_default_open_api".freeze
+
+    def self.all_vars
+      @all_vars ||= [UNKNOWN, PROVISIONING, PROVISIONED, DEPOSITED, PENDING_ACTIVATION, ACTIVE, EXITING, EXITED, WITHDRAWAL_AVAILABLE, WITHDRAWAL_COMPLETE, ACTIVE_SLASHED, EXITED_SLASHED, REAPED, UNKNOWN_DEFAULT_OPEN_API].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if ValidatorStatus.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #ValidatorStatus"
+    end
+  end
+end