qube_sync 0.3.0 → 0.4.0

data/lib/qube_sync/operations/inventory_site.rb

@@ -0,0 +1,214 @@
+# Generated from operations.json by bin/generate-operations: don't edit.
+# frozen_string_literal: true
+
+module QubeSync
+  module Operations
+    # QuickBooks inventory site operations, reached as `client.inventory_site`. Each queues a request and
+    # returns it (the response's `data`); the answer comes to `webhook_url`.
+    class InventorySite < Base
+      # Create inventory site: POST /connections/{connection_id}/inventory-sites
+      # (`inventory_site.create`).
+      #
+      # QuickBooks answers in one webhook.
+      #
+      # Params, sent as the JSON body:
+      # - `contact` (String): The name of a contact person for a customer or vendor.
+      # - `email` (String): E-mail address.
+      # - `fax` (String): Fax number.
+      # - `include_ret_element` (Array<one of "Contact", "EditSequence", "Email", "ExternalGUID",
+      #   "Fax", "IsActive", "IsDefaultSite", "ListID", "Name", "OwnerID", "ParentSiteRef", "Phone",
+      #   "SiteAddress", "SiteAddressBlock", "SiteDesc", "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 `full_name` remains distinct.
+      # - `parent_site_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 ParentRef 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`.
+      # - `phone` (String): The telephone number.
+      # - `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`.
+      # - `site_address` (Hash): This aggregate supports at most five address lines. You can provide
+      #   a structured address (Addr1-Addr3 plus City/State/`postal_code`/etc.) or use block mode
+      #   (Addr1-Addr5 only). Do not mix block mode with other address fields. In block mode, each
+      #   Addr line prints as its own line and is returned in ShipAddressBlock or BillAddressBlock.
+      #   - `addr1` (String): The first line of an address.
+      #   - `addr2` (String): The second line of an address (if a second line is needed).
+      #   - `addr3` (String): The third line of an address (if a third line is needed).
+      #   - `addr4` (String): The fourth line of an address (if a fourth line is needed).
+      #   - `addr5` (String): The fifth line of an address (if a fifth line is needed).
+      #   - `city` (String): The city name in an address.
+      #   - `country` (String): The country name in an address, or, in returned Host information
+      #     (HostRet or HostInfo), the country for which this edition of QuickBooks was designed.
+      #     (Possible values are US, CA, UK, and AU.)
+      #   - `postal_code` (String): The postal code in an address.
+      #   - `state` (String): The state name in an address.
+      # - `site_desc` (String): Description of the site.
+      #
+      # @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/inventory-sites/create-inventory-site
+      def create(connection_id, params = {}, webhook_url:, idempotency_key: nil)
+        queue("inventory_site.create", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
+      end
+
+      # List inventory sites: GET /connections/{connection_id}/inventory-sites
+      # (`inventory_site.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`,
+      #   `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`, `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`,
+      #   `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 "Contact", "EditSequence", "Email", "Fax", "IsActive",
+      #   "IsDefaultSite", "ListID", "Name", "ParentSiteRef", "Phone", "SiteAddress",
+      #   "SiteAddressBlock", "SiteDesc", "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`,
+      #   `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`,
+      #   `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`,
+      #   `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`,
+      #   `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/inventory-sites/list-inventory-sites
+      def query(connection_id, params = {}, webhook_url:, idempotency_key: nil)
+        queue("inventory_site.query", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
+      end
+
+      # Update inventory site: PUT /connections/{connection_id}/inventory-sites
+      # (`inventory_site.update`).
+      #
+      # QuickBooks answers in one webhook.
+      #
+      # Params, sent as the JSON body:
+      # - `contact` (String): The name of a contact person for a customer or vendor.
+      # - `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.
+      # - `email` (String): E-mail address.
+      # - `fax` (String): Fax number.
+      # - `include_ret_element` (Array<one of "Contact", "EditSequence", "Email", "ExternalGUID",
+      #   "Fax", "IsActive", "IsDefaultSite", "ListID", "Name", "OwnerID", "ParentSiteRef", "Phone",
+      #   "SiteAddress", "SiteAddressBlock", "SiteDesc", "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): 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 `full_name` remains distinct.
+      # - `parent_site_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 ParentRef 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`.
+      # - `phone` (String): The telephone number.
+      # - `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`.
+      # - `site_address` (Hash): This aggregate supports at most five address lines. You can provide
+      #   a structured address (Addr1-Addr3 plus City/State/`postal_code`/etc.) or use block mode
+      #   (Addr1-Addr5 only). Do not mix block mode with other address fields. In block mode, each
+      #   Addr line prints as its own line and is returned in ShipAddressBlock or BillAddressBlock.
+      #   - `addr1` (String): The first line of an address.
+      #   - `addr2` (String): The second line of an address (if a second line is needed).
+      #   - `addr3` (String): The third line of an address (if a third line is needed).
+      #   - `addr4` (String): The fourth line of an address (if a fourth line is needed).
+      #   - `addr5` (String): The fifth line of an address (if a fifth line is needed).
+      #   - `city` (String): The city name in an address.
+      #   - `country` (String): The country name in an address, or, in returned Host information
+      #     (HostRet or HostInfo), the country for which this edition of QuickBooks was designed.
+      #     (Possible values are US, CA, UK, and AU.)
+      #   - `postal_code` (String): The postal code in an address.
+      #   - `state` (String): The state name in an address.
+      # - `site_desc` (String): Description of the site.
+      #
+      # @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/inventory-sites/update-inventory-site
+      def update(connection_id, params = {}, webhook_url:, idempotency_key: nil)
+        queue("inventory_site.update", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
+      end
+    end
+  end
+end