SomeonesComputerSdk

JSON-LD resources backing the control panel. Bearer-token reachable since #1418 — see docs/sdk-generation.md.

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

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

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/SomeonesComputerSdk/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

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



// Configure Bearer authorization: bearerAuth
$config = SomeonesComputer\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new SomeonesComputer\Sdk\Api\AdoptionApprovalApi(
    // 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(),
    $config
);
$page = 1; // int | The collection page number

try {
    $result = $apiInstance->apiAdoptionApprovalsGetCollection($page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdoptionApprovalApi->apiAdoptionApprovalsGetCollection: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
AdoptionApprovalApi	apiAdoptionApprovalsGetCollection	GET /api/adoption_approvals	Retrieves the collection of AdoptionApproval resources.
AdoptionApprovalApi	apiAdoptionApprovalsIdDelete	DELETE /api/adoption_approvals/{id}	Removes the AdoptionApproval resource.
AdoptionApprovalApi	apiAdoptionApprovalsIdGet	GET /api/adoption_approvals/{id}	Retrieves a AdoptionApproval resource.
AdoptionApprovalApi	apiAdoptionApprovalsPost	POST /api/adoption_approvals	Creates a AdoptionApproval resource.
ApplicationApi	apiApplicationsGetCollection	GET /api/applications	Retrieves the collection of Application resources.
ApplicationApi	apiApplicationsIdDelete	DELETE /api/applications/{id}	Removes the Application resource.
ApplicationApi	apiApplicationsIdGet	GET /api/applications/{id}	Retrieves a Application resource.
ApplicationApi	apiApplicationsIdPatch	PATCH /api/applications/{id}	Updates the Application resource.
ApplicationApi	apiApplicationsPost	POST /api/applications	Creates a Application resource.
CreditTransactionApi	apiCreditTransactionsGetCollection	GET /api/credit_transactions	Retrieves the collection of CreditTransaction resources.
CreditTransactionApi	apiCreditTransactionsIdGet	GET /api/credit_transactions/{id}	Retrieves a CreditTransaction resource.
DeploymentApi	apiDeploymentsGetCollection	GET /api/deployments	Retrieves the collection of Deployment resources.
DeploymentApi	apiDeploymentsIdDelete	DELETE /api/deployments/{id}	Removes the Deployment resource.
DeploymentApi	apiDeploymentsIdGet	GET /api/deployments/{id}	Retrieves a Deployment resource.
DeploymentApi	apiDeploymentsIdPatch	PATCH /api/deployments/{id}	Updates the Deployment resource.
DeploymentApi	apiDeploymentsIdendpointsGetCollection	GET /api/deployments/{id}/endpoints	Retrieves the collection of Deployment resources.
DeploymentApi	apiDeploymentsPost	POST /api/deployments	Creates a Deployment resource.
DeploymentApi	bundleUploadConfirm	POST /api/deployments/bundle_uploads/confirm	Creates a Deployment resource.
DeploymentApi	bundleUploadDeclare	POST /api/deployments/bundle_uploads	Creates a Deployment resource.
ManagedServiceApi	apiManagedServicesGetCollection	GET /api/managed_services	Retrieves the collection of ManagedService resources.
ManagedServiceApi	apiManagedServicesIdDelete	DELETE /api/managed_services/{id}	Removes the ManagedService resource.
ManagedServiceApi	apiManagedServicesIdGet	GET /api/managed_services/{id}	Retrieves a ManagedService resource.
ManagedServiceApi	apiManagedServicesPost	POST /api/managed_services	Creates a ManagedService resource.
ManagedServiceApi	resume	POST /api/managed_services/{id}/resume	Creates a ManagedService resource.
ManagedServiceApi	suspend	POST /api/managed_services/{id}/suspend	Creates a ManagedService resource.
OrganizationApi	apiOrganizationsGetCollection	GET /api/organizations	Retrieves the collection of Organization resources.
OrganizationApi	apiOrganizationsIdDelete	DELETE /api/organizations/{id}	Removes the Organization resource.
OrganizationApi	apiOrganizationsIdGet	GET /api/organizations/{id}	Retrieves a Organization resource.
OrganizationApi	apiOrganizationsIdPatch	PATCH /api/organizations/{id}	Updates the Organization resource.
OrganizationApi	apiOrganizationsPost	POST /api/organizations	Creates a Organization resource.
ServiceBindingApi	apiServiceBindingsGetCollection	GET /api/service_bindings	Retrieves the collection of ServiceBinding resources.
ServiceBindingApi	apiServiceBindingsIdDelete	DELETE /api/service_bindings/{id}	Removes the ServiceBinding resource.
ServiceBindingApi	apiServiceBindingsIdGet	GET /api/service_bindings/{id}	Retrieves a ServiceBinding resource.
ServiceBindingApi	apiServiceBindingsPost	POST /api/service_bindings	Creates a ServiceBinding resource.
SwarmApi	apiSwarmsGetCollection	GET /api/swarms	Retrieves the collection of Swarm resources.
SwarmApi	apiSwarmsIdDelete	DELETE /api/swarms/{id}	Removes the Swarm resource.
SwarmApi	apiSwarmsIdGet	GET /api/swarms/{id}	Retrieves a Swarm resource.
SwarmApi	apiSwarmsIdPatch	PATCH /api/swarms/{id}	Updates the Swarm resource.
SwarmApi	apiSwarmsPost	POST /api/swarms	Creates a Swarm resource.

Models

• AdoptionApproval
• AdoptionApprovalAdoptionApprovalInput
• Application
• ApplicationJsonMergePatch
• BundleAdditionalContextInput
• BundleContextInput
• BundleForwardedImageInput
• BundleUploadTarget
• ConstraintViolation
• ConstraintViolationViolationsInner
• CreditTransaction
• CreditTransactionEngineMillis
• CreditTransactionUsageBytes
• Deployment
• DeploymentBundleUploadConfirmInput
• DeploymentBundleUploadConfirmOutput
• DeploymentBundleUploadDeclareInput
• DeploymentBundleUploadDeclareOutput
• DeploymentDeploymentEndpoint
• DeploymentJsonMergePatch
• DeploymentJsonMergePatchBuildContextsValueValue
• DeploymentJsonMergePatchCanonicalSpecValue
• DeploymentVariable
• Error
• Failure
• Machine
• ManagedService
• ManagedServiceLastLoadMillis
• ManagedServiceManagedServiceInput
• ManagedServicePendingLoadMillis
• ManagedServiceQuotaBytes
• ManagedServiceUsageBytes
• Membership
• OAuthIdentity
• Organization
• OrganizationJsonMergePatch
• OrganizationSignal
• PortAllocation
• ProxmoxInstance
• RecoveryCode
• SealedSecret
• Service
• ServiceBinding
• ServiceBindingServiceBindingInput
• ServiceCpuLimit
• ServiceCpuReservation
• ServiceHealthcheckValue
• ServiceInstance
• ServiceInstanceCapacityBytes
• ServiceInstanceObservedUsageBytes
• ServiceMemLimit
• ServiceMemReservation
• ServicePortsInnerValue
• Swarm
• SwarmJsonMergePatch
• SwarmNode
• User
• UserAvatarPhoto
• Variable
• VariableVersion

Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: Bearer authentication

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
  • Generator version: 7.11.0
• Build package: org.openapitools.codegen.languages.PhpClientCodegen