Skip to content

Commit 54ba8c2

Browse files
committed
Update README
1 parent 2c7fbbf commit 54ba8c2

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -212,6 +212,10 @@ $team = $client->teams()->all()[0];
212212
$permissions = TeamPermissions::fromTeamResponse($team);
213213
```
214214

215+
Additionally, teams have a separate "All Package Access" flag, determining whether the team has access to all current and future
216+
organization packages which do not have their permissions synchronized. Revoking "All Package Access" will not remove access to
217+
packages the team can currently access, but will prevent access to new packages and allow revoking individual package access.
218+
215219
#### List an organization's teams
216220
```php
217221
$teams = $client->teams()->all();
@@ -223,10 +227,12 @@ Returns an array of teams.
223227
use PrivatePackagist\ApiClient\TeamPermissions;
224228

225229
$permissions = new TeamPermissions;
226-
$team = $client->teams()->create('New Team Name', $permissions);
230+
$team = $client->teams()->create('New Team Name', $permissions, $canAccessAllPackages);
227231
```
228232
Creates a team and sets permissions applied to team members. Returns the newly-created team.
229233

234+
The `$canAccessAllPackages` argument defaults to `false`.
235+
230236
#### Show a Team
231237
```php
232238

@@ -240,10 +246,12 @@ Returns the team including all its members.
240246
use PrivatePackagist\ApiClient\TeamPermissions;
241247

242248
$permissions = new TeamPermissions;
243-
$team = $client->teams()->edit($teamId, 'Altered Team Name', $permissions);
249+
$team = $client->teams()->edit($teamId, 'Altered Team Name', $permissions, $canAccessAllPackages);
244250
```
245251
Edits a team's name and permissions to be applied to team members. Returns the updated team.
246252

253+
The `$canAccessAllPackages` argument defaults to `null`, meaning that the setting is left unchanged.
254+
247255
#### Delete a Team
248256
```php
249257
$client->teams()->remove($teamId);
@@ -477,7 +485,7 @@ Returns the vendor bundle.
477485
$vendorBundleId = 42;
478486
$vendorBundleData = [
479487
'name' => 'Bundle name',
480-
'minimumAccessibleStability' => 'dev',
488+
'minimumAccessibleStability' => 'dev',
481489
'versionConstraint' => '^1.0',
482490
'assignAllPackages' => true,
483491
'synchronizationIds' => [123], // A list of synchronization ids for which new packages should automatically be added to the bundle.

0 commit comments

Comments
 (0)