@itm-studio/partner-sdk 0.4.0 → 0.4.2

package/dist/index.d.ts

@@ -902,7 +902,63 @@ interface PartnerMembershipTier {
     yearlyPrice: (Scalars['Int'] | null);
     __typename: 'PartnerMembershipTier';
 }
+/** Whether a Login with ITM app can sign users in. */
+type BrandAppStatus = 'ACTIVE' | 'DISABLED';
+type ConsentChannel = 'EMAIL' | 'PUSH' | 'SMS';
+type ConsentPromptCategory = 'CUSTOM' | 'MARKETING' | 'PRIVACY' | 'TERMS';
+type LoginCodeChannel = 'CALL' | 'EMAIL' | 'SMS' | 'WHATSAPP';
+/** A brand-owned Login with ITM application: a public OAuth/OIDC client that uses PKCE and has no secret. */
+interface BrandApp {
+    /** Public OAuth client_id. It is not a secret. */
+    clientId: Scalars['String'];
+    createdAt: Scalars['DateTime'];
+    /** OpenID Connect issuer URL apps authenticate against; null when Login with ITM is not configured. */
+    issuer: (Scalars['String'] | null);
+    name: Scalars['String'];
+    /** Exact redirect URIs. All share one origin; that origin may call the token and userinfo endpoints and hand logins to ITM embeds. */
+    redirectUris: Scalars['String'][];
+    status: BrandAppStatus;
+    uid: Scalars['String'];
+    __typename: 'BrandApp';
+}
+interface CheckoutMarketingConsentPrompt {
+    bodyMarkdown: (Scalars['String'] | null);
+    category: ConsentPromptCategory;
+    channels: ConsentChannel[];
+    labelMarkdown: Scalars['String'];
+    promptUid: Scalars['String'];
+    required: Scalars['Boolean'];
+    version: Scalars['Int'];
+    __typename: 'CheckoutMarketingConsentPrompt';
+}
+interface PartnerAppLoginChallenge {
+    channel: LoginCodeChannel;
+    destinationHint: (Scalars['String'] | null);
+    /** Show this text verbatim with the code field: it is what signing in shares. */
+    disclosure: Scalars['String'];
+    expiresAt: Scalars['DateTime'];
+    /** Optional marketing opt-in. Render verbatim as an unchecked checkbox; signing in must not depend on it. */
+    marketingConsentPrompt: CheckoutMarketingConsentPrompt;
+    __typename: 'PartnerAppLoginChallenge';
+}
+interface PartnerAppLoginProfile {
+    email: (Scalars['String'] | null);
+    emailVerified: Scalars['Boolean'];
+    name: (Scalars['String'] | null);
+    phoneNumber: (Scalars['String'] | null);
+    phoneVerified: Scalars['Boolean'];
+    __typename: 'PartnerAppLoginProfile';
+}
+/** A completed headless sign-in. It is not a credential: keep your own session keyed by customerUid. */
+interface PartnerAppLogin {
+    /** The person's customer UID for your brand (getPartnerAudience customer uid). */
+    customerUid: Scalars['String'];
+    profile: PartnerAppLoginProfile;
+    __typename: 'PartnerAppLogin';
+}
 interface Query {
+    /** The brand's Login with ITM apps (at most 20), oldest first. Deleted apps are omitted. */
+    getPartnerBrandApps: BrandApp[];
     /** List the authenticated partner brand's membership rows; PENDING is excluded by default. */
     getPartnerMembers: GetPartnerMembersResponse;
     /** List the authenticated partner brand's non-deleted membership tiers, including inactive and private tiers. */
@@ -1057,6 +1113,14 @@ interface CreatePartnerBrandSubscriptionResponse {
     __typename: 'CreatePartnerBrandSubscriptionResponse';
 }
 interface Mutation {
+    /** Registers a Login with ITM app for the brand. A brand can have up to 20 apps. */
+    createPartnerBrandApp: BrandApp;
+    /** Disables an app: new logins stop and its tokens and remembered consents are revoked immediately. A partner key cannot re-enable it; ask ITM. */
+    disablePartnerBrandApp: BrandApp;
+    /** Sends a Login with ITM code for the brand's own sign-in form. Call it from your server; the response is the same whether or not the person has an ITM account. */
+    startPartnerAppLogin: PartnerAppLoginChallenge;
+    /** Completes a headless sign-in: checks the code, adds the person to the brand's contacts and records an optional opt-in. Returns no ITM credential. */
+    verifyPartnerAppLogin: PartnerAppLogin;
     /** Log a payment received off-site. Brand scope comes from the authenticated token or agent session. Amount is in ITM cents (major units times 100). Retain requestUid across retries. */
     createPartnerManualContribution: ContributionAdmin;
     reserveAgentMediaUpload: AgentMediaUploadReservation;
@@ -2319,7 +2383,97 @@ interface PartnerMembershipTierGenqlSelection {
     __typename?: boolean | number;
     __scalar?: boolean | number;
 }
+/** A brand-owned Login with ITM application: a public OAuth/OIDC client that uses PKCE and has no secret. */
+interface BrandAppGenqlSelection {
+    /** Public OAuth client_id. It is not a secret. */
+    clientId?: boolean | number;
+    createdAt?: boolean | number;
+    /** OpenID Connect issuer URL apps authenticate against; null when Login with ITM is not configured. */
+    issuer?: boolean | number;
+    name?: boolean | number;
+    /** Exact redirect URIs. All share one origin; that origin may call the token and userinfo endpoints and hand logins to ITM embeds. */
+    redirectUris?: boolean | number;
+    status?: boolean | number;
+    uid?: boolean | number;
+    __typename?: boolean | number;
+    __scalar?: boolean | number;
+}
+interface CreateBrandAppInput {
+    name: Scalars['String'];
+    /** Exact https redirect URIs (http is allowed only for localhost) on a single origin. */
+    redirectUris: Scalars['String'][];
+}
+interface CheckoutMarketingConsentPromptGenqlSelection {
+    bodyMarkdown?: boolean | number;
+    category?: boolean | number;
+    channels?: boolean | number;
+    labelMarkdown?: boolean | number;
+    promptUid?: boolean | number;
+    required?: boolean | number;
+    version?: boolean | number;
+    __typename?: boolean | number;
+    __scalar?: boolean | number;
+}
+interface CheckoutMarketingConsentInput {
+    accepted: Scalars['Boolean'];
+    language?: (Scalars['String'] | null);
+    pageUrl?: (Scalars['String'] | null);
+    referrerUrl?: (Scalars['String'] | null);
+    screenHeight?: (Scalars['Int'] | null);
+    screenWidth?: (Scalars['Int'] | null);
+    submittedAt?: (Scalars['DateTime'] | null);
+    timezone?: (Scalars['String'] | null);
+}
+/** Starts a headless Login with ITM sign-in from the brand's server: ITM sends a code that only verifyPartnerAppLogin accepts for this app and partner credential. */
+interface StartPartnerAppLoginInput {
+    /** The app's public client ID. */
+    clientId: Scalars['String'];
+    /** The visitor's request details. ipAddress (the visitor's, not your server's) is required. */
+    compliance: SubscriptionComplianceInput;
+    /** Phone number or email address. */
+    identifier: Scalars['String'];
+}
+interface PartnerAppLoginChallengeGenqlSelection {
+    channel?: boolean | number;
+    destinationHint?: boolean | number;
+    /** Show this text verbatim with the code field: it is what signing in shares. */
+    disclosure?: boolean | number;
+    expiresAt?: boolean | number;
+    /** Optional marketing opt-in. Render verbatim as an unchecked checkbox; signing in must not depend on it. */
+    marketingConsentPrompt?: CheckoutMarketingConsentPromptGenqlSelection;
+    __typename?: boolean | number;
+    __scalar?: boolean | number;
+}
+interface VerifyPartnerAppLoginInput {
+    clientId: Scalars['String'];
+    code: Scalars['String'];
+    /** The visitor's request details. ipAddress is required. */
+    compliance: SubscriptionComplianceInput;
+    /** The identifier the code was sent to. Read it from your own session, not from the browser. */
+    identifier: Scalars['String'];
+    /** Send only when the visitor ticked the opt-in (accepted: true; pageUrl here or in compliance). Omit it otherwise; omission never unsubscribes anyone. */
+    marketingConsent?: (CheckoutMarketingConsentInput | null);
+}
+interface PartnerAppLoginProfileGenqlSelection {
+    email?: boolean | number;
+    emailVerified?: boolean | number;
+    name?: boolean | number;
+    phoneNumber?: boolean | number;
+    phoneVerified?: boolean | number;
+    __typename?: boolean | number;
+    __scalar?: boolean | number;
+}
+/** A completed headless sign-in. It is not a credential: keep your own session keyed by customerUid. */
+interface PartnerAppLoginGenqlSelection {
+    /** The person's customer UID for your brand (getPartnerAudience customer uid). */
+    customerUid?: boolean | number;
+    profile?: PartnerAppLoginProfileGenqlSelection;
+    __typename?: boolean | number;
+    __scalar?: boolean | number;
+}
 interface QueryGenqlSelection {
+    /** The brand's Login with ITM apps (at most 20), oldest first. Deleted apps are omitted. */
+    getPartnerBrandApps?: BrandAppGenqlSelection;
     /** List the authenticated partner brand's membership rows; PENDING is excluded by default. */
     getPartnerMembers?: (GetPartnerMembersResponseGenqlSelection & {
         __args?: {
@@ -2914,6 +3068,30 @@ interface CreatePartnerBrandSubscriptionResponseGenqlSelection {
     __scalar?: boolean | number;
 }
 interface MutationGenqlSelection {
+    /** Registers a Login with ITM app for the brand. A brand can have up to 20 apps. */
+    createPartnerBrandApp?: (BrandAppGenqlSelection & {
+        __args: {
+            input: CreateBrandAppInput;
+        };
+    });
+    /** Disables an app: new logins stop and its tokens and remembered consents are revoked immediately. A partner key cannot re-enable it; ask ITM. */
+    disablePartnerBrandApp?: (BrandAppGenqlSelection & {
+        __args: {
+            appUid: Scalars['String'];
+        };
+    });
+    /** Sends a Login with ITM code for the brand's own sign-in form. Call it from your server; the response is the same whether or not the person has an ITM account. */
+    startPartnerAppLogin?: (PartnerAppLoginChallengeGenqlSelection & {
+        __args: {
+            input: StartPartnerAppLoginInput;
+        };
+    });
+    /** Completes a headless sign-in: checks the code, adds the person to the brand's contacts and records an optional opt-in. Returns no ITM credential. */
+    verifyPartnerAppLogin?: (PartnerAppLoginGenqlSelection & {
+        __args: {
+            input: VerifyPartnerAppLoginInput;
+        };
+    });
     /** Log a payment received off-site. Brand scope comes from the authenticated token or agent session. Amount is in ITM cents (major units times 100). Retain requestUid across retries. */
     createPartnerManualContribution?: (ContributionAdminGenqlSelection & {
         __args: {
@@ -3553,4 +3731,4 @@ type ITMPartnerClient = Client;
  */
 declare function createITMPartnerClient(config: ITMPartnerClientConfig): ITMPartnerClient;
 
-export { type AgentThreadSeedContext, type ApplyDynamicPricingInput, type BrandAgentEmailMessageInput, type BrandAgentEmailSendBatch, type BrandAgentEmailSendBatchStatus, type BrandAgentEmailSendMessage, type BrandAgentEmailSendMessageStatus, type BrandDrop, type BrandDropCtaType, type BrandDropMusicLink, type BrandSubscription, type ConsentStatus, type ContributionAdmin, type ContributionPageAdmin, type ContributionPageStatusFilter, type ContributionPagesResponse, type ContributionSource, type ContributionStatus, type ContributionsResponse, type CreateManualContributionInput, type CreateMomentOnlineConfigInput, type CreatePartnerBrandDropInput, type CreatePartnerBrandSubscriptionInput, type CreatePartnerBrandSubscriptionResponse, type CreatePartnerMomentInput, type CreatePartnerTicketTierInput, type CreatePlanBudgetInput, type CreatePlanInput, type Currency, DEFAULT_API_URL, type Dimensions, type DimensionsInput, type DynamicPricingActorType, type DynamicPricingAdmissionWindow, type DynamicPricingBatch, type DynamicPricingBatchEvent, type DynamicPricingBatchEventType, type DynamicPricingBatchItem, type DynamicPricingBatchItemStatus, type DynamicPricingBatchStatus, type DynamicPricingContext, type DynamicPricingExecutionMode, type DynamicPricingInventoryGuardInput, type DynamicPricingInventoryGuardMode, type DynamicPricingInventoryMetric, type DynamicPricingMomentInput, type DynamicPricingTierContext, type DynamicPricingTierUpdateInput, type Echo, type EchoMediaAsset, type EchoType, type EditPartnerTicketTiersForMomentInput, type EventImportPlatform, GenqlError, type GetBrandEchoesForUserResponse, type GetMomentLineupsResponse, type GetMomentTagAssignmentsResponse, type GetPartnerAudienceInput, type GetPartnerAudienceResponse, type GetPartnerCustomersResponse, type GetPartnerDropsResponse, type GetPartnerMediaAssetsInput, type GetPartnerMediaAssetsResponse, type GetPartnerMembersInput, type GetPartnerMembersResponse, type GetPartnerMembershipTiersInput, type GetPartnerMembershipTiersResponse, type GetPartnerTicketTiersForMomentInput, type GetPartnerTicketTiersForMomentResponse, type GetPlansInput, type GetPlansResponse, type GetPublicMomentsResponse, type GetTicketsResponse, type ITMPartnerAgentAccessConfig, type ITMPartnerAgentAccessCredentials, type ITMPartnerAgentSessionConfig, type ITMPartnerAgentSessionCredentials, type ITMPartnerClient, type ITMPartnerClientConfig, type ITMPartnerHeaders, type ITMPartnerHeadersObject, type ITMPartnerTokenConfig, type ManualContributionReceiptType, type MediaAsset, type MediaAssetUploadUrl, type MembershipBillingInterval, type MembershipExpiryType, type MembershipPassType, type MembershipPurchaseType, type MembershipSource, type MembershipStatus, type MerchPurchase, type Moment, type MomentCategory, type MomentCollection, type MomentCollectionLink, type MomentDiscountCodeUsage, type MomentDynamicPricingPolicy, type MomentDynamicPricingTierRule, type MomentLineup, type MomentLineupDisplayLabel, type MomentLineupResponseResult, type MomentLineupStatus, type MomentLineupType, type MomentOccurrenceScheduleFrequency, type MomentOnlineProvider, type MomentPublicVenuePreview, type MomentSortOrder, type MomentStatus, type MomentSubcategory, type MomentTagAssignment, type MomentType, type MusicReleaseType, type Mutation, type PaginationInput, type PartnerAudienceCustomer, type PartnerAudienceFiltersInput, type PartnerAudienceSortField, type PartnerAudienceSortInput, type PartnerBrand, type PartnerCustomer, type PartnerMember, type PartnerMemberCustomer, type PartnerMemberTier, type PartnerMembershipTier, type PartnerMomentAttendanceCount, type PartnerMomentAttendanceLookupInput, type PartnerMomentAttendanceStats, type PartnerMomentGuestlistAttendance, type PartnerMomentGuestlistLabelAttendance, type PartnerMomentStats, type PartnerMomentTicketAttendance, type PartnerMomentTicketTierAttendance, type PartnerMomentsFiltersInput, type PartnerTicketStatus, type PartnerTicketTier, type PartnerTicketTierUpdateInput, type PartnerTicketUserLookupInput, type PartnerTicketsForUserInput, type Payment, type PaymentStatus, type Plan, type PlanBudget, type PlanBudgetAllocationType, type PlanBudgetArtistDealBasis, type PlanBudgetArtistDealInput, type PlanBudgetArtistDealType, type PlanBudgetCapacityAllocationInput, type PlanBudgetCategoryInput, type PlanBudgetCategoryKind, type PlanBudgetChargeCalculation, type PlanBudgetChargeKind, type PlanBudgetChargeTreatment, type PlanBudgetExternalTicketingChannelInput, type PlanBudgetFeeAssessment, type PlanBudgetFeeComponentKind, type PlanBudgetFeePercentageBasis, type PlanBudgetGuaranteeBasis, type PlanBudgetLineBasis, type PlanBudgetLineInput, type PlanBudgetPaymentStatus, type PlanBudgetPricingMode, type PlanBudgetSummary, type PlanBudgetTicketChargeRuleInput, type PlanBudgetTicketTierInput, type PlanBudgetTicketingChannelType, type PlanBudgetTicketingFeeComponentInput, type PlanKind, type PlanLinkMetadataStatus, type PlanMoodboard, type PlanMoodboardItem, type PlanMoodboardItemType, type PlanSchedule, type PlanScheduleInput, type PlanScheduleTime, type PlanScheduleTimeInput, type PlanScheduleType, type PlanStatus, type PlanSummary, type PlanningProposal, type PlanningSource, type PlanningSourceDispositionInput, type PlanningSourceSection, type PostSubscriptionEmailInput, type PostSubscriptionMessageInput, type PostSubscriptionPushInput, type PostSubscriptionSmsInput, type PreparePlanningProposalInput, type PublicMomentLineupInfo, type Query, type ReplacePlanBudgetDraftInput, type RespondToMomentLineupInput, type SendPartnerAgentEmailInput, type SortDirection, type SubscriptionComplianceInput, type Tag, type TagSource, type ThirdPartyEchoType, type Ticket, type TicketAdmissionWindowSource, type TicketAttendanceMode, type TicketExtension, type TicketExtensionStatus, type TicketTier, type Transforms, type UpdatePlanInput, type User, type UserSource, type Venue, type VenueInput, type VerifyPartnerBrandSubscriptionInput, createITMPartnerClient, everything, generateMutationOp, generateQueryOp };
+export { type AgentThreadSeedContext, type ApplyDynamicPricingInput, type BrandAgentEmailMessageInput, type BrandAgentEmailSendBatch, type BrandAgentEmailSendBatchStatus, type BrandAgentEmailSendMessage, type BrandAgentEmailSendMessageStatus, type BrandApp, type BrandAppStatus, type BrandDrop, type BrandDropCtaType, type BrandDropMusicLink, type BrandSubscription, type CheckoutMarketingConsentInput, type CheckoutMarketingConsentPrompt, type ConsentChannel, type ConsentPromptCategory, type ConsentStatus, type ContributionAdmin, type ContributionPageAdmin, type ContributionPageStatusFilter, type ContributionPagesResponse, type ContributionSource, type ContributionStatus, type ContributionsResponse, type CreateBrandAppInput, type CreateManualContributionInput, type CreateMomentOnlineConfigInput, type CreatePartnerBrandDropInput, type CreatePartnerBrandSubscriptionInput, type CreatePartnerBrandSubscriptionResponse, type CreatePartnerMomentInput, type CreatePartnerTicketTierInput, type CreatePlanBudgetInput, type CreatePlanInput, type Currency, DEFAULT_API_URL, type Dimensions, type DimensionsInput, type DynamicPricingActorType, type DynamicPricingAdmissionWindow, type DynamicPricingBatch, type DynamicPricingBatchEvent, type DynamicPricingBatchEventType, type DynamicPricingBatchItem, type DynamicPricingBatchItemStatus, type DynamicPricingBatchStatus, type DynamicPricingContext, type DynamicPricingExecutionMode, type DynamicPricingInventoryGuardInput, type DynamicPricingInventoryGuardMode, type DynamicPricingInventoryMetric, type DynamicPricingMomentInput, type DynamicPricingTierContext, type DynamicPricingTierUpdateInput, type Echo, type EchoMediaAsset, type EchoType, type EditPartnerTicketTiersForMomentInput, type EventImportPlatform, GenqlError, type GetBrandEchoesForUserResponse, type GetMomentLineupsResponse, type GetMomentTagAssignmentsResponse, type GetPartnerAudienceInput, type GetPartnerAudienceResponse, type GetPartnerCustomersResponse, type GetPartnerDropsResponse, type GetPartnerMediaAssetsInput, type GetPartnerMediaAssetsResponse, type GetPartnerMembersInput, type GetPartnerMembersResponse, type GetPartnerMembershipTiersInput, type GetPartnerMembershipTiersResponse, type GetPartnerTicketTiersForMomentInput, type GetPartnerTicketTiersForMomentResponse, type GetPlansInput, type GetPlansResponse, type GetPublicMomentsResponse, type GetTicketsResponse, type ITMPartnerAgentAccessConfig, type ITMPartnerAgentAccessCredentials, type ITMPartnerAgentSessionConfig, type ITMPartnerAgentSessionCredentials, type ITMPartnerClient, type ITMPartnerClientConfig, type ITMPartnerHeaders, type ITMPartnerHeadersObject, type ITMPartnerTokenConfig, type LoginCodeChannel, type ManualContributionReceiptType, type MediaAsset, type MediaAssetUploadUrl, type MembershipBillingInterval, type MembershipExpiryType, type MembershipPassType, type MembershipPurchaseType, type MembershipSource, type MembershipStatus, type MerchPurchase, type Moment, type MomentCategory, type MomentCollection, type MomentCollectionLink, type MomentDiscountCodeUsage, type MomentDynamicPricingPolicy, type MomentDynamicPricingTierRule, type MomentLineup, type MomentLineupDisplayLabel, type MomentLineupResponseResult, type MomentLineupStatus, type MomentLineupType, type MomentOccurrenceScheduleFrequency, type MomentOnlineProvider, type MomentPublicVenuePreview, type MomentSortOrder, type MomentStatus, type MomentSubcategory, type MomentTagAssignment, type MomentType, type MusicReleaseType, type Mutation, type PaginationInput, type PartnerAppLogin, type PartnerAppLoginChallenge, type PartnerAppLoginProfile, type PartnerAudienceCustomer, type PartnerAudienceFiltersInput, type PartnerAudienceSortField, type PartnerAudienceSortInput, type PartnerBrand, type PartnerCustomer, type PartnerMember, type PartnerMemberCustomer, type PartnerMemberTier, type PartnerMembershipTier, type PartnerMomentAttendanceCount, type PartnerMomentAttendanceLookupInput, type PartnerMomentAttendanceStats, type PartnerMomentGuestlistAttendance, type PartnerMomentGuestlistLabelAttendance, type PartnerMomentStats, type PartnerMomentTicketAttendance, type PartnerMomentTicketTierAttendance, type PartnerMomentsFiltersInput, type PartnerTicketStatus, type PartnerTicketTier, type PartnerTicketTierUpdateInput, type PartnerTicketUserLookupInput, type PartnerTicketsForUserInput, type Payment, type PaymentStatus, type Plan, type PlanBudget, type PlanBudgetAllocationType, type PlanBudgetArtistDealBasis, type PlanBudgetArtistDealInput, type PlanBudgetArtistDealType, type PlanBudgetCapacityAllocationInput, type PlanBudgetCategoryInput, type PlanBudgetCategoryKind, type PlanBudgetChargeCalculation, type PlanBudgetChargeKind, type PlanBudgetChargeTreatment, type PlanBudgetExternalTicketingChannelInput, type PlanBudgetFeeAssessment, type PlanBudgetFeeComponentKind, type PlanBudgetFeePercentageBasis, type PlanBudgetGuaranteeBasis, type PlanBudgetLineBasis, type PlanBudgetLineInput, type PlanBudgetPaymentStatus, type PlanBudgetPricingMode, type PlanBudgetSummary, type PlanBudgetTicketChargeRuleInput, type PlanBudgetTicketTierInput, type PlanBudgetTicketingChannelType, type PlanBudgetTicketingFeeComponentInput, type PlanKind, type PlanLinkMetadataStatus, type PlanMoodboard, type PlanMoodboardItem, type PlanMoodboardItemType, type PlanSchedule, type PlanScheduleInput, type PlanScheduleTime, type PlanScheduleTimeInput, type PlanScheduleType, type PlanStatus, type PlanSummary, type PlanningProposal, type PlanningSource, type PlanningSourceDispositionInput, type PlanningSourceSection, type PostSubscriptionEmailInput, type PostSubscriptionMessageInput, type PostSubscriptionPushInput, type PostSubscriptionSmsInput, type PreparePlanningProposalInput, type PublicMomentLineupInfo, type Query, type ReplacePlanBudgetDraftInput, type RespondToMomentLineupInput, type SendPartnerAgentEmailInput, type SortDirection, type StartPartnerAppLoginInput, type SubscriptionComplianceInput, type Tag, type TagSource, type ThirdPartyEchoType, type Ticket, type TicketAdmissionWindowSource, type TicketAttendanceMode, type TicketExtension, type TicketExtensionStatus, type TicketTier, type Transforms, type UpdatePlanInput, type User, type UserSource, type Venue, type VenueInput, type VerifyPartnerAppLoginInput, type VerifyPartnerBrandSubscriptionInput, createITMPartnerClient, everything, generateMutationOp, generateQueryOp };