@poweredbysous/storefront-admin-sdk 2.0.1 → 3.0.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
@@ -90,6 +90,46 @@ interface paths {
90
90
  patch?: never;
91
91
  trace?: never;
92
92
  };
93
+ "/api/v1/admin/delivery-methods/": {
94
+ parameters: {
95
+ query?: never;
96
+ header?: never;
97
+ path?: never;
98
+ cookie?: never;
99
+ };
100
+ /**
101
+ * List the company's delivery-method availability
102
+ * @description ``GET /api/v1/admin/delivery-methods/`` — every method's company availability.
103
+ */
104
+ get: operations["admin_delivery_methods_list"];
105
+ put?: never;
106
+ post?: never;
107
+ delete?: never;
108
+ options?: never;
109
+ head?: never;
110
+ patch?: never;
111
+ trace?: never;
112
+ };
113
+ "/api/v1/admin/delivery-methods/{method}/": {
114
+ parameters: {
115
+ query?: never;
116
+ header?: never;
117
+ path?: never;
118
+ cookie?: never;
119
+ };
120
+ get?: never;
121
+ put?: never;
122
+ post?: never;
123
+ delete?: never;
124
+ options?: never;
125
+ head?: never;
126
+ /**
127
+ * Set the company's availability for one delivery method
128
+ * @description ``PATCH /api/v1/admin/delivery-methods/<method>/`` — the owner's switch.
129
+ */
130
+ patch: operations["admin_delivery_methods_partial_update"];
131
+ trace?: never;
132
+ };
93
133
  "/api/v1/admin/discounts/": {
94
134
  parameters: {
95
135
  query?: never;
@@ -860,6 +900,56 @@ interface paths {
860
900
  patch?: never;
861
901
  trace?: never;
862
902
  };
903
+ "/api/v1/admin/stores/{store_public_id}/locations/{location_public_id}/delivery-methods/": {
904
+ parameters: {
905
+ query?: never;
906
+ header?: never;
907
+ path?: never;
908
+ cookie?: never;
909
+ };
910
+ /**
911
+ * List a Location's delivery-method config
912
+ * @description ``GET .../stores/<store_public_id>/locations/<location_public_id>/
913
+ * delivery-methods/``.
914
+ *
915
+ * Config for methods the company has made available, for one Location.
916
+ * A method the company hasn't switched on at all is omitted entirely, not
917
+ * returned disabled — "hidden, not greyed out": a Location cannot see, let
918
+ * alone enable, something its company hasn't agreed to.
919
+ */
920
+ get: operations["admin_stores_locations_delivery_methods_list"];
921
+ put?: never;
922
+ post?: never;
923
+ delete?: never;
924
+ options?: never;
925
+ head?: never;
926
+ patch?: never;
927
+ trace?: never;
928
+ };
929
+ "/api/v1/admin/stores/{store_public_id}/locations/{location_public_id}/delivery-methods/{method}/": {
930
+ parameters: {
931
+ query?: never;
932
+ header?: never;
933
+ path?: never;
934
+ cookie?: never;
935
+ };
936
+ get?: never;
937
+ put?: never;
938
+ post?: never;
939
+ delete?: never;
940
+ options?: never;
941
+ head?: never;
942
+ /**
943
+ * Set a Location's switch/config for one delivery method
944
+ * @description ``PATCH .../stores/<store_public_id>/locations/<location_public_id>/
945
+ * delivery-methods/<method>/``.
946
+ *
947
+ * One Location's own switch and/or its retained config. At least one of
948
+ * ``is_enabled`` or a config field is required; either can be sent alone.
949
+ */
950
+ patch: operations["admin_stores_locations_delivery_methods_partial_update"];
951
+ trace?: never;
952
+ };
863
953
  "/api/v1/admin/stores/{store_public_id}/surcharges/": {
864
954
  parameters: {
865
955
  query?: never;
@@ -3247,6 +3337,13 @@ interface components {
3247
3337
  * @enum {string}
3248
3338
  */
3249
3339
  ChannelTypeEnum: "own_website" | "uber_eats" | "jet" | "other";
3340
+ /** @description One row of the company availability list: a method and its on/off state. */
3341
+ CompanyDeliveryMethodAvailability: {
3342
+ method: components["schemas"]["MethodEnum"];
3343
+ is_available: boolean;
3344
+ /** Format: date-time */
3345
+ updated_at: string | null;
3346
+ };
3250
3347
  ComplianceChoice: {
3251
3348
  slug: string;
3252
3349
  label: string;
@@ -3761,6 +3858,13 @@ interface components {
3761
3858
  * @enum {string}
3762
3859
  */
3763
3860
  MessageStatusEnum: "draft" | "active" | "paused" | "archived";
3861
+ /**
3862
+ * @description * `own_delivery` - Own Delivery
3863
+ * * `uber_direct` - Uber Direct
3864
+ * * `lieferando` - Lieferando
3865
+ * @enum {string}
3866
+ */
3867
+ MethodEnum: "own_delivery" | "uber_direct" | "lieferando";
3764
3868
  ModifyLineItem: {
3765
3869
  /** Format: uuid */
3766
3870
  order_line_item_id: string;
@@ -3792,7 +3896,7 @@ interface components {
3792
3896
  order_number: string;
3793
3897
  /**
3794
3898
  * Format: int64
3795
- * @description company_id from the authenticated merchant
3899
+ * @description Store.id from the authenticated merchant
3796
3900
  */
3797
3901
  store_id: number;
3798
3902
  /**
@@ -4575,6 +4679,27 @@ interface components {
4575
4679
  /** Format: date-time */
4576
4680
  readonly updated_at?: string;
4577
4681
  };
4682
+ /** @description PATCH body for the company owner's availability switch. */
4683
+ PatchedSetCompanyAvailability: {
4684
+ is_available?: boolean;
4685
+ };
4686
+ /**
4687
+ * @description PATCH body for a store's delivery-method row.
4688
+ *
4689
+ * ``is_enabled`` and the retained config fields are all optional so a
4690
+ * caller can flip the switch alone, without resending config it isn't
4691
+ * changing — but at least one field must be present.
4692
+ */
4693
+ PatchedSetStoreDeliveryMethod: {
4694
+ is_enabled?: boolean;
4695
+ delivery_area?: unknown;
4696
+ /** Format: decimal */
4697
+ base_fee?: string | null;
4698
+ /** Format: decimal */
4699
+ fee_split_percentage?: string | null;
4700
+ schedule?: unknown;
4701
+ lead_time_minutes?: number | null;
4702
+ };
4578
4703
  PatchedSurcharge: {
4579
4704
  readonly id?: number;
4580
4705
  /** @description Internal name (e.g. 'SUP Fee') */
@@ -5226,6 +5351,20 @@ interface components {
5226
5351
  readonly offers_reusable_packaging: boolean;
5227
5352
  readonly reusable_deposit_amount?: string | null;
5228
5353
  };
5354
+ /** @description One row of the store config list: a method's switch plus retained config. */
5355
+ StoreDeliveryMethodConfig: {
5356
+ method: components["schemas"]["MethodEnum"];
5357
+ is_enabled: boolean;
5358
+ delivery_area: unknown;
5359
+ /** Format: decimal */
5360
+ base_fee: string | null;
5361
+ /** Format: decimal */
5362
+ fee_split_percentage: string | null;
5363
+ schedule: unknown;
5364
+ lead_time_minutes: number | null;
5365
+ /** Format: date-time */
5366
+ config_updated_at: string | null;
5367
+ };
5229
5368
  StoreMeResponse: {
5230
5369
  id: number;
5231
5370
  public_id: string;
@@ -5974,6 +6113,166 @@ interface operations {
5974
6113
  };
5975
6114
  };
5976
6115
  };
6116
+ admin_delivery_methods_list: {
6117
+ parameters: {
6118
+ query?: never;
6119
+ header?: {
6120
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
6121
+ "X-Sous-Company-Id"?: number;
6122
+ };
6123
+ path?: never;
6124
+ cookie?: never;
6125
+ };
6126
+ requestBody?: never;
6127
+ responses: {
6128
+ 200: {
6129
+ headers: {
6130
+ [name: string]: unknown;
6131
+ };
6132
+ content: {
6133
+ "application/json": components["schemas"]["CompanyDeliveryMethodAvailability"][];
6134
+ };
6135
+ };
6136
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
6137
+ 400: {
6138
+ headers: {
6139
+ [name: string]: unknown;
6140
+ };
6141
+ content: {
6142
+ "application/json": components["schemas"]["APIErrorEnvelope"];
6143
+ };
6144
+ };
6145
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
6146
+ 401: {
6147
+ headers: {
6148
+ [name: string]: unknown;
6149
+ };
6150
+ content: {
6151
+ "application/json": components["schemas"]["APIErrorEnvelope"];
6152
+ };
6153
+ };
6154
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
6155
+ 403: {
6156
+ headers: {
6157
+ [name: string]: unknown;
6158
+ };
6159
+ content: {
6160
+ "application/json": components["schemas"]["APIErrorEnvelope"];
6161
+ };
6162
+ };
6163
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
6164
+ 404: {
6165
+ headers: {
6166
+ [name: string]: unknown;
6167
+ };
6168
+ content: {
6169
+ "application/json": components["schemas"]["APIErrorEnvelope"];
6170
+ };
6171
+ };
6172
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
6173
+ 429: {
6174
+ headers: {
6175
+ [name: string]: unknown;
6176
+ };
6177
+ content: {
6178
+ "application/json": components["schemas"]["APIErrorEnvelope"];
6179
+ };
6180
+ };
6181
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
6182
+ 500: {
6183
+ headers: {
6184
+ [name: string]: unknown;
6185
+ };
6186
+ content: {
6187
+ "application/json": components["schemas"]["APIErrorEnvelope"];
6188
+ };
6189
+ };
6190
+ };
6191
+ };
6192
+ admin_delivery_methods_partial_update: {
6193
+ parameters: {
6194
+ query?: never;
6195
+ header?: {
6196
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
6197
+ "X-Sous-Company-Id"?: number;
6198
+ };
6199
+ path: {
6200
+ method: string;
6201
+ };
6202
+ cookie?: never;
6203
+ };
6204
+ requestBody?: {
6205
+ content: {
6206
+ "application/json": components["schemas"]["PatchedSetCompanyAvailability"];
6207
+ "application/x-www-form-urlencoded": components["schemas"]["PatchedSetCompanyAvailability"];
6208
+ "multipart/form-data": components["schemas"]["PatchedSetCompanyAvailability"];
6209
+ };
6210
+ };
6211
+ responses: {
6212
+ 200: {
6213
+ headers: {
6214
+ [name: string]: unknown;
6215
+ };
6216
+ content: {
6217
+ "application/json": components["schemas"]["CompanyDeliveryMethodAvailability"];
6218
+ };
6219
+ };
6220
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
6221
+ 400: {
6222
+ headers: {
6223
+ [name: string]: unknown;
6224
+ };
6225
+ content: {
6226
+ "application/json": components["schemas"]["APIErrorEnvelope"];
6227
+ };
6228
+ };
6229
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
6230
+ 401: {
6231
+ headers: {
6232
+ [name: string]: unknown;
6233
+ };
6234
+ content: {
6235
+ "application/json": components["schemas"]["APIErrorEnvelope"];
6236
+ };
6237
+ };
6238
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
6239
+ 403: {
6240
+ headers: {
6241
+ [name: string]: unknown;
6242
+ };
6243
+ content: {
6244
+ "application/json": components["schemas"]["APIErrorEnvelope"];
6245
+ };
6246
+ };
6247
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
6248
+ 404: {
6249
+ headers: {
6250
+ [name: string]: unknown;
6251
+ };
6252
+ content: {
6253
+ "application/json": components["schemas"]["APIErrorEnvelope"];
6254
+ };
6255
+ };
6256
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
6257
+ 429: {
6258
+ headers: {
6259
+ [name: string]: unknown;
6260
+ };
6261
+ content: {
6262
+ "application/json": components["schemas"]["APIErrorEnvelope"];
6263
+ };
6264
+ };
6265
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
6266
+ 500: {
6267
+ headers: {
6268
+ [name: string]: unknown;
6269
+ };
6270
+ content: {
6271
+ "application/json": components["schemas"]["APIErrorEnvelope"];
6272
+ };
6273
+ };
6274
+ };
6275
+ };
5977
6276
  admin_discounts_list: {
5978
6277
  parameters: {
5979
6278
  query?: {
@@ -8833,6 +9132,171 @@ interface operations {
8833
9132
  };
8834
9133
  };
8835
9134
  };
9135
+ admin_stores_locations_delivery_methods_list: {
9136
+ parameters: {
9137
+ query?: never;
9138
+ header?: {
9139
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
9140
+ "X-Sous-Company-Id"?: number;
9141
+ };
9142
+ path: {
9143
+ location_public_id: string;
9144
+ store_public_id: string;
9145
+ };
9146
+ cookie?: never;
9147
+ };
9148
+ requestBody?: never;
9149
+ responses: {
9150
+ 200: {
9151
+ headers: {
9152
+ [name: string]: unknown;
9153
+ };
9154
+ content: {
9155
+ "application/json": components["schemas"]["StoreDeliveryMethodConfig"][];
9156
+ };
9157
+ };
9158
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
9159
+ 400: {
9160
+ headers: {
9161
+ [name: string]: unknown;
9162
+ };
9163
+ content: {
9164
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9165
+ };
9166
+ };
9167
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
9168
+ 401: {
9169
+ headers: {
9170
+ [name: string]: unknown;
9171
+ };
9172
+ content: {
9173
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9174
+ };
9175
+ };
9176
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
9177
+ 403: {
9178
+ headers: {
9179
+ [name: string]: unknown;
9180
+ };
9181
+ content: {
9182
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9183
+ };
9184
+ };
9185
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
9186
+ 404: {
9187
+ headers: {
9188
+ [name: string]: unknown;
9189
+ };
9190
+ content: {
9191
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9192
+ };
9193
+ };
9194
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
9195
+ 429: {
9196
+ headers: {
9197
+ [name: string]: unknown;
9198
+ };
9199
+ content: {
9200
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9201
+ };
9202
+ };
9203
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
9204
+ 500: {
9205
+ headers: {
9206
+ [name: string]: unknown;
9207
+ };
9208
+ content: {
9209
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9210
+ };
9211
+ };
9212
+ };
9213
+ };
9214
+ admin_stores_locations_delivery_methods_partial_update: {
9215
+ parameters: {
9216
+ query?: never;
9217
+ header?: {
9218
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
9219
+ "X-Sous-Company-Id"?: number;
9220
+ };
9221
+ path: {
9222
+ location_public_id: string;
9223
+ method: string;
9224
+ store_public_id: string;
9225
+ };
9226
+ cookie?: never;
9227
+ };
9228
+ requestBody?: {
9229
+ content: {
9230
+ "application/json": components["schemas"]["PatchedSetStoreDeliveryMethod"];
9231
+ "application/x-www-form-urlencoded": components["schemas"]["PatchedSetStoreDeliveryMethod"];
9232
+ "multipart/form-data": components["schemas"]["PatchedSetStoreDeliveryMethod"];
9233
+ };
9234
+ };
9235
+ responses: {
9236
+ 200: {
9237
+ headers: {
9238
+ [name: string]: unknown;
9239
+ };
9240
+ content: {
9241
+ "application/json": components["schemas"]["StoreDeliveryMethodConfig"];
9242
+ };
9243
+ };
9244
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
9245
+ 400: {
9246
+ headers: {
9247
+ [name: string]: unknown;
9248
+ };
9249
+ content: {
9250
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9251
+ };
9252
+ };
9253
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
9254
+ 401: {
9255
+ headers: {
9256
+ [name: string]: unknown;
9257
+ };
9258
+ content: {
9259
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9260
+ };
9261
+ };
9262
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
9263
+ 403: {
9264
+ headers: {
9265
+ [name: string]: unknown;
9266
+ };
9267
+ content: {
9268
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9269
+ };
9270
+ };
9271
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
9272
+ 404: {
9273
+ headers: {
9274
+ [name: string]: unknown;
9275
+ };
9276
+ content: {
9277
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9278
+ };
9279
+ };
9280
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
9281
+ 429: {
9282
+ headers: {
9283
+ [name: string]: unknown;
9284
+ };
9285
+ content: {
9286
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9287
+ };
9288
+ };
9289
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
9290
+ 500: {
9291
+ headers: {
9292
+ [name: string]: unknown;
9293
+ };
9294
+ content: {
9295
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9296
+ };
9297
+ };
9298
+ };
9299
+ };
8836
9300
  admin_stores_surcharges_list: {
8837
9301
  parameters: {
8838
9302
  query?: never;
package/dist/index.d.ts CHANGED
@@ -90,6 +90,46 @@ interface paths {
90
90
  patch?: never;
91
91
  trace?: never;
92
92
  };
93
+ "/api/v1/admin/delivery-methods/": {
94
+ parameters: {
95
+ query?: never;
96
+ header?: never;
97
+ path?: never;
98
+ cookie?: never;
99
+ };
100
+ /**
101
+ * List the company's delivery-method availability
102
+ * @description ``GET /api/v1/admin/delivery-methods/`` — every method's company availability.
103
+ */
104
+ get: operations["admin_delivery_methods_list"];
105
+ put?: never;
106
+ post?: never;
107
+ delete?: never;
108
+ options?: never;
109
+ head?: never;
110
+ patch?: never;
111
+ trace?: never;
112
+ };
113
+ "/api/v1/admin/delivery-methods/{method}/": {
114
+ parameters: {
115
+ query?: never;
116
+ header?: never;
117
+ path?: never;
118
+ cookie?: never;
119
+ };
120
+ get?: never;
121
+ put?: never;
122
+ post?: never;
123
+ delete?: never;
124
+ options?: never;
125
+ head?: never;
126
+ /**
127
+ * Set the company's availability for one delivery method
128
+ * @description ``PATCH /api/v1/admin/delivery-methods/<method>/`` — the owner's switch.
129
+ */
130
+ patch: operations["admin_delivery_methods_partial_update"];
131
+ trace?: never;
132
+ };
93
133
  "/api/v1/admin/discounts/": {
94
134
  parameters: {
95
135
  query?: never;
@@ -860,6 +900,56 @@ interface paths {
860
900
  patch?: never;
861
901
  trace?: never;
862
902
  };
903
+ "/api/v1/admin/stores/{store_public_id}/locations/{location_public_id}/delivery-methods/": {
904
+ parameters: {
905
+ query?: never;
906
+ header?: never;
907
+ path?: never;
908
+ cookie?: never;
909
+ };
910
+ /**
911
+ * List a Location's delivery-method config
912
+ * @description ``GET .../stores/<store_public_id>/locations/<location_public_id>/
913
+ * delivery-methods/``.
914
+ *
915
+ * Config for methods the company has made available, for one Location.
916
+ * A method the company hasn't switched on at all is omitted entirely, not
917
+ * returned disabled — "hidden, not greyed out": a Location cannot see, let
918
+ * alone enable, something its company hasn't agreed to.
919
+ */
920
+ get: operations["admin_stores_locations_delivery_methods_list"];
921
+ put?: never;
922
+ post?: never;
923
+ delete?: never;
924
+ options?: never;
925
+ head?: never;
926
+ patch?: never;
927
+ trace?: never;
928
+ };
929
+ "/api/v1/admin/stores/{store_public_id}/locations/{location_public_id}/delivery-methods/{method}/": {
930
+ parameters: {
931
+ query?: never;
932
+ header?: never;
933
+ path?: never;
934
+ cookie?: never;
935
+ };
936
+ get?: never;
937
+ put?: never;
938
+ post?: never;
939
+ delete?: never;
940
+ options?: never;
941
+ head?: never;
942
+ /**
943
+ * Set a Location's switch/config for one delivery method
944
+ * @description ``PATCH .../stores/<store_public_id>/locations/<location_public_id>/
945
+ * delivery-methods/<method>/``.
946
+ *
947
+ * One Location's own switch and/or its retained config. At least one of
948
+ * ``is_enabled`` or a config field is required; either can be sent alone.
949
+ */
950
+ patch: operations["admin_stores_locations_delivery_methods_partial_update"];
951
+ trace?: never;
952
+ };
863
953
  "/api/v1/admin/stores/{store_public_id}/surcharges/": {
864
954
  parameters: {
865
955
  query?: never;
@@ -3247,6 +3337,13 @@ interface components {
3247
3337
  * @enum {string}
3248
3338
  */
3249
3339
  ChannelTypeEnum: "own_website" | "uber_eats" | "jet" | "other";
3340
+ /** @description One row of the company availability list: a method and its on/off state. */
3341
+ CompanyDeliveryMethodAvailability: {
3342
+ method: components["schemas"]["MethodEnum"];
3343
+ is_available: boolean;
3344
+ /** Format: date-time */
3345
+ updated_at: string | null;
3346
+ };
3250
3347
  ComplianceChoice: {
3251
3348
  slug: string;
3252
3349
  label: string;
@@ -3761,6 +3858,13 @@ interface components {
3761
3858
  * @enum {string}
3762
3859
  */
3763
3860
  MessageStatusEnum: "draft" | "active" | "paused" | "archived";
3861
+ /**
3862
+ * @description * `own_delivery` - Own Delivery
3863
+ * * `uber_direct` - Uber Direct
3864
+ * * `lieferando` - Lieferando
3865
+ * @enum {string}
3866
+ */
3867
+ MethodEnum: "own_delivery" | "uber_direct" | "lieferando";
3764
3868
  ModifyLineItem: {
3765
3869
  /** Format: uuid */
3766
3870
  order_line_item_id: string;
@@ -3792,7 +3896,7 @@ interface components {
3792
3896
  order_number: string;
3793
3897
  /**
3794
3898
  * Format: int64
3795
- * @description company_id from the authenticated merchant
3899
+ * @description Store.id from the authenticated merchant
3796
3900
  */
3797
3901
  store_id: number;
3798
3902
  /**
@@ -4575,6 +4679,27 @@ interface components {
4575
4679
  /** Format: date-time */
4576
4680
  readonly updated_at?: string;
4577
4681
  };
4682
+ /** @description PATCH body for the company owner's availability switch. */
4683
+ PatchedSetCompanyAvailability: {
4684
+ is_available?: boolean;
4685
+ };
4686
+ /**
4687
+ * @description PATCH body for a store's delivery-method row.
4688
+ *
4689
+ * ``is_enabled`` and the retained config fields are all optional so a
4690
+ * caller can flip the switch alone, without resending config it isn't
4691
+ * changing — but at least one field must be present.
4692
+ */
4693
+ PatchedSetStoreDeliveryMethod: {
4694
+ is_enabled?: boolean;
4695
+ delivery_area?: unknown;
4696
+ /** Format: decimal */
4697
+ base_fee?: string | null;
4698
+ /** Format: decimal */
4699
+ fee_split_percentage?: string | null;
4700
+ schedule?: unknown;
4701
+ lead_time_minutes?: number | null;
4702
+ };
4578
4703
  PatchedSurcharge: {
4579
4704
  readonly id?: number;
4580
4705
  /** @description Internal name (e.g. 'SUP Fee') */
@@ -5226,6 +5351,20 @@ interface components {
5226
5351
  readonly offers_reusable_packaging: boolean;
5227
5352
  readonly reusable_deposit_amount?: string | null;
5228
5353
  };
5354
+ /** @description One row of the store config list: a method's switch plus retained config. */
5355
+ StoreDeliveryMethodConfig: {
5356
+ method: components["schemas"]["MethodEnum"];
5357
+ is_enabled: boolean;
5358
+ delivery_area: unknown;
5359
+ /** Format: decimal */
5360
+ base_fee: string | null;
5361
+ /** Format: decimal */
5362
+ fee_split_percentage: string | null;
5363
+ schedule: unknown;
5364
+ lead_time_minutes: number | null;
5365
+ /** Format: date-time */
5366
+ config_updated_at: string | null;
5367
+ };
5229
5368
  StoreMeResponse: {
5230
5369
  id: number;
5231
5370
  public_id: string;
@@ -5974,6 +6113,166 @@ interface operations {
5974
6113
  };
5975
6114
  };
5976
6115
  };
6116
+ admin_delivery_methods_list: {
6117
+ parameters: {
6118
+ query?: never;
6119
+ header?: {
6120
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
6121
+ "X-Sous-Company-Id"?: number;
6122
+ };
6123
+ path?: never;
6124
+ cookie?: never;
6125
+ };
6126
+ requestBody?: never;
6127
+ responses: {
6128
+ 200: {
6129
+ headers: {
6130
+ [name: string]: unknown;
6131
+ };
6132
+ content: {
6133
+ "application/json": components["schemas"]["CompanyDeliveryMethodAvailability"][];
6134
+ };
6135
+ };
6136
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
6137
+ 400: {
6138
+ headers: {
6139
+ [name: string]: unknown;
6140
+ };
6141
+ content: {
6142
+ "application/json": components["schemas"]["APIErrorEnvelope"];
6143
+ };
6144
+ };
6145
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
6146
+ 401: {
6147
+ headers: {
6148
+ [name: string]: unknown;
6149
+ };
6150
+ content: {
6151
+ "application/json": components["schemas"]["APIErrorEnvelope"];
6152
+ };
6153
+ };
6154
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
6155
+ 403: {
6156
+ headers: {
6157
+ [name: string]: unknown;
6158
+ };
6159
+ content: {
6160
+ "application/json": components["schemas"]["APIErrorEnvelope"];
6161
+ };
6162
+ };
6163
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
6164
+ 404: {
6165
+ headers: {
6166
+ [name: string]: unknown;
6167
+ };
6168
+ content: {
6169
+ "application/json": components["schemas"]["APIErrorEnvelope"];
6170
+ };
6171
+ };
6172
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
6173
+ 429: {
6174
+ headers: {
6175
+ [name: string]: unknown;
6176
+ };
6177
+ content: {
6178
+ "application/json": components["schemas"]["APIErrorEnvelope"];
6179
+ };
6180
+ };
6181
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
6182
+ 500: {
6183
+ headers: {
6184
+ [name: string]: unknown;
6185
+ };
6186
+ content: {
6187
+ "application/json": components["schemas"]["APIErrorEnvelope"];
6188
+ };
6189
+ };
6190
+ };
6191
+ };
6192
+ admin_delivery_methods_partial_update: {
6193
+ parameters: {
6194
+ query?: never;
6195
+ header?: {
6196
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
6197
+ "X-Sous-Company-Id"?: number;
6198
+ };
6199
+ path: {
6200
+ method: string;
6201
+ };
6202
+ cookie?: never;
6203
+ };
6204
+ requestBody?: {
6205
+ content: {
6206
+ "application/json": components["schemas"]["PatchedSetCompanyAvailability"];
6207
+ "application/x-www-form-urlencoded": components["schemas"]["PatchedSetCompanyAvailability"];
6208
+ "multipart/form-data": components["schemas"]["PatchedSetCompanyAvailability"];
6209
+ };
6210
+ };
6211
+ responses: {
6212
+ 200: {
6213
+ headers: {
6214
+ [name: string]: unknown;
6215
+ };
6216
+ content: {
6217
+ "application/json": components["schemas"]["CompanyDeliveryMethodAvailability"];
6218
+ };
6219
+ };
6220
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
6221
+ 400: {
6222
+ headers: {
6223
+ [name: string]: unknown;
6224
+ };
6225
+ content: {
6226
+ "application/json": components["schemas"]["APIErrorEnvelope"];
6227
+ };
6228
+ };
6229
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
6230
+ 401: {
6231
+ headers: {
6232
+ [name: string]: unknown;
6233
+ };
6234
+ content: {
6235
+ "application/json": components["schemas"]["APIErrorEnvelope"];
6236
+ };
6237
+ };
6238
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
6239
+ 403: {
6240
+ headers: {
6241
+ [name: string]: unknown;
6242
+ };
6243
+ content: {
6244
+ "application/json": components["schemas"]["APIErrorEnvelope"];
6245
+ };
6246
+ };
6247
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
6248
+ 404: {
6249
+ headers: {
6250
+ [name: string]: unknown;
6251
+ };
6252
+ content: {
6253
+ "application/json": components["schemas"]["APIErrorEnvelope"];
6254
+ };
6255
+ };
6256
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
6257
+ 429: {
6258
+ headers: {
6259
+ [name: string]: unknown;
6260
+ };
6261
+ content: {
6262
+ "application/json": components["schemas"]["APIErrorEnvelope"];
6263
+ };
6264
+ };
6265
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
6266
+ 500: {
6267
+ headers: {
6268
+ [name: string]: unknown;
6269
+ };
6270
+ content: {
6271
+ "application/json": components["schemas"]["APIErrorEnvelope"];
6272
+ };
6273
+ };
6274
+ };
6275
+ };
5977
6276
  admin_discounts_list: {
5978
6277
  parameters: {
5979
6278
  query?: {
@@ -8833,6 +9132,171 @@ interface operations {
8833
9132
  };
8834
9133
  };
8835
9134
  };
9135
+ admin_stores_locations_delivery_methods_list: {
9136
+ parameters: {
9137
+ query?: never;
9138
+ header?: {
9139
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
9140
+ "X-Sous-Company-Id"?: number;
9141
+ };
9142
+ path: {
9143
+ location_public_id: string;
9144
+ store_public_id: string;
9145
+ };
9146
+ cookie?: never;
9147
+ };
9148
+ requestBody?: never;
9149
+ responses: {
9150
+ 200: {
9151
+ headers: {
9152
+ [name: string]: unknown;
9153
+ };
9154
+ content: {
9155
+ "application/json": components["schemas"]["StoreDeliveryMethodConfig"][];
9156
+ };
9157
+ };
9158
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
9159
+ 400: {
9160
+ headers: {
9161
+ [name: string]: unknown;
9162
+ };
9163
+ content: {
9164
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9165
+ };
9166
+ };
9167
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
9168
+ 401: {
9169
+ headers: {
9170
+ [name: string]: unknown;
9171
+ };
9172
+ content: {
9173
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9174
+ };
9175
+ };
9176
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
9177
+ 403: {
9178
+ headers: {
9179
+ [name: string]: unknown;
9180
+ };
9181
+ content: {
9182
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9183
+ };
9184
+ };
9185
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
9186
+ 404: {
9187
+ headers: {
9188
+ [name: string]: unknown;
9189
+ };
9190
+ content: {
9191
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9192
+ };
9193
+ };
9194
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
9195
+ 429: {
9196
+ headers: {
9197
+ [name: string]: unknown;
9198
+ };
9199
+ content: {
9200
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9201
+ };
9202
+ };
9203
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
9204
+ 500: {
9205
+ headers: {
9206
+ [name: string]: unknown;
9207
+ };
9208
+ content: {
9209
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9210
+ };
9211
+ };
9212
+ };
9213
+ };
9214
+ admin_stores_locations_delivery_methods_partial_update: {
9215
+ parameters: {
9216
+ query?: never;
9217
+ header?: {
9218
+ /** @description Company the request acts on. Ignored for merchant tokens (scoped to their own company); required for admin tokens to select a company. */
9219
+ "X-Sous-Company-Id"?: number;
9220
+ };
9221
+ path: {
9222
+ location_public_id: string;
9223
+ method: string;
9224
+ store_public_id: string;
9225
+ };
9226
+ cookie?: never;
9227
+ };
9228
+ requestBody?: {
9229
+ content: {
9230
+ "application/json": components["schemas"]["PatchedSetStoreDeliveryMethod"];
9231
+ "application/x-www-form-urlencoded": components["schemas"]["PatchedSetStoreDeliveryMethod"];
9232
+ "multipart/form-data": components["schemas"]["PatchedSetStoreDeliveryMethod"];
9233
+ };
9234
+ };
9235
+ responses: {
9236
+ 200: {
9237
+ headers: {
9238
+ [name: string]: unknown;
9239
+ };
9240
+ content: {
9241
+ "application/json": components["schemas"]["StoreDeliveryMethodConfig"];
9242
+ };
9243
+ };
9244
+ /** @description Possible error codes include `VALIDATION_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
9245
+ 400: {
9246
+ headers: {
9247
+ [name: string]: unknown;
9248
+ };
9249
+ content: {
9250
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9251
+ };
9252
+ };
9253
+ /** @description Possible error codes include `UNAUTHORIZED`. Use `x-error-codes` for machine-readable retryability metadata. */
9254
+ 401: {
9255
+ headers: {
9256
+ [name: string]: unknown;
9257
+ };
9258
+ content: {
9259
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9260
+ };
9261
+ };
9262
+ /** @description Possible error codes include `FORBIDDEN`. Use `x-error-codes` for machine-readable retryability metadata. */
9263
+ 403: {
9264
+ headers: {
9265
+ [name: string]: unknown;
9266
+ };
9267
+ content: {
9268
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9269
+ };
9270
+ };
9271
+ /** @description Possible error codes include `NOT_FOUND`. Use `x-error-codes` for machine-readable retryability metadata. */
9272
+ 404: {
9273
+ headers: {
9274
+ [name: string]: unknown;
9275
+ };
9276
+ content: {
9277
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9278
+ };
9279
+ };
9280
+ /** @description Possible error codes include `RATE_LIMITED`. Use `x-error-codes` for machine-readable retryability metadata. */
9281
+ 429: {
9282
+ headers: {
9283
+ [name: string]: unknown;
9284
+ };
9285
+ content: {
9286
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9287
+ };
9288
+ };
9289
+ /** @description Possible error codes include `INTERNAL_ERROR`. Use `x-error-codes` for machine-readable retryability metadata. */
9290
+ 500: {
9291
+ headers: {
9292
+ [name: string]: unknown;
9293
+ };
9294
+ content: {
9295
+ "application/json": components["schemas"]["APIErrorEnvelope"];
9296
+ };
9297
+ };
9298
+ };
9299
+ };
8836
9300
  admin_stores_surcharges_list: {
8837
9301
  parameters: {
8838
9302
  query?: never;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@poweredbysous/storefront-admin-sdk",
3
- "version": "2.0.1",
3
+ "version": "3.0.0",
4
4
  "description": "Type-safe TypeScript SDK for SOUS Storefront Backend admin endpoints",
5
5
  "license": "UNLICENSED",
6
6
  "private": false,