@productcraft/social 1.1.2 → 1.2.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.
- package/README.md +10 -0
- package/api.md +250 -246
- package/dist/index.cjs +257 -247
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +270 -249
- package/dist/index.d.ts +270 -249
- package/dist/index.js +257 -247
- package/dist/index.js.map +1 -1
- package/manifest.json +198 -198
- package/package.json +2 -2
package/dist/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { LastResponse, WebhookPayload, WebhookHeaders, APIClient, RequestOptions, PagePromise, APIPromise, ClientOptions, PollOptions } from '@productcraft/core';
|
|
1
|
+
import { LastResponse, WebhookPayload, WebhookHeaders, APIClient, RequestOptions, PagePromise, APIPromise, SignedWebhook, ClientOptions, PollOptions } from '@productcraft/core';
|
|
2
2
|
export { APIConnectionError, APIError, APITimeoutError, APIUserAbortError, AuthenticationError, BadRequestError, ConfigurationError, ConflictError, IdempotencyKeyReuseError, InternalServerError, NotFoundError, PermissionDeniedError, ProductCraftError, RateLimitError, UnprocessableEntityError, WebhookVerificationError } from '@productcraft/core';
|
|
3
3
|
import { Client } from 'openapi-fetch';
|
|
4
4
|
|
|
@@ -29057,8 +29057,8 @@ interface operations {
|
|
|
29057
29057
|
|
|
29058
29058
|
type IsUnion<T, U = T> = T extends unknown ? ([U] extends [T] ? false : true) : never;
|
|
29059
29059
|
type OpenString<T extends string> = string extends T ? T : true extends IsUnion<T> ? T | (string & {}) : T;
|
|
29060
|
-
type OpenValue<T> = [T] extends [string] ? OpenString<T> : T extends readonly (infer I)[] ?
|
|
29061
|
-
[K in keyof T]:
|
|
29060
|
+
type OpenValue<T> = [T] extends [string] ? OpenString<T> : T extends readonly (infer I)[] ? (OpenValue<Exclude<I, null | undefined>> | Extract<I, null | undefined>)[] : T extends object ? {
|
|
29061
|
+
[K in keyof T]: OpenValue<Exclude<T[K], null | undefined>> | Extract<T[K], null | undefined>;
|
|
29062
29062
|
} : T;
|
|
29063
29063
|
/** A response type: string-literal unions also accept values added after this SDK was built. */
|
|
29064
29064
|
type Open<T> = OpenValue<Exclude<T, null | undefined>> | Extract<T, null | undefined>;
|
|
@@ -29914,6 +29914,17 @@ interface WebhookUnwrapParams {
|
|
|
29914
29914
|
/** Accepted clock skew in seconds. Default 300. */
|
|
29915
29915
|
toleranceSeconds?: number;
|
|
29916
29916
|
}
|
|
29917
|
+
/** `webhooks.sign()`: what to sign. Tests only; ProductCraft signs real deliveries. */
|
|
29918
|
+
interface WebhookSignParams {
|
|
29919
|
+
/** The event: an `UnwrapWebhookEvent`-shaped object (JSON-encoded) or the exact body string. */
|
|
29920
|
+
payload: WebhookPayload | Record<string, unknown>;
|
|
29921
|
+
/** Signing secret. Default: the client's `webhookSecret` (the first, when several), then `PRODUCTCRAFT_SOCIAL_WEBHOOK_SECRET`. */
|
|
29922
|
+
secret?: string;
|
|
29923
|
+
/** `webhook-id`. Default: a random `msg_…` id. */
|
|
29924
|
+
id?: string;
|
|
29925
|
+
/** Unix seconds for `webhook-timestamp`. Default: now. */
|
|
29926
|
+
timestamp?: number;
|
|
29927
|
+
}
|
|
29917
29928
|
|
|
29918
29929
|
type Bound = Readonly<Record<string, string | undefined>>;
|
|
29919
29930
|
declare class APIResource {
|
|
@@ -29938,10 +29949,10 @@ declare class CommunitiesActorsCommentsResource extends APIResource {
|
|
|
29938
29949
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-workspaces-workspace-id-communities-community-id-actors-actor-id-comments
|
|
29939
29950
|
* @example
|
|
29940
29951
|
* ```ts
|
|
29941
|
-
* for await (const comment of social.communities.actors.comments.list("
|
|
29952
|
+
* for await (const comment of social.communities.actors.comments.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f")) {
|
|
29942
29953
|
* console.log(comment);
|
|
29943
29954
|
* }
|
|
29944
|
-
* const page = await social.communities.actors.comments.list("
|
|
29955
|
+
* const page = await social.communities.actors.comments.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {}, { timeout: 5_000 });
|
|
29945
29956
|
* ```
|
|
29946
29957
|
*/
|
|
29947
29958
|
list(communityId: string, actorId: string, params?: CommunityActorCommentListParams, options?: RequestOptions): PagePromise<Comment>;
|
|
@@ -29962,10 +29973,10 @@ declare class CommunitiesActorsReactionsResource extends APIResource {
|
|
|
29962
29973
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-workspaces-workspace-id-communities-community-id-actors-actor-id-reactions
|
|
29963
29974
|
* @example
|
|
29964
29975
|
* ```ts
|
|
29965
|
-
* for await (const reaction of social.communities.actors.reactions.list("
|
|
29976
|
+
* for await (const reaction of social.communities.actors.reactions.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f")) {
|
|
29966
29977
|
* console.log(reaction);
|
|
29967
29978
|
* }
|
|
29968
|
-
* const page = await social.communities.actors.reactions.list("
|
|
29979
|
+
* const page = await social.communities.actors.reactions.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {}, { timeout: 5_000 });
|
|
29969
29980
|
* ```
|
|
29970
29981
|
*/
|
|
29971
29982
|
list(communityId: string, actorId: string, params?: CommunityActorReactionListParams, options?: RequestOptions): PagePromise<ActorReactionEntry>;
|
|
@@ -29993,7 +30004,7 @@ declare class CommunitiesModerationActionsResource extends APIResource {
|
|
|
29993
30004
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-workspaces-workspace-id-communities-community-id-moderation-actions
|
|
29994
30005
|
* @example
|
|
29995
30006
|
* ```ts
|
|
29996
|
-
* const moderationAction = await social.communities.moderation.actions.create("
|
|
30007
|
+
* const moderationAction = await social.communities.moderation.actions.create("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {
|
|
29997
30008
|
* action: "remove",
|
|
29998
30009
|
* target_id: "bbbbbbbb-0000-0000-0000-000000000001",
|
|
29999
30010
|
* target_kind: "direct_message",
|
|
@@ -30020,7 +30031,7 @@ declare class CommunitiesModerationActorsResource extends APIResource {
|
|
|
30020
30031
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-workspaces-workspace-id-communities-community-id-moderation-actors-actor-id-shadow-ban
|
|
30021
30032
|
* @example
|
|
30022
30033
|
* ```ts
|
|
30023
|
-
* const moderationActor = await social.communities.moderation.actors.shadowBan("
|
|
30034
|
+
* const moderationActor = await social.communities.moderation.actors.shadowBan("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", { duration_hours: 168 });
|
|
30024
30035
|
* ```
|
|
30025
30036
|
*/
|
|
30026
30037
|
shadowBan(communityId: string, actorId: string, params?: CommunityModerationActorShadowBanParams, options?: RequestOptions): APIPromise<WithLastResponse<ModerationActor>>;
|
|
@@ -30037,7 +30048,7 @@ declare class CommunitiesModerationActorsResource extends APIResource {
|
|
|
30037
30048
|
* @see https://productcraft.co/docs/social/api-reference#delete-v1-workspaces-workspace-id-communities-community-id-moderation-actors-actor-id-shadow-ban
|
|
30038
30049
|
* @example
|
|
30039
30050
|
* ```ts
|
|
30040
|
-
* const moderationActor = await social.communities.moderation.actors.unshadowBan("
|
|
30051
|
+
* const moderationActor = await social.communities.moderation.actors.unshadowBan("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
30041
30052
|
* ```
|
|
30042
30053
|
*/
|
|
30043
30054
|
unshadowBan(communityId: string, actorId: string, options?: RequestOptions): APIPromise<WithLastResponse<ModerationActor>>;
|
|
@@ -30058,10 +30069,10 @@ declare class CommunitiesModerationAuditResource extends APIResource {
|
|
|
30058
30069
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-workspaces-workspace-id-communities-community-id-moderation-audit
|
|
30059
30070
|
* @example
|
|
30060
30071
|
* ```ts
|
|
30061
|
-
* for await (const audit of social.communities.moderation.audit.list("
|
|
30072
|
+
* for await (const audit of social.communities.moderation.audit.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f")) {
|
|
30062
30073
|
* console.log(audit);
|
|
30063
30074
|
* }
|
|
30064
|
-
* const page = await social.communities.moderation.audit.list("
|
|
30075
|
+
* const page = await social.communities.moderation.audit.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {}, { timeout: 5_000 });
|
|
30065
30076
|
* ```
|
|
30066
30077
|
*/
|
|
30067
30078
|
list(communityId: string, params?: CommunityModerationAuditListParams, options?: RequestOptions): PagePromise<ModerationAction>;
|
|
@@ -30082,7 +30093,7 @@ declare class CommunitiesModerationBlockedTermsResource extends APIResource {
|
|
|
30082
30093
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-workspaces-workspace-id-communities-community-id-moderation-blocked-terms
|
|
30083
30094
|
* @example
|
|
30084
30095
|
* ```ts
|
|
30085
|
-
* const blockedTerm = await social.communities.moderation.blockedTerms.create("
|
|
30096
|
+
* const blockedTerm = await social.communities.moderation.blockedTerms.create("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", { term: "spoiler" });
|
|
30086
30097
|
* ```
|
|
30087
30098
|
*/
|
|
30088
30099
|
create(communityId: string, params: CommunityModerationBlockedTermCreateParams, options?: RequestOptions): APIPromise<WithLastResponse<BlockedTerm>>;
|
|
@@ -30098,7 +30109,7 @@ declare class CommunitiesModerationBlockedTermsResource extends APIResource {
|
|
|
30098
30109
|
* @see https://productcraft.co/docs/social/api-reference#delete-v1-workspaces-workspace-id-communities-community-id-moderation-blocked-terms-term
|
|
30099
30110
|
* @example
|
|
30100
30111
|
* ```ts
|
|
30101
|
-
* await social.communities.moderation.blockedTerms.delete("
|
|
30112
|
+
* await social.communities.moderation.blockedTerms.delete("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "spoiler");
|
|
30102
30113
|
* ```
|
|
30103
30114
|
*/
|
|
30104
30115
|
delete(communityId: string, term: string, options?: RequestOptions): APIPromise<void>;
|
|
@@ -30115,10 +30126,10 @@ declare class CommunitiesModerationBlockedTermsResource extends APIResource {
|
|
|
30115
30126
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-workspaces-workspace-id-communities-community-id-moderation-blocked-terms
|
|
30116
30127
|
* @example
|
|
30117
30128
|
* ```ts
|
|
30118
|
-
* for await (const blockedTerm of social.communities.moderation.blockedTerms.list("
|
|
30129
|
+
* for await (const blockedTerm of social.communities.moderation.blockedTerms.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f")) {
|
|
30119
30130
|
* console.log(blockedTerm);
|
|
30120
30131
|
* }
|
|
30121
|
-
* const page = await social.communities.moderation.blockedTerms.list("
|
|
30132
|
+
* const page = await social.communities.moderation.blockedTerms.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {}, { timeout: 5_000 });
|
|
30122
30133
|
* ```
|
|
30123
30134
|
*/
|
|
30124
30135
|
list(communityId: string, params?: CommunityModerationBlockedTermListParams, options?: RequestOptions): PagePromise<BlockedTerm>;
|
|
@@ -30139,10 +30150,10 @@ declare class CommunitiesModerationConversationsMessagesResource extends APIReso
|
|
|
30139
30150
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-workspaces-workspace-id-communities-community-id-moderation-conversations-conversation-id-messages
|
|
30140
30151
|
* @example
|
|
30141
30152
|
* ```ts
|
|
30142
|
-
* for await (const message of social.communities.moderation.conversations.messages.list("
|
|
30153
|
+
* for await (const message of social.communities.moderation.conversations.messages.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f")) {
|
|
30143
30154
|
* console.log(message);
|
|
30144
30155
|
* }
|
|
30145
|
-
* const page = await social.communities.moderation.conversations.messages.list("
|
|
30156
|
+
* const page = await social.communities.moderation.conversations.messages.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {}, { timeout: 5_000 });
|
|
30146
30157
|
* ```
|
|
30147
30158
|
*/
|
|
30148
30159
|
list(communityId: string, conversationId: string, params?: CommunityModerationConversationMessageListParams, options?: RequestOptions): PagePromise<DirectMessageAdmin>;
|
|
@@ -30164,10 +30175,10 @@ declare class CommunitiesModerationConversationsResource extends APIResource {
|
|
|
30164
30175
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-workspaces-workspace-id-communities-community-id-moderation-conversations
|
|
30165
30176
|
* @example
|
|
30166
30177
|
* ```ts
|
|
30167
|
-
* for await (const conversation of social.communities.moderation.conversations.list("
|
|
30178
|
+
* for await (const conversation of social.communities.moderation.conversations.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f")) {
|
|
30168
30179
|
* console.log(conversation);
|
|
30169
30180
|
* }
|
|
30170
|
-
* const page = await social.communities.moderation.conversations.list("
|
|
30181
|
+
* const page = await social.communities.moderation.conversations.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {}, { timeout: 5_000 });
|
|
30171
30182
|
* ```
|
|
30172
30183
|
*/
|
|
30173
30184
|
list(communityId: string, params?: CommunityModerationConversationListParams, options?: RequestOptions): PagePromise<ConversationAdmin>;
|
|
@@ -30188,10 +30199,10 @@ declare class CommunitiesModerationFlagsResource extends APIResource {
|
|
|
30188
30199
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-workspaces-workspace-id-communities-community-id-moderation-flags
|
|
30189
30200
|
* @example
|
|
30190
30201
|
* ```ts
|
|
30191
|
-
* for await (const flag of social.communities.moderation.flags.list("
|
|
30202
|
+
* for await (const flag of social.communities.moderation.flags.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f")) {
|
|
30192
30203
|
* console.log(flag);
|
|
30193
30204
|
* }
|
|
30194
|
-
* const page = await social.communities.moderation.flags.list("
|
|
30205
|
+
* const page = await social.communities.moderation.flags.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {}, { timeout: 5_000 });
|
|
30195
30206
|
* ```
|
|
30196
30207
|
*/
|
|
30197
30208
|
list(communityId: string, params?: CommunityModerationFlagListParams, options?: RequestOptions): PagePromise<Flag>;
|
|
@@ -30211,7 +30222,7 @@ declare class CommunitiesModerationFlagsResource extends APIResource {
|
|
|
30211
30222
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-workspaces-workspace-id-communities-community-id-moderation-flags-flag-id-actions
|
|
30212
30223
|
* @example
|
|
30213
30224
|
* ```ts
|
|
30214
|
-
* const actOnFlag = await social.communities.moderation.flags.resolve("
|
|
30225
|
+
* const actOnFlag = await social.communities.moderation.flags.resolve("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", { action: "hide" });
|
|
30215
30226
|
* ```
|
|
30216
30227
|
*/
|
|
30217
30228
|
resolve(communityId: string, flagId: string, params: CommunityModerationFlagResolveParams, options?: RequestOptions): APIPromise<WithLastResponse<ActOnFlag>>;
|
|
@@ -30232,10 +30243,10 @@ declare class CommunitiesModerationShadowBannedResource extends APIResource {
|
|
|
30232
30243
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-workspaces-workspace-id-communities-community-id-moderation-shadow-banned
|
|
30233
30244
|
* @example
|
|
30234
30245
|
* ```ts
|
|
30235
|
-
* for await (const shadowBanned of social.communities.moderation.shadowBanned.list("
|
|
30246
|
+
* for await (const shadowBanned of social.communities.moderation.shadowBanned.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f")) {
|
|
30236
30247
|
* console.log(shadowBanned);
|
|
30237
30248
|
* }
|
|
30238
|
-
* const page = await social.communities.moderation.shadowBanned.list("
|
|
30249
|
+
* const page = await social.communities.moderation.shadowBanned.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {}, { timeout: 5_000 });
|
|
30239
30250
|
* ```
|
|
30240
30251
|
*/
|
|
30241
30252
|
list(communityId: string, params?: CommunityModerationShadowBannedListParams, options?: RequestOptions): PagePromise<ModerationActor>;
|
|
@@ -30272,7 +30283,7 @@ declare class CommunitiesWebhooksEndpointsResource extends APIResource {
|
|
|
30272
30283
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-workspaces-workspace-id-communities-community-id-webhooks-endpoints
|
|
30273
30284
|
* @example
|
|
30274
30285
|
* ```ts
|
|
30275
|
-
* const webhookEndpointWithSecret = await social.communities.webhooks.endpoints.create("
|
|
30286
|
+
* const webhookEndpointWithSecret = await social.communities.webhooks.endpoints.create("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", { url: "https://api.acme.com/webhooks" });
|
|
30276
30287
|
* ```
|
|
30277
30288
|
*/
|
|
30278
30289
|
create(communityId: string, params: CommunityWebhookEndpointCreateParams, options?: RequestOptions): APIPromise<WithLastResponse<WebhookEndpointWithSecret>>;
|
|
@@ -30293,7 +30304,7 @@ declare class CommunitiesWebhooksEndpointsResource extends APIResource {
|
|
|
30293
30304
|
* @see https://productcraft.co/docs/social/api-reference#delete-v1-workspaces-workspace-id-communities-community-id-webhooks-endpoints-endpoint-id
|
|
30294
30305
|
* @example
|
|
30295
30306
|
* ```ts
|
|
30296
|
-
* await social.communities.webhooks.endpoints.delete("
|
|
30307
|
+
* await social.communities.webhooks.endpoints.delete("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
30297
30308
|
* ```
|
|
30298
30309
|
*/
|
|
30299
30310
|
delete(communityId: string, endpointId: string, options?: RequestOptions): APIPromise<void>;
|
|
@@ -30313,7 +30324,7 @@ declare class CommunitiesWebhooksEndpointsResource extends APIResource {
|
|
|
30313
30324
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-workspaces-workspace-id-communities-community-id-webhooks-endpoints
|
|
30314
30325
|
* @example
|
|
30315
30326
|
* ```ts
|
|
30316
|
-
* for await (const endpoint of social.communities.webhooks.endpoints.list("
|
|
30327
|
+
* for await (const endpoint of social.communities.webhooks.endpoints.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f")) {
|
|
30317
30328
|
* console.log(endpoint);
|
|
30318
30329
|
* }
|
|
30319
30330
|
* ```
|
|
@@ -30336,7 +30347,7 @@ declare class CommunitiesWebhooksEndpointsResource extends APIResource {
|
|
|
30336
30347
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-workspaces-workspace-id-communities-community-id-webhooks-endpoints-endpoint-id
|
|
30337
30348
|
* @example
|
|
30338
30349
|
* ```ts
|
|
30339
|
-
* const webhookEndpoint = await social.communities.webhooks.endpoints.retrieve("
|
|
30350
|
+
* const webhookEndpoint = await social.communities.webhooks.endpoints.retrieve("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
30340
30351
|
* ```
|
|
30341
30352
|
*/
|
|
30342
30353
|
retrieve(communityId: string, endpointId: string, options?: RequestOptions): APIPromise<WithLastResponse<WebhookEndpoint>>;
|
|
@@ -30359,7 +30370,7 @@ declare class CommunitiesWebhooksEndpointsResource extends APIResource {
|
|
|
30359
30370
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-workspaces-workspace-id-communities-community-id-webhooks-endpoints-endpoint-id-rotate-secret
|
|
30360
30371
|
* @example
|
|
30361
30372
|
* ```ts
|
|
30362
|
-
* const webhookEndpointWithSecret = await social.communities.webhooks.endpoints.rotateSecret("
|
|
30373
|
+
* const webhookEndpointWithSecret = await social.communities.webhooks.endpoints.rotateSecret("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", { grace_hours: 24 });
|
|
30363
30374
|
* ```
|
|
30364
30375
|
*/
|
|
30365
30376
|
rotateSecret(communityId: string, endpointId: string, params?: CommunityWebhookEndpointRotateSecretParams, options?: RequestOptions): APIPromise<WithLastResponse<WebhookEndpointWithSecret>>;
|
|
@@ -30382,7 +30393,7 @@ declare class CommunitiesWebhooksEndpointsResource extends APIResource {
|
|
|
30382
30393
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-workspaces-workspace-id-communities-community-id-webhooks-endpoints-endpoint-id-test
|
|
30383
30394
|
* @example
|
|
30384
30395
|
* ```ts
|
|
30385
|
-
* const webhookDeliveryAttempt = await social.communities.webhooks.endpoints.test("
|
|
30396
|
+
* const webhookDeliveryAttempt = await social.communities.webhooks.endpoints.test("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", { event_type: "post.created" });
|
|
30386
30397
|
* ```
|
|
30387
30398
|
*/
|
|
30388
30399
|
test(communityId: string, endpointId: string, params: CommunityWebhookEndpointTestParams, options?: RequestOptions): APIPromise<WithLastResponse<WebhookDeliveryAttempt>>;
|
|
@@ -30406,7 +30417,7 @@ declare class CommunitiesWebhooksEndpointsResource extends APIResource {
|
|
|
30406
30417
|
* @see https://productcraft.co/docs/social/api-reference#patch-v1-workspaces-workspace-id-communities-community-id-webhooks-endpoints-endpoint-id
|
|
30407
30418
|
* @example
|
|
30408
30419
|
* ```ts
|
|
30409
|
-
* const webhookEndpoint = await social.communities.webhooks.endpoints.update("
|
|
30420
|
+
* const webhookEndpoint = await social.communities.webhooks.endpoints.update("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", { description: "Production receiver" });
|
|
30410
30421
|
* ```
|
|
30411
30422
|
*/
|
|
30412
30423
|
update(communityId: string, endpointId: string, params?: CommunityWebhookEndpointUpdateParams, options?: RequestOptions): APIPromise<WithLastResponse<WebhookEndpoint>>;
|
|
@@ -30428,7 +30439,7 @@ declare class CommunitiesWebhooksEventTypesResource extends APIResource {
|
|
|
30428
30439
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-workspaces-workspace-id-communities-community-id-webhooks-event-types
|
|
30429
30440
|
* @example
|
|
30430
30441
|
* ```ts
|
|
30431
|
-
* const listWebhookEventTypes = await social.communities.webhooks.eventTypes.list("
|
|
30442
|
+
* const listWebhookEventTypes = await social.communities.webhooks.eventTypes.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
30432
30443
|
* ```
|
|
30433
30444
|
*/
|
|
30434
30445
|
list(communityId: string, options?: RequestOptions): APIPromise<WithLastResponse<ListWebhookEventTypes>>;
|
|
@@ -30452,10 +30463,10 @@ declare class CommunitiesWebhooksEventsResource extends APIResource {
|
|
|
30452
30463
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-workspaces-workspace-id-communities-community-id-webhooks-events
|
|
30453
30464
|
* @example
|
|
30454
30465
|
* ```ts
|
|
30455
|
-
* for await (const event of social.communities.webhooks.events.list("
|
|
30466
|
+
* for await (const event of social.communities.webhooks.events.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f")) {
|
|
30456
30467
|
* console.log(event);
|
|
30457
30468
|
* }
|
|
30458
|
-
* const page = await social.communities.webhooks.events.list("
|
|
30469
|
+
* const page = await social.communities.webhooks.events.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {}, { timeout: 5_000 });
|
|
30459
30470
|
* ```
|
|
30460
30471
|
*/
|
|
30461
30472
|
list(communityId: string, params?: CommunityWebhookEventListParams, options?: RequestOptions): PagePromise<WebhookEvent>;
|
|
@@ -30478,7 +30489,7 @@ declare class CommunitiesWebhooksEventsResource extends APIResource {
|
|
|
30478
30489
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-workspaces-workspace-id-communities-community-id-webhooks-events-event-id-replay
|
|
30479
30490
|
* @example
|
|
30480
30491
|
* ```ts
|
|
30481
|
-
* const replayWebhookEvent = await social.communities.webhooks.events.replay("
|
|
30492
|
+
* const replayWebhookEvent = await social.communities.webhooks.events.replay("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "evt_3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
30482
30493
|
* ```
|
|
30483
30494
|
*/
|
|
30484
30495
|
replay(communityId: string, eventId: string, params?: CommunityWebhookEventReplayParams, options?: RequestOptions): APIPromise<WithLastResponse<ReplayWebhookEvent>>;
|
|
@@ -30499,7 +30510,7 @@ declare class CommunitiesWebhooksEventsResource extends APIResource {
|
|
|
30499
30510
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-workspaces-workspace-id-communities-community-id-webhooks-events-event-id
|
|
30500
30511
|
* @example
|
|
30501
30512
|
* ```ts
|
|
30502
|
-
* const webhookEventDetail = await social.communities.webhooks.events.retrieve("
|
|
30513
|
+
* const webhookEventDetail = await social.communities.webhooks.events.retrieve("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "evt_3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
30503
30514
|
* ```
|
|
30504
30515
|
*/
|
|
30505
30516
|
retrieve(communityId: string, eventId: string, options?: RequestOptions): APIPromise<WithLastResponse<WebhookEventDetail>>;
|
|
@@ -30529,7 +30540,7 @@ declare class CommunitiesResource extends APIResource {
|
|
|
30529
30540
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-workspaces-workspace-id-communities-community-id-analytics
|
|
30530
30541
|
* @example
|
|
30531
30542
|
* ```ts
|
|
30532
|
-
* const communityAnalytics = await social.communities.analytics("
|
|
30543
|
+
* const communityAnalytics = await social.communities.analytics("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
30533
30544
|
* ```
|
|
30534
30545
|
*/
|
|
30535
30546
|
analytics(communityId: string, options?: RequestOptions): APIPromise<WithLastResponse<CommunityAnalytics>>;
|
|
@@ -30564,7 +30575,7 @@ declare class CommunitiesResource extends APIResource {
|
|
|
30564
30575
|
* @see https://productcraft.co/docs/social/api-reference#delete-v1-workspaces-workspace-id-communities-community-id
|
|
30565
30576
|
* @example
|
|
30566
30577
|
* ```ts
|
|
30567
|
-
* await social.communities.delete("
|
|
30578
|
+
* await social.communities.delete("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
30568
30579
|
* ```
|
|
30569
30580
|
*/
|
|
30570
30581
|
delete(communityId: string, options?: RequestOptions): APIPromise<void>;
|
|
@@ -30599,7 +30610,7 @@ declare class CommunitiesResource extends APIResource {
|
|
|
30599
30610
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-workspaces-workspace-id-communities-community-id
|
|
30600
30611
|
* @example
|
|
30601
30612
|
* ```ts
|
|
30602
|
-
* const community = await social.communities.retrieve("
|
|
30613
|
+
* const community = await social.communities.retrieve("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
30603
30614
|
* ```
|
|
30604
30615
|
*/
|
|
30605
30616
|
retrieve(communityId: string, options?: RequestOptions): APIPromise<WithLastResponse<Community>>;
|
|
@@ -30617,7 +30628,7 @@ declare class CommunitiesResource extends APIResource {
|
|
|
30617
30628
|
* @see https://productcraft.co/docs/social/api-reference#patch-v1-workspaces-workspace-id-communities-community-id
|
|
30618
30629
|
* @example
|
|
30619
30630
|
* ```ts
|
|
30620
|
-
* const community = await social.communities.update("
|
|
30631
|
+
* const community = await social.communities.update("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", { description: "string" });
|
|
30621
30632
|
* ```
|
|
30622
30633
|
*/
|
|
30623
30634
|
update(communityId: string, params?: CommunityUpdateParams, options?: RequestOptions): APIPromise<WithLastResponse<Community>>;
|
|
@@ -30688,7 +30699,7 @@ declare class WebhooksEndpointsResource extends APIResource {
|
|
|
30688
30699
|
* @see https://productcraft.co/docs/social/api-reference#delete-v1-workspaces-workspace-id-webhooks-endpoints-endpoint-id
|
|
30689
30700
|
* @example
|
|
30690
30701
|
* ```ts
|
|
30691
|
-
* await social.webhooks.endpoints.delete("
|
|
30702
|
+
* await social.webhooks.endpoints.delete("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
30692
30703
|
* ```
|
|
30693
30704
|
*/
|
|
30694
30705
|
delete(endpointId: string, options?: RequestOptions): APIPromise<void>;
|
|
@@ -30729,7 +30740,7 @@ declare class WebhooksEndpointsResource extends APIResource {
|
|
|
30729
30740
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-workspaces-workspace-id-webhooks-endpoints-endpoint-id
|
|
30730
30741
|
* @example
|
|
30731
30742
|
* ```ts
|
|
30732
|
-
* const webhookEndpoint = await social.webhooks.endpoints.retrieve("
|
|
30743
|
+
* const webhookEndpoint = await social.webhooks.endpoints.retrieve("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
30733
30744
|
* ```
|
|
30734
30745
|
*/
|
|
30735
30746
|
retrieve(endpointId: string, options?: RequestOptions): APIPromise<WithLastResponse<WebhookEndpoint>>;
|
|
@@ -30751,7 +30762,7 @@ declare class WebhooksEndpointsResource extends APIResource {
|
|
|
30751
30762
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-workspaces-workspace-id-webhooks-endpoints-endpoint-id-rotate-secret
|
|
30752
30763
|
* @example
|
|
30753
30764
|
* ```ts
|
|
30754
|
-
* const webhookEndpointWithSecret = await social.webhooks.endpoints.rotateSecret("
|
|
30765
|
+
* const webhookEndpointWithSecret = await social.webhooks.endpoints.rotateSecret("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", { grace_hours: 24 });
|
|
30755
30766
|
* ```
|
|
30756
30767
|
*/
|
|
30757
30768
|
rotateSecret(endpointId: string, params?: WebhookEndpointRotateSecretParams, options?: RequestOptions): APIPromise<WithLastResponse<WebhookEndpointWithSecret>>;
|
|
@@ -30773,7 +30784,7 @@ declare class WebhooksEndpointsResource extends APIResource {
|
|
|
30773
30784
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-workspaces-workspace-id-webhooks-endpoints-endpoint-id-test
|
|
30774
30785
|
* @example
|
|
30775
30786
|
* ```ts
|
|
30776
|
-
* const webhookDeliveryAttempt = await social.webhooks.endpoints.test("
|
|
30787
|
+
* const webhookDeliveryAttempt = await social.webhooks.endpoints.test("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", { event_type: "post.created" });
|
|
30777
30788
|
* ```
|
|
30778
30789
|
*/
|
|
30779
30790
|
test(endpointId: string, params: WebhookEndpointTestParams, options?: RequestOptions): APIPromise<WithLastResponse<WebhookDeliveryAttempt>>;
|
|
@@ -30796,7 +30807,7 @@ declare class WebhooksEndpointsResource extends APIResource {
|
|
|
30796
30807
|
* @see https://productcraft.co/docs/social/api-reference#patch-v1-workspaces-workspace-id-webhooks-endpoints-endpoint-id
|
|
30797
30808
|
* @example
|
|
30798
30809
|
* ```ts
|
|
30799
|
-
* const webhookEndpoint = await social.webhooks.endpoints.update("
|
|
30810
|
+
* const webhookEndpoint = await social.webhooks.endpoints.update("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", { description: "Production receiver" });
|
|
30800
30811
|
* ```
|
|
30801
30812
|
*/
|
|
30802
30813
|
update(endpointId: string, params?: WebhookEndpointUpdateParams, options?: RequestOptions): APIPromise<WithLastResponse<WebhookEndpoint>>;
|
|
@@ -30865,7 +30876,7 @@ declare class WebhooksEventsResource extends APIResource {
|
|
|
30865
30876
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-workspaces-workspace-id-webhooks-events-event-id-replay
|
|
30866
30877
|
* @example
|
|
30867
30878
|
* ```ts
|
|
30868
|
-
* const replayWebhookEvent = await social.webhooks.events.replay("
|
|
30879
|
+
* const replayWebhookEvent = await social.webhooks.events.replay("evt_3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
30869
30880
|
* ```
|
|
30870
30881
|
*/
|
|
30871
30882
|
replay(eventId: string, params?: WebhookEventReplayParams, options?: RequestOptions): APIPromise<WithLastResponse<ReplayWebhookEvent>>;
|
|
@@ -30885,7 +30896,7 @@ declare class WebhooksEventsResource extends APIResource {
|
|
|
30885
30896
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-workspaces-workspace-id-webhooks-events-event-id
|
|
30886
30897
|
* @example
|
|
30887
30898
|
* ```ts
|
|
30888
|
-
* const webhookEventDetail = await social.webhooks.events.retrieve("
|
|
30899
|
+
* const webhookEventDetail = await social.webhooks.events.retrieve("evt_3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
30889
30900
|
* ```
|
|
30890
30901
|
*/
|
|
30891
30902
|
retrieve(eventId: string, options?: RequestOptions): APIPromise<WithLastResponse<WebhookEventDetail>>;
|
|
@@ -30904,6 +30915,14 @@ declare class WebhooksResource extends APIResource {
|
|
|
30904
30915
|
* @throws {ConfigurationError} No secret was passed or configured.
|
|
30905
30916
|
*/
|
|
30906
30917
|
unwrap(params: WebhookUnwrapParams): Promise<UnwrapWebhookEvent>;
|
|
30918
|
+
/**
|
|
30919
|
+
* Sign a test event the way ProductCraft signs deliveries (Standard Webhooks), so a handler
|
|
30920
|
+
* test can call `unwrap` without a live delivery. Returns the exact body and the headers.
|
|
30921
|
+
*
|
|
30922
|
+
* @param params - The event (an object is JSON-encoded), and optionally the secret, `id` and `timestamp`.
|
|
30923
|
+
* @throws {ConfigurationError} No secret was passed or configured.
|
|
30924
|
+
*/
|
|
30925
|
+
sign(params: WebhookSignParams): Promise<SignedWebhook>;
|
|
30907
30926
|
}
|
|
30908
30927
|
/** `social` */
|
|
30909
30928
|
declare class SocialResources extends APIResource {
|
|
@@ -30929,10 +30948,10 @@ declare class CommunityActorsArchivedResource extends APIResource {
|
|
|
30929
30948
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-actors-actor-id-archived
|
|
30930
30949
|
* @example
|
|
30931
30950
|
* ```ts
|
|
30932
|
-
* for await (const archived of social.community("
|
|
30951
|
+
* for await (const archived of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.archived.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f")) {
|
|
30933
30952
|
* console.log(archived);
|
|
30934
30953
|
* }
|
|
30935
|
-
* const page = await social.community("
|
|
30954
|
+
* const page = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.archived.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {}, { timeout: 5_000 });
|
|
30936
30955
|
* ```
|
|
30937
30956
|
*/
|
|
30938
30957
|
list(actorId: string, params?: ActorArchivedListParams, options?: RequestOptions): PagePromise<Post>;
|
|
@@ -30951,10 +30970,10 @@ declare class CommunityActorsAssetsResource extends APIResource {
|
|
|
30951
30970
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-actors-actor-id-assets
|
|
30952
30971
|
* @example
|
|
30953
30972
|
* ```ts
|
|
30954
|
-
* for await (const asset of social.community("
|
|
30973
|
+
* for await (const asset of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.assets.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f")) {
|
|
30955
30974
|
* console.log(asset);
|
|
30956
30975
|
* }
|
|
30957
|
-
* const page = await social.community("
|
|
30976
|
+
* const page = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.assets.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {}, { timeout: 5_000 });
|
|
30958
30977
|
* ```
|
|
30959
30978
|
*/
|
|
30960
30979
|
list(actorId: string, params?: ActorAssetListParams, options?: RequestOptions): PagePromise<Asset>;
|
|
@@ -30975,10 +30994,10 @@ declare class CommunityActorsBlocksResource extends APIResource {
|
|
|
30975
30994
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-actors-actor-id-blocks
|
|
30976
30995
|
* @example
|
|
30977
30996
|
* ```ts
|
|
30978
|
-
* for await (const block of social.community("
|
|
30997
|
+
* for await (const block of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.blocks.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f")) {
|
|
30979
30998
|
* console.log(block);
|
|
30980
30999
|
* }
|
|
30981
|
-
* const page = await social.community("
|
|
31000
|
+
* const page = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.blocks.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {}, { timeout: 5_000 });
|
|
30982
31001
|
* ```
|
|
30983
31002
|
*/
|
|
30984
31003
|
list(actorId: string, params?: ActorBlockListParams, options?: RequestOptions): PagePromise<OutboundEdge>;
|
|
@@ -31000,10 +31019,10 @@ declare class CommunityActorsBookmarksResource extends APIResource {
|
|
|
31000
31019
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-actors-actor-id-bookmarks
|
|
31001
31020
|
* @example
|
|
31002
31021
|
* ```ts
|
|
31003
|
-
* for await (const bookmark of social.community("
|
|
31022
|
+
* for await (const bookmark of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.bookmarks.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f")) {
|
|
31004
31023
|
* console.log(bookmark);
|
|
31005
31024
|
* }
|
|
31006
|
-
* const page = await social.community("
|
|
31025
|
+
* const page = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.bookmarks.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {}, { timeout: 5_000 });
|
|
31007
31026
|
* ```
|
|
31008
31027
|
*/
|
|
31009
31028
|
list(actorId: string, params?: ActorBookmarkListParams, options?: RequestOptions): PagePromise<Bookmark>;
|
|
@@ -31023,7 +31042,7 @@ declare class CommunityActorsByExternalResource extends APIResource {
|
|
|
31023
31042
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-actors-by-external-batch
|
|
31024
31043
|
* @example
|
|
31025
31044
|
* ```ts
|
|
31026
|
-
* const actorsByExternalBatch = await social.community("
|
|
31045
|
+
* const actorsByExternalBatch = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.byExternal.batch({ external_ids: ["user_abc123", "user_def456"] });
|
|
31027
31046
|
* ```
|
|
31028
31047
|
*/
|
|
31029
31048
|
batch(params: ActorByExternalBatchParams, options?: RequestOptions): APIPromise<WithLastResponse<ActorsByExternalBatch>>;
|
|
@@ -31039,7 +31058,7 @@ declare class CommunityActorsByExternalResource extends APIResource {
|
|
|
31039
31058
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-actors-by-external-external-id
|
|
31040
31059
|
* @example
|
|
31041
31060
|
* ```ts
|
|
31042
|
-
* const actor = await social.community("
|
|
31061
|
+
* const actor = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.byExternal.retrieve("user_42");
|
|
31043
31062
|
* ```
|
|
31044
31063
|
*/
|
|
31045
31064
|
retrieve(externalId: string, options?: RequestOptions): APIPromise<WithLastResponse<Actor>>;
|
|
@@ -31062,10 +31081,10 @@ declare class CommunityActorsCloseFriendsResource extends APIResource {
|
|
|
31062
31081
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-actors-actor-id-close-friends
|
|
31063
31082
|
* @example
|
|
31064
31083
|
* ```ts
|
|
31065
|
-
* for await (const closeFriend of social.community("
|
|
31084
|
+
* for await (const closeFriend of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.closeFriends.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f")) {
|
|
31066
31085
|
* console.log(closeFriend);
|
|
31067
31086
|
* }
|
|
31068
|
-
* const page = await social.community("
|
|
31087
|
+
* const page = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.closeFriends.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {}, { timeout: 5_000 });
|
|
31069
31088
|
* ```
|
|
31070
31089
|
*/
|
|
31071
31090
|
list(actorId: string, params?: ActorCloseFriendListParams, options?: RequestOptions): PagePromise<CloseFriendResponse>;
|
|
@@ -31083,10 +31102,10 @@ declare class CommunityActorsDismissedSuggestionsResource extends APIResource {
|
|
|
31083
31102
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-actors-actor-id-dismissed-suggestions
|
|
31084
31103
|
* @example
|
|
31085
31104
|
* ```ts
|
|
31086
|
-
* for await (const dismissedSuggestion of social.community("
|
|
31105
|
+
* for await (const dismissedSuggestion of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.dismissedSuggestions.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f")) {
|
|
31087
31106
|
* console.log(dismissedSuggestion);
|
|
31088
31107
|
* }
|
|
31089
|
-
* const page = await social.community("
|
|
31108
|
+
* const page = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.dismissedSuggestions.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {}, { timeout: 5_000 });
|
|
31090
31109
|
* ```
|
|
31091
31110
|
*/
|
|
31092
31111
|
list(actorId: string, params?: ActorDismissedSuggestionListParams, options?: RequestOptions): PagePromise<OutboundEdge>;
|
|
@@ -31108,10 +31127,10 @@ declare class CommunityActorsDraftsResource extends APIResource {
|
|
|
31108
31127
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-actors-actor-id-drafts
|
|
31109
31128
|
* @example
|
|
31110
31129
|
* ```ts
|
|
31111
|
-
* for await (const draft of social.community("
|
|
31130
|
+
* for await (const draft of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.drafts.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f")) {
|
|
31112
31131
|
* console.log(draft);
|
|
31113
31132
|
* }
|
|
31114
|
-
* const page = await social.community("
|
|
31133
|
+
* const page = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.drafts.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {}, { timeout: 5_000 });
|
|
31115
31134
|
* ```
|
|
31116
31135
|
*/
|
|
31117
31136
|
list(actorId: string, params?: ActorDraftListParams, options?: RequestOptions): PagePromise<Post>;
|
|
@@ -31132,10 +31151,10 @@ declare class CommunityActorsFeedResource extends APIResource {
|
|
|
31132
31151
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-actors-actor-id-feed
|
|
31133
31152
|
* @example
|
|
31134
31153
|
* ```ts
|
|
31135
|
-
* for await (const feed of social.community("
|
|
31154
|
+
* for await (const feed of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.feed.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f")) {
|
|
31136
31155
|
* console.log(feed);
|
|
31137
31156
|
* }
|
|
31138
|
-
* const page = await social.community("
|
|
31157
|
+
* const page = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.feed.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {}, { timeout: 5_000 });
|
|
31139
31158
|
* ```
|
|
31140
31159
|
*/
|
|
31141
31160
|
list(actorId: string, params?: ActorFeedListParams, options?: RequestOptions): PagePromise<Post>;
|
|
@@ -31154,10 +31173,10 @@ declare class CommunityActorsFollowRequestsResource extends APIResource {
|
|
|
31154
31173
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-actors-actor-id-follow-requests
|
|
31155
31174
|
* @example
|
|
31156
31175
|
* ```ts
|
|
31157
|
-
* for await (const followRequest of social.community("
|
|
31176
|
+
* for await (const followRequest of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.followRequests.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f")) {
|
|
31158
31177
|
* console.log(followRequest);
|
|
31159
31178
|
* }
|
|
31160
|
-
* const page = await social.community("
|
|
31179
|
+
* const page = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.followRequests.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {}, { timeout: 5_000 });
|
|
31161
31180
|
* ```
|
|
31162
31181
|
*/
|
|
31163
31182
|
list(actorId: string, params?: ActorFollowRequestListParams, options?: RequestOptions): PagePromise<FollowRequestEntry>;
|
|
@@ -31178,10 +31197,10 @@ declare class CommunityActorsFollowersResource extends APIResource {
|
|
|
31178
31197
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-actors-actor-id-followers
|
|
31179
31198
|
* @example
|
|
31180
31199
|
* ```ts
|
|
31181
|
-
* for await (const follower of social.community("
|
|
31200
|
+
* for await (const follower of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.followers.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f")) {
|
|
31182
31201
|
* console.log(follower);
|
|
31183
31202
|
* }
|
|
31184
|
-
* const page = await social.community("
|
|
31203
|
+
* const page = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.followers.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {}, { timeout: 5_000 });
|
|
31185
31204
|
* ```
|
|
31186
31205
|
*/
|
|
31187
31206
|
list(actorId: string, params?: ActorFollowerListParams, options?: RequestOptions): PagePromise<FollowerEdge>;
|
|
@@ -31202,10 +31221,10 @@ declare class CommunityActorsFollowingResource extends APIResource {
|
|
|
31202
31221
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-actors-actor-id-following
|
|
31203
31222
|
* @example
|
|
31204
31223
|
* ```ts
|
|
31205
|
-
* for await (const following of social.community("
|
|
31224
|
+
* for await (const following of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.following.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f")) {
|
|
31206
31225
|
* console.log(following);
|
|
31207
31226
|
* }
|
|
31208
|
-
* const page = await social.community("
|
|
31227
|
+
* const page = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.following.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {}, { timeout: 5_000 });
|
|
31209
31228
|
* ```
|
|
31210
31229
|
*/
|
|
31211
31230
|
list(actorId: string, params?: ActorFollowingListParams, options?: RequestOptions): PagePromise<OutboundEdge>;
|
|
@@ -31227,7 +31246,7 @@ declare class CommunityActorsHashtagFollowsResource extends APIResource {
|
|
|
31227
31246
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-actors-actor-id-hashtag-follows
|
|
31228
31247
|
* @example
|
|
31229
31248
|
* ```ts
|
|
31230
|
-
* const hashtagFollow = await social.community("
|
|
31249
|
+
* const hashtagFollow = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.hashtagFollows.create("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", { tag: "storymode" });
|
|
31231
31250
|
* ```
|
|
31232
31251
|
*/
|
|
31233
31252
|
create(actorId: string, params: ActorHashtagFollowCreateParams, options?: RequestOptions): APIPromise<WithLastResponse<HashtagFollow>>;
|
|
@@ -31245,7 +31264,7 @@ declare class CommunityActorsHashtagFollowsResource extends APIResource {
|
|
|
31245
31264
|
* @see https://productcraft.co/docs/social/api-reference#delete-v1-communities-community-id-actors-actor-id-hashtag-follows-tag
|
|
31246
31265
|
* @example
|
|
31247
31266
|
* ```ts
|
|
31248
|
-
* await social.community("
|
|
31267
|
+
* await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.hashtagFollows.delete("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "launch");
|
|
31249
31268
|
* ```
|
|
31250
31269
|
*/
|
|
31251
31270
|
delete(actorId: string, tag: string, options?: RequestOptions): APIPromise<void>;
|
|
@@ -31262,10 +31281,10 @@ declare class CommunityActorsHashtagFollowsResource extends APIResource {
|
|
|
31262
31281
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-actors-actor-id-hashtag-follows
|
|
31263
31282
|
* @example
|
|
31264
31283
|
* ```ts
|
|
31265
|
-
* for await (const hashtagFollow of social.community("
|
|
31284
|
+
* for await (const hashtagFollow of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.hashtagFollows.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f")) {
|
|
31266
31285
|
* console.log(hashtagFollow);
|
|
31267
31286
|
* }
|
|
31268
|
-
* const page = await social.community("
|
|
31287
|
+
* const page = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.hashtagFollows.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {}, { timeout: 5_000 });
|
|
31269
31288
|
* ```
|
|
31270
31289
|
*/
|
|
31271
31290
|
list(actorId: string, params?: ActorHashtagFollowListParams, options?: RequestOptions): PagePromise<HashtagFollow>;
|
|
@@ -31283,10 +31302,10 @@ declare class CommunityActorsHidesResource extends APIResource {
|
|
|
31283
31302
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-actors-actor-id-hides
|
|
31284
31303
|
* @example
|
|
31285
31304
|
* ```ts
|
|
31286
|
-
* for await (const hide of social.community("
|
|
31305
|
+
* for await (const hide of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.hides.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f")) {
|
|
31287
31306
|
* console.log(hide);
|
|
31288
31307
|
* }
|
|
31289
|
-
* const page = await social.community("
|
|
31308
|
+
* const page = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.hides.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {}, { timeout: 5_000 });
|
|
31290
31309
|
* ```
|
|
31291
31310
|
*/
|
|
31292
31311
|
list(actorId: string, params?: ActorHideListParams, options?: RequestOptions): PagePromise<HideEntry>;
|
|
@@ -31308,10 +31327,10 @@ declare class CommunityActorsHighlightsResource extends APIResource {
|
|
|
31308
31327
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-actors-owner-actor-id-highlights
|
|
31309
31328
|
* @example
|
|
31310
31329
|
* ```ts
|
|
31311
|
-
* for await (const highlight of social.community("
|
|
31330
|
+
* for await (const highlight of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.highlights.list("aaaaaaaa-0000-0000-0000-000000000001")) {
|
|
31312
31331
|
* console.log(highlight);
|
|
31313
31332
|
* }
|
|
31314
|
-
* const page = await social.community("
|
|
31333
|
+
* const page = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.highlights.list("aaaaaaaa-0000-0000-0000-000000000001", {}, { timeout: 5_000 });
|
|
31315
31334
|
* ```
|
|
31316
31335
|
*/
|
|
31317
31336
|
list(ownerActorId: string, params?: WithOptionalActor<ActorHighlightListParams>, options?: RequestOptions): PagePromise<Post>;
|
|
@@ -31333,10 +31352,10 @@ declare class CommunityActorsMentionsResource extends APIResource {
|
|
|
31333
31352
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-actors-actor-id-mentions
|
|
31334
31353
|
* @example
|
|
31335
31354
|
* ```ts
|
|
31336
|
-
* for await (const mention of social.community("
|
|
31355
|
+
* for await (const mention of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.mentions.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f")) {
|
|
31337
31356
|
* console.log(mention);
|
|
31338
31357
|
* }
|
|
31339
|
-
* const page = await social.community("
|
|
31358
|
+
* const page = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.mentions.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {}, { timeout: 5_000 });
|
|
31340
31359
|
* ```
|
|
31341
31360
|
*/
|
|
31342
31361
|
list(actorId: string, params?: ActorMentionListParams, options?: RequestOptions): PagePromise<MentionEntry>;
|
|
@@ -31358,7 +31377,7 @@ declare class CommunityActorsMutedTermsResource extends APIResource {
|
|
|
31358
31377
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-actors-actor-id-muted-terms
|
|
31359
31378
|
* @example
|
|
31360
31379
|
* ```ts
|
|
31361
|
-
* const mutedTerm = await social.community("
|
|
31380
|
+
* const mutedTerm = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.mutedTerms.create("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", { term: "spoiler" });
|
|
31362
31381
|
* ```
|
|
31363
31382
|
*/
|
|
31364
31383
|
create(actorId: string, params: ActorMutedTermCreateParams, options?: RequestOptions): APIPromise<WithLastResponse<MutedTerm>>;
|
|
@@ -31375,7 +31394,7 @@ declare class CommunityActorsMutedTermsResource extends APIResource {
|
|
|
31375
31394
|
* @see https://productcraft.co/docs/social/api-reference#delete-v1-communities-community-id-actors-actor-id-muted-terms-term
|
|
31376
31395
|
* @example
|
|
31377
31396
|
* ```ts
|
|
31378
|
-
* await social.community("
|
|
31397
|
+
* await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.mutedTerms.delete("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "spoiler");
|
|
31379
31398
|
* ```
|
|
31380
31399
|
*/
|
|
31381
31400
|
delete(actorId: string, term: string, options?: RequestOptions): APIPromise<void>;
|
|
@@ -31392,10 +31411,10 @@ declare class CommunityActorsMutedTermsResource extends APIResource {
|
|
|
31392
31411
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-actors-actor-id-muted-terms
|
|
31393
31412
|
* @example
|
|
31394
31413
|
* ```ts
|
|
31395
|
-
* for await (const mutedTerm of social.community("
|
|
31414
|
+
* for await (const mutedTerm of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.mutedTerms.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f")) {
|
|
31396
31415
|
* console.log(mutedTerm);
|
|
31397
31416
|
* }
|
|
31398
|
-
* const page = await social.community("
|
|
31417
|
+
* const page = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.mutedTerms.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {}, { timeout: 5_000 });
|
|
31399
31418
|
* ```
|
|
31400
31419
|
*/
|
|
31401
31420
|
list(actorId: string, params?: ActorMutedTermListParams, options?: RequestOptions): PagePromise<MutedTerm>;
|
|
@@ -31416,10 +31435,10 @@ declare class CommunityActorsMutesResource extends APIResource {
|
|
|
31416
31435
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-actors-actor-id-mutes
|
|
31417
31436
|
* @example
|
|
31418
31437
|
* ```ts
|
|
31419
|
-
* for await (const mute of social.community("
|
|
31438
|
+
* for await (const mute of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.mutes.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f")) {
|
|
31420
31439
|
* console.log(mute);
|
|
31421
31440
|
* }
|
|
31422
|
-
* const page = await social.community("
|
|
31441
|
+
* const page = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.mutes.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {}, { timeout: 5_000 });
|
|
31423
31442
|
* ```
|
|
31424
31443
|
*/
|
|
31425
31444
|
list(actorId: string, params?: ActorMuteListParams, options?: RequestOptions): PagePromise<OutboundEdge>;
|
|
@@ -31440,7 +31459,7 @@ declare class CommunityActorsNotificationPrefsResource extends APIResource {
|
|
|
31440
31459
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-actors-actor-id-notification-prefs
|
|
31441
31460
|
* @example
|
|
31442
31461
|
* ```ts
|
|
31443
|
-
* const notificationPrefList = await social.community("
|
|
31462
|
+
* const notificationPrefList = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.notificationPrefs.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
31444
31463
|
* ```
|
|
31445
31464
|
*/
|
|
31446
31465
|
list(actorId: string, options?: RequestOptions): APIPromise<WithLastResponse<NotificationPrefList>>;
|
|
@@ -31461,7 +31480,7 @@ declare class CommunityActorsNotificationPrefsResource extends APIResource {
|
|
|
31461
31480
|
* @see https://productcraft.co/docs/social/api-reference#patch-v1-communities-community-id-actors-actor-id-notification-prefs-kind
|
|
31462
31481
|
* @example
|
|
31463
31482
|
* ```ts
|
|
31464
|
-
* const notificationPref = await social.community("
|
|
31483
|
+
* const notificationPref = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.notificationPrefs.update("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "follow", { enabled: false });
|
|
31465
31484
|
* ```
|
|
31466
31485
|
*/
|
|
31467
31486
|
update(actorId: string, kind: string, params: ActorNotificationPrefUpdateParams, options?: RequestOptions): APIPromise<WithLastResponse<NotificationPref>>;
|
|
@@ -31483,10 +31502,10 @@ declare class CommunityActorsNotificationsResource extends APIResource {
|
|
|
31483
31502
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-actors-actor-id-notifications
|
|
31484
31503
|
* @example
|
|
31485
31504
|
* ```ts
|
|
31486
|
-
* for await (const notification of social.community("
|
|
31505
|
+
* for await (const notification of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.notifications.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f")) {
|
|
31487
31506
|
* console.log(notification);
|
|
31488
31507
|
* }
|
|
31489
|
-
* const page = await social.community("
|
|
31508
|
+
* const page = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.notifications.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {}, { timeout: 5_000 });
|
|
31490
31509
|
* ```
|
|
31491
31510
|
*/
|
|
31492
31511
|
list(actorId: string, params?: ActorNotificationListParams, options?: RequestOptions): PagePromise<NotificationResponse>;
|
|
@@ -31506,7 +31525,7 @@ declare class CommunityActorsNotificationsResource extends APIResource {
|
|
|
31506
31525
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-actors-actor-id-notifications-read-all
|
|
31507
31526
|
* @example
|
|
31508
31527
|
* ```ts
|
|
31509
|
-
* const result = await social.community("
|
|
31528
|
+
* const result = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.notifications.markAllRead("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", { before: "2026-05-01T00:00:00.000Z" });
|
|
31510
31529
|
* ```
|
|
31511
31530
|
*/
|
|
31512
31531
|
markAllRead(actorId: string, params?: ActorNotificationMarkAllReadParams, options?: RequestOptions): APIPromise<WithLastResponse<MarkAllReadResponse>>;
|
|
@@ -31524,7 +31543,7 @@ declare class CommunityActorsNotificationsResource extends APIResource {
|
|
|
31524
31543
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-actors-actor-id-notifications-unread-count
|
|
31525
31544
|
* @example
|
|
31526
31545
|
* ```ts
|
|
31527
|
-
* const result = await social.community("
|
|
31546
|
+
* const result = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.notifications.unreadCount("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
31528
31547
|
* ```
|
|
31529
31548
|
*/
|
|
31530
31549
|
unreadCount(actorId: string, options?: RequestOptions): APIPromise<WithLastResponse<UnreadCountResponse>>;
|
|
@@ -31545,7 +31564,7 @@ declare class CommunityActorsNotificationsResource extends APIResource {
|
|
|
31545
31564
|
* @see https://productcraft.co/docs/social/api-reference#patch-v1-communities-community-id-actors-actor-id-notifications-notification-id
|
|
31546
31565
|
* @example
|
|
31547
31566
|
* ```ts
|
|
31548
|
-
* await social.community("
|
|
31567
|
+
* await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.notifications.update("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "11111111-1111-1111-1111-111111111111", { read: true });
|
|
31549
31568
|
* ```
|
|
31550
31569
|
*/
|
|
31551
31570
|
update(actorId: string, notificationId: string, params: ActorNotificationUpdateParams, options?: RequestOptions): APIPromise<void>;
|
|
@@ -31568,7 +31587,7 @@ declare class CommunityActorsRelationshipsResource extends APIResource {
|
|
|
31568
31587
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-actors-src-actor-id-relationships
|
|
31569
31588
|
* @example
|
|
31570
31589
|
* ```ts
|
|
31571
|
-
* const relationshipList = await social.community("
|
|
31590
|
+
* const relationshipList = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.relationships.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", { with: "0b1c2d3e-4f50-4a6b-8c7d-8e9f0a1b2c3d" });
|
|
31572
31591
|
* ```
|
|
31573
31592
|
*/
|
|
31574
31593
|
list(srcActorId: string, params: ActorRelationshipListParams, options?: RequestOptions): APIPromise<WithLastResponse<RelationshipList>>;
|
|
@@ -31589,10 +31608,10 @@ declare class CommunityActorsRestrictsResource extends APIResource {
|
|
|
31589
31608
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-actors-actor-id-restricts
|
|
31590
31609
|
* @example
|
|
31591
31610
|
* ```ts
|
|
31592
|
-
* for await (const restrict of social.community("
|
|
31611
|
+
* for await (const restrict of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.restricts.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f")) {
|
|
31593
31612
|
* console.log(restrict);
|
|
31594
31613
|
* }
|
|
31595
|
-
* const page = await social.community("
|
|
31614
|
+
* const page = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.restricts.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {}, { timeout: 5_000 });
|
|
31596
31615
|
* ```
|
|
31597
31616
|
*/
|
|
31598
31617
|
list(actorId: string, params?: ActorRestrictListParams, options?: RequestOptions): PagePromise<OutboundEdge>;
|
|
@@ -31614,10 +31633,10 @@ declare class CommunityActorsScheduledPostsResource extends APIResource {
|
|
|
31614
31633
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-actors-actor-id-scheduled-posts
|
|
31615
31634
|
* @example
|
|
31616
31635
|
* ```ts
|
|
31617
|
-
* for await (const scheduledPost of social.community("
|
|
31636
|
+
* for await (const scheduledPost of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.scheduledPosts.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f")) {
|
|
31618
31637
|
* console.log(scheduledPost);
|
|
31619
31638
|
* }
|
|
31620
|
-
* const page = await social.community("
|
|
31639
|
+
* const page = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.scheduledPosts.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {}, { timeout: 5_000 });
|
|
31621
31640
|
* ```
|
|
31622
31641
|
*/
|
|
31623
31642
|
list(actorId: string, params?: ActorScheduledPostListParams, options?: RequestOptions): PagePromise<Post>;
|
|
@@ -31638,7 +31657,7 @@ declare class CommunityActorsStoryTrayResource extends APIResource {
|
|
|
31638
31657
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-actors-actor-id-story-tray
|
|
31639
31658
|
* @example
|
|
31640
31659
|
* ```ts
|
|
31641
|
-
* for await (const storyTray of social.community("
|
|
31660
|
+
* for await (const storyTray of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.storyTray.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f")) {
|
|
31642
31661
|
* console.log(storyTray);
|
|
31643
31662
|
* }
|
|
31644
31663
|
* ```
|
|
@@ -31662,10 +31681,10 @@ declare class CommunityActorsSuggestedFollowsResource extends APIResource {
|
|
|
31662
31681
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-actors-actor-id-suggested-follows
|
|
31663
31682
|
* @example
|
|
31664
31683
|
* ```ts
|
|
31665
|
-
* for await (const suggestedFollow of social.community("
|
|
31684
|
+
* for await (const suggestedFollow of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.suggestedFollows.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f")) {
|
|
31666
31685
|
* console.log(suggestedFollow);
|
|
31667
31686
|
* }
|
|
31668
|
-
* const page = await social.community("
|
|
31687
|
+
* const page = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.suggestedFollows.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {}, { timeout: 5_000 });
|
|
31669
31688
|
* ```
|
|
31670
31689
|
*/
|
|
31671
31690
|
list(actorId: string, params?: ActorSuggestedFollowListParams, options?: RequestOptions): PagePromise<SuggestedFollow>;
|
|
@@ -31687,10 +31706,10 @@ declare class CommunityActorsTaggedResource extends APIResource {
|
|
|
31687
31706
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-actors-tagged-actor-id-tagged
|
|
31688
31707
|
* @example
|
|
31689
31708
|
* ```ts
|
|
31690
|
-
* for await (const tagged of social.community("
|
|
31709
|
+
* for await (const tagged of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.tagged.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f")) {
|
|
31691
31710
|
* console.log(tagged);
|
|
31692
31711
|
* }
|
|
31693
|
-
* const page = await social.community("
|
|
31712
|
+
* const page = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.tagged.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {}, { timeout: 5_000 });
|
|
31694
31713
|
* ```
|
|
31695
31714
|
*/
|
|
31696
31715
|
list(taggedActorId: string, params?: WithOptionalActor<ActorTaggedListParams>, options?: RequestOptions): PagePromise<Post>;
|
|
@@ -31737,7 +31756,7 @@ declare class CommunityActorsResource extends APIResource {
|
|
|
31737
31756
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-actors-batch
|
|
31738
31757
|
* @example
|
|
31739
31758
|
* ```ts
|
|
31740
|
-
* const batchActors = await social.community("
|
|
31759
|
+
* const batchActors = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.batch({ actors: [{ external_id: "user_abc123" }] });
|
|
31741
31760
|
* ```
|
|
31742
31761
|
*/
|
|
31743
31762
|
batch(params: ActorBatchParams, options?: RequestOptions): APIPromise<WithLastResponse<BatchActors>>;
|
|
@@ -31753,7 +31772,7 @@ declare class CommunityActorsResource extends APIResource {
|
|
|
31753
31772
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-actors-actor-id-counters
|
|
31754
31773
|
* @example
|
|
31755
31774
|
* ```ts
|
|
31756
|
-
* const actorCounters = await social.community("
|
|
31775
|
+
* const actorCounters = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.counters("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
31757
31776
|
* ```
|
|
31758
31777
|
*/
|
|
31759
31778
|
counters(actorId: string, options?: RequestOptions): APIPromise<WithLastResponse<ActorCounters>>;
|
|
@@ -31771,7 +31790,7 @@ declare class CommunityActorsResource extends APIResource {
|
|
|
31771
31790
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-actors
|
|
31772
31791
|
* @example
|
|
31773
31792
|
* ```ts
|
|
31774
|
-
* const upsertActor = await social.community("
|
|
31793
|
+
* const upsertActor = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.create({ external_id: "user_abc123" });
|
|
31775
31794
|
* ```
|
|
31776
31795
|
*/
|
|
31777
31796
|
create(params: ActorCreateParams, options?: RequestOptions): APIPromise<WithLastResponse<UpsertActor>>;
|
|
@@ -31787,7 +31806,7 @@ declare class CommunityActorsResource extends APIResource {
|
|
|
31787
31806
|
* @see https://productcraft.co/docs/social/api-reference#delete-v1-communities-community-id-actors-actor-id
|
|
31788
31807
|
* @example
|
|
31789
31808
|
* ```ts
|
|
31790
|
-
* await social.community("
|
|
31809
|
+
* await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.delete("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
31791
31810
|
* ```
|
|
31792
31811
|
*/
|
|
31793
31812
|
delete(actorId: string, options?: RequestOptions): APIPromise<void>;
|
|
@@ -31805,7 +31824,7 @@ declare class CommunityActorsResource extends APIResource {
|
|
|
31805
31824
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-actors-actor-id-insights
|
|
31806
31825
|
* @example
|
|
31807
31826
|
* ```ts
|
|
31808
|
-
* const actorInsights = await social.community("
|
|
31827
|
+
* const actorInsights = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.insights("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
31809
31828
|
* ```
|
|
31810
31829
|
*/
|
|
31811
31830
|
insights(actorId: string, params?: ActorInsightsParams, options?: RequestOptions): APIPromise<WithLastResponse<ActorInsights>>;
|
|
@@ -31822,10 +31841,10 @@ declare class CommunityActorsResource extends APIResource {
|
|
|
31822
31841
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-actors
|
|
31823
31842
|
* @example
|
|
31824
31843
|
* ```ts
|
|
31825
|
-
* for await (const actor of social.community("
|
|
31844
|
+
* for await (const actor of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.list()) {
|
|
31826
31845
|
* console.log(actor);
|
|
31827
31846
|
* }
|
|
31828
|
-
* const page = await social.community("
|
|
31847
|
+
* const page = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.list({}, { timeout: 5_000 });
|
|
31829
31848
|
* ```
|
|
31830
31849
|
*/
|
|
31831
31850
|
list(params?: ActorListParams, options?: RequestOptions): PagePromise<Actor>;
|
|
@@ -31845,7 +31864,7 @@ declare class CommunityActorsResource extends APIResource {
|
|
|
31845
31864
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-actors-actor-id-post-state
|
|
31846
31865
|
* @example
|
|
31847
31866
|
* ```ts
|
|
31848
|
-
* const postState = await social.community("
|
|
31867
|
+
* const postState = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.postState("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {
|
|
31849
31868
|
* post_ids: ["bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb", "cccccccc-cccc-cccc-cccc-cccccccccccc"],
|
|
31850
31869
|
* });
|
|
31851
31870
|
* ```
|
|
@@ -31862,7 +31881,7 @@ declare class CommunityActorsResource extends APIResource {
|
|
|
31862
31881
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-actors-actor-id
|
|
31863
31882
|
* @example
|
|
31864
31883
|
* ```ts
|
|
31865
|
-
* const actor = await social.community("
|
|
31884
|
+
* const actor = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.retrieve("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
31866
31885
|
* ```
|
|
31867
31886
|
*/
|
|
31868
31887
|
retrieve(actorId: string, options?: RequestOptions): APIPromise<WithLastResponse<Actor>>;
|
|
@@ -31880,7 +31899,7 @@ declare class CommunityActorsResource extends APIResource {
|
|
|
31880
31899
|
* @see https://productcraft.co/docs/social/api-reference#patch-v1-communities-community-id-actors-actor-id
|
|
31881
31900
|
* @example
|
|
31882
31901
|
* ```ts
|
|
31883
|
-
* const actor = await social.community("
|
|
31902
|
+
* const actor = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").actors.update("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", { avatar_url: "string" });
|
|
31884
31903
|
* ```
|
|
31885
31904
|
*/
|
|
31886
31905
|
update(actorId: string, params?: ActorUpdateParams, options?: RequestOptions): APIPromise<WithLastResponse<Actor>>;
|
|
@@ -31901,7 +31920,7 @@ declare class CommunityAssetsResource extends APIResource {
|
|
|
31901
31920
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-assets-asset-id-complete
|
|
31902
31921
|
* @example
|
|
31903
31922
|
* ```ts
|
|
31904
|
-
* const uploadAsset = await social.community("
|
|
31923
|
+
* const uploadAsset = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").assets.complete("eeeeeeee-0000-0000-0000-000000000001");
|
|
31905
31924
|
* ```
|
|
31906
31925
|
*/
|
|
31907
31926
|
complete(assetId: string, options?: RequestOptions): APIPromise<WithLastResponse<UploadAsset>>;
|
|
@@ -31920,7 +31939,7 @@ declare class CommunityAssetsResource extends APIResource {
|
|
|
31920
31939
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-assets
|
|
31921
31940
|
* @example
|
|
31922
31941
|
* ```ts
|
|
31923
|
-
* const uploadAsset = await social.community("
|
|
31942
|
+
* const uploadAsset = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").assets.create();
|
|
31924
31943
|
* ```
|
|
31925
31944
|
*/
|
|
31926
31945
|
create(params?: WithOptionalActor<AssetCreateParams>, options?: RequestOptions): APIPromise<WithLastResponse<UploadAsset>>;
|
|
@@ -31936,7 +31955,7 @@ declare class CommunityAssetsResource extends APIResource {
|
|
|
31936
31955
|
* @see https://productcraft.co/docs/social/api-reference#delete-v1-communities-community-id-assets-asset-id
|
|
31937
31956
|
* @example
|
|
31938
31957
|
* ```ts
|
|
31939
|
-
* await social.community("
|
|
31958
|
+
* await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").assets.delete("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
31940
31959
|
* ```
|
|
31941
31960
|
*/
|
|
31942
31961
|
delete(assetId: string, options?: RequestOptions): APIPromise<void>;
|
|
@@ -31952,7 +31971,7 @@ declare class CommunityAssetsResource extends APIResource {
|
|
|
31952
31971
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-assets-asset-id
|
|
31953
31972
|
* @example
|
|
31954
31973
|
* ```ts
|
|
31955
|
-
* const asset = await social.community("
|
|
31974
|
+
* const asset = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").assets.retrieve("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
31956
31975
|
* ```
|
|
31957
31976
|
*/
|
|
31958
31977
|
retrieve(assetId: string, options?: RequestOptions): APIPromise<WithLastResponse<Asset>>;
|
|
@@ -31974,7 +31993,7 @@ declare class CommunityBlocksResource extends APIResource {
|
|
|
31974
31993
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-blocks
|
|
31975
31994
|
* @example
|
|
31976
31995
|
* ```ts
|
|
31977
|
-
* const createEdge = await social.community("
|
|
31996
|
+
* const createEdge = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").blocks.create({ dst_actor_id: "aaaaaaaa-0000-0000-0000-000000000002" });
|
|
31978
31997
|
* ```
|
|
31979
31998
|
*/
|
|
31980
31999
|
create(params: WithOptionalActor<BlockCreateParams>, options?: RequestOptions): APIPromise<WithLastResponse<CreateEdge>>;
|
|
@@ -31991,7 +32010,7 @@ declare class CommunityBlocksResource extends APIResource {
|
|
|
31991
32010
|
* @see https://productcraft.co/docs/social/api-reference#delete-v1-communities-community-id-blocks-src-actor-id-dst-actor-id
|
|
31992
32011
|
* @example
|
|
31993
32012
|
* ```ts
|
|
31994
|
-
* await social.community("
|
|
32013
|
+
* await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").blocks.delete("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
31995
32014
|
* ```
|
|
31996
32015
|
*/
|
|
31997
32016
|
delete(srcActorId: string, dstActorId: string, options?: RequestOptions): APIPromise<void>;
|
|
@@ -32015,7 +32034,7 @@ declare class CommunityCloseFriendsResource extends APIResource {
|
|
|
32015
32034
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-close-friends
|
|
32016
32035
|
* @example
|
|
32017
32036
|
* ```ts
|
|
32018
|
-
* await social.community("
|
|
32037
|
+
* await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").closeFriends.create({ member_actor_id: "aaaaaaaa-0000-0000-0000-000000000002" });
|
|
32019
32038
|
* ```
|
|
32020
32039
|
*/
|
|
32021
32040
|
create(params: WithOptionalActor<CloseFriendCreateParams>, options?: RequestOptions): APIPromise<void>;
|
|
@@ -32034,7 +32053,7 @@ declare class CommunityCloseFriendsResource extends APIResource {
|
|
|
32034
32053
|
* @see https://productcraft.co/docs/social/api-reference#delete-v1-communities-community-id-close-friends-owner-actor-id-member-actor-id
|
|
32035
32054
|
* @example
|
|
32036
32055
|
* ```ts
|
|
32037
|
-
* await social.community("
|
|
32056
|
+
* await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").closeFriends.delete("aaaaaaaa-0000-0000-0000-000000000001", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
32038
32057
|
* ```
|
|
32039
32058
|
*/
|
|
32040
32059
|
delete(ownerActorId: string, memberActorId: string, options?: RequestOptions): APIPromise<void>;
|
|
@@ -32055,7 +32074,7 @@ declare class CommunityCollectionsItemsResource extends APIResource {
|
|
|
32055
32074
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-collections-collection-id-items
|
|
32056
32075
|
* @example
|
|
32057
32076
|
* ```ts
|
|
32058
|
-
* const collectionItem = await social.community("
|
|
32077
|
+
* const collectionItem = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").collections.items.create("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", { post_id: "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb" });
|
|
32059
32078
|
* ```
|
|
32060
32079
|
*/
|
|
32061
32080
|
create(collectionId: string, params: WithOptionalActor<CollectionItemCreateParams>, options?: RequestOptions): APIPromise<WithLastResponse<CollectionItem>>;
|
|
@@ -32072,7 +32091,7 @@ declare class CommunityCollectionsItemsResource extends APIResource {
|
|
|
32072
32091
|
* @see https://productcraft.co/docs/social/api-reference#delete-v1-communities-community-id-collections-collection-id-items-post-id
|
|
32073
32092
|
* @example
|
|
32074
32093
|
* ```ts
|
|
32075
|
-
* await social.community("
|
|
32094
|
+
* await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").collections.items.delete("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", { caller_actor_id: "aaaaaaaa-0000-0000-0000-000000000001" });
|
|
32076
32095
|
* ```
|
|
32077
32096
|
*/
|
|
32078
32097
|
delete(collectionId: string, postId: string, params?: WithOptionalActor<CollectionItemDeleteParams>, options?: RequestOptions): APIPromise<void>;
|
|
@@ -32088,10 +32107,10 @@ declare class CommunityCollectionsItemsResource extends APIResource {
|
|
|
32088
32107
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-collections-collection-id-items
|
|
32089
32108
|
* @example
|
|
32090
32109
|
* ```ts
|
|
32091
|
-
* for await (const item of social.community("
|
|
32110
|
+
* for await (const item of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").collections.items.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f")) {
|
|
32092
32111
|
* console.log(item);
|
|
32093
32112
|
* }
|
|
32094
|
-
* const page = await social.community("
|
|
32113
|
+
* const page = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").collections.items.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {}, { timeout: 5_000 });
|
|
32095
32114
|
* ```
|
|
32096
32115
|
*/
|
|
32097
32116
|
list(collectionId: string, params?: WithOptionalActor<CollectionItemListParams>, options?: RequestOptions): PagePromise<CollectionItem>;
|
|
@@ -32109,7 +32128,7 @@ declare class CommunityCollectionsItemsResource extends APIResource {
|
|
|
32109
32128
|
* @see https://productcraft.co/docs/social/api-reference#patch-v1-communities-community-id-collections-collection-id-items-post-id
|
|
32110
32129
|
* @example
|
|
32111
32130
|
* ```ts
|
|
32112
|
-
* const collectionItem = await social.community("
|
|
32131
|
+
* const collectionItem = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").collections.items.update("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", { position: 3 });
|
|
32113
32132
|
* ```
|
|
32114
32133
|
*/
|
|
32115
32134
|
update(collectionId: string, postId: string, params: WithOptionalActor<CollectionItemUpdateParams>, options?: RequestOptions): APIPromise<WithLastResponse<CollectionItem>>;
|
|
@@ -32133,7 +32152,7 @@ declare class CommunityCollectionsResource extends APIResource {
|
|
|
32133
32152
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-collections
|
|
32134
32153
|
* @example
|
|
32135
32154
|
* ```ts
|
|
32136
|
-
* const collection = await social.community("
|
|
32155
|
+
* const collection = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").collections.create({ name: "Travel" });
|
|
32137
32156
|
* ```
|
|
32138
32157
|
*/
|
|
32139
32158
|
create(params: WithOptionalActor<CollectionCreateParams>, options?: RequestOptions): APIPromise<WithLastResponse<Collection>>;
|
|
@@ -32150,7 +32169,7 @@ declare class CommunityCollectionsResource extends APIResource {
|
|
|
32150
32169
|
* @see https://productcraft.co/docs/social/api-reference#delete-v1-communities-community-id-collections-collection-id
|
|
32151
32170
|
* @example
|
|
32152
32171
|
* ```ts
|
|
32153
|
-
* await social.community("
|
|
32172
|
+
* await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").collections.delete("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", { caller_actor_id: "aaaaaaaa-0000-0000-0000-000000000001" });
|
|
32154
32173
|
* ```
|
|
32155
32174
|
*/
|
|
32156
32175
|
delete(collectionId: string, params?: WithOptionalActor<CollectionDeleteParams>, options?: RequestOptions): APIPromise<void>;
|
|
@@ -32164,10 +32183,10 @@ declare class CommunityCollectionsResource extends APIResource {
|
|
|
32164
32183
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-collections
|
|
32165
32184
|
* @example
|
|
32166
32185
|
* ```ts
|
|
32167
|
-
* for await (const collection of social.community("
|
|
32186
|
+
* for await (const collection of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").collections.list()) {
|
|
32168
32187
|
* console.log(collection);
|
|
32169
32188
|
* }
|
|
32170
|
-
* const page = await social.community("
|
|
32189
|
+
* const page = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").collections.list({}, { timeout: 5_000 });
|
|
32171
32190
|
* ```
|
|
32172
32191
|
*/
|
|
32173
32192
|
list(params?: WithOptionalActor<CollectionListParams>, options?: RequestOptions): PagePromise<Collection>;
|
|
@@ -32183,7 +32202,7 @@ declare class CommunityCollectionsResource extends APIResource {
|
|
|
32183
32202
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-collections-collection-id
|
|
32184
32203
|
* @example
|
|
32185
32204
|
* ```ts
|
|
32186
|
-
* const collection = await social.community("
|
|
32205
|
+
* const collection = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").collections.retrieve("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
32187
32206
|
* ```
|
|
32188
32207
|
*/
|
|
32189
32208
|
retrieve(collectionId: string, params?: WithOptionalActor<CollectionRetrieveParams>, options?: RequestOptions): APIPromise<WithLastResponse<Collection>>;
|
|
@@ -32201,7 +32220,7 @@ declare class CommunityCollectionsResource extends APIResource {
|
|
|
32201
32220
|
* @see https://productcraft.co/docs/social/api-reference#patch-v1-communities-community-id-collections-collection-id
|
|
32202
32221
|
* @example
|
|
32203
32222
|
* ```ts
|
|
32204
|
-
* const collection = await social.community("
|
|
32223
|
+
* const collection = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").collections.update("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
32205
32224
|
* ```
|
|
32206
32225
|
*/
|
|
32207
32226
|
update(collectionId: string, params?: WithOptionalActor<CollectionUpdateParams>, options?: RequestOptions): APIPromise<WithLastResponse<Collection>>;
|
|
@@ -32222,7 +32241,7 @@ declare class CommunityConnectionsResource extends APIResource {
|
|
|
32222
32241
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-connections-dst-actor-id-src-actor-id-accept
|
|
32223
32242
|
* @example
|
|
32224
32243
|
* ```ts
|
|
32225
|
-
* const connectionResult = await social.community("
|
|
32244
|
+
* const connectionResult = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").connections.accept("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
32226
32245
|
* ```
|
|
32227
32246
|
*/
|
|
32228
32247
|
accept(dstActorId: string, srcActorId: string, options?: RequestOptions): APIPromise<WithLastResponse<ConnectionResult>>;
|
|
@@ -32241,7 +32260,7 @@ declare class CommunityConnectionsResource extends APIResource {
|
|
|
32241
32260
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-connections
|
|
32242
32261
|
* @example
|
|
32243
32262
|
* ```ts
|
|
32244
|
-
* const connectionResult = await social.community("
|
|
32263
|
+
* const connectionResult = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").connections.create({
|
|
32245
32264
|
* dst_actor_id: "aaaaaaaa-0000-0000-0000-000000000002",
|
|
32246
32265
|
* src_actor_id: "aaaaaaaa-0000-0000-0000-000000000001",
|
|
32247
32266
|
* });
|
|
@@ -32262,7 +32281,7 @@ declare class CommunityConnectionsResource extends APIResource {
|
|
|
32262
32281
|
* @see https://productcraft.co/docs/social/api-reference#delete-v1-communities-community-id-connections-actor-id-other-actor-id
|
|
32263
32282
|
* @example
|
|
32264
32283
|
* ```ts
|
|
32265
|
-
* await social.community("
|
|
32284
|
+
* await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").connections.delete("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
32266
32285
|
* ```
|
|
32267
32286
|
*/
|
|
32268
32287
|
delete(actorId: string, otherActorId: string, options?: RequestOptions): APIPromise<void>;
|
|
@@ -32284,7 +32303,7 @@ declare class CommunityConversationsMembersResource extends APIResource {
|
|
|
32284
32303
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-conversations-conversation-id-members
|
|
32285
32304
|
* @example
|
|
32286
32305
|
* ```ts
|
|
32287
|
-
* const conversation = await social.community("
|
|
32306
|
+
* const conversation = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").conversations.members.create("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {});
|
|
32288
32307
|
* ```
|
|
32289
32308
|
*/
|
|
32290
32309
|
create(conversationId: string, params?: WithOptionalActor<ConversationMemberCreateParams>, options?: RequestOptions): APIPromise<WithLastResponse<Conversation>>;
|
|
@@ -32304,7 +32323,7 @@ declare class CommunityConversationsMembersResource extends APIResource {
|
|
|
32304
32323
|
* @see https://productcraft.co/docs/social/api-reference#delete-v1-communities-community-id-conversations-conversation-id-members-member-actor-id
|
|
32305
32324
|
* @example
|
|
32306
32325
|
* ```ts
|
|
32307
|
-
* await social.community("
|
|
32326
|
+
* await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").conversations.members.delete("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {});
|
|
32308
32327
|
* ```
|
|
32309
32328
|
*/
|
|
32310
32329
|
delete(conversationId: string, memberActorId: string, params?: WithOptionalActor<ConversationMemberDeleteParams>, options?: RequestOptions): APIPromise<void>;
|
|
@@ -32323,7 +32342,7 @@ declare class CommunityConversationsMembersResource extends APIResource {
|
|
|
32323
32342
|
* @see https://productcraft.co/docs/social/api-reference#patch-v1-communities-community-id-conversations-conversation-id-members-member-actor-id
|
|
32324
32343
|
* @example
|
|
32325
32344
|
* ```ts
|
|
32326
|
-
* const conversation = await social.community("
|
|
32345
|
+
* const conversation = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").conversations.members.update("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
32327
32346
|
* ```
|
|
32328
32347
|
*/
|
|
32329
32348
|
update(conversationId: string, memberActorId: string, params?: WithOptionalActor<ConversationMemberUpdateParams>, options?: RequestOptions): APIPromise<WithLastResponse<Conversation>>;
|
|
@@ -32346,7 +32365,7 @@ declare class CommunityConversationsMessagesReactionsResource extends APIResourc
|
|
|
32346
32365
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-conversations-conversation-id-messages-message-id-reactions
|
|
32347
32366
|
* @example
|
|
32348
32367
|
* ```ts
|
|
32349
|
-
* const directMessageReactionCreated = await social.community("
|
|
32368
|
+
* const directMessageReactionCreated = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").conversations.messages.reactions.create("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", { type: "heart" });
|
|
32350
32369
|
* ```
|
|
32351
32370
|
*/
|
|
32352
32371
|
create(conversationId: string, messageId: string, params: WithOptionalActor<ConversationMessageReactionCreateParams>, options?: RequestOptions): APIPromise<WithLastResponse<DirectMessageReactionCreated>>;
|
|
@@ -32365,7 +32384,7 @@ declare class CommunityConversationsMessagesReactionsResource extends APIResourc
|
|
|
32365
32384
|
* @see https://productcraft.co/docs/social/api-reference#delete-v1-communities-community-id-conversations-conversation-id-messages-message-id-reactions-actor-id-type
|
|
32366
32385
|
* @example
|
|
32367
32386
|
* ```ts
|
|
32368
|
-
* const directMessageReactionRemoved = await social.community("
|
|
32387
|
+
* const directMessageReactionRemoved = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").conversations.messages.reactions.delete("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "like");
|
|
32369
32388
|
* ```
|
|
32370
32389
|
*/
|
|
32371
32390
|
delete(conversationId: string, messageId: string, actorId: string, type: string, options?: RequestOptions): APIPromise<WithLastResponse<DirectMessageReactionRemoved>>;
|
|
@@ -32383,7 +32402,7 @@ declare class CommunityConversationsMessagesReactionsResource extends APIResourc
|
|
|
32383
32402
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-conversations-conversation-id-messages-message-id-reactions
|
|
32384
32403
|
* @example
|
|
32385
32404
|
* ```ts
|
|
32386
|
-
* for await (const reaction of social.community("
|
|
32405
|
+
* for await (const reaction of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").conversations.messages.reactions.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {})) {
|
|
32387
32406
|
* console.log(reaction);
|
|
32388
32407
|
* }
|
|
32389
32408
|
* ```
|
|
@@ -32409,7 +32428,7 @@ declare class CommunityConversationsMessagesResource extends APIResource {
|
|
|
32409
32428
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-conversations-conversation-id-messages
|
|
32410
32429
|
* @example
|
|
32411
32430
|
* ```ts
|
|
32412
|
-
* const directMessage = await social.community("
|
|
32431
|
+
* const directMessage = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").conversations.messages.create("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {});
|
|
32413
32432
|
* ```
|
|
32414
32433
|
*/
|
|
32415
32434
|
create(conversationId: string, params?: WithOptionalActor<ConversationMessageCreateParams>, options?: RequestOptions): APIPromise<WithLastResponse<DirectMessage>>;
|
|
@@ -32428,7 +32447,7 @@ declare class CommunityConversationsMessagesResource extends APIResource {
|
|
|
32428
32447
|
* @see https://productcraft.co/docs/social/api-reference#delete-v1-communities-community-id-conversations-conversation-id-messages-message-id
|
|
32429
32448
|
* @example
|
|
32430
32449
|
* ```ts
|
|
32431
|
-
* await social.community("
|
|
32450
|
+
* await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").conversations.messages.delete("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {});
|
|
32432
32451
|
* ```
|
|
32433
32452
|
*/
|
|
32434
32453
|
delete(conversationId: string, messageId: string, params?: WithOptionalActor<ConversationMessageDeleteParams>, options?: RequestOptions): APIPromise<void>;
|
|
@@ -32445,7 +32464,7 @@ declare class CommunityConversationsMessagesResource extends APIResource {
|
|
|
32445
32464
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-conversations-conversation-id-messages
|
|
32446
32465
|
* @example
|
|
32447
32466
|
* ```ts
|
|
32448
|
-
* for await (const message of social.community("
|
|
32467
|
+
* for await (const message of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").conversations.messages.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {})) {
|
|
32449
32468
|
* console.log(message);
|
|
32450
32469
|
* }
|
|
32451
32470
|
* ```
|
|
@@ -32465,7 +32484,7 @@ declare class CommunityConversationsMessagesResource extends APIResource {
|
|
|
32465
32484
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-conversations-conversation-id-messages-message-id
|
|
32466
32485
|
* @example
|
|
32467
32486
|
* ```ts
|
|
32468
|
-
* const directMessage = await social.community("
|
|
32487
|
+
* const directMessage = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").conversations.messages.retrieve("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {});
|
|
32469
32488
|
* ```
|
|
32470
32489
|
*/
|
|
32471
32490
|
retrieve(conversationId: string, messageId: string, params?: WithOptionalActor<ConversationMessageRetrieveParams>, options?: RequestOptions): APIPromise<WithLastResponse<DirectMessage>>;
|
|
@@ -32485,7 +32504,7 @@ declare class CommunityConversationsMessagesResource extends APIResource {
|
|
|
32485
32504
|
* @see https://productcraft.co/docs/social/api-reference#patch-v1-communities-community-id-conversations-conversation-id-messages-message-id
|
|
32486
32505
|
* @example
|
|
32487
32506
|
* ```ts
|
|
32488
|
-
* const directMessage = await social.community("
|
|
32507
|
+
* const directMessage = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").conversations.messages.update("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", { body: "edited" });
|
|
32489
32508
|
* ```
|
|
32490
32509
|
*/
|
|
32491
32510
|
update(conversationId: string, messageId: string, params: WithOptionalActor<ConversationMessageUpdateParams>, options?: RequestOptions): APIPromise<WithLastResponse<DirectMessage>>;
|
|
@@ -32509,7 +32528,7 @@ declare class CommunityConversationsResource extends APIResource {
|
|
|
32509
32528
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-conversations
|
|
32510
32529
|
* @example
|
|
32511
32530
|
* ```ts
|
|
32512
|
-
* const conversation = await social.community("
|
|
32531
|
+
* const conversation = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").conversations.create({});
|
|
32513
32532
|
* ```
|
|
32514
32533
|
*/
|
|
32515
32534
|
create(params?: WithOptionalActor<ConversationCreateParams>, options?: RequestOptions): APIPromise<WithLastResponse<Conversation>>;
|
|
@@ -32527,7 +32546,7 @@ declare class CommunityConversationsResource extends APIResource {
|
|
|
32527
32546
|
* @see https://productcraft.co/docs/social/api-reference#delete-v1-communities-community-id-conversations-conversation-id
|
|
32528
32547
|
* @example
|
|
32529
32548
|
* ```ts
|
|
32530
|
-
* await social.community("
|
|
32549
|
+
* await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").conversations.delete("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {});
|
|
32531
32550
|
* ```
|
|
32532
32551
|
*/
|
|
32533
32552
|
delete(conversationId: string, params?: WithOptionalActor<ConversationDeleteParams>, options?: RequestOptions): APIPromise<void>;
|
|
@@ -32543,7 +32562,7 @@ declare class CommunityConversationsResource extends APIResource {
|
|
|
32543
32562
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-conversations
|
|
32544
32563
|
* @example
|
|
32545
32564
|
* ```ts
|
|
32546
|
-
* for await (const conversation of social.community("
|
|
32565
|
+
* for await (const conversation of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").conversations.list({})) {
|
|
32547
32566
|
* console.log(conversation);
|
|
32548
32567
|
* }
|
|
32549
32568
|
* ```
|
|
@@ -32563,7 +32582,7 @@ declare class CommunityConversationsResource extends APIResource {
|
|
|
32563
32582
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-conversations-conversation-id-read
|
|
32564
32583
|
* @example
|
|
32565
32584
|
* ```ts
|
|
32566
|
-
* await social.community("
|
|
32585
|
+
* await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").conversations.markRead("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {});
|
|
32567
32586
|
* ```
|
|
32568
32587
|
*/
|
|
32569
32588
|
markRead(conversationId: string, params?: WithOptionalActor<ConversationMarkReadParams>, options?: RequestOptions): APIPromise<void>;
|
|
@@ -32580,7 +32599,7 @@ declare class CommunityConversationsResource extends APIResource {
|
|
|
32580
32599
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-conversations-conversation-id
|
|
32581
32600
|
* @example
|
|
32582
32601
|
* ```ts
|
|
32583
|
-
* const conversation = await social.community("
|
|
32602
|
+
* const conversation = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").conversations.retrieve("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {});
|
|
32584
32603
|
* ```
|
|
32585
32604
|
*/
|
|
32586
32605
|
retrieve(conversationId: string, params?: WithOptionalActor<ConversationRetrieveParams>, options?: RequestOptions): APIPromise<WithLastResponse<Conversation>>;
|
|
@@ -32596,7 +32615,7 @@ declare class CommunityConversationsResource extends APIResource {
|
|
|
32596
32615
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-conversations-unread-count
|
|
32597
32616
|
* @example
|
|
32598
32617
|
* ```ts
|
|
32599
|
-
* const unreadCount = await social.community("
|
|
32618
|
+
* const unreadCount = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").conversations.unreadCount({});
|
|
32600
32619
|
* ```
|
|
32601
32620
|
*/
|
|
32602
32621
|
unreadCount(params?: WithOptionalActor<ConversationUnreadCountParams>, options?: RequestOptions): APIPromise<WithLastResponse<UnreadCount>>;
|
|
@@ -32615,7 +32634,7 @@ declare class CommunityConversationsResource extends APIResource {
|
|
|
32615
32634
|
* @see https://productcraft.co/docs/social/api-reference#patch-v1-communities-community-id-conversations-conversation-id
|
|
32616
32635
|
* @example
|
|
32617
32636
|
* ```ts
|
|
32618
|
-
* const conversation = await social.community("
|
|
32637
|
+
* const conversation = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").conversations.update("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {});
|
|
32619
32638
|
* ```
|
|
32620
32639
|
*/
|
|
32621
32640
|
update(conversationId: string, params?: WithOptionalActor<ConversationUpdateParams>, options?: RequestOptions): APIPromise<WithLastResponse<Conversation>>;
|
|
@@ -32635,7 +32654,7 @@ declare class CommunityCountersResource extends APIResource {
|
|
|
32635
32654
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-counters
|
|
32636
32655
|
* @example
|
|
32637
32656
|
* ```ts
|
|
32638
|
-
* const batchCounters = await social.community("
|
|
32657
|
+
* const batchCounters = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").counters.list({ actor_ids: "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f,0b1c2d3e-4f50-4a6b-8c7d-8e9f0a1b2c3d" });
|
|
32639
32658
|
* ```
|
|
32640
32659
|
*/
|
|
32641
32660
|
list(params: CounterListParams, options?: RequestOptions): APIPromise<WithLastResponse<BatchCounters>>;
|
|
@@ -32654,10 +32673,10 @@ declare class CommunityDiscoverFeedResource extends APIResource {
|
|
|
32654
32673
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-discover-feed
|
|
32655
32674
|
* @example
|
|
32656
32675
|
* ```ts
|
|
32657
|
-
* for await (const discoverFeed of social.community("
|
|
32676
|
+
* for await (const discoverFeed of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").discoverFeed.list()) {
|
|
32658
32677
|
* console.log(discoverFeed);
|
|
32659
32678
|
* }
|
|
32660
|
-
* const page = await social.community("
|
|
32679
|
+
* const page = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").discoverFeed.list({}, { timeout: 5_000 });
|
|
32661
32680
|
* ```
|
|
32662
32681
|
*/
|
|
32663
32682
|
list(params?: WithOptionalActor<DiscoverFeedListParams>, options?: RequestOptions): PagePromise<Post>;
|
|
@@ -32677,7 +32696,7 @@ declare class CommunityDismissedSuggestionsResource extends APIResource {
|
|
|
32677
32696
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-dismissed-suggestions
|
|
32678
32697
|
* @example
|
|
32679
32698
|
* ```ts
|
|
32680
|
-
* const createEdge = await social.community("
|
|
32699
|
+
* const createEdge = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").dismissedSuggestions.create({ dst_actor_id: "aaaaaaaa-0000-0000-0000-000000000002" });
|
|
32681
32700
|
* ```
|
|
32682
32701
|
*/
|
|
32683
32702
|
create(params: WithOptionalActor<DismissedSuggestionCreateParams>, options?: RequestOptions): APIPromise<WithLastResponse<CreateEdge>>;
|
|
@@ -32692,7 +32711,7 @@ declare class CommunityDismissedSuggestionsResource extends APIResource {
|
|
|
32692
32711
|
* @see https://productcraft.co/docs/social/api-reference#delete-v1-communities-community-id-dismissed-suggestions-src-actor-id-dst-actor-id
|
|
32693
32712
|
* @example
|
|
32694
32713
|
* ```ts
|
|
32695
|
-
* await social.community("
|
|
32714
|
+
* await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").dismissedSuggestions.delete("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
32696
32715
|
* ```
|
|
32697
32716
|
*/
|
|
32698
32717
|
delete(srcActorId: string, dstActorId: string, options?: RequestOptions): APIPromise<void>;
|
|
@@ -32714,7 +32733,7 @@ declare class CommunityFlagsResource extends APIResource {
|
|
|
32714
32733
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-flags
|
|
32715
32734
|
* @example
|
|
32716
32735
|
* ```ts
|
|
32717
|
-
* const createFlag = await social.community("
|
|
32736
|
+
* const createFlag = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").flags.create({ target_id: "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb", target_kind: "post" });
|
|
32718
32737
|
* ```
|
|
32719
32738
|
*/
|
|
32720
32739
|
create(params: WithOptionalActor<FlagCreateParams>, options?: RequestOptions): APIPromise<WithLastResponse<CreateFlag>>;
|
|
@@ -32729,10 +32748,10 @@ declare class CommunityFlagsResource extends APIResource {
|
|
|
32729
32748
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-flags
|
|
32730
32749
|
* @example
|
|
32731
32750
|
* ```ts
|
|
32732
|
-
* for await (const flag of social.community("
|
|
32751
|
+
* for await (const flag of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").flags.list()) {
|
|
32733
32752
|
* console.log(flag);
|
|
32734
32753
|
* }
|
|
32735
|
-
* const page = await social.community("
|
|
32754
|
+
* const page = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").flags.list({}, { timeout: 5_000 });
|
|
32736
32755
|
* ```
|
|
32737
32756
|
*/
|
|
32738
32757
|
list(params?: WithOptionalActor<FlagListParams>, options?: RequestOptions): PagePromise<Flag>;
|
|
@@ -32751,7 +32770,7 @@ declare class CommunityFollowRequestsResource extends APIResource {
|
|
|
32751
32770
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-follow-requests-dst-actor-id-src-actor-id-approve
|
|
32752
32771
|
* @example
|
|
32753
32772
|
* ```ts
|
|
32754
|
-
* const createEdge = await social.community("
|
|
32773
|
+
* const createEdge = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").followRequests.approve("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
32755
32774
|
* ```
|
|
32756
32775
|
*/
|
|
32757
32776
|
approve(dstActorId: string, srcActorId: string, options?: RequestOptions): APIPromise<WithLastResponse<CreateEdge>>;
|
|
@@ -32767,7 +32786,7 @@ declare class CommunityFollowRequestsResource extends APIResource {
|
|
|
32767
32786
|
* @see https://productcraft.co/docs/social/api-reference#delete-v1-communities-community-id-follow-requests-dst-actor-id-src-actor-id
|
|
32768
32787
|
* @example
|
|
32769
32788
|
* ```ts
|
|
32770
|
-
* await social.community("
|
|
32789
|
+
* await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").followRequests.delete("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
32771
32790
|
* ```
|
|
32772
32791
|
*/
|
|
32773
32792
|
delete(dstActorId: string, srcActorId: string, options?: RequestOptions): APIPromise<void>;
|
|
@@ -32787,7 +32806,7 @@ declare class CommunityFollowsResource extends APIResource {
|
|
|
32787
32806
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-follows-batch
|
|
32788
32807
|
* @example
|
|
32789
32808
|
* ```ts
|
|
32790
|
-
* const batchFollows = await social.community("
|
|
32809
|
+
* const batchFollows = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").follows.batch({
|
|
32791
32810
|
* follows: [
|
|
32792
32811
|
* {
|
|
32793
32812
|
* actor_id: "aaaaaaaa-0000-0000-0000-000000000001",
|
|
@@ -32813,7 +32832,7 @@ declare class CommunityFollowsResource extends APIResource {
|
|
|
32813
32832
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-follows
|
|
32814
32833
|
* @example
|
|
32815
32834
|
* ```ts
|
|
32816
|
-
* const followResult = await social.community("
|
|
32835
|
+
* const followResult = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").follows.create({ dst_actor_id: "aaaaaaaa-0000-0000-0000-000000000002" });
|
|
32817
32836
|
* ```
|
|
32818
32837
|
*/
|
|
32819
32838
|
create(params: WithOptionalActor<FollowCreateParams>, options?: RequestOptions): APIPromise<WithLastResponse<FollowResult>>;
|
|
@@ -32830,7 +32849,7 @@ declare class CommunityFollowsResource extends APIResource {
|
|
|
32830
32849
|
* @see https://productcraft.co/docs/social/api-reference#delete-v1-communities-community-id-follows-src-actor-id-dst-actor-id
|
|
32831
32850
|
* @example
|
|
32832
32851
|
* ```ts
|
|
32833
|
-
* await social.community("
|
|
32852
|
+
* await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").follows.delete("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
32834
32853
|
* ```
|
|
32835
32854
|
*/
|
|
32836
32855
|
delete(srcActorId: string, dstActorId: string, options?: RequestOptions): APIPromise<void>;
|
|
@@ -32851,10 +32870,10 @@ declare class CommunityHashtagsPostsResource extends APIResource {
|
|
|
32851
32870
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-hashtags-tag-posts
|
|
32852
32871
|
* @example
|
|
32853
32872
|
* ```ts
|
|
32854
|
-
* for await (const post of social.community("
|
|
32873
|
+
* for await (const post of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").hashtags.posts.list("launch")) {
|
|
32855
32874
|
* console.log(post);
|
|
32856
32875
|
* }
|
|
32857
|
-
* const page = await social.community("
|
|
32876
|
+
* const page = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").hashtags.posts.list("launch", {}, { timeout: 5_000 });
|
|
32858
32877
|
* ```
|
|
32859
32878
|
*/
|
|
32860
32879
|
list(tag: string, params?: HashtagPostListParams, options?: RequestOptions): PagePromise<Post>;
|
|
@@ -32876,10 +32895,10 @@ declare class CommunityHashtagsResource extends APIResource {
|
|
|
32876
32895
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-hashtags
|
|
32877
32896
|
* @example
|
|
32878
32897
|
* ```ts
|
|
32879
|
-
* for await (const hashtag of social.community("
|
|
32898
|
+
* for await (const hashtag of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").hashtags.list()) {
|
|
32880
32899
|
* console.log(hashtag);
|
|
32881
32900
|
* }
|
|
32882
|
-
* const page = await social.community("
|
|
32901
|
+
* const page = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").hashtags.list({}, { timeout: 5_000 });
|
|
32883
32902
|
* ```
|
|
32884
32903
|
*/
|
|
32885
32904
|
list(params?: HashtagListParams, options?: RequestOptions): PagePromise<Hashtag>;
|
|
@@ -32896,7 +32915,7 @@ declare class CommunityHashtagsResource extends APIResource {
|
|
|
32896
32915
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-hashtags-tag
|
|
32897
32916
|
* @example
|
|
32898
32917
|
* ```ts
|
|
32899
|
-
* const hashtagDetail = await social.community("
|
|
32918
|
+
* const hashtagDetail = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").hashtags.retrieve("launch");
|
|
32900
32919
|
* ```
|
|
32901
32920
|
*/
|
|
32902
32921
|
retrieve(tag: string, options?: RequestOptions): APIPromise<WithLastResponse<HashtagDetail>>;
|
|
@@ -32915,7 +32934,7 @@ declare class CommunityHidesResource extends APIResource {
|
|
|
32915
32934
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-hides
|
|
32916
32935
|
* @example
|
|
32917
32936
|
* ```ts
|
|
32918
|
-
* const hideResult = await social.community("
|
|
32937
|
+
* const hideResult = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").hides.create({ post_id: "bbbbbbbb-0000-0000-0000-000000000001" });
|
|
32919
32938
|
* ```
|
|
32920
32939
|
*/
|
|
32921
32940
|
create(params: WithOptionalActor<HideCreateParams>, options?: RequestOptions): APIPromise<WithLastResponse<HideResult>>;
|
|
@@ -32930,7 +32949,7 @@ declare class CommunityHidesResource extends APIResource {
|
|
|
32930
32949
|
* @see https://productcraft.co/docs/social/api-reference#delete-v1-communities-community-id-hides-src-actor-id-post-id
|
|
32931
32950
|
* @example
|
|
32932
32951
|
* ```ts
|
|
32933
|
-
* await social.community("
|
|
32952
|
+
* await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").hides.delete("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
32934
32953
|
* ```
|
|
32935
32954
|
*/
|
|
32936
32955
|
delete(srcActorId: string, postId: string, options?: RequestOptions): APIPromise<void>;
|
|
@@ -32951,7 +32970,7 @@ declare class CommunityListsFeedResource extends APIResource {
|
|
|
32951
32970
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-lists-list-id-feed
|
|
32952
32971
|
* @example
|
|
32953
32972
|
* ```ts
|
|
32954
|
-
* for await (const feed of social.community("
|
|
32973
|
+
* for await (const feed of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").lists.feed.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {})) {
|
|
32955
32974
|
* console.log(feed);
|
|
32956
32975
|
* }
|
|
32957
32976
|
* ```
|
|
@@ -32974,7 +32993,7 @@ declare class CommunityListsMembersResource extends APIResource {
|
|
|
32974
32993
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-lists-list-id-members
|
|
32975
32994
|
* @example
|
|
32976
32995
|
* ```ts
|
|
32977
|
-
* const actorListMember = await social.community("
|
|
32996
|
+
* const actorListMember = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").lists.members.create("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {});
|
|
32978
32997
|
* ```
|
|
32979
32998
|
*/
|
|
32980
32999
|
create(listId: string, params?: WithOptionalActor<ListMemberCreateParams>, options?: RequestOptions): APIPromise<WithLastResponse<ActorListMember>>;
|
|
@@ -32993,7 +33012,7 @@ declare class CommunityListsMembersResource extends APIResource {
|
|
|
32993
33012
|
* @see https://productcraft.co/docs/social/api-reference#delete-v1-communities-community-id-lists-list-id-members-member-actor-id
|
|
32994
33013
|
* @example
|
|
32995
33014
|
* ```ts
|
|
32996
|
-
* await social.community("
|
|
33015
|
+
* await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").lists.members.delete("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {});
|
|
32997
33016
|
* ```
|
|
32998
33017
|
*/
|
|
32999
33018
|
delete(listId: string, memberActorId: string, params?: WithOptionalActor<ListMemberDeleteParams>, options?: RequestOptions): APIPromise<void>;
|
|
@@ -33010,10 +33029,10 @@ declare class CommunityListsMembersResource extends APIResource {
|
|
|
33010
33029
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-lists-list-id-members
|
|
33011
33030
|
* @example
|
|
33012
33031
|
* ```ts
|
|
33013
|
-
* for await (const member of social.community("
|
|
33032
|
+
* for await (const member of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").lists.members.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f")) {
|
|
33014
33033
|
* console.log(member);
|
|
33015
33034
|
* }
|
|
33016
|
-
* const page = await social.community("
|
|
33035
|
+
* const page = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").lists.members.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {}, { timeout: 5_000 });
|
|
33017
33036
|
* ```
|
|
33018
33037
|
*/
|
|
33019
33038
|
list(listId: string, params?: WithOptionalActor<ListMemberListParams>, options?: RequestOptions): PagePromise<ActorListMember>;
|
|
@@ -33037,7 +33056,7 @@ declare class CommunityListsResource extends APIResource {
|
|
|
33037
33056
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-lists
|
|
33038
33057
|
* @example
|
|
33039
33058
|
* ```ts
|
|
33040
|
-
* const actorList = await social.community("
|
|
33059
|
+
* const actorList = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").lists.create({ name: "Tech news" });
|
|
33041
33060
|
* ```
|
|
33042
33061
|
*/
|
|
33043
33062
|
create(params: WithOptionalActor<ListCreateParams>, options?: RequestOptions): APIPromise<WithLastResponse<ActorList>>;
|
|
@@ -33055,7 +33074,7 @@ declare class CommunityListsResource extends APIResource {
|
|
|
33055
33074
|
* @see https://productcraft.co/docs/social/api-reference#delete-v1-communities-community-id-lists-list-id
|
|
33056
33075
|
* @example
|
|
33057
33076
|
* ```ts
|
|
33058
|
-
* await social.community("
|
|
33077
|
+
* await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").lists.delete("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {});
|
|
33059
33078
|
* ```
|
|
33060
33079
|
*/
|
|
33061
33080
|
delete(listId: string, params?: WithOptionalActor<ListDeleteParams>, options?: RequestOptions): APIPromise<void>;
|
|
@@ -33070,10 +33089,10 @@ declare class CommunityListsResource extends APIResource {
|
|
|
33070
33089
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-lists
|
|
33071
33090
|
* @example
|
|
33072
33091
|
* ```ts
|
|
33073
|
-
* for await (const list of social.community("
|
|
33092
|
+
* for await (const list of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").lists.list()) {
|
|
33074
33093
|
* console.log(list);
|
|
33075
33094
|
* }
|
|
33076
|
-
* const page = await social.community("
|
|
33095
|
+
* const page = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").lists.list({}, { timeout: 5_000 });
|
|
33077
33096
|
* ```
|
|
33078
33097
|
*/
|
|
33079
33098
|
list(params?: WithOptionalActor<ListListParams>, options?: RequestOptions): PagePromise<ActorList>;
|
|
@@ -33090,7 +33109,7 @@ declare class CommunityListsResource extends APIResource {
|
|
|
33090
33109
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-lists-list-id
|
|
33091
33110
|
* @example
|
|
33092
33111
|
* ```ts
|
|
33093
|
-
* const actorList = await social.community("
|
|
33112
|
+
* const actorList = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").lists.retrieve("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
33094
33113
|
* ```
|
|
33095
33114
|
*/
|
|
33096
33115
|
retrieve(listId: string, params?: WithOptionalActor<ListRetrieveParams>, options?: RequestOptions): APIPromise<WithLastResponse<ActorList>>;
|
|
@@ -33108,7 +33127,7 @@ declare class CommunityListsResource extends APIResource {
|
|
|
33108
33127
|
* @see https://productcraft.co/docs/social/api-reference#patch-v1-communities-community-id-lists-list-id
|
|
33109
33128
|
* @example
|
|
33110
33129
|
* ```ts
|
|
33111
|
-
* const actorList = await social.community("
|
|
33130
|
+
* const actorList = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").lists.update("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
33112
33131
|
* ```
|
|
33113
33132
|
*/
|
|
33114
33133
|
update(listId: string, params?: WithOptionalActor<ListUpdateParams>, options?: RequestOptions): APIPromise<WithLastResponse<ActorList>>;
|
|
@@ -33130,7 +33149,7 @@ declare class CommunityMutesResource extends APIResource {
|
|
|
33130
33149
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-mutes
|
|
33131
33150
|
* @example
|
|
33132
33151
|
* ```ts
|
|
33133
|
-
* const createEdge = await social.community("
|
|
33152
|
+
* const createEdge = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").mutes.create({ dst_actor_id: "aaaaaaaa-0000-0000-0000-000000000002" });
|
|
33134
33153
|
* ```
|
|
33135
33154
|
*/
|
|
33136
33155
|
create(params: WithOptionalActor<MuteCreateParams>, options?: RequestOptions): APIPromise<WithLastResponse<CreateEdge>>;
|
|
@@ -33147,7 +33166,7 @@ declare class CommunityMutesResource extends APIResource {
|
|
|
33147
33166
|
* @see https://productcraft.co/docs/social/api-reference#delete-v1-communities-community-id-mutes-src-actor-id-dst-actor-id
|
|
33148
33167
|
* @example
|
|
33149
33168
|
* ```ts
|
|
33150
|
-
* await social.community("
|
|
33169
|
+
* await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").mutes.delete("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
33151
33170
|
* ```
|
|
33152
33171
|
*/
|
|
33153
33172
|
delete(srcActorId: string, dstActorId: string, options?: RequestOptions): APIPromise<void>;
|
|
@@ -33170,7 +33189,7 @@ declare class CommunityPostsCommentsReactionsResource extends APIResource {
|
|
|
33170
33189
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-posts-post-id-comments-comment-id-reactions
|
|
33171
33190
|
* @example
|
|
33172
33191
|
* ```ts
|
|
33173
|
-
* const addCommentReaction = await social.community("
|
|
33192
|
+
* const addCommentReaction = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").posts.comments.reactions.create("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", { type: "like" });
|
|
33174
33193
|
* ```
|
|
33175
33194
|
*/
|
|
33176
33195
|
create(postId: string, commentId: string, params: WithOptionalActor<PostCommentReactionCreateParams>, options?: RequestOptions): APIPromise<WithLastResponse<AddCommentReaction>>;
|
|
@@ -33190,7 +33209,7 @@ declare class CommunityPostsCommentsReactionsResource extends APIResource {
|
|
|
33190
33209
|
* @see https://productcraft.co/docs/social/api-reference#delete-v1-communities-community-id-posts-post-id-comments-comment-id-reactions-src-actor-id-type
|
|
33191
33210
|
* @example
|
|
33192
33211
|
* ```ts
|
|
33193
|
-
* const commentReactionCounts = await social.community("
|
|
33212
|
+
* const commentReactionCounts = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").posts.comments.reactions.delete("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "like");
|
|
33194
33213
|
* ```
|
|
33195
33214
|
*/
|
|
33196
33215
|
delete(postId: string, commentId: string, srcActorId: string, type: string, options?: RequestOptions): APIPromise<WithLastResponse<CommentReactionCounts>>;
|
|
@@ -33208,10 +33227,10 @@ declare class CommunityPostsCommentsReactionsResource extends APIResource {
|
|
|
33208
33227
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-posts-post-id-comments-comment-id-reactions
|
|
33209
33228
|
* @example
|
|
33210
33229
|
* ```ts
|
|
33211
|
-
* for await (const reaction of social.community("
|
|
33230
|
+
* for await (const reaction of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").posts.comments.reactions.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f")) {
|
|
33212
33231
|
* console.log(reaction);
|
|
33213
33232
|
* }
|
|
33214
|
-
* const page = await social.community("
|
|
33233
|
+
* const page = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").posts.comments.reactions.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {}, { timeout: 5_000 });
|
|
33215
33234
|
* ```
|
|
33216
33235
|
*/
|
|
33217
33236
|
list(postId: string, commentId: string, params?: PostCommentReactionListParams, options?: RequestOptions): PagePromise<CommentReactionEntry>;
|
|
@@ -33236,7 +33255,7 @@ declare class CommunityPostsCommentsResource extends APIResource {
|
|
|
33236
33255
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-posts-post-id-comments-comment-id-approve
|
|
33237
33256
|
* @example
|
|
33238
33257
|
* ```ts
|
|
33239
|
-
* const comment = await social.community("
|
|
33258
|
+
* const comment = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").posts.comments.approve("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
33240
33259
|
* ```
|
|
33241
33260
|
*/
|
|
33242
33261
|
approve(postId: string, commentId: string, params?: WithOptionalActor<PostCommentApproveParams>, options?: RequestOptions): APIPromise<WithLastResponse<Comment>>;
|
|
@@ -33255,7 +33274,7 @@ declare class CommunityPostsCommentsResource extends APIResource {
|
|
|
33255
33274
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-posts-post-id-comments
|
|
33256
33275
|
* @example
|
|
33257
33276
|
* ```ts
|
|
33258
|
-
* const comment = await social.community("
|
|
33277
|
+
* const comment = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").posts.comments.create("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", { body: "Looks great, shipping today." });
|
|
33259
33278
|
* ```
|
|
33260
33279
|
*/
|
|
33261
33280
|
create(postId: string, params: WithOptionalActor<PostCommentCreateParams>, options?: RequestOptions): APIPromise<WithLastResponse<Comment>>;
|
|
@@ -33272,7 +33291,7 @@ declare class CommunityPostsCommentsResource extends APIResource {
|
|
|
33272
33291
|
* @see https://productcraft.co/docs/social/api-reference#delete-v1-communities-community-id-posts-post-id-comments-comment-id
|
|
33273
33292
|
* @example
|
|
33274
33293
|
* ```ts
|
|
33275
|
-
* await social.community("
|
|
33294
|
+
* await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").posts.comments.delete("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
33276
33295
|
* ```
|
|
33277
33296
|
*/
|
|
33278
33297
|
delete(postId: string, commentId: string, options?: RequestOptions): APIPromise<void>;
|
|
@@ -33289,10 +33308,10 @@ declare class CommunityPostsCommentsResource extends APIResource {
|
|
|
33289
33308
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-posts-post-id-comments
|
|
33290
33309
|
* @example
|
|
33291
33310
|
* ```ts
|
|
33292
|
-
* for await (const comment of social.community("
|
|
33311
|
+
* for await (const comment of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").posts.comments.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f")) {
|
|
33293
33312
|
* console.log(comment);
|
|
33294
33313
|
* }
|
|
33295
|
-
* const page = await social.community("
|
|
33314
|
+
* const page = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").posts.comments.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {}, { timeout: 5_000 });
|
|
33296
33315
|
* ```
|
|
33297
33316
|
*/
|
|
33298
33317
|
list(postId: string, params?: WithOptionalActor<PostCommentListParams>, options?: RequestOptions): PagePromise<Comment>;
|
|
@@ -33313,7 +33332,7 @@ declare class CommunityPostsCommentsResource extends APIResource {
|
|
|
33313
33332
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-posts-post-id-comments-comment-id-pin
|
|
33314
33333
|
* @example
|
|
33315
33334
|
* ```ts
|
|
33316
|
-
* const comment = await social.community("
|
|
33335
|
+
* const comment = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").posts.comments.pin("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {});
|
|
33317
33336
|
* ```
|
|
33318
33337
|
*/
|
|
33319
33338
|
pin(postId: string, commentId: string, params?: WithOptionalActor<PostCommentPinParams>, options?: RequestOptions): APIPromise<WithLastResponse<Comment>>;
|
|
@@ -33331,7 +33350,7 @@ declare class CommunityPostsCommentsResource extends APIResource {
|
|
|
33331
33350
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-posts-post-id-comments-comment-id
|
|
33332
33351
|
* @example
|
|
33333
33352
|
* ```ts
|
|
33334
|
-
* const comment = await social.community("
|
|
33353
|
+
* const comment = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").posts.comments.retrieve("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
33335
33354
|
* ```
|
|
33336
33355
|
*/
|
|
33337
33356
|
retrieve(postId: string, commentId: string, params?: WithOptionalActor<PostCommentRetrieveParams>, options?: RequestOptions): APIPromise<WithLastResponse<Comment>>;
|
|
@@ -33351,7 +33370,7 @@ declare class CommunityPostsCommentsResource extends APIResource {
|
|
|
33351
33370
|
* @see https://productcraft.co/docs/social/api-reference#delete-v1-communities-community-id-posts-post-id-comments-comment-id-pin
|
|
33352
33371
|
* @example
|
|
33353
33372
|
* ```ts
|
|
33354
|
-
* const comment = await social.community("
|
|
33373
|
+
* const comment = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").posts.comments.unpin("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {});
|
|
33355
33374
|
* ```
|
|
33356
33375
|
*/
|
|
33357
33376
|
unpin(postId: string, commentId: string, params?: WithOptionalActor<PostCommentUnpinParams>, options?: RequestOptions): APIPromise<WithLastResponse<Comment>>;
|
|
@@ -33370,7 +33389,7 @@ declare class CommunityPostsCommentsResource extends APIResource {
|
|
|
33370
33389
|
* @see https://productcraft.co/docs/social/api-reference#patch-v1-communities-community-id-posts-post-id-comments-comment-id
|
|
33371
33390
|
* @example
|
|
33372
33391
|
* ```ts
|
|
33373
|
-
* const comment = await social.community("
|
|
33392
|
+
* const comment = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").posts.comments.update("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", { body: "string" });
|
|
33374
33393
|
* ```
|
|
33375
33394
|
*/
|
|
33376
33395
|
update(postId: string, commentId: string, params?: PostCommentUpdateParams, options?: RequestOptions): APIPromise<WithLastResponse<Comment>>;
|
|
@@ -33392,10 +33411,10 @@ declare class CommunityPostsQuotesResource extends APIResource {
|
|
|
33392
33411
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-posts-post-id-quotes
|
|
33393
33412
|
* @example
|
|
33394
33413
|
* ```ts
|
|
33395
|
-
* for await (const quote of social.community("
|
|
33414
|
+
* for await (const quote of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").posts.quotes.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f")) {
|
|
33396
33415
|
* console.log(quote);
|
|
33397
33416
|
* }
|
|
33398
|
-
* const page = await social.community("
|
|
33417
|
+
* const page = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").posts.quotes.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {}, { timeout: 5_000 });
|
|
33399
33418
|
* ```
|
|
33400
33419
|
*/
|
|
33401
33420
|
list(postId: string, params?: PostQuoteListParams, options?: RequestOptions): PagePromise<Post>;
|
|
@@ -33417,7 +33436,7 @@ declare class CommunityPostsReactionsResource extends APIResource {
|
|
|
33417
33436
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-posts-post-id-reactions
|
|
33418
33437
|
* @example
|
|
33419
33438
|
* ```ts
|
|
33420
|
-
* const reaction = await social.community("
|
|
33439
|
+
* const reaction = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").posts.reactions.create("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", { type: "like" });
|
|
33421
33440
|
* ```
|
|
33422
33441
|
*/
|
|
33423
33442
|
create(postId: string, params: WithOptionalActor<PostReactionCreateParams>, options?: RequestOptions): APIPromise<WithLastResponse<Reaction>>;
|
|
@@ -33436,7 +33455,7 @@ declare class CommunityPostsReactionsResource extends APIResource {
|
|
|
33436
33455
|
* @see https://productcraft.co/docs/social/api-reference#delete-v1-communities-community-id-posts-post-id-reactions-src-actor-id-type
|
|
33437
33456
|
* @example
|
|
33438
33457
|
* ```ts
|
|
33439
|
-
* const reactionCounts = await social.community("
|
|
33458
|
+
* const reactionCounts = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").posts.reactions.delete("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "like");
|
|
33440
33459
|
* ```
|
|
33441
33460
|
*/
|
|
33442
33461
|
delete(postId: string, srcActorId: string, type: string, options?: RequestOptions): APIPromise<WithLastResponse<ReactionCounts>>;
|
|
@@ -33454,10 +33473,10 @@ declare class CommunityPostsReactionsResource extends APIResource {
|
|
|
33454
33473
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-posts-post-id-reactions
|
|
33455
33474
|
* @example
|
|
33456
33475
|
* ```ts
|
|
33457
|
-
* for await (const reaction of social.community("
|
|
33476
|
+
* for await (const reaction of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").posts.reactions.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f")) {
|
|
33458
33477
|
* console.log(reaction);
|
|
33459
33478
|
* }
|
|
33460
|
-
* const page = await social.community("
|
|
33479
|
+
* const page = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").posts.reactions.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {}, { timeout: 5_000 });
|
|
33461
33480
|
* ```
|
|
33462
33481
|
*/
|
|
33463
33482
|
list(postId: string, params?: PostReactionListParams, options?: RequestOptions): PagePromise<PostReactionEntry>;
|
|
@@ -33477,10 +33496,10 @@ declare class CommunityPostsRepostsResource extends APIResource {
|
|
|
33477
33496
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-posts-post-id-reposts
|
|
33478
33497
|
* @example
|
|
33479
33498
|
* ```ts
|
|
33480
|
-
* for await (const repost of social.community("
|
|
33499
|
+
* for await (const repost of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").posts.reposts.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f")) {
|
|
33481
33500
|
* console.log(repost);
|
|
33482
33501
|
* }
|
|
33483
|
-
* const page = await social.community("
|
|
33502
|
+
* const page = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").posts.reposts.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {}, { timeout: 5_000 });
|
|
33484
33503
|
* ```
|
|
33485
33504
|
*/
|
|
33486
33505
|
list(postId: string, params?: PostRepostListParams, options?: RequestOptions): PagePromise<Post>;
|
|
@@ -33502,10 +33521,10 @@ declare class CommunityPostsRevisionsResource extends APIResource {
|
|
|
33502
33521
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-posts-post-id-revisions
|
|
33503
33522
|
* @example
|
|
33504
33523
|
* ```ts
|
|
33505
|
-
* for await (const revision of social.community("
|
|
33524
|
+
* for await (const revision of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").posts.revisions.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f")) {
|
|
33506
33525
|
* console.log(revision);
|
|
33507
33526
|
* }
|
|
33508
|
-
* const page = await social.community("
|
|
33527
|
+
* const page = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").posts.revisions.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {}, { timeout: 5_000 });
|
|
33509
33528
|
* ```
|
|
33510
33529
|
*/
|
|
33511
33530
|
list(postId: string, params?: PostRevisionListParams, options?: RequestOptions): PagePromise<PostRevision>;
|
|
@@ -33529,7 +33548,7 @@ declare class CommunityPostsTagsResource extends APIResource {
|
|
|
33529
33548
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-posts-post-id-tags-tagged-actor-id-approve
|
|
33530
33549
|
* @example
|
|
33531
33550
|
* ```ts
|
|
33532
|
-
* const postTag = await social.community("
|
|
33551
|
+
* const postTag = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").posts.tags.approve("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {});
|
|
33533
33552
|
* ```
|
|
33534
33553
|
*/
|
|
33535
33554
|
approve(postId: string, taggedActorId: string, params?: WithOptionalActor<PostTagApproveParams>, options?: RequestOptions): APIPromise<WithLastResponse<PostTag>>;
|
|
@@ -33549,7 +33568,7 @@ declare class CommunityPostsTagsResource extends APIResource {
|
|
|
33549
33568
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-posts-post-id-tags-tagged-actor-id-remove
|
|
33550
33569
|
* @example
|
|
33551
33570
|
* ```ts
|
|
33552
|
-
* const postTag = await social.community("
|
|
33571
|
+
* const postTag = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").posts.tags.delete("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {});
|
|
33553
33572
|
* ```
|
|
33554
33573
|
*/
|
|
33555
33574
|
delete(postId: string, taggedActorId: string, params?: WithOptionalActor<PostTagDeleteParams>, options?: RequestOptions): APIPromise<WithLastResponse<PostTag>>;
|
|
@@ -33572,7 +33591,7 @@ declare class CommunityPostsViewersResource extends APIResource {
|
|
|
33572
33591
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-posts-post-id-viewers
|
|
33573
33592
|
* @example
|
|
33574
33593
|
* ```ts
|
|
33575
|
-
* for await (const viewer of social.community("
|
|
33594
|
+
* for await (const viewer of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").posts.viewers.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {})) {
|
|
33576
33595
|
* console.log(viewer);
|
|
33577
33596
|
* }
|
|
33578
33597
|
* ```
|
|
@@ -33597,7 +33616,7 @@ declare class CommunityPostsVotersResource extends APIResource {
|
|
|
33597
33616
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-posts-post-id-voters
|
|
33598
33617
|
* @example
|
|
33599
33618
|
* ```ts
|
|
33600
|
-
* for await (const voter of social.community("
|
|
33619
|
+
* for await (const voter of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").posts.voters.list("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {})) {
|
|
33601
33620
|
* console.log(voter);
|
|
33602
33621
|
* }
|
|
33603
33622
|
* ```
|
|
@@ -33624,7 +33643,7 @@ declare class CommunityPostsVotesResource extends APIResource {
|
|
|
33624
33643
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-posts-post-id-votes
|
|
33625
33644
|
* @example
|
|
33626
33645
|
* ```ts
|
|
33627
|
-
* await social.community("
|
|
33646
|
+
* await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").posts.votes.create("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", { option_index: 1 });
|
|
33628
33647
|
* ```
|
|
33629
33648
|
*/
|
|
33630
33649
|
create(postId: string, params: WithOptionalActor<PostVoteCreateParams>, options?: RequestOptions): APIPromise<void>;
|
|
@@ -33643,7 +33662,7 @@ declare class CommunityPostsVotesResource extends APIResource {
|
|
|
33643
33662
|
* @see https://productcraft.co/docs/social/api-reference#delete-v1-communities-community-id-posts-post-id-votes-actor-id
|
|
33644
33663
|
* @example
|
|
33645
33664
|
* ```ts
|
|
33646
|
-
* await social.community("
|
|
33665
|
+
* await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").posts.votes.delete("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
33647
33666
|
* ```
|
|
33648
33667
|
*/
|
|
33649
33668
|
delete(postId: string, actorId: string, options?: RequestOptions): APIPromise<void>;
|
|
@@ -33662,7 +33681,7 @@ declare class CommunityPostsVotesResource extends APIResource {
|
|
|
33662
33681
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-posts-post-id-votes-actor-id
|
|
33663
33682
|
* @example
|
|
33664
33683
|
* ```ts
|
|
33665
|
-
* const result = await social.community("
|
|
33684
|
+
* const result = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").posts.votes.retrieve("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
33666
33685
|
* ```
|
|
33667
33686
|
*/
|
|
33668
33687
|
retrieve(postId: string, actorId: string, options?: RequestOptions): APIPromise<WithLastResponse<PollVoteResponse>>;
|
|
@@ -33695,7 +33714,7 @@ declare class CommunityPostsResource extends APIResource {
|
|
|
33695
33714
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-posts-post-id-bookmark
|
|
33696
33715
|
* @example
|
|
33697
33716
|
* ```ts
|
|
33698
|
-
* const bookmarkToggle = await social.community("
|
|
33717
|
+
* const bookmarkToggle = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").posts.bookmark("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {});
|
|
33699
33718
|
* ```
|
|
33700
33719
|
*/
|
|
33701
33720
|
bookmark(postId: string, params?: WithOptionalActor<PostBookmarkParams>, options?: RequestOptions): APIPromise<WithLastResponse<BookmarkToggle>>;
|
|
@@ -33714,7 +33733,7 @@ declare class CommunityPostsResource extends APIResource {
|
|
|
33714
33733
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-posts
|
|
33715
33734
|
* @example
|
|
33716
33735
|
* ```ts
|
|
33717
|
-
* const post = await social.community("
|
|
33736
|
+
* const post = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").posts.create({});
|
|
33718
33737
|
* ```
|
|
33719
33738
|
*/
|
|
33720
33739
|
create(params?: WithOptionalActor<PostCreateParams>, options?: RequestOptions): APIPromise<WithLastResponse<Post>>;
|
|
@@ -33730,7 +33749,7 @@ declare class CommunityPostsResource extends APIResource {
|
|
|
33730
33749
|
* @see https://productcraft.co/docs/social/api-reference#delete-v1-communities-community-id-posts-post-id
|
|
33731
33750
|
* @example
|
|
33732
33751
|
* ```ts
|
|
33733
|
-
* await social.community("
|
|
33752
|
+
* await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").posts.delete("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
33734
33753
|
* ```
|
|
33735
33754
|
*/
|
|
33736
33755
|
delete(postId: string, options?: RequestOptions): APIPromise<void>;
|
|
@@ -33748,7 +33767,7 @@ declare class CommunityPostsResource extends APIResource {
|
|
|
33748
33767
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-posts-post-id-insights
|
|
33749
33768
|
* @example
|
|
33750
33769
|
* ```ts
|
|
33751
|
-
* const postInsights = await social.community("
|
|
33770
|
+
* const postInsights = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").posts.insights("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
33752
33771
|
* ```
|
|
33753
33772
|
*/
|
|
33754
33773
|
insights(postId: string, params?: PostInsightsParams, options?: RequestOptions): APIPromise<WithLastResponse<PostInsights>>;
|
|
@@ -33764,10 +33783,10 @@ declare class CommunityPostsResource extends APIResource {
|
|
|
33764
33783
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-posts
|
|
33765
33784
|
* @example
|
|
33766
33785
|
* ```ts
|
|
33767
|
-
* for await (const post of social.community("
|
|
33786
|
+
* for await (const post of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").posts.list()) {
|
|
33768
33787
|
* console.log(post);
|
|
33769
33788
|
* }
|
|
33770
|
-
* const page = await social.community("
|
|
33789
|
+
* const page = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").posts.list({}, { timeout: 5_000 });
|
|
33771
33790
|
* ```
|
|
33772
33791
|
*/
|
|
33773
33792
|
list(params?: PostListParams, options?: RequestOptions): PagePromise<Post>;
|
|
@@ -33786,7 +33805,7 @@ declare class CommunityPostsResource extends APIResource {
|
|
|
33786
33805
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-posts-post-id-poll-results
|
|
33787
33806
|
* @example
|
|
33788
33807
|
* ```ts
|
|
33789
|
-
* const result = await social.community("
|
|
33808
|
+
* const result = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").posts.pollResults("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
33790
33809
|
* ```
|
|
33791
33810
|
*/
|
|
33792
33811
|
pollResults(postId: string, options?: RequestOptions): APIPromise<WithLastResponse<PollResultsResponse>>;
|
|
@@ -33802,7 +33821,7 @@ declare class CommunityPostsResource extends APIResource {
|
|
|
33802
33821
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-posts-impressions
|
|
33803
33822
|
* @example
|
|
33804
33823
|
* ```ts
|
|
33805
|
-
* await social.community("
|
|
33824
|
+
* await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").posts.recordImpressions({
|
|
33806
33825
|
* post_ids: ["bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb", "cccccccc-cccc-cccc-cccc-cccccccccccc"],
|
|
33807
33826
|
* });
|
|
33808
33827
|
* ```
|
|
@@ -33825,7 +33844,7 @@ declare class CommunityPostsResource extends APIResource {
|
|
|
33825
33844
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-posts-post-id-views
|
|
33826
33845
|
* @example
|
|
33827
33846
|
* ```ts
|
|
33828
|
-
* await social.community("
|
|
33847
|
+
* await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").posts.recordView("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {});
|
|
33829
33848
|
* ```
|
|
33830
33849
|
*/
|
|
33831
33850
|
recordView(postId: string, params?: WithOptionalActor<PostRecordViewParams>, options?: RequestOptions): APIPromise<void>;
|
|
@@ -33846,7 +33865,7 @@ declare class CommunityPostsResource extends APIResource {
|
|
|
33846
33865
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-posts-post-id-repost
|
|
33847
33866
|
* @example
|
|
33848
33867
|
* ```ts
|
|
33849
|
-
* const createRepost = await social.community("
|
|
33868
|
+
* const createRepost = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").posts.repost("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {});
|
|
33850
33869
|
* ```
|
|
33851
33870
|
*/
|
|
33852
33871
|
repost(postId: string, params?: WithOptionalActor<PostRepostParams>, options?: RequestOptions): APIPromise<WithLastResponse<CreateRepost>>;
|
|
@@ -33865,7 +33884,7 @@ declare class CommunityPostsResource extends APIResource {
|
|
|
33865
33884
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-posts-post-id
|
|
33866
33885
|
* @example
|
|
33867
33886
|
* ```ts
|
|
33868
|
-
* const post = await social.community("
|
|
33887
|
+
* const post = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").posts.retrieve("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
33869
33888
|
* ```
|
|
33870
33889
|
*/
|
|
33871
33890
|
retrieve(postId: string, params?: WithOptionalActor<PostRetrieveParams>, options?: RequestOptions): APIPromise<WithLastResponse<Post>>;
|
|
@@ -33883,7 +33902,7 @@ declare class CommunityPostsResource extends APIResource {
|
|
|
33883
33902
|
* @see https://productcraft.co/docs/social/api-reference#delete-v1-communities-community-id-posts-post-id-bookmark
|
|
33884
33903
|
* @example
|
|
33885
33904
|
* ```ts
|
|
33886
|
-
* await social.community("
|
|
33905
|
+
* await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").posts.unbookmark("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {});
|
|
33887
33906
|
* ```
|
|
33888
33907
|
*/
|
|
33889
33908
|
unbookmark(postId: string, params?: WithOptionalActor<PostUnbookmarkParams>, options?: RequestOptions): APIPromise<void>;
|
|
@@ -33901,7 +33920,7 @@ declare class CommunityPostsResource extends APIResource {
|
|
|
33901
33920
|
* @see https://productcraft.co/docs/social/api-reference#delete-v1-communities-community-id-posts-post-id-repost
|
|
33902
33921
|
* @example
|
|
33903
33922
|
* ```ts
|
|
33904
|
-
* await social.community("
|
|
33923
|
+
* await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").posts.unrepost("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", {});
|
|
33905
33924
|
* ```
|
|
33906
33925
|
*/
|
|
33907
33926
|
unrepost(postId: string, params?: WithOptionalActor<PostUnrepostParams>, options?: RequestOptions): APIPromise<void>;
|
|
@@ -33920,7 +33939,7 @@ declare class CommunityPostsResource extends APIResource {
|
|
|
33920
33939
|
* @see https://productcraft.co/docs/social/api-reference#patch-v1-communities-community-id-posts-post-id
|
|
33921
33940
|
* @example
|
|
33922
33941
|
* ```ts
|
|
33923
|
-
* const post = await social.community("
|
|
33942
|
+
* const post = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").posts.update("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", { attributes: {} });
|
|
33924
33943
|
* ```
|
|
33925
33944
|
*/
|
|
33926
33945
|
update(postId: string, params?: PostUpdateParams, options?: RequestOptions): APIPromise<WithLastResponse<Post>>;
|
|
@@ -33942,7 +33961,7 @@ declare class CommunityRestrictsResource extends APIResource {
|
|
|
33942
33961
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-restricts
|
|
33943
33962
|
* @example
|
|
33944
33963
|
* ```ts
|
|
33945
|
-
* const createEdge = await social.community("
|
|
33964
|
+
* const createEdge = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").restricts.create({ dst_actor_id: "aaaaaaaa-0000-0000-0000-000000000002" });
|
|
33946
33965
|
* ```
|
|
33947
33966
|
*/
|
|
33948
33967
|
create(params: WithOptionalActor<RestrictCreateParams>, options?: RequestOptions): APIPromise<WithLastResponse<CreateEdge>>;
|
|
@@ -33959,7 +33978,7 @@ declare class CommunityRestrictsResource extends APIResource {
|
|
|
33959
33978
|
* @see https://productcraft.co/docs/social/api-reference#delete-v1-communities-community-id-restricts-src-actor-id-dst-actor-id
|
|
33960
33979
|
* @example
|
|
33961
33980
|
* ```ts
|
|
33962
|
-
* await social.community("
|
|
33981
|
+
* await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").restricts.delete("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
33963
33982
|
* ```
|
|
33964
33983
|
*/
|
|
33965
33984
|
delete(srcActorId: string, dstActorId: string, options?: RequestOptions): APIPromise<void>;
|
|
@@ -33981,7 +34000,7 @@ declare class CommunitySearchActorsResource extends APIResource {
|
|
|
33981
34000
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-search-actors
|
|
33982
34001
|
* @example
|
|
33983
34002
|
* ```ts
|
|
33984
|
-
* for await (const actor of social.community("
|
|
34003
|
+
* for await (const actor of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").search.actors.list({ q: "onboarding" })) {
|
|
33985
34004
|
* console.log(actor);
|
|
33986
34005
|
* }
|
|
33987
34006
|
* ```
|
|
@@ -34005,7 +34024,7 @@ declare class CommunitySearchHashtagsResource extends APIResource {
|
|
|
34005
34024
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-search-hashtags
|
|
34006
34025
|
* @example
|
|
34007
34026
|
* ```ts
|
|
34008
|
-
* for await (const hashtag of social.community("
|
|
34027
|
+
* for await (const hashtag of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").search.hashtags.list({ q: "onboarding" })) {
|
|
34009
34028
|
* console.log(hashtag);
|
|
34010
34029
|
* }
|
|
34011
34030
|
* ```
|
|
@@ -34029,7 +34048,7 @@ declare class CommunitySearchPostsResource extends APIResource {
|
|
|
34029
34048
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-search-posts
|
|
34030
34049
|
* @example
|
|
34031
34050
|
* ```ts
|
|
34032
|
-
* for await (const post of social.community("
|
|
34051
|
+
* for await (const post of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").search.posts.list({ q: "onboarding" })) {
|
|
34033
34052
|
* console.log(post);
|
|
34034
34053
|
* }
|
|
34035
34054
|
* ```
|
|
@@ -34063,7 +34082,7 @@ declare class CommunityWebhooksEndpointsResource extends APIResource {
|
|
|
34063
34082
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-webhooks-endpoints
|
|
34064
34083
|
* @example
|
|
34065
34084
|
* ```ts
|
|
34066
|
-
* const webhookEndpointWithSecret = await social.community("
|
|
34085
|
+
* const webhookEndpointWithSecret = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").webhooks.endpoints.create({ url: "https://api.acme.com/webhooks" });
|
|
34067
34086
|
* ```
|
|
34068
34087
|
*/
|
|
34069
34088
|
create(params: CommunityScopedWebhookEndpointCreateParams, options?: RequestOptions): APIPromise<WithLastResponse<WebhookEndpointWithSecret>>;
|
|
@@ -34083,7 +34102,7 @@ declare class CommunityWebhooksEndpointsResource extends APIResource {
|
|
|
34083
34102
|
* @see https://productcraft.co/docs/social/api-reference#delete-v1-communities-community-id-webhooks-endpoints-endpoint-id
|
|
34084
34103
|
* @example
|
|
34085
34104
|
* ```ts
|
|
34086
|
-
* await social.community("
|
|
34105
|
+
* await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").webhooks.endpoints.delete("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
34087
34106
|
* ```
|
|
34088
34107
|
*/
|
|
34089
34108
|
delete(endpointId: string, options?: RequestOptions): APIPromise<void>;
|
|
@@ -34102,7 +34121,7 @@ declare class CommunityWebhooksEndpointsResource extends APIResource {
|
|
|
34102
34121
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-webhooks-endpoints
|
|
34103
34122
|
* @example
|
|
34104
34123
|
* ```ts
|
|
34105
|
-
* for await (const endpoint of social.community("
|
|
34124
|
+
* for await (const endpoint of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").webhooks.endpoints.list()) {
|
|
34106
34125
|
* console.log(endpoint);
|
|
34107
34126
|
* }
|
|
34108
34127
|
* ```
|
|
@@ -34124,7 +34143,7 @@ declare class CommunityWebhooksEndpointsResource extends APIResource {
|
|
|
34124
34143
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-webhooks-endpoints-endpoint-id
|
|
34125
34144
|
* @example
|
|
34126
34145
|
* ```ts
|
|
34127
|
-
* const webhookEndpoint = await social.community("
|
|
34146
|
+
* const webhookEndpoint = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").webhooks.endpoints.retrieve("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
34128
34147
|
* ```
|
|
34129
34148
|
*/
|
|
34130
34149
|
retrieve(endpointId: string, options?: RequestOptions): APIPromise<WithLastResponse<WebhookEndpoint>>;
|
|
@@ -34146,7 +34165,7 @@ declare class CommunityWebhooksEndpointsResource extends APIResource {
|
|
|
34146
34165
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-webhooks-endpoints-endpoint-id-rotate-secret
|
|
34147
34166
|
* @example
|
|
34148
34167
|
* ```ts
|
|
34149
|
-
* const webhookEndpointWithSecret = await social.community("
|
|
34168
|
+
* const webhookEndpointWithSecret = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").webhooks.endpoints.rotateSecret("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", { grace_hours: 24 });
|
|
34150
34169
|
* ```
|
|
34151
34170
|
*/
|
|
34152
34171
|
rotateSecret(endpointId: string, params?: CommunityScopedWebhookEndpointRotateSecretParams, options?: RequestOptions): APIPromise<WithLastResponse<WebhookEndpointWithSecret>>;
|
|
@@ -34168,7 +34187,7 @@ declare class CommunityWebhooksEndpointsResource extends APIResource {
|
|
|
34168
34187
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-webhooks-endpoints-endpoint-id-test
|
|
34169
34188
|
* @example
|
|
34170
34189
|
* ```ts
|
|
34171
|
-
* const webhookDeliveryAttempt = await social.community("
|
|
34190
|
+
* const webhookDeliveryAttempt = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").webhooks.endpoints.test("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", { event_type: "post.created" });
|
|
34172
34191
|
* ```
|
|
34173
34192
|
*/
|
|
34174
34193
|
test(endpointId: string, params: CommunityScopedWebhookEndpointTestParams, options?: RequestOptions): APIPromise<WithLastResponse<WebhookDeliveryAttempt>>;
|
|
@@ -34191,7 +34210,7 @@ declare class CommunityWebhooksEndpointsResource extends APIResource {
|
|
|
34191
34210
|
* @see https://productcraft.co/docs/social/api-reference#patch-v1-communities-community-id-webhooks-endpoints-endpoint-id
|
|
34192
34211
|
* @example
|
|
34193
34212
|
* ```ts
|
|
34194
|
-
* const webhookEndpoint = await social.community("
|
|
34213
|
+
* const webhookEndpoint = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").webhooks.endpoints.update("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f", { description: "Production receiver" });
|
|
34195
34214
|
* ```
|
|
34196
34215
|
*/
|
|
34197
34216
|
update(endpointId: string, params?: CommunityScopedWebhookEndpointUpdateParams, options?: RequestOptions): APIPromise<WithLastResponse<WebhookEndpoint>>;
|
|
@@ -34212,7 +34231,7 @@ declare class CommunityWebhooksEventTypesResource extends APIResource {
|
|
|
34212
34231
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-webhooks-event-types
|
|
34213
34232
|
* @example
|
|
34214
34233
|
* ```ts
|
|
34215
|
-
* const listWebhookEventTypes = await social.community("
|
|
34234
|
+
* const listWebhookEventTypes = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").webhooks.eventTypes.list();
|
|
34216
34235
|
* ```
|
|
34217
34236
|
*/
|
|
34218
34237
|
list(options?: RequestOptions): APIPromise<WithLastResponse<ListWebhookEventTypes>>;
|
|
@@ -34235,10 +34254,10 @@ declare class CommunityWebhooksEventsResource extends APIResource {
|
|
|
34235
34254
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-webhooks-events
|
|
34236
34255
|
* @example
|
|
34237
34256
|
* ```ts
|
|
34238
|
-
* for await (const event of social.community("
|
|
34257
|
+
* for await (const event of social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").webhooks.events.list()) {
|
|
34239
34258
|
* console.log(event);
|
|
34240
34259
|
* }
|
|
34241
|
-
* const page = await social.community("
|
|
34260
|
+
* const page = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").webhooks.events.list({}, { timeout: 5_000 });
|
|
34242
34261
|
* ```
|
|
34243
34262
|
*/
|
|
34244
34263
|
list(params?: CommunityScopedWebhookEventListParams, options?: RequestOptions): PagePromise<WebhookEvent>;
|
|
@@ -34260,7 +34279,7 @@ declare class CommunityWebhooksEventsResource extends APIResource {
|
|
|
34260
34279
|
* @see https://productcraft.co/docs/social/api-reference#post-v1-communities-community-id-webhooks-events-event-id-replay
|
|
34261
34280
|
* @example
|
|
34262
34281
|
* ```ts
|
|
34263
|
-
* const replayWebhookEvent = await social.community("
|
|
34282
|
+
* const replayWebhookEvent = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").webhooks.events.replay("evt_3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
34264
34283
|
* ```
|
|
34265
34284
|
*/
|
|
34266
34285
|
replay(eventId: string, params?: CommunityScopedWebhookEventReplayParams, options?: RequestOptions): APIPromise<WithLastResponse<ReplayWebhookEvent>>;
|
|
@@ -34280,7 +34299,7 @@ declare class CommunityWebhooksEventsResource extends APIResource {
|
|
|
34280
34299
|
* @see https://productcraft.co/docs/social/api-reference#get-v1-communities-community-id-webhooks-events-event-id
|
|
34281
34300
|
* @example
|
|
34282
34301
|
* ```ts
|
|
34283
|
-
* const webhookEventDetail = await social.community("
|
|
34302
|
+
* const webhookEventDetail = await social.community("3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f").as("7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d").webhooks.events.retrieve("evt_3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");
|
|
34284
34303
|
* ```
|
|
34285
34304
|
*/
|
|
34286
34305
|
retrieve(eventId: string, options?: RequestOptions): APIPromise<WithLastResponse<WebhookEventDetail>>;
|
|
@@ -34723,6 +34742,7 @@ type __RepostCreatedEvent = RepostCreatedEvent;
|
|
|
34723
34742
|
type __TagCreatedEvent = TagCreatedEvent;
|
|
34724
34743
|
type __UnknownWebhookEvent = UnknownWebhookEvent;
|
|
34725
34744
|
type __UnwrapWebhookEvent = UnwrapWebhookEvent;
|
|
34745
|
+
type __WebhookSignParams = WebhookSignParams;
|
|
34726
34746
|
type __WebhookUnwrapParams = WebhookUnwrapParams;
|
|
34727
34747
|
/**
|
|
34728
34748
|
* ProductCraft Social API client (communities, actors, posts, feeds, conversations, notifications and moderation). Every method is generated from the API's OpenAPI document.
|
|
@@ -35266,6 +35286,7 @@ declare namespace Social {
|
|
|
35266
35286
|
type TagCreatedEvent = __TagCreatedEvent;
|
|
35267
35287
|
type UnknownWebhookEvent = __UnknownWebhookEvent;
|
|
35268
35288
|
type UnwrapWebhookEvent = __UnwrapWebhookEvent;
|
|
35289
|
+
type WebhookSignParams = __WebhookSignParams;
|
|
35269
35290
|
type WebhookUnwrapParams = __WebhookUnwrapParams;
|
|
35270
35291
|
}
|
|
35271
35292
|
|