- Implement tests for basic and bearer authentication headers in `test_auth.py`. - Create tests for the `EasybillWebhookParser` in `test_webhooks.py`, covering JSON and form-encoded payloads, as well as a generic parse and acknowledgement method.
14 KiB
14 KiB
easybill_generated_async.PositionApi
All URIs are relative to https://api.easybill.de/rest/v1
| Method | HTTP request | Description |
|---|---|---|
| positions_get | GET /positions | Fetch positions list |
| positions_id_delete | DELETE /positions/{id} | Delete position |
| positions_id_get | GET /positions/{id} | Fetch position |
| positions_id_put | PUT /positions/{id} | Update position |
| positions_post | POST /positions | Create position |
positions_get
Positions positions_get(limit=limit, page=page, type=type, number=number)
Fetch positions list
Example
- Basic Authentication (basicAuth):
- Api Key Authentication (Bearer):
import easybill_generated_async
from easybill_generated_async.models.positions import Positions
from easybill_generated_async.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.easybill.de/rest/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = easybill_generated_async.Configuration(
host = "https://api.easybill.de/rest/v1"
)
# 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 HTTP basic authorization: basicAuth
configuration = easybill_generated_async.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: Bearer
configuration.api_key['Bearer'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Bearer'] = 'Bearer'
# Enter a context with an instance of the API client
async with easybill_generated_async.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = easybill_generated_async.PositionApi(api_client)
limit = 56 # int | Limited the result. Default is 100. Maximum can be 1000. (optional)
page = 56 # int | Set current Page. Default is 1. (optional)
type = 'type_example' # str | Filter positions by type. (optional)
number = 'number_example' # str | Filter positions by number. You can add multiple numbers separate by comma like no,no,no. (optional)
try:
# Fetch positions list
api_response = await api_instance.positions_get(limit=limit, page=page, type=type, number=number)
print("The response of PositionApi->positions_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PositionApi->positions_get: %s\n" % e)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| limit | int | Limited the result. Default is 100. Maximum can be 1000. | [optional] |
| page | int | Set current Page. Default is 1. | [optional] |
| type | str | Filter positions by type. | [optional] |
| number | str | Filter positions by number. You can add multiple numbers separate by comma like no,no,no. | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful operation | - |
| 429 | Too Many Requests | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
positions_id_delete
positions_id_delete(id)
Delete position
Example
- Basic Authentication (basicAuth):
- Api Key Authentication (Bearer):
import easybill_generated_async
from easybill_generated_async.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.easybill.de/rest/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = easybill_generated_async.Configuration(
host = "https://api.easybill.de/rest/v1"
)
# 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 HTTP basic authorization: basicAuth
configuration = easybill_generated_async.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: Bearer
configuration.api_key['Bearer'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Bearer'] = 'Bearer'
# Enter a context with an instance of the API client
async with easybill_generated_async.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = easybill_generated_async.PositionApi(api_client)
id = 56 # int | ID of position
try:
# Delete position
await api_instance.positions_id_delete(id)
except Exception as e:
print("Exception when calling PositionApi->positions_id_delete: %s\n" % e)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | ID of position |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 204 | Successful operation | - |
| 404 | Not found | - |
| 429 | Too Many Requests | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
positions_id_get
Position positions_id_get(id)
Fetch position
Example
- Basic Authentication (basicAuth):
- Api Key Authentication (Bearer):
import easybill_generated_async
from easybill_generated_async.models.position import Position
from easybill_generated_async.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.easybill.de/rest/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = easybill_generated_async.Configuration(
host = "https://api.easybill.de/rest/v1"
)
# 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 HTTP basic authorization: basicAuth
configuration = easybill_generated_async.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: Bearer
configuration.api_key['Bearer'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Bearer'] = 'Bearer'
# Enter a context with an instance of the API client
async with easybill_generated_async.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = easybill_generated_async.PositionApi(api_client)
id = 56 # int | ID of position
try:
# Fetch position
api_response = await api_instance.positions_id_get(id)
print("The response of PositionApi->positions_id_get:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PositionApi->positions_id_get: %s\n" % e)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | ID of position |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful operation | - |
| 404 | Not found | - |
| 429 | Too Many Requests | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
positions_id_put
Position positions_id_put(id, body)
Update position
Example
- Basic Authentication (basicAuth):
- Api Key Authentication (Bearer):
import easybill_generated_async
from easybill_generated_async.models.position import Position
from easybill_generated_async.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.easybill.de/rest/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = easybill_generated_async.Configuration(
host = "https://api.easybill.de/rest/v1"
)
# 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 HTTP basic authorization: basicAuth
configuration = easybill_generated_async.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: Bearer
configuration.api_key['Bearer'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Bearer'] = 'Bearer'
# Enter a context with an instance of the API client
async with easybill_generated_async.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = easybill_generated_async.PositionApi(api_client)
id = 56 # int | ID of position
body = easybill_generated_async.Position() # Position |
try:
# Update position
api_response = await api_instance.positions_id_put(id, body)
print("The response of PositionApi->positions_id_put:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PositionApi->positions_id_put: %s\n" % e)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | ID of position | |
| body | Position |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful operation | - |
| 400 | Invalid position | - |
| 429 | Too Many Requests | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
positions_post
Position positions_post(body)
Create position
Example
- Basic Authentication (basicAuth):
- Api Key Authentication (Bearer):
import easybill_generated_async
from easybill_generated_async.models.position import Position
from easybill_generated_async.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.easybill.de/rest/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = easybill_generated_async.Configuration(
host = "https://api.easybill.de/rest/v1"
)
# 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 HTTP basic authorization: basicAuth
configuration = easybill_generated_async.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Configure API key authorization: Bearer
configuration.api_key['Bearer'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Bearer'] = 'Bearer'
# Enter a context with an instance of the API client
async with easybill_generated_async.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = easybill_generated_async.PositionApi(api_client)
body = easybill_generated_async.Position() # Position |
try:
# Create position
api_response = await api_instance.positions_post(body)
print("The response of PositionApi->positions_post:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling PositionApi->positions_post: %s\n" % e)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Position |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 201 | Successful operation | - |
| 429 | Too Many Requests | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]