halo_msp_api 0.1.0 → 0.3.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 +4 -4
- data/CHANGELOG.md +25 -0
- data/Gemfile +3 -8
- data/README.md +32 -32
- data/Rakefile +3 -3
- data/examples/basic_usage.rb +95 -31
- data/lib/halo_msp_api/client.rb +49 -28
- data/lib/halo_msp_api/configuration.rb +1 -0
- data/lib/halo_msp_api/error.rb +1 -0
- data/lib/halo_msp_api/resources/actions.rb +21 -20
- data/lib/halo_msp_api/resources/agents.rb +24 -23
- data/lib/halo_msp_api/resources/appointments.rb +18 -17
- data/lib/halo_msp_api/resources/assets.rb +33 -32
- data/lib/halo_msp_api/resources/base.rb +12 -10
- data/lib/halo_msp_api/resources/clients.rb +26 -30
- data/lib/halo_msp_api/resources/integrations.rb +109 -106
- data/lib/halo_msp_api/resources/invoices.rb +32 -31
- data/lib/halo_msp_api/resources/knowledge_base.rb +17 -16
- data/lib/halo_msp_api/resources/organisations.rb +11 -10
- data/lib/halo_msp_api/resources/products.rb +33 -0
- data/lib/halo_msp_api/resources/purchase_orders.rb +16 -15
- data/lib/halo_msp_api/resources/quotations.rb +14 -13
- data/lib/halo_msp_api/resources/reports.rb +23 -22
- data/lib/halo_msp_api/resources/sales_orders.rb +16 -15
- data/lib/halo_msp_api/resources/services.rb +39 -38
- data/lib/halo_msp_api/resources/slas.rb +21 -20
- data/lib/halo_msp_api/resources/suppliers.rb +16 -15
- data/lib/halo_msp_api/resources/tickets.rb +63 -45
- data/lib/halo_msp_api/resources/users.rb +20 -24
- data/lib/halo_msp_api/resources/webhooks.rb +22 -21
- data/lib/halo_msp_api/version.rb +1 -1
- data/lib/halo_msp_api.rb +26 -24
- metadata +12 -14
|
@@ -2,55 +2,56 @@
|
|
|
2
2
|
|
|
3
3
|
module HaloMspApi
|
|
4
4
|
module Resources
|
|
5
|
+
# Resource class for Sales Orders
|
|
5
6
|
class SalesOrders < Base
|
|
6
7
|
# GET /SalesOrder - List of Sales Orders
|
|
7
|
-
def
|
|
8
|
-
list_resource(
|
|
8
|
+
def sales_orders(params = {})
|
|
9
|
+
list_resource('SalesOrder', params)
|
|
9
10
|
end
|
|
10
11
|
|
|
11
12
|
# GET /SalesOrder/{id} - Get a specific Sales Order
|
|
12
|
-
def
|
|
13
|
-
get_resource(
|
|
13
|
+
def sales_order(id, params = {})
|
|
14
|
+
get_resource('SalesOrder', id, params)
|
|
14
15
|
end
|
|
15
16
|
|
|
16
17
|
# POST /SalesOrder - Create a new Sales Order
|
|
17
|
-
def
|
|
18
|
-
create_resource(
|
|
18
|
+
def create_sales_order(data)
|
|
19
|
+
create_resource('SalesOrder', data)
|
|
19
20
|
end
|
|
20
21
|
|
|
21
22
|
# PUT /SalesOrder/{id} - Update a Sales Order
|
|
22
|
-
def
|
|
23
|
-
update_resource(
|
|
23
|
+
def update_sales_order(id, data)
|
|
24
|
+
update_resource('SalesOrder', id, data)
|
|
24
25
|
end
|
|
25
26
|
|
|
26
27
|
# DELETE /SalesOrder/{id} - Delete a Sales Order
|
|
27
|
-
def
|
|
28
|
-
delete_resource(
|
|
28
|
+
def delete_sales_order(id)
|
|
29
|
+
delete_resource('SalesOrder', id)
|
|
29
30
|
end
|
|
30
31
|
|
|
31
32
|
# POST /SalesOrder/Approval - Sales Order approval
|
|
32
33
|
def approval(data)
|
|
33
|
-
post(resource_path(
|
|
34
|
+
post(resource_path('SalesOrder', nil, 'Approval'), data)
|
|
34
35
|
end
|
|
35
36
|
|
|
36
37
|
# GET /SalesOrder/Lines - Get Sales Order lines
|
|
37
38
|
def lines(params = {})
|
|
38
|
-
get(resource_path(
|
|
39
|
+
get(resource_path('SalesOrder', nil, 'Lines'), params)
|
|
39
40
|
end
|
|
40
41
|
|
|
41
42
|
# GET /SalesOrder/NextRef - Get next Sales Order reference
|
|
42
43
|
def next_ref(params = {})
|
|
43
|
-
get(resource_path(
|
|
44
|
+
get(resource_path('SalesOrder', nil, 'NextRef'), params)
|
|
44
45
|
end
|
|
45
46
|
|
|
46
47
|
# POST /SalesOrder/updatelines - Update Sales Order lines
|
|
47
48
|
def update_lines(data)
|
|
48
|
-
post(resource_path(
|
|
49
|
+
post(resource_path('SalesOrder', nil, 'updatelines'), data)
|
|
49
50
|
end
|
|
50
51
|
|
|
51
52
|
# GET /SalesOrder/View - Get Sales Order view
|
|
52
53
|
def view(params = {})
|
|
53
|
-
get(resource_path(
|
|
54
|
+
get(resource_path('SalesOrder', nil, 'View'), params)
|
|
54
55
|
end
|
|
55
56
|
end
|
|
56
57
|
end
|
|
@@ -2,175 +2,176 @@
|
|
|
2
2
|
|
|
3
3
|
module HaloMspApi
|
|
4
4
|
module Resources
|
|
5
|
+
# Resource class for Services
|
|
5
6
|
class Services < Base
|
|
6
7
|
# GET /Service - List of Services
|
|
7
|
-
def
|
|
8
|
-
list_resource(
|
|
8
|
+
def services(params = {})
|
|
9
|
+
list_resource('Service', params)
|
|
9
10
|
end
|
|
10
11
|
|
|
11
12
|
# GET /Service/{id} - Get a specific Service
|
|
12
|
-
def
|
|
13
|
-
get_resource(
|
|
13
|
+
def service(id, params = {})
|
|
14
|
+
get_resource('Service', id, params)
|
|
14
15
|
end
|
|
15
16
|
|
|
16
17
|
# POST /Service - Create a new Service
|
|
17
|
-
def
|
|
18
|
-
create_resource(
|
|
18
|
+
def create_service(data)
|
|
19
|
+
create_resource('Service', data)
|
|
19
20
|
end
|
|
20
21
|
|
|
21
22
|
# PUT /Service/{id} - Update a Service
|
|
22
|
-
def
|
|
23
|
-
update_resource(
|
|
23
|
+
def update_service(id, data)
|
|
24
|
+
update_resource('Service', id, data)
|
|
24
25
|
end
|
|
25
26
|
|
|
26
27
|
# DELETE /Service/{id} - Delete a Service
|
|
27
|
-
def
|
|
28
|
-
delete_resource(
|
|
28
|
+
def delete_service(id)
|
|
29
|
+
delete_resource('Service', id)
|
|
29
30
|
end
|
|
30
31
|
|
|
31
32
|
# POST /Service/unsubscribe - Unsubscribe from Service
|
|
32
33
|
def unsubscribe(data)
|
|
33
|
-
post(resource_path(
|
|
34
|
+
post(resource_path('Service', nil, 'unsubscribe'), data)
|
|
34
35
|
end
|
|
35
36
|
|
|
36
37
|
# Service Availability methods
|
|
37
38
|
# GET /ServiceAvailability - List Service availabilities
|
|
38
39
|
def availabilities(params = {})
|
|
39
|
-
|
|
40
|
+
list_resource('ServiceAvailability', params)
|
|
40
41
|
end
|
|
41
42
|
|
|
42
43
|
# GET /ServiceAvailability/{id} - Get specific Service availability
|
|
43
44
|
def availability(id, params = {})
|
|
44
|
-
|
|
45
|
+
get_resource('ServiceAvailability', id, params)
|
|
45
46
|
end
|
|
46
47
|
|
|
47
48
|
# POST /ServiceAvailability - Create Service availability
|
|
48
49
|
def create_availability(data)
|
|
49
|
-
|
|
50
|
+
create_resource('ServiceAvailability', data)
|
|
50
51
|
end
|
|
51
52
|
|
|
52
53
|
# PUT /ServiceAvailability/{id} - Update Service availability
|
|
53
54
|
def update_availability(id, data)
|
|
54
|
-
|
|
55
|
+
update_resource('ServiceAvailability', id, data)
|
|
55
56
|
end
|
|
56
57
|
|
|
57
58
|
# DELETE /ServiceAvailability/{id} - Delete Service availability
|
|
58
59
|
def delete_availability(id)
|
|
59
|
-
|
|
60
|
+
delete_resource('ServiceAvailability', id)
|
|
60
61
|
end
|
|
61
62
|
|
|
62
63
|
# Service Category methods
|
|
63
64
|
# GET /ServiceCategory - List Service categories
|
|
64
65
|
def categories(params = {})
|
|
65
|
-
|
|
66
|
+
list_resource('ServiceCategory', params)
|
|
66
67
|
end
|
|
67
68
|
|
|
68
69
|
# GET /ServiceCategory/{id} - Get specific Service category
|
|
69
70
|
def category(id, params = {})
|
|
70
|
-
|
|
71
|
+
get_resource('ServiceCategory', id, params)
|
|
71
72
|
end
|
|
72
73
|
|
|
73
74
|
# POST /ServiceCategory - Create Service category
|
|
74
75
|
def create_category(data)
|
|
75
|
-
|
|
76
|
+
create_resource('ServiceCategory', data)
|
|
76
77
|
end
|
|
77
78
|
|
|
78
79
|
# PUT /ServiceCategory/{id} - Update Service category
|
|
79
80
|
def update_category(id, data)
|
|
80
|
-
|
|
81
|
+
update_resource('ServiceCategory', id, data)
|
|
81
82
|
end
|
|
82
83
|
|
|
83
84
|
# DELETE /ServiceCategory/{id} - Delete Service category
|
|
84
85
|
def delete_category(id)
|
|
85
|
-
|
|
86
|
+
delete_resource('ServiceCategory', id)
|
|
86
87
|
end
|
|
87
88
|
|
|
88
89
|
# Service Request Details methods
|
|
89
90
|
# GET /ServiceRequestDetails - List Service request details
|
|
90
91
|
def request_details(params = {})
|
|
91
|
-
|
|
92
|
+
list_resource('ServiceRequestDetails', params)
|
|
92
93
|
end
|
|
93
94
|
|
|
94
95
|
# GET /ServiceRequestDetails/{id} - Get specific Service request details
|
|
95
96
|
def request_detail(id, params = {})
|
|
96
|
-
|
|
97
|
+
get_resource('ServiceRequestDetails', id, params)
|
|
97
98
|
end
|
|
98
99
|
|
|
99
100
|
# POST /ServiceRequestDetails - Create Service request details
|
|
100
101
|
def create_request_detail(data)
|
|
101
|
-
|
|
102
|
+
create_resource('ServiceRequestDetails', data)
|
|
102
103
|
end
|
|
103
104
|
|
|
104
105
|
# PUT /ServiceRequestDetails/{id} - Update Service request details
|
|
105
106
|
def update_request_detail(id, data)
|
|
106
|
-
|
|
107
|
+
update_resource('ServiceRequestDetails', id, data)
|
|
107
108
|
end
|
|
108
109
|
|
|
109
110
|
# DELETE /ServiceRequestDetails/{id} - Delete Service request details
|
|
110
111
|
def delete_request_detail(id)
|
|
111
|
-
|
|
112
|
+
delete_resource('ServiceRequestDetails', id)
|
|
112
113
|
end
|
|
113
114
|
|
|
114
115
|
# Service Restriction methods
|
|
115
116
|
# GET /ServiceRestriction - List Service restrictions
|
|
116
117
|
def restrictions(params = {})
|
|
117
|
-
|
|
118
|
+
list_resource('ServiceRestriction', params)
|
|
118
119
|
end
|
|
119
120
|
|
|
120
121
|
# POST /ServiceRestriction - Create Service restriction
|
|
121
122
|
def create_restriction(data)
|
|
122
|
-
|
|
123
|
+
create_resource('ServiceRestriction', data)
|
|
123
124
|
end
|
|
124
125
|
|
|
125
126
|
# Service Status methods
|
|
126
127
|
# GET /ServiceStatus - List Service statuses
|
|
127
128
|
def statuses(params = {})
|
|
128
|
-
|
|
129
|
+
list_resource('ServiceStatus', params)
|
|
129
130
|
end
|
|
130
131
|
|
|
131
132
|
# GET /ServiceStatus/{id} - Get specific Service status
|
|
132
133
|
def status(id, params = {})
|
|
133
|
-
|
|
134
|
+
get_resource('ServiceStatus', id, params)
|
|
134
135
|
end
|
|
135
136
|
|
|
136
137
|
# POST /ServiceStatus - Create Service status
|
|
137
138
|
def create_status(data)
|
|
138
|
-
|
|
139
|
+
create_resource('ServiceStatus', data)
|
|
139
140
|
end
|
|
140
141
|
|
|
141
142
|
# PUT /ServiceStatus/{id} - Update Service status
|
|
142
143
|
def update_status(id, data)
|
|
143
|
-
|
|
144
|
+
update_resource('ServiceStatus', id, data)
|
|
144
145
|
end
|
|
145
146
|
|
|
146
147
|
# DELETE /ServiceStatus/{id} - Delete Service status
|
|
147
148
|
def delete_status(id)
|
|
148
|
-
|
|
149
|
+
delete_resource('ServiceStatus', id)
|
|
149
150
|
end
|
|
150
151
|
|
|
151
152
|
# GET /ServiceStatus/Subscribe - List Service status subscriptions
|
|
152
153
|
def status_subscriptions(params = {})
|
|
153
|
-
|
|
154
|
+
list_resource('ServiceStatus/Subscribe', params)
|
|
154
155
|
end
|
|
155
156
|
|
|
156
157
|
# GET /ServiceStatus/Subscribe/{id} - Get specific Service status subscription
|
|
157
158
|
def status_subscription(id, params = {})
|
|
158
|
-
|
|
159
|
+
get_resource('ServiceStatus/Subscribe', id, params)
|
|
159
160
|
end
|
|
160
161
|
|
|
161
162
|
# POST /ServiceStatus/Subscribe - Create Service status subscription
|
|
162
163
|
def create_status_subscription(data)
|
|
163
|
-
|
|
164
|
+
create_resource('ServiceStatus/Subscribe', data)
|
|
164
165
|
end
|
|
165
166
|
|
|
166
167
|
# PUT /ServiceStatus/Subscribe/{id} - Update Service status subscription
|
|
167
168
|
def update_status_subscription(id, data)
|
|
168
|
-
|
|
169
|
+
update_resource('ServiceStatus/Subscribe', id, data)
|
|
169
170
|
end
|
|
170
171
|
|
|
171
172
|
# DELETE /ServiceStatus/Subscribe/{id} - Delete Service status subscription
|
|
172
173
|
def delete_status_subscription(id)
|
|
173
|
-
|
|
174
|
+
delete_resource('ServiceStatus/Subscribe', id)
|
|
174
175
|
end
|
|
175
176
|
end
|
|
176
177
|
end
|
|
@@ -2,82 +2,83 @@
|
|
|
2
2
|
|
|
3
3
|
module HaloMspApi
|
|
4
4
|
module Resources
|
|
5
|
+
# Resource class for SLAs
|
|
5
6
|
class Slas < Base
|
|
6
7
|
# GET /SLA - List of SLAs
|
|
7
|
-
def
|
|
8
|
-
list_resource(
|
|
8
|
+
def slas(params = {})
|
|
9
|
+
list_resource('SLA', params)
|
|
9
10
|
end
|
|
10
11
|
|
|
11
12
|
# GET /SLA/{id} - Get a specific SLA
|
|
12
|
-
def
|
|
13
|
-
get_resource(
|
|
13
|
+
def sla(id, params = {})
|
|
14
|
+
get_resource('SLA', id, params)
|
|
14
15
|
end
|
|
15
16
|
|
|
16
17
|
# POST /SLA - Create a new SLA
|
|
17
|
-
def
|
|
18
|
-
create_resource(
|
|
18
|
+
def create_sla(data)
|
|
19
|
+
create_resource('SLA', data)
|
|
19
20
|
end
|
|
20
21
|
|
|
21
22
|
# PUT /SLA/{id} - Update an SLA
|
|
22
|
-
def
|
|
23
|
-
update_resource(
|
|
23
|
+
def update_sla(id, data)
|
|
24
|
+
update_resource('SLA', id, data)
|
|
24
25
|
end
|
|
25
26
|
|
|
26
27
|
# DELETE /SLA/{id} - Delete an SLA
|
|
27
|
-
def
|
|
28
|
-
delete_resource(
|
|
28
|
+
def delete_sla(id)
|
|
29
|
+
delete_resource('SLA', id)
|
|
29
30
|
end
|
|
30
31
|
|
|
31
32
|
# SLA Policy methods
|
|
32
33
|
# GET /SLAPolicy - List SLA policies
|
|
33
34
|
def policies(params = {})
|
|
34
|
-
|
|
35
|
+
list_resource('SLAPolicy', params)
|
|
35
36
|
end
|
|
36
37
|
|
|
37
38
|
# GET /SLAPolicy/{id} - Get specific SLA policy
|
|
38
39
|
def policy(id, params = {})
|
|
39
|
-
|
|
40
|
+
get_resource('SLAPolicy', id, params)
|
|
40
41
|
end
|
|
41
42
|
|
|
42
43
|
# POST /SLAPolicy - Create SLA policy
|
|
43
44
|
def create_policy(data)
|
|
44
|
-
|
|
45
|
+
create_resource('SLAPolicy', data)
|
|
45
46
|
end
|
|
46
47
|
|
|
47
48
|
# PUT /SLAPolicy/{id} - Update SLA policy
|
|
48
49
|
def update_policy(id, data)
|
|
49
|
-
|
|
50
|
+
update_resource('SLAPolicy', id, data)
|
|
50
51
|
end
|
|
51
52
|
|
|
52
53
|
# DELETE /SLAPolicy/{id} - Delete SLA policy
|
|
53
54
|
def delete_policy(id)
|
|
54
|
-
|
|
55
|
+
delete_resource('SLAPolicy', id)
|
|
55
56
|
end
|
|
56
57
|
|
|
57
58
|
# SLA Target methods
|
|
58
59
|
# GET /SLATarget - List SLA targets
|
|
59
60
|
def targets(params = {})
|
|
60
|
-
|
|
61
|
+
list_resource('SLATarget', params)
|
|
61
62
|
end
|
|
62
63
|
|
|
63
64
|
# GET /SLATarget/{id} - Get specific SLA target
|
|
64
65
|
def target(id, params = {})
|
|
65
|
-
|
|
66
|
+
get_resource('SLATarget', id, params)
|
|
66
67
|
end
|
|
67
68
|
|
|
68
69
|
# POST /SLATarget - Create SLA target
|
|
69
70
|
def create_target(data)
|
|
70
|
-
|
|
71
|
+
create_resource('SLATarget', data)
|
|
71
72
|
end
|
|
72
73
|
|
|
73
74
|
# PUT /SLATarget/{id} - Update SLA target
|
|
74
75
|
def update_target(id, data)
|
|
75
|
-
|
|
76
|
+
update_resource('SLATarget', id, data)
|
|
76
77
|
end
|
|
77
78
|
|
|
78
79
|
# DELETE /SLATarget/{id} - Delete SLA target
|
|
79
80
|
def delete_target(id)
|
|
80
|
-
|
|
81
|
+
delete_resource('SLATarget', id)
|
|
81
82
|
end
|
|
82
83
|
end
|
|
83
84
|
end
|
|
@@ -2,56 +2,57 @@
|
|
|
2
2
|
|
|
3
3
|
module HaloMspApi
|
|
4
4
|
module Resources
|
|
5
|
+
# Resource class for Suppliers
|
|
5
6
|
class Suppliers < Base
|
|
6
7
|
# GET /Supplier - List of Suppliers
|
|
7
|
-
def
|
|
8
|
-
list_resource(
|
|
8
|
+
def suppliers(params = {})
|
|
9
|
+
list_resource('Supplier', params)
|
|
9
10
|
end
|
|
10
11
|
|
|
11
12
|
# GET /Supplier/{id} - Get a specific Supplier
|
|
12
|
-
def
|
|
13
|
-
get_resource(
|
|
13
|
+
def supplier(id, params = {})
|
|
14
|
+
get_resource('Supplier', id, params)
|
|
14
15
|
end
|
|
15
16
|
|
|
16
17
|
# POST /Supplier - Create a new Supplier
|
|
17
|
-
def
|
|
18
|
-
create_resource(
|
|
18
|
+
def create_supplier(data)
|
|
19
|
+
create_resource('Supplier', data)
|
|
19
20
|
end
|
|
20
21
|
|
|
21
22
|
# PUT /Supplier/{id} - Update a Supplier
|
|
22
|
-
def
|
|
23
|
-
update_resource(
|
|
23
|
+
def update_supplier(id, data)
|
|
24
|
+
update_resource('Supplier', id, data)
|
|
24
25
|
end
|
|
25
26
|
|
|
26
27
|
# DELETE /Supplier/{id} - Delete a Supplier
|
|
27
|
-
def
|
|
28
|
-
delete_resource(
|
|
28
|
+
def delete_supplier(id)
|
|
29
|
+
delete_resource('Supplier', id)
|
|
29
30
|
end
|
|
30
31
|
|
|
31
32
|
# Supplier Contract methods
|
|
32
33
|
# GET /SupplierContract - List Supplier contracts
|
|
33
34
|
def contracts(params = {})
|
|
34
|
-
|
|
35
|
+
list_resource('SupplierContract', params)
|
|
35
36
|
end
|
|
36
37
|
|
|
37
38
|
# GET /SupplierContract/{id} - Get specific Supplier contract
|
|
38
39
|
def contract(id, params = {})
|
|
39
|
-
|
|
40
|
+
get_resource('SupplierContract', id, params)
|
|
40
41
|
end
|
|
41
42
|
|
|
42
43
|
# POST /SupplierContract - Create Supplier contract
|
|
43
44
|
def create_contract(data)
|
|
44
|
-
|
|
45
|
+
create_resource('SupplierContract', data)
|
|
45
46
|
end
|
|
46
47
|
|
|
47
48
|
# PUT /SupplierContract/{id} - Update Supplier contract
|
|
48
49
|
def update_contract(id, data)
|
|
49
|
-
|
|
50
|
+
update_resource('SupplierContract', id, data)
|
|
50
51
|
end
|
|
51
52
|
|
|
52
53
|
# DELETE /SupplierContract/{id} - Delete Supplier contract
|
|
53
54
|
def delete_contract(id)
|
|
54
|
-
|
|
55
|
+
delete_resource('SupplierContract', id)
|
|
55
56
|
end
|
|
56
57
|
end
|
|
57
58
|
end
|