Class: SparteraApiSdk::PostsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/spartera_api_sdk/api/posts_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PostsApi

Returns a new instance of PostsApi.



19
20
21
 
# File 'lib/spartera_api_sdk/api/posts_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/spartera_api_sdk/api/posts_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_posts(company_id, posts_input, opts = {}) ⇒ CreatePosts200Response

POST /companies/company_id/posts

Parameters:

  • company_id (String) —

    Unique identifier for the Company

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number for pagination (default to 1)

  • :limit (Integer) —

    Number of items per page (default to 20)

  • :sort_by (String) —

    Field to sort by

  • :sort_order (String) —

    Sort order (ascending or descending) (default to ‘desc’)

  • :search (String) —

    Search term to filter results

Returns:



32
33
34
35
 
# File 'lib/spartera_api_sdk/api/posts_api.rb', line 32

def create_posts(company_id, posts_input, opts = {})
  data, _status_code, _headers = create_posts_with_http_info(company_id, posts_input, opts)
  data
end

#create_posts2(company_id, post_id, integration_id, posts_input, opts = {}) ⇒ CreatePosts200Response

Publish a post to an external platform via an integration. Args: post_id: ID of the post to publish integration_id: ID of the integration to use (from postgen_integrations) Returns: Publication record with external_url and external_post_id

Parameters:

  • company_id (String) —

    Unique identifier for the Company

  • post_id (String) —

    Unique identifier for the Post

  • integration_id (String) —

    Unique identifier for the Integration

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

    the optional parameters

Returns:



153
154
155
156
 
# File 'lib/spartera_api_sdk/api/posts_api.rb', line 153

def create_posts2(company_id, post_id, integration_id, posts_input, opts = {})
  data, _status_code, _headers = create_posts2_with_http_info(company_id, post_id, integration_id, posts_input, opts)
  data
end

#create_posts2_with_http_info(company_id, post_id, integration_id, posts_input, opts = {}) ⇒ Array<(CreatePosts200Response, Integer, Hash)>

Publish a post to an external platform via an integration. Args: post_id: ID of the post to publish integration_id: ID of the integration to use (from postgen_integrations) Returns: Publication record with external_url and external_post_id

Parameters:

  • company_id (String) —

    Unique identifier for the Company

  • post_id (String) —

    Unique identifier for the Post

  • integration_id (String) —

    Unique identifier for the Integration

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

    the optional parameters

Returns:

  • (Array<(CreatePosts200Response, Integer, Hash)>) —

    CreatePosts200Response data, response status code and response headers



165
166
167
168
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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
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
265
266
267
 
# File 'lib/spartera_api_sdk/api/posts_api.rb', line 165

def create_posts2_with_http_info(company_id, post_id, integration_id, posts_input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PostsApi.create_posts2 ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling PostsApi.create_posts2"
  end
  if @api_client.config.client_side_validation && company_id.to_s.length > 255
    fail ArgumentError, 'invalid value for "company_id" when calling PostsApi.create_posts2, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && company_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "company_id" when calling PostsApi.create_posts2, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if @api_client.config.client_side_validation && company_id !~ pattern
    fail ArgumentError, "invalid value for 'company_id' when calling PostsApi.create_posts2, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'post_id' is set
  if @api_client.config.client_side_validation && post_id.nil?
    fail ArgumentError, "Missing the required parameter 'post_id' when calling PostsApi.create_posts2"
  end
  if @api_client.config.client_side_validation && post_id.to_s.length > 255
    fail ArgumentError, 'invalid value for "post_id" when calling PostsApi.create_posts2, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && post_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "post_id" when calling PostsApi.create_posts2, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if @api_client.config.client_side_validation && post_id !~ pattern
    fail ArgumentError, "invalid value for 'post_id' when calling PostsApi.create_posts2, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'integration_id' is set
  if @api_client.config.client_side_validation && integration_id.nil?
    fail ArgumentError, "Missing the required parameter 'integration_id' when calling PostsApi.create_posts2"
  end
  if @api_client.config.client_side_validation && integration_id.to_s.length > 255
    fail ArgumentError, 'invalid value for "integration_id" when calling PostsApi.create_posts2, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && integration_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "integration_id" when calling PostsApi.create_posts2, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if @api_client.config.client_side_validation && integration_id !~ pattern
    fail ArgumentError, "invalid value for 'integration_id' when calling PostsApi.create_posts2, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'posts_input' is set
  if @api_client.config.client_side_validation && posts_input.nil?
    fail ArgumentError, "Missing the required parameter 'posts_input' when calling PostsApi.create_posts2"
  end
  # resource path
  local_var_path = '/companies/{company_id}/posts/{post_id}/publish/{integration_id}'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'post_id' + '}', CGI.escape(post_id.to_s)).sub('{' + 'integration_id' + '}', CGI.escape(integration_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(posts_input)

  # return_type
  return_type = opts[:debug_return_type] || 'CreatePosts200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"PostsApi.create_posts2",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PostsApi#create_posts2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_posts_publish(company_id, post_id, posts_input, opts = {}) ⇒ CreatePosts200Response

Publish a post (make it publicly visible).

Parameters:

  • company_id (String) —

    Unique identifier for the Company

  • post_id (String) —

    Unique identifier for the Post

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

    the optional parameters

Returns:



275
276
277
278
 
# File 'lib/spartera_api_sdk/api/posts_api.rb', line 275

def create_posts_publish(company_id, post_id, posts_input, opts = {})
  data, _status_code, _headers = create_posts_publish_with_http_info(company_id, post_id, posts_input, opts)
  data
end

#create_posts_publish_with_http_info(company_id, post_id, posts_input, opts = {}) ⇒ Array<(CreatePosts200Response, Integer, Hash)>

Publish a post (make it publicly visible).

Parameters:

  • company_id (String) —

    Unique identifier for the Company

  • post_id (String) —

    Unique identifier for the Post

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

    the optional parameters

Returns:

  • (Array<(CreatePosts200Response, Integer, Hash)>) —

    CreatePosts200Response data, response status code and response headers



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
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/spartera_api_sdk/api/posts_api.rb', line 286

def create_posts_publish_with_http_info(company_id, post_id, posts_input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PostsApi.create_posts_publish ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling PostsApi.create_posts_publish"
  end
  if @api_client.config.client_side_validation && company_id.to_s.length > 255
    fail ArgumentError, 'invalid value for "company_id" when calling PostsApi.create_posts_publish, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && company_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "company_id" when calling PostsApi.create_posts_publish, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if @api_client.config.client_side_validation && company_id !~ pattern
    fail ArgumentError, "invalid value for 'company_id' when calling PostsApi.create_posts_publish, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'post_id' is set
  if @api_client.config.client_side_validation && post_id.nil?
    fail ArgumentError, "Missing the required parameter 'post_id' when calling PostsApi.create_posts_publish"
  end
  if @api_client.config.client_side_validation && post_id.to_s.length > 255
    fail ArgumentError, 'invalid value for "post_id" when calling PostsApi.create_posts_publish, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && post_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "post_id" when calling PostsApi.create_posts_publish, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if @api_client.config.client_side_validation && post_id !~ pattern
    fail ArgumentError, "invalid value for 'post_id' when calling PostsApi.create_posts_publish, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'posts_input' is set
  if @api_client.config.client_side_validation && posts_input.nil?
    fail ArgumentError, "Missing the required parameter 'posts_input' when calling PostsApi.create_posts_publish"
  end
  # resource path
  local_var_path = '/companies/{company_id}/posts/{post_id}/publish'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'post_id' + '}', CGI.escape(post_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(posts_input)

  # return_type
  return_type = opts[:debug_return_type] || 'CreatePosts200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"PostsApi.create_posts_publish",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PostsApi#create_posts_publish\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_posts_unpublish(company_id, post_id, posts_input, opts = {}) ⇒ CreatePosts200Response

Unpublish a post (make it private/draft again).

Parameters:

  • company_id (String) —

    Unique identifier for the Company

  • post_id (String) —

    Unique identifier for the Post

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

    the optional parameters

Returns:



379
380
381
382
 
# File 'lib/spartera_api_sdk/api/posts_api.rb', line 379

def create_posts_unpublish(company_id, post_id, posts_input, opts = {})
  data, _status_code, _headers = create_posts_unpublish_with_http_info(company_id, post_id, posts_input, opts)
  data
end

#create_posts_unpublish_with_http_info(company_id, post_id, posts_input, opts = {}) ⇒ Array<(CreatePosts200Response, Integer, Hash)>

Unpublish a post (make it private/draft again).

Parameters:

  • company_id (String) —

    Unique identifier for the Company

  • post_id (String) —

    Unique identifier for the Post

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

    the optional parameters

Returns:

  • (Array<(CreatePosts200Response, Integer, Hash)>) —

    CreatePosts200Response data, response status code and response headers



390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
 
# File 'lib/spartera_api_sdk/api/posts_api.rb', line 390

def create_posts_unpublish_with_http_info(company_id, post_id, posts_input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PostsApi.create_posts_unpublish ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling PostsApi.create_posts_unpublish"
  end
  if @api_client.config.client_side_validation && company_id.to_s.length > 255
    fail ArgumentError, 'invalid value for "company_id" when calling PostsApi.create_posts_unpublish, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && company_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "company_id" when calling PostsApi.create_posts_unpublish, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if @api_client.config.client_side_validation && company_id !~ pattern
    fail ArgumentError, "invalid value for 'company_id' when calling PostsApi.create_posts_unpublish, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'post_id' is set
  if @api_client.config.client_side_validation && post_id.nil?
    fail ArgumentError, "Missing the required parameter 'post_id' when calling PostsApi.create_posts_unpublish"
  end
  if @api_client.config.client_side_validation && post_id.to_s.length > 255
    fail ArgumentError, 'invalid value for "post_id" when calling PostsApi.create_posts_unpublish, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && post_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "post_id" when calling PostsApi.create_posts_unpublish, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if @api_client.config.client_side_validation && post_id !~ pattern
    fail ArgumentError, "invalid value for 'post_id' when calling PostsApi.create_posts_unpublish, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'posts_input' is set
  if @api_client.config.client_side_validation && posts_input.nil?
    fail ArgumentError, "Missing the required parameter 'posts_input' when calling PostsApi.create_posts_unpublish"
  end
  # resource path
  local_var_path = '/companies/{company_id}/posts/{post_id}/unpublish'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'post_id' + '}', CGI.escape(post_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(posts_input)

  # return_type
  return_type = opts[:debug_return_type] || 'CreatePosts200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"PostsApi.create_posts_unpublish",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PostsApi#create_posts_unpublish\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_posts_view(company_id, post_id, posts_input, opts = {}) ⇒ CreatePosts200Response

Increment view count for a post. Public endpoint (no authentication required).

Parameters:

  • company_id (String) —

    Unique identifier for the Company

  • post_id (String) —

    Unique identifier for the Post

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

    the optional parameters

Returns:



483
484
485
486
 
# File 'lib/spartera_api_sdk/api/posts_api.rb', line 483

def create_posts_view(company_id, post_id, posts_input, opts = {})
  data, _status_code, _headers = create_posts_view_with_http_info(company_id, post_id, posts_input, opts)
  data
end

#create_posts_view_with_http_info(company_id, post_id, posts_input, opts = {}) ⇒ Array<(CreatePosts200Response, Integer, Hash)>

Increment view count for a post. Public endpoint (no authentication required).

Parameters:

  • company_id (String) —

    Unique identifier for the Company

  • post_id (String) —

    Unique identifier for the Post

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

    the optional parameters

Returns:

  • (Array<(CreatePosts200Response, Integer, Hash)>) —

    CreatePosts200Response data, response status code and response headers



494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
 
# File 'lib/spartera_api_sdk/api/posts_api.rb', line 494

def create_posts_view_with_http_info(company_id, post_id, posts_input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PostsApi.create_posts_view ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling PostsApi.create_posts_view"
  end
  if @api_client.config.client_side_validation && company_id.to_s.length > 255
    fail ArgumentError, 'invalid value for "company_id" when calling PostsApi.create_posts_view, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && company_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "company_id" when calling PostsApi.create_posts_view, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if @api_client.config.client_side_validation && company_id !~ pattern
    fail ArgumentError, "invalid value for 'company_id' when calling PostsApi.create_posts_view, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'post_id' is set
  if @api_client.config.client_side_validation && post_id.nil?
    fail ArgumentError, "Missing the required parameter 'post_id' when calling PostsApi.create_posts_view"
  end
  if @api_client.config.client_side_validation && post_id.to_s.length > 255
    fail ArgumentError, 'invalid value for "post_id" when calling PostsApi.create_posts_view, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && post_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "post_id" when calling PostsApi.create_posts_view, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if @api_client.config.client_side_validation && post_id !~ pattern
    fail ArgumentError, "invalid value for 'post_id' when calling PostsApi.create_posts_view, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'posts_input' is set
  if @api_client.config.client_side_validation && posts_input.nil?
    fail ArgumentError, "Missing the required parameter 'posts_input' when calling PostsApi.create_posts_view"
  end
  # resource path
  local_var_path = '/companies/{company_id}/posts/{post_id}/view'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'post_id' + '}', CGI.escape(post_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(posts_input)

  # return_type
  return_type = opts[:debug_return_type] || 'CreatePosts200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"PostsApi.create_posts_view",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PostsApi#create_posts_view\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_posts_with_http_info(company_id, posts_input, opts = {}) ⇒ Array<(CreatePosts200Response, Integer, Hash)>

POST /companies/company_id/posts

Parameters:

  • company_id (String) —

    Unique identifier for the Company

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number for pagination (default to 1)

  • :limit (Integer) —

    Number of items per page (default to 20)

  • :sort_by (String) —

    Field to sort by

  • :sort_order (String) —

    Sort order (ascending or descending) (default to ‘desc’)

  • :search (String) —

    Search term to filter results

Returns:

  • (Array<(CreatePosts200Response, Integer, Hash)>) —

    CreatePosts200Response 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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
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
 
# File 'lib/spartera_api_sdk/api/posts_api.rb', line 47

def create_posts_with_http_info(company_id, posts_input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PostsApi.create_posts ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling PostsApi.create_posts"
  end
  if @api_client.config.client_side_validation && company_id.to_s.length > 255
    fail ArgumentError, 'invalid value for "company_id" when calling PostsApi.create_posts, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && company_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "company_id" when calling PostsApi.create_posts, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if @api_client.config.client_side_validation && company_id !~ pattern
    fail ArgumentError, "invalid value for 'company_id' when calling PostsApi.create_posts, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'posts_input' is set
  if @api_client.config.client_side_validation && posts_input.nil?
    fail ArgumentError, "Missing the required parameter 'posts_input' when calling PostsApi.create_posts"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling PostsApi.create_posts, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling PostsApi.create_posts, must be smaller than or equal to 100.'
  end

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

  allowable_values = ["asc", "desc"]
  if @api_client.config.client_side_validation && opts[:'sort_order'] && !allowable_values.include?(opts[:'sort_order'])
    fail ArgumentError, "invalid value for \"sort_order\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'search'].nil? && opts[:'search'].to_s.length > 255
    fail ArgumentError, 'invalid value for "opts[:"search"]" when calling PostsApi.create_posts, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && !opts[:'search'].nil? && opts[:'search'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"search"]" when calling PostsApi.create_posts, the character length must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/companies/{company_id}/posts'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'sort_by'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
  query_params[:'sort_order'] = opts[:'sort_order'] if !opts[:'sort_order'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(posts_input)

  # return_type
  return_type = opts[:debug_return_type] || 'CreatePosts200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"PostsApi.create_posts",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PostsApi#create_posts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_posts(company_id, post_id, opts = {}) ⇒ DeletePosts200Response

Delete single post by ID.

Parameters:

  • company_id (String) —

    Unique identifier for the Company

  • post_id (String) —

    Unique identifier for the Post

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

    the optional parameters

Returns:



586
587
588
589
 
# File 'lib/spartera_api_sdk/api/posts_api.rb', line 586

def delete_posts(company_id, post_id, opts = {})
  data, _status_code, _headers = delete_posts_with_http_info(company_id, post_id, opts)
  data
end

#delete_posts_with_http_info(company_id, post_id, opts = {}) ⇒ Array<(DeletePosts200Response, Integer, Hash)>

Delete single post by ID.

Parameters:

  • company_id (String) —

    Unique identifier for the Company

  • post_id (String) —

    Unique identifier for the Post

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

    the optional parameters

Returns:

  • (Array<(DeletePosts200Response, Integer, Hash)>) —

    DeletePosts200Response data, response status code and response headers



596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
 
# File 'lib/spartera_api_sdk/api/posts_api.rb', line 596

def delete_posts_with_http_info(company_id, post_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PostsApi.delete_posts ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling PostsApi.delete_posts"
  end
  if @api_client.config.client_side_validation && company_id.to_s.length > 255
    fail ArgumentError, 'invalid value for "company_id" when calling PostsApi.delete_posts, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && company_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "company_id" when calling PostsApi.delete_posts, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if @api_client.config.client_side_validation && company_id !~ pattern
    fail ArgumentError, "invalid value for 'company_id' when calling PostsApi.delete_posts, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'post_id' is set
  if @api_client.config.client_side_validation && post_id.nil?
    fail ArgumentError, "Missing the required parameter 'post_id' when calling PostsApi.delete_posts"
  end
  if @api_client.config.client_side_validation && post_id.to_s.length > 255
    fail ArgumentError, 'invalid value for "post_id" when calling PostsApi.delete_posts, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && post_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "post_id" when calling PostsApi.delete_posts, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if @api_client.config.client_side_validation && post_id !~ pattern
    fail ArgumentError, "invalid value for 'post_id' when calling PostsApi.delete_posts, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/companies/{company_id}/posts/{post_id}'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'post_id' + '}', CGI.escape(post_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DeletePosts200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"PostsApi.delete_posts",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PostsApi#delete_posts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_posts_by_id(company_id, post_id, opts = {}) ⇒ GetPostsById200Response

Get single post by ID.

Parameters:

  • company_id (String) —

    Unique identifier for the Company

  • post_id (String) —

    Unique identifier for the Post

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

    the optional parameters

Returns:



679
680
681
682
 
# File 'lib/spartera_api_sdk/api/posts_api.rb', line 679

def get_posts_by_id(company_id, post_id, opts = {})
  data, _status_code, _headers = get_posts_by_id_with_http_info(company_id, post_id, opts)
  data
end

#get_posts_by_id_publications(company_id, post_id, opts = {}) ⇒ GetPostsById200Response

Get all publications for a post. Shows where this post has been published to external platforms. Returns: Array of publication records with platform, URL, status

Parameters:

  • company_id (String) —

    Unique identifier for the Company

  • post_id (String) —

    Unique identifier for the Post

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

    the optional parameters

Returns:



772
773
774
775
 
# File 'lib/spartera_api_sdk/api/posts_api.rb', line 772

def get_posts_by_id_publications(company_id, post_id, opts = {})
  data, _status_code, _headers = get_posts_by_id_publications_with_http_info(company_id, post_id, opts)
  data
end

#get_posts_by_id_publications_with_http_info(company_id, post_id, opts = {}) ⇒ Array<(GetPostsById200Response, Integer, Hash)>

Get all publications for a post. Shows where this post has been published to external platforms. Returns: Array of publication records with platform, URL, status

Parameters:

  • company_id (String) —

    Unique identifier for the Company

  • post_id (String) —

    Unique identifier for the Post

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

    the optional parameters

Returns:

  • (Array<(GetPostsById200Response, Integer, Hash)>) —

    GetPostsById200Response data, response status code and response headers



782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
 
# File 'lib/spartera_api_sdk/api/posts_api.rb', line 782

def get_posts_by_id_publications_with_http_info(company_id, post_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PostsApi.get_posts_by_id_publications ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling PostsApi.get_posts_by_id_publications"
  end
  if @api_client.config.client_side_validation && company_id.to_s.length > 255
    fail ArgumentError, 'invalid value for "company_id" when calling PostsApi.get_posts_by_id_publications, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && company_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "company_id" when calling PostsApi.get_posts_by_id_publications, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if @api_client.config.client_side_validation && company_id !~ pattern
    fail ArgumentError, "invalid value for 'company_id' when calling PostsApi.get_posts_by_id_publications, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'post_id' is set
  if @api_client.config.client_side_validation && post_id.nil?
    fail ArgumentError, "Missing the required parameter 'post_id' when calling PostsApi.get_posts_by_id_publications"
  end
  if @api_client.config.client_side_validation && post_id.to_s.length > 255
    fail ArgumentError, 'invalid value for "post_id" when calling PostsApi.get_posts_by_id_publications, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && post_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "post_id" when calling PostsApi.get_posts_by_id_publications, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if @api_client.config.client_side_validation && post_id !~ pattern
    fail ArgumentError, "invalid value for 'post_id' when calling PostsApi.get_posts_by_id_publications, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/companies/{company_id}/posts/{post_id}/publications'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'post_id' + '}', CGI.escape(post_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetPostsById200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"PostsApi.get_posts_by_id_publications",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PostsApi#get_posts_by_id_publications\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_posts_by_id_with_http_info(company_id, post_id, opts = {}) ⇒ Array<(GetPostsById200Response, Integer, Hash)>

Get single post by ID.

Parameters:

  • company_id (String) —

    Unique identifier for the Company

  • post_id (String) —

    Unique identifier for the Post

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

    the optional parameters

Returns:

  • (Array<(GetPostsById200Response, Integer, Hash)>) —

    GetPostsById200Response data, response status code and response headers



689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
 
# File 'lib/spartera_api_sdk/api/posts_api.rb', line 689

def get_posts_by_id_with_http_info(company_id, post_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PostsApi.get_posts_by_id ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling PostsApi.get_posts_by_id"
  end
  if @api_client.config.client_side_validation && company_id.to_s.length > 255
    fail ArgumentError, 'invalid value for "company_id" when calling PostsApi.get_posts_by_id, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && company_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "company_id" when calling PostsApi.get_posts_by_id, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if @api_client.config.client_side_validation && company_id !~ pattern
    fail ArgumentError, "invalid value for 'company_id' when calling PostsApi.get_posts_by_id, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'post_id' is set
  if @api_client.config.client_side_validation && post_id.nil?
    fail ArgumentError, "Missing the required parameter 'post_id' when calling PostsApi.get_posts_by_id"
  end
  if @api_client.config.client_side_validation && post_id.to_s.length > 255
    fail ArgumentError, 'invalid value for "post_id" when calling PostsApi.get_posts_by_id, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && post_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "post_id" when calling PostsApi.get_posts_by_id, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if @api_client.config.client_side_validation && post_id !~ pattern
    fail ArgumentError, "invalid value for 'post_id' when calling PostsApi.get_posts_by_id, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/companies/{company_id}/posts/{post_id}'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'post_id' + '}', CGI.escape(post_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetPostsById200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"PostsApi.get_posts_by_id",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PostsApi#get_posts_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_posts(company_id, opts = {}) ⇒ ListPosts200Response

Get a list of all posts for the user’s company. Supports filtering, sorting, pagination.

Parameters:

  • company_id (String) —

    Unique identifier for the Company

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number for pagination (default to 1)

  • :limit (Integer) —

    Number of items per page (default to 20)

  • :sort_by (String) —

    Field to sort by

  • :sort_order (String) —

    Sort order (ascending or descending) (default to ‘desc’)

  • :search (String) —

    Search term to filter results

Returns:



869
870
871
872
 
# File 'lib/spartera_api_sdk/api/posts_api.rb', line 869

def list_posts(company_id, opts = {})
  data, _status_code, _headers = list_posts_with_http_info(company_id, opts)
  data
end

#list_posts_summary(company_id, opts = {}) ⇒ ListPosts200Response

GET /companies/company_id/posts/summary

Parameters:

  • company_id (String) —

    Unique identifier for the Company

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number for pagination (default to 1)

  • :limit (Integer) —

    Number of items per page (default to 20)

  • :sort_by (String) —

    Field to sort by

  • :sort_order (String) —

    Sort order (ascending or descending) (default to ‘desc’)

  • :search (String) —

    Search term to filter results

Returns:



982
983
984
985
 
# File 'lib/spartera_api_sdk/api/posts_api.rb', line 982

def list_posts_summary(company_id, opts = {})
  data, _status_code, _headers = list_posts_summary_with_http_info(company_id, opts)
  data
end

#list_posts_summary_with_http_info(company_id, opts = {}) ⇒ Array<(ListPosts200Response, Integer, Hash)>

GET /companies/company_id/posts/summary

Parameters:

  • company_id (String) —

    Unique identifier for the Company

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number for pagination (default to 1)

  • :limit (Integer) —

    Number of items per page (default to 20)

  • :sort_by (String) —

    Field to sort by

  • :sort_order (String) —

    Sort order (ascending or descending) (default to ‘desc’)

  • :search (String) —

    Search term to filter results

Returns:

  • (Array<(ListPosts200Response, Integer, Hash)>) —

    ListPosts200Response data, response status code and response headers



996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
 
# File 'lib/spartera_api_sdk/api/posts_api.rb', line 996

def list_posts_summary_with_http_info(company_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PostsApi.list_posts_summary ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling PostsApi.list_posts_summary"
  end
  if @api_client.config.client_side_validation && company_id.to_s.length > 255
    fail ArgumentError, 'invalid value for "company_id" when calling PostsApi.list_posts_summary, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && company_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "company_id" when calling PostsApi.list_posts_summary, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if @api_client.config.client_side_validation && company_id !~ pattern
    fail ArgumentError, "invalid value for 'company_id' when calling PostsApi.list_posts_summary, must conform to the pattern #{pattern}."
  end

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

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling PostsApi.list_posts_summary, must be smaller than or equal to 100.'
  end

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

  allowable_values = ["asc", "desc"]
  if @api_client.config.client_side_validation && opts[:'sort_order'] && !allowable_values.include?(opts[:'sort_order'])
    fail ArgumentError, "invalid value for \"sort_order\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'search'].nil? && opts[:'search'].to_s.length > 255
    fail ArgumentError, 'invalid value for "opts[:"search"]" when calling PostsApi.list_posts_summary, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && !opts[:'search'].nil? && opts[:'search'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"search"]" when calling PostsApi.list_posts_summary, the character length must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/companies/{company_id}/posts/summary'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'sort_by'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
  query_params[:'sort_order'] = opts[:'sort_order'] if !opts[:'sort_order'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ListPosts200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"PostsApi.list_posts_summary",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PostsApi#list_posts_summary\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_posts_with_http_info(company_id, opts = {}) ⇒ Array<(ListPosts200Response, Integer, Hash)>

Get a list of all posts for the user&#39;s company. Supports filtering, sorting, pagination.

Parameters:

  • company_id (String) —

    Unique identifier for the Company

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number for pagination (default to 1)

  • :limit (Integer) —

    Number of items per page (default to 20)

  • :sort_by (String) —

    Field to sort by

  • :sort_order (String) —

    Sort order (ascending or descending) (default to ‘desc’)

  • :search (String) —

    Search term to filter results

Returns:

  • (Array<(ListPosts200Response, Integer, Hash)>) —

    ListPosts200Response data, response status code and response headers



883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
 
# File 'lib/spartera_api_sdk/api/posts_api.rb', line 883

def list_posts_with_http_info(company_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PostsApi.list_posts ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling PostsApi.list_posts"
  end
  if @api_client.config.client_side_validation && company_id.to_s.length > 255
    fail ArgumentError, 'invalid value for "company_id" when calling PostsApi.list_posts, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && company_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "company_id" when calling PostsApi.list_posts, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if @api_client.config.client_side_validation && company_id !~ pattern
    fail ArgumentError, "invalid value for 'company_id' when calling PostsApi.list_posts, must conform to the pattern #{pattern}."
  end

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

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling PostsApi.list_posts, must be smaller than or equal to 100.'
  end

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

  allowable_values = ["asc", "desc"]
  if @api_client.config.client_side_validation && opts[:'sort_order'] && !allowable_values.include?(opts[:'sort_order'])
    fail ArgumentError, "invalid value for \"sort_order\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'search'].nil? && opts[:'search'].to_s.length > 255
    fail ArgumentError, 'invalid value for "opts[:"search"]" when calling PostsApi.list_posts, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && !opts[:'search'].nil? && opts[:'search'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"search"]" when calling PostsApi.list_posts, the character length must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/companies/{company_id}/posts'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'sort_by'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
  query_params[:'sort_order'] = opts[:'sort_order'] if !opts[:'sort_order'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ListPosts200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"PostsApi.list_posts",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PostsApi#list_posts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_posts(company_id, post_id, posts_update, opts = {}) ⇒ UpdatePosts200Response

Update an existing post by ID. Note: last_edited_at is automatically updated.

Parameters:

  • company_id (String) —

    Unique identifier for the Company

  • post_id (String) —

    Unique identifier for the Post

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

    the optional parameters

Returns:



1092
1093
1094
1095
 
# File 'lib/spartera_api_sdk/api/posts_api.rb', line 1092

def update_posts(company_id, post_id, posts_update, opts = {})
  data, _status_code, _headers = update_posts_with_http_info(company_id, post_id, posts_update, opts)
  data
end

#update_posts_with_http_info(company_id, post_id, posts_update, opts = {}) ⇒ Array<(UpdatePosts200Response, Integer, Hash)>

Update an existing post by ID. Note: last_edited_at is automatically updated.

Parameters:

  • company_id (String) —

    Unique identifier for the Company

  • post_id (String) —

    Unique identifier for the Post

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

    the optional parameters

Returns:

  • (Array<(UpdatePosts200Response, Integer, Hash)>) —

    UpdatePosts200Response data, response status code and response headers



1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
 
# File 'lib/spartera_api_sdk/api/posts_api.rb', line 1103

def update_posts_with_http_info(company_id, post_id, posts_update, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PostsApi.update_posts ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling PostsApi.update_posts"
  end
  if @api_client.config.client_side_validation && company_id.to_s.length > 255
    fail ArgumentError, 'invalid value for "company_id" when calling PostsApi.update_posts, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && company_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "company_id" when calling PostsApi.update_posts, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if @api_client.config.client_side_validation && company_id !~ pattern
    fail ArgumentError, "invalid value for 'company_id' when calling PostsApi.update_posts, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'post_id' is set
  if @api_client.config.client_side_validation && post_id.nil?
    fail ArgumentError, "Missing the required parameter 'post_id' when calling PostsApi.update_posts"
  end
  if @api_client.config.client_side_validation && post_id.to_s.length > 255
    fail ArgumentError, 'invalid value for "post_id" when calling PostsApi.update_posts, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && post_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "post_id" when calling PostsApi.update_posts, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if @api_client.config.client_side_validation && post_id !~ pattern
    fail ArgumentError, "invalid value for 'post_id' when calling PostsApi.update_posts, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'posts_update' is set
  if @api_client.config.client_side_validation && posts_update.nil?
    fail ArgumentError, "Missing the required parameter 'posts_update' when calling PostsApi.update_posts"
  end
  # resource path
  local_var_path = '/companies/{company_id}/posts/{post_id}'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'post_id' + '}', CGI.escape(post_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(posts_update)

  # return_type
  return_type = opts[:debug_return_type] || 'UpdatePosts200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"PostsApi.update_posts",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PostsApi#update_posts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end