Class: Pinnacle::Network::SubscriberMatch::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/pinnacle/network/subscriber_match/client.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ void

Parameters:



10
11
12
 
# File 'lib/pinnacle/network/subscriber_match/client.rb', line 10

def initialize(client:)
  @client = client
end

Instance Method Details

#check(request_options: {}, **params) ⇒ Pinnacle::Types::SubscriberMatchResponse

Compare user-provided identity details against the carrier’s subscriber record. Results return match strength per attribute, so you can use partial signals without receiving carrier PII.

<Note>

Limited availability. Contact [founders@pinnacle.sh](mailto:founders@pinnacle.sh) to request access.

</Note>

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:



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/pinnacle/network/subscriber_match/client.rb', line 30

def check(request_options: {}, **params)
  params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
  request = Pinnacle::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "POST",
    path: "network/subscriber-match",
    body: Pinnacle::Network::SubscriberMatch::Types::SubscriberMatchRequest.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::SubscriberMatchResponse.load(response.body)
  else
    error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end