@robosystems/client 2.34.0 → 2.34.1
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/artifacts/LedgerClient.d.ts +6 -4
- package/artifacts/LedgerClient.js +4 -3
- package/artifacts/LedgerClient.ts +6 -4
- package/artifacts/SSEClient.js +2 -1
- package/artifacts/SSEClient.ts +2 -1
- package/artifacts/graphql/client.d.ts +6 -0
- package/artifacts/graphql/client.js +16 -4
- package/artifacts/graphql/client.ts +17 -4
- package/package.json +3 -3
- package/sdk/sdk.gen.d.ts +2 -2
- package/sdk/sdk.gen.js +2 -2
- package/sdk/sdk.gen.ts +2 -2
- package/sdk/types.gen.d.ts +27 -5
- package/sdk/types.gen.ts +27 -5
- package/sdk.gen.d.ts +2 -2
- package/sdk.gen.js +2 -2
- package/sdk.gen.ts +2 -2
- package/types.gen.d.ts +27 -5
- package/types.gen.ts +27 -5
|
@@ -104,7 +104,8 @@ export type LedgerAllocationOverride = NonNullable<ListLedgerAllocationOverrides
|
|
|
104
104
|
/**
|
|
105
105
|
* A rule that turns a matching event into GL rows. `awaitingApproval` marks
|
|
106
106
|
* an AI client's suggestion, which takes no part in matching until a person
|
|
107
|
-
* approves it with `updateEventHandler(..., { approve: true
|
|
107
|
+
* approves it with `updateEventHandler(..., { approve: true,
|
|
108
|
+
* expected_updated_at })`, naming the `updatedAt` they reviewed.
|
|
108
109
|
*/
|
|
109
110
|
export type LedgerEventHandler = NonNullable<ListLedgerEventHandlersQuery['eventHandlers']>['eventHandlers'][number];
|
|
110
111
|
/**
|
|
@@ -1432,9 +1433,10 @@ export declare class LedgerClient {
|
|
|
1432
1433
|
/** One event handler, or null. */
|
|
1433
1434
|
getEventHandler(graphId: string, id: string): Promise<LedgerEventHandler | null>;
|
|
1434
1435
|
/**
|
|
1435
|
-
* Update a registered event handler. Pass `approve: true`
|
|
1436
|
-
*
|
|
1437
|
-
*
|
|
1436
|
+
* Update a registered event handler. Pass `approve: true` with
|
|
1437
|
+
* `expected_updated_at` (the handler's `updatedAt` as the person saw it) to
|
|
1438
|
+
* approve an AI-suggested handler; the API answers 409 if it changed since.
|
|
1439
|
+
* A person's action: through an AI client it is refused.
|
|
1438
1440
|
*/
|
|
1439
1441
|
updateEventHandler(graphId: string, body: UpdateEventHandlerRequest): Promise<EventHandlerResponse>;
|
|
1440
1442
|
/**
|
|
@@ -1425,9 +1425,10 @@ class LedgerClient {
|
|
|
1425
1425
|
return this.gqlQuery(graphId, graphql_1.GetLedgerEventHandlerDocument, { id }, 'Get event handler', (data) => data.eventHandler ?? null);
|
|
1426
1426
|
}
|
|
1427
1427
|
/**
|
|
1428
|
-
* Update a registered event handler. Pass `approve: true`
|
|
1429
|
-
*
|
|
1430
|
-
*
|
|
1428
|
+
* Update a registered event handler. Pass `approve: true` with
|
|
1429
|
+
* `expected_updated_at` (the handler's `updatedAt` as the person saw it) to
|
|
1430
|
+
* approve an AI-suggested handler; the API answers 409 if it changed since.
|
|
1431
|
+
* A person's action: through an AI client it is refused.
|
|
1431
1432
|
*/
|
|
1432
1433
|
async updateEventHandler(graphId, body) {
|
|
1433
1434
|
const envelope = await this.callOperation('Update event handler', (o) => (0, sdk_gen_1.updateEventHandler)({ ...o, path: { graph_id: graphId }, body }));
|
|
@@ -495,7 +495,8 @@ export type LedgerAllocationOverride = NonNullable<
|
|
|
495
495
|
/**
|
|
496
496
|
* A rule that turns a matching event into GL rows. `awaitingApproval` marks
|
|
497
497
|
* an AI client's suggestion, which takes no part in matching until a person
|
|
498
|
-
* approves it with `updateEventHandler(..., { approve: true
|
|
498
|
+
* approves it with `updateEventHandler(..., { approve: true,
|
|
499
|
+
* expected_updated_at })`, naming the `updatedAt` they reviewed.
|
|
499
500
|
*/
|
|
500
501
|
export type LedgerEventHandler = NonNullable<
|
|
501
502
|
ListLedgerEventHandlersQuery['eventHandlers']
|
|
@@ -3511,9 +3512,10 @@ export class LedgerClient {
|
|
|
3511
3512
|
}
|
|
3512
3513
|
|
|
3513
3514
|
/**
|
|
3514
|
-
* Update a registered event handler. Pass `approve: true`
|
|
3515
|
-
*
|
|
3516
|
-
*
|
|
3515
|
+
* Update a registered event handler. Pass `approve: true` with
|
|
3516
|
+
* `expected_updated_at` (the handler's `updatedAt` as the person saw it) to
|
|
3517
|
+
* approve an AI-suggested handler; the API answers 409 if it changed since.
|
|
3518
|
+
* A person's action: through an AI client it is refused.
|
|
3517
3519
|
*/
|
|
3518
3520
|
async updateEventHandler(
|
|
3519
3521
|
graphId: string,
|
package/artifacts/SSEClient.js
CHANGED
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
"use strict";
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
4
|
exports.SSEClient = exports.EventType = void 0;
|
|
5
|
+
const client_1 = require("./graphql/client");
|
|
5
6
|
var EventType;
|
|
6
7
|
(function (EventType) {
|
|
7
8
|
EventType["OPERATION_STARTED"] = "operation_started";
|
|
@@ -37,7 +38,7 @@ class SSEClient {
|
|
|
37
38
|
if (reconnect && this.closed)
|
|
38
39
|
return;
|
|
39
40
|
return new Promise((resolve, reject) => {
|
|
40
|
-
let url = `${this.config.baseUrl}/v1/operations/${operationId}/stream?from_sequence=${fromSequence}`;
|
|
41
|
+
let url = `${this.config.baseUrl}/v1/operations/${(0, client_1.pathSegment)(operationId, 'operationId')}/stream?from_sequence=${encodeURIComponent(String(fromSequence))}`;
|
|
41
42
|
// Add JWT token as query parameter if provided
|
|
42
43
|
// WARNING: EventSource API doesn't support custom headers, so tokens are passed via query param
|
|
43
44
|
// This has security implications - see class documentation
|
package/artifacts/SSEClient.ts
CHANGED
|
@@ -25,6 +25,7 @@
|
|
|
25
25
|
*/
|
|
26
26
|
|
|
27
27
|
import type { TokenProvider } from './graphql/client'
|
|
28
|
+
import { pathSegment } from './graphql/client'
|
|
28
29
|
|
|
29
30
|
export interface SSEConfig {
|
|
30
31
|
baseUrl: string
|
|
@@ -97,7 +98,7 @@ export class SSEClient {
|
|
|
97
98
|
if (reconnect && this.closed) return
|
|
98
99
|
|
|
99
100
|
return new Promise((resolve, reject) => {
|
|
100
|
-
let url = `${this.config.baseUrl}/v1/operations/${operationId}/stream?from_sequence=${fromSequence}`
|
|
101
|
+
let url = `${this.config.baseUrl}/v1/operations/${pathSegment(operationId, 'operationId')}/stream?from_sequence=${encodeURIComponent(String(fromSequence))}`
|
|
101
102
|
|
|
102
103
|
// Add JWT token as query parameter if provided
|
|
103
104
|
// WARNING: EventSource API doesn't support custom headers, so tokens are passed via query param
|
|
@@ -112,6 +112,12 @@ export declare function authHeaderFor(token: string): Record<string, string>;
|
|
|
112
112
|
* confusing 401 far from the real failure (matches the Python client).
|
|
113
113
|
*/
|
|
114
114
|
export declare function resolveCredential(config: Pick<GraphQLClientConfig, 'token' | 'tokenProvider'>): Promise<string | null>;
|
|
115
|
+
/**
|
|
116
|
+
* Validate and encode a value interpolated into a request path as one segment.
|
|
117
|
+
* Anything that could change the route — a separator, dot segments, a query
|
|
118
|
+
* or fragment marker — is refused rather than escaped.
|
|
119
|
+
*/
|
|
120
|
+
export declare function pathSegment(value: string, name: string): string;
|
|
115
121
|
/**
|
|
116
122
|
* Build a new GraphQL client for the given graph. Prefer
|
|
117
123
|
* `GraphQLClientCache.get(graphId)` in facade code — this is the raw
|
|
@@ -5,6 +5,7 @@ exports.GraphQLClientCache = exports.GraphQLError = exports.DEFAULT_GRAPHQL_TIME
|
|
|
5
5
|
exports.toGraphQLError = toGraphQLError;
|
|
6
6
|
exports.authHeaderFor = authHeaderFor;
|
|
7
7
|
exports.resolveCredential = resolveCredential;
|
|
8
|
+
exports.pathSegment = pathSegment;
|
|
8
9
|
exports.createGraphQLClient = createGraphQLClient;
|
|
9
10
|
/**
|
|
10
11
|
* GraphQL client factory used internally by the facade clients.
|
|
@@ -140,16 +141,27 @@ async function resolveCredential(config) {
|
|
|
140
141
|
'returns the current token, or null to send an unauthenticated (cookie-based) request.', { cause: err });
|
|
141
142
|
}
|
|
142
143
|
}
|
|
144
|
+
const PATH_SEGMENT_PATTERN = /^[A-Za-z0-9_.-]{1,128}$/;
|
|
145
|
+
/**
|
|
146
|
+
* Validate and encode a value interpolated into a request path as one segment.
|
|
147
|
+
* Anything that could change the route — a separator, dot segments, a query
|
|
148
|
+
* or fragment marker — is refused rather than escaped.
|
|
149
|
+
*/
|
|
150
|
+
function pathSegment(value, name) {
|
|
151
|
+
if (!value || !PATH_SEGMENT_PATTERN.test(value) || value === '.' || value === '..') {
|
|
152
|
+
throw new Error(`${name} must be a single path segment`);
|
|
153
|
+
}
|
|
154
|
+
return encodeURIComponent(value);
|
|
155
|
+
}
|
|
143
156
|
/**
|
|
144
157
|
* Build a new GraphQL client for the given graph. Prefer
|
|
145
158
|
* `GraphQLClientCache.get(graphId)` in facade code — this is the raw
|
|
146
159
|
* factory and bypasses the cache.
|
|
147
160
|
*/
|
|
148
161
|
function createGraphQLClient(config, graphId) {
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
}
|
|
152
|
-
const url = `${config.baseUrl.replace(/\/$/, '')}/extensions/${graphId}/graphql`;
|
|
162
|
+
// One path segment, nothing else: a graph id from a URL parameter must not be
|
|
163
|
+
// able to re-target the request (and its credential) to another endpoint.
|
|
164
|
+
const url = `${config.baseUrl.replace(/\/$/, '')}/extensions/${pathSegment(graphId, 'graphId')}/graphql`;
|
|
153
165
|
const staticHeaders = {
|
|
154
166
|
...(config.headers ?? {}),
|
|
155
167
|
};
|
|
@@ -205,16 +205,29 @@ export async function resolveCredential(
|
|
|
205
205
|
}
|
|
206
206
|
}
|
|
207
207
|
|
|
208
|
+
const PATH_SEGMENT_PATTERN = /^[A-Za-z0-9_.-]{1,128}$/
|
|
209
|
+
|
|
210
|
+
/**
|
|
211
|
+
* Validate and encode a value interpolated into a request path as one segment.
|
|
212
|
+
* Anything that could change the route — a separator, dot segments, a query
|
|
213
|
+
* or fragment marker — is refused rather than escaped.
|
|
214
|
+
*/
|
|
215
|
+
export function pathSegment(value: string, name: string): string {
|
|
216
|
+
if (!value || !PATH_SEGMENT_PATTERN.test(value) || value === '.' || value === '..') {
|
|
217
|
+
throw new Error(`${name} must be a single path segment`)
|
|
218
|
+
}
|
|
219
|
+
return encodeURIComponent(value)
|
|
220
|
+
}
|
|
221
|
+
|
|
208
222
|
/**
|
|
209
223
|
* Build a new GraphQL client for the given graph. Prefer
|
|
210
224
|
* `GraphQLClientCache.get(graphId)` in facade code — this is the raw
|
|
211
225
|
* factory and bypasses the cache.
|
|
212
226
|
*/
|
|
213
227
|
export function createGraphQLClient(config: GraphQLClientConfig, graphId: string): GraphQLClient {
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
}
|
|
217
|
-
const url = `${config.baseUrl.replace(/\/$/, '')}/extensions/${graphId}/graphql`
|
|
228
|
+
// One path segment, nothing else: a graph id from a URL parameter must not be
|
|
229
|
+
// able to re-target the request (and its credential) to another endpoint.
|
|
230
|
+
const url = `${config.baseUrl.replace(/\/$/, '')}/extensions/${pathSegment(graphId, 'graphId')}/graphql`
|
|
218
231
|
const staticHeaders: Record<string, string> = {
|
|
219
232
|
...(config.headers ?? {}),
|
|
220
233
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@robosystems/client",
|
|
3
|
-
"version": "2.34.
|
|
3
|
+
"version": "2.34.1",
|
|
4
4
|
"description": "TypeScript client library for the RoboSystems financial intelligence platform",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"types": "index.d.ts",
|
|
@@ -152,14 +152,14 @@
|
|
|
152
152
|
"eslint": "^10.9.1",
|
|
153
153
|
"eslint-config-prettier": "^10.0.0",
|
|
154
154
|
"eslint-plugin-prettier": "^5.0.0",
|
|
155
|
-
"happy-dom": "^
|
|
155
|
+
"happy-dom": "^21.0.4",
|
|
156
156
|
"prettier": "^3.0.0",
|
|
157
157
|
"prettier-plugin-organize-imports": "^4.0.0",
|
|
158
158
|
"react": "^19.2.0",
|
|
159
159
|
"react-dom": "^19.2.0",
|
|
160
160
|
"typescript": "^5.7.2",
|
|
161
161
|
"typescript-eslint": "^8.54.0",
|
|
162
|
-
"vitest": "^4.1.
|
|
162
|
+
"vitest": "^4.1.12"
|
|
163
163
|
},
|
|
164
164
|
"publishConfig": {
|
|
165
165
|
"access": "public",
|
package/sdk/sdk.gen.d.ts
CHANGED
|
@@ -320,7 +320,7 @@ export declare const listConnections: <ThrowOnError extends boolean = false>(opt
|
|
|
320
320
|
/**
|
|
321
321
|
* Create Connection
|
|
322
322
|
*
|
|
323
|
-
* QuickBooks and Mercury: returns a pending connection — complete the OAuth flow to activate (Mercury may instead connect at once with a personal API token where the deployment allows it). External: registers a source namespace for an integration that writes through the public API. One connection allowed per provider per graph, except 'external' which allows one per source_name and 'plaid' which allows one per bank login (a connection still waiting on Link is returned instead of a second). Plaid: returns a pending connection — `POST /oauth/init` returns a `link_token` for Plaid Link. A bank feed (Mercury, Plaid) names the entity its accounts book to (`entity_id`, the group parent when omitted) and is refused (409) when that entity has no chart of accounts or is the one QuickBooks keeps
|
|
323
|
+
* QuickBooks and Mercury: returns a pending connection — complete the OAuth flow to activate (Mercury may instead connect at once with a personal API token where the deployment allows it). External: registers a source namespace for an integration that writes through the public API. One connection allowed per provider per graph, except 'external' which allows one per source_name and 'plaid' which allows one per bank login (a connection still waiting on Link is returned instead of a second). Plaid: returns a pending connection — `POST /oauth/init` returns a `link_token` for Plaid Link. A bank feed (Mercury, Plaid) names the entity its accounts book to (`entity_id`, the group parent when omitted) and is refused (409) when that entity has no chart of accounts or is the one QuickBooks keeps. QuickBooks keeps the group parent's books only: `entity_id` may be omitted, and naming a subsidiary is refused (409 PARENT_ONLY); it is refused (409) too when the group parent's books are already native. Every connection's `entity_id` is the entity whose books it keeps.
|
|
324
324
|
*/
|
|
325
325
|
export declare const createConnection: <ThrowOnError extends boolean = false>(options: Options<CreateConnectionData, ThrowOnError>) => RequestResult<CreateConnectionResponses, CreateConnectionErrors, ThrowOnError>;
|
|
326
326
|
/**
|
|
@@ -592,7 +592,7 @@ export declare const deleteSubgraph: <ThrowOnError extends boolean = false>(opti
|
|
|
592
592
|
/**
|
|
593
593
|
* Delete Graph
|
|
594
594
|
*
|
|
595
|
-
* Permanently destroys a user graph and cancels its subscription. Two modes via the `at_period_end` body flag: omit it (or pass `false`) to tear down immediately (~10 min); pass `true` to keep the graph usable through the current billing period and tear it down at the period boundary via the existing suspend → deprovision pipeline. Requires `confirm` to equal the URL `graph_id`. Caller must be both org owner (billing authority) and admin on the graph (operational authority). Not allowed on shared repositories.
|
|
595
|
+
* Permanently destroys a user graph and cancels its subscription. Two modes via the `at_period_end` body flag: omit it (or pass `false`) to tear down immediately (~10 min); pass `true` to keep the graph usable through the current billing period and tear it down at the period boundary via the existing suspend → deprovision pipeline. An immediate delete credits the unused part of the billed period; it is not refunded. On a card-billed plan the credit goes to the organization's account balance and is applied to its next invoice; on an invoiced plan it is a credit line on that period's invoice, or a separate credit invoice if that one is already paid. Requires `confirm` to equal the URL `graph_id`. Caller must be both org owner (billing authority) and admin on the graph (operational authority). Not allowed on shared repositories.
|
|
596
596
|
*
|
|
597
597
|
* **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
|
|
598
598
|
*/
|
package/sdk/sdk.gen.js
CHANGED
|
@@ -614,7 +614,7 @@ exports.listConnections = listConnections;
|
|
|
614
614
|
/**
|
|
615
615
|
* Create Connection
|
|
616
616
|
*
|
|
617
|
-
* QuickBooks and Mercury: returns a pending connection — complete the OAuth flow to activate (Mercury may instead connect at once with a personal API token where the deployment allows it). External: registers a source namespace for an integration that writes through the public API. One connection allowed per provider per graph, except 'external' which allows one per source_name and 'plaid' which allows one per bank login (a connection still waiting on Link is returned instead of a second). Plaid: returns a pending connection — `POST /oauth/init` returns a `link_token` for Plaid Link. A bank feed (Mercury, Plaid) names the entity its accounts book to (`entity_id`, the group parent when omitted) and is refused (409) when that entity has no chart of accounts or is the one QuickBooks keeps
|
|
617
|
+
* QuickBooks and Mercury: returns a pending connection — complete the OAuth flow to activate (Mercury may instead connect at once with a personal API token where the deployment allows it). External: registers a source namespace for an integration that writes through the public API. One connection allowed per provider per graph, except 'external' which allows one per source_name and 'plaid' which allows one per bank login (a connection still waiting on Link is returned instead of a second). Plaid: returns a pending connection — `POST /oauth/init` returns a `link_token` for Plaid Link. A bank feed (Mercury, Plaid) names the entity its accounts book to (`entity_id`, the group parent when omitted) and is refused (409) when that entity has no chart of accounts or is the one QuickBooks keeps. QuickBooks keeps the group parent's books only: `entity_id` may be omitted, and naming a subsidiary is refused (409 PARENT_ONLY); it is refused (409) too when the group parent's books are already native. Every connection's `entity_id` is the entity whose books it keeps.
|
|
618
618
|
*/
|
|
619
619
|
const createConnection = (options) => (options.client ?? client_gen_1.client).post({
|
|
620
620
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -1208,7 +1208,7 @@ exports.deleteSubgraph = deleteSubgraph;
|
|
|
1208
1208
|
/**
|
|
1209
1209
|
* Delete Graph
|
|
1210
1210
|
*
|
|
1211
|
-
* Permanently destroys a user graph and cancels its subscription. Two modes via the `at_period_end` body flag: omit it (or pass `false`) to tear down immediately (~10 min); pass `true` to keep the graph usable through the current billing period and tear it down at the period boundary via the existing suspend → deprovision pipeline. Requires `confirm` to equal the URL `graph_id`. Caller must be both org owner (billing authority) and admin on the graph (operational authority). Not allowed on shared repositories.
|
|
1211
|
+
* Permanently destroys a user graph and cancels its subscription. Two modes via the `at_period_end` body flag: omit it (or pass `false`) to tear down immediately (~10 min); pass `true` to keep the graph usable through the current billing period and tear it down at the period boundary via the existing suspend → deprovision pipeline. An immediate delete credits the unused part of the billed period; it is not refunded. On a card-billed plan the credit goes to the organization's account balance and is applied to its next invoice; on an invoiced plan it is a credit line on that period's invoice, or a separate credit invoice if that one is already paid. Requires `confirm` to equal the URL `graph_id`. Caller must be both org owner (billing authority) and admin on the graph (operational authority). Not allowed on shared repositories.
|
|
1212
1212
|
*
|
|
1213
1213
|
* **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
|
|
1214
1214
|
*/
|
package/sdk/sdk.gen.ts
CHANGED
|
@@ -625,7 +625,7 @@ export const listConnections = <ThrowOnError extends boolean = false>(options: O
|
|
|
625
625
|
/**
|
|
626
626
|
* Create Connection
|
|
627
627
|
*
|
|
628
|
-
* QuickBooks and Mercury: returns a pending connection — complete the OAuth flow to activate (Mercury may instead connect at once with a personal API token where the deployment allows it). External: registers a source namespace for an integration that writes through the public API. One connection allowed per provider per graph, except 'external' which allows one per source_name and 'plaid' which allows one per bank login (a connection still waiting on Link is returned instead of a second). Plaid: returns a pending connection — `POST /oauth/init` returns a `link_token` for Plaid Link. A bank feed (Mercury, Plaid) names the entity its accounts book to (`entity_id`, the group parent when omitted) and is refused (409) when that entity has no chart of accounts or is the one QuickBooks keeps
|
|
628
|
+
* QuickBooks and Mercury: returns a pending connection — complete the OAuth flow to activate (Mercury may instead connect at once with a personal API token where the deployment allows it). External: registers a source namespace for an integration that writes through the public API. One connection allowed per provider per graph, except 'external' which allows one per source_name and 'plaid' which allows one per bank login (a connection still waiting on Link is returned instead of a second). Plaid: returns a pending connection — `POST /oauth/init` returns a `link_token` for Plaid Link. A bank feed (Mercury, Plaid) names the entity its accounts book to (`entity_id`, the group parent when omitted) and is refused (409) when that entity has no chart of accounts or is the one QuickBooks keeps. QuickBooks keeps the group parent's books only: `entity_id` may be omitted, and naming a subsidiary is refused (409 PARENT_ONLY); it is refused (409) too when the group parent's books are already native. Every connection's `entity_id` is the entity whose books it keeps.
|
|
629
629
|
*/
|
|
630
630
|
export const createConnection = <ThrowOnError extends boolean = false>(options: Options<CreateConnectionData, ThrowOnError>): RequestResult<CreateConnectionResponses, CreateConnectionErrors, ThrowOnError> => (options.client ?? client).post<CreateConnectionResponses, CreateConnectionErrors, ThrowOnError>({
|
|
631
631
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -1219,7 +1219,7 @@ export const deleteSubgraph = <ThrowOnError extends boolean = false>(options: Op
|
|
|
1219
1219
|
/**
|
|
1220
1220
|
* Delete Graph
|
|
1221
1221
|
*
|
|
1222
|
-
* Permanently destroys a user graph and cancels its subscription. Two modes via the `at_period_end` body flag: omit it (or pass `false`) to tear down immediately (~10 min); pass `true` to keep the graph usable through the current billing period and tear it down at the period boundary via the existing suspend → deprovision pipeline. Requires `confirm` to equal the URL `graph_id`. Caller must be both org owner (billing authority) and admin on the graph (operational authority). Not allowed on shared repositories.
|
|
1222
|
+
* Permanently destroys a user graph and cancels its subscription. Two modes via the `at_period_end` body flag: omit it (or pass `false`) to tear down immediately (~10 min); pass `true` to keep the graph usable through the current billing period and tear it down at the period boundary via the existing suspend → deprovision pipeline. An immediate delete credits the unused part of the billed period; it is not refunded. On a card-billed plan the credit goes to the organization's account balance and is applied to its next invoice; on an invoiced plan it is a credit line on that period's invoice, or a separate credit invoice if that one is already paid. Requires `confirm` to equal the URL `graph_id`. Caller must be both org owner (billing authority) and admin on the graph (operational authority). Not allowed on shared repositories.
|
|
1223
1223
|
*
|
|
1224
1224
|
* **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
|
|
1225
1225
|
*/
|
package/sdk/types.gen.d.ts
CHANGED
|
@@ -2524,7 +2524,7 @@ export type ConnectionResponse = {
|
|
|
2524
2524
|
/**
|
|
2525
2525
|
* Entity Id
|
|
2526
2526
|
*
|
|
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
2530
|
/**
|
|
@@ -3100,7 +3100,7 @@ export type CreateConnectionRequest = {
|
|
|
3100
3100
|
/**
|
|
3101
3101
|
* Entity Id
|
|
3102
3102
|
*
|
|
3103
|
-
*
|
|
3103
|
+
* QuickBooks: the entity whose books it keeps, which can only be the group parent; omit it. A bank feed names its entity on its own config.
|
|
3104
3104
|
*/
|
|
3105
3105
|
entity_id?: string | null;
|
|
3106
3106
|
quickbooks_config?: QuickBooksConnectionConfig | null;
|
|
@@ -4779,7 +4779,11 @@ export type DeleteForecastRequest = {
|
|
|
4779
4779
|
*
|
|
4780
4780
|
* - **Immediate** (default): subscription canceled now (`ends_at = now`) and
|
|
4781
4781
|
* fast-path deprovisioning fires within ~10 minutes. Use when you want
|
|
4782
|
-
* the data gone and the slot freed right away.
|
|
4782
|
+
* the data gone and the slot freed right away. The unused part of the
|
|
4783
|
+
* billed period is credited, not refunded: on a card-billed plan to the
|
|
4784
|
+
* organization's account balance, applied to its next invoice; on an
|
|
4785
|
+
* invoiced plan as a credit on that period's invoice, or a separate credit
|
|
4786
|
+
* invoice if it is already paid.
|
|
4783
4787
|
* - **At period end** (`at_period_end=true`): subscription canceled but
|
|
4784
4788
|
* `ends_at = current_period_end` so the graph stays usable through the
|
|
4785
4789
|
* paid period. The existing suspend → deprovision sensor pipeline tears
|
|
@@ -18984,6 +18988,12 @@ export type SsoCompleteRequest = {
|
|
|
18984
18988
|
* Temporary session ID from secure handoff
|
|
18985
18989
|
*/
|
|
18986
18990
|
session_id: string;
|
|
18991
|
+
/**
|
|
18992
|
+
* Browser Nonce
|
|
18993
|
+
*
|
|
18994
|
+
* The nonce this browser minted when it started the bridge; its SHA-256 was passed through the exchange as browser_nonce_hash.
|
|
18995
|
+
*/
|
|
18996
|
+
browser_nonce?: string | null;
|
|
18987
18997
|
};
|
|
18988
18998
|
/**
|
|
18989
18999
|
* SSOExchangeRequest
|
|
@@ -19009,6 +19019,12 @@ export type SsoExchangeRequest = {
|
|
|
19009
19019
|
* Optional return URL after authentication
|
|
19010
19020
|
*/
|
|
19011
19021
|
return_url?: string | null;
|
|
19022
|
+
/**
|
|
19023
|
+
* Browser Nonce Hash
|
|
19024
|
+
*
|
|
19025
|
+
* SHA-256 (hex) of a nonce the target app minted in the browser that is signing in. Completion must present the nonce, so the handoff cannot be redeemed by any other browser.
|
|
19026
|
+
*/
|
|
19027
|
+
browser_nonce_hash?: string | null;
|
|
19012
19028
|
};
|
|
19013
19029
|
/**
|
|
19014
19030
|
* SSOExchangeResponse
|
|
@@ -22332,9 +22348,15 @@ export type UpdateEventHandlerRequest = {
|
|
|
22332
22348
|
/**
|
|
22333
22349
|
* Approve
|
|
22334
22350
|
*
|
|
22335
|
-
* Approval shortcut: True stamps approved_by/approved_at to the current user; False clears both.
|
|
22351
|
+
* Approval shortcut: True stamps approved_by/approved_at to the current user; False clears both. Approving an AI-suggested handler also needs `expected_updated_at`.
|
|
22336
22352
|
*/
|
|
22337
22353
|
approve?: boolean | null;
|
|
22354
|
+
/**
|
|
22355
|
+
* Expected Updated At
|
|
22356
|
+
*
|
|
22357
|
+
* The handler's `updated_at` as shown when it was reviewed. Required with `approve=true` on an AI-suggested handler, so the approval covers exactly that version; a mismatch is refused with 409.
|
|
22358
|
+
*/
|
|
22359
|
+
expected_updated_at?: string | null;
|
|
22338
22360
|
/**
|
|
22339
22361
|
* Metadata Patch
|
|
22340
22362
|
*
|
|
@@ -25772,7 +25794,7 @@ export type ListConnectionsData = {
|
|
|
25772
25794
|
/**
|
|
25773
25795
|
* Entity Id
|
|
25774
25796
|
*
|
|
25775
|
-
*
|
|
25797
|
+
* Only the connections that keep this entity's books
|
|
25776
25798
|
*/
|
|
25777
25799
|
entity_id?: string | null;
|
|
25778
25800
|
/**
|
package/sdk/types.gen.ts
CHANGED
|
@@ -2588,7 +2588,7 @@ export type ConnectionResponse = {
|
|
|
2588
2588
|
/**
|
|
2589
2589
|
* Entity Id
|
|
2590
2590
|
*
|
|
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
2594
|
/**
|
|
@@ -3177,7 +3177,7 @@ export type CreateConnectionRequest = {
|
|
|
3177
3177
|
/**
|
|
3178
3178
|
* Entity Id
|
|
3179
3179
|
*
|
|
3180
|
-
*
|
|
3180
|
+
* QuickBooks: the entity whose books it keeps, which can only be the group parent; omit it. A bank feed names its entity on its own config.
|
|
3181
3181
|
*/
|
|
3182
3182
|
entity_id?: string | null;
|
|
3183
3183
|
quickbooks_config?: QuickBooksConnectionConfig | null;
|
|
@@ -4888,7 +4888,11 @@ export type DeleteForecastRequest = {
|
|
|
4888
4888
|
*
|
|
4889
4889
|
* - **Immediate** (default): subscription canceled now (`ends_at = now`) and
|
|
4890
4890
|
* fast-path deprovisioning fires within ~10 minutes. Use when you want
|
|
4891
|
-
* the data gone and the slot freed right away.
|
|
4891
|
+
* the data gone and the slot freed right away. The unused part of the
|
|
4892
|
+
* billed period is credited, not refunded: on a card-billed plan to the
|
|
4893
|
+
* organization's account balance, applied to its next invoice; on an
|
|
4894
|
+
* invoiced plan as a credit on that period's invoice, or a separate credit
|
|
4895
|
+
* invoice if it is already paid.
|
|
4892
4896
|
* - **At period end** (`at_period_end=true`): subscription canceled but
|
|
4893
4897
|
* `ends_at = current_period_end` so the graph stays usable through the
|
|
4894
4898
|
* paid period. The existing suspend → deprovision sensor pipeline tears
|
|
@@ -19422,6 +19426,12 @@ export type SsoCompleteRequest = {
|
|
|
19422
19426
|
* Temporary session ID from secure handoff
|
|
19423
19427
|
*/
|
|
19424
19428
|
session_id: string;
|
|
19429
|
+
/**
|
|
19430
|
+
* Browser Nonce
|
|
19431
|
+
*
|
|
19432
|
+
* The nonce this browser minted when it started the bridge; its SHA-256 was passed through the exchange as browser_nonce_hash.
|
|
19433
|
+
*/
|
|
19434
|
+
browser_nonce?: string | null;
|
|
19425
19435
|
};
|
|
19426
19436
|
|
|
19427
19437
|
/**
|
|
@@ -19448,6 +19458,12 @@ export type SsoExchangeRequest = {
|
|
|
19448
19458
|
* Optional return URL after authentication
|
|
19449
19459
|
*/
|
|
19450
19460
|
return_url?: string | null;
|
|
19461
|
+
/**
|
|
19462
|
+
* Browser Nonce Hash
|
|
19463
|
+
*
|
|
19464
|
+
* SHA-256 (hex) of a nonce the target app minted in the browser that is signing in. Completion must present the nonce, so the handoff cannot be redeemed by any other browser.
|
|
19465
|
+
*/
|
|
19466
|
+
browser_nonce_hash?: string | null;
|
|
19451
19467
|
};
|
|
19452
19468
|
|
|
19453
19469
|
/**
|
|
@@ -22852,9 +22868,15 @@ export type UpdateEventHandlerRequest = {
|
|
|
22852
22868
|
/**
|
|
22853
22869
|
* Approve
|
|
22854
22870
|
*
|
|
22855
|
-
* Approval shortcut: True stamps approved_by/approved_at to the current user; False clears both.
|
|
22871
|
+
* Approval shortcut: True stamps approved_by/approved_at to the current user; False clears both. Approving an AI-suggested handler also needs `expected_updated_at`.
|
|
22856
22872
|
*/
|
|
22857
22873
|
approve?: boolean | null;
|
|
22874
|
+
/**
|
|
22875
|
+
* Expected Updated At
|
|
22876
|
+
*
|
|
22877
|
+
* The handler's `updated_at` as shown when it was reviewed. Required with `approve=true` on an AI-suggested handler, so the approval covers exactly that version; a mismatch is refused with 409.
|
|
22878
|
+
*/
|
|
22879
|
+
expected_updated_at?: string | null;
|
|
22858
22880
|
/**
|
|
22859
22881
|
* Metadata Patch
|
|
22860
22882
|
*
|
|
@@ -26601,7 +26623,7 @@ export type ListConnectionsData = {
|
|
|
26601
26623
|
/**
|
|
26602
26624
|
* Entity Id
|
|
26603
26625
|
*
|
|
26604
|
-
*
|
|
26626
|
+
* Only the connections that keep this entity's books
|
|
26605
26627
|
*/
|
|
26606
26628
|
entity_id?: string | null;
|
|
26607
26629
|
/**
|
package/sdk.gen.d.ts
CHANGED
|
@@ -320,7 +320,7 @@ export declare const listConnections: <ThrowOnError extends boolean = false>(opt
|
|
|
320
320
|
/**
|
|
321
321
|
* Create Connection
|
|
322
322
|
*
|
|
323
|
-
* QuickBooks and Mercury: returns a pending connection — complete the OAuth flow to activate (Mercury may instead connect at once with a personal API token where the deployment allows it). External: registers a source namespace for an integration that writes through the public API. One connection allowed per provider per graph, except 'external' which allows one per source_name and 'plaid' which allows one per bank login (a connection still waiting on Link is returned instead of a second). Plaid: returns a pending connection — `POST /oauth/init` returns a `link_token` for Plaid Link. A bank feed (Mercury, Plaid) names the entity its accounts book to (`entity_id`, the group parent when omitted) and is refused (409) when that entity has no chart of accounts or is the one QuickBooks keeps
|
|
323
|
+
* QuickBooks and Mercury: returns a pending connection — complete the OAuth flow to activate (Mercury may instead connect at once with a personal API token where the deployment allows it). External: registers a source namespace for an integration that writes through the public API. One connection allowed per provider per graph, except 'external' which allows one per source_name and 'plaid' which allows one per bank login (a connection still waiting on Link is returned instead of a second). Plaid: returns a pending connection — `POST /oauth/init` returns a `link_token` for Plaid Link. A bank feed (Mercury, Plaid) names the entity its accounts book to (`entity_id`, the group parent when omitted) and is refused (409) when that entity has no chart of accounts or is the one QuickBooks keeps. QuickBooks keeps the group parent's books only: `entity_id` may be omitted, and naming a subsidiary is refused (409 PARENT_ONLY); it is refused (409) too when the group parent's books are already native. Every connection's `entity_id` is the entity whose books it keeps.
|
|
324
324
|
*/
|
|
325
325
|
export declare const createConnection: <ThrowOnError extends boolean = false>(options: Options<CreateConnectionData, ThrowOnError>) => RequestResult<CreateConnectionResponses, CreateConnectionErrors, ThrowOnError>;
|
|
326
326
|
/**
|
|
@@ -592,7 +592,7 @@ export declare const deleteSubgraph: <ThrowOnError extends boolean = false>(opti
|
|
|
592
592
|
/**
|
|
593
593
|
* Delete Graph
|
|
594
594
|
*
|
|
595
|
-
* Permanently destroys a user graph and cancels its subscription. Two modes via the `at_period_end` body flag: omit it (or pass `false`) to tear down immediately (~10 min); pass `true` to keep the graph usable through the current billing period and tear it down at the period boundary via the existing suspend → deprovision pipeline. Requires `confirm` to equal the URL `graph_id`. Caller must be both org owner (billing authority) and admin on the graph (operational authority). Not allowed on shared repositories.
|
|
595
|
+
* Permanently destroys a user graph and cancels its subscription. Two modes via the `at_period_end` body flag: omit it (or pass `false`) to tear down immediately (~10 min); pass `true` to keep the graph usable through the current billing period and tear it down at the period boundary via the existing suspend → deprovision pipeline. An immediate delete credits the unused part of the billed period; it is not refunded. On a card-billed plan the credit goes to the organization's account balance and is applied to its next invoice; on an invoiced plan it is a credit line on that period's invoice, or a separate credit invoice if that one is already paid. Requires `confirm` to equal the URL `graph_id`. Caller must be both org owner (billing authority) and admin on the graph (operational authority). Not allowed on shared repositories.
|
|
596
596
|
*
|
|
597
597
|
* **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
|
|
598
598
|
*/
|
package/sdk.gen.js
CHANGED
|
@@ -614,7 +614,7 @@ exports.listConnections = listConnections;
|
|
|
614
614
|
/**
|
|
615
615
|
* Create Connection
|
|
616
616
|
*
|
|
617
|
-
* QuickBooks and Mercury: returns a pending connection — complete the OAuth flow to activate (Mercury may instead connect at once with a personal API token where the deployment allows it). External: registers a source namespace for an integration that writes through the public API. One connection allowed per provider per graph, except 'external' which allows one per source_name and 'plaid' which allows one per bank login (a connection still waiting on Link is returned instead of a second). Plaid: returns a pending connection — `POST /oauth/init` returns a `link_token` for Plaid Link. A bank feed (Mercury, Plaid) names the entity its accounts book to (`entity_id`, the group parent when omitted) and is refused (409) when that entity has no chart of accounts or is the one QuickBooks keeps
|
|
617
|
+
* QuickBooks and Mercury: returns a pending connection — complete the OAuth flow to activate (Mercury may instead connect at once with a personal API token where the deployment allows it). External: registers a source namespace for an integration that writes through the public API. One connection allowed per provider per graph, except 'external' which allows one per source_name and 'plaid' which allows one per bank login (a connection still waiting on Link is returned instead of a second). Plaid: returns a pending connection — `POST /oauth/init` returns a `link_token` for Plaid Link. A bank feed (Mercury, Plaid) names the entity its accounts book to (`entity_id`, the group parent when omitted) and is refused (409) when that entity has no chart of accounts or is the one QuickBooks keeps. QuickBooks keeps the group parent's books only: `entity_id` may be omitted, and naming a subsidiary is refused (409 PARENT_ONLY); it is refused (409) too when the group parent's books are already native. Every connection's `entity_id` is the entity whose books it keeps.
|
|
618
618
|
*/
|
|
619
619
|
const createConnection = (options) => (options.client ?? client_gen_1.client).post({
|
|
620
620
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -1208,7 +1208,7 @@ exports.deleteSubgraph = deleteSubgraph;
|
|
|
1208
1208
|
/**
|
|
1209
1209
|
* Delete Graph
|
|
1210
1210
|
*
|
|
1211
|
-
* Permanently destroys a user graph and cancels its subscription. Two modes via the `at_period_end` body flag: omit it (or pass `false`) to tear down immediately (~10 min); pass `true` to keep the graph usable through the current billing period and tear it down at the period boundary via the existing suspend → deprovision pipeline. Requires `confirm` to equal the URL `graph_id`. Caller must be both org owner (billing authority) and admin on the graph (operational authority). Not allowed on shared repositories.
|
|
1211
|
+
* Permanently destroys a user graph and cancels its subscription. Two modes via the `at_period_end` body flag: omit it (or pass `false`) to tear down immediately (~10 min); pass `true` to keep the graph usable through the current billing period and tear it down at the period boundary via the existing suspend → deprovision pipeline. An immediate delete credits the unused part of the billed period; it is not refunded. On a card-billed plan the credit goes to the organization's account balance and is applied to its next invoice; on an invoiced plan it is a credit line on that period's invoice, or a separate credit invoice if that one is already paid. Requires `confirm` to equal the URL `graph_id`. Caller must be both org owner (billing authority) and admin on the graph (operational authority). Not allowed on shared repositories.
|
|
1212
1212
|
*
|
|
1213
1213
|
* **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
|
|
1214
1214
|
*/
|
package/sdk.gen.ts
CHANGED
|
@@ -625,7 +625,7 @@ export const listConnections = <ThrowOnError extends boolean = false>(options: O
|
|
|
625
625
|
/**
|
|
626
626
|
* Create Connection
|
|
627
627
|
*
|
|
628
|
-
* QuickBooks and Mercury: returns a pending connection — complete the OAuth flow to activate (Mercury may instead connect at once with a personal API token where the deployment allows it). External: registers a source namespace for an integration that writes through the public API. One connection allowed per provider per graph, except 'external' which allows one per source_name and 'plaid' which allows one per bank login (a connection still waiting on Link is returned instead of a second). Plaid: returns a pending connection — `POST /oauth/init` returns a `link_token` for Plaid Link. A bank feed (Mercury, Plaid) names the entity its accounts book to (`entity_id`, the group parent when omitted) and is refused (409) when that entity has no chart of accounts or is the one QuickBooks keeps
|
|
628
|
+
* QuickBooks and Mercury: returns a pending connection — complete the OAuth flow to activate (Mercury may instead connect at once with a personal API token where the deployment allows it). External: registers a source namespace for an integration that writes through the public API. One connection allowed per provider per graph, except 'external' which allows one per source_name and 'plaid' which allows one per bank login (a connection still waiting on Link is returned instead of a second). Plaid: returns a pending connection — `POST /oauth/init` returns a `link_token` for Plaid Link. A bank feed (Mercury, Plaid) names the entity its accounts book to (`entity_id`, the group parent when omitted) and is refused (409) when that entity has no chart of accounts or is the one QuickBooks keeps. QuickBooks keeps the group parent's books only: `entity_id` may be omitted, and naming a subsidiary is refused (409 PARENT_ONLY); it is refused (409) too when the group parent's books are already native. Every connection's `entity_id` is the entity whose books it keeps.
|
|
629
629
|
*/
|
|
630
630
|
export const createConnection = <ThrowOnError extends boolean = false>(options: Options<CreateConnectionData, ThrowOnError>): RequestResult<CreateConnectionResponses, CreateConnectionErrors, ThrowOnError> => (options.client ?? client).post<CreateConnectionResponses, CreateConnectionErrors, ThrowOnError>({
|
|
631
631
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -1219,7 +1219,7 @@ export const deleteSubgraph = <ThrowOnError extends boolean = false>(options: Op
|
|
|
1219
1219
|
/**
|
|
1220
1220
|
* Delete Graph
|
|
1221
1221
|
*
|
|
1222
|
-
* Permanently destroys a user graph and cancels its subscription. Two modes via the `at_period_end` body flag: omit it (or pass `false`) to tear down immediately (~10 min); pass `true` to keep the graph usable through the current billing period and tear it down at the period boundary via the existing suspend → deprovision pipeline. Requires `confirm` to equal the URL `graph_id`. Caller must be both org owner (billing authority) and admin on the graph (operational authority). Not allowed on shared repositories.
|
|
1222
|
+
* Permanently destroys a user graph and cancels its subscription. Two modes via the `at_period_end` body flag: omit it (or pass `false`) to tear down immediately (~10 min); pass `true` to keep the graph usable through the current billing period and tear it down at the period boundary via the existing suspend → deprovision pipeline. An immediate delete credits the unused part of the billed period; it is not refunded. On a card-billed plan the credit goes to the organization's account balance and is applied to its next invoice; on an invoiced plan it is a credit line on that period's invoice, or a separate credit invoice if that one is already paid. Requires `confirm` to equal the URL `graph_id`. Caller must be both org owner (billing authority) and admin on the graph (operational authority). Not allowed on shared repositories.
|
|
1223
1223
|
*
|
|
1224
1224
|
* **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
|
|
1225
1225
|
*/
|
package/types.gen.d.ts
CHANGED
|
@@ -2524,7 +2524,7 @@ export type ConnectionResponse = {
|
|
|
2524
2524
|
/**
|
|
2525
2525
|
* Entity Id
|
|
2526
2526
|
*
|
|
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
2530
|
/**
|
|
@@ -3100,7 +3100,7 @@ export type CreateConnectionRequest = {
|
|
|
3100
3100
|
/**
|
|
3101
3101
|
* Entity Id
|
|
3102
3102
|
*
|
|
3103
|
-
*
|
|
3103
|
+
* QuickBooks: the entity whose books it keeps, which can only be the group parent; omit it. A bank feed names its entity on its own config.
|
|
3104
3104
|
*/
|
|
3105
3105
|
entity_id?: string | null;
|
|
3106
3106
|
quickbooks_config?: QuickBooksConnectionConfig | null;
|
|
@@ -4779,7 +4779,11 @@ export type DeleteForecastRequest = {
|
|
|
4779
4779
|
*
|
|
4780
4780
|
* - **Immediate** (default): subscription canceled now (`ends_at = now`) and
|
|
4781
4781
|
* fast-path deprovisioning fires within ~10 minutes. Use when you want
|
|
4782
|
-
* the data gone and the slot freed right away.
|
|
4782
|
+
* the data gone and the slot freed right away. The unused part of the
|
|
4783
|
+
* billed period is credited, not refunded: on a card-billed plan to the
|
|
4784
|
+
* organization's account balance, applied to its next invoice; on an
|
|
4785
|
+
* invoiced plan as a credit on that period's invoice, or a separate credit
|
|
4786
|
+
* invoice if it is already paid.
|
|
4783
4787
|
* - **At period end** (`at_period_end=true`): subscription canceled but
|
|
4784
4788
|
* `ends_at = current_period_end` so the graph stays usable through the
|
|
4785
4789
|
* paid period. The existing suspend → deprovision sensor pipeline tears
|
|
@@ -18984,6 +18988,12 @@ export type SsoCompleteRequest = {
|
|
|
18984
18988
|
* Temporary session ID from secure handoff
|
|
18985
18989
|
*/
|
|
18986
18990
|
session_id: string;
|
|
18991
|
+
/**
|
|
18992
|
+
* Browser Nonce
|
|
18993
|
+
*
|
|
18994
|
+
* The nonce this browser minted when it started the bridge; its SHA-256 was passed through the exchange as browser_nonce_hash.
|
|
18995
|
+
*/
|
|
18996
|
+
browser_nonce?: string | null;
|
|
18987
18997
|
};
|
|
18988
18998
|
/**
|
|
18989
18999
|
* SSOExchangeRequest
|
|
@@ -19009,6 +19019,12 @@ export type SsoExchangeRequest = {
|
|
|
19009
19019
|
* Optional return URL after authentication
|
|
19010
19020
|
*/
|
|
19011
19021
|
return_url?: string | null;
|
|
19022
|
+
/**
|
|
19023
|
+
* Browser Nonce Hash
|
|
19024
|
+
*
|
|
19025
|
+
* SHA-256 (hex) of a nonce the target app minted in the browser that is signing in. Completion must present the nonce, so the handoff cannot be redeemed by any other browser.
|
|
19026
|
+
*/
|
|
19027
|
+
browser_nonce_hash?: string | null;
|
|
19012
19028
|
};
|
|
19013
19029
|
/**
|
|
19014
19030
|
* SSOExchangeResponse
|
|
@@ -22332,9 +22348,15 @@ export type UpdateEventHandlerRequest = {
|
|
|
22332
22348
|
/**
|
|
22333
22349
|
* Approve
|
|
22334
22350
|
*
|
|
22335
|
-
* Approval shortcut: True stamps approved_by/approved_at to the current user; False clears both.
|
|
22351
|
+
* Approval shortcut: True stamps approved_by/approved_at to the current user; False clears both. Approving an AI-suggested handler also needs `expected_updated_at`.
|
|
22336
22352
|
*/
|
|
22337
22353
|
approve?: boolean | null;
|
|
22354
|
+
/**
|
|
22355
|
+
* Expected Updated At
|
|
22356
|
+
*
|
|
22357
|
+
* The handler's `updated_at` as shown when it was reviewed. Required with `approve=true` on an AI-suggested handler, so the approval covers exactly that version; a mismatch is refused with 409.
|
|
22358
|
+
*/
|
|
22359
|
+
expected_updated_at?: string | null;
|
|
22338
22360
|
/**
|
|
22339
22361
|
* Metadata Patch
|
|
22340
22362
|
*
|
|
@@ -25772,7 +25794,7 @@ export type ListConnectionsData = {
|
|
|
25772
25794
|
/**
|
|
25773
25795
|
* Entity Id
|
|
25774
25796
|
*
|
|
25775
|
-
*
|
|
25797
|
+
* Only the connections that keep this entity's books
|
|
25776
25798
|
*/
|
|
25777
25799
|
entity_id?: string | null;
|
|
25778
25800
|
/**
|
package/types.gen.ts
CHANGED
|
@@ -2588,7 +2588,7 @@ export type ConnectionResponse = {
|
|
|
2588
2588
|
/**
|
|
2589
2589
|
* Entity Id
|
|
2590
2590
|
*
|
|
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
2594
|
/**
|
|
@@ -3177,7 +3177,7 @@ export type CreateConnectionRequest = {
|
|
|
3177
3177
|
/**
|
|
3178
3178
|
* Entity Id
|
|
3179
3179
|
*
|
|
3180
|
-
*
|
|
3180
|
+
* QuickBooks: the entity whose books it keeps, which can only be the group parent; omit it. A bank feed names its entity on its own config.
|
|
3181
3181
|
*/
|
|
3182
3182
|
entity_id?: string | null;
|
|
3183
3183
|
quickbooks_config?: QuickBooksConnectionConfig | null;
|
|
@@ -4888,7 +4888,11 @@ export type DeleteForecastRequest = {
|
|
|
4888
4888
|
*
|
|
4889
4889
|
* - **Immediate** (default): subscription canceled now (`ends_at = now`) and
|
|
4890
4890
|
* fast-path deprovisioning fires within ~10 minutes. Use when you want
|
|
4891
|
-
* the data gone and the slot freed right away.
|
|
4891
|
+
* the data gone and the slot freed right away. The unused part of the
|
|
4892
|
+
* billed period is credited, not refunded: on a card-billed plan to the
|
|
4893
|
+
* organization's account balance, applied to its next invoice; on an
|
|
4894
|
+
* invoiced plan as a credit on that period's invoice, or a separate credit
|
|
4895
|
+
* invoice if it is already paid.
|
|
4892
4896
|
* - **At period end** (`at_period_end=true`): subscription canceled but
|
|
4893
4897
|
* `ends_at = current_period_end` so the graph stays usable through the
|
|
4894
4898
|
* paid period. The existing suspend → deprovision sensor pipeline tears
|
|
@@ -19422,6 +19426,12 @@ export type SsoCompleteRequest = {
|
|
|
19422
19426
|
* Temporary session ID from secure handoff
|
|
19423
19427
|
*/
|
|
19424
19428
|
session_id: string;
|
|
19429
|
+
/**
|
|
19430
|
+
* Browser Nonce
|
|
19431
|
+
*
|
|
19432
|
+
* The nonce this browser minted when it started the bridge; its SHA-256 was passed through the exchange as browser_nonce_hash.
|
|
19433
|
+
*/
|
|
19434
|
+
browser_nonce?: string | null;
|
|
19425
19435
|
};
|
|
19426
19436
|
|
|
19427
19437
|
/**
|
|
@@ -19448,6 +19458,12 @@ export type SsoExchangeRequest = {
|
|
|
19448
19458
|
* Optional return URL after authentication
|
|
19449
19459
|
*/
|
|
19450
19460
|
return_url?: string | null;
|
|
19461
|
+
/**
|
|
19462
|
+
* Browser Nonce Hash
|
|
19463
|
+
*
|
|
19464
|
+
* SHA-256 (hex) of a nonce the target app minted in the browser that is signing in. Completion must present the nonce, so the handoff cannot be redeemed by any other browser.
|
|
19465
|
+
*/
|
|
19466
|
+
browser_nonce_hash?: string | null;
|
|
19451
19467
|
};
|
|
19452
19468
|
|
|
19453
19469
|
/**
|
|
@@ -22852,9 +22868,15 @@ export type UpdateEventHandlerRequest = {
|
|
|
22852
22868
|
/**
|
|
22853
22869
|
* Approve
|
|
22854
22870
|
*
|
|
22855
|
-
* Approval shortcut: True stamps approved_by/approved_at to the current user; False clears both.
|
|
22871
|
+
* Approval shortcut: True stamps approved_by/approved_at to the current user; False clears both. Approving an AI-suggested handler also needs `expected_updated_at`.
|
|
22856
22872
|
*/
|
|
22857
22873
|
approve?: boolean | null;
|
|
22874
|
+
/**
|
|
22875
|
+
* Expected Updated At
|
|
22876
|
+
*
|
|
22877
|
+
* The handler's `updated_at` as shown when it was reviewed. Required with `approve=true` on an AI-suggested handler, so the approval covers exactly that version; a mismatch is refused with 409.
|
|
22878
|
+
*/
|
|
22879
|
+
expected_updated_at?: string | null;
|
|
22858
22880
|
/**
|
|
22859
22881
|
* Metadata Patch
|
|
22860
22882
|
*
|
|
@@ -26601,7 +26623,7 @@ export type ListConnectionsData = {
|
|
|
26601
26623
|
/**
|
|
26602
26624
|
* Entity Id
|
|
26603
26625
|
*
|
|
26604
|
-
*
|
|
26626
|
+
* Only the connections that keep this entity's books
|
|
26605
26627
|
*/
|
|
26606
26628
|
entity_id?: string | null;
|
|
26607
26629
|
/**
|