feat: new Endpoints for suspending/unsuspending an installation (#58)

Co-authored-by: Octokit Bot <33075676+octokitbot@users.noreply.github.com>
octokit · May 5, 2020 · 0689ba8 · 0689ba8
1 parent baee0aa
commit 0689ba8
Show file tree

Hide file tree

Showing 2 changed files with 176 additions and 48 deletions.
diff --git a/scripts/update-endpoints/generated/endpoints.json b/scripts/update-endpoints/generated/endpoints.json
@@ -242,6 +242,54 @@
     ],
     "renamed": null
   },
+  {
+    "name": "Suspend an installation",
+    "scope": "apps",
+    "id": "suspendInstallation",
+    "method": "PUT",
+    "url": "/app/installations/{installation_id}/suspended",
+    "documentationUrl": "https://developer.github.com/v3/apps/#suspend-an-installation",
+    "parameters": [
+      {
+        "alias": null,
+        "allowNull": false,
+        "deprecated": null,
+        "description": "installation_id parameter",
+        "enum": null,
+        "name": "installation_id",
+        "type": "integer",
+        "required": true
+      }
+    ],
+    "previews": [],
+    "headers": [],
+    "responses": [],
+    "renamed": null
+  },
+  {
+    "name": "Unsuspend an installation",
+    "scope": "apps",
+    "id": "unsuspendInstallation",
+    "method": "DELETE",
+    "url": "/app/installations/{installation_id}/suspended",
+    "documentationUrl": "https://developer.github.com/v3/apps/#unsuspend-an-installation",
+    "parameters": [
+      {
+        "alias": null,
+        "allowNull": false,
+        "deprecated": null,
+        "description": "installation_id parameter",
+        "enum": null,
+        "name": "installation_id",
+        "type": "integer",
+        "required": true
+      }
+    ],
+    "previews": [],
+    "headers": [],
+    "responses": [],
+    "renamed": null
+  },
   {
     "name": "List your grants",
     "scope": "oauthAuthorizations",
@@ -11471,12 +11519,12 @@
     "renamed": null
   },
   {
-    "name": "List workflow job logs",
+    "name": "Download workflow job logs",
     "scope": "actions",
-    "id": "listWorkflowJobLogs",
+    "id": "downloadWorkflowJobLogs",
     "method": "GET",
     "url": "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs",
-    "documentationUrl": "https://developer.github.com/v3/actions/workflow-jobs/#list-workflow-job-logs",
+    "documentationUrl": "https://developer.github.com/v3/actions/workflow-jobs/#download-workflow-job-logs",
     "parameters": [
       {
         "alias": null,
@@ -11507,32 +11555,58 @@
         "name": "job_id",
         "type": "integer",
         "required": true
+      }
+    ],
+    "previews": [],
+    "headers": [],
+    "responses": [],
+    "renamed": null
+  },
+  {
+    "name": "Download workflow job logs",
+    "scope": "actions",
+    "id": "listWorkflowJobLogs",
+    "method": "GET",
+    "url": "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs",
+    "documentationUrl": "https://developer.github.com/v3/actions/workflow-jobs/#download-workflow-job-logs",
+    "parameters": [
+      {
+        "alias": null,
+        "allowNull": false,
+        "deprecated": null,
+        "description": "owner parameter",
+        "enum": null,
+        "name": "owner",
+        "type": "string",
+        "required": true
       },
       {
         "alias": null,
         "allowNull": false,
         "deprecated": null,
-        "description": "Results per page (max 100)",
+        "description": "repo parameter",
         "enum": null,
-        "name": "per_page",
-        "type": "integer",
-        "required": false
+        "name": "repo",
+        "type": "string",
+        "required": true
       },
       {
         "alias": null,
         "allowNull": false,
         "deprecated": null,
-        "description": "Page number of the results to fetch.",
+        "description": "job_id parameter",
         "enum": null,
-        "name": "page",
+        "name": "job_id",
         "type": "integer",
-        "required": false
+        "required": true
       }
     ],
     "previews": [],
     "headers": [],
     "responses": [],
-    "renamed": null
+    "renamed": {
+      "note": "\"actions/list-workflow-job-logs\" operation ID is now \"actions/download-workflow-job-logs\""
+    }
   },
   {
     "name": "List self-hosted runners for a repository",
@@ -12429,12 +12503,12 @@
     "renamed": null
   },
   {
-    "name": "List workflow run logs",
+    "name": "Download workflow run logs",
     "scope": "actions",
-    "id": "listWorkflowRunLogs",
+    "id": "downloadWorkflowRunLogs",
     "method": "GET",
     "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/logs",
-    "documentationUrl": "https://developer.github.com/v3/actions/workflow-runs/#list-workflow-run-logs",
+    "documentationUrl": "https://developer.github.com/v3/actions/workflow-runs/#download-workflow-run-logs",
     "parameters": [
       {
         "alias": null,
@@ -12465,32 +12539,58 @@
         "name": "run_id",
         "type": "integer",
         "required": true
+      }
+    ],
+    "previews": [],
+    "headers": [],
+    "responses": [],
+    "renamed": null
+  },
+  {
+    "name": "Download workflow run logs",
+    "scope": "actions",
+    "id": "listWorkflowRunLogs",
+    "method": "GET",
+    "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/logs",
+    "documentationUrl": "https://developer.github.com/v3/actions/workflow-runs/#download-workflow-run-logs",
+    "parameters": [
+      {
+        "alias": null,
+        "allowNull": false,
+        "deprecated": null,
+        "description": "owner parameter",
+        "enum": null,
+        "name": "owner",
+        "type": "string",
+        "required": true
       },
       {
         "alias": null,
         "allowNull": false,
         "deprecated": null,
-        "description": "Results per page (max 100)",
+        "description": "repo parameter",
         "enum": null,
-        "name": "per_page",
-        "type": "integer",
-        "required": false
+        "name": "repo",
+        "type": "string",
+        "required": true
       },
       {
         "alias": null,
         "allowNull": false,
         "deprecated": null,
-        "description": "Page number of the results to fetch.",
+        "description": "run_id parameter",
         "enum": null,
-        "name": "page",
+        "name": "run_id",
         "type": "integer",
-        "required": false
+        "required": true
       }
     ],
     "previews": [],
     "headers": [],
     "responses": [],
-    "renamed": null
+    "renamed": {
+      "note": "\"actions/list-workflow-run-logs\" operation ID is now \"actions/download-workflow-run-logs\""
+    }
   },
   {
     "name": "Delete workflow run logs",

diff --git a/src/generated/Endpoints.ts b/src/generated/Endpoints.ts
@@ -18,6 +18,14 @@ export interface Endpoints {
     request: AppsDeleteInstallationRequestOptions;
     response: OctokitResponse<any>;
   };
+  /**
+   * @see https://developer.github.com/v3/apps/#unsuspend-an-installation
+   */
+  "DELETE /app/installations/:installation_id/suspended": {
+    parameters: AppsUnsuspendInstallationEndpoint;
+    request: AppsUnsuspendInstallationRequestOptions;
+    response: OctokitResponse<any>;
+  };
   /**
    * @see https://developer.github.com/v3/apps/oauth_applications/#delete-an-app-authorization
    */
@@ -1685,11 +1693,11 @@ export interface Endpoints {
     response: OctokitResponse<ActionsGetWorkflowJobResponseData>;
   };
   /**
-   * @see https://developer.github.com/v3/actions/workflow-jobs/#list-workflow-job-logs
+   * @see https://developer.github.com/v3/actions/workflow-jobs/#download-workflow-job-logs
    */
   "GET /repos/:owner/:repo/actions/jobs/:job_id/logs": {
-    parameters: ActionsListWorkflowJobLogsEndpoint;
-    request: ActionsListWorkflowJobLogsRequestOptions;
+    parameters: ActionsDownloadWorkflowJobLogsEndpoint;
+    request: ActionsDownloadWorkflowJobLogsRequestOptions;
     response: OctokitResponse<any>;
   };
   /**
@@ -1749,11 +1757,11 @@ export interface Endpoints {
     response: OctokitResponse<ActionsListJobsForWorkflowRunResponseData>;
   };
   /**
-   * @see https://developer.github.com/v3/actions/workflow-runs/#list-workflow-run-logs
+   * @see https://developer.github.com/v3/actions/workflow-runs/#download-workflow-run-logs
    */
   "GET /repos/:owner/:repo/actions/runs/:run_id/logs": {
-    parameters: ActionsListWorkflowRunLogsEndpoint;
-    request: ActionsListWorkflowRunLogsRequestOptions;
+    parameters: ActionsDownloadWorkflowRunLogsEndpoint;
+    request: ActionsDownloadWorkflowRunLogsRequestOptions;
     response: OctokitResponse<any>;
   };
   /**
@@ -4564,6 +4572,14 @@ export interface Endpoints {
     request: ReposCreateForAuthenticatedUserRequestOptions;
     response: OctokitResponse<ReposCreateForAuthenticatedUserResponseData>;
   };
+  /**
+   * @see https://developer.github.com/v3/apps/#suspend-an-installation
+   */
+  "PUT /app/installations/:installation_id/suspended": {
+    parameters: AppsSuspendInstallationEndpoint;
+    request: AppsSuspendInstallationRequestOptions;
+    response: OctokitResponse<any>;
+  };
   /**
    * @see https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app
    */
@@ -5303,6 +5319,34 @@ type AppsCreateInstallationTokenResponseData = {
   repositories: Array<AppsCreateInstallationTokenResponseDataRepositoriesItem>;
 };
 
+type AppsSuspendInstallationEndpoint = {
+  /**
+   * installation_id parameter
+   */
+  installation_id: number;
+};
+
+type AppsSuspendInstallationRequestOptions = {
+  method: "PUT";
+  url: "/app/installations/:installation_id/suspended";
+  headers: RequestHeaders;
+  request: RequestRequestOptions;
+};
+
+type AppsUnsuspendInstallationEndpoint = {
+  /**
+   * installation_id parameter
+   */
+  installation_id: number;
+};
+
+type AppsUnsuspendInstallationRequestOptions = {
+  method: "DELETE";
+  url: "/app/installations/:installation_id/suspended";
+  headers: RequestHeaders;
+  request: RequestRequestOptions;
+};
+
 type OauthAuthorizationsListGrantsEndpoint = {
   /**
    * Results per page (max 100)
@@ -15916,7 +15960,7 @@ type ActionsGetWorkflowJobResponseData = {
   check_run_url: string;
 };
 
-type ActionsListWorkflowJobLogsEndpoint = {
+type ActionsDownloadWorkflowJobLogsEndpoint = {
   /**
    * owner parameter
    */
@@ -15929,17 +15973,9 @@ type ActionsListWorkflowJobLogsEndpoint = {
    * job_id parameter
    */
   job_id: number;
-  /**
-   * Results per page (max 100)
-   */
-  per_page?: number;
-  /**
-   * Page number of the results to fetch.
-   */
-  page?: number;
 };
 
-type ActionsListWorkflowJobLogsRequestOptions = {
+type ActionsDownloadWorkflowJobLogsRequestOptions = {
   method: "GET";
   url: "/repos/:owner/:repo/actions/jobs/:job_id/logs";
   headers: RequestHeaders;
@@ -16658,7 +16694,7 @@ type ActionsListJobsForWorkflowRunResponseData = {
   jobs: Array<ActionsListJobsForWorkflowRunResponseDataJobsItem>;
 };
 
-type ActionsListWorkflowRunLogsEndpoint = {
+type ActionsDownloadWorkflowRunLogsEndpoint = {
   /**
    * owner parameter
    */
@@ -16671,17 +16707,9 @@ type ActionsListWorkflowRunLogsEndpoint = {
    * run_id parameter
    */
   run_id: number;
-  /**
-   * Results per page (max 100)
-   */
-  per_page?: number;
-  /**
-   * Page number of the results to fetch.
-   */
-  page?: number;
 };
 
-type ActionsListWorkflowRunLogsRequestOptions = {
+type ActionsDownloadWorkflowRunLogsRequestOptions = {
   method: "GET";
   url: "/repos/:owner/:repo/actions/runs/:run_id/logs";
   headers: RequestHeaders;