@cimplify/sdk 0.102.0 → 0.104.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/advanced.d.mts +3 -3
- package/dist/advanced.d.ts +3 -3
- package/dist/advanced.js +23 -22
- package/dist/advanced.mjs +4 -3
- package/dist/{chunk-DCMXUKDQ.mjs → chunk-2WPVUIHX.mjs} +455 -105
- package/dist/{chunk-NIOUSKQQ.js → chunk-4BKOKHE3.js} +9 -0
- package/dist/{chunk-YDA46OZ6.js → chunk-5BDYDZ4U.js} +722 -90
- package/dist/{chunk-4KNFBPV2.mjs → chunk-5RT4HYMP.mjs} +61 -15
- package/dist/{chunk-WMEC5JWN.js → chunk-7PDEX54K.js} +50 -13
- package/dist/chunk-CNN7Z2IP.js +125 -0
- package/dist/{chunk-DLW3RWRK.mjs → chunk-DYIAX3WI.mjs} +46 -12
- package/dist/{chunk-LOWSMGRT.js → chunk-E4K2VQDD.js} +64 -16
- package/dist/chunk-GOHSXBKW.mjs +105 -0
- package/dist/{chunk-O3YUHLZL.mjs → chunk-H3RATH4B.mjs} +9 -0
- package/dist/{chunk-YER7DIOM.js → chunk-IQFFSKE2.js} +753 -594
- package/dist/{chunk-Z3K2D3TE.mjs → chunk-OCCNG6MO.mjs} +735 -558
- package/dist/{chunk-DKLHCZ5M.mjs → chunk-OKADBZAI.mjs} +652 -25
- package/dist/{chunk-EAZGA7LD.js → chunk-YVAEY3VC.js} +457 -107
- package/dist/{client-nsiMwuC1.d.ts → client-BVNWjk6W.d.ts} +2 -2
- package/dist/{client-B40KFazg.d.ts → client-BuLcOWLv.d.ts} +202 -319
- package/dist/{client-BizGfqB7.d.mts → client-D5AoobFc.d.mts} +202 -319
- package/dist/{client-BdErclfU.d.mts → client-fM716k7G.d.mts} +2 -2
- package/dist/{index-DpmnI__D.d.mts → index-BtcoqrY1.d.ts} +14 -4
- package/dist/{index-nEyXWIyR.d.ts → index-D7Tf3v7c.d.mts} +14 -4
- package/dist/index.d.mts +83 -8
- package/dist/index.d.ts +83 -8
- package/dist/index.js +203 -169
- package/dist/index.mjs +7 -5
- package/dist/link-D9iSVxt5.d.mts +308 -0
- package/dist/link-D9iSVxt5.d.ts +308 -0
- package/dist/mock/cli.mjs +463 -104
- package/dist/mock/library.js +463 -104
- package/dist/mock/library.mjs +463 -104
- package/dist/mock/msw.js +463 -104
- package/dist/mock/msw.mjs +463 -104
- package/dist/{product-Byf0unSy.d.mts → payment-g0HFkEDU.d.mts} +708 -61
- package/dist/{product-Byf0unSy.d.ts → payment-g0HFkEDU.d.ts} +708 -61
- package/dist/{price-BstChV9a.d.ts → price-BLIeAb8K.d.ts} +1 -1
- package/dist/{price-CS4E5zLS.d.mts → price-Czq_cTC_.d.mts} +1 -1
- package/dist/react.d.mts +4 -4
- package/dist/react.d.ts +4 -4
- package/dist/react.js +194 -169
- package/dist/react.mjs +55 -30
- package/dist/{server-DqbZh8Bk.d.mts → server-BkVhOIwn.d.mts} +14 -10
- package/dist/{server-Cj40R2ZD.d.ts → server-DKK_D-PP.d.ts} +14 -10
- package/dist/server.d.mts +4 -4
- package/dist/server.d.ts +4 -4
- package/dist/server.js +12 -10
- package/dist/server.mjs +6 -4
- package/dist/testing/msw.d.mts +2 -2
- package/dist/testing/msw.d.ts +2 -2
- package/dist/testing/msw.js +4 -3
- package/dist/testing/msw.mjs +3 -2
- package/dist/testing/suite.d.mts +6 -6
- package/dist/testing/suite.d.ts +6 -6
- package/dist/testing/suite.js +26 -25
- package/dist/testing/suite.mjs +7 -6
- package/dist/testing.d.mts +195 -56
- package/dist/testing.d.ts +195 -56
- package/dist/testing.js +95 -82
- package/dist/testing.mjs +14 -9
- package/dist/utils.d.mts +4 -4
- package/dist/utils.d.ts +4 -4
- package/dist/utils.js +37 -29
- package/dist/utils.mjs +2 -2
- package/package.json +7 -1
- package/registry/chat-widget.json +1 -1
- package/dist/payment-l0rkieEQ.d.mts +0 -113
- package/dist/payment-vzNnIi1n.d.ts +0 -113
|
@@ -27,6 +27,7 @@ declare const ErrorCode: {
|
|
|
27
27
|
readonly TIMEOUT: "TIMEOUT";
|
|
28
28
|
readonly UNAUTHORIZED: "UNAUTHORIZED";
|
|
29
29
|
readonly FORBIDDEN: "FORBIDDEN";
|
|
30
|
+
readonly TENANT_CONTEXT_CHANGED: "TENANT_CONTEXT_CHANGED";
|
|
30
31
|
readonly NOT_FOUND: "NOT_FOUND";
|
|
31
32
|
readonly VALIDATION_ERROR: "VALIDATION_ERROR";
|
|
32
33
|
readonly CART_EMPTY: "CART_EMPTY";
|
|
@@ -48,10 +49,14 @@ declare const ErrorCode: {
|
|
|
48
49
|
readonly PRICE_CHANGED: "PRICE_CHANGED";
|
|
49
50
|
readonly PAYMENT_FAILED: "PAYMENT_FAILED";
|
|
50
51
|
readonly PAYMENT_CANCELLED: "PAYMENT_CANCELLED";
|
|
52
|
+
readonly PAYMENT_CAPABILITY_MISMATCH: "PAYMENT_CAPABILITY_MISMATCH";
|
|
53
|
+
readonly UNSUPPORTED_CURRENCY: "UNSUPPORTED_CURRENCY";
|
|
51
54
|
readonly INSUFFICIENT_FUNDS: "INSUFFICIENT_FUNDS";
|
|
52
55
|
readonly CARD_DECLINED: "CARD_DECLINED";
|
|
53
56
|
readonly INVALID_OTP: "INVALID_OTP";
|
|
54
57
|
readonly OTP_EXPIRED: "OTP_EXPIRED";
|
|
58
|
+
readonly OTP_CHALLENGE_EXHAUSTED: "OTP_CHALLENGE_EXHAUSTED";
|
|
59
|
+
readonly OTP_CHALLENGE_CONSUMED: "OTP_CHALLENGE_CONSUMED";
|
|
55
60
|
readonly AUTHORIZATION_FAILED: "AUTHORIZATION_FAILED";
|
|
56
61
|
readonly PAYMENT_ACTION_NOT_COMPLETED: "PAYMENT_ACTION_NOT_COMPLETED";
|
|
57
62
|
readonly SLOT_UNAVAILABLE: "SLOT_UNAVAILABLE";
|
|
@@ -295,6 +300,42 @@ interface components {
|
|
|
295
300
|
provider_receives: string;
|
|
296
301
|
fee_bearer: components["schemas"]["FeeBearerType"];
|
|
297
302
|
};
|
|
303
|
+
ApiResponse_PublicSocialPost: {
|
|
304
|
+
data: {
|
|
305
|
+
id: string;
|
|
306
|
+
author: components["schemas"]["PublicPersona"];
|
|
307
|
+
collaborators: components["schemas"]["PublicSocialPostCollaborator"][];
|
|
308
|
+
kind: components["schemas"]["SocialPostKind"];
|
|
309
|
+
caption?: string | null;
|
|
310
|
+
media: components["schemas"]["PublicSocialPostMedia"][];
|
|
311
|
+
audio_label?: string | null;
|
|
312
|
+
market: string;
|
|
313
|
+
/** Format: date-time */
|
|
314
|
+
published_at: string;
|
|
315
|
+
tags: components["schemas"]["PublicSocialPostTag"][];
|
|
316
|
+
/**
|
|
317
|
+
* @description Persistent server-projected disclosure. Once true for a published post,
|
|
318
|
+
* offer retirement or enrollment revocation cannot clear it.
|
|
319
|
+
*/
|
|
320
|
+
paid_partnership: boolean;
|
|
321
|
+
partnership?: null | components["schemas"]["PublicSocialPostPartnership"];
|
|
322
|
+
/** @description Opaque signed handoff for the tagged business storefront. */
|
|
323
|
+
commerce_ref?: string | null;
|
|
324
|
+
engagement: components["schemas"]["SocialPostEngagement"];
|
|
325
|
+
viewer: components["schemas"]["SocialPostViewerState"];
|
|
326
|
+
};
|
|
327
|
+
meta?: null | components["schemas"]["ResponseMetadata"];
|
|
328
|
+
status: components["schemas"]["ResponseStatus"];
|
|
329
|
+
};
|
|
330
|
+
ApiResponse_PublicSocialShelfPage: {
|
|
331
|
+
data: {
|
|
332
|
+
sale: components["schemas"]["PublicSocialShelfSale"];
|
|
333
|
+
items: components["schemas"]["PublicCatalogueProduct"][];
|
|
334
|
+
next_cursor?: string | null;
|
|
335
|
+
};
|
|
336
|
+
meta?: null | components["schemas"]["ResponseMetadata"];
|
|
337
|
+
status: components["schemas"]["ResponseStatus"];
|
|
338
|
+
};
|
|
298
339
|
AppliedDiscount: {
|
|
299
340
|
discount_id: string;
|
|
300
341
|
discount_code?: string | null;
|
|
@@ -735,6 +776,8 @@ interface components {
|
|
|
735
776
|
payment: components["schemas"]["PaymentPreferences"];
|
|
736
777
|
/** @description Scheduling and booking preferences */
|
|
737
778
|
scheduling: components["schemas"]["SchedulingPreferences"];
|
|
779
|
+
/** @description Delivery fallback preferences. */
|
|
780
|
+
delivery?: components["schemas"]["DeliveryPreferences"];
|
|
738
781
|
/**
|
|
739
782
|
* @description Support agent preferences. `#[serde(default)]` because rows written
|
|
740
783
|
* before this field existed must not fall back to a full-default
|
|
@@ -1002,7 +1045,7 @@ interface components {
|
|
|
1002
1045
|
product_count?: number;
|
|
1003
1046
|
};
|
|
1004
1047
|
/** @enum {string} */
|
|
1005
|
-
Channel: "web" | "qr" | "desk" | "tap" | "chat" | "whatsapp" | "instagram" | "telegram" | "messenger" | "sms" | "email" | "agent";
|
|
1048
|
+
Channel: "web" | "qr" | "desk" | "tap" | "chat" | "whatsapp" | "instagram" | "telegram" | "messenger" | "sms" | "email" | "social" | "agent";
|
|
1006
1049
|
/** @description Channel-specific policy configuration */
|
|
1007
1050
|
ChannelPolicy: {
|
|
1008
1051
|
/** @description Channel identifier */
|
|
@@ -1046,64 +1089,103 @@ interface components {
|
|
|
1046
1089
|
/** @description Action to take when limit is exceeded */
|
|
1047
1090
|
overflow_action: components["schemas"]["OverflowAction"];
|
|
1048
1091
|
};
|
|
1049
|
-
|
|
1092
|
+
/**
|
|
1093
|
+
* @description Account-facing message projection. Merchant staff identity, the caller's
|
|
1094
|
+
* idempotency material and internal metadata stay on the business/audit
|
|
1095
|
+
* surface and never cross into the shopper API.
|
|
1096
|
+
*/
|
|
1097
|
+
ChatAccountMessageProjection: {
|
|
1050
1098
|
id: string;
|
|
1051
|
-
|
|
1052
|
-
|
|
1053
|
-
|
|
1054
|
-
|
|
1055
|
-
|
|
1099
|
+
thread_id: string;
|
|
1100
|
+
business_id: string;
|
|
1101
|
+
/** Format: int64 */
|
|
1102
|
+
sequence: number;
|
|
1103
|
+
sender_side: components["schemas"]["ChatSenderSide"];
|
|
1104
|
+
authorship: components["schemas"]["ChatAuthorship"];
|
|
1105
|
+
content: string;
|
|
1106
|
+
content_type: components["schemas"]["ChatContentType"];
|
|
1107
|
+
structured_content: Record<string, never>;
|
|
1108
|
+
media: Record<string, never>;
|
|
1109
|
+
reply_to_message_id?: string | null;
|
|
1056
1110
|
/** Format: date-time */
|
|
1057
|
-
|
|
1111
|
+
source_occurred_at?: string | null;
|
|
1058
1112
|
/** Format: date-time */
|
|
1059
|
-
|
|
1060
|
-
/**
|
|
1061
|
-
|
|
1062
|
-
|
|
1063
|
-
|
|
1064
|
-
team_read_at?: string | null;
|
|
1113
|
+
edited_at?: string | null;
|
|
1114
|
+
/** Format: date-time */
|
|
1115
|
+
deleted_at?: string | null;
|
|
1116
|
+
/** Format: date-time */
|
|
1117
|
+
created_at: string;
|
|
1065
1118
|
};
|
|
1119
|
+
/** @enum {string} */
|
|
1120
|
+
ChatAiMode: "auto" | "assist" | "off";
|
|
1121
|
+
/** @enum {string} */
|
|
1122
|
+
ChatAuthorship: "human" | "ai" | "system";
|
|
1123
|
+
/** @enum {string} */
|
|
1124
|
+
ChatContentType: "text" | "rich" | "media";
|
|
1066
1125
|
ChatConversationPeekResponse: {
|
|
1067
|
-
conversation?: null | components["schemas"]["
|
|
1068
|
-
messages: components["schemas"]["
|
|
1126
|
+
conversation?: null | components["schemas"]["ChatThreadProjection"];
|
|
1127
|
+
messages: components["schemas"]["ChatAccountMessageProjection"][];
|
|
1069
1128
|
};
|
|
1070
1129
|
ChatConversationResponse: {
|
|
1071
|
-
conversation: components["schemas"]["
|
|
1072
|
-
messages: components["schemas"]["
|
|
1130
|
+
conversation: components["schemas"]["ChatThreadProjection"];
|
|
1131
|
+
messages: components["schemas"]["ChatAccountMessageProjection"][];
|
|
1132
|
+
};
|
|
1133
|
+
ChatHandoffResponse: {
|
|
1134
|
+
thread: components["schemas"]["ChatThreadProjection"];
|
|
1135
|
+
/** Format: int64 */
|
|
1136
|
+
cancelled_turns: number;
|
|
1137
|
+
/** Format: int64 */
|
|
1138
|
+
spending_turns: number;
|
|
1073
1139
|
};
|
|
1074
1140
|
ChatMessageResponse: {
|
|
1141
|
+
message: components["schemas"]["ChatAccountMessageProjection"];
|
|
1142
|
+
replayed: boolean;
|
|
1143
|
+
};
|
|
1144
|
+
/** @enum {string} */
|
|
1145
|
+
ChatSenderSide: "account" | "business" | "system";
|
|
1146
|
+
ChatThread: {
|
|
1075
1147
|
id: string;
|
|
1076
|
-
|
|
1077
|
-
|
|
1078
|
-
|
|
1079
|
-
|
|
1080
|
-
|
|
1081
|
-
|
|
1082
|
-
|
|
1148
|
+
account_id: string;
|
|
1149
|
+
business_id: string;
|
|
1150
|
+
kind: components["schemas"]["ChatThreadKind"];
|
|
1151
|
+
ai_mode: components["schemas"]["ChatAiMode"];
|
|
1152
|
+
/** Format: int64 */
|
|
1153
|
+
ai_mode_version: number;
|
|
1154
|
+
/** Format: int64 */
|
|
1155
|
+
message_count: number;
|
|
1156
|
+
last_message_id?: string | null;
|
|
1157
|
+
/** Format: date-time */
|
|
1158
|
+
last_message_at?: string | null;
|
|
1083
1159
|
/** Format: date-time */
|
|
1084
1160
|
created_at: string;
|
|
1161
|
+
/** Format: date-time */
|
|
1162
|
+
updated_at: string;
|
|
1163
|
+
/** Format: date-time */
|
|
1164
|
+
archived_at?: string | null;
|
|
1085
1165
|
};
|
|
1166
|
+
/** @enum {string} */
|
|
1167
|
+
ChatThreadKind: "direct";
|
|
1086
1168
|
/**
|
|
1087
|
-
* @description
|
|
1088
|
-
*
|
|
1089
|
-
*
|
|
1169
|
+
* @description API-safe thread shape with explicit typed participants. The persisted
|
|
1170
|
+
* account/business foreign keys remain present on `thread`; these personas
|
|
1171
|
+
* make the two parties unambiguous at the domain and wire boundaries.
|
|
1090
1172
|
*/
|
|
1091
|
-
|
|
1092
|
-
|
|
1093
|
-
|
|
1094
|
-
preview: string;
|
|
1173
|
+
ChatThreadProjection: components["schemas"]["ChatThread"] & {
|
|
1174
|
+
account: components["schemas"]["Persona"];
|
|
1175
|
+
business: components["schemas"]["Persona"];
|
|
1095
1176
|
};
|
|
1096
1177
|
CheckoutApiResponse: {
|
|
1097
1178
|
order_id: string;
|
|
1098
1179
|
order_number: string;
|
|
1099
1180
|
bill_token?: string | null;
|
|
1181
|
+
payment_id?: string | null;
|
|
1100
1182
|
payment_reference?: string | null;
|
|
1101
1183
|
payment_status: string;
|
|
1102
1184
|
requires_authorization: boolean;
|
|
1103
1185
|
authorization_type?: null | components["schemas"]["AuthorizationType"];
|
|
1104
1186
|
authorization_url?: string | null;
|
|
1105
1187
|
display_text?: string | null;
|
|
1106
|
-
provider?:
|
|
1188
|
+
provider?: null | components["schemas"]["ProviderType"];
|
|
1107
1189
|
client_secret?: string | null;
|
|
1108
1190
|
public_key?: string | null;
|
|
1109
1191
|
next_action: components["schemas"]["NextAction"];
|
|
@@ -1166,8 +1248,8 @@ interface components {
|
|
|
1166
1248
|
fx_quote_id?: string | null;
|
|
1167
1249
|
/**
|
|
1168
1250
|
* @description Pay only the required deposit now (balance collected later) instead of the
|
|
1169
|
-
* full total.
|
|
1170
|
-
* the
|
|
1251
|
+
* full total. Honored only for the first collection on a deposit-eligible
|
|
1252
|
+
* order; later attempts collect the authoritative remaining balance.
|
|
1171
1253
|
*/
|
|
1172
1254
|
pay_deposit?: boolean;
|
|
1173
1255
|
/**
|
|
@@ -1231,8 +1313,26 @@ interface components {
|
|
|
1231
1313
|
};
|
|
1232
1314
|
ClaimConversationResponse: {
|
|
1233
1315
|
session_token: string;
|
|
1234
|
-
|
|
1316
|
+
thread: components["schemas"]["ChatThreadProjection"];
|
|
1235
1317
|
customer_name: string;
|
|
1318
|
+
/** @description One PII-minimal result per launch-claimable WhatsApp envelope. */
|
|
1319
|
+
external_claims: components["schemas"]["ClaimedExternalChat"][];
|
|
1320
|
+
/**
|
|
1321
|
+
* @description True only when candidate discovery itself was unavailable. Individual
|
|
1322
|
+
* envelope failures are represented in `external_claims` instead.
|
|
1323
|
+
*/
|
|
1324
|
+
external_claims_unavailable: boolean;
|
|
1325
|
+
};
|
|
1326
|
+
ClaimedExternalChat: {
|
|
1327
|
+
status: components["schemas"]["ExternalClaimDisposition"];
|
|
1328
|
+
thread_id?: string | null;
|
|
1329
|
+
/** Format: int64 */
|
|
1330
|
+
imported_message_count?: number | null;
|
|
1331
|
+
replayed: boolean;
|
|
1332
|
+
/** Format: int64 */
|
|
1333
|
+
observed_message_count?: number | null;
|
|
1334
|
+
/** Format: int64 */
|
|
1335
|
+
maximum_message_count?: number | null;
|
|
1236
1336
|
};
|
|
1237
1337
|
CollectionDetailView: {
|
|
1238
1338
|
collection: components["schemas"]["CollectionView"];
|
|
@@ -1594,8 +1694,6 @@ interface components {
|
|
|
1594
1694
|
/** @description Machine learning classifier */
|
|
1595
1695
|
MLClassifier: string;
|
|
1596
1696
|
};
|
|
1597
|
-
/** @enum {string} */
|
|
1598
|
-
ContentType: "text" | "image" | "video" | "audio" | "voice" | "document" | "sticker" | "location" | "contact" | "reaction" | "interactive" | "story_mention" | "share";
|
|
1599
1697
|
CoordinatesPair: {
|
|
1600
1698
|
/** Format: double */
|
|
1601
1699
|
lat: number;
|
|
@@ -1625,6 +1723,12 @@ interface components {
|
|
|
1625
1723
|
/** @description Channels allowed for cross-business communication */
|
|
1626
1724
|
approved_channels: string[];
|
|
1627
1725
|
};
|
|
1726
|
+
CursorMetadata: {
|
|
1727
|
+
next_cursor?: string | null;
|
|
1728
|
+
has_more: boolean;
|
|
1729
|
+
/** Format: int32 */
|
|
1730
|
+
count: number;
|
|
1731
|
+
};
|
|
1628
1732
|
Customer: {
|
|
1629
1733
|
id: string;
|
|
1630
1734
|
email?: string | null;
|
|
@@ -1715,6 +1819,13 @@ interface components {
|
|
|
1715
1819
|
field_type: string;
|
|
1716
1820
|
value: Record<string, never>;
|
|
1717
1821
|
semantic_kind?: null | components["schemas"]["SemanticKind"];
|
|
1822
|
+
/**
|
|
1823
|
+
* @description Authoritative per-unit adjustment captured from the field definition
|
|
1824
|
+
* when this value was validated. Callers must still re-resolve it from
|
|
1825
|
+
* the catalogue before changing frozen money; the snapshot makes the
|
|
1826
|
+
* selected pricing contract typed and hashable in between resolutions.
|
|
1827
|
+
*/
|
|
1828
|
+
price_adjustment?: string | null;
|
|
1718
1829
|
};
|
|
1719
1830
|
CustomerServicePreferences: {
|
|
1720
1831
|
preferred_staff_ids: string[];
|
|
@@ -1774,6 +1885,7 @@ interface components {
|
|
|
1774
1885
|
zone_name?: string | null;
|
|
1775
1886
|
provider: string;
|
|
1776
1887
|
provider_resolved_from: components["schemas"]["ProviderResolutionSource"];
|
|
1888
|
+
fee_status?: components["schemas"]["DeliveryFeeStatus"];
|
|
1777
1889
|
/**
|
|
1778
1890
|
* @description Named rate this fee was priced under, if any. `calculated_fee` is the
|
|
1779
1891
|
* rate price before `free_over`; the charged fee lives on the order.
|
|
@@ -1799,6 +1911,13 @@ interface components {
|
|
|
1799
1911
|
currency?: string | null;
|
|
1800
1912
|
details?: null | components["schemas"]["DeliveryFeeDetails"];
|
|
1801
1913
|
};
|
|
1914
|
+
/**
|
|
1915
|
+
* @description Whether delivery is priced on-platform or arranged directly between the
|
|
1916
|
+
* seller and customer. `Arranged` deliberately contributes zero to checkout,
|
|
1917
|
+
* tax, and payment totals; it must never be rendered as free delivery.
|
|
1918
|
+
* @enum {string}
|
|
1919
|
+
*/
|
|
1920
|
+
DeliveryFeeStatus: "priced" | "arranged";
|
|
1802
1921
|
/**
|
|
1803
1922
|
* @description One entry on the customer-facing delivery menu. Zone-backed rates are
|
|
1804
1923
|
* priced for a concrete dropoff; all-zone flat rates can be priced from the
|
|
@@ -1810,6 +1929,7 @@ interface components {
|
|
|
1810
1929
|
name: string;
|
|
1811
1930
|
description?: string | null;
|
|
1812
1931
|
fee: string;
|
|
1932
|
+
fee_status: components["schemas"]["DeliveryFeeStatus"];
|
|
1813
1933
|
currency: string;
|
|
1814
1934
|
free_delivery_applied: boolean;
|
|
1815
1935
|
free_over_amount?: string | null;
|
|
@@ -1825,6 +1945,17 @@ interface components {
|
|
|
1825
1945
|
options: components["schemas"]["DeliveryOption"][];
|
|
1826
1946
|
message?: string | null;
|
|
1827
1947
|
};
|
|
1948
|
+
/**
|
|
1949
|
+
* @description Delivery behavior that is safe to evaluate during checkout without
|
|
1950
|
+
* loading the complete business preferences document.
|
|
1951
|
+
*/
|
|
1952
|
+
DeliveryPreferences: {
|
|
1953
|
+
/**
|
|
1954
|
+
* @description When no rates or zones are configured, offer goods-only checkout and let
|
|
1955
|
+
* the seller arrange delivery directly with the customer.
|
|
1956
|
+
*/
|
|
1957
|
+
allow_seller_arranged_delivery?: boolean;
|
|
1958
|
+
};
|
|
1828
1959
|
/**
|
|
1829
1960
|
* @description Fulfillment evidence used by document-level statutory charges. `Unknown`
|
|
1830
1961
|
* is deliberately distinct from `NonMotorized`: compliance code must never
|
|
@@ -2037,6 +2168,8 @@ interface components {
|
|
|
2037
2168
|
seat_info: Record<string, never>;
|
|
2038
2169
|
};
|
|
2039
2170
|
/** @enum {string} */
|
|
2171
|
+
ExternalClaimDisposition: "claimed" | "replayed" | "conflict" | "contact_unverified" | "business_unavailable" | "history_empty" | "history_oversize" | "failed";
|
|
2172
|
+
/** @enum {string} */
|
|
2040
2173
|
FeeBearerType: "business" | "customer";
|
|
2041
2174
|
FeeHandlingPreferences: {
|
|
2042
2175
|
/** @description Whether business absorbs payment processing fees */
|
|
@@ -2126,6 +2259,19 @@ interface components {
|
|
|
2126
2259
|
};
|
|
2127
2260
|
/** @enum {string} */
|
|
2128
2261
|
InputFieldType: "text" | "textarea" | "number" | "select" | "radio" | "checkbox" | "color" | "date" | "file" | "image" | "url" | "address" | "phone" | "email" | "date_time" | "time" | "signature" | "multi_select" | "date_range" | "location";
|
|
2262
|
+
InventoryHoldWindowOverride: {
|
|
2263
|
+
channel: components["schemas"]["Channel"];
|
|
2264
|
+
/**
|
|
2265
|
+
* Format: int32
|
|
2266
|
+
* @description Whole seconds, bounded to match the one-minute inventory reaper cadence
|
|
2267
|
+
* and to prevent an ordinary self-service checkout from pinning stock for
|
|
2268
|
+
* more than one day.
|
|
2269
|
+
*/
|
|
2270
|
+
seconds: number;
|
|
2271
|
+
};
|
|
2272
|
+
InventoryHoldWindowPreferences: {
|
|
2273
|
+
channel_overrides?: components["schemas"]["InventoryHoldWindowOverride"][];
|
|
2274
|
+
};
|
|
2129
2275
|
InventoryPreferences: {
|
|
2130
2276
|
/** @description Basic inventory tracking settings */
|
|
2131
2277
|
tracking: components["schemas"]["InventoryTrackingPreferences"];
|
|
@@ -2146,6 +2292,12 @@ interface components {
|
|
|
2146
2292
|
* (material consumed outside a line's recipe). Off by default; stays record-only.
|
|
2147
2293
|
*/
|
|
2148
2294
|
deduct_adhoc_costs?: boolean;
|
|
2295
|
+
/**
|
|
2296
|
+
* @description Per-channel overrides for provisional customer inventory holds. The
|
|
2297
|
+
* resolved value is frozen onto the hold at order creation, so changing a
|
|
2298
|
+
* preference never moves an existing deadline.
|
|
2299
|
+
*/
|
|
2300
|
+
hold_windows?: components["schemas"]["InventoryHoldWindowPreferences"];
|
|
2149
2301
|
};
|
|
2150
2302
|
/**
|
|
2151
2303
|
* @description Defines how inventory is tracked for a product.
|
|
@@ -2423,6 +2575,11 @@ interface components {
|
|
|
2423
2575
|
item: components["schemas"]["ProductItemView"];
|
|
2424
2576
|
add_ons: components["schemas"]["AddOnView"][];
|
|
2425
2577
|
};
|
|
2578
|
+
MerchantReply: {
|
|
2579
|
+
text: string;
|
|
2580
|
+
/** Format: date-time */
|
|
2581
|
+
replied_at: string;
|
|
2582
|
+
};
|
|
2426
2583
|
/** @description Conditions that can trigger escalation */
|
|
2427
2584
|
MessagingEscalationTrigger: "NoAcknowledgment" | {
|
|
2428
2585
|
/** @description Specific user not available */
|
|
@@ -2522,6 +2679,7 @@ interface components {
|
|
|
2522
2679
|
reviews: boolean;
|
|
2523
2680
|
blogs: boolean;
|
|
2524
2681
|
marketing: boolean;
|
|
2682
|
+
publishing?: boolean;
|
|
2525
2683
|
accounting: boolean;
|
|
2526
2684
|
analytics: boolean;
|
|
2527
2685
|
taxes: boolean;
|
|
@@ -2564,6 +2722,11 @@ interface components {
|
|
|
2564
2722
|
provider: string;
|
|
2565
2723
|
client_secret: string;
|
|
2566
2724
|
public_key: string;
|
|
2725
|
+
/**
|
|
2726
|
+
* @description Public provider account namespace required by browser SDKs for a
|
|
2727
|
+
* direct connected-account charge. Platform-account flows omit it.
|
|
2728
|
+
*/
|
|
2729
|
+
provider_account_id?: string | null;
|
|
2567
2730
|
/** @enum {string} */
|
|
2568
2731
|
type: "card_popup";
|
|
2569
2732
|
} | {
|
|
@@ -2749,6 +2912,47 @@ interface components {
|
|
|
2749
2912
|
has_more: boolean;
|
|
2750
2913
|
next_cursor?: string | null;
|
|
2751
2914
|
};
|
|
2915
|
+
PaginationMetadata: {
|
|
2916
|
+
/** Format: int64 */
|
|
2917
|
+
total_count: number;
|
|
2918
|
+
/** Format: int32 */
|
|
2919
|
+
current_page: number;
|
|
2920
|
+
/** Format: int32 */
|
|
2921
|
+
page_size: number;
|
|
2922
|
+
/** Format: int32 */
|
|
2923
|
+
total_pages: number;
|
|
2924
|
+
};
|
|
2925
|
+
/**
|
|
2926
|
+
* @description Typed customer input for one provider-requested authorization step.
|
|
2927
|
+
*
|
|
2928
|
+
* Provider references are deliberately absent. The payment service resolves
|
|
2929
|
+
* the authoritative reference and provider from the tenant-scoped payment
|
|
2930
|
+
* row before making provider I/O.
|
|
2931
|
+
*/
|
|
2932
|
+
PaymentAuthorizationSubmission: {
|
|
2933
|
+
value: string;
|
|
2934
|
+
/** @enum {string} */
|
|
2935
|
+
type: "pin";
|
|
2936
|
+
} | {
|
|
2937
|
+
value: string;
|
|
2938
|
+
/** @enum {string} */
|
|
2939
|
+
type: "otp";
|
|
2940
|
+
} | {
|
|
2941
|
+
value: string;
|
|
2942
|
+
/** @enum {string} */
|
|
2943
|
+
type: "phone";
|
|
2944
|
+
} | {
|
|
2945
|
+
value: string;
|
|
2946
|
+
/** @enum {string} */
|
|
2947
|
+
type: "birthday";
|
|
2948
|
+
} | {
|
|
2949
|
+
address: string;
|
|
2950
|
+
city: string;
|
|
2951
|
+
state: string;
|
|
2952
|
+
zip_code: string;
|
|
2953
|
+
/** @enum {string} */
|
|
2954
|
+
type: "address";
|
|
2955
|
+
};
|
|
2752
2956
|
PaymentInfoDTO: {
|
|
2753
2957
|
state: components["schemas"]["PaymentState"];
|
|
2754
2958
|
computed_status?: string | null;
|
|
@@ -2804,6 +3008,12 @@ interface components {
|
|
|
2804
3008
|
reference?: string | null;
|
|
2805
3009
|
message: string;
|
|
2806
3010
|
};
|
|
3011
|
+
Persona: {
|
|
3012
|
+
persona_type: components["schemas"]["PersonaType"];
|
|
3013
|
+
persona_id: string;
|
|
3014
|
+
};
|
|
3015
|
+
/** @enum {string} */
|
|
3016
|
+
PersonaType: "account" | "business" | "service";
|
|
2807
3017
|
PlaceDetails: {
|
|
2808
3018
|
formatted_address: string;
|
|
2809
3019
|
street_address?: string | null;
|
|
@@ -3275,6 +3485,20 @@ interface components {
|
|
|
3275
3485
|
* @enum {string}
|
|
3276
3486
|
*/
|
|
3277
3487
|
ProviderResolutionSource: "zone" | "hint" | "fallback" | "rate" | "best_price";
|
|
3488
|
+
/** @enum {string} */
|
|
3489
|
+
ProviderType: "stripe" | "paystack" | "cellulant" | "mtn_momo" | "offline";
|
|
3490
|
+
PublicCatalogueCollection: {
|
|
3491
|
+
id: string;
|
|
3492
|
+
name: string;
|
|
3493
|
+
image_url?: string | null;
|
|
3494
|
+
};
|
|
3495
|
+
PublicCatalogueProduct: {
|
|
3496
|
+
id: string;
|
|
3497
|
+
name: string;
|
|
3498
|
+
image_url?: string | null;
|
|
3499
|
+
price: string;
|
|
3500
|
+
currency: string;
|
|
3501
|
+
};
|
|
3278
3502
|
PublicCheckoutSessionResponse: {
|
|
3279
3503
|
id: string;
|
|
3280
3504
|
status: string;
|
|
@@ -3292,6 +3516,134 @@ interface components {
|
|
|
3292
3516
|
/** Format: date-time */
|
|
3293
3517
|
expires_at: string;
|
|
3294
3518
|
};
|
|
3519
|
+
/** @enum {string} */
|
|
3520
|
+
PublicPartnerOfferScope: "product" | "collection" | "shop_wide";
|
|
3521
|
+
PublicPersona: {
|
|
3522
|
+
handle?: string | null;
|
|
3523
|
+
display_name: string;
|
|
3524
|
+
avatar_ref?: string | null;
|
|
3525
|
+
};
|
|
3526
|
+
PublicReview: {
|
|
3527
|
+
id: string;
|
|
3528
|
+
product_id?: string | null;
|
|
3529
|
+
media_refs: string[];
|
|
3530
|
+
reviewer_handle?: string | null;
|
|
3531
|
+
anonymous: boolean;
|
|
3532
|
+
review_text: string;
|
|
3533
|
+
/** Format: int32 */
|
|
3534
|
+
rating: number;
|
|
3535
|
+
verified_purchase: boolean;
|
|
3536
|
+
incentive_disclosure_required: boolean;
|
|
3537
|
+
/** Format: int32 */
|
|
3538
|
+
helpful_count: number;
|
|
3539
|
+
reply?: null | components["schemas"]["MerchantReply"];
|
|
3540
|
+
/** Format: date-time */
|
|
3541
|
+
created_at: string;
|
|
3542
|
+
};
|
|
3543
|
+
PublicSocialPost: {
|
|
3544
|
+
id: string;
|
|
3545
|
+
author: components["schemas"]["PublicPersona"];
|
|
3546
|
+
collaborators: components["schemas"]["PublicSocialPostCollaborator"][];
|
|
3547
|
+
kind: components["schemas"]["SocialPostKind"];
|
|
3548
|
+
caption?: string | null;
|
|
3549
|
+
media: components["schemas"]["PublicSocialPostMedia"][];
|
|
3550
|
+
audio_label?: string | null;
|
|
3551
|
+
market: string;
|
|
3552
|
+
/** Format: date-time */
|
|
3553
|
+
published_at: string;
|
|
3554
|
+
tags: components["schemas"]["PublicSocialPostTag"][];
|
|
3555
|
+
/**
|
|
3556
|
+
* @description Persistent server-projected disclosure. Once true for a published post,
|
|
3557
|
+
* offer retirement or enrollment revocation cannot clear it.
|
|
3558
|
+
*/
|
|
3559
|
+
paid_partnership: boolean;
|
|
3560
|
+
partnership?: null | components["schemas"]["PublicSocialPostPartnership"];
|
|
3561
|
+
/** @description Opaque signed handoff for the tagged business storefront. */
|
|
3562
|
+
commerce_ref?: string | null;
|
|
3563
|
+
engagement: components["schemas"]["SocialPostEngagement"];
|
|
3564
|
+
viewer: components["schemas"]["SocialPostViewerState"];
|
|
3565
|
+
};
|
|
3566
|
+
PublicSocialPostCollaborator: {
|
|
3567
|
+
persona: components["schemas"]["PublicPersona"];
|
|
3568
|
+
/** Format: int32 */
|
|
3569
|
+
seq: number;
|
|
3570
|
+
};
|
|
3571
|
+
PublicSocialPostMedia: {
|
|
3572
|
+
url: string;
|
|
3573
|
+
poster_url?: string | null;
|
|
3574
|
+
blurhash?: string | null;
|
|
3575
|
+
hls_url?: string | null;
|
|
3576
|
+
init_segment_url?: string | null;
|
|
3577
|
+
/** Format: int64 */
|
|
3578
|
+
init_segment_bytes?: number | null;
|
|
3579
|
+
first_segment_url?: string | null;
|
|
3580
|
+
/** Format: int64 */
|
|
3581
|
+
first_segment_bytes?: number | null;
|
|
3582
|
+
/** Format: int32 */
|
|
3583
|
+
width?: number | null;
|
|
3584
|
+
/** Format: int32 */
|
|
3585
|
+
height?: number | null;
|
|
3586
|
+
/** Format: int64 */
|
|
3587
|
+
duration_ms?: number | null;
|
|
3588
|
+
mime_type?: string | null;
|
|
3589
|
+
alt_text?: string | null;
|
|
3590
|
+
};
|
|
3591
|
+
/**
|
|
3592
|
+
* @description Public, non-financial Partner Commerce truth. The earning tag identity is
|
|
3593
|
+
* exposed so composer, post, and earnings views cannot disagree about which
|
|
3594
|
+
* merchant/scope was selected. Rate and enrollment identities stay private.
|
|
3595
|
+
*/
|
|
3596
|
+
PublicSocialPostPartnership: {
|
|
3597
|
+
/** Format: int32 */
|
|
3598
|
+
earning_tag_seq: number;
|
|
3599
|
+
offer_scope: components["schemas"]["PublicPartnerOfferScope"];
|
|
3600
|
+
};
|
|
3601
|
+
PublicSocialPostTag: {
|
|
3602
|
+
/** Format: int32 */
|
|
3603
|
+
seq: number;
|
|
3604
|
+
target: components["schemas"]["PublicSocialPostTagTarget"];
|
|
3605
|
+
};
|
|
3606
|
+
PublicSocialPostTagTarget: {
|
|
3607
|
+
value: components["schemas"]["PublicCatalogueProduct"];
|
|
3608
|
+
/** @enum {string} */
|
|
3609
|
+
type: "product";
|
|
3610
|
+
} | {
|
|
3611
|
+
value: components["schemas"]["PublicCatalogueCollection"];
|
|
3612
|
+
/** @enum {string} */
|
|
3613
|
+
type: "collection";
|
|
3614
|
+
} | {
|
|
3615
|
+
value: components["schemas"]["PublicSocialSaleTag"];
|
|
3616
|
+
/** @enum {string} */
|
|
3617
|
+
type: "sale";
|
|
3618
|
+
};
|
|
3619
|
+
PublicSocialSaleTag: {
|
|
3620
|
+
id: string;
|
|
3621
|
+
name: string;
|
|
3622
|
+
badge_text?: string | null;
|
|
3623
|
+
show_countdown: boolean;
|
|
3624
|
+
/** Format: date-time */
|
|
3625
|
+
occurrence_starts_at: string;
|
|
3626
|
+
/** Format: date-time */
|
|
3627
|
+
occurrence_ends_at: string;
|
|
3628
|
+
preview: components["schemas"]["PublicCatalogueProduct"][];
|
|
3629
|
+
};
|
|
3630
|
+
PublicSocialShelfPage: {
|
|
3631
|
+
sale: components["schemas"]["PublicSocialShelfSale"];
|
|
3632
|
+
items: components["schemas"]["PublicCatalogueProduct"][];
|
|
3633
|
+
next_cursor?: string | null;
|
|
3634
|
+
};
|
|
3635
|
+
PublicSocialShelfSale: {
|
|
3636
|
+
id: string;
|
|
3637
|
+
name: string;
|
|
3638
|
+
/** Format: int32 */
|
|
3639
|
+
version: number;
|
|
3640
|
+
badge_text?: string | null;
|
|
3641
|
+
show_countdown: boolean;
|
|
3642
|
+
/** Format: date-time */
|
|
3643
|
+
occurrence_starts_at: string;
|
|
3644
|
+
/** Format: date-time */
|
|
3645
|
+
occurrence_ends_at: string;
|
|
3646
|
+
};
|
|
3295
3647
|
QuantityPricingTier: {
|
|
3296
3648
|
/** Format: int32 */
|
|
3297
3649
|
min_quantity: number;
|
|
@@ -3321,11 +3673,65 @@ interface components {
|
|
|
3321
3673
|
/** Format: int64 */
|
|
3322
3674
|
countdown_seconds?: number | null;
|
|
3323
3675
|
};
|
|
3676
|
+
RatingDistribution: {
|
|
3677
|
+
/** Format: int64 */
|
|
3678
|
+
one: number;
|
|
3679
|
+
/** Format: int64 */
|
|
3680
|
+
two: number;
|
|
3681
|
+
/** Format: int64 */
|
|
3682
|
+
three: number;
|
|
3683
|
+
/** Format: int64 */
|
|
3684
|
+
four: number;
|
|
3685
|
+
/** Format: int64 */
|
|
3686
|
+
five: number;
|
|
3687
|
+
};
|
|
3688
|
+
RatingSummary: {
|
|
3689
|
+
product_id?: string | null;
|
|
3690
|
+
/** Format: int64 */
|
|
3691
|
+
review_count: number;
|
|
3692
|
+
/** Format: int64 */
|
|
3693
|
+
rating_sum: number;
|
|
3694
|
+
/** Format: double */
|
|
3695
|
+
average_rating?: number | null;
|
|
3696
|
+
distribution: components["schemas"]["RatingDistribution"];
|
|
3697
|
+
};
|
|
3698
|
+
ReactBody: {
|
|
3699
|
+
emoji: string;
|
|
3700
|
+
client_id: string;
|
|
3701
|
+
};
|
|
3324
3702
|
RecommendationsResponse: {
|
|
3325
3703
|
recommendations: components["schemas"]["ActivityRecommendation"][];
|
|
3326
3704
|
intent: string;
|
|
3327
3705
|
incentive?: null | components["schemas"]["IncentiveView"];
|
|
3328
3706
|
};
|
|
3707
|
+
/** @description Browser-known session context only; identity and attribution are derived server-side. */
|
|
3708
|
+
RecordActivitySessionBody: {
|
|
3709
|
+
analytics_session_id?: string | null;
|
|
3710
|
+
/** @description Opaque signed handoff copied from a public Social commerce post. */
|
|
3711
|
+
social_commerce_ref?: string | null;
|
|
3712
|
+
started_at?: string | null;
|
|
3713
|
+
landing_page?: string | null;
|
|
3714
|
+
landing_url?: string | null;
|
|
3715
|
+
referrer_url?: string | null;
|
|
3716
|
+
utm_source?: string | null;
|
|
3717
|
+
utm_medium?: string | null;
|
|
3718
|
+
utm_campaign?: string | null;
|
|
3719
|
+
utm_term?: string | null;
|
|
3720
|
+
utm_content?: string | null;
|
|
3721
|
+
/** Format: int32 */
|
|
3722
|
+
screen_width?: number | null;
|
|
3723
|
+
/** Format: int32 */
|
|
3724
|
+
screen_height?: number | null;
|
|
3725
|
+
/** Format: int32 */
|
|
3726
|
+
viewport_width?: number | null;
|
|
3727
|
+
/** Format: int32 */
|
|
3728
|
+
viewport_height?: number | null;
|
|
3729
|
+
pixel_density?: string | null;
|
|
3730
|
+
language?: string | null;
|
|
3731
|
+
timezone?: string | null;
|
|
3732
|
+
fingerprint?: string | null;
|
|
3733
|
+
is_new_visitor?: boolean | null;
|
|
3734
|
+
};
|
|
3329
3735
|
RecordEventsResponse: {
|
|
3330
3736
|
processed: number;
|
|
3331
3737
|
intent: string;
|
|
@@ -3429,6 +3835,43 @@ interface components {
|
|
|
3429
3835
|
name: string;
|
|
3430
3836
|
resource_type: string;
|
|
3431
3837
|
};
|
|
3838
|
+
ResponseMetadata: {
|
|
3839
|
+
pagination?: null | components["schemas"]["PaginationMetadata"];
|
|
3840
|
+
cursor?: null | components["schemas"]["CursorMetadata"];
|
|
3841
|
+
/** Format: date-time */
|
|
3842
|
+
timestamp: string;
|
|
3843
|
+
request_id?: string | null;
|
|
3844
|
+
};
|
|
3845
|
+
ResponseStatus: {
|
|
3846
|
+
/** Format: int32 */
|
|
3847
|
+
code: number;
|
|
3848
|
+
success: boolean;
|
|
3849
|
+
};
|
|
3850
|
+
ReviewCursor: {
|
|
3851
|
+
/** Format: date-time */
|
|
3852
|
+
created_at: string;
|
|
3853
|
+
id: string;
|
|
3854
|
+
};
|
|
3855
|
+
ReviewPage_PublicReview: {
|
|
3856
|
+
items: {
|
|
3857
|
+
id: string;
|
|
3858
|
+
product_id?: string | null;
|
|
3859
|
+
media_refs: string[];
|
|
3860
|
+
reviewer_handle?: string | null;
|
|
3861
|
+
anonymous: boolean;
|
|
3862
|
+
review_text: string;
|
|
3863
|
+
/** Format: int32 */
|
|
3864
|
+
rating: number;
|
|
3865
|
+
verified_purchase: boolean;
|
|
3866
|
+
incentive_disclosure_required: boolean;
|
|
3867
|
+
/** Format: int32 */
|
|
3868
|
+
helpful_count: number;
|
|
3869
|
+
reply?: null | components["schemas"]["MerchantReply"];
|
|
3870
|
+
/** Format: date-time */
|
|
3871
|
+
created_at: string;
|
|
3872
|
+
}[];
|
|
3873
|
+
next_cursor?: null | components["schemas"]["ReviewCursor"];
|
|
3874
|
+
};
|
|
3432
3875
|
/** @description Role-based message routing configuration */
|
|
3433
3876
|
RoleBasedRouting: {
|
|
3434
3877
|
/** @description Business identifier */
|
|
@@ -3594,30 +4037,14 @@ interface components {
|
|
|
3594
4037
|
* @enum {string}
|
|
3595
4038
|
*/
|
|
3596
4039
|
SemanticKind: "allergen" | "dietary_preference" | "sensitivity" | "consent";
|
|
3597
|
-
/**
|
|
3598
|
-
* @description POST /api/v1/support/conversation/messages
|
|
3599
|
-
*
|
|
3600
|
-
* Send a customer message. Triggers AI interpretation if the thread
|
|
3601
|
-
* is in Autopilot mode.
|
|
3602
|
-
* `client_id` is a widget-supplied idempotency key; passed through to
|
|
3603
|
-
* `CreateMessage.external_id`, so a retried POST with the same id
|
|
3604
|
-
* returns the originally created message instead of inserting twice.
|
|
3605
|
-
* `reply_to_message_id` quotes another message by the id the customer
|
|
3606
|
-
* actually has — `ChatMessageResponse.id`.
|
|
3607
|
-
*/
|
|
3608
4040
|
SendMessageBody: {
|
|
3609
4041
|
content: string;
|
|
3610
|
-
client_id
|
|
4042
|
+
client_id: string;
|
|
3611
4043
|
reply_to_message_id?: string | null;
|
|
3612
|
-
/**
|
|
3613
|
-
* @description Ids of image uploads made via `/api/v1/uploads` — the only way to
|
|
3614
|
-
* attach media. The server stores the durable storage reference and
|
|
3615
|
-
* presigns at read time.
|
|
3616
|
-
*/
|
|
3617
4044
|
upload_ids?: string[];
|
|
4045
|
+
/** @description Signed Social commerce context for this exact entry message. */
|
|
4046
|
+
social_ref?: string | null;
|
|
3618
4047
|
};
|
|
3619
|
-
/** @enum {string} */
|
|
3620
|
-
SenderType: "customer" | "agent" | "system" | "bot";
|
|
3621
4048
|
ServiceAvailabilityDayView: {
|
|
3622
4049
|
date: string;
|
|
3623
4050
|
slots: components["schemas"]["BookingSlot"][];
|
|
@@ -3764,6 +4191,58 @@ interface components {
|
|
|
3764
4191
|
/** Format: int32 */
|
|
3765
4192
|
participant_count: number;
|
|
3766
4193
|
};
|
|
4194
|
+
SocialPostEngagement: {
|
|
4195
|
+
/** Format: int64 */
|
|
4196
|
+
views: number;
|
|
4197
|
+
/** Format: int64 */
|
|
4198
|
+
likes: number;
|
|
4199
|
+
/** Format: int64 */
|
|
4200
|
+
comments: number;
|
|
4201
|
+
/** Format: int64 */
|
|
4202
|
+
shares: number;
|
|
4203
|
+
/** Format: int64 */
|
|
4204
|
+
saves: number;
|
|
4205
|
+
};
|
|
4206
|
+
/** @enum {string} */
|
|
4207
|
+
SocialPostKind: "video" | "image" | "live_replay";
|
|
4208
|
+
SocialPostMedia: {
|
|
4209
|
+
/**
|
|
4210
|
+
* @description Publishing-asset identity used to converge asynchronous media work.
|
|
4211
|
+
* Public Social projections use a separate DTO and omit this field.
|
|
4212
|
+
*/
|
|
4213
|
+
asset_ref?: string | null;
|
|
4214
|
+
object_key: string;
|
|
4215
|
+
poster_key?: string | null;
|
|
4216
|
+
blurhash?: string | null;
|
|
4217
|
+
hls_key?: string | null;
|
|
4218
|
+
init_segment_key?: string | null;
|
|
4219
|
+
/** Format: int64 */
|
|
4220
|
+
init_segment_bytes?: number | null;
|
|
4221
|
+
first_segment_key?: string | null;
|
|
4222
|
+
/** Format: int64 */
|
|
4223
|
+
first_segment_bytes?: number | null;
|
|
4224
|
+
/** Format: int32 */
|
|
4225
|
+
w?: number | null;
|
|
4226
|
+
/** Format: int32 */
|
|
4227
|
+
h?: number | null;
|
|
4228
|
+
/** Format: int64 */
|
|
4229
|
+
dur_ms?: number | null;
|
|
4230
|
+
mime_type?: string | null;
|
|
4231
|
+
alt_text?: string | null;
|
|
4232
|
+
};
|
|
4233
|
+
SocialPostTag: {
|
|
4234
|
+
/** Format: int32 */
|
|
4235
|
+
seq: number;
|
|
4236
|
+
target_type: components["schemas"]["SocialPostTagType"];
|
|
4237
|
+
target_id: string;
|
|
4238
|
+
target_business_id: string;
|
|
4239
|
+
};
|
|
4240
|
+
/** @enum {string} */
|
|
4241
|
+
SocialPostTagType: "product" | "collection" | "sale" | "business" | "service";
|
|
4242
|
+
SocialPostViewerState: {
|
|
4243
|
+
liked: boolean;
|
|
4244
|
+
saved: boolean;
|
|
4245
|
+
};
|
|
3767
4246
|
StaffInfo: {
|
|
3768
4247
|
staff_id: string;
|
|
3769
4248
|
name: string;
|
|
@@ -3808,10 +4287,50 @@ interface components {
|
|
|
3808
4287
|
balance: string;
|
|
3809
4288
|
currency: string;
|
|
3810
4289
|
};
|
|
4290
|
+
StorefrontActivitySessionResponse: {
|
|
4291
|
+
data: components["schemas"]["RecordSessionResponse"];
|
|
4292
|
+
};
|
|
4293
|
+
/**
|
|
4294
|
+
* @description One method/network combination accepted by the storefront checkout input.
|
|
4295
|
+
* @enum {string}
|
|
4296
|
+
*/
|
|
4297
|
+
StorefrontCollectionMethod: "card" | "mobile_money";
|
|
4298
|
+
StorefrontCollectionMethodOption: {
|
|
4299
|
+
method: components["schemas"]["StorefrontCollectionMethod"];
|
|
4300
|
+
/** @description Optional network selector required by network-specific methods. */
|
|
4301
|
+
network?: string | null;
|
|
4302
|
+
};
|
|
4303
|
+
/**
|
|
4304
|
+
* @description Storefront-safe projection of active merchant collection routes.
|
|
4305
|
+
*
|
|
4306
|
+
* Internal providers, route cells, proceeds, operation scopes, activations,
|
|
4307
|
+
* bindings, readiness, provider accounts, and payout identifiers deliberately
|
|
4308
|
+
* remain behind the payment service boundary.
|
|
4309
|
+
*/
|
|
4310
|
+
StorefrontCollectionOptions: {
|
|
4311
|
+
/** @description Exact ISO 4217 currency charged to the customer. */
|
|
4312
|
+
presentment_currency: string;
|
|
4313
|
+
options: components["schemas"]["StorefrontCollectionMethodOption"][];
|
|
4314
|
+
};
|
|
4315
|
+
StorefrontCollectionOptionsResponse: {
|
|
4316
|
+
data: components["schemas"]["StorefrontCollectionOptions"];
|
|
4317
|
+
};
|
|
4318
|
+
StorefrontPaymentAuthorizationResponse: {
|
|
4319
|
+
data: components["schemas"]["CheckoutApiResponse"];
|
|
4320
|
+
};
|
|
4321
|
+
StorefrontReviewListResponse: {
|
|
4322
|
+
data: components["schemas"]["ReviewPage_PublicReview"];
|
|
4323
|
+
};
|
|
4324
|
+
StorefrontReviewSummary: {
|
|
4325
|
+
ratings: components["schemas"]["RatingSummary"];
|
|
4326
|
+
trust_chips: components["schemas"]["TrustChips"];
|
|
4327
|
+
};
|
|
4328
|
+
StorefrontReviewSummaryResponse: {
|
|
4329
|
+
data: components["schemas"]["StorefrontReviewSummary"];
|
|
4330
|
+
};
|
|
3811
4331
|
SubmitAuthorizationArgs: {
|
|
3812
|
-
|
|
3813
|
-
|
|
3814
|
-
value: string;
|
|
4332
|
+
payment_id: string;
|
|
4333
|
+
authorization: components["schemas"]["PaymentAuthorizationSubmission"];
|
|
3815
4334
|
};
|
|
3816
4335
|
SubscriptionItem: {
|
|
3817
4336
|
id: string;
|
|
@@ -3921,6 +4440,16 @@ interface components {
|
|
|
3921
4440
|
/** @description Whether to send payment confirmations */
|
|
3922
4441
|
send_payment_confirmations: boolean;
|
|
3923
4442
|
};
|
|
4443
|
+
TrustChips: {
|
|
4444
|
+
/** Format: double */
|
|
4445
|
+
on_time_delivery_percent?: number | null;
|
|
4446
|
+
/** Format: int64 */
|
|
4447
|
+
delivery_sample_size: number;
|
|
4448
|
+
/** Format: int64 */
|
|
4449
|
+
average_first_response_seconds?: number | null;
|
|
4450
|
+
/** Format: int64 */
|
|
4451
|
+
support_sample_size: number;
|
|
4452
|
+
};
|
|
3924
4453
|
/** @description A comprehensive DTO for cart details to be sent to the frontend */
|
|
3925
4454
|
UICart: {
|
|
3926
4455
|
id: string;
|
|
@@ -5681,4 +6210,122 @@ interface TagsResponse {
|
|
|
5681
6210
|
offset: number;
|
|
5682
6211
|
}
|
|
5683
6212
|
|
|
5684
|
-
|
|
6213
|
+
type PaymentStatus = "initialized" | "pending" | "processing" | "authorized" | "captured" | "not_required" | "failed" | "cancelled" | "refunded" | "unknown" | "voided" | "requires_action" | "abandoned" | "reversed" | "disputed" | "refund_pending";
|
|
6214
|
+
type PaymentProvider = "stripe" | "paystack" | "cellulant" | "mtn_momo" | "offline" | "mtn" | "vodafone" | "airtel" | "cash" | "manual";
|
|
6215
|
+
type PaymentMethodType = "card" | "bank_transfer" | "cash" | {
|
|
6216
|
+
mobile_money: {
|
|
6217
|
+
provider: string;
|
|
6218
|
+
phone_number: string;
|
|
6219
|
+
};
|
|
6220
|
+
} | {
|
|
6221
|
+
ussd: {
|
|
6222
|
+
provider: string;
|
|
6223
|
+
};
|
|
6224
|
+
} | {
|
|
6225
|
+
bank: {
|
|
6226
|
+
bank_code: string;
|
|
6227
|
+
account_number: string;
|
|
6228
|
+
account_name?: string;
|
|
6229
|
+
bank_name?: string;
|
|
6230
|
+
};
|
|
6231
|
+
} | {
|
|
6232
|
+
qr: {
|
|
6233
|
+
provider: string;
|
|
6234
|
+
};
|
|
6235
|
+
} | {
|
|
6236
|
+
wallet: {
|
|
6237
|
+
provider: string;
|
|
6238
|
+
};
|
|
6239
|
+
} | {
|
|
6240
|
+
crypto: {
|
|
6241
|
+
currency: string;
|
|
6242
|
+
};
|
|
6243
|
+
} | {
|
|
6244
|
+
custom: string;
|
|
6245
|
+
};
|
|
6246
|
+
interface AddressAuthorizationData {
|
|
6247
|
+
address: string;
|
|
6248
|
+
city: string;
|
|
6249
|
+
state: string;
|
|
6250
|
+
zip_code: string;
|
|
6251
|
+
}
|
|
6252
|
+
type PaymentAuthorizationKind = "otp" | "pin" | "phone" | "birthday" | "address";
|
|
6253
|
+
type AuthorizationType = Exclude<PaymentAuthorizationKind, "address"> | {
|
|
6254
|
+
address: AddressAuthorizationData;
|
|
6255
|
+
};
|
|
6256
|
+
/** Customer input for one provider-requested authorization challenge. */
|
|
6257
|
+
type PaymentAuthorizationSubmission = {
|
|
6258
|
+
type: Exclude<PaymentAuthorizationKind, "address">;
|
|
6259
|
+
value: string;
|
|
6260
|
+
} | ({
|
|
6261
|
+
type: "address";
|
|
6262
|
+
} & AddressAuthorizationData);
|
|
6263
|
+
type PaymentProcessingState = "initial" | "preparing" | "processing" | "verifying" | "awaiting_authorization" | "success" | "error" | "timeout";
|
|
6264
|
+
interface PaymentMethod {
|
|
6265
|
+
type: PaymentMethodType;
|
|
6266
|
+
provider?: string;
|
|
6267
|
+
phone_number?: string;
|
|
6268
|
+
card_last_four?: string;
|
|
6269
|
+
custom_value?: string;
|
|
6270
|
+
}
|
|
6271
|
+
interface Payment {
|
|
6272
|
+
id: string;
|
|
6273
|
+
order_id: string;
|
|
6274
|
+
business_id: string;
|
|
6275
|
+
amount: Money;
|
|
6276
|
+
currency: CurrencyCode;
|
|
6277
|
+
payment_method: PaymentMethod;
|
|
6278
|
+
status: PaymentStatus;
|
|
6279
|
+
provider: PaymentProvider;
|
|
6280
|
+
provider_reference?: string;
|
|
6281
|
+
failure_reason?: string;
|
|
6282
|
+
created_at: string;
|
|
6283
|
+
updated_at: string;
|
|
6284
|
+
}
|
|
6285
|
+
interface InitializePaymentResult {
|
|
6286
|
+
payment_id: string;
|
|
6287
|
+
status: PaymentStatus;
|
|
6288
|
+
redirect_url?: string;
|
|
6289
|
+
authorization_url?: string;
|
|
6290
|
+
reference: string;
|
|
6291
|
+
provider: PaymentProvider;
|
|
6292
|
+
}
|
|
6293
|
+
interface PaymentResponse {
|
|
6294
|
+
method: string;
|
|
6295
|
+
provider: string;
|
|
6296
|
+
requires_action: boolean;
|
|
6297
|
+
public_key?: string;
|
|
6298
|
+
client_secret?: string;
|
|
6299
|
+
access_code?: string;
|
|
6300
|
+
redirect_url?: string;
|
|
6301
|
+
transaction_id?: string;
|
|
6302
|
+
order_id?: string;
|
|
6303
|
+
reference?: string;
|
|
6304
|
+
metadata?: Record<string, unknown>;
|
|
6305
|
+
instructions?: string;
|
|
6306
|
+
display_text?: string;
|
|
6307
|
+
requires_authorization?: boolean;
|
|
6308
|
+
authorization_type?: AuthorizationType;
|
|
6309
|
+
provider_payment_id?: string;
|
|
6310
|
+
}
|
|
6311
|
+
interface PaymentStatusResponse {
|
|
6312
|
+
status: PaymentStatus;
|
|
6313
|
+
paid: boolean;
|
|
6314
|
+
amount: Money;
|
|
6315
|
+
currency: string;
|
|
6316
|
+
reference?: string;
|
|
6317
|
+
message: string;
|
|
6318
|
+
}
|
|
6319
|
+
interface PaymentErrorDetails {
|
|
6320
|
+
code: string;
|
|
6321
|
+
message: string;
|
|
6322
|
+
recoverable: boolean;
|
|
6323
|
+
technical?: string;
|
|
6324
|
+
}
|
|
6325
|
+
interface SubmitAuthorizationInput {
|
|
6326
|
+
/** Tenant-scoped Cimplify payment id returned by checkout. */
|
|
6327
|
+
payment_id: string;
|
|
6328
|
+
authorization: PaymentAuthorizationSubmission;
|
|
6329
|
+
}
|
|
6330
|
+
|
|
6331
|
+
export { type ComponentGroup as $, type AddOn as A, BOUNDARY_KIND as B, type BundleComponentView as C, type BundlePriceType as D, type BundleProduct as E, type BundleSelectionData as F, type BundleSelectionInput as G, type BundleStoredSelection as H, type BundleSummary as I, type BundleWithDetails as J, type Cart as K, type CartAddOn as L, type CartChannel as M, type CartItem as N, type CartItemDetails as O, type CartMutationResult as P, type CartNotice as Q, type CartStatus as R, type CartSummary as S, type CartTotals as T, type Category as U, type CategorySummary as V, type ChosenPrice as W, CimplifyError as X, type Collection as Y, type CollectionProduct as Z, type CollectionSummary as _, type AddOnDetails as a, type PaymentErrorDetails as a$, type ComponentGroupWithComponents as a0, type ComponentPriceBreakdown as a1, type ComponentSchedulingData as a2, type ComponentSelectionInput as a3, type ComponentSourceType as a4, type Composite as a5, type CompositeComponent as a6, type CompositeComponentView as a7, type CompositeGroupView as a8, type CompositePriceBreakdown as a9, type DurationUnit as aA, ERROR_HINTS as aB, type EligiblePlansQuery as aC, ErrorCode as aD, type ErrorCodeType as aE, type ErrorHint as aF, type FacetValue as aG, type FormattedPlanOption as aH, type GroupPricingBehavior as aI, INPUT_FIELD_TYPE as aJ, IdempotencyMismatchError as aK, type InitializePaymentResult as aL, type InputFieldType as aM, type InputFieldValidation as aN, type InventoryType as aO, type KnowledgeArticle as aP, type LineConfiguration as aQ, type LocationProductPrice as aR, type LocationValue as aS, type MeasurementValue as aT, type Money as aU, PRODUCT_TYPE as aV, type Pagination as aW, type PaginationParams as aX, type Payment as aY, type PaymentAuthorizationKind as aZ, type PaymentAuthorizationSubmission as a_, type CompositePriceResult as aa, type CompositePricingMode as ab, type CompositeSelectionData as ac, type CompositeStoredSelection as ad, type CompositeWithDetails as ae, type CurrencyCode as af, type CustomAttributeDefinition as ag, type CustomAttributeValue as ah, type CustomerInputValue as ai, DURATION_UNIT as aj, type DateRangeValue as ak, type Deal as al, type DealBenefitType as am, type DepositType as an, type DestinationQuote as ao, type DestinationQuoteAddress as ap, type DestinationQuoteInput as aq, type DigitalProductType as ar, type DiscountBreakdown as as, type DiscountDetails as at, type DiscountValidation as au, type DisplayAddOn as av, type DisplayAddOnOption as aw, type DisplayCart as ax, type DisplayCartItem as ay, type DisplayMode as az, type AddOnGroupDetails as b, type VariantAxisValueView as b$, type PaymentMethod as b0, type PaymentMethodType as b1, type PaymentProcessingState as b2, type PaymentProvider as b3, type PaymentResponse as b4, type PaymentStatus as b5, type PaymentStatusResponse as b6, type PhoneValue as b7, type Price as b8, type PriceAdjustment as b9, type SalesChannel as bA, type SchedulingMode as bB, type SelectedAddOnOption as bC, type SemanticKind as bD, type SignatureValue as bE, type SubmitAuthorizationInput as bF, type Subscription as bG, type SubscriptionInvoice as bH, type SubscriptionItem as bI, type SubscriptionStatus as bJ, type SubscriptionWithDetails as bK, type Tag as bL, type TagsResponse as bM, type TaxPathComponent as bN, type TaxPriceDisplayMode as bO, type TaxonomyAttributeTemplate as bP, type TaxonomyWithChildren as bQ, type UICart as bR, type UICartBusiness as bS, type UICartCustomer as bT, type UICartLocation as bU, type UICartPricing as bV, type UpcomingSale as bW, type UpdateCartItemInput as bX, type VariantAxis as bY, type VariantAxisSelection as bZ, type VariantAxisValue as b_, type PriceDecisionPath as ba, type PriceEntryType as bb, type PricePathTaxInfo as bc, type PriceSource as bd, type Product as be, type ProductAddOn as bf, type ProductAvailability as bg, type ProductAvailabilityNow as bh, type ProductBillingPlan as bi, type ProductDealInfo as bj, type ProductInputField as bk, type ProductProperty as bl, type ProductRenderHint as bm, type ProductTaxonomy as bn, type ProductTimeProfile as bo, type ProductType as bp, type ProductVariant as bq, type ProductVariantValue as br, type ProductWithDetails as bs, type PropertyFacet as bt, type PropertySource as bu, type QuantityPricingTier as bv, RENDER_HINT as bw, type RelatedProductView as bx, type SaleCapInfo as by, type SaleInfo as bz, type AddOnOption as c, type VariantAxisView as c0, type VariantAxisWithValues as c1, type VariantDetails as c2, type VariantDetailsDTO as c3, type VariantDisplayAttribute as c4, type VariantLocationAvailability as c5, type VariantStrategy as c6, type VariantView as c7, ZERO as c8, type components as c9, currencyCode as ca, enrichError as cb, getErrorHint as cc, isCimplifyError as cd, isIdempotencyMismatchError as ce, isQuoteConflictRequiringConsent as cf, isQuoteError as cg, isRetryableError as ch, isSupportedCurrency as ci, money as cj, moneyFromNumber as ck, type AddOnOptionDetails as d, type AddOnOptionPrice as e, type AddOnWithOptions as f, type AddToCartInput as g, type AddressAuthorizationData as h, type AddressValue as i, type AdjustmentType as j, type ApiError as k, type AppliedDiscount as l, type AttributeAppliesTo as m, type AttributeType as n, type AttributeValidationRules as o, type AttributeVisibility as p, type AuthorizationType as q, type BenefitType as r, type BillingFrequency as s, type BillingMarkupType as t, type BillingPlanType as u, type BoundaryKind as v, type Bundle as w, type BundleComponentData as x, type BundleComponentInfo as y, type BundleComponentVariantView as z };
|