@stigg/js-client-sdk 0.36.0 → 0.37.0

package/dist/api/ApiGateway.d.ts

@@ -1,9 +1,11 @@
 import { ApolloClient, NormalizedCacheObject } from '@apollo/client/core';
 import PaywallApi from './PaywallApi';
 import CustomersApi from './CustomersApi';
+import CouponsApi from './CouponsApi';
 declare class ApiGateway {
     paywall: PaywallApi;
     customers: CustomersApi;
+    coupons: CouponsApi;
     constructor(client: ApolloClient<NormalizedCacheObject>);
 }
 export default ApiGateway;

package/dist/api/CouponsApi.d.ts

@@ -0,0 +1,8 @@
+import { ApolloClient, NormalizedCacheObject } from '@apollo/client/core';
+import { FetchCouponsQuery } from './generated/types';
+declare class CouponsApi {
+    private readonly client;
+    constructor(client: ApolloClient<NormalizedCacheObject>);
+    getCoupons(): Promise<import("@apollo/client/core").ApolloQueryResult<FetchCouponsQuery>>;
+}
+export default CouponsApi;

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

@@ -121,6 +121,10 @@ export declare enum ApiKeyType {
     Client = "CLIENT",
     Server = "SERVER"
 }
+export declare type ArchiveCouponInput = {
+    environmentId?: InputMaybe<Scalars['String']>;
+    refId: Scalars['String'];
+};
 export declare type ArchivePlanInput = {
     environmentId: Scalars['String'];
     id: Scalars['String'];
@@ -183,6 +187,104 @@ export declare enum ChangeType {
     Deleted = "DELETED",
     Modified = "MODIFIED"
 }
+export declare type CouponFilter = {
+    and?: InputMaybe<Array<CouponFilter>>;
+    billingId?: InputMaybe<StringFieldComparison>;
+    createdAt?: InputMaybe<DateFieldComparison>;
+    customers?: InputMaybe<CouponFilterCustomerFilter>;
+    description?: InputMaybe<StringFieldComparison>;
+    environmentId?: InputMaybe<StringFieldComparison>;
+    id?: InputMaybe<StringFieldComparison>;
+    name?: InputMaybe<StringFieldComparison>;
+    or?: InputMaybe<Array<CouponFilter>>;
+    refId?: InputMaybe<StringFieldComparison>;
+    status?: InputMaybe<CouponStatusFilterComparison>;
+    type?: InputMaybe<CouponTypeFilterComparison>;
+    updatedAt?: InputMaybe<DateFieldComparison>;
+};
+export declare type CouponFilterCustomerFilter = {
+    and?: InputMaybe<Array<CouponFilterCustomerFilter>>;
+    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<CouponFilterCustomerFilter>>;
+    refId?: InputMaybe<StringFieldComparison>;
+    updatedAt?: InputMaybe<DateFieldComparison>;
+};
+export declare type CouponSort = {
+    direction: SortDirection;
+    field: CouponSortFields;
+    nulls?: InputMaybe<SortNulls>;
+};
+export declare enum CouponSortFields {
+    BillingId = "billingId",
+    CreatedAt = "createdAt",
+    Description = "description",
+    EnvironmentId = "environmentId",
+    Id = "id",
+    Name = "name",
+    RefId = "refId",
+    Status = "status",
+    Type = "type",
+    UpdatedAt = "updatedAt"
+}
+/** The status of the coupon */
+export declare enum CouponStatus {
+    Active = "ACTIVE",
+    Archived = "ARCHIVED"
+}
+export declare type CouponStatusFilterComparison = {
+    eq?: InputMaybe<CouponStatus>;
+    gt?: InputMaybe<CouponStatus>;
+    gte?: InputMaybe<CouponStatus>;
+    iLike?: InputMaybe<CouponStatus>;
+    in?: InputMaybe<Array<CouponStatus>>;
+    is?: InputMaybe<Scalars['Boolean']>;
+    isNot?: InputMaybe<Scalars['Boolean']>;
+    like?: InputMaybe<CouponStatus>;
+    lt?: InputMaybe<CouponStatus>;
+    lte?: InputMaybe<CouponStatus>;
+    neq?: InputMaybe<CouponStatus>;
+    notILike?: InputMaybe<CouponStatus>;
+    notIn?: InputMaybe<Array<CouponStatus>>;
+    notLike?: InputMaybe<CouponStatus>;
+};
+/** The type of the coupon */
+export declare enum CouponType {
+    Fixed = "FIXED",
+    Percentage = "PERCENTAGE"
+}
+export declare type CouponTypeFilterComparison = {
+    eq?: InputMaybe<CouponType>;
+    gt?: InputMaybe<CouponType>;
+    gte?: InputMaybe<CouponType>;
+    iLike?: InputMaybe<CouponType>;
+    in?: InputMaybe<Array<CouponType>>;
+    is?: InputMaybe<Scalars['Boolean']>;
+    isNot?: InputMaybe<Scalars['Boolean']>;
+    like?: InputMaybe<CouponType>;
+    lt?: InputMaybe<CouponType>;
+    lte?: InputMaybe<CouponType>;
+    neq?: InputMaybe<CouponType>;
+    notILike?: InputMaybe<CouponType>;
+    notIn?: InputMaybe<Array<CouponType>>;
+    notLike?: InputMaybe<CouponType>;
+};
+export declare type CreateCouponInput = {
+    additionalMetaData?: InputMaybe<Scalars['JSON']>;
+    description?: InputMaybe<Scalars['String']>;
+    discountValue: Scalars['Float'];
+    environmentId: Scalars['String'];
+    name: Scalars['String'];
+    refId: Scalars['String'];
+    type: CouponType;
+};
 export declare type CreateEnvironment = {
     createdAt?: InputMaybe<Scalars['DateTime']>;
     description?: InputMaybe<Scalars['String']>;
@@ -306,6 +408,7 @@ export declare type CustomerInput = {
     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']>;
@@ -530,10 +633,13 @@ export declare enum EnvironmentSortFields {
 }
 /** error codes */
 export declare enum ErrorCode {
+    AddonHasToHavePriceError = "AddonHasToHavePriceError",
     AddonNotFound = "AddonNotFound",
+    ArchivedCouponCantBeApplied = "ArchivedCouponCantBeApplied",
     BadUserInput = "BadUserInput",
     BillingPeriodMissingError = "BillingPeriodMissingError",
     CheckoutIsNotSupported = "CheckoutIsNotSupported",
+    CouponNotFound = "CouponNotFound",
     CustomerHasNoPaymentMethod = "CustomerHasNoPaymentMethod",
     CustomerNoBillingId = "CustomerNoBillingId",
     CustomerNotFound = "CustomerNotFound",
@@ -569,6 +675,7 @@ export declare enum ErrorCode {
     PriceNotFound = "PriceNotFound",
     RateLimitExceeded = "RateLimitExceeded",
     ResyncAlreadyInProgress = "ResyncAlreadyInProgress",
+    SelectedBillingModelDoesntMatchImportedItemError = "SelectedBillingModelDoesntMatchImportedItemError",
     StripeCustomerIsDeleted = "StripeCustomerIsDeleted",
     SubscriptionAlreadyCanceledOrExpired = "SubscriptionAlreadyCanceledOrExpired",
     SubscriptionMustHaveSinglePlanError = "SubscriptionMustHaveSinglePlanError",
@@ -588,6 +695,9 @@ export declare enum EventLogType {
     AddonCreated = "ADDON_CREATED",
     AddonDeleted = "ADDON_DELETED",
     AddonUpdated = "ADDON_UPDATED",
+    CouponArchived = "COUPON_ARCHIVED",
+    CouponCreated = "COUPON_CREATED",
+    CouponUpdated = "COUPON_UPDATED",
     CustomerCreated = "CUSTOMER_CREATED",
     CustomerDeleted = "CUSTOMER_DELETED",
     CustomerUpdated = "CUSTOMER_UPDATED",
@@ -774,8 +884,11 @@ export declare type ImportCustomerInput = {
     refId: Scalars['String'];
 };
 export declare type ImportIntegrationCatalogInput = {
+    billingModel?: InputMaybe<BillingModel>;
     entitySelectionMode: EntitySelectionMode;
     environmentId: Scalars['String'];
+    featureUnitName?: InputMaybe<Scalars['String']>;
+    featureUnitPluralName?: InputMaybe<Scalars['String']>;
     plansSelectionBlacklist?: InputMaybe<Array<Scalars['String']>>;
     plansSelectionWhitelist?: InputMaybe<Array<Scalars['String']>>;
     productId: Scalars['String'];
@@ -1376,6 +1489,12 @@ export declare type RemoveCompatibleAddonsFromPlanInput = {
     /** The ids of the relations. */
     relationIds: Array<Scalars['String']>;
 };
+export declare type RemoveCouponFromCustomerInput = {
+    /** The id of the record. */
+    id: Scalars['String'];
+    /** The id of relation. */
+    relationId: Scalars['String'];
+};
 export declare type ResyncIntegrationInput = {
     environmentId: Scalars['String'];
     vendorIdentifier: VendorIdentifier;
@@ -1392,6 +1511,12 @@ export declare type SetCompatibleAddonsOnPlanInput = {
     /** The ids of the relations. */
     relationIds: Array<Scalars['String']>;
 };
+export declare type SetCouponOnCustomerInput = {
+    /** The id of the record. */
+    id: Scalars['String'];
+    /** The id of relation. */
+    relationId: Scalars['String'];
+};
 /** Sort Directions */
 export declare enum SortDirection {
     Asc = "ASC",
@@ -1742,10 +1867,18 @@ export declare type UpdateAccountInput = {
     id: Scalars['String'];
     timezone?: InputMaybe<Scalars['String']>;
 };
+export declare type UpdateCouponInput = {
+    additionalMetaData?: InputMaybe<Scalars['JSON']>;
+    description?: InputMaybe<Scalars['String']>;
+    environmentId?: InputMaybe<Scalars['String']>;
+    name: Scalars['String'];
+    refId: Scalars['String'];
+};
 export declare type UpdateCustomerInput = {
     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']>;
@@ -1940,6 +2073,60 @@ export declare type ZuoraCredentialsInput = {
     clientId: Scalars['String'];
     clientSecret: Scalars['String'];
 };
+export declare type CouponFragment = {
+    __typename?: 'Coupon';
+    id: string;
+    discountValue: number;
+    type: CouponType;
+    additionalMetaData?: any | null | undefined;
+    refId: string;
+    name: string;
+    description?: string | null | undefined;
+    createdAt: any;
+    updatedAt: any;
+    billingId?: string | null | undefined;
+    billingLinkUrl?: string | null | undefined;
+    status: CouponStatus;
+    syncStates?: Array<{
+        __typename?: 'SyncState';
+        vendorIdentifier: VendorIdentifier;
+        status: SyncStatus;
+    }> | null | undefined;
+    customers?: Array<{
+        __typename?: 'Customer';
+        id: string;
+    }> | null | undefined;
+};
+export declare type FetchCouponsQueryVariables = Exact<{
+    filter?: Maybe<CouponFilter>;
+    sorting?: Maybe<Array<CouponSort> | CouponSort>;
+    paging?: Maybe<CursorPaging>;
+}>;
+export declare type FetchCouponsQuery = {
+    __typename?: 'Query';
+    coupons: {
+        __typename?: 'CouponConnection';
+        edges: Array<{
+            __typename?: 'CouponEdge';
+            node: {
+                __typename?: 'Coupon';
+            } & CouponFragment;
+        }>;
+    };
+};
+export declare type TotalPriceFragment = {
+    __typename?: 'CustomerSubscriptionTotalPrice';
+    subTotal: {
+        __typename?: 'Money';
+        amount: number;
+        currency: Currency;
+    };
+    total: {
+        __typename?: 'Money';
+        amount: number;
+        currency: Currency;
+    };
+};
 export declare type SubscriptionFragment = {
     __typename?: 'CustomerSubscription';
     id: string;
@@ -1960,6 +2147,9 @@ export declare type SubscriptionFragment = {
             __typename?: 'Price';
         } & PriceFragment;
     }> | null | undefined;
+    totalPrice?: ({
+        __typename?: 'CustomerSubscriptionTotalPrice';
+    } & TotalPriceFragment) | null | undefined;
     plan: {
         __typename?: 'Plan';
         id: string;

package/dist/client.d.ts

@@ -1,4 +1,4 @@
-import { Customer, Entitlement, Plan, BooleanEntitlement, NumericEntitlement, MeteredEntitlement, GetBooleanEntitlement, GetNumericEntitlement, GetMeteredEntitlement, GetPaywall } from './models';
+import { Customer, Entitlement, Plan, BooleanEntitlement, NumericEntitlement, MeteredEntitlement, GetBooleanEntitlement, GetNumericEntitlement, GetMeteredEntitlement, GetPaywall, Coupon } from './models';
 import { ClientConfiguration } from './configuration';
 export interface StiggClient {
     getBooleanEntitlement: (params: GetBooleanEntitlement) => BooleanEntitlement;
@@ -60,6 +60,12 @@ export declare class Stigg implements StiggClient {
      * @returns {Promise<Plan[]>}
      */
     getPaywall({ productId }?: GetPaywall): Promise<Plan[]>;
+    /**
+     * Get a list of coupons
+     *
+     * @returns {Promise<Coupon[]>}
+     */
+    getCoupons(): Promise<Coupon[]>;
     /**
      * Get a customer
      *