@lana-commerce/core 14.0.0-alpha.26 → 14.0.0-alpha.28

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lana-commerce/core",
3
- "version": "14.0.0-alpha.26",
3
+ "version": "14.0.0-alpha.28",
4
4
  "description": "Lana JS Core",
5
5
  "scripts": {
6
6
  "test": "jest",
@@ -2422,6 +2422,10 @@ export interface InfoTimezone {
2422
2422
  /** Formatted offset from GMT of the given timezone */
2423
2423
  offset: string;
2424
2424
  }
2425
+ export interface InfoVersion {
2426
+ /** Backend API version */
2427
+ version: string;
2428
+ }
2425
2429
  export interface InfoWebhook {
2426
2430
  event_type: string;
2427
2431
  fields: Array<string>;
@@ -4270,7 +4274,7 @@ export interface Organization {
4270
4274
  id: string;
4271
4275
  } | PaymentMethod | null;
4272
4276
  /** Reason, why shop was deleted */
4273
- delete_reason: ShopDeleteReason;
4277
+ delete_reason: ShopDeleteReason | null;
4274
4278
  /** The date and time when the organization was deleted, RFC 3339 format */
4275
4279
  deleted_at: string | null;
4276
4280
  /** Unique organization identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */
@@ -4281,7 +4285,13 @@ export interface Organization {
4281
4285
  owner?: {
4282
4286
  id: string;
4283
4287
  } | User | null;
4288
+ /** Organization is being transferred to this user */
4289
+ pending_transfer_user?: {
4290
+ id: string;
4291
+ } | User | null;
4284
4292
  subscription: ShopSettingsSubscription;
4293
+ /** Whether organization is in test mode or not */
4294
+ test: boolean;
4285
4295
  /** The date and time when the organization was last updated, RFC 3339 format */
4286
4296
  updated_at: string;
4287
4297
  }
@@ -4292,6 +4302,8 @@ export interface OrganizationCreate {
4292
4302
  name: string;
4293
4303
  /** Unique identifier for the subscription plan a shop is on */
4294
4304
  plan_id?: string | null;
4305
+ /** Whether organization is in test mode or not */
4306
+ test?: boolean | null;
4295
4307
  }
4296
4308
  export interface OrganizationInvitation {
4297
4309
  /** Entity ID the user is invited to */
@@ -7583,14 +7595,16 @@ export interface ShopSettingsNotifications {
7583
7595
  auth_order_notification: boolean;
7584
7596
  /** Whether to send "email_abandoned_checkout" email notifications or not */
7585
7597
  email_abandoned_checkout: boolean;
7586
- /** Whether to send "email_customer_inventory_notification" email notifications or not */
7587
- email_customer_inventory_notification: boolean;
7598
+ /** Whether to send "email_favorite_inventory" email notifications or not */
7599
+ email_favorite_inventory: boolean;
7588
7600
  /** Whether to send "email_order_canceled" email notifications or not */
7589
7601
  email_order_canceled: boolean;
7590
7602
  /** Whether to send "email_order_confirmation" email notifications or not */
7591
7603
  email_order_confirmation: boolean;
7592
7604
  /** Whether to send "email_product_review_reminder" email notifications or not */
7593
7605
  email_product_review_reminder: boolean;
7606
+ /** Whether to send "email_purchase_order" email notifications or not */
7607
+ email_purchase_order: boolean;
7594
7608
  /** Whether to send "email_refund_notification" email notifications or not */
7595
7609
  email_refund_notification: boolean;
7596
7610
  /** Whether to send "email_return_approved" email notifications or not */
@@ -7627,8 +7641,6 @@ export interface ShopSettingsNotifications {
7627
7641
  new_order_notification: boolean;
7628
7642
  /** Whether to send "new_return_notification" email notifications or not */
7629
7643
  new_return_notification: boolean;
7630
- /** Whether to send "purchase_order" email notifications or not */
7631
- purchase_order: boolean;
7632
7644
  /** Whether to send "sms_fulfillment_created" email notifications or not */
7633
7645
  sms_fulfillment_created: boolean;
7634
7646
  /** Whether to send "sms_tracking_attempt_fail" email notifications or not */
@@ -7649,14 +7661,16 @@ export interface ShopSettingsNotificationsCreate {
7649
7661
  auth_order_notification?: boolean | null;
7650
7662
  /** Whether to send "email_abandoned_checkout" email notifications or not */
7651
7663
  email_abandoned_checkout?: boolean | null;
7652
- /** Whether to send "email_customer_inventory_notification" email notifications or not */
7653
- email_customer_inventory_notification?: boolean | null;
7664
+ /** Whether to send "email_favorite_inventory" email notifications or not */
7665
+ email_favorite_inventory?: boolean | null;
7654
7666
  /** Whether to send "email_order_canceled" email notifications or not */
7655
7667
  email_order_canceled?: boolean | null;
7656
7668
  /** Whether to send "email_order_confirmation" email notifications or not */
7657
7669
  email_order_confirmation?: boolean | null;
7658
7670
  /** Whether to send "email_product_review_reminder" email notifications or not */
7659
7671
  email_product_review_reminder?: boolean | null;
7672
+ /** Whether to send "email_purchase_order" email notifications or not */
7673
+ email_purchase_order?: boolean | null;
7660
7674
  /** Whether to send "email_refund_notification" email notifications or not */
7661
7675
  email_refund_notification?: boolean | null;
7662
7676
  /** Whether to send "email_return_approved" email notifications or not */
@@ -7693,8 +7707,6 @@ export interface ShopSettingsNotificationsCreate {
7693
7707
  new_order_notification?: boolean | null;
7694
7708
  /** Whether to send "new_return_notification" email notifications or not */
7695
7709
  new_return_notification?: boolean | null;
7696
- /** Whether to send "purchase_order" email notifications or not */
7697
- purchase_order?: boolean | null;
7698
7710
  /** Whether to send "sms_fulfillment_created" email notifications or not */
7699
7711
  sms_fulfillment_created?: boolean | null;
7700
7712
  /** Whether to send "sms_tracking_attempt_fail" email notifications or not */
@@ -8572,6 +8584,15 @@ export interface UsageStat {
8572
8584
  /** Price per item in USD cents */
8573
8585
  price_per_item: number;
8574
8586
  }
8587
+ export interface UsageStatHistory {
8588
+ /** The date and time when plan period ends */
8589
+ period_end: string;
8590
+ /** The date and time when plan period started */
8591
+ period_start: string;
8592
+ /** Unique shop identifier */
8593
+ shop_id: string;
8594
+ usage_stats: Array<UsageStat>;
8595
+ }
8575
8596
  export interface User {
8576
8597
  /** Raw content with user's bio */
8577
8598
  bio_raw_content: string;
@@ -9623,6 +9644,7 @@ export interface OrganizationExpansionMap {
9623
9644
  "billing_address.province"?: true;
9624
9645
  default_payment_method?: true | PaymentMethodExpansionMap;
9625
9646
  owner?: true | UserExpansionMap;
9647
+ pending_transfer_user?: true | UserExpansionMap;
9626
9648
  }
9627
9649
  export interface OrganizationInvitationExpansionMap {
9628
9650
  roles?: true;
@@ -9632,6 +9654,7 @@ export interface OrganizationPageExpansionMap {
9632
9654
  "items.billing_address.province"?: true;
9633
9655
  "items.default_payment_method"?: true | PaymentMethodExpansionMap;
9634
9656
  "items.owner"?: true | UserExpansionMap;
9657
+ "items.pending_transfer_user"?: true | UserExpansionMap;
9635
9658
  }
9636
9659
  export interface OrganizationUserExpansionMap {
9637
9660
  roles?: true;
@@ -9642,6 +9665,7 @@ export interface OrganizationsHierarchyExpansionMap {
9642
9665
  "organizations.billing_address.province"?: true;
9643
9666
  "organizations.default_payment_method"?: true | PaymentMethodExpansionMap;
9644
9667
  "organizations.owner"?: true | UserExpansionMap;
9668
+ "organizations.pending_transfer_user"?: true | UserExpansionMap;
9645
9669
  "shops.entity"?: true | EntityExpansionMap;
9646
9670
  "shops.organization"?: true | OrganizationExpansionMap;
9647
9671
  "shops.pending_transfer_organization"?: true | OrganizationExpansionMap;
@@ -10131,6 +10155,8 @@ export interface EndpointAnalyticsAudit extends Endpoint<EndpointAnalyticsAudit,
10131
10155
  limit(v: number): EndpointAnalyticsAudit;
10132
10156
  /** Skip N entries (pagination). See also: [Pagination](/overview/concepts/pagination) */
10133
10157
  offset(v: number): EndpointAnalyticsAudit;
10158
+ /** Unique organization identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */
10159
+ organization_id(v: string): EndpointAnalyticsAudit;
10134
10160
  /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */
10135
10161
  shop_id(v: string): EndpointAnalyticsAudit;
10136
10162
  /** Filter results by a user id */
@@ -11524,6 +11550,9 @@ export interface EndpointInfoShippingProviders extends Endpoint<EndpointInfoShip
11524
11550
  export interface EndpointInfoTimezones extends Endpoint<EndpointInfoTimezones, Array<InfoTimezone>> {
11525
11551
  extract(v: Extractor<Array<InfoTimezone>>): EndpointInfoTimezones;
11526
11552
  }
11553
+ export interface EndpointInfoVersion extends Endpoint<EndpointInfoVersion, InfoVersion> {
11554
+ extract(v: Extractor<InfoVersion>): EndpointInfoVersion;
11555
+ }
11527
11556
  export interface EndpointInfoWebhooks extends Endpoint<EndpointInfoWebhooks, Array<InfoWebhook>> {
11528
11557
  /** Output filtering */
11529
11558
  fields(v: Array<string>): EndpointInfoWebhooks;
@@ -12359,6 +12388,10 @@ export interface EndpointOrganizationsModify extends Endpoint<EndpointOrganizati
12359
12388
  expand(v: OrganizationExpansionMap): EndpointOrganizationsModify;
12360
12389
  extract(v: Extractor<Array<Organization>>): EndpointOrganizationsModify;
12361
12390
  }
12391
+ export interface EndpointOrganizationsAcceptOwnership extends Endpoint<EndpointOrganizationsAcceptOwnership, void> {
12392
+ /** Unique organization identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */
12393
+ accept_organization_id(v: string): EndpointOrganizationsAcceptOwnership;
12394
+ }
12362
12395
  export interface EndpointOrganizationsDeleteInit extends Endpoint<EndpointOrganizationsDeleteInit, void> {
12363
12396
  /** Unique organization identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */
12364
12397
  organization_id(v: string): EndpointOrganizationsDeleteInit;
@@ -12403,6 +12436,8 @@ export interface EndpointOrganizationsInvitationsAccept extends Endpoint<Endpoin
12403
12436
  fields(v: Array<string>): EndpointOrganizationsInvitationsAccept;
12404
12437
  /** List of invitation ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */
12405
12438
  ids(v: Array<string>): EndpointOrganizationsInvitationsAccept;
12439
+ /** Unique organization identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */
12440
+ organization_id(v: string): EndpointOrganizationsInvitationsAccept;
12406
12441
  expand(v: OrganizationInvitationExpansionMap): EndpointOrganizationsInvitationsAccept;
12407
12442
  extract(v: Extractor<Array<OrganizationInvitation>>): EndpointOrganizationsInvitationsAccept;
12408
12443
  }
@@ -12531,6 +12566,18 @@ export interface EndpointOrganizationsRolesModify extends Endpoint<EndpointOrgan
12531
12566
  data(v: Array<RoleModify>): EndpointOrganizationsRolesModify;
12532
12567
  extract(v: Extractor<Array<Role>>): EndpointOrganizationsRolesModify;
12533
12568
  }
12569
+ export interface EndpointOrganizationsTransferOwnership extends Endpoint<EndpointOrganizationsTransferOwnership, void> {
12570
+ /** Verification code */
12571
+ code(v: string): EndpointOrganizationsTransferOwnership;
12572
+ /** Unique organization identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */
12573
+ organization_id(v: string): EndpointOrganizationsTransferOwnership;
12574
+ /** Unique user identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */
12575
+ user_id(v: string): EndpointOrganizationsTransferOwnership;
12576
+ }
12577
+ export interface EndpointOrganizationsTransferOwnershipInit extends Endpoint<EndpointOrganizationsTransferOwnershipInit, void> {
12578
+ /** Unique organization identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */
12579
+ organization_id(v: string): EndpointOrganizationsTransferOwnershipInit;
12580
+ }
12534
12581
  export interface EndpointOrganizationsUsage extends Endpoint<EndpointOrganizationsUsage, Array<UsageStat>> {
12535
12582
  /** Upper boundary */
12536
12583
  max(v: string): EndpointOrganizationsUsage;
@@ -12540,6 +12587,11 @@ export interface EndpointOrganizationsUsage extends Endpoint<EndpointOrganizatio
12540
12587
  organization_id(v: string): EndpointOrganizationsUsage;
12541
12588
  extract(v: Extractor<Array<UsageStat>>): EndpointOrganizationsUsage;
12542
12589
  }
12590
+ export interface EndpointOrganizationsUsageHistory extends Endpoint<EndpointOrganizationsUsageHistory, Array<UsageStatHistory>> {
12591
+ /** Unique organization identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */
12592
+ organization_id(v: string): EndpointOrganizationsUsageHistory;
12593
+ extract(v: Extractor<Array<UsageStatHistory>>): EndpointOrganizationsUsageHistory;
12594
+ }
12543
12595
  export interface EndpointOrganizationsUsersDelete extends Endpoint<EndpointOrganizationsUsersDelete, void> {
12544
12596
  /** List of user ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */
12545
12597
  ids(v: Array<string>): EndpointOrganizationsUsersDelete;
@@ -12623,6 +12675,11 @@ export interface EndpointPackagingImport extends Endpoint<EndpointPackagingImpor
12623
12675
  expand(v: ForeignShardedTaskExpansionMap): EndpointPackagingImport;
12624
12676
  extract(v: Extractor<ForeignShardedTask>): EndpointPackagingImport;
12625
12677
  }
12678
+ export interface EndpointPlan extends Endpoint<EndpointPlan, Plan> {
12679
+ /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */
12680
+ shop_id(v: string): EndpointPlan;
12681
+ extract(v: Extractor<Plan>): EndpointPlan;
12682
+ }
12626
12683
  export interface EndpointPriceListsDelete extends Endpoint<EndpointPriceListsDelete, void> {
12627
12684
  /** List of price list ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */
12628
12685
  ids(v: Array<string>): EndpointPriceListsDelete;
@@ -14509,6 +14566,10 @@ export interface EndpointShopsPreferencesCreate extends Endpoint<EndpointShopsPr
14509
14566
  data(v: Array<UIPreferenceCreate>): EndpointShopsPreferencesCreate;
14510
14567
  extract(v: Extractor<Array<UIPreference>>): EndpointShopsPreferencesCreate;
14511
14568
  }
14569
+ export interface EndpointShopsRestore extends Endpoint<EndpointShopsRestore, void> {
14570
+ /** Unique shop identifier. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */
14571
+ shop_id(v: string): EndpointShopsRestore;
14572
+ }
14512
14573
  export interface EndpointShopsSettings extends Endpoint<EndpointShopsSettings, ShopSettings> {
14513
14574
  /** Output filtering */
14514
14575
  fields(v: Array<string>): EndpointShopsSettings;
@@ -15340,7 +15401,7 @@ export interface EndpointUsersWebauthn extends Endpoint<EndpointUsersWebauthn, v
15340
15401
  export interface EndpointVariantInventory extends Endpoint<EndpointVariantInventory, Array<VariantInventory>> {
15341
15402
  /** Output filtering */
15342
15403
  fields(v: Array<string>): EndpointVariantInventory;
15343
- /** List of variant ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */
15404
+ /** List of product variant ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */
15344
15405
  ids(v: Array<string>): EndpointVariantInventory;
15345
15406
  /** When asking for multiple items, allow returning less than was asked (in case some are missing) */
15346
15407
  loose(v: boolean): EndpointVariantInventory;
@@ -15743,6 +15804,7 @@ export interface ReqFunction {
15743
15804
  (ctx: Context, v: "GET:info/roles.json"): EndpointInfoRoles;
15744
15805
  (ctx: Context, v: "GET:info/shipping_providers.json"): EndpointInfoShippingProviders;
15745
15806
  (ctx: Context, v: "GET:info/timezones.json"): EndpointInfoTimezones;
15807
+ (ctx: Context, v: "GET:info/version.json"): EndpointInfoVersion;
15746
15808
  (ctx: Context, v: "GET:info/webhooks.json"): EndpointInfoWebhooks;
15747
15809
  (ctx: Context, v: "GET:inventory_locations.json"): EndpointInventoryLocations;
15748
15810
  (ctx: Context, v: "POST:inventory_locations.json"): EndpointInventoryLocationsCreate;
@@ -15815,6 +15877,7 @@ export interface ReqFunction {
15815
15877
  (ctx: Context, v: "DELETE:organizations.json"): EndpointOrganizationsDelete;
15816
15878
  (ctx: Context, v: "GET:organizations.json"): EndpointOrganizations;
15817
15879
  (ctx: Context, v: "POST:organizations.json"): EndpointOrganizationsCreate;
15880
+ (ctx: Context, v: "POST:organizations/accept_ownership.json"): EndpointOrganizationsAcceptOwnership;
15818
15881
  (ctx: Context, v: "POST:organizations/delete_init.json"): EndpointOrganizationsDeleteInit;
15819
15882
  (ctx: Context, v: "GET:organizations/hierarchy.json"): EndpointOrganizationsHierarchy;
15820
15883
  (ctx: Context, v: "DELETE:organizations/invitations.json"): EndpointOrganizationsInvitationsDelete;
@@ -15833,7 +15896,10 @@ export interface ReqFunction {
15833
15896
  (ctx: Context, v: "DELETE:organizations/roles.json"): EndpointOrganizationsRolesDelete;
15834
15897
  (ctx: Context, v: "GET:organizations/roles.json"): EndpointOrganizationsRoles;
15835
15898
  (ctx: Context, v: "POST:organizations/roles.json"): EndpointOrganizationsRolesCreate;
15899
+ (ctx: Context, v: "POST:organizations/transfer_ownership.json"): EndpointOrganizationsTransferOwnership;
15900
+ (ctx: Context, v: "POST:organizations/transfer_ownership_init.json"): EndpointOrganizationsTransferOwnershipInit;
15836
15901
  (ctx: Context, v: "GET:organizations/usage.json"): EndpointOrganizationsUsage;
15902
+ (ctx: Context, v: "GET:organizations/usage_history.json"): EndpointOrganizationsUsageHistory;
15837
15903
  (ctx: Context, v: "DELETE:organizations/users.json"): EndpointOrganizationsUsersDelete;
15838
15904
  (ctx: Context, v: "GET:organizations/users.json"): EndpointOrganizationsUsers;
15839
15905
  (ctx: Context, v: "POST:organizations/users.json"): EndpointOrganizationsUsers;
@@ -15842,6 +15908,7 @@ export interface ReqFunction {
15842
15908
  (ctx: Context, v: "POST:packaging.json"): EndpointPackagingCreate;
15843
15909
  (ctx: Context, v: "POST:packaging/export.json"): EndpointPackagingExport;
15844
15910
  (ctx: Context, v: "POST:packaging/import.json"): EndpointPackagingImport;
15911
+ (ctx: Context, v: "GET:plan.json"): EndpointPlan;
15845
15912
  (ctx: Context, v: "DELETE:price_lists.json"): EndpointPriceListsDelete;
15846
15913
  (ctx: Context, v: "GET:price_lists.json"): EndpointPriceLists;
15847
15914
  (ctx: Context, v: "POST:price_lists.json"): EndpointPriceListsCreate;
@@ -15993,6 +16060,7 @@ export interface ReqFunction {
15993
16060
  (ctx: Context, v: "GET:shops/page.json"): EndpointShopsPage;
15994
16061
  (ctx: Context, v: "GET:shops/preferences.json"): EndpointShopsPreferences;
15995
16062
  (ctx: Context, v: "POST:shops/preferences.json"): EndpointShopsPreferencesCreate;
16063
+ (ctx: Context, v: "POST:shops/restore.json"): EndpointShopsRestore;
15996
16064
  (ctx: Context, v: "GET:shops/settings.json"): EndpointShopsSettings;
15997
16065
  (ctx: Context, v: "POST:shops/settings.json"): EndpointShopsSettingsCreate;
15998
16066
  (ctx: Context, v: "GET:shops/synonym_settings.json"): EndpointShopsSynonymSettings;
@@ -4952,7 +4952,7 @@ export interface EndpointStorefrontUsers extends Endpoint<EndpointStorefrontUser
4952
4952
  export interface EndpointStorefrontVariantInventory extends Endpoint<EndpointStorefrontVariantInventory, Array<StorefrontVariantInventory>> {
4953
4953
  /** Output filtering */
4954
4954
  fields(v: Array<string>): EndpointStorefrontVariantInventory;
4955
- /** List of variant ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */
4955
+ /** List of product variant ids. See also: [Unique Identifiers](/overview/concepts/unique-identifiers) */
4956
4956
  ids(v: Array<string>): EndpointStorefrontVariantInventory;
4957
4957
  /** When asking for multiple items, allow returning less than was asked (in case some are missing) */
4958
4958
  loose(v: boolean): EndpointStorefrontVariantInventory;