DraftAPI.getCirculations added

Author: msadovyi

CHANGELOG.md

@@ -1,5 +1,11 @@
 # @code.store/arcxp-sdk-ts
 
+## 4.35.0
+
+### Minor Changes
+
+- DraftAPI.getCirculations added
+
 ## 4.34.1
 
 ### Patch Changes

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code.store/arcxp-sdk-ts",
-  "version": "4.34.1",
+  "version": "4.35.0",
   "description": "A strongly typed set of ArcXP API's and utilities reduce the amount of work required to develop with ArcXP, starting with reducing the boilerplate code you have to write.",
   "type": "commonjs",
   "main": "./dist/index.js",

src/api/draft/index.ts

@@ -1,5 +1,6 @@
 import { type ArcAPIOptions, ArcAbstractAPI } from '../abstract-api';
 import type {
+  Circulations,
   CreateDocumentRedirectPayload,
   CreateExternalRedirectPayload,
   CreateRedirectPayload,
@@ -45,6 +46,11 @@ export class ArcDraft extends ArcAbstractAPI {
     return data;
   }
 
+  async getCirculations(id: string, type = 'story', after?: string) {
+    const { data } = await this.client.get<Circulations>(`/${type}/${id}/circulation`, { params: { after } });
+    return data;
+  }
+
   async createRedirect<
     P extends CreateRedirectPayload,
     R = P extends CreateExternalRedirectPayload

src/api/draft/types.ts

@@ -1,4 +1,5 @@
 import type { AStory } from '../../types/story';
+import type { CirculationReference } from '../migration-center/types';
 
 export type CreateExternalRedirectPayload = {
   redirect_to: string;
@@ -53,3 +54,8 @@ export type UpdateDraftRevisionPayload = {
   ans: AStory;
   type: 'DRAFT';
 };
+
+export type Circulations = {
+  circulations: CirculationReference[];
+  last?: string;
+};