@moonbase.sh/storefront-api 1.0.37 → 2.0.0

package/dist/index.d.ts

@@ -876,9 +876,9 @@ declare const activationRequestSchema: z.ZodObject<{
     } | undefined;
 }>;
 
-declare const schemas$a_activationRequestSchema: typeof activationRequestSchema;
-declare namespace schemas$a {
-  export { schemas$a_activationRequestSchema as activationRequestSchema };
+declare const schemas$b_activationRequestSchema: typeof activationRequestSchema;
+declare namespace schemas$b {
+  export { schemas$b_activationRequestSchema as activationRequestSchema };
 }
 
 declare enum ActivationRequestFulfillmentType {
@@ -903,6 +903,59 @@ declare class ActivationRequestEndpoints {
     cancel(requestId: string): Promise<ActivationRequest>;
 }
 
+declare const subscribeResponseSchema: z.ZodObject<{
+    status: z.ZodEnum<["subscribed", "confirmation_sent"]>;
+}, "strip", z.ZodTypeAny, {
+    status: "subscribed" | "confirmation_sent";
+}, {
+    status: "subscribed" | "confirmation_sent";
+}>;
+declare const communicationPreferencesViewSchema: z.ZodObject<{
+    email: z.ZodString;
+    name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    newsletter: z.ZodBoolean;
+    productUpdates: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    email: string;
+    newsletter: boolean;
+    productUpdates: boolean;
+    name?: string | null | undefined;
+}, {
+    email: string;
+    newsletter: boolean;
+    productUpdates: boolean;
+    name?: string | null | undefined;
+}>;
+
+declare const schemas$a_communicationPreferencesViewSchema: typeof communicationPreferencesViewSchema;
+declare const schemas$a_subscribeResponseSchema: typeof subscribeResponseSchema;
+declare namespace schemas$a {
+  export { schemas$a_communicationPreferencesViewSchema as communicationPreferencesViewSchema, schemas$a_subscribeResponseSchema as subscribeResponseSchema };
+}
+
+type SubscribeResponse = z.infer<typeof subscribeResponseSchema>;
+type CommunicationPreferencesView = z.infer<typeof communicationPreferencesViewSchema>;
+interface SubscribeInput {
+    email: string;
+    name?: string | null;
+    newsletter?: boolean;
+    productUpdates?: boolean;
+}
+interface CommunicationPreferencesInput {
+    newsletter: boolean;
+    productUpdates: boolean;
+}
+
+declare class CommunicationsEndpoints {
+    private api;
+    constructor(api: MoonbaseApi);
+    subscribe(input: SubscribeInput): Promise<SubscribeResponse>;
+    confirm(email: string, token: string): Promise<void>;
+    getPreferences(email: string, token: string): Promise<CommunicationPreferencesView>;
+    updatePreferences(email: string, token: string, preferences: CommunicationPreferencesInput): Promise<CommunicationPreferencesView>;
+    unsubscribe(email: string, token: string): Promise<void>;
+}
+
 declare const addressSchema: z.ZodObject<{
     countryCode: z.ZodString;
     streetAddress1: z.ZodString;
@@ -927,10 +980,13 @@ declare const addressSchema: z.ZodObject<{
 }>;
 declare const communicationPreferencesSchema: z.ZodObject<{
     newsletterOptIn: z.ZodBoolean;
+    productUpdatesOptIn: z.ZodDefault<z.ZodBoolean>;
 }, "strip", z.ZodTypeAny, {
     newsletterOptIn: boolean;
+    productUpdatesOptIn: boolean;
 }, {
     newsletterOptIn: boolean;
+    productUpdatesOptIn?: boolean | undefined;
 }>;
 declare const ilokConnectedAccountSchema: z.ZodObject<{
     provider: z.ZodLiteral<ConnectableAccountProvider>;
@@ -1001,10 +1057,13 @@ declare const userSchema: z.ZodObject<{
     phone: z.ZodOptional<z.ZodString>;
     communicationPreferences: z.ZodObject<{
         newsletterOptIn: z.ZodBoolean;
+        productUpdatesOptIn: z.ZodDefault<z.ZodBoolean>;
     }, "strip", z.ZodTypeAny, {
         newsletterOptIn: boolean;
+        productUpdatesOptIn: boolean;
     }, {
         newsletterOptIn: boolean;
+        productUpdatesOptIn?: boolean | undefined;
     }>;
     ownedProducts: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
     subscribedProducts: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
@@ -1034,6 +1093,7 @@ declare const userSchema: z.ZodObject<{
     tenantId: string;
     communicationPreferences: {
         newsletterOptIn: boolean;
+        productUpdatesOptIn: boolean;
     };
     connectedAccounts: {
         provider: ConnectableAccountProvider;
@@ -1062,6 +1122,7 @@ declare const userSchema: z.ZodObject<{
     tenantId: string;
     communicationPreferences: {
         newsletterOptIn: boolean;
+        productUpdatesOptIn?: boolean | undefined;
     };
     address?: {
         countryCode: string;
@@ -1114,10 +1175,13 @@ declare const identitySchema: z.ZodIntersection<z.ZodObject<{
     phone: z.ZodOptional<z.ZodString>;
     communicationPreferences: z.ZodObject<{
         newsletterOptIn: z.ZodBoolean;
+        productUpdatesOptIn: z.ZodDefault<z.ZodBoolean>;
     }, "strip", z.ZodTypeAny, {
         newsletterOptIn: boolean;
+        productUpdatesOptIn: boolean;
     }, {
         newsletterOptIn: boolean;
+        productUpdatesOptIn?: boolean | undefined;
     }>;
     ownedProducts: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
     subscribedProducts: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
@@ -1147,6 +1211,7 @@ declare const identitySchema: z.ZodIntersection<z.ZodObject<{
     tenantId: string;
     communicationPreferences: {
         newsletterOptIn: boolean;
+        productUpdatesOptIn: boolean;
     };
     connectedAccounts: {
         provider: ConnectableAccountProvider;
@@ -1175,6 +1240,7 @@ declare const identitySchema: z.ZodIntersection<z.ZodObject<{
     tenantId: string;
     communicationPreferences: {
         newsletterOptIn: boolean;
+        productUpdatesOptIn?: boolean | undefined;
     };
     address?: {
         countryCode: string;
@@ -1206,21 +1272,149 @@ declare const identitySchema: z.ZodIntersection<z.ZodObject<{
     accessToken: string;
     refreshToken: string;
 }>>;
-declare const userAccountConfirmedSchema: z.ZodObject<{
+declare const userAccountConfirmedStatusSchema: z.ZodEnum<["PasswordSetupRequired", "SignedIn"]>;
+declare const userAccountConfirmedSchema: z.ZodIntersection<z.ZodObject<{
     id: z.ZodString;
-    name: z.ZodString;
     email: z.ZodString;
-    resetPasswordToken: z.ZodNullable<z.ZodString>;
+    name: z.ZodString;
+    tenantId: z.ZodString;
+    address: z.ZodOptional<z.ZodObject<{
+        countryCode: z.ZodString;
+        streetAddress1: z.ZodString;
+        streetAddress2: z.ZodNullable<z.ZodString>;
+        locality: z.ZodNullable<z.ZodString>;
+        region: z.ZodNullable<z.ZodString>;
+        postCode: z.ZodNullable<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        countryCode: string;
+        streetAddress1: string;
+        streetAddress2: string | null;
+        locality: string | null;
+        region: string | null;
+        postCode: string | null;
+    }, {
+        countryCode: string;
+        streetAddress1: string;
+        streetAddress2: string | null;
+        locality: string | null;
+        region: string | null;
+        postCode: string | null;
+    }>>;
+    phone: z.ZodOptional<z.ZodString>;
+    communicationPreferences: z.ZodObject<{
+        newsletterOptIn: z.ZodBoolean;
+        productUpdatesOptIn: z.ZodDefault<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        newsletterOptIn: boolean;
+        productUpdatesOptIn: boolean;
+    }, {
+        newsletterOptIn: boolean;
+        productUpdatesOptIn?: boolean | undefined;
+    }>;
+    ownedProducts: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    subscribedProducts: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    confirmedAccount: z.ZodOptional<z.ZodBoolean>;
+    hasProducts: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    hasSubscriptions: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    connectedAccounts: z.ZodDefault<z.ZodArray<z.ZodDiscriminatedUnion<"provider", [z.ZodObject<{
+        provider: z.ZodLiteral<ConnectableAccountProvider>;
+        isConnected: z.ZodBoolean;
+        pendingLicenseFulfillments: z.ZodBoolean;
+        accountId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    }, "strip", z.ZodTypeAny, {
+        provider: ConnectableAccountProvider;
+        isConnected: boolean;
+        pendingLicenseFulfillments: boolean;
+        accountId?: string | null | undefined;
+    }, {
+        provider: ConnectableAccountProvider;
+        isConnected: boolean;
+        pendingLicenseFulfillments: boolean;
+        accountId?: string | null | undefined;
+    }>]>, "many">>;
 }, "strip", z.ZodTypeAny, {
     id: string;
     email: string;
     name: string;
-    resetPasswordToken: string | null;
+    tenantId: string;
+    communicationPreferences: {
+        newsletterOptIn: boolean;
+        productUpdatesOptIn: boolean;
+    };
+    connectedAccounts: {
+        provider: ConnectableAccountProvider;
+        isConnected: boolean;
+        pendingLicenseFulfillments: boolean;
+        accountId?: string | null | undefined;
+    }[];
+    address?: {
+        countryCode: string;
+        streetAddress1: string;
+        streetAddress2: string | null;
+        locality: string | null;
+        region: string | null;
+        postCode: string | null;
+    } | undefined;
+    phone?: string | undefined;
+    ownedProducts?: string[] | undefined;
+    subscribedProducts?: string[] | undefined;
+    confirmedAccount?: boolean | undefined;
+    hasProducts?: boolean | null | undefined;
+    hasSubscriptions?: boolean | null | undefined;
 }, {
     id: string;
     email: string;
     name: string;
-    resetPasswordToken: string | null;
+    tenantId: string;
+    communicationPreferences: {
+        newsletterOptIn: boolean;
+        productUpdatesOptIn?: boolean | undefined;
+    };
+    address?: {
+        countryCode: string;
+        streetAddress1: string;
+        streetAddress2: string | null;
+        locality: string | null;
+        region: string | null;
+        postCode: string | null;
+    } | undefined;
+    phone?: string | undefined;
+    ownedProducts?: string[] | undefined;
+    subscribedProducts?: string[] | undefined;
+    confirmedAccount?: boolean | undefined;
+    hasProducts?: boolean | null | undefined;
+    hasSubscriptions?: boolean | null | undefined;
+    connectedAccounts?: {
+        provider: ConnectableAccountProvider;
+        isConnected: boolean;
+        pendingLicenseFulfillments: boolean;
+        accountId?: string | null | undefined;
+    }[] | undefined;
+}>, z.ZodObject<{
+    status: z.ZodEnum<["PasswordSetupRequired", "SignedIn"]>;
+    resetPasswordToken: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    accessToken: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    refreshToken: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    status: "PasswordSetupRequired" | "SignedIn";
+    accessToken?: string | null | undefined;
+    refreshToken?: string | null | undefined;
+    resetPasswordToken?: string | null | undefined;
+}, {
+    status: "PasswordSetupRequired" | "SignedIn";
+    accessToken?: string | null | undefined;
+    refreshToken?: string | null | undefined;
+    resetPasswordToken?: string | null | undefined;
+}>>;
+declare const pendingActivationSchema: z.ZodObject<{
+    status: z.ZodLiteral<"activation_pending">;
+    email: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    email: string;
+    status: "activation_pending";
+}, {
+    email: string;
+    status: "activation_pending";
 }>;
 
 declare const schemas$9_addressSchema: typeof addressSchema;
@@ -1229,10 +1423,12 @@ declare const schemas$9_connectedAccountSchema: typeof connectedAccountSchema;
 declare const schemas$9_connectionUrlSchema: typeof connectionUrlSchema;
 declare const schemas$9_identitySchema: typeof identitySchema;
 declare const schemas$9_ilokConnectedAccountSchema: typeof ilokConnectedAccountSchema;
+declare const schemas$9_pendingActivationSchema: typeof pendingActivationSchema;
 declare const schemas$9_userAccountConfirmedSchema: typeof userAccountConfirmedSchema;
+declare const schemas$9_userAccountConfirmedStatusSchema: typeof userAccountConfirmedStatusSchema;
 declare const schemas$9_userSchema: typeof userSchema;
 declare namespace schemas$9 {
-  export { schemas$9_addressSchema as addressSchema, schemas$9_communicationPreferencesSchema as communicationPreferencesSchema, schemas$9_connectedAccountSchema as connectedAccountSchema, schemas$9_connectionUrlSchema as connectionUrlSchema, schemas$9_identitySchema as identitySchema, schemas$9_ilokConnectedAccountSchema as ilokConnectedAccountSchema, schemas$9_userAccountConfirmedSchema as userAccountConfirmedSchema, schemas$9_userSchema as userSchema };
+  export { schemas$9_addressSchema as addressSchema, schemas$9_communicationPreferencesSchema as communicationPreferencesSchema, schemas$9_connectedAccountSchema as connectedAccountSchema, schemas$9_connectionUrlSchema as connectionUrlSchema, schemas$9_identitySchema as identitySchema, schemas$9_ilokConnectedAccountSchema as ilokConnectedAccountSchema, schemas$9_pendingActivationSchema as pendingActivationSchema, schemas$9_userAccountConfirmedSchema as userAccountConfirmedSchema, schemas$9_userAccountConfirmedStatusSchema as userAccountConfirmedStatusSchema, schemas$9_userSchema as userSchema };
 }
 
 type CommunicationPreferences = z.infer<typeof communicationPreferencesSchema>;
@@ -1243,7 +1439,15 @@ type ConnectedAccount = z.infer<typeof connectedAccountSchema>;
 type User = z.infer<typeof userSchema>;
 type Identity = z.infer<typeof identitySchema>;
 type Address = z.infer<typeof addressSchema>;
+type UserAccountConfirmedStatus = z.infer<typeof userAccountConfirmedStatusSchema>;
 type UserAccountConfirmed = z.infer<typeof userAccountConfirmedSchema>;
+type SignUpResult = {
+    status: 'signed-in';
+    user: User;
+} | {
+    status: 'activation-pending';
+    email: string;
+};
 
 declare class IdentityEndpoints {
     private api;
@@ -1252,7 +1456,7 @@ declare class IdentityEndpoints {
     constructor(api: MoonbaseApi, tokenStore: ITokenStore, logger: ILogger);
     get(): Promise<User>;
     signIn(email: string, password: string): Promise<User>;
-    signUp(name: string, email: string, password: string, address: Address | null | undefined, acceptedPrivacyPolicy: boolean, acceptedTermsAndConditions: boolean, communicationOptIn?: boolean): Promise<User>;
+    signUp(name: string, email: string, password: string, address: Address | null | undefined, acceptedPrivacyPolicy: boolean, acceptedTermsAndConditions: boolean, communicationOptIn?: boolean): Promise<SignUpResult>;
     signOut(): Promise<void>;
     update(name: string, email: string, emailConfirmationToken?: string, communicationPreferences?: CommunicationPreferences): Promise<{
         needsEmailConfirmationToken: boolean;
@@ -1263,6 +1467,7 @@ declare class IdentityEndpoints {
             tenantId: string;
             communicationPreferences: {
                 newsletterOptIn: boolean;
+                productUpdatesOptIn: boolean;
             };
             connectedAccounts: {
                 provider: ConnectableAccountProvider;
@@ -38149,7 +38354,7 @@ declare namespace schemas$1 {
 }
 
 declare namespace schemas {
-  export { schemas$a as activationRequests, schemas$9 as identity, schemas$2 as inventory, schemas$5 as orders, schemas$1 as storefront, schemas$4 as vendor, schemas$3 as vouchers };
+  export { schemas$b as activationRequests, schemas$a as communications, schemas$9 as identity, schemas$2 as inventory, schemas$5 as orders, schemas$1 as storefront, schemas$4 as vendor, schemas$3 as vouchers };
 }
 
 type StorefrontProduct = z.infer<typeof storefrontProductSchema>;
@@ -38231,6 +38436,7 @@ declare class MoonbaseClient {
     api: MoonbaseApi;
     storefront: StorefrontEndpoints;
     identity: IdentityEndpoints;
+    communications: CommunicationsEndpoints;
     vouchers: VoucherEndpoints;
     activationRequests: ActivationRequestEndpoints;
     inventory: InventoryEndpoints;
@@ -38238,4 +38444,4 @@ declare class MoonbaseClient {
     orders: OrderEndpoints;
 }
 
-export { type Activation, ActivationMethod, type ActivationRequest, ActivationRequestFulfillmentType, ActivationRequestStatus, ActivationStatus, type Address, type BundleLineItem, type CommunicationPreferences, type CompletedOrder, ConnectableAccountProvider, type ConnectedAccount, ConsoleLogger, CycleLength, type Discount, DiscountUtils, type Download, type DownloadManifest, type ILogger, type IRecurrence, type IStore, type ITokenStore, type Identity, InMemoryStore, type License, LicenseStatus, type LineItem, LocalStorageStore, LogLevel, MarketingConsentType, type MilestoneProgress, type Money, type MoneyCollection, MoneyCollectionUtils, MoonbaseApi, MoonbaseClient, type MoonbaseConfiguration, MoonbaseError, NotAuthenticatedError, NotAuthorizedError, NotFoundError, type OfferCondition, OfferUtils, type OpenOrder, type Order, OrderStatus, type OwnedProduct, type Page, Platform, type PricingTier, type PricingVariation, type ProblemDetails, type ProductLineItem, type Quantifiable, type RawPropertyObject, type RawPropertyValue, type SingleOrMultiple, type Storefront, type StorefrontBundle, type StorefrontOffer, type StorefrontProduct, type Subscription, SubscriptionStatus, type TaxEstimate, TokenStore, type UrchinTrackingModule, type User, type UserAccountConfirmed, type Vendor, type Voucher, objectToQuery, problemDetailsSchema, schemas, utmToObject };
+export { type Activation, ActivationMethod, type ActivationRequest, ActivationRequestFulfillmentType, ActivationRequestStatus, ActivationStatus, type Address, type BundleLineItem, type CommunicationPreferences, type CommunicationPreferencesInput, type CommunicationPreferencesView, type CompletedOrder, ConnectableAccountProvider, type ConnectedAccount, ConsoleLogger, CycleLength, type Discount, DiscountUtils, type Download, type DownloadManifest, type ILogger, type IRecurrence, type IStore, type ITokenStore, type Identity, InMemoryStore, type License, LicenseStatus, type LineItem, LocalStorageStore, LogLevel, MarketingConsentType, type MilestoneProgress, type Money, type MoneyCollection, MoneyCollectionUtils, MoonbaseApi, MoonbaseClient, type MoonbaseConfiguration, MoonbaseError, NotAuthenticatedError, NotAuthorizedError, NotFoundError, type OfferCondition, OfferUtils, type OpenOrder, type Order, OrderStatus, type OwnedProduct, type Page, Platform, type PricingTier, type PricingVariation, type ProblemDetails, type ProductLineItem, type Quantifiable, type RawPropertyObject, type RawPropertyValue, type SignUpResult, type SingleOrMultiple, type Storefront, type StorefrontBundle, type StorefrontOffer, type StorefrontProduct, type SubscribeInput, type SubscribeResponse, type Subscription, SubscriptionStatus, type TaxEstimate, TokenStore, type UrchinTrackingModule, type User, type UserAccountConfirmed, type UserAccountConfirmedStatus, type Vendor, type Voucher, objectToQuery, problemDetailsSchema, schemas, utmToObject };