webflow-api 3.0.0 → 3.0.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.
- package/.mock/definition/__package__.yml +99 -5
- package/.mock/definition/collections/items.yml +21 -37
- package/.mock/definition/inventory.yml +2 -2
- package/MIGRATION.md +32 -15
- package/api/resources/accessGroups/client/Client.js +1 -1
- package/api/resources/assets/client/Client.js +8 -8
- package/api/resources/collections/client/Client.js +4 -4
- package/api/resources/collections/resources/fields/client/Client.js +3 -3
- package/api/resources/collections/resources/items/client/Client.d.ts +5 -15
- package/api/resources/collections/resources/items/client/Client.js +21 -31
- package/api/resources/collections/resources/items/client/requests/CreateBulkCollectionItemRequestBody.d.ts +1 -1
- package/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.d.ts +4 -1
- package/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.d.ts +3 -0
- package/api/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.d.ts +1 -1
- package/api/resources/collections/resources/items/types/ItemsCreateItemRequest.d.ts +1 -1
- package/{dist/api/resources/collections/resources/items/types/ItemsCreateItemLiveRequestItems.d.ts → api/resources/collections/resources/items/types/MultipleItems.d.ts} +1 -1
- package/api/resources/collections/resources/items/types/{CreateBulkCollectionItemRequestBodyFieldDataName.d.ts → SingleCmsItem.d.ts} +1 -1
- package/api/resources/collections/resources/items/types/index.d.ts +2 -3
- package/api/resources/collections/resources/items/types/index.js +2 -3
- package/api/resources/ecommerce/client/Client.js +1 -1
- package/api/resources/forms/client/Client.js +5 -5
- package/api/resources/inventory/client/Client.js +2 -2
- package/api/resources/orders/client/Client.js +6 -6
- package/api/resources/pages/client/Client.js +5 -5
- package/api/resources/pages/resources/scripts/client/Client.js +3 -3
- package/api/resources/products/client/Client.js +6 -6
- package/api/resources/scripts/client/Client.js +3 -3
- package/api/resources/sites/client/Client.js +4 -4
- package/api/resources/sites/resources/activityLogs/client/Client.js +1 -1
- package/api/resources/sites/resources/scripts/client/Client.js +4 -4
- package/api/resources/token/client/Client.js +2 -2
- package/api/resources/users/client/Client.js +5 -5
- package/api/resources/webhooks/client/Client.js +4 -4
- package/api/types/CollectionItem.d.ts +1 -1
- package/api/types/CollectionItemFieldData.d.ts +2 -2
- package/api/types/CollectionItemPatchSingle.d.ts +24 -0
- package/api/types/CollectionItemPatchSingleFieldData.d.ts +11 -0
- package/api/types/CollectionItemPostSingle.d.ts +24 -0
- package/api/types/CollectionItemPostSingleFieldData.d.ts +11 -0
- package/api/types/index.d.ts +4 -0
- package/api/types/index.js +4 -0
- package/dist/api/resources/accessGroups/client/Client.js +1 -1
- package/dist/api/resources/assets/client/Client.js +8 -8
- package/dist/api/resources/collections/client/Client.js +4 -4
- package/dist/api/resources/collections/resources/fields/client/Client.js +3 -3
- package/dist/api/resources/collections/resources/items/client/Client.d.ts +5 -15
- package/dist/api/resources/collections/resources/items/client/Client.js +21 -31
- package/dist/api/resources/collections/resources/items/client/requests/CreateBulkCollectionItemRequestBody.d.ts +1 -1
- package/dist/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.d.ts +4 -1
- package/dist/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.d.ts +3 -0
- package/dist/api/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.d.ts +1 -1
- package/dist/api/resources/collections/resources/items/types/ItemsCreateItemRequest.d.ts +1 -1
- package/{api/resources/collections/resources/items/types/ItemsCreateItemLiveRequestItems.d.ts → dist/api/resources/collections/resources/items/types/MultipleItems.d.ts} +1 -1
- package/dist/api/resources/collections/resources/items/types/MultipleItems.js +5 -0
- package/dist/api/resources/collections/resources/items/types/{CreateBulkCollectionItemRequestBodyFieldDataName.d.ts → SingleCmsItem.d.ts} +1 -1
- package/dist/api/resources/collections/resources/items/types/SingleCmsItem.js +5 -0
- package/dist/api/resources/collections/resources/items/types/index.d.ts +2 -3
- package/dist/api/resources/collections/resources/items/types/index.js +2 -3
- package/dist/api/resources/ecommerce/client/Client.js +1 -1
- package/dist/api/resources/forms/client/Client.js +5 -5
- package/dist/api/resources/inventory/client/Client.js +2 -2
- package/dist/api/resources/orders/client/Client.js +6 -6
- package/dist/api/resources/pages/client/Client.js +5 -5
- package/dist/api/resources/pages/resources/scripts/client/Client.js +3 -3
- package/dist/api/resources/products/client/Client.js +6 -6
- package/dist/api/resources/scripts/client/Client.js +3 -3
- package/dist/api/resources/sites/client/Client.js +4 -4
- package/dist/api/resources/sites/resources/activityLogs/client/Client.js +1 -1
- package/dist/api/resources/sites/resources/scripts/client/Client.js +4 -4
- package/dist/api/resources/token/client/Client.js +2 -2
- package/dist/api/resources/users/client/Client.js +5 -5
- package/dist/api/resources/webhooks/client/Client.js +4 -4
- package/dist/api/types/CollectionItem.d.ts +1 -1
- package/dist/api/types/CollectionItemFieldData.d.ts +2 -2
- package/dist/api/types/CollectionItemPatchSingle.d.ts +24 -0
- package/dist/api/types/CollectionItemPatchSingle.js +5 -0
- package/dist/api/types/CollectionItemPatchSingleFieldData.d.ts +11 -0
- package/dist/api/types/CollectionItemPatchSingleFieldData.js +5 -0
- package/dist/api/types/CollectionItemPostSingle.d.ts +24 -0
- package/dist/api/types/CollectionItemPostSingle.js +5 -0
- package/dist/api/types/CollectionItemPostSingleFieldData.d.ts +11 -0
- package/dist/api/types/CollectionItemPostSingleFieldData.js +5 -0
- package/dist/api/types/index.d.ts +4 -0
- package/dist/api/types/index.js +4 -0
- package/dist/serialization/resources/collections/resources/items/client/requests/CreateBulkCollectionItemRequestBody.d.ts +1 -1
- package/dist/serialization/resources/collections/resources/items/client/requests/CreateBulkCollectionItemRequestBody.js +1 -1
- package/dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.d.ts +2 -2
- package/dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.js +2 -2
- package/dist/serialization/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.d.ts +2 -2
- package/dist/serialization/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.js +2 -2
- package/dist/serialization/resources/collections/resources/items/types/ItemsCreateItemRequest.d.ts +3 -3
- package/dist/serialization/resources/collections/resources/items/types/ItemsCreateItemRequest.js +3 -3
- package/dist/serialization/resources/collections/resources/items/types/{ItemsCreateItemRequestItems.d.ts → MultipleItems.d.ts} +2 -2
- package/dist/serialization/resources/collections/resources/items/types/{ItemsCreateItemRequestItems.js → MultipleItems.js} +2 -2
- package/dist/serialization/resources/collections/resources/items/types/{CreateBulkCollectionItemRequestBodyFieldDataName.d.ts → SingleCmsItem.d.ts} +2 -2
- package/dist/serialization/resources/collections/resources/items/types/{CreateBulkCollectionItemRequestBodyFieldDataName.js → SingleCmsItem.js} +2 -2
- package/dist/serialization/resources/collections/resources/items/types/index.d.ts +2 -3
- package/dist/serialization/resources/collections/resources/items/types/index.js +2 -3
- package/dist/serialization/types/CollectionItem.d.ts +1 -1
- package/dist/serialization/types/CollectionItem.js +1 -1
- package/dist/serialization/types/CollectionItemFieldData.d.ts +2 -2
- package/dist/serialization/types/CollectionItemFieldData.js +2 -2
- package/dist/serialization/types/CollectionItemPatchSingle.d.ts +20 -0
- package/dist/serialization/types/CollectionItemPatchSingle.js +41 -0
- package/dist/serialization/types/CollectionItemPatchSingleFieldData.d.ts +14 -0
- package/dist/serialization/types/CollectionItemPatchSingleFieldData.js +36 -0
- package/dist/serialization/types/CollectionItemPostSingle.d.ts +20 -0
- package/{serialization/resources/collections/resources/items/types/ItemsCreateItemLiveRequestItems.js → dist/serialization/types/CollectionItemPostSingle.js} +12 -5
- package/dist/serialization/types/CollectionItemPostSingleFieldData.d.ts +14 -0
- package/dist/serialization/types/CollectionItemPostSingleFieldData.js +36 -0
- package/dist/serialization/types/index.d.ts +4 -0
- package/dist/serialization/types/index.js +4 -0
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
- package/reference.md +2 -12
- package/serialization/resources/collections/resources/items/client/requests/CreateBulkCollectionItemRequestBody.d.ts +1 -1
- package/serialization/resources/collections/resources/items/client/requests/CreateBulkCollectionItemRequestBody.js +1 -1
- package/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.d.ts +2 -2
- package/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.js +2 -2
- package/serialization/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.d.ts +2 -2
- package/serialization/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.js +2 -2
- package/serialization/resources/collections/resources/items/types/ItemsCreateItemRequest.d.ts +3 -3
- package/serialization/resources/collections/resources/items/types/ItemsCreateItemRequest.js +3 -3
- package/serialization/resources/collections/resources/items/types/{ItemsCreateItemRequestItems.d.ts → MultipleItems.d.ts} +2 -2
- package/serialization/resources/collections/resources/items/types/{ItemsCreateItemRequestItems.js → MultipleItems.js} +2 -2
- package/serialization/resources/collections/resources/items/types/{CreateBulkCollectionItemRequestBodyFieldDataName.d.ts → SingleCmsItem.d.ts} +2 -2
- package/serialization/resources/collections/resources/items/types/{CreateBulkCollectionItemRequestBodyFieldDataName.js → SingleCmsItem.js} +2 -2
- package/serialization/resources/collections/resources/items/types/index.d.ts +2 -3
- package/serialization/resources/collections/resources/items/types/index.js +2 -3
- package/serialization/types/CollectionItem.d.ts +1 -1
- package/serialization/types/CollectionItem.js +1 -1
- package/serialization/types/CollectionItemFieldData.d.ts +2 -2
- package/serialization/types/CollectionItemFieldData.js +2 -2
- package/serialization/types/CollectionItemPatchSingle.d.ts +20 -0
- package/serialization/types/CollectionItemPatchSingle.js +41 -0
- package/serialization/types/CollectionItemPatchSingleFieldData.d.ts +14 -0
- package/serialization/types/CollectionItemPatchSingleFieldData.js +36 -0
- package/serialization/types/CollectionItemPostSingle.d.ts +20 -0
- package/{dist/serialization/resources/collections/resources/items/types/ItemsCreateItemLiveRequestItems.js → serialization/types/CollectionItemPostSingle.js} +12 -5
- package/serialization/types/CollectionItemPostSingleFieldData.d.ts +14 -0
- package/serialization/types/CollectionItemPostSingleFieldData.js +36 -0
- package/serialization/types/index.d.ts +4 -0
- package/serialization/types/index.js +4 -0
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/api/resources/collections/resources/items/types/ItemsCreateItemRequestItems.d.ts +0 -8
- package/dist/api/resources/collections/resources/items/types/ItemsCreateItemRequestItems.d.ts +0 -8
- package/dist/serialization/resources/collections/resources/items/types/ItemsCreateItemLiveRequestItems.d.ts +0 -13
- package/serialization/resources/collections/resources/items/types/ItemsCreateItemLiveRequestItems.d.ts +0 -13
- /package/api/resources/collections/resources/items/types/{CreateBulkCollectionItemRequestBodyFieldDataName.js → MultipleItems.js} +0 -0
- /package/api/resources/collections/resources/items/types/{ItemsCreateItemLiveRequestItems.js → SingleCmsItem.js} +0 -0
- /package/api/{resources/collections/resources/items/types/ItemsCreateItemRequestItems.js → types/CollectionItemPatchSingle.js} +0 -0
- /package/{dist/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataName.js → api/types/CollectionItemPatchSingleFieldData.js} +0 -0
- /package/{dist/api/resources/collections/resources/items/types/ItemsCreateItemLiveRequestItems.js → api/types/CollectionItemPostSingle.js} +0 -0
- /package/{dist/api/resources/collections/resources/items/types/ItemsCreateItemRequestItems.js → api/types/CollectionItemPostSingleFieldData.js} +0 -0
|
@@ -551,10 +551,10 @@ types:
|
|
|
551
551
|
CollectionItemFieldData:
|
|
552
552
|
properties:
|
|
553
553
|
name:
|
|
554
|
-
type:
|
|
554
|
+
type: string
|
|
555
555
|
docs: Name of the Item
|
|
556
556
|
slug:
|
|
557
|
-
type:
|
|
557
|
+
type: string
|
|
558
558
|
docs: >-
|
|
559
559
|
URL structure of the Item in your site. Note: Updates to an item slug
|
|
560
560
|
will break all links referencing the old slug.
|
|
@@ -592,7 +592,7 @@ types:
|
|
|
592
592
|
type: optional<boolean>
|
|
593
593
|
docs: Boolean determining if the Item is set to draft
|
|
594
594
|
default: false
|
|
595
|
-
fieldData:
|
|
595
|
+
fieldData: CollectionItemFieldData
|
|
596
596
|
source:
|
|
597
597
|
openapi: ../../../referenced-specs/v2.yml
|
|
598
598
|
CollectionItemListPagination:
|
|
@@ -620,6 +620,53 @@ types:
|
|
|
620
620
|
pagination: optional<CollectionItemListPagination>
|
|
621
621
|
source:
|
|
622
622
|
openapi: ../../../referenced-specs/v2.yml
|
|
623
|
+
CollectionItemPostSingleFieldData:
|
|
624
|
+
properties:
|
|
625
|
+
name:
|
|
626
|
+
type: string
|
|
627
|
+
docs: Name of the Item
|
|
628
|
+
slug:
|
|
629
|
+
type: string
|
|
630
|
+
docs: >-
|
|
631
|
+
URL structure of the Item in your site. Note: Updates to an item slug
|
|
632
|
+
will break all links referencing the old slug.
|
|
633
|
+
extra-properties: true
|
|
634
|
+
source:
|
|
635
|
+
openapi: ../../../referenced-specs/v2.yml
|
|
636
|
+
inline: true
|
|
637
|
+
CollectionItemPostSingle:
|
|
638
|
+
docs: >
|
|
639
|
+
The fields that define the schema for a given Item are based on the
|
|
640
|
+
Collection that Item belongs to. Beyond the user defined fields, there are
|
|
641
|
+
a handful of additional fields that are automatically created for all
|
|
642
|
+
items
|
|
643
|
+
properties:
|
|
644
|
+
id:
|
|
645
|
+
type: optional<string>
|
|
646
|
+
docs: Unique identifier for the Item
|
|
647
|
+
cmsLocaleId:
|
|
648
|
+
type: optional<string>
|
|
649
|
+
docs: Identifier for the locale of the CMS item
|
|
650
|
+
lastPublished:
|
|
651
|
+
type: optional<string>
|
|
652
|
+
docs: The date the item was last published
|
|
653
|
+
lastUpdated:
|
|
654
|
+
type: optional<string>
|
|
655
|
+
docs: The date the item was last updated
|
|
656
|
+
createdOn:
|
|
657
|
+
type: optional<string>
|
|
658
|
+
docs: The date the item was created
|
|
659
|
+
isArchived:
|
|
660
|
+
type: optional<boolean>
|
|
661
|
+
docs: Boolean determining if the Item is set to archived
|
|
662
|
+
default: false
|
|
663
|
+
isDraft:
|
|
664
|
+
type: optional<boolean>
|
|
665
|
+
docs: Boolean determining if the Item is set to draft
|
|
666
|
+
default: false
|
|
667
|
+
fieldData: CollectionItemPostSingleFieldData
|
|
668
|
+
source:
|
|
669
|
+
openapi: ../../../referenced-specs/v2.yml
|
|
623
670
|
CollectionItemWithIdInputFieldData:
|
|
624
671
|
properties:
|
|
625
672
|
name:
|
|
@@ -722,6 +769,53 @@ types:
|
|
|
722
769
|
fieldData: optional<BulkCollectionItemFieldData>
|
|
723
770
|
source:
|
|
724
771
|
openapi: ../../../referenced-specs/v2.yml
|
|
772
|
+
CollectionItemPatchSingleFieldData:
|
|
773
|
+
properties:
|
|
774
|
+
name:
|
|
775
|
+
type: optional<string>
|
|
776
|
+
docs: Name of the Item
|
|
777
|
+
slug:
|
|
778
|
+
type: optional<string>
|
|
779
|
+
docs: >-
|
|
780
|
+
URL structure of the Item in your site. Note: Updates to an item slug
|
|
781
|
+
will break all links referencing the old slug.
|
|
782
|
+
extra-properties: true
|
|
783
|
+
source:
|
|
784
|
+
openapi: ../../../referenced-specs/v2.yml
|
|
785
|
+
inline: true
|
|
786
|
+
CollectionItemPatchSingle:
|
|
787
|
+
docs: >
|
|
788
|
+
The fields that define the schema for a given Item are based on the
|
|
789
|
+
Collection that Item belongs to. Beyond the user defined fields, there are
|
|
790
|
+
a handful of additional fields that are automatically created for all
|
|
791
|
+
items
|
|
792
|
+
properties:
|
|
793
|
+
id:
|
|
794
|
+
type: optional<string>
|
|
795
|
+
docs: Unique identifier for the Item
|
|
796
|
+
cmsLocaleId:
|
|
797
|
+
type: optional<string>
|
|
798
|
+
docs: Identifier for the locale of the CMS item
|
|
799
|
+
lastPublished:
|
|
800
|
+
type: optional<string>
|
|
801
|
+
docs: The date the item was last published
|
|
802
|
+
lastUpdated:
|
|
803
|
+
type: optional<string>
|
|
804
|
+
docs: The date the item was last updated
|
|
805
|
+
createdOn:
|
|
806
|
+
type: optional<string>
|
|
807
|
+
docs: The date the item was created
|
|
808
|
+
isArchived:
|
|
809
|
+
type: optional<boolean>
|
|
810
|
+
docs: Boolean determining if the Item is set to archived
|
|
811
|
+
default: false
|
|
812
|
+
isDraft:
|
|
813
|
+
type: optional<boolean>
|
|
814
|
+
docs: Boolean determining if the Item is set to draft
|
|
815
|
+
default: false
|
|
816
|
+
fieldData: optional<CollectionItemPatchSingleFieldData>
|
|
817
|
+
source:
|
|
818
|
+
openapi: ../../../referenced-specs/v2.yml
|
|
725
819
|
PageSeo:
|
|
726
820
|
docs: SEO-related fields for the Page
|
|
727
821
|
properties:
|
|
@@ -1280,7 +1374,7 @@ types:
|
|
|
1280
1374
|
WebhookFilter:
|
|
1281
1375
|
docs: >-
|
|
1282
1376
|
Only supported for the `form_submission` trigger type. Filter for the form
|
|
1283
|
-
you want Webhooks to be sent for.
|
|
1377
|
+
you want Webhooks to be sent for.
|
|
1284
1378
|
properties:
|
|
1285
1379
|
name:
|
|
1286
1380
|
type: optional<string>
|
|
@@ -1307,7 +1401,7 @@ types:
|
|
|
1307
1401
|
type: optional<WebhookFilter>
|
|
1308
1402
|
docs: >-
|
|
1309
1403
|
Only supported for the `form_submission` trigger type. Filter for the
|
|
1310
|
-
form you want Webhooks to be sent for.
|
|
1404
|
+
form you want Webhooks to be sent for.
|
|
1311
1405
|
lastTriggered:
|
|
1312
1406
|
type: optional<datetime>
|
|
1313
1407
|
docs: Date the Webhook instance was last triggered
|
|
@@ -12,19 +12,19 @@ types:
|
|
|
12
12
|
- desc
|
|
13
13
|
source:
|
|
14
14
|
openapi: ../../../referenced-specs/v2.yml
|
|
15
|
-
|
|
15
|
+
Multiple Items:
|
|
16
16
|
properties:
|
|
17
17
|
items:
|
|
18
18
|
type: optional<list<root.CollectionItem>>
|
|
19
|
-
docs:
|
|
19
|
+
docs: List of collection items to create
|
|
20
20
|
source:
|
|
21
21
|
openapi: ../../../referenced-specs/v2.yml
|
|
22
22
|
inline: true
|
|
23
23
|
ItemsCreateItemRequest:
|
|
24
24
|
discriminated: false
|
|
25
25
|
union:
|
|
26
|
-
- root.
|
|
27
|
-
-
|
|
26
|
+
- root.CollectionItemPostSingle
|
|
27
|
+
- Multiple Items
|
|
28
28
|
source:
|
|
29
29
|
openapi: ../../../referenced-specs/v2.yml
|
|
30
30
|
ItemsDeleteItemsRequestItemsItem:
|
|
@@ -51,19 +51,11 @@ types:
|
|
|
51
51
|
- desc
|
|
52
52
|
source:
|
|
53
53
|
openapi: ../../../referenced-specs/v2.yml
|
|
54
|
-
ItemsCreateItemLiveRequestItems:
|
|
55
|
-
properties:
|
|
56
|
-
items:
|
|
57
|
-
type: optional<list<root.CollectionItem>>
|
|
58
|
-
docs: List of collection items to create
|
|
59
|
-
source:
|
|
60
|
-
openapi: ../../../referenced-specs/v2.yml
|
|
61
|
-
inline: true
|
|
62
54
|
ItemsCreateItemLiveRequest:
|
|
63
55
|
discriminated: false
|
|
64
56
|
union:
|
|
65
57
|
- root.CollectionItem
|
|
66
|
-
-
|
|
58
|
+
- Multiple Items
|
|
67
59
|
source:
|
|
68
60
|
openapi: ../../../referenced-specs/v2.yml
|
|
69
61
|
ItemsDeleteItemsLiveRequestItemsItem:
|
|
@@ -77,7 +69,7 @@ types:
|
|
|
77
69
|
source:
|
|
78
70
|
openapi: ../../../referenced-specs/v2.yml
|
|
79
71
|
inline: true
|
|
80
|
-
|
|
72
|
+
Single CMS Item:
|
|
81
73
|
properties:
|
|
82
74
|
name:
|
|
83
75
|
type: string
|
|
@@ -94,6 +86,7 @@ types:
|
|
|
94
86
|
openapi: ../../../referenced-specs/v2.yml
|
|
95
87
|
inline: true
|
|
96
88
|
CreateBulkCollectionItemRequestBodyFieldDataItem:
|
|
89
|
+
docs: A single CMS item to create
|
|
97
90
|
properties:
|
|
98
91
|
name:
|
|
99
92
|
type: string
|
|
@@ -112,8 +105,9 @@ types:
|
|
|
112
105
|
CreateBulkCollectionItemRequestBodyFieldData:
|
|
113
106
|
discriminated: false
|
|
114
107
|
union:
|
|
115
|
-
-
|
|
116
|
-
- list
|
|
108
|
+
- Single CMS Item
|
|
109
|
+
- docs: A list of CMS items to create
|
|
110
|
+
type: list<CreateBulkCollectionItemRequestBodyFieldDataItem>
|
|
117
111
|
source:
|
|
118
112
|
openapi: ../../../referenced-specs/v2.yml
|
|
119
113
|
inline: true
|
|
@@ -285,16 +279,16 @@ service:
|
|
|
285
279
|
slug: product-manager
|
|
286
280
|
response:
|
|
287
281
|
body:
|
|
288
|
-
id:
|
|
282
|
+
id: id
|
|
289
283
|
cmsLocaleId: 653ad57de882f528b32e810e
|
|
290
|
-
lastPublished: '
|
|
291
|
-
lastUpdated: '
|
|
292
|
-
createdOn: '
|
|
293
|
-
isArchived:
|
|
294
|
-
isDraft:
|
|
284
|
+
lastPublished: '2023-03-17T18:47:35.560Z'
|
|
285
|
+
lastUpdated: '2023-03-17T18:47:35.560Z'
|
|
286
|
+
createdOn: '2023-03-17T18:47:35.560Z'
|
|
287
|
+
isArchived: true
|
|
288
|
+
isDraft: true
|
|
295
289
|
fieldData:
|
|
296
|
-
name:
|
|
297
|
-
slug:
|
|
290
|
+
name: My new item
|
|
291
|
+
slug: my-new-item
|
|
298
292
|
delete-items:
|
|
299
293
|
path: /collections/{collection_id}/items
|
|
300
294
|
method: DELETE
|
|
@@ -1033,7 +1027,7 @@ service:
|
|
|
1033
1027
|
type: optional<boolean>
|
|
1034
1028
|
docs: Indicates whether the item is in draft state.
|
|
1035
1029
|
default: false
|
|
1036
|
-
fieldData:
|
|
1030
|
+
fieldData: CreateBulkCollectionItemRequestBodyFieldData
|
|
1037
1031
|
content-type: application/json
|
|
1038
1032
|
response:
|
|
1039
1033
|
docs: Request was successful
|
|
@@ -1270,7 +1264,7 @@ service:
|
|
|
1270
1264
|
docs: Unique identifier for an Item
|
|
1271
1265
|
display-name: Update Collection Item
|
|
1272
1266
|
request:
|
|
1273
|
-
body: root.
|
|
1267
|
+
body: root.CollectionItemPatchSingle
|
|
1274
1268
|
content-type: application/json
|
|
1275
1269
|
response:
|
|
1276
1270
|
docs: Request was successful
|
|
@@ -1286,11 +1280,6 @@ service:
|
|
|
1286
1280
|
collection_id: 580e63fc8c9a982ac9b8b745
|
|
1287
1281
|
item_id: 580e64008c9a982ac9b8b754
|
|
1288
1282
|
request:
|
|
1289
|
-
id: 42b720ef280c7a7a3be8cabe
|
|
1290
|
-
cmsLocaleId: 653ad57de882f528b32e810e
|
|
1291
|
-
lastPublished: '2022-11-29T16:22:43.159Z'
|
|
1292
|
-
lastUpdated: '2022-11-17T17:19:43.282Z'
|
|
1293
|
-
createdOn: '2022-11-17T17:11:57.148Z'
|
|
1294
1283
|
isArchived: false
|
|
1295
1284
|
isDraft: false
|
|
1296
1285
|
fieldData:
|
|
@@ -1425,7 +1414,7 @@ service:
|
|
|
1425
1414
|
docs: Unique identifier for an Item
|
|
1426
1415
|
display-name: Update Live Collection Item
|
|
1427
1416
|
request:
|
|
1428
|
-
body: root.
|
|
1417
|
+
body: root.CollectionItemPatchSingle
|
|
1429
1418
|
content-type: application/json
|
|
1430
1419
|
response:
|
|
1431
1420
|
docs: Request was successful
|
|
@@ -1441,11 +1430,6 @@ service:
|
|
|
1441
1430
|
collection_id: 580e63fc8c9a982ac9b8b745
|
|
1442
1431
|
item_id: 580e64008c9a982ac9b8b754
|
|
1443
1432
|
request:
|
|
1444
|
-
id: 42b720ef280c7a7a3be8cabe
|
|
1445
|
-
cmsLocaleId: 653ad57de882f528b32e810e
|
|
1446
|
-
lastPublished: '2022-11-29T16:22:43.159Z'
|
|
1447
|
-
lastUpdated: '2022-11-17T17:19:43.282Z'
|
|
1448
|
-
createdOn: '2022-11-17T17:11:57.148Z'
|
|
1449
1433
|
isArchived: false
|
|
1450
1434
|
isDraft: false
|
|
1451
1435
|
fieldData:
|
|
@@ -41,7 +41,7 @@ service:
|
|
|
41
41
|
body:
|
|
42
42
|
id: 5bfedb42bab0ad90fa7dad39
|
|
43
43
|
quantity: 100
|
|
44
|
-
inventoryType:
|
|
44
|
+
inventoryType: finite
|
|
45
45
|
update:
|
|
46
46
|
path: /collections/{collection_id}/items/{item_id}/inventory
|
|
47
47
|
method: PATCH
|
|
@@ -106,7 +106,7 @@ service:
|
|
|
106
106
|
body:
|
|
107
107
|
id: 5bfedb42bab0ad90fa7dad39
|
|
108
108
|
quantity: 100
|
|
109
|
-
inventoryType:
|
|
109
|
+
inventoryType: finite
|
|
110
110
|
source:
|
|
111
111
|
openapi: ../../../referenced-specs/v2.yml
|
|
112
112
|
display-name: Inventory
|
package/MIGRATION.md
CHANGED
|
@@ -4,34 +4,51 @@ When migrating to a new major version of this SDK, please consult the notes here
|
|
|
4
4
|
|
|
5
5
|
## v2.x.x -> v3.0.0
|
|
6
6
|
|
|
7
|
-
There are a few breaking changes with v3.0.0 of the Webflow JS SDK
|
|
7
|
+
There are a few breaking changes with v3.0.0 of the Webflow JS SDK. Please see the `Breaking` section below for more details and consult our [API Docs](https://developers.webflow.com/data/reference/rest-introduction) for examples of usage.
|
|
8
8
|
|
|
9
9
|
### Breaking
|
|
10
10
|
|
|
11
11
|
#### CMS APIs
|
|
12
12
|
|
|
13
|
-
- CHANGED
|
|
14
|
-
-
|
|
15
|
-
|
|
16
|
-
-
|
|
17
|
-
|
|
13
|
+
- **CHANGED**: Deleting a Collection is now achieved through `client.collections.delete()`, which was previously an API used to delete a Collection field.
|
|
14
|
+
- To delete a Collection, use `client.collections.delete()`
|
|
15
|
+
- e.g., `client.collections.delete(collectionId)`
|
|
16
|
+
- **NEW**: To delete a Collection field, use `client.collections.fields.delete()`
|
|
17
|
+
- e.g., `client.collections.fields.delete(collectionId, fieldId)`
|
|
18
|
+
- **REMOVED**: `client.collections.deleteCollection()`
|
|
19
|
+
- **CHANGED**: Creating bulk CMS Items in multiple locales is now achieved through `client.collections.createItems()`
|
|
20
|
+
- e.g.,
|
|
21
|
+
```ts
|
|
22
|
+
const newItems = client.collections.items.createItems(collectionId, {
|
|
23
|
+
cmsLocaleIds: [primaryCmsLocaleId, secondaryCmsLocaleId],
|
|
24
|
+
isArchived: false,
|
|
25
|
+
isDraft: false,
|
|
26
|
+
fieldData: {
|
|
27
|
+
name: "My Item For Multiple Locales",
|
|
28
|
+
slug: "my-item",
|
|
29
|
+
"plain-text": "foo",
|
|
30
|
+
},
|
|
31
|
+
});
|
|
32
|
+
```
|
|
33
|
+
- **REMOVED**: `client.collections.createItemForMultipleLocales()`
|
|
18
34
|
|
|
19
35
|
#### Pages APIs
|
|
20
36
|
|
|
21
|
-
- CHANGED
|
|
37
|
+
- **CHANGED**: The `locale` query parameter is now `localeId`
|
|
38
|
+
- e.g., `client.pages.list(siteId, { localeId: "65427cf400e02b306eaa04a0" })`
|
|
22
39
|
|
|
23
40
|
### New Features
|
|
24
41
|
|
|
25
42
|
#### CMS APIs
|
|
26
43
|
|
|
27
|
-
-
|
|
28
|
-
- `createItems()`
|
|
29
|
-
- `updateItems()`
|
|
30
|
-
- `updateItemsLive()`
|
|
31
|
-
- `deleteItems()`
|
|
32
|
-
- `deleteItemsLive()`
|
|
44
|
+
- **NEW**: Bulk CMS Item API support, with the ability to specify one or many locales to manage the CMS Item in. See [docs](https://developers.webflow.com/data/reference/cms/collection-items/bulk-items/create-items) for more on usage.
|
|
45
|
+
- `collections.items.createItems()` - Create a single CMS Item or multiple CMS Items in a Collection
|
|
46
|
+
- `collections.items.updateItems()` - Update multiple CMS Item(s) in a Collection
|
|
47
|
+
- `collections.items.updateItemsLive()` - Update multiple live CMS Item(s) in a Collection
|
|
48
|
+
- `collections.items.deleteItems()` - Unpublish/delete multiple CMS Item(s) in a Collection
|
|
49
|
+
- `collections.items.deleteItemsLive()` - Unpublish/delete multiple live CMS Item(s) in a Colllection
|
|
33
50
|
|
|
34
51
|
### Fixes
|
|
35
52
|
|
|
36
|
-
- Some APIs that created resources (i.e. `collections.items.createItem()`) had types that required an `id`, which is not possible to provide. This is no longer required.
|
|
37
|
-
- `fieldData` type in CMS Items now allows arbitrary extra key/value pairs
|
|
53
|
+
- Some APIs that created resources (i.e. `collections.items.createItem()`) had request payload types that required an `id`, which is not possible to provide. This is no longer required.
|
|
54
|
+
- `fieldData` type in CMS Items now allows arbitrary extra key/value pairs
|
|
@@ -85,7 +85,7 @@ class AccessGroups {
|
|
|
85
85
|
const _response = yield core.fetcher({
|
|
86
86
|
url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${encodeURIComponent(siteId)}/accessgroups`),
|
|
87
87
|
method: "GET",
|
|
88
|
-
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.
|
|
88
|
+
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.1", "User-Agent": "webflow-api/3.0.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
89
89
|
contentType: "application/json",
|
|
90
90
|
queryParameters: _queryParams,
|
|
91
91
|
requestType: "json",
|
|
@@ -72,7 +72,7 @@ class Assets {
|
|
|
72
72
|
const _response = yield core.fetcher({
|
|
73
73
|
url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${encodeURIComponent(siteId)}/assets`),
|
|
74
74
|
method: "GET",
|
|
75
|
-
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.
|
|
75
|
+
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.1", "User-Agent": "webflow-api/3.0.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
76
76
|
contentType: "application/json",
|
|
77
77
|
requestType: "json",
|
|
78
78
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
@@ -177,7 +177,7 @@ class Assets {
|
|
|
177
177
|
const _response = yield core.fetcher({
|
|
178
178
|
url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${encodeURIComponent(siteId)}/assets`),
|
|
179
179
|
method: "POST",
|
|
180
|
-
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.
|
|
180
|
+
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.1", "User-Agent": "webflow-api/3.0.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
181
181
|
contentType: "application/json",
|
|
182
182
|
requestType: "json",
|
|
183
183
|
body: serializers.AssetsCreateRequest.jsonOrThrow(request, {
|
|
@@ -279,7 +279,7 @@ class Assets {
|
|
|
279
279
|
const _response = yield core.fetcher({
|
|
280
280
|
url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `assets/${encodeURIComponent(assetId)}`),
|
|
281
281
|
method: "GET",
|
|
282
|
-
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.
|
|
282
|
+
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.1", "User-Agent": "webflow-api/3.0.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
283
283
|
contentType: "application/json",
|
|
284
284
|
requestType: "json",
|
|
285
285
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
@@ -376,7 +376,7 @@ class Assets {
|
|
|
376
376
|
const _response = yield core.fetcher({
|
|
377
377
|
url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `assets/${encodeURIComponent(assetId)}`),
|
|
378
378
|
method: "DELETE",
|
|
379
|
-
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.
|
|
379
|
+
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.1", "User-Agent": "webflow-api/3.0.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
380
380
|
contentType: "application/json",
|
|
381
381
|
requestType: "json",
|
|
382
382
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
@@ -468,7 +468,7 @@ class Assets {
|
|
|
468
468
|
const _response = yield core.fetcher({
|
|
469
469
|
url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `assets/${encodeURIComponent(assetId)}`),
|
|
470
470
|
method: "PATCH",
|
|
471
|
-
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.
|
|
471
|
+
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.1", "User-Agent": "webflow-api/3.0.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
472
472
|
contentType: "application/json",
|
|
473
473
|
requestType: "json",
|
|
474
474
|
body: serializers.AssetsUpdateRequest.jsonOrThrow(request, {
|
|
@@ -570,7 +570,7 @@ class Assets {
|
|
|
570
570
|
const _response = yield core.fetcher({
|
|
571
571
|
url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${encodeURIComponent(siteId)}/asset_folders`),
|
|
572
572
|
method: "GET",
|
|
573
|
-
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.
|
|
573
|
+
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.1", "User-Agent": "webflow-api/3.0.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
574
574
|
contentType: "application/json",
|
|
575
575
|
requestType: "json",
|
|
576
576
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
@@ -670,7 +670,7 @@ class Assets {
|
|
|
670
670
|
const _response = yield core.fetcher({
|
|
671
671
|
url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${encodeURIComponent(siteId)}/asset_folders`),
|
|
672
672
|
method: "POST",
|
|
673
|
-
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.
|
|
673
|
+
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.1", "User-Agent": "webflow-api/3.0.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
674
674
|
contentType: "application/json",
|
|
675
675
|
requestType: "json",
|
|
676
676
|
body: serializers.AssetsCreateFolderRequest.jsonOrThrow(request, {
|
|
@@ -772,7 +772,7 @@ class Assets {
|
|
|
772
772
|
const _response = yield core.fetcher({
|
|
773
773
|
url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `asset_folders/${encodeURIComponent(assetFolderId)}`),
|
|
774
774
|
method: "GET",
|
|
775
|
-
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.
|
|
775
|
+
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.1", "User-Agent": "webflow-api/3.0.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
776
776
|
contentType: "application/json",
|
|
777
777
|
requestType: "json",
|
|
778
778
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
@@ -74,7 +74,7 @@ class Collections {
|
|
|
74
74
|
const _response = yield core.fetcher({
|
|
75
75
|
url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${encodeURIComponent(siteId)}/collections`),
|
|
76
76
|
method: "GET",
|
|
77
|
-
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.
|
|
77
|
+
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.1", "User-Agent": "webflow-api/3.0.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
78
78
|
contentType: "application/json",
|
|
79
79
|
requestType: "json",
|
|
80
80
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
@@ -176,7 +176,7 @@ class Collections {
|
|
|
176
176
|
const _response = yield core.fetcher({
|
|
177
177
|
url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${encodeURIComponent(siteId)}/collections`),
|
|
178
178
|
method: "POST",
|
|
179
|
-
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.
|
|
179
|
+
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.1", "User-Agent": "webflow-api/3.0.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
180
180
|
contentType: "application/json",
|
|
181
181
|
requestType: "json",
|
|
182
182
|
body: serializers.CollectionsCreateRequest.jsonOrThrow(request, {
|
|
@@ -278,7 +278,7 @@ class Collections {
|
|
|
278
278
|
const _response = yield core.fetcher({
|
|
279
279
|
url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `collections/${encodeURIComponent(collectionId)}`),
|
|
280
280
|
method: "GET",
|
|
281
|
-
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.
|
|
281
|
+
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.1", "User-Agent": "webflow-api/3.0.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
282
282
|
contentType: "application/json",
|
|
283
283
|
requestType: "json",
|
|
284
284
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
@@ -375,7 +375,7 @@ class Collections {
|
|
|
375
375
|
const _response = yield core.fetcher({
|
|
376
376
|
url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `collections/${encodeURIComponent(collectionId)}`),
|
|
377
377
|
method: "DELETE",
|
|
378
|
-
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.
|
|
378
|
+
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.1", "User-Agent": "webflow-api/3.0.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
379
379
|
contentType: "application/json",
|
|
380
380
|
requestType: "json",
|
|
381
381
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
@@ -85,7 +85,7 @@ class Fields {
|
|
|
85
85
|
const _response = yield core.fetcher({
|
|
86
86
|
url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `collections/${encodeURIComponent(collectionId)}/fields`),
|
|
87
87
|
method: "POST",
|
|
88
|
-
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.
|
|
88
|
+
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.1", "User-Agent": "webflow-api/3.0.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
89
89
|
contentType: "application/json",
|
|
90
90
|
requestType: "json",
|
|
91
91
|
body: serializers.collections.FieldCreate.jsonOrThrow(request, {
|
|
@@ -188,7 +188,7 @@ class Fields {
|
|
|
188
188
|
const _response = yield core.fetcher({
|
|
189
189
|
url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `collections/${encodeURIComponent(collectionId)}/fields/${encodeURIComponent(fieldId)}`),
|
|
190
190
|
method: "DELETE",
|
|
191
|
-
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.
|
|
191
|
+
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.1", "User-Agent": "webflow-api/3.0.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
192
192
|
contentType: "application/json",
|
|
193
193
|
requestType: "json",
|
|
194
194
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
@@ -285,7 +285,7 @@ class Fields {
|
|
|
285
285
|
const _response = yield core.fetcher({
|
|
286
286
|
url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `collections/${encodeURIComponent(collectionId)}/fields/${encodeURIComponent(fieldId)}`),
|
|
287
287
|
method: "PATCH",
|
|
288
|
-
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.
|
|
288
|
+
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.1", "User-Agent": "webflow-api/3.0.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
289
289
|
contentType: "application/json",
|
|
290
290
|
requestType: "json",
|
|
291
291
|
body: serializers.collections.FieldUpdate.jsonOrThrow(request, {
|
|
@@ -386,7 +386,7 @@ export declare class Items {
|
|
|
386
386
|
* }]
|
|
387
387
|
* })
|
|
388
388
|
*/
|
|
389
|
-
createItems(collectionId: string, request
|
|
389
|
+
createItems(collectionId: string, request: Webflow.collections.CreateBulkCollectionItemRequestBody, requestOptions?: Items.RequestOptions): Promise<Webflow.BulkCollectionItem>;
|
|
390
390
|
/**
|
|
391
391
|
* Get details of a selected Collection Item.
|
|
392
392
|
*
|
|
@@ -434,7 +434,7 @@ export declare class Items {
|
|
|
434
434
|
*
|
|
435
435
|
* @param {string} collectionId - Unique identifier for a Collection
|
|
436
436
|
* @param {string} itemId - Unique identifier for an Item
|
|
437
|
-
* @param {Webflow.
|
|
437
|
+
* @param {Webflow.CollectionItemPatchSingle} request
|
|
438
438
|
* @param {Items.RequestOptions} requestOptions - Request-specific configuration.
|
|
439
439
|
*
|
|
440
440
|
* @throws {@link Webflow.BadRequestError}
|
|
@@ -445,11 +445,6 @@ export declare class Items {
|
|
|
445
445
|
*
|
|
446
446
|
* @example
|
|
447
447
|
* await client.collections.items.updateItem("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754", {
|
|
448
|
-
* id: "42b720ef280c7a7a3be8cabe",
|
|
449
|
-
* cmsLocaleId: "653ad57de882f528b32e810e",
|
|
450
|
-
* lastPublished: "2022-11-29T16:22:43.159Z",
|
|
451
|
-
* lastUpdated: "2022-11-17T17:19:43.282Z",
|
|
452
|
-
* createdOn: "2022-11-17T17:11:57.148Z",
|
|
453
448
|
* isArchived: false,
|
|
454
449
|
* isDraft: false,
|
|
455
450
|
* fieldData: {
|
|
@@ -458,7 +453,7 @@ export declare class Items {
|
|
|
458
453
|
* }
|
|
459
454
|
* })
|
|
460
455
|
*/
|
|
461
|
-
updateItem(collectionId: string, itemId: string, request: Webflow.
|
|
456
|
+
updateItem(collectionId: string, itemId: string, request: Webflow.CollectionItemPatchSingle, requestOptions?: Items.RequestOptions): Promise<Webflow.CollectionItem>;
|
|
462
457
|
/**
|
|
463
458
|
* Get details of a selected Collection live Item.
|
|
464
459
|
*
|
|
@@ -508,7 +503,7 @@ export declare class Items {
|
|
|
508
503
|
*
|
|
509
504
|
* @param {string} collectionId - Unique identifier for a Collection
|
|
510
505
|
* @param {string} itemId - Unique identifier for an Item
|
|
511
|
-
* @param {Webflow.
|
|
506
|
+
* @param {Webflow.CollectionItemPatchSingle} request
|
|
512
507
|
* @param {Items.RequestOptions} requestOptions - Request-specific configuration.
|
|
513
508
|
*
|
|
514
509
|
* @throws {@link Webflow.BadRequestError}
|
|
@@ -519,11 +514,6 @@ export declare class Items {
|
|
|
519
514
|
*
|
|
520
515
|
* @example
|
|
521
516
|
* await client.collections.items.updateItemLive("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754", {
|
|
522
|
-
* id: "42b720ef280c7a7a3be8cabe",
|
|
523
|
-
* cmsLocaleId: "653ad57de882f528b32e810e",
|
|
524
|
-
* lastPublished: "2022-11-29T16:22:43.159Z",
|
|
525
|
-
* lastUpdated: "2022-11-17T17:19:43.282Z",
|
|
526
|
-
* createdOn: "2022-11-17T17:11:57.148Z",
|
|
527
517
|
* isArchived: false,
|
|
528
518
|
* isDraft: false,
|
|
529
519
|
* fieldData: {
|
|
@@ -532,7 +522,7 @@ export declare class Items {
|
|
|
532
522
|
* }
|
|
533
523
|
* })
|
|
534
524
|
*/
|
|
535
|
-
updateItemLive(collectionId: string, itemId: string, request: Webflow.
|
|
525
|
+
updateItemLive(collectionId: string, itemId: string, request: Webflow.CollectionItemPatchSingle, requestOptions?: Items.RequestOptions): Promise<Webflow.CollectionItem>;
|
|
536
526
|
/**
|
|
537
527
|
* Publish an item or multiple items.
|
|
538
528
|
*
|