@usehercules/sdk 1.14.1 → 1.14.3
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/CHANGELOG.md +47 -0
- package/README.md +9 -0
- package/client.d.mts +13 -4
- package/client.d.mts.map +1 -1
- package/client.d.ts +13 -4
- package/client.d.ts.map +1 -1
- package/client.js +21 -5
- package/client.js.map +1 -1
- package/client.mjs +21 -5
- package/client.mjs.map +1 -1
- package/internal/parse.d.mts.map +1 -1
- package/internal/parse.d.ts.map +1 -1
- package/internal/parse.js +5 -0
- package/internal/parse.js.map +1 -1
- package/internal/parse.mjs +5 -0
- package/internal/parse.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/content/{models/models.d.mts → collections/collections.d.mts} +88 -87
- package/resources/content/collections/collections.d.mts.map +1 -0
- package/resources/content/{models/models.d.ts → collections/collections.d.ts} +88 -87
- package/resources/content/collections/collections.d.ts.map +1 -0
- package/resources/content/collections/collections.js +58 -0
- package/resources/content/collections/collections.js.map +1 -0
- package/resources/content/collections/collections.mjs +53 -0
- package/resources/content/collections/collections.mjs.map +1 -0
- package/resources/content/{models → collections}/fields.d.mts +23 -22
- package/resources/content/collections/fields.d.mts.map +1 -0
- package/resources/content/{models → collections}/fields.d.ts +23 -22
- package/resources/content/collections/fields.d.ts.map +1 -0
- package/resources/content/collections/fields.js +41 -0
- package/resources/content/collections/fields.js.map +1 -0
- package/resources/content/collections/fields.mjs +37 -0
- package/resources/content/collections/fields.mjs.map +1 -0
- package/resources/content/collections/index.d.mts +3 -0
- package/resources/content/collections/index.d.mts.map +1 -0
- package/resources/content/collections/index.d.ts +3 -0
- package/resources/content/collections/index.d.ts.map +1 -0
- package/resources/content/{models → collections}/index.js +3 -3
- package/resources/content/collections/index.js.map +1 -0
- package/resources/content/{models → collections}/index.mjs +1 -1
- package/resources/content/collections/index.mjs.map +1 -0
- package/resources/content/collections.d.mts +2 -0
- package/resources/content/collections.d.mts.map +1 -0
- package/resources/content/collections.d.ts +2 -0
- package/resources/content/collections.d.ts.map +1 -0
- package/resources/content/{models.js → collections.js} +2 -2
- package/resources/content/collections.js.map +1 -0
- package/resources/content/collections.mjs +3 -0
- package/resources/content/collections.mjs.map +1 -0
- package/resources/content/content.d.mts +4 -4
- package/resources/content/content.d.mts.map +1 -1
- package/resources/content/content.d.ts +4 -4
- package/resources/content/content.d.ts.map +1 -1
- package/resources/content/content.js +4 -4
- package/resources/content/content.js.map +1 -1
- package/resources/content/content.mjs +4 -4
- package/resources/content/content.mjs.map +1 -1
- package/resources/content/entries.d.mts +18 -18
- package/resources/content/entries.d.mts.map +1 -1
- package/resources/content/entries.d.ts +18 -18
- package/resources/content/entries.d.ts.map +1 -1
- package/resources/content/entries.js +2 -2
- package/resources/content/entries.mjs +2 -2
- package/resources/content/index.d.mts +1 -1
- package/resources/content/index.d.mts.map +1 -1
- package/resources/content/index.d.ts +1 -1
- package/resources/content/index.d.ts.map +1 -1
- package/resources/content/index.js +3 -3
- package/resources/content/index.js.map +1 -1
- package/resources/content/index.mjs +1 -1
- package/resources/content/index.mjs.map +1 -1
- package/resources/email/email.d.mts +166 -0
- package/resources/email/email.d.mts.map +1 -0
- package/resources/email/email.d.ts +166 -0
- package/resources/email/email.d.ts.map +1 -0
- package/resources/email/email.js +43 -0
- package/resources/email/email.js.map +1 -0
- package/resources/email/email.mjs +38 -0
- package/resources/email/email.mjs.map +1 -0
- package/resources/email/identities.d.mts +107 -0
- package/resources/email/identities.d.mts.map +1 -0
- package/resources/email/identities.d.ts +107 -0
- package/resources/email/identities.d.ts.map +1 -0
- package/resources/email/identities.js +51 -0
- package/resources/email/identities.js.map +1 -0
- package/resources/email/identities.mjs +47 -0
- package/resources/email/identities.mjs.map +1 -0
- package/resources/email/index.d.mts +3 -0
- package/resources/email/index.d.mts.map +1 -0
- package/resources/email/index.d.ts +3 -0
- package/resources/email/index.d.ts.map +1 -0
- package/resources/email/index.js +9 -0
- package/resources/email/index.js.map +1 -0
- package/resources/email/index.mjs +4 -0
- package/resources/email/index.mjs.map +1 -0
- package/resources/email.d.mts +2 -0
- package/resources/email.d.mts.map +1 -0
- package/resources/email.d.ts +2 -0
- package/resources/email.d.ts.map +1 -0
- package/resources/email.js +6 -0
- package/resources/email.js.map +1 -0
- package/resources/{content/models.mjs → email.mjs} +2 -2
- package/resources/email.mjs.map +1 -0
- package/resources/files.d.mts +8 -6
- package/resources/files.d.mts.map +1 -1
- package/resources/files.d.ts +8 -6
- package/resources/files.d.ts.map +1 -1
- package/resources/files.js +3 -2
- package/resources/files.js.map +1 -1
- package/resources/files.mjs +3 -2
- package/resources/files.mjs.map +1 -1
- package/resources/index.d.mts +1 -0
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +1 -0
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +3 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -0
- package/resources/index.mjs.map +1 -1
- package/src/client.ts +46 -8
- package/src/internal/parse.ts +6 -0
- package/src/resources/content/{models/models.ts → collections/collections.ts} +112 -108
- package/src/resources/content/{models → collections}/fields.ts +39 -27
- package/src/resources/content/{models → collections}/index.ts +8 -8
- package/src/resources/content/collections.ts +3 -0
- package/src/resources/content/content.ts +16 -16
- package/src/resources/content/entries.ts +20 -20
- package/src/resources/content/index.ts +9 -9
- package/src/resources/email/email.ts +229 -0
- package/src/resources/email/identities.ts +151 -0
- package/src/resources/email/index.ts +18 -0
- package/src/resources/{content/models.ts → email.ts} +1 -1
- package/src/resources/files.ts +8 -6
- package/src/resources/index.ts +9 -0
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
- package/resources/content/models/fields.d.mts.map +0 -1
- package/resources/content/models/fields.d.ts.map +0 -1
- package/resources/content/models/fields.js +0 -37
- package/resources/content/models/fields.js.map +0 -1
- package/resources/content/models/fields.mjs +0 -33
- package/resources/content/models/fields.mjs.map +0 -1
- package/resources/content/models/index.d.mts +0 -3
- package/resources/content/models/index.d.mts.map +0 -1
- package/resources/content/models/index.d.ts +0 -3
- package/resources/content/models/index.d.ts.map +0 -1
- package/resources/content/models/index.js.map +0 -1
- package/resources/content/models/index.mjs.map +0 -1
- package/resources/content/models/models.d.mts.map +0 -1
- package/resources/content/models/models.d.ts.map +0 -1
- package/resources/content/models/models.js +0 -54
- package/resources/content/models/models.js.map +0 -1
- package/resources/content/models/models.mjs +0 -49
- package/resources/content/models/models.mjs.map +0 -1
- package/resources/content/models.d.mts +0 -2
- package/resources/content/models.d.mts.map +0 -1
- package/resources/content/models.d.ts +0 -2
- package/resources/content/models.d.ts.map +0 -1
- package/resources/content/models.js.map +0 -1
- package/resources/content/models.mjs.map +0 -1
|
@@ -4,7 +4,7 @@ import { CursorIDPage, type CursorIDPageParams, PagePromise } from "../../core/p
|
|
|
4
4
|
import { RequestOptions } from "../../internal/request-options.mjs";
|
|
5
5
|
export declare class Entries extends APIResource {
|
|
6
6
|
/**
|
|
7
|
-
* Creates a new content entry for a given
|
|
7
|
+
* Creates a new content entry for a given collection. Entries start as drafts by
|
|
8
8
|
* default. Use the publish endpoint to make entries publicly accessible.
|
|
9
9
|
*/
|
|
10
10
|
create(body: EntryCreateParams, options?: RequestOptions): APIPromise<Entry>;
|
|
@@ -15,7 +15,7 @@ export declare class Entries extends APIResource {
|
|
|
15
15
|
*/
|
|
16
16
|
update(entryID: string, body?: EntryUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Entry>;
|
|
17
17
|
/**
|
|
18
|
-
* Retrieves a paginated list of content entries. Supports filtering by
|
|
18
|
+
* Retrieves a paginated list of content entries. Supports filtering by collection,
|
|
19
19
|
* status, locale, and custom field queries. Use the 'where' parameter for
|
|
20
20
|
* field-based filtering with operators like $eq, $contains, $gt, etc.
|
|
21
21
|
*/
|
|
@@ -44,14 +44,18 @@ export declare class Entries extends APIResource {
|
|
|
44
44
|
}
|
|
45
45
|
export type EntriesCursorIDPage = CursorIDPage<Entry>;
|
|
46
46
|
/**
|
|
47
|
-
* A content entry containing field values based on its
|
|
48
|
-
* be drafts, published, or archived.
|
|
47
|
+
* A content entry containing field values based on its collection schema. Entries
|
|
48
|
+
* can be drafts, published, or archived.
|
|
49
49
|
*/
|
|
50
50
|
export interface Entry {
|
|
51
51
|
/**
|
|
52
52
|
* Unique identifier for the entry
|
|
53
53
|
*/
|
|
54
54
|
id: string;
|
|
55
|
+
/**
|
|
56
|
+
* ID of the content collection this entry belongs to
|
|
57
|
+
*/
|
|
58
|
+
collection_id: string;
|
|
55
59
|
/**
|
|
56
60
|
* Timestamp when the entry was created
|
|
57
61
|
*/
|
|
@@ -67,10 +71,6 @@ export interface Entry {
|
|
|
67
71
|
* Primary locale for this entry
|
|
68
72
|
*/
|
|
69
73
|
locale: string;
|
|
70
|
-
/**
|
|
71
|
-
* ID of the content model this entry belongs to
|
|
72
|
-
*/
|
|
73
|
-
model_id: string;
|
|
74
74
|
/**
|
|
75
75
|
* Publishing status: draft, published, or archived
|
|
76
76
|
*/
|
|
@@ -84,13 +84,13 @@ export interface Entry {
|
|
|
84
84
|
*/
|
|
85
85
|
version: number;
|
|
86
86
|
/**
|
|
87
|
-
*
|
|
87
|
+
* API ID of the content collection (included when populated)
|
|
88
88
|
*/
|
|
89
|
-
|
|
89
|
+
collection_api_id?: string;
|
|
90
90
|
/**
|
|
91
|
-
*
|
|
91
|
+
* Timestamp when first published
|
|
92
92
|
*/
|
|
93
|
-
|
|
93
|
+
first_published_at?: string | null;
|
|
94
94
|
/**
|
|
95
95
|
* Timestamp when last published
|
|
96
96
|
*/
|
|
@@ -106,9 +106,9 @@ export interface Entry {
|
|
|
106
106
|
}
|
|
107
107
|
export interface EntryCreateParams {
|
|
108
108
|
/**
|
|
109
|
-
* API ID of the content
|
|
109
|
+
* API ID of the content collection (e.g., 'blogPost')
|
|
110
110
|
*/
|
|
111
|
-
|
|
111
|
+
collection: string;
|
|
112
112
|
/**
|
|
113
113
|
* Optional custom ID for the entry. Must start with 'ce\_'. If not provided, one
|
|
114
114
|
* will be generated.
|
|
@@ -148,6 +148,10 @@ export interface EntryUpdateParams {
|
|
|
148
148
|
version?: number;
|
|
149
149
|
}
|
|
150
150
|
export interface EntryListParams extends CursorIDPageParams {
|
|
151
|
+
/**
|
|
152
|
+
* Filter by content collection API ID (e.g., 'blogPost')
|
|
153
|
+
*/
|
|
154
|
+
collection?: string;
|
|
151
155
|
/**
|
|
152
156
|
* Filter by creation date
|
|
153
157
|
*/
|
|
@@ -160,10 +164,6 @@ export interface EntryListParams extends CursorIDPageParams {
|
|
|
160
164
|
* Filter by primary locale
|
|
161
165
|
*/
|
|
162
166
|
locale?: string;
|
|
163
|
-
/**
|
|
164
|
-
* Filter by content model API ID (e.g., 'blogPost')
|
|
165
|
-
*/
|
|
166
|
-
model?: string;
|
|
167
167
|
/**
|
|
168
168
|
* JSON-encoded sort order. Example: {"field":"publishedAt","direction":"desc"}
|
|
169
169
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"entries.d.mts","sourceRoot":"","sources":["../../src/resources/content/entries.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE,WAAW,EAAE;OACtD,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;OAGG;IACH,MAAM,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAI5E;;;;OAIG;IACH,MAAM,CACJ,OAAO,EAAE,MAAM,EACf,IAAI,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,KAAK,CAAC;IAIpB;;;;OAIG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mBAAmB,EAAE,KAAK,CAAC;IAI1C;;;OAGG;IACH,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAIrE;;;OAGG;IACH,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAIjE;;;;OAIG;IACH,OAAO,CACL,OAAO,EAAE,MAAM,EACf,IAAI,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,KAAK,CAAC;IAIpB;;;OAGG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;CAGxE;AAED,MAAM,MAAM,mBAAmB,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;AAEtD;;;GAGG;AACH,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,MAAM,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEnC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,
|
|
1
|
+
{"version":3,"file":"entries.d.mts","sourceRoot":"","sources":["../../src/resources/content/entries.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE,WAAW,EAAE;OACtD,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;OAGG;IACH,MAAM,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAI5E;;;;OAIG;IACH,MAAM,CACJ,OAAO,EAAE,MAAM,EACf,IAAI,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,KAAK,CAAC;IAIpB;;;;OAIG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mBAAmB,EAAE,KAAK,CAAC;IAI1C;;;OAGG;IACH,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAIrE;;;OAGG;IACH,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAIjE;;;;OAIG;IACH,OAAO,CACL,OAAO,EAAE,MAAM,EACf,IAAI,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,KAAK,CAAC;IAIpB;;;OAGG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;CAGxE;AAED,MAAM,MAAM,mBAAmB,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;AAEtD;;;GAGG;AACH,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,MAAM,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEnC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,EAAE,OAAO,GAAG,WAAW,GAAG,UAAU,CAAC;IAE3C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxC;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,MAAM,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEpC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,WAAW,GAAG,UAAU,CAAC;CAC7C;AAED,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,MAAM,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEpC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,eAAgB,SAAQ,kBAAkB;IACzD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,eAAe,CAAC,OAAO,CAAC;IAElC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,CAAC,EAAE,eAAe,CAAC,SAAS,CAAC;IAEtC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,WAAW,GAAG,UAAU,CAAC;IAE5C;;OAEG;IACH,OAAO,CAAC,EAAE,eAAe,CAAC,OAAO,CAAC;IAElC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,yBAAiB,eAAe,CAAC;IAC/B;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;IAED;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
|
|
@@ -4,7 +4,7 @@ import { CursorIDPage, type CursorIDPageParams, PagePromise } from "../../core/p
|
|
|
4
4
|
import { RequestOptions } from "../../internal/request-options.js";
|
|
5
5
|
export declare class Entries extends APIResource {
|
|
6
6
|
/**
|
|
7
|
-
* Creates a new content entry for a given
|
|
7
|
+
* Creates a new content entry for a given collection. Entries start as drafts by
|
|
8
8
|
* default. Use the publish endpoint to make entries publicly accessible.
|
|
9
9
|
*/
|
|
10
10
|
create(body: EntryCreateParams, options?: RequestOptions): APIPromise<Entry>;
|
|
@@ -15,7 +15,7 @@ export declare class Entries extends APIResource {
|
|
|
15
15
|
*/
|
|
16
16
|
update(entryID: string, body?: EntryUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Entry>;
|
|
17
17
|
/**
|
|
18
|
-
* Retrieves a paginated list of content entries. Supports filtering by
|
|
18
|
+
* Retrieves a paginated list of content entries. Supports filtering by collection,
|
|
19
19
|
* status, locale, and custom field queries. Use the 'where' parameter for
|
|
20
20
|
* field-based filtering with operators like $eq, $contains, $gt, etc.
|
|
21
21
|
*/
|
|
@@ -44,14 +44,18 @@ export declare class Entries extends APIResource {
|
|
|
44
44
|
}
|
|
45
45
|
export type EntriesCursorIDPage = CursorIDPage<Entry>;
|
|
46
46
|
/**
|
|
47
|
-
* A content entry containing field values based on its
|
|
48
|
-
* be drafts, published, or archived.
|
|
47
|
+
* A content entry containing field values based on its collection schema. Entries
|
|
48
|
+
* can be drafts, published, or archived.
|
|
49
49
|
*/
|
|
50
50
|
export interface Entry {
|
|
51
51
|
/**
|
|
52
52
|
* Unique identifier for the entry
|
|
53
53
|
*/
|
|
54
54
|
id: string;
|
|
55
|
+
/**
|
|
56
|
+
* ID of the content collection this entry belongs to
|
|
57
|
+
*/
|
|
58
|
+
collection_id: string;
|
|
55
59
|
/**
|
|
56
60
|
* Timestamp when the entry was created
|
|
57
61
|
*/
|
|
@@ -67,10 +71,6 @@ export interface Entry {
|
|
|
67
71
|
* Primary locale for this entry
|
|
68
72
|
*/
|
|
69
73
|
locale: string;
|
|
70
|
-
/**
|
|
71
|
-
* ID of the content model this entry belongs to
|
|
72
|
-
*/
|
|
73
|
-
model_id: string;
|
|
74
74
|
/**
|
|
75
75
|
* Publishing status: draft, published, or archived
|
|
76
76
|
*/
|
|
@@ -84,13 +84,13 @@ export interface Entry {
|
|
|
84
84
|
*/
|
|
85
85
|
version: number;
|
|
86
86
|
/**
|
|
87
|
-
*
|
|
87
|
+
* API ID of the content collection (included when populated)
|
|
88
88
|
*/
|
|
89
|
-
|
|
89
|
+
collection_api_id?: string;
|
|
90
90
|
/**
|
|
91
|
-
*
|
|
91
|
+
* Timestamp when first published
|
|
92
92
|
*/
|
|
93
|
-
|
|
93
|
+
first_published_at?: string | null;
|
|
94
94
|
/**
|
|
95
95
|
* Timestamp when last published
|
|
96
96
|
*/
|
|
@@ -106,9 +106,9 @@ export interface Entry {
|
|
|
106
106
|
}
|
|
107
107
|
export interface EntryCreateParams {
|
|
108
108
|
/**
|
|
109
|
-
* API ID of the content
|
|
109
|
+
* API ID of the content collection (e.g., 'blogPost')
|
|
110
110
|
*/
|
|
111
|
-
|
|
111
|
+
collection: string;
|
|
112
112
|
/**
|
|
113
113
|
* Optional custom ID for the entry. Must start with 'ce\_'. If not provided, one
|
|
114
114
|
* will be generated.
|
|
@@ -148,6 +148,10 @@ export interface EntryUpdateParams {
|
|
|
148
148
|
version?: number;
|
|
149
149
|
}
|
|
150
150
|
export interface EntryListParams extends CursorIDPageParams {
|
|
151
|
+
/**
|
|
152
|
+
* Filter by content collection API ID (e.g., 'blogPost')
|
|
153
|
+
*/
|
|
154
|
+
collection?: string;
|
|
151
155
|
/**
|
|
152
156
|
* Filter by creation date
|
|
153
157
|
*/
|
|
@@ -160,10 +164,6 @@ export interface EntryListParams extends CursorIDPageParams {
|
|
|
160
164
|
* Filter by primary locale
|
|
161
165
|
*/
|
|
162
166
|
locale?: string;
|
|
163
|
-
/**
|
|
164
|
-
* Filter by content model API ID (e.g., 'blogPost')
|
|
165
|
-
*/
|
|
166
|
-
model?: string;
|
|
167
167
|
/**
|
|
168
168
|
* JSON-encoded sort order. Example: {"field":"publishedAt","direction":"desc"}
|
|
169
169
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"entries.d.ts","sourceRoot":"","sources":["../../src/resources/content/entries.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE,WAAW,EAAE;OACtD,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;OAGG;IACH,MAAM,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAI5E;;;;OAIG;IACH,MAAM,CACJ,OAAO,EAAE,MAAM,EACf,IAAI,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,KAAK,CAAC;IAIpB;;;;OAIG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mBAAmB,EAAE,KAAK,CAAC;IAI1C;;;OAGG;IACH,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAIrE;;;OAGG;IACH,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAIjE;;;;OAIG;IACH,OAAO,CACL,OAAO,EAAE,MAAM,EACf,IAAI,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,KAAK,CAAC;IAIpB;;;OAGG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;CAGxE;AAED,MAAM,MAAM,mBAAmB,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;AAEtD;;;GAGG;AACH,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,MAAM,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEnC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,
|
|
1
|
+
{"version":3,"file":"entries.d.ts","sourceRoot":"","sources":["../../src/resources/content/entries.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE,WAAW,EAAE;OACtD,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;OAGG;IACH,MAAM,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAI5E;;;;OAIG;IACH,MAAM,CACJ,OAAO,EAAE,MAAM,EACf,IAAI,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,KAAK,CAAC;IAIpB;;;;OAIG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mBAAmB,EAAE,KAAK,CAAC;IAI1C;;;OAGG;IACH,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAIrE;;;OAGG;IACH,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAIjE;;;;OAIG;IACH,OAAO,CACL,OAAO,EAAE,MAAM,EACf,IAAI,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,KAAK,CAAC;IAIpB;;;OAGG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;CAGxE;AAED,MAAM,MAAM,mBAAmB,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;AAEtD;;;GAGG;AACH,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,MAAM,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEnC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,EAAE,OAAO,GAAG,WAAW,GAAG,UAAU,CAAC;IAE3C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxC;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,MAAM,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEpC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,WAAW,GAAG,UAAU,CAAC;CAC7C;AAED,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,MAAM,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEpC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,eAAgB,SAAQ,kBAAkB;IACzD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,eAAe,CAAC,OAAO,CAAC;IAElC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,CAAC,EAAE,eAAe,CAAC,SAAS,CAAC;IAEtC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,WAAW,GAAG,UAAU,CAAC;IAE5C;;OAEG;IACH,OAAO,CAAC,EAAE,eAAe,CAAC,OAAO,CAAC;IAElC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,yBAAiB,eAAe,CAAC;IAC/B;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;IAED;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
|
|
@@ -7,7 +7,7 @@ const pagination_1 = require("../../core/pagination.js");
|
|
|
7
7
|
const path_1 = require("../../internal/utils/path.js");
|
|
8
8
|
class Entries extends resource_1.APIResource {
|
|
9
9
|
/**
|
|
10
|
-
* Creates a new content entry for a given
|
|
10
|
+
* Creates a new content entry for a given collection. Entries start as drafts by
|
|
11
11
|
* default. Use the publish endpoint to make entries publicly accessible.
|
|
12
12
|
*/
|
|
13
13
|
create(body, options) {
|
|
@@ -22,7 +22,7 @@ class Entries extends resource_1.APIResource {
|
|
|
22
22
|
return this._client.patch((0, path_1.path) `/v1/content/entries/${entryID}`, { body, ...options });
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
|
-
* Retrieves a paginated list of content entries. Supports filtering by
|
|
25
|
+
* Retrieves a paginated list of content entries. Supports filtering by collection,
|
|
26
26
|
* status, locale, and custom field queries. Use the 'where' parameter for
|
|
27
27
|
* field-based filtering with operators like $eq, $contains, $gt, etc.
|
|
28
28
|
*/
|
|
@@ -4,7 +4,7 @@ import { CursorIDPage } from "../../core/pagination.mjs";
|
|
|
4
4
|
import { path } from "../../internal/utils/path.mjs";
|
|
5
5
|
export class Entries extends APIResource {
|
|
6
6
|
/**
|
|
7
|
-
* Creates a new content entry for a given
|
|
7
|
+
* Creates a new content entry for a given collection. Entries start as drafts by
|
|
8
8
|
* default. Use the publish endpoint to make entries publicly accessible.
|
|
9
9
|
*/
|
|
10
10
|
create(body, options) {
|
|
@@ -19,7 +19,7 @@ export class Entries extends APIResource {
|
|
|
19
19
|
return this._client.patch(path `/v1/content/entries/${entryID}`, { body, ...options });
|
|
20
20
|
}
|
|
21
21
|
/**
|
|
22
|
-
* Retrieves a paginated list of content entries. Supports filtering by
|
|
22
|
+
* Retrieves a paginated list of content entries. Supports filtering by collection,
|
|
23
23
|
* status, locale, and custom field queries. Use the 'where' parameter for
|
|
24
24
|
* field-based filtering with operators like $eq, $contains, $gt, etc.
|
|
25
25
|
*/
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
export { Assets, type Asset, type AssetCreateParams, type AssetUpdateParams, type AssetListParams, type AssetsCursorIDPage, } from "./assets.mjs";
|
|
2
|
+
export { Collections, type Collection, type Field, type CollectionCreateParams, type CollectionUpdateParams, type CollectionListParams, type CollectionsCursorIDPage, } from "./collections/index.mjs";
|
|
2
3
|
export { Content } from "./content.mjs";
|
|
3
4
|
export { Entries, type Entry, type EntryCreateParams, type EntryUpdateParams, type EntryListParams, type EntryPublishParams, type EntriesCursorIDPage, } from "./entries.mjs";
|
|
4
5
|
export { Locales, type Locale, type LocaleCreateParams, type LocaleUpdateParams, type LocaleListParams, type LocalesCursorIDPage, } from "./locales.mjs";
|
|
5
|
-
export { Models, type Field, type Model, type ModelCreateParams, type ModelUpdateParams, type ModelListParams, type ModelsCursorIDPage, } from "./models/index.mjs";
|
|
6
6
|
export { Releases, type Release, type ReleaseItem, type ReleaseCreateParams, type ReleaseUpdateParams, type ReleaseListParams, type ReleaseScheduleParams, type ReleasesCursorIDPage, } from "./releases/index.mjs";
|
|
7
7
|
//# sourceMappingURL=index.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/content/index.ts"],"names":[],"mappings":"OAEO,EACL,MAAM,EACN,KAAK,KAAK,EACV,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,kBAAkB,GACxB;OACM,EAAE,OAAO,EAAE;OACX,EACL,OAAO,EACP,KAAK,KAAK,EACV,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,GACzB;OACM,EACL,OAAO,EACP,KAAK,MAAM,EACX,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,mBAAmB,GACzB;OACM,EACL,
|
|
1
|
+
{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/content/index.ts"],"names":[],"mappings":"OAEO,EACL,MAAM,EACN,KAAK,KAAK,EACV,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,kBAAkB,GACxB;OACM,EACL,WAAW,EACX,KAAK,UAAU,EACf,KAAK,KAAK,EACV,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,uBAAuB,GAC7B;OACM,EAAE,OAAO,EAAE;OACX,EACL,OAAO,EACP,KAAK,KAAK,EACV,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,GACzB;OACM,EACL,OAAO,EACP,KAAK,MAAM,EACX,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,mBAAmB,GACzB;OACM,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,WAAW,EAChB,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,GAC1B"}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
export { Assets, type Asset, type AssetCreateParams, type AssetUpdateParams, type AssetListParams, type AssetsCursorIDPage, } from "./assets.js";
|
|
2
|
+
export { Collections, type Collection, type Field, type CollectionCreateParams, type CollectionUpdateParams, type CollectionListParams, type CollectionsCursorIDPage, } from "./collections/index.js";
|
|
2
3
|
export { Content } from "./content.js";
|
|
3
4
|
export { Entries, type Entry, type EntryCreateParams, type EntryUpdateParams, type EntryListParams, type EntryPublishParams, type EntriesCursorIDPage, } from "./entries.js";
|
|
4
5
|
export { Locales, type Locale, type LocaleCreateParams, type LocaleUpdateParams, type LocaleListParams, type LocalesCursorIDPage, } from "./locales.js";
|
|
5
|
-
export { Models, type Field, type Model, type ModelCreateParams, type ModelUpdateParams, type ModelListParams, type ModelsCursorIDPage, } from "./models/index.js";
|
|
6
6
|
export { Releases, type Release, type ReleaseItem, type ReleaseCreateParams, type ReleaseUpdateParams, type ReleaseListParams, type ReleaseScheduleParams, type ReleasesCursorIDPage, } from "./releases/index.js";
|
|
7
7
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/content/index.ts"],"names":[],"mappings":"OAEO,EACL,MAAM,EACN,KAAK,KAAK,EACV,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,kBAAkB,GACxB;OACM,EAAE,OAAO,EAAE;OACX,EACL,OAAO,EACP,KAAK,KAAK,EACV,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,GACzB;OACM,EACL,OAAO,EACP,KAAK,MAAM,EACX,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,mBAAmB,GACzB;OACM,EACL,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/content/index.ts"],"names":[],"mappings":"OAEO,EACL,MAAM,EACN,KAAK,KAAK,EACV,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,kBAAkB,GACxB;OACM,EACL,WAAW,EACX,KAAK,UAAU,EACf,KAAK,KAAK,EACV,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,EAC3B,KAAK,oBAAoB,EACzB,KAAK,uBAAuB,GAC7B;OACM,EAAE,OAAO,EAAE;OACX,EACL,OAAO,EACP,KAAK,KAAK,EACV,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,GACzB;OACM,EACL,OAAO,EACP,KAAK,MAAM,EACX,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,mBAAmB,GACzB;OACM,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,WAAW,EAChB,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,GAC1B"}
|
|
@@ -1,17 +1,17 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
-
exports.Releases = exports.
|
|
4
|
+
exports.Releases = exports.Locales = exports.Entries = exports.Content = exports.Collections = exports.Assets = void 0;
|
|
5
5
|
var assets_1 = require("./assets.js");
|
|
6
6
|
Object.defineProperty(exports, "Assets", { enumerable: true, get: function () { return assets_1.Assets; } });
|
|
7
|
+
var index_1 = require("./collections/index.js");
|
|
8
|
+
Object.defineProperty(exports, "Collections", { enumerable: true, get: function () { return index_1.Collections; } });
|
|
7
9
|
var content_1 = require("./content.js");
|
|
8
10
|
Object.defineProperty(exports, "Content", { enumerable: true, get: function () { return content_1.Content; } });
|
|
9
11
|
var entries_1 = require("./entries.js");
|
|
10
12
|
Object.defineProperty(exports, "Entries", { enumerable: true, get: function () { return entries_1.Entries; } });
|
|
11
13
|
var locales_1 = require("./locales.js");
|
|
12
14
|
Object.defineProperty(exports, "Locales", { enumerable: true, get: function () { return locales_1.Locales; } });
|
|
13
|
-
var index_1 = require("./models/index.js");
|
|
14
|
-
Object.defineProperty(exports, "Models", { enumerable: true, get: function () { return index_1.Models; } });
|
|
15
15
|
var index_2 = require("./releases/index.js");
|
|
16
16
|
Object.defineProperty(exports, "Releases", { enumerable: true, get: function () { return index_2.Releases; } });
|
|
17
17
|
//# sourceMappingURL=index.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/content/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,sCAOkB;AANhB,gGAAA,MAAM,OAAA;AAOR,wCAAoC;AAA3B,kGAAA,OAAO,OAAA;AAChB,wCAQmB;AAPjB,kGAAA,OAAO,OAAA;AAQT,wCAOmB;AANjB,kGAAA,OAAO,OAAA;AAOT,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/content/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,sCAOkB;AANhB,gGAAA,MAAM,OAAA;AAOR,gDAQ6B;AAP3B,oGAAA,WAAW,OAAA;AAQb,wCAAoC;AAA3B,kGAAA,OAAO,OAAA;AAChB,wCAQmB;AAPjB,kGAAA,OAAO,OAAA;AAQT,wCAOmB;AANjB,kGAAA,OAAO,OAAA;AAOT,6CAS0B;AARxB,iGAAA,QAAQ,OAAA"}
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
2
|
export { Assets, } from "./assets.mjs";
|
|
3
|
+
export { Collections, } from "./collections/index.mjs";
|
|
3
4
|
export { Content } from "./content.mjs";
|
|
4
5
|
export { Entries, } from "./entries.mjs";
|
|
5
6
|
export { Locales, } from "./locales.mjs";
|
|
6
|
-
export { Models, } from "./models/index.mjs";
|
|
7
7
|
export { Releases, } from "./releases/index.mjs";
|
|
8
8
|
//# sourceMappingURL=index.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/content/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,MAAM,GAMP;OACM,EAAE,OAAO,EAAE;OACX,EACL,OAAO,GAOR;OACM,EACL,OAAO,GAMR;OACM,EACL,
|
|
1
|
+
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/content/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,MAAM,GAMP;OACM,EACL,WAAW,GAOZ;OACM,EAAE,OAAO,EAAE;OACX,EACL,OAAO,GAOR;OACM,EACL,OAAO,GAMR;OACM,EACL,QAAQ,GAQT"}
|
|
@@ -0,0 +1,166 @@
|
|
|
1
|
+
import { APIResource } from "../../core/resource.mjs";
|
|
2
|
+
import * as IdentitiesAPI from "./identities.mjs";
|
|
3
|
+
import { Identities, IdentitiesCursorIDPage, Identity, IdentityCreateParams, IdentityListParams } from "./identities.mjs";
|
|
4
|
+
import { APIPromise } from "../../core/api-promise.mjs";
|
|
5
|
+
import { CursorIDPage, type CursorIDPageParams, PagePromise } from "../../core/pagination.mjs";
|
|
6
|
+
import { RequestOptions } from "../../internal/request-options.mjs";
|
|
7
|
+
/**
|
|
8
|
+
* Send transactional emails, send batch emails, and retrieve sent email
|
|
9
|
+
* history with delivery status tracking.
|
|
10
|
+
*/
|
|
11
|
+
export declare class EmailResource extends APIResource {
|
|
12
|
+
identities: IdentitiesAPI.Identities;
|
|
13
|
+
/**
|
|
14
|
+
* Retrieves a paginated list of sent emails. Returns email metadata including
|
|
15
|
+
* delivery status.
|
|
16
|
+
*/
|
|
17
|
+
list(query?: EmailListParams | null | undefined, options?: RequestOptions): PagePromise<EmailsCursorIDPage, Email>;
|
|
18
|
+
/**
|
|
19
|
+
* Retrieves a single email by its unique identifier.
|
|
20
|
+
*/
|
|
21
|
+
get(emailID: string, options?: RequestOptions): APIPromise<Email>;
|
|
22
|
+
/**
|
|
23
|
+
* Sends a single email. The sender address must be a verified identity for this
|
|
24
|
+
* website.
|
|
25
|
+
*/
|
|
26
|
+
send(body: EmailSendParams, options?: RequestOptions): APIPromise<EmailSendResponse>;
|
|
27
|
+
}
|
|
28
|
+
export type EmailsCursorIDPage = CursorIDPage<Email>;
|
|
29
|
+
/**
|
|
30
|
+
* A file attachment
|
|
31
|
+
*/
|
|
32
|
+
export interface Attachment {
|
|
33
|
+
/**
|
|
34
|
+
* The Base64-encoded content of the attachment. Max 40MB total per email.
|
|
35
|
+
*/
|
|
36
|
+
content: string;
|
|
37
|
+
/**
|
|
38
|
+
* The name of the attached file
|
|
39
|
+
*/
|
|
40
|
+
filename: string;
|
|
41
|
+
/**
|
|
42
|
+
* The MIME type of the attachment
|
|
43
|
+
*/
|
|
44
|
+
content_type?: string;
|
|
45
|
+
}
|
|
46
|
+
/**
|
|
47
|
+
* A sent email object
|
|
48
|
+
*/
|
|
49
|
+
export interface Email {
|
|
50
|
+
/**
|
|
51
|
+
* Unique identifier for the email
|
|
52
|
+
*/
|
|
53
|
+
id: string;
|
|
54
|
+
/**
|
|
55
|
+
* Timestamp when the email was sent
|
|
56
|
+
*/
|
|
57
|
+
created_at: string;
|
|
58
|
+
/**
|
|
59
|
+
* Sender email address
|
|
60
|
+
*/
|
|
61
|
+
from: string;
|
|
62
|
+
/**
|
|
63
|
+
* Email subject line
|
|
64
|
+
*/
|
|
65
|
+
subject: string;
|
|
66
|
+
/**
|
|
67
|
+
* Recipient email addresses
|
|
68
|
+
*/
|
|
69
|
+
to: Array<string>;
|
|
70
|
+
/**
|
|
71
|
+
* Blind carbon copy recipients
|
|
72
|
+
*/
|
|
73
|
+
bcc?: Array<string> | null;
|
|
74
|
+
/**
|
|
75
|
+
* Carbon copy recipients
|
|
76
|
+
*/
|
|
77
|
+
cc?: Array<string> | null;
|
|
78
|
+
/**
|
|
79
|
+
* The most recent event for this email
|
|
80
|
+
*/
|
|
81
|
+
last_event?: 'sent' | 'delivered' | 'opened' | 'clicked' | 'bounced' | 'complained' | null;
|
|
82
|
+
/**
|
|
83
|
+
* Reply-to addresses
|
|
84
|
+
*/
|
|
85
|
+
reply_to?: Array<string> | null;
|
|
86
|
+
}
|
|
87
|
+
/**
|
|
88
|
+
* Response after sending an email
|
|
89
|
+
*/
|
|
90
|
+
export interface EmailSendResponse {
|
|
91
|
+
/**
|
|
92
|
+
* The unique identifier of the sent email
|
|
93
|
+
*/
|
|
94
|
+
id: string;
|
|
95
|
+
}
|
|
96
|
+
export interface EmailListParams extends CursorIDPageParams {
|
|
97
|
+
}
|
|
98
|
+
export interface EmailSendParams {
|
|
99
|
+
/**
|
|
100
|
+
* Sender email address. To include a friendly name, use the format 'Your Name
|
|
101
|
+
* <sender@domain.com>'.
|
|
102
|
+
*/
|
|
103
|
+
from: string;
|
|
104
|
+
/**
|
|
105
|
+
* Email subject line
|
|
106
|
+
*/
|
|
107
|
+
subject: string;
|
|
108
|
+
/**
|
|
109
|
+
* Recipient email address(es). Maximum 50.
|
|
110
|
+
*/
|
|
111
|
+
to: string | Array<string>;
|
|
112
|
+
/**
|
|
113
|
+
* List of file attachments. Total size must not exceed 40MB after Base64 encoding.
|
|
114
|
+
*/
|
|
115
|
+
attachments?: Array<Attachment>;
|
|
116
|
+
/**
|
|
117
|
+
* Blind carbon copy recipient(s)
|
|
118
|
+
*/
|
|
119
|
+
bcc?: string | Array<string>;
|
|
120
|
+
/**
|
|
121
|
+
* Carbon copy recipient(s)
|
|
122
|
+
*/
|
|
123
|
+
cc?: string | Array<string>;
|
|
124
|
+
/**
|
|
125
|
+
* Custom email headers as key-value pairs
|
|
126
|
+
*/
|
|
127
|
+
headers?: {
|
|
128
|
+
[key: string]: string;
|
|
129
|
+
};
|
|
130
|
+
/**
|
|
131
|
+
* The HTML version of the message body
|
|
132
|
+
*/
|
|
133
|
+
html?: string;
|
|
134
|
+
/**
|
|
135
|
+
* Reply-to email address(es)
|
|
136
|
+
*/
|
|
137
|
+
reply_to?: string | Array<string>;
|
|
138
|
+
/**
|
|
139
|
+
* Custom metadata tags for the email (max 50)
|
|
140
|
+
*/
|
|
141
|
+
tags?: Array<EmailSendParams.Tag>;
|
|
142
|
+
/**
|
|
143
|
+
* The plain text version of the message body
|
|
144
|
+
*/
|
|
145
|
+
text?: string;
|
|
146
|
+
}
|
|
147
|
+
export declare namespace EmailSendParams {
|
|
148
|
+
/**
|
|
149
|
+
* A custom metadata tag for the email
|
|
150
|
+
*/
|
|
151
|
+
interface Tag {
|
|
152
|
+
/**
|
|
153
|
+
* The name of the tag
|
|
154
|
+
*/
|
|
155
|
+
name: string;
|
|
156
|
+
/**
|
|
157
|
+
* The value of the tag
|
|
158
|
+
*/
|
|
159
|
+
value: string;
|
|
160
|
+
}
|
|
161
|
+
}
|
|
162
|
+
export declare namespace EmailResource {
|
|
163
|
+
export { type Attachment as Attachment, type Email as Email, type EmailSendResponse as EmailSendResponse, type EmailsCursorIDPage as EmailsCursorIDPage, type EmailListParams as EmailListParams, type EmailSendParams as EmailSendParams, };
|
|
164
|
+
export { Identities as Identities, type Identity as Identity, type IdentitiesCursorIDPage as IdentitiesCursorIDPage, type IdentityCreateParams as IdentityCreateParams, type IdentityListParams as IdentityListParams, };
|
|
165
|
+
}
|
|
166
|
+
//# sourceMappingURL=email.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"email.d.mts","sourceRoot":"","sources":["../../src/resources/email/email.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,aAAa;OAClB,EACL,UAAU,EACV,sBAAsB,EACtB,QAAQ,EACR,oBAAoB,EACpB,kBAAkB,EACnB;OACM,EAAE,UAAU,EAAE;OACd,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE,WAAW,EAAE;OACtD,EAAE,cAAc,EAAE;AAGzB;;;GAGG;AACH,qBAAa,aAAc,SAAQ,WAAW;IAC5C,UAAU,EAAE,aAAa,CAAC,UAAU,CAA8C;IAElF;;;OAGG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,kBAAkB,EAAE,KAAK,CAAC;IAIzC;;OAEG;IACH,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;IAIjE;;;OAGG;IACH,IAAI,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;CAGrF;AAED,MAAM,MAAM,kBAAkB,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;AAErD;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,EAAE,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAElB;;OAEG;IACH,GAAG,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,EAAE,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,QAAQ,GAAG,SAAS,GAAG,SAAS,GAAG,YAAY,GAAG,IAAI,CAAC;IAE3F;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,eAAgB,SAAQ,kBAAkB;CAAG;AAE9D,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,EAAE,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;IAE3B;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;IAEhC;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;IAE7B;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;IAElC;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;IAElC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,eAAe,CAAC;IAC/B;;OAEG;IACH,UAAiB,GAAG;QAClB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAID,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,KAAK,IAAI,KAAK,EACnB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,eAAe,IAAI,eAAe,GACxC,CAAC;IAEF,OAAO,EACL,UAAU,IAAI,UAAU,EACxB,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
|