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) ⇒ Enumerator<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.

Returns:

  • (Enumerator<Hash>) —

    paginated results



89
90
91
92
93
94
 
# File 'lib/basecamp/generated/services/everything_service.rb', line 89

def get_everything_checkins(page: 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")
  end
end

#get_everything_comments(page: nil) ⇒ Enumerator<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.

Returns:

  • (Enumerator<Hash>) —

    paginated results



99
100
101
102
103
104
 
# File 'lib/basecamp/generated/services/everything_service.rb', line 99

def get_everything_comments(page: 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")
  end
end

#get_everything_completed_cards(assignee_ids: nil, due: nil, page: nil) ⇒ Enumerator<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.

Returns:

  • (Enumerator<Hash>) —

    paginated results



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

def get_everything_completed_cards(assignee_ids: nil, due: nil, page: 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")
  end
end

#get_everything_completed_todos(assignee_ids: nil, due: nil, page: nil) ⇒ Enumerator<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.

Returns:

  • (Enumerator<Hash>) —

    paginated results



144
145
146
147
148
149
 
# File 'lib/basecamp/generated/services/everything_service.rb', line 144

def get_everything_completed_todos(assignee_ids: nil, due: nil, page: 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")
  end
end

#get_everything_files(kind: nil, people_ids: nil, page: nil) ⇒ Enumerator<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.

Returns:

  • (Enumerator<Hash>) —

    paginated results



111
112
113
114
115
116
 
# File 'lib/basecamp/generated/services/everything_service.rb', line 111

def get_everything_files(kind: nil, people_ids: nil, page: 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")
  end
end

#get_everything_forwards(page: nil) ⇒ Enumerator<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.

Returns:

  • (Enumerator<Hash>) —

    paginated results



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

def get_everything_forwards(page: 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")
  end
end

#get_everything_messages(page: nil) ⇒ Enumerator<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.

Returns:

  • (Enumerator<Hash>) —

    paginated results



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

def get_everything_messages(page: 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")
  end
end

#get_everything_no_due_date_cards(assignee_ids: nil, due: nil, page: nil) ⇒ Enumerator<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.

Returns:

  • (Enumerator<Hash>) —

    paginated results



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

def get_everything_no_due_date_cards(assignee_ids: nil, due: nil, page: 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")
  end
end

#get_everything_no_due_date_todos(assignee_ids: nil, due: nil, page: nil) ⇒ Enumerator<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.

Returns:

  • (Enumerator<Hash>) —

    paginated results



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

def get_everything_no_due_date_todos(assignee_ids: nil, due: nil, page: 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")
  end
end

#get_everything_not_now_cards(assignee_ids: nil, due: nil, page: nil) ⇒ Enumerator<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.

Returns:

  • (Enumerator<Hash>) —

    paginated results



42
43
44
45
46
47
 
# File 'lib/basecamp/generated/services/everything_service.rb', line 42

def get_everything_not_now_cards(assignee_ids: nil, due: nil, page: 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")
  end
end

#get_everything_open_cards(assignee_ids: nil, due: nil, page: nil) ⇒ Enumerator<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.

Returns:

  • (Enumerator<Hash>) —

    paginated results



55
56
57
58
59
60
 
# File 'lib/basecamp/generated/services/everything_service.rb', line 55

def get_everything_open_cards(assignee_ids: nil, due: nil, page: 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")
  end
end

#get_everything_open_todos(assignee_ids: nil, due: nil, page: nil) ⇒ Enumerator<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.

Returns:

  • (Enumerator<Hash>) —

    paginated results



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

def get_everything_open_todos(assignee_ids: nil, due: nil, page: 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")
  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



67
68
69
70
71
 
# File 'lib/basecamp/generated/services/everything_service.rb', line 67

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



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

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) ⇒ Enumerator<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.

Returns:

  • (Enumerator<Hash>) —

    paginated results



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

def get_everything_unassigned_cards(assignee_ids: nil, due: nil, page: 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")
  end
end

#get_everything_unassigned_todos(assignee_ids: nil, due: nil, page: nil) ⇒ Enumerator<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.

Returns:

  • (Enumerator<Hash>) —

    paginated results



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

def get_everything_unassigned_todos(assignee_ids: nil, due: nil, page: 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")
  end
end