moonbase-sdk 0.1.0.pre.alpha.3 → 0.1.0.pre.alpha.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 004417c139bdd9c6ec043a9dde658dc67e6f098a32bb3bbef956982695798109
-  data.tar.gz: 3189fbe40f05177f5f49eddb00826aae96cba29df3c0bad285d5744c19f15b07
+  metadata.gz: 7d9abd330fe8d3d9959ca6dec77410f82534e129d027cd7cc82e334b132df582
+  data.tar.gz: d0c68d2fbb0d6b9bf37b369309e1bfe079989497fd4d6d540aa82d09fb8b49b7
 SHA512:
-  metadata.gz: aac86c8dc30cefd306f10561ba41657159d832fc5fc787e3cf8b6b7f9e0f98bef0e579d4bee4078c679750efcd3e1aa8a8fa3bd7b8e106c84267a1dd0cafd270
-  data.tar.gz: 2aff665206729f4260afbef357dab139d53f227b702ea43a19db4cd990d3ff75651873dd3ac28ef1f175d29727c7171f7f900827aa6b9317a10be17e2964a557
+  metadata.gz: 385f835ee07b14c3665cff1efa60ecec5d72b617f995f2882cbe69a9558c8b5a0877f94dfdd7602d989992329dddc48071f0066194f33dde1dfe6e24118a3ccc
+  data.tar.gz: 1ecace055b4932aa758e93c198332e74ef858ea0ff15460c8a2f5f1ec69869c2e10828254cbcfc33cf62ac32ac462f520096178983d10cc8944684815fc62fd4

data/CHANGELOG.md

@@ -1,5 +1,59 @@
 # Changelog
 
+## 0.1.0-alpha.5 (2025-11-13)
+
+Full Changelog: [v0.1.0-alpha.4...v0.1.0-alpha.5](https://github.com/moonbaseai/moonbase-sdk-ruby/compare/v0.1.0-alpha.4...v0.1.0-alpha.5)
+
+### Features
+
+* Add PATCH /v0/meetings/{id} ([2cb2339](https://github.com/moonbaseai/moonbase-sdk-ruby/commit/2cb23391e356cd92aae56c0c1509f73018260482))
+* **api:** manual updates ([fa67751](https://github.com/moonbaseai/moonbase-sdk-ruby/commit/fa67751e7ec83a1f1ce33c47e8c94b5ab3ae31d6))
+* **api:** update api ([e3c9ad0](https://github.com/moonbaseai/moonbase-sdk-ruby/commit/e3c9ad0433de6cddd5f4a903d1593fac88efd9c9))
+* expose response headers for both streams and errors ([39b34b0](https://github.com/moonbaseai/moonbase-sdk-ruby/commit/39b34b0c68a778fd30d6349e577c8f64b1ff647d))
+* handle thread interrupts in the core HTTP client ([ecedb52](https://github.com/moonbaseai/moonbase-sdk-ruby/commit/ecedb5205ba87a29e5d650ca6d1600348c813c17))
+
+
+### Bug Fixes
+
+* absolutely qualified uris should always override the default ([4f9d377](https://github.com/moonbaseai/moonbase-sdk-ruby/commit/4f9d3776eec58bf9d57dd060bbd69b28c4b11acf))
+* always send `filename=...` for multipart requests where a file is expected ([67a4aca](https://github.com/moonbaseai/moonbase-sdk-ruby/commit/67a4aca74fb0f190800c6a514a2778453ff35c33))
+* better thread safety via early initializing SSL store during HTTP client creation ([bd6d5d3](https://github.com/moonbaseai/moonbase-sdk-ruby/commit/bd6d5d3ee42ef1218cebc1de4a20a7bec6df604c))
+* coroutine leaks from connection pool ([ca7118b](https://github.com/moonbaseai/moonbase-sdk-ruby/commit/ca7118b2108de43ef1fd07759a99cc4712777444))
+* shorten multipart boundary sep to less than RFC specificed max length ([1325f54](https://github.com/moonbaseai/moonbase-sdk-ruby/commit/1325f5410253d8f6bb41ef20552d95b452021185))
+* should not reuse buffers for `IO.copy_stream` interop ([2a7f948](https://github.com/moonbaseai/moonbase-sdk-ruby/commit/2a7f9482c054c3c7cc1a5ee89fcc10334db8f4fa))
+
+
+### Performance Improvements
+
+* faster code formatting ([84f021f](https://github.com/moonbaseai/moonbase-sdk-ruby/commit/84f021fc5251a01d8b836bcaa09de27ee8898f29))
+
+
+### Chores
+
+* allow fast-format to use bsd sed as well ([80db719](https://github.com/moonbaseai/moonbase-sdk-ruby/commit/80db719c03aad42092719fdedca8b54a1cae95cc))
+* bump dependency version and update sorbet types ([22aaba5](https://github.com/moonbaseai/moonbase-sdk-ruby/commit/22aaba59955a621fb070d977b654212cb1f0d45e))
+* do not install brew dependencies in ./scripts/bootstrap by default ([91df728](https://github.com/moonbaseai/moonbase-sdk-ruby/commit/91df728ae9d09148f185043a8193bc7235bf4884))
+* ignore linter error for tests having large collections ([c0059a2](https://github.com/moonbaseai/moonbase-sdk-ruby/commit/c0059a249133f0c39f08ba3a3418cfb8117e3890))
+* **internal:** codegen related update ([dc876ed](https://github.com/moonbaseai/moonbase-sdk-ruby/commit/dc876ed1ccfb8994dc415b23fa4b1bf3bfe6a2b0))
+
+## 0.1.0-alpha.4 (2025-09-12)
+
+Full Changelog: [v0.1.0-alpha.3...v0.1.0-alpha.4](https://github.com/moonbaseai/moonbase-sdk-ruby/compare/v0.1.0-alpha.3...v0.1.0-alpha.4)
+
+### Features
+
+* Improve examples of API errors ([840de2a](https://github.com/moonbaseai/moonbase-sdk-ruby/commit/840de2a8ea5438cc3f50f31fc13caba3469926a7))
+
+
+### Documentation
+
+* improve webhook endpoints examples ([c7851fe](https://github.com/moonbaseai/moonbase-sdk-ruby/commit/c7851fe6f336b8892ae016fdc8ac97175a71124f))
+
+
+### Refactors
+
+* rename ChoiceFieldOption label to name for consistency ([0a9ef9a](https://github.com/moonbaseai/moonbase-sdk-ruby/commit/0a9ef9a75fb619b856d70c68ccb147ef5909b32a))
+
 ## 0.1.0-alpha.3 (2025-09-09)
 
 Full Changelog: [v0.1.0-alpha.2...v0.1.0-alpha.3](https://github.com/moonbaseai/moonbase-sdk-ruby/compare/v0.1.0-alpha.2...v0.1.0-alpha.3)

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "moonbase-sdk", "~> 0.1.0.pre.alpha.3"
+gem "moonbase-sdk", "~> 0.1.0.pre.alpha.5"
 ```
 
 <!-- x-release-please-end -->
@@ -63,6 +63,28 @@ if page.next_page?
 end
 ```
 
+### File uploads
+
+Request parameters that correspond to file uploads can be passed as raw contents, a [`Pathname`](https://rubyapi.org/3.2/o/pathname) instance, [`StringIO`](https://rubyapi.org/3.2/o/stringio), or more.
+
+```ruby
+require "pathname"
+
+# Use `Pathname` to send the filename and/or avoid paging a large file into memory:
+moonbase_file = moonbase.files.upload(file: Pathname("/path/to/file"))
+
+# Alternatively, pass file contents or a `StringIO` directly:
+moonbase_file = moonbase.files.upload(file: File.read("/path/to/file"))
+
+# Or, to control the filename and/or content type:
+file = Moonbase::FilePart.new(File.read("/path/to/file"), filename: "/path/to/file", content_type: "…")
+moonbase_file = moonbase.files.upload(file: file)
+
+puts(moonbase_file.id)
+```
+
+Note that you can also pass a raw `IO` descriptor, but this disables retries, as the library can't be sure if the descriptor is a file or pipe (which cannot be rewound).
+
 ### Handling errors
 
 When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `Moonbase::Errors::APIError` will be thrown:

data/lib/moonbase/errors.rb

@@ -40,6 +40,9 @@ module Moonbase
       # @return [Integer, nil]
       attr_accessor :status
 
+      # @return [Hash{String=>String}, nil]
+      attr_accessor :headers
+
       # @return [Object, nil]
       attr_accessor :body
 
@@ -47,13 +50,15 @@ module Moonbase
       #
       # @param url [URI::Generic]
       # @param status [Integer, nil]
+      # @param headers [Hash{String=>String}, nil]
       # @param body [Object, nil]
       # @param request [nil]
       # @param response [nil]
       # @param message [String, nil]
-      def initialize(url:, status: nil, body: nil, request: nil, response: nil, message: nil)
+      def initialize(url:, status: nil, headers: nil, body: nil, request: nil, response: nil, message: nil)
         @url = url
         @status = status
+        @headers = headers
         @body = body
         @request = request
         @response = response
@@ -74,6 +79,7 @@ module Moonbase
       #
       # @param url [URI::Generic]
       # @param status [nil]
+      # @param headers [Hash{String=>String}, nil]
       # @param body [nil]
       # @param request [nil]
       # @param response [nil]
@@ -81,6 +87,7 @@ module Moonbase
       def initialize(
         url:,
         status: nil,
+        headers: nil,
         body: nil,
         request: nil,
         response: nil,
@@ -95,6 +102,7 @@ module Moonbase
       #
       # @param url [URI::Generic]
       # @param status [nil]
+      # @param headers [Hash{String=>String}, nil]
       # @param body [nil]
       # @param request [nil]
       # @param response [nil]
@@ -102,6 +110,7 @@ module Moonbase
       def initialize(
         url:,
         status: nil,
+        headers: nil,
         body: nil,
         request: nil,
         response: nil,
@@ -116,21 +125,24 @@ module Moonbase
       #
       # @param url [URI::Generic]
       # @param status [Integer]
+      # @param headers [Hash{String=>String}, nil]
       # @param body [Object, nil]
       # @param request [nil]
       # @param response [nil]
       # @param message [String, nil]
       #
       # @return [self]
-      def self.for(url:, status:, body:, request:, response:, message: nil)
-        kwargs = {
-          url: url,
-          status: status,
-          body: body,
-          request: request,
-          response: response,
-          message: message
-        }
+      def self.for(url:, status:, headers:, body:, request:, response:, message: nil)
+        kwargs =
+          {
+            url: url,
+            status: status,
+            headers: headers,
+            body: body,
+            request: request,
+            response: response,
+            message: message
+          }
 
         case status
         in 400
@@ -162,15 +174,17 @@ module Moonbase
       #
       # @param url [URI::Generic]
       # @param status [Integer]
+      # @param headers [Hash{String=>String}, nil]
       # @param body [Object, nil]
       # @param request [nil]
       # @param response [nil]
       # @param message [String, nil]
-      def initialize(url:, status:, body:, request:, response:, message: nil)
+      def initialize(url:, status:, headers:, body:, request:, response:, message: nil)
         message ||= {url: url.to_s, status: status, body: body}
         super(
           url: url,
           status: status,
+          headers: headers,
           body: body,
           request: request,
           response: response,

data/lib/moonbase/file_part.rb

@@ -38,18 +38,21 @@ module Moonbase
     def to_yaml(*a) = read.to_yaml(*a)
 
     # @param content [Pathname, StringIO, IO, String]
-    # @param filename [String, nil]
+    # @param filename [Pathname, String, nil]
     # @param content_type [String, nil]
     def initialize(content, filename: nil, content_type: nil)
-      @content = content
+      @content_type = content_type
       @filename =
-        case content
-        in Pathname
-          filename.nil? ? content.basename.to_path : ::File.basename(filename)
+        case [filename, (@content = content)]
+        in [String | Pathname, _]
+          ::File.basename(filename)
+        in [nil, Pathname]
+          content.basename.to_path
+        in [nil, IO]
+          content.to_path
         else
-          filename.nil? ? nil : ::File.basename(filename)
+          filename
         end
-      @content_type = content_type
     end
   end
 end

data/lib/moonbase/internal/cursor_page.rb

@@ -60,7 +60,7 @@ module Moonbase
       #
       # @param client [Moonbase::Internal::Transport::BaseClient]
       # @param req [Hash{Symbol=>Object}]
-      # @param headers [Hash{String=>String}, Net::HTTPHeader]
+      # @param headers [Hash{String=>String}]
       # @param page_data [Hash{Symbol=>Object}]
       def initialize(client:, req:, headers:, page_data:)
         super

data/lib/moonbase/internal/transport/base_client.rb

@@ -47,7 +47,7 @@ module Moonbase
           # @api private
           #
           # @param status [Integer]
-          # @param headers [Hash{String=>String}, Net::HTTPHeader]
+          # @param headers [Hash{String=>String}]
           #
           # @return [Boolean]
           def should_retry?(status, headers:)
@@ -85,7 +85,7 @@ module Moonbase
           #
           # @param status [Integer]
           #
-          # @param response_headers [Hash{String=>String}, Net::HTTPHeader]
+          # @param response_headers [Hash{String=>String}]
           #
           # @return [Hash{Symbol=>Object}]
           def follow_redirect(request, status:, response_headers:)
@@ -201,7 +201,8 @@ module Moonbase
             self.class::PLATFORM_HEADERS,
             {
               "accept" => "application/json",
-              "content-type" => "application/json"
+              "content-type" => "application/json",
+              "user-agent" => user_agent
             },
             headers
           )
@@ -219,6 +220,11 @@ module Moonbase
         # @return [Hash{String=>String}]
         private def auth_headers = {}
 
+        # @api private
+        #
+        # @return [String]
+        private def user_agent = "#{self.class.name}/Ruby #{Moonbase::VERSION}"
+
         # @api private
         #
         # @return [String]
@@ -378,6 +384,7 @@ module Moonbase
           rescue Moonbase::Errors::APIConnectionError => e
             status = e
           end
+          headers = Moonbase::Internal::Util.normalized_headers(response&.each_header&.to_h)
 
           case status
           in ..299
@@ -390,7 +397,7 @@ module Moonbase
           in 300..399
             self.class.reap_connection!(status, stream: stream)
 
-            request = self.class.follow_redirect(request, status: status, response_headers: response)
+            request = self.class.follow_redirect(request, status: status, response_headers: headers)
             send_request(
               request,
               redirect_count: redirect_count + 1,
@@ -399,9 +406,9 @@ module Moonbase
             )
           in Moonbase::Errors::APIConnectionError if retry_count >= max_retries
             raise status
-          in (400..) if retry_count >= max_retries || !self.class.should_retry?(status, headers: response)
+          in (400..) if retry_count >= max_retries || !self.class.should_retry?(status, headers: headers)
             decoded = Kernel.then do
-              Moonbase::Internal::Util.decode_content(response, stream: stream, suppress_error: true)
+              Moonbase::Internal::Util.decode_content(headers, stream: stream, suppress_error: true)
             ensure
               self.class.reap_connection!(status, stream: stream)
             end
@@ -409,6 +416,7 @@ module Moonbase
             raise Moonbase::Errors::APIStatusError.for(
               url: url,
               status: status,
+              headers: headers,
               body: decoded,
               request: nil,
               response: response
@@ -485,19 +493,21 @@ module Moonbase
             send_retry_header: send_retry_header
           )
 
-          decoded = Moonbase::Internal::Util.decode_content(response, stream: stream)
+          headers = Moonbase::Internal::Util.normalized_headers(response.each_header.to_h)
+          decoded = Moonbase::Internal::Util.decode_content(headers, stream: stream)
           case req
           in {stream: Class => st}
             st.new(
               model: model,
               url: url,
               status: status,
+              headers: headers,
               response: response,
               unwrap: unwrap,
               stream: decoded
             )
           in {page: Class => page}
-            page.new(client: self, req: req, headers: response, page_data: decoded)
+            page.new(client: self, req: req, headers: headers, page_data: decoded)
           else
             unwrapped = Moonbase::Internal::Util.dig(decoded, unwrap)
             Moonbase::Internal::Type::Converter.coerce(model, unwrapped)

data/lib/moonbase/internal/transport/pooled_net_requester.rb

@@ -16,10 +16,11 @@ module Moonbase
         class << self
           # @api private
           #
+          # @param cert_store [OpenSSL::X509::Store]
           # @param url [URI::Generic]
           #
           # @return [Net::HTTP]
-          def connect(url)
+          def connect(cert_store:, url:)
             port =
               case [url.port, url.scheme]
               in [Integer, _]
@@ -33,6 +34,8 @@ module Moonbase
             Net::HTTP.new(url.host, port).tap do
               _1.use_ssl = %w[https wss].include?(url.scheme)
               _1.max_retries = 0
+
+              (_1.cert_store = cert_store) if _1.use_ssl?
             end
           end
 
@@ -102,7 +105,7 @@ module Moonbase
           pool =
             @mutex.synchronize do
               @pools[origin] ||= ConnectionPool.new(size: @size) do
-                self.class.connect(url)
+                self.class.connect(cert_store: @cert_store, url: url)
               end
             end
 
@@ -128,37 +131,47 @@ module Moonbase
           url, deadline = request.fetch_values(:url, :deadline)
 
           req = nil
-          eof = false
           finished = false
-          closing = nil
 
           # rubocop:disable Metrics/BlockLength
           enum = Enumerator.new do |y|
-            with_pool(url, deadline: deadline) do |conn|
-              next if finished
-
-              req, closing = self.class.build_request(request) do
-                self.class.calibrate_socket_timeout(conn, deadline)
-              end
-
-              self.class.calibrate_socket_timeout(conn, deadline)
-              unless conn.started?
-                conn.keep_alive_timeout = self.class::KEEP_ALIVE_TIMEOUT
-                conn.start
-              end
+            next if finished
 
-              self.class.calibrate_socket_timeout(conn, deadline)
-              conn.request(req) do |rsp|
-                y << [conn, req, rsp]
-                break if finished
+            with_pool(url, deadline: deadline) do |conn|
+              eof = false
+              closing = nil
+              ::Thread.handle_interrupt(Object => :never) do
+                ::Thread.handle_interrupt(Object => :immediate) do
+                  req, closing = self.class.build_request(request) do
+                    self.class.calibrate_socket_timeout(conn, deadline)
+                  end
 
-                rsp.read_body do |bytes|
-                  y << bytes.force_encoding(Encoding::BINARY)
-                  break if finished
+                  self.class.calibrate_socket_timeout(conn, deadline)
+                  unless conn.started?
+                    conn.keep_alive_timeout = self.class::KEEP_ALIVE_TIMEOUT
+                    conn.start
+                  end
 
                   self.class.calibrate_socket_timeout(conn, deadline)
+                  conn.request(req) do |rsp|
+                    y << [req, rsp]
+                    break if finished
+
+                    rsp.read_body do |bytes|
+                      y << bytes.force_encoding(Encoding::BINARY)
+                      break if finished
+
+                      self.class.calibrate_socket_timeout(conn, deadline)
+                    end
+                    eof = true
+                  end
+                end
+              ensure
+                begin
+                  conn.finish if !eof && conn&.started?
+                ensure
+                  closing&.call
                 end
-                eof = true
               end
             end
           rescue Timeout::Error
@@ -168,17 +181,10 @@ module Moonbase
           end
           # rubocop:enable Metrics/BlockLength
 
-          conn, _, response = enum.next
+          _, response = enum.next
           body = Moonbase::Internal::Util.fused_enum(enum, external: true) do
             finished = true
-            tap do
-              enum.next
-            rescue StopIteration
-              nil
-            end
-          ensure
-            conn.finish if !eof && conn&.started?
-            closing&.call
+            loop { enum.next }
           end
           [Integer(response.code), response, body]
         end
@@ -189,6 +195,7 @@ module Moonbase
         def initialize(size: self.class::DEFAULT_MAX_CONNECTIONS)
           @mutex = Mutex.new
           @size = size
+          @cert_store = OpenSSL::X509::Store.new.tap(&:set_default_paths)
           @pools = {}
         end
 

data/lib/moonbase/internal/type/base_page.rb

@@ -39,7 +39,7 @@ module Moonbase
         #
         # @param client [Moonbase::Internal::Transport::BaseClient]
         # @param req [Hash{Symbol=>Object}]
-        # @param headers [Hash{String=>String}, Net::HTTPHeader]
+        # @param headers [Hash{String=>String}]
         # @param page_data [Object]
         def initialize(client:, req:, headers:, page_data:)
           @client = client

data/lib/moonbase/internal/type/file_input.rb

@@ -82,17 +82,20 @@ module Moonbase
           #
           # @return [Pathname, StringIO, IO, String, Object]
           def dump(value, state:)
-            # rubocop:disable Lint/DuplicateBranch
             case value
+            in StringIO | String
+              # https://datatracker.ietf.org/doc/html/rfc7578#section-4.2
+              # while not required, a filename is recommended, and in practice many servers do expect this
+              Moonbase::FilePart.new(value, filename: "upload")
             in IO
               state[:can_retry] = false
+              value.to_path.nil? ? Moonbase::FilePart.new(value, filename: "upload") : value
             in Moonbase::FilePart if value.content.is_a?(IO)
               state[:can_retry] = false
+              value
             else
+              value
             end
-            # rubocop:enable Lint/DuplicateBranch
-
-            value
           end
 
           # @api private

data/lib/moonbase/internal/util.rb

@@ -346,8 +346,9 @@ module Moonbase
           base_path, base_query = lhs.fetch_values(:path, :query)
           slashed = base_path.end_with?("/") ? base_path : "#{base_path}/"
 
-          parsed_path, parsed_query = parse_uri(rhs.fetch(:path)).fetch_values(:path, :query)
-          override = URI::Generic.build(**rhs.slice(:scheme, :host, :port), path: parsed_path)
+          merged = {**parse_uri(rhs.fetch(:path)), **rhs.except(:path, :query)}
+          parsed_path, parsed_query = merged.fetch_values(:path, :query)
+          override = URI::Generic.build(**merged.slice(:scheme, :host, :port), path: parsed_path)
 
           joined = URI.join(URI::Generic.build(lhs.except(:path, :query)), slashed, override)
           query = deep_merge(
@@ -473,10 +474,9 @@ module Moonbase
         # @return [Enumerable<String>]
         def writable_enum(&blk)
           Enumerator.new do |y|
-            buf = String.new
             y.define_singleton_method(:write) do
-              self << buf.replace(_1)
-              buf.bytesize
+              self << _1.dup
+              _1.bytesize
             end
 
             blk.call(y)
@@ -566,7 +566,8 @@ module Moonbase
         #
         # @return [Array(String, Enumerable<String>)]
         private def encode_multipart_streaming(body)
-          boundary = SecureRandom.urlsafe_base64(60)
+          # RFC 1521 Section 7.2.1 says we should have 70 char maximum for boundary length
+          boundary = SecureRandom.urlsafe_base64(46)
 
           closing = []
           strio = writable_enum do |y|
@@ -647,7 +648,7 @@ module Moonbase
         #
         # Assumes each chunk in stream has `Encoding::BINARY`.
         #
-        # @param headers [Hash{String=>String}, Net::HTTPHeader]
+        # @param headers [Hash{String=>String}]
         # @param stream [Enumerable<String>]
         # @param suppress_error [Boolean]
         #

data/lib/moonbase/models/choice_field_option.rb

@@ -9,11 +9,11 @@ module Moonbase
       #   @return [String]
       required :id, String
 
-      # @!attribute label
+      # @!attribute name
       #   The human-readable text displayed for this option.
       #
       #   @return [String]
-      required :label, String
+      required :name, String
 
       # @!attribute type
       #   String representing the object’s type. Always `choice_field_option` for this
@@ -22,7 +22,7 @@ module Moonbase
       #   @return [Symbol, :choice_field_option]
       required :type, const: :choice_field_option
 
-      # @!method initialize(id:, label:, type: :choice_field_option)
+      # @!method initialize(id:, name:, type: :choice_field_option)
       #   Some parameter documentations has been truncated, see
       #   {Moonbase::Models::ChoiceFieldOption} for more details.
       #
@@ -30,7 +30,7 @@ module Moonbase
       #
       #   @param id [String] Unique identifier for the option.
       #
-      #   @param label [String] The human-readable text displayed for this option.
+      #   @param name [String] The human-readable text displayed for this option.
       #
       #   @param type [Symbol, :choice_field_option] String representing the object’s type. Always `choice_field_option` for this obj
     end

data/lib/moonbase/models/file_upload_params.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Moonbase
+  module Models
+    # @see Moonbase::Resources::Files#upload
+    class FileUploadParams < Moonbase::Internal::Type::BaseModel
+      extend Moonbase::Internal::Type::RequestParameters::Converter
+      include Moonbase::Internal::Type::RequestParameters
+
+      # @!attribute file
+      #   The File object to be uploaded.
+      #
+      #   @return [Pathname, StringIO, IO, String, Moonbase::FilePart]
+      required :file, Moonbase::Internal::Type::FileInput
+
+      # @!attribute associations
+      #   Link the File to Moonbase items like a person, organization, deal, task, or an
+      #   item in a custom collection.
+      #
+      #   @return [Array<Moonbase::Models::Pointer>, nil]
+      optional :associations, -> { Moonbase::Internal::Type::ArrayOf[Moonbase::Pointer] }
+
+      # @!attribute name
+      #   The display name of the file.
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!method initialize(file:, associations: nil, name: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Moonbase::Models::FileUploadParams} for more details.
+      #
+      #   @param file [Pathname, StringIO, IO, String, Moonbase::FilePart] The File object to be uploaded.
+      #
+      #   @param associations [Array<Moonbase::Models::Pointer>] Link the File to Moonbase items like a person, organization, deal, task, or an i
+      #
+      #   @param name [String] The display name of the file.
+      #
+      #   @param request_options [Moonbase::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end