jbr 3.13.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eff06d450e1e4c357e208ca25d49eec46229009623dac5fab0d2316784b10ddc
-  data.tar.gz: 85cd26058f5eec17b84f143e61c1d366f2ac7702d44d0cd8b6fb80694041f6d3
+  metadata.gz: a01ddd16fc41518ff9cc7d18b61bdc2c0d9e419959c01fc7dd822473de08bade
+  data.tar.gz: 3d60fe2c06fd056d0e61d83bca1e40ff6f61954994a061e858a60422b6546e12
 SHA512:
-  metadata.gz: 8cef0ee9b3d02ec476d890d6d34367d896e77ab374fa75f923d77fb6535415c3958c43aefea6ee7512e09606eb75cf92583c8c0ddf79e2ccf7d111b49a858af4
-  data.tar.gz: 1bdaf92404d72cf9ad5abaf26711e9cba47fa0054e1ab1e4b53114bfe0d157ed073959783ef8a23cdf101ac6ea95da798ca0e4723ffb06d907600b3857018aef
+  metadata.gz: 71b4e3faacce7acb0ea6d5a3eab5f1beea5f4534a416a16ed663d434299551b94375e3522f0152e6627a22340a7c098eaf464fdcec0012688fa07b0def98c9e8
+  data.tar.gz: 99828c97615dd6357dd58f167ec05338b6595cbcf5206cbad1088f9e3d3a95665f08698add77b3aeb854d4e10c9a664f8b77467ac064c680ecdd409bc763e96f

data/.rubocop.yml

@@ -57,3 +57,8 @@ Layout/LineLength:
 # lines per site, so the cop is declined and the rule held in review.
 Style/MethodCallWithArgsParentheses:
   Enabled: false
+
+# The vocabulary names a keyword for every platform, and one a platform has no field for is
+# taken and dropped rather than left out of the signature
+Lint/UnusedMethodArgument:
+  AllowUnusedKeywordArguments: true

data/CHANGELOG.md

@@ -1,3 +1,142 @@
+## [Unreleased]
+
+## [5.0.0] - 2026-09-15
+
+- [Feature] A scope the app was never granted no longer raises. Jobber answers `An object of
+  type User was hidden due to permissions` and hides the object rather than the query, so
+  whatever came back beside it is kept: `account.technicians` answers `[]`, and a week asked
+  for with `includes(:technicians)` answers the week with nobody on it. `Jbr.logger` takes the
+  line saying which type to tick the scope for -- standard error until an app points it
+  somewhere better. Jobber codes this refusal not at all, so the words are the only signal, and
+  only those words are carried on from: anything else raises, an empty list being a poor place
+  to hide a fault.
+
+- [Breaking change] `account.visits.find` is gone. A visit arrives from the walk carrying
+  everything it reads, so looking one up again was a request spent to learn nothing -- and it
+  answered a job's stop alone, quietly finding nothing for an assessment, an event or a task.
+  `Enumerable#find` is what the name means on a list of visits now.
+
+- [Feature] `visit.location`, where a stop is, through `includes(:location)`. Jobber hangs the
+  property off each kind of scheduled item rather than off what they share, so it is selected
+  inside the fragments; a caller reading a schedule no longer reaches through `visit.job` for an
+  address, which a stop booked against a lead never had.
+
+- [Fix] A window asks for unassigned work and not for unscheduled. `schedulingAspects: [ALL]`
+  means both, so a windowed list came back carrying requests nobody had booked -- no start, no
+  end, in no window. `includeUnassigned: true` with `includeUnscheduled: false` asks for exactly
+  the half that is booked, verified against an account holding plenty of each.
+
+- [Breaking change] An event or a task is a visit. They occupy a pro exactly as a job's stop does
+  and were being read past unread. Jobber's scheduled item has exactly four kinds -- visit,
+  assessment, event, task -- so nothing is filtered out now; a reminder is named by the filter's
+  enum but is not a scheduled item and cannot come back. `visit.job` and `visit.lead` are nil on
+  an event, and `visit.location` may be: Jobber gives an event a property, and not always.
+
+- [Breaking change] The vocabulary is `company` 2.1: a `Company::Selection` takes its rule as a
+  block, a visit answers a lead as well as a job, and it says where it is. The pin is `~> 2.1`.
+
+- [Feature] The README says which Developer Center object each reader needs ticked. Jobber
+  files a visit under Scheduled Items -- one object covering visits, assessments, tasks and
+  calendar events -- and there is no Visits scope of its own.
+
+- [Feature] `account.visits.create` books a stop to go and look at work nobody has priced. It
+  takes the words `leads.create` takes plus `starts_at:`, `ends_at:` and `technicians:`, opens
+  the client and the property where Jobber has none, and files all of it in the one
+  `requestCreate`: Jobber hangs the assessment off the request it opens with it. What comes
+  back is the assessment Jobber stored, naming the request as its lead. Jobber has no source
+  for a request, so `source:` is dropped, and `ends_at:` may be nil for a stop booked to a day.
+
+  A mocked booking refuses a bare `Time` the same way, so a suite cannot pass on one Jobber
+  would not take. `starts_at:` must know its zone. Jobber takes a date, a local time and the zone they are in,
+  not a moment in UTC, and a bare `Time` names an offset rather than a zone -- so one is
+  refused, with `Jbr::Error`, before a client is opened.
+
+- [Breaking change] `account.visits` is every stop booked, not only a job's. Jobber calls the
+  stop booked to look at work before there is a job an assessment and hangs it off the request,
+  so `visit.lead` answers that request and `visit.job` is nil there; `for_jobs` and `for_leads`
+  narrow to one kind, by Jobber rather than here. The list is read from `scheduledItems` rather
+  than `visits`, which has three consequences worth reading twice:
+
+  - **A schedule is read by the window.** `scheduledItems` takes a required `occursWithin`, so
+    `account.visits` with nothing narrowing it raises `Jbr::Error` where it used to walk every
+    visit there was.
+  - **An open end reaches a year.** `occursWithin` takes two moments and no nil, so
+    `upcoming` and `past` with no duration are bounded at a year rather than left open.
+  - **Unassigned work is in.** `scheduledItems` answers assigned work only unless told
+    otherwise, so `includeUnassigned: true` is always sent. A list that did not send it would
+    quietly drop every stop nobody is on yet.
+
+  `account.visits.find` still answers a stop of a job alone: Jobber files an assessment under a
+  lookup of its own and this gem does not reach for it. Events, tasks and reminders share the
+  list and are read past, Jobber's filter taking one kind and not two.
+
+- [Feature] `account.technicians` walks the account's users a page at a time, each a
+  `Jbr::Technician` reading `id`, `name` and `surname` off the `name` node Jobber answers a
+  user with. Reading one needs the Users scope, which an app granted before this
+  release does not have: Jobber refuses a query selecting a user outright rather than leaving
+  the field empty, so an app that asks for a technician re-authorizes first.
+
+- [Feature] `visit.technicians` is whoever a visit is booked for, and `includes(:technicians)`
+  is what asks for them -- nothing brings them back unbidden, for the scope above and because
+  Jobber prices them on every row that carries them.
+
+- [Feature] `account.visits.between(from, to).assigned_to(technician)` is one technician's
+  week. `VisitFilterAttributes` takes an `assignedTo`, so the technician joins the window in
+  the one filter Jobber is sent: nobody else's visits are answered, paged or paid for, and the
+  crew is not read unless `includes(:technicians)` asks, which means `assigned_to` needs no
+  Users scope. Both narrowings land in the same filter, so either order asks the same
+  thing. `Jbr.mock.technicians` mocks the crew, and a mocked visit takes a `technicians:` of
+  its own.
+
+## [4.0.0] - 2026-09-09
+
+- [Breaking change] `Jbr::Account` is the gateway, and reads in the vocabulary the `company` gem
+  names. It replaces `Jbr::OAuth` and the `Jbr.oauth_for`, `Jbr.create_oauth` and
+  `Jbr.oauth_url_for` entry points: `Jbr::Account.new credentials`, `Jbr::Account.create code:,
+  redirect_uri:`, `Jbr::Account.url_for redirect_uri:, state:`, and `Jbr::Account.client_secret`.
+  `#account` is `#business`, answering a `Company::Business` whose `phone` is the ten digits to
+  dial rather than the string Jobber holds
+- [Breaking change] `#requests` is `#leads`, and `leads.create` takes its keywords by name
+  as the vocabulary names them (`name:`, `surname:`, `phone:`, `email:`, `address:`,
+  `description:` for the title, `notes:` for the instructions, and a `source:` Jobber has no
+  field for) and
+  answers a `Jbr::Lead` with `id` and `customer` rather than the collection that filed it.
+  `Quote#request_id` is `#lead`, a `Jbr::Lead`; `Invoice#job_id` is `#job`, a `Jbr::Job`;
+  `Invoice#total`, `#issued_at` and `#completed_at` are `#amount`, a `BigDecimal`, and
+  `#fulfilled_at`, the moment the work was finished or the bill issued where the work never was
+- [Breaking change] A job reads `#amount` as a `BigDecimal` where it read `#total` as a Float,
+  answers the quote it was won with as `#quote` -- a `Jbr::Quote` with `id` and `amount`,
+  nil where there was none -- in place of `#quote_id` and `#quote_total`, its title as
+  `#description` and its instructions as `#notes`. `#summary` is gone with `#name`: a caller sums a job up from its lines and
+  its description. `Job#title`, `#status` and `#client`, `Visit#title`, `#name`, `#job_id`
+  and `#client`, are gone, and `Visit#client_confirmed?` is `#confirmed?`, `#all_day?` is `#anytime?`
+- [Breaking change] `includes` takes `:lines`, `:location` and `location: :customer` where it
+  took `:line_items`, `:property`, `:client` and `property: :client`, and only on jobs: a visit
+  happens where its job does, so it answers `#job` and no `#location` or `includes` of its own. A
+  job answers `#lines` and `#location`, and a location `#customer`. `Location#address` and `#state` are gone,
+  as are `Customer#first_name` and `#company_name`: `#name` answers the first name, or the
+  business's name where a person has none. `Jbr::LineItem`, `Jbr::Property`, `Jbr::Client` and
+  `Jbr::Request` are `Jbr::Line`, `Jbr::Location`, `Jbr::Customer` and `Jbr::Lead`
+- [Breaking change] `Jbr.mock` takes `business` and `lead` where it took `account` and `request`,
+  and every slot reads by the vocabulary's keys: `description`, `amount`, `quote`,
+  `lines`, `location`, `customer`, `confirmed`, `lead`, `job`. A mock collection
+  answers the vocabulary's own kinds built from those hashes, so `Jbr::Mock::Job` and its
+  siblings are gone; `Jbr.mock = nil` hands the accounts back to Jobber
+- [Breaking change] `Jbr::Retriable` is `Jbr::Throttled`, a `Company::Throttled` rather than a
+  `Jbr::Error`, so one rescue retries a refusal for rate from any platform; its `#cost`,
+  `#available`, `#maximum` and `#restore_rate` are gone and the numbers stay in the message.
+  `Jbr::Error` descends from `Company::Error`
+- [Fix] An `includes` chained after `past` or `upcoming` keeps the window it was asked on. It
+  used to rebuild the list without the filter, so `account.jobs.past(1.year).includes(:lines)`
+  walked every job the account ever had
+- [Fix] A mutation Jobber takes but will not act on raises `Jbr::Error` with the reasons Jobber
+  gave. It answers those with a 200 and the messages under the mutation's own `userErrors`,
+  which nothing read, so a client Jobber refused to open came back with a nil ID and the
+  request filed against nobody
+- [Change] Every selection Jobber is asked for is generated from the keys the vocabulary reads
+  wherever Jobber's shape is flat, so a kind gaining a reader asks for it without a query
+  written by hand
+
 ## [3.13.0] - 2026-08-31
 
 - [New] `Jbr::LineItem#id`, `#description` and `#amount`, beside the `#quantity` and `#name` a