Download the PHP package private-packagist/api-client without Composer

Private Packagist API Client

Table of Contents

• Private Packagist API Client
  • Table of Contents
  • Requirements
  • Install
  • Basic usage of private-packagist/api-client client
  • Documentation
    • Organization
      • Trigger a full synchronization
    • Team
      • List an organization's teams
      • Create a New Team
      • Show a Team
      • Edit a Team
      • Grant All Package Access
      • Revoke All Package Access
      • Delete a Team
      • Add Member to Team (by User ID)
      • Remove Member from Team
      • List all private packages a team has access to
      • Grant a team access to a list of private packages
      • Remove access for a package from a team
    • Authentication Tokens
      • List an organization's team authentication tokens
      • Create a new team authentication token
      • Delete a team authentication token
      • Regenerate a team authentication token
    • Customer
      • List an organization's customers
      • Show a customer
      • Create a customer
      • Edit a customer
      • Delete a customer
      • Enable a customer
      • Disable a customer
      • List a customer's packages
      • Show a customer's package
      • Grant a customer access to a package or edit the limitations
      • Revoke access to a package from a customer
      • Regenerate a customer's Composer repository token
      • List a customer's vendor bundles
      • Grant a customer access to a vendor bundle or edit the limitations
      • Revoke access to a vendor bundle from a customer
    • Vendor Bundle
      • List an organization's vendor bundles
      • Show a vendor bundle
      • Create a vendor bundle
      • Edit a customer
      • Delete a vendor bundle
      • List packages in a vendor bundle
      • Add one or more packages to a vendor bundle or edit their limitations
      • Remove a package from a vendor bundle
    • Subrepository
      • List an organization's subrepositories
      • Show a subrepository
      • Create a subrepository
      • Delete a subrepository
      • List a subrepository's teams
      • Add a team to a subrepository or edit the permission
      • Remove a team from a subrepository
      • List a subrepository's packages
      • Show a subrepository package
      • Create a vcs package in a subrepository
      • Create a vcs package with credentials in a subrepository
      • Create a custom package in a subrepository
      • Create a custom package with credentials in a subrepository
      • Edit a vcs package in a subrepository in a subrepository
      • Edit a custom package in a subrepository
      • Delete a package from a subrepository
      • List all dependents of a subrepository package
      • List a subrepository's authentication tokens
      • Create a subrepository authentication token
      • Delete a subrepository authentication token
      • Regenerate a subrepository authentication token
      • List a subrepository's mirrored repositories
      • Show a mirrored repository
      • Add mirrored repositories to a subrepository
      • Edit the mirroring behaviour of mirrored repository in a subrepository
      • Delete a mirrored repository from a subrepository
      • List all mirrored packages from a mirrored repository in a subrepository
      • Add mirrored packages from one mirrored repository to a subrepository
      • Remove all mirrored packages from one mirrored repository in a subrepository
    • Package
      • List an organization's packages
      • Show a package
      • Create a vcs package
      • Create a vcs package with credentials
      • Create a vcs package with a specific type
      • Create a custom package
      • Create a custom package with credentials
      • Edit a vcs package
      • Edit a custom package
      • Delete a package
      • List all dependents of a package
      • List all customers with access to a package
      • List all security issues of a package
      • Show the security monitoring config of a package
      • Edit the security monitoring config of a package
      • Create an artifact package file
      • Create an artifact package
      • Add an artifact file to an existing package
      • Update or replace artifact files of a package
    • Credential
      • List an organization's credentials
      • Show a credential
      • Create a credential
      • Edit a credential
      • Delete a credential
    • Mirrored Repository
      • List an organization's mirrored repositories
      • Show a mirrored repository
      • Create a mirrored repository
      • Edit a mirrored repository
      • Delete a mirrored repository
      • List all mirrored packages from one repository
      • Add mirrored packages from one repository
      • Remove all mirrored packages from one repository
    • Job
      • Show a job
      • Wait for a job to finish
    • Security Issue
      • List an organization's security issues
    • Magento legacy keys
      • List all legacy keys for a customer
      • Create a new legacy keys for a customer
      • Delete a legacy keys from a customer
    • Validate incoming webhook payloads
  • License

Requirements

• PHP >= 7.2
• Guzzle library,

Install

Via Composer:

Why do you need to require guzzlehttp/guzzle? We are decoupled from any HTTP messaging client with help by HTTPlug, so you can pick an HTTP client of your choice, guzzle is merely a recommendation.

Basic usage of private-packagist/api-client client

From $client object, you can access the full Private Packagist API.

Documentation

Full documentation can be found in the Private Packagist documentation.

Organization

Trigger a full synchronization

Returns an array of created jobs. One for every synchronization.

Team

The permissions available for a team are:

• canEditTeamPackages: members of the team can edit and remove packages, assign package permissions (only applies to packages assigned to team).
• canAddPackages: members of the team can add packages to organization; add, edit and remove credentials and mirrored third-party repositories.
• canCreateSubrepositories: members of the team can create subrepositories.
• canViewVendorCustomers: members of the team can view customers, their Composer information, their packages, and their install statistics.
• canManageVendorCustomers: members of the team can create and delete customers, add and remove packages, update their settings, view Composer information and install statistics.

The permissions model can also be constructed via flags:

Or from the permissions of an existing team:

List an organization's teams

Returns an array of teams.

Create a New Team

Creates a team and sets permissions applied to team members. Returns the newly-created team.

Show a Team

Returns the team including all its members.

Edit a Team

Edits a team's name and permissions to be applied to team members. Returns the updated team.

Grant All Package Access

Granting a team access to all packages will give this team access to all current and future organization packages which do not have their permissions synchronized.

Revoke All Package Access

Revoking a team's access to all packages will not remove access to packages the team can currently access, but will prevent access to new packages and allow revoking individual package access.

Delete a Team

Add Member to Team (by User ID)

Returns the team the user was added to.

Remove Member from Team

List all private packages a team has access to

Returns an array of packages.

Grant a team access to a list of private packages

You pass an array of packages to give access to. The values of the array can be either package ID or package name.

Returns an array of packages.

Remove access for a package from a team

You can use the package ID or package name as a reference.

Authentication Tokens

List an organization's team authentication tokens

Returns an array of team tokens.

Create a new team authentication token

Returns the created token.

Delete a team authentication token

Regenerate a team authentication token

Returns the regenerated token.

Customer

List an organization's customers

Returns an array of customers.

Show a customer

Returns a single customer.

Create a customer

Returns the customer.

Edit a customer

Returns the customer.

Delete a customer

Enable a customer

Disable a customer

List a customer's packages

Returns an array of customer packages.

Show a customer's package

Returns a customer's package, including the versions that the customer has been granted access to.

Grant a customer access to a package or edit the limitations

Returns an array of all added or edited customer packages.

Revoke access to a package from a customer

You can reference the package by its ID or name.

Regenerate a customer's Composer repository token

Returns the edited Composer repository.

List a customer's vendor bundles

Returns an array of customer vendor bundles.

Grant a customer access to a vendor bundle or edit the limitations

Returns the added or edited customer vendor bundle.

Revoke access to a vendor bundle from a customer

Vendor Bundle

List an organization's vendor bundles

Returns an array of vendor bundles.

Show a vendor bundle

Returns a single vendor bundle.

Create a vendor bundle

Returns the vendor bundle.

Edit a customer

Returns the vendor bundle.

Delete a vendor bundle

List packages in a vendor bundle

Returns an array of vendor bundle packages.

Add one or more packages to a vendor bundle or edit their limitations

Returns an array of all added or edited customer packages.

Remove a package from a vendor bundle

You can reference the package by its ID or name.

Subrepository

List an organization's subrepositories

Returns an array of subrepositories.

Show a subrepository

Returns a single subrepository.

Create a subrepository

Returns the subrepository.

Delete a subrepository

List a subrepository's teams

Returns an array of subrepositories teams.

Add a team to a subrepository or edit the permission

Returns an array of added subrepository teams.

Remove a team from a subrepository

List a subrepository's packages

Returns an array of subrepositories packages.

Show a subrepository package

You can reference a package by its name or ID.

Returns the package.

Create a vcs package in a subrepository

Returns a new job.

Create a vcs package with credentials in a subrepository

Returns a new job.

Create a custom package in a subrepository

Returns a new job.

Create a custom package with credentials in a subrepository

Returns a new job.

Edit a vcs package in a subrepository in a subrepository

Returns a new job.

Edit a custom package in a subrepository

Returns a new job.

Delete a package from a subrepository

List all dependents of a subrepository package

Returns a list of packages.

List a subrepository's authentication tokens

Returns an array of authentication tokens.

Create a subrepository authentication token

Returns the authentication token.

Delete a subrepository authentication token

Regenerate a subrepository authentication token

Returns the authentication token.

List a subrepository's mirrored repositories

Returns an array of mirrored repositories.

Show a mirrored repository

Returns the mirrored repository.

Add mirrored repositories to a subrepository

Returns a list of added mirrored repositories.

Edit the mirroring behaviour of mirrored repository in a subrepository

Returns the edited mirrored repository.

Delete a mirrored repository from a subrepository

List all mirrored packages from a mirrored repository in a subrepository

Returns an array of packages.

Add mirrored packages from one mirrored repository to a subrepository

Returns an array of jobs.

Remove all mirrored packages from one mirrored repository in a subrepository

Package

You can reference a package by its name or ID.

List an organization's packages

Returns an array of packages.

Show a package

Returns the package.

Create a vcs package

Returns a new job.

Create a vcs package with credentials

Returns a new job.

Create a vcs package with a specific type

Returns a new job.

Create a custom package

Returns a new job.

Create a custom package with credentials

Returns a new job.

Edit a vcs package

Returns a new job.

Edit a custom package

Returns a new job.

Delete a package

List all dependents of a package

Returns a list of packages.

List all customers with access to a package

Pass either package ID or package name as argument.

Returns a list of customers with access to the package.

List all security issues of a package

Returns a list of security issues.

Show the security monitoring config of a package

Returns the security monitoring config of the package.

Edit the security monitoring config of a package

Returns the edited security monitoring config of the package.

Create an artifact package file

Create an artifact package

Add an artifact file to an existing package

Update or replace artifact files of a package

Credential

List an organization's credentials

Returns an array of credentials.

Show a credential

Returns the credential.

Create a credential

Returns the new credential.

Edit a credential

Returns the edited credential.

Delete a credential

Mirrored Repository

List an organization's mirrored repositories

Returns an array of mirrored repositories.

Show a mirrored repository

Returns the mirrored repository.

Create a mirrored repository

Returns the new mirrored repository.

Edit a mirrored repository

Returns the edited mirrored repository.

Delete a mirrored repository

List all mirrored packages from one repository

Returns an array of packages.

Add mirrored packages from one repository

Returns an array of jobs.

Remove all mirrored packages from one repository

Job

Show a job

Returns the job.

Wait for a job to finish

This will periodically poll the job status until the job either finished or the maximum wait time was reached

Returns the job.

Security Issue

List an organization's security issues

Returns an array of security issues.

Magento legacy keys

List all legacy keys for a customer

Returns a list of Magento legacy keys.

Create a new legacy keys for a customer

Returns the new Magento legacy key.

Delete a legacy keys from a customer

Validate incoming webhook payloads

When you create or update a webhook in Private Packagist an optional secret can be set. This secret gets used to create a signature which is sent with each request in the headers as Packagist-Signature. The secret and signature can then be used on your server to validate that the request was made by Private Packagist. If no secret is set then no signature is sent.

License

private-packagist/api-client is licensed under the MIT License