nordlet 0.5.3 → 0.5.5

data/lib/nordlet/ecommerce/client.rb

@@ -10,6 +10,12 @@ module Nordlet
         @client = client
       end
 
+      # Create a sales order from an online channel in status `new`. The customer is `partnerId` or `partner` details:
+      # with an `email` the existing partner with that e-mail is reused, otherwise a new partner is created; without
+      # either the call is refused with 422. `currency` defaults to the company's invoice currency, and
+      # `shipToCountryCode` and `marketplace` are kept for the VAT treatment of the invoice at fulfilment. A second
+      # order with the same `channel` and `externalRef` is refused with 409. Emits `sales_order.created`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Ecommerce::Types::OrdersCreateEcommerceRequest]
       # @option request_options [String] :base_url
@@ -42,6 +48,8 @@ module Nordlet
         end
       end
 
+      # Read one sales order with its lines.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Ecommerce::Types::OrdersGetEcommerceRequest]
       # @option request_options [String] :base_url
@@ -74,6 +82,9 @@ module Nordlet
         end
       end
 
+      # List sales orders without their lines. Filterable by `channel`, `externalRef`, `partnerId` and `status`;
+      # sortable by `createdAt`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Ecommerce::Types::OrdersListEcommerceRequest]
       # @option request_options [String] :base_url
@@ -106,6 +117,12 @@ module Nordlet
         end
       end
 
+      # Reserve stock for a `new` order in `warehouseId` (default: the order's warehouse; 422 when neither is set). Each
+      # product line, and each product component of a set line, is checked against the warehouse's on-hand quantity less
+      # the existing reservations; when any item is short the call is refused with 422 and nothing is reserved.
+      # Otherwise a reservation is written per stock line, `stock.changed` (change type `reserve`) is emitted for each,
+      # and the order becomes `reserved`. An order in another status is refused with 409.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Ecommerce::Types::OrdersReserveEcommerceRequest]
       # @option request_options [String] :base_url
@@ -138,6 +155,16 @@ module Nordlet
         end
       end
 
+      # Fulfil a `new` or `reserved` order: its reservations are released, the stock lines are consumed FIFO from the
+      # order's warehouse on `date` (default: the company's today), the cost of goods sold is posted as a journal entry
+      # debiting `cogsAccountCode` and crediting the stock accounts of the consumed layers (`inventoryAccountCode` when
+      # a layer has none), and a draft sale invoice for the order lines is created and linked as `invoiceId`, ready for
+      # `sales/invoices/issue`. With a `shipToCountryCode` on the order the invoice's VAT scheme is resolved for goods
+      # shipped there, as a marketplace sale when `marketplace` is set. Account codes default to the company's chart.
+      # Refused with 422 when the stock lines have no warehouse or stock is insufficient (unless the company allows
+      # negative stock), with 409 when the accounting period is locked or the order is already `fulfilled` or
+      # `cancelled`. Emits `sales_order.fulfilled` and `stock.changed`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Ecommerce::Types::OrdersFulfillEcommerceRequest]
       # @option request_options [String] :base_url
@@ -170,6 +197,9 @@ module Nordlet
         end
       end
 
+      # Cancel an order that is not fulfilled: its stock reservations are released, `stock.changed` (change type
+      # `release`) is emitted for each, and the status becomes `cancelled`. A fulfilled order is refused with 409.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Ecommerce::Types::OrdersCancelEcommerceRequest]
       # @option request_options [String] :base_url
@@ -202,6 +232,14 @@ module Nordlet
         end
       end
 
+      # List the company's items as a shop catalogue, in order of last update, with price and stock. `price` is the
+      # item's price in `priceListId` when given, else its own sale price, and `currency` that of the price list, else
+      # the company's invoice currency; `vatRatePercent` falls back to the rate of the item's VAT classifier. For a
+      # product `onHand`, `reserved` and `available` are summed over all warehouses or over `warehouseId` only; for a
+      # set `available` is the number of sets its product components can still make; for a service they are null. With
+      # `updatedSince` only items changed after that time are returned, deleted ones included (`deleted: true`), so a
+      # shop can sync incrementally; without it only live items are listed.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Ecommerce::Types::ProductsListEcommerceRequest]
       # @option request_options [String] :base_url
@@ -234,6 +272,9 @@ module Nordlet
         end
       end
 
+      # Stock position per item and warehouse: `onHand`, `reserved` and their difference `available`, for all warehouses
+      # or `warehouseId` only. Only items with a positive quantity on hand are returned.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Ecommerce::Types::StockListEcommerceRequest]
       # @option request_options [String] :base_url

data/lib/nordlet/files/client.rb

@@ -10,6 +10,9 @@ module Nordlet
         @client = client
       end
 
+      # Store a base64-encoded file of up to 10 MB (413 above that) under an `entity` and optional `entityId`, and
+      # return its record with the SHA-256 of the content and its `storageKey`, which other calls take as `documentRef`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Files::Types::UploadFilesRequest]
       # @option request_options [String] :base_url
@@ -42,6 +45,8 @@ module Nordlet
         end
       end
 
+      # Return a file record with its content, base64-encoded.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Files::Types::GetFilesRequest]
       # @option request_options [String] :base_url
@@ -74,6 +79,9 @@ module Nordlet
         end
       end
 
+      # List the company's files. Filterable by `entity`, `entityId` and `fileName`; sortable by `createdAt`, `fileName`
+      # and `sizeBytes`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Files::Types::ListFilesRequest]
       # @option request_options [String] :base_url
@@ -106,6 +114,8 @@ module Nordlet
         end
       end
 
+      # Delete a file record and its stored content.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Files::Types::DeleteFilesRequest]
       # @option request_options [String] :base_url

data/lib/nordlet/fleet/client.rb

@@ -10,6 +10,9 @@ module Nordlet
         @client = client
       end
 
+      # Register a vehicle. The plate number is stored in upper case and must be unique in the company (409 otherwise);
+      # `fixedAssetId` must name an existing fixed asset. Uploaded `documents` are attached to the vehicle.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Fleet::Types::VehiclesCreateFleetRequest]
       # @option request_options [String] :base_url
@@ -42,6 +45,9 @@ module Nordlet
         end
       end
 
+      # Change a vehicle's details or set its `status` to `active`, `sold` or `scrapped`; omitted fields keep their
+      # value. A plate number already used by another vehicle is refused with 409.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Fleet::Types::VehiclesUpdateFleetRequest]
       # @option request_options [String] :base_url
@@ -74,6 +80,8 @@ module Nordlet
         end
       end
 
+      # Read one vehicle with its current assignment, when an employee holds it today.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Fleet::Types::VehiclesGetFleetRequest]
       # @option request_options [String] :base_url
@@ -106,6 +114,9 @@ module Nordlet
         end
       end
 
+      # List vehicles with their current assignment. Filterable by `plateNumber`, `make`, `model` and `status`; sortable
+      # by `plateNumber`, `make` and `createdAt`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Fleet::Types::VehiclesListFleetRequest]
       # @option request_options [String] :base_url
@@ -138,6 +149,10 @@ module Nordlet
         end
       end
 
+      # Assign a vehicle to an employee from `fromDate`, open-ended or until `toDate`. A period that overlaps another
+      # assignment of the same vehicle is refused with 409, a `toDate` before `fromDate` with 422. `privateUse` makes
+      # the car a benefit in kind in `fleet/natura/preview`, and `employerPaysFuel` picks its rate.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Fleet::Types::AssignmentsCreateFleetRequest]
       # @option request_options [String] :base_url
@@ -170,6 +185,9 @@ module Nordlet
         end
       end
 
+      # End an open assignment on `toDate`. An assignment that already has an end date is refused with 409, a `toDate`
+      # before its `fromDate` with 422.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Fleet::Types::AssignmentsEndFleetRequest]
       # @option request_options [String] :base_url
@@ -202,6 +220,9 @@ module Nordlet
         end
       end
 
+      # List vehicle assignments with the plate number and the employee's name. Filterable by `vehicleId`, `employeeId`
+      # and `privateUse`; sortable by `fromDate` and `createdAt`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Fleet::Types::AssignmentsListFleetRequest]
       # @option request_options [String] :base_url
@@ -234,6 +255,11 @@ module Nordlet
         end
       end
 
+      # Preview the car benefit in kind of a month for a Lithuanian company: every assignment with `privateUse` that
+      # overlaps the month is valued at 0.75 % of the vehicle's market value when the employer pays the fuel, else 0.70
+      # %, one row per employee and vehicle, with the total. A company registered in another country is refused with
+      # 422. The same amounts are added to a payroll run created with `includeNatura` (`payroll/runs/create`).
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Fleet::Types::NaturaPreviewFleetRequest]
       # @option request_options [String] :base_url

data/lib/nordlet/hr/client.rb

@@ -10,6 +10,8 @@ module Nordlet
         @client = client
       end
 
+      # Creates a job position with an optional code and name translations, for use in `hr/contracts/create`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Hr::Types::PositionsCreateHrRequest]
       # @option request_options [String] :base_url
@@ -42,6 +44,8 @@ module Nordlet
         end
       end
 
+      # Changes the code, name or translations of a position; a null `translations` removes them.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Hr::Types::PositionsUpdateHrRequest]
       # @option request_options [String] :base_url
@@ -74,6 +78,8 @@ module Nordlet
         end
       end
 
+      # Lists the company's positions; filterable and sortable by `name` and `code`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Hr::Types::PositionsListHrRequest]
       # @option request_options [String] :base_url
@@ -106,6 +112,9 @@ module Nordlet
         end
       end
 
+      # Creates an employee record. `payrollOptions` holds the country-specific settings the payroll engine reads for
+      # the person (see `hr/employees/fields`); `applyAllowance` defaults to true and `pensionAccumulation` to false.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Hr::Types::EmployeesCreateHrRequest]
       # @option request_options [String] :base_url
@@ -138,6 +147,10 @@ module Nordlet
         end
       end
 
+      # Changes the given fields of an employee; a null clears the fields that allow it (code, personal code, birth
+      # date, contact details, address, IBAN, social insurance number and start, hire date, notes). `status` and
+      # `terminationDate` are set here too.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Hr::Types::EmployeesUpdateHrRequest]
       # @option request_options [String] :base_url
@@ -170,6 +183,8 @@ module Nordlet
         end
       end
 
+      # Reads one employee.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Hr::Types::EmployeesGetHrRequest]
       # @option request_options [String] :base_url
@@ -238,6 +253,9 @@ module Nordlet
         end
       end
 
+      # Lists the employees that are not deleted; filterable by `firstName`, `lastName`, `code`, `status` and `email`,
+      # sortable by `lastName`, `code` and `createdAt`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Hr::Types::EmployeesListHrRequest]
       # @option request_options [String] :base_url
@@ -270,6 +288,9 @@ module Nordlet
         end
       end
 
+      # Marks the employee deleted; the record stays and no longer appears in lists or payroll runs.
+      # `hr/employees/anonymize` also blanks the personal data.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Hr::Types::EmployeesDeleteHrRequest]
       # @option request_options [String] :base_url
@@ -338,6 +359,12 @@ module Nordlet
         end
       end
 
+      # Creates an employment contract for an employee. A `permanent` contract takes no `endDate` and a `fixed_term` one
+      # requires it; the number comes from `contractNo` or, with `agreementId`, from the employee's agreement;
+      # `workHours` defaults by `salaryType`. Answers 422 when the end date is before the start, and 409 when the
+      # employee already has a contract overlapping the period (end it with `hr/contracts/end` first) or the contract
+      # number already exists.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Hr::Types::ContractsCreateHrRequest]
       # @option request_options [String] :base_url
@@ -370,6 +397,9 @@ module Nordlet
         end
       end
 
+      # Ends a contract on `endDate` with an optional reason. Answers 422 when the end date is before the contract
+      # start.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Hr::Types::ContractsEndHrRequest]
       # @option request_options [String] :base_url
@@ -402,6 +432,9 @@ module Nordlet
         end
       end
 
+      # Lists employment contracts; filterable by `employeeId`, `agreementId`, `status` and `contractNo`, sortable by
+      # `startDate` and `contractNo`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Hr::Types::ContractsListHrRequest]
       # @option request_options [String] :base_url
@@ -434,6 +467,9 @@ module Nordlet
         end
       end
 
+      # Creates or replaces the leave entitlement of an employee for a year; `usedDays` is kept unless given (0 on a new
+      # row) and `remainingDays` is the entitled days less the used ones.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Hr::Types::LeaveBalancesSetHrRequest]
       # @option request_options [String] :base_url
@@ -466,6 +502,8 @@ module Nordlet
         end
       end
 
+      # Lists leave balances, narrowed to an employee and/or a year when given, oldest year first.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Hr::Types::LeaveBalancesListHrRequest]
       # @option request_options [String] :base_url
@@ -498,6 +536,9 @@ module Nordlet
         end
       end
 
+      # Records a sick-leave certificate of an employee. Answers 422 when `toDate` is before `fromDate`.
+      # `payroll/runs/create` warns when a certificate covers working days of a month that has no timesheet.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Hr::Types::IncapacityCertificatesCreateHrRequest]
       # @option request_options [String] :base_url
@@ -530,6 +571,8 @@ module Nordlet
         end
       end
 
+      # Lists incapacity certificates; filterable by `employeeId` and `number`, sortable by `fromDate` and `number`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Hr::Types::IncapacityCertificatesListHrRequest]
       # @option request_options [String] :base_url
@@ -562,6 +605,10 @@ module Nordlet
         end
       end
 
+      # Adds the company's daily per diem rate for a destination country from `validFrom`; `hr/business-trips/create`
+      # takes the latest rate valid on the trip's start date. Answers 409 when a rate for that country already starts on
+      # that date.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Hr::Types::PerDiemRatesCreateHrRequest]
       # @option request_options [String] :base_url
@@ -594,6 +641,8 @@ module Nordlet
         end
       end
 
+      # Lists per diem rates; filterable by `countryCode`, sortable by `countryCode` and `validFrom`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Hr::Types::PerDiemRatesListHrRequest]
       # @option request_options [String] :base_url
@@ -626,6 +675,8 @@ module Nordlet
         end
       end
 
+      # Deletes a per diem rate.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Hr::Types::PerDiemRatesDeleteHrRequest]
       # @option request_options [String] :base_url
@@ -658,6 +709,11 @@ module Nordlet
         end
       end
 
+      # Stores the trip as a draft with `days` counted as calendar days, both ends included, and `perDiemAmount` as the
+      # days times the company's rate for the destination valid on the start date (`hr/per-diem-rates/create`). Answers
+      # 422 when the trip ends before it starts or no rate covers the destination on that date, and 409 when the
+      # employee already has a trip overlapping the dates.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Hr::Types::BusinessTripsCreateHrRequest]
       # @option request_options [String] :base_url
@@ -690,6 +746,8 @@ module Nordlet
         end
       end
 
+      # Reads one business trip.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Hr::Types::BusinessTripsGetHrRequest]
       # @option request_options [String] :base_url
@@ -722,6 +780,8 @@ module Nordlet
         end
       end
 
+      # Lists business trips; filterable by `employeeId`, `status` and `payrollRunId`, sortable by `startDate`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Hr::Types::BusinessTripsListHrRequest]
       # @option request_options [String] :base_url
@@ -754,6 +814,10 @@ module Nordlet
         end
       end
 
+      # Sets the trip's status to `approved`. `payroll/runs/create` without explicit lines adds the per diem of every
+      # approved trip ending in the run month as an untaxed addition and sets the trip's `payrollRunId`; reversing or
+      # cancelling the run releases the trip again. Answers 409 when the trip is not a draft.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Hr::Types::BusinessTripsApproveHrRequest]
       # @option request_options [String] :base_url
@@ -786,6 +850,8 @@ module Nordlet
         end
       end
 
+      # Deletes a draft trip; answers 409 when the trip is not a draft.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Hr::Types::BusinessTripsDeleteHrRequest]
       # @option request_options [String] :base_url
@@ -818,6 +884,9 @@ module Nordlet
         end
       end
 
+      # Adds an education, qualification, certificate or training record to an employee, optionally linked to one of the
+      # company's uploaded files (`fileId`).
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Hr::Types::EmployeesRecordsCreateHrRequest]
       # @option request_options [String] :base_url
@@ -850,6 +919,8 @@ module Nordlet
         end
       end
 
+      # Changes the given fields of an employee record; `issuedAt`, `validUntil` and `fileId` can be cleared with null.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Hr::Types::EmployeesRecordsUpdateHrRequest]
       # @option request_options [String] :base_url
@@ -882,6 +953,8 @@ module Nordlet
         end
       end
 
+      # Deletes an employee record.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Hr::Types::EmployeesRecordsDeleteHrRequest]
       # @option request_options [String] :base_url
@@ -914,6 +987,8 @@ module Nordlet
         end
       end
 
+      # Lists employee records; filterable by `employeeId`, `type` and `title`, sortable by `createdAt` and `issuedAt`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Hr::Types::EmployeesRecordsListHrRequest]
       # @option request_options [String] :base_url
@@ -946,6 +1021,8 @@ module Nordlet
         end
       end
 
+      # Lists the files uploaded against an employee, newest first.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Hr::Types::EmployeesAttachmentsListHrRequest]
       # @option request_options [String] :base_url
@@ -978,6 +1055,11 @@ module Nordlet
         end
       end
 
+      # Builds the timesheet of the month for every employee with a contract in it, or for one employee with
+      # `employeeId`, replacing any existing timesheet: the Monday to Friday days within the contract get the contract's
+      # daily hours (its weekly hours over five), and for a Lithuanian company the public holidays are `holiday` days
+      # with 0 hours. Answers 422 when no contract covers the month.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Hr::Types::TimesheetsGenerateHrRequest]
       # @option request_options [String] :base_url
@@ -1010,6 +1092,11 @@ module Nordlet
         end
       end
 
+      # Creates or replaces the timesheet of an employee for a month from the given days; `workedDays` and `workedHours`
+      # count the `work` and `business_trip` days with hours. Answers 422 for a day outside the month, a day given twice
+      # or more than 24 hours in a day. `payroll/runs/create` reads the timesheet for the paid days, the days worked and
+      # the business-trip days of the month.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Hr::Types::TimesheetsUpsertHrRequest]
       # @option request_options [String] :base_url
@@ -1042,6 +1129,8 @@ module Nordlet
         end
       end
 
+      # Reads the timesheet of an employee for a month.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Hr::Types::TimesheetsGetHrRequest]
       # @option request_options [String] :base_url
@@ -1074,6 +1163,8 @@ module Nordlet
         end
       end
 
+      # Lists the timesheets of a month, ordered by employee name.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Hr::Types::TimesheetsListHrRequest]
       # @option request_options [String] :base_url
@@ -1106,6 +1197,8 @@ module Nordlet
         end
       end
 
+      # Deletes a timesheet.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Hr::Types::TimesheetsDeleteHrRequest]
       # @option request_options [String] :base_url