myob_acumatica 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e15a5861adfeb95df2fd9ba27fdcabdd38ddd7256e06114f4f24307c3f094429
-  data.tar.gz: b30cb9b7080780e7017572c24e886785c8ea6c7b136ac770396f36dada9f55b6
+  metadata.gz: f55ce7017ae2648ed83e6342d1067b97529db7dfac0437d45602f748e0ac402d
+  data.tar.gz: 3b3e9c12b1ca74f6b9214b1e97ffe8c086a16dc79af3dd475d371e127e676f2f
 SHA512:
-  metadata.gz: 8d505819ddac73957aa98a108f1f4a7d2ae9d8f21b9b0f5faa7f026fb61e2e52c16e45cdf8f04eab7e2d4b69f6c9b45d920a800060c5b896d997c00978e89bcc
-  data.tar.gz: 9d558ce25b14bc005aebe2c4693d3ca2c9e1192d36a1f6aaf4ff984d8e640a4590b453ea75276acd8a47eb28fcd5f46200d354319353e535886ba77249443257
+  metadata.gz: 8ea6da5df7be16a1dcb9f62ad4db478683b8d60ea2c735dfd852cc510d5f84ff3437accfd1ab9747d0efa28ee97665611ff9c66fe4d8e9267a42487cbb2e5733
+  data.tar.gz: 5aed30d5a8da8d83f60ab217629f7327f876c87268cf86c0a4c3b1c93ef96cb6a41f6e14a6ca491e1ed09bad0d502f07cbe0a75396418795d3872aa76826e955

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## [0.1.5] - 2025-08-13
+### Added
+- **Currency API** support:
+  - `delete_by_id`
+  - `delete_by_keys`
+  - `get_ad_hoc_schema`
+  - `get_by_id`
+  - `get_by_keys`
+  - `get_list`
+  - `invoke_action`
+  - `put_entity`
+  - `put_file`
+
 ## [0.1.4] - 2025-08-13
 ### Added
 - **Tax API** support:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    myob_acumatica (0.1.4)
+    myob_acumatica (0.1.5)
 
 GEM
   remote: https://rubygems.org/

data/examples/currency.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'logger'
+require 'date'
+require 'dotenv/load'
+require 'myob_acumatica'
+
+access_token = ENV['MYOB_ACUMATICA_ACCESS_TOKEN']
+logger = Logger.new($stdout)
+
+MyobAcumatica::Api::Currency.get_ad_hoc_schema(
+  access_token: access_token,
+  logger: logger
+)
+
+currency1 = MyobAcumatica::Api::Currency.put_entity(
+  access_token: access_token,
+  entity: {
+    'CurrencyID' => { 'value' => 'XCU1' },
+    'Description' => { 'value' => 'Example Currency 1' }
+  },
+  logger: logger
+)
+
+currency2 = MyobAcumatica::Api::Currency.put_entity(
+  access_token: access_token,
+  entity: {
+    'CurrencyID' => { 'value' => 'XCU2' },
+    'Description' => { 'value' => 'Example Currency 2' }
+  },
+  logger: logger
+)
+
+puts "Created XCU1 id=#{currency1['id']}"
+puts "Created XCU2 id=#{currency2['id']}"
+
+currency1 = MyobAcumatica::Api::Currency.put_entity(
+  access_token: access_token,
+  entity: {
+    'id' => currency1['id'],
+    'Description' => { 'value' => 'Example Currency 1 (updated)' }
+  },
+  logger: logger
+)
+puts 'Updated XCU1 description'
+
+by_id = MyobAcumatica::Api::Currency.get_by_id(
+  access_token: access_token,
+  id: currency1['id'],
+  logger: logger
+)
+puts "Fetched by id: #{by_id['CurrencyID']&.dig('value')}"
+
+by_keys = MyobAcumatica::Api::Currency.get_by_keys(
+  access_token: access_token,
+  keys: ['AMD'],
+  logger: logger
+)
+puts "Fetched by keys: #{by_keys['CurrencyID']&.dig('value')}"
+
+list = MyobAcumatica::Api::Currency.get_list(
+  access_token: access_token,
+  query_params: { '$select' => 'CurrencyID,Description', '$top' => 5 },
+  logger: logger
+)
+puts "Listed #{list.size} currency record(s)"
+
+# MyobAcumatica::Api::Currency.put_file(
+#   access_token: access_token,
+#   keys: ['AMD'],
+#   file_path: 'examples/dummy.pdf',
+#   logger: logger
+# )
+# puts 'Attached file to AMD'
+
+# MyobAcumatica::Api::Currency.invoke_action(
+#   access_token: access_token,
+#   action_name: 'CustomAction',
+#   entity: { 'id' => currency1['id'] },
+#   logger: logger
+# )
+# puts 'Invoked action on XCU1'
+
+# MyobAcumatica::Api::Currency.delete_by_keys(
+#   access_token: access_token,
+#   keys: ['XCU2'],
+#   logger: logger
+# )
+# puts 'Deleted XCU2 by keys'
+
+MyobAcumatica::Api::Currency.delete_by_id(
+  access_token: access_token,
+  id: currency1['id'],
+  logger: logger
+)
+puts 'Deleted XCU1 by id'

data/lib/myob_acumatica/api/currency.rb

@@ -0,0 +1,340 @@
+# frozen_string_literal: true
+
+module MyobAcumatica
+  module Api
+    # Provides methods to interact with the Currency API endpoints.
+    module Currency
+      module_function
+
+      ##
+      # Deletes a currency record by its session UUID.
+      #
+      # @example Delete a currency by ID
+      #   MyobAcumatica::Api::Currency.delete_by_id(
+      #     access_token: access_token,
+      #     id: currency['id'],
+      #     logger: logger
+      #   )
+      #
+      # @param access_token [String] OAuth2 access token.
+      # @param id [String] Session UUID of the currency record.
+      # @param instance_name [String] The instance name.
+      # @param endpoint_name [String] The endpoint name.
+      # @param endpoint_version [String] The endpoint version.
+      # @param logger [Logger, nil] Optional logger.
+      # @return [nil]
+      def delete_by_id(access_token:, id:,
+                       instance_name: INSTANCE_NAME,
+                       endpoint_name: ENDPOINT_NAME,
+                       endpoint_version: ENDPOINT_VERSION,
+                       logger: nil)
+        Http.request(
+          instance_name: instance_name,
+          access_token: access_token,
+          method: :delete,
+          endpoint_name: endpoint_name,
+          endpoint_version: endpoint_version,
+          path: "Currency/#{id}",
+          logger: logger
+        )
+      end
+
+      ##
+      # Deletes a currency record by composite keys.
+      #
+      # Keys are ordered values of the record's key fields.
+      #
+      # @example Delete a currency by keys
+      #   MyobAcumatica::Api::Currency.delete_by_keys(
+      #     access_token: access_token,
+      #     keys: [currency['CurrencyID']['value']],
+      #     logger: logger
+      #   )
+      #
+      # @param access_token [String] OAuth2 access token.
+      # @param keys [Array<String>] Key values identifying the currency record.
+      # @param instance_name [String] The instance name.
+      # @param endpoint_name [String] The endpoint name.
+      # @param endpoint_version [String] The endpoint version.
+      # @param logger [Logger, nil] Optional logger.
+      # @return [nil]
+      def delete_by_keys(access_token:, keys:,
+                         instance_name: INSTANCE_NAME,
+                         endpoint_name: ENDPOINT_NAME,
+                         endpoint_version: ENDPOINT_VERSION,
+                         logger: nil)
+        Http.request(
+          instance_name: instance_name,
+          access_token: access_token,
+          method: :delete,
+          endpoint_name: endpoint_name,
+          endpoint_version: endpoint_version,
+          path: "Currency/#{keys.join('/')}",
+          logger: logger
+        )
+      end
+
+      ##
+      # Retrieves the ad-hoc schema (custom fields) for the Currency entity.
+      #
+      # @example Retrieve ad-hoc schema
+      #   MyobAcumatica::Api::Currency.get_ad_hoc_schema(
+      #     access_token: access_token,
+      #     logger: logger
+      #   )
+      #
+      # @param access_token [String] OAuth2 access token.
+      # @param instance_name [String] The instance name.
+      # @param endpoint_name [String] The endpoint name.
+      # @param endpoint_version [String] The endpoint version.
+      # @param logger [Logger, nil] Optional logger.
+      # @return [Hash] Ad-hoc schema payload.
+      def get_ad_hoc_schema(access_token:,
+                            instance_name: INSTANCE_NAME,
+                            endpoint_name: ENDPOINT_NAME,
+                            endpoint_version: ENDPOINT_VERSION,
+                            logger: nil)
+        Http.request(
+          instance_name: instance_name,
+          access_token: access_token,
+          method: :get,
+          endpoint_name: endpoint_name,
+          endpoint_version: endpoint_version,
+          path: 'Currency/$adHocSchema',
+          logger: logger
+        )
+      end
+
+      ##
+      # Retrieves a currency record by its session UUID.
+      #
+      # @example Get currency by ID
+      #   MyobAcumatica::Api::Currency.get_by_id(
+      #     access_token: access_token,
+      #     id: currency['id'],
+      #     logger: logger
+      #   )
+      #
+      # @param access_token [String] OAuth2 access token.
+      # @param id [String] Session UUID of the currency record.
+      # @param query_params [Hash] Optional query params ($select, $expand, $filter,
+      #   $custom).
+      # @param instance_name [String] The instance name.
+      # @param endpoint_name [String] The endpoint name.
+      # @param endpoint_version [String] The endpoint version.
+      # @param logger [Logger, nil] Optional logger.
+      # @return [Hash] The currency record.
+      def get_by_id(access_token:, id:, query_params: {},
+                    instance_name: INSTANCE_NAME,
+                    endpoint_name: ENDPOINT_NAME,
+                    endpoint_version: ENDPOINT_VERSION,
+                    logger: nil)
+        Http.request(
+          instance_name: instance_name,
+          access_token: access_token,
+          method: :get,
+          endpoint_name: endpoint_name,
+          endpoint_version: endpoint_version,
+          path: "Currency/#{id}",
+          query_params: query_params,
+          logger: logger
+        )
+      end
+
+      ##
+      # Retrieves a currency record by composite keys.
+      #
+      # @example Get currency by keys
+      #   MyobAcumatica::Api::Currency.get_by_keys(
+      #     access_token: access_token,
+      #     keys: ['USD'],
+      #     logger: logger
+      #   )
+      #
+      # @param access_token [String] OAuth2 access token.
+      # @param keys [Array<String>] Key values identifying the currency record.
+      # @param query_params [Hash] Optional query params.
+      # @param instance_name [String] The instance name.
+      # @param endpoint_name [String] The endpoint name.
+      # @param endpoint_version [String] The endpoint version.
+      # @param logger [Logger, nil] Optional logger.
+      # @return [Hash] The currency record.
+      def get_by_keys(access_token:, keys:, query_params: {},
+                      instance_name: INSTANCE_NAME,
+                      endpoint_name: ENDPOINT_NAME,
+                      endpoint_version: ENDPOINT_VERSION,
+                      logger: nil)
+        Http.request(
+          instance_name: instance_name,
+          access_token: access_token,
+          method: :get,
+          endpoint_name: endpoint_name,
+          endpoint_version: endpoint_version,
+          path: "Currency/#{keys.join('/')}",
+          query_params: query_params,
+          logger: logger
+        )
+      end
+
+      ##
+      # Retrieves a list of currency records with optional filtering and paging.
+      #
+      # @example List currencies
+      #   MyobAcumatica::Api::Currency.get_list(
+      #     access_token: access_token,
+      #     query_params: { '$top' => 10 },
+      #     logger: logger
+      #   )
+      #
+      # @param access_token [String] OAuth2 access token.
+      # @param query_params [Hash] Optional query params.
+      # @param instance_name [String] The instance name.
+      # @param endpoint_name [String] The endpoint name.
+      # @param endpoint_version [String] The endpoint version.
+      # @param logger [Logger, nil] Optional logger.
+      # @return [Array<Hash>] List of currency records.
+      def get_list(access_token:, query_params: {},
+                   instance_name: INSTANCE_NAME,
+                   endpoint_name: ENDPOINT_NAME,
+                   endpoint_version: ENDPOINT_VERSION,
+                   logger: nil)
+        Http.request(
+          instance_name: instance_name,
+          access_token: access_token,
+          method: :get,
+          endpoint_name: endpoint_name,
+          endpoint_version: endpoint_version,
+          path: 'Currency',
+          query_params: query_params,
+          logger: logger
+        )
+      end
+
+      ##
+      # Invokes a custom action on a currency record.
+      #
+      # @example Invoke a custom action
+      #   MyobAcumatica::Api::Currency.invoke_action(
+      #     access_token: access_token,
+      #     action_name: 'CustomAction',
+      #     entity: { 'id' => currency['id'] },
+      #     parameters: {},
+      #     logger: logger
+      #   )
+      #
+      # @param access_token [String] OAuth2 access token.
+      # @param action_name [String] The action name to invoke.
+      # @param entity [Hash] Currency entity payload.
+      # @param parameters [Hash] Optional parameters for the action.
+      # @param instance_name [String] The instance name.
+      # @param endpoint_name [String] The endpoint name.
+      # @param endpoint_version [String] The endpoint version.
+      # @param logger [Logger, nil] Optional logger.
+      # @return [Hash, nil] Action response or nil on 204.
+      def invoke_action(access_token:, action_name:, entity:, parameters: {},
+                        instance_name: INSTANCE_NAME,
+                        endpoint_name: ENDPOINT_NAME,
+                        endpoint_version: ENDPOINT_VERSION,
+                        logger: nil)
+        Http.request(
+          instance_name: instance_name,
+          access_token: access_token,
+          method: :post,
+          endpoint_name: endpoint_name,
+          endpoint_version: endpoint_version,
+          path: "Currency/#{action_name}",
+          body: { 'entity' => entity, 'parameters' => parameters },
+          logger: logger
+        )
+      end
+
+      ##
+      # Creates or updates a currency record.
+      #
+      # @example Create or update a currency
+      #   usd = MyobAcumatica::Api::Currency.put_entity(
+      #     access_token: access_token,
+      #     entity: { 'CurrencyID' => { 'value' => 'USD' } },
+      #     logger: logger
+      #   )
+      #
+      # @param access_token [String] OAuth2 access token.
+      # @param entity [Hash] Currency entity payload.
+      # @param query_params [Hash] Optional query params.
+      # @param instance_name [String] The instance name.
+      # @param endpoint_name [String] The endpoint name.
+      # @param endpoint_version [String] The endpoint version.
+      # @param logger [Logger, nil] Optional logger.
+      # @return [Hash] The created or updated currency record.
+      def put_entity(access_token:, entity:, query_params: {},
+                     instance_name: INSTANCE_NAME,
+                     endpoint_name: ENDPOINT_NAME,
+                     endpoint_version: ENDPOINT_VERSION,
+                     logger: nil)
+        Http.request(
+          instance_name: instance_name,
+          access_token: access_token,
+          method: :put,
+          endpoint_name: endpoint_name,
+          endpoint_version: endpoint_version,
+          path: 'Currency',
+          body: entity,
+          query_params: query_params,
+          logger: logger
+        )
+      end
+
+      ##
+      # Attaches a file to a currency record.
+      #
+      # @example Upload a file to a currency record
+      #   MyobAcumatica::Api::Currency.put_file(
+      #     access_token: access_token,
+      #     keys: ['USD'],
+      #     file_path: 'examples/rate-sheet.pdf',
+      #     logger: logger
+      #   )
+      #
+      # @param access_token [String] OAuth2 access token.
+      # @param keys [Array<String>] Key values identifying the currency record.
+      # @param file_path [String] Path to the file.
+      # @param instance_name [String] The instance name.
+      # @param endpoint_name [String] The endpoint name.
+      # @param endpoint_version [String] The endpoint version.
+      # @param logger [Logger, nil] Optional logger.
+      # @return [nil]
+      def put_file(access_token:, keys:, file_path:,
+                   instance_name: INSTANCE_NAME,
+                   endpoint_name: ENDPOINT_NAME,
+                   endpoint_version: ENDPOINT_VERSION,
+                   logger: nil)
+        entity = get_by_keys(
+          access_token: access_token,
+          keys: keys,
+          instance_name: instance_name,
+          endpoint_name: endpoint_name,
+          endpoint_version: endpoint_version,
+          logger: logger
+        )
+
+        put_template = entity.dig('_links', 'files:put')
+        raise MyobAcumatica::Error, 'files:put link not found' unless put_template
+
+        filename = File.basename(file_path)
+        path = put_template.gsub('{filename}', filename)
+
+        Http.request(
+          instance_name: instance_name,
+          access_token: access_token,
+          method: :put,
+          endpoint_name: endpoint_name,
+          endpoint_version: endpoint_version,
+          path: path,
+          body: File.binread(file_path),
+          content_type: 'application/octet-stream',
+          logger: logger
+        )
+      end
+    end
+  end
+end

data/lib/myob_acumatica/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MyobAcumatica
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 end

data/lib/myob_acumatica.rb

@@ -29,3 +29,4 @@ require_relative 'myob_acumatica/api/customer'
 require_relative 'myob_acumatica/api/invoice'
 require_relative 'myob_acumatica/api/payment'
 require_relative 'myob_acumatica/api/tax'
+require_relative 'myob_acumatica/api/currency'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: myob_acumatica
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Adam Mikulasev
@@ -153,6 +153,7 @@ files:
 - README.md
 - Rakefile
 - examples/app.rb
+- examples/currency.rb
 - examples/customer.rb
 - examples/dummy.pdf
 - examples/invoice.rb
@@ -160,6 +161,7 @@ files:
 - examples/tax.rb
 - lib/myob_acumatica.rb
 - lib/myob_acumatica/api.rb
+- lib/myob_acumatica/api/currency.rb
 - lib/myob_acumatica/api/customer.rb
 - lib/myob_acumatica/api/http.rb
 - lib/myob_acumatica/api/invoice.rb