mailhub-sdk 0.1.0

data/lib/Mailhub/template/client.rb

@@ -0,0 +1,301 @@
+# frozen_string_literal: true
+
+module Mailhub
+  module Template
+    class Client
+      # @param client [Mailhub::Internal::Http::RawClient]
+      #
+      # @return [void]
+      def initialize(client:)
+        @client = client
+      end
+
+      # @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, nil] :search
+      # @option params [String, nil] :sort_by
+      # @option params [String, nil] :sort_direction
+      # @option params [Integer, nil] :page_size
+      # @option params [Integer, nil] :page_index
+      #
+      # @example
+      #   client.template.get_templates
+      #
+      # @return [Mailhub::Types::TemplateModelPagedResult]
+      def get_templates(request_options: {}, **params)
+        params = Mailhub::Internal::Types::Utils.normalize_keys(params)
+        query_params = {}
+        query_params["search"] = params[:search] if params.key?(:search)
+        query_params["sortBy"] = params[:sort_by] if params.key?(:sort_by)
+        query_params["sortDirection"] = params[:sort_direction] if params.key?(:sort_direction)
+        query_params["pageSize"] = params[:page_size] if params.key?(:page_size)
+        query_params["pageIndex"] = params[:page_index] if params.key?(:page_index)
+
+        request = Mailhub::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "v1/templates",
+          query: query_params,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Mailhub::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Mailhub::Types::TemplateModelPagedResult.load(response.body)
+        else
+          error_class = Mailhub::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # @param request_options [Hash]
+      # @param params [Mailhub::Template::Types::CreateTemplateRequest]
+      # @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
+      #
+      # @example
+      #   client.template.create_template
+      #
+      # @return [Mailhub::Types::TemplateModel]
+      def create_template(request_options: {}, **params)
+        params = Mailhub::Internal::Types::Utils.normalize_keys(params)
+        request = Mailhub::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "v1/templates",
+          body: Mailhub::Template::Types::CreateTemplateRequest.new(params).to_h,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Mailhub::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Mailhub::Types::TemplateModel.load(response.body)
+        else
+          error_class = Mailhub::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # @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
+      #
+      # @example
+      #   client.template.get_template_expressions
+      #
+      # @return [Array[Mailhub::Types::TemplateExpressionModel]]
+      def get_template_expressions(request_options: {}, **_params)
+        request = Mailhub::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "v1/templates/meta/expressions",
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Mailhub::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        return if code.between?(200, 299)
+
+        error_class = Mailhub::Errors::ResponseError.subclass_for_code(code)
+        raise error_class.new(response.body, code: code)
+      end
+
+      # @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] :code
+      #
+      # @example
+      #   client.template.get_template(code: "code")
+      #
+      # @return [Mailhub::Types::TemplateModel]
+      def get_template(request_options: {}, **params)
+        params = Mailhub::Internal::Types::Utils.normalize_keys(params)
+        request = Mailhub::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "v1/templates/#{URI.encode_uri_component(params[:code].to_s)}",
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Mailhub::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Mailhub::Types::TemplateModel.load(response.body)
+        else
+          error_class = Mailhub::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # @param request_options [Hash]
+      # @param params [Mailhub::Template::Types::UpdateTemplateRequest]
+      # @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] :code
+      #
+      # @example
+      #   client.template.update_template(code: "code")
+      #
+      # @return [Mailhub::Types::TemplateModel]
+      def update_template(request_options: {}, **params)
+        params = Mailhub::Internal::Types::Utils.normalize_keys(params)
+        request_data = Mailhub::Template::Types::UpdateTemplateRequest.new(params).to_h
+        non_body_param_names = %w[code]
+        body = request_data.except(*non_body_param_names)
+
+        request = Mailhub::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "PUT",
+          path: "v1/templates/#{URI.encode_uri_component(params[:code].to_s)}",
+          body: body,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Mailhub::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Mailhub::Types::TemplateModel.load(response.body)
+        else
+          error_class = Mailhub::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # @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] :code
+      #
+      # @example
+      #   client.template.delete_template(code: "code")
+      #
+      # @return [untyped]
+      def delete_template(request_options: {}, **params)
+        params = Mailhub::Internal::Types::Utils.normalize_keys(params)
+        request = Mailhub::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "DELETE",
+          path: "v1/templates/#{URI.encode_uri_component(params[:code].to_s)}",
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Mailhub::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        return if code.between?(200, 299)
+
+        error_class = Mailhub::Errors::ResponseError.subclass_for_code(code)
+        raise error_class.new(response.body, code: code)
+      end
+
+      # @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] :code
+      #
+      # @example
+      #   client.template.preview_template(code: "code")
+      #
+      # @return [String]
+      def preview_template(request_options: {}, **params)
+        params = Mailhub::Internal::Types::Utils.normalize_keys(params)
+        request = Mailhub::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "v1/templates/#{URI.encode_uri_component(params[:code].to_s)}/preview",
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Mailhub::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        return if code.between?(200, 299)
+
+        error_class = Mailhub::Errors::ResponseError.subclass_for_code(code)
+        raise error_class.new(response.body, code: code)
+      end
+
+      # @param request_options [Hash]
+      # @param params [Mailhub::Template::Types::GetTemplateRenderedPreviewRequest]
+      # @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
+      #
+      # @example
+      #   client.template.render_template_preview
+      #
+      # @return [String]
+      def render_template_preview(request_options: {}, **params)
+        params = Mailhub::Internal::Types::Utils.normalize_keys(params)
+        request = Mailhub::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "v1/templates/preview",
+          body: Mailhub::Template::Types::GetTemplateRenderedPreviewRequest.new(params).to_h,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Mailhub::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        return if code.between?(200, 299)
+
+        error_class = Mailhub::Errors::ResponseError.subclass_for_code(code)
+        raise error_class.new(response.body, code: code)
+      end
+    end
+  end
+end

data/lib/Mailhub/template/types/create_template_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Mailhub
+  module Template
+    module Types
+      class CreateTemplateRequest < Internal::Types::Model
+        field :name, -> { String }, optional: true, nullable: false
+
+        field :body, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/Mailhub/template/types/delete_template_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Mailhub
+  module Template
+    module Types
+      class DeleteTemplateRequest < Internal::Types::Model
+        field :code, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/Mailhub/template/types/get_template_rendered_preview_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Mailhub
+  module Template
+    module Types
+      class GetTemplateRenderedPreviewRequest < Internal::Types::Model
+        field :body, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/Mailhub/template/types/get_template_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Mailhub
+  module Template
+    module Types
+      class GetTemplateRequest < Internal::Types::Model
+        field :code, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/Mailhub/template/types/get_templates_request.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Mailhub
+  module Template
+    module Types
+      class GetTemplatesRequest < Internal::Types::Model
+        field :search, -> { String }, optional: true, nullable: false
+
+        field :sort_by, -> { String }, optional: true, nullable: false, api_name: "sortBy"
+
+        field :sort_direction, -> { String }, optional: true, nullable: false, api_name: "sortDirection"
+
+        field :page_size, -> { Integer }, optional: true, nullable: false, api_name: "pageSize"
+
+        field :page_index, -> { Integer }, optional: true, nullable: false, api_name: "pageIndex"
+      end
+    end
+  end
+end

data/lib/Mailhub/template/types/preview_template_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Mailhub
+  module Template
+    module Types
+      class PreviewTemplateRequest < Internal::Types::Model
+        field :code, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/Mailhub/template/types/update_template_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Mailhub
+  module Template
+    module Types
+      class UpdateTemplateRequest < Internal::Types::Model
+        field :code, -> { String }, optional: false, nullable: false
+
+        field :name, -> { String }, optional: true, nullable: false
+
+        field :body, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/Mailhub/types/api_error.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Mailhub
+  module Types
+    # API 오류 응답
+    class APIError < Internal::Types::Model
+      field :code, -> { String }, optional: true, nullable: false
+
+      field :status, -> { Integer }, optional: true, nullable: false
+
+      field :message, -> { String }, optional: true, nullable: false
+
+      field :errors, -> { Internal::Types::Array[Mailhub::Types::APIErrorDetail] }, optional: true, nullable: false
+    end
+  end
+end

data/lib/Mailhub/types/api_error_detail.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Mailhub
+  module Types
+    # 필드 단위 오류 상세
+    class APIErrorDetail < Internal::Types::Model
+      field :field, -> { String }, optional: true, nullable: false
+
+      field :message, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/Mailhub/types/campaign_activity_point_model.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Mailhub
+  module Types
+    # 캠페인 활동 추이의 시점별 통계
+    class CampaignActivityPointModel < Internal::Types::Model
+      field :timestamp, -> { String }, optional: true, nullable: false
+
+      field :sent, -> { Integer }, optional: true, nullable: false
+
+      field :opens, -> { Integer }, optional: true, nullable: false
+
+      field :clicks, -> { Integer }, optional: true, nullable: false
+
+      field :bounced, -> { Integer }, optional: true, nullable: false
+    end
+  end
+end

data/lib/Mailhub/types/campaign_analytics_model.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Mailhub
+  module Types
+    # 캠페인 성과 분석 통계
+    class CampaignAnalyticsModel < Internal::Types::Model
+      field :campaign_id, -> { Integer }, optional: true, nullable: false, api_name: "campaignId"
+
+      field :campaign_code, -> { String }, optional: true, nullable: false, api_name: "campaignCode"
+
+      field :sent, -> { Integer }, optional: true, nullable: false
+
+      field :views, -> { Integer }, optional: true, nullable: false
+
+      field :unique_views, -> { Integer }, optional: true, nullable: false, api_name: "uniqueViews"
+
+      field :clicks, -> { Integer }, optional: true, nullable: false
+
+      field :unique_clicks, -> { Integer }, optional: true, nullable: false, api_name: "uniqueClicks"
+
+      field :open_rate, -> { Integer }, optional: true, nullable: false, api_name: "openRate"
+
+      field :unique_open_rate, -> { Integer }, optional: true, nullable: false, api_name: "uniqueOpenRate"
+
+      field :click_rate, -> { Integer }, optional: true, nullable: false, api_name: "clickRate"
+
+      field :unique_click_rate, -> { Integer }, optional: true, nullable: false, api_name: "uniqueClickRate"
+    end
+  end
+end

data/lib/Mailhub/types/campaign_link_stat_model.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Mailhub
+  module Types
+    # 캠페인 본문 내 링크별 클릭 통계
+    class CampaignLinkStatModel < Internal::Types::Model
+      field :url, -> { String }, optional: true, nullable: false
+
+      field :clicks, -> { Integer }, optional: true, nullable: false
+
+      field :unique_clicks, -> { Integer }, optional: true, nullable: false, api_name: "uniqueClicks"
+    end
+  end
+end

data/lib/Mailhub/types/campaign_media_model.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Mailhub
+  module Types
+    # 캠페인에 첨부된 미디어 정보
+    class CampaignMediaModel < Internal::Types::Model
+      field :id, -> { Integer }, optional: true, nullable: false
+
+      field :campaign_id, -> { Integer }, optional: true, nullable: false, api_name: "campaignId"
+
+      field :media_id, -> { Integer }, optional: true, nullable: false, api_name: "mediaId"
+
+      field :media_code, -> { String }, optional: true, nullable: false, api_name: "mediaCode"
+
+      field :file_name, -> { String }, optional: true, nullable: false, api_name: "fileName"
+
+      field :content_type, -> { String }, optional: true, nullable: false, api_name: "contentType"
+
+      field :size, -> { Integer }, optional: true, nullable: false
+
+      field :created_at, -> { String }, optional: true, nullable: false, api_name: "createdAt"
+    end
+  end
+end

data/lib/Mailhub/types/campaign_model.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Mailhub
+  module Types
+    # 캠페인 정보
+    class CampaignModel < Internal::Types::Model
+      field :id, -> { Integer }, optional: true, nullable: false
+
+      field :code, -> { String }, optional: true, nullable: false
+
+      field :name, -> { String }, optional: true, nullable: false
+
+      field :subject, -> { String }, optional: true, nullable: false
+
+      field :type, -> { Mailhub::Types::CampaignType }, optional: true, nullable: false
+
+      field :from_email, -> { String }, optional: true, nullable: false, api_name: "fromEmail"
+
+      field :segments, -> { Internal::Types::Array[Mailhub::Types::CampaignSegmentModel] }, optional: true, nullable: false
+
+      field :template_id, -> { Integer }, optional: true, nullable: false, api_name: "templateId"
+
+      field :template_code, -> { String }, optional: true, nullable: false, api_name: "templateCode"
+
+      field :body, -> { String }, optional: true, nullable: false
+
+      field :send_at, -> { String }, optional: true, nullable: false, api_name: "sendAt"
+
+      field :to_send, -> { Integer }, optional: true, nullable: false, api_name: "toSend"
+
+      field :sent, -> { Integer }, optional: true, nullable: false
+
+      field :views, -> { Integer }, optional: true, nullable: false
+
+      field :unique_views, -> { Integer }, optional: true, nullable: false, api_name: "uniqueViews"
+
+      field :clicks, -> { Integer }, optional: true, nullable: false
+
+      field :unique_clicks, -> { Integer }, optional: true, nullable: false, api_name: "uniqueClicks"
+
+      field :bounces, -> { Integer }, optional: true, nullable: false
+
+      field :status, -> { Mailhub::Types::CampaignStatus }, optional: true, nullable: false
+
+      field :created_at, -> { String }, optional: true, nullable: false, api_name: "createdAt"
+
+      field :updated_at, -> { String }, optional: true, nullable: false, api_name: "updatedAt"
+
+      field :started_at, -> { String }, optional: true, nullable: false, api_name: "startedAt"
+    end
+  end
+end

data/lib/Mailhub/types/campaign_model_paged_result.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Mailhub
+  module Types
+    # 페이지네이션 목록 결과
+    class CampaignModelPagedResult < Internal::Types::Model
+      field :page_index, -> { Integer }, optional: true, nullable: false, api_name: "pageIndex"
+
+      field :page_size, -> { Integer }, optional: true, nullable: false, api_name: "pageSize"
+
+      field :total_count, -> { Integer }, optional: true, nullable: false, api_name: "totalCount"
+
+      field :items, -> { Internal::Types::Array[Mailhub::Types::CampaignModel] }, optional: true, nullable: false
+    end
+  end
+end

data/lib/Mailhub/types/campaign_segment_model.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Mailhub
+  module Types
+    # 캠페인의 대상 세그먼트 정보
+    class CampaignSegmentModel < Internal::Types::Model
+      field :id, -> { Integer }, optional: true, nullable: false
+
+      field :code, -> { String }, optional: true, nullable: false
+
+      field :name, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/Mailhub/types/campaign_status.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Mailhub
+  module Types
+    module CampaignStatus
+      extend Mailhub::Internal::Types::Enum
+
+      DRAFT = "Draft"
+      SCHEDULED = "Scheduled"
+      PREPARE = "Prepare"
+      RUNNING = "Running"
+      PAUSED = "Paused"
+      FINISHED = "Finished"
+      CANCELLED = "Cancelled"
+    end
+  end
+end

data/lib/Mailhub/types/campaign_type.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Mailhub
+  module Types
+    module CampaignType
+      extend Mailhub::Internal::Types::Enum
+
+      MARKETING = "Marketing"
+      OPERATIONAL = "Operational"
+    end
+  end
+end

data/lib/Mailhub/types/contact_import_job_model.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Mailhub
+  module Types
+    # 연락처 가져오기 작업 진행 상태
+    class ContactImportJobModel < Internal::Types::Model
+      field :job_id, -> { String }, optional: true, nullable: false, api_name: "jobId"
+
+      field :status, -> { Mailhub::Types::ContactImportStatus }, optional: true, nullable: false
+
+      field :total_rows, -> { Integer }, optional: true, nullable: false, api_name: "totalRows"
+
+      field :processed_rows, -> { Integer }, optional: true, nullable: false, api_name: "processedRows"
+
+      field :imported_count, -> { Integer }, optional: true, nullable: false, api_name: "importedCount"
+
+      field :updated_count, -> { Integer }, optional: true, nullable: false, api_name: "updatedCount"
+
+      field :errors, -> { Internal::Types::Array[Mailhub::Types::ImportContactErrorModel] }, optional: true, nullable: false
+    end
+  end
+end

data/lib/Mailhub/types/contact_import_model.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Mailhub
+  module Types
+    # 연락처 가져오기 작업 접수 결과
+    class ContactImportModel < Internal::Types::Model
+      field :job_id, -> { String }, optional: true, nullable: false, api_name: "jobId"
+    end
+  end
+end