growsurf-ruby 0.0.2

data/lib/growsurf_ruby/models/participant_payout_list.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # @see GrowsurfRuby::Resources::Campaign#list_payouts
+    class ParticipantPayoutList < 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 payouts
+      #
+      #   @return [Array<GrowsurfRuby::Models::ParticipantPayoutList::Payout>]
+      required :payouts,
+               -> { GrowsurfRuby::Internal::Type::ArrayOf[GrowsurfRuby::ParticipantPayoutList::Payout] }
+
+      # @!method initialize(limit:, next_id:, payouts:)
+      #   @param limit [Integer]
+      #   @param next_id [String, nil]
+      #   @param payouts [Array<GrowsurfRuby::Models::ParticipantPayoutList::Payout>]
+
+      class Payout < GrowsurfRuby::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute amount
+        #
+        #   @return [Integer]
+        required :amount, Integer
+
+        # @!attribute commission_ids
+        #
+        #   @return [Array<String>]
+        required :commission_ids, GrowsurfRuby::Internal::Type::ArrayOf[String], api_name: :commissionIds
+
+        # @!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 participant_id
+        #
+        #   @return [String]
+        required :participant_id, String, api_name: :participantId
+
+        # @!attribute status
+        #
+        #   @return [Symbol, GrowsurfRuby::Models::ParticipantPayoutList::Payout::Status]
+        required :status, enum: -> { GrowsurfRuby::ParticipantPayoutList::Payout::Status }
+
+        # @!attribute amount_in_campaign_currency
+        #
+        #   @return [Integer, nil]
+        optional :amount_in_campaign_currency, Integer, api_name: :amountInCampaignCurrency, nil?: true
+
+        # @!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 failed_at
+        #
+        #   @return [Integer, nil]
+        optional :failed_at, Integer, api_name: :failedAt
+
+        # @!attribute fx_error
+        #
+        #   @return [String, nil]
+        optional :fx_error, String, api_name: :fxError, nil?: true
+
+        # @!attribute issued_at
+        #
+        #   @return [Integer, nil]
+        optional :issued_at, Integer, api_name: :issuedAt
+
+        # @!attribute provider
+        #
+        #   @return [String, nil]
+        optional :provider, String, nil?: true
+
+        # @!method initialize(id:, amount:, commission_ids:, created_at:, currency_iso:, participant_id:, status:, amount_in_campaign_currency: nil, campaign_currency_iso: nil, exchange_rate: nil, exchange_rate_at: nil, failed_at: nil, fx_error: nil, issued_at: nil, provider: nil)
+        #   @param id [String]
+        #   @param amount [Integer]
+        #   @param commission_ids [Array<String>]
+        #   @param created_at [Integer]
+        #   @param currency_iso [String]
+        #   @param participant_id [String]
+        #   @param status [Symbol, GrowsurfRuby::Models::ParticipantPayoutList::Payout::Status]
+        #   @param amount_in_campaign_currency [Integer, nil]
+        #   @param campaign_currency_iso [String, nil]
+        #   @param exchange_rate [Float, nil]
+        #   @param exchange_rate_at [Integer]
+        #   @param failed_at [Integer]
+        #   @param fx_error [String, nil]
+        #   @param issued_at [Integer]
+        #   @param provider [String, nil]
+
+        # @see GrowsurfRuby::Models::ParticipantPayoutList::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
+end

data/lib/growsurf_ruby/models/referral_list.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # @see GrowsurfRuby::Resources::Campaign#list_referrals
+    class ReferralList < GrowsurfRuby::Internal::Type::BaseModel
+      # @!attribute limit
+      #
+      #   @return [Integer]
+      required :limit, Integer
+
+      # @!attribute more
+      #
+      #   @return [Boolean]
+      required :more, GrowsurfRuby::Internal::Type::Boolean
+
+      # @!attribute referrals
+      #
+      #   @return [Array<GrowsurfRuby::Models::ReferralList::Referral>]
+      required :referrals, -> { GrowsurfRuby::Internal::Type::ArrayOf[GrowsurfRuby::ReferralList::Referral] }
+
+      # @!attribute next_id
+      #
+      #   @return [String, nil]
+      optional :next_id, String, api_name: :nextId, nil?: true
+
+      # @!attribute next_offset
+      #
+      #   @return [Integer, nil]
+      optional :next_offset, Integer, api_name: :nextOffset, nil?: true
+
+      # @!method initialize(limit:, more:, referrals:, next_id: nil, next_offset: nil)
+      #   @param limit [Integer]
+      #   @param more [Boolean]
+      #   @param referrals [Array<GrowsurfRuby::Models::ReferralList::Referral>]
+      #   @param next_id [String, nil]
+      #   @param next_offset [Integer, nil]
+
+      class Referral < GrowsurfRuby::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #
+        #   @return [Integer]
+        required :created_at, Integer, api_name: :createdAt
+
+        # @!attribute email
+        #
+        #   @return [String]
+        required :email, String
+
+        # @!attribute referral_status
+        #
+        #   @return [Symbol, GrowsurfRuby::Models::Campaign::ReferralStatus]
+        required :referral_status,
+                 enum: -> {
+                   GrowsurfRuby::Campaign::ReferralStatus
+                 },
+                 api_name: :referralStatus
+
+        # @!attribute referred_by
+        #
+        #   @return [String]
+        required :referred_by, String, api_name: :referredBy
+
+        # @!attribute updated_at
+        #
+        #   @return [Integer]
+        required :updated_at, Integer, api_name: :updatedAt
+
+        # @!attribute first_name
+        #
+        #   @return [String, nil]
+        optional :first_name, String, api_name: :firstName, nil?: true
+
+        # @!attribute last_name
+        #
+        #   @return [String, nil]
+        optional :last_name, String, api_name: :lastName, nil?: true
+
+        # @!method initialize(id:, created_at:, email:, referral_status:, referred_by:, updated_at:, first_name: nil, last_name: nil)
+        #   @param id [String]
+        #   @param created_at [Integer]
+        #   @param email [String]
+        #   @param referral_status [Symbol, GrowsurfRuby::Models::Campaign::ReferralStatus]
+        #   @param referred_by [String]
+        #   @param updated_at [Integer]
+        #   @param first_name [String, nil]
+        #   @param last_name [String, nil]
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  [GrowsurfRuby::Internal::Type::BaseModel, *GrowsurfRuby::Internal::Type::BaseModel.subclasses].each do |cls|
+    cls.define_sorbet_constant!(:OrHash) { T.type_alias { T.any(cls, GrowsurfRuby::Internal::AnyHash) } }
+  end
+
+  GrowsurfRuby::Internal::Util.walk_namespaces(GrowsurfRuby::Models).each do |mod|
+    case mod
+    in GrowsurfRuby::Internal::Type::Enum | GrowsurfRuby::Internal::Type::Union
+      mod.constants.each do |name|
+        case mod.const_get(name)
+        in true | false
+          mod.define_sorbet_constant!(:TaggedBoolean) { T.type_alias { T::Boolean } }
+          mod.define_sorbet_constant!(:OrBoolean) { T.type_alias { T::Boolean } }
+        in Integer
+          mod.define_sorbet_constant!(:TaggedInteger) { T.type_alias { Integer } }
+          mod.define_sorbet_constant!(:OrInteger) { T.type_alias { Integer } }
+        in Float
+          mod.define_sorbet_constant!(:TaggedFloat) { T.type_alias { Float } }
+          mod.define_sorbet_constant!(:OrFloat) { T.type_alias { Float } }
+        in Symbol
+          mod.define_sorbet_constant!(:TaggedSymbol) { T.type_alias { Symbol } }
+          mod.define_sorbet_constant!(:OrSymbol) { T.type_alias { T.any(Symbol, String) } }
+        else
+        end
+      end
+    else
+    end
+  end
+
+  GrowsurfRuby::Internal::Util.walk_namespaces(GrowsurfRuby::Models)
+                              .lazy
+                              .grep(GrowsurfRuby::Internal::Type::Union)
+                              .each do |mod|
+    const = :Variants
+    next if mod.sorbet_constant_defined?(const)
+
+    mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
+  end
+
+  Campaign = GrowsurfRuby::Models::Campaign
+
+  CampaignAPI = GrowsurfRuby::Models::CampaignAPI
+
+  CampaignListCommissionsParams = GrowsurfRuby::Models::CampaignListCommissionsParams
+
+  CampaignListLeaderboardParams = GrowsurfRuby::Models::CampaignListLeaderboardParams
+
+  CampaignListParams = GrowsurfRuby::Models::CampaignListParams
+
+  CampaignListParticipantsParams = GrowsurfRuby::Models::CampaignListParticipantsParams
+
+  CampaignListPayoutsParams = GrowsurfRuby::Models::CampaignListPayoutsParams
+
+  CampaignListReferralsParams = GrowsurfRuby::Models::CampaignListReferralsParams
+
+  CampaignRetrieveAnalyticsParams = GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams
+
+  CampaignRetrieveParams = GrowsurfRuby::Models::CampaignRetrieveParams
+
+  CommissionStructure = GrowsurfRuby::Models::CommissionStructure
+
+  ParticipantCommissionList = GrowsurfRuby::Models::ParticipantCommissionList
+
+  ParticipantList = GrowsurfRuby::Models::ParticipantList
+
+  ParticipantPayoutList = GrowsurfRuby::Models::ParticipantPayoutList
+
+  ReferralList = GrowsurfRuby::Models::ReferralList
+end

data/lib/growsurf_ruby/request_options.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  # Specify HTTP behaviour to use for a specific request. These options supplement
+  # or override those provided at the client level.
+  #
+  # When making a request, you can pass an actual {RequestOptions} instance, or
+  # simply pass a Hash with symbol keys matching the attributes on this class.
+  class RequestOptions < GrowsurfRuby::Internal::Type::BaseModel
+    # @api private
+    #
+    # @param opts [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
+    #
+    # @raise [ArgumentError]
+    def self.validate!(opts)
+      case opts
+      in GrowsurfRuby::RequestOptions | Hash
+        opts.to_h.each_key do |k|
+          unless fields.include?(k)
+            raise ArgumentError.new("Request `opts` keys must be one of #{fields.keys}, got #{k.inspect}")
+          end
+        end
+      else
+        raise ArgumentError.new("Request `opts` must be a Hash or RequestOptions, got #{opts.inspect}")
+      end
+    end
+
+    # @!attribute idempotency_key
+    #   Idempotency key to send with request and all associated retries. Will only be
+    #   sent for write requests.
+    #
+    #   @return [String, nil]
+    optional :idempotency_key, String
+
+    # @!attribute extra_query
+    #   Extra query params to send with the request. These are `.merge`’d into any
+    #   `query` given at the client level.
+    #
+    #   @return [Hash{String=>Array<String>, String, nil}, nil]
+    optional :extra_query, GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::ArrayOf[String]]
+
+    # @!attribute extra_headers
+    #   Extra headers to send with the request. These are `.merged`’d into any
+    #   `extra_headers` given at the client level.
+    #
+    #   @return [Hash{String=>String, nil}, nil]
+    optional :extra_headers, GrowsurfRuby::Internal::Type::HashOf[String, nil?: true]
+
+    # @!attribute extra_body
+    #   Extra data to send with the request. These are deep merged into any data
+    #   generated as part of the normal request.
+    #
+    #   @return [Object, nil]
+    optional :extra_body, GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown]
+
+    # @!attribute max_retries
+    #   Maximum number of retries to attempt after a failed initial request.
+    #
+    #   @return [Integer, nil]
+    optional :max_retries, Integer
+
+    # @!attribute timeout
+    #   Request timeout in seconds.
+    #
+    #   @return [Float, nil]
+    optional :timeout, Float
+
+    # @!method initialize(values = {})
+    #   Returns a new instance of RequestOptions.
+    #
+    #   @param values [Hash{Symbol=>Object}]
+
+    define_sorbet_constant!(:OrHash) do
+      T.type_alias { T.any(GrowsurfRuby::RequestOptions, GrowsurfRuby::Internal::AnyHash) }
+    end
+  end
+end

data/lib/growsurf_ruby/resources/campaign/commission.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Resources
+    class Campaign
+      # Affiliate transaction, commission, and payout operations.
+      class Commission
+        # Removes a pending participant commission.
+        #
+        # @overload delete(commission_id, id:, request_options: {})
+        #
+        # @param commission_id [String] Participant commission ID.
+        #
+        # @param id [String] GrowSurf program ID.
+        #
+        # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [GrowsurfRuby::Models::Campaign::CommissionDeleteResponse]
+        #
+        # @see GrowsurfRuby::Models::Campaign::CommissionDeleteParams
+        def delete(commission_id, params)
+          parsed, options = GrowsurfRuby::Campaign::CommissionDeleteParams.dump_request(params)
+          id =
+            parsed.delete(:id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :delete,
+            path: ["campaign/%1$s/commission/%2$s", id, commission_id],
+            model: GrowsurfRuby::Models::Campaign::CommissionDeleteResponse,
+            options: options
+          )
+        end
+
+        # Approves a pending participant commission so it can become eligible for payout.
+        #
+        # @overload approve(commission_id, id:, request_options: {})
+        #
+        # @param commission_id [String] Participant commission ID.
+        #
+        # @param id [String] GrowSurf program ID.
+        #
+        # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [GrowsurfRuby::Models::Campaign::CommissionApproveResponse]
+        #
+        # @see GrowsurfRuby::Models::Campaign::CommissionApproveParams
+        def approve(commission_id, params)
+          parsed, options = GrowsurfRuby::Campaign::CommissionApproveParams.dump_request(params)
+          id =
+            parsed.delete(:id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :post,
+            path: ["campaign/%1$s/commission/%2$s/approve", id, commission_id],
+            model: GrowsurfRuby::Models::Campaign::CommissionApproveResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [GrowsurfRuby::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end