notion_ruby_mapping 0.2.3 → 0.3.0

data/README.md

@@ -6,15 +6,10 @@ Development note is here. → [Idea note of "notion_ruby_mapping"](https://www.n
 
 ## Table of Contents
 
-- [notion_ruby_mapping](#notion_ruby_mapping)
+- [notion\_ruby\_mapping](#notion_ruby_mapping)
   - [Table of Contents](#table-of-contents)
   - [1. Installation](#1-installation)
   - [2. Example code](#2-example-code)
-    - [2.1 Set icon to all icon unsettled pages](#21-set-icon-to-all-icon-unsettled-pages)
-    - [2.2 Renumbering pages](#22-renumbering-pages)
-    - [2.3 Change title](#23-change-title)
-      - [Pattern 1 (replace existing text partially)](#pattern-1-replace-existing-text-partially)
-      - [Pattern 2 (replace all text)](#pattern-2-replace-all-text)
   - [3. Preparation](#3-preparation)
     - [3.1 Create a New Integration](#31-create-a-new-integration)
     - [3.2 Create client](#32-create-client)
@@ -29,8 +24,13 @@ Development note is here. → [Idea note of "notion_ruby_mapping"](https://www.n
       - [4.2.2 Query a database](#422-query-a-database)
         - [4.2.2.1 Complex conditions](#4221-complex-conditions)
         - [4.2.2.2 Sort criteria](#4222-sort-criteria)
+        - [4.2.2.3 Dry run sample](#4223-dry-run-sample)
       - [4.2.3 Create child page](#423-create-child-page)
-      - [4.2.4 Update database](#424-update-database)
+      - [4.2.4 Create database](#424-create-database)
+      - [4.2.5 Update database properties](#425-update-database-properties)
+      - [4.2.6 Add a database property](#426-add-a-database-property)
+      - [4.2.7 Rename a database property](#427-rename-a-database-property)
+      - [4.2.8 Remove database properties](#428-remove-database-properties)
     - [4.3 List class](#43-list-class)
     - [4.4 Block class](#44-block-class)
     - [4.5 Property classes](#45-property-classes)
@@ -47,14 +47,30 @@ Development note is here. → [Idea note of "notion_ruby_mapping"](https://www.n
         - [4.5.3.7 PeopleProperty](#4537-peopleproperty)
         - [4.5.3.8 TitleProperty, RichTextProperty](#4538-titleproperty-richtextproperty)
         - [4.5.3.9 CheckboxProperty](#4539-checkboxproperty)
-        - [4.5.3.10 EmailProperty](#45310-emailproperty)
-        - [4.5.3.11 FilesProperty](#45311-filesproperty)
-        - [4.5.3.12 RelationProperty](#45312-relationproperty)
-  - [5. XXXObjects](#5-xxxobjects)
+        - [4.5.3.10 FilesProperty](#45310-filesproperty)
+        - [4.5.3.11 RelationProperty](#45311-relationproperty)
+      - [4.5.4 create or update values for Database properties](#454-create-or-update-values-for-database-properties)
+        - [4.5.4.1 NumberProperty](#4541-numberproperty)
+        - [4.5.4.2 SelectProperty](#4542-selectproperty)
+        - [4.5.4.3 MultiSelectProperty](#4543-multiselectproperty)
+        - [4.5.4.4 DateProperty](#4544-dateproperty)
+        - [4.5.4.4 UrlProperty](#4544-urlproperty)
+        - [4.5.4.5 EmailProperty](#4545-emailproperty)
+        - [4.5.4.6 PhoneNumberProperty](#4546-phonenumberproperty)
+        - [4.5.4.7 PeopleProperty](#4547-peopleproperty)
+        - [4.5.4.8 TitleProperty, RichTextProperty](#4548-titleproperty-richtextproperty)
+        - [4.5.4.9 CheckboxProperty](#4549-checkboxproperty)
+        - [4.5.4.10 FilesProperty](#45410-filesproperty)
+        - [4.5.4.11 RelationProperty](#45411-relationproperty)
+        - [4.5.4.12 RollupProperty](#45412-rollupproperty)
+  - [5. XXXObjects and RichTextArray](#5-xxxobjects-and-richtextarray)
     - [5.1 RichTextObject](#51-richtextobject)
     - [5.2 TextObject](#52-textobject)
     - [5.3 MentionObject](#53-mentionobject)
     - [5.4 UserObject](#54-userobject)
+    - [5.5 RichTextArray](#55-richtextarray)
+      - [5.5.1 Constructor for RichTextArray](#551-constructor-for-richtextarray)
+      - [5.5.2 Instance methods](#552-instance-methods)
   - [6. ChangeLog](#6-changelog)
   - [7. Contributing](#7-contributing)
   - [8. License](#8-license)
@@ -83,76 +99,9 @@ gem install notion_ruby_mapping
 
 ## 2. Example code
 
-### 2.1 Set icon to all icon unsettled pages
-
-The following code sets a "💿" icon on all unset pages in the database.
-
-```Ruby
-require "notion_ruby_mapping"
-
-include NotionRubyMapping
-
-token = ENV["NOTION_API_TOKEN"]
-database_id = ENV["DATABASE_ID"]
-
-NotionCache.instance.create_client token
-
-db = Database.new id: database_id
-db.query_database.each do |page|
-  unless page.icon
-    page.set_icon(emoji: "💿")
-    page.save
-    p page.id
-  end
-end
-```
-
-|Before execution|After execution|
-|---|---|
-|![Before execution](images/pre_set_icon.png)|![After execution](images/post_set_icon.png)|
-
-### 2.2 Renumbering pages
-
-The following code sets serial numbers to the pages whose title is not empty in ascending order of titles.
-
-```Ruby
-db = Database.new id: database_id, assign: [RichTextProperty, "TextTitle"]
-tp = db.properties["TextTitle"]
-query = tp.filter_is_not_empty.ascending(tp)
-db.query_database(tp.filter_is_not_empty.ascending(tp)).each.with_index(1) do |page, index|
-  page.properties["NumberTitle"].number = index
-  page.save
-end
-```
-
-| After execution                               |
-|-----------------------------------------------|
-| ![After exuecution](images/serial_number.png) |
-
-### 2.3 Change title
-
-The following code update the page title.
-
-#### Pattern 1 (replace existing text partially)
-
-```Ruby
-page = Page.find page_id # API access
-print page.title # -> ABC\nDEF
-tp = page.properties["Title"]
-tp[1].text = "GHI"
-page.save # API access
-print page.title # -> ABC\nGHI
-```
-
-#### Pattern 2 (replace all text)
-
-```Ruby
-page = Page.new id: page_id, assign: [TitleProperty, "Title"]
-tp = page.properties["Title"]
-tp << TextObject.new("JKL")
-page.save # API access
-print page.title # -> JKL
-```
+1. [Set icon to all icon unsettled pages](examples/set_icon_to_all_icon_unsettled_pages.md)
+1. [Renumbering pages](examples/renumbering_pages.md)
+1. [Change title](examples/change_title.md)
 
 ## 3. Preparation
 
@@ -165,24 +114,34 @@ Please check [Notion documentation](https://developers.notion.com/docs#getting-s
 Please create a client (notion-ruby-client) before you use the following class.
 
 ```Ruby
-NotionCache.instance.create_client ENV["NOTION_API_TOKEN"]
+NotionCache.instance.create_client "Secret_XXXXXXXXXXXXXXXXXXXX" # write directly
+NotionCache.instance.create_client ENV["NOTION_API_TOKEN"] # from environment
 ```
 
 ## 4. Usage
 
+From v0.3.0, `find`, `save` and `query_database` methods can set `dry_run: true` option.  When this option is set, these methods create create a shell script for verification instead of calling the Notion API.  Some sample codes show the results of dry_run in order to make it easy to understand what the method runs.
+
 ### 4.1 Page
 
 #### 4.1.1 Retrieve a page
 
-`Page.find(id)` creates a Page object with `retrieving page API`.
-The created object has page information generated from the JSON response.
+`Page.find(id)` creates a Page object with `retrieving page API`.  The created object has page information generated from the JSON response.
 
 ```Ruby
 page = Page.find "c01166c6-13ae-45cb-b968-18b4ef2f5a77" # Notion API call
 ```
 
-`Page.new(id)` creates a Page object without the Notion API.
-Since Page.new does not acquire property information, so you need to assign yourself.
+- result of dry run
+```bash
+#!/bin/sh
+curl  'https://api.notion.com/v1/pages/c01166c6-13ae-45cb-b968-18b4ef2f5a77'\
+  -H 'Notion-Version: 2022-02-22'\
+  -H 'Authorization: Bearer '"$NOTION_API_KEY"''\
+  -H 'Content-Type: application/json'⏎
+```
+
+`Page.new(id)` creates a Page object without the Notion API.  Since Page.new does not acquire property information, so you need to assign yourself.
 
 ```Ruby
 # Assign some properties for update manually
@@ -193,17 +152,14 @@ page = Page.new id: "c01166c6-13ae-45cb-b968-18b4ef2f5a77",
 
 #### 4.1.2 Update page properties
 
-Page properties with values can be obtained from the retrieved page using `find`.
-On the other hand, Page properties without values can be obtained from the property assigned page.
+Page properties with values can be obtained from the retrieved page using `find`.  On the other hand, Page properties without values can be obtained from the property assigned page.
 
 ```Ruby
 tp = page.properties["Title"] # TitleProperty
 np = page.properties["Number"] # NumberProperty
 ```
 
-Each property object can change values using corresponded methods.
-After changing value, `will_update` flag of the property object also set to true.
-These methods are explained in the section of each property object class.
+Each property object can change values using corresponded methods.  After changing value, `will_update` flag of the property object also set to true.  These methods are explained in the section of each property object class.
 
 ```Ruby
 to = tp[1] # TitleProperty has Array of TextObject
@@ -211,21 +167,20 @@ to.text = "ABC" # TextObject can set text by ".text="
 # or tp[1].text = "ABC"
 
 np.number = 3.14159
-page.save # Notion API call
 ```
 
 After update some properties, `page.save` method sends `Notion API` and replace the page information using the response of API.
 
 ```Ruby
-page.update # Notion API call
+page.save # Notion API call
 ```
 
 #### 4.1.3 Update other page information
 
 `page.set_icon` can change the page icon using emoji or external url.
 
-[Breaking change on v0.2.2] `page.set_icon` has no longer calling the Notion API.
-Please use `page.save` after `page.set_icon` if you want to update or create the page.
+[Breaking change on v0.2.2]
+`page.set_icon` has no longer calling the Notion API.  Please use `page.save` after `page.set_icon` if you want to update or create the page.
 
 ```Ruby
 # both methods call Notion API
@@ -238,7 +193,9 @@ obj.save
 
 #### 4.1.4 other methods
 
+- `Page.find id, dry_run: true` create shell script for verification.
 - `page.save` call Notion API, and so on and replace object information.
+- `page.save dry_run: true` create shell script for verification.
 - `page.new_record?` returns true if the page was generated by `create_child_page`.
 - `page.title` returns plain_text string of `Title`.
 - `page.icon` returns JSON hash for the page icon.
@@ -248,15 +205,22 @@ obj.save
 
 #### 4.2.1 Retrieve a database
 
-`Database.find(id)` creates a Database object with `retrieving database API`.
-The created object has database information generated from the JSON response.
+`Database.find(id)` creates a Database object with `retrieving database API`.  The created object has database information generated from the JSON response.
 
 ```Ruby
-db = Database.find("c37a2c66-e3aa-4a0d-a447-73de3b80c253") # Notion API call
+db = Database.find "c37a2c66-e3aa-4a0d-a447-73de3b80c253" # Notion API call
+```
+
+```bash
+# result of dry run
+#!/bin/sh
+curl  'https://api.notion.com/v1/databases/c37a2c66-e3aa-4a0d-a447-73de3b80c253'\
+  -H 'Notion-Version: 2022-02-22'\
+  -H 'Authorization: Bearer '"$NOTION_API_KEY"''\
+  -H 'Content-Type: application/json'⏎
 ```
 
-`Database.new(id)` creates a Database object without the Notion API.
-Since Database.new does not acquire property information, so you need to assign yourself.
+`Database.new(id)` creates a Database object without the Notion API.  Since Database.new does not acquire property information, so you need to assign yourself.
 
 ```Ruby
 # assign some properties for update manually
@@ -266,8 +230,7 @@ db = Database.new id: "c37a2c66-e3aa-4a0d-a447-73de3b80c253",
 
 #### 4.2.2 Query a database
 
-`db.query_database` obtains a List object with Page objects contained in the database.
-You can obtain filtered and ordered pages using Query object.
+`db.query_database` obtains a List object with Page objects contained in the database.  You can obtain filtered and ordered pages using Query object.
 
 ```Ruby
 # query_database method calls Notion API
@@ -275,11 +238,9 @@ db.query_database # retrieves all pages (no filter, no sort)
 db.query_database query # retrieves using query
 ```
 
-The query object can be generated from the Property objects included in the database object.
-The Property object can be obtained from the retrieved or assigned database object like as the Page object.
+The query object can be generated from the Property objects included in the database object.  The Property object can be obtained from the retrieved or assigned database object like as the Page object.
 
-`filter_xxxx` methods of the property objects generates a query object.
-These methods are explained in the section of each property object class.
+`filter_xxxx` methods of the property objects generates a query object.  These methods are explained in the section of each property object class.
 
 ```Ruby
 tp = db.properties["Title"]
@@ -289,8 +250,7 @@ pages = db.query_database query
 
 ##### 4.2.2.1 Complex conditions
 
-Complex filters can be generated `and` / `or` methods of the Query object.
-Here are some sample scripts and the json parameters created from them.
+Complex filters can be generated `and` / `or` methods of the Query object.  Here are some sample scripts and the json parameters created from them.
 
 ```Ruby
 # Prepare some sample properties
@@ -500,8 +460,7 @@ query7 = np.filter_greater_than(100).and(np.filter_less_than(200))
 
 ##### 4.2.2.2 Sort criteria
 
-Sort criteria can be appended to an existing query object.
-If you don't use the previous filters, you can generate by `Query.new`.
+Sort criteria can be appended to an existing query object.  If you don't use the previous filters, you can generate by `Query.new`.
 
 - sort criteria only
 
@@ -543,10 +502,30 @@ query13 = tp.filter_starts_with("A").ascending(tp)
 [{"property" => "tp", "direction" => "ascending"}]
 ```
 
+##### 4.2.2.3 Dry run sample
+
+This is a sample script for query database.  If dry_run flag is set, you can see the verification shell script.
+
+```Ruby
+db = Database.new id: tc.database_id, assign: [NumberProperty, "NumberTitle", UrlProperty, "UrlTitle"]
+np, up = target.properties.values_at "NumberTitle", "UrlTitle"
+query = np.filter_greater_than(100).and(up.filter_starts_with("https")).ascending(np)
+print db.query_database query, dry_run: true
+# => Result
+# #!/bin/sh
+# curl -X POST 'https://api.notion.com/v1/databases/XXXXX/query'\
+#   -H 'Notion-Version: 2022-02-22'\
+#   -H 'Authorization: Bearer '"$NOTION_API_KEY"''\
+#   -H 'Content-Type: application/json'\
+#   --data '{"filter":{"and":[{"property":"NumberTitle","number":{"greater_than":100}},{"property":"UrlTitle","url":{"starts_with":"https"}}]},"sorts":[{"property":"NumberTitle","direction":"ascending"}],"page_size":100}'⏎
+
+
+```
+
+
 #### 4.2.3 Create child page
 
-`create_child_page` creates a child page object of the database.
-After setting some properties, please call `page.save` to send page information to Notion.
+`create_child_page` creates a child page object of the database.  After setting some properties, please call `page.save` to send page information to Notion.
 
 ```Ruby
 page = db.create_child_page TitleProperty, "Name"
@@ -554,9 +533,138 @@ page.properties["Name"] << "New Page"
 page.save
 ```
 
-#### 4.2.4 Update database
+- result of dry run
+```bash
+#!/bin/sh
+curl -X POST 'https://api.notion.com/v1/pages'\
+  -H 'Notion-Version: 2022-02-22'\
+  -H 'Authorization: Bearer '"$NOTION_API_KEY"''\
+  -H 'Content-Type: application/json'\
+  --data '{"properties":{"Name":{"type":"title","title":[{"type":"text","text":{"content":"New Page","link":null},"plain_text":"New Page","href":null}]}},"parent":{"database_id":"c37a2c66e3aa4a0da44773de3b80c253"}}'⏎
+```
 
-=== under construction ===
+#### 4.2.4 Create database
+
+`create_child_database` method of an existing page creates a child database object.  Some properties of the database can be arrange the option.  Here is a sample script for creating a database that set all types of properties.
+```Ruby
+page = Page.find "a sample page id"
+db = parent_page.create_child_database "New database title",
+                                       CheckboxProperty, "Checkbox",
+                                       CreatedByProperty, "CreatedBy",
+                                       CreatedTimeProperty, "CreatedTime",
+                                       DateProperty, "Date",
+                                       EmailProperty, "Email",
+                                       FilesProperty, "Files",
+                                       FormulaProperty, "Formula",
+                                       LastEditedByProperty, "LastEditedBy",
+                                       LastEditedTimeProperty, "LastEditedTime",
+                                       MultiSelectProperty, "MultiSelect",
+                                       NumberProperty, "Number",
+                                       PeopleProperty, "People",
+                                       PhoneNumberProperty, "PhoneNumber",
+                                       RelationProperty, "Relation",
+                                       RollupProperty, "Rollup",
+                                       RichTextProperty, "RichText",
+                                       SelectProperty, "Select",
+                                       TitleProperty, "Title",
+                                       UrlProperty, "Url"
+fp, msp, np, rp, rup, sp = db.properties.values_at "Formula", "MultiSelect", "Number", "Relation", "Rollup", "Select"
+fp.formula_expression = "now()"
+msp.add_multi_select_options name: "MS1", color: "orange"
+msp.add_multi_select_options name: "MS2", color: "green"
+np.format = "yen"
+rp.replace_relation_database database_id: tc.database_id
+rup.relation_property_name = "Relation"
+rup.rollup_property_name = "NumberTitle"
+rup.function = "sum"
+sp.add_select_options name: "S1", color: "yellow"
+sp.add_select_options name: "S2", color: "default"
+db.set_icon emoji: "🎉"
+db.save
+```
+
+#### 4.2.5 Update database properties
+
+`save` method updates existing database properties.  The database needs to be retrieved using `find` to prevent existing settings from disappearing.
+
+```Ruby
+db = Database.find "c7697137d49f49c2bbcdd6a665c4f921"
+fp, msp, np, rp, rup, sp = db.properties.values_at "Formula", "MultiSelect", "Number", "Relation", "Rollup", "Select"
+fp.formula_expression = "pi"
+msp.add_multi_select_options name: "MS3", color: "blue"
+np.format = "percent"
+rp.replace_relation_database database_id: tc.database_id, synced_property_name: "Renamed table"
+rup.function = "average"
+sp.add_select_options name: "S3", color: "red"
+db.set_icon emoji: "🎉"
+db.database_title << "(Added)"
+db.save
+```
+
+#### 4.2.6 Add a database property
+
+`add_property` can add a database property.
+
+```Ruby
+db = Database.find "c7697137d49f49c2bbcdd6a665c4f921"
+db.add_property NumberProperty, "added number property" do |np|
+  np.format = "euro" # arrange option
+end
+db.add_property UrlProperty, "added url property" # UrlProperty has no option
+db.save
+```
+
+- result of dry run
+
+```bash
+#!/bin/sh
+curl -X PATCH 'https://api.notion.com/v1/databases/c7697137d49f49c2bbcdd6a665c4f921'\
+  -H 'Notion-Version: 2022-02-22'\
+  -H 'Authorization: Bearer '"$NOTION_API_KEY"''\
+  -H 'Content-Type: application/json'\
+  --data '{"properties":{"added number property":{"number":{"format":"euro"}},"added url property":{"url":{}}}}'⏎
+```
+
+#### 4.2.7 Rename a database property
+
+`rename_property` can rename a database property.
+
+```Ruby
+properties = db.properties
+properties["added number property"].new_name = "renamed number property"
+properties["added url property"].new_name = "renamed url property"
+db.save
+```
+
+- result of dry run
+
+```bash
+#!/bin/sh
+curl -X PATCH 'https://api.notion.com/v1/databases/c7697137d49f49c2bbcdd6a665c4f921'\
+  -H 'Notion-Version: 2022-02-22'\
+  -H 'Authorization: Bearer '"$NOTION_API_KEY"''\
+  -H 'Content-Type: application/json'\
+  --data '{"properties":{"added number property":{"name":"renamed number property"},"added url property":{"name":"renamed url property"}}}'
+```
+
+#### 4.2.8 Remove database properties
+
+`remove_properties' can remove some database properties.
+
+```Ruby
+db.remove_property "renamed number property", "renamed url property"
+```
+
+- result of dry run
+
+```bash
+#!/bin/sh
+curl -X PATCH 'https://api.notion.com/v1/databases/c7697137d49f49c2bbcdd6a665c4f921'\
+  -H 'Notion-Version: 2022-02-22'\
+  -H 'Authorization: Bearer '"$NOTION_API_KEY"''\
+  -H 'Content-Type: application/json'\
+  --data '{"properties":{"renamed number property":null,"renamed url property":null}}'
+```
 
 ### 4.3 List class
 
@@ -614,9 +722,11 @@ xp = page.properties["property_name"]
 xp, yp = page.properties.values_at "xp_name", "yp_name"
 ```
 
+Page properties and database properties are objects of the same class, but there are methods for page properties and methods for database properties.
+
 #### 4.5.2 Query object generator of property objects
 
-The following methods for the Property objects generate a query object.
+The following methods for the Property objects generate a query object.  These methods can be used for page properties and database properties.
 
 - TitleProperty, RichTextProperty, UrlProperty, EmailProperty, PhoneNumberProperty
   - filter_equals(value)
@@ -691,11 +801,9 @@ The following methods for the Property objects generate a query object.
 
 #### 4.5.3 create or update values for Page properties
 
-Retrieving Page object has XXXProperties with values.
-On the other hand, Assigned Page object has also XXXProperties, but they don't have any information for pages.
+Retrieving Page object with `find` method has page properties of XXXProperties with values.  On the other hand, Assigned Page object has also XXXProperties, but they don't have any information for pages.
 
-XXXProperties can change property values by setter methods.
-Since the setter method is different for each class, it will be explained separately.
+XXXProperties can change property values by setter methods.  Since the setter method is different for each class, it will be explained separately.
 
 ##### 4.5.3.1 NumberProperty
 
@@ -710,7 +818,7 @@ p np.property_values_json
 
 ##### 4.5.3.2 SelectProperty
 
-NumberProperty can set a select name by `.select=`.
+SelectProperty can set a select name by `.select=`.
 
 ```Ruby
 sp = page.properties["SelectTitle"]
@@ -869,7 +977,7 @@ p tp.property_values_json
 
 ##### 4.5.3.9 CheckboxProperty
 
-PeopleProperty can set a boolean value by `.checkbox=`.
+CheckboxProperty can set a boolean value by `.checkbox=`.
 
 ```Ruby
 cp = page.properties["CheckboxTitle"]
@@ -878,18 +986,7 @@ p cp.property_values_json
 # result => {"cp"=>{"checkbox"=>true, "type"=>"checkbox"}}
 ```
 
-##### 4.5.3.10 EmailProperty
-
-EmailProperty can set an email address by `.email=`.
-
-```Ruby
-ep = page.properties["MailTitle"]
-ep.email = "hkobhkob@gmail.com"
-p ep.property_values_json
-# result => {"ep"=>{"email"=>"hkobhkob@gmail.com", "type"=>"email"}}
-```
-
-##### 4.5.3.11 FilesProperty
+##### 4.5.3.10 FilesProperty
 
 FilesProperty can set an external url or Array of external urls by `.files=`.
 
@@ -904,7 +1001,7 @@ p fp.property_values_json
 # Result => {"fp"=>{"files"=>[{"name"=>"F2", "type"=>"external", "external"=>{"url"=>"F2"}}, {"name"=>"F3", "type"=>"external", "external"=>{"url"=>"F3"}}], "type"=>"files"}}
 ```
 
-##### 4.5.3.12 RelationProperty
+##### 4.5.3.11 RelationProperty
 
 RelationProperty can set an relation's page_id or Array of relation's page_ids by `.relation=`.
 
@@ -919,7 +1016,166 @@ p rp.property_values_json
 # Result => {"rp"=>{"type"=>"relation", "relation"=>[{"id"=>"R2"}, {"id"=>"R3"}]}}
 ```
 
-## 5. XXXObjects
+
+#### 4.5.4 create or update values for Database properties
+
+Retrieving Database object with `find` method has database properties of XXXProperties with values.  On the other hand, Assigned Database object has also XXXProperties, but they don't have any information for databases.
+
+XXXProperties can change property values by setter methods.  Since the setter method is different for each class, it will be explained separately.
+
+##### 4.5.4.1 NumberProperty
+
+NumberProperty can set a format by `.format=`.
+
+```Ruby
+np = db.properties["NumberTitle"]
+np.format = "percent"
+print np.property_schema_json
+# Result => {"NumberTitle"=>{"number"=>{"format"=>"percent"}}}
+```
+
+##### 4.5.4.2 SelectProperty
+
+SelectProperty can add a new option by `.add_select_options`.
+
+```Ruby
+sp = db.properties["SelectTitle"]
+sp.add_select_options name: "S3", color: "red"
+print sp.property_schema_json
+# Result => {"Select"=>{"select"=>{"options"=>[{"id"=>"56a526e1-0cec-4b85-b9db-fc68d00e50c6", "name"=>"S1", "color"=>"yellow"}, {"id"=>"6ead7aee-d7f0-40ba-aa5e-59bccf6c50c8", "name"=>"S2", "color"=>"default"}, {"name"=>"S3", "color"=>"red"}]}}}
+```
+
+If you want to edit existing values, you should access `edit_select_options` array.  It sets `will_update` flag to true.
+```Ruby
+sp.edit_select_options[0]["name"] = "new S1"
+p sp.property_values_json
+# Result => {"Select"=>{"select"=>{"options"=>[{"id"=>"56a526e1-0cec-4b85-b9db-fc68d00e50c6", "name"=>"new S1", "color"=>"yellow"}, {"id"=>"6ead7aee-d7f0-40ba-aa5e-59bccf6c50c8", "name"=>"S2", "color"=>"default"}]}}}⏎
+```
+
+##### 4.5.4.3 MultiSelectProperty
+
+MultiSelectProperty can add a new option by `.add_multi_select_options`.
+
+```Ruby
+msp = db.properties["MultiSelectTitle"]
+msp.add_multi_select_options name: "MS3", color: "blue"
+print msp.property_schema_json
+# Result => {"MultiSelectTitle"=>{"multi_select"=>{"options"=>[{"id"=>"98aaa1c0-4634-47e2-bfae-d739a8c5e564", "name"=>"MS1", "color"=>"orange"}, {"id"=>"71756a93-cfd8-4675-b508-facb1c31af2c", "name"=>"MS2", "color"=>"green"}, {"name"=>"MS3", "color"=>"blue"}]}}}
+```
+
+If you want to edit existing values, you should access `edit_multi_select_options` array.  It sets `will_update` flag to true.
+```Ruby
+msp.edit_multi_select_options[0]["name"] = "new MS1"
+p msp.property_values_json
+# Result => {"MultiSelectTitle"=>{"multi_select"=>{"options"=>[{"id"=>"98aaa1c0-4634-47e2-bfae-d739a8c5e564", "name"=>"new MS1", "color"=>"orange"}, {"id"=>"71756a93-cfd8-4675-b508-facb1c31af2c", "name"=>"MS2", "color"=>"green"}]}}}⏎
+```
+
+##### 4.5.4.4 DateProperty
+
+DateProperty has no option.
+
+```Ruby
+dp = db.properties["DateTitle"]
+print dp.property_schema_json
+# Result => {"DateTitle"=>{"date"=>{}}}
+```
+
+##### 4.5.4.4 UrlProperty
+
+UrlProperty has no option.
+
+```Ruby
+up = db.properties["UrlTitle"]
+print up.property_schema_json
+# Result => {"UrlTitle"=>{"url"=>{}}}
+```
+
+##### 4.5.4.5 EmailProperty
+
+EmailProperty has no option.
+
+```Ruby
+ep = db.properties["MailTitle"]
+print ep.property_schema_json
+# Result => {"MailTitle"=>{"email"=>{}}}
+```
+
+##### 4.5.4.6 PhoneNumberProperty
+
+PhoneNumberProperty has no option.
+
+```Ruby
+pp = db.properties["TelTitle"]
+print ep.property_schema_json
+# Result => {"TelTitle"=>{"phone_number"=>{}}}
+```
+
+##### 4.5.4.7 PeopleProperty
+
+PeopleProperty has no option.
+
+```Ruby
+usp = db.properties["UserTitle"]
+print usp.property_schema_json
+# Result => {"UserTitle"=>{"people"=>{}}}
+```
+
+##### 4.5.4.8 TitleProperty, RichTextProperty
+
+TitleProperty and RichTextProperty have no option.
+
+```Ruby
+tp, rtp = db.properties.values_at "Title", "TextTitle"
+print tp.property_schema_json
+# Result => {"Title"=>{"title"=>{}}}
+print rtp.property_schema_json
+# Result => {"TextTitle"=>{"rich_text"=>{}}}
+```
+
+##### 4.5.4.9 CheckboxProperty
+
+CheckboxProperty has no option.
+
+```Ruby
+cp = db.properties["CheckboxTitle"]
+print cp.property_schema_json
+# Result => {"CheckboxTitle"=>{"checkbox"=>{}}}
+```
+
+##### 4.5.4.10 FilesProperty
+
+FilesProperty has no option.
+
+```Ruby
+fp = db.properties["FilesTitle"]
+print fp.property_schema_json
+# Result => {"FilesTitle"=>{"files"=>{}}}
+```
+
+##### 4.5.4.11 RelationProperty
+
+RelationProperty can set an relation's database_id by `.replace_relation_database`.
+
+```Ruby
+rp = db.properties["RelationTitle"]
+rp.replace_relation_database database_id: "new database id"
+p rp.property_values_json
+# Result => {"Relation"=>{"relation"=>{"database_id"=>"new database id"}}}
+```
+
+##### 4.5.4.12 RollupProperty
+
+RollupProperty can set rollup property name, relation property name and function by `.rollup_property_name=`, `relation_property_name=` and `function=`, respectively.
+
+```Ruby
+rup = db.properties["RollupTitle"]
+rup.relation_property_name = "new relation property name"
+rup.rollup_property_name = "new rollup property name"
+rup.function = "average"
+# Result => {"Rollup"=>{"rollup"=>{"function"=>"average", "relation_property_name"=>"new relation property name", "rollup_property_name"=>"new rollup property name"}}}
+```
+
+## 5. XXXObjects and RichTextArray
 
 ### 5.1 RichTextObject
 
@@ -969,8 +1225,33 @@ UserObject is a class for users.
 u = User.new id: "user_id"
 ```
 
+### 5.5 RichTextArray
+
+Some properties and Database title have an array of RichTextObject.  `RichTextArray` is the delegate class for the array of RichTextObject.
+Moreover, some methods of TitleProperty, RichTextProperty and Database.title delegate to the included RichTextArray.
+
+#### 5.5.1 Constructor for RichTextArray
+
+RichTextArray can be created by a String, some Strings, a RichTextObject and some RichTextObjects.  String values will convert to simple TextObjects.
+
+```Ruby
+nullString = RichTextArray.new "title"
+aString = RichTextArray.new "title", text_objects: "A string"
+twoStrings = RichTextArray.new "title", text_objects: %W[ABC\n DEF]
+aTextObject = RichTextArray.new "title", text_objects: TextObject.new "A TextObject"
+textMentionObjects = RichTextArray.new "title", [TextObject.new("A TextObject"), MentionObject.new(user_id: "ABC")]
+```
+
+#### 5.5.2 Instance methods
+
+- `rto << text_or_text_object`: append a text or RichTextObject
+- `rto[0]`: obtain the object specified by the index
+- `delete_at 0`: obtain the object specified by the index and delete from the array
+- `full_text`: obtain joined plain text
+
 ## 6. ChangeLog
 
+- 2022/3/25 added create_child_database, update_database, add_property, rename_property and remove_property
 - 2022/3/17 added template_mention objects, tools/an command
 - 2022/3/16 added database.create_child_page and base.save instead of base.update/create
 - 2022/3/15 Fixed not to reload from API when all contents are loaded