@datocms/cma-client 5.2.0-alpha.3 → 5.2.0-alpha.4

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.
Files changed (48) hide show
  1. package/dist/cjs/generated/Client.js +3 -3
  2. package/dist/cjs/generated/Client.js.map +1 -1
  3. package/dist/cjs/generated/resources/Role.js +8 -8
  4. package/dist/cjs/generated/resources/Role.js.map +1 -1
  5. package/dist/cjs/generated/resources/{SiteSearchSource.js → SearchIndex.js} +53 -53
  6. package/dist/cjs/generated/resources/SearchIndex.js.map +1 -0
  7. package/dist/cjs/generated/resources/{SiteSearchSourceEvent.js → SearchIndexEvent.js} +19 -19
  8. package/dist/cjs/generated/resources/SearchIndexEvent.js.map +1 -0
  9. package/dist/cjs/generated/resources/index.js +5 -5
  10. package/dist/cjs/generated/resources/index.js.map +1 -1
  11. package/dist/esm/generated/ApiTypes.d.ts +131 -131
  12. package/dist/esm/generated/Client.d.ts +2 -2
  13. package/dist/esm/generated/Client.js +3 -3
  14. package/dist/esm/generated/Client.js.map +1 -1
  15. package/dist/esm/generated/RawApiTypes.d.ts +136 -136
  16. package/dist/esm/generated/resources/Role.js +8 -8
  17. package/dist/esm/generated/resources/Role.js.map +1 -1
  18. package/dist/esm/generated/resources/{SiteSearchSource.d.ts → SearchIndex.d.ts} +40 -40
  19. package/dist/esm/generated/resources/{SiteSearchSource.js → SearchIndex.js} +52 -52
  20. package/dist/esm/generated/resources/SearchIndex.js.map +1 -0
  21. package/dist/esm/generated/resources/SearchIndexEvent.d.ts +61 -0
  22. package/dist/esm/generated/resources/{SiteSearchSourceEvent.js → SearchIndexEvent.js} +18 -18
  23. package/dist/esm/generated/resources/SearchIndexEvent.js.map +1 -0
  24. package/dist/esm/generated/resources/index.d.ts +2 -2
  25. package/dist/esm/generated/resources/index.js +2 -2
  26. package/dist/esm/generated/resources/index.js.map +1 -1
  27. package/dist/types/generated/ApiTypes.d.ts +131 -131
  28. package/dist/types/generated/Client.d.ts +2 -2
  29. package/dist/types/generated/RawApiTypes.d.ts +136 -136
  30. package/dist/types/generated/resources/{SiteSearchSource.d.ts → SearchIndex.d.ts} +40 -40
  31. package/dist/types/generated/resources/SearchIndexEvent.d.ts +61 -0
  32. package/dist/types/generated/resources/index.d.ts +2 -2
  33. package/package.json +3 -3
  34. package/resources.json +75 -75
  35. package/src/generated/ApiTypes.ts +132 -133
  36. package/src/generated/Client.ts +5 -5
  37. package/src/generated/RawApiTypes.ts +137 -137
  38. package/src/generated/resources/Role.ts +8 -8
  39. package/src/generated/resources/SearchIndex.ts +255 -0
  40. package/src/generated/resources/{SiteSearchSourceEvent.ts → SearchIndexEvent.ts} +32 -34
  41. package/src/generated/resources/index.ts +2 -2
  42. package/dist/cjs/generated/resources/SiteSearchSource.js.map +0 -1
  43. package/dist/cjs/generated/resources/SiteSearchSourceEvent.js.map +0 -1
  44. package/dist/esm/generated/resources/SiteSearchSource.js.map +0 -1
  45. package/dist/esm/generated/resources/SiteSearchSourceEvent.d.ts +0 -61
  46. package/dist/esm/generated/resources/SiteSearchSourceEvent.js.map +0 -1
  47. package/dist/types/generated/resources/SiteSearchSourceEvent.d.ts +0 -61
  48. package/src/generated/resources/SiteSearchSource.ts +0 -267
@@ -1,132 +1,132 @@
1
1
  import BaseResource from '../../BaseResource';
2
2
  import type * as ApiTypes from '../ApiTypes';
3
3
  import type * as RawApiTypes from '../RawApiTypes';
4
- export default class SiteSearchSource extends BaseResource {
5
- static readonly TYPE: "site_search_source";
4
+ export default class SearchIndex extends BaseResource {
5
+ static readonly TYPE: "search_index";
6
6
  /**
7
- * List all site search sources for a site
7
+ * List all search indexes for a site
8
8
  *
9
- * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/instances
9
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/instances
10
10
  *
11
11
  * @throws {ApiError}
12
12
  * @throws {TimeoutError}
13
13
  */
14
- list(): Promise<ApiTypes.SiteSearchSourceInstancesTargetSchema>;
14
+ list(): Promise<ApiTypes.SearchIndexInstancesTargetSchema>;
15
15
  /**
16
- * List all site search sources for a site
16
+ * List all search indexes for a site
17
17
  *
18
- * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/instances
18
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/instances
19
19
  *
20
20
  * @throws {ApiError}
21
21
  * @throws {TimeoutError}
22
22
  */
23
- rawList(): Promise<RawApiTypes.SiteSearchSourceInstancesTargetSchema>;
23
+ rawList(): Promise<RawApiTypes.SearchIndexInstancesTargetSchema>;
24
24
  /**
25
- * Retrieve a site search source
25
+ * Retrieve a search index
26
26
  *
27
- * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/self
27
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/self
28
28
  *
29
29
  * @throws {ApiError}
30
30
  * @throws {TimeoutError}
31
31
  */
32
- find(siteSearchSourceId: string | ApiTypes.SiteSearchSourceData): Promise<ApiTypes.SiteSearchSource>;
32
+ find(searchIndexId: string | ApiTypes.SearchIndexData): Promise<ApiTypes.SearchIndex>;
33
33
  /**
34
- * Retrieve a site search source
34
+ * Retrieve a search index
35
35
  *
36
- * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/self
36
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/self
37
37
  *
38
38
  * @throws {ApiError}
39
39
  * @throws {TimeoutError}
40
40
  */
41
- rawFind(siteSearchSourceId: string): Promise<RawApiTypes.SiteSearchSourceSelfTargetSchema>;
41
+ rawFind(searchIndexId: string): Promise<RawApiTypes.SearchIndexSelfTargetSchema>;
42
42
  /**
43
- * Create site search source
43
+ * Create search index
44
44
  *
45
- * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/create
45
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/create
46
46
  *
47
47
  * @throws {ApiError}
48
48
  * @throws {TimeoutError}
49
49
  */
50
- create(body: ApiTypes.SiteSearchSourceCreateSchema): Promise<ApiTypes.SiteSearchSource>;
50
+ create(body: ApiTypes.SearchIndexCreateSchema): Promise<ApiTypes.SearchIndex>;
51
51
  /**
52
- * Create site search source
52
+ * Create search index
53
53
  *
54
- * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/create
54
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/create
55
55
  *
56
56
  * @throws {ApiError}
57
57
  * @throws {TimeoutError}
58
58
  */
59
- rawCreate(body: RawApiTypes.SiteSearchSourceCreateSchema): Promise<RawApiTypes.SiteSearchSourceCreateTargetSchema>;
59
+ rawCreate(body: RawApiTypes.SearchIndexCreateSchema): Promise<RawApiTypes.SearchIndexCreateTargetSchema>;
60
60
  /**
61
- * Update site search source
61
+ * Update search index
62
62
  *
63
- * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/update
63
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/update
64
64
  *
65
65
  * @throws {ApiError}
66
66
  * @throws {TimeoutError}
67
67
  */
68
- update(siteSearchSourceId: string | ApiTypes.SiteSearchSourceData, body: ApiTypes.SiteSearchSourceUpdateSchema): Promise<ApiTypes.SiteSearchSource>;
68
+ update(searchIndexId: string | ApiTypes.SearchIndexData, body: ApiTypes.SearchIndexUpdateSchema): Promise<ApiTypes.SearchIndex>;
69
69
  /**
70
- * Update site search source
70
+ * Update search index
71
71
  *
72
- * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/update
72
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/update
73
73
  *
74
74
  * @throws {ApiError}
75
75
  * @throws {TimeoutError}
76
76
  */
77
- rawUpdate(siteSearchSourceId: string, body: RawApiTypes.SiteSearchSourceUpdateSchema): Promise<RawApiTypes.SiteSearchSourceUpdateTargetSchema>;
77
+ rawUpdate(searchIndexId: string, body: RawApiTypes.SearchIndexUpdateSchema): Promise<RawApiTypes.SearchIndexUpdateTargetSchema>;
78
78
  /**
79
79
  * Trigger a site search indexing
80
80
  *
81
- * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/trigger
81
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/trigger
82
82
  *
83
83
  * @throws {ApiError}
84
84
  * @throws {TimeoutError}
85
85
  */
86
- trigger(siteSearchSourceId: string | ApiTypes.SiteSearchSourceData): Promise<void>;
86
+ trigger(searchIndexId: string | ApiTypes.SearchIndexData): Promise<void>;
87
87
  /**
88
88
  * Trigger a site search indexing
89
89
  *
90
- * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/trigger
90
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/trigger
91
91
  *
92
92
  * @throws {ApiError}
93
93
  * @throws {TimeoutError}
94
94
  */
95
- rawTrigger(siteSearchSourceId: string): Promise<void>;
95
+ rawTrigger(searchIndexId: string): Promise<void>;
96
96
  /**
97
97
  * Abort a site search spidering and mark it as failed
98
98
  *
99
- * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/abort
99
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/abort
100
100
  *
101
101
  * @throws {ApiError}
102
102
  * @throws {TimeoutError}
103
103
  */
104
- abort(siteSearchSourceId: string | ApiTypes.SiteSearchSourceData): Promise<void>;
104
+ abort(searchIndexId: string | ApiTypes.SearchIndexData): Promise<void>;
105
105
  /**
106
106
  * Abort a site search spidering and mark it as failed
107
107
  *
108
- * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/abort
108
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/abort
109
109
  *
110
110
  * @throws {ApiError}
111
111
  * @throws {TimeoutError}
112
112
  */
113
- rawAbort(siteSearchSourceId: string): Promise<void>;
113
+ rawAbort(searchIndexId: string): Promise<void>;
114
114
  /**
115
- * Delete a site search source
115
+ * Delete a search index
116
116
  *
117
- * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/destroy
117
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/destroy
118
118
  *
119
119
  * @throws {ApiError}
120
120
  * @throws {TimeoutError}
121
121
  */
122
- destroy(siteSearchSourceId: string | ApiTypes.SiteSearchSourceData): Promise<ApiTypes.SiteSearchSource>;
122
+ destroy(searchIndexId: string | ApiTypes.SearchIndexData): Promise<ApiTypes.SearchIndex>;
123
123
  /**
124
- * Delete a site search source
124
+ * Delete a search index
125
125
  *
126
- * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/destroy
126
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/destroy
127
127
  *
128
128
  * @throws {ApiError}
129
129
  * @throws {TimeoutError}
130
130
  */
131
- rawDestroy(siteSearchSourceId: string): Promise<RawApiTypes.SiteSearchSourceDestroyTargetSchema>;
131
+ rawDestroy(searchIndexId: string): Promise<RawApiTypes.SearchIndexDestroyTargetSchema>;
132
132
  }
@@ -0,0 +1,61 @@
1
+ import * as Utils from '@datocms/rest-client-utils';
2
+ import BaseResource from '../../BaseResource';
3
+ import type * as ApiTypes from '../ApiTypes';
4
+ import type * as RawApiTypes from '../RawApiTypes';
5
+ export default class SearchIndexEvent extends BaseResource {
6
+ static readonly TYPE: "search_index_event";
7
+ /**
8
+ * List all search indexing events
9
+ *
10
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index_event/instances
11
+ *
12
+ * @throws {ApiError}
13
+ * @throws {TimeoutError}
14
+ */
15
+ list(queryParams?: ApiTypes.SearchIndexEventInstancesHrefSchema): Promise<ApiTypes.SearchIndexEventInstancesTargetSchema>;
16
+ /**
17
+ * List all search indexing events
18
+ *
19
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index_event/instances
20
+ *
21
+ * @throws {ApiError}
22
+ * @throws {TimeoutError}
23
+ */
24
+ rawList(queryParams?: RawApiTypes.SearchIndexEventInstancesHrefSchema): Promise<RawApiTypes.SearchIndexEventInstancesTargetSchema>;
25
+ /**
26
+ * Async iterator to auto-paginate over elements returned by list()
27
+ *
28
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index_event/instances
29
+ *
30
+ * @throws {ApiError}
31
+ * @throws {TimeoutError}
32
+ */
33
+ listPagedIterator(queryParams?: Utils.OmitFromKnownKeys<ApiTypes.SearchIndexEventInstancesHrefSchema, 'page'>, iteratorOptions?: Utils.IteratorOptions): AsyncGenerator<ApiTypes.SearchIndexEvent, void, unknown>;
34
+ /**
35
+ * Async iterator to auto-paginate over elements returned by rawList()
36
+ *
37
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index_event/instances
38
+ *
39
+ * @throws {ApiError}
40
+ * @throws {TimeoutError}
41
+ */
42
+ rawListPagedIterator(queryParams?: Utils.OmitFromKnownKeys<RawApiTypes.SearchIndexEventInstancesHrefSchema, 'page'>, iteratorOptions?: Utils.IteratorOptions): AsyncGenerator<RawApiTypes.SearchIndexEvent, void, unknown>;
43
+ /**
44
+ * Retrieve a search indexing event
45
+ *
46
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index_event/self
47
+ *
48
+ * @throws {ApiError}
49
+ * @throws {TimeoutError}
50
+ */
51
+ find(searchIndexEventId: string | ApiTypes.SearchIndexEventData): Promise<ApiTypes.SearchIndexEvent>;
52
+ /**
53
+ * Retrieve a search indexing event
54
+ *
55
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index_event/self
56
+ *
57
+ * @throws {ApiError}
58
+ * @throws {TimeoutError}
59
+ */
60
+ rawFind(searchIndexEventId: string): Promise<RawApiTypes.SearchIndexEventSelfTargetSchema>;
61
+ }
@@ -15,7 +15,7 @@ export { default as JobResult } from './JobResult';
15
15
  export { default as SubscriptionLimit } from './SubscriptionLimit';
16
16
  export { default as SubscriptionFeature } from './SubscriptionFeature';
17
17
  export { default as BuildEvent } from './BuildEvent';
18
- export { default as SiteSearchSourceEvent } from './SiteSearchSourceEvent';
18
+ export { default as SearchIndexEvent } from './SearchIndexEvent';
19
19
  export { default as Item } from './Item';
20
20
  export { default as ItemVersion } from './ItemVersion';
21
21
  export { default as Upload } from './Upload';
@@ -29,7 +29,7 @@ export { default as MaintenanceMode } from './MaintenanceMode';
29
29
  export { default as Webhook } from './Webhook';
30
30
  export { default as WebhookCall } from './WebhookCall';
31
31
  export { default as BuildTrigger } from './BuildTrigger';
32
- export { default as SiteSearchSource } from './SiteSearchSource';
32
+ export { default as SearchIndex } from './SearchIndex';
33
33
  export { default as ItemTypeFilter } from './ItemTypeFilter';
34
34
  export { default as UploadFilter } from './UploadFilter';
35
35
  export { default as SiteInvitation } from './SiteInvitation';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@datocms/cma-client",
3
- "version": "5.2.0-alpha.3",
3
+ "version": "5.2.0-alpha.4",
4
4
  "description": "JS client for DatoCMS REST Content Management API",
5
5
  "keywords": [
6
6
  "datocms",
@@ -42,8 +42,8 @@
42
42
  "uuid": "^9.0.1"
43
43
  },
44
44
  "devDependencies": {
45
- "@datocms/dashboard-client": "^5.2.0-alpha.3",
45
+ "@datocms/dashboard-client": "^5.2.0-alpha.4",
46
46
  "@types/uuid": "^9.0.7"
47
47
  },
48
- "gitHead": "cbaad3363bbe1fa53160b9b03d76ac594fd3c798"
48
+ "gitHead": "319efa216e04297104dc7278ef514c7a8ab10355"
49
49
  }
package/resources.json CHANGED
@@ -27,7 +27,7 @@
27
27
  "environments_access",
28
28
  "can_manage_users",
29
29
  "can_manage_shared_filters",
30
- "can_manage_site_search_sources",
30
+ "can_manage_search_indexes",
31
31
  "can_manage_upload_collections",
32
32
  "can_manage_build_triggers",
33
33
  "can_manage_webhooks",
@@ -38,15 +38,15 @@
38
38
  "can_manage_access_tokens",
39
39
  "can_perform_site_search",
40
40
  "can_access_build_events_log",
41
- "can_access_site_search_source_events_log",
41
+ "can_access_search_index_events_log",
42
42
  "positive_item_type_permissions",
43
43
  "negative_item_type_permissions",
44
44
  "positive_upload_permissions",
45
45
  "negative_upload_permissions",
46
46
  "positive_build_trigger_permissions",
47
47
  "negative_build_trigger_permissions",
48
- "positive_site_search_source_permissions",
49
- "negative_site_search_source_permissions"
48
+ "positive_search_index_permissions",
49
+ "negative_search_index_permissions"
50
50
  ],
51
51
  "relationships": ["inherits_permissions_from"]
52
52
  },
@@ -92,7 +92,7 @@
92
92
  "environments_access",
93
93
  "can_manage_users",
94
94
  "can_manage_shared_filters",
95
- "can_manage_site_search_sources",
95
+ "can_manage_search_indexes",
96
96
  "can_manage_upload_collections",
97
97
  "can_manage_build_triggers",
98
98
  "can_manage_webhooks",
@@ -103,15 +103,15 @@
103
103
  "can_manage_access_tokens",
104
104
  "can_perform_site_search",
105
105
  "can_access_build_events_log",
106
- "can_access_site_search_source_events_log",
106
+ "can_access_search_index_events_log",
107
107
  "positive_item_type_permissions",
108
108
  "negative_item_type_permissions",
109
109
  "positive_upload_permissions",
110
110
  "negative_upload_permissions",
111
111
  "positive_build_trigger_permissions",
112
112
  "negative_build_trigger_permissions",
113
- "positive_site_search_source_permissions",
114
- "negative_site_search_source_permissions"
113
+ "positive_search_index_permissions",
114
+ "negative_search_index_permissions"
115
115
  ],
116
116
  "relationships": ["inherits_permissions_from"]
117
117
  },
@@ -2159,22 +2159,22 @@
2159
2159
  "resourceClassName": "BuildEvent"
2160
2160
  },
2161
2161
  {
2162
- "jsonApiType": "site_search_source_event",
2162
+ "jsonApiType": "search_index_event",
2163
2163
  "endpoints": [
2164
2164
  {
2165
2165
  "returnsItem": false,
2166
2166
  "requestBodyRequiresItem": false,
2167
2167
  "offersNestedItemsOptionInQueryParams": false,
2168
- "docUrl": "https://www.datocms.com/docs/content-management-api/resources/site-search_source_event/instances",
2168
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/search-index_event/instances",
2169
2169
  "rel": "instances",
2170
- "urlTemplate": "/site-search-source-events",
2170
+ "urlTemplate": "/search-index-events",
2171
2171
  "method": "GET",
2172
- "comment": "List all site search indexing events",
2172
+ "comment": "List all search indexing events",
2173
2173
  "urlPlaceholders": [],
2174
2174
  "optionalRequestBody": false,
2175
- "queryParamsType": "SiteSearchSourceEventInstancesHrefSchema",
2175
+ "queryParamsType": "SearchIndexEventInstancesHrefSchema",
2176
2176
  "queryParamsRequired": false,
2177
- "responseType": "SiteSearchSourceEventInstancesTargetSchema",
2177
+ "responseType": "SearchIndexEventInstancesTargetSchema",
2178
2178
  "paginatedResponse": {
2179
2179
  "defaultLimit": 30,
2180
2180
  "maxLimit": 500
@@ -2186,32 +2186,32 @@
2186
2186
  "returnsItem": false,
2187
2187
  "requestBodyRequiresItem": false,
2188
2188
  "offersNestedItemsOptionInQueryParams": false,
2189
- "docUrl": "https://www.datocms.com/docs/content-management-api/resources/site-search_source_event/self",
2189
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/search-index_event/self",
2190
2190
  "rel": "self",
2191
- "urlTemplate": "/site-search-source-events/${siteSearchSourceEventId}",
2191
+ "urlTemplate": "/search-index-events/${searchIndexEventId}",
2192
2192
  "method": "GET",
2193
- "comment": "Retrieve a site search indexing event",
2193
+ "comment": "Retrieve a search indexing event",
2194
2194
  "urlPlaceholders": [
2195
2195
  {
2196
- "variableName": "siteSearchSourceEventId",
2196
+ "variableName": "searchIndexEventId",
2197
2197
  "isEntityId": true,
2198
- "relType": "SiteSearchSourceEventData"
2198
+ "relType": "SearchIndexEventData"
2199
2199
  }
2200
2200
  ],
2201
2201
  "entityIdPlaceholder": {
2202
- "variableName": "siteSearchSourceEventId",
2202
+ "variableName": "searchIndexEventId",
2203
2203
  "isEntityId": true,
2204
- "relType": "SiteSearchSourceEventData"
2204
+ "relType": "SearchIndexEventData"
2205
2205
  },
2206
2206
  "optionalRequestBody": false,
2207
2207
  "queryParamsRequired": false,
2208
- "responseType": "SiteSearchSourceEventSelfTargetSchema",
2208
+ "responseType": "SearchIndexEventSelfTargetSchema",
2209
2209
  "name": "find",
2210
2210
  "rawName": "rawFind"
2211
2211
  }
2212
2212
  ],
2213
- "namespace": "siteSearchSourceEvents",
2214
- "resourceClassName": "SiteSearchSourceEvent"
2213
+ "namespace": "searchIndexEvents",
2214
+ "resourceClassName": "SearchIndexEvent"
2215
2215
  },
2216
2216
  {
2217
2217
  "jsonApiType": "item",
@@ -4000,21 +4000,21 @@
4000
4000
  "resourceClassName": "BuildTrigger"
4001
4001
  },
4002
4002
  {
4003
- "jsonApiType": "site_search_source",
4003
+ "jsonApiType": "search_index",
4004
4004
  "endpoints": [
4005
4005
  {
4006
4006
  "returnsItem": false,
4007
4007
  "requestBodyRequiresItem": false,
4008
4008
  "offersNestedItemsOptionInQueryParams": false,
4009
- "docUrl": "https://www.datocms.com/docs/content-management-api/resources/site-search_source/instances",
4009
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/search-index/instances",
4010
4010
  "rel": "instances",
4011
- "urlTemplate": "/site-search-sources",
4011
+ "urlTemplate": "/search-indexes",
4012
4012
  "method": "GET",
4013
- "comment": "List all site search sources for a site",
4013
+ "comment": "List all search indexes for a site",
4014
4014
  "urlPlaceholders": [],
4015
4015
  "optionalRequestBody": false,
4016
4016
  "queryParamsRequired": false,
4017
- "responseType": "SiteSearchSourceInstancesTargetSchema",
4017
+ "responseType": "SearchIndexInstancesTargetSchema",
4018
4018
  "name": "list",
4019
4019
  "rawName": "rawList"
4020
4020
  },
@@ -4022,26 +4022,26 @@
4022
4022
  "returnsItem": false,
4023
4023
  "requestBodyRequiresItem": false,
4024
4024
  "offersNestedItemsOptionInQueryParams": false,
4025
- "docUrl": "https://www.datocms.com/docs/content-management-api/resources/site-search_source/self",
4025
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/search-index/self",
4026
4026
  "rel": "self",
4027
- "urlTemplate": "/site-search-sources/${siteSearchSourceId}",
4027
+ "urlTemplate": "/search-indexes/${searchIndexId}",
4028
4028
  "method": "GET",
4029
- "comment": "Retrieve a site search source",
4029
+ "comment": "Retrieve a search index",
4030
4030
  "urlPlaceholders": [
4031
4031
  {
4032
- "variableName": "siteSearchSourceId",
4032
+ "variableName": "searchIndexId",
4033
4033
  "isEntityId": true,
4034
- "relType": "SiteSearchSourceData"
4034
+ "relType": "SearchIndexData"
4035
4035
  }
4036
4036
  ],
4037
4037
  "entityIdPlaceholder": {
4038
- "variableName": "siteSearchSourceId",
4038
+ "variableName": "searchIndexId",
4039
4039
  "isEntityId": true,
4040
- "relType": "SiteSearchSourceData"
4040
+ "relType": "SearchIndexData"
4041
4041
  },
4042
4042
  "optionalRequestBody": false,
4043
4043
  "queryParamsRequired": false,
4044
- "responseType": "SiteSearchSourceSelfTargetSchema",
4044
+ "responseType": "SearchIndexSelfTargetSchema",
4045
4045
  "name": "find",
4046
4046
  "rawName": "rawFind"
4047
4047
  },
@@ -4049,16 +4049,16 @@
4049
4049
  "returnsItem": false,
4050
4050
  "requestBodyRequiresItem": false,
4051
4051
  "offersNestedItemsOptionInQueryParams": false,
4052
- "docUrl": "https://www.datocms.com/docs/content-management-api/resources/site-search_source/create",
4052
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/search-index/create",
4053
4053
  "rel": "create",
4054
- "urlTemplate": "/site-search-sources",
4054
+ "urlTemplate": "/search-indexes",
4055
4055
  "method": "POST",
4056
- "comment": "Create site search source",
4056
+ "comment": "Create search index",
4057
4057
  "urlPlaceholders": [],
4058
- "requestBodyType": "SiteSearchSourceCreateSchema",
4058
+ "requestBodyType": "SearchIndexCreateSchema",
4059
4059
  "optionalRequestBody": false,
4060
4060
  "requestStructure": {
4061
- "type": "site_search_source",
4061
+ "type": "search_index",
4062
4062
  "attributes": [
4063
4063
  "name",
4064
4064
  "enabled",
@@ -4069,7 +4069,7 @@
4069
4069
  "relationships": ["build_triggers"]
4070
4070
  },
4071
4071
  "queryParamsRequired": false,
4072
- "responseType": "SiteSearchSourceCreateTargetSchema",
4072
+ "responseType": "SearchIndexCreateTargetSchema",
4073
4073
  "name": "create",
4074
4074
  "rawName": "rawCreate"
4075
4075
  },
@@ -4077,27 +4077,27 @@
4077
4077
  "returnsItem": false,
4078
4078
  "requestBodyRequiresItem": false,
4079
4079
  "offersNestedItemsOptionInQueryParams": false,
4080
- "docUrl": "https://www.datocms.com/docs/content-management-api/resources/site-search_source/update",
4080
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/search-index/update",
4081
4081
  "rel": "update",
4082
- "urlTemplate": "/site-search-sources/${siteSearchSourceId}",
4082
+ "urlTemplate": "/search-indexes/${searchIndexId}",
4083
4083
  "method": "PUT",
4084
- "comment": "Update site search source",
4084
+ "comment": "Update search index",
4085
4085
  "urlPlaceholders": [
4086
4086
  {
4087
- "variableName": "siteSearchSourceId",
4087
+ "variableName": "searchIndexId",
4088
4088
  "isEntityId": true,
4089
- "relType": "SiteSearchSourceData"
4089
+ "relType": "SearchIndexData"
4090
4090
  }
4091
4091
  ],
4092
4092
  "entityIdPlaceholder": {
4093
- "variableName": "siteSearchSourceId",
4093
+ "variableName": "searchIndexId",
4094
4094
  "isEntityId": true,
4095
- "relType": "SiteSearchSourceData"
4095
+ "relType": "SearchIndexData"
4096
4096
  },
4097
- "requestBodyType": "SiteSearchSourceUpdateSchema",
4097
+ "requestBodyType": "SearchIndexUpdateSchema",
4098
4098
  "optionalRequestBody": false,
4099
4099
  "requestStructure": {
4100
- "type": "site_search_source",
4100
+ "type": "search_index",
4101
4101
  "idRequired": true,
4102
4102
  "attributes": [
4103
4103
  "name",
@@ -4109,7 +4109,7 @@
4109
4109
  "relationships": ["build_triggers"]
4110
4110
  },
4111
4111
  "queryParamsRequired": false,
4112
- "responseType": "SiteSearchSourceUpdateTargetSchema",
4112
+ "responseType": "SearchIndexUpdateTargetSchema",
4113
4113
  "name": "update",
4114
4114
  "rawName": "rawUpdate"
4115
4115
  },
@@ -4117,22 +4117,22 @@
4117
4117
  "returnsItem": false,
4118
4118
  "requestBodyRequiresItem": false,
4119
4119
  "offersNestedItemsOptionInQueryParams": false,
4120
- "docUrl": "https://www.datocms.com/docs/content-management-api/resources/site-search_source/trigger",
4120
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/search-index/trigger",
4121
4121
  "rel": "trigger",
4122
- "urlTemplate": "/site-search-sources/${siteSearchSourceId}/trigger",
4122
+ "urlTemplate": "/search-indexes/${searchIndexId}/trigger",
4123
4123
  "method": "POST",
4124
4124
  "comment": "Trigger a site search indexing",
4125
4125
  "urlPlaceholders": [
4126
4126
  {
4127
- "variableName": "siteSearchSourceId",
4127
+ "variableName": "searchIndexId",
4128
4128
  "isEntityId": true,
4129
- "relType": "SiteSearchSourceData"
4129
+ "relType": "SearchIndexData"
4130
4130
  }
4131
4131
  ],
4132
4132
  "entityIdPlaceholder": {
4133
- "variableName": "siteSearchSourceId",
4133
+ "variableName": "searchIndexId",
4134
4134
  "isEntityId": true,
4135
- "relType": "SiteSearchSourceData"
4135
+ "relType": "SearchIndexData"
4136
4136
  },
4137
4137
  "optionalRequestBody": false,
4138
4138
  "queryParamsRequired": false,
@@ -4143,22 +4143,22 @@
4143
4143
  "returnsItem": false,
4144
4144
  "requestBodyRequiresItem": false,
4145
4145
  "offersNestedItemsOptionInQueryParams": false,
4146
- "docUrl": "https://www.datocms.com/docs/content-management-api/resources/site-search_source/abort",
4146
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/search-index/abort",
4147
4147
  "rel": "abort",
4148
- "urlTemplate": "/site-search-sources/${siteSearchSourceId}/abort",
4148
+ "urlTemplate": "/search-indexes/${searchIndexId}/abort",
4149
4149
  "method": "DELETE",
4150
4150
  "comment": "Abort a site search spidering and mark it as failed",
4151
4151
  "urlPlaceholders": [
4152
4152
  {
4153
- "variableName": "siteSearchSourceId",
4153
+ "variableName": "searchIndexId",
4154
4154
  "isEntityId": true,
4155
- "relType": "SiteSearchSourceData"
4155
+ "relType": "SearchIndexData"
4156
4156
  }
4157
4157
  ],
4158
4158
  "entityIdPlaceholder": {
4159
- "variableName": "siteSearchSourceId",
4159
+ "variableName": "searchIndexId",
4160
4160
  "isEntityId": true,
4161
- "relType": "SiteSearchSourceData"
4161
+ "relType": "SearchIndexData"
4162
4162
  },
4163
4163
  "optionalRequestBody": false,
4164
4164
  "queryParamsRequired": false,
@@ -4169,32 +4169,32 @@
4169
4169
  "returnsItem": false,
4170
4170
  "requestBodyRequiresItem": false,
4171
4171
  "offersNestedItemsOptionInQueryParams": false,
4172
- "docUrl": "https://www.datocms.com/docs/content-management-api/resources/site-search_source/destroy",
4172
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/search-index/destroy",
4173
4173
  "rel": "destroy",
4174
- "urlTemplate": "/site-search-sources/${siteSearchSourceId}",
4174
+ "urlTemplate": "/search-indexes/${searchIndexId}",
4175
4175
  "method": "DELETE",
4176
- "comment": "Delete a site search source",
4176
+ "comment": "Delete a search index",
4177
4177
  "urlPlaceholders": [
4178
4178
  {
4179
- "variableName": "siteSearchSourceId",
4179
+ "variableName": "searchIndexId",
4180
4180
  "isEntityId": true,
4181
- "relType": "SiteSearchSourceData"
4181
+ "relType": "SearchIndexData"
4182
4182
  }
4183
4183
  ],
4184
4184
  "entityIdPlaceholder": {
4185
- "variableName": "siteSearchSourceId",
4185
+ "variableName": "searchIndexId",
4186
4186
  "isEntityId": true,
4187
- "relType": "SiteSearchSourceData"
4187
+ "relType": "SearchIndexData"
4188
4188
  },
4189
4189
  "optionalRequestBody": false,
4190
4190
  "queryParamsRequired": false,
4191
- "responseType": "SiteSearchSourceDestroyTargetSchema",
4191
+ "responseType": "SearchIndexDestroyTargetSchema",
4192
4192
  "name": "destroy",
4193
4193
  "rawName": "rawDestroy"
4194
4194
  }
4195
4195
  ],
4196
- "namespace": "siteSearchSources",
4197
- "resourceClassName": "SiteSearchSource"
4196
+ "namespace": "searchIndexes",
4197
+ "resourceClassName": "SearchIndex"
4198
4198
  },
4199
4199
  {
4200
4200
  "jsonApiType": "item_type_filter",