postboost 1.0.0 → 1.8.0

data/lib/postboost/models/account.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
@@ -32,6 +32,15 @@ module PostBoost
 
     attr_accessor :authorized
 
+    # Public URL of the account's profile on the network, when known.
+    attr_accessor :profile_url
+
+    # Only present when the account is embedded in a post. Publishing state of this account for the post.
+    attr_accessor :publish_status
+
+    # Only present when the account is embedded in a post. How many parts (for example thread items or a first comment) are live on the network.
+    attr_accessor :published_parts
+
     attr_accessor :created_at
 
     class EnumAttributeValidator
@@ -67,6 +76,9 @@ module PostBoost
         :'provider' => :'provider',
         :'data' => :'data',
         :'authorized' => :'authorized',
+        :'profile_url' => :'profile_url',
+        :'publish_status' => :'publish_status',
+        :'published_parts' => :'published_parts',
         :'created_at' => :'created_at'
       }
     end
@@ -87,6 +99,9 @@ module PostBoost
         :'provider' => :'String',
         :'data' => :'Object',
         :'authorized' => :'Boolean',
+        :'profile_url' => :'String',
+        :'publish_status' => :'String',
+        :'published_parts' => :'Integer',
         :'created_at' => :'Time'
       }
     end
@@ -114,18 +129,26 @@ module PostBoost
 
       if attributes.key?(:'id')
         self.id = attributes[:'id']
+      else
+        self.id = nil
       end
 
       if attributes.key?(:'uuid')
         self.uuid = attributes[:'uuid']
+      else
+        self.uuid = nil
       end
 
       if attributes.key?(:'name')
         self.name = attributes[:'name']
+      else
+        self.name = nil
       end
 
       if attributes.key?(:'username')
         self.username = attributes[:'username']
+      else
+        self.username = nil
       end
 
       if attributes.key?(:'image')
@@ -134,18 +157,38 @@ module PostBoost
 
       if attributes.key?(:'provider')
         self.provider = attributes[:'provider']
+      else
+        self.provider = nil
       end
 
       if attributes.key?(:'data')
         self.data = attributes[:'data']
+      else
+        self.data = nil
       end
 
       if attributes.key?(:'authorized')
         self.authorized = attributes[:'authorized']
+      else
+        self.authorized = nil
+      end
+
+      if attributes.key?(:'profile_url')
+        self.profile_url = attributes[:'profile_url']
+      end
+
+      if attributes.key?(:'publish_status')
+        self.publish_status = attributes[:'publish_status']
+      end
+
+      if attributes.key?(:'published_parts')
+        self.published_parts = attributes[:'published_parts']
       end
 
       if attributes.key?(:'created_at')
         self.created_at = attributes[:'created_at']
+      else
+        self.created_at = nil
       end
     end
 
@@ -154,6 +197,42 @@ module PostBoost
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @uuid.nil?
+        invalid_properties.push('invalid value for "uuid", uuid cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @username.nil?
+        invalid_properties.push('invalid value for "username", username cannot be nil.')
+      end
+
+      if @provider.nil?
+        invalid_properties.push('invalid value for "provider", provider cannot be nil.')
+      end
+
+      if @data.nil?
+        invalid_properties.push('invalid value for "data", data cannot be nil.')
+      end
+
+      if @authorized.nil?
+        invalid_properties.push('invalid value for "authorized", authorized cannot be nil.')
+      end
+
+      if !@published_parts.nil? && @published_parts < 0
+        invalid_properties.push('invalid value for "published_parts", must be greater than or equal to 0.')
+      end
+
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -161,8 +240,19 @@ module PostBoost
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @id.nil?
+      return false if @uuid.nil?
+      return false if @name.nil?
+      return false if @username.nil?
+      return false if @provider.nil?
       provider_validator = EnumAttributeValidator.new('String', ["instagram", "tiktok", "pinterest", "twitter", "linkedin", "facebook_page", "youtube", "mastodon"])
       return false unless provider_validator.valid?(@provider)
+      return false if @data.nil?
+      return false if @authorized.nil?
+      publish_status_validator = EnumAttributeValidator.new('String', ["pending", "publishing", "published", "failed"])
+      return false unless publish_status_validator.valid?(@publish_status)
+      return false if !@published_parts.nil? && @published_parts < 0
+      return false if @created_at.nil?
       true
     end
 
@@ -176,6 +266,30 @@ module PostBoost
       @provider = provider
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] publish_status Object to be assigned
+    def publish_status=(publish_status)
+      validator = EnumAttributeValidator.new('String', ["pending", "publishing", "published", "failed"])
+      unless validator.valid?(publish_status)
+        fail ArgumentError, "invalid value for \"publish_status\", must be one of #{validator.allowable_values}."
+      end
+      @publish_status = publish_status
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] published_parts Value to be assigned
+    def published_parts=(published_parts)
+      if published_parts.nil?
+        fail ArgumentError, 'published_parts cannot be nil'
+      end
+
+      if published_parts < 0
+        fail ArgumentError, 'invalid value for "published_parts", must be greater than or equal to 0.'
+      end
+
+      @published_parts = published_parts
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -189,6 +303,9 @@ module PostBoost
           provider == o.provider &&
           data == o.data &&
           authorized == o.authorized &&
+          profile_url == o.profile_url &&
+          publish_status == o.publish_status &&
+          published_parts == o.published_parts &&
           created_at == o.created_at
     end
 
@@ -201,7 +318,7 @@ module PostBoost
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, uuid, name, username, image, provider, data, authorized, created_at].hash
+      [id, uuid, name, username, image, provider, data, authorized, profile_url, publish_status, published_parts, created_at].hash
     end
 
     # Builds the object from hash

data/lib/postboost/models/account_analytics.rb

@@ -0,0 +1,308 @@
+=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.  ## 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.8.0
+Contact: hi@postboost.co
+Generated by: https://openapi-generator.tech
+Generator version: 7.9.0
+
+=end
+
+require 'date'
+require 'time'
+
+module PostBoost
+  class AccountAnalytics
+    attr_accessor :account
+
+    # The analytics tab returned.
+    attr_accessor :type
+
+    # Tabs this account supports; any of them can be passed as `type`.
+    attr_accessor :tabs
+
+    attr_accessor :period
+
+    attr_accessor :initial_sync
+
+    # Provider- and tab-specific metrics. Chart series are lists of `{date, value}` points.
+    attr_accessor :data
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'account' => :'account',
+        :'type' => :'type',
+        :'tabs' => :'tabs',
+        :'period' => :'period',
+        :'initial_sync' => :'initial_sync',
+        :'data' => :'data'
+      }
+    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
+      {
+        :'account' => :'Account',
+        :'type' => :'String',
+        :'tabs' => :'Array<String>',
+        :'period' => :'AnalyticsPeriod',
+        :'initial_sync' => :'AccountAnalyticsInitialSync',
+        :'data' => :'Hash<String, Object>'
+      }
+    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::AccountAnalytics` 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::AccountAnalytics`. 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?(:'account')
+        self.account = attributes[:'account']
+      else
+        self.account = nil
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = nil
+      end
+
+      if attributes.key?(:'tabs')
+        if (value = attributes[:'tabs']).is_a?(Array)
+          self.tabs = value
+        end
+      else
+        self.tabs = nil
+      end
+
+      if attributes.key?(:'period')
+        self.period = attributes[:'period']
+      else
+        self.period = nil
+      end
+
+      if attributes.key?(:'initial_sync')
+        self.initial_sync = attributes[:'initial_sync']
+      else
+        self.initial_sync = nil
+      end
+
+      if attributes.key?(:'data')
+        if (value = attributes[:'data']).is_a?(Hash)
+          self.data = value
+        end
+      else
+        self.data = nil
+      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 @account.nil?
+        invalid_properties.push('invalid value for "account", account cannot be nil.')
+      end
+
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @tabs.nil?
+        invalid_properties.push('invalid value for "tabs", tabs cannot be nil.')
+      end
+
+      if @period.nil?
+        invalid_properties.push('invalid value for "period", period cannot be nil.')
+      end
+
+      if @initial_sync.nil?
+        invalid_properties.push('invalid value for "initial_sync", initial_sync cannot be nil.')
+      end
+
+      if @data.nil?
+        invalid_properties.push('invalid value for "data", data cannot be nil.')
+      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'
+      return false if @account.nil?
+      return false if @type.nil?
+      return false if @tabs.nil?
+      return false if @period.nil?
+      return false if @initial_sync.nil?
+      return false if @data.nil?
+      true
+    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 &&
+          account == o.account &&
+          type == o.type &&
+          tabs == o.tabs &&
+          period == o.period &&
+          initial_sync == o.initial_sync &&
+          data == o.data
+    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
+      [account, type, tabs, period, initial_sync, data].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