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



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

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



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

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(page: nil) ⇒ Enumerator<Hash>

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

Parameters:

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

    Page number for paginating through results. Defaults to 1.

Returns:

  • (Enumerator<Hash>) —

    paginated results



13
14
15
16
17
18
 
# File 'lib/basecamp/generated/services/everything_service.rb', line 13

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

#get_everything_completed_todos(page: nil) ⇒ Enumerator<Hash>

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

Parameters:

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

    Page number for paginating through results. Defaults to 1.

Returns:

  • (Enumerator<Hash>) —

    paginated results



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

def get_everything_completed_todos(page: nil)
  wrap_paginated(service: "everything", operation: "get_everything_completed_todos", is_mutation: false) do
    params = compact_query_params(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



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

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



103
104
105
106
107
108
 
# File 'lib/basecamp/generated/services/everything_service.rb', line 103

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



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

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(page: nil) ⇒ Enumerator<Hash>

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

Parameters:

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

    Page number for paginating through results. Defaults to 1.

Returns:

  • (Enumerator<Hash>) —

    paginated results



23
24
25
26
27
28
 
# File 'lib/basecamp/generated/services/everything_service.rb', line 23

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

#get_everything_no_due_date_todos(page: nil) ⇒ Enumerator<Hash>

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

Parameters:

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

    Page number for paginating through results. Defaults to 1.

Returns:

  • (Enumerator<Hash>) —

    paginated results



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

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

#get_everything_not_now_cards(page: nil) ⇒ Enumerator<Hash>

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

Parameters:

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

    Page number for paginating through results. Defaults to 1.

Returns:

  • (Enumerator<Hash>) —

    paginated results



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

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

#get_everything_open_cards(page: nil) ⇒ Enumerator<Hash>

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

Parameters:

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

    Page number for paginating through results. Defaults to 1.

Returns:

  • (Enumerator<Hash>) —

    paginated results



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

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

#get_everything_open_todos(page: nil) ⇒ Enumerator<Hash>

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

Parameters:

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

    Page number for paginating through results. Defaults to 1.

Returns:

  • (Enumerator<Hash>) —

    paginated results



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

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

#get_everything_overdue_cards ⇒ Array<Hash>

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

Returns:

  • (Array<Hash>) —

    response data



52
53
54
55
56
 
# File 'lib/basecamp/generated/services/everything_service.rb', line 52

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

#get_everything_overdue_todos ⇒ Array<Hash>

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

Returns:

  • (Array<Hash>) —

    response data



152
153
154
155
156
 
# File 'lib/basecamp/generated/services/everything_service.rb', line 152

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

#get_everything_unassigned_cards(page: nil) ⇒ Enumerator<Hash>

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

Parameters:

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

    Page number for paginating through results. Defaults to 1.

Returns:

  • (Enumerator<Hash>) —

    paginated results



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

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

#get_everything_unassigned_todos(page: nil) ⇒ Enumerator<Hash>

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

Parameters:

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

    Page number for paginating through results. Defaults to 1.

Returns:

  • (Enumerator<Hash>) —

    paginated results



161
162
163
164
165
166
 
# File 'lib/basecamp/generated/services/everything_service.rb', line 161

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