Struct Installation

pub struct Installation {

    pub access_tokens_url: String,
    pub account: User,
    pub app_id: i64,
    pub app_slug: Option<String>,
    pub created_at: InstallationCreatedAt,
    pub events: Vec<InstallationEventsItem>,
    pub has_multiple_single_files: Option<bool>,
    pub html_url: String,
    pub id: i64,
    pub permissions: InstallationPermissions,
    pub repositories_url: String,
    pub repository_selection: InstallationRepositorySelection,
    pub single_file_name: Option<String>,
    pub single_file_paths: Vec<String>,
    pub suspended_at: Option<DateTime<Utc>>,
    pub suspended_by: Option<User>,
    pub target_id: i64,
    pub target_type: InstallationTargetType,
    pub updated_at: InstallationUpdatedAt,
}

The GitHub App installation.

JSON schema

{
 "title": "Installation",
 "description": "The GitHub App installation.",
 "type": "object",
 "required": [
   "access_tokens_url",
   "account",
   "app_id",
   "created_at",
   "events",
   "html_url",
   "id",
   "permissions",
   "repositories_url",
   "repository_selection",
   "single_file_name",
   "suspended_at",
   "suspended_by",
   "target_id",
   "target_type",
   "updated_at"
 ],
 "properties": {
   "access_tokens_url": {
     "type": "string",
     "format": "uri"
   },
   "account": {
     "$ref": "#/definitions/user"
   },
   "app_id": {
     "type": "integer"
   },
   "app_slug": {
     "type": "string"
   },
   "created_at": {
     "oneOf": [
       {
         "type": "string",
         "format": "date-time"
       },
       {
         "type": "integer"
       }
     ]
   },
   "events": {
     "type": "array",
     "items": {
       "type": "string",
       "enum": [
         "branch_protection_rule",
         "check_run",
         "check_suite",
         "code_scanning_alert",
         "commit_comment",
         "create",
         "delete",
         "deployment",
         "deployment_review",
         "deployment_status",
         "deploy_key",
         "discussion",
         "discussion_comment",
         "fork",
         "gollum",
         "issues",
         "issue_comment",
         "label",
         "member",
         "membership",
         "merge_group",
         "merge_queue_entry",
         "milestone",
         "organization",
         "org_block",
         "page_build",
         "project",
         "projects_v2_item",
         "project_card",
         "project_column",
         "public",
         "pull_request",
         "pull_request_review",
         "pull_request_review_comment",
         "pull_request_review_thread",
         "push",
         "registry_package",
         "release",
         "repository",
         "repository_dispatch",
         "secret_scanning_alert",
         "secret_scanning_alert_location",
         "security_and_analysis",
         "star",
         "status",
         "team",
         "team_add",
         "watch",
         "workflow_dispatch",
         "workflow_job",
         "workflow_run"
       ]
     }
   },
   "has_multiple_single_files": {
     "type": "boolean"
   },
   "html_url": {
     "type": "string",
     "format": "uri"
   },
   "id": {
     "description": "The ID of the installation.",
     "type": "integer"
   },
   "permissions": {
     "type": "object",
     "properties": {
       "actions": {
         "description": "The level of permission granted to the access token for GitHub Actions workflows, workflow runs, and artifacts.",
         "type": "string",
         "enum": [
           "read",
           "write"
         ]
       },
       "administration": {
         "description": "The level of permission granted to the access token for repository creation, deletion, settings, teams, and collaborators creation.",
         "type": "string",
         "enum": [
           "read",
           "write"
         ]
       },
       "blocking": {
         "type": "string",
         "enum": [
           "read",
           "write"
         ]
       },
       "checks": {
         "description": "The level of permission granted to the access token for checks on code.",
         "type": "string",
         "enum": [
           "read",
           "write"
         ]
       },
       "content_references": {
         "type": "string",
         "enum": [
           "read",
           "write"
         ]
       },
       "contents": {
         "description": "The level of permission granted to the access token for repository contents, commits, branches, downloads, releases, and merges.",
         "type": "string",
         "enum": [
           "read",
           "write"
         ]
       },
       "deployments": {
         "description": "The level of permission granted to the access token for deployments and deployment statuses.",
         "type": "string",
         "enum": [
           "read",
           "write"
         ]
       },
       "discussions": {
         "type": "string",
         "enum": [
           "read",
           "write"
         ]
       },
       "emails": {
         "type": "string",
         "enum": [
           "read",
           "write"
         ]
       },
       "environments": {
         "description": "The level of permission granted to the access token for managing repository environments.",
         "type": "string",
         "enum": [
           "read",
           "write"
         ]
       },
       "issues": {
         "description": "The level of permission granted to the access token for issues and related comments, assignees, labels, and milestones.",
         "type": "string",
         "enum": [
           "read",
           "write"
         ]
       },
       "members": {
         "description": "The level of permission granted to the access token for organization teams and members.",
         "type": "string",
         "enum": [
           "read",
           "write"
         ]
       },
       "merge_queues": {
         "type": "string",
         "enum": [
           "read",
           "write"
         ]
       },
       "metadata": {
         "description": "The level of permission granted to the access token to search repositories, list collaborators, and access repository metadata.",
         "type": "string",
         "enum": [
           "read",
           "write"
         ]
       },
       "organization_administration": {
         "description": "The level of permission granted to the access token to manage access to an organization.",
         "type": "string",
         "enum": [
           "read",
           "write"
         ]
       },
       "organization_events": {
         "type": "string",
         "enum": [
           "read",
           "write"
         ]
       },
       "organization_hooks": {
         "description": "The level of permission granted to the access token to manage the post-receive hooks for an organization.",
         "type": "string",
         "enum": [
           "read",
           "write"
         ]
       },
       "organization_packages": {
         "description": "The level of permission granted to the access token for organization packages published to GitHub Packages.",
         "type": "string",
         "enum": [
           "read",
           "write"
         ]
       },
       "organization_plan": {
         "description": "The level of permission granted to the access token for viewing an organization's plan.",
         "type": "string",
         "enum": [
           "read",
           "write"
         ]
       },
       "organization_projects": {
         "description": "The level of permission granted to the access token to manage organization projects and projects beta (where available).",
         "type": "string",
         "enum": [
           "read",
           "write"
         ]
       },
       "organization_secrets": {
         "description": "The level of permission granted to the access token to manage organization secrets.",
         "type": "string",
         "enum": [
           "read",
           "write"
         ]
       },
       "organization_self_hosted_runners": {
         "description": "The level of permission granted to the access token to view and manage GitHub Actions self-hosted runners available to an organization.",
         "type": "string",
         "enum": [
           "read",
           "write"
         ]
       },
       "organization_user_blocking": {
         "description": "The level of permission granted to the access token to view and manage users blocked by the organization.",
         "type": "string",
         "enum": [
           "read",
           "write"
         ]
       },
       "packages": {
         "description": "The level of permission granted to the access token for packages published to GitHub Packages.",
         "type": "string",
         "enum": [
           "read",
           "write"
         ]
       },
       "pages": {
         "description": "The level of permission granted to the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.",
         "type": "string",
         "enum": [
           "read",
           "write"
         ]
       },
       "pull_requests": {
         "description": "The level of permission granted to the access token for pull requests and related comments, assignees, labels, milestones, and merges.",
         "type": "string",
         "enum": [
           "read",
           "write"
         ]
       },
       "repository_hooks": {
         "description": "The level of permission granted to the access token to manage the post-receive hooks for a repository.",
         "type": "string",
         "enum": [
           "read",
           "write"
         ]
       },
       "repository_projects": {
         "description": "The level of permission granted to the access token to manage repository projects, columns, and cards.",
         "type": "string",
         "enum": [
           "read",
           "write"
         ]
       },
       "secret_scanning_alerts": {
         "description": "The level of permission granted to the access token to view and manage secret scanning alerts.",
         "type": "string",
         "enum": [
           "read",
           "write"
         ]
       },
       "secrets": {
         "description": "The level of permission granted to the access token to manage repository secrets.",
         "type": "string",
         "enum": [
           "read",
           "write"
         ]
       },
       "security_events": {
         "description": "The level of permission granted to the access token to view and manage security events like code scanning alerts.",
         "type": "string",
         "enum": [
           "read",
           "write"
         ]
       },
       "security_scanning_alert": {
         "type": "string",
         "enum": [
           "read",
           "write"
         ]
       },
       "single_file": {
         "description": "The level of permission granted to the access token to manage just a single file.",
         "type": "string",
         "enum": [
           "read",
           "write"
         ]
       },
       "statuses": {
         "description": "The level of permission granted to the access token for commit statuses.",
         "type": "string",
         "enum": [
           "read",
           "write"
         ]
       },
       "team_discussions": {
         "description": "The level of permission granted to the access token to manage team discussions and related comments.",
         "type": "string",
         "enum": [
           "read",
           "write"
         ]
       },
       "vulnerability_alerts": {
         "description": "The level of permission granted to the access token to manage Dependabot alerts.",
         "type": "string",
         "enum": [
           "read",
           "write"
         ]
       },
       "workflows": {
         "description": "The level of permission granted to the access token to update GitHub Actions workflow files.",
         "type": "string",
         "enum": [
           "read",
           "write"
         ]
       }
     },
     "additionalProperties": false
   },
   "repositories_url": {
     "type": "string",
     "format": "uri"
   },
   "repository_selection": {
     "description": "Describe whether all repositories have been selected or there's a selection involved",
     "type": "string",
     "enum": [
       "all",
       "selected"
     ]
   },
   "single_file_name": {
     "type": [
       "string",
       "null"
     ]
   },
   "single_file_paths": {
     "type": "array",
     "items": {
       "type": "string"
     }
   },
   "suspended_at": {
     "type": [
       "string",
       "null"
     ],
     "format": "date-time"
   },
   "suspended_by": {
     "oneOf": [
       {
         "$ref": "#/definitions/user"
       },
       {
         "type": "null"
       }
     ]
   },
   "target_id": {
     "description": "The ID of the user or organization this token is being scoped to.",
     "type": "integer"
   },
   "target_type": {
     "type": "string",
     "enum": [
       "User",
       "Organization"
     ]
   },
   "updated_at": {
     "oneOf": [
       {
         "type": "string",
         "format": "date-time"
       },
       {
         "type": "integer"
       }
     ]
   }
 },
 "additionalProperties": false,
 "$schema": "http://json-schema.org/draft-07/schema"
}

Fields

access_tokens_url: String

account: User

app_id: i64

app_slug: Option<String>

created_at: InstallationCreatedAt

events: Vec<InstallationEventsItem>

has_multiple_single_files: Option<bool>

html_url: String

id: i64

The ID of the installation.

permissions: InstallationPermissions

repositories_url: String

repository_selection: InstallationRepositorySelection

Describe whether all repositories have been selected or there’s a selection involved

single_file_name: Option<String>

single_file_paths: Vec<String>

suspended_at: Option<DateTime<Utc>>

suspended_by: Option<User>

target_id: i64

The ID of the user or organization this token is being scoped to.

target_type: InstallationTargetType

updated_at: InstallationUpdatedAt

Implementations

impl Installation

pub fn builder() -> Installation

Trait Implementations

impl Clone for Installation

fn clone(&self) -> Installation

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Installation

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Installation

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&Installation> for Installation

fn from(value: &Installation) -> Self

Converts to this type from the input type.

impl From<Installation> for Installation

fn from(value: Installation) -> Self

Converts to this type from the input type.

impl Serialize for Installation

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Installation> for Installation

type Error = String

The type returned in the event of a conversion error.

fn try_from(value: Installation) -> Result<Self, String>

Performs the conversion.