Skip to content

Latest commit

 

History

History
398 lines (314 loc) · 23.4 KB

File metadata and controls

398 lines (314 loc) · 23.4 KB

ProductApi

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

Method HTTP request Description
createProduct POST /products Create a product
deleteProduct DELETE /products/{id} Delete a product
getProduct GET /products/{id} Retrieve a product
listProduct GET /products List all product
updateProduct PUT /products/{id} Update a product

createProduct

Product createProduct(product)

Create a product

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

Example

// Import classes:
import com.clientapi.billingo.invoker.ApiClient;
import com.clientapi.billingo.invoker.ApiException;
import com.clientapi.billingo.invoker.Configuration;
import com.clientapi.billingo.invoker.auth.*;
import com.clientapi.billingo.invoker.models.*;
import com.clientapi.billingo.api.ProductApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.billingo.hu/v3");
    
    // Configure API key authorization: api_key
    ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
    api_key.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //api_key.setApiKeyPrefix("Token");

    ProductApi apiInstance = new ProductApi(defaultClient);
    Product product = new Product(); // Product | Product object that you would like to store.
    try {
      Product result = apiInstance.createProduct(product);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ProductApi#createProduct");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

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.

deleteProduct

deleteProduct(id)

Delete a product

Delete an existing product.

Example

// Import classes:
import com.clientapi.billingo.invoker.ApiClient;
import com.clientapi.billingo.invoker.ApiException;
import com.clientapi.billingo.invoker.Configuration;
import com.clientapi.billingo.invoker.auth.*;
import com.clientapi.billingo.invoker.models.*;
import com.clientapi.billingo.api.ProductApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.billingo.hu/v3");
    
    // Configure API key authorization: api_key
    ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
    api_key.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //api_key.setApiKeyPrefix("Token");

    ProductApi apiInstance = new ProductApi(defaultClient);
    Integer id = 56; // Integer | 
    try {
      apiInstance.deleteProduct(id);
    } catch (ApiException e) {
      System.err.println("Exception when calling ProductApi#deleteProduct");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
id Integer

Return type

null (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.
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.
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.

getProduct

Product getProduct(id)

Retrieve a product

Retrieves the details of an existing product.

Example

// Import classes:
import com.clientapi.billingo.invoker.ApiClient;
import com.clientapi.billingo.invoker.ApiException;
import com.clientapi.billingo.invoker.Configuration;
import com.clientapi.billingo.invoker.auth.*;
import com.clientapi.billingo.invoker.models.*;
import com.clientapi.billingo.api.ProductApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.billingo.hu/v3");
    
    // Configure API key authorization: api_key
    ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
    api_key.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //api_key.setApiKeyPrefix("Token");

    ProductApi apiInstance = new ProductApi(defaultClient);
    Integer id = 56; // Integer | 
    try {
      Product result = apiInstance.getProduct(id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ProductApi#getProduct");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
id Integer

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. -
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.
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.

listProduct

ProductList listProduct(page, perPage, 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

// Import classes:
import com.clientapi.billingo.invoker.ApiClient;
import com.clientapi.billingo.invoker.ApiException;
import com.clientapi.billingo.invoker.Configuration;
import com.clientapi.billingo.invoker.auth.*;
import com.clientapi.billingo.invoker.models.*;
import com.clientapi.billingo.api.ProductApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.billingo.hu/v3");
    
    // Configure API key authorization: api_key
    ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
    api_key.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //api_key.setApiKeyPrefix("Token");

    ProductApi apiInstance = new ProductApi(defaultClient);
    Integer page = 56; // Integer | 
    Integer perPage = 25; // Integer | 
    String query = "query_example"; // String | 
    try {
      ProductList result = apiInstance.listProduct(page, perPage, query);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ProductApi#listProduct");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
page Integer [optional]
perPage Integer [optional] [default to 25]
query String [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.

updateProduct

Product updateProduct(id, product)

Update a product

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

Example

// Import classes:
import com.clientapi.billingo.invoker.ApiClient;
import com.clientapi.billingo.invoker.ApiException;
import com.clientapi.billingo.invoker.Configuration;
import com.clientapi.billingo.invoker.auth.*;
import com.clientapi.billingo.invoker.models.*;
import com.clientapi.billingo.api.ProductApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.billingo.hu/v3");
    
    // Configure API key authorization: api_key
    ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
    api_key.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //api_key.setApiKeyPrefix("Token");

    ProductApi apiInstance = new ProductApi(defaultClient);
    Integer id = 56; // Integer | 
    Product product = new Product(); // Product | Product object that you would like to update.
    try {
      Product result = apiInstance.updateProduct(id, product);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ProductApi#updateProduct");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
id Integer
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.
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.
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.