growsurf-ruby 0.0.2

data/lib/growsurf_ruby/models/campaign_retrieve_analytics_response.rb

@@ -0,0 +1,215 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # @see GrowsurfRuby::Resources::Campaign#retrieve_analytics
+    class CampaignRetrieveAnalyticsResponse < GrowsurfRuby::Internal::Type::BaseModel
+      # @!attribute analytics
+      #
+      #   @return [GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::Analytics]
+      required :analytics, -> { GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::Analytics }
+
+      # @!attribute end_date
+      #
+      #   @return [Integer]
+      required :end_date, Integer, api_name: :endDate
+
+      # @!attribute start_date
+      #
+      #   @return [Integer]
+      required :start_date, Integer, api_name: :startDate
+
+      # @!method initialize(analytics:, end_date:, start_date:)
+      #   @param analytics [GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::Analytics]
+      #   @param end_date [Integer]
+      #   @param start_date [Integer]
+
+      # @see GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse#analytics
+      class Analytics < GrowsurfRuby::Internal::Type::BaseModel
+        # @!attribute bluesky_shares
+        #
+        #   @return [Integer, nil]
+        optional :bluesky_shares, Integer, api_name: :blueskyShares
+
+        # @!attribute email_shares
+        #
+        #   @return [Integer, nil]
+        optional :email_shares, Integer, api_name: :emailShares
+
+        # @!attribute facebook_shares
+        #
+        #   @return [Integer, nil]
+        optional :facebook_shares, Integer, api_name: :facebookShares
+
+        # @!attribute impressions
+        #
+        #   @return [Integer, nil]
+        optional :impressions, Integer
+
+        # @!attribute invites
+        #
+        #   @return [Integer, nil]
+        optional :invites, Integer
+
+        # @!attribute linked_in_shares
+        #
+        #   @return [Integer, nil]
+        optional :linked_in_shares, Integer, api_name: :linkedInShares
+
+        # @!attribute messenger_shares
+        #
+        #   @return [Integer, nil]
+        optional :messenger_shares, Integer, api_name: :messengerShares
+
+        # @!attribute participants
+        #
+        #   @return [Integer, nil]
+        optional :participants, Integer
+
+        # @!attribute pinterest_shares
+        #
+        #   @return [Integer, nil]
+        optional :pinterest_shares, Integer, api_name: :pinterestShares
+
+        # @!attribute qrcode_shares
+        #
+        #   @return [Integer, nil]
+        optional :qrcode_shares, Integer, api_name: :qrcodeShares
+
+        # @!attribute reddit_shares
+        #
+        #   @return [Integer, nil]
+        optional :reddit_shares, Integer, api_name: :redditShares
+
+        # @!attribute referral_credit_expireds
+        #
+        #   @return [Integer, nil]
+        optional :referral_credit_expireds, Integer, api_name: :referralCreditExpireds
+
+        # @!attribute referral_credit_pendings
+        #
+        #   @return [Integer, nil]
+        optional :referral_credit_pendings, Integer, api_name: :referralCreditPendings
+
+        # @!attribute referrals
+        #
+        #   @return [Integer, nil]
+        optional :referrals, Integer
+
+        # @!attribute sms_shares
+        #
+        #   @return [Integer, nil]
+        optional :sms_shares, Integer, api_name: :smsShares
+
+        # @!attribute telegram_shares
+        #
+        #   @return [Integer, nil]
+        optional :telegram_shares, Integer, api_name: :telegramShares
+
+        # @!attribute threads_shares
+        #
+        #   @return [Integer, nil]
+        optional :threads_shares, Integer, api_name: :threadsShares
+
+        # @!attribute total_commission_count
+        #   Affiliate programs only. Number of commission records.
+        #
+        #   @return [Integer, nil]
+        optional :total_commission_count, Integer, api_name: :totalCommissionCount
+
+        # @!attribute total_commissions
+        #   Affiliate programs only. Commissions in the smallest unit of the program
+        #   currency.
+        #
+        #   @return [Integer, nil]
+        optional :total_commissions, Integer, api_name: :totalCommissions
+
+        # @!attribute total_revenue
+        #   Affiliate programs only. Revenue in the smallest unit of the program currency.
+        #
+        #   @return [Integer, nil]
+        optional :total_revenue, Integer, api_name: :totalRevenue
+
+        # @!attribute tumblr_shares
+        #
+        #   @return [Integer, nil]
+        optional :tumblr_shares, Integer, api_name: :tumblrShares
+
+        # @!attribute twitter_shares
+        #
+        #   @return [Integer, nil]
+        optional :twitter_shares, Integer, api_name: :twitterShares
+
+        # @!attribute unique_impressions
+        #
+        #   @return [Integer, nil]
+        optional :unique_impressions, Integer, api_name: :uniqueImpressions
+
+        # @!attribute wechat_shares
+        #
+        #   @return [Integer, nil]
+        optional :wechat_shares, Integer, api_name: :wechatShares
+
+        # @!attribute whats_app_shares
+        #
+        #   @return [Integer, nil]
+        optional :whats_app_shares, Integer, api_name: :whatsAppShares
+
+        # @!method initialize(bluesky_shares: nil, email_shares: nil, facebook_shares: nil, impressions: nil, invites: nil, linked_in_shares: nil, messenger_shares: nil, participants: nil, pinterest_shares: nil, qrcode_shares: nil, reddit_shares: nil, referral_credit_expireds: nil, referral_credit_pendings: nil, referrals: nil, sms_shares: nil, telegram_shares: nil, threads_shares: nil, total_commission_count: nil, total_commissions: nil, total_revenue: nil, tumblr_shares: nil, twitter_shares: nil, unique_impressions: nil, wechat_shares: nil, whats_app_shares: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::Analytics} for more
+        #   details.
+        #
+        #   @param bluesky_shares [Integer]
+        #
+        #   @param email_shares [Integer]
+        #
+        #   @param facebook_shares [Integer]
+        #
+        #   @param impressions [Integer]
+        #
+        #   @param invites [Integer]
+        #
+        #   @param linked_in_shares [Integer]
+        #
+        #   @param messenger_shares [Integer]
+        #
+        #   @param participants [Integer]
+        #
+        #   @param pinterest_shares [Integer]
+        #
+        #   @param qrcode_shares [Integer]
+        #
+        #   @param reddit_shares [Integer]
+        #
+        #   @param referral_credit_expireds [Integer]
+        #
+        #   @param referral_credit_pendings [Integer]
+        #
+        #   @param referrals [Integer]
+        #
+        #   @param sms_shares [Integer]
+        #
+        #   @param telegram_shares [Integer]
+        #
+        #   @param threads_shares [Integer]
+        #
+        #   @param total_commission_count [Integer] Affiliate programs only. Number of commission records.
+        #
+        #   @param total_commissions [Integer] Affiliate programs only. Commissions in the smallest unit of the program currenc
+        #
+        #   @param total_revenue [Integer] Affiliate programs only. Revenue in the smallest unit of the program currency.
+        #
+        #   @param tumblr_shares [Integer]
+        #
+        #   @param twitter_shares [Integer]
+        #
+        #   @param unique_impressions [Integer]
+        #
+        #   @param wechat_shares [Integer]
+        #
+        #   @param whats_app_shares [Integer]
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign_retrieve_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # @see GrowsurfRuby::Resources::Campaign#retrieve
+    class CampaignRetrieveParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
+      #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/growsurf_ruby/models/commission_structure.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    class CommissionStructure < GrowsurfRuby::Internal::Type::BaseModel
+      # @!attribute amount
+      #
+      #   @return [Integer, nil]
+      optional :amount, Integer, nil?: true
+
+      # @!attribute approval_required
+      #
+      #   @return [Boolean, nil]
+      optional :approval_required,
+               GrowsurfRuby::Internal::Type::Boolean,
+               api_name: :approvalRequired,
+               nil?: true
+
+      # @!attribute duration
+      #
+      #   @return [String, nil]
+      optional :duration, String, nil?: true
+
+      # @!attribute duration_in_months
+      #
+      #   @return [Integer, nil]
+      optional :duration_in_months, Integer, api_name: :durationInMonths, nil?: true
+
+      # @!attribute event
+      #
+      #   @return [String, nil]
+      optional :event, String, nil?: true
+
+      # @!attribute has_intro
+      #
+      #   @return [Boolean, nil]
+      optional :has_intro, GrowsurfRuby::Internal::Type::Boolean, api_name: :hasIntro, nil?: true
+
+      # @!attribute has_max_amount
+      #
+      #   @return [Boolean, nil]
+      optional :has_max_amount, GrowsurfRuby::Internal::Type::Boolean, api_name: :hasMaxAmount, nil?: true
+
+      # @!attribute hold_duration
+      #
+      #   @return [Integer, nil]
+      optional :hold_duration, Integer, api_name: :holdDuration, nil?: true
+
+      # @!attribute intro_amount
+      #
+      #   @return [Integer, nil]
+      optional :intro_amount, Integer, api_name: :introAmount, nil?: true
+
+      # @!attribute intro_amount_iso
+      #
+      #   @return [String, nil]
+      optional :intro_amount_iso, String, api_name: :introAmountISO, nil?: true
+
+      # @!attribute intro_duration
+      #
+      #   @return [String, nil]
+      optional :intro_duration, String, api_name: :introDuration, nil?: true
+
+      # @!attribute intro_duration_in_months
+      #
+      #   @return [Integer, nil]
+      optional :intro_duration_in_months, Integer, api_name: :introDurationInMonths, nil?: true
+
+      # @!attribute intro_percent
+      #
+      #   @return [Float, nil]
+      optional :intro_percent, Float, api_name: :introPercent, nil?: true
+
+      # @!attribute intro_type
+      #
+      #   @return [String, nil]
+      optional :intro_type, String, api_name: :introType, nil?: true
+
+      # @!attribute max_amount
+      #
+      #   @return [Integer, nil]
+      optional :max_amount, Integer, api_name: :maxAmount, nil?: true
+
+      # @!attribute max_amount_iso
+      #
+      #   @return [String, nil]
+      optional :max_amount_iso, String, api_name: :maxAmountISO, nil?: true
+
+      # @!attribute min_paid_referrals
+      #
+      #   @return [Integer, nil]
+      optional :min_paid_referrals, Integer, api_name: :minPaidReferrals, nil?: true
+
+      # @!attribute percent
+      #
+      #   @return [Float, nil]
+      optional :percent, Float, nil?: true
+
+      # @!attribute type
+      #
+      #   @return [Symbol, GrowsurfRuby::Models::CommissionStructure::Type, nil]
+      optional :type, enum: -> { GrowsurfRuby::CommissionStructure::Type }, nil?: true
+
+      # @!method initialize(amount: nil, approval_required: nil, duration: nil, duration_in_months: nil, event: nil, has_intro: nil, has_max_amount: nil, hold_duration: nil, intro_amount: nil, intro_amount_iso: nil, intro_duration: nil, intro_duration_in_months: nil, intro_percent: nil, intro_type: nil, max_amount: nil, max_amount_iso: nil, min_paid_referrals: nil, percent: nil, type: nil)
+      #   @param amount [Integer, nil]
+      #   @param approval_required [Boolean, nil]
+      #   @param duration [String, nil]
+      #   @param duration_in_months [Integer, nil]
+      #   @param event [String, nil]
+      #   @param has_intro [Boolean, nil]
+      #   @param has_max_amount [Boolean, nil]
+      #   @param hold_duration [Integer, nil]
+      #   @param intro_amount [Integer, nil]
+      #   @param intro_amount_iso [String, nil]
+      #   @param intro_duration [String, nil]
+      #   @param intro_duration_in_months [Integer, nil]
+      #   @param intro_percent [Float, nil]
+      #   @param intro_type [String, nil]
+      #   @param max_amount [Integer, nil]
+      #   @param max_amount_iso [String, nil]
+      #   @param min_paid_referrals [Integer, nil]
+      #   @param percent [Float, nil]
+      #   @param type [Symbol, GrowsurfRuby::Models::CommissionStructure::Type, nil]
+
+      # @see GrowsurfRuby::Models::CommissionStructure#type
+      module Type
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        PERCENT = :PERCENT
+        AMOUNT = :AMOUNT
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/participant_commission_list.rb

@@ -0,0 +1,170 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # @see GrowsurfRuby::Resources::Campaign#list_commissions
+    class ParticipantCommissionList < GrowsurfRuby::Internal::Type::BaseModel
+      # @!attribute commissions
+      #
+      #   @return [Array<GrowsurfRuby::Models::ParticipantCommissionList::Commission>]
+      required :commissions,
+               -> { GrowsurfRuby::Internal::Type::ArrayOf[GrowsurfRuby::ParticipantCommissionList::Commission] }
+
+      # @!attribute limit
+      #
+      #   @return [Integer]
+      required :limit, Integer
+
+      # @!attribute next_id
+      #
+      #   @return [String, nil]
+      required :next_id, String, api_name: :nextId, nil?: true
+
+      # @!method initialize(commissions:, limit:, next_id:)
+      #   @param commissions [Array<GrowsurfRuby::Models::ParticipantCommissionList::Commission>]
+      #   @param limit [Integer]
+      #   @param next_id [String, nil]
+
+      class Commission < GrowsurfRuby::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute amount
+        #
+        #   @return [Integer]
+        required :amount, Integer
+
+        # @!attribute created_at
+        #
+        #   @return [Integer]
+        required :created_at, Integer, api_name: :createdAt
+
+        # @!attribute currency_iso
+        #
+        #   @return [String]
+        required :currency_iso, String, api_name: :currencyISO
+
+        # @!attribute referred_id
+        #
+        #   @return [String]
+        required :referred_id, String, api_name: :referredId
+
+        # @!attribute referrer_id
+        #
+        #   @return [String]
+        required :referrer_id, String, api_name: :referrerId
+
+        # @!attribute sale_amount
+        #
+        #   @return [Integer]
+        required :sale_amount, Integer, api_name: :saleAmount
+
+        # @!attribute status
+        #
+        #   @return [Symbol, GrowsurfRuby::Models::ParticipantCommissionList::Commission::Status]
+        required :status, enum: -> { GrowsurfRuby::ParticipantCommissionList::Commission::Status }
+
+        # @!attribute amount_in_campaign_currency
+        #
+        #   @return [Integer, nil]
+        optional :amount_in_campaign_currency, Integer, api_name: :amountInCampaignCurrency, nil?: true
+
+        # @!attribute approved_at
+        #
+        #   @return [Integer, nil]
+        optional :approved_at, Integer, api_name: :approvedAt
+
+        # @!attribute campaign_currency_iso
+        #
+        #   @return [String, nil]
+        optional :campaign_currency_iso, String, api_name: :campaignCurrencyISO, nil?: true
+
+        # @!attribute exchange_rate
+        #
+        #   @return [Float, nil]
+        optional :exchange_rate, Float, api_name: :exchangeRate, nil?: true
+
+        # @!attribute exchange_rate_at
+        #
+        #   @return [Integer, nil]
+        optional :exchange_rate_at, Integer, api_name: :exchangeRateAt
+
+        # @!attribute fx_error
+        #
+        #   @return [String, nil]
+        optional :fx_error, String, api_name: :fxError, nil?: true
+
+        # @!attribute hold_duration
+        #
+        #   @return [Integer, nil]
+        optional :hold_duration, Integer, api_name: :holdDuration, nil?: true
+
+        # @!attribute paid_at
+        #
+        #   @return [Integer, nil]
+        optional :paid_at, Integer, api_name: :paidAt
+
+        # @!attribute payout_queued_at
+        #
+        #   @return [Integer, nil]
+        optional :payout_queued_at, Integer, api_name: :payoutQueuedAt
+
+        # @!attribute provider
+        #
+        #   @return [String, nil]
+        optional :provider, String, nil?: true
+
+        # @!attribute reversed_at
+        #
+        #   @return [Integer, nil]
+        optional :reversed_at, Integer, api_name: :reversedAt
+
+        # @!attribute sale_amount_amount_in_campaign_currency
+        #
+        #   @return [Integer, nil]
+        optional :sale_amount_amount_in_campaign_currency,
+                 Integer,
+                 api_name: :saleAmountAmountInCampaignCurrency,
+                 nil?: true
+
+        # @!method initialize(id:, amount:, created_at:, currency_iso:, referred_id:, referrer_id:, sale_amount:, status:, amount_in_campaign_currency: nil, approved_at: nil, campaign_currency_iso: nil, exchange_rate: nil, exchange_rate_at: nil, fx_error: nil, hold_duration: nil, paid_at: nil, payout_queued_at: nil, provider: nil, reversed_at: nil, sale_amount_amount_in_campaign_currency: nil)
+        #   @param id [String]
+        #   @param amount [Integer]
+        #   @param created_at [Integer]
+        #   @param currency_iso [String]
+        #   @param referred_id [String]
+        #   @param referrer_id [String]
+        #   @param sale_amount [Integer]
+        #   @param status [Symbol, GrowsurfRuby::Models::ParticipantCommissionList::Commission::Status]
+        #   @param amount_in_campaign_currency [Integer, nil]
+        #   @param approved_at [Integer]
+        #   @param campaign_currency_iso [String, nil]
+        #   @param exchange_rate [Float, nil]
+        #   @param exchange_rate_at [Integer]
+        #   @param fx_error [String, nil]
+        #   @param hold_duration [Integer, nil]
+        #   @param paid_at [Integer]
+        #   @param payout_queued_at [Integer]
+        #   @param provider [String, nil]
+        #   @param reversed_at [Integer]
+        #   @param sale_amount_amount_in_campaign_currency [Integer, nil]
+
+        # @see GrowsurfRuby::Models::ParticipantCommissionList::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
+end

data/lib/growsurf_ruby/models/participant_list.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # @see GrowsurfRuby::Resources::Campaign#list_leaderboard
+    class ParticipantList < GrowsurfRuby::Internal::Type::BaseModel
+      # @!attribute limit
+      #
+      #   @return [Integer]
+      required :limit, Integer
+
+      # @!attribute next_id
+      #
+      #   @return [String, nil]
+      required :next_id, String, api_name: :nextId, nil?: true
+
+      # @!attribute participants
+      #
+      #   @return [Array<GrowsurfRuby::Models::Campaign::CampaignParticipant>]
+      required :participants,
+               -> { GrowsurfRuby::Internal::Type::ArrayOf[GrowsurfRuby::Campaign::CampaignParticipant] }
+
+      # @!method initialize(limit:, next_id:, participants:)
+      #   @param limit [Integer]
+      #   @param next_id [String, nil]
+      #   @param participants [Array<GrowsurfRuby::Models::Campaign::CampaignParticipant>]
+    end
+  end
+end