@datocms/cma-client 5.2.0-alpha.2 → 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} +55 -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 +147 -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 +148 -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} +54 -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 +147 -131
  28. package/dist/types/generated/Client.d.ts +2 -2
  29. package/dist/types/generated/RawApiTypes.d.ts +148 -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 +79 -77
  35. package/src/generated/ApiTypes.ts +148 -133
  36. package/src/generated/Client.ts +5 -5
  37. package/src/generated/RawApiTypes.ts +149 -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 -265
@@ -23,7 +23,7 @@ export default class Role extends BaseResource {
23
23
  'environments_access',
24
24
  'can_manage_users',
25
25
  'can_manage_shared_filters',
26
- 'can_manage_site_search_sources',
26
+ 'can_manage_search_indexes',
27
27
  'can_manage_upload_collections',
28
28
  'can_manage_build_triggers',
29
29
  'can_manage_webhooks',
@@ -34,15 +34,15 @@ export default class Role extends BaseResource {
34
34
  'can_manage_access_tokens',
35
35
  'can_perform_site_search',
36
36
  'can_access_build_events_log',
37
- 'can_access_site_search_source_events_log',
37
+ 'can_access_search_index_events_log',
38
38
  'positive_item_type_permissions',
39
39
  'negative_item_type_permissions',
40
40
  'positive_upload_permissions',
41
41
  'negative_upload_permissions',
42
42
  'positive_build_trigger_permissions',
43
43
  'negative_build_trigger_permissions',
44
- 'positive_site_search_source_permissions',
45
- 'negative_site_search_source_permissions',
44
+ 'positive_search_index_permissions',
45
+ 'negative_search_index_permissions',
46
46
  ],
47
47
  relationships: ['inherits_permissions_from'],
48
48
  })).then((body) => Utils.deserializeResponseBody(body));
@@ -85,7 +85,7 @@ export default class Role extends BaseResource {
85
85
  'environments_access',
86
86
  'can_manage_users',
87
87
  'can_manage_shared_filters',
88
- 'can_manage_site_search_sources',
88
+ 'can_manage_search_indexes',
89
89
  'can_manage_upload_collections',
90
90
  'can_manage_build_triggers',
91
91
  'can_manage_webhooks',
@@ -96,15 +96,15 @@ export default class Role extends BaseResource {
96
96
  'can_manage_access_tokens',
97
97
  'can_perform_site_search',
98
98
  'can_access_build_events_log',
99
- 'can_access_site_search_source_events_log',
99
+ 'can_access_search_index_events_log',
100
100
  'positive_item_type_permissions',
101
101
  'negative_item_type_permissions',
102
102
  'positive_upload_permissions',
103
103
  'negative_upload_permissions',
104
104
  'positive_build_trigger_permissions',
105
105
  'negative_build_trigger_permissions',
106
- 'positive_site_search_source_permissions',
107
- 'negative_site_search_source_permissions',
106
+ 'positive_search_index_permissions',
107
+ 'negative_search_index_permissions',
108
108
  ],
109
109
  relationships: ['inherits_permissions_from'],
110
110
  })).then((body) => Utils.deserializeResponseBody(body));
@@ -1 +1 @@
1
- {"version":3,"file":"Role.js","sourceRoot":"","sources":["../../../../src/generated/resources/Role.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,4BAA4B,CAAC;AACpD,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAI9C,MAAM,CAAC,OAAO,OAAO,IAAK,SAAQ,YAAY;IAG5C;;;;;;;OAOG;IACH,MAAM,CAAC,IAA+B;QACpC,OAAO,IAAI,CAAC,SAAS,CACnB,KAAK,CAAC,oBAAoB,CAA+B,IAAI,EAAE;YAC7D,IAAI,EAAE,MAAM;YACZ,UAAU,EAAE;gBACV,MAAM;gBACN,kBAAkB;gBAClB,eAAe;gBACf,iBAAiB;gBACjB,iBAAiB;gBACjB,sBAAsB;gBACtB,0BAA0B;gBAC1B,qBAAqB;gBACrB,kBAAkB;gBAClB,2BAA2B;gBAC3B,gCAAgC;gBAChC,+BAA+B;gBAC/B,2BAA2B;gBAC3B,qBAAqB;gBACrB,yBAAyB;gBACzB,gBAAgB;gBAChB,sBAAsB;gBACtB,sBAAsB;gBACtB,0BAA0B;gBAC1B,yBAAyB;gBACzB,6BAA6B;gBAC7B,0CAA0C;gBAC1C,gCAAgC;gBAChC,gCAAgC;gBAChC,6BAA6B;gBAC7B,6BAA6B;gBAC7B,oCAAoC;gBACpC,oCAAoC;gBACpC,yCAAyC;gBACzC,yCAAyC;aAC1C;YACD,aAAa,EAAE,CAAC,2BAA2B,CAAC;SAC7C,CAAC,CACH,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CACd,KAAK,CAAC,uBAAuB,CAAkC,IAAI,CAAC,CACrE,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,SAAS,CACP,IAAkC;QAElC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAqC;YAC7D,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,QAAQ;YACb,IAAI;SACL,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,MAAkC,EAAE,IAA+B;QACxE,OAAO,IAAI,CAAC,SAAS,CACnB,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,EAClB,KAAK,CAAC,oBAAoB,CAA+B,IAAI,EAAE;YAC7D,EAAE,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC;YACtB,IAAI,EAAE,MAAM;YACZ,UAAU,EAAE;gBACV,MAAM;gBACN,kBAAkB;gBAClB,eAAe;gBACf,iBAAiB;gBACjB,iBAAiB;gBACjB,sBAAsB;gBACtB,0BAA0B;gBAC1B,qBAAqB;gBACrB,kBAAkB;gBAClB,2BAA2B;gBAC3B,gCAAgC;gBAChC,+BAA+B;gBAC/B,2BAA2B;gBAC3B,qBAAqB;gBACrB,yBAAyB;gBACzB,gBAAgB;gBAChB,sBAAsB;gBACtB,sBAAsB;gBACtB,0BAA0B;gBAC1B,yBAAyB;gBACzB,6BAA6B;gBAC7B,0CAA0C;gBAC1C,gCAAgC;gBAChC,gCAAgC;gBAChC,6BAA6B;gBAC7B,6BAA6B;gBAC7B,oCAAoC;gBACpC,oCAAoC;gBACpC,yCAAyC;gBACzC,yCAAyC;aAC1C;YACD,aAAa,EAAE,CAAC,2BAA2B,CAAC;SAC7C,CAAC,CACH,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CACd,KAAK,CAAC,uBAAuB,CAAkC,IAAI,CAAC,CACrE,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,SAAS,CACP,MAAc,EACd,IAAkC;QAElC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAqC;YAC7D,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,UAAU,MAAM,EAAE;YACvB,IAAI;SACL,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,IAAI;QACF,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAClC,KAAK,CAAC,uBAAuB,CAAqC,IAAI,CAAC,CACxE,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAwC;YAChE,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,QAAQ;SACd,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CAAC,MAAkC;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CACpD,KAAK,CAAC,uBAAuB,CAAgC,IAAI,CAAC,CACnE,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CAAC,MAAc;QACpB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAmC;YAC3D,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,UAAU,MAAM,EAAE;SACxB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CAAC,MAAkC;QACxC,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CACvD,KAAK,CAAC,uBAAuB,CAAmC,IAAI,CAAC,CACtE,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,UAAU,CAAC,MAAc;QACvB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAsC;YAC9D,MAAM,EAAE,QAAQ;YAChB,GAAG,EAAE,UAAU,MAAM,EAAE;SACxB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,SAAS,CAAC,MAAkC;QAC1C,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CACzD,KAAK,CAAC,uBAAuB,CAAqC,IAAI,CAAC,CACxE,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,YAAY,CAAC,MAAc;QACzB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAwC;YAChE,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,UAAU,MAAM,YAAY;SAClC,CAAC,CAAC;IACL,CAAC;;AAjQe,SAAI,GAAG,MAAe,CAAC"}
1
+ {"version":3,"file":"Role.js","sourceRoot":"","sources":["../../../../src/generated/resources/Role.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,4BAA4B,CAAC;AACpD,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAI9C,MAAM,CAAC,OAAO,OAAO,IAAK,SAAQ,YAAY;IAG5C;;;;;;;OAOG;IACH,MAAM,CAAC,IAA+B;QACpC,OAAO,IAAI,CAAC,SAAS,CACnB,KAAK,CAAC,oBAAoB,CAA+B,IAAI,EAAE;YAC7D,IAAI,EAAE,MAAM;YACZ,UAAU,EAAE;gBACV,MAAM;gBACN,kBAAkB;gBAClB,eAAe;gBACf,iBAAiB;gBACjB,iBAAiB;gBACjB,sBAAsB;gBACtB,0BAA0B;gBAC1B,qBAAqB;gBACrB,kBAAkB;gBAClB,2BAA2B;gBAC3B,2BAA2B;gBAC3B,+BAA+B;gBAC/B,2BAA2B;gBAC3B,qBAAqB;gBACrB,yBAAyB;gBACzB,gBAAgB;gBAChB,sBAAsB;gBACtB,sBAAsB;gBACtB,0BAA0B;gBAC1B,yBAAyB;gBACzB,6BAA6B;gBAC7B,oCAAoC;gBACpC,gCAAgC;gBAChC,gCAAgC;gBAChC,6BAA6B;gBAC7B,6BAA6B;gBAC7B,oCAAoC;gBACpC,oCAAoC;gBACpC,mCAAmC;gBACnC,mCAAmC;aACpC;YACD,aAAa,EAAE,CAAC,2BAA2B,CAAC;SAC7C,CAAC,CACH,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CACd,KAAK,CAAC,uBAAuB,CAAkC,IAAI,CAAC,CACrE,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,SAAS,CACP,IAAkC;QAElC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAqC;YAC7D,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,QAAQ;YACb,IAAI;SACL,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,MAAkC,EAAE,IAA+B;QACxE,OAAO,IAAI,CAAC,SAAS,CACnB,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,EAClB,KAAK,CAAC,oBAAoB,CAA+B,IAAI,EAAE;YAC7D,EAAE,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC;YACtB,IAAI,EAAE,MAAM;YACZ,UAAU,EAAE;gBACV,MAAM;gBACN,kBAAkB;gBAClB,eAAe;gBACf,iBAAiB;gBACjB,iBAAiB;gBACjB,sBAAsB;gBACtB,0BAA0B;gBAC1B,qBAAqB;gBACrB,kBAAkB;gBAClB,2BAA2B;gBAC3B,2BAA2B;gBAC3B,+BAA+B;gBAC/B,2BAA2B;gBAC3B,qBAAqB;gBACrB,yBAAyB;gBACzB,gBAAgB;gBAChB,sBAAsB;gBACtB,sBAAsB;gBACtB,0BAA0B;gBAC1B,yBAAyB;gBACzB,6BAA6B;gBAC7B,oCAAoC;gBACpC,gCAAgC;gBAChC,gCAAgC;gBAChC,6BAA6B;gBAC7B,6BAA6B;gBAC7B,oCAAoC;gBACpC,oCAAoC;gBACpC,mCAAmC;gBACnC,mCAAmC;aACpC;YACD,aAAa,EAAE,CAAC,2BAA2B,CAAC;SAC7C,CAAC,CACH,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CACd,KAAK,CAAC,uBAAuB,CAAkC,IAAI,CAAC,CACrE,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,SAAS,CACP,MAAc,EACd,IAAkC;QAElC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAqC;YAC7D,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,UAAU,MAAM,EAAE;YACvB,IAAI;SACL,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,IAAI;QACF,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAClC,KAAK,CAAC,uBAAuB,CAAqC,IAAI,CAAC,CACxE,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAwC;YAChE,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,QAAQ;SACd,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CAAC,MAAkC;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CACpD,KAAK,CAAC,uBAAuB,CAAgC,IAAI,CAAC,CACnE,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CAAC,MAAc;QACpB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAmC;YAC3D,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,UAAU,MAAM,EAAE;SACxB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CAAC,MAAkC;QACxC,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CACvD,KAAK,CAAC,uBAAuB,CAAmC,IAAI,CAAC,CACtE,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,UAAU,CAAC,MAAc;QACvB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAsC;YAC9D,MAAM,EAAE,QAAQ;YAChB,GAAG,EAAE,UAAU,MAAM,EAAE;SACxB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,SAAS,CAAC,MAAkC;QAC1C,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CACzD,KAAK,CAAC,uBAAuB,CAAqC,IAAI,CAAC,CACxE,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,YAAY,CAAC,MAAc;QACzB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAwC;YAChE,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,UAAU,MAAM,YAAY;SAClC,CAAC,CAAC;IACL,CAAC;;AAjQe,SAAI,GAAG,MAAe,CAAC"}
@@ -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
  }
@@ -1,10 +1,10 @@
1
1
  import * as Utils from '@datocms/rest-client-utils';
2
2
  import BaseResource from '../../BaseResource';
3
- export default class SiteSearchSource extends BaseResource {
3
+ export default class SearchIndex extends BaseResource {
4
4
  /**
5
- * List all site search sources for a site
5
+ * List all search indexes for a site
6
6
  *
7
- * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/instances
7
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/instances
8
8
  *
9
9
  * @throws {ApiError}
10
10
  * @throws {TimeoutError}
@@ -13,9 +13,9 @@ export default class SiteSearchSource extends BaseResource {
13
13
  return this.rawList().then((body) => Utils.deserializeResponseBody(body));
14
14
  }
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}
@@ -23,58 +23,59 @@ export default class SiteSearchSource extends BaseResource {
23
23
  rawList() {
24
24
  return this.client.request({
25
25
  method: 'GET',
26
- url: '/site-search-sources',
26
+ url: '/search-indexes',
27
27
  });
28
28
  }
29
29
  /**
30
- * Retrieve a site search source
30
+ * Retrieve a search index
31
31
  *
32
- * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/self
32
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/self
33
33
  *
34
34
  * @throws {ApiError}
35
35
  * @throws {TimeoutError}
36
36
  */
37
- find(siteSearchSourceId) {
38
- return this.rawFind(Utils.toId(siteSearchSourceId)).then((body) => Utils.deserializeResponseBody(body));
37
+ find(searchIndexId) {
38
+ return this.rawFind(Utils.toId(searchIndexId)).then((body) => Utils.deserializeResponseBody(body));
39
39
  }
40
40
  /**
41
- * Retrieve a site search source
41
+ * Retrieve a search index
42
42
  *
43
- * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/self
43
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/self
44
44
  *
45
45
  * @throws {ApiError}
46
46
  * @throws {TimeoutError}
47
47
  */
48
- rawFind(siteSearchSourceId) {
48
+ rawFind(searchIndexId) {
49
49
  return this.client.request({
50
50
  method: 'GET',
51
- url: `/site-search-sources/${siteSearchSourceId}`,
51
+ url: `/search-indexes/${searchIndexId}`,
52
52
  });
53
53
  }
54
54
  /**
55
- * Create site search source
55
+ * Create search index
56
56
  *
57
- * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/create
57
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/create
58
58
  *
59
59
  * @throws {ApiError}
60
60
  * @throws {TimeoutError}
61
61
  */
62
62
  create(body) {
63
63
  return this.rawCreate(Utils.serializeRequestBody(body, {
64
- type: 'site_search_source',
64
+ type: 'search_index',
65
65
  attributes: [
66
66
  'name',
67
67
  'enabled',
68
68
  'build_trigger_indexing_enabled',
69
69
  'frontend_url',
70
+ 'user_agent_suffix',
70
71
  ],
71
72
  relationships: ['build_triggers'],
72
73
  })).then((body) => Utils.deserializeResponseBody(body));
73
74
  }
74
75
  /**
75
- * Create site search source
76
+ * Create search index
76
77
  *
77
- * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/create
78
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/create
78
79
  *
79
80
  * @throws {ApiError}
80
81
  * @throws {TimeoutError}
@@ -82,121 +83,122 @@ export default class SiteSearchSource extends BaseResource {
82
83
  rawCreate(body) {
83
84
  return this.client.request({
84
85
  method: 'POST',
85
- url: '/site-search-sources',
86
+ url: '/search-indexes',
86
87
  body,
87
88
  });
88
89
  }
89
90
  /**
90
- * Update site search source
91
+ * Update search index
91
92
  *
92
- * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/update
93
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/update
93
94
  *
94
95
  * @throws {ApiError}
95
96
  * @throws {TimeoutError}
96
97
  */
97
- update(siteSearchSourceId, body) {
98
- return this.rawUpdate(Utils.toId(siteSearchSourceId), Utils.serializeRequestBody(body, {
99
- id: Utils.toId(siteSearchSourceId),
100
- type: 'site_search_source',
98
+ update(searchIndexId, body) {
99
+ return this.rawUpdate(Utils.toId(searchIndexId), Utils.serializeRequestBody(body, {
100
+ id: Utils.toId(searchIndexId),
101
+ type: 'search_index',
101
102
  attributes: [
102
103
  'name',
103
104
  'enabled',
104
105
  'build_trigger_indexing_enabled',
105
106
  'frontend_url',
107
+ 'user_agent_suffix',
106
108
  ],
107
109
  relationships: ['build_triggers'],
108
110
  })).then((body) => Utils.deserializeResponseBody(body));
109
111
  }
110
112
  /**
111
- * Update site search source
113
+ * Update search index
112
114
  *
113
- * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/update
115
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/update
114
116
  *
115
117
  * @throws {ApiError}
116
118
  * @throws {TimeoutError}
117
119
  */
118
- rawUpdate(siteSearchSourceId, body) {
120
+ rawUpdate(searchIndexId, body) {
119
121
  return this.client.request({
120
122
  method: 'PUT',
121
- url: `/site-search-sources/${siteSearchSourceId}`,
123
+ url: `/search-indexes/${searchIndexId}`,
122
124
  body,
123
125
  });
124
126
  }
125
127
  /**
126
128
  * Trigger a site search indexing
127
129
  *
128
- * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/trigger
130
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/trigger
129
131
  *
130
132
  * @throws {ApiError}
131
133
  * @throws {TimeoutError}
132
134
  */
133
- trigger(siteSearchSourceId) {
134
- return this.rawTrigger(Utils.toId(siteSearchSourceId));
135
+ trigger(searchIndexId) {
136
+ return this.rawTrigger(Utils.toId(searchIndexId));
135
137
  }
136
138
  /**
137
139
  * Trigger a site search indexing
138
140
  *
139
- * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/trigger
141
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/trigger
140
142
  *
141
143
  * @throws {ApiError}
142
144
  * @throws {TimeoutError}
143
145
  */
144
- rawTrigger(siteSearchSourceId) {
146
+ rawTrigger(searchIndexId) {
145
147
  return this.client.request({
146
148
  method: 'POST',
147
- url: `/site-search-sources/${siteSearchSourceId}/trigger`,
149
+ url: `/search-indexes/${searchIndexId}/trigger`,
148
150
  });
149
151
  }
150
152
  /**
151
153
  * Abort a site search spidering and mark it as failed
152
154
  *
153
- * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/abort
155
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/abort
154
156
  *
155
157
  * @throws {ApiError}
156
158
  * @throws {TimeoutError}
157
159
  */
158
- abort(siteSearchSourceId) {
159
- return this.rawAbort(Utils.toId(siteSearchSourceId));
160
+ abort(searchIndexId) {
161
+ return this.rawAbort(Utils.toId(searchIndexId));
160
162
  }
161
163
  /**
162
164
  * Abort a site search spidering and mark it as failed
163
165
  *
164
- * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/abort
166
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/abort
165
167
  *
166
168
  * @throws {ApiError}
167
169
  * @throws {TimeoutError}
168
170
  */
169
- rawAbort(siteSearchSourceId) {
171
+ rawAbort(searchIndexId) {
170
172
  return this.client.request({
171
173
  method: 'DELETE',
172
- url: `/site-search-sources/${siteSearchSourceId}/abort`,
174
+ url: `/search-indexes/${searchIndexId}/abort`,
173
175
  });
174
176
  }
175
177
  /**
176
- * Delete a site search source
178
+ * Delete a search index
177
179
  *
178
- * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/destroy
180
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/destroy
179
181
  *
180
182
  * @throws {ApiError}
181
183
  * @throws {TimeoutError}
182
184
  */
183
- destroy(siteSearchSourceId) {
184
- return this.rawDestroy(Utils.toId(siteSearchSourceId)).then((body) => Utils.deserializeResponseBody(body));
185
+ destroy(searchIndexId) {
186
+ return this.rawDestroy(Utils.toId(searchIndexId)).then((body) => Utils.deserializeResponseBody(body));
185
187
  }
186
188
  /**
187
- * Delete a site search source
189
+ * Delete a search index
188
190
  *
189
- * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/destroy
191
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/destroy
190
192
  *
191
193
  * @throws {ApiError}
192
194
  * @throws {TimeoutError}
193
195
  */
194
- rawDestroy(siteSearchSourceId) {
196
+ rawDestroy(searchIndexId) {
195
197
  return this.client.request({
196
198
  method: 'DELETE',
197
- url: `/site-search-sources/${siteSearchSourceId}`,
199
+ url: `/search-indexes/${searchIndexId}`,
198
200
  });
199
201
  }
200
202
  }
201
- SiteSearchSource.TYPE = 'site_search_source';
202
- //# sourceMappingURL=SiteSearchSource.js.map
203
+ SearchIndex.TYPE = 'search_index';
204
+ //# sourceMappingURL=SearchIndex.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"SearchIndex.js","sourceRoot":"","sources":["../../../../src/generated/resources/SearchIndex.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,4BAA4B,CAAC;AACpD,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAI9C,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,YAAY;IAGnD;;;;;;;OAOG;IACH,IAAI;QACF,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAClC,KAAK,CAAC,uBAAuB,CAC3B,IAAI,CACL,CACF,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAA+C;YACvE,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,iBAAiB;SACvB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CAAC,aAAgD;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAC3D,KAAK,CAAC,uBAAuB,CAAuC,IAAI,CAAC,CAC1E,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CACL,aAAqB;QAErB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAA0C;YAClE,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,mBAAmB,aAAa,EAAE;SACxC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,IAAsC;QAC3C,OAAO,IAAI,CAAC,SAAS,CACnB,KAAK,CAAC,oBAAoB,CAAsC,IAAI,EAAE;YACpE,IAAI,EAAE,cAAc;YACpB,UAAU,EAAE;gBACV,MAAM;gBACN,SAAS;gBACT,gCAAgC;gBAChC,cAAc;gBACd,mBAAmB;aACpB;YACD,aAAa,EAAE,CAAC,gBAAgB,CAAC;SAClC,CAAC,CACH,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CACd,KAAK,CAAC,uBAAuB,CAC3B,IAAI,CACL,CACF,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,SAAS,CACP,IAAyC;QAEzC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAA4C;YACpE,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,iBAAiB;YACtB,IAAI;SACL,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CACJ,aAAgD,EAChD,IAAsC;QAEtC,OAAO,IAAI,CAAC,SAAS,CACnB,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,EACzB,KAAK,CAAC,oBAAoB,CAAsC,IAAI,EAAE;YACpE,EAAE,EAAE,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC;YAC7B,IAAI,EAAE,cAAc;YACpB,UAAU,EAAE;gBACV,MAAM;gBACN,SAAS;gBACT,gCAAgC;gBAChC,cAAc;gBACd,mBAAmB;aACpB;YACD,aAAa,EAAE,CAAC,gBAAgB,CAAC;SAClC,CAAC,CACH,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CACd,KAAK,CAAC,uBAAuB,CAC3B,IAAI,CACL,CACF,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,SAAS,CACP,aAAqB,EACrB,IAAyC;QAEzC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAA4C;YACpE,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,mBAAmB,aAAa,EAAE;YACvC,IAAI;SACL,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CAAC,aAAgD;QACtD,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;;OAOG;IACH,UAAU,CAAC,aAAqB;QAC9B,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAO;YAC/B,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,mBAAmB,aAAa,UAAU;SAChD,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,aAAgD;QACpD,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAC,aAAqB;QAC5B,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAO;YAC/B,MAAM,EAAE,QAAQ;YAChB,GAAG,EAAE,mBAAmB,aAAa,QAAQ;SAC9C,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CAAC,aAAgD;QACtD,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAC9D,KAAK,CAAC,uBAAuB,CAC3B,IAAI,CACL,CACF,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,UAAU,CACR,aAAqB;QAErB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAA6C;YACrE,MAAM,EAAE,QAAQ;YAChB,GAAG,EAAE,mBAAmB,aAAa,EAAE;SACxC,CAAC,CAAC;IACL,CAAC;;AAvPe,gBAAI,GAAG,cAAuB,CAAC"}
@@ -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
+ }