growsurf-ruby 0.0.2

data/lib/growsurf_ruby/resources/campaign.rb

@@ -0,0 +1,266 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Resources
+    class Campaign
+      # @return [GrowsurfRuby::Resources::Campaign::Participant]
+      attr_reader :participant
+
+      # Participant reward retrieval and manual reward operations.
+      # @return [GrowsurfRuby::Resources::Campaign::Reward]
+      attr_reader :reward
+
+      # Affiliate transaction, commission, and payout operations.
+      # @return [GrowsurfRuby::Resources::Campaign::Commission]
+      attr_reader :commission
+
+      # Retrieves a program for the given program ID.
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String] GrowSurf program ID.
+      #
+      # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [GrowsurfRuby::Models::CampaignAPI]
+      #
+      # @see GrowsurfRuby::Models::CampaignRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["campaign/%1$s", id],
+          model: GrowsurfRuby::CampaignAPI,
+          options: params[:request_options]
+        )
+      end
+
+      # Retrieves a list of your programs. Deleted programs are not returned.
+      #
+      # @overload list(request_options: {})
+      #
+      # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [GrowsurfRuby::Models::CampaignListResponse]
+      #
+      # @see GrowsurfRuby::Models::CampaignListParams
+      def list(params = {})
+        @client.request(
+          method: :get,
+          path: "campaigns",
+          model: GrowsurfRuby::Models::CampaignListResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Retrieves a paged list of all participant commissions in an affiliate program.
+      #
+      # @overload list_commissions(id, limit: nil, next_id: nil, status: nil, request_options: {})
+      #
+      # @param id [String] GrowSurf program ID.
+      #
+      # @param limit [Integer] Number of results to return. Maximum 100.
+      #
+      # @param next_id [String] ID to start the next paged result set with.
+      #
+      # @param status [Symbol, GrowsurfRuby::Models::CampaignListCommissionsParams::Status] Participant commission status.
+      #
+      # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [GrowsurfRuby::Models::ParticipantCommissionList]
+      #
+      # @see GrowsurfRuby::Models::CampaignListCommissionsParams
+      def list_commissions(id, params = {})
+        parsed, options = GrowsurfRuby::CampaignListCommissionsParams.dump_request(params)
+        query = GrowsurfRuby::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: ["campaign/%1$s/commissions", id],
+          query: query.transform_keys(next_id: "nextId"),
+          model: GrowsurfRuby::ParticipantCommissionList,
+          options: options
+        )
+      end
+
+      # Retrieves participants in leaderboard order for the specified leaderboard type.
+      #
+      # @overload list_leaderboard(id, is_monthly: nil, leaderboard_type: nil, limit: nil, next_id: nil, request_options: {})
+      #
+      # @param id [String] GrowSurf program ID.
+      #
+      # @param is_monthly [Boolean] Deprecated. Use `leaderboardType=CURRENT_MONTH` instead.
+      #
+      # @param leaderboard_type [Symbol, GrowsurfRuby::Models::CampaignListLeaderboardParams::LeaderboardType] Leaderboard ordering mode.
+      #
+      # @param limit [Integer] Number of results to return. Maximum 100.
+      #
+      # @param next_id [String] ID to start the next paged result set with.
+      #
+      # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [GrowsurfRuby::Models::ParticipantList]
+      #
+      # @see GrowsurfRuby::Models::CampaignListLeaderboardParams
+      def list_leaderboard(id, params = {})
+        parsed, options = GrowsurfRuby::CampaignListLeaderboardParams.dump_request(params)
+        query = GrowsurfRuby::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: ["campaign/%1$s/leaderboard", id],
+          query: query.transform_keys(
+            is_monthly: "isMonthly",
+            leaderboard_type: "leaderboardType",
+            next_id: "nextId"
+          ),
+          model: GrowsurfRuby::ParticipantList,
+          options: options
+        )
+      end
+
+      # Retrieves a paged list of participants in a program.
+      #
+      # @overload list_participants(id, limit: nil, next_id: nil, request_options: {})
+      #
+      # @param id [String] GrowSurf program ID.
+      #
+      # @param limit [Integer] Number of results to return. Maximum 100.
+      #
+      # @param next_id [String] ID to start the next paged result set with.
+      #
+      # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [GrowsurfRuby::Models::ParticipantList]
+      #
+      # @see GrowsurfRuby::Models::CampaignListParticipantsParams
+      def list_participants(id, params = {})
+        parsed, options = GrowsurfRuby::CampaignListParticipantsParams.dump_request(params)
+        query = GrowsurfRuby::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: ["campaign/%1$s/participants", id],
+          query: query.transform_keys(next_id: "nextId"),
+          model: GrowsurfRuby::ParticipantList,
+          options: options
+        )
+      end
+
+      # Retrieves a paged list of all participant payouts in an affiliate program.
+      #
+      # @overload list_payouts(id, limit: nil, next_id: nil, status: nil, request_options: {})
+      #
+      # @param id [String] GrowSurf program ID.
+      #
+      # @param limit [Integer] Number of results to return. Maximum 100.
+      #
+      # @param next_id [String] ID to start the next paged result set with.
+      #
+      # @param status [Symbol, GrowsurfRuby::Models::CampaignListPayoutsParams::Status] Participant payout status.
+      #
+      # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [GrowsurfRuby::Models::ParticipantPayoutList]
+      #
+      # @see GrowsurfRuby::Models::CampaignListPayoutsParams
+      def list_payouts(id, params = {})
+        parsed, options = GrowsurfRuby::CampaignListPayoutsParams.dump_request(params)
+        query = GrowsurfRuby::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: ["campaign/%1$s/payouts", id],
+          query: query.transform_keys(next_id: "nextId"),
+          model: GrowsurfRuby::ParticipantPayoutList,
+          options: options
+        )
+      end
+
+      # Retrieves a list of all referrals and email invites made by participants in a
+      # program.
+      #
+      # @overload list_referrals(id, desc: nil, email: nil, first_name: nil, last_name: nil, limit: nil, next_id: nil, offset: nil, referral_status: nil, sort_by: nil, request_options: {})
+      #
+      # @param id [String] GrowSurf program ID.
+      #
+      # @param desc [Boolean] Return results in descending order when true.
+      #
+      # @param email [String] URL-encoded email value to filter referral results.
+      #
+      # @param first_name [String] First name value to filter results.
+      #
+      # @param last_name [String] Last name value to filter results.
+      #
+      # @param limit [Integer] Number of results to return. Maximum 100.
+      #
+      # @param next_id [String] ID to start the next paged result set with.
+      #
+      # @param offset [Integer] Offset number used to skip through a result set.
+      #
+      # @param referral_status [Symbol, GrowsurfRuby::Models::Campaign::ReferralStatus]
+      #
+      # @param sort_by [Symbol, GrowsurfRuby::Models::CampaignListReferralsParams::SortBy] Field used to sort referral results.
+      #
+      # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [GrowsurfRuby::Models::ReferralList]
+      #
+      # @see GrowsurfRuby::Models::CampaignListReferralsParams
+      def list_referrals(id, params = {})
+        parsed, options = GrowsurfRuby::CampaignListReferralsParams.dump_request(params)
+        query = GrowsurfRuby::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: ["campaign/%1$s/referrals", id],
+          query: query.transform_keys(
+            first_name: "firstName",
+            last_name: "lastName",
+            next_id: "nextId",
+            referral_status: "referralStatus",
+            sort_by: "sortBy"
+          ),
+          model: GrowsurfRuby::ReferralList,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams} for more details.
+      #
+      # Retrieves analytics for a program.
+      #
+      # @overload retrieve_analytics(id, days: nil, end_date: nil, start_date: nil, request_options: {})
+      #
+      # @param id [String] GrowSurf program ID.
+      #
+      # @param days [Integer] Last number of days to retrieve analytics for. Defaults to 365. Maximum 1825.
+      #
+      # @param end_date [Integer] End date of the analytics timeframe as a Unix timestamp in milliseconds. Require
+      #
+      # @param start_date [Integer] Start date of the analytics timeframe as a Unix timestamp in milliseconds. Requi
+      #
+      # @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse]
+      #
+      # @see GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams
+      def retrieve_analytics(id, params = {})
+        parsed, options = GrowsurfRuby::CampaignRetrieveAnalyticsParams.dump_request(params)
+        query = GrowsurfRuby::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: ["campaign/%1$s/analytics", id],
+          query: query.transform_keys(end_date: "endDate", start_date: "startDate"),
+          model: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [GrowsurfRuby::Client]
+      def initialize(client:)
+        @client = client
+        @participant = GrowsurfRuby::Resources::Campaign::Participant.new(client: client)
+        @reward = GrowsurfRuby::Resources::Campaign::Reward.new(client: client)
+        @commission = GrowsurfRuby::Resources::Campaign::Commission.new(client: client)
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  VERSION = "0.0.2"
+end

data/lib/growsurf_ruby.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+# Standard libraries.
+# rubocop:disable Lint/RedundantRequireStatement
+require "English"
+require "base64"
+require "cgi"
+require "date"
+require "erb"
+require "etc"
+require "json"
+require "net/http"
+require "openssl"
+require "pathname"
+require "rbconfig"
+require "securerandom"
+require "set"
+require "stringio"
+require "time"
+require "uri"
+# rubocop:enable Lint/RedundantRequireStatement
+
+# We already ship the preferred sorbet manifests in the package itself.
+# `tapioca` currently does not offer us a way to opt out of unnecessary compilation.
+if Object.const_defined?(:Tapioca) &&
+   caller.chain([$PROGRAM_NAME]).chain(ARGV).any?(/tapioca/) &&
+   ARGV.none?(/dsl/)
+  return
+end
+
+# Gems.
+require "connection_pool"
+
+# Package files.
+require_relative "growsurf_ruby/version"
+require_relative "growsurf_ruby/internal/util"
+require_relative "growsurf_ruby/internal/type/converter"
+require_relative "growsurf_ruby/internal/type/unknown"
+require_relative "growsurf_ruby/internal/type/boolean"
+require_relative "growsurf_ruby/internal/type/file_input"
+require_relative "growsurf_ruby/internal/type/enum"
+require_relative "growsurf_ruby/internal/type/union"
+require_relative "growsurf_ruby/internal/type/array_of"
+require_relative "growsurf_ruby/internal/type/hash_of"
+require_relative "growsurf_ruby/internal/type/base_model"
+require_relative "growsurf_ruby/internal/type/base_page"
+require_relative "growsurf_ruby/internal/type/request_parameters"
+require_relative "growsurf_ruby/internal"
+require_relative "growsurf_ruby/request_options"
+require_relative "growsurf_ruby/file_part"
+require_relative "growsurf_ruby/errors"
+require_relative "growsurf_ruby/internal/transport/base_client"
+require_relative "growsurf_ruby/internal/transport/pooled_net_requester"
+require_relative "growsurf_ruby/client"
+require_relative "growsurf_ruby/models/campaign/participant"
+require_relative "growsurf_ruby/models/campaign/commission_approve_params"
+require_relative "growsurf_ruby/models/campaign/commission_approve_response"
+require_relative "growsurf_ruby/models/campaign/commission_delete_params"
+require_relative "growsurf_ruby/models/campaign/commission_delete_response"
+require_relative "growsurf_ruby/models/campaign/fraud_risk_level"
+require_relative "growsurf_ruby/models/campaign/participant_add_params"
+require_relative "growsurf_ruby/models/campaign/participant_delete_params"
+require_relative "growsurf_ruby/models/campaign/participant_delete_response"
+require_relative "growsurf_ruby/models/campaign/participant_list_commissions_params"
+require_relative "growsurf_ruby/models/campaign/participant_list_payouts_params"
+require_relative "growsurf_ruby/models/campaign/participant_list_referrals_params"
+require_relative "growsurf_ruby/models/campaign/participant_list_rewards_params"
+require_relative "growsurf_ruby/models/campaign/participant_list_rewards_response"
+require_relative "growsurf_ruby/models/campaign/participant_record_transaction_params"
+require_relative "growsurf_ruby/models/campaign/participant_record_transaction_response"
+require_relative "growsurf_ruby/models/campaign/participant_retrieve_params"
+require_relative "growsurf_ruby/models/campaign/participant_reward"
+require_relative "growsurf_ruby/models/campaign/participant_send_invites_params"
+require_relative "growsurf_ruby/models/campaign/participant_send_invites_response"
+require_relative "growsurf_ruby/models/campaign/participant_trigger_referral_params"
+require_relative "growsurf_ruby/models/campaign/participant_trigger_referral_response"
+require_relative "growsurf_ruby/models/campaign/participant_update_params"
+require_relative "growsurf_ruby/models/campaign/referral_source"
+require_relative "growsurf_ruby/models/campaign/referral_status"
+require_relative "growsurf_ruby/models/campaign/reward_approve_params"
+require_relative "growsurf_ruby/models/campaign/reward_approve_response"
+require_relative "growsurf_ruby/models/campaign/reward_delete_params"
+require_relative "growsurf_ruby/models/campaign/reward_delete_response"
+require_relative "growsurf_ruby/models/campaign/reward_fulfill_params"
+require_relative "growsurf_ruby/models/campaign/reward_fulfill_response"
+require_relative "growsurf_ruby/models/campaign"
+require_relative "growsurf_ruby/models/campaign_list_commissions_params"
+require_relative "growsurf_ruby/models/campaign_list_leaderboard_params"
+require_relative "growsurf_ruby/models/campaign_list_params"
+require_relative "growsurf_ruby/models/campaign_list_participants_params"
+require_relative "growsurf_ruby/models/campaign_list_payouts_params"
+require_relative "growsurf_ruby/models/campaign_list_referrals_params"
+require_relative "growsurf_ruby/models/campaign_list_response"
+require_relative "growsurf_ruby/models/campaign_retrieve_analytics_params"
+require_relative "growsurf_ruby/models/campaign_retrieve_analytics_response"
+require_relative "growsurf_ruby/models/campaign_retrieve_params"
+require_relative "growsurf_ruby/models/commission_structure"
+require_relative "growsurf_ruby/models/participant_commission_list"
+require_relative "growsurf_ruby/models/participant_list"
+require_relative "growsurf_ruby/models/participant_payout_list"
+require_relative "growsurf_ruby/models/referral_list"
+require_relative "growsurf_ruby/models"
+require_relative "growsurf_ruby/resources/campaign"
+require_relative "growsurf_ruby/resources/campaign/commission"
+require_relative "growsurf_ruby/resources/campaign/participant"
+require_relative "growsurf_ruby/resources/campaign/reward"

data/manifest.yaml

@@ -0,0 +1,17 @@
+dependencies:
+  - English
+  - base64
+  - cgi
+  - date
+  - erb
+  - etc
+  - json
+  - net/http
+  - openssl
+  - pathname
+  - rbconfig
+  - securerandom
+  - set
+  - stringio
+  - time
+  - uri

data/rbi/growsurf_ruby/client.rbi

@@ -0,0 +1,51 @@
+# typed: strong
+
+module GrowsurfRuby
+  class Client < GrowsurfRuby::Internal::Transport::BaseClient
+    DEFAULT_MAX_RETRIES = 2
+
+    DEFAULT_TIMEOUT_IN_SECONDS = T.let(60.0, Float)
+
+    DEFAULT_INITIAL_RETRY_DELAY = T.let(0.5, Float)
+
+    DEFAULT_MAX_RETRY_DELAY = T.let(8.0, Float)
+
+    # GrowSurf REST API key supplied as `Authorization: Bearer <api_key>`.
+    sig { returns(String) }
+    attr_reader :api_key
+
+    sig { returns(GrowsurfRuby::Resources::Campaign) }
+    attr_reader :campaign
+
+    # @api private
+    sig { override.returns(T::Hash[String, String]) }
+    private def auth_headers
+    end
+
+    # Creates and returns a new client for interacting with the API.
+    sig do
+      params(
+        api_key: T.nilable(String),
+        base_url: T.nilable(String),
+        max_retries: Integer,
+        timeout: Float,
+        initial_retry_delay: Float,
+        max_retry_delay: Float
+      ).returns(T.attached_class)
+    end
+    def self.new(
+      # GrowSurf REST API key supplied as `Authorization: Bearer <api_key>`. Defaults to
+      # `ENV["GROWSURF_API_KEY"]`
+      api_key: ENV["GROWSURF_API_KEY"],
+      # Override the default base URL for the API, e.g.,
+      # `"https://api.example.com/v2/"`. Defaults to `ENV["GROWSURF_BASE_URL"]`
+      base_url: ENV["GROWSURF_BASE_URL"],
+      # Max number of retries to attempt after a failed retryable request.
+      max_retries: GrowsurfRuby::Client::DEFAULT_MAX_RETRIES,
+      timeout: GrowsurfRuby::Client::DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: GrowsurfRuby::Client::DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: GrowsurfRuby::Client::DEFAULT_MAX_RETRY_DELAY
+    )
+    end
+  end
+end

data/rbi/growsurf_ruby/errors.rbi

@@ -0,0 +1,205 @@
+# typed: strong
+
+module GrowsurfRuby
+  module Errors
+    class Error < StandardError
+      sig { returns(T.nilable(StandardError)) }
+      attr_accessor :cause
+    end
+
+    class ConversionError < GrowsurfRuby::Errors::Error
+      sig { returns(T.nilable(StandardError)) }
+      def cause
+      end
+
+      # @api private
+      sig do
+        params(
+          on: T::Class[StandardError],
+          method: Symbol,
+          target: T.anything,
+          value: T.anything,
+          cause: T.nilable(StandardError)
+        ).returns(T.attached_class)
+      end
+      def self.new(on:, method:, target:, value:, cause: nil)
+      end
+    end
+
+    class APIError < GrowsurfRuby::Errors::Error
+      sig { returns(URI::Generic) }
+      attr_accessor :url
+
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :status
+
+      sig { returns(T.nilable(T::Hash[String, String])) }
+      attr_accessor :headers
+
+      sig { returns(T.nilable(T.anything)) }
+      attr_accessor :body
+
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: T.nilable(Integer),
+          headers: T.nilable(T::Hash[String, String]),
+          body: T.nilable(Object),
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        url:,
+        status: nil,
+        headers: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: nil
+      )
+      end
+    end
+
+    class APIConnectionError < GrowsurfRuby::Errors::APIError
+      sig { returns(NilClass) }
+      attr_accessor :status
+
+      sig { returns(NilClass) }
+      attr_accessor :body
+
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: NilClass,
+          headers: T.nilable(T::Hash[String, String]),
+          body: NilClass,
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        url:,
+        status: nil,
+        headers: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Connection error."
+      )
+      end
+    end
+
+    class APITimeoutError < GrowsurfRuby::Errors::APIConnectionError
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: NilClass,
+          headers: T.nilable(T::Hash[String, String]),
+          body: NilClass,
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        url:,
+        status: nil,
+        headers: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Request timed out."
+      )
+      end
+    end
+
+    class APIStatusError < GrowsurfRuby::Errors::APIError
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: Integer,
+          headers: T.nilable(T::Hash[String, String]),
+          body: T.nilable(Object),
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.for(
+        url:,
+        status:,
+        headers:,
+        body:,
+        request:,
+        response:,
+        message: nil
+      )
+      end
+
+      sig { returns(Integer) }
+      attr_accessor :status
+
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: Integer,
+          headers: T.nilable(T::Hash[String, String]),
+          body: T.nilable(Object),
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        url:,
+        status:,
+        headers:,
+        body:,
+        request:,
+        response:,
+        message: nil
+      )
+      end
+    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 = T.let((500..), T::Range[Integer])
+    end
+  end
+end

data/rbi/growsurf_ruby/file_part.rbi

@@ -0,0 +1,37 @@
+# typed: strong
+
+module GrowsurfRuby
+  class FilePart
+    sig { returns(T.any(Pathname, StringIO, IO, String)) }
+    attr_reader :content
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :content_type
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :filename
+
+    # @api private
+    sig { returns(String) }
+    private def read
+    end
+
+    sig { params(a: T.anything).returns(String) }
+    def to_json(*a)
+    end
+
+    sig { params(a: T.anything).returns(String) }
+    def to_yaml(*a)
+    end
+
+    sig do
+      params(
+        content: T.any(Pathname, StringIO, IO, String),
+        filename: T.nilable(T.any(Pathname, String)),
+        content_type: T.nilable(String)
+      ).returns(T.attached_class)
+    end
+    def self.new(content, filename: nil, content_type: nil)
+    end
+  end
+end