clientapi_billingo.ProductApi

All URIs are relative to https://api.billingo.hu/v3

Method	HTTP request	Description
create_product	POST /products	Create a product
delete_product	DELETE /products/{id}	Delete a product
get_product	GET /products/{id}	Retrieve a product
list_product	GET /products	List all product
update_product	PUT /products/{id}	Update a product

create_product

Product create_product(product)

Create a product

Create a new product. Returns a product object if the create is succeded.

Example

Api Key Authentication (api_key):

import clientapi_billingo
from clientapi_billingo.models.product import Product
from clientapi_billingo.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.billingo.hu/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_billingo.Configuration(
    host = "https://api.billingo.hu/v3"
)

# 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 API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_billingo.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_billingo.ProductApi(api_client)
    product = clientapi_billingo.Product() # Product | Product object that you would like to store.

    try:
        # Create a product
        api_response = api_instance.create_product(product)
        print("The response of ProductApi->create_product:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProductApi->create_product: %s\n" % e)

Parameters

Name	Type	Description	Notes
product	Product	Product object that you would like to store.

Return type

Product

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Product created successfully.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
400	The request is malformed.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
401	Authorization information is missing or invalid.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
402	Authenticated user doesn't have subscription.	-
403	Authenticated user doesn't have access to the resource.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
422	Validation errors occured.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
429	Too many requests	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
500	Internal server error.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_product

delete_product(id)

Delete a product

Delete an existing product.

Example

Api Key Authentication (api_key):

import clientapi_billingo
from clientapi_billingo.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.billingo.hu/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_billingo.Configuration(
    host = "https://api.billingo.hu/v3"
)

# 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 API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_billingo.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_billingo.ProductApi(api_client)
    id = 56 # int | 

    try:
        # Delete a product
        api_instance.delete_product(id)
    except Exception as e:
        print("Exception when calling ProductApi->delete_product: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Product deleted successfully.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
400	The request is malformed.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
401	Authorization information is missing or invalid.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
402	Authenticated user doesn't have subscription.	-
403	Authenticated user doesn't have access to the resource.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
429	Too many requests	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
500	Internal server error.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
404	Non-existent resource is requested.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_product

Product get_product(id)

Retrieve a product

Retrieves the details of an existing product.

Example

Api Key Authentication (api_key):

import clientapi_billingo
from clientapi_billingo.models.product import Product
from clientapi_billingo.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.billingo.hu/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_billingo.Configuration(
    host = "https://api.billingo.hu/v3"
)

# 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 API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_billingo.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_billingo.ProductApi(api_client)
    id = 56 # int | 

    try:
        # Retrieve a product
        api_response = api_instance.get_product(id)
        print("The response of ProductApi->get_product:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProductApi->get_product: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int

Return type

Product

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success response	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
400	The request is malformed.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
401	Authorization information is missing or invalid.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
402	Authenticated user doesn't have subscription.	-
422	Validation errors occured.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
429	Too many requests	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
500	Internal server error.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
404	Non-existent resource is requested.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_product

ProductList list_product(page=page, per_page=per_page, query=query)

List all product

Returns a list of your products. The partners are returned sorted by creation date, with the most recent partners appearing first.

Example

Api Key Authentication (api_key):

import clientapi_billingo
from clientapi_billingo.models.product_list import ProductList
from clientapi_billingo.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.billingo.hu/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_billingo.Configuration(
    host = "https://api.billingo.hu/v3"
)

# 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 API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_billingo.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_billingo.ProductApi(api_client)
    page = 56 # int |  (optional)
    per_page = 25 # int |  (optional) (default to 25)
    query = 'query_example' # str |  (optional)

    try:
        # List all product
        api_response = api_instance.list_product(page=page, per_page=per_page, query=query)
        print("The response of ProductApi->list_product:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProductApi->list_product: %s\n" % e)

Parameters

Name	Type	Notes
page	int	[optional]
per_page	int	[optional] [default to 25]
query	str	[optional]

Return type

ProductList

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success response	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
400	The request is malformed.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
401	Authorization information is missing or invalid.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
402	Authenticated user doesn't have subscription.	-
422	Validation errors occured.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
429	Too many requests	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
500	Internal server error.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_product

Product update_product(id, product)

Update a product

Update an existing product. Returns a product object if the update is succeded.

Example

Api Key Authentication (api_key):

import clientapi_billingo
from clientapi_billingo.models.product import Product
from clientapi_billingo.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.billingo.hu/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_billingo.Configuration(
    host = "https://api.billingo.hu/v3"
)

# 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 API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_billingo.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_billingo.ProductApi(api_client)
    id = 56 # int | 
    product = clientapi_billingo.Product() # Product | Product object that you would like to update.

    try:
        # Update a product
        api_response = api_instance.update_product(id, product)
        print("The response of ProductApi->update_product:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ProductApi->update_product: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int
product	Product	Product object that you would like to update.

Return type

Product

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Product updated successfully.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
400	The request is malformed.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
401	Authorization information is missing or invalid.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
402	Authenticated user doesn't have subscription.	-
403	Authenticated user doesn't have access to the resource.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
422	Validation errors occured.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
429	Too many requests	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
500	Internal server error.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.
404	Non-existent resource is requested.	* X-RateLimit-Limit - Request limit per minute. * X-RateLimit-Remaining - The number of requests left for the time window. * X-RateLimit-Reset - The timestamp at which the current rate limit window resets. * Retry-After - How many seconds you have to wait before making new request.

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

clientapi_billingo.ProductApi

create_product

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_product

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_product

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_product

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_product

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

FilesExpand file tree

ProductApi.md

Latest commit

History

ProductApi.md

File metadata and controls

clientapi_billingo.ProductApi

create_product

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_product

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_product

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_product

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_product

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details