Package com.sinch.sdk.domains.sms.models.requests

Class DeliveryReportListRequestParameters

java.lang.Object

com.sinch.sdk.domains.sms.models.requests.DeliveryReportListRequestParameters

public class DeliveryReportListRequestParameters
extends Object

Parameters request to list delivery reports for a project

Since:

1.0

See Also:

• https://developers.sinch.com/docs/sms/api-reference/sms/tag/Delivery-reports/#tag/Delivery-reports/operation/getDeliveryReports

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DeliveryReportListRequestParameters.Builder

Constructor Summary

Constructors

Constructor	Description
DeliveryReportListRequestParameters(Instant startDate, Instant endDate, String clientReference, Integer page, Integer pageSize, Collection<DeliveryReportStatus> statuses, Collection<DeliveryReportErrorCode> codes)

Method Summary

Modifier and Type	Method	Description
static DeliveryReportListRequestParameters.Builder	builder()
static DeliveryReportListRequestParameters.Builder	builder(DeliveryReportListRequestParameters parameters)
Optional<String>	getClientReference()
Optional<Collection<DeliveryReportErrorCode>>	getCodes()
Optional<Instant>	getEndDate()
Optional<Integer>	getPage()
Optional<Integer>	getPageSize()
Optional<Instant>	getStartDate()
Optional<Collection<DeliveryReportStatus>>	getStatuses()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DeliveryReportListRequestParameters

public DeliveryReportListRequestParameters(Instant startDate,
 Instant endDate,
 String clientReference,
 Integer page,
 Integer pageSize,
 Collection<DeliveryReportStatus> statuses,
 Collection<DeliveryReportErrorCode> codes)

Parameters:

startDate - Only list messages received at or after this date/time. Default: 24h ago

endDate - Only list messages received before this date/time.

clientReference - Client reference to include

page - The page number starting from 0.

pageSize - Determines the size of a page.

statuses - List of delivery report statuses to include

codes - List of delivery receipt error codes to include

Method Details

getStartDate

public Optional<Instant> getStartDate()

getEndDate

public Optional<Instant> getEndDate()

getClientReference

public Optional<String> getClientReference()

getPage

public Optional<Integer> getPage()

getPageSize

public Optional<Integer> getPageSize()

getStatuses

public Optional<Collection<DeliveryReportStatus>> getStatuses()

getCodes

public Optional<Collection<DeliveryReportErrorCode>> getCodes()

builder

public static DeliveryReportListRequestParameters.Builder builder()

builder

public static DeliveryReportListRequestParameters.Builder builder(DeliveryReportListRequestParameters parameters)