@datocms/cma-client 3.1.6 → 3.1.7-alpha.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.
@@ -1201,6 +1201,21 @@ export type DailyUsageType = 'daily_usage';
1201
1201
  * via the `definition` "id".
1202
1202
  */
1203
1203
  export type DailyUsageIdentity = string;
1204
+ /**
1205
+ * This interface was referenced by `Site`'s JSON-Schema
1206
+ * via the `definition` "type".
1207
+ */
1208
+ export type SiteType = 'site';
1209
+ /**
1210
+ * ID of site
1211
+ *
1212
+ * This interface was referenced by `Site`'s JSON-Schema
1213
+ * via the `definition` "identity".
1214
+ *
1215
+ * This interface was referenced by `Site`'s JSON-Schema
1216
+ * via the `definition` "id".
1217
+ */
1218
+ export type SiteIdentity = string;
1204
1219
  /**
1205
1220
  * This interface was referenced by `UsageCounter`'s JSON-Schema
1206
1221
  * via the `definition` "type".
@@ -1337,21 +1352,6 @@ export type UploadSmartTagInstancesHrefSchema = {
1337
1352
  };
1338
1353
  [k: string]: unknown;
1339
1354
  };
1340
- /**
1341
- * This interface was referenced by `Site`'s JSON-Schema
1342
- * via the `definition` "type".
1343
- */
1344
- export type SiteType = 'site';
1345
- /**
1346
- * ID of site
1347
- *
1348
- * This interface was referenced by `Site`'s JSON-Schema
1349
- * via the `definition` "identity".
1350
- *
1351
- * This interface was referenced by `Site`'s JSON-Schema
1352
- * via the `definition` "id".
1353
- */
1354
- export type SiteIdentity = string;
1355
1355
  /**
1356
1356
  * This interface was referenced by `Site`'s JSON-Schema
1357
1357
  * via the `self.hrefSchema` link.
@@ -8922,49 +8922,49 @@ export type BuildTrigger = {
8922
8922
  */
8923
8923
  export type BuildTriggerAttributes = {
8924
8924
  /**
8925
- * Name of the build trigger
8925
+ * Name of the environment
8926
8926
  */
8927
8927
  name: string;
8928
8928
  /**
8929
- * The type of build trigger
8929
+ * The deploy adapter
8930
8930
  */
8931
- adapter: 'custom' | 'netlify' | 'vercel' | 'circle_ci' | 'gitlab' | 'travis';
8931
+ adapter: string;
8932
8932
  /**
8933
- * Additional settings for the build trigger. The value depends on the `adapter`.
8933
+ * Additional configuration for deploy
8934
8934
  */
8935
8935
  adapter_settings: {
8936
8936
  [k: string]: unknown;
8937
8937
  };
8938
8938
  /**
8939
- * Timestamp of the last build
8939
+ * Timestamp of the last deploy
8940
8940
  */
8941
8941
  last_build_completed_at: string | null;
8942
8942
  /**
8943
- * Status of last build
8943
+ * Status of last deploy
8944
8944
  */
8945
8945
  build_status: string;
8946
8946
  /**
8947
- * Unique token for the webhook (it's the same token present in `webhook_url`)
8947
+ * Unique token of the webhook
8948
8948
  */
8949
8949
  webhook_token?: string;
8950
8950
  /**
8951
- * The URL of the webhook your service has to call when the build completes to report it's status (success or error)
8951
+ * Notification webhook URL
8952
8952
  */
8953
8953
  webhook_url: string;
8954
8954
  /**
8955
- * Status of Site Search for the frontend
8955
+ * Status of site scraper
8956
8956
  */
8957
8957
  indexing_status: string;
8958
8958
  /**
8959
- * 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
8959
+ * Public url of the site
8960
8960
  */
8961
8961
  frontend_url: string | null;
8962
8962
  /**
8963
- * Wheter an automatic build request to `webhook_url` should be made on scheduled publications/unpublishings
8963
+ * Deploy on scheduled publication
8964
8964
  */
8965
8965
  autotrigger_on_scheduled_publications: boolean;
8966
8966
  /**
8967
- * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
8967
+ * Enable scraper on the site
8968
8968
  */
8969
8969
  indexing_enabled: boolean;
8970
8970
  };
@@ -8994,37 +8994,31 @@ export type BuildTriggerCreateSchema = {
8994
8994
  type: BuildTriggerType;
8995
8995
  attributes: {
8996
8996
  /**
8997
- * Name of the build trigger
8997
+ * Name of the environment
8998
8998
  */
8999
8999
  name: string;
9000
9000
  /**
9001
- * Unique token for the webhook (it's the same token present in `webhook_url`)
9001
+ * Unique token of the webhook
9002
9002
  */
9003
9003
  webhook_token?: string;
9004
9004
  /**
9005
- * The type of build trigger
9005
+ * The deploy adapter
9006
9006
  */
9007
- adapter:
9008
- | 'custom'
9009
- | 'netlify'
9010
- | 'vercel'
9011
- | 'circle_ci'
9012
- | 'gitlab'
9013
- | 'travis';
9007
+ adapter: string;
9014
9008
  /**
9015
- * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
9009
+ * Enable scraper on the site
9016
9010
  */
9017
9011
  indexing_enabled: boolean;
9018
9012
  /**
9019
- * 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
9013
+ * Public url of the site
9020
9014
  */
9021
9015
  frontend_url: string | null;
9022
9016
  /**
9023
- * Wheter an automatic build request to `webhook_url` should be made on scheduled publications/unpublishings
9017
+ * Deploy on scheduled publication
9024
9018
  */
9025
9019
  autotrigger_on_scheduled_publications: boolean;
9026
9020
  /**
9027
- * Additional settings for the build trigger. The value depends on the `adapter`.
9021
+ * Additional configuration for deploy
9028
9022
  */
9029
9023
  adapter_settings: {
9030
9024
  [k: string]: unknown;
@@ -9051,33 +9045,27 @@ export type BuildTriggerUpdateSchema = {
9051
9045
  id: BuildTriggerIdentity;
9052
9046
  attributes: {
9053
9047
  /**
9054
- * Name of the build trigger
9048
+ * Name of the environment
9055
9049
  */
9056
9050
  name?: string;
9057
9051
  /**
9058
- * The type of build trigger
9052
+ * The deploy adapter
9059
9053
  */
9060
- adapter?:
9061
- | 'custom'
9062
- | 'netlify'
9063
- | 'vercel'
9064
- | 'circle_ci'
9065
- | 'gitlab'
9066
- | 'travis';
9054
+ adapter?: string;
9067
9055
  /**
9068
- * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
9056
+ * Enable scraper on the site
9069
9057
  */
9070
9058
  indexing_enabled?: boolean;
9071
9059
  /**
9072
- * 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
9060
+ * Public url of the site
9073
9061
  */
9074
9062
  frontend_url?: string | null;
9075
9063
  /**
9076
- * Wheter an automatic build request to `webhook_url` should be made on scheduled publications/unpublishings
9064
+ * Deploy on scheduled publication
9077
9065
  */
9078
9066
  autotrigger_on_scheduled_publications?: boolean;
9079
9067
  /**
9080
- * Additional settings for the build trigger. The value depends on the `adapter`.
9068
+ * Additional configuration for deploy
9081
9069
  */
9082
9070
  adapter_settings?: {
9083
9071
  [k: string]: unknown;
@@ -10337,6 +10325,7 @@ export type DailyUsage = {
10337
10325
  type: DailyUsageType;
10338
10326
  id: DailyUsageIdentity;
10339
10327
  attributes: DailyUsageAttributes;
10328
+ relationships?: DailyUsageRelationships;
10340
10329
  };
10341
10330
 
10342
10331
  /**
@@ -10362,6 +10351,10 @@ export type DailyUsageAttributes = {
10362
10351
  * Content delivery API traffic
10363
10352
  */
10364
10353
  cda_traffic_bytes: number;
10354
+ /**
10355
+ * Content management API traffic
10356
+ */
10357
+ cma_traffic_bytes: number;
10365
10358
  /**
10366
10359
  * Uploads requests traffic
10367
10360
  */
@@ -10370,6 +10363,36 @@ export type DailyUsageAttributes = {
10370
10363
  * Video streaming seconds
10371
10364
  */
10372
10365
  mux_delivered_seconds: number;
10366
+ /**
10367
+ * Video encoding seconds
10368
+ */
10369
+ mux_encoded_seconds: number;
10370
+ };
10371
+
10372
+ /**
10373
+ * JSON API links
10374
+ *
10375
+ * This interface was referenced by `DailyUsage`'s JSON-Schema
10376
+ * via the `definition` "relationships".
10377
+ */
10378
+ export type DailyUsageRelationships = {
10379
+ /**
10380
+ * Site that generate the usage
10381
+ */
10382
+ site?: {
10383
+ data: SiteData;
10384
+ };
10385
+ };
10386
+
10387
+ /**
10388
+ * JSON API data
10389
+ *
10390
+ * This interface was referenced by `Site`'s JSON-Schema
10391
+ * via the `definition` "data".
10392
+ */
10393
+ export type SiteData = {
10394
+ type: SiteType;
10395
+ id: SiteIdentity;
10373
10396
  };
10374
10397
 
10375
10398
  /**
@@ -10795,17 +10818,6 @@ export type SiteMeta = {
10795
10818
  custom_upload_storage_settings?: boolean;
10796
10819
  };
10797
10820
 
10798
- /**
10799
- * JSON API data
10800
- *
10801
- * This interface was referenced by `Site`'s JSON-Schema
10802
- * via the `definition` "data".
10803
- */
10804
- export type SiteData = {
10805
- type: SiteType;
10806
- id: SiteIdentity;
10807
- };
10808
-
10809
10821
  /**
10810
10822
  * This interface was referenced by `Site`'s JSON-Schema
10811
10823
  * via the `self.targetSchema` link.
@@ -1476,6 +1476,21 @@ export type DailyUsageIdentity = string;
1476
1476
  * via the `definition` "type".
1477
1477
  */
1478
1478
  export type DailyUsageType = 'daily_usage';
1479
+ /**
1480
+ * This interface was referenced by `Site`'s JSON-Schema
1481
+ * via the `definition` "type".
1482
+ */
1483
+ export type SiteType = 'site';
1484
+ /**
1485
+ * ID of site
1486
+ *
1487
+ * This interface was referenced by `Site`'s JSON-Schema
1488
+ * via the `definition` "identity".
1489
+ *
1490
+ * This interface was referenced by `Site`'s JSON-Schema
1491
+ * via the `definition` "id".
1492
+ */
1493
+ export type SiteIdentity = string;
1479
1494
  /**
1480
1495
  * This interface was referenced by `DailyUsage`'s JSON-Schema
1481
1496
  * via the `instances.targetSchema` link.
@@ -1627,21 +1642,6 @@ export type UploadSmartTagInstancesHrefSchema = {
1627
1642
  };
1628
1643
  [k: string]: unknown;
1629
1644
  };
1630
- /**
1631
- * ID of site
1632
- *
1633
- * This interface was referenced by `Site`'s JSON-Schema
1634
- * via the `definition` "identity".
1635
- *
1636
- * This interface was referenced by `Site`'s JSON-Schema
1637
- * via the `definition` "id".
1638
- */
1639
- export type SiteIdentity = string;
1640
- /**
1641
- * This interface was referenced by `Site`'s JSON-Schema
1642
- * via the `definition` "type".
1643
- */
1644
- export type SiteType = 'site';
1645
1645
  /**
1646
1646
  * This interface was referenced by `Site`'s JSON-Schema
1647
1647
  * via the `self.hrefSchema` link.
@@ -8787,49 +8787,49 @@ export type BuildTrigger = {
8787
8787
  id: BuildTriggerIdentity;
8788
8788
  type: BuildTriggerType;
8789
8789
  /**
8790
- * Name of the build trigger
8790
+ * Name of the environment
8791
8791
  */
8792
8792
  name: string;
8793
8793
  /**
8794
- * The type of build trigger
8794
+ * The deploy adapter
8795
8795
  */
8796
- adapter: 'custom' | 'netlify' | 'vercel' | 'circle_ci' | 'gitlab' | 'travis';
8796
+ adapter: string;
8797
8797
  /**
8798
- * Additional settings for the build trigger. The value depends on the `adapter`.
8798
+ * Additional configuration for deploy
8799
8799
  */
8800
8800
  adapter_settings: {
8801
8801
  [k: string]: unknown;
8802
8802
  };
8803
8803
  /**
8804
- * Timestamp of the last build
8804
+ * Timestamp of the last deploy
8805
8805
  */
8806
8806
  last_build_completed_at: string | null;
8807
8807
  /**
8808
- * Status of last build
8808
+ * Status of last deploy
8809
8809
  */
8810
8810
  build_status: string;
8811
8811
  /**
8812
- * Unique token for the webhook (it's the same token present in `webhook_url`)
8812
+ * Unique token of the webhook
8813
8813
  */
8814
8814
  webhook_token?: string;
8815
8815
  /**
8816
- * The URL of the webhook your service has to call when the build completes to report it's status (success or error)
8816
+ * Notification webhook URL
8817
8817
  */
8818
8818
  webhook_url: string;
8819
8819
  /**
8820
- * Status of Site Search for the frontend
8820
+ * Status of site scraper
8821
8821
  */
8822
8822
  indexing_status: string;
8823
8823
  /**
8824
- * 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
8824
+ * Public url of the site
8825
8825
  */
8826
8826
  frontend_url: string | null;
8827
8827
  /**
8828
- * Wheter an automatic build request to `webhook_url` should be made on scheduled publications/unpublishings
8828
+ * Deploy on scheduled publication
8829
8829
  */
8830
8830
  autotrigger_on_scheduled_publications: boolean;
8831
8831
  /**
8832
- * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
8832
+ * Enable scraper on the site
8833
8833
  */
8834
8834
  indexing_enabled: boolean;
8835
8835
  };
@@ -8845,49 +8845,49 @@ export type BuildTriggerDestroyTargetSchema = BuildTrigger;
8845
8845
  */
8846
8846
  export type BuildTriggerAttributes = {
8847
8847
  /**
8848
- * Name of the build trigger
8848
+ * Name of the environment
8849
8849
  */
8850
8850
  name: string;
8851
8851
  /**
8852
- * The type of build trigger
8852
+ * The deploy adapter
8853
8853
  */
8854
- adapter: 'custom' | 'netlify' | 'vercel' | 'circle_ci' | 'gitlab' | 'travis';
8854
+ adapter: string;
8855
8855
  /**
8856
- * Additional settings for the build trigger. The value depends on the `adapter`.
8856
+ * Additional configuration for deploy
8857
8857
  */
8858
8858
  adapter_settings: {
8859
8859
  [k: string]: unknown;
8860
8860
  };
8861
8861
  /**
8862
- * Timestamp of the last build
8862
+ * Timestamp of the last deploy
8863
8863
  */
8864
8864
  last_build_completed_at: string | null;
8865
8865
  /**
8866
- * Status of last build
8866
+ * Status of last deploy
8867
8867
  */
8868
8868
  build_status: string;
8869
8869
  /**
8870
- * Unique token for the webhook (it's the same token present in `webhook_url`)
8870
+ * Unique token of the webhook
8871
8871
  */
8872
8872
  webhook_token?: string;
8873
8873
  /**
8874
- * The URL of the webhook your service has to call when the build completes to report it's status (success or error)
8874
+ * Notification webhook URL
8875
8875
  */
8876
8876
  webhook_url: string;
8877
8877
  /**
8878
- * Status of Site Search for the frontend
8878
+ * Status of site scraper
8879
8879
  */
8880
8880
  indexing_status: string;
8881
8881
  /**
8882
- * 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
8882
+ * Public url of the site
8883
8883
  */
8884
8884
  frontend_url: string | null;
8885
8885
  /**
8886
- * Wheter an automatic build request to `webhook_url` should be made on scheduled publications/unpublishings
8886
+ * Deploy on scheduled publication
8887
8887
  */
8888
8888
  autotrigger_on_scheduled_publications: boolean;
8889
8889
  /**
8890
- * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
8890
+ * Enable scraper on the site
8891
8891
  */
8892
8892
  indexing_enabled: boolean;
8893
8893
  };
@@ -8899,31 +8899,31 @@ export type BuildTriggerAttributes = {
8899
8899
  export type BuildTriggerCreateSchema = {
8900
8900
  type?: BuildTriggerType;
8901
8901
  /**
8902
- * Name of the build trigger
8902
+ * Name of the environment
8903
8903
  */
8904
8904
  name: string;
8905
8905
  /**
8906
- * Unique token for the webhook (it's the same token present in `webhook_url`)
8906
+ * Unique token of the webhook
8907
8907
  */
8908
8908
  webhook_token?: string;
8909
8909
  /**
8910
- * The type of build trigger
8910
+ * The deploy adapter
8911
8911
  */
8912
- adapter: 'custom' | 'netlify' | 'vercel' | 'circle_ci' | 'gitlab' | 'travis';
8912
+ adapter: string;
8913
8913
  /**
8914
- * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
8914
+ * Enable scraper on the site
8915
8915
  */
8916
8916
  indexing_enabled: boolean;
8917
8917
  /**
8918
- * 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
8918
+ * Public url of the site
8919
8919
  */
8920
8920
  frontend_url: string | null;
8921
8921
  /**
8922
- * Wheter an automatic build request to `webhook_url` should be made on scheduled publications/unpublishings
8922
+ * Deploy on scheduled publication
8923
8923
  */
8924
8924
  autotrigger_on_scheduled_publications: boolean;
8925
8925
  /**
8926
- * Additional settings for the build trigger. The value depends on the `adapter`.
8926
+ * Additional configuration for deploy
8927
8927
  */
8928
8928
  adapter_settings: {
8929
8929
  [k: string]: unknown;
@@ -8938,27 +8938,27 @@ export type BuildTriggerUpdateSchema = {
8938
8938
  id?: BuildTriggerIdentity;
8939
8939
  type?: BuildTriggerType;
8940
8940
  /**
8941
- * Name of the build trigger
8941
+ * Name of the environment
8942
8942
  */
8943
8943
  name?: string;
8944
8944
  /**
8945
- * The type of build trigger
8945
+ * The deploy adapter
8946
8946
  */
8947
- adapter?: 'custom' | 'netlify' | 'vercel' | 'circle_ci' | 'gitlab' | 'travis';
8947
+ adapter?: string;
8948
8948
  /**
8949
- * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
8949
+ * Enable scraper on the site
8950
8950
  */
8951
8951
  indexing_enabled?: boolean;
8952
8952
  /**
8953
- * 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
8953
+ * Public url of the site
8954
8954
  */
8955
8955
  frontend_url?: string | null;
8956
8956
  /**
8957
- * Wheter an automatic build request to `webhook_url` should be made on scheduled publications/unpublishings
8957
+ * Deploy on scheduled publication
8958
8958
  */
8959
8959
  autotrigger_on_scheduled_publications?: boolean;
8960
8960
  /**
8961
- * Additional settings for the build trigger. The value depends on the `adapter`.
8961
+ * Additional configuration for deploy
8962
8962
  */
8963
8963
  adapter_settings?: {
8964
8964
  [k: string]: unknown;
@@ -9983,6 +9983,10 @@ export type DailyUsage = {
9983
9983
  * Content delivery API traffic
9984
9984
  */
9985
9985
  cda_traffic_bytes: number;
9986
+ /**
9987
+ * Content management API traffic
9988
+ */
9989
+ cma_traffic_bytes: number;
9986
9990
  /**
9987
9991
  * Uploads requests traffic
9988
9992
  */
@@ -9991,6 +9995,22 @@ export type DailyUsage = {
9991
9995
  * Video streaming seconds
9992
9996
  */
9993
9997
  mux_delivered_seconds: number;
9998
+ /**
9999
+ * Video encoding seconds
10000
+ */
10001
+ mux_encoded_seconds: number;
10002
+ site?: SiteData;
10003
+ };
10004
+
10005
+ /**
10006
+ * JSON API data
10007
+ *
10008
+ * This interface was referenced by `Site`'s JSON-Schema
10009
+ * via the `definition` "data".
10010
+ */
10011
+ export type SiteData = {
10012
+ type: SiteType;
10013
+ id: SiteIdentity;
9994
10014
  };
9995
10015
 
9996
10016
  /**
@@ -10027,6 +10047,10 @@ export type DailyUsageAttributes = {
10027
10047
  * Content delivery API traffic
10028
10048
  */
10029
10049
  cda_traffic_bytes: number;
10050
+ /**
10051
+ * Content management API traffic
10052
+ */
10053
+ cma_traffic_bytes: number;
10030
10054
  /**
10031
10055
  * Uploads requests traffic
10032
10056
  */
@@ -10035,6 +10059,20 @@ export type DailyUsageAttributes = {
10035
10059
  * Video streaming seconds
10036
10060
  */
10037
10061
  mux_delivered_seconds: number;
10062
+ /**
10063
+ * Video encoding seconds
10064
+ */
10065
+ mux_encoded_seconds: number;
10066
+ };
10067
+
10068
+ /**
10069
+ * JSON API links
10070
+ *
10071
+ * This interface was referenced by `DailyUsage`'s JSON-Schema
10072
+ * via the `definition` "relationships".
10073
+ */
10074
+ export type DailyUsageRelationships = {
10075
+ site?: SiteData;
10038
10076
  };
10039
10077
 
10040
10078
  /**
@@ -10395,17 +10433,6 @@ export type SiteMeta = {
10395
10433
  custom_upload_storage_settings?: boolean;
10396
10434
  };
10397
10435
 
10398
- /**
10399
- * JSON API data
10400
- *
10401
- * This interface was referenced by `Site`'s JSON-Schema
10402
- * via the `definition` "data".
10403
- */
10404
- export type SiteData = {
10405
- type: SiteType;
10406
- id: SiteIdentity;
10407
- };
10408
-
10409
10436
  /**
10410
10437
  * JSON API attributes
10411
10438
  *