io.alwaysonmobile.hullo.api.client

Class MembersApi

java.lang.Object

io.alwaysonmobile.hullo.api.client.MembersApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-05-07T11:42:47.246+01:00[Europe/London]")
public class MembersApi
extends Object

Constructor Summary

Constructors

Constructor and Description
MembersApi()
MembersApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
Member	getMember(String phoneNumber) Gets the details for a member Retrieves the details hullo stores about a specific member.
Member	getMember(String phoneNumber, Map<String,String> additionalHeaders) Gets the details for a member Retrieves the details hullo stores about a specific member.
void	optOutMember(String phoneNumber) Opts the member out from the hullo member store Opts out the member from the hullo member store which results in their record being deleted.
void	optOutMember(String phoneNumber, Map<String,String> additionalHeaders) Opts the member out from the hullo member store Opts out the member from the hullo member store which results in their record being deleted.
void	setApiClient(ApiClient apiClient)
Member	upsertMember(Member member) Adds or updates a member Add or update the information hullo stores for a specific member.
Member	upsertMember(Member member, Map<String,String> additionalHeaders) Adds or updates a member Add or update the information hullo stores for a specific member.

Methods inherited from class java.lang.Object

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

Constructor Detail

MembersApi

public MembersApi()

MembersApi

public MembersApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getMember

public Member getMember(String phoneNumber)
                 throws ApiException

Gets the details for a member Retrieves the details hullo stores about a specific member. The record will contain any attribute data added using either the hullo API or the hullo application along with the members phone number and full name.

Parameters:

phoneNumber - The phone number of the subscriber (required)

Returns:

Member

Throws:

ApiException - if fails to make API call

getMember

public Member getMember(String phoneNumber,
                        Map<String,String> additionalHeaders)
                 throws ApiException

Gets the details for a member Retrieves the details hullo stores about a specific member. The record will contain any attribute data added using either the hullo API or the hullo application along with the members phone number and full name.

Parameters:

phoneNumber - The phone number of the subscriber (required)

additionalHeaders - additionalHeaders for this call

Returns:

Member

Throws:

ApiException - if fails to make API call

optOutMember

public void optOutMember(String phoneNumber)
                  throws ApiException

Opts the member out from the hullo member store Opts out the member from the hullo member store which results in their record being deleted. Any pending messages will also be deleted for the member and the member will no longer be able to participate in \\ any campaigns.

Parameters:

phoneNumber - The phone number of the subscriber (required)

Throws:

ApiException - if fails to make API call

optOutMember

public void optOutMember(String phoneNumber,
                         Map<String,String> additionalHeaders)
                  throws ApiException

Opts the member out from the hullo member store Opts out the member from the hullo member store which results in their record being deleted. Any pending messages will also be deleted for the member and the member will no longer be able to participate in \\ any campaigns.

Parameters:

phoneNumber - The phone number of the subscriber (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

upsertMember

public Member upsertMember(Member member)
                    throws ApiException

Adds or updates a member Add or update the information hullo stores for a specific member. If the member doesn't already exist then they will be added to the members store and an opt-in message will be sent to the number specified in order to get confirmation that the number exists and wishes to receive messages. If the member responds with a confirmation message (\"yes\") then their member record will be updated to opted-in and they will then be able to receive messages sent to them from any hullo campaign. If the member already exists then their record will be updated to reflect any new / updated attribute data included in the call. If an attribute is specified but no value is given or the value is null then that attribute will be deleted from the members record.

Parameters:

member - A JSON object containing member information (required)

Returns:

Member

Throws:

ApiException - if fails to make API call

upsertMember

public Member upsertMember(Member member,
                           Map<String,String> additionalHeaders)
                    throws ApiException

Adds or updates a member Add or update the information hullo stores for a specific member. If the member doesn't already exist then they will be added to the members store and an opt-in message will be sent to the number specified in order to get confirmation that the number exists and wishes to receive messages. If the member responds with a confirmation message (\"yes\") then their member record will be updated to opted-in and they will then be able to receive messages sent to them from any hullo campaign. If the member already exists then their record will be updated to reflect any new / updated attribute data included in the call. If an attribute is specified but no value is given or the value is null then that attribute will be deleted from the members record.

Parameters:

member - A JSON object containing member information (required)

additionalHeaders - additionalHeaders for this call

Returns:

Member

Throws:

ApiException - if fails to make API call