@datocms/cma-client 6.4.0 → 6.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/generated/Client.js +1 -1
- package/dist/cjs/generated/resources/Field.js +16 -12
- package/dist/cjs/generated/resources/Field.js.map +1 -1
- package/dist/cjs/generated/resources/Fieldset.js +8 -6
- package/dist/cjs/generated/resources/Fieldset.js.map +1 -1
- package/dist/cjs/generated/resources/Item.js +4 -4
- package/dist/cjs/generated/resources/ItemType.js +12 -9
- package/dist/cjs/generated/resources/ItemType.js.map +1 -1
- package/dist/esm/generated/ApiTypes.d.ts +181 -0
- package/dist/esm/generated/Client.js +1 -1
- package/dist/esm/generated/RawApiTypes.d.ts +181 -0
- package/dist/esm/generated/resources/Field.d.ts +8 -8
- package/dist/esm/generated/resources/Field.js +16 -12
- package/dist/esm/generated/resources/Field.js.map +1 -1
- package/dist/esm/generated/resources/Fieldset.d.ts +4 -4
- package/dist/esm/generated/resources/Fieldset.js +8 -6
- package/dist/esm/generated/resources/Fieldset.js.map +1 -1
- package/dist/esm/generated/resources/Item.d.ts +4 -4
- package/dist/esm/generated/resources/Item.js +4 -4
- package/dist/esm/generated/resources/ItemType.d.ts +6 -6
- package/dist/esm/generated/resources/ItemType.js +12 -9
- package/dist/esm/generated/resources/ItemType.js.map +1 -1
- package/dist/types/generated/ApiTypes.d.ts +181 -0
- package/dist/types/generated/RawApiTypes.d.ts +181 -0
- package/dist/types/generated/resources/Field.d.ts +8 -8
- package/dist/types/generated/resources/Fieldset.d.ts +4 -4
- package/dist/types/generated/resources/Item.d.ts +4 -4
- package/dist/types/generated/resources/ItemType.d.ts +6 -6
- package/package.json +1 -1
- package/resources.json +11 -2
- package/src/generated/ApiTypes.ts +181 -0
- package/src/generated/Client.ts +1 -1
- package/src/generated/RawApiTypes.ts +181 -0
- package/src/generated/resources/Field.ts +38 -13
- package/src/generated/resources/Fieldset.ts +17 -5
- package/src/generated/resources/Item.ts +4 -4
- package/src/generated/resources/ItemType.ts +27 -11
|
@@ -120,8 +120,8 @@ export default class ItemType extends BaseResource {
|
|
|
120
120
|
* @throws {ApiError}
|
|
121
121
|
* @throws {TimeoutError}
|
|
122
122
|
*/
|
|
123
|
-
list() {
|
|
124
|
-
return this.rawList().then((body) => Utils.deserializeResponseBody(body));
|
|
123
|
+
list(queryParams) {
|
|
124
|
+
return this.rawList(queryParams).then((body) => Utils.deserializeResponseBody(body));
|
|
125
125
|
}
|
|
126
126
|
/**
|
|
127
127
|
* List all models/block models
|
|
@@ -131,10 +131,11 @@ export default class ItemType extends BaseResource {
|
|
|
131
131
|
* @throws {ApiError}
|
|
132
132
|
* @throws {TimeoutError}
|
|
133
133
|
*/
|
|
134
|
-
rawList() {
|
|
134
|
+
rawList(queryParams) {
|
|
135
135
|
return this.client.request({
|
|
136
136
|
method: 'GET',
|
|
137
137
|
url: '/item-types',
|
|
138
|
+
queryParams,
|
|
138
139
|
});
|
|
139
140
|
}
|
|
140
141
|
/**
|
|
@@ -145,8 +146,8 @@ export default class ItemType extends BaseResource {
|
|
|
145
146
|
* @throws {ApiError}
|
|
146
147
|
* @throws {TimeoutError}
|
|
147
148
|
*/
|
|
148
|
-
find(itemTypeId) {
|
|
149
|
-
return this.rawFind(Utils.toId(itemTypeId)).then((body) => Utils.deserializeResponseBody(body));
|
|
149
|
+
find(itemTypeId, queryParams) {
|
|
150
|
+
return this.rawFind(Utils.toId(itemTypeId), queryParams).then((body) => Utils.deserializeResponseBody(body));
|
|
150
151
|
}
|
|
151
152
|
/**
|
|
152
153
|
* Retrieve a model/block model
|
|
@@ -156,10 +157,11 @@ export default class ItemType extends BaseResource {
|
|
|
156
157
|
* @throws {ApiError}
|
|
157
158
|
* @throws {TimeoutError}
|
|
158
159
|
*/
|
|
159
|
-
rawFind(itemTypeId) {
|
|
160
|
+
rawFind(itemTypeId, queryParams) {
|
|
160
161
|
return this.client.request({
|
|
161
162
|
method: 'GET',
|
|
162
163
|
url: `/item-types/${itemTypeId}`,
|
|
164
|
+
queryParams,
|
|
163
165
|
});
|
|
164
166
|
}
|
|
165
167
|
/**
|
|
@@ -221,8 +223,8 @@ export default class ItemType extends BaseResource {
|
|
|
221
223
|
* @throws {ApiError}
|
|
222
224
|
* @throws {TimeoutError}
|
|
223
225
|
*/
|
|
224
|
-
referencing(itemTypeId) {
|
|
225
|
-
return this.rawReferencing(Utils.toId(itemTypeId)).then((body) => Utils.deserializeResponseBody(body));
|
|
226
|
+
referencing(itemTypeId, queryParams) {
|
|
227
|
+
return this.rawReferencing(Utils.toId(itemTypeId), queryParams).then((body) => Utils.deserializeResponseBody(body));
|
|
226
228
|
}
|
|
227
229
|
/**
|
|
228
230
|
* List models referencing another model/block
|
|
@@ -232,10 +234,11 @@ export default class ItemType extends BaseResource {
|
|
|
232
234
|
* @throws {ApiError}
|
|
233
235
|
* @throws {TimeoutError}
|
|
234
236
|
*/
|
|
235
|
-
rawReferencing(itemTypeId) {
|
|
237
|
+
rawReferencing(itemTypeId, queryParams) {
|
|
236
238
|
return this.client.request({
|
|
237
239
|
method: 'GET',
|
|
238
240
|
url: `/item-types/${itemTypeId}/referencing`,
|
|
241
|
+
queryParams,
|
|
239
242
|
});
|
|
240
243
|
}
|
|
241
244
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ItemType.js","sourceRoot":"","sources":["../../../../src/generated/resources/ItemType.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,4BAA4B,CAAC;AACpD,OAAO,YAAY,MAAM,uBAAuB,CAAC;AAIjD,MAAM,CAAC,OAAO,OAAO,QAAS,SAAQ,YAAY;IAGhD;;;;;;;OAOG;IACH,MAAM,CACJ,IAAmC,EACnC,WAA+C;QAE/C,OAAO,IAAI,CAAC,SAAS,CACnB,KAAK,CAAC,oBAAoB,CAAmC,IAAI,EAAE;YACjE,IAAI,EAAE,WAAW;YACjB,UAAU,EAAE;gBACV,MAAM;gBACN,SAAS;gBACT,WAAW;gBACX,sBAAsB;gBACtB,UAAU;gBACV,eAAe;gBACf,mBAAmB;gBACnB,qBAAqB;gBACrB,MAAM;gBACN,oBAAoB;gBACpB,eAAe;gBACf,wBAAwB;gBACxB,uBAAuB;gBACvB,MAAM;gBACN,+BAA+B;aAChC;YACD,aAAa,EAAE;gBACb,gBAAgB;gBAChB,0BAA0B;gBAC1B,0BAA0B;gBAC1B,aAAa;gBACb,qBAAqB;gBACrB,eAAe;gBACf,UAAU;aACX;SACF,CAAC,EACF,WAAW,CACZ,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CACd,KAAK,CAAC,uBAAuB,CAAsC,IAAI,CAAC,CACzE,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,SAAS,CACP,IAAsC,EACtC,WAAkD;QAElD,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAyC;YACjE,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,aAAa;YAClB,IAAI;YACJ,WAAW;SACZ,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CACJ,UAA0C,EAC1C,IAAmC;QAEnC,OAAO,IAAI,CAAC,SAAS,CACnB,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,EACtB,KAAK,CAAC,oBAAoB,CAAmC,IAAI,EAAE;YACjE,EAAE,EAAE,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC;YAC1B,IAAI,EAAE,WAAW;YACjB,UAAU,EAAE;gBACV,MAAM;gBACN,SAAS;gBACT,wBAAwB;gBACxB,uBAAuB;gBACvB,WAAW;gBACX,sBAAsB;gBACtB,UAAU;gBACV,eAAe;gBACf,mBAAmB;gBACnB,qBAAqB;gBACrB,MAAM;gBACN,oBAAoB;gBACpB,eAAe;gBACf,oBAAoB;gBACpB,MAAM;gBACN,+BAA+B;aAChC;YACD,aAAa,EAAE;gBACb,gBAAgB;gBAChB,0BAA0B;gBAC1B,0BAA0B;gBAC1B,aAAa;gBACb,qBAAqB;gBACrB,eAAe;gBACf,UAAU;aACX;SACF,CAAC,CACH,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CACd,KAAK,CAAC,uBAAuB,CAAmC,IAAI,CAAC,CACtE,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,SAAS,CACP,UAAkB,EAClB,IAAsC;QAEtC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAsC;YAC9D,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,eAAe,UAAU,EAAE;YAChC,IAAI;SACL,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,IAAI;
|
|
1
|
+
{"version":3,"file":"ItemType.js","sourceRoot":"","sources":["../../../../src/generated/resources/ItemType.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,4BAA4B,CAAC;AACpD,OAAO,YAAY,MAAM,uBAAuB,CAAC;AAIjD,MAAM,CAAC,OAAO,OAAO,QAAS,SAAQ,YAAY;IAGhD;;;;;;;OAOG;IACH,MAAM,CACJ,IAAmC,EACnC,WAA+C;QAE/C,OAAO,IAAI,CAAC,SAAS,CACnB,KAAK,CAAC,oBAAoB,CAAmC,IAAI,EAAE;YACjE,IAAI,EAAE,WAAW;YACjB,UAAU,EAAE;gBACV,MAAM;gBACN,SAAS;gBACT,WAAW;gBACX,sBAAsB;gBACtB,UAAU;gBACV,eAAe;gBACf,mBAAmB;gBACnB,qBAAqB;gBACrB,MAAM;gBACN,oBAAoB;gBACpB,eAAe;gBACf,wBAAwB;gBACxB,uBAAuB;gBACvB,MAAM;gBACN,+BAA+B;aAChC;YACD,aAAa,EAAE;gBACb,gBAAgB;gBAChB,0BAA0B;gBAC1B,0BAA0B;gBAC1B,aAAa;gBACb,qBAAqB;gBACrB,eAAe;gBACf,UAAU;aACX;SACF,CAAC,EACF,WAAW,CACZ,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CACd,KAAK,CAAC,uBAAuB,CAAsC,IAAI,CAAC,CACzE,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,SAAS,CACP,IAAsC,EACtC,WAAkD;QAElD,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAyC;YACjE,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,aAAa;YAClB,IAAI;YACJ,WAAW;SACZ,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CACJ,UAA0C,EAC1C,IAAmC;QAEnC,OAAO,IAAI,CAAC,SAAS,CACnB,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,EACtB,KAAK,CAAC,oBAAoB,CAAmC,IAAI,EAAE;YACjE,EAAE,EAAE,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC;YAC1B,IAAI,EAAE,WAAW;YACjB,UAAU,EAAE;gBACV,MAAM;gBACN,SAAS;gBACT,wBAAwB;gBACxB,uBAAuB;gBACvB,WAAW;gBACX,sBAAsB;gBACtB,UAAU;gBACV,eAAe;gBACf,mBAAmB;gBACnB,qBAAqB;gBACrB,MAAM;gBACN,oBAAoB;gBACpB,eAAe;gBACf,oBAAoB;gBACpB,MAAM;gBACN,+BAA+B;aAChC;YACD,aAAa,EAAE;gBACb,gBAAgB;gBAChB,0BAA0B;gBAC1B,0BAA0B;gBAC1B,aAAa;gBACb,qBAAqB;gBACrB,eAAe;gBACf,UAAU;aACX;SACF,CAAC,CACH,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CACd,KAAK,CAAC,uBAAuB,CAAmC,IAAI,CAAC,CACtE,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,SAAS,CACP,UAAkB,EAClB,IAAsC;QAEtC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAsC;YAC9D,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,eAAe,UAAU,EAAE;YAChC,IAAI;SACL,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CAAC,WAAkD;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAC7C,KAAK,CAAC,uBAAuB,CAC3B,IAAI,CACL,CACF,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CACL,WAAqD;QAErD,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAA4C;YACpE,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,aAAa;YAClB,WAAW;SACZ,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CACF,UAA0C,EAC1C,WAA6C;QAE7C,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,WAAW,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CACrE,KAAK,CAAC,uBAAuB,CAAoC,IAAI,CAAC,CACvE,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CACL,UAAkB,EAClB,WAAgD;QAEhD,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAuC;YAC/D,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,eAAe,UAAU,EAAE;YAChC,WAAW;SACZ,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,SAAS,CAAC,UAA0C;QAClD,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAC7D,KAAK,CAAC,uBAAuB,CAC3B,IAAI,CACL,CACF,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,YAAY,CACV,UAAkB;QAElB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAA4C;YACpE,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,eAAe,UAAU,YAAY;SAC3C,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CACL,UAA0C,EAC1C,WAAgD;QAEhD,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,WAAW,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CACxE,KAAK,CAAC,uBAAuB,CAAoC,IAAI,CAAC,CACvE,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,UAAU,CACR,UAAkB,EAClB,WAAmD;QAEnD,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAuC;YAC/D,MAAM,EAAE,QAAQ;YAChB,GAAG,EAAE,eAAe,UAAU,EAAE;YAChC,WAAW;SACZ,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,WAAW,CACT,UAA0C,EAC1C,WAAoD;QAEpD,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,WAAW,CAAC,CAAC,IAAI,CAClE,CAAC,IAAI,EAAE,EAAE,CACP,KAAK,CAAC,uBAAuB,CAC3B,IAAI,CACL,CACJ,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,cAAc,CACZ,UAAkB,EAClB,WAAuD;QAEvD,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAA8C;YACtE,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,eAAe,UAAU,cAAc;YAC5C,WAAW;SACZ,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,4BAA4B,CAC1B,UAAkB,EAClB,IAAyD;QAEzD,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CACxB;YACE,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,eAAe,UAAU,+BAA+B;YAC7D,IAAI;SACL,CACF,CAAC;IACJ,CAAC;;AAlVe,aAAI,GAAG,WAAoB,CAAC"}
|
|
@@ -248,6 +248,13 @@ export type AccountIdentity = string;
|
|
|
248
248
|
* via the `definition` "type".
|
|
249
249
|
*/
|
|
250
250
|
export type AccountType = 'account';
|
|
251
|
+
/**
|
|
252
|
+
* Attributes and relationships to return for each `account` that this endpoint returns.
|
|
253
|
+
*
|
|
254
|
+
* This interface was referenced by `Account`'s JSON-Schema
|
|
255
|
+
* via the `definition` "sparse_fieldset".
|
|
256
|
+
*/
|
|
257
|
+
export type AccountSparseFieldset = string;
|
|
251
258
|
/**
|
|
252
259
|
* ID of organization
|
|
253
260
|
*
|
|
@@ -263,6 +270,13 @@ export type OrganizationIdentity = string;
|
|
|
263
270
|
* via the `definition` "type".
|
|
264
271
|
*/
|
|
265
272
|
export type OrganizationType = 'organization';
|
|
273
|
+
/**
|
|
274
|
+
* Attributes and relationships to return for each `organization` that this endpoint returns.
|
|
275
|
+
*
|
|
276
|
+
* This interface was referenced by `Organization`'s JSON-Schema
|
|
277
|
+
* via the `definition` "sparse_fieldset".
|
|
278
|
+
*/
|
|
279
|
+
export type OrganizationSparseFieldset = string;
|
|
266
280
|
/**
|
|
267
281
|
* This interface was referenced by `User`'s JSON-Schema
|
|
268
282
|
* via the `me.hrefSchema` link.
|
|
@@ -553,6 +567,13 @@ export type FieldsetIdentity = string;
|
|
|
553
567
|
* via the `definition` "type".
|
|
554
568
|
*/
|
|
555
569
|
export type WorkflowType = 'workflow';
|
|
570
|
+
/**
|
|
571
|
+
* Attributes and relationships to return for each `item_type` that this endpoint returns.
|
|
572
|
+
*
|
|
573
|
+
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
574
|
+
* via the `definition` "sparse_fieldset".
|
|
575
|
+
*/
|
|
576
|
+
export type ItemTypeSparseFieldset = string;
|
|
556
577
|
/**
|
|
557
578
|
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
558
579
|
* via the `create.hrefSchema` link.
|
|
@@ -577,6 +598,42 @@ export type ItemTypeCreateHrefSchema = {
|
|
|
577
598
|
* via the `instances.targetSchema` link.
|
|
578
599
|
*/
|
|
579
600
|
export type ItemTypeInstancesTargetSchema = ItemType[];
|
|
601
|
+
/**
|
|
602
|
+
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
603
|
+
* via the `instances.hrefSchema` link.
|
|
604
|
+
*/
|
|
605
|
+
export type ItemTypeInstancesHrefSchema = {
|
|
606
|
+
/**
|
|
607
|
+
* Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
|
|
608
|
+
*/
|
|
609
|
+
fields?: {
|
|
610
|
+
item_type?: ItemTypeSparseFieldset;
|
|
611
|
+
[k: string]: unknown;
|
|
612
|
+
};
|
|
613
|
+
[k: string]: unknown;
|
|
614
|
+
};
|
|
615
|
+
/**
|
|
616
|
+
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
617
|
+
* via the `self.hrefSchema` link.
|
|
618
|
+
*/
|
|
619
|
+
export type ItemTypeSelfHrefSchema = {
|
|
620
|
+
/**
|
|
621
|
+
* Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
|
|
622
|
+
*/
|
|
623
|
+
fields?: {
|
|
624
|
+
item_type?: ItemTypeSparseFieldset;
|
|
625
|
+
field?: FieldSparseFieldset;
|
|
626
|
+
[k: string]: unknown;
|
|
627
|
+
};
|
|
628
|
+
[k: string]: unknown;
|
|
629
|
+
};
|
|
630
|
+
/**
|
|
631
|
+
* Attributes and relationships to return for each `field` that this endpoint returns.
|
|
632
|
+
*
|
|
633
|
+
* This interface was referenced by `Field`'s JSON-Schema
|
|
634
|
+
* via the `definition` "sparse_fieldset".
|
|
635
|
+
*/
|
|
636
|
+
export type FieldSparseFieldset = string;
|
|
580
637
|
/**
|
|
581
638
|
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
582
639
|
* via the `destroy.hrefSchema` link.
|
|
@@ -593,6 +650,20 @@ export type ItemTypeDestroyHrefSchema = {
|
|
|
593
650
|
* via the `referencing.targetSchema` link.
|
|
594
651
|
*/
|
|
595
652
|
export type ItemTypeReferencingTargetSchema = ItemType[];
|
|
653
|
+
/**
|
|
654
|
+
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
655
|
+
* via the `referencing.hrefSchema` link.
|
|
656
|
+
*/
|
|
657
|
+
export type ItemTypeReferencingHrefSchema = {
|
|
658
|
+
/**
|
|
659
|
+
* Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
|
|
660
|
+
*/
|
|
661
|
+
fields?: {
|
|
662
|
+
item_type?: ItemTypeSparseFieldset;
|
|
663
|
+
[k: string]: unknown;
|
|
664
|
+
};
|
|
665
|
+
[k: string]: unknown;
|
|
666
|
+
};
|
|
596
667
|
/**
|
|
597
668
|
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
598
669
|
* via the `reorder_fields_and_fieldsets.schema` link.
|
|
@@ -618,21 +689,112 @@ export type ItemTypeReorderFieldsAndFieldsetsSchema = ({
|
|
|
618
689
|
* via the `instances.targetSchema` link.
|
|
619
690
|
*/
|
|
620
691
|
export type FieldInstancesTargetSchema = Field[];
|
|
692
|
+
/**
|
|
693
|
+
* This interface was referenced by `Field`'s JSON-Schema
|
|
694
|
+
* via the `instances.hrefSchema` link.
|
|
695
|
+
*/
|
|
696
|
+
export type FieldInstancesHrefSchema = {
|
|
697
|
+
/**
|
|
698
|
+
* Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
|
|
699
|
+
*/
|
|
700
|
+
fields?: {
|
|
701
|
+
field?: FieldSparseFieldset;
|
|
702
|
+
[k: string]: unknown;
|
|
703
|
+
};
|
|
704
|
+
[k: string]: unknown;
|
|
705
|
+
};
|
|
621
706
|
/**
|
|
622
707
|
* This interface was referenced by `Field`'s JSON-Schema
|
|
623
708
|
* via the `referencing.targetSchema` link.
|
|
624
709
|
*/
|
|
625
710
|
export type FieldReferencingTargetSchema = Field[];
|
|
711
|
+
/**
|
|
712
|
+
* This interface was referenced by `Field`'s JSON-Schema
|
|
713
|
+
* via the `referencing.hrefSchema` link.
|
|
714
|
+
*/
|
|
715
|
+
export type FieldReferencingHrefSchema = {
|
|
716
|
+
/**
|
|
717
|
+
* Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
|
|
718
|
+
*/
|
|
719
|
+
fields?: {
|
|
720
|
+
field?: FieldSparseFieldset;
|
|
721
|
+
[k: string]: unknown;
|
|
722
|
+
};
|
|
723
|
+
[k: string]: unknown;
|
|
724
|
+
};
|
|
626
725
|
/**
|
|
627
726
|
* This interface was referenced by `Field`'s JSON-Schema
|
|
628
727
|
* via the `related.targetSchema` link.
|
|
629
728
|
*/
|
|
630
729
|
export type FieldRelatedTargetSchema = Field[];
|
|
730
|
+
/**
|
|
731
|
+
* This interface was referenced by `Field`'s JSON-Schema
|
|
732
|
+
* via the `related.hrefSchema` link.
|
|
733
|
+
*/
|
|
734
|
+
export type FieldRelatedHrefSchema = {
|
|
735
|
+
/**
|
|
736
|
+
* Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
|
|
737
|
+
*/
|
|
738
|
+
fields?: {
|
|
739
|
+
field?: FieldSparseFieldset;
|
|
740
|
+
[k: string]: unknown;
|
|
741
|
+
};
|
|
742
|
+
[k: string]: unknown;
|
|
743
|
+
};
|
|
744
|
+
/**
|
|
745
|
+
* This interface was referenced by `Field`'s JSON-Schema
|
|
746
|
+
* via the `self.hrefSchema` link.
|
|
747
|
+
*/
|
|
748
|
+
export type FieldSelfHrefSchema = {
|
|
749
|
+
/**
|
|
750
|
+
* Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
|
|
751
|
+
*/
|
|
752
|
+
fields?: {
|
|
753
|
+
field?: FieldSparseFieldset;
|
|
754
|
+
[k: string]: unknown;
|
|
755
|
+
};
|
|
756
|
+
[k: string]: unknown;
|
|
757
|
+
};
|
|
758
|
+
/**
|
|
759
|
+
* Attributes and relationships to return for each `fieldset` that this endpoint returns.
|
|
760
|
+
*
|
|
761
|
+
* This interface was referenced by `Fieldset`'s JSON-Schema
|
|
762
|
+
* via the `definition` "sparse_fieldset".
|
|
763
|
+
*/
|
|
764
|
+
export type FieldsetSparseFieldset = string;
|
|
631
765
|
/**
|
|
632
766
|
* This interface was referenced by `Fieldset`'s JSON-Schema
|
|
633
767
|
* via the `instances.targetSchema` link.
|
|
634
768
|
*/
|
|
635
769
|
export type FieldsetInstancesTargetSchema = Fieldset[];
|
|
770
|
+
/**
|
|
771
|
+
* This interface was referenced by `Fieldset`'s JSON-Schema
|
|
772
|
+
* via the `instances.hrefSchema` link.
|
|
773
|
+
*/
|
|
774
|
+
export type FieldsetInstancesHrefSchema = {
|
|
775
|
+
/**
|
|
776
|
+
* Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
|
|
777
|
+
*/
|
|
778
|
+
fields?: {
|
|
779
|
+
fieldset?: FieldsetSparseFieldset;
|
|
780
|
+
[k: string]: unknown;
|
|
781
|
+
};
|
|
782
|
+
[k: string]: unknown;
|
|
783
|
+
};
|
|
784
|
+
/**
|
|
785
|
+
* This interface was referenced by `Fieldset`'s JSON-Schema
|
|
786
|
+
* via the `self.hrefSchema` link.
|
|
787
|
+
*/
|
|
788
|
+
export type FieldsetSelfHrefSchema = {
|
|
789
|
+
/**
|
|
790
|
+
* Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
|
|
791
|
+
*/
|
|
792
|
+
fields?: {
|
|
793
|
+
fieldset?: FieldsetSparseFieldset;
|
|
794
|
+
[k: string]: unknown;
|
|
795
|
+
};
|
|
796
|
+
[k: string]: unknown;
|
|
797
|
+
};
|
|
636
798
|
/**
|
|
637
799
|
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
638
800
|
* via the `reorder_fields_and_fieldsets.jobSchema` link.
|
|
@@ -1904,6 +2066,13 @@ export type SiteIdentity = string;
|
|
|
1904
2066
|
* via the `definition` "type".
|
|
1905
2067
|
*/
|
|
1906
2068
|
export type SiteType = 'site';
|
|
2069
|
+
/**
|
|
2070
|
+
* Attributes and relationships to return for each `site` that this endpoint returns.
|
|
2071
|
+
*
|
|
2072
|
+
* This interface was referenced by `Site`'s JSON-Schema
|
|
2073
|
+
* via the `definition` "sparse_fieldset".
|
|
2074
|
+
*/
|
|
2075
|
+
export type SiteSparseFieldset = string;
|
|
1907
2076
|
/**
|
|
1908
2077
|
* This interface was referenced by `Site`'s JSON-Schema
|
|
1909
2078
|
* via the `self.hrefSchema` link.
|
|
@@ -1913,6 +2082,18 @@ export type SiteSelfHrefSchema = {
|
|
|
1913
2082
|
* Comma-separated list of [relationship paths](https://jsonapi.org/format/#fetching-includes). A relationship path is a dot-separated list of relationship names. Allowed relationship paths: `item_types`, `item_types.fields`, `item_types.fieldsets`, `item_types.singleton_item`, `account`.
|
|
1914
2083
|
*/
|
|
1915
2084
|
include?: string;
|
|
2085
|
+
/**
|
|
2086
|
+
* Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
|
|
2087
|
+
*/
|
|
2088
|
+
fields?: {
|
|
2089
|
+
site?: SiteSparseFieldset;
|
|
2090
|
+
item_type?: ItemTypeSparseFieldset;
|
|
2091
|
+
field?: FieldSparseFieldset;
|
|
2092
|
+
fieldset?: FieldsetSparseFieldset;
|
|
2093
|
+
account?: AccountSparseFieldset;
|
|
2094
|
+
organization?: OrganizationSparseFieldset;
|
|
2095
|
+
[k: string]: unknown;
|
|
2096
|
+
};
|
|
1916
2097
|
[k: string]: unknown;
|
|
1917
2098
|
};
|
|
1918
2099
|
/**
|
|
@@ -226,6 +226,13 @@ export type AccountType = 'account';
|
|
|
226
226
|
* via the `definition` "id".
|
|
227
227
|
*/
|
|
228
228
|
export type AccountIdentity = string;
|
|
229
|
+
/**
|
|
230
|
+
* Attributes and relationships to return for each `account` that this endpoint returns.
|
|
231
|
+
*
|
|
232
|
+
* This interface was referenced by `Account`'s JSON-Schema
|
|
233
|
+
* via the `definition` "sparse_fieldset".
|
|
234
|
+
*/
|
|
235
|
+
export type AccountSparseFieldset = string;
|
|
229
236
|
/**
|
|
230
237
|
* This interface was referenced by `Organization`'s JSON-Schema
|
|
231
238
|
* via the `definition` "type".
|
|
@@ -241,6 +248,13 @@ export type OrganizationType = 'organization';
|
|
|
241
248
|
* via the `definition` "id".
|
|
242
249
|
*/
|
|
243
250
|
export type OrganizationIdentity = string;
|
|
251
|
+
/**
|
|
252
|
+
* Attributes and relationships to return for each `organization` that this endpoint returns.
|
|
253
|
+
*
|
|
254
|
+
* This interface was referenced by `Organization`'s JSON-Schema
|
|
255
|
+
* via the `definition` "sparse_fieldset".
|
|
256
|
+
*/
|
|
257
|
+
export type OrganizationSparseFieldset = string;
|
|
244
258
|
/**
|
|
245
259
|
* This interface was referenced by `User`'s JSON-Schema
|
|
246
260
|
* via the `me.hrefSchema` link.
|
|
@@ -457,6 +471,13 @@ export type FieldsetIdentity = string;
|
|
|
457
471
|
* via the `definition` "type".
|
|
458
472
|
*/
|
|
459
473
|
export type WorkflowType = 'workflow';
|
|
474
|
+
/**
|
|
475
|
+
* Attributes and relationships to return for each `item_type` that this endpoint returns.
|
|
476
|
+
*
|
|
477
|
+
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
478
|
+
* via the `definition` "sparse_fieldset".
|
|
479
|
+
*/
|
|
480
|
+
export type ItemTypeSparseFieldset = string;
|
|
460
481
|
/**
|
|
461
482
|
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
462
483
|
* via the `create.hrefSchema` link.
|
|
@@ -476,6 +497,42 @@ export type ItemTypeCreateHrefSchema = {
|
|
|
476
497
|
schema_menu_item_id?: string;
|
|
477
498
|
[k: string]: unknown;
|
|
478
499
|
};
|
|
500
|
+
/**
|
|
501
|
+
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
502
|
+
* via the `instances.hrefSchema` link.
|
|
503
|
+
*/
|
|
504
|
+
export type ItemTypeInstancesHrefSchema = {
|
|
505
|
+
/**
|
|
506
|
+
* Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
|
|
507
|
+
*/
|
|
508
|
+
fields?: {
|
|
509
|
+
item_type?: ItemTypeSparseFieldset;
|
|
510
|
+
[k: string]: unknown;
|
|
511
|
+
};
|
|
512
|
+
[k: string]: unknown;
|
|
513
|
+
};
|
|
514
|
+
/**
|
|
515
|
+
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
516
|
+
* via the `self.hrefSchema` link.
|
|
517
|
+
*/
|
|
518
|
+
export type ItemTypeSelfHrefSchema = {
|
|
519
|
+
/**
|
|
520
|
+
* Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
|
|
521
|
+
*/
|
|
522
|
+
fields?: {
|
|
523
|
+
item_type?: ItemTypeSparseFieldset;
|
|
524
|
+
field?: FieldSparseFieldset;
|
|
525
|
+
[k: string]: unknown;
|
|
526
|
+
};
|
|
527
|
+
[k: string]: unknown;
|
|
528
|
+
};
|
|
529
|
+
/**
|
|
530
|
+
* Attributes and relationships to return for each `field` that this endpoint returns.
|
|
531
|
+
*
|
|
532
|
+
* This interface was referenced by `Field`'s JSON-Schema
|
|
533
|
+
* via the `definition` "sparse_fieldset".
|
|
534
|
+
*/
|
|
535
|
+
export type FieldSparseFieldset = string;
|
|
479
536
|
/**
|
|
480
537
|
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
481
538
|
* via the `destroy.hrefSchema` link.
|
|
@@ -487,6 +544,111 @@ export type ItemTypeDestroyHrefSchema = {
|
|
|
487
544
|
skip_menu_items_deletion?: boolean;
|
|
488
545
|
[k: string]: unknown;
|
|
489
546
|
};
|
|
547
|
+
/**
|
|
548
|
+
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
549
|
+
* via the `referencing.hrefSchema` link.
|
|
550
|
+
*/
|
|
551
|
+
export type ItemTypeReferencingHrefSchema = {
|
|
552
|
+
/**
|
|
553
|
+
* Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
|
|
554
|
+
*/
|
|
555
|
+
fields?: {
|
|
556
|
+
item_type?: ItemTypeSparseFieldset;
|
|
557
|
+
[k: string]: unknown;
|
|
558
|
+
};
|
|
559
|
+
[k: string]: unknown;
|
|
560
|
+
};
|
|
561
|
+
/**
|
|
562
|
+
* This interface was referenced by `Field`'s JSON-Schema
|
|
563
|
+
* via the `instances.hrefSchema` link.
|
|
564
|
+
*/
|
|
565
|
+
export type FieldInstancesHrefSchema = {
|
|
566
|
+
/**
|
|
567
|
+
* Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
|
|
568
|
+
*/
|
|
569
|
+
fields?: {
|
|
570
|
+
field?: FieldSparseFieldset;
|
|
571
|
+
[k: string]: unknown;
|
|
572
|
+
};
|
|
573
|
+
[k: string]: unknown;
|
|
574
|
+
};
|
|
575
|
+
/**
|
|
576
|
+
* This interface was referenced by `Field`'s JSON-Schema
|
|
577
|
+
* via the `referencing.hrefSchema` link.
|
|
578
|
+
*/
|
|
579
|
+
export type FieldReferencingHrefSchema = {
|
|
580
|
+
/**
|
|
581
|
+
* Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
|
|
582
|
+
*/
|
|
583
|
+
fields?: {
|
|
584
|
+
field?: FieldSparseFieldset;
|
|
585
|
+
[k: string]: unknown;
|
|
586
|
+
};
|
|
587
|
+
[k: string]: unknown;
|
|
588
|
+
};
|
|
589
|
+
/**
|
|
590
|
+
* This interface was referenced by `Field`'s JSON-Schema
|
|
591
|
+
* via the `related.hrefSchema` link.
|
|
592
|
+
*/
|
|
593
|
+
export type FieldRelatedHrefSchema = {
|
|
594
|
+
/**
|
|
595
|
+
* Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
|
|
596
|
+
*/
|
|
597
|
+
fields?: {
|
|
598
|
+
field?: FieldSparseFieldset;
|
|
599
|
+
[k: string]: unknown;
|
|
600
|
+
};
|
|
601
|
+
[k: string]: unknown;
|
|
602
|
+
};
|
|
603
|
+
/**
|
|
604
|
+
* This interface was referenced by `Field`'s JSON-Schema
|
|
605
|
+
* via the `self.hrefSchema` link.
|
|
606
|
+
*/
|
|
607
|
+
export type FieldSelfHrefSchema = {
|
|
608
|
+
/**
|
|
609
|
+
* Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
|
|
610
|
+
*/
|
|
611
|
+
fields?: {
|
|
612
|
+
field?: FieldSparseFieldset;
|
|
613
|
+
[k: string]: unknown;
|
|
614
|
+
};
|
|
615
|
+
[k: string]: unknown;
|
|
616
|
+
};
|
|
617
|
+
/**
|
|
618
|
+
* Attributes and relationships to return for each `fieldset` that this endpoint returns.
|
|
619
|
+
*
|
|
620
|
+
* This interface was referenced by `Fieldset`'s JSON-Schema
|
|
621
|
+
* via the `definition` "sparse_fieldset".
|
|
622
|
+
*/
|
|
623
|
+
export type FieldsetSparseFieldset = string;
|
|
624
|
+
/**
|
|
625
|
+
* This interface was referenced by `Fieldset`'s JSON-Schema
|
|
626
|
+
* via the `instances.hrefSchema` link.
|
|
627
|
+
*/
|
|
628
|
+
export type FieldsetInstancesHrefSchema = {
|
|
629
|
+
/**
|
|
630
|
+
* Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
|
|
631
|
+
*/
|
|
632
|
+
fields?: {
|
|
633
|
+
fieldset?: FieldsetSparseFieldset;
|
|
634
|
+
[k: string]: unknown;
|
|
635
|
+
};
|
|
636
|
+
[k: string]: unknown;
|
|
637
|
+
};
|
|
638
|
+
/**
|
|
639
|
+
* This interface was referenced by `Fieldset`'s JSON-Schema
|
|
640
|
+
* via the `self.hrefSchema` link.
|
|
641
|
+
*/
|
|
642
|
+
export type FieldsetSelfHrefSchema = {
|
|
643
|
+
/**
|
|
644
|
+
* Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
|
|
645
|
+
*/
|
|
646
|
+
fields?: {
|
|
647
|
+
fieldset?: FieldsetSparseFieldset;
|
|
648
|
+
[k: string]: unknown;
|
|
649
|
+
};
|
|
650
|
+
[k: string]: unknown;
|
|
651
|
+
};
|
|
490
652
|
/**
|
|
491
653
|
* This interface was referenced by `Session`'s JSON-Schema
|
|
492
654
|
* via the `definition` "type".
|
|
@@ -1548,6 +1710,13 @@ export type SiteType = 'site';
|
|
|
1548
1710
|
* via the `definition` "id".
|
|
1549
1711
|
*/
|
|
1550
1712
|
export type SiteIdentity = string;
|
|
1713
|
+
/**
|
|
1714
|
+
* Attributes and relationships to return for each `site` that this endpoint returns.
|
|
1715
|
+
*
|
|
1716
|
+
* This interface was referenced by `Site`'s JSON-Schema
|
|
1717
|
+
* via the `definition` "sparse_fieldset".
|
|
1718
|
+
*/
|
|
1719
|
+
export type SiteSparseFieldset = string;
|
|
1551
1720
|
/**
|
|
1552
1721
|
* This interface was referenced by `Site`'s JSON-Schema
|
|
1553
1722
|
* via the `self.hrefSchema` link.
|
|
@@ -1557,6 +1726,18 @@ export type SiteSelfHrefSchema = {
|
|
|
1557
1726
|
* Comma-separated list of [relationship paths](https://jsonapi.org/format/#fetching-includes). A relationship path is a dot-separated list of relationship names. Allowed relationship paths: `item_types`, `item_types.fields`, `item_types.fieldsets`, `item_types.singleton_item`, `account`.
|
|
1558
1727
|
*/
|
|
1559
1728
|
include?: string;
|
|
1729
|
+
/**
|
|
1730
|
+
* Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
|
|
1731
|
+
*/
|
|
1732
|
+
fields?: {
|
|
1733
|
+
site?: SiteSparseFieldset;
|
|
1734
|
+
item_type?: ItemTypeSparseFieldset;
|
|
1735
|
+
field?: FieldSparseFieldset;
|
|
1736
|
+
fieldset?: FieldsetSparseFieldset;
|
|
1737
|
+
account?: AccountSparseFieldset;
|
|
1738
|
+
organization?: OrganizationSparseFieldset;
|
|
1739
|
+
[k: string]: unknown;
|
|
1740
|
+
};
|
|
1560
1741
|
[k: string]: unknown;
|
|
1561
1742
|
};
|
|
1562
1743
|
/**
|
|
@@ -1647,7 +1647,7 @@ export default class Field extends BaseResource {
|
|
|
1647
1647
|
* @throws {ApiError}
|
|
1648
1648
|
* @throws {TimeoutError}
|
|
1649
1649
|
*/
|
|
1650
|
-
list(itemTypeId: string | ApiTypes.ItemTypeData): Promise<ApiTypes.FieldInstancesTargetSchema>;
|
|
1650
|
+
list(itemTypeId: string | ApiTypes.ItemTypeData, queryParams?: ApiTypes.FieldInstancesHrefSchema): Promise<ApiTypes.FieldInstancesTargetSchema>;
|
|
1651
1651
|
/**
|
|
1652
1652
|
* List all fields of a model/block
|
|
1653
1653
|
*
|
|
@@ -1656,7 +1656,7 @@ export default class Field extends BaseResource {
|
|
|
1656
1656
|
* @throws {ApiError}
|
|
1657
1657
|
* @throws {TimeoutError}
|
|
1658
1658
|
*/
|
|
1659
|
-
rawList(itemTypeId: string): Promise<RawApiTypes.FieldInstancesTargetSchema>;
|
|
1659
|
+
rawList(itemTypeId: string, queryParams?: RawApiTypes.FieldInstancesHrefSchema): Promise<RawApiTypes.FieldInstancesTargetSchema>;
|
|
1660
1660
|
/**
|
|
1661
1661
|
* List fields referencing a model/block
|
|
1662
1662
|
*
|
|
@@ -1665,7 +1665,7 @@ export default class Field extends BaseResource {
|
|
|
1665
1665
|
* @throws {ApiError}
|
|
1666
1666
|
* @throws {TimeoutError}
|
|
1667
1667
|
*/
|
|
1668
|
-
referencing(itemTypeId: string | ApiTypes.ItemTypeData): Promise<ApiTypes.FieldReferencingTargetSchema>;
|
|
1668
|
+
referencing(itemTypeId: string | ApiTypes.ItemTypeData, queryParams?: ApiTypes.FieldReferencingHrefSchema): Promise<ApiTypes.FieldReferencingTargetSchema>;
|
|
1669
1669
|
/**
|
|
1670
1670
|
* List fields referencing a model/block
|
|
1671
1671
|
*
|
|
@@ -1674,7 +1674,7 @@ export default class Field extends BaseResource {
|
|
|
1674
1674
|
* @throws {ApiError}
|
|
1675
1675
|
* @throws {TimeoutError}
|
|
1676
1676
|
*/
|
|
1677
|
-
rawReferencing(itemTypeId: string): Promise<RawApiTypes.FieldReferencingTargetSchema>;
|
|
1677
|
+
rawReferencing(itemTypeId: string, queryParams?: RawApiTypes.FieldReferencingHrefSchema): Promise<RawApiTypes.FieldReferencingTargetSchema>;
|
|
1678
1678
|
/**
|
|
1679
1679
|
* List related fields
|
|
1680
1680
|
*
|
|
@@ -1685,7 +1685,7 @@ export default class Field extends BaseResource {
|
|
|
1685
1685
|
*
|
|
1686
1686
|
* @deprecated This API call is to be considered private and might change without notice
|
|
1687
1687
|
*/
|
|
1688
|
-
related(itemTypeId: string | ApiTypes.ItemTypeData): Promise<ApiTypes.FieldRelatedTargetSchema>;
|
|
1688
|
+
related(itemTypeId: string | ApiTypes.ItemTypeData, queryParams?: ApiTypes.FieldRelatedHrefSchema): Promise<ApiTypes.FieldRelatedTargetSchema>;
|
|
1689
1689
|
/**
|
|
1690
1690
|
* List related fields
|
|
1691
1691
|
*
|
|
@@ -1696,7 +1696,7 @@ export default class Field extends BaseResource {
|
|
|
1696
1696
|
*
|
|
1697
1697
|
* @deprecated This API call is to be considered private and might change without notice
|
|
1698
1698
|
*/
|
|
1699
|
-
rawRelated(itemTypeId: string): Promise<RawApiTypes.FieldRelatedTargetSchema>;
|
|
1699
|
+
rawRelated(itemTypeId: string, queryParams?: RawApiTypes.FieldRelatedHrefSchema): Promise<RawApiTypes.FieldRelatedTargetSchema>;
|
|
1700
1700
|
/**
|
|
1701
1701
|
* Retrieve a field
|
|
1702
1702
|
*
|
|
@@ -1705,7 +1705,7 @@ export default class Field extends BaseResource {
|
|
|
1705
1705
|
* @throws {ApiError}
|
|
1706
1706
|
* @throws {TimeoutError}
|
|
1707
1707
|
*/
|
|
1708
|
-
find(fieldId: string | ApiTypes.FieldData): Promise<(Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
|
|
1708
|
+
find(fieldId: string | ApiTypes.FieldData, queryParams?: ApiTypes.FieldSelfHrefSchema): Promise<(Omit<ApiTypes.FieldStableShell, "field_type" | "default_value" | "validators" | "appearance" | "localized"> & {
|
|
1709
1709
|
field_type: "boolean";
|
|
1710
1710
|
localized: false;
|
|
1711
1711
|
default_value: import("../../index.js").BooleanFieldValue;
|
|
@@ -2514,7 +2514,7 @@ export default class Field extends BaseResource {
|
|
|
2514
2514
|
* @throws {ApiError}
|
|
2515
2515
|
* @throws {TimeoutError}
|
|
2516
2516
|
*/
|
|
2517
|
-
rawFind(fieldId: string): Promise<RawApiTypes.FieldSelfTargetSchema>;
|
|
2517
|
+
rawFind(fieldId: string, queryParams?: RawApiTypes.FieldSelfHrefSchema): Promise<RawApiTypes.FieldSelfTargetSchema>;
|
|
2518
2518
|
/**
|
|
2519
2519
|
* Delete a field
|
|
2520
2520
|
*
|
|
@@ -47,7 +47,7 @@ export default class Fieldset extends BaseResource {
|
|
|
47
47
|
* @throws {ApiError}
|
|
48
48
|
* @throws {TimeoutError}
|
|
49
49
|
*/
|
|
50
|
-
list(itemTypeId: string | ApiTypes.ItemTypeData): Promise<ApiTypes.FieldsetInstancesTargetSchema>;
|
|
50
|
+
list(itemTypeId: string | ApiTypes.ItemTypeData, queryParams?: ApiTypes.FieldsetInstancesHrefSchema): Promise<ApiTypes.FieldsetInstancesTargetSchema>;
|
|
51
51
|
/**
|
|
52
52
|
* List all fieldsets of a model/block
|
|
53
53
|
*
|
|
@@ -56,7 +56,7 @@ export default class Fieldset extends BaseResource {
|
|
|
56
56
|
* @throws {ApiError}
|
|
57
57
|
* @throws {TimeoutError}
|
|
58
58
|
*/
|
|
59
|
-
rawList(itemTypeId: string): Promise<RawApiTypes.FieldsetInstancesTargetSchema>;
|
|
59
|
+
rawList(itemTypeId: string, queryParams?: RawApiTypes.FieldsetInstancesHrefSchema): Promise<RawApiTypes.FieldsetInstancesTargetSchema>;
|
|
60
60
|
/**
|
|
61
61
|
* Retrieve a fieldset
|
|
62
62
|
*
|
|
@@ -65,7 +65,7 @@ export default class Fieldset extends BaseResource {
|
|
|
65
65
|
* @throws {ApiError}
|
|
66
66
|
* @throws {TimeoutError}
|
|
67
67
|
*/
|
|
68
|
-
find(fieldsetId: string | ApiTypes.FieldsetData): Promise<ApiTypes.Fieldset>;
|
|
68
|
+
find(fieldsetId: string | ApiTypes.FieldsetData, queryParams?: ApiTypes.FieldsetSelfHrefSchema): Promise<ApiTypes.Fieldset>;
|
|
69
69
|
/**
|
|
70
70
|
* Retrieve a fieldset
|
|
71
71
|
*
|
|
@@ -74,7 +74,7 @@ export default class Fieldset extends BaseResource {
|
|
|
74
74
|
* @throws {ApiError}
|
|
75
75
|
* @throws {TimeoutError}
|
|
76
76
|
*/
|
|
77
|
-
rawFind(fieldsetId: string): Promise<RawApiTypes.FieldsetSelfTargetSchema>;
|
|
77
|
+
rawFind(fieldsetId: string, queryParams?: RawApiTypes.FieldsetSelfHrefSchema): Promise<RawApiTypes.FieldsetSelfTargetSchema>;
|
|
78
78
|
/**
|
|
79
79
|
* Delete a fieldset
|
|
80
80
|
*
|