class ShopifyAPI::Comment

Attributes

article_id[R]
author[R]
blog_id[R]
body[R]
body_html[R]
created_at[R]
email[R]
id[R]
ip[R]
published_at[R]
status[R]
updated_at[R]
user_agent[R]

Public Class Methods

all( limit: nil, since_id: nil, created_at_min: nil, created_at_max: nil, updated_at_min: nil, updated_at_max: nil, published_at_min: nil, published_at_max: nil, fields: nil, published_status: nil, status: nil, session: ShopifyAPI::Context.active_session, **kwargs ) click to toggle source
# File lib/shopify_api/rest/resources/2022_04/comment.rb, line 118
def all(
  limit: nil,
  since_id: nil,
  created_at_min: nil,
  created_at_max: nil,
  updated_at_min: nil,
  updated_at_max: nil,
  published_at_min: nil,
  published_at_max: nil,
  fields: nil,
  published_status: nil,
  status: nil,
  session: ShopifyAPI::Context.active_session,
  **kwargs
)
  response = base_find(
    session: session,
    ids: {},
    params: {limit: limit, since_id: since_id, created_at_min: created_at_min, created_at_max: created_at_max, updated_at_min: updated_at_min, updated_at_max: updated_at_max, published_at_min: published_at_min, published_at_max: published_at_max, fields: fields, published_status: published_status, status: status}.merge(kwargs).compact,
  )

  T.cast(response, T::Array[Comment])
end
count( created_at_min: nil, created_at_max: nil, updated_at_min: nil, updated_at_max: nil, published_at_min: nil, published_at_max: nil, published_status: nil, status: nil, session: ShopifyAPI::Context.active_session, **kwargs ) click to toggle source
# File lib/shopify_api/rest/resources/2022_04/comment.rb, line 156
def count(
  created_at_min: nil,
  created_at_max: nil,
  updated_at_min: nil,
  updated_at_max: nil,
  published_at_min: nil,
  published_at_max: nil,
  published_status: nil,
  status: nil,
  session: ShopifyAPI::Context.active_session,
  **kwargs
)
  request(
    http_method: :get,
    operation: :count,
    session: session,
    ids: {},
    params: {created_at_min: created_at_min, created_at_max: created_at_max, updated_at_min: updated_at_min, updated_at_max: updated_at_max, published_at_min: published_at_min, published_at_max: published_at_max, published_status: published_status, status: status}.merge(kwargs).compact,
    body: {},
    entity: nil,
  )
end
find( id:, fields: nil, session: ShopifyAPI::Context.active_session ) click to toggle source
# File lib/shopify_api/rest/resources/2022_04/comment.rb, line 88
def find(
  id:,
  fields: nil,
  session: ShopifyAPI::Context.active_session
)
  result = base_find(
    session: session,
    ids: {id: id},
    params: {fields: fields},
  )
  T.cast(result[0], T.nilable(Comment))
end
new(session: ShopifyAPI::Context.active_session, from_hash: nil) click to toggle source
Calls superclass method ShopifyAPI::Rest::Base::new
# File lib/shopify_api/rest/resources/2022_04/comment.rb, line 19
def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)

  @article_id = T.let(nil, T.nilable(Integer))
  @author = T.let(nil, T.nilable(String))
  @blog_id = T.let(nil, T.nilable(Integer))
  @body = T.let(nil, T.nilable(String))
  @body_html = T.let(nil, T.nilable(String))
  @created_at = T.let(nil, T.nilable(String))
  @email = T.let(nil, T.nilable(String))
  @id = T.let(nil, T.nilable(Integer))
  @ip = T.let(nil, T.nilable(String))
  @published_at = T.let(nil, T.nilable(String))
  @status = T.let(nil, T.nilable(String))
  @updated_at = T.let(nil, T.nilable(String))
  @user_agent = T.let(nil, T.nilable(String))

  super(session: session, from_hash: from_hash)
end

Public Instance Methods

approve( body: nil, **kwargs ) click to toggle source
# File lib/shopify_api/rest/resources/2022_04/comment.rb, line 187
def approve(
  body: nil,
  **kwargs
)
  self.class.request(
    http_method: :post,
    operation: :approve,
    session: @session,
    ids: {id: @id},
    params: {}.merge(kwargs).compact,
    body: body,
    entity: self,
  )
end
not_spam( body: nil, **kwargs ) click to toggle source
# File lib/shopify_api/rest/resources/2022_04/comment.rb, line 208
def not_spam(
  body: nil,
  **kwargs
)
  self.class.request(
    http_method: :post,
    operation: :not_spam,
    session: @session,
    ids: {id: @id},
    params: {}.merge(kwargs).compact,
    body: body,
    entity: self,
  )
end
remove( body: nil, **kwargs ) click to toggle source
# File lib/shopify_api/rest/resources/2022_04/comment.rb, line 229
def remove(
  body: nil,
  **kwargs
)
  self.class.request(
    http_method: :post,
    operation: :remove,
    session: @session,
    ids: {id: @id},
    params: {}.merge(kwargs).compact,
    body: body,
    entity: self,
  )
end
restore( body: nil, **kwargs ) click to toggle source
# File lib/shopify_api/rest/resources/2022_04/comment.rb, line 250
def restore(
  body: nil,
  **kwargs
)
  self.class.request(
    http_method: :post,
    operation: :restore,
    session: @session,
    ids: {id: @id},
    params: {}.merge(kwargs).compact,
    body: body,
    entity: self,
  )
end
spam( body: nil, **kwargs ) click to toggle source
# File lib/shopify_api/rest/resources/2022_04/comment.rb, line 271
def spam(
  body: nil,
  **kwargs
)
  self.class.request(
    http_method: :post,
    operation: :spam,
    session: @session,
    ids: {id: @id},
    params: {}.merge(kwargs).compact,
    body: body,
    entity: self,
  )
end