intacct-rest 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa26a0193bf0a743c64e8b7a0872a17922be601d53bb0a8f809aa09d33bee382
-  data.tar.gz: 1d27d3c95af15ddf66d879fb8c08d86a7b0f67c223034606dff1df8cf1e32624
+  metadata.gz: 5a6731f918358600559712cf46245ade06051c5baad36679f586098ba8292ce7
+  data.tar.gz: '08a147feac379d3549d35d7ac345796ac2686d22ae605f2d857cdf625c0011ba'
 SHA512:
-  metadata.gz: f8d45d6db98887b8af8974e601fff28d4c8534d8d52147b41d8336c2f2da4865864fde4c146a978d20dac67f32ebda91eb4e459ccbf83d5a6077cc5ff62954f8
-  data.tar.gz: d2c3b257318be66c710a2c008ccb4b65d2e719e3ee9e35701511ac0cfd3358a6c42ab98214647490426e28f295b40678abba1a7b8c28340ae40eb75933edae4b
+  metadata.gz: 21137e073809b557d7f6fe00595c60423e85b04d0616683a6826e7c29ada6f645a4b2069d8596164c2c4c80b53e16182232112dfaf5c7ade25a3971aac29e16b
+  data.tar.gz: 1e962684b6d9ee8838c83be7b2dc3ba04471cd5ff578296ba55a7f09431c4575dcbf9f7b033eae9e61afd0ace2ebdc923108bda184fc189d3ceb909910d8cf55

data/README.md

@@ -14,7 +14,8 @@ A small, framework-agnostic Ruby client for [Sage Intacct's REST API v1](https:/
 - **`IntacctRest::Model::Contact`**, a data + validation object for the non-deprecated subset of the contact shape shared by vendors and customers (no dedicated create endpoint — contacts are referenced by id from `contacts`/`contact_list`; this is just a typed helper for building that nested payload)
 - **The `POST /objects/accounts-payable/bill` endpoint**, via `IntacctRest::Endpoints::CreateBill` and `IntacctRest::Model::Bill`, reusing the same `Post`/validation pattern
 - **The `POST /objects/accounts-payable/bill-line` endpoint**, via `IntacctRest::Endpoints::CreateBillLine` and `IntacctRest::Model::BillLine`
-
+- **The `DELETE /objects/accounts-payable/bill/{key}` endpoint**, via `IntacctRest::Endpoints::DeleteBill` and `IntacctRest::Delete` (the generic "delete this model" operation), sending only the model key
+- **The `DELETE /objects/accounts-receivable/invoice/{key}` endpoint**, via `IntacctRest::Endpoints::DeleteInvoice` and `IntacctRest::Delete` (the generic "delete this model" operation), sending only the model key
 It has no Rails, ActiveRecord, or Redis dependency — the host application supplies its own token store and error-handling hook.
 
 ## Installation
@@ -245,14 +246,18 @@ What still raises, before any request is sent or when something is actually brok
 
 ```ruby
 validate :presence, %i[id name], on: :create
+
 validate :presence, %i[key], on: :update
 validate :kind_of, :string, %i[key], on: :update
 
+validate :presence, %i[key], on: :delete
+validate :kind_of, :string, %i[key], on: :delete
+
 validate :kind_of, :string, %i[id name status state ...]
 validate :inclusion, BANK_FILE_COUNTRY_CODES, %i[bank_files_payment_country_code]
 ```
 
-`on:` scopes a validation to one operation: it only runs when `#errors`/`#valid?` is called with that context. A validation without `on:` always runs. `Post` validates with `:create` and `Patch` with `:update`, so a vendor needs `id`/`name` to be created and `key` to be updated (see Updating a vendor, below).
+`on:` scopes a validation to one operation: it only runs when `#errors`/`#valid?` is called with that context. A validation without `on:` always runs. `Post` validates with `:create`, `Patch` with `:update` and `Delete` with `:delete`. Therefore a vendor needs `id`/`name` to be created and `key` to be updated (see Updating a vendor, below) and a bill or invoices to be deleted needs `key`.
 
 Four validator kinds ship in `IntacctRest::Validators`:
 
@@ -261,7 +266,7 @@ Four validator kinds ship in `IntacctRest::Validators`:
 - `:inclusion` — the attribute, if present, must be included in a given list (e.g. Intacct's documented bank-file country codes)
 - `:custom` — the attribute, if present, is passed to an instance method you name (`record.send(method_name, value)`); a falsy return means invalid
 
-By default, `Post` validates the model first, raising `IntacctRest::ValidationError` and skipping the HTTP request entirely if it's invalid — currently that means `id`/`name` presence, every field's documented type, and `bank_files["paymentCountryCode"]` (if set) matching a real country code. `Patch` does the same with `key` in place of `id`/`name`. Note Intacct can auto-generate `id` when document sequencing is enabled for your company; override `errors` in a `Model::Vendor` subclass if you need to relax that.
+By default, `Post` validates the model first, raising `IntacctRest::ValidationError` and skipping the HTTP request entirely if it's invalid — currently that means `id`/`name` presence, every field's documented type, and `bank_files["paymentCountryCode"]` (if set) matching a real country code. `Patch` and `Delete` does the same with `key` in place of `id`/`name`. Note Intacct can auto-generate `id` when document sequencing is enabled for your company; override `errors` in a `Model::Vendor` subclass if you need to relax that.
 
 ### Custom fields
 
@@ -327,6 +332,52 @@ vendor.id       # => "V-00014"   (filled in from the response by Patch, via mode
 
 Like `Post`, it never raises for the HTTP outcome and always returns an `IntacctRest::Result` (see The Result, above).
 
+## Deleting a payment
+
+`IntacctRest::Endpoints::DeletePayment` sends `PATCH /objects/accounts-payable/bill/{key}`. Set `key` to pick the record, plus only the fields you want to change:
+
+```ruby
+bill = IntacctRest::Model::Bill.new(key: "111")
+
+result = IntacctRest::Endpoints::DeleteBill.call(bill: bill)
+
+result.success? # => true
+bill.id       # => "00014" (model contains the same data before it was sent)
+bill.key      # => "111"
+```
+
+- `key` is required on delete and must be a String.
+- `results:` a successful response is a non content http response with 200 status
+
+
+## Deleting a invoice
+
+`IntacctRest::Endpoints::DeleteInvoice` sends `PATCH /objects/accounts-receivable/invoice/{key}`. Set `key` to pick the record, plus only the fields you want to change:
+
+```ruby
+invoice = IntacctRest::Model::Invoice.new(key: "111")
+
+result = IntacctRest::Endpoints::DeleteInvoice.call(invoice: invoice)
+
+result.success? # => true
+invoice.id       # => "00014" (model contains the same data before it was sent)
+invoice.key      # => "111"
+```
+
+- `key` is required on delete and must be a String.
+- `results:` a successful response is a non content http response with 200 status
+
+## IntacctRest::Delete
+
+`IntacctRest::Delete` is the generic "delete this model" operation behind `DeleteBill` and `DeleteInvoice`, the DELETE counterpart of `Post`. It works against any model that responds to:
+
+- `#intacct_object` — the collection path; `Delete` appends `/#{model.key}`
+- `#key` — the record to delete
+- `#errors(:delete)` — validated first the key that any model should required presense of; any error raises `IntacctRest::ValidationError` and no request is sent
+- `#apply_result` — called with the Result on success but this is always empty model preserves its data
+
+Like `Post`, it never raises for the HTTP outcome and always returns an `IntacctRest::Result` (see The Result, above).
+
 ## Creating an invoice
 
 Same three pieces as vendors — `IntacctRest::Model::Invoice` (data + validation), `IntacctRest::Post` (generic send), `IntacctRest::Endpoints::CreateInvoice` (the invoice-specific use case):

data/lib/intacct_rest/delete.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module IntacctRest
+  # Generic operation for Delete-ing (deleting) any model that responds to
+  # #intacct_object (the collection path), #key (the record appended to
+  # it)and #valid?/#errors with an :delete context. Raises
+  # IntacctRest::ValidationError if the model is invalid for delete.
+  # Returns an IntacctRest::Result (Success or Error) — never raises for the HTTP
+  # outcome itself. On success, calls model.apply_result(result) so the
+  # model can absorb whatever it cares about from the response.
+  class Delete
+    include AuthenticatedRequest
+
+    def self.call(model, config: IntacctRest.configuration, token_provider: nil)
+      new(config: config, token_provider: token_provider).send(:perform, model)
+    end
+
+    def initialize(config: IntacctRest.configuration, token_provider: nil)
+      @config = config
+      @token_provider = token_provider || IntacctRest::OauthClient.new(config: config)
+    end
+
+    private
+
+    attr_reader :config, :token_provider
+
+    def perform(model)
+      errors = model.errors(:delete)
+      raise IntacctRest::ValidationError.new(errors.join('; '), attributes: errors) unless errors.empty?
+
+      path = "#{model.intacct_object}/#{model.key}"
+      response = authenticated_response(:delete, path)
+      parsed = parse_json(response.body, path)
+      result = build_result(model, response, parsed)
+      model.apply_result(result) if result.success?
+      result
+    end
+
+    def build_result(model, response, parsed)
+      klass = response.is_a?(Net::HTTPSuccess) ? IntacctRest::Result::Success : IntacctRest::Result::Error
+      klass.new(model: model, code: response.code, body: parsed, headers: response.to_hash)
+    end
+  end
+end

data/lib/intacct_rest/endpoints/delete_bill.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module IntacctRest
+  module Endpoints
+    # Delete /objects/accounts-payable/delete/{key}. delete.key picks the
+    # record; only the key field is required and sent.
+
+    class DeleteBill
+      # model already knows the bill data it just checks http response.
+      def self.call(bill:, results: [], config: IntacctRest.configuration, token_provider: nil)
+        unless bill.is_a?(IntacctRest::Model::Bill)
+          raise ArgumentError, 'bill must be an IntacctRest::Model::Bill'
+        end
+
+        result = IntacctRest::Delete.call(bill, config: config, token_provider: token_provider)
+
+        result
+      end
+    end
+  end
+end

data/lib/intacct_rest/endpoints/delete_invoice.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module IntacctRest
+  module Endpoints
+    # Delete /objects/accounts-payable/delete/{key}. delete.key picks the
+    # record; only the key field is required and sent.
+
+    class DeleteInvoice
+      # model already knows the invoice data it just checks http response.
+      def self.call(invoice:, results: [], config: IntacctRest.configuration, token_provider: nil)
+        unless invoice.is_a?(IntacctRest::Model::Invoice)
+          raise ArgumentError, 'invoice must be an IntacctRest::Model::Invoice'
+        end
+
+        result = IntacctRest::Delete.call(invoice, config: config, token_provider: token_provider)
+
+        result
+      end
+    end
+  end
+end

data/lib/intacct_rest/model/bill.rb

@@ -38,19 +38,22 @@ module IntacctRest
       attr_accessor(*READONLY_ATTRIBUTES)
       attr_reader :custom_fields
 
-      validate :presence, %i[due_date created_date]
+      validate :presence, %i[due_date created_date], on: :create
 
       validate :kind_of, :string, %i[
         bill_number state reference_number description posting_date discount_cut_off_date
         due_date recommended_payment_date created_date invoice_type invoice_mode
-      ]
-      validate :kind_of, :boolean, %i[is_on_hold is_tax_inclusive]
+      ], on: :create
+      validate :kind_of, :boolean, %i[is_on_hold is_tax_inclusive], on: :create
       validate :kind_of, :hash, %i[
         vendor term contacts currency tax_solution bill_summary bill_back_template attachment
         dispute refuse
       ]
       validate :kind_of, :array, %i[lines]
 
+      validate :presence, %i[key], on: :delete
+      validate :kind_of, :string, %i[key], on: :delete
+
       # source: an arbitrary domain object (ActiveRecord record, OpenStruct,
       # another Model::Bill, ...) to pull matching attributes off of via
       # duck-typing — any WRITABLE_ATTRIBUTES/READONLY_ATTRIBUTES key it

data/lib/intacct_rest/model/invoice.rb

@@ -40,8 +40,10 @@ module IntacctRest
       attr_accessor(*READONLY_ATTRIBUTES)
       attr_reader :custom_fields
 
-      validate :presence, %i[invoice_date due_date]
+      validate :presence, %i[invoice_date due_date], on: :create
+      validate :presence, %i[key], on: :delete
 
+      validate :kind_of, :string, %i[key], on: :delete
       validate :kind_of, :string, %i[
         invoice_number state reference_number description invoice_date due_date
         invoice_type invoice_mode
@@ -52,6 +54,8 @@ module IntacctRest
       ]
       validate :kind_of, :array, %i[lines]
 
+
+
       # source: an arbitrary domain object (ActiveRecord record, OpenStruct,
       # another Model::Invoice, ...) to pull matching attributes off of via
       # duck-typing — any WRITABLE_ATTRIBUTES/READONLY_ATTRIBUTES key it

data/lib/intacct_rest/version.rb

@@ -1,3 +1,3 @@
 module IntacctRest
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/lib/intacct_rest.rb

@@ -42,6 +42,7 @@ require 'intacct_rest/result/success'
 require 'intacct_rest/result/error'
 require 'intacct_rest/post'
 require 'intacct_rest/patch'
+require 'intacct_rest/delete'
 require 'intacct_rest/endpoints/create_vendor'
 require 'intacct_rest/endpoints/update_vendor'
 require 'intacct_rest/endpoints/create_invoice'
@@ -50,6 +51,8 @@ require 'intacct_rest/endpoints/create_invoice_line'
 require 'intacct_rest/endpoints/create_customer'
 require 'intacct_rest/endpoints/create_bill'
 require 'intacct_rest/endpoints/create_bill_line'
+require 'intacct_rest/endpoints/delete_bill'
+require 'intacct_rest/endpoints/delete_invoice'
 require 'intacct_rest/query'
 require 'intacct_rest/objects'
 require 'intacct_rest/schema_generator'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intacct-rest
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Bernardo Espinoza
@@ -84,6 +84,7 @@ files:
 - lib/intacct_rest/client.rb
 - lib/intacct_rest/configuration.rb
 - lib/intacct_rest/custom_field.rb
+- lib/intacct_rest/delete.rb
 - lib/intacct_rest/endpoints/create_bill.rb
 - lib/intacct_rest/endpoints/create_bill_line.rb
 - lib/intacct_rest/endpoints/create_customer.rb
@@ -91,6 +92,8 @@ files:
 - lib/intacct_rest/endpoints/create_invoice_line.rb
 - lib/intacct_rest/endpoints/create_term.rb
 - lib/intacct_rest/endpoints/create_vendor.rb
+- lib/intacct_rest/endpoints/delete_bill.rb
+- lib/intacct_rest/endpoints/delete_invoice.rb
 - lib/intacct_rest/endpoints/update_vendor.rb
 - lib/intacct_rest/error_reporting.rb
 - lib/intacct_rest/errors.rb
@@ -146,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.20
+rubygems_version: 4.0.6
 specification_version: 4
 summary: A Ruby wrapper for Intacct SAGE Rest API
 test_files: []