growsurf-ruby 1.3.0 → 1.5.0

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/participant_commission_list.rbs

@@ -32,21 +32,22 @@ 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?,
           status: GrowsurfRuby::Models::ParticipantCommissionList::Commission::status,
           amount_in_campaign_currency: Integer?,
-          approved_at: Integer,
+          approved_at: Integer?,
           campaign_currency_iso: String?,
           exchange_rate: Float?,
-          exchange_rate_at: Integer,
+          exchange_rate_at: Integer?,
           fx_error: String?,
           hold_duration: Integer?,
-          paid_at: Integer,
-          payout_queued_at: Integer,
+          paid_at: Integer?,
+          payout_queued_at: Integer?,
           provider: String?,
-          reversed_at: Integer,
+          reversed_at: Integer?,
           sale_amount_in_campaign_currency: 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
@@ -71,7 +74,7 @@ module GrowsurfRuby
 
         attr_reader approved_at: Integer?
 
-        def approved_at=: (Integer) -> Integer
+        def approved_at=: (Integer?) -> Integer?
 
         attr_accessor campaign_currency_iso: String?
 
@@ -79,7 +82,7 @@ module GrowsurfRuby
 
         attr_reader exchange_rate_at: Integer?
 
-        def exchange_rate_at=: (Integer) -> Integer
+        def exchange_rate_at=: (Integer?) -> Integer?
 
         attr_accessor fx_error: String?
 
@@ -87,17 +90,17 @@ module GrowsurfRuby
 
         attr_reader paid_at: Integer?
 
-        def paid_at=: (Integer) -> Integer
+        def paid_at=: (Integer?) -> Integer?
 
         attr_reader payout_queued_at: Integer?
 
-        def payout_queued_at=: (Integer) -> Integer
+        def payout_queued_at=: (Integer?) -> Integer?
 
         attr_accessor provider: String?
 
         attr_reader reversed_at: Integer?
 
-        def reversed_at=: (Integer) -> Integer
+        def reversed_at=: (Integer?) -> Integer?
 
         attr_accessor sale_amount_in_campaign_currency: Integer?
 
@@ -106,21 +109,22 @@ 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?,
           status: GrowsurfRuby::Models::ParticipantCommissionList::Commission::status,
           ?amount_in_campaign_currency: Integer?,
-          ?approved_at: Integer,
+          ?approved_at: Integer?,
           ?campaign_currency_iso: String?,
           ?exchange_rate: Float?,
-          ?exchange_rate_at: Integer,
+          ?exchange_rate_at: Integer?,
           ?fx_error: String?,
           ?hold_duration: Integer?,
-          ?paid_at: Integer,
-          ?payout_queued_at: Integer,
+          ?paid_at: Integer?,
+          ?payout_queued_at: Integer?,
           ?provider: String?,
-          ?reversed_at: Integer,
+          ?reversed_at: Integer?,
           ?sale_amount_in_campaign_currency: Integer?
         ) -> void
 
@@ -129,24 +133,36 @@ 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?,
           status: GrowsurfRuby::Models::ParticipantCommissionList::Commission::status,
           amount_in_campaign_currency: Integer?,
-          approved_at: Integer,
+          approved_at: Integer?,
           campaign_currency_iso: String?,
           exchange_rate: Float?,
-          exchange_rate_at: Integer,
+          exchange_rate_at: Integer?,
           fx_error: String?,
           hold_duration: Integer?,
-          paid_at: Integer,
-          payout_queued_at: Integer,
+          paid_at: Integer?,
+          payout_queued_at: Integer?,
           provider: String?,
-          reversed_at: Integer,
+          reversed_at: Integer?,
           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

@@ -38,13 +38,13 @@ module GrowsurfRuby
           amount_in_campaign_currency: Integer?,
           campaign_currency_iso: String?,
           exchange_rate: Float?,
-          exchange_rate_at: Integer,
-          failed_at: Integer,
+          exchange_rate_at: Integer?,
+          failed_at: Integer?,
           fx_error: String?,
-          issued_at: Integer,
+          issued_at: Integer?,
           provider: String?,
-          queued_at: Integer,
-          reversed_at: Integer
+          queued_at: Integer?,
+          reversed_at: Integer?
         }
 
       class Payout < GrowsurfRuby::Internal::Type::BaseModel
@@ -70,27 +70,27 @@ module GrowsurfRuby
 
         attr_reader exchange_rate_at: Integer?
 
-        def exchange_rate_at=: (Integer) -> Integer
+        def exchange_rate_at=: (Integer?) -> Integer?
 
         attr_reader failed_at: Integer?
 
-        def failed_at=: (Integer) -> Integer
+        def failed_at=: (Integer?) -> Integer?
 
         attr_accessor fx_error: String?
 
         attr_reader issued_at: Integer?
 
-        def issued_at=: (Integer) -> Integer
+        def issued_at=: (Integer?) -> Integer?
 
         attr_accessor provider: String?
 
         attr_reader queued_at: Integer?
 
-        def queued_at=: (Integer) -> Integer
+        def queued_at=: (Integer?) -> Integer?
 
         attr_reader reversed_at: Integer?
 
-        def reversed_at=: (Integer) -> Integer
+        def reversed_at=: (Integer?) -> Integer?
 
         def initialize: (
           id: String,
@@ -103,13 +103,13 @@ module GrowsurfRuby
           ?amount_in_campaign_currency: Integer?,
           ?campaign_currency_iso: String?,
           ?exchange_rate: Float?,
-          ?exchange_rate_at: Integer,
-          ?failed_at: Integer,
+          ?exchange_rate_at: Integer?,
+          ?failed_at: Integer?,
           ?fx_error: String?,
-          ?issued_at: Integer,
+          ?issued_at: Integer?,
           ?provider: String?,
-          ?queued_at: Integer,
-          ?reversed_at: Integer
+          ?queued_at: Integer?,
+          ?reversed_at: Integer?
         ) -> void
 
         def to_hash: -> {
@@ -123,13 +123,13 @@ module GrowsurfRuby
           amount_in_campaign_currency: Integer?,
           campaign_currency_iso: String?,
           exchange_rate: Float?,
-          exchange_rate_at: Integer,
-          failed_at: Integer,
+          exchange_rate_at: Integer?,
+          failed_at: Integer?,
           fx_error: String?,
-          issued_at: Integer,
+          issued_at: Integer?,
           provider: String?,
-          queued_at: Integer,
-          reversed_at: Integer
+          queued_at: Integer?,
+          reversed_at: Integer?
         }
 
         type status = :UPCOMING | :QUEUED | :ISSUED | :FAILED | :REVERSED

data/sig/growsurf_ruby/models.rbs

@@ -1,6 +1,10 @@
 module GrowsurfRuby
   class AccountCreateParams = GrowsurfRuby::Models::AccountCreateParams
 
+  module AnalyticsAvailability = GrowsurfRuby::Models::AnalyticsAvailability
+
+  module AnalyticsUnavailableReason = GrowsurfRuby::Models::AnalyticsUnavailableReason
+
   class AffiliateApplication = GrowsurfRuby::Models::AffiliateApplication
 
   class AffiliateInvite = GrowsurfRuby::Models::AffiliateInvite
@@ -39,6 +43,8 @@ module GrowsurfRuby
 
   class CampaignRetrieveAffiliateApplicationParams = GrowsurfRuby::Models::CampaignRetrieveAffiliateApplicationParams
 
+  class CampaignRetrieveActivationAnalyticsParams = GrowsurfRuby::Models::CampaignRetrieveActivationAnalyticsParams
+
   class CampaignRetrieveAnalyticsParams = GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams
 
   class CampaignRetrieveParams = GrowsurfRuby::Models::CampaignRetrieveParams

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

@@ -2,6 +2,25 @@ module GrowsurfRuby
   module Resources
     class Campaign
       class Design
+        # Icon configuration for the participant Resources destination.
+        type resources_icon = {
+          type?: "DEFAULT" | "IMAGE" | "NONE",
+          imageUrl?: String
+        }
+
+        # Participant presentation settings for Resources. Each label is limited to 100
+        # characters; imageUrl is limited to 500. Resource items use Program Resources operations.
+        type resources = {
+          isPublicDisplayed?: bool,
+          title?: String,
+          viewResourcesLinkText?: String,
+          backLinkText?: String,
+          copyButtonText?: String,
+          copiedText?: String,
+          emptyState?: String,
+          icon?: resources_icon
+        }
+
         def retrieve: (
           String id,
           ?request_options: GrowsurfRuby::request_opts

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

@@ -0,0 +1,14 @@
+module GrowsurfRuby
+  module Resources
+    class Campaign
+      class Integrations
+        def list: (
+          String id,
+          ?request_options: GrowsurfRuby::request_opts
+        ) -> GrowsurfRuby::Models::Campaign::IntegrationListResponse
+
+        def initialize: (client: GrowsurfRuby::Client) -> void
+      end
+    end
+  end
+end

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

@@ -118,6 +118,8 @@ module GrowsurfRuby
           ?total_tax_amounts: ::Array[::Hash[Symbol, top]],
           ?total_taxes: ::Array[::Hash[Symbol, top]],
           ?transaction_id: String,
+          ?payment_provider: String,
+          ?test_mode: bool,
           ?request_options: GrowsurfRuby::request_opts
         ) -> GrowsurfRuby::Models::Campaign::participant_record_transaction_response
 
@@ -139,6 +141,8 @@ module GrowsurfRuby
           ?refund_id: String,
           ?refund_status: String,
           ?transaction_id: String,
+          ?payment_provider: String,
+          ?test_mode: bool,
           ?request_options: GrowsurfRuby::request_opts
         ) -> GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionResponse
 

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

@@ -0,0 +1,58 @@
+module GrowsurfRuby
+  module Resources
+    class Campaign
+      class ProgramResources
+        def list: (
+          String id,
+          ?request_options: GrowsurfRuby::request_opts
+        ) -> GrowsurfRuby::Campaign::ProgramResourceListResponse
+
+        def create: (
+          String id,
+          type: GrowsurfRuby::Campaign::ProgramResourceCreateParams::type_,
+          title: String,
+          ?description: String?,
+          ?category: String?,
+          ?is_published: bool,
+          ?url: String,
+          ?text: String,
+          ?upload_ticket: String,
+          ?upload_result: GrowsurfRuby::Campaign::ProgramResourceUploadResult | GrowsurfRuby::Campaign::program_resource_upload_result,
+          ?request_options: GrowsurfRuby::request_opts
+        ) -> GrowsurfRuby::Campaign::ProgramResource
+
+        def update: (
+          String resource_id,
+          id: String,
+          ?type: GrowsurfRuby::Campaign::ProgramResourceUpdateParams::type_,
+          ?title: String,
+          ?description: String?,
+          ?category: String?,
+          ?is_published: bool,
+          ?position: Integer,
+          ?url: String,
+          ?text: String,
+          ?upload_ticket: String,
+          ?upload_result: GrowsurfRuby::Campaign::ProgramResourceUploadResult | GrowsurfRuby::Campaign::program_resource_upload_result,
+          ?request_options: GrowsurfRuby::request_opts
+        ) -> GrowsurfRuby::Campaign::ProgramResource
+
+        def delete: (
+          String resource_id,
+          id: String,
+          ?request_options: GrowsurfRuby::request_opts
+        ) -> GrowsurfRuby::Campaign::DeleteProgramResourceResponse
+
+        def create_upload_ticket: (
+          String id,
+          file_name: String,
+          mime_type: String,
+          bytes: Integer,
+          ?request_options: GrowsurfRuby::request_opts
+        ) -> GrowsurfRuby::Campaign::ProgramResourceUploadTicket
+
+        def initialize: (client: GrowsurfRuby::Client) -> void
+      end
+    end
+  end
+end

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

@@ -12,20 +12,21 @@ module GrowsurfRuby
           type: GrowsurfRuby::Models::Campaign::RewardCreateParams::type_,
           ?commission_structure: GrowsurfRuby::CommissionStructure,
           ?conversions_required: Integer,
-          ?coupon_code: String,
+          ?coupon_code: String?,
           ?description: String,
-          ?image_url: String,
+          ?event: GrowsurfRuby::Models::Campaign::RewardCreateParams::event,
+          ?image_url: String?,
           ?is_unlimited: bool,
           ?is_visible: bool,
           ?limit: Integer,
           ?limit_duration: GrowsurfRuby::Models::Campaign::RewardCreateParams::limit_duration,
           ?metadata: ::Hash[Symbol, top],
-          ?next_milestone_prefix: String,
-          ?next_milestone_suffix: String,
+          ?next_milestone_prefix: String?,
+          ?next_milestone_suffix: String?,
           ?number_of_winners: Integer,
           ?order: Integer,
-          ?referral_coupon_code: String,
-          ?referral_description: String,
+          ?referral_coupon_code: String?,
+          ?referral_description: String?,
           ?referred_reward_upfront: bool,
           ?referred_value: GrowsurfRuby::RewardTaxValuation,
           ?title: String,
@@ -38,20 +39,21 @@ module GrowsurfRuby
           id: String,
           ?commission_structure: GrowsurfRuby::CommissionStructure,
           ?conversions_required: Integer,
-          ?coupon_code: String,
+          ?coupon_code: String?,
           ?description: String,
-          ?image_url: String,
+          ?event: GrowsurfRuby::Models::Campaign::RewardUpdateParams::event,
+          ?image_url: String?,
           ?is_unlimited: bool,
           ?is_visible: bool,
           ?limit: Integer,
           ?limit_duration: GrowsurfRuby::Models::Campaign::RewardUpdateParams::limit_duration,
           ?metadata: ::Hash[Symbol, top],
-          ?next_milestone_prefix: String,
-          ?next_milestone_suffix: String,
+          ?next_milestone_prefix: String?,
+          ?next_milestone_suffix: String?,
           ?number_of_winners: Integer,
           ?order: Integer,
-          ?referral_coupon_code: String,
-          ?referral_description: String,
+          ?referral_coupon_code: String?,
+          ?referral_description: String?,
           ?referred_reward_upfront: bool,
           ?referred_value: GrowsurfRuby::RewardTaxValuation,
           ?title: String,

data/sig/growsurf_ruby/resources/campaign.rbs

@@ -9,6 +9,8 @@ module GrowsurfRuby
 
       attr_reader rewards: GrowsurfRuby::Resources::Campaign::Rewards
 
+      attr_reader resources: GrowsurfRuby::Resources::Campaign::ProgramResources
+
       attr_reader design: GrowsurfRuby::Resources::Campaign::Design
 
       attr_reader emails: GrowsurfRuby::Resources::Campaign::Emails
@@ -17,6 +19,8 @@ module GrowsurfRuby
 
       attr_reader installation: GrowsurfRuby::Resources::Campaign::Installation
 
+      attr_reader integrations: GrowsurfRuby::Resources::Campaign::Integrations
+
       attr_reader webhooks: GrowsurfRuby::Resources::Campaign::Webhooks
 
       def retrieve: (
@@ -33,6 +37,7 @@ module GrowsurfRuby
         ?company_logo_image_url: String,
         ?company_name: String,
         ?currency_iso: String,
+        ?goal: GrowsurfRuby::Models::CampaignCreateParams::goal,
         ?name: String,
         ?rewards: ::Array[GrowsurfRuby::Campaign::RewardCreateParams],
         ?request_options: GrowsurfRuby::request_opts
@@ -154,10 +159,22 @@ module GrowsurfRuby
         ?end_date: Integer,
         ?include: String,
         ?interval: GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams::interval,
+        ?platform: GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams::platform,
         ?start_date: Integer,
+        ?timezone: String,
         ?request_options: GrowsurfRuby::request_opts
       ) -> GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse
 
+      def retrieve_activation_analytics: (
+        String id,
+        ?cohort_from: Integer,
+        ?cohort_to: Integer,
+        ?cohort_interval: GrowsurfRuby::Models::CampaignRetrieveActivationAnalyticsParams::cohort_interval,
+        ?observation_window_days: GrowsurfRuby::Models::CampaignRetrieveActivationAnalyticsParams::observation_window_days,
+        ?timezone: String,
+        ?request_options: GrowsurfRuby::request_opts
+      ) -> GrowsurfRuby::Models::CampaignActivationAnalyticsResponse
+
       def review_affiliate_application: (
         String application_id,
         id: String,