RequestContactExportCustomContactFilter (sib-api-v3-sdk 5.3.0 API)

java.lang.Object
- sibModel.RequestContactExportCustomContactFilter

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2021-03-12T11:46:32.800+05:30")
public class RequestContactExportCustomContactFilter
extends Object

Only one of the two filter options (contactFilter or customContactFilter) can be passed in the request. Set the filter for the contacts to be exported.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`RequestContactExportCustomContactFilter.ActionForContactsEnum` Mandatory if neither actionForEmailCampaigns nor actionForSmsCampaigns is passed.
`static class`	`RequestContactExportCustomContactFilter.ActionForEmailCampaignsEnum` Mandatory if neither actionForContacts nor actionForSmsCampaigns is passed.
`static class`	`RequestContactExportCustomContactFilter.ActionForSmsCampaignsEnum` Mandatory if neither actionForContacts nor actionForEmailCampaigns is passed.

Constructor Summary

Constructors
Constructor and Description

RequestContactExportCustomContactFilter()

Constructors
Constructor and Description
`RequestContactExportCustomContactFilter()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RequestContactExportCustomContactFilter`	`actionForContacts(RequestContactExportCustomContactFilter.ActionForContactsEnum actionForContacts)`
`RequestContactExportCustomContactFilter`	`actionForEmailCampaigns(RequestContactExportCustomContactFilter.ActionForEmailCampaignsEnum actionForEmailCampaigns)`
`RequestContactExportCustomContactFilter`	`actionForSmsCampaigns(RequestContactExportCustomContactFilter.ActionForSmsCampaignsEnum actionForSmsCampaigns)`
`RequestContactExportCustomContactFilter`	`emailCampaignId(Long emailCampaignId)`
`boolean`	`equals(Object o)`
`RequestContactExportCustomContactFilter.ActionForContactsEnum`	`getActionForContacts()` Mandatory if neither actionForEmailCampaigns nor actionForSmsCampaigns is passed.
`RequestContactExportCustomContactFilter.ActionForEmailCampaignsEnum`	`getActionForEmailCampaigns()` Mandatory if neither actionForContacts nor actionForSmsCampaigns is passed.
`RequestContactExportCustomContactFilter.ActionForSmsCampaignsEnum`	`getActionForSmsCampaigns()` Mandatory if neither actionForContacts nor actionForEmailCampaigns is passed.
`Long`	`getEmailCampaignId()` Considered only if actionForEmailCampaigns is passed, ignored otherwise.
`Long`	`getListId()` Mandatory if actionForContacts is passed, ignored otherwise.
`Long`	`getSmsCampaignId()` Considered only if actionForSmsCampaigns is passed, ignored otherwise.
`int`	`hashCode()`
`RequestContactExportCustomContactFilter`	`listId(Long listId)`
`void`	`setActionForContacts(RequestContactExportCustomContactFilter.ActionForContactsEnum actionForContacts)`
`void`	`setActionForEmailCampaigns(RequestContactExportCustomContactFilter.ActionForEmailCampaignsEnum actionForEmailCampaigns)`
`void`	`setActionForSmsCampaigns(RequestContactExportCustomContactFilter.ActionForSmsCampaignsEnum actionForSmsCampaigns)`
`void`	`setEmailCampaignId(Long emailCampaignId)`
`void`	`setListId(Long listId)`
`void`	`setSmsCampaignId(Long smsCampaignId)`
`RequestContactExportCustomContactFilter`	`smsCampaignId(Long smsCampaignId)`
`String`	`toString()`

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

- Constructor Detail
  - RequestContactExportCustomContactFilter
```
public RequestContactExportCustomContactFilter()
```
- Method Detail
  - actionForContacts
```
public RequestContactExportCustomContactFilter actionForContacts(RequestContactExportCustomContactFilter.ActionForContactsEnum actionForContacts)
```
  - getActionForContacts
```
public RequestContactExportCustomContactFilter.ActionForContactsEnum getActionForContacts()
```
    Mandatory if neither actionForEmailCampaigns nor actionForSmsCampaigns is passed. This will export the contacts on the basis of provided action applied on contacts as per the list id. * allContacts - Fetch the list of all contacts for a particular list. * subscribed & unsubscribed - Fetch the list of subscribed / unsubscribed (blacklisted via any means) contacts for a particular list. * unsubscribedPerList - Fetch the list of contacts that are unsubscribed from a particular list only.
    
    Returns:
    
    actionForContacts
  - setActionForContacts
```
public void setActionForContacts(RequestContactExportCustomContactFilter.ActionForContactsEnum actionForContacts)
```
  - actionForEmailCampaigns
```
public RequestContactExportCustomContactFilter actionForEmailCampaigns(RequestContactExportCustomContactFilter.ActionForEmailCampaignsEnum actionForEmailCampaigns)
```
  - getActionForEmailCampaigns
```
public RequestContactExportCustomContactFilter.ActionForEmailCampaignsEnum getActionForEmailCampaigns()
```
    Mandatory if neither actionForContacts nor actionForSmsCampaigns is passed. This will export the contacts on the basis of provided action applied on email campaigns. * openers & nonOpeners - emailCampaignId is mandatory. Fetch the list of readers / non-readers for a particular email campaign. * clickers & nonClickers - emailCampaignId is mandatory. Fetch the list of clickers / non-clickers for a particular email campaign. * unsubscribed - emailCampaignId is mandatory. Fetch the list of all unsubscribed (blacklisted via any means) contacts for a particular email campaign. * hardBounces & softBounces - emailCampaignId is optional. Fetch the list of hard bounces / soft bounces for a particular / all email campaign(s).
    
    Returns:
    
    actionForEmailCampaigns
  - setActionForEmailCampaigns
```
public void setActionForEmailCampaigns(RequestContactExportCustomContactFilter.ActionForEmailCampaignsEnum actionForEmailCampaigns)
```
  - actionForSmsCampaigns
```
public RequestContactExportCustomContactFilter actionForSmsCampaigns(RequestContactExportCustomContactFilter.ActionForSmsCampaignsEnum actionForSmsCampaigns)
```
  - getActionForSmsCampaigns
```
public RequestContactExportCustomContactFilter.ActionForSmsCampaignsEnum getActionForSmsCampaigns()
```
    Mandatory if neither actionForContacts nor actionForEmailCampaigns is passed. This will export the contacts on the basis of provided action applied on sms campaigns. * unsubscribed - Fetch the list of all unsubscribed (blacklisted via any means) contacts for all / particular sms campaigns. * hardBounces & softBounces - Fetch the list of hard bounces / soft bounces for all / particular sms campaigns.
    
    Returns:
    
    actionForSmsCampaigns
  - setActionForSmsCampaigns
```
public void setActionForSmsCampaigns(RequestContactExportCustomContactFilter.ActionForSmsCampaignsEnum actionForSmsCampaigns)
```
  - listId
```
public RequestContactExportCustomContactFilter listId(Long listId)
```
  - getListId
```
public Long getListId()
```
    Mandatory if actionForContacts is passed, ignored otherwise. Id of the list for which the corresponding action shall be applied in the filter.
    
    Returns:
    
    listId
  - setListId
```
public void setListId(Long listId)
```
  - emailCampaignId
```
public RequestContactExportCustomContactFilter emailCampaignId(Long emailCampaignId)
```
  - getEmailCampaignId
```
public Long getEmailCampaignId()
```
    Considered only if actionForEmailCampaigns is passed, ignored otherwise. Mandatory if action is one of the following - openers, nonOpeners, clickers, nonClickers, unsubscribed. The id of the email campaign for which the corresponding action shall be applied in the filter.
    
    Returns:
    
    emailCampaignId
  - setEmailCampaignId
```
public void setEmailCampaignId(Long emailCampaignId)
```
  - smsCampaignId
```
public RequestContactExportCustomContactFilter smsCampaignId(Long smsCampaignId)
```
  - getSmsCampaignId
```
public Long getSmsCampaignId()
```
    Considered only if actionForSmsCampaigns is passed, ignored otherwise. The id of sms campaign for which the corresponding action shall be applied in the filter.
    
    Returns:
    
    smsCampaignId
  - setSmsCampaignId
```
public void setSmsCampaignId(Long smsCampaignId)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class RequestContactExportCustomContactFilter

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RequestContactExportCustomContactFilter

Method Detail

actionForContacts

getActionForContacts

setActionForContacts

actionForEmailCampaigns

getActionForEmailCampaigns

setActionForEmailCampaigns

actionForSmsCampaigns

getActionForSmsCampaigns

setActionForSmsCampaigns

listId

getListId

setListId

emailCampaignId

getEmailCampaignId

setEmailCampaignId

smsCampaignId

getSmsCampaignId

setSmsCampaignId

equals

hashCode

toString