growsurf-ruby 0.0.2

data/rbi/growsurf_ruby/request_options.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+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
+    OrHash =
+      T.type_alias do
+        T.any(GrowsurfRuby::RequestOptions, GrowsurfRuby::Internal::AnyHash)
+      end
+
+    # @api private
+    sig { params(opts: GrowsurfRuby::RequestOptions::OrHash).void }
+    def self.validate!(opts)
+    end
+
+    # Idempotency key to send with request and all associated retries. Will only be
+    # sent for write requests.
+    sig { returns(T.nilable(String)) }
+    attr_accessor :idempotency_key
+
+    # Extra query params to send with the request. These are `.merge`’d into any
+    # `query` given at the client level.
+    sig do
+      returns(
+        T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))])
+      )
+    end
+    attr_accessor :extra_query
+
+    # Extra headers to send with the request. These are `.merged`’d into any
+    # `extra_headers` given at the client level.
+    sig { returns(T.nilable(T::Hash[String, T.nilable(String)])) }
+    attr_accessor :extra_headers
+
+    # Extra data to send with the request. These are deep merged into any data
+    # generated as part of the normal request.
+    sig { returns(T.nilable(T.anything)) }
+    attr_accessor :extra_body
+
+    # Maximum number of retries to attempt after a failed initial request.
+    sig { returns(T.nilable(Integer)) }
+    attr_accessor :max_retries
+
+    # Request timeout in seconds.
+    sig { returns(T.nilable(Float)) }
+    attr_accessor :timeout
+
+    # Returns a new instance of RequestOptions.
+    sig do
+      params(values: GrowsurfRuby::Internal::AnyHash).returns(T.attached_class)
+    end
+    def self.new(values = {})
+    end
+  end
+end

data/rbi/growsurf_ruby/resources/campaign/commission.rbi

@@ -0,0 +1,49 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Resources
+    class Campaign
+      # Affiliate transaction, commission, and payout operations.
+      class Commission
+        # Removes a pending participant commission.
+        sig do
+          params(
+            commission_id: String,
+            id: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(GrowsurfRuby::Models::Campaign::CommissionDeleteResponse)
+        end
+        def delete(
+          # Participant commission ID.
+          commission_id,
+          # GrowSurf program ID.
+          id:,
+          request_options: {}
+        )
+        end
+
+        # Approves a pending participant commission so it can become eligible for payout.
+        sig do
+          params(
+            commission_id: String,
+            id: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(GrowsurfRuby::Models::Campaign::CommissionApproveResponse)
+        end
+        def approve(
+          # Participant commission ID.
+          commission_id,
+          # GrowSurf program ID.
+          id:,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: GrowsurfRuby::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/resources/campaign/participant.rbi

@@ -0,0 +1,385 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Resources
+    class Campaign
+      class Participant
+        # Retrieves a single participant by GrowSurf participant ID or email address.
+        sig do
+          params(
+            participant_id_or_email: String,
+            id: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(GrowsurfRuby::Campaign::CampaignParticipant)
+        end
+        def retrieve(
+          # GrowSurf participant ID or URL-encoded participant email address.
+          participant_id_or_email,
+          # GrowSurf program ID.
+          id:,
+          request_options: {}
+        )
+        end
+
+        # Updates a participant by GrowSurf participant ID or email address.
+        sig do
+          params(
+            participant_id_or_email: String,
+            id: String,
+            email: String,
+            first_name: String,
+            last_name: String,
+            metadata: T::Hash[Symbol, T.anything],
+            referral_status:
+              GrowsurfRuby::Campaign::ParticipantUpdateParams::ReferralStatus::OrSymbol,
+            referred_by: String,
+            unsubscribed: T::Boolean,
+            vanity_keys: T::Array[String],
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(GrowsurfRuby::Campaign::CampaignParticipant)
+        end
+        def update(
+          # Path param: GrowSurf participant ID or URL-encoded participant email address.
+          participant_id_or_email,
+          # Path param: GrowSurf program ID.
+          id:,
+          # Body param
+          email: nil,
+          # Body param
+          first_name: nil,
+          # Body param
+          last_name: nil,
+          # Body param: Shallow custom metadata object.
+          metadata: nil,
+          # Body param
+          referral_status: nil,
+          # Body param
+          referred_by: nil,
+          # Body param
+          unsubscribed: nil,
+          # Body param
+          vanity_keys: nil,
+          request_options: {}
+        )
+        end
+
+        # Removes a participant by GrowSurf participant ID or email address.
+        sig do
+          params(
+            participant_id_or_email: String,
+            id: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(GrowsurfRuby::Models::Campaign::ParticipantDeleteResponse)
+        end
+        def delete(
+          # GrowSurf participant ID or URL-encoded participant email address.
+          participant_id_or_email,
+          # GrowSurf program ID.
+          id:,
+          request_options: {}
+        )
+        end
+
+        # Adds a new participant to the program. If the email already exists, the existing
+        # participant is returned.
+        sig do
+          params(
+            id: String,
+            email: String,
+            fingerprint: String,
+            first_name: String,
+            ip_address: String,
+            last_name: String,
+            metadata: T::Hash[Symbol, T.anything],
+            referral_status:
+              GrowsurfRuby::Campaign::ParticipantAddParams::ReferralStatus::OrSymbol,
+            referred_by: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(GrowsurfRuby::Campaign::CampaignParticipant)
+        end
+        def add(
+          # GrowSurf program ID.
+          id,
+          email:,
+          fingerprint: nil,
+          first_name: nil,
+          ip_address: nil,
+          last_name: nil,
+          # Shallow custom metadata object.
+          metadata: nil,
+          referral_status: nil,
+          # Referrer participant ID or email address.
+          referred_by: nil,
+          request_options: {}
+        )
+        end
+
+        # Retrieves a paged list of commissions earned by a participant.
+        sig do
+          params(
+            participant_id_or_email: String,
+            id: String,
+            limit: Integer,
+            next_id: String,
+            status:
+              GrowsurfRuby::Campaign::ParticipantListCommissionsParams::Status::OrSymbol,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(GrowsurfRuby::ParticipantCommissionList)
+        end
+        def list_commissions(
+          # Path param: GrowSurf participant ID or URL-encoded participant email address.
+          participant_id_or_email,
+          # Path param: GrowSurf program ID.
+          id:,
+          # Query param: Number of results to return. Maximum 100.
+          limit: nil,
+          # Query param: ID to start the next paged result set with.
+          next_id: nil,
+          # Query param: Participant commission status.
+          status: nil,
+          request_options: {}
+        )
+        end
+
+        # Retrieves a paged list of payouts that belong to a participant.
+        sig do
+          params(
+            participant_id_or_email: String,
+            id: String,
+            limit: Integer,
+            next_id: String,
+            status:
+              GrowsurfRuby::Campaign::ParticipantListPayoutsParams::Status::OrSymbol,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(GrowsurfRuby::ParticipantPayoutList)
+        end
+        def list_payouts(
+          # Path param: GrowSurf participant ID or URL-encoded participant email address.
+          participant_id_or_email,
+          # Path param: GrowSurf program ID.
+          id:,
+          # Query param: Number of results to return. Maximum 100.
+          limit: nil,
+          # Query param: ID to start the next paged result set with.
+          next_id: nil,
+          # Query param: Participant payout status.
+          status: nil,
+          request_options: {}
+        )
+        end
+
+        # Retrieves referrals and email invites made by a participant.
+        sig do
+          params(
+            participant_id_or_email: String,
+            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::Campaign::ParticipantListReferralsParams::SortBy::OrSymbol,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(GrowsurfRuby::ReferralList)
+        end
+        def list_referrals(
+          # Path param: GrowSurf participant ID or URL-encoded participant email address.
+          participant_id_or_email,
+          # Path param: GrowSurf program ID.
+          id:,
+          # Query param: Return results in descending order when true.
+          desc: nil,
+          # Query param: URL-encoded email value to filter referral results.
+          email: nil,
+          # Query param: First name value to filter results.
+          first_name: nil,
+          # Query param: Last name value to filter results.
+          last_name: nil,
+          # Query param: Number of results to return. Maximum 100.
+          limit: nil,
+          # Query param: ID to start the next paged result set with.
+          next_id: nil,
+          # Query param: Offset number used to skip through a result set.
+          offset: nil,
+          # Query param
+          referral_status: nil,
+          # Query param: Field used to sort referral results.
+          sort_by: nil,
+          request_options: {}
+        )
+        end
+
+        # Retrieves a paged list of rewards earned by a participant.
+        sig do
+          params(
+            participant_id_or_email: String,
+            id: String,
+            limit: Integer,
+            next_id: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(
+            GrowsurfRuby::Models::Campaign::ParticipantListRewardsResponse
+          )
+        end
+        def list_rewards(
+          # Path param: GrowSurf participant ID or URL-encoded participant email address.
+          participant_id_or_email,
+          # Path param: GrowSurf program ID.
+          id:,
+          # Query param: Number of results to return. Maximum 100.
+          limit: nil,
+          # Query param: ID to start the next paged result set with.
+          next_id: nil,
+          request_options: {}
+        )
+        end
+
+        # Records a sale made by a referred customer and generates affiliate commissions
+        # for their referrer when applicable.
+        sig do
+          params(
+            participant_id_or_email: String,
+            id: String,
+            currency: String,
+            gross_amount: Integer,
+            amount_cash_net: Integer,
+            amount_paid: Integer,
+            charge_id: String,
+            customer_id: String,
+            description: String,
+            external_id: String,
+            invoice_id: String,
+            invoice_subtotal_excluding_tax: Integer,
+            invoice_total: Integer,
+            invoice_total_excluding_tax: Integer,
+            net_amount: Integer,
+            order_id: String,
+            paid_at: Integer,
+            payment_id: String,
+            payment_intent_id: String,
+            subscription_id: String,
+            tax_amount: Integer,
+            total_tax_amount: Integer,
+            total_tax_amounts: T::Array[T::Hash[Symbol, T.anything]],
+            total_taxes: T::Array[T::Hash[Symbol, T.anything]],
+            transaction_id: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(
+            GrowsurfRuby::Models::Campaign::ParticipantRecordTransactionResponse::Variants
+          )
+        end
+        def record_transaction(
+          # Path param: GrowSurf participant ID or URL-encoded participant email address.
+          participant_id_or_email,
+          # Path param: GrowSurf program ID.
+          id:,
+          # Body param
+          currency:,
+          # Body param
+          gross_amount:,
+          # Body param
+          amount_cash_net: nil,
+          # Body param
+          amount_paid: nil,
+          # Body param
+          charge_id: nil,
+          # Body param
+          customer_id: nil,
+          # Body param
+          description: nil,
+          # Body param
+          external_id: nil,
+          # Body param
+          invoice_id: nil,
+          # Body param
+          invoice_subtotal_excluding_tax: nil,
+          # Body param
+          invoice_total: nil,
+          # Body param
+          invoice_total_excluding_tax: nil,
+          # Body param
+          net_amount: nil,
+          # Body param
+          order_id: nil,
+          # Body param
+          paid_at: nil,
+          # Body param
+          payment_id: nil,
+          # Body param
+          payment_intent_id: nil,
+          # Body param
+          subscription_id: nil,
+          # Body param
+          tax_amount: nil,
+          # Body param
+          total_tax_amount: nil,
+          # Body param
+          total_tax_amounts: nil,
+          # Body param
+          total_taxes: nil,
+          # Body param
+          transaction_id: nil,
+          request_options: {}
+        )
+        end
+
+        # Sends email invites on behalf of a participant to a list of email addresses.
+        sig do
+          params(
+            participant_id_or_email: String,
+            id: String,
+            email_addresses: T::Array[String],
+            message_text: String,
+            subject_text: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(
+            GrowsurfRuby::Models::Campaign::ParticipantSendInvitesResponse
+          )
+        end
+        def send_invites(
+          # Path param: GrowSurf participant ID or URL-encoded participant email address.
+          participant_id_or_email,
+          # Path param: GrowSurf program ID.
+          id:,
+          # Body param
+          email_addresses:,
+          # Body param
+          message_text:,
+          # Body param
+          subject_text:,
+          request_options: {}
+        )
+        end
+
+        # Triggers referral credit for an existing referred participant by GrowSurf
+        # participant ID or email address.
+        sig do
+          params(
+            participant_id_or_email: String,
+            id: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(
+            GrowsurfRuby::Models::Campaign::ParticipantTriggerReferralResponse
+          )
+        end
+        def trigger_referral(
+          # GrowSurf participant ID or URL-encoded participant email address.
+          participant_id_or_email,
+          # GrowSurf program ID.
+          id:,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: GrowsurfRuby::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/resources/campaign/reward.rbi

@@ -0,0 +1,70 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Resources
+    class Campaign
+      # Participant reward retrieval and manual reward operations.
+      class Reward
+        # Removes a manually approved participant reward that has not already been
+        # approved.
+        sig do
+          params(
+            reward_id: String,
+            id: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(GrowsurfRuby::Models::Campaign::RewardDeleteResponse)
+        end
+        def delete(
+          # Participant reward ID.
+          reward_id,
+          # GrowSurf program ID.
+          id:,
+          request_options: {}
+        )
+        end
+
+        # Approves a manually approved reward earned by a participant.
+        sig do
+          params(
+            reward_id: String,
+            id: String,
+            fulfill: T::Boolean,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(GrowsurfRuby::Models::Campaign::RewardApproveResponse)
+        end
+        def approve(
+          # Path param: Participant reward ID.
+          reward_id,
+          # Path param: GrowSurf program ID.
+          id:,
+          # Body param: Set true to mark the reward as fulfilled after approval.
+          fulfill: nil,
+          request_options: {}
+        )
+        end
+
+        # Marks an approved participant reward as fulfilled.
+        sig do
+          params(
+            reward_id: String,
+            id: String,
+            request_options: GrowsurfRuby::RequestOptions::OrHash
+          ).returns(GrowsurfRuby::Models::Campaign::RewardFulfillResponse)
+        end
+        def fulfill(
+          # Participant reward ID.
+          reward_id,
+          # GrowSurf program ID.
+          id:,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: GrowsurfRuby::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end