@stigg/js-client-sdk 0.34.0 → 0.35.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 {
@@ -85,6 +87,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'];
@@ -173,10 +176,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 +254,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 +274,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 +296,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 +313,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 +331,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 +349,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 +387,7 @@ export declare enum CustomerSubscriptionSortFields {
     CancellationDate = "cancellationDate",
     CreatedAt = "createdAt",
     CrmId = "crmId",
+    CrmLinkUrl = "crmLinkUrl",
     EffectiveEndDate = "effectiveEndDate",
     EndDate = "endDate",
     EnvironmentId = "environmentId",
@@ -523,12 +532,14 @@ export declare enum ErrorCode {
     FailedToImportCustomer = "FailedToImportCustomer",
     FeatureNotFound = "FeatureNotFound",
     IdentityForbidden = "IdentityForbidden",
+    IntegrationNotFound = "IntegrationNotFound",
     IntegrityViolation = "IntegrityViolation",
     InvalidAddressError = "InvalidAddressError",
     InvalidArgumentError = "InvalidArgumentError",
     InvalidCancellationDate = "InvalidCancellationDate",
     InvalidEntitlementResetPeriod = "InvalidEntitlementResetPeriod",
     InvalidMemberDelete = "InvalidMemberDelete",
+    InvalidQuantity = "InvalidQuantity",
     InvalidSubscriptionStatus = "InvalidSubscriptionStatus",
     InvalidUsageValueForIncrementalFeatureError = "InvalidUsageValueForIncrementalFeatureError",
     MemberInvitationError = "MemberInvitationError",
@@ -543,10 +554,12 @@ export declare enum ErrorCode {
     PlansCircularDependencyError = "PlansCircularDependencyError",
     PriceNotFound = "PriceNotFound",
     RateLimitExceeded = "RateLimitExceeded",
+    ResyncAlreadyInProgress = "ResyncAlreadyInProgress",
     SubscriptionAlreadyCanceledOrExpired = "SubscriptionAlreadyCanceledOrExpired",
+    SubscriptionMustHaveSinglePlanError = "SubscriptionMustHaveSinglePlanError",
     SubscriptionNotFound = "SubscriptionNotFound",
-    TrialMustBeCancelledImmediately = "TrialMustBeCancelledImmediately",
     TrialMinDateError = "TrialMinDateError",
+    TrialMustBeCancelledImmediately = "TrialMustBeCancelledImmediately",
     TrialsNotAllowedInProduct = "TrialsNotAllowedInProduct",
     UnPublishedPackage = "UnPublishedPackage",
     Unauthenticated = "Unauthenticated",
@@ -579,6 +592,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",
@@ -742,7 +756,7 @@ export declare type ImportCustomerInput = {
     refId: Scalars['String'];
 };
 export declare type InitiateCheckoutInput = {
-    addons?: InputMaybe<Array<CheckoutAddonInput>>;
+    addons?: InputMaybe<Array<SubscriptionAddonInput>>;
     billingPeriod: BillingPeriod;
     cancelUrl: Scalars['String'];
     customerId: Scalars['String'];
@@ -1080,6 +1094,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']>;
@@ -1195,6 +1210,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 +1309,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'];
@@ -1371,6 +1391,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 +1434,7 @@ export declare enum SubscriptionCancelReason {
     Expired = "Expired",
     Immediate = "Immediate",
     PendingPaymentExpired = "PendingPaymentExpired",
+    ScheduledCancellation = "ScheduledCancellation",
     TrialConverted = "TrialConverted",
     TrialEnded = "TrialEnded",
     UpgradeOrDowngrade = "UpgradeOrDowngrade"
@@ -1454,6 +1476,7 @@ export declare enum SubscriptionEndSetup {
     DowngradeToFree = "DOWNGRADE_TO_FREE"
 }
 export declare type SubscriptionInput = {
+    additionalMetaData?: InputMaybe<Scalars['JSON']>;
     addons?: InputMaybe<Array<SubscriptionAddonInput>>;
     billingId?: InputMaybe<Scalars['String']>;
     billingPeriod?: InputMaybe<BillingPeriod>;
@@ -1511,6 +1534,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>;
@@ -1590,6 +1614,7 @@ export declare type TaskStatusFilterComparison = {
     notLike?: InputMaybe<TaskStatus>;
 };
 export declare enum TaskType {
+    ResyncIntegration = "RESYNC_INTEGRATION",
     SubscriptionMigration = "SUBSCRIPTION_MIGRATION"
 }
 export declare type TaskTypeFilterComparison = {
@@ -1622,6 +1647,7 @@ export declare enum TrialPeriodUnits {
     Month = "MONTH"
 }
 export declare type UpdateCustomerInput = {
+    additionalMetaData?: InputMaybe<Scalars['JSON']>;
     billingId?: InputMaybe<Scalars['String']>;
     billingInformation?: InputMaybe<CustomerBillingInfo>;
     crmId?: InputMaybe<Scalars['String']>;
@@ -1708,6 +1734,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 +1769,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 +1851,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 +1870,7 @@ export declare type SubscriptionFragment = {
         refId: string;
         displayName: string;
         description?: string | null | undefined;
+        additionalMetaData?: any | null | undefined;
         product: {
             __typename?: 'Product';
             refId: string;
@@ -1890,6 +1926,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 +1975,7 @@ export declare type CustomerFragment = {
     updatedAt: any;
     hasPaymentMethod: boolean;
     refId: string;
+    additionalMetaData?: any | null | undefined;
     promotionalEntitlements: Array<{
         __typename?: 'PromotionalEntitlement';
     } & PromotionalEntitlementFragment>;
@@ -2043,6 +2081,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 +2096,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';