feat: implement append block children

Author: mkfsn

README.md

@@ -26,8 +26,8 @@ go get -u github.com/mkfsn/notion-go
   * [x] Retrieve ✅
   * [ ] Create ❌
   * [ ] Update ❌
-- [ ] Blocks ⚠️
-  * [ ] Children ⚠️
+- [x] Blocks ✅️
+  * [x] Children ✅
     - [x] Retrieve ✅
-    - [ ] Append ❌
+    - [x] Append ✅
 - [x] Search ✅

blocks.go

@@ -3,7 +3,6 @@ package notion
 import (
 	"context"
 	"encoding/json"
-	"fmt"
 	"net/http"
 	"strings"
 	"time"
@@ -31,7 +30,7 @@ func newBlock(data []byte) (Block, error) {
 		return block, nil
 
 	case BlockTypeHeading1:
-		var block Heading3Block
+		var block Heading1Block
 
 		if err := json.Unmarshal(data, &block); err != nil {
 			return nil, err
@@ -40,7 +39,7 @@ func newBlock(data []byte) (Block, error) {
 		return block, nil
 
 	case BlockTypeHeading2:
-		var block Heading3Block
+		var block Heading2Block
 
 		if err := json.Unmarshal(data, &block); err != nil {
 			return nil, err
@@ -132,70 +131,83 @@ const (
 
 type BlockBase struct {
 	// Always "block".
-	Object string `json:"object"`
+	Object ObjectType `json:"object"`
 	// Identifier for the block.
-	ID string `json:"id"`
+	ID string `json:"id,omitempty"`
 	// Type of block.
 	Type BlockType `json:"type"`
 	// Date and time when this block was created. Formatted as an ISO 8601 date time string.
-	CreatedTime time.Time `json:"created_time"`
+	CreatedTime *time.Time `json:"created_time,omitempty"`
 	// Date and time when this block was last updated. Formatted as an ISO 8601 date time string.
-	LastEditedTime time.Time `json:"last_edited_time"`
+	LastEditedTime *time.Time `json:"last_edited_time,omitempty"`
 	// Whether or not the block has children blocks nested within it.
-	HasChildren bool `json:"has_children"`
+	HasChildren *bool `json:"has_children,omitempty"`
 }
 
 func (b BlockBase) isBlock() {}
 
 type ParagraphBlock struct {
 	BlockBase
-	Text     []RichText  `json:"text"`
-	Children []BlockBase `json:"children"`
+	Paragraph RichTextBlock `json:"paragraph"`
 }
 
-type Heading3Block struct {
-	BlockBase
+type HeadingBlock struct {
 	Text []RichText `json:"text"`
 }
 
-type HeadingTwoBlock struct {
+type Heading1Block struct {
 	BlockBase
-	Text []RichText `json:"text"`
+	Heading1 HeadingBlock `json:"heading_1"`
 }
 
-type HeadingThreeBlock struct {
+type Heading2Block struct {
 	BlockBase
-	Text []RichText `json:"text"`
+	Heading2 HeadingBlock `json:"heading_2"`
 }
 
-type BulletedListItemBlock struct {
+type Heading3Block struct {
 	BlockBase
+	Heading3 HeadingBlock `json:"heading_3"`
+}
+
+type RichTextBlock struct {
 	Text     []RichText  `json:"text"`
-	Children []BlockBase `json:"children"`
+	Children []BlockBase `json:"children,omitempty"`
+}
+
+type BulletedListItemBlock struct {
+	BlockBase
+	BulletedListItem RichTextBlock `json:"bulleted_list_item"`
 }
 
 type NumberedListItemBlock struct {
 	BlockBase
+	NumberedListItem RichTextBlock `json:"numbered_list_item"`
+}
+
+type RichTextWithCheckBlock struct {
 	Text     []RichText  `json:"text"`
+	Checked  bool        `json:"checked"`
 	Children []BlockBase `json:"children"`
 }
 
 type ToDoBlock struct {
 	BlockBase
-	Text     []RichText  `json:"text"`
-	Checked  bool        `json:"checked"`
-	Children []BlockBase `json:"children"`
+	ToDo RichTextWithCheckBlock `json:"todo"`
 }
 
 type ToggleBlock struct {
 	BlockBase
-	Text     []RichText  `json:"text"`
-	Children []BlockBase `json:"children"`
+	Toggle RichTextBlock `json:"toggle"`
+}
+
+type TitleBlock struct {
+	Title string `json:"title"`
 }
 
 type ChildPageBlock struct {
 	BlockBase
-	Title string `json:"title"`
+	ChildPage TitleBlock `json:"child_page"`
 }
 
 type UnsupportedBlock struct {
@@ -264,14 +276,24 @@ func (b *BlocksChildrenListResponse) UnmarshalJSON(data []byte) error {
 
 type BlocksChildrenAppendParameters struct {
 	// Identifier for a block
-	BlockID string
+	BlockID string `json:"-" url:"-"`
 	// Child content to append to a container block as an array of block objects
-	Children []Block `json:"children"`
+	Children []Block `json:"children"  url:"-"`
 }
 
 type BlocksChildrenAppendResponse struct {
-	// TODO: check if this is correct
-	BlockBase
+	Block
+}
+
+func (b *BlocksChildrenAppendResponse) UnmarshalJSON(data []byte) error {
+	block, err := newBlock(data)
+	if err != nil {
+		return err
+	}
+
+	b.Block = block
+
+	return nil
 }
 
 type BlocksChildrenInterface interface {
@@ -292,8 +314,6 @@ func newBlocksChildrenClient(client client) *blocksChildrenClient {
 func (b *blocksChildrenClient) List(ctx context.Context, params BlocksChildrenListParameters) (*BlocksChildrenListResponse, error) {
 	endpoint := strings.Replace(APIBlocksListChildrenEndpoint, "{block_id}", params.BlockID, 1)
 
-	fmt.Printf("endpoint: %s\n", endpoint)
-
 	data, err := b.client.Request(ctx, http.MethodGet, endpoint, nil)
 	if err != nil {
 		return nil, err
@@ -309,5 +329,18 @@ func (b *blocksChildrenClient) List(ctx context.Context, params BlocksChildrenLi
 }
 
 func (b *blocksChildrenClient) Append(ctx context.Context, params BlocksChildrenAppendParameters) (*BlocksChildrenAppendResponse, error) {
-	return nil, ErrUnimplemented
+	endpoint := strings.Replace(APIBlocksAppendChildrenEndpoint, "{block_id}", params.BlockID, 1)
+
+	data, err := b.client.Request(ctx, http.MethodPatch, endpoint, params)
+	if err != nil {
+		return nil, err
+	}
+
+	var response BlocksChildrenAppendResponse
+
+	if err := json.Unmarshal(data, &response); err != nil {
+		return nil, err
+	}
+
+	return &response, nil
 }

databases.go

@@ -9,8 +9,8 @@ import (
 )
 
 type Database struct {
-	Object string `json:"object"`
-	ID     string `json:"id"`
+	Object ObjectType `json:"object"`
+	ID     string     `json:"id"`
 
 	CreatedTime    time.Time           `json:"created_time"`
 	LastEditedTime time.Time           `json:"last_edited_time"`
@@ -39,7 +39,7 @@ func (d *Database) UnmarshalJSON(data []byte) error {
 	d.Properties = make(map[string]Property)
 
 	for _, title := range alias.Title {
-		var base baseRichText
+		var base BaseRichText
 
 		if err := json.Unmarshal(title, &base); err != nil {
 			return err
@@ -279,7 +279,7 @@ type RichText interface {
 }
 
 func newRichText(data []byte) (RichText, error) {
-	var base baseRichText
+	var base BaseRichText
 
 	if err := json.Unmarshal(data, &base); err != nil {
 		return nil, err
@@ -325,30 +325,32 @@ const (
 	RichTextTypeEquation RichTextType = "equation"
 )
 
-type baseRichText struct {
+type BaseRichText struct {
 	// The plain text without annotations.
-	PlainText string `json:"plain_text"`
+	PlainText string `json:"plain_text,omitempty"`
 	// (Optional) The URL of any link or internal Notion mention in this text, if any.
-	Href string `json:"href"`
+	Href string `json:"href,omitempty"`
 	// Type of this rich text object.
 	Type RichTextType `json:"type"`
 	// All annotations that apply to this rich text.
 	// Annotations include colors and bold/italics/underline/strikethrough.
-	Annotations Annotations `json:"annotations"`
+	Annotations *Annotations `json:"annotations,omitempty"`
 }
 
-func (r baseRichText) isRichText() {}
+func (r BaseRichText) isRichText() {}
+
+type Link struct {
+	Type string `json:"type"`
+	URL  string `json:"url"`
+}
 
 type TextObject struct {
 	Content string `json:"content"`
-	Link    *struct {
-		Type string `json:"type"`
-		URL  string `json:"url"`
-	} `json:"link"`
+	Link    *Link  `json:"link,omitempty"`
 }
 
 type RichTextText struct {
-	baseRichText
+	BaseRichText
 	Text TextObject `json:"text"`
 }
 
@@ -387,7 +389,7 @@ type DateMention struct {
 }
 
 type RichTextMention struct {
-	baseRichText
+	BaseRichText
 	Mention Mention `json:"mention"`
 }
 
@@ -396,7 +398,7 @@ type EquationObject struct {
 }
 
 type RichTextEquation struct {
-	baseRichText
+	BaseRichText
 	Equation EquationObject `json:"equation"`
 }
 

examples/append-block-children/main.go

@@ -0,0 +1,68 @@
+package main
+
+import (
+	"context"
+	"log"
+	"os"
+
+	"github.com/mkfsn/notion-go"
+)
+
+func main() {
+	c := notion.New(notion.WithAuthToken(os.Getenv("NOTION_AUTH_TOKEN")))
+
+	resp, err := c.Blocks().Children().Append(context.Background(),
+		notion.BlocksChildrenAppendParameters{
+			BlockID: "12e1d803ee234651a125c6ce13ccd58d",
+			Children: []notion.Block{
+				notion.Heading2Block{
+					BlockBase: notion.BlockBase{
+						Object: notion.ObjectTypeBlock,
+						Type:   notion.BlockTypeHeading2,
+					},
+					Heading2: notion.HeadingBlock{
+						Text: []notion.RichText{
+							notion.RichTextText{
+								BaseRichText: notion.BaseRichText{
+									Type: notion.RichTextTypeText,
+								},
+								Text: notion.TextObject{
+									Content: "Lacinato kale",
+								},
+							},
+						},
+					},
+				},
+
+				notion.ParagraphBlock{
+					BlockBase: notion.BlockBase{
+						Object: notion.ObjectTypeBlock,
+						Type:   notion.BlockTypeParagraph,
+					},
+					Paragraph: notion.RichTextBlock{
+						Text: []notion.RichText{
+							notion.RichTextText{
+								BaseRichText: notion.BaseRichText{
+									Type: notion.RichTextTypeText,
+								},
+								Text: notion.TextObject{
+									Content: "Lacinato kale is a variety of kale with a long tradition in Italian cuisine, especially that of Tuscany. It is also known as Tuscan kale, Italian kale, dinosaur kale, kale, flat back kale, palm tree kale, or black Tuscan palm.",
+									Link: &notion.Link{
+										Type: "url",
+										URL:  "https://en.wikipedia.org/wiki/Lacinato_kale",
+									},
+								},
+							},
+						},
+					},
+				},
+			},
+		},
+	)
+
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	log.Printf("response: %#v\n", resp)
+}

pages.go

@@ -60,7 +60,7 @@ type PageParentInput struct {
 
 type Page struct {
 	// Always "page".
-	Object string `json:"object"`
+	Object ObjectType `json:"object"`
 	// Unique identifier of the page.
 	ID string `json:"id"`
 	// The page's parent

search.go

@@ -84,15 +84,15 @@ func (s *SearchResponse) UnmarshalJSON(data []byte) error {
 
 	for _, result := range alias.Results {
 		var base struct {
-			Object string `json:"object"`
+			Object ObjectType `json:"object"`
 		}
 
 		if err := json.Unmarshal(result, &base); err != nil {
 			return err
 		}
 
 		switch base.Object {
-		case "page":
+		case ObjectTypePage:
 			var object Page
 
 			if err := json.Unmarshal(result, &object); err != nil {
@@ -101,7 +101,7 @@ func (s *SearchResponse) UnmarshalJSON(data []byte) error {
 
 			s.Results = append(s.Results, object)
 
-		case "database":
+		case ObjectTypeDatabase:
 			var object Database
 
 			if err := json.Unmarshal(result, &object); err != nil {