prelude-sdk 0.1.0.pre.alpha.2

data/lib/prelude_sdk/internal.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Internal
+    extend PreludeSDK::Internal::Util::SorbetRuntimeSupport
+
+    OMIT =
+      Object.new.tap do
+        _1.define_singleton_method(:inspect) { "#<#{PreludeSDK::Internal}::OMIT>" }
+      end
+        .freeze
+
+    define_sorbet_constant!(:AnyHash) do
+      T.type_alias { T::Hash[Symbol, T.anything] }
+    end
+    define_sorbet_constant!(:FileInput) do
+      T.type_alias { T.any(Pathname, StringIO, IO, String, PreludeSDK::FilePart) }
+    end
+  end
+end

data/lib/prelude_sdk/models/lookup_lookup_params.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Models
+    # @see PreludeSDK::Resources::Lookup#lookup
+    class LookupLookupParams < PreludeSDK::Internal::Type::BaseModel
+      extend PreludeSDK::Internal::Type::RequestParameters::Converter
+      include PreludeSDK::Internal::Type::RequestParameters
+
+      # @!attribute type
+      #   Optional features. Possible values are:
+      #
+      #   - `cnam` - Retrieve CNAM (Caller ID Name) along with other information. Contact
+      #     us if you need to use this functionality.
+      #
+      #   @return [Array<Symbol, PreludeSDK::Models::LookupLookupParams::Type>, nil]
+      optional :type, -> { PreludeSDK::Internal::Type::ArrayOf[enum: PreludeSDK::LookupLookupParams::Type] }
+
+      # @!method initialize(type: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {PreludeSDK::Models::LookupLookupParams} for more details.
+      #
+      #   @param type [Array<Symbol, PreludeSDK::Models::LookupLookupParams::Type>] Optional features. Possible values are:
+      #
+      #   @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}]
+
+      module Type
+        extend PreludeSDK::Internal::Type::Enum
+
+        CNAM = :cnam
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/prelude_sdk/models/lookup_lookup_response.rb

@@ -0,0 +1,236 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Models
+    # @see PreludeSDK::Resources::Lookup#lookup
+    class LookupLookupResponse < PreludeSDK::Internal::Type::BaseModel
+      # @!attribute caller_name
+      #   The CNAM (Caller ID Name) associated with the phone number. Contact us if you
+      #   need to use this functionality. Once enabled, put `cnam` option to `type` query
+      #   parameter.
+      #
+      #   @return [String, nil]
+      optional :caller_name, String
+
+      # @!attribute country_code
+      #   The country code of the phone number.
+      #
+      #   @return [String, nil]
+      optional :country_code, String
+
+      # @!attribute flags
+      #   A list of flags associated with the phone number.
+      #
+      #   - `ported` - Indicates the phone number has been transferred from one carrier to
+      #     another.
+      #   - `temporary` - Indicates the phone number is likely a temporary or virtual
+      #     number, often used for verification services or burner phones.
+      #
+      #   @return [Array<Symbol, PreludeSDK::Models::LookupLookupResponse::Flag>, nil]
+      optional :flags,
+               -> { PreludeSDK::Internal::Type::ArrayOf[enum: PreludeSDK::Models::LookupLookupResponse::Flag] }
+
+      # @!attribute line_type
+      #   The type of phone line.
+      #
+      #   - `calling_cards` - Numbers that are associated with providers of pre-paid
+      #     domestic and international calling cards.
+      #   - `fixed_line` - Landline phone numbers.
+      #   - `isp` - Numbers reserved for Internet Service Providers.
+      #   - `local_rate` - Numbers that can be assigned non-geographically.
+      #   - `mobile` - Mobile phone numbers.
+      #   - `other` - Other types of services.
+      #   - `pager` - Number ranges specifically allocated to paging devices.
+      #   - `payphone` - Allocated numbers for payphone kiosks in some countries.
+      #   - `premium_rate` - Landline numbers where the calling party pays more than
+      #     standard.
+      #   - `satellite` - Satellite phone numbers.
+      #   - `service` - Automated applications.
+      #   - `shared_cost` - Specific landline ranges where the cost of making the call is
+      #     shared between the calling and called party.
+      #   - `short_codes_commercial` - Short codes are memorable, easy-to-use numbers,
+      #     like the UK's NHS 111, often sold to businesses. Not available in all
+      #     countries.
+      #   - `toll_free` - Number where the called party pays for the cost of the call not
+      #     the calling party.
+      #   - `universal_access` - Number ranges reserved for Universal Access initiatives.
+      #   - `unknown` - Unknown phone number type.
+      #   - `vpn` - Numbers are used exclusively within a private telecommunications
+      #     network, connecting the operator's terminals internally and not accessible via
+      #     the public telephone network.
+      #   - `voice_mail` - A specific category of Interactive Voice Response (IVR)
+      #     services.
+      #   - `voip` - Specific ranges for providers of VoIP services to allow incoming
+      #     calls from the regular telephony network.
+      #
+      #   @return [Symbol, PreludeSDK::Models::LookupLookupResponse::LineType, nil]
+      optional :line_type, enum: -> { PreludeSDK::Models::LookupLookupResponse::LineType }
+
+      # @!attribute network_info
+      #   The current carrier information.
+      #
+      #   @return [PreludeSDK::Models::LookupLookupResponse::NetworkInfo, nil]
+      optional :network_info, -> { PreludeSDK::Models::LookupLookupResponse::NetworkInfo }
+
+      # @!attribute original_network_info
+      #   The original carrier information.
+      #
+      #   @return [PreludeSDK::Models::LookupLookupResponse::OriginalNetworkInfo, nil]
+      optional :original_network_info, -> { PreludeSDK::Models::LookupLookupResponse::OriginalNetworkInfo }
+
+      # @!attribute phone_number
+      #   The phone number.
+      #
+      #   @return [String, nil]
+      optional :phone_number, String
+
+      # @!method initialize(caller_name: nil, country_code: nil, flags: nil, line_type: nil, network_info: nil, original_network_info: nil, phone_number: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {PreludeSDK::Models::LookupLookupResponse} for more details.
+      #
+      #   @param caller_name [String] The CNAM (Caller ID Name) associated with the phone number. Contact us if you ne
+      #
+      #   @param country_code [String] The country code of the phone number.
+      #
+      #   @param flags [Array<Symbol, PreludeSDK::Models::LookupLookupResponse::Flag>] A list of flags associated with the phone number.
+      #
+      #   @param line_type [Symbol, PreludeSDK::Models::LookupLookupResponse::LineType] The type of phone line.
+      #
+      #   @param network_info [PreludeSDK::Models::LookupLookupResponse::NetworkInfo] The current carrier information.
+      #
+      #   @param original_network_info [PreludeSDK::Models::LookupLookupResponse::OriginalNetworkInfo] The original carrier information.
+      #
+      #   @param phone_number [String] The phone number.
+
+      module Flag
+        extend PreludeSDK::Internal::Type::Enum
+
+        PORTED = :ported
+        TEMPORARY = :temporary
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The type of phone line.
+      #
+      # - `calling_cards` - Numbers that are associated with providers of pre-paid
+      #   domestic and international calling cards.
+      # - `fixed_line` - Landline phone numbers.
+      # - `isp` - Numbers reserved for Internet Service Providers.
+      # - `local_rate` - Numbers that can be assigned non-geographically.
+      # - `mobile` - Mobile phone numbers.
+      # - `other` - Other types of services.
+      # - `pager` - Number ranges specifically allocated to paging devices.
+      # - `payphone` - Allocated numbers for payphone kiosks in some countries.
+      # - `premium_rate` - Landline numbers where the calling party pays more than
+      #   standard.
+      # - `satellite` - Satellite phone numbers.
+      # - `service` - Automated applications.
+      # - `shared_cost` - Specific landline ranges where the cost of making the call is
+      #   shared between the calling and called party.
+      # - `short_codes_commercial` - Short codes are memorable, easy-to-use numbers,
+      #   like the UK's NHS 111, often sold to businesses. Not available in all
+      #   countries.
+      # - `toll_free` - Number where the called party pays for the cost of the call not
+      #   the calling party.
+      # - `universal_access` - Number ranges reserved for Universal Access initiatives.
+      # - `unknown` - Unknown phone number type.
+      # - `vpn` - Numbers are used exclusively within a private telecommunications
+      #   network, connecting the operator's terminals internally and not accessible via
+      #   the public telephone network.
+      # - `voice_mail` - A specific category of Interactive Voice Response (IVR)
+      #   services.
+      # - `voip` - Specific ranges for providers of VoIP services to allow incoming
+      #   calls from the regular telephony network.
+      #
+      # @see PreludeSDK::Models::LookupLookupResponse#line_type
+      module LineType
+        extend PreludeSDK::Internal::Type::Enum
+
+        CALLING_CARDS = :calling_cards
+        FIXED_LINE = :fixed_line
+        ISP = :isp
+        LOCAL_RATE = :local_rate
+        MOBILE = :mobile
+        OTHER = :other
+        PAGER = :pager
+        PAYPHONE = :payphone
+        PREMIUM_RATE = :premium_rate
+        SATELLITE = :satellite
+        SERVICE = :service
+        SHARED_COST = :shared_cost
+        SHORT_CODES_COMMERCIAL = :short_codes_commercial
+        TOLL_FREE = :toll_free
+        UNIVERSAL_ACCESS = :universal_access
+        UNKNOWN = :unknown
+        VPN = :vpn
+        VOICE_MAIL = :voice_mail
+        VOIP = :voip
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see PreludeSDK::Models::LookupLookupResponse#network_info
+      class NetworkInfo < PreludeSDK::Internal::Type::BaseModel
+        # @!attribute carrier_name
+        #   The name of the carrier.
+        #
+        #   @return [String, nil]
+        optional :carrier_name, String
+
+        # @!attribute mcc
+        #   Mobile Country Code.
+        #
+        #   @return [String, nil]
+        optional :mcc, String
+
+        # @!attribute mnc
+        #   Mobile Network Code.
+        #
+        #   @return [String, nil]
+        optional :mnc, String
+
+        # @!method initialize(carrier_name: nil, mcc: nil, mnc: nil)
+        #   The current carrier information.
+        #
+        #   @param carrier_name [String] The name of the carrier.
+        #
+        #   @param mcc [String] Mobile Country Code.
+        #
+        #   @param mnc [String] Mobile Network Code.
+      end
+
+      # @see PreludeSDK::Models::LookupLookupResponse#original_network_info
+      class OriginalNetworkInfo < PreludeSDK::Internal::Type::BaseModel
+        # @!attribute carrier_name
+        #   The name of the original carrier.
+        #
+        #   @return [String, nil]
+        optional :carrier_name, String
+
+        # @!attribute mcc
+        #   Mobile Country Code.
+        #
+        #   @return [String, nil]
+        optional :mcc, String
+
+        # @!attribute mnc
+        #   Mobile Network Code.
+        #
+        #   @return [String, nil]
+        optional :mnc, String
+
+        # @!method initialize(carrier_name: nil, mcc: nil, mnc: nil)
+        #   The original carrier information.
+        #
+        #   @param carrier_name [String] The name of the original carrier.
+        #
+        #   @param mcc [String] Mobile Country Code.
+        #
+        #   @param mnc [String] Mobile Network Code.
+      end
+    end
+  end
+end

data/lib/prelude_sdk/models/transactional_send_params.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Models
+    # @see PreludeSDK::Resources::Transactional#send_
+    class TransactionalSendParams < PreludeSDK::Internal::Type::BaseModel
+      extend PreludeSDK::Internal::Type::RequestParameters::Converter
+      include PreludeSDK::Internal::Type::RequestParameters
+
+      # @!attribute template_id
+      #   The template identifier.
+      #
+      #   @return [String]
+      required :template_id, String
+
+      # @!attribute to
+      #   The recipient's phone number.
+      #
+      #   @return [String]
+      required :to, String
+
+      # @!attribute callback_url
+      #   The callback URL.
+      #
+      #   @return [String, nil]
+      optional :callback_url, String
+
+      # @!attribute correlation_id
+      #   A unique, user-defined identifier that will be included in webhook events.
+      #
+      #   @return [String, nil]
+      optional :correlation_id, String
+
+      # @!attribute expires_at
+      #   The message expiration date.
+      #
+      #   @return [String, nil]
+      optional :expires_at, String
+
+      # @!attribute from
+      #   The Sender ID.
+      #
+      #   @return [String, nil]
+      optional :from, String
+
+      # @!attribute locale
+      #   A BCP-47 formatted locale string with the language the text message will be sent
+      #   to. If there's no locale set, the language will be determined by the country
+      #   code of the phone number. If the language specified doesn't exist, the default
+      #   set on the template will be used.
+      #
+      #   @return [String, nil]
+      optional :locale, String
+
+      # @!attribute variables
+      #   The variables to be replaced in the template.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :variables, PreludeSDK::Internal::Type::HashOf[String]
+
+      # @!method initialize(template_id:, to:, callback_url: nil, correlation_id: nil, expires_at: nil, from: nil, locale: nil, variables: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {PreludeSDK::Models::TransactionalSendParams} for more details.
+      #
+      #   @param template_id [String] The template identifier.
+      #
+      #   @param to [String] The recipient's phone number.
+      #
+      #   @param callback_url [String] The callback URL.
+      #
+      #   @param correlation_id [String] A unique, user-defined identifier that will be included in webhook events.
+      #
+      #   @param expires_at [String] The message expiration date.
+      #
+      #   @param from [String] The Sender ID.
+      #
+      #   @param locale [String] A BCP-47 formatted locale string with the language the text message will be sent
+      #
+      #   @param variables [Hash{Symbol=>String}] The variables to be replaced in the template.
+      #
+      #   @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/prelude_sdk/models/transactional_send_response.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Models
+    # @see PreludeSDK::Resources::Transactional#send_
+    class TransactionalSendResponse < PreludeSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The message identifier.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   The message creation date.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute expires_at
+      #   The message expiration date.
+      #
+      #   @return [Time]
+      required :expires_at, Time
+
+      # @!attribute template_id
+      #   The template identifier.
+      #
+      #   @return [String]
+      required :template_id, String
+
+      # @!attribute to
+      #   The recipient's phone number.
+      #
+      #   @return [String]
+      required :to, String
+
+      # @!attribute variables
+      #   The variables to be replaced in the template.
+      #
+      #   @return [Hash{Symbol=>String}]
+      required :variables, PreludeSDK::Internal::Type::HashOf[String]
+
+      # @!attribute callback_url
+      #   The callback URL.
+      #
+      #   @return [String, nil]
+      optional :callback_url, String
+
+      # @!attribute correlation_id
+      #   A unique, user-defined identifier that will be included in webhook events.
+      #
+      #   @return [String, nil]
+      optional :correlation_id, String
+
+      # @!attribute from
+      #   The Sender ID.
+      #
+      #   @return [String, nil]
+      optional :from, String
+
+      # @!method initialize(id:, created_at:, expires_at:, template_id:, to:, variables:, callback_url: nil, correlation_id: nil, from: nil)
+      #   @param id [String] The message identifier.
+      #
+      #   @param created_at [Time] The message creation date.
+      #
+      #   @param expires_at [Time] The message expiration date.
+      #
+      #   @param template_id [String] The template identifier.
+      #
+      #   @param to [String] The recipient's phone number.
+      #
+      #   @param variables [Hash{Symbol=>String}] The variables to be replaced in the template.
+      #
+      #   @param callback_url [String] The callback URL.
+      #
+      #   @param correlation_id [String] A unique, user-defined identifier that will be included in webhook events.
+      #
+      #   @param from [String] The Sender ID.
+    end
+  end
+end

data/lib/prelude_sdk/models/verification_check_params.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Models
+    # @see PreludeSDK::Resources::Verification#check
+    class VerificationCheckParams < PreludeSDK::Internal::Type::BaseModel
+      extend PreludeSDK::Internal::Type::RequestParameters::Converter
+      include PreludeSDK::Internal::Type::RequestParameters
+
+      # @!attribute code
+      #   The OTP code to validate.
+      #
+      #   @return [String]
+      required :code, String
+
+      # @!attribute target
+      #   The verification target. Either a phone number or an email address. To use the
+      #   email verification feature contact us to discuss your use case.
+      #
+      #   @return [PreludeSDK::Models::VerificationCheckParams::Target]
+      required :target, -> { PreludeSDK::VerificationCheckParams::Target }
+
+      # @!method initialize(code:, target:, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {PreludeSDK::Models::VerificationCheckParams} for more details.
+      #
+      #   @param code [String] The OTP code to validate.
+      #
+      #   @param target [PreludeSDK::Models::VerificationCheckParams::Target] The verification target. Either a phone number or an email address. To use the e
+      #
+      #   @param request_options [PreludeSDK::RequestOptions, Hash{Symbol=>Object}]
+
+      class Target < PreludeSDK::Internal::Type::BaseModel
+        # @!attribute type
+        #   The type of the target. Either "phone_number" or "email_address".
+        #
+        #   @return [Symbol, PreludeSDK::Models::VerificationCheckParams::Target::Type]
+        required :type, enum: -> { PreludeSDK::VerificationCheckParams::Target::Type }
+
+        # @!attribute value
+        #   An E.164 formatted phone number or an email address.
+        #
+        #   @return [String]
+        required :value, String
+
+        # @!method initialize(type:, value:)
+        #   The verification target. Either a phone number or an email address. To use the
+        #   email verification feature contact us to discuss your use case.
+        #
+        #   @param type [Symbol, PreludeSDK::Models::VerificationCheckParams::Target::Type] The type of the target. Either "phone_number" or "email_address".
+        #
+        #   @param value [String] An E.164 formatted phone number or an email address.
+
+        # The type of the target. Either "phone_number" or "email_address".
+        #
+        # @see PreludeSDK::Models::VerificationCheckParams::Target#type
+        module Type
+          extend PreludeSDK::Internal::Type::Enum
+
+          PHONE_NUMBER = :phone_number
+          EMAIL_ADDRESS = :email_address
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/prelude_sdk/models/verification_check_response.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module PreludeSDK
+  module Models
+    # @see PreludeSDK::Resources::Verification#check
+    class VerificationCheckResponse < PreludeSDK::Internal::Type::BaseModel
+      # @!attribute status
+      #   The status of the check.
+      #
+      #   @return [Symbol, PreludeSDK::Models::VerificationCheckResponse::Status]
+      required :status, enum: -> { PreludeSDK::Models::VerificationCheckResponse::Status }
+
+      # @!attribute id
+      #   The verification identifier.
+      #
+      #   @return [String, nil]
+      optional :id, String
+
+      # @!attribute metadata
+      #   The metadata for this verification.
+      #
+      #   @return [PreludeSDK::Models::VerificationCheckResponse::Metadata, nil]
+      optional :metadata, -> { PreludeSDK::Models::VerificationCheckResponse::Metadata }
+
+      # @!attribute request_id
+      #
+      #   @return [String, nil]
+      optional :request_id, String
+
+      # @!method initialize(status:, id: nil, metadata: nil, request_id: nil)
+      #   @param status [Symbol, PreludeSDK::Models::VerificationCheckResponse::Status] The status of the check.
+      #
+      #   @param id [String] The verification identifier.
+      #
+      #   @param metadata [PreludeSDK::Models::VerificationCheckResponse::Metadata] The metadata for this verification.
+      #
+      #   @param request_id [String]
+
+      # The status of the check.
+      #
+      # @see PreludeSDK::Models::VerificationCheckResponse#status
+      module Status
+        extend PreludeSDK::Internal::Type::Enum
+
+        SUCCESS = :success
+        FAILURE = :failure
+        EXPIRED_OR_NOT_FOUND = :expired_or_not_found
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see PreludeSDK::Models::VerificationCheckResponse#metadata
+      class Metadata < PreludeSDK::Internal::Type::BaseModel
+        # @!attribute correlation_id
+        #
+        #   @return [String, nil]
+        optional :correlation_id, String
+
+        # @!method initialize(correlation_id: nil)
+        #   The metadata for this verification.
+        #
+        #   @param correlation_id [String]
+      end
+    end
+  end
+end