@datocms/cma-client 1.0.1 → 1.1.2
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/resources/Item.js +3 -1
- package/dist/cjs/generated/resources/Item.js.map +1 -1
- package/dist/cjs/generated/resources/ItemVersion.js +3 -1
- package/dist/cjs/generated/resources/ItemVersion.js.map +1 -1
- package/dist/cjs/generated/resources/SearchResult.js +118 -0
- package/dist/cjs/generated/resources/SearchResult.js.map +1 -1
- package/dist/cjs/generated/resources/Upload.js +3 -1
- package/dist/cjs/generated/resources/Upload.js.map +1 -1
- package/dist/cjs/generated/resources/UploadSmartTag.js +3 -1
- package/dist/cjs/generated/resources/UploadSmartTag.js.map +1 -1
- package/dist/cjs/generated/resources/UploadTag.js +3 -1
- package/dist/cjs/generated/resources/UploadTag.js.map +1 -1
- package/dist/cjs/generated/resources/WebhookCall.js +3 -1
- package/dist/cjs/generated/resources/WebhookCall.js.map +1 -1
- package/dist/esm/buildBlockRecord.d.ts +2 -0
- package/dist/esm/generated/SchemaTypes.d.ts +70 -25
- package/dist/esm/generated/SimpleSchemaTypes.d.ts +82 -28
- package/dist/esm/generated/resources/DailyUsage.d.ts +1 -1
- package/dist/esm/generated/resources/Item.d.ts +6 -6
- package/dist/esm/generated/resources/Item.js +3 -1
- package/dist/esm/generated/resources/Item.js.map +1 -1
- package/dist/esm/generated/resources/ItemVersion.js +3 -1
- package/dist/esm/generated/resources/ItemVersion.js.map +1 -1
- package/dist/esm/generated/resources/SearchResult.d.ts +15 -2
- package/dist/esm/generated/resources/SearchResult.js +118 -0
- package/dist/esm/generated/resources/SearchResult.js.map +1 -1
- package/dist/esm/generated/resources/Upload.js +3 -1
- package/dist/esm/generated/resources/Upload.js.map +1 -1
- package/dist/esm/generated/resources/UploadSmartTag.js +3 -1
- package/dist/esm/generated/resources/UploadSmartTag.js.map +1 -1
- package/dist/esm/generated/resources/UploadTag.js +3 -1
- package/dist/esm/generated/resources/UploadTag.js.map +1 -1
- package/dist/esm/generated/resources/WebhookCall.js +3 -1
- package/dist/esm/generated/resources/WebhookCall.js.map +1 -1
- package/dist/types/buildBlockRecord.d.ts +2 -0
- package/dist/types/generated/SchemaTypes.d.ts +70 -25
- package/dist/types/generated/SimpleSchemaTypes.d.ts +82 -28
- package/dist/types/generated/resources/DailyUsage.d.ts +1 -1
- package/dist/types/generated/resources/Item.d.ts +6 -6
- package/dist/types/generated/resources/SearchResult.d.ts +15 -2
- package/package.json +4 -4
- package/resources.json +4 -0
- package/src/generated/SchemaTypes.ts +70 -25
- package/src/generated/SimpleSchemaTypes.ts +83 -28
- package/src/generated/resources/Item.ts +8 -7
- package/src/generated/resources/ItemVersion.ts +2 -1
- package/src/generated/resources/SearchResult.ts +43 -2
- package/src/generated/resources/Upload.ts +2 -1
- package/src/generated/resources/UploadSmartTag.ts +2 -1
- package/src/generated/resources/UploadTag.ts +2 -1
- package/src/generated/resources/WebhookCall.ts +2 -1
|
@@ -156,7 +156,9 @@ var WebhookCall = /** @class */ (function (_super) {
|
|
|
156
156
|
return Utils.rawPageIterator({
|
|
157
157
|
defaultLimit: 30,
|
|
158
158
|
maxLimit: 500,
|
|
159
|
-
}, function (page) {
|
|
159
|
+
}, function (page) {
|
|
160
|
+
return _this.rawList(__assign(__assign({}, queryParams), { page: page }));
|
|
161
|
+
}, iteratorOptions);
|
|
160
162
|
};
|
|
161
163
|
/**
|
|
162
164
|
* Re-send the webhook call
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"WebhookCall.js","sourceRoot":"","sources":["../../../../src/generated/resources/WebhookCall.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,KAAK,KAAK,MAAM,4BAA4B,CAAC;AAGpD,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAE9C;IAAyC,+BAAY;IAArD;;
|
|
1
|
+
{"version":3,"file":"WebhookCall.js","sourceRoot":"","sources":["../../../../src/generated/resources/WebhookCall.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,KAAK,KAAK,MAAM,4BAA4B,CAAC;AAGpD,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAE9C;IAAyC,+BAAY;IAArD;;IA4FA,CAAC;IAzFC;;;;OAIG;IACH,0BAAI,GAAJ,UAAK,WAA8D;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,UAAC,IAAI;YACzC,OAAA,KAAK,CAAC,uBAAuB,CAC3B,IAAI,CACL;QAFD,CAEC,CACF,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,6BAAO,GAAP,UACE,WAAwD;QAExD,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAA+C;YACvE,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,gBAAgB;YACrB,WAAW,aAAA;SACZ,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,uCAAiB,GAAxB,UACE,WAA8D,EAC9D,eAAuC;;;;;;;;wBAEX,KAAA,cAAA,IAAI,CAAC,oBAAoB,CACnD,WAAW,EACX,eAAe,CAChB,CAAA;;;;;wBAHgB,OAAO,WAAA,CAAA;qDAIhB,KAAK,CAAC,qBAAqB,CAE/B,OAAO,CAAC;4BAFV,gCAEU;;wBAFV,SAEU,CAAC;;;;;;;;;;;;;;;;;;;;;;;;KAEd;IAED;;;;OAIG;IACH,0CAAoB,GAApB,UACE,WAAwD,EACxD,eAAuC;QAFzC,iBAeC;QAXC,OAAO,KAAK,CAAC,eAAe,CAG1B;YACE,YAAY,EAAE,EAAE;YAChB,QAAQ,EAAE,GAAG;SACd,EACD,UAAC,IAAwD;YACvD,OAAA,KAAI,CAAC,OAAO,uBAAM,WAAW,KAAE,IAAI,MAAA,IAAG;QAAtC,CAAsC,EACxC,eAAe,CAChB,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,mCAAa,GAAb,UAAc,MAA2C;QACvD,OAAO,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IACnD,CAAC;IAED;;;;OAIG;IACH,sCAAgB,GAAhB,UAAiB,MAAc;QAC7B,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAO;YAC/B,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,yBAAkB,MAAM,oBAAiB;SAC/C,CAAC,CAAC;IACL,CAAC;IA1Fe,gBAAI,GAAmB,cAAc,CAAC;IA2FxD,kBAAC;CAAA,AA5FD,CAAyC,YAAY,GA4FpD;eA5FoB,WAAW"}
|
|
@@ -16,6 +16,8 @@ export declare function buildBlockRecord(body: SimpleSchemaTypes.ItemUpdateSchem
|
|
|
16
16
|
status?: "published" | "draft" | "updated" | null | undefined;
|
|
17
17
|
is_valid?: boolean | undefined;
|
|
18
18
|
current_version?: string | undefined;
|
|
19
|
+
is_current_version_valid?: boolean | null | undefined;
|
|
20
|
+
is_published_version_valid?: boolean | null | undefined;
|
|
19
21
|
stage?: string | null | undefined;
|
|
20
22
|
} | undefined;
|
|
21
23
|
relationships?: {
|
|
@@ -516,7 +516,7 @@ export declare type ItemInstancesHrefSchema = {
|
|
|
516
516
|
[k: string]: unknown;
|
|
517
517
|
};
|
|
518
518
|
/**
|
|
519
|
-
* Fields used to order results. You
|
|
519
|
+
* Fields used to order results. You **must** specify also `filter[type]` with one element only to be able use this option. Format: `<field_name>_(ASC|DESC)`, where `<field_name>` can be either the API key of a model's field, or one of the following meta columns: `id`, `_updated_at`, `_created_at`, `_status`, `_published_at`, `_first_published_at`, `_publication_scheduled_at`, `_unpublishing_scheduled_at`, `_is_valid`, `position` (only for sortable models). You can pass multiple comma separated rules.
|
|
520
520
|
*/
|
|
521
521
|
order_by?: string;
|
|
522
522
|
/**
|
|
@@ -826,25 +826,41 @@ export declare type SearchResultIdentity = string;
|
|
|
826
826
|
*/
|
|
827
827
|
export declare type SearchResultInstancesHrefSchema = {
|
|
828
828
|
/**
|
|
829
|
-
*
|
|
830
|
-
*/
|
|
831
|
-
q: string;
|
|
832
|
-
/**
|
|
833
|
-
* The build trigger ID on which the search will be performed
|
|
834
|
-
*/
|
|
835
|
-
build_trigger_id?: string;
|
|
836
|
-
/**
|
|
837
|
-
* Restrict the search on one locale
|
|
838
|
-
*/
|
|
839
|
-
locale?: string;
|
|
840
|
-
/**
|
|
841
|
-
* Maximum number of results to return (defaults to 20, maximum is 100)
|
|
829
|
+
* Attributes to manage results pagination
|
|
842
830
|
*/
|
|
843
|
-
|
|
831
|
+
page?: {
|
|
832
|
+
/**
|
|
833
|
+
* Index of first element to fetch (defaults to 0)
|
|
834
|
+
*/
|
|
835
|
+
offset?: number;
|
|
836
|
+
/**
|
|
837
|
+
* Number of elements to fetch (defaults to 20, maximum is 100)
|
|
838
|
+
*/
|
|
839
|
+
limit?: number;
|
|
840
|
+
[k: string]: unknown;
|
|
841
|
+
};
|
|
844
842
|
/**
|
|
845
|
-
*
|
|
843
|
+
* Attributes to filter search results
|
|
846
844
|
*/
|
|
847
|
-
|
|
845
|
+
filter: {
|
|
846
|
+
/**
|
|
847
|
+
* When any value is passed, it enables the fuzzy search: the Levenshtein Edit Distance is used to match more results.
|
|
848
|
+
*/
|
|
849
|
+
fuzzy?: string;
|
|
850
|
+
/**
|
|
851
|
+
* Text to search
|
|
852
|
+
*/
|
|
853
|
+
query: string;
|
|
854
|
+
/**
|
|
855
|
+
* The build trigger ID on which the search will be performed. Required if more than one build trigger is present in a project
|
|
856
|
+
*/
|
|
857
|
+
build_trigger_id?: string;
|
|
858
|
+
/**
|
|
859
|
+
* Restrict the search on pages in a specific locale
|
|
860
|
+
*/
|
|
861
|
+
locale?: string;
|
|
862
|
+
[k: string]: unknown;
|
|
863
|
+
};
|
|
848
864
|
[k: string]: unknown;
|
|
849
865
|
};
|
|
850
866
|
/**
|
|
@@ -2963,6 +2979,10 @@ export declare type SitePlanAttributes = {
|
|
|
2963
2979
|
* Whether or not use a static IP when sending webhooks
|
|
2964
2980
|
*/
|
|
2965
2981
|
static_webhooks_ip: boolean;
|
|
2982
|
+
/**
|
|
2983
|
+
* Maximum size in bytes for a single file upload
|
|
2984
|
+
*/
|
|
2985
|
+
maximum_single_upload_bytes: number;
|
|
2966
2986
|
/**
|
|
2967
2987
|
* Available extra packets
|
|
2968
2988
|
*/
|
|
@@ -5694,6 +5714,14 @@ export declare type ItemMeta = {
|
|
|
5694
5714
|
* Whether the current record is valid or not
|
|
5695
5715
|
*/
|
|
5696
5716
|
is_valid: boolean;
|
|
5717
|
+
/**
|
|
5718
|
+
* Whether the current version of the record is valid or not
|
|
5719
|
+
*/
|
|
5720
|
+
is_current_version_valid: null | boolean;
|
|
5721
|
+
/**
|
|
5722
|
+
* Whether the published version of record is valid or not
|
|
5723
|
+
*/
|
|
5724
|
+
is_published_version_valid: null | boolean;
|
|
5697
5725
|
/**
|
|
5698
5726
|
* The ID of the current record version
|
|
5699
5727
|
*/
|
|
@@ -5811,6 +5839,14 @@ export declare type ItemCreateSchema = {
|
|
|
5811
5839
|
* Whether the current record is valid or not
|
|
5812
5840
|
*/
|
|
5813
5841
|
is_valid?: boolean;
|
|
5842
|
+
/**
|
|
5843
|
+
* Whether the current version of the record is valid or not
|
|
5844
|
+
*/
|
|
5845
|
+
is_current_version_valid?: null | boolean;
|
|
5846
|
+
/**
|
|
5847
|
+
* Whether the published version of the record is valid or not
|
|
5848
|
+
*/
|
|
5849
|
+
is_published_version_valid?: null | boolean;
|
|
5814
5850
|
/**
|
|
5815
5851
|
* The ID of the current record version
|
|
5816
5852
|
*/
|
|
@@ -5903,6 +5939,14 @@ export declare type ItemUpdateSchema = {
|
|
|
5903
5939
|
* The ID of the current record version (for optimistic locking, see the example)
|
|
5904
5940
|
*/
|
|
5905
5941
|
current_version?: string;
|
|
5942
|
+
/**
|
|
5943
|
+
* Whether the current version of the record is valid or not
|
|
5944
|
+
*/
|
|
5945
|
+
is_current_version_valid?: null | boolean;
|
|
5946
|
+
/**
|
|
5947
|
+
* Whether the published version of record is valid or not
|
|
5948
|
+
*/
|
|
5949
|
+
is_published_version_valid?: null | boolean;
|
|
5906
5950
|
/**
|
|
5907
5951
|
* The new stage to move the record to
|
|
5908
5952
|
*/
|
|
@@ -7069,11 +7113,11 @@ export declare type SearchResult = {
|
|
|
7069
7113
|
*/
|
|
7070
7114
|
export declare type SearchResultAttributes = {
|
|
7071
7115
|
/**
|
|
7072
|
-
*
|
|
7116
|
+
* Title of the page
|
|
7073
7117
|
*/
|
|
7074
7118
|
title: string;
|
|
7075
7119
|
/**
|
|
7076
|
-
* First
|
|
7120
|
+
* First 200 characters of page body, unformatted
|
|
7077
7121
|
*/
|
|
7078
7122
|
body_excerpt: string;
|
|
7079
7123
|
/**
|
|
@@ -7081,7 +7125,7 @@ export declare type SearchResultAttributes = {
|
|
|
7081
7125
|
*/
|
|
7082
7126
|
url: string;
|
|
7083
7127
|
/**
|
|
7084
|
-
*
|
|
7128
|
+
* Search score
|
|
7085
7129
|
*/
|
|
7086
7130
|
score: number;
|
|
7087
7131
|
highlight: {
|
|
@@ -7105,7 +7149,7 @@ export declare type SearchResultData = {
|
|
|
7105
7149
|
*/
|
|
7106
7150
|
export declare type SearchResultInstancesTargetSchema = {
|
|
7107
7151
|
data: SearchResult[];
|
|
7108
|
-
meta
|
|
7152
|
+
meta: {
|
|
7109
7153
|
total_count: number;
|
|
7110
7154
|
};
|
|
7111
7155
|
};
|
|
@@ -7799,7 +7843,7 @@ export declare type ItemTypeFilterAttributes = {
|
|
|
7799
7843
|
*/
|
|
7800
7844
|
name: string;
|
|
7801
7845
|
/**
|
|
7802
|
-
* The actual filter
|
|
7846
|
+
* The actual filter. It follows the form of the `filter` query parameter of the [List all records](https://www.datocms.com/docs/content-management-api/resources/item/instances) endpoint.
|
|
7803
7847
|
*/
|
|
7804
7848
|
filter: {
|
|
7805
7849
|
[k: string]: unknown;
|
|
@@ -7846,7 +7890,7 @@ export declare type ItemTypeFilterCreateSchema = {
|
|
|
7846
7890
|
*/
|
|
7847
7891
|
name: string;
|
|
7848
7892
|
/**
|
|
7849
|
-
* The actual filter
|
|
7893
|
+
* The actual filter. It follows the form of the `filter` query parameter of the [List all records](https://www.datocms.com/docs/content-management-api/resources/item/instances) endpoint.
|
|
7850
7894
|
*/
|
|
7851
7895
|
filter: {
|
|
7852
7896
|
[k: string]: unknown;
|
|
@@ -7894,7 +7938,7 @@ export declare type ItemTypeFilterUpdateSchema = {
|
|
|
7894
7938
|
*/
|
|
7895
7939
|
shared?: boolean;
|
|
7896
7940
|
/**
|
|
7897
|
-
* The actual filter
|
|
7941
|
+
* The actual filter. It follows the form of the `filter` query parameter of the [List all records](https://www.datocms.com/docs/content-management-api/resources/item/instances) endpoint.
|
|
7898
7942
|
*/
|
|
7899
7943
|
filter: {
|
|
7900
7944
|
[k: string]: unknown;
|
|
@@ -8705,6 +8749,7 @@ export declare type PublicInfoAttributes = {
|
|
|
8705
8749
|
extras: null | {
|
|
8706
8750
|
blocks_depth: number;
|
|
8707
8751
|
blocks_per_item: number;
|
|
8752
|
+
maximum_single_upload_bytes: number;
|
|
8708
8753
|
[k: string]: unknown;
|
|
8709
8754
|
};
|
|
8710
8755
|
};
|
|
@@ -8783,7 +8828,7 @@ export declare type DailyUsageData = {
|
|
|
8783
8828
|
* via the `instances.targetSchema` link.
|
|
8784
8829
|
*/
|
|
8785
8830
|
export declare type DailyUsageInstancesTargetSchema = {
|
|
8786
|
-
data: DailyUsage;
|
|
8831
|
+
data: DailyUsage[];
|
|
8787
8832
|
};
|
|
8788
8833
|
/**
|
|
8789
8834
|
* You can use counters to analyze your project's data consumption over a period of time. Counters are especially useful if your project is exceeding its API calls/traffic quota limits, to better understand where and how requests are originating. Counters are updated every minute, so you can debug in real-time the results of your changes.
|
|
@@ -611,7 +611,7 @@ export declare type ItemInstancesHrefSchema = {
|
|
|
611
611
|
[k: string]: unknown;
|
|
612
612
|
};
|
|
613
613
|
/**
|
|
614
|
-
* Fields used to order results. You
|
|
614
|
+
* Fields used to order results. You **must** specify also `filter[type]` with one element only to be able use this option. Format: `<field_name>_(ASC|DESC)`, where `<field_name>` can be either the API key of a model's field, or one of the following meta columns: `id`, `_updated_at`, `_created_at`, `_status`, `_published_at`, `_first_published_at`, `_publication_scheduled_at`, `_unpublishing_scheduled_at`, `_is_valid`, `position` (only for sortable models). You can pass multiple comma separated rules.
|
|
615
615
|
*/
|
|
616
616
|
order_by?: string;
|
|
617
617
|
/**
|
|
@@ -1006,25 +1006,41 @@ export declare type SearchResultInstancesTargetSchema = SearchResult[];
|
|
|
1006
1006
|
*/
|
|
1007
1007
|
export declare type SearchResultInstancesHrefSchema = {
|
|
1008
1008
|
/**
|
|
1009
|
-
*
|
|
1010
|
-
*/
|
|
1011
|
-
q: string;
|
|
1012
|
-
/**
|
|
1013
|
-
* The build trigger ID on which the search will be performed
|
|
1014
|
-
*/
|
|
1015
|
-
build_trigger_id?: string;
|
|
1016
|
-
/**
|
|
1017
|
-
* Restrict the search on one locale
|
|
1018
|
-
*/
|
|
1019
|
-
locale?: string;
|
|
1020
|
-
/**
|
|
1021
|
-
* Maximum number of results to return (defaults to 20, maximum is 100)
|
|
1009
|
+
* Attributes to manage results pagination
|
|
1022
1010
|
*/
|
|
1023
|
-
|
|
1011
|
+
page?: {
|
|
1012
|
+
/**
|
|
1013
|
+
* Index of first element to fetch (defaults to 0)
|
|
1014
|
+
*/
|
|
1015
|
+
offset?: number;
|
|
1016
|
+
/**
|
|
1017
|
+
* Number of elements to fetch (defaults to 20, maximum is 100)
|
|
1018
|
+
*/
|
|
1019
|
+
limit?: number;
|
|
1020
|
+
[k: string]: unknown;
|
|
1021
|
+
};
|
|
1024
1022
|
/**
|
|
1025
|
-
*
|
|
1023
|
+
* Attributes to filter search results
|
|
1026
1024
|
*/
|
|
1027
|
-
|
|
1025
|
+
filter: {
|
|
1026
|
+
/**
|
|
1027
|
+
* When any value is passed, it enables the fuzzy search: the Levenshtein Edit Distance is used to match more results.
|
|
1028
|
+
*/
|
|
1029
|
+
fuzzy?: string;
|
|
1030
|
+
/**
|
|
1031
|
+
* Text to search
|
|
1032
|
+
*/
|
|
1033
|
+
query: string;
|
|
1034
|
+
/**
|
|
1035
|
+
* The build trigger ID on which the search will be performed. Required if more than one build trigger is present in a project
|
|
1036
|
+
*/
|
|
1037
|
+
build_trigger_id?: string;
|
|
1038
|
+
/**
|
|
1039
|
+
* Restrict the search on pages in a specific locale
|
|
1040
|
+
*/
|
|
1041
|
+
locale?: string;
|
|
1042
|
+
[k: string]: unknown;
|
|
1043
|
+
};
|
|
1028
1044
|
[k: string]: unknown;
|
|
1029
1045
|
};
|
|
1030
1046
|
/**
|
|
@@ -1340,6 +1356,11 @@ export declare type DailyUsageIdentity = string;
|
|
|
1340
1356
|
* via the `definition` "type".
|
|
1341
1357
|
*/
|
|
1342
1358
|
export declare type DailyUsageType = 'daily_usage';
|
|
1359
|
+
/**
|
|
1360
|
+
* This interface was referenced by `DailyUsage`'s JSON-Schema
|
|
1361
|
+
* via the `instances.targetSchema` link.
|
|
1362
|
+
*/
|
|
1363
|
+
export declare type DailyUsageInstancesTargetSchema = DailyUsage[];
|
|
1343
1364
|
/**
|
|
1344
1365
|
* Name of the counter
|
|
1345
1366
|
*
|
|
@@ -3340,6 +3361,10 @@ export declare type SitePlan = {
|
|
|
3340
3361
|
* Whether or not use a static IP when sending webhooks
|
|
3341
3362
|
*/
|
|
3342
3363
|
static_webhooks_ip: boolean;
|
|
3364
|
+
/**
|
|
3365
|
+
* Maximum size in bytes for a single file upload
|
|
3366
|
+
*/
|
|
3367
|
+
maximum_single_upload_bytes: number;
|
|
3343
3368
|
/**
|
|
3344
3369
|
* Available extra packets
|
|
3345
3370
|
*/
|
|
@@ -3560,6 +3585,10 @@ export declare type SitePlanAttributes = {
|
|
|
3560
3585
|
* Whether or not use a static IP when sending webhooks
|
|
3561
3586
|
*/
|
|
3562
3587
|
static_webhooks_ip: boolean;
|
|
3588
|
+
/**
|
|
3589
|
+
* Maximum size in bytes for a single file upload
|
|
3590
|
+
*/
|
|
3591
|
+
maximum_single_upload_bytes: number;
|
|
3563
3592
|
/**
|
|
3564
3593
|
* Available extra packets
|
|
3565
3594
|
*/
|
|
@@ -6109,6 +6138,14 @@ export declare type ItemMeta = {
|
|
|
6109
6138
|
* Whether the current record is valid or not
|
|
6110
6139
|
*/
|
|
6111
6140
|
is_valid: boolean;
|
|
6141
|
+
/**
|
|
6142
|
+
* Whether the current version of the record is valid or not
|
|
6143
|
+
*/
|
|
6144
|
+
is_current_version_valid: null | boolean;
|
|
6145
|
+
/**
|
|
6146
|
+
* Whether the published version of record is valid or not
|
|
6147
|
+
*/
|
|
6148
|
+
is_published_version_valid: null | boolean;
|
|
6112
6149
|
/**
|
|
6113
6150
|
* The ID of the current record version
|
|
6114
6151
|
*/
|
|
@@ -6196,6 +6233,14 @@ export declare type ItemCreateSchema = {
|
|
|
6196
6233
|
* Whether the current record is valid or not
|
|
6197
6234
|
*/
|
|
6198
6235
|
is_valid?: boolean;
|
|
6236
|
+
/**
|
|
6237
|
+
* Whether the current version of the record is valid or not
|
|
6238
|
+
*/
|
|
6239
|
+
is_current_version_valid?: null | boolean;
|
|
6240
|
+
/**
|
|
6241
|
+
* Whether the published version of the record is valid or not
|
|
6242
|
+
*/
|
|
6243
|
+
is_published_version_valid?: null | boolean;
|
|
6199
6244
|
/**
|
|
6200
6245
|
* The ID of the current record version
|
|
6201
6246
|
*/
|
|
@@ -6252,6 +6297,14 @@ export declare type ItemUpdateSchema = {
|
|
|
6252
6297
|
* The ID of the current record version (for optimistic locking, see the example)
|
|
6253
6298
|
*/
|
|
6254
6299
|
current_version?: string;
|
|
6300
|
+
/**
|
|
6301
|
+
* Whether the current version of the record is valid or not
|
|
6302
|
+
*/
|
|
6303
|
+
is_current_version_valid?: null | boolean;
|
|
6304
|
+
/**
|
|
6305
|
+
* Whether the published version of record is valid or not
|
|
6306
|
+
*/
|
|
6307
|
+
is_published_version_valid?: null | boolean;
|
|
6255
6308
|
/**
|
|
6256
6309
|
* The new stage to move the record to
|
|
6257
6310
|
*/
|
|
@@ -7073,11 +7126,11 @@ export declare type SearchResult = {
|
|
|
7073
7126
|
id: SearchResultIdentity;
|
|
7074
7127
|
type: SearchResultType;
|
|
7075
7128
|
/**
|
|
7076
|
-
*
|
|
7129
|
+
* Title of the page
|
|
7077
7130
|
*/
|
|
7078
7131
|
title: string;
|
|
7079
7132
|
/**
|
|
7080
|
-
* First
|
|
7133
|
+
* First 200 characters of page body, unformatted
|
|
7081
7134
|
*/
|
|
7082
7135
|
body_excerpt: string;
|
|
7083
7136
|
/**
|
|
@@ -7085,7 +7138,7 @@ export declare type SearchResult = {
|
|
|
7085
7138
|
*/
|
|
7086
7139
|
url: string;
|
|
7087
7140
|
/**
|
|
7088
|
-
*
|
|
7141
|
+
* Search score
|
|
7089
7142
|
*/
|
|
7090
7143
|
score: number;
|
|
7091
7144
|
highlight: {
|
|
@@ -7111,11 +7164,11 @@ export declare type SearchResultData = {
|
|
|
7111
7164
|
*/
|
|
7112
7165
|
export declare type SearchResultAttributes = {
|
|
7113
7166
|
/**
|
|
7114
|
-
*
|
|
7167
|
+
* Title of the page
|
|
7115
7168
|
*/
|
|
7116
7169
|
title: string;
|
|
7117
7170
|
/**
|
|
7118
|
-
* First
|
|
7171
|
+
* First 200 characters of page body, unformatted
|
|
7119
7172
|
*/
|
|
7120
7173
|
body_excerpt: string;
|
|
7121
7174
|
/**
|
|
@@ -7123,7 +7176,7 @@ export declare type SearchResultAttributes = {
|
|
|
7123
7176
|
*/
|
|
7124
7177
|
url: string;
|
|
7125
7178
|
/**
|
|
7126
|
-
*
|
|
7179
|
+
* Search score
|
|
7127
7180
|
*/
|
|
7128
7181
|
score: number;
|
|
7129
7182
|
highlight: {
|
|
@@ -7782,7 +7835,7 @@ export declare type ItemTypeFilter = {
|
|
|
7782
7835
|
*/
|
|
7783
7836
|
name: string;
|
|
7784
7837
|
/**
|
|
7785
|
-
* The actual filter
|
|
7838
|
+
* The actual filter. It follows the form of the `filter` query parameter of the [List all records](https://www.datocms.com/docs/content-management-api/resources/item/instances) endpoint.
|
|
7786
7839
|
*/
|
|
7787
7840
|
filter: {
|
|
7788
7841
|
[k: string]: unknown;
|
|
@@ -7819,7 +7872,7 @@ export declare type ItemTypeFilterAttributes = {
|
|
|
7819
7872
|
*/
|
|
7820
7873
|
name: string;
|
|
7821
7874
|
/**
|
|
7822
|
-
* The actual filter
|
|
7875
|
+
* The actual filter. It follows the form of the `filter` query parameter of the [List all records](https://www.datocms.com/docs/content-management-api/resources/item/instances) endpoint.
|
|
7823
7876
|
*/
|
|
7824
7877
|
filter: {
|
|
7825
7878
|
[k: string]: unknown;
|
|
@@ -7849,7 +7902,7 @@ export declare type ItemTypeFilterCreateSchema = {
|
|
|
7849
7902
|
*/
|
|
7850
7903
|
name: string;
|
|
7851
7904
|
/**
|
|
7852
|
-
* The actual filter
|
|
7905
|
+
* The actual filter. It follows the form of the `filter` query parameter of the [List all records](https://www.datocms.com/docs/content-management-api/resources/item/instances) endpoint.
|
|
7853
7906
|
*/
|
|
7854
7907
|
filter: {
|
|
7855
7908
|
[k: string]: unknown;
|
|
@@ -7876,7 +7929,7 @@ export declare type ItemTypeFilterUpdateSchema = {
|
|
|
7876
7929
|
*/
|
|
7877
7930
|
shared?: boolean;
|
|
7878
7931
|
/**
|
|
7879
|
-
* The actual filter
|
|
7932
|
+
* The actual filter. It follows the form of the `filter` query parameter of the [List all records](https://www.datocms.com/docs/content-management-api/resources/item/instances) endpoint.
|
|
7880
7933
|
*/
|
|
7881
7934
|
filter: {
|
|
7882
7935
|
[k: string]: unknown;
|
|
@@ -8425,6 +8478,7 @@ export declare type PublicInfo = {
|
|
|
8425
8478
|
extras: null | {
|
|
8426
8479
|
blocks_depth: number;
|
|
8427
8480
|
blocks_per_item: number;
|
|
8481
|
+
maximum_single_upload_bytes: number;
|
|
8428
8482
|
[k: string]: unknown;
|
|
8429
8483
|
};
|
|
8430
8484
|
};
|
|
@@ -8506,6 +8560,7 @@ export declare type PublicInfoAttributes = {
|
|
|
8506
8560
|
extras: null | {
|
|
8507
8561
|
blocks_depth: number;
|
|
8508
8562
|
blocks_per_item: number;
|
|
8563
|
+
maximum_single_upload_bytes: number;
|
|
8509
8564
|
[k: string]: unknown;
|
|
8510
8565
|
};
|
|
8511
8566
|
};
|
|
@@ -8543,7 +8598,6 @@ export declare type DailyUsage = {
|
|
|
8543
8598
|
*/
|
|
8544
8599
|
mux_delivered_seconds: number;
|
|
8545
8600
|
};
|
|
8546
|
-
export declare type DailyUsageInstancesTargetSchema = DailyUsage;
|
|
8547
8601
|
/**
|
|
8548
8602
|
* JSON API data
|
|
8549
8603
|
*
|
|
@@ -8,7 +8,7 @@ export default class DailyUsage extends BaseResource {
|
|
|
8
8
|
*
|
|
9
9
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/daily-usage/instances
|
|
10
10
|
*/
|
|
11
|
-
list(): Promise<SimpleSchemaTypes.
|
|
11
|
+
list(): Promise<SimpleSchemaTypes.DailyUsageInstancesTargetSchema>;
|
|
12
12
|
/**
|
|
13
13
|
* Retrieve project's daily usage info
|
|
14
14
|
*
|
|
@@ -139,7 +139,7 @@ export default class Item extends BaseResource {
|
|
|
139
139
|
*
|
|
140
140
|
* @deprecated This API call is to be considered private and might change without notice
|
|
141
141
|
*/
|
|
142
|
-
batchDestroy(queryParams
|
|
142
|
+
batchDestroy(queryParams: SimpleSchemaTypes.ItemBatchDestroyHrefSchema): Promise<SimpleSchemaTypes.ItemBatchDestroyJobSchema>;
|
|
143
143
|
/**
|
|
144
144
|
* Delete multiple records
|
|
145
145
|
*
|
|
@@ -147,7 +147,7 @@ export default class Item extends BaseResource {
|
|
|
147
147
|
*
|
|
148
148
|
* @deprecated This API call is to be considered private and might change without notice
|
|
149
149
|
*/
|
|
150
|
-
rawBatchDestroy(queryParams
|
|
150
|
+
rawBatchDestroy(queryParams: SchemaTypes.ItemBatchDestroyHrefSchema): Promise<SchemaTypes.ItemBatchDestroyJobSchema>;
|
|
151
151
|
/**
|
|
152
152
|
* Publish multiple records
|
|
153
153
|
*
|
|
@@ -155,7 +155,7 @@ export default class Item extends BaseResource {
|
|
|
155
155
|
*
|
|
156
156
|
* @deprecated This API call is to be considered private and might change without notice
|
|
157
157
|
*/
|
|
158
|
-
batchPublish(queryParams
|
|
158
|
+
batchPublish(queryParams: SimpleSchemaTypes.ItemBatchPublishHrefSchema): Promise<SimpleSchemaTypes.ItemBatchPublishJobSchema>;
|
|
159
159
|
/**
|
|
160
160
|
* Publish multiple records
|
|
161
161
|
*
|
|
@@ -163,7 +163,7 @@ export default class Item extends BaseResource {
|
|
|
163
163
|
*
|
|
164
164
|
* @deprecated This API call is to be considered private and might change without notice
|
|
165
165
|
*/
|
|
166
|
-
rawBatchPublish(queryParams
|
|
166
|
+
rawBatchPublish(queryParams: SchemaTypes.ItemBatchPublishHrefSchema): Promise<SchemaTypes.ItemBatchPublishJobSchema>;
|
|
167
167
|
/**
|
|
168
168
|
* Unpublish multiple records
|
|
169
169
|
*
|
|
@@ -171,7 +171,7 @@ export default class Item extends BaseResource {
|
|
|
171
171
|
*
|
|
172
172
|
* @deprecated This API call is to be considered private and might change without notice
|
|
173
173
|
*/
|
|
174
|
-
batchUnpublish(queryParams
|
|
174
|
+
batchUnpublish(queryParams: SimpleSchemaTypes.ItemBatchUnpublishHrefSchema): Promise<SimpleSchemaTypes.ItemBatchUnpublishJobSchema>;
|
|
175
175
|
/**
|
|
176
176
|
* Unpublish multiple records
|
|
177
177
|
*
|
|
@@ -179,7 +179,7 @@ export default class Item extends BaseResource {
|
|
|
179
179
|
*
|
|
180
180
|
* @deprecated This API call is to be considered private and might change without notice
|
|
181
181
|
*/
|
|
182
|
-
rawBatchUnpublish(queryParams
|
|
182
|
+
rawBatchUnpublish(queryParams: SchemaTypes.ItemBatchUnpublishHrefSchema): Promise<SchemaTypes.ItemBatchUnpublishJobSchema>;
|
|
183
183
|
/**
|
|
184
184
|
* Publish a record
|
|
185
185
|
*
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import * as Utils from '@datocms/rest-client-utils';
|
|
1
2
|
import * as SchemaTypes from '../SchemaTypes';
|
|
2
3
|
import * as SimpleSchemaTypes from '../SimpleSchemaTypes';
|
|
3
4
|
import BaseResource from '../../BaseResource';
|
|
@@ -8,11 +9,23 @@ export default class SearchResult extends BaseResource {
|
|
|
8
9
|
*
|
|
9
10
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/search-result/instances
|
|
10
11
|
*/
|
|
11
|
-
list(queryParams
|
|
12
|
+
list(queryParams: SimpleSchemaTypes.SearchResultInstancesHrefSchema): Promise<SimpleSchemaTypes.SearchResultInstancesTargetSchema>;
|
|
12
13
|
/**
|
|
13
14
|
* Search for results
|
|
14
15
|
*
|
|
15
16
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/search-result/instances
|
|
16
17
|
*/
|
|
17
|
-
rawList(queryParams
|
|
18
|
+
rawList(queryParams: SchemaTypes.SearchResultInstancesHrefSchema): Promise<SchemaTypes.SearchResultInstancesTargetSchema>;
|
|
19
|
+
/**
|
|
20
|
+
* Async iterator to auto-paginate over elements returned by list()
|
|
21
|
+
*
|
|
22
|
+
* Read more: https://www.datocms.com/docs/content-management-api/resources/search-result/instances
|
|
23
|
+
*/
|
|
24
|
+
listPagedIterator(queryParams: SimpleSchemaTypes.SearchResultInstancesHrefSchema, iteratorOptions?: Utils.IteratorOptions): AsyncGenerator<SimpleSchemaTypes.SearchResult, void, unknown>;
|
|
25
|
+
/**
|
|
26
|
+
* Async iterator to auto-paginate over elements returned by rawList()
|
|
27
|
+
*
|
|
28
|
+
* Read more: https://www.datocms.com/docs/content-management-api/resources/search-result/instances
|
|
29
|
+
*/
|
|
30
|
+
rawListPagedIterator(queryParams: SchemaTypes.SearchResultInstancesHrefSchema, iteratorOptions?: Utils.IteratorOptions): AsyncGenerator<SchemaTypes.SearchResult, void, unknown>;
|
|
18
31
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@datocms/cma-client",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.1.2",
|
|
4
4
|
"description": "JS client for DatoCMS REST Content Management API",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"datocms",
|
|
@@ -37,10 +37,10 @@
|
|
|
37
37
|
"url": "https://github.com/datocms/js-rest-api-clients/issues"
|
|
38
38
|
},
|
|
39
39
|
"dependencies": {
|
|
40
|
-
"@datocms/rest-client-utils": "^1.
|
|
40
|
+
"@datocms/rest-client-utils": "^1.1.2"
|
|
41
41
|
},
|
|
42
42
|
"devDependencies": {
|
|
43
|
-
"@datocms/dashboard-client": "^1.
|
|
43
|
+
"@datocms/dashboard-client": "^1.1.2"
|
|
44
44
|
},
|
|
45
|
-
"gitHead": "
|
|
45
|
+
"gitHead": "60159cb125e4a493dbbeefb4ac3764d25c2abae8"
|
|
46
46
|
}
|