postboost 1.0.0 → 1.14.0

data/lib/postboost/models/post_content.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
@@ -14,8 +14,9 @@ require 'date'
 require 'time'
 
 module PostBoost
+  # One item of a version's `content` array. The first item is always the post itself. What a second item means depends on the network:  - **Facebook Page, Instagram, LinkedIn** (profile and page): the second item's `body` is   published as the **first comment** under the post, right after the post goes live.   Only one comment is supported; further items are ignored. Facebook Stories take no comment. - **X, Threads, Bluesky, Mastodon, Pixelfed**: every additional item is published as the   next post of a **thread**, in order. - **All other networks** (YouTube, TikTok, Pinterest, Google Business Profile): only the   first item is published; additional items are ignored. 
   class PostContent
-    # Post text/caption.
+    # Post text/caption. For a second item on Facebook Page, Instagram or LinkedIn this is the first comment.
     attr_accessor :body
 
     attr_accessor :url

data/lib/postboost/models/post_input.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
@@ -28,8 +28,12 @@ module PostBoost
 
     attr_accessor :time
 
+    # Timezone `date`, `time` and `accounts_schedule` are read in. Defaults to the workspace timezone.
     attr_accessor :timezone
 
+    # Per-account departure times. When omitted on update, accounts keep their offsets from the post time.
+    attr_accessor :accounts_schedule
+
     # Schedule the post for the given date/time.
     attr_accessor :schedule
 
@@ -39,6 +43,12 @@ module PostBoost
     # Add to the smart publishing queue.
     attr_accessor :queue
 
+    # Declares the post AI-generated (or, with `false`, not). PostBoost sets each network's own AI label: TikTok's `is_aigc` for every TikTok account in `accounts`, Instagram's \"AI info\" label (`instagram.ai_generated`) and YouTube's synthetic-media disclosure (`youtube.contains_synthetic_media`). The other networks have no API label. The response carries `X-AI-Disclosure: applied` when every network with a label got it. When omitted, a post that attaches images made by the AI image endpoints is labelled automatically. See the AI disclosure guide. 
+    attr_accessor :ai_generated
+
+    # Skip the duplicate guard. By default the API refuses (`409`, `code: duplicate_post`) content that matches a post created for the same account in the last 24 hours. The header `X-Allow-Duplicate: true` does the same. 
+    attr_accessor :allow_duplicate
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -48,9 +58,12 @@ module PostBoost
         :'date' => :'date',
         :'time' => :'time',
         :'timezone' => :'timezone',
+        :'accounts_schedule' => :'accounts_schedule',
         :'schedule' => :'schedule',
         :'schedule_now' => :'schedule_now',
-        :'queue' => :'queue'
+        :'queue' => :'queue',
+        :'ai_generated' => :'ai_generated',
+        :'allow_duplicate' => :'allow_duplicate'
       }
     end
 
@@ -68,9 +81,12 @@ module PostBoost
         :'date' => :'Date',
         :'time' => :'String',
         :'timezone' => :'String',
+        :'accounts_schedule' => :'Array<AccountSchedule>',
         :'schedule' => :'Boolean',
         :'schedule_now' => :'Boolean',
-        :'queue' => :'Boolean'
+        :'queue' => :'Boolean',
+        :'ai_generated' => :'Boolean',
+        :'allow_duplicate' => :'Boolean'
       }
     end
 
@@ -127,6 +143,12 @@ module PostBoost
         self.timezone = attributes[:'timezone']
       end
 
+      if attributes.key?(:'accounts_schedule')
+        if (value = attributes[:'accounts_schedule']).is_a?(Array)
+          self.accounts_schedule = value
+        end
+      end
+
       if attributes.key?(:'schedule')
         self.schedule = attributes[:'schedule']
       end
@@ -138,6 +160,16 @@ module PostBoost
       if attributes.key?(:'queue')
         self.queue = attributes[:'queue']
       end
+
+      if attributes.key?(:'ai_generated')
+        self.ai_generated = attributes[:'ai_generated']
+      end
+
+      if attributes.key?(:'allow_duplicate')
+        self.allow_duplicate = attributes[:'allow_duplicate']
+      else
+        self.allow_duplicate = false
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -190,9 +222,12 @@ module PostBoost
           date == o.date &&
           time == o.time &&
           timezone == o.timezone &&
+          accounts_schedule == o.accounts_schedule &&
           schedule == o.schedule &&
           schedule_now == o.schedule_now &&
-          queue == o.queue
+          queue == o.queue &&
+          ai_generated == o.ai_generated &&
+          allow_duplicate == o.allow_duplicate
     end
 
     # @see the `==` method
@@ -204,7 +239,7 @@ module PostBoost
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [versions, accounts, tags, date, time, timezone, schedule, schedule_now, queue].hash
+      [versions, accounts, tags, date, time, timezone, accounts_schedule, schedule, schedule_now, queue, ai_generated, allow_duplicate].hash
     end
 
     # Builds the object from hash

data/lib/postboost/models/post_options_instagram.rb

@@ -0,0 +1,294 @@
+=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 'date'
+require 'time'
+
+module PostBoost
+  # Instagram options (`instagram` for accounts connected through Facebook, `instagram_standalone` for Instagram Login).
+  class PostOptionsInstagram
+    attr_accessor :type
+
+    # Usernames invited as collaborators (not for stories).
+    attr_accessor :collaborators
+
+    # Instagram's \"AI info\" label on the post (on the carousel itself for carousels; not for stories). Set by `ai_generated`.
+    attr_accessor :ai_generated
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'type' => :'type',
+        :'collaborators' => :'collaborators',
+        :'ai_generated' => :'ai_generated'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'type' => :'String',
+        :'collaborators' => :'Array<String>',
+        :'ai_generated' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `PostBoost::PostOptionsInstagram` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `PostBoost::PostOptionsInstagram`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = 'post'
+      end
+
+      if attributes.key?(:'collaborators')
+        if (value = attributes[:'collaborators']).is_a?(Array)
+          self.collaborators = value
+        end
+      end
+
+      if attributes.key?(:'ai_generated')
+        self.ai_generated = attributes[:'ai_generated']
+      else
+        self.ai_generated = false
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if !@collaborators.nil? && @collaborators.length > 3
+        invalid_properties.push('invalid value for "collaborators", number of items must be less than or equal to 3.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      type_validator = EnumAttributeValidator.new('String', ["post", "reel", "story"])
+      return false unless type_validator.valid?(@type)
+      return false if !@collaborators.nil? && @collaborators.length > 3
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["post", "reel", "story"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] collaborators Value to be assigned
+    def collaborators=(collaborators)
+      if collaborators.nil?
+        fail ArgumentError, 'collaborators cannot be nil'
+      end
+
+      if collaborators.length > 3
+        fail ArgumentError, 'invalid value for "collaborators", number of items must be less than or equal to 3.'
+      end
+
+      @collaborators = collaborators
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          type == o.type &&
+          collaborators == o.collaborators &&
+          ai_generated == o.ai_generated
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [type, collaborators, ai_generated].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = PostBoost.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end