contentful-management 11.58.0-canary.4 → 11.58.1

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 (30) hide show
  1. package/README.md +0 -14
  2. package/dist/contentful-management.browser.js +63 -558
  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 +63 -500
  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 +0 -19
  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/entities/app-action-call.js +8 -44
  14. package/dist/es-modules/plain/plain-client.js +0 -33
  15. package/dist/typings/adapters/REST/endpoints/index.d.ts +0 -4
  16. package/dist/typings/common-types.d.ts +10 -212
  17. package/dist/typings/create-entry-api.d.ts +1 -1
  18. package/dist/typings/create-environment-api.d.ts +4 -4
  19. package/dist/typings/entities/app-action-call.d.ts +22 -14
  20. package/dist/typings/entities/asset.d.ts +3 -3
  21. package/dist/typings/entities/entry.d.ts +3 -3
  22. package/dist/typings/entities/release.d.ts +1 -18
  23. package/dist/typings/export-types.d.ts +1 -1
  24. package/dist/typings/plain/common-types.d.ts +11 -81
  25. package/dist/typings/plain/wrappers/wrap.d.ts +0 -2
  26. package/package.json +2 -6
  27. package/dist/es-modules/adapters/REST/endpoints/release-asset.js +0 -179
  28. package/dist/es-modules/adapters/REST/endpoints/release-entry.js +0 -54
  29. package/dist/typings/adapters/REST/endpoints/release-asset.d.ts +0 -9
  30. 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,15 +1505,12 @@ export type MRActions = {
1527
1505
  return: CollectionProp<EntryProps<any>>;
1528
1506
  };
1529
1507
  getMany: {
1530
- params: GetSpaceEnvironmentParams & QueryParams & {
1531
- releaseId?: string;
1532
- };
1508
+ params: GetSpaceEnvironmentParams & QueryParams;
1533
1509
  return: CollectionProp<EntryProps<any>>;
1534
1510
  };
1535
1511
  get: {
1536
1512
  params: GetSpaceEnvironmentParams & {
1537
1513
  entryId: string;
1538
- releaseId?: string;
1539
1514
  } & QueryParams;
1540
1515
  return: EntryProps<any>;
1541
1516
  };
@@ -1543,7 +1518,6 @@ export type MRActions = {
1543
1518
  params: GetSpaceEnvironmentParams & {
1544
1519
  entryId: string;
1545
1520
  version: number;
1546
- releaseId?: string;
1547
1521
  };
1548
1522
  payload: OpPatch[];
1549
1523
  headers?: RawAxiosRequestHeaders;
@@ -1552,7 +1526,6 @@ export type MRActions = {
1552
1526
  update: {
1553
1527
  params: GetSpaceEnvironmentParams & {
1554
1528
  entryId: string;
1555
- releaseId?: string;
1556
1529
  };
1557
1530
  payload: EntryProps<any>;
1558
1531
  headers?: RawAxiosRequestHeaders;
@@ -1592,7 +1565,6 @@ export type MRActions = {
1592
1565
  create: {
1593
1566
  params: GetSpaceEnvironmentParams & {
1594
1567
  contentTypeId: string;
1595
- releaseId?: string;
1596
1568
  };
1597
1569
  payload: CreateEntryProps<any>;
1598
1570
  return: EntryProps<any>;
@@ -1601,7 +1573,6 @@ export type MRActions = {
1601
1573
  params: GetSpaceEnvironmentParams & {
1602
1574
  entryId: string;
1603
1575
  contentTypeId: string;
1604
- releaseId?: string;
1605
1576
  };
1606
1577
  payload: CreateEntryProps<any>;
1607
1578
  return: EntryProps<any>;
@@ -1854,21 +1825,21 @@ export type MRActions = {
1854
1825
  return: ReleaseProps;
1855
1826
  };
1856
1827
  query: {
1857
- params: ReleaseEnvironmentParams & {
1828
+ params: GetSpaceEnvironmentParams & {
1858
1829
  query?: ReleaseQueryOptions;
1859
1830
  };
1860
1831
  return: CollectionProp<ReleaseProps>;
1861
1832
  };
1862
1833
  create: {
1863
- params: ReleaseEnvironmentParams;
1864
- payload: ReleasePayload | ReleasePayloadV2;
1834
+ params: GetSpaceEnvironmentParams;
1835
+ payload: ReleasePayload;
1865
1836
  return: ReleaseProps;
1866
1837
  };
1867
1838
  update: {
1868
1839
  params: GetReleaseParams & {
1869
1840
  version: number;
1870
1841
  };
1871
- payload: ReleasePayload | ReleasePayloadV2;
1842
+ payload: ReleasePayload;
1872
1843
  return: ReleaseProps;
1873
1844
  };
1874
1845
  delete: {
@@ -1899,116 +1870,6 @@ export type MRActions = {
1899
1870
  return: ReleaseActionProps<'validate'>;
1900
1871
  };
1901
1872
  };
1902
- ReleaseAsset: {
1903
- get: {
1904
- params: GetReleaseAssetParams & QueryParams;
1905
- headers?: RawAxiosRequestHeaders;
1906
- return: AssetProps<{
1907
- release: Link<'Release'>;
1908
- }>;
1909
- };
1910
- getMany: {
1911
- params: GetManyReleaseAssetParams & QueryParams;
1912
- headers?: RawAxiosRequestHeaders;
1913
- return: CollectionProp<AssetProps<{
1914
- release: Link<'Release'>;
1915
- }>>;
1916
- };
1917
- update: {
1918
- params: UpdateReleaseAssetParams & QueryParams;
1919
- payload: AssetProps;
1920
- headers?: RawAxiosRequestHeaders;
1921
- return: AssetProps<{
1922
- release: Link<'Release'>;
1923
- }>;
1924
- };
1925
- create: {
1926
- params: CreateReleaseAssetParams & QueryParams;
1927
- payload: CreateAssetProps;
1928
- headers?: RawAxiosRequestHeaders;
1929
- return: AssetProps<{
1930
- release: Link<'Release'>;
1931
- }>;
1932
- };
1933
- createWithId: {
1934
- params: CreateWithIdReleaseAssetParams & QueryParams;
1935
- payload: CreateAssetProps;
1936
- headers?: RawAxiosRequestHeaders;
1937
- return: AssetProps<{
1938
- release: Link<'Release'>;
1939
- }>;
1940
- };
1941
- createFromFiles: {
1942
- params: CreateWithFilesReleaseAssetParams & QueryParams;
1943
- payload: Omit<AssetFileProp, 'sys'>;
1944
- headers?: RawAxiosRequestHeaders;
1945
- return: AssetProps<{
1946
- release: Link<'Release'>;
1947
- }>;
1948
- };
1949
- processForAllLocales: {
1950
- params: ProcessForAllLocalesReleaseAssetParams;
1951
- return: AssetProps<{
1952
- release: Link<'Release'>;
1953
- }>;
1954
- };
1955
- processForLocale: {
1956
- params: ProcessForLocaleReleaseAssetParams;
1957
- return: AssetProps<{
1958
- release: Link<'Release'>;
1959
- }>;
1960
- };
1961
- };
1962
- ReleaseEntry: {
1963
- get: {
1964
- params: GetReleaseEntryParams & QueryParams;
1965
- headers?: RawAxiosRequestHeaders;
1966
- return: EntryProps<any, {
1967
- release: Link<'Release'>;
1968
- }>;
1969
- };
1970
- getMany: {
1971
- params: GetManyReleaseEntryParams & QueryParams;
1972
- headers?: RawAxiosRequestHeaders;
1973
- return: CollectionProp<EntryProps<any, {
1974
- release: Link<'Release'>;
1975
- }>>;
1976
- };
1977
- update: {
1978
- params: UpdateReleaseEntryParams & QueryParams;
1979
- payload: EntryProps<any>;
1980
- headers?: RawAxiosRequestHeaders;
1981
- return: EntryProps<any, {
1982
- release: Link<'Release'>;
1983
- }>;
1984
- };
1985
- patch: {
1986
- params: PatchReleaseEntryParams & QueryParams;
1987
- payload: OpPatch[];
1988
- headers?: RawAxiosRequestHeaders;
1989
- return: EntryProps<any, {
1990
- release: Link<'Release'>;
1991
- }>;
1992
- };
1993
- create: {
1994
- params: CreateReleaseEntryParams & QueryParams;
1995
- payload: CreateEntryProps<any>;
1996
- headers?: RawAxiosRequestHeaders;
1997
- return: EntryProps<any, {
1998
- release: Link<'Release'>;
1999
- }>;
2000
- };
2001
- createWithId: {
2002
- params: CreateReleaseEntryParams & {
2003
- entryId: string;
2004
- } & QueryParams;
2005
- payload: CreateEntryProps<any>;
2006
- headers?: RawAxiosRequestHeaders;
2007
- return: EntryProps<any, {
2008
- release: Link<'Release'>;
2009
- }>;
2010
- };
2011
- };
2012
1873
  ReleaseAction: {
2013
1874
  get: {
2014
1875
  params: GetReleaseParams & {
@@ -2710,68 +2571,8 @@ export type GetFunctionLogParams = GetManyFunctionLogParams & {
2710
2571
  export type GetOrganizationParams = {
2711
2572
  organizationId: string;
2712
2573
  };
2713
- export type GetReleaseParams = ReleaseEnvironmentParams & {
2714
- releaseId: string;
2715
- };
2716
- export type GetReleaseAssetParams = GetSpaceEnvironmentParams & {
2717
- releaseId: string;
2718
- assetId: string;
2719
- };
2720
- export type GetManyReleaseAssetParams = GetSpaceEnvironmentParams & {
2721
- releaseId: string;
2722
- };
2723
- export type GetReleaseEntryParams = GetSpaceEnvironmentParams & {
2724
- releaseId: string;
2725
- entryId: string;
2726
- };
2727
- export type CreateReleaseAssetParams = GetSpaceEnvironmentParams & {
2728
- releaseId: string;
2729
- };
2730
- export type CreateWithIdReleaseAssetParams = GetSpaceEnvironmentParams & {
2731
- releaseId: string;
2732
- assetId: string;
2733
- };
2734
- export type CreateWithFilesReleaseAssetParams = GetSpaceEnvironmentParams & {
2735
- releaseId: string;
2736
- uploadTimeout?: number;
2737
- };
2738
- export type UpdateReleaseAssetParams = GetSpaceEnvironmentParams & {
2739
- releaseId: string;
2740
- assetId: string;
2741
- };
2742
- export type ProcessForLocaleReleaseAssetParams = GetSpaceEnvironmentParams & {
2743
- asset: AssetProps<{
2744
- release: Link<'Release'>;
2745
- }>;
2746
- locale: string;
2747
- options?: AssetProcessingForLocale;
2748
- };
2749
- export type ProcessForAllLocalesReleaseAssetParams = GetSpaceEnvironmentParams & {
2750
- asset: AssetProps<{
2751
- release: Link<'Release'>;
2752
- }>;
2753
- options?: AssetProcessingForLocale;
2754
- };
2755
- export type GetManyReleaseEntryParams = GetSpaceEnvironmentParams & {
2756
- releaseId: string;
2757
- };
2758
- export type UpdateReleaseEntryParams = GetSpaceEnvironmentParams & {
2574
+ export type GetReleaseParams = GetSpaceEnvironmentParams & {
2759
2575
  releaseId: string;
2760
- entryId: string;
2761
- };
2762
- export type PatchReleaseEntryParams = GetSpaceEnvironmentParams & {
2763
- releaseId: string;
2764
- entryId: string;
2765
- version: number;
2766
- };
2767
- export type CreateReleaseEntryParams = GetSpaceEnvironmentParams & {
2768
- releaseId: string;
2769
- contentTypeId: string;
2770
- };
2771
- export type CreateWithIdReleaseEntryParams = GetSpaceEnvironmentParams & {
2772
- releaseId: string;
2773
- entryId: string;
2774
- contentTypeId: string;
2775
2576
  };
2776
2577
  export type GetSnapshotForContentTypeParams = GetSpaceEnvironmentParams & {
2777
2578
  contentTypeId: string;
@@ -2919,7 +2720,4 @@ export type GetUserParams = {
2919
2720
  export declare enum ScheduledActionReferenceFilters {
2920
2721
  contentTypeAnnotationNotIn = "sys.contentType.metadata.annotations.ContentType[nin]"
2921
2722
  }
2922
- export type ReleaseEnvironmentParams = GetSpaceEnvironmentParams & {
2923
- releaseSchemaVersion?: 'Release.v1' | 'Release.v2';
2924
- };
2925
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
  };
@@ -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
@@ -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.
@@ -1,5 +1,5 @@
1
- import type { Except } from 'type-fest';
2
- import type { BasicMetaSysProps, AppActionCallRetryOptions, DefaultElements, MakeRequest, SysLink } from '../common-types';
1
+ import type { Except, JsonValue } from 'type-fest';
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;
@@ -7,7 +7,7 @@ type AppActionCallSys = Except<BasicMetaSysProps, 'version'> & {
7
7
  environment: SysLink;
8
8
  action: SysLink;
9
9
  appActionCallResponse?: SysLink;
10
- };
10
+ } & (AppActionCallSucceeded | AppActionCallProcessing | AppActionCallFailed);
11
11
  type RetryOptions = AppActionCallRetryOptions;
12
12
  export type AppActionCallStatus = 'processing' | 'succeeded' | 'failed';
13
13
  export interface AppActionCallErrorProps {
@@ -19,16 +19,24 @@ export interface AppActionCallErrorProps {
19
19
  details?: Record<string, unknown>;
20
20
  statusCode?: number;
21
21
  }
22
+ export type AppActionCallSucceeded = {
23
+ status: 'succeeded';
24
+ result: JsonValue;
25
+ };
26
+ export type AppActionCallProcessing = {
27
+ status: 'processing';
28
+ };
29
+ export type AppActionCallFailed = {
30
+ status: 'failed';
31
+ error: AppActionCallErrorProps;
32
+ };
22
33
  export type AppActionCallProps = {
23
34
  /**
24
35
  * System metadata
25
36
  */
26
37
  sys: AppActionCallSys;
27
- /** The execution status of the app action call, if available */
28
- status?: AppActionCallStatus;
29
- /** Structured result when execution succeeded */
30
- result?: unknown;
31
- /** Structured error when execution failed */
38
+ status: AppActionCallStatus;
39
+ result?: JsonValue;
32
40
  error?: AppActionCallErrorProps;
33
41
  };
34
42
  export type CreateAppActionCallProps = {
@@ -38,10 +46,10 @@ export type CreateAppActionCallProps = {
38
46
  };
39
47
  };
40
48
  type AppActionCallApi = {
41
- createWithResponse(): Promise<AppActionCallResponse>;
42
- getCallDetails(): Promise<AppActionCallResponse>;
43
- get(): Promise<AppActionCallProps>;
44
- createWithResult(): Promise<AppActionCallProps>;
49
+ createWithResponse(params: CreateWithResponseParams, payload: CreateAppActionCallProps): Promise<AppActionCallResponse>;
50
+ getCallDetails(params: GetAppActionCallDetailsParams): Promise<AppActionCallResponse>;
51
+ get(params: GetAppActionCallParamsWithId): Promise<AppActionCallProps>;
52
+ createWithResult(params: CreateWithResultParams, payload: CreateAppActionCallProps): Promise<AppActionCallProps>;
45
53
  };
46
54
  export type AppActionCallResponse = WebhookCallDetailsProps;
47
55
  export interface AppActionCallRawResponseProps {
@@ -58,13 +66,13 @@ export interface AppActionCallRawResponseProps {
58
66
  headers?: {
59
67
  contentType?: string;
60
68
  };
69
+ statusCode?: number;
61
70
  body: string;
62
71
  };
63
72
  }
64
73
  export interface AppActionCallResponseData extends AppActionCallResponse, DefaultElements<AppActionCallResponse>, AppActionCallApi {
65
74
  }
66
- export interface AppActionCall extends AppActionCallProps, DefaultElements<AppActionCallProps> {
67
- }
75
+ export type AppActionCall = AppActionCallProps & DefaultElements<AppActionCallProps>;
68
76
  /**
69
77
  * @private
70
78
  */
@@ -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,25 +72,11 @@ 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
- action?: 'publish' | 'unpublish';
79
+ action?: 'publish';
97
80
  }
98
81
  export interface ReleaseValidateOptions {
99
82
  payload?: ReleaseValidatePayload;
@@ -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';