qube_sync 0.3.0 → 0.4.0

data/lib/qube_sync/operations/data_ext_def.rb

@@ -0,0 +1,179 @@
+# Generated from operations.json by bin/generate-operations: don't edit.
+# frozen_string_literal: true
+
+module QubeSync
+  module Operations
+    # QuickBooks data ext def operations, reached as `client.data_ext_def`. Each queues a request and
+    # returns it (the response's `data`); the answer comes to `webhook_url`.
+    class DataExtDef < Base
+      # Create data ext def: POST /connections/{connection_id}/data-ext-defs
+      # (`data_ext_def.create`).
+      #
+      # QuickBooks answers in one webhook.
+      #
+      # Params, sent as the JSON body:
+      # - `assign_to_object` (Array<one of "ARRefundCreditCard", "Account", "Bill",
+      #   "BillPaymentCheck", "BillPaymentCreditCard", "BuildAssembly", "Charge", "Check",
+      #   "Company", "CreditCardCharge", "CreditCardCredit", "CreditMemo", "Customer", "Deposit",
+      #   "Employee", "Estimate", "InventoryAdjustment", "Invoice", "Item", "ItemReceipt",
+      #   "JournalEntry", "OtherName", "PurchaseOrder", "ReceivePayment", "SalesOrder",
+      #   "SalesReceipt", "SalesTaxPaymentCheck", "Vendor", "VendorCredit">)
+      # - `data_ext_format_string` (String): The string format required for the data extension.
+      # - `data_ext_list_require` (Boolean): If `data_ext_list_require` is true, this data extension
+      #   field is required to be entered in lists. The default value is false.
+      # - `data_ext_name` (String, required): The name of the data extension. If this is a custom
+      #   field, `data_ext_name` will be visible as a label in the QuickBooks user interface. Also
+      #   because `owner_id` and `data_ext_name` together make the data extension unique, and
+      #   because custom fields all have the same `owner_id` of zero, the `data_ext_name` must be a
+      #   unique value among existing custom fields.
+      # - `data_ext_txn_require` (Boolean): If `data_ext_txn_require` is true, this data extension
+      #   field is required to be entered in transaction. The default value is false.
+      # - `data_ext_type` (one of "AMTTYPE", "DATETIMETYPE", "INTTYPE", "PERCENTTYPE", "PRICETYPE",
+      #   "QUANTYPE", "STR1024TYPE", "STR255TYPE", required): The field’s data type, which
+      #   corresponds to a qbXML data type. In an IDataExtDefAdd request object, if this is a custom
+      #   field, `data_ext_type` must be detSTR255TYPE.
+      # - `include_ret_element` (Array<one of "AssignToObject", "DataExtFormatString", "DataExtID",
+      #   "DataExtListRequire", "DataExtName", "DataExtTxnRequire", "DataExtType", "EditSequence",
+      #   "ExternalGUID", "ListID", "OwnerID", "TxnID", "TxnNumber">)
+      # - `owner_id` (String, required): `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/data-ext-defs/create-data-ext-def
+      def create(connection_id, params = {}, webhook_url:, idempotency_key: nil)
+        queue("data_ext_def.create", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
+      end
+
+      # Delete data ext def: DELETE /connections/{connection_id}/data-ext-defs
+      # (`data_ext_def.delete`).
+      #
+      # QuickBooks answers in one webhook.
+      #
+      # Params, sent as the JSON body:
+      # - `data_ext_name` (String, required): The name of the data extension. If this is a custom
+      #   field, `data_ext_name` will be visible as a label in the QuickBooks user interface. Also
+      #   because `owner_id` and `data_ext_name` together make the data extension unique, and
+      #   because custom fields all have the same `owner_id` of zero, the `data_ext_name` must be a
+      #   unique value among existing custom fields.
+      # - `owner_id` (String, required): `owner_id` identifies the extension owner. `owner_id` 0
+      #   means a public custom field visible in the QuickBooks UI. A GUID means a private app
+      #   extension that is not shown in the UI. `owner_id` matching is case-insensitive. To share
+      #   private extensions across apps, both apps must use the same `owner_id` and
+      #   `data_ext_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/data-ext-defs/delete-data-ext-def
+      def delete(connection_id, params = {}, webhook_url:, idempotency_key: nil)
+        queue("data_ext_def.delete", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
+      end
+
+      # List data ext defs: GET /connections/{connection_id}/data-ext-defs (`data_ext_def.query`).
+      #
+      # QuickBooks answers in one webhook.
+      #
+      # Params, sent as the query string:
+      # - `assign_to_object` (Array<one of "ARRefundCreditCard", "Account", "Bill",
+      #   "BillPaymentCheck", "BillPaymentCreditCard", "BuildAssembly", "Charge", "Check",
+      #   "Company", "CreditCardCharge", "CreditCardCredit", "CreditMemo", "Customer", "Deposit",
+      #   "Employee", "Estimate", "InventoryAdjustment", "Invoice", "Item", "ItemReceipt",
+      #   "JournalEntry", "OtherName", "PurchaseOrder", "ReceivePayment", "SalesOrder",
+      #   "SalesReceipt", "SalesTaxPaymentCheck", "Vendor", "VendorCredit">): Choose at most one of:
+      #   `owner_id`, or `assign_to_object`.
+      # - `include_ret_element` (Array<one of "AssignToObject", "DataExtFormatString", "DataExtID",
+      #   "DataExtListRequire", "DataExtName", "DataExtTxnRequire", "DataExtType", "OwnerID">)
+      # - `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.
+      # - `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. Choose at most one
+      #   of: `owner_id`, or `assign_to_object`.
+      # - `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/data-ext-defs/list-data-ext-defs
+      def query(connection_id, params = {}, webhook_url:, idempotency_key: nil)
+        queue("data_ext_def.query", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
+      end
+
+      # Update data ext def: PUT /connections/{connection_id}/data-ext-defs (`data_ext_def.update`).
+      #
+      # QuickBooks answers in one webhook.
+      #
+      # Params, sent as the JSON body:
+      # - `assign_to_object` (Array<one of "ARRefundCreditCard", "Account", "Bill",
+      #   "BillPaymentCheck", "BillPaymentCreditCard", "BuildAssembly", "Charge", "Check",
+      #   "Company", "CreditCardCharge", "CreditCardCredit", "CreditMemo", "Customer", "Deposit",
+      #   "Employee", "Estimate", "InventoryAdjustment", "Invoice", "Item", "ItemReceipt",
+      #   "JournalEntry", "OtherName", "PurchaseOrder", "ReceivePayment", "SalesOrder",
+      #   "SalesReceipt", "SalesTaxPaymentCheck", "Vendor", "VendorCredit">)
+      # - `data_ext_format_string` (String): The string format required for the data extension.
+      # - `data_ext_list_require` (Boolean): If `data_ext_list_require` is true, this data extension
+      #   field is required to be entered in lists. The default value is false.
+      # - `data_ext_name` (String, required): The name of the data extension. If this is a custom
+      #   field, `data_ext_name` will be visible as a label in the QuickBooks user interface. Also
+      #   because `owner_id` and `data_ext_name` together make the data extension unique, and
+      #   because custom fields all have the same `owner_id` of zero, the `data_ext_name` must be a
+      #   unique value among existing custom fields.
+      # - `data_ext_new_name` (String): The new name for this field. Note that in the case of custom
+      #   fields, `data_ext_new_name` can run into name conflicts, because the name space of custom
+      #   fields (data extensions with an `owner_id` of 0) is shared by all applications.
+      # - `data_ext_txn_require` (Boolean): If `data_ext_txn_require` is true, this data extension
+      #   field is required to be entered in transaction. The default value is false.
+      # - `include_ret_element` (Array<one of "AssignToObject", "DataExtFormatString", "DataExtID",
+      #   "DataExtListRequire", "DataExtName", "DataExtTxnRequire", "DataExtType", "EditSequence",
+      #   "ExternalGUID", "ListID", "OwnerID", "TxnID", "TxnNumber">)
+      # - `owner_id` (String, required): `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.
+      # - `remove_from_object` (Array<one of "ARRefundCreditCard", "Account", "Bill",
+      #   "BillPaymentCheck", "BillPaymentCreditCard", "BuildAssembly", "Charge", "Check",
+      #   "Company", "CreditCardCharge", "CreditCardCredit", "CreditMemo", "Customer", "Deposit",
+      #   "Employee", "Estimate", "InventoryAdjustment", "Invoice", "Item", "ItemReceipt",
+      #   "JournalEntry", "OtherName", "PurchaseOrder", "ReceivePayment", "SalesOrder",
+      #   "SalesReceipt", "SalesTaxPaymentCheck", "Vendor", "VendorCredit">)
+      # - `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/data-ext-defs/update-data-ext-def
+      def update(connection_id, params = {}, webhook_url:, idempotency_key: nil)
+        queue("data_ext_def.update", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
+      end
+    end
+  end
+end

data/lib/qube_sync/operations/date_driven_terms.rb

@@ -0,0 +1,131 @@
+# Generated from operations.json by bin/generate-operations: don't edit.
+# frozen_string_literal: true
+
+module QubeSync
+  module Operations
+    # QuickBooks date driven terms operations, reached as `client.date_driven_terms`. Each queues a request and
+    # returns it (the response's `data`); the answer comes to `webhook_url`.
+    class DateDrivenTerms < Base
+      # Create date driven terms: POST /connections/{connection_id}/date-driven-terms
+      # (`date_driven_terms.create`).
+      #
+      # QuickBooks answers in one webhook.
+      #
+      # Params, sent as the JSON body:
+      # - `day_of_month_due` (Integer, required): The day of the month when full payment is due with
+      #   no discount.
+      # - `discount_day_of_month` (Integer): If the payment is made by this day of the month, then
+      #   `discount_pct` applies.
+      # - `discount_pct` (Numeric): If payment is received by `discount_day_of_month`, then this
+      #   discount will apply to the payment. `discount_pct` must be between 0 and 100.
+      # - `due_next_month_days` (Integer): Handles cases when an invoice or bill is issued close to
+      #   its due date. If the invoice or bill is issued within this many days of the due date,
+      #   payment isn’t due until the following month. For example, with a `day_of_month_due` of 15
+      #   and a `due_next_month_days` of 2, an invoice issued on May 13th wouldn’t be due until June
+      #   15th.
+      # - `include_ret_element` (Array<one of "DayOfMonthDue", "DiscountDayOfMonth", "DiscountPct",
+      #   "DueNextMonthDays", "EditSequence", "ExternalGUID", "IsActive", "ListID", "Name",
+      #   "OwnerID", "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): Name is the case-insensitive short name of a list object
+      #   (without ancestors). It must be unique within its hierarchy scope. Hierarchical lists can
+      #   reuse the same Name in different branches because FullName remains distinct.
+      # - `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/date-driven-terms/create-date-driven-terms
+      def create(connection_id, params = {}, webhook_url:, idempotency_key: nil)
+        queue("date_driven_terms.create", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
+      end
+
+      # List date driven terms: GET /connections/{connection_id}/date-driven-terms
+      # (`date_driven_terms.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>): 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 "DayOfMonthDue", "DiscountDayOfMonth", "DiscountPct",
+      #   "DueNextMonthDays", "EditSequence", "IsActive", "ListID", "Name", "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/date-driven-terms/list-date-driven-terms
+      def query(connection_id, params = {}, webhook_url:, idempotency_key: nil)
+        queue("date_driven_terms.query", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
+      end
+    end
+  end
+end