growsurf-ruby 0.0.2

data/rbi/growsurf_ruby/resources/campaign.rbi

@@ -0,0 +1,205 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Resources
+    class Campaign
+      sig { returns(GrowsurfRuby::Resources::Campaign::Participant) }
+      attr_reader :participant
+
+      # Participant reward retrieval and manual reward operations.
+      sig { returns(GrowsurfRuby::Resources::Campaign::Reward) }
+      attr_reader :reward
+
+      # Affiliate transaction, commission, and payout operations.
+      sig { returns(GrowsurfRuby::Resources::Campaign::Commission) }
+      attr_reader :commission
+
+      # Retrieves a program for the given program ID.
+      sig do
+        params(
+          id: String,
+          request_options: GrowsurfRuby::RequestOptions::OrHash
+        ).returns(GrowsurfRuby::CampaignAPI)
+      end
+      def retrieve(
+        # GrowSurf program ID.
+        id,
+        request_options: {}
+      )
+      end
+
+      # Retrieves a list of your programs. Deleted programs are not returned.
+      sig do
+        params(request_options: GrowsurfRuby::RequestOptions::OrHash).returns(
+          GrowsurfRuby::Models::CampaignListResponse
+        )
+      end
+      def list(request_options: {})
+      end
+
+      # Retrieves a paged list of all participant commissions in an affiliate program.
+      sig do
+        params(
+          id: String,
+          limit: Integer,
+          next_id: String,
+          status: GrowsurfRuby::CampaignListCommissionsParams::Status::OrSymbol,
+          request_options: GrowsurfRuby::RequestOptions::OrHash
+        ).returns(GrowsurfRuby::ParticipantCommissionList)
+      end
+      def list_commissions(
+        # GrowSurf program ID.
+        id,
+        # Number of results to return. Maximum 100.
+        limit: nil,
+        # ID to start the next paged result set with.
+        next_id: nil,
+        # Participant commission status.
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieves participants in leaderboard order for the specified leaderboard type.
+      sig do
+        params(
+          id: String,
+          is_monthly: T::Boolean,
+          leaderboard_type:
+            GrowsurfRuby::CampaignListLeaderboardParams::LeaderboardType::OrSymbol,
+          limit: Integer,
+          next_id: String,
+          request_options: GrowsurfRuby::RequestOptions::OrHash
+        ).returns(GrowsurfRuby::ParticipantList)
+      end
+      def list_leaderboard(
+        # GrowSurf program ID.
+        id,
+        # Deprecated. Use `leaderboardType=CURRENT_MONTH` instead.
+        is_monthly: nil,
+        # Leaderboard ordering mode.
+        leaderboard_type: nil,
+        # Number of results to return. Maximum 100.
+        limit: nil,
+        # ID to start the next paged result set with.
+        next_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieves a paged list of participants in a program.
+      sig do
+        params(
+          id: String,
+          limit: Integer,
+          next_id: String,
+          request_options: GrowsurfRuby::RequestOptions::OrHash
+        ).returns(GrowsurfRuby::ParticipantList)
+      end
+      def list_participants(
+        # GrowSurf program ID.
+        id,
+        # Number of results to return. Maximum 100.
+        limit: nil,
+        # ID to start the next paged result set with.
+        next_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieves a paged list of all participant payouts in an affiliate program.
+      sig do
+        params(
+          id: String,
+          limit: Integer,
+          next_id: String,
+          status: GrowsurfRuby::CampaignListPayoutsParams::Status::OrSymbol,
+          request_options: GrowsurfRuby::RequestOptions::OrHash
+        ).returns(GrowsurfRuby::ParticipantPayoutList)
+      end
+      def list_payouts(
+        # GrowSurf program ID.
+        id,
+        # Number of results to return. Maximum 100.
+        limit: nil,
+        # ID to start the next paged result set with.
+        next_id: nil,
+        # Participant payout status.
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieves a list of all referrals and email invites made by participants in a
+      # program.
+      sig do
+        params(
+          id: String,
+          desc: T::Boolean,
+          email: String,
+          first_name: String,
+          last_name: String,
+          limit: Integer,
+          next_id: String,
+          offset: Integer,
+          referral_status: GrowsurfRuby::Campaign::ReferralStatus::OrSymbol,
+          sort_by: GrowsurfRuby::CampaignListReferralsParams::SortBy::OrSymbol,
+          request_options: GrowsurfRuby::RequestOptions::OrHash
+        ).returns(GrowsurfRuby::ReferralList)
+      end
+      def list_referrals(
+        # GrowSurf program ID.
+        id,
+        # Return results in descending order when true.
+        desc: nil,
+        # URL-encoded email value to filter referral results.
+        email: nil,
+        # First name value to filter results.
+        first_name: nil,
+        # Last name value to filter results.
+        last_name: nil,
+        # Number of results to return. Maximum 100.
+        limit: nil,
+        # ID to start the next paged result set with.
+        next_id: nil,
+        # Offset number used to skip through a result set.
+        offset: nil,
+        referral_status: nil,
+        # Field used to sort referral results.
+        sort_by: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieves analytics for a program.
+      sig do
+        params(
+          id: String,
+          days: Integer,
+          end_date: Integer,
+          start_date: Integer,
+          request_options: GrowsurfRuby::RequestOptions::OrHash
+        ).returns(GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse)
+      end
+      def retrieve_analytics(
+        # GrowSurf program ID.
+        id,
+        # Last number of days to retrieve analytics for. Defaults to 365. Maximum 1825.
+        days: nil,
+        # End date of the analytics timeframe as a Unix timestamp in milliseconds.
+        # Required if `days` is not set.
+        end_date: nil,
+        # Start date of the analytics timeframe as a Unix timestamp in milliseconds.
+        # Required if `days` is not set.
+        start_date: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: GrowsurfRuby::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/growsurf_ruby/version.rbi

@@ -0,0 +1,5 @@
+# typed: strong
+
+module GrowsurfRuby
+  VERSION = T.let(T.unsafe(nil), String)
+end

data/sig/growsurf_ruby/client.rbs

@@ -0,0 +1,26 @@
+module GrowsurfRuby
+  class Client < GrowsurfRuby::Internal::Transport::BaseClient
+    DEFAULT_MAX_RETRIES: 2
+
+    DEFAULT_TIMEOUT_IN_SECONDS: Float
+
+    DEFAULT_INITIAL_RETRY_DELAY: Float
+
+    DEFAULT_MAX_RETRY_DELAY: Float
+
+    attr_reader api_key: String
+
+    attr_reader campaign: GrowsurfRuby::Resources::Campaign
+
+    private def auth_headers: -> ::Hash[String, String]
+
+    def initialize: (
+      ?api_key: String?,
+      ?base_url: String?,
+      ?max_retries: Integer,
+      ?timeout: Float,
+      ?initial_retry_delay: Float,
+      ?max_retry_delay: Float
+    ) -> void
+  end
+end

data/sig/growsurf_ruby/errors.rbs

@@ -0,0 +1,117 @@
+module GrowsurfRuby
+  module Errors
+    class Error < StandardError
+      attr_accessor cause: StandardError?
+    end
+
+    class ConversionError < GrowsurfRuby::Errors::Error
+      def cause: -> StandardError?
+
+      def initialize: (
+        on: Class,
+        method: Symbol,
+        target: top,
+        value: top,
+        ?cause: StandardError?
+      ) -> void
+    end
+
+    class APIError < GrowsurfRuby::Errors::Error
+      attr_accessor url: URI::Generic
+
+      attr_accessor status: Integer?
+
+      attr_accessor headers: ::Hash[String, String]?
+
+      attr_accessor body: top?
+
+      def initialize: (
+        url: URI::Generic,
+        ?status: Integer?,
+        ?headers: ::Hash[String, String]?,
+        ?body: Object?,
+        ?request: nil,
+        ?response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class APIConnectionError < GrowsurfRuby::Errors::APIError
+      def initialize: (
+        url: URI::Generic,
+        ?status: nil,
+        ?headers: ::Hash[String, String]?,
+        ?body: nil,
+        ?request: nil,
+        ?response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class APITimeoutError < GrowsurfRuby::Errors::APIConnectionError
+      def initialize: (
+        url: URI::Generic,
+        ?status: nil,
+        ?headers: ::Hash[String, String]?,
+        ?body: nil,
+        ?request: nil,
+        ?response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class APIStatusError < GrowsurfRuby::Errors::APIError
+      def self.for: (
+        url: URI::Generic,
+        status: Integer,
+        headers: ::Hash[String, String]?,
+        body: Object?,
+        request: nil,
+        response: nil,
+        ?message: String?
+      ) -> instance
+
+      def initialize: (
+        url: URI::Generic,
+        status: Integer,
+        headers: ::Hash[String, String]?,
+        body: Object?,
+        request: nil,
+        response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class BadRequestError < GrowsurfRuby::Errors::APIStatusError
+      HTTP_STATUS: 400
+    end
+
+    class AuthenticationError < GrowsurfRuby::Errors::APIStatusError
+      HTTP_STATUS: 401
+    end
+
+    class PermissionDeniedError < GrowsurfRuby::Errors::APIStatusError
+      HTTP_STATUS: 403
+    end
+
+    class NotFoundError < GrowsurfRuby::Errors::APIStatusError
+      HTTP_STATUS: 404
+    end
+
+    class ConflictError < GrowsurfRuby::Errors::APIStatusError
+      HTTP_STATUS: 409
+    end
+
+    class UnprocessableEntityError < GrowsurfRuby::Errors::APIStatusError
+      HTTP_STATUS: 422
+    end
+
+    class RateLimitError < GrowsurfRuby::Errors::APIStatusError
+      HTTP_STATUS: 429
+    end
+
+    class InternalServerError < GrowsurfRuby::Errors::APIStatusError
+      HTTP_STATUS: Range[Integer]
+    end
+  end
+end

data/sig/growsurf_ruby/file_part.rbs

@@ -0,0 +1,21 @@
+module GrowsurfRuby
+  class FilePart
+    attr_reader content: Pathname | StringIO | IO | String
+
+    attr_reader content_type: String?
+
+    attr_reader filename: String?
+
+    private def read: -> String
+
+    def to_json: (*top a) -> String
+
+    def to_yaml: (*top a) -> String
+
+    def initialize: (
+      Pathname | StringIO | IO | String content,
+      ?filename: (Pathname | String)?,
+      ?content_type: String?
+    ) -> void
+  end
+end

data/sig/growsurf_ruby/internal/transport/base_client.rbs

@@ -0,0 +1,133 @@
+module GrowsurfRuby
+  module Internal
+    module Transport
+      class BaseClient
+        extend GrowsurfRuby::Internal::Util::SorbetRuntimeSupport
+
+        type request_components =
+          {
+            method: Symbol,
+            path: String | ::Array[String],
+            query: ::Hash[String, (::Array[String] | String)?]?,
+            headers: ::Hash[String, (String
+            | Integer
+            | ::Array[(String | Integer)?])?]?,
+            body: top?,
+            unwrap: (Symbol
+            | Integer
+            | ::Array[(Symbol | Integer)]
+            | (^(top arg0) -> top))?,
+            page: Class?,
+            stream: Class?,
+            model: GrowsurfRuby::Internal::Type::Converter::input?,
+            options: GrowsurfRuby::request_opts?
+          }
+        type request_input =
+          {
+            method: Symbol,
+            url: URI::Generic,
+            headers: ::Hash[String, String],
+            body: top,
+            max_retries: Integer,
+            timeout: Float
+          }
+
+        MAX_REDIRECTS: 20
+
+        PLATFORM_HEADERS: ::Hash[String, String]
+
+        def self.validate!: (
+          GrowsurfRuby::Internal::Transport::BaseClient::request_components req
+        ) -> void
+
+        def self.should_retry?: (
+          Integer status,
+          headers: ::Hash[String, String]
+        ) -> bool
+
+        def self.follow_redirect: (
+          GrowsurfRuby::Internal::Transport::BaseClient::request_input request,
+          status: Integer,
+          response_headers: ::Hash[String, String]
+        ) -> GrowsurfRuby::Internal::Transport::BaseClient::request_input
+
+        def self.reap_connection!: (
+          Integer | GrowsurfRuby::Errors::APIConnectionError status,
+          stream: Enumerable[String]?
+        ) -> void
+
+        attr_reader base_url: URI::Generic
+
+        attr_reader timeout: Float
+
+        attr_reader max_retries: Integer
+
+        attr_reader initial_retry_delay: Float
+
+        attr_reader max_retry_delay: Float
+
+        attr_reader headers: ::Hash[String, String]
+
+        attr_reader idempotency_header: String?
+
+        # @api private
+        attr_reader requester: GrowsurfRuby::Internal::Transport::PooledNetRequester
+
+        def initialize: (
+          base_url: String,
+          ?timeout: Float,
+          ?max_retries: Integer,
+          ?initial_retry_delay: Float,
+          ?max_retry_delay: Float,
+          ?headers: ::Hash[String, (String
+          | Integer
+          | ::Array[(String | Integer)?])?],
+          ?idempotency_header: String?
+        ) -> void
+
+        private def auth_headers: -> ::Hash[String, String]
+
+        private def user_agent: -> String
+
+        private def generate_idempotency_key: -> String
+
+        private def build_request: (
+          GrowsurfRuby::Internal::Transport::BaseClient::request_components req,
+          GrowsurfRuby::request_options opts
+        ) -> GrowsurfRuby::Internal::Transport::BaseClient::request_input
+
+        private def retry_delay: (
+          ::Hash[String, String] headers,
+          retry_count: Integer
+        ) -> Float
+
+        def send_request: (
+          GrowsurfRuby::Internal::Transport::BaseClient::request_input request,
+          redirect_count: Integer,
+          retry_count: Integer,
+          send_retry_header: bool
+        ) -> [Integer, top, Enumerable[String]]
+
+        def request: (
+          Symbol method,
+          String | ::Array[String] path,
+          ?query: ::Hash[String, (::Array[String] | String)?]?,
+          ?headers: ::Hash[String, (String
+          | Integer
+          | ::Array[(String | Integer)?])?]?,
+          ?body: top?,
+          ?unwrap: (Symbol
+          | Integer
+          | ::Array[(Symbol | Integer)]
+          | (^(top arg0) -> top))?,
+          ?page: Class?,
+          ?stream: Class?,
+          ?model: GrowsurfRuby::Internal::Type::Converter::input?,
+          ?options: GrowsurfRuby::request_opts?
+        ) -> top
+
+        def inspect: -> String
+      end
+    end
+  end
+end

data/sig/growsurf_ruby/internal/transport/pooled_net_requester.rbs

@@ -0,0 +1,48 @@
+module GrowsurfRuby
+  module Internal
+    module Transport
+      class PooledNetRequester
+        extend GrowsurfRuby::Internal::Util::SorbetRuntimeSupport
+
+        type request =
+          {
+            method: Symbol,
+            url: URI::Generic,
+            headers: ::Hash[String, String],
+            body: top,
+            deadline: Float
+          }
+
+        KEEP_ALIVE_TIMEOUT: 30
+
+        DEFAULT_MAX_CONNECTIONS: Integer
+
+        def self.connect: (
+          cert_store: OpenSSL::X509::Store,
+          url: URI::Generic
+        ) -> top
+
+        def self.calibrate_socket_timeout: (top conn, Float deadline) -> void
+
+        def self.build_request: (
+          GrowsurfRuby::Internal::Transport::PooledNetRequester::request request
+        ) {
+          (String arg0) -> void
+        } -> [top, (^-> void)]
+
+        private def with_pool: (
+          URI::Generic url,
+          deadline: Float
+        ) {
+          (top arg0) -> void
+        } -> void
+
+        def execute: (
+          GrowsurfRuby::Internal::Transport::PooledNetRequester::request request
+        ) -> [Integer, top, Enumerable[String]]
+
+        def initialize: (?size: Integer) -> void
+      end
+    end
+  end
+end

data/sig/growsurf_ruby/internal/type/array_of.rbs

@@ -0,0 +1,48 @@
+module GrowsurfRuby
+  module Internal
+    module Type
+      class ArrayOf[Elem]
+        include GrowsurfRuby::Internal::Type::Converter
+        include GrowsurfRuby::Internal::Util::SorbetRuntimeSupport
+
+        def self.[]: (
+          ::Hash[Symbol, top]
+          | ^-> GrowsurfRuby::Internal::Type::Converter::input
+          | GrowsurfRuby::Internal::Type::Converter::input type_info,
+          ?::Hash[Symbol, top] spec
+        ) -> instance
+
+        def ===: (top other) -> bool
+
+        def ==: (top other) -> bool
+
+        def hash: -> Integer
+
+        def coerce: (
+          ::Array[top] | top value,
+          state: GrowsurfRuby::Internal::Type::Converter::coerce_state
+        ) -> (::Array[top] | top)
+
+        def dump: (
+          ::Array[top] | top value,
+          state: GrowsurfRuby::Internal::Type::Converter::dump_state
+        ) -> (::Array[top] | top)
+
+        def to_sorbet_type: -> top
+
+        def item_type: -> Elem
+
+        def nilable?: -> bool
+
+        def initialize: (
+          ::Hash[Symbol, top]
+          | ^-> GrowsurfRuby::Internal::Type::Converter::input
+          | GrowsurfRuby::Internal::Type::Converter::input type_info,
+          ?::Hash[Symbol, top] spec
+        ) -> void
+
+        def inspect: (?depth: Integer) -> String
+      end
+    end
+  end
+end

data/sig/growsurf_ruby/internal/type/base_model.rbs

@@ -0,0 +1,104 @@
+module GrowsurfRuby
+  module Internal
+    module Type
+      class BaseModel
+        extend GrowsurfRuby::Internal::Type::Converter
+        extend GrowsurfRuby::Internal::Util::SorbetRuntimeSupport
+
+        type known_field =
+          { mode: (:coerce | :dump)?, required: bool, nilable: bool }
+
+        def self.inherited: (self child) -> void
+
+        def self.known_fields: -> ::Hash[Symbol, (GrowsurfRuby::Internal::Type::BaseModel::known_field
+        & { type_fn: (^-> GrowsurfRuby::Internal::Type::Converter::input) })]
+
+        def self.fields: -> ::Hash[Symbol, (GrowsurfRuby::Internal::Type::BaseModel::known_field
+        & { type: GrowsurfRuby::Internal::Type::Converter::input })]
+
+        private def self.add_field: (
+          Symbol name_sym,
+          required: bool,
+          type_info: {
+            const: (nil | bool | Integer | Float | Symbol)?,
+            enum: ^-> GrowsurfRuby::Internal::Type::Converter::input?,
+            union: ^-> GrowsurfRuby::Internal::Type::Converter::input?,
+            api_name: Symbol
+          }
+          | ^-> GrowsurfRuby::Internal::Type::Converter::input
+          | GrowsurfRuby::Internal::Type::Converter::input,
+          spec: ::Hash[Symbol, top]
+        ) -> void
+
+        def self.required: (
+          Symbol name_sym,
+          ::Hash[Symbol, top]
+          | ^-> GrowsurfRuby::Internal::Type::Converter::input
+          | GrowsurfRuby::Internal::Type::Converter::input type_info,
+          ?::Hash[Symbol, top] spec
+        ) -> void
+
+        def self.optional: (
+          Symbol name_sym,
+          ::Hash[Symbol, top]
+          | ^-> GrowsurfRuby::Internal::Type::Converter::input
+          | GrowsurfRuby::Internal::Type::Converter::input type_info,
+          ?::Hash[Symbol, top] spec
+        ) -> void
+
+        private def self.request_only: { -> void } -> void
+
+        private def self.response_only: { -> void } -> void
+
+        def self.==: (top other) -> bool
+
+        def self.hash: -> Integer
+
+        def ==: (top other) -> bool
+
+        def hash: -> Integer
+
+        def self.coerce: (
+          GrowsurfRuby::Internal::Type::BaseModel
+          | ::Hash[top, top]
+          | top value,
+          state: GrowsurfRuby::Internal::Type::Converter::coerce_state
+        ) -> (instance | top)
+
+        def self.dump: (
+          instance | top value,
+          state: GrowsurfRuby::Internal::Type::Converter::dump_state
+        ) -> (::Hash[top, top] | top)
+
+        def self.to_sorbet_type: -> top
+
+        def self.recursively_to_h: (
+          GrowsurfRuby::Internal::Type::BaseModel model,
+          convert: bool
+        ) -> ::Hash[Symbol, top]
+
+        def []: (Symbol key) -> top?
+
+        def to_h: -> ::Hash[Symbol, top]
+
+        alias to_hash to_h
+
+        def deep_to_h: -> ::Hash[Symbol, top]
+
+        def deconstruct_keys: (::Array[Symbol]? keys) -> ::Hash[Symbol, top]
+
+        def to_json: (*top a) -> String
+
+        def to_yaml: (*top a) -> String
+
+        def initialize: (?::Hash[Symbol, top] | instance data) -> void
+
+        def self.inspect: (?depth: Integer) -> String
+
+        def to_s: -> String
+
+        def inspect: -> String
+      end
+    end
+  end
+end