@wix/auto_sdk_blog_draft-posts 1.0.90 → 1.0.91

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.
@@ -82,6 +82,25 @@ interface DraftPost {
82
82
  * @format LANGUAGE_TAG
83
83
  */
84
84
  language?: string | null;
85
+ /**
86
+ * Reserved for internal use.
87
+ * @internal
88
+ * @readonly
89
+ */
90
+ changeOrigin?: OriginWithLiterals;
91
+ /**
92
+ * Reserved for internal use.
93
+ * @internal
94
+ * @readonly
95
+ * @maxLength 24
96
+ */
97
+ contentId?: string | null;
98
+ /**
99
+ * Reserved for internal use.
100
+ * @internal
101
+ * @format GUID
102
+ */
103
+ editingSessionId?: string | null;
85
104
  /**
86
105
  * Draft Post rich content.
87
106
  *
@@ -97,6 +116,13 @@ interface DraftPost {
97
116
  status?: StatusWithLiterals;
98
117
  /** Details of the draft post in review. Only relevant to posts submitted by guest writers. */
99
118
  moderationDetails?: ModerationDetails;
119
+ /**
120
+ * Reserved for internal use.
121
+ * @internal
122
+ * @readonly
123
+ * @format GUID
124
+ */
125
+ mostRecentContributorId?: string | null;
100
126
  /**
101
127
  * Indicates if there are changes made to the draft post that have not yet been published.
102
128
  * @readonly
@@ -112,10 +138,23 @@ interface DraftPost {
112
138
  * @readonly
113
139
  */
114
140
  scheduledPublishDate?: Date | null;
141
+ /**
142
+ * Reserved for internal use.
143
+ * @internal
144
+ */
145
+ content?: Record<string, any> | null;
115
146
  /** Date the post was first published. */
116
147
  firstPublishedDate?: Date | null;
117
148
  /** SEO data. */
118
149
  seoData?: SeoSchema;
150
+ /**
151
+ * Reserved for internal use.
152
+ * @internal
153
+ * @readonly
154
+ * @maxSize 5000
155
+ * @maxLength 100
156
+ */
157
+ slugs?: string[];
119
158
  /**
120
159
  * Draft post URL preview. What the URL will look like once the post is published.
121
160
  * @readonly
@@ -135,6 +174,32 @@ interface DraftPost {
135
174
  media?: Media;
136
175
  /** Number of paragraphs to display in a paid content preview for non-paying users. */
137
176
  previewTextParagraph?: number | null;
177
+ /**
178
+ * List of the post's translated posts.
179
+ * @internal
180
+ * @readonly
181
+ * @maxSize 1000
182
+ */
183
+ translations?: DraftPostTranslation[];
184
+ /**
185
+ * Reserved for internal use, not included in base response.
186
+ * @internal
187
+ * @format GUID
188
+ */
189
+ originPostId?: string | null;
190
+ /**
191
+ * Reserved for internal use, not included in base response.
192
+ * @internal
193
+ * @format GUID
194
+ */
195
+ originPostInstanceId?: string | null;
196
+ /**
197
+ * Reserved for internal use.
198
+ * @internal
199
+ * @readonly
200
+ * @maxLength 24
201
+ */
202
+ internalId?: string | null;
138
203
  }
139
204
  interface Image {
140
205
  /** WixMedia image ID. */
@@ -153,11 +218,29 @@ interface Image {
153
218
  width?: number;
154
219
  /** Image alt text. */
155
220
  altText?: string | null;
221
+ /**
222
+ * Image URL expiration date (when relevant).
223
+ * @internal
224
+ * @readonly
225
+ */
226
+ urlExpirationDate?: Date | null;
156
227
  /**
157
228
  * Image filename.
158
229
  * @readonly
159
230
  */
160
231
  filename?: string | null;
232
+ /**
233
+ * Image size in bytes.
234
+ * @internal
235
+ * @readonly
236
+ * @format DECIMAL_VALUE
237
+ */
238
+ sizeInBytes?: string | null;
239
+ /**
240
+ * Focal point of the image.
241
+ * @internal
242
+ */
243
+ focalPoint?: FocalPoint;
161
244
  }
162
245
  interface FocalPoint {
163
246
  /** X-coordinate of the focal point. */
@@ -2847,6 +2930,13 @@ declare enum Status {
2847
2930
  SCHEDULED = "SCHEDULED",
2848
2931
  /** Status indicating the draft post is deleted. */
2849
2932
  DELETED = "DELETED",
2933
+ /**
2934
+ * Deprecated. Use `IN_REVIEW` instead. Status indicating the draft post is in review.
2935
+ * Target removal date 2024-06-30
2936
+ * Reserved for internal use.
2937
+ * @internal
2938
+ */
2939
+ IN_MODERATION = "IN_MODERATION",
2850
2940
  /** Status indicating the draft post is in review. */
2851
2941
  IN_REVIEW = "IN_REVIEW"
2852
2942
  }
@@ -2973,6 +3063,11 @@ interface WixMedia {
2973
3063
  interface VideoV2 {
2974
3064
  /** WixMedia ID. */
2975
3065
  id?: string;
3066
+ /**
3067
+ * Original video URL.
3068
+ * @internal
3069
+ */
3070
+ url?: string;
2976
3071
  /**
2977
3072
  * Available resolutions for the video, starting with the optimal resolution.
2978
3073
  * @readonly
@@ -2984,6 +3079,55 @@ interface VideoV2 {
2984
3079
  * @readonly
2985
3080
  */
2986
3081
  filename?: string | null;
3082
+ /**
3083
+ * Video posters.
3084
+ * @internal
3085
+ * @readonly
3086
+ */
3087
+ posters?: Image[];
3088
+ /**
3089
+ * Original video size in bytes.
3090
+ * @internal
3091
+ * @readonly
3092
+ * @format DECIMAL_VALUE
3093
+ */
3094
+ sizeInBytes?: string | null;
3095
+ /**
3096
+ * Video URL expiration date (when relevant).
3097
+ * @internal
3098
+ * @readonly
3099
+ */
3100
+ urlExpirationDate?: Date | null;
3101
+ /**
3102
+ * Original video duration in milliseconds.
3103
+ * @internal
3104
+ * @readonly
3105
+ */
3106
+ durationInMilliseconds?: number | null;
3107
+ /**
3108
+ * A short title for the video. will be used for SEO purposes.
3109
+ * @internal
3110
+ * @maxLength 300
3111
+ */
3112
+ title?: string | null;
3113
+ /**
3114
+ * A long description for the video. will be used for SEO purposes.
3115
+ * @internal
3116
+ * @maxLength 2000
3117
+ */
3118
+ description?: string | null;
3119
+ /**
3120
+ * Original video height.
3121
+ * @internal
3122
+ * @readonly
3123
+ */
3124
+ height?: number | null;
3125
+ /**
3126
+ * Original video width.
3127
+ * @internal
3128
+ * @readonly
3129
+ */
3130
+ width?: number | null;
2987
3131
  }
2988
3132
  interface VideoResolution {
2989
3133
  /** Video URL. */
@@ -2992,8 +3136,68 @@ interface VideoResolution {
2992
3136
  height?: number;
2993
3137
  /** Video width. */
2994
3138
  width?: number;
3139
+ /**
3140
+ * Deprecated. Use the `posters` property in the parent entity instead.
3141
+ * @internal
3142
+ * @deprecated
3143
+ */
3144
+ poster?: Image;
2995
3145
  /** Video format for example, mp4, hls. */
2996
3146
  format?: string;
3147
+ /**
3148
+ * Deprecated. Use the `urlExpirationDate` property in the parent entity instead.
3149
+ * @internal
3150
+ * @deprecated
3151
+ */
3152
+ urlExpirationDate?: Date | null;
3153
+ /**
3154
+ * Deprecated. Use the `sizeInBytes` property in the parent entity instead. Size cannot be provided per resolution.
3155
+ * @internal
3156
+ * @format DECIMAL_VALUE
3157
+ * @deprecated
3158
+ */
3159
+ sizeInBytes?: string | null;
3160
+ /**
3161
+ * Video quality. For example: 480p, 720p.
3162
+ * @internal
3163
+ */
3164
+ quality?: string | null;
3165
+ /**
3166
+ * Video filename.
3167
+ * @internal
3168
+ */
3169
+ filename?: string | null;
3170
+ /**
3171
+ * Video duration in seconds.
3172
+ * @internal
3173
+ * @readonly
3174
+ * @deprecated Video duration in seconds.
3175
+ * @replacedBy duration_in_milliseconds
3176
+ * @targetRemovalDate 2024-08-01
3177
+ */
3178
+ durationInSeconds?: number | null;
3179
+ /**
3180
+ * Video duration in milliseconds.
3181
+ * @internal
3182
+ * @readonly
3183
+ */
3184
+ durationInMilliseconds?: number | null;
3185
+ /**
3186
+ * When true, this is a protected asset, and calling the URL will return a 403 error.
3187
+ * In order to access private assets, make a request to:
3188
+ * `GenerateFileDownloadUrl` with the WixMedia id and specify the asset_key in the request
3189
+ * @internal
3190
+ * @readonly
3191
+ */
3192
+ private?: boolean | null;
3193
+ /**
3194
+ * Key to identify the video resolution's relationship to the original media in WixMedia.
3195
+ * Can be used to request a download for the specific video resolution.
3196
+ * For example: 480p.mp4, 720p.mp4, 1080p.mp4, trailer-720p.mp4, clip-720p.mp4
3197
+ * @internal
3198
+ * @readonly
3199
+ */
3200
+ assetKey?: string | null;
2997
3201
  }
2998
3202
  interface EmbedMedia {
2999
3203
  /** Thumbnail details. */
@@ -3097,6 +3301,11 @@ interface CreateDraftPostRequest {
3097
3301
  * Default: `false`
3098
3302
  */
3099
3303
  publish?: boolean;
3304
+ /**
3305
+ * Save type.
3306
+ * @internal
3307
+ */
3308
+ saveType?: TypeWithLiterals;
3100
3309
  /**
3101
3310
  * List of additional draft post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3102
3311
  * the response in addition to the draft post's base fields. Base fields don’t include any of the supported fieldset values. By default
@@ -3125,10 +3334,21 @@ declare enum Field {
3125
3334
  UNKNOWN = "UNKNOWN",
3126
3335
  /** Includes draft post preview URL. */
3127
3336
  URL = "URL",
3337
+ /**
3338
+ * Includes internal id field.
3339
+ * Reserved for internal use.
3340
+ * @internal
3341
+ */
3342
+ INTERNAL_ID = "INTERNAL_ID",
3128
3343
  /** Includes content field. */
3129
3344
  CONTENT = "CONTENT",
3130
3345
  /** Includes rich content field. */
3131
3346
  RICH_CONTENT = "RICH_CONTENT",
3347
+ /**
3348
+ * Includes draft post translations when present.
3349
+ * @internal
3350
+ */
3351
+ TRANSLATIONS = "TRANSLATIONS",
3132
3352
  /** If the user has not set excerpt, returns the one autogenerated from content. */
3133
3353
  GENERATED_EXCERPT = "GENERATED_EXCERPT"
3134
3354
  }
@@ -3147,6 +3367,11 @@ interface BulkCreateDraftPostsRequest {
3147
3367
  draftPosts: DraftPost[];
3148
3368
  /** Whether the draft post should be published after creation. */
3149
3369
  publish?: boolean;
3370
+ /**
3371
+ * Save type.
3372
+ * @internal
3373
+ */
3374
+ saveType?: TypeWithLiterals;
3150
3375
  /** Whether to return the full created draft post entities in the response. */
3151
3376
  returnFullEntity?: boolean;
3152
3377
  /**
@@ -3210,6 +3435,11 @@ interface BulkUpdateDraftPostsRequest {
3210
3435
  action?: ActionWithLiterals;
3211
3436
  /** Posts' scheduled publish date when `action` is set to `UPDATE_SCHEDULE`. */
3212
3437
  scheduledPublishDate?: Date | null;
3438
+ /**
3439
+ * Save type.
3440
+ * @internal
3441
+ */
3442
+ saveType?: TypeWithLiterals;
3213
3443
  /** Whether to return the full updated draft post entities in the response. */
3214
3444
  returnFullEntity?: boolean;
3215
3445
  /**
@@ -3251,6 +3481,18 @@ interface BulkUpdateDraftPostsResponse {
3251
3481
  bulkActionMetadata?: BulkActionMetadata;
3252
3482
  }
3253
3483
  interface DraftPostOwnerChanged {
3484
+ /**
3485
+ * Member ID of the draft post's owner before the change.
3486
+ * @internal
3487
+ * @format GUID
3488
+ */
3489
+ oldMemberId?: string;
3490
+ /**
3491
+ * Member ID of the draft post's owner after the change.
3492
+ * @internal
3493
+ * @format GUID
3494
+ */
3495
+ newMemberId?: string;
3254
3496
  }
3255
3497
  interface ListDeletedDraftPostsRequest {
3256
3498
  /**
@@ -3331,6 +3573,13 @@ interface PagingMetadataV2 {
3331
3573
  tooManyToCount?: boolean | null;
3332
3574
  /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
3333
3575
  cursors?: Cursors;
3576
+ /**
3577
+ * Indicates if there are more results after the current page.
3578
+ * If `true`, another page of results can be retrieved.
3579
+ * If `false`, this is the last page.
3580
+ * @internal
3581
+ */
3582
+ hasNext?: boolean | null;
3334
3583
  }
3335
3584
  interface Cursors {
3336
3585
  /**
@@ -3387,6 +3636,16 @@ interface UpdateDraftPostContentResponse {
3387
3636
  interface UpdateDraftPostRequest {
3388
3637
  /** Draft post to update. */
3389
3638
  draftPost: DraftPost;
3639
+ /**
3640
+ * Field mask of fields to update.
3641
+ * @internal
3642
+ */
3643
+ fieldMask?: string[];
3644
+ /**
3645
+ * Save type.
3646
+ * @internal
3647
+ */
3648
+ saveType?: TypeWithLiterals;
3390
3649
  /**
3391
3650
  * Action to perform on the post.
3392
3651
  *
@@ -3567,6 +3826,20 @@ interface Sorting {
3567
3826
  fieldName?: string;
3568
3827
  /** Sort order. */
3569
3828
  order?: SortOrderWithLiterals;
3829
+ /**
3830
+ * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
3831
+ * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
3832
+ *
3833
+ * If multiple filters are provided, they are combined with AND operator.
3834
+ *
3835
+ * Example:
3836
+ * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
3837
+ * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
3838
+ * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
3839
+ * @internal
3840
+ * @maxSize 10
3841
+ */
3842
+ selectItemsBy?: Record<string, any>[] | null;
3570
3843
  /**
3571
3844
  * Origin point for geo-distance sorting on a GEO field
3572
3845
  * results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
@@ -3711,8 +3984,18 @@ interface DomainEventBodyOneOf {
3711
3984
  }
3712
3985
  interface EntityCreatedEvent {
3713
3986
  entityAsJson?: string;
3987
+ /**
3988
+ * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity
3989
+ * @internal
3990
+ */
3991
+ triggeredByUndelete?: boolean | null;
3714
3992
  /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
3715
3993
  restoreInfo?: RestoreInfo;
3994
+ /**
3995
+ * Optional domain-specific metadata defined by the API owner, encoded as JSON.
3996
+ * @internal
3997
+ */
3998
+ additionalMetadataAsJson?: string | null;
3716
3999
  }
3717
4000
  interface RestoreInfo {
3718
4001
  deletedDate?: Date | null;
@@ -3724,10 +4007,42 @@ interface EntityUpdatedEvent {
3724
4007
  * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
3725
4008
  */
3726
4009
  currentEntityAsJson?: string;
4010
+ /**
4011
+ * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard
4012
+ * wont populate it / have any reference to it in the API.
4013
+ * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,
4014
+ * the developer should send only the new (current) entity.
4015
+ * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big
4016
+ * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.
4017
+ * @internal
4018
+ * @deprecated
4019
+ */
4020
+ previousEntityAsJson?: string | null;
4021
+ /**
4022
+ * Map of fully qualified field paths to their previous values for fields that changed.
4023
+ * For more details please see [AIP](https://dev.wix.com/docs/rnd-general/articles/p13n-guidelines-aips/guidance-aips/design-patterns/7016-events#modified-fields-format)
4024
+ * @internal
4025
+ */
4026
+ modifiedFields?: Record<string, any>;
4027
+ /**
4028
+ * Optional domain-specific metadata defined by the API owner, encoded as JSON.
4029
+ * @internal
4030
+ */
4031
+ additionalMetadataAsJson?: string | null;
3727
4032
  }
3728
4033
  interface EntityDeletedEvent {
4034
+ /**
4035
+ * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled
4036
+ * @internal
4037
+ */
4038
+ movedToTrash?: boolean | null;
3729
4039
  /** Entity that was deleted. */
3730
4040
  deletedEntityAsJson?: string | null;
4041
+ /**
4042
+ * Optional domain-specific metadata defined by the API owner, encoded as JSON.
4043
+ * @internal
4044
+ */
4045
+ additionalMetadataAsJson?: string | null;
3731
4046
  }
3732
4047
  interface ActionEvent {
3733
4048
  bodyAsJson?: string;
@@ -3878,6 +4193,11 @@ interface TranslateDraftRequest {
3878
4193
  * @maxSize 10
3879
4194
  */
3880
4195
  fieldsets?: FieldWithLiterals[];
4196
+ /**
4197
+ * Performs automatic translation of the title and the content of the draft post to the target language.
4198
+ * @internal
4199
+ */
4200
+ useAutoTranslation?: boolean;
3881
4201
  }
3882
4202
  interface TranslateDraftResponse {
3883
4203
  /** Draft post. */
@@ -3973,6 +4293,15 @@ interface RevertToUnpublishedRequest {
3973
4293
  * @format GUID
3974
4294
  */
3975
4295
  postId?: string;
4296
+ /**
4297
+ * List of draft post fields to be included in the response.
4298
+ * @internal
4299
+ * @maxSize 10
4300
+ * @deprecated List of draft post fields to be included in the response.
4301
+ * @replacedBy fieldsets
4302
+ * @targetRemovalDate 2024-06-30
4303
+ */
4304
+ fieldsToInclude?: FieldWithLiterals[];
3976
4305
  /**
3977
4306
  * List of draft post fields to be included if entities are present in the response.
3978
4307
  * Base fieldset, which is default, will return all core draft post properties.
@@ -3991,6 +4320,15 @@ interface RejectDraftPostRequest {
3991
4320
  * @format GUID
3992
4321
  */
3993
4322
  postId?: string;
4323
+ /**
4324
+ * List of draft post fields to be included in the response.
4325
+ * @internal
4326
+ * @maxSize 10
4327
+ * @deprecated List of draft post fields to be included in the response.
4328
+ * @replacedBy fieldsets
4329
+ * @targetRemovalDate 2024-06-30
4330
+ */
4331
+ fieldsToInclude?: FieldWithLiterals[];
3994
4332
  /**
3995
4333
  * List of draft post fields to be included if entities are present in the response.
3996
4334
  * Base fieldset, which is default, will return all core draft post properties.
@@ -4014,6 +4352,15 @@ interface ApproveDraftPostRequest {
4014
4352
  * @maxLength 24
4015
4353
  */
4016
4354
  scheduledPublishDate?: string | null;
4355
+ /**
4356
+ * List of draft post fields to be included in the response.
4357
+ * @internal
4358
+ * @maxSize 10
4359
+ * @deprecated List of draft post fields to be included in the response.
4360
+ * @replacedBy fieldsets
4361
+ * @targetRemovalDate 2024-06-30
4362
+ */
4363
+ fieldsToInclude?: FieldWithLiterals[];
4017
4364
  /**
4018
4365
  * List of draft post fields to be included if entities are present in the response.
4019
4366
  * Base fieldset, which is default, will return all core draft post properties.
@@ -4032,6 +4379,15 @@ interface MarkPostAsInModerationRequest {
4032
4379
  * @maxLength 38
4033
4380
  */
4034
4381
  postId?: string;
4382
+ /**
4383
+ * List of draft post fields to be included in the response.
4384
+ * @internal
4385
+ * @maxSize 10
4386
+ * @deprecated List of draft post fields to be included in the response.
4387
+ * @replacedBy fieldsets
4388
+ * @targetRemovalDate 2024-06-30
4389
+ */
4390
+ fieldsToInclude?: FieldWithLiterals[];
4035
4391
  /**
4036
4392
  * List of draft post fields to be included if entities are present in the response.
4037
4393
  * Base fieldset, which is default, will return all core draft post properties.
@@ -3592,6 +3592,7 @@ var Status = /* @__PURE__ */ ((Status2) => {
3592
3592
  Status2["UNPUBLISHED"] = "UNPUBLISHED";
3593
3593
  Status2["SCHEDULED"] = "SCHEDULED";
3594
3594
  Status2["DELETED"] = "DELETED";
3595
+ Status2["IN_MODERATION"] = "IN_MODERATION";
3595
3596
  Status2["IN_REVIEW"] = "IN_REVIEW";
3596
3597
  return Status2;
3597
3598
  })(Status || {});
@@ -3613,8 +3614,10 @@ var Type = /* @__PURE__ */ ((Type2) => {
3613
3614
  var Field = /* @__PURE__ */ ((Field2) => {
3614
3615
  Field2["UNKNOWN"] = "UNKNOWN";
3615
3616
  Field2["URL"] = "URL";
3617
+ Field2["INTERNAL_ID"] = "INTERNAL_ID";
3616
3618
  Field2["CONTENT"] = "CONTENT";
3617
3619
  Field2["RICH_CONTENT"] = "RICH_CONTENT";
3620
+ Field2["TRANSLATIONS"] = "TRANSLATIONS";
3618
3621
  Field2["GENERATED_EXCERPT"] = "GENERATED_EXCERPT";
3619
3622
  return Field2;
3620
3623
  })(Field || {});