@datocms/cma-client 6.1.3 → 6.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -90,7 +90,7 @@ class Client {
90
90
  return this.config.baseUrl || Client.defaultBaseUrl;
91
91
  }
92
92
  request(options) {
93
- return (0, rest_client_utils_1.request)(Object.assign(Object.assign(Object.assign({}, this.config), options), { logFn: this.config.logFn || console.log, userAgent: '@datocms/cma-client v6.1.3', baseUrl: this.baseUrl, preCallStack: new Error().stack, extraHeaders: Object.assign(Object.assign(Object.assign({}, (this.config.extraHeaders || {})), (this.config.environment
93
+ return (0, rest_client_utils_1.request)(Object.assign(Object.assign(Object.assign({}, this.config), options), { logFn: this.config.logFn || console.log, userAgent: '@datocms/cma-client v6.3.0', baseUrl: this.baseUrl, preCallStack: new Error().stack, extraHeaders: Object.assign(Object.assign(Object.assign({}, (this.config.extraHeaders || {})), (this.config.environment
94
94
  ? { 'X-Environment': this.config.environment }
95
95
  : {})), { 'X-API-Version': '3' }), fetchJobResult: (jobId) => {
96
96
  return this.jobResultsFetcher
@@ -50,6 +50,7 @@ class Plugin extends BaseResource_js_1.default {
50
50
  'field_types',
51
51
  'parameter_definitions',
52
52
  'package_version',
53
+ 'enabled',
53
54
  ],
54
55
  relationships: [],
55
56
  })).then((body) => Utils.deserializeResponseBody(body));
@@ -85,9 +86,11 @@ class Plugin extends BaseResource_js_1.default {
85
86
  'name',
86
87
  'description',
87
88
  'url',
89
+ 'package_name',
88
90
  'parameters',
89
91
  'package_version',
90
92
  'permissions',
93
+ 'enabled',
91
94
  ],
92
95
  relationships: [],
93
96
  })).then((body) => Utils.deserializeResponseBody(body));
@@ -1 +1 @@
1
- {"version":3,"file":"Plugin.js","sourceRoot":"","sources":["../../../../src/generated/resources/Plugin.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kEAAoD;AACpD,4EAAiD;AAIjD,MAAqB,MAAO,SAAQ,yBAAY;IAG9C;;;;;;;OAOG;IACH,MAAM,CAAC,IAAiC;QACtC,OAAO,IAAI,CAAC,SAAS,CACnB,KAAK,CAAC,oBAAoB,CAAiC,IAAI,EAAE;YAC/D,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,cAAc;gBACd,MAAM;gBACN,aAAa;gBACb,KAAK;gBACL,aAAa;gBACb,aAAa;gBACb,aAAa;gBACb,uBAAuB;gBACvB,iBAAiB;aAClB;YACD,aAAa,EAAE,EAAE;SAClB,CAAC,CACH,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CACd,KAAK,CAAC,uBAAuB,CAAoC,IAAI,CAAC,CACvE,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,SAAS,CACP,IAAoC;QAEpC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAuC;YAC/D,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,UAAU;YACf,IAAI;SACL,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CACJ,QAAsC,EACtC,IAAiC;QAEjC,OAAO,IAAI,CAAC,SAAS,CACnB,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,EACpB,KAAK,CAAC,oBAAoB,CAAiC,IAAI,EAAE;YAC/D,EAAE,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC;YACxB,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,MAAM;gBACN,aAAa;gBACb,KAAK;gBACL,YAAY;gBACZ,iBAAiB;gBACjB,aAAa;aACd;YACD,aAAa,EAAE,EAAE;SAClB,CAAC,CACH,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CACd,KAAK,CAAC,uBAAuB,CAAoC,IAAI,CAAC,CACvE,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,SAAS,CACP,QAAgB,EAChB,IAAoC;QAEpC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAuC;YAC/D,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,YAAY,QAAQ,EAAE;YAC3B,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,CAAuC,IAAI,CAAC,CAC1E,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAA0C;YAClE,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,UAAU;SAChB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CAAC,QAAsC;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CACtD,KAAK,CAAC,uBAAuB,CAAkC,IAAI,CAAC,CACrE,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CAAC,QAAgB;QACtB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAqC;YAC7D,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,YAAY,QAAQ,EAAE;SAC5B,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CAAC,QAAsC;QAC5C,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CACzD,KAAK,CAAC,uBAAuB,CAAqC,IAAI,CAAC,CACxE,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,UAAU,CAAC,QAAgB;QACzB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAwC;YAChE,MAAM,EAAE,QAAQ;YAChB,GAAG,EAAE,YAAY,QAAQ,EAAE;SAC5B,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,QAAsC;QAC3C,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CACxD,KAAK,CAAC,uBAAuB,CAAoC,IAAI,CAAC,CACvE,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,SAAS,CAAC,QAAgB;QACxB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAuC;YAC/D,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,YAAY,QAAQ,SAAS;SACnC,CAAC,CAAC;IACL,CAAC;;AAxNH,yBAyNC;AAxNiB,WAAI,GAAG,QAAiB,CAAC"}
1
+ {"version":3,"file":"Plugin.js","sourceRoot":"","sources":["../../../../src/generated/resources/Plugin.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kEAAoD;AACpD,4EAAiD;AAIjD,MAAqB,MAAO,SAAQ,yBAAY;IAG9C;;;;;;;OAOG;IACH,MAAM,CAAC,IAAiC;QACtC,OAAO,IAAI,CAAC,SAAS,CACnB,KAAK,CAAC,oBAAoB,CAAiC,IAAI,EAAE;YAC/D,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,cAAc;gBACd,MAAM;gBACN,aAAa;gBACb,KAAK;gBACL,aAAa;gBACb,aAAa;gBACb,aAAa;gBACb,uBAAuB;gBACvB,iBAAiB;gBACjB,SAAS;aACV;YACD,aAAa,EAAE,EAAE;SAClB,CAAC,CACH,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CACd,KAAK,CAAC,uBAAuB,CAAoC,IAAI,CAAC,CACvE,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,SAAS,CACP,IAAoC;QAEpC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAuC;YAC/D,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,UAAU;YACf,IAAI;SACL,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CACJ,QAAsC,EACtC,IAAiC;QAEjC,OAAO,IAAI,CAAC,SAAS,CACnB,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,EACpB,KAAK,CAAC,oBAAoB,CAAiC,IAAI,EAAE;YAC/D,EAAE,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC;YACxB,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,MAAM;gBACN,aAAa;gBACb,KAAK;gBACL,cAAc;gBACd,YAAY;gBACZ,iBAAiB;gBACjB,aAAa;gBACb,SAAS;aACV;YACD,aAAa,EAAE,EAAE;SAClB,CAAC,CACH,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CACd,KAAK,CAAC,uBAAuB,CAAoC,IAAI,CAAC,CACvE,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,SAAS,CACP,QAAgB,EAChB,IAAoC;QAEpC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAuC;YAC/D,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,YAAY,QAAQ,EAAE;YAC3B,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,CAAuC,IAAI,CAAC,CAC1E,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAA0C;YAClE,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,UAAU;SAChB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CAAC,QAAsC;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CACtD,KAAK,CAAC,uBAAuB,CAAkC,IAAI,CAAC,CACrE,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CAAC,QAAgB;QACtB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAqC;YAC7D,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,YAAY,QAAQ,EAAE;SAC5B,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CAAC,QAAsC;QAC5C,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CACzD,KAAK,CAAC,uBAAuB,CAAqC,IAAI,CAAC,CACxE,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,UAAU,CAAC,QAAgB;QACzB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAwC;YAChE,MAAM,EAAE,QAAQ;YAChB,GAAG,EAAE,YAAY,QAAQ,EAAE;SAC5B,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,QAAsC;QAC3C,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CACxD,KAAK,CAAC,uBAAuB,CAAoC,IAAI,CAAC,CACvE,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,SAAS,CAAC,QAAgB;QACxB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAuC;YAC/D,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,YAAY,QAAQ,SAAS;SACnC,CAAC,CAAC;IACL,CAAC;;AA3NH,yBA4NC;AA3NiB,WAAI,GAAG,QAAiB,CAAC"}
@@ -6812,6 +6812,10 @@ export type Plugin = {
6812
6812
  global: unknown[];
6813
6813
  instance: unknown[];
6814
6814
  };
6815
+ /**
6816
+ * Whether the plugin is enabled or not. When disabled, the plugin behaves as if it didn't exist: fields using it as editor/addon fall back to the default editor, and any sidebar panel/page/config screen/asset source it registers does not render.
6817
+ */
6818
+ enabled: boolean;
6815
6819
  meta: PluginMeta;
6816
6820
  };
6817
6821
  export type PluginCreateTargetSchema = Plugin;
@@ -6892,6 +6896,10 @@ export type PluginAttributes = {
6892
6896
  global: unknown[];
6893
6897
  instance: unknown[];
6894
6898
  };
6899
+ /**
6900
+ * Whether the plugin is enabled or not. When disabled, the plugin behaves as if it didn't exist: fields using it as editor/addon fall back to the default editor, and any sidebar panel/page/config screen/asset source it registers does not render.
6901
+ */
6902
+ enabled: boolean;
6895
6903
  };
6896
6904
  /**
6897
6905
  * This interface was referenced by `Plugin`'s JSON-Schema
@@ -6939,6 +6947,10 @@ export type PluginCreateSchema = {
6939
6947
  * NPM version of the plugin
6940
6948
  */
6941
6949
  package_version?: null | string;
6950
+ /**
6951
+ * Whether the plugin is enabled or not. Defaults to `true`.
6952
+ */
6953
+ enabled?: boolean;
6942
6954
  };
6943
6955
  /**
6944
6956
  * This interface was referenced by `Plugin`'s JSON-Schema
@@ -6959,6 +6971,10 @@ export type PluginUpdateSchema = {
6959
6971
  * The entry point URL of the plugin
6960
6972
  */
6961
6973
  url?: string;
6974
+ /**
6975
+ * Turns a private plugin into a Marketplace plugin, installing the specified package from the DatoCMS Marketplace. Only accepted for private, non-legacy plugins, and cannot be combined with other attributes (except `enabled`). Name, description, URL, version and permissions are replaced with the ones published in the Marketplace, while the existing `parameters` are preserved.
6976
+ */
6977
+ package_name?: string;
6962
6978
  /**
6963
6979
  * Global plugin configuration. Plugins can persist whatever information they want in this object to reuse it later. Refer to the CMA for details about technical limits.
6964
6980
  */
@@ -6973,6 +6989,10 @@ export type PluginUpdateSchema = {
6973
6989
  * Permissions granted to this plugin
6974
6990
  */
6975
6991
  permissions?: 'currentUserAccessToken'[];
6992
+ /**
6993
+ * Whether the plugin is enabled or not. When disabled, the plugin behaves as if it didn't exist: fields using it as editor/addon fall back to the default editor, and any sidebar panel/page/config screen/asset source it registers does not render.
6994
+ */
6995
+ enabled?: boolean;
6976
6996
  meta?: {
6977
6997
  [k: string]: unknown;
6978
6998
  };
@@ -10965,7 +10985,7 @@ export type Site = {
10965
10985
  */
10966
10986
  domain: string | null;
10967
10987
  /**
10968
- * Google API Key to be used by the LatLon widget
10988
+ * Google API Key to be used by the LatLon field editor. Only the DatoCMS interface uses it: it returns `null` for any other caller.
10969
10989
  */
10970
10990
  google_maps_api_token: string | null;
10971
10991
  /**
@@ -10973,7 +10993,7 @@ export type Site = {
10973
10993
  */
10974
10994
  imgix_host: string | null;
10975
10995
  /**
10976
- * DatoCMS internal domain for the administrative area
10996
+ * DatoCMS internal domain for the administrative area. Returns `null` if the credentials you are using cannot change the project's settings.
10977
10997
  */
10978
10998
  internal_domain: string | null;
10979
10999
  /**
@@ -10997,13 +11017,13 @@ export type Site = {
10997
11017
  */
10998
11018
  last_data_change_at: null | string;
10999
11019
  /**
11000
- * Specifies whether all users of this site need to authenticate using two-factor authentication
11020
+ * Specifies whether all users of this site need to authenticate using two-factor authentication. Returns `null` if the credentials you are using cannot change the project's settings.
11001
11021
  */
11002
- require_2fa: boolean;
11022
+ require_2fa: boolean | null;
11003
11023
  /**
11004
- * Specifies whether you want IPs to be tracked in the Project usages section
11024
+ * Specifies whether you want IPs to be tracked in the Project usages section. Returns `null` if the credentials you are using cannot change the project's settings.
11005
11025
  */
11006
- ip_tracking_enabled: boolean;
11026
+ ip_tracking_enabled: boolean | null;
11007
11027
  /**
11008
11028
  * If enabled, blocks schema changes of primary environment
11009
11029
  */
@@ -11312,7 +11332,7 @@ export type SiteAttributes = {
11312
11332
  */
11313
11333
  domain: string | null;
11314
11334
  /**
11315
- * Google API Key to be used by the LatLon widget
11335
+ * Google API Key to be used by the LatLon field editor. Only the DatoCMS interface uses it: it returns `null` for any other caller.
11316
11336
  */
11317
11337
  google_maps_api_token: string | null;
11318
11338
  /**
@@ -11320,7 +11340,7 @@ export type SiteAttributes = {
11320
11340
  */
11321
11341
  imgix_host: string | null;
11322
11342
  /**
11323
- * DatoCMS internal domain for the administrative area
11343
+ * DatoCMS internal domain for the administrative area. Returns `null` if the credentials you are using cannot change the project's settings.
11324
11344
  */
11325
11345
  internal_domain: string | null;
11326
11346
  /**
@@ -11344,13 +11364,13 @@ export type SiteAttributes = {
11344
11364
  */
11345
11365
  last_data_change_at: null | string;
11346
11366
  /**
11347
- * Specifies whether all users of this site need to authenticate using two-factor authentication
11367
+ * Specifies whether all users of this site need to authenticate using two-factor authentication. Returns `null` if the credentials you are using cannot change the project's settings.
11348
11368
  */
11349
- require_2fa: boolean;
11369
+ require_2fa: boolean | null;
11350
11370
  /**
11351
- * Specifies whether you want IPs to be tracked in the Project usages section
11371
+ * Specifies whether you want IPs to be tracked in the Project usages section. Returns `null` if the credentials you are using cannot change the project's settings.
11352
11372
  */
11353
- ip_tracking_enabled: boolean;
11373
+ ip_tracking_enabled: boolean | null;
11354
11374
  /**
11355
11375
  * If enabled, blocks schema changes of primary environment
11356
11376
  */
@@ -11734,11 +11754,11 @@ export type SiteUpdateSchema = {
11734
11754
  */
11735
11755
  timezone?: string;
11736
11756
  /**
11737
- * Specifies whether all users of this site need to authenticate using two-factor authentication
11757
+ * Specifies whether all users of this site need to authenticate using two-factor authentication.
11738
11758
  */
11739
11759
  require_2fa?: boolean;
11740
11760
  /**
11741
- * Specifies whether you want IPs to be tracked in the Project usages section
11761
+ * Specifies whether you want IPs to be tracked in the Project usages section.
11742
11762
  */
11743
11763
  ip_tracking_enabled?: boolean;
11744
11764
  /**
@@ -59,7 +59,7 @@ export class Client {
59
59
  ...this.config,
60
60
  ...options,
61
61
  logFn: this.config.logFn || console.log,
62
- userAgent: '@datocms/cma-client v6.1.3',
62
+ userAgent: '@datocms/cma-client v6.3.0',
63
63
  baseUrl: this.baseUrl,
64
64
  preCallStack: new Error().stack,
65
65
  extraHeaders: {
@@ -6644,6 +6644,10 @@ export type PluginAttributes = {
6644
6644
  global: unknown[];
6645
6645
  instance: unknown[];
6646
6646
  };
6647
+ /**
6648
+ * Whether the plugin is enabled or not. When disabled, the plugin behaves as if it didn't exist: fields using it as editor/addon fall back to the default editor, and any sidebar panel/page/config screen/asset source it registers does not render.
6649
+ */
6650
+ enabled: boolean;
6647
6651
  };
6648
6652
  /**
6649
6653
  * JSON API meta
@@ -6715,6 +6719,10 @@ export type PluginCreateSchema = {
6715
6719
  * NPM version of the plugin
6716
6720
  */
6717
6721
  package_version?: null | string;
6722
+ /**
6723
+ * Whether the plugin is enabled or not. Defaults to `true`.
6724
+ */
6725
+ enabled?: boolean;
6718
6726
  };
6719
6727
  };
6720
6728
  };
@@ -6746,6 +6754,10 @@ export type PluginUpdateSchema = {
6746
6754
  * The entry point URL of the plugin
6747
6755
  */
6748
6756
  url?: string;
6757
+ /**
6758
+ * Turns a private plugin into a Marketplace plugin, installing the specified package from the DatoCMS Marketplace. Only accepted for private, non-legacy plugins, and cannot be combined with other attributes (except `enabled`). Name, description, URL, version and permissions are replaced with the ones published in the Marketplace, while the existing `parameters` are preserved.
6759
+ */
6760
+ package_name?: string;
6749
6761
  /**
6750
6762
  * Global plugin configuration. Plugins can persist whatever information they want in this object to reuse it later. Refer to the CMA for details about technical limits.
6751
6763
  */
@@ -6760,6 +6772,10 @@ export type PluginUpdateSchema = {
6760
6772
  * Permissions granted to this plugin
6761
6773
  */
6762
6774
  permissions?: 'currentUserAccessToken'[];
6775
+ /**
6776
+ * Whether the plugin is enabled or not. When disabled, the plugin behaves as if it didn't exist: fields using it as editor/addon fall back to the default editor, and any sidebar panel/page/config screen/asset source it registers does not render.
6777
+ */
6778
+ enabled?: boolean;
6763
6779
  };
6764
6780
  meta?: {
6765
6781
  [k: string]: unknown;
@@ -11401,7 +11417,7 @@ export type SiteAttributes = {
11401
11417
  */
11402
11418
  domain: string | null;
11403
11419
  /**
11404
- * Google API Key to be used by the LatLon widget
11420
+ * Google API Key to be used by the LatLon field editor. Only the DatoCMS interface uses it: it returns `null` for any other caller.
11405
11421
  */
11406
11422
  google_maps_api_token: string | null;
11407
11423
  /**
@@ -11409,7 +11425,7 @@ export type SiteAttributes = {
11409
11425
  */
11410
11426
  imgix_host: string | null;
11411
11427
  /**
11412
- * DatoCMS internal domain for the administrative area
11428
+ * DatoCMS internal domain for the administrative area. Returns `null` if the credentials you are using cannot change the project's settings.
11413
11429
  */
11414
11430
  internal_domain: string | null;
11415
11431
  /**
@@ -11433,13 +11449,13 @@ export type SiteAttributes = {
11433
11449
  */
11434
11450
  last_data_change_at: null | string;
11435
11451
  /**
11436
- * Specifies whether all users of this site need to authenticate using two-factor authentication
11452
+ * Specifies whether all users of this site need to authenticate using two-factor authentication. Returns `null` if the credentials you are using cannot change the project's settings.
11437
11453
  */
11438
- require_2fa: boolean;
11454
+ require_2fa: boolean | null;
11439
11455
  /**
11440
- * Specifies whether you want IPs to be tracked in the Project usages section
11456
+ * Specifies whether you want IPs to be tracked in the Project usages section. Returns `null` if the credentials you are using cannot change the project's settings.
11441
11457
  */
11442
- ip_tracking_enabled: boolean;
11458
+ ip_tracking_enabled: boolean | null;
11443
11459
  /**
11444
11460
  * If enabled, blocks schema changes of primary environment
11445
11461
  */
@@ -11913,11 +11929,11 @@ export type SiteUpdateSchema = {
11913
11929
  */
11914
11930
  timezone?: string;
11915
11931
  /**
11916
- * Specifies whether all users of this site need to authenticate using two-factor authentication
11932
+ * Specifies whether all users of this site need to authenticate using two-factor authentication.
11917
11933
  */
11918
11934
  require_2fa?: boolean;
11919
11935
  /**
11920
- * Specifies whether you want IPs to be tracked in the Project usages section
11936
+ * Specifies whether you want IPs to be tracked in the Project usages section.
11921
11937
  */
11922
11938
  ip_tracking_enabled?: boolean;
11923
11939
  /**
@@ -19,7 +19,7 @@ export default class ItemVersion extends BaseResource {
19
19
  item_type: ApiTypes.ItemTypeData<import("../../index.js").ItemTypeDefinition<{
20
20
  locales: string;
21
21
  }, string, {}>>;
22
- creator?: ApiTypes.UserData | ApiTypes.AccessTokenData | ApiTypes.AccountData | ApiTypes.SsoUserData | ApiTypes.OrganizationData | undefined;
22
+ creator?: ApiTypes.AccountData | ApiTypes.AccessTokenData | ApiTypes.UserData | ApiTypes.SsoUserData | ApiTypes.OrganizationData | undefined;
23
23
  meta: ApiTypes.ItemMeta;
24
24
  } & Record<string, unknown>, ApiTypes.ItemVersion]>;
25
25
  /**
@@ -22,6 +22,7 @@ export default class Plugin extends BaseResource {
22
22
  'field_types',
23
23
  'parameter_definitions',
24
24
  'package_version',
25
+ 'enabled',
25
26
  ],
26
27
  relationships: [],
27
28
  })).then((body) => Utils.deserializeResponseBody(body));
@@ -57,9 +58,11 @@ export default class Plugin extends BaseResource {
57
58
  'name',
58
59
  'description',
59
60
  'url',
61
+ 'package_name',
60
62
  'parameters',
61
63
  'package_version',
62
64
  'permissions',
65
+ 'enabled',
63
66
  ],
64
67
  relationships: [],
65
68
  })).then((body) => Utils.deserializeResponseBody(body));
@@ -1 +1 @@
1
- {"version":3,"file":"Plugin.js","sourceRoot":"","sources":["../../../../src/generated/resources/Plugin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,4BAA4B,CAAC;AACpD,OAAO,YAAY,MAAM,uBAAuB,CAAC;AAIjD,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,YAAY;IAG9C;;;;;;;OAOG;IACH,MAAM,CAAC,IAAiC;QACtC,OAAO,IAAI,CAAC,SAAS,CACnB,KAAK,CAAC,oBAAoB,CAAiC,IAAI,EAAE;YAC/D,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,cAAc;gBACd,MAAM;gBACN,aAAa;gBACb,KAAK;gBACL,aAAa;gBACb,aAAa;gBACb,aAAa;gBACb,uBAAuB;gBACvB,iBAAiB;aAClB;YACD,aAAa,EAAE,EAAE;SAClB,CAAC,CACH,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CACd,KAAK,CAAC,uBAAuB,CAAoC,IAAI,CAAC,CACvE,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,SAAS,CACP,IAAoC;QAEpC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAuC;YAC/D,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,UAAU;YACf,IAAI;SACL,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CACJ,QAAsC,EACtC,IAAiC;QAEjC,OAAO,IAAI,CAAC,SAAS,CACnB,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,EACpB,KAAK,CAAC,oBAAoB,CAAiC,IAAI,EAAE;YAC/D,EAAE,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC;YACxB,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,MAAM;gBACN,aAAa;gBACb,KAAK;gBACL,YAAY;gBACZ,iBAAiB;gBACjB,aAAa;aACd;YACD,aAAa,EAAE,EAAE;SAClB,CAAC,CACH,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CACd,KAAK,CAAC,uBAAuB,CAAoC,IAAI,CAAC,CACvE,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,SAAS,CACP,QAAgB,EAChB,IAAoC;QAEpC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAuC;YAC/D,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,YAAY,QAAQ,EAAE;YAC3B,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,CAAuC,IAAI,CAAC,CAC1E,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAA0C;YAClE,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,UAAU;SAChB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CAAC,QAAsC;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CACtD,KAAK,CAAC,uBAAuB,CAAkC,IAAI,CAAC,CACrE,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CAAC,QAAgB;QACtB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAqC;YAC7D,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,YAAY,QAAQ,EAAE;SAC5B,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CAAC,QAAsC;QAC5C,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CACzD,KAAK,CAAC,uBAAuB,CAAqC,IAAI,CAAC,CACxE,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,UAAU,CAAC,QAAgB;QACzB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAwC;YAChE,MAAM,EAAE,QAAQ;YAChB,GAAG,EAAE,YAAY,QAAQ,EAAE;SAC5B,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,QAAsC;QAC3C,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CACxD,KAAK,CAAC,uBAAuB,CAAoC,IAAI,CAAC,CACvE,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,SAAS,CAAC,QAAgB;QACxB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAuC;YAC/D,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,YAAY,QAAQ,SAAS;SACnC,CAAC,CAAC;IACL,CAAC;;AAvNe,WAAI,GAAG,QAAiB,CAAC"}
1
+ {"version":3,"file":"Plugin.js","sourceRoot":"","sources":["../../../../src/generated/resources/Plugin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,4BAA4B,CAAC;AACpD,OAAO,YAAY,MAAM,uBAAuB,CAAC;AAIjD,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,YAAY;IAG9C;;;;;;;OAOG;IACH,MAAM,CAAC,IAAiC;QACtC,OAAO,IAAI,CAAC,SAAS,CACnB,KAAK,CAAC,oBAAoB,CAAiC,IAAI,EAAE;YAC/D,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,cAAc;gBACd,MAAM;gBACN,aAAa;gBACb,KAAK;gBACL,aAAa;gBACb,aAAa;gBACb,aAAa;gBACb,uBAAuB;gBACvB,iBAAiB;gBACjB,SAAS;aACV;YACD,aAAa,EAAE,EAAE;SAClB,CAAC,CACH,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CACd,KAAK,CAAC,uBAAuB,CAAoC,IAAI,CAAC,CACvE,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,SAAS,CACP,IAAoC;QAEpC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAuC;YAC/D,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,UAAU;YACf,IAAI;SACL,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CACJ,QAAsC,EACtC,IAAiC;QAEjC,OAAO,IAAI,CAAC,SAAS,CACnB,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,EACpB,KAAK,CAAC,oBAAoB,CAAiC,IAAI,EAAE;YAC/D,EAAE,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC;YACxB,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,MAAM;gBACN,aAAa;gBACb,KAAK;gBACL,cAAc;gBACd,YAAY;gBACZ,iBAAiB;gBACjB,aAAa;gBACb,SAAS;aACV;YACD,aAAa,EAAE,EAAE;SAClB,CAAC,CACH,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CACd,KAAK,CAAC,uBAAuB,CAAoC,IAAI,CAAC,CACvE,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,SAAS,CACP,QAAgB,EAChB,IAAoC;QAEpC,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAuC;YAC/D,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,YAAY,QAAQ,EAAE;YAC3B,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,CAAuC,IAAI,CAAC,CAC1E,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAA0C;YAClE,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,UAAU;SAChB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CAAC,QAAsC;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CACtD,KAAK,CAAC,uBAAuB,CAAkC,IAAI,CAAC,CACrE,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CAAC,QAAgB;QACtB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAqC;YAC7D,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,YAAY,QAAQ,EAAE;SAC5B,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CAAC,QAAsC;QAC5C,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CACzD,KAAK,CAAC,uBAAuB,CAAqC,IAAI,CAAC,CACxE,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,UAAU,CAAC,QAAgB;QACzB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAwC;YAChE,MAAM,EAAE,QAAQ;YAChB,GAAG,EAAE,YAAY,QAAQ,EAAE;SAC5B,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,QAAsC;QAC3C,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CACxD,KAAK,CAAC,uBAAuB,CAAoC,IAAI,CAAC,CACvE,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,SAAS,CAAC,QAAgB;QACxB,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAuC;YAC/D,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,YAAY,QAAQ,SAAS;SACnC,CAAC,CAAC;IACL,CAAC;;AA1Ne,WAAI,GAAG,QAAiB,CAAC"}
@@ -1,3 +1,4 @@
1
+ import type * as ApiTypes from '../generated/ApiTypes.js';
1
2
  export type StringMatchesFilter = {
2
3
  /** Pattern to match against */
3
4
  pattern: string;
@@ -242,8 +243,20 @@ export type PositionFilter = {
242
243
  /** Exclude records with an exact match */
243
244
  neq?: number;
244
245
  };
246
+ export type CreatorReference = ApiTypes.AccountData | ApiTypes.AccessTokenData | ApiTypes.UserData | ApiTypes.SsoUserData | ApiTypes.OrganizationData;
247
+ export type CreatorFilter = {
248
+ /** Search records created by the specified creator */
249
+ eq?: CreatorReference;
250
+ /** Exclude records created by the specified creator */
251
+ neq?: CreatorReference;
252
+ /** Search records created by one of the specified creators */
253
+ in?: CreatorReference[];
254
+ /** Search records not created by any of the specified creators */
255
+ notIn?: CreatorReference[];
256
+ };
245
257
  export type ItemMetaFilter = {
246
258
  _created_at?: DateTimeHrefFilter;
259
+ _creator?: CreatorFilter;
247
260
  _first_published_at?: DateTimeHrefFilter;
248
261
  _is_valid?: BooleanHrefFilter;
249
262
  _publication_scheduled_at?: DateTimeHrefFilter;
@@ -6812,6 +6812,10 @@ export type Plugin = {
6812
6812
  global: unknown[];
6813
6813
  instance: unknown[];
6814
6814
  };
6815
+ /**
6816
+ * Whether the plugin is enabled or not. When disabled, the plugin behaves as if it didn't exist: fields using it as editor/addon fall back to the default editor, and any sidebar panel/page/config screen/asset source it registers does not render.
6817
+ */
6818
+ enabled: boolean;
6815
6819
  meta: PluginMeta;
6816
6820
  };
6817
6821
  export type PluginCreateTargetSchema = Plugin;
@@ -6892,6 +6896,10 @@ export type PluginAttributes = {
6892
6896
  global: unknown[];
6893
6897
  instance: unknown[];
6894
6898
  };
6899
+ /**
6900
+ * Whether the plugin is enabled or not. When disabled, the plugin behaves as if it didn't exist: fields using it as editor/addon fall back to the default editor, and any sidebar panel/page/config screen/asset source it registers does not render.
6901
+ */
6902
+ enabled: boolean;
6895
6903
  };
6896
6904
  /**
6897
6905
  * This interface was referenced by `Plugin`'s JSON-Schema
@@ -6939,6 +6947,10 @@ export type PluginCreateSchema = {
6939
6947
  * NPM version of the plugin
6940
6948
  */
6941
6949
  package_version?: null | string;
6950
+ /**
6951
+ * Whether the plugin is enabled or not. Defaults to `true`.
6952
+ */
6953
+ enabled?: boolean;
6942
6954
  };
6943
6955
  /**
6944
6956
  * This interface was referenced by `Plugin`'s JSON-Schema
@@ -6959,6 +6971,10 @@ export type PluginUpdateSchema = {
6959
6971
  * The entry point URL of the plugin
6960
6972
  */
6961
6973
  url?: string;
6974
+ /**
6975
+ * Turns a private plugin into a Marketplace plugin, installing the specified package from the DatoCMS Marketplace. Only accepted for private, non-legacy plugins, and cannot be combined with other attributes (except `enabled`). Name, description, URL, version and permissions are replaced with the ones published in the Marketplace, while the existing `parameters` are preserved.
6976
+ */
6977
+ package_name?: string;
6962
6978
  /**
6963
6979
  * Global plugin configuration. Plugins can persist whatever information they want in this object to reuse it later. Refer to the CMA for details about technical limits.
6964
6980
  */
@@ -6973,6 +6989,10 @@ export type PluginUpdateSchema = {
6973
6989
  * Permissions granted to this plugin
6974
6990
  */
6975
6991
  permissions?: 'currentUserAccessToken'[];
6992
+ /**
6993
+ * Whether the plugin is enabled or not. When disabled, the plugin behaves as if it didn't exist: fields using it as editor/addon fall back to the default editor, and any sidebar panel/page/config screen/asset source it registers does not render.
6994
+ */
6995
+ enabled?: boolean;
6976
6996
  meta?: {
6977
6997
  [k: string]: unknown;
6978
6998
  };
@@ -10965,7 +10985,7 @@ export type Site = {
10965
10985
  */
10966
10986
  domain: string | null;
10967
10987
  /**
10968
- * Google API Key to be used by the LatLon widget
10988
+ * Google API Key to be used by the LatLon field editor. Only the DatoCMS interface uses it: it returns `null` for any other caller.
10969
10989
  */
10970
10990
  google_maps_api_token: string | null;
10971
10991
  /**
@@ -10973,7 +10993,7 @@ export type Site = {
10973
10993
  */
10974
10994
  imgix_host: string | null;
10975
10995
  /**
10976
- * DatoCMS internal domain for the administrative area
10996
+ * DatoCMS internal domain for the administrative area. Returns `null` if the credentials you are using cannot change the project's settings.
10977
10997
  */
10978
10998
  internal_domain: string | null;
10979
10999
  /**
@@ -10997,13 +11017,13 @@ export type Site = {
10997
11017
  */
10998
11018
  last_data_change_at: null | string;
10999
11019
  /**
11000
- * Specifies whether all users of this site need to authenticate using two-factor authentication
11020
+ * Specifies whether all users of this site need to authenticate using two-factor authentication. Returns `null` if the credentials you are using cannot change the project's settings.
11001
11021
  */
11002
- require_2fa: boolean;
11022
+ require_2fa: boolean | null;
11003
11023
  /**
11004
- * Specifies whether you want IPs to be tracked in the Project usages section
11024
+ * Specifies whether you want IPs to be tracked in the Project usages section. Returns `null` if the credentials you are using cannot change the project's settings.
11005
11025
  */
11006
- ip_tracking_enabled: boolean;
11026
+ ip_tracking_enabled: boolean | null;
11007
11027
  /**
11008
11028
  * If enabled, blocks schema changes of primary environment
11009
11029
  */
@@ -11312,7 +11332,7 @@ export type SiteAttributes = {
11312
11332
  */
11313
11333
  domain: string | null;
11314
11334
  /**
11315
- * Google API Key to be used by the LatLon widget
11335
+ * Google API Key to be used by the LatLon field editor. Only the DatoCMS interface uses it: it returns `null` for any other caller.
11316
11336
  */
11317
11337
  google_maps_api_token: string | null;
11318
11338
  /**
@@ -11320,7 +11340,7 @@ export type SiteAttributes = {
11320
11340
  */
11321
11341
  imgix_host: string | null;
11322
11342
  /**
11323
- * DatoCMS internal domain for the administrative area
11343
+ * DatoCMS internal domain for the administrative area. Returns `null` if the credentials you are using cannot change the project's settings.
11324
11344
  */
11325
11345
  internal_domain: string | null;
11326
11346
  /**
@@ -11344,13 +11364,13 @@ export type SiteAttributes = {
11344
11364
  */
11345
11365
  last_data_change_at: null | string;
11346
11366
  /**
11347
- * Specifies whether all users of this site need to authenticate using two-factor authentication
11367
+ * Specifies whether all users of this site need to authenticate using two-factor authentication. Returns `null` if the credentials you are using cannot change the project's settings.
11348
11368
  */
11349
- require_2fa: boolean;
11369
+ require_2fa: boolean | null;
11350
11370
  /**
11351
- * Specifies whether you want IPs to be tracked in the Project usages section
11371
+ * Specifies whether you want IPs to be tracked in the Project usages section. Returns `null` if the credentials you are using cannot change the project's settings.
11352
11372
  */
11353
- ip_tracking_enabled: boolean;
11373
+ ip_tracking_enabled: boolean | null;
11354
11374
  /**
11355
11375
  * If enabled, blocks schema changes of primary environment
11356
11376
  */
@@ -11734,11 +11754,11 @@ export type SiteUpdateSchema = {
11734
11754
  */
11735
11755
  timezone?: string;
11736
11756
  /**
11737
- * Specifies whether all users of this site need to authenticate using two-factor authentication
11757
+ * Specifies whether all users of this site need to authenticate using two-factor authentication.
11738
11758
  */
11739
11759
  require_2fa?: boolean;
11740
11760
  /**
11741
- * Specifies whether you want IPs to be tracked in the Project usages section
11761
+ * Specifies whether you want IPs to be tracked in the Project usages section.
11742
11762
  */
11743
11763
  ip_tracking_enabled?: boolean;
11744
11764
  /**
@@ -6644,6 +6644,10 @@ export type PluginAttributes = {
6644
6644
  global: unknown[];
6645
6645
  instance: unknown[];
6646
6646
  };
6647
+ /**
6648
+ * Whether the plugin is enabled or not. When disabled, the plugin behaves as if it didn't exist: fields using it as editor/addon fall back to the default editor, and any sidebar panel/page/config screen/asset source it registers does not render.
6649
+ */
6650
+ enabled: boolean;
6647
6651
  };
6648
6652
  /**
6649
6653
  * JSON API meta
@@ -6715,6 +6719,10 @@ export type PluginCreateSchema = {
6715
6719
  * NPM version of the plugin
6716
6720
  */
6717
6721
  package_version?: null | string;
6722
+ /**
6723
+ * Whether the plugin is enabled or not. Defaults to `true`.
6724
+ */
6725
+ enabled?: boolean;
6718
6726
  };
6719
6727
  };
6720
6728
  };
@@ -6746,6 +6754,10 @@ export type PluginUpdateSchema = {
6746
6754
  * The entry point URL of the plugin
6747
6755
  */
6748
6756
  url?: string;
6757
+ /**
6758
+ * Turns a private plugin into a Marketplace plugin, installing the specified package from the DatoCMS Marketplace. Only accepted for private, non-legacy plugins, and cannot be combined with other attributes (except `enabled`). Name, description, URL, version and permissions are replaced with the ones published in the Marketplace, while the existing `parameters` are preserved.
6759
+ */
6760
+ package_name?: string;
6749
6761
  /**
6750
6762
  * Global plugin configuration. Plugins can persist whatever information they want in this object to reuse it later. Refer to the CMA for details about technical limits.
6751
6763
  */
@@ -6760,6 +6772,10 @@ export type PluginUpdateSchema = {
6760
6772
  * Permissions granted to this plugin
6761
6773
  */
6762
6774
  permissions?: 'currentUserAccessToken'[];
6775
+ /**
6776
+ * Whether the plugin is enabled or not. When disabled, the plugin behaves as if it didn't exist: fields using it as editor/addon fall back to the default editor, and any sidebar panel/page/config screen/asset source it registers does not render.
6777
+ */
6778
+ enabled?: boolean;
6763
6779
  };
6764
6780
  meta?: {
6765
6781
  [k: string]: unknown;
@@ -11401,7 +11417,7 @@ export type SiteAttributes = {
11401
11417
  */
11402
11418
  domain: string | null;
11403
11419
  /**
11404
- * Google API Key to be used by the LatLon widget
11420
+ * Google API Key to be used by the LatLon field editor. Only the DatoCMS interface uses it: it returns `null` for any other caller.
11405
11421
  */
11406
11422
  google_maps_api_token: string | null;
11407
11423
  /**
@@ -11409,7 +11425,7 @@ export type SiteAttributes = {
11409
11425
  */
11410
11426
  imgix_host: string | null;
11411
11427
  /**
11412
- * DatoCMS internal domain for the administrative area
11428
+ * DatoCMS internal domain for the administrative area. Returns `null` if the credentials you are using cannot change the project's settings.
11413
11429
  */
11414
11430
  internal_domain: string | null;
11415
11431
  /**
@@ -11433,13 +11449,13 @@ export type SiteAttributes = {
11433
11449
  */
11434
11450
  last_data_change_at: null | string;
11435
11451
  /**
11436
- * Specifies whether all users of this site need to authenticate using two-factor authentication
11452
+ * Specifies whether all users of this site need to authenticate using two-factor authentication. Returns `null` if the credentials you are using cannot change the project's settings.
11437
11453
  */
11438
- require_2fa: boolean;
11454
+ require_2fa: boolean | null;
11439
11455
  /**
11440
- * Specifies whether you want IPs to be tracked in the Project usages section
11456
+ * Specifies whether you want IPs to be tracked in the Project usages section. Returns `null` if the credentials you are using cannot change the project's settings.
11441
11457
  */
11442
- ip_tracking_enabled: boolean;
11458
+ ip_tracking_enabled: boolean | null;
11443
11459
  /**
11444
11460
  * If enabled, blocks schema changes of primary environment
11445
11461
  */
@@ -11913,11 +11929,11 @@ export type SiteUpdateSchema = {
11913
11929
  */
11914
11930
  timezone?: string;
11915
11931
  /**
11916
- * Specifies whether all users of this site need to authenticate using two-factor authentication
11932
+ * Specifies whether all users of this site need to authenticate using two-factor authentication.
11917
11933
  */
11918
11934
  require_2fa?: boolean;
11919
11935
  /**
11920
- * Specifies whether you want IPs to be tracked in the Project usages section
11936
+ * Specifies whether you want IPs to be tracked in the Project usages section.
11921
11937
  */
11922
11938
  ip_tracking_enabled?: boolean;
11923
11939
  /**
@@ -19,7 +19,7 @@ export default class ItemVersion extends BaseResource {
19
19
  item_type: ApiTypes.ItemTypeData<import("../../index.js").ItemTypeDefinition<{
20
20
  locales: string;
21
21
  }, string, {}>>;
22
- creator?: ApiTypes.UserData | ApiTypes.AccessTokenData | ApiTypes.AccountData | ApiTypes.SsoUserData | ApiTypes.OrganizationData | undefined;
22
+ creator?: ApiTypes.AccountData | ApiTypes.AccessTokenData | ApiTypes.UserData | ApiTypes.SsoUserData | ApiTypes.OrganizationData | undefined;
23
23
  meta: ApiTypes.ItemMeta;
24
24
  } & Record<string, unknown>, ApiTypes.ItemVersion]>;
25
25
  /**
@@ -1,3 +1,4 @@
1
+ import type * as ApiTypes from '../generated/ApiTypes.js';
1
2
  export type StringMatchesFilter = {
2
3
  /** Pattern to match against */
3
4
  pattern: string;
@@ -242,8 +243,20 @@ export type PositionFilter = {
242
243
  /** Exclude records with an exact match */
243
244
  neq?: number;
244
245
  };
246
+ export type CreatorReference = ApiTypes.AccountData | ApiTypes.AccessTokenData | ApiTypes.UserData | ApiTypes.SsoUserData | ApiTypes.OrganizationData;
247
+ export type CreatorFilter = {
248
+ /** Search records created by the specified creator */
249
+ eq?: CreatorReference;
250
+ /** Exclude records created by the specified creator */
251
+ neq?: CreatorReference;
252
+ /** Search records created by one of the specified creators */
253
+ in?: CreatorReference[];
254
+ /** Search records not created by any of the specified creators */
255
+ notIn?: CreatorReference[];
256
+ };
245
257
  export type ItemMetaFilter = {
246
258
  _created_at?: DateTimeHrefFilter;
259
+ _creator?: CreatorFilter;
247
260
  _first_published_at?: DateTimeHrefFilter;
248
261
  _is_valid?: BooleanHrefFilter;
249
262
  _publication_scheduled_at?: DateTimeHrefFilter;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@datocms/cma-client",
3
- "version": "6.1.3",
3
+ "version": "6.3.0",
4
4
  "description": "JS client for DatoCMS REST Content Management API",
5
5
  "keywords": [
6
6
  "datocms",
@@ -53,7 +53,7 @@
53
53
  "uuid": "^11.1.1"
54
54
  },
55
55
  "devDependencies": {
56
- "@datocms/dashboard-client": "^6.1.0"
56
+ "@datocms/dashboard-client": "^6.3.0"
57
57
  },
58
58
  "gitHead": "ac4164968026ba62a2841d31d2b60c31eadb2cc8"
59
59
  }
package/resources.json CHANGED
@@ -1869,7 +1869,8 @@
1869
1869
  "plugin_type",
1870
1870
  "field_types",
1871
1871
  "parameter_definitions",
1872
- "package_version"
1872
+ "package_version",
1873
+ "enabled"
1873
1874
  ],
1874
1875
  "relationships": []
1875
1876
  },
@@ -1908,9 +1909,11 @@
1908
1909
  "name",
1909
1910
  "description",
1910
1911
  "url",
1912
+ "package_name",
1911
1913
  "parameters",
1912
1914
  "package_version",
1913
- "permissions"
1915
+ "permissions",
1916
+ "enabled"
1914
1917
  ],
1915
1918
  "relationships": []
1916
1919
  },
@@ -7273,6 +7273,10 @@ export type Plugin = {
7273
7273
  global: unknown[];
7274
7274
  instance: unknown[];
7275
7275
  };
7276
+ /**
7277
+ * Whether the plugin is enabled or not. When disabled, the plugin behaves as if it didn't exist: fields using it as editor/addon fall back to the default editor, and any sidebar panel/page/config screen/asset source it registers does not render.
7278
+ */
7279
+ enabled: boolean;
7276
7280
  meta: PluginMeta;
7277
7281
  };
7278
7282
  export type PluginCreateTargetSchema = Plugin;
@@ -7374,6 +7378,10 @@ export type PluginAttributes = {
7374
7378
  global: unknown[];
7375
7379
  instance: unknown[];
7376
7380
  };
7381
+ /**
7382
+ * Whether the plugin is enabled or not. When disabled, the plugin behaves as if it didn't exist: fields using it as editor/addon fall back to the default editor, and any sidebar panel/page/config screen/asset source it registers does not render.
7383
+ */
7384
+ enabled: boolean;
7377
7385
  };
7378
7386
  /**
7379
7387
  * This interface was referenced by `Plugin`'s JSON-Schema
@@ -7440,6 +7448,10 @@ export type PluginCreateSchema = {
7440
7448
  * NPM version of the plugin
7441
7449
  */
7442
7450
  package_version?: null | string;
7451
+ /**
7452
+ * Whether the plugin is enabled or not. Defaults to `true`.
7453
+ */
7454
+ enabled?: boolean;
7443
7455
  };
7444
7456
  /**
7445
7457
  * This interface was referenced by `Plugin`'s JSON-Schema
@@ -7460,6 +7472,10 @@ export type PluginUpdateSchema = {
7460
7472
  * The entry point URL of the plugin
7461
7473
  */
7462
7474
  url?: string;
7475
+ /**
7476
+ * Turns a private plugin into a Marketplace plugin, installing the specified package from the DatoCMS Marketplace. Only accepted for private, non-legacy plugins, and cannot be combined with other attributes (except `enabled`). Name, description, URL, version and permissions are replaced with the ones published in the Marketplace, while the existing `parameters` are preserved.
7477
+ */
7478
+ package_name?: string;
7463
7479
  /**
7464
7480
  * Global plugin configuration. Plugins can persist whatever information they want in this object to reuse it later. Refer to the CMA for details about technical limits.
7465
7481
  */
@@ -7474,6 +7490,10 @@ export type PluginUpdateSchema = {
7474
7490
  * Permissions granted to this plugin
7475
7491
  */
7476
7492
  permissions?: 'currentUserAccessToken'[];
7493
+ /**
7494
+ * Whether the plugin is enabled or not. When disabled, the plugin behaves as if it didn't exist: fields using it as editor/addon fall back to the default editor, and any sidebar panel/page/config screen/asset source it registers does not render.
7495
+ */
7496
+ enabled?: boolean;
7477
7497
  meta?: {
7478
7498
  [k: string]: unknown;
7479
7499
  };
@@ -11738,7 +11758,7 @@ export type Site = {
11738
11758
  */
11739
11759
  domain: string | null;
11740
11760
  /**
11741
- * Google API Key to be used by the LatLon widget
11761
+ * Google API Key to be used by the LatLon field editor. Only the DatoCMS interface uses it: it returns `null` for any other caller.
11742
11762
  */
11743
11763
  google_maps_api_token: string | null;
11744
11764
  /**
@@ -11746,7 +11766,7 @@ export type Site = {
11746
11766
  */
11747
11767
  imgix_host: string | null;
11748
11768
  /**
11749
- * DatoCMS internal domain for the administrative area
11769
+ * DatoCMS internal domain for the administrative area. Returns `null` if the credentials you are using cannot change the project's settings.
11750
11770
  */
11751
11771
  internal_domain: string | null;
11752
11772
  /**
@@ -11770,13 +11790,13 @@ export type Site = {
11770
11790
  */
11771
11791
  last_data_change_at: null | string;
11772
11792
  /**
11773
- * Specifies whether all users of this site need to authenticate using two-factor authentication
11793
+ * Specifies whether all users of this site need to authenticate using two-factor authentication. Returns `null` if the credentials you are using cannot change the project's settings.
11774
11794
  */
11775
- require_2fa: boolean;
11795
+ require_2fa: boolean | null;
11776
11796
  /**
11777
- * Specifies whether you want IPs to be tracked in the Project usages section
11797
+ * Specifies whether you want IPs to be tracked in the Project usages section. Returns `null` if the credentials you are using cannot change the project's settings.
11778
11798
  */
11779
- ip_tracking_enabled: boolean;
11799
+ ip_tracking_enabled: boolean | null;
11780
11800
  /**
11781
11801
  * If enabled, blocks schema changes of primary environment
11782
11802
  */
@@ -12085,7 +12105,7 @@ export type SiteAttributes = {
12085
12105
  */
12086
12106
  domain: string | null;
12087
12107
  /**
12088
- * Google API Key to be used by the LatLon widget
12108
+ * Google API Key to be used by the LatLon field editor. Only the DatoCMS interface uses it: it returns `null` for any other caller.
12089
12109
  */
12090
12110
  google_maps_api_token: string | null;
12091
12111
  /**
@@ -12093,7 +12113,7 @@ export type SiteAttributes = {
12093
12113
  */
12094
12114
  imgix_host: string | null;
12095
12115
  /**
12096
- * DatoCMS internal domain for the administrative area
12116
+ * DatoCMS internal domain for the administrative area. Returns `null` if the credentials you are using cannot change the project's settings.
12097
12117
  */
12098
12118
  internal_domain: string | null;
12099
12119
  /**
@@ -12117,13 +12137,13 @@ export type SiteAttributes = {
12117
12137
  */
12118
12138
  last_data_change_at: null | string;
12119
12139
  /**
12120
- * Specifies whether all users of this site need to authenticate using two-factor authentication
12140
+ * Specifies whether all users of this site need to authenticate using two-factor authentication. Returns `null` if the credentials you are using cannot change the project's settings.
12121
12141
  */
12122
- require_2fa: boolean;
12142
+ require_2fa: boolean | null;
12123
12143
  /**
12124
- * Specifies whether you want IPs to be tracked in the Project usages section
12144
+ * Specifies whether you want IPs to be tracked in the Project usages section. Returns `null` if the credentials you are using cannot change the project's settings.
12125
12145
  */
12126
- ip_tracking_enabled: boolean;
12146
+ ip_tracking_enabled: boolean | null;
12127
12147
  /**
12128
12148
  * If enabled, blocks schema changes of primary environment
12129
12149
  */
@@ -12509,11 +12529,11 @@ export type SiteUpdateSchema = {
12509
12529
  */
12510
12530
  timezone?: string;
12511
12531
  /**
12512
- * Specifies whether all users of this site need to authenticate using two-factor authentication
12532
+ * Specifies whether all users of this site need to authenticate using two-factor authentication.
12513
12533
  */
12514
12534
  require_2fa?: boolean;
12515
12535
  /**
12516
- * Specifies whether you want IPs to be tracked in the Project usages section
12536
+ * Specifies whether you want IPs to be tracked in the Project usages section.
12517
12537
  */
12518
12538
  ip_tracking_enabled?: boolean;
12519
12539
  /**
@@ -151,7 +151,7 @@ export class Client {
151
151
  ...this.config,
152
152
  ...options,
153
153
  logFn: this.config.logFn || console.log,
154
- userAgent: '@datocms/cma-client v6.1.3',
154
+ userAgent: '@datocms/cma-client v6.3.0',
155
155
  baseUrl: this.baseUrl,
156
156
  preCallStack: new Error().stack,
157
157
  extraHeaders: {
@@ -6997,6 +6997,10 @@ export type PluginAttributes = {
6997
6997
  global: unknown[];
6998
6998
  instance: unknown[];
6999
6999
  };
7000
+ /**
7001
+ * Whether the plugin is enabled or not. When disabled, the plugin behaves as if it didn't exist: fields using it as editor/addon fall back to the default editor, and any sidebar panel/page/config screen/asset source it registers does not render.
7002
+ */
7003
+ enabled: boolean;
7000
7004
  };
7001
7005
  /**
7002
7006
  * JSON API meta
@@ -7087,6 +7091,10 @@ export type PluginCreateSchema = {
7087
7091
  * NPM version of the plugin
7088
7092
  */
7089
7093
  package_version?: null | string;
7094
+ /**
7095
+ * Whether the plugin is enabled or not. Defaults to `true`.
7096
+ */
7097
+ enabled?: boolean;
7090
7098
  };
7091
7099
  };
7092
7100
  };
@@ -7118,6 +7126,10 @@ export type PluginUpdateSchema = {
7118
7126
  * The entry point URL of the plugin
7119
7127
  */
7120
7128
  url?: string;
7129
+ /**
7130
+ * Turns a private plugin into a Marketplace plugin, installing the specified package from the DatoCMS Marketplace. Only accepted for private, non-legacy plugins, and cannot be combined with other attributes (except `enabled`). Name, description, URL, version and permissions are replaced with the ones published in the Marketplace, while the existing `parameters` are preserved.
7131
+ */
7132
+ package_name?: string;
7121
7133
  /**
7122
7134
  * Global plugin configuration. Plugins can persist whatever information they want in this object to reuse it later. Refer to the CMA for details about technical limits.
7123
7135
  */
@@ -7132,6 +7144,10 @@ export type PluginUpdateSchema = {
7132
7144
  * Permissions granted to this plugin
7133
7145
  */
7134
7146
  permissions?: 'currentUserAccessToken'[];
7147
+ /**
7148
+ * Whether the plugin is enabled or not. When disabled, the plugin behaves as if it didn't exist: fields using it as editor/addon fall back to the default editor, and any sidebar panel/page/config screen/asset source it registers does not render.
7149
+ */
7150
+ enabled?: boolean;
7135
7151
  };
7136
7152
  meta?: {
7137
7153
  [k: string]: unknown;
@@ -12013,7 +12029,7 @@ export type SiteAttributes = {
12013
12029
  */
12014
12030
  domain: string | null;
12015
12031
  /**
12016
- * Google API Key to be used by the LatLon widget
12032
+ * Google API Key to be used by the LatLon field editor. Only the DatoCMS interface uses it: it returns `null` for any other caller.
12017
12033
  */
12018
12034
  google_maps_api_token: string | null;
12019
12035
  /**
@@ -12021,7 +12037,7 @@ export type SiteAttributes = {
12021
12037
  */
12022
12038
  imgix_host: string | null;
12023
12039
  /**
12024
- * DatoCMS internal domain for the administrative area
12040
+ * DatoCMS internal domain for the administrative area. Returns `null` if the credentials you are using cannot change the project's settings.
12025
12041
  */
12026
12042
  internal_domain: string | null;
12027
12043
  /**
@@ -12045,13 +12061,13 @@ export type SiteAttributes = {
12045
12061
  */
12046
12062
  last_data_change_at: null | string;
12047
12063
  /**
12048
- * Specifies whether all users of this site need to authenticate using two-factor authentication
12064
+ * Specifies whether all users of this site need to authenticate using two-factor authentication. Returns `null` if the credentials you are using cannot change the project's settings.
12049
12065
  */
12050
- require_2fa: boolean;
12066
+ require_2fa: boolean | null;
12051
12067
  /**
12052
- * Specifies whether you want IPs to be tracked in the Project usages section
12068
+ * Specifies whether you want IPs to be tracked in the Project usages section. Returns `null` if the credentials you are using cannot change the project's settings.
12053
12069
  */
12054
- ip_tracking_enabled: boolean;
12070
+ ip_tracking_enabled: boolean | null;
12055
12071
  /**
12056
12072
  * If enabled, blocks schema changes of primary environment
12057
12073
  */
@@ -12527,11 +12543,11 @@ export type SiteUpdateSchema = {
12527
12543
  */
12528
12544
  timezone?: string;
12529
12545
  /**
12530
- * Specifies whether all users of this site need to authenticate using two-factor authentication
12546
+ * Specifies whether all users of this site need to authenticate using two-factor authentication.
12531
12547
  */
12532
12548
  require_2fa?: boolean;
12533
12549
  /**
12534
- * Specifies whether you want IPs to be tracked in the Project usages section
12550
+ * Specifies whether you want IPs to be tracked in the Project usages section.
12535
12551
  */
12536
12552
  ip_tracking_enabled?: boolean;
12537
12553
  /**
@@ -28,6 +28,7 @@ export default class Plugin extends BaseResource {
28
28
  'field_types',
29
29
  'parameter_definitions',
30
30
  'package_version',
31
+ 'enabled',
31
32
  ],
32
33
  relationships: [],
33
34
  }),
@@ -75,9 +76,11 @@ export default class Plugin extends BaseResource {
75
76
  'name',
76
77
  'description',
77
78
  'url',
79
+ 'package_name',
78
80
  'parameters',
79
81
  'package_version',
80
82
  'permissions',
83
+ 'enabled',
81
84
  ],
82
85
  relationships: [],
83
86
  }),
@@ -1,3 +1,5 @@
1
+ import type * as ApiTypes from '../generated/ApiTypes.js';
2
+
1
3
  // String matching filter for text-based filters
2
4
  export type StringMatchesFilter = {
3
5
  /** Pattern to match against */
@@ -275,8 +277,29 @@ export type PositionFilter = {
275
277
  neq?: number;
276
278
  };
277
279
 
280
+ // Polymorphic reference to whoever created a record, same shape as `Item['creator']`
281
+ export type CreatorReference =
282
+ | ApiTypes.AccountData
283
+ | ApiTypes.AccessTokenData
284
+ | ApiTypes.UserData
285
+ | ApiTypes.SsoUserData
286
+ | ApiTypes.OrganizationData;
287
+
288
+ // Creator filter for the _creator meta field
289
+ export type CreatorFilter = {
290
+ /** Search records created by the specified creator */
291
+ eq?: CreatorReference;
292
+ /** Exclude records created by the specified creator */
293
+ neq?: CreatorReference;
294
+ /** Search records created by one of the specified creators */
295
+ in?: CreatorReference[];
296
+ /** Search records not created by any of the specified creators */
297
+ notIn?: CreatorReference[];
298
+ };
299
+
278
300
  export type ItemMetaFilter = {
279
301
  _created_at?: DateTimeHrefFilter;
302
+ _creator?: CreatorFilter;
280
303
  _first_published_at?: DateTimeHrefFilter;
281
304
  _is_valid?: BooleanHrefFilter;
282
305
  _publication_scheduled_at?: DateTimeHrefFilter;