spartera_api_sdk 1.0.77 → 1.0.78

data/docs/InlineObject7.md

@@ -0,0 +1,20 @@
+# SparteraApiSdk::InlineObject7
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **Integer** |  | [optional] |
+| **message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::InlineObject7.new(
+  code: 500,
+  message: Internal server error
+)
+```
+

data/docs/JobFunctions.md

@@ -4,10 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **date_created** | **Time** |  | [optional] |
-| **last_updated** | **Time** |  | [optional] |
-| **function_id** | **Integer** |  |  |
-| **name** | **String** |  |  |
+| **date_created** | **Time** | Optional. | [optional] |
+| **last_updated** | **Time** | Optional. | [optional] |
+| **function_id** | **Integer** | Auto-generated unique identifier. |  |
+| **name** | **String** | Required. Must be unique. |  |
 
 ## Example
 
@@ -15,10 +15,10 @@
 require 'spartera_api_sdk'
 
 instance = SparteraApiSdk::JobFunctions.new(
-  date_created: null,
-  last_updated: null,
-  function_id: null,
-  name: null
+  date_created: 2025-04-01T00:00:00Z,
+  last_updated: 2025-04-01T00:00:00Z,
+  function_id: 1,
+  name: Example Name
 )
 ```
 

data/docs/JobFunctionsApi.md

@@ -4,13 +4,13 @@ All URIs are relative to *https://api.spartera.com*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**job_functions_function_id_get**](JobFunctionsApi.md#job_functions_function_id_get) | **GET** /job-functions/{function_id} | Get single job function by ID |
-| [**job_functions_get**](JobFunctionsApi.md#job_functions_get) | **GET** /job-functions | Get a list of all job functions |
+| [**get_job_functions_by_id**](JobFunctionsApi.md#get_job_functions_by_id) | **GET** /job-functions/{function_id} | Get single job function by ID |
+| [**list_job_functions**](JobFunctionsApi.md#list_job_functions) | **GET** /job-functions | Get a list of all job functions |
 
 
-## job_functions_function_id_get
+## get_job_functions_by_id
 
-> <JobFunctionsFunctionIdGet200Response> job_functions_function_id_get(function_id)
+> <GetJobFunctionsById200Response> get_job_functions_by_id(function_id)
 
 Get single job function by ID
 
@@ -28,32 +28,32 @@ SparteraApiSdk.configure do |config|
 end
 
 api_instance = SparteraApiSdk::JobFunctionsApi.new
-function_id = 'function_id_example' # String | 
+function_id = 'function_id_example' # String | Unique identifier for the Function
 
 begin
   # Get single job function by ID
-  result = api_instance.job_functions_function_id_get(function_id)
+  result = api_instance.get_job_functions_by_id(function_id)
   p result
 rescue SparteraApiSdk::ApiError => e
-  puts "Error when calling JobFunctionsApi->job_functions_function_id_get: #{e}"
+  puts "Error when calling JobFunctionsApi->get_job_functions_by_id: #{e}"
 end
 ```
 
-#### Using the job_functions_function_id_get_with_http_info variant
+#### Using the get_job_functions_by_id_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<JobFunctionsFunctionIdGet200Response>, Integer, Hash)> job_functions_function_id_get_with_http_info(function_id)
+> <Array(<GetJobFunctionsById200Response>, Integer, Hash)> get_job_functions_by_id_with_http_info(function_id)
 
 ```ruby
 begin
   # Get single job function by ID
-  data, status_code, headers = api_instance.job_functions_function_id_get_with_http_info(function_id)
+  data, status_code, headers = api_instance.get_job_functions_by_id_with_http_info(function_id)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <JobFunctionsFunctionIdGet200Response>
+  p data # => <GetJobFunctionsById200Response>
 rescue SparteraApiSdk::ApiError => e
-  puts "Error when calling JobFunctionsApi->job_functions_function_id_get_with_http_info: #{e}"
+  puts "Error when calling JobFunctionsApi->get_job_functions_by_id_with_http_info: #{e}"
 end
 ```
 
@@ -61,11 +61,11 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **function_id** | **String** |  |  |
+| **function_id** | **String** | Unique identifier for the Function |  |
 
 ### Return type
 
-[**JobFunctionsFunctionIdGet200Response**](JobFunctionsFunctionIdGet200Response.md)
+[**GetJobFunctionsById200Response**](GetJobFunctionsById200Response.md)
 
 ### Authorization
 
@@ -77,9 +77,9 @@ end
 - **Accept**: application/json
 
 
-## job_functions_get
+## list_job_functions
 
-> <JobFunctionsGet200Response> job_functions_get
+> <ListJobFunctions200Response> list_job_functions(opts)
 
 Get a list of all job functions
 
@@ -97,41 +97,54 @@ SparteraApiSdk.configure do |config|
 end
 
 api_instance = SparteraApiSdk::JobFunctionsApi.new
+opts = {
+  page: 56, # Integer | Page number for pagination
+  limit: 56, # Integer | Number of items per page
+  sort_by: 'sort_by_example', # String | Field to sort by
+  sort_order: 'asc', # String | Sort order (ascending or descending)
+  search: 'search_example' # String | Search term to filter results
+}
 
 begin
   # Get a list of all job functions
-  result = api_instance.job_functions_get
+  result = api_instance.list_job_functions(opts)
   p result
 rescue SparteraApiSdk::ApiError => e
-  puts "Error when calling JobFunctionsApi->job_functions_get: #{e}"
+  puts "Error when calling JobFunctionsApi->list_job_functions: #{e}"
 end
 ```
 
-#### Using the job_functions_get_with_http_info variant
+#### Using the list_job_functions_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<JobFunctionsGet200Response>, Integer, Hash)> job_functions_get_with_http_info
+> <Array(<ListJobFunctions200Response>, Integer, Hash)> list_job_functions_with_http_info(opts)
 
 ```ruby
 begin
   # Get a list of all job functions
-  data, status_code, headers = api_instance.job_functions_get_with_http_info
+  data, status_code, headers = api_instance.list_job_functions_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <JobFunctionsGet200Response>
+  p data # => <ListJobFunctions200Response>
 rescue SparteraApiSdk::ApiError => e
-  puts "Error when calling JobFunctionsApi->job_functions_get_with_http_info: #{e}"
+  puts "Error when calling JobFunctionsApi->list_job_functions_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-This endpoint does not need any parameter.
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** | Page number for pagination | [optional][default to 1] |
+| **limit** | **Integer** | Number of items per page | [optional][default to 20] |
+| **sort_by** | **String** | Field to sort by | [optional] |
+| **sort_order** | **String** | Sort order (ascending or descending) | [optional][default to &#39;desc&#39;] |
+| **search** | **String** | Search term to filter results | [optional] |
 
 ### Return type
 
-[**JobFunctionsGet200Response**](JobFunctionsGet200Response.md)
+[**ListJobFunctions200Response**](ListJobFunctions200Response.md)
 
 ### Authorization
 

data/docs/JobFunctionsInput.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **name** | **String** |  |  |
+| **name** | **String** | Required. Must be unique. |  |
 
 ## Example
 
@@ -12,7 +12,7 @@
 require 'spartera_api_sdk'
 
 instance = SparteraApiSdk::JobFunctionsInput.new(
-  name: null
+  name: Example Name
 )
 ```
 

data/docs/JobFunctionsUpdate.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **name** | **String** |  | [optional] |
+| **name** | **String** | Required. Must be unique. | [optional] |
 
 ## Example
 
@@ -12,7 +12,7 @@
 require 'spartera_api_sdk'
 
 instance = SparteraApiSdk::JobFunctionsUpdate.new(
-  name: null
+  name: Example Name
 )
 ```
 

data/docs/{CompaniesCompanyIdApiKeysGet200Response.md → ListApiKeys200Response.md}

@@ -1,4 +1,4 @@
-# SparteraApiSdk::CompaniesCompanyIdApiKeysGet200Response
+# SparteraApiSdk::ListApiKeys200Response
 
 ## Properties
 
@@ -12,7 +12,7 @@
 ```ruby
 require 'spartera_api_sdk'
 
-instance = SparteraApiSdk::CompaniesCompanyIdApiKeysGet200Response.new(
+instance = SparteraApiSdk::ListApiKeys200Response.new(
   message: success,
   data: null
 )

data/docs/ListAssetUsecases200Response.md

@@ -0,0 +1,20 @@
+# SparteraApiSdk::ListAssetUsecases200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | Response status message |  |
+| **data** | [**Array<AssetUsecases>**](AssetUsecases.md) |  |  |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::ListAssetUsecases200Response.new(
+  message: success,
+  data: null
+)
+```
+

data/docs/{CompaniesCompanyIdAssetsGet200Response.md → ListAssets200Response.md}

@@ -1,4 +1,4 @@
-# SparteraApiSdk::CompaniesCompanyIdAssetsGet200Response
+# SparteraApiSdk::ListAssets200Response
 
 ## Properties
 
@@ -12,7 +12,7 @@
 ```ruby
 require 'spartera_api_sdk'
 
-instance = SparteraApiSdk::CompaniesCompanyIdAssetsGet200Response.new(
+instance = SparteraApiSdk::ListAssets200Response.new(
   message: success,
   data: null
 )

data/docs/{CloudProvidersGet200Response.md → ListCloudProviders200Response.md}

@@ -1,4 +1,4 @@
-# SparteraApiSdk::CloudProvidersGet200Response
+# SparteraApiSdk::ListCloudProviders200Response
 
 ## Properties
 
@@ -12,7 +12,7 @@
 ```ruby
 require 'spartera_api_sdk'
 
-instance = SparteraApiSdk::CloudProvidersGet200Response.new(
+instance = SparteraApiSdk::ListCloudProviders200Response.new(
   message: success,
   data: null
 )

data/docs/{CompaniesCompanyIdAnalyticsAssetsGet200Response.md → ListCompaniesAnalyticsAssets200Response.md}

@@ -1,4 +1,4 @@
-# SparteraApiSdk::CompaniesCompanyIdAnalyticsAssetsGet200Response
+# SparteraApiSdk::ListCompaniesAnalyticsAssets200Response
 
 ## Properties
 
@@ -12,7 +12,7 @@
 ```ruby
 require 'spartera_api_sdk'
 
-instance = SparteraApiSdk::CompaniesCompanyIdAnalyticsAssetsGet200Response.new(
+instance = SparteraApiSdk::ListCompaniesAnalyticsAssets200Response.new(
   message: success,
   data: null
 )

data/docs/{CompaniesCompanyIdConnectionsGet200Response.md → ListConnections200Response.md}

@@ -1,4 +1,4 @@
-# SparteraApiSdk::CompaniesCompanyIdConnectionsGet200Response
+# SparteraApiSdk::ListConnections200Response
 
 ## Properties
 
@@ -12,7 +12,7 @@
 ```ruby
 require 'spartera_api_sdk'
 
-instance = SparteraApiSdk::CompaniesCompanyIdConnectionsGet200Response.new(
+instance = SparteraApiSdk::ListConnections200Response.new(
   message: success,
   data: null
 )

data/docs/ListEndpoints200Response.md

@@ -0,0 +1,20 @@
+# SparteraApiSdk::ListEndpoints200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | Response status message |  |
+| **data** | [**Array<Endpoints>**](Endpoints.md) |  |  |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::ListEndpoints200Response.new(
+  message: success,
+  data: null
+)
+```
+

data/docs/ListIndustries200Response.md

@@ -0,0 +1,20 @@
+# SparteraApiSdk::ListIndustries200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | Response status message |  |
+| **data** | [**Array<Industries>**](Industries.md) |  |  |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::ListIndustries200Response.new(
+  message: success,
+  data: null
+)
+```
+

data/docs/{JobFunctionsGet200Response.md → ListJobFunctions200Response.md}

@@ -1,4 +1,4 @@
-# SparteraApiSdk::JobFunctionsGet200Response
+# SparteraApiSdk::ListJobFunctions200Response
 
 ## Properties
 
@@ -12,7 +12,7 @@
 ```ruby
 require 'spartera_api_sdk'
 
-instance = SparteraApiSdk::JobFunctionsGet200Response.new(
+instance = SparteraApiSdk::ListJobFunctions200Response.new(
   message: success,
   data: null
 )

data/docs/ListPostgenIntegrations200Response.md

@@ -0,0 +1,20 @@
+# SparteraApiSdk::ListPostgenIntegrations200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | Response status message |  |
+| **data** | [**Array<PostgenIntegrations>**](PostgenIntegrations.md) |  |  |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::ListPostgenIntegrations200Response.new(
+  message: success,
+  data: null
+)
+```
+

data/docs/ListPosts200Response.md

@@ -0,0 +1,20 @@
+# SparteraApiSdk::ListPosts200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | Response status message |  |
+| **data** | [**Array<Posts>**](Posts.md) |  |  |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::ListPosts200Response.new(
+  message: success,
+  data: null
+)
+```
+

data/docs/ListStorageEngines200Response.md

@@ -0,0 +1,20 @@
+# SparteraApiSdk::ListStorageEngines200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | Response status message |  |
+| **data** | [**Array<StorageEngines>**](StorageEngines.md) |  |  |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::ListStorageEngines200Response.new(
+  message: success,
+  data: null
+)
+```
+

data/docs/{CompaniesCompanyIdUsersGet200Response.md → ListUsers200Response.md}

@@ -1,4 +1,4 @@
-# SparteraApiSdk::CompaniesCompanyIdUsersGet200Response
+# SparteraApiSdk::ListUsers200Response
 
 ## Properties
 
@@ -12,7 +12,7 @@
 ```ruby
 require 'spartera_api_sdk'
 
-instance = SparteraApiSdk::CompaniesCompanyIdUsersGet200Response.new(
+instance = SparteraApiSdk::ListUsers200Response.new(
   message: success,
   data: null
 )

data/docs/PostPublications.md

@@ -0,0 +1,40 @@
+# SparteraApiSdk::PostPublications
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **date_created** | **Time** | Optional. | [optional] |
+| **last_updated** | **Time** | Optional. | [optional] |
+| **publication_id** | **String** | Unique identifier. | [optional] |
+| **post_id** | **String** | Post that was published |  |
+| **company_id** | **String** | Company this publication belongs to |  |
+| **integration_id** | **String** | Integration used for publishing | [optional] |
+| **platform** | **String** | Platform identifier (beehiiv, wordpress, etc) |  |
+| **external_post_id** | **String** | ID of the post on the external platform | [optional] |
+| **external_post_url** | **String** | URL to view the post on the external platform | [optional] |
+| **published_at** | **Time** | When the post was published to this platform | [optional] |
+| **status** | **String** | Status: published, failed, deleted |  |
+| **error_message** | **String** | Error message if publication failed | [optional] |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::PostPublications.new(
+  date_created: 2025-04-01T00:00:00Z,
+  last_updated: 2025-04-01T00:00:00Z,
+  publication_id: publication_id_abc123,
+  post_id: post_id_abc123,
+  company_id: company_id_abc123,
+  integration_id: integration_id_abc123,
+  platform: example_value,
+  external_post_id: external_post_id_abc123,
+  external_post_url: https://example.com,
+  published_at: 2025-04-01T00:00:00Z,
+  status: ACTIVE,
+  error_message: example_value
+)
+```
+

data/docs/PostPublicationsInput.md

@@ -0,0 +1,34 @@
+# SparteraApiSdk::PostPublicationsInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **post_id** | **String** | Post that was published |  |
+| **company_id** | **String** | Company this publication belongs to |  |
+| **integration_id** | **String** | Integration used for publishing | [optional] |
+| **platform** | **String** | Platform identifier (beehiiv, wordpress, etc) |  |
+| **external_post_id** | **String** | ID of the post on the external platform | [optional] |
+| **external_post_url** | **String** | URL to view the post on the external platform | [optional] |
+| **published_at** | **Time** | When the post was published to this platform | [optional] |
+| **status** | **String** | Status: published, failed, deleted | [optional] |
+| **error_message** | **String** | Error message if publication failed | [optional] |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::PostPublicationsInput.new(
+  post_id: post_id_abc123,
+  company_id: company_id_abc123,
+  integration_id: integration_id_abc123,
+  platform: example_value,
+  external_post_id: external_post_id_abc123,
+  external_post_url: https://example.com,
+  published_at: 2025-04-01T00:00:00Z,
+  status: ACTIVE,
+  error_message: example_value
+)
+```
+

data/docs/PostPublicationsUpdate.md

@@ -0,0 +1,34 @@
+# SparteraApiSdk::PostPublicationsUpdate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **post_id** | **String** | Post that was published | [optional] |
+| **company_id** | **String** | Company this publication belongs to | [optional] |
+| **integration_id** | **String** | Integration used for publishing | [optional] |
+| **platform** | **String** | Platform identifier (beehiiv, wordpress, etc) | [optional] |
+| **external_post_id** | **String** | ID of the post on the external platform | [optional] |
+| **external_post_url** | **String** | URL to view the post on the external platform | [optional] |
+| **published_at** | **Time** | When the post was published to this platform | [optional] |
+| **status** | **String** | Status: published, failed, deleted | [optional] |
+| **error_message** | **String** | Error message if publication failed | [optional] |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::PostPublicationsUpdate.new(
+  post_id: post_id_abc123,
+  company_id: company_id_abc123,
+  integration_id: integration_id_abc123,
+  platform: example_value,
+  external_post_id: external_post_id_abc123,
+  external_post_url: https://example.com,
+  published_at: 2025-04-01T00:00:00Z,
+  status: ACTIVE,
+  error_message: example_value
+)
+```
+

data/docs/PostgenIntegrations.md

@@ -0,0 +1,36 @@
+# SparteraApiSdk::PostgenIntegrations
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **date_created** | **Time** | Optional. | [optional] |
+| **last_updated** | **Time** | Optional. | [optional] |
+| **integration_id** | **String** | Unique identifier. | [optional] |
+| **company_id** | **String** | Company this integration belongs to |  |
+| **user_id** | **String** | User who created this integration |  |
+| **platform** | **String** | Platform identifier (beehiiv, wordpress, medium, etc) |  |
+| **platform_name** | **String** | Display name of the platform |  |
+| **credentials_secret_name** | **String** | GCP Secret Manager secret name containing encrypted credentials |  |
+| **is_active** | **Boolean** | Whether this integration is currently active |  |
+| **last_used_at** | **Time** | Last time this integration was used for publishing | [optional] |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::PostgenIntegrations.new(
+  date_created: 2025-04-01T00:00:00Z,
+  last_updated: 2025-04-01T00:00:00Z,
+  integration_id: integration_id_abc123,
+  company_id: company_id_abc123,
+  user_id: user_id_abc123,
+  platform: example_value,
+  platform_name: Example Name,
+  credentials_secret_name: Example Name,
+  is_active: true,
+  last_used_at: 2025-04-01T00:00:00Z
+)
+```
+