Class: Forem::Services::RecommendedArticlesListService

Inherits:
BaseService
  • Object
show all
Defined in:
lib/forem/services/recommended_articles_list_service.rb

Overview

Service for interacting with the Forem Recommended Articles Lists API.

Recommended articles lists are curated collections of articles surfaced to specific user segments. Access via Client#recommended_articles_lists. All methods inject the client's requestor automatically so no additional configuration is required.

Examples:

client = Forem::Client.new("your-api-key")
lists = client.recommended_articles_lists.list
list  = client.recommended_articles_lists.retrieve(2)

See Also:

Instance Method Summary collapse

Methods inherited from BaseService

#initialize

Constructor Details

This class inherits a constructor from Forem::Services::BaseService

Instance Method Details

#create(params = {}, opts = {}) ⇒ RecommendedArticlesList

Create a new recommended articles list.

Examples:

client.recommended_articles_lists.create(
  name: "Top Ruby Articles",
  segment_id: 5
)

Parameters:

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

    list attributes

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

    per-request options

Options Hash (params):

  • :name (String) —

    name of the list

  • :segment_id (Integer) —

    the audience segment this list targets

Returns:

See Also:



51
52
53
 
# File 'lib/forem/services/recommended_articles_list_service.rb', line 51

def create(params = {}, opts = {})
  RecommendedArticlesList.create(params, opts_with_requestor(opts))
end

#list(params = {}, opts = {}) ⇒ Array<RecommendedArticlesList>

List all recommended articles lists.

Examples:

client.recommended_articles_lists.list

Parameters:

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

    query parameters

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

    per-request options

Options Hash (params):

  • :page (Integer) —

    page number (default: 1)

  • :per_page (Integer) —

    number of results per page

Returns:

See Also:



31
32
33
 
# File 'lib/forem/services/recommended_articles_list_service.rb', line 31

def list(params = {}, opts = {})
  RecommendedArticlesList.list(params, opts_with_requestor(opts))
end

#retrieve(id, opts = {}) ⇒ RecommendedArticlesList

Retrieve a single recommended articles list by its numeric ID.

Examples:

client.recommended_articles_lists.retrieve(2)

Parameters:

  • id (Integer, String) —

    the list ID

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

    per-request options

Returns:

See Also:



65
66
67
 
# File 'lib/forem/services/recommended_articles_list_service.rb', line 65

def retrieve(id, opts = {})
  RecommendedArticlesList.retrieve(id, opts_with_requestor(opts))
end

#update(id, params = {}, opts = {}) ⇒ RecommendedArticlesList

Update an existing recommended articles list.

Examples:

client.recommended_articles_lists.update(2, name: "Best Ruby Content")

Parameters:

  • id (Integer, String) —

    the list ID to update

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

    list attributes to change

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

    per-request options

Options Hash (params):

  • :name (String) —

    new name for the list

  • :segment_id (Integer) —

    new target segment

Returns:

See Also:



82
83
84
 
# File 'lib/forem/services/recommended_articles_list_service.rb', line 82

def update(id, params = {}, opts = {})
  RecommendedArticlesList.update(id, params, opts_with_requestor(opts))
end