growsurf-ruby 0.0.2

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

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Participant#record_transaction
+      module ParticipantRecordTransactionResponse
+        extend GrowsurfRuby::Internal::Type::Union
+
+        variant -> { GrowsurfRuby::Models::Campaign::ParticipantRecordTransactionResponse::UnionMember0 }
+
+        variant -> { GrowsurfRuby::Models::Campaign::ParticipantRecordTransactionResponse::UnionMember1 }
+
+        class UnionMember0 < GrowsurfRuby::Internal::Type::BaseModel
+          # @!attribute duplicate
+          #
+          #   @return [Boolean, false]
+          required :duplicate, const: false
+
+          # @!attribute first_sale
+          #
+          #   @return [Boolean]
+          required :first_sale, GrowsurfRuby::Internal::Type::Boolean, api_name: :firstSale
+
+          # @!attribute message
+          #
+          #   @return [String]
+          required :message, String
+
+          # @!attribute success
+          #
+          #   @return [Boolean, true]
+          required :success, const: true
+
+          # @!method initialize(first_sale:, message:, duplicate: false, success: true)
+          #   @param first_sale [Boolean]
+          #   @param message [String]
+          #   @param duplicate [Boolean, false]
+          #   @param success [Boolean, true]
+        end
+
+        class UnionMember1 < GrowsurfRuby::Internal::Type::BaseModel
+          # @!attribute commissions_created
+          #
+          #   @return [Integer]
+          required :commissions_created, Integer, api_name: :commissionsCreated
+
+          # @!attribute duplicate
+          #
+          #   @return [Boolean, true]
+          required :duplicate, const: true
+
+          # @!attribute duplicate_fields
+          #
+          #   @return [Array<String>]
+          required :duplicate_fields,
+                   GrowsurfRuby::Internal::Type::ArrayOf[String],
+                   api_name: :duplicateFields
+
+          # @!attribute matching_commission_ids
+          #
+          #   @return [Array<String>]
+          required :matching_commission_ids,
+                   GrowsurfRuby::Internal::Type::ArrayOf[String],
+                   api_name: :matchingCommissionIds
+
+          # @!attribute message
+          #
+          #   @return [String]
+          required :message, String
+
+          # @!attribute success
+          #
+          #   @return [Boolean, false]
+          required :success, const: false
+
+          # @!method initialize(commissions_created:, duplicate_fields:, matching_commission_ids:, message:, duplicate: true, success: false)
+          #   @param commissions_created [Integer]
+          #   @param duplicate_fields [Array<String>]
+          #   @param matching_commission_ids [Array<String>]
+          #   @param message [String]
+          #   @param duplicate [Boolean, true]
+          #   @param success [Boolean, false]
+        end
+
+        # @!method self.variants
+        #   @return [Array(GrowsurfRuby::Models::Campaign::ParticipantRecordTransactionResponse::UnionMember0, GrowsurfRuby::Models::Campaign::ParticipantRecordTransactionResponse::UnionMember1)]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Participant#retrieve
+      class ParticipantRetrieveParams < 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_reward.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      class ParticipantReward < GrowsurfRuby::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute reward_id
+        #
+        #   @return [String]
+        required :reward_id, String, api_name: :rewardId
+
+        # @!attribute status
+        #
+        #   @return [Symbol, GrowsurfRuby::Models::Campaign::ParticipantReward::Status]
+        required :status, enum: -> { GrowsurfRuby::Campaign::ParticipantReward::Status }
+
+        # @!attribute approved
+        #
+        #   @return [Boolean, nil]
+        optional :approved, GrowsurfRuby::Internal::Type::Boolean
+
+        # @!attribute approved_at
+        #
+        #   @return [Integer, nil]
+        optional :approved_at, Integer, api_name: :approvedAt
+
+        # @!attribute commission_structure
+        #
+        #   @return [GrowsurfRuby::Models::CommissionStructure, nil]
+        optional :commission_structure,
+                 -> { GrowsurfRuby::CommissionStructure },
+                 api_name: :commissionStructure,
+                 nil?: true
+
+        # @!attribute fulfilled_at
+        #
+        #   @return [Integer, nil]
+        optional :fulfilled_at, Integer, api_name: :fulfilledAt
+
+        # @!attribute is_available
+        #
+        #   @return [Boolean, nil]
+        optional :is_available, GrowsurfRuby::Internal::Type::Boolean, api_name: :isAvailable
+
+        # @!attribute is_fulfilled
+        #
+        #   @return [Boolean, nil]
+        optional :is_fulfilled, GrowsurfRuby::Internal::Type::Boolean, api_name: :isFulfilled
+
+        # @!attribute is_referrer
+        #
+        #   @return [Boolean, nil]
+        optional :is_referrer, GrowsurfRuby::Internal::Type::Boolean, api_name: :isReferrer
+
+        # @!attribute referred_id
+        #
+        #   @return [String, nil]
+        optional :referred_id, String, api_name: :referredId
+
+        # @!attribute referrer_id
+        #
+        #   @return [String, nil]
+        optional :referrer_id, String, api_name: :referrerId
+
+        # @!attribute unread
+        #
+        #   @return [Boolean, nil]
+        optional :unread, GrowsurfRuby::Internal::Type::Boolean
+
+        # @!method initialize(id:, reward_id:, status:, approved: nil, approved_at: nil, commission_structure: nil, fulfilled_at: nil, is_available: nil, is_fulfilled: nil, is_referrer: nil, referred_id: nil, referrer_id: nil, unread: nil)
+        #   @param id [String]
+        #   @param reward_id [String]
+        #   @param status [Symbol, GrowsurfRuby::Models::Campaign::ParticipantReward::Status]
+        #   @param approved [Boolean]
+        #   @param approved_at [Integer]
+        #   @param commission_structure [GrowsurfRuby::Models::CommissionStructure, nil]
+        #   @param fulfilled_at [Integer]
+        #   @param is_available [Boolean]
+        #   @param is_fulfilled [Boolean]
+        #   @param is_referrer [Boolean]
+        #   @param referred_id [String]
+        #   @param referrer_id [String]
+        #   @param unread [Boolean]
+
+        # @see GrowsurfRuby::Models::Campaign::ParticipantReward#status
+        module Status
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          PENDING = :PENDING
+          FULFILLED = :FULFILLED
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Participant#send_invites
+      class ParticipantSendInvitesParams < 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 email_addresses
+        #
+        #   @return [Array<String>]
+        required :email_addresses, GrowsurfRuby::Internal::Type::ArrayOf[String], api_name: :emailAddresses
+
+        # @!attribute message_text
+        #
+        #   @return [String]
+        required :message_text, String, api_name: :messageText
+
+        # @!attribute subject_text
+        #
+        #   @return [String]
+        required :subject_text, String, api_name: :subjectText
+
+        # @!method initialize(id:, participant_id_or_email:, email_addresses:, message_text:, subject_text:, request_options: {})
+        #   @param id [String]
+        #   @param participant_id_or_email [String]
+        #   @param email_addresses [Array<String>]
+        #   @param message_text [String]
+        #   @param subject_text [String]
+        #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Participant#send_invites
+      class ParticipantSendInvitesResponse < GrowsurfRuby::Internal::Type::BaseModel
+        # @!attribute invites_sent
+        #
+        #   @return [Integer]
+        required :invites_sent, Integer, api_name: :invitesSent
+
+        # @!attribute message_type
+        #
+        #   @return [String]
+        required :message_type, String, api_name: :messageType
+
+        # @!attribute success
+        #
+        #   @return [Boolean]
+        required :success, GrowsurfRuby::Internal::Type::Boolean
+
+        # @!method initialize(invites_sent:, message_type:, success:)
+        #   @param invites_sent [Integer]
+        #   @param message_type [String]
+        #   @param success [Boolean]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Participant#trigger_referral
+      class ParticipantTriggerReferralParams < 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_trigger_referral_response.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Participant#trigger_referral
+      class ParticipantTriggerReferralResponse < GrowsurfRuby::Internal::Type::BaseModel
+        # @!attribute success
+        #
+        #   @return [Boolean]
+        required :success, GrowsurfRuby::Internal::Type::Boolean
+
+        # @!attribute message
+        #
+        #   @return [String, nil]
+        optional :message, String
+
+        # @!method initialize(success:, message: nil)
+        #   @param success [Boolean]
+        #   @param message [String]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Participant#update
+      class ParticipantUpdateParams < 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 email
+        #
+        #   @return [String, nil]
+        optional :email, String
+
+        # @!attribute first_name
+        #
+        #   @return [String, nil]
+        optional :first_name, String, api_name: :firstName
+
+        # @!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::ParticipantUpdateParams::ReferralStatus, nil]
+        optional :referral_status,
+                 enum: -> { GrowsurfRuby::Campaign::ParticipantUpdateParams::ReferralStatus },
+                 api_name: :referralStatus
+
+        # @!attribute referred_by
+        #
+        #   @return [String, nil]
+        optional :referred_by, String, api_name: :referredBy
+
+        # @!attribute unsubscribed
+        #
+        #   @return [Boolean, nil]
+        optional :unsubscribed, GrowsurfRuby::Internal::Type::Boolean
+
+        # @!attribute vanity_keys
+        #
+        #   @return [Array<String>, nil]
+        optional :vanity_keys, GrowsurfRuby::Internal::Type::ArrayOf[String], api_name: :vanityKeys
+
+        # @!method initialize(id:, participant_id_or_email:, email: nil, first_name: nil, last_name: nil, metadata: nil, referral_status: nil, referred_by: nil, unsubscribed: nil, vanity_keys: nil, request_options: {})
+        #   @param id [String]
+        #
+        #   @param participant_id_or_email [String]
+        #
+        #   @param email [String]
+        #
+        #   @param first_name [String]
+        #
+        #   @param last_name [String]
+        #
+        #   @param metadata [Hash{Symbol=>Object}] Shallow custom metadata object.
+        #
+        #   @param referral_status [Symbol, GrowsurfRuby::Models::Campaign::ParticipantUpdateParams::ReferralStatus]
+        #
+        #   @param referred_by [String]
+        #
+        #   @param unsubscribed [Boolean]
+        #
+        #   @param vanity_keys [Array<String>]
+        #
+        #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
+
+        module ReferralStatus
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          CREDIT_PENDING = :CREDIT_PENDING
+          CREDIT_AWARDED = :CREDIT_AWARDED
+          CREDIT_EXPIRED = :CREDIT_EXPIRED
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      module ReferralSource
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        DIRECT = :DIRECT
+        PARTICIPANT = :PARTICIPANT
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      module ReferralStatus
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        CREDIT_PENDING = :CREDIT_PENDING
+        CREDIT_AWARDED = :CREDIT_AWARDED
+        CREDIT_EXPIRED = :CREDIT_EXPIRED
+        INVITE_SENT = :INVITE_SENT
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Reward#approve
+      class RewardApproveParams < GrowsurfRuby::Internal::Type::BaseModel
+        extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+        include GrowsurfRuby::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute reward_id
+        #
+        #   @return [String]
+        required :reward_id, String
+
+        # @!attribute fulfill
+        #   Set true to mark the reward as fulfilled after approval.
+        #
+        #   @return [Boolean, nil]
+        optional :fulfill, GrowsurfRuby::Internal::Type::Boolean
+
+        # @!method initialize(id:, reward_id:, fulfill: nil, request_options: {})
+        #   @param id [String]
+        #
+        #   @param reward_id [String]
+        #
+        #   @param fulfill [Boolean] Set true to mark the reward as fulfilled after approval.
+        #
+        #   @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Reward#approve
+      class RewardApproveResponse < 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/reward_delete_params.rb

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

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    module Campaign
+      # @see GrowsurfRuby::Resources::Campaign::Reward#delete
+      class RewardDeleteResponse < 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/reward_fulfill_params.rb

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

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

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