@itm-studio/partner-sdk 0.1.6 → 0.1.7
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 +68 -0
- package/dist/index.d.mts +1 -1
- package/dist/index.d.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -223,6 +223,74 @@ const { getPartnerMomentCollection } = await itm.query({
|
|
|
223
223
|
|
|
224
224
|
> **Note:** `getPartnerMomentCollection` returns `null` if no collection matches the given slug.
|
|
225
225
|
|
|
226
|
+
### `getPartnerPublicEchoes`
|
|
227
|
+
|
|
228
|
+
Get public echoes (content) for your brand. Echoes are content units — links, posts, images, videos, galleries, audio, polls, forms, and third-party embeds (Spotify, Instagram, TikTok).
|
|
229
|
+
|
|
230
|
+
- If `momentSlug` is provided, returns **moment-level** echoes for that moment.
|
|
231
|
+
- If `momentSlug` is omitted, returns **brand-level** echoes.
|
|
232
|
+
|
|
233
|
+
```typescript
|
|
234
|
+
const { getPartnerPublicEchoes } = await itm.query({
|
|
235
|
+
getPartnerPublicEchoes: {
|
|
236
|
+
__args: { take: 20 },
|
|
237
|
+
echoes: {
|
|
238
|
+
uid: true,
|
|
239
|
+
type: true,
|
|
240
|
+
name: true,
|
|
241
|
+
slug: true,
|
|
242
|
+
description: true,
|
|
243
|
+
publishTime: true,
|
|
244
|
+
externalLink: true,
|
|
245
|
+
mediaAsset: {
|
|
246
|
+
uid: true,
|
|
247
|
+
mimeType: true,
|
|
248
|
+
s3Key: true,
|
|
249
|
+
dimensions: { width: true, height: true },
|
|
250
|
+
placeholderUrl: true,
|
|
251
|
+
blurhash: true,
|
|
252
|
+
},
|
|
253
|
+
echoMedia: {
|
|
254
|
+
uid: true,
|
|
255
|
+
mimeType: true,
|
|
256
|
+
s3Key: true,
|
|
257
|
+
dimensions: { width: true, height: true },
|
|
258
|
+
},
|
|
259
|
+
moment: { uid: true, name: true, slug: true },
|
|
260
|
+
},
|
|
261
|
+
totalCount: true,
|
|
262
|
+
hasNextPage: true,
|
|
263
|
+
nextCursor: true,
|
|
264
|
+
},
|
|
265
|
+
});
|
|
266
|
+
```
|
|
267
|
+
|
|
268
|
+
Filter by moment to get echoes scoped to a specific event:
|
|
269
|
+
|
|
270
|
+
```typescript
|
|
271
|
+
const { getPartnerPublicEchoes } = await itm.query({
|
|
272
|
+
getPartnerPublicEchoes: {
|
|
273
|
+
__args: { momentSlug: 'my-event-slug', take: 10 },
|
|
274
|
+
echoes: {
|
|
275
|
+
uid: true,
|
|
276
|
+
type: true,
|
|
277
|
+
name: true,
|
|
278
|
+
postBody: true,
|
|
279
|
+
externalLink: true,
|
|
280
|
+
thirdPartyEchoType: true,
|
|
281
|
+
thirdPartyEchoConfig: true,
|
|
282
|
+
},
|
|
283
|
+
totalCount: true,
|
|
284
|
+
hasNextPage: true,
|
|
285
|
+
nextCursor: true,
|
|
286
|
+
},
|
|
287
|
+
});
|
|
288
|
+
```
|
|
289
|
+
|
|
290
|
+
**Echo types:** `LINK` | `POST` | `IMAGE` | `VIDEO` | `GALLERY` | `MERCH` | `AUDIO` | `QUESTION` | `POLL` | `UPLOAD` | `TOKEN` | `MOMENT` | `FORM` | `THIRD_PARTY`
|
|
291
|
+
|
|
292
|
+
**Third-party embed types:** `SPOTIFY` | `INSTAGRAM` | `TIKTOK` — use `thirdPartyEchoType` and `thirdPartyEchoConfig` for embed details.
|
|
293
|
+
|
|
226
294
|
## Pagination
|
|
227
295
|
|
|
228
296
|
All list endpoints use cursor-based pagination. The default page size is **50** items if `take` is not specified.
|
package/dist/index.d.mts
CHANGED
|
@@ -710,4 +710,4 @@ type ITMPartnerClient = Client;
|
|
|
710
710
|
*/
|
|
711
711
|
declare function createITMPartnerClient(config: ITMPartnerClientConfig): ITMPartnerClient;
|
|
712
712
|
|
|
713
|
-
export { type Currency, type GetPartnerCustomersResponse, type GetPublicMomentsResponse, type GetTicketsResponse, type ITMPartnerClient, type ITMPartnerClientConfig, type MerchPurchase, type Moment, type MomentCategory, type MomentCollection, type MomentCollectionLink, type MomentDiscountCodeUsage, type MomentSortOrder, type MomentStatus, type MomentSubcategory, type MomentType, type PartnerCustomer, type Payment, type PaymentStatus, type Query, type Ticket, type TicketExtension, type TicketExtensionStatus, type TicketTier, type User, type Venue, createITMPartnerClient, everything, generateQueryOp };
|
|
713
|
+
export { type Currency, type Dimensions, type Echo, type EchoMediaAsset, type EchoType, type GetBrandEchoesForUserResponse, type GetPartnerCustomersResponse, type GetPublicMomentsResponse, type GetTicketsResponse, type ITMPartnerClient, type ITMPartnerClientConfig, type MerchPurchase, type Moment, type MomentCategory, type MomentCollection, type MomentCollectionLink, type MomentDiscountCodeUsage, type MomentSortOrder, type MomentStatus, type MomentSubcategory, type MomentType, type PartnerCustomer, type Payment, type PaymentStatus, type Query, type ThirdPartyEchoType, type Ticket, type TicketExtension, type TicketExtensionStatus, type TicketTier, type User, type Venue, createITMPartnerClient, everything, generateQueryOp };
|
package/dist/index.d.ts
CHANGED
|
@@ -710,4 +710,4 @@ type ITMPartnerClient = Client;
|
|
|
710
710
|
*/
|
|
711
711
|
declare function createITMPartnerClient(config: ITMPartnerClientConfig): ITMPartnerClient;
|
|
712
712
|
|
|
713
|
-
export { type Currency, type GetPartnerCustomersResponse, type GetPublicMomentsResponse, type GetTicketsResponse, type ITMPartnerClient, type ITMPartnerClientConfig, type MerchPurchase, type Moment, type MomentCategory, type MomentCollection, type MomentCollectionLink, type MomentDiscountCodeUsage, type MomentSortOrder, type MomentStatus, type MomentSubcategory, type MomentType, type PartnerCustomer, type Payment, type PaymentStatus, type Query, type Ticket, type TicketExtension, type TicketExtensionStatus, type TicketTier, type User, type Venue, createITMPartnerClient, everything, generateQueryOp };
|
|
713
|
+
export { type Currency, type Dimensions, type Echo, type EchoMediaAsset, type EchoType, type GetBrandEchoesForUserResponse, type GetPartnerCustomersResponse, type GetPublicMomentsResponse, type GetTicketsResponse, type ITMPartnerClient, type ITMPartnerClientConfig, type MerchPurchase, type Moment, type MomentCategory, type MomentCollection, type MomentCollectionLink, type MomentDiscountCodeUsage, type MomentSortOrder, type MomentStatus, type MomentSubcategory, type MomentType, type PartnerCustomer, type Payment, type PaymentStatus, type Query, type ThirdPartyEchoType, type Ticket, type TicketExtension, type TicketExtensionStatus, type TicketTier, type User, type Venue, createITMPartnerClient, everything, generateQueryOp };
|
package/package.json
CHANGED