growsurf-ruby 0.0.2

data/lib/growsurf_ruby/models/campaign/participant_add_params.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Participant#add
+      class ParticipantAddParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute email
+        #
+        #   @return [String]
+        required :email, String
+
+        # @!attribute fingerprint
+        #
+        #   @return [String, nil]
+        optional :fingerprint, String
+
+        # @!attribute first_name
+        #
+        #   @return [String, nil]
+        optional :first_name, String, api_name: :firstName
+
+        # @!attribute ip_address
+        #
+        #   @return [String, nil]
+        optional :ip_address, String, api_name: :ipAddress
+
+        # @!attribute last_name
+        #
+        #   @return [String, nil]
+        optional :last_name, String, api_name: :lastName
+
+        # @!attribute metadata
+        #   Shallow custom metadata object.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :metadata, GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown]
+
+        # @!attribute referral_status
+        #
+        #   @return [Symbol, GrowsurfRuby::Models::Campaign::ParticipantAddParams::ReferralStatus, nil]
+        optional :referral_status,
+                 enum: -> { GrowsurfRuby::Campaign::ParticipantAddParams::ReferralStatus },
+                 api_name: :referralStatus
+
+        # @!attribute referred_by
+        #   Referrer participant ID or email address.
+        #
+        #   @return [String, nil]
+        optional :referred_by, String, api_name: :referredBy
+
+        # @!method initialize(id:, email:, fingerprint: nil, first_name: nil, ip_address: nil, last_name: nil, metadata: nil, referral_status: nil, referred_by: nil, request_options: {})
+        #   @param id [String]
+        #
+        #   @param email [String]
+        #
+        #   @param fingerprint [String]
+        #
+        #   @param first_name [String]
+        #
+        #   @param ip_address [String]
+        #
+        #   @param last_name [String]
+        #
+        #   @param metadata [Hash{Symbol=>Object}] Shallow custom metadata object.
+        #
+        #   @param referral_status [Symbol, GrowsurfRuby::Models::Campaign::ParticipantAddParams::ReferralStatus]
+        #
+        #   @param referred_by [String] Referrer participant ID or email address.
+        #
+        #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
+
+        module ReferralStatus
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          CREDIT_PENDING = :CREDIT_PENDING
+          CREDIT_AWARDED = :CREDIT_AWARDED
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign/participant_delete_params.rb

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

data/lib/growsurf_ruby/models/campaign/participant_delete_response.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Participant#delete
+      class ParticipantDeleteResponse < GrowsurfRuby::Internal::Type::BaseModel
+        # @!attribute success
+        #
+        #   @return [Boolean]
+        required :success, GrowsurfRuby::Internal::Type::Boolean
+
+        # @!method initialize(success:)
+        #   @param success [Boolean]
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign/participant_list_commissions_params.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Participant#list_commissions
+      class ParticipantListCommissionsParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute participant_id_or_email
+        #
+        #   @return [String]
+        required :participant_id_or_email, 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::Campaign::ParticipantListCommissionsParams::Status, nil]
+        optional :status, enum: -> { GrowsurfRuby::Campaign::ParticipantListCommissionsParams::Status }
+
+        # @!method initialize(id:, participant_id_or_email:, limit: nil, next_id: nil, status: nil, request_options: {})
+        #   @param id [String]
+        #
+        #   @param participant_id_or_email [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::Campaign::ParticipantListCommissionsParams::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
+end

data/lib/growsurf_ruby/models/campaign/participant_list_payouts_params.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Participant#list_payouts
+      class ParticipantListPayoutsParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute participant_id_or_email
+        #
+        #   @return [String]
+        required :participant_id_or_email, 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::Campaign::ParticipantListPayoutsParams::Status, nil]
+        optional :status, enum: -> { GrowsurfRuby::Campaign::ParticipantListPayoutsParams::Status }
+
+        # @!method initialize(id:, participant_id_or_email:, limit: nil, next_id: nil, status: nil, request_options: {})
+        #   @param id [String]
+        #
+        #   @param participant_id_or_email [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::Campaign::ParticipantListPayoutsParams::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
+end

data/lib/growsurf_ruby/models/campaign/participant_list_referrals_params.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Participant#list_referrals
+      class ParticipantListReferralsParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute participant_id_or_email
+        #
+        #   @return [String]
+        required :participant_id_or_email, 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::Campaign::ParticipantListReferralsParams::SortBy, nil]
+        optional :sort_by, enum: -> { GrowsurfRuby::Campaign::ParticipantListReferralsParams::SortBy }
+
+        # @!method initialize(id:, participant_id_or_email:, 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 participant_id_or_email [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::Campaign::ParticipantListReferralsParams::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
+end

data/lib/growsurf_ruby/models/campaign/participant_list_rewards_params.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Participant#list_rewards
+      class ParticipantListRewardsParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute participant_id_or_email
+        #
+        #   @return [String]
+        required :participant_id_or_email, 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:, participant_id_or_email:, limit: nil, next_id: nil, request_options: {})
+        #   @param id [String]
+        #
+        #   @param participant_id_or_email [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
+end

data/lib/growsurf_ruby/models/campaign/participant_list_rewards_response.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Participant#list_rewards
+      class ParticipantListRewardsResponse < 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 rewards
+        #
+        #   @return [Array<GrowsurfRuby::Models::Campaign::ParticipantReward>]
+        required :rewards, -> { GrowsurfRuby::Internal::Type::ArrayOf[GrowsurfRuby::Campaign::ParticipantReward] }
+
+        # @!method initialize(limit:, next_id:, rewards:)
+        #   @param limit [Integer]
+        #   @param next_id [String, nil]
+        #   @param rewards [Array<GrowsurfRuby::Models::Campaign::ParticipantReward>]
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/campaign/participant_record_transaction_params.rb

@@ -0,0 +1,170 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Participant#record_transaction
+      class ParticipantRecordTransactionParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute participant_id_or_email
+        #
+        #   @return [String]
+        required :participant_id_or_email, String
+
+        # @!attribute currency
+        #
+        #   @return [String]
+        required :currency, String
+
+        # @!attribute gross_amount
+        #
+        #   @return [Integer]
+        required :gross_amount, Integer, api_name: :grossAmount
+
+        # @!attribute amount_cash_net
+        #
+        #   @return [Integer, nil]
+        optional :amount_cash_net, Integer, api_name: :amountCashNet
+
+        # @!attribute amount_paid
+        #
+        #   @return [Integer, nil]
+        optional :amount_paid, Integer, api_name: :amountPaid
+
+        # @!attribute charge_id
+        #
+        #   @return [String, nil]
+        optional :charge_id, String, api_name: :chargeId
+
+        # @!attribute customer_id
+        #
+        #   @return [String, nil]
+        optional :customer_id, String, api_name: :customerId
+
+        # @!attribute description
+        #
+        #   @return [String, nil]
+        optional :description, String
+
+        # @!attribute external_id
+        #
+        #   @return [String, nil]
+        optional :external_id, String, api_name: :externalId
+
+        # @!attribute invoice_id
+        #
+        #   @return [String, nil]
+        optional :invoice_id, String, api_name: :invoiceId
+
+        # @!attribute invoice_subtotal_excluding_tax
+        #
+        #   @return [Integer, nil]
+        optional :invoice_subtotal_excluding_tax, Integer, api_name: :invoiceSubtotalExcludingTax
+
+        # @!attribute invoice_total
+        #
+        #   @return [Integer, nil]
+        optional :invoice_total, Integer, api_name: :invoiceTotal
+
+        # @!attribute invoice_total_excluding_tax
+        #
+        #   @return [Integer, nil]
+        optional :invoice_total_excluding_tax, Integer, api_name: :invoiceTotalExcludingTax
+
+        # @!attribute net_amount
+        #
+        #   @return [Integer, nil]
+        optional :net_amount, Integer, api_name: :netAmount
+
+        # @!attribute order_id
+        #
+        #   @return [String, nil]
+        optional :order_id, String, api_name: :orderId
+
+        # @!attribute paid_at
+        #
+        #   @return [Integer, nil]
+        optional :paid_at, Integer, api_name: :paidAt
+
+        # @!attribute payment_id
+        #
+        #   @return [String, nil]
+        optional :payment_id, String, api_name: :paymentId
+
+        # @!attribute payment_intent_id
+        #
+        #   @return [String, nil]
+        optional :payment_intent_id, String, api_name: :paymentIntentId
+
+        # @!attribute subscription_id
+        #
+        #   @return [String, nil]
+        optional :subscription_id, String, api_name: :subscriptionId
+
+        # @!attribute tax_amount
+        #
+        #   @return [Integer, nil]
+        optional :tax_amount, Integer, api_name: :taxAmount
+
+        # @!attribute total_tax_amount
+        #
+        #   @return [Integer, nil]
+        optional :total_tax_amount, Integer, api_name: :totalTaxAmount
+
+        # @!attribute total_tax_amounts
+        #
+        #   @return [Array<Hash{Symbol=>Object}>, nil]
+        optional :total_tax_amounts,
+                 GrowsurfRuby::Internal::Type::ArrayOf[GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown]],
+                 api_name: :totalTaxAmounts
+
+        # @!attribute total_taxes
+        #
+        #   @return [Array<Hash{Symbol=>Object}>, nil]
+        optional :total_taxes,
+                 GrowsurfRuby::Internal::Type::ArrayOf[GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown]],
+                 api_name: :totalTaxes
+
+        # @!attribute transaction_id
+        #
+        #   @return [String, nil]
+        optional :transaction_id, String, api_name: :transactionId
+
+        # @!method initialize(id:, participant_id_or_email:, currency:, gross_amount:, amount_cash_net: nil, amount_paid: nil, charge_id: nil, customer_id: nil, description: nil, external_id: nil, invoice_id: nil, invoice_subtotal_excluding_tax: nil, invoice_total: nil, invoice_total_excluding_tax: nil, net_amount: nil, order_id: nil, paid_at: nil, payment_id: nil, payment_intent_id: nil, subscription_id: nil, tax_amount: nil, total_tax_amount: nil, total_tax_amounts: nil, total_taxes: nil, transaction_id: nil, request_options: {})
+        #   @param id [String]
+        #   @param participant_id_or_email [String]
+        #   @param currency [String]
+        #   @param gross_amount [Integer]
+        #   @param amount_cash_net [Integer]
+        #   @param amount_paid [Integer]
+        #   @param charge_id [String]
+        #   @param customer_id [String]
+        #   @param description [String]
+        #   @param external_id [String]
+        #   @param invoice_id [String]
+        #   @param invoice_subtotal_excluding_tax [Integer]
+        #   @param invoice_total [Integer]
+        #   @param invoice_total_excluding_tax [Integer]
+        #   @param net_amount [Integer]
+        #   @param order_id [String]
+        #   @param paid_at [Integer]
+        #   @param payment_id [String]
+        #   @param payment_intent_id [String]
+        #   @param subscription_id [String]
+        #   @param tax_amount [Integer]
+        #   @param total_tax_amount [Integer]
+        #   @param total_tax_amounts [Array<Hash{Symbol=>Object}>]
+        #   @param total_taxes [Array<Hash{Symbol=>Object}>]
+        #   @param transaction_id [String]
+        #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end