postboost 1.0.0 → 1.14.0

data/spec/api/media_api_spec.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.  ## Idempotent requests Send an `Idempotency-Key` header (any unique string, for example a UUID) with a `POST`. Repeating the request with the same key within 24 hours returns the stored response with `Idempotent-Replayed: true` and creates nothing new. Reusing a key with a different body returns `422`; a request still in progress with the same key returns `409`. `5xx` and `429` responses are not stored, so they can be retried with the same key.  ## Guardrails for automated clients Create and update requests are checked before anything is written: a post whose content matches one created for the same account in the last 24 hours returns `409` (`code: duplicate_post`, override with `allow_duplicate: true`), scheduling past an account's daily cap returns `429` (`code: account_daily_cap_reached`), and scheduling to an account that must be reconnected returns `422` (`code: account_unauthorized` or `account_token_missing`). Use `POST /{workspaceUuid}/posts/validate` for a dry run and `GET /{workspaceUuid}/activity` to review what API clients did.  ## 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.14.0
 Contact: hi@postboost.co
 Generated by: https://openapi-generator.tech
 Generator version: 7.9.0
@@ -47,10 +47,11 @@ describe 'MediaApi' do
 
   # unit tests for complete_chunked_upload
   # Complete chunked upload
-  # Signal that all chunks have been uploaded. Returns the final media object.
+  # Signal that all chunks have been uploaded. Returns the final media object. A video may come back with `is_processing` set to `true` while its conversion runs.
   # @param workspace_uuid UUID of the workspace.
   # @param upload_uuid 
   # @param [Hash] opts the optional parameters
+  # @option opts [CompleteChunkedUploadRequest] :complete_chunked_upload_request 
   # @return [Media]
   describe 'complete_chunked_upload test' do
     it 'should work' do
@@ -58,9 +59,23 @@ describe 'MediaApi' do
     end
   end
 
+  # unit tests for create_media_folder
+  # Create media folder
+  # Creates a folder at the top level or under `parent`. The name must be unique among its siblings.
+  # @param workspace_uuid UUID of the workspace.
+  # @param create_media_folder_request 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :idempotency_key Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with `Idempotent-Replayed: true` and has no further effect. Keys are scoped to your user, the workspace, the method and the path. 
+  # @return [MediaFolder]
+  describe 'create_media_folder test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   # unit tests for delete_media_bulk
   # Delete media (bulk)
-  # Delete one or more media items by their IDs.
+  # Delete one or more media items by their numeric IDs or UUIDs (both may be mixed, up to 500 per request).
   # @param workspace_uuid UUID of the workspace.
   # @param delete_media_bulk_request 
   # @param [Hash] opts the optional parameters
@@ -71,6 +86,20 @@ describe 'MediaApi' do
     end
   end
 
+  # unit tests for delete_media_folder
+  # Delete media folder
+  # Deletes a folder. By default its media and sub-folders move up to the folder's parent; with `delete_media` set to true every media item below the folder is deleted as well.
+  # @param workspace_uuid UUID of the workspace.
+  # @param folder_uuid UUID of the media folder.
+  # @param [Hash] opts the optional parameters
+  # @option opts [DeleteMediaFolderRequest] :delete_media_folder_request 
+  # @return [Object]
+  describe 'delete_media_folder test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   # unit tests for get_media
   # Get media
   # Returns a single media asset.
@@ -103,7 +132,8 @@ describe 'MediaApi' do
   # @param workspace_uuid UUID of the workspace.
   # @param initiate_chunked_upload_request 
   # @param [Hash] opts the optional parameters
-  # @return [InitiateChunkedUpload200Response]
+  # @option opts [String] :idempotency_key Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with `Idempotent-Replayed: true` and has no further effect. Keys are scoped to your user, the workspace, the method and the path. 
+  # @return [InitiateChunkedUpload201Response]
   describe 'initiate_chunked_upload test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
@@ -116,7 +146,8 @@ describe 'MediaApi' do
   # @param workspace_uuid UUID of the workspace.
   # @param initiate_remote_upload_request 
   # @param [Hash] opts the optional parameters
-  # @return [InitiateRemoteUpload200Response]
+  # @option opts [String] :idempotency_key Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with `Idempotent-Replayed: true` and has no further effect. Keys are scoped to your user, the workspace, the method and the path. 
+  # @return [InitiateRemoteUpload201Response]
   describe 'initiate_remote_upload test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
@@ -125,10 +156,18 @@ describe 'MediaApi' do
 
   # unit tests for list_media
   # List media
-  # Returns a paginated list of media assets in the workspace library.
+  # Returns a paginated list of media assets in the workspace library. Without `folder` every item is listed, whatever folder it is filed in. A `keyword` search always looks at the whole library and ignores `folder` and `favorite`. 
   # @param workspace_uuid UUID of the workspace.
   # @param [Hash] opts the optional parameters
-  # @option opts [Integer] :page Page number (20 items per page).
+  # @option opts [Integer] :page Page number.
+  # @option opts [Integer] :limit Items per page. Values below 1 fall back to 50; values above 100 are capped at 100.
+  # @option opts [String] :folder Media folder UUID, or `root` for items not filed in any folder.
+  # @option opts [Array<String>] :mime_types Only these MIME types (for example &#x60;image/png&#x60;).
+  # @option opts [String] :type Only this media type.
+  # @option opts [String] :keyword Search media by name.
+  # @option opts [String] :usage Filter by how the media is used in posts.
+  # @option opts [Boolean] :favorite When &#x60;true&#x60;, only media the caller marked as favorite.
+  # @option opts [String] :sort 
   # @return [ListMedia200Response]
   describe 'list_media test' do
     it 'should work' do
@@ -136,9 +175,21 @@ describe 'MediaApi' do
     end
   end
 
+  # unit tests for list_media_folders
+  # List media folders
+  # Returns the whole folder tree of the media library in one response (not paginated). Rebuild the tree from each folder&#39;s &#x60;parent&#x60;.
+  # @param workspace_uuid UUID of the workspace.
+  # @param [Hash] opts the optional parameters
+  # @return [ListMediaFolders200Response]
+  describe 'list_media_folders test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   # unit tests for update_media
   # Update media
-  # Update the alt text of a media asset.
+  # Update the name, alt text, or folder of a media asset. Only the keys present in the body are written. Sending &#x60;folder: null&#x60; moves the item to the library root; omitting &#x60;folder&#x60; leaves it where it is. 
   # @param workspace_uuid UUID of the workspace.
   # @param media_uuid UUID of the media asset.
   # @param update_media_request 
@@ -150,6 +201,20 @@ describe 'MediaApi' do
     end
   end
 
+  # unit tests for update_media_folder
+  # Update media folder
+  # Renames a folder and/or moves it. Sending &#x60;parent&#x60; moves the folder (null &#x3D; top level); omitting it keeps the current parent. A folder cannot be moved into itself or one of its descendants.
+  # @param workspace_uuid UUID of the workspace.
+  # @param folder_uuid UUID of the media folder.
+  # @param media_folder_input 
+  # @param [Hash] opts the optional parameters
+  # @return [MediaFolder]
+  describe 'update_media_folder test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   # unit tests for upload_chunk
   # Upload a chunk
   # Upload a single chunk of a chunked upload session.
@@ -158,7 +223,7 @@ describe 'MediaApi' do
   # @param chunk 
   # @param chunk_index Zero-based index of this chunk.
   # @param [Hash] opts the optional parameters
-  # @return [UploadChunk200Response]
+  # @return [UploadChunk201Response]
   describe 'upload_chunk test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
@@ -167,11 +232,13 @@ describe 'MediaApi' do
 
   # unit tests for upload_media
   # Upload media (binary)
-  # Upload a file directly as multipart form data.
+  # Upload a file directly as multipart form data. Images and videos, plus a PDF (up to 100 MB) for LinkedIn document posts: a post that attaches a PDF must have it as the only media item and may only go to LinkedIn profiles and pages. 
   # @param workspace_uuid UUID of the workspace.
   # @param file The file to upload.
   # @param [Hash] opts the optional parameters
+  # @option opts [String] :idempotency_key Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with &#x60;Idempotent-Replayed: true&#x60; and has no further effect. Keys are scoped to your user, the workspace, the method and the path. 
   # @option opts [String] :alt_text Alternative text for accessibility.
+  # @option opts [String] :folder UUID of the media folder to file the upload in. Omit or null for the library root.
   # @return [Media]
   describe 'upload_media test' do
     it 'should work' do
@@ -179,4 +246,18 @@ describe 'MediaApi' do
     end
   end
 
+  # unit tests for upload_media_base64
+  # Upload media (base64 JSON)
+  # Upload a file as base64 inside a JSON body, for agents and tools that cannot send multipart form data. The decoded file is checked exactly like &#x60;POST media&#x60; (allowed types and size limits; a PDF is accepted for LinkedIn document posts). Decoded size is capped at 20 MB; for larger files use remote upload by URL or chunked upload. 
+  # @param workspace_uuid UUID of the workspace.
+  # @param media_base64_input 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :idempotency_key Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with &#x60;Idempotent-Replayed: true&#x60; and has no further effect. Keys are scoped to your user, the workspace, the method and the path. 
+  # @return [Media]
+  describe 'upload_media_base64 test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
 end

data/spec/api/mentions_api_spec.rb

@@ -0,0 +1,104 @@
+=begin
+#PostBoost API
+
+#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.  ## Idempotent requests Send an `Idempotency-Key` header (any unique string, for example a UUID) with a `POST`. Repeating the request with the same key within 24 hours returns the stored response with `Idempotent-Replayed: true` and creates nothing new. Reusing a key with a different body returns `422`; a request still in progress with the same key returns `409`. `5xx` and `429` responses are not stored, so they can be retried with the same key.  ## Guardrails for automated clients Create and update requests are checked before anything is written: a post whose content matches one created for the same account in the last 24 hours returns `409` (`code: duplicate_post`, override with `allow_duplicate: true`), scheduling past an account's daily cap returns `429` (`code: account_daily_cap_reached`), and scheduling to an account that must be reconnected returns `422` (`code: account_unauthorized` or `account_token_missing`). Use `POST /{workspaceUuid}/posts/validate` for a dry run and `GET /{workspaceUuid}/activity` to review what API clients did.  ## 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.14.0
+Contact: hi@postboost.co
+Generated by: https://openapi-generator.tech
+Generator version: 7.9.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for PostBoost::MentionsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'MentionsApi' do
+  before do
+    # run before each test
+    @api_instance = PostBoost::MentionsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of MentionsApi' do
+    it 'should create an instance of MentionsApi' do
+      expect(@api_instance).to be_instance_of(PostBoost::MentionsApi)
+    end
+  end
+
+  # unit tests for create_mention
+  # Create mention
+  # Adds a person or page to the mention book. When one of the submitted identities already belongs to a stored mention, that mention is reused and the identities are added to it (status `200` instead of `201`). 
+  # @param workspace_uuid UUID of the workspace.
+  # @param mention_input 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :idempotency_key Unique key (for example a UUID) that makes the request safe to retry. A repeat with the same key and body within 24 hours returns the stored response with `Idempotent-Replayed: true` and has no further effect. Keys are scoped to your user, the workspace, the method and the path. 
+  # @return [CreateMention201Response]
+  describe 'create_mention test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for delete_mention
+  # Delete mention
+  # Removes a mention from the mention book. `success` is false when nothing was deleted.
+  # @param workspace_uuid UUID of the workspace.
+  # @param mention_id The mention's `id` (a UUID).
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'delete_mention test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_mention
+  # Get mention
+  # Returns a single mention with its identities.
+  # @param workspace_uuid UUID of the workspace.
+  # @param mention_id The mention's `id` (a UUID).
+  # @param [Hash] opts the optional parameters
+  # @return [CreateMention201Response]
+  describe 'get_mention test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for list_mentions
+  # List mentions
+  # Returns a paginated list of the workspace's mention book, ranked, with each entry's network identities.
+  # @param workspace_uuid UUID of the workspace.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :q Search keyword.
+  # @option opts [Integer] :per_page 
+  # @option opts [Integer] :page 
+  # @return [ListMentions200Response]
+  describe 'list_mentions test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for update_mention
+  # Update mention
+  # Replaces the mention's name, avatar and identities. Identities for providers not in the payload are removed. An identity already held by another mention returns `422`.
+  # @param workspace_uuid UUID of the workspace.
+  # @param mention_id The mention's `id` (a UUID).
+  # @param mention_input 
+  # @param [Hash] opts the optional parameters
+  # @return [CreateMention201Response]
+  describe 'update_mention test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/posting_schedule_api_spec.rb

@@ -0,0 +1,102 @@
+=begin
+#PostBoost API
+
+#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.  ## Idempotent requests Send an `Idempotency-Key` header (any unique string, for example a UUID) with a `POST`. Repeating the request with the same key within 24 hours returns the stored response with `Idempotent-Replayed: true` and creates nothing new. Reusing a key with a different body returns `422`; a request still in progress with the same key returns `409`. `5xx` and `429` responses are not stored, so they can be retried with the same key.  ## Guardrails for automated clients Create and update requests are checked before anything is written: a post whose content matches one created for the same account in the last 24 hours returns `409` (`code: duplicate_post`, override with `allow_duplicate: true`), scheduling past an account's daily cap returns `429` (`code: account_daily_cap_reached`), and scheduling to an account that must be reconnected returns `422` (`code: account_unauthorized` or `account_token_missing`). Use `POST /{workspaceUuid}/posts/validate` for a dry run and `GET /{workspaceUuid}/activity` to review what API clients did.  ## 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.14.0
+Contact: hi@postboost.co
+Generated by: https://openapi-generator.tech
+Generator version: 7.9.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for PostBoost::PostingScheduleApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'PostingScheduleApi' do
+  before do
+    # run before each test
+    @api_instance = PostBoost::PostingScheduleApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of PostingScheduleApi' do
+    it 'should create an instance of PostingScheduleApi' do
+      expect(@api_instance).to be_instance_of(PostBoost::PostingScheduleApi)
+    end
+  end
+
+  # unit tests for get_posting_schedule
+  # Get the posting schedule
+  # The queue's posting times: per weekday, a list of clock times in the schedule's timezone. `account_id=0` is the workspace schedule. An account without its own schedule follows the workspace one (`inherited: true`, `source_account_id: 0`). Posts added to the queue take the next free time. 
+  # @param workspace_uuid UUID of the workspace.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :account_id `0` (default) for the workspace schedule, or an account `id`.
+  # @return [GetPostingSchedule200Response]
+  describe 'get_posting_schedule test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_recommended_posting_times
+  # Get recommended posting times
+  # Suggested posting times from past engagement, in the schedule's timezone. `has_data` is false until there is enough analytics history. 
+  # @param workspace_uuid UUID of the workspace.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :account_id `0` (default) for the workspace schedule, or an account `id`.
+  # @option opts [Integer] :slots_per_day Times to suggest per day (1 to 6).
+  # @return [RecommendedPostingTimes]
+  describe 'get_recommended_posting_times test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for list_queue_slots
+  # List upcoming queue slots
+  # The queue read forward: upcoming posting times, filled by scheduled posts where they land on one. Page with `after` set to the previous `next_cursor`. 
+  # @param workspace_uuid UUID of the workspace.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :account_id `0` (default) for the workspace schedule, or an account `id`.
+  # @option opts [String] :after Start after this time (`Y-m-d H:i:s`, UTC), from `next_cursor`.
+  # @return [QueueSlots]
+  describe 'list_queue_slots test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for reset_account_posting_schedule
+  # Reset an account schedule
+  # Removes the account's own schedule so it follows the workspace schedule again. Workspace admins only. 
+  # @param workspace_uuid UUID of the workspace.
+  # @param account_id The account `id`.
+  # @param [Hash] opts the optional parameters
+  # @return [GetPostingSchedule200Response]
+  describe 'reset_account_posting_schedule test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for update_posting_schedule
+  # Set the posting schedule
+  # Sets the workspace schedule (`account_id: 0`) or gives one account its own schedule. Send all seven weekdays (ids 1 to 6 for Monday to Saturday, 0 for Sunday). Workspace admins only. 
+  # @param workspace_uuid UUID of the workspace.
+  # @param posting_schedule_input 
+  # @param [Hash] opts the optional parameters
+  # @return [GetPostingSchedule200Response]
+  describe 'update_posting_schedule test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end