node-cnb 1.0.0

package/src/client.d.ts

@@ -0,0 +1,970 @@
+import {
+  DtoUsersResultForSelf,
+  DtoOrganizationAccess,
+  DtoRepos4User,
+  DtoRepos4UserBase,
+  DtoUsersResult,
+  DtoUserFollowResult,
+  DtoOrganizationUnion,
+  DtoWorkspaceDeleteResult,
+  DtoWorkspaceListResult,
+  DtoListInheritMembers,
+  DtoUsersWithAccessLevelInSlug,
+  DtoMemberAccessLevelInSlugUnion,
+  DtoMemberAccessLevel,
+  DtoOrganizationSettingWithParent,
+  DtoUploadAssetsResponse,
+  DtoBuildLogsResult,
+  DtoBuildResult,
+  DtoBuildStatusResult,
+  WebRepoContribTrend,
+  DtoForks,
+  ApiBranch,
+  ApiBranchDetail,
+  WebCommitAnnotationInBatch,
+  WebCommitAnnotation,
+  ApiCommitAsset,
+  ApiCommitStatus,
+  ApiCommit,
+  ApiCompareResponse,
+  ApiContent,
+  OpenapiHeadRef,
+  WebTagAnnotation,
+  ApiTag,
+  ApiIssue,
+  ApiIssueDetail,
+  ApiIssueComment,
+  ApiLabel,
+  DtoOutsideCollaboratorInRepo,
+  ApiPullRequest,
+  ApiPull,
+  ApiPullRequestComment,
+  ApiMergePullResponse,
+  ApiRelease,
+  ApiReleaseAsset,
+  ApiBranchProtection,
+  ApiPipelineSettings,
+  ApiPullRequestSettings,
+  ApiPushLimitSettings,
+  DtoRepoStarUsers,
+  DtoWorkspaceDetailResult,
+} from "./types";
+
+export interface Client {
+  groups: {
+    post: (params: { request: any }) => Promise<any>;
+  };
+
+  user: {
+    get: (params: {}) => Promise<DtoUsersResultForSelf>;
+
+    post: (params: { request: any }) => Promise<any>;
+
+    autocompleteSource: {
+      list: (params: {
+        source_type?: string;
+        page?: number;
+        page_size?: number;
+        search?: string;
+        access?: string;
+      }) => Promise<string[]>;
+    };
+
+    groups: {
+      list: (params: {
+        page?: number;
+        page_size?: number;
+        search?: string;
+        role?: string;
+      }) => Promise<DtoOrganizationAccess[]>;
+
+      listByGroup: (params: {
+        group: string;
+        page?: number;
+        page_size?: number;
+        access?: number;
+      }) => Promise<DtoOrganizationAccess[]>;
+    };
+
+    repos: {
+      list: (params: {
+        page?: number;
+        page_size?: number;
+        search?: string;
+        filter_type?: string;
+        role?: string;
+        order_by?: string;
+        desc?: boolean;
+      }) => Promise<DtoRepos4User[]>;
+    };
+
+    staredRepos: {
+      list: (params: {
+        page?: number;
+        page_size?: number;
+        search?: string;
+        desc?: boolean;
+        order_by?: string;
+      }) => Promise<DtoRepos4UserBase[]>;
+    };
+  };
+
+  users: {
+    get: (params: { username: string }) => Promise<DtoUsersResult>;
+
+    avatar: {
+      get: (params: { username: string; size: string }) => Promise<any>;
+    };
+
+    followers: {
+      list: (params: {
+        username: string;
+        page?: number;
+        page_size?: number;
+      }) => Promise<DtoUserFollowResult[]>;
+    };
+
+    following: {
+      list: (params: {
+        username: string;
+        page?: number;
+        page_size?: number;
+      }) => Promise<DtoUserFollowResult[]>;
+    };
+
+    groups: {
+      get: (params: {
+        username: string;
+        search?: string;
+        page?: number;
+        page_size?: number;
+        desc?: boolean;
+        order_by?: string;
+      }) => Promise<DtoOrganizationUnion>;
+    };
+
+    pinnedRepos: {
+      list: (params: { username: string }) => Promise<DtoRepos4User[]>;
+    };
+
+    repos: {
+      list: (params: {
+        username: string;
+        search?: string;
+        role?: string;
+        page?: number;
+        page_size?: number;
+        desc?: boolean;
+        order_by?: string;
+      }) => Promise<DtoRepos4User[]>;
+    };
+
+    staredRepos: {
+      list: (params: {
+        username: string;
+        search?: string;
+        page?: number;
+        page_size?: number;
+        desc?: boolean;
+        order_by?: string;
+      }) => Promise<DtoRepos4User[]>;
+    };
+  };
+
+  workspace: {
+    delete: {
+      post: (params: { request: any }) => Promise<DtoWorkspaceDeleteResult>;
+    };
+
+    list: {
+      get: (params: {
+        branch?: string;
+        end?: string;
+        page?: number;
+        pageSize?: number;
+        slug?: string;
+        start?: string;
+        status?: string;
+      }) => Promise<DtoWorkspaceListResult>;
+    };
+  };
+
+  group: {
+    get: (params: { group: string }) => Promise<DtoOrganizationAccess>;
+
+    avatar: {
+      put: (params: { group: string; request: any }) => Promise<any>;
+    };
+
+    inheritMembers: {
+      list: (params: {
+        group: string;
+        search?: string;
+        role?: string;
+        page?: number;
+        page_size?: number;
+      }) => Promise<DtoListInheritMembers[]>;
+    };
+
+    listMembers: {
+      list: (params: {
+        group: string;
+        page?: number;
+        page_size?: number;
+        role?: string;
+        search?: string;
+        names?: string;
+        order_by?: string;
+        desc?: boolean;
+      }) => Promise<DtoUsersWithAccessLevelInSlug[]>;
+    };
+
+    logos: {
+      put: (params: { group: string; token: string }) => Promise<any>;
+
+      get: (params: { group: string; size?: string }) => Promise<any>;
+    };
+
+    members: {
+      list: (params: {
+        group: string;
+        page?: number;
+        page_size?: number;
+        role?: string;
+        search?: string;
+      }) => Promise<DtoUsersWithAccessLevelInSlug[]>;
+
+      accessLevel: {
+        get: (params: {
+          group: string;
+          include_inherit?: boolean;
+        }) => Promise<DtoMemberAccessLevelInSlugUnion>;
+
+        list: (params: {
+          group: string;
+          username: string;
+        }) => Promise<DtoMemberAccessLevel[]>;
+      };
+
+      delete: (params: { group: string; username: string }) => Promise<any>;
+
+      put: (params: {
+        group: string;
+        username: string;
+        request: any;
+      }) => Promise<any>;
+    };
+
+    pinnedRepos: {
+      list: (params: { group: string }) => Promise<DtoRepos4UserBase[]>;
+
+      put: (params: {
+        group: string;
+        request: any;
+      }) => Promise<DtoRepos4UserBase[]>;
+    };
+
+    repos: {
+      list: (params: {
+        group: string;
+        page?: number;
+        page_size?: number;
+        filter_type?: string;
+        order_by?: string;
+        desc?: boolean;
+        descendant?: string;
+        search?: string;
+      }) => Promise<DtoRepos4UserBase[]>;
+
+      post: (params: { group: string; request: any }) => Promise<any>;
+    };
+
+    settings: {
+      get: (params: {
+        group: string;
+      }) => Promise<DtoOrganizationSettingWithParent>;
+
+      put: (params: { group: string; request: any }) => Promise<any>;
+    };
+
+    subGroups: {
+      list: (params: {
+        group: string;
+        search?: string;
+        page: number;
+        page_size: number;
+      }) => Promise<DtoOrganizationUnion[]>;
+    };
+
+    upload: {
+      logos: {
+        post: (params: {
+          group: string;
+          request: any;
+        }) => Promise<DtoUploadAssetsResponse>;
+      };
+    };
+  };
+
+  registry: {
+    packages: {
+      name: {
+        tag: {
+          delete: (params: {
+            registry: string;
+            type: string;
+            name: string;
+            tag: string;
+          }) => Promise<any>;
+        };
+      };
+    };
+  };
+
+  repo: {
+    get: (params: { repo: string }) => Promise<DtoRepos4User>;
+
+    build: {
+      logs: {
+        get: (params: {
+          repo: string;
+          createTime?: string;
+          endTime?: string;
+          event?: string;
+          page?: number;
+          pagesize?: number;
+          sha?: string;
+          sn?: string;
+          sourceRef?: string;
+          status?: string;
+          targetRef?: string;
+          userId?: string;
+          userName?: string;
+        }) => Promise<DtoBuildLogsResult>;
+      };
+
+      start: {
+        post: (params: {
+          repo: string;
+          request: any;
+        }) => Promise<DtoBuildResult[]>;
+      };
+
+      status: {
+        get: (params: {
+          repo: string;
+          sn: string;
+        }) => Promise<DtoBuildStatusResult>;
+      };
+
+      stop: {
+        post: (params: {
+          repo: string;
+          sn: string;
+        }) => Promise<DtoBuildResult[]>;
+      };
+    };
+
+    commitAssets: {
+      download: {
+        get: (params: { repo: string; fileName: string }) => Promise<any>;
+      };
+    };
+
+    contributor: {
+      trend: {
+        list: (params: {
+          repo: string;
+          limit?: number;
+          exclude_external_users?: boolean;
+        }) => Promise<WebRepoContribTrend[]>;
+      };
+    };
+
+    files: {
+      get: (params: {
+        repo: string;
+        userIdKey: string;
+        randomUUID: string;
+        fileName: string;
+      }) => Promise<any>;
+
+      put: (params: {
+        repo: string;
+        userIdKey: string;
+        randomUUID: string;
+        fileName: string;
+        token: string;
+      }) => Promise<any>;
+    };
+
+    forks: {
+      list: (params: {
+        repo: string;
+        page: number;
+        page_size: number;
+      }) => Promise<DtoForks[]>;
+
+      post: (params: { repo: string; request: any }) => Promise<any>;
+    };
+
+    git: {
+      branches: {
+        list: (params: {
+          repo: string;
+          page?: number;
+          page_size?: number;
+        }) => Promise<ApiBranch[]>;
+
+        post: (params: {
+          repo: string;
+          create_branch_form: any;
+        }) => Promise<any>;
+
+        delete: (params: { repo: string; branch: string }) => Promise<any>;
+
+        get: (params: {
+          repo: string;
+          branch?: string;
+        }) => Promise<ApiBranchDetail>;
+      };
+
+      commitAnnotationsInBatch: {
+        post: (params: {
+          repo: string;
+          get_commit_annotations_form: any;
+        }) => Promise<WebCommitAnnotationInBatch[]>;
+      };
+
+      commitAnnotations: {
+        list: (params: {
+          repo: string;
+          sha: string;
+        }) => Promise<WebCommitAnnotation[]>;
+
+        put: (params: {
+          repo: string;
+          sha: string;
+          put_commit_annotations_form: any;
+        }) => Promise<any>;
+
+        delete: (params: {
+          repo: string;
+          sha: string;
+          key: string;
+        }) => Promise<any>;
+      };
+
+      commitAssets: {
+        list: (params: {
+          repo: string;
+          sha1: string;
+        }) => Promise<ApiCommitAsset[]>;
+
+        assetUploadConfirmation: {
+          post: (params: {
+            repo: string;
+            sha1: number;
+            token: string;
+            asset_path: string;
+          }) => Promise<any>;
+        };
+
+        assetUploadUrl: {
+          post: (params: {
+            repo: string;
+            sha1: number;
+            create_commit_asset_upload_url_form: any;
+          }) => Promise<any>;
+        };
+
+        delete: (params: {
+          repo: string;
+          sha1: string;
+          asset_id: number;
+        }) => Promise<any>;
+      };
+
+      commitStatuses: {
+        list: (params: {
+          repo: string;
+          sha: string;
+        }) => Promise<ApiCommitStatus[]>;
+      };
+
+      commits: {
+        list: (params: {
+          repo: string;
+          sha?: string;
+          author?: string;
+          committer?: string;
+          since?: string;
+          until?: string;
+          page?: number;
+          page_size?: number;
+        }) => Promise<ApiCommit[]>;
+
+        get: (params: { repo: string; ref: string }) => Promise<ApiCommit>;
+      };
+
+      compare: {
+        get: (params: {
+          repo: string;
+          base_head: string;
+        }) => Promise<ApiCompareResponse>;
+      };
+
+      contents: {
+        get: (params: {
+          repo: string;
+          file_path: string;
+          ref?: string;
+        }) => Promise<ApiContent>;
+      };
+
+      head: {
+        get: (params: { repo: string }) => Promise<OpenapiHeadRef>;
+      };
+
+      tagAnnotations: {
+        delete: (params: {
+          repo: string;
+          tag_with_key: string;
+        }) => Promise<any>;
+
+        list: (params: {
+          repo: string;
+          tag: string;
+        }) => Promise<WebTagAnnotation[]>;
+
+        put: (params: {
+          repo: string;
+          tag: string;
+          put_tag_annotations_form: any;
+        }) => Promise<any>;
+      };
+
+      tags: {
+        list: (params: {
+          repo: string;
+          page?: number;
+          page_size?: number;
+        }) => Promise<ApiTag[]>;
+
+        delete: (params: { repo: string; tag: string }) => Promise<any>;
+
+        get: (params: { repo: string; tag: string }) => Promise<ApiTag>;
+      };
+    };
+
+    imgs: {
+      get: (params: {
+        repo: string;
+        userIdKey: string;
+        fileName: string;
+      }) => Promise<any>;
+
+      put: (params: {
+        repo: string;
+        userIdKey: string;
+        fileName: string;
+        token: string;
+      }) => Promise<any>;
+    };
+
+    inheritMembers: {
+      list: (params: {
+        repo: string;
+        search?: string;
+        role?: string;
+        page?: number;
+        page_size?: number;
+      }) => Promise<DtoListInheritMembers[]>;
+    };
+
+    issues: {
+      list: (params: {
+        repo: string;
+        page?: number;
+        page_size?: number;
+        state?: string;
+        keyword?: string;
+        priority?: string;
+        labels?: string;
+        authors?: string;
+        assignees?: string;
+        updated_time_begin?: string;
+        updated_time_end?: string;
+        order_by?: string;
+      }) => Promise<ApiIssue[]>;
+
+      post: (params: { repo: string; post_issue_form: any }) => Promise<any>;
+
+      get: (params: {
+        repo: string;
+        number: number;
+      }) => Promise<ApiIssueDetail>;
+
+      patch: (params: {
+        repo: string;
+        number: number;
+        patch_issue_form: any;
+      }) => Promise<ApiIssueDetail>;
+
+      comments: {
+        list: (params: {
+          repo: string;
+          number: number;
+          page?: number;
+          page_size?: number;
+        }) => Promise<ApiIssueComment[]>;
+
+        post: (params: {
+          repo: string;
+          number: number;
+          post_issue_comment_form: any;
+        }) => Promise<any>;
+
+        get: (params: {
+          repo: string;
+          number: number;
+          comment_id: number;
+        }) => Promise<ApiIssueComment>;
+
+        patch: (params: {
+          repo: string;
+          number: number;
+          comment_id: number;
+          patch_issue_comment_form: any;
+        }) => Promise<ApiIssueComment>;
+      };
+
+      labels: {
+        delete: (params: { repo: string; number: number }) => Promise<any>;
+
+        deleteByName: (params: {
+          repo: string;
+          number: number;
+          name: string;
+        }) => Promise<ApiLabel>;
+      };
+    };
+
+    labels: {
+      list: (params: {
+        repo: string;
+        page?: number;
+        page_size?: number;
+        keyword?: string;
+      }) => Promise<ApiLabel[]>;
+
+      post: (params: { repo: string; post_label_form: any }) => Promise<any>;
+
+      delete: (params: { repo: string; name: string }) => Promise<any>;
+
+      patch: (params: {
+        repo: string;
+        name: string;
+        patch_label_form: any;
+      }) => Promise<ApiLabel>;
+    };
+
+    listMembers: {
+      list: (params: {
+        repo: string;
+        page?: number;
+        page_size?: number;
+        role?: string;
+        search?: string;
+        names?: string;
+        order_by?: string;
+        desc?: boolean;
+      }) => Promise<DtoUsersWithAccessLevelInSlug[]>;
+    };
+
+    members: {
+      list: (params: {
+        repo: string;
+        page?: number;
+        page_size?: number;
+        role?: string;
+        search?: string;
+      }) => Promise<DtoUsersWithAccessLevelInSlug[]>;
+
+      accessLevel: {
+        get: (params: {
+          repo: string;
+          include_inherit?: boolean;
+        }) => Promise<DtoMemberAccessLevelInSlugUnion>;
+
+        list: (params: {
+          repo: string;
+          username: string;
+        }) => Promise<DtoMemberAccessLevel[]>;
+      };
+
+      delete: (params: { repo: string; username: string }) => Promise<any>;
+
+      put: (params: {
+        repo: string;
+        username: string;
+        request: any;
+      }) => Promise<any>;
+    };
+
+    outsideCollaborators: {
+      list: (params: {
+        repo: string;
+        page?: number;
+        page_size?: number;
+        role?: string;
+        search?: string;
+      }) => Promise<DtoOutsideCollaboratorInRepo[]>;
+
+      delete: (params: { repo: string; username: string }) => Promise<any>;
+
+      put: (params: {
+        repo: string;
+        username: string;
+        role: string;
+      }) => Promise<any>;
+    };
+
+    pulls: {
+      list: (params: {
+        repo: string;
+        page?: number;
+        page_size?: number;
+        state?: string;
+        authors?: string;
+        reviewers?: string;
+        assignees?: string;
+      }) => Promise<ApiPullRequest[]>;
+
+      post: (params: { repo: string; post_pull_form: any }) => Promise<any>;
+
+      get: (params: { repo: string; number: number }) => Promise<ApiPull>;
+
+      patch: (params: {
+        repo: string;
+        number: number;
+        update_pull_request_form: any;
+      }) => Promise<ApiPull>;
+
+      comments: {
+        list: (params: {
+          repo: string;
+          page?: number;
+          page_size?: number;
+        }) => Promise<ApiPullRequestComment[]>;
+
+        post: (params: {
+          repo: string;
+          number: number;
+          post_pull_comment_form: any;
+        }) => Promise<any>;
+      };
+
+      labels: {
+        delete: (params: { repo: string; number: number }) => Promise<any>;
+
+        list: (params: {
+          repo: string;
+          number: number;
+          page?: number;
+          page_size?: number;
+        }) => Promise<ApiLabel[]>;
+
+        post: (params: {
+          repo: string;
+          number: number;
+          post_pull_labels_form: any;
+        }) => Promise<ApiLabel>;
+
+        put: (params: {
+          repo: string;
+          number: number;
+          put_pull_labels_form: any;
+        }) => Promise<ApiLabel>;
+
+        deleteByName: (params: {
+          repo: string;
+          number: number;
+          name: string;
+        }) => Promise<ApiLabel>;
+      };
+
+      merge: {
+        put: (params: {
+          repo: string;
+          number: number;
+          merge_pull_request_form: any;
+        }) => Promise<ApiMergePullResponse>;
+      };
+
+      reviews: {
+        post: (params: {
+          repo: string;
+          number: number;
+          post_pull_review_form: any;
+        }) => Promise<any>;
+      };
+    };
+
+    releases: {
+      list: (params: {
+        repo: string;
+        page?: number;
+        page_size?: number;
+      }) => Promise<ApiRelease[]>;
+
+      post: (params: {
+        repo: string;
+        create_release_form: any;
+      }) => Promise<any>;
+
+      download: {
+        get: (params: { repo: string; fileName: string }) => Promise<any>;
+      };
+
+      tags: {
+        get: (params: { repo: string; tag: string }) => Promise<ApiRelease>;
+      };
+
+      delete: (params: { repo: string; release_id: number }) => Promise<any>;
+
+      get: (params: {
+        repo: string;
+        release_id: number;
+      }) => Promise<ApiRelease>;
+
+      patch: (params: {
+        repo: string;
+        release_id: number;
+        patch_release_form: any;
+      }) => Promise<any>;
+
+      assetUploadConfirmation: {
+        post: (params: {
+          repo: string;
+          release_id: number;
+          token: string;
+          asset_path: string;
+        }) => Promise<any>;
+      };
+
+      assetUploadUrl: {
+        post: (params: {
+          repo: string;
+          release_id: number;
+          create_release_asset_upload_url_form: any;
+        }) => Promise<any>;
+      };
+
+      assets: {
+        delete: (params: {
+          repo: string;
+          release_id: number;
+          asset_id: number;
+        }) => Promise<any>;
+
+        get: (params: {
+          repo: string;
+          release_id: number;
+          asset_id: number;
+        }) => Promise<ApiReleaseAsset>;
+      };
+    };
+
+    settings: {
+      branchProtections: {
+        list: (params: { repo: string }) => Promise<ApiBranchProtection[]>;
+
+        post: (params: {
+          repo: string;
+          branch_protection_form: any;
+        }) => Promise<any>;
+
+        delete: (params: { repo: string; id: string }) => Promise<any>;
+
+        get: (params: {
+          repo: string;
+          id: string;
+        }) => Promise<ApiBranchProtection>;
+
+        patch: (params: {
+          repo: string;
+          id: string;
+          branch_protection_form: any;
+        }) => Promise<any>;
+      };
+
+      cloudNativeBuild: {
+        get: (params: { repo: string }) => Promise<ApiPipelineSettings>;
+
+        put: (params: { repo: string; pipeline_form: any }) => Promise<any>;
+      };
+
+      pullRequest: {
+        get: (params: { repo: string }) => Promise<ApiPullRequestSettings>;
+
+        put: (params: { repo: string; pull_request_form: any }) => Promise<any>;
+      };
+
+      pushLimit: {
+        get: (params: { repo: string }) => Promise<ApiPushLimitSettings>;
+
+        put: (params: { repo: string; push_limit_form: any }) => Promise<any>;
+      };
+    };
+
+    stars: {
+      get: (params: {
+        repo: string;
+        filter_type: string;
+        page: number;
+        page_size: number;
+      }) => Promise<DtoRepoStarUsers>;
+    };
+
+    topActivityUsers: {
+      list: (params: {
+        repo: string;
+        top?: number;
+      }) => Promise<DtoUsersResult[]>;
+    };
+
+    upload: {
+      files: {
+        post: (params: {
+          repo: string;
+          request: any;
+        }) => Promise<DtoUploadAssetsResponse>;
+      };
+
+      imgs: {
+        post: (params: {
+          repo: string;
+          request: any;
+        }) => Promise<DtoUploadAssetsResponse>;
+      };
+
+      releases: {
+        post: (params: {
+          repo: string;
+          tagName: string;
+          request: any;
+        }) => Promise<DtoUploadAssetsResponse>;
+      };
+    };
+
+    workspace: {
+      detail: {
+        get: (params: {
+          repo: string;
+          sn: string;
+        }) => Promise<DtoWorkspaceDetailResult>;
+      };
+    };
+  };
+}