Class: Pinnacle::Audiences::Contacts::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/pinnacle/audiences/contacts/client.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ void

Parameters:



10
11
12
 
# File 'lib/pinnacle/audiences/contacts/client.rb', line 10

def initialize(client:)
  @client = client
end

Instance Method Details

#add(request_options: {}, **params) ⇒ Pinnacle::Types::AudienceCountOnly

Add contacts to an existing audience. This operation is additive and idempotent.

  • Phone numbers that don’t exist will be auto-created as contacts

  • Duplicate adds are ignored

  • Contacts already in the audience are ignored

Parameters:

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/pinnacle/audiences/contacts/client.rb', line 66

def add(request_options: {}, **params)
  params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
  request = Pinnacle::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "PATCH",
    path: "audiences/contacts",
    body: Pinnacle::Audiences::Contacts::Types::AddContactsParams.new(params).to_h,
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Pinnacle::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Pinnacle::Types::AudienceCountOnly.load(response.body)
  else
    error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#remove(request_options: {}, **params) ⇒ Pinnacle::Types::AudienceCountOnly

Remove contacts from an existing audience. This operation is idempotent.

  • Only removes contacts that exist in the audience

  • Contacts not in the audience are ignored

Parameters:

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Returns:



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/pinnacle/audiences/contacts/client.rb', line 28

def remove(request_options: {}, **params)
  params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
  request = Pinnacle::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "DELETE",
    path: "audiences/contacts",
    body: Pinnacle::Audiences::Contacts::Types::RemoveContactsParams.new(params).to_h,
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Pinnacle::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Pinnacle::Types::AudienceCountOnly.load(response.body)
  else
    error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end