Package org.apache.fineract.client.services

Interface ReportMailingJobsApi

public interface ReportMailingJobsApi

  • Method Details

    • createReportMailingJob

      @Headers("Content-Type:application/json") @POST("v1/reportmailingjobs") retrofit2.Call<PostReportMailingJobsResponse> createReportMailingJob(@Body PostReportMailingJobsRequest postReportMailingJobsRequest)
      Create a Report Mailing Job Mandatory Fields: name, startDateTime, stretchyReportId, emailRecipients, emailSubject, emailMessage, emailAttachmentFileFormatId, recurrence, isActive Optional Fields: description, stretchyReportParamMap
      Parameters:
      postReportMailingJobsRequest - (required)
      Returns:
      Call<PostReportMailingJobsResponse>

    • deleteReportMailingJob

      @DELETE("v1/reportmailingjobs/{entityId}") retrofit2.Call<DeleteReportMailingJobsResponse> deleteReportMailingJob(@Path("entityId") Long entityId)
      Delete a Report Mailing Job
      Parameters:
      entityId - entityId (required)
      Returns:
      Call<DeleteReportMailingJobsResponse>

    • retrieveAllReportMailingJobs

      @GET("v1/reportmailingjobs") retrofit2.Call<List<GetReportMailingJobsResponse>> retrieveAllReportMailingJobs(@Query("offset") Integer offset, @Query("limit") Integer limit, @Query("orderBy") String orderBy, @Query("sortOrder") String sortOrder)
      List Report Mailing Jobs Example Requests: reportmailingjobs
      Parameters:
      offset - offset (optional)
      limit - limit (optional)
      orderBy - orderBy (optional)
      sortOrder - sortOrder (optional)
      Returns:
      Call<List<GetReportMailingJobsResponse>>

    • retrieveReportMailingJob

      @GET("v1/reportmailingjobs/{entityId}") retrofit2.Call<GetReportMailingJobsResponse> retrieveReportMailingJob(@Path("entityId") Long entityId)
      Retrieve a Report Mailing Job Example Requests: reportmailingjobs/1 reportmailingjobs/1?template=true
      Parameters:
      entityId - entityId (required)
      Returns:
      Call<GetReportMailingJobsResponse>

    • retrieveReportMailingJobTemplate

      @GET("v1/reportmailingjobs/template") retrofit2.Call<GetReportMailingJobsTemplate> retrieveReportMailingJobTemplate()
      Retrieve Report Mailing Job Details Template This is a convenience resource. It can be useful when building maintenance user interface screens for report mailing job applications. The template data returned consists of any or all of: Field Defaults Allowed description Lists Example Request: reportmailingjobs/template
      Returns:
      Call<GetReportMailingJobsTemplate>

    • updateReportMailingJob

      @Headers("Content-Type:application/json") @PUT("v1/reportmailingjobs/{entityId}") retrofit2.Call<PutReportMailingJobsResponse> updateReportMailingJob(@Path("entityId") Long entityId, @Body PutReportMailingJobsRequest putReportMailingJobsRequest)
      Update a Report Mailing Job
      Parameters:
      entityId - entityId (required)
      putReportMailingJobsRequest - (required)
      Returns:
      Call<PutReportMailingJobsResponse>

    • createReportMailingJob

      @Headers("Content-Type:application/json") @POST("v1/reportmailingjobs") retrofit2.Call<PostReportMailingJobsResponse> createReportMailingJob(@Body PostReportMailingJobsRequest postReportMailingJobsRequest, @HeaderMap Map<String,String> headers)
      Create a Report Mailing Job Mandatory Fields: name, startDateTime, stretchyReportId, emailRecipients, emailSubject, emailMessage, emailAttachmentFileFormatId, recurrence, isActive Optional Fields: description, stretchyReportParamMap
      Parameters:
      postReportMailingJobsRequest - (required)
      Returns:
      Call<PostReportMailingJobsResponse>

    • deleteReportMailingJob

      @DELETE("v1/reportmailingjobs/{entityId}") retrofit2.Call<DeleteReportMailingJobsResponse> deleteReportMailingJob(@Path("entityId") Long entityId, @HeaderMap Map<String,String> headers)
      Delete a Report Mailing Job
      Parameters:
      entityId - entityId (required)
      Returns:
      Call<DeleteReportMailingJobsResponse>

    • retrieveAllReportMailingJobs

      @GET("v1/reportmailingjobs") retrofit2.Call<List<GetReportMailingJobsResponse>> retrieveAllReportMailingJobs(@Query("offset") Integer offset, @Query("limit") Integer limit, @Query("orderBy") String orderBy, @Query("sortOrder") String sortOrder, @HeaderMap Map<String,String> headers)
      List Report Mailing Jobs Example Requests: reportmailingjobs
      Parameters:
      offset - offset (optional)
      limit - limit (optional)
      orderBy - orderBy (optional)
      sortOrder - sortOrder (optional)
      Returns:
      Call<List<GetReportMailingJobsResponse>>

    • retrieveReportMailingJob

      @GET("v1/reportmailingjobs/{entityId}") retrofit2.Call<GetReportMailingJobsResponse> retrieveReportMailingJob(@Path("entityId") Long entityId, @HeaderMap Map<String,String> headers)
      Retrieve a Report Mailing Job Example Requests: reportmailingjobs/1 reportmailingjobs/1?template=true
      Parameters:
      entityId - entityId (required)
      Returns:
      Call<GetReportMailingJobsResponse>

    • retrieveReportMailingJobTemplate

      @GET("v1/reportmailingjobs/template") retrofit2.Call<GetReportMailingJobsTemplate> retrieveReportMailingJobTemplate(@HeaderMap Map<String,String> headers)
      Retrieve Report Mailing Job Details Template This is a convenience resource. It can be useful when building maintenance user interface screens for report mailing job applications. The template data returned consists of any or all of: Field Defaults Allowed description Lists Example Request: reportmailingjobs/template
      Returns:
      Call<GetReportMailingJobsTemplate>

    • updateReportMailingJob

      @Headers("Content-Type:application/json") @PUT("v1/reportmailingjobs/{entityId}") retrofit2.Call<PutReportMailingJobsResponse> updateReportMailingJob(@Path("entityId") Long entityId, @Body PutReportMailingJobsRequest putReportMailingJobsRequest, @HeaderMap Map<String,String> headers)
      Update a Report Mailing Job
      Parameters:
      entityId - entityId (required)
      putReportMailingJobsRequest - (required)
      Returns:
      Call<PutReportMailingJobsResponse>