Package pl.gsmservice.gateway

Class AsyncSenders

java.lang.Object

pl.gsmservice.gateway.AsyncSenders

public class AsyncSenders
extends java.lang.Object

Method Summary

Modifier and Type	Method	Description
AddSenderRequestBuilder	add()	Add a new sender name
java.util.concurrent.CompletableFuture<AddSenderResponse>	add(SenderInput request)	Add a new sender name
java.util.concurrent.CompletableFuture<AddSenderResponse>	add(SenderInput request, java.util.Optional<Options> options)	Add a new sender name
DeleteSenderRequestBuilder	delete()	Delete a sender name
java.util.concurrent.CompletableFuture<DeleteSenderResponse>	delete(java.lang.String sender)	Delete a sender name
java.util.concurrent.CompletableFuture<DeleteSenderResponse>	delete(java.lang.String sender, java.util.Optional<Options> options)	Delete a sender name
ListSendersRequestBuilder	list()	List allowed senders names
java.util.concurrent.CompletableFuture<ListSendersResponse>	list(java.util.Optional<Options> options)	List allowed senders names
java.util.concurrent.CompletableFuture<ListSendersResponse>	listDirect()	List allowed senders names
SetDefaultSenderRequestBuilder	setDefault()	Set default sender name
java.util.concurrent.CompletableFuture<SetDefaultSenderResponse>	setDefault(java.lang.String sender)	Set default sender name
java.util.concurrent.CompletableFuture<SetDefaultSenderResponse>	setDefault(java.lang.String sender, java.util.Optional<Options> options)	Set default sender name
Senders	sync()	Switches to the sync SDK.

Methods inherited from class java.lang.Object

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

Method Detail

sync

public Senders sync()

Switches to the sync SDK.

Returns:

The sync SDK

list

public ListSendersRequestBuilder list()

List allowed senders names

Get a list of allowed senders defined in your account. The method doesn't take any parameters. Please use builder style:

 ListSendersResponse res = sdk.senders().list()
    .call();
 

As a successful result a ListSendersResponse object will be returned wich senders property of type List<Sender> containing Sender objects, each object per single sender.

Returns:

The async call builder

listDirect

public java.util.concurrent.CompletableFuture<ListSendersResponse> listDirect()

List allowed senders names

Get a list of allowed senders defined in your account. The method doesn't take any parameters. Please use builder style:

 ListSendersResponse res = sdk.senders().list()
    .call();
 

As a successful result a ListSendersResponse object will be returned wich senders property of type List<Sender> containing Sender objects, each object per single sender.

Returns:

CompletableFuture<ListSendersResponse> - The async response

list

public java.util.concurrent.CompletableFuture<ListSendersResponse> list(java.util.Optional<Options> options)

List allowed senders names

Get a list of allowed senders defined in your account. The method doesn't take any parameters. Please use builder style:

 ListSendersResponse res = sdk.senders().list()
    .call();
 

As a successful result a ListSendersResponse object will be returned wich senders property of type List<Sender> containing Sender objects, each object per single sender.

Parameters:

options - additional options

Returns:

CompletableFuture<ListSendersResponse> - The async response

add

public AddSenderRequestBuilder add()

Add a new sender name

Define a new allowed sender on your account. You should pass as parameter a SenderInput object with two properties: sender (defines sender name) and description. Please use builder style:

 AddSenderResponse res = sdk.senders().add()
    .request(req)
    .call();
 

Please carefully fill this property with the extensive description of a sender name (what will be its use, what the name mean, etc).

As a successful result a AddSenderResponse object will be returned with a sender property containing a Sender object with details and status of added sender name.

Returns:

The async call builder

add

public java.util.concurrent.CompletableFuture<AddSenderResponse> add(SenderInput request)

Add a new sender name

Define a new allowed sender on your account. You should pass as parameter a SenderInput object with two properties: sender (defines sender name) and description. Please use builder style:

 AddSenderResponse res = sdk.senders().add()
    .request(req)
    .call();
 

Please carefully fill this property with the extensive description of a sender name (what will be its use, what the name mean, etc).

As a successful result a AddSenderResponse object will be returned with a sender property containing a Sender object with details and status of added sender name.

Parameters:

request - The request object containing all the parameters for the API call.

Returns:

CompletableFuture<AddSenderResponse> - The async response

add

public java.util.concurrent.CompletableFuture<AddSenderResponse> add(SenderInput request,
                                                                     java.util.Optional<Options> options)

Add a new sender name

Define a new allowed sender on your account. You should pass as parameter a SenderInput object with two properties: sender (defines sender name) and description. Please use builder style:

 AddSenderResponse res = sdk.senders().add()
    .request(req)
    .call();
 

Please carefully fill this property with the extensive description of a sender name (what will be its use, what the name mean, etc).

As a successful result a AddSenderResponse object will be returned with a sender property containing a Sender object with details and status of added sender name.

Parameters:

request - The request object containing all the parameters for the API call.

options - additional options

Returns:

CompletableFuture<AddSenderResponse> - The async response

delete

public DeleteSenderRequestBuilder delete()

Delete a sender name

Removes defined sender name from your account. This method accepts a string with a sender name you want to remove. Please use builder style:

 DeleteSenderResponse res = sdk.senders().delete()
    .sender("Podpis")
    .call();
 

Sender name will be deleted immediately.

As a successful response a DeleteSenderResponse object will de returned with statusCode property of 204.

Returns:

The async call builder

delete

public java.util.concurrent.CompletableFuture<DeleteSenderResponse> delete(java.lang.String sender)

Delete a sender name

Removes defined sender name from your account. This method accepts a string with a sender name you want to remove. Please use builder style:

 DeleteSenderResponse res = sdk.senders().delete()
    .sender("Podpis")
    .call();
 

Sender name will be deleted immediately.

As a successful response a DeleteSenderResponse object will de returned with statusCode property of 204.

Parameters:

sender - Sender name to be removed

Returns:

CompletableFuture<DeleteSenderResponse> - The async response

delete

public java.util.concurrent.CompletableFuture<DeleteSenderResponse> delete(java.lang.String sender,
                                                                           java.util.Optional<Options> options)

Delete a sender name

Removes defined sender name from your account. This method accepts a string with a sender name you want to remove. Please use builder style:

 DeleteSenderResponse res = sdk.senders().delete()
    .sender("Podpis")
    .call();
 

Sender name will be deleted immediately.

As a successful response a DeleteSenderResponse object will de returned with statusCode property of 204.

Parameters:

sender - Sender name to be removed

options - additional options

Returns:

CompletableFuture<DeleteSenderResponse> - The async response

setDefault

public SetDefaultSenderRequestBuilder setDefault()

Set default sender name

Set default sender name to one of the senders names already defined on your account. This method accepts a string containing a sender name to be set as default on your account. Please use a builder style:

 SetDefaultSenderResponse res = sdk.senders().setDefault()
    .sender("Podpis")
    .call();
 

As a successful response a SetDefaultSenderResponse will be returned with statusCode property of 204.

Returns:

The async call builder

setDefault

public java.util.concurrent.CompletableFuture<SetDefaultSenderResponse> setDefault(java.lang.String sender)

Set default sender name

Set default sender name to one of the senders names already defined on your account. This method accepts a string containing a sender name to be set as default on your account. Please use a builder style:

 SetDefaultSenderResponse res = sdk.senders().setDefault()
    .sender("Podpis")
    .call();
 

As a successful response a SetDefaultSenderResponse will be returned with statusCode property of 204.

Parameters:

sender - Sender name to set as default

Returns:

CompletableFuture<SetDefaultSenderResponse> - The async response

setDefault

public java.util.concurrent.CompletableFuture<SetDefaultSenderResponse> setDefault(java.lang.String sender,
                                                                                   java.util.Optional<Options> options)

Set default sender name

Set default sender name to one of the senders names already defined on your account. This method accepts a string containing a sender name to be set as default on your account. Please use a builder style:

 SetDefaultSenderResponse res = sdk.senders().setDefault()
    .sender("Podpis")
    .call();
 

As a successful response a SetDefaultSenderResponse will be returned with statusCode property of 204.

Parameters:

sender - Sender name to set as default

options - additional options

Returns:

CompletableFuture<SetDefaultSenderResponse> - The async response