growsurf-ruby 0.0.2

data/sig/growsurf_ruby/models/campaign/participant_send_invites_params.rbs

@@ -0,0 +1,48 @@
+module GrowsurfRuby
+  module Models
+    module Campaign
+      type participant_send_invites_params =
+        {
+          id: String,
+          participant_id_or_email: String,
+          email_addresses: ::Array[String],
+          message_text: String,
+          subject_text: String
+        }
+        & GrowsurfRuby::Internal::Type::request_parameters
+
+      class ParticipantSendInvitesParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        attr_accessor id: String
+
+        attr_accessor participant_id_or_email: String
+
+        attr_accessor email_addresses: ::Array[String]
+
+        attr_accessor message_text: String
+
+        attr_accessor subject_text: String
+
+        def initialize: (
+          id: String,
+          participant_id_or_email: String,
+          email_addresses: ::Array[String],
+          message_text: String,
+          subject_text: String,
+          ?request_options: GrowsurfRuby::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          participant_id_or_email: String,
+          email_addresses: ::Array[String],
+          message_text: String,
+          subject_text: String,
+          request_options: GrowsurfRuby::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/growsurf_ruby/models/campaign/participant_send_invites_response.rbs

@@ -0,0 +1,28 @@
+module GrowsurfRuby
+  module Models
+    module Campaign
+      type participant_send_invites_response =
+        { invites_sent: Integer, message_type: String, success: bool }
+
+      class ParticipantSendInvitesResponse < GrowsurfRuby::Internal::Type::BaseModel
+        attr_accessor invites_sent: Integer
+
+        attr_accessor message_type: String
+
+        attr_accessor success: bool
+
+        def initialize: (
+          invites_sent: Integer,
+          message_type: String,
+          success: bool
+        ) -> void
+
+        def to_hash: -> {
+          invites_sent: Integer,
+          message_type: String,
+          success: bool
+        }
+      end
+    end
+  end
+end

data/sig/growsurf_ruby/models/campaign/participant_trigger_referral_params.rbs

@@ -0,0 +1,30 @@
+module GrowsurfRuby
+  module Models
+    module Campaign
+      type participant_trigger_referral_params =
+        { id: String, participant_id_or_email: String }
+        & GrowsurfRuby::Internal::Type::request_parameters
+
+      class ParticipantTriggerReferralParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        attr_accessor id: String
+
+        attr_accessor participant_id_or_email: String
+
+        def initialize: (
+          id: String,
+          participant_id_or_email: String,
+          ?request_options: GrowsurfRuby::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          participant_id_or_email: String,
+          request_options: GrowsurfRuby::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/growsurf_ruby/models/campaign/participant_trigger_referral_response.rbs

@@ -0,0 +1,20 @@
+module GrowsurfRuby
+  module Models
+    module Campaign
+      type participant_trigger_referral_response =
+        { success: bool, message: String }
+
+      class ParticipantTriggerReferralResponse < GrowsurfRuby::Internal::Type::BaseModel
+        attr_accessor success: bool
+
+        attr_reader message: String?
+
+        def message=: (String) -> String
+
+        def initialize: (success: bool, ?message: String) -> void
+
+        def to_hash: -> { success: bool, message: String }
+      end
+    end
+  end
+end

data/sig/growsurf_ruby/models/campaign/participant_update_params.rbs

@@ -0,0 +1,104 @@
+module GrowsurfRuby
+  module Models
+    module Campaign
+      type participant_update_params =
+        {
+          id: String,
+          participant_id_or_email: String,
+          email: String,
+          first_name: String,
+          last_name: String,
+          metadata: ::Hash[Symbol, top],
+          referral_status: GrowsurfRuby::Models::Campaign::ParticipantUpdateParams::referral_status,
+          referred_by: String,
+          unsubscribed: bool,
+          vanity_keys: ::Array[String]
+        }
+        & GrowsurfRuby::Internal::Type::request_parameters
+
+      class ParticipantUpdateParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        attr_accessor id: String
+
+        attr_accessor participant_id_or_email: String
+
+        attr_reader email: String?
+
+        def email=: (String) -> String
+
+        attr_reader first_name: String?
+
+        def first_name=: (String) -> String
+
+        attr_reader last_name: String?
+
+        def last_name=: (String) -> String
+
+        attr_reader metadata: ::Hash[Symbol, top]?
+
+        def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+        attr_reader referral_status: GrowsurfRuby::Models::Campaign::ParticipantUpdateParams::referral_status?
+
+        def referral_status=: (
+          GrowsurfRuby::Models::Campaign::ParticipantUpdateParams::referral_status
+        ) -> GrowsurfRuby::Models::Campaign::ParticipantUpdateParams::referral_status
+
+        attr_reader referred_by: String?
+
+        def referred_by=: (String) -> String
+
+        attr_reader unsubscribed: bool?
+
+        def unsubscribed=: (bool) -> bool
+
+        attr_reader vanity_keys: ::Array[String]?
+
+        def vanity_keys=: (::Array[String]) -> ::Array[String]
+
+        def initialize: (
+          id: String,
+          participant_id_or_email: String,
+          ?email: String,
+          ?first_name: String,
+          ?last_name: String,
+          ?metadata: ::Hash[Symbol, top],
+          ?referral_status: GrowsurfRuby::Models::Campaign::ParticipantUpdateParams::referral_status,
+          ?referred_by: String,
+          ?unsubscribed: bool,
+          ?vanity_keys: ::Array[String],
+          ?request_options: GrowsurfRuby::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          participant_id_or_email: String,
+          email: String,
+          first_name: String,
+          last_name: String,
+          metadata: ::Hash[Symbol, top],
+          referral_status: GrowsurfRuby::Models::Campaign::ParticipantUpdateParams::referral_status,
+          referred_by: String,
+          unsubscribed: bool,
+          vanity_keys: ::Array[String],
+          request_options: GrowsurfRuby::RequestOptions
+        }
+
+        type referral_status =
+          :CREDIT_PENDING | :CREDIT_AWARDED | :CREDIT_EXPIRED
+
+        module ReferralStatus
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          CREDIT_PENDING: :CREDIT_PENDING
+          CREDIT_AWARDED: :CREDIT_AWARDED
+          CREDIT_EXPIRED: :CREDIT_EXPIRED
+
+          def self?.values: -> ::Array[GrowsurfRuby::Models::Campaign::ParticipantUpdateParams::referral_status]
+        end
+      end
+    end
+  end
+end

data/sig/growsurf_ruby/models/campaign/referral_source.rbs

@@ -0,0 +1,16 @@
+module GrowsurfRuby
+  module Models
+    module Campaign
+      type referral_source = :DIRECT | :PARTICIPANT
+
+      module ReferralSource
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        DIRECT: :DIRECT
+        PARTICIPANT: :PARTICIPANT
+
+        def self?.values: -> ::Array[GrowsurfRuby::Models::Campaign::referral_source]
+      end
+    end
+  end
+end

data/sig/growsurf_ruby/models/campaign/referral_status.rbs

@@ -0,0 +1,19 @@
+module GrowsurfRuby
+  module Models
+    module Campaign
+      type referral_status =
+        :CREDIT_PENDING | :CREDIT_AWARDED | :CREDIT_EXPIRED | :INVITE_SENT
+
+      module ReferralStatus
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        CREDIT_PENDING: :CREDIT_PENDING
+        CREDIT_AWARDED: :CREDIT_AWARDED
+        CREDIT_EXPIRED: :CREDIT_EXPIRED
+        INVITE_SENT: :INVITE_SENT
+
+        def self?.values: -> ::Array[GrowsurfRuby::Models::Campaign::referral_status]
+      end
+    end
+  end
+end

data/sig/growsurf_ruby/models/campaign/reward_approve_params.rbs

@@ -0,0 +1,36 @@
+module GrowsurfRuby
+  module Models
+    module Campaign
+      type reward_approve_params =
+        { id: String, reward_id: String, fulfill: bool }
+        & GrowsurfRuby::Internal::Type::request_parameters
+
+      class RewardApproveParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        attr_accessor id: String
+
+        attr_accessor reward_id: String
+
+        attr_reader fulfill: bool?
+
+        def fulfill=: (bool) -> bool
+
+        def initialize: (
+          id: String,
+          reward_id: String,
+          ?fulfill: bool,
+          ?request_options: GrowsurfRuby::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          reward_id: String,
+          fulfill: bool,
+          request_options: GrowsurfRuby::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/growsurf_ruby/models/campaign/reward_approve_response.rbs

@@ -0,0 +1,15 @@
+module GrowsurfRuby
+  module Models
+    module Campaign
+      type reward_approve_response = { success: bool }
+
+      class RewardApproveResponse < GrowsurfRuby::Internal::Type::BaseModel
+        attr_accessor success: bool
+
+        def initialize: (success: bool) -> void
+
+        def to_hash: -> { success: bool }
+      end
+    end
+  end
+end

data/sig/growsurf_ruby/models/campaign/reward_delete_params.rbs

@@ -0,0 +1,30 @@
+module GrowsurfRuby
+  module Models
+    module Campaign
+      type reward_delete_params =
+        { id: String, reward_id: String }
+        & GrowsurfRuby::Internal::Type::request_parameters
+
+      class RewardDeleteParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        attr_accessor id: String
+
+        attr_accessor reward_id: String
+
+        def initialize: (
+          id: String,
+          reward_id: String,
+          ?request_options: GrowsurfRuby::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          reward_id: String,
+          request_options: GrowsurfRuby::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/growsurf_ruby/models/campaign/reward_delete_response.rbs

@@ -0,0 +1,15 @@
+module GrowsurfRuby
+  module Models
+    module Campaign
+      type reward_delete_response = { success: bool }
+
+      class RewardDeleteResponse < GrowsurfRuby::Internal::Type::BaseModel
+        attr_accessor success: bool
+
+        def initialize: (success: bool) -> void
+
+        def to_hash: -> { success: bool }
+      end
+    end
+  end
+end

data/sig/growsurf_ruby/models/campaign/reward_fulfill_params.rbs

@@ -0,0 +1,30 @@
+module GrowsurfRuby
+  module Models
+    module Campaign
+      type reward_fulfill_params =
+        { id: String, reward_id: String }
+        & GrowsurfRuby::Internal::Type::request_parameters
+
+      class RewardFulfillParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        attr_accessor id: String
+
+        attr_accessor reward_id: String
+
+        def initialize: (
+          id: String,
+          reward_id: String,
+          ?request_options: GrowsurfRuby::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          reward_id: String,
+          request_options: GrowsurfRuby::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/growsurf_ruby/models/campaign/reward_fulfill_response.rbs

@@ -0,0 +1,15 @@
+module GrowsurfRuby
+  module Models
+    module Campaign
+      type reward_fulfill_response = { success: bool }
+
+      class RewardFulfillResponse < GrowsurfRuby::Internal::Type::BaseModel
+        attr_accessor success: bool
+
+        def initialize: (success: bool) -> void
+
+        def to_hash: -> { success: bool }
+      end
+    end
+  end
+end

data/sig/growsurf_ruby/models/campaign.rbs

@@ -0,0 +1,221 @@
+module GrowsurfRuby
+  module Models
+    type campaign_api =
+      {
+        id: String,
+        impression_count: Integer,
+        invite_count: Integer,
+        name: String,
+        participant_count: Integer,
+        referral_count: Integer,
+        rewards: ::Array[GrowsurfRuby::CampaignAPI::Reward],
+        status: GrowsurfRuby::Models::CampaignAPI::status,
+        type: GrowsurfRuby::Models::CampaignAPI::type_,
+        winner_count: Integer,
+        currency_iso: String
+      }
+
+    class CampaignAPI < GrowsurfRuby::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor impression_count: Integer
+
+      attr_accessor invite_count: Integer
+
+      attr_accessor name: String
+
+      attr_accessor participant_count: Integer
+
+      attr_accessor referral_count: Integer
+
+      attr_accessor rewards: ::Array[GrowsurfRuby::CampaignAPI::Reward]
+
+      attr_accessor status: GrowsurfRuby::Models::CampaignAPI::status
+
+      attr_accessor type: GrowsurfRuby::Models::CampaignAPI::type_
+
+      attr_accessor winner_count: Integer
+
+      attr_reader currency_iso: String?
+
+      def currency_iso=: (String) -> String
+
+      def initialize: (
+        id: String,
+        impression_count: Integer,
+        invite_count: Integer,
+        name: String,
+        participant_count: Integer,
+        referral_count: Integer,
+        rewards: ::Array[GrowsurfRuby::CampaignAPI::Reward],
+        status: GrowsurfRuby::Models::CampaignAPI::status,
+        type: GrowsurfRuby::Models::CampaignAPI::type_,
+        winner_count: Integer,
+        ?currency_iso: String
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        impression_count: Integer,
+        invite_count: Integer,
+        name: String,
+        participant_count: Integer,
+        referral_count: Integer,
+        rewards: ::Array[GrowsurfRuby::CampaignAPI::Reward],
+        status: GrowsurfRuby::Models::CampaignAPI::status,
+        type: GrowsurfRuby::Models::CampaignAPI::type_,
+        winner_count: Integer,
+        currency_iso: String
+      }
+
+      type reward =
+        {
+          id: String,
+          is_unlimited: bool,
+          metadata: ::Hash[Symbol, top],
+          type: GrowsurfRuby::Models::CampaignAPI::Reward::type_,
+          commission_structure: GrowsurfRuby::CommissionStructure?,
+          conversions_required: Integer?,
+          coupon_code: String?,
+          description: String?,
+          image_url: String?,
+          limit: Integer?,
+          limit_duration: GrowsurfRuby::Models::CampaignAPI::Reward::limit_duration?,
+          next_milestone_prefix: String?,
+          next_milestone_suffix: String?,
+          number_of_winners: Integer?,
+          order: Integer?,
+          referral_description: String?,
+          referred_reward_upfront: bool
+        }
+
+      class Reward < GrowsurfRuby::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor is_unlimited: bool
+
+        attr_accessor metadata: ::Hash[Symbol, top]
+
+        attr_accessor type: GrowsurfRuby::Models::CampaignAPI::Reward::type_
+
+        attr_accessor commission_structure: GrowsurfRuby::CommissionStructure?
+
+        attr_accessor conversions_required: Integer?
+
+        attr_accessor coupon_code: String?
+
+        attr_accessor description: String?
+
+        attr_accessor image_url: String?
+
+        attr_accessor limit: Integer?
+
+        attr_accessor limit_duration: GrowsurfRuby::Models::CampaignAPI::Reward::limit_duration?
+
+        attr_accessor next_milestone_prefix: String?
+
+        attr_accessor next_milestone_suffix: String?
+
+        attr_accessor number_of_winners: Integer?
+
+        attr_accessor order: Integer?
+
+        attr_accessor referral_description: String?
+
+        attr_reader referred_reward_upfront: bool?
+
+        def referred_reward_upfront=: (bool) -> bool
+
+        def initialize: (
+          id: String,
+          is_unlimited: bool,
+          metadata: ::Hash[Symbol, top],
+          type: GrowsurfRuby::Models::CampaignAPI::Reward::type_,
+          ?commission_structure: GrowsurfRuby::CommissionStructure?,
+          ?conversions_required: Integer?,
+          ?coupon_code: String?,
+          ?description: String?,
+          ?image_url: String?,
+          ?limit: Integer?,
+          ?limit_duration: GrowsurfRuby::Models::CampaignAPI::Reward::limit_duration?,
+          ?next_milestone_prefix: String?,
+          ?next_milestone_suffix: String?,
+          ?number_of_winners: Integer?,
+          ?order: Integer?,
+          ?referral_description: String?,
+          ?referred_reward_upfront: bool
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          is_unlimited: bool,
+          metadata: ::Hash[Symbol, top],
+          type: GrowsurfRuby::Models::CampaignAPI::Reward::type_,
+          commission_structure: GrowsurfRuby::CommissionStructure?,
+          conversions_required: Integer?,
+          coupon_code: String?,
+          description: String?,
+          image_url: String?,
+          limit: Integer?,
+          limit_duration: GrowsurfRuby::Models::CampaignAPI::Reward::limit_duration?,
+          next_milestone_prefix: String?,
+          next_milestone_suffix: String?,
+          number_of_winners: Integer?,
+          order: Integer?,
+          referral_description: String?,
+          referred_reward_upfront: bool
+        }
+
+        type type_ =
+          :SINGLE_SIDED | :DOUBLE_SIDED | :MILESTONE | :LEADERBOARD | :AFFILIATE
+
+        module Type
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          SINGLE_SIDED: :SINGLE_SIDED
+          DOUBLE_SIDED: :DOUBLE_SIDED
+          MILESTONE: :MILESTONE
+          LEADERBOARD: :LEADERBOARD
+          AFFILIATE: :AFFILIATE
+
+          def self?.values: -> ::Array[GrowsurfRuby::Models::CampaignAPI::Reward::type_]
+        end
+
+        type limit_duration = :IN_TOTAL | :PER_MONTH
+
+        module LimitDuration
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          IN_TOTAL: :IN_TOTAL
+          PER_MONTH: :PER_MONTH
+
+          def self?.values: -> ::Array[GrowsurfRuby::Models::CampaignAPI::Reward::limit_duration]
+        end
+      end
+
+      type status = :DRAFT | :IN_PROGRESS | :COMPLETE | :DELETED
+
+      module Status
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        DRAFT: :DRAFT
+        IN_PROGRESS: :IN_PROGRESS
+        COMPLETE: :COMPLETE
+        DELETED: :DELETED
+
+        def self?.values: -> ::Array[GrowsurfRuby::Models::CampaignAPI::status]
+      end
+
+      type type_ = :REFERRAL | :AFFILIATE
+
+      module Type
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        REFERRAL: :REFERRAL
+        AFFILIATE: :AFFILIATE
+
+        def self?.values: -> ::Array[GrowsurfRuby::Models::CampaignAPI::type_]
+      end
+    end
+  end
+end