Class: Fizzy::Services::CardsService

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

Overview

Service for Cards operations

Instance Method Summary collapse

Methods inherited from BaseService

#initialize

Constructor Details

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

Instance Method Details

#assign(account_id:, card_number:, assignee_id:) ⇒ void

This method returns an undefined value.

assign operation

Parameters:

  • account_id (String) —

    account id ID

  • card_number (Integer) —

    card number ID

  • assignee_id (String) —

    assignee id



145
146
147
148
149
150
 
# File 'lib/fizzy/generated/services/cards_service.rb', line 145

def assign(account_id:, card_number:, assignee_id:)
  with_operation(service: "cards", operation: "AssignCard", is_mutation: true, resource_id: card_number) do
    http_post("/#{}/cards/#{card_number}/assignments.json", body: compact_params(assignee_id: assignee_id))
    nil
  end
end

#close(account_id:, card_number:) ⇒ void

This method returns an undefined value.

close operation

Parameters:

  • account_id (String) —

    account id ID

  • card_number (Integer) —

    card number ID



168
169
170
171
172
173
 
# File 'lib/fizzy/generated/services/cards_service.rb', line 168

def close(account_id:, card_number:)
  with_operation(service: "cards", operation: "CloseCard", is_mutation: true, resource_id: card_number) do
    http_post("/#{}/cards/#{card_number}/closure.json", retryable: true)
    nil
  end
end

#create(account_id:, title:, board_id: nil, column_id: nil, description: nil, assignee_ids: nil, tag_names: nil, image: nil, created_at: nil, last_active_at: nil) ⇒ Hash

create operation

Parameters:

  • account_id (String) —

    account id ID

  • title (String) —

    title

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

    board id

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

    column id

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

    description

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

    assignee ids

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

    tag names

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

    image

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

    created at

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

    last active at

Returns:

  • (Hash) —

    response data



98
99
100
101
102
 
# File 'lib/fizzy/generated/services/cards_service.rb', line 98

def create(account_id:, title:, board_id: nil, column_id: nil, description: nil, assignee_ids: nil, tag_names: nil, image: nil, created_at: nil, last_active_at: nil)
  with_operation(service: "cards", operation: "CreateCard", is_mutation: true, resource_id: ) do
    http_post("/#{}/cards.json", body: compact_params(title: title, board_id: board_id, column_id: column_id, description: description, assignee_ids: assignee_ids, tag_names: tag_names, image: image, created_at: created_at, last_active_at: last_active_at)).json
  end
end

#delete(account_id:, card_number:) ⇒ void

This method returns an undefined value.

delete operation

Parameters:

  • account_id (String) —

    account id ID

  • card_number (Integer) —

    card number ID



133
134
135
136
137
138
 
# File 'lib/fizzy/generated/services/cards_service.rb', line 133

def delete(account_id:, card_number:)
  with_operation(service: "cards", operation: "DeleteCard", is_mutation: true, resource_id: card_number) do
    http_delete("/#{}/cards/#{card_number}")
    nil
  end
end

#delete_image(account_id:, card_number:) ⇒ void

This method returns an undefined value.

delete_image operation

Parameters:

  • account_id (String) —

    account id ID

  • card_number (Integer) —

    card number ID



212
213
214
215
216
217
 
# File 'lib/fizzy/generated/services/cards_service.rb', line 212

def delete_image(account_id:, card_number:)
  with_operation(service: "cards", operation: "DeleteCardImage", is_mutation: true, resource_id: card_number) do
    http_delete("/#{}/cards/#{card_number}/image.json")
    nil
  end
end

#get(account_id:, card_number:) ⇒ Hash

get operation

Parameters:

  • account_id (String) —

    account id ID

  • card_number (Integer) —

    card number ID

Returns:

  • (Hash) —

    response data



108
109
110
111
112
 
# File 'lib/fizzy/generated/services/cards_service.rb', line 108

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

#gold(account_id:, card_number:) ⇒ void

This method returns an undefined value.

gold operation

Parameters:

  • account_id (String) —

    account id ID

  • card_number (Integer) —

    card number ID



190
191
192
193
194
195
 
# File 'lib/fizzy/generated/services/cards_service.rb', line 190

def gold(account_id:, card_number:)
  with_operation(service: "cards", operation: "GoldCard", is_mutation: true, resource_id: card_number) do
    http_post("/#{}/cards/#{card_number}/goldness.json", retryable: true)
    nil
  end
end

#list(account_id:, board_ids: nil, tag_ids: nil, assignee_ids: nil, creator_ids: nil, closer_ids: nil, card_ids: nil, column_ids: nil, indexed_by: nil, sorted_by: nil, assignment_status: nil, creation: nil, closure: nil, terms: nil) ⇒ Enumerator<Hash>

list operation

Parameters:

  • account_id (String) —

    account id ID

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

    board ids

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

    tag ids

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

    assignee ids

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

    creator ids

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

    closer ids

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

    card ids

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

    column ids

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

    indexed by

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

    sorted by

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

    assignment status

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

    creation

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

    closure

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

    terms

Returns:

  • (Enumerator<Hash>) —

    paginated results



79
80
81
82
83
84
 
# File 'lib/fizzy/generated/services/cards_service.rb', line 79

def list(account_id:, board_ids: nil, tag_ids: nil, assignee_ids: nil, creator_ids: nil, closer_ids: nil, card_ids: nil, column_ids: nil, indexed_by: nil, sorted_by: nil, assignment_status: nil, creation: nil, closure: nil, terms: nil)
  wrap_paginated(service: "cards", operation: "ListCards", is_mutation: false, resource_id: ) do
    params = compact_params(board_ids: board_ids, tag_ids: tag_ids, assignee_ids: assignee_ids, creator_ids: creator_ids, closer_ids: closer_ids, card_ids: card_ids, column_ids: column_ids, indexed_by: indexed_by, sorted_by: sorted_by, assignment_status: assignment_status, creation: creation, closure: closure, terms: terms)
    paginate("/#{}/cards.json", params: params)
  end
end

#list_activities(account_id:, creator_ids: nil, board_ids: nil) ⇒ Enumerator<Hash>

list_activities operation

Parameters:

  • account_id (String) —

    account id ID

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

    creator ids

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

    board ids

Returns:

  • (Enumerator<Hash>) —

    paginated results



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

def list_activities(account_id:, creator_ids: nil, board_ids: nil)
  wrap_paginated(service: "cards", operation: "ListActivities", is_mutation: false, resource_id: ) do
    params = compact_params(creator_ids: creator_ids, board_ids: board_ids)
    paginate("/#{}/activities.json", params: params)
  end
end

#list_closed_cards(account_id:, board_id:) ⇒ Enumerator<Hash>

list_closed_cards operation

Parameters:

  • account_id (String) —

    account id ID

  • board_id (String) —

    board id ID

Returns:

  • (Enumerator<Hash>) —

    paginated results



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

def list_closed_cards(account_id:, board_id:)
  wrap_paginated(service: "cards", operation: "ListClosedCards", is_mutation: false, resource_id: board_id) do
    paginate("/#{}/boards/#{board_id}/columns/closed.json")
  end
end

#list_column_cards(account_id:, board_id:, column_id:) ⇒ Enumerator<Hash>

list_column_cards operation

Parameters:

  • account_id (String) —

    account id ID

  • board_id (String) —

    board id ID

  • column_id (String) —

    column id ID

Returns:

  • (Enumerator<Hash>) —

    paginated results



57
58
59
60
61
 
# File 'lib/fizzy/generated/services/cards_service.rb', line 57

def list_column_cards(account_id:, board_id:, column_id:)
  wrap_paginated(service: "cards", operation: "ListColumnCards", is_mutation: false, resource_id: column_id) do
    paginate("/#{}/boards/#{board_id}/columns/#{column_id}/cards.json")
  end
end

#list_postponed_cards(account_id:, board_id:) ⇒ Enumerator<Hash>

list_postponed_cards operation

Parameters:

  • account_id (String) —

    account id ID

  • board_id (String) —

    board id ID

Returns:

  • (Enumerator<Hash>) —

    paginated results



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

def list_postponed_cards(account_id:, board_id:)
  wrap_paginated(service: "cards", operation: "ListPostponedCards", is_mutation: false, resource_id: board_id) do
    paginate("/#{}/boards/#{board_id}/columns/not_now.json")
  end
end

#list_stream_cards(account_id:, board_id:) ⇒ Enumerator<Hash>

list_stream_cards operation

Parameters:

  • account_id (String) —

    account id ID

  • board_id (String) —

    board id ID

Returns:

  • (Enumerator<Hash>) —

    paginated results



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

def list_stream_cards(account_id:, board_id:)
  wrap_paginated(service: "cards", operation: "ListStreamCards", is_mutation: false, resource_id: board_id) do
    paginate("/#{}/boards/#{board_id}/columns/stream.json")
  end
end

#move(account_id:, card_number:, board_id:, column_id: nil) ⇒ Hash

move operation

Parameters:

  • account_id (String) —

    account id ID

  • card_number (Integer) —

    card number ID

  • board_id (String) —

    board id

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

    column id

Returns:

  • (Hash) —

    response data



158
159
160
161
162
 
# File 'lib/fizzy/generated/services/cards_service.rb', line 158

def move(account_id:, card_number:, board_id:, column_id: nil)
  with_operation(service: "cards", operation: "MoveCard", is_mutation: true, resource_id: card_number) do
    http_patch("/#{}/cards/#{card_number}/board.json", body: compact_params(board_id: board_id, column_id: column_id)).json
  end
end

#pin(account_id:, card_number:) ⇒ void

This method returns an undefined value.

pin operation

Parameters:

  • account_id (String) —

    account id ID

  • card_number (Integer) —

    card number ID



234
235
236
237
238
239
 
# File 'lib/fizzy/generated/services/cards_service.rb', line 234

def pin(account_id:, card_number:)
  with_operation(service: "cards", operation: "PinCard", is_mutation: true, resource_id: card_number) do
    http_post("/#{}/cards/#{card_number}/pin.json", retryable: true)
    nil
  end
end

#postpone(account_id:, card_number:) ⇒ void

This method returns an undefined value.

postpone operation

Parameters:

  • account_id (String) —

    account id ID

  • card_number (Integer) —

    card number ID



223
224
225
226
227
228
 
# File 'lib/fizzy/generated/services/cards_service.rb', line 223

def postpone(account_id:, card_number:)
  with_operation(service: "cards", operation: "PostponeCard", is_mutation: true, resource_id: card_number) do
    http_post("/#{}/cards/#{card_number}/not_now.json", retryable: true)
    nil
  end
end

#publish_card(account_id:, card_number:) ⇒ void

This method returns an undefined value.

publish_card operation

Parameters:

  • account_id (String) —

    account id ID

  • card_number (Integer) —

    card number ID



256
257
258
259
260
261
 
# File 'lib/fizzy/generated/services/cards_service.rb', line 256

def publish_card(account_id:, card_number:)
  with_operation(service: "cards", operation: "PublishCard", is_mutation: true, resource_id: card_number) do
    http_post("/#{}/cards/#{card_number}/publish.json")
    nil
  end
end

#reopen(account_id:, card_number:) ⇒ void

This method returns an undefined value.

reopen operation

Parameters:

  • account_id (String) —

    account id ID

  • card_number (Integer) —

    card number ID



179
180
181
182
183
184
 
# File 'lib/fizzy/generated/services/cards_service.rb', line 179

def reopen(account_id:, card_number:)
  with_operation(service: "cards", operation: "ReopenCard", is_mutation: true, resource_id: card_number) do
    http_delete("/#{}/cards/#{card_number}/closure.json")
    nil
  end
end

#search_cards(account_id:, q:) ⇒ Enumerator<Hash>

search_cards operation

Parameters:

  • account_id (String) —

    account id ID

  • q (String) —

    q

Returns:

  • (Enumerator<Hash>) —

    paginated results



335
336
337
338
339
340
 
# File 'lib/fizzy/generated/services/cards_service.rb', line 335

def search_cards(account_id:, q:)
  wrap_paginated(service: "cards", operation: "SearchCards", is_mutation: false, resource_id: ) do
    params = compact_params(q: q)
    paginate("/#{}/search.json", params: params)
  end
end

#self_assign(account_id:, card_number:) ⇒ void

This method returns an undefined value.

self_assign operation

Parameters:

  • account_id (String) —

    account id ID

  • card_number (Integer) —

    card number ID



267
268
269
270
271
272
 
# File 'lib/fizzy/generated/services/cards_service.rb', line 267

def self_assign(account_id:, card_number:)
  with_operation(service: "cards", operation: "SelfAssignCard", is_mutation: true, resource_id: card_number) do
    http_post("/#{}/cards/#{card_number}/self_assignment.json")
    nil
  end
end

#tag(account_id:, card_number:, tag_title:) ⇒ void

This method returns an undefined value.

tag operation

Parameters:

  • account_id (String) —

    account id ID

  • card_number (Integer) —

    card number ID

  • tag_title (String) —

    tag title



279
280
281
282
283
284
 
# File 'lib/fizzy/generated/services/cards_service.rb', line 279

def tag(account_id:, card_number:, tag_title:)
  with_operation(service: "cards", operation: "TagCard", is_mutation: true, resource_id: card_number) do
    http_post("/#{}/cards/#{card_number}/taggings.json", body: compact_params(tag_title: tag_title))
    nil
  end
end

#triage(account_id:, card_number:, column_id: nil) ⇒ void

This method returns an undefined value.

triage operation

Parameters:

  • account_id (String) —

    account id ID

  • card_number (Integer) —

    card number ID

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

    column id



291
292
293
294
295
296
 
# File 'lib/fizzy/generated/services/cards_service.rb', line 291

def triage(account_id:, card_number:, column_id: nil)
  with_operation(service: "cards", operation: "TriageCard", is_mutation: true, resource_id: card_number) do
    http_post("/#{}/cards/#{card_number}/triage.json", body: compact_params(column_id: column_id), retryable: true)
    nil
  end
end

#ungold(account_id:, card_number:) ⇒ void

This method returns an undefined value.

ungold operation

Parameters:

  • account_id (String) —

    account id ID

  • card_number (Integer) —

    card number ID



201
202
203
204
205
206
 
# File 'lib/fizzy/generated/services/cards_service.rb', line 201

def ungold(account_id:, card_number:)
  with_operation(service: "cards", operation: "UngoldCard", is_mutation: true, resource_id: card_number) do
    http_delete("/#{}/cards/#{card_number}/goldness.json")
    nil
  end
end

#unpin(account_id:, card_number:) ⇒ void

This method returns an undefined value.

unpin operation

Parameters:

  • account_id (String) —

    account id ID

  • card_number (Integer) —

    card number ID



245
246
247
248
249
250
 
# File 'lib/fizzy/generated/services/cards_service.rb', line 245

def unpin(account_id:, card_number:)
  with_operation(service: "cards", operation: "UnpinCard", is_mutation: true, resource_id: card_number) do
    http_delete("/#{}/cards/#{card_number}/pin.json")
    nil
  end
end

#untriage(account_id:, card_number:) ⇒ void

This method returns an undefined value.

untriage operation

Parameters:

  • account_id (String) —

    account id ID

  • card_number (Integer) —

    card number ID



302
303
304
305
306
307
 
# File 'lib/fizzy/generated/services/cards_service.rb', line 302

def untriage(account_id:, card_number:)
  with_operation(service: "cards", operation: "UnTriageCard", is_mutation: true, resource_id: card_number) do
    http_delete("/#{}/cards/#{card_number}/triage.json")
    nil
  end
end

#unwatch(account_id:, card_number:) ⇒ void

This method returns an undefined value.

unwatch operation

Parameters:

  • account_id (String) —

    account id ID

  • card_number (Integer) —

    card number ID



324
325
326
327
328
329
 
# File 'lib/fizzy/generated/services/cards_service.rb', line 324

def unwatch(account_id:, card_number:)
  with_operation(service: "cards", operation: "UnwatchCard", is_mutation: true, resource_id: card_number) do
    http_delete("/#{}/cards/#{card_number}/watch.json")
    nil
  end
end

#update(account_id:, card_number:, title: nil, description: nil, column_id: nil, image: nil, created_at: nil) ⇒ Hash

update operation

Parameters:

  • account_id (String) —

    account id ID

  • card_number (Integer) —

    card number ID

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

    title

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

    description

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

    column id

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

    image

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

    created at

Returns:

  • (Hash) —

    response data



123
124
125
126
127
 
# File 'lib/fizzy/generated/services/cards_service.rb', line 123

def update(account_id:, card_number:, title: nil, description: nil, column_id: nil, image: nil, created_at: nil)
  with_operation(service: "cards", operation: "UpdateCard", is_mutation: true, resource_id: card_number) do
    http_patch("/#{}/cards/#{card_number}", body: compact_params(title: title, description: description, column_id: column_id, image: image, created_at: created_at)).json
  end
end

#watch(account_id:, card_number:) ⇒ void

This method returns an undefined value.

watch operation

Parameters:

  • account_id (String) —

    account id ID

  • card_number (Integer) —

    card number ID



313
314
315
316
317
318
 
# File 'lib/fizzy/generated/services/cards_service.rb', line 313

def watch(account_id:, card_number:)
  with_operation(service: "cards", operation: "WatchCard", is_mutation: true, resource_id: card_number) do
    http_post("/#{}/cards/#{card_number}/watch.json", retryable: true)
    nil
  end
end