Class: Zernio::CreateBlogArticleRequest

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

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



95
96
97
98
99
100
101
102
103
104
105
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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/zernio-sdk/models/create_blog_article_request.rb', line 95

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

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

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

Instance Attribute Details

#author ⇒ Object

Shopify author display name, or numeric WordPress user id serialized as a string. Assigning another WordPress user may require elevated capability.



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

def author
  @author
end

#body_html ⇒ Object

Article body as HTML.



21
22
23
 
# File 'lib/zernio-sdk/models/create_blog_article_request.rb', line 21

def body_html
  @body_html
end

#excerpt ⇒ Object

Short summary shown in blog listings.



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

def excerpt
  @excerpt
end

#handle ⇒ Object

URL slug. Generated from the title when omitted.



24
25
26
 
# File 'lib/zernio-sdk/models/create_blog_article_request.rb', line 24

def handle
  @handle
end

#image ⇒ Object

Returns the value of attribute image.



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

def image
  @image
end

#is_published ⇒ Object

Set false for a draft or true to publish. On WordPress false takes priority over a future publishDate; omission with no date defaults to draft.



40
41
42
 
# File 'lib/zernio-sdk/models/create_blog_article_request.rb', line 40

def is_published
  @is_published
end

#publish_date ⇒ Object

ISO 8601 datetime with offset (or Z). A future date schedules publication natively on the platform.



43
44
45
 
# File 'lib/zernio-sdk/models/create_blog_article_request.rb', line 43

def publish_date
  @publish_date
end

#seo ⇒ Object

Returns the value of attribute seo.



37
38
39
 
# File 'lib/zernio-sdk/models/create_blog_article_request.rb', line 37

def seo
  @seo
end

#tags ⇒ Object

Tag names. WordPress resolves existing names case-insensitively and creates missing tags.



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

def tags
  @tags
end

#title ⇒ Object

Returns the value of attribute title.



18
19
20
 
# File 'lib/zernio-sdk/models/create_blog_article_request.rb', line 18

def title
  @title
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/zernio-sdk/models/create_blog_article_request.rb', line 46

def self.attribute_map
  {
    :'title' => :'title',
    :'body_html' => :'bodyHtml',
    :'handle' => :'handle',
    :'tags' => :'tags',
    :'author' => :'author',
    :'excerpt' => :'excerpt',
    :'image' => :'image',
    :'seo' => :'seo',
    :'is_published' => :'isPublished',
    :'publish_date' => :'publishDate'
  }
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



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/zernio-sdk/models/create_blog_article_request.rb', line 244

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



88
89
90
91
 
# File 'lib/zernio-sdk/models/create_blog_article_request.rb', line 88

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

.openapi_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/zernio-sdk/models/create_blog_article_request.rb', line 72

def self.openapi_types
  {
    :'title' => :'String',
    :'body_html' => :'String',
    :'handle' => :'String',
    :'tags' => :'Array<String>',
    :'author' => :'String',
    :'excerpt' => :'String',
    :'image' => :'CreateBlogArticleRequestImage',
    :'seo' => :'CreateBlogArticleRequestSeo',
    :'is_published' => :'Boolean',
    :'publish_date' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/zernio-sdk/models/create_blog_article_request.rb', line 214

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      title == o.title &&
      body_html == o.body_html &&
      handle == o.handle &&
      tags == o.tags &&
      author == o.author &&
      excerpt == o.excerpt &&
      image == o.image &&
      seo == o.seo &&
      is_published == o.is_published &&
      publish_date == o.publish_date
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


231
232
233
 
# File 'lib/zernio-sdk/models/create_blog_article_request.rb', line 231

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



237
238
239
 
# File 'lib/zernio-sdk/models/create_blog_article_request.rb', line 237

def hash
  [title, body_html, handle, tags, author, excerpt, image, seo, is_published, publish_date].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



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

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

  if @title.to_s.length < 1
    invalid_properties.push('invalid value for "title", the character length must be greater than or equal to 1.')
  end

  if !@tags.nil? && @tags.length > 100
    invalid_properties.push('invalid value for "tags", number of items must be less than or equal to 100.')
  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



266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/zernio-sdk/models/create_blog_article_request.rb', line 266

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



176
177
178
179
180
181
182
 
# File 'lib/zernio-sdk/models/create_blog_article_request.rb', line 176

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @title.nil?
  return false if @title.to_s.length < 1
  return false if !@tags.nil? && @tags.length > 100
  true
end