Class: Pinnacle::Messages::Client

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

Direct Known Subclasses

Wrapper::Messages::Client

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ void

Parameters:



9
10
11
 
# File 'lib/pinnacle/messages/client.rb', line 9

def initialize(client:)
  @client = client
end

Instance Method Details

#blast ⇒ Pinnacle::Blast::Client

Returns:

  • (Pinnacle::Blast::Client) 


131
132
133
 
# File 'lib/pinnacle/messages/client.rb', line 131

def blast
  @blast ||= Pinnacle::Messages::Blast::Client.new(client: @client)
end

#blasts ⇒ Pinnacle::Blasts::Client

Returns:

  • (Pinnacle::Blasts::Client) 


146
147
148
 
# File 'lib/pinnacle/messages/client.rb', line 146

def blasts
  @blasts ||= Pinnacle::Messages::Blasts::Client.new(client: @client)
end

#get(request_options: {}, **params) ⇒ Pinnacle::Types::Message

Retrieve a previously sent message.

Parameters:

  • request_options (Hash) (defaults to: {})
  • params (Hash)

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)

Options Hash (**params):

  • :id (String)

Returns:



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/pinnacle/messages/client.rb', line 25

def get(request_options: {}, **params)
  params = Pinnacle::Internal::Types::Utils.normalize_keys(params)
  request = Pinnacle::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "GET",
    path: "messages/#{params[:id]}",
    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::Message.load(response.body)
  else
    error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#list(request_options: {}, **params) ⇒ Pinnacle::Types::ListMessagesResponse

List all messages with optional filtering and pagination. Results are sorted by creation date, newest first.

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:



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/pinnacle/messages/client.rb', line 92

def list(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: "messages/list",
    body: Pinnacle::Messages::Types::ListMessagesParams.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::ListMessagesResponse.load(response.body)
  else
    error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#mms ⇒ Pinnacle::Mms::Client

Returns:

  • (Pinnacle::Mms::Client) 


121
122
123
 
# File 'lib/pinnacle/messages/client.rb', line 121

def mms
  @mms ||= Pinnacle::Messages::Mms::Client.new(client: @client)
end

#rcs ⇒ Pinnacle::Rcs::Client

Returns:



126
127
128
 
# File 'lib/pinnacle/messages/client.rb', line 126

def rcs
  @rcs ||= Pinnacle::Messages::Rcs::Client.new(client: @client)
end

#react(request_options: {}, **params) ⇒ Pinnacle::Types::ReactionResult

Add or remove an emoji reaction to a previously sent message.

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:



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/pinnacle/messages/client.rb', line 58

def react(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: "messages/react",
    body: Pinnacle::Messages::Types::ReactMessageParams.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::ReactionResult.load(response.body)
  else
    error_class = Pinnacle::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#schedule ⇒ Pinnacle::Schedule::Client

Returns:

  • (Pinnacle::Schedule::Client) 


136
137
138
 
# File 'lib/pinnacle/messages/client.rb', line 136

def schedule
  @schedule ||= Pinnacle::Messages::Schedule::Client.new(client: @client)
end

#schedules ⇒ Pinnacle::Schedules::Client

Returns:

  • (Pinnacle::Schedules::Client) 


141
142
143
 
# File 'lib/pinnacle/messages/client.rb', line 141

def schedules
  @schedules ||= Pinnacle::Messages::Schedules::Client.new(client: @client)
end

#simulate ⇒ Pinnacle::Simulate::Client

Returns:

  • (Pinnacle::Simulate::Client) 


151
152
153
 
# File 'lib/pinnacle/messages/client.rb', line 151

def simulate
  @simulate ||= Pinnacle::Messages::Simulate::Client.new(client: @client)
end

#sms ⇒ Pinnacle::Sms::Client

Returns:

  • (Pinnacle::Sms::Client) 


116
117
118
 
# File 'lib/pinnacle/messages/client.rb', line 116

def sms
  @sms ||= Pinnacle::Messages::Sms::Client.new(client: @client)
end