Class: Zernio::PostPublishIncompleteResponse

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

Overview

Body of the 207 returned by createPost and updatePost when the post was saved but the inline publish did not fully succeed. Read post.status to tell the three outcomes apart.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
103
104
105
106
107
108
109
110
 
# File 'lib/zernio-sdk/models/post_publish_incomplete_response.rb', line 73

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

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

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

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

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

Instance Attribute Details

#error ⇒ Object

Present when no platform published. Absent on a partial success. Informational only; the per-platform detail is in platformResults and in post.platforms[].



25
26
27
 
# File 'lib/zernio-sdk/models/post_publish_incomplete_response.rb', line 25

def error
  @error
end

#message ⇒ Object

Human-readable summary of the publish outcome.



22
23
24
 
# File 'lib/zernio-sdk/models/post_publish_incomplete_response.rb', line 22

def message
  @message
end

#platform_results ⇒ Object

Per-platform outcome of the publish attempt. Omitted when the attempt aborted before producing per-platform results (for example the post was already being processed); read post.platforms[] in that case.



28
29
30
 
# File 'lib/zernio-sdk/models/post_publish_incomplete_response.rb', line 28

def platform_results
  @platform_results
end

#post ⇒ Object

Returns the value of attribute post.



19
20
21
 
# File 'lib/zernio-sdk/models/post_publish_incomplete_response.rb', line 19

def post
  @post
end

#warnings ⇒ Object

Advisory notices about the post that was still created. Absent when there are none.



31
32
33
 
# File 'lib/zernio-sdk/models/post_publish_incomplete_response.rb', line 31

def warnings
  @warnings
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



45
46
47
 
# File 'lib/zernio-sdk/models/post_publish_incomplete_response.rb', line 45

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



50
51
52
 
# File 'lib/zernio-sdk/models/post_publish_incomplete_response.rb', line 50

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
42
 
# File 'lib/zernio-sdk/models/post_publish_incomplete_response.rb', line 34

def self.attribute_map
  {
    :'post' => :'post',
    :'message' => :'message',
    :'error' => :'error',
    :'platform_results' => :'platformResults',
    :'warnings' => :'warnings'
  }
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



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/zernio-sdk/models/post_publish_incomplete_response.rb', line 154

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



66
67
68
69
 
# File 'lib/zernio-sdk/models/post_publish_incomplete_response.rb', line 66

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

.openapi_types ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
62
63
 
# File 'lib/zernio-sdk/models/post_publish_incomplete_response.rb', line 55

def self.openapi_types
  {
    :'post' => :'Post',
    :'message' => :'String',
    :'error' => :'String',
    :'platform_results' => :'Array<PostPublishIncompleteResponsePlatformResultsInner>',
    :'warnings' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



129
130
131
132
133
134
135
136
137
 
# File 'lib/zernio-sdk/models/post_publish_incomplete_response.rb', line 129

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      post == o.post &&
      message == o.message &&
      error == o.error &&
      platform_results == o.platform_results &&
      warnings == o.warnings
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


141
142
143
 
# File 'lib/zernio-sdk/models/post_publish_incomplete_response.rb', line 141

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



147
148
149
 
# File 'lib/zernio-sdk/models/post_publish_incomplete_response.rb', line 147

def hash
  [post, message, error, platform_results, warnings].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



114
115
116
117
118
 
# File 'lib/zernio-sdk/models/post_publish_incomplete_response.rb', line 114

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/zernio-sdk/models/post_publish_incomplete_response.rb', line 176

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



122
123
124
125
 
# File 'lib/zernio-sdk/models/post_publish_incomplete_response.rb', line 122

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end