@highlightxyz/sdk 0.3.0 → 0.4.0

package/lib/v1/gen/sdk.gen.js

@@ -1,7 +1,7 @@
 // This file is auto-generated by @hey-api/openapi-ts
 import { buildClientParams, } from "./client";
 import { client } from "./client.gen";
-import { CaptureSettingsTrigger, CollectionType, ContractStandard, GateMatchMode, GenerativeEditionType, MediaKind, MediaScope, SaleAccessMode, SaleType, SelectorType, } from "./types.gen";
+import { CaptureSettingsTrigger, CollectionType, ContractStandard, GateMatchMode, GenerativeEditionType, MediaPurpose, SaleAccessMode, SaleType, SelectorType, } from "./types.gen";
 class HeyApiClient {
     client;
     constructor(args) {
@@ -62,8 +62,6 @@ export class Collection extends HeyApiClient {
                     { in: "body", key: "description" },
                     { in: "body", key: "contractId" },
                     { in: "body", key: "contract" },
-                    { in: "body", key: "logoMediaId" },
-                    { in: "body", key: "image" },
                     { in: "body", key: "type" },
                     { in: "body", key: "royalty" },
                     { in: "body", key: "tokenManager" },
@@ -158,16 +156,70 @@ export class Collection extends HeyApiClient {
     /**
      * Archive collection metadata to Arweave
      *
-     * Archive the collection's token-metadata directory to Arweave. The operation is idempotent and does not change the contract's base URI.
+     * Archive the collection's current token-metadata directory snapshot to Arweave. The operation is archive-once, leaves the R2 directory appendable, and does not change the contract's base URI.
      */
-    finalizeBaseUri(parameters, options) {
+    archiveBaseUri(parameters, options) {
         const params = buildClientParams([parameters], [{ args: [{ in: "path", key: "highlightId" }] }]);
         return (options?.client ?? this.client).post({
-            url: "/collection/{highlightId}/finalize-base-uri",
+            url: "/collection/{highlightId}/archive-base-uri",
             ...options,
             ...params,
         });
     }
+    /**
+     * Create a collection media upload session
+     *
+     * Start an upload for one of the collection media purposes and return an upload URL with the required request headers.
+     */
+    createMediaUploadSession(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "path", key: "highlightId" },
+                    { in: "body", key: "purpose" },
+                    { in: "body", key: "fileName" },
+                    { in: "body", key: "mimeType" },
+                    { in: "body", key: "fileSize" },
+                    { in: "body", key: "contentHash" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).post({
+            url: "/collection/{highlightId}/media/upload-session",
+            ...options,
+            ...params,
+            headers: {
+                "Content-Type": "application/json",
+                ...options?.headers,
+                ...params.headers,
+            },
+        });
+    }
+    /**
+     * Update collection display metadata
+     *
+     * Update a collection's name, description, and logo. Every field is optional; absent fields are left unchanged.
+     */
+    updateMetadata(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "path", key: "highlightId" },
+                    { key: "collectionUpdateMetadataInput", map: "body" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).patch({
+            url: "/collection/{highlightId}/metadata",
+            ...options,
+            ...params,
+            headers: {
+                "Content-Type": "application/json",
+                ...options?.headers,
+                ...params.headers,
+            },
+        });
+    }
     /**
      * Update generative draft details
      *
@@ -278,7 +330,6 @@ export class Collection extends HeyApiClient {
                     { in: "body", key: "paymentRecipient" },
                     { in: "body", key: "accessMode" },
                     { in: "body", key: "gateId" },
-                    { in: "body", key: "gasSponsored" },
                     { in: "body", key: "mechanicId" },
                     { in: "body", key: "typeConfig" },
                     { in: "body", key: "collectorMessage" },
@@ -570,6 +621,51 @@ export class Collection extends HeyApiClient {
             ...params,
         });
     }
+    /**
+     * Get Dutch auction standing
+     *
+     * Get a Dutch auction's descending price ladder, its clock, and its supply/escrow state. An authenticated response also includes the caller's purchase position and any rebate owed. Amounts use the currency's raw on-chain base unit.
+     */
+    dutchAuctionStanding(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "path", key: "highlightId" },
+                    { in: "path", key: "saleId" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).get({
+            url: "/collection/{highlightId}/sales/{saleId}/dutch",
+            ...options,
+            ...params,
+        });
+    }
+    /**
+     * Claim a Dutch auction rebate
+     *
+     * Build a transaction that refunds the caller the difference between what they paid and the auction's final clearing price. Only available once the auction has reached its resting price or sold out.
+     */
+    claimDutchRebate(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "path", key: "highlightId" },
+                    { in: "body", key: "saleId" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).post({
+            url: "/collection/{highlightId}/sales/dutch/rebate",
+            ...options,
+            ...params,
+            headers: {
+                "Content-Type": "application/json",
+                ...options?.headers,
+                ...params.headers,
+            },
+        });
+    }
     /**
      * Initiate collection deployment
      *
@@ -716,6 +812,17 @@ export class Config extends HeyApiClient {
             ...options,
         });
     }
+    /**
+     * Get media delivery hosts
+     *
+     * Public hosts a client uses to build media URLs from a storage location's provider and reference.
+     */
+    mediaHosts(options) {
+        return (options?.client ?? this.client).get({
+            url: "/config/media-hosts",
+            ...options,
+        });
+    }
     /**
      * Get system contract
      *
@@ -1124,55 +1231,14 @@ export class Mechanic extends HeyApiClient {
 }
 export class Media extends HeyApiClient {
     /**
-     * Create media upload session
+     * Finalize a direct media upload
      *
-     * Create a pending media asset and return an upload URL with the required request headers.
+     * Verify the exact object, size, content type, and R2 SHA-256 checksum before exposing it or starting directory extraction. Duplicate calls are idempotent.
      */
-    createUploadSession(parameters, options) {
-        const params = buildClientParams([parameters], [
-            {
-                args: [
-                    { in: "body", key: "kind" },
-                    { in: "body", key: "scope" },
-                    { in: "body", key: "fileName" },
-                    { in: "body", key: "mimeType" },
-                    { in: "body", key: "fileSize" },
-                ],
-            },
-        ]);
-        return (options?.client ?? this.client).post({
-            url: "/media/upload-session",
-            ...options,
-            ...params,
-            headers: {
-                "Content-Type": "application/json",
-                ...options?.headers,
-                ...params.headers,
-            },
-        });
-    }
-    /**
-     * Upload media bytes
-     *
-     * Write the request body to storage and start processing. Files return Ready; directories return Processing while extraction runs.
-     */
-    upload(parameters, options) {
-        const params = buildClientParams([parameters], [{ args: [{ in: "path", key: "mediaId" }] }]);
-        return (options?.client ?? this.client).put({
-            url: "/media/{mediaId}/upload",
-            ...options,
-            ...params,
-        });
-    }
-    /**
-     * Process a media asset
-     *
-     * Retry processing for a failed directory. The operation is idempotent and leaves Ready or Processing assets unchanged.
-     */
-    process(parameters, options) {
+    finalizeUpload(parameters, options) {
         const params = buildClientParams([parameters], [{ args: [{ in: "path", key: "mediaId" }] }]);
         return (options?.client ?? this.client).post({
-            url: "/media/{mediaId}/process",
+            url: "/media/{mediaId}/finalize",
             ...options,
             ...params,
         });
@@ -1201,7 +1267,7 @@ export class Media extends HeyApiClient {
     /**
      * Delete a media asset
      *
-     * Delete a media record and its R2 objects. An immutable Arweave archive remains available. Returns 409 when a contract or generative collection still references the media.
+     * Delete a media record and its R2 objects. Referenced media returns 409. Immutable Arweave archives remain available.
      */
     delete(parameters, options) {
         const params = buildClientParams([parameters], [{ args: [{ in: "path", key: "mediaId" }] }]);
@@ -1300,6 +1366,68 @@ export class Tx extends HeyApiClient {
         });
     }
 }
+export class Siwe extends HeyApiClient {
+    /**
+     * Issue a SIWE nonce
+     *
+     * Issue a single-use, short-lived nonce for the `nonce` field of a SIWE (EIP-4361) message.
+     */
+    nonce(options) {
+        return (options?.client ?? this.client).post({ url: "/user/signin/siwe/nonce", ...options });
+    }
+}
+export class User extends HeyApiClient {
+    /**
+     * Create a user media upload session
+     *
+     * Start an upload for one of the user media purposes and return an upload URL with the required request headers.
+     */
+    createMediaUploadSession(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "body", key: "purpose" },
+                    { in: "body", key: "fileName" },
+                    { in: "body", key: "mimeType" },
+                    { in: "body", key: "fileSize" },
+                    { in: "body", key: "contentHash" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).post({
+            url: "/user/media/upload-session",
+            ...options,
+            ...params,
+            headers: {
+                "Content-Type": "application/json",
+                ...options?.headers,
+                ...params.headers,
+            },
+        });
+    }
+    /**
+     * Sign in
+     *
+     * Exchange a Privy ID token or signed SIWE message for Highlight access and refresh tokens.
+     */
+    signin(parameters, options) {
+        const params = buildClientParams([parameters], [{ args: [{ key: "body", map: "body" }] }]);
+        return (options?.client ?? this.client).post({
+            url: "/user/signin",
+            ...options,
+            ...params,
+            headers: {
+                "Content-Type": "application/json",
+                ...options?.headers,
+                ...params.headers,
+            },
+        });
+    }
+    _siwe;
+    get siwe() {
+        return (this._siwe ??= new Siwe({ client: this.client }));
+    }
+}
 export class Profile extends HeyApiClient {
     /**
      * Get authenticated profile
@@ -1312,7 +1440,7 @@ export class Profile extends HeyApiClient {
     /**
      * Update authenticated profile
      *
-     * Update private profile fields. Avatar media must be an owned, ready User-scope image file.
+     * Update private profile fields. Avatar media must be an owned, ready User-namespace image file.
      */
     update(parameters, options) {
         const params = buildClientParams([parameters], [
@@ -1375,40 +1503,6 @@ export class Profile extends HeyApiClient {
         });
     }
 }
-export class Siwe extends HeyApiClient {
-    /**
-     * Issue a SIWE nonce
-     *
-     * Issue a single-use, short-lived nonce for the `nonce` field of a SIWE (EIP-4361) message.
-     */
-    nonce(options) {
-        return (options?.client ?? this.client).post({ url: "/user/signin/siwe/nonce", ...options });
-    }
-}
-export class User extends HeyApiClient {
-    /**
-     * Sign in
-     *
-     * Exchange a Privy ID token or signed SIWE message for Highlight access and refresh tokens.
-     */
-    signin(parameters, options) {
-        const params = buildClientParams([parameters], [{ args: [{ key: "body", map: "body" }] }]);
-        return (options?.client ?? this.client).post({
-            url: "/user/signin",
-            ...options,
-            ...params,
-            headers: {
-                "Content-Type": "application/json",
-                ...options?.headers,
-                ...params.headers,
-            },
-        });
-    }
-    _siwe;
-    get siwe() {
-        return (this._siwe ??= new Siwe({ client: this.client }));
-    }
-}
 export class ApiKey extends HeyApiClient {
     /**
      * List API keys
@@ -1559,14 +1653,14 @@ export class HighlightClient extends HeyApiClient {
     get tx() {
         return (this._tx ??= new Tx({ client: this.client }));
     }
-    _profile;
-    get profile() {
-        return (this._profile ??= new Profile({ client: this.client }));
-    }
     _user;
     get user() {
         return (this._user ??= new User({ client: this.client }));
     }
+    _profile;
+    get profile() {
+        return (this._profile ??= new Profile({ client: this.client }));
+    }
     _apiKey;
     get apiKey() {
         return (this._apiKey ??= new ApiKey({ client: this.client }));