notion_ruby_mapping 3.0.5 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 129deebb939e145eb0c9adc431cbec81edb0d67cbefca8f38dfb7e2550a221b4
-  data.tar.gz: f82b0f5d77b8de97d0e31cd8f2cb583ba8ce80e58c68b9698359600e59b221e4
+  metadata.gz: 9dad5c3579a84ff3dd64c56a20d58e1c8bdcd605d6d956b7a97f3a6120bee28a
+  data.tar.gz: fffec11062ce3e152350cda495ad33b13baf2697abb7db308b4755e66710654e
 SHA512:
-  metadata.gz: 9bf2499aa0a6f91b97206325534eeb1bafa027727b1bc5a24798ad7c6fc7040aa3e24e84c02179f9916994c2bb59ba60600f3e7d7faaedeb5c61a721fd0e5d33
-  data.tar.gz: 624eb4a6364d528ceb413b7dda9dd946d41d72914372545f51c8785df4f654a9ee138615aac56d409b2f781ecc3d3933cbc14fa132943903a7a5841d5669a49a
+  metadata.gz: bc60d84f2634660338b0ffee697539e9063b4e46e079c5a107724f1acd782e466bbc27b80561b710dcaf2a9878194a5b0a77bcf52edf4028e142d3b24a636767
+  data.tar.gz: d7e39e143665cd7c51ebd8008e727aacdaee9ee936f043017c7e163b4db078c253a189dc391baead83061b1ae0656a9c33c5d278e5269e6f2b871a774c061c16

data/README.md

@@ -136,6 +136,7 @@ NotionRubyMapping.configuration { |c| c.notion_token = ENV["NOTION_API_TOKEN"] }
 
 ## 3. ChangeLog
 
+- 2026/1/25 [v3.0.6] add move page, list templates, and create child page to page
 - 2025/12/15 [v3.0.5] add AudioBlock
 - 2025/12/9 [v3.0.4] Fix the issue where page.parent could not be executed for pages with a data source as parent
 - 2025/10/25 [v3.0.3] Add default template option for create_child_page and build_child_page

data/lib/notion_ruby_mapping/blocks/base.rb

@@ -7,11 +7,15 @@ module NotionRubyMapping
     # @param [Hash, nil] json
     # @param [String, nil] id
     # @param [Array<Property, Class, String>] assign
-    def initialize(json: nil, id: nil, assign: [], parent: nil, template_page: nil)
+    # @param [Block, nil] parent
+    # @param [String, nil] template_page
+    # @param [String, nil] position
+    # @param [String, nil] markdown
+    def initialize(json: nil, id: nil, assign: [], parent: nil, template_page: nil, position: nil, markdown: nil)
       @nc = NotionCache.instance
       @json = json
       @id = @nc.hex_id(id || @json && @json["id"])
-      @archived = @json && @json["archived"]
+      @in_trash = @json && @json["in_trash"]
       @has_children = @json && @json["has_children"]
       @new_record = true unless parent.nil?
       raise StandardError, "Unknown id" if !is_a?(List) && !is_a?(Block) && @id.nil? && parent.nil?
@@ -23,6 +27,12 @@ module NotionRubyMapping
       elsif template_page
         payload_json["template"] = {"type" => "template_id", "template_id" => template_page.id}
       end
+      if %w[page_start page_end].include? position
+        payload_json["position"] = {"type" => position}
+      elsif position
+        payload_json["position"] = {"type" => "after_block", "after_block" => {"id" => position}}
+      end
+      payload_json["markdown"] = markdown if markdown
       @payload = Payload.new(payload_json)
       @property_cache = nil
       @created_time = nil
@@ -32,13 +42,13 @@ module NotionRubyMapping
       assign.each_slice(2) { |(klass, key)| assign_property(klass, key) }
       @json ||= {}
     end
-    attr_reader :json, :id, :archived, :has_children
+    attr_reader :json, :id, :in_trash, :has_children
 
     # @param [Hash, Notion::Messages] json
     # @return [NotionRubyMapping::Base]
     def self.create_from_json(json)
       case json["object"]
-      when "page"
+      when "page", "page_markdown"
         Page.new json: json
       when "data_source"
         DataSource.new json: json
@@ -135,12 +145,12 @@ module NotionRubyMapping
     end
 
     # @param [Array<Block>] blocks
-    # @param [String, nil] after block id of previous block
+    # @param [String, nil] position block id of previous block, start, or end
     # @param [Boolean] dry_run true if dry_run
     # @return [NotionRubyMapping::Block, String]
     # @see https://www.notion.so/hkob/Page-d359650e3ca94424af8359a24147b9a0#44bbf83d852c419485c5efe9fe1558fb
     # @see https://www.notion.so/hkob/Block-689ad4cbff50404d8a1baf67b6d6d78d#2c47f7fedae543cf8566389ba1677132
-    def append_block_children(*blocks, after: nil, dry_run: false)
+    def append_block_children(*blocks, position: nil, dry_run: false)
       raise StandardError, "This block can have no children." unless page? || (block? && can_have_children)
 
       only_one = blocks.length == 1
@@ -150,7 +160,11 @@ module NotionRubyMapping
           block.block_json
         end,
       }
-      json["after"] = after if after
+      if %w[start end].include? position
+        json["position"] = {"type" => position}
+      elsif position
+        json["position"] = {"type" => "after_block", "after_block" => {"id" => position}}
+      end
       if dry_run
         path = @nc.append_block_children_page_path(id)
         self.class.dry_run_script :patch, path, json
@@ -261,6 +275,11 @@ module NotionRubyMapping
       @last_edited_time ||= LastEditedTimeProperty.new("__timestamp__", json: self["last_edited_time"])
     end
 
+    # @return [String]
+    def markdown
+      @json && @json["markdown"]
+    end
+
     # @return [Boolean] true if new record
     # @see https://www.notion.so/hkob/Page-d359650e3ca94424af8359a24147b9a0#307af6e40d3840c59f8a82513a572d51
     def new_record?

data/lib/notion_ruby_mapping/blocks/block.rb

@@ -34,6 +34,7 @@ module NotionRubyMapping
           heading_1: Heading1Block,
           heading_2: Heading2Block,
           heading_3: Heading3Block,
+          heading_4: Heading4Block,
           image: ImageBlock,
           link_preview: LinkPreviewBlock,
           link_to_page: LinkToPageBlock,
@@ -53,6 +54,7 @@ module NotionRubyMapping
           heading_1: ToggleHeading1Block,
           heading_2: ToggleHeading2Block,
           heading_3: ToggleHeading3Block,
+          heading_4: ToggleHeading4Block,
         },
       }
       @klass = @type2class[has_children][type.to_sym] || @type2class[false][type.to_sym] || Block
@@ -80,7 +82,7 @@ module NotionRubyMapping
     # @return [NotionRubyMapping::Block, String]
     # @param [Array<Block>] blocks
     def append_after(*blocks, dry_run: false)
-      parent.append_block_children(*blocks, after: id, dry_run: dry_run)
+      parent.append_block_children(*blocks, position: id, dry_run: dry_run)
     end
 
     # @param [Boolean] not_update false when update
@@ -88,7 +90,7 @@ module NotionRubyMapping
     def block_json(not_update: true)
       ans = {"type" => type}
       ans["object"] = "block"
-      ans["archived"] = true if @archived
+      ans["in_trash"] = true if @in_trash
       ans
     end
 

data/lib/notion_ruby_mapping/blocks/data_source.rb

@@ -40,9 +40,12 @@ module NotionRubyMapping
     # @param [Array<Property, Class, String>] assign
     # @return [NotionRubyMapping::Base]
     # @see https://www.notion.so/hkob/DataSource-1462b24502424539a4231bedc07dc2f5#c217ce78020a4de79b720790fce3092d
-    def build_child_page(*assign, template_page: nil)
+    # @param [String, NilClass] template_page
+    # @param [String, NilClass] markdown
+    def build_child_page(*assign, template_page: nil, markdown: nil)
       assign = properties.map { |p| [p.class, p.name] }.flatten if assign.empty?
-      page = Page.new assign: assign, parent: {"data_source_id" => @id}, template_page: template_page
+      page = Page.new assign: assign, parent: {"data_source_id" => @id}, template_page: template_page,
+                      markdown: markdown
       pp = page.properties
       pp.clear_will_update
       yield page, pp if block_given?
@@ -50,12 +53,15 @@ module NotionRubyMapping
     end
 
     # @param [Array<Property, Class, String>] assign
+    # @param [String, NilClass] template_page
+    # @param [String, NilClass] markdown
     # @param [Boolean] dry_run true if dry_run
     # @return [NotionRubyMapping::Base]
     # @see https://www.notion.so/hkob/DataSource-1462b24502424539a4231bedc07dc2f5#c217ce78020a4de79b720790fce3092d
-    def create_child_page(*assign, template_page: nil, dry_run: false)
+    def create_child_page(*assign, template_page: nil, markdown: nil, dry_run: false)
       assign = properties.map { |p| [p.class, p.name] }.flatten if assign.empty?
-      page = Page.new assign: assign, parent: {"data_source_id" => @id}, template_page: template_page
+      page = Page.new assign: assign, parent: {"data_source_id" => @id}, template_page: template_page,
+                      markdown: markdown
       pp = page.properties
       pp.clear_will_update
       yield page, pp if block_given?
@@ -126,6 +132,13 @@ module NotionRubyMapping
       self
     end
 
+    # @param [Integer] page_size
+    # @return [NotionRubyMapping::List] List of Template object
+    def templates(page_size: nil)
+      json = @nc.list_data_source_templates_request(id, page_size: page_size)
+      List.new type: "template", value: id, json: json, query: Query.new
+    end
+
     # @return [Hash] created json for property schemas (for update data_source)
     def update_property_schema_json
       @payload.update_property_schema_json @property_cache, data_source_title

data/lib/notion_ruby_mapping/blocks/heading4_block.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Notion block
+  class Heading4Block < TextSubBlockColorBaseBlock
+    # @param [RichTextArray, String, Array<String>, RichTextObject, Array<RichTextObject>] text_info
+    # @param [String] color
+    def initialize(text_info = nil, color: nil, json: nil, id: nil, parent: nil)
+      super(text_info, color: color, json: json, id: id, parent: parent)
+      @can_have_children = false
+    end
+
+    # @return [String]
+    def type
+      "heading_4"
+    end
+
+    # @param [Boolean] not_update false when update
+    # @return [Hash{String (frozen)->Hash}]
+    def block_json(not_update: true)
+      ans = super
+      ans[type]["is_toggleable"] = false
+      ans
+    end
+  end
+end

data/lib/notion_ruby_mapping/blocks/list.rb

@@ -23,6 +23,8 @@ module NotionRubyMapping
         @user_object = value
       when "search"
         @search = value
+      when "template"
+        @template = value
       end
       @query = query
       @index = 0
@@ -82,6 +84,11 @@ module NotionRubyMapping
                  query: -> { @nc.search @search.payload.merge(@query.query_json) },
                  create_object: ->(json) { Base.create_from_json json },
                  &block
+      elsif @template
+        each_sub base: @template,
+                 query: -> { @nc.list_data_source_templates_request @template, start_cursor: @query.start_cursor },
+                 create_object: ->(json) { TemplateObject.new json: json },
+                 &block
       end
       self
     end
@@ -125,7 +132,7 @@ module NotionRubyMapping
 
     # @return [Hash]
     def results
-      @json["results"]
+      @json[@template ? "templates" : "results"]
     end
   end
 end

data/lib/notion_ruby_mapping/blocks/page.rb

@@ -59,11 +59,80 @@ module NotionRubyMapping
       db.save dry_run: dry_run
     end
 
+    # @return [NotionRubyMapping::Base]
+    # @param [String, NilClass] template_page
+    # @param [String, NilClass] position
+    # @param [String, NilClass] markdown
+    def build_child_page(template_page: nil, position: nil, markdown: nil)
+      page = Page.new assign: [TitleProperty, "title"], parent: {"type" => "page_id", "page_id" => @id},
+                      template_page: template_page, position: position, markdown: markdown
+      pp = page.properties
+      pp.clear_will_update
+      yield page, pp if block_given?
+      page
+    end
+
+    # @param [Boolean] dry_run true if dry_run
+    # @return [NotionRubyMapping::Base]
+    # @param [String, NilClass] template_page
+    # @param [String, NilClass] position
+    # @param [String, NilClass] markdown
+    def create_child_page(template_page: nil, position: nil, markdown: nil, dry_run: false)
+      page = Page.new assign: [TitleProperty, "title"], parent: {"type" => "page_id", "page_id" => @id},
+                      template_page: template_page, position: position, markdown: markdown
+      pp = page.properties
+      pp.clear_will_update
+      yield page, pp if block_given?
+      page.save dry_run: dry_run
+    end
+
+    # @param [String] markdown
+    # @param [String, NilClass] after
+    # @param [Boolean] dry_run
+    # @return [String, NotionRubyMapping::Base]
+    def insert_markdown(markdown, after: nil, dry_run: false)
+      json = {"type" => "insert_content", "insert_content" => {"content" => markdown}}
+      json["insert_content"]["after"] = after if after
+      if dry_run
+        self.class.dry_run_script :patch, @nc.markdown_page_path(@id), json
+      else
+        update_json @nc.markdown_page_request(@id, json)
+      end
+    end
+
+    # @param [Page, DataSource] page_or_data_source
+    # @param [Boolean] dry_run true if dry_run
+    # @return [NotionRubyMapping::Page, String]
+    def move_to(page_or_data_source, dry_run: false)
+      key = page_or_data_source.is_a?(Page) ? "page_id" : "data_source_id"
+      json = {"parent" => {"type" => key, key => page_or_data_source.id}}
+      if dry_run
+        self.class.dry_run_script :post, @nc.move_page_path(@id), json
+      else
+        update_json @nc.move_page_request(@id, json)
+      end
+    end
+
     # @return [String] 公開URL
     def public_url
       @json["public_url"]
     end
 
+    # @param [String] replace
+    # @param [String] replace_range
+    # @param [Boolean] dry_run
+    # @return [String, NotionRubyMapping::Base]
+    def replace_markdown(replace, replace_range, allow_deleting_content: nil, dry_run: false)
+      json = {"type" => "replace_content_range",
+              "replace_content_range" => {"content" => replace, "content_range" => replace_range}}
+      json["replace_content_range"]["allow_deleting_content"] = true if allow_deleting_content
+      if dry_run
+        self.class.dry_run_script :patch, @nc.markdown_page_path(@id), json
+      else
+        update_json @nc.markdown_page_request(@id, json)
+      end
+    end
+
     # @return [String] title
     # @see https://www.notion.so/hkob/Page-d359650e3ca94424af8359a24147b9a0#2ff7209055f346fbbda454cdbb40b1c8
     def title

data/lib/notion_ruby_mapping/blocks/toggle_heading4_block.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module NotionRubyMapping
+  # Notion block
+  class ToggleHeading4Block < TextSubBlockColorBaseBlock
+    # @return [String]
+    def type
+      "heading_4"
+    end
+
+    # @param [Boolean] not_update false when update
+    # @return [Hash{String (frozen)->Hash}]
+    def block_json(not_update: true)
+      ans = super
+      ans[type]["is_toggleable"] = true
+      ans
+    end
+  end
+end

data/lib/notion_ruby_mapping/controllers/notion_cache.rb

@@ -243,6 +243,51 @@ module NotionRubyMapping
       "NotionCache"
     end
 
+    # @param [String] data_source_id
+    # @param [Integer] page_size
+    # @param [String] start_cursor
+    # @return [Hash] response hash
+    def list_data_source_templates_request(data_source_id, page_size: nil, start_cursor: nil)
+      options = []
+      options << "page_size=#{page_size}" if page_size
+      options << "start_cursor=#{start_cursor}" if start_cursor
+      option_str = options.empty? ? "" : "?" + options.join("&")
+      request :get, list_data_source_templates_path(data_source_id, option_str)
+    end
+
+    # @param [String] data_source_id
+    # @param [String] options
+    # @return [String] path
+    def list_data_source_templates_path(data_source_id, options = "")
+      "v1/data_sources/#{data_source_id}/templates#{options}"
+    end
+
+    # @param [String] page_id
+    # @return [String] path
+    def markdown_page_path(page_id)
+      "v1/pages/#{page_id}/markdown"
+    end
+
+    # @param [String] page_id
+    # @param [Hash] payload
+    # @return [Hash] response hash
+    def markdown_page_request(page_id, payload)
+      request :patch, markdown_page_path(page_id), payload
+    end
+
+    # @param [String] page_id
+    # @param [Hash] payload
+    # @return [Hash] response hash
+    def move_page_request(page_id, payload)
+      request :post, move_page_path(page_id), payload
+    end
+
+    # @param [String] page_id
+    # @return [String] move_page_path
+    def move_page_path(page_id)
+      "v1/pages/#{page_id}/move"
+    end
+
     # @param [String] path
     # @param [String] fname
     # @param [Hash] options
@@ -427,7 +472,7 @@ module NotionRubyMapping
       request :get, user_path(user_id)
     end
 
-    # @return [Array<NotionRubyMapping::UserObject>] UserObject array
+    # @return [NotionRubyMapping::ListObject] List Object for UserObject
     def users
       List.new json: users_request, type: "user_object", value: true
     end

data/lib/notion_ruby_mapping/objects/template_object.rb

@@ -0,0 +1,19 @@
+module NotionRubyMapping
+  class TemplateObject
+    def initialize(json: json)
+      @id = json["id"]
+      @name = json["name"]
+      @is_default = json["is_default"]
+    end
+    attr_reader :id, :name, :is_default
+
+    # @return [Hash{String->String, Boolean}]
+    def property_values_json
+      {
+        "id" => @id,
+        "name" => @name,
+        "is_default" => @is_default
+      }
+    end
+  end
+end

data/lib/notion_ruby_mapping/properties/property.rb

@@ -157,7 +157,7 @@ module NotionRubyMapping
       !instance_of? Property
     end
 
-    # @param [Symbol] key query parameter
+    # @param [String] key query parameter
     # @param [Object] value query value
     # @return [NotionRubyMapping::Query] generated Query object
     def make_filter_query(key, value, condition: nil, another_type: nil)

data/lib/notion_ruby_mapping/properties/verification_property.rb

@@ -30,6 +30,17 @@ module NotionRubyMapping
       @json = json
     end
 
+    ## DataSource only methods
+
+    # @param [String, Number] value Query value
+    # @param [String] condition rollup Rollup name
+    # @param [String] another_type rollup_type Rollup type
+    # @return [NotionRubyMapping::Query] generated Query object
+    # @see https://www.notion.so/hkob/CheckboxProperty-ac1edbdb8e264af5ad1432b522b429fd#5f07c4ebc4744986bfc99a43827349fc
+    def filter_status(value, condition: nil, another_type: nil)
+      make_filter_query "status", value, condition: condition, another_type: another_type
+    end
+
     ## Page property only methods
 
     # @return [Hash]

data/lib/notion_ruby_mapping/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module NotionRubyMapping
-  VERSION = "3.0.5"
-  NOTION_VERSION = "2025-09-03"
+  VERSION = "4.0.0"
+  NOTION_VERSION = "2026-03-11"
 end

data/lib/notion_ruby_mapping.rb

@@ -11,11 +11,11 @@ require_relative "notion_ruby_mapping/version"
              image_block toggle_heading1_block toggle_heading2_block toggle_heading3_block url_base_block
              link_preview_block link_to_page_block numbered_list_item_block paragraph_block pdf_block quote_block
              synced_block table_block table_row_block table_of_contents_block to_do_block
-             toggle_block video_block audio_block],
+             toggle_block video_block audio_block heading4_block toggle_heading4_block],
   controllers: %w[notion_cache payload property_cache query rich_text_array discussion_thread search mermaid
                   mermaid_data_source],
   objects: %w[rich_text_object emoji_object equation_object file_object mention_object text_object user_object
-              comment_object file_upload_object],
+              comment_object file_upload_object template_object],
   properties: %w[property checkbox_property multi_property created_by_property date_base_property created_time_property
                  date_property email_property files_property formula_property last_edited_by_property
                  last_edited_time_property multi_select_property number_property people_property phone_number_property

data/notion_ruby_mapping.gemspec

@@ -38,6 +38,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency "faraday-multipart"
   spec.add_dependency "mime-types"
 
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rb-readline"
   spec.add_development_dependency "guard"
   spec.add_development_dependency "guard-rspec"
   spec.add_development_dependency "rake"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: notion_ruby_mapping
 version: !ruby/object:Gem::Version
-  version: 3.0.5
+  version: 4.0.0
 platform: ruby
 authors:
 - Hiroyuki KOBAYASHI
@@ -51,6 +51,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-readline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -200,6 +242,7 @@ files:
 - lib/notion_ruby_mapping/blocks/heading1_block.rb
 - lib/notion_ruby_mapping/blocks/heading2_block.rb
 - lib/notion_ruby_mapping/blocks/heading3_block.rb
+- lib/notion_ruby_mapping/blocks/heading4_block.rb
 - lib/notion_ruby_mapping/blocks/image_block.rb
 - lib/notion_ruby_mapping/blocks/link_preview_block.rb
 - lib/notion_ruby_mapping/blocks/link_to_page_block.rb
@@ -219,6 +262,7 @@ files:
 - lib/notion_ruby_mapping/blocks/toggle_heading1_block.rb
 - lib/notion_ruby_mapping/blocks/toggle_heading2_block.rb
 - lib/notion_ruby_mapping/blocks/toggle_heading3_block.rb
+- lib/notion_ruby_mapping/blocks/toggle_heading4_block.rb
 - lib/notion_ruby_mapping/blocks/url_base_block.rb
 - lib/notion_ruby_mapping/blocks/url_caption_base_block.rb
 - lib/notion_ruby_mapping/blocks/video_block.rb
@@ -238,6 +282,7 @@ files:
 - lib/notion_ruby_mapping/objects/file_upload_object.rb
 - lib/notion_ruby_mapping/objects/mention_object.rb
 - lib/notion_ruby_mapping/objects/rich_text_object.rb
+- lib/notion_ruby_mapping/objects/template_object.rb
 - lib/notion_ruby_mapping/objects/text_object.rb
 - lib/notion_ruby_mapping/objects/user_object.rb
 - lib/notion_ruby_mapping/properties/button_property.rb
@@ -289,7 +334,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.0
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Notion Ruby mapping tool
 test_files: []