surge_api 0.1.0

data/sig/surge_api/models/account_create_params.rbs

@@ -0,0 +1,433 @@
+module SurgeAPI
+  module Models
+    type account_create_params =
+      {
+        name: String,
+        brand_name: String?,
+        organization: SurgeAPI::AccountCreateParams::Organization,
+        time_zone: String
+      }
+      & SurgeAPI::Internal::Type::request_parameters
+
+    class AccountCreateParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      attr_accessor name: String
+
+      attr_accessor brand_name: String?
+
+      attr_reader organization: SurgeAPI::AccountCreateParams::Organization?
+
+      def organization=: (
+        SurgeAPI::AccountCreateParams::Organization
+      ) -> SurgeAPI::AccountCreateParams::Organization
+
+      attr_reader time_zone: String?
+
+      def time_zone=: (String) -> String
+
+      def initialize: (
+        name: String,
+        ?brand_name: String?,
+        ?organization: SurgeAPI::AccountCreateParams::Organization,
+        ?time_zone: String,
+        ?request_options: SurgeAPI::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        name: String,
+        brand_name: String?,
+        organization: SurgeAPI::AccountCreateParams::Organization,
+        time_zone: String,
+        request_options: SurgeAPI::RequestOptions
+      }
+
+      type organization =
+        {
+          address: SurgeAPI::AccountCreateParams::Organization::Address,
+          contact: SurgeAPI::AccountCreateParams::Organization::Contact?,
+          country: String?,
+          email: String?,
+          identifier: String?,
+          identifier_type: SurgeAPI::Models::AccountCreateParams::Organization::identifier_type?,
+          industry: SurgeAPI::Models::AccountCreateParams::Organization::industry?,
+          mobile_number: String?,
+          regions_of_operation: ::Array[SurgeAPI::Models::AccountCreateParams::Organization::regions_of_operation]?,
+          registered_name: String?,
+          stock_exchange: SurgeAPI::Models::AccountCreateParams::Organization::stock_exchange?,
+          stock_symbol: String?,
+          type: SurgeAPI::Models::AccountCreateParams::Organization::type_?,
+          website: String?
+        }
+
+      class Organization < SurgeAPI::Internal::Type::BaseModel
+        attr_reader address: SurgeAPI::AccountCreateParams::Organization::Address?
+
+        def address=: (
+          SurgeAPI::AccountCreateParams::Organization::Address
+        ) -> SurgeAPI::AccountCreateParams::Organization::Address
+
+        attr_accessor contact: SurgeAPI::AccountCreateParams::Organization::Contact?
+
+        attr_accessor country: String?
+
+        attr_accessor email: String?
+
+        attr_accessor identifier: String?
+
+        attr_accessor identifier_type: SurgeAPI::Models::AccountCreateParams::Organization::identifier_type?
+
+        attr_accessor industry: SurgeAPI::Models::AccountCreateParams::Organization::industry?
+
+        attr_accessor mobile_number: String?
+
+        attr_accessor regions_of_operation: ::Array[SurgeAPI::Models::AccountCreateParams::Organization::regions_of_operation]?
+
+        attr_accessor registered_name: String?
+
+        attr_accessor stock_exchange: SurgeAPI::Models::AccountCreateParams::Organization::stock_exchange?
+
+        attr_accessor stock_symbol: String?
+
+        attr_accessor type: SurgeAPI::Models::AccountCreateParams::Organization::type_?
+
+        attr_accessor website: String?
+
+        def initialize: (
+          ?address: SurgeAPI::AccountCreateParams::Organization::Address,
+          ?contact: SurgeAPI::AccountCreateParams::Organization::Contact?,
+          ?country: String?,
+          ?email: String?,
+          ?identifier: String?,
+          ?identifier_type: SurgeAPI::Models::AccountCreateParams::Organization::identifier_type?,
+          ?industry: SurgeAPI::Models::AccountCreateParams::Organization::industry?,
+          ?mobile_number: String?,
+          ?regions_of_operation: ::Array[SurgeAPI::Models::AccountCreateParams::Organization::regions_of_operation]?,
+          ?registered_name: String?,
+          ?stock_exchange: SurgeAPI::Models::AccountCreateParams::Organization::stock_exchange?,
+          ?stock_symbol: String?,
+          ?type: SurgeAPI::Models::AccountCreateParams::Organization::type_?,
+          ?website: String?
+        ) -> void
+
+        def to_hash: -> {
+          address: SurgeAPI::AccountCreateParams::Organization::Address,
+          contact: SurgeAPI::AccountCreateParams::Organization::Contact?,
+          country: String?,
+          email: String?,
+          identifier: String?,
+          identifier_type: SurgeAPI::Models::AccountCreateParams::Organization::identifier_type?,
+          industry: SurgeAPI::Models::AccountCreateParams::Organization::industry?,
+          mobile_number: String?,
+          regions_of_operation: ::Array[SurgeAPI::Models::AccountCreateParams::Organization::regions_of_operation]?,
+          registered_name: String?,
+          stock_exchange: SurgeAPI::Models::AccountCreateParams::Organization::stock_exchange?,
+          stock_symbol: String?,
+          type: SurgeAPI::Models::AccountCreateParams::Organization::type_?,
+          website: String?
+        }
+
+        type address =
+          {
+            country: String?,
+            :line1 => String?,
+            :line2 => String?,
+            locality: String?,
+            name: String?,
+            postal_code: String?,
+            region: String?
+          }
+
+        class Address < SurgeAPI::Internal::Type::BaseModel
+          attr_accessor country: String?
+
+          attr_accessor line1: String?
+
+          attr_accessor line2: String?
+
+          attr_accessor locality: String?
+
+          attr_accessor name: String?
+
+          attr_accessor postal_code: String?
+
+          attr_accessor region: String?
+
+          def initialize: (
+            ?country: String?,
+            ?line1: String?,
+            ?line2: String?,
+            ?locality: String?,
+            ?name: String?,
+            ?postal_code: String?,
+            ?region: String?
+          ) -> void
+
+          def to_hash: -> {
+            country: String?,
+            :line1 => String?,
+            :line2 => String?,
+            locality: String?,
+            name: String?,
+            postal_code: String?,
+            region: String?
+          }
+        end
+
+        type contact =
+          {
+            email: String?,
+            first_name: String?,
+            last_name: String?,
+            phone_number: String?,
+            title: SurgeAPI::Models::AccountCreateParams::Organization::Contact::title?,
+            title_other: String?
+          }
+
+        class Contact < SurgeAPI::Internal::Type::BaseModel
+          attr_accessor email: String?
+
+          attr_accessor first_name: String?
+
+          attr_accessor last_name: String?
+
+          attr_accessor phone_number: String?
+
+          attr_accessor title: SurgeAPI::Models::AccountCreateParams::Organization::Contact::title?
+
+          attr_accessor title_other: String?
+
+          def initialize: (
+            ?email: String?,
+            ?first_name: String?,
+            ?last_name: String?,
+            ?phone_number: String?,
+            ?title: SurgeAPI::Models::AccountCreateParams::Organization::Contact::title?,
+            ?title_other: String?
+          ) -> void
+
+          def to_hash: -> {
+            email: String?,
+            first_name: String?,
+            last_name: String?,
+            phone_number: String?,
+            title: SurgeAPI::Models::AccountCreateParams::Organization::Contact::title?,
+            title_other: String?
+          }
+
+          type title =
+            :ceo | :cfo | :director | :gm | :vp | :general_counsel | :other
+
+          module Title
+            extend SurgeAPI::Internal::Type::Enum
+
+            CEO: :ceo
+            CFO: :cfo
+            DIRECTOR: :director
+            GM: :gm
+            VP: :vp
+            GENERAL_COUNSEL: :general_counsel
+            OTHER: :other
+
+            def self?.values: -> ::Array[SurgeAPI::Models::AccountCreateParams::Organization::Contact::title]
+          end
+        end
+
+        type identifier_type = :ein
+
+        module IdentifierType
+          extend SurgeAPI::Internal::Type::Enum
+
+          EIN: :ein
+
+          def self?.values: -> ::Array[SurgeAPI::Models::AccountCreateParams::Organization::identifier_type]
+        end
+
+        type industry =
+          :agriculture
+          | :automotive
+          | :banking
+          | :construction
+          | :consumer
+          | :education
+          | :electronics
+          | :energy
+          | :engineering
+          | :fast_moving_consumer_goods
+          | :financial
+          | :fintech
+          | :food_and_beverage
+          | :government
+          | :healthcare
+          | :hospitality
+          | :insurance
+          | :jewelry
+          | :legal
+          | :manufacturing
+          | :media
+          | :not_for_profit
+          | :oil_and_gas
+          | :online
+          | :professional_services
+          | :raw_materials
+          | :real_estate
+          | :religion
+          | :retail
+          | :technology
+          | :telecommunications
+          | :transportation
+          | :travel
+
+        module Industry
+          extend SurgeAPI::Internal::Type::Enum
+
+          AGRICULTURE: :agriculture
+          AUTOMOTIVE: :automotive
+          BANKING: :banking
+          CONSTRUCTION: :construction
+          CONSUMER: :consumer
+          EDUCATION: :education
+          ELECTRONICS: :electronics
+          ENERGY: :energy
+          ENGINEERING: :engineering
+          FAST_MOVING_CONSUMER_GOODS: :fast_moving_consumer_goods
+          FINANCIAL: :financial
+          FINTECH: :fintech
+          FOOD_AND_BEVERAGE: :food_and_beverage
+          GOVERNMENT: :government
+          HEALTHCARE: :healthcare
+          HOSPITALITY: :hospitality
+          INSURANCE: :insurance
+          JEWELRY: :jewelry
+          LEGAL: :legal
+          MANUFACTURING: :manufacturing
+          MEDIA: :media
+          NOT_FOR_PROFIT: :not_for_profit
+          OIL_AND_GAS: :oil_and_gas
+          ONLINE: :online
+          PROFESSIONAL_SERVICES: :professional_services
+          RAW_MATERIALS: :raw_materials
+          REAL_ESTATE: :real_estate
+          RELIGION: :religion
+          RETAIL: :retail
+          TECHNOLOGY: :technology
+          TELECOMMUNICATIONS: :telecommunications
+          TRANSPORTATION: :transportation
+          TRAVEL: :travel
+
+          def self?.values: -> ::Array[SurgeAPI::Models::AccountCreateParams::Organization::industry]
+        end
+
+        type regions_of_operation =
+          :africa
+          | :asia
+          | :australia
+          | :europe
+          | :latin_america
+          | :usa_and_canada
+
+        module RegionsOfOperation
+          extend SurgeAPI::Internal::Type::Enum
+
+          AFRICA: :africa
+          ASIA: :asia
+          AUSTRALIA: :australia
+          EUROPE: :europe
+          LATIN_AMERICA: :latin_america
+          USA_AND_CANADA: :usa_and_canada
+
+          def self?.values: -> ::Array[SurgeAPI::Models::AccountCreateParams::Organization::regions_of_operation]
+        end
+
+        type stock_exchange =
+          :amex
+          | :amx
+          | :asx
+          | :b3
+          | :bme
+          | :bse
+          | :fra
+          | :icex
+          | :jpx
+          | :jse
+          | :krx
+          | :lon
+          | :nasdaq
+          | :none
+          | :nyse
+          | :nse
+          | :omx
+          | :other
+          | :sehk
+          | :sgx
+          | :sse
+          | :sto
+          | :swx
+          | :szse
+          | :tsx
+          | :twse
+          | :vse
+
+        module StockExchange
+          extend SurgeAPI::Internal::Type::Enum
+
+          AMEX: :amex
+          AMX: :amx
+          ASX: :asx
+          B3: :b3
+          BME: :bme
+          BSE: :bse
+          FRA: :fra
+          ICEX: :icex
+          JPX: :jpx
+          JSE: :jse
+          KRX: :krx
+          LON: :lon
+          NASDAQ: :nasdaq
+          NONE: :none
+          NYSE: :nyse
+          NSE: :nse
+          OMX: :omx
+          OTHER: :other
+          SEHK: :sehk
+          SGX: :sgx
+          SSE: :sse
+          STO: :sto
+          SWX: :swx
+          SZSE: :szse
+          TSX: :tsx
+          TWSE: :twse
+          VSE: :vse
+
+          def self?.values: -> ::Array[SurgeAPI::Models::AccountCreateParams::Organization::stock_exchange]
+        end
+
+        type type_ =
+          :co_op
+          | :government
+          | :llc
+          | :non_profit
+          | :partnership
+          | :private_corporation
+          | :public_corporation
+          | :sole_proprietor
+
+        module Type
+          extend SurgeAPI::Internal::Type::Enum
+
+          CO_OP: :co_op
+          GOVERNMENT: :government
+          LLC: :llc
+          NON_PROFIT: :non_profit
+          PARTNERSHIP: :partnership
+          PRIVATE_CORPORATION: :private_corporation
+          PUBLIC_CORPORATION: :public_corporation
+          SOLE_PROPRIETOR: :sole_proprietor
+
+          def self?.values: -> ::Array[SurgeAPI::Models::AccountCreateParams::Organization::type_]
+        end
+      end
+    end
+  end
+end

data/sig/surge_api/models/account_retrieve_status_params.rbs

@@ -0,0 +1,40 @@
+module SurgeAPI
+  module Models
+    type account_retrieve_status_params =
+      {
+        capabilities: ::Array[SurgeAPI::Models::AccountRetrieveStatusParams::capability]
+      }
+      & SurgeAPI::Internal::Type::request_parameters
+
+    class AccountRetrieveStatusParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      attr_reader capabilities: ::Array[SurgeAPI::Models::AccountRetrieveStatusParams::capability]?
+
+      def capabilities=: (
+        ::Array[SurgeAPI::Models::AccountRetrieveStatusParams::capability]
+      ) -> ::Array[SurgeAPI::Models::AccountRetrieveStatusParams::capability]
+
+      def initialize: (
+        ?capabilities: ::Array[SurgeAPI::Models::AccountRetrieveStatusParams::capability],
+        ?request_options: SurgeAPI::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        capabilities: ::Array[SurgeAPI::Models::AccountRetrieveStatusParams::capability],
+        request_options: SurgeAPI::RequestOptions
+      }
+
+      type capability = :local_messaging
+
+      module Capability
+        extend SurgeAPI::Internal::Type::Enum
+
+        LOCAL_MESSAGING: :local_messaging
+
+        def self?.values: -> ::Array[SurgeAPI::Models::AccountRetrieveStatusParams::capability]
+      end
+    end
+  end
+end

data/sig/surge_api/models/account_status.rbs

@@ -0,0 +1,71 @@
+module SurgeAPI
+  module Models
+    type account_status =
+      { capabilities: ::Hash[Symbol, SurgeAPI::AccountStatus::Capability] }
+
+    class AccountStatus < SurgeAPI::Internal::Type::BaseModel
+      attr_accessor capabilities: ::Hash[Symbol, SurgeAPI::AccountStatus::Capability]
+
+      def initialize: (
+        capabilities: ::Hash[Symbol, SurgeAPI::AccountStatus::Capability]
+      ) -> void
+
+      def to_hash: -> {
+        capabilities: ::Hash[Symbol, SurgeAPI::AccountStatus::Capability]
+      }
+
+      type capability =
+        {
+          errors: ::Array[SurgeAPI::AccountStatus::Capability::Error],
+          fields_needed: ::Array[String],
+          status: SurgeAPI::Models::AccountStatus::Capability::status
+        }
+
+      class Capability < SurgeAPI::Internal::Type::BaseModel
+        attr_accessor errors: ::Array[SurgeAPI::AccountStatus::Capability::Error]
+
+        attr_accessor fields_needed: ::Array[String]
+
+        attr_accessor status: SurgeAPI::Models::AccountStatus::Capability::status
+
+        def initialize: (
+          errors: ::Array[SurgeAPI::AccountStatus::Capability::Error],
+          fields_needed: ::Array[String],
+          status: SurgeAPI::Models::AccountStatus::Capability::status
+        ) -> void
+
+        def to_hash: -> {
+          errors: ::Array[SurgeAPI::AccountStatus::Capability::Error],
+          fields_needed: ::Array[String],
+          status: SurgeAPI::Models::AccountStatus::Capability::status
+        }
+
+        type error = { field: String, message: String, type: String }
+
+        class Error < SurgeAPI::Internal::Type::BaseModel
+          attr_accessor field: String
+
+          attr_accessor message: String
+
+          attr_accessor type: String
+
+          def initialize: (field: String, message: String, type: String) -> void
+
+          def to_hash: -> { field: String, message: String, type: String }
+        end
+
+        type status = :error | :incomplete | :ready
+
+        module Status
+          extend SurgeAPI::Internal::Type::Enum
+
+          ERROR: :error
+          INCOMPLETE: :incomplete
+          READY: :ready
+
+          def self?.values: -> ::Array[SurgeAPI::Models::AccountStatus::Capability::status]
+        end
+      end
+    end
+  end
+end