growsurf-ruby 0.0.2

data/rbi/growsurf_ruby/models/campaign_list_participants_params.rbi

@@ -0,0 +1,66 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    class CampaignListParticipantsParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            GrowsurfRuby::CampaignListParticipantsParams,
+            GrowsurfRuby::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Number of results to return. Maximum 100.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :limit
+
+      sig { params(limit: Integer).void }
+      attr_writer :limit
+
+      # ID to start the next paged result set with.
+      sig { returns(T.nilable(String)) }
+      attr_reader :next_id
+
+      sig { params(next_id: String).void }
+      attr_writer :next_id
+
+      sig do
+        params(
+          id: String,
+          limit: Integer,
+          next_id: String,
+          request_options: GrowsurfRuby::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        # Number of results to return. Maximum 100.
+        limit: nil,
+        # ID to start the next paged result set with.
+        next_id: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            limit: Integer,
+            next_id: String,
+            request_options: GrowsurfRuby::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign_list_payouts_params.rbi

@@ -0,0 +1,127 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    class CampaignListPayoutsParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            GrowsurfRuby::CampaignListPayoutsParams,
+            GrowsurfRuby::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Number of results to return. Maximum 100.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :limit
+
+      sig { params(limit: Integer).void }
+      attr_writer :limit
+
+      # ID to start the next paged result set with.
+      sig { returns(T.nilable(String)) }
+      attr_reader :next_id
+
+      sig { params(next_id: String).void }
+      attr_writer :next_id
+
+      # Participant payout status.
+      sig do
+        returns(
+          T.nilable(GrowsurfRuby::CampaignListPayoutsParams::Status::OrSymbol)
+        )
+      end
+      attr_reader :status
+
+      sig do
+        params(
+          status: GrowsurfRuby::CampaignListPayoutsParams::Status::OrSymbol
+        ).void
+      end
+      attr_writer :status
+
+      sig do
+        params(
+          id: String,
+          limit: Integer,
+          next_id: String,
+          status: GrowsurfRuby::CampaignListPayoutsParams::Status::OrSymbol,
+          request_options: GrowsurfRuby::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        # Number of results to return. Maximum 100.
+        limit: nil,
+        # ID to start the next paged result set with.
+        next_id: nil,
+        # Participant payout status.
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            limit: Integer,
+            next_id: String,
+            status: GrowsurfRuby::CampaignListPayoutsParams::Status::OrSymbol,
+            request_options: GrowsurfRuby::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Participant payout status.
+      module Status
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, GrowsurfRuby::CampaignListPayoutsParams::Status)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        UPCOMING =
+          T.let(
+            :UPCOMING,
+            GrowsurfRuby::CampaignListPayoutsParams::Status::TaggedSymbol
+          )
+        QUEUED =
+          T.let(
+            :QUEUED,
+            GrowsurfRuby::CampaignListPayoutsParams::Status::TaggedSymbol
+          )
+        ISSUED =
+          T.let(
+            :ISSUED,
+            GrowsurfRuby::CampaignListPayoutsParams::Status::TaggedSymbol
+          )
+        FAILED =
+          T.let(
+            :FAILED,
+            GrowsurfRuby::CampaignListPayoutsParams::Status::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              GrowsurfRuby::CampaignListPayoutsParams::Status::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign_list_referrals_params.rbi

@@ -0,0 +1,213 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    class CampaignListReferralsParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            GrowsurfRuby::CampaignListReferralsParams,
+            GrowsurfRuby::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Return results in descending order when true.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :desc
+
+      sig { params(desc: T::Boolean).void }
+      attr_writer :desc
+
+      # URL-encoded email value to filter referral results.
+      sig { returns(T.nilable(String)) }
+      attr_reader :email
+
+      sig { params(email: String).void }
+      attr_writer :email
+
+      # First name value to filter results.
+      sig { returns(T.nilable(String)) }
+      attr_reader :first_name
+
+      sig { params(first_name: String).void }
+      attr_writer :first_name
+
+      # Last name value to filter results.
+      sig { returns(T.nilable(String)) }
+      attr_reader :last_name
+
+      sig { params(last_name: String).void }
+      attr_writer :last_name
+
+      # Number of results to return. Maximum 100.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :limit
+
+      sig { params(limit: Integer).void }
+      attr_writer :limit
+
+      # ID to start the next paged result set with.
+      sig { returns(T.nilable(String)) }
+      attr_reader :next_id
+
+      sig { params(next_id: String).void }
+      attr_writer :next_id
+
+      # Offset number used to skip through a result set.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :offset
+
+      sig { params(offset: Integer).void }
+      attr_writer :offset
+
+      sig do
+        returns(T.nilable(GrowsurfRuby::Campaign::ReferralStatus::OrSymbol))
+      end
+      attr_reader :referral_status
+
+      sig do
+        params(
+          referral_status: GrowsurfRuby::Campaign::ReferralStatus::OrSymbol
+        ).void
+      end
+      attr_writer :referral_status
+
+      # Field used to sort referral results.
+      sig do
+        returns(
+          T.nilable(GrowsurfRuby::CampaignListReferralsParams::SortBy::OrSymbol)
+        )
+      end
+      attr_reader :sort_by
+
+      sig do
+        params(
+          sort_by: GrowsurfRuby::CampaignListReferralsParams::SortBy::OrSymbol
+        ).void
+      end
+      attr_writer :sort_by
+
+      sig do
+        params(
+          id: String,
+          desc: T::Boolean,
+          email: String,
+          first_name: String,
+          last_name: String,
+          limit: Integer,
+          next_id: String,
+          offset: Integer,
+          referral_status: GrowsurfRuby::Campaign::ReferralStatus::OrSymbol,
+          sort_by: GrowsurfRuby::CampaignListReferralsParams::SortBy::OrSymbol,
+          request_options: GrowsurfRuby::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        # Return results in descending order when true.
+        desc: nil,
+        # URL-encoded email value to filter referral results.
+        email: nil,
+        # First name value to filter results.
+        first_name: nil,
+        # Last name value to filter results.
+        last_name: nil,
+        # Number of results to return. Maximum 100.
+        limit: nil,
+        # ID to start the next paged result set with.
+        next_id: nil,
+        # Offset number used to skip through a result set.
+        offset: nil,
+        referral_status: nil,
+        # Field used to sort referral results.
+        sort_by: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            desc: T::Boolean,
+            email: String,
+            first_name: String,
+            last_name: String,
+            limit: Integer,
+            next_id: String,
+            offset: Integer,
+            referral_status: GrowsurfRuby::Campaign::ReferralStatus::OrSymbol,
+            sort_by:
+              GrowsurfRuby::CampaignListReferralsParams::SortBy::OrSymbol,
+            request_options: GrowsurfRuby::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Field used to sort referral results.
+      module SortBy
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, GrowsurfRuby::CampaignListReferralsParams::SortBy)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        UPDATED_AT =
+          T.let(
+            :updatedAt,
+            GrowsurfRuby::CampaignListReferralsParams::SortBy::TaggedSymbol
+          )
+        CREATED_AT =
+          T.let(
+            :createdAt,
+            GrowsurfRuby::CampaignListReferralsParams::SortBy::TaggedSymbol
+          )
+        EMAIL =
+          T.let(
+            :email,
+            GrowsurfRuby::CampaignListReferralsParams::SortBy::TaggedSymbol
+          )
+        FIRST_NAME =
+          T.let(
+            :firstName,
+            GrowsurfRuby::CampaignListReferralsParams::SortBy::TaggedSymbol
+          )
+        LAST_NAME =
+          T.let(
+            :lastName,
+            GrowsurfRuby::CampaignListReferralsParams::SortBy::TaggedSymbol
+          )
+        REFERRAL_STATUS =
+          T.let(
+            :referralStatus,
+            GrowsurfRuby::CampaignListReferralsParams::SortBy::TaggedSymbol
+          )
+        REFERRAL_TRIGGERED_AT =
+          T.let(
+            :referralTriggeredAt,
+            GrowsurfRuby::CampaignListReferralsParams::SortBy::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              GrowsurfRuby::CampaignListReferralsParams::SortBy::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign_list_response.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    class CampaignListResponse < GrowsurfRuby::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            GrowsurfRuby::Models::CampaignListResponse,
+            GrowsurfRuby::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T::Array[GrowsurfRuby::CampaignAPI]) }
+      attr_accessor :campaigns
+
+      sig do
+        params(campaigns: T::Array[GrowsurfRuby::CampaignAPI::OrHash]).returns(
+          T.attached_class
+        )
+      end
+      def self.new(campaigns:)
+      end
+
+      sig do
+        override.returns({ campaigns: T::Array[GrowsurfRuby::CampaignAPI] })
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign_retrieve_analytics_params.rbi

@@ -0,0 +1,81 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    class CampaignRetrieveAnalyticsParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            GrowsurfRuby::CampaignRetrieveAnalyticsParams,
+            GrowsurfRuby::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Last number of days to retrieve analytics for. Defaults to 365. Maximum 1825.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :days
+
+      sig { params(days: Integer).void }
+      attr_writer :days
+
+      # End date of the analytics timeframe as a Unix timestamp in milliseconds.
+      # Required if `days` is not set.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :end_date
+
+      sig { params(end_date: Integer).void }
+      attr_writer :end_date
+
+      # Start date of the analytics timeframe as a Unix timestamp in milliseconds.
+      # Required if `days` is not set.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :start_date
+
+      sig { params(start_date: Integer).void }
+      attr_writer :start_date
+
+      sig do
+        params(
+          id: String,
+          days: Integer,
+          end_date: Integer,
+          start_date: Integer,
+          request_options: GrowsurfRuby::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        # Last number of days to retrieve analytics for. Defaults to 365. Maximum 1825.
+        days: nil,
+        # End date of the analytics timeframe as a Unix timestamp in milliseconds.
+        # Required if `days` is not set.
+        end_date: nil,
+        # Start date of the analytics timeframe as a Unix timestamp in milliseconds.
+        # Required if `days` is not set.
+        start_date: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            days: Integer,
+            end_date: Integer,
+            start_date: Integer,
+            request_options: GrowsurfRuby::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end