@stigg/js-client-sdk 0.40.0 → 0.41.0

package/dist/api/generated/types.d.ts

@@ -135,6 +135,10 @@ export declare type AttachCustomerPaymentMethodInput = {
     refId: Scalars['String'];
     vendorIdentifier: VendorIdentifier;
 };
+export declare enum BillingAnchor {
+    StartOfTheMonth = "START_OF_THE_MONTH",
+    SubscriptionStart = "SUBSCRIPTION_START"
+}
 /** Billing model. */
 export declare enum BillingModel {
     FlatFee = "FLAT_FEE",
@@ -292,6 +296,19 @@ export declare type CreateEnvironment = {
     id?: InputMaybe<Scalars['String']>;
     slug?: InputMaybe<Scalars['String']>;
 };
+export declare type CreateEnvironmentOptions = {
+    createDefaultProduct?: InputMaybe<Scalars['Boolean']>;
+};
+export declare type CreateExperimentInput = {
+    controlGroupName: Scalars['String'];
+    description?: InputMaybe<Scalars['String']>;
+    environmentId?: InputMaybe<Scalars['String']>;
+    name: Scalars['String'];
+    productId: Scalars['String'];
+    productSettings?: InputMaybe<ProductSettingsInput>;
+    variantGroupName: Scalars['String'];
+    variantPercentage: Scalars['Float'];
+};
 export declare type CreateHook = {
     createdAt?: InputMaybe<Scalars['DateTime']>;
     description?: InputMaybe<Scalars['String']>;
@@ -318,8 +335,8 @@ export declare type CreateManyPromotionalEntitlementsInput = {
     promotionalEntitlements: Array<PromotionalEntitlementInput>;
 };
 export declare type CreateOneEnvironmentInput = {
-    /** The record to create */
     environment: CreateEnvironment;
+    options?: InputMaybe<CreateEnvironmentOptions>;
 };
 export declare type CreateOneFeatureInput = {
     /** The record to create */
@@ -416,6 +433,7 @@ export declare type CustomerInput = {
     environmentId?: InputMaybe<Scalars['String']>;
     name?: InputMaybe<Scalars['String']>;
     refId: Scalars['String'];
+    shouldSyncFree?: InputMaybe<Scalars['Boolean']>;
 };
 export declare type CustomerSort = {
     direction: SortDirection;
@@ -635,6 +653,7 @@ export declare enum EnvironmentSortFields {
 }
 /** error codes */
 export declare enum ErrorCode {
+    AccountNotFoundError = "AccountNotFoundError",
     AddonHasToHavePriceError = "AddonHasToHavePriceError",
     AddonNotFound = "AddonNotFound",
     ArchivedCouponCantBeApplied = "ArchivedCouponCantBeApplied",
@@ -642,6 +661,7 @@ export declare enum ErrorCode {
     BillingPeriodMissingError = "BillingPeriodMissingError",
     CannotDeleteCustomerError = "CannotDeleteCustomerError",
     CannotDeleteFeatureError = "CannotDeleteFeatureError",
+    CantCreateExperiment = "CantCreateExperiment",
     CheckoutIsNotSupported = "CheckoutIsNotSupported",
     CouponNotFound = "CouponNotFound",
     CustomerHasNoPaymentMethod = "CustomerHasNoPaymentMethod",
@@ -651,6 +671,8 @@ export declare enum ErrorCode {
     DuplicatedEntityNotAllowed = "DuplicatedEntityNotAllowed",
     EditAllowedOnDraftPackageOnlyError = "EditAllowedOnDraftPackageOnlyError",
     EnvironmentMissing = "EnvironmentMissing",
+    ExperimentNotFoundError = "ExperimentNotFoundError",
+    ExperimentStatusError = "ExperimentStatusError",
     FailedToImportCustomer = "FailedToImportCustomer",
     FeatureNotFound = "FeatureNotFound",
     IdentityForbidden = "IdentityForbidden",
@@ -674,6 +696,8 @@ export declare enum ErrorCode {
     PackageAlreadyPublished = "PackageAlreadyPublished",
     PackagePricingTypeNotSet = "PackagePricingTypeNotSet",
     PlanAlreadyExtended = "PlanAlreadyExtended",
+    PlanIsUsedAsDefaultStartPlan = "PlanIsUsedAsDefaultStartPlan",
+    PlanIsUsedAsDowngradePlan = "PlanIsUsedAsDowngradePlan",
     PlanNotFound = "PlanNotFound",
     PlanWithChildCantBeDeleted = "PlanWithChildCantBeDeleted",
     PlansCircularDependencyError = "PlansCircularDependencyError",
@@ -687,7 +711,6 @@ export declare enum ErrorCode {
     SubscriptionNotFound = "SubscriptionNotFound",
     TrialMinDateError = "TrialMinDateError",
     TrialMustBeCancelledImmediately = "TrialMustBeCancelledImmediately",
-    TrialsNotAllowedInProduct = "TrialsNotAllowedInProduct",
     UnPublishedPackage = "UnPublishedPackage",
     Unauthenticated = "Unauthenticated",
     UncompatibleSubscriptionAddon = "UncompatibleSubscriptionAddon",
@@ -738,6 +761,69 @@ export declare enum EventLogType {
     SubscriptionUsageUpdated = "SUBSCRIPTION_USAGE_UPDATED",
     SyncFailed = "SYNC_FAILED"
 }
+export declare type ExperimentFilter = {
+    and?: InputMaybe<Array<ExperimentFilter>>;
+    createdAt?: InputMaybe<DateFieldComparison>;
+    customers?: InputMaybe<ExperimentFilterCustomerFilter>;
+    environmentId?: InputMaybe<StringFieldComparison>;
+    id?: InputMaybe<StringFieldComparison>;
+    name?: InputMaybe<StringFieldComparison>;
+    or?: InputMaybe<Array<ExperimentFilter>>;
+    productId?: InputMaybe<StringFieldComparison>;
+    refId?: InputMaybe<StringFieldComparison>;
+    status?: InputMaybe<ExperimentStatusFilterComparison>;
+};
+export declare type ExperimentFilterCustomerFilter = {
+    and?: InputMaybe<Array<ExperimentFilterCustomerFilter>>;
+    billingId?: InputMaybe<StringFieldComparison>;
+    createdAt?: InputMaybe<DateFieldComparison>;
+    crmHubspotCompanyId?: InputMaybe<StringFieldComparison>;
+    crmHubspotCompanyUrl?: InputMaybe<StringFieldComparison>;
+    crmId?: InputMaybe<StringFieldComparison>;
+    email?: InputMaybe<StringFieldComparison>;
+    environmentId?: InputMaybe<StringFieldComparison>;
+    id?: InputMaybe<StringFieldComparison>;
+    name?: InputMaybe<StringFieldComparison>;
+    or?: InputMaybe<Array<ExperimentFilterCustomerFilter>>;
+    refId?: InputMaybe<StringFieldComparison>;
+    updatedAt?: InputMaybe<DateFieldComparison>;
+};
+export declare type ExperimentSort = {
+    direction: SortDirection;
+    field: ExperimentSortFields;
+    nulls?: InputMaybe<SortNulls>;
+};
+export declare enum ExperimentSortFields {
+    CreatedAt = "createdAt",
+    EnvironmentId = "environmentId",
+    Id = "id",
+    Name = "name",
+    ProductId = "productId",
+    RefId = "refId",
+    Status = "status"
+}
+/** The status of the EXPERIMENT */
+export declare enum ExperimentStatus {
+    Completed = "COMPLETED",
+    Draft = "DRAFT",
+    InProgress = "IN_PROGRESS"
+}
+export declare type ExperimentStatusFilterComparison = {
+    eq?: InputMaybe<ExperimentStatus>;
+    gt?: InputMaybe<ExperimentStatus>;
+    gte?: InputMaybe<ExperimentStatus>;
+    iLike?: InputMaybe<ExperimentStatus>;
+    in?: InputMaybe<Array<ExperimentStatus>>;
+    is?: InputMaybe<Scalars['Boolean']>;
+    isNot?: InputMaybe<Scalars['Boolean']>;
+    like?: InputMaybe<ExperimentStatus>;
+    lt?: InputMaybe<ExperimentStatus>;
+    lte?: InputMaybe<ExperimentStatus>;
+    neq?: InputMaybe<ExperimentStatus>;
+    notILike?: InputMaybe<ExperimentStatus>;
+    notIn?: InputMaybe<Array<ExperimentStatus>>;
+    notLike?: InputMaybe<ExperimentStatus>;
+};
 export declare type FeatureFilter = {
     and?: InputMaybe<Array<FeatureFilter>>;
     createdAt?: InputMaybe<DateFieldComparison>;
@@ -1382,6 +1468,8 @@ export declare type ProductSettingsInput = {
     downgradePlanId?: InputMaybe<Scalars['String']>;
     subscriptionCancellationTime: SubscriptionCancellationTime;
     subscriptionEndSetup: SubscriptionEndSetup;
+    subscriptionStartPlanId?: InputMaybe<Scalars['String']>;
+    subscriptionStartSetup: SubscriptionStartSetup;
 };
 export declare type ProductSort = {
     direction: SortDirection;
@@ -1481,6 +1569,19 @@ export declare type PromotionalEntitlementUpdateInput = {
     usageLimit?: InputMaybe<Scalars['Float']>;
     weeklyResetPeriodConfiguration?: InputMaybe<WeeklyResetPeriodConfigInput>;
 };
+export declare type ProvisionCustomerInput = {
+    additionalMetaData?: InputMaybe<Scalars['JSON']>;
+    billingId?: InputMaybe<Scalars['String']>;
+    billingInformation?: InputMaybe<CustomerBillingInfo>;
+    couponRefId?: InputMaybe<Scalars['String']>;
+    crmId?: InputMaybe<Scalars['String']>;
+    email?: InputMaybe<Scalars['String']>;
+    environmentId?: InputMaybe<Scalars['String']>;
+    name?: InputMaybe<Scalars['String']>;
+    refId: Scalars['String'];
+    shouldSyncFree?: InputMaybe<Scalars['Boolean']>;
+    subscriptionParams?: InputMaybe<SubscriptionBaseInput>;
+};
 /** PublishMigrationType */
 export declare enum PublishMigrationType {
     AllCustomers = "ALL_CUSTOMERS",
@@ -1504,6 +1605,18 @@ export declare type RemoveCouponFromCustomerInput = {
     /** The id of relation. */
     relationId: Scalars['String'];
 };
+export declare type RemoveExperimentFromCustomerInput = {
+    /** The id of the record. */
+    id: Scalars['String'];
+    /** The id of relation. */
+    relationId: Scalars['String'];
+};
+export declare type RemoveExperimentFromCustomerSubscriptionInput = {
+    /** The id of the record. */
+    id: Scalars['String'];
+    /** The id of relation. */
+    relationId: Scalars['String'];
+};
 export declare type ResyncIntegrationInput = {
     environmentId: Scalars['String'];
     vendorIdentifier: VendorIdentifier;
@@ -1526,6 +1639,18 @@ export declare type SetCouponOnCustomerInput = {
     /** The id of relation. */
     relationId: Scalars['String'];
 };
+export declare type SetExperimentOnCustomerInput = {
+    /** The id of the record. */
+    id: Scalars['String'];
+    /** The id of relation. */
+    relationId: Scalars['String'];
+};
+export declare type SetExperimentOnCustomerSubscriptionInput = {
+    /** The id of the record. */
+    id: Scalars['String'];
+    /** The id of relation. */
+    relationId: Scalars['String'];
+};
 /** Sort Directions */
 export declare enum SortDirection {
     Asc = "ASC",
@@ -1540,6 +1665,14 @@ export declare enum SourceType {
     JsClientSdk = "JS_CLIENT_SDK",
     NodeServerSdk = "NODE_SERVER_SDK"
 }
+export declare type StartExperimentInput = {
+    environmentId?: InputMaybe<Scalars['String']>;
+    refId: Scalars['String'];
+};
+export declare type StopExperimentInput = {
+    environmentId?: InputMaybe<Scalars['String']>;
+    refId: Scalars['String'];
+};
 export declare type StringFieldComparison = {
     eq?: InputMaybe<Scalars['String']>;
     gt?: InputMaybe<Scalars['String']>;
@@ -1646,6 +1779,25 @@ export declare enum SubscriptionAddonSortFields {
     Quantity = "quantity",
     UpdatedAt = "updatedAt"
 }
+export declare type SubscriptionBaseInput = {
+    additionalMetaData?: InputMaybe<Scalars['JSON']>;
+    addons?: InputMaybe<Array<SubscriptionAddonInput>>;
+    awaitPaymentConfirmation?: InputMaybe<Scalars['Boolean']>;
+    billingCycleAnchor?: InputMaybe<Scalars['DateTime']>;
+    billingId?: InputMaybe<Scalars['String']>;
+    billingInformation?: InputMaybe<SubscriptionBillingInfo>;
+    billingPeriod?: InputMaybe<BillingPeriod>;
+    crmId?: InputMaybe<Scalars['String']>;
+    currentBillingPeriodEnd?: InputMaybe<Scalars['DateTime']>;
+    endDate?: InputMaybe<Scalars['DateTime']>;
+    isCustomPriceSubscription?: InputMaybe<Scalars['Boolean']>;
+    isOverridingTrialConfig?: InputMaybe<Scalars['Boolean']>;
+    isTrial?: InputMaybe<Scalars['Boolean']>;
+    planId?: InputMaybe<Scalars['String']>;
+    priceUnitAmount?: InputMaybe<Scalars['Float']>;
+    refId?: InputMaybe<Scalars['String']>;
+    startDate?: InputMaybe<Scalars['DateTime']>;
+};
 export declare type SubscriptionBillingInfo = {
     taxRateIds?: InputMaybe<Array<Scalars['String']>>;
 };
@@ -1701,6 +1853,7 @@ export declare type SubscriptionInput = {
     additionalMetaData?: InputMaybe<Scalars['JSON']>;
     addons?: InputMaybe<Array<SubscriptionAddonInput>>;
     awaitPaymentConfirmation?: InputMaybe<Scalars['Boolean']>;
+    billingCycleAnchor?: InputMaybe<Scalars['DateTime']>;
     billingId?: InputMaybe<Scalars['String']>;
     billingInformation?: InputMaybe<SubscriptionBillingInfo>;
     billingPeriod?: InputMaybe<BillingPeriod>;
@@ -1789,6 +1942,11 @@ export declare enum SubscriptionPriceSortFields {
     UpdatedAt = "updatedAt",
     UsageLimit = "usageLimit"
 }
+export declare enum SubscriptionStartSetup {
+    FreePlan = "FREE_PLAN",
+    PlanSelection = "PLAN_SELECTION",
+    TrialPeriod = "TRIAL_PERIOD"
+}
 /** Subscription status */
 export declare enum SubscriptionStatus {
     Active = "ACTIVE",
@@ -1814,6 +1972,13 @@ export declare type SubscriptionStatusFilterComparison = {
     notIn?: InputMaybe<Array<SubscriptionStatus>>;
     notLike?: InputMaybe<SubscriptionStatus>;
 };
+/** Subscription strategy decision */
+export declare enum SubscriptionStrategyDecision {
+    PredefinedFreePlan = "PREDEFINED_FREE_PLAN",
+    PredefinedTrialPlan = "PREDEFINED_TRIAL_PLAN",
+    RequestedPlan = "REQUESTED_PLAN",
+    SkippedSubscriptionCreation = "SKIPPED_SUBSCRIPTION_CREATION"
+}
 /** Status of the integration sync */
 export declare enum SyncStatus {
     Error = "ERROR",
@@ -1872,6 +2037,7 @@ export declare type TaxExempt = {
 };
 export declare type TestHookInput = {
     endpointUrl: Scalars['String'];
+    environmentId: Scalars['String'];
     hookEventType: EventLogType;
 };
 /** day or month. */
@@ -1882,6 +2048,7 @@ export declare enum TrialPeriodUnits {
 export declare type UpdateAccountInput = {
     displayName: Scalars['String'];
     id: Scalars['String'];
+    subscriptionBillingAnchor?: InputMaybe<BillingAnchor>;
     timezone?: InputMaybe<Scalars['String']>;
 };
 export declare type UpdateCouponInput = {
@@ -1909,6 +2076,17 @@ export declare type UpdateEnvironment = {
     id?: InputMaybe<Scalars['String']>;
     slug?: InputMaybe<Scalars['String']>;
 };
+export declare type UpdateExperimentInput = {
+    controlGroupName?: InputMaybe<Scalars['String']>;
+    description?: InputMaybe<Scalars['String']>;
+    environmentId?: InputMaybe<Scalars['String']>;
+    name?: InputMaybe<Scalars['String']>;
+    productId?: InputMaybe<Scalars['String']>;
+    productSettings?: InputMaybe<ProductSettingsInput>;
+    refId?: InputMaybe<Scalars['String']>;
+    variantGroupName?: InputMaybe<Scalars['String']>;
+    variantPercentage?: InputMaybe<Scalars['Float']>;
+};
 export declare type UpdateFeature = {
     createdAt?: InputMaybe<Scalars['DateTime']>;
     description?: InputMaybe<Scalars['String']>;
@@ -2091,6 +2269,11 @@ export declare type ZuoraCredentialsInput = {
     clientId: Scalars['String'];
     clientSecret: Scalars['String'];
 };
+/** The group of the experiment */
+export declare enum ExperimentGroupType {
+    Control = "CONTROL",
+    Variant = "VARIANT"
+}
 export declare type CouponFragment = {
     __typename?: 'Coupon';
     id: string;
@@ -2158,6 +2341,13 @@ export declare type SubscriptionFragment = {
     currentBillingPeriodEnd?: any | null | undefined;
     additionalMetaData?: any | null | undefined;
     pricingType: PricingType;
+    experimentInfo?: {
+        __typename?: 'experimentInfo';
+        name: string;
+        groupName: string;
+        groupType?: ExperimentGroupType | null | undefined;
+        id: string;
+    } | null | undefined;
     prices?: Array<{
         __typename?: 'SubscriptionPrice';
         usageLimit?: number | null | undefined;
@@ -2280,6 +2470,13 @@ export declare type CustomerFragment = {
     hasPaymentMethod: boolean;
     refId: string;
     additionalMetaData?: any | null | undefined;
+    experimentInfo?: {
+        __typename?: 'experimentInfo';
+        name: string;
+        groupType?: ExperimentGroupType | null | undefined;
+        groupName: string;
+        id: string;
+    } | null | undefined;
     trialedPlans?: Array<{
         __typename?: 'TrialedPlan';
         productId?: string | null | undefined;