growsurf-ruby 1.2.1 → 1.4.0

data/sig/growsurf_ruby/models/campaign_review_affiliate_application_params.rbs

@@ -0,0 +1,79 @@
+module GrowsurfRuby
+  module Models
+    type campaign_review_affiliate_application_params =
+      {
+        id: String,
+        application_id: String,
+        allow_immediate_reapply: bool,
+        reapply_allowed_at: Integer,
+        rejection_reason: String,
+        review_note: String,
+        status: GrowsurfRuby::Models::CampaignReviewAffiliateApplicationParams::status
+      }
+      & GrowsurfRuby::Internal::Type::request_parameters
+
+    class CampaignReviewAffiliateApplicationParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      attr_accessor id: String
+
+      attr_accessor application_id: String
+
+      attr_reader allow_immediate_reapply: bool?
+
+      def allow_immediate_reapply=: (bool) -> bool
+
+      attr_reader reapply_allowed_at: Integer?
+
+      def reapply_allowed_at=: (Integer) -> Integer
+
+      attr_reader rejection_reason: String?
+
+      def rejection_reason=: (String) -> String
+
+      attr_reader review_note: String?
+
+      def review_note=: (String) -> String
+
+      attr_reader status: GrowsurfRuby::Models::CampaignReviewAffiliateApplicationParams::status?
+
+      def status=: (
+        GrowsurfRuby::Models::CampaignReviewAffiliateApplicationParams::status
+      ) -> GrowsurfRuby::Models::CampaignReviewAffiliateApplicationParams::status
+
+      def initialize: (
+        id: String,
+        application_id: String,
+        ?allow_immediate_reapply: bool,
+        ?reapply_allowed_at: Integer,
+        ?rejection_reason: String,
+        ?review_note: String,
+        ?status: GrowsurfRuby::Models::CampaignReviewAffiliateApplicationParams::status,
+        ?request_options: GrowsurfRuby::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        application_id: String,
+        allow_immediate_reapply: bool,
+        reapply_allowed_at: Integer,
+        rejection_reason: String,
+        review_note: String,
+        status: GrowsurfRuby::Models::CampaignReviewAffiliateApplicationParams::status,
+        request_options: GrowsurfRuby::RequestOptions
+      }
+
+      type status = :APPROVED | :DENIED
+
+      module Status
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        APPROVED: :APPROVED
+        DENIED: :DENIED
+
+        def self?.values: -> ::Array[GrowsurfRuby::Models::CampaignReviewAffiliateApplicationParams::status]
+      end
+    end
+  end
+end

data/sig/growsurf_ruby/models/campaign_revoke_affiliate_invite_params.rbs

@@ -0,0 +1,28 @@
+module GrowsurfRuby
+  module Models
+    type campaign_revoke_affiliate_invite_params =
+      { id: String, invite_id: String }
+      & GrowsurfRuby::Internal::Type::request_parameters
+
+    class CampaignRevokeAffiliateInviteParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      attr_accessor id: String
+
+      attr_accessor invite_id: String
+
+      def initialize: (
+        id: String,
+        invite_id: String,
+        ?request_options: GrowsurfRuby::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        invite_id: String,
+        request_options: GrowsurfRuby::RequestOptions
+      }
+    end
+  end
+end

data/sig/growsurf_ruby/models/commission_structure.rbs

@@ -7,7 +7,7 @@ module GrowsurfRuby
         approval_required: bool?,
         duration: String?,
         duration_in_months: Integer?,
-        event: String?,
+        event: GrowsurfRuby::Models::CommissionStructure::event?,
         has_intro: bool?,
         has_max_amount: bool?,
         hold_duration: Integer?,
@@ -35,7 +35,7 @@ module GrowsurfRuby
 
       attr_accessor duration_in_months: Integer?
 
-      attr_accessor event: String?
+      attr_accessor event: GrowsurfRuby::Models::CommissionStructure::event?
 
       attr_accessor has_intro: bool?
 
@@ -71,7 +71,7 @@ module GrowsurfRuby
         ?approval_required: bool?,
         ?duration: String?,
         ?duration_in_months: Integer?,
-        ?event: String?,
+        ?event: GrowsurfRuby::Models::CommissionStructure::event?,
         ?has_intro: bool?,
         ?has_max_amount: bool?,
         ?hold_duration: Integer?,
@@ -94,7 +94,7 @@ module GrowsurfRuby
         approval_required: bool?,
         duration: String?,
         duration_in_months: Integer?,
-        event: String?,
+        event: GrowsurfRuby::Models::CommissionStructure::event?,
         has_intro: bool?,
         has_max_amount: bool?,
         hold_duration: Integer?,
@@ -111,6 +111,18 @@ module GrowsurfRuby
         type: GrowsurfRuby::Models::CommissionStructure::type_?
       }
 
+      type event = :CLICK | :LEAD | :SALE
+
+      module Event
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        CLICK: :CLICK
+        LEAD: :LEAD
+        SALE: :SALE
+
+        def self?.values: -> ::Array[GrowsurfRuby::Models::CommissionStructure::event]
+      end
+
       type type_ = :PERCENT | :FIXED
 
       module Type

data/sig/growsurf_ruby/models/email_analytics.rbs

@@ -0,0 +1,92 @@
+module GrowsurfRuby
+  module Models
+    type email_analytics =
+      {
+        sent: Integer,
+        delivered: Integer,
+        opened: Integer,
+        clicked: Integer,
+        bounced: Integer,
+        spam_complaints: Integer,
+        delivery_rate: Float,
+        open_rate: Float,
+        click_rate: Float,
+        bounce_rate: Float,
+        by_type: Array[GrowsurfRuby::Models::EmailAnalytics::ByType],
+        coverage_start_date: Integer?,
+        is_partial: bool
+      }
+
+    class EmailAnalytics < GrowsurfRuby::Internal::Type::BaseModel
+      attr_accessor sent: Integer
+      attr_accessor delivered: Integer
+      attr_accessor opened: Integer
+      attr_accessor clicked: Integer
+      attr_accessor bounced: Integer
+      attr_accessor spam_complaints: Integer
+      attr_accessor delivery_rate: Float
+      attr_accessor open_rate: Float
+      attr_accessor click_rate: Float
+      attr_accessor bounce_rate: Float
+      attr_accessor by_type: Array[GrowsurfRuby::Models::EmailAnalytics::ByType]
+      attr_accessor coverage_start_date: Integer?
+      attr_accessor is_partial: bool
+
+      def initialize: (
+        sent: Integer,
+        delivered: Integer,
+        opened: Integer,
+        clicked: Integer,
+        bounced: Integer,
+        spam_complaints: Integer,
+        delivery_rate: Float,
+        open_rate: Float,
+        click_rate: Float,
+        bounce_rate: Float,
+        by_type: Array[GrowsurfRuby::Models::EmailAnalytics::ByType],
+        coverage_start_date: Integer?,
+        is_partial: bool
+      ) -> void
+
+      class Counts < GrowsurfRuby::Internal::Type::BaseModel
+        attr_accessor sent: Integer
+        attr_accessor delivered: Integer
+        attr_accessor opened: Integer
+        attr_accessor clicked: Integer
+        attr_accessor bounced: Integer
+        attr_accessor spam_complaints: Integer
+
+        def initialize: (
+          sent: Integer,
+          delivered: Integer,
+          opened: Integer,
+          clicked: Integer,
+          bounced: Integer,
+          spam_complaints: Integer
+        ) -> void
+      end
+
+      class ByType < GrowsurfRuby::Models::EmailAnalytics::Counts
+        attr_accessor email_type: String
+        attr_accessor delivery_rate: Float
+        attr_accessor open_rate: Float
+        attr_accessor click_rate: Float
+        attr_accessor bounce_rate: Float
+
+        def initialize: (
+          sent: Integer,
+          delivered: Integer,
+          opened: Integer,
+          clicked: Integer,
+          bounced: Integer,
+          spam_complaints: Integer,
+          email_type: String,
+          delivery_rate: Float,
+          open_rate: Float,
+          click_rate: Float,
+          bounce_rate: Float
+        ) -> void
+      end
+    end
+  end
+end

data/sig/growsurf_ruby/models/participant_commission_list.rbs

@@ -32,6 +32,7 @@ module GrowsurfRuby
           amount: Integer?,
           created_at: Integer,
           currency_iso: String,
+          event: GrowsurfRuby::Models::ParticipantCommissionList::Commission::event,
           referred_id: String,
           referrer_id: String,
           sale_amount: Integer?,
@@ -59,6 +60,8 @@ module GrowsurfRuby
 
         attr_accessor currency_iso: String
 
+        attr_accessor event: GrowsurfRuby::Models::ParticipantCommissionList::Commission::event
+
         attr_accessor referred_id: String
 
         attr_accessor referrer_id: String
@@ -106,6 +109,7 @@ module GrowsurfRuby
           amount: Integer?,
           created_at: Integer,
           currency_iso: String,
+          event: GrowsurfRuby::Models::ParticipantCommissionList::Commission::event,
           referred_id: String,
           referrer_id: String,
           sale_amount: Integer?,
@@ -129,6 +133,7 @@ module GrowsurfRuby
           amount: Integer?,
           created_at: Integer,
           currency_iso: String,
+          event: GrowsurfRuby::Models::ParticipantCommissionList::Commission::event,
           referred_id: String,
           referrer_id: String,
           sale_amount: Integer?,
@@ -147,6 +152,17 @@ module GrowsurfRuby
           sale_amount_in_campaign_currency: Integer?
         }
 
+        type event = :LEAD | :SALE
+
+        module Event
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          LEAD: :LEAD
+          SALE: :SALE
+
+          def self?.values: -> ::Array[GrowsurfRuby::Models::ParticipantCommissionList::Commission::event]
+        end
+
         type status = :PENDING | :APPROVED | :PAID | :REVERSED | :DELETED
 
         module Status

data/sig/growsurf_ruby/models/participant_payout_list.rbs

@@ -43,7 +43,8 @@ module GrowsurfRuby
           fx_error: String?,
           issued_at: Integer,
           provider: String?,
-          queued_at: Integer
+          queued_at: Integer,
+          reversed_at: Integer
         }
 
       class Payout < GrowsurfRuby::Internal::Type::BaseModel
@@ -87,6 +88,10 @@ module GrowsurfRuby
 
         def queued_at=: (Integer) -> Integer
 
+        attr_reader reversed_at: Integer?
+
+        def reversed_at=: (Integer) -> Integer
+
         def initialize: (
           id: String,
           amount: Integer,
@@ -103,7 +108,8 @@ module GrowsurfRuby
           ?fx_error: String?,
           ?issued_at: Integer,
           ?provider: String?,
-          ?queued_at: Integer
+          ?queued_at: Integer,
+          ?reversed_at: Integer
         ) -> void
 
         def to_hash: -> {
@@ -122,10 +128,11 @@ module GrowsurfRuby
           fx_error: String?,
           issued_at: Integer,
           provider: String?,
-          queued_at: Integer
+          queued_at: Integer,
+          reversed_at: Integer
         }
 
-        type status = :UPCOMING | :QUEUED | :ISSUED | :FAILED
+        type status = :UPCOMING | :QUEUED | :ISSUED | :FAILED | :REVERSED
 
         module Status
           extend GrowsurfRuby::Internal::Type::Enum
@@ -134,6 +141,7 @@ module GrowsurfRuby
           QUEUED: :QUEUED
           ISSUED: :ISSUED
           FAILED: :FAILED
+          REVERSED: :REVERSED
 
           def self?.values: -> ::Array[GrowsurfRuby::Models::ParticipantPayoutList::Payout::status]
         end

data/sig/growsurf_ruby/models/reward_tax_valuation.rbs

@@ -1,22 +1,44 @@
 module GrowsurfRuby
   module Models
     type reward_tax_valuation =
-      { fair_market_value_usd: Float?, is_tax_reportable: bool? }
+      {
+        fair_market_value_usd: Float?,
+        tax_character: GrowsurfRuby::Models::RewardTaxValuation::tax_character?
+      }
 
     class RewardTaxValuation < GrowsurfRuby::Internal::Type::BaseModel
       attr_accessor fair_market_value_usd: Float?
 
-      attr_accessor is_tax_reportable: bool?
+      attr_accessor tax_character: GrowsurfRuby::Models::RewardTaxValuation::tax_character?
 
       def initialize: (
         ?fair_market_value_usd: Float?,
-        ?is_tax_reportable: bool?
+        ?tax_character: GrowsurfRuby::Models::RewardTaxValuation::tax_character?
       ) -> void
 
       def to_hash: -> {
         fair_market_value_usd: Float?,
-        is_tax_reportable: bool?
+        tax_character: GrowsurfRuby::Models::RewardTaxValuation::tax_character?
       }
+
+      type tax_character =
+        :NONEMPLOYEE_SERVICES
+        | :PRIZE_OR_AWARD
+        | :PURCHASE_REBATE
+        | :OTHER_INCOME
+        | :REVIEW_REQUIRED
+
+      module TaxCharacter
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        NONEMPLOYEE_SERVICES: :NONEMPLOYEE_SERVICES
+        PRIZE_OR_AWARD: :PRIZE_OR_AWARD
+        PURCHASE_REBATE: :PURCHASE_REBATE
+        OTHER_INCOME: :OTHER_INCOME
+        REVIEW_REQUIRED: :REVIEW_REQUIRED
+
+        def self?.values: -> ::Array[GrowsurfRuby::Models::RewardTaxValuation::tax_character]
+      end
     end
   end
 end

data/sig/growsurf_ruby/models.rbs

@@ -1,6 +1,10 @@
 module GrowsurfRuby
   class AccountCreateParams = GrowsurfRuby::Models::AccountCreateParams
 
+  class AffiliateApplication = GrowsurfRuby::Models::AffiliateApplication
+
+  class AffiliateInvite = GrowsurfRuby::Models::AffiliateInvite
+
   class Team = GrowsurfRuby::Models::Team
 
   class TeamUpdateParams = GrowsurfRuby::Models::TeamUpdateParams
@@ -9,10 +13,16 @@ module GrowsurfRuby
 
   class CampaignAPI = GrowsurfRuby::Models::CampaignAPI
 
+  class CampaignCreateAffiliateInviteParams = GrowsurfRuby::Models::CampaignCreateAffiliateInviteParams
+
   class CampaignCreateMobileParticipantTokenParams = GrowsurfRuby::Models::CampaignCreateMobileParticipantTokenParams
 
   class CampaignCreateParams = GrowsurfRuby::Models::CampaignCreateParams
 
+  class CampaignListAffiliateApplicationsParams = GrowsurfRuby::Models::CampaignListAffiliateApplicationsParams
+
+  class CampaignListAffiliateInvitesParams = GrowsurfRuby::Models::CampaignListAffiliateInvitesParams
+
   class CampaignListCommissionsParams = GrowsurfRuby::Models::CampaignListCommissionsParams
 
   class CampaignListLeaderboardParams = GrowsurfRuby::Models::CampaignListLeaderboardParams
@@ -25,10 +35,18 @@ module GrowsurfRuby
 
   class CampaignListReferralsParams = GrowsurfRuby::Models::CampaignListReferralsParams
 
+  class CampaignResendAffiliateInviteParams = GrowsurfRuby::Models::CampaignResendAffiliateInviteParams
+
+  class CampaignRetrieveAffiliateApplicationParams = GrowsurfRuby::Models::CampaignRetrieveAffiliateApplicationParams
+
   class CampaignRetrieveAnalyticsParams = GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams
 
   class CampaignRetrieveParams = GrowsurfRuby::Models::CampaignRetrieveParams
 
+  class CampaignReviewAffiliateApplicationParams = GrowsurfRuby::Models::CampaignReviewAffiliateApplicationParams
+
+  class CampaignRevokeAffiliateInviteParams = GrowsurfRuby::Models::CampaignRevokeAffiliateInviteParams
+
   class CampaignUpdateParams = GrowsurfRuby::Models::CampaignUpdateParams
 
   class CommissionStructure = GrowsurfRuby::Models::CommissionStructure

data/sig/growsurf_ruby/resources/campaign/participant.rbs

@@ -11,12 +11,12 @@ module GrowsurfRuby
         def update: (
           String participant_id_or_email,
           id: String,
+          ?affiliate_status: GrowsurfRuby::Models::Campaign::ParticipantUpdateParams::affiliate_status,
           ?email: String,
           ?first_name: String,
           ?last_name: String,
           ?metadata: ::Hash[Symbol, top],
           ?notes: String,
-          ?paypal_email: String,
           ?referral_status: GrowsurfRuby::Models::Campaign::ParticipantUpdateParams::referral_status,
           ?referred_by: String,
           ?unsubscribed: bool,
@@ -42,6 +42,7 @@ module GrowsurfRuby
           ?fingerprint: String,
           ?first_name: String,
           ?ip_address: String,
+          ?is_affiliate: bool,
           ?last_name: String,
           ?metadata: ::Hash[Symbol, top],
           ?mobile_instance_id: String,
@@ -186,12 +187,25 @@ module GrowsurfRuby
           id: String,
           ?days: Integer,
           ?end_date: Integer,
-          ?include: :series,
+          ?include: String,
           ?interval: GrowsurfRuby::Models::Campaign::ParticipantRetrieveAnalyticsParams::interval,
           ?start_date: Integer,
           ?request_options: GrowsurfRuby::request_opts
         ) -> GrowsurfRuby::Models::Campaign::ParticipantAnalyticsResponse
 
+        def get_payout_destination: (
+          String participant_id_or_email,
+          id: String,
+          ?request_options: GrowsurfRuby::request_opts
+        ) -> GrowsurfRuby::Models::Campaign::ParticipantGetPayoutDestinationResponse
+
+        def request_payout_destination_confirmation: (
+          String participant_id_or_email,
+          id: String,
+          provider: GrowsurfRuby::Models::Campaign::ParticipantRequestPayoutDestinationConfirmationParams::provider,
+          ?request_options: GrowsurfRuby::request_opts
+        ) -> GrowsurfRuby::Models::Campaign::ParticipantRequestPayoutDestinationConfirmationResponse
+
         def initialize: (client: GrowsurfRuby::Client) -> void
       end
     end

data/sig/growsurf_ruby/resources/campaign/rewards.rbs

@@ -14,6 +14,7 @@ module GrowsurfRuby
           ?conversions_required: Integer,
           ?coupon_code: String,
           ?description: String,
+          ?event: GrowsurfRuby::Models::Campaign::RewardCreateParams::event,
           ?image_url: String,
           ?is_unlimited: bool,
           ?is_visible: bool,
@@ -40,6 +41,7 @@ module GrowsurfRuby
           ?conversions_required: Integer,
           ?coupon_code: String,
           ?description: String,
+          ?event: GrowsurfRuby::Models::Campaign::RewardUpdateParams::event,
           ?image_url: String,
           ?is_unlimited: bool,
           ?is_visible: bool,

data/sig/growsurf_ruby/resources/campaign.rbs

@@ -52,6 +52,14 @@ module GrowsurfRuby
         ?request_options: GrowsurfRuby::request_opts
       ) -> GrowsurfRuby::CampaignAPI
 
+      def create_affiliate_invite: (
+        String id,
+        email: String,
+        ?first_name: String,
+        ?last_name: String,
+        ?request_options: GrowsurfRuby::request_opts
+      ) -> GrowsurfRuby::AffiliateInvite
+
       def create_mobile_participant_token: (
         String id,
         email: String,
@@ -66,6 +74,22 @@ module GrowsurfRuby
         ?request_options: GrowsurfRuby::request_opts
       ) -> GrowsurfRuby::Models::CampaignCreateMobileParticipantTokenResponse
 
+      def list_affiliate_applications: (
+        String id,
+        ?limit: Integer,
+        ?offset: Integer,
+        ?status: GrowsurfRuby::Models::CampaignListAffiliateApplicationsParams::status,
+        ?request_options: GrowsurfRuby::request_opts
+      ) -> GrowsurfRuby::Models::AffiliateApplicationListResponse
+
+      def list_affiliate_invites: (
+        String id,
+        ?limit: Integer,
+        ?offset: Integer,
+        ?status: GrowsurfRuby::Models::CampaignListAffiliateInvitesParams::status,
+        ?request_options: GrowsurfRuby::request_opts
+      ) -> GrowsurfRuby::Models::AffiliateInviteListResponse
+
       def list_commissions: (
         String id,
         ?limit: Integer,
@@ -112,6 +136,18 @@ module GrowsurfRuby
         ?request_options: GrowsurfRuby::request_opts
       ) -> GrowsurfRuby::ReferralList
 
+      def resend_affiliate_invite: (
+        String invite_id,
+        id: String,
+        ?request_options: GrowsurfRuby::request_opts
+      ) -> GrowsurfRuby::AffiliateInvite
+
+      def retrieve_affiliate_application: (
+        String application_id,
+        id: String,
+        ?request_options: GrowsurfRuby::request_opts
+      ) -> GrowsurfRuby::AffiliateApplication
+
       def retrieve_analytics: (
         String id,
         ?days: Integer,
@@ -122,6 +158,23 @@ module GrowsurfRuby
         ?request_options: GrowsurfRuby::request_opts
       ) -> GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse
 
+      def review_affiliate_application: (
+        String application_id,
+        id: String,
+        ?allow_immediate_reapply: bool,
+        ?reapply_allowed_at: Integer,
+        ?rejection_reason: String,
+        ?review_note: String,
+        ?status: GrowsurfRuby::Models::CampaignReviewAffiliateApplicationParams::status,
+        ?request_options: GrowsurfRuby::request_opts
+      ) -> GrowsurfRuby::AffiliateApplication
+
+      def revoke_affiliate_invite: (
+        String invite_id,
+        id: String,
+        ?request_options: GrowsurfRuby::request_opts
+      ) -> GrowsurfRuby::AffiliateInvite
+
       def initialize: (client: GrowsurfRuby::Client) -> void
     end
   end