pike13 0.1.2 → 0.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +16 -0
- data/README.md +24 -3
- data/lib/pike13/api/v2/desk/custom_field.rb +0 -5
- data/lib/pike13/api/v2/desk/event.rb +2 -2
- data/lib/pike13/api/v2/desk/person.rb +2 -2
- data/lib/pike13/api/v2/desk/visit.rb +0 -5
- data/lib/pike13/api/v2/front/event.rb +2 -2
- data/lib/pike13/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 4ecda21167ab9648a9c5cc963c84b109fec1de1b72f6501e479a6121be976866
|
|
4
|
+
data.tar.gz: 6f26de3022a6186ecb1c2c6d10a3f8b2276b9fe2aa9ef112cc1b0b2972ae6d93
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: a9cb41a2cbc57602bb5bb18ad352eacd783f117c721502675350059e98fb790b3da72f07e8ad3d5fc80f247cb7da8feaaffb160ae64f9bf0dc755126f7ff522d
|
|
7
|
+
data.tar.gz: dec61801a5cdc486f5e467b1978719132d467961d41638020fd658def9347dfcd4c2f34a1c0cfad1c7fd941fd63765a2b697ecd397bba5a837ec87d394f477d7
|
data/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,22 @@ All notable changes to this project will be documented in this file.
|
|
|
5
5
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
6
6
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
7
|
|
|
8
|
+
## [0.1.4] - 2025-11-18
|
|
9
|
+
|
|
10
|
+
### Added
|
|
11
|
+
- **Enhanced Event and People list methods**: Added support for query parameters in `all` methods
|
|
12
|
+
- `Pike13::Desk::Event.all(**params)` now accepts `from`, `to`, `ids`, `service_ids` parameters
|
|
13
|
+
- `Pike13::Desk::Person.all(**params)` now accepts `created_since`, `updated_since`, `is_member`, `include_relationships`, `include_balances`, `sort` parameters
|
|
14
|
+
- `Pike13::Front::Event.all(**params)` now accepts `from`, `to`, `ids`, `service_ids` parameters
|
|
15
|
+
|
|
16
|
+
### Fixed
|
|
17
|
+
- **Desk::Visit**: Removed non-existent `all` method that referenced an unsupported `/desk/visits` list endpoint. The Pike13 API v2 only supports individual visit operations via find, create, update, and destroy methods.
|
|
18
|
+
|
|
19
|
+
## [0.1.3] - 2025-11-13
|
|
20
|
+
|
|
21
|
+
### Fixed
|
|
22
|
+
- **Desk::CustomField**: Removed unsupported `find(id)` method that was not supported by the Pike13 API v2.
|
|
23
|
+
|
|
8
24
|
## [0.1.2] - 2025-11-06
|
|
9
25
|
|
|
10
26
|
### Fixed
|
data/README.md
CHANGED
|
@@ -117,6 +117,8 @@ Full staff interface with read/write access to all resources.
|
|
|
117
117
|
|
|
118
118
|
```ruby
|
|
119
119
|
Pike13::Desk::Person.all # List all people
|
|
120
|
+
Pike13::Desk::Person.all(is_member: true, include_balances: true) # Filter with parameters
|
|
121
|
+
Pike13::Desk::Person.all(created_since: "2024-01-01", sort: "-updated_at") # Date and sorting
|
|
120
122
|
Pike13::Desk::Person.find(123) # Find a person
|
|
121
123
|
Pike13::Desk::Person.me # Get authenticated user
|
|
122
124
|
Pike13::Desk::Person.search("john") # Search people
|
|
@@ -130,12 +132,17 @@ Pike13::Desk::Person.destroy(123)
|
|
|
130
132
|
```ruby
|
|
131
133
|
# Get business details
|
|
132
134
|
Pike13::Desk::Business.find
|
|
135
|
+
|
|
136
|
+
# Get franchisees (for franchise businesses)
|
|
137
|
+
Pike13::Desk::Business.franchisees
|
|
133
138
|
```
|
|
134
139
|
|
|
135
140
|
#### Events & Event Occurrences
|
|
136
141
|
|
|
137
142
|
```ruby
|
|
138
143
|
Pike13::Desk::Event.all # List events
|
|
144
|
+
Pike13::Desk::Event.all(from: "2024-01-01", to: "2024-12-31", service_ids: "1,2,3") # Filter with parameters
|
|
145
|
+
Pike13::Desk::Event.all(ids: "100,200,300") # Filter by specific event IDs
|
|
139
146
|
Pike13::Desk::Event.find(100) # Find event
|
|
140
147
|
Pike13::Desk::EventOccurrence.all(from: "2025-01-01", to: "2025-01-31")
|
|
141
148
|
Pike13::Desk::EventOccurrence.find(789) # Find occurrence
|
|
@@ -179,16 +186,22 @@ Pike13::Desk::Appointment.available_slots_summary(
|
|
|
179
186
|
**Note:** Creating bookings requires an `idempotency_token` parameter to prevent duplicate bookings.
|
|
180
187
|
|
|
181
188
|
```ruby
|
|
189
|
+
# Booking operations
|
|
182
190
|
Pike13::Desk::Booking.find(123)
|
|
183
191
|
Pike13::Desk::Booking.create(event_occurrence_id: 789, person_id: 123, idempotency_token: SecureRandom.uuid)
|
|
184
192
|
Pike13::Desk::Booking.update(456, state: "completed")
|
|
185
193
|
Pike13::Desk::Booking.destroy(456)
|
|
194
|
+
|
|
195
|
+
# Lease management within bookings
|
|
196
|
+
Pike13::Desk::Booking.find_lease(booking_id: 123, id: 456)
|
|
197
|
+
Pike13::Desk::Booking.create_lease(123, event_occurrence_id: 789, person: { id: 1 })
|
|
198
|
+
Pike13::Desk::Booking.update_lease(123, 456, person: { id: 2 })
|
|
199
|
+
Pike13::Desk::Booking.destroy_lease(123, 456)
|
|
186
200
|
```
|
|
187
201
|
|
|
188
202
|
#### Visits
|
|
189
203
|
|
|
190
204
|
```ruby
|
|
191
|
-
Pike13::Desk::Visit.all # List all visits
|
|
192
205
|
Pike13::Desk::Visit.find(456) # Find visit
|
|
193
206
|
Pike13::Desk::Visit.summary(person_id: 123) # Get visit summary for a person
|
|
194
207
|
```
|
|
@@ -273,7 +286,6 @@ Pike13::Desk::WaitlistEntry.find(1200) # Find waitlist entry
|
|
|
273
286
|
|
|
274
287
|
```ruby
|
|
275
288
|
Pike13::Desk::CustomField.all # List custom fields
|
|
276
|
-
Pike13::Desk::CustomField.find(30) # Find custom field
|
|
277
289
|
```
|
|
278
290
|
|
|
279
291
|
#### Person-Related Resources
|
|
@@ -298,6 +310,7 @@ Client-facing interface with limited read-only access.
|
|
|
298
310
|
|
|
299
311
|
```ruby
|
|
300
312
|
Pike13::Front::Business.find # Get business info
|
|
313
|
+
Pike13::Front::Business.franchisees # Get franchisees (for franchise businesses)
|
|
301
314
|
Pike13::Front::Branding.find # Get branding
|
|
302
315
|
```
|
|
303
316
|
|
|
@@ -311,6 +324,8 @@ Pike13::Front::Person.me # Get authenticated client user (o
|
|
|
311
324
|
|
|
312
325
|
```ruby
|
|
313
326
|
Pike13::Front::Event.all # List events
|
|
327
|
+
Pike13::Front::Event.all(from: "2024-01-01", to: "2024-12-31", service_ids: "1,2,3") # Filter with parameters
|
|
328
|
+
Pike13::Front::Event.all(ids: "100,200,300") # Filter by specific event IDs
|
|
314
329
|
Pike13::Front::Event.find(100) # Find event
|
|
315
330
|
Pike13::Front::EventOccurrence.all(from: "2025-01-01", to: "2025-01-31")
|
|
316
331
|
Pike13::Front::EventOccurrence.find(789) # Find occurrence
|
|
@@ -333,11 +348,17 @@ Pike13::Front::Appointment.available_slots_summary(service_id: 100, from: "2025-
|
|
|
333
348
|
**Note:** Creating bookings requires an `idempotency_token` parameter to prevent duplicate bookings.
|
|
334
349
|
|
|
335
350
|
```ruby
|
|
351
|
+
# Booking operations
|
|
336
352
|
Pike13::Front::Booking.find(123)
|
|
337
|
-
Pike13::Front::Booking.find_lease(booking_id: 123, id: 456)
|
|
338
353
|
Pike13::Front::Booking.create(event_occurrence_id: 789, person_id: 123, idempotency_token: SecureRandom.uuid)
|
|
339
354
|
Pike13::Front::Booking.update(456, state: "completed")
|
|
340
355
|
Pike13::Front::Booking.destroy(456)
|
|
356
|
+
|
|
357
|
+
# Lease management within bookings
|
|
358
|
+
Pike13::Front::Booking.find_lease(booking_id: 123, id: 456)
|
|
359
|
+
Pike13::Front::Booking.create_lease(123, event_occurrence_id: 789, person: { id: 1 })
|
|
360
|
+
Pike13::Front::Booking.update_lease(123, 456, person: { id: 2 })
|
|
361
|
+
Pike13::Front::Booking.destroy_lease(123, 456)
|
|
341
362
|
```
|
|
342
363
|
|
|
343
364
|
#### Visits
|
data/lib/pike13/version.rb
CHANGED