growsurf-ruby 1.2.1 → 1.3.0

data/rbi/growsurf_ruby/models/campaign_retrieve_affiliate_application_params.rbi

@@ -0,0 +1,46 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    class CampaignRetrieveAffiliateApplicationParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            GrowsurfRuby::CampaignRetrieveAffiliateApplicationParams,
+            GrowsurfRuby::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig { returns(String) }
+      attr_accessor :application_id
+
+      sig do
+        params(
+          id: String,
+          application_id: String,
+          request_options: GrowsurfRuby::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(id:, application_id:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            application_id: String,
+            request_options: GrowsurfRuby::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign_retrieve_analytics_params.rbi

@@ -32,11 +32,13 @@ module GrowsurfRuby
       sig { params(end_date: Integer).void }
       attr_writer :end_date
 
-      # Comma-separated list of optional enrichments (opt-in to keep the default response
-      # lean): `previousPeriod` adds totals for the equal-length window immediately before
-      # the requested one; `statusCounts` adds reward (and, for affiliate programs,
-      # affiliate/commission/payout) status breakdowns; `rates` adds derived referral
-      # rates.
+      # Comma-separated list of optional data to include: `previousPeriod` adds totals for the
+      # equal-length window immediately before the requested one; `statusCounts` adds reward (and,
+      # for affiliate programs, affiliate/commission/payout) status breakdowns; `rates` adds
+      # derived referral rates; `email` adds `sent`, `delivered`, `opened`, `clicked`, `bounced`,
+      # `spamComplaints`, and per-email-type metrics. When `email` and an interval are both
+      # requested, each `series` item also contains counts for emails sent during that period.
+      # Combine `email` with `previousPeriod` to include the same email metrics in both windows.
       sig { returns(T.nilable(String)) }
       attr_reader :include
 
@@ -89,11 +91,14 @@ module GrowsurfRuby
         # End date of the analytics timeframe as a Unix timestamp in milliseconds.
         # Required if `days` is not set.
         end_date: nil,
-        # Comma-separated list of optional enrichments (opt-in to keep the default response
-        # lean): `previousPeriod` adds totals for the equal-length window immediately before
-        # the requested one; `statusCounts` adds reward (and, for affiliate programs,
-        # affiliate/commission/payout) status breakdowns; `rates` adds derived referral
-        # rates.
+        # Comma-separated list of optional data to include: `previousPeriod` adds totals for the
+        # equal-length window immediately before the requested one; `statusCounts` adds reward
+        # (and, for affiliate programs, affiliate/commission/payout) status breakdowns; `rates`
+        # adds derived referral rates; `email` adds `sent`, `delivered`, `opened`, `clicked`,
+        # `bounced`, `spamComplaints`, and per-email-type metrics. When `email` and an interval
+        # are both requested, each `series` item also contains counts for emails sent during that
+        # period. Combine `email` with `previousPeriod` to include the same email metrics in both
+        # windows.
         include: nil,
         # When set to `day`, `week`, or `month`, the response also includes a `series` array
         # with per-period totals. Defaults to `total` (no series).

data/rbi/growsurf_ruby/models/campaign_retrieve_analytics_response.rbi

@@ -329,6 +329,12 @@ module GrowsurfRuby
         sig { params(twitter_shares: Integer).void }
         attr_writer :twitter_shares
 
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :unique_commission_referrals
+
+        sig { params(unique_commission_referrals: Integer).void }
+        attr_writer :unique_commission_referrals
+
         sig { returns(T.nilable(Integer)) }
         attr_reader :unique_impressions
 
@@ -374,6 +380,7 @@ module GrowsurfRuby
             total_revenue: Integer,
             tumblr_shares: Integer,
             twitter_shares: Integer,
+            unique_commission_referrals: Integer,
             unique_impressions: Integer,
             wechat_shares: Integer,
             whats_app_shares: Integer
@@ -409,6 +416,7 @@ module GrowsurfRuby
           total_revenue: nil,
           tumblr_shares: nil,
           twitter_shares: nil,
+          unique_commission_referrals: nil,
           unique_impressions: nil,
           wechat_shares: nil,
           whats_app_shares: nil
@@ -443,6 +451,7 @@ module GrowsurfRuby
               total_revenue: Integer,
               tumblr_shares: Integer,
               twitter_shares: Integer,
+              unique_commission_referrals: Integer,
               unique_impressions: Integer,
               wechat_shares: Integer,
               whats_app_shares: Integer
@@ -741,6 +750,12 @@ module GrowsurfRuby
         sig { params(twitter_shares: Integer).void }
         attr_writer :twitter_shares
 
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :unique_commission_referrals
+
+        sig { params(unique_commission_referrals: Integer).void }
+        attr_writer :unique_commission_referrals
+
         sig { returns(T.nilable(Integer)) }
         attr_reader :unique_impressions
 
@@ -787,6 +802,7 @@ module GrowsurfRuby
             total_revenue: Integer,
             tumblr_shares: Integer,
             twitter_shares: Integer,
+            unique_commission_referrals: Integer,
             unique_impressions: Integer,
             wechat_shares: Integer,
             whats_app_shares: Integer
@@ -824,6 +840,7 @@ module GrowsurfRuby
           total_revenue: nil,
           tumblr_shares: nil,
           twitter_shares: nil,
+          unique_commission_referrals: nil,
           unique_impressions: nil,
           wechat_shares: nil,
           whats_app_shares: nil
@@ -859,6 +876,7 @@ module GrowsurfRuby
               total_revenue: Integer,
               tumblr_shares: Integer,
               twitter_shares: Integer,
+              unique_commission_referrals: Integer,
               unique_impressions: Integer,
               wechat_shares: Integer,
               whats_app_shares: Integer
@@ -1219,6 +1237,23 @@ module GrowsurfRuby
           end
           attr_writer :queued
 
+          sig do
+            returns(
+              T.nilable(
+                GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric
+              )
+            )
+          end
+          attr_reader :reversed
+
+          sig do
+            params(
+              reversed:
+                GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric::OrHash
+            ).void
+          end
+          attr_writer :reversed
+
           sig do
             returns(
               T.nilable(
@@ -1245,11 +1280,19 @@ module GrowsurfRuby
                 GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric::OrHash,
               queued:
                 GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric::OrHash,
+              reversed:
+                GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric::OrHash,
               upcoming:
                 GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric::OrHash
             ).returns(T.attached_class)
           end
-          def self.new(failed: nil, issued: nil, queued: nil, upcoming: nil)
+          def self.new(
+            failed: nil,
+            issued: nil,
+            queued: nil,
+            reversed: nil,
+            upcoming: nil
+          )
           end
 
           sig do
@@ -1261,6 +1304,8 @@ module GrowsurfRuby
                   GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric,
                 queued:
                   GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric,
+                reversed:
+                  GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric,
                 upcoming:
                   GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric
               }
@@ -1303,9 +1348,7 @@ module GrowsurfRuby
             )
             end
 
-            sig do
-              override.returns({ count: Integer, total_amount: Integer })
-            end
+            sig { override.returns({ count: Integer, total_amount: Integer }) }
             def to_hash
             end
           end
@@ -1320,32 +1363,39 @@ module GrowsurfRuby
               )
             end
 
+          # Approved rewards that are fulfilled.
           sig { returns(T.nilable(Integer)) }
-          attr_reader :approved
+          attr_reader :completed
 
-          sig { params(approved: Integer).void }
-          attr_writer :approved
+          sig { params(completed: Integer).void }
+          attr_writer :completed
 
-          # Unapproved rewards awaiting fulfillment.
+          # Unapproved rewards awaiting review.
           sig { returns(T.nilable(Integer)) }
-          attr_reader :pending
+          attr_reader :unapproved
 
-          sig { params(pending: Integer).void }
-          attr_writer :pending
+          sig { params(unapproved: Integer).void }
+          attr_writer :unapproved
 
+          # Rewards that are approved but not fulfilled.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :unfulfilled
+
+          sig { params(unfulfilled: Integer).void }
+          attr_writer :unfulfilled
+
+          # Reward counts grouped by review and fulfillment status.
           sig do
-            params(approved: Integer, pending: Integer).returns(
-              T.attached_class
-            )
+            params(completed: Integer, unapproved: Integer, unfulfilled: Integer).returns(T.attached_class)
           end
           def self.new(
-            approved: nil,
-            # Unapproved rewards awaiting fulfillment.
-            pending: nil
+            completed: nil,
+            unapproved: nil,
+            unfulfilled: nil
           )
           end
 
-          sig { override.returns({ approved: Integer, pending: Integer }) }
+          sig { override.returns({ completed: Integer, unapproved: Integer, unfulfilled: Integer }) }
           def to_hash
           end
         end

data/rbi/growsurf_ruby/models/campaign_review_affiliate_application_params.rbi

@@ -0,0 +1,167 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    # Either decide a pending application with `status`, or move a denied application's
+    # reapplication window with `reapply_allowed_at`. Provide exactly one of those
+    # fields.
+    class CampaignReviewAffiliateApplicationParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            GrowsurfRuby::CampaignReviewAffiliateApplicationParams,
+            GrowsurfRuby::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig { returns(String) }
+      attr_accessor :application_id
+
+      # When denying, let the applicant reapply right away instead of waiting out the
+      # program's reapplication cooldown. Only valid when `status` is `DENIED`.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :allow_immediate_reapply
+
+      sig { params(allow_immediate_reapply: T::Boolean).void }
+      attr_writer :allow_immediate_reapply
+
+      # For an already-denied application, move the reapplication window to this earlier
+      # time, in Unix milliseconds. Send without `status`.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :reapply_allowed_at
+
+      sig { params(reapply_allowed_at: Integer).void }
+      attr_writer :reapply_allowed_at
+
+      # Short reason recorded with a denial. Only valid when `status` is `DENIED`.
+      # Maximum 255 characters.
+      sig { returns(T.nilable(String)) }
+      attr_reader :rejection_reason
+
+      sig { params(rejection_reason: String).void }
+      attr_writer :rejection_reason
+
+      # Private note recorded with a denial. Only valid when `status` is `DENIED`; never
+      # shown to the applicant. Maximum 500 characters.
+      sig { returns(T.nilable(String)) }
+      attr_reader :review_note
+
+      sig { params(review_note: String).void }
+      attr_writer :review_note
+
+      # The decision. `APPROVED` enrolls the applicant as an affiliate; `DENIED` closes
+      # the application.
+      sig do
+        returns(
+          T.nilable(
+            GrowsurfRuby::CampaignReviewAffiliateApplicationParams::Status::OrSymbol
+          )
+        )
+      end
+      attr_reader :status
+
+      sig do
+        params(
+          status:
+            GrowsurfRuby::CampaignReviewAffiliateApplicationParams::Status::OrSymbol
+        ).void
+      end
+      attr_writer :status
+
+      sig do
+        params(
+          id: String,
+          application_id: String,
+          allow_immediate_reapply: T::Boolean,
+          reapply_allowed_at: Integer,
+          rejection_reason: String,
+          review_note: String,
+          status:
+            GrowsurfRuby::CampaignReviewAffiliateApplicationParams::Status::OrSymbol,
+          request_options: GrowsurfRuby::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        application_id:,
+        # When denying, let the applicant reapply right away instead of waiting out the
+        # program's reapplication cooldown.
+        allow_immediate_reapply: nil,
+        # For an already-denied application, move the reapplication window to this earlier
+        # time, in Unix milliseconds. Send without `status`.
+        reapply_allowed_at: nil,
+        # Short reason recorded with a denial. Only valid when `status` is `DENIED`.
+        # Maximum 255 characters.
+        rejection_reason: nil,
+        # Private note recorded with a denial. Only valid when `status` is `DENIED`; never
+        # shown to the applicant. Maximum 500 characters.
+        review_note: nil,
+        # The decision. `APPROVED` enrolls the applicant as an affiliate; `DENIED` closes
+        # the application.
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            application_id: String,
+            allow_immediate_reapply: T::Boolean,
+            reapply_allowed_at: Integer,
+            rejection_reason: String,
+            review_note: String,
+            status:
+              GrowsurfRuby::CampaignReviewAffiliateApplicationParams::Status::OrSymbol,
+            request_options: GrowsurfRuby::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The decision. `APPROVED` enrolls the applicant as an affiliate; `DENIED` closes
+      # the application.
+      module Status
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              GrowsurfRuby::CampaignReviewAffiliateApplicationParams::Status
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        APPROVED =
+          T.let(
+            :APPROVED,
+            GrowsurfRuby::CampaignReviewAffiliateApplicationParams::Status::TaggedSymbol
+          )
+        DENIED =
+          T.let(
+            :DENIED,
+            GrowsurfRuby::CampaignReviewAffiliateApplicationParams::Status::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              GrowsurfRuby::CampaignReviewAffiliateApplicationParams::Status::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/campaign_revoke_affiliate_invite_params.rbi

@@ -0,0 +1,46 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    class CampaignRevokeAffiliateInviteParams < GrowsurfRuby::Internal::Type::BaseModel
+      extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
+      include GrowsurfRuby::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            GrowsurfRuby::CampaignRevokeAffiliateInviteParams,
+            GrowsurfRuby::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig { returns(String) }
+      attr_accessor :invite_id
+
+      sig do
+        params(
+          id: String,
+          invite_id: String,
+          request_options: GrowsurfRuby::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(id:, invite_id:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            invite_id: String,
+            request_options: GrowsurfRuby::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/models/email_analytics.rbi

@@ -0,0 +1,200 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Models
+    class EmailAnalytics < GrowsurfRuby::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            GrowsurfRuby::Models::EmailAnalytics,
+            GrowsurfRuby::Internal::AnyHash
+          )
+        end
+
+      sig { returns(Integer) }
+      attr_accessor :sent
+
+      sig { returns(Integer) }
+      attr_accessor :delivered
+
+      sig { returns(Integer) }
+      attr_accessor :opened
+
+      sig { returns(Integer) }
+      attr_accessor :clicked
+
+      sig { returns(Integer) }
+      attr_accessor :bounced
+
+      sig { returns(Integer) }
+      attr_accessor :spam_complaints
+
+      sig { returns(Float) }
+      attr_accessor :delivery_rate
+
+      sig { returns(Float) }
+      attr_accessor :open_rate
+
+      sig { returns(Float) }
+      attr_accessor :click_rate
+
+      sig { returns(Float) }
+      attr_accessor :bounce_rate
+
+      sig { returns(T::Array[GrowsurfRuby::Models::EmailAnalytics::ByType]) }
+      attr_reader :by_type
+
+      sig do
+        params(
+          by_type:
+            T::Array[GrowsurfRuby::Models::EmailAnalytics::ByType::OrHash]
+        ).void
+      end
+      attr_writer :by_type
+
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :coverage_start_date
+
+      sig { returns(T::Boolean) }
+      attr_accessor :is_partial
+
+      sig do
+        params(
+          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:
+            T::Array[GrowsurfRuby::Models::EmailAnalytics::ByType::OrHash],
+          coverage_start_date: T.nilable(Integer),
+          is_partial: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        sent:,
+        delivered:,
+        opened:,
+        clicked:,
+        bounced:,
+        spam_complaints:,
+        delivery_rate:,
+        open_rate:,
+        click_rate:,
+        bounce_rate:,
+        by_type:,
+        coverage_start_date:,
+        is_partial:
+      )
+      end
+
+      class Counts < GrowsurfRuby::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              GrowsurfRuby::Models::EmailAnalytics::Counts,
+              GrowsurfRuby::Internal::AnyHash
+            )
+          end
+
+        sig { returns(Integer) }
+        attr_accessor :sent
+
+        sig { returns(Integer) }
+        attr_accessor :delivered
+
+        sig { returns(Integer) }
+        attr_accessor :opened
+
+        sig { returns(Integer) }
+        attr_accessor :clicked
+
+        sig { returns(Integer) }
+        attr_accessor :bounced
+
+        sig { returns(Integer) }
+        attr_accessor :spam_complaints
+
+        sig do
+          params(
+            sent: Integer,
+            delivered: Integer,
+            opened: Integer,
+            clicked: Integer,
+            bounced: Integer,
+            spam_complaints: Integer
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          sent:,
+          delivered:,
+          opened:,
+          clicked:,
+          bounced:,
+          spam_complaints:
+        )
+        end
+      end
+
+      class ByType < GrowsurfRuby::Models::EmailAnalytics::Counts
+        OrHash =
+          T.type_alias do
+            T.any(
+              GrowsurfRuby::Models::EmailAnalytics::ByType,
+              GrowsurfRuby::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :email_type
+
+        sig { returns(Float) }
+        attr_accessor :delivery_rate
+
+        sig { returns(Float) }
+        attr_accessor :open_rate
+
+        sig { returns(Float) }
+        attr_accessor :click_rate
+
+        sig { returns(Float) }
+        attr_accessor :bounce_rate
+
+        sig do
+          params(
+            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
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          sent:,
+          delivered:,
+          opened:,
+          clicked:,
+          bounced:,
+          spam_complaints:,
+          email_type:,
+          delivery_rate:,
+          open_rate:,
+          click_rate:,
+          bounce_rate:
+        )
+        end
+      end
+    end
+  end
+end