diff --git a/README.md b/README.md index dd90b74..83e2fd1 100644 --- a/README.md +++ b/README.md @@ -2,135 +2,136 @@ ## Table of Contents - * [Private Packagist API Client](#private-packagist-api-client) - * [Table of Contents](#table-of-contents) - * [Requirements](#requirements) - * [Install](#install) - * [Basic usage of private-packagist/api-client client](#basic-usage-of-private-packagistapi-client-client) - * [Documentation](#documentation) - * [Organization](#organization) - * [Trigger a full synchronization](#trigger-a-full-synchronization) - * [Team](#team) - * [List an organization's teams](#list-an-organizations-teams) - * [Create a New Team](#create-a-new-team) - * [Show a Team](#show-a-team) - * [Edit a Team](#edit-a-team) - * [Grant All Package Access](#grant-all-package-access) - * [Revoke All Package Access](#revoke-all-package-access) - * [Delete a Team](#delete-a-team) - * [Add Member to Team (by User ID)](#add-member-to-team-by-user-id) - * [Remove Member from Team](#remove-member-from-team) - * [List all private packages a team has access to](#list-all-private-packages-a-team-has-access-to) - * [Grant a team access to a list of private packages](#grant-a-team-access-to-a-list-of-private-packages) - * [Remove access for a package from a team](#remove-access-for-a-package-from-a-team) - * [Authentication Tokens](#authentication-tokens) - * [List an organization's team authentication tokens](#list-an-organizations-team-authentication-tokens) - * [Create a new team authentication token](#create-a-new-team-authentication-token) - * [Delete a team authentication token](#delete-a-team-authentication-token) - * [Regenerate a team authentication token](#regenerate-a-team-authentication-token) - * [Customer](#customer) - * [List an organization's customers](#list-an-organizations-customers) - * [Show a customer](#show-a-customer) - * [Create a customer](#create-a-customer) - * [Edit a customer](#edit-a-customer) - * [Delete a customer](#delete-a-customer) - * [Enable a customer](#enable-a-customer) - * [Disable a customer](#disable-a-customer) - * [List a customer's packages](#list-a-customers-packages) - * [Show a customer's package](#show-a-customers-package) - * [Grant a customer access to a package or edit the limitations](#grant-a-customer-access-to-a-package-or-edit-the-limitations) - * [Revoke access to a package from a customer](#revoke-access-to-a-package-from-a-customer) - * [Regenerate a customer's Composer repository token](#regenerate-a-customers-composer-repository-token) - * [List a customer's vendor bundles](#list-a-customers-vendor-bundles) - * [Grant a customer access to a vendor bundle or edit the limitations](#grant-a-customer-access-to-a-vendor-bundle-or-edit-the-limitations) - * [Revoke access to a vendor bundle from a customer](#revoke-access-to-a-vendor-bundle-from-a-customer) - * [Vendor Bundle](#vendor-bundle) - * [List an organization's vendor bundles](#list-an-organizations-vendor-bundles) - * [Show a vendor bundle](#show-a-vendor-bundle) - * [Create a vendor bundle](#create-a-vendor-bundle) - * [Edit a customer](#edit-a-customer-1) - * [Delete a vendor bundle](#delete-a-vendor-bundle) - * [List packages in a vendor bundle](#list-packages-in-a-vendor-bundle) - * [Add one or more packages to a vendor bundle or edit their limitations](#add-one-or-more-packages-to-a-vendor-bundle-or-edit-their-limitations) - * [Remove a package from a vendor bundle](#remove-a-package-from-a-vendor-bundle) - * [Subrepository](#subrepository) - * [List an organization's subrepositories](#list-an-organizations-subrepositories) - * [Show a subrepository](#show-a-subrepository) - * [Create a subrepository](#create-a-subrepository) - * [Delete a subrepository](#delete-a-subrepository) - * [List a subrepository's teams](#list-a-subrepositoriess-teams) - * [Add a team to a subrepository or edit the permission](#add-a-team-to-a-subrepository-or-edit-the-permission) - * [Remove a team from a subrepository](#remove-a-team-from-a-subrepository) - * [List a subrepository's packages](#list-a-subrepositoriess-packages) - * [Show a subrepository package](#show-a-subrepository-package) - * [Create a vcs package in a subrepository](#create-a-vcs-package-in-a-subrepository) - * [Create a vcs package with credentials in a subrepository](#create-a-vcs-package-with-credentials-in-a-subrepository) - * [Create a custom package in a subrepository](#create-a-custom-package-in-a-subrepository) - * [Create a custom package with credentials in a subrepository](#create-a-custom-package-with-credentials-in-a-subrepository) - * [Edit a vcs package in a subrepository in a subrepository](#edit-a-vcs-package-in-a-subrepository-in-a-subrepository) - * [Edit a custom package in a subrepository](#edit-a-custom-package-in-a-subrepository) - * [Delete a package from a subrepository](#delete-a-package-from-a-subrepository) - * [List all dependents of a subrepository package](#list-all-dependents-of-a-subrepository-package) - * [List a subrepository's authentication tokens](#list-a-subrepositoriess-authentication-tokens) - * [Create a subrepository authentication token](#create-a-subrepository-authentication-token) - * [Delete a subrepository authentication token](#delete-a-subrepository-authentication-token) - * [Regenerate a subrepository authentication token](#regenerate-a-subrepository-authentication-token) - * [List a subrepository's mirrored repositories](#list-a-subrepositoriess-mirrored-repositories) - * [Show a mirrored repository](#show-a-mirrored-repository) - * [Add mirrored repositories to a subrepository](#add-mirrored-repositories-to-a-subrepository) - * [Edit the mirroring behaviour of mirrored repository in a subrepository](#edit-the-mirroring-behaviour-of-mirrored-repository-in-a-subrepository) - * [Delete a mirrored repository from a subrepository](#delete-a-mirrored-repository-from-a-subrepository) - * [List all mirrored packages from a mirrored repository in a subrepository](#list-all-mirrored-packages-from-a-mirrored-repository-in-a-subrepository) - * [Add mirrored packages from one mirrored repository to a subrepository](#add-mirrored-packages-from-one-mirrored-repository-to-a-subrepository) - * [Remove all mirrored packages from one mirrored repository in a subrepository](#remove-all-mirrored-packages-from-one-mirrored-repository-in-a-subrepository) - * [Package](#package) - * [List an organization's packages](#list-an-organizations-packages) - * [Show a package](#show-a-package) - * [Create a vcs package](#create-a-vcs-package) - * [Create a vcs package with credentials](#create-a-vcs-package-with-credentials) - * [Create a vcs package with a specific type](#create-a-vcs-package-with-a-specific-type) - * [Create a custom package](#create-a-custom-package) - * [Create a custom package with credentials](#create-a-custom-package-with-credentials) - * [Edit a vcs package](#edit-a-vcs-package) - * [Edit a custom package](#edit-a-custom-package) - * [Delete a package](#delete-a-package) - * [List all dependents of a package](#list-all-dependents-of-a-package) - * [List all customers with access to a package](#list-all-customers-with-access-to-a-package) - * [List all security issues of a package](#list-all-security-issues-of-a-package) - * [Show the security monitoring config of a package](#show-the-security-monitoring-config-of-a-package) - * [Edit the security monitoring config of a package](#edit-the-security-monitoring-config-of-a-package) - * [Create an artifact package file](#create-an-artifact-package-file) - * [Create an artifact package](#create-an-artifact-package) - * [Add an artifact file to an existing package](#add-an-artifact-file-to-an-existing-package) - * [Update or replace artifact files of a package](#update-or-replace-artifact-files-of-a-package) - * [Credential](#credential) - * [List an organization's credentials](#list-an-organizations-credentials) - * [Show a credential](#show-a-credential) - * [Create a credential](#create-a-credential) - * [Edit a credential](#edit-a-credential) - * [Delete a credential](#delete-a-credential) - * [Mirrored Repository](#mirrored-repository) - * [List an organization's mirrored repositories](#list-an-organizations-mirrored-repositories) - * [Show a mirrored repository](#show-a-mirrored-repository-1) - * [Create a mirrored repository](#create-a-mirrored-repository) - * [Edit a mirrored repository](#edit-a-mirrored-repository) - * [Delete a mirrored repository](#delete-a-mirrored-repository) - * [List all mirrored packages from one repository](#list-all-mirrored-packages-from-one-repository) - * [Add mirrored packages from one repository](#add-mirrored-packages-from-one-repository) - * [Remove all mirrored packages from one repository](#remove-all-mirrored-packages-from-one-repository) - * [Job](#job) - * [Show a job](#show-a-job) - * [Wait for a job to finish](#wait-for-a-job-to-finish) - * [Security Issue](#security-issue) - * [List an organization's security issues](#list-an-organizations-security-issues) - * [Magento legacy keys](#magento-legacy-keys) - * [List all legacy keys for a customer](#list-all-legacy-keys-for-a-customer) - * [Create a new legacy keys for a customer](#create-a-new-legacy-keys-for-a-customer) - * [Delete a legacy keys from a customer](#delete-a-legacy-keys-from-a-customer) - * [Validate incoming webhook payloads](#validate-incoming-webhook-payloads) - * [License](#license) - - +* [Private Packagist API Client](#private-packagist-api-client) + * [Table of Contents](#table-of-contents) + * [Requirements](#requirements) + * [Install](#install) + * [Basic usage of private-packagist/api-client client](#basic-usage-of-private-packagistapi-client-client) + * [Documentation](#documentation) + * [Organization](#organization) + * [Trigger a full synchronization](#trigger-a-full-synchronization) + * [Team](#team) + * [List an organization's teams](#list-an-organizations-teams) + * [Create a New Team](#create-a-new-team) + * [Show a Team](#show-a-team) + * [Edit a Team](#edit-a-team) + * [Grant All Package Access](#grant-all-package-access) + * [Revoke All Package Access](#revoke-all-package-access) + * [Delete a Team](#delete-a-team) + * [Add Member to Team (by User ID)](#add-member-to-team-by-user-id) + * [Remove Member from Team](#remove-member-from-team) + * [List all private packages a team has access to](#list-all-private-packages-a-team-has-access-to) + * [Grant a team access to a list of private packages](#grant-a-team-access-to-a-list-of-private-packages) + * [Remove access for a package from a team](#remove-access-for-a-package-from-a-team) + * [Authentication Tokens](#authentication-tokens) + * [List an organization's team authentication tokens](#list-an-organizations-team-authentication-tokens) + * [Create a new team authentication token](#create-a-new-team-authentication-token) + * [Delete a team authentication token](#delete-a-team-authentication-token) + * [Regenerate a team authentication token](#regenerate-a-team-authentication-token) + * [Customer](#customer) + * [List an organization's customers](#list-an-organizations-customers) + * [Show a customer](#show-a-customer) + * [Create a customer](#create-a-customer) + * [Edit a customer](#edit-a-customer) + * [Delete a customer](#delete-a-customer) + * [Enable a customer](#enable-a-customer) + * [Disable a customer](#disable-a-customer) + * [List a customer's packages](#list-a-customers-packages) + * [Show a customer's package](#show-a-customers-package) + * [Grant a customer access to a package or edit the limitations](#grant-a-customer-access-to-a-package-or-edit-the-limitations) + * [Revoke access to a package from a customer](#revoke-access-to-a-package-from-a-customer) + * [Regenerate a customer's Composer repository token](#regenerate-a-customers-composer-repository-token) + * [List a customer's vendor bundles](#list-a-customers-vendor-bundles) + * [Grant a customer access to a vendor bundle or edit the limitations](#grant-a-customer-access-to-a-vendor-bundle-or-edit-the-limitations) + * [Revoke access to a vendor bundle from a customer](#revoke-access-to-a-vendor-bundle-from-a-customer) + * [Vendor Bundle](#vendor-bundle) + * [List an organization's vendor bundles](#list-an-organizations-vendor-bundles) + * [Show a vendor bundle](#show-a-vendor-bundle) + * [Create a vendor bundle](#create-a-vendor-bundle) + * [Edit a customer](#edit-a-customer-1) + * [Delete a vendor bundle](#delete-a-vendor-bundle) + * [List packages in a vendor bundle](#list-packages-in-a-vendor-bundle) + * [Add one or more packages to a vendor bundle or edit their limitations](#add-one-or-more-packages-to-a-vendor-bundle-or-edit-their-limitations) + * [Remove a package from a vendor bundle](#remove-a-package-from-a-vendor-bundle) + * [Subrepository](#subrepository) + * [List an organization's subrepositories](#list-an-organizations-subrepositories) + * [Show a subrepository](#show-a-subrepository) + * [Create a subrepository](#create-a-subrepository) + * [Delete a subrepository](#delete-a-subrepository) + * [List a subrepository's teams](#list-a-subrepositorys-teams) + * [Add a team to a subrepository or edit the permission](#add-a-team-to-a-subrepository-or-edit-the-permission) + * [Remove a team from a subrepository](#remove-a-team-from-a-subrepository) + * [List a subrepository's packages](#list-a-subrepositorys-packages) + * [Show a subrepository package](#show-a-subrepository-package) + * [Create a vcs package in a subrepository](#create-a-vcs-package-in-a-subrepository) + * [Create a vcs package with credentials in a subrepository](#create-a-vcs-package-with-credentials-in-a-subrepository) + * [Create a custom package in a subrepository](#create-a-custom-package-in-a-subrepository) + * [Create a custom package with credentials in a subrepository](#create-a-custom-package-with-credentials-in-a-subrepository) + * [Edit a vcs package in a subrepository in a subrepository](#edit-a-vcs-package-in-a-subrepository-in-a-subrepository) + * [Edit a custom package in a subrepository](#edit-a-custom-package-in-a-subrepository) + * [Delete a package from a subrepository](#delete-a-package-from-a-subrepository) + * [List all dependents of a subrepository package](#list-all-dependents-of-a-subrepository-package) + * [List a subrepository's authentication tokens](#list-a-subrepositorys-authentication-tokens) + * [Create a subrepository authentication token](#create-a-subrepository-authentication-token) + * [Delete a subrepository authentication token](#delete-a-subrepository-authentication-token) + * [Regenerate a subrepository authentication token](#regenerate-a-subrepository-authentication-token) + * [List a subrepository's mirrored repositories](#list-a-subrepositorys-mirrored-repositories) + * [Show a mirrored repository](#show-a-mirrored-repository) + * [Add mirrored repositories to a subrepository](#add-mirrored-repositories-to-a-subrepository) + * [Edit the mirroring behaviour of mirrored repository in a subrepository](#edit-the-mirroring-behaviour-of-mirrored-repository-in-a-subrepository) + * [Delete a mirrored repository from a subrepository](#delete-a-mirrored-repository-from-a-subrepository) + * [List all mirrored packages from a mirrored repository in a subrepository](#list-all-mirrored-packages-from-a-mirrored-repository-in-a-subrepository) + * [Add mirrored packages from one mirrored repository to a subrepository](#add-mirrored-packages-from-one-mirrored-repository-to-a-subrepository) + * [Remove all mirrored packages from one mirrored repository in a subrepository](#remove-all-mirrored-packages-from-one-mirrored-repository-in-a-subrepository) + * [Package](#package) + * [List an organization's packages](#list-an-organizations-packages) + * [Show a package](#show-a-package) + * [Create a vcs package](#create-a-vcs-package) + * [Create a vcs package with credentials](#create-a-vcs-package-with-credentials) + * [Create a vcs package with a specific type](#create-a-vcs-package-with-a-specific-type) + * [Create a custom package](#create-a-custom-package) + * [Create a custom package with credentials](#create-a-custom-package-with-credentials) + * [Edit a vcs package](#edit-a-vcs-package) + * [Edit a custom package](#edit-a-custom-package) + * [Delete a package](#delete-a-package) + * [List all dependents of a package](#list-all-dependents-of-a-package) + * [List all customers with access to a package](#list-all-customers-with-access-to-a-package) + * [List all security issues of a package](#list-all-security-issues-of-a-package) + * [Show the security monitoring config of a package](#show-the-security-monitoring-config-of-a-package) + * [Edit the security monitoring config of a package](#edit-the-security-monitoring-config-of-a-package) + * [Create an artifact package file](#create-an-artifact-package-file) + * [Create an artifact package](#create-an-artifact-package) + * [Add an artifact file to an existing package](#add-an-artifact-file-to-an-existing-package) + * [Update or replace artifact files of a package](#update-or-replace-artifact-files-of-a-package) + * [Credential](#credential) + * [List an organization's credentials](#list-an-organizations-credentials) + * [Show a credential](#show-a-credential) + * [Create a credential](#create-a-credential) + * [Edit a credential](#edit-a-credential) + * [Delete a credential](#delete-a-credential) + * [Mirrored Repository](#mirrored-repository) + * [List an organization's mirrored repositories](#list-an-organizations-mirrored-repositories) + * [Show a mirrored repository](#show-a-mirrored-repository-1) + * [Create a mirrored repository](#create-a-mirrored-repository) + * [Edit a mirrored repository](#edit-a-mirrored-repository) + * [Delete a mirrored repository](#delete-a-mirrored-repository) + * [List all mirrored packages from one repository](#list-all-mirrored-packages-from-one-repository) + * [Add mirrored packages from one repository](#add-mirrored-packages-from-one-repository) + * [Remove all mirrored packages from one repository](#remove-all-mirrored-packages-from-one-repository) + * [Job](#job) + * [Show a job](#show-a-job) + * [Wait for a job to finish](#wait-for-a-job-to-finish) + * [Security Issue](#security-issue) + * [List an organization's security issues](#list-an-organizations-security-issues) + * [Magento legacy keys](#magento-legacy-keys) + * [List all legacy keys for a customer](#list-all-legacy-keys-for-a-customer) + * [Create a new legacy keys for a customer](#create-a-new-legacy-keys-for-a-customer) + * [Delete a legacy keys from a customer](#delete-a-legacy-keys-from-a-customer) + * [Validate incoming webhook payloads](#validate-incoming-webhook-payloads) + * [License](#license) + + +