Skip to content
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
4 changes: 2 additions & 2 deletions .fern/metadata.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"cliVersion": "4.22.0",
"cliVersion": "4.65.1",
"generatorName": "fernapi/fern-typescript-node-sdk",
"generatorVersion": "3.53.13",
"generatorConfig": {
Expand Down Expand Up @@ -34,6 +34,6 @@
}
}
},
"originGitCommit": "f0174d404a2635415e858ef151cf9202df3e3d02",
"originGitCommit": "0eb950072ce0d6e80e3c587f693c9d4beb4f6f76",
"sdkVersion": "3.3.5"
}
80 changes: 0 additions & 80 deletions .github/workflows/socket_reachability.yml

This file was deleted.

25 changes: 20 additions & 5 deletions reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -537,6 +537,8 @@ Publishes a site to one or more more domains.

To publish to a specific custom domain, use the domain IDs from the [Get Custom Domains](/data/reference/sites/get-custom-domain) endpoint.

You must include at least one of the `customDomains` or `publishToWebflowSubdomain` properties in the request body.

<Note title="Rate limit: 1 publish per minute">This endpoint has a specific rate limit of one successful publish queue per minute.</Note>

Required scope | `sites:write`
Expand Down Expand Up @@ -2071,6 +2073,7 @@ Required scope | `assets:read`

```typescript
await client.assets.list("580e63e98c9a982ac9b8b741", {
localeId: "65427cf400e02b306eaa04a0",
offset: 1,
limit: 1
});
Expand Down Expand Up @@ -2202,7 +2205,7 @@ await client.assets.create("580e63e98c9a982ac9b8b741", {
</dl>
</details>

<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">get</a>(asset_id) -> Webflow.Asset</code></summary>
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">get</a>(asset_id, { ...params }) -> Webflow.Asset</code></summary>
<dl>
<dd>

Expand Down Expand Up @@ -2231,7 +2234,9 @@ Required scope | `assets:read`
<dd>

```typescript
await client.assets.get("580e63fc8c9a982ac9b8b745");
await client.assets.get("580e63fc8c9a982ac9b8b745", {
localeId: "65427cf400e02b306eaa04a0"
});

```
</dd>
Expand All @@ -2255,6 +2260,14 @@ await client.assets.get("580e63fc8c9a982ac9b8b745");
<dl>
<dd>

**request:** `Webflow.AssetsGetRequest`

</dd>
</dl>

<dl>
<dd>

**requestOptions:** `AssetsClient.RequestOptions`

</dd>
Expand Down Expand Up @@ -2361,7 +2374,9 @@ Required scope | `assets:write`
<dd>

```typescript
await client.assets.update("580e63fc8c9a982ac9b8b745");
await client.assets.update("580e63fc8c9a982ac9b8b745", {
localeId: "65427cf400e02b306eaa04a0"
});

```
</dd>
Expand Down Expand Up @@ -4874,7 +4889,7 @@ await client.collections.items.listItems("580e63fc8c9a982ac9b8b745", {
limit: 1,
name: "name",
slug: "slug",
sortBy: "lastPublished",
sortBy: "createdOn",
sortOrder: "asc"
});

Expand Down Expand Up @@ -5270,7 +5285,7 @@ await client.collections.items.listItemsLive("580e63fc8c9a982ac9b8b745", {
limit: 1,
name: "name",
slug: "slug",
sortBy: "lastPublished",
sortBy: "createdOn",
sortOrder: "asc"
});

Expand Down
4 changes: 2 additions & 2 deletions src/BaseClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ export function normalizeClientOptions<T extends BaseClientOptions = BaseClientO
{
"X-Fern-Language": "JavaScript",
"X-Fern-SDK-Name": "webflow-api",
"X-Fern-SDK-Version": "3.3.2",
"User-Agent": "webflow-api/3.3.2",
"X-Fern-SDK-Version": "3.3.5",
"User-Agent": "webflow-api/3.3.5",
"X-Fern-Runtime": core.RUNTIME.type,
"X-Fern-Runtime-Version": core.RUNTIME.version,
},
Expand Down
31 changes: 24 additions & 7 deletions src/api/resources/assets/client/Client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ export class AssetsClient {
*
* @example
* await client.assets.list("580e63e98c9a982ac9b8b741", {
* localeId: "65427cf400e02b306eaa04a0",
* offset: 1,
* limit: 1
* })
Expand All @@ -60,8 +61,9 @@ export class AssetsClient {
request: Webflow.AssetsListRequest = {},
requestOptions?: AssetsClient.RequestOptions,
): Promise<core.WithRawResponse<Webflow.Assets>> {
const { offset, limit } = request;
const { localeId, offset, limit } = request;
const _queryParams: Record<string, unknown> = {
localeId,
offset,
limit,
};
Expand Down Expand Up @@ -312,6 +314,7 @@ export class AssetsClient {
* Required scope | `assets:read`
*
* @param {string} asset_id - Unique identifier for an Asset on a site
* @param {Webflow.AssetsGetRequest} request
* @param {AssetsClient.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link Webflow.BadRequestError}
Expand All @@ -321,19 +324,27 @@ export class AssetsClient {
* @throws {@link Webflow.InternalServerError}
*
* @example
* await client.assets.get("580e63fc8c9a982ac9b8b745")
* await client.assets.get("580e63fc8c9a982ac9b8b745", {
* localeId: "65427cf400e02b306eaa04a0"
* })
*/
public get(
asset_id: string,
request: Webflow.AssetsGetRequest = {},
requestOptions?: AssetsClient.RequestOptions,
): core.HttpResponsePromise<Webflow.Asset> {
return core.HttpResponsePromise.fromPromise(this.__get(asset_id, requestOptions));
return core.HttpResponsePromise.fromPromise(this.__get(asset_id, request, requestOptions));
}

private async __get(
asset_id: string,
request: Webflow.AssetsGetRequest = {},
requestOptions?: AssetsClient.RequestOptions,
): Promise<core.WithRawResponse<Webflow.Asset>> {
const { localeId } = request;
const _queryParams: Record<string, unknown> = {
localeId,
};
const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest();
const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
_authRequest.headers,
Expand All @@ -349,7 +360,7 @@ export class AssetsClient {
),
method: "GET",
headers: _headers,
queryParameters: requestOptions?.queryParams,
queryParameters: { ..._queryParams, ...requestOptions?.queryParams },
timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
abortSignal: requestOptions?.abortSignal,
Expand Down Expand Up @@ -556,7 +567,9 @@ export class AssetsClient {
* @throws {@link Webflow.InternalServerError}
*
* @example
* await client.assets.update("580e63fc8c9a982ac9b8b745")
* await client.assets.update("580e63fc8c9a982ac9b8b745", {
* localeId: "65427cf400e02b306eaa04a0"
* })
*/
public update(
asset_id: string,
Expand All @@ -571,6 +584,10 @@ export class AssetsClient {
request: Webflow.AssetsUpdateRequest = {},
requestOptions?: AssetsClient.RequestOptions,
): Promise<core.WithRawResponse<Webflow.Asset>> {
const { localeId, ..._body } = request;
const _queryParams: Record<string, unknown> = {
localeId,
};
const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest();
const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
_authRequest.headers,
Expand All @@ -587,9 +604,9 @@ export class AssetsClient {
method: "PATCH",
headers: _headers,
contentType: "application/json",
queryParameters: requestOptions?.queryParams,
queryParameters: { ..._queryParams, ...requestOptions?.queryParams },
requestType: "json",
body: serializers.AssetsUpdateRequest.jsonOrThrow(request, {
body: serializers.AssetsUpdateRequest.jsonOrThrow(_body, {
unrecognizedObjectKeys: "passthrough",
allowUnrecognizedUnionMembers: true,
allowUnrecognizedEnumValues: true,
Expand Down
16 changes: 16 additions & 0 deletions src/api/resources/assets/client/requests/AssetsGetRequest.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
// This file was auto-generated by Fern from our API Definition.

/**
* @example
* {
* localeId: "65427cf400e02b306eaa04a0"
* }
*/
export interface AssetsGetRequest {
/**
* Unique identifier for a specific Locale.
*
* [Learn more about localization.](/data/v2.0.0/docs/working-with-localization)
*/
localeId?: string;
}
7 changes: 7 additions & 0 deletions src/api/resources/assets/client/requests/AssetsListRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,18 @@
/**
* @example
* {
* localeId: "65427cf400e02b306eaa04a0",
* offset: 1,
* limit: 1
* }
*/
export interface AssetsListRequest {
/**
* Unique identifier for a specific Locale.
*
* [Learn more about localization.](/data/v2.0.0/docs/working-with-localization)
*/
localeId?: string;
/** Offset used for pagination if the results have more than limit records */
offset?: number;
/** Maximum number of records to be returned (max limit: 100) */
Expand Down
14 changes: 11 additions & 3 deletions src/api/resources/assets/client/requests/AssetsUpdateRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,19 @@

/**
* @example
* {}
* {
* localeId: "65427cf400e02b306eaa04a0"
* }
*/
export interface AssetsUpdateRequest {
/** Unique identifier for a specific locale. Applicable, when using localization. */
/**
* Unique identifier for a specific Locale.
*
* [Learn more about localization.](/data/v2.0.0/docs/working-with-localization)
*/
localeId?: string;
/** A human readable name for the asset */
/** A human readable name for the asset. This value is not localizable. */
displayName?: string;
/** Alternate text describing the image */
altText?: string;
}
1 change: 1 addition & 0 deletions src/api/resources/assets/client/requests/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
export type { AssetsCreateFolderRequest } from "./AssetsCreateFolderRequest";
export type { AssetsCreateRequest } from "./AssetsCreateRequest";
export type { AssetsGetRequest } from "./AssetsGetRequest";
export type { AssetsListRequest } from "./AssetsListRequest";
export type { AssetsUpdateRequest } from "./AssetsUpdateRequest";
Loading