@datocms/cma-client 0.1.4 → 0.1.8

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 (36) hide show
  1. package/dist/cjs/generated/Client.js +1 -1
  2. package/dist/cjs/generated/Client.js.map +1 -1
  3. package/dist/cjs/generated/resources/BuildTrigger.js +40 -2
  4. package/dist/cjs/generated/resources/BuildTrigger.js.map +1 -1
  5. package/dist/cjs/generated/resources/Site.js +21 -0
  6. package/dist/cjs/generated/resources/Site.js.map +1 -1
  7. package/dist/esm/generated/Client.d.ts +1 -0
  8. package/dist/esm/generated/Client.js +1 -1
  9. package/dist/esm/generated/Client.js.map +1 -1
  10. package/dist/esm/generated/SchemaTypes.d.ts +37 -0
  11. package/dist/esm/generated/SimpleSchemaTypes.d.ts +28 -0
  12. package/dist/esm/generated/resources/BuildTrigger.d.ts +26 -2
  13. package/dist/esm/generated/resources/BuildTrigger.js +40 -2
  14. package/dist/esm/generated/resources/BuildTrigger.js.map +1 -1
  15. package/dist/esm/generated/resources/Site.d.ts +12 -0
  16. package/dist/esm/generated/resources/Site.js +21 -0
  17. package/dist/esm/generated/resources/Site.js.map +1 -1
  18. package/dist/types/generated/Client.d.ts +1 -0
  19. package/dist/types/generated/SchemaTypes.d.ts +37 -0
  20. package/dist/types/generated/SimpleSchemaTypes.d.ts +28 -0
  21. package/dist/types/generated/resources/BuildTrigger.d.ts +26 -2
  22. package/dist/types/generated/resources/Site.d.ts +12 -0
  23. package/package.json +6 -5
  24. package/resources.json +1272 -0
  25. package/src/generated/Client.ts +2 -0
  26. package/src/generated/SchemaTypes.ts +40 -0
  27. package/src/generated/SimpleSchemaTypes.ts +29 -0
  28. package/src/generated/resources/BuildTrigger.ts +44 -2
  29. package/src/generated/resources/Site.ts +27 -0
  30. package/dist/cjs/generated/schemaInfo.js +0 -3063
  31. package/dist/cjs/generated/schemaInfo.js.map +0 -1
  32. package/dist/esm/generated/schemaInfo.d.ts +0 -940
  33. package/dist/esm/generated/schemaInfo.js +0 -3061
  34. package/dist/esm/generated/schemaInfo.js.map +0 -1
  35. package/dist/types/generated/schemaInfo.d.ts +0 -940
  36. package/src/generated/schemaInfo.ts +0 -3231
@@ -16,6 +16,7 @@ export type ClientConfigOptions = {
16
16
  environment?: string;
17
17
  extraHeaders?: Record<string, string>;
18
18
  logLevel?: LogLevel;
19
+ logFn?: (message: string) => void;
19
20
  autoRetry?: boolean;
20
21
  };
21
22
 
@@ -122,6 +123,7 @@ export class Client {
122
123
  return request<T>({
123
124
  ...this.config,
124
125
  ...options,
126
+ logFn: this.config.logFn || console.log,
125
127
  userAgent: `@datocms/cma-client`,
126
128
  baseUrl: this.baseUrl,
127
129
  preCallStack: new Error().stack,
@@ -6761,6 +6761,10 @@ export type EnvironmentMeta = {
6761
6761
  * Is this environment the primary for the project?
6762
6762
  */
6763
6763
  primary: boolean;
6764
+ /**
6765
+ * ID of the environment that's been forked to generate this one
6766
+ */
6767
+ forked_from?: string | null;
6764
6768
  };
6765
6769
 
6766
6770
  /**
@@ -8675,6 +8679,7 @@ export type Site = {
8675
8679
  id: SiteIdentity;
8676
8680
  attributes: SiteAttributes;
8677
8681
  relationships: SiteRelationships;
8682
+ meta: SiteMeta;
8678
8683
  };
8679
8684
 
8680
8685
  /**
@@ -8865,6 +8870,19 @@ export type SiteRelationships = {
8865
8870
  };
8866
8871
  };
8867
8872
 
8873
+ /**
8874
+ * Meta attributes
8875
+ *
8876
+ * This interface was referenced by `Site`'s JSON-Schema
8877
+ * via the `definition` "meta".
8878
+ */
8879
+ export type SiteMeta = {
8880
+ /**
8881
+ * Whether the Improved API Timezone Management option is active or not
8882
+ */
8883
+ improved_timezone_management: boolean;
8884
+ };
8885
+
8868
8886
  /**
8869
8887
  * JSON API data
8870
8888
  *
@@ -8996,6 +9014,12 @@ export type SiteUpdateSchema = {
8996
9014
  */
8997
9015
  ip_tracking_enabled?: boolean;
8998
9016
  };
9017
+ meta?: {
9018
+ /**
9019
+ * Whether the Improved API Timezone Management option is active or not
9020
+ */
9021
+ improved_timezone_management?: boolean;
9022
+ };
8999
9023
  relationships?: {
9000
9024
  sso_default_role?: {
9001
9025
  data: RoleData;
@@ -9020,6 +9044,22 @@ export type SiteUpdateJobSchema = {
9020
9044
  data: Site;
9021
9045
  };
9022
9046
 
9047
+ /**
9048
+ * This interface was referenced by `Site`'s JSON-Schema
9049
+ * via the `activate_improved_timezone_management.targetSchema` link.
9050
+ */
9051
+ export type SiteActivateImprovedTimezoneManagementTargetSchema = {
9052
+ data: Job;
9053
+ };
9054
+
9055
+ /**
9056
+ * This interface was referenced by `Site`'s JSON-Schema
9057
+ * via the `activate_improved_timezone_management.jobSchema` link.
9058
+ */
9059
+ export type SiteActivateImprovedTimezoneManagementJobSchema = {
9060
+ data: Site;
9061
+ };
9062
+
9023
9063
  /**
9024
9064
  * Through workflows it is possible to set up a precise state machine able to bring a draft content up to the final publication (and beyond), through a series of intermediate, fully customizable approval steps.
9025
9065
  *
@@ -4223,6 +4223,9 @@ export type ItemTypeUpdateSchema = {
4223
4223
  * This interface was referenced by `Site`'s JSON-Schema
4224
4224
  * via the `update.targetSchema` link.
4225
4225
  *
4226
+ * This interface was referenced by `Site`'s JSON-Schema
4227
+ * via the `activate_improved_timezone_management.targetSchema` link.
4228
+ *
4226
4229
  * This interface was referenced by `DatoApi`'s JSON-Schema
4227
4230
  * via the `definition` "job".
4228
4231
  */
@@ -4253,6 +4256,7 @@ export type UploadBatchDestroyTargetSchema = Job;
4253
4256
  export type UploadBulkTagTargetSchema = Job;
4254
4257
  export type UploadBulkDestroyTargetSchema = Job;
4255
4258
  export type SiteUpdateTargetSchema = Job;
4259
+ export type SiteActivateImprovedTimezoneManagementTargetSchema = Job;
4256
4260
  /**
4257
4261
  * JSON API data
4258
4262
  *
@@ -6730,6 +6734,10 @@ export type EnvironmentMeta = {
6730
6734
  * Is this environment the primary for the project?
6731
6735
  */
6732
6736
  primary: boolean;
6737
+ /**
6738
+ * ID of the environment that's been forked to generate this one
6739
+ */
6740
+ forked_from?: string | null;
6733
6741
  };
6734
6742
 
6735
6743
  /**
@@ -8478,9 +8486,24 @@ export type Site = {
8478
8486
  * The list of site roles
8479
8487
  */
8480
8488
  roles: RoleData[];
8489
+ meta: SiteMeta;
8481
8490
  };
8482
8491
  export type SiteSelfTargetSchema = Site;
8483
8492
  export type SiteUpdateJobSchema = Site;
8493
+ export type SiteActivateImprovedTimezoneManagementJobSchema = Site;
8494
+ /**
8495
+ * Meta attributes
8496
+ *
8497
+ * This interface was referenced by `Site`'s JSON-Schema
8498
+ * via the `definition` "meta".
8499
+ */
8500
+ export type SiteMeta = {
8501
+ /**
8502
+ * Whether the Improved API Timezone Management option is active or not
8503
+ */
8504
+ improved_timezone_management: boolean;
8505
+ };
8506
+
8484
8507
  /**
8485
8508
  * JSON API data
8486
8509
  *
@@ -8773,6 +8796,12 @@ export type SiteUpdateSchema = {
8773
8796
  */
8774
8797
  ip_tracking_enabled?: boolean;
8775
8798
  sso_default_role?: RoleData;
8799
+ meta?: {
8800
+ /**
8801
+ * Whether the Improved API Timezone Management option is active or not
8802
+ */
8803
+ improved_timezone_management?: boolean;
8804
+ };
8776
8805
  };
8777
8806
 
8778
8807
  /**
@@ -169,7 +169,49 @@ export default class BuildTrigger extends BaseResource {
169
169
  }
170
170
 
171
171
  /**
172
- * Trigger a new Site Search spidering of the website
172
+ * Abort a deploy and mark it as failed
173
+ *
174
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/abort
175
+ */
176
+ abort(buildTriggerId: string | SimpleSchemaTypes.BuildTriggerData) {
177
+ return this.rawAbort(Utils.toId(buildTriggerId));
178
+ }
179
+
180
+ /**
181
+ * Abort a deploy and mark it as failed
182
+ *
183
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/abort
184
+ */
185
+ rawAbort(buildTriggerId: string): Promise<void> {
186
+ return this.client.request<void>({
187
+ method: 'DELETE',
188
+ url: `/build-triggers/${buildTriggerId}/abort`,
189
+ });
190
+ }
191
+
192
+ /**
193
+ * Abort a site search spidering and mark it as failed
194
+ *
195
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/abort_indexing
196
+ */
197
+ abortIndexing(buildTriggerId: string | SimpleSchemaTypes.BuildTriggerData) {
198
+ return this.rawAbortIndexing(Utils.toId(buildTriggerId));
199
+ }
200
+
201
+ /**
202
+ * Abort a site search spidering and mark it as failed
203
+ *
204
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/abort_indexing
205
+ */
206
+ rawAbortIndexing(buildTriggerId: string): Promise<void> {
207
+ return this.client.request<void>({
208
+ method: 'DELETE',
209
+ url: `/build-triggers/${buildTriggerId}/abort_indexing`,
210
+ });
211
+ }
212
+
213
+ /**
214
+ * Trigger a new site search spidering of the website
173
215
  *
174
216
  * Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/reindex
175
217
  */
@@ -178,7 +220,7 @@ export default class BuildTrigger extends BaseResource {
178
220
  }
179
221
 
180
222
  /**
181
- * Trigger a new Site Search spidering of the website
223
+ * Trigger a new site search spidering of the website
182
224
  *
183
225
  * Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/reindex
184
226
  */
@@ -74,4 +74,31 @@ export default class Site extends BaseResource {
74
74
  body,
75
75
  });
76
76
  }
77
+
78
+ /**
79
+ * Activate improved timezone management
80
+ *
81
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/site/activate_improved_timezone_management
82
+ */
83
+ activateImprovedTimezoneManagement() {
84
+ return this.rawActivateImprovedTimezoneManagement().then((body) =>
85
+ Utils.deserializeResponseBody<SimpleSchemaTypes.SiteActivateImprovedTimezoneManagementJobSchema>(
86
+ body,
87
+ ),
88
+ );
89
+ }
90
+
91
+ /**
92
+ * Activate improved timezone management
93
+ *
94
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/site/activate_improved_timezone_management
95
+ */
96
+ rawActivateImprovedTimezoneManagement(): Promise<SchemaTypes.SiteActivateImprovedTimezoneManagementJobSchema> {
97
+ return this.client.request<SchemaTypes.SiteActivateImprovedTimezoneManagementJobSchema>(
98
+ {
99
+ method: 'PUT',
100
+ url: `/site/activate-improved-timezone-management`,
101
+ },
102
+ );
103
+ }
77
104
  }