@37signals/basecamp 0.24.0 → 0.25.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.
Files changed (36) hide show
  1. package/dist/client.d.ts +1 -1
  2. package/dist/client.js +1 -1
  3. package/dist/generated/metadata.js +1 -1
  4. package/dist/generated/metadata.ts +1 -1
  5. package/dist/generated/openapi-stripped.json +41 -14
  6. package/dist/generated/schema.d.ts +43 -14
  7. package/dist/generated/services/boosts.d.ts +2 -2
  8. package/dist/generated/services/boosts.js +2 -2
  9. package/dist/generated/services/boosts.ts +2 -2
  10. package/dist/generated/services/card-columns.d.ts +7 -4
  11. package/dist/generated/services/card-columns.d.ts.map +1 -1
  12. package/dist/generated/services/card-columns.js +1 -1
  13. package/dist/generated/services/card-columns.js.map +1 -1
  14. package/dist/generated/services/card-columns.ts +7 -4
  15. package/dist/generated/services/checkins.d.ts +2 -4
  16. package/dist/generated/services/checkins.d.ts.map +1 -1
  17. package/dist/generated/services/checkins.js +1 -2
  18. package/dist/generated/services/checkins.js.map +1 -1
  19. package/dist/generated/services/checkins.ts +2 -5
  20. package/dist/generated/services/lineup.d.ts +8 -8
  21. package/dist/generated/services/lineup.d.ts.map +1 -1
  22. package/dist/generated/services/lineup.js +10 -8
  23. package/dist/generated/services/lineup.js.map +1 -1
  24. package/dist/generated/services/lineup.ts +12 -10
  25. package/dist/generated/services/my-notifications.d.ts +1 -1
  26. package/dist/generated/services/my-notifications.js +1 -1
  27. package/dist/generated/services/my-notifications.ts +1 -1
  28. package/package.json +1 -1
  29. package/src/generated/metadata.ts +1 -1
  30. package/src/generated/openapi-stripped.json +41 -14
  31. package/src/generated/schema.d.ts +43 -14
  32. package/src/generated/services/boosts.ts +2 -2
  33. package/src/generated/services/card-columns.ts +7 -4
  34. package/src/generated/services/checkins.ts +2 -5
  35. package/src/generated/services/lineup.ts +12 -10
  36. package/src/generated/services/my-notifications.ts +1 -1
@@ -65,12 +65,10 @@ export interface CreateQuestionCheckinRequest {
65
65
  * Request parameters for updateQuestion.
66
66
  */
67
67
  export interface UpdateQuestionCheckinRequest {
68
- /** Title */
68
+ /** The question text. An update carries a title, a schedule or both. */
69
69
  title?: string;
70
70
  /** Schedule */
71
71
  schedule?: components["schemas"]["QuestionScheduleInput"];
72
- /** Paused */
73
- paused?: boolean;
74
72
  }
75
73
 
76
74
  /**
@@ -361,7 +359,7 @@ export class CheckinsService extends BaseService {
361
359
  }
362
360
 
363
361
  /**
364
- * Update an existing question
362
+ * Update an existing question's title, schedule or both. A schedule replaces the whole schedule, so send every part of it: one without frequency or time_of_day is refused, and one without start_date re-anchors the recurrence on today. Pausing and resuming are PauseQuestion and ResumeQuestion.
365
363
  * @param questionId - The question ID
366
364
  * @param req - Question update parameters
367
365
  * @returns The Question
@@ -389,7 +387,6 @@ export class CheckinsService extends BaseService {
389
387
  body: {
390
388
  title: req.title,
391
389
  schedule: req.schedule,
392
- paused: req.paused,
393
390
  },
394
391
  })
395
392
  );
@@ -70,24 +70,24 @@ export class LineupService extends BaseService {
70
70
  }
71
71
 
72
72
  /**
73
- * Create a new lineup marker
73
+ * Create a new lineup marker. Returns the created marker.
74
74
  * @param req - Lineup_marker creation parameters
75
- * @returns void
75
+ * @returns The LineupMarker
76
76
  * @throws {BasecampError} If required fields are missing or invalid
77
77
  *
78
78
  * @example
79
79
  * ```ts
80
- * await client.lineup.create({ name: "My example", date: "example" });
80
+ * const result = await client.lineup.create({ name: "My example", date: "example" });
81
81
  * ```
82
82
  */
83
- async create(req: CreateLineupRequest): Promise<void> {
83
+ async create(req: CreateLineupRequest): Promise<LineupMarker> {
84
84
  if (!req.name) {
85
85
  throw Errors.validation("Name is required");
86
86
  }
87
87
  if (!req.date) {
88
88
  throw Errors.validation("Date is required");
89
89
  }
90
- await this.request(
90
+ const response = await this.request(
91
91
  {
92
92
  service: "Lineup",
93
93
  operation: "CreateLineupMarker",
@@ -102,22 +102,23 @@ export class LineupService extends BaseService {
102
102
  },
103
103
  })
104
104
  );
105
+ return response;
105
106
  }
106
107
 
107
108
  /**
108
- * Update an existing lineup marker
109
+ * Update an existing lineup marker. Returns the updated marker.
109
110
  * @param markerId - The marker ID
110
111
  * @param req - Lineup_marker update parameters
111
- * @returns void
112
+ * @returns The LineupMarker
112
113
  * @throws {BasecampError} If the resource is not found or fields are invalid
113
114
  *
114
115
  * @example
115
116
  * ```ts
116
- * await client.lineup.update(123, { });
117
+ * const result = await client.lineup.update(123, { });
117
118
  * ```
118
119
  */
119
- async update(markerId: number, req: UpdateLineupRequest): Promise<void> {
120
- await this.request(
120
+ async update(markerId: number, req: UpdateLineupRequest): Promise<LineupMarker> {
121
+ const response = await this.request(
121
122
  {
122
123
  service: "Lineup",
123
124
  operation: "UpdateLineupMarker",
@@ -136,6 +137,7 @@ export class LineupService extends BaseService {
136
137
  },
137
138
  })
138
139
  );
140
+ return response;
139
141
  }
140
142
 
141
143
  /**
@@ -60,7 +60,7 @@ At most 500 per request. */
60
60
  export class MyNotificationsService extends BaseService {
61
61
 
62
62
  /**
63
- * Get the current user's notification inbox (the "Hey!" menu).
63
+ * Get the current user's notifications (the "Hey!" menu in Basecamp 4).
64
64
  * @param options - Optional query parameters
65
65
  * @returns The my_notification
66
66
  *