@stigg/typescript 0.1.0-beta.36 → 0.1.0-beta.38
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/CHANGELOG.md +16 -0
- package/client.d.mts +1 -1
- package/client.d.ts +1 -1
- package/client.js +3 -3
- package/client.js.map +1 -1
- package/client.mjs +3 -3
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/v1/events/beta/customers.d.mts +3 -3
- package/resources/v1/events/beta/customers.d.mts.map +1 -1
- package/resources/v1/events/beta/customers.d.ts +3 -3
- package/resources/v1/events/beta/customers.d.ts.map +1 -1
- package/resources/v1-beta/customers/assignments.d.mts +29 -25
- package/resources/v1-beta/customers/assignments.d.mts.map +1 -1
- package/resources/v1-beta/customers/assignments.d.ts +29 -25
- package/resources/v1-beta/customers/assignments.d.ts.map +1 -1
- package/resources/v1-beta/customers/entities.d.mts +25 -25
- package/resources/v1-beta/customers/entities.d.mts.map +1 -1
- package/resources/v1-beta/customers/entities.d.ts +25 -25
- package/resources/v1-beta/customers/entities.d.ts.map +1 -1
- package/resources/v1-beta/customers/entities.js +2 -2
- package/resources/v1-beta/customers/entities.mjs +2 -2
- package/src/client.ts +3 -3
- package/src/resources/v1/events/beta/customers.ts +3 -3
- package/src/resources/v1-beta/customers/assignments.ts +30 -25
- package/src/resources/v1-beta/customers/entities.ts +26 -26
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -71,18 +71,17 @@ export interface AssignmentListResponse {
|
|
|
71
71
|
*/
|
|
72
72
|
createdAt: string;
|
|
73
73
|
/**
|
|
74
|
-
* The entity
|
|
74
|
+
* The entity ID this assignment is attached to
|
|
75
75
|
*/
|
|
76
76
|
entityId: string;
|
|
77
77
|
/**
|
|
78
|
-
* Parent entity
|
|
78
|
+
* Parent entity ID in the hierarchy, or `null` for a root.
|
|
79
79
|
*/
|
|
80
80
|
parentId: string | null;
|
|
81
81
|
/**
|
|
82
|
-
* Dimension-scoped sub-budget key: the set of entity
|
|
83
|
-
*
|
|
84
|
-
*
|
|
85
|
-
* (order-insensitive).
|
|
82
|
+
* Dimension-scoped sub-budget key: the set of entity IDs this budget applies to.
|
|
83
|
+
* Empty is the node-wide budget that always matches; a non-empty set only applies
|
|
84
|
+
* when every listed entity is present in the resolved set (order-insensitive).
|
|
86
85
|
*/
|
|
87
86
|
scopeEntityIds: Array<string>;
|
|
88
87
|
/**
|
|
@@ -94,11 +93,11 @@ export interface AssignmentListResponse {
|
|
|
94
93
|
*/
|
|
95
94
|
usageLimit: number | null;
|
|
96
95
|
/**
|
|
97
|
-
* Currency
|
|
96
|
+
* Currency ID this assignment grants (present for credit capabilities).
|
|
98
97
|
*/
|
|
99
98
|
currencyId?: string;
|
|
100
99
|
/**
|
|
101
|
-
* Feature
|
|
100
|
+
* Feature ID this assignment grants (present for feature capabilities).
|
|
102
101
|
*/
|
|
103
102
|
featureId?: string;
|
|
104
103
|
}
|
|
@@ -129,18 +128,17 @@ export declare namespace AssignmentUpsertResponse {
|
|
|
129
128
|
*/
|
|
130
129
|
createdAt: string;
|
|
131
130
|
/**
|
|
132
|
-
* The entity
|
|
131
|
+
* The entity ID this assignment is attached to
|
|
133
132
|
*/
|
|
134
133
|
entityId: string;
|
|
135
134
|
/**
|
|
136
|
-
* Parent entity
|
|
135
|
+
* Parent entity ID in the hierarchy, or `null` for a root.
|
|
137
136
|
*/
|
|
138
137
|
parentId: string | null;
|
|
139
138
|
/**
|
|
140
|
-
* Dimension-scoped sub-budget key: the set of entity
|
|
141
|
-
*
|
|
142
|
-
*
|
|
143
|
-
* (order-insensitive).
|
|
139
|
+
* Dimension-scoped sub-budget key: the set of entity IDs this budget applies to.
|
|
140
|
+
* Empty is the node-wide budget that always matches; a non-empty set only applies
|
|
141
|
+
* when every listed entity is present in the resolved set (order-insensitive).
|
|
144
142
|
*/
|
|
145
143
|
scopeEntityIds: Array<string>;
|
|
146
144
|
/**
|
|
@@ -152,24 +150,30 @@ export declare namespace AssignmentUpsertResponse {
|
|
|
152
150
|
*/
|
|
153
151
|
usageLimit: number | null;
|
|
154
152
|
/**
|
|
155
|
-
* Currency
|
|
153
|
+
* Currency ID this assignment grants (present for credit capabilities).
|
|
156
154
|
*/
|
|
157
155
|
currencyId?: string;
|
|
158
156
|
/**
|
|
159
|
-
* Feature
|
|
157
|
+
* Feature ID this assignment grants (present for feature capabilities).
|
|
160
158
|
*/
|
|
161
159
|
featureId?: string;
|
|
162
160
|
}
|
|
163
161
|
}
|
|
164
162
|
export interface AssignmentListParams extends MyCursorIDPageParams {
|
|
165
163
|
/**
|
|
166
|
-
* Query param: Filter assignments to a specific
|
|
164
|
+
* Query param: Filter assignments to a specific currency, by its ID. Mutually
|
|
165
|
+
* exclusive with `featureId`.
|
|
167
166
|
*/
|
|
168
|
-
|
|
167
|
+
currencyId?: string;
|
|
169
168
|
/**
|
|
170
|
-
* Query param: Filter assignments to a specific entity
|
|
169
|
+
* Query param: Filter assignments to a specific entity ID
|
|
171
170
|
*/
|
|
172
171
|
entityId?: string;
|
|
172
|
+
/**
|
|
173
|
+
* Query param: Filter assignments to a specific feature, by its ID. Mutually
|
|
174
|
+
* exclusive with `currencyId`.
|
|
175
|
+
*/
|
|
176
|
+
featureId?: string;
|
|
173
177
|
/**
|
|
174
178
|
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
175
179
|
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
@@ -209,7 +213,7 @@ export declare namespace AssignmentUpsertParams {
|
|
|
209
213
|
*/
|
|
210
214
|
interface Assignment {
|
|
211
215
|
/**
|
|
212
|
-
* The entity
|
|
216
|
+
* The entity ID this assignment is attached to
|
|
213
217
|
*/
|
|
214
218
|
entityId: string;
|
|
215
219
|
/**
|
|
@@ -218,18 +222,18 @@ export declare namespace AssignmentUpsertParams {
|
|
|
218
222
|
*/
|
|
219
223
|
cadence?: string;
|
|
220
224
|
/**
|
|
221
|
-
* Currency
|
|
225
|
+
* Currency ID this assignment grants (credit budgets). Mutually exclusive with
|
|
222
226
|
* `featureId`.
|
|
223
227
|
*/
|
|
224
228
|
currencyId?: string;
|
|
225
229
|
/**
|
|
226
|
-
* Feature
|
|
230
|
+
* Feature ID this assignment grants. Mutually exclusive with `currencyId`.
|
|
227
231
|
*/
|
|
228
232
|
featureId?: string;
|
|
229
233
|
/**
|
|
230
|
-
* Parent entity
|
|
231
|
-
*
|
|
232
|
-
*
|
|
234
|
+
* Parent entity ID in the hierarchy. Omit to leave the current parent untouched (a
|
|
235
|
+
* new node defaults to a root); `null` detaches to a root; an ID sets or changes
|
|
236
|
+
* the parent. Reparenting an existing node is leaf-only.
|
|
233
237
|
*/
|
|
234
238
|
parentId?: string | null;
|
|
235
239
|
scopeEntityIds?: Array<string>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"assignments.d.ts","sourceRoot":"","sources":["../../../src/resources/v1-beta/customers/assignments.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,kCAA+B;AACrD,OAAO,EAAE,UAAU,EAAE,qCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,KAAK,oBAAoB,EAAE,WAAW,EAAE,oCAAiC;AAElG,OAAO,EAAE,cAAc,EAAE,6CAA0C;AAGnE,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;OAcG;IACH,IAAI,CACF,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qCAAqC,EAAE,sBAAsB,CAAC;IAmB7E;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,sBAAsB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;CAcxC;AAED,MAAM,MAAM,qCAAqC,GAAG,cAAc,CAAC,sBAAsB,CAAC,CAAC;AAE3F;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB
|
|
1
|
+
{"version":3,"file":"assignments.d.ts","sourceRoot":"","sources":["../../../src/resources/v1-beta/customers/assignments.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,kCAA+B;AACrD,OAAO,EAAE,UAAU,EAAE,qCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,KAAK,oBAAoB,EAAE,WAAW,EAAE,oCAAiC;AAElG,OAAO,EAAE,cAAc,EAAE,6CAA0C;AAGnE,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;OAcG;IACH,IAAI,CACF,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qCAAqC,EAAE,sBAAsB,CAAC;IAmB7E;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,sBAAsB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;CAcxC;AAED,MAAM,MAAM,qCAAqC,GAAG,cAAc,CAAC,sBAAsB,CAAC,CAAC;AAE3F;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;;;OAIG;IACH,cAAc,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE9B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,KAAK,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC;CAC5C;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;;;OAIG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;;;WAIG;QACH,cAAc,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE9B;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,oBAAqB,SAAQ,oBAAoB;IAChE;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC;IAEtD;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;;;;;OAMG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;WAIG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE/B;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;CACF;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
|
|
@@ -64,12 +64,12 @@ export declare class Entities extends APIResource {
|
|
|
64
64
|
* entities: [
|
|
65
65
|
* {
|
|
66
66
|
* id: 'user-7f3a0c1d',
|
|
67
|
-
*
|
|
67
|
+
* entityTypeId: 'user',
|
|
68
68
|
* metadata: { email: 'jane@acme.com', role: 'admin' },
|
|
69
69
|
* },
|
|
70
70
|
* {
|
|
71
71
|
* id: 'user-c4d1b2e9',
|
|
72
|
-
*
|
|
72
|
+
* entityTypeId: 'user',
|
|
73
73
|
* metadata: { email: 'john@acme.com' },
|
|
74
74
|
* },
|
|
75
75
|
* ],
|
|
@@ -105,16 +105,16 @@ export declare namespace EntityRetrieveResponse {
|
|
|
105
105
|
* Timestamp of when the record was created
|
|
106
106
|
*/
|
|
107
107
|
createdAt: string;
|
|
108
|
+
/**
|
|
109
|
+
* The entity type identifier this entity instantiates
|
|
110
|
+
*/
|
|
111
|
+
entityTypeId: string;
|
|
108
112
|
/**
|
|
109
113
|
* Free-form key/value metadata attached to the entity
|
|
110
114
|
*/
|
|
111
115
|
metadata: {
|
|
112
116
|
[key: string]: string;
|
|
113
117
|
};
|
|
114
|
-
/**
|
|
115
|
-
* The entity type identifier this entity instantiates
|
|
116
|
-
*/
|
|
117
|
-
typeId: string;
|
|
118
118
|
/**
|
|
119
119
|
* Timestamp of when the record was last updated
|
|
120
120
|
*/
|
|
@@ -137,16 +137,16 @@ export interface EntityListResponse {
|
|
|
137
137
|
* Timestamp of when the record was created
|
|
138
138
|
*/
|
|
139
139
|
createdAt: string;
|
|
140
|
+
/**
|
|
141
|
+
* The entity type identifier this entity instantiates
|
|
142
|
+
*/
|
|
143
|
+
entityTypeId: string;
|
|
140
144
|
/**
|
|
141
145
|
* Free-form key/value metadata attached to the entity
|
|
142
146
|
*/
|
|
143
147
|
metadata: {
|
|
144
148
|
[key: string]: string;
|
|
145
149
|
};
|
|
146
|
-
/**
|
|
147
|
-
* The entity type identifier this entity instantiates
|
|
148
|
-
*/
|
|
149
|
-
typeId: string;
|
|
150
150
|
/**
|
|
151
151
|
* Timestamp of when the record was last updated
|
|
152
152
|
*/
|
|
@@ -215,16 +215,16 @@ export declare namespace EntityUpsertResponse {
|
|
|
215
215
|
* Timestamp of when the record was created
|
|
216
216
|
*/
|
|
217
217
|
createdAt: string;
|
|
218
|
+
/**
|
|
219
|
+
* The entity type identifier this entity instantiates
|
|
220
|
+
*/
|
|
221
|
+
entityTypeId: string;
|
|
218
222
|
/**
|
|
219
223
|
* Free-form key/value metadata attached to the entity
|
|
220
224
|
*/
|
|
221
225
|
metadata: {
|
|
222
226
|
[key: string]: string;
|
|
223
227
|
};
|
|
224
|
-
/**
|
|
225
|
-
* The entity type identifier this entity instantiates
|
|
226
|
-
*/
|
|
227
|
-
typeId: string;
|
|
228
228
|
/**
|
|
229
229
|
* Timestamp of when the record was last updated
|
|
230
230
|
*/
|
|
@@ -250,14 +250,14 @@ export interface EntityRetrieveParams {
|
|
|
250
250
|
}
|
|
251
251
|
export interface EntityListParams extends MyCursorIDPageParams {
|
|
252
252
|
/**
|
|
253
|
-
* Query param:
|
|
253
|
+
* Query param: Filter results to entities of a specific entity type, by the type's
|
|
254
|
+
* ID
|
|
254
255
|
*/
|
|
255
|
-
|
|
256
|
+
entityTypeId?: string;
|
|
256
257
|
/**
|
|
257
|
-
* Query param:
|
|
258
|
-
* refId
|
|
258
|
+
* Query param: Whether to include archived entities. One of: true, false
|
|
259
259
|
*/
|
|
260
|
-
|
|
260
|
+
includeArchived?: 'true' | 'false';
|
|
261
261
|
/**
|
|
262
262
|
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
263
263
|
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
@@ -330,6 +330,12 @@ export declare namespace EntityUpsertParams {
|
|
|
330
330
|
* The unique identifier for the entity
|
|
331
331
|
*/
|
|
332
332
|
id: string;
|
|
333
|
+
/**
|
|
334
|
+
* The entity type ID this entity instantiates. Required when creating a new
|
|
335
|
+
* entity; on a re-upsert may be omitted to preserve the existing type. Governance
|
|
336
|
+
* returns 400 if missing on create.
|
|
337
|
+
*/
|
|
338
|
+
entityTypeId?: string;
|
|
333
339
|
/**
|
|
334
340
|
* Free-form key/value metadata. Patch semantics: empty-string value removes a key,
|
|
335
341
|
* omitted keys are preserved.
|
|
@@ -337,12 +343,6 @@ export declare namespace EntityUpsertParams {
|
|
|
337
343
|
metadata?: {
|
|
338
344
|
[key: string]: string;
|
|
339
345
|
};
|
|
340
|
-
/**
|
|
341
|
-
* The entity type refId this entity instantiates. Required when creating a new
|
|
342
|
-
* entity; on a re-upsert may be omitted to preserve the existing type. Governance
|
|
343
|
-
* returns 400 if missing on create.
|
|
344
|
-
*/
|
|
345
|
-
typeRefId?: string;
|
|
346
346
|
}
|
|
347
347
|
}
|
|
348
348
|
export declare namespace Entities {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"entities.d.mts","sourceRoot":"","sources":["../../../src/resources/v1-beta/customers/entities.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,mCAA+B;AACrD,OAAO,EAAE,UAAU,EAAE,sCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,KAAK,oBAAoB,EAAE,WAAW,EAAE,qCAAiC;AAElG,OAAO,EAAE,cAAc,EAAE,8CAA0C;AAGnE,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;OAUG;IACH,QAAQ,CACN,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,oBAAoB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAcrC;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iCAAiC,EAAE,kBAAkB,CAAC;IAmBrE;;;;;;;;;;OAUG;IACH,OAAO,CACL,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAepC;;;;;;;;;;OAUG;IACH,SAAS,CACP,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;IAetC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;CAc3G;AAED,MAAM,MAAM,iCAAiC,GAAG,cAAc,CAAC,kBAAkB,CAAC,CAAC;AAEnF;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC,IAAI,CAAC;CACnC;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,QAAQ,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEpC;;WAEG;QACH,
|
|
1
|
+
{"version":3,"file":"entities.d.mts","sourceRoot":"","sources":["../../../src/resources/v1-beta/customers/entities.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,mCAA+B;AACrD,OAAO,EAAE,UAAU,EAAE,sCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,KAAK,oBAAoB,EAAE,WAAW,EAAE,qCAAiC;AAElG,OAAO,EAAE,cAAc,EAAE,8CAA0C;AAGnE,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;OAUG;IACH,QAAQ,CACN,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,oBAAoB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAcrC;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iCAAiC,EAAE,kBAAkB,CAAC;IAmBrE;;;;;;;;;;OAUG;IACH,OAAO,CACL,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAepC;;;;;;;;;;OAUG;IACH,SAAS,CACP,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;IAetC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;CAc3G;AAED,MAAM,MAAM,iCAAiC,GAAG,cAAc,CAAC,kBAAkB,CAAC,CAAC;AAEnF;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC,IAAI,CAAC;CACnC;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,QAAQ,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEpC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;KACnB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;CAClC;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACpB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,IAAI,EAAE,uBAAuB,CAAC,IAAI,CAAC;CACpC;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACpB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;CACxC;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,QAAQ,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEpC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,gBAAiB,SAAQ,oBAAoB;IAC5D;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAEnC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEnB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEnB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;IAE3C;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;;WAIG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;WAGG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;KACtC;CACF;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
|
|
@@ -64,12 +64,12 @@ export declare class Entities extends APIResource {
|
|
|
64
64
|
* entities: [
|
|
65
65
|
* {
|
|
66
66
|
* id: 'user-7f3a0c1d',
|
|
67
|
-
*
|
|
67
|
+
* entityTypeId: 'user',
|
|
68
68
|
* metadata: { email: 'jane@acme.com', role: 'admin' },
|
|
69
69
|
* },
|
|
70
70
|
* {
|
|
71
71
|
* id: 'user-c4d1b2e9',
|
|
72
|
-
*
|
|
72
|
+
* entityTypeId: 'user',
|
|
73
73
|
* metadata: { email: 'john@acme.com' },
|
|
74
74
|
* },
|
|
75
75
|
* ],
|
|
@@ -105,16 +105,16 @@ export declare namespace EntityRetrieveResponse {
|
|
|
105
105
|
* Timestamp of when the record was created
|
|
106
106
|
*/
|
|
107
107
|
createdAt: string;
|
|
108
|
+
/**
|
|
109
|
+
* The entity type identifier this entity instantiates
|
|
110
|
+
*/
|
|
111
|
+
entityTypeId: string;
|
|
108
112
|
/**
|
|
109
113
|
* Free-form key/value metadata attached to the entity
|
|
110
114
|
*/
|
|
111
115
|
metadata: {
|
|
112
116
|
[key: string]: string;
|
|
113
117
|
};
|
|
114
|
-
/**
|
|
115
|
-
* The entity type identifier this entity instantiates
|
|
116
|
-
*/
|
|
117
|
-
typeId: string;
|
|
118
118
|
/**
|
|
119
119
|
* Timestamp of when the record was last updated
|
|
120
120
|
*/
|
|
@@ -137,16 +137,16 @@ export interface EntityListResponse {
|
|
|
137
137
|
* Timestamp of when the record was created
|
|
138
138
|
*/
|
|
139
139
|
createdAt: string;
|
|
140
|
+
/**
|
|
141
|
+
* The entity type identifier this entity instantiates
|
|
142
|
+
*/
|
|
143
|
+
entityTypeId: string;
|
|
140
144
|
/**
|
|
141
145
|
* Free-form key/value metadata attached to the entity
|
|
142
146
|
*/
|
|
143
147
|
metadata: {
|
|
144
148
|
[key: string]: string;
|
|
145
149
|
};
|
|
146
|
-
/**
|
|
147
|
-
* The entity type identifier this entity instantiates
|
|
148
|
-
*/
|
|
149
|
-
typeId: string;
|
|
150
150
|
/**
|
|
151
151
|
* Timestamp of when the record was last updated
|
|
152
152
|
*/
|
|
@@ -215,16 +215,16 @@ export declare namespace EntityUpsertResponse {
|
|
|
215
215
|
* Timestamp of when the record was created
|
|
216
216
|
*/
|
|
217
217
|
createdAt: string;
|
|
218
|
+
/**
|
|
219
|
+
* The entity type identifier this entity instantiates
|
|
220
|
+
*/
|
|
221
|
+
entityTypeId: string;
|
|
218
222
|
/**
|
|
219
223
|
* Free-form key/value metadata attached to the entity
|
|
220
224
|
*/
|
|
221
225
|
metadata: {
|
|
222
226
|
[key: string]: string;
|
|
223
227
|
};
|
|
224
|
-
/**
|
|
225
|
-
* The entity type identifier this entity instantiates
|
|
226
|
-
*/
|
|
227
|
-
typeId: string;
|
|
228
228
|
/**
|
|
229
229
|
* Timestamp of when the record was last updated
|
|
230
230
|
*/
|
|
@@ -250,14 +250,14 @@ export interface EntityRetrieveParams {
|
|
|
250
250
|
}
|
|
251
251
|
export interface EntityListParams extends MyCursorIDPageParams {
|
|
252
252
|
/**
|
|
253
|
-
* Query param:
|
|
253
|
+
* Query param: Filter results to entities of a specific entity type, by the type's
|
|
254
|
+
* ID
|
|
254
255
|
*/
|
|
255
|
-
|
|
256
|
+
entityTypeId?: string;
|
|
256
257
|
/**
|
|
257
|
-
* Query param:
|
|
258
|
-
* refId
|
|
258
|
+
* Query param: Whether to include archived entities. One of: true, false
|
|
259
259
|
*/
|
|
260
|
-
|
|
260
|
+
includeArchived?: 'true' | 'false';
|
|
261
261
|
/**
|
|
262
262
|
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
263
263
|
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
@@ -330,6 +330,12 @@ export declare namespace EntityUpsertParams {
|
|
|
330
330
|
* The unique identifier for the entity
|
|
331
331
|
*/
|
|
332
332
|
id: string;
|
|
333
|
+
/**
|
|
334
|
+
* The entity type ID this entity instantiates. Required when creating a new
|
|
335
|
+
* entity; on a re-upsert may be omitted to preserve the existing type. Governance
|
|
336
|
+
* returns 400 if missing on create.
|
|
337
|
+
*/
|
|
338
|
+
entityTypeId?: string;
|
|
333
339
|
/**
|
|
334
340
|
* Free-form key/value metadata. Patch semantics: empty-string value removes a key,
|
|
335
341
|
* omitted keys are preserved.
|
|
@@ -337,12 +343,6 @@ export declare namespace EntityUpsertParams {
|
|
|
337
343
|
metadata?: {
|
|
338
344
|
[key: string]: string;
|
|
339
345
|
};
|
|
340
|
-
/**
|
|
341
|
-
* The entity type refId this entity instantiates. Required when creating a new
|
|
342
|
-
* entity; on a re-upsert may be omitted to preserve the existing type. Governance
|
|
343
|
-
* returns 400 if missing on create.
|
|
344
|
-
*/
|
|
345
|
-
typeRefId?: string;
|
|
346
346
|
}
|
|
347
347
|
}
|
|
348
348
|
export declare namespace Entities {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../src/resources/v1-beta/customers/entities.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,kCAA+B;AACrD,OAAO,EAAE,UAAU,EAAE,qCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,KAAK,oBAAoB,EAAE,WAAW,EAAE,oCAAiC;AAElG,OAAO,EAAE,cAAc,EAAE,6CAA0C;AAGnE,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;OAUG;IACH,QAAQ,CACN,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,oBAAoB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAcrC;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iCAAiC,EAAE,kBAAkB,CAAC;IAmBrE;;;;;;;;;;OAUG;IACH,OAAO,CACL,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAepC;;;;;;;;;;OAUG;IACH,SAAS,CACP,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;IAetC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;CAc3G;AAED,MAAM,MAAM,iCAAiC,GAAG,cAAc,CAAC,kBAAkB,CAAC,CAAC;AAEnF;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC,IAAI,CAAC;CACnC;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,QAAQ,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEpC;;WAEG;QACH,
|
|
1
|
+
{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../src/resources/v1-beta/customers/entities.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,kCAA+B;AACrD,OAAO,EAAE,UAAU,EAAE,qCAAkC;AACvD,OAAO,EAAE,cAAc,EAAE,KAAK,oBAAoB,EAAE,WAAW,EAAE,oCAAiC;AAElG,OAAO,EAAE,cAAc,EAAE,6CAA0C;AAGnE,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;OAUG;IACH,QAAQ,CACN,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,oBAAoB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAcrC;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iCAAiC,EAAE,kBAAkB,CAAC;IAmBrE;;;;;;;;;;OAUG;IACH,OAAO,CACL,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAepC;;;;;;;;;;OAUG;IACH,SAAS,CACP,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;IAetC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;CAc3G;AAED,MAAM,MAAM,iCAAiC,GAAG,cAAc,CAAC,kBAAkB,CAAC,CAAC;AAEnF;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC,IAAI,CAAC;CACnC;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,QAAQ,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEpC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;KACnB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;CAClC;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACpB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,IAAI,EAAE,uBAAuB,CAAC,IAAI,CAAC;CACpC;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACpB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;CACxC;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,QAAQ,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEpC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,gBAAiB,SAAQ,oBAAoB;IAC5D;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAEnC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEnB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEnB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;IAE3C;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;;WAIG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;WAGG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;KACtC;CACF;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
|
|
@@ -119,12 +119,12 @@ class Entities extends resource_1.APIResource {
|
|
|
119
119
|
* entities: [
|
|
120
120
|
* {
|
|
121
121
|
* id: 'user-7f3a0c1d',
|
|
122
|
-
*
|
|
122
|
+
* entityTypeId: 'user',
|
|
123
123
|
* metadata: { email: 'jane@acme.com', role: 'admin' },
|
|
124
124
|
* },
|
|
125
125
|
* {
|
|
126
126
|
* id: 'user-c4d1b2e9',
|
|
127
|
-
*
|
|
127
|
+
* entityTypeId: 'user',
|
|
128
128
|
* metadata: { email: 'john@acme.com' },
|
|
129
129
|
* },
|
|
130
130
|
* ],
|
|
@@ -116,12 +116,12 @@ export class Entities extends APIResource {
|
|
|
116
116
|
* entities: [
|
|
117
117
|
* {
|
|
118
118
|
* id: 'user-7f3a0c1d',
|
|
119
|
-
*
|
|
119
|
+
* entityTypeId: 'user',
|
|
120
120
|
* metadata: { email: 'jane@acme.com', role: 'admin' },
|
|
121
121
|
* },
|
|
122
122
|
* {
|
|
123
123
|
* id: 'user-c4d1b2e9',
|
|
124
|
-
*
|
|
124
|
+
* entityTypeId: 'user',
|
|
125
125
|
* metadata: { email: 'john@acme.com' },
|
|
126
126
|
* },
|
|
127
127
|
* ],
|
package/src/client.ts
CHANGED
|
@@ -131,7 +131,7 @@ export class Stigg {
|
|
|
131
131
|
* API Client for interfacing with the Stigg API.
|
|
132
132
|
*
|
|
133
133
|
* @param {string | undefined} [opts.apiKey=process.env['STIGG_API_KEY'] ?? undefined]
|
|
134
|
-
* @param {string} [opts.baseURL=process.env['STIGG_BASE_URL'] ?? https://api.stigg.io] - Override the default base URL for the API.
|
|
134
|
+
* @param {string} [opts.baseURL=process.env['STIGG_BASE_URL'] ?? https://edge.api.stigg.io] - Override the default base URL for the API.
|
|
135
135
|
* @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
|
|
136
136
|
* @param {MergedRequestInit} [opts.fetchOptions] - Additional `RequestInit` options to be passed to `fetch` calls.
|
|
137
137
|
* @param {Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
|
|
@@ -153,7 +153,7 @@ export class Stigg {
|
|
|
153
153
|
const options: ClientOptions = {
|
|
154
154
|
apiKey,
|
|
155
155
|
...opts,
|
|
156
|
-
baseURL: baseURL || `https://api.stigg.io`,
|
|
156
|
+
baseURL: baseURL || `https://edge.api.stigg.io`,
|
|
157
157
|
};
|
|
158
158
|
|
|
159
159
|
this.baseURL = options.baseURL!;
|
|
@@ -211,7 +211,7 @@ export class Stigg {
|
|
|
211
211
|
* Check whether the base URL is set to its default.
|
|
212
212
|
*/
|
|
213
213
|
#baseURLOverridden(): boolean {
|
|
214
|
-
return this.baseURL !== 'https://api.stigg.io';
|
|
214
|
+
return this.baseURL !== 'https://edge.api.stigg.io';
|
|
215
215
|
}
|
|
216
216
|
|
|
217
217
|
protected defaultQuery(): Record<string, string | undefined> | undefined {
|
|
@@ -72,7 +72,7 @@ export namespace CustomerRetrieveGovernanceResponse {
|
|
|
72
72
|
/**
|
|
73
73
|
* External id of the entity type (e.g. `team`, `user`).
|
|
74
74
|
*/
|
|
75
|
-
|
|
75
|
+
entityTypeId: string;
|
|
76
76
|
|
|
77
77
|
/**
|
|
78
78
|
* External id of the parent entity in the tree; `null` for a root. Use it to
|
|
@@ -110,13 +110,13 @@ export namespace CustomerRetrieveGovernanceResponse {
|
|
|
110
110
|
utilization: number | null;
|
|
111
111
|
|
|
112
112
|
/**
|
|
113
|
-
* The metered currency
|
|
113
|
+
* The metered currency ID (present when the configured capability is a credit
|
|
114
114
|
* currency).
|
|
115
115
|
*/
|
|
116
116
|
currencyId?: string;
|
|
117
117
|
|
|
118
118
|
/**
|
|
119
|
-
* The metered feature
|
|
119
|
+
* The metered feature ID (present when the configured capability is a feature).
|
|
120
120
|
*/
|
|
121
121
|
featureId?: string;
|
|
122
122
|
}
|
|
@@ -120,20 +120,19 @@ export interface AssignmentListResponse {
|
|
|
120
120
|
createdAt: string;
|
|
121
121
|
|
|
122
122
|
/**
|
|
123
|
-
* The entity
|
|
123
|
+
* The entity ID this assignment is attached to
|
|
124
124
|
*/
|
|
125
125
|
entityId: string;
|
|
126
126
|
|
|
127
127
|
/**
|
|
128
|
-
* Parent entity
|
|
128
|
+
* Parent entity ID in the hierarchy, or `null` for a root.
|
|
129
129
|
*/
|
|
130
130
|
parentId: string | null;
|
|
131
131
|
|
|
132
132
|
/**
|
|
133
|
-
* Dimension-scoped sub-budget key: the set of entity
|
|
134
|
-
*
|
|
135
|
-
*
|
|
136
|
-
* (order-insensitive).
|
|
133
|
+
* Dimension-scoped sub-budget key: the set of entity IDs this budget applies to.
|
|
134
|
+
* Empty is the node-wide budget that always matches; a non-empty set only applies
|
|
135
|
+
* when every listed entity is present in the resolved set (order-insensitive).
|
|
137
136
|
*/
|
|
138
137
|
scopeEntityIds: Array<string>;
|
|
139
138
|
|
|
@@ -148,12 +147,12 @@ export interface AssignmentListResponse {
|
|
|
148
147
|
usageLimit: number | null;
|
|
149
148
|
|
|
150
149
|
/**
|
|
151
|
-
* Currency
|
|
150
|
+
* Currency ID this assignment grants (present for credit capabilities).
|
|
152
151
|
*/
|
|
153
152
|
currencyId?: string;
|
|
154
153
|
|
|
155
154
|
/**
|
|
156
|
-
* Feature
|
|
155
|
+
* Feature ID this assignment grants (present for feature capabilities).
|
|
157
156
|
*/
|
|
158
157
|
featureId?: string;
|
|
159
158
|
}
|
|
@@ -189,20 +188,19 @@ export namespace AssignmentUpsertResponse {
|
|
|
189
188
|
createdAt: string;
|
|
190
189
|
|
|
191
190
|
/**
|
|
192
|
-
* The entity
|
|
191
|
+
* The entity ID this assignment is attached to
|
|
193
192
|
*/
|
|
194
193
|
entityId: string;
|
|
195
194
|
|
|
196
195
|
/**
|
|
197
|
-
* Parent entity
|
|
196
|
+
* Parent entity ID in the hierarchy, or `null` for a root.
|
|
198
197
|
*/
|
|
199
198
|
parentId: string | null;
|
|
200
199
|
|
|
201
200
|
/**
|
|
202
|
-
* Dimension-scoped sub-budget key: the set of entity
|
|
203
|
-
*
|
|
204
|
-
*
|
|
205
|
-
* (order-insensitive).
|
|
201
|
+
* Dimension-scoped sub-budget key: the set of entity IDs this budget applies to.
|
|
202
|
+
* Empty is the node-wide budget that always matches; a non-empty set only applies
|
|
203
|
+
* when every listed entity is present in the resolved set (order-insensitive).
|
|
206
204
|
*/
|
|
207
205
|
scopeEntityIds: Array<string>;
|
|
208
206
|
|
|
@@ -217,12 +215,12 @@ export namespace AssignmentUpsertResponse {
|
|
|
217
215
|
usageLimit: number | null;
|
|
218
216
|
|
|
219
217
|
/**
|
|
220
|
-
* Currency
|
|
218
|
+
* Currency ID this assignment grants (present for credit capabilities).
|
|
221
219
|
*/
|
|
222
220
|
currencyId?: string;
|
|
223
221
|
|
|
224
222
|
/**
|
|
225
|
-
* Feature
|
|
223
|
+
* Feature ID this assignment grants (present for feature capabilities).
|
|
226
224
|
*/
|
|
227
225
|
featureId?: string;
|
|
228
226
|
}
|
|
@@ -230,15 +228,22 @@ export namespace AssignmentUpsertResponse {
|
|
|
230
228
|
|
|
231
229
|
export interface AssignmentListParams extends MyCursorIDPageParams {
|
|
232
230
|
/**
|
|
233
|
-
* Query param: Filter assignments to a specific
|
|
231
|
+
* Query param: Filter assignments to a specific currency, by its ID. Mutually
|
|
232
|
+
* exclusive with `featureId`.
|
|
234
233
|
*/
|
|
235
|
-
|
|
234
|
+
currencyId?: string;
|
|
236
235
|
|
|
237
236
|
/**
|
|
238
|
-
* Query param: Filter assignments to a specific entity
|
|
237
|
+
* Query param: Filter assignments to a specific entity ID
|
|
239
238
|
*/
|
|
240
239
|
entityId?: string;
|
|
241
240
|
|
|
241
|
+
/**
|
|
242
|
+
* Query param: Filter assignments to a specific feature, by its ID. Mutually
|
|
243
|
+
* exclusive with `currencyId`.
|
|
244
|
+
*/
|
|
245
|
+
featureId?: string;
|
|
246
|
+
|
|
242
247
|
/**
|
|
243
248
|
* Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
244
249
|
* token); falls back to the user's first membership. Ignored for API-key auth.
|
|
@@ -283,7 +288,7 @@ export namespace AssignmentUpsertParams {
|
|
|
283
288
|
*/
|
|
284
289
|
export interface Assignment {
|
|
285
290
|
/**
|
|
286
|
-
* The entity
|
|
291
|
+
* The entity ID this assignment is attached to
|
|
287
292
|
*/
|
|
288
293
|
entityId: string;
|
|
289
294
|
|
|
@@ -294,20 +299,20 @@ export namespace AssignmentUpsertParams {
|
|
|
294
299
|
cadence?: string;
|
|
295
300
|
|
|
296
301
|
/**
|
|
297
|
-
* Currency
|
|
302
|
+
* Currency ID this assignment grants (credit budgets). Mutually exclusive with
|
|
298
303
|
* `featureId`.
|
|
299
304
|
*/
|
|
300
305
|
currencyId?: string;
|
|
301
306
|
|
|
302
307
|
/**
|
|
303
|
-
* Feature
|
|
308
|
+
* Feature ID this assignment grants. Mutually exclusive with `currencyId`.
|
|
304
309
|
*/
|
|
305
310
|
featureId?: string;
|
|
306
311
|
|
|
307
312
|
/**
|
|
308
|
-
* Parent entity
|
|
309
|
-
*
|
|
310
|
-
*
|
|
313
|
+
* Parent entity ID in the hierarchy. Omit to leave the current parent untouched (a
|
|
314
|
+
* new node defaults to a root); `null` detaches to a root; an ID sets or changes
|
|
315
|
+
* the parent. Reparenting an existing node is leaf-only.
|
|
311
316
|
*/
|
|
312
317
|
parentId?: string | null;
|
|
313
318
|
|