@usehercules/sdk 1.9.0 → 1.10.0

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.
Files changed (179) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/package.json +1 -1
  3. package/resources/beta/beta.d.mts +4 -0
  4. package/resources/beta/beta.d.mts.map +1 -1
  5. package/resources/beta/beta.d.ts +4 -0
  6. package/resources/beta/beta.d.ts.map +1 -1
  7. package/resources/beta/beta.js +4 -0
  8. package/resources/beta/beta.js.map +1 -1
  9. package/resources/beta/beta.mjs +4 -0
  10. package/resources/beta/beta.mjs.map +1 -1
  11. package/resources/beta/commerce/commerce.d.mts +16 -11
  12. package/resources/beta/commerce/commerce.d.mts.map +1 -1
  13. package/resources/beta/commerce/commerce.d.ts +16 -11
  14. package/resources/beta/commerce/commerce.d.ts.map +1 -1
  15. package/resources/beta/commerce/commerce.js.map +1 -1
  16. package/resources/beta/commerce/commerce.mjs.map +1 -1
  17. package/resources/beta/commerce/products/products.d.mts +103 -126
  18. package/resources/beta/commerce/products/products.d.mts.map +1 -1
  19. package/resources/beta/commerce/products/products.d.ts +103 -126
  20. package/resources/beta/commerce/products/products.d.ts.map +1 -1
  21. package/resources/beta/commerce/products/products.js.map +1 -1
  22. package/resources/beta/commerce/products/products.mjs.map +1 -1
  23. package/resources/beta/commerce/products/resources.d.mts +16 -19
  24. package/resources/beta/commerce/products/resources.d.mts.map +1 -1
  25. package/resources/beta/commerce/products/resources.d.ts +16 -19
  26. package/resources/beta/commerce/products/resources.d.ts.map +1 -1
  27. package/resources/beta/commerce/products/variants.d.mts +0 -75
  28. package/resources/beta/commerce/products/variants.d.mts.map +1 -1
  29. package/resources/beta/commerce/products/variants.d.ts +0 -75
  30. package/resources/beta/commerce/products/variants.d.ts.map +1 -1
  31. package/resources/beta/content/assets.d.mts +226 -0
  32. package/resources/beta/content/assets.d.mts.map +1 -0
  33. package/resources/beta/content/assets.d.ts +226 -0
  34. package/resources/beta/content/assets.d.ts.map +1 -0
  35. package/resources/beta/content/assets.js +56 -0
  36. package/resources/beta/content/assets.js.map +1 -0
  37. package/resources/beta/content/assets.mjs +52 -0
  38. package/resources/beta/content/assets.mjs.map +1 -0
  39. package/resources/beta/content/content.d.mts +26 -0
  40. package/resources/beta/content/content.d.mts.map +1 -0
  41. package/resources/beta/content/content.d.ts +26 -0
  42. package/resources/beta/content/content.d.ts.map +1 -0
  43. package/resources/beta/content/content.js +33 -0
  44. package/resources/beta/content/content.js.map +1 -0
  45. package/resources/beta/content/content.mjs +28 -0
  46. package/resources/beta/content/content.mjs.map +1 -0
  47. package/resources/beta/content/entries.d.mts +266 -0
  48. package/resources/beta/content/entries.d.mts.map +1 -0
  49. package/resources/beta/content/entries.d.ts +266 -0
  50. package/resources/beta/content/entries.d.ts.map +1 -0
  51. package/resources/beta/content/entries.js +63 -0
  52. package/resources/beta/content/entries.js.map +1 -0
  53. package/resources/beta/content/entries.mjs +59 -0
  54. package/resources/beta/content/entries.mjs.map +1 -0
  55. package/resources/beta/content/index.d.mts +7 -0
  56. package/resources/beta/content/index.d.mts.map +1 -0
  57. package/resources/beta/content/index.d.ts +7 -0
  58. package/resources/beta/content/index.d.ts.map +1 -0
  59. package/resources/beta/content/index.js +17 -0
  60. package/resources/beta/content/index.js.map +1 -0
  61. package/resources/beta/content/index.mjs +8 -0
  62. package/resources/beta/content/index.mjs.map +1 -0
  63. package/resources/beta/content/locales.d.mts +116 -0
  64. package/resources/beta/content/locales.d.mts.map +1 -0
  65. package/resources/beta/content/locales.d.ts +116 -0
  66. package/resources/beta/content/locales.d.ts.map +1 -0
  67. package/resources/beta/content/locales.js +49 -0
  68. package/resources/beta/content/locales.js.map +1 -0
  69. package/resources/beta/content/locales.mjs +45 -0
  70. package/resources/beta/content/locales.mjs.map +1 -0
  71. package/resources/beta/content/models/fields.d.mts +186 -0
  72. package/resources/beta/content/models/fields.d.mts.map +1 -0
  73. package/resources/beta/content/models/fields.d.ts +186 -0
  74. package/resources/beta/content/models/fields.d.ts.map +1 -0
  75. package/resources/beta/content/models/fields.js +37 -0
  76. package/resources/beta/content/models/fields.js.map +1 -0
  77. package/resources/beta/content/models/fields.mjs +33 -0
  78. package/resources/beta/content/models/fields.mjs.map +1 -0
  79. package/resources/beta/content/models/index.d.mts +3 -0
  80. package/resources/beta/content/models/index.d.mts.map +1 -0
  81. package/resources/beta/content/models/index.d.ts +3 -0
  82. package/resources/beta/content/models/index.d.ts.map +1 -0
  83. package/resources/beta/content/models/index.js +9 -0
  84. package/resources/beta/content/models/index.js.map +1 -0
  85. package/resources/beta/content/models/index.mjs +4 -0
  86. package/resources/beta/content/models/index.mjs.map +1 -0
  87. package/resources/beta/content/models/models.d.mts +296 -0
  88. package/resources/beta/content/models/models.d.mts.map +1 -0
  89. package/resources/beta/content/models/models.d.ts +296 -0
  90. package/resources/beta/content/models/models.d.ts.map +1 -0
  91. package/resources/beta/content/models/models.js +54 -0
  92. package/resources/beta/content/models/models.js.map +1 -0
  93. package/resources/beta/content/models/models.mjs +49 -0
  94. package/resources/beta/content/models/models.mjs.map +1 -0
  95. package/resources/beta/content/models.d.mts +2 -0
  96. package/resources/beta/content/models.d.mts.map +1 -0
  97. package/resources/beta/content/models.d.ts +2 -0
  98. package/resources/beta/content/models.d.ts.map +1 -0
  99. package/resources/beta/content/models.js +6 -0
  100. package/resources/beta/content/models.js.map +1 -0
  101. package/resources/beta/content/models.mjs +3 -0
  102. package/resources/beta/content/models.mjs.map +1 -0
  103. package/resources/beta/content/releases/index.d.mts +3 -0
  104. package/resources/beta/content/releases/index.d.mts.map +1 -0
  105. package/resources/beta/content/releases/index.d.ts +3 -0
  106. package/resources/beta/content/releases/index.d.ts.map +1 -0
  107. package/resources/beta/content/releases/index.js +9 -0
  108. package/resources/beta/content/releases/index.js.map +1 -0
  109. package/resources/beta/content/releases/index.mjs +4 -0
  110. package/resources/beta/content/releases/index.mjs.map +1 -0
  111. package/resources/beta/content/releases/items.d.mts +39 -0
  112. package/resources/beta/content/releases/items.d.mts.map +1 -0
  113. package/resources/beta/content/releases/items.d.ts +39 -0
  114. package/resources/beta/content/releases/items.d.ts.map +1 -0
  115. package/resources/beta/content/releases/items.js +28 -0
  116. package/resources/beta/content/releases/items.js.map +1 -0
  117. package/resources/beta/content/releases/items.mjs +24 -0
  118. package/resources/beta/content/releases/items.mjs.map +1 -0
  119. package/resources/beta/content/releases/releases.d.mts +151 -0
  120. package/resources/beta/content/releases/releases.d.mts.map +1 -0
  121. package/resources/beta/content/releases/releases.d.ts +151 -0
  122. package/resources/beta/content/releases/releases.d.ts.map +1 -0
  123. package/resources/beta/content/releases/releases.js +69 -0
  124. package/resources/beta/content/releases/releases.js.map +1 -0
  125. package/resources/beta/content/releases/releases.mjs +64 -0
  126. package/resources/beta/content/releases/releases.mjs.map +1 -0
  127. package/resources/beta/content/releases.d.mts +2 -0
  128. package/resources/beta/content/releases.d.mts.map +1 -0
  129. package/resources/beta/content/releases.d.ts +2 -0
  130. package/resources/beta/content/releases.d.ts.map +1 -0
  131. package/resources/beta/content/releases.js +6 -0
  132. package/resources/beta/content/releases.js.map +1 -0
  133. package/resources/beta/content/releases.mjs +3 -0
  134. package/resources/beta/content/releases.mjs.map +1 -0
  135. package/resources/beta/content.d.mts +2 -0
  136. package/resources/beta/content.d.mts.map +1 -0
  137. package/resources/beta/content.d.ts +2 -0
  138. package/resources/beta/content.d.ts.map +1 -0
  139. package/resources/beta/content.js +6 -0
  140. package/resources/beta/content.js.map +1 -0
  141. package/resources/beta/content.mjs +3 -0
  142. package/resources/beta/content.mjs.map +1 -0
  143. package/resources/beta/index.d.mts +1 -0
  144. package/resources/beta/index.d.mts.map +1 -1
  145. package/resources/beta/index.d.ts +1 -0
  146. package/resources/beta/index.d.ts.map +1 -1
  147. package/resources/beta/index.js +3 -1
  148. package/resources/beta/index.js.map +1 -1
  149. package/resources/beta/index.mjs +1 -0
  150. package/resources/beta/index.mjs.map +1 -1
  151. package/src/resources/beta/beta.ts +6 -0
  152. package/src/resources/beta/commerce/commerce.ts +18 -12
  153. package/src/resources/beta/commerce/products/products.ts +114 -144
  154. package/src/resources/beta/commerce/products/resources.ts +16 -19
  155. package/src/resources/beta/commerce/products/variants.ts +0 -90
  156. package/src/resources/beta/content/assets.ts +299 -0
  157. package/src/resources/beta/content/content.ts +117 -0
  158. package/src/resources/beta/content/entries.ts +347 -0
  159. package/src/resources/beta/content/index.ts +47 -0
  160. package/src/resources/beta/content/locales.ts +169 -0
  161. package/src/resources/beta/content/models/fields.ts +276 -0
  162. package/src/resources/beta/content/models/index.ts +12 -0
  163. package/src/resources/beta/content/models/models.ts +436 -0
  164. package/src/resources/beta/content/models.ts +3 -0
  165. package/src/resources/beta/content/releases/index.ts +13 -0
  166. package/src/resources/beta/content/releases/items.ts +57 -0
  167. package/src/resources/beta/content/releases/releases.ts +220 -0
  168. package/src/resources/beta/content/releases.ts +3 -0
  169. package/src/resources/beta/content.ts +3 -0
  170. package/src/resources/beta/index.ts +1 -0
  171. package/src/version.ts +1 -1
  172. package/version.d.mts +1 -1
  173. package/version.d.mts.map +1 -1
  174. package/version.d.ts +1 -1
  175. package/version.d.ts.map +1 -1
  176. package/version.js +1 -1
  177. package/version.js.map +1 -1
  178. package/version.mjs +1 -1
  179. package/version.mjs.map +1 -1
@@ -0,0 +1,186 @@
1
+ import { APIResource } from "../../../../core/resource.mjs";
2
+ import * as ModelsAPI from "./models.mjs";
3
+ import { APIPromise } from "../../../../core/api-promise.mjs";
4
+ import { RequestOptions } from "../../../../internal/request-options.mjs";
5
+ export declare class Fields extends APIResource {
6
+ /**
7
+ * Adds a new field to a content model. Fields define the structure of entries. The
8
+ * model must not be locked. Adding a field increments the model version.
9
+ */
10
+ create(modelID: string, body: FieldCreateParams, options?: RequestOptions): APIPromise<ModelsAPI.Field>;
11
+ /**
12
+ * Updates an existing field in a content model. The field type cannot be changed
13
+ * after creation. The model must not be locked.
14
+ */
15
+ update(fieldID: string, params: FieldUpdateParams, options?: RequestOptions): APIPromise<ModelsAPI.Field>;
16
+ /**
17
+ * Removes a field from a content model. Existing entry data for this field is
18
+ * preserved but will no longer be validated. The model must not be locked.
19
+ */
20
+ delete(fieldID: string, params: FieldDeleteParams, options?: RequestOptions): APIPromise<void>;
21
+ }
22
+ export interface FieldCreateParams {
23
+ /**
24
+ * API identifier for the field (camelCase, e.g., 'title')
25
+ */
26
+ api_id: string;
27
+ /**
28
+ * Display name for the field
29
+ */
30
+ name: string;
31
+ /**
32
+ * Field data type
33
+ */
34
+ type: 'text' | 'richtext' | 'number' | 'boolean' | 'date' | 'datetime' | 'json' | 'reference' | 'asset' | 'enum' | 'array';
35
+ /**
36
+ * Optional custom ID for the field. Must start with 'cf\_'. If not provided, one
37
+ * will be generated.
38
+ */
39
+ id?: string;
40
+ /**
41
+ * Description of the field
42
+ */
43
+ description?: string;
44
+ /**
45
+ * Display order within the model
46
+ */
47
+ display_order?: number;
48
+ /**
49
+ * Whether field values are stored per-locale
50
+ */
51
+ localized?: boolean;
52
+ /**
53
+ * Validation rules
54
+ */
55
+ validation?: FieldCreateParams.Validation;
56
+ }
57
+ export declare namespace FieldCreateParams {
58
+ /**
59
+ * Validation rules
60
+ */
61
+ interface Validation {
62
+ /**
63
+ * Allowed MIME types for asset fields (e.g., 'image/\*', 'application/pdf')
64
+ */
65
+ allowed_mime_types?: Array<string>;
66
+ /**
67
+ * Allowed model apiIds for reference fields
68
+ */
69
+ allowed_models?: Array<string>;
70
+ /**
71
+ * Allowed values for enum fields
72
+ */
73
+ allowed_values?: Array<string>;
74
+ /**
75
+ * Type of items for array fields
76
+ */
77
+ array_item_type?: 'text' | 'richtext' | 'number' | 'boolean' | 'date' | 'datetime' | 'json' | 'reference' | 'asset' | 'enum' | 'array';
78
+ /**
79
+ * Default value for the field
80
+ */
81
+ default_value?: unknown;
82
+ /**
83
+ * Maximum value for numbers, maximum length for text/arrays
84
+ */
85
+ max?: number;
86
+ /**
87
+ * Minimum value for numbers, minimum length for text/arrays
88
+ */
89
+ min?: number;
90
+ /**
91
+ * Regex pattern for text field validation
92
+ */
93
+ pattern?: string;
94
+ /**
95
+ * Whether the field is required
96
+ */
97
+ required?: boolean;
98
+ /**
99
+ * Whether field values must be unique
100
+ */
101
+ unique?: boolean;
102
+ }
103
+ }
104
+ export interface FieldUpdateParams {
105
+ /**
106
+ * Path param: The unique identifier of the content model
107
+ */
108
+ model_id: string;
109
+ /**
110
+ * Body param: Description of the field
111
+ */
112
+ description?: string;
113
+ /**
114
+ * Body param: Display order
115
+ */
116
+ display_order?: number;
117
+ /**
118
+ * Body param: Whether field values are localized
119
+ */
120
+ localized?: boolean;
121
+ /**
122
+ * Body param: Display name for the field
123
+ */
124
+ name?: string;
125
+ /**
126
+ * Body param: Validation rules
127
+ */
128
+ validation?: FieldUpdateParams.Validation;
129
+ }
130
+ export declare namespace FieldUpdateParams {
131
+ /**
132
+ * Validation rules
133
+ */
134
+ interface Validation {
135
+ /**
136
+ * Allowed MIME types for asset fields (e.g., 'image/\*', 'application/pdf')
137
+ */
138
+ allowed_mime_types?: Array<string>;
139
+ /**
140
+ * Allowed model apiIds for reference fields
141
+ */
142
+ allowed_models?: Array<string>;
143
+ /**
144
+ * Allowed values for enum fields
145
+ */
146
+ allowed_values?: Array<string>;
147
+ /**
148
+ * Type of items for array fields
149
+ */
150
+ array_item_type?: 'text' | 'richtext' | 'number' | 'boolean' | 'date' | 'datetime' | 'json' | 'reference' | 'asset' | 'enum' | 'array';
151
+ /**
152
+ * Default value for the field
153
+ */
154
+ default_value?: unknown;
155
+ /**
156
+ * Maximum value for numbers, maximum length for text/arrays
157
+ */
158
+ max?: number;
159
+ /**
160
+ * Minimum value for numbers, minimum length for text/arrays
161
+ */
162
+ min?: number;
163
+ /**
164
+ * Regex pattern for text field validation
165
+ */
166
+ pattern?: string;
167
+ /**
168
+ * Whether the field is required
169
+ */
170
+ required?: boolean;
171
+ /**
172
+ * Whether field values must be unique
173
+ */
174
+ unique?: boolean;
175
+ }
176
+ }
177
+ export interface FieldDeleteParams {
178
+ /**
179
+ * The unique identifier of the content model
180
+ */
181
+ model_id: string;
182
+ }
183
+ export declare namespace Fields {
184
+ export { type FieldCreateParams as FieldCreateParams, type FieldUpdateParams as FieldUpdateParams, type FieldDeleteParams as FieldDeleteParams, };
185
+ }
186
+ //# sourceMappingURL=fields.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"fields.d.mts","sourceRoot":"","sources":["../../../../src/resources/beta/content/models/fields.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,SAAS;OACd,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;OAGG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC;IAIvG;;;OAGG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC;IAKzG;;;OAGG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAO/F;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EACA,MAAM,GACN,UAAU,GACV,QAAQ,GACR,SAAS,GACT,MAAM,GACN,UAAU,GACV,MAAM,GACN,WAAW,GACX,OAAO,GACP,MAAM,GACN,OAAO,CAAC;IAEZ;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,iBAAiB,CAAC,UAAU,CAAC;CAC3C;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,kBAAkB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEnC;;WAEG;QACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE/B;;WAEG;QACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE/B;;WAEG;QACH,eAAe,CAAC,EACZ,MAAM,GACN,UAAU,GACV,QAAQ,GACR,SAAS,GACT,MAAM,GACN,UAAU,GACV,MAAM,GACN,WAAW,GACX,OAAO,GACP,MAAM,GACN,OAAO,CAAC;QAEZ;;WAEG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;QAExB;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,QAAQ,CAAC,EAAE,OAAO,CAAC;QAEnB;;WAEG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC;KAClB;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,CAAC,EAAE,iBAAiB,CAAC,UAAU,CAAC;CAC3C;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,kBAAkB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEnC;;WAEG;QACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE/B;;WAEG;QACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE/B;;WAEG;QACH,eAAe,CAAC,EACZ,MAAM,GACN,UAAU,GACV,QAAQ,GACR,SAAS,GACT,MAAM,GACN,UAAU,GACV,MAAM,GACN,WAAW,GACX,OAAO,GACP,MAAM,GACN,OAAO,CAAC;QAEZ;;WAEG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;QAExB;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,QAAQ,CAAC,EAAE,OAAO,CAAC;QAEnB;;WAEG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC;KAClB;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
@@ -0,0 +1,186 @@
1
+ import { APIResource } from "../../../../core/resource.js";
2
+ import * as ModelsAPI from "./models.js";
3
+ import { APIPromise } from "../../../../core/api-promise.js";
4
+ import { RequestOptions } from "../../../../internal/request-options.js";
5
+ export declare class Fields extends APIResource {
6
+ /**
7
+ * Adds a new field to a content model. Fields define the structure of entries. The
8
+ * model must not be locked. Adding a field increments the model version.
9
+ */
10
+ create(modelID: string, body: FieldCreateParams, options?: RequestOptions): APIPromise<ModelsAPI.Field>;
11
+ /**
12
+ * Updates an existing field in a content model. The field type cannot be changed
13
+ * after creation. The model must not be locked.
14
+ */
15
+ update(fieldID: string, params: FieldUpdateParams, options?: RequestOptions): APIPromise<ModelsAPI.Field>;
16
+ /**
17
+ * Removes a field from a content model. Existing entry data for this field is
18
+ * preserved but will no longer be validated. The model must not be locked.
19
+ */
20
+ delete(fieldID: string, params: FieldDeleteParams, options?: RequestOptions): APIPromise<void>;
21
+ }
22
+ export interface FieldCreateParams {
23
+ /**
24
+ * API identifier for the field (camelCase, e.g., 'title')
25
+ */
26
+ api_id: string;
27
+ /**
28
+ * Display name for the field
29
+ */
30
+ name: string;
31
+ /**
32
+ * Field data type
33
+ */
34
+ type: 'text' | 'richtext' | 'number' | 'boolean' | 'date' | 'datetime' | 'json' | 'reference' | 'asset' | 'enum' | 'array';
35
+ /**
36
+ * Optional custom ID for the field. Must start with 'cf\_'. If not provided, one
37
+ * will be generated.
38
+ */
39
+ id?: string;
40
+ /**
41
+ * Description of the field
42
+ */
43
+ description?: string;
44
+ /**
45
+ * Display order within the model
46
+ */
47
+ display_order?: number;
48
+ /**
49
+ * Whether field values are stored per-locale
50
+ */
51
+ localized?: boolean;
52
+ /**
53
+ * Validation rules
54
+ */
55
+ validation?: FieldCreateParams.Validation;
56
+ }
57
+ export declare namespace FieldCreateParams {
58
+ /**
59
+ * Validation rules
60
+ */
61
+ interface Validation {
62
+ /**
63
+ * Allowed MIME types for asset fields (e.g., 'image/\*', 'application/pdf')
64
+ */
65
+ allowed_mime_types?: Array<string>;
66
+ /**
67
+ * Allowed model apiIds for reference fields
68
+ */
69
+ allowed_models?: Array<string>;
70
+ /**
71
+ * Allowed values for enum fields
72
+ */
73
+ allowed_values?: Array<string>;
74
+ /**
75
+ * Type of items for array fields
76
+ */
77
+ array_item_type?: 'text' | 'richtext' | 'number' | 'boolean' | 'date' | 'datetime' | 'json' | 'reference' | 'asset' | 'enum' | 'array';
78
+ /**
79
+ * Default value for the field
80
+ */
81
+ default_value?: unknown;
82
+ /**
83
+ * Maximum value for numbers, maximum length for text/arrays
84
+ */
85
+ max?: number;
86
+ /**
87
+ * Minimum value for numbers, minimum length for text/arrays
88
+ */
89
+ min?: number;
90
+ /**
91
+ * Regex pattern for text field validation
92
+ */
93
+ pattern?: string;
94
+ /**
95
+ * Whether the field is required
96
+ */
97
+ required?: boolean;
98
+ /**
99
+ * Whether field values must be unique
100
+ */
101
+ unique?: boolean;
102
+ }
103
+ }
104
+ export interface FieldUpdateParams {
105
+ /**
106
+ * Path param: The unique identifier of the content model
107
+ */
108
+ model_id: string;
109
+ /**
110
+ * Body param: Description of the field
111
+ */
112
+ description?: string;
113
+ /**
114
+ * Body param: Display order
115
+ */
116
+ display_order?: number;
117
+ /**
118
+ * Body param: Whether field values are localized
119
+ */
120
+ localized?: boolean;
121
+ /**
122
+ * Body param: Display name for the field
123
+ */
124
+ name?: string;
125
+ /**
126
+ * Body param: Validation rules
127
+ */
128
+ validation?: FieldUpdateParams.Validation;
129
+ }
130
+ export declare namespace FieldUpdateParams {
131
+ /**
132
+ * Validation rules
133
+ */
134
+ interface Validation {
135
+ /**
136
+ * Allowed MIME types for asset fields (e.g., 'image/\*', 'application/pdf')
137
+ */
138
+ allowed_mime_types?: Array<string>;
139
+ /**
140
+ * Allowed model apiIds for reference fields
141
+ */
142
+ allowed_models?: Array<string>;
143
+ /**
144
+ * Allowed values for enum fields
145
+ */
146
+ allowed_values?: Array<string>;
147
+ /**
148
+ * Type of items for array fields
149
+ */
150
+ array_item_type?: 'text' | 'richtext' | 'number' | 'boolean' | 'date' | 'datetime' | 'json' | 'reference' | 'asset' | 'enum' | 'array';
151
+ /**
152
+ * Default value for the field
153
+ */
154
+ default_value?: unknown;
155
+ /**
156
+ * Maximum value for numbers, maximum length for text/arrays
157
+ */
158
+ max?: number;
159
+ /**
160
+ * Minimum value for numbers, minimum length for text/arrays
161
+ */
162
+ min?: number;
163
+ /**
164
+ * Regex pattern for text field validation
165
+ */
166
+ pattern?: string;
167
+ /**
168
+ * Whether the field is required
169
+ */
170
+ required?: boolean;
171
+ /**
172
+ * Whether field values must be unique
173
+ */
174
+ unique?: boolean;
175
+ }
176
+ }
177
+ export interface FieldDeleteParams {
178
+ /**
179
+ * The unique identifier of the content model
180
+ */
181
+ model_id: string;
182
+ }
183
+ export declare namespace Fields {
184
+ export { type FieldCreateParams as FieldCreateParams, type FieldUpdateParams as FieldUpdateParams, type FieldDeleteParams as FieldDeleteParams, };
185
+ }
186
+ //# sourceMappingURL=fields.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"fields.d.ts","sourceRoot":"","sources":["../../../../src/resources/beta/content/models/fields.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,SAAS;OACd,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;OAGG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC;IAIvG;;;OAGG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC;IAKzG;;;OAGG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAO/F;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EACA,MAAM,GACN,UAAU,GACV,QAAQ,GACR,SAAS,GACT,MAAM,GACN,UAAU,GACV,MAAM,GACN,WAAW,GACX,OAAO,GACP,MAAM,GACN,OAAO,CAAC;IAEZ;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,iBAAiB,CAAC,UAAU,CAAC;CAC3C;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,kBAAkB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEnC;;WAEG;QACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE/B;;WAEG;QACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE/B;;WAEG;QACH,eAAe,CAAC,EACZ,MAAM,GACN,UAAU,GACV,QAAQ,GACR,SAAS,GACT,MAAM,GACN,UAAU,GACV,MAAM,GACN,WAAW,GACX,OAAO,GACP,MAAM,GACN,OAAO,CAAC;QAEZ;;WAEG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;QAExB;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,QAAQ,CAAC,EAAE,OAAO,CAAC;QAEnB;;WAEG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC;KAClB;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,CAAC,EAAE,iBAAiB,CAAC,UAAU,CAAC;CAC3C;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,kBAAkB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEnC;;WAEG;QACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE/B;;WAEG;QACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE/B;;WAEG;QACH,eAAe,CAAC,EACZ,MAAM,GACN,UAAU,GACV,QAAQ,GACR,SAAS,GACT,MAAM,GACN,UAAU,GACV,MAAM,GACN,WAAW,GACX,OAAO,GACP,MAAM,GACN,OAAO,CAAC;QAEZ;;WAEG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;QAExB;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,QAAQ,CAAC,EAAE,OAAO,CAAC;QAEnB;;WAEG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC;KAClB;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
@@ -0,0 +1,37 @@
1
+ "use strict";
2
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.Fields = void 0;
5
+ const resource_1 = require("../../../../core/resource.js");
6
+ const headers_1 = require("../../../../internal/headers.js");
7
+ const path_1 = require("../../../../internal/utils/path.js");
8
+ class Fields extends resource_1.APIResource {
9
+ /**
10
+ * Adds a new field to a content model. Fields define the structure of entries. The
11
+ * model must not be locked. Adding a field increments the model version.
12
+ */
13
+ create(modelID, body, options) {
14
+ return this._client.post((0, path_1.path) `/v1/content/models/${modelID}/fields`, { body, ...options });
15
+ }
16
+ /**
17
+ * Updates an existing field in a content model. The field type cannot be changed
18
+ * after creation. The model must not be locked.
19
+ */
20
+ update(fieldID, params, options) {
21
+ const { model_id, ...body } = params;
22
+ return this._client.patch((0, path_1.path) `/v1/content/models/${model_id}/fields/${fieldID}`, { body, ...options });
23
+ }
24
+ /**
25
+ * Removes a field from a content model. Existing entry data for this field is
26
+ * preserved but will no longer be validated. The model must not be locked.
27
+ */
28
+ delete(fieldID, params, options) {
29
+ const { model_id } = params;
30
+ return this._client.delete((0, path_1.path) `/v1/content/models/${model_id}/fields/${fieldID}`, {
31
+ ...options,
32
+ headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
33
+ });
34
+ }
35
+ }
36
+ exports.Fields = Fields;
37
+ //# sourceMappingURL=fields.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"fields.js","sourceRoot":"","sources":["../../../../src/resources/beta/content/models/fields.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,2DAAwD;AAGxD,6DAA4D;AAE5D,6DAAuD;AAEvD,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;OAGG;IACH,MAAM,CAAC,OAAe,EAAE,IAAuB,EAAE,OAAwB;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,sBAAsB,OAAO,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,OAAe,EAAE,MAAyB,EAAE,OAAwB;QACzE,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,sBAAsB,QAAQ,WAAW,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1G,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,OAAe,EAAE,MAAyB,EAAE,OAAwB;QACzE,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;QAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,sBAAsB,QAAQ,WAAW,OAAO,EAAE,EAAE;YACjF,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AA7BD,wBA6BC"}
@@ -0,0 +1,33 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+ import { APIResource } from "../../../../core/resource.mjs";
3
+ import { buildHeaders } from "../../../../internal/headers.mjs";
4
+ import { path } from "../../../../internal/utils/path.mjs";
5
+ export class Fields extends APIResource {
6
+ /**
7
+ * Adds a new field to a content model. Fields define the structure of entries. The
8
+ * model must not be locked. Adding a field increments the model version.
9
+ */
10
+ create(modelID, body, options) {
11
+ return this._client.post(path `/v1/content/models/${modelID}/fields`, { body, ...options });
12
+ }
13
+ /**
14
+ * Updates an existing field in a content model. The field type cannot be changed
15
+ * after creation. The model must not be locked.
16
+ */
17
+ update(fieldID, params, options) {
18
+ const { model_id, ...body } = params;
19
+ return this._client.patch(path `/v1/content/models/${model_id}/fields/${fieldID}`, { body, ...options });
20
+ }
21
+ /**
22
+ * Removes a field from a content model. Existing entry data for this field is
23
+ * preserved but will no longer be validated. The model must not be locked.
24
+ */
25
+ delete(fieldID, params, options) {
26
+ const { model_id } = params;
27
+ return this._client.delete(path `/v1/content/models/${model_id}/fields/${fieldID}`, {
28
+ ...options,
29
+ headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
30
+ });
31
+ }
32
+ }
33
+ //# sourceMappingURL=fields.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"fields.mjs","sourceRoot":"","sources":["../../../../src/resources/beta/content/models/fields.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;OAGG;IACH,MAAM,CAAC,OAAe,EAAE,IAAuB,EAAE,OAAwB;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,sBAAsB,OAAO,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,OAAe,EAAE,MAAyB,EAAE,OAAwB;QACzE,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,sBAAsB,QAAQ,WAAW,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1G,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,OAAe,EAAE,MAAyB,EAAE,OAAwB;QACzE,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;QAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,sBAAsB,QAAQ,WAAW,OAAO,EAAE,EAAE;YACjF,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF"}
@@ -0,0 +1,3 @@
1
+ export { Fields, type FieldCreateParams, type FieldUpdateParams, type FieldDeleteParams } from "./fields.mjs";
2
+ export { Models, type Field, type Model, type ModelCreateParams, type ModelUpdateParams, type ModelListParams, type ModelsCursorIDPage, } from "./models.mjs";
3
+ //# sourceMappingURL=index.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../../src/resources/beta/content/models/index.ts"],"names":[],"mappings":"OAEO,EAAE,MAAM,EAAE,KAAK,iBAAiB,EAAE,KAAK,iBAAiB,EAAE,KAAK,iBAAiB,EAAE;OAClF,EACL,MAAM,EACN,KAAK,KAAK,EACV,KAAK,KAAK,EACV,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,kBAAkB,GACxB"}
@@ -0,0 +1,3 @@
1
+ export { Fields, type FieldCreateParams, type FieldUpdateParams, type FieldDeleteParams } from "./fields.js";
2
+ export { Models, type Field, type Model, type ModelCreateParams, type ModelUpdateParams, type ModelListParams, type ModelsCursorIDPage, } from "./models.js";
3
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/resources/beta/content/models/index.ts"],"names":[],"mappings":"OAEO,EAAE,MAAM,EAAE,KAAK,iBAAiB,EAAE,KAAK,iBAAiB,EAAE,KAAK,iBAAiB,EAAE;OAClF,EACL,MAAM,EACN,KAAK,KAAK,EACV,KAAK,KAAK,EACV,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,kBAAkB,GACxB"}
@@ -0,0 +1,9 @@
1
+ "use strict";
2
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.Models = exports.Fields = void 0;
5
+ var fields_1 = require("./fields.js");
6
+ Object.defineProperty(exports, "Fields", { enumerable: true, get: function () { return fields_1.Fields; } });
7
+ var models_1 = require("./models.js");
8
+ Object.defineProperty(exports, "Models", { enumerable: true, get: function () { return models_1.Models; } });
9
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/resources/beta/content/models/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,sCAA0G;AAAjG,gGAAA,MAAM,OAAA;AACf,sCAQkB;AAPhB,gGAAA,MAAM,OAAA"}
@@ -0,0 +1,4 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+ export { Fields } from "./fields.mjs";
3
+ export { Models, } from "./models.mjs";
4
+ //# sourceMappingURL=index.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../../src/resources/beta/content/models/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,MAAM,EAA0E;OAClF,EACL,MAAM,GAOP"}