surge_api 0.24.0 → 0.25.0

data/lib/surge_api/models/toll_free_campaign_update_params.rb

@@ -0,0 +1,278 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    class TollFreeCampaignUpdateParams < SurgeAPI::Internal::Type::BaseModel
+      # @!attribute consent_flows
+      #
+      #   @return [Array<SurgeAPI::Models::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember0, SurgeAPI::Models::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember1, SurgeAPI::Models::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember2, SurgeAPI::Models::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember3>, nil]
+      optional :consent_flows,
+               -> { SurgeAPI::Internal::Type::ArrayOf[union: SurgeAPI::TollFreeCampaignUpdateParams::ConsentFlow] }
+
+      # @!attribute description
+      #   An explanation of how the toll-free number will be used.
+      #
+      #   @return [String, nil]
+      optional :description, String
+
+      # @!attribute includes
+      #
+      #   @return [Array<Symbol, SurgeAPI::Models::TollFreeCampaignUpdateParams::Include>, nil]
+      optional :includes,
+               -> { SurgeAPI::Internal::Type::ArrayOf[enum: SurgeAPI::TollFreeCampaignUpdateParams::Include] }
+
+      # @!attribute message_samples
+      #
+      #   @return [Array<String>, nil]
+      optional :message_samples, SurgeAPI::Internal::Type::ArrayOf[String]
+
+      # @!attribute privacy_policy_url
+      #
+      #   @return [String, nil]
+      optional :privacy_policy_url, String
+
+      # @!attribute terms_and_conditions_url
+      #
+      #   @return [String, nil]
+      optional :terms_and_conditions_url, String
+
+      # @!attribute use_cases
+      #
+      #   @return [Array<Symbol, SurgeAPI::Models::TollFreeCampaignUpdateParams::UseCase>, nil]
+      optional :use_cases,
+               -> { SurgeAPI::Internal::Type::ArrayOf[enum: SurgeAPI::TollFreeCampaignUpdateParams::UseCase] }
+
+      # @!method initialize(consent_flows: nil, description: nil, includes: nil, message_samples: nil, privacy_policy_url: nil, terms_and_conditions_url: nil, use_cases: nil)
+      #   Parameters for updating a toll-free campaign.
+      #
+      #   @param consent_flows [Array<SurgeAPI::Models::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember0, SurgeAPI::Models::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember1, SurgeAPI::Models::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember2, SurgeAPI::Models::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember3>]
+      #
+      #   @param description [String] An explanation of how the toll-free number will be used.
+      #
+      #   @param includes [Array<Symbol, SurgeAPI::Models::TollFreeCampaignUpdateParams::Include>]
+      #
+      #   @param message_samples [Array<String>]
+      #
+      #   @param privacy_policy_url [String]
+      #
+      #   @param terms_and_conditions_url [String]
+      #
+      #   @param use_cases [Array<Symbol, SurgeAPI::Models::TollFreeCampaignUpdateParams::UseCase>]
+
+      module ConsentFlow
+        extend SurgeAPI::Internal::Type::Union
+
+        variant -> { SurgeAPI::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember0 }
+
+        variant -> { SurgeAPI::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember1 }
+
+        variant -> { SurgeAPI::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember2 }
+
+        variant -> { SurgeAPI::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember3 }
+
+        class UnionMember0 < SurgeAPI::Internal::Type::BaseModel
+          # @!attribute script
+          #
+          #   @return [String]
+          required :script, String
+
+          # @!attribute type
+          #
+          #   @return [Symbol, SurgeAPI::Models::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember0::Type]
+          required :type, enum: -> { SurgeAPI::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember0::Type }
+
+          # @!method initialize(script:, type:)
+          #   @param script [String]
+          #   @param type [Symbol, SurgeAPI::Models::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember0::Type]
+
+          # @see SurgeAPI::Models::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember0#type
+          module Type
+            extend SurgeAPI::Internal::Type::Enum
+
+            VERBAL = :verbal
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        class UnionMember1 < SurgeAPI::Internal::Type::BaseModel
+          # @!attribute owner
+          #
+          #   @return [Symbol, SurgeAPI::Models::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember1::Owner]
+          required :owner, enum: -> { SurgeAPI::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember1::Owner }
+
+          # @!attribute type
+          #
+          #   @return [Symbol, SurgeAPI::Models::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember1::Type]
+          required :type, enum: -> { SurgeAPI::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember1::Type }
+
+          # @!attribute form_url
+          #
+          #   @return [String, nil]
+          optional :form_url, String
+
+          # @!attribute screenshot
+          #
+          #   @return [SurgeAPI::Models::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember1::Screenshot, nil]
+          optional :screenshot, -> { SurgeAPI::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember1::Screenshot }
+
+          # @!method initialize(owner:, type:, form_url: nil, screenshot: nil)
+          #   @param owner [Symbol, SurgeAPI::Models::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember1::Owner]
+          #   @param type [Symbol, SurgeAPI::Models::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember1::Type]
+          #   @param form_url [String]
+          #   @param screenshot [SurgeAPI::Models::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember1::Screenshot]
+
+          # @see SurgeAPI::Models::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember1#owner
+          module Owner
+            extend SurgeAPI::Internal::Type::Enum
+
+            BRAND = :brand
+            PLATFORM = :platform
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # @see SurgeAPI::Models::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember1#type
+          module Type
+            extend SurgeAPI::Internal::Type::Enum
+
+            WEB_FORM = :web_form
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # @see SurgeAPI::Models::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember1#screenshot
+          class Screenshot < SurgeAPI::Internal::Type::BaseModel
+            # @!attribute reason
+            #
+            #   @return [Symbol, SurgeAPI::Models::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember1::Screenshot::Reason]
+            required :reason,
+                     enum: -> { SurgeAPI::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember1::Screenshot::Reason }
+
+            # @!attribute urls
+            #
+            #   @return [Array<String>]
+            required :urls, SurgeAPI::Internal::Type::ArrayOf[String]
+
+            # @!attribute reason_other
+            #
+            #   @return [String, nil]
+            optional :reason_other, String
+
+            # @!method initialize(reason:, urls:, reason_other: nil)
+            #   @param reason [Symbol, SurgeAPI::Models::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember1::Screenshot::Reason]
+            #   @param urls [Array<String>]
+            #   @param reason_other [String]
+
+            # @see SurgeAPI::Models::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember1::Screenshot#reason
+            module Reason
+              extend SurgeAPI::Internal::Type::Enum
+
+              BEHIND_LOGIN = :behind_login
+              UNDER_CONSTRUCTION = :under_construction
+              OTHER = :other
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
+
+        class UnionMember2 < SurgeAPI::Internal::Type::BaseModel
+          # @!attribute file_urls
+          #
+          #   @return [Array<String>]
+          required :file_urls, SurgeAPI::Internal::Type::ArrayOf[String]
+
+          # @!attribute type
+          #
+          #   @return [Symbol, SurgeAPI::Models::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember2::Type]
+          required :type, enum: -> { SurgeAPI::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember2::Type }
+
+          # @!attribute keywords
+          #
+          #   @return [Array<String>, nil]
+          optional :keywords, SurgeAPI::Internal::Type::ArrayOf[String]
+
+          # @!method initialize(file_urls:, type:, keywords: nil)
+          #   @param file_urls [Array<String>]
+          #   @param type [Symbol, SurgeAPI::Models::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember2::Type]
+          #   @param keywords [Array<String>]
+
+          # @see SurgeAPI::Models::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember2#type
+          module Type
+            extend SurgeAPI::Internal::Type::Enum
+
+            TEXT = :text
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        class UnionMember3 < SurgeAPI::Internal::Type::BaseModel
+          # @!attribute file_urls
+          #
+          #   @return [Array<String>]
+          required :file_urls, SurgeAPI::Internal::Type::ArrayOf[String]
+
+          # @!attribute type
+          #
+          #   @return [Symbol, SurgeAPI::Models::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember3::Type]
+          required :type, enum: -> { SurgeAPI::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember3::Type }
+
+          # @!method initialize(file_urls:, type:)
+          #   @param file_urls [Array<String>]
+          #   @param type [Symbol, SurgeAPI::Models::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember3::Type]
+
+          # @see SurgeAPI::Models::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember3#type
+          module Type
+            extend SurgeAPI::Internal::Type::Enum
+
+            PAPER_FORM = :paper_form
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # @!method self.variants
+        #   @return [Array(SurgeAPI::Models::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember0, SurgeAPI::Models::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember1, SurgeAPI::Models::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember2, SurgeAPI::Models::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember3)]
+      end
+
+      module Include
+        extend SurgeAPI::Internal::Type::Enum
+
+        AGE_GATED = :age_gated
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      module UseCase
+        extend SurgeAPI::Internal::Type::Enum
+
+        TWO_FACTOR_AUTHENTICATION = :two_factor_authentication
+        ACCOUNT_NOTIFICATION = :account_notification
+        CUSTOMER_CARE = :customer_care
+        CHARITY = :charity
+        DELIVERY_NOTIFICATION = :delivery_notification
+        FRAUD_ALERT = :fraud_alert
+        EVENT = :event
+        HIGHER_EDUCATION = :higher_education
+        K12_EDUCATION = :k12_education
+        MARKETING = :marketing
+        POLLING_VOTING = :polling_voting
+        POLITICAL = :political
+        PUBLIC_SERVICE_ANNOUNCEMENT = :public_service_announcement
+        SECURITY_ALERT = :security_alert
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/surge_api/models/unwrap_webhook_event.rb

@@ -11,6 +11,12 @@ module SurgeAPI
 
       variant :"campaign.approved", -> { SurgeAPI::CampaignApprovedWebhookEvent }
 
+      variant :"campaign.rejected", -> { SurgeAPI::CampaignRejectedWebhookEvent }
+
+      variant :"campaign.submitted", -> { SurgeAPI::CampaignSubmittedWebhookEvent }
+
+      variant :"campaign.warning", -> { SurgeAPI::CampaignWarningWebhookEvent }
+
       variant :"contact.opted_in", -> { SurgeAPI::ContactOptedInWebhookEvent }
 
       variant :"contact.opted_out", -> { SurgeAPI::ContactOptedOutWebhookEvent }
@@ -36,7 +42,7 @@ module SurgeAPI
       variant :"voicemail.received", -> { SurgeAPI::VoicemailReceivedWebhookEvent }
 
       # @!method self.variants
-      #   @return [Array(SurgeAPI::Models::CallEndedWebhookEvent, SurgeAPI::Models::CampaignApprovedWebhookEvent, SurgeAPI::Models::ContactOptedInWebhookEvent, SurgeAPI::Models::ContactOptedOutWebhookEvent, SurgeAPI::Models::ConversationCreatedWebhookEvent, SurgeAPI::Models::LinkFollowedWebhookEvent, SurgeAPI::Models::MessageDeliveredWebhookEvent, SurgeAPI::Models::MessageFailedWebhookEvent, SurgeAPI::Models::MessageReceivedWebhookEvent, SurgeAPI::Models::MessageSentWebhookEvent, SurgeAPI::Models::PhoneNumberAttachedToCampaignWebhookEvent, SurgeAPI::Models::PhoneNumberImportedWebhookEvent, SurgeAPI::Models::RecordingCompletedWebhookEvent, SurgeAPI::Models::VoicemailReceivedWebhookEvent)]
+      #   @return [Array(SurgeAPI::Models::CallEndedWebhookEvent, SurgeAPI::Models::CampaignApprovedWebhookEvent, SurgeAPI::Models::CampaignRejectedWebhookEvent, SurgeAPI::Models::CampaignSubmittedWebhookEvent, SurgeAPI::Models::CampaignWarningWebhookEvent, SurgeAPI::Models::ContactOptedInWebhookEvent, SurgeAPI::Models::ContactOptedOutWebhookEvent, SurgeAPI::Models::ConversationCreatedWebhookEvent, SurgeAPI::Models::LinkFollowedWebhookEvent, SurgeAPI::Models::MessageDeliveredWebhookEvent, SurgeAPI::Models::MessageFailedWebhookEvent, SurgeAPI::Models::MessageReceivedWebhookEvent, SurgeAPI::Models::MessageSentWebhookEvent, SurgeAPI::Models::PhoneNumberAttachedToCampaignWebhookEvent, SurgeAPI::Models::PhoneNumberImportedWebhookEvent, SurgeAPI::Models::RecordingCompletedWebhookEvent, SurgeAPI::Models::VoicemailReceivedWebhookEvent)]
     end
   end
 end

data/lib/surge_api/models/user_create_token_params.rb

@@ -19,11 +19,25 @@ module SurgeAPI
       #   @return [Integer, nil]
       optional :duration_seconds, Integer
 
-      # @!method initialize(user_id:, duration_seconds: nil, request_options: {})
+      # @!attribute read_only
+      #   Restrict the token to viewing embedded conversations and unread counts. Sending
+      #   messages, changing read state, editing contacts, and calling are disabled.
+      #   Defaults to false. Preserve this value when refreshing the token; changing
+      #   access mode requires reloading the embed.
+      #
+      #   @return [Boolean, nil]
+      optional :read_only, SurgeAPI::Internal::Type::Boolean
+
+      # @!method initialize(user_id:, duration_seconds: nil, read_only: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {SurgeAPI::Models::UserCreateTokenParams} for more details.
+      #
       #   @param user_id [String] The user for which the token represents authentication.
       #
       #   @param duration_seconds [Integer] For how many seconds the token should be accepted. Defaults to 15 minutes.
       #
+      #   @param read_only [Boolean] Restrict the token to viewing embedded conversations and unread counts. Sending
+      #
       #   @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/surge_api/models.rb

@@ -79,13 +79,19 @@ module SurgeAPI
 
   CampaignParams = SurgeAPI::Models::CampaignParams
 
+  CampaignRejectedWebhookEvent = SurgeAPI::Models::CampaignRejectedWebhookEvent
+
   CampaignResendBrandVerificationMessageParams =
     SurgeAPI::Models::CampaignResendBrandVerificationMessageParams
 
   CampaignRetrieveParams = SurgeAPI::Models::CampaignRetrieveParams
 
+  CampaignSubmittedWebhookEvent = SurgeAPI::Models::CampaignSubmittedWebhookEvent
+
   CampaignUpdateParams = SurgeAPI::Models::CampaignUpdateParams
 
+  CampaignWarningWebhookEvent = SurgeAPI::Models::CampaignWarningWebhookEvent
+
   Contact = SurgeAPI::Models::Contact
 
   ContactCreateParams = SurgeAPI::Models::ContactCreateParams
@@ -154,6 +160,20 @@ module SurgeAPI
 
   RecordingRetrieveParams = SurgeAPI::Models::RecordingRetrieveParams
 
+  TollFreeCampaign = SurgeAPI::Models::TollFreeCampaign
+
+  TollFreeCampaignConsentFlow = SurgeAPI::Models::TollFreeCampaignConsentFlow
+
+  TollFreeCampaignCreateParams = SurgeAPI::Models::TollFreeCampaignCreateParams
+
+  TollFreeCampaignListParams = SurgeAPI::Models::TollFreeCampaignListParams
+
+  TollFreeCampaignParams = SurgeAPI::Models::TollFreeCampaignParams
+
+  TollFreeCampaignRetrieveParams = SurgeAPI::Models::TollFreeCampaignRetrieveParams
+
+  TollFreeCampaignUpdateParams = SurgeAPI::Models::TollFreeCampaignUpdateParams
+
   UnwrapWebhookEvent = SurgeAPI::Models::UnwrapWebhookEvent
 
   User = SurgeAPI::Models::User

data/lib/surge_api/resources/accounts.rb

@@ -6,7 +6,7 @@ module SurgeAPI
       # Some parameter documentations has been truncated, see
       # {SurgeAPI::Models::AccountCreateParams} for more details.
       #
-      # Creates a new Account within the calling Platform.
+      # Creates a new Account.
       #
       # @overload create(name:, brand_name: nil, organization: nil, time_zone: nil, request_options: {})
       #
@@ -90,7 +90,7 @@ module SurgeAPI
       # Some parameter documentations has been truncated, see
       # {SurgeAPI::Models::AccountListParams} for more details.
       #
-      # List all accounts for the calling platform with cursor-based pagination.
+      # List all accounts with cursor-based pagination.
       #
       # @overload list(after: nil, before: nil, request_options: {})
       #

data/lib/surge_api/resources/campaigns.rb

@@ -53,28 +53,46 @@ module SurgeAPI
       # Some parameter documentations has been truncated, see
       # {SurgeAPI::Models::CampaignUpdateParams} for more details.
       #
-      # Updates a campaign that has not yet been approved. This can be used to fix
-      # issues flagged during review and resubmit the campaign. Returns an error if the
-      # campaign is currently in review, has already been approved, or has been
-      # deactivated.
+      # Updates supplied fields on a campaign and submits it for review. Omitted fields
+      # retain their stored values. An empty object or empty request body resubmits the
+      # existing campaign without changing its registration details. Supplied arrays
+      # replace their stored values; an empty includes array clears all inclusion flags.
+      # Returns an error if the resulting campaign is incomplete or invalid, or the
+      # campaign is not editable.
       #
-      # @overload update(id, campaign_params:, request_options: {})
+      # @overload update(id, consent_flow: nil, description: nil, includes: nil, link_sample: nil, message_samples: nil, privacy_policy_url: nil, terms_and_conditions_url: nil, use_cases: nil, volume: nil, request_options: {})
       #
       # @param id [String] The ID of the campaign to update.
       #
-      # @param campaign_params [SurgeAPI::Models::CampaignParams::StandardCampaignParams, SurgeAPI::Models::CampaignParams::ExternalCampaignParams] Parameters for creating a new campaign. Either provide full campaign details or
+      # @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 includes [Array<Symbol, SurgeAPI::Models::CampaignUpdateParams::Include>] A list of properties that this campaign should include. These properties can be
+      #
+      # @param link_sample [String, nil] A sample link that might be sent by this campaign. This is required when `includ
+      #
+      # @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 terms_and_conditions_url [String] The URL of the terms and conditions presented to end users when they opt in to m
+      #
+      # @param use_cases [Array<Symbol, SurgeAPI::Models::CampaignUpdateParams::UseCase>] A list containing 1-5 types of messages that will be sent with this campaign.
+      #
+      # @param volume [Symbol, SurgeAPI::Models::CampaignUpdateParams::Volume] This will be one of the following:
       #
       # @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [SurgeAPI::Models::Campaign]
       #
       # @see SurgeAPI::Models::CampaignUpdateParams
-      def update(id, params)
+      def update(id, params = {})
         parsed, options = SurgeAPI::CampaignUpdateParams.dump_request(params)
         @client.request(
           method: :patch,
           path: ["campaigns/%1$s", id],
-          body: parsed[:campaign_params],
+          body: parsed,
           model: SurgeAPI::Campaign,
           options: options
         )

data/lib/surge_api/resources/phone_numbers.rb

@@ -25,12 +25,14 @@ module SurgeAPI
 
       # Updates a phone number's details.
       #
-      # @overload update(id, campaign_id: nil, name: nil, request_options: {})
+      # @overload update(id, campaign_id: nil, metadata: nil, name: nil, request_options: {})
       #
       # @param id [String] The ID of the phone number to update.
       #
       # @param campaign_id [String] Campaign ID to attach this number to (`cpn_...`).
       #
+      # @param metadata [Hash{Symbol=>String}] Set of key-value pairs that will be stored with the object.
+      #
       # @param name [String] A human-readable name for the phone number.
       #
       # @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -127,7 +129,7 @@ module SurgeAPI
       #
       # When `phone_number` is provided, all other search parameters are ignored.
       #
-      # @overload purchase(account_id, area_code: nil, latitude: nil, longitude: nil, name: nil, phone_number: nil, type: nil, request_options: {})
+      # @overload purchase(account_id, area_code: nil, latitude: nil, longitude: nil, metadata: nil, name: nil, phone_number: nil, type: nil, request_options: {})
       #
       # @param account_id [String] The account for which the phone number should be created.
       #
@@ -137,6 +139,8 @@ module SurgeAPI
       #
       # @param longitude [Float] Longitude to search for nearby phone numbers. Must be used with latitude. If pro
       #
+      # @param metadata [Hash{Symbol=>String}] Set of key-value pairs that will be stored with the object.
+      #
       # @param name [String] A human-readable name for the phone number. If not provided, defaults to the for
       #
       # @param phone_number [String] The exact phone number to purchase in E.164 format. When provided, all other sea

data/lib/surge_api/resources/toll_free_campaigns.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Resources
+    class TollFreeCampaigns
+      # Creates a toll-free campaign and submits it for Surge review.
+      #
+      # @overload create(account_id, consent_flows:, description:, message_samples:, phone_number_id:, privacy_policy_url:, terms_and_conditions_url:, use_cases:, includes: nil, request_options: {})
+      #
+      # @param account_id [String] The account for which the toll-free campaign should be created.
+      #
+      # @param consent_flows [Array<SurgeAPI::Models::TollFreeCampaignParams::ConsentFlow::UnionMember0, SurgeAPI::Models::TollFreeCampaignParams::ConsentFlow::UnionMember1, SurgeAPI::Models::TollFreeCampaignParams::ConsentFlow::UnionMember2, SurgeAPI::Models::TollFreeCampaignParams::ConsentFlow::UnionMember3>]
+      #
+      # @param description [String] An explanation of how the toll-free number will be used.
+      #
+      # @param message_samples [Array<String>]
+      #
+      # @param phone_number_id [String] The toll-free phone number to register.
+      #
+      # @param privacy_policy_url [String]
+      #
+      # @param terms_and_conditions_url [String]
+      #
+      # @param use_cases [Array<Symbol, SurgeAPI::Models::TollFreeCampaignParams::UseCase>]
+      #
+      # @param includes [Array<Symbol, SurgeAPI::Models::TollFreeCampaignParams::Include>]
+      #
+      # @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [SurgeAPI::Models::TollFreeCampaign]
+      #
+      # @see SurgeAPI::Models::TollFreeCampaignCreateParams
+      def create(account_id, params)
+        parsed, options = SurgeAPI::TollFreeCampaignCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["accounts/%1$s/toll_free_campaigns", account_id],
+          body: parsed,
+          model: SurgeAPI::TollFreeCampaign,
+          options: options
+        )
+      end
+
+      # Retrieves a toll-free campaign object.
+      #
+      # @overload retrieve(campaign_id, request_options: {})
+      #
+      # @param campaign_id [String] The ID of the toll-free campaign to retrieve.
+      #
+      # @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [SurgeAPI::Models::TollFreeCampaign]
+      #
+      # @see SurgeAPI::Models::TollFreeCampaignRetrieveParams
+      def retrieve(campaign_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["toll_free_campaigns/%1$s", campaign_id],
+          model: SurgeAPI::TollFreeCampaign,
+          options: params[:request_options]
+        )
+      end
+
+      # Updates a toll-free campaign awaiting customer fixes and re-submits it for Surge
+      # review. Returns 409 if the campaign is not in an updatable status.
+      #
+      # @overload update(campaign_id, consent_flows: nil, description: nil, includes: nil, message_samples: nil, privacy_policy_url: nil, terms_and_conditions_url: nil, use_cases: nil, request_options: {})
+      #
+      # @param campaign_id [String] The toll-free campaign ID to update.
+      #
+      # @param consent_flows [Array<SurgeAPI::Models::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember0, SurgeAPI::Models::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember1, SurgeAPI::Models::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember2, SurgeAPI::Models::TollFreeCampaignUpdateParams::ConsentFlow::UnionMember3>]
+      #
+      # @param description [String] An explanation of how the toll-free number will be used.
+      #
+      # @param includes [Array<Symbol, SurgeAPI::Models::TollFreeCampaignUpdateParams::Include>]
+      #
+      # @param message_samples [Array<String>]
+      #
+      # @param privacy_policy_url [String]
+      #
+      # @param terms_and_conditions_url [String]
+      #
+      # @param use_cases [Array<Symbol, SurgeAPI::Models::TollFreeCampaignUpdateParams::UseCase>]
+      #
+      # @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [SurgeAPI::Models::TollFreeCampaign]
+      #
+      # @see SurgeAPI::Models::TollFreeCampaignUpdateParams
+      def update(campaign_id, params = {})
+        parsed, options = SurgeAPI::TollFreeCampaignUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["toll_free_campaigns/%1$s", campaign_id],
+          body: parsed,
+          model: SurgeAPI::TollFreeCampaign,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {SurgeAPI::Models::TollFreeCampaignListParams} for more details.
+      #
+      # List all toll-free campaigns for an account with cursor-based pagination.
+      #
+      # @overload list(account_id, after: nil, before: nil, request_options: {})
+      #
+      # @param account_id [String] The account ID to list toll-free campaigns for.
+      #
+      # @param after [String] Cursor for forward pagination. Use the next_cursor from a previous response.
+      #
+      # @param before [String] Cursor for backward pagination. Use the previous_cursor from a previous response
+      #
+      # @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [SurgeAPI::Internal::Cursor<SurgeAPI::Models::TollFreeCampaign>]
+      #
+      # @see SurgeAPI::Models::TollFreeCampaignListParams
+      def list(account_id, params = {})
+        parsed, options = SurgeAPI::TollFreeCampaignListParams.dump_request(params)
+        query = SurgeAPI::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: ["accounts/%1$s/toll_free_campaigns", account_id],
+          query: query,
+          page: SurgeAPI::Internal::Cursor,
+          model: SurgeAPI::TollFreeCampaign,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [SurgeAPI::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/surge_api/resources/users.rb

@@ -138,15 +138,20 @@ module SurgeAPI
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {SurgeAPI::Models::UserCreateTokenParams} for more details.
+      #
       # Provides a mechanism for having Surge create a signed token for embeds instead
       # of signing with your own signing key.
       #
-      # @overload create_token(user_id, duration_seconds: nil, request_options: {})
+      # @overload create_token(user_id, duration_seconds: nil, read_only: nil, request_options: {})
       #
       # @param user_id [String] The user for which the token represents authentication.
       #
       # @param duration_seconds [Integer] For how many seconds the token should be accepted. Defaults to 15 minutes.
       #
+      # @param read_only [Boolean] Restrict the token to viewing embedded conversations and unread counts. Sending
+      #
       # @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [SurgeAPI::Models::UserTokenResponse]

data/lib/surge_api/resources/webhooks.rb

@@ -9,7 +9,7 @@ module SurgeAPI
       #
       # @param key [String, nil] The webhook signing key
       #
-      # @return [SurgeAPI::Models::CallEndedWebhookEvent, SurgeAPI::Models::CampaignApprovedWebhookEvent, SurgeAPI::Models::ContactOptedInWebhookEvent, SurgeAPI::Models::ContactOptedOutWebhookEvent, SurgeAPI::Models::ConversationCreatedWebhookEvent, SurgeAPI::Models::LinkFollowedWebhookEvent, SurgeAPI::Models::MessageDeliveredWebhookEvent, SurgeAPI::Models::MessageFailedWebhookEvent, SurgeAPI::Models::MessageReceivedWebhookEvent, SurgeAPI::Models::MessageSentWebhookEvent, SurgeAPI::Models::PhoneNumberAttachedToCampaignWebhookEvent, SurgeAPI::Models::PhoneNumberImportedWebhookEvent, SurgeAPI::Models::RecordingCompletedWebhookEvent, SurgeAPI::Models::VoicemailReceivedWebhookEvent]
+      # @return [SurgeAPI::Models::CallEndedWebhookEvent, SurgeAPI::Models::CampaignApprovedWebhookEvent, SurgeAPI::Models::CampaignRejectedWebhookEvent, SurgeAPI::Models::CampaignSubmittedWebhookEvent, SurgeAPI::Models::CampaignWarningWebhookEvent, SurgeAPI::Models::ContactOptedInWebhookEvent, SurgeAPI::Models::ContactOptedOutWebhookEvent, SurgeAPI::Models::ConversationCreatedWebhookEvent, SurgeAPI::Models::LinkFollowedWebhookEvent, SurgeAPI::Models::MessageDeliveredWebhookEvent, SurgeAPI::Models::MessageFailedWebhookEvent, SurgeAPI::Models::MessageReceivedWebhookEvent, SurgeAPI::Models::MessageSentWebhookEvent, SurgeAPI::Models::PhoneNumberAttachedToCampaignWebhookEvent, SurgeAPI::Models::PhoneNumberImportedWebhookEvent, SurgeAPI::Models::RecordingCompletedWebhookEvent, SurgeAPI::Models::VoicemailReceivedWebhookEvent]
       def unwrap(payload, headers:, key: @client.webhook_signing_secret)
         if key.nil?
           raise ArgumentError.new("Cannot verify a webhook without a key on either the client's webhook_signing_secret or passed in as an argument")

data/lib/surge_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SurgeAPI
-  VERSION = "0.24.0"
+  VERSION = "0.25.0"
 end