growsurf-ruby 0.0.2

data/sig/growsurf_ruby/models/commission_structure.rbs

@@ -0,0 +1,121 @@
+module GrowsurfRuby
+  module Models
+    type commission_structure =
+      {
+        amount: Integer?,
+        approval_required: bool?,
+        duration: String?,
+        duration_in_months: Integer?,
+        event: String?,
+        has_intro: bool?,
+        has_max_amount: bool?,
+        hold_duration: Integer?,
+        intro_amount: Integer?,
+        intro_amount_iso: String?,
+        intro_duration: String?,
+        intro_duration_in_months: Integer?,
+        intro_percent: Float?,
+        intro_type: String?,
+        max_amount: Integer?,
+        max_amount_iso: String?,
+        min_paid_referrals: Integer?,
+        percent: Float?,
+        type: GrowsurfRuby::Models::CommissionStructure::type_?
+      }
+
+    class CommissionStructure < GrowsurfRuby::Internal::Type::BaseModel
+      attr_accessor amount: Integer?
+
+      attr_accessor approval_required: bool?
+
+      attr_accessor duration: String?
+
+      attr_accessor duration_in_months: Integer?
+
+      attr_accessor event: String?
+
+      attr_accessor has_intro: bool?
+
+      attr_accessor has_max_amount: bool?
+
+      attr_accessor hold_duration: Integer?
+
+      attr_accessor intro_amount: Integer?
+
+      attr_accessor intro_amount_iso: String?
+
+      attr_accessor intro_duration: String?
+
+      attr_accessor intro_duration_in_months: Integer?
+
+      attr_accessor intro_percent: Float?
+
+      attr_accessor intro_type: String?
+
+      attr_accessor max_amount: Integer?
+
+      attr_accessor max_amount_iso: String?
+
+      attr_accessor min_paid_referrals: Integer?
+
+      attr_accessor percent: Float?
+
+      attr_accessor type: GrowsurfRuby::Models::CommissionStructure::type_?
+
+      def initialize: (
+        ?amount: Integer?,
+        ?approval_required: bool?,
+        ?duration: String?,
+        ?duration_in_months: Integer?,
+        ?event: String?,
+        ?has_intro: bool?,
+        ?has_max_amount: bool?,
+        ?hold_duration: Integer?,
+        ?intro_amount: Integer?,
+        ?intro_amount_iso: String?,
+        ?intro_duration: String?,
+        ?intro_duration_in_months: Integer?,
+        ?intro_percent: Float?,
+        ?intro_type: String?,
+        ?max_amount: Integer?,
+        ?max_amount_iso: String?,
+        ?min_paid_referrals: Integer?,
+        ?percent: Float?,
+        ?type: GrowsurfRuby::Models::CommissionStructure::type_?
+      ) -> void
+
+      def to_hash: -> {
+        amount: Integer?,
+        approval_required: bool?,
+        duration: String?,
+        duration_in_months: Integer?,
+        event: String?,
+        has_intro: bool?,
+        has_max_amount: bool?,
+        hold_duration: Integer?,
+        intro_amount: Integer?,
+        intro_amount_iso: String?,
+        intro_duration: String?,
+        intro_duration_in_months: Integer?,
+        intro_percent: Float?,
+        intro_type: String?,
+        max_amount: Integer?,
+        max_amount_iso: String?,
+        min_paid_referrals: Integer?,
+        percent: Float?,
+        type: GrowsurfRuby::Models::CommissionStructure::type_?
+      }
+
+      type type_ = :PERCENT | :AMOUNT
+
+      module Type
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        PERCENT: :PERCENT
+        AMOUNT: :AMOUNT
+
+        def self?.values: -> ::Array[GrowsurfRuby::Models::CommissionStructure::type_]
+      end
+    end
+  end
+end

data/sig/growsurf_ruby/models/participant_commission_list.rbs

@@ -0,0 +1,166 @@
+module GrowsurfRuby
+  module Models
+    type participant_commission_list =
+      {
+        commissions: ::Array[GrowsurfRuby::ParticipantCommissionList::Commission],
+        limit: Integer,
+        next_id: String?
+      }
+
+    class ParticipantCommissionList < GrowsurfRuby::Internal::Type::BaseModel
+      attr_accessor commissions: ::Array[GrowsurfRuby::ParticipantCommissionList::Commission]
+
+      attr_accessor limit: Integer
+
+      attr_accessor next_id: String?
+
+      def initialize: (
+        commissions: ::Array[GrowsurfRuby::ParticipantCommissionList::Commission],
+        limit: Integer,
+        next_id: String?
+      ) -> void
+
+      def to_hash: -> {
+        commissions: ::Array[GrowsurfRuby::ParticipantCommissionList::Commission],
+        limit: Integer,
+        next_id: String?
+      }
+
+      type commission =
+        {
+          id: String,
+          amount: Integer,
+          created_at: Integer,
+          currency_iso: String,
+          referred_id: String,
+          referrer_id: String,
+          sale_amount: Integer,
+          status: GrowsurfRuby::Models::ParticipantCommissionList::Commission::status,
+          amount_in_campaign_currency: Integer?,
+          approved_at: Integer,
+          campaign_currency_iso: String?,
+          exchange_rate: Float?,
+          exchange_rate_at: Integer,
+          fx_error: String?,
+          hold_duration: Integer?,
+          paid_at: Integer,
+          payout_queued_at: Integer,
+          provider: String?,
+          reversed_at: Integer,
+          sale_amount_amount_in_campaign_currency: Integer?
+        }
+
+      class Commission < GrowsurfRuby::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor amount: Integer
+
+        attr_accessor created_at: Integer
+
+        attr_accessor currency_iso: String
+
+        attr_accessor referred_id: String
+
+        attr_accessor referrer_id: String
+
+        attr_accessor sale_amount: Integer
+
+        attr_accessor status: GrowsurfRuby::Models::ParticipantCommissionList::Commission::status
+
+        attr_accessor amount_in_campaign_currency: Integer?
+
+        attr_reader approved_at: Integer?
+
+        def approved_at=: (Integer) -> Integer
+
+        attr_accessor campaign_currency_iso: String?
+
+        attr_accessor exchange_rate: Float?
+
+        attr_reader exchange_rate_at: Integer?
+
+        def exchange_rate_at=: (Integer) -> Integer
+
+        attr_accessor fx_error: String?
+
+        attr_accessor hold_duration: Integer?
+
+        attr_reader paid_at: Integer?
+
+        def paid_at=: (Integer) -> Integer
+
+        attr_reader payout_queued_at: Integer?
+
+        def payout_queued_at=: (Integer) -> Integer
+
+        attr_accessor provider: String?
+
+        attr_reader reversed_at: Integer?
+
+        def reversed_at=: (Integer) -> Integer
+
+        attr_accessor sale_amount_amount_in_campaign_currency: Integer?
+
+        def initialize: (
+          id: String,
+          amount: Integer,
+          created_at: Integer,
+          currency_iso: String,
+          referred_id: String,
+          referrer_id: String,
+          sale_amount: Integer,
+          status: GrowsurfRuby::Models::ParticipantCommissionList::Commission::status,
+          ?amount_in_campaign_currency: Integer?,
+          ?approved_at: Integer,
+          ?campaign_currency_iso: String?,
+          ?exchange_rate: Float?,
+          ?exchange_rate_at: Integer,
+          ?fx_error: String?,
+          ?hold_duration: Integer?,
+          ?paid_at: Integer,
+          ?payout_queued_at: Integer,
+          ?provider: String?,
+          ?reversed_at: Integer,
+          ?sale_amount_amount_in_campaign_currency: Integer?
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          amount: Integer,
+          created_at: Integer,
+          currency_iso: String,
+          referred_id: String,
+          referrer_id: String,
+          sale_amount: Integer,
+          status: GrowsurfRuby::Models::ParticipantCommissionList::Commission::status,
+          amount_in_campaign_currency: Integer?,
+          approved_at: Integer,
+          campaign_currency_iso: String?,
+          exchange_rate: Float?,
+          exchange_rate_at: Integer,
+          fx_error: String?,
+          hold_duration: Integer?,
+          paid_at: Integer,
+          payout_queued_at: Integer,
+          provider: String?,
+          reversed_at: Integer,
+          sale_amount_amount_in_campaign_currency: Integer?
+        }
+
+        type status = :PENDING | :APPROVED | :PAID | :REVERSED | :DELETED
+
+        module Status
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          PENDING: :PENDING
+          APPROVED: :APPROVED
+          PAID: :PAID
+          REVERSED: :REVERSED
+          DELETED: :DELETED
+
+          def self?.values: -> ::Array[GrowsurfRuby::Models::ParticipantCommissionList::Commission::status]
+        end
+      end
+    end
+  end
+end

data/sig/growsurf_ruby/models/participant_list.rbs

@@ -0,0 +1,30 @@
+module GrowsurfRuby
+  module Models
+    type participant_list =
+      {
+        limit: Integer,
+        next_id: String?,
+        participants: ::Array[GrowsurfRuby::Campaign::CampaignParticipant]
+      }
+
+    class ParticipantList < GrowsurfRuby::Internal::Type::BaseModel
+      attr_accessor limit: Integer
+
+      attr_accessor next_id: String?
+
+      attr_accessor participants: ::Array[GrowsurfRuby::Campaign::CampaignParticipant]
+
+      def initialize: (
+        limit: Integer,
+        next_id: String?,
+        participants: ::Array[GrowsurfRuby::Campaign::CampaignParticipant]
+      ) -> void
+
+      def to_hash: -> {
+        limit: Integer,
+        next_id: String?,
+        participants: ::Array[GrowsurfRuby::Campaign::CampaignParticipant]
+      }
+    end
+  end
+end

data/sig/growsurf_ruby/models/participant_payout_list.rbs

@@ -0,0 +1,136 @@
+module GrowsurfRuby
+  module Models
+    type participant_payout_list =
+      {
+        limit: Integer,
+        next_id: String?,
+        payouts: ::Array[GrowsurfRuby::ParticipantPayoutList::Payout]
+      }
+
+    class ParticipantPayoutList < GrowsurfRuby::Internal::Type::BaseModel
+      attr_accessor limit: Integer
+
+      attr_accessor next_id: String?
+
+      attr_accessor payouts: ::Array[GrowsurfRuby::ParticipantPayoutList::Payout]
+
+      def initialize: (
+        limit: Integer,
+        next_id: String?,
+        payouts: ::Array[GrowsurfRuby::ParticipantPayoutList::Payout]
+      ) -> void
+
+      def to_hash: -> {
+        limit: Integer,
+        next_id: String?,
+        payouts: ::Array[GrowsurfRuby::ParticipantPayoutList::Payout]
+      }
+
+      type payout =
+        {
+          id: String,
+          amount: Integer,
+          commission_ids: ::Array[String],
+          created_at: Integer,
+          currency_iso: String,
+          participant_id: String,
+          status: GrowsurfRuby::Models::ParticipantPayoutList::Payout::status,
+          amount_in_campaign_currency: Integer?,
+          campaign_currency_iso: String?,
+          exchange_rate: Float?,
+          exchange_rate_at: Integer,
+          failed_at: Integer,
+          fx_error: String?,
+          issued_at: Integer,
+          provider: String?
+        }
+
+      class Payout < GrowsurfRuby::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor amount: Integer
+
+        attr_accessor commission_ids: ::Array[String]
+
+        attr_accessor created_at: Integer
+
+        attr_accessor currency_iso: String
+
+        attr_accessor participant_id: String
+
+        attr_accessor status: GrowsurfRuby::Models::ParticipantPayoutList::Payout::status
+
+        attr_accessor amount_in_campaign_currency: Integer?
+
+        attr_accessor campaign_currency_iso: String?
+
+        attr_accessor exchange_rate: Float?
+
+        attr_reader exchange_rate_at: Integer?
+
+        def exchange_rate_at=: (Integer) -> Integer
+
+        attr_reader failed_at: Integer?
+
+        def failed_at=: (Integer) -> Integer
+
+        attr_accessor fx_error: String?
+
+        attr_reader issued_at: Integer?
+
+        def issued_at=: (Integer) -> Integer
+
+        attr_accessor provider: String?
+
+        def initialize: (
+          id: String,
+          amount: Integer,
+          commission_ids: ::Array[String],
+          created_at: Integer,
+          currency_iso: String,
+          participant_id: String,
+          status: GrowsurfRuby::Models::ParticipantPayoutList::Payout::status,
+          ?amount_in_campaign_currency: Integer?,
+          ?campaign_currency_iso: String?,
+          ?exchange_rate: Float?,
+          ?exchange_rate_at: Integer,
+          ?failed_at: Integer,
+          ?fx_error: String?,
+          ?issued_at: Integer,
+          ?provider: String?
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          amount: Integer,
+          commission_ids: ::Array[String],
+          created_at: Integer,
+          currency_iso: String,
+          participant_id: String,
+          status: GrowsurfRuby::Models::ParticipantPayoutList::Payout::status,
+          amount_in_campaign_currency: Integer?,
+          campaign_currency_iso: String?,
+          exchange_rate: Float?,
+          exchange_rate_at: Integer,
+          failed_at: Integer,
+          fx_error: String?,
+          issued_at: Integer,
+          provider: String?
+        }
+
+        type status = :UPCOMING | :QUEUED | :ISSUED | :FAILED
+
+        module Status
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          UPCOMING: :UPCOMING
+          QUEUED: :QUEUED
+          ISSUED: :ISSUED
+          FAILED: :FAILED
+
+          def self?.values: -> ::Array[GrowsurfRuby::Models::ParticipantPayoutList::Payout::status]
+        end
+      end
+    end
+  end
+end

data/sig/growsurf_ruby/models/referral_list.rbs

@@ -0,0 +1,92 @@
+module GrowsurfRuby
+  module Models
+    type referral_list =
+      {
+        limit: Integer,
+        more: bool,
+        referrals: ::Array[GrowsurfRuby::ReferralList::Referral],
+        next_id: String?,
+        next_offset: Integer?
+      }
+
+    class ReferralList < GrowsurfRuby::Internal::Type::BaseModel
+      attr_accessor limit: Integer
+
+      attr_accessor more: bool
+
+      attr_accessor referrals: ::Array[GrowsurfRuby::ReferralList::Referral]
+
+      attr_accessor next_id: String?
+
+      attr_accessor next_offset: Integer?
+
+      def initialize: (
+        limit: Integer,
+        more: bool,
+        referrals: ::Array[GrowsurfRuby::ReferralList::Referral],
+        ?next_id: String?,
+        ?next_offset: Integer?
+      ) -> void
+
+      def to_hash: -> {
+        limit: Integer,
+        more: bool,
+        referrals: ::Array[GrowsurfRuby::ReferralList::Referral],
+        next_id: String?,
+        next_offset: Integer?
+      }
+
+      type referral =
+        {
+          id: String,
+          created_at: Integer,
+          email: String,
+          referral_status: GrowsurfRuby::Models::Campaign::referral_status,
+          referred_by: String,
+          updated_at: Integer,
+          first_name: String?,
+          last_name: String?
+        }
+
+      class Referral < GrowsurfRuby::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor created_at: Integer
+
+        attr_accessor email: String
+
+        attr_accessor referral_status: GrowsurfRuby::Models::Campaign::referral_status
+
+        attr_accessor referred_by: String
+
+        attr_accessor updated_at: Integer
+
+        attr_accessor first_name: String?
+
+        attr_accessor last_name: String?
+
+        def initialize: (
+          id: String,
+          created_at: Integer,
+          email: String,
+          referral_status: GrowsurfRuby::Models::Campaign::referral_status,
+          referred_by: String,
+          updated_at: Integer,
+          ?first_name: String?,
+          ?last_name: String?
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          created_at: Integer,
+          email: String,
+          referral_status: GrowsurfRuby::Models::Campaign::referral_status,
+          referred_by: String,
+          updated_at: Integer,
+          first_name: String?,
+          last_name: String?
+        }
+      end
+    end
+  end
+end

data/sig/growsurf_ruby/models.rbs

@@ -0,0 +1,31 @@
+module GrowsurfRuby
+  module Campaign = GrowsurfRuby::Models::Campaign
+
+  class CampaignAPI = GrowsurfRuby::Models::CampaignAPI
+
+  class CampaignListCommissionsParams = GrowsurfRuby::Models::CampaignListCommissionsParams
+
+  class CampaignListLeaderboardParams = GrowsurfRuby::Models::CampaignListLeaderboardParams
+
+  class CampaignListParams = GrowsurfRuby::Models::CampaignListParams
+
+  class CampaignListParticipantsParams = GrowsurfRuby::Models::CampaignListParticipantsParams
+
+  class CampaignListPayoutsParams = GrowsurfRuby::Models::CampaignListPayoutsParams
+
+  class CampaignListReferralsParams = GrowsurfRuby::Models::CampaignListReferralsParams
+
+  class CampaignRetrieveAnalyticsParams = GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams
+
+  class CampaignRetrieveParams = GrowsurfRuby::Models::CampaignRetrieveParams
+
+  class CommissionStructure = GrowsurfRuby::Models::CommissionStructure
+
+  class ParticipantCommissionList = GrowsurfRuby::Models::ParticipantCommissionList
+
+  class ParticipantList = GrowsurfRuby::Models::ParticipantList
+
+  class ParticipantPayoutList = GrowsurfRuby::Models::ParticipantPayoutList
+
+  class ReferralList = GrowsurfRuby::Models::ReferralList
+end

data/sig/growsurf_ruby/request_options.rbs

@@ -0,0 +1,36 @@
+module GrowsurfRuby
+  type request_opts =
+    GrowsurfRuby::RequestOptions
+    | GrowsurfRuby::request_options
+    | ::Hash[Symbol, top]
+
+  type request_options =
+    {
+      idempotency_key: String?,
+      extra_query: ::Hash[String, (::Array[String] | String)?]?,
+      extra_headers: ::Hash[String, String?]?,
+      extra_body: top?,
+      max_retries: Integer?,
+      timeout: Float?
+    }
+
+  class RequestOptions < GrowsurfRuby::Internal::Type::BaseModel
+    def self.validate!: (GrowsurfRuby::request_opts opts) -> void
+
+    attr_accessor idempotency_key: String?
+
+    attr_accessor extra_query: ::Hash[String, (::Array[String] | String)?]?
+
+    attr_accessor extra_headers: ::Hash[String, String?]?
+
+    attr_accessor extra_body: top?
+
+    attr_accessor max_retries: Integer?
+
+    attr_accessor timeout: Float?
+
+    def initialize: (
+      ?GrowsurfRuby::request_options | ::Hash[Symbol, top] values
+    ) -> void
+  end
+end

data/sig/growsurf_ruby/resources/campaign/commission.rbs

@@ -0,0 +1,21 @@
+module GrowsurfRuby
+  module Resources
+    class Campaign
+      class Commission
+        def delete: (
+          String commission_id,
+          id: String,
+          ?request_options: GrowsurfRuby::request_opts
+        ) -> GrowsurfRuby::Models::Campaign::CommissionDeleteResponse
+
+        def approve: (
+          String commission_id,
+          id: String,
+          ?request_options: GrowsurfRuby::request_opts
+        ) -> GrowsurfRuby::Models::Campaign::CommissionApproveResponse
+
+        def initialize: (client: GrowsurfRuby::Client) -> void
+      end
+    end
+  end
+end