@poweredbysous/storefront-all-sdk 3.1.0 → 3.2.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/dist/index.d.cts CHANGED
@@ -7126,24 +7126,10 @@ interface components {
7126
7126
  /**
7127
7127
  * @description How many products this category shows, descendants included.
7128
7128
  *
7129
- * Counted through the compliance gate (D15), because the count and the
7130
- * listing are one read model: ``/categories/`` reported 5 while
7131
- * ``/categories/<id>/products/`` returned 0, which discloses how many
7132
- * hidden products sit in each category and, by diffing, which categories
7133
- * are affected. Search's ``total`` had already closed the same gap.
7134
- *
7135
- * No ``annotated_product_count`` shortcut any more: a ``Count()`` in the
7136
- * view cannot know the verdict, so such an annotation would be an ungated
7137
- * number that silently won over this one.
7138
- *
7139
7129
  * The listing precomputes every category's count in one pass
7140
- * (``views._build_gated_counts``) and passes it in context, because doing
7141
- * it per category asked the gate — a fixed handful of queries however
7142
- * many ids it is given — once per category in the tree. ``MAX_DEPTH = 4``
7143
- * bounds the depth but not the breadth, and breadth is what drives it.
7144
- *
7145
- * The fallback below is the single-object path (retrieve), where there is
7146
- * no tree to amortise over and one gate call is the whole cost.
7130
+ * (``views._build_product_counts``) and passes it in context; the
7131
+ * fallback below is the single-object path (retrieve), which counts its
7132
+ * own subtree directly.
7147
7133
  */
7148
7134
  readonly product_count: number;
7149
7135
  };
@@ -7539,6 +7525,14 @@ interface components {
7539
7525
  /** Format: date-time */
7540
7526
  disabled_at: string | null;
7541
7527
  };
7528
+ /**
7529
+ * @description What merchant-portal-backend's publish needs to know about a store
7530
+ * whose delivery methods the portal's toggles own.
7531
+ */
7532
+ DeliveryMethodToggles: {
7533
+ wizard_choice_applies: components["schemas"]["WizardChoiceApplies"];
7534
+ publish_readiness: string[];
7535
+ };
7542
7536
  /**
7543
7537
  * @description Merchant-facing CRUD serializer for :class:`Discount`.
7544
7538
  *
@@ -7744,6 +7738,17 @@ interface components {
7744
7738
  * @enum {string}
7745
7739
  */
7746
7740
  FulfillmentTypeEnum: "nationwide_delivery" | "local_delivery" | "pickup" | "room_service";
7741
+ /**
7742
+ * @description What publish provisioned (``fulfillment.services
7743
+ * .StoreFulfilmentProvisionResult``).
7744
+ */
7745
+ FulfilmentProvisioning: {
7746
+ pickup_enabled: boolean;
7747
+ uber_direct_enabled: boolean;
7748
+ uber_direct_skipped_reason: string | null;
7749
+ products_assigned: number;
7750
+ products_unassigned: number;
7751
+ };
7747
7752
  GroupOrderItemsRequest: {
7748
7753
  participant_id: string;
7749
7754
  };
@@ -9394,6 +9399,7 @@ interface components {
9394
9399
  readonly updated_at?: string;
9395
9400
  readonly brand_assets?: components["schemas"]["StoreBrandAsset"][];
9396
9401
  readonly uber_direct_supported_countries?: string[];
9402
+ readonly delivery_method_toggles?: components["schemas"]["DeliveryMethodToggles"] | null;
9397
9403
  };
9398
9404
  PatchedSurcharge: {
9399
9405
  readonly id?: number;
@@ -10493,6 +10499,7 @@ interface components {
10493
10499
  readonly updated_at: string;
10494
10500
  readonly brand_assets: components["schemas"]["StoreBrandAsset"][];
10495
10501
  readonly uber_direct_supported_countries: string[];
10502
+ readonly delivery_method_toggles: components["schemas"]["DeliveryMethodToggles"] | null;
10496
10503
  };
10497
10504
  /**
10498
10505
  * @description * `draft` - Draft
@@ -10500,6 +10507,49 @@ interface components {
10500
10507
  * @enum {string}
10501
10508
  */
10502
10509
  StoreOnboardingStatusEnum: "draft" | "published";
10510
+ /**
10511
+ * @description The published onboarding row, plus what publish provisioned -- the only
10512
+ * way a merchant learns why an Uber Direct they ticked is not live.
10513
+ *
10514
+ * The provisioning result comes in through ``context["provisioning"]``.
10515
+ */
10516
+ StorePublishResponse: {
10517
+ slug: string;
10518
+ name?: string;
10519
+ tagline?: string;
10520
+ description?: string;
10521
+ logo_text?: string;
10522
+ theme?: unknown;
10523
+ layout?: string;
10524
+ languages?: unknown;
10525
+ default_language?: string;
10526
+ currency?: string;
10527
+ country?: string;
10528
+ timezone?: string;
10529
+ contact?: unknown;
10530
+ hours?: unknown;
10531
+ social?: unknown;
10532
+ seo?: unknown;
10533
+ fulfilment?: unknown;
10534
+ cuisine?: string;
10535
+ price_range?: string;
10536
+ product_placeholder?: string;
10537
+ analytics?: unknown;
10538
+ labels?: unknown;
10539
+ frame_ancestors?: unknown;
10540
+ multi_store?: boolean;
10541
+ brand_slug?: string;
10542
+ default_store?: string;
10543
+ readonly status: components["schemas"]["StoreOnboardingStatusEnum"];
10544
+ /** Format: date-time */
10545
+ readonly published_at: string | null;
10546
+ /** Format: date-time */
10547
+ readonly updated_at: string;
10548
+ readonly brand_assets: components["schemas"]["StoreBrandAsset"][];
10549
+ readonly uber_direct_supported_countries: string[];
10550
+ readonly delivery_method_toggles: components["schemas"]["DeliveryMethodToggles"] | null;
10551
+ readonly provisioning: components["schemas"]["FulfilmentProvisioning"];
10552
+ };
10503
10553
  /**
10504
10554
  * @description Customer-facing profile view (no CRM/analytics fields).
10505
10555
  *
@@ -10837,6 +10887,11 @@ interface components {
10837
10887
  completed_at: string | null;
10838
10888
  eligibility_snapshot: components["schemas"]["EligibilitySnapshot"];
10839
10889
  };
10890
+ /** @description Per delivery method: whether the wizard's toggle still decides it. */
10891
+ WizardChoiceApplies: {
10892
+ uber_direct: boolean;
10893
+ lieferando: boolean;
10894
+ };
10840
10895
  /** @description Customer-facing Zeemijlen balance + redemption economics. */
10841
10896
  ZeemijlenSummary: {
10842
10897
  points_balance: number;
@@ -21101,7 +21156,7 @@ interface operations {
21101
21156
  };
21102
21157
  };
21103
21158
  };
21104
- /** @description Possible error codes: `MISSING_GATEWAY_ID`, `GATEWAY_NOT_ENABLED`, `INVALID_GATEWAY`, `MISSING_GIFT_CARD_CODE`, `INVALID_TAX_PROVIDER`, `PRODUCT_UNAVAILABLE`. Retryable: no. Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
21159
+ /** @description Possible error codes: `MISSING_GATEWAY_ID`, `GATEWAY_NOT_ENABLED`, `INVALID_GATEWAY`, `MISSING_GIFT_CARD_CODE`, `INVALID_TAX_PROVIDER`, `PRODUCT_UNAVAILABLE`, `SERVICE_POINT_REQUIRED`. Retryable: no. Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
21105
21160
  400: {
21106
21161
  headers: {
21107
21162
  [name: string]: unknown;
@@ -27591,7 +27646,7 @@ interface operations {
27591
27646
  [name: string]: unknown;
27592
27647
  };
27593
27648
  content: {
27594
- "application/json": components["schemas"]["StoreOnboarding"];
27649
+ "application/json": components["schemas"]["StorePublishResponse"];
27595
27650
  };
27596
27651
  };
27597
27652
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
package/dist/index.d.ts CHANGED
@@ -7126,24 +7126,10 @@ interface components {
7126
7126
  /**
7127
7127
  * @description How many products this category shows, descendants included.
7128
7128
  *
7129
- * Counted through the compliance gate (D15), because the count and the
7130
- * listing are one read model: ``/categories/`` reported 5 while
7131
- * ``/categories/<id>/products/`` returned 0, which discloses how many
7132
- * hidden products sit in each category and, by diffing, which categories
7133
- * are affected. Search's ``total`` had already closed the same gap.
7134
- *
7135
- * No ``annotated_product_count`` shortcut any more: a ``Count()`` in the
7136
- * view cannot know the verdict, so such an annotation would be an ungated
7137
- * number that silently won over this one.
7138
- *
7139
7129
  * The listing precomputes every category's count in one pass
7140
- * (``views._build_gated_counts``) and passes it in context, because doing
7141
- * it per category asked the gate — a fixed handful of queries however
7142
- * many ids it is given — once per category in the tree. ``MAX_DEPTH = 4``
7143
- * bounds the depth but not the breadth, and breadth is what drives it.
7144
- *
7145
- * The fallback below is the single-object path (retrieve), where there is
7146
- * no tree to amortise over and one gate call is the whole cost.
7130
+ * (``views._build_product_counts``) and passes it in context; the
7131
+ * fallback below is the single-object path (retrieve), which counts its
7132
+ * own subtree directly.
7147
7133
  */
7148
7134
  readonly product_count: number;
7149
7135
  };
@@ -7539,6 +7525,14 @@ interface components {
7539
7525
  /** Format: date-time */
7540
7526
  disabled_at: string | null;
7541
7527
  };
7528
+ /**
7529
+ * @description What merchant-portal-backend's publish needs to know about a store
7530
+ * whose delivery methods the portal's toggles own.
7531
+ */
7532
+ DeliveryMethodToggles: {
7533
+ wizard_choice_applies: components["schemas"]["WizardChoiceApplies"];
7534
+ publish_readiness: string[];
7535
+ };
7542
7536
  /**
7543
7537
  * @description Merchant-facing CRUD serializer for :class:`Discount`.
7544
7538
  *
@@ -7744,6 +7738,17 @@ interface components {
7744
7738
  * @enum {string}
7745
7739
  */
7746
7740
  FulfillmentTypeEnum: "nationwide_delivery" | "local_delivery" | "pickup" | "room_service";
7741
+ /**
7742
+ * @description What publish provisioned (``fulfillment.services
7743
+ * .StoreFulfilmentProvisionResult``).
7744
+ */
7745
+ FulfilmentProvisioning: {
7746
+ pickup_enabled: boolean;
7747
+ uber_direct_enabled: boolean;
7748
+ uber_direct_skipped_reason: string | null;
7749
+ products_assigned: number;
7750
+ products_unassigned: number;
7751
+ };
7747
7752
  GroupOrderItemsRequest: {
7748
7753
  participant_id: string;
7749
7754
  };
@@ -9394,6 +9399,7 @@ interface components {
9394
9399
  readonly updated_at?: string;
9395
9400
  readonly brand_assets?: components["schemas"]["StoreBrandAsset"][];
9396
9401
  readonly uber_direct_supported_countries?: string[];
9402
+ readonly delivery_method_toggles?: components["schemas"]["DeliveryMethodToggles"] | null;
9397
9403
  };
9398
9404
  PatchedSurcharge: {
9399
9405
  readonly id?: number;
@@ -10493,6 +10499,7 @@ interface components {
10493
10499
  readonly updated_at: string;
10494
10500
  readonly brand_assets: components["schemas"]["StoreBrandAsset"][];
10495
10501
  readonly uber_direct_supported_countries: string[];
10502
+ readonly delivery_method_toggles: components["schemas"]["DeliveryMethodToggles"] | null;
10496
10503
  };
10497
10504
  /**
10498
10505
  * @description * `draft` - Draft
@@ -10500,6 +10507,49 @@ interface components {
10500
10507
  * @enum {string}
10501
10508
  */
10502
10509
  StoreOnboardingStatusEnum: "draft" | "published";
10510
+ /**
10511
+ * @description The published onboarding row, plus what publish provisioned -- the only
10512
+ * way a merchant learns why an Uber Direct they ticked is not live.
10513
+ *
10514
+ * The provisioning result comes in through ``context["provisioning"]``.
10515
+ */
10516
+ StorePublishResponse: {
10517
+ slug: string;
10518
+ name?: string;
10519
+ tagline?: string;
10520
+ description?: string;
10521
+ logo_text?: string;
10522
+ theme?: unknown;
10523
+ layout?: string;
10524
+ languages?: unknown;
10525
+ default_language?: string;
10526
+ currency?: string;
10527
+ country?: string;
10528
+ timezone?: string;
10529
+ contact?: unknown;
10530
+ hours?: unknown;
10531
+ social?: unknown;
10532
+ seo?: unknown;
10533
+ fulfilment?: unknown;
10534
+ cuisine?: string;
10535
+ price_range?: string;
10536
+ product_placeholder?: string;
10537
+ analytics?: unknown;
10538
+ labels?: unknown;
10539
+ frame_ancestors?: unknown;
10540
+ multi_store?: boolean;
10541
+ brand_slug?: string;
10542
+ default_store?: string;
10543
+ readonly status: components["schemas"]["StoreOnboardingStatusEnum"];
10544
+ /** Format: date-time */
10545
+ readonly published_at: string | null;
10546
+ /** Format: date-time */
10547
+ readonly updated_at: string;
10548
+ readonly brand_assets: components["schemas"]["StoreBrandAsset"][];
10549
+ readonly uber_direct_supported_countries: string[];
10550
+ readonly delivery_method_toggles: components["schemas"]["DeliveryMethodToggles"] | null;
10551
+ readonly provisioning: components["schemas"]["FulfilmentProvisioning"];
10552
+ };
10503
10553
  /**
10504
10554
  * @description Customer-facing profile view (no CRM/analytics fields).
10505
10555
  *
@@ -10837,6 +10887,11 @@ interface components {
10837
10887
  completed_at: string | null;
10838
10888
  eligibility_snapshot: components["schemas"]["EligibilitySnapshot"];
10839
10889
  };
10890
+ /** @description Per delivery method: whether the wizard's toggle still decides it. */
10891
+ WizardChoiceApplies: {
10892
+ uber_direct: boolean;
10893
+ lieferando: boolean;
10894
+ };
10840
10895
  /** @description Customer-facing Zeemijlen balance + redemption economics. */
10841
10896
  ZeemijlenSummary: {
10842
10897
  points_balance: number;
@@ -21101,7 +21156,7 @@ interface operations {
21101
21156
  };
21102
21157
  };
21103
21158
  };
21104
- /** @description Possible error codes: `MISSING_GATEWAY_ID`, `GATEWAY_NOT_ENABLED`, `INVALID_GATEWAY`, `MISSING_GIFT_CARD_CODE`, `INVALID_TAX_PROVIDER`, `PRODUCT_UNAVAILABLE`. Retryable: no. Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
21159
+ /** @description Possible error codes: `MISSING_GATEWAY_ID`, `GATEWAY_NOT_ENABLED`, `INVALID_GATEWAY`, `MISSING_GIFT_CARD_CODE`, `INVALID_TAX_PROVIDER`, `PRODUCT_UNAVAILABLE`, `SERVICE_POINT_REQUIRED`. Retryable: no. Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_NOT_PAID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `CHECKOUT_VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_CART_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GATEWAY_ID`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_GATEWAY`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_SHIPPING_METHOD`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `SHIPPING_FULFILLMENT_MISMATCH`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `MISSING_GIFT_CARD_CODE`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `GATEWAY_NOT_ENABLED`. Use `x-error-codes` for machine-readable retryability metadata. Possible error codes include `INVALID_TAX_PROVIDER`. Use `x-error-codes` for machine-readable retryability metadata. */
21105
21160
  400: {
21106
21161
  headers: {
21107
21162
  [name: string]: unknown;
@@ -27591,7 +27646,7 @@ interface operations {
27591
27646
  [name: string]: unknown;
27592
27647
  };
27593
27648
  content: {
27594
- "application/json": components["schemas"]["StoreOnboarding"];
27649
+ "application/json": components["schemas"]["StorePublishResponse"];
27595
27650
  };
27596
27651
  };
27597
27652
  /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@poweredbysous/storefront-all-sdk",
3
- "version": "3.1.0",
3
+ "version": "3.2.0",
4
4
  "description": "Type-safe TypeScript SDK for all SOUS Storefront Backend endpoints",
5
5
  "license": "UNLICENSED",
6
6
  "private": false,