@forgecart/sdk 1.202607070306.0 → 1.202607100718.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -56,7 +56,7 @@ const order = await client.shop.cart.addItemToOrder({ variantId, quantity: 1 });
56
56
 
57
57
  ## Namespaces
58
58
 
59
- - `client.admin` — entry, fieldDefinition, publish, acfSchema, acf, administrator, analyticsGateway, asset, audienceMembership, audienceSegment, auth, settings, channel, chat, collection, country, address, group, customerGroup, customer, deployment, facet, fulfillmentRequest, fulfillment, hookDispatch, hook, market, marketingAttribution, marketingEvent, marketingIdentity, mission, onboarding, coupon, draft, modification, note, orderModification, order, payment, manageable, plugin, optionGroup, option, productOption, productVariant, product, promotion, role, scheduledJob, search, seller, sellingPlan, shipping, stock, subscriptionAnalytics, subscription, tax, transaction, zone
59
+ - `client.admin` — entry, fieldDefinition, publish, acfSchema, acf, administrator, analyticsGateway, asset, audienceMembership, audienceSegment, auth, settings, channel, chat, collection, country, address, group, customerAnalytics, customerGroup, customer, deployment, facet, fulfillmentRequest, fulfillment, hookDispatch, hook, market, marketingAttribution, marketingEvent, marketingIdentity, mission, onboarding, coupon, draft, modification, note, orderAnalytics, orderModification, order, payment, manageable, plugin, optionGroup, option, productOption, productVariant, product, promotion, role, scheduledJob, search, seller, sellingPlan, shipping, stockAnalytics, stock, subscriptionAnalytics, subscription, tax, transaction, zone
60
60
  - `client.shop` — acf, auth, cart, channel, checkout, collection, customer, facet, hookDispatch, hook, marketingEvent, marketingIdentity, order, payment, product, search, sellingPlan, shipping, subscription
61
61
 
62
62
  ## NestJS Integration
@@ -1115,6 +1115,10 @@ export type Customer = {
1115
1115
  title?: Maybe<Scalars['String']['output']>;
1116
1116
  updatedAt: Scalars['DateTime']['output'];
1117
1117
  };
1118
+ export type CustomerAnalyticsInput = {
1119
+ dateRangeFrom: Scalars['DateTime']['input'];
1120
+ dateRangeTo: Scalars['DateTime']['input'];
1121
+ };
1118
1122
  export type CustomerGroup = {
1119
1123
  createdAt: Scalars['DateTime']['output'];
1120
1124
  customers: Array<Customer>;
@@ -1130,6 +1134,10 @@ export type CustomerList = {
1130
1134
  items: Array<Customer>;
1131
1135
  totalItems: Scalars['Int']['output'];
1132
1136
  };
1137
+ export type CustomerSignupPoint = {
1138
+ count: Scalars['Int']['output'];
1139
+ day: Scalars['String']['output'];
1140
+ };
1133
1141
  export type CustomsInput = {
1134
1142
  contentsType?: InputMaybe<Scalars['String']['input']>;
1135
1143
  hsCode: Scalars['String']['input'];
@@ -1214,7 +1222,7 @@ export type DeploymentLogEntry = {
1214
1222
  stream?: Maybe<Scalars['String']['output']>;
1215
1223
  timestamp: Scalars['DateTime']['output'];
1216
1224
  };
1217
- export type DeploymentStatus = 'FAILED' | 'PENDING' | 'RESTARTING' | 'RUNNING' | 'STAGING' | 'STOPPED';
1225
+ export type DeploymentStatus = 'BUILDING' | 'FAILED' | 'PENDING' | 'RESTARTING' | 'RUNNING' | 'STAGING' | 'STOPPED';
1218
1226
  export type DeploymentSummary = {
1219
1227
  instances: Scalars['Int']['output'];
1220
1228
  lastDeployedAt?: Maybe<Scalars['DateTime']['output']>;
@@ -1574,6 +1582,16 @@ export type ListQueryOptions = {
1574
1582
  sort?: InputMaybe<Scalars['JSON']['input']>;
1575
1583
  take?: InputMaybe<Scalars['Int']['input']>;
1576
1584
  };
1585
+ export type LowStockVariant = {
1586
+ available: Scalars['Int']['output'];
1587
+ name: Scalars['String']['output'];
1588
+ sku?: Maybe<Scalars['String']['output']>;
1589
+ threshold: Scalars['Int']['output'];
1590
+ variantId: Scalars['ID']['output'];
1591
+ };
1592
+ export type LowStockVariantsInput = {
1593
+ take?: InputMaybe<Scalars['Int']['input']>;
1594
+ };
1577
1595
  export type ManageablePlugin = {
1578
1596
  channelPlugins: Array<ChannelPlugin>;
1579
1597
  code: Scalars['String']['output'];
@@ -1637,6 +1655,17 @@ export type MarketingAttribution = {
1637
1655
  touchpoints: Array<MarketingTouchpoint>;
1638
1656
  touchpointsWithCredit: Array<MarketingTouchpointWithCredit>;
1639
1657
  };
1658
+ export type MarketingEventGeoBucket = {
1659
+ count: Scalars['Int']['output'];
1660
+ country: Scalars['String']['output'];
1661
+ region?: Maybe<Scalars['String']['output']>;
1662
+ uniqueIdentities: Scalars['Int']['output'];
1663
+ };
1664
+ export type MarketingEventGeoRollupInput = {
1665
+ eventType?: InputMaybe<Scalars['String']['input']>;
1666
+ from: Scalars['DateTime']['input'];
1667
+ to: Scalars['DateTime']['input'];
1668
+ };
1640
1669
  export type MarketingEventSummary = {
1641
1670
  count: Scalars['Int']['output'];
1642
1671
  durationMs: Scalars['Int']['output'];
@@ -1683,6 +1712,23 @@ export type MarketingIdentityIdentifier = {
1683
1712
  position?: Maybe<Scalars['Int']['output']>;
1684
1713
  value: Scalars['String']['output'];
1685
1714
  };
1715
+ export type MarketingLiveVisitor = {
1716
+ browser?: Maybe<Scalars['String']['output']>;
1717
+ city?: Maybe<Scalars['String']['output']>;
1718
+ country?: Maybe<Scalars['String']['output']>;
1719
+ deviceType?: Maybe<Scalars['String']['output']>;
1720
+ eventCount: Scalars['Int']['output'];
1721
+ identityId: Scalars['ID']['output'];
1722
+ isCustomer: Scalars['Boolean']['output'];
1723
+ lastEventType: Scalars['String']['output'];
1724
+ lastSeenAt: Scalars['DateTime']['output'];
1725
+ latitude?: Maybe<Scalars['Float']['output']>;
1726
+ longitude?: Maybe<Scalars['Float']['output']>;
1727
+ os?: Maybe<Scalars['String']['output']>;
1728
+ };
1729
+ export type MarketingLiveVisitorsInput = {
1730
+ windowMinutes: Scalars['Int']['input'];
1731
+ };
1686
1732
  export type MarketingTouchpoint = {
1687
1733
  dedupCount: Scalars['Int']['output'];
1688
1734
  eventId: Scalars['ID']['output'];
@@ -1913,6 +1959,7 @@ export type Mutation = {
1913
1959
  pollDeviceToken?: Maybe<DeviceTokenResponse>;
1914
1960
  provisionChannel: ProvisionChannelResult;
1915
1961
  publish: PublishLog;
1962
+ publishDeployment: Deployment;
1916
1963
  reactivateSubscription: BillingSubscription;
1917
1964
  receiveIncomingStock: StockMovement;
1918
1965
  recomputeAttribution: MarketingAttribution;
@@ -2415,6 +2462,9 @@ export type MutationprovisionChannelArgs = {
2415
2462
  export type MutationpublishArgs = {
2416
2463
  codes?: InputMaybe<Array<Scalars['String']['input']>>;
2417
2464
  };
2465
+ export type MutationpublishDeploymentArgs = {
2466
+ type: DeploymentType;
2467
+ };
2418
2468
  export type MutationreactivateSubscriptionArgs = {
2419
2469
  id: Scalars['ID']['input'];
2420
2470
  };
@@ -2791,6 +2841,16 @@ export type OrderAddress = {
2791
2841
  streetLine1: Scalars['String']['output'];
2792
2842
  streetLine2?: Maybe<Scalars['String']['output']>;
2793
2843
  };
2844
+ export type OrderAnalytics = {
2845
+ averageOrderValueMinor: Scalars['Int']['output'];
2846
+ orderCount: Scalars['Int']['output'];
2847
+ revenueByDay: Array<OrderRevenuePoint>;
2848
+ totalRevenueMinor: Scalars['Int']['output'];
2849
+ };
2850
+ export type OrderAnalyticsInput = {
2851
+ dateRangeFrom: Scalars['DateTime']['input'];
2852
+ dateRangeTo: Scalars['DateTime']['input'];
2853
+ };
2794
2854
  export type OrderCouponCodeInput = {
2795
2855
  couponCode: Scalars['String']['input'];
2796
2856
  orderId: Scalars['ID']['input'];
@@ -2855,6 +2915,11 @@ export type OrderNotesInput = {
2855
2915
  options?: InputMaybe<ListQueryOptions>;
2856
2916
  orderId: Scalars['ID']['input'];
2857
2917
  };
2918
+ export type OrderRevenuePoint = {
2919
+ day: Scalars['String']['output'];
2920
+ orderCount: Scalars['Int']['output'];
2921
+ revenueMinor: Scalars['Int']['output'];
2922
+ };
2858
2923
  export type OrderTaxLine = {
2859
2924
  description: Scalars['String']['output'];
2860
2925
  taxAmount: Scalars['Int']['output'];
@@ -3139,6 +3204,7 @@ export type Query = {
3139
3204
  customer?: Maybe<Customer>;
3140
3205
  customerGroup?: Maybe<CustomerGroup>;
3141
3206
  customerGroups: CustomerGroupList;
3207
+ customerSignupsByDay: Array<CustomerSignupPoint>;
3142
3208
  customers: CustomerList;
3143
3209
  defaultStockLocation: StockLocation;
3144
3210
  deployment?: Maybe<Deployment>;
@@ -3166,15 +3232,19 @@ export type Query = {
3166
3232
  getSessionTemplate: PaymentFormTemplate;
3167
3233
  getSessionVariables: PaymentFormVariables;
3168
3234
  getTokenTemplate: PaymentFormTemplate;
3235
+ lowStockVariants: Array<LowStockVariant>;
3169
3236
  manageablePlugin?: Maybe<ManageablePlugin>;
3170
3237
  manageablePlugins: Array<ManageablePlugin>;
3171
3238
  manageablePluginsByTag: Array<ManageablePlugin>;
3239
+ marketingEventGeoRollup: Array<MarketingEventGeoBucket>;
3172
3240
  marketingIdentity?: Maybe<MarketingIdentity>;
3173
3241
  marketingIdentityByCustomer?: Maybe<MarketingIdentity>;
3242
+ marketingLiveVisitors: Array<MarketingLiveVisitor>;
3174
3243
  markets: MarketList;
3175
3244
  mission?: Maybe<Mission>;
3176
3245
  missions: MissionList;
3177
3246
  order?: Maybe<Order>;
3247
+ orderAnalytics: OrderAnalytics;
3178
3248
  orderByCode?: Maybe<Order>;
3179
3249
  orderHistory: HistoryEntryList;
3180
3250
  orderModifications: Array<OrderModification>;
@@ -3220,6 +3290,7 @@ export type Query = {
3220
3290
  taxCategory?: Maybe<TaxCategory>;
3221
3291
  taxRate?: Maybe<TaxRate>;
3222
3292
  taxRates: TaxRateList;
3293
+ topProducts: Array<TopProduct>;
3223
3294
  usageMetrics: Array<UsageMetric>;
3224
3295
  usageRecords: UsageRecordList;
3225
3296
  validateChannelToken: Scalars['Boolean']['output'];
@@ -3311,6 +3382,9 @@ export type QuerycustomerGroupArgs = {
3311
3382
  export type QuerycustomerGroupsArgs = {
3312
3383
  options?: InputMaybe<ListQueryOptions>;
3313
3384
  };
3385
+ export type QuerycustomerSignupsByDayArgs = {
3386
+ input: CustomerAnalyticsInput;
3387
+ };
3314
3388
  export type QuerycustomersArgs = {
3315
3389
  options?: InputMaybe<ListQueryOptions>;
3316
3390
  };
@@ -3384,18 +3458,27 @@ export type QuerygetSessionVariablesArgs = {
3384
3458
  export type QuerygetTokenTemplateArgs = {
3385
3459
  providerCode: Scalars['String']['input'];
3386
3460
  };
3461
+ export type QuerylowStockVariantsArgs = {
3462
+ input: LowStockVariantsInput;
3463
+ };
3387
3464
  export type QuerymanageablePluginArgs = {
3388
3465
  code: Scalars['String']['input'];
3389
3466
  };
3390
3467
  export type QuerymanageablePluginsByTagArgs = {
3391
3468
  tag: Scalars['String']['input'];
3392
3469
  };
3470
+ export type QuerymarketingEventGeoRollupArgs = {
3471
+ input: MarketingEventGeoRollupInput;
3472
+ };
3393
3473
  export type QuerymarketingIdentityArgs = {
3394
3474
  id: Scalars['ID']['input'];
3395
3475
  };
3396
3476
  export type QuerymarketingIdentityByCustomerArgs = {
3397
3477
  customerId: Scalars['ID']['input'];
3398
3478
  };
3479
+ export type QuerymarketingLiveVisitorsArgs = {
3480
+ input: MarketingLiveVisitorsInput;
3481
+ };
3399
3482
  export type QuerymarketsArgs = {
3400
3483
  options?: InputMaybe<ListQueryOptions>;
3401
3484
  };
@@ -3408,6 +3491,9 @@ export type QuerymissionsArgs = {
3408
3491
  export type QueryorderArgs = {
3409
3492
  id: Scalars['ID']['input'];
3410
3493
  };
3494
+ export type QueryorderAnalyticsArgs = {
3495
+ input: OrderAnalyticsInput;
3496
+ };
3411
3497
  export type QueryorderByCodeArgs = {
3412
3498
  code: Scalars['String']['input'];
3413
3499
  };
@@ -3531,6 +3617,9 @@ export type QuerytaxRateArgs = {
3531
3617
  export type QuerytaxRatesArgs = {
3532
3618
  options?: InputMaybe<ListQueryOptions>;
3533
3619
  };
3620
+ export type QuerytopProductsArgs = {
3621
+ input: TopProductsInput;
3622
+ };
3534
3623
  export type QueryusageRecordsArgs = {
3535
3624
  options?: InputMaybe<UsageRecordListOptions>;
3536
3625
  subscriptionId: Scalars['ID']['input'];
@@ -4174,6 +4263,7 @@ export type StringFilter = {
4174
4263
  export type Subscription = {
4175
4264
  chatMessageStream: ChatMessage;
4176
4265
  deploymentLogs: DeploymentLogEntry;
4266
+ deploymentStatusChanged: Deployment;
4177
4267
  hookDispatched: HookDispatchEvent;
4178
4268
  resumeChatSession: ChatMessage;
4179
4269
  workspaceReadiness: WorkspaceReadiness;
@@ -4184,6 +4274,9 @@ export type SubscriptionchatMessageStreamArgs = {
4184
4274
  export type SubscriptiondeploymentLogsArgs = {
4185
4275
  type: DeploymentType;
4186
4276
  };
4277
+ export type SubscriptiondeploymentStatusChangedArgs = {
4278
+ type: DeploymentType;
4279
+ };
4187
4280
  export type SubscriptionhookDispatchedArgs = {
4188
4281
  hookPoints: Array<Scalars['String']['input']>;
4189
4282
  };
@@ -4330,6 +4423,17 @@ export type ToolUseDetail = {
4330
4423
  toolId: Scalars['String']['output'];
4331
4424
  toolName: Scalars['String']['output'];
4332
4425
  };
4426
+ export type TopProduct = {
4427
+ productId: Scalars['ID']['output'];
4428
+ productName: Scalars['String']['output'];
4429
+ revenueMinor: Scalars['Int']['output'];
4430
+ unitsSold: Scalars['Int']['output'];
4431
+ };
4432
+ export type TopProductsInput = {
4433
+ dateRangeFrom: Scalars['DateTime']['input'];
4434
+ dateRangeTo: Scalars['DateTime']['input'];
4435
+ take?: InputMaybe<Scalars['Int']['input']>;
4436
+ };
4333
4437
  export type TrackEventInput = {
4334
4438
  eventType: Scalars['String']['input'];
4335
4439
  occurredAt?: InputMaybe<Scalars['DateTime']['input']>;
@@ -4384,6 +4488,7 @@ export type UpdateAddressInput = {
4384
4488
  streetLine2?: InputMaybe<Scalars['String']['input']>;
4385
4489
  };
4386
4490
  export type UpdateAdministratorInput = {
4491
+ avatarUrl?: InputMaybe<Scalars['String']['input']>;
4387
4492
  emailAddress?: InputMaybe<Scalars['String']['input']>;
4388
4493
  firstName?: InputMaybe<Scalars['String']['input']>;
4389
4494
  id: Scalars['ID']['input'];
@@ -5678,7 +5783,7 @@ export type UpdateChannelSettingsMutationVariables = Exact<{
5678
5783
  input: UpdateChannelSettingsInput;
5679
5784
  }>;
5680
5785
  export type UpdateChannelSettingsMutation = {
5681
- updateChannelSettings: Pick<ChannelSettings, 'id' | 'channelId' | 'shopName' | 'requiresShippingAddressValidation' | 'requireCustomerForCheckout' | 'defaultFulfillmentHandlerCode' | 'defaultPaymentProviderCode' | 'defaultWeightUnit' | 'defaultDimensionUnit' | 'autoCurrencyExchange' | 'fxRoundingRule' | 'fxMarkupPercent'>;
5786
+ updateChannelSettings: Pick<ChannelSettings, 'id' | 'channelId' | 'shopName' | 'requiresShippingAddressValidation' | 'requireCustomerForCheckout' | 'defaultFulfillmentHandlerCode' | 'defaultPaymentProviderCode' | 'defaultDeploymentProviderCode' | 'defaultWeightUnit' | 'defaultDimensionUnit' | 'autoCurrencyExchange' | 'fxRoundingRule' | 'fxMarkupPercent'>;
5682
5787
  };
5683
5788
  export type ProvisionChannelMutationVariables = Exact<{
5684
5789
  input: ProvisionChannelInput;
@@ -5686,22 +5791,22 @@ export type ProvisionChannelMutationVariables = Exact<{
5686
5791
  export type ProvisionChannelMutation = {
5687
5792
  provisionChannel: {
5688
5793
  channel: Pick<Channel, 'id' | 'createdAt' | 'updatedAt' | 'code' | 'token' | 'secret' | 'previewUrl' | 'defaultLanguageCode' | 'defaultCurrencyCode' | 'availableLanguageCodes' | 'availableCurrencyCodes' | 'description' | 'pricesIncludeTax' | 'taxProviderCode' | 'trackInventory' | 'outOfStockThreshold' | 'sellerId' | 'defaultTaxZoneId'>;
5689
- channelSettings: Pick<ChannelSettings, 'id' | 'channelId' | 'shopName' | 'requiresShippingAddressValidation' | 'requireCustomerForCheckout' | 'defaultFulfillmentHandlerCode' | 'defaultPaymentProviderCode' | 'defaultWeightUnit' | 'defaultDimensionUnit' | 'autoCurrencyExchange' | 'fxRoundingRule' | 'fxMarkupPercent'>;
5794
+ channelSettings: Pick<ChannelSettings, 'id' | 'channelId' | 'shopName' | 'requiresShippingAddressValidation' | 'requireCustomerForCheckout' | 'defaultFulfillmentHandlerCode' | 'defaultPaymentProviderCode' | 'defaultDeploymentProviderCode' | 'defaultWeightUnit' | 'defaultDimensionUnit' | 'autoCurrencyExchange' | 'fxRoundingRule' | 'fxMarkupPercent'>;
5690
5795
  role: Pick<Role, 'id' | 'name' | 'code' | 'description' | 'permissions'>;
5691
5796
  };
5692
5797
  };
5693
- export type ChannelSettingsFieldFragment = Pick<ChannelSettings, 'id' | 'channelId' | 'shopName' | 'requiresShippingAddressValidation' | 'requireCustomerForCheckout' | 'defaultFulfillmentHandlerCode' | 'defaultPaymentProviderCode' | 'defaultWeightUnit' | 'defaultDimensionUnit' | 'autoCurrencyExchange' | 'fxRoundingRule' | 'fxMarkupPercent'>;
5798
+ export type ChannelSettingsFieldFragment = Pick<ChannelSettings, 'id' | 'channelId' | 'shopName' | 'requiresShippingAddressValidation' | 'requireCustomerForCheckout' | 'defaultFulfillmentHandlerCode' | 'defaultPaymentProviderCode' | 'defaultDeploymentProviderCode' | 'defaultWeightUnit' | 'defaultDimensionUnit' | 'autoCurrencyExchange' | 'fxRoundingRule' | 'fxMarkupPercent'>;
5694
5799
  export type ChannelSettingsQueryVariables = Exact<{
5695
5800
  [key: string]: never;
5696
5801
  }>;
5697
5802
  export type ChannelSettingsQuery = {
5698
- channelSettings: Pick<ChannelSettings, 'id' | 'channelId' | 'shopName' | 'requiresShippingAddressValidation' | 'requireCustomerForCheckout' | 'defaultFulfillmentHandlerCode' | 'defaultPaymentProviderCode' | 'defaultWeightUnit' | 'defaultDimensionUnit' | 'autoCurrencyExchange' | 'fxRoundingRule' | 'fxMarkupPercent'>;
5803
+ channelSettings: Pick<ChannelSettings, 'id' | 'channelId' | 'shopName' | 'requiresShippingAddressValidation' | 'requireCustomerForCheckout' | 'defaultFulfillmentHandlerCode' | 'defaultPaymentProviderCode' | 'defaultDeploymentProviderCode' | 'defaultWeightUnit' | 'defaultDimensionUnit' | 'autoCurrencyExchange' | 'fxRoundingRule' | 'fxMarkupPercent'>;
5699
5804
  };
5700
5805
  export type ChannelUpdateSettingsMutationVariables = Exact<{
5701
5806
  input: UpdateChannelSettingsInput;
5702
5807
  }>;
5703
5808
  export type ChannelUpdateSettingsMutation = {
5704
- updateChannelSettings: Pick<ChannelSettings, 'id' | 'channelId' | 'shopName' | 'requiresShippingAddressValidation' | 'requireCustomerForCheckout' | 'defaultFulfillmentHandlerCode' | 'defaultPaymentProviderCode' | 'defaultWeightUnit' | 'defaultDimensionUnit' | 'autoCurrencyExchange' | 'fxRoundingRule' | 'fxMarkupPercent'>;
5809
+ updateChannelSettings: Pick<ChannelSettings, 'id' | 'channelId' | 'shopName' | 'requiresShippingAddressValidation' | 'requireCustomerForCheckout' | 'defaultFulfillmentHandlerCode' | 'defaultPaymentProviderCode' | 'defaultDeploymentProviderCode' | 'defaultWeightUnit' | 'defaultDimensionUnit' | 'autoCurrencyExchange' | 'fxRoundingRule' | 'fxMarkupPercent'>;
5705
5810
  };
5706
5811
  export type ChannelSubscriptionSettingsFieldFragment = Pick<ChannelSubscriptionSettings, 'id' | 'channelId' | 'couponInteraction'>;
5707
5812
  export type ChannelSubscriptionSettingsQueryVariables = Exact<{
@@ -5901,6 +6006,13 @@ export type DeleteCountryMutationVariables = Exact<{
5901
6006
  export type DeleteCountryMutation = {
5902
6007
  deleteCountry: Pick<DeletionResponse, 'result' | 'message'>;
5903
6008
  };
6009
+ export type CustomerSignupPointFieldFragment = Pick<CustomerSignupPoint, 'day' | 'count'>;
6010
+ export type CustomerSignupsByDayQueryVariables = Exact<{
6011
+ input: CustomerAnalyticsInput;
6012
+ }>;
6013
+ export type CustomerSignupsByDayQuery = {
6014
+ customerSignupsByDay: Array<Pick<CustomerSignupPoint, 'day' | 'count'>>;
6015
+ };
5904
6016
  export type CreateCustomerGroupMutationVariables = Exact<{
5905
6017
  input: CreateCustomerGroupInput;
5906
6018
  }>;
@@ -6128,6 +6240,12 @@ export type AdminDeployAppMutationVariables = Exact<{
6128
6240
  export type AdminDeployAppMutation = {
6129
6241
  deployApp: Pick<Deployment, 'id' | 'name' | 'type' | 'status' | 'url' | 'providerCode' | 'providerAppName' | 'instances' | 'lastDeployedAt' | 'errorMessage' | 'channelId' | 'createdAt' | 'updatedAt'>;
6130
6242
  };
6243
+ export type AdminPublishDeploymentMutationVariables = Exact<{
6244
+ type: DeploymentType;
6245
+ }>;
6246
+ export type AdminPublishDeploymentMutation = {
6247
+ publishDeployment: Pick<Deployment, 'id' | 'name' | 'type' | 'status' | 'url' | 'providerCode' | 'providerAppName' | 'instances' | 'lastDeployedAt' | 'errorMessage' | 'channelId' | 'createdAt' | 'updatedAt'>;
6248
+ };
6131
6249
  export type AdminScaleDeploymentMutationVariables = Exact<{
6132
6250
  input: ScaleDeploymentInput;
6133
6251
  }>;
@@ -6176,6 +6294,12 @@ export type AdminDeploymentLogsSubscriptionVariables = Exact<{
6176
6294
  export type AdminDeploymentLogsSubscription = {
6177
6295
  deploymentLogs: Pick<DeploymentLogEntry, 'timestamp' | 'message' | 'stream'>;
6178
6296
  };
6297
+ export type AdminDeploymentStatusChangedSubscriptionVariables = Exact<{
6298
+ type: DeploymentType;
6299
+ }>;
6300
+ export type AdminDeploymentStatusChangedSubscription = {
6301
+ deploymentStatusChanged: Pick<Deployment, 'id' | 'type' | 'status' | 'url' | 'errorMessage' | 'instances' | 'lastDeployedAt'>;
6302
+ };
6179
6303
  export type FacetValueTranslationFieldFragment = Pick<FacetValueTranslation, 'id' | 'languageCode' | 'name'>;
6180
6304
  export type FacetTranslationFieldFragment = Pick<FacetTranslation, 'id' | 'languageCode' | 'name'>;
6181
6305
  export type FacetValueFieldFragment = (Pick<FacetValue, 'id' | 'createdAt' | 'updatedAt' | 'name' | 'code' | 'facetId'> & {
@@ -6574,6 +6698,18 @@ export type AdminQueryMarketingEventSummaryQueryVariables = Exact<{
6574
6698
  export type AdminQueryMarketingEventSummaryQuery = {
6575
6699
  queryMarketingEventSummary: Pick<MarketingEventSummary, 'count' | 'uniqueIdentities' | 'uniqueCustomers' | 'durationMs'>;
6576
6700
  };
6701
+ export type AdminMarketingEventGeoRollupQueryVariables = Exact<{
6702
+ input: MarketingEventGeoRollupInput;
6703
+ }>;
6704
+ export type AdminMarketingEventGeoRollupQuery = {
6705
+ marketingEventGeoRollup: Array<Pick<MarketingEventGeoBucket, 'country' | 'region' | 'count' | 'uniqueIdentities'>>;
6706
+ };
6707
+ export type AdminMarketingLiveVisitorsQueryVariables = Exact<{
6708
+ input: MarketingLiveVisitorsInput;
6709
+ }>;
6710
+ export type AdminMarketingLiveVisitorsQuery = {
6711
+ marketingLiveVisitors: Array<Pick<MarketingLiveVisitor, 'identityId' | 'latitude' | 'longitude' | 'city' | 'country' | 'deviceType' | 'browser' | 'os' | 'isCustomer' | 'lastEventType' | 'lastSeenAt' | 'eventCount'>>;
6712
+ };
6577
6713
  export type AdminMarketingIdentityIdentifierFieldsFragment = Pick<MarketingIdentityIdentifier, 'id' | 'key' | 'value' | 'capturedAt' | 'position'>;
6578
6714
  export type AdminMarketingIdentityFieldsFragment = (Pick<MarketingIdentity, 'id' | 'sessionToken' | 'customerId' | 'email' | 'emailSha256' | 'phone' | 'phoneSha256' | 'ipAddress' | 'userAgent' | 'country' | 'region' | 'city' | 'postalCode' | 'deviceType' | 'os' | 'browser' | 'firstSeenAt' | 'lastSeenAt' | 'createdAt' | 'updatedAt'> & {
6579
6715
  identifiers: Array<Pick<MarketingIdentityIdentifier, 'id' | 'key' | 'value' | 'capturedAt' | 'position'>>;
@@ -6686,6 +6822,24 @@ export type CompleteShopMutation = {
6686
6822
  onboarding: Pick<Onboarding, 'id' | 'currentStep' | 'completedAt'>;
6687
6823
  };
6688
6824
  };
6825
+ export type OrderAnalyticsFieldFragment = (Pick<OrderAnalytics, 'totalRevenueMinor' | 'orderCount' | 'averageOrderValueMinor'> & {
6826
+ revenueByDay: Array<Pick<OrderRevenuePoint, 'day' | 'revenueMinor' | 'orderCount'>>;
6827
+ });
6828
+ export type TopProductFieldFragment = Pick<TopProduct, 'productId' | 'productName' | 'unitsSold' | 'revenueMinor'>;
6829
+ export type OrderAnalyticsQueryVariables = Exact<{
6830
+ input: OrderAnalyticsInput;
6831
+ }>;
6832
+ export type OrderAnalyticsQuery = {
6833
+ orderAnalytics: (Pick<OrderAnalytics, 'totalRevenueMinor' | 'orderCount' | 'averageOrderValueMinor'> & {
6834
+ revenueByDay: Array<Pick<OrderRevenuePoint, 'day' | 'revenueMinor' | 'orderCount'>>;
6835
+ });
6836
+ };
6837
+ export type TopProductsQueryVariables = Exact<{
6838
+ input: TopProductsInput;
6839
+ }>;
6840
+ export type TopProductsQuery = {
6841
+ topProducts: Array<Pick<TopProduct, 'productId' | 'productName' | 'unitsSold' | 'revenueMinor'>>;
6842
+ };
6689
6843
  export type ModifyOrderMutationVariables = Exact<{
6690
6844
  input: ModifyOrderInput;
6691
6845
  }>;
@@ -10183,6 +10337,13 @@ export type ReorderShippingGatewayRoutingRulesMutation = {
10183
10337
  flatRates: Array<Pick<ShippingGatewayRoutingFlatRate, 'id' | 'code' | 'name' | 'amount' | 'currencyCode' | 'estimatedDays'>>;
10184
10338
  })>;
10185
10339
  };
10340
+ export type LowStockVariantFieldFragment = Pick<LowStockVariant, 'variantId' | 'name' | 'sku' | 'available' | 'threshold'>;
10341
+ export type LowStockVariantsQueryVariables = Exact<{
10342
+ input: LowStockVariantsInput;
10343
+ }>;
10344
+ export type LowStockVariantsQuery = {
10345
+ lowStockVariants: Array<Pick<LowStockVariant, 'variantId' | 'name' | 'sku' | 'available' | 'threshold'>>;
10346
+ };
10186
10347
  export type StockLocationFieldFragment = (Pick<StockLocation, 'id' | 'createdAt' | 'updatedAt' | 'name' | 'description' | 'locationType'> & {
10187
10348
  address?: Maybe<Pick<StockLocationAddress, 'id' | 'createdAt' | 'updatedAt' | 'fullName' | 'company' | 'streetLine1' | 'streetLine2' | 'city' | 'province' | 'postalCode' | 'countryCode' | 'phoneNumber'>>;
10188
10349
  });
package/dist/admin.d.ts CHANGED
@@ -17,6 +17,7 @@ export { CollectionCategory } from './admin.generated';
17
17
  export { CountryCategory } from './admin.generated';
18
18
  export { AddressCategory } from './admin.generated';
19
19
  export { GroupCategory } from './admin.generated';
20
+ export { CustomerAnalyticsCategory } from './admin.generated';
20
21
  export { CustomerGroupCategory } from './admin.generated';
21
22
  export { CustomerCategory } from './admin.generated';
22
23
  export { DeploymentCategory } from './admin.generated';
@@ -35,6 +36,7 @@ export { CouponCategory } from './admin.generated';
35
36
  export { DraftCategory } from './admin.generated';
36
37
  export { ModificationCategory } from './admin.generated';
37
38
  export { NoteCategory } from './admin.generated';
39
+ export { OrderAnalyticsCategory } from './admin.generated';
38
40
  export { OrderModificationCategory } from './admin.generated';
39
41
  export { OrderCategory } from './admin.generated';
40
42
  export { PaymentCategory } from './admin.generated';
@@ -52,6 +54,7 @@ export { SearchCategory } from './admin.generated';
52
54
  export { SellerCategory } from './admin.generated';
53
55
  export { SellingPlanCategory } from './admin.generated';
54
56
  export { ShippingCategory } from './admin.generated';
57
+ export { StockAnalyticsCategory } from './admin.generated';
55
58
  export { StockCategory } from './admin.generated';
56
59
  export { SubscriptionAnalyticsCategory } from './admin.generated';
57
60
  export { SubscriptionCategory } from './admin.generated';
@@ -166,6 +166,11 @@ export declare class CountryCategory {
166
166
  updateCountry(variables: Types.UpdateCountryMutationVariables): QueryObservable<Types.UpdateCountryMutation>;
167
167
  deleteCountry(variables: Types.DeleteCountryMutationVariables): QueryObservable<Types.DeleteCountryMutation>;
168
168
  }
169
+ export declare class CustomerAnalyticsCategory {
170
+ private readonly client;
171
+ constructor(client: BaseGraphQLClient);
172
+ customerSignupsByDay(variables: Types.CustomerSignupsByDayQueryVariables): QueryObservable<Types.CustomerSignupsByDayQuery>;
173
+ }
169
174
  export declare class CustomerGroupCategory {
170
175
  private readonly client;
171
176
  constructor(client: BaseGraphQLClient);
@@ -217,6 +222,7 @@ export declare class DeploymentCategory {
217
222
  adminCreateDeployment(variables: Types.AdminCreateDeploymentMutationVariables): QueryObservable<Types.AdminCreateDeploymentMutation>;
218
223
  adminDeleteDeployment(variables: Types.AdminDeleteDeploymentMutationVariables): QueryObservable<Types.AdminDeleteDeploymentMutation>;
219
224
  adminDeployApp(variables: Types.AdminDeployAppMutationVariables): QueryObservable<Types.AdminDeployAppMutation>;
225
+ adminPublishDeployment(variables: Types.AdminPublishDeploymentMutationVariables): QueryObservable<Types.AdminPublishDeploymentMutation>;
220
226
  adminScaleDeployment(variables: Types.AdminScaleDeploymentMutationVariables): QueryObservable<Types.AdminScaleDeploymentMutation>;
221
227
  adminSetDeploymentEnv(variables: Types.AdminSetDeploymentEnvMutationVariables): QueryObservable<Types.AdminSetDeploymentEnvMutation>;
222
228
  adminUnsetDeploymentEnv(variables: Types.AdminUnsetDeploymentEnvMutationVariables): QueryObservable<Types.AdminUnsetDeploymentEnvMutation>;
@@ -225,6 +231,7 @@ export declare class DeploymentCategory {
225
231
  adminPollDeviceToken(variables: Types.AdminPollDeviceTokenMutationVariables): QueryObservable<Types.AdminPollDeviceTokenMutation>;
226
232
  adminApproveDeviceCode(variables: Types.AdminApproveDeviceCodeMutationVariables): QueryObservable<Types.AdminApproveDeviceCodeMutation>;
227
233
  adminDeploymentLogs(variables: Types.AdminDeploymentLogsSubscriptionVariables): Observable<Types.AdminDeploymentLogsSubscription>;
234
+ adminDeploymentStatusChanged(variables: Types.AdminDeploymentStatusChangedSubscriptionVariables): Observable<Types.AdminDeploymentStatusChangedSubscription>;
228
235
  }
229
236
  export declare class FacetCategory {
230
237
  private readonly client;
@@ -297,6 +304,8 @@ export declare class MarketingEventCategory {
297
304
  constructor(client: BaseGraphQLClient);
298
305
  adminIngestMarketingEvent(variables: Types.AdminIngestMarketingEventMutationVariables): QueryObservable<Types.AdminIngestMarketingEventMutation>;
299
306
  adminQueryMarketingEventSummary(variables: Types.AdminQueryMarketingEventSummaryQueryVariables): QueryObservable<Types.AdminQueryMarketingEventSummaryQuery>;
307
+ adminMarketingEventGeoRollup(variables: Types.AdminMarketingEventGeoRollupQueryVariables): QueryObservable<Types.AdminMarketingEventGeoRollupQuery>;
308
+ adminMarketingLiveVisitors(variables: Types.AdminMarketingLiveVisitorsQueryVariables): QueryObservable<Types.AdminMarketingLiveVisitorsQuery>;
300
309
  }
301
310
  export declare class MarketingIdentityCategory {
302
311
  private readonly client;
@@ -321,6 +330,12 @@ export declare class OnboardingCategory {
321
330
  updateProfile(variables: Types.UpdateProfileMutationVariables): QueryObservable<Types.UpdateProfileMutation>;
322
331
  completeShop(variables: Types.CompleteShopMutationVariables): QueryObservable<Types.CompleteShopMutation>;
323
332
  }
333
+ export declare class OrderAnalyticsCategory {
334
+ private readonly client;
335
+ constructor(client: BaseGraphQLClient);
336
+ orderAnalytics(variables: Types.OrderAnalyticsQueryVariables): QueryObservable<Types.OrderAnalyticsQuery>;
337
+ topProducts(variables: Types.TopProductsQueryVariables): QueryObservable<Types.TopProductsQuery>;
338
+ }
324
339
  export declare class OrderModificationCategory {
325
340
  private readonly client;
326
341
  constructor(client: BaseGraphQLClient);
@@ -576,6 +591,11 @@ export declare class ShippingCategory {
576
591
  deleteShippingGatewayRoutingRule(variables: Types.DeleteShippingGatewayRoutingRuleMutationVariables): QueryObservable<Types.DeleteShippingGatewayRoutingRuleMutation>;
577
592
  reorderShippingGatewayRoutingRules(variables: Types.ReorderShippingGatewayRoutingRulesMutationVariables): QueryObservable<Types.ReorderShippingGatewayRoutingRulesMutation>;
578
593
  }
594
+ export declare class StockAnalyticsCategory {
595
+ private readonly client;
596
+ constructor(client: BaseGraphQLClient);
597
+ lowStockVariants(variables: Types.LowStockVariantsQueryVariables): QueryObservable<Types.LowStockVariantsQuery>;
598
+ }
579
599
  export declare class StockCategory {
580
600
  private readonly client;
581
601
  constructor(client: BaseGraphQLClient);
@@ -679,6 +699,7 @@ export declare class AdminNamespace {
679
699
  private readonly _chat;
680
700
  private readonly _collection;
681
701
  private readonly _country;
702
+ private readonly _customerAnalytics;
682
703
  private readonly _customerGroup;
683
704
  private readonly _customer;
684
705
  private readonly _address;
@@ -695,6 +716,7 @@ export declare class AdminNamespace {
695
716
  private readonly _marketingIdentity;
696
717
  private readonly _mission;
697
718
  private readonly _onboarding;
719
+ private readonly _orderAnalytics;
698
720
  private readonly _orderModification;
699
721
  private readonly _order;
700
722
  private readonly _coupon;
@@ -716,6 +738,7 @@ export declare class AdminNamespace {
716
738
  private readonly _seller;
717
739
  private readonly _sellingPlan;
718
740
  private readonly _shipping;
741
+ private readonly _stockAnalytics;
719
742
  private readonly _stock;
720
743
  private readonly _subscriptionAnalytics;
721
744
  private readonly _subscription;
@@ -739,6 +762,7 @@ export declare class AdminNamespace {
739
762
  get chat(): ChatCategory;
740
763
  get collection(): CollectionCategory;
741
764
  get country(): CountryCategory;
765
+ get customerAnalytics(): CustomerAnalyticsCategory;
742
766
  get customerGroup(): CustomerGroupCategory;
743
767
  get customer(): CustomerCategory;
744
768
  get address(): AddressCategory;
@@ -755,6 +779,7 @@ export declare class AdminNamespace {
755
779
  get marketingIdentity(): MarketingIdentityCategory;
756
780
  get mission(): MissionCategory;
757
781
  get onboarding(): OnboardingCategory;
782
+ get orderAnalytics(): OrderAnalyticsCategory;
758
783
  get orderModification(): OrderModificationCategory;
759
784
  get order(): OrderCategory;
760
785
  get coupon(): CouponCategory;
@@ -776,6 +801,7 @@ export declare class AdminNamespace {
776
801
  get seller(): SellerCategory;
777
802
  get sellingPlan(): SellingPlanCategory;
778
803
  get shipping(): ShippingCategory;
804
+ get stockAnalytics(): StockAnalyticsCategory;
779
805
  get stock(): StockCategory;
780
806
  get subscriptionAnalytics(): SubscriptionAnalyticsCategory;
781
807
  get subscription(): SubscriptionCategory;
@@ -807,6 +833,7 @@ export type Country = Types.CountryFieldFragment;
807
833
  export type CountryTranslation = Types.CountryTranslationFieldFragment;
808
834
  export type Customer = Types.CustomerFieldFragment;
809
835
  export type CustomerGroup = Types.CustomerGroupFieldFragment;
836
+ export type CustomerSignupPoint = Types.CustomerSignupPointFieldFragment;
810
837
  export type Deployment = Types.DeploymentFieldFragment;
811
838
  export type DunningAttempt = Types.DunningAttemptFieldFragment;
812
839
  export type Facet = Types.FacetFieldFragment;
@@ -820,6 +847,7 @@ export type FulfillmentRequest = Types.FulfillmentRequestFieldFragment;
820
847
  export type FulfillmentRequestLine = Types.FulfillmentRequestLineFieldFragment;
821
848
  export type HistoryEntry = Types.HistoryEntryFieldFragment;
822
849
  export type HoldReason = Types.HoldReasonFieldFragment;
850
+ export type LowStockVariant = Types.LowStockVariantFieldFragment;
823
851
  export type ManageablePlugin = Types.ManageablePluginFieldsFragment;
824
852
  export type Market = Types.MarketFieldFragment;
825
853
  export type MarketingIdentity = Types.AdminMarketingIdentityFieldsFragment;
@@ -828,6 +856,7 @@ export type Mission = Types.MissionFieldFragment;
828
856
  export type MissionRepoRef = Types.MissionRepoRefFieldFragment;
829
857
  export type Order = Types.OrderFieldFragment;
830
858
  export type OrderAddress = Types.OrderAddressFieldFragment;
859
+ export type OrderAnalytics = Types.OrderAnalyticsFieldFragment;
831
860
  export type OrderDiscount = Types.DiscountFieldFragment;
832
861
  export type OrderLine = Types.OrderLineFieldFragment;
833
862
  export type OrderModification = Types.OrderModificationFieldFragment;
@@ -868,6 +897,7 @@ export type SubscriptionCreditBalance = Types.SubscriptionCreditBalanceFieldFrag
868
897
  export type SubscriptionVariantConfig = Types.SubscriptionVariantConfigFieldFragment;
869
898
  export type Surcharge = Types.SurchargeFieldFragment;
870
899
  export type TaxRate = Types.TaxRateFieldFragment;
900
+ export type TopProduct = Types.TopProductFieldFragment;
871
901
  export type UsageMetric = Types.UsageMetricFieldFragment;
872
902
  export type WorkspaceReadiness = Types.WorkspaceReadinessFieldFragment;
873
903
  export type Zone = Types.ZoneFieldFragment;