Class: Basecamp::Services::CardStepsService

Inherits:
BaseService
  • Object
show all
Defined in:
lib/basecamp/generated/services/card_steps_service.rb

Overview

Service for CardSteps operations

Instance Method Summary collapse

Constructor Details

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

Instance Method Details

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

Create a step on a card

Parameters:

  • card_id (Integer) —

    card id ID

  • title (String) —

    title

  • 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



28
29
30
31
32
 
# File 'lib/basecamp/generated/services/card_steps_service.rb', line 28

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

#get(step_id:) ⇒ Hash

Get a step by ID

Parameters:

  • step_id (Integer) —

    step id ID

Returns:

  • (Hash) —

    response data



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

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

#reposition(card_id:, source_id:, position:) ⇒ void

This method returns an undefined value.

Reposition a step within a card

Parameters:

  • card_id (Integer) —

    card id ID

  • source_id (Integer) —

    source id

  • position (Integer) —

    0-indexed position



15
16
17
18
19
20
 
# File 'lib/basecamp/generated/services/card_steps_service.rb', line 15

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

#set_completion(step_id:, completion:) ⇒ Hash

Set card step completion status (PUT with completion: "on" to complete, "" to uncomplete)

Parameters:

  • step_id (Integer) —

    step id ID

  • completion (String) —

    Set to "on" to complete the step, "" (empty) to uncomplete

Returns:

  • (Hash) —

    response data



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

def set_completion(step_id:, completion:)
  with_operation(service: "cardsteps", operation: "set_completion", is_mutation: true, resource_id: step_id) do
    http_put("/card_tables/steps/#{step_id}/completions.json", body: compact_params(completion: completion)).json
  end
end

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

Update an existing step

Parameters:

  • step_id (Integer) —

    step id ID

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

    title

  • 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



49
50
51
52
53
 
# File 'lib/basecamp/generated/services/card_steps_service.rb', line 49

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