java.lang.Object
- pl.gsmservice.gateway.Senders

public class Senders
extends java.lang.Object

Method Summary

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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - async
```
public AsyncSenders async()
```
    Switches to the async SDK.
    
    Returns:
    
    The async 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 call builder
  - listDirect
```
public ListSendersResponse listDirect()
                               throws java.lang.Exception
```
    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 response from the API call
    
    Throws:
    
    java.lang.Exception - if the API call fails
  - list
```
public ListSendersResponse list(java.util.Optional<Options> options)
                         throws java.lang.Exception
```
    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:
    
    The response from the API call
    
    Throws:
    
    java.lang.Exception - if the API call fails
  - 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 call builder
  - add
```
public AddSenderResponse add(SenderInput request)
                      throws java.lang.Exception
```
    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:
    
    The response from the API call
    
    Throws:
    
    java.lang.Exception - if the API call fails
  - add
```
public AddSenderResponse add(SenderInput request,
                             java.util.Optional<Options> options)
                      throws java.lang.Exception
```
    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:
    
    The response from the API call
    
    Throws:
    
    java.lang.Exception - if the API call fails
  - 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 call builder
  - delete
```
public DeleteSenderResponse delete(java.lang.String sender)
                            throws java.lang.Exception
```
    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:
    
    The response from the API call
    
    Throws:
    
    java.lang.Exception - if the API call fails
  - delete
```
public DeleteSenderResponse delete(java.lang.String sender,
                                   java.util.Optional<Options> options)
                            throws java.lang.Exception
```
    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:
    
    The response from the API call
    
    Throws:
    
    java.lang.Exception - if the API call fails
  - 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 call builder
  - setDefault
```
public SetDefaultSenderResponse setDefault(java.lang.String sender)
                                    throws java.lang.Exception
```
    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:
    
    The response from the API call
    
    Throws:
    
    java.lang.Exception - if the API call fails
  - setDefault
```
public SetDefaultSenderResponse setDefault(java.lang.String sender,
                                           java.util.Optional<Options> options)
                                    throws java.lang.Exception
```
    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:
    
    The response from the API call
    
    Throws:
    
    java.lang.Exception - if the API call fails

Class Senders

Method Summary

Methods inherited from class java.lang.Object

Method Detail

async

list

listDirect

list

add

add

add

delete

delete

delete

setDefault

setDefault

setDefault