Class: BrevoRuby::NotesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ NotesApi

Returns a new instance of NotesApi.



19
20
21
 
# File 'lib/brevo-ruby/api/notes_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/notes_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#crm_notes_get(opts = {}) ⇒ NoteList

Get all notes

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :entity (String) —

    Filter by note entity type

  • :entity_ids (String) —

    Filter by note entity IDs

  • :date_from (Integer) —

    dateFrom to date range filter type (timestamp in milliseconds)

  • :date_to (Integer) —

    dateTo to date range filter type (timestamp in milliseconds)

  • :offset (Integer) —

    Index of the first document of the page

  • :limit (Integer) —

    Number of documents per page (default to 50)

  • :sort (String) —

    Sort the results in the ascending/descending order. Default order is descending by creation if `sort` is not passed

Returns:



42
43
44
45
 
# File 'lib/brevo-ruby/api/notes_api.rb', line 42

def crm_notes_get(opts = {})
  data, _status_code, _headers = crm_notes_get_with_http_info(opts)
  data
end

#crm_notes_get_with_http_info(opts = {}) ⇒ Array<(NoteList, Fixnum, Hash)>

Get all notes

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :entity (String) —

    Filter by note entity type

  • :entity_ids (String) —

    Filter by note entity IDs

  • :date_from (Integer) —

    dateFrom to date range filter type (timestamp in milliseconds)

  • :date_to (Integer) —

    dateTo to date range filter type (timestamp in milliseconds)

  • :offset (Integer) —

    Index of the first document of the page

  • :limit (Integer) —

    Number of documents per page

  • :sort (String) —

    Sort the results in the ascending/descending order. Default order is descending by creation if &#x60;sort&#x60; is not passed

Returns:

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

    NoteList data, response status code and response headers



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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/brevo-ruby/api/notes_api.rb', line 57

def crm_notes_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NotesApi.crm_notes_get ...'
  end
  if @api_client.config.client_side_validation && opts[:'entity'] && !['companies', 'deals', 'contacts'].include?(opts[:'entity'])
    fail ArgumentError, 'invalid value for "entity", must be one of companies, deals, contacts'
  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 = '/crm/notes'

  # query parameters
  query_params = {}
  query_params[:'entity'] = opts[:'entity'] if !opts[:'entity'].nil?
  query_params[:'entityIds'] = opts[:'entity_ids'] if !opts[:'entity_ids'].nil?
  query_params[:'dateFrom'] = opts[:'date_from'] if !opts[:'date_from'].nil?
  query_params[:'dateTo'] = opts[:'date_to'] if !opts[:'date_to'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].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 => 'NoteList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NotesApi#crm_notes_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#crm_notes_id_delete(id, opts = {}) ⇒ nil

Delete a note

Parameters:

  • id —

    Note ID to delete

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

    the optional parameters

Returns:

  • (nil) 


109
110
111
112
 
# File 'lib/brevo-ruby/api/notes_api.rb', line 109

def crm_notes_id_delete(id, opts = {})
  crm_notes_id_delete_with_http_info(id, opts)
  nil
end

#crm_notes_id_delete_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a note

Parameters:

  • id —

    Note ID to delete

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/brevo-ruby/api/notes_api.rb', line 118

def crm_notes_id_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NotesApi.crm_notes_id_delete ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling NotesApi.crm_notes_id_delete"
  end
  # resource path
  local_var_path = '/crm/notes/{id}'.sub('{' + 'id' + '}', id.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(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NotesApi#crm_notes_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#crm_notes_id_get(id, opts = {}) ⇒ Note

Get a note

Parameters:

  • id —

    Note ID to get

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

    the optional parameters

Returns:



160
161
162
163
 
# File 'lib/brevo-ruby/api/notes_api.rb', line 160

def crm_notes_id_get(id, opts = {})
  data, _status_code, _headers = crm_notes_id_get_with_http_info(id, opts)
  data
end

#crm_notes_id_get_with_http_info(id, opts = {}) ⇒ Array<(Note, Fixnum, Hash)>

Get a note

Parameters:

  • id —

    Note ID to get

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

    the optional parameters

Returns:

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

    Note data, response status code and response headers



169
170
171
172
173
174
175
176
177
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
 
# File 'lib/brevo-ruby/api/notes_api.rb', line 169

def crm_notes_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NotesApi.crm_notes_id_get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling NotesApi.crm_notes_id_get"
  end
  # resource path
  local_var_path = '/crm/notes/{id}'.sub('{' + 'id' + '}', id.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 => 'Note')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NotesApi#crm_notes_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#crm_notes_id_patch(id, body, opts = {}) ⇒ nil

Update a note

Parameters:

  • id —

    Note ID to update

  • body —

    Note data to update a note

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

    the optional parameters

Returns:

  • (nil) 


213
214
215
216
 
# File 'lib/brevo-ruby/api/notes_api.rb', line 213

def crm_notes_id_patch(id, body, opts = {})
  crm_notes_id_patch_with_http_info(id, body, opts)
  nil
end

#crm_notes_id_patch_with_http_info(id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update a note

Parameters:

  • id —

    Note ID to update

  • body —

    Note data to update a note

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/brevo-ruby/api/notes_api.rb', line 223

def crm_notes_id_patch_with_http_info(id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NotesApi.crm_notes_id_patch ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling NotesApi.crm_notes_id_patch"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling NotesApi.crm_notes_id_patch"
  end
  # resource path
  local_var_path = '/crm/notes/{id}'.sub('{' + 'id' + '}', id.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 = @api_client.object_to_http_body(body)
  auth_names = ['api-key', 'partner-key']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NotesApi#crm_notes_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#crm_notes_post(body, opts = {}) ⇒ NoteId

Create a note

Parameters:

  • body —

    Note data to create a note.

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

    the optional parameters

Returns:



269
270
271
272
 
# File 'lib/brevo-ruby/api/notes_api.rb', line 269

def crm_notes_post(body, opts = {})
  data, _status_code, _headers = crm_notes_post_with_http_info(body, opts)
  data
end

#crm_notes_post_with_http_info(body, opts = {}) ⇒ Array<(NoteId, Fixnum, Hash)>

Create a note

Parameters:

  • body —

    Note data to create a note.

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

    the optional parameters

Returns:

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

    NoteId data, response status code and response headers



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/brevo-ruby/api/notes_api.rb', line 278

def crm_notes_post_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: NotesApi.crm_notes_post ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling NotesApi.crm_notes_post"
  end
  # resource path
  local_var_path = '/crm/notes'

  # 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 = @api_client.object_to_http_body(body)
  auth_names = ['api-key', 'partner-key']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'NoteId')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NotesApi#crm_notes_post\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/notes_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