@datocms/cma-client 6.4.0 → 6.8.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 +205 -3
- package/dist/esm/generated/Client.js +1 -1
- package/dist/esm/generated/RawApiTypes.d.ts +208 -2
- 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 +205 -3
- package/dist/types/generated/RawApiTypes.d.ts +208 -2
- 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 +205 -3
- package/src/generated/Client.ts +1 -1
- package/src/generated/RawApiTypes.ts +208 -2
- 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
|
@@ -47,7 +47,7 @@ export default class ItemType extends BaseResource {
|
|
|
47
47
|
* @throws {ApiError}
|
|
48
48
|
* @throws {TimeoutError}
|
|
49
49
|
*/
|
|
50
|
-
list(): Promise<ApiTypes.ItemTypeInstancesTargetSchema>;
|
|
50
|
+
list(queryParams?: ApiTypes.ItemTypeInstancesHrefSchema): Promise<ApiTypes.ItemTypeInstancesTargetSchema>;
|
|
51
51
|
/**
|
|
52
52
|
* List all models/block models
|
|
53
53
|
*
|
|
@@ -56,7 +56,7 @@ export default class ItemType extends BaseResource {
|
|
|
56
56
|
* @throws {ApiError}
|
|
57
57
|
* @throws {TimeoutError}
|
|
58
58
|
*/
|
|
59
|
-
rawList(): Promise<RawApiTypes.ItemTypeInstancesTargetSchema>;
|
|
59
|
+
rawList(queryParams?: RawApiTypes.ItemTypeInstancesHrefSchema): Promise<RawApiTypes.ItemTypeInstancesTargetSchema>;
|
|
60
60
|
/**
|
|
61
61
|
* Retrieve a model/block model
|
|
62
62
|
*
|
|
@@ -65,7 +65,7 @@ export default class ItemType extends BaseResource {
|
|
|
65
65
|
* @throws {ApiError}
|
|
66
66
|
* @throws {TimeoutError}
|
|
67
67
|
*/
|
|
68
|
-
find(itemTypeId: string | ApiTypes.ItemTypeData): Promise<ApiTypes.ItemType>;
|
|
68
|
+
find(itemTypeId: string | ApiTypes.ItemTypeData, queryParams?: ApiTypes.ItemTypeSelfHrefSchema): Promise<ApiTypes.ItemType>;
|
|
69
69
|
/**
|
|
70
70
|
* Retrieve a model/block model
|
|
71
71
|
*
|
|
@@ -74,7 +74,7 @@ export default class ItemType extends BaseResource {
|
|
|
74
74
|
* @throws {ApiError}
|
|
75
75
|
* @throws {TimeoutError}
|
|
76
76
|
*/
|
|
77
|
-
rawFind(itemTypeId: string): Promise<RawApiTypes.ItemTypeSelfTargetSchema>;
|
|
77
|
+
rawFind(itemTypeId: string, queryParams?: RawApiTypes.ItemTypeSelfHrefSchema): Promise<RawApiTypes.ItemTypeSelfTargetSchema>;
|
|
78
78
|
/**
|
|
79
79
|
* Duplicate model/block model
|
|
80
80
|
*
|
|
@@ -119,7 +119,7 @@ export default class ItemType extends BaseResource {
|
|
|
119
119
|
* @throws {ApiError}
|
|
120
120
|
* @throws {TimeoutError}
|
|
121
121
|
*/
|
|
122
|
-
referencing(itemTypeId: string | ApiTypes.ItemTypeData): Promise<ApiTypes.ItemTypeReferencingTargetSchema>;
|
|
122
|
+
referencing(itemTypeId: string | ApiTypes.ItemTypeData, queryParams?: ApiTypes.ItemTypeReferencingHrefSchema): Promise<ApiTypes.ItemTypeReferencingTargetSchema>;
|
|
123
123
|
/**
|
|
124
124
|
* List models referencing another model/block
|
|
125
125
|
*
|
|
@@ -128,7 +128,7 @@ export default class ItemType extends BaseResource {
|
|
|
128
128
|
* @throws {ApiError}
|
|
129
129
|
* @throws {TimeoutError}
|
|
130
130
|
*/
|
|
131
|
-
rawReferencing(itemTypeId: string): Promise<RawApiTypes.ItemTypeReferencingTargetSchema>;
|
|
131
|
+
rawReferencing(itemTypeId: string, queryParams?: RawApiTypes.ItemTypeReferencingHrefSchema): Promise<RawApiTypes.ItemTypeReferencingTargetSchema>;
|
|
132
132
|
/**
|
|
133
133
|
* Reorders a set of fields and fieldsets within the model
|
|
134
134
|
*
|
|
@@ -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.
|
|
@@ -879,6 +1041,13 @@ export type SearchIndexEventInstancesHrefSchema = {
|
|
|
879
1041
|
order_by?: 'search_index_id_asc' | 'search_index_id_desc' | 'created_at_asc' | 'created_at_desc' | 'event_type_asc' | 'event_type_desc';
|
|
880
1042
|
[k: string]: unknown;
|
|
881
1043
|
};
|
|
1044
|
+
/**
|
|
1045
|
+
* Attributes and relationships to return for each `item` that this endpoint returns.
|
|
1046
|
+
*
|
|
1047
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
1048
|
+
* via the `definition` "sparse_fieldset".
|
|
1049
|
+
*/
|
|
1050
|
+
export type ItemSparseFieldset = string;
|
|
882
1051
|
/**
|
|
883
1052
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
884
1053
|
* via the `instances.targetSchema` link.
|
|
@@ -1904,15 +2073,35 @@ export type SiteIdentity = string;
|
|
|
1904
2073
|
* via the `definition` "type".
|
|
1905
2074
|
*/
|
|
1906
2075
|
export type SiteType = 'site';
|
|
2076
|
+
/**
|
|
2077
|
+
* Attributes and relationships to return for each `site` that this endpoint returns.
|
|
2078
|
+
*
|
|
2079
|
+
* This interface was referenced by `Site`'s JSON-Schema
|
|
2080
|
+
* via the `definition` "sparse_fieldset".
|
|
2081
|
+
*/
|
|
2082
|
+
export type SiteSparseFieldset = string;
|
|
1907
2083
|
/**
|
|
1908
2084
|
* This interface was referenced by `Site`'s JSON-Schema
|
|
1909
2085
|
* via the `self.hrefSchema` link.
|
|
1910
2086
|
*/
|
|
1911
2087
|
export type SiteSelfHrefSchema = {
|
|
1912
2088
|
/**
|
|
1913
|
-
* 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`.
|
|
2089
|
+
* 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`, `owner`.
|
|
1914
2090
|
*/
|
|
1915
2091
|
include?: string;
|
|
2092
|
+
/**
|
|
2093
|
+
* 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.
|
|
2094
|
+
*/
|
|
2095
|
+
fields?: {
|
|
2096
|
+
site?: SiteSparseFieldset;
|
|
2097
|
+
item_type?: ItemTypeSparseFieldset;
|
|
2098
|
+
field?: FieldSparseFieldset;
|
|
2099
|
+
fieldset?: FieldsetSparseFieldset;
|
|
2100
|
+
item?: ItemSparseFieldset;
|
|
2101
|
+
account?: AccountSparseFieldset;
|
|
2102
|
+
organization?: OrganizationSparseFieldset;
|
|
2103
|
+
[k: string]: unknown;
|
|
2104
|
+
};
|
|
1916
2105
|
[k: string]: unknown;
|
|
1917
2106
|
};
|
|
1918
2107
|
/**
|
|
@@ -6788,7 +6977,7 @@ export type Plugin = {
|
|
|
6788
6977
|
*/
|
|
6789
6978
|
url: string;
|
|
6790
6979
|
/**
|
|
6791
|
-
* Global plugin configuration. Plugins can persist whatever information they want in this object to reuse it later. Refer to the CMA for details about technical limits.
|
|
6980
|
+
* Global plugin configuration. Plugins can persist whatever information they want in this object to reuse it later. Refer to the CMA for details about technical limits. Collaborators always receive it. API tokens and OAuth applications receive it only if they can edit the schema of the project, otherwise it returns `null`.
|
|
6792
6981
|
*/
|
|
6793
6982
|
parameters: null | {
|
|
6794
6983
|
[k: string]: unknown;
|
|
@@ -6872,7 +7061,7 @@ export type PluginAttributes = {
|
|
|
6872
7061
|
*/
|
|
6873
7062
|
url: string;
|
|
6874
7063
|
/**
|
|
6875
|
-
* Global plugin configuration. Plugins can persist whatever information they want in this object to reuse it later. Refer to the CMA for details about technical limits.
|
|
7064
|
+
* Global plugin configuration. Plugins can persist whatever information they want in this object to reuse it later. Refer to the CMA for details about technical limits. Collaborators always receive it. API tokens and OAuth applications receive it only if they can edit the schema of the project, otherwise it returns `null`.
|
|
6876
7065
|
*/
|
|
6877
7066
|
parameters: null | {
|
|
6878
7067
|
[k: string]: unknown;
|
|
@@ -7389,6 +7578,12 @@ export type ItemValidateExistingSchema<D extends ItemTypeDefinition = ItemTypeDe
|
|
|
7389
7578
|
type?: ItemType1;
|
|
7390
7579
|
item_type?: ItemTypeData<D>;
|
|
7391
7580
|
creator?: AccountData | AccessTokenData | UserData | SsoUserData | OrganizationData;
|
|
7581
|
+
/**
|
|
7582
|
+
* Accepted so you can validate the same payload you will send to update the record, but ignored
|
|
7583
|
+
*/
|
|
7584
|
+
meta?: {
|
|
7585
|
+
[k: string]: unknown;
|
|
7586
|
+
};
|
|
7392
7587
|
__itemTypeId?: D['itemTypeId'];
|
|
7393
7588
|
} & ToItemAttributesInRequest<D>;
|
|
7394
7589
|
/**
|
|
@@ -7396,9 +7591,16 @@ export type ItemValidateExistingSchema<D extends ItemTypeDefinition = ItemTypeDe
|
|
|
7396
7591
|
* via the `validate_new.schema` link.
|
|
7397
7592
|
*/
|
|
7398
7593
|
export type ItemValidateNewSchema<D extends ItemTypeDefinition = ItemTypeDefinition> = {
|
|
7594
|
+
id?: ItemIdentity;
|
|
7399
7595
|
type?: ItemType1;
|
|
7400
7596
|
item_type: ItemTypeData<D>;
|
|
7401
7597
|
creator?: AccountData | AccessTokenData | UserData | SsoUserData | OrganizationData;
|
|
7598
|
+
/**
|
|
7599
|
+
* Accepted so you can validate the same payload you will send to create the record, but ignored
|
|
7600
|
+
*/
|
|
7601
|
+
meta?: {
|
|
7602
|
+
[k: string]: unknown;
|
|
7603
|
+
};
|
|
7402
7604
|
__itemTypeId?: D['itemTypeId'];
|
|
7403
7605
|
} & ToItemAttributesInRequest<D>;
|
|
7404
7606
|
/**
|