late-sdk 0.0.710 → 0.0.711

data/lib/zernio-sdk/models/instagram_audio_asset.rb

@@ -0,0 +1,293 @@
+=begin
+#Zernio API
+
+#API reference for Zernio. Authenticate with a Bearer API key. Base URL: https://zernio.com/api 
+
+The version of the OpenAPI document: 1.0.4
+Contact: support@zernio.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Zernio
+  # One asset from the Instagram audio catalog. Licensed music carries artist/artwork fields; original sounds carry creator fields instead, so most fields are nullable.
+  class InstagramAudioAsset < ApiModelBase
+    # Audio asset ID. Pass it as platformSpecificData.audioConfiguration.audioId when creating a Reel.
+    attr_accessor :audio_id
+
+    # Track or sound title.
+    attr_accessor :title
+
+    # Catalog type of the asset.
+    attr_accessor :audio_type
+
+    # Asset duration in milliseconds.
+    attr_accessor :duration_in_ms
+
+    # Artist name (licensed music only).
+    attr_accessor :display_artist
+
+    # Cover artwork thumbnail (licensed music only).
+    attr_accessor :cover_artwork_thumbnail_url
+
+    # Temporary preview URL. Meta expires it after roughly 1.5 days; re-fetch the asset to refresh it.
+    attr_accessor :download_url
+
+    # Creator username (original sounds only).
+    attr_accessor :ig_username
+
+    # Creator profile picture (original sounds only).
+    attr_accessor :profile_picture_url
+
+    # Whether the asset is eligible for ads use.
+    attr_accessor :is_ads_eligible
+
+    # Instagram web link to preview the audio.
+    attr_accessor :on_platform_audio_preview_link
+
+    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
+      {
+        :'audio_id' => :'audioId',
+        :'title' => :'title',
+        :'audio_type' => :'audioType',
+        :'duration_in_ms' => :'durationInMs',
+        :'display_artist' => :'displayArtist',
+        :'cover_artwork_thumbnail_url' => :'coverArtworkThumbnailUrl',
+        :'download_url' => :'downloadUrl',
+        :'ig_username' => :'igUsername',
+        :'profile_picture_url' => :'profilePictureUrl',
+        :'is_ads_eligible' => :'isAdsEligible',
+        :'on_platform_audio_preview_link' => :'onPlatformAudioPreviewLink'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'audio_id' => :'String',
+        :'title' => :'String',
+        :'audio_type' => :'String',
+        :'duration_in_ms' => :'Integer',
+        :'display_artist' => :'String',
+        :'cover_artwork_thumbnail_url' => :'String',
+        :'download_url' => :'String',
+        :'ig_username' => :'String',
+        :'profile_picture_url' => :'String',
+        :'is_ads_eligible' => :'Boolean',
+        :'on_platform_audio_preview_link' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'title',
+        :'audio_type',
+        :'duration_in_ms',
+        :'display_artist',
+        :'cover_artwork_thumbnail_url',
+        :'download_url',
+        :'ig_username',
+        :'profile_picture_url',
+        :'is_ads_eligible',
+        :'on_platform_audio_preview_link'
+      ])
+    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 `Zernio::InstagramAudioAsset` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Zernio::InstagramAudioAsset`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'audio_id')
+        self.audio_id = attributes[:'audio_id']
+      end
+
+      if attributes.key?(:'title')
+        self.title = attributes[:'title']
+      end
+
+      if attributes.key?(:'audio_type')
+        self.audio_type = attributes[:'audio_type']
+      end
+
+      if attributes.key?(:'duration_in_ms')
+        self.duration_in_ms = attributes[:'duration_in_ms']
+      end
+
+      if attributes.key?(:'display_artist')
+        self.display_artist = attributes[:'display_artist']
+      end
+
+      if attributes.key?(:'cover_artwork_thumbnail_url')
+        self.cover_artwork_thumbnail_url = attributes[:'cover_artwork_thumbnail_url']
+      end
+
+      if attributes.key?(:'download_url')
+        self.download_url = attributes[:'download_url']
+      end
+
+      if attributes.key?(:'ig_username')
+        self.ig_username = attributes[:'ig_username']
+      end
+
+      if attributes.key?(:'profile_picture_url')
+        self.profile_picture_url = attributes[:'profile_picture_url']
+      end
+
+      if attributes.key?(:'is_ads_eligible')
+        self.is_ads_eligible = attributes[:'is_ads_eligible']
+      end
+
+      if attributes.key?(:'on_platform_audio_preview_link')
+        self.on_platform_audio_preview_link = attributes[:'on_platform_audio_preview_link']
+      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
+      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'
+      audio_type_validator = EnumAttributeValidator.new('String', ["music", "original_sound"])
+      return false unless audio_type_validator.valid?(@audio_type)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] audio_type Object to be assigned
+    def audio_type=(audio_type)
+      validator = EnumAttributeValidator.new('String', ["music", "original_sound"])
+      unless validator.valid?(audio_type)
+        fail ArgumentError, "invalid value for \"audio_type\", must be one of #{validator.allowable_values}."
+      end
+      @audio_type = audio_type
+    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 &&
+          audio_id == o.audio_id &&
+          title == o.title &&
+          audio_type == o.audio_type &&
+          duration_in_ms == o.duration_in_ms &&
+          display_artist == o.display_artist &&
+          cover_artwork_thumbnail_url == o.cover_artwork_thumbnail_url &&
+          download_url == o.download_url &&
+          ig_username == o.ig_username &&
+          profile_picture_url == o.profile_picture_url &&
+          is_ads_eligible == o.is_ads_eligible &&
+          on_platform_audio_preview_link == o.on_platform_audio_preview_link
+    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
+      [audio_id, title, audio_type, duration_in_ms, display_artist, cover_artwork_thumbnail_url, download_url, ig_username, profile_picture_url, is_ads_eligible, on_platform_audio_preview_link].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
+
+    # 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
+
+  end
+
+end

data/lib/zernio-sdk/models/instagram_platform_data.rb

@@ -33,9 +33,11 @@ module Zernio
     # Tag Instagram users by username. The tag shape depends on the media: photos require x/y coordinates, Reels and videos take username only (coordinates are ignored), stories accept optional coordinates. For carousels, use mediaIndex to target specific slides (defaults to 0); video slides take username-only tags. Photo tags without valid coordinates are skipped.
     attr_accessor :user_tags
 
-    # Custom name for original audio in Reels. Replaces the default \"Original Audio\" label. Can only be set once.
+    # Custom name for original audio in Reels. Replaces the default \"Original Audio\" label. Can only be set once. Unrelated to audioConfiguration, which attaches a catalog track.
     attr_accessor :audio_name
 
+    attr_accessor :audio_configuration
+
     # Millisecond offset from video start for the Reel cover frame. Ignored when instagramThumbnail or reelCover is provided. Defaults to 0.
     attr_accessor :thumb_offset
 
@@ -80,6 +82,7 @@ module Zernio
         :'trial_params' => :'trialParams',
         :'user_tags' => :'userTags',
         :'audio_name' => :'audioName',
+        :'audio_configuration' => :'audioConfiguration',
         :'thumb_offset' => :'thumbOffset',
         :'instagram_thumbnail' => :'instagramThumbnail',
         :'reel_cover' => :'reelCover',
@@ -107,6 +110,7 @@ module Zernio
         :'trial_params' => :'InstagramPlatformDataTrialParams',
         :'user_tags' => :'Array<InstagramPlatformDataUserTagsInner>',
         :'audio_name' => :'String',
+        :'audio_configuration' => :'InstagramPlatformDataAudioConfiguration',
         :'thumb_offset' => :'Integer',
         :'instagram_thumbnail' => :'String',
         :'reel_cover' => :'String',
@@ -170,6 +174,10 @@ module Zernio
         self.audio_name = attributes[:'audio_name']
       end
 
+      if attributes.key?(:'audio_configuration')
+        self.audio_configuration = attributes[:'audio_configuration']
+      end
+
       if attributes.key?(:'thumb_offset')
         self.thumb_offset = attributes[:'thumb_offset']
       end
@@ -247,6 +255,7 @@ module Zernio
           trial_params == o.trial_params &&
           user_tags == o.user_tags &&
           audio_name == o.audio_name &&
+          audio_configuration == o.audio_configuration &&
           thumb_offset == o.thumb_offset &&
           instagram_thumbnail == o.instagram_thumbnail &&
           reel_cover == o.reel_cover &&
@@ -262,7 +271,7 @@ module Zernio
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [content_type, share_to_feed, collaborators, first_comment, trial_params, user_tags, audio_name, thumb_offset, instagram_thumbnail, reel_cover, is_ai_generated].hash
+      [content_type, share_to_feed, collaborators, first_comment, trial_params, user_tags, audio_name, audio_configuration, thumb_offset, instagram_thumbnail, reel_cover, is_ai_generated].hash
     end
 
     # Builds the object from hash

data/lib/zernio-sdk/models/instagram_platform_data_audio_configuration.rb

@@ -0,0 +1,242 @@
+=begin
+#Zernio API
+
+#API reference for Zernio. Authenticate with a Bearer API key. Base URL: https://zernio.com/api 
+
+The version of the OpenAPI document: 1.0.4
+Contact: support@zernio.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Zernio
+  # Attach a licensed music track or original sound from the Instagram audio catalog to a Reel. Reels only (single video post, not a story or image). Requires an Instagram account connected via Facebook Login; classic Instagram Login accounts get a 400 (instagram_audio_requires_facebook_login). Get audio IDs from GET /v1/accounts/{accountId}/instagram/audio. If the track becomes unavailable by publish time (removed, region-blocked, licensing change), the post fails with a user-error; it is not published without the audio.
+  class InstagramPlatformDataAudioConfiguration < ApiModelBase
+    # Audio asset ID from the audio search endpoint.
+    attr_accessor :audio_id
+
+    # Volume of the attached audio track, 0-100. Defaults to 100.
+    attr_accessor :audio_volume
+
+    # Volume of the video's own sound, 0-100. Defaults to 100. Set 0 to mute the original video audio.
+    attr_accessor :video_volume
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'audio_id' => :'audioId',
+        :'audio_volume' => :'audioVolume',
+        :'video_volume' => :'videoVolume'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'audio_id' => :'String',
+        :'audio_volume' => :'Integer',
+        :'video_volume' => :'Integer'
+      }
+    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 `Zernio::InstagramPlatformDataAudioConfiguration` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Zernio::InstagramPlatformDataAudioConfiguration`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'audio_id')
+        self.audio_id = attributes[:'audio_id']
+      else
+        self.audio_id = nil
+      end
+
+      if attributes.key?(:'audio_volume')
+        self.audio_volume = attributes[:'audio_volume']
+      end
+
+      if attributes.key?(:'video_volume')
+        self.video_volume = attributes[:'video_volume']
+      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 @audio_id.nil?
+        invalid_properties.push('invalid value for "audio_id", audio_id cannot be nil.')
+      end
+
+      if !@audio_volume.nil? && @audio_volume > 100
+        invalid_properties.push('invalid value for "audio_volume", must be smaller than or equal to 100.')
+      end
+
+      if !@audio_volume.nil? && @audio_volume < 0
+        invalid_properties.push('invalid value for "audio_volume", must be greater than or equal to 0.')
+      end
+
+      if !@video_volume.nil? && @video_volume > 100
+        invalid_properties.push('invalid value for "video_volume", must be smaller than or equal to 100.')
+      end
+
+      if !@video_volume.nil? && @video_volume < 0
+        invalid_properties.push('invalid value for "video_volume", must be greater than or equal to 0.')
+      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 @audio_id.nil?
+      return false if !@audio_volume.nil? && @audio_volume > 100
+      return false if !@audio_volume.nil? && @audio_volume < 0
+      return false if !@video_volume.nil? && @video_volume > 100
+      return false if !@video_volume.nil? && @video_volume < 0
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] audio_id Value to be assigned
+    def audio_id=(audio_id)
+      if audio_id.nil?
+        fail ArgumentError, 'audio_id cannot be nil'
+      end
+
+      @audio_id = audio_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] audio_volume Value to be assigned
+    def audio_volume=(audio_volume)
+      if audio_volume.nil?
+        fail ArgumentError, 'audio_volume cannot be nil'
+      end
+
+      if audio_volume > 100
+        fail ArgumentError, 'invalid value for "audio_volume", must be smaller than or equal to 100.'
+      end
+
+      if audio_volume < 0
+        fail ArgumentError, 'invalid value for "audio_volume", must be greater than or equal to 0.'
+      end
+
+      @audio_volume = audio_volume
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] video_volume Value to be assigned
+    def video_volume=(video_volume)
+      if video_volume.nil?
+        fail ArgumentError, 'video_volume cannot be nil'
+      end
+
+      if video_volume > 100
+        fail ArgumentError, 'invalid value for "video_volume", must be smaller than or equal to 100.'
+      end
+
+      if video_volume < 0
+        fail ArgumentError, 'invalid value for "video_volume", must be greater than or equal to 0.'
+      end
+
+      @video_volume = video_volume
+    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 &&
+          audio_id == o.audio_id &&
+          audio_volume == o.audio_volume &&
+          video_volume == o.video_volume
+    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
+      [audio_id, audio_volume, video_volume].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
+
+    # 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
+
+  end
+
+end