Type Definitions

The types module provides type definitions for the Postiva API.

CreateClientParameters

Prop	Type	Default
`apiKey`	`string`	-
`workspaceId`	`string`	-
`options`	`PostivaClientOptions`	-

PostivaClientOptions

Prop	Type	Default
`debug`	`boolean`	-

Content

Prop	Type	Default
`id`	`string`	-
`title`	`string`	-
`type`	`string`	-
`createdAt`	`string`	-
`updatedAt`	`string`	-
`tags`	`string[]`	-
`categories`	`ContentCategory[]`	-
`publishedBy`	`ContentPublishedBy`	-
`description`	`string`	-
`publishedAt`	`string`	-
`slug`	`string`	-
`thumbnail`	`string`	-
`body`	`string`	-
`html`	`string`	-
`seoTitle`	`string`	-
`seoDescription`	`string`	-
`seoThumbnail`	`string`	-
`readingStatus`	`ContentReadingStatus`	-
`analytics`	`ContentAnalytics`	-

PublishedBy

Prop	Type	Default
`role`	`string`	-
`user`	`{ name: string; email: string; image: string; }`	-

Category

Prop	Type	Default
`id`	`string`	-
`name`	`string`	-
`description`	`string`	-
`createdAt`	`string`	-
`updatedAt`	`string`	-

Content Similarity

Prop	Type	Default
`id`	`string`	-
`slug`	`string`	-
`title`	`string`	-
`description`	`string`	-
`tags`	`string`	-
`thumbnail`	`string`	-
`createdAt`	`string`	-
`publishedBy`	`ContentPublishedBy`	-
`publishedAt`	`string`	-
`readingStatus`	`ContentReadingStatus`	-
`type`	`ContentStatusEnum`	-

Content Analytics

Prop	Type	Default
`views`	`number`	-
`likes`	`number`	-
`comments`	`number`	-
`shares`	`number`	-
`claps`	`number`	-

Pagination

Prop	Type	Default
`page`	`number`	-
`limit`	`number`	-
`total`	`number`	-
`totalPages`	`number`	-

APIResponse

Prop	Type	Default
`data`	`Content`	-

PaginationResponse

Prop	Type	Default
`data`	`Content`	-
`pagination`	`IPagination`	-

Previous

Claps

On this page

CreateClientParameters PostivaClientOptions Content PublishedBy Category Content Similarity Content Analytics Pagination APIResponse PaginationResponse