Class: Mailhub::Message::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/Mailhub/message/client.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ void

Parameters:



9
10
11
 
# File 'lib/Mailhub/message/client.rb', line 9

def initialize(client:)
  @client = client
end

Instance Method Details

#cancel_message(request_options: {}, **params) ⇒ Mailhub::Types::MessageModel

Examples:

client.message.cancel_message(guid: "guid")

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):

  • :guid (String)

Returns:



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/Mailhub/message/client.rb', line 178

def cancel_message(request_options: {}, **params)
  params = Mailhub::Internal::Types::Utils.normalize_keys(params)
  request = Mailhub::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "PUT",
    path: "v1/messages/#{URI.encode_uri_component(params[:guid].to_s)}/cancel",
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Mailhub::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Mailhub::Types::MessageModel.load(response.body)
  else
    error_class = Mailhub::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#get_message(request_options: {}, **params) ⇒ Mailhub::Types::MessageModel

Examples:

client.message.get_message(guid: "guid")

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):

  • :guid (String)

Returns:



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/Mailhub/message/client.rb', line 75

def get_message(request_options: {}, **params)
  params = Mailhub::Internal::Types::Utils.normalize_keys(params)
  request = Mailhub::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "GET",
    path: "v1/messages/#{URI.encode_uri_component(params[:guid].to_s)}",
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Mailhub::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Mailhub::Types::MessageModel.load(response.body)
  else
    error_class = Mailhub::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#get_message_events(request_options: {}, **params) ⇒ Array[Mailhub::Types::MessageEventModel]

Examples:

client.message.get_message_events(guid: "guid")

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):

  • :guid (String)

Returns:

Raises:

  • (error_class) 


110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/Mailhub/message/client.rb', line 110

def get_message_events(request_options: {}, **params)
  params = Mailhub::Internal::Types::Utils.normalize_keys(params)
  request = Mailhub::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "GET",
    path: "v1/messages/#{URI.encode_uri_component(params[:guid].to_s)}/events",
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Mailhub::Errors::TimeoutError
  end
  code = response.code.to_i
  return if code.between?(200, 299)

  error_class = Mailhub::Errors::ResponseError.subclass_for_code(code)
  raise error_class.new(response.body, code: code)
end

#get_messages(request_options: {}, **params) ⇒ Mailhub::Types::MessageModelCursorPagedResult

Examples:

client.message.get_messages

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):

  • :search (String, nil)
  • :status (String, nil)
  • :sort_by (String, nil)
  • :sort_direction (String, nil)
  • :page_size (Integer, nil)
  • :cursor (String, nil)

Returns:



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/Mailhub/message/client.rb', line 31

def get_messages(request_options: {}, **params)
  params = Mailhub::Internal::Types::Utils.normalize_keys(params)
  query_params = {}
  query_params["search"] = params[:search] if params.key?(:search)
  query_params["status"] = params[:status] if params.key?(:status)
  query_params["sortBy"] = params[:sort_by] if params.key?(:sort_by)
  query_params["sortDirection"] = params[:sort_direction] if params.key?(:sort_direction)
  query_params["pageSize"] = params[:page_size] if params.key?(:page_size)
  query_params["cursor"] = params[:cursor] if params.key?(:cursor)

  request = Mailhub::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "GET",
    path: "v1/messages",
    query: query_params,
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Mailhub::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Mailhub::Types::MessageModelCursorPagedResult.load(response.body)
  else
    error_class = Mailhub::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#send_message(request_options: {}, **params) ⇒ Mailhub::Types::MessageModel

Examples:

client.message.send_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:



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/Mailhub/message/client.rb', line 142

def send_message(request_options: {}, **params)
  params = Mailhub::Internal::Types::Utils.normalize_keys(params)
  request = Mailhub::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "POST",
    path: "v1/messages/send",
    body: Mailhub::Message::Types::SendMessageRequest.new(params).to_h,
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Mailhub::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Mailhub::Types::MessageModel.load(response.body)
  else
    error_class = Mailhub::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end