privy_ruby 0.2.0 → 0.3.0

data/lib/privy/models/kraken_embed_list_custom_orders_query_params.rb

@@ -15,7 +15,7 @@ module Privy
 
       # @!attribute statuses
       #
-      #   @return [Array<Symbol, Privy::Models::KrakenEmbedListCustomOrdersQueryParams::Statuses::UnionMember0>, String, nil]
+      #   @return [Array<Symbol, Privy::Models::KrakenEmbedCustomOrderStatusValue>, String, nil]
       optional :statuses, union: -> { Privy::KrakenEmbedListCustomOrdersQueryParams::Statuses }
 
       # @!method initialize(user_id:, cursor: nil, statuses: nil)
@@ -23,36 +23,22 @@ module Privy
       #
       #   @param user_id [String]
       #   @param cursor [String]
-      #   @param statuses [Array<Symbol, Privy::Models::KrakenEmbedListCustomOrdersQueryParams::Statuses::UnionMember0>, String]
+      #   @param statuses [Array<Symbol, Privy::Models::KrakenEmbedCustomOrderStatusValue>, String]
 
       # @see Privy::Models::KrakenEmbedListCustomOrdersQueryParams#statuses
       module Statuses
         extend Privy::Internal::Type::Union
 
-        variant -> { Privy::Models::KrakenEmbedListCustomOrdersQueryParams::Statuses::UnionMember0Array }
+        variant -> { Privy::Models::KrakenEmbedListCustomOrdersQueryParams::Statuses::KrakenEmbedCustomOrderStatusValueArray }
 
         variant String
 
-        module UnionMember0
-          extend Privy::Internal::Type::Enum
-
-          ACTIVE = :active
-          PAUSED = :paused
-          CANCELLED = :cancelled
-          COMPLETED = :completed
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
         # @!method self.variants
-        #   @return [Array(Array<Symbol, Privy::Models::KrakenEmbedListCustomOrdersQueryParams::Statuses::UnionMember0>, String)]
+        #   @return [Array(Array<Symbol, Privy::Models::KrakenEmbedCustomOrderStatusValue>, String)]
 
         # @type [Privy::Internal::Type::Converter]
-        UnionMember0Array =
-          Privy::Internal::Type::ArrayOf[enum: -> {
-            Privy::KrakenEmbedListCustomOrdersQueryParams::Statuses::UnionMember0
-          }]
+        KrakenEmbedCustomOrderStatusValueArray =
+          Privy::Internal::Type::ArrayOf[enum: -> { Privy::KrakenEmbedCustomOrderStatusValue }]
       end
     end
   end

data/lib/privy/models/kraken_embed_list_custom_orders_response.rb

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

data/lib/privy/models/kraken_embed_portfolio_summary_payload.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    class KrakenEmbedPortfolioSummaryPayload < Privy::Internal::Type::BaseModel
+      # @!attribute available_balance
+      #
+      #   @return [String]
+      required :available_balance, String
+
+      # @!attribute currency
+      #
+      #   @return [String]
+      required :currency, String
+
+      # @!attribute open_orders
+      #
+      #   @return [String]
+      required :open_orders, String
+
+      # @!attribute portfolio_value
+      #
+      #   @return [String]
+      required :portfolio_value, String
+
+      # @!attribute timestamp
+      #
+      #   @return [Time]
+      required :timestamp, Time
+
+      # @!attribute withheld_value
+      #
+      #   @return [String]
+      required :withheld_value, String
+
+      # @!attribute cost_basis
+      #
+      #   @return [String, nil]
+      optional :cost_basis, String, nil?: true
+
+      # @!attribute current_day_pnl
+      #   Current day profit and loss for a portfolio, calculated from the most recent
+      #   available balance.
+      #
+      #   @return [Privy::Models::KrakenEmbedCurrentDayPnl, nil]
+      optional :current_day_pnl, -> { Privy::KrakenEmbedCurrentDayPnl }, nil?: true
+
+      # @!attribute lots_upnl
+      #
+      #   @return [String, nil]
+      optional :lots_upnl, String, nil?: true
+
+      # @!method initialize(available_balance:, currency:, open_orders:, portfolio_value:, timestamp:, withheld_value:, cost_basis: nil, current_day_pnl: nil, lots_upnl: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Privy::Models::KrakenEmbedPortfolioSummaryPayload} for more details.
+      #
+      #   Portfolio summary payload containing balances, value, and profit/loss
+      #   information.
+      #
+      #   @param available_balance [String]
+      #
+      #   @param currency [String]
+      #
+      #   @param open_orders [String]
+      #
+      #   @param portfolio_value [String]
+      #
+      #   @param timestamp [Time]
+      #
+      #   @param withheld_value [String]
+      #
+      #   @param cost_basis [String, nil]
+      #
+      #   @param current_day_pnl [Privy::Models::KrakenEmbedCurrentDayPnl, nil] Current day profit and loss for a portfolio, calculated from the most recent ava
+      #
+      #   @param lots_upnl [String, nil]
+    end
+  end
+end

data/lib/privy/models/kraken_embed_portfolio_transaction_ref_id.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    class KrakenEmbedPortfolioTransactionRefID < Privy::Internal::Type::BaseModel
+      # @!attribute ref_id
+      #
+      #   @return [String]
+      required :ref_id, String
+
+      # @!attribute type
+      #   The type of reference ID used to filter portfolio transactions by quote or
+      #   failed quote references.
+      #
+      #   @return [Symbol, Privy::Models::KrakenEmbedPortfolioTransactionRefIDType]
+      required :type, enum: -> { Privy::KrakenEmbedPortfolioTransactionRefIDType }
+
+      # @!method initialize(ref_id:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Privy::Models::KrakenEmbedPortfolioTransactionRefID} for more details.
+      #
+      #   A reference ID filter for portfolio transaction queries, identifying a
+      #   transaction by type and reference identifier.
+      #
+      #   @param ref_id [String]
+      #
+      #   @param type [Symbol, Privy::Models::KrakenEmbedPortfolioTransactionRefIDType] The type of reference ID used to filter portfolio transactions by quote or faile
+    end
+  end
+end

data/lib/privy/models/kraken_embed_portfolio_transaction_ref_id_type.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    # The type of reference ID used to filter portfolio transactions by quote or
+    # failed quote references.
+    module KrakenEmbedPortfolioTransactionRefIDType
+      extend Privy::Internal::Type::Enum
+
+      SIMPLE_ORDER_QUOTE = :simple_order_quote
+      SIMPLE_ORDER_QUOTE_FAILED = :simple_order_quote_failed
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/privy/models/kraken_embed_quote_type.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    # Whether the quote amount refers to the asset being received or spent.
+    module KrakenEmbedQuoteType
+      extend Privy::Internal::Type::Enum
+
+      RECEIVE = :receive
+      SPEND = :spend
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/privy/models/kraken_embed_residence.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    class KrakenEmbedResidence < Privy::Internal::Type::BaseModel
+      # @!attribute city
+      #
+      #   @return [String]
+      required :city, String
+
+      # @!attribute country
+      #   ISO 3166-1 alpha-2 country codes supported by Kraken Embed.
+      #
+      #   @return [Symbol, Privy::Models::KrakenEmbedCountryCode]
+      required :country, enum: -> { Privy::KrakenEmbedCountryCode }
+
+      # @!attribute line1
+      #
+      #   @return [String]
+      required :line1, String
+
+      # @!attribute postal_code
+      #
+      #   @return [String]
+      required :postal_code, String
+
+      # @!attribute line2
+      #
+      #   @return [String, nil]
+      optional :line2, String, nil?: true
+
+      # @!attribute province
+      #
+      #   @return [String, nil]
+      optional :province, String, nil?: true
+
+      # @!method initialize(city:, country:, line1:, postal_code:, line2: nil, province: nil)
+      #   User's residential address including street, city, postal code, and country.
+      #
+      #   @param city [String]
+      #
+      #   @param country [Symbol, Privy::Models::KrakenEmbedCountryCode] ISO 3166-1 alpha-2 country codes supported by Kraken Embed.
+      #
+      #   @param line1 [String]
+      #
+      #   @param postal_code [String]
+      #
+      #   @param line2 [String, nil]
+      #
+      #   @param province [String, nil]
+    end
+  end
+end

data/lib/privy/models/kraken_embed_residence_document_type.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    # Document types accepted for proof of address verification.
+    module KrakenEmbedResidenceDocumentType
+      extend Privy::Internal::Type::Enum
+
+      BANK_STATEMENT = :bank_statement
+      CREDIT_CARD_STATEMENT = :credit_card_statement
+      EMPLOYER_LETTER_OR_WORK_CONTRACT = :employer_letter_or_work_contract
+      GOVERNMENT_ISSUED_DOCUMENT = :government_issued_document
+      HOME_OR_RENTAL_INSURANCE = :home_or_rental_insurance
+      INTERNET_OR_CABLE_BILL = :internet_or_cable_bill
+      MOBILE_PHONE_BILL = :mobile_phone_bill
+      MORTGAGE_STATEMENT = :mortgage_statement
+      OFFICIAL_GOVERNMENT_LETTER = :official_government_letter
+      PASSPORT_ADDRESS_PAGE = :passport_address_page
+      RENTAL_OR_LEASE_AGREEMENT = :rental_or_lease_agreement
+      RESIDENCE_CERTIFICATE = :residence_certificate
+      SOCIAL_INSURANCE_PAYMENT_RECEIPT = :social_insurance_payment_receipt
+      TAX_RECEIPT = :tax_receipt
+      TAX_RETURN = :tax_return
+      UTILITY_BILL = :utility_bill
+      OTHER = :other
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/privy/models/kraken_embed_sorting_order.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    # Sort direction for paginated transaction lists.
+    module KrakenEmbedSortingOrder
+      extend Privy::Internal::Type::Enum
+
+      DESCENDING = :descending
+      ASCENDING = :ascending
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/privy/models/kraken_embed_start_address_metadata.rb

@@ -4,9 +4,10 @@ module Privy
   module Models
     class KrakenEmbedStartAddressMetadata < Privy::Internal::Type::BaseModel
       # @!attribute address
+      #   User's residential address including street, city, postal code, and country.
       #
-      #   @return [Privy::Models::KrakenEmbedStartAddressMetadata::Address, nil]
-      optional :address, -> { Privy::KrakenEmbedStartAddressMetadata::Address }, nil?: true
+      #   @return [Privy::Models::KrakenEmbedResidence, nil]
+      optional :address, -> { Privy::KrakenEmbedResidence }, nil?: true
 
       # @!attribute document_number
       #
@@ -14,9 +15,10 @@ module Privy
       optional :document_number, String, nil?: true
 
       # @!attribute document_type
+      #   Document types accepted for proof of address verification.
       #
-      #   @return [Symbol, Privy::Models::KrakenEmbedStartAddressMetadata::DocumentType, nil]
-      optional :document_type, enum: -> { Privy::KrakenEmbedStartAddressMetadata::DocumentType }, nil?: true
+      #   @return [Symbol, Privy::Models::KrakenEmbedResidenceDocumentType, nil]
+      optional :document_type, enum: -> { Privy::KrakenEmbedResidenceDocumentType }, nil?: true
 
       # @!attribute expiration_date
       #
@@ -26,348 +28,13 @@ module Privy
       # @!method initialize(address: nil, document_number: nil, document_type: nil, expiration_date: nil)
       #   Optional best-effort metadata hints for proof of address verification.
       #
-      #   @param address [Privy::Models::KrakenEmbedStartAddressMetadata::Address, nil]
+      #   @param address [Privy::Models::KrakenEmbedResidence, nil] User's residential address including street, city, postal code, and country.
+      #
       #   @param document_number [String, nil]
-      #   @param document_type [Symbol, Privy::Models::KrakenEmbedStartAddressMetadata::DocumentType, nil]
+      #
+      #   @param document_type [Symbol, Privy::Models::KrakenEmbedResidenceDocumentType, nil] Document types accepted for proof of address verification.
+      #
       #   @param expiration_date [Date, nil]
-
-      # @see Privy::Models::KrakenEmbedStartAddressMetadata#address
-      class Address < Privy::Internal::Type::BaseModel
-        # @!attribute city
-        #
-        #   @return [String]
-        required :city, String
-
-        # @!attribute country
-        #
-        #   @return [Symbol, Privy::Models::KrakenEmbedStartAddressMetadata::Address::Country]
-        required :country, enum: -> { Privy::KrakenEmbedStartAddressMetadata::Address::Country }
-
-        # @!attribute line1
-        #
-        #   @return [String]
-        required :line1, String
-
-        # @!attribute postal_code
-        #
-        #   @return [String]
-        required :postal_code, String
-
-        # @!attribute line2
-        #
-        #   @return [String, nil]
-        optional :line2, String, nil?: true
-
-        # @!attribute province
-        #
-        #   @return [String, nil]
-        optional :province, String, nil?: true
-
-        # @!method initialize(city:, country:, line1:, postal_code:, line2: nil, province: nil)
-        #   @param city [String]
-        #   @param country [Symbol, Privy::Models::KrakenEmbedStartAddressMetadata::Address::Country]
-        #   @param line1 [String]
-        #   @param postal_code [String]
-        #   @param line2 [String, nil]
-        #   @param province [String, nil]
-
-        # @see Privy::Models::KrakenEmbedStartAddressMetadata::Address#country
-        module Country
-          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
-          COUNTRY_0_C = :"0C"
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-
-      # @see Privy::Models::KrakenEmbedStartAddressMetadata#document_type
-      module DocumentType
-        extend Privy::Internal::Type::Enum
-
-        BANK_STATEMENT = :bank_statement
-        CREDIT_CARD_STATEMENT = :credit_card_statement
-        EMPLOYER_LETTER_OR_WORK_CONTRACT = :employer_letter_or_work_contract
-        GOVERNMENT_ISSUED_DOCUMENT = :government_issued_document
-        HOME_OR_RENTAL_INSURANCE = :home_or_rental_insurance
-        INTERNET_OR_CABLE_BILL = :internet_or_cable_bill
-        MOBILE_PHONE_BILL = :mobile_phone_bill
-        MORTGAGE_STATEMENT = :mortgage_statement
-        OFFICIAL_GOVERNMENT_LETTER = :official_government_letter
-        PASSPORT_ADDRESS_PAGE = :passport_address_page
-        RENTAL_OR_LEASE_AGREEMENT = :rental_or_lease_agreement
-        RESIDENCE_CERTIFICATE = :residence_certificate
-        SOCIAL_INSURANCE_PAYMENT_RECEIPT = :social_insurance_payment_receipt
-        TAX_RECEIPT = :tax_receipt
-        TAX_RETURN = :tax_return
-        UTILITY_BILL = :utility_bill
-        OTHER = :other
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
     end
   end
 end