x-twitter-scraper 0.4.0 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (140) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/README.md +16 -4
  3. package/package.json +2 -15
  4. package/resources/credits.d.mts +1 -1
  5. package/resources/credits.d.ts +1 -1
  6. package/resources/extractions.d.mts +4 -4
  7. package/resources/extractions.d.ts +4 -4
  8. package/resources/guest-wallets.d.mts +2 -2
  9. package/resources/guest-wallets.d.ts +2 -2
  10. package/resources/shared.d.mts +24 -8
  11. package/resources/shared.d.mts.map +1 -1
  12. package/resources/shared.d.ts +24 -8
  13. package/resources/shared.d.ts.map +1 -1
  14. package/resources/support/tickets.d.mts +67 -4
  15. package/resources/support/tickets.d.mts.map +1 -1
  16. package/resources/support/tickets.d.ts +67 -4
  17. package/resources/support/tickets.d.ts.map +1 -1
  18. package/resources/support/tickets.js +22 -4
  19. package/resources/support/tickets.js.map +1 -1
  20. package/resources/support/tickets.mjs +22 -4
  21. package/resources/support/tickets.mjs.map +1 -1
  22. package/resources/x/account-connection-challenges.d.mts +1 -1
  23. package/resources/x/account-connection-challenges.d.ts +1 -1
  24. package/resources/x/account-connection-challenges.js +1 -1
  25. package/resources/x/account-connection-challenges.mjs +1 -1
  26. package/resources/x/accounts.d.mts +9 -6
  27. package/resources/x/accounts.d.mts.map +1 -1
  28. package/resources/x/accounts.d.ts +9 -6
  29. package/resources/x/accounts.d.ts.map +1 -1
  30. package/resources/x/accounts.js +4 -2
  31. package/resources/x/accounts.js.map +1 -1
  32. package/resources/x/accounts.mjs +4 -2
  33. package/resources/x/accounts.mjs.map +1 -1
  34. package/resources/x/communities/communities.d.mts +360 -10
  35. package/resources/x/communities/communities.d.mts.map +1 -1
  36. package/resources/x/communities/communities.d.ts +360 -10
  37. package/resources/x/communities/communities.d.ts.map +1 -1
  38. package/resources/x/communities/communities.js +17 -4
  39. package/resources/x/communities/communities.js.map +1 -1
  40. package/resources/x/communities/communities.mjs +17 -4
  41. package/resources/x/communities/communities.mjs.map +1 -1
  42. package/resources/x/communities/join.d.mts +361 -7
  43. package/resources/x/communities/join.d.mts.map +1 -1
  44. package/resources/x/communities/join.d.ts +361 -7
  45. package/resources/x/communities/join.d.ts.map +1 -1
  46. package/resources/x/communities/join.js +20 -5
  47. package/resources/x/communities/join.js.map +1 -1
  48. package/resources/x/communities/join.mjs +20 -5
  49. package/resources/x/communities/join.mjs.map +1 -1
  50. package/resources/x/dm.d.mts +183 -5
  51. package/resources/x/dm.d.mts.map +1 -1
  52. package/resources/x/dm.d.ts +183 -5
  53. package/resources/x/dm.d.ts.map +1 -1
  54. package/resources/x/dm.js +9 -2
  55. package/resources/x/dm.js.map +1 -1
  56. package/resources/x/dm.mjs +9 -2
  57. package/resources/x/dm.mjs.map +1 -1
  58. package/resources/x/media.d.mts +178 -10
  59. package/resources/x/media.d.mts.map +1 -1
  60. package/resources/x/media.d.ts +178 -10
  61. package/resources/x/media.d.ts.map +1 -1
  62. package/resources/x/media.js +9 -5
  63. package/resources/x/media.js.map +1 -1
  64. package/resources/x/media.mjs +9 -5
  65. package/resources/x/media.mjs.map +1 -1
  66. package/resources/x/profile.d.mts +545 -14
  67. package/resources/x/profile.d.mts.map +1 -1
  68. package/resources/x/profile.d.ts +545 -14
  69. package/resources/x/profile.d.ts.map +1 -1
  70. package/resources/x/profile.js +25 -6
  71. package/resources/x/profile.js.map +1 -1
  72. package/resources/x/profile.mjs +25 -6
  73. package/resources/x/profile.mjs.map +1 -1
  74. package/resources/x/tweets/like.d.mts +358 -6
  75. package/resources/x/tweets/like.d.mts.map +1 -1
  76. package/resources/x/tweets/like.d.ts +358 -6
  77. package/resources/x/tweets/like.d.ts.map +1 -1
  78. package/resources/x/tweets/like.js +17 -4
  79. package/resources/x/tweets/like.js.map +1 -1
  80. package/resources/x/tweets/like.mjs +17 -4
  81. package/resources/x/tweets/like.mjs.map +1 -1
  82. package/resources/x/tweets/retweet.d.mts +358 -6
  83. package/resources/x/tweets/retweet.d.mts.map +1 -1
  84. package/resources/x/tweets/retweet.d.ts +358 -6
  85. package/resources/x/tweets/retweet.d.ts.map +1 -1
  86. package/resources/x/tweets/retweet.js +17 -4
  87. package/resources/x/tweets/retweet.js.map +1 -1
  88. package/resources/x/tweets/retweet.mjs +17 -4
  89. package/resources/x/tweets/retweet.mjs.map +1 -1
  90. package/resources/x/tweets/tweets.d.mts +376 -18
  91. package/resources/x/tweets/tweets.d.mts.map +1 -1
  92. package/resources/x/tweets/tweets.d.ts +376 -18
  93. package/resources/x/tweets/tweets.d.ts.map +1 -1
  94. package/resources/x/tweets/tweets.js +25 -6
  95. package/resources/x/tweets/tweets.js.map +1 -1
  96. package/resources/x/tweets/tweets.mjs +25 -6
  97. package/resources/x/tweets/tweets.mjs.map +1 -1
  98. package/resources/x/users/follow.d.mts +361 -7
  99. package/resources/x/users/follow.d.mts.map +1 -1
  100. package/resources/x/users/follow.d.ts +361 -7
  101. package/resources/x/users/follow.d.ts.map +1 -1
  102. package/resources/x/users/follow.js +20 -5
  103. package/resources/x/users/follow.js.map +1 -1
  104. package/resources/x/users/follow.mjs +20 -5
  105. package/resources/x/users/follow.mjs.map +1 -1
  106. package/resources/x/users/users.d.mts +181 -5
  107. package/resources/x/users/users.d.mts.map +1 -1
  108. package/resources/x/users/users.d.ts +181 -5
  109. package/resources/x/users/users.d.ts.map +1 -1
  110. package/resources/x/users/users.js +9 -2
  111. package/resources/x/users/users.js.map +1 -1
  112. package/resources/x/users/users.mjs +9 -2
  113. package/resources/x/users/users.mjs.map +1 -1
  114. package/resources/x/write-actions.d.mts +155 -12
  115. package/resources/x/write-actions.d.mts.map +1 -1
  116. package/resources/x/write-actions.d.ts +155 -12
  117. package/resources/x/write-actions.d.ts.map +1 -1
  118. package/src/resources/credits.ts +1 -1
  119. package/src/resources/extractions.ts +4 -4
  120. package/src/resources/guest-wallets.ts +2 -2
  121. package/src/resources/shared.ts +93 -9
  122. package/src/resources/support/tickets.ts +122 -6
  123. package/src/resources/x/account-connection-challenges.ts +1 -1
  124. package/src/resources/x/accounts.ts +9 -6
  125. package/src/resources/x/communities/communities.ts +515 -12
  126. package/src/resources/x/communities/join.ts +518 -9
  127. package/src/resources/x/dm.ts +261 -6
  128. package/src/resources/x/media.ts +258 -11
  129. package/src/resources/x/profile.ts +786 -17
  130. package/src/resources/x/tweets/like.ts +515 -8
  131. package/src/resources/x/tweets/retweet.ts +523 -8
  132. package/src/resources/x/tweets/tweets.ts +529 -23
  133. package/src/resources/x/users/follow.ts +518 -9
  134. package/src/resources/x/users/users.ts +260 -6
  135. package/src/resources/x/write-actions.ts +207 -14
  136. package/src/version.ts +1 -1
  137. package/version.d.mts +1 -1
  138. package/version.d.ts +1 -1
  139. package/version.js +1 -1
  140. package/version.mjs +1 -1
@@ -17,32 +17,175 @@ export declare class WriteActions extends APIResource {
17
17
  */
18
18
  retrieve(id: string, options?: RequestOptions): APIPromise<WriteActionRetrieveResponse>;
19
19
  }
20
+ /**
21
+ * Durable write lifecycle record. Poll statusUrl until terminal is true. Reusing
22
+ * the original Idempotency-Key returns this same record. Submit a new write only
23
+ * when safeToRetry is true, using a new key.
24
+ */
20
25
  export interface WriteActionRetrieveResponse {
21
- action: string;
26
+ id: string;
27
+ /**
28
+ * Connected account selected for the write.
29
+ */
30
+ account: WriteActionRetrieveResponse.Account | null;
31
+ action: 'create_tweet' | 'delete_tweet' | 'like' | 'unlike' | 'retweet' | 'unretweet' | 'follow' | 'unfollow' | 'remove_follower' | 'send_dm' | 'upload_media' | 'update_profile' | 'update_avatar' | 'update_banner' | 'create_community' | 'delete_community' | 'join_community' | 'leave_community';
32
+ /**
33
+ * plannedCredits is the approved maximum. chargedCredits comes from the settled
34
+ * credit ledger. Pending or failed writes are not charged.
35
+ */
36
+ billing: WriteActionRetrieveResponse.Billing;
22
37
  charged: boolean;
23
38
  chargedCredits: string;
24
- createdAt: string;
25
- media: WriteActionRetrieveResponse.Media;
26
- retryable: false;
39
+ /**
40
+ * Exact follow-up an API client or agent should perform.
41
+ */
42
+ nextAction: WriteActionRetrieveResponse.NextAction | null;
43
+ object: 'x_write_action';
44
+ pollAfterMs: number | null;
45
+ /**
46
+ * Stable fingerprint and sanitized payload for replay checks.
47
+ */
48
+ request: WriteActionRetrieveResponse.Request;
49
+ /**
50
+ * Confirmed result produced by the write, when available.
51
+ */
52
+ result: WriteActionRetrieveResponse.Result | null;
53
+ /**
54
+ * True only when a new attempt can reasonably succeed.
55
+ */
56
+ retryable: boolean;
57
+ /**
58
+ * True only when no write was dispatched and a new idempotency key may be used.
59
+ */
60
+ safeToRetry: boolean;
27
61
  sendDispatched: boolean;
28
- status: 'success' | 'failed' | 'pending_confirmation';
62
+ status: 'accepted' | 'dispatching' | 'pending_confirmation' | 'success' | 'failed' | 'expired';
63
+ statusUrl: string;
64
+ success: boolean;
65
+ /**
66
+ * Existing X resource targeted by the write, when applicable.
67
+ */
68
+ target: WriteActionRetrieveResponse.Target | null;
69
+ targetId: string | null;
70
+ terminal: boolean;
29
71
  writeActionId: string;
72
+ /**
73
+ * Compatibility field for a confirmed community ID.
74
+ */
75
+ communityId?: string;
76
+ /**
77
+ * Confirmed community name when available.
78
+ */
79
+ communityName?: string;
80
+ completedAt?: string;
30
81
  confirmationAttempts?: number;
31
82
  confirmationCheckedAt?: string;
32
- confirmationSource?: string | null;
33
83
  confirmedAt?: string;
84
+ createdAt?: string;
85
+ /**
86
+ * Structured recovery context for a failed write.
87
+ */
88
+ details?: {
89
+ [key: string]: unknown;
90
+ };
91
+ error?: string;
92
+ /**
93
+ * Deadline for resolving a non-terminal write. This is not the Idempotency-Key
94
+ * retention deadline.
95
+ */
96
+ expiresAt?: string;
97
+ idempotent?: boolean;
98
+ /**
99
+ * Media count, kind, size, and billing details when used.
100
+ */
101
+ media?: {
102
+ [key: string]: unknown;
103
+ };
104
+ /**
105
+ * Compatibility field for a confirmed media upload ID.
106
+ */
107
+ mediaId?: string;
108
+ /**
109
+ * Public media URL when the upload creates one.
110
+ */
111
+ mediaUrl?: string;
34
112
  message?: string;
113
+ /**
114
+ * Compatibility field for a confirmed direct message ID.
115
+ */
35
116
  messageId?: string;
117
+ requestHash?: string;
118
+ requestId?: string;
119
+ /**
120
+ * Compatibility result ID for other write actions.
121
+ */
122
+ resultId?: string;
123
+ /**
124
+ * Dispatch timestamp when the write reached execution.
125
+ */
36
126
  sendDispatchedAt?: string;
37
- targetId?: string | null;
127
+ /**
128
+ * Compatibility field for a confirmed tweet result ID.
129
+ */
38
130
  tweetId?: string;
131
+ updatedAt?: string;
39
132
  }
40
133
  export declare namespace WriteActionRetrieveResponse {
41
- interface Media {
42
- count: number;
43
- credits: string;
44
- kind: 'none' | 'image' | 'video';
45
- totalBytes: string;
134
+ /**
135
+ * Connected account selected for the write.
136
+ */
137
+ interface Account {
138
+ id: string;
139
+ username: string;
140
+ }
141
+ /**
142
+ * plannedCredits is the approved maximum. chargedCredits comes from the settled
143
+ * credit ledger. Pending or failed writes are not charged.
144
+ */
145
+ interface Billing {
146
+ charged: boolean;
147
+ chargedCredits: string;
148
+ plannedCredits: string;
149
+ status: 'not_charged' | 'pending' | 'charged' | 'charge_failed' | 'refunded';
150
+ }
151
+ /**
152
+ * Exact follow-up an API client or agent should perform.
153
+ */
154
+ interface NextAction {
155
+ type: 'poll' | 'retry' | 'verify_result' | 'fix_request';
156
+ afterMs?: number;
157
+ requiresNewIdempotencyKey?: boolean;
158
+ url?: string;
159
+ }
160
+ /**
161
+ * Stable fingerprint and sanitized payload for replay checks.
162
+ */
163
+ interface Request {
164
+ /**
165
+ * Stable hash of account, action, target, and payload.
166
+ */
167
+ hash: string | null;
168
+ /**
169
+ * Exact sanitized payload dispatched for this action.
170
+ */
171
+ payload: {
172
+ [key: string]: unknown;
173
+ } | null;
174
+ }
175
+ /**
176
+ * Confirmed result produced by the write, when available.
177
+ */
178
+ interface Result {
179
+ id?: string;
180
+ state?: string;
181
+ type?: 'tweet' | 'direct_message' | 'media' | 'community' | 'state_change';
182
+ }
183
+ /**
184
+ * Existing X resource targeted by the write, when applicable.
185
+ */
186
+ interface Target {
187
+ id: string;
188
+ type: 'tweet' | 'user' | 'community';
46
189
  }
47
190
  }
48
191
  export declare namespace WriteActions {
@@ -1 +1 @@
1
- {"version":3,"file":"write-actions.d.mts","sourceRoot":"","sources":["../../src/resources/x/write-actions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,2BAA2B,CAAC;CAGxF;AAED,MAAM,WAAW,2BAA2B;IAC1C,MAAM,EAAE,MAAM,CAAC;IAEf,OAAO,EAAE,OAAO,CAAC;IAEjB,cAAc,EAAE,MAAM,CAAC;IAEvB,SAAS,EAAE,MAAM,CAAC;IAElB,KAAK,EAAE,2BAA2B,CAAC,KAAK,CAAC;IAEzC,SAAS,EAAE,KAAK,CAAC;IAEjB,cAAc,EAAE,OAAO,CAAC;IAExB,MAAM,EAAE,SAAS,GAAG,QAAQ,GAAG,sBAAsB,CAAC;IAEtD,aAAa,EAAE,MAAM,CAAC;IAEtB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,yBAAiB,2BAA2B,CAAC;IAC3C,UAAiB,KAAK;QACpB,KAAK,EAAE,MAAM,CAAC;QAEd,OAAO,EAAE,MAAM,CAAC;QAEhB,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC;QAEjC,UAAU,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EAAE,KAAK,2BAA2B,IAAI,2BAA2B,EAAE,CAAC;CAC5E"}
1
+ {"version":3,"file":"write-actions.d.mts","sourceRoot":"","sources":["../../src/resources/x/write-actions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,2BAA2B,CAAC;CAGxF;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IAC1C,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,2BAA2B,CAAC,OAAO,GAAG,IAAI,CAAC;IAEpD,MAAM,EACF,cAAc,GACd,cAAc,GACd,MAAM,GACN,QAAQ,GACR,SAAS,GACT,WAAW,GACX,QAAQ,GACR,UAAU,GACV,iBAAiB,GACjB,SAAS,GACT,cAAc,GACd,gBAAgB,GAChB,eAAe,GACf,eAAe,GACf,kBAAkB,GAClB,kBAAkB,GAClB,gBAAgB,GAChB,iBAAiB,CAAC;IAEtB;;;OAGG;IACH,OAAO,EAAE,2BAA2B,CAAC,OAAO,CAAC;IAE7C,OAAO,EAAE,OAAO,CAAC;IAEjB,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE,2BAA2B,CAAC,UAAU,GAAG,IAAI,CAAC;IAE1D,MAAM,EAAE,gBAAgB,CAAC;IAEzB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,OAAO,EAAE,2BAA2B,CAAC,OAAO,CAAC;IAE7C;;OAEG;IACH,MAAM,EAAE,2BAA2B,CAAC,MAAM,GAAG,IAAI,CAAC;IAElD;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB,cAAc,EAAE,OAAO,CAAC;IAExB,MAAM,EAAE,UAAU,GAAG,aAAa,GAAG,sBAAsB,GAAG,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAC;IAE/F,SAAS,EAAE,MAAM,CAAC;IAElB,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,2BAA2B,CAAC,MAAM,GAAG,IAAI,CAAC;IAElD,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB,QAAQ,EAAE,OAAO,CAAC;IAElB,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAErC,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEnC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,2BAA2B,CAAC;IAC3C;;OAEG;IACH,UAAiB,OAAO;QACtB,EAAE,EAAE,MAAM,CAAC;QAEX,QAAQ,EAAE,MAAM,CAAC;KAClB;IAED;;;OAGG;IACH,UAAiB,OAAO;QACtB,OAAO,EAAE,OAAO,CAAC;QAEjB,cAAc,EAAE,MAAM,CAAC;QAEvB,cAAc,EAAE,MAAM,CAAC;QAEvB,MAAM,EAAE,aAAa,GAAG,SAAS,GAAG,SAAS,GAAG,eAAe,GAAG,UAAU,CAAC;KAC9E;IAED;;OAEG;IACH,UAAiB,UAAU;QACzB,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,eAAe,GAAG,aAAa,CAAC;QAEzD,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB,yBAAyB,CAAC,EAAE,OAAO,CAAC;QAEpC,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,OAAO,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,IAAI,CAAC;KAC5C;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf,IAAI,CAAC,EAAE,OAAO,GAAG,gBAAgB,GAAG,OAAO,GAAG,WAAW,GAAG,cAAc,CAAC;KAC5E;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB,EAAE,EAAE,MAAM,CAAC;QAEX,IAAI,EAAE,OAAO,GAAG,MAAM,GAAG,WAAW,CAAC;KACtC;CACF;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EAAE,KAAK,2BAA2B,IAAI,2BAA2B,EAAE,CAAC;CAC5E"}
@@ -17,32 +17,175 @@ export declare class WriteActions extends APIResource {
17
17
  */
18
18
  retrieve(id: string, options?: RequestOptions): APIPromise<WriteActionRetrieveResponse>;
19
19
  }
20
+ /**
21
+ * Durable write lifecycle record. Poll statusUrl until terminal is true. Reusing
22
+ * the original Idempotency-Key returns this same record. Submit a new write only
23
+ * when safeToRetry is true, using a new key.
24
+ */
20
25
  export interface WriteActionRetrieveResponse {
21
- action: string;
26
+ id: string;
27
+ /**
28
+ * Connected account selected for the write.
29
+ */
30
+ account: WriteActionRetrieveResponse.Account | null;
31
+ action: 'create_tweet' | 'delete_tweet' | 'like' | 'unlike' | 'retweet' | 'unretweet' | 'follow' | 'unfollow' | 'remove_follower' | 'send_dm' | 'upload_media' | 'update_profile' | 'update_avatar' | 'update_banner' | 'create_community' | 'delete_community' | 'join_community' | 'leave_community';
32
+ /**
33
+ * plannedCredits is the approved maximum. chargedCredits comes from the settled
34
+ * credit ledger. Pending or failed writes are not charged.
35
+ */
36
+ billing: WriteActionRetrieveResponse.Billing;
22
37
  charged: boolean;
23
38
  chargedCredits: string;
24
- createdAt: string;
25
- media: WriteActionRetrieveResponse.Media;
26
- retryable: false;
39
+ /**
40
+ * Exact follow-up an API client or agent should perform.
41
+ */
42
+ nextAction: WriteActionRetrieveResponse.NextAction | null;
43
+ object: 'x_write_action';
44
+ pollAfterMs: number | null;
45
+ /**
46
+ * Stable fingerprint and sanitized payload for replay checks.
47
+ */
48
+ request: WriteActionRetrieveResponse.Request;
49
+ /**
50
+ * Confirmed result produced by the write, when available.
51
+ */
52
+ result: WriteActionRetrieveResponse.Result | null;
53
+ /**
54
+ * True only when a new attempt can reasonably succeed.
55
+ */
56
+ retryable: boolean;
57
+ /**
58
+ * True only when no write was dispatched and a new idempotency key may be used.
59
+ */
60
+ safeToRetry: boolean;
27
61
  sendDispatched: boolean;
28
- status: 'success' | 'failed' | 'pending_confirmation';
62
+ status: 'accepted' | 'dispatching' | 'pending_confirmation' | 'success' | 'failed' | 'expired';
63
+ statusUrl: string;
64
+ success: boolean;
65
+ /**
66
+ * Existing X resource targeted by the write, when applicable.
67
+ */
68
+ target: WriteActionRetrieveResponse.Target | null;
69
+ targetId: string | null;
70
+ terminal: boolean;
29
71
  writeActionId: string;
72
+ /**
73
+ * Compatibility field for a confirmed community ID.
74
+ */
75
+ communityId?: string;
76
+ /**
77
+ * Confirmed community name when available.
78
+ */
79
+ communityName?: string;
80
+ completedAt?: string;
30
81
  confirmationAttempts?: number;
31
82
  confirmationCheckedAt?: string;
32
- confirmationSource?: string | null;
33
83
  confirmedAt?: string;
84
+ createdAt?: string;
85
+ /**
86
+ * Structured recovery context for a failed write.
87
+ */
88
+ details?: {
89
+ [key: string]: unknown;
90
+ };
91
+ error?: string;
92
+ /**
93
+ * Deadline for resolving a non-terminal write. This is not the Idempotency-Key
94
+ * retention deadline.
95
+ */
96
+ expiresAt?: string;
97
+ idempotent?: boolean;
98
+ /**
99
+ * Media count, kind, size, and billing details when used.
100
+ */
101
+ media?: {
102
+ [key: string]: unknown;
103
+ };
104
+ /**
105
+ * Compatibility field for a confirmed media upload ID.
106
+ */
107
+ mediaId?: string;
108
+ /**
109
+ * Public media URL when the upload creates one.
110
+ */
111
+ mediaUrl?: string;
34
112
  message?: string;
113
+ /**
114
+ * Compatibility field for a confirmed direct message ID.
115
+ */
35
116
  messageId?: string;
117
+ requestHash?: string;
118
+ requestId?: string;
119
+ /**
120
+ * Compatibility result ID for other write actions.
121
+ */
122
+ resultId?: string;
123
+ /**
124
+ * Dispatch timestamp when the write reached execution.
125
+ */
36
126
  sendDispatchedAt?: string;
37
- targetId?: string | null;
127
+ /**
128
+ * Compatibility field for a confirmed tweet result ID.
129
+ */
38
130
  tweetId?: string;
131
+ updatedAt?: string;
39
132
  }
40
133
  export declare namespace WriteActionRetrieveResponse {
41
- interface Media {
42
- count: number;
43
- credits: string;
44
- kind: 'none' | 'image' | 'video';
45
- totalBytes: string;
134
+ /**
135
+ * Connected account selected for the write.
136
+ */
137
+ interface Account {
138
+ id: string;
139
+ username: string;
140
+ }
141
+ /**
142
+ * plannedCredits is the approved maximum. chargedCredits comes from the settled
143
+ * credit ledger. Pending or failed writes are not charged.
144
+ */
145
+ interface Billing {
146
+ charged: boolean;
147
+ chargedCredits: string;
148
+ plannedCredits: string;
149
+ status: 'not_charged' | 'pending' | 'charged' | 'charge_failed' | 'refunded';
150
+ }
151
+ /**
152
+ * Exact follow-up an API client or agent should perform.
153
+ */
154
+ interface NextAction {
155
+ type: 'poll' | 'retry' | 'verify_result' | 'fix_request';
156
+ afterMs?: number;
157
+ requiresNewIdempotencyKey?: boolean;
158
+ url?: string;
159
+ }
160
+ /**
161
+ * Stable fingerprint and sanitized payload for replay checks.
162
+ */
163
+ interface Request {
164
+ /**
165
+ * Stable hash of account, action, target, and payload.
166
+ */
167
+ hash: string | null;
168
+ /**
169
+ * Exact sanitized payload dispatched for this action.
170
+ */
171
+ payload: {
172
+ [key: string]: unknown;
173
+ } | null;
174
+ }
175
+ /**
176
+ * Confirmed result produced by the write, when available.
177
+ */
178
+ interface Result {
179
+ id?: string;
180
+ state?: string;
181
+ type?: 'tweet' | 'direct_message' | 'media' | 'community' | 'state_change';
182
+ }
183
+ /**
184
+ * Existing X resource targeted by the write, when applicable.
185
+ */
186
+ interface Target {
187
+ id: string;
188
+ type: 'tweet' | 'user' | 'community';
46
189
  }
47
190
  }
48
191
  export declare namespace WriteActions {
@@ -1 +1 @@
1
- {"version":3,"file":"write-actions.d.ts","sourceRoot":"","sources":["../../src/resources/x/write-actions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,2BAA2B,CAAC;CAGxF;AAED,MAAM,WAAW,2BAA2B;IAC1C,MAAM,EAAE,MAAM,CAAC;IAEf,OAAO,EAAE,OAAO,CAAC;IAEjB,cAAc,EAAE,MAAM,CAAC;IAEvB,SAAS,EAAE,MAAM,CAAC;IAElB,KAAK,EAAE,2BAA2B,CAAC,KAAK,CAAC;IAEzC,SAAS,EAAE,KAAK,CAAC;IAEjB,cAAc,EAAE,OAAO,CAAC;IAExB,MAAM,EAAE,SAAS,GAAG,QAAQ,GAAG,sBAAsB,CAAC;IAEtD,aAAa,EAAE,MAAM,CAAC;IAEtB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,yBAAiB,2BAA2B,CAAC;IAC3C,UAAiB,KAAK;QACpB,KAAK,EAAE,MAAM,CAAC;QAEd,OAAO,EAAE,MAAM,CAAC;QAEhB,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC;QAEjC,UAAU,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EAAE,KAAK,2BAA2B,IAAI,2BAA2B,EAAE,CAAC;CAC5E"}
1
+ {"version":3,"file":"write-actions.d.ts","sourceRoot":"","sources":["../../src/resources/x/write-actions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,2BAA2B,CAAC;CAGxF;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IAC1C,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,2BAA2B,CAAC,OAAO,GAAG,IAAI,CAAC;IAEpD,MAAM,EACF,cAAc,GACd,cAAc,GACd,MAAM,GACN,QAAQ,GACR,SAAS,GACT,WAAW,GACX,QAAQ,GACR,UAAU,GACV,iBAAiB,GACjB,SAAS,GACT,cAAc,GACd,gBAAgB,GAChB,eAAe,GACf,eAAe,GACf,kBAAkB,GAClB,kBAAkB,GAClB,gBAAgB,GAChB,iBAAiB,CAAC;IAEtB;;;OAGG;IACH,OAAO,EAAE,2BAA2B,CAAC,OAAO,CAAC;IAE7C,OAAO,EAAE,OAAO,CAAC;IAEjB,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE,2BAA2B,CAAC,UAAU,GAAG,IAAI,CAAC;IAE1D,MAAM,EAAE,gBAAgB,CAAC;IAEzB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,OAAO,EAAE,2BAA2B,CAAC,OAAO,CAAC;IAE7C;;OAEG;IACH,MAAM,EAAE,2BAA2B,CAAC,MAAM,GAAG,IAAI,CAAC;IAElD;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB,cAAc,EAAE,OAAO,CAAC;IAExB,MAAM,EAAE,UAAU,GAAG,aAAa,GAAG,sBAAsB,GAAG,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAC;IAE/F,SAAS,EAAE,MAAM,CAAC;IAElB,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,2BAA2B,CAAC,MAAM,GAAG,IAAI,CAAC;IAElD,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB,QAAQ,EAAE,OAAO,CAAC;IAElB,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAErC,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEnC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,2BAA2B,CAAC;IAC3C;;OAEG;IACH,UAAiB,OAAO;QACtB,EAAE,EAAE,MAAM,CAAC;QAEX,QAAQ,EAAE,MAAM,CAAC;KAClB;IAED;;;OAGG;IACH,UAAiB,OAAO;QACtB,OAAO,EAAE,OAAO,CAAC;QAEjB,cAAc,EAAE,MAAM,CAAC;QAEvB,cAAc,EAAE,MAAM,CAAC;QAEvB,MAAM,EAAE,aAAa,GAAG,SAAS,GAAG,SAAS,GAAG,eAAe,GAAG,UAAU,CAAC;KAC9E;IAED;;OAEG;IACH,UAAiB,UAAU;QACzB,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,eAAe,GAAG,aAAa,CAAC;QAEzD,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB,yBAAyB,CAAC,EAAE,OAAO,CAAC;QAEpC,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,OAAO,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,IAAI,CAAC;KAC5C;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf,IAAI,CAAC,EAAE,OAAO,GAAG,gBAAgB,GAAG,OAAO,GAAG,WAAW,GAAG,cAAc,CAAC;KAC5E;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB,EAAE,EAAE,MAAM,CAAC;QAEX,IAAI,EAAE,OAAO,GAAG,MAAM,GAAG,WAAW,CAAC;KACtC;CACF;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EAAE,KAAK,2BAA2B,IAAI,2BAA2B,EAAE,CAAC;CAC5E"}
@@ -146,7 +146,7 @@ export interface CreditRedirectTopupCheckoutParams {
146
146
 
147
147
  export interface CreditRetrieveTopupStatusParams {
148
148
  /**
149
- * Billing session ID returned by the top-up billing flow.
149
+ * Top-up session ID to inspect.
150
150
  */
151
151
  session_id: string;
152
152
  }
@@ -453,7 +453,7 @@ export interface ExtractionEstimateCostParams {
453
453
  retweetsOfTweetId?: string;
454
454
 
455
455
  /**
456
- * Required for tweet_search_extractor & community_search.
456
+ * Query used to price tweet_search_extractor or community_search.
457
457
  */
458
458
  searchQuery?: string;
459
459
 
@@ -463,18 +463,18 @@ export interface ExtractionEstimateCostParams {
463
463
  sinceDate?: string;
464
464
 
465
465
  /**
466
- * Required for community_post_extractor & community_search.
466
+ * Community ID used to price community_post_extractor or community_search.
467
467
  */
468
468
  targetCommunityId?: string;
469
469
 
470
470
  /**
471
- * Required for list_follower_explorer, list_member_extractor &
471
+ * List ID used to price list_follower_explorer, list_member_extractor, or
472
472
  * list_post_extractor.
473
473
  */
474
474
  targetListId?: string;
475
475
 
476
476
  /**
477
- * Required for space_explorer.
477
+ * Space ID used to price space_explorer.
478
478
  */
479
479
  targetSpaceId?: string;
480
480
 
@@ -289,7 +289,7 @@ export namespace GuestWalletTopupResponse {
289
289
 
290
290
  export interface GuestWalletCreateParams {
291
291
  /**
292
- * Body param: Confirmed USD amount in cents.
292
+ * Body param: USD cents accepted for this checkout.
293
293
  */
294
294
  amount_minor: number;
295
295
 
@@ -308,7 +308,7 @@ export interface GuestWalletCreateParams {
308
308
 
309
309
  export interface GuestWalletTopupParams {
310
310
  /**
311
- * Body param: Confirmed USD amount in cents.
311
+ * Body param: USD cents accepted for this checkout.
312
312
  */
313
313
  amount_minor: number;
314
314
 
@@ -149,6 +149,39 @@ export interface Error {
149
149
  | 'unauthenticated'
150
150
  | 'unsupported_field'
151
151
  | 'user_not_found'
152
+ | 'body_too_large'
153
+ | 'checkout_unavailable'
154
+ | 'connection_challenge_expired'
155
+ | 'connection_challenge_inactive'
156
+ | 'draft_not_found'
157
+ | 'favoriters_unavailable'
158
+ | 'forbidden'
159
+ | 'guest_wallet_unavailable'
160
+ | 'guest_wallets_disabled'
161
+ | 'guest_wallets_unavailable'
162
+ | 'idempotency_conflict'
163
+ | 'idempotency_key_conflict'
164
+ | 'invalid_community_id'
165
+ | 'invalid_idempotency_key'
166
+ | 'invalid_list_id'
167
+ | 'invalid_payment_amount'
168
+ | 'invalid_range'
169
+ | 'login_rate_limited'
170
+ | 'missing_idempotency_key'
171
+ | 'missing_ids'
172
+ | 'no_cached_style'
173
+ | 'passkey_required'
174
+ | 'rate_limited'
175
+ | 'read_request_timeout'
176
+ | 'replies_incomplete'
177
+ | 'support_media_rate_limit'
178
+ | 'support_request_rate_limit'
179
+ | 'too_many_ids'
180
+ | 'unknown_field'
181
+ | 'unsupported_media_type'
182
+ | 'webhook_inactive'
183
+ | 'write_tracking_unavailable'
184
+ | 'x_write_unconfirmed'
152
185
  | 'x_account_feature_required'
153
186
  | 'x_account_protected'
154
187
  | 'x_account_suspended'
@@ -175,8 +208,27 @@ export interface Error {
175
208
  | 'x_user_lookup_failed'
176
209
  | 'x_write_ambiguous'
177
210
  | 'x_write_failed'
178
- | 'x_write_unconfirmed'
179
211
  | Error.StructuredError;
212
+
213
+ /**
214
+ * Human-readable error guidance.
215
+ */
216
+ message?: string;
217
+
218
+ /**
219
+ * Machine-readable reason for a login cooldown.
220
+ */
221
+ reason?: string;
222
+
223
+ /**
224
+ * Seconds until the next permitted request.
225
+ */
226
+ retryAfter?: number;
227
+
228
+ /**
229
+ * Required wait in milliseconds.
230
+ */
231
+ retryAfterMs?: number;
180
232
  }
181
233
 
182
234
  export namespace Error {
@@ -222,6 +274,39 @@ export namespace Error {
222
274
  | 'unauthenticated'
223
275
  | 'unsupported_field'
224
276
  | 'user_not_found'
277
+ | 'body_too_large'
278
+ | 'checkout_unavailable'
279
+ | 'connection_challenge_expired'
280
+ | 'connection_challenge_inactive'
281
+ | 'draft_not_found'
282
+ | 'favoriters_unavailable'
283
+ | 'forbidden'
284
+ | 'guest_wallet_unavailable'
285
+ | 'guest_wallets_disabled'
286
+ | 'guest_wallets_unavailable'
287
+ | 'idempotency_conflict'
288
+ | 'idempotency_key_conflict'
289
+ | 'invalid_community_id'
290
+ | 'invalid_idempotency_key'
291
+ | 'invalid_list_id'
292
+ | 'invalid_payment_amount'
293
+ | 'invalid_range'
294
+ | 'login_rate_limited'
295
+ | 'missing_idempotency_key'
296
+ | 'missing_ids'
297
+ | 'no_cached_style'
298
+ | 'passkey_required'
299
+ | 'rate_limited'
300
+ | 'read_request_timeout'
301
+ | 'replies_incomplete'
302
+ | 'support_media_rate_limit'
303
+ | 'support_request_rate_limit'
304
+ | 'too_many_ids'
305
+ | 'unknown_field'
306
+ | 'unsupported_media_type'
307
+ | 'webhook_inactive'
308
+ | 'write_tracking_unavailable'
309
+ | 'x_write_unconfirmed'
225
310
  | 'x_account_feature_required'
226
311
  | 'x_account_protected'
227
312
  | 'x_account_suspended'
@@ -247,8 +332,7 @@ export namespace Error {
247
332
  | 'x_transient_error'
248
333
  | 'x_user_lookup_failed'
249
334
  | 'x_write_ambiguous'
250
- | 'x_write_failed'
251
- | 'x_write_unconfirmed';
335
+ | 'x_write_failed';
252
336
 
253
337
  message: string;
254
338
 
@@ -359,7 +443,7 @@ export interface SearchTweet {
359
443
  createdAt?: string;
360
444
 
361
445
  /**
362
- * Start and end offsets for rendered tweet text
446
+ * Rendered text's start and end offsets.
363
447
  */
364
448
  displayTextRange?: Array<number>;
365
449
 
@@ -370,17 +454,17 @@ export interface SearchTweet {
370
454
  entities?: { [key: string]: unknown };
371
455
 
372
456
  /**
373
- * Tweet ID being replied to
457
+ * ID of the tweet this result replies to.
374
458
  */
375
459
  inReplyToId?: string;
376
460
 
377
461
  /**
378
- * User ID being replied to
462
+ * ID of the user this result replies to.
379
463
  */
380
464
  inReplyToUserId?: string;
381
465
 
382
466
  /**
383
- * Username being replied to
467
+ * Username this result replies to.
384
468
  */
385
469
  inReplyToUsername?: string;
386
470
 
@@ -405,7 +489,7 @@ export interface SearchTweet {
405
489
  isReply?: boolean;
406
490
 
407
491
  /**
408
- * Tweet language code
492
+ * Search result language code.
409
493
  */
410
494
  lang?: string;
411
495
 
@@ -436,7 +520,7 @@ export interface SearchTweet {
436
520
  type?: string;
437
521
 
438
522
  /**
439
- * Tweet permalink URL
523
+ * Search result permalink.
440
524
  */
441
525
  url?: string;
442
526
  }