growsurf-ruby 0.8.0 → 1.1.0

data/sig/growsurf_ruby/models/commission_structure.rbs

@@ -3,6 +3,7 @@ module GrowsurfRuby
     type commission_structure =
       {
         amount: Integer?,
+        amount_iso: String?,
         approval_required: bool?,
         duration: String?,
         duration_in_months: Integer?,
@@ -26,6 +27,8 @@ module GrowsurfRuby
     class CommissionStructure < GrowsurfRuby::Internal::Type::BaseModel
       attr_accessor amount: Integer?
 
+      attr_accessor amount_iso: String?
+
       attr_accessor approval_required: bool?
 
       attr_accessor duration: String?
@@ -64,6 +67,7 @@ module GrowsurfRuby
 
       def initialize: (
         ?amount: Integer?,
+        ?amount_iso: String?,
         ?approval_required: bool?,
         ?duration: String?,
         ?duration_in_months: Integer?,
@@ -86,6 +90,7 @@ module GrowsurfRuby
 
       def to_hash: -> {
         amount: Integer?,
+        amount_iso: String?,
         approval_required: bool?,
         duration: String?,
         duration_in_months: Integer?,
@@ -106,13 +111,13 @@ module GrowsurfRuby
         type: GrowsurfRuby::Models::CommissionStructure::type_?
       }
 
-      type type_ = :PERCENT | :AMOUNT
+      type type_ = :PERCENT | :FIXED
 
       module Type
         extend GrowsurfRuby::Internal::Type::Enum
 
         PERCENT: :PERCENT
-        AMOUNT: :AMOUNT
+        FIXED: :FIXED
 
         def self?.values: -> ::Array[GrowsurfRuby::Models::CommissionStructure::type_]
       end

data/sig/growsurf_ruby/models/referral_flow_screenshots_response.rbs

@@ -0,0 +1,54 @@
+module GrowsurfRuby
+  module Models
+    type referral_flow_screenshots_response =
+      {
+        referrer: GrowsurfRuby::Models::ReferralFlowScreenshotsResponse::ReferralFlowScreenshot,
+        referred_friend: GrowsurfRuby::Models::ReferralFlowScreenshotsResponse::ReferralFlowScreenshot,
+        generated_at: Integer
+      }
+
+    class ReferralFlowScreenshotsResponse < GrowsurfRuby::Internal::Type::BaseModel
+      attr_accessor referrer: GrowsurfRuby::Models::ReferralFlowScreenshotsResponse::ReferralFlowScreenshot
+
+      attr_accessor referred_friend: GrowsurfRuby::Models::ReferralFlowScreenshotsResponse::ReferralFlowScreenshot
+
+      attr_accessor generated_at: Integer
+
+      def initialize: (
+        referrer: GrowsurfRuby::Models::ReferralFlowScreenshotsResponse::ReferralFlowScreenshot,
+        referred_friend: GrowsurfRuby::Models::ReferralFlowScreenshotsResponse::ReferralFlowScreenshot,
+        generated_at: Integer
+      ) -> void
+
+      def to_hash: -> {
+        referrer: GrowsurfRuby::Models::ReferralFlowScreenshotsResponse::ReferralFlowScreenshot,
+        referred_friend: GrowsurfRuby::Models::ReferralFlowScreenshotsResponse::ReferralFlowScreenshot,
+        generated_at: Integer
+      }
+
+      class ReferralFlowScreenshot < GrowsurfRuby::Internal::Type::BaseModel
+        attr_accessor view: String
+
+        attr_accessor url: String
+
+        attr_accessor width: Integer
+
+        attr_accessor height: Integer
+
+        def initialize: (
+          view: String,
+          url: String,
+          width: Integer,
+          height: Integer
+        ) -> void
+
+        def to_hash: -> {
+          view: String,
+          url: String,
+          width: Integer,
+          height: Integer
+        }
+      end
+    end
+  end
+end

data/sig/growsurf_ruby/models/reward_tax_valuation.rbs

@@ -0,0 +1,22 @@
+module GrowsurfRuby
+  module Models
+    type reward_tax_valuation =
+      { fair_market_value_usd: Float?, is_tax_reportable: bool? }
+
+    class RewardTaxValuation < GrowsurfRuby::Internal::Type::BaseModel
+      attr_accessor fair_market_value_usd: Float?
+
+      attr_accessor is_tax_reportable: bool?
+
+      def initialize: (
+        ?fair_market_value_usd: Float?,
+        ?is_tax_reportable: bool?
+      ) -> void
+
+      def to_hash: -> {
+        fair_market_value_usd: Float?,
+        is_tax_reportable: bool?
+      }
+    end
+  end
+end

data/sig/growsurf_ruby/models.rbs

@@ -1,4 +1,10 @@
 module GrowsurfRuby
+  class Account = GrowsurfRuby::Models::Account
+
+  class AccountCreateParams = GrowsurfRuby::Models::AccountCreateParams
+
+  class AccountUpdateParams = GrowsurfRuby::Models::AccountUpdateParams
+
   module Campaign = GrowsurfRuby::Models::Campaign
 
   class CampaignAPI = GrowsurfRuby::Models::CampaignAPI
@@ -34,4 +40,8 @@ module GrowsurfRuby
   class ParticipantPayoutList = GrowsurfRuby::Models::ParticipantPayoutList
 
   class ReferralList = GrowsurfRuby::Models::ReferralList
+
+  class ReferralFlowScreenshotsResponse = GrowsurfRuby::Models::ReferralFlowScreenshotsResponse
+
+  class RewardTaxValuation = GrowsurfRuby::Models::RewardTaxValuation
 end

data/sig/growsurf_ruby/resources/account.rbs

@@ -0,0 +1,38 @@
+module GrowsurfRuby
+  module Resources
+    class Account
+      def create: (
+        email: String,
+        ?company: String,
+        ?first_name: String,
+        ?last_name: String,
+        ?request_options: GrowsurfRuby::request_opts
+      ) -> GrowsurfRuby::Models::AccountCreateResponse
+
+      def retrieve: (
+        ?request_options: GrowsurfRuby::request_opts
+      ) -> GrowsurfRuby::Account
+
+      def update: (
+        ?company: String,
+        ?first_name: String,
+        ?last_name: String,
+        ?request_options: GrowsurfRuby::request_opts
+      ) -> GrowsurfRuby::Account
+
+      def rotate_api_key: (
+        ?request_options: GrowsurfRuby::request_opts
+      ) -> GrowsurfRuby::Models::AccountRotateAPIKeyResponse
+
+      def request_verification: (
+        ?request_options: GrowsurfRuby::request_opts
+      ) -> GrowsurfRuby::Account
+
+      def resend_verification_email: (
+        ?request_options: GrowsurfRuby::request_opts
+      ) -> GrowsurfRuby::Models::AccountResendVerificationEmailResponse
+
+      def initialize: (client: GrowsurfRuby::Client) -> void
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module GrowsurfRuby
+  module Resources
+    class Campaign
+      class Design
+        def retrieve: (
+          String id,
+          ?request_options: GrowsurfRuby::request_opts
+        ) -> ::Hash[Symbol, top]
+
+        def update: (
+          String id,
+          ::Hash[Symbol, top] body,
+          ?request_options: GrowsurfRuby::request_opts
+        ) -> ::Hash[Symbol, top]
+
+        def initialize: (client: GrowsurfRuby::Client) -> void
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module GrowsurfRuby
+  module Resources
+    class Campaign
+      class Emails
+        def retrieve: (
+          String id,
+          ?request_options: GrowsurfRuby::request_opts
+        ) -> ::Hash[Symbol, top]
+
+        def update: (
+          String id,
+          ::Hash[Symbol, top] body,
+          ?request_options: GrowsurfRuby::request_opts
+        ) -> ::Hash[Symbol, top]
+
+        def initialize: (client: GrowsurfRuby::Client) -> void
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module GrowsurfRuby
+  module Resources
+    class Campaign
+      class Installation
+        def retrieve: (
+          String id,
+          ?request_options: GrowsurfRuby::request_opts
+        ) -> ::Hash[Symbol, top]
+
+        def update: (
+          String id,
+          ::Hash[Symbol, top] body,
+          ?request_options: GrowsurfRuby::request_opts
+        ) -> ::Hash[Symbol, top]
+
+        def initialize: (client: GrowsurfRuby::Client) -> void
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module GrowsurfRuby
+  module Resources
+    class Campaign
+      class Options
+        def retrieve: (
+          String id,
+          ?request_options: GrowsurfRuby::request_opts
+        ) -> ::Hash[Symbol, top]
+
+        def update: (
+          String id,
+          ::Hash[Symbol, top] body,
+          ?request_options: GrowsurfRuby::request_opts
+        ) -> ::Hash[Symbol, top]
+
+        def initialize: (client: GrowsurfRuby::Client) -> void
+      end
+    end
+  end
+end

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

@@ -15,6 +15,8 @@ module GrowsurfRuby
           ?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,
@@ -28,6 +30,12 @@ module GrowsurfRuby
           ?request_options: GrowsurfRuby::request_opts
         ) -> GrowsurfRuby::Models::Campaign::ParticipantDeleteResponse
 
+        def bulk_delete: (
+          String id,
+          participants: ::Array[String],
+          ?request_options: GrowsurfRuby::request_opts
+        ) -> GrowsurfRuby::Models::Campaign::ParticipantBulkDeleteResponse
+
         def add: (
           String id,
           email: String,
@@ -155,6 +163,35 @@ module GrowsurfRuby
           ?request_options: GrowsurfRuby::request_opts
         ) -> GrowsurfRuby::Models::Campaign::ParticipantCancelDelayedReferralResponse
 
+        def email: (
+          String participant_id_or_email,
+          id: String,
+          ?body: String,
+          ?email_type: String,
+          ?preheader: String,
+          ?subject: String,
+          ?request_options: GrowsurfRuby::request_opts
+        ) -> GrowsurfRuby::Models::Campaign::ParticipantEmailResponse
+
+        def list_activity_logs: (
+          String participant_id_or_email,
+          id: String,
+          ?limit: Integer,
+          ?offset: Integer,
+          ?request_options: GrowsurfRuby::request_opts
+        ) -> GrowsurfRuby::Models::Campaign::ParticipantActivityLogsResponse
+
+        def retrieve_analytics: (
+          String participant_id_or_email,
+          id: String,
+          ?days: Integer,
+          ?end_date: Integer,
+          ?include: :series,
+          ?interval: GrowsurfRuby::Models::Campaign::ParticipantRetrieveAnalyticsParams::interval,
+          ?start_date: Integer,
+          ?request_options: GrowsurfRuby::request_opts
+        ) -> GrowsurfRuby::Models::Campaign::ParticipantAnalyticsResponse
+
         def initialize: (client: GrowsurfRuby::Client) -> void
       end
     end

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

@@ -15,7 +15,6 @@ module GrowsurfRuby
           ?coupon_code: String,
           ?description: String,
           ?image_url: String,
-          ?is_active: bool,
           ?is_unlimited: bool,
           ?is_visible: bool,
           ?limit: Integer,
@@ -28,19 +27,20 @@ module GrowsurfRuby
           ?referral_coupon_code: String,
           ?referral_description: String,
           ?referred_reward_upfront: bool,
+          ?referred_value: GrowsurfRuby::RewardTaxValuation,
           ?title: String,
+          ?value: GrowsurfRuby::RewardTaxValuation,
           ?request_options: GrowsurfRuby::request_opts
         ) -> GrowsurfRuby::Models::Campaign::Reward
 
         def update: (
-          String reward_id,
+          String campaign_reward_id,
           id: String,
           ?commission_structure: GrowsurfRuby::CommissionStructure,
           ?conversions_required: Integer,
           ?coupon_code: String,
           ?description: String,
           ?image_url: String,
-          ?is_active: bool,
           ?is_unlimited: bool,
           ?is_visible: bool,
           ?limit: Integer,
@@ -53,12 +53,14 @@ module GrowsurfRuby
           ?referral_coupon_code: String,
           ?referral_description: String,
           ?referred_reward_upfront: bool,
+          ?referred_value: GrowsurfRuby::RewardTaxValuation,
           ?title: String,
+          ?value: GrowsurfRuby::RewardTaxValuation,
           ?request_options: GrowsurfRuby::request_opts
         ) -> GrowsurfRuby::Models::Campaign::Reward
 
         def delete: (
-          String reward_id,
+          String campaign_reward_id,
           id: String,
           ?request_options: GrowsurfRuby::request_opts
         ) -> GrowsurfRuby::Models::Campaign::DeleteRewardResponse

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

@@ -0,0 +1,46 @@
+module GrowsurfRuby
+  module Resources
+    class Campaign
+      class Webhooks
+        def list: (
+          String id,
+          ?request_options: GrowsurfRuby::request_opts
+        ) -> GrowsurfRuby::Models::Campaign::WebhookListResponse
+
+        def create: (
+          String id,
+          payload_url: String,
+          ?events: ::Array[GrowsurfRuby::Models::Campaign::webhook_event],
+          ?is_enabled: bool,
+          ?secret: String,
+          ?request_options: GrowsurfRuby::request_opts
+        ) -> GrowsurfRuby::Models::Campaign::Webhook
+
+        def update: (
+          String webhook_id,
+          id: String,
+          ?events: ::Array[GrowsurfRuby::Models::Campaign::webhook_event],
+          ?is_enabled: bool,
+          ?payload_url: String,
+          ?secret: String,
+          ?request_options: GrowsurfRuby::request_opts
+        ) -> GrowsurfRuby::Models::Campaign::Webhook
+
+        def delete: (
+          String webhook_id,
+          id: String,
+          ?request_options: GrowsurfRuby::request_opts
+        ) -> GrowsurfRuby::Models::Campaign::WebhookDeleteResponse
+
+        def test: (
+          String webhook_id,
+          id: String,
+          ?event: GrowsurfRuby::Models::Campaign::webhook_event,
+          ?request_options: GrowsurfRuby::request_opts
+        ) -> GrowsurfRuby::Models::Campaign::WebhookTestResponse
+
+        def initialize: (client: GrowsurfRuby::Client) -> void
+      end
+    end
+  end
+end

data/sig/growsurf_ruby/resources/campaign.rbs

@@ -9,6 +9,16 @@ module GrowsurfRuby
 
       attr_reader rewards: GrowsurfRuby::Resources::Campaign::Rewards
 
+      attr_reader design: GrowsurfRuby::Resources::Campaign::Design
+
+      attr_reader emails: GrowsurfRuby::Resources::Campaign::Emails
+
+      attr_reader options: GrowsurfRuby::Resources::Campaign::Options
+
+      attr_reader installation: GrowsurfRuby::Resources::Campaign::Installation
+
+      attr_reader webhooks: GrowsurfRuby::Resources::Campaign::Webhooks
+
       def retrieve: (
         String id,
         ?request_options: GrowsurfRuby::request_opts
@@ -23,9 +33,7 @@ module GrowsurfRuby
         ?company_logo_image_url: String,
         ?company_name: String,
         ?currency_iso: String,
-        ?goal: String,
         ?name: String,
-        ?options: ::Hash[Symbol, top],
         ?rewards: ::Array[GrowsurfRuby::Campaign::RewardCreateParams],
         ?request_options: GrowsurfRuby::request_opts
       ) -> GrowsurfRuby::CampaignAPI
@@ -34,14 +42,7 @@ module GrowsurfRuby
         String id,
         ?company_logo_image_url: String,
         ?company_name: String,
-        ?currency_iso: String,
-        ?design: ::Hash[Symbol, top],
-        ?emails: ::Hash[Symbol, top],
-        ?goal: String,
-        ?installation: ::Hash[Symbol, top],
         ?name: String,
-        ?notifications: ::Hash[Symbol, top],
-        ?options: ::Hash[Symbol, top],
         ?status: GrowsurfRuby::Models::CampaignUpdateParams::status,
         ?request_options: GrowsurfRuby::request_opts
       ) -> GrowsurfRuby::CampaignAPI
@@ -51,6 +52,11 @@ module GrowsurfRuby
         ?request_options: GrowsurfRuby::request_opts
       ) -> GrowsurfRuby::CampaignAPI
 
+      def get_referral_flow_screenshots: (
+        String id,
+        ?request_options: GrowsurfRuby::request_opts
+      ) -> GrowsurfRuby::Models::ReferralFlowScreenshotsResponse
+
       def create_mobile_participant_token: (
         String id,
         email: String,
@@ -115,6 +121,8 @@ module GrowsurfRuby
         String id,
         ?days: Integer,
         ?end_date: Integer,
+        ?include: String,
+        ?interval: GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams::interval,
         ?start_date: Integer,
         ?request_options: GrowsurfRuby::request_opts
       ) -> GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse