Skip to content
BranchesTags

Repository files navigation

someones-computer-sdk

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

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

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

Requirements.

Python 3.8+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import someones_computer_sdk

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import someones_computer_sdk

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import someones_computer_sdk
from someones_computer_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = someones_computer_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = someones_computer_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with someones_computer_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = someones_computer_sdk.AdoptionApprovalApi(api_client)
    page = 1 # int | The collection page number (optional) (default to 1)

    try:
        # Retrieves the collection of AdoptionApproval resources.
        api_response = api_instance.api_adoption_approvals_get_collection(page=page)
        print("The response of AdoptionApprovalApi->api_adoption_approvals_get_collection:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AdoptionApprovalApi->api_adoption_approvals_get_collection: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
AdoptionApprovalApi api_adoption_approvals_get_collection GET /api/adoption_approvals Retrieves the collection of AdoptionApproval resources.
AdoptionApprovalApi api_adoption_approvals_id_delete DELETE /api/adoption_approvals/{id} Removes the AdoptionApproval resource.
AdoptionApprovalApi api_adoption_approvals_id_get GET /api/adoption_approvals/{id} Retrieves a AdoptionApproval resource.
AdoptionApprovalApi api_adoption_approvals_post POST /api/adoption_approvals Creates a AdoptionApproval resource.
ApplicationApi api_applications_get_collection GET /api/applications Retrieves the collection of Application resources.
ApplicationApi api_applications_id_delete DELETE /api/applications/{id} Removes the Application resource.
ApplicationApi api_applications_id_get GET /api/applications/{id} Retrieves a Application resource.
ApplicationApi api_applications_id_patch PATCH /api/applications/{id} Updates the Application resource.
ApplicationApi api_applications_post POST /api/applications Creates a Application resource.
CreditTransactionApi api_credit_transactions_get_collection GET /api/credit_transactions Retrieves the collection of CreditTransaction resources.
CreditTransactionApi api_credit_transactions_id_get GET /api/credit_transactions/{id} Retrieves a CreditTransaction resource.
DeploymentApi api_deployments_get_collection GET /api/deployments Retrieves the collection of Deployment resources.
DeploymentApi api_deployments_id_delete DELETE /api/deployments/{id} Removes the Deployment resource.
DeploymentApi api_deployments_id_get GET /api/deployments/{id} Retrieves a Deployment resource.
DeploymentApi api_deployments_id_patch PATCH /api/deployments/{id} Updates the Deployment resource.
DeploymentApi api_deployments_idendpoints_get_collection GET /api/deployments/{id}/endpoints Retrieves the collection of Deployment resources.
DeploymentApi api_deployments_post POST /api/deployments Creates a Deployment resource.
DeploymentApi bundle_upload_confirm POST /api/deployments/bundle_uploads/confirm Creates a Deployment resource.
DeploymentApi bundle_upload_declare POST /api/deployments/bundle_uploads Creates a Deployment resource.
ManagedServiceApi api_managed_services_get_collection GET /api/managed_services Retrieves the collection of ManagedService resources.
ManagedServiceApi api_managed_services_id_delete DELETE /api/managed_services/{id} Removes the ManagedService resource.
ManagedServiceApi api_managed_services_id_get GET /api/managed_services/{id} Retrieves a ManagedService resource.
ManagedServiceApi api_managed_services_post 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 api_organizations_get_collection GET /api/organizations Retrieves the collection of Organization resources.
OrganizationApi api_organizations_id_delete DELETE /api/organizations/{id} Removes the Organization resource.
OrganizationApi api_organizations_id_get GET /api/organizations/{id} Retrieves a Organization resource.
OrganizationApi api_organizations_id_patch PATCH /api/organizations/{id} Updates the Organization resource.
OrganizationApi api_organizations_post POST /api/organizations Creates a Organization resource.
ServiceBindingApi api_service_bindings_get_collection GET /api/service_bindings Retrieves the collection of ServiceBinding resources.
ServiceBindingApi api_service_bindings_id_delete DELETE /api/service_bindings/{id} Removes the ServiceBinding resource.
ServiceBindingApi api_service_bindings_id_get GET /api/service_bindings/{id} Retrieves a ServiceBinding resource.
ServiceBindingApi api_service_bindings_post POST /api/service_bindings Creates a ServiceBinding resource.
SwarmApi api_swarms_get_collection GET /api/swarms Retrieves the collection of Swarm resources.
SwarmApi api_swarms_id_delete DELETE /api/swarms/{id} Removes the Swarm resource.
SwarmApi api_swarms_id_get GET /api/swarms/{id} Retrieves a Swarm resource.
SwarmApi api_swarms_id_patch PATCH /api/swarms/{id} Updates the Swarm resource.
SwarmApi api_swarms_post POST /api/swarms Creates a Swarm resource.

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

  • Type: Bearer authentication

Author

About

OpenAPI-generated Python client for the someones.computer /api surface

Resources

Readme
MIT license
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

Packages

Contributors

Languages