com.licensespring.management.api

Interface OrdersApi

public interface OrdersApi

Orders APIs.

Method Summary

Modifier and Type	Method and Description
Manager	addManagerToOrder(Long id, AddManagerToOrderRequest request) Add manager to order.
BackOfficeInstallationFile	createInstallationFile(CreateInstallationFileRequest request) Creates a new installation file.
CreateOrderResponse	createOrder(com.licensespring.model.order.WebhookOrder request) Create/Update order using the webhook DTO.
BackOfficeProductCustomField	createProductCustomField(CreateProductCustomFieldRequest request) Create a product custom field.
void	deleteProductCustomField(int id) Delete the product custom field.
feign.Response	exportToCsv(LocalDate from, LocalDate to) Exports orders to a csv format.
feign.Response	exportToCsv(Range range) Exports orders to a csv format, using the predefined ranges.
String[]	generateLicenseKeys(com.licensespring.dto.GenerateLicenseRequest request) Generates unique license keys to be used with an order containing license-key based licenses.
BackOfficeInstallationFile	getInstallationFile(int id) Gets information about the specific Installation File.
Order	getOrder(Long id) Gets order by LS internal ID.
BackOfficeProduct	getProduct(Long id) Gets product information.
BackOfficeProductCustomField	getProductCustomField(int id) Get product custom field data.
SearchResult<BackOfficeInstallationFile>	searchInstallationFiles(SearchInstallationFilesRequest request) Search installation files.
SearchResult<Order>	searchOrders(SearchOrdersRequest request) Gets a paginated set of orders based on input search request.
SearchResult<BackOfficeProductCustomField>	searchProductCustomFields(SearchProductCustomFieldsRequest request) Search product custom fields.
SearchResult<BackOfficeProduct>	searchProducts(SearchProductsRequest request) Search products.
BackOfficeProductCustomField	updateProductCustomField(int id, UpdateProductCustomFieldRequest request) Update the product custom field.

Method Detail

searchOrders

SearchResult<Order> searchOrders(SearchOrdersRequest request)

Gets a paginated set of orders based on input search request.

Parameters:

request - the request filtering options

Returns:

the search result

getOrder

Order getOrder(Long id)

Gets order by LS internal ID.

Parameters:

id - the id of the order

Returns:

the order

exportToCsv

feign.Response exportToCsv(LocalDate from,
                           LocalDate to)

Exports orders to a csv format. Saves to a stream.

Parameters:

from - the from

to - the to

Returns:

the response

exportToCsv

feign.Response exportToCsv(Range range)

Exports orders to a csv format, using the predefined ranges.

Parameters:

range - the range

Returns:

the response

generateLicenseKeys

String[] generateLicenseKeys(com.licensespring.dto.GenerateLicenseRequest request)

Generates unique license keys to be used with an order containing license-key based licenses.

Parameters:

request - how many licenses and for which product

Returns:

the array of generated license keys

createOrder

CreateOrderResponse createOrder(com.licensespring.model.order.WebhookOrder request)

Create/Update order using the webhook DTO.

Parameters:

request - the request

Returns:

order id and may contain usernames and initial passwords if user-based licenses.

addManagerToOrder

Manager addManagerToOrder(Long id,
                          AddManagerToOrderRequest request)

Add manager to order.

Parameters:

id - id of the order

request - manager information

Returns:

searchProducts

SearchResult<BackOfficeProduct> searchProducts(SearchProductsRequest request)

Search products.

Parameters:

request - the request

Returns:

the search result

getProduct

BackOfficeProduct getProduct(Long id)

Gets product information.

Parameters:

id - the id (internal) of the product

Returns:

the product

searchInstallationFiles

SearchResult<BackOfficeInstallationFile> searchInstallationFiles(SearchInstallationFilesRequest request)

Search installation files.

Parameters:

request - queries and filters for the search

Returns:

the search result

getInstallationFile

BackOfficeInstallationFile getInstallationFile(int id)

Gets information about the specific Installation File.

Parameters:

id - id of the installation file

Returns:

the installation file object

createInstallationFile

BackOfficeInstallationFile createInstallationFile(CreateInstallationFileRequest request)

Creates a new installation file.

Parameters:

request - details of the file

Returns:

the installation file object

searchProductCustomFields

SearchResult<BackOfficeProductCustomField> searchProductCustomFields(SearchProductCustomFieldsRequest request)

Search product custom fields.

Parameters:

request - the request

Returns:

the search result

getProductCustomField

BackOfficeProductCustomField getProductCustomField(int id)

Get product custom field data.

Parameters:

id - the id of the product custom field

Returns:

back office product custom field

createProductCustomField

BackOfficeProductCustomField createProductCustomField(CreateProductCustomFieldRequest request)

Create a product custom field.

Parameters:

request - the request

Returns:

back office product custom field

updateProductCustomField

BackOfficeProductCustomField updateProductCustomField(int id,
                                                      UpdateProductCustomFieldRequest request)

Update the product custom field.

Parameters:

id - the id of the product custom field

request - the request

Returns:

back office product custom field

deleteProductCustomField

void deleteProductCustomField(int id)

Delete the product custom field.

Parameters:

id - the id of the product custom field