Package com.w3asel.inventree.api

Class AdminApi

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

  • Constructor Details

    • AdminApi

      public AdminApi()

    • AdminApi

      public AdminApi(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)

    • adminConfigListCall

      public okhttp3.Call adminConfigListCall(ApiCallback _callback) throws ApiException
      Build call for adminConfigList
      Parameters:
      _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 No response body -

    • adminConfigList

      public void adminConfigList() throws ApiException
      List view for all accessed configurations.
      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 No response body -

    • adminConfigListWithHttpInfo

      public ApiResponse<Void> adminConfigListWithHttpInfo() throws ApiException
      List view for all accessed configurations.
      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
      200 No response body -

    • adminConfigListAsync

      public okhttp3.Call adminConfigListAsync(ApiCallback<Void> _callback) throws ApiException
      (asynchronously) List view for all accessed configurations.
      Parameters:
      _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 No response body -

    • adminConfigRetrieveCall

      public okhttp3.Call adminConfigRetrieveCall(@Nonnull String key, ApiCallback _callback) throws ApiException
      Build call for adminConfigRetrieve
      Parameters:
      key - (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 No response body -

    • adminConfigRetrieve

      public void adminConfigRetrieve(@Nonnull String key) throws ApiException
      Detail view for an individual configuration.
      Parameters:
      key - (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
      200 No response body -

    • adminConfigRetrieveWithHttpInfo

      public ApiResponse<Void> adminConfigRetrieveWithHttpInfo(@Nonnull String key) throws ApiException
      Detail view for an individual configuration.
      Parameters:
      key - (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
      200 No response body -

    • adminConfigRetrieveAsync

      public okhttp3.Call adminConfigRetrieveAsync(@Nonnull String key, ApiCallback<Void> _callback) throws ApiException
      (asynchronously) Detail view for an individual configuration.
      Parameters:
      key - (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 No response body -

    • adminEmailBulkDestroyCall

      public okhttp3.Call adminEmailBulkDestroyCall(@Nonnull BulkRequest bulkRequest, ApiCallback _callback) throws ApiException
      Build call for adminEmailBulkDestroy
      Parameters:
      bulkRequest - (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 -

    • adminEmailBulkDestroy

      public void adminEmailBulkDestroy(@Nonnull BulkRequest bulkRequest) throws ApiException
      Perform a DELETE operation against this list endpoint. Note that the typical DRF list endpoint does not support DELETE, so this method is provided as a custom implementation.
      Parameters:
      bulkRequest - (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 -

    • adminEmailBulkDestroyWithHttpInfo

      public ApiResponse<Void> adminEmailBulkDestroyWithHttpInfo(@Nonnull BulkRequest bulkRequest) throws ApiException
      Perform a DELETE operation against this list endpoint. Note that the typical DRF list endpoint does not support DELETE, so this method is provided as a custom implementation.
      Parameters:
      bulkRequest - (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 -

    • adminEmailBulkDestroyAsync

      public okhttp3.Call adminEmailBulkDestroyAsync(@Nonnull BulkRequest bulkRequest, ApiCallback<Void> _callback) throws ApiException
      (asynchronously) Perform a DELETE operation against this list endpoint. Note that the typical DRF list endpoint does not support DELETE, so this method is provided as a custom implementation.
      Parameters:
      bulkRequest - (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 -

    • adminEmailDestroyCall

      public okhttp3.Call adminEmailDestroyCall(@Nonnull UUID globalId, ApiCallback _callback) throws ApiException
      Build call for adminEmailDestroy
      Parameters:
      globalId - (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 -

    • adminEmailDestroy

      public void adminEmailDestroy(@Nonnull UUID globalId) throws ApiException
      Detail view for an email object.
      Parameters:
      globalId - (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 -

    • adminEmailDestroyWithHttpInfo

      public ApiResponse<Void> adminEmailDestroyWithHttpInfo(@Nonnull UUID globalId) throws ApiException
      Detail view for an email object.
      Parameters:
      globalId - (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 -

    • adminEmailDestroyAsync

      public okhttp3.Call adminEmailDestroyAsync(@Nonnull UUID globalId, ApiCallback<Void> _callback) throws ApiException
      (asynchronously) Detail view for an email object.
      Parameters:
      globalId - (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 -

    • adminEmailListCall

      public okhttp3.Call adminEmailListCall(@Nonnull Integer limit, @Nullable Integer offset, @Nullable String ordering, @Nullable String search, ApiCallback _callback) throws ApiException
      Build call for adminEmailList
      Parameters:
      limit - Number of results to return per page. (required)
      offset - The initial index from which to return the results. (optional)
      ordering - Which field to use when ordering the results. Possible fields: created, subject, to, sender, status, timestamp, direction. (optional)
      search - A search term. Searched fields: global_id, message_id_key, sender, subject, thread_id_key, to. (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 -

    • adminEmailList

      public PaginatedEmailMessageList adminEmailList(@Nonnull Integer limit, @Nullable Integer offset, @Nullable String ordering, @Nullable String search) throws ApiException
      List view for email objects.
      Parameters:
      limit - Number of results to return per page. (required)
      offset - The initial index from which to return the results. (optional)
      ordering - Which field to use when ordering the results. Possible fields: created, subject, to, sender, status, timestamp, direction. (optional)
      search - A search term. Searched fields: global_id, message_id_key, sender, subject, thread_id_key, to. (optional)
      Returns:
      PaginatedEmailMessageList
      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 -

    • adminEmailListWithHttpInfo

      public ApiResponse<PaginatedEmailMessageList> adminEmailListWithHttpInfo(@Nonnull Integer limit, @Nullable Integer offset, @Nullable String ordering, @Nullable String search) throws ApiException
      List view for email objects.
      Parameters:
      limit - Number of results to return per page. (required)
      offset - The initial index from which to return the results. (optional)
      ordering - Which field to use when ordering the results. Possible fields: created, subject, to, sender, status, timestamp, direction. (optional)
      search - A search term. Searched fields: global_id, message_id_key, sender, subject, thread_id_key, to. (optional)
      Returns:
      ApiResponse<PaginatedEmailMessageList>
      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 -

    • adminEmailListAsync

      public okhttp3.Call adminEmailListAsync(@Nonnull Integer limit, @Nullable Integer offset, @Nullable String ordering, @Nullable String search, ApiCallback<PaginatedEmailMessageList> _callback) throws ApiException
      (asynchronously) List view for email objects.
      Parameters:
      limit - Number of results to return per page. (required)
      offset - The initial index from which to return the results. (optional)
      ordering - Which field to use when ordering the results. Possible fields: created, subject, to, sender, status, timestamp, direction. (optional)
      search - A search term. Searched fields: global_id, message_id_key, sender, subject, thread_id_key, to. (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 -

    • adminEmailRetrieveCall

      public okhttp3.Call adminEmailRetrieveCall(@Nonnull UUID globalId, ApiCallback _callback) throws ApiException
      Build call for adminEmailRetrieve
      Parameters:
      globalId - (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 -

    • adminEmailRetrieve

      public EmailMessage adminEmailRetrieve(@Nonnull UUID globalId) throws ApiException
      Detail view for an email object.
      Parameters:
      globalId - (required)
      Returns:
      EmailMessage
      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 -

    • adminEmailRetrieveWithHttpInfo

      public ApiResponse<EmailMessage> adminEmailRetrieveWithHttpInfo(@Nonnull UUID globalId) throws ApiException
      Detail view for an email object.
      Parameters:
      globalId - (required)
      Returns:
      ApiResponse<EmailMessage>
      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 -

    • adminEmailRetrieveAsync

      public okhttp3.Call adminEmailRetrieveAsync(@Nonnull UUID globalId, ApiCallback<EmailMessage> _callback) throws ApiException
      (asynchronously) Detail view for an email object.
      Parameters:
      globalId - (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 -

    • adminEmailTestCreateCall

      public okhttp3.Call adminEmailTestCreateCall(@Nonnull TestEmail testEmail, ApiCallback _callback) throws ApiException
      Build call for adminEmailTestCreate
      Parameters:
      testEmail - (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 -

    • adminEmailTestCreate

      public TestEmail adminEmailTestCreate(@Nonnull TestEmail testEmail) throws ApiException
      Send a test email.
      Parameters:
      testEmail - (required)
      Returns:
      TestEmail
      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 -

    • adminEmailTestCreateWithHttpInfo

      public ApiResponse<TestEmail> adminEmailTestCreateWithHttpInfo(@Nonnull TestEmail testEmail) throws ApiException
      Send a test email.
      Parameters:
      testEmail - (required)
      Returns:
      ApiResponse<TestEmail>
      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 -

    • adminEmailTestCreateAsync

      public okhttp3.Call adminEmailTestCreateAsync(@Nonnull TestEmail testEmail, ApiCallback<TestEmail> _callback) throws ApiException
      (asynchronously) Send a test email.
      Parameters:
      testEmail - (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 -