postboost 1.0.0 → 1.8.0

data/docs/SubscriptionsApi.md

@@ -22,6 +22,8 @@ All URIs are relative to *https://postboost.co/app/api*
 
 Add generic subscription
 
+Assigns a non-Stripe (generic) subscription plan to the workspace, optionally granting a trial period. Used for AppSumo-style lifetime deals. Admin only.
+
 ### Examples
 
 ```ruby
@@ -87,10 +89,12 @@ end
 
 ## cancel_subscription
 
-> Object cancel_subscription(workspace_uuid)
+> Object cancel_subscription(workspace_uuid, opts)
 
 Cancel subscription
 
+Cancels the workspace's Stripe subscription at the end of the current billing period, or right away with `immediately: true`. Works for active and past-due subscriptions. Admin only. 
+
 ### Examples
 
 ```ruby
@@ -104,10 +108,13 @@ end
 
 api_instance = PostBoost::SubscriptionsApi.new
 workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
+opts = {
+  cancel_subscription_request: PostBoost::CancelSubscriptionRequest.new # CancelSubscriptionRequest | 
+}
 
 begin
   # Cancel subscription
-  result = api_instance.cancel_subscription(workspace_uuid)
+  result = api_instance.cancel_subscription(workspace_uuid, opts)
   p result
 rescue PostBoost::ApiError => e
   puts "Error when calling SubscriptionsApi->cancel_subscription: #{e}"
@@ -118,12 +125,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(Object, Integer, Hash)> cancel_subscription_with_http_info(workspace_uuid)
+> <Array(Object, Integer, Hash)> cancel_subscription_with_http_info(workspace_uuid, opts)
 
 ```ruby
 begin
   # Cancel subscription
-  data, status_code, headers = api_instance.cancel_subscription_with_http_info(workspace_uuid)
+  data, status_code, headers = api_instance.cancel_subscription_with_http_info(workspace_uuid, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => Object
@@ -137,6 +144,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **workspace_uuid** | **String** | UUID of the workspace. |  |
+| **cancel_subscription_request** | [**CancelSubscriptionRequest**](CancelSubscriptionRequest.md) |  | [optional] |
 
 ### Return type
 
@@ -148,7 +156,7 @@ end
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
+- **Content-Type**: application/json
 - **Accept**: application/json
 
 
@@ -158,6 +166,8 @@ end
 
 Change subscription plan
 
+Switches the workspace to a different Stripe plan. Optionally prorates the change and bills immediately. Admin only.
+
 ### Examples
 
 ```ruby
@@ -298,6 +308,8 @@ end
 
 Create subscription
 
+Manually creates a subscription record for the workspace (for external billing integrations). Admin only.
+
 ### Examples
 
 ```ruby
@@ -367,6 +379,8 @@ end
 
 Delete subscription
 
+Removes the subscription record from the workspace. Admin only.
+
 ### Examples
 
 ```ruby
@@ -434,6 +448,8 @@ end
 
 Get subscription
 
+Returns the active subscription for the workspace, or `null` if none exists. Admin only.
+
 ### Examples
 
 ```ruby
@@ -501,6 +517,8 @@ end
 
 Remove generic subscription
 
+Removes the generic (non-Stripe) subscription from the workspace. Returns `422` when the workspace has no generic subscription. Admin only.
+
 ### Examples
 
 ```ruby
@@ -568,6 +586,8 @@ end
 
 Resume subscription
 
+Resumes a previously canceled subscription before it expires. Admin only.
+
 ### Examples
 
 ```ruby
@@ -635,6 +655,8 @@ end
 
 Update subscription
 
+Updates the plan ID, status, or trial/pause dates of an existing subscription. Admin only.
+
 ### Examples
 
 ```ruby

data/docs/Tag.md

@@ -4,10 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **Integer** |  | [optional] |
-| **uuid** | **String** |  | [optional] |
-| **name** | **String** |  | [optional] |
-| **hex_color** | **String** |  | [optional] |
+| **id** | **Integer** |  |  |
+| **uuid** | **String** |  |  |
+| **name** | **String** |  |  |
+| **hex_color** | **String** |  |  |
 
 ## Example
 

data/docs/TagsApi.md

@@ -17,6 +17,8 @@ All URIs are relative to *https://postboost.co/app/api*
 
 Create tag
 
+Creates a new color-coded tag in the workspace for organizing posts.
+
 ### Examples
 
 ```ruby
@@ -86,6 +88,8 @@ end
 
 Delete tag
 
+Permanently deletes a tag. Posts that had this tag attached are unaffected.
+
 ### Examples
 
 ```ruby
@@ -155,6 +159,8 @@ end
 
 Get tag
 
+Returns a single tag by UUID.
+
 ### Examples
 
 ```ruby
@@ -224,6 +230,8 @@ end
 
 List tags
 
+Returns all tags defined in the workspace.
+
 ### Examples
 
 ```ruby
@@ -291,6 +299,8 @@ end
 
 Update tag
 
+Updates a tag's name or color.
+
 ### Examples
 
 ```ruby

data/docs/UpdateMediaRequest.md

@@ -4,7 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **alt_text** | **String** | Alternative text for accessibility. |  |
+| **name** | **String** |  | [optional] |
+| **alt_text** | **String** | Alternative text for accessibility. | [optional] |
+| **folder** | **String** | UUID of the media folder to move the item to, or null for the library root. | [optional] |
 
 ## Example
 
@@ -12,7 +14,9 @@
 require 'postboost'
 
 instance = PostBoost::UpdateMediaRequest.new(
-  alt_text: null
+  name: null,
+  alt_text: null,
+  folder: null
 )
 ```
 

data/docs/{UploadChunk200Response.md → UploadChunk201Response.md}

@@ -1,4 +1,4 @@
-# PostBoost::UploadChunk200Response
+# PostBoost::UploadChunk201Response
 
 ## Properties
 
@@ -11,7 +11,7 @@
 ```ruby
 require 'postboost'
 
-instance = PostBoost::UploadChunk200Response.new(
+instance = PostBoost::UploadChunk201Response.new(
   received: null
 )
 ```

data/docs/User.md

@@ -4,12 +4,13 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **Integer** |  | [optional] |
-| **name** | **String** |  | [optional] |
-| **email** | **String** |  | [optional] |
-| **is_admin** | **Boolean** |  | [optional] |
+| **id** | **Integer** |  |  |
+| **name** | **String** |  |  |
+| **email** | **String** |  |  |
+| **avatar** | **String** | URL of the user's avatar, or null when none is set. | [optional] |
+| **is_admin** | **Boolean** |  |  |
 | **email_verified_at** | **Time** |  | [optional] |
-| **created_at** | **Time** |  | [optional] |
+| **created_at** | **Time** |  |  |
 
 ## Example
 
@@ -20,6 +21,7 @@ instance = PostBoost::User.new(
   id: null,
   name: null,
   email: null,
+  avatar: null,
   is_admin: null,
   email_verified_at: null,
   created_at: null

data/docs/UsersApi.md

@@ -18,6 +18,8 @@ All URIs are relative to *https://postboost.co/app/api*
 
 Create user
 
+Creates a new user account on the platform. Admin only.
+
 ### Examples
 
 ```ruby
@@ -85,6 +87,8 @@ end
 
 Delete user
 
+Permanently deletes a user account. Returns 400 if you attempt to delete your own account. Admin only.
+
 ### Examples
 
 ```ruby
@@ -152,6 +156,8 @@ end
 
 Delete users (bulk)
 
+Permanently deletes one or more user accounts. You cannot delete your own account. Admin only.
+
 ### Examples
 
 ```ruby
@@ -219,6 +225,8 @@ end
 
 Get user
 
+Returns a single user account by ID. Admin only.
+
 ### Examples
 
 ```ruby
@@ -286,6 +294,8 @@ end
 
 List users
 
+Returns a paginated list of all users on the platform. Optionally filter by name or email. Admin only.
+
 ### Examples
 
 ```ruby
@@ -299,7 +309,8 @@ end
 
 api_instance = PostBoost::UsersApi.new
 opts = {
-  keyword: 'keyword_example' # String | Search by name or email.
+  keyword: 'keyword_example', # String | Search by name or email.
+  page: 56 # Integer | Page number (15 items per page).
 }
 
 begin
@@ -334,6 +345,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **keyword** | **String** | Search by name or email. | [optional] |
+| **page** | **Integer** | Page number (15 items per page). | [optional][default to 1] |
 
 ### Return type
 
@@ -355,6 +367,8 @@ end
 
 Update user
 
+Updates a user's name, email, admin status, or password. Admin only.
+
 ### Examples
 
 ```ruby

data/docs/Workspace.md

@@ -4,12 +4,13 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **uuid** | **String** |  | [optional] |
-| **name** | **String** |  | [optional] |
-| **hex_color** | **String** |  | [optional] |
+| **uuid** | **String** |  |  |
+| **name** | **String** |  |  |
+| **hex_color** | **String** | Deprecated. Workspaces no longer have a colour (workspaces now use `avatar`); the API returns the constant `4f46e5` so existing clients keep working. Will be removed in API v2. | [optional] |
+| **avatar** | **String** | URL of the workspace avatar, or null when none is set. Supersedes `hex_color`. | [optional] |
 | **owner** | [**User**](User.md) |  | [optional] |
-| **access_status** | **String** |  | [optional] |
-| **created_at** | **Time** |  | [optional] |
+| **access_status** | **String** |  |  |
+| **created_at** | **Time** |  |  |
 
 ## Example
 
@@ -19,7 +20,8 @@ require 'postboost'
 instance = PostBoost::Workspace.new(
   uuid: null,
   name: null,
-  hex_color: null,
+  hex_color: 4f46e5,
+  avatar: null,
   owner: null,
   access_status: null,
   created_at: null

data/docs/WorkspaceInput.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **name** | **String** |  |  |
-| **hex_color** | **String** |  |  |
+| **hex_color** | **String** | Ignored since v2.0; kept for backward compatibility | [optional] |
 | **owner_id** | **Integer** |  | [optional] |
 | **access_status** | **String** |  |  |
 

data/docs/WorkspacesApi.md

@@ -9,6 +9,8 @@ All URIs are relative to *https://postboost.co/app/api*
 | [**delete_workspace**](WorkspacesApi.md#delete_workspace) | **DELETE** /panel/workspaces/{workspaceUuid} | Delete workspace |
 | [**delete_workspaces_bulk**](WorkspacesApi.md#delete_workspaces_bulk) | **DELETE** /panel/workspaces | Delete workspaces (bulk) |
 | [**get_workspace**](WorkspacesApi.md#get_workspace) | **GET** /panel/workspaces/{workspaceUuid} | Get workspace |
+| [**get_workspace_ai_credits**](WorkspacesApi.md#get_workspace_ai_credits) | **GET** /panel/workspaces/{workspaceUuid}/ai-credits | Get workspace AI credits |
+| [**list_my_workspaces**](WorkspacesApi.md#list_my_workspaces) | **GET** /workspaces | List my workspaces |
 | [**list_workspaces**](WorkspacesApi.md#list_workspaces) | **GET** /panel/workspaces | List workspaces |
 | [**remove_user_from_workspace**](WorkspacesApi.md#remove_user_from_workspace) | **DELETE** /panel/workspaces/{workspaceUuid}/users | Remove user from workspace |
 | [**update_workspace**](WorkspacesApi.md#update_workspace) | **PUT** /panel/workspaces/{workspaceUuid} | Update workspace |
@@ -21,6 +23,8 @@ All URIs are relative to *https://postboost.co/app/api*
 
 Add user to workspace
 
+Adds an existing user to the workspace with a specified role. Admin only.
+
 ### Examples
 
 ```ruby
@@ -104,7 +108,7 @@ PostBoost.configure do |config|
 end
 
 api_instance = PostBoost::WorkspacesApi.new
-workspace_input = PostBoost::WorkspaceInput.new({name: 'name_example', hex_color: '#1d4ed8', access_status: 'subscription'}) # WorkspaceInput | 
+workspace_input = PostBoost::WorkspaceInput.new({name: 'name_example', access_status: 'subscription'}) # WorkspaceInput | 
 
 begin
   # Create workspace
@@ -159,6 +163,8 @@ end
 
 Delete workspace
 
+Permanently deletes a single workspace and all its associated data. Admin only.
+
 ### Examples
 
 ```ruby
@@ -226,6 +232,8 @@ end
 
 Delete workspaces (bulk)
 
+Permanently deletes one or more workspaces and all their associated data. Admin only.
+
 ### Examples
 
 ```ruby
@@ -293,6 +301,8 @@ end
 
 Get workspace
 
+Returns a single workspace by UUID including its subscription status. Admin only.
+
 ### Examples
 
 ```ruby
@@ -354,6 +364,141 @@ end
 - **Accept**: application/json
 
 
+## get_workspace_ai_credits
+
+> <AICredits> get_workspace_ai_credits(workspace_uuid)
+
+Get workspace AI credits
+
+Returns whether the workspace can use AI credits, its remaining balance, and whether the balance is low. Admin only.
+
+### Examples
+
+```ruby
+require 'time'
+require 'postboost'
+# setup authorization
+PostBoost.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = PostBoost::WorkspacesApi.new
+workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
+
+begin
+  # Get workspace AI credits
+  result = api_instance.get_workspace_ai_credits(workspace_uuid)
+  p result
+rescue PostBoost::ApiError => e
+  puts "Error when calling WorkspacesApi->get_workspace_ai_credits: #{e}"
+end
+```
+
+#### Using the get_workspace_ai_credits_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AICredits>, Integer, Hash)> get_workspace_ai_credits_with_http_info(workspace_uuid)
+
+```ruby
+begin
+  # Get workspace AI credits
+  data, status_code, headers = api_instance.get_workspace_ai_credits_with_http_info(workspace_uuid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AICredits>
+rescue PostBoost::ApiError => e
+  puts "Error when calling WorkspacesApi->get_workspace_ai_credits_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_uuid** | **String** | UUID of the workspace. |  |
+
+### Return type
+
+[**AICredits**](AICredits.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_my_workspaces
+
+> <ListMyWorkspaces200Response> list_my_workspaces
+
+List my workspaces
+
+Returns the workspaces the authenticated user belongs to, most recently updated first, with the caller's role in each. Use a returned `uuid` as `workspaceUuid`.
+
+### Examples
+
+```ruby
+require 'time'
+require 'postboost'
+# setup authorization
+PostBoost.configure do |config|
+  # Configure Bearer authorization: bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = PostBoost::WorkspacesApi.new
+
+begin
+  # List my workspaces
+  result = api_instance.list_my_workspaces
+  p result
+rescue PostBoost::ApiError => e
+  puts "Error when calling WorkspacesApi->list_my_workspaces: #{e}"
+end
+```
+
+#### Using the list_my_workspaces_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListMyWorkspaces200Response>, Integer, Hash)> list_my_workspaces_with_http_info
+
+```ruby
+begin
+  # List my workspaces
+  data, status_code, headers = api_instance.list_my_workspaces_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListMyWorkspaces200Response>
+rescue PostBoost::ApiError => e
+  puts "Error when calling WorkspacesApi->list_my_workspaces_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ListMyWorkspaces200Response**](ListMyWorkspaces200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## list_workspaces
 
 > <ListWorkspaces200Response> list_workspaces(opts)
@@ -377,7 +522,8 @@ api_instance = PostBoost::WorkspacesApi.new
 opts = {
   keyword: 'keyword_example', # String | 
   subscription_status: 'active', # String | 
-  access_status: 'subscription' # String | 
+  access_status: 'subscription', # String | 
+  page: 56 # Integer | Page number (15 items per page).
 }
 
 begin
@@ -414,6 +560,7 @@ end
 | **keyword** | **String** |  | [optional] |
 | **subscription_status** | **String** |  | [optional] |
 | **access_status** | **String** |  | [optional] |
+| **page** | **Integer** | Page number (15 items per page). | [optional][default to 1] |
 
 ### Return type
 
@@ -435,6 +582,8 @@ end
 
 Remove user from workspace
 
+Removes a user's access to the workspace. The user account is not deleted. Admin only.
+
 ### Examples
 
 ```ruby
@@ -504,6 +653,8 @@ end
 
 Update workspace
 
+Updates a workspace's name, owner, or access status. Admin only. `hex_color` is accepted but ignored.
+
 ### Examples
 
 ```ruby
@@ -517,7 +668,7 @@ end
 
 api_instance = PostBoost::WorkspacesApi.new
 workspace_uuid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | UUID of the workspace.
-workspace_input = PostBoost::WorkspaceInput.new({name: 'name_example', hex_color: '#1d4ed8', access_status: 'subscription'}) # WorkspaceInput | 
+workspace_input = PostBoost::WorkspaceInput.new({name: 'name_example', access_status: 'subscription'}) # WorkspaceInput | 
 
 begin
   # Update workspace
@@ -573,6 +724,8 @@ end
 
 Update user role in workspace
 
+Changes a user's role or permissions within the workspace. Admin only.
+
 ### Examples
 
 ```ruby

data/lib/postboost/api/accounts_api.rb

@@ -1,9 +1,9 @@
 =begin
 #PostBoost API
 
-#The PostBoost REST API lets you publish, schedule, and analyze social media posts across 8+ platforms from a single integration. No OAuth apps to maintain — PostBoost handles platform authorization for you.  ## Base URL All workspace-scoped endpoints are prefixed with `/{workspaceUuid}`. Panel/admin endpoints are prefixed with `/panel`.  ## Authentication All requests require a Bearer token in the `Authorization` header. Generate tokens in your PostBoost dashboard under **Settings → Access Tokens**.  ``` Authorization: Bearer YOUR_API_TOKEN ``` 
+#The PostBoost REST API lets you publish, schedule, and analyze social media posts across 12+ platforms from a single integration. No OAuth apps to maintain — PostBoost handles platform authorization for you.  ## Base URL All workspace-scoped endpoints are prefixed with `/{workspaceUuid}`. Panel/admin endpoints are prefixed with `/panel`.  ## Plan access Every workspace-scoped endpoint returns `403` when the workspace's plan does not include API access (capability `api`).  ## Dates and times Post dates and times (`date`, `time`, `accounts_schedule`) are read in the request's `timezone` when one is given, otherwise in the workspace timezone.  ## Authentication All requests require a Bearer token in the `Authorization` header. Generate tokens in your PostBoost dashboard under **Settings → Access Tokens**.  ``` Authorization: Bearer YOUR_API_TOKEN ``` 
 
-The version of the OpenAPI document: 1.0.0
+The version of the OpenAPI document: 1.8.0
 Contact: hi@postboost.co
 Generated by: https://openapi-generator.tech
 Generator version: 7.9.0
@@ -89,9 +89,13 @@ module PostBoost
     end
 
     # List accounts
-    # Returns all social media accounts connected to the workspace.
+    # Returns all social media accounts connected to the workspace, newest first. Optional filters narrow the list.
     # @param workspace_uuid [String] UUID of the workspace.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :keyword Match the account name or username.
+    # @option opts [String] :group Only accounts in this account group.
+    # @option opts [Array<String>] :providers Only accounts of these providers (for example &#x60;instagram&#x60;, &#x60;linkedin&#x60;).
+    # @option opts [Boolean] :unauthorized When &#x60;true&#x60;, only accounts that need to be reconnected.
     # @return [ListAccounts200Response]
     def list_accounts(workspace_uuid, opts = {})
       data, _status_code, _headers = list_accounts_with_http_info(workspace_uuid, opts)
@@ -99,9 +103,13 @@ module PostBoost
     end
 
     # List accounts
-    # Returns all social media accounts connected to the workspace.
+    # Returns all social media accounts connected to the workspace, newest first. Optional filters narrow the list.
     # @param workspace_uuid [String] UUID of the workspace.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :keyword Match the account name or username.
+    # @option opts [String] :group Only accounts in this account group.
+    # @option opts [Array<String>] :providers Only accounts of these providers (for example &#x60;instagram&#x60;, &#x60;linkedin&#x60;).
+    # @option opts [Boolean] :unauthorized When &#x60;true&#x60;, only accounts that need to be reconnected.
     # @return [Array<(ListAccounts200Response, Integer, Hash)>] ListAccounts200Response data, response status code and response headers
     def list_accounts_with_http_info(workspace_uuid, opts = {})
       if @api_client.config.debugging
@@ -116,6 +124,10 @@ module PostBoost
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'keyword'] = opts[:'keyword'] if !opts[:'keyword'].nil?
+      query_params[:'group'] = opts[:'group'] if !opts[:'group'].nil?
+      query_params[:'providers[]'] = @api_client.build_collection_param(opts[:'providers'], :multi) if !opts[:'providers'].nil?
+      query_params[:'unauthorized'] = opts[:'unauthorized'] if !opts[:'unauthorized'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}