qube_sync 0.3.0 → 0.4.0

data/lib/qube_sync/operations/class.rb

@@ -0,0 +1,176 @@
+# Generated from operations.json by bin/generate-operations: don't edit.
+# frozen_string_literal: true
+
+module QubeSync
+  module Operations
+    # QuickBooks class operations, reached as `client.class_`. Each queues a request and
+    # returns it (the response's `data`); the answer comes to `webhook_url`.
+    class Class_ < Base
+      # Create class: POST /connections/{connection_id}/classes (`class.create`).
+      #
+      # QuickBooks answers in one webhook.
+      #
+      # Params, sent as the JSON body:
+      # - `include_ret_element` (Array<one of "EditSequence", "ExternalGUID", "FullName",
+      #   "IsActive", "ListID", "Name", "OwnerID", "ParentRef", "Sublevel", "TimeCreated",
+      #   "TimeModified", "TxnID", "TxnNumber">)
+      # - `is_active` (Boolean): If `is_active` is true, this object is currently enabled for use by
+      #   QuickBooks. The default value is true.
+      # - `name` (String, required): The case-insensitive name of the class, not including the names
+      #   of its ancestors.
+      # - `parent_ref` (Hash): A reference to the list object that is one level above this one. For
+      #   example, an inventory item with the `full_name` of GermanCars:Mercedes-Benz:CL500I99AA
+      #   might have a parent object with the `full_name` of GermanCars:Mercedes-Benz. In a request,
+      #   if a `parent_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be
+      #   ignored.
+      #   - `full_name` (String): `full_name` (along with `list_id`) is a way to identify a list
+      #     object. The `full_name` is the name prefixed by the names of each ancestor, for example
+      #     Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive.
+      #   - `list_id` (String): `list_id` and `full_name` both identify a list object. QuickBooks
+      #     assigns `list_id` when the object is created. `list_id` values are unique within a list
+      #     type, not globally across all lists. If both `full_name` and `list_id` are supplied in a
+      #     request, QuickBooks uses `list_id` and ignores `full_name`.
+      # - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
+      #   `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
+      #   webhook already carries the request's `id`.
+      #
+      # @param connection_id [String]
+      # @param params [Hash] the fields above
+      # @param webhook_url [String] where QuBe Sync sends the answer
+      # @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
+      # @return [Hash] the queued request
+      # @see https://docs.qubesync.com/api-reference/v2/classes/create-class
+      def create(connection_id, params = {}, webhook_url:, idempotency_key: nil)
+        queue("class.create", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
+      end
+
+      # List classes: GET /connections/{connection_id}/classes (`class.query`).
+      #
+      # QuickBooks answers in one webhook.
+      #
+      # Params, sent as the query string:
+      # - `active_status` (one of "ActiveOnly", "All", "InactiveOnly"): Used in filters to select
+      #   list objects based on whether or not they are currently enabled for use by QuickBooks. The
+      #   default value is asActiveOnly, which selects only list objects that are active. Choose at
+      #   most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`,
+      #   `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set
+      #   combine with each other, not with the other choices.
+      # - `from_modified_date` (String): Filters results to objects modified on or after this
+      #   timestamp. QuickBooks Desktop accepts 1970-01-01 through 2038-01-19T03:14:07. If only a
+      #   date is provided, time defaults to 00:00:00. Choose at most one of: `list_id`, or
+      #   `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`,
+      #   `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with
+      #   each other, not with the other choices.
+      # - `full_name` (Array<String>): `full_name` (along with `list_id`) is a way to identify a
+      #   list object. The `full_name` is the name prefixed by the names of each ancestor, for
+      #   example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive. Choose at most
+      #   one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`,
+      #   `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set
+      #   combine with each other, not with the other choices.
+      # - `include_ret_element` (Array<one of "EditSequence", "FullName", "IsActive", "ListID",
+      #   "Name", "ParentRef", "Sublevel", "TimeCreated", "TimeModified">)
+      # - `list_id` (Array<String>): `list_id` and `full_name` both identify a list object.
+      #   QuickBooks assigns `list_id` when the object is created. `list_id` values are unique
+      #   within a list type, not globally across all lists. If both `full_name` and `list_id` are
+      #   supplied in a request, QuickBooks uses `list_id` and ignores `full_name`. Choose at most
+      #   one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`,
+      #   `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set
+      #   combine with each other, not with the other choices.
+      # - `max_returned` (Integer): Limits the number of objects that a query returns. (To get a
+      #   count of how many objects could possibly be returned, use the `meta_data` query
+      #   attribute.) If you include a `max_returned` value, it must be at least 1. QuickBooks
+      #   doesn't page this query: at most this many records come back, in one answer, with no sign
+      #   of whether more matched. Leave it out for every match, in one answer; one over 4 MB as the
+      #   Web Connector sends it, about 3 MB of qbXML isn't kept (`error_type`
+      #   `response_too_large`), so narrow a large one with its filters. Choose at most one of:
+      #   `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`,
+      #   `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set
+      #   combine with each other, not with the other choices.
+      # - `meta_data` (one of "MetaDataAndResponseData", "MetaDataOnly", "NoMetaData"): Use the
+      #   `meta_data` attribute to control whether query responses include counts. Options are
+      #   NoMetaData (default), MetaDataOnly (count only), and MetaDataAndResponseData (count plus
+      #   objects). Counts are approximate and may vary slightly if records are created or deleted
+      #   during processing.
+      # - `name_filter` (Hash): Filters according to the object’s Name. Choose at most one of:
+      #   `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`,
+      #   `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set
+      #   combine with each other, not with the other choices.
+      #   - `match_criterion` (one of "Contains", "EndsWith", "StartsWith", required): The criterion
+      #     to match.
+      #   - `name` (String, required): The string to match.
+      # - `name_range_filter` (Hash): Filters according to the object’s Name. Choose at most one of:
+      #   `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`,
+      #   `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set
+      #   combine with each other, not with the other choices.
+      #   - `from_name` (String): The first name or item in the search range. If `from_name` is
+      #     omitted, the range will begin with first name on the list.
+      #   - `to_name` (String): The final name or item in the search range. If `to_name` is omitted,
+      #     the range will end with last name on the list.
+      # - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
+      #   `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
+      #   webhook already carries the request's `id`.
+      # - `to_modified_date` (String): Filters results to objects modified on or before this
+      #   timestamp. QuickBooks Desktop accepts 1970-01-01 through 2038-01-19T03:14:07. If only a
+      #   date is provided, time defaults to end-of-day (23:59:59). Choose at most one of:
+      #   `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`,
+      #   `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set
+      #   combine with each other, not with the other choices.
+      #
+      # @param connection_id [String]
+      # @param params [Hash] the fields above
+      # @param webhook_url [String] where QuBe Sync sends the answer
+      # @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
+      # @return [Hash] the queued request
+      # @see https://docs.qubesync.com/api-reference/v2/classes/list-classes
+      def query(connection_id, params = {}, webhook_url:, idempotency_key: nil)
+        queue("class.query", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
+      end
+
+      # Update class: PUT /connections/{connection_id}/classes (`class.update`).
+      #
+      # QuickBooks answers in one webhook.
+      #
+      # Params, sent as the JSON body:
+      # - `edit_sequence` (String, required): `edit_sequence` is a server-generated revision token.
+      #   It changes each time the object is updated. To modify an existing object, you must send
+      #   the current `edit_sequence`. If your value is stale, the update is rejected to prevent
+      #   overwriting newer changes.
+      # - `include_ret_element` (Array<one of "EditSequence", "ExternalGUID", "FullName",
+      #   "IsActive", "ListID", "Name", "OwnerID", "ParentRef", "Sublevel", "TimeCreated",
+      #   "TimeModified", "TxnID", "TxnNumber">)
+      # - `is_active` (Boolean): If `is_active` is true, this object is currently enabled for use by
+      #   QuickBooks. The default value is true.
+      # - `list_id` (String, required): `list_id` and `full_name` both identify a list object.
+      #   QuickBooks assigns `list_id` when the object is created. `list_id` values are unique
+      #   within a list type, not globally across all lists. If both `full_name` and `list_id` are
+      #   supplied in a request, QuickBooks uses `list_id` and ignores `full_name`.
+      # - `name` (String): The case-insensitive name of the class, not including the names of its
+      #   ancestors.
+      # - `parent_ref` (Hash): A reference to the list object that is one level above this one. For
+      #   example, an inventory item with the `full_name` of GermanCars:Mercedes-Benz:CL500I99AA
+      #   might have a parent object with the `full_name` of GermanCars:Mercedes-Benz. In a request,
+      #   if a `parent_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be
+      #   ignored.
+      #   - `full_name` (String): `full_name` (along with `list_id`) is a way to identify a list
+      #     object. The `full_name` is the name prefixed by the names of each ancestor, for example
+      #     Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive.
+      #   - `list_id` (String): `list_id` and `full_name` both identify a list object. QuickBooks
+      #     assigns `list_id` when the object is created. `list_id` values are unique within a list
+      #     type, not globally across all lists. If both `full_name` and `list_id` are supplied in a
+      #     request, QuickBooks uses `list_id` and ignores `full_name`.
+      # - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
+      #   `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
+      #   webhook already carries the request's `id`.
+      #
+      # @param connection_id [String]
+      # @param params [Hash] the fields above
+      # @param webhook_url [String] where QuBe Sync sends the answer
+      # @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
+      # @return [Hash] the queued request
+      # @see https://docs.qubesync.com/api-reference/v2/classes/update-class
+      def update(connection_id, params = {}, webhook_url:, idempotency_key: nil)
+        queue("class.update", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
+      end
+    end
+  end
+end

data/lib/qube_sync/operations/cleared_status.rb

@@ -0,0 +1,39 @@
+# Generated from operations.json by bin/generate-operations: don't edit.
+# frozen_string_literal: true
+
+module QubeSync
+  module Operations
+    # QuickBooks cleared status operations, reached as `client.cleared_status`. Each queues a request and
+    # returns it (the response's `data`); the answer comes to `webhook_url`.
+    class ClearedStatus < Base
+      # Update cleared status: PUT /connections/{connection_id}/cleared-statuses
+      # (`cleared_status.update`).
+      #
+      # QuickBooks answers in one webhook.
+      #
+      # Params, sent as the JSON body:
+      # - `cleared_status` (one of "Cleared", "NotCleared", "Pending", required): Indicates whether
+      #   a transaction or transaction line has been cleared.
+      # - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
+      #   `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
+      #   webhook already carries the request's `id`.
+      # - `txn_id` (String, required): `txn_id` is the unique QuickBooks identifier for a
+      #   transaction. Use it to reference that transaction in later requests. `txn_id` values are
+      #   transaction-specific and should not be reused across unrelated transaction types.
+      # - `txn_line_id` (String): Identification number of the transaction line. (`txn_line_id` is
+      #   supported as of v2.0 of the SDK. With qbXML v1.0 and v1.1, `txn_line_id` is always
+      #   returned as zero.) G/p>If you need to add a new transaction line in a transaction Mod
+      #   request, you can do so by setting the `txn_line_id` to -1.
+      #
+      # @param connection_id [String]
+      # @param params [Hash] the fields above
+      # @param webhook_url [String] where QuBe Sync sends the answer
+      # @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
+      # @return [Hash] the queued request
+      # @see https://docs.qubesync.com/api-reference/v2/cleared-statuses/update-cleared-status
+      def update(connection_id, params = {}, webhook_url:, idempotency_key: nil)
+        queue("cleared_status.update", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
+      end
+    end
+  end
+end

data/lib/qube_sync/operations/company.rb

@@ -0,0 +1,39 @@
+# Generated from operations.json by bin/generate-operations: don't edit.
+# frozen_string_literal: true
+
+module QubeSync
+  module Operations
+    # QuickBooks company operations, reached as `client.company`. Each queues a request and
+    # returns it (the response's `data`); the answer comes to `webhook_url`.
+    class Company < Base
+      # List companies: GET /connections/{connection_id}/companies (`company.query`).
+      #
+      # QuickBooks answers in one webhook.
+      #
+      # Params, sent as the query string:
+      # - `include_ret_element` (Array<one of "AccountantCopy", "Address", "AddressBlock",
+      #   "CompanyAddressBlockForCustomer", "CompanyAddressForCustomer", "CompanyEmailForCustomer",
+      #   "CompanyName", "CompanyType", "CompanyWebSite", "DataExtRet", "EIN", "Email", "Fax",
+      #   "FirstMonthFiscalYear", "FirstMonthIncomeTaxYear", "IsSampleCompany", "LegalAddress",
+      #   "LegalCompanyName", "Phone", "SSN", "SubscribedServices", "TaxForm">)
+      # - `owner_id` (Array<String>): `owner_id` identifies who owns the data extension. Use 0 for
+      #   QuickBooks custom fields that appear in the UI, or use a GUID for private extensions owned
+      #   by an app. Keep private GUIDs confidential unless you intentionally share extensions
+      #   across apps. If you do share them, both apps must use the same `owner_id` and
+      #   `data_ext_name`, because that pair uniquely identifies the extension.
+      # - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
+      #   `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
+      #   webhook already carries the request's `id`.
+      #
+      # @param connection_id [String]
+      # @param params [Hash] the fields above
+      # @param webhook_url [String] where QuBe Sync sends the answer
+      # @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
+      # @return [Hash] the queued request
+      # @see https://docs.qubesync.com/api-reference/v2/companies/list-companies
+      def query(connection_id, params = {}, webhook_url:, idempotency_key: nil)
+        queue("company.query", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
+      end
+    end
+  end
+end

data/lib/qube_sync/operations/company_activity.rb

@@ -0,0 +1,31 @@
+# Generated from operations.json by bin/generate-operations: don't edit.
+# frozen_string_literal: true
+
+module QubeSync
+  module Operations
+    # QuickBooks company activity operations, reached as `client.company_activity`. Each queues a request and
+    # returns it (the response's `data`); the answer comes to `webhook_url`.
+    class CompanyActivity < Base
+      # List company activities: GET /connections/{connection_id}/company-activities
+      # (`company_activity.query`).
+      #
+      # QuickBooks answers in one webhook.
+      #
+      # Params, sent as the query string:
+      # - `include_ret_element` (Array<one of "LastCondenseTime", "LastRestoreTime">)
+      # - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
+      #   `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
+      #   webhook already carries the request's `id`.
+      #
+      # @param connection_id [String]
+      # @param params [Hash] the fields above
+      # @param webhook_url [String] where QuBe Sync sends the answer
+      # @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
+      # @return [Hash] the queued request
+      # @see https://docs.qubesync.com/api-reference/v2/company-activities/list-company-activities
+      def query(connection_id, params = {}, webhook_url:, idempotency_key: nil)
+        queue("company_activity.query", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
+      end
+    end
+  end
+end