halo_msp_api 0.1.0 → 0.3.0

data/lib/halo_msp_api/resources/invoices.rb

@@ -2,139 +2,140 @@
 
 module HaloMspApi
   module Resources
+    # Resource class for Invoices
     class Invoices < Base
       # GET /Invoice - List of Invoices
-      def list(params = {})
-        list_resource("Invoice", params)
+      def invoices(params = {})
+        list_resource('Invoice', params)
       end
 
       # GET /Invoice/{id} - Get a specific Invoice
-      def get(id, params = {})
-        get_resource("Invoice", id, params)
+      def invoice(id, params = {})
+        get_resource('Invoice', id, params)
       end
 
       # POST /Invoice - Create a new Invoice
-      def create(data)
-        create_resource("Invoice", data)
+      def create_invoice(data)
+        create_resource('Invoice', data)
       end
 
       # PUT /Invoice/{id} - Update an Invoice
-      def update(id, data)
-        update_resource("Invoice", id, data)
+      def update_invoice(id, data)
+        update_resource('Invoice', id, data)
       end
 
       # DELETE /Invoice/{id} - Delete an Invoice
-      def delete(id)
-        delete_resource("Invoice", id)
+      def delete_invoice(id)
+        delete_resource('Invoice', id)
       end
 
       # POST /Invoice/{id}/void - Void an Invoice
       def void(id, data = {})
-        post(resource_path("Invoice", "#{id}/void"), data)
+        post(resource_path('Invoice', "#{id}/void"), data)
       end
 
       # GET /Invoice/PDF/{id} - Get Invoice PDF
       def pdf(id, params = {})
-        get(resource_path("Invoice", "PDF/#{id}"), params)
+        get_resource('Invoice', "#{id}/PDF", params)
       end
 
       # POST /Invoice/updatelines - Update Invoice lines
       def update_lines(data)
-        post(resource_path("Invoice", nil, "updatelines"), data)
+        post(resource_path('Invoice', nil, 'updatelines'), data)
       end
 
       # GET /Invoice/View - Get Invoice view
       def view(params = {})
-        get(resource_path("Invoice", nil, "View"), params)
+        get_resource('Invoice', 'View', params)
       end
 
       # Invoice Change methods
       # GET /InvoiceChange - List Invoice changes
       def changes(params = {})
-        get("/InvoiceChange", params)
+        list_resource('InvoiceChange', params)
       end
 
       # POST /InvoiceChange - Create Invoice change
       def create_change(data)
-        post("/InvoiceChange", data)
+        create_resource('InvoiceChange', data)
       end
 
       # Invoice Detail Pro Rata methods
       # GET /InvoiceDetailProRata - List Invoice detail pro rata
       def detail_pro_rata(params = {})
-        get("/InvoiceDetailProRata", params)
+        list_resource('InvoiceDetailProRata', params)
       end
 
       # POST /InvoiceDetailProRata - Create Invoice detail pro rata
       def create_detail_pro_rata(data)
-        post("/InvoiceDetailProRata", data)
+        create_resource('InvoiceDetailProRata', data)
       end
 
       # Invoice Payment methods
       # GET /InvoicePayment - List Invoice payments
       def payments(params = {})
-        get("/InvoicePayment", params)
+        list_resource('InvoicePayment', params)
       end
 
       # GET /InvoicePayment/{id} - Get specific Invoice payment
       def payment(id, params = {})
-        get("/InvoicePayment/#{id}", params)
+        get_resource('InvoicePayment', id, params)
       end
 
       # POST /InvoicePayment - Create Invoice payment
       def create_payment(data)
-        post("/InvoicePayment", data)
+        create_resource('InvoicePayment', data)
       end
 
       # PUT /InvoicePayment/{id} - Update Invoice payment
       def update_payment(id, data)
-        put("/InvoicePayment/#{id}", data)
+        update_resource('InvoicePayment', id, data)
       end
 
       # DELETE /InvoicePayment/{id} - Delete Invoice payment
       def delete_payment(id)
-        delete("/InvoicePayment/#{id}")
+        delete_resource('InvoicePayment', id)
       end
 
       # Recurring Invoice methods
       # GET /RecurringInvoice - List Recurring invoices
       def recurring_invoices(params = {})
-        get("/RecurringInvoice", params)
+        list_resource('RecurringInvoice', params)
       end
 
       # GET /RecurringInvoice/{id} - Get specific Recurring invoice
       def recurring_invoice(id, params = {})
-        get("/RecurringInvoice/#{id}", params)
+        get_resource('RecurringInvoice', id, params)
       end
 
       # POST /RecurringInvoice - Create Recurring invoice
       def create_recurring_invoice(data)
-        post("/RecurringInvoice", data)
+        create_resource('RecurringInvoice', data)
       end
 
       # PUT /RecurringInvoice/{id} - Update Recurring invoice
       def update_recurring_invoice(id, data)
-        put("/RecurringInvoice/#{id}", data)
+        update_resource('RecurringInvoice', id, data)
       end
 
       # DELETE /RecurringInvoice/{id} - Delete Recurring invoice
       def delete_recurring_invoice(id)
-        delete("/RecurringInvoice/#{id}")
+        delete_resource('RecurringInvoice', id)
       end
 
       # GET /RecurringInvoice/Lines - Get Recurring invoice lines
       def recurring_invoice_lines(params = {})
-        get("/RecurringInvoice/Lines", params)
+        get_resource('RecurringInvoice', 'Lines', params)
       end
 
       # POST /RecurringInvoice/process - Process Recurring invoices
       def process_recurring_invoices(data)
-        post("/RecurringInvoice/process", data)
+        post('RecurringInvoice/process', data)
       end
 
       # POST /RecurringInvoice/updatelines - Update Recurring invoice lines
       def update_recurring_invoice_lines(data)
-        post("/RecurringInvoice/updatelines", data)
+        post('RecurringInvoice/updatelines', data)
       end
     end
   end

data/lib/halo_msp_api/resources/knowledge_base.rb

@@ -2,87 +2,88 @@
 
 module HaloMspApi
   module Resources
+    # Resource class for Knowledge Base
     class KnowledgeBase < Base
       # GET /KBArticle - List of Knowledge Base Articles
       def articles(params = {})
-        get("/KBArticle", params)
+        list_resource('KBArticle', params)
       end
 
       # GET /KBArticle/{id} - Get a specific Knowledge Base Article
       def article(id, params = {})
-        get("/KBArticle/#{id}", params)
+        get_resource('KBArticle', id, params)
       end
 
       # POST /KBArticle - Create a new Knowledge Base Article
       def create_article(data)
-        post("/KBArticle", data)
+        create_resource('KBArticle', data)
       end
 
       # PUT /KBArticle/{id} - Update a Knowledge Base Article
       def update_article(id, data)
-        put("/KBArticle/#{id}", data)
+        update_resource('KBArticle', id, data)
       end
 
       # DELETE /KBArticle/{id} - Delete a Knowledge Base Article
       def delete_article(id)
-        delete("/KBArticle/#{id}")
+        delete_resource('KBArticle', id)
       end
 
       # GET /KBArticle/Search - Search Knowledge Base Articles
       def search_articles(params = {})
-        get("/KBArticle/Search", params)
+        get('KBArticle/Search', params)
       end
 
       # Knowledge Base Category methods
       # GET /KBCategory - List Knowledge Base Categories
       def categories(params = {})
-        get("/KBCategory", params)
+        list_resource('KBCategory', params)
       end
 
       # GET /KBCategory/{id} - Get specific Knowledge Base Category
       def category(id, params = {})
-        get("/KBCategory/#{id}", params)
+        get_resource('KBCategory', id, params)
       end
 
       # POST /KBCategory - Create Knowledge Base Category
       def create_category(data)
-        post("/KBCategory", data)
+        create_resource('KBCategory', data)
       end
 
       # PUT /KBCategory/{id} - Update Knowledge Base Category
       def update_category(id, data)
-        put("/KBCategory/#{id}", data)
+        update_resource('KBCategory', id, data)
       end
 
       # DELETE /KBCategory/{id} - Delete Knowledge Base Category
       def delete_category(id)
-        delete("/KBCategory/#{id}")
+        delete_resource('KBCategory', id)
       end
 
       # Knowledge Base Keywords methods
       # GET /KBKeywords - List Knowledge Base Keywords
       def keywords(params = {})
-        get("/KBKeywords", params)
+        list_resource('KBKeywords', params)
       end
 
       # GET /KBKeywords/{id} - Get specific Knowledge Base Keywords
       def keyword(id, params = {})
-        get("/KBKeywords/#{id}", params)
+        get_resource('KBKeywords', id, params)
       end
 
       # POST /KBKeywords - Create Knowledge Base Keywords
       def create_keyword(data)
-        post("/KBKeywords", data)
+        create_resource('KBKeywords', data)
       end
 
       # PUT /KBKeywords/{id} - Update Knowledge Base Keywords
       def update_keyword(id, data)
-        put("/KBKeywords/#{id}", data)
+        update_resource('KBKeywords', id, data)
       end
 
       # DELETE /KBKeywords/{id} - Delete Knowledge Base Keywords
       def delete_keyword(id)
-        delete("/KBKeywords/#{id}")
+        delete_resource('KBKeywords', id)
       end
     end
   end

data/lib/halo_msp_api/resources/organisations.rb

@@ -2,30 +2,31 @@
 
 module HaloMspApi
   module Resources
+    # Resource class for Organisations
     class Organisations < Base
       # GET /Organisation - List of Organisations
-      def list(params = {})
-        list_resource("Organisation", params)
+      def organisations(params = {})
+        list_resource('Organisation', params)
       end
 
       # GET /Organisation/{id} - Get a specific Organisation
-      def get(id, params = {})
-        get_resource("Organisation", id, params)
+      def organisation(id, params = {})
+        get_resource('Organisation', id, params)
       end
 
       # POST /Organisation - Create a new Organisation
-      def create(data)
-        create_resource("Organisation", data)
+      def create_organisation(data)
+        create_resource('Organisation', data)
       end
 
       # PUT /Organisation/{id} - Update an Organisation
-      def update(id, data)
-        update_resource("Organisation", id, data)
+      def update_organisation(id, data)
+        update_resource('Organisation', id, data)
       end
 
       # DELETE /Organisation/{id} - Delete an Organisation
-      def delete(id)
-        delete_resource("Organisation", id)
+      def delete_organisation(id)
+        delete_resource('Organisation', id)
       end
     end
   end

data/lib/halo_msp_api/resources/products.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module HaloMspApi
+  module Resources
+    # Resource class for Products
+    class Products < Base
+      # GET /Item - List of Products
+      def products(params = {})
+        list_resource('Item', params)
+      end
+
+      # GET /Item/{id} - Get a specific Product
+      def product(id, params = {})
+        get_resource('Item', id, params)
+      end
+
+      # POST /Item - Create a new Product
+      def create_product(data)
+        create_resource('Item', data)
+      end
+
+      # PUT /Item/{id} - Update a Product
+      def update_product(id, data)
+        update_resource('Item', id, data)
+      end
+
+      # DELETE /Item/{id} - Delete a Product
+      def delete_product(id)
+        delete_resource('Item', id)
+      end
+    end
+  end
+end

data/lib/halo_msp_api/resources/purchase_orders.rb

@@ -2,55 +2,56 @@
 
 module HaloMspApi
   module Resources
+    # Resource class for Purchase Orders
     class PurchaseOrders < Base
       # GET /PurchaseOrder - List of Purchase Orders
-      def list(params = {})
-        list_resource("PurchaseOrder", params)
+      def purchase_orders(params = {})
+        list_resource('PurchaseOrder', params)
       end
 
       # GET /PurchaseOrder/{id} - Get a specific Purchase Order
-      def get(id, params = {})
-        get_resource("PurchaseOrder", id, params)
+      def purchase_order(id, params = {})
+        get_resource('PurchaseOrder', id, params)
       end
 
       # POST /PurchaseOrder - Create a new Purchase Order
-      def create(data)
-        create_resource("PurchaseOrder", data)
+      def create_purchase_order(data)
+        create_resource('PurchaseOrder', data)
       end
 
       # PUT /PurchaseOrder/{id} - Update a Purchase Order
-      def update(id, data)
-        update_resource("PurchaseOrder", id, data)
+      def update_purchase_order(id, data)
+        update_resource('PurchaseOrder', id, data)
       end
 
       # DELETE /PurchaseOrder/{id} - Delete a Purchase Order
-      def delete(id)
-        delete_resource("PurchaseOrder", id)
+      def delete_purchase_order(id)
+        delete_resource('PurchaseOrder', id)
       end
 
       # POST /PurchaseOrder/Approval - Purchase Order approval
       def approval(data)
-        post(resource_path("PurchaseOrder", nil, "Approval"), data)
+        post(resource_path('PurchaseOrder', nil, 'Approval'), data)
       end
 
       # GET /PurchaseOrder/Lines - Get Purchase Order lines
       def lines(params = {})
-        get(resource_path("PurchaseOrder", nil, "Lines"), params)
+        get(resource_path('PurchaseOrder', nil, 'Lines'), params)
       end
 
       # GET /PurchaseOrder/NextRef - Get next Purchase Order reference
       def next_ref(params = {})
-        get(resource_path("PurchaseOrder", nil, "NextRef"), params)
+        get(resource_path('PurchaseOrder', nil, 'NextRef'), params)
       end
 
       # POST /PurchaseOrder/updatelines - Update Purchase Order lines
       def update_lines(data)
-        post(resource_path("PurchaseOrder", nil, "updatelines"), data)
+        post(resource_path('PurchaseOrder', nil, 'updatelines'), data)
       end
 
       # GET /PurchaseOrder/View - Get Purchase Order view
       def view(params = {})
-        get(resource_path("PurchaseOrder", nil, "View"), params)
+        get(resource_path('PurchaseOrder', nil, 'View'), params)
       end
     end
   end

data/lib/halo_msp_api/resources/quotations.rb

@@ -2,45 +2,46 @@
 
 module HaloMspApi
   module Resources
+    # Resource class for Quotations
     class Quotations < Base
       # GET /Quotation - List of Quotations
-      def list(params = {})
-        list_resource("Quotation", params)
+      def quotations(params = {})
+        list_resource('Quotation', params)
       end
 
       # GET /Quotation/{id} - Get a specific Quotation
-      def get(id, params = {})
-        get_resource("Quotation", id, params)
+      def quotation(id, params = {})
+        get_resource('Quotation', id, params)
       end
 
       # POST /Quotation - Create a new Quotation
-      def create(data)
-        create_resource("Quotation", data)
+      def create_quotation(data)
+        create_resource('Quotation', data)
       end
 
       # PUT /Quotation/{id} - Update a Quotation
-      def update(id, data)
-        update_resource("Quotation", id, data)
+      def update_quotation(id, data)
+        update_resource('Quotation', id, data)
       end
 
       # DELETE /Quotation/{id} - Delete a Quotation
-      def delete(id)
-        delete_resource("Quotation", id)
+      def delete_quotation(id)
+        delete_resource('Quotation', id)
       end
 
       # POST /Quotation/Approval - Quotation approval
       def approval(data)
-        post(resource_path("Quotation", nil, "Approval"), data)
+        post(resource_path('Quotation', nil, 'Approval'), data)
       end
 
       # GET /Quotation/Lines - Get Quotation lines
       def lines(params = {})
-        get(resource_path("Quotation", nil, "Lines"), params)
+        get(resource_path('Quotation', nil, 'Lines'), params)
       end
 
       # GET /Quotation/View - Get Quotation view
       def view(params = {})
-        get(resource_path("Quotation", nil, "View"), params)
+        get(resource_path('Quotation', nil, 'View'), params)
       end
     end
   end

data/lib/halo_msp_api/resources/reports.rb

@@ -2,86 +2,87 @@
 
 module HaloMspApi
   module Resources
+    # Resource class for Reports
     class Reports < Base
       # GET /Report - List of Reports
-      def list(params = {})
-        list_resource("Report", params)
+      def reports(params = {})
+        list_resource('Report', params)
       end
 
       # GET /Report/{id} - Get a specific Report
-      def get(id, params = {})
-        get_resource("Report", id, params)
+      def report(id, params = {})
+        get_resource('Report', id, params)
       end
 
       # POST /Report - Create a new Report
-      def create(data)
-        create_resource("Report", data)
+      def create_report(data)
+        create_resource('Report', data)
       end
 
       # PUT /Report/{id} - Update a Report
-      def update(id, data)
-        update_resource("Report", id, data)
+      def update_report(id, data)
+        update_resource('Report', id, data)
       end
 
       # DELETE /Report/{id} - Delete a Report
-      def delete(id)
-        delete_resource("Report", id)
+      def delete_report(id)
+        delete_resource('Report', id)
       end
 
       # GET /Report/Bookmark - Get Report bookmarks
       def bookmarks(params = {})
-        get(resource_path("Report", nil, "Bookmark"), params)
+        get(resource_path('Report', nil, 'Bookmark'), params)
       end
 
       # POST /Report/Bookmark - Create Report bookmark
       def create_bookmark(data)
-        post(resource_path("Report", nil, "Bookmark"), data)
+        post(resource_path('Report', nil, 'Bookmark'), data)
       end
 
       # POST /Report/createpdf - Create Report PDF
       def create_pdf(data)
-        post(resource_path("Report", nil, "createpdf"), data)
+        post(resource_path('Report', nil, 'createpdf'), data)
       end
 
       # POST /Report/print - Print Report
-      def print(data)
-        post(resource_path("Report", nil, "print"), data)
+      def print_report(data)
+        post(resource_path('Report', nil, 'print'), data)
       end
 
       # GET /ReportData/{publishedid} - Get Report data
       def data(published_id, params = {})
-        get("/ReportData/#{published_id}", params)
+        get("ReportData/#{published_id}", params)
       end
 
       # Report Repository methods
       # GET /ReportRepository - List Report repositories
       def repositories(params = {})
-        get("/ReportRepository", params)
+        list_resource('ReportRepository', params)
       end
 
       # GET /ReportRepository/{id} - Get specific Report repository
       def repository(id, params = {})
-        get("/ReportRepository/#{id}", params)
+        get_resource('ReportRepository', id, params)
       end
 
       # POST /ReportRepository - Create Report repository
       def create_repository(data)
-        post("/ReportRepository", data)
+        create_resource('ReportRepository', data)
       end
 
       # PUT /ReportRepository/{id} - Update Report repository
       def update_repository(id, data)
-        put("/ReportRepository/#{id}", data)
+        update_resource('ReportRepository', id, data)
       end
 
       # DELETE /ReportRepository/{id} - Delete Report repository
       def delete_repository(id)
-        delete("/ReportRepository/#{id}")
+        delete_resource('ReportRepository', id)
       end
 
       # GET /ReportRepository/ReportCategories - Get Report categories
       def categories(params = {})
-        get("/ReportRepository/ReportCategories", params)
+        get('ReportRepository/ReportCategories', params)
       end
     end
   end