Skip to content

🌿 Fern Regeneration -- May 15, 2025 #263

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 11 additions & 12 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,30 +12,29 @@
"test": "jest"
},
"dependencies": {
"crypto-browserify": "^3.12.0",
"url-join": "4.0.1",
"form-data": "^4.0.0",
"formdata-node": "^6.0.3",
"js-base64": "3.7.2",
"node-fetch": "2.7.0",
"qs": "6.11.2",
"readable-stream": "^4.5.2",
"url-join": "4.0.1"
"js-base64": "3.7.2",
"crypto-browserify": "^3.12.0"
},
"devDependencies": {
"@types/jest": "29.5.5",
"@types/node": "17.0.33",
"@types/node-fetch": "2.6.9",
"@types/url-join": "4.0.1",
"@types/qs": "6.9.8",
"@types/node-fetch": "2.6.9",
"@types/readable-stream": "^4.0.15",
"@types/url-join": "4.0.1",
"webpack": "^5.94.0",
"ts-loader": "^9.3.1",
"jest": "29.7.0",
"@types/jest": "29.5.5",
"ts-jest": "29.1.1",
"jest-environment-jsdom": "29.7.0",
"jest-fetch-mock": "^3.0.3",
"@types/node": "17.0.33",
"prettier": "2.7.1",
"ts-jest": "29.1.1",
"ts-loader": "^9.3.1",
"typescript": "4.6.4",
"webpack": "^5.94.0"
"typescript": "4.6.4"
},
"browser": {
"fs": false,
Expand Down
4 changes: 4 additions & 0 deletions reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -5192,6 +5192,7 @@ Required scope | `cms:write`

```typescript
await client.collections.fields.create("580e63fc8c9a982ac9b8b745", {
id: "562ac0395358780a1f5e6fbc",
isEditable: true,
isRequired: false,
type: "RichText",
Expand Down Expand Up @@ -5859,6 +5860,9 @@ Required scope | `CMS:write`

```typescript
await client.collections.items.createItemLive("580e63fc8c9a982ac9b8b745", {
lastPublished: "2023-03-17T18:47:35.560Z",
lastUpdated: "2023-03-17T18:47:35.560Z",
createdOn: "2023-03-17T18:47:35.560Z",
isArchived: false,
isDraft: false,
fieldData: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ export class Fields {
*
* @example
* await client.collections.fields.create("580e63fc8c9a982ac9b8b745", {
* id: "562ac0395358780a1f5e6fbc",
* isEditable: true,
* isRequired: false,
* type: "RichText",
Expand All @@ -62,6 +63,7 @@ export class Fields {
*
* @example
* await client.collections.fields.create("580e63fc8c9a982ac9b8b745", {
* id: "562ac0395358780a1f5e6fbc",
* isEditable: true,
* isRequired: false,
* type: "Option",
Expand All @@ -80,6 +82,7 @@ export class Fields {
*
* @example
* await client.collections.fields.create("580e63fc8c9a982ac9b8b745", {
* id: "562ac0395358780a1f5e6fbd",
* isEditable: true,
* isRequired: false,
* type: "Reference",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -841,6 +841,9 @@ export class Items {
*
* @example
* await client.collections.items.createItemLive("580e63fc8c9a982ac9b8b745", {
* lastPublished: "2023-03-17T18:47:35.560Z",
* lastUpdated: "2023-03-17T18:47:35.560Z",
* createdOn: "2023-03-17T18:47:35.560Z",
* isArchived: false,
* isDraft: false,
* fieldData: {
Expand All @@ -852,13 +855,19 @@ export class Items {
* @example
* await client.collections.items.createItemLive("580e63fc8c9a982ac9b8b745", {
* items: [{
* lastPublished: "2023-03-17T18:47:35.560Z",
* lastUpdated: "2023-03-17T18:47:35.560Z",
* createdOn: "2023-03-17T18:47:35.560Z",
* isArchived: false,
* isDraft: false,
* fieldData: {
* name: "Senior Data Analyst",
* slug: "senior-data-analyst"
* }
* }, {
* lastPublished: "2023-03-17T18:47:35.560Z",
* lastUpdated: "2023-03-17T18:47:35.560Z",
* createdOn: "2023-03-17T18:47:35.560Z",
* isArchived: false,
* isDraft: false,
* fieldData: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@
import * as Webflow from "../../../index";

export interface ProductsCreateSkuResponse {
skus?: Webflow.Sku[];
skus: Webflow.Sku[];
}
20 changes: 10 additions & 10 deletions src/api/types/Asset.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,25 +9,25 @@ import * as Webflow from "../index";
*/
export interface Asset {
/** Unique identifier for this asset */
id?: string;
id: string;
/** File format type */
contentType?: string;
contentType: string;
/** size in bytes */
size?: number;
size: number;
/** Unique identifier for the site that hosts this asset */
siteId?: string;
siteId: string;
/** Link to the asset */
hostedUrl?: string;
hostedUrl: string;
/** Original file name at the time of upload */
originalFileName?: string;
originalFileName: string;
/** Display name of the asset */
displayName?: string;
displayName: string;
/** Date the asset metadata was last updated */
lastUpdated?: Date;
lastUpdated: Date;
/** Date the asset metadata was created */
createdOn?: Date;
createdOn: Date;
/** A list of [asset variants](https://help.webflow.com/hc/en-us/articles/33961378697107-Responsive-images) created by Webflow to serve your site responsively. */
variants?: Webflow.AssetVariant[];
variants: Webflow.AssetVariant[];
/** The visual description of the asset */
altText?: string;
}
14 changes: 7 additions & 7 deletions src/api/types/AssetVariant.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,19 @@
*/
export interface AssetVariant {
/** URL of where the asset variant is hosted */
hostedUrl?: string;
hostedUrl: string;
/** Original file name of the variant */
originalFileName?: string;
originalFileName: string;
/** Display name of the variant */
displayName?: string;
displayName: string;
/** format of the variant */
format?: string;
format: string;
/** Width in pixels */
width?: number;
width: number;
/** Height in pixels */
height?: number;
height: number;
/** Value between 0 and 100 representing the image quality */
quality?: number;
quality: number;
/** Any associated validation errors */
error?: string;
}
4 changes: 2 additions & 2 deletions src/api/types/Collection.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ export interface Collection {
/** Unique identifier for a Collection */
id: string;
/** Name given to the Collection */
displayName?: string;
displayName: string;
/** The name of one Item in Collection (e.g. ”Blog Post” if the Collection is called “Blog Posts”) */
singularName?: string;
singularName: string;
/** Slug of Collection in Site URL structure */
slug?: string;
/** The date the collection was created */
Expand Down
6 changes: 3 additions & 3 deletions src/api/types/CollectionItem.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ export interface CollectionItem {
/** Identifier for the locale of the CMS item */
cmsLocaleId?: string;
/** The date the item was last published */
lastPublished?: string;
lastPublished: string;
/** The date the item was last updated */
lastUpdated?: string;
lastUpdated: string;
/** The date the item was created */
createdOn?: string;
createdOn: string;
/** Boolean determining if the Item is set to archived */
isArchived?: boolean;
/** Boolean determining if the Item is set to draft */
Expand Down
6 changes: 3 additions & 3 deletions src/api/types/ComponentNode.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ import * as Webflow from "../index";
*/
export interface ComponentNode {
/** The unique identifier of the component instance node */
id?: string;
id: string;
/** The unique identifier of the component */
componentId?: string;
componentId: string;
/** List of component properties with overrides for a component instance. */
propertyOverrides?: Webflow.ComponentProperty[];
propertyOverrides: Webflow.ComponentProperty[];
}
4 changes: 2 additions & 2 deletions src/api/types/ImageNode.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ import * as Webflow from "../index";
*/
export interface ImageNode {
/** Node UUID */
id?: string;
id: string;
/** The image details of the node */
image?: Webflow.ImageNodeImage;
image: Webflow.ImageNodeImage;
/** The custom attributes of the node */
attributes?: Record<string, string>;
}
6 changes: 3 additions & 3 deletions src/api/types/Pagination.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
*/
export interface Pagination {
/** The limit used for pagination */
limit?: number;
limit: number;
/** The offset used for pagination */
offset?: number;
offset: number;
/** The total number of records */
total?: number;
total: number;
}
4 changes: 2 additions & 2 deletions src/api/types/TextNode.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ import * as Webflow from "../index";
*/
export interface TextNode {
/** Node UUID */
id?: string;
id: string;
/** The text content of the node */
text?: Webflow.TextNodeText;
text: Webflow.TextNodeText;
/** The custom attributes of the node */
attributes?: Record<string, string>;
}
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ export const ProductsCreateSkuResponse: core.serialization.ObjectSchema<
serializers.ProductsCreateSkuResponse.Raw,
Webflow.ProductsCreateSkuResponse
> = core.serialization.object({
skus: core.serialization.list(Sku).optional(),
skus: core.serialization.list(Sku),
});

export declare namespace ProductsCreateSkuResponse {
interface Raw {
skus?: Sku.Raw[] | null;
skus: Sku.Raw[];
}
}
40 changes: 20 additions & 20 deletions src/serialization/types/Asset.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,31 +8,31 @@ import * as core from "../../core";
import { AssetVariant } from "./AssetVariant";

export const Asset: core.serialization.ObjectSchema<serializers.Asset.Raw, Webflow.Asset> = core.serialization.object({
id: core.serialization.string().optional(),
contentType: core.serialization.string().optional(),
size: core.serialization.number().optional(),
siteId: core.serialization.string().optional(),
hostedUrl: core.serialization.string().optional(),
originalFileName: core.serialization.string().optional(),
displayName: core.serialization.string().optional(),
lastUpdated: core.serialization.date().optional(),
createdOn: core.serialization.date().optional(),
variants: core.serialization.list(AssetVariant).optional(),
id: core.serialization.string(),
contentType: core.serialization.string(),
size: core.serialization.number(),
siteId: core.serialization.string(),
hostedUrl: core.serialization.string(),
originalFileName: core.serialization.string(),
displayName: core.serialization.string(),
lastUpdated: core.serialization.date(),
createdOn: core.serialization.date(),
variants: core.serialization.list(AssetVariant),
altText: core.serialization.string().optional(),
});

export declare namespace Asset {
interface Raw {
id?: string | null;
contentType?: string | null;
size?: number | null;
siteId?: string | null;
hostedUrl?: string | null;
originalFileName?: string | null;
displayName?: string | null;
lastUpdated?: string | null;
createdOn?: string | null;
variants?: AssetVariant.Raw[] | null;
id: string;
contentType: string;
size: number;
siteId: string;
hostedUrl: string;
originalFileName: string;
displayName: string;
lastUpdated: string;
createdOn: string;
variants: AssetVariant.Raw[];
altText?: string | null;
}
}
28 changes: 14 additions & 14 deletions src/serialization/types/AssetVariant.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,25 @@ import * as core from "../../core";

export const AssetVariant: core.serialization.ObjectSchema<serializers.AssetVariant.Raw, Webflow.AssetVariant> =
core.serialization.object({
hostedUrl: core.serialization.string().optional(),
originalFileName: core.serialization.string().optional(),
displayName: core.serialization.string().optional(),
format: core.serialization.string().optional(),
width: core.serialization.number().optional(),
height: core.serialization.number().optional(),
quality: core.serialization.number().optional(),
hostedUrl: core.serialization.string(),
originalFileName: core.serialization.string(),
displayName: core.serialization.string(),
format: core.serialization.string(),
width: core.serialization.number(),
height: core.serialization.number(),
quality: core.serialization.number(),
error: core.serialization.string().optional(),
});

export declare namespace AssetVariant {
interface Raw {
hostedUrl?: string | null;
originalFileName?: string | null;
displayName?: string | null;
format?: string | null;
width?: number | null;
height?: number | null;
quality?: number | null;
hostedUrl: string;
originalFileName: string;
displayName: string;
format: string;
width: number;
height: number;
quality: number;
error?: string | null;
}
}
8 changes: 4 additions & 4 deletions src/serialization/types/Collection.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ import { Field } from "./Field";
export const Collection: core.serialization.ObjectSchema<serializers.Collection.Raw, Webflow.Collection> =
core.serialization.object({
id: core.serialization.string(),
displayName: core.serialization.string().optional(),
singularName: core.serialization.string().optional(),
displayName: core.serialization.string(),
singularName: core.serialization.string(),
slug: core.serialization.string().optional(),
createdOn: core.serialization.date().optional(),
lastUpdated: core.serialization.date().optional(),
Expand All @@ -21,8 +21,8 @@ export const Collection: core.serialization.ObjectSchema<serializers.Collection.
export declare namespace Collection {
interface Raw {
id: string;
displayName?: string | null;
singularName?: string | null;
displayName: string;
singularName: string;
slug?: string | null;
createdOn?: string | null;
lastUpdated?: string | null;
Expand Down
Loading
Loading