peal 0.2.0 → 0.3.0

data/lib/peal/media/client.rb

@@ -0,0 +1,360 @@
+# frozen_string_literal: true
+
+module Peal
+  module Media
+    class Client
+      # @param client [Peal::Internal::Http::RawClient]
+      #
+      # @return [void]
+      def initialize(client:)
+        @client = client
+      end
+
+      # Lists the workspace's media, newest first, 30 a page unless `limit` (at most 100) says otherwise. Pass the
+      # page's `nextCursor` as `cursor` for the next one. Needs media:read.
+      #
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String] :workspace_id
+      # @option params [String, nil] :cursor
+      # @option params [String, nil] :limit
+      #
+      # @example
+      #   client.media.list(workspace_id: "workspaceId")
+      #
+      # @return [Peal::Types::MediaPage]
+      def list(request_options: {}, **params)
+        params = Peal::Internal::Types::Utils.normalize_keys(params)
+        query_params = {}
+        query_params["cursor"] = params[:cursor] if params.key?(:cursor)
+        query_params["limit"] = params[:limit] if params.key?(:limit)
+
+        request = Peal::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "api/workspaces/#{URI.encode_uri_component(params[:workspace_id].to_s)}/media",
+          query: query_params,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Peal::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          (response.body.to_s.empty? ? nil : Peal::Types::MediaPage.load(response.body))
+        else
+          error_class = Peal::Errors::ResponseError.subclass_for_code(code)
+          error_types = {
+            401 => Peal::Types::UnauthenticatedEncoded,
+            403 => Peal::Types::ForbiddenEncoded
+          }
+          error_body = Peal::Errors::ResponseError.load_error_body(code, response.body, error_types)
+          raise error_class.new(response.body, code: code, body: error_body, headers: response.to_hash)
+        end
+      end
+
+      # Records pending media and signs the upload of its file: one PUT for an image or a video up to 16 MiB, one PUT
+      # per part for a larger video. Send the file with them, then complete the upload. The requests only take the
+      # declared size and content type. Needs media:upload.
+      #
+      # @param request_options [Hash]
+      # @param params [Peal::Media::Types::NewUpload]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String] :workspace_id
+      #
+      # @example
+      #   client.media.create(
+      #     workspace_id: "workspaceId",
+      #     byte_size: 1,
+      #     content_type: "contentType"
+      #   )
+      #
+      # @return [Peal::Types::PreparedUpload]
+      def create(request_options: {}, **params)
+        params = Peal::Internal::Types::Utils.normalize_keys(params)
+        request_data = Peal::Media::Types::NewUpload.new(params).to_h
+        non_body_param_names = %w[workspaceId]
+        body = request_data.except(*non_body_param_names)
+
+        request = Peal::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "api/workspaces/#{URI.encode_uri_component(params[:workspace_id].to_s)}/media",
+          body: body,
+          request_options: request_options,
+          max_retries: 0
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Peal::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          (response.body.to_s.empty? ? nil : Peal::Types::PreparedUpload.load(response.body))
+        else
+          error_class = Peal::Errors::ResponseError.subclass_for_code(code)
+          error_types = {
+            401 => Peal::Types::UnauthenticatedEncoded,
+            403 => Peal::Types::ForbiddenEncoded
+          }
+          error_body = Peal::Errors::ResponseError.load_error_body(code, response.body, error_types)
+          raise error_class.new(response.body, code: code, body: error_body, headers: response.to_hash)
+        end
+      end
+
+      # Shows one of the workspace's media. Needs media:read.
+      #
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String] :workspace_id
+      # @option params [String] :media_id
+      #
+      # @example
+      #   client.media.get(
+      #     workspace_id: "workspaceId",
+      #     media_id: "mediaId"
+      #   )
+      #
+      # @return [Peal::Types::Media]
+      def get(request_options: {}, **params)
+        params = Peal::Internal::Types::Utils.normalize_keys(params)
+        request = Peal::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "api/workspaces/#{URI.encode_uri_component(params[:workspace_id].to_s)}/media/#{URI.encode_uri_component(params[:media_id].to_s)}",
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Peal::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          (response.body.to_s.empty? ? nil : Peal::Types::Media.load(response.body))
+        else
+          error_class = Peal::Errors::ResponseError.subclass_for_code(code)
+          error_types = {
+            401 => Peal::Types::UnauthenticatedEncoded,
+            403 => Peal::Types::ForbiddenEncoded
+          }
+          error_body = Peal::Errors::ResponseError.load_error_body(code, response.body, error_types)
+          raise error_class.new(response.body, code: code, body: error_body, headers: response.to_hash)
+        end
+      end
+
+      # Deletes the media and its file, and cancels its upload if it is still pending. Drafts that show it lose it.
+      # Posts scheduled or publishing that show it refuse the deletion (`MediaInUse`, listing them): take them back to
+      # draft first. Needs media:delete.
+      #
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String] :workspace_id
+      # @option params [String] :media_id
+      #
+      # @example
+      #   client.media.delete(
+      #     workspace_id: "workspaceId",
+      #     media_id: "mediaId"
+      #   )
+      #
+      # @return [untyped]
+      def delete(request_options: {}, **params)
+        params = Peal::Internal::Types::Utils.normalize_keys(params)
+        request = Peal::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "DELETE",
+          path: "api/workspaces/#{URI.encode_uri_component(params[:workspace_id].to_s)}/media/#{URI.encode_uri_component(params[:media_id].to_s)}",
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Peal::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        return if code.between?(200, 299)
+
+        error_class = Peal::Errors::ResponseError.subclass_for_code(code)
+        error_types = {
+          401 => Peal::Types::UnauthenticatedEncoded,
+          403 => Peal::Types::ForbiddenEncoded
+        }
+        error_body = Peal::Errors::ResponseError.load_error_body(code, response.body, error_types)
+        raise error_class.new(response.body, code: code, body: error_body, headers: response.to_hash)
+      end
+
+      # Sets the media's description, which platforms show to people who cannot see it. It can be written while the file
+      # uploads. Needs media:upload.
+      #
+      # @param request_options [Hash]
+      # @param params [Peal::Media::Types::MediaDescription]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String] :workspace_id
+      # @option params [String] :media_id
+      #
+      # @example
+      #   client.media.describe(
+      #     workspace_id: "workspaceId",
+      #     media_id: "mediaId",
+      #     alt_text: nil
+      #   )
+      #
+      # @return [Peal::Types::Media]
+      def describe(request_options: {}, **params)
+        params = Peal::Internal::Types::Utils.normalize_keys(params)
+        request_data = Peal::Media::Types::MediaDescription.new(params).to_h
+        non_body_param_names = %w[workspaceId mediaId]
+        body = request_data.except(*non_body_param_names)
+
+        request = Peal::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "PATCH",
+          path: "api/workspaces/#{URI.encode_uri_component(params[:workspace_id].to_s)}/media/#{URI.encode_uri_component(params[:media_id].to_s)}",
+          body: body,
+          request_options: request_options,
+          max_retries: 0
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Peal::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          (response.body.to_s.empty? ? nil : Peal::Types::Media.load(response.body))
+        else
+          error_class = Peal::Errors::ResponseError.subclass_for_code(code)
+          error_types = {
+            401 => Peal::Types::UnauthenticatedEncoded,
+            403 => Peal::Types::ForbiddenEncoded
+          }
+          error_body = Peal::Errors::ResponseError.load_error_body(code, response.body, error_types)
+          raise error_class.new(response.body, code: code, body: error_body, headers: response.to_hash)
+        end
+      end
+
+      # Checks that the file reached the store with the declared size and type, joining its parts first, then probes it:
+      # the media is ready, or stays uploaded with why it could not be probed. Calling it again is safe, and probes an
+      # uploaded file again. Needs media:upload.
+      #
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String] :workspace_id
+      # @option params [String] :media_id
+      #
+      # @example
+      #   client.media.complete(
+      #     workspace_id: "workspaceId",
+      #     media_id: "mediaId"
+      #   )
+      #
+      # @return [Peal::Types::Media]
+      def complete(request_options: {}, **params)
+        params = Peal::Internal::Types::Utils.normalize_keys(params)
+        request = Peal::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "api/workspaces/#{URI.encode_uri_component(params[:workspace_id].to_s)}/media/#{URI.encode_uri_component(params[:media_id].to_s)}/complete",
+          request_options: request_options,
+          max_retries: 0
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Peal::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          (response.body.to_s.empty? ? nil : Peal::Types::Media.load(response.body))
+        else
+          error_class = Peal::Errors::ResponseError.subclass_for_code(code)
+          error_types = {
+            401 => Peal::Types::UnauthenticatedEncoded,
+            403 => Peal::Types::ForbiddenEncoded
+          }
+          error_body = Peal::Errors::ResponseError.load_error_body(code, response.body, error_types)
+          raise error_class.new(response.body, code: code, body: error_body, headers: response.to_hash)
+        end
+      end
+
+      # Lists the posts that show the media: drafts, which lose it if it is deleted, and posts scheduled or publishing,
+      # which keep it from being deleted. Needs media:read.
+      #
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String] :workspace_id
+      # @option params [String] :media_id
+      #
+      # @example
+      #   client.media.usage(
+      #     workspace_id: "workspaceId",
+      #     media_id: "mediaId"
+      #   )
+      #
+      # @return [Peal::Types::MediaUsage]
+      def usage(request_options: {}, **params)
+        params = Peal::Internal::Types::Utils.normalize_keys(params)
+        request = Peal::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "api/workspaces/#{URI.encode_uri_component(params[:workspace_id].to_s)}/media/#{URI.encode_uri_component(params[:media_id].to_s)}/usage",
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Peal::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          (response.body.to_s.empty? ? nil : Peal::Types::MediaUsage.load(response.body))
+        else
+          error_class = Peal::Errors::ResponseError.subclass_for_code(code)
+          error_types = {
+            401 => Peal::Types::UnauthenticatedEncoded,
+            403 => Peal::Types::ForbiddenEncoded
+          }
+          error_body = Peal::Errors::ResponseError.load_error_body(code, response.body, error_types)
+          raise error_class.new(response.body, code: code, body: error_body, headers: response.to_hash)
+        end
+      end
+    end
+  end
+end

data/lib/peal/media/types/complete_media_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Peal
+  module Media
+    module Types
+      class CompleteMediaRequest < Internal::Types::Model
+        field :workspace_id, -> { String }, optional: false, nullable: false, api_name: "workspaceId"
+
+        field :media_id, -> { String }, optional: false, nullable: false, api_name: "mediaId"
+      end
+    end
+  end
+end

data/lib/peal/media/types/delete_media_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Peal
+  module Media
+    module Types
+      class DeleteMediaRequest < Internal::Types::Model
+        field :workspace_id, -> { String }, optional: false, nullable: false, api_name: "workspaceId"
+
+        field :media_id, -> { String }, optional: false, nullable: false, api_name: "mediaId"
+      end
+    end
+  end
+end

data/lib/peal/media/types/get_media_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Peal
+  module Media
+    module Types
+      class GetMediaRequest < Internal::Types::Model
+        field :workspace_id, -> { String }, optional: false, nullable: false, api_name: "workspaceId"
+
+        field :media_id, -> { String }, optional: false, nullable: false, api_name: "mediaId"
+      end
+    end
+  end
+end

data/lib/peal/media/types/list_media_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Peal
+  module Media
+    module Types
+      class ListMediaRequest < Internal::Types::Model
+        field :workspace_id, -> { String }, optional: false, nullable: false, api_name: "workspaceId"
+
+        field :cursor, -> { String }, optional: true, nullable: false
+
+        field :limit, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/peal/media/types/media_description.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Peal
+  module Media
+    module Types
+      class MediaDescription < Internal::Types::Model
+        field :workspace_id, -> { String }, optional: false, nullable: false, api_name: "workspaceId"
+
+        field :media_id, -> { String }, optional: false, nullable: false, api_name: "mediaId"
+
+        field :alt_text, -> { String }, optional: false, nullable: true, api_name: "altText"
+      end
+    end
+  end
+end

data/lib/peal/media/types/new_upload.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Peal
+  module Media
+    module Types
+      class NewUpload < Internal::Types::Model
+        field :workspace_id, -> { String }, optional: false, nullable: false, api_name: "workspaceId"
+
+        field :alt_text, -> { String }, optional: true, nullable: true, api_name: "altText"
+
+        field :byte_size, -> { Integer }, optional: false, nullable: false, api_name: "byteSize"
+
+        field :content_type, -> { String }, optional: false, nullable: false, api_name: "contentType"
+      end
+    end
+  end
+end

data/lib/peal/media/types/usage_media_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Peal
+  module Media
+    module Types
+      class UsageMediaRequest < Internal::Types::Model
+        field :workspace_id, -> { String }, optional: false, nullable: false, api_name: "workspaceId"
+
+        field :media_id, -> { String }, optional: false, nullable: false, api_name: "mediaId"
+      end
+    end
+  end
+end

data/lib/peal/members/client.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Peal
+  module Members
+    class Client
+      # @param client [Peal::Internal::Http::RawClient]
+      #
+      # @return [void]
+      def initialize(client:)
+        @client = client
+      end
+
+      # Lists the workspace's members, in the order they joined, with their name, email address and role. Every member
+      # may see them, as the workspace's settings show them; an API key may not, as members' addresses are not a
+      # script's to read.
+      #
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String] :workspace_id
+      #
+      # @example
+      #   client.members.list(workspace_id: "workspaceId")
+      #
+      # @return [Array[Peal::Types::WorkspaceMember]]
+      def list(request_options: {}, **params)
+        params = Peal::Internal::Types::Utils.normalize_keys(params)
+        request = Peal::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "api/workspaces/#{URI.encode_uri_component(params[:workspace_id].to_s)}/members",
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Peal::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Peal::Internal::Types::Utils.coerce(Internal::Types::Array[Peal::Types::WorkspaceMember], (response.body.to_s.empty? ? nil : JSON.parse(response.body, symbolize_names: true)))
+        else
+          error_class = Peal::Errors::ResponseError.subclass_for_code(code)
+          error_types = {
+            401 => Peal::Types::UnauthenticatedEncoded,
+            403 => Peal::Types::ForbiddenEncoded
+          }
+          error_body = Peal::Errors::ResponseError.load_error_body(code, response.body, error_types)
+          raise error_class.new(response.body, code: code, body: error_body, headers: response.to_hash)
+        end
+      end
+    end
+  end
+end

data/lib/peal/members/types/list_members_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Peal
+  module Members
+    module Types
+      class ListMembersRequest < Internal::Types::Model
+        field :workspace_id, -> { String }, optional: false, nullable: false, api_name: "workspaceId"
+      end
+    end
+  end
+end