@code.store/arcxp-sdk-ts 5.4.0 → 5.5.0

package/dist/api/author/index.d.ts

@@ -1,7 +1,11 @@
 import { ArcAbstractAPI, type ArcAPIOptions } from '../abstract-api.js';
-import type { ListAuthorsParams, ListAuthorsResponse } from './types.js';
+import type { AuthorANS, AuthorConfigurationResponse, CreateAuthorPayload, GetAuthorParams, ListAuthorsParams, ListAuthorsResponse, UpdateAuthorPayload } from './types.js';
 export declare class ArcAuthor extends ArcAbstractAPI {
     constructor(options: ArcAPIOptions);
+    getAuthor(params: GetAuthorParams): Promise<AuthorANS>;
     listAuthors(params?: ListAuthorsParams): Promise<ListAuthorsResponse>;
-    delete(userId: string): Promise<void>;
+    createAuthor(payload: CreateAuthorPayload): Promise<AuthorANS>;
+    updateAuthor(id: string, payload: UpdateAuthorPayload): Promise<AuthorANS>;
+    deleteAuthor(id: string): Promise<void>;
+    getConfiguration(): Promise<AuthorConfigurationResponse>;
 }

package/dist/api/author/types.d.ts

@@ -1,4 +1,12 @@
 export type ListAuthorsParams = Partial<{
+    sort_by: 'lastName' | 'last_updated_date';
+    order: 'asc' | 'desc';
+    byline: string;
+    email: string;
+    firstName: string;
+    lastName: string;
+    slug: string;
+    include_inactive: boolean;
     limit: number;
     last: string;
 }>;
@@ -7,6 +15,34 @@ export type ListAuthorsResponse = {
     more?: boolean;
     last?: string;
 };
+export type CreateAuthorPayload = Omit<AuthorANS, 'last_updated_date'>;
+export type UpdateAuthorPayload = Partial<Omit<AuthorANS, '_id' | 'last_updated_date'>>;
+export type GetAuthorParams = {
+    _id: string;
+};
+export type AuthorConfigurationResponse = {
+    q_results: AuthorFieldConfig[];
+    count: number;
+    limit: number;
+    offset: number;
+    total_count: number;
+};
+export type AuthorFieldConfig = {
+    _id: string;
+    key: string;
+    label?: string;
+    type?: string;
+    required?: boolean;
+    hidden?: boolean;
+    placeholder?: string;
+    default?: string;
+    max?: number;
+    versionAdded?: number;
+    picklist_options?: {
+        value: string;
+        label: string;
+    }[];
+};
 export type AuthorANS = {
     type: 'author';
     _id: string;
@@ -16,6 +52,9 @@ export type AuthorANS = {
     slug: string;
     email: string;
     image?: string;
+    url?: string;
+    middleName?: string;
+    suffix?: string;
     affiliations?: string;
     author_type?: string;
     education?: {
@@ -24,6 +63,16 @@ export type AuthorANS = {
     awards?: {
         name: string;
     }[];
+    books?: {
+        title: string;
+        url?: string;
+        publisher?: string;
+    }[];
+    podcasts?: {
+        name?: string;
+        url?: string;
+        download_url?: string;
+    }[];
     bio_page?: string;
     bio?: string;
     longBio?: string;
@@ -33,9 +82,22 @@ export type AuthorANS = {
     location?: string;
     role?: string;
     expertise?: string;
+    languages?: string;
+    beat?: string;
     personal_website?: string;
     twitter?: string;
     facebook?: string;
     linkedin?: string;
+    youtube?: string;
+    tumblr?: string;
+    pinterest?: string;
+    soundcloud?: string;
+    instagram?: string;
+    rss?: string;
+    snapchat?: string;
+    whatsapp?: string;
+    medium?: string;
+    reddit?: string;
+    last_updated_date?: string;
     status?: boolean;
 };

package/dist/index.cjs

@@ -129,12 +129,27 @@ class ArcAuthor extends ArcAbstractAPI {
     constructor(options) {
         super({ ...options, apiPath: 'author' });
     }
+    async getAuthor(params) {
+        const { data } = await this.client.get('/v1/author-service', { params });
+        return data;
+    }
     async listAuthors(params) {
         const { data } = await this.client.get('/v2/author-service', { params });
         return data;
     }
-    async delete(userId) {
-        const { data } = await this.client.delete(`/v2/author-service/${userId}`);
+    async createAuthor(payload) {
+        const { data } = await this.client.post('/v2/author-service', payload);
+        return data;
+    }
+    async updateAuthor(id, payload) {
+        const { data } = await this.client.post(`/v2/author-service/${id}`, payload);
+        return data;
+    }
+    async deleteAuthor(id) {
+        await this.client.delete(`/v2/author-service/${id}`);
+    }
+    async getConfiguration() {
+        const { data } = await this.client.get('/v1/configuration');
         return data;
     }
 }