Class: Basecamp::Services::EverythingService

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

Overview

Service for Everything operations

Instance Method Summary collapse

Constructor Details

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

Instance Method Details

#get_everything_checkins(page: nil, max_items: nil) ⇒ ListEnumerator<Hash>

Get every automatic check-in answer across all accessible projects, newest-first.

Parameters:

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

    Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8.

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

    cap on items yielded across pages; nil or non-positive means no cap

Returns:

  • (ListEnumerator<Hash>) —

    lazily paginated results (#meta carries pagination metadata)



95
96
97
98
99
100
 
# File 'lib/basecamp/generated/services/everything_service.rb', line 95

def get_everything_checkins(page: nil, max_items: nil)
  wrap_paginated(service: "everything", operation: "get_everything_checkins", is_mutation: false) do
    params = compact_query_params(page: page)
    paginate("/checkins.json", params: params, operation: "GetEverythingCheckins", max_items: max_items)
  end
end

#get_everything_comments(page: nil, max_items: nil) ⇒ ListEnumerator<Hash>

Get every comment across all accessible projects, newest-first (paginated).

Parameters:

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

    Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8.

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

    cap on items yielded across pages; nil or non-positive means no cap

Returns:

  • (ListEnumerator<Hash>) —

    lazily paginated results (#meta carries pagination metadata)



106
107
108
109
110
111
 
# File 'lib/basecamp/generated/services/everything_service.rb', line 106

def get_everything_comments(page: nil, max_items: nil)
  wrap_paginated(service: "everything", operation: "get_everything_comments", is_mutation: false) do
    params = compact_query_params(page: page)
    paginate("/comments.json", params: params, operation: "GetEverythingComments", max_items: max_items)
  end
end

#get_everything_completed_cards(assignee_ids: nil, due: nil, page: nil, max_items: nil) ⇒ ListEnumerator<Hash>

Completed cards across all accessible projects, grouped by project (paginated).

Parameters:

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

    Restrict to tasks assigned to at least one of the given people (repeatable). Assignees on nested steps are not considered.

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

    Filter by due date: with, without, or overdue. Unrecognized values are ignored.

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

    Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8.

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

    cap on items yielded across pages; nil or non-positive means no cap

Returns:

  • (ListEnumerator<Hash>) —

    lazily paginated results (#meta carries pagination metadata)



17
18
19
20
21
22
 
# File 'lib/basecamp/generated/services/everything_service.rb', line 17

def get_everything_completed_cards(assignee_ids: nil, due: nil, page: nil, max_items: nil)
  wrap_paginated(service: "everything", operation: "get_everything_completed_cards", is_mutation: false) do
    params = compact_query_params(assignee_ids: assignee_ids, due: due, page: page)
    paginate("/cards/completed.json", params: params, operation: "GetEverythingCompletedCards", max_items: max_items)
  end
end

#get_everything_completed_todos(assignee_ids: nil, due: nil, page: nil, max_items: nil) ⇒ ListEnumerator<Hash>

Completed to-dos across all accessible projects, grouped by project (paginated).

Parameters:

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

    Restrict to tasks assigned to at least one of the given people (repeatable). Assignees on nested steps are not considered.

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

    Filter by due date: with, without, or overdue. Unrecognized values are ignored.

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

    Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8.

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

    cap on items yielded across pages; nil or non-positive means no cap

Returns:

  • (ListEnumerator<Hash>) —

    lazily paginated results (#meta carries pagination metadata)



155
156
157
158
159
160
 
# File 'lib/basecamp/generated/services/everything_service.rb', line 155

def get_everything_completed_todos(assignee_ids: nil, due: nil, page: nil, max_items: nil)
  wrap_paginated(service: "everything", operation: "get_everything_completed_todos", is_mutation: false) do
    params = compact_query_params(assignee_ids: assignee_ids, due: due, page: page)
    paginate("/todos/completed.json", params: params, operation: "GetEverythingCompletedTodos", max_items: max_items)
  end
end

#get_everything_files(kind: nil, people_ids: nil, page: nil, max_items: nil) ⇒ ListEnumerator<Hash>

Get every file recording across all accessible projects, newest-first (paginated).

Parameters:

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

    Filter by file kind: all (default), images, pdfs, documents, or videos.

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

    Restrict to files created by the given people (repeatable).

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

    Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8.

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

    cap on items yielded across pages; nil or non-positive means no cap

Returns:

  • (ListEnumerator<Hash>) —

    lazily paginated results (#meta carries pagination metadata)



119
120
121
122
123
124
 
# File 'lib/basecamp/generated/services/everything_service.rb', line 119

def get_everything_files(kind: nil, people_ids: nil, page: nil, max_items: nil)
  wrap_paginated(service: "everything", operation: "get_everything_files", is_mutation: false) do
    params = compact_query_params(kind: kind, people_ids: people_ids, page: page)
    paginate("/files.json", params: params, operation: "GetEverythingFiles", max_items: max_items)
  end
end

#get_everything_forwards(page: nil, max_items: nil) ⇒ ListEnumerator<Hash>

Get every inbox forward across all accessible projects, newest-first (paginated).

Parameters:

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

    Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8.

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

    cap on items yielded across pages; nil or non-positive means no cap

Returns:

  • (ListEnumerator<Hash>) —

    lazily paginated results (#meta carries pagination metadata)



130
131
132
133
134
135
 
# File 'lib/basecamp/generated/services/everything_service.rb', line 130

def get_everything_forwards(page: nil, max_items: nil)
  wrap_paginated(service: "everything", operation: "get_everything_forwards", is_mutation: false) do
    params = compact_query_params(page: page)
    paginate("/forwards.json", params: params, operation: "GetEverythingForwards", max_items: max_items)
  end
end

#get_everything_messages(page: nil, max_items: nil) ⇒ ListEnumerator<Hash>

Get every message across all accessible projects, newest-first (paginated).

Parameters:

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

    Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8.

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

    cap on items yielded across pages; nil or non-positive means no cap

Returns:

  • (ListEnumerator<Hash>) —

    lazily paginated results (#meta carries pagination metadata)



141
142
143
144
145
146
 
# File 'lib/basecamp/generated/services/everything_service.rb', line 141

def get_everything_messages(page: nil, max_items: nil)
  wrap_paginated(service: "everything", operation: "get_everything_messages", is_mutation: false) do
    params = compact_query_params(page: page)
    paginate("/messages.json", params: params, operation: "GetEverythingMessages", max_items: max_items)
  end
end

#get_everything_no_due_date_cards(assignee_ids: nil, due: nil, page: nil, max_items: nil) ⇒ ListEnumerator<Hash>

Open cards with no due date across all accessible projects, grouped by project (paginated).

Parameters:

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

    Restrict to tasks assigned to at least one of the given people (repeatable). Assignees on nested steps are not considered.

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

    Filter by due date: with, without, or overdue. Unrecognized values are ignored.

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

    Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8.

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

    cap on items yielded across pages; nil or non-positive means no cap

Returns:

  • (ListEnumerator<Hash>) —

    lazily paginated results (#meta carries pagination metadata)



31
32
33
34
35
36
 
# File 'lib/basecamp/generated/services/everything_service.rb', line 31

def get_everything_no_due_date_cards(assignee_ids: nil, due: nil, page: nil, max_items: nil)
  wrap_paginated(service: "everything", operation: "get_everything_no_due_date_cards", is_mutation: false) do
    params = compact_query_params(assignee_ids: assignee_ids, due: due, page: page)
    paginate("/cards/no_due_date.json", params: params, operation: "GetEverythingNoDueDateCards", max_items: max_items)
  end
end

#get_everything_no_due_date_todos(assignee_ids: nil, due: nil, page: nil, max_items: nil) ⇒ ListEnumerator<Hash>

Open to-dos with no due date across all accessible projects, grouped by project (paginated).

Parameters:

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

    Restrict to tasks assigned to at least one of the given people (repeatable). Assignees on nested steps are not considered.

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

    Filter by due date: with, without, or overdue. Unrecognized values are ignored.

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

    Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8.

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

    cap on items yielded across pages; nil or non-positive means no cap

Returns:

  • (ListEnumerator<Hash>) —

    lazily paginated results (#meta carries pagination metadata)



169
170
171
172
173
174
 
# File 'lib/basecamp/generated/services/everything_service.rb', line 169

def get_everything_no_due_date_todos(assignee_ids: nil, due: nil, page: nil, max_items: nil)
  wrap_paginated(service: "everything", operation: "get_everything_no_due_date_todos", is_mutation: false) do
    params = compact_query_params(assignee_ids: assignee_ids, due: due, page: page)
    paginate("/todos/no_due_date.json", params: params, operation: "GetEverythingNoDueDateTodos", max_items: max_items)
  end
end

#get_everything_not_now_cards(assignee_ids: nil, due: nil, page: nil, max_items: nil) ⇒ ListEnumerator<Hash>

Cards parked in a project's "Not now" column across all accessible projects, grouped by project (paginated).

Parameters:

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

    Restrict to tasks assigned to at least one of the given people (repeatable). Assignees on nested steps are not considered.

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

    Filter by due date: with, without, or overdue. Unrecognized values are ignored.

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

    Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8.

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

    cap on items yielded across pages; nil or non-positive means no cap

Returns:

  • (ListEnumerator<Hash>) —

    lazily paginated results (#meta carries pagination metadata)



45
46
47
48
49
50
 
# File 'lib/basecamp/generated/services/everything_service.rb', line 45

def get_everything_not_now_cards(assignee_ids: nil, due: nil, page: nil, max_items: nil)
  wrap_paginated(service: "everything", operation: "get_everything_not_now_cards", is_mutation: false) do
    params = compact_query_params(assignee_ids: assignee_ids, due: due, page: page)
    paginate("/cards/not_now.json", params: params, operation: "GetEverythingNotNowCards", max_items: max_items)
  end
end

#get_everything_open_cards(assignee_ids: nil, due: nil, page: nil, max_items: nil) ⇒ ListEnumerator<Hash>

Incomplete cards in active columns across all accessible projects, grouped by project (paginated).

Parameters:

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

    Restrict to tasks assigned to at least one of the given people (repeatable). Assignees on nested steps are not considered.

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

    Filter by due date: with, without, or overdue. Unrecognized values are ignored.

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

    Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8.

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

    cap on items yielded across pages; nil or non-positive means no cap

Returns:

  • (ListEnumerator<Hash>) —

    lazily paginated results (#meta carries pagination metadata)



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

def get_everything_open_cards(assignee_ids: nil, due: nil, page: nil, max_items: nil)
  wrap_paginated(service: "everything", operation: "get_everything_open_cards", is_mutation: false) do
    params = compact_query_params(assignee_ids: assignee_ids, due: due, page: page)
    paginate("/cards/open.json", params: params, operation: "GetEverythingOpenCards", max_items: max_items)
  end
end

#get_everything_open_todos(assignee_ids: nil, due: nil, page: nil, max_items: nil) ⇒ ListEnumerator<Hash>

Active, incomplete to-dos across all accessible projects, grouped by project (paginated).

Parameters:

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

    Restrict to tasks assigned to at least one of the given people (repeatable). Assignees on nested steps are not considered.

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

    Filter by due date: with, without, or overdue. Unrecognized values are ignored.

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

    Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8.

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

    cap on items yielded across pages; nil or non-positive means no cap

Returns:

  • (ListEnumerator<Hash>) —

    lazily paginated results (#meta carries pagination metadata)



183
184
185
186
187
188
 
# File 'lib/basecamp/generated/services/everything_service.rb', line 183

def get_everything_open_todos(assignee_ids: nil, due: nil, page: nil, max_items: nil)
  wrap_paginated(service: "everything", operation: "get_everything_open_todos", is_mutation: false) do
    params = compact_query_params(assignee_ids: assignee_ids, due: due, page: page)
    paginate("/todos/open.json", params: params, operation: "GetEverythingOpenTodos", max_items: max_items)
  end
end

#get_everything_overdue_cards(assignee_ids: nil, due: nil) ⇒ Array<Hash>

Get every overdue card across all accessible projects, oldest-due-date-first.

Parameters:

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

    Restrict to tasks assigned to at least one of the given people (repeatable). Assignees on nested steps are not considered.

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

    Filter by due date: with, without, or overdue. Unrecognized values are ignored.

Returns:

  • (Array<Hash>) —

    response data



71
72
73
74
75
 
# File 'lib/basecamp/generated/services/everything_service.rb', line 71

def get_everything_overdue_cards(assignee_ids: nil, due: nil)
  with_operation(service: "everything", operation: "get_everything_overdue_cards", is_mutation: false) do
    http_get("/cards/overdue.json", params: compact_query_params(assignee_ids: assignee_ids, due: due), operation: "GetEverythingOverdueCards").json
  end
end

#get_everything_overdue_todos(assignee_ids: nil, due: nil) ⇒ Array<Hash>

Get every overdue to-do across all accessible projects, oldest-due-date-first.

Parameters:

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

    Restrict to tasks assigned to at least one of the given people (repeatable). Assignees on nested steps are not considered.

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

    Filter by due date: with, without, or overdue. Unrecognized values are ignored.

Returns:

  • (Array<Hash>) —

    response data



195
196
197
198
199
 
# File 'lib/basecamp/generated/services/everything_service.rb', line 195

def get_everything_overdue_todos(assignee_ids: nil, due: nil)
  with_operation(service: "everything", operation: "get_everything_overdue_todos", is_mutation: false) do
    http_get("/todos/overdue.json", params: compact_query_params(assignee_ids: assignee_ids, due: due), operation: "GetEverythingOverdueTodos").json
  end
end

#get_everything_unassigned_cards(assignee_ids: nil, due: nil, page: nil, max_items: nil) ⇒ ListEnumerator<Hash>

Open, unassigned cards across all accessible projects, grouped by project (paginated).

Parameters:

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

    Restrict to tasks assigned to at least one of the given people (repeatable). Assignees on nested steps are not considered.

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

    Filter by due date: with, without, or overdue. Unrecognized values are ignored.

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

    Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8.

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

    cap on items yielded across pages; nil or non-positive means no cap

Returns:

  • (ListEnumerator<Hash>) —

    lazily paginated results (#meta carries pagination metadata)



84
85
86
87
88
89
 
# File 'lib/basecamp/generated/services/everything_service.rb', line 84

def get_everything_unassigned_cards(assignee_ids: nil, due: nil, page: nil, max_items: nil)
  wrap_paginated(service: "everything", operation: "get_everything_unassigned_cards", is_mutation: false) do
    params = compact_query_params(assignee_ids: assignee_ids, due: due, page: page)
    paginate("/cards/unassigned.json", params: params, operation: "GetEverythingUnassignedCards", max_items: max_items)
  end
end

#get_everything_unassigned_todos(assignee_ids: nil, due: nil, page: nil, max_items: nil) ⇒ ListEnumerator<Hash>

Open, unassigned to-dos across all accessible projects, grouped by project (paginated).

Parameters:

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

    Restrict to tasks assigned to at least one of the given people (repeatable). Assignees on nested steps are not considered.

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

    Filter by due date: with, without, or overdue. Unrecognized values are ignored.

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

    Page number for paginating through results. Defaults to 1. A positive value selects exactly that page, not a starting offset; see SPEC section 8.

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

    cap on items yielded across pages; nil or non-positive means no cap

Returns:

  • (ListEnumerator<Hash>) —

    lazily paginated results (#meta carries pagination metadata)



208
209
210
211
212
213
 
# File 'lib/basecamp/generated/services/everything_service.rb', line 208

def get_everything_unassigned_todos(assignee_ids: nil, due: nil, page: nil, max_items: nil)
  wrap_paginated(service: "everything", operation: "get_everything_unassigned_todos", is_mutation: false) do
    params = compact_query_params(assignee_ids: assignee_ids, due: due, page: page)
    paginate("/todos/unassigned.json", params: params, operation: "GetEverythingUnassignedTodos", max_items: max_items)
  end
end