merge_ruby_client 1.0.0 → 2.0.0

data/lib/merge_ruby_client/accounting/income_statements/client.rb

@@ -89,6 +89,8 @@ module Merge
       #  should be comma separated without spaces.
       # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to
       #  produce these models.
+      # @param include_shell_data [Boolean] Whether to include shell records. Shell records are empty records (they may
+      #  contain some metadata but all other fields are null).
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Accounting::IncomeStatement]
       # @example
@@ -98,7 +100,7 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.accounting.income_statements.retrieve(id: "id")
-      def retrieve(id:, expand: nil, include_remote_data: nil, request_options: nil)
+      def retrieve(id:, expand: nil, include_remote_data: nil, include_shell_data: nil, request_options: nil)
         response = @request_client.conn.get do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
@@ -111,7 +113,8 @@ module Merge
           req.params = {
             **(request_options&.additional_query_parameters || {}),
             "expand": expand,
-            "include_remote_data": include_remote_data
+            "include_remote_data": include_remote_data,
+            "include_shell_data": include_shell_data
           }.compact
           unless request_options.nil? || request_options&.additional_body_parameters.nil?
             req.body = { **(request_options&.additional_body_parameters || {}) }.compact
@@ -205,6 +208,8 @@ module Merge
       #  should be comma separated without spaces.
       # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to
       #  produce these models.
+      # @param include_shell_data [Boolean] Whether to include shell records. Shell records are empty records (they may
+      #  contain some metadata but all other fields are null).
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Accounting::IncomeStatement]
       # @example
@@ -214,7 +219,7 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.accounting.income_statements.retrieve(id: "id")
-      def retrieve(id:, expand: nil, include_remote_data: nil, request_options: nil)
+      def retrieve(id:, expand: nil, include_remote_data: nil, include_shell_data: nil, request_options: nil)
         Async do
           response = @request_client.conn.get do |req|
             req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -228,7 +233,8 @@ module Merge
             req.params = {
               **(request_options&.additional_query_parameters || {}),
               "expand": expand,
-              "include_remote_data": include_remote_data
+              "include_remote_data": include_remote_data,
+              "include_shell_data": include_shell_data
             }.compact
             unless request_options.nil? || request_options&.additional_body_parameters.nil?
               req.body = { **(request_options&.additional_body_parameters || {}) }.compact

data/lib/merge_ruby_client/accounting/invoices/client.rb

@@ -58,15 +58,15 @@ module Merge
       #  values to be returned, instead of Merge's normalized enum values. [Learn
       #  e](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
       # @param status [Merge::Accounting::Invoices::InvoicesListRequestStatus] If provided, will only return Invoices with this status.
-      #  - `PAID` - PAID
-      #  - `DRAFT` - DRAFT
-      #  - `SUBMITTED` - SUBMITTED
-      #  - `PARTIALLY_PAID` - PARTIALLY_PAID
-      #  - `OPEN` - OPEN
-      #  - `VOID` - VOID
+      #  * `PAID` - PAID
+      #  * `DRAFT` - DRAFT
+      #  * `SUBMITTED` - SUBMITTED
+      #  * `PARTIALLY_PAID` - PARTIALLY_PAID
+      #  * `OPEN` - OPEN
+      #  * `VOID` - VOID
       # @param type [Merge::Accounting::Invoices::InvoicesListRequestType] If provided, will only return Invoices with this type.
-      #  - `ACCOUNTS_RECEIVABLE` - ACCOUNTS_RECEIVABLE
-      #  - `ACCOUNTS_PAYABLE` - ACCOUNTS_PAYABLE
+      #  * `ACCOUNTS_RECEIVABLE` - ACCOUNTS_RECEIVABLE
+      #  * `ACCOUNTS_PAYABLE` - ACCOUNTS_PAYABLE
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Accounting::PaginatedInvoiceList]
       # @example
@@ -120,8 +120,8 @@ module Merge
       end
 
       # Creates an `Invoice` object with the given values.
-      #  Including a `PurchaseOrder` id in the `purchase_orders` property will generate
-      #  an Accounts Payable Invoice from the specified Purchase Order(s).
+      #  Including a `PurchaseOrder` id in the `purchase_orders` property
+      #  will generate an Accounts Payable Invoice from the specified Purchase Order(s).
       #
       # @param is_debug_mode [Boolean] Whether to include debug fields (such as log file links) in the response.
       # @param run_async [Boolean] Whether or not third-party updates should be run asynchronously.
@@ -140,6 +140,7 @@ module Merge
       #   * :exchange_rate (String)
       #   * :total_discount (Float)
       #   * :sub_total (Float)
+      #   * :payment_term (Hash)
       #   * :total_tax_amount (Float)
       #   * :inclusive_of_tax (Boolean)
       #   * :total_amount (Float)
@@ -190,6 +191,8 @@ module Merge
       #  produce these models.
       # @param include_remote_fields [Boolean] Whether to include all remote fields, including fields that Merge did not map to
       #  common models, in a normalized format.
+      # @param include_shell_data [Boolean] Whether to include shell records. Shell records are empty records (they may
+      #  contain some metadata but all other fields are null).
       # @param remote_fields [String] Deprecated. Use show_enum_origins.
       # @param show_enum_origins [String] A comma separated list of enum field names for which you'd like the original
       #  values to be returned, instead of Merge's normalized enum values. [Learn
@@ -203,8 +206,8 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.accounting.invoices.retrieve(id: "id")
-      def retrieve(id:, expand: nil, include_remote_data: nil, include_remote_fields: nil, remote_fields: nil,
-                   show_enum_origins: nil, request_options: nil)
+      def retrieve(id:, expand: nil, include_remote_data: nil, include_remote_fields: nil, include_shell_data: nil,
+                   remote_fields: nil, show_enum_origins: nil, request_options: nil)
         response = @request_client.conn.get do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
@@ -219,6 +222,7 @@ module Merge
             "expand": expand,
             "include_remote_data": include_remote_data,
             "include_remote_fields": include_remote_fields,
+            "include_shell_data": include_shell_data,
             "remote_fields": remote_fields,
             "show_enum_origins": show_enum_origins
           }.compact
@@ -250,6 +254,7 @@ module Merge
       #   * :exchange_rate (String)
       #   * :total_discount (Float)
       #   * :sub_total (Float)
+      #   * :payment_term (Hash)
       #   * :total_tax_amount (Float)
       #   * :inclusive_of_tax (Boolean)
       #   * :total_amount (Float)
@@ -304,6 +309,7 @@ module Merge
       #  contain some metadata but all other fields are null).
       # @param is_common_model_field [Boolean] If provided, will only return remote field classes with this
       #  is_common_model_field value
+      # @param is_custom [Boolean] If provided, will only return remote fields classes with this is_custom value
       # @param page_size [Integer] Number of results to return per page.
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Accounting::PaginatedRemoteFieldClassList]
@@ -315,7 +321,7 @@ module Merge
       #  )
       #  api.accounting.invoices.line_items_remote_field_classes_list
       def line_items_remote_field_classes_list(cursor: nil, include_deleted_data: nil, include_remote_data: nil,
-                                               include_shell_data: nil, is_common_model_field: nil, page_size: nil, request_options: nil)
+                                               include_shell_data: nil, is_common_model_field: nil, is_custom: nil, page_size: nil, request_options: nil)
         response = @request_client.conn.get do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
@@ -332,6 +338,7 @@ module Merge
             "include_remote_data": include_remote_data,
             "include_shell_data": include_shell_data,
             "is_common_model_field": is_common_model_field,
+            "is_custom": is_custom,
             "page_size": page_size
           }.compact
           unless request_options.nil? || request_options&.additional_body_parameters.nil?
@@ -420,6 +427,7 @@ module Merge
       #  contain some metadata but all other fields are null).
       # @param is_common_model_field [Boolean] If provided, will only return remote field classes with this
       #  is_common_model_field value
+      # @param is_custom [Boolean] If provided, will only return remote fields classes with this is_custom value
       # @param page_size [Integer] Number of results to return per page.
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Accounting::PaginatedRemoteFieldClassList]
@@ -431,7 +439,7 @@ module Merge
       #  )
       #  api.accounting.invoices.remote_field_classes_list
       def remote_field_classes_list(cursor: nil, include_deleted_data: nil, include_remote_data: nil,
-                                    include_shell_data: nil, is_common_model_field: nil, page_size: nil, request_options: nil)
+                                    include_shell_data: nil, is_common_model_field: nil, is_custom: nil, page_size: nil, request_options: nil)
         response = @request_client.conn.get do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
@@ -448,6 +456,7 @@ module Merge
             "include_remote_data": include_remote_data,
             "include_shell_data": include_shell_data,
             "is_common_model_field": is_common_model_field,
+            "is_custom": is_custom,
             "page_size": page_size
           }.compact
           unless request_options.nil? || request_options&.additional_body_parameters.nil?
@@ -501,15 +510,15 @@ module Merge
       #  values to be returned, instead of Merge's normalized enum values. [Learn
       #  e](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
       # @param status [Merge::Accounting::Invoices::InvoicesListRequestStatus] If provided, will only return Invoices with this status.
-      #  - `PAID` - PAID
-      #  - `DRAFT` - DRAFT
-      #  - `SUBMITTED` - SUBMITTED
-      #  - `PARTIALLY_PAID` - PARTIALLY_PAID
-      #  - `OPEN` - OPEN
-      #  - `VOID` - VOID
+      #  * `PAID` - PAID
+      #  * `DRAFT` - DRAFT
+      #  * `SUBMITTED` - SUBMITTED
+      #  * `PARTIALLY_PAID` - PARTIALLY_PAID
+      #  * `OPEN` - OPEN
+      #  * `VOID` - VOID
       # @param type [Merge::Accounting::Invoices::InvoicesListRequestType] If provided, will only return Invoices with this type.
-      #  - `ACCOUNTS_RECEIVABLE` - ACCOUNTS_RECEIVABLE
-      #  - `ACCOUNTS_PAYABLE` - ACCOUNTS_PAYABLE
+      #  * `ACCOUNTS_RECEIVABLE` - ACCOUNTS_RECEIVABLE
+      #  * `ACCOUNTS_PAYABLE` - ACCOUNTS_PAYABLE
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Accounting::PaginatedInvoiceList]
       # @example
@@ -565,8 +574,8 @@ module Merge
       end
 
       # Creates an `Invoice` object with the given values.
-      #  Including a `PurchaseOrder` id in the `purchase_orders` property will generate
-      #  an Accounts Payable Invoice from the specified Purchase Order(s).
+      #  Including a `PurchaseOrder` id in the `purchase_orders` property
+      #  will generate an Accounts Payable Invoice from the specified Purchase Order(s).
       #
       # @param is_debug_mode [Boolean] Whether to include debug fields (such as log file links) in the response.
       # @param run_async [Boolean] Whether or not third-party updates should be run asynchronously.
@@ -585,6 +594,7 @@ module Merge
       #   * :exchange_rate (String)
       #   * :total_discount (Float)
       #   * :sub_total (Float)
+      #   * :payment_term (Hash)
       #   * :total_tax_amount (Float)
       #   * :inclusive_of_tax (Boolean)
       #   * :total_amount (Float)
@@ -637,6 +647,8 @@ module Merge
       #  produce these models.
       # @param include_remote_fields [Boolean] Whether to include all remote fields, including fields that Merge did not map to
       #  common models, in a normalized format.
+      # @param include_shell_data [Boolean] Whether to include shell records. Shell records are empty records (they may
+      #  contain some metadata but all other fields are null).
       # @param remote_fields [String] Deprecated. Use show_enum_origins.
       # @param show_enum_origins [String] A comma separated list of enum field names for which you'd like the original
       #  values to be returned, instead of Merge's normalized enum values. [Learn
@@ -650,8 +662,8 @@ module Merge
       #    api_key: "YOUR_AUTH_TOKEN"
       #  )
       #  api.accounting.invoices.retrieve(id: "id")
-      def retrieve(id:, expand: nil, include_remote_data: nil, include_remote_fields: nil, remote_fields: nil,
-                   show_enum_origins: nil, request_options: nil)
+      def retrieve(id:, expand: nil, include_remote_data: nil, include_remote_fields: nil, include_shell_data: nil,
+                   remote_fields: nil, show_enum_origins: nil, request_options: nil)
         Async do
           response = @request_client.conn.get do |req|
             req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -667,6 +679,7 @@ module Merge
               "expand": expand,
               "include_remote_data": include_remote_data,
               "include_remote_fields": include_remote_fields,
+              "include_shell_data": include_shell_data,
               "remote_fields": remote_fields,
               "show_enum_origins": show_enum_origins
             }.compact
@@ -699,6 +712,7 @@ module Merge
       #   * :exchange_rate (String)
       #   * :total_discount (Float)
       #   * :sub_total (Float)
+      #   * :payment_term (Hash)
       #   * :total_tax_amount (Float)
       #   * :inclusive_of_tax (Boolean)
       #   * :total_amount (Float)
@@ -755,6 +769,7 @@ module Merge
       #  contain some metadata but all other fields are null).
       # @param is_common_model_field [Boolean] If provided, will only return remote field classes with this
       #  is_common_model_field value
+      # @param is_custom [Boolean] If provided, will only return remote fields classes with this is_custom value
       # @param page_size [Integer] Number of results to return per page.
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Accounting::PaginatedRemoteFieldClassList]
@@ -766,7 +781,7 @@ module Merge
       #  )
       #  api.accounting.invoices.line_items_remote_field_classes_list
       def line_items_remote_field_classes_list(cursor: nil, include_deleted_data: nil, include_remote_data: nil,
-                                               include_shell_data: nil, is_common_model_field: nil, page_size: nil, request_options: nil)
+                                               include_shell_data: nil, is_common_model_field: nil, is_custom: nil, page_size: nil, request_options: nil)
         Async do
           response = @request_client.conn.get do |req|
             req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -784,6 +799,7 @@ module Merge
               "include_remote_data": include_remote_data,
               "include_shell_data": include_shell_data,
               "is_common_model_field": is_common_model_field,
+              "is_custom": is_custom,
               "page_size": page_size
             }.compact
             unless request_options.nil? || request_options&.additional_body_parameters.nil?
@@ -877,6 +893,7 @@ module Merge
       #  contain some metadata but all other fields are null).
       # @param is_common_model_field [Boolean] If provided, will only return remote field classes with this
       #  is_common_model_field value
+      # @param is_custom [Boolean] If provided, will only return remote fields classes with this is_custom value
       # @param page_size [Integer] Number of results to return per page.
       # @param request_options [Merge::RequestOptions]
       # @return [Merge::Accounting::PaginatedRemoteFieldClassList]
@@ -888,7 +905,7 @@ module Merge
       #  )
       #  api.accounting.invoices.remote_field_classes_list
       def remote_field_classes_list(cursor: nil, include_deleted_data: nil, include_remote_data: nil,
-                                    include_shell_data: nil, is_common_model_field: nil, page_size: nil, request_options: nil)
+                                    include_shell_data: nil, is_common_model_field: nil, is_custom: nil, page_size: nil, request_options: nil)
         Async do
           response = @request_client.conn.get do |req|
             req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -906,6 +923,7 @@ module Merge
               "include_remote_data": include_remote_data,
               "include_shell_data": include_shell_data,
               "is_common_model_field": is_common_model_field,
+              "is_custom": is_custom,
               "page_size": page_size
             }.compact
             unless request_options.nil? || request_options&.additional_body_parameters.nil?