fix: use new shape of app actions (#1285)

contentful · Apr 12, 2022 · 0a794e8 · 0a794e8
1 parent 62074cb
commit 0a794e8
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 19 deletions.
diff --git a/lib/entities/app-action-call.ts b/lib/entities/app-action-call.ts
@@ -19,9 +19,7 @@ export type AppActionCallProps = {
 
 export type CreateAppActionCallProps = {
   /** The body for the call */
-  body: { [key: string]: any }
-  /** The headers for the call*/
-  headers: { [key: string]: any }
+  parameters: { [key: string]: any }
 }
 
 export interface AppActionCall extends AppActionCallProps, DefaultElements<AppActionCallProps> {}

diff --git a/lib/entities/app-action.ts b/lib/entities/app-action.ts
@@ -11,17 +11,18 @@ type AppActionSys = Except<BasicMetaSysProps, 'version'> & {
   organization: SysLink
 }
 
-export type BodyDefinition = Omit<ParameterDefinition, 'labels'>
+export type AppActionParameterDefinition = Omit<ParameterDefinition, 'labels'>
 
-export enum ActionTypes {
-  Endpoint = 'endpoint',
+export enum AppActionCategory {
+  EntryListV1Beta = 'EntryList.v1.0-beta',
+  NotificationV1Beta = 'Notification.v1.0-beta',
+  Custom = 'Custom',
 }
 
 export type CreateAppActionProps = {
-  type: ActionTypes.Endpoint
   url: string
-  body?: BodyDefinition[]
-  headers?: string[]
+  category: AppActionCategory
+  parameters?: AppActionParameterDefinition[]
   name: string
 }
 
@@ -31,21 +32,17 @@ export type AppActionProps = {
    */
   sys: AppActionSys
   /**
-   * Type of the action
+   * Category identifying the shape of the action. Choose "Custom" for custom schema
    */
-  type: ActionTypes
+  category: AppActionCategory
   /**
    * Url that will be called when the action is invoked
    */
   url: string
   /**
    * An optional schema for which body parameters need to be provided when calling the action
    */
-  body?: BodyDefinition[]
-  /**
-   * An optional schema for which headers need to be provided hen calling the action
-   */
-  headers?: string[]
+  parameters?: AppActionParameterDefinition[]
   /**
    * Human readable name for the action
    */
@@ -65,7 +62,7 @@ export interface AppAction extends AppActionProps, DefaultElements<AppActionProp
    *
    * client.getOrganization('<org_id>')
    * .then((org) => org.getAppDefinition('<app_def_id>'))
-   * .then((appDefinition) => appDefinition.getAppAction('<app-bundle-id>'))
+   * .then((appDefinition) => appDefinition.getAppAction('<app-action-id>'))
    * .then((appAction) => appAction.delete())
    * .catch(console.error)
    * ```

diff --git a/lib/export-types.ts b/lib/export-types.ts
@@ -4,8 +4,8 @@ export type {
   AppAction,
   AppActionProps,
   CreateAppActionProps,
-  BodyDefinition,
-  ActionTypes,
+  AppActionParameterDefinition,
+  AppActionCategory,
 } from './entities/app-action'
 export type {
   AppActionCall,