fix: revert changes to plain client wrap method that made space/env/o…

…rg ids required [] (#2194) * Revert "feat: PlainClient docs - task [EXT-4924] (#2181)" This reverts commit 9c8603f. * Revert "docs: PlainClient docs - comment [EXT-4926] (#2183)" This reverts commit 3f3de67. * Revert "docs: add inline docs for the plain client Workflows interfaces [EXT-4927] (#2175)" This reverts commit c2e9871. * docs: add TSDocs for the comment entity on the plain client interface * docs: add TSDocs for the task entity on the plain client interface * chore: prune unused type imports from common-types * docs: fixs snippets for users queries * docs: add TSDocs for the workflow entity on the plain client interface * docs: add TSDocs for the workflows-changelog entity on the plain client interface * docs: add TSDocs for the workflow-definition entity on the plain client interface * docs: PlainClient docs - role [EXT-4925] (#2184) * docs: PlainClient docs - role [EXT-4925] * docs: update formatting on role plain client snippets --------- Co-authored-by: Tyler Collins <[email protected]> * docs: add inline docs for the plain client Tag interface [EXT-4966] (#2189) * docs: add inline docs for the plain client Tag interface [EXT-4966] * fix: remove CreateOrUpdate * chore: re-align interface with upstream fixes --------- Co-authored-by: Tyler Collins <[email protected]> --------- Co-authored-by: Tyler Collins <[email protected]> Co-authored-by: david-shibley-contentful <[email protected]>
contentful · Feb 23, 2024 · 64aa66d · 64aa66d
1 parent 639bcf4
commit 64aa66d
Show file tree

Hide file tree

Showing 18 changed files with 671 additions and 277 deletions.
diff --git a/lib/common-types.ts b/lib/common-types.ts
@@ -116,7 +116,6 @@ import {
   CreateWorkflowDefinitionParams,
   CreateWorkflowDefinitionProps,
   DeleteWorkflowDefinitionParams,
-  UpdateWorkflowDefinitionProps,
   WorkflowDefinitionProps,
   WorkflowDefinitionQueryOptions,
 } from './entities/workflow-definition'
@@ -125,7 +124,6 @@ import {
   CreateWorkflowParams,
   CreateWorkflowProps,
   DeleteWorkflowParams,
-  UpdateWorkflowProps,
   WorkflowProps,
   WorkflowQueryOptions,
 } from './entities/workflow'
@@ -1791,7 +1789,7 @@ export type MRActions = {
     }
     update: {
       params: GetWorkflowDefinitionParams
-      payload: UpdateWorkflowDefinitionProps
+      payload: WorkflowDefinitionProps
       headers?: RawAxiosRequestHeaders
       return: WorkflowDefinitionProps
     }
@@ -1815,7 +1813,7 @@ export type MRActions = {
     }
     update: {
       params: GetWorkflowParams
-      payload: UpdateWorkflowProps
+      payload: WorkflowProps
       headers?: RawAxiosRequestHeaders
       return: WorkflowProps
     }

diff --git a/lib/entities/comment.ts b/lib/entities/comment.ts
@@ -112,7 +112,7 @@ export type GetCommentParentEntityParams = GetSpaceEnvironmentParams &
 export type GetManyCommentsParams = (GetEntryParams | GetCommentParentEntityParams) & {
   status?: CommentStatus
 }
-export type CreateCommentParams = GetCommentParentEntityParams & {
+export type CreateCommentParams = (GetEntryParams | GetCommentParentEntityParams) & {
   parentCommentId?: string
 }
 export type UpdateCommentParams = GetCommentParams

diff --git a/lib/plain/common-types.ts b/lib/plain/common-types.ts
@@ -10,7 +10,6 @@ import {
   GetSnapshotForEntryParams,
   GetSpaceEnvironmentParams,
   GetSpaceParams,
-  GetTagParams,
   GetTeamMembershipParams,
   GetTeamParams,
   GetTeamSpaceMembershipParams,
@@ -46,13 +45,11 @@ import {
   CreatePersonalAccessTokenProps as CreatePATProps,
 } from '../entities/access-token'
 import { PreviewApiKeyProps } from '../entities/preview-api-key'
-import { CreateRoleProps, RoleProps } from '../entities/role'
 import {
   ScheduledActionProps,
   CreateUpdateScheduledActionProps,
 } from '../entities/scheduled-action'
 import { SnapshotProps } from '../entities/snapshot'
-import { CreateTagProps, DeleteTagParams, TagProps, UpdateTagProps } from '../entities/tag'
 import { CreateTeamProps, TeamProps } from '../entities/team'
 import { CreateTeamMembershipProps, TeamMembershipProps } from '../entities/team-membership'
 import {
@@ -105,18 +102,20 @@ import { AppEventSubscriptionPlainClientAPI } from './entities/app-event-subscri
 import { AppKeyPlainClientAPI } from './entities/app-key'
 import { UserPlainClientAPI } from './entities/user'
 import { UploadPlainClientAPI } from './entities/upload'
-import { TaskPlainClientAPI } from './entities/task'
 import { OrganizationPlainClientAPI } from './entities/organization'
 import { LocalePlainClientAPI } from './entities/locale'
-import { CommentPlainClientAPI } from './entities/comment'
 import { SpacePlainClientAPI } from './entities/space'
 import { SpaceMembershipPlainClientAPI } from './entities/space-membership'
 import { SpaceMemberPlainClientAPI } from './entities/space-member'
 import { EnvironmentPlainClientAPI } from './entities/environment'
 import { EnvironmentAliasPlainClientAPI } from './entities/environment-alias'
-import { WorkflowsChangelogPlainClientAPI } from './entities/workflows-changelog'
+import { CommentPlainClientAPI } from './entities/comment'
+import { TaskPlainClientAPI } from './entities/task'
 import { WorkflowPlainClientAPI } from './entities/workflow'
+import { WorkflowsChangelogPlainClientAPI } from './entities/workflows-changelog'
 import { WorkflowDefinitionPlainClientAPI } from './entities/workflow-definition'
+import { RolePlainClientAPI } from './entities/role'
+import { TagPlainClientAPI } from './entities/tag'
 
 export type PlainClientAPI = {
   raw: {
@@ -456,31 +455,7 @@ export type PlainClientAPI = {
       params: OptionalDefaults<GetReleaseParams> & { query?: ReleaseActionQueryOptions }
     ): Promise<CollectionProp<ReleaseActionProps>>
   }
-  role: {
-    get(params: OptionalDefaults<GetSpaceParams & { roleId: string }>): Promise<RoleProps>
-    getMany(
-      params: OptionalDefaults<GetSpaceParams & QueryParams>
-    ): Promise<CollectionProp<RoleProps>>
-    getManyForOrganization(
-      params: OptionalDefaults<GetOrganizationParams & QueryParams>
-    ): Promise<CollectionProp<RoleProps>>
-    create(
-      params: OptionalDefaults<GetSpaceParams>,
-      data: CreateRoleProps,
-      headers?: RawAxiosRequestHeaders
-    ): Promise<RoleProps>
-    createWithId(
-      params: OptionalDefaults<GetSpaceParams & { roleId: string }>,
-      data: CreateRoleProps,
-      headers?: RawAxiosRequestHeaders
-    ): Promise<RoleProps>
-    update(
-      params: OptionalDefaults<GetSpaceParams & { roleId: string }>,
-      rawData: RoleProps,
-      headers?: RawAxiosRequestHeaders
-    ): Promise<RoleProps>
-    delete(params: OptionalDefaults<GetSpaceParams & { roleId: string }>): Promise<any>
-  }
+  role: RolePlainClientAPI
   scheduledActions: {
     get(
       params: OptionalDefaults<GetSpaceParams> & {
@@ -551,19 +526,7 @@ export type PlainClientAPI = {
       params: OptionalDefaults<GetSnapshotForContentTypeParams & { snapshotId: string }>
     ): Promise<SnapshotProps<ContentTypeProps>>
   }
-  tag: {
-    get(params: OptionalDefaults<GetTagParams>): Promise<TagProps>
-    getMany(
-      params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>
-    ): Promise<CollectionProp<TagProps>>
-    createWithId(params: OptionalDefaults<GetTagParams>, rawData: CreateTagProps): Promise<TagProps>
-    update(
-      params: OptionalDefaults<GetTagParams>,
-      rawData: UpdateTagProps,
-      headers?: RawAxiosRequestHeaders
-    ): Promise<TagProps>
-    delete(params: OptionalDefaults<DeleteTagParams>): Promise<any>
-  }
+  tag: TagPlainClientAPI
   organization: OrganizationPlainClientAPI
   organizationInvitation: {
     get(

diff --git a/lib/plain/entities/app-definition.ts b/lib/plain/entities/app-definition.ts
@@ -1,3 +1,4 @@
+import { RawAxiosRequestHeaders } from 'axios'
 import {
   CollectionProp,
   GetAppDefinitionParams,
@@ -10,8 +11,6 @@ import {
   CreateAppDefinitionProps,
 } from '../../entities/app-definition'
 import { OptionalDefaults } from '../wrappers/wrap'
-import { CreateOrUpdate } from './base'
-import { Get } from 'type-fest'
 
 export type AppDefinitionPlainClientAPI = {
   /**
@@ -70,7 +69,10 @@ export type AppDefinitionPlainClientAPI = {
    * );
    * ```
    */
-  create: CreateOrUpdate<GetOrganizationParams, CreateAppDefinitionProps, AppDefinitionProps>
+  create(
+    params: OptionalDefaults<GetOrganizationParams>,
+    rawData: CreateAppDefinitionProps
+  ): Promise<AppDefinitionProps>
   /**
    * Update an App Definition
    * @param params entity IDs to identify the App Definition
@@ -91,7 +93,11 @@ export type AppDefinitionPlainClientAPI = {
    * );
    * ```
    */
-  update: CreateOrUpdate<GetAppDefinitionParams, AppDefinitionProps, AppDefinitionProps>
+  update(
+    params: OptionalDefaults<GetAppDefinitionParams>,
+    rawData: AppDefinitionProps,
+    headers?: RawAxiosRequestHeaders
+  ): Promise<AppDefinitionProps>
   /**
    * Delete an App Definition
    * @param params entity IDs to identify the App Definition

diff --git a/lib/plain/entities/app-installation.ts b/lib/plain/entities/app-installation.ts
@@ -1,3 +1,4 @@
+import { RawAxiosRequestHeaders } from 'axios'
 import {
   CollectionProp,
   GetAppDefinitionParams,
@@ -8,7 +9,6 @@ import {
 import { AppInstallationsForOrganizationProps } from '../../entities/app-definition'
 import { AppInstallationProps, CreateAppInstallationProps } from '../../entities/app-installation'
 import { OptionalDefaults } from '../wrappers/wrap'
-import { CreateOrUpdate } from './base'
 
 export type AppInstallationPlainClientAPI = {
   /**
@@ -80,7 +80,11 @@ export type AppInstallationPlainClientAPI = {
    * );
    * ```
    */
-  upsert: CreateOrUpdate<GetAppInstallationParams, CreateAppInstallationProps, AppInstallationProps>
+  upsert(
+    params: OptionalDefaults<GetAppInstallationParams>,
+    rawData: CreateAppInstallationProps,
+    headers?: RawAxiosRequestHeaders
+  ): Promise<AppInstallationProps>
   /**
    * Uninstalls the App
    * @param params entity IDs to identify the App to uninstall

diff --git a/lib/plain/entities/base.ts b/lib/plain/entities/base.ts