surge_api 0.1.0 → 0.2.1

data/lib/surge_api/models/campaign_create_params.rb

@@ -7,196 +7,20 @@ module SurgeAPI
       extend SurgeAPI::Internal::Type::RequestParameters::Converter
       include SurgeAPI::Internal::Type::RequestParameters
 
-      # @!attribute consent_flow
-      #   A string explaining the method through which end users will opt in to receive
-      #   messages from the brand. Typically this should include URLs for opt-in forms or
-      #   screenshots that might be helpful in explaining the flow to someone unfamiliar
-      #   with the organization's purpose.
+      # @!attribute campaign_params
+      #   Parameters for creating a new campaign. Either provide full campaign details or
+      #   import using a TCR ID.
       #
-      #   @return [String]
-      required :consent_flow, String
+      #   @return [SurgeAPI::Models::CampaignParams::StandardCampaignParams, SurgeAPI::Models::CampaignParams::ExternalCampaignParams]
+      required :campaign_params, union: -> { SurgeAPI::CampaignParams }
 
-      # @!attribute description
-      #   An explanation of the organization's purpose and how it will be using text
-      #   messaging to accomplish that purpose.
-      #
-      #   @return [String]
-      required :description, String
-
-      # @!attribute message_samples
-      #   An array of 2-5 strings with examples of the messages that will be sent from
-      #   this campaign. Typically the first sample should be a compliance message like
-      #   `You are now opted in to messages from {brand name}. Frequency varies. Msg&data rates apply. Reply STOP to opt out.`
-      #   These samples don't necessarily need to be the only templates that will be used
-      #   for the campaign, but they should reflect the purpose of the messages that will
-      #   be sent. Any variable content can be reflected by wrapping it in square brackets
-      #   like `[customer name]`.
-      #
-      #   @return [Array<String>]
-      required :message_samples, SurgeAPI::Internal::Type::ArrayOf[String]
-
-      # @!attribute privacy_policy_url
-      #   The URL of the privacy policy for the brand in question. This may be a shared
-      #   privacy policy if it's the policy that is displayed to end users when they opt
-      #   in to messaging.
-      #
-      #   @return [String]
-      required :privacy_policy_url, String
-
-      # @!attribute use_cases
-      #   A list containing 1-5 types of messages that will be sent with this campaign.
-      #
-      #   The following use cases are typically available to all brands:
-      #
-      #   - `account_notification` - For sending reminders, alerts, and general
-      #     account-related notifications like booking confirmations or appointment
-      #     reminders.
-      #   - `customer_care` - For account support, troubleshooting, and general customer
-      #     service communication.
-      #   - `delivery_notification` - For notifying customers about the status of product
-      #     or service deliveries.
-      #   - `fraud_alert` - For warning customers about suspicious or potentially
-      #     fraudulent activity.
-      #   - `higher_education` - For messaging related to colleges, universities, and
-      #     school districts outside of K–12.
-      #   - `marketing` - For promotional or advertising messages intended to market
-      #     products or services.
-      #   - `polling_voting` - For conducting surveys, polls, or voting-related messaging.
-      #   - `public_service_announcement` - For raising awareness about social issues or
-      #     important public information.
-      #   - `security_alert` - For alerts related to potential security breaches or
-      #     compromised systems requiring user action.
-      #   - `two_factor_authentication` - For sending one-time passwords or verification
-      #     codes for login or password reset.
-      #
-      #   For access to special use cases not shown here, reach out to support@surge.app.
-      #
-      #   @return [Array<Symbol, SurgeAPI::Models::CampaignCreateParams::UseCase>]
-      required :use_cases,
-               -> { SurgeAPI::Internal::Type::ArrayOf[enum: SurgeAPI::CampaignCreateParams::UseCase] }
-
-      # @!attribute volume
-      #   This will be one of the following:
-      #
-      #   - `low` - The campaign will be allowed to send up to 2000 SMS segments to
-      #     T-Mobile customers each day. In this case your platform will be charged for
-      #     the setup fee for a low volume number upon receipt of the API request.
-      #   - `high` - The campaign will be allowed to send up to 200k SMS segments to
-      #     T-Mobile customers each day, depending on the trust score assigned by The
-      #     Campaign Registry. Your platform will be charged for the setup fee for a high
-      #     volume number upon receipt of the API request, and phone numbers will be
-      #     charged as high volume numbers going forward.
-      #
-      #   @return [Symbol, SurgeAPI::Models::CampaignCreateParams::Volume]
-      required :volume, enum: -> { SurgeAPI::CampaignCreateParams::Volume }
-
-      # @!attribute includes
-      #   A list of properties that this campaign should include. These properties can be
-      #   any of the following values:
-      #
-      #   - `links` - whether the campaign might send links in messages
-      #   - `phone_numbers` - whether the campaign might send phone numbers in messages
-      #   - `age_gated` - whether the campaign contains age gated content (controlled
-      #     substances or adult content)
-      #   - `direct_lending` - whether the campaign contains content related to direct
-      #     lending or other loan arrangements
-      #
-      #   @return [Array<Symbol, SurgeAPI::Models::CampaignCreateParams::Include>, nil]
-      optional :includes,
-               -> { SurgeAPI::Internal::Type::ArrayOf[enum: SurgeAPI::CampaignCreateParams::Include] }
-
-      # @!attribute link_sample
-      #   A sample link that might be sent by this campaign. If links from other domains
-      #   are sent through this campaign, they are much more likely to be filtered by the
-      #   carriers. If link shortening is enabled for the account, the link shortener URL
-      #   will be used instead of what is provided. Reach out to support if you would like
-      #   to disable automatic link shortening.
-      #
-      #   @return [String, nil]
-      optional :link_sample, String
-
-      # @!attribute terms_and_conditions_url
-      #   The URL of the terms and conditions presented to end users when they opt in to
-      #   messaging. These terms and conditions may be shared among all of a platform's
-      #   customers if they're the terms that are presented to end users when they opt in
-      #   to messaging.
-      #
-      #   @return [String, nil]
-      optional :terms_and_conditions_url, String
-
-      # @!method initialize(consent_flow:, description:, message_samples:, privacy_policy_url:, use_cases:, volume:, includes: nil, link_sample: nil, terms_and_conditions_url: nil, request_options: {})
+      # @!method initialize(campaign_params:, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {SurgeAPI::Models::CampaignCreateParams} for more details.
       #
-      #   @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 campaign_params [SurgeAPI::Models::CampaignParams::StandardCampaignParams, SurgeAPI::Models::CampaignParams::ExternalCampaignParams] Parameters for creating a new campaign. Either provide full campaign details or
       #
       #   @param request_options [SurgeAPI::RequestOptions, Hash{Symbol=>Object}]
-
-      module UseCase
-        extend SurgeAPI::Internal::Type::Enum
-
-        ACCOUNT_NOTIFICATION = :account_notification
-        CUSTOMER_CARE = :customer_care
-        DELIVERY_NOTIFICATION = :delivery_notification
-        FRAUD_ALERT = :fraud_alert
-        HIGHER_EDUCATION = :higher_education
-        MARKETING = :marketing
-        POLLING_VOTING = :polling_voting
-        PUBLIC_SERVICE_ANNOUNCEMENT = :public_service_announcement
-        SECURITY_ALERT = :security_alert
-        TWO_FACTOR_AUTHENTICATION = :two_factor_authentication
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      # This will be one of the following:
-      #
-      # - `low` - The campaign will be allowed to send up to 2000 SMS segments to
-      #   T-Mobile customers each day. In this case your platform will be charged for
-      #   the setup fee for a low volume number upon receipt of the API request.
-      # - `high` - The campaign will be allowed to send up to 200k SMS segments to
-      #   T-Mobile customers each day, depending on the trust score assigned by The
-      #   Campaign Registry. Your platform will be charged for the setup fee for a high
-      #   volume number upon receipt of the API request, and phone numbers will be
-      #   charged as high volume numbers going forward.
-      module Volume
-        extend SurgeAPI::Internal::Type::Enum
-
-        HIGH = :high
-        LOW = :low
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      module Include
-        extend SurgeAPI::Internal::Type::Enum
-
-        LINKS = :links
-        PHONE_NUMBERS = :phone_numbers
-        AGE_GATED = :age_gated
-        DIRECT_LENDING = :direct_lending
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
     end
   end
 end

data/lib/surge_api/models/campaign_params.rb

@@ -0,0 +1,228 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    # Parameters for creating a new campaign. Either provide full campaign details or
+    # import using a TCR ID.
+    module CampaignParams
+      extend SurgeAPI::Internal::Type::Union
+
+      # Full campaign details for standard registration through Surge
+      variant -> { SurgeAPI::CampaignParams::StandardCampaignParams }
+
+      # Import an externally registered campaign from The Campaign Registry (TCR)
+      variant -> { SurgeAPI::CampaignParams::ExternalCampaignParams }
+
+      class StandardCampaignParams < SurgeAPI::Internal::Type::BaseModel
+        # @!attribute consent_flow
+        #   A string explaining the method through which end users will opt in to receive
+        #   messages from the brand. Typically this should include URLs for opt-in forms or
+        #   screenshots that might be helpful in explaining the flow to someone unfamiliar
+        #   with the organization's purpose.
+        #
+        #   @return [String]
+        required :consent_flow, String
+
+        # @!attribute description
+        #   An explanation of the organization's purpose and how it will be using text
+        #   messaging to accomplish that purpose.
+        #
+        #   @return [String]
+        required :description, String
+
+        # @!attribute message_samples
+        #   An array of 2-5 strings with examples of the messages that will be sent from
+        #   this campaign. Typically the first sample should be a compliance message like
+        #   `You are now opted in to messages from {brand name}. Frequency varies. Msg&data rates apply. Reply STOP to opt out.`
+        #   These samples don't necessarily need to be the only templates that will be used
+        #   for the campaign, but they should reflect the purpose of the messages that will
+        #   be sent. Any variable content can be reflected by wrapping it in square brackets
+        #   like `[customer name]`.
+        #
+        #   @return [Array<String>]
+        required :message_samples, SurgeAPI::Internal::Type::ArrayOf[String]
+
+        # @!attribute privacy_policy_url
+        #   The URL of the privacy policy for the brand in question. This may be a shared
+        #   privacy policy if it's the policy that is displayed to end users when they opt
+        #   in to messaging.
+        #
+        #   @return [String]
+        required :privacy_policy_url, String
+
+        # @!attribute use_cases
+        #   A list containing 1-5 types of messages that will be sent with this campaign.
+        #
+        #   The following use cases are typically available to all brands:
+        #
+        #   - `account_notification` - For sending reminders, alerts, and general
+        #     account-related notifications like booking confirmations or appointment
+        #     reminders.
+        #   - `customer_care` - For account support, troubleshooting, and general customer
+        #     service communication.
+        #   - `delivery_notification` - For notifying customers about the status of product
+        #     or service deliveries.
+        #   - `fraud_alert` - For warning customers about suspicious or potentially
+        #     fraudulent activity.
+        #   - `higher_education` - For messaging related to colleges, universities, and
+        #     school districts outside of K–12.
+        #   - `marketing` - For promotional or advertising messages intended to market
+        #     products or services.
+        #   - `polling_voting` - For conducting surveys, polls, or voting-related messaging.
+        #   - `public_service_announcement` - For raising awareness about social issues or
+        #     important public information.
+        #   - `security_alert` - For alerts related to potential security breaches or
+        #     compromised systems requiring user action.
+        #   - `two_factor_authentication` - For sending one-time passwords or verification
+        #     codes for login or password reset.
+        #
+        #   For access to special use cases not shown here, reach out to support@surge.app.
+        #
+        #   @return [Array<Symbol, SurgeAPI::Models::CampaignParams::StandardCampaignParams::UseCase>]
+        required :use_cases,
+                 -> { SurgeAPI::Internal::Type::ArrayOf[enum: SurgeAPI::CampaignParams::StandardCampaignParams::UseCase] }
+
+        # @!attribute volume
+        #   This will be one of the following:
+        #
+        #   - `low` - The campaign will be allowed to send up to 2000 SMS segments to
+        #     T-Mobile customers each day. In this case your platform will be charged for
+        #     the setup fee for a low volume number upon receipt of the API request.
+        #   - `high` - The campaign will be allowed to send up to 200k SMS segments to
+        #     T-Mobile customers each day, depending on the trust score assigned by The
+        #     Campaign Registry. Your platform will be charged for the setup fee for a high
+        #     volume number upon receipt of the API request, and phone numbers will be
+        #     charged as high volume numbers going forward.
+        #
+        #   @return [Symbol, SurgeAPI::Models::CampaignParams::StandardCampaignParams::Volume]
+        required :volume, enum: -> { SurgeAPI::CampaignParams::StandardCampaignParams::Volume }
+
+        # @!attribute includes
+        #   A list of properties that this campaign should include. These properties can be
+        #   any of the following values:
+        #
+        #   - `links` - whether the campaign might send links in messages
+        #   - `phone_numbers` - whether the campaign might send phone numbers in messages
+        #   - `age_gated` - whether the campaign contains age gated content (controlled
+        #     substances or adult content)
+        #   - `direct_lending` - whether the campaign contains content related to direct
+        #     lending or other loan arrangements
+        #
+        #   @return [Array<Symbol, SurgeAPI::Models::CampaignParams::StandardCampaignParams::Include>, nil]
+        optional :includes,
+                 -> { SurgeAPI::Internal::Type::ArrayOf[enum: SurgeAPI::CampaignParams::StandardCampaignParams::Include] }
+
+        # @!attribute link_sample
+        #   A sample link that might be sent by this campaign. If links from other domains
+        #   are sent through this campaign, they are much more likely to be filtered by the
+        #   carriers. If link shortening is enabled for the account, the link shortener URL
+        #   will be used instead of what is provided. Reach out to support if you would like
+        #   to disable automatic link shortening.
+        #
+        #   @return [String, nil]
+        optional :link_sample, String
+
+        # @!attribute terms_and_conditions_url
+        #   The URL of the terms and conditions presented to end users when they opt in to
+        #   messaging. These terms and conditions may be shared among all of a platform's
+        #   customers if they're the terms that are presented to end users when they opt in
+        #   to messaging.
+        #
+        #   @return [String, nil]
+        optional :terms_and_conditions_url, String
+
+        # @!method initialize(consent_flow:, description:, message_samples:, privacy_policy_url:, use_cases:, volume:, includes: nil, link_sample: nil, terms_and_conditions_url: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {SurgeAPI::Models::CampaignParams::StandardCampaignParams} for more details.
+        #
+        #   Full campaign details for standard registration through Surge
+        #
+        #   @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::CampaignParams::StandardCampaignParams::UseCase>] A list containing 1-5 types of messages that will be sent with this campaign.
+        #
+        #   @param volume [Symbol, SurgeAPI::Models::CampaignParams::StandardCampaignParams::Volume] This will be one of the following:
+        #
+        #   @param includes [Array<Symbol, SurgeAPI::Models::CampaignParams::StandardCampaignParams::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
+
+        module UseCase
+          extend SurgeAPI::Internal::Type::Enum
+
+          ACCOUNT_NOTIFICATION = :account_notification
+          CUSTOMER_CARE = :customer_care
+          DELIVERY_NOTIFICATION = :delivery_notification
+          FRAUD_ALERT = :fraud_alert
+          HIGHER_EDUCATION = :higher_education
+          MARKETING = :marketing
+          POLLING_VOTING = :polling_voting
+          PUBLIC_SERVICE_ANNOUNCEMENT = :public_service_announcement
+          SECURITY_ALERT = :security_alert
+          TWO_FACTOR_AUTHENTICATION = :two_factor_authentication
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # This will be one of the following:
+        #
+        # - `low` - The campaign will be allowed to send up to 2000 SMS segments to
+        #   T-Mobile customers each day. In this case your platform will be charged for
+        #   the setup fee for a low volume number upon receipt of the API request.
+        # - `high` - The campaign will be allowed to send up to 200k SMS segments to
+        #   T-Mobile customers each day, depending on the trust score assigned by The
+        #   Campaign Registry. Your platform will be charged for the setup fee for a high
+        #   volume number upon receipt of the API request, and phone numbers will be
+        #   charged as high volume numbers going forward.
+        #
+        # @see SurgeAPI::Models::CampaignParams::StandardCampaignParams#volume
+        module Volume
+          extend SurgeAPI::Internal::Type::Enum
+
+          HIGH = :high
+          LOW = :low
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        module Include
+          extend SurgeAPI::Internal::Type::Enum
+
+          LINKS = :links
+          PHONE_NUMBERS = :phone_numbers
+          AGE_GATED = :age_gated
+          DIRECT_LENDING = :direct_lending
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      class ExternalCampaignParams < SurgeAPI::Internal::Type::BaseModel
+        # @!attribute tcr_id
+        #   The Campaign Registry (TCR) ID for the externally registered campaign
+        #
+        #   @return [String]
+        required :tcr_id, String
+
+        # @!method initialize(tcr_id:)
+        #   Import an externally registered campaign from The Campaign Registry (TCR)
+        #
+        #   @param tcr_id [String] The Campaign Registry (TCR) ID for the externally registered campaign
+      end
+
+      # @!method self.variants
+      #   @return [Array(SurgeAPI::Models::CampaignParams::StandardCampaignParams, SurgeAPI::Models::CampaignParams::ExternalCampaignParams)]
+    end
+  end
+end

data/lib/surge_api/models/contact_opted_in_webhook_event.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    class ContactOptedInWebhookEvent < SurgeAPI::Internal::Type::BaseModel
+      # @!attribute account_id
+      #   The ID of the account in which this event occurred
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute data
+      #   The data associated with the event
+      #
+      #   @return [SurgeAPI::Models::ContactOptedInWebhookEvent::Data]
+      required :data, -> { SurgeAPI::ContactOptedInWebhookEvent::Data }
+
+      # @!attribute timestamp
+      #   The timestamp when this event occurred, in ISO8601 format
+      #
+      #   @return [Time]
+      required :timestamp, Time
+
+      # @!attribute type
+      #   The type of the event. Always `contact.opted_in` for this event.
+      #
+      #   @return [Symbol, :"contact.opted_in"]
+      required :type, const: :"contact.opted_in"
+
+      # @!method initialize(account_id:, data:, timestamp:, type: :"contact.opted_in")
+      #   @param account_id [String] The ID of the account in which this event occurred
+      #
+      #   @param data [SurgeAPI::Models::ContactOptedInWebhookEvent::Data] The data associated with the event
+      #
+      #   @param timestamp [Time] The timestamp when this event occurred, in ISO8601 format
+      #
+      #   @param type [Symbol, :"contact.opted_in"] The type of the event. Always `contact.opted_in` for this event.
+
+      # @see SurgeAPI::Models::ContactOptedInWebhookEvent#data
+      class Data < SurgeAPI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique identifier for the contact
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!method initialize(id:)
+        #   The data associated with the event
+        #
+        #   @param id [String] The unique identifier for the contact
+      end
+    end
+  end
+end

data/lib/surge_api/models/contact_opted_out_webhook_event.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module SurgeAPI
+  module Models
+    class ContactOptedOutWebhookEvent < SurgeAPI::Internal::Type::BaseModel
+      # @!attribute account_id
+      #   The ID of the account in which this event occurred
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute data
+      #   The data associated with the event
+      #
+      #   @return [SurgeAPI::Models::ContactOptedOutWebhookEvent::Data]
+      required :data, -> { SurgeAPI::ContactOptedOutWebhookEvent::Data }
+
+      # @!attribute timestamp
+      #   The timestamp when this event occurred, in ISO8601 format
+      #
+      #   @return [Time]
+      required :timestamp, Time
+
+      # @!attribute type
+      #   The type of the event. Always `contact.opted_out` for this event.
+      #
+      #   @return [Symbol, :"contact.opted_out"]
+      required :type, const: :"contact.opted_out"
+
+      # @!method initialize(account_id:, data:, timestamp:, type: :"contact.opted_out")
+      #   @param account_id [String] The ID of the account in which this event occurred
+      #
+      #   @param data [SurgeAPI::Models::ContactOptedOutWebhookEvent::Data] The data associated with the event
+      #
+      #   @param timestamp [Time] The timestamp when this event occurred, in ISO8601 format
+      #
+      #   @param type [Symbol, :"contact.opted_out"] The type of the event. Always `contact.opted_out` for this event.
+
+      # @see SurgeAPI::Models::ContactOptedOutWebhookEvent#data
+      class Data < SurgeAPI::Internal::Type::BaseModel
+        # @!attribute id
+        #   The unique identifier for the contact
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!method initialize(id:)
+        #   The data associated with the event
+        #
+        #   @param id [String] The unique identifier for the contact
+      end
+    end
+  end
+end