Class: Zernio::RecyclingConfig

Inherits:
ApiModelBase show all
Defined in:
lib/zernio-sdk/models/recycling_config.rb

Overview

Configure automatic post recycling (reposting at regular intervals). After the post is published, the system creates new scheduled copies at the specified interval until expiration conditions are met. Supports weekly or monthly intervals. Maximum 10 active recycling posts per account. YouTube and TikTok platforms are excluded from recycling. Content variations are recommended for Twitter and Pinterest to avoid duplicate flags.

Defined Under Namespace

Classes: EnumAttributeValidator

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 = {}) ⇒ RecyclingConfig

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/zernio-sdk/models/recycling_config.rb', line 108

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

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

  if attributes.key?(:'gap_freq')
    self.gap_freq = attributes[:'gap_freq']
  else
    self.gap_freq = 'month'
  end

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

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

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

  if attributes.key?(:'content_variations')
    if (value = attributes[:'content_variations']).is_a?(Array)
      self.content_variations = value
    end
  end
end

Instance Attribute Details

#content_variations ⇒ Object

Array of content variations for recycled copies. On each recycle, the next variation is used in round-robin order. Recommended for Twitter and Pinterest to avoid duplicate content flags. If omitted, the original post content is used for all recycled copies. Send an empty array [] to clear existing variations. Must have 2+ entries when setting variations. Platform-level customContent still overrides the base content per platform.



38
39
40
 
# File 'lib/zernio-sdk/models/recycling_config.rb', line 38

def content_variations
  @content_variations
end

#enabled ⇒ Object

Set to false to disable recycling on this post



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

def enabled
  @enabled
end

#expire_count ⇒ Object

Stop recycling after this many copies have been created. Send null on update to clear this limit.



32
33
34
 
# File 'lib/zernio-sdk/models/recycling_config.rb', line 32

def expire_count
  @expire_count
end

#expire_date ⇒ Object

Stop recycling after this date, regardless of count. Send null on update to clear this limit.



35
36
37
 
# File 'lib/zernio-sdk/models/recycling_config.rb', line 35

def expire_date
  @expire_date
end

#gap ⇒ Object

Number of interval units between each repost. Required when enabling recycling.



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

def gap
  @gap
end

#gap_freq ⇒ Object

Interval unit for the gap. Defaults to 'month'.



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

def gap_freq
  @gap_freq
end

#start_date ⇒ Object

When to start the recycling cycle. Defaults to the post's scheduledFor date.



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

def start_date
  @start_date
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



76
77
78
 
# File 'lib/zernio-sdk/models/recycling_config.rb', line 76

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



81
82
83
 
# File 'lib/zernio-sdk/models/recycling_config.rb', line 81

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/zernio-sdk/models/recycling_config.rb', line 63

def self.attribute_map
  {
    :'enabled' => :'enabled',
    :'gap' => :'gap',
    :'gap_freq' => :'gapFreq',
    :'start_date' => :'startDate',
    :'expire_count' => :'expireCount',
    :'expire_date' => :'expireDate',
    :'content_variations' => :'contentVariations'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/zernio-sdk/models/recycling_config.rb', line 266

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



99
100
101
102
103
104
 
# File 'lib/zernio-sdk/models/recycling_config.rb', line 99

def self.openapi_nullable
  Set.new([
    :'expire_count',
    :'expire_date',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/zernio-sdk/models/recycling_config.rb', line 86

def self.openapi_types
  {
    :'enabled' => :'Boolean',
    :'gap' => :'Integer',
    :'gap_freq' => :'String',
    :'start_date' => :'Time',
    :'expire_count' => :'Integer',
    :'expire_date' => :'Time',
    :'content_variations' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/zernio-sdk/models/recycling_config.rb', line 239

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      enabled == o.enabled &&
      gap == o.gap &&
      gap_freq == o.gap_freq &&
      start_date == o.start_date &&
      expire_count == o.expire_count &&
      expire_date == o.expire_date &&
      content_variations == o.content_variations
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


253
254
255
 
# File 'lib/zernio-sdk/models/recycling_config.rb', line 253

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



259
260
261
 
# File 'lib/zernio-sdk/models/recycling_config.rb', line 259

def hash
  [enabled, gap, gap_freq, start_date, expire_count, expire_date, content_variations].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/zernio-sdk/models/recycling_config.rb', line 159

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@gap.nil? && @gap < 1
    invalid_properties.push('invalid value for "gap", must be greater than or equal to 1.')
  end

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

  if !@content_variations.nil? && @content_variations.length > 20
    invalid_properties.push('invalid value for "content_variations", number of items must be less than or equal to 20.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/zernio-sdk/models/recycling_config.rb', line 288

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

Returns:

  • (Boolean) —

    true if the model is valid



179
180
181
182
183
184
185
186
187
 
# File 'lib/zernio-sdk/models/recycling_config.rb', line 179

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@gap.nil? && @gap < 1
  gap_freq_validator = EnumAttributeValidator.new('String', ["week", "month"])
  return false unless gap_freq_validator.valid?(@gap_freq)
  return false if !@expire_count.nil? && @expire_count < 1
  return false if !@content_variations.nil? && @content_variations.length > 20
  true
end