@itm-studio/partner-sdk 0.1.0 → 0.1.2

package/README.md

@@ -66,10 +66,10 @@ Get paginated moments (events) for your brand.
 const { getPartnerMomentsForBrand } = await itm.query({
   getPartnerMomentsForBrand: {
     __args: {
-      take: 20,             // items per page (default: 50)
+      take: 20,             // items per page (default: 50, omit to use default)
       cursor: nextCursor,   // from previous response
       status: 'UPCOMING',   // UPCOMING | LIVE | ENDED
-      sortOrder: 'ASC',     // ASC | DESC (by start date)
+      sortOrder: 'ASC',     // ASC | DESC by start date (default: DESC)
     },
     moments: { uid: true, name: true, startDate: true },
     totalCount: true,
@@ -148,9 +148,65 @@ const { getPartnerCustomersForMoment } = await itm.query({
 });
 ```
 
+### `getPartnerMomentCollection`
+
+Get a moment collection by slug. Collections group related moments together (e.g. a summer series, a festival lineup). Returns the collection with its moments and links.
+
+```typescript
+const { getPartnerMomentCollection } = await itm.query({
+  getPartnerMomentCollection: {
+    __args: { slug: 'summer-series' },
+    uid: true,
+    name: true,
+    description: true,
+    subLabel: true,
+    availableQueryFilters: true,
+    moments: {
+      uid: true,
+      name: true,
+      slug: true,
+      startDate: true,
+      endDate: true,
+      status: true,
+      venue: { name: true, city: true },
+      ticketTiers: {
+        name: true,
+        price: true,
+        currency: { code: true, symbol: true },
+        remainingSupply: true,
+      },
+    },
+    links: {
+      uid: true,
+      url: true,
+      label: true,
+    },
+  },
+});
+```
+
+You can filter moments within a collection using `queryFilters`:
+
+```typescript
+const { getPartnerMomentCollection } = await itm.query({
+  getPartnerMomentCollection: {
+    __args: { slug: 'summer-series' },
+    name: true,
+    moments: {
+      __args: { queryFilters: ['upcoming'] },
+      uid: true,
+      name: true,
+      startDate: true,
+    },
+  },
+});
+```
+
+> **Note:** `getPartnerMomentCollection` returns `null` if no collection matches the given slug.
+
 ## Pagination
 
-All list endpoints use cursor-based pagination:
+All list endpoints use cursor-based pagination. The default page size is **50** items if `take` is not specified.
 
 ```typescript
 let cursor: string | null = null;

package/dist/index.d.mts

@@ -51,6 +51,7 @@ interface Moment {
     soldOut: Scalars['Boolean'];
     timezone: Scalars['String'];
     minimumAge: Scalars['Int'];
+    externalUrl: (Scalars['String'] | null);
     venue: (Venue | null);
     ticketTiers: TicketTier[];
     createdAt: Scalars['DateTime'];
@@ -68,8 +69,6 @@ interface TicketTier {
     maxPerUser: Scalars['Int'];
     minPerUser: Scalars['Int'];
     remainingSupply: Scalars['Int'];
-    numSold: Scalars['Float'];
-    numCheckedIn: Scalars['Float'];
     startDateOverride: (Scalars['DateTime'] | null);
     endDateOverride: (Scalars['DateTime'] | null);
     createdAt: Scalars['DateTime'];
@@ -147,6 +146,27 @@ interface PartnerCustomer {
     tickets: Ticket[];
     __typename: 'PartnerCustomer';
 }
+interface MomentCollectionLink {
+    uid: Scalars['ID'];
+    url: Scalars['String'];
+    label: (Scalars['String'] | null);
+    createdAt: Scalars['DateTime'];
+    updatedAt: Scalars['DateTime'];
+    __typename: 'MomentCollectionLink';
+}
+interface MomentCollection {
+    uid: Scalars['ID'];
+    name: Scalars['String'];
+    description: (Scalars['String'] | null);
+    slug: Scalars['String'];
+    subLabel: (Scalars['String'] | null);
+    availableQueryFilters: Scalars['String'][];
+    moments: Moment[];
+    links: MomentCollectionLink[];
+    createdAt: Scalars['DateTime'];
+    updatedAt: Scalars['DateTime'];
+    __typename: 'MomentCollection';
+}
 interface GetPublicMomentsResponse {
     moments: Moment[];
     totalCount: Scalars['Int'];
@@ -180,6 +200,11 @@ interface Query {
      * Sorted by newest first (based on earliest ticket purchase time).
      */
     getPartnerCustomersForMoment: GetPartnerCustomersResponse;
+    /**
+     * Get a moment collection by slug.
+     * Returns the collection with its moments and links.
+     */
+    getPartnerMomentCollection: (MomentCollection | null);
     __typename: 'Query';
 }
 interface CurrencyGenqlSelection {
@@ -222,6 +247,7 @@ interface MomentGenqlSelection {
     soldOut?: boolean | number;
     timezone?: boolean | number;
     minimumAge?: boolean | number;
+    externalUrl?: boolean | number;
     venue?: VenueGenqlSelection;
     ticketTiers?: TicketTierGenqlSelection;
     createdAt?: boolean | number;
@@ -240,8 +266,6 @@ interface TicketTierGenqlSelection {
     maxPerUser?: boolean | number;
     minPerUser?: boolean | number;
     remainingSupply?: boolean | number;
-    numSold?: boolean | number;
-    numCheckedIn?: boolean | number;
     startDateOverride?: boolean | number;
     endDateOverride?: boolean | number;
     createdAt?: boolean | number;
@@ -320,6 +344,33 @@ interface PartnerCustomerGenqlSelection {
     __typename?: boolean | number;
     __scalar?: boolean | number;
 }
+interface MomentCollectionLinkGenqlSelection {
+    uid?: boolean | number;
+    url?: boolean | number;
+    label?: boolean | number;
+    createdAt?: boolean | number;
+    updatedAt?: boolean | number;
+    __typename?: boolean | number;
+    __scalar?: boolean | number;
+}
+interface MomentCollectionGenqlSelection {
+    uid?: boolean | number;
+    name?: boolean | number;
+    description?: boolean | number;
+    slug?: boolean | number;
+    subLabel?: boolean | number;
+    availableQueryFilters?: boolean | number;
+    moments?: (MomentGenqlSelection & {
+        __args?: {
+            queryFilters?: (Scalars['String'][] | null);
+        };
+    });
+    links?: MomentCollectionLinkGenqlSelection;
+    createdAt?: boolean | number;
+    updatedAt?: boolean | number;
+    __typename?: boolean | number;
+    __scalar?: boolean | number;
+}
 interface GetPublicMomentsResponseGenqlSelection {
     moments?: MomentGenqlSelection;
     totalCount?: boolean | number;
@@ -385,6 +436,15 @@ interface QueryGenqlSelection {
             take?: (Scalars['Int'] | null);
         };
     });
+    /**
+     * Get a moment collection by slug.
+     * Returns the collection with its moments and links.
+     */
+    getPartnerMomentCollection?: (MomentCollectionGenqlSelection & {
+        __args: {
+            slug: Scalars['String'];
+        };
+    });
     __typename?: boolean | number;
     __scalar?: boolean | number;
 }
@@ -483,4 +543,4 @@ type ITMPartnerClient = Client;
  */
 declare function createITMPartnerClient(config: ITMPartnerClientConfig): ITMPartnerClient;
 
-export { type Currency, type GetPartnerCustomersResponse, type GetPublicMomentsResponse, type GetTicketsResponse, type ITMPartnerClient, type ITMPartnerClientConfig, type MerchPurchase, type Moment, type MomentCategory, 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 };
+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 };

package/dist/index.d.ts

@@ -51,6 +51,7 @@ interface Moment {
     soldOut: Scalars['Boolean'];
     timezone: Scalars['String'];
     minimumAge: Scalars['Int'];
+    externalUrl: (Scalars['String'] | null);
     venue: (Venue | null);
     ticketTiers: TicketTier[];
     createdAt: Scalars['DateTime'];
@@ -68,8 +69,6 @@ interface TicketTier {
     maxPerUser: Scalars['Int'];
     minPerUser: Scalars['Int'];
     remainingSupply: Scalars['Int'];
-    numSold: Scalars['Float'];
-    numCheckedIn: Scalars['Float'];
     startDateOverride: (Scalars['DateTime'] | null);
     endDateOverride: (Scalars['DateTime'] | null);
     createdAt: Scalars['DateTime'];
@@ -147,6 +146,27 @@ interface PartnerCustomer {
     tickets: Ticket[];
     __typename: 'PartnerCustomer';
 }
+interface MomentCollectionLink {
+    uid: Scalars['ID'];
+    url: Scalars['String'];
+    label: (Scalars['String'] | null);
+    createdAt: Scalars['DateTime'];
+    updatedAt: Scalars['DateTime'];
+    __typename: 'MomentCollectionLink';
+}
+interface MomentCollection {
+    uid: Scalars['ID'];
+    name: Scalars['String'];
+    description: (Scalars['String'] | null);
+    slug: Scalars['String'];
+    subLabel: (Scalars['String'] | null);
+    availableQueryFilters: Scalars['String'][];
+    moments: Moment[];
+    links: MomentCollectionLink[];
+    createdAt: Scalars['DateTime'];
+    updatedAt: Scalars['DateTime'];
+    __typename: 'MomentCollection';
+}
 interface GetPublicMomentsResponse {
     moments: Moment[];
     totalCount: Scalars['Int'];
@@ -180,6 +200,11 @@ interface Query {
      * Sorted by newest first (based on earliest ticket purchase time).
      */
     getPartnerCustomersForMoment: GetPartnerCustomersResponse;
+    /**
+     * Get a moment collection by slug.
+     * Returns the collection with its moments and links.
+     */
+    getPartnerMomentCollection: (MomentCollection | null);
     __typename: 'Query';
 }
 interface CurrencyGenqlSelection {
@@ -222,6 +247,7 @@ interface MomentGenqlSelection {
     soldOut?: boolean | number;
     timezone?: boolean | number;
     minimumAge?: boolean | number;
+    externalUrl?: boolean | number;
     venue?: VenueGenqlSelection;
     ticketTiers?: TicketTierGenqlSelection;
     createdAt?: boolean | number;
@@ -240,8 +266,6 @@ interface TicketTierGenqlSelection {
     maxPerUser?: boolean | number;
     minPerUser?: boolean | number;
     remainingSupply?: boolean | number;
-    numSold?: boolean | number;
-    numCheckedIn?: boolean | number;
     startDateOverride?: boolean | number;
     endDateOverride?: boolean | number;
     createdAt?: boolean | number;
@@ -320,6 +344,33 @@ interface PartnerCustomerGenqlSelection {
     __typename?: boolean | number;
     __scalar?: boolean | number;
 }
+interface MomentCollectionLinkGenqlSelection {
+    uid?: boolean | number;
+    url?: boolean | number;
+    label?: boolean | number;
+    createdAt?: boolean | number;
+    updatedAt?: boolean | number;
+    __typename?: boolean | number;
+    __scalar?: boolean | number;
+}
+interface MomentCollectionGenqlSelection {
+    uid?: boolean | number;
+    name?: boolean | number;
+    description?: boolean | number;
+    slug?: boolean | number;
+    subLabel?: boolean | number;
+    availableQueryFilters?: boolean | number;
+    moments?: (MomentGenqlSelection & {
+        __args?: {
+            queryFilters?: (Scalars['String'][] | null);
+        };
+    });
+    links?: MomentCollectionLinkGenqlSelection;
+    createdAt?: boolean | number;
+    updatedAt?: boolean | number;
+    __typename?: boolean | number;
+    __scalar?: boolean | number;
+}
 interface GetPublicMomentsResponseGenqlSelection {
     moments?: MomentGenqlSelection;
     totalCount?: boolean | number;
@@ -385,6 +436,15 @@ interface QueryGenqlSelection {
             take?: (Scalars['Int'] | null);
         };
     });
+    /**
+     * Get a moment collection by slug.
+     * Returns the collection with its moments and links.
+     */
+    getPartnerMomentCollection?: (MomentCollectionGenqlSelection & {
+        __args: {
+            slug: Scalars['String'];
+        };
+    });
     __typename?: boolean | number;
     __scalar?: boolean | number;
 }
@@ -483,4 +543,4 @@ type ITMPartnerClient = Client;
  */
 declare function createITMPartnerClient(config: ITMPartnerClientConfig): ITMPartnerClient;
 
-export { type Currency, type GetPartnerCustomersResponse, type GetPublicMomentsResponse, type GetTicketsResponse, type ITMPartnerClient, type ITMPartnerClientConfig, type MerchPurchase, type Moment, type MomentCategory, 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 };
+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 };

package/dist/index.js

@@ -680,6 +680,9 @@ var types_default = {
       "minimumAge": [
         14
       ],
+      "externalUrl": [
+        10
+      ],
       "venue": [
         11
       ],
@@ -729,12 +732,6 @@ var types_default = {
       "remainingSupply": [
         14
       ],
-      "numSold": [
-        16
-      ],
-      "numCheckedIn": [
-        16
-      ],
       "startDateOverride": [
         0
       ],
@@ -937,6 +934,67 @@ var types_default = {
         10
       ]
     },
+    "MomentCollectionLink": {
+      "uid": [
+        9
+      ],
+      "url": [
+        10
+      ],
+      "label": [
+        10
+      ],
+      "createdAt": [
+        0
+      ],
+      "updatedAt": [
+        0
+      ],
+      "__typename": [
+        10
+      ]
+    },
+    "MomentCollection": {
+      "uid": [
+        9
+      ],
+      "name": [
+        10
+      ],
+      "description": [
+        10
+      ],
+      "slug": [
+        10
+      ],
+      "subLabel": [
+        10
+      ],
+      "availableQueryFilters": [
+        10
+      ],
+      "moments": [
+        12,
+        {
+          "queryFilters": [
+            10,
+            "[String!]"
+          ]
+        }
+      ],
+      "links": [
+        24
+      ],
+      "createdAt": [
+        0
+      ],
+      "updatedAt": [
+        0
+      ],
+      "__typename": [
+        10
+      ]
+    },
     "GetPublicMomentsResponse": {
       "moments": [
         12
@@ -990,7 +1048,7 @@ var types_default = {
     },
     "Query": {
       "getPartnerMomentsForBrand": [
-        24,
+        26,
         {
           "cursor": [
             10
@@ -1016,7 +1074,7 @@ var types_default = {
         }
       ],
       "getPartnerTicketsForMoment": [
-        25,
+        27,
         {
           "momentSlug": [
             10,
@@ -1034,7 +1092,7 @@ var types_default = {
         }
       ],
       "getPartnerCustomersForMoment": [
-        26,
+        28,
         {
           "momentSlug": [
             10,
@@ -1048,6 +1106,15 @@ var types_default = {
           ]
         }
       ],
+      "getPartnerMomentCollection": [
+        25,
+        {
+          "slug": [
+            10,
+            "String!"
+          ]
+        }
+      ],
       "__typename": [
         10
       ]