ittybit 0.8.14 → 1.0.0

data/lib/ittybit/media/client.rb

@@ -2,8 +2,11 @@
 
 require_relative "../../requests"
 require_relative "../types/media_list_response"
-require_relative "../types/media_response"
-require_relative "../types/confirmation_response"
+require "json"
+require_relative "types/media_create_response"
+require_relative "types/media_get_response"
+require_relative "types/media_delete_response"
+require_relative "types/media_update_response"
 require "async"
 
 module Ittybit
@@ -22,7 +25,7 @@ module Ittybit
     # @param page [Integer]
     # @param limit [Integer]
     # @param request_options [Ittybit::RequestOptions]
-    # @return [Ittybit::MediaListResponse]
+    # @return [Ittybit::MEDIA_LIST_RESPONSE]
     # @example
     #  api = Ittybit::Client.new(
     #    base_url: "https://api.example.com",
@@ -36,9 +39,10 @@ module Ittybit
         req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
         req.headers["ACCEPT_VERSION"] = request_options.version unless request_options&.version.nil?
         req.headers = {
-      **(req.headers || {}),
-      **@request_client.get_headers,
-      **(request_options&.additional_headers || {})
+          **(req.headers || {}),
+          **@request_client.get_headers,
+          **(request_options&.additional_headers || {}),
+          "Accept-Version": "2025-08-20"
         }.compact
         req.params = { **(request_options&.additional_query_parameters || {}), "page": page, "limit": limit }.compact
         unless request_options.nil? || request_options&.additional_body_parameters.nil?
@@ -46,7 +50,11 @@ module Ittybit
         end
         req.url "#{@request_client.get_url(request_options: request_options)}/media"
       end
-      Ittybit::MediaListResponse.from_json(json_object: response.body)
+      parsed_json = JSON.parse(response.body)
+      parsed_json&.map do |item|
+        item = item.to_json
+        Ittybit::MediaListResponseItem.from_json(json_object: item)
+      end
     end
 
     # Creates a new media item. See [Media Object](/docs/media) for more details.
@@ -55,7 +63,7 @@ module Ittybit
     # @param alt [String]
     # @param metadata [Hash{String => Object}]
     # @param request_options [Ittybit::RequestOptions]
-    # @return [Ittybit::MediaResponse]
+    # @return [Ittybit::Media::MediaCreateResponse]
     # @example
     #  api = Ittybit::Client.new(
     #    base_url: "https://api.example.com",
@@ -65,7 +73,7 @@ module Ittybit
     #  api.media.create(
     #    title: "My Video Example",
     #    alt: "An example video used to demonstrate the ittybit API",
-    #    metadata: { "customKey2": "a different custom value" }
+    #    metadata: { "customKey": "your custom value" }
     #  )
     def create(title: nil, alt: nil, metadata: nil, request_options: nil)
       response = @request_client.conn.post do |req|
@@ -73,9 +81,10 @@ module Ittybit
         req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
         req.headers["ACCEPT_VERSION"] = request_options.version unless request_options&.version.nil?
         req.headers = {
-      **(req.headers || {}),
-      **@request_client.get_headers,
-      **(request_options&.additional_headers || {})
+          **(req.headers || {}),
+          **@request_client.get_headers,
+          **(request_options&.additional_headers || {}),
+          "Accept-Version": "2025-08-20"
         }.compact
         unless request_options.nil? || request_options&.additional_query_parameters.nil?
           req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -88,14 +97,14 @@ module Ittybit
         }.compact
         req.url "#{@request_client.get_url(request_options: request_options)}/media"
       end
-      Ittybit::MediaResponse.from_json(json_object: response.body)
+      Ittybit::Media::MediaCreateResponse.from_json(json_object: response.body)
     end
 
     # Retrieves the media object for a media with the given ID.
     #
     # @param id [String]
     # @param request_options [Ittybit::RequestOptions]
-    # @return [Ittybit::MediaResponse]
+    # @return [Ittybit::Media::MediaGetResponse]
     # @example
     #  api = Ittybit::Client.new(
     #    base_url: "https://api.example.com",
@@ -109,9 +118,10 @@ module Ittybit
         req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
         req.headers["ACCEPT_VERSION"] = request_options.version unless request_options&.version.nil?
         req.headers = {
-      **(req.headers || {}),
-      **@request_client.get_headers,
-      **(request_options&.additional_headers || {})
+          **(req.headers || {}),
+          **@request_client.get_headers,
+          **(request_options&.additional_headers || {}),
+          "Accept-Version": "2025-08-20"
         }.compact
         unless request_options.nil? || request_options&.additional_query_parameters.nil?
           req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -121,7 +131,7 @@ module Ittybit
         end
         req.url "#{@request_client.get_url(request_options: request_options)}/media/#{id}"
       end
-      Ittybit::MediaResponse.from_json(json_object: response.body)
+      Ittybit::Media::MediaGetResponse.from_json(json_object: response.body)
     end
 
     # Permanently removes a media object from the system. This action cannot be
@@ -129,7 +139,7 @@ module Ittybit
     #
     # @param id [String]
     # @param request_options [Ittybit::RequestOptions]
-    # @return [Ittybit::ConfirmationResponse]
+    # @return [Ittybit::Media::MediaDeleteResponse]
     # @example
     #  api = Ittybit::Client.new(
     #    base_url: "https://api.example.com",
@@ -143,9 +153,10 @@ module Ittybit
         req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
         req.headers["ACCEPT_VERSION"] = request_options.version unless request_options&.version.nil?
         req.headers = {
-      **(req.headers || {}),
-      **@request_client.get_headers,
-      **(request_options&.additional_headers || {})
+          **(req.headers || {}),
+          **@request_client.get_headers,
+          **(request_options&.additional_headers || {}),
+          "Accept-Version": "2025-08-20"
         }.compact
         unless request_options.nil? || request_options&.additional_query_parameters.nil?
           req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -155,7 +166,7 @@ module Ittybit
         end
         req.url "#{@request_client.get_url(request_options: request_options)}/media/#{id}"
       end
-      Ittybit::ConfirmationResponse.from_json(json_object: response.body)
+      Ittybit::Media::MediaDeleteResponse.from_json(json_object: response.body)
     end
 
     # Updates a media object's `title`, `alt`, or `metadata`. Only the specified
@@ -166,7 +177,7 @@ module Ittybit
     # @param alt [String]
     # @param metadata [Hash{String => Object}]
     # @param request_options [Ittybit::RequestOptions]
-    # @return [Ittybit::MediaResponse]
+    # @return [Ittybit::Media::MediaUpdateResponse]
     # @example
     #  api = Ittybit::Client.new(
     #    base_url: "https://api.example.com",
@@ -177,7 +188,7 @@ module Ittybit
     #    id: "med_abcdefgh1234",
     #    title: "Updated Video Example",
     #    alt: "An updated example video used to demonstrate the ittybit API",
-    #    metadata: { "customKey2": "a different custom value" }
+    #    metadata: { "customKey": "a different custom value" }
     #  )
     def update(id:, title: nil, alt: nil, metadata: nil, request_options: nil)
       response = @request_client.conn.patch do |req|
@@ -185,9 +196,10 @@ module Ittybit
         req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
         req.headers["ACCEPT_VERSION"] = request_options.version unless request_options&.version.nil?
         req.headers = {
-      **(req.headers || {}),
-      **@request_client.get_headers,
-      **(request_options&.additional_headers || {})
+          **(req.headers || {}),
+          **@request_client.get_headers,
+          **(request_options&.additional_headers || {}),
+          "Accept-Version": "2025-08-20"
         }.compact
         unless request_options.nil? || request_options&.additional_query_parameters.nil?
           req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -200,7 +212,7 @@ module Ittybit
         }.compact
         req.url "#{@request_client.get_url(request_options: request_options)}/media/#{id}"
       end
-      Ittybit::MediaResponse.from_json(json_object: response.body)
+      Ittybit::Media::MediaUpdateResponse.from_json(json_object: response.body)
     end
   end
 
@@ -219,7 +231,7 @@ module Ittybit
     # @param page [Integer]
     # @param limit [Integer]
     # @param request_options [Ittybit::RequestOptions]
-    # @return [Ittybit::MediaListResponse]
+    # @return [Ittybit::MEDIA_LIST_RESPONSE]
     # @example
     #  api = Ittybit::Client.new(
     #    base_url: "https://api.example.com",
@@ -234,9 +246,10 @@ module Ittybit
           req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
           req.headers["ACCEPT_VERSION"] = request_options.version unless request_options&.version.nil?
           req.headers = {
-        **(req.headers || {}),
-        **@request_client.get_headers,
-        **(request_options&.additional_headers || {})
+            **(req.headers || {}),
+            **@request_client.get_headers,
+            **(request_options&.additional_headers || {}),
+            "Accept-Version": "2025-08-20"
           }.compact
           req.params = { **(request_options&.additional_query_parameters || {}), "page": page, "limit": limit }.compact
           unless request_options.nil? || request_options&.additional_body_parameters.nil?
@@ -244,7 +257,11 @@ module Ittybit
           end
           req.url "#{@request_client.get_url(request_options: request_options)}/media"
         end
-        Ittybit::MediaListResponse.from_json(json_object: response.body)
+        parsed_json = JSON.parse(response.body)
+        parsed_json&.map do |item|
+          item = item.to_json
+          Ittybit::MediaListResponseItem.from_json(json_object: item)
+        end
       end
     end
 
@@ -254,7 +271,7 @@ module Ittybit
     # @param alt [String]
     # @param metadata [Hash{String => Object}]
     # @param request_options [Ittybit::RequestOptions]
-    # @return [Ittybit::MediaResponse]
+    # @return [Ittybit::Media::MediaCreateResponse]
     # @example
     #  api = Ittybit::Client.new(
     #    base_url: "https://api.example.com",
@@ -264,7 +281,7 @@ module Ittybit
     #  api.media.create(
     #    title: "My Video Example",
     #    alt: "An example video used to demonstrate the ittybit API",
-    #    metadata: { "customKey2": "a different custom value" }
+    #    metadata: { "customKey": "your custom value" }
     #  )
     def create(title: nil, alt: nil, metadata: nil, request_options: nil)
       Async do
@@ -273,9 +290,10 @@ module Ittybit
           req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
           req.headers["ACCEPT_VERSION"] = request_options.version unless request_options&.version.nil?
           req.headers = {
-        **(req.headers || {}),
-        **@request_client.get_headers,
-        **(request_options&.additional_headers || {})
+            **(req.headers || {}),
+            **@request_client.get_headers,
+            **(request_options&.additional_headers || {}),
+            "Accept-Version": "2025-08-20"
           }.compact
           unless request_options.nil? || request_options&.additional_query_parameters.nil?
             req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -288,7 +306,7 @@ module Ittybit
           }.compact
           req.url "#{@request_client.get_url(request_options: request_options)}/media"
         end
-        Ittybit::MediaResponse.from_json(json_object: response.body)
+        Ittybit::Media::MediaCreateResponse.from_json(json_object: response.body)
       end
     end
 
@@ -296,7 +314,7 @@ module Ittybit
     #
     # @param id [String]
     # @param request_options [Ittybit::RequestOptions]
-    # @return [Ittybit::MediaResponse]
+    # @return [Ittybit::Media::MediaGetResponse]
     # @example
     #  api = Ittybit::Client.new(
     #    base_url: "https://api.example.com",
@@ -311,9 +329,10 @@ module Ittybit
           req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
           req.headers["ACCEPT_VERSION"] = request_options.version unless request_options&.version.nil?
           req.headers = {
-        **(req.headers || {}),
-        **@request_client.get_headers,
-        **(request_options&.additional_headers || {})
+            **(req.headers || {}),
+            **@request_client.get_headers,
+            **(request_options&.additional_headers || {}),
+            "Accept-Version": "2025-08-20"
           }.compact
           unless request_options.nil? || request_options&.additional_query_parameters.nil?
             req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -323,7 +342,7 @@ module Ittybit
           end
           req.url "#{@request_client.get_url(request_options: request_options)}/media/#{id}"
         end
-        Ittybit::MediaResponse.from_json(json_object: response.body)
+        Ittybit::Media::MediaGetResponse.from_json(json_object: response.body)
       end
     end
 
@@ -332,7 +351,7 @@ module Ittybit
     #
     # @param id [String]
     # @param request_options [Ittybit::RequestOptions]
-    # @return [Ittybit::ConfirmationResponse]
+    # @return [Ittybit::Media::MediaDeleteResponse]
     # @example
     #  api = Ittybit::Client.new(
     #    base_url: "https://api.example.com",
@@ -347,9 +366,10 @@ module Ittybit
           req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
           req.headers["ACCEPT_VERSION"] = request_options.version unless request_options&.version.nil?
           req.headers = {
-        **(req.headers || {}),
-        **@request_client.get_headers,
-        **(request_options&.additional_headers || {})
+            **(req.headers || {}),
+            **@request_client.get_headers,
+            **(request_options&.additional_headers || {}),
+            "Accept-Version": "2025-08-20"
           }.compact
           unless request_options.nil? || request_options&.additional_query_parameters.nil?
             req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -359,7 +379,7 @@ module Ittybit
           end
           req.url "#{@request_client.get_url(request_options: request_options)}/media/#{id}"
         end
-        Ittybit::ConfirmationResponse.from_json(json_object: response.body)
+        Ittybit::Media::MediaDeleteResponse.from_json(json_object: response.body)
       end
     end
 
@@ -371,7 +391,7 @@ module Ittybit
     # @param alt [String]
     # @param metadata [Hash{String => Object}]
     # @param request_options [Ittybit::RequestOptions]
-    # @return [Ittybit::MediaResponse]
+    # @return [Ittybit::Media::MediaUpdateResponse]
     # @example
     #  api = Ittybit::Client.new(
     #    base_url: "https://api.example.com",
@@ -382,7 +402,7 @@ module Ittybit
     #    id: "med_abcdefgh1234",
     #    title: "Updated Video Example",
     #    alt: "An updated example video used to demonstrate the ittybit API",
-    #    metadata: { "customKey2": "a different custom value" }
+    #    metadata: { "customKey": "a different custom value" }
     #  )
     def update(id:, title: nil, alt: nil, metadata: nil, request_options: nil)
       Async do
@@ -391,9 +411,10 @@ module Ittybit
           req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
           req.headers["ACCEPT_VERSION"] = request_options.version unless request_options&.version.nil?
           req.headers = {
-        **(req.headers || {}),
-        **@request_client.get_headers,
-        **(request_options&.additional_headers || {})
+            **(req.headers || {}),
+            **@request_client.get_headers,
+            **(request_options&.additional_headers || {}),
+            "Accept-Version": "2025-08-20"
           }.compact
           unless request_options.nil? || request_options&.additional_query_parameters.nil?
             req.params = { **(request_options&.additional_query_parameters || {}) }.compact
@@ -406,7 +427,7 @@ module Ittybit
           }.compact
           req.url "#{@request_client.get_url(request_options: request_options)}/media/#{id}"
         end
-        Ittybit::MediaResponse.from_json(json_object: response.body)
+        Ittybit::Media::MediaUpdateResponse.from_json(json_object: response.body)
       end
     end
   end

data/lib/ittybit/media/types/media_create_response.rb

@@ -0,0 +1,175 @@
+# frozen_string_literal: true
+
+require_relative "media_create_response_kind"
+require_relative "media_create_response_files_item"
+require "date"
+require "ostruct"
+require "json"
+
+module Ittybit
+  class Media
+    class MediaCreateResponse
+      # @return [String]
+      attr_reader :id
+      # @return [String]
+      attr_reader :object
+      # @return [Ittybit::Media::MediaCreateResponseKind]
+      attr_reader :kind
+      # @return [String]
+      attr_reader :title
+      # @return [String]
+      attr_reader :alt
+      # @return [Integer]
+      attr_reader :width
+      # @return [Integer]
+      attr_reader :height
+      # @return [Float]
+      attr_reader :duration
+      # @return [Array<Ittybit::Media::MediaCreateResponseFilesItem>]
+      attr_reader :files
+      # @return [Hash{String => Object}]
+      attr_reader :urls
+      # @return [String]
+      attr_reader :background
+      # @return [Hash{String => Object}]
+      attr_reader :metadata
+      # @return [DateTime]
+      attr_reader :created
+      # @return [DateTime]
+      attr_reader :updated
+      # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+      # @return [Object]
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
+
+      # @param id [String]
+      # @param object [String]
+      # @param kind [Ittybit::Media::MediaCreateResponseKind]
+      # @param title [String]
+      # @param alt [String]
+      # @param width [Integer]
+      # @param height [Integer]
+      # @param duration [Float]
+      # @param files [Array<Ittybit::Media::MediaCreateResponseFilesItem>]
+      # @param urls [Hash{String => Object}]
+      # @param background [String]
+      # @param metadata [Hash{String => Object}]
+      # @param created [DateTime]
+      # @param updated [DateTime]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Ittybit::Media::MediaCreateResponse]
+      def initialize(id:, object:, files:, urls:, created:, updated:, kind: OMIT, title: OMIT, alt: OMIT, width: OMIT,
+                     height: OMIT, duration: OMIT, background: OMIT, metadata: OMIT, additional_properties: nil)
+        @id = id
+        @object = object
+        @kind = kind if kind != OMIT
+        @title = title if title != OMIT
+        @alt = alt if alt != OMIT
+        @width = width if width != OMIT
+        @height = height if height != OMIT
+        @duration = duration if duration != OMIT
+        @files = files
+        @urls = urls
+        @background = background if background != OMIT
+        @metadata = metadata if metadata != OMIT
+        @created = created
+        @updated = updated
+        @additional_properties = additional_properties
+        @_field_set = {
+          "id": id,
+          "object": object,
+          "kind": kind,
+          "title": title,
+          "alt": alt,
+          "width": width,
+          "height": height,
+          "duration": duration,
+          "files": files,
+          "urls": urls,
+          "background": background,
+          "metadata": metadata,
+          "created": created,
+          "updated": updated
+        }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of MediaCreateResponse
+      #
+      # @param json_object [String]
+      # @return [Ittybit::Media::MediaCreateResponse]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        id = parsed_json["id"]
+        object = parsed_json["object"]
+        kind = parsed_json["kind"]
+        title = parsed_json["title"]
+        alt = parsed_json["alt"]
+        width = parsed_json["width"]
+        height = parsed_json["height"]
+        duration = parsed_json["duration"]
+        files = parsed_json["files"]&.map do |item|
+          item = item.to_json
+          Ittybit::Media::MediaCreateResponseFilesItem.from_json(json_object: item)
+        end
+        urls = parsed_json["urls"]
+        background = parsed_json["background"]
+        metadata = parsed_json["metadata"]
+        created = (DateTime.parse(parsed_json["created"]) unless parsed_json["created"].nil?)
+        updated = (DateTime.parse(parsed_json["updated"]) unless parsed_json["updated"].nil?)
+        new(
+          id: id,
+          object: object,
+          kind: kind,
+          title: title,
+          alt: alt,
+          width: width,
+          height: height,
+          duration: duration,
+          files: files,
+          urls: urls,
+          background: background,
+          metadata: metadata,
+          created: created,
+          updated: updated,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of MediaCreateResponse to a JSON object
+      #
+      # @return [String]
+      def to_json(*_args)
+        @_field_set&.to_json
+      end
+
+      # Leveraged for Union-type generation, validate_raw attempts to parse the given
+      #  hash and check each fields type against the current object's property
+      #  definitions.
+      #
+      # @param obj [Object]
+      # @return [Void]
+      def self.validate_raw(obj:)
+        obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+        obj.object.is_a?(String) != false || raise("Passed value for field obj.object is not the expected type, validation failed.")
+        obj.kind&.is_a?(Ittybit::Media::MediaCreateResponseKind) != false || raise("Passed value for field obj.kind is not the expected type, validation failed.")
+        obj.title&.is_a?(String) != false || raise("Passed value for field obj.title is not the expected type, validation failed.")
+        obj.alt&.is_a?(String) != false || raise("Passed value for field obj.alt is not the expected type, validation failed.")
+        obj.width&.is_a?(Integer) != false || raise("Passed value for field obj.width is not the expected type, validation failed.")
+        obj.height&.is_a?(Integer) != false || raise("Passed value for field obj.height is not the expected type, validation failed.")
+        obj.duration&.is_a?(Float) != false || raise("Passed value for field obj.duration is not the expected type, validation failed.")
+        obj.files.is_a?(Array) != false || raise("Passed value for field obj.files is not the expected type, validation failed.")
+        obj.urls.is_a?(Hash) != false || raise("Passed value for field obj.urls is not the expected type, validation failed.")
+        obj.background&.is_a?(String) != false || raise("Passed value for field obj.background is not the expected type, validation failed.")
+        obj.metadata&.is_a?(Hash) != false || raise("Passed value for field obj.metadata is not the expected type, validation failed.")
+        obj.created.is_a?(DateTime) != false || raise("Passed value for field obj.created is not the expected type, validation failed.")
+        obj.updated.is_a?(DateTime) != false || raise("Passed value for field obj.updated is not the expected type, validation failed.")
+      end
+    end
+  end
+end