notion.api.v1.endpoint.PagesSupport.kt Maven / Gradle / Ivy

Go to download
package notion.api.v1.endpoint

import notion.api.v1.exception.NotionAPIError
import notion.api.v1.http.NotionHttpClient
import notion.api.v1.json.NotionJsonSerializer
import notion.api.v1.logging.NotionLogger
import notion.api.v1.model.blocks.Block
import notion.api.v1.model.common.Cover
import notion.api.v1.model.common.Icon
import notion.api.v1.model.pages.Page
import notion.api.v1.model.pages.PageParent
import notion.api.v1.model.pages.PageProperty
import notion.api.v1.model.pages.PagePropertyItem
import notion.api.v1.request.pages.CreatePageRequest
import notion.api.v1.request.pages.RetrievePagePropertyItemRequest
import notion.api.v1.request.pages.RetrievePageRequest
import notion.api.v1.request.pages.UpdatePageRequest

interface PagesSupport : EndpointsSupport {
  val httpClient: NotionHttpClient
  val jsonSerializer: NotionJsonSerializer
  val logger: NotionLogger
  val baseUrl: String

  // -----------------------------------------------
  // createPage
  // -----------------------------------------------

  fun createPage(
      parent: PageParent,
      properties: Map,
      children: List? = null,
      icon: Icon? = null,
      cover: Cover? = null,
  ): Page {
    return createPage(
        CreatePageRequest(
            parent = parent,
            properties = properties,
            children = children,
            icon = icon,
            cover = cover,
        ))
  }

  fun createPage(page: CreatePageRequest): Page {
    val httpResponse =
        httpClient.postTextBody(
            logger = logger,
            url = "$baseUrl/pages",
            body = jsonSerializer.toJsonString(page),
            headers = buildRequestHeaders(contentTypeJson()))
    if (httpResponse.status == 200) {
      return jsonSerializer.toPage(httpResponse.body)
    } else {
      throw NotionAPIError(
          error = jsonSerializer.toError(httpResponse.body),
          httpResponse = httpResponse,
      )
    }
  }

  // -----------------------------------------------
  // retrievePage
  // -----------------------------------------------

  fun retrievePage(pageId: String, filterProperties: List? = null): Page {
    return retrievePage(RetrievePageRequest(pageId = pageId, filterProperties = filterProperties))
  }

  fun retrievePage(request: RetrievePageRequest): Page {
    val httpResponse =
        httpClient.get(
            logger = logger,
            query = request.toQuery(),
            url = "$baseUrl/pages/${urlEncode(request.pageId)}",
            headers = buildRequestHeaders(emptyMap()))
    if (httpResponse.status == 200) {
      return jsonSerializer.toPage(httpResponse.body)
    } else {
      throw NotionAPIError(
          error = jsonSerializer.toError(httpResponse.body),
          httpResponse = httpResponse,
      )
    }
  }

  // -----------------------------------------------
  // updatePage
  // -----------------------------------------------

  fun updatePage(
      pageId: String,
      properties: Map,
      archived: Boolean? = null,
      icon: Icon? = null,
      cover: Cover? = null,
  ): Page {
    return updatePage(
        UpdatePageRequest(
            pageId = pageId,
            properties = properties,
            archived = archived,
            icon = icon,
            cover = cover,
        ))
  }

  fun updatePage(request: UpdatePageRequest): Page {
    val httpResponse =
        httpClient.patchTextBody(
            logger = logger,
            url = "$baseUrl/pages/${request.pageId}",
            body = jsonSerializer.toJsonString(request),
            headers = buildRequestHeaders(contentTypeJson()))
    if (httpResponse.status == 200) {
      return jsonSerializer.toPage(httpResponse.body)
    } else {
      throw NotionAPIError(
          error = jsonSerializer.toError(httpResponse.body),
          httpResponse = httpResponse,
      )
    }
  }

  @Deprecated(
      message = "Use updatePage method instead",
      replaceWith = ReplaceWith(expression = "updatePage(...)"))
  fun updatePageProperties(
      pageId: String,
      properties: Map,
      archived: Boolean? = null,
      icon: Icon? = null,
      cover: Cover? = null,
  ): Page {
    return updatePage(
        UpdatePageRequest(
            pageId = pageId,
            properties = properties,
            archived = archived,
            icon = icon,
            cover = cover,
        ))
  }

  @Deprecated(
      message = "Use updatePage method instead",
      replaceWith = ReplaceWith(expression = "updatePage(UpdatePageRequest())"))
  fun updatePageProperties(request: UpdatePageRequest): Page {
    return updatePage(request)
  }

  // -----------------------------------------------
  // retrievePagePropertyItem
  // -----------------------------------------------

  fun retrievePagePropertyItem(
      pageId: String,
      propertyId: String,
      startCursor: String? = null,
      pageSize: Int? = null,
  ): PagePropertyItem {
    return retrievePagePropertyItem(
        RetrievePagePropertyItemRequest(
            pageId = pageId,
            propertyId = propertyId,
            startCursor = startCursor,
            pageSize = pageSize,
        ))
  }

  fun retrievePagePropertyItem(request: RetrievePagePropertyItemRequest): PagePropertyItem {
    val url =
        "$baseUrl/pages/${urlEncode(request.pageId)}/properties/${urlEncode(request.propertyId)}"
    val httpResponse =
        httpClient.get(
            logger = logger,
            url = url,
            query = request.toQuery(),
            headers = buildRequestHeaders(emptyMap()))
    if (httpResponse.status == 200) {
      return jsonSerializer.toPagePropertyItem(httpResponse.body)
    } else {
      throw NotionAPIError(
          error = jsonSerializer.toError(httpResponse.body),
          httpResponse = httpResponse,
      )
    }
  }
}