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

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 (120) hide show
  1. package/dist/cjs/fieldTypes/single_block.js.map +1 -1
  2. package/dist/cjs/fieldTypes/slug.js.map +1 -1
  3. package/dist/cjs/fieldTypes/structured_text.js.map +1 -1
  4. package/dist/cjs/fieldTypes/validators/index.js +2 -2
  5. package/dist/cjs/fieldTypes/validators/index.js.map +1 -1
  6. package/dist/cjs/fieldTypes/validators/{sanitization.js → sanitized_html.js} +1 -1
  7. package/dist/cjs/fieldTypes/validators/sanitized_html.js.map +1 -0
  8. package/dist/cjs/generated/Client.js +3 -1
  9. package/dist/cjs/generated/Client.js.map +1 -1
  10. package/dist/cjs/generated/resources/BuildTrigger.js +2 -0
  11. package/dist/cjs/generated/resources/BuildTrigger.js.map +1 -1
  12. package/dist/cjs/generated/resources/Field.js +2 -6
  13. package/dist/cjs/generated/resources/Field.js.map +1 -1
  14. package/dist/cjs/generated/resources/ItemType.js +25 -0
  15. package/dist/cjs/generated/resources/ItemType.js.map +1 -1
  16. package/dist/cjs/generated/resources/ItemVersion.js +4 -3
  17. package/dist/cjs/generated/resources/ItemVersion.js.map +1 -1
  18. package/dist/cjs/generated/resources/Role.js +8 -0
  19. package/dist/cjs/generated/resources/Role.js.map +1 -1
  20. package/dist/cjs/generated/resources/SiteSearchSource.js +233 -0
  21. package/dist/cjs/generated/resources/SiteSearchSource.js.map +1 -0
  22. package/dist/cjs/generated/resources/SiteSearchSourceEvent.js +153 -0
  23. package/dist/cjs/generated/resources/SiteSearchSourceEvent.js.map +1 -0
  24. package/dist/cjs/generated/resources/UploadRequest.js +1 -1
  25. package/dist/cjs/generated/resources/UploadRequest.js.map +1 -1
  26. package/dist/cjs/generated/resources/index.js +5 -1
  27. package/dist/cjs/generated/resources/index.js.map +1 -1
  28. package/dist/cjs/utilities/buildBlockRecord.js.map +1 -1
  29. package/dist/cjs/utilities/duplicateBlockRecord.js +6 -2
  30. package/dist/cjs/utilities/duplicateBlockRecord.js.map +1 -1
  31. package/dist/esm/fieldTypes/appearance/seo.d.ts +1 -1
  32. package/dist/esm/fieldTypes/single_block.d.ts +0 -1
  33. package/dist/esm/fieldTypes/single_block.js.map +1 -1
  34. package/dist/esm/fieldTypes/slug.d.ts +3 -0
  35. package/dist/esm/fieldTypes/slug.js.map +1 -1
  36. package/dist/esm/fieldTypes/structured_text.d.ts +3 -0
  37. package/dist/esm/fieldTypes/structured_text.js.map +1 -1
  38. package/dist/esm/fieldTypes/text.d.ts +2 -2
  39. package/dist/esm/fieldTypes/validators/index.d.ts +2 -2
  40. package/dist/esm/fieldTypes/validators/index.js +2 -2
  41. package/dist/esm/fieldTypes/validators/index.js.map +1 -1
  42. package/dist/{types/fieldTypes/validators/sanitization.d.ts → esm/fieldTypes/validators/sanitized_html.d.ts} +1 -1
  43. package/dist/esm/fieldTypes/validators/sanitized_html.js +2 -0
  44. package/dist/esm/fieldTypes/validators/sanitized_html.js.map +1 -0
  45. package/dist/esm/generated/ApiTypes.d.ts +507 -69
  46. package/dist/esm/generated/Client.d.ts +2 -0
  47. package/dist/esm/generated/Client.js +3 -1
  48. package/dist/esm/generated/Client.js.map +1 -1
  49. package/dist/esm/generated/RawApiTypes.d.ts +517 -68
  50. package/dist/esm/generated/resources/BuildTrigger.js +2 -0
  51. package/dist/esm/generated/resources/BuildTrigger.js.map +1 -1
  52. package/dist/esm/generated/resources/Field.d.ts +2 -206
  53. package/dist/esm/generated/resources/Field.js +2 -6
  54. package/dist/esm/generated/resources/Field.js.map +1 -1
  55. package/dist/esm/generated/resources/ItemType.d.ts +18 -0
  56. package/dist/esm/generated/resources/ItemType.js +25 -0
  57. package/dist/esm/generated/resources/ItemType.js.map +1 -1
  58. package/dist/esm/generated/resources/ItemVersion.d.ts +2 -2
  59. package/dist/esm/generated/resources/ItemVersion.js +4 -3
  60. package/dist/esm/generated/resources/ItemVersion.js.map +1 -1
  61. package/dist/esm/generated/resources/Role.js +8 -0
  62. package/dist/esm/generated/resources/Role.js.map +1 -1
  63. package/dist/esm/generated/resources/SiteSearchSource.d.ts +132 -0
  64. package/dist/esm/generated/resources/SiteSearchSource.js +204 -0
  65. package/dist/esm/generated/resources/SiteSearchSource.js.map +1 -0
  66. package/dist/esm/generated/resources/SiteSearchSourceEvent.d.ts +61 -0
  67. package/dist/esm/generated/resources/SiteSearchSourceEvent.js +124 -0
  68. package/dist/esm/generated/resources/SiteSearchSourceEvent.js.map +1 -0
  69. package/dist/esm/generated/resources/UploadRequest.js +1 -1
  70. package/dist/esm/generated/resources/UploadRequest.js.map +1 -1
  71. package/dist/esm/generated/resources/index.d.ts +2 -0
  72. package/dist/esm/generated/resources/index.js +2 -0
  73. package/dist/esm/generated/resources/index.js.map +1 -1
  74. package/dist/esm/utilities/buildBlockRecord.d.ts +10 -3
  75. package/dist/esm/utilities/buildBlockRecord.js.map +1 -1
  76. package/dist/esm/utilities/duplicateBlockRecord.js +6 -2
  77. package/dist/esm/utilities/duplicateBlockRecord.js.map +1 -1
  78. package/dist/types/fieldTypes/appearance/seo.d.ts +1 -1
  79. package/dist/types/fieldTypes/single_block.d.ts +0 -1
  80. package/dist/types/fieldTypes/slug.d.ts +3 -0
  81. package/dist/types/fieldTypes/structured_text.d.ts +3 -0
  82. package/dist/types/fieldTypes/text.d.ts +2 -2
  83. package/dist/types/fieldTypes/validators/index.d.ts +2 -2
  84. package/dist/{esm/fieldTypes/validators/sanitization.d.ts → types/fieldTypes/validators/sanitized_html.d.ts} +1 -1
  85. package/dist/types/generated/ApiTypes.d.ts +507 -69
  86. package/dist/types/generated/Client.d.ts +2 -0
  87. package/dist/types/generated/RawApiTypes.d.ts +517 -68
  88. package/dist/types/generated/resources/Field.d.ts +2 -206
  89. package/dist/types/generated/resources/ItemType.d.ts +18 -0
  90. package/dist/types/generated/resources/ItemVersion.d.ts +2 -2
  91. package/dist/types/generated/resources/SiteSearchSource.d.ts +132 -0
  92. package/dist/types/generated/resources/SiteSearchSourceEvent.d.ts +61 -0
  93. package/dist/types/generated/resources/index.d.ts +2 -0
  94. package/dist/types/utilities/buildBlockRecord.d.ts +10 -3
  95. package/package.json +3 -3
  96. package/resources.json +294 -193
  97. package/src/fieldTypes/appearance/seo.ts +1 -1
  98. package/src/fieldTypes/single_block.ts +0 -1
  99. package/src/fieldTypes/slug.ts +3 -0
  100. package/src/fieldTypes/structured_text.ts +3 -0
  101. package/src/fieldTypes/text.ts +2 -2
  102. package/src/fieldTypes/validators/index.ts +2 -2
  103. package/src/fieldTypes/validators/{sanitization.ts → sanitized_html.ts} +1 -1
  104. package/src/generated/ApiTypes.ts +526 -88
  105. package/src/generated/Client.ts +5 -1
  106. package/src/generated/RawApiTypes.ts +531 -82
  107. package/src/generated/resources/BuildTrigger.ts +2 -0
  108. package/src/generated/resources/Field.ts +2 -6
  109. package/src/generated/resources/ItemType.ts +33 -0
  110. package/src/generated/resources/ItemVersion.ts +7 -2
  111. package/src/generated/resources/Role.ts +8 -0
  112. package/src/generated/resources/SiteSearchSource.ts +267 -0
  113. package/src/generated/resources/SiteSearchSourceEvent.ts +134 -0
  114. package/src/generated/resources/UploadRequest.ts +1 -1
  115. package/src/generated/resources/index.ts +2 -0
  116. package/src/utilities/buildBlockRecord.ts +15 -3
  117. package/src/utilities/duplicateBlockRecord.ts +7 -2
  118. package/dist/cjs/fieldTypes/validators/sanitization.js.map +0 -1
  119. package/dist/esm/fieldTypes/validators/sanitization.js +0 -2
  120. package/dist/esm/fieldTypes/validators/sanitization.js.map +0 -1
@@ -81,25 +81,25 @@ export type WorkflowIdentity = string;
81
81
  */
82
82
  export type EnvironmentIdentity = string;
83
83
  /**
84
- * RFC 4122 UUID of upload collection expressed in URL-safe base64 format
84
+ * ID of build_trigger
85
85
  *
86
- * This interface was referenced by `UploadCollection`'s JSON-Schema
86
+ * This interface was referenced by `BuildTrigger`'s JSON-Schema
87
87
  * via the `definition` "identity".
88
88
  *
89
- * This interface was referenced by `UploadCollection`'s JSON-Schema
89
+ * This interface was referenced by `BuildTrigger`'s JSON-Schema
90
90
  * via the `definition` "id".
91
91
  */
92
- export type UploadCollectionIdentity = string;
92
+ export type BuildTriggerIdentity = string;
93
93
  /**
94
- * ID of build_trigger
94
+ * ID of site_search_source
95
95
  *
96
- * This interface was referenced by `BuildTrigger`'s JSON-Schema
96
+ * This interface was referenced by `SiteSearchSource`'s JSON-Schema
97
97
  * via the `definition` "identity".
98
98
  *
99
- * This interface was referenced by `BuildTrigger`'s JSON-Schema
99
+ * This interface was referenced by `SiteSearchSource`'s JSON-Schema
100
100
  * via the `definition` "id".
101
101
  */
102
- export type BuildTriggerIdentity = string;
102
+ export type SiteSearchSourceIdentity = string;
103
103
  /**
104
104
  * This interface was referenced by `User`'s JSON-Schema
105
105
  * via the `definition` "type".
@@ -385,6 +385,16 @@ export type SchemaMenuItemInstancesHrefSchema = {
385
385
  * via the `definition` "type".
386
386
  */
387
387
  export type UploadCollectionType = 'upload_collection';
388
+ /**
389
+ * RFC 4122 UUID of upload collection expressed in URL-safe base64 format
390
+ *
391
+ * This interface was referenced by `UploadCollection`'s JSON-Schema
392
+ * via the `definition` "identity".
393
+ *
394
+ * This interface was referenced by `UploadCollection`'s JSON-Schema
395
+ * via the `definition` "id".
396
+ */
397
+ export type UploadCollectionIdentity = string;
388
398
  /**
389
399
  * This interface was referenced by `UploadCollection`'s JSON-Schema
390
400
  * via the `instances.hrefSchema` link.
@@ -606,7 +616,7 @@ export type BuildEventInstancesHrefSchema = {
606
616
  /**
607
617
  * The type of activity
608
618
  */
609
- eq?: 'request_success' | 'request_failure' | 'response_success' | 'response_failure' | 'request_aborted' | 'response_unprocessable' | 'indexing_started' | 'indexing_success' | 'indexing_failure';
619
+ eq?: 'request_success' | 'request_failure' | 'response_success' | 'response_failure' | 'request_aborted' | 'response_unprocessable';
610
620
  };
611
621
  created_at?: {
612
622
  gt?: string;
@@ -620,6 +630,74 @@ export type BuildEventInstancesHrefSchema = {
620
630
  order_by?: 'build_trigger_id_asc' | 'build_trigger_id_desc' | 'created_at_asc' | 'created_at_desc' | 'event_type_asc' | 'event_type_desc';
621
631
  [k: string]: unknown;
622
632
  };
633
+ /**
634
+ * This interface was referenced by `SiteSearchSourceEvent`'s JSON-Schema
635
+ * via the `definition` "type".
636
+ */
637
+ export type SiteSearchSourceEventType = 'site_search_source_event';
638
+ /**
639
+ * ID of site search source event
640
+ *
641
+ * This interface was referenced by `SiteSearchSourceEvent`'s JSON-Schema
642
+ * via the `definition` "identity".
643
+ *
644
+ * This interface was referenced by `SiteSearchSourceEvent`'s JSON-Schema
645
+ * via the `definition` "id".
646
+ */
647
+ export type SiteSearchSourceEventIdentity = string;
648
+ /**
649
+ * This interface was referenced by `SiteSearchSource`'s JSON-Schema
650
+ * via the `definition` "type".
651
+ */
652
+ export type SiteSearchSourceType = 'site_search_source';
653
+ /**
654
+ * This interface was referenced by `SiteSearchSourceEvent`'s JSON-Schema
655
+ * via the `instances.hrefSchema` link.
656
+ */
657
+ export type SiteSearchSourceEventInstancesHrefSchema = {
658
+ /**
659
+ * Parameters to control offset-based pagination
660
+ */
661
+ page?: {
662
+ /**
663
+ * The (zero-based) offset of the first entity returned in the collection (defaults to 0)
664
+ */
665
+ offset?: number;
666
+ /**
667
+ * The maximum number of entities to return (defaults to 30, maximum is 500)
668
+ */
669
+ limit?: number;
670
+ };
671
+ /**
672
+ * Attributes to filter
673
+ */
674
+ filter?: {
675
+ /**
676
+ * IDs to fetch, comma separated
677
+ */
678
+ ids?: string;
679
+ fields?: {
680
+ site_search_source_id?: {
681
+ eq?: string;
682
+ };
683
+ event_type?: {
684
+ /**
685
+ * The type of activity
686
+ */
687
+ eq?: 'indexing_started' | 'indexing_success' | 'indexing_failure' | 'indexing_aborted';
688
+ };
689
+ created_at?: {
690
+ gt?: string;
691
+ lt?: string;
692
+ };
693
+ };
694
+ };
695
+ /**
696
+ * Fields used to order results
697
+ */
698
+ order_by?: 'site_search_source_id_asc' | 'site_search_source_id_desc' | 'created_at_asc' | 'created_at_desc' | 'event_type_asc' | 'event_type_desc';
699
+ [k: string]: unknown;
700
+ };
623
701
  /**
624
702
  * This interface was referenced by `Item`'s JSON-Schema
625
703
  * via the `instances.hrefSchema` link.
@@ -796,6 +874,17 @@ export type ItemVersionInstancesHrefSchema = {
796
874
  };
797
875
  [k: string]: unknown;
798
876
  };
877
+ /**
878
+ * This interface was referenced by `ItemVersion`'s JSON-Schema
879
+ * via the `self.hrefSchema` link.
880
+ */
881
+ export type ItemVersionSelfHrefSchema = {
882
+ /**
883
+ * For Modular Content, Structured Text and Single Block fields, return full payload for nested blocks instead of IDs
884
+ */
885
+ nested?: boolean;
886
+ [k: string]: unknown;
887
+ };
799
888
  /**
800
889
  * This interface was referenced by `Item`'s JSON-Schema
801
890
  * via the `publish.schema` link.
@@ -1009,7 +1098,11 @@ export type SearchResultInstancesHrefSchema = {
1009
1098
  */
1010
1099
  query: string;
1011
1100
  /**
1012
- * The build trigger ID on which the search will be performed. Required if more than one build trigger is present in a project
1101
+ * The site search source ID or name on which the search will be performed. If not provided, the first enabled site search source will be used.
1102
+ */
1103
+ site_search_source_id?: string;
1104
+ /**
1105
+ * **[Deprecated]** Use `site_search_source_id` instead. The build trigger ID or name on which the search will be performed. This parameter is only supported for backward compatibility and will return an error if the build trigger has multiple site search sources associated.
1013
1106
  */
1014
1107
  build_trigger_id?: string;
1015
1108
  /**
@@ -1523,6 +1616,10 @@ export type RoleAttributes = {
1523
1616
  * Can create/edit Build triggers
1524
1617
  */
1525
1618
  can_manage_build_triggers: boolean;
1619
+ /**
1620
+ * Can create/edit Site Search Sources
1621
+ */
1622
+ can_manage_site_search_sources: boolean;
1526
1623
  /**
1527
1624
  * Can create/edit webhooks
1528
1625
  */
@@ -1555,6 +1652,10 @@ export type RoleAttributes = {
1555
1652
  * Can access the build events log
1556
1653
  */
1557
1654
  can_access_build_events_log: boolean;
1655
+ /**
1656
+ * Can access the site search source events log
1657
+ */
1658
+ can_access_site_search_source_events_log: boolean;
1558
1659
  /**
1559
1660
  * Allowed actions on a model (or all) for a role
1560
1661
  */
@@ -1615,7 +1716,7 @@ export type RoleAttributes = {
1615
1716
  /**
1616
1717
  * Permitted action
1617
1718
  */
1618
- action: 'all' | 'read' | 'update' | 'create' | 'delete' | 'edit_creator' | 'replace_asset' | 'move';
1719
+ action: 'all' | 'read' | 'update' | 'create' | 'delete' | 'edit_creator' | 'replace_asset';
1619
1720
  /**
1620
1721
  * Permitted creator
1621
1722
  */
@@ -1628,8 +1729,6 @@ export type RoleAttributes = {
1628
1729
  * Permitted localized content in this locale. Required when `localization_scope` is `localized`
1629
1730
  */
1630
1731
  locale?: string | null;
1631
- upload_collection?: UploadCollectionIdentity | null;
1632
- move_to_upload_collection?: UploadCollectionIdentity | null;
1633
1732
  }[];
1634
1733
  /**
1635
1734
  * Prohibited actions on a model (or all) for a role
@@ -1639,7 +1738,7 @@ export type RoleAttributes = {
1639
1738
  /**
1640
1739
  * Permitted action
1641
1740
  */
1642
- action: 'all' | 'read' | 'update' | 'create' | 'delete' | 'edit_creator' | 'replace_asset' | 'move';
1741
+ action: 'all' | 'read' | 'update' | 'create' | 'delete' | 'edit_creator' | 'replace_asset';
1643
1742
  /**
1644
1743
  * Permitted creator
1645
1744
  */
@@ -1652,8 +1751,6 @@ export type RoleAttributes = {
1652
1751
  * Permitted localized content in this locale. Required when `localization_scope` is `localized`
1653
1752
  */
1654
1753
  locale?: string | null;
1655
- upload_collection?: UploadCollectionIdentity | null;
1656
- move_to_upload_collection?: UploadCollectionIdentity | null;
1657
1754
  }[];
1658
1755
  /**
1659
1756
  * Allowed build triggers for a role
@@ -1667,6 +1764,18 @@ export type RoleAttributes = {
1667
1764
  negative_build_trigger_permissions: {
1668
1765
  build_trigger?: BuildTriggerIdentity | null;
1669
1766
  }[];
1767
+ /**
1768
+ * Allowed site search sources for a role
1769
+ */
1770
+ positive_site_search_source_permissions: {
1771
+ site_search_source?: SiteSearchSourceIdentity | null;
1772
+ }[];
1773
+ /**
1774
+ * Prohibited site search sources for a role
1775
+ */
1776
+ negative_site_search_source_permissions: {
1777
+ site_search_source?: SiteSearchSourceIdentity | null;
1778
+ }[];
1670
1779
  };
1671
1780
  /**
1672
1781
  * JSON API links
@@ -1747,6 +1856,10 @@ export type RoleMeta = {
1747
1856
  * Can create/edit Build triggers
1748
1857
  */
1749
1858
  can_manage_build_triggers: boolean;
1859
+ /**
1860
+ * Can create/edit Site Search Sources
1861
+ */
1862
+ can_manage_site_search_sources: boolean;
1750
1863
  /**
1751
1864
  * Can create/edit webhooks
1752
1865
  */
@@ -1779,6 +1892,10 @@ export type RoleMeta = {
1779
1892
  * Can access the build events log
1780
1893
  */
1781
1894
  can_access_build_events_log: boolean;
1895
+ /**
1896
+ * Can access the site search source events log
1897
+ */
1898
+ can_access_site_search_source_events_log: boolean;
1782
1899
  /**
1783
1900
  * Allowed actions on a model (or all) for a role
1784
1901
  */
@@ -1839,7 +1956,7 @@ export type RoleMeta = {
1839
1956
  /**
1840
1957
  * Permitted action
1841
1958
  */
1842
- action: 'all' | 'read' | 'update' | 'create' | 'delete' | 'edit_creator' | 'replace_asset' | 'move';
1959
+ action: 'all' | 'read' | 'update' | 'create' | 'delete' | 'edit_creator' | 'replace_asset';
1843
1960
  /**
1844
1961
  * Permitted creator
1845
1962
  */
@@ -1852,8 +1969,6 @@ export type RoleMeta = {
1852
1969
  * Permitted localized content in this locale. Required when `localization_scope` is `localized`
1853
1970
  */
1854
1971
  locale?: string | null;
1855
- upload_collection?: UploadCollectionIdentity | null;
1856
- move_to_upload_collection?: UploadCollectionIdentity | null;
1857
1972
  }[];
1858
1973
  /**
1859
1974
  * Prohibited actions on a model (or all) for a role
@@ -1863,7 +1978,7 @@ export type RoleMeta = {
1863
1978
  /**
1864
1979
  * Permitted action
1865
1980
  */
1866
- action: 'all' | 'read' | 'update' | 'create' | 'delete' | 'edit_creator' | 'replace_asset' | 'move';
1981
+ action: 'all' | 'read' | 'update' | 'create' | 'delete' | 'edit_creator' | 'replace_asset';
1867
1982
  /**
1868
1983
  * Permitted creator
1869
1984
  */
@@ -1876,8 +1991,6 @@ export type RoleMeta = {
1876
1991
  * Permitted localized content in this locale. Required when `localization_scope` is `localized`
1877
1992
  */
1878
1993
  locale?: string | null;
1879
- upload_collection?: UploadCollectionIdentity | null;
1880
- move_to_upload_collection?: UploadCollectionIdentity | null;
1881
1994
  }[];
1882
1995
  /**
1883
1996
  * Allowed build triggers for a role
@@ -1891,6 +2004,18 @@ export type RoleMeta = {
1891
2004
  negative_build_trigger_permissions: {
1892
2005
  build_trigger?: BuildTriggerIdentity | null;
1893
2006
  }[];
2007
+ /**
2008
+ * Allowed site search sources for a role
2009
+ */
2010
+ positive_site_search_source_permissions: {
2011
+ site_search_source?: SiteSearchSourceIdentity | null;
2012
+ }[];
2013
+ /**
2014
+ * Prohibited site search sources for a role
2015
+ */
2016
+ negative_site_search_source_permissions: {
2017
+ site_search_source?: SiteSearchSourceIdentity | null;
2018
+ }[];
1894
2019
  };
1895
2020
  };
1896
2021
  /**
@@ -1944,6 +2069,10 @@ export type RoleCreateSchema = {
1944
2069
  * Can create/edit shared filters (both for models and the media area)
1945
2070
  */
1946
2071
  can_manage_shared_filters?: boolean;
2072
+ /**
2073
+ * Can create/edit Site Search Sources
2074
+ */
2075
+ can_manage_site_search_sources?: boolean;
1947
2076
  /**
1948
2077
  * Can create/edit upload collections
1949
2078
  */
@@ -1984,6 +2113,10 @@ export type RoleCreateSchema = {
1984
2113
  * Can access the build events log
1985
2114
  */
1986
2115
  can_access_build_events_log?: boolean;
2116
+ /**
2117
+ * Can access the site search source events log
2118
+ */
2119
+ can_access_site_search_source_events_log?: boolean;
1987
2120
  /**
1988
2121
  * Allowed actions on a model (or all) for a role
1989
2122
  */
@@ -2044,7 +2177,7 @@ export type RoleCreateSchema = {
2044
2177
  /**
2045
2178
  * Permitted action
2046
2179
  */
2047
- action: 'all' | 'read' | 'update' | 'create' | 'delete' | 'edit_creator' | 'replace_asset' | 'move';
2180
+ action: 'all' | 'read' | 'update' | 'create' | 'delete' | 'edit_creator' | 'replace_asset';
2048
2181
  /**
2049
2182
  * Permitted creator
2050
2183
  */
@@ -2057,8 +2190,6 @@ export type RoleCreateSchema = {
2057
2190
  * Permitted localized content in this locale. Required when `localization_scope` is `localized`
2058
2191
  */
2059
2192
  locale?: string | null;
2060
- upload_collection?: UploadCollectionIdentity | null;
2061
- move_to_upload_collection?: UploadCollectionIdentity | null;
2062
2193
  }[];
2063
2194
  /**
2064
2195
  * Prohibited actions on a model (or all) for a role
@@ -2068,7 +2199,7 @@ export type RoleCreateSchema = {
2068
2199
  /**
2069
2200
  * Permitted action
2070
2201
  */
2071
- action: 'all' | 'read' | 'update' | 'create' | 'delete' | 'edit_creator' | 'replace_asset' | 'move';
2202
+ action: 'all' | 'read' | 'update' | 'create' | 'delete' | 'edit_creator' | 'replace_asset';
2072
2203
  /**
2073
2204
  * Permitted creator
2074
2205
  */
@@ -2081,8 +2212,6 @@ export type RoleCreateSchema = {
2081
2212
  * Permitted localized content in this locale. Required when `localization_scope` is `localized`
2082
2213
  */
2083
2214
  locale?: string | null;
2084
- upload_collection?: UploadCollectionIdentity | null;
2085
- move_to_upload_collection?: UploadCollectionIdentity | null;
2086
2215
  }[];
2087
2216
  /**
2088
2217
  * Allowed build triggers for a role
@@ -2096,6 +2225,18 @@ export type RoleCreateSchema = {
2096
2225
  negative_build_trigger_permissions?: {
2097
2226
  build_trigger?: BuildTriggerIdentity | null;
2098
2227
  }[];
2228
+ /**
2229
+ * Allowed site search sources for a role
2230
+ */
2231
+ positive_site_search_source_permissions?: {
2232
+ site_search_source?: SiteSearchSourceIdentity | null;
2233
+ }[];
2234
+ /**
2235
+ * Prohibited site search sources for a role
2236
+ */
2237
+ negative_site_search_source_permissions?: {
2238
+ site_search_source?: SiteSearchSourceIdentity | null;
2239
+ }[];
2099
2240
  };
2100
2241
  /**
2101
2242
  * JSON API links
@@ -2170,6 +2311,10 @@ export type RoleUpdateSchema = {
2170
2311
  * Can create/edit shared filters (both for models and the media area)
2171
2312
  */
2172
2313
  can_manage_shared_filters?: boolean;
2314
+ /**
2315
+ * Can create/edit Site Search Sources
2316
+ */
2317
+ can_manage_site_search_sources?: boolean;
2173
2318
  /**
2174
2319
  * Can create/edit upload collections
2175
2320
  */
@@ -2210,6 +2355,10 @@ export type RoleUpdateSchema = {
2210
2355
  * Can access the build events log
2211
2356
  */
2212
2357
  can_access_build_events_log?: boolean;
2358
+ /**
2359
+ * Can access the site search source events log
2360
+ */
2361
+ can_access_site_search_source_events_log?: boolean;
2213
2362
  /**
2214
2363
  * Allowed actions on a model (or all) for a role
2215
2364
  */
@@ -2270,7 +2419,7 @@ export type RoleUpdateSchema = {
2270
2419
  /**
2271
2420
  * Permitted action
2272
2421
  */
2273
- action: 'all' | 'read' | 'update' | 'create' | 'delete' | 'edit_creator' | 'replace_asset' | 'move';
2422
+ action: 'all' | 'read' | 'update' | 'create' | 'delete' | 'edit_creator' | 'replace_asset';
2274
2423
  /**
2275
2424
  * Permitted creator
2276
2425
  */
@@ -2283,8 +2432,6 @@ export type RoleUpdateSchema = {
2283
2432
  * Permitted localized content in this locale. Required when `localization_scope` is `localized`
2284
2433
  */
2285
2434
  locale?: string | null;
2286
- upload_collection?: UploadCollectionIdentity | null;
2287
- move_to_upload_collection?: UploadCollectionIdentity | null;
2288
2435
  }[];
2289
2436
  /**
2290
2437
  * Prohibited actions on a model (or all) for a role
@@ -2294,7 +2441,7 @@ export type RoleUpdateSchema = {
2294
2441
  /**
2295
2442
  * Permitted action
2296
2443
  */
2297
- action: 'all' | 'read' | 'update' | 'create' | 'delete' | 'edit_creator' | 'replace_asset' | 'move';
2444
+ action: 'all' | 'read' | 'update' | 'create' | 'delete' | 'edit_creator' | 'replace_asset';
2298
2445
  /**
2299
2446
  * Permitted creator
2300
2447
  */
@@ -2307,8 +2454,6 @@ export type RoleUpdateSchema = {
2307
2454
  * Permitted localized content in this locale. Required when `localization_scope` is `localized`
2308
2455
  */
2309
2456
  locale?: string | null;
2310
- upload_collection?: UploadCollectionIdentity | null;
2311
- move_to_upload_collection?: UploadCollectionIdentity | null;
2312
2457
  }[];
2313
2458
  /**
2314
2459
  * Allowed build triggers for a role
@@ -2322,6 +2467,18 @@ export type RoleUpdateSchema = {
2322
2467
  negative_build_trigger_permissions?: {
2323
2468
  build_trigger?: BuildTriggerIdentity | null;
2324
2469
  }[];
2470
+ /**
2471
+ * Allowed site search sources for a role
2472
+ */
2473
+ positive_site_search_source_permissions?: {
2474
+ site_search_source?: SiteSearchSourceIdentity | null;
2475
+ }[];
2476
+ /**
2477
+ * Prohibited site search sources for a role
2478
+ */
2479
+ negative_site_search_source_permissions?: {
2480
+ site_search_source?: SiteSearchSourceIdentity | null;
2481
+ }[];
2325
2482
  };
2326
2483
  /**
2327
2484
  * JSON API links
@@ -3088,6 +3245,10 @@ export type SitePlanAttributes = {
3088
3245
  * Number of build triggers
3089
3246
  */
3090
3247
  build_triggers: null | number;
3248
+ /**
3249
+ * Number of site search sources
3250
+ */
3251
+ site_search_sources: null | number;
3091
3252
  /**
3092
3253
  * Number of plugins
3093
3254
  */
@@ -3252,6 +3413,10 @@ export type SitePlanAttributes = {
3252
3413
  amount_per_packet: number;
3253
3414
  price: number;
3254
3415
  };
3416
+ site_search_sources?: {
3417
+ amount_per_packet: number;
3418
+ price: number;
3419
+ };
3255
3420
  access_tokens?: {
3256
3421
  amount_per_packet: number;
3257
3422
  price: number;
@@ -4521,6 +4686,13 @@ export type ItemTypeDestroyTargetSchema = {
4521
4686
  export type ItemTypeDestroyJobSchema = {
4522
4687
  data: ItemType;
4523
4688
  };
4689
+ /**
4690
+ * This interface was referenced by `ItemType`'s JSON-Schema
4691
+ * via the `referencing.targetSchema` link.
4692
+ */
4693
+ export type ItemTypeReferencingTargetSchema = {
4694
+ data: ItemType[];
4695
+ };
4524
4696
  /**
4525
4697
  * This interface was referenced by `ItemType`'s JSON-Schema
4526
4698
  * via the `reorder_fields_and_fieldsets.schema` link.
@@ -4691,11 +4863,11 @@ export type ItemTypeReorderFieldsAndFieldsetsJobSchema = {
4691
4863
  * <details>
4692
4864
  * <summary>Multi-line text (<code>text</code>)</summary>
4693
4865
  *
4694
- * | Property | Value |
4695
- * | ------------------------------ | ---------------------------------------------- |
4696
- * | Code | `text` |
4697
- * | Built-in editors for the field | `markdown`, `wysiwyg`, `textarea` |
4698
- * | Available validators | `required`, `length`, `format`, `sanitization` |
4866
+ * | Property | Value |
4867
+ * | ------------------------------ | ------------------------------------------------ |
4868
+ * | Code | `text` |
4869
+ * | Built-in editors for the field | `markdown`, `wysiwyg`, `textarea` |
4870
+ * | Available validators | `required`, `length`, `format`, `sanitized_html` |
4699
4871
  *
4700
4872
  * </details>
4701
4873
  *
@@ -4801,11 +4973,11 @@ export type ItemTypeReorderFieldsAndFieldsetsJobSchema = {
4801
4973
  * <details>
4802
4974
  * <summary>Slug (<code>slug</code>)</summary>
4803
4975
  *
4804
- * | Property | Value |
4805
- * | ------------------------------ | ------------------------------------------------------- |
4806
- * | Code | `slug` |
4807
- * | Built-in editors for the field | `slug` |
4808
- * | Available validators | `required`, `length`, `slug_format`, `slug_title_field` |
4976
+ * | Property | Value |
4977
+ * | ------------------------------ | ----------------------------------------------------------------- |
4978
+ * | Code | `slug` |
4979
+ * | Built-in editors for the field | `slug` |
4980
+ * | Available validators | `required`, `unique`, `length`, `slug_format`, `slug_title_field` |
4809
4981
  *
4810
4982
  * </details>
4811
4983
  *
@@ -4895,12 +5067,12 @@ export type ItemTypeReorderFieldsAndFieldsetsJobSchema = {
4895
5067
  * <details>
4896
5068
  * <summary>Structured text (<code>structured_text</code>)</summary>
4897
5069
  *
4898
- * | Property | Value |
4899
- * | ------------------------------ | ------------------------------------------------- |
4900
- * | Code | `structured_text` |
4901
- * | Built-in editors for the field | `structured_text` |
4902
- * | Required validators | `structured_text_blocks`, `structured_text_links` |
4903
- * | Other validators available | `length`, `structured_text_inline_blocks` |
5070
+ * | Property | Value |
5071
+ * | ------------------------------ | ----------------------------------------------------- |
5072
+ * | Code | `structured_text` |
5073
+ * | Built-in editors for the field | `structured_text` |
5074
+ * | Required validators | `structured_text_blocks`, `structured_text_links` |
5075
+ * | Other validators available | `required`, `length`, `structured_text_inline_blocks` |
4904
5076
  *
4905
5077
  * </details>
4906
5078
  *
@@ -5214,9 +5386,9 @@ export type ItemTypeReorderFieldsAndFieldsetsJobSchema = {
5214
5386
  * </details>
5215
5387
  *
5216
5388
  * <details>
5217
- * <summary><code>sanitization</code></summary>
5389
+ * <summary><code>sanitized_html</code></summary>
5218
5390
  *
5219
- * Checks for the presence of malicious cose in HTML fields: content is valid if no dangerous code is present.
5391
+ * Checks for the presence of malicious code in HTML fields: content is valid if no dangerous code is present.
5220
5392
  *
5221
5393
  * | Parameter | Type | Required | Description |
5222
5394
  * | ---------------------------- | --------- | -------- | ------------------------------------------------------------ |
@@ -5443,10 +5615,10 @@ export type ItemTypeReorderFieldsAndFieldsetsJobSchema = {
5443
5615
  *
5444
5616
  * Built-in editor for _seo_ fields.
5445
5617
  *
5446
- * | Parameter | Type | Required | Description |
5447
- * | ---------- | --------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
5448
- * | `fields` | `Array<String>` | ✅ | Specify which fields of the SEO input should be visible to editors. Valid values: `"title"`, `"description"`, `"image"`, `"no_index"`, `"twitter_card"` |
5449
- * | `previews` | `Array<String>` | ✅ | Specify which previews should be visible to editors. Valid values: `"google_search"`, `"twitter"`, `"slack"`, `"whatsapp"`, `"telegram"`, `"facebook"`, `"linkedin"` |
5618
+ * | Parameter | Type | Required | Description |
5619
+ * | ---------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
5620
+ * | `fields` | `Array<String>` | ✅ | Specify which fields of the SEO input should be visible to editors. Valid values: `"title"`, `"description"`, `"image"`, `"no_index"`, `"twitter_card"` |
5621
+ * | `previews` | `Array<String>` | ✅ | Specify which previews should be visible to editors. Valid values: `"google"`, `"twitter"`, `"slack"`, `"whatsapp"`, `"telegram"`, `"facebook"`, `"linkedin"` |
5450
5622
  *
5451
5623
  * </details>
5452
5624
  *
@@ -5618,7 +5790,6 @@ export type FieldAttributesStableShell = {
5618
5790
  };
5619
5791
  [k: string]: unknown;
5620
5792
  }[];
5621
- [k: string]: unknown;
5622
5793
  };
5623
5794
  /**
5624
5795
  * Ordering index
@@ -5728,7 +5899,6 @@ export type FieldCreateSchemaStableShell = {
5728
5899
  };
5729
5900
  [k: string]: unknown;
5730
5901
  }[];
5731
- [k: string]: unknown;
5732
5902
  };
5733
5903
  /**
5734
5904
  * Ordering index
@@ -5855,7 +6025,6 @@ export type FieldUpdateSchemaStableShell = {
5855
6025
  };
5856
6026
  [k: string]: unknown;
5857
6027
  }[];
5858
- [k: string]: unknown;
5859
6028
  };
5860
6029
  /**
5861
6030
  * Ordering index
@@ -6574,7 +6743,7 @@ export type BuildEventAttributes = {
6574
6743
  /**
6575
6744
  * The type of activity
6576
6745
  */
6577
- event_type: 'request_success' | 'request_failure' | 'response_success' | 'response_failure' | 'request_aborted' | 'response_unprocessable' | 'indexing_started' | 'indexing_success' | 'indexing_failure';
6746
+ event_type: 'request_success' | 'request_failure' | 'response_success' | 'response_failure' | 'request_aborted' | 'response_unprocessable';
6578
6747
  /**
6579
6748
  * The moment the activity occurred
6580
6749
  */
@@ -6637,6 +6806,91 @@ export type BuildEventInstancesTargetSchema = {
6637
6806
  export type BuildEventSelfTargetSchema = {
6638
6807
  data: BuildEvent;
6639
6808
  };
6809
+ /**
6810
+ * Represents an event occurred during the site search indexing process.
6811
+ *
6812
+ * This interface was referenced by `DatoApi`'s JSON-Schema
6813
+ * via the `definition` "site_search_source_event".
6814
+ */
6815
+ export type SiteSearchSourceEvent = {
6816
+ type: SiteSearchSourceEventType;
6817
+ id: SiteSearchSourceEventIdentity;
6818
+ attributes: SiteSearchSourceEventAttributes;
6819
+ relationships: SiteSearchSourceEventRelationships;
6820
+ };
6821
+ /**
6822
+ * JSON API attributes
6823
+ *
6824
+ * This interface was referenced by `SiteSearchSourceEvent`'s JSON-Schema
6825
+ * via the `definition` "attributes".
6826
+ */
6827
+ export type SiteSearchSourceEventAttributes = {
6828
+ /**
6829
+ * The type of activity
6830
+ */
6831
+ event_type: 'indexing_started' | 'indexing_success' | 'indexing_failure' | 'indexing_aborted';
6832
+ /**
6833
+ * The moment the activity occurred
6834
+ */
6835
+ created_at: string;
6836
+ /**
6837
+ * Any details regarding the event
6838
+ */
6839
+ data: {
6840
+ [k: string]: unknown;
6841
+ };
6842
+ };
6843
+ /**
6844
+ * JSON API links
6845
+ *
6846
+ * This interface was referenced by `SiteSearchSourceEvent`'s JSON-Schema
6847
+ * via the `definition` "relationships".
6848
+ */
6849
+ export type SiteSearchSourceEventRelationships = {
6850
+ /**
6851
+ * Source site search source
6852
+ */
6853
+ site_search_source: {
6854
+ data: SiteSearchSourceData;
6855
+ };
6856
+ };
6857
+ /**
6858
+ * JSON API data
6859
+ *
6860
+ * This interface was referenced by `SiteSearchSource`'s JSON-Schema
6861
+ * via the `definition` "data".
6862
+ */
6863
+ export type SiteSearchSourceData = {
6864
+ type: SiteSearchSourceType;
6865
+ id: SiteSearchSourceIdentity;
6866
+ };
6867
+ /**
6868
+ * JSON API data
6869
+ *
6870
+ * This interface was referenced by `SiteSearchSourceEvent`'s JSON-Schema
6871
+ * via the `definition` "data".
6872
+ */
6873
+ export type SiteSearchSourceEventData = {
6874
+ type: SiteSearchSourceEventType;
6875
+ id: SiteSearchSourceEventIdentity;
6876
+ };
6877
+ /**
6878
+ * This interface was referenced by `SiteSearchSourceEvent`'s JSON-Schema
6879
+ * via the `instances.targetSchema` link.
6880
+ */
6881
+ export type SiteSearchSourceEventInstancesTargetSchema = {
6882
+ data: SiteSearchSourceEvent[];
6883
+ meta: {
6884
+ total_count: number;
6885
+ };
6886
+ };
6887
+ /**
6888
+ * This interface was referenced by `SiteSearchSourceEvent`'s JSON-Schema
6889
+ * via the `self.targetSchema` link.
6890
+ */
6891
+ export type SiteSearchSourceEventSelfTargetSchema = {
6892
+ data: SiteSearchSourceEvent;
6893
+ };
6640
6894
  /**
6641
6895
  * JSON API links
6642
6896
  *
@@ -8189,14 +8443,6 @@ export type UploadRequestCreateSchema = {
8189
8443
  filename?: string;
8190
8444
  [k: string]: unknown;
8191
8445
  };
8192
- relationships?: {
8193
- /**
8194
- * Upload collection to which the asset belongs
8195
- */
8196
- upload_collection?: {
8197
- data: UploadCollectionData | null;
8198
- };
8199
- };
8200
8446
  };
8201
8447
  };
8202
8448
  /**
@@ -9069,6 +9315,10 @@ export type BuildTriggerAttributes = {
9069
9315
  * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
9070
9316
  */
9071
9317
  indexing_enabled: boolean;
9318
+ /**
9319
+ * Whether the build trigger is enabled or not
9320
+ */
9321
+ enabled: boolean;
9072
9322
  };
9073
9323
  /**
9074
9324
  * This interface was referenced by `BuildTrigger`'s JSON-Schema
@@ -9108,6 +9358,10 @@ export type BuildTriggerCreateSchema = {
9108
9358
  * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
9109
9359
  */
9110
9360
  indexing_enabled: boolean;
9361
+ /**
9362
+ * Whether the build trigger is enabled or not
9363
+ */
9364
+ enabled?: boolean;
9111
9365
  /**
9112
9366
  * The public URL of the frontend. If Site Search is enabled (indicated by `indexing_enabled`), this is the starting point from which the website's spidering will start
9113
9367
  */
@@ -9153,6 +9407,10 @@ export type BuildTriggerUpdateSchema = {
9153
9407
  * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
9154
9408
  */
9155
9409
  indexing_enabled?: boolean;
9410
+ /**
9411
+ * Whether the build trigger is enabled or not
9412
+ */
9413
+ enabled?: boolean;
9156
9414
  /**
9157
9415
  * The public URL of the frontend. If Site Search is enabled (indicated by `indexing_enabled`), this is the starting point from which the website's spidering will start
9158
9416
  */
@@ -9184,6 +9442,197 @@ export type BuildTriggerUpdateTargetSchema = {
9184
9442
  export type BuildTriggerDestroyTargetSchema = {
9185
9443
  data: BuildTrigger;
9186
9444
  };
9445
+ /**
9446
+ * A Site Search Source represents a website that should be indexed by DatoCMS Site Search. When enabled, DatoCMS will periodically spider the website to update the search index.
9447
+ *
9448
+ * This interface was referenced by `DatoApi`'s JSON-Schema
9449
+ * via the `definition` "site_search_source".
9450
+ */
9451
+ export type SiteSearchSource = {
9452
+ type: SiteSearchSourceType;
9453
+ id: SiteSearchSourceIdentity;
9454
+ attributes: SiteSearchSourceAttributes;
9455
+ relationships: SiteSearchSourceRelationships;
9456
+ meta: SiteSearchSourceMeta;
9457
+ };
9458
+ /**
9459
+ * JSON API attributes
9460
+ *
9461
+ * This interface was referenced by `SiteSearchSource`'s JSON-Schema
9462
+ * via the `definition` "attributes".
9463
+ */
9464
+ export type SiteSearchSourceAttributes = {
9465
+ /**
9466
+ * Name of the site search source
9467
+ */
9468
+ name: string;
9469
+ /**
9470
+ * Whether the site search source is enabled or not
9471
+ */
9472
+ enabled: boolean;
9473
+ /**
9474
+ * Whether the spidering should automatically run after associated build triggers complete
9475
+ */
9476
+ build_trigger_indexing_enabled: boolean;
9477
+ /**
9478
+ * The public URL of the frontend. This is the starting point from which the website's spidering will start
9479
+ */
9480
+ frontend_url: string | null;
9481
+ /**
9482
+ * Optional suffix to append to the DatoCmsSearchBot user agent when indexing the website
9483
+ */
9484
+ user_agent_suffix: string | null;
9485
+ };
9486
+ /**
9487
+ * JSON API links
9488
+ *
9489
+ * This interface was referenced by `SiteSearchSource`'s JSON-Schema
9490
+ * via the `definition` "relationships".
9491
+ */
9492
+ export type SiteSearchSourceRelationships = {
9493
+ /**
9494
+ * The build triggers connected to this site search source
9495
+ */
9496
+ build_triggers: {
9497
+ data: BuildTriggerData[];
9498
+ };
9499
+ };
9500
+ /**
9501
+ * Meta information about the site search source
9502
+ *
9503
+ * This interface was referenced by `SiteSearchSource`'s JSON-Schema
9504
+ * via the `definition` "meta".
9505
+ */
9506
+ export type SiteSearchSourceMeta = {
9507
+ /**
9508
+ * Status of the site search indexing
9509
+ */
9510
+ indexing_status: 'unstarted' | 'pending' | 'success' | 'failed';
9511
+ /**
9512
+ * Timestamp of the last completed indexing
9513
+ */
9514
+ last_indexing_completed_at: string | null;
9515
+ };
9516
+ /**
9517
+ * This interface was referenced by `SiteSearchSource`'s JSON-Schema
9518
+ * via the `instances.targetSchema` link.
9519
+ */
9520
+ export type SiteSearchSourceInstancesTargetSchema = {
9521
+ data: SiteSearchSource[];
9522
+ };
9523
+ /**
9524
+ * This interface was referenced by `SiteSearchSource`'s JSON-Schema
9525
+ * via the `self.targetSchema` link.
9526
+ */
9527
+ export type SiteSearchSourceSelfTargetSchema = {
9528
+ data: SiteSearchSource;
9529
+ };
9530
+ /**
9531
+ * This interface was referenced by `SiteSearchSource`'s JSON-Schema
9532
+ * via the `create.schema` link.
9533
+ */
9534
+ export type SiteSearchSourceCreateSchema = {
9535
+ data: {
9536
+ type: SiteSearchSourceType;
9537
+ attributes: {
9538
+ /**
9539
+ * Name of the site search source
9540
+ */
9541
+ name: string;
9542
+ /**
9543
+ * Whether the site search source is enabled or not
9544
+ */
9545
+ enabled: boolean;
9546
+ /**
9547
+ * Whether the spidering should automatically run after associated build triggers complete
9548
+ */
9549
+ build_trigger_indexing_enabled?: boolean;
9550
+ /**
9551
+ * The public URL of the frontend. This is the starting point from which the website's spidering will start
9552
+ */
9553
+ frontend_url: string | null;
9554
+ /**
9555
+ * Optional suffix to append to the DatoCmsSearchBot user agent when indexing the website
9556
+ */
9557
+ user_agent_suffix?: string | null;
9558
+ };
9559
+ /**
9560
+ * JSON API links
9561
+ */
9562
+ relationships?: {
9563
+ /**
9564
+ * The build triggers connected to this site search source
9565
+ */
9566
+ build_triggers?: {
9567
+ data: BuildTriggerData[];
9568
+ };
9569
+ };
9570
+ };
9571
+ };
9572
+ /**
9573
+ * This interface was referenced by `SiteSearchSource`'s JSON-Schema
9574
+ * via the `create.targetSchema` link.
9575
+ */
9576
+ export type SiteSearchSourceCreateTargetSchema = {
9577
+ data: SiteSearchSource;
9578
+ };
9579
+ /**
9580
+ * This interface was referenced by `SiteSearchSource`'s JSON-Schema
9581
+ * via the `update.schema` link.
9582
+ */
9583
+ export type SiteSearchSourceUpdateSchema = {
9584
+ data: {
9585
+ type: SiteSearchSourceType;
9586
+ id: SiteSearchSourceIdentity;
9587
+ attributes: {
9588
+ /**
9589
+ * Name of the site search source
9590
+ */
9591
+ name?: string;
9592
+ /**
9593
+ * Whether the site search source is enabled or not
9594
+ */
9595
+ enabled?: boolean;
9596
+ /**
9597
+ * Whether the spidering should automatically run after associated build triggers complete
9598
+ */
9599
+ build_trigger_indexing_enabled?: boolean;
9600
+ /**
9601
+ * The public URL of the frontend. This is the starting point from which the website's spidering will start
9602
+ */
9603
+ frontend_url?: string | null;
9604
+ /**
9605
+ * Optional suffix to append to the DatoCmsSearchBot user agent when indexing the website
9606
+ */
9607
+ user_agent_suffix?: string | null;
9608
+ };
9609
+ /**
9610
+ * JSON API links
9611
+ */
9612
+ relationships?: {
9613
+ /**
9614
+ * The build triggers connected to this site search source
9615
+ */
9616
+ build_triggers?: {
9617
+ data: BuildTriggerData[];
9618
+ };
9619
+ };
9620
+ };
9621
+ };
9622
+ /**
9623
+ * This interface was referenced by `SiteSearchSource`'s JSON-Schema
9624
+ * via the `update.targetSchema` link.
9625
+ */
9626
+ export type SiteSearchSourceUpdateTargetSchema = {
9627
+ data: SiteSearchSource;
9628
+ };
9629
+ /**
9630
+ * This interface was referenced by `SiteSearchSource`'s JSON-Schema
9631
+ * via the `destroy.targetSchema` link.
9632
+ */
9633
+ export type SiteSearchSourceDestroyTargetSchema = {
9634
+ data: SiteSearchSource;
9635
+ };
9187
9636
  /**
9188
9637
  * In DatoCMS you can create filters to help you (and other editors) quickly search for records
9189
9638
  *