order3000 1.3.0 → 1.5.0

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.
package/dist/client.cjs CHANGED
@@ -220,6 +220,23 @@ class AdsResource extends BaseResource {
220
220
  body
221
221
  );
222
222
  }
223
+ /**
224
+ * Replace the ad's three owner-managed keyword sets in one shot: the
225
+ * active positive `keywords` the campaign bids on (alongside the venue
226
+ * keywords), the reversible `dismissedKeywords`, and the
227
+ * `disabledVenueKeywords` (venue keywords toggled off for this event).
228
+ * Every set is replaced wholesale — call {@link get} first and resend
229
+ * the full set to preserve existing entries. Texts are lowercased +
230
+ * de-duplicated server-side; an empty array clears that set. Returns the
231
+ * cleaned, persisted sets.
232
+ */
233
+ async saveKeywords(adId, body) {
234
+ return this.request(
235
+ "PATCH",
236
+ `/${encodeURIComponent(adId)}/keywords`,
237
+ body
238
+ );
239
+ }
223
240
  /**
224
241
  * Permanently delete an ad by id. Returns the deleted ad row.
225
242
  */
package/dist/client.d.cts CHANGED
@@ -70,9 +70,27 @@ interface components {
70
70
  ownerEntityId: string;
71
71
  channel: components["schemas"]["AdChannel"];
72
72
  status: components["schemas"]["AdStatus"];
73
+ campaignId: string | null;
73
74
  content: (string | number | boolean | (null)) | {
74
75
  [key: string]: unknown;
75
76
  } | unknown[];
77
+ keywords: (string | number | boolean | (null)) | {
78
+ [key: string]: unknown;
79
+ } | unknown[];
80
+ negativeKeywords: (string | number | boolean | (null)) | {
81
+ [key: string]: unknown;
82
+ } | unknown[];
83
+ disabledVenueKeywords: (string | number | boolean | (null)) | {
84
+ [key: string]: unknown;
85
+ } | unknown[];
86
+ dismissedKeywords: (string | number | boolean | (null)) | {
87
+ [key: string]: unknown;
88
+ } | unknown[];
89
+ publishedContentHash: string | null;
90
+ publishedAt: unknown;
91
+ pushedKeywords: ((string | number | boolean | (null)) | {
92
+ [key: string]: unknown;
93
+ } | unknown[]) | null;
76
94
  createdBy: string | null;
77
95
  updatedBy: string | null;
78
96
  createdAt: unknown;
@@ -86,9 +104,27 @@ interface components {
86
104
  ownerEntityId: string;
87
105
  channel: components["schemas"]["AdChannel"];
88
106
  status: components["schemas"]["AdStatus"];
107
+ campaignId: string | null;
89
108
  content: (string | number | boolean | (null)) | {
90
109
  [key: string]: unknown;
91
110
  } | unknown[];
111
+ keywords: (string | number | boolean | (null)) | {
112
+ [key: string]: unknown;
113
+ } | unknown[];
114
+ negativeKeywords: (string | number | boolean | (null)) | {
115
+ [key: string]: unknown;
116
+ } | unknown[];
117
+ disabledVenueKeywords: (string | number | boolean | (null)) | {
118
+ [key: string]: unknown;
119
+ } | unknown[];
120
+ dismissedKeywords: (string | number | boolean | (null)) | {
121
+ [key: string]: unknown;
122
+ } | unknown[];
123
+ publishedContentHash: string | null;
124
+ publishedAt: unknown;
125
+ pushedKeywords: ((string | number | boolean | (null)) | {
126
+ [key: string]: unknown;
127
+ } | unknown[]) | null;
92
128
  createdBy: string | null;
93
129
  updatedBy: string | null;
94
130
  createdAt: unknown;
@@ -115,9 +151,27 @@ interface components {
115
151
  ownerEntityId: string;
116
152
  channel: components["schemas"]["AdChannel"];
117
153
  status: components["schemas"]["AdStatus"];
154
+ campaignId: string | null;
118
155
  content: (string | number | boolean | (null)) | {
119
156
  [key: string]: unknown;
120
157
  } | unknown[];
158
+ keywords: (string | number | boolean | (null)) | {
159
+ [key: string]: unknown;
160
+ } | unknown[];
161
+ negativeKeywords: (string | number | boolean | (null)) | {
162
+ [key: string]: unknown;
163
+ } | unknown[];
164
+ disabledVenueKeywords: (string | number | boolean | (null)) | {
165
+ [key: string]: unknown;
166
+ } | unknown[];
167
+ dismissedKeywords: (string | number | boolean | (null)) | {
168
+ [key: string]: unknown;
169
+ } | unknown[];
170
+ publishedContentHash: string | null;
171
+ publishedAt: unknown;
172
+ pushedKeywords: ((string | number | boolean | (null)) | {
173
+ [key: string]: unknown;
174
+ } | unknown[]) | null;
121
175
  createdBy: string | null;
122
176
  updatedBy: string | null;
123
177
  createdAt: unknown;
@@ -159,14 +213,47 @@ interface components {
159
213
  ownerEntityId: string;
160
214
  channel: components["schemas"]["AdChannel"];
161
215
  status: components["schemas"]["AdStatus"];
216
+ campaignId: string | null;
162
217
  content: (string | number | boolean | (null)) | {
163
218
  [key: string]: unknown;
164
219
  } | unknown[];
220
+ keywords: (string | number | boolean | (null)) | {
221
+ [key: string]: unknown;
222
+ } | unknown[];
223
+ negativeKeywords: (string | number | boolean | (null)) | {
224
+ [key: string]: unknown;
225
+ } | unknown[];
226
+ disabledVenueKeywords: (string | number | boolean | (null)) | {
227
+ [key: string]: unknown;
228
+ } | unknown[];
229
+ dismissedKeywords: (string | number | boolean | (null)) | {
230
+ [key: string]: unknown;
231
+ } | unknown[];
232
+ publishedContentHash: string | null;
233
+ publishedAt: unknown;
234
+ pushedKeywords: ((string | number | boolean | (null)) | {
235
+ [key: string]: unknown;
236
+ } | unknown[]) | null;
165
237
  createdBy: string | null;
166
238
  updatedBy: string | null;
167
239
  createdAt: unknown;
168
240
  updatedAt: unknown;
169
241
  };
242
+ /** SaveAdKeywordsRequest */
243
+ SaveAdKeywordsRequest: {
244
+ venueAccessor: string;
245
+ adId: string;
246
+ keywords: string[];
247
+ dismissedKeywords: string[];
248
+ disabledVenueKeywords: string[];
249
+ };
250
+ /** SaveAdKeywordsResponse */
251
+ SaveAdKeywordsResponse: {
252
+ success: boolean;
253
+ keywords: string[];
254
+ dismissedKeywords: string[];
255
+ disabledVenueKeywords: string[];
256
+ };
170
257
  /** DeleteAdResponse */
171
258
  DeleteAdResponse: {
172
259
  id: string;
@@ -175,9 +262,27 @@ interface components {
175
262
  ownerEntityId: string;
176
263
  channel: components["schemas"]["AdChannel"];
177
264
  status: components["schemas"]["AdStatus"];
265
+ campaignId: string | null;
178
266
  content: (string | number | boolean | (null)) | {
179
267
  [key: string]: unknown;
180
268
  } | unknown[];
269
+ keywords: (string | number | boolean | (null)) | {
270
+ [key: string]: unknown;
271
+ } | unknown[];
272
+ negativeKeywords: (string | number | boolean | (null)) | {
273
+ [key: string]: unknown;
274
+ } | unknown[];
275
+ disabledVenueKeywords: (string | number | boolean | (null)) | {
276
+ [key: string]: unknown;
277
+ } | unknown[];
278
+ dismissedKeywords: (string | number | boolean | (null)) | {
279
+ [key: string]: unknown;
280
+ } | unknown[];
281
+ publishedContentHash: string | null;
282
+ publishedAt: unknown;
283
+ pushedKeywords: ((string | number | boolean | (null)) | {
284
+ [key: string]: unknown;
285
+ } | unknown[]) | null;
181
286
  createdBy: string | null;
182
287
  updatedBy: string | null;
183
288
  createdAt: unknown;
@@ -317,8 +422,8 @@ interface components {
317
422
  endTime: string | null;
318
423
  partySize: number;
319
424
  status: components["schemas"]["AreaBookingStatus"];
320
- customerFirstName?: string;
321
- customerLastName?: string;
425
+ guestFirstName?: string;
426
+ guestLastName?: string;
322
427
  totalPrice?: number;
323
428
  currency?: components["schemas"]["Currency"];
324
429
  confirmationCode?: string | null;
@@ -329,11 +434,11 @@ interface components {
329
434
  requestedStartTime?: string;
330
435
  requestedEndTime?: string;
331
436
  partySize: number;
332
- customerFirstName: string;
333
- customerLastName: string;
437
+ guestFirstName: string;
438
+ guestLastName: string;
334
439
  /** Format: email */
335
- customerEmail: string;
336
- customerPhone?: string;
440
+ guestEmail: string;
441
+ guestPhone?: string;
337
442
  message?: string;
338
443
  source?: components["schemas"]["AreaBookingRequestSource"];
339
444
  };
@@ -346,10 +451,10 @@ interface components {
346
451
  requestedStartTime: string | null;
347
452
  requestedEndTime: string | null;
348
453
  partySize: number;
349
- customerFirstName: string;
350
- customerLastName: string;
351
- customerEmail: string;
352
- customerPhone: string | null;
454
+ guestFirstName: string;
455
+ guestLastName: string;
456
+ guestEmail: string;
457
+ guestPhone: string | null;
353
458
  message: string | null;
354
459
  source: components["schemas"]["AreaBookingRequestSource"];
355
460
  status: components["schemas"]["AreaBookingRequestStatus"];
@@ -1536,9 +1641,9 @@ interface components {
1536
1641
  fulfillmentType: components["schemas"]["FulfillmentType"];
1537
1642
  /** Format: date-time */
1538
1643
  fulfillmentAt?: string | null;
1539
- customerFirstName?: string;
1540
- customerLastName?: string;
1541
- customerEmail?: string;
1644
+ guestFirstName?: string;
1645
+ guestLastName?: string;
1646
+ guestEmail?: string;
1542
1647
  declaredReturns?: {
1543
1648
  depositwareTemplateId: string;
1544
1649
  count: number;
@@ -1565,7 +1670,7 @@ interface components {
1565
1670
  status: string;
1566
1671
  publicId: string | null;
1567
1672
  quickReferenceNumber: number | null;
1568
- customerId?: string;
1673
+ guestId?: string;
1569
1674
  };
1570
1675
  /** FetchLatestOrderResponse */
1571
1676
  FetchLatestOrderResponse: {
@@ -1617,8 +1722,8 @@ interface components {
1617
1722
  fulfillmentType: components["schemas"]["FulfillmentType"];
1618
1723
  /** Format: date-time */
1619
1724
  fulfillmentAt?: string | null;
1620
- customerFirstName?: string;
1621
- customerLastName?: string;
1725
+ guestFirstName?: string;
1726
+ guestLastName?: string;
1622
1727
  teamOrderPublicId?: string;
1623
1728
  declaredReturns?: {
1624
1729
  depositwareTemplateId: string;
@@ -1692,18 +1797,18 @@ interface components {
1692
1797
  * Format: uuid
1693
1798
  * @description UUID of existing customer profile if available
1694
1799
  */
1695
- customerId?: string | null;
1800
+ guestId?: string | null;
1696
1801
  /** @description First name of the customer making the reservation */
1697
- customerFirstName: string;
1802
+ guestFirstName: string;
1698
1803
  /** @description Last name of the customer making the reservation */
1699
- customerLastName: string;
1804
+ guestLastName: string;
1700
1805
  /**
1701
1806
  * Format: email
1702
1807
  * @description Email address for reservation confirmations and updates
1703
1808
  */
1704
- customerEmail?: string | null;
1809
+ guestEmail?: string | null;
1705
1810
  /** @description Phone number for reservation confirmations and updates. Include country code for international numbers. */
1706
- customerPhone?: string | null;
1811
+ guestPhone?: string | null;
1707
1812
  contactPreference?: components["schemas"]["ContactPreference"];
1708
1813
  source?: components["schemas"]["AreaBookingRequestSource"];
1709
1814
  /** @description Any dietary restrictions, allergies, or special occasions (max 500 characters) */
@@ -1750,15 +1855,15 @@ interface components {
1750
1855
  * Format: uuid
1751
1856
  * @description Link to customer profile if exists
1752
1857
  */
1753
- customerId: string | null;
1858
+ guestId: string | null;
1754
1859
  /** @description First name of the customer */
1755
- customerFirstName: string;
1860
+ guestFirstName: string;
1756
1861
  /** @description Last name of the customer */
1757
- customerLastName: string;
1862
+ guestLastName: string;
1758
1863
  /** @description Customer email address */
1759
- customerEmail: string | null;
1864
+ guestEmail: string | null;
1760
1865
  /** @description Customer phone number */
1761
- customerPhone: string | null;
1866
+ guestPhone: string | null;
1762
1867
  contactPreference: components["schemas"]["ContactPreference"];
1763
1868
  status: components["schemas"]["ReservationStatus"];
1764
1869
  /** @description 6-character confirmation code for the reservation */
@@ -1943,7 +2048,7 @@ interface components {
1943
2048
  quantity: number | null;
1944
2049
  };
1945
2050
  participants: {
1946
- customerId: string;
2051
+ guestId: string;
1947
2052
  basketId: string | null;
1948
2053
  orderId: string | null;
1949
2054
  participantNumber: number | null;
@@ -2012,7 +2117,7 @@ interface components {
2012
2117
  /** Format: uuid */
2013
2118
  teamOrderId: string;
2014
2119
  basketId: string;
2015
- customerId: string;
2120
+ guestId: string;
2016
2121
  status: components["schemas"]["TeamOrderStatus"];
2017
2122
  isLead: boolean;
2018
2123
  alreadyJoined: boolean;
@@ -2206,7 +2311,7 @@ interface components {
2206
2311
  /** @enum {string} */
2207
2312
  BeverageCategory: "wine" | "beer" | "coffee" | "tea" | "cocktail" | "juice" | "soft_drink" | "dairy_drink" | "spirit" | "water";
2208
2313
  /** @enum {string} */
2209
- CancellationReason: "customer_request" | "restaurant_request";
2314
+ CancellationReason: "guest_request" | "restaurant_request";
2210
2315
  /** @enum {string} */
2211
2316
  ContactPreference: "email" | "phone" | "sms" | "none";
2212
2317
  /** @enum {string} */
@@ -2286,7 +2391,7 @@ interface components {
2286
2391
  /** @enum {string} */
2287
2392
  TeamOrderPaymentStatus: "authorized" | "captured" | "cash_pending" | "cash_received" | "voided" | "failed";
2288
2393
  /** @enum {string} */
2289
- FeatureCategory: "articles" | "auth" | "billing" | "core" | "customers" | "events" | "inventory" | "menus" | "orders" | "platform" | "promotions" | "reservations" | "settings" | "venues";
2394
+ FeatureCategory: "articles" | "auth" | "billing" | "core" | "guests" | "events" | "inventory" | "menus" | "orders" | "platform" | "promotions" | "reservations" | "settings" | "venues";
2290
2395
  /** @enum {string} */
2291
2396
  FeatureStatus: "backlog" | "in_development" | "released";
2292
2397
  /** @enum {string} */
@@ -2298,6 +2403,10 @@ interface components {
2298
2403
  /** @enum {string} */
2299
2404
  ReservationStatus: "pending" | "confirmed" | "arrived" | "seated" | "completed" | "cancelled" | "no_show";
2300
2405
  /** @enum {string} */
2406
+ ReservationMessageStatus: "draft" | "sent";
2407
+ /** @enum {string} */
2408
+ VenueEmailSenderStatus: "pending" | "verified" | "failed" | "temporary_failure";
2409
+ /** @enum {string} */
2301
2410
  VenueAssetType: "logomark" | "wordmark" | "combinationmark_horizontal" | "combinationmark_vertical";
2302
2411
  /** @enum {string} */
2303
2412
  VenueUserStatus: "pending" | "confirmed" | "revoked";
@@ -2352,6 +2461,8 @@ type CreateAdResponse = schemas['CreateAdResponse'];
2352
2461
  type PatchAdRequest = schemas['EditAdRequest'];
2353
2462
  type PatchAdResponse = schemas['EditAdResponse'];
2354
2463
  type DeleteAdResponse = schemas['DeleteAdResponse'];
2464
+ type SaveAdKeywordsRequest = schemas['SaveAdKeywordsRequest'];
2465
+ type SaveAdKeywordsResponse = schemas['SaveAdKeywordsResponse'];
2355
2466
  /**
2356
2467
  * Optional filters for `client.ads.list()`. Each narrows the venue's ad
2357
2468
  * set; omit all to list every ad. Client ergonomics, mapped to the wire
@@ -2753,6 +2864,17 @@ declare class AdsResource extends BaseResource {
2753
2864
  * lifecycle. Returns the resulting ad.
2754
2865
  */
2755
2866
  patch(adId: string, body: PatchAdRequest): Promise<PatchAdResponse>;
2867
+ /**
2868
+ * Replace the ad's three owner-managed keyword sets in one shot: the
2869
+ * active positive `keywords` the campaign bids on (alongside the venue
2870
+ * keywords), the reversible `dismissedKeywords`, and the
2871
+ * `disabledVenueKeywords` (venue keywords toggled off for this event).
2872
+ * Every set is replaced wholesale — call {@link get} first and resend
2873
+ * the full set to preserve existing entries. Texts are lowercased +
2874
+ * de-duplicated server-side; an empty array clears that set. Returns the
2875
+ * cleaned, persisted sets.
2876
+ */
2877
+ saveKeywords(adId: string, body: SaveAdKeywordsRequest): Promise<SaveAdKeywordsResponse>;
2756
2878
  /**
2757
2879
  * Permanently delete an ad by id. Returns the deleted ad row.
2758
2880
  */
@@ -3262,7 +3384,7 @@ interface TeamOrderParticipantPayment {
3262
3384
  cardLast4: string | null;
3263
3385
  }
3264
3386
  interface TeamOrderParticipant {
3265
- customerId: string;
3387
+ guestId: string;
3266
3388
  basketId: string | null;
3267
3389
  orderId: string | null;
3268
3390
  /**
@@ -3411,7 +3533,7 @@ interface JoinTeamOrderRequest {
3411
3533
  interface JoinTeamOrderResponse {
3412
3534
  teamOrderId: string;
3413
3535
  basketId: string;
3414
- customerId: string;
3536
+ guestId: string;
3415
3537
  status: TeamOrderStatus;
3416
3538
  isLead: boolean;
3417
3539
  alreadyJoined: boolean;