Merge pull request #639 from contentful/feat/expose-tags-api

feat: expose tags api
contentful · Apr 6, 2021 · 4c7881c · 4c7881c
2 parents 3dcfcf8 + 47cf06b
commit 4c7881c
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 1 deletion.
diff --git a/lib/space.ts b/lib/space.ts
@@ -47,6 +47,11 @@ const spaceMethods: Array<keyof SpaceAPI> = [
   'getEntityScheduledActions',
 
   'signRequest',
+
+  'createTag',
+  'readTags',
+  'updateTag',
+  'deleteTag',
 ]
 
 export default function createSpace(

diff --git a/lib/types.ts b/lib/types.ts
@@ -1,4 +1,5 @@
 export type EntityType = 'Entry' | 'Asset'
+export type TagVisibility = 'private' | 'public'
 
 export interface SpaceMembership {
   sys: {
@@ -30,11 +31,27 @@ export interface Items {
 export interface Link {
   sys: {
     id: string
-    type: string
+    type: 'Link'
     linkType: string
   }
 }
 
+export interface Tag {
+  sys: {
+    type: 'Tag'
+    id: string
+    space: Link
+    environment: Link
+    createdBy: Link
+    updatedBy: Link
+    createdAt: string
+    updatedAt: string
+    version: number
+    visibility: 'private' | 'public'
+  }
+  name: string
+}
+
 export type CollectionResponse<T> = {
   items: T[]
   total: number
@@ -375,6 +392,11 @@ export interface SpaceAPI {
   getAllScheduledActions: () => Promise<ScheduledAction[]>
 
   signRequest: (request: CanonicalRequest) => Promise<Record<string, string>>
+
+  createTag: (id: string, name: string, visibility?: TagVisibility) => Promise<Tag>
+  readTags: (skip: number, limit: number) => Promise<CollectionResponse<Tag>>
+  updateTag: (id: string, name: string, version: number) => Promise<Tag>
+  deleteTag: (id: string, version: number) => Promise<boolean>
 }
 
 /* Locales API */

diff --git a/test/unit/space.spec.ts b/test/unit/space.spec.ts
@@ -45,6 +45,11 @@ const spaceMethods = [
   'getUsers',
 
   'signRequest',
+
+  'createTag',
+  'readTags',
+  'updateTag',
+  'deleteTag',
 ]
 
 describe('createSpace()', () => {