ittybit 0.7.4

data/lib/ittybit/media/client.rb

@@ -0,0 +1,367 @@
+# frozen_string_literal: true
+
+require_relative "../../requests"
+require_relative "../types/media_list_response"
+require_relative "../types/media_response"
+require_relative "../types/confirmation_response"
+require "async"
+
+module Ittybit
+  class MediaClient
+    # @return [Ittybit::RequestClient]
+    attr_reader :request_client
+
+    # @param request_client [Ittybit::RequestClient]
+    # @return [Ittybit::MediaClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+
+    # Retrieves a list of all media for the current project
+    #
+    # @param limit [Integer] Number of media items to return per page.
+    # @param request_options [Ittybit::RequestOptions]
+    # @return [Ittybit::MediaListResponse]
+    # @example
+    #  api = Ittybit::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: Ittybit::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.media.list
+    def list(limit: nil, request_options: nil)
+      response = @request_client.conn.get do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        req.headers["Authorization"] = request_options.token unless request_options&.token.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 || {})
+        }.compact
+        req.params = { **(request_options&.additional_query_parameters || {}), "limit": limit }.compact
+        unless request_options.nil? || request_options&.additional_body_parameters.nil?
+          req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+        end
+        req.url "#{@request_client.get_url(request_options: request_options)}/media"
+      end
+      Ittybit::MediaListResponse.from_json(json_object: response.body)
+    end
+
+    # Creates a new media item from a URL or as an empty placeholder
+    #
+    # @param title [String] Title for the media
+    # @param metadata [Hash{String => Object}] Additional metadata for the media
+    # @param request_options [Ittybit::RequestOptions]
+    # @return [Ittybit::MediaResponse]
+    # @example
+    #  api = Ittybit::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: Ittybit::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.media.create(metadata: { "credit": "gtv-videos-bucket" })
+    def create(title: nil, metadata: nil, request_options: nil)
+      response = @request_client.conn.post do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        req.headers["Authorization"] = request_options.token unless request_options&.token.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 || {})
+        }.compact
+        unless request_options.nil? || request_options&.additional_query_parameters.nil?
+          req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+        end
+        req.body = { **(request_options&.additional_body_parameters || {}), title: title, metadata: metadata }.compact
+        req.url "#{@request_client.get_url(request_options: request_options)}/media"
+      end
+      Ittybit::MediaResponse.from_json(json_object: response.body)
+    end
+
+    # Retrieves a specific media item by its ID
+    #
+    # @param id [String]
+    # @param request_options [Ittybit::RequestOptions]
+    # @return [Ittybit::MediaResponse]
+    # @example
+    #  api = Ittybit::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: Ittybit::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.media.get(id: "id")
+    def get(id:, request_options: nil)
+      response = @request_client.conn.get do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        req.headers["Authorization"] = request_options.token unless request_options&.token.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 || {})
+        }.compact
+        unless request_options.nil? || request_options&.additional_query_parameters.nil?
+          req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+        end
+        unless request_options.nil? || request_options&.additional_body_parameters.nil?
+          req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+        end
+        req.url "#{@request_client.get_url(request_options: request_options)}/media/#{id}"
+      end
+      Ittybit::MediaResponse.from_json(json_object: response.body)
+    end
+
+    # Deletes a specific media item by its ID
+    #
+    # @param id [String]
+    # @param request_options [Ittybit::RequestOptions]
+    # @return [Ittybit::ConfirmationResponse]
+    # @example
+    #  api = Ittybit::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: Ittybit::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.media.delete(id: "id")
+    def delete(id:, request_options: nil)
+      response = @request_client.conn.delete do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        req.headers["Authorization"] = request_options.token unless request_options&.token.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 || {})
+        }.compact
+        unless request_options.nil? || request_options&.additional_query_parameters.nil?
+          req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+        end
+        unless request_options.nil? || request_options&.additional_body_parameters.nil?
+          req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+        end
+        req.url "#{@request_client.get_url(request_options: request_options)}/media/#{id}"
+      end
+      Ittybit::ConfirmationResponse.from_json(json_object: response.body)
+    end
+
+    # Updates specific fields of a media item by its ID. Only the fields provided in
+    #  the request body will be updated.
+    #
+    # @param id [String]
+    # @param title [String] New title for the media item.
+    # @param metadata [Hash{String => Object}] New metadata object for the media item. This will replace the existing metadata.
+    # @param request_options [Ittybit::RequestOptions]
+    # @return [Ittybit::MediaResponse]
+    # @example
+    #  api = Ittybit::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: Ittybit::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.media.update(id: "id")
+    def update(id:, title: nil, metadata: nil, request_options: nil)
+      response = @request_client.conn.patch do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        req.headers["Authorization"] = request_options.token unless request_options&.token.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 || {})
+        }.compact
+        unless request_options.nil? || request_options&.additional_query_parameters.nil?
+          req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+        end
+        req.body = { **(request_options&.additional_body_parameters || {}), title: title, metadata: metadata }.compact
+        req.url "#{@request_client.get_url(request_options: request_options)}/media/#{id}"
+      end
+      Ittybit::MediaResponse.from_json(json_object: response.body)
+    end
+  end
+
+  class AsyncMediaClient
+    # @return [Ittybit::AsyncRequestClient]
+    attr_reader :request_client
+
+    # @param request_client [Ittybit::AsyncRequestClient]
+    # @return [Ittybit::AsyncMediaClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+
+    # Retrieves a list of all media for the current project
+    #
+    # @param limit [Integer] Number of media items to return per page.
+    # @param request_options [Ittybit::RequestOptions]
+    # @return [Ittybit::MediaListResponse]
+    # @example
+    #  api = Ittybit::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: Ittybit::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.media.list
+    def list(limit: nil, request_options: nil)
+      Async do
+        response = @request_client.conn.get do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["Authorization"] = request_options.token unless request_options&.token.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 || {})
+          }.compact
+          req.params = { **(request_options&.additional_query_parameters || {}), "limit": limit }.compact
+          unless request_options.nil? || request_options&.additional_body_parameters.nil?
+            req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+          end
+          req.url "#{@request_client.get_url(request_options: request_options)}/media"
+        end
+        Ittybit::MediaListResponse.from_json(json_object: response.body)
+      end
+    end
+
+    # Creates a new media item from a URL or as an empty placeholder
+    #
+    # @param title [String] Title for the media
+    # @param metadata [Hash{String => Object}] Additional metadata for the media
+    # @param request_options [Ittybit::RequestOptions]
+    # @return [Ittybit::MediaResponse]
+    # @example
+    #  api = Ittybit::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: Ittybit::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.media.create(metadata: { "credit": "gtv-videos-bucket" })
+    def create(title: nil, metadata: nil, request_options: nil)
+      Async do
+        response = @request_client.conn.post do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["Authorization"] = request_options.token unless request_options&.token.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 || {})
+          }.compact
+          unless request_options.nil? || request_options&.additional_query_parameters.nil?
+            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+          end
+          req.body = { **(request_options&.additional_body_parameters || {}), title: title, metadata: metadata }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/media"
+        end
+        Ittybit::MediaResponse.from_json(json_object: response.body)
+      end
+    end
+
+    # Retrieves a specific media item by its ID
+    #
+    # @param id [String]
+    # @param request_options [Ittybit::RequestOptions]
+    # @return [Ittybit::MediaResponse]
+    # @example
+    #  api = Ittybit::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: Ittybit::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.media.get(id: "id")
+    def get(id:, request_options: nil)
+      Async do
+        response = @request_client.conn.get do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["Authorization"] = request_options.token unless request_options&.token.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 || {})
+          }.compact
+          unless request_options.nil? || request_options&.additional_query_parameters.nil?
+            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+          end
+          unless request_options.nil? || request_options&.additional_body_parameters.nil?
+            req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+          end
+          req.url "#{@request_client.get_url(request_options: request_options)}/media/#{id}"
+        end
+        Ittybit::MediaResponse.from_json(json_object: response.body)
+      end
+    end
+
+    # Deletes a specific media item by its ID
+    #
+    # @param id [String]
+    # @param request_options [Ittybit::RequestOptions]
+    # @return [Ittybit::ConfirmationResponse]
+    # @example
+    #  api = Ittybit::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: Ittybit::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.media.delete(id: "id")
+    def delete(id:, request_options: nil)
+      Async do
+        response = @request_client.conn.delete do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["Authorization"] = request_options.token unless request_options&.token.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 || {})
+          }.compact
+          unless request_options.nil? || request_options&.additional_query_parameters.nil?
+            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+          end
+          unless request_options.nil? || request_options&.additional_body_parameters.nil?
+            req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+          end
+          req.url "#{@request_client.get_url(request_options: request_options)}/media/#{id}"
+        end
+        Ittybit::ConfirmationResponse.from_json(json_object: response.body)
+      end
+    end
+
+    # Updates specific fields of a media item by its ID. Only the fields provided in
+    #  the request body will be updated.
+    #
+    # @param id [String]
+    # @param title [String] New title for the media item.
+    # @param metadata [Hash{String => Object}] New metadata object for the media item. This will replace the existing metadata.
+    # @param request_options [Ittybit::RequestOptions]
+    # @return [Ittybit::MediaResponse]
+    # @example
+    #  api = Ittybit::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: Ittybit::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.media.update(id: "id")
+    def update(id:, title: nil, metadata: nil, request_options: nil)
+      Async do
+        response = @request_client.conn.patch do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["Authorization"] = request_options.token unless request_options&.token.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 || {})
+          }.compact
+          unless request_options.nil? || request_options&.additional_query_parameters.nil?
+            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+          end
+          req.body = { **(request_options&.additional_body_parameters || {}), title: title, metadata: metadata }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/media/#{id}"
+        end
+        Ittybit::MediaResponse.from_json(json_object: response.body)
+      end
+    end
+  end
+end

data/lib/ittybit/signatures/client.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+require_relative "../../requests"
+require_relative "types/signatures_create_request_method"
+require_relative "../types/signature_response"
+require "async"
+
+module Ittybit
+  class SignaturesClient
+    # @return [Ittybit::RequestClient]
+    attr_reader :request_client
+
+    # @param request_client [Ittybit::RequestClient]
+    # @return [Ittybit::SignaturesClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+
+    # Creates a cryptographically signed URL that provides temporary and restricted
+    #  access to a file. The URL can expire after a specified time and be limited to
+    #  specific HTTP methods.
+    #
+    # @param filename [String] The name of the file to generate a signature for. Special characters will be
+    #  sanitised.
+    # @param folder [String] Optional folder path where the file resides. Special characters will be
+    #  sanitised.
+    # @param expiry [Long] Optional expiry time for the signature in seconds since epoch. Defaults to 60
+    #  minutes from now. Must be a positive integer and in the future.
+    # @param method [Ittybit::Signatures::SignaturesCreateRequestMethod] Optional HTTP method allowed for the signed URL. Defaults to 'get'.
+    # @param request_options [Ittybit::RequestOptions]
+    # @return [Ittybit::SignatureResponse]
+    # @example
+    #  api = Ittybit::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: Ittybit::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.signatures.create(
+    #    filename: "video.mp4",
+    #    folder: "private/user_123",
+    #    expiry: 1735689600,
+    #    method: GET
+    #  )
+    def create(filename:, folder: nil, expiry: nil, method: nil, request_options: nil)
+      response = @request_client.conn.post do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        req.headers["Authorization"] = request_options.token unless request_options&.token.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 || {})
+        }.compact
+        unless request_options.nil? || request_options&.additional_query_parameters.nil?
+          req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+        end
+        req.body = {
+          **(request_options&.additional_body_parameters || {}),
+          filename: filename,
+          folder: folder,
+          expiry: expiry,
+          method: method
+        }.compact
+        req.url "#{@request_client.get_url(request_options: request_options)}/signatures"
+      end
+      Ittybit::SignatureResponse.from_json(json_object: response.body)
+    end
+  end
+
+  class AsyncSignaturesClient
+    # @return [Ittybit::AsyncRequestClient]
+    attr_reader :request_client
+
+    # @param request_client [Ittybit::AsyncRequestClient]
+    # @return [Ittybit::AsyncSignaturesClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+
+    # Creates a cryptographically signed URL that provides temporary and restricted
+    #  access to a file. The URL can expire after a specified time and be limited to
+    #  specific HTTP methods.
+    #
+    # @param filename [String] The name of the file to generate a signature for. Special characters will be
+    #  sanitised.
+    # @param folder [String] Optional folder path where the file resides. Special characters will be
+    #  sanitised.
+    # @param expiry [Long] Optional expiry time for the signature in seconds since epoch. Defaults to 60
+    #  minutes from now. Must be a positive integer and in the future.
+    # @param method [Ittybit::Signatures::SignaturesCreateRequestMethod] Optional HTTP method allowed for the signed URL. Defaults to 'get'.
+    # @param request_options [Ittybit::RequestOptions]
+    # @return [Ittybit::SignatureResponse]
+    # @example
+    #  api = Ittybit::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: Ittybit::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.signatures.create(
+    #    filename: "video.mp4",
+    #    folder: "private/user_123",
+    #    expiry: 1735689600,
+    #    method: GET
+    #  )
+    def create(filename:, folder: nil, expiry: nil, method: nil, request_options: nil)
+      Async do
+        response = @request_client.conn.post do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["Authorization"] = request_options.token unless request_options&.token.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 || {})
+          }.compact
+          unless request_options.nil? || request_options&.additional_query_parameters.nil?
+            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+          end
+          req.body = {
+            **(request_options&.additional_body_parameters || {}),
+            filename: filename,
+            folder: folder,
+            expiry: expiry,
+            method: method
+          }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/signatures"
+        end
+        Ittybit::SignatureResponse.from_json(json_object: response.body)
+      end
+    end
+  end
+end

data/lib/ittybit/signatures/types/signatures_create_request_method.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Ittybit
+  class Signatures
+    # Optional HTTP method allowed for the signed URL. Defaults to 'get'.
+    class SignaturesCreateRequestMethod
+      GET = "get"
+      PUT = "put"
+      POST = "post"
+      DELETE = "delete"
+    end
+  end
+end