Class: Fizzy::Services::BoardsService

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

Overview

Service for Boards 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:, name:, all_access: nil, auto_postpone_period_in_days: nil, public_description: nil) ⇒ Hash

create operation

Parameters:

  • account_id (String) —

    account id ID

  • name (String) —

    name

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

    all access

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

    auto postpone period in days

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

    public description

Returns:

  • (Hash) —

    response data



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

def create(account_id:, name:, all_access: nil, auto_postpone_period_in_days: nil, public_description: nil)
  with_operation(service: "boards", operation: "CreateBoard", is_mutation: true, resource_id: ) do
    http_post("/#{}/boards.json", body: compact_params(name: name, all_access: all_access, auto_postpone_period_in_days: auto_postpone_period_in_days, public_description: public_description)).json
  end
end

#delete(account_id:, board_id:) ⇒ void

This method returns an undefined value.

delete operation

Parameters:

  • account_id (String) —

    account id ID

  • board_id (String) —

    board id ID



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

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

#get(account_id:, board_id:) ⇒ Hash

get operation

Parameters:

  • account_id (String) —

    account id ID

  • board_id (String) —

    board id ID

Returns:

  • (Hash) —

    response data



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

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

#list(account_id:) ⇒ Enumerator<Hash>

list operation

Parameters:

  • account_id (String) —

    account id ID

Returns:

  • (Enumerator<Hash>) —

    paginated results



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

def list(account_id:)
  wrap_paginated(service: "boards", operation: "ListBoards", is_mutation: false, resource_id: ) do
    paginate("/#{}/boards.json")
  end
end

#list_board_accesses(account_id:, board_id:, page: nil) ⇒ Hash

list_board_accesses operation

Parameters:

  • account_id (String) —

    account id ID

  • board_id (String) —

    board id ID

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

    page

Returns:

  • (Hash) —

    response data



73
74
75
76
77
 
# File 'lib/fizzy/generated/services/boards_service.rb', line 73

def list_board_accesses(account_id:, board_id:, page: nil)
  with_operation(service: "boards", operation: "ListBoardAccesses", is_mutation: false, resource_id: board_id) do
    http_get("/#{}/boards/#{board_id}/accesses.json", params: compact_params(page: page)).json
  end
end

#publish_board(account_id:, board_id:) ⇒ void

This method returns an undefined value.

publish_board operation

Parameters:

  • account_id (String) —

    account id ID

  • board_id (String) —

    board id ID



83
84
85
86
87
88
 
# File 'lib/fizzy/generated/services/boards_service.rb', line 83

def publish_board(account_id:, board_id:)
  with_operation(service: "boards", operation: "PublishBoard", is_mutation: true, resource_id: board_id) do
    http_post("/#{}/boards/#{board_id}/publication.json", retryable: true)
    nil
  end
end

#unpublish_board(account_id:, board_id:) ⇒ void

This method returns an undefined value.

unpublish_board operation

Parameters:

  • account_id (String) —

    account id ID

  • board_id (String) —

    board id ID



94
95
96
97
98
99
 
# File 'lib/fizzy/generated/services/boards_service.rb', line 94

def unpublish_board(account_id:, board_id:)
  with_operation(service: "boards", operation: "UnpublishBoard", is_mutation: true, resource_id: board_id) do
    http_delete("/#{}/boards/#{board_id}/publication.json")
    nil
  end
end

#update(account_id:, board_id:, name: nil, all_access: nil, auto_postpone_period_in_days: nil, public_description: nil, user_ids: nil) ⇒ Hash

update operation

Parameters:

  • account_id (String) —

    account id ID

  • board_id (String) —

    board id ID

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

    name

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

    all access

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

    auto postpone period in days

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

    public description

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

    user ids

Returns:

  • (Hash) —

    response data



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

def update(account_id:, board_id:, name: nil, all_access: nil, auto_postpone_period_in_days: nil, public_description: nil, user_ids: nil)
  with_operation(service: "boards", operation: "UpdateBoard", is_mutation: true, resource_id: board_id) do
    http_patch("/#{}/boards/#{board_id}", body: compact_params(name: name, all_access: all_access, auto_postpone_period_in_days: auto_postpone_period_in_days, public_description: public_description, user_ids: user_ids)).json
  end
end