README

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

Bugs and feature requests for the someones.computer ecosystem are tracked centrally at Grey.ooo/Someones.Computer — this repo's own issue tracker is disabled. Pull requests are still welcome here.

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
);
$adoption_approval_adoption_approval_input = new \SomeonesComputer\Sdk\Model\AdoptionApprovalAdoptionApprovalInput(); // \SomeonesComputer\Sdk\Model\AdoptionApprovalAdoptionApprovalInput | The new AdoptionApproval resource

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

API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
AdoptionApprovalApi	adoptionApprovalsDecide	POST /api/adoption_approvals	Creates a AdoptionApproval resource.
AdoptionApprovalApi	adoptionApprovalsGet	GET /api/adoption_approvals/{id}	Retrieves a AdoptionApproval resource.
AdoptionApprovalApi	adoptionApprovalsList	GET /api/adoption_approvals	Retrieves the collection of AdoptionApproval resources.
AdoptionApprovalApi	adoptionApprovalsWithdraw	DELETE /api/adoption_approvals/{id}	Removes the AdoptionApproval resource.
ApplicationApi	applicationsCreate	POST /api/applications	Creates a Application resource.
ApplicationApi	applicationsDelete	DELETE /api/applications/{id}	Removes the Application resource.
ApplicationApi	applicationsGet	GET /api/applications/{id}	Retrieves a Application resource.
ApplicationApi	applicationsList	GET /api/applications	Retrieves the collection of Application resources.
ApplicationApi	applicationsUpdate	PATCH /api/applications/{id}	Updates the Application resource.
CreditTransactionApi	creditTransactionsGet	GET /api/credit_transactions/{id}	Retrieves a CreditTransaction resource.
CreditTransactionApi	creditTransactionsList	GET /api/credit_transactions	Retrieves the collection of CreditTransaction resources.
DeploymentApi	deploymentsBundleUploadConfirm	POST /api/deployments/bundle_uploads/confirm	Creates a Deployment resource.
DeploymentApi	deploymentsBundleUploadDeclare	POST /api/deployments/bundle_uploads	Creates a Deployment resource.
DeploymentApi	deploymentsCreate	POST /api/deployments	Creates a Deployment resource.
DeploymentApi	deploymentsDelete	DELETE /api/deployments/{id}	Removes the Deployment resource.
DeploymentApi	deploymentsEndpoints	GET /api/deployments/{id}/endpoints	Retrieves the collection of Deployment resources.
DeploymentApi	deploymentsGet	GET /api/deployments/{id}	Retrieves a Deployment resource.
DeploymentApi	deploymentsList	GET /api/deployments	Retrieves the collection of Deployment resources.
DeploymentApi	deploymentsUpdate	PATCH /api/deployments/{id}	Updates the Deployment resource.
DeploymentAccessGateApi	deploymentAccessGatesCreate	POST /api/deployment_access_gates	Creates a DeploymentAccessGate resource.
DeploymentAccessGateApi	deploymentAccessGatesDelete	DELETE /api/deployment_access_gates/{id}	Removes the DeploymentAccessGate resource.
DeploymentAccessGateApi	deploymentAccessGatesGet	GET /api/deployment_access_gates/{id}	Retrieves a DeploymentAccessGate resource.
DeploymentAccessGateApi	deploymentAccessGatesList	GET /api/deployment_access_gates	Retrieves the collection of DeploymentAccessGate resources.
DeploymentAccessGateApi	deploymentAccessGatesUpdate	PATCH /api/deployment_access_gates/{id}	Updates the DeploymentAccessGate resource.
ManagedServiceApi	managedServicesCreate	POST /api/managed_services	Creates a ManagedService resource.
ManagedServiceApi	managedServicesDelete	DELETE /api/managed_services/{id}	Removes the ManagedService resource.
ManagedServiceApi	managedServicesGet	GET /api/managed_services/{id}	Retrieves a ManagedService resource.
ManagedServiceApi	managedServicesList	GET /api/managed_services	Retrieves the collection of ManagedService resources.
ManagedServiceApi	managedServicesResume	POST /api/managed_services/{id}/resume	Creates a ManagedService resource.
ManagedServiceApi	managedServicesSuspend	POST /api/managed_services/{id}/suspend	Creates a ManagedService resource.
OrganizationApi	organizationsCreate	POST /api/organizations	Creates a Organization resource.
OrganizationApi	organizationsDelete	DELETE /api/organizations/{id}	Removes the Organization resource.
OrganizationApi	organizationsGet	GET /api/organizations/{id}	Retrieves a Organization resource.
OrganizationApi	organizationsList	GET /api/organizations	Retrieves the collection of Organization resources.
OrganizationApi	organizationsUpdate	PATCH /api/organizations/{id}	Updates the Organization resource.
ServiceBindingApi	serviceBindingsCreate	POST /api/service_bindings	Creates a ServiceBinding resource.
ServiceBindingApi	serviceBindingsDelete	DELETE /api/service_bindings/{id}	Removes the ServiceBinding resource.
ServiceBindingApi	serviceBindingsGet	GET /api/service_bindings/{id}	Retrieves a ServiceBinding resource.
ServiceBindingApi	serviceBindingsList	GET /api/service_bindings	Retrieves the collection of ServiceBinding resources.
SwarmApi	swarmsCreate	POST /api/swarms	Creates a Swarm resource.
SwarmApi	swarmsDelete	DELETE /api/swarms/{id}	Removes the Swarm resource.
SwarmApi	swarmsGet	GET /api/swarms/{id}	Retrieves a Swarm resource.
SwarmApi	swarmsList	GET /api/swarms	Retrieves the collection of Swarm resources.
SwarmApi	swarmsUpdate	PATCH /api/swarms/{id}	Updates the Swarm resource.

Models

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

someones-computer / sdk-php

Package info

Security

Statistics