Class: Zernio::TikTokPlatformDataMusicSoundInfo

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/zernio-sdk/models/tik_tok_platform_data_music_sound_info.rb

Overview

Commercial Music Library track to attach. Accounts connected through the TikTok for Business app only: a developer-app account rejects the post at publish time with a message that says so. Pick musicSoundId from GET /v1/accounts/accountId/tiktok/commercial-music. Ignored on drafts, where TikTok ignores every post_info field.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ TikTokPlatformDataMusicSoundInfo

Initializes the object



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/zernio-sdk/models/tik_tok_platform_data_music_sound_info.rb', line 69

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Zernio::TikTokPlatformDataMusicSoundInfo` 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::TikTokPlatformDataMusicSoundInfo`. 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?(:'music_sound_id')
    self.music_sound_id = attributes[:'music_sound_id']
  else
    self.music_sound_id = nil
  end

  if attributes.key?(:'music_sound_volume')
    self.music_sound_volume = attributes[:'music_sound_volume']
  else
    self.music_sound_volume = 50
  end

  if attributes.key?(:'music_sound_start')
    self.music_sound_start = attributes[:'music_sound_start']
  end

  if attributes.key?(:'music_sound_end')
    self.music_sound_end = attributes[:'music_sound_end']
  end
end

Instance Attribute Details

#music_sound_end ⇒ Object

End point of the track in milliseconds (default: the video length). Must be greater than musicSoundStart. Video posts only.



29
30
31
 
# File 'lib/zernio-sdk/models/tik_tok_platform_data_music_sound_info.rb', line 29

def music_sound_end
  @music_sound_end
end

#music_sound_id ⇒ Object

The id field of a track from GET /v1/accounts/accountId/tiktok/commercial-music (a song clip id). TikTok fails the publish with a generic 51065 when given the commercial music id instead.



20
21
22
 
# File 'lib/zernio-sdk/models/tik_tok_platform_data_music_sound_info.rb', line 20

def music_sound_id
  @music_sound_id
end

#music_sound_start ⇒ Object

Start point of the track in milliseconds (default 0). Video posts only.



26
27
28
 
# File 'lib/zernio-sdk/models/tik_tok_platform_data_music_sound_info.rb', line 26

def music_sound_start
  @music_sound_start
end

#music_sound_volume ⇒ Object

Track volume. TikTok defaults an omitted volume to 0, which publishes the track silently, so we default to the app's 50. Video posts only.



23
24
25
 
# File 'lib/zernio-sdk/models/tik_tok_platform_data_music_sound_info.rb', line 23

def music_sound_volume
  @music_sound_volume
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



42
43
44
 
# File 'lib/zernio-sdk/models/tik_tok_platform_data_music_sound_info.rb', line 42

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



47
48
49
 
# File 'lib/zernio-sdk/models/tik_tok_platform_data_music_sound_info.rb', line 47

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



32
33
34
35
36
37
38
39
 
# File 'lib/zernio-sdk/models/tik_tok_platform_data_music_sound_info.rb', line 32

def self.attribute_map
  {
    :'music_sound_id' => :'musicSoundId',
    :'music_sound_volume' => :'musicSoundVolume',
    :'music_sound_start' => :'musicSoundStart',
    :'music_sound_end' => :'musicSoundEnd'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/zernio-sdk/models/tik_tok_platform_data_music_sound_info.rb', line 226

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



62
63
64
65
 
# File 'lib/zernio-sdk/models/tik_tok_platform_data_music_sound_info.rb', line 62

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



52
53
54
55
56
57
58
59
 
# File 'lib/zernio-sdk/models/tik_tok_platform_data_music_sound_info.rb', line 52

def self.openapi_types
  {
    :'music_sound_id' => :'String',
    :'music_sound_volume' => :'Integer',
    :'music_sound_start' => :'Integer',
    :'music_sound_end' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



202
203
204
205
206
207
208
209
 
# File 'lib/zernio-sdk/models/tik_tok_platform_data_music_sound_info.rb', line 202

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      music_sound_id == o.music_sound_id &&
      music_sound_volume == o.music_sound_volume &&
      music_sound_start == o.music_sound_start &&
      music_sound_end == o.music_sound_end
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


213
214
215
 
# File 'lib/zernio-sdk/models/tik_tok_platform_data_music_sound_info.rb', line 213

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



219
220
221
 
# File 'lib/zernio-sdk/models/tik_tok_platform_data_music_sound_info.rb', line 219

def hash
  [music_sound_id, music_sound_volume, music_sound_start, music_sound_end].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/zernio-sdk/models/tik_tok_platform_data_music_sound_info.rb', line 106

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @music_sound_id.nil?
    invalid_properties.push('invalid value for "music_sound_id", music_sound_id cannot be nil.')
  end

  if !@music_sound_volume.nil? && @music_sound_volume > 100
    invalid_properties.push('invalid value for "music_sound_volume", must be smaller than or equal to 100.')
  end

  if !@music_sound_volume.nil? && @music_sound_volume < 0
    invalid_properties.push('invalid value for "music_sound_volume", must be greater than or equal to 0.')
  end

  if !@music_sound_start.nil? && @music_sound_start < 0
    invalid_properties.push('invalid value for "music_sound_start", must be greater than or equal to 0.')
  end

  if !@music_sound_end.nil? && @music_sound_end < 0
    invalid_properties.push('invalid value for "music_sound_end", must be greater than or equal to 0.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash



248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/zernio-sdk/models/tik_tok_platform_data_music_sound_info.rb', line 248

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

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



134
135
136
137
138
139
140
141
142
 
# File 'lib/zernio-sdk/models/tik_tok_platform_data_music_sound_info.rb', line 134

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @music_sound_id.nil?
  return false if !@music_sound_volume.nil? && @music_sound_volume > 100
  return false if !@music_sound_volume.nil? && @music_sound_volume < 0
  return false if !@music_sound_start.nil? && @music_sound_start < 0
  return false if !@music_sound_end.nil? && @music_sound_end < 0
  true
end