Package com.w3asel.inventree.api

Class LabelApi

java.lang.Object
com.w3asel.inventree.api.LabelApi
public class LabelApi extends Object

  • Constructor Details

    • LabelApi

      public LabelApi()

    • LabelApi

      public LabelApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • getHostIndex

      public int getHostIndex()

    • setHostIndex

      public void setHostIndex(int hostIndex)

    • getCustomBaseUrl

      public String getCustomBaseUrl()

    • setCustomBaseUrl

      public void setCustomBaseUrl(String customBaseUrl)

    • labelPrintCreateCall

      public okhttp3.Call labelPrintCreateCall(@Nonnull LabelPrint labelPrint, ApiCallback _callback) throws ApiException
      Build call for labelPrintCreate
      Parameters:
      labelPrint - (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 -

    • labelPrintCreate

      public LabelPrint labelPrintCreate(@Nonnull LabelPrint labelPrint) throws ApiException
      POST action for printing labels.
      Parameters:
      labelPrint - (required)
      Returns:
      LabelPrint
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 -

    • labelPrintCreateWithHttpInfo

      public ApiResponse<LabelPrint> labelPrintCreateWithHttpInfo(@Nonnull LabelPrint labelPrint) throws ApiException
      POST action for printing labels.
      Parameters:
      labelPrint - (required)
      Returns:
      ApiResponse<LabelPrint>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 -

    • labelPrintCreateAsync

      public okhttp3.Call labelPrintCreateAsync(@Nonnull LabelPrint labelPrint, ApiCallback<LabelPrint> _callback) throws ApiException
      (asynchronously) POST action for printing labels.
      Parameters:
      labelPrint - (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 -

    • labelTemplateCreateCall

      public okhttp3.Call labelTemplateCreateCall(@Nonnull LabelTemplate labelTemplate, ApiCallback _callback) throws ApiException
      Build call for labelTemplateCreate
      Parameters:
      labelTemplate - (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      201 -

    • labelTemplateCreate

      public LabelTemplate labelTemplateCreate(@Nonnull LabelTemplate labelTemplate) throws ApiException
      API endpoint for viewing list of LabelTemplate objects.
      Parameters:
      labelTemplate - (required)
      Returns:
      LabelTemplate
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      201 -

    • labelTemplateCreateWithHttpInfo

      public ApiResponse<LabelTemplate> labelTemplateCreateWithHttpInfo(@Nonnull LabelTemplate labelTemplate) throws ApiException
      API endpoint for viewing list of LabelTemplate objects.
      Parameters:
      labelTemplate - (required)
      Returns:
      ApiResponse<LabelTemplate>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      201 -

    • labelTemplateCreateAsync

      public okhttp3.Call labelTemplateCreateAsync(@Nonnull LabelTemplate labelTemplate, ApiCallback<LabelTemplate> _callback) throws ApiException
      (asynchronously) API endpoint for viewing list of LabelTemplate objects.
      Parameters:
      labelTemplate - (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      201 -

    • labelTemplateDestroyCall

      public okhttp3.Call labelTemplateDestroyCall(@Nonnull Integer id, ApiCallback _callback) throws ApiException
      Build call for labelTemplateDestroy
      Parameters:
      id - (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      204 No response body -

    • labelTemplateDestroy

      public void labelTemplateDestroy(@Nonnull Integer id) throws ApiException
      Detail API endpoint for label template model.
      Parameters:
      id - (required)
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      204 No response body -

    • labelTemplateDestroyWithHttpInfo

      public ApiResponse<Void> labelTemplateDestroyWithHttpInfo(@Nonnull Integer id) throws ApiException
      Detail API endpoint for label template model.
      Parameters:
      id - (required)
      Returns:
      ApiResponse<Void>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      204 No response body -

    • labelTemplateDestroyAsync

      public okhttp3.Call labelTemplateDestroyAsync(@Nonnull Integer id, ApiCallback<Void> _callback) throws ApiException
      (asynchronously) Detail API endpoint for label template model.
      Parameters:
      id - (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      204 No response body -

    • labelTemplateListCall

      public okhttp3.Call labelTemplateListCall(@Nonnull Integer limit, @Nullable Boolean enabled, @Nullable String items, @Nullable String modelType, @Nullable Integer offset, @Nullable String search, ApiCallback _callback) throws ApiException
      Build call for labelTemplateList
      Parameters:
      limit - Number of results to return per page. (required)
      enabled - (optional)
      items - Items (optional)
      modelType - Model Type * `build` - Build Order * `buildline` - Build Order Line Item * `company` - Company * `purchaseorder` - Purchase Order * `salesorder` - Sales Order * `salesordershipment` - Sales Order Shipment * `returnorder` - Return Order * `part` - Part * `stockitem` - Stock Item * `stocklocation` - Stock Location (optional)
      offset - The initial index from which to return the results. (optional)
      search - A search term. Searched fields: description, name. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 -

    • labelTemplateList

      public PaginatedLabelTemplateList labelTemplateList(@Nonnull Integer limit, @Nullable Boolean enabled, @Nullable String items, @Nullable String modelType, @Nullable Integer offset, @Nullable String search) throws ApiException
      API endpoint for viewing list of LabelTemplate objects.
      Parameters:
      limit - Number of results to return per page. (required)
      enabled - (optional)
      items - Items (optional)
      modelType - Model Type * `build` - Build Order * `buildline` - Build Order Line Item * `company` - Company * `purchaseorder` - Purchase Order * `salesorder` - Sales Order * `salesordershipment` - Sales Order Shipment * `returnorder` - Return Order * `part` - Part * `stockitem` - Stock Item * `stocklocation` - Stock Location (optional)
      offset - The initial index from which to return the results. (optional)
      search - A search term. Searched fields: description, name. (optional)
      Returns:
      PaginatedLabelTemplateList
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 -

    • labelTemplateListWithHttpInfo

      public ApiResponse<PaginatedLabelTemplateList> labelTemplateListWithHttpInfo(@Nonnull Integer limit, @Nullable Boolean enabled, @Nullable String items, @Nullable String modelType, @Nullable Integer offset, @Nullable String search) throws ApiException
      API endpoint for viewing list of LabelTemplate objects.
      Parameters:
      limit - Number of results to return per page. (required)
      enabled - (optional)
      items - Items (optional)
      modelType - Model Type * `build` - Build Order * `buildline` - Build Order Line Item * `company` - Company * `purchaseorder` - Purchase Order * `salesorder` - Sales Order * `salesordershipment` - Sales Order Shipment * `returnorder` - Return Order * `part` - Part * `stockitem` - Stock Item * `stocklocation` - Stock Location (optional)
      offset - The initial index from which to return the results. (optional)
      search - A search term. Searched fields: description, name. (optional)
      Returns:
      ApiResponse<PaginatedLabelTemplateList>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 -

    • labelTemplateListAsync

      public okhttp3.Call labelTemplateListAsync(@Nonnull Integer limit, @Nullable Boolean enabled, @Nullable String items, @Nullable String modelType, @Nullable Integer offset, @Nullable String search, ApiCallback<PaginatedLabelTemplateList> _callback) throws ApiException
      (asynchronously) API endpoint for viewing list of LabelTemplate objects.
      Parameters:
      limit - Number of results to return per page. (required)
      enabled - (optional)
      items - Items (optional)
      modelType - Model Type * `build` - Build Order * `buildline` - Build Order Line Item * `company` - Company * `purchaseorder` - Purchase Order * `salesorder` - Sales Order * `salesordershipment` - Sales Order Shipment * `returnorder` - Return Order * `part` - Part * `stockitem` - Stock Item * `stocklocation` - Stock Location (optional)
      offset - The initial index from which to return the results. (optional)
      search - A search term. Searched fields: description, name. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 -

    • labelTemplateMetadataPartialUpdateCall

      public okhttp3.Call labelTemplateMetadataPartialUpdateCall(@Nonnull Integer id, @Nullable PatchedMetadata patchedMetadata, ApiCallback _callback) throws ApiException
      Build call for labelTemplateMetadataPartialUpdate
      Parameters:
      id - (required)
      patchedMetadata - (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 -

    • labelTemplateMetadataPartialUpdate

      public Metadata labelTemplateMetadataPartialUpdate(@Nonnull Integer id, @Nullable PatchedMetadata patchedMetadata) throws ApiException
      Generic API endpoint for reading and editing metadata for a model.
      Parameters:
      id - (required)
      patchedMetadata - (optional)
      Returns:
      Metadata
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 -

    • labelTemplateMetadataPartialUpdateWithHttpInfo

      public ApiResponse<Metadata> labelTemplateMetadataPartialUpdateWithHttpInfo(@Nonnull Integer id, @Nullable PatchedMetadata patchedMetadata) throws ApiException
      Generic API endpoint for reading and editing metadata for a model.
      Parameters:
      id - (required)
      patchedMetadata - (optional)
      Returns:
      ApiResponse<Metadata>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 -

    • labelTemplateMetadataPartialUpdateAsync

      public okhttp3.Call labelTemplateMetadataPartialUpdateAsync(@Nonnull Integer id, @Nullable PatchedMetadata patchedMetadata, ApiCallback<Metadata> _callback) throws ApiException
      (asynchronously) Generic API endpoint for reading and editing metadata for a model.
      Parameters:
      id - (required)
      patchedMetadata - (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 -

    • labelTemplateMetadataRetrieveCall

      public okhttp3.Call labelTemplateMetadataRetrieveCall(@Nonnull Integer id, ApiCallback _callback) throws ApiException
      Build call for labelTemplateMetadataRetrieve
      Parameters:
      id - (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 -

    • labelTemplateMetadataRetrieve

      public Metadata labelTemplateMetadataRetrieve(@Nonnull Integer id) throws ApiException
      Generic API endpoint for reading and editing metadata for a model.
      Parameters:
      id - (required)
      Returns:
      Metadata
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 -

    • labelTemplateMetadataRetrieveWithHttpInfo

      public ApiResponse<Metadata> labelTemplateMetadataRetrieveWithHttpInfo(@Nonnull Integer id) throws ApiException
      Generic API endpoint for reading and editing metadata for a model.
      Parameters:
      id - (required)
      Returns:
      ApiResponse<Metadata>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 -

    • labelTemplateMetadataRetrieveAsync

      public okhttp3.Call labelTemplateMetadataRetrieveAsync(@Nonnull Integer id, ApiCallback<Metadata> _callback) throws ApiException
      (asynchronously) Generic API endpoint for reading and editing metadata for a model.
      Parameters:
      id - (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 -

    • labelTemplateMetadataUpdateCall

      public okhttp3.Call labelTemplateMetadataUpdateCall(@Nonnull Integer id, @Nonnull Metadata metadata, ApiCallback _callback) throws ApiException
      Build call for labelTemplateMetadataUpdate
      Parameters:
      id - (required)
      metadata - (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 -

    • labelTemplateMetadataUpdate

      public Metadata labelTemplateMetadataUpdate(@Nonnull Integer id, @Nonnull Metadata metadata) throws ApiException
      Generic API endpoint for reading and editing metadata for a model.
      Parameters:
      id - (required)
      metadata - (required)
      Returns:
      Metadata
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 -

    • labelTemplateMetadataUpdateWithHttpInfo

      public ApiResponse<Metadata> labelTemplateMetadataUpdateWithHttpInfo(@Nonnull Integer id, @Nonnull Metadata metadata) throws ApiException
      Generic API endpoint for reading and editing metadata for a model.
      Parameters:
      id - (required)
      metadata - (required)
      Returns:
      ApiResponse<Metadata>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 -

    • labelTemplateMetadataUpdateAsync

      public okhttp3.Call labelTemplateMetadataUpdateAsync(@Nonnull Integer id, @Nonnull Metadata metadata, ApiCallback<Metadata> _callback) throws ApiException
      (asynchronously) Generic API endpoint for reading and editing metadata for a model.
      Parameters:
      id - (required)
      metadata - (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 -

    • labelTemplatePartialUpdateCall

      public okhttp3.Call labelTemplatePartialUpdateCall(@Nonnull Integer id, @Nullable PatchedLabelTemplate patchedLabelTemplate, ApiCallback _callback) throws ApiException
      Build call for labelTemplatePartialUpdate
      Parameters:
      id - (required)
      patchedLabelTemplate - (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 -

    • labelTemplatePartialUpdate

      public LabelTemplate labelTemplatePartialUpdate(@Nonnull Integer id, @Nullable PatchedLabelTemplate patchedLabelTemplate) throws ApiException
      Detail API endpoint for label template model.
      Parameters:
      id - (required)
      patchedLabelTemplate - (optional)
      Returns:
      LabelTemplate
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 -

    • labelTemplatePartialUpdateWithHttpInfo

      public ApiResponse<LabelTemplate> labelTemplatePartialUpdateWithHttpInfo(@Nonnull Integer id, @Nullable PatchedLabelTemplate patchedLabelTemplate) throws ApiException
      Detail API endpoint for label template model.
      Parameters:
      id - (required)
      patchedLabelTemplate - (optional)
      Returns:
      ApiResponse<LabelTemplate>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 -

    • labelTemplatePartialUpdateAsync

      public okhttp3.Call labelTemplatePartialUpdateAsync(@Nonnull Integer id, @Nullable PatchedLabelTemplate patchedLabelTemplate, ApiCallback<LabelTemplate> _callback) throws ApiException
      (asynchronously) Detail API endpoint for label template model.
      Parameters:
      id - (required)
      patchedLabelTemplate - (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 -

    • labelTemplateRetrieveCall

      public okhttp3.Call labelTemplateRetrieveCall(@Nonnull Integer id, ApiCallback _callback) throws ApiException
      Build call for labelTemplateRetrieve
      Parameters:
      id - (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 -

    • labelTemplateRetrieve

      public LabelTemplate labelTemplateRetrieve(@Nonnull Integer id) throws ApiException
      Detail API endpoint for label template model.
      Parameters:
      id - (required)
      Returns:
      LabelTemplate
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 -

    • labelTemplateRetrieveWithHttpInfo

      public ApiResponse<LabelTemplate> labelTemplateRetrieveWithHttpInfo(@Nonnull Integer id) throws ApiException
      Detail API endpoint for label template model.
      Parameters:
      id - (required)
      Returns:
      ApiResponse<LabelTemplate>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 -

    • labelTemplateRetrieveAsync

      public okhttp3.Call labelTemplateRetrieveAsync(@Nonnull Integer id, ApiCallback<LabelTemplate> _callback) throws ApiException
      (asynchronously) Detail API endpoint for label template model.
      Parameters:
      id - (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 -

    • labelTemplateUpdateCall

      public okhttp3.Call labelTemplateUpdateCall(@Nonnull Integer id, @Nonnull LabelTemplate labelTemplate, ApiCallback _callback) throws ApiException
      Build call for labelTemplateUpdate
      Parameters:
      id - (required)
      labelTemplate - (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 -

    • labelTemplateUpdate

      public LabelTemplate labelTemplateUpdate(@Nonnull Integer id, @Nonnull LabelTemplate labelTemplate) throws ApiException
      Detail API endpoint for label template model.
      Parameters:
      id - (required)
      labelTemplate - (required)
      Returns:
      LabelTemplate
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 -

    • labelTemplateUpdateWithHttpInfo

      public ApiResponse<LabelTemplate> labelTemplateUpdateWithHttpInfo(@Nonnull Integer id, @Nonnull LabelTemplate labelTemplate) throws ApiException
      Detail API endpoint for label template model.
      Parameters:
      id - (required)
      labelTemplate - (required)
      Returns:
      ApiResponse<LabelTemplate>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 -

    • labelTemplateUpdateAsync

      public okhttp3.Call labelTemplateUpdateAsync(@Nonnull Integer id, @Nonnull LabelTemplate labelTemplate, ApiCallback<LabelTemplate> _callback) throws ApiException
      (asynchronously) Detail API endpoint for label template model.
      Parameters:
      id - (required)
      labelTemplate - (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 -