spartera_api_sdk 0.3.6

data/docs/InlineObject6.md

@@ -0,0 +1,22 @@
+# SparteraApiSdk::InlineObject6
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **Integer** |  | [optional] |
+| **message** | **String** |  | [optional] |
+| **retry_after** | **Integer** | Seconds to wait before retrying | [optional] |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::InlineObject6.new(
+  code: 429,
+  message: Rate limit exceeded,
+  retry_after: 60
+)
+```
+

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

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

data/docs/JobFunctionsApi.md

@@ -0,0 +1,157 @@
+# SparteraApiSdk::JobFunctionsApi
+
+All URIs are relative to *https://api.spartera.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**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 |
+
+
+## get_job_functions_by_id
+
+> <GetJobFunctionsById200Response> get_job_functions_by_id(function_id)
+
+Get single job function by ID
+
+### Examples
+
+```ruby
+require 'time'
+require 'spartera_api_sdk'
+# setup authorization
+SparteraApiSdk.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['x-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['x-api-key'] = 'Bearer'
+end
+
+api_instance = SparteraApiSdk::JobFunctionsApi.new
+function_id = 'function_id_example' # String | Unique identifier for the Function
+
+begin
+  # Get single job function by ID
+  result = api_instance.get_job_functions_by_id(function_id)
+  p result
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling JobFunctionsApi->get_job_functions_by_id: #{e}"
+end
+```
+
+#### 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(<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.get_job_functions_by_id_with_http_info(function_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetJobFunctionsById200Response>
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling JobFunctionsApi->get_job_functions_by_id_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **function_id** | **String** | Unique identifier for the Function |  |
+
+### Return type
+
+[**GetJobFunctionsById200Response**](GetJobFunctionsById200Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_job_functions
+
+> <ListJobFunctions200Response> list_job_functions(opts)
+
+Get a list of all job functions
+
+### Examples
+
+```ruby
+require 'time'
+require 'spartera_api_sdk'
+# setup authorization
+SparteraApiSdk.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['x-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['x-api-key'] = 'Bearer'
+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.list_job_functions(opts)
+  p result
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling JobFunctionsApi->list_job_functions: #{e}"
+end
+```
+
+#### Using the list_job_functions_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <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.list_job_functions_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListJobFunctions200Response>
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling JobFunctionsApi->list_job_functions_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| 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
+
+[**ListJobFunctions200Response**](ListJobFunctions200Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/JobFunctionsInput.md

@@ -0,0 +1,18 @@
+# SparteraApiSdk::JobFunctionsInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Required. Must be unique. |  |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::JobFunctionsInput.new(
+  name: Example Name
+)
+```
+

data/docs/JobFunctionsUpdate.md

@@ -0,0 +1,18 @@
+# SparteraApiSdk::JobFunctionsUpdate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Required. Must be unique. | [optional] |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+instance = SparteraApiSdk::JobFunctionsUpdate.new(
+  name: Example Name
+)
+```
+

data/docs/ListApiKeys200Response.md

@@ -0,0 +1,20 @@
+# SparteraApiSdk::ListApiKeys200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | Response status message |  |
+| **data** | [**Array<ApiKeys>**](ApiKeys.md) |  |  |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+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/ListAssets200Response.md

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

data/docs/ListCloudProviders200Response.md

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

data/docs/ListCompaniesAnalyticsAssets200Response.md

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

data/docs/ListConnections200Response.md

@@ -0,0 +1,20 @@
+# SparteraApiSdk::ListConnections200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | Response status message |  |
+| **data** | [**Array<Connections>**](Connections.md) |  |  |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+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/ListJobFunctions200Response.md

@@ -0,0 +1,20 @@
+# SparteraApiSdk::ListJobFunctions200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | Response status message |  |
+| **data** | [**Array<JobFunctions>**](JobFunctions.md) |  |  |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+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/ListUsers200Response.md

@@ -0,0 +1,20 @@
+# SparteraApiSdk::ListUsers200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | Response status message |  |
+| **data** | [**Array<Users>**](Users.md) |  |  |
+
+## Example
+
+```ruby
+require 'spartera_api_sdk'
+
+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
+)
+```
+