Class: Basecamp::Services::CardsService

Inherits:
BaseService show all
Defined in:
lib/basecamp/generated/services/cards_service.rb

Overview

Service for Cards operations

Instance Method Summary collapse

Constructor Details

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

Instance Method Details

#create(column_id:, title:, content: nil, due_on: nil, notify: nil) ⇒ Hash

Create a card in a column

Parameters:

  • column_id (Integer) —

    column id ID

  • title (String) —

    title

  • content (String, nil) (defaults to: nil) —

    content

  • due_on (String, nil) (defaults to: nil) —

    due on (YYYY-MM-DD)

  • notify (Boolean, nil) (defaults to: nil) —

    notify

Returns:

  • (Hash) —

    response data



60
61
62
63
64
 
# File 'lib/basecamp/generated/services/cards_service.rb', line 60

def create(column_id:, title:, content: nil, due_on: nil, notify: nil)
  with_operation(service: "cards", operation: "create", is_mutation: true, resource_id: column_id) do
    http_post("/card_tables/lists/#{column_id}/cards.json", body: compact_params(title: title, content: content, due_on: due_on, notify: notify)).json
  end
end

#get(card_id:) ⇒ Hash

Get a card by ID

Parameters:

  • card_id (Integer) —

    card id ID

Returns:

  • (Hash) —

    response data



13
14
15
16
17
 
# File 'lib/basecamp/generated/services/cards_service.rb', line 13

def get(card_id:)
  with_operation(service: "cards", operation: "get", is_mutation: false, resource_id: card_id) do
    http_get("/card_tables/cards/#{card_id}").json
  end
end

#list(column_id:) ⇒ Enumerator<Hash>

List cards in a column

Parameters:

  • column_id (Integer) —

    column id ID

Returns:

  • (Enumerator<Hash>) —

    paginated results



47
48
49
50
51
 
# File 'lib/basecamp/generated/services/cards_service.rb', line 47

def list(column_id:)
  wrap_paginated(service: "cards", operation: "list", is_mutation: false, resource_id: column_id) do
    paginate("/card_tables/lists/#{column_id}/cards.json")
  end
end

#move(card_id:, column_id:, position: nil) ⇒ void

This method returns an undefined value.

Move a card to a different column

Parameters:

  • card_id (Integer) —

    card id ID

  • column_id (Integer) —

    column id

  • position (Integer, nil) (defaults to: nil) —

    1-indexed position within the destination column. Defaults to 1 (top).



37
38
39
40
41
42
 
# File 'lib/basecamp/generated/services/cards_service.rb', line 37

def move(card_id:, column_id:, position: nil)
  with_operation(service: "cards", operation: "move", is_mutation: true, resource_id: card_id) do
    http_post("/card_tables/cards/#{card_id}/moves.json", body: compact_params(column_id: column_id, position: position))
    nil
  end
end

#update(card_id:, title: nil, content: nil, due_on: nil, assignee_ids: nil) ⇒ Hash

Update an existing card

Parameters:

  • card_id (Integer) —

    card id ID

  • title (String, nil) (defaults to: nil) —

    title

  • content (String, nil) (defaults to: nil) —

    content

  • due_on (String, nil) (defaults to: nil) —

    due on (YYYY-MM-DD)

  • assignee_ids (Array, nil) (defaults to: nil) —

    assignee ids

Returns:

  • (Hash) —

    response data



26
27
28
29
30
 
# File 'lib/basecamp/generated/services/cards_service.rb', line 26

def update(card_id:, title: nil, content: nil, due_on: nil, assignee_ids: nil)
  with_operation(service: "cards", operation: "update", is_mutation: true, resource_id: card_id) do
    http_put("/card_tables/cards/#{card_id}", body: compact_params(title: title, content: content, due_on: due_on, assignee_ids: assignee_ids)).json
  end
end