Documentation
¶
Index ¶
- type LISTS
- type LISTS_IMPL
- func (me *LISTS_IMPL) AddContactsBulk(name string, fileUrl string, format string, countrycode *string, ...) (interface{}, error)
- func (me *LISTS_IMPL) AddFieldToList(listId string, field1 string, format string, field2 *string, ...) (interface{}, error)
- func (me *LISTS_IMPL) AddList(name string, format string, field1 *string, ...) (interface{}, error)
- func (me *LISTS_IMPL) AddToList(listId string, msisdn string, format string, firstName *string, ...) (interface{}, error)
- func (me *LISTS_IMPL) DeleteFromList(listId int64, msisdn string, format string) (interface{}, error)
- func (me *LISTS_IMPL) EditListMember(listId string, msisdn string, format string, firstName *string, ...) (interface{}, error)
- func (me *LISTS_IMPL) GetContact(listId string, msisdn string, format string) (interface{}, error)
- func (me *LISTS_IMPL) GetList(listId string, format string, members *string, page *string, max *string) (interface{}, error)
- func (me *LISTS_IMPL) GetLists(format string, page *string, max *string) (interface{}, error)
- func (me *LISTS_IMPL) OptoutListMember(listId string, msisdn string, format string) (interface{}, error)
- func (me *LISTS_IMPL) RemoveList(listId string, format string) (interface{}, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type LISTS ¶
type LISTS interface { AddToList(string, string, string, *string, *string, *string) (interface{}, error) AddFieldToList(string, string, string, *string, map[string]interface{}) (interface{}, error) AddList(string, string, *string, map[string]interface{}) (interface{}, error) OptoutListMember(string, string, string) (interface{}, error) DeleteFromList(int64, string, string) (interface{}, error) GetList(string, string, *string, *string, *string) (interface{}, error) GetLists(string, *string, *string) (interface{}, error) EditListMember(string, string, string, *string, *string, *string, map[string]interface{}) (interface{}, error) GetContact(string, string, string) (interface{}, error) AddContactsBulk(string, string, string, *string, *string, map[string]interface{}) (interface{}, error) RemoveList(string, string) (interface{}, error) }
* Interface for the LISTS_IMPL
type LISTS_IMPL ¶
type LISTS_IMPL struct {
// contains filtered or unexported fields
}
* Client structure as interface implementation
func NewLISTS ¶
func NewLISTS(config configuration_pkg.CONFIGURATION) *LISTS_IMPL
* Factory for the LISTS interaface returning LISTS_IMPL
func (*LISTS_IMPL) AddContactsBulk ¶
func (me *LISTS_IMPL) AddContactsBulk( name string, fileUrl string, format string, countrycode *string, field1 *string, queryParameters map[string]interface{}) (interface{}, error)
*
- Upload a list of contacts to Burst SMS
- @param string name parameter: Required
- @param string fileUrl parameter: Required
- @param string format parameter: Required
- @param *string countrycode parameter: Optional
- @param *string field1 parameter: Optional
- @param queryParameters Additional optional query parameters are supported by this endpoint
- @return Returns the interface{} response from the API call
func (*LISTS_IMPL) AddFieldToList ¶
func (me *LISTS_IMPL) AddFieldToList( listId string, field1 string, format string, field2 *string, queryParameters map[string]interface{}) (interface{}, error)
*
- Update or add custom fields to a list
- @param string listId parameter: Required
- @param string field1 parameter: Required
- @param string format parameter: Required
- @param *string field2 parameter: Optional
- @param queryParameters Additional optional query parameters are supported by this endpoint
- @return Returns the interface{} response from the API call
func (*LISTS_IMPL) AddList ¶
func (me *LISTS_IMPL) AddList( name string, format string, field1 *string, queryParameters map[string]interface{}) (interface{}, error)
*
- Create a new list including the ability to add custom fields.
- @param string name parameter: Required
- @param string format parameter: Required
- @param *string field1 parameter: Optional
- @param queryParameters Additional optional query parameters are supported by this endpoint
- @return Returns the interface{} response from the API call
func (*LISTS_IMPL) AddToList ¶
func (me *LISTS_IMPL) AddToList( listId string, msisdn string, format string, firstName *string, lastName *string, countrycode *string) (interface{}, error)
*
- Add a member to a list.
- @param string listId parameter: Required
- @param string msisdn parameter: Required
- @param string format parameter: Required
- @param *string firstName parameter: Optional
- @param *string lastName parameter: Optional
- @param *string countrycode parameter: Optional
- @return Returns the interface{} response from the API call
func (*LISTS_IMPL) DeleteFromList ¶
func (me *LISTS_IMPL) DeleteFromList( listId int64, msisdn string, format string) (interface{}, error)
*
- Remove a member from one list or all lists.
- @param int64 listId parameter: Required
- @param string msisdn parameter: Required
- @param string format parameter: Required
- @return Returns the interface{} response from the API call
func (*LISTS_IMPL) EditListMember ¶
func (me *LISTS_IMPL) EditListMember( listId string, msisdn string, format string, firstName *string, lastName *string, field1 *string, queryParameters map[string]interface{}) (interface{}, error)
*
- Edit a member of a list.
- @param string listId parameter: Required
- @param string msisdn parameter: Required
- @param string format parameter: Required
- @param *string firstName parameter: Optional
- @param *string lastName parameter: Optional
- @param *string field1 parameter: Optional
- @param queryParameters Additional optional query parameters are supported by this endpoint
- @return Returns the interface{} response from the API call
func (*LISTS_IMPL) GetContact ¶
func (me *LISTS_IMPL) GetContact( listId string, msisdn string, format string) (interface{}, error)
*
- Get contact information from a list.
- @param string listId parameter: Required
- @param string msisdn parameter: Required
- @param string format parameter: Required
- @return Returns the interface{} response from the API call
func (*LISTS_IMPL) GetList ¶
func (me *LISTS_IMPL) GetList( listId string, format string, members *string, page *string, max *string) (interface{}, error)
*
- Get information about a list and its members.
- @param string listId parameter: Required
- @param string format parameter: Required
- @param *string members parameter: Optional
- @param *string page parameter: Optional
- @param *string max parameter: Optional
- @return Returns the interface{} response from the API call
func (*LISTS_IMPL) GetLists ¶
func (me *LISTS_IMPL) GetLists( format string, page *string, max *string) (interface{}, error)
*
- Get the metadata of all your lists.
- @param string format parameter: Required
- @param *string page parameter: Optional
- @param *string max parameter: Optional
- @return Returns the interface{} response from the API call
func (*LISTS_IMPL) OptoutListMember ¶
func (me *LISTS_IMPL) OptoutListMember( listId string, msisdn string, format string) (interface{}, error)
*
- Opt a user out of one list or all lists.
- @param string listId parameter: Required
- @param string msisdn parameter: Required
- @param string format parameter: Required
- @return Returns the interface{} response from the API call
func (*LISTS_IMPL) RemoveList ¶
func (me *LISTS_IMPL) RemoveList( listId string, format string) (interface{}, error)
*
- Delete a list and its members.
- @param string listId parameter: Required
- @param string format parameter: Required
- @return Returns the interface{} response from the API call