no.digipost.api.useragreements.client

Class DigipostUserAgreementsClient

java.lang.Object

no.digipost.api.useragreements.client.DigipostUserAgreementsClient

public class DigipostUserAgreementsClient
extends Object

API client for managing Digipost documents on behalf of users

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DigipostUserAgreementsClient.Builder

Constructor Summary

Constructors

Constructor and Description
DigipostUserAgreementsClient(ApiService apiService)

Method Summary

Modifier and Type	Method and Description
URI	createOrReplaceAgreement(SenderId senderId, Agreement agreement)
URI	createOrReplaceAgreement(SenderId senderId, Agreement agreement, String requestTrackingId)
void	deleteAgreement(SenderId senderId, AgreementType agreementType, UserId userId, String requestTrackingId)
void	deleteAgreement(URI agreementPath, String requestTrackingId)
void	deleteInvoice(SenderId senderId, AgreementType agreementType, long documentId)
void	deleteInvoice(SenderId senderId, AgreementType agreementType, long documentId, String requestTrackingId)
GetAgreementResult	getAgreement(SenderId senderId, AgreementType type, UserId userId, String requestTrackingId)
Agreement	getAgreement(URI agreementUri, String requestTrackingId)
List<Agreement>	getAgreements(SenderId senderId, UserId userId)
List<Agreement>	getAgreements(SenderId senderId, UserId userId, String requestTrackingId)
List<UserId>	getAgreementUsers(SenderId senderId, AgreementType agreementType, Boolean smsNotificationEnabled)
List<UserId>	getAgreementUsers(SenderId senderId, AgreementType agreementType, Boolean smsNotificationEnabled, String requestTrackingId)
Document	getDocument(SenderId senderId, AgreementType agreementType, long documentId)
Document	getDocument(SenderId senderId, AgreementType agreementType, long documentId, String requestTrackingId)
DocumentContent	getDocumentContent(SenderId senderId, AgreementType agreementType, long documentId)
DocumentContent	getDocumentContent(SenderId senderId, AgreementType agreementType, long documentId, String requestTrackingId)
long	getDocumentCount(SenderId senderId, AgreementType agreementType, UserId userId, GetDocumentsQuery query)
long	getDocumentCount(SenderId senderId, AgreementType agreementType, UserId userId, GetDocumentsQuery query, String requestTrackingId)
long	getDocumentCount(SenderId senderId, AgreementType agreementType, UserId userId, InvoiceStatus status, org.joda.time.LocalDate invoiceDueDateFrom) Deprecated.
long	getDocumentCount(SenderId senderId, AgreementType agreementType, UserId userId, InvoiceStatus status, org.joda.time.LocalDate invoiceDueDateFrom, String requestTrackingId) Deprecated.
List<Document>	getDocuments(SenderId senderId, AgreementType agreementType, UserId userId, GetDocumentsQuery query)
List<Document>	getDocuments(SenderId senderId, AgreementType agreementType, UserId userId, GetDocumentsQuery query, String requestTrackingId)
List<Document>	getDocuments(SenderId senderId, AgreementType agreementType, UserId userId, InvoiceStatus status, org.joda.time.LocalDate invoiceDueDateFrom) Deprecated.
List<Document>	getDocuments(SenderId senderId, AgreementType agreementType, UserId userId, InvoiceStatus status, org.joda.time.LocalDate invoiceDueDateFrom, String requestTrackingId) Deprecated.
IdentificationResult	identifyUser(SenderId senderId, UserId userId)
IdentificationResult	identifyUser(SenderId senderId, UserId userId, String requestTrackingId)
static boolean	isOkResponse(int status)
void	payInvoice(SenderId senderId, AgreementType agreementType, long documentId, InvoicePayment invoicePayment)
void	payInvoice(SenderId senderId, AgreementType agreementType, long documentId, InvoicePayment invoicePayment, String requestTrackingId)
static Error	readErrorFromResponse(org.apache.http.HttpResponse response)
static <T> T	unmarshallEntity(org.apache.http.HttpResponse response, Class<T> returnType)
void	updateInvoice(SenderId senderId, AgreementType agreementType, long documentId, InvoiceUpdate invoiceUpdate)
void	updateInvoice(SenderId senderId, AgreementType agreementType, long documentId, InvoiceUpdate invoiceUpdate, String requestTrackingId)

Methods inherited from class java.lang.Object

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

Constructor Detail

DigipostUserAgreementsClient

public DigipostUserAgreementsClient(ApiService apiService)

Method Detail

identifyUser

public IdentificationResult identifyUser(SenderId senderId,
                                         UserId userId)

identifyUser

public IdentificationResult identifyUser(SenderId senderId,
                                         UserId userId,
                                         String requestTrackingId)

createOrReplaceAgreement

public URI createOrReplaceAgreement(SenderId senderId,
                                    Agreement agreement)

createOrReplaceAgreement

public URI createOrReplaceAgreement(SenderId senderId,
                                    Agreement agreement,
                                    String requestTrackingId)

getAgreement

public Agreement getAgreement(URI agreementUri,
                              String requestTrackingId)

getAgreement

public GetAgreementResult getAgreement(SenderId senderId,
                                       AgreementType type,
                                       UserId userId,
                                       String requestTrackingId)

getAgreements

public List<Agreement> getAgreements(SenderId senderId,
                                     UserId userId)

getAgreements

public List<Agreement> getAgreements(SenderId senderId,
                                     UserId userId,
                                     String requestTrackingId)

deleteAgreement

public void deleteAgreement(URI agreementPath,
                            String requestTrackingId)

deleteAgreement

public void deleteAgreement(SenderId senderId,
                            AgreementType agreementType,
                            UserId userId,
                            String requestTrackingId)

getDocuments

@Deprecated
public List<Document> getDocuments(SenderId senderId,
                                               AgreementType agreementType,
                                               UserId userId,
                                               InvoiceStatus status,
                                               org.joda.time.LocalDate invoiceDueDateFrom)

Deprecated.

getDocuments

@Deprecated
public List<Document> getDocuments(SenderId senderId,
                                               AgreementType agreementType,
                                               UserId userId,
                                               InvoiceStatus status,
                                               org.joda.time.LocalDate invoiceDueDateFrom,
                                               String requestTrackingId)

Deprecated.

getDocuments

public List<Document> getDocuments(SenderId senderId,
                                   AgreementType agreementType,
                                   UserId userId,
                                   GetDocumentsQuery query)

getDocuments

public List<Document> getDocuments(SenderId senderId,
                                   AgreementType agreementType,
                                   UserId userId,
                                   GetDocumentsQuery query,
                                   String requestTrackingId)

getDocument

public Document getDocument(SenderId senderId,
                            AgreementType agreementType,
                            long documentId)

getDocument

public Document getDocument(SenderId senderId,
                            AgreementType agreementType,
                            long documentId,
                            String requestTrackingId)

payInvoice

public void payInvoice(SenderId senderId,
                       AgreementType agreementType,
                       long documentId,
                       InvoicePayment invoicePayment)

payInvoice

public void payInvoice(SenderId senderId,
                       AgreementType agreementType,
                       long documentId,
                       InvoicePayment invoicePayment,
                       String requestTrackingId)

updateInvoice

public void updateInvoice(SenderId senderId,
                          AgreementType agreementType,
                          long documentId,
                          InvoiceUpdate invoiceUpdate)

updateInvoice

public void updateInvoice(SenderId senderId,
                          AgreementType agreementType,
                          long documentId,
                          InvoiceUpdate invoiceUpdate,
                          String requestTrackingId)

deleteInvoice

public void deleteInvoice(SenderId senderId,
                          AgreementType agreementType,
                          long documentId)

deleteInvoice

public void deleteInvoice(SenderId senderId,
                          AgreementType agreementType,
                          long documentId,
                          String requestTrackingId)

getDocumentCount

@Deprecated
public long getDocumentCount(SenderId senderId,
                                         AgreementType agreementType,
                                         UserId userId,
                                         InvoiceStatus status,
                                         org.joda.time.LocalDate invoiceDueDateFrom)

Deprecated.

getDocumentCount

@Deprecated
public long getDocumentCount(SenderId senderId,
                                         AgreementType agreementType,
                                         UserId userId,
                                         InvoiceStatus status,
                                         org.joda.time.LocalDate invoiceDueDateFrom,
                                         String requestTrackingId)

Deprecated.

getDocumentCount

public long getDocumentCount(SenderId senderId,
                             AgreementType agreementType,
                             UserId userId,
                             GetDocumentsQuery query)

getDocumentCount

public long getDocumentCount(SenderId senderId,
                             AgreementType agreementType,
                             UserId userId,
                             GetDocumentsQuery query,
                             String requestTrackingId)

getDocumentContent

public DocumentContent getDocumentContent(SenderId senderId,
                                          AgreementType agreementType,
                                          long documentId)

getDocumentContent

public DocumentContent getDocumentContent(SenderId senderId,
                                          AgreementType agreementType,
                                          long documentId,
                                          String requestTrackingId)

getAgreementUsers

public List<UserId> getAgreementUsers(SenderId senderId,
                                      AgreementType agreementType,
                                      Boolean smsNotificationEnabled)

getAgreementUsers

public List<UserId> getAgreementUsers(SenderId senderId,
                                      AgreementType agreementType,
                                      Boolean smsNotificationEnabled,
                                      String requestTrackingId)

isOkResponse

public static boolean isOkResponse(int status)

unmarshallEntity

public static <T> T unmarshallEntity(org.apache.http.HttpResponse response,
                                     Class<T> returnType)

readErrorFromResponse

public static Error readErrorFromResponse(org.apache.http.HttpResponse response)