helpscout-mailbox-v2-reports 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.buildkite/pipeline.yml +6 -0
- data/.gitignore +11 -0
- data/.rspec +3 -0
- data/.ruby-version +1 -0
- data/.travis.yml +6 -0
- data/CODE_OF_CONDUCT.md +74 -0
- data/Dockerfile +8 -0
- data/Gemfile +4 -0
- data/Gemfile.lock +68 -0
- data/LICENSE.txt +21 -0
- data/README.md +1986 -0
- data/Rakefile +6 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/docker-compose.yml +5 -0
- data/helpscout-mailbox-v2-reports.gemspec +34 -0
- data/lib/helpscout/mailbox/v2/reports.rb +14 -0
- data/lib/helpscout/mailbox/v2/reports/client.rb +214 -0
- data/lib/helpscout/mailbox/v2/reports/validate.rb +65 -0
- data/lib/helpscout/mailbox/v2/reports/version.rb +9 -0
- metadata +149 -0
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "helpscout/mailbox/v2/reports"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require "irb"
|
14
|
+
IRB.start(__FILE__)
|
data/bin/setup
ADDED
data/docker-compose.yml
ADDED
@@ -0,0 +1,34 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require_relative 'lib/helpscout/mailbox/v2/reports/version'
|
4
|
+
|
5
|
+
Gem::Specification.new do |spec|
|
6
|
+
spec.name = 'helpscout-mailbox-v2-reports'
|
7
|
+
spec.version = Helpscout::Mailbox::V2::Reports::VERSION
|
8
|
+
spec.authors = ['Jason Jacob']
|
9
|
+
spec.email = ['hipcog@gmail.com']
|
10
|
+
|
11
|
+
spec.summary = 'REST client for HelpScout V2 mailbox reports'
|
12
|
+
spec.homepage = 'https://github.com/jayco/helpscout-mailbox-v2-reports.git'
|
13
|
+
spec.license = 'MIT'
|
14
|
+
|
15
|
+
spec.metadata['homepage_uri'] = spec.homepage
|
16
|
+
spec.metadata['source_code_uri'] = spec.homepage
|
17
|
+
|
18
|
+
# Specify which files should be added to the gem when it is released.
|
19
|
+
# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
|
20
|
+
spec.files = Dir.chdir(File.expand_path(__dir__)) do
|
21
|
+
`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
22
|
+
end
|
23
|
+
spec.bindir = 'exe'
|
24
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
25
|
+
spec.require_paths = ['lib']
|
26
|
+
|
27
|
+
spec.add_runtime_dependency 'activesupport', '~> 6.0'
|
28
|
+
spec.add_runtime_dependency 'helpscout-mailbox-v2-client', '~> 0.1.0'
|
29
|
+
|
30
|
+
spec.add_development_dependency 'bundler', '~> 2.0'
|
31
|
+
spec.add_development_dependency 'rake', '>= 12.3.3'
|
32
|
+
spec.add_development_dependency 'rspec', '~> 3.0'
|
33
|
+
spec.add_development_dependency 'webmock', '~> 3.8'
|
34
|
+
end
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require 'helpscout/mailbox/v2/reports/version'
|
4
|
+
require 'helpscout/mailbox/v2/reports/client'
|
5
|
+
module Helpscout
|
6
|
+
module Mailbox
|
7
|
+
module V2
|
8
|
+
module Reports
|
9
|
+
class Error < StandardError; end
|
10
|
+
# Your code goes here...
|
11
|
+
end
|
12
|
+
end
|
13
|
+
end
|
14
|
+
end
|
@@ -0,0 +1,214 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require 'helpscout/mailbox/v2/client'
|
4
|
+
require_relative './validate'
|
5
|
+
|
6
|
+
module Helpscout
|
7
|
+
module Mailbox
|
8
|
+
module V2
|
9
|
+
module Reports
|
10
|
+
class Client < Helpscout::Mailbox::V2::Client::Http
|
11
|
+
include Helpscout::Mailbox::V2::Reports::Validate
|
12
|
+
|
13
|
+
def initialize(client_id:, client_secret:)
|
14
|
+
super(client_id: client_id, client_secret: client_secret)
|
15
|
+
@start = 1.week.ago.beginning_of_day.utc.iso8601
|
16
|
+
@end = DateTime.now.beginning_of_day.utc.iso8601
|
17
|
+
@prev_start = 3.weeks.ago.beginning_of_day.utc.iso8601
|
18
|
+
@prev_end = 2.weeks.ago.beginning_of_day.utc.iso8601
|
19
|
+
end
|
20
|
+
|
21
|
+
def get_defaults
|
22
|
+
{ start: @start, end: @end, previous_start: @prev_start, previous_end: @prev_end }
|
23
|
+
end
|
24
|
+
|
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)
|
26
|
+
validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
|
27
|
+
api_map = generate_path(:v2_reports_company, nil)
|
28
|
+
request(api_map[:method], api_map[:path], format(validated_dates.merge({ mailboxes: mailboxes, tags: tags, types: types, folders: folders })))
|
29
|
+
end
|
30
|
+
|
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)
|
32
|
+
validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
|
33
|
+
api_map = generate_path(:v2_reports_company_customers_helped, nil)
|
34
|
+
request(api_map[:method], api_map[:path], format(validated_dates.merge({ mailboxes: mailboxes, tags: tags, types: types, folders: folders, view_by: view_by })))
|
35
|
+
end
|
36
|
+
|
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)
|
38
|
+
validated_dates = check_dates(start_date, end_date)
|
39
|
+
api_map = generate_path(:v2_reports_company_drilldown, nil)
|
40
|
+
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 })))
|
41
|
+
end
|
42
|
+
|
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)
|
44
|
+
validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
|
45
|
+
api_map = generate_path(:v2_reports_conversations, nil)
|
46
|
+
request(api_map[:method], api_map[:path], format(validated_dates.merge({ mailboxes: mailboxes, tags: tags, types: types, folders: folders })))
|
47
|
+
end
|
48
|
+
|
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)
|
50
|
+
validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
|
51
|
+
api_map = generate_path(:v2_reports_conversations_new, nil)
|
52
|
+
request(api_map[:method], api_map[:path], format(validated_dates.merge({ mailboxes: mailboxes, tags: tags, types: types, folders: folders, view_by: view_by })))
|
53
|
+
end
|
54
|
+
|
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)
|
56
|
+
validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
|
57
|
+
api_map = generate_path(:v2_reports_conversations_channel_volume, nil)
|
58
|
+
request(api_map[:method], api_map[:path], format(validated_dates.merge({ mailboxes: mailboxes, tags: tags, types: types, folders: folders, view_by: view_by })))
|
59
|
+
end
|
60
|
+
|
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)
|
62
|
+
validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
|
63
|
+
api_map = generate_path(:v2_reports_conversations_busy_times, nil)
|
64
|
+
request(api_map[:method], api_map[:path], format(validated_dates.merge({ mailboxes: mailboxes, tags: tags, types: types, folders: folders })))
|
65
|
+
end
|
66
|
+
|
67
|
+
def get_conversations_drilldown(start_date: @start, end_date: @end, mailboxes: nil, tags: nil, types: nil, folders: nil, page: nil, rows: nil)
|
68
|
+
validated_dates = check_dates(start_date, end_date)
|
69
|
+
api_map = generate_path(:v2_reports_conversations_drilldown, nil)
|
70
|
+
request(api_map[:method], api_map[:path], format(validated_dates.merge({ mailboxes: mailboxes, tags: tags, types: types, folders: folders, page: page, rows: rows })))
|
71
|
+
end
|
72
|
+
|
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)
|
74
|
+
validated_dates = check_dates(start_date, end_date)
|
75
|
+
api_map = generate_path(:v2_reports_conversations_fields_drilldown, nil)
|
76
|
+
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 })))
|
77
|
+
end
|
78
|
+
|
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)
|
80
|
+
validated_dates = check_dates(start_date, end_date)
|
81
|
+
api_map = generate_path(:v2_reports_conversations_new_drilldown, nil)
|
82
|
+
request(api_map[:method], api_map[:path], format(validated_dates.merge({ mailboxes: mailboxes, tags: tags, types: types, folders: folders, page: page, rows: rows })))
|
83
|
+
end
|
84
|
+
|
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)
|
86
|
+
validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
|
87
|
+
api_map = generate_path(:v2_reports_conversations_messages_received, nil)
|
88
|
+
request(api_map[:method], api_map[:path], format(validated_dates.merge({ mailboxes: mailboxes, tags: tags, types: types, folders: folders, view_by: view_by })))
|
89
|
+
end
|
90
|
+
|
91
|
+
def get_docs(start_date: @start, end_date: @end, previous_start_date: @prev_start, previous_end_date: @prev_end, sites: nil)
|
92
|
+
validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
|
93
|
+
api_map = generate_path(:v2_reports_docs, nil)
|
94
|
+
request(api_map[:method], api_map[:path], format(validated_dates.merge({ sites: sites })))
|
95
|
+
end
|
96
|
+
|
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)
|
98
|
+
validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
|
99
|
+
api_map = generate_path(:v2_reports_happiness, nil)
|
100
|
+
request(api_map[:method], api_map[:path], format(validated_dates.merge({ mailboxes: mailboxes, tags: tags, types: types, folders: folders })))
|
101
|
+
end
|
102
|
+
|
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)
|
104
|
+
validated_dates = check_dates(start_date, end_date)
|
105
|
+
api_map = generate_path(:v2_reports_happiness_ratings, nil)
|
106
|
+
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' })))
|
107
|
+
end
|
108
|
+
|
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)
|
110
|
+
validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
|
111
|
+
api_map = generate_path(:v2_reports_productivity, nil)
|
112
|
+
request(api_map[:method], api_map[:path], format(validated_dates.merge({ mailboxes: mailboxes, tags: tags, types: types, folders: folders, office_hours: office_hours })))
|
113
|
+
end
|
114
|
+
|
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)
|
116
|
+
validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
|
117
|
+
api_map = generate_path(:v2_reports_productivity_first_response_times, nil)
|
118
|
+
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 })))
|
119
|
+
end
|
120
|
+
|
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)
|
122
|
+
validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
|
123
|
+
api_map = generate_path(:v2_reports_productivity_replies, nil)
|
124
|
+
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 })))
|
125
|
+
end
|
126
|
+
|
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)
|
128
|
+
validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
|
129
|
+
api_map = generate_path(:v2_reports_productivity_resolutions_times, nil)
|
130
|
+
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 })))
|
131
|
+
end
|
132
|
+
|
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)
|
134
|
+
validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
|
135
|
+
api_map = generate_path(:v2_reports_productivity_resolved, nil)
|
136
|
+
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 })))
|
137
|
+
end
|
138
|
+
|
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)
|
140
|
+
validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
|
141
|
+
api_map = generate_path(:v2_reports_productivity_response_times, nil)
|
142
|
+
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 })))
|
143
|
+
end
|
144
|
+
|
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)
|
146
|
+
validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
|
147
|
+
api_map = generate_path(:v2_reports_user, nil)
|
148
|
+
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 })))
|
149
|
+
end
|
150
|
+
|
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')
|
152
|
+
validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
|
153
|
+
api_map = generate_path(:v2_reports_user_conversation_history, nil)
|
154
|
+
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 })))
|
155
|
+
end
|
156
|
+
|
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)
|
158
|
+
validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
|
159
|
+
api_map = generate_path(:v2_reports_user_customers_helped, nil)
|
160
|
+
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 })))
|
161
|
+
end
|
162
|
+
|
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)
|
164
|
+
validated_dates = check_dates(start_date, end_date)
|
165
|
+
api_map = generate_path(:v2_reports_user_drilldown, nil)
|
166
|
+
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 })))
|
167
|
+
end
|
168
|
+
|
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)
|
170
|
+
validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
|
171
|
+
api_map = generate_path(:v2_reports_user_happiness, nil)
|
172
|
+
request(api_map[:method], api_map[:path], format(validated_dates.merge({ mailboxes: mailboxes, tags: tags, types: types, folders: folders, user: user })))
|
173
|
+
end
|
174
|
+
|
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')
|
176
|
+
validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
|
177
|
+
api_map = generate_path(:v2_reports_user_ratings, nil)
|
178
|
+
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 })))
|
179
|
+
end
|
180
|
+
|
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)
|
182
|
+
validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
|
183
|
+
api_map = generate_path(:v2_reports_user_replies, nil)
|
184
|
+
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 })))
|
185
|
+
end
|
186
|
+
|
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)
|
188
|
+
validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
|
189
|
+
api_map = generate_path(:v2_reports_user_resolutions, nil)
|
190
|
+
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 })))
|
191
|
+
end
|
192
|
+
|
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)
|
194
|
+
validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
|
195
|
+
api_map = generate_path(:v2_reports_chat, nil)
|
196
|
+
request(api_map[:method], api_map[:path], format(validated_dates.merge({ mailboxes: mailboxes, tags: tags, folders: folders, office_hours: office_hours })))
|
197
|
+
end
|
198
|
+
|
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)
|
200
|
+
validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
|
201
|
+
api_map = generate_path(:v2_reports_email, nil)
|
202
|
+
request(api_map[:method], api_map[:path], format(validated_dates.merge({ mailboxes: mailboxes, tags: tags, folders: folders, office_hours: office_hours })))
|
203
|
+
end
|
204
|
+
|
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)
|
206
|
+
validated_dates = check_dates(start_date, end_date, previous_start_date, previous_end_date)
|
207
|
+
api_map = generate_path(:v2_reports_phone, nil)
|
208
|
+
request(api_map[:method], api_map[:path], format(validated_dates.merge({ mailboxes: mailboxes, tags: tags, folders: folders, office_hours: office_hours })))
|
209
|
+
end
|
210
|
+
end
|
211
|
+
end
|
212
|
+
end
|
213
|
+
end
|
214
|
+
end
|
@@ -0,0 +1,65 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require 'active_support/all'
|
4
|
+
|
5
|
+
module Helpscout
|
6
|
+
module Mailbox
|
7
|
+
module V2
|
8
|
+
module Reports
|
9
|
+
module Validate
|
10
|
+
def camel(value)
|
11
|
+
value.to_s.split('_').inject { |m, p| m + p.capitalize }
|
12
|
+
end
|
13
|
+
|
14
|
+
def format(args = {})
|
15
|
+
res = {}
|
16
|
+
args.each { |k, v| res[camel(k)] = v unless v.nil? }
|
17
|
+
res
|
18
|
+
end
|
19
|
+
|
20
|
+
def valid_date(date_range)
|
21
|
+
date_range.each { |_k, v| Time.iso8601(v) }
|
22
|
+
end
|
23
|
+
|
24
|
+
def date_range_overlap(date_range)
|
25
|
+
(date_range[:start]..date_range[:end]).overlaps?(date_range[:previous_start]..date_range[:previous_end])
|
26
|
+
end
|
27
|
+
|
28
|
+
def date_range(date_range, include_previous = false)
|
29
|
+
if date_range[:start] > date_range[:end]
|
30
|
+
raise 'end date must be after start date'
|
31
|
+
end
|
32
|
+
|
33
|
+
return unless include_previous
|
34
|
+
|
35
|
+
if date_range[:previous_start] > date_range[:previous_end]
|
36
|
+
raise 'prev end date must be after previous start date'
|
37
|
+
end
|
38
|
+
|
39
|
+
if date_range[:end] < date_range[:previous_start]
|
40
|
+
raise 'end date must be after previous start date'
|
41
|
+
end
|
42
|
+
|
43
|
+
if date_range_overlap(date_range)
|
44
|
+
raise 'the date range has overlapping dates'
|
45
|
+
end
|
46
|
+
end
|
47
|
+
|
48
|
+
def check_dates(start_date, end_date, previous_start_date = nil, previous_end_date = nil)
|
49
|
+
if previous_start_date.nil? && previous_end_date.nil?
|
50
|
+
date_range = { start: start_date, end: end_date }
|
51
|
+
valid_date(date_range)
|
52
|
+
date_range(date_range)
|
53
|
+
return date_range
|
54
|
+
end
|
55
|
+
|
56
|
+
date_range = { start: start_date, end: end_date, previous_start: previous_start_date, previous_end: previous_end_date }
|
57
|
+
valid_date(date_range)
|
58
|
+
date_range(date_range, true)
|
59
|
+
date_range
|
60
|
+
end
|
61
|
+
end
|
62
|
+
end
|
63
|
+
end
|
64
|
+
end
|
65
|
+
end
|
metadata
ADDED
@@ -0,0 +1,149 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: helpscout-mailbox-v2-reports
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Jason Jacob
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2020-03-17 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: activesupport
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '6.0'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '6.0'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: helpscout-mailbox-v2-client
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: 0.1.0
|
34
|
+
type: :runtime
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: 0.1.0
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: bundler
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '2.0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '2.0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: rake
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - ">="
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: 12.3.3
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - ">="
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: 12.3.3
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: rspec
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - "~>"
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '3.0'
|
76
|
+
type: :development
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - "~>"
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '3.0'
|
83
|
+
- !ruby/object:Gem::Dependency
|
84
|
+
name: webmock
|
85
|
+
requirement: !ruby/object:Gem::Requirement
|
86
|
+
requirements:
|
87
|
+
- - "~>"
|
88
|
+
- !ruby/object:Gem::Version
|
89
|
+
version: '3.8'
|
90
|
+
type: :development
|
91
|
+
prerelease: false
|
92
|
+
version_requirements: !ruby/object:Gem::Requirement
|
93
|
+
requirements:
|
94
|
+
- - "~>"
|
95
|
+
- !ruby/object:Gem::Version
|
96
|
+
version: '3.8'
|
97
|
+
description:
|
98
|
+
email:
|
99
|
+
- hipcog@gmail.com
|
100
|
+
executables: []
|
101
|
+
extensions: []
|
102
|
+
extra_rdoc_files: []
|
103
|
+
files:
|
104
|
+
- ".buildkite/pipeline.yml"
|
105
|
+
- ".gitignore"
|
106
|
+
- ".rspec"
|
107
|
+
- ".ruby-version"
|
108
|
+
- ".travis.yml"
|
109
|
+
- CODE_OF_CONDUCT.md
|
110
|
+
- Dockerfile
|
111
|
+
- Gemfile
|
112
|
+
- Gemfile.lock
|
113
|
+
- LICENSE.txt
|
114
|
+
- README.md
|
115
|
+
- Rakefile
|
116
|
+
- bin/console
|
117
|
+
- bin/setup
|
118
|
+
- docker-compose.yml
|
119
|
+
- helpscout-mailbox-v2-reports.gemspec
|
120
|
+
- lib/helpscout/mailbox/v2/reports.rb
|
121
|
+
- lib/helpscout/mailbox/v2/reports/client.rb
|
122
|
+
- lib/helpscout/mailbox/v2/reports/validate.rb
|
123
|
+
- lib/helpscout/mailbox/v2/reports/version.rb
|
124
|
+
homepage: https://github.com/jayco/helpscout-mailbox-v2-reports.git
|
125
|
+
licenses:
|
126
|
+
- MIT
|
127
|
+
metadata:
|
128
|
+
homepage_uri: https://github.com/jayco/helpscout-mailbox-v2-reports.git
|
129
|
+
source_code_uri: https://github.com/jayco/helpscout-mailbox-v2-reports.git
|
130
|
+
post_install_message:
|
131
|
+
rdoc_options: []
|
132
|
+
require_paths:
|
133
|
+
- lib
|
134
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
135
|
+
requirements:
|
136
|
+
- - ">="
|
137
|
+
- !ruby/object:Gem::Version
|
138
|
+
version: '0'
|
139
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
140
|
+
requirements:
|
141
|
+
- - ">="
|
142
|
+
- !ruby/object:Gem::Version
|
143
|
+
version: '0'
|
144
|
+
requirements: []
|
145
|
+
rubygems_version: 3.1.2
|
146
|
+
signing_key:
|
147
|
+
specification_version: 4
|
148
|
+
summary: REST client for HelpScout V2 mailbox reports
|
149
|
+
test_files: []
|