Class: Helpscout::Mailbox::V2::Reports::Client

Inherits:
Client::Http
  • Object
show all
Includes:
Validate
Defined in:
lib/helpscout/mailbox/v2/reports/client.rb

Instance Method Summary collapse

Methods included from Validate

#camel, #check_dates, #date_range, #date_range_overlap, #format, #valid_date

Constructor Details

#initialize(client_id:, client_secret:) ⇒ Client

Returns a new instance of Client.



13
14
15
16
17
18
19
 
# File 'lib/helpscout/mailbox/v2/reports/client.rb', line 13

def initialize(client_id:, client_secret:)
  super(client_id: client_id, client_secret: client_secret)
  @start = 1.week.ago.beginning_of_day.utc.iso8601
  @end = DateTime.now.beginning_of_day.utc.iso8601
  @prev_start = 3.weeks.ago.beginning_of_day.utc.iso8601
  @prev_end = 2.weeks.ago.beginning_of_day.utc.iso8601
end

Instance Method Details

#get_chat(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, folders: nil, office_hours: nil) ⇒ Object 



193
194
195
196
197
 
# File 'lib/helpscout/mailbox/v2/reports/client.rb', line 193

def get_chat(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, folders: nil, office_hours: nil)
  validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
  api_map = generate_path(:v2_reports_chat, nil)
  request(api_map[:method], api_map[:path], format(validated_dates.merge({ mailboxes: mailboxes, tags: tags, folders: folders, office_hours: office_hours })))
end

#get_company(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, types: nil, folders: nil) ⇒ Object 



25
26
27
28
29
 
# File 'lib/helpscout/mailbox/v2/reports/client.rb', line 25

def get_company(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, types: nil, folders: nil)
  validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
  api_map = generate_path(:v2_reports_company, nil)
  request(api_map[:method], api_map[:path], format(validated_dates.merge({ mailboxes: mailboxes, tags: tags, types: types, folders: folders })))
end

#get_company_customers_helped(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, types: nil, folders: nil, view_by: nil) ⇒ Object 



31
32
33
34
35
 
# File 'lib/helpscout/mailbox/v2/reports/client.rb', line 31

def get_company_customers_helped(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, types: nil, folders: nil, view_by: nil)
  validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
  api_map = generate_path(:v2_reports_company_customers_helped, nil)
  request(api_map[:method], api_map[:path], format(validated_dates.merge({ mailboxes: mailboxes, tags: tags, types: types, folders: folders, view_by: view_by })))
end

#get_company_drilldown(start_date: @start, end_date: @end, mailboxes: nil, tags: nil, types: nil, folders: nil, page: nil, rows: nil, range: 'responseTime', range_id: nil) ⇒ Object 



37
38
39
40
41
 
# File 'lib/helpscout/mailbox/v2/reports/client.rb', line 37

def get_company_drilldown(start_date: @start, end_date: @end, mailboxes: nil, tags: nil, types: nil, folders: nil, page: nil, rows: nil, range: 'responseTime', range_id: nil)
  validated_dates = check_dates(start_date, end_date)
  api_map = generate_path(:v2_reports_company_drilldown, nil)
  request(api_map[:method], api_map[:path], format(validated_dates.merge({ mailboxes: mailboxes, tags: tags, types: types, folders: folders, page: page, rows: rows, range: range, range_id: range_id })))
end

#get_conversations(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, types: nil, folders: nil) ⇒ Object 



43
44
45
46
47
 
# File 'lib/helpscout/mailbox/v2/reports/client.rb', line 43

def get_conversations(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, types: nil, folders: nil)
  validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
  api_map = generate_path(:v2_reports_conversations, nil)
  request(api_map[:method], api_map[:path], format(validated_dates.merge({ mailboxes: mailboxes, tags: tags, types: types, folders: folders })))
end

#get_conversations_busiest_times(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, types: nil, folders: nil) ⇒ Object 



61
62
63
64
65
 
# File 'lib/helpscout/mailbox/v2/reports/client.rb', line 61

def get_conversations_busiest_times(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, types: nil, folders: nil)
  validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
  api_map = generate_path(:v2_reports_conversations_busy_times, nil)
  request(api_map[:method], api_map[:path], format(validated_dates.merge({ mailboxes: mailboxes, tags: tags, types: types, folders: folders })))
end

#get_conversations_channel_volumes(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, types: nil, folders: nil, view_by: nil) ⇒ Object 



55
56
57
58
59
 
# File 'lib/helpscout/mailbox/v2/reports/client.rb', line 55

def get_conversations_channel_volumes(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, types: nil, folders: nil, view_by: nil)
  validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
  api_map = generate_path(:v2_reports_conversations_channel_volume, nil)
  request(api_map[:method], api_map[:path], format(validated_dates.merge({ mailboxes: mailboxes, tags: tags, types: types, folders: folders, view_by: view_by })))
end

#get_conversations_drilldown(start_date: @start, end_date: @end, mailboxes: nil, tags: nil, types: nil, folders: nil, page: nil, rows: nil) ⇒ Object 



67
68
69
70
71
 
# File 'lib/helpscout/mailbox/v2/reports/client.rb', line 67

def get_conversations_drilldown(start_date: @start, end_date: @end, mailboxes: nil, tags: nil, types: nil, folders: nil, page: nil, rows: nil)
  validated_dates = check_dates(start_date, end_date)
  api_map = generate_path(:v2_reports_conversations_drilldown, nil)
  request(api_map[:method], api_map[:path], format(validated_dates.merge({ mailboxes: mailboxes, tags: tags, types: types, folders: folders, page: page, rows: rows })))
end

#get_conversations_drilldown_by_field(start_date: @start, end_date: @end, mailboxes: nil, tags: nil, types: nil, folders: nil, page: nil, rows: nil, field: 'customerid', field_id: 1) ⇒ Object 



73
74
75
76
77
 
# File 'lib/helpscout/mailbox/v2/reports/client.rb', line 73

def get_conversations_drilldown_by_field(start_date: @start, end_date: @end, mailboxes: nil, tags: nil, types: nil, folders: nil, page: nil, rows: nil, field: 'customerid', field_id: 1)
  validated_dates = check_dates(start_date, end_date)
  api_map = generate_path(:v2_reports_conversations_fields_drilldown, nil)
  request(api_map[:method], api_map[:path], format(validated_dates.merge({ mailboxes: mailboxes, tags: tags, types: types, folders: folders, page: page, rows: rows, field: field, fieldid: field_id })))
end

#get_conversations_new_conversations(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, types: nil, folders: nil, view_by: nil) ⇒ Object 



49
50
51
52
53
 
# File 'lib/helpscout/mailbox/v2/reports/client.rb', line 49

def get_conversations_new_conversations(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, types: nil, folders: nil, view_by: nil)
  validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
  api_map = generate_path(:v2_reports_conversations_new, nil)
  request(api_map[:method], api_map[:path], format(validated_dates.merge({ mailboxes: mailboxes, tags: tags, types: types, folders: folders, view_by: view_by })))
end

#get_conversations_new_conversations_drilldown(start_date: @start, end_date: @end, mailboxes: nil, tags: nil, types: nil, folders: nil, page: nil, rows: nil) ⇒ Object 



79
80
81
82
83
 
# File 'lib/helpscout/mailbox/v2/reports/client.rb', line 79

def get_conversations_new_conversations_drilldown(start_date: @start, end_date: @end, mailboxes: nil, tags: nil, types: nil, folders: nil, page: nil, rows: nil)
  validated_dates = check_dates(start_date, end_date)
  api_map = generate_path(:v2_reports_conversations_new_drilldown, nil)
  request(api_map[:method], api_map[:path], format(validated_dates.merge({ mailboxes: mailboxes, tags: tags, types: types, folders: folders, page: page, rows: rows })))
end

#get_conversations_received_message_stats(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, types: nil, folders: nil, view_by: nil) ⇒ Object 



85
86
87
88
89
 
# File 'lib/helpscout/mailbox/v2/reports/client.rb', line 85

def get_conversations_received_message_stats(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, types: nil, folders: nil, view_by: nil)
  validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
  api_map = generate_path(:v2_reports_conversations_messages_received, nil)
  request(api_map[:method], api_map[:path], format(validated_dates.merge({ mailboxes: mailboxes, tags: tags, types: types, folders: folders, view_by: view_by })))
end

#get_defaults ⇒ Object 



21
22
23
 
# File 'lib/helpscout/mailbox/v2/reports/client.rb', line 21

def get_defaults
  { start: @start, end: @end, previous_start: @prev_start, previous_end: @prev_end }
end

#get_docs(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, sites: nil) ⇒ Object 



91
92
93
94
95
 
# File 'lib/helpscout/mailbox/v2/reports/client.rb', line 91

def get_docs(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, sites: nil)
  validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
  api_map = generate_path(:v2_reports_docs, nil)
  request(api_map[:method], api_map[:path], format(validated_dates.merge({ sites: sites })))
end

#get_email(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, folders: nil, office_hours: nil) ⇒ Object 



199
200
201
202
203
 
# File 'lib/helpscout/mailbox/v2/reports/client.rb', line 199

def get_email(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, folders: nil, office_hours: nil)
  validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
  api_map = generate_path(:v2_reports_email, nil)
  request(api_map[:method], api_map[:path], format(validated_dates.merge({ mailboxes: mailboxes, tags: tags, folders: folders, office_hours: office_hours })))
end

#get_happiness(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, types: nil, folders: nil) ⇒ Object 



97
98
99
100
101
 
# File 'lib/helpscout/mailbox/v2/reports/client.rb', line 97

def get_happiness(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, types: nil, folders: nil)
  validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
  api_map = generate_path(:v2_reports_happiness, nil)
  request(api_map[:method], api_map[:path], format(validated_dates.merge({ mailboxes: mailboxes, tags: tags, types: types, folders: folders })))
end

#get_happiness_ratings(start_date: @start, end_date: @end, mailboxes: nil, tags: nil, types: nil, folders: nil, page: nil, rows: nil, field: 'customerid', field_id: 1) ⇒ Object 



103
104
105
106
107
 
# File 'lib/helpscout/mailbox/v2/reports/client.rb', line 103

def get_happiness_ratings(start_date: @start, end_date: @end, mailboxes: nil, tags: nil, types: nil, folders: nil, page: nil, rows: nil, field: 'customerid', field_id: 1)
  validated_dates = check_dates(start_date, end_date)
  api_map = generate_path(:v2_reports_happiness_ratings, nil)
  request(api_map[:method], api_map[:path], format(validated_dates.merge({ mailboxes: mailboxes, tags: tags, types: types, folders: folders, page: page, rating: nil, sort_field: 'rating', sort_order: 'ASC' })))
end

#get_phone(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, folders: nil, office_hours: nil) ⇒ Object 



205
206
207
208
209
 
# File 'lib/helpscout/mailbox/v2/reports/client.rb', line 205

def get_phone(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, folders: nil, office_hours: nil)
  validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
  api_map = generate_path(:v2_reports_phone, nil)
  request(api_map[:method], api_map[:path], format(validated_dates.merge({ mailboxes: mailboxes, tags: tags, folders: folders, office_hours: office_hours })))
end

#get_productivity(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, types: nil, folders: nil, office_hours: nil) ⇒ Object 



109
110
111
112
113
 
# File 'lib/helpscout/mailbox/v2/reports/client.rb', line 109

def get_productivity(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, types: nil, folders: nil, office_hours: nil)
  validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
  api_map = generate_path(:v2_reports_productivity, nil)
  request(api_map[:method], api_map[:path], format(validated_dates.merge({ mailboxes: mailboxes, tags: tags, types: types, folders: folders, office_hours: office_hours })))
end

#get_productivity_first_response_time(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, types: nil, folders: nil, office_hours: nil, view_by: nil) ⇒ Object 



115
116
117
118
119
 
# File 'lib/helpscout/mailbox/v2/reports/client.rb', line 115

def get_productivity_first_response_time(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, types: nil, folders: nil, office_hours: nil, view_by: nil)
  validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
  api_map = generate_path(:v2_reports_productivity_first_response_times, nil)
  request(api_map[:method], api_map[:path], format(validated_dates.merge({ mailboxes: mailboxes, tags: tags, types: types, folders: folders, office_hours: office_hours, view_by: view_by })))
end

#get_productivity_replies_sent(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, types: nil, folders: nil, office_hours: nil, view_by: nil) ⇒ Object 



121
122
123
124
125
 
# File 'lib/helpscout/mailbox/v2/reports/client.rb', line 121

def get_productivity_replies_sent(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, types: nil, folders: nil, office_hours: nil, view_by: nil)
  validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
  api_map = generate_path(:v2_reports_productivity_replies, nil)
  request(api_map[:method], api_map[:path], format(validated_dates.merge({ mailboxes: mailboxes, tags: tags, types: types, folders: folders, office_hours: office_hours, view_by: view_by })))
end

#get_productivity_resolution_time(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, types: nil, folders: nil, office_hours: nil, view_by: nil) ⇒ Object 



127
128
129
130
131
 
# File 'lib/helpscout/mailbox/v2/reports/client.rb', line 127

def get_productivity_resolution_time(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, types: nil, folders: nil, office_hours: nil, view_by: nil)
  validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
  api_map = generate_path(:v2_reports_productivity_resolutions_times, nil)
  request(api_map[:method], api_map[:path], format(validated_dates.merge({ mailboxes: mailboxes, tags: tags, types: types, folders: folders, office_hours: office_hours, view_by: view_by })))
end

#get_productivity_resolved(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, types: nil, folders: nil, office_hours: nil, view_by: nil) ⇒ Object 



133
134
135
136
137
 
# File 'lib/helpscout/mailbox/v2/reports/client.rb', line 133

def get_productivity_resolved(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, types: nil, folders: nil, office_hours: nil, view_by: nil)
  validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
  api_map = generate_path(:v2_reports_productivity_resolved, nil)
  request(api_map[:method], api_map[:path], format(validated_dates.merge({ mailboxes: mailboxes, tags: tags, types: types, folders: folders, office_hours: office_hours, view_by: view_by })))
end

#get_productivity_response_time(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, types: nil, folders: nil, office_hours: nil, view_by: nil) ⇒ Object 



139
140
141
142
143
 
# File 'lib/helpscout/mailbox/v2/reports/client.rb', line 139

def get_productivity_response_time(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, types: nil, folders: nil, office_hours: nil, view_by: nil)
  validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
  api_map = generate_path(:v2_reports_productivity_response_times, nil)
  request(api_map[:method], api_map[:path], format(validated_dates.merge({ mailboxes: mailboxes, tags: tags, types: types, folders: folders, office_hours: office_hours, view_by: view_by })))
end

#get_user(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, types: nil, folders: nil, office_hours: nil, user: 1) ⇒ Object 



145
146
147
148
149
 
# File 'lib/helpscout/mailbox/v2/reports/client.rb', line 145

def get_user(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, types: nil, folders: nil, office_hours: nil, user: 1)
  validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
  api_map = generate_path(:v2_reports_user, nil)
  request(api_map[:method], api_map[:path], format(validated_dates.merge({ mailboxes: mailboxes, tags: tags, types: types, folders: folders, office_hours: office_hours, user: user })))
end

#get_user_conversation_history(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, types: nil, folders: nil, office_hours: nil, user: 1, status: nil, page: nil, sort_field: 'number', sort_order: 'ASC') ⇒ Object 



151
152
153
154
155
 
# File 'lib/helpscout/mailbox/v2/reports/client.rb', line 151

def get_user_conversation_history(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, types: nil, folders: nil, office_hours: nil, user: 1, status: nil, page: nil, sort_field: 'number', sort_order: 'ASC')
  validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
  api_map = generate_path(:v2_reports_user_conversation_history, nil)
  request(api_map[:method], api_map[:path], format(validated_dates.merge({ mailboxes: mailboxes, tags: tags, types: types, folders: folders, office_hours: office_hours, user: user, status: status, page: page, sort_field: sort_field, sort_order: sort_order })))
end

#get_user_customers_helped(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, types: nil, folders: nil, user: 1, view_by: nil) ⇒ Object 



157
158
159
160
161
 
# File 'lib/helpscout/mailbox/v2/reports/client.rb', line 157

def get_user_customers_helped(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, types: nil, folders: nil, user: 1, view_by: nil)
  validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
  api_map = generate_path(:v2_reports_user_customers_helped, nil)
  request(api_map[:method], api_map[:path], format(validated_dates.merge({ mailboxes: mailboxes, tags: tags, types: types, folders: folders, user: user, view_by: view_by })))
end

#get_user_drilldown(start_date: @start, end_date: @end, mailboxes: nil, tags: nil, types: nil, folders: nil, page: nil, rows: nil, user: 1) ⇒ Object 



163
164
165
166
167
 
# File 'lib/helpscout/mailbox/v2/reports/client.rb', line 163

def get_user_drilldown(start_date: @start, end_date: @end, mailboxes: nil, tags: nil, types: nil, folders: nil, page: nil, rows: nil, user: 1)
  validated_dates = check_dates(start_date, end_date)
  api_map = generate_path(:v2_reports_user_drilldown, nil)
  request(api_map[:method], api_map[:path], format(validated_dates.merge({ mailboxes: mailboxes, tags: tags, types: types, folders: folders, page: page, rows: rows, user: user })))
end

#get_user_happiness(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, types: nil, folders: nil, user: 1) ⇒ Object 



169
170
171
172
173
 
# File 'lib/helpscout/mailbox/v2/reports/client.rb', line 169

def get_user_happiness(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, types: nil, folders: nil, user: 1)
  validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
  api_map = generate_path(:v2_reports_user_happiness, nil)
  request(api_map[:method], api_map[:path], format(validated_dates.merge({ mailboxes: mailboxes, tags: tags, types: types, folders: folders, user: user })))
end

#get_user_happiness_drilldown(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, types: nil, folders: nil, user: 1, rating: nil, page: nil, sort_field: 'number', sort_order: 'ASC') ⇒ Object 



175
176
177
178
179
 
# File 'lib/helpscout/mailbox/v2/reports/client.rb', line 175

def get_user_happiness_drilldown(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, types: nil, folders: nil, user: 1, rating: nil, page: nil, sort_field: 'number', sort_order: 'ASC')
  validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
  api_map = generate_path(:v2_reports_user_ratings, nil)
  request(api_map[:method], api_map[:path], format(validated_dates.merge({ mailboxes: mailboxes, tags: tags, types: types, folders: folders, user: user, rating: rating, page: page, sort_field: sort_field, sort_order: sort_order })))
end

#get_user_replies(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, types: nil, folders: nil, user: 1, view_by: nil) ⇒ Object 



181
182
183
184
185
 
# File 'lib/helpscout/mailbox/v2/reports/client.rb', line 181

def get_user_replies(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, types: nil, folders: nil, user: 1, view_by: nil)
  validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
  api_map = generate_path(:v2_reports_user_replies, nil)
  request(api_map[:method], api_map[:path], format(validated_dates.merge({ mailboxes: mailboxes, tags: tags, types: types, folders: folders, user: user, view_by: view_by })))
end

#get_user_resolutions(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, types: nil, folders: nil, user: 1, view_by: nil) ⇒ Object 



187
188
189
190
191
 
# File 'lib/helpscout/mailbox/v2/reports/client.rb', line 187

def get_user_resolutions(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, mailboxes: nil, tags: nil, types: nil, folders: nil, user: 1, view_by: nil)
  validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
  api_map = generate_path(:v2_reports_user_resolutions, nil)
  request(api_map[:method], api_map[:path], format(validated_dates.merge({ mailboxes: mailboxes, tags: tags, types: types, folders: folders, user: user, view_by: view_by })))
end