privy_ruby 0.2.0 → 0.3.0

data/lib/privy/models/kraken_embed_asset_sort_option.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    # Sorting options for the asset list endpoint.
+    module KrakenEmbedAssetSortOption
+      extend Privy::Internal::Type::Enum
+
+      TRENDING = :trending
+      MARKET_CAP_RANK = :market_cap_rank
+      MINUS_MARKET_CAP_RANK = :"-market_cap_rank"
+      SYMBOL = :symbol
+      MINUS_SYMBOL = :"-symbol"
+      NAME = :name
+      MINUS_NAME = :"-name"
+      CHANGE_PERCENT_1H = :change_percent_1h
+      MINUS_CHANGE_PERCENT_1_H = :"-change_percent_1h"
+      CHANGE_PERCENT_24H = :change_percent_24h
+      MINUS_CHANGE_PERCENT_24_H = :"-change_percent_24h"
+      CHANGE_PERCENT_7D = :change_percent_7d
+      MINUS_CHANGE_PERCENT_7_D = :"-change_percent_7d"
+      CHANGE_PERCENT_30D = :change_percent_30d
+      MINUS_CHANGE_PERCENT_30_D = :"-change_percent_30d"
+      CHANGE_PERCENT_1Y = :change_percent_1y
+      MINUS_CHANGE_PERCENT_1_Y = :"-change_percent_1y"
+      LISTING_DATE = :listing_date
+      MINUS_LISTING_DATE = :"-listing_date"
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/privy/models/kraken_embed_cancel_custom_order_response.rb

@@ -6,8 +6,8 @@ module Privy
       # @!attribute result
       #   Result payload for cancel custom order response.
       #
-      #   @return [Privy::Models::KrakenEmbedCancelCustomOrderResponse::Result]
-      required :result, -> { Privy::KrakenEmbedCancelCustomOrderResponse::Result }
+      #   @return [Privy::Models::KrakenEmbedCancelCustomOrderResult, nil]
+      required :result, -> { Privy::KrakenEmbedCancelCustomOrderResult }, nil?: true
 
       # @!attribute error
       #
@@ -22,17 +22,11 @@ module Privy
       # @!method initialize(result:, error: nil, errors: nil)
       #   Response body for cancelling a custom order.
       #
-      #   @param result [Privy::Models::KrakenEmbedCancelCustomOrderResponse::Result] Result payload for cancel custom order response.
+      #   @param result [Privy::Models::KrakenEmbedCancelCustomOrderResult, nil] Result payload for cancel custom order response.
       #
       #   @param error [Array<Object>]
       #
       #   @param errors [Array<Object>]
-
-      # @see Privy::Models::KrakenEmbedCancelCustomOrderResponse#result
-      class Result < Privy::Models::KrakenEmbedCancelCustomOrderResult
-        # @!method initialize
-        #   Result payload for cancel custom order response.
-      end
     end
   end
 end

data/lib/privy/models/kraken_embed_country_code.rb

@@ -0,0 +1,276 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    # ISO 3166-1 alpha-2 country codes supported by Kraken Embed.
+    module KrakenEmbedCountryCode
+      extend Privy::Internal::Type::Enum
+
+      AD = :AD
+      AE = :AE
+      AF = :AF
+      AG = :AG
+      AI = :AI
+      AL = :AL
+      AM = :AM
+      AO = :AO
+      AQ = :AQ
+      AR = :AR
+      AS = :AS
+      AT = :AT
+      AU = :AU
+      AW = :AW
+      AX = :AX
+      AZ = :AZ
+      BA = :BA
+      BB = :BB
+      BD = :BD
+      BE = :BE
+      BF = :BF
+      BG = :BG
+      BH = :BH
+      BI = :BI
+      BJ = :BJ
+      BL = :BL
+      BM = :BM
+      BN = :BN
+      BO = :BO
+      BQ = :BQ
+      BR = :BR
+      BS = :BS
+      BT = :BT
+      BV = :BV
+      BW = :BW
+      BY = :BY
+      BZ = :BZ
+      CA = :CA
+      CC = :CC
+      CD = :CD
+      CF = :CF
+      CG = :CG
+      CH = :CH
+      CI = :CI
+      CK = :CK
+      CL = :CL
+      CM = :CM
+      CN = :CN
+      CO = :CO
+      CR = :CR
+      CU = :CU
+      CV = :CV
+      CW = :CW
+      CX = :CX
+      CY = :CY
+      CZ = :CZ
+      DE = :DE
+      DJ = :DJ
+      DK = :DK
+      DM = :DM
+      DO = :DO
+      DZ = :DZ
+      EC = :EC
+      EE = :EE
+      EG = :EG
+      EH = :EH
+      ER = :ER
+      ES = :ES
+      ET = :ET
+      FI = :FI
+      FJ = :FJ
+      FK = :FK
+      FM = :FM
+      FO = :FO
+      FR = :FR
+      GA = :GA
+      GB = :GB
+      GD = :GD
+      GE = :GE
+      GF = :GF
+      GG = :GG
+      GH = :GH
+      GI = :GI
+      GL = :GL
+      GM = :GM
+      GN = :GN
+      GP = :GP
+      GQ = :GQ
+      GR = :GR
+      GS = :GS
+      GT = :GT
+      GU = :GU
+      GW = :GW
+      GY = :GY
+      HK = :HK
+      HM = :HM
+      HN = :HN
+      HR = :HR
+      HT = :HT
+      HU = :HU
+      ID = :ID
+      IE = :IE
+      IL = :IL
+      IM = :IM
+      IN = :IN
+      IO = :IO
+      IQ = :IQ
+      IR = :IR
+      IS = :IS
+      IT = :IT
+      JE = :JE
+      JM = :JM
+      JO = :JO
+      JP = :JP
+      KE = :KE
+      KG = :KG
+      KH = :KH
+      KI = :KI
+      KM = :KM
+      KN = :KN
+      KP = :KP
+      KR = :KR
+      KW = :KW
+      KY = :KY
+      KZ = :KZ
+      LA = :LA
+      LB = :LB
+      LC = :LC
+      LI = :LI
+      LK = :LK
+      LR = :LR
+      LS = :LS
+      LT = :LT
+      LU = :LU
+      LV = :LV
+      LY = :LY
+      MA = :MA
+      MC = :MC
+      MD = :MD
+      ME = :ME
+      MF = :MF
+      MG = :MG
+      MH = :MH
+      MK = :MK
+      ML = :ML
+      MM = :MM
+      MN = :MN
+      MO = :MO
+      MP = :MP
+      MQ = :MQ
+      MR = :MR
+      MS = :MS
+      MT = :MT
+      MU = :MU
+      MV = :MV
+      MW = :MW
+      MX = :MX
+      MY = :MY
+      MZ = :MZ
+      NA = :NA
+      NC = :NC
+      NE = :NE
+      NF = :NF
+      NG = :NG
+      NI = :NI
+      NL = :NL
+      NO = :NO
+      NP = :NP
+      NR = :NR
+      NU = :NU
+      NZ = :NZ
+      OM = :OM
+      PA = :PA
+      PE = :PE
+      PF = :PF
+      PG = :PG
+      PH = :PH
+      PK = :PK
+      PL = :PL
+      PM = :PM
+      PN = :PN
+      PR = :PR
+      PS = :PS
+      PT = :PT
+      PW = :PW
+      PY = :PY
+      QA = :QA
+      RE = :RE
+      RO = :RO
+      RS = :RS
+      RU = :RU
+      RW = :RW
+      SA = :SA
+      SB = :SB
+      SC = :SC
+      SD = :SD
+      SE = :SE
+      SG = :SG
+      SH = :SH
+      SI = :SI
+      SJ = :SJ
+      SK = :SK
+      SL = :SL
+      SM = :SM
+      SN = :SN
+      SO = :SO
+      SR = :SR
+      SS = :SS
+      ST = :ST
+      SV = :SV
+      SX = :SX
+      SY = :SY
+      SZ = :SZ
+      TC = :TC
+      TD = :TD
+      TF = :TF
+      TG = :TG
+      TH = :TH
+      TJ = :TJ
+      TK = :TK
+      TL = :TL
+      TM = :TM
+      TN = :TN
+      TO = :TO
+      TR = :TR
+      TT = :TT
+      TV = :TV
+      TW = :TW
+      TZ = :TZ
+      UA = :UA
+      UG = :UG
+      UM = :UM
+      US = :US
+      UY = :UY
+      UZ = :UZ
+      VA = :VA
+      VC = :VC
+      VE = :VE
+      VG = :VG
+      VI = :VI
+      VN = :VN
+      VU = :VU
+      WF = :WF
+      WS = :WS
+      YE = :YE
+      YT = :YT
+      ZA = :ZA
+      ZM = :ZM
+      ZW = :ZW
+      AC = :AC
+      AN = :AN
+      AP = :AP
+      CP = :CP
+      DG = :DG
+      EA = :EA
+      EU = :EU
+      IC = :IC
+      JX = :JX
+      TA = :TA
+      QO = :QO
+      XK = :XK
+      KRAKEN_EMBED_COUNTRY_CODE_0_C = :"0C"
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/privy/models/kraken_embed_create_custom_order_response.rb

@@ -6,8 +6,8 @@ module Privy
       # @!attribute result
       #   Result payload for create custom order response.
       #
-      #   @return [Privy::Models::KrakenEmbedCreateCustomOrderResponse::Result]
-      required :result, -> { Privy::KrakenEmbedCreateCustomOrderResponse::Result }
+      #   @return [Privy::Models::KrakenEmbedCreateCustomOrderResult, nil]
+      required :result, -> { Privy::KrakenEmbedCreateCustomOrderResult }, nil?: true
 
       # @!attribute error
       #
@@ -22,17 +22,11 @@ module Privy
       # @!method initialize(result:, error: nil, errors: nil)
       #   Response body for creating a custom order.
       #
-      #   @param result [Privy::Models::KrakenEmbedCreateCustomOrderResponse::Result] Result payload for create custom order response.
+      #   @param result [Privy::Models::KrakenEmbedCreateCustomOrderResult, nil] Result payload for create custom order response.
       #
       #   @param error [Array<Object>]
       #
       #   @param errors [Array<Object>]
-
-      # @see Privy::Models::KrakenEmbedCreateCustomOrderResponse#result
-      class Result < Privy::Models::KrakenEmbedCreateCustomOrderResult
-        # @!method initialize
-        #   Result payload for create custom order response.
-      end
     end
   end
 end

data/lib/privy/models/kraken_embed_custom_order_action.rb

@@ -26,9 +26,10 @@ module Privy
       required :spread_bps, String
 
       # @!attribute type
+      #   Whether the quote amount refers to the asset being received or spent.
       #
-      #   @return [Symbol, Privy::Models::KrakenEmbedCustomOrderAction::Type]
-      required :type, enum: -> { Privy::KrakenEmbedCustomOrderAction::Type }
+      #   @return [Symbol, Privy::Models::KrakenEmbedQuoteType]
+      required :type, enum: -> { Privy::KrakenEmbedQuoteType }
 
       # @!method initialize(amount:, fee_bps:, quote:, spread_bps:, type:)
       #   Trade action for a custom order.
@@ -41,18 +42,7 @@ module Privy
       #
       #   @param spread_bps [String]
       #
-      #   @param type [Symbol, Privy::Models::KrakenEmbedCustomOrderAction::Type]
-
-      # @see Privy::Models::KrakenEmbedCustomOrderAction#type
-      module Type
-        extend Privy::Internal::Type::Enum
-
-        RECEIVE = :receive
-        SPEND = :spend
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
+      #   @param type [Symbol, Privy::Models::KrakenEmbedQuoteType] Whether the quote amount refers to the asset being received or spent.
     end
   end
 end

data/lib/privy/models/kraken_embed_custom_order_occurrence.rb

@@ -14,9 +14,10 @@ module Privy
       required :created_at, Time
 
       # @!attribute status
+      #   Outcome status of a custom order execution occurrence.
       #
-      #   @return [Symbol, Privy::Models::KrakenEmbedCustomOrderOccurrence::Status]
-      required :status, enum: -> { Privy::KrakenEmbedCustomOrderOccurrence::Status }
+      #   @return [Symbol, Privy::Models::KrakenEmbedCustomOrderOccurrenceStatus]
+      required :status, enum: -> { Privy::KrakenEmbedCustomOrderOccurrenceStatus }
 
       # @!attribute trigger
       #   Trigger metadata for a custom order occurrence.
@@ -32,8 +33,8 @@ module Privy
       # @!attribute executed_action
       #   Executed action details for a custom order occurrence.
       #
-      #   @return [Privy::Models::KrakenEmbedCustomOrderOccurrence::ExecutedAction, nil]
-      optional :executed_action, -> { Privy::KrakenEmbedCustomOrderOccurrence::ExecutedAction }
+      #   @return [Privy::Models::KrakenEmbedCustomOrderOccurrenceExecutedAction, nil]
+      optional :executed_action, -> { Privy::KrakenEmbedCustomOrderOccurrenceExecutedAction }, nil?: true
 
       # @!attribute failure_reason
       #
@@ -52,35 +53,17 @@ module Privy
       #
       #   @param created_at [Time]
       #
-      #   @param status [Symbol, Privy::Models::KrakenEmbedCustomOrderOccurrence::Status]
+      #   @param status [Symbol, Privy::Models::KrakenEmbedCustomOrderOccurrenceStatus] Outcome status of a custom order execution occurrence.
       #
       #   @param trigger [Privy::Models::KrakenEmbedCustomOrderOccurrenceTrigger] Trigger metadata for a custom order occurrence.
       #
       #   @param updated_at [Time]
       #
-      #   @param executed_action [Privy::Models::KrakenEmbedCustomOrderOccurrence::ExecutedAction] Executed action details for a custom order occurrence.
+      #   @param executed_action [Privy::Models::KrakenEmbedCustomOrderOccurrenceExecutedAction, nil] Executed action details for a custom order occurrence.
       #
       #   @param failure_reason [String]
       #
       #   @param skip_reason [String]
-
-      # @see Privy::Models::KrakenEmbedCustomOrderOccurrence#status
-      module Status
-        extend Privy::Internal::Type::Enum
-
-        SUCCESS = :success
-        FAILURE = :failure
-        SKIPPED = :skipped
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      # @see Privy::Models::KrakenEmbedCustomOrderOccurrence#executed_action
-      class ExecutedAction < Privy::Models::KrakenEmbedCustomOrderOccurrenceExecutedAction
-        # @!method initialize
-        #   Executed action details for a custom order occurrence.
-      end
     end
   end
 end

data/lib/privy/models/kraken_embed_custom_order_occurrence_status.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    # Outcome status of a custom order execution occurrence.
+    module KrakenEmbedCustomOrderOccurrenceStatus
+      extend Privy::Internal::Type::Enum
+
+      SUCCESS = :success
+      FAILURE = :failure
+      SKIPPED = :skipped
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/privy/models/kraken_embed_custom_order_occurrence_trigger.rb

@@ -4,27 +4,15 @@ module Privy
   module Models
     class KrakenEmbedCustomOrderOccurrenceTrigger < Privy::Internal::Type::BaseModel
       # @!attribute type
+      #   The trigger type that caused a custom order occurrence to execute.
       #
-      #   @return [Symbol, Privy::Models::KrakenEmbedCustomOrderOccurrenceTrigger::Type]
-      required :type, enum: -> { Privy::KrakenEmbedCustomOrderOccurrenceTrigger::Type }
+      #   @return [Symbol, Privy::Models::KrakenEmbedCustomOrderOccurrenceTriggerType]
+      required :type, enum: -> { Privy::KrakenEmbedCustomOrderOccurrenceTriggerType }
 
       # @!method initialize(type:)
       #   Trigger metadata for a custom order occurrence.
       #
-      #   @param type [Symbol, Privy::Models::KrakenEmbedCustomOrderOccurrenceTrigger::Type]
-
-      # @see Privy::Models::KrakenEmbedCustomOrderOccurrenceTrigger#type
-      module Type
-        extend Privy::Internal::Type::Enum
-
-        TIME = :time
-        PRICE = :price
-        CRYPTO_DEPOSIT = :crypto_deposit
-        MARKET_OPEN = :market_open
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
+      #   @param type [Symbol, Privy::Models::KrakenEmbedCustomOrderOccurrenceTriggerType] The trigger type that caused a custom order occurrence to execute.
     end
   end
 end

data/lib/privy/models/kraken_embed_custom_order_occurrence_trigger_type.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    # The trigger type that caused a custom order occurrence to execute.
+    module KrakenEmbedCustomOrderOccurrenceTriggerType
+      extend Privy::Internal::Type::Enum
+
+      TIME = :time
+      PRICE = :price
+      CRYPTO_DEPOSIT = :crypto_deposit
+      MARKET_OPEN = :market_open
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/privy/models/kraken_embed_custom_order_status.rb

@@ -4,9 +4,10 @@ module Privy
   module Models
     class KrakenEmbedCustomOrderStatus < Privy::Internal::Type::BaseModel
       # @!attribute status
+      #   The lifecycle state of a custom order.
       #
-      #   @return [Symbol, Privy::Models::KrakenEmbedCustomOrderStatus::Status]
-      required :status, enum: -> { Privy::KrakenEmbedCustomOrderStatus::Status }
+      #   @return [Symbol, Privy::Models::KrakenEmbedCustomOrderStatusValue]
+      required :status, enum: -> { Privy::KrakenEmbedCustomOrderStatusValue }
 
       # @!attribute reason
       #
@@ -16,21 +17,9 @@ module Privy
       # @!method initialize(status:, reason: nil)
       #   Custom order status with optional reason for cancelled or paused states.
       #
-      #   @param status [Symbol, Privy::Models::KrakenEmbedCustomOrderStatus::Status]
+      #   @param status [Symbol, Privy::Models::KrakenEmbedCustomOrderStatusValue] The lifecycle state of a custom order.
+      #
       #   @param reason [Object]
-
-      # @see Privy::Models::KrakenEmbedCustomOrderStatus#status
-      module Status
-        extend Privy::Internal::Type::Enum
-
-        ACTIVE = :active
-        COMPLETED = :completed
-        CANCELLED = :cancelled
-        PAUSED = :paused
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
     end
   end
 end

data/lib/privy/models/kraken_embed_custom_order_status_value.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    # The lifecycle state of a custom order.
+    module KrakenEmbedCustomOrderStatusValue
+      extend Privy::Internal::Type::Enum
+
+      ACTIVE = :active
+      COMPLETED = :completed
+      CANCELLED = :cancelled
+      PAUSED = :paused
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/privy/models/kraken_embed_custom_order_trigger.rb

@@ -9,9 +9,10 @@ module Privy
       required :base_asset, String
 
       # @!attribute condition
+      #   Comparison operator for a custom order price trigger.
       #
-      #   @return [Symbol, Privy::Models::KrakenEmbedCustomOrderTrigger::Condition]
-      required :condition, enum: -> { Privy::KrakenEmbedCustomOrderTrigger::Condition }
+      #   @return [Symbol, Privy::Models::KrakenEmbedCustomOrderTriggerCondition]
+      required :condition, enum: -> { Privy::KrakenEmbedCustomOrderTriggerCondition }
 
       # @!attribute quote_asset
       #
@@ -33,22 +34,15 @@ module Privy
       #   rate meets the condition against target_price.
       #
       #   @param base_asset [String]
-      #   @param condition [Symbol, Privy::Models::KrakenEmbedCustomOrderTrigger::Condition]
+      #
+      #   @param condition [Symbol, Privy::Models::KrakenEmbedCustomOrderTriggerCondition] Comparison operator for a custom order price trigger.
+      #
       #   @param quote_asset [String]
+      #
       #   @param target_price [String]
+      #
       #   @param type [Symbol, Privy::Models::KrakenEmbedCustomOrderTrigger::Type]
 
-      # @see Privy::Models::KrakenEmbedCustomOrderTrigger#condition
-      module Condition
-        extend Privy::Internal::Type::Enum
-
-        GTE = :gte
-        LTE = :lte
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
       # @see Privy::Models::KrakenEmbedCustomOrderTrigger#type
       module Type
         extend Privy::Internal::Type::Enum

data/lib/privy/models/kraken_embed_custom_order_trigger_condition.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    # Comparison operator for a custom order price trigger.
+    module KrakenEmbedCustomOrderTriggerCondition
+      extend Privy::Internal::Type::Enum
+
+      GTE = :gte
+      LTE = :lte
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/privy/models/kraken_embed_earn_asset.rb

@@ -6,33 +6,21 @@ module Privy
       # @!attribute apr_estimate
       #   Low and high estimate of the yield of an earn asset.
       #
-      #   @return [Privy::Models::KrakenEmbedEarnAsset::AprEstimate]
-      required :apr_estimate, -> { Privy::KrakenEmbedEarnAsset::AprEstimate }
+      #   @return [Privy::Models::KrakenEmbedEarnAprEstimate, nil]
+      required :apr_estimate, -> { Privy::KrakenEmbedEarnAprEstimate }, nil?: true
 
       # @!attribute user_allocation
       #   User allocation for an earn asset.
       #
-      #   @return [Privy::Models::KrakenEmbedEarnAsset::UserAllocation, nil]
-      optional :user_allocation, -> { Privy::KrakenEmbedEarnAsset::UserAllocation }
+      #   @return [Privy::Models::KrakenEmbedEarnUserAllocation, nil]
+      optional :user_allocation, -> { Privy::KrakenEmbedEarnUserAllocation }, nil?: true
 
       # @!method initialize(apr_estimate:, user_allocation: nil)
       #   A single asset that can yield rewards.
       #
-      #   @param apr_estimate [Privy::Models::KrakenEmbedEarnAsset::AprEstimate] Low and high estimate of the yield of an earn asset.
+      #   @param apr_estimate [Privy::Models::KrakenEmbedEarnAprEstimate, nil] Low and high estimate of the yield of an earn asset.
       #
-      #   @param user_allocation [Privy::Models::KrakenEmbedEarnAsset::UserAllocation] User allocation for an earn asset.
-
-      # @see Privy::Models::KrakenEmbedEarnAsset#apr_estimate
-      class AprEstimate < Privy::Models::KrakenEmbedEarnAprEstimate
-        # @!method initialize
-        #   Low and high estimate of the yield of an earn asset.
-      end
-
-      # @see Privy::Models::KrakenEmbedEarnAsset#user_allocation
-      class UserAllocation < Privy::Models::KrakenEmbedEarnUserAllocation
-        # @!method initialize
-        #   User allocation for an earn asset.
-      end
+      #   @param user_allocation [Privy::Models::KrakenEmbedEarnUserAllocation, nil] User allocation for an earn asset.
     end
   end
 end