nordlet 0.5.4 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f12fbedbc5b1f5390c549bd8922735902a0c2be2c8d9c82cb2e8ff2a2b1cb7ec
-  data.tar.gz: 344fc85edc1ffe11a51c771b54e20d507a8b9010afa0f01ac0db98ebdb22673c
+  metadata.gz: 4da069081b53c176214991ead94b15c5fcf480a48a3d72c3d40606c4130200f5
+  data.tar.gz: c2cedd7c56fd51ba38417e3d6591a3ff934e4ed71cbf05aab8cf5323dd890ea4
 SHA512:
-  metadata.gz: '0269cc9199ea5750f8c9899644cb08939f89949f206aac25888c2bcad97abd820fd16dc2f8e3ba1763a0709f1182e9109155854beaffda409c5f97052a00a4a8'
-  data.tar.gz: 679f30e8dedac9e4d417e2a7f835ca7eac7eaf12720c39c4e848c8adbd7430e8c90f41eb0923a51542b16894d19d490ea4c99c430811ec2bec89e57234b2391e
+  metadata.gz: 7989554b0f26778d0a8b3db0f8d959ed48d8dbf0735cf1c30f9dae58ad135beffd600691afc1e20c5f70698e45fe732db7a81a9f7f2cfdb70e589ec416990e3e
+  data.tar.gz: 10ba70415ab76e7d3e47d3ab8aef84d927ca58ecf36c8ec94c4c8e47ba7b34c07eabd3e39c98d0021f26fdef9dfa4f3bc469c911f2f9ff170e6a42d66dd1404f

data/lib/nordlet/account/client.rb

@@ -10,6 +10,12 @@ module Nordlet
         @client = client
       end
 
+      # Create a sign-in link for the e-mail address and send it; the link is valid for 15 minutes and is consumed with
+      # `account/login-link/consume`. When an unused link was requested for the same address within the last minute, the
+      # call answers `sent` without sending another. `locale` sets the language of the e-mail and of the link;
+      # `acceptTerms`, `acceptDpa` and `referralCode` are stored with the link and used when the address has no account
+      # yet.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Account::Types::LoginLinkRequestAccountRequest]
       # @option request_options [String] :base_url
@@ -42,6 +48,12 @@ module Nordlet
         end
       end
 
+      # Exchange a sign-in link token for a session; an unknown, used or expired token is refused with 401. When no
+      # account has the address, one is created (`isNewUser`), which is refused with 422 unless the link was requested
+      # with `acceptTerms` and `acceptDpa`; a `referralCode` on the link records who referred the new user. A link from
+      # `account/email/change-request` changes the signed-in user's address instead, refused with 409 when another
+      # account has it.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Account::Types::LoginLinkConsumeAccountRequest]
       # @option request_options [String] :base_url
@@ -74,6 +86,8 @@ module Nordlet
         end
       end
 
+      # Delete the session the call was made with.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Account::Types::LogoutAccountRequest]
       # @option request_options [String] :base_url
@@ -106,6 +120,11 @@ module Nordlet
         end
       end
 
+      # Return the signed-in user, their active company and role in it, the companies they belong to and their consent
+      # state. `billing` is the billing account that pays for the active company (its payer, or the user when there is
+      # none or no company), with `isPayer` saying whether that is the user; `referralPoints` is the user's current
+      # points balance.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Account::Types::MeAccountRequest]
       # @option request_options [String] :base_url
@@ -138,6 +157,8 @@ module Nordlet
         end
       end
 
+      # List the members of the active company with their role.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Account::Types::MembersListAccountRequest]
       # @option request_options [String] :base_url
@@ -170,6 +191,9 @@ module Nordlet
         end
       end
 
+      # Change the role of a member of the active company; owners and admins may call it. Refused with 422 for the
+      # caller's own role and with 403 for the owner's, which only `account/members/transfer-ownership` changes.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Account::Types::MembersSetRoleAccountRequest]
       # @option request_options [String] :base_url
@@ -202,6 +226,10 @@ module Nordlet
         end
       end
 
+      # Make another member the owner of the active company; the caller must be its owner and becomes an admin. Refused
+      # with 422 when `userId` is the caller. With `movePayer` the company's billing also moves to the new owner, which
+      # only the member currently paying for it may do (403).
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Account::Types::MembersTransferOwnershipAccountRequest]
       # @option request_options [String] :base_url
@@ -234,6 +262,10 @@ module Nordlet
         end
       end
 
+      # Remove a member from the active company; owners and admins may call it. Their sessions lose this company as the
+      # active one and the API keys they created for it are revoked. Refused with 422 for the caller themself and with
+      # 403 for the owner.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Account::Types::MembersRemoveAccountRequest]
       # @option request_options [String] :base_url
@@ -266,6 +298,10 @@ module Nordlet
         end
       end
 
+      # Create an invitation to the active company for an e-mail address with the given role and send it by e-mail in
+      # `locale`; owners and admins may call it. The invitation is valid for 7 days and replaces an earlier pending one
+      # for the same address. Refused with 409 when the address already belongs to a member.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Account::Types::InvitesCreateAccountRequest]
       # @option request_options [String] :base_url
@@ -298,6 +334,8 @@ module Nordlet
         end
       end
 
+      # List the pending invitations of the active company; `expired` marks those past their expiry.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Account::Types::InvitesListAccountRequest]
       # @option request_options [String] :base_url
@@ -330,6 +368,8 @@ module Nordlet
         end
       end
 
+      # Delete a pending invitation of the active company.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Account::Types::InvitesRevokeAccountRequest]
       # @option request_options [String] :base_url
@@ -362,6 +402,10 @@ module Nordlet
         end
       end
 
+      # Read a pending invitation by its token: the invited address, role and company name, whether it has expired and
+      # whether an account with that address already exists (`userExists`), in which case `account/invites/accept` must
+      # be called signed in as that account.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Account::Types::InvitesGetAccountRequest]
       # @option request_options [String] :base_url
@@ -394,6 +438,11 @@ module Nordlet
         end
       end
 
+      # Accept an invitation and return a session with the invited company active. When the address has no account, one
+      # is created with `name` and `locale`, which is refused with 422 unless `acceptTerms` and `acceptDpa` are true;
+      # when it has one, the call must be made signed in as that account (401 otherwise). An expired invitation is
+      # refused with 422.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Account::Types::InvitesAcceptAccountRequest]
       # @option request_options [String] :base_url
@@ -426,6 +475,9 @@ module Nordlet
         end
       end
 
+      # Set the user's language: with an active company it is stored on their membership of that company (`scope` =
+      # `membership`), otherwise on the user (`scope` = `user`).
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Account::Types::LocaleSetAccountRequest]
       # @option request_options [String] :base_url
@@ -458,6 +510,11 @@ module Nordlet
         end
       end
 
+      # Create a company with the caller as its owner and payer, seed its chart of accounts from the template of
+      # `countryCode`, and make it the active company of the session. `timeZone` defaults to the country's, `isVatPayer`
+      # to true and `defaultInvoiceCurrency` to the base currency. Refused with 422 when `baseCurrency` is not a
+      # supported currency.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Account::Types::CompaniesCreateAccountRequest]
       # @option request_options [String] :base_url
@@ -490,6 +547,9 @@ module Nordlet
         end
       end
 
+      # Make one of the caller's companies the active company of the session. Refused with 403 when the caller is not a
+      # member and with 422 when the company is archived or deleted.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Account::Types::CompaniesSelectAccountRequest]
       # @option request_options [String] :base_url
@@ -522,6 +582,8 @@ module Nordlet
         end
       end
 
+      # Return the profile of the active company.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Account::Types::CompaniesProfileAccountRequest]
       # @option request_options [String] :base_url
@@ -554,6 +616,10 @@ module Nordlet
         end
       end
 
+      # Change the profile of the active company; owners and admins may call it. Only the fields sent are changed, and
+      # the nullable ones can be sent as null to clear them. `logo` stores a base64-encoded image as a file of the
+      # company and sets `logoFileId`. The country, base currency and sandbox flag are fixed at creation.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Account::Types::CompaniesUpdateAccountRequest]
       # @option request_options [String] :base_url
@@ -586,6 +652,9 @@ module Nordlet
         end
       end
 
+      # Set the company named by `companyId` to `archived`; the caller must be its owner. Every session that had it
+      # active loses it. Refused with 409 unless the company is active; `account/companies/activate` reverses it.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Account::Types::CompaniesArchiveAccountRequest]
       # @option request_options [String] :base_url
@@ -618,6 +687,11 @@ module Nordlet
         end
       end
 
+      # Set the company named by `companyId` to `deleted`; the caller must be its owner, and every session that had it
+      # active loses it. A sandbox company is purged at once; any other is purged by the scheduled purge after
+      # `purgeAfter` (10 days) and can be restored until then with `account/companies/activate`. Refused with 409 when
+      # it is already deleted.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Account::Types::CompaniesDeleteAccountRequest]
       # @option request_options [String] :base_url
@@ -650,6 +724,9 @@ module Nordlet
         end
       end
 
+      # Set an archived or deleted company named by `companyId` back to `active`; the caller must be its owner. Refused
+      # with 409 when it is already active.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Account::Types::CompaniesActivateAccountRequest]
       # @option request_options [String] :base_url
@@ -682,6 +759,10 @@ module Nordlet
         end
       end
 
+      # Create an API key for the active company and return the key itself once; owners, admins and developers may call
+      # it. `scopes` defaults to the caller's own scopes and may not exceed them (403); without `expiresInDays` the key
+      # does not expire.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Account::Types::APIKeysCreateAccountRequest]
       # @option request_options [String] :base_url
@@ -714,6 +795,8 @@ module Nordlet
         end
       end
 
+      # List the API keys of the active company, including expired and revoked ones.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Account::Types::APIKeysListAccountRequest]
       # @option request_options [String] :base_url
@@ -746,6 +829,10 @@ module Nordlet
         end
       end
 
+      # Create a new key with the name and scopes of the key `id` and return it once; the old key keeps working for
+      # `overlapHours` and then expires, and its `replacedByKeyId` points to the new one. `expiresInDays` applies to the
+      # new key. Refused with 409 when the old key is revoked.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Account::Types::APIKeysRotateAccountRequest]
       # @option request_options [String] :base_url
@@ -778,6 +865,8 @@ module Nordlet
         end
       end
 
+      # Revoke an API key of the active company at once.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Account::Types::APIKeysRevokeAccountRequest]
       # @option request_options [String] :base_url
@@ -810,6 +899,9 @@ module Nordlet
         end
       end
 
+      # Record the signed-in user's acceptance of the current Terms of Service and Data Processing Agreement versions
+      # and return the consent state.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Account::Types::ConsentAcceptAccountRequest]
       # @option request_options [String] :base_url
@@ -842,6 +934,8 @@ module Nordlet
         end
       end
 
+      # Set the signed-in user's name; null or a blank string clears it.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Account::Types::ProfileUpdateAccountRequest]
       # @option request_options [String] :base_url
@@ -874,6 +968,11 @@ module Nordlet
         end
       end
 
+      # Send a confirmation link to `newEmail`; the address changes when that link is consumed with
+      # `account/login-link/consume`. When an unused link was sent to the address within the last minute, the call
+      # answers `sent` without sending another. Refused with 422 when it is already the user's address and with 409 when
+      # another account has it.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Account::Types::EmailChangeRequestAccountRequest]
       # @option request_options [String] :base_url
@@ -906,6 +1005,8 @@ module Nordlet
         end
       end
 
+      # List the signed-in user's sessions that have not expired; `current` marks the one the call was made with.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Account::Types::SessionsListAccountRequest]
       # @option request_options [String] :base_url
@@ -938,6 +1039,8 @@ module Nordlet
         end
       end
 
+      # Delete one of the signed-in user's sessions.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Account::Types::SessionsRevokeAccountRequest]
       # @option request_options [String] :base_url
@@ -970,6 +1073,9 @@ module Nordlet
         end
       end
 
+      # Delete every session of the signed-in user except the one the call was made with, and return how many were
+      # deleted.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Account::Types::SessionsRevokeOthersAccountRequest]
       # @option request_options [String] :base_url
@@ -1002,6 +1108,9 @@ module Nordlet
         end
       end
 
+      # Return the user's profile, consent state, memberships, unexpired sessions, billing account, credit transactions
+      # and the audit entries they made in their companies (the most recent 5000 of each of the last two).
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Account::Types::ExportAccountRequest]
       # @option request_options [String] :base_url
@@ -1070,6 +1179,10 @@ module Nordlet
         end
       end
 
+      # Return the user's referral code (allocated on first call) and sign-up link, their points balance, the number of
+      # accounts they referred and the last 50 points entries. `rates.perEur` is the points the referrer earns per euro
+      # a referred user tops up, `rates.pointCents` the credit one point converts to with `account/referral/convert`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Account::Types::ReferralGetAccountRequest]
       # @option request_options [String] :base_url
@@ -1102,6 +1215,10 @@ module Nordlet
         end
       end
 
+      # Convert `points` of the user's referral points into credit on their billing account at `rates.pointCents` per
+      # point, booked as an `adjustment` credit transaction; a billing account past its trial is set to active when the
+      # new balance allows. Refused with 422 when the user has fewer points than requested.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Account::Types::ReferralConvertAccountRequest]
       # @option request_options [String] :base_url
@@ -1134,6 +1251,9 @@ module Nordlet
         end
       end
 
+      # Return the signed-in user's saved column list and page size for the table `tableKey`; both are null when nothing
+      # is saved.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Account::Types::TableSettingsGetAccountRequest]
       # @option request_options [String] :base_url
@@ -1166,6 +1286,9 @@ module Nordlet
         end
       end
 
+      # Save the signed-in user's column list and page size for the table `tableKey`; only the fields sent are changed,
+      # and null clears one.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Account::Types::TableSettingsSetAccountRequest]
       # @option request_options [String] :base_url
@@ -1198,6 +1321,8 @@ module Nordlet
         end
       end
 
+      # List the signed-in user's saved table settings.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Account::Types::TableSettingsListAccountRequest]
       # @option request_options [String] :base_url

data/lib/nordlet/agreements/client.rb

@@ -10,6 +10,8 @@ module Nordlet
         @client = client
       end
 
+      # Return whether automatic agreement billing is switched on for the company.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Agreements::Types::SettingsGetAgreementsRequest]
       # @option request_options [String] :base_url
@@ -42,6 +44,9 @@ module Nordlet
         end
       end
 
+      # Switch automatic agreement billing on or off for the company. With it on, a scheduled job runs the same billing
+      # as `agreements/agreements/billing/run` for the company once a day.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Agreements::Types::SettingsUpdateAgreementsRequest]
       # @option request_options [String] :base_url
@@ -74,6 +79,9 @@ module Nordlet
         end
       end
 
+      # Create an agreement type with a `code` and a `name`. Answers 409 when the company already has a type with that
+      # code.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Agreements::Types::TypesCreateAgreementsRequest]
       # @option request_options [String] :base_url
@@ -106,6 +114,8 @@ module Nordlet
         end
       end
 
+      # List the company's agreement types. Filterable and sortable by `code` and `name`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Agreements::Types::TypesListAgreementsRequest]
       # @option request_options [String] :base_url
@@ -138,6 +148,11 @@ module Nordlet
         end
       end
 
+      # Create an agreement for exactly one party, a partner, an employee or a bank account, which must exist in the
+      # company (400 otherwise). Without `kind`, an employee agreement is `employment`, a bank account agreement is
+      # `bank` and a partner agreement is `other`; a `documentRef` (the `storageKey` of an uploaded file) attaches that
+      # file to the agreement. Answers 409 when the company already has an agreement with that `number`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Agreements::Types::AgreementsCreateAgreementsRequest]
       # @option request_options [String] :base_url
@@ -170,6 +185,8 @@ module Nordlet
         end
       end
 
+      # Return one agreement with its items.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Agreements::Types::AgreementsGetAgreementsRequest]
       # @option request_options [String] :base_url
@@ -202,6 +219,9 @@ module Nordlet
         end
       end
 
+      # Change the given fields of an agreement and return it with its items. The party, `number`, `startDate`,
+      # `currency` and items are not changed by this call.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Agreements::Types::AgreementsUpdateAgreementsRequest]
       # @option request_options [String] :base_url
@@ -234,6 +254,8 @@ module Nordlet
         end
       end
 
+      # Mark an agreement as deleted. It is no longer returned, changed or billed.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Agreements::Types::AgreementsDeleteAgreementsRequest]
       # @option request_options [String] :base_url
@@ -266,6 +288,10 @@ module Nordlet
         end
       end
 
+      # List the company's agreements without their items, each with `partnerName`. Filterable by `number`, `name`,
+      # `partnerId`, `employeeId`, `bankAccountId`, `kind`, `typeId`, `status`, `startDate`, `endDate` and `value`;
+      # sortable by `number`, `startDate` and `createdAt` (default `startDate` descending).
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Agreements::Types::AgreementsListAgreementsRequest]
       # @option request_options [String] :base_url
@@ -298,6 +324,15 @@ module Nordlet
         end
       end
 
+      # Create a draft sale invoice for the next unbilled period of an active agreement that has a partner and a
+      # `billingPeriod`. The period follows the monthly, quarterly or annual grid from `startDate`, continues after the
+      # last period already invoiced for the agreement, and is prorated by days when it starts late or is cut by
+      # `endDate`; an `autoRenew` agreement has its `endDate` moved forward by whole terms instead (`renewedEndDate`).
+      # The lines come from the agreement items, else one line of `value`, with revenue recognised ratably over the
+      # period. Answers 422 when the agreement is not active, has no partner, billing period, items or value, carries
+      # VAT while the company is not a VAT payer, is fully billed through its end date, or when the next period starts
+      # after `asOfDate` (default today). Emits `agreement.invoice_generated`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Agreements::Types::AgreementsGenerateInvoiceAgreementsRequest]
       # @option request_options [String] :base_url
@@ -330,6 +365,12 @@ module Nordlet
         end
       end
 
+      # Generate the invoices due up to `asOfDate` (default today) for every active agreement of the company that has a
+      # partner and a billing period, one invoice per period and at most 60 per agreement in one run, in the same way as
+      # `agreements/agreements/generate-invoice`. An agreement that is fully billed and whose `endDate` has passed is
+      # set to `expired`. A failing agreement is listed in `errors` and does not stop the run. Each invoice emits
+      # `agreement.invoice_generated`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Agreements::Types::AgreementsBillingRunAgreementsRequest]
       # @option request_options [String] :base_url
@@ -362,6 +403,9 @@ module Nordlet
         end
       end
 
+      # Create an insurance policy. Answers 422 when `toDate` is before `fromDate`, 400 when `insurerPartnerId` is not a
+      # partner of the company, and 409 when the company already has a policy with that `policyNumber`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Agreements::Types::InsurancePoliciesCreateAgreementsRequest]
       # @option request_options [String] :base_url
@@ -394,6 +438,9 @@ module Nordlet
         end
       end
 
+      # List the company's insurance policies. Filterable by `policyNumber`, `insurerPartnerId` and `toDate`; sortable
+      # by `policyNumber` and `toDate` (default `toDate` descending).
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Agreements::Types::InsurancePoliciesListAgreementsRequest]
       # @option request_options [String] :base_url
@@ -426,6 +473,8 @@ module Nordlet
         end
       end
 
+      # Mark an insurance policy as deleted.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Agreements::Types::InsurancePoliciesDeleteAgreementsRequest]
       # @option request_options [String] :base_url

data/lib/nordlet/assets/client.rb

@@ -10,6 +10,8 @@ module Nordlet
         @client = client
       end
 
+      # Return the company's fixed asset setting `autoDepreciation`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Assets::Types::SettingsGetAssetsRequest]
       # @option request_options [String] :base_url
@@ -42,6 +44,9 @@ module Nordlet
         end
       end
 
+      # Turn automatic depreciation on or off. When it is on, the scheduler posts the previous month's depreciation for
+      # the company once a day, as `assets/depreciation/post` does.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Assets::Types::SettingsUpdateAssetsRequest]
       # @option request_options [String] :base_url
@@ -74,6 +79,11 @@ module Nordlet
         end
       end
 
+      # Create an asset group: the asset, accumulated depreciation and depreciation expense accounts its assets are
+      # posted to, and an optional default useful life in months. `expenseAccountCode` defaults to the chart's
+      # depreciation expense account; each account must exist and be postable (422). A duplicate code is refused with
+      # 409.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Assets::Types::GroupsCreateAssetsRequest]
       # @option request_options [String] :base_url
@@ -106,6 +116,8 @@ module Nordlet
         end
       end
 
+      # List the asset groups; filterable and sortable by `code` and `name`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Assets::Types::GroupsListAssetsRequest]
       # @option request_options [String] :base_url
@@ -138,6 +150,11 @@ module Nordlet
         end
       end
 
+      # Register a fixed asset in a group with its acquisition date and cost, salvage value, useful life in months
+      # (defaults to the group's default; 422 when neither is set) and depreciation start date (defaults to the
+      # acquisition date). The salvage value must be below the acquisition cost (422); a duplicate code is refused with
+      # 409. Depreciation is posted with `assets/depreciation/post`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Assets::Types::AssetsCreateAssetsRequest]
       # @option request_options [String] :base_url
@@ -170,6 +187,10 @@ module Nordlet
         end
       end
 
+      # Change an asset that has no posted depreciation yet: group, code, name, dates, cost, salvage value, useful life,
+      # notes or documents. Refused with 409 once depreciation is posted or the asset is disposed, and with 422 when the
+      # salvage value would reach the acquisition cost; a duplicate code is 409.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Assets::Types::AssetsUpdateAssetsRequest]
       # @option request_options [String] :base_url
@@ -240,6 +261,9 @@ module Nordlet
         end
       end
 
+      # Return one fixed asset with its totals (cost including modernisations, accumulated depreciation, net book value,
+      # total life in months), its input VAT facts and its disposal.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Assets::Types::AssetsGetAssetsRequest]
       # @option request_options [String] :base_url
@@ -272,6 +296,9 @@ module Nordlet
         end
       end
 
+      # List the fixed assets; filterable by `code`, `name`, `groupId`, `status`, `acquisitionDate`, `acquisitionCost`
+      # and `accumulatedDepreciation`, sortable by `code`, `name`, `acquisitionDate` and `acquisitionCost`.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Assets::Types::AssetsListAssetsRequest]
       # @option request_options [String] :base_url
@@ -304,6 +331,11 @@ module Nordlet
         end
       end
 
+      # Record a modernisation of a fixed asset: `amount` is added to its cost and `addedLifeMonths` to its useful life
+      # from the month of `date` on, and the remaining depreciable value is spread over the months left. Refused with
+      # 422 when the asset is disposed or when no depreciation month would be left (give `addedLifeMonths` of at least
+      # 1); a fully depreciated asset becomes active again.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Assets::Types::AssetsModernizeAssetsRequest]
       # @option request_options [String] :base_url
@@ -373,6 +405,9 @@ module Nordlet
         end
       end
 
+      # Preview what `assets/depreciation/post` would post for a month: per active asset the amount and the months it
+      # covers, earlier unposted months included, and whether the month is already posted. Nothing is written.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Assets::Types::DepreciationPreviewAssetsRequest]
       # @option request_options [String] :base_url
@@ -405,6 +440,13 @@ module Nordlet
         end
       end
 
+      # Post the depreciation of a month: one journal entry dated the last day of the month that debits each group's
+      # expense account and credits its accumulated depreciation account, for every active asset whose depreciation has
+      # started, covering that month and any earlier month not yet posted. Each month's amount is the remaining
+      # depreciable value (cost plus modernisations less salvage value less accumulated depreciation) divided by the
+      # months left; an asset whose life or value is used up becomes `fully_depreciated`. Answers 409 when the period is
+      # locked, and `journalTransactionId` null when nothing is due.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Assets::Types::DepreciationPostAssetsRequest]
       # @option request_options [String] :base_url

data/lib/nordlet/audit/client.rb

@@ -10,6 +10,10 @@ module Nordlet
         @client = client
       end
 
+      # List the audit log of the company: who did what to which entity, with the recorded change in `diff`. Filterable
+      # by `action`, `entity`, `entityId`, `actorType` and `actorId`; sortable by `createdAt` and `id`, newest first by
+      # default.
+      #
       # @param request_options [Hash]
       # @param params [Nordlet::Audit::Types::ListAuditRequest]
       # @option request_options [String] :base_url