# pymetrics-soft-skills-sdk
### This is pymetrics's public API. The API can be used to get information on candidates as part of a job application workflow, or for employee career pathing and development.
The typical use case for this is to support an externally initiated assessment for a candidate job application.
This is often done \"inline\" with the candidate's application, or asynchronously after the candidate submits their application.
This data can then be used for career pathing and employee development in subsequent stages.
The expected sequence of API calls is:
* `Generate OAuth Token` with the OAuth Client ID and Secret you've been provided
* `Get Assessment Configurations` to determine which configured assessment templates are available
* `Create Assessment Order` for a selected Assessment and candidate job application
* `Get Assessment Order` to receive the recommendation results and reports, once they are available
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 2.2.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.PythonLegacyClientCodegen
## Requirements.
Python 2.7 and 3.4+
## Installation & Usage
### pip install
If the python package is hosted on a repository, you can install directly using:
### pip install
```sh
pip install pymetrics_soft_skills_sdk
```
Then import the package:
```python
import pymetrics_soft_skills_sdk
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import pymetrics_soft_skills_sdk
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
from __future__ import print_function
import time
import pymetrics_soft_skills_sdk
from pymetrics_soft_skills_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 = pymetrics_soft_skills_sdk.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
with pymetrics_soft_skills_sdk.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = pymetrics_soft_skills_sdk.DefaultApi(api_client)
authorization = 'authorization_example' # str | Standard Bearer token request, from `Generate OAuth Token`. Formatted `Bearer {token}` (optional)
x_api_key = 'x_api_key_example' # str | Mandatory API Key that pymetrics will provide (optional)
order_request = pymetrics_soft_skills_sdk.OrderRequest() # OrderRequest | Candidate, assessment, and job application details (optional)
try:
# Create Assessment Order
api_response = api_instance.mercury_create_order_v2(authorization=authorization, x_api_key=x_api_key, order_request=order_request)
pprint(api_response)
except ApiException as e:
print("Exception when calling DefaultApi->mercury_create_order_v2: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *http://localhost*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DefaultApi* | [**mercury_create_order_v2**](docs/DefaultApi.md#mercury_create_order_v2) | **POST** /mercury/v2/orders | Create Assessment Order
*DefaultApi* | [**mercury_get_config_v2**](docs/DefaultApi.md#mercury_get_config_v2) | **GET** /mercury/v2/assessments | Get Assessment Configurations
*DefaultApi* | [**mercury_list_orders_v2**](docs/DefaultApi.md#mercury_list_orders_v2) | **GET** /mercury/v2/orders | List Assessment Orders
*DefaultApi* | [**mercury_o_auth_v2**](docs/DefaultApi.md#mercury_o_auth_v2) | **POST** /mercury/v2/oauth/token | Generate OAuth Token
*DefaultApi* | [**mercury_retrieve_factor_content**](docs/DefaultApi.md#mercury_retrieve_factor_content) | **GET** /mercury/v2/factorContent/{uuid} | Get Factor Content
*DefaultApi* | [**mercury_retrieve_order_v2**](docs/DefaultApi.md#mercury_retrieve_order_v2) | **GET** /mercury/v2/orders/{uuid} | Get Assessment Order
## Documentation For Models
- [AssessmentType](docs/AssessmentType.md)
- [AtsType](docs/AtsType.md)
- [Configuration](docs/Configuration.md)
- [ErrorResponse](docs/ErrorResponse.md)
- [ListOrdersRequest](docs/ListOrdersRequest.md)
- [ListOrdersResponse](docs/ListOrdersResponse.md)
- [MercuryAssessment](docs/MercuryAssessment.md)
- [MercuryAssessmentOrder](docs/MercuryAssessmentOrder.md)
- [MercuryCandidate](docs/MercuryCandidate.md)
- [MercuryDevelopmentReportContent](docs/MercuryDevelopmentReportContent.md)
- [MercuryFactorContent](docs/MercuryFactorContent.md)
- [MercuryModelDirection](docs/MercuryModelDirection.md)
- [MercuryOrderFactorContent](docs/MercuryOrderFactorContent.md)
- [MercuryOrderMetadata](docs/MercuryOrderMetadata.md)
- [MercuryReport](docs/MercuryReport.md)
- [MercuryResult](docs/MercuryResult.md)
- [MercuryRetrieveFactorContentRequest](docs/MercuryRetrieveFactorContentRequest.md)
- [OAuthRequest](docs/OAuthRequest.md)
- [OAuthResponse](docs/OAuthResponse.md)
- [OrderCreateResponse](docs/OrderCreateResponse.md)
- [OrderRequest](docs/OrderRequest.md)
- [PontemOrderStatuses](docs/PontemOrderStatuses.md)
- [PontemReportTypes](docs/PontemReportTypes.md)
## Author
Michelle Tsai <min.tsai@pymetrics.com>
Raw data
{
"_id": null,
"home_page": "",
"name": "pymetrics-soft-skills-sdk",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "OpenAPI,OpenAPI-Generator,pymetrics API",
"author": "OpenAPI Generator community",
"author_email": "team@openapitools.org",
"download_url": "https://files.pythonhosted.org/packages/fb/0d/3729a9dc9ac52648945fc37219f89688d02928784823de1441c5621e7031/pymetrics-soft-skills-sdk-1.0.1.tar.gz",
"platform": null,
"description": "# pymetrics-soft-skills-sdk\n### This is pymetrics's public API. The API can be used to get information on candidates as part of a job application workflow, or for employee career pathing and development.\nThe typical use case for this is to support an externally initiated assessment for a candidate job application.\nThis is often done \\\"inline\\\" with the candidate's application, or asynchronously after the candidate submits their application.\nThis data can then be used for career pathing and employee development in subsequent stages.\n\nThe expected sequence of API calls is:\n* `Generate OAuth Token` with the OAuth Client ID and Secret you've been provided\n* `Get Assessment Configurations` to determine which configured assessment templates are available\n* `Create Assessment Order` for a selected Assessment and candidate job application\n* `Get Assessment Order` to receive the recommendation results and reports, once they are available\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 2.2.0\n- Package version: 1.0.0\n- Build package: org.openapitools.codegen.languages.PythonLegacyClientCodegen\n\n## Requirements.\n\nPython 2.7 and 3.4+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n### pip install\n\n\n```sh\npip install pymetrics_soft_skills_sdk\n```\n\nThen import the package:\n```python\nimport pymetrics_soft_skills_sdk\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport pymetrics_soft_skills_sdk\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\nfrom __future__ import print_function\n\nimport time\nimport pymetrics_soft_skills_sdk\nfrom pymetrics_soft_skills_sdk.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to http://localhost\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = pymetrics_soft_skills_sdk.Configuration(\n host = \"http://localhost\"\n)\n\n\n\n# Enter a context with an instance of the API client\nwith pymetrics_soft_skills_sdk.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = pymetrics_soft_skills_sdk.DefaultApi(api_client)\n authorization = 'authorization_example' # str | Standard Bearer token request, from `Generate OAuth Token`. Formatted `Bearer {token}` (optional)\nx_api_key = 'x_api_key_example' # str | Mandatory API Key that pymetrics will provide (optional)\norder_request = pymetrics_soft_skills_sdk.OrderRequest() # OrderRequest | Candidate, assessment, and job application details (optional)\n\n try:\n # Create Assessment Order\n api_response = api_instance.mercury_create_order_v2(authorization=authorization, x_api_key=x_api_key, order_request=order_request)\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling DefaultApi->mercury_create_order_v2: %s\\n\" % e)\n \n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *http://localhost*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*DefaultApi* | [**mercury_create_order_v2**](docs/DefaultApi.md#mercury_create_order_v2) | **POST** /mercury/v2/orders | Create Assessment Order\n*DefaultApi* | [**mercury_get_config_v2**](docs/DefaultApi.md#mercury_get_config_v2) | **GET** /mercury/v2/assessments | Get Assessment Configurations\n*DefaultApi* | [**mercury_list_orders_v2**](docs/DefaultApi.md#mercury_list_orders_v2) | **GET** /mercury/v2/orders | List Assessment Orders\n*DefaultApi* | [**mercury_o_auth_v2**](docs/DefaultApi.md#mercury_o_auth_v2) | **POST** /mercury/v2/oauth/token | Generate OAuth Token\n*DefaultApi* | [**mercury_retrieve_factor_content**](docs/DefaultApi.md#mercury_retrieve_factor_content) | **GET** /mercury/v2/factorContent/{uuid} | Get Factor Content\n*DefaultApi* | [**mercury_retrieve_order_v2**](docs/DefaultApi.md#mercury_retrieve_order_v2) | **GET** /mercury/v2/orders/{uuid} | Get Assessment Order\n\n\n## Documentation For Models\n\n - [AssessmentType](docs/AssessmentType.md)\n - [AtsType](docs/AtsType.md)\n - [Configuration](docs/Configuration.md)\n - [ErrorResponse](docs/ErrorResponse.md)\n - [ListOrdersRequest](docs/ListOrdersRequest.md)\n - [ListOrdersResponse](docs/ListOrdersResponse.md)\n - [MercuryAssessment](docs/MercuryAssessment.md)\n - [MercuryAssessmentOrder](docs/MercuryAssessmentOrder.md)\n - [MercuryCandidate](docs/MercuryCandidate.md)\n - [MercuryDevelopmentReportContent](docs/MercuryDevelopmentReportContent.md)\n - [MercuryFactorContent](docs/MercuryFactorContent.md)\n - [MercuryModelDirection](docs/MercuryModelDirection.md)\n - [MercuryOrderFactorContent](docs/MercuryOrderFactorContent.md)\n - [MercuryOrderMetadata](docs/MercuryOrderMetadata.md)\n - [MercuryReport](docs/MercuryReport.md)\n - [MercuryResult](docs/MercuryResult.md)\n - [MercuryRetrieveFactorContentRequest](docs/MercuryRetrieveFactorContentRequest.md)\n - [OAuthRequest](docs/OAuthRequest.md)\n - [OAuthResponse](docs/OAuthResponse.md)\n - [OrderCreateResponse](docs/OrderCreateResponse.md)\n - [OrderRequest](docs/OrderRequest.md)\n - [PontemOrderStatuses](docs/PontemOrderStatuses.md)\n - [PontemReportTypes](docs/PontemReportTypes.md)\n\n\n## Author\nMichelle Tsai <min.tsai@pymetrics.com>",
"bugtrack_url": null,
"license": "",
"summary": "pymetrics API",
"version": "1.0.1",
"split_keywords": [
"openapi",
"openapi-generator",
"pymetrics api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fb0d3729a9dc9ac52648945fc37219f89688d02928784823de1441c5621e7031",
"md5": "be6edc682ef430525a841eb5516c1c0b",
"sha256": "847f270602809febad4e18e5264f97a6eafd1ea947c4b3ba6a978eef2b8d6308"
},
"downloads": -1,
"filename": "pymetrics-soft-skills-sdk-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "be6edc682ef430525a841eb5516c1c0b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 68362,
"upload_time": "2023-04-03T18:53:43",
"upload_time_iso_8601": "2023-04-03T18:53:43.848071Z",
"url": "https://files.pythonhosted.org/packages/fb/0d/3729a9dc9ac52648945fc37219f89688d02928784823de1441c5621e7031/pymetrics-soft-skills-sdk-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-03 18:53:43",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "pymetrics-soft-skills-sdk"
}
JSON