Class: BrevoRuby::InboundParsingApi

Inherits:
Object
  • Object
show all
Defined in:
lib/brevo-ruby/api/inbound_parsing_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ InboundParsingApi

Returns a new instance of InboundParsingApi.



19
20
21
 
# File 'lib/brevo-ruby/api/inbound_parsing_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/brevo-ruby/api/inbound_parsing_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_inbound_email_attachment(download_token, opts = {}) ⇒ File

Retrieve inbound attachment with download token. This endpoint will retrieve inbound attachment with download token.

Parameters:

  • download_token —

    Token to fetch a particular attachment

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (File) 


37
38
39
40
 
# File 'lib/brevo-ruby/api/inbound_parsing_api.rb', line 37

def get_inbound_email_attachment(download_token, opts = {})
  data, _status_code, _headers = get_inbound_email_attachment_with_http_info(download_token, opts)
  data
end

#get_inbound_email_attachment_with_http_info(download_token, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Retrieve inbound attachment with download token. This endpoint will retrieve inbound attachment with download token.

Parameters:

  • download_token —

    Token to fetch a particular attachment

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(File, Fixnum, Hash)>) —

    File data, response status code and response headers



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/brevo-ruby/api/inbound_parsing_api.rb', line 47

def get_inbound_email_attachment_with_http_info(download_token, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InboundParsingApi.get_inbound_email_attachment ...'
  end
  # verify the required parameter 'download_token' is set
  if @api_client.config.client_side_validation && download_token.nil?
    fail ArgumentError, "Missing the required parameter 'download_token' when calling InboundParsingApi.get_inbound_email_attachment"
  end
  # resource path
  local_var_path = '/inbound/attachments/{downloadToken}'.sub('{' + 'downloadToken' + '}', download_token.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api-key', 'partner-key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InboundParsingApi#get_inbound_email_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_inbound_email_events(opts = {}) ⇒ GetInboundEmailEvents

Get the list of all the events for the received emails. This endpoint will show the list of all the events for the received emails.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :sender (String) —

    Email address of the sender.

  • :start_date (String) —

    Mandatory if endDate is used. Starting date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ) from which you want to fetch the list. Maximum time period that can be selected is one month.

  • :end_date (String) —

    Mandatory if startDate is used. Ending date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ) till which you want to fetch the list. Maximum time period that can be selected is one month.

  • :limit (Integer) —

    Number of documents returned per page (default to 100)

  • :offset (Integer) —

    Index of the first document on the page (default to 0)

  • :sort (String) —

    Sort the results in the ascending/descending order of record creation (default to desc)

Returns:



96
97
98
99
 
# File 'lib/brevo-ruby/api/inbound_parsing_api.rb', line 96

def get_inbound_email_events(opts = {})
  data, _status_code, _headers = get_inbound_email_events_with_http_info(opts)
  data
end

#get_inbound_email_events_by_uuid(uuid, opts = {}) ⇒ GetInboundEmailEventsByUuid

Fetch all events history for one particular received email. This endpoint will show the list of all events history for one particular received email.

Parameters:

  • uuid —

    UUID to fetch events specific to recieved email

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



168
169
170
171
 
# File 'lib/brevo-ruby/api/inbound_parsing_api.rb', line 168

def get_inbound_email_events_by_uuid(uuid, opts = {})
  data, _status_code, _headers = get_inbound_email_events_by_uuid_with_http_info(uuid, opts)
  data
end

#get_inbound_email_events_by_uuid_with_http_info(uuid, opts = {}) ⇒ Array<(GetInboundEmailEventsByUuid, Fixnum, Hash)>

Fetch all events history for one particular received email. This endpoint will show the list of all events history for one particular received email.

Parameters:

  • uuid —

    UUID to fetch events specific to recieved email

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/brevo-ruby/api/inbound_parsing_api.rb', line 178

def get_inbound_email_events_by_uuid_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InboundParsingApi.get_inbound_email_events_by_uuid ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling InboundParsingApi.get_inbound_email_events_by_uuid"
  end
  # resource path
  local_var_path = '/inbound/events/{uuid}'.sub('{' + 'uuid' + '}', uuid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api-key', 'partner-key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'GetInboundEmailEventsByUuid')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InboundParsingApi#get_inbound_email_events_by_uuid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_inbound_email_events_with_http_info(opts = {}) ⇒ Array<(GetInboundEmailEvents, Fixnum, Hash)>

Get the list of all the events for the received emails. This endpoint will show the list of all the events for the received emails.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :sender (String) —

    Email address of the sender.

  • :start_date (String) —

    Mandatory if endDate is used. Starting date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ) from which you want to fetch the list. Maximum time period that can be selected is one month.

  • :end_date (String) —

    Mandatory if startDate is used. Ending date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ) till which you want to fetch the list. Maximum time period that can be selected is one month.

  • :limit (Integer) —

    Number of documents returned per page

  • :offset (Integer) —

    Index of the first document on the page

  • :sort (String) —

    Sort the results in the ascending/descending order of record creation

Returns:

  • (Array<(GetInboundEmailEvents, Fixnum, Hash)>) —

    GetInboundEmailEvents data, response status code and response headers



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/brevo-ruby/api/inbound_parsing_api.rb', line 111

def get_inbound_email_events_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InboundParsingApi.get_inbound_email_events ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling InboundParsingApi.get_inbound_email_events, must be smaller than or equal to 500.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 0
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling InboundParsingApi.get_inbound_email_events, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
    fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
  end
  # resource path
  local_var_path = '/inbound/events'

  # query parameters
  query_params = {}
  query_params[:'sender'] = opts[:'sender'] if !opts[:'sender'].nil?
  query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
  query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api-key', 'partner-key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'GetInboundEmailEvents')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InboundParsingApi#get_inbound_email_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#setUserAgent(user_agent) ⇒ Object

Set custom user_agent if explicitly passed in api default will still remain Swagger-Codegen/#VERSION/ruby



25
26
27
28
29
30
 
# File 'lib/brevo-ruby/api/inbound_parsing_api.rb', line 25

def setUserAgent(user_agent)
  @user_agent = user_agent
  if user_agent.is_a?(String) && user_agent.downcase.start_with?('brevo_')
    @api_client.default_headers['User-Agent'] = @user_agent
  end
end