diff --git a/.fern/metadata.json b/.fern/metadata.json
index 090b4eb..ff00807 100644
--- a/.fern/metadata.json
+++ b/.fern/metadata.json
@@ -9,10 +9,10 @@
"version": "1.21"
}
},
- "originGitCommit": "32635f40577b214f6a6b3189a2271425c3a574fd",
+ "originGitCommit": "1345fb7a45ee660a352774d29decce25cb54b8ea",
"originGitCommitIsDirty": false,
"invokedBy": "ci",
- "requestedVersion": "3.0.0-next.6",
+ "requestedVersion": "3.0.0-next.7",
"ciProvider": "github",
- "sdkVersion": "v3.0.0-next.6"
+ "sdkVersion": "v3.0.0-next.7"
}
\ No newline at end of file
diff --git a/cloudpdf-generation.json b/cloudpdf-generation.json
index 38a3488..94c64d8 100644
--- a/cloudpdf-generation.json
+++ b/cloudpdf-generation.json
@@ -1,12 +1,12 @@
{
"language": "go",
- "canonicalVersion": "3.0.0-next.6",
- "sdkVersion": "3.0.0-next.6",
+ "canonicalVersion": "3.0.0-next.7",
+ "sdkVersion": "3.0.0-next.7",
"source": {
"repository": "embedpdf/embed-pdf-viewer",
"openapi": "cloudpdf/contract/openapi.json",
- "openapiSha256": "b3e236a932673e27e05825352e1bc3675369d7505040bf7d7760e542aae8d38d",
- "gitCommit": "32635f40577b214f6a6b3189a2271425c3a574fd",
+ "openapiSha256": "f6fc610bfd193f278a7e8ec063d9e96b8fef86bdec7ade5e7bc4b19879673147",
+ "gitCommit": "1345fb7a45ee660a352774d29decce25cb54b8ea",
"gitCommitIsDirty": false
},
"fern": {
diff --git a/core/request_option.go b/core/request_option.go
index 1c4ca4c..9de774f 100644
--- a/core/request_option.go
+++ b/core/request_option.go
@@ -65,8 +65,8 @@ func (r *RequestOptions) cloneHeader() http.Header {
headers := r.HTTPHeader.Clone()
headers.Set("X-Fern-Language", "Go")
headers.Set("X-Fern-SDK-Name", "github.com/embedpdf/cloudpdf-sdk-go/v3")
- headers.Set("X-Fern-SDK-Version", "v3.0.0-next.6")
- headers.Set("User-Agent", "github.com/embedpdf/cloudpdf-sdk-go/v3/3.0.0-next.6")
+ headers.Set("X-Fern-SDK-Version", "v3.0.0-next.7")
+ headers.Set("User-Agent", "github.com/embedpdf/cloudpdf-sdk-go/v3/3.0.0-next.7")
return headers
}
diff --git a/documents.go b/documents.go
index 96d5f3c..10efa35 100644
--- a/documents.go
+++ b/documents.go
@@ -188,14 +188,19 @@ var (
)
type DocumentsImportFromRequest struct {
- TenantID string `json:"-" url:"-"`
- Source *DocumentsImportFromRequestSource `json:"source" url:"-"`
- Expected *DocumentsImportFromRequestExpected `json:"expected,omitempty" url:"-"`
- Metadata map[string]any `json:"metadata,omitempty" url:"-"`
- IdempotencyKey *string `json:"idempotencyKey,omitempty" url:"-"`
- DedupMode *DocumentsImportFromRequestDedupMode `json:"dedupMode,omitempty" url:"-"`
- DocID *string `json:"docId,omitempty" url:"-"`
- Mode *DocumentsImportFromRequestMode `json:"mode,omitempty" url:"-"`
+ TenantID string `json:"-" url:"-"`
+ // Where CloudPDF pulls the bytes from. The two shapes differ in WHO supplies the authority to read, not in which storage vendor holds the file.
+ Source *DocumentsImportFromRequestSource `json:"source" url:"-"`
+ // Integrity pins, enforced when present. When absent, the server-observed values become authoritative.
+ Expected *DocumentsImportFromRequestExpected `json:"expected,omitempty" url:"-"`
+ Metadata map[string]any `json:"metadata,omitempty" url:"-"`
+ // Retrying with the same key resumes the same document rather than importing a second copy — including after a 502.
+ IdempotencyKey *string `json:"idempotencyKey,omitempty" url:"-"`
+ // always-create (default) creates a new document every time. reuse-existing returns a document that already holds the same content instead of storing it twice.
+ DedupMode *DocumentsImportFromRequestDedupMode `json:"dedupMode,omitempty" url:"-"`
+ DocID *string `json:"docId,omitempty" url:"-"`
+ // sync (default) holds the response open for the whole transfer. async answers 202 with the document pending and transfers in the background; it requires a connection source, and filesystem connections additionally require expected.sha256.
+ Mode *DocumentsImportFromRequestMode `json:"mode,omitempty" url:"-"`
// Private bitmask of fields set to an explicit value and therefore not to be omitted
explicitFields *big.Int `json:"-" url:"-"`
@@ -298,11 +303,12 @@ var (
)
type DocumentsInitRequest struct {
- TenantID string `json:"-" url:"-"`
- ContentLength float64 `json:"contentLength" url:"-"`
- ContentSha256 string `json:"contentSha256" url:"-"`
- Metadata map[string]any `json:"metadata,omitempty" url:"-"`
- IdempotencyKey *string `json:"idempotencyKey,omitempty" url:"-"`
+ TenantID string `json:"-" url:"-"`
+ ContentLength float64 `json:"contentLength" url:"-"`
+ ContentSha256 string `json:"contentSha256" url:"-"`
+ Metadata map[string]any `json:"metadata,omitempty" url:"-"`
+ IdempotencyKey *string `json:"idempotencyKey,omitempty" url:"-"`
+ // always-create (default) creates a new document every time. reuse-existing returns a document that already holds the same content instead of storing it twice.
DedupMode *DocumentsInitRequestDedupMode `json:"dedupMode,omitempty" url:"-"`
DocID *string `json:"docId,omitempty" url:"-"`
UploadTTLSec *float64 `json:"uploadTtlSec,omitempty" url:"-"`
@@ -4678,6 +4684,7 @@ func (d *DocumentsUploadProxy200Response) String() string {
return fmt.Sprintf("%#v", d)
}
+// always-create (default) creates a new document every time. reuse-existing returns a document that already holds the same content instead of storing it twice.
type DocumentsImportFromRequestDedupMode string
const (
@@ -4700,14 +4707,17 @@ func (d DocumentsImportFromRequestDedupMode) Ptr() *DocumentsImportFromRequestDe
return &d
}
+// Integrity pins, enforced when present. When absent, the server-observed values become authoritative.
var (
documentsImportFromRequestExpectedFieldSizeBytes = big.NewInt(1 << 0)
documentsImportFromRequestExpectedFieldSha256 = big.NewInt(1 << 1)
)
type DocumentsImportFromRequestExpected struct {
- SizeBytes *int `json:"sizeBytes,omitempty" url:"sizeBytes,omitempty"`
- Sha256 *string `json:"sha256,omitempty" url:"sha256,omitempty"`
+ // Checked against the source's declared Content-Length before the transfer.
+ SizeBytes *int `json:"sizeBytes,omitempty" url:"sizeBytes,omitempty"`
+ // Checked against the server-observed digest after the transfer. Required when dedupMode is reuse-existing.
+ Sha256 *string `json:"sha256,omitempty" url:"sha256,omitempty"`
// Private bitmask of fields set to an explicit value and therefore not to be omitted
explicitFields *big.Int `json:"-" url:"-"`
@@ -4800,6 +4810,7 @@ func (d *DocumentsImportFromRequestExpected) String() string {
return fmt.Sprintf("%#v", d)
}
+// sync (default) holds the response open for the whole transfer. async answers 202 with the document pending and transfers in the background; it requires a connection source, and filesystem connections additionally require expected.sha256.
type DocumentsImportFromRequestMode string
const (
@@ -4822,9 +4833,12 @@ func (d DocumentsImportFromRequestMode) Ptr() *DocumentsImportFromRequestMode {
return &d
}
+// Where CloudPDF pulls the bytes from. The two shapes differ in WHO supplies the authority to read, not in which storage vendor holds the file.
type DocumentsImportFromRequestSource struct {
- Kind string
- URL *DocumentsImportFromRequestSourceURL
+ Kind string
+ // The caller supplies the authority: a presigned S3/GCS/Azure/R2/MinIO GET, or any HTTPS endpoint the deployment import policy allows. The URL is a capability — treat it as a secret. CloudPDF never echoes its query string back in errors, logs, or stored failure reasons.
+ URL *DocumentsImportFromRequestSourceURL
+ // The operator pre-registered the authority: the request names a connection and a key inside it. Which provider backs the connection (S3, GCS, Azure Blob, filesystem, ...) is deployment configuration, never wire surface.
Connection *DocumentsImportFromRequestSourceConnection
rawJSON json.RawMessage
@@ -4948,6 +4962,7 @@ func (d *DocumentsImportFromRequestSource) validate() error {
return nil
}
+// The operator pre-registered the authority: the request names a connection and a key inside it. Which provider backs the connection (S3, GCS, Azure Blob, filesystem, ...) is deployment configuration, never wire surface.
var (
documentsImportFromRequestSourceConnectionFieldConnectionID = big.NewInt(1 << 0)
documentsImportFromRequestSourceConnectionFieldKey = big.NewInt(1 << 1)
@@ -4955,9 +4970,12 @@ var (
)
type DocumentsImportFromRequestSourceConnection struct {
- ConnectionID string `json:"connectionId" url:"connectionId"`
- Key string `json:"key" url:"key"`
- Revision *string `json:"revision,omitempty" url:"revision,omitempty"`
+ // The operator-registered storage connection to read from.
+ ConnectionID string `json:"connectionId" url:"connectionId"`
+ // The object key to read, inside the connection's configured scope. At most 1024 UTF-8 bytes.
+ Key string `json:"key" url:"key"`
+ // Pins a specific version of the object. Provider-interpreted (S3 VersionId, GCS generation, Azure version id); providers without versioning reject it.
+ Revision *string `json:"revision,omitempty" url:"revision,omitempty"`
// Private bitmask of fields set to an explicit value and therefore not to be omitted
explicitFields *big.Int `json:"-" url:"-"`
@@ -5064,11 +5082,13 @@ func (d *DocumentsImportFromRequestSourceConnection) String() string {
return fmt.Sprintf("%#v", d)
}
+// The caller supplies the authority: a presigned S3/GCS/Azure/R2/MinIO GET, or any HTTPS endpoint the deployment import policy allows. The URL is a capability — treat it as a secret. CloudPDF never echoes its query string back in errors, logs, or stored failure reasons.
var (
documentsImportFromRequestSourceURLFieldURL = big.NewInt(1 << 0)
)
type DocumentsImportFromRequestSourceURL struct {
+ // The URL to fetch. Must be allowed by the deployment import policy (scheme, network range, size) and must declare a length.
URL string `json:"url" url:"url"`
// Private bitmask of fields set to an explicit value and therefore not to be omitted
@@ -5148,6 +5168,7 @@ func (d *DocumentsImportFromRequestSourceURL) String() string {
return fmt.Sprintf("%#v", d)
}
+// always-create (default) creates a new document every time. reuse-existing returns a document that already holds the same content instead of storing it twice.
type DocumentsInitRequestDedupMode string
const (
diff --git a/reference.md b/reference.md
index 57dfabc..8ec0da7 100644
--- a/reference.md
+++ b/reference.md
@@ -1721,7 +1721,7 @@ client.Documents.ImportFrom(
-
-**source:** `*cloudpdf.DocumentsImportFromRequestSource`
+**source:** `*cloudpdf.DocumentsImportFromRequestSource` — Where CloudPDF pulls the bytes from. The two shapes differ in WHO supplies the authority to read, not in which storage vendor holds the file.
@@ -1729,7 +1729,7 @@ client.Documents.ImportFrom(
-
-**expected:** `*cloudpdf.DocumentsImportFromRequestExpected`
+**expected:** `*cloudpdf.DocumentsImportFromRequestExpected` — Integrity pins, enforced when present. When absent, the server-observed values become authoritative.
@@ -1745,7 +1745,7 @@ client.Documents.ImportFrom(
-
-**idempotencyKey:** `*string`
+**idempotencyKey:** `*string` — Retrying with the same key resumes the same document rather than importing a second copy — including after a 502.
@@ -1753,7 +1753,7 @@ client.Documents.ImportFrom(
-
-**dedupMode:** `*cloudpdf.DocumentsImportFromRequestDedupMode`
+**dedupMode:** `*cloudpdf.DocumentsImportFromRequestDedupMode` — always-create (default) creates a new document every time. reuse-existing returns a document that already holds the same content instead of storing it twice.
@@ -1769,7 +1769,7 @@ client.Documents.ImportFrom(
-
-**mode:** `*cloudpdf.DocumentsImportFromRequestMode`
+**mode:** `*cloudpdf.DocumentsImportFromRequestMode` — sync (default) holds the response open for the whole transfer. async answers 202 with the document pending and transfers in the background; it requires a connection source, and filesystem connections additionally require expected.sha256.
@@ -1857,7 +1857,7 @@ client.Documents.Init(
-
-**dedupMode:** `*cloudpdf.DocumentsInitRequestDedupMode`
+**dedupMode:** `*cloudpdf.DocumentsInitRequestDedupMode` — always-create (default) creates a new document every time. reuse-existing returns a document that already holds the same content instead of storing it twice.