@poweredbysous/storefront-sdk 3.0.2 → 3.0.4

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/dist/index.d.cts CHANGED
@@ -1459,7 +1459,13 @@ interface paths {
1459
1459
  * @description Return the authenticated merchant's information.
1460
1460
  *
1461
1461
  * Uses the default StoreAuthentication and IsStore permission.
1462
- * Useful for testing merchant authentication.
1462
+ *
1463
+ * With ``?include=location`` the payload also carries the store's pickup
1464
+ * address and position, so the ExploreSOUS directory can pin it. That costs
1465
+ * a (cached) geocode, so it is opt-in: the store and product pages read this
1466
+ * endpoint without it and never pay for one. ``address`` is null without an
1467
+ * active pickup location; the coordinates are null when the address cannot
1468
+ * be placed.
1463
1469
  */
1464
1470
  get: operations["merchant_me_retrieve"];
1465
1471
  put?: never;
@@ -2446,14 +2452,14 @@ interface components {
2446
2452
  unit_price_override?: string;
2447
2453
  };
2448
2454
  AddressCheckInput: {
2449
- /** @default */
2450
- address_line_1: string;
2451
- /** @default */
2452
- city: string;
2453
- /** @default */
2454
- postal_code: string;
2455
- /** @default NL */
2456
- country: string;
2455
+ address_line_1?: string;
2456
+ city?: string;
2457
+ postal_code?: string;
2458
+ country?: string;
2459
+ /** Format: double */
2460
+ latitude?: number;
2461
+ /** Format: double */
2462
+ longitude?: number;
2457
2463
  };
2458
2464
  AddressCheckPickupLocation: {
2459
2465
  id: number;
@@ -2465,6 +2471,8 @@ interface components {
2465
2471
  AddressCheckResponse: {
2466
2472
  latitude: string;
2467
2473
  longitude: string;
2474
+ postal_code: string;
2475
+ country: string;
2468
2476
  available_fulfillment_types: string[];
2469
2477
  available_shipping_providers: components["schemas"]["ShippingProviderOption"][];
2470
2478
  pickup_locations: components["schemas"]["AddressCheckPickupLocation"][];
@@ -4520,6 +4528,8 @@ interface components {
4520
4528
  /** @description Cart-level free-delivery threshold, or null when the basket spans carriers that do not agree on one. */
4521
4529
  free_shipping_threshold: string | null;
4522
4530
  remaining_for_free_shipping: string | null;
4531
+ /** @description Products no carrier delivers to this address. The total does not cover them and checkout cannot route them, so the customer must remove them or change the address. Empty when every item ships. */
4532
+ unshippable_product_ids: number[];
4523
4533
  };
4524
4534
  /**
4525
4535
  * @description One carrier's share of the basket. Documentation only — never used to
@@ -4601,11 +4611,23 @@ interface components {
4601
4611
  readonly offers_reusable_packaging: boolean;
4602
4612
  readonly reusable_deposit_amount?: string | null;
4603
4613
  };
4614
+ StoreMeAddress: {
4615
+ address_1: string;
4616
+ address_2: string;
4617
+ city: string;
4618
+ postal_code: string;
4619
+ country: string;
4620
+ };
4604
4621
  StoreMeResponse: {
4605
4622
  id: number;
4606
4623
  public_id: string;
4607
4624
  name: string;
4608
4625
  currency: string;
4626
+ address?: components["schemas"]["StoreMeAddress"] | null;
4627
+ /** Format: double */
4628
+ latitude?: number | null;
4629
+ /** Format: double */
4630
+ longitude?: number | null;
4609
4631
  };
4610
4632
  /**
4611
4633
  * @description Read/write serializer for the store-onboarding wizard.
@@ -12191,7 +12213,10 @@ interface operations {
12191
12213
  };
12192
12214
  merchant_me_retrieve: {
12193
12215
  parameters: {
12194
- query?: never;
12216
+ query?: {
12217
+ /** @description `location` adds `address`, `latitude` and `longitude`. Omit it and those keys are absent and nothing is geocoded. */
12218
+ include?: "location";
12219
+ };
12195
12220
  header?: never;
12196
12221
  path?: never;
12197
12222
  cookie?: never;
package/dist/index.d.ts CHANGED
@@ -1459,7 +1459,13 @@ interface paths {
1459
1459
  * @description Return the authenticated merchant's information.
1460
1460
  *
1461
1461
  * Uses the default StoreAuthentication and IsStore permission.
1462
- * Useful for testing merchant authentication.
1462
+ *
1463
+ * With ``?include=location`` the payload also carries the store's pickup
1464
+ * address and position, so the ExploreSOUS directory can pin it. That costs
1465
+ * a (cached) geocode, so it is opt-in: the store and product pages read this
1466
+ * endpoint without it and never pay for one. ``address`` is null without an
1467
+ * active pickup location; the coordinates are null when the address cannot
1468
+ * be placed.
1463
1469
  */
1464
1470
  get: operations["merchant_me_retrieve"];
1465
1471
  put?: never;
@@ -2446,14 +2452,14 @@ interface components {
2446
2452
  unit_price_override?: string;
2447
2453
  };
2448
2454
  AddressCheckInput: {
2449
- /** @default */
2450
- address_line_1: string;
2451
- /** @default */
2452
- city: string;
2453
- /** @default */
2454
- postal_code: string;
2455
- /** @default NL */
2456
- country: string;
2455
+ address_line_1?: string;
2456
+ city?: string;
2457
+ postal_code?: string;
2458
+ country?: string;
2459
+ /** Format: double */
2460
+ latitude?: number;
2461
+ /** Format: double */
2462
+ longitude?: number;
2457
2463
  };
2458
2464
  AddressCheckPickupLocation: {
2459
2465
  id: number;
@@ -2465,6 +2471,8 @@ interface components {
2465
2471
  AddressCheckResponse: {
2466
2472
  latitude: string;
2467
2473
  longitude: string;
2474
+ postal_code: string;
2475
+ country: string;
2468
2476
  available_fulfillment_types: string[];
2469
2477
  available_shipping_providers: components["schemas"]["ShippingProviderOption"][];
2470
2478
  pickup_locations: components["schemas"]["AddressCheckPickupLocation"][];
@@ -4520,6 +4528,8 @@ interface components {
4520
4528
  /** @description Cart-level free-delivery threshold, or null when the basket spans carriers that do not agree on one. */
4521
4529
  free_shipping_threshold: string | null;
4522
4530
  remaining_for_free_shipping: string | null;
4531
+ /** @description Products no carrier delivers to this address. The total does not cover them and checkout cannot route them, so the customer must remove them or change the address. Empty when every item ships. */
4532
+ unshippable_product_ids: number[];
4523
4533
  };
4524
4534
  /**
4525
4535
  * @description One carrier's share of the basket. Documentation only — never used to
@@ -4601,11 +4611,23 @@ interface components {
4601
4611
  readonly offers_reusable_packaging: boolean;
4602
4612
  readonly reusable_deposit_amount?: string | null;
4603
4613
  };
4614
+ StoreMeAddress: {
4615
+ address_1: string;
4616
+ address_2: string;
4617
+ city: string;
4618
+ postal_code: string;
4619
+ country: string;
4620
+ };
4604
4621
  StoreMeResponse: {
4605
4622
  id: number;
4606
4623
  public_id: string;
4607
4624
  name: string;
4608
4625
  currency: string;
4626
+ address?: components["schemas"]["StoreMeAddress"] | null;
4627
+ /** Format: double */
4628
+ latitude?: number | null;
4629
+ /** Format: double */
4630
+ longitude?: number | null;
4609
4631
  };
4610
4632
  /**
4611
4633
  * @description Read/write serializer for the store-onboarding wizard.
@@ -12191,7 +12213,10 @@ interface operations {
12191
12213
  };
12192
12214
  merchant_me_retrieve: {
12193
12215
  parameters: {
12194
- query?: never;
12216
+ query?: {
12217
+ /** @description `location` adds `address`, `latitude` and `longitude`. Omit it and those keys are absent and nothing is geocoded. */
12218
+ include?: "location";
12219
+ };
12195
12220
  header?: never;
12196
12221
  path?: never;
12197
12222
  cookie?: never;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@poweredbysous/storefront-sdk",
3
- "version": "3.0.2",
3
+ "version": "3.0.4",
4
4
  "description": "Type-safe TypeScript SDK for SOUS Storefront Backend",
5
5
  "license": "UNLICENSED",
6
6
  "private": false,