Module: Octokit::Client::Apps
- Included in:
- Octokit::Client
- Defined in:
- lib/octokit/client/apps.rb
Overview
Methods for the Apps API
Instance Method Summary collapse
-
#add_repository_to_app_installation(installation, repo, options = {}) ⇒ Boolean
(also: #add_repo_to_installation)
Add a single repository to an installation.
- #add_repository_to_integration_installation(installation, repo, options = {}) ⇒ Object
-
#create_app_installation_access_token(installation, options = {}) ⇒ <Sawyer::Resource>
(also: #create_installation_access_token)
Create a new installation token.
- #create_integration_installation_access_token(installation, options = {}) ⇒ Object
-
#find_app_installations(options = {}) ⇒ Array<Sawyer::Resource>
(also: #find_installations)
Find all installations that belong to an App.
-
#find_installation_repositories_for_user(installation, options = {}) ⇒ Sawyer::Resource
List repositories accessible to the user for an installation.
- #find_integration_installations(options = {}) ⇒ Object
-
#find_user_installations(options = {}) ⇒ Sawyer::Resource
Find all installations that are accessible to the authenticated user.
-
#installation(id, options = {}) ⇒ Sawyer::Resource
Get a single installation.
-
#list_app_installation_repositories(options = {}) ⇒ Sawyer::Resource
(also: #list_installation_repos)
List repositories that are accessible to the authenticated installation.
- #list_integration_installation_repositories(options = {}) ⇒ Object
-
#remove_repository_from_app_installation(installation, repo, options = {}) ⇒ Boolean
(also: #remove_repo_from_installation)
Remove a single repository to an installation.
- #remove_repository_from_integration_installation(installation, repo, options = {}) ⇒ Object
Instance Method Details
#add_repository_to_app_installation(installation, repo, options = {}) ⇒ Boolean Also known as: add_repo_to_installation
Add a single repository to an installation
113 114 115 116 |
# File 'lib/octokit/client/apps.rb', line 113 def add_repository_to_app_installation(installation, repo, = {}) opts = ensure_api_media_type(:integrations, ) boolean_from_response :put, "user/installations/#{installation}/repositories/#{repo}", opts end |
#add_repository_to_integration_installation(installation, repo, options = {}) ⇒ Object
119 120 121 122 123 124 125 126 127 |
# File 'lib/octokit/client/apps.rb', line 119 def add_repository_to_integration_installation(installation, repo, = {}) octokit_warn( "Deprecated: Octokit::Client::Apps#add_repository_to_integration_installation "\ "method is deprecated. Please update your call to use "\ "Octokit::Client::Apps#add_repository_to_app_installation before the next major "\ "Octokit version update." ) add_repository_to_app_installation(installation, repo, ) end |
#create_app_installation_access_token(installation, options = {}) ⇒ <Sawyer::Resource> Also known as: create_installation_access_token
Create a new installation token
64 65 66 67 |
# File 'lib/octokit/client/apps.rb', line 64 def create_app_installation_access_token(installation, = {}) opts = ensure_api_media_type(:integrations, ) post "installations/#{installation}/access_tokens", opts end |
#create_integration_installation_access_token(installation, options = {}) ⇒ Object
70 71 72 73 74 75 76 77 78 |
# File 'lib/octokit/client/apps.rb', line 70 def create_integration_installation_access_token(installation, = {}) octokit_warn( "Deprecated: Octokit::Client::Apps#create_integration_installation_access_token "\ "method is deprecated. Please update your call to use "\ "Octokit::Client::Apps#create_app_installation_access_token before the next major "\ "Octokit version update." ) create_app_installation_access_token(installation, ) end |
#find_app_installations(options = {}) ⇒ Array<Sawyer::Resource> Also known as: find_installations
Find all installations that belong to an App
14 15 16 17 |
# File 'lib/octokit/client/apps.rb', line 14 def find_app_installations( = {}) opts = ensure_api_media_type(:integrations, ) paginate "app/installations", opts end |
#find_installation_repositories_for_user(installation, options = {}) ⇒ Sawyer::Resource
List repositories accessible to the user for an installation
162 163 164 165 166 167 |
# File 'lib/octokit/client/apps.rb', line 162 def find_installation_repositories_for_user(installation, = {}) opts = ensure_api_media_type(:integrations, ) paginate("user/installations/#{installation}/repositories", opts) do |data, last_response| data.repositories.concat last_response.data.repositories end end |
#find_integration_installations(options = {}) ⇒ Object
20 21 22 23 24 25 26 27 28 |
# File 'lib/octokit/client/apps.rb', line 20 def find_integration_installations( = {}) octokit_warn( "Deprecated: Octokit::Client::Apps#find_integration_installations "\ "method is deprecated. Please update your call to use "\ "Octokit::Client::Apps#find_app_installations before the next major "\ "Octokit version update." ) find_app_installations() end |
#find_user_installations(options = {}) ⇒ Sawyer::Resource
Find all installations that are accessible to the authenticated user
37 38 39 40 41 42 |
# File 'lib/octokit/client/apps.rb', line 37 def find_user_installations( = {}) opts = ensure_api_media_type(:integrations, ) paginate("user/installations", opts) do |data, last_response| data.installations.concat last_response.data.installations end end |
#installation(id, options = {}) ⇒ Sawyer::Resource
Get a single installation
51 52 53 54 |
# File 'lib/octokit/client/apps.rb', line 51 def installation(id, = {}) opts = ensure_api_media_type(:integrations, ) get "app/installations/#{id}", opts end |
#list_app_installation_repositories(options = {}) ⇒ Sawyer::Resource Also known as: list_installation_repos
List repositories that are accessible to the authenticated installation
86 87 88 89 90 91 |
# File 'lib/octokit/client/apps.rb', line 86 def list_app_installation_repositories( = {}) opts = ensure_api_media_type(:integrations, ) paginate("installation/repositories", opts) do |data, last_response| data.repositories.concat last_response.data.repositories end end |
#list_integration_installation_repositories(options = {}) ⇒ Object
94 95 96 97 98 99 100 101 102 |
# File 'lib/octokit/client/apps.rb', line 94 def list_integration_installation_repositories( = {}) octokit_warn( "Deprecated: Octokit::Client::Apps#list_integration_installation_repositories "\ "method is deprecated. Please update your call to use "\ "Octokit::Client::Apps#list_app_installation_repositories before the next major "\ "Octokit version update." ) list_app_installation_repositories() end |
#remove_repository_from_app_installation(installation, repo, options = {}) ⇒ Boolean Also known as: remove_repo_from_installation
Remove a single repository to an installation
138 139 140 141 |
# File 'lib/octokit/client/apps.rb', line 138 def remove_repository_from_app_installation(installation, repo, = {}) opts = ensure_api_media_type(:integrations, ) boolean_from_response :delete, "user/installations/#{installation}/repositories/#{repo}", opts end |
#remove_repository_from_integration_installation(installation, repo, options = {}) ⇒ Object
144 145 146 147 148 149 150 151 152 |
# File 'lib/octokit/client/apps.rb', line 144 def remove_repository_from_integration_installation(installation, repo, = {}) octokit_warn( "Deprecated: Octokit::Client::Apps#remove_repository_from_integration_installation "\ "method is deprecated. Please update your call to use "\ "Octokit::Client::Apps#remove_repository_from_app_installation before the next major "\ "Octokit version update." ) remove_repository_from_app_installation(installation, repo, ) end |