halo_msp_api 0.1.0 → 0.2.0

data/lib/halo_msp_api/resources/slas.rb

@@ -2,82 +2,83 @@
 
 module HaloMspApi
   module Resources
+    # Resource class for SLAs
     class Slas < Base
       # GET /SLA - List of SLAs
-      def list(params = {})
-        list_resource("SLA", params)
+      def slas(params = {})
+        list_resource('SLA', params)
       end
 
       # GET /SLA/{id} - Get a specific SLA
-      def get(id, params = {})
-        get_resource("SLA", id, params)
+      def sla(id, params = {})
+        get_resource('SLA', id, params)
       end
 
       # POST /SLA - Create a new SLA
-      def create(data)
-        create_resource("SLA", data)
+      def create_sla(data)
+        create_resource('SLA', data)
       end
 
       # PUT /SLA/{id} - Update an SLA
-      def update(id, data)
-        update_resource("SLA", id, data)
+      def update_sla(id, data)
+        update_resource('SLA', id, data)
       end
 
       # DELETE /SLA/{id} - Delete an SLA
-      def delete(id)
-        delete_resource("SLA", id)
+      def delete_sla(id)
+        delete_resource('SLA', id)
       end
 
       # SLA Policy methods
       # GET /SLAPolicy - List SLA policies
       def policies(params = {})
-        get("/SLAPolicy", params)
+        get('SLAPolicy', params)
       end
 
       # GET /SLAPolicy/{id} - Get specific SLA policy
       def policy(id, params = {})
-        get("/SLAPolicy/#{id}", params)
+        get("SLAPolicy/#{id}", params)
       end
 
       # POST /SLAPolicy - Create SLA policy
       def create_policy(data)
-        post("/SLAPolicy", data)
+        post('SLAPolicy', data)
       end
 
       # PUT /SLAPolicy/{id} - Update SLA policy
       def update_policy(id, data)
-        put("/SLAPolicy/#{id}", data)
+        put("SLAPolicy/#{id}", data)
       end
 
       # DELETE /SLAPolicy/{id} - Delete SLA policy
       def delete_policy(id)
-        delete("/SLAPolicy/#{id}")
+        delete("SLAPolicy/#{id}")
       end
 
       # SLA Target methods
       # GET /SLATarget - List SLA targets
       def targets(params = {})
-        get("/SLATarget", params)
+        get('SLATarget', params)
       end
 
       # GET /SLATarget/{id} - Get specific SLA target
       def target(id, params = {})
-        get("/SLATarget/#{id}", params)
+        get("SLATarget/#{id}", params)
       end
 
       # POST /SLATarget - Create SLA target
       def create_target(data)
-        post("/SLATarget", data)
+        post('SLATarget', data)
       end
 
       # PUT /SLATarget/{id} - Update SLA target
       def update_target(id, data)
-        put("/SLATarget/#{id}", data)
+        put("SLATarget/#{id}", data)
       end
 
       # DELETE /SLATarget/{id} - Delete SLA target
       def delete_target(id)
-        delete("/SLATarget/#{id}")
+        delete("SLATarget/#{id}")
       end
     end
   end

data/lib/halo_msp_api/resources/suppliers.rb

@@ -2,56 +2,57 @@
 
 module HaloMspApi
   module Resources
+    # Resource class for Suppliers
     class Suppliers < Base
       # GET /Supplier - List of Suppliers
-      def list(params = {})
-        list_resource("Supplier", params)
+      def suppliers(params = {})
+        list_resource('Supplier', params)
       end
 
       # GET /Supplier/{id} - Get a specific Supplier
-      def get(id, params = {})
-        get_resource("Supplier", id, params)
+      def supplier(id, params = {})
+        get_resource('Supplier', id, params)
       end
 
       # POST /Supplier - Create a new Supplier
-      def create(data)
-        create_resource("Supplier", data)
+      def create_supplier(data)
+        create_resource('Supplier', data)
       end
 
       # PUT /Supplier/{id} - Update a Supplier
-      def update(id, data)
-        update_resource("Supplier", id, data)
+      def update_supplier(id, data)
+        update_resource('Supplier', id, data)
       end
 
       # DELETE /Supplier/{id} - Delete a Supplier
-      def delete(id)
-        delete_resource("Supplier", id)
+      def delete_supplier(id)
+        delete_resource('Supplier', id)
       end
 
       # Supplier Contract methods
       # GET /SupplierContract - List Supplier contracts
       def contracts(params = {})
-        get("/SupplierContract", params)
+        get('SupplierContract', params)
       end
 
       # GET /SupplierContract/{id} - Get specific Supplier contract
       def contract(id, params = {})
-        get("/SupplierContract/#{id}", params)
+        get("SupplierContract/#{id}", params)
       end
 
       # POST /SupplierContract - Create Supplier contract
       def create_contract(data)
-        post("/SupplierContract", data)
+        post('SupplierContract', data)
       end
 
       # PUT /SupplierContract/{id} - Update Supplier contract
       def update_contract(id, data)
-        put("/SupplierContract/#{id}", data)
+        put("SupplierContract/#{id}", data)
       end
 
       # DELETE /SupplierContract/{id} - Delete Supplier contract
       def delete_contract(id)
-        delete("/SupplierContract/#{id}")
+        delete("SupplierContract/#{id}")
       end
     end
   end

data/lib/halo_msp_api/resources/tickets.rb

@@ -2,206 +2,209 @@
 
 module HaloMspApi
   module Resources
+    # Resource class for Tickets
+    # rubocop:disable Metrics/ClassLength
     class Tickets < Base
       # GET /Tickets - List of Tickets
-      def list(params = {})
-        list_resource("Tickets", params)
+      def tickets(params = {})
+        list_resource('Tickets', params)
       end
 
       # GET /Tickets/{id} - Get a specific Ticket
-      def get(id, params = {})
-        get_resource("Tickets", id, params)
+      def ticket(id, params = {})
+        get_resource('Tickets', id, params)
       end
 
       # POST /Tickets - Create a new Ticket
-      def create(data)
-        create_resource("Tickets", data)
+      def create_ticket(data)
+        create_resource('Tickets', data)
       end
 
       # PUT /Tickets/{id} - Update a Ticket
-      def update(id, data)
-        update_resource("Tickets", id, data)
+      def update_ticket(id, data)
+        update_resource('Tickets', id, data)
       end
 
       # DELETE /Tickets/{id} - Delete a Ticket
-      def delete(id)
-        delete_resource("Tickets", id)
+      def delete_ticket(id)
+        delete_resource('Tickets', id)
       end
 
       # GET /Tickets/Object - Get Ticket object
       def object(params = {})
-        get(resource_path("Tickets", nil, "Object"), params)
+        get(resource_path('Tickets', nil, 'Object'), params)
       end
 
       # POST /Tickets/processchildren - Process child tickets
       def process_children(data)
-        post(resource_path("Tickets", nil, "processchildren"), data)
+        post(resource_path('Tickets', nil, 'processchildren'), data)
       end
 
       # GET /Tickets/salesmailbox - Get sales mailbox tickets
       def sales_mailbox(params = {})
-        get(resource_path("Tickets", nil, "salesmailbox"), params)
+        get(resource_path('Tickets', nil, 'salesmailbox'), params)
       end
 
       # POST /Tickets/SetBillableProject - Set billable project
-      def set_billable_project(data)
-        post(resource_path("Tickets", nil, "SetBillableProject"), data)
+      def billable_project(data)
+        post(resource_path('Tickets', nil, 'SetBillableProject'), data)
       end
 
       # GET /Tickets/View - Get Ticket view
       def view(params = {})
-        get(resource_path("Tickets", nil, "View"), params)
+        get(resource_path('Tickets', nil, 'View'), params)
       end
 
       # POST /Tickets/vote - Vote on a ticket
       def vote(data)
-        post(resource_path("Tickets", nil, "vote"), data)
+        post(resource_path('Tickets', nil, 'vote'), data)
       end
 
       # POST /Tickets/zapier - Zapier integration
       def zapier(data)
-        post(resource_path("Tickets", nil, "zapier"), data)
+        post(resource_path('Tickets', nil, 'zapier'), data)
       end
 
       # Ticket Approval methods
       # GET /TicketApproval - List Ticket approvals
       def approvals(params = {})
-        get("/TicketApproval", params)
+        get('TicketApproval', params)
       end
 
       # GET /TicketApproval/{id} - Get specific Ticket approval
       def approval(id, params = {})
-        get("/TicketApproval/#{id}", params)
+        get("TicketApproval/#{id}", params)
       end
 
       # GET /TicketApproval/{id}&{seq} - Get specific Ticket approval with sequence
       def approval_with_sequence(id, seq, params = {})
-        get("/TicketApproval/#{id}&#{seq}", params)
+        get("TicketApproval/#{id}&#{seq}", params)
       end
 
       # POST /TicketApproval - Create Ticket approval
       def create_approval(data)
-        post("/TicketApproval", data)
+        post('TicketApproval', data)
       end
 
       # PUT /TicketApproval/{id} - Update Ticket approval
       def update_approval(id, data)
-        put("/TicketApproval/#{id}", data)
+        put("TicketApproval/#{id}", data)
       end
 
       # DELETE /TicketApproval/{id} - Delete Ticket approval
       def delete_approval(id)
-        delete("/TicketApproval/#{id}")
+        delete("TicketApproval/#{id}")
       end
 
       # Ticket Area methods
       # GET /TicketArea - List Ticket areas
       def areas(params = {})
-        get("/TicketArea", params)
+        get('TicketArea', params)
       end
 
       # GET /TicketArea/{id} - Get specific Ticket area
       def area(id, params = {})
-        get("/TicketArea/#{id}", params)
+        get("TicketArea/#{id}", params)
       end
 
       # POST /TicketArea - Create Ticket area
       def create_area(data)
-        post("/TicketArea", data)
+        post('TicketArea', data)
       end
 
       # PUT /TicketArea/{id} - Update Ticket area
       def update_area(id, data)
-        put("/TicketArea/#{id}", data)
+        put("TicketArea/#{id}", data)
       end
 
       # DELETE /TicketArea/{id} - Delete Ticket area
       def delete_area(id)
-        delete("/TicketArea/#{id}")
+        delete("TicketArea/#{id}")
       end
 
       # Ticket Rules methods
       # GET /TicketRules - List Ticket rules
       def rules(params = {})
-        get("/TicketRules", params)
+        get('TicketRules', params)
       end
 
       # GET /TicketRules/{id} - Get specific Ticket rule
       def rule(id, params = {})
-        get("/TicketRules/#{id}", params)
+        get("TicketRules/#{id}", params)
       end
 
       # POST /TicketRules - Create Ticket rule
       def create_rule(data)
-        post("/TicketRules", data)
+        post('TicketRules', data)
       end
 
       # PUT /TicketRules/{id} - Update Ticket rule
       def update_rule(id, data)
-        put("/TicketRules/#{id}", data)
+        put("TicketRules/#{id}", data)
       end
 
       # DELETE /TicketRules/{id} - Delete Ticket rule
       def delete_rule(id)
-        delete("/TicketRules/#{id}")
+        delete("TicketRules/#{id}")
       end
 
       # Ticket Type methods
       # GET /TicketType - List Ticket types
       def types(params = {})
-        get("/TicketType", params)
+        get('TicketType', params)
       end
 
       # GET /TicketType/{id} - Get specific Ticket type
       def type(id, params = {})
-        get("/TicketType/#{id}", params)
+        get("TicketType/#{id}", params)
       end
 
       # POST /TicketType - Create Ticket type
       def create_type(data)
-        post("/TicketType", data)
+        post('TicketType', data)
       end
 
       # PUT /TicketType/{id} - Update Ticket type
       def update_type(id, data)
-        put("/TicketType/#{id}", data)
+        put("TicketType/#{id}", data)
       end
 
       # DELETE /TicketType/{id} - Delete Ticket type
       def delete_type(id)
-        delete("/TicketType/#{id}")
+        delete("TicketType/#{id}")
       end
 
       # GET /TicketTypeField - List Ticket type fields
       def type_fields(params = {})
-        get("/TicketTypeField", params)
+        get('TicketTypeField', params)
       end
 
       # Ticket Type Group methods
       # GET /TicketTypeGroup - List Ticket type groups
       def type_groups(params = {})
-        get("/TicketTypeGroup", params)
+        get('TicketTypeGroup', params)
       end
 
       # GET /TicketTypeGroup/{id} - Get specific Ticket type group
       def type_group(id, params = {})
-        get("/TicketTypeGroup/#{id}", params)
+        get("TicketTypeGroup/#{id}", params)
       end
 
       # POST /TicketTypeGroup - Create Ticket type group
       def create_type_group(data)
-        post("/TicketTypeGroup", data)
+        post('TicketTypeGroup', data)
       end
 
       # PUT /TicketTypeGroup/{id} - Update Ticket type group
       def update_type_group(id, data)
-        put("/TicketTypeGroup/#{id}", data)
+        put("TicketTypeGroup/#{id}", data)
       end
 
       # DELETE /TicketTypeGroup/{id} - Delete Ticket type group
       def delete_type_group(id)
-        delete("/TicketTypeGroup/#{id}")
+        delete("TicketTypeGroup/#{id}")
       end
     end
   end
 end
+# rubocop:enable Metrics/ClassLength

data/lib/halo_msp_api/resources/users.rb

@@ -2,82 +2,78 @@
 
 module HaloMspApi
   module Resources
+    # Resource class for Users
     class Users < Base
       # GET /Users - List of Users
-      def list(params = {})
-        list_resource("Users", params)
+      def users(params = {})
+        list_resource('Users', params)
       end
 
       # GET /Users/{id} - Get a specific User
-      def get(id, params = {})
-        get_resource("Users", id, params)
+      def user(id, params = {})
+        get_resource('Users', id, params)
       end
 
       # POST /Users - Create a new User
-      def create(data)
-        create_resource("Users", data)
+      def create_user(data)
+        create_resource('Users', data)
       end
 
       # PUT /Users/{id} - Update a User
-      def update(id, data)
-        update_resource("Users", id, data)
+      def update_user(id, data)
+        update_resource('Users', id, data)
       end
 
       # DELETE /Users/{id} - Delete a User
-      def delete(id)
-        delete_resource("Users", id)
-      end
-
-      # GET /Users/me - Get current User information
-      def me(params = {})
-        get(resource_path("Users", nil, "me"), params)
+      def delete_user(id)
+        delete_resource('Users', id)
       end
 
       # GET /Users/prefs - Get User preferences
       def preferences(params = {})
-        get(resource_path("Users", nil, "prefs"), params)
+        get(resource_path('Users', nil, 'prefs'), params)
       end
 
       # POST /Users/prefs - Update User preferences
       def update_preferences(data)
-        post(resource_path("Users", nil, "prefs"), data)
+        post(resource_path('Users', nil, 'prefs'), data)
       end
 
       # User Change methods
       # GET /UserChange - List User changes
       def changes(params = {})
-        get("/UserChange", params)
+        get('UserChange', params)
       end
 
       # POST /UserChange - Create User change
       def create_change(data)
-        post("/UserChange", data)
+        post('UserChange', data)
       end
 
       # User Roles methods
       # GET /UserRoles - List User roles
       def roles(params = {})
-        get("/UserRoles", params)
+        get('UserRoles', params)
       end
 
       # GET /UserRoles/{id} - Get specific User role
       def role(id, params = {})
-        get("/UserRoles/#{id}", params)
+        get("UserRoles/#{id}", params)
       end
 
       # POST /UserRoles - Create User role
       def create_role(data)
-        post("/UserRoles", data)
+        post('UserRoles', data)
       end
 
       # PUT /UserRoles/{id} - Update User role
       def update_role(id, data)
-        put("/UserRoles/#{id}", data)
+        put("UserRoles/#{id}", data)
       end
 
       # DELETE /UserRoles/{id} - Delete User role
       def delete_role(id)
-        delete("/UserRoles/#{id}")
+        delete("UserRoles/#{id}")
       end
     end
   end

data/lib/halo_msp_api/resources/webhooks.rb

@@ -2,87 +2,88 @@
 
 module HaloMspApi
   module Resources
+    # Resource class for Webhooks
     class Webhooks < Base
       # GET /Webhook - List of Webhooks
-      def list(params = {})
-        list_resource("Webhook", params)
+      def webhooks(params = {})
+        list_resource('Webhook', params)
       end
 
       # GET /Webhook/{id} - Get a specific Webhook
-      def get(id, params = {})
-        get_resource("Webhook", id, params)
+      def webhook(id, params = {})
+        get_resource('Webhook', id, params)
       end
 
       # POST /Webhook - Create a new Webhook
-      def create(data)
-        create_resource("Webhook", data)
+      def create_webhook(data)
+        create_resource('Webhook', data)
       end
 
       # PUT /Webhook/{id} - Update a Webhook
-      def update(id, data)
-        update_resource("Webhook", id, data)
+      def update_webhook(id, data)
+        update_resource('Webhook', id, data)
       end
 
       # DELETE /Webhook/{id} - Delete a Webhook
-      def delete(id)
-        delete_resource("Webhook", id)
+      def delete_webhook(id)
+        delete_resource('Webhook', id)
       end
 
       # POST /Webhook/test - Test a Webhook
       def test(data)
-        post(resource_path("Webhook", nil, "test"), data)
+        post(resource_path('Webhook', nil, 'test'), data)
       end
 
       # Webhook Event methods
       # GET /WebhookEvent - List Webhook events
       def events(params = {})
-        get("/WebhookEvent", params)
+        get('WebhookEvent', params)
       end
 
       # GET /WebhookEvent/{id} - Get specific Webhook event
       def event(id, params = {})
-        get("/WebhookEvent/#{id}", params)
+        get("WebhookEvent/#{id}", params)
       end
 
       # POST /WebhookEvent - Create Webhook event
       def create_event(data)
-        post("/WebhookEvent", data)
+        post('WebhookEvent', data)
       end
 
       # PUT /WebhookEvent/{id} - Update Webhook event
       def update_event(id, data)
-        put("/WebhookEvent/#{id}", data)
+        put("WebhookEvent/#{id}", data)
       end
 
       # DELETE /WebhookEvent/{id} - Delete Webhook event
       def delete_event(id)
-        delete("/WebhookEvent/#{id}")
+        delete("WebhookEvent/#{id}")
       end
 
       # Webhook Subscription methods
       # GET /WebhookSubscription - List Webhook subscriptions
       def subscriptions(params = {})
-        get("/WebhookSubscription", params)
+        get('WebhookSubscription', params)
       end
 
       # GET /WebhookSubscription/{id} - Get specific Webhook subscription
       def subscription(id, params = {})
-        get("/WebhookSubscription/#{id}", params)
+        get("WebhookSubscription/#{id}", params)
       end
 
       # POST /WebhookSubscription - Create Webhook subscription
       def create_subscription(data)
-        post("/WebhookSubscription", data)
+        post('WebhookSubscription', data)
       end
 
       # PUT /WebhookSubscription/{id} - Update Webhook subscription
       def update_subscription(id, data)
-        put("/WebhookSubscription/#{id}", data)
+        put("WebhookSubscription/#{id}", data)
       end
 
       # DELETE /WebhookSubscription/{id} - Delete Webhook subscription
       def delete_subscription(id)
-        delete("/WebhookSubscription/#{id}")
+        delete("WebhookSubscription/#{id}")
       end
     end
   end

data/lib/halo_msp_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HaloMspApi
-  VERSION = "0.1.0"
+  VERSION = '0.2.0'
 end