growsurf-ruby 0.0.2

data/lib/growsurf_ruby/models/campaign.rb

@@ -0,0 +1,257 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # @see GrowsurfRuby::Resources::Campaign#retrieve
+    class CampaignAPI < GrowsurfRuby::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute impression_count
+      #
+      #   @return [Integer]
+      required :impression_count, Integer, api_name: :impressionCount
+
+      # @!attribute invite_count
+      #
+      #   @return [Integer]
+      required :invite_count, Integer, api_name: :inviteCount
+
+      # @!attribute name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute participant_count
+      #
+      #   @return [Integer]
+      required :participant_count, Integer, api_name: :participantCount
+
+      # @!attribute referral_count
+      #
+      #   @return [Integer]
+      required :referral_count, Integer, api_name: :referralCount
+
+      # @!attribute rewards
+      #
+      #   @return [Array<GrowsurfRuby::Models::CampaignAPI::Reward>]
+      required :rewards, -> { GrowsurfRuby::Internal::Type::ArrayOf[GrowsurfRuby::CampaignAPI::Reward] }
+
+      # @!attribute status
+      #
+      #   @return [Symbol, GrowsurfRuby::Models::CampaignAPI::Status]
+      required :status, enum: -> { GrowsurfRuby::CampaignAPI::Status }
+
+      # @!attribute type
+      #
+      #   @return [Symbol, GrowsurfRuby::Models::CampaignAPI::Type]
+      required :type, enum: -> { GrowsurfRuby::CampaignAPI::Type }
+
+      # @!attribute winner_count
+      #
+      #   @return [Integer]
+      required :winner_count, Integer, api_name: :winnerCount
+
+      # @!attribute currency_iso
+      #
+      #   @return [String, nil]
+      optional :currency_iso, String, api_name: :currencyISO
+
+      # @!method initialize(id:, impression_count:, invite_count:, name:, participant_count:, referral_count:, rewards:, status:, type:, winner_count:, currency_iso: nil)
+      #   @param id [String]
+      #   @param impression_count [Integer]
+      #   @param invite_count [Integer]
+      #   @param name [String]
+      #   @param participant_count [Integer]
+      #   @param referral_count [Integer]
+      #   @param rewards [Array<GrowsurfRuby::Models::CampaignAPI::Reward>]
+      #   @param status [Symbol, GrowsurfRuby::Models::CampaignAPI::Status]
+      #   @param type [Symbol, GrowsurfRuby::Models::CampaignAPI::Type]
+      #   @param winner_count [Integer]
+      #   @param currency_iso [String]
+
+      class Reward < GrowsurfRuby::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute is_unlimited
+        #
+        #   @return [Boolean]
+        required :is_unlimited, GrowsurfRuby::Internal::Type::Boolean, api_name: :isUnlimited
+
+        # @!attribute metadata
+        #   Shallow custom metadata object.
+        #
+        #   @return [Hash{Symbol=>Object}]
+        required :metadata, GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown]
+
+        # @!attribute type
+        #
+        #   @return [Symbol, GrowsurfRuby::Models::CampaignAPI::Reward::Type]
+        required :type, enum: -> { GrowsurfRuby::CampaignAPI::Reward::Type }
+
+        # @!attribute commission_structure
+        #
+        #   @return [GrowsurfRuby::Models::CommissionStructure, nil]
+        optional :commission_structure,
+                 -> { GrowsurfRuby::CommissionStructure },
+                 api_name: :commissionStructure,
+                 nil?: true
+
+        # @!attribute conversions_required
+        #
+        #   @return [Integer, nil]
+        optional :conversions_required, Integer, api_name: :conversionsRequired, nil?: true
+
+        # @!attribute coupon_code
+        #
+        #   @return [String, nil]
+        optional :coupon_code, String, api_name: :couponCode, nil?: true
+
+        # @!attribute description
+        #
+        #   @return [String, nil]
+        optional :description, String, nil?: true
+
+        # @!attribute image_url
+        #
+        #   @return [String, nil]
+        optional :image_url, String, api_name: :imageUrl, nil?: true
+
+        # @!attribute limit
+        #   `-1` represents an unlimited reward in REST responses.
+        #
+        #   @return [Integer, nil]
+        optional :limit, Integer, nil?: true
+
+        # @!attribute limit_duration
+        #
+        #   @return [Symbol, GrowsurfRuby::Models::CampaignAPI::Reward::LimitDuration, nil]
+        optional :limit_duration,
+                 enum: -> { GrowsurfRuby::CampaignAPI::Reward::LimitDuration },
+                 api_name: :limitDuration,
+                 nil?: true
+
+        # @!attribute next_milestone_prefix
+        #
+        #   @return [String, nil]
+        optional :next_milestone_prefix, String, api_name: :nextMilestonePrefix, nil?: true
+
+        # @!attribute next_milestone_suffix
+        #
+        #   @return [String, nil]
+        optional :next_milestone_suffix, String, api_name: :nextMilestoneSuffix, nil?: true
+
+        # @!attribute number_of_winners
+        #
+        #   @return [Integer, nil]
+        optional :number_of_winners, Integer, api_name: :numberOfWinners, nil?: true
+
+        # @!attribute order
+        #
+        #   @return [Integer, nil]
+        optional :order, Integer, nil?: true
+
+        # @!attribute referral_description
+        #
+        #   @return [String, nil]
+        optional :referral_description, String, api_name: :referralDescription, nil?: true
+
+        # @!attribute referred_reward_upfront
+        #
+        #   @return [Boolean, nil]
+        optional :referred_reward_upfront,
+                 GrowsurfRuby::Internal::Type::Boolean,
+                 api_name: :referredRewardUpfront
+
+        # @!method initialize(id:, is_unlimited:, metadata:, type:, commission_structure: nil, conversions_required: nil, coupon_code: nil, description: nil, image_url: nil, limit: nil, limit_duration: nil, next_milestone_prefix: nil, next_milestone_suffix: nil, number_of_winners: nil, order: nil, referral_description: nil, referred_reward_upfront: nil)
+        #   @param id [String]
+        #
+        #   @param is_unlimited [Boolean]
+        #
+        #   @param metadata [Hash{Symbol=>Object}] Shallow custom metadata object.
+        #
+        #   @param type [Symbol, GrowsurfRuby::Models::CampaignAPI::Reward::Type]
+        #
+        #   @param commission_structure [GrowsurfRuby::Models::CommissionStructure, nil]
+        #
+        #   @param conversions_required [Integer, nil]
+        #
+        #   @param coupon_code [String, nil]
+        #
+        #   @param description [String, nil]
+        #
+        #   @param image_url [String, nil]
+        #
+        #   @param limit [Integer, nil] `-1` represents an unlimited reward in REST responses.
+        #
+        #   @param limit_duration [Symbol, GrowsurfRuby::Models::CampaignAPI::Reward::LimitDuration, nil]
+        #
+        #   @param next_milestone_prefix [String, nil]
+        #
+        #   @param next_milestone_suffix [String, nil]
+        #
+        #   @param number_of_winners [Integer, nil]
+        #
+        #   @param order [Integer, nil]
+        #
+        #   @param referral_description [String, nil]
+        #
+        #   @param referred_reward_upfront [Boolean]
+
+        # @see GrowsurfRuby::Models::CampaignAPI::Reward#type
+        module Type
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          SINGLE_SIDED = :SINGLE_SIDED
+          DOUBLE_SIDED = :DOUBLE_SIDED
+          MILESTONE = :MILESTONE
+          LEADERBOARD = :LEADERBOARD
+          AFFILIATE = :AFFILIATE
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see GrowsurfRuby::Models::CampaignAPI::Reward#limit_duration
+        module LimitDuration
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          IN_TOTAL = :IN_TOTAL
+          PER_MONTH = :PER_MONTH
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # @see GrowsurfRuby::Models::CampaignAPI#status
+      module Status
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        DRAFT = :DRAFT
+        IN_PROGRESS = :IN_PROGRESS
+        COMPLETE = :COMPLETE
+        DELETED = :DELETED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see GrowsurfRuby::Models::CampaignAPI#type
+      module Type
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        REFERRAL = :REFERRAL
+        AFFILIATE = :AFFILIATE
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign_list_commissions_params.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # @see GrowsurfRuby::Resources::Campaign#list_commissions
+    class CampaignListCommissionsParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute limit
+      #   Number of results to return. Maximum 100.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute next_id
+      #   ID to start the next paged result set with.
+      #
+      #   @return [String, nil]
+      optional :next_id, String
+
+      # @!attribute status
+      #   Participant commission status.
+      #
+      #   @return [Symbol, GrowsurfRuby::Models::CampaignListCommissionsParams::Status, nil]
+      optional :status, enum: -> { GrowsurfRuby::CampaignListCommissionsParams::Status }
+
+      # @!method initialize(id:, limit: nil, next_id: nil, status: nil, request_options: {})
+      #   @param id [String]
+      #
+      #   @param limit [Integer] Number of results to return. Maximum 100.
+      #
+      #   @param next_id [String] ID to start the next paged result set with.
+      #
+      #   @param status [Symbol, GrowsurfRuby::Models::CampaignListCommissionsParams::Status] Participant commission status.
+      #
+      #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
+
+      # Participant commission status.
+      module Status
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        PENDING = :PENDING
+        APPROVED = :APPROVED
+        PAID = :PAID
+        REVERSED = :REVERSED
+        DELETED = :DELETED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign_list_leaderboard_params.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # @see GrowsurfRuby::Resources::Campaign#list_leaderboard
+    class CampaignListLeaderboardParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute is_monthly
+      #   Deprecated. Use `leaderboardType=CURRENT_MONTH` instead.
+      #
+      #   @return [Boolean, nil]
+      optional :is_monthly, GrowsurfRuby::Internal::Type::Boolean
+
+      # @!attribute leaderboard_type
+      #   Leaderboard ordering mode.
+      #
+      #   @return [Symbol, GrowsurfRuby::Models::CampaignListLeaderboardParams::LeaderboardType, nil]
+      optional :leaderboard_type, enum: -> { GrowsurfRuby::CampaignListLeaderboardParams::LeaderboardType }
+
+      # @!attribute limit
+      #   Number of results to return. Maximum 100.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute next_id
+      #   ID to start the next paged result set with.
+      #
+      #   @return [String, nil]
+      optional :next_id, String
+
+      # @!method initialize(id:, is_monthly: nil, leaderboard_type: nil, limit: nil, next_id: nil, request_options: {})
+      #   @param id [String]
+      #
+      #   @param is_monthly [Boolean] Deprecated. Use `leaderboardType=CURRENT_MONTH` instead.
+      #
+      #   @param leaderboard_type [Symbol, GrowsurfRuby::Models::CampaignListLeaderboardParams::LeaderboardType] Leaderboard ordering mode.
+      #
+      #   @param limit [Integer] Number of results to return. Maximum 100.
+      #
+      #   @param next_id [String] ID to start the next paged result set with.
+      #
+      #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
+
+      # Leaderboard ordering mode.
+      module LeaderboardType
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        ALL_TIME = :ALL_TIME
+        CURRENT_MONTH = :CURRENT_MONTH
+        PREV_MONTH = :PREV_MONTH
+        TOTAL_IMPRESSION_COUNT = :TOTAL_IMPRESSION_COUNT
+        UNIQUE_IMPRESSION_COUNT = :UNIQUE_IMPRESSION_COUNT
+        BY_COMMISSIONS = :BY_COMMISSIONS
+        BY_REVENUE = :BY_REVENUE
+        BY_REFERRALS = :BY_REFERRALS
+        BY_LEADS = :BY_LEADS
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign_list_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # @see GrowsurfRuby::Resources::Campaign#list
+    class CampaignListParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign_list_participants_params.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # @see GrowsurfRuby::Resources::Campaign#list_participants
+    class CampaignListParticipantsParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute limit
+      #   Number of results to return. Maximum 100.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute next_id
+      #   ID to start the next paged result set with.
+      #
+      #   @return [String, nil]
+      optional :next_id, String
+
+      # @!method initialize(id:, limit: nil, next_id: nil, request_options: {})
+      #   @param id [String]
+      #
+      #   @param limit [Integer] Number of results to return. Maximum 100.
+      #
+      #   @param next_id [String] ID to start the next paged result set with.
+      #
+      #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign_list_payouts_params.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # @see GrowsurfRuby::Resources::Campaign#list_payouts
+    class CampaignListPayoutsParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute limit
+      #   Number of results to return. Maximum 100.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute next_id
+      #   ID to start the next paged result set with.
+      #
+      #   @return [String, nil]
+      optional :next_id, String
+
+      # @!attribute status
+      #   Participant payout status.
+      #
+      #   @return [Symbol, GrowsurfRuby::Models::CampaignListPayoutsParams::Status, nil]
+      optional :status, enum: -> { GrowsurfRuby::CampaignListPayoutsParams::Status }
+
+      # @!method initialize(id:, limit: nil, next_id: nil, status: nil, request_options: {})
+      #   @param id [String]
+      #
+      #   @param limit [Integer] Number of results to return. Maximum 100.
+      #
+      #   @param next_id [String] ID to start the next paged result set with.
+      #
+      #   @param status [Symbol, GrowsurfRuby::Models::CampaignListPayoutsParams::Status] Participant payout status.
+      #
+      #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
+
+      # Participant payout status.
+      module Status
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        UPCOMING = :UPCOMING
+        QUEUED = :QUEUED
+        ISSUED = :ISSUED
+        FAILED = :FAILED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign_list_referrals_params.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # @see GrowsurfRuby::Resources::Campaign#list_referrals
+    class CampaignListReferralsParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute desc
+      #   Return results in descending order when true.
+      #
+      #   @return [Boolean, nil]
+      optional :desc, GrowsurfRuby::Internal::Type::Boolean
+
+      # @!attribute email
+      #   URL-encoded email value to filter referral results.
+      #
+      #   @return [String, nil]
+      optional :email, String
+
+      # @!attribute first_name
+      #   First name value to filter results.
+      #
+      #   @return [String, nil]
+      optional :first_name, String
+
+      # @!attribute last_name
+      #   Last name value to filter results.
+      #
+      #   @return [String, nil]
+      optional :last_name, String
+
+      # @!attribute limit
+      #   Number of results to return. Maximum 100.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute next_id
+      #   ID to start the next paged result set with.
+      #
+      #   @return [String, nil]
+      optional :next_id, String
+
+      # @!attribute offset
+      #   Offset number used to skip through a result set.
+      #
+      #   @return [Integer, nil]
+      optional :offset, Integer
+
+      # @!attribute referral_status
+      #
+      #   @return [Symbol, GrowsurfRuby::Models::Campaign::ReferralStatus, nil]
+      optional :referral_status, enum: -> { GrowsurfRuby::Campaign::ReferralStatus }
+
+      # @!attribute sort_by
+      #   Field used to sort referral results.
+      #
+      #   @return [Symbol, GrowsurfRuby::Models::CampaignListReferralsParams::SortBy, nil]
+      optional :sort_by, enum: -> { GrowsurfRuby::CampaignListReferralsParams::SortBy }
+
+      # @!method initialize(id:, desc: nil, email: nil, first_name: nil, last_name: nil, limit: nil, next_id: nil, offset: nil, referral_status: nil, sort_by: nil, request_options: {})
+      #   @param id [String]
+      #
+      #   @param desc [Boolean] Return results in descending order when true.
+      #
+      #   @param email [String] URL-encoded email value to filter referral results.
+      #
+      #   @param first_name [String] First name value to filter results.
+      #
+      #   @param last_name [String] Last name value to filter results.
+      #
+      #   @param limit [Integer] Number of results to return. Maximum 100.
+      #
+      #   @param next_id [String] ID to start the next paged result set with.
+      #
+      #   @param offset [Integer] Offset number used to skip through a result set.
+      #
+      #   @param referral_status [Symbol, GrowsurfRuby::Models::Campaign::ReferralStatus]
+      #
+      #   @param sort_by [Symbol, GrowsurfRuby::Models::CampaignListReferralsParams::SortBy] Field used to sort referral results.
+      #
+      #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
+
+      # Field used to sort referral results.
+      module SortBy
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        UPDATED_AT = :updatedAt
+        CREATED_AT = :createdAt
+        EMAIL = :email
+        FIRST_NAME = :firstName
+        LAST_NAME = :lastName
+        REFERRAL_STATUS = :referralStatus
+        REFERRAL_TRIGGERED_AT = :referralTriggeredAt
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign_list_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # @see GrowsurfRuby::Resources::Campaign#list
+    class CampaignListResponse < GrowsurfRuby::Internal::Type::BaseModel
+      # @!attribute campaigns
+      #
+      #   @return [Array<GrowsurfRuby::Models::CampaignAPI>]
+      required :campaigns, -> { GrowsurfRuby::Internal::Type::ArrayOf[GrowsurfRuby::CampaignAPI] }
+
+      # @!method initialize(campaigns:)
+      #   @param campaigns [Array<GrowsurfRuby::Models::CampaignAPI>]
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign_retrieve_analytics_params.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # @see GrowsurfRuby::Resources::Campaign#retrieve_analytics
+    class CampaignRetrieveAnalyticsParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute days
+      #   Last number of days to retrieve analytics for. Defaults to 365. Maximum 1825.
+      #
+      #   @return [Integer, nil]
+      optional :days, Integer
+
+      # @!attribute end_date
+      #   End date of the analytics timeframe as a Unix timestamp in milliseconds.
+      #   Required if `days` is not set.
+      #
+      #   @return [Integer, nil]
+      optional :end_date, Integer
+
+      # @!attribute start_date
+      #   Start date of the analytics timeframe as a Unix timestamp in milliseconds.
+      #   Required if `days` is not set.
+      #
+      #   @return [Integer, nil]
+      optional :start_date, Integer
+
+      # @!method initialize(id:, days: nil, end_date: nil, start_date: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param days [Integer] Last number of days to retrieve analytics for. Defaults to 365. Maximum 1825.
+      #
+      #   @param end_date [Integer] End date of the analytics timeframe as a Unix timestamp in milliseconds. Require
+      #
+      #   @param start_date [Integer] Start date of the analytics timeframe as a Unix timestamp in milliseconds. Requi
+      #
+      #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end