amritk-galaxy-staging 0.2.0

data/rbi/amritk-galaxy-staging/resources/planets.rbi

@@ -0,0 +1,180 @@
+# typed: strong
+
+module DemoApiScalarGalaxy
+  module Resources
+    # Everything about planets
+    class Planets
+      # Time to play god and create a new planet. What do you think? Ah, don't think too
+      # much. What could go wrong anyway?
+      sig do
+        params(
+          id: Integer,
+          name: String,
+          type: DemoApiScalarGalaxy::Planet::Type::OrSymbol,
+          atmosphere: T::Array[DemoApiScalarGalaxy::Planet::Atmosphere::OrHash],
+          creator: DemoApiScalarGalaxy::User::OrHash,
+          description: T.nilable(String),
+          discovered_at: Time,
+          failure_callback_url: String,
+          habitability_index: Float,
+          image: T.nilable(String),
+          last_updated: Time,
+          physical_properties:
+            DemoApiScalarGalaxy::Planet::PhysicalProperties::OrHash,
+          satellites: T::Array[DemoApiScalarGalaxy::Satellite::OrHash],
+          success_callback_url: String,
+          tags: T::Array[String],
+          request_options: DemoApiScalarGalaxy::RequestOptions::OrHash
+        ).returns(DemoApiScalarGalaxy::Planet)
+      end
+      def create(
+        id:,
+        name:,
+        type:,
+        # Atmospheric composition
+        atmosphere: nil,
+        # A user
+        creator: nil,
+        description: nil,
+        discovered_at: nil,
+        # URL which gets invoked upon a failed operation
+        failure_callback_url: nil,
+        # A score from 0 to 1 indicating potential habitability
+        habitability_index: nil,
+        image: nil,
+        last_updated: nil,
+        physical_properties: nil,
+        satellites: nil,
+        # URL which gets invoked upon a successful operation
+        success_callback_url: nil,
+        tags: nil,
+        request_options: {}
+      )
+      end
+
+      # You'll better learn a little bit more about the planets. It might come in handy
+      # once space travel is available for everyone.
+      sig do
+        params(
+          planet_id: Integer,
+          request_options: DemoApiScalarGalaxy::RequestOptions::OrHash
+        ).returns(DemoApiScalarGalaxy::Planet)
+      end
+      def retrieve(
+        # The ID of the planet to get
+        planet_id,
+        request_options: {}
+      )
+      end
+
+      # Sometimes you make mistakes, that's fine. No worries, you can update all
+      # planets.
+      sig do
+        params(
+          planet_id: Integer,
+          id: Integer,
+          name: String,
+          type: DemoApiScalarGalaxy::Planet::Type::OrSymbol,
+          atmosphere: T::Array[DemoApiScalarGalaxy::Planet::Atmosphere::OrHash],
+          creator: DemoApiScalarGalaxy::User::OrHash,
+          description: T.nilable(String),
+          discovered_at: Time,
+          failure_callback_url: String,
+          habitability_index: Float,
+          image: T.nilable(String),
+          last_updated: Time,
+          physical_properties:
+            DemoApiScalarGalaxy::Planet::PhysicalProperties::OrHash,
+          satellites: T::Array[DemoApiScalarGalaxy::Satellite::OrHash],
+          success_callback_url: String,
+          tags: T::Array[String],
+          request_options: DemoApiScalarGalaxy::RequestOptions::OrHash
+        ).returns(DemoApiScalarGalaxy::Planet)
+      end
+      def update(
+        # The ID of the planet to get
+        planet_id,
+        id:,
+        name:,
+        type:,
+        # Atmospheric composition
+        atmosphere: nil,
+        # A user
+        creator: nil,
+        description: nil,
+        discovered_at: nil,
+        # URL which gets invoked upon a failed operation
+        failure_callback_url: nil,
+        # A score from 0 to 1 indicating potential habitability
+        habitability_index: nil,
+        image: nil,
+        last_updated: nil,
+        physical_properties: nil,
+        satellites: nil,
+        # URL which gets invoked upon a successful operation
+        success_callback_url: nil,
+        tags: nil,
+        request_options: {}
+      )
+      end
+
+      # It's easy to say you know them all, but do you really? Retrieve all the planets
+      # and check whether you missed one.
+      sig do
+        params(
+          limit: Integer,
+          offset: Integer,
+          request_options: DemoApiScalarGalaxy::RequestOptions::OrHash
+        ).returns(DemoApiScalarGalaxy::Models::PlanetListResponse)
+      end
+      def list(
+        # The number of items to return
+        limit: nil,
+        # The number of items to skip before starting to collect the result set
+        offset: nil,
+        request_options: {}
+      )
+      end
+
+      # This endpoint was used to delete planets. Unfortunately, that caused a lot of
+      # trouble for planets with life. So, this endpoint is now deprecated and should
+      # not be used anymore.
+      sig do
+        params(
+          planet_id: Integer,
+          request_options: DemoApiScalarGalaxy::RequestOptions::OrHash
+        ).void
+      end
+      def delete(
+        # The ID of the planet to get
+        planet_id,
+        request_options: {}
+      )
+      end
+
+      # Got a crazy good photo of a planet? Share it with the world!
+      sig do
+        params(
+          planet_id: Integer,
+          image: DemoApiScalarGalaxy::Internal::FileInput,
+          request_options: DemoApiScalarGalaxy::RequestOptions::OrHash
+        ).returns(DemoApiScalarGalaxy::Models::PlanetUploadImageResponse)
+      end
+      def upload_image(
+        # The ID of the planet to get
+        planet_id,
+        # The image file to upload
+        image: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig do
+        params(client: DemoApiScalarGalaxy::Client).returns(T.attached_class)
+      end
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/amritk-galaxy-staging/resources/webhooks.rbi

@@ -0,0 +1,31 @@
+# typed: strong
+
+module DemoApiScalarGalaxy
+  module Resources
+    class Webhooks
+      sig do
+        params(
+          payload: String,
+          headers: T::Hash[String, String],
+          key: T.nilable(String)
+        ).returns(DemoApiScalarGalaxy::NewPlanetWebhookEvent)
+      end
+      def unwrap(
+        # The raw webhook payload as a string
+        payload,
+        # The raw HTTP headers that came with the payload
+        headers:,
+        # The webhook signing key
+        key: @client.webhook_secret
+      )
+      end
+
+      # @api private
+      sig do
+        params(client: DemoApiScalarGalaxy::Client).returns(T.attached_class)
+      end
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/amritk-galaxy-staging/version.rbi

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

data/sig/amritk-galaxy-staging/client.rbs

@@ -0,0 +1,62 @@
+module DemoApiScalarGalaxy
+  class Client < DemoApiScalarGalaxy::Internal::Transport::BaseClient
+    DEFAULT_MAX_RETRIES: 2
+
+    DEFAULT_TIMEOUT_IN_SECONDS: Float
+
+    DEFAULT_INITIAL_RETRY_DELAY: Float
+
+    DEFAULT_MAX_RETRY_DELAY: Float
+
+    ENVIRONMENTS: {
+      production: "https://galaxy.scalar.com",
+      responds_with_your_request_data: "https://void.scalar.com/{path}"
+    }
+
+    attr_reader bearer_auth: String?
+
+    attr_reader basic_auth_username: String?
+
+    attr_reader basic_auth_password: String?
+
+    attr_reader api_key_header: String?
+
+    attr_reader api_key_query: String?
+
+    attr_reader api_key_cookie: String?
+
+    attr_reader o_auth2: String?
+
+    attr_reader open_id_connect: String?
+
+    attr_reader webhook_secret: String?
+
+    attr_reader planets: DemoApiScalarGalaxy::Resources::Planets
+
+    attr_reader celestial_bodies: DemoApiScalarGalaxy::Resources::CelestialBodies
+
+    attr_reader authentication: DemoApiScalarGalaxy::Resources::Authentication
+
+    attr_reader webhooks: DemoApiScalarGalaxy::Resources::Webhooks
+
+    private def auth_headers: -> ::Hash[String, String]
+
+    def initialize: (
+      ?bearer_auth: String?,
+      ?basic_auth_username: String?,
+      ?basic_auth_password: String?,
+      ?api_key_header: String?,
+      ?api_key_query: String?,
+      ?api_key_cookie: String?,
+      ?o_auth2: String?,
+      ?open_id_connect: String?,
+      ?webhook_secret: String?,
+      ?environment: :production | :responds_with_your_request_data | nil,
+      ?base_url: String?,
+      ?max_retries: Integer,
+      ?timeout: Float,
+      ?initial_retry_delay: Float,
+      ?max_retry_delay: Float
+    ) -> void
+  end
+end

data/sig/amritk-galaxy-staging/errors.rbs

@@ -0,0 +1,117 @@
+module DemoApiScalarGalaxy
+  module Errors
+    class Error < StandardError
+      attr_accessor cause: StandardError?
+    end
+
+    class ConversionError < DemoApiScalarGalaxy::Errors::Error
+      def cause: -> StandardError?
+
+      def initialize: (
+        on: Class,
+        method: Symbol,
+        target: top,
+        value: top,
+        ?cause: StandardError?
+      ) -> void
+    end
+
+    class APIError < DemoApiScalarGalaxy::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 < DemoApiScalarGalaxy::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 < DemoApiScalarGalaxy::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 < DemoApiScalarGalaxy::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 < DemoApiScalarGalaxy::Errors::APIStatusError
+      HTTP_STATUS: 400
+    end
+
+    class AuthenticationError < DemoApiScalarGalaxy::Errors::APIStatusError
+      HTTP_STATUS: 401
+    end
+
+    class PermissionDeniedError < DemoApiScalarGalaxy::Errors::APIStatusError
+      HTTP_STATUS: 403
+    end
+
+    class NotFoundError < DemoApiScalarGalaxy::Errors::APIStatusError
+      HTTP_STATUS: 404
+    end
+
+    class ConflictError < DemoApiScalarGalaxy::Errors::APIStatusError
+      HTTP_STATUS: 409
+    end
+
+    class UnprocessableEntityError < DemoApiScalarGalaxy::Errors::APIStatusError
+      HTTP_STATUS: 422
+    end
+
+    class RateLimitError < DemoApiScalarGalaxy::Errors::APIStatusError
+      HTTP_STATUS: 429
+    end
+
+    class InternalServerError < DemoApiScalarGalaxy::Errors::APIStatusError
+      HTTP_STATUS: Range[Integer]
+    end
+  end
+end

data/sig/amritk-galaxy-staging/file_part.rbs

@@ -0,0 +1,21 @@
+module DemoApiScalarGalaxy
+  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/amritk-galaxy-staging/internal/transport/base_client.rbs

@@ -0,0 +1,133 @@
+module DemoApiScalarGalaxy
+  module Internal
+    module Transport
+      class BaseClient
+        extend DemoApiScalarGalaxy::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: DemoApiScalarGalaxy::Internal::Type::Converter::input?,
+            options: DemoApiScalarGalaxy::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!: (
+          DemoApiScalarGalaxy::Internal::Transport::BaseClient::request_components req
+        ) -> void
+
+        def self.should_retry?: (
+          Integer status,
+          headers: ::Hash[String, String]
+        ) -> bool
+
+        def self.follow_redirect: (
+          DemoApiScalarGalaxy::Internal::Transport::BaseClient::request_input request,
+          status: Integer,
+          response_headers: ::Hash[String, String]
+        ) -> DemoApiScalarGalaxy::Internal::Transport::BaseClient::request_input
+
+        def self.reap_connection!: (
+          Integer | DemoApiScalarGalaxy::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: DemoApiScalarGalaxy::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: (
+          DemoApiScalarGalaxy::Internal::Transport::BaseClient::request_components req,
+          DemoApiScalarGalaxy::request_options opts
+        ) -> DemoApiScalarGalaxy::Internal::Transport::BaseClient::request_input
+
+        private def retry_delay: (
+          ::Hash[String, String] headers,
+          retry_count: Integer
+        ) -> Float
+
+        def send_request: (
+          DemoApiScalarGalaxy::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: DemoApiScalarGalaxy::Internal::Type::Converter::input?,
+          ?options: DemoApiScalarGalaxy::request_opts?
+        ) -> top
+
+        def inspect: -> String
+      end
+    end
+  end
+end

data/sig/amritk-galaxy-staging/internal/transport/pooled_net_requester.rbs

@@ -0,0 +1,48 @@
+module DemoApiScalarGalaxy
+  module Internal
+    module Transport
+      class PooledNetRequester
+        extend DemoApiScalarGalaxy::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: (
+          DemoApiScalarGalaxy::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: (
+          DemoApiScalarGalaxy::Internal::Transport::PooledNetRequester::request request
+        ) -> [Integer, top, Enumerable[String]]
+
+        def initialize: (?size: Integer) -> void
+      end
+    end
+  end
+end

data/sig/amritk-galaxy-staging/internal/type/array_of.rbs

@@ -0,0 +1,48 @@
+module DemoApiScalarGalaxy
+  module Internal
+    module Type
+      class ArrayOf[Elem]
+        include DemoApiScalarGalaxy::Internal::Type::Converter
+        include DemoApiScalarGalaxy::Internal::Util::SorbetRuntimeSupport
+
+        def self.[]: (
+          ::Hash[Symbol, top]
+          | ^-> DemoApiScalarGalaxy::Internal::Type::Converter::input
+          | DemoApiScalarGalaxy::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: DemoApiScalarGalaxy::Internal::Type::Converter::coerce_state
+        ) -> (::Array[top] | top)
+
+        def dump: (
+          ::Array[top] | top value,
+          state: DemoApiScalarGalaxy::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]
+          | ^-> DemoApiScalarGalaxy::Internal::Type::Converter::input
+          | DemoApiScalarGalaxy::Internal::Type::Converter::input type_info,
+          ?::Hash[Symbol, top] spec
+        ) -> void
+
+        def inspect: (?depth: Integer) -> String
+      end
+    end
+  end
+end