@shopware/api-client 1.2.0 → 1.3.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.
@@ -2,7 +2,7 @@
2
2
  * This file is auto-generated. Do not make direct changes to the file.
3
3
  * Instead override it in your shopware.d.ts file.
4
4
  *
5
- * Shopware API version: 6.6.6.0
5
+ * Shopware API version: 6.6.10.0
6
6
  *
7
7
  */
8
8
  type GenericRecord =
@@ -117,6 +117,18 @@ export type Schemas = {
117
117
  /** Format: date-time */
118
118
  readonly updatedAt?: string;
119
119
  };
120
+ Aggregation:
121
+ | components["schemas"]["AggregationMetrics"]
122
+ | (components["schemas"]["AggregationEntity"] &
123
+ components["schemas"]["SubAggregations"])
124
+ | (components["schemas"]["AggregationFilter"] &
125
+ components["schemas"]["SubAggregations"])
126
+ | (components["schemas"]["AggregationTerms"] &
127
+ components["schemas"]["SubAggregations"])
128
+ | (components["schemas"]["AggregationHistogram"] &
129
+ components["schemas"]["SubAggregations"])
130
+ | (components["schemas"]["AggregationRange"] &
131
+ components["schemas"]["SubAggregations"]);
120
132
  AggregationEntity: {
121
133
  /** The entity definition e.g "product_manufacturer". */
122
134
  definition: string;
@@ -206,19 +218,6 @@ export type Schemas = {
206
218
  */
207
219
  type: "terms";
208
220
  };
209
- Aggregations: (
210
- | components["schemas"]["AggregationMetrics"]
211
- | (components["schemas"]["AggregationEntity"] &
212
- components["schemas"]["SubAggregations"])
213
- | (components["schemas"]["AggregationFilter"] &
214
- components["schemas"]["SubAggregations"])
215
- | (components["schemas"]["AggregationTerms"] &
216
- components["schemas"]["SubAggregations"])
217
- | (components["schemas"]["AggregationHistogram"] &
218
- components["schemas"]["SubAggregations"])
219
- | (components["schemas"]["AggregationRange"] &
220
- components["schemas"]["SubAggregations"])
221
- )[];
222
221
  App: {
223
222
  /** Format: date-time */
224
223
  readonly createdAt?: string;
@@ -314,15 +313,18 @@ export type Schemas = {
314
313
  * @default false
315
314
  */
316
315
  canSendRequestEmail?: boolean;
317
- /** The mode of the interaction */
318
- mode?: string;
316
+ /**
317
+ * The mode of the interaction
318
+ * @enum {string}
319
+ */
320
+ mode?: "guided" | "self";
319
321
  /** The name of the sales channel */
320
322
  salesChannelName?: string;
321
323
  /**
322
324
  * The video and audio settings
323
325
  * @enum {string}
324
326
  */
325
- videoAudioSettings?: "none" | "both" | "audio_only";
327
+ videoAudioSettings?: "none" | "both" | "audio-only";
326
328
  };
327
329
  ApprovalRule: {
328
330
  active?: boolean;
@@ -340,6 +342,9 @@ export type Schemas = {
340
342
  Association: {
341
343
  [key: string]: components["schemas"]["Association"];
342
344
  };
345
+ Associations: {
346
+ [key: string]: components["schemas"]["Criteria"];
347
+ };
343
348
  AttendeeProductCollectionLastSeenResponse: {
344
349
  collection?: {
345
350
  lastSeen?: string[];
@@ -488,6 +493,8 @@ export type Schemas = {
488
493
  /** Format: date-time */
489
494
  readonly createdAt?: string;
490
495
  customFields?: GenericRecord;
496
+ /** Runtime field, cannot be used as part of the criteria. */
497
+ default?: boolean;
491
498
  id: string;
492
499
  name: string;
493
500
  permissions?: GenericRecord[];
@@ -630,6 +637,7 @@ export type Schemas = {
630
637
  languageId: string;
631
638
  lastName: string;
632
639
  role?: components["schemas"]["B2bComponentsRole"];
640
+ status?: string;
633
641
  /** Format: date-time */
634
642
  readonly updatedAt?: string;
635
643
  };
@@ -652,6 +660,24 @@ export type Schemas = {
652
660
  /** Format: date-time */
653
661
  readonly updatedAt?: string;
654
662
  };
663
+ BaseInteraction: {
664
+ /**
665
+ * The time in seconds how long the interaction should be stored in the database
666
+ * @default -1
667
+ */
668
+ lifeTimeInSeconds?: number;
669
+ /**
670
+ * The time when the interaction was triggered
671
+ * @default now
672
+ */
673
+ triggeredAt?: string;
674
+ };
675
+ BasePresentationSlideData: {
676
+ cmsPage?: components["schemas"]["CmsPage"];
677
+ extensions?: {
678
+ cmsPageRelation?: components["schemas"]["PresentationCmsPage"];
679
+ };
680
+ };
655
681
  Breadcrumb: {
656
682
  /** @enum {string} */
657
683
  apiAlias: "breadcrumb";
@@ -679,11 +705,7 @@ export type Schemas = {
679
705
  /** @enum {string} */
680
706
  type: "page" | "link" | "folder";
681
707
  };
682
- BreadcrumbCollection: {
683
- /** @enum {string} */
684
- apiAlias: "breadcrumb_collection";
685
- breadcrumbs: components["schemas"]["Breadcrumb"][];
686
- };
708
+ BreadcrumbCollection: components["schemas"]["Breadcrumb"][];
687
709
  CalculatedPrice: {
688
710
  /** @enum {string} */
689
711
  apiAlias: "calculated_price";
@@ -816,7 +838,7 @@ export type Schemas = {
816
838
  messageKey: string;
817
839
  };
818
840
  CartItems: {
819
- items?: components["schemas"]["LineItem"][];
841
+ items: components["schemas"]["LineItem"][];
820
842
  };
821
843
  CartListPrice: {
822
844
  /** @enum {string} */
@@ -1097,7 +1119,6 @@ export type Schemas = {
1097
1119
  ClientPresentationStateResponse: {
1098
1120
  stateForAll?: components["schemas"]["StateForAll"];
1099
1121
  stateForClients?: components["schemas"]["StateForClients"];
1100
- stateForMe?: components["schemas"]["StateForMe"];
1101
1122
  };
1102
1123
  CmsBlock: {
1103
1124
  /** @enum {string} */
@@ -1257,22 +1278,12 @@ export type Schemas = {
1257
1278
  };
1258
1279
  id?: string;
1259
1280
  mobileBehavior?: string;
1281
+ name?: string;
1260
1282
  page?: components["schemas"]["CmsPage"];
1261
1283
  pageId: string;
1262
1284
  /** Format: int64 */
1263
1285
  position: number;
1264
1286
  sizingMode?: string;
1265
- translated: {
1266
- backgroundColor: string;
1267
- backgroundMediaId: string;
1268
- backgroundMediaMode: string;
1269
- cmsPageVersionId: string;
1270
- cssClass: string;
1271
- mobileBehavior: string;
1272
- pageId: string;
1273
- sizingMode: string;
1274
- type: string;
1275
- };
1276
1287
  /** @enum {string} */
1277
1288
  type: "default" | "sidebar";
1278
1289
  /** Format: date-time */
@@ -1291,7 +1302,26 @@ export type Schemas = {
1291
1302
  cmsBlockVersionId?: string;
1292
1303
  /** Format: date-time */
1293
1304
  readonly createdAt?: string;
1294
- customFields?: GenericRecord;
1305
+ customFields?: {
1306
+ _uniqueIdentifier?: string;
1307
+ };
1308
+ extensions?: {
1309
+ swagCmsExtensionsForm?: {
1310
+ data?: {
1311
+ /** @example 0654ad514da002e9d77fa24ee33acd95 */
1312
+ id?: string;
1313
+ /** @example swag_cms_extensions_form */
1314
+ type?: string;
1315
+ };
1316
+ links?: {
1317
+ /**
1318
+ * Format: uri-reference
1319
+ * @example /cms-slot/ac5ca6960137c6b8a97c90c11b71d4bb/swagCmsExtensionsForm
1320
+ */
1321
+ related?: string;
1322
+ };
1323
+ };
1324
+ };
1295
1325
  fieldConfig?: GenericRecord;
1296
1326
  id: string;
1297
1327
  locked?: boolean;
@@ -1299,6 +1329,11 @@ export type Schemas = {
1299
1329
  translated: {
1300
1330
  blockId: string;
1301
1331
  cmsBlockVersionId: string;
1332
+ config?: {
1333
+ content?: {
1334
+ value?: string;
1335
+ };
1336
+ };
1302
1337
  slot: string;
1303
1338
  type: string;
1304
1339
  versionId: string;
@@ -1479,55 +1514,9 @@ export type Schemas = {
1479
1514
  /** The subject of the appointment */
1480
1515
  subject: string;
1481
1516
  };
1482
- CreateInteractionRequestBody: {
1483
- /**
1484
- * The time in seconds how long the interaction should be stored in the database
1485
- * @default -1
1486
- */
1487
- lifeTimeInSeconds?: number;
1488
- /**
1489
- * the name of the interaction
1490
- * @enum {string}
1491
- */
1492
- name:
1493
- | "keep.alive"
1494
- | "product.viewed"
1495
- | "quickview.opened"
1496
- | "quickview.closed"
1497
- | "dynamicPage.opened"
1498
- | "dynamicProductPage.opened"
1499
- | "dynamicPage.closed"
1500
- | "page.viewed"
1501
- | "guide.hovered"
1502
- | "attendee.product.collection.liked"
1503
- | "attendee.product.collection.disliked"
1504
- | "attendee.product.collection.removed"
1505
- | "attendee.leave"
1506
- | "remote.checkout.accepted"
1507
- | "remote.checkout.denied"
1508
- | "broadcastMode.toggled"
1509
- | "viewMode.changed"
1510
- | "screenSharing.toggled";
1511
- payload:
1512
- | components["schemas"]["EmptyPayload"]
1513
- | components["schemas"]["ProductPayload"]
1514
- | components["schemas"]["DynamicPageOpenedPayload"]
1515
- | components["schemas"]["DynamicProductPageOpenedPayload"]
1516
- | components["schemas"]["DynamicPageClosedPayload"]
1517
- | components["schemas"]["PageViewedPayload"]
1518
- | components["schemas"]["GuideHoveredPayload"]
1519
- | components["schemas"]["ToggleBroadcastModePayload"]
1520
- | components["schemas"]["ViewModeChangedPayload"]
1521
- | components["schemas"]["ScreenSharingToggledPayload"];
1522
- /**
1523
- * The time when the interaction was triggered
1524
- * @default now
1525
- */
1526
- triggeredAt?: string;
1527
- };
1517
+ CreateInteractionRequestBody: components["schemas"]["DynamicInteractionBody"];
1528
1518
  Criteria: {
1529
- aggregations?: components["schemas"]["Aggregations"];
1530
- /** Associations to include. For more information, see [Search Queries > Associations](https://shopware.stoplight.io/docs/store-api/cf710bf73d0cd-search-queries#associations) */
1519
+ aggregations?: components["schemas"]["Aggregation"][];
1531
1520
  associations?: components["schemas"]["Association"];
1532
1521
  /** Fields which should be returned in the search result. */
1533
1522
  fields?: string[];
@@ -1542,7 +1531,7 @@ export type Schemas = {
1542
1531
  grouping?: string[];
1543
1532
  /** List of ids to search for */
1544
1533
  ids?: string[];
1545
- includes?: components["schemas"]["Include"];
1534
+ includes?: components["schemas"]["Includes"];
1546
1535
  /** Number of items per result page */
1547
1536
  limit?: number;
1548
1537
  /** Search result page */
@@ -1790,6 +1779,16 @@ export type Schemas = {
1790
1779
  company: string;
1791
1780
  vatIds: [string, ...string[]];
1792
1781
  }
1782
+ | {
1783
+ /** @enum {string} */
1784
+ accountType: "private";
1785
+ }
1786
+ | {
1787
+ /** @enum {string} */
1788
+ accountType: "business";
1789
+ company: string;
1790
+ vatIds: [string, ...string[]];
1791
+ }
1793
1792
  );
1794
1793
  CustomerAddress: {
1795
1794
  additionalAddressLine1?: string;
@@ -1929,6 +1928,14 @@ export type Schemas = {
1929
1928
  /** Format: date-time */
1930
1929
  readonly updatedAt?: string;
1931
1930
  };
1931
+ DiscountLineItemPayload: {
1932
+ /** Format: float */
1933
+ discountPrice?: number;
1934
+ /** @enum {string} */
1935
+ discountType?: "percentage" | "absolute";
1936
+ /** Format: float */
1937
+ discountValue?: number;
1938
+ };
1932
1939
  Document: {
1933
1940
  config: {
1934
1941
  name: string;
@@ -1939,6 +1946,8 @@ export type Schemas = {
1939
1946
  customFields?: GenericRecord;
1940
1947
  deepLinkCode: string;
1941
1948
  dependentDocuments?: components["schemas"]["Document"][];
1949
+ documentA11yMediaFile?: components["schemas"]["Media"];
1950
+ documentA11yMediaFileId?: string;
1942
1951
  documentMediaFile?: components["schemas"]["Media"];
1943
1952
  documentMediaFileId?: string;
1944
1953
  documentNumber?: string;
@@ -2065,7 +2074,6 @@ export type Schemas = {
2065
2074
  customFields?: GenericRecord;
2066
2075
  id?: string;
2067
2076
  name?: string;
2068
- startAsBroadcast?: boolean;
2069
2077
  /** Format: date-time */
2070
2078
  readonly updatedAt?: string;
2071
2079
  url?: string;
@@ -2079,6 +2087,24 @@ export type Schemas = {
2079
2087
  /** Format: date-time */
2080
2088
  readonly updatedAt?: string;
2081
2089
  };
2090
+ DsrCmsSlide: {
2091
+ cmsSection?: components["schemas"]["CmsSection"];
2092
+ cmsSectionId: string;
2093
+ cmsSectionVersionId?: string;
2094
+ /** Format: date-time */
2095
+ readonly createdAt?: string;
2096
+ id: string;
2097
+ slideName: string;
2098
+ translated: {
2099
+ cmsSectionId: string;
2100
+ cmsSectionVersionId: string;
2101
+ slideName: string;
2102
+ versionId: string;
2103
+ };
2104
+ /** Format: date-time */
2105
+ readonly updatedAt?: string;
2106
+ versionId?: string;
2107
+ };
2082
2108
  DsrInteraction: {
2083
2109
  /** Format: date-time */
2084
2110
  readonly createdAt?: string;
@@ -2143,42 +2169,69 @@ export type Schemas = {
2143
2169
  /** Format: date-time */
2144
2170
  readonly updatedAt?: string;
2145
2171
  };
2172
+ DynamicInteractionBody:
2173
+ | components["schemas"]["EmptyInteraction"]
2174
+ | components["schemas"]["ProductInteraction"]
2175
+ | components["schemas"]["DynamicPageOpenedInteraction"]
2176
+ | components["schemas"]["DynamicPageClosedInteraction"]
2177
+ | components["schemas"]["DynamicProductPageOpenedInteraction"]
2178
+ | components["schemas"]["PageViewedInteraction"]
2179
+ | components["schemas"]["GuideHoveredInteraction"]
2180
+ | components["schemas"]["ToggleBroadcastModeInteraction"]
2181
+ | components["schemas"]["ViewModeChangedInteraction"]
2182
+ | components["schemas"]["ScreenSharingToggledInteraction"];
2183
+ DynamicPageClosedInteraction: components["schemas"]["BaseInteraction"] & {
2184
+ name: string;
2185
+ payload: components["schemas"]["DynamicPageClosedPayload"];
2186
+ } & {
2187
+ /**
2188
+ * discriminator enum property added by openapi-typescript
2189
+ * @enum {string}
2190
+ */
2191
+ name: "dynamicPage.closed";
2192
+ };
2146
2193
  DynamicPageClosedPayload: {
2147
2194
  /**
2148
2195
  * Whether all pages were closed
2149
2196
  * @default false
2150
2197
  */
2151
2198
  all?: boolean;
2152
- /**
2153
- * discriminator enum property added by openapi-typescript
2154
- * @enum {string}
2155
- */
2156
- name: "dynamicPage.closed";
2157
2199
  /** The id of the page that was closed */
2158
2200
  pageId?: string | null;
2159
2201
  };
2160
- DynamicPageOpenedPayload: components["schemas"]["AbstractDynamicPageOpenedPayload"] & {
2202
+ DynamicPageOpenedInteraction: components["schemas"]["BaseInteraction"] & {
2203
+ name: string;
2204
+ payload: components["schemas"]["DynamicPageOpenedPayload"];
2205
+ } & {
2161
2206
  /**
2162
2207
  * discriminator enum property added by openapi-typescript
2163
2208
  * @enum {string}
2164
2209
  */
2165
2210
  name: "dynamicPage.opened";
2166
2211
  };
2212
+ DynamicPageOpenedPayload: components["schemas"]["AbstractDynamicPageOpenedPayload"];
2167
2213
  DynamicProductListingPageOpenedPayload: {
2168
2214
  /** Current page position in the pagination */
2169
2215
  page: number;
2170
2216
  };
2171
- DynamicProductPageOpenedPayload: {
2172
- /** the id from the product which is shown on the dynamic page */
2173
- productId: string;
2174
- } & (components["schemas"]["AbstractDynamicPageOpenedPayload"] & {
2217
+ DynamicProductPageOpenedInteraction: components["schemas"]["BaseInteraction"] & {
2218
+ name: string;
2219
+ payload: components["schemas"]["DynamicProductPageOpenedPayload"];
2220
+ } & {
2175
2221
  /**
2176
2222
  * discriminator enum property added by openapi-typescript
2177
2223
  * @enum {string}
2178
2224
  */
2179
2225
  name: "dynamicProductPage.opened";
2180
- });
2181
- EmptyPayload: {
2226
+ };
2227
+ DynamicProductPageOpenedPayload: {
2228
+ /** the id from the product which is shown on the dynamic page */
2229
+ productId: string;
2230
+ } & components["schemas"]["AbstractDynamicPageOpenedPayload"];
2231
+ EmptyInteraction: components["schemas"]["BaseInteraction"] & {
2232
+ name: string;
2233
+ payload: GenericRecord;
2234
+ } & {
2182
2235
  /**
2183
2236
  * discriminator enum property added by openapi-typescript
2184
2237
  * @enum {string}
@@ -2191,6 +2244,7 @@ export type Schemas = {
2191
2244
  | "remote.checkout.accepted"
2192
2245
  | "remote.checkout.denied";
2193
2246
  };
2247
+ EmptyPayload: Record<string, never>;
2194
2248
  EntitySearchResult: {
2195
2249
  /** Contains aggregated data. A simple example is the determination of the average price from a product search query. */
2196
2250
  aggregations?: GenericRecord[];
@@ -2241,14 +2295,19 @@ export type Schemas = {
2241
2295
  /** Format: date-time */
2242
2296
  readonly updatedAt?: string;
2243
2297
  };
2244
- GuideHoveredPayload: {
2245
- hoveredElementId?: string | null;
2298
+ GuideHoveredInteraction: components["schemas"]["BaseInteraction"] & {
2299
+ name: string;
2300
+ payload: components["schemas"]["GuideHoveredPayload"];
2301
+ } & {
2246
2302
  /**
2247
2303
  * discriminator enum property added by openapi-typescript
2248
2304
  * @enum {string}
2249
2305
  */
2250
2306
  name: "guide.hovered";
2251
2307
  };
2308
+ GuideHoveredPayload: {
2309
+ hoveredElementId?: string | null;
2310
+ };
2252
2311
  ImportExportFile: {
2253
2312
  /** Format: date-time */
2254
2313
  readonly createdAt?: string;
@@ -2270,7 +2329,7 @@ export type Schemas = {
2270
2329
  /** Format: date-time */
2271
2330
  readonly updatedAt?: string;
2272
2331
  };
2273
- Include: {
2332
+ Includes: {
2274
2333
  [key: string]: string[];
2275
2334
  };
2276
2335
  Integration: {
@@ -2285,6 +2344,13 @@ export type Schemas = {
2285
2344
  appointmentName?: string;
2286
2345
  /** The created Id for the attendee */
2287
2346
  attendeeId?: string;
2347
+ /** The name of the attendee */
2348
+ attendeeName?: string | null;
2349
+ /** The b2b features that available for the appointment */
2350
+ b2bFeatures?: {
2351
+ /** To know if the quote management is enabled for current customer */
2352
+ quoteManagement?: boolean;
2353
+ };
2288
2354
  /** The appointment id */
2289
2355
  id?: string;
2290
2356
  /** To see if it's a preview appointment */
@@ -2310,6 +2376,8 @@ export type Schemas = {
2310
2376
  salesChannelId?: string;
2311
2377
  /** The name of the current sales channel */
2312
2378
  salesChannelName?: string;
2379
+ /** The video user id that attendee could use */
2380
+ videoUserId?: string | null;
2313
2381
  };
2314
2382
  LandingPage: {
2315
2383
  active?: boolean;
@@ -2500,6 +2568,14 @@ export type Schemas = {
2500
2568
  dataTimestamp?: string;
2501
2569
  deliveryInformation: components["schemas"]["CartDeliveryInformation"];
2502
2570
  description?: string;
2571
+ extensions?: {
2572
+ meta?: {
2573
+ attendees?: {
2574
+ id: string;
2575
+ name: string;
2576
+ }[];
2577
+ };
2578
+ };
2503
2579
  good?: boolean;
2504
2580
  id: string;
2505
2581
  label?: string;
@@ -2554,7 +2630,9 @@ export type Schemas = {
2554
2630
  | "promotion"
2555
2631
  | "discount"
2556
2632
  | "container"
2557
- | "quantity";
2633
+ | "quantity"
2634
+ | "dsr-line-item-discount"
2635
+ | "dsr-cart-discount";
2558
2636
  ListPrice: {
2559
2637
  /** @enum {string} */
2560
2638
  apiAlias: "cart_list_price";
@@ -2613,6 +2691,23 @@ export type Schemas = {
2613
2691
  /** Format: date-time */
2614
2692
  readonly createdAt?: string;
2615
2693
  customFields?: GenericRecord;
2694
+ extensions?: {
2695
+ swagCmsExtensionsForms?: {
2696
+ data?: {
2697
+ /** @example a08561237fe1e2a012502c820a08405d */
2698
+ id?: string;
2699
+ /** @example swag_cms_extensions_form */
2700
+ type?: string;
2701
+ }[];
2702
+ links?: {
2703
+ /**
2704
+ * Format: uri-reference
2705
+ * @example /mail-template/901aa1bf1715ad482f037eaa8b9cdc3a/swagCmsExtensionsForms
2706
+ */
2707
+ related?: string;
2708
+ };
2709
+ };
2710
+ };
2616
2711
  id?: string;
2617
2712
  mailTemplateType?: components["schemas"]["MailTemplateType"];
2618
2713
  media?: components["schemas"]["MailTemplateMedia"][];
@@ -2699,7 +2794,7 @@ export type Schemas = {
2699
2794
  };
2700
2795
  };
2701
2796
  readonly fileExtension: string;
2702
- readonly fileName: string;
2797
+ fileName: string;
2703
2798
  /** Format: int64 */
2704
2799
  readonly fileSize?: number;
2705
2800
  /** Runtime field, cannot be used as part of the criteria. */
@@ -2711,7 +2806,7 @@ export type Schemas = {
2711
2806
  /** Format: int64 */
2712
2807
  width?: number;
2713
2808
  };
2714
- readonly mimeType?: string;
2809
+ mimeType?: string;
2715
2810
  path: string;
2716
2811
  private: boolean;
2717
2812
  thumbnails?: components["schemas"]["MediaThumbnail"][];
@@ -2800,7 +2895,7 @@ export type Schemas = {
2800
2895
  };
2801
2896
  MultiNotFilter: {
2802
2897
  /** @enum {string} */
2803
- operator: "AND" | "and" | "OR" | "or";
2898
+ operator: "and" | "or" | "nor" | "nand";
2804
2899
  queries: components["schemas"]["Filters"];
2805
2900
  /** @enum {string} */
2806
2901
  type: "multi" | "not";
@@ -2889,6 +2984,36 @@ export type Schemas = {
2889
2984
  deliveries?: components["schemas"]["OrderDelivery"][];
2890
2985
  documents: components["schemas"]["Document"][];
2891
2986
  extensions?: {
2987
+ orderEmployee?: {
2988
+ data?: {
2989
+ /** @example 5ea451c08a87db806089c4031601c29a */
2990
+ id?: string;
2991
+ /** @example b2b_order_employee */
2992
+ type?: string;
2993
+ }[];
2994
+ links?: {
2995
+ /**
2996
+ * Format: uri-reference
2997
+ * @example /order/a240fa27925a635b08dc28c9e4f9216d/orderEmployee
2998
+ */
2999
+ related?: string;
3000
+ };
3001
+ };
3002
+ quote?: {
3003
+ data?: {
3004
+ /** @example 7a674c327bfa07f7c1204fb38ca6ef3b */
3005
+ id?: string;
3006
+ /** @example quote */
3007
+ type?: string;
3008
+ };
3009
+ links?: {
3010
+ /**
3011
+ * Format: uri-reference
3012
+ * @example /order/a240fa27925a635b08dc28c9e4f9216d/quote
3013
+ */
3014
+ related?: string;
3015
+ };
3016
+ };
2892
3017
  returns?: {
2893
3018
  data?: {
2894
3019
  /** @example 7fff84525c6516919851a9005373f87e */
@@ -3518,12 +3643,17 @@ export type Schemas = {
3518
3643
  /** Format: date-time */
3519
3644
  readonly updatedAt?: string;
3520
3645
  };
3521
- PageViewedPayload: {
3646
+ PageViewedInteraction: components["schemas"]["BaseInteraction"] & {
3647
+ name: string;
3648
+ payload: components["schemas"]["PageViewedPayload"];
3649
+ } & {
3522
3650
  /**
3523
3651
  * discriminator enum property added by openapi-typescript
3524
3652
  * @enum {string}
3525
3653
  */
3526
3654
  name: "page.viewed";
3655
+ };
3656
+ PageViewedPayload: {
3527
3657
  /** the id from the page which was viewed */
3528
3658
  pageId: string;
3529
3659
  pageNumber?: number | null;
@@ -3662,23 +3792,21 @@ export type Schemas = {
3662
3792
  /** Format: date-time */
3663
3793
  readonly updatedAt?: string;
3664
3794
  };
3795
+ PresentationCmsPage: components["schemas"]["DsrPresentationCmsPage"] & {
3796
+ /** The product id is assigned to presentation if it's product listing or instant listing */
3797
+ pickedProductIds?: string[] | null;
3798
+ };
3665
3799
  PresentationSlideData: {
3800
+ category?: components["schemas"]["Category"];
3666
3801
  cmsPage?: components["schemas"]["CmsPage"];
3802
+ configurator?: components["schemas"]["PropertyGroup"][];
3667
3803
  extensions?: {
3668
- cmsPageRelation?: components["schemas"]["DsrPresentationCmsPage"];
3804
+ cmsPageRelation?: components["schemas"]["PresentationCmsPage"];
3669
3805
  };
3670
- } & (
3671
- | {
3672
- configurator?: components["schemas"]["PropertyGroup"][];
3673
- product?: components["schemas"]["Product"];
3674
- }
3675
- | {
3676
- category?: components["schemas"]["Category"];
3677
- }
3678
- | null
3679
- );
3806
+ product?: components["schemas"]["Product"];
3807
+ };
3680
3808
  PresentationStructure: {
3681
- cmsPageResults?: {
3809
+ cmsPageResults: {
3682
3810
  cmsPage?: components["schemas"]["CmsPage"];
3683
3811
  /** The presentation id */
3684
3812
  resourceIdentifier?: string;
@@ -3688,15 +3816,15 @@ export type Schemas = {
3688
3816
  */
3689
3817
  resourceType?: string;
3690
3818
  }[];
3691
- navigation?: {
3819
+ navigation: {
3692
3820
  /** The CMS page id */
3693
- cmsPageId?: string;
3821
+ cmsPageId: string;
3694
3822
  /** The presentation CMS page id */
3695
- groupId?: string;
3823
+ groupId: string;
3696
3824
  /** The slide name */
3697
- groupName?: string;
3825
+ groupName: string;
3698
3826
  /** The slide position */
3699
- index?: number;
3827
+ index: number;
3700
3828
  /** If the slide is an instant listing */
3701
3829
  isInstantListing?: boolean;
3702
3830
  /** @default [] */
@@ -3704,9 +3832,9 @@ export type Schemas = {
3704
3832
  /** The number of picked products of the instant listing */
3705
3833
  pickedProductsCount?: number;
3706
3834
  /** The section id */
3707
- sectionId?: string;
3835
+ sectionId: string;
3708
3836
  /** The section name */
3709
- sectionName?: string | null;
3837
+ sectionName: string | null;
3710
3838
  }[];
3711
3839
  };
3712
3840
  Price: {
@@ -4012,6 +4140,20 @@ export type Schemas = {
4012
4140
  /** Format: date-time */
4013
4141
  readonly updatedAt?: string;
4014
4142
  };
4143
+ ProductInteraction: components["schemas"]["BaseInteraction"] & {
4144
+ name: string;
4145
+ payload: components["schemas"]["ProductPayload"];
4146
+ } & {
4147
+ /**
4148
+ * discriminator enum property added by openapi-typescript
4149
+ * @enum {string}
4150
+ */
4151
+ name:
4152
+ | "product.viewed"
4153
+ | "attendee.product.collection.liked"
4154
+ | "attendee.product.collection.disliked"
4155
+ | "attendee.product.collection.removed";
4156
+ };
4015
4157
  ProductJsonApi: components["schemas"]["resource"] & {
4016
4158
  active?: boolean;
4017
4159
  readonly available?: boolean;
@@ -4521,16 +4663,16 @@ export type Schemas = {
4521
4663
  weight?: number;
4522
4664
  /** Format: float */
4523
4665
  width?: number;
4524
- } & {
4525
- options: {
4526
- group: string;
4527
- option: string;
4528
- translated: {
4666
+ } & components["schemas"]["DiscountLineItemPayload"] & {
4667
+ options: {
4529
4668
  group: string;
4530
4669
  option: string;
4531
- };
4532
- }[];
4533
- };
4670
+ translated: {
4671
+ group: string;
4672
+ option: string;
4673
+ };
4674
+ }[];
4675
+ };
4534
4676
  ProductKeywordDictionary: {
4535
4677
  id?: string;
4536
4678
  keyword: string;
@@ -4684,15 +4826,6 @@ export type Schemas = {
4684
4826
  product?: components["schemas"]["Product"];
4685
4827
  };
4686
4828
  ProductPayload: {
4687
- /**
4688
- * discriminator enum property added by openapi-typescript
4689
- * @enum {string}
4690
- */
4691
- name:
4692
- | "product.viewed"
4693
- | "attendee.product.collection.liked"
4694
- | "attendee.product.collection.disliked"
4695
- | "attendee.product.collection.removed";
4696
4829
  /** the id from the product which is used in the interaction */
4697
4830
  productId: string;
4698
4831
  };
@@ -5127,14 +5260,211 @@ export type Schemas = {
5127
5260
  /** Format: date-time */
5128
5261
  readonly updatedAt?: string;
5129
5262
  };
5130
- QuoteLineItem: {
5131
- children: components["schemas"]["QuoteLineItem"][];
5132
- cover?: components["schemas"]["Media"];
5133
- coverId?: string;
5263
+ QuoteJsonApi: components["schemas"]["resource"] & {
5264
+ /** Format: float */
5265
+ readonly amountNet?: number;
5266
+ /** Format: float */
5267
+ readonly amountTotal?: number;
5134
5268
  /** Format: date-time */
5135
5269
  readonly createdAt?: string;
5270
+ createdById?: string;
5271
+ currencyId: string;
5272
+ customerId: string;
5136
5273
  customFields?: GenericRecord;
5137
- description?: string;
5274
+ discount?: {
5275
+ type?: string;
5276
+ /** Format: float */
5277
+ value?: number;
5278
+ };
5279
+ /** Format: date-time */
5280
+ expirationDate?: string;
5281
+ id: string;
5282
+ languageId: string;
5283
+ orderId?: string;
5284
+ orderVersionId?: string;
5285
+ price?: {
5286
+ calculatedTaxes?: GenericRecord;
5287
+ /** Format: float */
5288
+ netPrice: number;
5289
+ /** Format: float */
5290
+ positionPrice: number;
5291
+ /** Format: float */
5292
+ rawTotal: number;
5293
+ taxRules?: GenericRecord;
5294
+ taxStatus: string;
5295
+ /** Format: float */
5296
+ totalPrice: number;
5297
+ };
5298
+ quoteNumber?: string;
5299
+ relationships?: {
5300
+ comments?: {
5301
+ data?: {
5302
+ /** @example a5d491060952aa8ad5fdee071be752de */
5303
+ id?: string;
5304
+ /** @example quote_comment */
5305
+ type?: string;
5306
+ }[];
5307
+ links?: {
5308
+ /**
5309
+ * Format: uri-reference
5310
+ * @example /quote/c48e929b2b1eabba2ba036884433345e/comments
5311
+ */
5312
+ related?: string;
5313
+ };
5314
+ };
5315
+ currency?: {
5316
+ data?: {
5317
+ /** @example 1af0389838508d7016a9841eb6273962 */
5318
+ id?: string;
5319
+ /** @example currency */
5320
+ type?: string;
5321
+ };
5322
+ links?: {
5323
+ /**
5324
+ * Format: uri-reference
5325
+ * @example /quote/c48e929b2b1eabba2ba036884433345e/currency
5326
+ */
5327
+ related?: string;
5328
+ };
5329
+ };
5330
+ deliveries?: {
5331
+ data?: {
5332
+ /** @example 6fc31b6b9cd717cc0dcb81152308f8af */
5333
+ id?: string;
5334
+ /** @example quote_delivery */
5335
+ type?: string;
5336
+ }[];
5337
+ links?: {
5338
+ /**
5339
+ * Format: uri-reference
5340
+ * @example /quote/c48e929b2b1eabba2ba036884433345e/deliveries
5341
+ */
5342
+ related?: string;
5343
+ };
5344
+ };
5345
+ documents?: {
5346
+ data?: {
5347
+ /** @example 21f64da1e5792c8295b964d159a14491 */
5348
+ id?: string;
5349
+ /** @example quote_document */
5350
+ type?: string;
5351
+ }[];
5352
+ links?: {
5353
+ /**
5354
+ * Format: uri-reference
5355
+ * @example /quote/c48e929b2b1eabba2ba036884433345e/documents
5356
+ */
5357
+ related?: string;
5358
+ };
5359
+ };
5360
+ language?: {
5361
+ data?: {
5362
+ /** @example 8512ae7d57b1396273f76fe6ed341a23 */
5363
+ id?: string;
5364
+ /** @example language */
5365
+ type?: string;
5366
+ };
5367
+ links?: {
5368
+ /**
5369
+ * Format: uri-reference
5370
+ * @example /quote/c48e929b2b1eabba2ba036884433345e/language
5371
+ */
5372
+ related?: string;
5373
+ };
5374
+ };
5375
+ lineItems?: {
5376
+ data?: {
5377
+ /** @example a042af1aa9f3853fe3cd7dabc065568f */
5378
+ id?: string;
5379
+ /** @example quote_line_item */
5380
+ type?: string;
5381
+ }[];
5382
+ links?: {
5383
+ /**
5384
+ * Format: uri-reference
5385
+ * @example /quote/c48e929b2b1eabba2ba036884433345e/lineItems
5386
+ */
5387
+ related?: string;
5388
+ };
5389
+ };
5390
+ stateMachineState?: {
5391
+ data?: {
5392
+ /** @example 1ab22d393154f21e3be76aca3ec3ee31 */
5393
+ id?: string;
5394
+ /** @example state_machine_state */
5395
+ type?: string;
5396
+ };
5397
+ links?: {
5398
+ /**
5399
+ * Format: uri-reference
5400
+ * @example /quote/c48e929b2b1eabba2ba036884433345e/stateMachineState
5401
+ */
5402
+ related?: string;
5403
+ };
5404
+ };
5405
+ transactions?: {
5406
+ data?: {
5407
+ /** @example c15b977dd99332ca8623fbdfb86827e8 */
5408
+ id?: string;
5409
+ /** @example quote_transaction */
5410
+ type?: string;
5411
+ }[];
5412
+ links?: {
5413
+ /**
5414
+ * Format: uri-reference
5415
+ * @example /quote/c48e929b2b1eabba2ba036884433345e/transactions
5416
+ */
5417
+ related?: string;
5418
+ };
5419
+ };
5420
+ };
5421
+ salesChannelId: string;
5422
+ /** Format: date-time */
5423
+ sentAt?: string;
5424
+ shippingCosts?: {
5425
+ calculatedTaxes?: GenericRecord;
5426
+ listPrice?: {
5427
+ /** Format: float */
5428
+ discount?: number;
5429
+ /** Format: float */
5430
+ percentage?: number;
5431
+ /** Format: float */
5432
+ price?: number;
5433
+ };
5434
+ /** Format: int64 */
5435
+ quantity: number;
5436
+ referencePrice?: GenericRecord;
5437
+ regulationPrice?: {
5438
+ /** Format: float */
5439
+ price?: number;
5440
+ };
5441
+ taxRules?: GenericRecord;
5442
+ /** Format: float */
5443
+ totalPrice: number;
5444
+ /** Format: float */
5445
+ unitPrice: number;
5446
+ };
5447
+ stateId: string;
5448
+ /** Format: float */
5449
+ subtotalNet?: number;
5450
+ readonly taxStatus?: string;
5451
+ /** Format: float */
5452
+ totalDiscount?: number;
5453
+ /** Format: date-time */
5454
+ readonly updatedAt?: string;
5455
+ updatedById?: string;
5456
+ userId?: string;
5457
+ versionId?: string;
5458
+ };
5459
+ QuoteLineItem: {
5460
+ children: components["schemas"]["QuoteLineItem"][];
5461
+ cover?: components["schemas"]["Media"];
5462
+ coverId?: string;
5463
+ /** Format: date-time */
5464
+ readonly createdAt?: string;
5465
+ customFields?: GenericRecord;
5466
+ deliveryPositions?: components["schemas"]["QuoteDeliveryPosition"][];
5467
+ description?: string;
5138
5468
  discount?: {
5139
5469
  type?: string;
5140
5470
  /** Format: int64 */
@@ -5242,6 +5572,21 @@ export type Schemas = {
5242
5572
  customFields?: GenericRecord;
5243
5573
  description?: string;
5244
5574
  extensions?: {
5575
+ swagCmsExtensionsBlockRules?: {
5576
+ data?: {
5577
+ /** @example ce0b9f43f8947576ee10c93d4d69a4c4 */
5578
+ id?: string;
5579
+ /** @example swag_cms_extensions_block_rule */
5580
+ type?: string;
5581
+ }[];
5582
+ links?: {
5583
+ /**
5584
+ * Format: uri-reference
5585
+ * @example /rule/ab7a485ebe75b6dd7243ad719f23c7de/swagCmsExtensionsBlockRules
5586
+ */
5587
+ related?: string;
5588
+ };
5589
+ };
5245
5590
  warehouseGroup?: {
5246
5591
  data?: {
5247
5592
  /** @example 1768e3071b62161d415e0c24332055ed */
@@ -5393,6 +5738,10 @@ export type Schemas = {
5393
5738
  displayGross?: boolean;
5394
5739
  name?: string;
5395
5740
  };
5741
+ languageInfo: {
5742
+ localeCode: string;
5743
+ name: string;
5744
+ };
5396
5745
  paymentMethod?: components["schemas"]["PaymentMethod"];
5397
5746
  salesChannel: components["schemas"]["SalesChannel"];
5398
5747
  shippingLocation?: {
@@ -5474,15 +5823,20 @@ export type Schemas = {
5474
5823
  /** Format: date-time */
5475
5824
  readonly updatedAt?: string;
5476
5825
  };
5477
- ScreenSharingToggledPayload: {
5478
- /** Whether the screen sharing is active or not */
5479
- active: boolean;
5826
+ ScreenSharingToggledInteraction: components["schemas"]["BaseInteraction"] & {
5827
+ name: string;
5828
+ payload: components["schemas"]["ScreenSharingToggledPayload"];
5829
+ } & {
5480
5830
  /**
5481
5831
  * discriminator enum property added by openapi-typescript
5482
5832
  * @enum {string}
5483
5833
  */
5484
5834
  name: "screenSharing.toggled";
5485
5835
  };
5836
+ ScreenSharingToggledPayload: {
5837
+ /** Whether the screen sharing is active or not */
5838
+ active: boolean;
5839
+ };
5486
5840
  Script: {
5487
5841
  /** Format: date-time */
5488
5842
  readonly createdAt?: string;
@@ -5902,6 +6256,13 @@ export type Schemas = {
5902
6256
  /** Format: date-time */
5903
6257
  readonly updatedAt?: string;
5904
6258
  };
6259
+ SpatialSceneGroup: {
6260
+ /** Format: date-time */
6261
+ readonly createdAt?: string;
6262
+ id?: string;
6263
+ /** Format: date-time */
6264
+ readonly updatedAt?: string;
6265
+ };
5905
6266
  SpatialSceneLight: {
5906
6267
  /** Format: date-time */
5907
6268
  readonly createdAt?: string;
@@ -5909,6 +6270,13 @@ export type Schemas = {
5909
6270
  /** Format: date-time */
5910
6271
  readonly updatedAt?: string;
5911
6272
  };
6273
+ SpatialSceneMaterial: {
6274
+ /** Format: date-time */
6275
+ readonly createdAt?: string;
6276
+ id?: string;
6277
+ /** Format: date-time */
6278
+ readonly updatedAt?: string;
6279
+ };
5912
6280
  SpatialSceneObject: {
5913
6281
  /** Format: date-time */
5914
6282
  readonly createdAt?: string;
@@ -5916,6 +6284,13 @@ export type Schemas = {
5916
6284
  /** Format: date-time */
5917
6285
  readonly updatedAt?: string;
5918
6286
  };
6287
+ SpatialScenePrimitive: {
6288
+ /** Format: date-time */
6289
+ readonly createdAt?: string;
6290
+ id?: string;
6291
+ /** Format: date-time */
6292
+ readonly updatedAt?: string;
6293
+ };
5919
6294
  SsoProvider: {
5920
6295
  /** Format: date-time */
5921
6296
  readonly createdAt?: string;
@@ -5985,13 +6360,6 @@ export type Schemas = {
5985
6360
  hoveredElementId?: string | null;
5986
6361
  videoClientToken?: string | null;
5987
6362
  };
5988
- StateForMe: {
5989
- attendeeName?: string | null;
5990
- /** @default [] */
5991
- extensions?: unknown[];
5992
- /** @default null */
5993
- guideCartPermissionsGranted?: boolean;
5994
- };
5995
6363
  StateMachine: {
5996
6364
  /** Format: date-time */
5997
6365
  readonly createdAt?: string;
@@ -6254,25 +6622,77 @@ export type Schemas = {
6254
6622
  visibilityRuleId?: string;
6255
6623
  };
6256
6624
  SwagCmsExtensionsForm: {
6625
+ cmsSlot?: components["schemas"]["CmsSlot"];
6626
+ cmsSlotId?: string;
6627
+ cmsSlotVersionId?: string;
6257
6628
  /** Format: date-time */
6258
6629
  readonly createdAt?: string;
6259
- id?: string;
6630
+ groups?: components["schemas"]["SwagCmsExtensionsFormGroup"][];
6631
+ id: string;
6632
+ isTemplate?: boolean;
6633
+ mailTemplate?: components["schemas"]["MailTemplate"];
6634
+ mailTemplateId: string;
6635
+ receivers?: GenericRecord;
6636
+ successMessage?: string;
6637
+ technicalName: string;
6638
+ title?: string;
6639
+ translated: {
6640
+ cmsSlotId: string;
6641
+ cmsSlotVersionId: string;
6642
+ mailTemplateId: string;
6643
+ successMessage: string;
6644
+ technicalName: string;
6645
+ title: string;
6646
+ };
6260
6647
  /** Format: date-time */
6261
6648
  readonly updatedAt?: string;
6262
6649
  };
6263
6650
  SwagCmsExtensionsFormGroup: {
6264
6651
  /** Format: date-time */
6265
6652
  readonly createdAt?: string;
6266
- id?: string;
6653
+ fields?: components["schemas"]["SwagCmsExtensionsFormGroupField"][];
6654
+ form?: components["schemas"]["SwagCmsExtensionsForm"];
6655
+ formId?: string;
6656
+ id: string;
6657
+ /** Format: int64 */
6658
+ position: number;
6659
+ technicalName: string;
6660
+ title?: string;
6661
+ translated: {
6662
+ formId: string;
6663
+ technicalName: string;
6664
+ title: string;
6665
+ };
6267
6666
  /** Format: date-time */
6268
6667
  readonly updatedAt?: string;
6269
6668
  };
6270
6669
  SwagCmsExtensionsFormGroupField: {
6670
+ config?: GenericRecord;
6271
6671
  /** Format: date-time */
6272
6672
  readonly createdAt?: string;
6273
- id?: string;
6673
+ errorMessage?: string;
6674
+ group?: components["schemas"]["SwagCmsExtensionsFormGroup"];
6675
+ groupId?: string;
6676
+ id: string;
6677
+ label: string;
6678
+ placeholder?: string;
6679
+ /** Format: int64 */
6680
+ position: number;
6681
+ required?: boolean;
6682
+ technicalName: string;
6683
+ translated: {
6684
+ errorMessage: string;
6685
+ groupId: string;
6686
+ label: string;
6687
+ placeholder: string;
6688
+ technicalName: string;
6689
+ type: string;
6690
+ };
6691
+ type: string;
6274
6692
  /** Format: date-time */
6275
6693
  readonly updatedAt?: string;
6694
+ /** Format: int64 */
6695
+ width: number;
6276
6696
  };
6277
6697
  SwagCmsExtensionsQuickview: {
6278
6698
  active?: boolean;
@@ -6989,22 +7409,12 @@ export type Schemas = {
6989
7409
  readonly updatedAt?: string;
6990
7410
  };
6991
7411
  SwagPaypalVaultToken: {
6992
- // TODO: [OpenAPI][SwagPaypalVaultToken] - add SwagPaypalVaultToken definition to schema
7412
+ id?: string;
7413
+ identifier?: string;
7414
+ };
7415
+ SwagPaypalVaultTokenMapping: {
6993
7416
  /** Format: date-time */
6994
- createdAt: string;
6995
- customer?: components["schemas"]["Customer"];
6996
- customerId: string;
6997
- id?: string;
6998
- identifier: string;
6999
- mainMapping?: components["schemas"]["SwagPaypalVaultTokenMapping"];
7000
- paymentMethod?: components["schemas"]["PaymentMethod"];
7001
- paymentMethodId: string;
7002
- /** Format: date-time */
7003
- updatedAt?: string;
7004
- };
7005
- SwagPaypalVaultTokenMapping: {
7006
- /** Format: date-time */
7007
- readonly createdAt?: string;
7417
+ readonly createdAt?: string;
7008
7418
  customer?: components["schemas"]["Customer"];
7009
7419
  customerId: string;
7010
7420
  id?: string;
@@ -7141,15 +7551,20 @@ export type Schemas = {
7141
7551
  /** Format: date-time */
7142
7552
  readonly updatedAt?: string;
7143
7553
  };
7144
- ToggleBroadcastModePayload: {
7145
- /** Status if the mode is toggled to active or inactive */
7146
- active: boolean;
7554
+ ToggleBroadcastModeInteraction: components["schemas"]["BaseInteraction"] & {
7555
+ name: string;
7556
+ payload: components["schemas"]["ToggleBroadcastModePayload"];
7557
+ } & {
7147
7558
  /**
7148
7559
  * discriminator enum property added by openapi-typescript
7149
7560
  * @enum {string}
7150
7561
  */
7151
7562
  name: "broadcastMode.toggled";
7152
7563
  };
7564
+ ToggleBroadcastModePayload: {
7565
+ /** Status if the mode is toggled to active or inactive */
7566
+ active: boolean;
7567
+ };
7153
7568
  TotalCountMode: "none" | "exact" | "next-pages";
7154
7569
  Unit: {
7155
7570
  /** Format: date-time */
@@ -7201,6 +7616,16 @@ export type Schemas = {
7201
7616
  /** Format: date-time */
7202
7617
  readonly updatedAt?: string;
7203
7618
  };
7619
+ ViewModeChangedInteraction: components["schemas"]["BaseInteraction"] & {
7620
+ name: string;
7621
+ payload: components["schemas"]["ViewModeChangedPayload"];
7622
+ } & {
7623
+ /**
7624
+ * discriminator enum property added by openapi-typescript
7625
+ * @enum {string}
7626
+ */
7627
+ name: "viewMode.changed";
7628
+ };
7204
7629
  ViewModeChangedPayload: {
7205
7630
  /**
7206
7631
  * The view mode of presentation
@@ -7208,11 +7633,6 @@ export type Schemas = {
7208
7633
  * @enum {string}
7209
7634
  */
7210
7635
  mode?: "onlyYou" | "presentation" | "videoGrid";
7211
- /**
7212
- * discriminator enum property added by openapi-typescript
7213
- * @enum {string}
7214
- */
7215
- name: "viewMode.changed";
7216
7636
  };
7217
7637
  Warehouse: {
7218
7638
  /** Format: date-time */
@@ -7368,6 +7788,1390 @@ export type Schemas = {
7368
7788
  components["schemas"]["pagination"];
7369
7789
  meta?: components["schemas"]["meta"];
7370
7790
  };
7791
+ swag_paypal_v1_capture: {
7792
+ amount: components["schemas"]["swag_paypal_v1_common_amount"];
7793
+ create_time: string;
7794
+ id: string;
7795
+ is_final_capture: boolean;
7796
+ links: components["schemas"]["swag_paypal_v1_common_link"][];
7797
+ parent_payment: string;
7798
+ reason_code: string;
7799
+ state: string;
7800
+ transaction_fee: components["schemas"]["swag_paypal_v1_capture_transaction_fee"];
7801
+ update_time: string;
7802
+ };
7803
+ swag_paypal_v1_capture_transaction_fee: components["schemas"]["swag_paypal_v1_common_value"];
7804
+ swag_paypal_v1_client_token: {
7805
+ client_token: string;
7806
+ /**
7807
+ * Format: date-time
7808
+ * Calculated expiration date
7809
+ */
7810
+ expire_date_time: string;
7811
+ /** The lifetime of the access token, in seconds. */
7812
+ expires_in: number;
7813
+ };
7814
+ swag_paypal_v1_common_address: {
7815
+ city: string;
7816
+ country_code: string;
7817
+ line1: string;
7818
+ line2: string | null;
7819
+ phone: string | null;
7820
+ postal_code: string;
7821
+ state: string | null;
7822
+ };
7823
+ swag_paypal_v1_common_amount: {
7824
+ currency: string;
7825
+ details: components["schemas"]["swag_paypal_v1_common_details"];
7826
+ total: string;
7827
+ };
7828
+ swag_paypal_v1_common_details: {
7829
+ discount: string;
7830
+ handling_fee: string;
7831
+ insurance: string;
7832
+ shipping: string;
7833
+ shipping_discount: string;
7834
+ subtotal: string;
7835
+ tax: string;
7836
+ };
7837
+ swag_paypal_v1_common_link: {
7838
+ enc_type: string | null;
7839
+ href: string;
7840
+ method: string;
7841
+ rel: string;
7842
+ };
7843
+ swag_paypal_v1_common_money: {
7844
+ currency_code: string;
7845
+ value: string;
7846
+ };
7847
+ swag_paypal_v1_common_value: {
7848
+ currency: string;
7849
+ value: string;
7850
+ };
7851
+ swag_paypal_v1_create_webhooks: {
7852
+ event_types: components["schemas"]["swag_paypal_v1_create_webhooks_event_type"][];
7853
+ url: string;
7854
+ };
7855
+ swag_paypal_v1_create_webhooks_event_type: {
7856
+ name: string;
7857
+ };
7858
+ swag_paypal_v1_disputes: {
7859
+ items: components["schemas"]["swag_paypal_v1_disputes_item"][] | null;
7860
+ links: components["schemas"]["swag_paypal_v1_common_link"][];
7861
+ };
7862
+ swag_paypal_v1_disputes_common_buyer: {
7863
+ name: string;
7864
+ };
7865
+ swag_paypal_v1_disputes_common_item: {
7866
+ dispute_amount: components["schemas"]["swag_paypal_v1_common_money"];
7867
+ item_description: string;
7868
+ item_id: string;
7869
+ item_quantity: string;
7870
+ notes: string;
7871
+ partner_transaction_id: string;
7872
+ reason: string;
7873
+ };
7874
+ swag_paypal_v1_disputes_common_product_details: {
7875
+ product_received: string;
7876
+ product_received_time: string;
7877
+ purchase_url: string;
7878
+ return_details: components["schemas"]["swag_paypal_v1_disputes_common_return_details"];
7879
+ sub_reasons: components["schemas"]["swag_paypal_v1_disputes_common_sub_reason"][];
7880
+ };
7881
+ swag_paypal_v1_disputes_common_return_details: {
7882
+ mode: string;
7883
+ receipt: boolean;
7884
+ return_confirmation_number: string;
7885
+ return_time: string;
7886
+ returned: boolean;
7887
+ };
7888
+ swag_paypal_v1_disputes_common_seller: {
7889
+ email: string;
7890
+ merchant_id: string;
7891
+ name: string;
7892
+ };
7893
+ swag_paypal_v1_disputes_common_service_details: {
7894
+ description: string;
7895
+ note: string;
7896
+ purchase_url: string;
7897
+ service_started: string;
7898
+ sub_reasons: components["schemas"]["swag_paypal_v1_disputes_common_sub_reason"][];
7899
+ };
7900
+ swag_paypal_v1_disputes_common_sub_reason: {
7901
+ sub_reason: string;
7902
+ };
7903
+ swag_paypal_v1_disputes_common_transaction: {
7904
+ buyer: components["schemas"]["swag_paypal_v1_disputes_common_buyer"];
7905
+ buyer_transaction_id: string;
7906
+ create_time: string;
7907
+ custom: string;
7908
+ gross_amount: components["schemas"]["swag_paypal_v1_common_money"];
7909
+ invoice_number: string;
7910
+ items: components["schemas"]["swag_paypal_v1_disputes_common_item"][];
7911
+ reference_id: string;
7912
+ seller: components["schemas"]["swag_paypal_v1_disputes_common_seller"];
7913
+ seller_transaction_id: string;
7914
+ transaction_status: string;
7915
+ };
7916
+ swag_paypal_v1_disputes_item: {
7917
+ adjudications: components["schemas"]["swag_paypal_v1_disputes_item_adjudication"][];
7918
+ buyer_response_due_date: string | null;
7919
+ communication_details:
7920
+ | components["schemas"]["swag_paypal_v1_disputes_item_communication_details"]
7921
+ | null;
7922
+ create_time: string;
7923
+ dispute_amount: components["schemas"]["swag_paypal_v1_disputes_item_dispute_amount"];
7924
+ dispute_channel: string | null;
7925
+ dispute_id: string;
7926
+ dispute_life_cycle_stage: string;
7927
+ dispute_outcome:
7928
+ | components["schemas"]["swag_paypal_v1_disputes_item_dispute_outcome"]
7929
+ | null;
7930
+ /** @enum {string|null} */
7931
+ dispute_state:
7932
+ | "REQUIRED_ACTION"
7933
+ | "REQUIRED_OTHER_PARTY_ACTION"
7934
+ | "UNDER_PAYPAL_REVIEW"
7935
+ | "RESOLVED"
7936
+ | "OPEN_INQUIRIES"
7937
+ | "APPEALABLE"
7938
+ | null;
7939
+ disputed_transactions:
7940
+ | components["schemas"]["swag_paypal_v1_disputes_item_disputed_transaction"][]
7941
+ | null;
7942
+ evidences:
7943
+ | components["schemas"]["swag_paypal_v1_disputes_item_evidence"][]
7944
+ | null;
7945
+ extensions: components["schemas"]["swag_paypal_v1_disputes_item_extensions"];
7946
+ external_reason_code: string | null;
7947
+ links: components["schemas"]["swag_paypal_v1_common_link"][];
7948
+ messages:
7949
+ | components["schemas"]["swag_paypal_v1_disputes_item_message"][]
7950
+ | null;
7951
+ money_movements: components["schemas"]["swag_paypal_v1_disputes_item_money_movement"][];
7952
+ offer: components["schemas"]["swag_paypal_v1_disputes_item_offer"] | null;
7953
+ partner_actions:
7954
+ | components["schemas"]["swag_paypal_v1_disputes_item_partner_action"][]
7955
+ | null;
7956
+ reason: string;
7957
+ refund_details:
7958
+ | components["schemas"]["swag_paypal_v1_disputes_item_refund_details"]
7959
+ | null;
7960
+ seller_response_due_date: string | null;
7961
+ status: string;
7962
+ supporting_info:
7963
+ | components["schemas"]["swag_paypal_v1_disputes_item_supporting_info"][]
7964
+ | null;
7965
+ update_time: string;
7966
+ };
7967
+ swag_paypal_v1_disputes_item_adjudication: {
7968
+ adjudication_time: string;
7969
+ dispute_life_cycle_stage: string;
7970
+ reason: string;
7971
+ type: string;
7972
+ };
7973
+ swag_paypal_v1_disputes_item_communication_details: {
7974
+ email: string;
7975
+ note: string;
7976
+ time_posted: string;
7977
+ };
7978
+ swag_paypal_v1_disputes_item_dispute_amount: components["schemas"]["swag_paypal_v1_common_money"];
7979
+ swag_paypal_v1_disputes_item_dispute_outcome: {
7980
+ amount_refunded: components["schemas"]["swag_paypal_v1_common_money"];
7981
+ outcome_code: string;
7982
+ };
7983
+ swag_paypal_v1_disputes_item_disputed_transaction: components["schemas"]["swag_paypal_v1_disputes_common_transaction"] & {
7984
+ seller_protection_eligible: boolean;
7985
+ };
7986
+ swag_paypal_v1_disputes_item_evidence: {
7987
+ documents: components["schemas"]["swag_paypal_v1_disputes_item_evidence_document"][];
7988
+ evidence_info: components["schemas"]["swag_paypal_v1_disputes_item_evidence_evidence_info"];
7989
+ evidence_type: string;
7990
+ item_id: string;
7991
+ notes: string;
7992
+ };
7993
+ swag_paypal_v1_disputes_item_evidence_document: {
7994
+ name: string;
7995
+ };
7996
+ swag_paypal_v1_disputes_item_evidence_evidence_info: {
7997
+ refund_ids: components["schemas"]["swag_paypal_v1_disputes_item_evidence_evidence_info_refund_id"][];
7998
+ tracking_info: components["schemas"]["swag_paypal_v1_disputes_item_evidence_evidence_info_tracking_info"][];
7999
+ };
8000
+ swag_paypal_v1_disputes_item_evidence_evidence_info_refund_id: {
8001
+ refund_id: string;
8002
+ };
8003
+ swag_paypal_v1_disputes_item_evidence_evidence_info_tracking_info: {
8004
+ carrier_name: string;
8005
+ carrier_name_other: string;
8006
+ tracking_number: string;
8007
+ tracking_url: string;
8008
+ };
8009
+ swag_paypal_v1_disputes_item_extensions: {
8010
+ billing_dispute_properties: components["schemas"]["swag_paypal_v1_disputes_item_extensions_billing_dispute_properties"];
8011
+ buyer_contacted_channel: string;
8012
+ buyer_contacted_time: string;
8013
+ merchandize_dispute_properties: components["schemas"]["swag_paypal_v1_disputes_item_extensions_merchandize_dispute_properties"];
8014
+ merchant_contacted: boolean;
8015
+ merchant_contacted_mode: string;
8016
+ merchant_contacted_outcome: string;
8017
+ merchant_contacted_time: string;
8018
+ };
8019
+ swag_paypal_v1_disputes_item_extensions_billing_dispute_properties: {
8020
+ canceled_recurring_billing: components["schemas"]["swag_paypal_v1_disputes_item_extensions_billing_dispute_properties_canceled_recurring_billing"];
8021
+ credit_not_processed: components["schemas"]["swag_paypal_v1_disputes_item_extensions_billing_dispute_properties_credit_not_processed"];
8022
+ duplicate_transaction: components["schemas"]["swag_paypal_v1_disputes_item_extensions_billing_dispute_properties_duplicate_transaction"];
8023
+ incorrect_transaction_amount: components["schemas"]["swag_paypal_v1_disputes_item_extensions_billing_dispute_properties_incorrect_transaction_amount"];
8024
+ payment_by_other_means: components["schemas"]["swag_paypal_v1_disputes_item_extensions_billing_dispute_properties_payment_by_other_means"];
8025
+ };
8026
+ swag_paypal_v1_disputes_item_extensions_billing_dispute_properties_canceled_recurring_billing: {
8027
+ cancellation_details: components["schemas"]["swag_paypal_v1_disputes_item_extensions_billing_dispute_properties_common_cancellation_details"];
8028
+ expected_refund: components["schemas"]["swag_paypal_v1_common_money"];
8029
+ };
8030
+ swag_paypal_v1_disputes_item_extensions_billing_dispute_properties_common_agreed_refund_details: {
8031
+ merchant_agreed_refund: boolean;
8032
+ merchant_agreed_refund_time: string;
8033
+ };
8034
+ swag_paypal_v1_disputes_item_extensions_billing_dispute_properties_common_cancellation_details: {
8035
+ cancellation_date: string;
8036
+ cancellation_mode: string;
8037
+ cancellation_number: string;
8038
+ cancelled: boolean;
8039
+ };
8040
+ swag_paypal_v1_disputes_item_extensions_billing_dispute_properties_credit_not_processed: {
8041
+ agreed_refund_details: components["schemas"]["swag_paypal_v1_disputes_item_extensions_billing_dispute_properties_common_agreed_refund_details"];
8042
+ cancellation_details: components["schemas"]["swag_paypal_v1_disputes_item_extensions_billing_dispute_properties_common_cancellation_details"];
8043
+ expected_refund: components["schemas"]["swag_paypal_v1_common_money"];
8044
+ issue_type: string;
8045
+ product_details: components["schemas"]["swag_paypal_v1_disputes_common_product_details"];
8046
+ service_details: components["schemas"]["swag_paypal_v1_disputes_common_service_details"];
8047
+ };
8048
+ swag_paypal_v1_disputes_item_extensions_billing_dispute_properties_duplicate_transaction: {
8049
+ original_transaction: components["schemas"]["swag_paypal_v1_disputes_common_transaction"];
8050
+ received_duplicate: boolean;
8051
+ };
8052
+ swag_paypal_v1_disputes_item_extensions_billing_dispute_properties_incorrect_transaction_amount: {
8053
+ correct_transaction_amount: components["schemas"]["swag_paypal_v1_common_money"];
8054
+ correct_transaction_time: string;
8055
+ };
8056
+ swag_paypal_v1_disputes_item_extensions_billing_dispute_properties_payment_by_other_means: {
8057
+ charge_different_from_original: boolean;
8058
+ payment_instrument_suffix: string;
8059
+ payment_method: string;
8060
+ received_duplicate: boolean;
8061
+ };
8062
+ swag_paypal_v1_disputes_item_extensions_merchandize_dispute_properties: {
8063
+ issue_type: string;
8064
+ product_details: components["schemas"]["swag_paypal_v1_disputes_common_product_details"];
8065
+ service_details: components["schemas"]["swag_paypal_v1_disputes_common_service_details"];
8066
+ };
8067
+ swag_paypal_v1_disputes_item_message: {
8068
+ content: string;
8069
+ posted_by: string;
8070
+ time_posted: string;
8071
+ };
8072
+ swag_paypal_v1_disputes_item_money_movement: {
8073
+ affected_party: string;
8074
+ amount: components["schemas"]["swag_paypal_v1_common_amount"];
8075
+ initiated_time: string;
8076
+ reason: string;
8077
+ type: string;
8078
+ };
8079
+ swag_paypal_v1_disputes_item_offer: {
8080
+ buyer_requested_amount: components["schemas"]["swag_paypal_v1_common_money"];
8081
+ history:
8082
+ | components["schemas"]["swag_paypal_v1_disputes_item_offer_history"][]
8083
+ | null;
8084
+ offer_type: string;
8085
+ seller_offered_amount: components["schemas"]["swag_paypal_v1_common_money"];
8086
+ };
8087
+ swag_paypal_v1_disputes_item_offer_history: {
8088
+ actor: string;
8089
+ event_type: string;
8090
+ offer_time: string;
8091
+ offer_type: string;
8092
+ };
8093
+ swag_paypal_v1_disputes_item_partner_action: {
8094
+ amount: components["schemas"]["swag_paypal_v1_common_money"];
8095
+ create_time: string;
8096
+ due_time: string;
8097
+ id: string;
8098
+ name: string;
8099
+ status: string;
8100
+ update_time: string;
8101
+ };
8102
+ swag_paypal_v1_disputes_item_refund_details: {
8103
+ allowed_refund_amount: components["schemas"]["swag_paypal_v1_common_money"];
8104
+ };
8105
+ swag_paypal_v1_disputes_item_supporting_info: {
8106
+ notes: string;
8107
+ provided_time: string;
8108
+ source: string;
8109
+ };
8110
+ swag_paypal_v1_do_void: {
8111
+ amount: components["schemas"]["swag_paypal_v1_common_amount"];
8112
+ create_time: string;
8113
+ id: string;
8114
+ links: components["schemas"]["swag_paypal_v1_common_link"][];
8115
+ parent_payment: string;
8116
+ state: string;
8117
+ update_time: string;
8118
+ };
8119
+ swag_paypal_v1_merchant_integrations: {
8120
+ capabilities:
8121
+ | components["schemas"]["swag_paypal_v1_merchant_integrations_capability"][]
8122
+ | null;
8123
+ granted_permissions: string[];
8124
+ legal_name: string;
8125
+ merchant_id: string;
8126
+ oauth_integrations: components["schemas"]["swag_paypal_v1_merchant_integrations_oauth_integration"][];
8127
+ payments_receivable: boolean;
8128
+ primary_email: string;
8129
+ primary_email_confirmed: boolean;
8130
+ products: components["schemas"]["swag_paypal_v1_merchant_integrations_product"][];
8131
+ tracking_id: string;
8132
+ };
8133
+ swag_paypal_v1_merchant_integrations_capability: {
8134
+ name: string;
8135
+ status: string;
8136
+ };
8137
+ swag_paypal_v1_merchant_integrations_oauth_integration: {
8138
+ integration_method?: string;
8139
+ integration_type?: string;
8140
+ oauth_third_party?: components["schemas"]["swag_paypal_v1_merchant_integrations_oauth_integration_oauth_third_party"][];
8141
+ status?: string;
8142
+ };
8143
+ swag_paypal_v1_merchant_integrations_oauth_integration_oauth_third_party: {
8144
+ access_token?: string;
8145
+ merchant_client_id?: string;
8146
+ partner_client_id?: string;
8147
+ refresh_token?: string;
8148
+ scopes: string[];
8149
+ };
8150
+ swag_paypal_v1_merchant_integrations_product: {
8151
+ capabilities?: string[];
8152
+ name: string;
8153
+ vetting_status?: string;
8154
+ };
8155
+ swag_paypal_v1_oauth_credentials: {
8156
+ restId: string;
8157
+ restSecret: string;
8158
+ url: string;
8159
+ };
8160
+ swag_paypal_v1_patch: {
8161
+ /** @enum {string} */
8162
+ op: "add" | "replace";
8163
+ path: string;
8164
+ value: string | Record<string, never>[];
8165
+ };
8166
+ swag_paypal_v1_payment: {
8167
+ application_context: components["schemas"]["swag_paypal_v1_payment_application_context"];
8168
+ cart: string;
8169
+ create_time: string;
8170
+ id: string;
8171
+ /**
8172
+ * @default sale
8173
+ * @enum {string}
8174
+ */
8175
+ intent?: "sale" | "authorize" | "order";
8176
+ links: components["schemas"]["swag_paypal_v1_common_link"][];
8177
+ payer: components["schemas"]["swag_paypal_v1_payment_payer"];
8178
+ payment_instruction:
8179
+ | components["schemas"]["swag_paypal_v1_payment_payment_instruction"]
8180
+ | null;
8181
+ redirect_urls: components["schemas"]["swag_paypal_v1_payment_redirect_urls"];
8182
+ state: string;
8183
+ transactions: components["schemas"]["swag_paypal_v1_payment_transaction"][];
8184
+ update_time: string;
8185
+ };
8186
+ swag_paypal_v1_payment_application_context: {
8187
+ brand_name: string;
8188
+ /** @enum {string} */
8189
+ landing_page: "Login" | "Billing";
8190
+ locale: string;
8191
+ /** @default SET_PROVIDED_ADDRESS */
8192
+ shipping_preference?: string;
8193
+ /** @default commit */
8194
+ user_action?: string;
8195
+ };
8196
+ swag_paypal_v1_payment_payer: {
8197
+ external_selected_funding_instrument_type: string;
8198
+ payer_info: components["schemas"]["swag_paypal_v1_payment_payer_payer_info"];
8199
+ payment_method: string;
8200
+ status: string;
8201
+ };
8202
+ swag_paypal_v1_payment_payer_execute_payer_info: {
8203
+ payer_id: string;
8204
+ };
8205
+ swag_paypal_v1_payment_payer_payer_info: components["schemas"]["swag_paypal_v1_payment_payer_execute_payer_info"] & {
8206
+ billing_address:
8207
+ | components["schemas"]["swag_paypal_v1_common_address"]
8208
+ | null;
8209
+ country_code: string;
8210
+ email: string;
8211
+ first_name: string;
8212
+ last_name: string;
8213
+ phone: string;
8214
+ shipping_address: components["schemas"]["swag_paypal_v1_payment_transaction_item_list_shipping_address"];
8215
+ };
8216
+ swag_paypal_v1_payment_payment_instruction: {
8217
+ amount: components["schemas"]["swag_paypal_v1_common_value"];
8218
+ instruction_type: string;
8219
+ links: components["schemas"]["swag_paypal_v1_common_link"][];
8220
+ payment_due_date: string;
8221
+ recipient_banking_instruction: components["schemas"]["swag_paypal_v1_payment_payment_instruction_recipient_banking_instruction"];
8222
+ reference_number: string;
8223
+ };
8224
+ swag_paypal_v1_payment_payment_instruction_recipient_banking_instruction: {
8225
+ account_holder_name: string;
8226
+ bank_identifier_code: string;
8227
+ bank_name: string;
8228
+ international_bank_account_number: string;
8229
+ };
8230
+ swag_paypal_v1_payment_redirect_urls: {
8231
+ cancel_url: string;
8232
+ return_url: string;
8233
+ };
8234
+ swag_paypal_v1_payment_transaction: {
8235
+ amount: components["schemas"]["swag_paypal_v1_common_amount"];
8236
+ custom: string;
8237
+ description: string;
8238
+ invoice_number: string | null;
8239
+ item_list:
8240
+ | components["schemas"]["swag_paypal_v1_payment_transaction_item_list"]
8241
+ | null;
8242
+ payee: components["schemas"]["swag_paypal_v1_payment_transaction_payee"];
8243
+ related_resources: components["schemas"]["swag_paypal_v1_payment_transaction_related_resource"][];
8244
+ soft_descriptor: string;
8245
+ };
8246
+ swag_paypal_v1_payment_transaction_item_list: {
8247
+ items: components["schemas"]["swag_paypal_v1_payment_transaction_item_list_item"][];
8248
+ shipping_address: components["schemas"]["swag_paypal_v1_payment_transaction_item_list_shipping_address"];
8249
+ shipping_options: components["schemas"]["swag_paypal_v1_payment_transaction_item_list_shipping_option"][];
8250
+ shipping_phone_number: string;
8251
+ };
8252
+ swag_paypal_v1_payment_transaction_item_list_item: {
8253
+ currency: string;
8254
+ name: string;
8255
+ price: string;
8256
+ quantity: number;
8257
+ sku: string | null;
8258
+ tax: string;
8259
+ };
8260
+ swag_paypal_v1_payment_transaction_item_list_shipping_address: components["schemas"]["swag_paypal_v1_common_address"] & {
8261
+ recipient_name: string;
8262
+ };
8263
+ swag_paypal_v1_payment_transaction_item_list_shipping_option: unknown;
8264
+ swag_paypal_v1_payment_transaction_payee: {
8265
+ email: string;
8266
+ merchant_id: string;
8267
+ };
8268
+ swag_paypal_v1_payment_transaction_related_resource: {
8269
+ authorization:
8270
+ | components["schemas"]["swag_paypal_v1_payment_transaction_related_resource_authorization"]
8271
+ | null;
8272
+ capture:
8273
+ | components["schemas"]["swag_paypal_v1_payment_transaction_related_resource_capture"]
8274
+ | null;
8275
+ order:
8276
+ | components["schemas"]["swag_paypal_v1_payment_transaction_related_resource_order"]
8277
+ | null;
8278
+ refund:
8279
+ | components["schemas"]["swag_paypal_v1_payment_transaction_related_resource_refund"]
8280
+ | null;
8281
+ sale:
8282
+ | components["schemas"]["swag_paypal_v1_payment_transaction_related_resource_sale"]
8283
+ | null;
8284
+ };
8285
+ swag_paypal_v1_payment_transaction_related_resource_authorization: {
8286
+ amount: components["schemas"]["swag_paypal_v1_common_amount"];
8287
+ create_time: string;
8288
+ id: string;
8289
+ links: components["schemas"]["swag_paypal_v1_common_link"][];
8290
+ parent_payment: string;
8291
+ payment_mode: string;
8292
+ protection_eligibility: string;
8293
+ protection_eligibility_type: string;
8294
+ reason_code: string;
8295
+ receipt_id: string;
8296
+ state: string;
8297
+ update_time: string;
8298
+ valid_until: string;
8299
+ };
8300
+ swag_paypal_v1_payment_transaction_related_resource_capture: {
8301
+ amount: components["schemas"]["swag_paypal_v1_common_amount"];
8302
+ create_time: string;
8303
+ custom: string;
8304
+ id: string;
8305
+ invoice_number: string;
8306
+ links: components["schemas"]["swag_paypal_v1_common_link"][];
8307
+ parent_payment: string;
8308
+ payment_mode: string;
8309
+ protection_eligibility: string;
8310
+ protection_eligibility_type: string;
8311
+ receipt_id: string;
8312
+ state: string;
8313
+ transaction_fee: components["schemas"]["swag_paypal_v1_common_value"];
8314
+ update_time: string;
8315
+ };
8316
+ swag_paypal_v1_payment_transaction_related_resource_order: {
8317
+ amount: components["schemas"]["swag_paypal_v1_common_amount"];
8318
+ create_time: string;
8319
+ id: string;
8320
+ links: components["schemas"]["swag_paypal_v1_common_link"][];
8321
+ parent_payment: string;
8322
+ payment_mode: string;
8323
+ protection_eligibility: string;
8324
+ protection_eligibility_type: string;
8325
+ reason_code: string;
8326
+ receipt_id: string;
8327
+ state: string;
8328
+ update_time: string;
8329
+ };
8330
+ swag_paypal_v1_payment_transaction_related_resource_refund: {
8331
+ amount: components["schemas"]["swag_paypal_v1_common_amount"];
8332
+ capture_id: string;
8333
+ create_time: string;
8334
+ id: string;
8335
+ links: components["schemas"]["swag_paypal_v1_common_link"][];
8336
+ parent_payment: string;
8337
+ payment_mode: string;
8338
+ protection_eligibility: string;
8339
+ protection_eligibility_type: string;
8340
+ receipt_id: string;
8341
+ sale_id: string;
8342
+ state: string;
8343
+ update_time: string;
8344
+ };
8345
+ swag_paypal_v1_payment_transaction_related_resource_sale: {
8346
+ amount: components["schemas"]["swag_paypal_v1_common_amount"];
8347
+ create_time: string;
8348
+ id: string;
8349
+ links: components["schemas"]["swag_paypal_v1_common_link"][];
8350
+ parent_payment: string;
8351
+ payment_mode: string;
8352
+ protection_eligibility: string;
8353
+ protection_eligibility_type: string;
8354
+ receipt_id: string;
8355
+ state: string;
8356
+ transaction_fee: components["schemas"]["swag_paypal_v1_common_value"];
8357
+ update_time: string;
8358
+ };
8359
+ swag_paypal_v1_plan: {
8360
+ billing_cycles: components["schemas"]["swag_paypal_v1_plan_billing_cycle"][];
8361
+ description: string | null;
8362
+ name: string;
8363
+ payment_preferences: components["schemas"]["swag_paypal_v1_plan_payment_preferences"];
8364
+ product_id: string;
8365
+ status: string;
8366
+ taxes: components["schemas"]["swag_paypal_v1_plan_taxes"];
8367
+ };
8368
+ swag_paypal_v1_plan_billing_cycle: {
8369
+ frequency: components["schemas"]["swag_paypal_v1_plan_billing_cycle_frequency"];
8370
+ pricing_scheme: components["schemas"]["swag_paypal_v1_plan_billing_cycle_pricing_scheme"];
8371
+ sequence: number;
8372
+ tenure_type: string;
8373
+ total_cycles: number;
8374
+ };
8375
+ swag_paypal_v1_plan_billing_cycle_frequency: {
8376
+ interval_count: number;
8377
+ interval_unit: string;
8378
+ };
8379
+ swag_paypal_v1_plan_billing_cycle_pricing_scheme: {
8380
+ fixed_price: components["schemas"]["swag_paypal_v1_common_money"];
8381
+ };
8382
+ swag_paypal_v1_plan_payment_preferences: {
8383
+ auto_bill_outstanding: boolean;
8384
+ payment_failure_threshold: number;
8385
+ };
8386
+ swag_paypal_v1_plan_taxes: {
8387
+ inclusive: boolean;
8388
+ percentage: string;
8389
+ };
8390
+ swag_paypal_v1_product: {
8391
+ description: string;
8392
+ name: string;
8393
+ type: string;
8394
+ };
8395
+ swag_paypal_v1_refund: {
8396
+ amount: components["schemas"]["swag_paypal_v1_common_amount"];
8397
+ capture_id: string;
8398
+ create_time: string;
8399
+ description: string;
8400
+ id: string;
8401
+ invoice_number: string;
8402
+ links: components["schemas"]["swag_paypal_v1_common_link"][];
8403
+ parent_payment: string;
8404
+ reason: string;
8405
+ refund_from_received_amount: components["schemas"]["swag_paypal_v1_common_value"];
8406
+ refund_from_transaction_fee: components["schemas"]["swag_paypal_v1_common_value"];
8407
+ sale_id: string;
8408
+ state: string;
8409
+ total_refunded_amount: components["schemas"]["swag_paypal_v1_common_value"];
8410
+ update_time: string;
8411
+ };
8412
+ swag_paypal_v1_shipping: {
8413
+ trackers: components["schemas"]["swag_paypal_v1_shipping_tracker"][];
8414
+ };
8415
+ swag_paypal_v1_shipping_tracker: {
8416
+ carrier: string;
8417
+ notify_buyer: boolean;
8418
+ /** Pattern: '2022-08-15' */
8419
+ shipment_date: string;
8420
+ status: string;
8421
+ tracking_number: string;
8422
+ transaction_id: string;
8423
+ };
8424
+ swag_paypal_v1_subscription: {
8425
+ application_context: components["schemas"]["swag_paypal_v1_subscription_application_context"];
8426
+ billing_info:
8427
+ | components["schemas"]["swag_paypal_v1_subscription_billing_info"]
8428
+ | null;
8429
+ create_time: string;
8430
+ id: string;
8431
+ links: components["schemas"]["swag_paypal_v1_common_link"][];
8432
+ plan_id: string;
8433
+ quantity: string;
8434
+ shipping_amount: components["schemas"]["swag_paypal_v1_common_money"];
8435
+ start_time: string;
8436
+ status: string;
8437
+ status_update_time: string;
8438
+ subscriber: components["schemas"]["swag_paypal_v1_subscription_subscriber"];
8439
+ update_time: string;
8440
+ };
8441
+ swag_paypal_v1_subscription_application_context: {
8442
+ brand_name: string;
8443
+ cancel_url: string;
8444
+ locale: string;
8445
+ return_url: string;
8446
+ /** @default SET_PROVIDED_ADDRESS */
8447
+ shipping_preference?: string;
8448
+ /** @default SUBSCRIBE_NOW */
8449
+ user_action?: string;
8450
+ };
8451
+ swag_paypal_v1_subscription_billing_info: {
8452
+ cycle_executions: components["schemas"]["swag_paypal_v1_subscription_billing_info_cycle_execution"][];
8453
+ failed_payments_count: number;
8454
+ last_payment: components["schemas"]["swag_paypal_v1_subscription_billing_info_last_payment"];
8455
+ next_billing_time: string | null;
8456
+ outstanding_balance: components["schemas"]["swag_paypal_v1_subscription_billing_info_outstanding_balance"];
8457
+ };
8458
+ swag_paypal_v1_subscription_billing_info_cycle_execution: {
8459
+ cycles_completed: number;
8460
+ cycles_remaining: number;
8461
+ sequence: number;
8462
+ tenure_type: string;
8463
+ total_cycles: number;
8464
+ };
8465
+ swag_paypal_v1_subscription_billing_info_last_payment: {
8466
+ amount: components["schemas"]["swag_paypal_v1_common_money"];
8467
+ time: string;
8468
+ };
8469
+ swag_paypal_v1_subscription_billing_info_outstanding_balance: components["schemas"]["swag_paypal_v1_common_money"];
8470
+ swag_paypal_v1_subscription_subscriber: {
8471
+ email_address: string;
8472
+ name: components["schemas"]["swag_paypal_v1_subscription_subscriber_name"];
8473
+ payer_id: string;
8474
+ shipping_address:
8475
+ | components["schemas"]["swag_paypal_v1_subscription_subscriber_shipping_address"]
8476
+ | null;
8477
+ };
8478
+ swag_paypal_v1_subscription_subscriber_name: {
8479
+ given_name: string;
8480
+ surname: string;
8481
+ };
8482
+ swag_paypal_v1_subscription_subscriber_shipping_address: {
8483
+ address:
8484
+ | components["schemas"]["swag_paypal_v1_subscription_subscriber_shipping_address_address"]
8485
+ | null;
8486
+ name:
8487
+ | components["schemas"]["swag_paypal_v1_subscription_subscriber_shipping_address_name"]
8488
+ | null;
8489
+ };
8490
+ swag_paypal_v1_subscription_subscriber_shipping_address_address: {
8491
+ address_line_1: string | null;
8492
+ address_line_2: string | null;
8493
+ admin_area_1: string | null;
8494
+ admin_area_2: string | null;
8495
+ country_code: string;
8496
+ postal_code: string | null;
8497
+ };
8498
+ swag_paypal_v1_subscription_subscriber_shipping_address_name: {
8499
+ full_name: string;
8500
+ };
8501
+ swag_paypal_v1_token: {
8502
+ /** The access token issued by PayPal. After the access token
8503
+ * expires (see $expiresIn), you must request a new access token. */
8504
+ access_token: string;
8505
+ app_id: string;
8506
+ /**
8507
+ * Format: date-time
8508
+ * Calculated expiration date
8509
+ */
8510
+ expire_date_time: string;
8511
+ /** The lifetime of the access token, in seconds. */
8512
+ expires_in: number;
8513
+ id_token: string | null;
8514
+ nonce: string;
8515
+ /** Scopes expressed in the form of resource URL endpoints. The value of the scope parameter
8516
+ * is expressed as a list of space-delimited, case-sensitive strings. */
8517
+ scope: string;
8518
+ /** The type of the token issued as described in OAuth2.0 RFC6749,
8519
+ * Section 7.1. Value is case insensitive. */
8520
+ token_type: string;
8521
+ };
8522
+ swag_paypal_v1_webhook: {
8523
+ create_time: string;
8524
+ event_type: string;
8525
+ event_version: string;
8526
+ id: string;
8527
+ links: components["schemas"]["swag_paypal_v1_common_link"][];
8528
+ resource:
8529
+ | (
8530
+ | components["schemas"]["swag_paypal_v3_payment_token"]
8531
+ | components["schemas"]["swag_paypal_v2_order_purchase_unit_payments_authorization"]
8532
+ | components["schemas"]["swag_paypal_v2_order_purchase_unit_payments_capture"]
8533
+ | components["schemas"]["swag_paypal_v2_order_purchase_unit_payments_refund"]
8534
+ | components["schemas"]["swag_paypal_v1_webhook_resource"]
8535
+ | components["schemas"]["swag_paypal_v1_subscription"]
8536
+ )
8537
+ | null;
8538
+ resource_type: string;
8539
+ resource_version: string;
8540
+ summary: string;
8541
+ };
8542
+ swag_paypal_v1_webhook_resource: {
8543
+ amount: components["schemas"]["swag_paypal_v1_common_amount"];
8544
+ billing_agreement_id: string | null;
8545
+ clearing_time: string;
8546
+ create_time: string;
8547
+ id: string;
8548
+ invoice_number: string;
8549
+ links: components["schemas"]["swag_paypal_v1_common_link"][];
8550
+ merchant_id: string | null;
8551
+ parent_payment: string | null;
8552
+ payment_mode: string;
8553
+ protection_eligibility: string;
8554
+ protection_eligibility_type: string;
8555
+ refund_reason_code: string | null;
8556
+ sale_id: string | null;
8557
+ state: string;
8558
+ transaction_fee: components["schemas"]["swag_paypal_v1_common_value"];
8559
+ update_time: string;
8560
+ };
8561
+ swag_paypal_v2_common_address: {
8562
+ /** The first line of the address. For example, number or street. For example, 173 Drury Lane.
8563
+ * Required for data entry and compliance and risk checks. Must contain the full address. */
8564
+ address_line_1: string | null;
8565
+ /** The second line of the address. For example, suite or apartment number. */
8566
+ address_line_2: string | null;
8567
+ /** The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision.
8568
+ * Format for postal delivery. For example, CA and not California. */
8569
+ admin_area_1: string | null;
8570
+ /** A city, town, or village. Smaller than $adminArea1 */
8571
+ admin_area_2: string | null;
8572
+ country_code: string;
8573
+ postal_code: string | null;
8574
+ };
8575
+ swag_paypal_v2_common_link: {
8576
+ enc_type: string | null;
8577
+ href: string;
8578
+ method: string;
8579
+ rel: string;
8580
+ };
8581
+ swag_paypal_v2_common_money: {
8582
+ currency_code: string;
8583
+ value: string;
8584
+ };
8585
+ swag_paypal_v2_common_name: {
8586
+ given_name: string;
8587
+ surname: string;
8588
+ };
8589
+ swag_paypal_v2_common_phone_number: {
8590
+ country_code: string;
8591
+ national_number: string;
8592
+ };
8593
+ swag_paypal_v2_order: {
8594
+ application_context: components["schemas"]["swag_paypal_v2_order_application_context"];
8595
+ create_time: string;
8596
+ id: string;
8597
+ intent: string;
8598
+ links: components["schemas"]["swag_paypal_v2_common_link"][];
8599
+ payer: components["schemas"]["swag_paypal_v2_order_payer"];
8600
+ payment_source:
8601
+ | components["schemas"]["swag_paypal_v2_order_payment_source"]
8602
+ | null;
8603
+ processing_instruction: string;
8604
+ purchase_units:
8605
+ | components["schemas"]["swag_paypal_v2_order_purchase_unit"][]
8606
+ | null;
8607
+ status: string;
8608
+ update_time: string;
8609
+ };
8610
+ swag_paypal_v2_order_application_context: {
8611
+ brand_name: string;
8612
+ cancel_url: string;
8613
+ /**
8614
+ * @default NO_PREFERENCE
8615
+ * @enum {string}
8616
+ */
8617
+ landing_page?: "LOGIN" | "BILLING" | "NO_PREFERENCE";
8618
+ return_url: string;
8619
+ /**
8620
+ * @default SET_PROVIDED_ADDRESS
8621
+ * @enum {string}
8622
+ */
8623
+ shipping_preference?:
8624
+ | "SET_PROVIDED_ADDRESS"
8625
+ | "NO_SHIPPING"
8626
+ | "GET_FROM_FILE";
8627
+ /**
8628
+ * @default PAY_NOW
8629
+ * @enum {string}
8630
+ */
8631
+ user_action?: "CONTINUE" | "PAY_NOW";
8632
+ };
8633
+ swag_paypal_v2_order_payer: {
8634
+ address: components["schemas"]["swag_paypal_v2_common_address"];
8635
+ email_address: string;
8636
+ name: components["schemas"]["swag_paypal_v2_common_name"];
8637
+ payer_id: string;
8638
+ phone:
8639
+ | components["schemas"]["swag_paypal_v2_order_payment_source_common_phone"]
8640
+ | null;
8641
+ };
8642
+ swag_paypal_v2_order_payment_source: {
8643
+ apple_pay: components["schemas"]["swag_paypal_v2_order_payment_source_apple_pay"];
8644
+ bancontact:
8645
+ | components["schemas"]["swag_paypal_v2_order_payment_source_bancontact"]
8646
+ | null;
8647
+ blik:
8648
+ | components["schemas"]["swag_paypal_v2_order_payment_source_blik"]
8649
+ | null;
8650
+ boletobancario:
8651
+ | components["schemas"]["swag_paypal_v2_order_payment_source_boletobancario"]
8652
+ | null;
8653
+ card:
8654
+ | components["schemas"]["swag_paypal_v2_order_payment_source_card"]
8655
+ | null;
8656
+ eps:
8657
+ | components["schemas"]["swag_paypal_v2_order_payment_source_eps"]
8658
+ | null;
8659
+ giropay:
8660
+ | components["schemas"]["swag_paypal_v2_order_payment_source_giropay"]
8661
+ | null;
8662
+ google_pay:
8663
+ | components["schemas"]["swag_paypal_v2_order_payment_source_google_pay"]
8664
+ | null;
8665
+ ideal:
8666
+ | components["schemas"]["swag_paypal_v2_order_payment_source_ideal"]
8667
+ | null;
8668
+ multibanco:
8669
+ | components["schemas"]["swag_paypal_v2_order_payment_source_multibanco"]
8670
+ | null;
8671
+ my_bank:
8672
+ | components["schemas"]["swag_paypal_v2_order_payment_source_my_bank"]
8673
+ | null;
8674
+ oxxo:
8675
+ | components["schemas"]["swag_paypal_v2_order_payment_source_oxxo"]
8676
+ | null;
8677
+ p24:
8678
+ | components["schemas"]["swag_paypal_v2_order_payment_source_p24"]
8679
+ | null;
8680
+ pay_upon_invoice:
8681
+ | components["schemas"]["swag_paypal_v2_order_payment_source_pay_upon_invoice"]
8682
+ | null;
8683
+ paypal:
8684
+ | components["schemas"]["swag_paypal_v2_order_payment_source_paypal"]
8685
+ | null;
8686
+ sofort:
8687
+ | components["schemas"]["swag_paypal_v2_order_payment_source_sofort"]
8688
+ | null;
8689
+ token:
8690
+ | components["schemas"]["swag_paypal_v2_order_payment_source_token"]
8691
+ | null;
8692
+ trustly:
8693
+ | components["schemas"]["swag_paypal_v2_order_payment_source_trustly"]
8694
+ | null;
8695
+ venmo:
8696
+ | components["schemas"]["swag_paypal_v2_order_payment_source_venmo"]
8697
+ | null;
8698
+ };
8699
+ swag_paypal_v2_order_payment_source_apple_pay: {
8700
+ attributes:
8701
+ | components["schemas"]["swag_paypal_v2_order_payment_source_common_attributes"]
8702
+ | null;
8703
+ card:
8704
+ | components["schemas"]["swag_paypal_v2_order_payment_source_card"]
8705
+ | null;
8706
+ country_code: string;
8707
+ experience_context: components["schemas"]["swag_paypal_v2_order_payment_source_common_experience_context"];
8708
+ name: string;
8709
+ };
8710
+ swag_paypal_v2_order_payment_source_bancontact: {
8711
+ country_code: string;
8712
+ experience_context: components["schemas"]["swag_paypal_v2_order_payment_source_common_experience_context"];
8713
+ name: string;
8714
+ };
8715
+ swag_paypal_v2_order_payment_source_blik: {
8716
+ country_code: string;
8717
+ email: string;
8718
+ experience_context: components["schemas"]["swag_paypal_v2_order_payment_source_common_experience_context"];
8719
+ name: string;
8720
+ };
8721
+ swag_paypal_v2_order_payment_source_boletobancario: {
8722
+ billing_address: components["schemas"]["swag_paypal_v2_common_address"];
8723
+ country_code: string;
8724
+ email: string;
8725
+ experience_context: components["schemas"]["swag_paypal_v2_order_payment_source_common_experience_context"];
8726
+ expiry_date: string;
8727
+ name: string;
8728
+ tax_info: components["schemas"]["swag_paypal_v2_order_payment_source_boletobancario_tax_info"];
8729
+ };
8730
+ swag_paypal_v2_order_payment_source_boletobancario_tax_info: {
8731
+ tax_id: string;
8732
+ tax_id_type: string;
8733
+ };
8734
+ swag_paypal_v2_order_payment_source_card: {
8735
+ attributes:
8736
+ | components["schemas"]["swag_paypal_v2_order_payment_source_common_attributes"]
8737
+ | null;
8738
+ authentication_result:
8739
+ | components["schemas"]["swag_paypal_v2_order_payment_source_card_authentication_result"]
8740
+ | null;
8741
+ billing_address:
8742
+ | components["schemas"]["swag_paypal_v2_common_address"]
8743
+ | null;
8744
+ brand: string;
8745
+ country_code: string;
8746
+ experience_context: components["schemas"]["swag_paypal_v2_order_payment_source_common_experience_context"];
8747
+ last_digits: string;
8748
+ name: string;
8749
+ stored_credential:
8750
+ | components["schemas"]["swag_paypal_v2_order_payment_source_card_stored_credential"]
8751
+ | null;
8752
+ type: string;
8753
+ vault_id: string;
8754
+ };
8755
+ swag_paypal_v2_order_payment_source_card_authentication_result: {
8756
+ liability_shift: string;
8757
+ three_d_secure:
8758
+ | components["schemas"]["swag_paypal_v2_order_payment_source_card_authentication_result_3d_secure"]
8759
+ | null;
8760
+ };
8761
+ swag_paypal_v2_order_payment_source_card_authentication_result_3d_secure: {
8762
+ authentication_status: string;
8763
+ enrollment_status: string;
8764
+ };
8765
+ swag_paypal_v2_order_payment_source_card_stored_credential: {
8766
+ /** @enum {string} */
8767
+ payment_initiator: "MERCHANT" | "CUSTOMER";
8768
+ /** @enum {string} */
8769
+ payment_type: "RECURRING" | "ONE_TIME" | "UNSCHEDULED";
8770
+ previous_network_transaction_reference: string;
8771
+ /** @enum {string} */
8772
+ usage: "DERIVED" | "FIRST" | "SUBSEQUENT";
8773
+ };
8774
+ swag_paypal_v2_order_payment_source_common_attributes: {
8775
+ customer: components["schemas"]["swag_paypal_v2_order_payment_source_common_attributes_customer"];
8776
+ vault: components["schemas"]["swag_paypal_v2_order_payment_source_common_attributes_vault"];
8777
+ verification: components["schemas"]["swag_paypal_v2_order_payment_source_common_attributes_verification"];
8778
+ };
8779
+ swag_paypal_v2_order_payment_source_common_attributes_customer: {
8780
+ id: string;
8781
+ };
8782
+ swag_paypal_v2_order_payment_source_common_attributes_vault: {
8783
+ confirm_payment_token: string;
8784
+ customer:
8785
+ | components["schemas"]["swag_paypal_v2_order_payment_source_common_attributes_customer"]
8786
+ | null;
8787
+ id: string | null;
8788
+ links: components["schemas"]["swag_paypal_v2_common_link"][];
8789
+ permit_multiple_payment_tokens: boolean;
8790
+ status: string;
8791
+ store_in_vault: string;
8792
+ usage_type: string;
8793
+ };
8794
+ swag_paypal_v2_order_payment_source_common_attributes_verification: {
8795
+ method: string;
8796
+ };
8797
+ swag_paypal_v2_order_payment_source_common_experience_context: {
8798
+ brand_name: string;
8799
+ cancel_url: string;
8800
+ /** Only: PUI */
8801
+ customer_service_instructions: string[];
8802
+ /**
8803
+ * @default NO_PREFERENCE
8804
+ * @enum {string}
8805
+ */
8806
+ landing_page?: "LOGIN" | "GUEST_CHECKOUT" | "NO_PREFERENCE";
8807
+ locale: string;
8808
+ logo_url: string;
8809
+ /**
8810
+ * Only: PayPal Wallet
8811
+ * @enum {string}
8812
+ */
8813
+ payment_method_preference: "UNRESTRICTED" | "IMMEDIATE_PAYMENT_REQUIRED";
8814
+ return_url: string;
8815
+ /**
8816
+ * @default SET_PROVIDED_ADDRESS
8817
+ * @enum {string}
8818
+ */
8819
+ shipping_preference?:
8820
+ | "SET_PROVIDED_ADDRESS"
8821
+ | "NO_SHIPPING"
8822
+ | "GET_FROM_FILE";
8823
+ /**
8824
+ * @default PAY_NOW
8825
+ * @enum {string}
8826
+ */
8827
+ user_action?: "CONTINUE" | "PAY_NOW";
8828
+ };
8829
+ swag_paypal_v2_order_payment_source_common_phone: {
8830
+ phone_number: components["schemas"]["swag_paypal_v2_common_phone_number"];
8831
+ phone_type: string;
8832
+ };
8833
+ swag_paypal_v2_order_payment_source_eps: {
8834
+ country_code: string;
8835
+ experience_context: components["schemas"]["swag_paypal_v2_order_payment_source_common_experience_context"];
8836
+ name: string;
8837
+ };
8838
+ swag_paypal_v2_order_payment_source_giropay: {
8839
+ country_code: string;
8840
+ experience_context: components["schemas"]["swag_paypal_v2_order_payment_source_common_experience_context"];
8841
+ name: string;
8842
+ };
8843
+ swag_paypal_v2_order_payment_source_google_pay: {
8844
+ attributes:
8845
+ | components["schemas"]["swag_paypal_v2_order_payment_source_common_attributes"]
8846
+ | null;
8847
+ card:
8848
+ | components["schemas"]["swag_paypal_v2_order_payment_source_card"]
8849
+ | null;
8850
+ experience_context: components["schemas"]["swag_paypal_v2_order_payment_source_common_experience_context"];
8851
+ };
8852
+ swag_paypal_v2_order_payment_source_ideal: {
8853
+ country_code: string;
8854
+ experience_context: components["schemas"]["swag_paypal_v2_order_payment_source_common_experience_context"];
8855
+ name: string;
8856
+ };
8857
+ swag_paypal_v2_order_payment_source_multibanco: {
8858
+ country_code: string;
8859
+ experience_context: components["schemas"]["swag_paypal_v2_order_payment_source_common_experience_context"];
8860
+ name: string;
8861
+ };
8862
+ swag_paypal_v2_order_payment_source_my_bank: {
8863
+ country_code: string;
8864
+ experience_context: components["schemas"]["swag_paypal_v2_order_payment_source_common_experience_context"];
8865
+ name: string;
8866
+ };
8867
+ swag_paypal_v2_order_payment_source_oxxo: {
8868
+ country_code: string;
8869
+ email: string;
8870
+ experience_context: components["schemas"]["swag_paypal_v2_order_payment_source_common_experience_context"];
8871
+ name: string;
8872
+ };
8873
+ swag_paypal_v2_order_payment_source_p24: {
8874
+ country_code: string;
8875
+ email: string;
8876
+ experience_context: components["schemas"]["swag_paypal_v2_order_payment_source_common_experience_context"];
8877
+ name: string;
8878
+ };
8879
+ swag_paypal_v2_order_payment_source_pay_upon_invoice: {
8880
+ billing_address: components["schemas"]["swag_paypal_v2_common_address"];
8881
+ birth_date: string;
8882
+ deposit_bank_details: components["schemas"]["swag_paypal_v2_order_payment_source_pay_upon_invoice_deposit_bank_details"];
8883
+ email: string;
8884
+ experience_context: components["schemas"]["swag_paypal_v2_order_payment_source_common_experience_context"];
8885
+ name: components["schemas"]["swag_paypal_v2_common_name"];
8886
+ payment_reference: string;
8887
+ phone: components["schemas"]["swag_paypal_v2_common_phone_number"];
8888
+ };
8889
+ swag_paypal_v2_order_payment_source_pay_upon_invoice_deposit_bank_details: {
8890
+ account_holder_name: string;
8891
+ bank_name: string;
8892
+ bic: string;
8893
+ iban: string;
8894
+ };
8895
+ swag_paypal_v2_order_payment_source_paypal: {
8896
+ account_id: string;
8897
+ address: components["schemas"]["swag_paypal_v2_common_address"];
8898
+ attributes:
8899
+ | components["schemas"]["swag_paypal_v2_order_payment_source_common_attributes"]
8900
+ | null;
8901
+ billing_agreement_id: string;
8902
+ birth_date: string;
8903
+ email_address: string;
8904
+ experience_context: components["schemas"]["swag_paypal_v2_order_payment_source_common_experience_context"];
8905
+ name: components["schemas"]["swag_paypal_v2_common_name"];
8906
+ phone_number:
8907
+ | components["schemas"]["swag_paypal_v2_common_phone_number"]
8908
+ | null;
8909
+ phone_type: string;
8910
+ vault_id: string;
8911
+ };
8912
+ swag_paypal_v2_order_payment_source_sofort: {
8913
+ country_code: string;
8914
+ experience_context: components["schemas"]["swag_paypal_v2_order_payment_source_common_experience_context"];
8915
+ name: string;
8916
+ };
8917
+ swag_paypal_v2_order_payment_source_token: {
8918
+ experience_context: components["schemas"]["swag_paypal_v2_order_payment_source_common_experience_context"];
8919
+ id: string;
8920
+ stored_payment_source: components["schemas"]["swag_paypal_v2_order_payment_source_token_stored_payment_source"];
8921
+ type: string;
8922
+ };
8923
+ swag_paypal_v2_order_payment_source_token_stored_payment_source: {
8924
+ payment_initiator: string;
8925
+ payment_type: string;
8926
+ usage: string;
8927
+ };
8928
+ swag_paypal_v2_order_payment_source_trustly: {
8929
+ country_code: string;
8930
+ experience_context: components["schemas"]["swag_paypal_v2_order_payment_source_common_experience_context"];
8931
+ name: string;
8932
+ };
8933
+ swag_paypal_v2_order_payment_source_venmo: {
8934
+ account_id: string;
8935
+ address: components["schemas"]["swag_paypal_v2_common_address"];
8936
+ attributes:
8937
+ | components["schemas"]["swag_paypal_v2_order_payment_source_common_attributes"]
8938
+ | null;
8939
+ email_address: string;
8940
+ experience_context: components["schemas"]["swag_paypal_v2_order_payment_source_common_experience_context"];
8941
+ name: components["schemas"]["swag_paypal_v2_common_name"];
8942
+ phone_number:
8943
+ | components["schemas"]["swag_paypal_v2_common_phone_number"]
8944
+ | null;
8945
+ user_name: string;
8946
+ vault_id: string;
8947
+ };
8948
+ swag_paypal_v2_order_purchase_unit: {
8949
+ amount: components["schemas"]["swag_paypal_v2_order_purchase_unit_amount"];
8950
+ custom_id: string | null;
8951
+ description: string;
8952
+ invoice_id: string | null;
8953
+ items:
8954
+ | components["schemas"]["swag_paypal_v2_order_purchase_unit_item"][]
8955
+ | null;
8956
+ payee: components["schemas"]["swag_paypal_v2_order_purchase_unit_payee"];
8957
+ payments:
8958
+ | components["schemas"]["swag_paypal_v2_order_purchase_unit_payments"]
8959
+ | null;
8960
+ reference_id: string;
8961
+ shipping: components["schemas"]["swag_paypal_v2_order_purchase_unit_shipping"];
8962
+ };
8963
+ swag_paypal_v2_order_purchase_unit_amount: components["schemas"]["swag_paypal_v2_common_money"] & {
8964
+ breakdown:
8965
+ | components["schemas"]["swag_paypal_v2_order_purchase_unit_amount_breakdown"]
8966
+ | null;
8967
+ };
8968
+ swag_paypal_v2_order_purchase_unit_amount_breakdown: {
8969
+ discount: components["schemas"]["swag_paypal_v2_common_money"];
8970
+ handling: components["schemas"]["swag_paypal_v2_common_money"];
8971
+ insurance: components["schemas"]["swag_paypal_v2_common_money"];
8972
+ item_total: components["schemas"]["swag_paypal_v2_common_money"];
8973
+ shipping: components["schemas"]["swag_paypal_v2_common_money"];
8974
+ shipping_discount: components["schemas"]["swag_paypal_v2_common_money"];
8975
+ tax_total: components["schemas"]["swag_paypal_v2_common_money"] | null;
8976
+ };
8977
+ swag_paypal_v2_order_purchase_unit_item: {
8978
+ /** @enum {string} */
8979
+ category: "PHYSICAL_GOODS" | "DIGITAL_GOODS" | "DONATION";
8980
+ name: string;
8981
+ quantity: number;
8982
+ sku: string | null;
8983
+ tax: components["schemas"]["swag_paypal_v2_common_money"];
8984
+ tax_rate: string | number | Record<string, never>;
8985
+ unit_amount: components["schemas"]["swag_paypal_v2_common_money"];
8986
+ };
8987
+ swag_paypal_v2_order_purchase_unit_payee: {
8988
+ display_data: components["schemas"]["swag_paypal_v2_order_purchase_unit_payee_display_data"];
8989
+ email_address: string;
8990
+ merchant_id: string;
8991
+ };
8992
+ swag_paypal_v2_order_purchase_unit_payee_display_data: {
8993
+ brand_name: string;
8994
+ };
8995
+ swag_paypal_v2_order_purchase_unit_payments: {
8996
+ authorizations:
8997
+ | components["schemas"]["swag_paypal_v2_order_purchase_unit_payments_authorization"][]
8998
+ | null;
8999
+ captures:
9000
+ | components["schemas"]["swag_paypal_v2_order_purchase_unit_payments_capture"][]
9001
+ | null;
9002
+ refunds:
9003
+ | components["schemas"]["swag_paypal_v2_order_purchase_unit_payments_refund"][]
9004
+ | null;
9005
+ };
9006
+ swag_paypal_v2_order_purchase_unit_payments_authorization: {
9007
+ amount: components["schemas"]["swag_paypal_v2_common_money"] | null;
9008
+ create_time: string;
9009
+ custom_id: string | null;
9010
+ expiration_time: string;
9011
+ id: string;
9012
+ links: components["schemas"]["swag_paypal_v2_common_link"][];
9013
+ seller_protection: components["schemas"]["swag_paypal_v2_order_purchase_unit_payments_common_seller_protection"];
9014
+ status: string;
9015
+ update_time: string;
9016
+ };
9017
+ swag_paypal_v2_order_purchase_unit_payments_authorization_seller_protection: {
9018
+ dispute_categories: string[];
9019
+ status: string;
9020
+ };
9021
+ swag_paypal_v2_order_purchase_unit_payments_capture: {
9022
+ amount: components["schemas"]["swag_paypal_v2_common_money"] | null;
9023
+ create_time: string;
9024
+ custom_id: string | null;
9025
+ disbursement_mode: string;
9026
+ final_capture: boolean;
9027
+ id: string;
9028
+ invoice_id: string | null;
9029
+ links: components["schemas"]["swag_paypal_v2_common_link"][];
9030
+ note_to_payer: string | null;
9031
+ processor_response: components["schemas"]["swag_paypal_v2_order_purchase_unit_payments_capture_processor_response"];
9032
+ seller_protection: components["schemas"]["swag_paypal_v2_order_purchase_unit_payments_common_seller_protection"];
9033
+ seller_receivable_breakdown: components["schemas"]["swag_paypal_v2_order_purchase_unit_payments_capture_seller_receivable_breakdown"];
9034
+ status: string;
9035
+ update_time: string;
9036
+ };
9037
+ swag_paypal_v2_order_purchase_unit_payments_capture_processor_response: {
9038
+ avs_code: string | null;
9039
+ cvv_code: string | null;
9040
+ response_code: string | null;
9041
+ };
9042
+ swag_paypal_v2_order_purchase_unit_payments_capture_seller_receivable_breakdown: {
9043
+ gross_amount: components["schemas"]["swag_paypal_v2_common_money"];
9044
+ net_amount: components["schemas"]["swag_paypal_v2_common_money"];
9045
+ paypal_fee: components["schemas"]["swag_paypal_v2_common_money"];
9046
+ };
9047
+ swag_paypal_v2_order_purchase_unit_payments_common_seller_protection: {
9048
+ dispute_categories: string[];
9049
+ status: string;
9050
+ };
9051
+ swag_paypal_v2_order_purchase_unit_payments_refund: {
9052
+ amount: components["schemas"]["swag_paypal_v2_common_money"] | null;
9053
+ create_time: string;
9054
+ custom_id: string | null;
9055
+ id: string;
9056
+ invoice_id: string | null;
9057
+ links: components["schemas"]["swag_paypal_v2_common_link"][];
9058
+ note_to_payer: string | null;
9059
+ seller_payable_breakdown: components["schemas"]["swag_paypal_v2_order_purchase_unit_payments_refund_seller_payable_breakdown"];
9060
+ status: string;
9061
+ update_time: string;
9062
+ };
9063
+ swag_paypal_v2_order_purchase_unit_payments_refund_seller_payable_breakdown: {
9064
+ gross_amount: components["schemas"]["swag_paypal_v2_common_money"];
9065
+ net_amount: components["schemas"]["swag_paypal_v2_common_money"];
9066
+ paypal_fee: components["schemas"]["swag_paypal_v2_common_money"];
9067
+ total_refunded_amount: components["schemas"]["swag_paypal_v2_common_money"];
9068
+ };
9069
+ swag_paypal_v2_order_purchase_unit_shipping: {
9070
+ address: components["schemas"]["swag_paypal_v2_common_address"];
9071
+ name: components["schemas"]["swag_paypal_v2_order_purchase_unit_shipping_name"];
9072
+ trackers:
9073
+ | components["schemas"]["swag_paypal_v2_order_purchase_unit_shipping_tracker"][]
9074
+ | null;
9075
+ };
9076
+ swag_paypal_v2_order_purchase_unit_shipping_name: {
9077
+ full_name: string;
9078
+ };
9079
+ swag_paypal_v2_order_purchase_unit_shipping_tracker: {
9080
+ id: string;
9081
+ items: components["schemas"]["swag_paypal_v2_order_purchase_unit_item"][];
9082
+ links: components["schemas"]["swag_paypal_v2_common_link"][];
9083
+ notify_payer: boolean;
9084
+ status: string;
9085
+ };
9086
+ swag_paypal_v2_order_purchase_unit_shipping_tracker_item: {
9087
+ image_url: string | null;
9088
+ name: string;
9089
+ quantity: number;
9090
+ sku: string | null;
9091
+ url: string | null;
9092
+ };
9093
+ swag_paypal_v2_order_tracker: {
9094
+ capture_id: string;
9095
+ carrier: string;
9096
+ carrier_name_other: string | null;
9097
+ items: components["schemas"]["swag_paypal_v2_order_purchase_unit_shipping_tracker_item"][];
9098
+ /** @default false */
9099
+ notify_payer?: boolean;
9100
+ tracking_number: string;
9101
+ };
9102
+ swag_paypal_v2_patch: {
9103
+ from: string;
9104
+ op: string;
9105
+ path: string;
9106
+ value:
9107
+ | (
9108
+ | number
9109
+ | Record<string, never>
9110
+ | string
9111
+ | boolean
9112
+ | Record<string, never>[]
9113
+ )
9114
+ | null;
9115
+ };
9116
+ swag_paypal_v2_referral: {
9117
+ business_entity: components["schemas"]["swag_paypal_v2_referral_business_entity"];
9118
+ capabilities: string[];
9119
+ legal_consents: components["schemas"]["swag_paypal_v2_referral_legal_consent"][];
9120
+ links: components["schemas"]["swag_paypal_v2_common_link"][];
9121
+ operations: components["schemas"]["swag_paypal_v2_referral_operation"][];
9122
+ partner_config_override: components["schemas"]["swag_paypal_v2_referral_partner_config_override"];
9123
+ preferred_language_code: string;
9124
+ products: string[];
9125
+ tracking_id: string;
9126
+ };
9127
+ swag_paypal_v2_referral_business_entity: {
9128
+ addresses: components["schemas"]["swag_paypal_v2_referral_business_entity_address"][];
9129
+ };
9130
+ swag_paypal_v2_referral_business_entity_address: {
9131
+ country_code: string;
9132
+ /** @default WORK */
9133
+ type?: string;
9134
+ };
9135
+ swag_paypal_v2_referral_legal_consent: {
9136
+ granted: boolean;
9137
+ /** @default SHARE_DATA_CONSENT */
9138
+ type?: string;
9139
+ };
9140
+ swag_paypal_v2_referral_operation: {
9141
+ api_integration_preference: components["schemas"]["swag_paypal_v2_referral_operation_integration_preference"];
9142
+ /** @default API_INTEGRATION */
9143
+ operation?: string;
9144
+ };
9145
+ swag_paypal_v2_referral_operation_integration_preference: {
9146
+ rest_api_integration: components["schemas"]["swag_paypal_v2_referral_operation_integration_preference_integration"];
9147
+ };
9148
+ swag_paypal_v2_referral_operation_integration_preference_integration: {
9149
+ /** @default PAYPAL */
9150
+ integration_method?: string;
9151
+ /** @default THIRD_PARTY */
9152
+ integration_type?: string;
9153
+ third_party_details: components["schemas"]["swag_paypal_v2_referral_operation_integration_preference_integration_third_party_details"];
9154
+ };
9155
+ swag_paypal_v2_referral_operation_integration_preference_integration_third_party_details: {
9156
+ features: string[];
9157
+ };
9158
+ swag_paypal_v2_referral_partner_config_override: {
9159
+ partner_logo_url: string;
9160
+ return_url: string;
9161
+ };
9162
+ swag_paypal_v3_payment_token: {
9163
+ customer: components["schemas"]["swag_paypal_v2_order_payment_source_common_attributes_customer"];
9164
+ id: string;
9165
+ links: components["schemas"]["swag_paypal_v2_common_link"][];
9166
+ metadata:
9167
+ | components["schemas"]["swag_paypal_v3_payment_token_metadata"]
9168
+ | null;
9169
+ payment_source: components["schemas"]["swag_paypal_v2_order_payment_source"];
9170
+ status: string;
9171
+ };
9172
+ swag_paypal_v3_payment_token_metadata: {
9173
+ order_id: string;
9174
+ };
7371
9175
  };
7372
9176
  export type operations = {
7373
9177
  "api-info get /_info/openapi3.json": {
@@ -7560,7 +9364,7 @@ export type operations = {
7560
9364
  /** Customer last name. Value will be reused for shipping and billing address if not provided explicitly. */
7561
9365
  lastName: string;
7562
9366
  /** Id of the salutation for the customer account. Fetch options using `salutation` endpoint. */
7563
- salutationId: string;
9367
+ salutationId?: string;
7564
9368
  /** (Academic) title of the customer */
7565
9369
  title?: string;
7566
9370
  } & (
@@ -7585,6 +9389,27 @@ export type operations = {
7585
9389
  /** VAT IDs of the customer's company. Only valid when `accountType` is `business`. */
7586
9390
  vatIds: [string, ...string[]];
7587
9391
  }
9392
+ | {
9393
+ /**
9394
+ * Type of the customer account. Default value is 'private'.
9395
+ * @default private
9396
+ * @enum {string}
9397
+ */
9398
+ accountType?: "private";
9399
+ company?: null;
9400
+ vatIds?: null;
9401
+ }
9402
+ | {
9403
+ /**
9404
+ * Type of the customer account. Can be `private` or `business`.
9405
+ * @enum {string}
9406
+ */
9407
+ accountType: "business";
9408
+ /** Company of the customer. Only required when `accountType` is `business`. */
9409
+ company: string;
9410
+ /** VAT IDs of the customer's company. Only valid when `accountType` is `business`. */
9411
+ vatIds: [string, ...string[]];
9412
+ }
7588
9413
  );
7589
9414
  response: components["schemas"]["SuccessResponse"];
7590
9415
  responseCode: 200;
@@ -7732,7 +9557,7 @@ export type operations = {
7732
9557
  /** Password for the customer. Required, unless `guest` is `true` */
7733
9558
  password: string;
7734
9559
  /** Id of the salutation for the customer account. Fetch options using `salutation` endpoint. */
7735
- salutationId: string;
9560
+ salutationId?: string;
7736
9561
  shippingAddress?: components["schemas"]["CustomerAddress"];
7737
9562
  /** URL of the storefront for that registration. Used in confirmation emails. Has to be one of the configured domains of the sales channel. */
7738
9563
  storefrontUrl: string;
@@ -7760,6 +9585,27 @@ export type operations = {
7760
9585
  /** VAT IDs of the customer's company. Only valid when `accountType` is `business`. */
7761
9586
  vatIds: [string, ...string[]];
7762
9587
  }
9588
+ | {
9589
+ /**
9590
+ * Type of the customer account. Default value is 'private'.
9591
+ * @default private
9592
+ * @enum {string}
9593
+ */
9594
+ accountType?: "private";
9595
+ company?: null;
9596
+ vatIds?: null;
9597
+ }
9598
+ | {
9599
+ /**
9600
+ * Type of the customer account. Can be `private` or `business`.
9601
+ * @enum {string}
9602
+ */
9603
+ accountType: "business";
9604
+ /** Company of the customer. Only required when `accountType` is `business`. */
9605
+ company: string;
9606
+ /** VAT IDs of the customer's company. Only valid when `accountType` is `business`. */
9607
+ vatIds: [string, ...string[]];
9608
+ }
7763
9609
  );
7764
9610
  response: components["schemas"]["Customer"];
7765
9611
  responseCode: 200;
@@ -7776,158 +9622,6 @@ export type operations = {
7776
9622
  response: never;
7777
9623
  responseCode: 200;
7778
9624
  };
7779
- "createShoppingList post /account/shopping-list": {
7780
- contentType?: "application/json";
7781
- accept?: "application/json";
7782
- body: {
7783
- lineItems?: {
7784
- [key: string]: {
7785
- /** Product id */
7786
- id: string;
7787
- /** Quantity of the product */
7788
- quantity: number;
7789
- };
7790
- };
7791
- /** Shopping list name */
7792
- name: string;
7793
- };
7794
- response: never;
7795
- responseCode: 204;
7796
- };
7797
- "removeShoppingLists delete /account/shopping-list": {
7798
- contentType?: "application/json";
7799
- accept?: "application/json";
7800
- body: {
7801
- /** Shopping list ids */
7802
- ids: string[];
7803
- };
7804
- response: never;
7805
- responseCode: 204;
7806
- };
7807
- "readShoppingList post /account/shopping-list/{id}": {
7808
- contentType?: "application/json";
7809
- accept?: "application/json";
7810
- pathParams: {
7811
- /** Identifier of the shopping list to be fetched */
7812
- id: string;
7813
- };
7814
- response: components["schemas"]["B2bComponentsShoppingList"];
7815
- responseCode: 200;
7816
- };
7817
- "updateShoppingList patch /account/shopping-list/{id}/change-name": {
7818
- contentType?: "application/json";
7819
- accept?: "application/json";
7820
- pathParams: {
7821
- /** Identifier of the shopping list to be fetched */
7822
- id: string;
7823
- };
7824
- body: {
7825
- /** Shopping list name */
7826
- name: string;
7827
- };
7828
- response: never;
7829
- responseCode: 204;
7830
- };
7831
- "duplicateShoppingList post /account/shopping-list/{id}/duplicate": {
7832
- contentType?: "application/json";
7833
- accept?: "application/json";
7834
- pathParams: {
7835
- /** Identifier of the shopping list to be fetched */
7836
- id: string;
7837
- };
7838
- body: {
7839
- /** Shopping list name */
7840
- name: string;
7841
- };
7842
- response: {
7843
- /** The generated id of the duplicated shopping list */
7844
- id?: string;
7845
- };
7846
- responseCode: 200;
7847
- };
7848
- "summaryShoppingList get /account/shopping-list/{id}/summary": {
7849
- contentType?: "application/json";
7850
- accept?: "application/json";
7851
- pathParams: {
7852
- /** Identifier of the shopping list to be fetched */
7853
- id: string;
7854
- };
7855
- response: {
7856
- price?: {
7857
- /**
7858
- * Format: float
7859
- * Net price of the cart
7860
- */
7861
- netPrice?: number;
7862
- /**
7863
- * Format: float
7864
- * Price for all line items in the cart
7865
- */
7866
- positionPrice?: number;
7867
- /** Tax calculation for the cart. One of `gross`, `net` or `tax-free` */
7868
- taxStatus?: string;
7869
- /**
7870
- * Format: float
7871
- * Total price of the cart, including shipping costs, discounts and taxes
7872
- */
7873
- totalPrice?: number;
7874
- };
7875
- };
7876
- responseCode: 200;
7877
- };
7878
- "addLineItems post /account/shopping-list/line-item/{id}/add": {
7879
- contentType?: "application/json";
7880
- accept?: "application/json";
7881
- pathParams: {
7882
- /** Identifier of the shopping list to be fetched */
7883
- id: string;
7884
- };
7885
- body: {
7886
- lineItems: {
7887
- [key: string]: {
7888
- /** Product id */
7889
- id: string;
7890
- /** Quantity of the product */
7891
- quantity: number;
7892
- };
7893
- };
7894
- };
7895
- response: never;
7896
- responseCode: 204;
7897
- };
7898
- "updateLineItems patch /account/shopping-list/line-item/{id}/change-quantity": {
7899
- contentType?: "application/json";
7900
- accept?: "application/json";
7901
- pathParams: {
7902
- /** Identifier of the shopping list line item to be fetched */
7903
- id: string;
7904
- };
7905
- body: {
7906
- /** new line item quantity */
7907
- quantity: number;
7908
- };
7909
- response: never;
7910
- responseCode: 204;
7911
- };
7912
- "removeLineItems delete /account/shopping-list/line-item/remove": {
7913
- contentType?: "application/json";
7914
- accept?: "application/json";
7915
- body: {
7916
- /** Line items ids */
7917
- ids: string[];
7918
- };
7919
- response: never;
7920
- responseCode: 204;
7921
- };
7922
- "readShoppingLists post /account/shopping-lists": {
7923
- contentType?: "application/json";
7924
- accept?: "application/json";
7925
- body?: components["schemas"]["Criteria"];
7926
- response: {
7927
- elements?: components["schemas"]["B2bComponentsShoppingList"][];
7928
- } & components["schemas"]["EntitySearchResult"];
7929
- responseCode: 200;
7930
- };
7931
9625
  "generateJWTAppSystemAppServer post /app-system/{name}/generate-token": {
7932
9626
  contentType?: "application/json";
7933
9627
  accept?: "application/json";
@@ -8158,11 +9852,16 @@ export type operations = {
8158
9852
  "sw-language-id"?: string;
8159
9853
  };
8160
9854
  body: {
8161
- // TODO: [OpenAPI][updateLineItem] - add proper request body type with required fields
8162
- items: Array<{
8163
- id: string;
8164
- quantity: number;
8165
- }>;
9855
+ items: [
9856
+ {
9857
+ id: string;
9858
+ quantity: number;
9859
+ },
9860
+ ...{
9861
+ id: string;
9862
+ quantity: number;
9863
+ }[],
9864
+ ];
8166
9865
  };
8167
9866
  response: components["schemas"]["Cart"];
8168
9867
  responseCode: 200;
@@ -8272,7 +9971,7 @@ export type operations = {
8272
9971
  /** Phone. This field may be required depending on the system settings. */
8273
9972
  phone?: string;
8274
9973
  /** Identifier of the salutation. Use `/api/salutation` endpoint to fetch possible values. */
8275
- salutationId: string;
9974
+ salutationId?: string;
8276
9975
  /** Identifier of the cms element */
8277
9976
  slotId?: string;
8278
9977
  /** The subject of the contact form. */
@@ -8436,7 +10135,7 @@ export type operations = {
8436
10135
  * The status you respond to
8437
10136
  * @enum {string}
8438
10137
  */
8439
- invitationStatus?: "accepted" | "maybe" | "declined";
10138
+ answer?: "accepted" | "maybe" | "declined";
8440
10139
  /** The token will be attached to the invitation response link in the invitation mail */
8441
10140
  token: string;
8442
10141
  };
@@ -8661,7 +10360,16 @@ export type operations = {
8661
10360
  response: components["schemas"]["CmsPage"];
8662
10361
  responseCode: 200;
8663
10362
  };
8664
- "readEmployees post /employee": {
10363
+ "readEmployees get /employee": {
10364
+ contentType?: "application/json";
10365
+ accept?: "application/json";
10366
+ body?: components["schemas"]["Criteria"];
10367
+ response: {
10368
+ elements?: components["schemas"]["B2bEmployee"][];
10369
+ } & components["schemas"]["EntitySearchResult"];
10370
+ responseCode: 200;
10371
+ };
10372
+ "readEmployeesPOST post /employee": {
8665
10373
  contentType?: "application/json";
8666
10374
  accept?: "application/json";
8667
10375
  body?: components["schemas"]["Criteria"];
@@ -8670,7 +10378,7 @@ export type operations = {
8670
10378
  } & components["schemas"]["EntitySearchResult"];
8671
10379
  responseCode: 200;
8672
10380
  };
8673
- "readEmployee post /employee/{id}": {
10381
+ "readEmployee get /employee/{id}": {
8674
10382
  contentType?: "application/json";
8675
10383
  accept?: "application/json";
8676
10384
  pathParams: {
@@ -8718,6 +10426,8 @@ export type operations = {
8718
10426
  email: string;
8719
10427
  /** First name of the new employee */
8720
10428
  firstName: string;
10429
+ /** Identifier of the [language](#/System%20%26%20Context/readLanguages) to be set for the new employee. */
10430
+ languageId: string;
8721
10431
  /** Last name of the new employee */
8722
10432
  lastName: string;
8723
10433
  /** Id of the role of the new employee */
@@ -8957,6 +10667,79 @@ export type operations = {
8957
10667
  };
8958
10668
  responseCode: 200;
8959
10669
  };
10670
+ "createPayPalOrder post /paypal/create-order": {
10671
+ contentType?: "application/json";
10672
+ accept?: "application/json";
10673
+ body: {
10674
+ /** Use an existing order id to create PayPal order */
10675
+ orderId?: string;
10676
+ /**
10677
+ * Use an existing order id to create PayPal order
10678
+ * @default ppcp
10679
+ */
10680
+ product?: string;
10681
+ };
10682
+ response: {
10683
+ token?: string;
10684
+ };
10685
+ responseCode: 200;
10686
+ };
10687
+ "createPayPalExpressOrder post /paypal/express/create-order": {
10688
+ contentType?: "application/json";
10689
+ accept?: "application/json";
10690
+ response: never;
10691
+ responseCode: 200;
10692
+ };
10693
+ "preparePayPalExpressCheckout post /paypal/express/prepare-checkout": {
10694
+ contentType?: "application/json";
10695
+ accept?: "application/json";
10696
+ body: {
10697
+ /** ID of the paypal order */
10698
+ token?: string;
10699
+ };
10700
+ response: {
10701
+ redirectUrl?: string;
10702
+ };
10703
+ responseCode: 200;
10704
+ };
10705
+ "setPaymentMethodEligibility post /paypal/payment-method-eligibility": {
10706
+ contentType?: "application/json";
10707
+ accept?: "application/json";
10708
+ body: {
10709
+ /** List of PayPal payment method identifiers according to constant REMOVABLE_PAYMENT_HANDLERS */
10710
+ paymentMethods?: string[];
10711
+ };
10712
+ response: never;
10713
+ responseCode: 204;
10714
+ };
10715
+ "getPUIPaymentInstructions get /paypal/pui/payment-instructions/{transactionId}": {
10716
+ contentType?: "application/json";
10717
+ accept?: "application/json";
10718
+ pathParams: {
10719
+ /** Identifier of the order transaction to be fetched */
10720
+ transactionId: string;
10721
+ };
10722
+ response: never;
10723
+ responseCode: 200;
10724
+ };
10725
+ "getPayPalCustomerVaultToken get /paypal/vault-token": {
10726
+ contentType?: "application/json";
10727
+ accept?: "application/json";
10728
+ response: {
10729
+ token?: string;
10730
+ };
10731
+ responseCode: 200;
10732
+ };
10733
+ "paypalVaultClear post /paypal/vault/clear": {
10734
+ contentType?: "application/json";
10735
+ accept?: "application/json";
10736
+ body: {
10737
+ /** @enum {string} */
10738
+ type?: "cancel" | "browser" | "error";
10739
+ };
10740
+ response: never;
10741
+ responseCode: 204;
10742
+ };
8960
10743
  "fetchPendingOrder post /pending-order/{id}": {
8961
10744
  contentType?: "application/json";
8962
10745
  accept?: "application/json";
@@ -9019,6 +10802,38 @@ export type operations = {
9019
10802
  response: components["schemas"]["PendingOrder"];
9020
10803
  responseCode: 200;
9021
10804
  };
10805
+ "readPermissions get /permission": {
10806
+ contentType?: "application/json";
10807
+ accept?: "application/json";
10808
+ response: {
10809
+ elements?: {
10810
+ permissionDependencies?: string[];
10811
+ permissionGroupName?: string;
10812
+ permissionName?: string;
10813
+ }[];
10814
+ } & components["schemas"]["EntitySearchResult"];
10815
+ responseCode: 200;
10816
+ };
10817
+ "addPermission post /permission": {
10818
+ contentType?: "application/json";
10819
+ accept?: "application/json";
10820
+ body: {
10821
+ /** Optional dependencies for the new permission */
10822
+ dependencies?: string[];
10823
+ /** Group of the new permission */
10824
+ group?: string;
10825
+ /** Name of the new permission */
10826
+ name?: string;
10827
+ };
10828
+ response: {
10829
+ elements?: {
10830
+ permissionDependencies?: string[];
10831
+ permissionGroupName?: string;
10832
+ permissionName?: string;
10833
+ }[];
10834
+ } & components["schemas"]["EntitySearchResult"];
10835
+ responseCode: 200;
10836
+ };
9022
10837
  "readProduct post /product": {
9023
10838
  contentType?: "application/json";
9024
10839
  accept?: "application/json";
@@ -9028,7 +10843,7 @@ export type operations = {
9028
10843
  };
9029
10844
  body?: components["schemas"]["Criteria"];
9030
10845
  response: {
9031
- elements: components["schemas"]["Product"][]; // TODO: [OpenAPI][readProduct]: add elements property as required
10846
+ elements: components["schemas"]["Product"][];
9032
10847
  } & components["schemas"]["EntitySearchResult"];
9033
10848
  responseCode: 200;
9034
10849
  };
@@ -9231,6 +11046,20 @@ export type operations = {
9231
11046
  response: never;
9232
11047
  responseCode: 204;
9233
11048
  };
11049
+ "sendMessageInQuote post /quote/{id}/send-message": {
11050
+ contentType?: "application/json";
11051
+ accept?: "application/json";
11052
+ pathParams: {
11053
+ /** Identifier of the quote to be reinvited */
11054
+ id: string;
11055
+ };
11056
+ body?: {
11057
+ /** Message content */
11058
+ comment?: string;
11059
+ };
11060
+ response: never;
11061
+ responseCode: 204;
11062
+ };
9234
11063
  "readQuote post /quote/detail/{id}": {
9235
11064
  contentType?: "application/json";
9236
11065
  accept?: "application/json";
@@ -9366,18 +11195,6 @@ export type operations = {
9366
11195
  response: never;
9367
11196
  responseCode: 204;
9368
11197
  };
9369
- "readPermissions get /role/permissions": {
9370
- contentType?: "application/json";
9371
- accept?: "application/json";
9372
- response: {
9373
- elements?: {
9374
- permissionDependencies?: string[];
9375
- permissionGroupName?: string;
9376
- permissionName?: string;
9377
- }[];
9378
- } & components["schemas"]["EntitySearchResult"];
9379
- responseCode: 200;
9380
- };
9381
11198
  "readSalutation post /salutation": {
9382
11199
  contentType?: "application/json";
9383
11200
  accept?: "application/json";
@@ -9519,11 +11336,168 @@ export type operations = {
9519
11336
  body?: components["schemas"]["Criteria"];
9520
11337
  response: {
9521
11338
  /** aggregation result */
9522
- aggregations?: Record<string, never>;
9523
- elements: components["schemas"]["ShippingMethod"][]; // TODO: [OpenAPI][readShippingMethod]: response should be `EntitySearchResult` and elements should be required
11339
+ aggregations?: GenericRecord;
11340
+ elements: components["schemas"]["ShippingMethod"][];
9524
11341
  /** Total amount */
9525
11342
  total?: number;
11343
+ } & components["schemas"]["EntitySearchResult"];
11344
+ responseCode: 200;
11345
+ };
11346
+ "createShoppingList post /shopping-list": {
11347
+ contentType?: "application/json";
11348
+ accept?: "application/json";
11349
+ body: {
11350
+ lineItems?: {
11351
+ [key: string]: {
11352
+ /** Product id */
11353
+ id: string;
11354
+ /** Quantity of the product */
11355
+ quantity: number;
11356
+ };
11357
+ };
11358
+ /** Shopping list name */
11359
+ name: string;
11360
+ };
11361
+ response: never;
11362
+ responseCode: 204;
11363
+ };
11364
+ "removeShoppingLists delete /shopping-list": {
11365
+ contentType?: "application/json";
11366
+ accept?: "application/json";
11367
+ body: {
11368
+ /** Shopping list ids */
11369
+ ids: string[];
11370
+ };
11371
+ response: never;
11372
+ responseCode: 204;
11373
+ };
11374
+ "readShoppingList post /shopping-list/{id}": {
11375
+ contentType?: "application/json";
11376
+ accept?: "application/json";
11377
+ pathParams: {
11378
+ /** Identifier of the shopping list to be fetched */
11379
+ id: string;
11380
+ };
11381
+ body?: components["schemas"]["Criteria"];
11382
+ response: components["schemas"]["B2bComponentsShoppingList"];
11383
+ responseCode: 200;
11384
+ };
11385
+ "addLineItems post /shopping-list/{id}/add": {
11386
+ contentType?: "application/json";
11387
+ accept?: "application/json";
11388
+ pathParams: {
11389
+ /** Identifier of the shopping list to be fetched */
11390
+ id: string;
11391
+ };
11392
+ body?: {
11393
+ lineItems: {
11394
+ [key: string]: {
11395
+ /** Product id */
11396
+ id: string;
11397
+ /** Quantity of the product */
11398
+ quantity: number;
11399
+ };
11400
+ };
11401
+ };
11402
+ response: never;
11403
+ responseCode: 204;
11404
+ };
11405
+ "updateShoppingList patch /shopping-list/{id}/change-name": {
11406
+ contentType?: "application/json";
11407
+ accept?: "application/json";
11408
+ pathParams: {
11409
+ /** Identifier of the shopping list to be fetched */
11410
+ id: string;
11411
+ };
11412
+ body: {
11413
+ /** Shopping list name */
11414
+ name: string;
11415
+ };
11416
+ response: never;
11417
+ responseCode: 204;
11418
+ };
11419
+ "duplicateShoppingList post /shopping-list/{id}/duplicate": {
11420
+ contentType?: "application/json";
11421
+ accept?: "application/json";
11422
+ pathParams: {
11423
+ /** Identifier of the shopping list to be fetched */
11424
+ id: string;
11425
+ };
11426
+ body: {
11427
+ /** Shopping list name */
11428
+ name: string;
11429
+ };
11430
+ response: {
11431
+ /** The generated id of the duplicated shopping list */
11432
+ id?: string;
11433
+ };
11434
+ responseCode: 200;
11435
+ };
11436
+ "summaryShoppingList get /shopping-list/{id}/summary": {
11437
+ contentType?: "application/json";
11438
+ accept?: "application/json";
11439
+ pathParams: {
11440
+ /** Identifier of the shopping list to be fetched */
11441
+ id: string;
11442
+ };
11443
+ response: {
11444
+ price?: {
11445
+ /**
11446
+ * Format: float
11447
+ * Net price of the cart
11448
+ */
11449
+ netPrice?: number;
11450
+ /**
11451
+ * Format: float
11452
+ * Price for all line items in the cart
11453
+ */
11454
+ positionPrice?: number;
11455
+ /** Tax calculation for the cart. One of `gross`, `net` or `tax-free` */
11456
+ taxStatus?: string;
11457
+ /**
11458
+ * Format: float
11459
+ * Total price of the cart, including shipping costs, discounts and taxes
11460
+ */
11461
+ totalPrice?: number;
11462
+ };
11463
+ };
11464
+ responseCode: 200;
11465
+ };
11466
+ "updateLineItems post /shopping-list/line-item/{id}/change-quantity": {
11467
+ contentType?: "application/json";
11468
+ accept?: "application/json";
11469
+ pathParams: {
11470
+ /** Identifier of the shopping list line item to be fetched */
11471
+ id: string;
11472
+ };
11473
+ body: {
11474
+ /** new line item quantity */
11475
+ quantity: number;
11476
+ };
11477
+ response: never;
11478
+ responseCode: 204;
11479
+ };
11480
+ "removeLineItems post /shopping-list/line-item/remove": {
11481
+ contentType?: "application/json";
11482
+ accept?: "application/json";
11483
+ body: {
11484
+ /** Line items ids */
11485
+ ids?: string[];
11486
+ /** List id */
11487
+ listId?: string;
11488
+ /** Product ids */
11489
+ productIds?: string[];
9526
11490
  };
11491
+ response: never;
11492
+ responseCode: 204;
11493
+ };
11494
+ "readShoppingLists post /shopping-lists": {
11495
+ contentType?: "application/json";
11496
+ accept?: "application/json";
11497
+ body?: components["schemas"]["Criteria"];
11498
+ response: {
11499
+ elements?: components["schemas"]["B2bComponentsShoppingList"][];
11500
+ } & components["schemas"]["EntitySearchResult"];
9527
11501
  responseCode: 200;
9528
11502
  };
9529
11503
  "addShoppingListsToCart post /shopping-lists/add-to-cart": {