/nexus-php-client

Autogenerated php client for nuxus 3.26 from swagger open api json

Primary LanguagePHP

NexusClient-php

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

This PHP package is automatically generated by the Swagger Codegen project:

  • API version: 3.26.1-02
  • Build package: io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/jamesRUS52/nexus-php-client.git"
    }
  ],
  "require": {
    "james.rus52/nexus-php-client": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/SwaggerClient-php/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new NexusClient\Api\AssetsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$id = "id_example"; // string | Id of the asset to delete

try {
    $apiInstance->deleteAsset($id);
} catch (Exception $e) {
    echo 'Exception when calling AssetsApi->deleteAsset: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://localhost/service/rest/

Class Method HTTP request Description
AssetsApi deleteAsset DELETE /v1/assets/{id} Delete a single asset
AssetsApi getAssetById GET /v1/assets/{id} Get a single asset
AssetsApi getAssets GET /v1/assets List assets
BlobStoreApi createBlobStore POST /v1/blobstores/s3 Create an S3 blob store
BlobStoreApi createFileBlobStore POST /v1/blobstores/file Create a file blob store
BlobStoreApi deleteBlobStore DELETE /v1/blobstores/{name} Delete a blob store by name
BlobStoreApi getBlobStore GET /v1/blobstores/s3/{name} Fetch a S3 blob store configuration
BlobStoreApi getFileBlobStoreConfiguration GET /v1/blobstores/file/{name} Get a file blob store configuration by name
BlobStoreApi listBlobStores GET /v1/blobstores List the blob stores
BlobStoreApi quotaStatus GET /v1/blobstores/{name}/quota-status Get quota status for a given blob store
BlobStoreApi updateBlobStore PUT /v1/blobstores/s3/{name} Update an S3 blob store configuration
BlobStoreApi updateFileBlobStore PUT /v1/blobstores/file/{name} Update a file blob store configuration by name
ComponentsApi deleteComponent DELETE /v1/components/{id} Delete a single component
ComponentsApi getComponentById GET /v1/components/{id} Get a single component
ComponentsApi getComponents GET /v1/components List components
ComponentsApi uploadComponent POST /v1/components Upload a single component
ContentSelectorsApi createContentSelector POST /v1/security/content-selectors Create a new content selector
ContentSelectorsApi deleteContentSelector DELETE /v1/security/content-selectors/{name} Delete a content selector
ContentSelectorsApi getContentSelector GET /v1/security/content-selectors/{name} Get a content selector by name
ContentSelectorsApi getContentSelectors GET /v1/security/content-selectors List content selectors
ContentSelectorsApi updateContentSelector PUT /v1/security/content-selectors/{name} Update a content selector
EmailApi deleteEmailConfiguration DELETE /v1/email Disable and clear the email configuration
EmailApi getEmailConfiguration GET /v1/email Retrieve the current email configuration
EmailApi setEmailConfiguration PUT /v1/email Set the current email configuration
EmailApi testEmailConfiguration POST /v1/email/verify Send a test email to the email address provided in the request body
FormatsApi get1 GET /v1/formats/{format}/upload-specs Get upload field requirements for the desired format
FormatsApi get2 GET /v1/formats/upload-specs Get upload field requirements for each supported format
LifecycleApi bounce PUT /v1/lifecycle/bounce Bounce lifecycle phase
LifecycleApi getPhase GET /v1/lifecycle/phase Get current lifecycle phase
LifecycleApi setPhase PUT /v1/lifecycle/phase Move to new lifecycle phase
ManageIQServerConfigurationApi disableIq POST /v1/iq/disable Disable IQ server
ManageIQServerConfigurationApi enableIq POST /v1/iq/enable Enable IQ server
ManageIQServerConfigurationApi getConfiguration GET /v1/iq Get IQ server configuration
ManageIQServerConfigurationApi updateConfiguration PUT /v1/iq Update IQ server configuration
ManageIQServerConfigurationApi verifyConnection POST /v1/iq/verify-connection Verify IQ server connection
ProductLicensingApi getLicenseStatus GET /v1/system/license Get the current license status.
ProductLicensingApi removeLicense DELETE /v1/system/license Uninstall license if present.
ProductLicensingApi setLicense POST /v1/system/license Upload a new license file.
ReadOnlyApi forceRelease POST /v1/read-only/force-release Forcibly release read-only
ReadOnlyApi freeze POST /v1/read-only/freeze Enable read-only
ReadOnlyApi get GET /v1/read-only Get read-only state
ReadOnlyApi release POST /v1/read-only/release Release read-only
RepositoriesApi getRepositories1 GET /v1/repositories List repositories
RepositoryManagementApi createRepository POST /v1/repositories/maven/group Create Maven group repository
RepositoryManagementApi createRepository1 POST /v1/repositories/maven/hosted Create Maven hosted repository
RepositoryManagementApi createRepository10 POST /v1/repositories/nuget/proxy Create NuGet proxy repository
RepositoryManagementApi createRepository11 POST /v1/repositories/npm/group Create npm group repository
RepositoryManagementApi createRepository12 POST /v1/repositories/npm/hosted Create npm hosted repository
RepositoryManagementApi createRepository13 POST /v1/repositories/npm/proxy Create npm proxy repository
RepositoryManagementApi createRepository14 POST /v1/repositories/rubygems/group Create RubyGems group repository
RepositoryManagementApi createRepository15 POST /v1/repositories/rubygems/hosted Create RubyGems hosted repository
RepositoryManagementApi createRepository16 POST /v1/repositories/rubygems/proxy Create RubyGems proxy repository
RepositoryManagementApi createRepository17 POST /v1/repositories/apt/hosted Create APT hosted repository
RepositoryManagementApi createRepository18 POST /v1/repositories/apt/proxy Create APT proxy repository
RepositoryManagementApi createRepository19 POST /v1/repositories/cocoapods/proxy Create Cocoapods proxy repository
RepositoryManagementApi createRepository2 POST /v1/repositories/maven/proxy Create Maven proxy repository
RepositoryManagementApi createRepository20 POST /v1/repositories/go/group Create a Go group repository
RepositoryManagementApi createRepository21 POST /v1/repositories/go/proxy Create a Go proxy repository
RepositoryManagementApi createRepository22 POST /v1/repositories/pypi/group Create PyPI group repository
RepositoryManagementApi createRepository23 POST /v1/repositories/pypi/hosted Create PyPI hosted repository
RepositoryManagementApi createRepository24 POST /v1/repositories/pypi/proxy Create PyPI proxy repository
RepositoryManagementApi createRepository25 POST /v1/repositories/conan/proxy Create Conan proxy repository
RepositoryManagementApi createRepository26 POST /v1/repositories/p2/proxy Create p2 proxy repository
RepositoryManagementApi createRepository27 POST /v1/repositories/r/group Create R group repository
RepositoryManagementApi createRepository28 POST /v1/repositories/r/hosted Create R hosted repository
RepositoryManagementApi createRepository29 POST /v1/repositories/r/proxy Create R proxy repository
RepositoryManagementApi createRepository3 POST /v1/repositories/raw/group Create raw group repository
RepositoryManagementApi createRepository30 POST /v1/repositories/bower/group Create Bower group repository
RepositoryManagementApi createRepository31 POST /v1/repositories/bower/hosted Create Bower hosted repository
RepositoryManagementApi createRepository32 POST /v1/repositories/bower/proxy Create Bower proxy repository
RepositoryManagementApi createRepository33 POST /v1/repositories/docker/group Create Docker group repository
RepositoryManagementApi createRepository34 POST /v1/repositories/docker/hosted Create Docker hosted repository
RepositoryManagementApi createRepository35 POST /v1/repositories/docker/proxy Create Docker proxy repository
RepositoryManagementApi createRepository36 POST /v1/repositories/gitlfs/hosted Create Git LFS hosted repository
RepositoryManagementApi createRepository37 POST /v1/repositories/yum/group Create Yum group repository
RepositoryManagementApi createRepository38 POST /v1/repositories/yum/hosted Create Yum hosted repository
RepositoryManagementApi createRepository39 POST /v1/repositories/yum/proxy Create Yum proxy repository
RepositoryManagementApi createRepository4 POST /v1/repositories/raw/hosted Create raw hosted repository
RepositoryManagementApi createRepository5 POST /v1/repositories/raw/proxy Create raw proxy repository
RepositoryManagementApi createRepository6 POST /v1/repositories/helm/hosted Create Helm hosted repository
RepositoryManagementApi createRepository7 POST /v1/repositories/helm/proxy Create Helm proxy repository
RepositoryManagementApi createRepository8 POST /v1/repositories/nuget/group Create NuGet group repository
RepositoryManagementApi createRepository9 POST /v1/repositories/nuget/hosted Create NuGet hosted repository
RepositoryManagementApi deleteRepository DELETE /v1/repositories/{repositoryName} Delete repository of any format
RepositoryManagementApi disableRepositoryHealthCheck DELETE /v1/repositories/{repositoryName}/health-check Disable repository health check. Proxy repositories only.
RepositoryManagementApi enableRepositoryHealthCheck POST /v1/repositories/{repositoryName}/health-check Enable repository health check. Proxy repositories only.
RepositoryManagementApi getRepositories GET /v1/repositorySettings List repositories
RepositoryManagementApi invalidateCache POST /v1/repositories/{repositoryName}/invalidate-cache Invalidate repository cache. Proxy or group repositories only.
RepositoryManagementApi rebuildIndex POST /v1/repositories/{repositoryName}/rebuild-index Schedule a 'Repair - Rebuild repository search' Task. Hosted or proxy repositories only.
RepositoryManagementApi updateRepository PUT /v1/repositories/maven/group/{repositoryName} Update Maven group repository
RepositoryManagementApi updateRepository1 PUT /v1/repositories/maven/hosted/{repositoryName} Update Maven hosted repository
RepositoryManagementApi updateRepository10 PUT /v1/repositories/nuget/proxy/{repositoryName} Update NuGet proxy repository
RepositoryManagementApi updateRepository11 PUT /v1/repositories/npm/group/{repositoryName} Update npm group repository
RepositoryManagementApi updateRepository12 PUT /v1/repositories/npm/hosted/{repositoryName} Update npm hosted repository
RepositoryManagementApi updateRepository13 PUT /v1/repositories/npm/proxy/{repositoryName} Update npm proxy repository
RepositoryManagementApi updateRepository14 PUT /v1/repositories/rubygems/group/{repositoryName} Update RubyGems group repository
RepositoryManagementApi updateRepository15 PUT /v1/repositories/rubygems/hosted/{repositoryName} Update RubyGems hosted repository
RepositoryManagementApi updateRepository16 PUT /v1/repositories/rubygems/proxy/{repositoryName} Update RubyGems proxy repository
RepositoryManagementApi updateRepository17 PUT /v1/repositories/apt/hosted/{repositoryName} Update APT hosted repository
RepositoryManagementApi updateRepository18 PUT /v1/repositories/apt/proxy/{repositoryName} Update APT proxy repository
RepositoryManagementApi updateRepository19 PUT /v1/repositories/cocoapods/proxy/{repositoryName} Update Cocoapods proxy repository
RepositoryManagementApi updateRepository2 PUT /v1/repositories/maven/proxy/{repositoryName} Update Maven proxy repository
RepositoryManagementApi updateRepository20 PUT /v1/repositories/go/group/{repositoryName} Update a Go group repository
RepositoryManagementApi updateRepository21 PUT /v1/repositories/go/proxy/{repositoryName} Update a Go proxy repository
RepositoryManagementApi updateRepository22 PUT /v1/repositories/pypi/group/{repositoryName} Update PyPI group repository
RepositoryManagementApi updateRepository23 PUT /v1/repositories/pypi/hosted/{repositoryName} Update PyPI hosted repository
RepositoryManagementApi updateRepository24 PUT /v1/repositories/pypi/proxy/{repositoryName} Update PyPI proxy repository
RepositoryManagementApi updateRepository25 PUT /v1/repositories/conan/proxy/{repositoryName} Update Conan proxy repository
RepositoryManagementApi updateRepository26 PUT /v1/repositories/p2/proxy/{repositoryName} Update p2 proxy repository
RepositoryManagementApi updateRepository27 PUT /v1/repositories/r/group/{repositoryName} Update R group repository
RepositoryManagementApi updateRepository28 PUT /v1/repositories/r/hosted/{repositoryName} Update R hosted repository
RepositoryManagementApi updateRepository29 PUT /v1/repositories/r/proxy/{repositoryName} Update R proxy repository
RepositoryManagementApi updateRepository3 PUT /v1/repositories/raw/group/{repositoryName} Update raw group repository
RepositoryManagementApi updateRepository30 PUT /v1/repositories/bower/group/{repositoryName} Update Bower group repository
RepositoryManagementApi updateRepository31 PUT /v1/repositories/bower/hosted/{repositoryName} Update Bower hosted repository
RepositoryManagementApi updateRepository32 PUT /v1/repositories/bower/proxy/{repositoryName} Update Bower proxy repository
RepositoryManagementApi updateRepository33 PUT /v1/repositories/docker/group/{repositoryName} Update Docker group repository
RepositoryManagementApi updateRepository34 PUT /v1/repositories/docker/hosted/{repositoryName} Update Docker hosted repository
RepositoryManagementApi updateRepository35 PUT /v1/repositories/docker/proxy/{repositoryName} Update Docker group repository
RepositoryManagementApi updateRepository36 PUT /v1/repositories/gitlfs/hosted/{repositoryName} Update Git LFS hosted repository
RepositoryManagementApi updateRepository37 PUT /v1/repositories/yum/group/{repositoryName} Update Yum group repository
RepositoryManagementApi updateRepository38 PUT /v1/repositories/yum/hosted/{repositoryName} Update Yum hosted repository
RepositoryManagementApi updateRepository39 PUT /v1/repositories/yum/proxy/{repositoryName} Update Yum proxy repository
RepositoryManagementApi updateRepository4 PUT /v1/repositories/raw/hosted/{repositoryName} Update raw hosted repository
RepositoryManagementApi updateRepository5 PUT /v1/repositories/raw/proxy/{repositoryName} Update raw proxy repository
RepositoryManagementApi updateRepository6 PUT /v1/repositories/helm/hosted/{repositoryName} Update Helm hosted repository
RepositoryManagementApi updateRepository7 PUT /v1/repositories/helm/proxy/{repositoryName} Update Helm proxy repository
RepositoryManagementApi updateRepository8 PUT /v1/repositories/nuget/group/{repositoryName} Update NuGet group repository
RepositoryManagementApi updateRepository9 PUT /v1/repositories/nuget/hosted/{repositoryName} Update NuGet hosted repository
RoutingRulesApi createRoutingRule POST /v1/routing-rules Create a single routing rule
RoutingRulesApi deleteRoutingRule DELETE /v1/routing-rules/{name} Delete a single routing rule
RoutingRulesApi getRoutingRule GET /v1/routing-rules/{name} Get a single routing rule
RoutingRulesApi getRoutingRules GET /v1/routing-rules List routing rules
RoutingRulesApi updateRoutingRule PUT /v1/routing-rules/{name} Update a single routing rule
ScriptApi add POST /v1/script Add a new script
ScriptApi browse GET /v1/script List all stored scripts
ScriptApi delete1 DELETE /v1/script/{name} Delete stored script by name
ScriptApi edit PUT /v1/script/{name} Update stored script by name
ScriptApi read1 GET /v1/script/{name} Read stored script by name
ScriptApi run1 POST /v1/script/{name}/run Run stored script by name
SearchApi search GET /v1/search Search components
SearchApi searchAndDownloadAssets GET /v1/search/assets/download Search and download asset
SearchApi searchAssets GET /v1/search/assets Search assets
SecurityCertificatesApi addCertificate POST /v1/security/ssl/truststore Add a certificate to the trust store.
SecurityCertificatesApi getTrustStoreCertificates GET /v1/security/ssl/truststore Retrieve a list of certificates added to the trust store.
SecurityCertificatesApi removeCertificate DELETE /v1/security/ssl/truststore/{id} Remove a certificate in the trust store.
SecurityCertificatesApi retrieveCertificate GET /v1/security/ssl Helper method to retrieve certificate details from a remote system.
SecurityManagementApi getUserSources GET /v1/security/user-sources Retrieve a list of the available user sources.
SecurityManagementAnonymousAccessApi read GET /v1/security/anonymous Get Anonymous Access settings
SecurityManagementAnonymousAccessApi update PUT /v1/security/anonymous Update Anonymous Access settings
SecurityManagementLDAPApi changeOrder POST /v1/security/ldap/change-order Change LDAP server order
SecurityManagementLDAPApi createLdapServer POST /v1/security/ldap Create LDAP server
SecurityManagementLDAPApi deleteLdapServer DELETE /v1/security/ldap/{name} Delete LDAP server
SecurityManagementLDAPApi getLdapServer GET /v1/security/ldap/{name} Get LDAP server
SecurityManagementLDAPApi getLdapServers GET /v1/security/ldap List LDAP servers
SecurityManagementLDAPApi updateLdapServer PUT /v1/security/ldap/{name} Update LDAP server
SecurityManagementPrivilegesApi createPrivilege POST /v1/security/privileges/wildcard Create a wildcard type privilege.
SecurityManagementPrivilegesApi createPrivilege1 POST /v1/security/privileges/application Create an application type privilege.
SecurityManagementPrivilegesApi createPrivilege2 POST /v1/security/privileges/repository-content-selector Create a repository content selector type privilege.
SecurityManagementPrivilegesApi createPrivilege3 POST /v1/security/privileges/repository-admin Create a repository admin type privilege.
SecurityManagementPrivilegesApi createPrivilege4 POST /v1/security/privileges/repository-view Create a repository view type privilege.
SecurityManagementPrivilegesApi createPrivilege5 POST /v1/security/privileges/script Create a script type privilege.
SecurityManagementPrivilegesApi deletePrivilege DELETE /v1/security/privileges/{privilegeId} Delete a privilege by id.
SecurityManagementPrivilegesApi getPrivilege GET /v1/security/privileges/{privilegeId} Retrieve a privilege by id.
SecurityManagementPrivilegesApi getPrivileges GET /v1/security/privileges Retrieve a list of privileges.
SecurityManagementPrivilegesApi updatePrivilege PUT /v1/security/privileges/wildcard/{privilegeId} Update a wildcard type privilege.
SecurityManagementPrivilegesApi updatePrivilege1 PUT /v1/security/privileges/application/{privilegeId} Update an application type privilege.
SecurityManagementPrivilegesApi updatePrivilege2 PUT /v1/security/privileges/repository-view/{privilegeId} Update a repository view type privilege.
SecurityManagementPrivilegesApi updatePrivilege3 PUT /v1/security/privileges/repository-content-selector/{privilegeId} Update a repository content selector type privilege.
SecurityManagementPrivilegesApi updatePrivilege4 PUT /v1/security/privileges/repository-admin/{privilegeId} Update a repository admin type privilege.
SecurityManagementPrivilegesApi updatePrivilege5 PUT /v1/security/privileges/script/{privilegeId} Update a script type privilege.
SecurityManagementRealmsApi getActiveRealms GET /v1/security/realms/active List the active realm IDs in order
SecurityManagementRealmsApi getRealms GET /v1/security/realms/available List the available realms
SecurityManagementRealmsApi setActiveRealms PUT /v1/security/realms/active Set the active security realms in the order they should be used
SecurityManagementRolesApi create POST /v1/security/roles Create role
SecurityManagementRolesApi delete DELETE /v1/security/roles/{id} Delete role
SecurityManagementRolesApi getRole GET /v1/security/roles/{id} Get role
SecurityManagementRolesApi getRoles GET /v1/security/roles List roles
SecurityManagementRolesApi update1 PUT /v1/security/roles/{id} Update role
SecurityManagementUsersApi changePassword PUT /v1/security/users/{userId}/change-password Change a user's password.
SecurityManagementUsersApi createUser POST /v1/security/users Create a new user in the default source.
SecurityManagementUsersApi deleteUser DELETE /v1/security/users/{userId} Delete a user.
SecurityManagementUsersApi getUsers GET /v1/security/users Retrieve a list of users. Note if the source is not 'default' the response is limited to 100 users.
SecurityManagementUsersApi updateUser PUT /v1/security/users/{userId} Update an existing user.
StatusApi getSystemStatusChecks GET /v1/status/check Health check endpoint that returns the results of the system status checks
StatusApi isAvailable GET /v1/status Health check endpoint that validates server can respond to read requests
StatusApi isWritable GET /v1/status/writable Health check endpoint that validates server can respond to read and write requests
SupportApi supportzip POST /v1/support/supportzip Creates and downloads a support zip
SupportApi supportzippath POST /v1/support/supportzippath Creates a support zip and returns the path
TasksApi getTaskById GET /v1/tasks/{id} Get a single task by id
TasksApi getTasks GET /v1/tasks List tasks
TasksApi run POST /v1/tasks/{id}/run Run task
TasksApi stop POST /v1/tasks/{id}/stop Stop task

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

Author