contentful-management 11.58.0-canary.3 → 11.58.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.
Files changed (31) hide show
  1. package/README.md +0 -14
  2. package/dist/contentful-management.browser.js +73 -570
  3. package/dist/contentful-management.browser.js.map +1 -1
  4. package/dist/contentful-management.browser.min.js +1 -1
  5. package/dist/contentful-management.node.js +73 -512
  6. package/dist/contentful-management.node.js.map +1 -1
  7. package/dist/contentful-management.node.min.js +1 -1
  8. package/dist/es-modules/adapters/REST/endpoints/asset.js +0 -35
  9. package/dist/es-modules/adapters/REST/endpoints/entry.js +6 -27
  10. package/dist/es-modules/adapters/REST/endpoints/index.js +0 -4
  11. package/dist/es-modules/adapters/REST/endpoints/release.js +0 -24
  12. package/dist/es-modules/contentful-management.js +1 -1
  13. package/dist/es-modules/create-environment-api.js +4 -4
  14. package/dist/es-modules/entities/app-action-call.js +8 -44
  15. package/dist/es-modules/plain/plain-client.js +0 -33
  16. package/dist/typings/adapters/REST/endpoints/index.d.ts +0 -4
  17. package/dist/typings/common-types.d.ts +20 -224
  18. package/dist/typings/create-entry-api.d.ts +1 -1
  19. package/dist/typings/create-environment-api.d.ts +10 -10
  20. package/dist/typings/entities/app-action-call.d.ts +6 -5
  21. package/dist/typings/entities/asset.d.ts +3 -3
  22. package/dist/typings/entities/entry.d.ts +3 -3
  23. package/dist/typings/entities/release.d.ts +1 -18
  24. package/dist/typings/export-types.d.ts +1 -1
  25. package/dist/typings/plain/common-types.d.ts +17 -70
  26. package/dist/typings/plain/wrappers/wrap.d.ts +0 -2
  27. package/package.json +2 -6
  28. package/dist/es-modules/adapters/REST/endpoints/release-asset.js +0 -179
  29. package/dist/es-modules/adapters/REST/endpoints/release-entry.js +0 -54
  30. package/dist/typings/adapters/REST/endpoints/release-asset.d.ts +0 -9
  31. package/dist/typings/adapters/REST/endpoints/release-entry.d.ts +0 -7
@@ -28,7 +28,7 @@ import type { CreateOrganizationInvitationProps, OrganizationInvitationProps } f
28
28
  import type { OrganizationMembershipProps } from './entities/organization-membership';
29
29
  import type { CreatePersonalAccessTokenProps, PersonalAccessTokenProps } from './entities/personal-access-token';
30
30
  import type { PreviewApiKeyProps } from './entities/preview-api-key';
31
- import type { ReleasePayload, ReleasePayloadV2, ReleaseProps, ReleaseQueryOptions, ReleaseValidatePayload } from './entities/release';
31
+ import type { ReleasePayload, ReleaseProps, ReleaseQueryOptions, ReleaseValidatePayload } from './entities/release';
32
32
  import type { ReleaseAction, ReleaseActionProps, ReleaseActionQueryOptions } from './entities/release-action';
33
33
  import type { CreateRoleProps, RoleProps } from './entities/role';
34
34
  import type { ScheduledActionProps } from './entities/scheduled-action';
@@ -159,7 +159,6 @@ export interface EntityMetaSysProps extends MetaSysProps {
159
159
  fieldStatus?: {
160
160
  '*': Record<string, 'draft' | 'changed' | 'published'>;
161
161
  };
162
- release?: Link<'Release'>;
163
162
  }
164
163
  export interface EntryMetaSysProps extends EntityMetaSysProps {
165
164
  contentType: SysLink;
@@ -455,20 +454,6 @@ type MRInternal<UA extends boolean> = {
455
454
  (opts: MROpts<'ReleaseAction', 'get', UA>): MRReturn<'ReleaseAction', 'get'>;
456
455
  (opts: MROpts<'ReleaseAction', 'getMany', UA>): MRReturn<'ReleaseAction', 'getMany'>;
457
456
  (opts: MROpts<'ReleaseAction', 'queryForRelease', UA>): MRReturn<'ReleaseAction', 'queryForRelease'>;
458
- (opts: MROpts<'ReleaseAsset', 'get', UA>): MRReturn<'ReleaseAsset', 'get'>;
459
- (opts: MROpts<'ReleaseAsset', 'getMany', UA>): MRReturn<'ReleaseAsset', 'getMany'>;
460
- (opts: MROpts<'ReleaseAsset', 'update', UA>): MRReturn<'ReleaseAsset', 'update'>;
461
- (opts: MROpts<'ReleaseAsset', 'create', UA>): MRReturn<'ReleaseAsset', 'create'>;
462
- (opts: MROpts<'ReleaseAsset', 'createWithId', UA>): MRReturn<'ReleaseAsset', 'createWithId'>;
463
- (opts: MROpts<'ReleaseAsset', 'createFromFiles', UA>): MRReturn<'ReleaseAsset', 'createFromFiles'>;
464
- (opts: MROpts<'ReleaseAsset', 'processForAllLocales', UA>): MRReturn<'ReleaseAsset', 'processForAllLocales'>;
465
- (opts: MROpts<'ReleaseAsset', 'processForLocale', UA>): MRReturn<'ReleaseAsset', 'processForLocale'>;
466
- (opts: MROpts<'ReleaseEntry', 'get', UA>): MRReturn<'ReleaseEntry', 'get'>;
467
- (opts: MROpts<'ReleaseEntry', 'getMany', UA>): MRReturn<'ReleaseEntry', 'getMany'>;
468
- (opts: MROpts<'ReleaseEntry', 'update', UA>): MRReturn<'ReleaseEntry', 'update'>;
469
- (opts: MROpts<'ReleaseEntry', 'patch', UA>): MRReturn<'ReleaseEntry', 'patch'>;
470
- (opts: MROpts<'ReleaseEntry', 'create', UA>): MRReturn<'ReleaseEntry', 'create'>;
471
- (opts: MROpts<'ReleaseEntry', 'createWithId', UA>): MRReturn<'ReleaseEntry', 'createWithId'>;
472
457
  (opts: MROpts<'Resource', 'getMany', UA>): MRReturn<'Resource', 'getMany'>;
473
458
  (opts: MROpts<'ResourceProvider', 'get', UA>): MRReturn<'ResourceProvider', 'get'>;
474
459
  (opts: MROpts<'ResourceProvider', 'upsert', UA>): MRReturn<'ResourceProvider', 'upsert'>;
@@ -1056,16 +1041,13 @@ export type MRActions = {
1056
1041
  return: CollectionProp<AssetProps>;
1057
1042
  };
1058
1043
  getMany: {
1059
- params: GetSpaceEnvironmentParams & QueryParams & {
1060
- releaseId?: string;
1061
- };
1044
+ params: GetSpaceEnvironmentParams & QueryParams;
1062
1045
  headers?: RawAxiosRequestHeaders;
1063
1046
  return: CollectionProp<AssetProps>;
1064
1047
  };
1065
1048
  get: {
1066
1049
  params: GetSpaceEnvironmentParams & {
1067
1050
  assetId: string;
1068
- releaseId?: string;
1069
1051
  } & QueryParams;
1070
1052
  headers?: RawAxiosRequestHeaders;
1071
1053
  return: AssetProps;
@@ -1073,7 +1055,6 @@ export type MRActions = {
1073
1055
  update: {
1074
1056
  params: GetSpaceEnvironmentParams & {
1075
1057
  assetId: string;
1076
- releaseId?: string;
1077
1058
  };
1078
1059
  payload: AssetProps;
1079
1060
  headers?: RawAxiosRequestHeaders;
@@ -1111,16 +1092,13 @@ export type MRActions = {
1111
1092
  return: AssetProps;
1112
1093
  };
1113
1094
  create: {
1114
- params: GetSpaceEnvironmentParams & {
1115
- releaseId?: string;
1116
- };
1095
+ params: GetSpaceEnvironmentParams;
1117
1096
  payload: CreateAssetProps;
1118
1097
  return: AssetProps;
1119
1098
  };
1120
1099
  createWithId: {
1121
1100
  params: GetSpaceEnvironmentParams & {
1122
1101
  assetId: string;
1123
- releaseId?: string;
1124
1102
  };
1125
1103
  payload: CreateAssetProps;
1126
1104
  return: AssetProps;
@@ -1128,7 +1106,6 @@ export type MRActions = {
1128
1106
  createFromFiles: {
1129
1107
  params: GetSpaceEnvironmentParams & {
1130
1108
  uploadTimeout?: number;
1131
- releaseId?: string;
1132
1109
  };
1133
1110
  payload: Omit<AssetFileProp, 'sys'>;
1134
1111
  return: AssetProps;
@@ -1451,6 +1428,7 @@ export type MRActions = {
1451
1428
  params: GetOrganizationParams & {
1452
1429
  query?: BasicCursorPaginationOptions & {
1453
1430
  select?: string;
1431
+ forTemplatedSpaces?: boolean;
1454
1432
  };
1455
1433
  };
1456
1434
  return: CursorPaginatedCollectionProp<EnvironmentTemplateProps>;
@@ -1527,28 +1505,27 @@ export type MRActions = {
1527
1505
  return: CollectionProp<EntryProps<any>>;
1528
1506
  };
1529
1507
  getMany: {
1530
- params: GetManyEntryParams & QueryParams & {
1531
- releaseId?: string;
1532
- };
1533
- return: CollectionProp<EntryProps<any, any>>;
1508
+ params: GetSpaceEnvironmentParams & QueryParams;
1509
+ return: CollectionProp<EntryProps<any>>;
1534
1510
  };
1535
1511
  get: {
1536
- params: GetEntryParams & QueryParams & {
1537
- releaseId?: string;
1538
- };
1539
- return: EntryProps<any, any>;
1512
+ params: GetSpaceEnvironmentParams & {
1513
+ entryId: string;
1514
+ } & QueryParams;
1515
+ return: EntryProps<any>;
1540
1516
  };
1541
1517
  patch: {
1542
- params: PatchEntryParams & QueryParams & {
1543
- releaseId?: string;
1518
+ params: GetSpaceEnvironmentParams & {
1519
+ entryId: string;
1520
+ version: number;
1544
1521
  };
1545
1522
  payload: OpPatch[];
1546
1523
  headers?: RawAxiosRequestHeaders;
1547
1524
  return: EntryProps<any>;
1548
1525
  };
1549
1526
  update: {
1550
- params: UpdateEntryParams & QueryParams & {
1551
- releaseId?: string;
1527
+ params: GetSpaceEnvironmentParams & {
1528
+ entryId: string;
1552
1529
  };
1553
1530
  payload: EntryProps<any>;
1554
1531
  headers?: RawAxiosRequestHeaders;
@@ -1588,8 +1565,7 @@ export type MRActions = {
1588
1565
  create: {
1589
1566
  params: GetSpaceEnvironmentParams & {
1590
1567
  contentTypeId: string;
1591
- releaseId?: string;
1592
- } & QueryParams;
1568
+ };
1593
1569
  payload: CreateEntryProps<any>;
1594
1570
  return: EntryProps<any>;
1595
1571
  };
@@ -1597,10 +1573,9 @@ export type MRActions = {
1597
1573
  params: GetSpaceEnvironmentParams & {
1598
1574
  entryId: string;
1599
1575
  contentTypeId: string;
1600
- releaseId?: string;
1601
1576
  };
1602
1577
  payload: CreateEntryProps<any>;
1603
- return: EntryProps<any, any>;
1578
+ return: EntryProps<any>;
1604
1579
  };
1605
1580
  references: {
1606
1581
  params: GetSpaceEnvironmentParams & {
@@ -1857,14 +1832,14 @@ export type MRActions = {
1857
1832
  };
1858
1833
  create: {
1859
1834
  params: GetSpaceEnvironmentParams;
1860
- payload: ReleasePayload | ReleasePayloadV2;
1835
+ payload: ReleasePayload;
1861
1836
  return: ReleaseProps;
1862
1837
  };
1863
1838
  update: {
1864
1839
  params: GetReleaseParams & {
1865
1840
  version: number;
1866
1841
  };
1867
- payload: ReleasePayload | ReleasePayloadV2;
1842
+ payload: ReleasePayload;
1868
1843
  return: ReleaseProps;
1869
1844
  };
1870
1845
  delete: {
@@ -1895,112 +1870,6 @@ export type MRActions = {
1895
1870
  return: ReleaseActionProps<'validate'>;
1896
1871
  };
1897
1872
  };
1898
- ReleaseAsset: {
1899
- get: {
1900
- params: GetReleaseAssetParams & QueryParams;
1901
- headers?: RawAxiosRequestHeaders;
1902
- return: AssetProps<{
1903
- release: Link<'Release'>;
1904
- }>;
1905
- };
1906
- getMany: {
1907
- params: GetManyReleaseAssetParams & QueryParams;
1908
- headers?: RawAxiosRequestHeaders;
1909
- return: CollectionProp<AssetProps<{
1910
- release: Link<'Release'>;
1911
- }>>;
1912
- };
1913
- update: {
1914
- params: UpdateReleaseAssetParams & QueryParams;
1915
- payload: AssetProps;
1916
- headers?: RawAxiosRequestHeaders;
1917
- return: AssetProps<{
1918
- release: Link<'Release'>;
1919
- }>;
1920
- };
1921
- create: {
1922
- params: CreateReleaseAssetParams & QueryParams;
1923
- payload: CreateAssetProps;
1924
- headers?: RawAxiosRequestHeaders;
1925
- return: AssetProps<{
1926
- release: Link<'Release'>;
1927
- }>;
1928
- };
1929
- createWithId: {
1930
- params: CreateWithIdReleaseAssetParams & QueryParams;
1931
- payload: CreateAssetProps;
1932
- headers?: RawAxiosRequestHeaders;
1933
- return: AssetProps<{
1934
- release: Link<'Release'>;
1935
- }>;
1936
- };
1937
- createFromFiles: {
1938
- params: CreateWithFilesReleaseAssetParams & QueryParams;
1939
- payload: Omit<AssetFileProp, 'sys'>;
1940
- headers?: RawAxiosRequestHeaders;
1941
- return: AssetProps<{
1942
- release: Link<'Release'>;
1943
- }>;
1944
- };
1945
- processForAllLocales: {
1946
- params: ProcessForAllLocalesReleaseAssetParams;
1947
- return: AssetProps<{
1948
- release: Link<'Release'>;
1949
- }>;
1950
- };
1951
- processForLocale: {
1952
- params: ProcessForLocaleReleaseAssetParams;
1953
- return: AssetProps<{
1954
- release: Link<'Release'>;
1955
- }>;
1956
- };
1957
- };
1958
- ReleaseEntry: {
1959
- get: {
1960
- params: GetReleaseEntryParams & QueryParams;
1961
- headers?: RawAxiosRequestHeaders;
1962
- return: EntryProps<any, any>;
1963
- };
1964
- getMany: {
1965
- params: GetManyReleaseEntryParams & QueryParams;
1966
- headers?: RawAxiosRequestHeaders;
1967
- return: CollectionProp<EntryProps<any, any>>;
1968
- };
1969
- update: {
1970
- params: UpdateReleaseEntryParams & QueryParams;
1971
- payload: EntryProps<any>;
1972
- headers?: RawAxiosRequestHeaders;
1973
- return: EntryProps<any, {
1974
- release: Link<'Release'>;
1975
- }>;
1976
- };
1977
- patch: {
1978
- params: PatchReleaseEntryParams & QueryParams;
1979
- payload: OpPatch[];
1980
- headers?: RawAxiosRequestHeaders;
1981
- return: EntryProps<any, {
1982
- release: Link<'Release'>;
1983
- }>;
1984
- };
1985
- create: {
1986
- params: CreateReleaseEntryParams & QueryParams;
1987
- payload: CreateEntryProps<any>;
1988
- headers?: RawAxiosRequestHeaders;
1989
- return: EntryProps<any, {
1990
- release: Link<'Release'>;
1991
- }>;
1992
- };
1993
- createWithId: {
1994
- params: CreateReleaseEntryParams & {
1995
- entryId: string;
1996
- } & QueryParams;
1997
- payload: CreateEntryProps<any>;
1998
- headers?: RawAxiosRequestHeaders;
1999
- return: EntryProps<any, {
2000
- release: Link<'Release'>;
2001
- }>;
2002
- };
2003
- };
2004
1873
  ReleaseAction: {
2005
1874
  get: {
2006
1875
  params: GetReleaseParams & {
@@ -2680,16 +2549,6 @@ export type GetEditorInterfaceParams = GetSpaceEnvironmentParams & {
2680
2549
  export type GetEntryParams = GetSpaceEnvironmentParams & {
2681
2550
  entryId: string;
2682
2551
  };
2683
- export type GetManyEntryParams = GetSpaceEnvironmentParams;
2684
- export type PatchEntryParams = GetSpaceEnvironmentParams & {
2685
- entryId: string;
2686
- version: number;
2687
- releaseId?: string;
2688
- };
2689
- export type UpdateEntryParams = GetSpaceEnvironmentParams & {
2690
- entryId: string;
2691
- releaseId?: string;
2692
- };
2693
2552
  export type GetExtensionParams = GetSpaceEnvironmentParams & {
2694
2553
  extensionId: string;
2695
2554
  };
@@ -2712,69 +2571,9 @@ export type GetFunctionLogParams = GetManyFunctionLogParams & {
2712
2571
  export type GetOrganizationParams = {
2713
2572
  organizationId: string;
2714
2573
  };
2715
- export type GetReleaseParams = ReleaseEnvironmentParams & {
2716
- releaseId: string;
2717
- };
2718
- export type GetReleaseAssetParams = GetSpaceEnvironmentParams & {
2719
- releaseId: string;
2720
- assetId: string;
2721
- };
2722
- export type GetManyReleaseAssetParams = GetSpaceEnvironmentParams & {
2574
+ export type GetReleaseParams = GetSpaceEnvironmentParams & {
2723
2575
  releaseId: string;
2724
2576
  };
2725
- export type GetReleaseEntryParams = GetSpaceEnvironmentParams & {
2726
- releaseId: string;
2727
- entryId: string;
2728
- };
2729
- export type CreateReleaseAssetParams = GetSpaceEnvironmentParams & {
2730
- releaseId: string;
2731
- };
2732
- export type CreateWithIdReleaseAssetParams = GetSpaceEnvironmentParams & {
2733
- releaseId: string;
2734
- assetId: string;
2735
- };
2736
- export type CreateWithFilesReleaseAssetParams = GetSpaceEnvironmentParams & {
2737
- releaseId: string;
2738
- uploadTimeout?: number;
2739
- };
2740
- export type UpdateReleaseAssetParams = GetSpaceEnvironmentParams & {
2741
- releaseId: string;
2742
- assetId: string;
2743
- };
2744
- export type ProcessForLocaleReleaseAssetParams = GetSpaceEnvironmentParams & {
2745
- asset: AssetProps<{
2746
- release: Link<'Release'>;
2747
- }>;
2748
- locale: string;
2749
- options?: AssetProcessingForLocale;
2750
- };
2751
- export type ProcessForAllLocalesReleaseAssetParams = GetSpaceEnvironmentParams & {
2752
- asset: AssetProps<{
2753
- release: Link<'Release'>;
2754
- }>;
2755
- options?: AssetProcessingForLocale;
2756
- };
2757
- export type GetManyReleaseEntryParams = GetSpaceEnvironmentParams & {
2758
- releaseId: string;
2759
- };
2760
- export type UpdateReleaseEntryParams = GetSpaceEnvironmentParams & {
2761
- releaseId: string;
2762
- entryId: string;
2763
- };
2764
- export type PatchReleaseEntryParams = GetSpaceEnvironmentParams & {
2765
- releaseId: string;
2766
- entryId: string;
2767
- version: number;
2768
- };
2769
- export type CreateReleaseEntryParams = GetSpaceEnvironmentParams & {
2770
- releaseId: string;
2771
- contentTypeId: string;
2772
- };
2773
- export type CreateWithIdReleaseEntryParams = GetSpaceEnvironmentParams & {
2774
- releaseId: string;
2775
- entryId: string;
2776
- contentTypeId: string;
2777
- };
2778
2577
  export type GetSnapshotForContentTypeParams = GetSpaceEnvironmentParams & {
2779
2578
  contentTypeId: string;
2780
2579
  };
@@ -2921,7 +2720,4 @@ export type GetUserParams = {
2921
2720
  export declare enum ScheduledActionReferenceFilters {
2922
2721
  contentTypeAnnotationNotIn = "sys.contentType.metadata.annotations.ContentType[nin]"
2923
2722
  }
2924
- export type ReleaseEnvironmentParams = GetSpaceEnvironmentParams & {
2925
- releaseSchemaVersion?: 'Release.v1' | 'Release.v2';
2926
- };
2927
2723
  export {};
@@ -327,5 +327,5 @@ export default function createEntryApi(makeRequest: MakeRequest): {
327
327
  /**
328
328
  * Recursively collects references of an entry and their descendants
329
329
  */
330
- references: (options?: EntryReferenceOptionsProps) => Promise<import("./common-types").Collection<Entry, EntryProps<import("./common-types").KeyValueMap, unknown>>>;
330
+ references: (options?: EntryReferenceOptionsProps) => Promise<import("./common-types").Collection<Entry, EntryProps<import("./common-types").KeyValueMap>>>;
331
331
  };
@@ -8,7 +8,7 @@ import type { AssetFileProp, AssetProps, CreateAssetFromFilesOptions, CreateAsse
8
8
  import type { CreateAssetKeyProps } from './entities/asset-key';
9
9
  import type { BulkAction, BulkActionPayload, BulkActionPublishPayload, BulkActionUnpublishPayload, BulkActionValidatePayload } from './entities/bulk-action';
10
10
  import type { ReleaseActionQueryOptions } from './entities/release-action';
11
- import type { ReleasePayload, ReleaseQueryOptions, ReleaseValidatePayload, ReleasePayloadV2 } from './entities/release';
11
+ import type { ReleasePayload, ReleaseQueryOptions, ReleaseValidatePayload } from './entities/release';
12
12
  import type { ContentTypeProps, CreateContentTypeProps } from './entities/content-type';
13
13
  import type { CreateEntryProps, EntryProps, EntryReferenceOptionsProps, EntryReferenceProps } from './entities/entry';
14
14
  import type { CreateExtensionProps } from './entities/extension';
@@ -269,7 +269,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
269
269
  *
270
270
  * // Using Thenables
271
271
  * client.getSpace('<space_id>')
272
- * .then((space) => space.getEnvironment('<environment-id>'))
272
+ * .then((space) => space.getEnvironment('<environment_id>'))
273
273
  * .then((environment) => environment.createUnpublishBulkAction(payload))
274
274
  * .then((bulkAction) => console.log(bulkAction.waitProcessing()))
275
275
  * .catch(console.error)
@@ -277,7 +277,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
277
277
  * // Using async/await
278
278
  * try {
279
279
  * const space = await clientgetSpace('<space_id>')
280
- * const environment = await space.getEnvironment('<environment-id>')
280
+ * const environment = await space.getEnvironment('<environment_id>')
281
281
  * const bulkActionInProgress = await environment.createUnpublishBulkAction(payload)
282
282
  *
283
283
  * // You can wait for a recently created BulkAction to be processed by using `bulkAction.waitProcessing()`
@@ -486,7 +486,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
486
486
  * .catch(console.error)
487
487
  * ```
488
488
  */
489
- getEntries(query?: QueryOptions): Promise<import("./common-types").Collection<import("./entities/entry").Entry, EntryProps<import("./common-types").KeyValueMap, unknown>>>;
489
+ getEntries(query?: QueryOptions): Promise<import("./common-types").Collection<import("./entities/entry").Entry, EntryProps<import("./common-types").KeyValueMap>>>;
490
490
  /**
491
491
  * Gets a collection of published Entries
492
492
  * @param query - Object with search parameters. Check the <a href="https://www.contentful.com/developers/docs/javascript/tutorials/using-js-cda-sdk/#retrieving-entries-with-search-parameters">JS SDK tutorial</a> and the <a href="https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters">REST API reference</a> for more details.
@@ -505,7 +505,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
505
505
  * .catch(console.error)
506
506
  * ```
507
507
  */
508
- getPublishedEntries(query?: QueryOptions): Promise<import("./common-types").Collection<import("./entities/entry").Entry, EntryProps<import("./common-types").KeyValueMap, unknown>>>;
508
+ getPublishedEntries(query?: QueryOptions): Promise<import("./common-types").Collection<import("./entities/entry").Entry, EntryProps<import("./common-types").KeyValueMap>>>;
509
509
  /**
510
510
  * Creates a Entry
511
511
  * @param contentTypeId - The Content Type ID of the newly created Entry
@@ -574,7 +574,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
574
574
  *
575
575
  * // Get entry references
576
576
  * client.getSpace('<space_id>')
577
- * .then((space) => space.getEnvironment('<environment-id>'))
577
+ * .then((space) => space.getEnvironment('<environment_id>'))
578
578
  * .then((environment) => environment.getEntryReferences('<entry_id>', {include: number}))
579
579
  * .then((entry) => console.log(entry.includes))
580
580
  * // or
@@ -625,7 +625,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
625
625
  * .catch(console.error)
626
626
  * ```
627
627
  */
628
- getAssets(query?: QueryOptions): Promise<import("./common-types").Collection<import("./entities/asset").Asset, AssetProps<{}>>>;
628
+ getAssets(query?: QueryOptions): Promise<import("./common-types").Collection<import("./entities/asset").Asset, AssetProps>>;
629
629
  /**
630
630
  * Gets a collection of published Assets
631
631
  * @param query - Object with search parameters. Check the <a href="https://www.contentful.com/developers/docs/javascript/tutorials/using-js-cda-sdk/#retrieving-entries-with-search-parameters">JS SDK tutorial</a> and the <a href="https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters">REST API reference</a> for more details.
@@ -644,7 +644,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
644
644
  * .catch(console.error)
645
645
  * ```
646
646
  */
647
- getPublishedAssets(query?: QueryOptions): Promise<import("./common-types").Collection<import("./entities/asset").Asset, AssetProps<{}>>>;
647
+ getPublishedAssets(query?: QueryOptions): Promise<import("./common-types").Collection<import("./entities/asset").Asset, AssetProps>>;
648
648
  /**
649
649
  * Creates a Asset. After creation, call asset.processForLocale or asset.processForAllLocales to start asset processing.
650
650
  * @param data - Object representation of the Asset to be created. Note that the field object should have an upload property on asset creation, which will be removed and replaced with an url property when processing is finished.
@@ -1380,7 +1380,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
1380
1380
  */
1381
1381
  updateRelease({ releaseId, payload, version, }: {
1382
1382
  releaseId: string;
1383
- payload: ReleasePayload | ReleasePayloadV2;
1383
+ payload: ReleasePayload;
1384
1384
  version: number;
1385
1385
  }): Promise<import("./entities/release").Release>;
1386
1386
  /**
@@ -1612,7 +1612,7 @@ export default function createEnvironmentApi(makeRequest: MakeRequest): {
1612
1612
  * })
1613
1613
  *
1614
1614
  * client.getSpace('<space_id>')
1615
- * .then((space) => space.getEnvironment('<environment-id>'))
1615
+ * .then((space) => space.getEnvironment('<environment_id>'))
1616
1616
  * .then((environment) => environment.getResourceTypes({limit: 10}))
1617
1617
  * .then((installations) => console.log(installations.items))
1618
1618
  * .catch(console.error)
@@ -1,5 +1,5 @@
1
1
  import type { Except } from 'type-fest';
2
- import type { BasicMetaSysProps, AppActionCallRetryOptions, DefaultElements, MakeRequest, SysLink } from '../common-types';
2
+ import type { BasicMetaSysProps, AppActionCallRetryOptions, DefaultElements, MakeRequest, SysLink, CreateWithResponseParams, CreateWithResultParams, GetAppActionCallDetailsParams, GetAppActionCallParamsWithId } from '../common-types';
3
3
  import type { WebhookCallDetailsProps } from './webhook';
4
4
  type AppActionCallSys = Except<BasicMetaSysProps, 'version'> & {
5
5
  appDefinition: SysLink;
@@ -38,10 +38,10 @@ export type CreateAppActionCallProps = {
38
38
  };
39
39
  };
40
40
  type AppActionCallApi = {
41
- createWithResponse(): Promise<AppActionCallResponse>;
42
- getCallDetails(): Promise<AppActionCallResponse>;
43
- get(): Promise<AppActionCallProps>;
44
- createWithResult(): Promise<AppActionCallProps>;
41
+ createWithResponse(params: CreateWithResponseParams, payload: CreateAppActionCallProps): Promise<AppActionCallResponse>;
42
+ getCallDetails(params: GetAppActionCallDetailsParams): Promise<AppActionCallResponse>;
43
+ get(params: GetAppActionCallParamsWithId): Promise<AppActionCallProps>;
44
+ createWithResult(params: CreateWithResultParams, payload: CreateAppActionCallProps): Promise<AppActionCallProps>;
45
45
  };
46
46
  export type AppActionCallResponse = WebhookCallDetailsProps;
47
47
  export interface AppActionCallRawResponseProps {
@@ -58,6 +58,7 @@ export interface AppActionCallRawResponseProps {
58
58
  headers?: {
59
59
  contentType?: string;
60
60
  };
61
+ statusCode?: number;
61
62
  body: string;
62
63
  };
63
64
  }
@@ -1,7 +1,7 @@
1
1
  import type { Stream } from 'stream';
2
2
  import type { MetaSysProps, DefaultElements, EntityMetaSysProps, MetadataProps, MakeRequest } from '../common-types';
3
- export type AssetProps<S = {}> = {
4
- sys: EntityMetaSysProps & S;
3
+ export type AssetProps = {
4
+ sys: EntityMetaSysProps;
5
5
  fields: {
6
6
  /** Title for this asset */
7
7
  title: {
@@ -274,5 +274,5 @@ export declare function wrapAsset(makeRequest: MakeRequest, data: AssetProps): A
274
274
  /**
275
275
  * @private
276
276
  */
277
- export declare const wrapAssetCollection: (makeRequest: MakeRequest, data: import("../common-types").CollectionProp<AssetProps<{}>>) => import("../common-types").Collection<Asset, AssetProps<{}>>;
277
+ export declare const wrapAssetCollection: (makeRequest: MakeRequest, data: import("../common-types").CollectionProp<AssetProps>) => import("../common-types").Collection<Asset, AssetProps>;
278
278
  export {};
@@ -1,8 +1,8 @@
1
1
  import type { CollectionProp, DefaultElements, EntryMetaSysProps, KeyValueMap, MakeRequest, MetadataProps } from '../common-types';
2
2
  import type { ContentfulEntryApi } from '../create-entry-api';
3
3
  import type { AssetProps } from './asset';
4
- export type EntryProps<T = KeyValueMap, S = unknown> = {
5
- sys: EntryMetaSysProps & S;
4
+ export type EntryProps<T = KeyValueMap> = {
5
+ sys: EntryMetaSysProps;
6
6
  metadata?: MetadataProps;
7
7
  fields: T;
8
8
  };
@@ -50,4 +50,4 @@ export declare function wrapEntry(makeRequest: MakeRequest, data: EntryProps): E
50
50
  * Data is also mixed in with link getters if links exist and includes were requested
51
51
  * @private
52
52
  */
53
- export declare const wrapEntryCollection: (makeRequest: MakeRequest, data: CollectionProp<EntryProps<KeyValueMap, unknown>>) => import("../common-types").Collection<Entry, EntryProps<KeyValueMap, unknown>>;
53
+ export declare const wrapEntryCollection: (makeRequest: MakeRequest, data: CollectionProp<EntryProps<KeyValueMap>>) => import("../common-types").Collection<Entry, EntryProps<KeyValueMap>>;
@@ -18,8 +18,6 @@ export interface ReleaseQueryOptions {
18
18
  'sys.createdBy.sys.id[in]'?: string;
19
19
  /** Comma-separated filter (inclusion) by Release status (active, archived) */
20
20
  'sys.status[in]'?: ReleaseStatus;
21
- /** Determines the Release API version to use. 'Release.v1' refers to Launch, 'Release.v2' refers to Releases. */
22
- 'sys.schemaVersion'?: 'Release.v1' | 'Release.v2';
23
21
  /** Comma-separated filter (exclusion) by Release status (active, archived) */
24
22
  'sys.status[nin]'?: ReleaseStatus;
25
23
  /** Find releases using full text phrase and term matching */
@@ -57,7 +55,6 @@ export type ReleaseSysProps = {
57
55
  createdAt: ISO8601Timestamp;
58
56
  updatedAt: ISO8601Timestamp;
59
57
  lastAction?: Link<'ReleaseAction'>;
60
- schemaVersion?: 'Release.v2';
61
58
  };
62
59
  export type ReleaseReferenceFilters = ScheduledActionReferenceFilters;
63
60
  export declare const ReleaseReferenceFilters: typeof ScheduledActionReferenceFilters;
@@ -75,23 +72,9 @@ export interface ReleaseProps {
75
72
  metadata?: ReleaseMetadata;
76
73
  }
77
74
  export interface ReleasePayload extends MakeRequestPayload {
78
- sys?: {
79
- type: 'Release';
80
- schemaVersion?: 'Release.v1' | undefined;
81
- };
82
75
  title: string;
83
76
  entities: BaseCollection<Link<Entity>>;
84
77
  }
85
- export interface ReleasePayloadV2 extends MakeRequestPayload {
86
- sys?: {
87
- type: 'Release';
88
- schemaVersion: 'Release.v2';
89
- };
90
- title: string;
91
- entities: BaseCollection<{
92
- entity: Link<Entity>;
93
- } & ReleaseValidatePayload>;
94
- }
95
78
  export interface ReleaseValidatePayload {
96
79
  action?: 'publish';
97
80
  }
@@ -112,7 +95,7 @@ export interface ReleaseApiMethods {
112
95
  * */
113
96
  unarchive(): Promise<Release>;
114
97
  /** Updates a Release and returns the updated Release object */
115
- update(payload: ReleasePayload | ReleasePayloadV2): Promise<Release>;
98
+ update(payload: ReleasePayload): Promise<Release>;
116
99
  /** Deletes a Release and all ReleaseActions linked to it (non-reversible) */
117
100
  delete(): Promise<void>;
118
101
  /** Publishes a Release and waits until the asynchronous action is completed */
@@ -37,7 +37,7 @@ export type { CreateOrganizationInvitationProps, OrganizationInvitation, Organiz
37
37
  export type { OrganizationMembership, OrganizationMembershipProps, } from './entities/organization-membership';
38
38
  export type { CreatePersonalAccessTokenProps, PersonalAccessToken, PersonalAccessTokenProp, PersonalAccessTokenProps, } from './entities/personal-access-token';
39
39
  export type { PreviewApiKey, PreviewApiKeyProps } from './entities/preview-api-key';
40
- export type { Release, ReleaseMetadata, ReleasePayload, ReleasePayloadV2, ReleaseProps, ReleaseQueryOptions, ReleaseReferenceFilters, ReleaseSysProps, ReleaseValidateOptions, } from './entities/release';
40
+ export type { Release, ReleaseMetadata, ReleasePayload, ReleaseProps, ReleaseQueryOptions, ReleaseReferenceFilters, ReleaseSysProps, ReleaseValidateOptions, } from './entities/release';
41
41
  export type { ReleaseAction, ReleaseActionProps, ReleaseActionQueryOptions, ReleaseActionSysProps, ReleaseActionTypes, } from './entities/release-action';
42
42
  export type { CreateRoleProps, Role, RoleProps } from './entities/role';
43
43
  export type { ScheduledAction, ScheduledActionProps, ScheduledActionSysProps, } from './entities/scheduled-action';