@wix/auto_sdk_blog_posts 1.0.162 → 1.0.163

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 (45) hide show
  1. package/build/cjs/index.js +26 -26
  2. package/build/cjs/index.js.map +1 -1
  3. package/build/cjs/index.typings.d.ts +320 -320
  4. package/build/cjs/index.typings.js +26 -26
  5. package/build/cjs/index.typings.js.map +1 -1
  6. package/build/cjs/meta.d.ts +320 -320
  7. package/build/cjs/meta.js +26 -26
  8. package/build/cjs/meta.js.map +1 -1
  9. package/build/cjs/schemas.d.ts +3 -2
  10. package/build/cjs/schemas.js +2 -1
  11. package/build/cjs/schemas.js.map +1 -1
  12. package/build/es/index.mjs +26 -26
  13. package/build/es/index.mjs.map +1 -1
  14. package/build/es/index.typings.d.mts +320 -320
  15. package/build/es/index.typings.mjs +26 -26
  16. package/build/es/index.typings.mjs.map +1 -1
  17. package/build/es/meta.d.mts +320 -320
  18. package/build/es/meta.mjs +26 -26
  19. package/build/es/meta.mjs.map +1 -1
  20. package/build/es/schemas.d.mts +3 -2
  21. package/build/es/schemas.mjs +2 -1
  22. package/build/es/schemas.mjs.map +1 -1
  23. package/build/internal/cjs/index.js +26 -26
  24. package/build/internal/cjs/index.js.map +1 -1
  25. package/build/internal/cjs/index.typings.d.ts +320 -320
  26. package/build/internal/cjs/index.typings.js +26 -26
  27. package/build/internal/cjs/index.typings.js.map +1 -1
  28. package/build/internal/cjs/meta.d.ts +320 -320
  29. package/build/internal/cjs/meta.js +26 -26
  30. package/build/internal/cjs/meta.js.map +1 -1
  31. package/build/internal/cjs/schemas.d.ts +3 -2
  32. package/build/internal/cjs/schemas.js +2 -1
  33. package/build/internal/cjs/schemas.js.map +1 -1
  34. package/build/internal/es/index.mjs +26 -26
  35. package/build/internal/es/index.mjs.map +1 -1
  36. package/build/internal/es/index.typings.d.mts +320 -320
  37. package/build/internal/es/index.typings.mjs +26 -26
  38. package/build/internal/es/index.typings.mjs.map +1 -1
  39. package/build/internal/es/meta.d.mts +320 -320
  40. package/build/internal/es/meta.mjs +26 -26
  41. package/build/internal/es/meta.mjs.map +1 -1
  42. package/build/internal/es/schemas.d.mts +3 -2
  43. package/build/internal/es/schemas.mjs +2 -1
  44. package/build/internal/es/schemas.mjs.map +1 -1
  45. package/package.json +2 -2
@@ -2887,172 +2887,6 @@ interface PostUnlikedInitiatorOneOf {
2887
2887
  */
2888
2888
  anonymousVisitorId?: string | null;
2889
2889
  }
2890
- interface GetTotalLikesPerMemberRequest {
2891
- /**
2892
- * Member ID.
2893
- * @format GUID
2894
- */
2895
- memberId?: string;
2896
- }
2897
- interface GetTotalLikesPerMemberResponse {
2898
- /** The total number of likes of the member. */
2899
- total?: number;
2900
- }
2901
- interface DomainEvent extends DomainEventBodyOneOf {
2902
- createdEvent?: EntityCreatedEvent;
2903
- updatedEvent?: EntityUpdatedEvent;
2904
- deletedEvent?: EntityDeletedEvent;
2905
- actionEvent?: ActionEvent;
2906
- /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
2907
- id?: string;
2908
- /**
2909
- * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
2910
- * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
2911
- */
2912
- entityFqdn?: string;
2913
- /**
2914
- * Event action name, placed at the top level to make it easier for users to dispatch messages.
2915
- * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
2916
- */
2917
- slug?: string;
2918
- /** ID of the entity associated with the event. */
2919
- entityId?: string;
2920
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
2921
- eventTime?: Date | null;
2922
- /**
2923
- * Whether the event was triggered as a result of a privacy regulation application
2924
- * (for example, GDPR).
2925
- */
2926
- triggeredByAnonymizeRequest?: boolean | null;
2927
- /** If present, indicates the action that triggered the event. */
2928
- originatedFrom?: string | null;
2929
- /**
2930
- * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number.
2931
- * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
2932
- */
2933
- entityEventSequence?: string | null;
2934
- }
2935
- /** @oneof */
2936
- interface DomainEventBodyOneOf {
2937
- createdEvent?: EntityCreatedEvent;
2938
- updatedEvent?: EntityUpdatedEvent;
2939
- deletedEvent?: EntityDeletedEvent;
2940
- actionEvent?: ActionEvent;
2941
- }
2942
- interface EntityCreatedEvent {
2943
- entityAsJson?: string;
2944
- /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
2945
- restoreInfo?: RestoreInfo;
2946
- }
2947
- interface RestoreInfo {
2948
- deletedDate?: Date | null;
2949
- }
2950
- interface EntityUpdatedEvent {
2951
- /**
2952
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
2953
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
2954
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
2955
- */
2956
- currentEntityAsJson?: string;
2957
- }
2958
- interface EntityDeletedEvent {
2959
- /** Entity that was deleted. */
2960
- deletedEntityAsJson?: string | null;
2961
- }
2962
- interface ActionEvent {
2963
- bodyAsJson?: string;
2964
- }
2965
- interface MessageEnvelope {
2966
- /**
2967
- * App instance ID.
2968
- * @format GUID
2969
- */
2970
- instanceId?: string | null;
2971
- /**
2972
- * Event type.
2973
- * @maxLength 150
2974
- */
2975
- eventType?: string;
2976
- /** The identification type and identity data. */
2977
- identity?: IdentificationData;
2978
- /** Stringify payload. */
2979
- data?: string;
2980
- /** Details related to the account */
2981
- accountInfo?: AccountInfo;
2982
- }
2983
- interface IdentificationData extends IdentificationDataIdOneOf {
2984
- /**
2985
- * ID of a site visitor that has not logged in to the site.
2986
- * @format GUID
2987
- */
2988
- anonymousVisitorId?: string;
2989
- /**
2990
- * ID of a site visitor that has logged in to the site.
2991
- * @format GUID
2992
- */
2993
- memberId?: string;
2994
- /**
2995
- * ID of a Wix user (site owner, contributor, etc.).
2996
- * @format GUID
2997
- */
2998
- wixUserId?: string;
2999
- /**
3000
- * ID of an app.
3001
- * @format GUID
3002
- */
3003
- appId?: string;
3004
- /** @readonly */
3005
- identityType?: WebhookIdentityTypeWithLiterals;
3006
- }
3007
- /** @oneof */
3008
- interface IdentificationDataIdOneOf {
3009
- /**
3010
- * ID of a site visitor that has not logged in to the site.
3011
- * @format GUID
3012
- */
3013
- anonymousVisitorId?: string;
3014
- /**
3015
- * ID of a site visitor that has logged in to the site.
3016
- * @format GUID
3017
- */
3018
- memberId?: string;
3019
- /**
3020
- * ID of a Wix user (site owner, contributor, etc.).
3021
- * @format GUID
3022
- */
3023
- wixUserId?: string;
3024
- /**
3025
- * ID of an app.
3026
- * @format GUID
3027
- */
3028
- appId?: string;
3029
- }
3030
- declare enum WebhookIdentityType {
3031
- UNKNOWN = "UNKNOWN",
3032
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
3033
- MEMBER = "MEMBER",
3034
- WIX_USER = "WIX_USER",
3035
- APP = "APP"
3036
- }
3037
- /** @enumType */
3038
- type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
3039
- interface AccountInfo {
3040
- /**
3041
- * ID of the Wix account associated with the event.
3042
- * @format GUID
3043
- */
3044
- accountId?: string | null;
3045
- /**
3046
- * ID of the parent Wix account. Only included when accountId belongs to a child account.
3047
- * @format GUID
3048
- */
3049
- parentAccountId?: string | null;
3050
- /**
3051
- * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
3052
- * @format GUID
3053
- */
3054
- siteId?: string | null;
3055
- }
3056
2890
  /** Get Blog Publications Count Stats request */
3057
2891
  interface QueryPublicationsCountStatsRequest {
3058
2892
  /** Start of time range to return, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format. */
@@ -3173,193 +3007,171 @@ interface GetTotalPostsResponse {
3173
3007
  /** Total amount of published posts. */
3174
3008
  total?: number;
3175
3009
  }
3176
- interface ListDemoPostsRequest {
3010
+ interface DomainEvent extends DomainEventBodyOneOf {
3011
+ createdEvent?: EntityCreatedEvent;
3012
+ updatedEvent?: EntityUpdatedEvent;
3013
+ deletedEvent?: EntityDeletedEvent;
3014
+ actionEvent?: ActionEvent;
3015
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
3016
+ id?: string;
3177
3017
  /**
3178
- * Whether to return only featured posts.
3179
- *
3180
- * Default: `false`
3018
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
3019
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
3181
3020
  */
3182
- featured?: boolean;
3021
+ entityFqdn?: string;
3183
3022
  /**
3184
- * Hashtag filter.
3185
- *
3186
- * Pass an array of hashtags to return only posts containing any of the provided hashtags.
3187
- * If omitted, all posts with or without hashtags are returned.
3188
- * @maxSize 100
3189
- * @maxLength 100
3023
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
3024
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
3190
3025
  */
3191
- hashtags?: string[];
3026
+ slug?: string;
3027
+ /** ID of the entity associated with the event. */
3028
+ entityId?: string;
3029
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
3030
+ eventTime?: Date | null;
3192
3031
  /**
3193
- * Category filter.
3194
- *
3195
- * Pass an array of category IDs to return only posts with any of the provided categories.
3196
- * If omitted, all posts with or without associated categories are returned.
3197
- * @maxSize 50
3198
- * @format GUID
3032
+ * Whether the event was triggered as a result of a privacy regulation application
3033
+ * (for example, GDPR).
3199
3034
  */
3200
- categoryIds?: string[];
3035
+ triggeredByAnonymizeRequest?: boolean | null;
3036
+ /** If present, indicates the action that triggered the event. */
3037
+ originatedFrom?: string | null;
3201
3038
  /**
3202
- * Tag filter.
3203
- *
3204
- * Pass an array of tag IDs to return only posts with any of the provided tags.
3205
- * If omitted, all posts with or without tags are returned.
3206
- * @maxSize 50
3207
- * @format GUID
3039
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number.
3040
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
3208
3041
  */
3209
- tagIds?: string[];
3042
+ entityEventSequence?: string | null;
3043
+ }
3044
+ /** @oneof */
3045
+ interface DomainEventBodyOneOf {
3046
+ createdEvent?: EntityCreatedEvent;
3047
+ updatedEvent?: EntityUpdatedEvent;
3048
+ deletedEvent?: EntityDeletedEvent;
3049
+ actionEvent?: ActionEvent;
3050
+ }
3051
+ interface EntityCreatedEvent {
3052
+ entityAsJson?: string;
3053
+ /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
3054
+ restoreInfo?: RestoreInfo;
3055
+ }
3056
+ interface RestoreInfo {
3057
+ deletedDate?: Date | null;
3058
+ }
3059
+ interface EntityUpdatedEvent {
3210
3060
  /**
3211
- * Sorting options.
3212
- *
3213
- * - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
3214
- * - `VIEW_COUNT`: Ordered by total number of views in descending order.
3215
- * - `LIKE_COUNT`: Ordered by total number of likes in descending order.
3216
- * - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
3217
- * - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
3218
- * - `TITLE_ASC`: Ordered by `title` in ascending order.
3219
- * - `TITLE_DESC`: Ordered by `title` in descending order.
3220
- * - `RATING`: reserved for internal use.
3221
- *
3222
- * Default: `FEED`
3061
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
3062
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
3063
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
3223
3064
  */
3224
- sort?: GetPostsSortWithLiterals;
3225
- /** Pagination options. */
3226
- paging?: BlogPaging;
3065
+ currentEntityAsJson?: string;
3066
+ }
3067
+ interface EntityDeletedEvent {
3068
+ /** Entity that was deleted. */
3069
+ deletedEntityAsJson?: string | null;
3070
+ }
3071
+ interface ActionEvent {
3072
+ bodyAsJson?: string;
3073
+ }
3074
+ interface MessageEnvelope {
3227
3075
  /**
3228
- * __Deprecated.__ Use `fieldsets` instead.
3229
- * This parameter will be removed on June 30, 2023.
3230
- *
3231
- * List of post fields to be included in the response.
3232
- * @maxSize 20
3233
- * @deprecated __Deprecated.__ Use `fieldsets` instead.
3234
- * This parameter will be removed on June 30, 2023.
3235
- *
3236
- * List of post fields to be included in the response.
3237
- * @replacedBy fieldsets
3238
- * @targetRemovalDate 2024-06-30
3076
+ * App instance ID.
3077
+ * @format GUID
3239
3078
  */
3240
- fieldsToInclude?: PostFieldFieldWithLiterals[];
3079
+ instanceId?: string | null;
3241
3080
  /**
3242
- * Language filter.
3243
- *
3244
- * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3245
- * Pass a language to only receive posts that are in that language.
3246
- * If omitted, posts in all languages are returned.
3247
- * @format LANGUAGE_TAG
3081
+ * Event type.
3082
+ * @maxLength 150
3248
3083
  */
3249
- language?: string | null;
3084
+ eventType?: string;
3085
+ /** The identification type and identity data. */
3086
+ identity?: IdentificationData;
3087
+ /** Stringify payload. */
3088
+ data?: string;
3089
+ /** Details related to the account */
3090
+ accountInfo?: AccountInfo;
3091
+ }
3092
+ interface IdentificationData extends IdentificationDataIdOneOf {
3250
3093
  /**
3251
- * Post owner's member ID.
3094
+ * ID of a site visitor that has not logged in to the site.
3252
3095
  * @format GUID
3253
3096
  */
3254
- memberId?: string | null;
3255
- /**
3256
- * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3257
- * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
3258
- * only the post’s base fields are returned.
3259
- * @maxSize 20
3260
- */
3261
- fieldsets?: PostFieldFieldWithLiterals[];
3262
- }
3263
- declare enum GetPostsSort {
3264
- /** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
3265
- FEED = "FEED",
3266
- /** Ordered by `firstPublishedDate` in ascending order. */
3267
- PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
3268
- /** Ordered by `firstPublishedDate` in descending order. */
3269
- PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
3270
- /** Ordered by total number of views in descending order. */
3271
- VIEW_COUNT = "VIEW_COUNT",
3272
- /** Ordered by total number of likes in descending order. */
3273
- LIKE_COUNT = "LIKE_COUNT",
3274
- /** Ordered by `title` in ascending order. */
3275
- TITLE_ASC = "TITLE_ASC",
3276
- /** Ordered by `title` in descending order. */
3277
- TITLE_DESC = "TITLE_DESC"
3278
- }
3279
- /** @enumType */
3280
- type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
3281
- interface BlogPaging {
3097
+ anonymousVisitorId?: string;
3282
3098
  /**
3283
- * Number of items to skip in the current sort order.
3284
- *
3285
- *
3286
- * Default: `0`
3099
+ * ID of a site visitor that has logged in to the site.
3100
+ * @format GUID
3287
3101
  */
3288
- offset?: number;
3102
+ memberId?: string;
3289
3103
  /**
3290
- * Number of items to return.
3291
- *
3292
- *
3293
- * Default:`50`
3294
- * @min 1
3295
- * @max 100
3104
+ * ID of a Wix user (site owner, contributor, etc.).
3105
+ * @format GUID
3296
3106
  */
3297
- limit?: number;
3107
+ wixUserId?: string;
3298
3108
  /**
3299
- * Pointer to the next or previous page in the list of results.
3300
- * @maxLength 2000
3109
+ * ID of an app.
3110
+ * @format GUID
3301
3111
  */
3302
- cursor?: string | null;
3303
- }
3304
- declare enum PostFieldField {
3305
- UNKNOWN = "UNKNOWN",
3306
- /** Includes post URL when present. */
3307
- URL = "URL",
3308
- /** Includes post content text string when present. */
3309
- CONTENT_TEXT = "CONTENT_TEXT",
3310
- /** Includes post metrics when present. */
3311
- METRICS = "METRICS",
3312
- /** Includes SEO data. */
3313
- SEO = "SEO",
3314
- /** Includes post owner's contact ID. */
3315
- CONTACT_ID = "CONTACT_ID",
3316
- /** Includes post rich content. */
3317
- RICH_CONTENT = "RICH_CONTENT",
3318
- /** Includes post reference ID field. */
3319
- REFERENCE_ID = "REFERENCE_ID"
3320
- }
3321
- /** @enumType */
3322
- type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
3323
- interface ListDemoPostsResponse {
3324
- /** List of posts. */
3325
- posts?: Post[];
3326
- /** Details on the paged set of results returned. */
3327
- metaData?: MetaData;
3328
- }
3329
- interface MetaData {
3330
- /** Number of items returned in this response. */
3331
- count?: number;
3332
- /** Requested offset. */
3333
- offset?: number;
3334
- /** Total number of items that match the query. */
3335
- total?: number;
3112
+ appId?: string;
3113
+ /** @readonly */
3114
+ identityType?: WebhookIdentityTypeWithLiterals;
3115
+ }
3116
+ /** @oneof */
3117
+ interface IdentificationDataIdOneOf {
3336
3118
  /**
3337
- * Pointer to the next or previous page in the list of results.
3338
- * @maxLength 2000
3119
+ * ID of a site visitor that has not logged in to the site.
3120
+ * @format GUID
3339
3121
  */
3340
- cursor?: string | null;
3122
+ anonymousVisitorId?: string;
3123
+ /**
3124
+ * ID of a site visitor that has logged in to the site.
3125
+ * @format GUID
3126
+ */
3127
+ memberId?: string;
3128
+ /**
3129
+ * ID of a Wix user (site owner, contributor, etc.).
3130
+ * @format GUID
3131
+ */
3132
+ wixUserId?: string;
3133
+ /**
3134
+ * ID of an app.
3135
+ * @format GUID
3136
+ */
3137
+ appId?: string;
3341
3138
  }
3342
- interface ConvertDraftJsToRichContentRequest {
3343
- /** DraftJs content to convert to Rich content. */
3344
- content?: Record<string, any> | null;
3139
+ declare enum WebhookIdentityType {
3140
+ UNKNOWN = "UNKNOWN",
3141
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
3142
+ MEMBER = "MEMBER",
3143
+ WIX_USER = "WIX_USER",
3144
+ APP = "APP"
3345
3145
  }
3346
- interface ConvertDraftJsToRichContentResponse {
3146
+ /** @enumType */
3147
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
3148
+ interface AccountInfo {
3347
3149
  /**
3348
- * Rich content converted from DraftJs content.
3349
- * @maxLength 2000000
3150
+ * ID of the Wix account associated with the event.
3151
+ * @format GUID
3350
3152
  */
3351
- richContent?: string;
3153
+ accountId?: string | null;
3154
+ /**
3155
+ * ID of the parent Wix account. Only included when accountId belongs to a child account.
3156
+ * @format GUID
3157
+ */
3158
+ parentAccountId?: string | null;
3159
+ /**
3160
+ * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
3161
+ * @format GUID
3162
+ */
3163
+ siteId?: string | null;
3352
3164
  }
3353
- interface ConvertRichContentToDraftJsRequest {
3165
+ interface GetTotalLikesPerMemberRequest {
3354
3166
  /**
3355
- * Rich content to convert to DraftJs content.
3356
- * @maxLength 2000000
3167
+ * Member ID.
3168
+ * @format GUID
3357
3169
  */
3358
- richContent?: string;
3170
+ memberId?: string;
3359
3171
  }
3360
- interface ConvertRichContentToDraftJsResponse {
3361
- /** DraftJs content converted from Rich content. */
3362
- content?: Record<string, any> | null;
3172
+ interface GetTotalLikesPerMemberResponse {
3173
+ /** The total number of likes of the member. */
3174
+ total?: number;
3363
3175
  }
3364
3176
  interface PostCountersUpdated extends PostCountersUpdatedInitiatorOneOf {
3365
3177
  /**
@@ -3430,6 +3242,25 @@ interface GetPostRequest {
3430
3242
  */
3431
3243
  fieldsets?: PostFieldFieldWithLiterals[];
3432
3244
  }
3245
+ declare enum PostFieldField {
3246
+ UNKNOWN = "UNKNOWN",
3247
+ /** Includes post URL when present. */
3248
+ URL = "URL",
3249
+ /** Includes post content text string when present. */
3250
+ CONTENT_TEXT = "CONTENT_TEXT",
3251
+ /** Includes post metrics when present. */
3252
+ METRICS = "METRICS",
3253
+ /** Includes SEO data. */
3254
+ SEO = "SEO",
3255
+ /** Includes post owner's contact ID. */
3256
+ CONTACT_ID = "CONTACT_ID",
3257
+ /** Includes post rich content. */
3258
+ RICH_CONTENT = "RICH_CONTENT",
3259
+ /** Includes post reference ID field. */
3260
+ REFERENCE_ID = "REFERENCE_ID"
3261
+ }
3262
+ /** @enumType */
3263
+ type PostFieldFieldWithLiterals = PostFieldField | 'UNKNOWN' | 'URL' | 'CONTENT_TEXT' | 'METRICS' | 'SEO' | 'CONTACT_ID' | 'RICH_CONTENT' | 'REFERENCE_ID';
3433
3264
  interface GetPostResponse {
3434
3265
  /** Retrieved post info. */
3435
3266
  post?: Post;
@@ -3522,12 +3353,66 @@ interface ListPostsRequest {
3522
3353
  */
3523
3354
  fieldsets?: PostFieldFieldWithLiterals[];
3524
3355
  }
3356
+ declare enum GetPostsSort {
3357
+ /** Ordered by `firstPublishedDate` in descending order with pinned posts first. */
3358
+ FEED = "FEED",
3359
+ /** Ordered by `firstPublishedDate` in ascending order. */
3360
+ PUBLISHED_DATE_ASC = "PUBLISHED_DATE_ASC",
3361
+ /** Ordered by `firstPublishedDate` in descending order. */
3362
+ PUBLISHED_DATE_DESC = "PUBLISHED_DATE_DESC",
3363
+ /** Ordered by total number of views in descending order. */
3364
+ VIEW_COUNT = "VIEW_COUNT",
3365
+ /** Ordered by total number of likes in descending order. */
3366
+ LIKE_COUNT = "LIKE_COUNT",
3367
+ /** Ordered by `title` in ascending order. */
3368
+ TITLE_ASC = "TITLE_ASC",
3369
+ /** Ordered by `title` in descending order. */
3370
+ TITLE_DESC = "TITLE_DESC"
3371
+ }
3372
+ /** @enumType */
3373
+ type GetPostsSortWithLiterals = GetPostsSort | 'FEED' | 'PUBLISHED_DATE_ASC' | 'PUBLISHED_DATE_DESC' | 'VIEW_COUNT' | 'LIKE_COUNT' | 'TITLE_ASC' | 'TITLE_DESC';
3374
+ interface BlogPaging {
3375
+ /**
3376
+ * Number of items to skip in the current sort order.
3377
+ *
3378
+ *
3379
+ * Default: `0`
3380
+ */
3381
+ offset?: number;
3382
+ /**
3383
+ * Number of items to return.
3384
+ *
3385
+ *
3386
+ * Default:`50`
3387
+ * @min 1
3388
+ * @max 100
3389
+ */
3390
+ limit?: number;
3391
+ /**
3392
+ * Pointer to the next or previous page in the list of results.
3393
+ * @maxLength 2000
3394
+ */
3395
+ cursor?: string | null;
3396
+ }
3525
3397
  interface ListPostsResponse {
3526
3398
  /** List of retrieved posts. */
3527
3399
  posts?: Post[];
3528
3400
  /** Details on the paged set of results returned. */
3529
3401
  metaData?: MetaData;
3530
3402
  }
3403
+ interface MetaData {
3404
+ /** Number of items returned in this response. */
3405
+ count?: number;
3406
+ /** Requested offset. */
3407
+ offset?: number;
3408
+ /** Total number of items that match the query. */
3409
+ total?: number;
3410
+ /**
3411
+ * Pointer to the next or previous page in the list of results.
3412
+ * @maxLength 2000
3413
+ */
3414
+ cursor?: string | null;
3415
+ }
3531
3416
  interface QueryPostsRequest {
3532
3417
  /** Query options. */
3533
3418
  query?: PlatformQuery;
@@ -3871,6 +3756,121 @@ interface PostCount {
3871
3756
  /** Number of posts. */
3872
3757
  postCount?: number;
3873
3758
  }
3759
+ interface ListDemoPostsRequest {
3760
+ /**
3761
+ * Whether to return only featured posts.
3762
+ *
3763
+ * Default: `false`
3764
+ */
3765
+ featured?: boolean;
3766
+ /**
3767
+ * Hashtag filter.
3768
+ *
3769
+ * Pass an array of hashtags to return only posts containing any of the provided hashtags.
3770
+ * If omitted, all posts with or without hashtags are returned.
3771
+ * @maxSize 100
3772
+ * @maxLength 100
3773
+ */
3774
+ hashtags?: string[];
3775
+ /**
3776
+ * Category filter.
3777
+ *
3778
+ * Pass an array of category IDs to return only posts with any of the provided categories.
3779
+ * If omitted, all posts with or without associated categories are returned.
3780
+ * @maxSize 50
3781
+ * @format GUID
3782
+ */
3783
+ categoryIds?: string[];
3784
+ /**
3785
+ * Tag filter.
3786
+ *
3787
+ * Pass an array of tag IDs to return only posts with any of the provided tags.
3788
+ * If omitted, all posts with or without tags are returned.
3789
+ * @maxSize 50
3790
+ * @format GUID
3791
+ */
3792
+ tagIds?: string[];
3793
+ /**
3794
+ * Sorting options.
3795
+ *
3796
+ * - `FEED`: Ordered by `firstPublishedDate` in descending order with pinned posts first.
3797
+ * - `VIEW_COUNT`: Ordered by total number of views in descending order.
3798
+ * - `LIKE_COUNT`: Ordered by total number of likes in descending order.
3799
+ * - `PUBLISHED_DATE_ASC`: Ordered by `firstPublishedDate` in ascending order.
3800
+ * - `PUBLISHED_DATE_DESC`: Ordered by `firstPublishedDate` in descending order.
3801
+ * - `TITLE_ASC`: Ordered by `title` in ascending order.
3802
+ * - `TITLE_DESC`: Ordered by `title` in descending order.
3803
+ * - `RATING`: reserved for internal use.
3804
+ *
3805
+ * Default: `FEED`
3806
+ */
3807
+ sort?: GetPostsSortWithLiterals;
3808
+ /** Pagination options. */
3809
+ paging?: BlogPaging;
3810
+ /**
3811
+ * __Deprecated.__ Use `fieldsets` instead.
3812
+ * This parameter will be removed on June 30, 2023.
3813
+ *
3814
+ * List of post fields to be included in the response.
3815
+ * @maxSize 20
3816
+ * @deprecated __Deprecated.__ Use `fieldsets` instead.
3817
+ * This parameter will be removed on June 30, 2023.
3818
+ *
3819
+ * List of post fields to be included in the response.
3820
+ * @replacedBy fieldsets
3821
+ * @targetRemovalDate 2024-06-30
3822
+ */
3823
+ fieldsToInclude?: PostFieldFieldWithLiterals[];
3824
+ /**
3825
+ * Language filter.
3826
+ *
3827
+ * 2-or-4-letter language code in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
3828
+ * Pass a language to only receive posts that are in that language.
3829
+ * If omitted, posts in all languages are returned.
3830
+ * @format LANGUAGE_TAG
3831
+ */
3832
+ language?: string | null;
3833
+ /**
3834
+ * Post owner's member ID.
3835
+ * @format GUID
3836
+ */
3837
+ memberId?: string | null;
3838
+ /**
3839
+ * List of additional post fields to include in the response. For example, use the `URL` fieldset to retrieve the url field in
3840
+ * the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default
3841
+ * only the post’s base fields are returned.
3842
+ * @maxSize 20
3843
+ */
3844
+ fieldsets?: PostFieldFieldWithLiterals[];
3845
+ }
3846
+ interface ListDemoPostsResponse {
3847
+ /** List of posts. */
3848
+ posts?: Post[];
3849
+ /** Details on the paged set of results returned. */
3850
+ metaData?: MetaData;
3851
+ }
3852
+ interface ConvertDraftJsToRichContentRequest {
3853
+ /** DraftJs content to convert to Rich content. */
3854
+ content?: Record<string, any> | null;
3855
+ }
3856
+ interface ConvertDraftJsToRichContentResponse {
3857
+ /**
3858
+ * Rich content converted from DraftJs content.
3859
+ * @maxLength 2000000
3860
+ */
3861
+ richContent?: string;
3862
+ }
3863
+ interface ConvertRichContentToDraftJsRequest {
3864
+ /**
3865
+ * Rich content to convert to DraftJs content.
3866
+ * @maxLength 2000000
3867
+ */
3868
+ richContent?: string;
3869
+ }
3870
+ interface ConvertRichContentToDraftJsResponse {
3871
+ /** DraftJs content converted from Rich content. */
3872
+ content?: Record<string, any> | null;
3873
+ }
3874
3874
 
3875
3875
  type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
3876
3876
  getUrl: (context: any) => string;