surge_api 0.1.0

data/lib/surge_api/models/user_token_response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    # @see SurgeAPI::Resources::Users#create_token
+    class UserTokenResponse < SurgeAPI::Internal::Type::BaseModel
+      # @!attribute token
+      #   The created token.
+      #
+      #   @return [String, nil]
+      optional :token, String
+
+      # @!method initialize(token: nil)
+      #   Response when token has been created successfully
+      #
+      #   @param token [String] The created token.
+    end
+  end
+end

data/lib/surge_api/models/user_update_params.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    # @see SurgeAPI::Resources::Users#update
+    class UserUpdateParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      # @!attribute first_name
+      #   The user's first name.
+      #
+      #   @return [String]
+      required :first_name, String
+
+      # @!attribute last_name
+      #   The user's last name.
+      #
+      #   @return [String, nil]
+      optional :last_name, String
+
+      # @!attribute metadata
+      #   Set of key-value pairs that will be stored with the object.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :metadata, SurgeAPI::Internal::Type::HashOf[String]
+
+      # @!attribute photo_url
+      #   URL of a photo to be used as the user's avatar.
+      #
+      #   @return [String, nil]
+      optional :photo_url, String
+
+      # @!method initialize(first_name:, last_name: nil, metadata: nil, photo_url: nil, request_options: {})
+      #   @param first_name [String] The user's first name.
+      #
+      #   @param last_name [String] The user's last name.
+      #
+      #   @param metadata [Hash{Symbol=>String}] Set of key-value pairs that will be stored with the object.
+      #
+      #   @param photo_url [String] URL of a photo to be used as the user's avatar.
+      #
+      #   @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/surge_api/models/verification.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    # @see SurgeAPI::Resources::Verifications#create
+    class Verification < SurgeAPI::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the object.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute attempt_count
+      #   The number of times the code has been attempted.
+      #
+      #   @return [Integer]
+      required :attempt_count, Integer
+
+      # @!attribute phone_number
+      #   The phone number being verified. In E.164 format.
+      #
+      #   @return [String]
+      required :phone_number, String
+
+      # @!attribute status
+      #   The current status of the verification.
+      #
+      #   @return [Symbol, SurgeAPI::Models::Verification::Status]
+      required :status, enum: -> { SurgeAPI::Verification::Status }
+
+      # @!method initialize(id:, attempt_count:, phone_number:, status:)
+      #   A phone number verification
+      #
+      #   @param id [String] Unique identifier for the object.
+      #
+      #   @param attempt_count [Integer] The number of times the code has been attempted.
+      #
+      #   @param phone_number [String] The phone number being verified. In E.164 format.
+      #
+      #   @param status [Symbol, SurgeAPI::Models::Verification::Status] The current status of the verification.
+
+      # The current status of the verification.
+      #
+      # @see SurgeAPI::Models::Verification#status
+      module Status
+        extend SurgeAPI::Internal::Type::Enum
+
+        PENDING = :pending
+        VERIFIED = :verified
+        EXHAUSTED = :exhausted
+        EXPIRED = :expired
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/surge_api/models/verification_check.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    # @see SurgeAPI::Resources::Verifications#check
+    class VerificationCheck < SurgeAPI::Internal::Type::BaseModel
+      # @!attribute result
+      #   The result of the code check.
+      #
+      #   @return [Symbol, SurgeAPI::Models::VerificationCheck::Result, nil]
+      optional :result, enum: -> { SurgeAPI::VerificationCheck::Result }
+
+      # @!attribute verification
+      #   A phone number verification
+      #
+      #   @return [SurgeAPI::Models::Verification, nil]
+      optional :verification, -> { SurgeAPI::Verification }
+
+      # @!method initialize(result: nil, verification: nil)
+      #   The result of checking a Verification code
+      #
+      #   @param result [Symbol, SurgeAPI::Models::VerificationCheck::Result] The result of the code check.
+      #
+      #   @param verification [SurgeAPI::Models::Verification] A phone number verification
+
+      # The result of the code check.
+      #
+      # @see SurgeAPI::Models::VerificationCheck#result
+      module Result
+        extend SurgeAPI::Internal::Type::Enum
+
+        OK = :ok
+        INCORRECT = :incorrect
+        EXHAUSTED = :exhausted
+        EXPIRED = :expired
+        ALREADY_VERIFIED = :already_verified
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/surge_api/models/verification_check_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    # @see SurgeAPI::Resources::Verifications#check
+    class VerificationCheckParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      # @!attribute code
+      #   The Verification code that was received.
+      #
+      #   @return [String]
+      required :code, String
+
+      # @!method initialize(code:, request_options: {})
+      #   @param code [String] The Verification code that was received.
+      #
+      #   @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/surge_api/models/verification_create_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    # @see SurgeAPI::Resources::Verifications#create
+    class VerificationCreateParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      # @!attribute phone_number
+      #   The phone number to be verified. In E.164 format.
+      #
+      #   @return [String]
+      required :phone_number, String
+
+      # @!method initialize(phone_number:, request_options: {})
+      #   @param phone_number [String] The phone number to be verified. In E.164 format.
+      #
+      #   @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/surge_api/models/webhook_unwrap_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    # @see SurgeAPI::Resources::Webhooks#unwrap
+    class WebhookUnwrapParams < SurgeAPI::Internal::Type::BaseModel
+      extend SurgeAPI::Internal::Type::RequestParameters::Converter
+      include SurgeAPI::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/surge_api/models.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  [SurgeAPI::Internal::Type::BaseModel, *SurgeAPI::Internal::Type::BaseModel.subclasses].each do |cls|
+    cls.define_sorbet_constant!(:OrHash) { T.type_alias { T.any(cls, SurgeAPI::Internal::AnyHash) } }
+  end
+
+  SurgeAPI::Internal::Util.walk_namespaces(SurgeAPI::Models).each do |mod|
+    case mod
+    in SurgeAPI::Internal::Type::Enum | SurgeAPI::Internal::Type::Union
+      mod.constants.each do |name|
+        case mod.const_get(name)
+        in true | false
+          mod.define_sorbet_constant!(:TaggedBoolean) { T.type_alias { T::Boolean } }
+          mod.define_sorbet_constant!(:OrBoolean) { T.type_alias { T::Boolean } }
+        in Integer
+          mod.define_sorbet_constant!(:TaggedInteger) { T.type_alias { Integer } }
+          mod.define_sorbet_constant!(:OrInteger) { T.type_alias { Integer } }
+        in Float
+          mod.define_sorbet_constant!(:TaggedFloat) { T.type_alias { Float } }
+          mod.define_sorbet_constant!(:OrFloat) { T.type_alias { Float } }
+        in Symbol
+          mod.define_sorbet_constant!(:TaggedSymbol) { T.type_alias { Symbol } }
+          mod.define_sorbet_constant!(:OrSymbol) { T.type_alias { T.any(Symbol, String) } }
+        else
+        end
+      end
+    else
+    end
+  end
+
+  SurgeAPI::Internal::Util.walk_namespaces(SurgeAPI::Models)
+                          .lazy
+                          .grep(SurgeAPI::Internal::Type::Union)
+                          .each do |mod|
+    const = :Variants
+    next if mod.sorbet_constant_defined?(const)
+
+    mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
+  end
+
+  Account = SurgeAPI::Models::Account
+
+  AccountCreateParams = SurgeAPI::Models::AccountCreateParams
+
+  AccountRetrieveStatusParams = SurgeAPI::Models::AccountRetrieveStatusParams
+
+  AccountStatus = SurgeAPI::Models::AccountStatus
+
+  AccountUpdateParams = SurgeAPI::Models::AccountUpdateParams
+
+  Blast = SurgeAPI::Models::Blast
+
+  BlastCreateParams = SurgeAPI::Models::BlastCreateParams
+
+  CallEndedWebhookEvent = SurgeAPI::Models::CallEndedWebhookEvent
+
+  Campaign = SurgeAPI::Models::Campaign
+
+  CampaignApprovedWebhookEvent = SurgeAPI::Models::CampaignApprovedWebhookEvent
+
+  CampaignCreateParams = SurgeAPI::Models::CampaignCreateParams
+
+  Contact = SurgeAPI::Models::Contact
+
+  ContactCreateParams = SurgeAPI::Models::ContactCreateParams
+
+  ContactRetrieveParams = SurgeAPI::Models::ContactRetrieveParams
+
+  ContactUpdateParams = SurgeAPI::Models::ContactUpdateParams
+
+  ConversationCreatedWebhookEvent = SurgeAPI::Models::ConversationCreatedWebhookEvent
+
+  Error = SurgeAPI::Models::Error
+
+  Message = SurgeAPI::Models::Message
+
+  MessageCreateParams = SurgeAPI::Models::MessageCreateParams
+
+  MessageDeliveredWebhookEvent = SurgeAPI::Models::MessageDeliveredWebhookEvent
+
+  MessageFailedWebhookEvent = SurgeAPI::Models::MessageFailedWebhookEvent
+
+  MessageReceivedWebhookEvent = SurgeAPI::Models::MessageReceivedWebhookEvent
+
+  MessageSentWebhookEvent = SurgeAPI::Models::MessageSentWebhookEvent
+
+  Organization = SurgeAPI::Models::Organization
+
+  PhoneNumber = SurgeAPI::Models::PhoneNumber
+
+  PhoneNumberPurchaseParams = SurgeAPI::Models::PhoneNumberPurchaseParams
+
+  UnwrapWebhookEvent = SurgeAPI::Models::UnwrapWebhookEvent
+
+  User = SurgeAPI::Models::User
+
+  UserCreateParams = SurgeAPI::Models::UserCreateParams
+
+  UserCreateTokenParams = SurgeAPI::Models::UserCreateTokenParams
+
+  UserRetrieveParams = SurgeAPI::Models::UserRetrieveParams
+
+  UserTokenResponse = SurgeAPI::Models::UserTokenResponse
+
+  UserUpdateParams = SurgeAPI::Models::UserUpdateParams
+
+  Verification = SurgeAPI::Models::Verification
+
+  VerificationCheck = SurgeAPI::Models::VerificationCheck
+
+  VerificationCheckParams = SurgeAPI::Models::VerificationCheckParams
+
+  VerificationCreateParams = SurgeAPI::Models::VerificationCreateParams
+
+  WebhookUnwrapParams = SurgeAPI::Models::WebhookUnwrapParams
+end

data/lib/surge_api/request_options.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  # Specify HTTP behaviour to use for a specific request. These options supplement
+  # or override those provided at the client level.
+  #
+  # When making a request, you can pass an actual {RequestOptions} instance, or
+  # simply pass a Hash with symbol keys matching the attributes on this class.
+  class RequestOptions < SurgeAPI::Internal::Type::BaseModel
+    # @api private
+    #
+    # @param opts [SurgeAPI::RequestOptions, Hash{Symbol=>Object}]
+    #
+    # @raise [ArgumentError]
+    def self.validate!(opts)
+      case opts
+      in SurgeAPI::RequestOptions | Hash
+        opts.to_h.each_key do |k|
+          unless fields.include?(k)
+            raise ArgumentError.new("Request `opts` keys must be one of #{fields.keys}, got #{k.inspect}")
+          end
+        end
+      else
+        raise ArgumentError.new("Request `opts` must be a Hash or RequestOptions, got #{opts.inspect}")
+      end
+    end
+
+    # @!attribute idempotency_key
+    #   Idempotency key to send with request and all associated retries. Will only be
+    #   sent for write requests.
+    #
+    #   @return [String, nil]
+    optional :idempotency_key, String
+
+    # @!attribute extra_query
+    #   Extra query params to send with the request. These are `.merge`’d into any
+    #   `query` given at the client level.
+    #
+    #   @return [Hash{String=>Array<String>, String, nil}, nil]
+    optional :extra_query, SurgeAPI::Internal::Type::HashOf[SurgeAPI::Internal::Type::ArrayOf[String]]
+
+    # @!attribute extra_headers
+    #   Extra headers to send with the request. These are `.merged`’d into any
+    #   `extra_headers` given at the client level.
+    #
+    #   @return [Hash{String=>String, nil}, nil]
+    optional :extra_headers, SurgeAPI::Internal::Type::HashOf[String, nil?: true]
+
+    # @!attribute extra_body
+    #   Extra data to send with the request. These are deep merged into any data
+    #   generated as part of the normal request.
+    #
+    #   @return [Object, nil]
+    optional :extra_body, SurgeAPI::Internal::Type::HashOf[SurgeAPI::Internal::Type::Unknown]
+
+    # @!attribute max_retries
+    #   Maximum number of retries to attempt after a failed initial request.
+    #
+    #   @return [Integer, nil]
+    optional :max_retries, Integer
+
+    # @!attribute timeout
+    #   Request timeout in seconds.
+    #
+    #   @return [Float, nil]
+    optional :timeout, Float
+
+    # @!method initialize(values = {})
+    #   Returns a new instance of RequestOptions.
+    #
+    #   @param values [Hash{Symbol=>Object}]
+
+    define_sorbet_constant!(:OrHash) do
+      T.type_alias { T.any(SurgeAPI::RequestOptions, SurgeAPI::Internal::AnyHash) }
+    end
+  end
+end

data/lib/surge_api/resources/accounts.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Resources
+    class Accounts
+      # Some parameter documentations has been truncated, see
+      # {SurgeAPI::Models::AccountCreateParams} for more details.
+      #
+      # Creates a new Account within the calling Platform.
+      #
+      # @overload create(name:, brand_name: nil, organization: nil, time_zone: nil, request_options: {})
+      #
+      # @param name [String] The name of the account that will be visible for your internal organizational pu
+      #
+      # @param brand_name [String, nil] The name by which the people this account communicates with know it. If not prov
+      #
+      # @param organization [SurgeAPI::Models::AccountCreateParams::Organization] Parameters describing the legal entity on whose behalf the account will be opera
+      #
+      # @param time_zone [String] This is the time zone in which the account is headquartered. This time zone may
+      #
+      # @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [SurgeAPI::Models::Account]
+      #
+      # @see SurgeAPI::Models::AccountCreateParams
+      def create(params)
+        parsed, options = SurgeAPI::AccountCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "accounts",
+          body: parsed,
+          model: SurgeAPI::Account,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {SurgeAPI::Models::AccountUpdateParams} for more details.
+      #
+      # Updates an Account
+      #
+      # @overload update(id, brand_name: nil, name: nil, organization: nil, time_zone: nil, request_options: {})
+      #
+      # @param id [String] The ID for the account to update.
+      #
+      # @param brand_name [String] The name by which the people this account communicates with know it. If not prov
+      #
+      # @param name [String] The name of the account that will be visible for your internal organizational pu
+      #
+      # @param organization [SurgeAPI::Models::AccountUpdateParams::Organization] Parameters describing the legal entity on whose behalf the account will be opera
+      #
+      # @param time_zone [String, nil] The time zone for the account
+      #
+      # @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [SurgeAPI::Models::Account]
+      #
+      # @see SurgeAPI::Models::AccountUpdateParams
+      def update(id, params = {})
+        parsed, options = SurgeAPI::AccountUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["accounts/%1$s", id],
+          body: parsed,
+          model: SurgeAPI::Account,
+          options: options
+        )
+      end
+
+      # Check an account's status and capabilities
+      #
+      # @overload retrieve_status(account_id, capabilities: nil, request_options: {})
+      #
+      # @param account_id [String] ID of the account to check
+      #
+      # @param capabilities [Array<Symbol, SurgeAPI::Models::AccountRetrieveStatusParams::Capability>] capabilities about which to check the status
+      #
+      # @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [SurgeAPI::Models::AccountStatus]
+      #
+      # @see SurgeAPI::Models::AccountRetrieveStatusParams
+      def retrieve_status(account_id, params = {})
+        parsed, options = SurgeAPI::AccountRetrieveStatusParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["accounts/%1$s/status", account_id],
+          query: parsed,
+          model: SurgeAPI::AccountStatus,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [SurgeAPI::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/surge_api/resources/blasts.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Resources
+    class Blasts
+      # Some parameter documentations has been truncated, see
+      # {SurgeAPI::Models::BlastCreateParams} for more details.
+      #
+      # Sends a Blast.
+      #
+      # @overload create(account_id, attachments: nil, body: nil, contacts: nil, name: nil, segments: nil, send_at: nil, to: nil, request_options: {})
+      #
+      # @param account_id [String] The account for which the blast should be sent.
+      #
+      # @param attachments [Array<SurgeAPI::Models::BlastCreateParams::Attachment>]
+      #
+      # @param body [String] The message body.
+      #
+      # @param contacts [Array<String>] Deprecated. Use `to` instead.
+      #
+      # @param name [String] Optional name for the blast.
+      #
+      # @param segments [Array<String>] Deprecated. Use `to` instead.
+      #
+      # @param send_at [Time] When to send the blast. If not provided, sends immediately.
+      #
+      # @param to [Array<String>] List of recipients to whom the blast should be sent. This can be a combination o
+      #
+      # @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [SurgeAPI::Models::Blast]
+      #
+      # @see SurgeAPI::Models::BlastCreateParams
+      def create(account_id, params = {})
+        parsed, options = SurgeAPI::BlastCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["accounts/%1$s/blasts", account_id],
+          body: parsed,
+          model: SurgeAPI::Blast,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [SurgeAPI::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/surge_api/resources/campaigns.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Resources
+    class Campaigns
+      # Some parameter documentations has been truncated, see
+      # {SurgeAPI::Models::CampaignCreateParams} for more details.
+      #
+      # Creates a campaign to register account to send text messages.
+      #
+      # @overload create(account_id, consent_flow:, description:, message_samples:, privacy_policy_url:, use_cases:, volume:, includes: nil, link_sample: nil, terms_and_conditions_url: nil, request_options: {})
+      #
+      # @param account_id [String] The account for which the campaign should be created.
+      #
+      # @param consent_flow [String] A string explaining the method through which end users will opt in to receive me
+      #
+      # @param description [String] An explanation of the organization's purpose and how it will be using text messa
+      #
+      # @param message_samples [Array<String>] An array of 2-5 strings with examples of the messages that will be sent from thi
+      #
+      # @param privacy_policy_url [String] The URL of the privacy policy for the brand in question. This may be a shared pr
+      #
+      # @param use_cases [Array<Symbol, SurgeAPI::Models::CampaignCreateParams::UseCase>] A list containing 1-5 types of messages that will be sent with this campaign.
+      #
+      # @param volume [Symbol, SurgeAPI::Models::CampaignCreateParams::Volume] This will be one of the following:
+      #
+      # @param includes [Array<Symbol, SurgeAPI::Models::CampaignCreateParams::Include>] A list of properties that this campaign should include. These properties can be
+      #
+      # @param link_sample [String] A sample link that might be sent by this campaign. If links from other domains a
+      #
+      # @param terms_and_conditions_url [String] The URL of the terms and conditions presented to end users when they opt in to m
+      #
+      # @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [SurgeAPI::Models::Campaign]
+      #
+      # @see SurgeAPI::Models::CampaignCreateParams
+      def create(account_id, params)
+        parsed, options = SurgeAPI::CampaignCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["accounts/%1$s/campaigns", account_id],
+          body: parsed,
+          model: SurgeAPI::Campaign,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [SurgeAPI::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end