halo_msp_api 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 298a5f2396dac7b60b32afb4d7e12af0797c20ea696f06adb5b7cde91a1802e7
-  data.tar.gz: a90a79d513e0384e0ac3b3fac4c4f10afa99616b0e4d21f032a21d5958d8dab9
+  metadata.gz: 66a71218fe73c35441a0f239ab1c80a3879aac9d9c44116c167a260c6cf6cb3c
+  data.tar.gz: 8602e863b06f0e4fd6ea315da702c6e9f1f8e41fdbdb3f19c22e08c4dd5ab91c
 SHA512:
-  metadata.gz: 0fb09a0fca38736575835d473bd52f0836b4f520e1442a9a7c8faa3f0d65e738789a9a52d4c620cccbc9730da822552283afd1f958ca4cf7a90917d029e4b1f8
-  data.tar.gz: 20bd7c4acb3661c4240b2749fa15f9b02181d17ba08b40d233e7f4811cea86a78c112fc7b2c547419de56c63629134f1862ba5d561e3c833c0391fe6ac29a009
+  metadata.gz: a4fbc442112b4f78af465735d8b59b74f3cfed6308306d42810a550729aafe6ed8a61815d904841a648e956a11c1aed92f15bfe512423a9c848895962d9d4be8
+  data.tar.gz: 300aebb149d31b354667abc6845598739e74f8b60008702f8c418b3ab0159646e53c40996e1e11c12591097bb5df9b5c33acf227ece2fa56a517978f95605ad7

data/CHANGELOG.md

@@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.3.0] - 2025-09-23
+
+### Added
+- Added methods for grabbing ticket statuses, categories, and other user defined attributes
+
+### Fixed
+- Fixed resource methods not using the correct method from the base class
+
 ## [0.2.0] - 2025-09-15
 
 ### Added

data/README.md

@@ -55,13 +55,13 @@ client = HaloApi::Client.new(config)
 
 ```ruby
 # List all tickets
-tickets = client.tickets.list
+tickets = client.tickets.tickets
 
 # Get a specific ticket
-ticket = client.tickets.get(123)
+ticket = client.tickets.ticket(123)
 
 # Create a new ticket
-new_ticket = client.tickets.create({
+new_ticket = client.tickets.create_ticket({
   summary: "New ticket",
   details: "Ticket description",
   tickettype_id: 1,
@@ -69,23 +69,20 @@ new_ticket = client.tickets.create({
 })
 
 # Update a ticket
-client.tickets.update(123, { summary: "Updated summary" })
+client.tickets.update_ticket(123, { summary: "Updated summary" })
 
 # Delete a ticket
-client.tickets.delete(123)
+client.tickets.delete_ticket(123)
 ```
 
 ### Working with Users
 
 ```ruby
 # List all users
-users = client.users.list
-
-# Get current user
-current_user = client.users.me
+users = client.users.users
 
 # Create a new user
-new_user = client.users.create({
+new_user = client.users.create_user({
   name: "John Doe",
   emailaddress: "john@example.com"
 })
@@ -95,13 +92,13 @@ new_user = client.users.create({
 
 ```ruby
 # List all assets
-assets = client.assets.list
+assets = client.assets.assets
 
 # Get a specific asset
-asset = client.assets.get(123)
+asset = client.assets.asset(123)
 
 # Create a new asset
-new_asset = client.assets.create({
+new_asset = client.assets.create_asset({
   inventory_number: "ASSET001",
   assettype_id: 1
 })
@@ -111,13 +108,13 @@ new_asset = client.assets.create({
 
 ```ruby
 # List all clients
-clients = client.clients.list
+clients = client.clients.clients
 
 # Get a specific client
-client_record = client.clients.get(123)
+client_record = client.clients.client(123)
 
 # Create a new client
-new_client = client.clients.create({
+new_client = client.clients.create_client({
   name: "ACME Corp",
   website: "https://acme.com"
 })
@@ -127,13 +124,13 @@ new_client = client.clients.create({
 
 ```ruby
 # List all invoices
-invoices = client.invoices.list
+invoices = client.invoices.invoices
 
 # Get a specific invoice
-invoice = client.invoices.get(123)
+invoice = client.invoices.invoice(123)
 
 # Create a new invoice
-new_invoice = client.invoices.create({
+new_invoice = client.invoices.create_invoice({
   client_id: 1,
   invoicedate: "2023-01-01"
 })
@@ -146,10 +143,10 @@ pdf_data = client.invoices.pdf(123)
 
 ```ruby
 # List all reports
-reports = client.reports.list
+reports = client.reports.reports
 
 # Get a specific report
-report = client.reports.get(123)
+report = client.reports.report(123)
 
 # Get report data
 report_data = client.reports.data("published_report_id")
@@ -159,10 +156,10 @@ report_data = client.reports.data("published_report_id")
 
 ```ruby
 # Get Azure AD data
-azure_data = client.integrations.get_azure_ad
+azure_data = client.integrations.azure_ad
 
 # Get Slack data
-slack_data = client.integrations.get_slack
+slack_data = client.integrations.slack
 
 # Import Jira data
 client.integrations.import_jira(jira_data)
@@ -210,7 +207,7 @@ The gem provides specific error classes for different types of API errors:
 
 ```ruby
 begin
-  ticket = client.tickets.get(999999)
+  ticket = client.tickets.ticket(999999)
 rescue HaloMspApi::NotFoundError
   puts "Ticket not found"
 rescue HaloMspApi::AuthenticationError

data/examples/basic_usage.rb

@@ -117,6 +117,11 @@ begin
   end
   puts
 
+  puts '9. Listing Statuses'
+  statuses = instance.tickets.statuses
+  puts "Found #{statuses&.length || 0} statuses"
+  puts "First Status: #{statuses.first['name']}"
+
   puts '=== Example completed successfully! ==='
 rescue HaloMspApi::AuthenticationError => e
   puts "Authentication failed: #{e.message}"

data/lib/halo_msp_api/resources/actions.rb

@@ -34,53 +34,53 @@ module HaloMspApi
       # Action Reactions methods
       # GET /ActionReaction - List action reactions
       def reactions(params = {})
-        get('ActionReaction', params)
+        list_resource('ActionReaction', params)
       end
 
       # GET /ActionReaction/{id} - Get specific action reaction
       def reaction(id, params = {})
-        get("ActionReaction/#{id}", params)
+        get_resource('ActionReaction', id, params)
       end
 
       # POST /ActionReaction - Create action reaction
       def create_reaction(data)
-        post('ActionReaction', data)
+        create_resource('ActionReaction', data)
       end
 
       # PUT /ActionReaction/{id} - Update action reaction
       def update_reaction(id, data)
-        put("ActionReaction/#{id}", data)
+        update_resource('ActionReaction', id, data)
       end
 
       # DELETE /ActionReaction/{id} - Delete action reaction
       def delete_reaction(id)
-        delete("ActionReaction/#{id}")
+        delete_resource('ActionReaction', id)
       end
 
       # Action Review methods
       # GET /ActionReview - List action reviews
       def reviews(params = {})
-        get('ActionReview', params)
+        list_resource('ActionReview', params)
       end
 
       # GET /ActionReview/{id} - Get specific action review
       def review(id, params = {})
-        get("ActionReview/#{id}", params)
+        get_resource('ActionReview', id, params)
       end
 
       # POST /ActionReview - Create action review
       def create_review(data)
-        post('ActionReview', data)
+        create_resource('ActionReview', data)
       end
 
       # PUT /ActionReview/{id} - Update action review
       def update_review(id, data)
-        put("ActionReview/#{id}", data)
+        update_resource('ActionReview', id, data)
       end
 
       # DELETE /ActionReview/{id} - Delete action review
       def delete_review(id)
-        delete("ActionReview/#{id}")
+        delete_resource('ActionReview', id)
       end
     end
   end

data/lib/halo_msp_api/resources/agents.rb

@@ -31,7 +31,7 @@ module HaloMspApi
 
       # GET /Agent/me - Get current Agent information
       def me(params = {})
-        get(resource_path('Agent', nil, 'me'), params)
+        get_resource('Agent', 'me', params)
       end
 
       # POST /Agent/ClearCache - Clear Agent cache
@@ -41,60 +41,60 @@ module HaloMspApi
 
       # GET /AgentImage/{id} - Get Agent image
       def image(id)
-        get(resource_path('AgentImage', id))
+        get_resource('AgentImage', id)
       end
 
       # Agent Check-in related methods
       # GET /AgentCheckIn - List Agent check-ins
       def check_ins(params = {})
-        get('AgentCheckIn', params)
+        list_resource('AgentCheckIn', params)
       end
 
       # GET /AgentCheckIn/{id} - Get specific Agent check-in
       def check_in(id, params = {})
-        get("AgentCheckIn/#{id}", params)
+        get_resource('AgentCheckIn', id, params)
       end
 
       # POST /AgentCheckIn - Create Agent check-in
       def create_check_in(data)
-        post('AgentCheckIn', data)
+        create_resource('AgentCheckIn', data)
       end
 
       # Agent Event Subscription methods
       # GET /AgentEventSubscription - List Agent event subscriptions
       def event_subscriptions(params = {})
-        get('AgentEventSubscription', params)
+        list_resource('AgentEventSubscription', params)
       end
 
       # GET /AgentEventSubscription/{id} - Get specific Agent event subscription
       def event_subscription(id, params = {})
-        get("AgentEventSubscription/#{id}", params)
+        get_resource('AgentEventSubscription', id, params)
       end
 
       # POST /AgentEventSubscription - Create Agent event subscription
       def create_event_subscription(data)
-        post('AgentEventSubscription', data)
+        create_resource('AgentEventSubscription', data)
       end
 
       # Agent Presence related methods
       # GET /AgentPresenceRule - List Agent presence rules
       def presence_rules(params = {})
-        get('AgentPresenceRule', params)
+        list_resource('AgentPresenceRule', params)
       end
 
       # GET /AgentPresenceSubscription - List Agent presence subscriptions
       def presence_subscriptions(params = {})
-        get('AgentPresenceSubscription', params)
+        list_resource('AgentPresenceSubscription', params)
       end
 
       # GET /AgentPresenceSubscription/{id} - Get specific Agent presence subscription
       def presence_subscription(id, params = {})
-        get("AgentPresenceSubscription/#{id}", params)
+        get_resource('AgentPresenceSubscription', id, params)
       end
 
       # POST /AgentPresenceSubscription - Create Agent presence subscription
       def create_presence_subscription(data)
-        post('AgentPresenceSubscription', data)
+        create_resource('AgentPresenceSubscription', data)
       end
     end
   end

data/lib/halo_msp_api/resources/appointments.rb

@@ -31,12 +31,12 @@ module HaloMspApi
 
       # GET /Appointment/Availability - Get Appointment availability
       def availability(params = {})
-        get(resource_path('Appointment', nil, 'Availability'), params)
+        get_resource('Appointment', 'Availability', params)
       end
 
       # GET /Appointment/Calendar - Get Appointment calendar
       def calendar(params = {})
-        get(resource_path('Appointment', nil, 'Calendar'), params)
+        get_resource('Appointment', 'Calendar', params)
       end
 
       # POST /Appointment/CheckAvailability - Check Appointment availability
@@ -46,22 +46,22 @@ module HaloMspApi
 
       # GET /Appointment/Slots - Get Appointment slots
       def slots(params = {})
-        get(resource_path('Appointment', nil, 'Slots'), params)
+        list_resource('Appointment', 'Slots', params)
       end
 
       # POST /Appointment/Slots - Create Appointment slots
       def create_slots(data)
-        post(resource_path('Appointment', nil, 'Slots'), data)
+        create_resource('Appointment', 'Slots', data)
       end
 
       # GET /Appointment/Types - Get Appointment types
       def types(params = {})
-        get(resource_path('Appointment', nil, 'Types'), params)
+        list_resource('Appointment', 'Types', params)
       end
 
       # POST /Appointment/Types - Create Appointment type
       def create_type(data)
-        post(resource_path('Appointment', nil, 'Types'), data)
+        create_resource('Appointment', 'Types', data)
       end
     end
   end

data/lib/halo_msp_api/resources/assets.rb

@@ -31,117 +31,117 @@ module HaloMspApi
 
       # GET /Asset/GetAllSoftwareVersions - Get all software versions
       def software_versions(params = {})
-        get(resource_path('Asset', nil, 'GetAllSoftwareVersions'), params)
+        list_resource('Asset', params, 'GetAllSoftwareVersions')
       end
 
       # GET /Asset/NextTag - Get next asset tag
       def next_tag(params = {})
-        get(resource_path('Asset', nil, 'NextTag'), params)
+        get_resource('Asset', 'NextTag', params)
       end
 
       # Asset Change related methods
       # GET /AssetChange - List Asset changes
       def changes(params = {})
-        get('AssetChange', params)
+        list_resource('AssetChange', params)
       end
 
       # POST /AssetChange - Create Asset change
       def create_change(data)
-        post('AssetChange', data)
+        create_resource('AssetChange', data)
       end
 
       # Asset Group methods
       # GET /AssetGroup - List Asset groups
       def groups(params = {})
-        get('AssetGroup', params)
+        list_resource('AssetGroup', params)
       end
 
       # GET /AssetGroup/{id} - Get specific Asset group
       def group(id, params = {})
-        get("AssetGroup/#{id}", params)
+        get_resource('AssetGroup', id, params)
       end
 
       # POST /AssetGroup - Create Asset group
       def create_group(data)
-        post('AssetGroup', data)
+        create_resource('AssetGroup', data)
       end
 
       # PUT /AssetGroup/{id} - Update Asset group
       def update_group(id, data)
-        put("AssetGroup/#{id}", data)
+        update_resource('AssetGroup', id, data)
       end
 
       # DELETE /AssetGroup/{id} - Delete Asset group
       def delete_group(id)
-        delete("AssetGroup/#{id}")
+        delete_resource('AssetGroup', id)
       end
 
       # Asset Software methods
       # GET /AssetSoftware - List Asset software
       def software(params = {})
-        get('AssetSoftware', params)
+        list_resource('AssetSoftware', params)
       end
 
       # POST /AssetSoftware - Create Asset software
       def create_software(data)
-        post('AssetSoftware', data)
+        create_resource('AssetSoftware', data)
       end
 
       # Asset Type methods
       # GET /AssetType - List Asset types
       def types(params = {})
-        get('AssetType', params)
+        list_resource('AssetType', params)
       end
 
       # GET /AssetType/{id} - Get specific Asset type
       def type(id, params = {})
-        get("AssetType/#{id}", params)
+        get_resource('AssetType', id, params)
       end
 
       # POST /AssetType - Create Asset type
       def create_type(data)
-        post('AssetType', data)
+        create_resource('AssetType', data)
       end
 
       # PUT /AssetType/{id} - Update Asset type
       def update_type(id, data)
-        put("AssetType/#{id}", data)
+        update_resource('AssetType', id, data)
       end
 
       # DELETE /AssetType/{id} - Delete Asset type
       def delete_type(id)
-        delete("AssetType/#{id}")
+        delete_resource('AssetType', id)
       end
 
       # GET /AssetTypeInfo - Get Asset type info
       def type_info(params = {})
-        get('AssetTypeInfo', params)
+        get(resource_path('AssetTypeInfo'), params)
       end
 
       # Asset Type Mappings methods
       # GET /AssetTypeMappings - List Asset type mappings
       def type_mappings(params = {})
-        get('AssetTypeMappings', params)
+        list_resource('AssetTypeMappings', params)
       end
 
       # GET /AssetTypeMappings/{id} - Get specific Asset type mapping
       def type_mapping(id, params = {})
-        get("AssetTypeMappings/#{id}", params)
+        get_resource('AssetTypeMappings', id, params)
       end
 
       # POST /AssetTypeMappings - Create Asset type mapping
       def create_type_mapping(data)
-        post('AssetTypeMappings', data)
+        create_resource('AssetTypeMappings', data)
       end
 
       # PUT /AssetTypeMappings/{id} - Update Asset type mapping
       def update_type_mapping(id, data)
-        put("AssetTypeMappings/#{id}", data)
+        update_resource('AssetTypeMappings', id, data)
       end
 
       # DELETE /AssetTypeMappings/{id} - Delete Asset type mapping
       def delete_type_mapping(id)
-        delete("AssetTypeMappings/#{id}")
+        delete_resource('AssetTypeMappings', id)
       end
     end
   end

data/lib/halo_msp_api/resources/base.rb

@@ -57,7 +57,8 @@ module HaloMspApi
 
       # Helper method for update operations
       def update_resource(resource_name, id, data)
-        put(resource_path(resource_name, id), data)
+        data_with_id = data.merge(id: id)
+        post(resource_path(resource_name), data_with_id)
       end
 
       # Helper method for delete operations

data/lib/halo_msp_api/resources/clients.rb

@@ -48,27 +48,27 @@ module HaloMspApi
       # Client Contract methods
       # GET /ClientContract - List Client contracts
       def contracts(params = {})
-        get('ClientContract', params)
+        list_resource('ClientContract', params)
       end
 
       # GET /ClientContract/{id} - Get specific Client contract
       def contract(id, params = {})
-        get("ClientContract/#{id}", params)
+        get_resource('ClientContract', id, params)
       end
 
       # POST /ClientContract - Create Client contract
       def create_contract(data)
-        post('ClientContract', data)
+        create_resource('ClientContract', data)
       end
 
       # PUT /ClientContract/{id} - Update Client contract
       def update_contract(id, data)
-        put("ClientContract/#{id}", data)
+        update_resource('ClientContract', id, data)
       end
 
       # DELETE /ClientContract/{id} - Delete Client contract
       def delete_contract(id)
-        delete("ClientContract/#{id}")
+        delete_resource('ClientContract', id)
       end
 
       # POST /ClientContract/Approval - Client contract approval
@@ -84,27 +84,27 @@ module HaloMspApi
       # Client Prepay methods
       # GET /ClientPrepay - List Client prepayments
       def prepayments(params = {})
-        get('ClientPrepay', params)
+        list_resource('ClientPrepay', params)
       end
 
       # GET /ClientPrepay/{id} - Get specific Client prepayment
       def prepayment(id, params = {})
-        get("ClientPrepay/#{id}", params)
+        get_resource('ClientPrepay', id, params)
       end
 
       # POST /ClientPrepay - Create Client prepayment
       def create_prepayment(data)
-        post('ClientPrepay', data)
+        create_resource('ClientPrepay', data)
       end
 
       # PUT /ClientPrepay/{id} - Update Client prepayment
       def update_prepayment(id, data)
-        put("ClientPrepay/#{id}", data)
+        update_resource('ClientPrepay', id, data)
       end
 
       # DELETE /ClientPrepay/{id} - Delete Client prepayment
       def delete_prepayment(id)
-        delete("ClientPrepay/#{id}")
+        delete_resource('ClientPrepay', id)
       end
     end
   end