@robosystems/client 2.36.0 → 2.38.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/types.gen.d.ts CHANGED
@@ -96,7 +96,7 @@ export type AcceptSuggestionLine = {
96
96
  /**
97
97
  * Reason
98
98
  *
99
- * Why a skipped line was not taken: `not_open` (already classified, posted or retracted), `no_suggestion` (nothing to take, or a name that matches no account), `source_changed` (the feed changed it after capture), `suggestion_changed` (a line taken earlier in the batch moved the counterparty's default, so this one's suggestion is not the one selected; review it again), `closed_period`, `locked` (another process holds it; retry), or `refused` (the handler would not post the choice).
99
+ * Why a skipped line was not taken: `not_open` (already classified, posted or retracted), `no_suggestion` (nothing to take, or a name that matches no account), `source_changed` (the feed changed it after capture), `needs_review` (the suggestion carries a caution, such as an amount far above the counterparty's usual; classify the line on its own), `suggestion_changed` (a line taken earlier in the batch moved the counterparty's default, so this one's suggestion is not the one selected; review it again), `closed_period`, `locked` (another process holds it; retry), or `refused` (the handler would not post the choice).
100
100
  */
101
101
  reason?: string | null;
102
102
  /**
@@ -2527,6 +2527,12 @@ export type ConnectionResponse = {
2527
2527
  * The entity whose books the connection keeps: the group parent for QuickBooks, the entity a bank feed was connected for (each of its accounts can move to another entity later), none for an external source, whose events name their own.
2528
2528
  */
2529
2529
  entity_id?: string | null;
2530
+ /**
2531
+ * Keeps Books
2532
+ *
2533
+ * Whether this connection is the ledger of record for `entity_id`: its books are kept in the connected system, and `write_policy` says whether entries are written back to it or only mirrored. False for a bank feed or an external event source.
2534
+ */
2535
+ keeps_books?: boolean;
2530
2536
  /**
2531
2537
  * Status
2532
2538
  *
@@ -2554,7 +2560,7 @@ export type ConnectionResponse = {
2554
2560
  /**
2555
2561
  * Write Policy
2556
2562
  *
2557
- * Source-of-truth write policy: 'native' (RoboSystems is authoritative; no outbound write-back) or 'qb_authoritative' (QuickBooks is authoritative; RoboSystems-originated entries publish to QB). Set via the write-policy endpoint.
2563
+ * Outbound write policy: 'qb_authoritative' (QuickBooks is the book of record and RoboSystems-originated entries publish to it at close), 'shadow' (QuickBooks is the book of record, nothing is written to it and the close posts nothing locally), or 'native' (no external ledger; what severing leaves). It governs the books of `entity_id`, and only on the connection that keeps them. Set via the write-policy endpoint.
2558
2564
  */
2559
2565
  write_policy?: string | null;
2560
2566
  /**
@@ -3192,7 +3198,7 @@ export type CreateEntityRequest = {
3192
3198
  /**
3193
3199
  * Reporting Style Id
3194
3200
  *
3195
- * Structure id of the Reporting Style to present under, validated in the graph like change-reporting-style. Omit to derive it from `entity_type`.
3201
+ * Structure id of the Reporting Style to present under, validated in the graph like change-reporting-style. Omit to derive it from `entity_type`. A consolidation entity always takes the group parent's.
3196
3202
  */
3197
3203
  reporting_style_id?: string | null;
3198
3204
  /**
@@ -8125,6 +8131,12 @@ export type GraphSubscriptionResponse = {
8125
8131
  * Cancellation date
8126
8132
  */
8127
8133
  canceled_at?: string | null;
8134
+ /**
8135
+ * Trial Ends At
8136
+ *
8137
+ * When the free trial ends and the first charge is made. Null for a subscription that opened without a trial; kept after the trial is over.
8138
+ */
8139
+ trial_ends_at?: string | null;
8128
8140
  /**
8129
8141
  * Ends At
8130
8142
  *
@@ -18609,6 +18621,12 @@ export type RepositoryInfo = {
18609
18621
  * Whether repository is coming soon
18610
18622
  */
18611
18623
  coming_soon: boolean;
18624
+ /**
18625
+ * Trial Days
18626
+ *
18627
+ * Length in days of the free trial a first subscription opens with; 0 when the repository offers none
18628
+ */
18629
+ trial_days?: number;
18612
18630
  /**
18613
18631
  * Plans
18614
18632
  *
@@ -20226,7 +20244,7 @@ export type SetWritePolicyRequest = {
20226
20244
  /**
20227
20245
  * Write Policy
20228
20246
  *
20229
- * 'qb_authoritative' = QuickBooks authoritative, entries publish to QB; 'shadow' = QuickBooks authoritative and RoboSystems only observes: nothing is written to QuickBooks, the close posts nothing locally, its drafts become shadowed expectations and its gates are findings. 'native', books kept in RoboSystems with no write-back, is what disconnecting or severing leaves, not a choice for a live connection.
20247
+ * 'qb_authoritative' = QuickBooks authoritative, entries publish to QB; 'shadow' = QuickBooks authoritative and RoboSystems only observes: nothing is written to QuickBooks, the close posts nothing locally, its drafts become shadowed expectations and its gates are findings. 'native', books kept in RoboSystems with no write-back, is what severing leaves, not a choice for a live connection.
20230
20248
  */
20231
20249
  write_policy: 'qb_authoritative' | 'shadow';
20232
20250
  };
@@ -28117,6 +28135,57 @@ export type CreateRepositorySubscriptionResponses = {
28117
28135
  201: GraphSubscriptionResponse;
28118
28136
  };
28119
28137
  export type CreateRepositorySubscriptionResponse = CreateRepositorySubscriptionResponses[keyof CreateRepositorySubscriptionResponses];
28138
+ export type EndRepositorySubscriptionTrialData = {
28139
+ body?: never;
28140
+ path: {
28141
+ /**
28142
+ * Graph Id
28143
+ *
28144
+ * Repository name (e.g., 'sec')
28145
+ */
28146
+ graph_id: string;
28147
+ };
28148
+ query?: never;
28149
+ url: '/v1/graphs/{graph_id}/subscriptions/end-trial';
28150
+ };
28151
+ export type EndRepositorySubscriptionTrialErrors = {
28152
+ /**
28153
+ * Invalid request
28154
+ */
28155
+ 400: ErrorResponse;
28156
+ /**
28157
+ * Authentication required
28158
+ */
28159
+ 401: ErrorResponse;
28160
+ /**
28161
+ * Access denied
28162
+ */
28163
+ 403: ErrorResponse;
28164
+ /**
28165
+ * Resource not found
28166
+ */
28167
+ 404: ErrorResponse;
28168
+ /**
28169
+ * Validation Error
28170
+ */
28171
+ 422: HttpValidationError;
28172
+ /**
28173
+ * Rate limit exceeded
28174
+ */
28175
+ 429: ErrorResponse;
28176
+ /**
28177
+ * Internal server error
28178
+ */
28179
+ 500: ErrorResponse;
28180
+ };
28181
+ export type EndRepositorySubscriptionTrialError = EndRepositorySubscriptionTrialErrors[keyof EndRepositorySubscriptionTrialErrors];
28182
+ export type EndRepositorySubscriptionTrialResponses = {
28183
+ /**
28184
+ * Successful Response
28185
+ */
28186
+ 200: GraphSubscriptionResponse;
28187
+ };
28188
+ export type EndRepositorySubscriptionTrialResponse = EndRepositorySubscriptionTrialResponses[keyof EndRepositorySubscriptionTrialResponses];
28120
28189
  export type CancelRepositorySubscriptionData = {
28121
28190
  body?: CancelSubscriptionRequest;
28122
28191
  path: {
package/types.gen.ts CHANGED
@@ -101,7 +101,7 @@ export type AcceptSuggestionLine = {
101
101
  /**
102
102
  * Reason
103
103
  *
104
- * Why a skipped line was not taken: `not_open` (already classified, posted or retracted), `no_suggestion` (nothing to take, or a name that matches no account), `source_changed` (the feed changed it after capture), `suggestion_changed` (a line taken earlier in the batch moved the counterparty's default, so this one's suggestion is not the one selected; review it again), `closed_period`, `locked` (another process holds it; retry), or `refused` (the handler would not post the choice).
104
+ * Why a skipped line was not taken: `not_open` (already classified, posted or retracted), `no_suggestion` (nothing to take, or a name that matches no account), `source_changed` (the feed changed it after capture), `needs_review` (the suggestion carries a caution, such as an amount far above the counterparty's usual; classify the line on its own), `suggestion_changed` (a line taken earlier in the batch moved the counterparty's default, so this one's suggestion is not the one selected; review it again), `closed_period`, `locked` (another process holds it; retry), or `refused` (the handler would not post the choice).
105
105
  */
106
106
  reason?: string | null;
107
107
  /**
@@ -2591,6 +2591,12 @@ export type ConnectionResponse = {
2591
2591
  * The entity whose books the connection keeps: the group parent for QuickBooks, the entity a bank feed was connected for (each of its accounts can move to another entity later), none for an external source, whose events name their own.
2592
2592
  */
2593
2593
  entity_id?: string | null;
2594
+ /**
2595
+ * Keeps Books
2596
+ *
2597
+ * Whether this connection is the ledger of record for `entity_id`: its books are kept in the connected system, and `write_policy` says whether entries are written back to it or only mirrored. False for a bank feed or an external event source.
2598
+ */
2599
+ keeps_books?: boolean;
2594
2600
  /**
2595
2601
  * Status
2596
2602
  *
@@ -2618,7 +2624,7 @@ export type ConnectionResponse = {
2618
2624
  /**
2619
2625
  * Write Policy
2620
2626
  *
2621
- * Source-of-truth write policy: 'native' (RoboSystems is authoritative; no outbound write-back) or 'qb_authoritative' (QuickBooks is authoritative; RoboSystems-originated entries publish to QB). Set via the write-policy endpoint.
2627
+ * Outbound write policy: 'qb_authoritative' (QuickBooks is the book of record and RoboSystems-originated entries publish to it at close), 'shadow' (QuickBooks is the book of record, nothing is written to it and the close posts nothing locally), or 'native' (no external ledger; what severing leaves). It governs the books of `entity_id`, and only on the connection that keeps them. Set via the write-policy endpoint.
2622
2628
  */
2623
2629
  write_policy?: string | null;
2624
2630
  /**
@@ -3272,7 +3278,7 @@ export type CreateEntityRequest = {
3272
3278
  /**
3273
3279
  * Reporting Style Id
3274
3280
  *
3275
- * Structure id of the Reporting Style to present under, validated in the graph like change-reporting-style. Omit to derive it from `entity_type`.
3281
+ * Structure id of the Reporting Style to present under, validated in the graph like change-reporting-style. Omit to derive it from `entity_type`. A consolidation entity always takes the group parent's.
3276
3282
  */
3277
3283
  reporting_style_id?: string | null;
3278
3284
  /**
@@ -8312,6 +8318,12 @@ export type GraphSubscriptionResponse = {
8312
8318
  * Cancellation date
8313
8319
  */
8314
8320
  canceled_at?: string | null;
8321
+ /**
8322
+ * Trial Ends At
8323
+ *
8324
+ * When the free trial ends and the first charge is made. Null for a subscription that opened without a trial; kept after the trial is over.
8325
+ */
8326
+ trial_ends_at?: string | null;
8315
8327
  /**
8316
8328
  * Ends At
8317
8329
  *
@@ -19034,6 +19046,12 @@ export type RepositoryInfo = {
19034
19046
  * Whether repository is coming soon
19035
19047
  */
19036
19048
  coming_soon: boolean;
19049
+ /**
19050
+ * Trial Days
19051
+ *
19052
+ * Length in days of the free trial a first subscription opens with; 0 when the repository offers none
19053
+ */
19054
+ trial_days?: number;
19037
19055
  /**
19038
19056
  * Plans
19039
19057
  *
@@ -20692,7 +20710,7 @@ export type SetWritePolicyRequest = {
20692
20710
  /**
20693
20711
  * Write Policy
20694
20712
  *
20695
- * 'qb_authoritative' = QuickBooks authoritative, entries publish to QB; 'shadow' = QuickBooks authoritative and RoboSystems only observes: nothing is written to QuickBooks, the close posts nothing locally, its drafts become shadowed expectations and its gates are findings. 'native', books kept in RoboSystems with no write-back, is what disconnecting or severing leaves, not a choice for a live connection.
20713
+ * 'qb_authoritative' = QuickBooks authoritative, entries publish to QB; 'shadow' = QuickBooks authoritative and RoboSystems only observes: nothing is written to QuickBooks, the close posts nothing locally, its drafts become shadowed expectations and its gates are findings. 'native', books kept in RoboSystems with no write-back, is what severing leaves, not a choice for a live connection.
20696
20714
  */
20697
20715
  write_policy: 'qb_authoritative' | 'shadow';
20698
20716
  };
@@ -29140,6 +29158,62 @@ export type CreateRepositorySubscriptionResponses = {
29140
29158
 
29141
29159
  export type CreateRepositorySubscriptionResponse = CreateRepositorySubscriptionResponses[keyof CreateRepositorySubscriptionResponses];
29142
29160
 
29161
+ export type EndRepositorySubscriptionTrialData = {
29162
+ body?: never;
29163
+ path: {
29164
+ /**
29165
+ * Graph Id
29166
+ *
29167
+ * Repository name (e.g., 'sec')
29168
+ */
29169
+ graph_id: string;
29170
+ };
29171
+ query?: never;
29172
+ url: '/v1/graphs/{graph_id}/subscriptions/end-trial';
29173
+ };
29174
+
29175
+ export type EndRepositorySubscriptionTrialErrors = {
29176
+ /**
29177
+ * Invalid request
29178
+ */
29179
+ 400: ErrorResponse;
29180
+ /**
29181
+ * Authentication required
29182
+ */
29183
+ 401: ErrorResponse;
29184
+ /**
29185
+ * Access denied
29186
+ */
29187
+ 403: ErrorResponse;
29188
+ /**
29189
+ * Resource not found
29190
+ */
29191
+ 404: ErrorResponse;
29192
+ /**
29193
+ * Validation Error
29194
+ */
29195
+ 422: HttpValidationError;
29196
+ /**
29197
+ * Rate limit exceeded
29198
+ */
29199
+ 429: ErrorResponse;
29200
+ /**
29201
+ * Internal server error
29202
+ */
29203
+ 500: ErrorResponse;
29204
+ };
29205
+
29206
+ export type EndRepositorySubscriptionTrialError = EndRepositorySubscriptionTrialErrors[keyof EndRepositorySubscriptionTrialErrors];
29207
+
29208
+ export type EndRepositorySubscriptionTrialResponses = {
29209
+ /**
29210
+ * Successful Response
29211
+ */
29212
+ 200: GraphSubscriptionResponse;
29213
+ };
29214
+
29215
+ export type EndRepositorySubscriptionTrialResponse = EndRepositorySubscriptionTrialResponses[keyof EndRepositorySubscriptionTrialResponses];
29216
+
29143
29217
  export type CancelRepositorySubscriptionData = {
29144
29218
  body?: CancelSubscriptionRequest;
29145
29219
  path: {