@stigg/js-client-sdk 0.34.1 → 0.36.0

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

@@ -22,6 +22,8 @@ export declare type Scalars = {
     ConnectionCursor: any;
     /** A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format. */
     DateTime: any;
+    /** The `JSON` scalar type represents JSON values as specified by [ECMA-404](http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf). */
+    JSON: any;
 };
 /** DenyReason of get access policy */
 export declare enum AccessDeniedReason {
@@ -39,6 +41,7 @@ export declare type AddCompatibleAddonsToPlanInput = {
     relationIds: Array<Scalars['String']>;
 };
 export declare type AddonCreateInput = {
+    additionalMetaData?: InputMaybe<Scalars['JSON']>;
     billingId?: InputMaybe<Scalars['String']>;
     description?: InputMaybe<Scalars['String']>;
     displayName: Scalars['String'];
@@ -85,6 +88,7 @@ export declare enum AddonSortFields {
     VersionNumber = "versionNumber"
 }
 export declare type AddonUpdateInput = {
+    additionalMetaData?: InputMaybe<Scalars['JSON']>;
     billingId?: InputMaybe<Scalars['String']>;
     description?: InputMaybe<Scalars['String']>;
     displayName: Scalars['String'];
@@ -121,6 +125,12 @@ export declare type ArchivePlanInput = {
     environmentId: Scalars['String'];
     id: Scalars['String'];
 };
+export declare type AttachCustomerPaymentMethodInput = {
+    environmentId?: InputMaybe<Scalars['String']>;
+    paymentMethodId: Scalars['String'];
+    refId: Scalars['String'];
+    vendorIdentifier: VendorIdentifier;
+};
 /** Billing model. */
 export declare enum BillingModel {
     FlatFee = "FLAT_FEE",
@@ -173,10 +183,6 @@ export declare enum ChangeType {
     Deleted = "DELETED",
     Modified = "MODIFIED"
 }
-export declare type CheckoutAddonInput = {
-    addonId: Scalars['String'];
-    quantity?: InputMaybe<Scalars['Int']>;
-};
 export declare type CreateEnvironment = {
     createdAt?: InputMaybe<Scalars['DateTime']>;
     description?: InputMaybe<Scalars['String']>;
@@ -255,6 +261,8 @@ export declare type CustomerFilter = {
     and?: InputMaybe<Array<CustomerFilter>>;
     billingId?: InputMaybe<StringFieldComparison>;
     createdAt?: InputMaybe<DateFieldComparison>;
+    crmHubspotCompanyId?: InputMaybe<StringFieldComparison>;
+    crmHubspotCompanyUrl?: InputMaybe<StringFieldComparison>;
     crmId?: InputMaybe<StringFieldComparison>;
     email?: InputMaybe<StringFieldComparison>;
     environmentId?: InputMaybe<StringFieldComparison>;
@@ -273,6 +281,7 @@ export declare type CustomerFilterCustomerSubscriptionFilter = {
     cancellationDate?: InputMaybe<DateFieldComparison>;
     createdAt?: InputMaybe<DateFieldComparison>;
     crmId?: InputMaybe<StringFieldComparison>;
+    crmLinkUrl?: InputMaybe<StringFieldComparison>;
     effectiveEndDate?: InputMaybe<DateFieldComparison>;
     endDate?: InputMaybe<DateFieldComparison>;
     environmentId?: InputMaybe<StringFieldComparison>;
@@ -294,6 +303,7 @@ export declare type CustomerFilterPromotionalEntitlementFilter = {
     updatedAt?: InputMaybe<DateFieldComparison>;
 };
 export declare type CustomerInput = {
+    additionalMetaData?: InputMaybe<Scalars['JSON']>;
     billingId?: InputMaybe<Scalars['String']>;
     billingInformation?: InputMaybe<CustomerBillingInfo>;
     crmId?: InputMaybe<Scalars['String']>;
@@ -310,6 +320,8 @@ export declare type CustomerSort = {
 export declare enum CustomerSortFields {
     BillingId = "billingId",
     CreatedAt = "createdAt",
+    CrmHubspotCompanyId = "crmHubspotCompanyId",
+    CrmHubspotCompanyUrl = "crmHubspotCompanyUrl",
     CrmId = "crmId",
     Email = "email",
     EnvironmentId = "environmentId",
@@ -326,6 +338,7 @@ export declare type CustomerSubscriptionFilter = {
     cancellationDate?: InputMaybe<DateFieldComparison>;
     createdAt?: InputMaybe<DateFieldComparison>;
     crmId?: InputMaybe<StringFieldComparison>;
+    crmLinkUrl?: InputMaybe<StringFieldComparison>;
     customer?: InputMaybe<CustomerSubscriptionFilterCustomerFilter>;
     effectiveEndDate?: InputMaybe<DateFieldComparison>;
     endDate?: InputMaybe<DateFieldComparison>;
@@ -343,6 +356,8 @@ export declare type CustomerSubscriptionFilterCustomerFilter = {
     and?: InputMaybe<Array<CustomerSubscriptionFilterCustomerFilter>>;
     billingId?: InputMaybe<StringFieldComparison>;
     createdAt?: InputMaybe<DateFieldComparison>;
+    crmHubspotCompanyId?: InputMaybe<StringFieldComparison>;
+    crmHubspotCompanyUrl?: InputMaybe<StringFieldComparison>;
     crmId?: InputMaybe<StringFieldComparison>;
     email?: InputMaybe<StringFieldComparison>;
     environmentId?: InputMaybe<StringFieldComparison>;
@@ -379,6 +394,7 @@ export declare enum CustomerSubscriptionSortFields {
     CancellationDate = "cancellationDate",
     CreatedAt = "createdAt",
     CrmId = "crmId",
+    CrmLinkUrl = "crmLinkUrl",
     EffectiveEndDate = "effectiveEndDate",
     EndDate = "endDate",
     EnvironmentId = "environmentId",
@@ -489,6 +505,10 @@ export declare enum EntitlementResetPeriod {
     Month = "MONTH",
     Week = "WEEK"
 }
+export declare enum EntitySelectionMode {
+    BlackList = "BLACK_LIST",
+    WhiteList = "WHITE_LIST"
+}
 export declare type EnvironmentFilter = {
     and?: InputMaybe<Array<EnvironmentFilter>>;
     createdAt?: InputMaybe<DateFieldComparison>;
@@ -515,6 +535,7 @@ export declare enum ErrorCode {
     BillingPeriodMissingError = "BillingPeriodMissingError",
     CheckoutIsNotSupported = "CheckoutIsNotSupported",
     CustomerHasNoPaymentMethod = "CustomerHasNoPaymentMethod",
+    CustomerNoBillingId = "CustomerNoBillingId",
     CustomerNotFound = "CustomerNotFound",
     DraftPlanCantBeArchived = "DraftPlanCantBeArchived",
     DuplicatedEntityNotAllowed = "DuplicatedEntityNotAllowed",
@@ -523,12 +544,16 @@ export declare enum ErrorCode {
     FailedToImportCustomer = "FailedToImportCustomer",
     FeatureNotFound = "FeatureNotFound",
     IdentityForbidden = "IdentityForbidden",
+    ImportAlreadyInProgress = "ImportAlreadyInProgress",
+    InitStripePaymentMethodError = "InitStripePaymentMethodError",
+    IntegrationNotFound = "IntegrationNotFound",
     IntegrityViolation = "IntegrityViolation",
     InvalidAddressError = "InvalidAddressError",
     InvalidArgumentError = "InvalidArgumentError",
     InvalidCancellationDate = "InvalidCancellationDate",
     InvalidEntitlementResetPeriod = "InvalidEntitlementResetPeriod",
     InvalidMemberDelete = "InvalidMemberDelete",
+    InvalidQuantity = "InvalidQuantity",
     InvalidSubscriptionStatus = "InvalidSubscriptionStatus",
     InvalidUsageValueForIncrementalFeatureError = "InvalidUsageValueForIncrementalFeatureError",
     MemberInvitationError = "MemberInvitationError",
@@ -543,10 +568,13 @@ export declare enum ErrorCode {
     PlansCircularDependencyError = "PlansCircularDependencyError",
     PriceNotFound = "PriceNotFound",
     RateLimitExceeded = "RateLimitExceeded",
+    ResyncAlreadyInProgress = "ResyncAlreadyInProgress",
+    StripeCustomerIsDeleted = "StripeCustomerIsDeleted",
     SubscriptionAlreadyCanceledOrExpired = "SubscriptionAlreadyCanceledOrExpired",
+    SubscriptionMustHaveSinglePlanError = "SubscriptionMustHaveSinglePlanError",
     SubscriptionNotFound = "SubscriptionNotFound",
-    TrialMustBeCancelledImmediately = "TrialMustBeCancelledImmediately",
     TrialMinDateError = "TrialMinDateError",
+    TrialMustBeCancelledImmediately = "TrialMustBeCancelledImmediately",
     TrialsNotAllowedInProduct = "TrialsNotAllowedInProduct",
     UnPublishedPackage = "UnPublishedPackage",
     Unauthenticated = "Unauthenticated",
@@ -570,6 +598,8 @@ export declare enum EventLogType {
     FeatureCreated = "FEATURE_CREATED",
     FeatureDeleted = "FEATURE_DELETED",
     FeatureUpdated = "FEATURE_UPDATED",
+    ImportIntegrationCatalogTriggered = "IMPORT_INTEGRATION_CATALOG_TRIGGERED",
+    ImportIntegrationCustomersTriggered = "IMPORT_INTEGRATION_CUSTOMERS_TRIGGERED",
     MeasurementReported = "MEASUREMENT_REPORTED",
     PackagePublished = "PACKAGE_PUBLISHED",
     PlanCreated = "PLAN_CREATED",
@@ -579,6 +609,7 @@ export declare enum EventLogType {
     PromotionalEntitlementGranted = "PROMOTIONAL_ENTITLEMENT_GRANTED",
     PromotionalEntitlementRevoked = "PROMOTIONAL_ENTITLEMENT_REVOKED",
     PromotionalEntitlementUpdated = "PROMOTIONAL_ENTITLEMENT_UPDATED",
+    ResyncIntegrationTriggered = "RESYNC_INTEGRATION_TRIGGERED",
     SubscriptionCanceled = "SUBSCRIPTION_CANCELED",
     SubscriptionCreated = "SUBSCRIPTION_CREATED",
     SubscriptionExpired = "SUBSCRIPTION_EXPIRED",
@@ -586,7 +617,8 @@ export declare enum EventLogType {
     SubscriptionTrialEndsSoon = "SUBSCRIPTION_TRIAL_ENDS_SOON",
     SubscriptionTrialExpired = "SUBSCRIPTION_TRIAL_EXPIRED",
     SubscriptionTrialStarted = "SUBSCRIPTION_TRIAL_STARTED",
-    SubscriptionUpdated = "SUBSCRIPTION_UPDATED"
+    SubscriptionUpdated = "SUBSCRIPTION_UPDATED",
+    SubscriptionUsageUpdated = "SUBSCRIPTION_USAGE_UPDATED"
 }
 export declare type FeatureFilter = {
     and?: InputMaybe<Array<FeatureFilter>>;
@@ -741,8 +773,50 @@ export declare type ImportCustomerInput = {
     name?: InputMaybe<Scalars['String']>;
     refId: Scalars['String'];
 };
+export declare type ImportIntegrationCatalogInput = {
+    entitySelectionMode: EntitySelectionMode;
+    environmentId: Scalars['String'];
+    plansSelectionBlacklist?: InputMaybe<Array<Scalars['String']>>;
+    plansSelectionWhitelist?: InputMaybe<Array<Scalars['String']>>;
+    productId: Scalars['String'];
+    selectedAddonBillingIds: Array<Scalars['String']>;
+    vendorIdentifier: VendorIdentifier;
+};
+export declare type ImportIntegrationCustomersInput = {
+    customersSelectionBlacklist?: InputMaybe<Array<Scalars['String']>>;
+    customersSelectionWhitelist?: InputMaybe<Array<Scalars['String']>>;
+    entitySelectionMode: EntitySelectionMode;
+    environmentId: Scalars['String'];
+    productId: Scalars['String'];
+    vendorIdentifier: VendorIdentifier;
+};
+export declare type ImportIntegrationTaskFilter = {
+    and?: InputMaybe<Array<ImportIntegrationTaskFilter>>;
+    createdAt?: InputMaybe<DateFieldComparison>;
+    environmentId?: InputMaybe<StringFieldComparison>;
+    id?: InputMaybe<StringFieldComparison>;
+    or?: InputMaybe<Array<ImportIntegrationTaskFilter>>;
+    status?: InputMaybe<TaskStatusFilterComparison>;
+    taskType?: InputMaybe<TaskTypeFilterComparison>;
+};
+export declare type ImportIntegrationTaskSort = {
+    direction: SortDirection;
+    field: ImportIntegrationTaskSortFields;
+    nulls?: InputMaybe<SortNulls>;
+};
+export declare enum ImportIntegrationTaskSortFields {
+    CreatedAt = "createdAt",
+    EnvironmentId = "environmentId",
+    Id = "id",
+    Status = "status",
+    TaskType = "taskType"
+}
+export declare type InitAddStripeCustomerPaymentMethodInput = {
+    customerRefId: Scalars['String'];
+    environmentId?: InputMaybe<Scalars['String']>;
+};
 export declare type InitiateCheckoutInput = {
-    addons?: InputMaybe<Array<CheckoutAddonInput>>;
+    addons?: InputMaybe<Array<SubscriptionAddonInput>>;
     billingPeriod: BillingPeriod;
     cancelUrl: Scalars['String'];
     customerId: Scalars['String'];
@@ -1001,7 +1075,13 @@ export declare type PackageStatusFilterComparison = {
     notIn?: InputMaybe<Array<PackageStatus>>;
     notLike?: InputMaybe<PackageStatus>;
 };
+/** Type of a payment method */
+export declare enum PaymentMethodType {
+    Bank = "BANK",
+    Card = "CARD"
+}
 export declare type PlanCreateInput = {
+    additionalMetaData?: InputMaybe<Scalars['JSON']>;
     billingId?: InputMaybe<Scalars['String']>;
     description?: InputMaybe<Scalars['String']>;
     displayName: Scalars['String'];
@@ -1080,6 +1160,7 @@ export declare enum PlanSortFields {
     VersionNumber = "versionNumber"
 }
 export declare type PlanUpdateInput = {
+    additionalMetaData?: InputMaybe<Scalars['JSON']>;
     billingId?: InputMaybe<Scalars['String']>;
     defaultTrialConfig?: InputMaybe<DefaultTrialConfigInputDto>;
     description?: InputMaybe<Scalars['String']>;
@@ -1157,6 +1238,7 @@ export declare type PricingTypeFilterComparison = {
     notLike?: InputMaybe<PricingType>;
 };
 export declare type ProductCreateInput = {
+    additionalMetaData?: InputMaybe<Scalars['JSON']>;
     description?: InputMaybe<Scalars['String']>;
     displayName?: InputMaybe<Scalars['String']>;
     environmentId: Scalars['String'];
@@ -1195,6 +1277,7 @@ export declare enum ProductSortFields {
     UpdatedAt = "updatedAt"
 }
 export declare type ProductUpdateInput = {
+    additionalMetaData?: InputMaybe<Scalars['JSON']>;
     description?: InputMaybe<Scalars['String']>;
     displayName?: InputMaybe<Scalars['String']>;
     productSettings?: InputMaybe<ProductSettingsInput>;
@@ -1293,6 +1376,10 @@ export declare type RemoveCompatibleAddonsFromPlanInput = {
     /** The ids of the relations. */
     relationIds: Array<Scalars['String']>;
 };
+export declare type ResyncIntegrationInput = {
+    environmentId: Scalars['String'];
+    vendorIdentifier: VendorIdentifier;
+};
 export declare type SetBasePlanOnPlanInput = {
     /** The id of the record. */
     id: Scalars['String'];
@@ -1336,6 +1423,20 @@ export declare type StripeCredentialsInput = {
     authorizationCode: Scalars['String'];
     isTestMode: Scalars['Boolean'];
 };
+export declare type StripeCustomerSearchInput = {
+    customerName?: InputMaybe<Scalars['String']>;
+    environmentId: Scalars['String'];
+    nextPage?: InputMaybe<Scalars['String']>;
+};
+export declare type StripeProductSearchInput = {
+    environmentId: Scalars['String'];
+    nextPage?: InputMaybe<Scalars['String']>;
+    productName?: InputMaybe<Scalars['String']>;
+};
+export declare type StripeSubscriptionSearchInput = {
+    environmentId: Scalars['String'];
+    nextPage?: InputMaybe<Scalars['String']>;
+};
 export declare type SubscriptionAddonFilter = {
     addon?: InputMaybe<SubscriptionAddonFilterAddonFilter>;
     and?: InputMaybe<Array<SubscriptionAddonFilter>>;
@@ -1371,6 +1472,7 @@ export declare type SubscriptionAddonFilterCustomerSubscriptionFilter = {
     cancellationDate?: InputMaybe<DateFieldComparison>;
     createdAt?: InputMaybe<DateFieldComparison>;
     crmId?: InputMaybe<StringFieldComparison>;
+    crmLinkUrl?: InputMaybe<StringFieldComparison>;
     effectiveEndDate?: InputMaybe<DateFieldComparison>;
     endDate?: InputMaybe<DateFieldComparison>;
     environmentId?: InputMaybe<StringFieldComparison>;
@@ -1413,6 +1515,7 @@ export declare enum SubscriptionCancelReason {
     Expired = "Expired",
     Immediate = "Immediate",
     PendingPaymentExpired = "PendingPaymentExpired",
+    ScheduledCancellation = "ScheduledCancellation",
     TrialConverted = "TrialConverted",
     TrialEnded = "TrialEnded",
     UpgradeOrDowngrade = "UpgradeOrDowngrade"
@@ -1454,7 +1557,9 @@ export declare enum SubscriptionEndSetup {
     DowngradeToFree = "DOWNGRADE_TO_FREE"
 }
 export declare type SubscriptionInput = {
+    additionalMetaData?: InputMaybe<Scalars['JSON']>;
     addons?: InputMaybe<Array<SubscriptionAddonInput>>;
+    awaitPaymentConfirmation?: InputMaybe<Scalars['Boolean']>;
     billingId?: InputMaybe<Scalars['String']>;
     billingPeriod?: InputMaybe<BillingPeriod>;
     crmId?: InputMaybe<Scalars['String']>;
@@ -1511,6 +1616,7 @@ export declare type SubscriptionPriceFilterCustomerSubscriptionFilter = {
     cancellationDate?: InputMaybe<DateFieldComparison>;
     createdAt?: InputMaybe<DateFieldComparison>;
     crmId?: InputMaybe<StringFieldComparison>;
+    crmLinkUrl?: InputMaybe<StringFieldComparison>;
     effectiveEndDate?: InputMaybe<DateFieldComparison>;
     endDate?: InputMaybe<DateFieldComparison>;
     environmentId?: InputMaybe<StringFieldComparison>;
@@ -1566,11 +1672,18 @@ export declare type SubscriptionStatusFilterComparison = {
     notIn?: InputMaybe<Array<SubscriptionStatus>>;
     notLike?: InputMaybe<SubscriptionStatus>;
 };
+/** Status of the integration sync */
+export declare enum SyncStatus {
+    Error = "ERROR",
+    NoSyncRequired = "NO_SYNC_REQUIRED",
+    Pending = "PENDING",
+    Success = "SUCCESS"
+}
 export declare enum TaskStatus {
     Completed = "COMPLETED",
     Failed = "FAILED",
     InProgress = "IN_PROGRESS",
-    PartiallyCompleted = "PARTIALLY_COMPLETED",
+    PartiallyFailed = "PARTIALLY_FAILED",
     Pending = "PENDING"
 }
 export declare type TaskStatusFilterComparison = {
@@ -1590,6 +1703,9 @@ export declare type TaskStatusFilterComparison = {
     notLike?: InputMaybe<TaskStatus>;
 };
 export declare enum TaskType {
+    ImportIntegrationCatalog = "IMPORT_INTEGRATION_CATALOG",
+    ImportIntegrationCustomers = "IMPORT_INTEGRATION_CUSTOMERS",
+    ResyncIntegration = "RESYNC_INTEGRATION",
     SubscriptionMigration = "SUBSCRIPTION_MIGRATION"
 }
 export declare type TaskTypeFilterComparison = {
@@ -1621,7 +1737,13 @@ export declare enum TrialPeriodUnits {
     Day = "DAY",
     Month = "MONTH"
 }
+export declare type UpdateAccountInput = {
+    displayName: Scalars['String'];
+    id: Scalars['String'];
+    timezone?: InputMaybe<Scalars['String']>;
+};
 export declare type UpdateCustomerInput = {
+    additionalMetaData?: InputMaybe<Scalars['JSON']>;
     billingId?: InputMaybe<Scalars['String']>;
     billingInformation?: InputMaybe<CustomerBillingInfo>;
     crmId?: InputMaybe<Scalars['String']>;
@@ -1708,6 +1830,11 @@ export declare type UpdateOnePromotionalEntitlementInput = {
     /** The update to apply. */
     update: PromotionalEntitlementUpdateInput;
 };
+export declare type UpdateSubscriptionInput = {
+    additionalMetaData?: InputMaybe<Scalars['JSON']>;
+    environmentId?: InputMaybe<Scalars['String']>;
+    refId: Scalars['String'];
+};
 export declare type UsageHistoryInput = {
     customerRefId: Scalars['String'];
     endDate?: InputMaybe<Scalars['DateTime']>;
@@ -1738,6 +1865,8 @@ export declare type UsageMeasurementFilterCustomerFilter = {
     and?: InputMaybe<Array<UsageMeasurementFilterCustomerFilter>>;
     billingId?: InputMaybe<StringFieldComparison>;
     createdAt?: InputMaybe<DateFieldComparison>;
+    crmHubspotCompanyId?: InputMaybe<StringFieldComparison>;
+    crmHubspotCompanyUrl?: InputMaybe<StringFieldComparison>;
     crmId?: InputMaybe<StringFieldComparison>;
     email?: InputMaybe<StringFieldComparison>;
     environmentId?: InputMaybe<StringFieldComparison>;
@@ -1818,9 +1947,11 @@ export declare type SubscriptionFragment = {
     endDate?: any | null | undefined;
     trialEndDate?: any | null | undefined;
     cancellationDate?: any | null | undefined;
+    effectiveEndDate?: any | null | undefined;
     status: SubscriptionStatus;
     refId: string;
     currentBillingPeriodEnd?: any | null | undefined;
+    additionalMetaData?: any | null | undefined;
     pricingType: PricingType;
     prices?: Array<{
         __typename?: 'SubscriptionPrice';
@@ -1835,6 +1966,7 @@ export declare type SubscriptionFragment = {
         refId: string;
         displayName: string;
         description?: string | null | undefined;
+        additionalMetaData?: any | null | undefined;
         product: {
             __typename?: 'Product';
             refId: string;
@@ -1890,6 +2022,7 @@ export declare type SubscriptionFragment = {
             refId: string;
             displayName: string;
             description?: string | null | undefined;
+            additionalMetaData?: any | null | undefined;
             entitlements?: Array<{
                 __typename?: 'PackageEntitlement';
                 usageLimit?: number | null | undefined;
@@ -1938,6 +2071,14 @@ export declare type CustomerFragment = {
     updatedAt: any;
     hasPaymentMethod: boolean;
     refId: string;
+    additionalMetaData?: any | null | undefined;
+    trialedPlans?: Array<{
+        __typename?: 'TrialedPlan';
+        productId?: string | null | undefined;
+        productRefId?: string | null | undefined;
+        planRefId?: string | null | undefined;
+        planId?: string | null | undefined;
+    }> | null | undefined;
     promotionalEntitlements: Array<{
         __typename?: 'PromotionalEntitlement';
     } & PromotionalEntitlementFragment>;
@@ -2043,6 +2184,7 @@ export declare type AddonFragment = {
     refId: string;
     displayName: string;
     description?: string | null | undefined;
+    additionalMetaData?: any | null | undefined;
     pricingType?: PricingType | null | undefined;
     entitlements?: Array<{
         __typename?: 'PackageEntitlement';
@@ -2057,12 +2199,14 @@ export declare type PlanFragment = {
     refId: string;
     description?: string | null | undefined;
     displayName: string;
+    additionalMetaData?: any | null | undefined;
     pricingType?: PricingType | null | undefined;
     product: {
         __typename?: 'Product';
         refId: string;
         displayName?: string | null | undefined;
         description?: string | null | undefined;
+        additionalMetaData?: any | null | undefined;
     };
     basePlan?: {
         __typename?: 'Plan';