nordlet 0.5.3 → 0.5.5

data/lib/nordlet/calendar/client.rb

@@ -10,6 +10,12 @@ module Nordlet
         @client = client
       end
 
+      # Lists, in due-date order, the filing deadlines Nordlet derives for the company from its country and profile
+      # together with the company's own events, between `from` and `to` (default 45 days back to 120 days ahead of the
+      # company's current date). Each deadline carries its submissions, whether it can be filed with `calendar/submit`,
+      # amended, or built with `calendar/download`, and whether its automation is on; `includeDone: false` leaves out
+      # the rows that are completed, submitted or accepted.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Calendar::Types::ListCalendarRequest]
       # @option request_options [String] :base_url
@@ -42,6 +48,9 @@ module Nordlet
         end
       end
 
+      # Reads one calendar row by `key`: the id of a company event, or `ruleKey:period` for a filing deadline with its
+      # submissions.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Calendar::Types::GetCalendarRequest]
       # @option request_options [String] :base_url
@@ -144,6 +153,8 @@ module Nordlet
         end
       end
 
+      # Creates a company event (kind `custom`) with a title, a due date, notes and a done flag.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Calendar::Types::CreateCalendarRequest]
       # @option request_options [String] :base_url
@@ -176,6 +187,10 @@ module Nordlet
         end
       end
 
+      # Changes a calendar row by `key`. A company event takes a new title, due date, notes or done flag; a filing
+      # deadline (`ruleKey:period`) takes only notes and done, keeps its own title and date, and gets a stored row the
+      # first time it is annotated.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Calendar::Types::UpdateCalendarRequest]
       # @option request_options [String] :base_url
@@ -208,6 +223,9 @@ module Nordlet
         end
       end
 
+      # Deletes a company event by its id, or the stored notes and done mark of a filing deadline by `ruleKey:period`;
+      # the deadline itself still comes from the rules.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Calendar::Types::DeleteCalendarRequest]
       # @option request_options [String] :base_url

data/lib/nordlet/capture/client.rb

@@ -10,6 +10,10 @@ module Nordlet
         @client = client
       end
 
+      # Return the company's document capture settings: whether intake by e-mail is enabled, whether e-mailed documents
+      # are read on arrival, the company's intake e-mail address and whether a reading provider is configured. The
+      # intake token behind the address is created on the first call.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Capture::Types::SettingsGetCaptureRequest]
       # @option request_options [String] :base_url
@@ -42,6 +46,9 @@ module Nordlet
         end
       end
 
+      # Switch `intakeEnabled` (documents sent to the intake address are accepted) and `captureAutoExtract` (they are
+      # read on arrival) on or off; at least one field is required.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Capture::Types::SettingsUpdateCaptureRequest]
       # @option request_options [String] :base_url
@@ -74,6 +81,9 @@ module Nordlet
         end
       end
 
+      # Replace the company's intake token, so the previous intake e-mail address stops working and the settings come
+      # back with the new one.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Capture::Types::SettingsRegenerateIntakeCaptureRequest]
       # @option request_options [String] :base_url
@@ -106,6 +116,12 @@ module Nordlet
         end
       end
 
+      # Endpoint for the inbound e-mail provider (Postmark field names or the generic `to`, `from`, `subject` and
+      # `attachments` form). It needs the `x-inbound-secret` header and finds the company by the `intake+<token>@`
+      # recipient address (404 when unknown, 403 when intake is disabled). Every PDF, image, Word or PowerPoint
+      # attachment up to 10 MB becomes a `pending` capture (`accepted`), anything else is `skipped`; when the company
+      # has automatic reading on, is not on trial and a reading provider is configured, each capture is read at once.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Capture::Types::InboundEmailCaptureRequest]
       # @option request_options [String] :base_url
@@ -138,6 +154,12 @@ module Nordlet
         end
       end
 
+      # Upload a supplier document (PDF, image, Word or PowerPoint, up to 10 MB; 422 for any other type) as a capture
+      # and read it at once. The result holds the extracted supplier, dates, totals and lines, the partner matched by
+      # VAT code, then partner code, then name, the raw text, and `status` `extracted` or `failed` with `error`. Needs a
+      # configured reading provider, is refused with 402 for a company on trial until its first top-up, and counts every
+      # page read as `ocr_page` usage. The draft is reviewed and saved with `capture/documents/confirm`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Capture::Types::DocumentsUploadCaptureRequest]
       # @option request_options [String] :base_url
@@ -170,6 +192,10 @@ module Nordlet
         end
       end
 
+      # Read a stored capture again and replace its draft (supplier, totals, lines, matched partner). A capture received
+      # over Peppol is parsed from its document again without a reading provider; any other needs the provider and, for
+      # a company on trial, the first top-up (402). Refused with 409 once the capture is linked to a purchase invoice.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Capture::Types::DocumentsExtractCaptureRequest]
       # @option request_options [String] :base_url
@@ -202,6 +228,8 @@ module Nordlet
         end
       end
 
+      # Return one capture with its extraction and raw text.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Capture::Types::DocumentsGetCaptureRequest]
       # @option request_options [String] :base_url
@@ -234,6 +262,9 @@ module Nordlet
         end
       end
 
+      # List captures without raw text. Filterable by `status`, `matchedPartnerId` and `purchaseInvoiceId`; sortable by
+      # `createdAt` and `updatedAt`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Capture::Types::DocumentsListCaptureRequest]
       # @option request_options [String] :base_url
@@ -266,6 +297,8 @@ module Nordlet
         end
       end
 
+      # Delete a capture and its stored file (409 once it is linked to a purchase invoice).
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Capture::Types::DocumentsDeleteCaptureRequest]
       # @option request_options [String] :base_url

data/lib/nordlet/cash/client.rb

@@ -10,6 +10,18 @@ module Nordlet
         @client = client
       end
 
+      # Creates a numbered cash receipt (series `KPO`) or cash disbursement (`KIO`) and posts it in the base currency
+      # between the cash account (`cashAccountCode`, default the cash account of the company's chart) and
+      # `counterAccountCode`; a receipt debits the cash account, a disbursement credits it. Linked to an invoice -
+      # `saleInvoiceId` for a receipt against an issued invoice or advance invoice or a disbursement against an issued
+      # credit note, `purchaseInvoiceId` for a disbursement against a registered purchase invoice - the counter account
+      # is the receivable or payable account of the posting rules, the invoice's paid amount and payment status
+      # (`partial` or `paid`) are updated, and `sale_invoice.paid` or `purchase_invoice.paid` is emitted when the
+      # invoice becomes fully paid. Answers 422 when both invoice ids are given, a receipt names a purchase invoice,
+      # `counterAccountCode` differs from the invoice's account, or the invoice is in another currency or belongs to
+      # another partner; 409 when `amount` exceeds the invoice's remaining amount or the accounting period of `date` is
+      # locked.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Cash::Types::OrdersCreateCashRequest]
       # @option request_options [String] :base_url
@@ -42,6 +54,8 @@ module Nordlet
         end
       end
 
+      # Returns one cash order.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Cash::Types::OrdersGetCashRequest]
       # @option request_options [String] :base_url
@@ -74,6 +88,9 @@ module Nordlet
         end
       end
 
+      # Lists cash orders. Filterable by `type`, `date`, `partnerId`, `employeeId`, `fullNumber` and `amount`; sortable
+      # by `date`, `fullNumber`, `createdAt` and `amount`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Cash::Types::OrdersListCashRequest]
       # @option request_options [String] :base_url
@@ -106,6 +123,9 @@ module Nordlet
         end
       end
 
+      # Returns the balance of a cash account (default: the cash account of the company's chart) from the posted journal
+      # entries, up to and including `asOf` when given.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Cash::Types::BalanceCashRequest]
       # @option request_options [String] :base_url
@@ -138,6 +158,13 @@ module Nordlet
         end
       end
 
+      # Creates a numbered expense report (series `AA`) for the employee and posts it: each line's net amount is debited
+      # to its `accountCode` and the VAT total to the input VAT account of the posting rules
+      # (`purchases.vatReceivable`), or the gross amount to the line account when the company is not a VAT payer, and
+      # the total is credited to the cash advances account (`cash.advances`), which settles the employee's advance
+      # balance shown by `cash/advance-holders/balances`. Answers 422 when the total is zero or a line account is
+      # missing from the chart or not postable, and 409 when the accounting period of `date` is locked.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Cash::Types::ExpenseReportsCreateCashRequest]
       # @option request_options [String] :base_url
@@ -170,6 +197,8 @@ module Nordlet
         end
       end
 
+      # Returns one expense report with its lines.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Cash::Types::ExpenseReportsGetCashRequest]
       # @option request_options [String] :base_url
@@ -202,6 +231,9 @@ module Nordlet
         end
       end
 
+      # Lists expense reports without their lines. Filterable by `employeeId` and `date`; sortable by `date` and
+      # `number`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Cash::Types::ExpenseReportsListCashRequest]
       # @option request_options [String] :base_url
@@ -234,6 +266,10 @@ module Nordlet
         end
       end
 
+      # Returns, per employee, the cash advances issued to them (disbursements posted to the `cash.advances` account
+      # with the employee set), the amounts returned (receipts on the same account), the total settled by expense
+      # reports and the open balance (issued less returned less settled).
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Cash::Types::AdvanceHoldersBalancesCashRequest]
       # @option request_options [String] :base_url

data/lib/nordlet/catalog/client.rb

@@ -10,6 +10,13 @@ module Nordlet
         @client = client
       end
 
+      # Create a catalog item: a product, a service or a set of other items. `unit` must be `vnt`, a global measurement
+      # unit or one of the company's own units (`catalog/units/options`), the sale, purchase and expense account codes
+      # must be postable accounts of the chart, and `priceFrom`/`priceTo` and `validFrom`/`validTo` must be in order;
+      # otherwise 422. A `set` needs at least one component and none of them may be a set; `components` on any other
+      # type is refused with 422. 409 when an active item already carries the `code`. `documentRef` is the storage key
+      # of a file uploaded with `files/upload`, which is attached to the item. Emits `item.created`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Catalog::Types::ItemsCreateCatalogRequest]
       # @option request_options [String] :base_url
@@ -42,6 +49,8 @@ module Nordlet
         end
       end
 
+      # Return one item; a set comes with its components.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Catalog::Types::ItemsGetCatalogRequest]
       # @option request_options [String] :base_url
@@ -74,6 +83,12 @@ module Nordlet
         end
       end
 
+      # Change the fields of an item; the fields that are nullable in the request can be set to null to clear them. The
+      # checks of `catalog/items/create` apply. `components` replaces the whole component list and is accepted only when
+      # the item is or becomes a set (422); turning an item into a set needs components and is refused with 409 while
+      # the item is itself a component of another set. Turning a set into another type removes its components. 409 when
+      # an active item already carries the new `code`. Emits `item.updated`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Catalog::Types::ItemsUpdateCatalogRequest]
       # @option request_options [String] :base_url
@@ -106,6 +121,8 @@ module Nordlet
         end
       end
 
+      # Soft-delete an item. Refused with 409 while the item is a component of an active set. Emits `item.deleted`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Catalog::Types::ItemsDeleteCatalogRequest]
       # @option request_options [String] :base_url
@@ -138,6 +155,10 @@ module Nordlet
         end
       end
 
+      # List the active items. Filterable: name, code, barcode, type, vatClassifierCode, groupId, kindId, externalId,
+      # manufacturer, department. Sortable: name, code, createdAt, updatedAt, salePriceExclVat; default name ascending.
+      # Rows carry no components; `catalog/items/get` returns them.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Catalog::Types::ItemsListCatalogRequest]
       # @option request_options [String] :base_url
@@ -170,6 +191,8 @@ module Nordlet
         end
       end
 
+      # List the files attached to an item, newest first.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Catalog::Types::ItemsFilesListCatalogRequest]
       # @option request_options [String] :base_url
@@ -202,6 +225,9 @@ module Nordlet
         end
       end
 
+      # Create an item kind: a code, a name, the SAF-T item type, whether quantities are accounted for, and a sort
+      # order. 409 when the code already exists.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Catalog::Types::ItemsKindsCreateCatalogRequest]
       # @option request_options [String] :base_url
@@ -234,6 +260,8 @@ module Nordlet
         end
       end
 
+      # Change an item kind. 409 when the new code already exists.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Catalog::Types::ItemsKindsUpdateCatalogRequest]
       # @option request_options [String] :base_url
@@ -266,6 +294,9 @@ module Nordlet
         end
       end
 
+      # Delete an item kind. Refused with 409 while an active item uses it; soft-deleted items that still carry it are
+      # detached.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Catalog::Types::ItemsKindsDeleteCatalogRequest]
       # @option request_options [String] :base_url
@@ -298,6 +329,8 @@ module Nordlet
         end
       end
 
+      # List the company's item kinds in sort order, then by code.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Catalog::Types::ItemsKindsListCatalogRequest]
       # @option request_options [String] :base_url
@@ -330,6 +363,9 @@ module Nordlet
         end
       end
 
+      # Create a unit of measure of the company's own, in addition to the global measurement units
+      # (`reference/units/list`). 409 when the code already exists.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Catalog::Types::UnitsCreateCatalogRequest]
       # @option request_options [String] :base_url
@@ -362,6 +398,8 @@ module Nordlet
         end
       end
 
+      # Change the code, name or active flag of a company unit. 409 when the new code already exists.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Catalog::Types::UnitsUpdateCatalogRequest]
       # @option request_options [String] :base_url
@@ -394,6 +432,8 @@ module Nordlet
         end
       end
 
+      # Delete a company unit of measure.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Catalog::Types::UnitsDeleteCatalogRequest]
       # @option request_options [String] :base_url
@@ -426,6 +466,8 @@ module Nordlet
         end
       end
 
+      # List the company's own units of measure, ordered by code.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Catalog::Types::UnitsListCatalogRequest]
       # @option request_options [String] :base_url
@@ -458,6 +500,10 @@ module Nordlet
         end
       end
 
+      # Return the unit codes an item can use: the company's active own units first, then the global measurement units,
+      # named in the requested `locale` (Lithuanian for `lt`, English otherwise). A company unit hides a global unit
+      # with the same code.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Catalog::Types::UnitsOptionsCatalogRequest]
       # @option request_options [String] :base_url
@@ -490,6 +536,8 @@ module Nordlet
         end
       end
 
+      # Create an item group, optionally under `parentId`. 409 when the code already exists.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Catalog::Types::ItemGroupsCreateCatalogRequest]
       # @option request_options [String] :base_url
@@ -522,6 +570,9 @@ module Nordlet
         end
       end
 
+      # Change the code, name or parent of an item group; `parentId` null moves it to the top level. 422 when the new
+      # parent is the group itself or one of its descendants. 409 when the new code already exists.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Catalog::Types::ItemGroupsUpdateCatalogRequest]
       # @option request_options [String] :base_url
@@ -554,6 +605,8 @@ module Nordlet
         end
       end
 
+      # Delete an item group. Refused with 409 while it has child groups or active items assigned.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Catalog::Types::ItemGroupsDeleteCatalogRequest]
       # @option request_options [String] :base_url
@@ -586,6 +639,8 @@ module Nordlet
         end
       end
 
+      # List the company's item groups, ordered by code.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Catalog::Types::ItemGroupsListCatalogRequest]
       # @option request_options [String] :base_url
@@ -618,6 +673,10 @@ module Nordlet
         end
       end
 
+      # Create or replace the supplier record of an item for a partner (one per item and partner): supplier code,
+      # purchase price excluding VAT, currency (EUR when omitted) and notes. Fields omitted from the request are cleared
+      # on an existing record.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Catalog::Types::ItemsSuppliersUpsertCatalogRequest]
       # @option request_options [String] :base_url
@@ -650,6 +709,8 @@ module Nordlet
         end
       end
 
+      # List the supplier records, optionally for one `itemId` and/or `partnerId`, ordered by partner name.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Catalog::Types::ItemsSuppliersListCatalogRequest]
       # @option request_options [String] :base_url
@@ -682,6 +743,8 @@ module Nordlet
         end
       end
 
+      # Delete the supplier record of an item.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Catalog::Types::ItemsSuppliersDeleteCatalogRequest]
       # @option request_options [String] :base_url
@@ -714,6 +777,8 @@ module Nordlet
         end
       end
 
+      # Create a price list (currency EUR and active when omitted). 409 when the code already exists.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Catalog::Types::PriceListsCreateCatalogRequest]
       # @option request_options [String] :base_url
@@ -746,6 +811,8 @@ module Nordlet
         end
       end
 
+      # Change a price list. 409 when the new code already exists.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Catalog::Types::PriceListsUpdateCatalogRequest]
       # @option request_options [String] :base_url
@@ -778,6 +845,8 @@ module Nordlet
         end
       end
 
+      # List the company's price lists, ordered by code.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Catalog::Types::PriceListsListCatalogRequest]
       # @option request_options [String] :base_url
@@ -810,6 +879,10 @@ module Nordlet
         end
       end
 
+      # Set the unit price excluding VAT of up to 500 items on a price list; a price already on the list is replaced and
+      # the other items on the list are kept. 422 when an item appears twice in the request. Emits `price_list.updated`
+      # with the item ids.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Catalog::Types::PriceListsItemsSetCatalogRequest]
       # @option request_options [String] :base_url
@@ -842,6 +915,8 @@ module Nordlet
         end
       end
 
+      # List the prices of a price list with the item name and code, ordered by item name.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Catalog::Types::PriceListsItemsListCatalogRequest]
       # @option request_options [String] :base_url
@@ -874,6 +949,8 @@ module Nordlet
         end
       end
 
+      # Remove one item from a price list.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Catalog::Types::PriceListsItemsDeleteCatalogRequest]
       # @option request_options [String] :base_url

data/lib/nordlet/consolidation/client.rb

@@ -10,6 +10,9 @@ module Nordlet
         @client = client
       end
 
+      # Create a consolidation group owned by the calling company; `presentationCurrency` defaults to the company's base
+      # currency. Members are added with `consolidation/members/add`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Consolidation::Types::GroupsCreateConsolidationRequest]
       # @option request_options [String] :base_url
@@ -42,6 +45,8 @@ module Nordlet
         end
       end
 
+      # List the calling company's consolidation groups with their member counts.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Consolidation::Types::GroupsListConsolidationRequest]
       # @option request_options [String] :base_url
@@ -74,6 +79,8 @@ module Nordlet
         end
       end
 
+      # Return one consolidation group with its members, each with its ownership percentage and consolidation method.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Consolidation::Types::GroupsGetConsolidationRequest]
       # @option request_options [String] :base_url
@@ -106,6 +113,8 @@ module Nordlet
         end
       end
 
+      # Rename a consolidation group or change its presentation currency.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Consolidation::Types::GroupsUpdateConsolidationRequest]
       # @option request_options [String] :base_url
@@ -138,6 +147,8 @@ module Nordlet
         end
       end
 
+      # Delete a consolidation group.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Consolidation::Types::GroupsDeleteConsolidationRequest]
       # @option request_options [String] :base_url
@@ -170,6 +181,10 @@ module Nordlet
         end
       end
 
+      # Add a company to a consolidation group with its ownership percentage and method (`full`, `proportional` or
+      # `equity`), or change those of an existing member. Another company can be added only by a signed-in user who is
+      # owner, admin or accountant of it; an API key is refused with 403.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Consolidation::Types::MembersAddConsolidationRequest]
       # @option request_options [String] :base_url
@@ -202,6 +217,8 @@ module Nordlet
         end
       end
 
+      # Remove a company from a consolidation group.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Consolidation::Types::MembersRemoveConsolidationRequest]
       # @option request_options [String] :base_url
@@ -306,6 +323,9 @@ module Nordlet
         end
       end
 
+      # List the intercompany links of a group: which partner record of which member company stands for which other
+      # member company.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Consolidation::Types::IntercompanyLinksListConsolidationRequest]
       # @option request_options [String] :base_url
@@ -338,6 +358,8 @@ module Nordlet
         end
       end
 
+      # Remove an intercompany link from a group.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Consolidation::Types::IntercompanyLinksRemoveConsolidationRequest]
       # @option request_options [String] :base_url
@@ -406,6 +428,13 @@ module Nordlet
         end
       end
 
+      # Consolidated financial statements of a group for a period in its presentation currency, with the consolidated
+      # trial balance and cash flow, each member's contribution and the intercompany candidates. Each member's balances
+      # are translated at the group owner's exchange rates of `toDate` and taken in full, in proportion to the ownership
+      # (`proportional`) or as an equity-method investment (`equity`); a fully consolidated member held below 100 %
+      # yields the non-controlling interest, and `eliminations` are amounts added to account codes before the statements
+      # are assembled (`balanced` tells whether they net to zero). Refused with 422 when the group has no members.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Consolidation::Types::ReportConsolidationRequest]
       # @option request_options [String] :base_url