Class: Zernio::BlogArticle

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

Overview

An article inside a blog on the connected platform.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/zernio-sdk/models/blog_article.rb', line 155

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#author ⇒ Object

Shopify author display name, or numeric WordPress user id serialized as a string.



39
40
41
 
# File 'lib/zernio-sdk/models/blog_article.rb', line 39

def author
  @author
end

#blog_id ⇒ Object

Platform-native id of the blog the article belongs to.



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

def blog_id
  @blog_id
end

#body_html ⇒ Object

Article body as HTML.



30
31
32
 
# File 'lib/zernio-sdk/models/blog_article.rb', line 30

def body_html
  @body_html
end

#created_at ⇒ Object

Creation time when the platform exposes one. WordPress returns null because its core date is the editable publication date.



59
60
61
 
# File 'lib/zernio-sdk/models/blog_article.rb', line 59

def created_at
  @created_at
end

#excerpt ⇒ Object

Short summary shown in blog listings.



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

def excerpt
  @excerpt
end

#handle ⇒ Object

URL slug of the article.



33
34
35
 
# File 'lib/zernio-sdk/models/blog_article.rb', line 33

def handle
  @handle
end

#id ⇒ Object

Platform-native numeric article/post id.



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

def id
  @id
end

#image ⇒ Object

Returns the value of attribute image.



44
45
46
 
# File 'lib/zernio-sdk/models/blog_article.rb', line 44

def image
  @image
end

#is_published ⇒ Object

False while the article is a draft or its publish date is still in the future.



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

def is_published
  @is_published
end

#platform ⇒ Object

Returns the value of attribute platform.



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

def platform
  @platform
end

#publish_date ⇒ Object

WordPress only. Scheduled publication time in UTC when status is future; null for other WordPress statuses and omitted for Shopify.



56
57
58
 
# File 'lib/zernio-sdk/models/blog_article.rb', line 56

def publish_date
  @publish_date
end

#published_at ⇒ Object

Publication time. On WordPress this is present only when status is publish; null for drafts, pending/private posts, and scheduled posts.



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

def published_at
  @published_at
end

#status ⇒ Object

WordPress only. Native post status returned by WordPress; omitted for Shopify.



53
54
55
 
# File 'lib/zernio-sdk/models/blog_article.rb', line 53

def status
  @status
end

#tags ⇒ Object

Tag names. On WordPress, missing tag names are created and matching is case-insensitive.



36
37
38
 
# File 'lib/zernio-sdk/models/blog_article.rb', line 36

def tags
  @tags
end

#title ⇒ Object

Returns the value of attribute title.



27
28
29
 
# File 'lib/zernio-sdk/models/blog_article.rb', line 27

def title
  @title
end

#updated_at ⇒ Object

Last modification time. WordPress returns modified_gmt as UTC.



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

def updated_at
  @updated_at
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



109
110
111
 
# File 'lib/zernio-sdk/models/blog_article.rb', line 109

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/zernio-sdk/models/blog_article.rb', line 87

def self.attribute_map
  {
    :'id' => :'id',
    :'blog_id' => :'blogId',
    :'platform' => :'platform',
    :'title' => :'title',
    :'body_html' => :'bodyHtml',
    :'handle' => :'handle',
    :'tags' => :'tags',
    :'author' => :'author',
    :'excerpt' => :'excerpt',
    :'image' => :'image',
    :'is_published' => :'isPublished',
    :'published_at' => :'publishedAt',
    :'status' => :'status',
    :'publish_date' => :'publishDate',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt'
  }
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



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/zernio-sdk/models/blog_article.rb', line 313

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



141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/zernio-sdk/models/blog_article.rb', line 141

def self.openapi_nullable
  Set.new([
    :'body_html',
    :'author',
    :'excerpt',
    :'published_at',
    :'publish_date',
    :'created_at',
    :'updated_at'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/zernio-sdk/models/blog_article.rb', line 119

def self.openapi_types
  {
    :'id' => :'String',
    :'blog_id' => :'String',
    :'platform' => :'String',
    :'title' => :'String',
    :'body_html' => :'String',
    :'handle' => :'String',
    :'tags' => :'Array<String>',
    :'author' => :'String',
    :'excerpt' => :'String',
    :'image' => :'BlogArticleImage',
    :'is_published' => :'Boolean',
    :'published_at' => :'Time',
    :'status' => :'String',
    :'publish_date' => :'Time',
    :'created_at' => :'Time',
    :'updated_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/zernio-sdk/models/blog_article.rb', line 277

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      blog_id == o.blog_id &&
      platform == o.platform &&
      title == o.title &&
      body_html == o.body_html &&
      handle == o.handle &&
      tags == o.tags &&
      author == o.author &&
      excerpt == o.excerpt &&
      image == o.image &&
      is_published == o.is_published &&
      published_at == o.published_at &&
      status == o.status &&
      publish_date == o.publish_date &&
      created_at == o.created_at &&
      updated_at == o.updated_at
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


300
301
302
 
# File 'lib/zernio-sdk/models/blog_article.rb', line 300

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



306
307
308
 
# File 'lib/zernio-sdk/models/blog_article.rb', line 306

def hash
  [id, blog_id, platform, title, body_html, handle, tags, author, excerpt, image, is_published, published_at, status, publish_date, created_at, updated_at].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



238
239
240
241
242
 
# File 'lib/zernio-sdk/models/blog_article.rb', line 238

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



335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/zernio-sdk/models/blog_article.rb', line 335

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



246
247
248
249
250
251
252
253
 
# File 'lib/zernio-sdk/models/blog_article.rb', line 246

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  platform_validator = EnumAttributeValidator.new('String', ["shopify", "wordpress"])
  return false unless platform_validator.valid?(@platform)
  status_validator = EnumAttributeValidator.new('String', ["publish", "future", "draft", "pending", "private"])
  return false unless status_validator.valid?(@status)
  true
end