Class: Fizzy::Services::ColumnsService

Inherits:
BaseService show all
Defined in:
lib/fizzy/generated/services/columns_service.rb

Overview

Service for Columns operations

Instance Method Summary collapse

Methods inherited from BaseService

#initialize

Constructor Details

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

Instance Method Details

#create(account_id:, board_id:, name:, color: nil) ⇒ Hash

create operation

Parameters:

  • account_id (String)

    account id ID

  • board_id (String)

    board id ID

  • name (String)

    name

  • color (String, nil) (defaults to: nil)

    color

Returns:

  • (Hash)

    response data



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

def create(account_id:, board_id:, name:, color: nil)
  with_operation(service: "columns", operation: "CreateColumn", is_mutation: true, resource_id: board_id) do
    http_post("/#{}/boards/#{board_id}/columns.json", body: compact_params(name: name, color: color)).json
  end
end

#delete(account_id:, board_id:, column_id:) ⇒ void

This method returns an undefined value.

delete operation

Parameters:

  • account_id (String)

    account id ID

  • board_id (String)

    board id ID

  • column_id (String)

    column id ID



61
62
63
64
65
66
# File 'lib/fizzy/generated/services/columns_service.rb', line 61

def delete(account_id:, board_id:, column_id:)
  with_operation(service: "columns", operation: "DeleteColumn", is_mutation: true, resource_id: column_id) do
    http_delete("/#{}/boards/#{board_id}/columns/#{column_id}")
    nil
  end
end

#get(account_id:, board_id:, column_id:) ⇒ Hash

get operation

Parameters:

  • account_id (String)

    account id ID

  • board_id (String)

    board id ID

  • column_id (String)

    column id ID

Returns:

  • (Hash)

    response data



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

def get(account_id:, board_id:, column_id:)
  with_operation(service: "columns", operation: "GetColumn", is_mutation: false, resource_id: column_id) do
    http_get("/#{}/boards/#{board_id}/columns/#{column_id}").json
  end
end

#list(account_id:, board_id:) ⇒ Hash

list operation

Parameters:

  • account_id (String)

    account id ID

  • board_id (String)

    board id ID

Returns:

  • (Hash)

    response data



14
15
16
17
18
# File 'lib/fizzy/generated/services/columns_service.rb', line 14

def list(account_id:, board_id:)
  with_operation(service: "columns", operation: "ListColumns", is_mutation: false, resource_id: board_id) do
    http_get("/#{}/boards/#{board_id}/columns.json").json
  end
end

#update(account_id:, board_id:, column_id:, name: nil, color: nil) ⇒ Hash

update operation

Parameters:

  • account_id (String)

    account id ID

  • board_id (String)

    board id ID

  • column_id (String)

    column id ID

  • name (String, nil) (defaults to: nil)

    name

  • color (String, nil) (defaults to: nil)

    color

Returns:

  • (Hash)

    response data



50
51
52
53
54
# File 'lib/fizzy/generated/services/columns_service.rb', line 50

def update(account_id:, board_id:, column_id:, name: nil, color: nil)
  with_operation(service: "columns", operation: "UpdateColumn", is_mutation: true, resource_id: column_id) do
    http_patch("/#{}/boards/#{board_id}/columns/#{column_id}", body: compact_params(name: name, color: color)).json
  end
end