qube_sync 0.3.0 → 0.4.0

data/lib/qube_sync/operations/employee_default.rb

@@ -0,0 +1,100 @@
+# Generated from operations.json by bin/generate-operations: don't edit.
+# frozen_string_literal: true
+
+module QubeSync
+  module Operations
+    # QuickBooks employee default operations, reached as `client.employee_default`. Each queues a request and
+    # returns it (the response's `data`); the answer comes to `webhook_url`.
+    class EmployeeDefault < Base
+      # List employee defaults: GET /connections/{connection_id}/employee-defaults
+      # (`employee_default.query`).
+      #
+      # QuickBooks answers in one webhook.
+      #
+      # Params, sent as the query string:
+      # - `include_ret_element` (Array<one of "EmployeeDefaultPayrollInfo">)
+      # - `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/employee-defaults/list-employee-defaults
+      def query(connection_id, params = {}, webhook_url:, idempotency_key: nil)
+        queue("employee_default.query", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
+      end
+
+      # Update employee default: PUT /connections/{connection_id}/employee-defaults
+      # (`employee_default.update`).
+      #
+      # QuickBooks answers in one webhook.
+      #
+      # Params, sent as the JSON body:
+      # - `employee_default_payroll_info_mod` (Hash)
+      #   - `class_ref` (Hash)
+      #     - `full_name` (String)
+      #     - `list_id` (String)
+      #   - `clear_earnings` (Boolean): Choose at most one of: `clear_earnings`, or `earnings`.
+      #   - `clear_non_earnings` (Boolean): Choose at most one of: `clear_non_earnings`, or
+      #     `non_earnings`.
+      #   - `earnings` (Array<Hash>): Choose at most one of: `clear_earnings`, or `earnings`.
+      #     - `payroll_item_wage_ref` (Hash, required)
+      #       - `full_name` (String)
+      #       - `list_id` (String)
+      #     - `rate` (Numeric): Choose at most one of: `rate`, or `rate_percent`.
+      #     - `rate_percent` (Numeric): Choose at most one of: `rate`, or `rate_percent`.
+      #   - `employee_tax_info` (Hash)
+      #     - `employee_tax` (Array<Hash>)
+      #       - `is_subject_to_tax` (Boolean)
+      #       - `payroll_item_tax_ref` (Hash, required)
+      #         - `full_name` (String)
+      #         - `list_id` (String)
+      #       - `tax_info` (Array<Hash>)
+      #         - `tax_info_category` (String, required)
+      #         - `tax_info_value` (String, required)
+      #       - `tax_law_version` (Integer)
+      #     - `is_standard_taxation_required` (Boolean)
+      #     - `state_lived` (String)
+      #     - `state_worked` (String)
+      #   - `is_covered_by_qualified_pension_plan` (Boolean)
+      #   - `non_earnings` (Array<Hash>): Choose at most one of: `clear_non_earnings`, or
+      #     `non_earnings`.
+      #     - `amount` (Numeric): Choose at most one of: `amount`, or `rate_percent`.
+      #     - `limit` (Numeric)
+      #     - `payroll_item_non_wage_ref` (Hash, required)
+      #       - `full_name` (String)
+      #       - `list_id` (String)
+      #     - `rate_percent` (Numeric): Choose at most one of: `amount`, or `rate_percent`.
+      #   - `pay_period` (one of "Biweekly", "Daily", "Monthly", "Quarterly", "Semimonthly",
+      #     "Weekly", "Yearly")
+      #   - `sick_hours_default` (Hash)
+      #     - `accrual_period` (one of "BeginningOfYear", "EveryHourOnPaycheck", "EveryPaycheck")
+      #     - `hours_accrued` (String)
+      #     - `is_resetting_hours_each_new_year` (Boolean)
+      #     - `maximum_hours` (String)
+      #   - `use_time_data_to_create_paychecks` (one of "DoNotUseTimeData", "NotSet", "UseTimeData")
+      #   - `vacation_hours_default` (Hash)
+      #     - `accrual_period` (one of "BeginningOfYear", "EveryHourOnPaycheck", "EveryPaycheck")
+      #     - `hours_accrued` (String)
+      #     - `is_resetting_hours_each_new_year` (Boolean)
+      #     - `maximum_hours` (String)
+      # - `include_ret_element` (Array<one of "EmployeeDefaultPayrollInfo">)
+      # - `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/employee-defaults/update-employee-default
+      def update(connection_id, params = {}, webhook_url:, idempotency_key: nil)
+        queue("employee_default.update", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
+      end
+    end
+  end
+end

data/lib/qube_sync/operations/entity.rb

@@ -0,0 +1,118 @@
+# Generated from operations.json by bin/generate-operations: don't edit.
+# frozen_string_literal: true
+
+module QubeSync
+  module Operations
+    # QuickBooks entity operations, reached as `client.entity`. Each queues a request and
+    # returns it (the response's `data`); the answer comes to `webhook_url`.
+    class Entity < Base
+      # List entities: GET /connections/{connection_id}/entities (`entity.query`).
+      #
+      # QuickBooks answers in pages: one webhook per page, each with its `page`, the last with
+      # `iteration_state` `done`.
+      #
+      # 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 "AccountNumber", "AdditionalContactRef",
+      #   "AdditionalNotesRet", "AdjustedServiceDate", "AltContact", "AltPhone", "Balance",
+      #   "BillAddress", "BillAddressBlock", "BillingRateRef", "BirthDate", "Cc", "ClassRef",
+      #   "CompanyName", "Contact", "ContactsRet", "CreditCardInfo", "CreditLimit", "CurrencyRef",
+      #   "CustomerTypeRef", "DataExtRet", "DeliveryMethod", "Department", "Description",
+      #   "DisabilityDesc", "Disabled", "EditSequence", "Email", "EmergencyContacts",
+      #   "EmployeeAddress", "EmployeePayrollInfo", "EmployeeType", "Ethnicity", "Exempt",
+      #   "ExternalGUID", "Fax", "FirstName", "FullName", "Gender", "HiredDate", "IsActive",
+      #   "IsSalesTaxAgency", "IsStatementWithParent", "IsTaxAgency", "IsTaxOnTax",
+      #   "IsTaxTrackedOnPurchases", "IsTaxTrackedOnSales", "IsVendorEligibleFor1099",
+      #   "ItemSalesTaxRef", "JobDesc", "JobEndDate", "JobProjectedEndDate", "JobStartDate",
+      #   "JobStatus", "JobTitle", "JobTypeRef", "KeyEmployee", "LastName", "ListID", "MiddleName",
+      #   "MilitaryStatus", "Mobile", "Name", "NameOnCheck", "Notes", "OnFile", "OriginalHireDate",
+      #   "OtherNameAddress", "OtherNameAddressBlock", "Pager", "PagerPIN", "ParentRef",
+      #   "PartOrFullTime", "Phone", "PreferredDeliveryMethod", "PreferredPaymentMethodRef",
+      #   "PrefillAccountRef", "PriceLevelRef", "PrintAs", "ReleasedDate", "ReportingPeriod",
+      #   "ResaleNumber", "SSN", "SalesRepRef", "SalesTaxCodeRef", "SalesTaxCountry",
+      #   "SalesTaxReturnRef", "Salutation", "ShipAddress", "ShipAddressBlock", "ShipToAddress",
+      #   "Sublevel", "Suffix", "SupervisorRef", "TargetBonus", "TaxOnPurchasesAccountRef",
+      #   "TaxOnSalesAccountRef", "TaxRegistrationNumber", "TermsRef", "TimeCreated",
+      #   "TimeModified", "TotalBalance", "USCitizen", "USVeteran", "VendorAddress",
+      #   "VendorAddressBlock", "VendorTaxIdent", "VendorTypeRef", "WorkAuthExpireDate">)
+      # - `iterator` (Boolean): Page through every match: QuBe Sync asks QuickBooks for each page in
+      #   turn and sends each to your `webhook_url` as it arrives, all with the same `id`. On by
+      #   default, with pages of 100 records; send `iterator=true` with `max_returned` for another
+      #   size. Off when you send `iterator=false` (every match in one answer) or `max_returned`
+      #   alone (at most that many, in one answer). It pages a filtered query only: with `full_name`
+      #   or `list_id` every match comes back in one answer, so leave `iterator` out.
+      # - `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. The page size,
+      #   with `iterator=true`. Sent without `iterator`, or with `iterator=false`, it's a cap
+      #   instead: at most this many records come back, in one answer, and QuickBooks doesn't say
+      #   whether more matched. 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/entities/list-entities
+      def query(connection_id, params = {}, webhook_url:, idempotency_key: nil)
+        queue("entity.query", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
+      end
+    end
+  end
+end