@blezgo/api-sdk 0.1.2 → 0.1.3
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/account/generated.d.ts +193 -193
- package/dist/account/generated.d.ts.map +1 -1
- package/dist/activity/generated.d.ts +64 -64
- package/dist/activity/generated.d.ts.map +1 -1
- package/dist/addon/generated.d.ts +96 -96
- package/dist/addon/generated.d.ts.map +1 -1
- package/dist/admin/generated.d.ts +120 -120
- package/dist/admin/generated.d.ts.map +1 -1
- package/dist/affiliate/generated.d.ts +84 -85
- package/dist/affiliate/generated.d.ts.map +1 -1
- package/dist/analytics/generated.d.ts +15 -15
- package/dist/analytics/generated.d.ts.map +1 -1
- package/dist/announcements/generated.d.ts +100 -100
- package/dist/announcements/generated.d.ts.map +1 -1
- package/dist/apikeys/generated.d.ts +100 -100
- package/dist/apikeys/generated.d.ts.map +1 -1
- package/dist/assistance/generated.d.ts +12 -12
- package/dist/assistance/generated.d.ts.map +1 -1
- package/dist/authentication/generated.d.ts +95 -95
- package/dist/authentication/generated.d.ts.map +1 -1
- package/dist/blog/generated.d.ts +169 -169
- package/dist/blog/generated.d.ts.map +1 -1
- package/dist/bundle/generated.d.ts +168 -168
- package/dist/bundle/generated.d.ts.map +1 -1
- package/dist/cache/generated.d.ts +38 -38
- package/dist/cache/generated.d.ts.map +1 -1
- package/dist/calendar/generated.d.ts +38 -38
- package/dist/calendar/generated.d.ts.map +1 -1
- package/dist/campaigns/generated.d.ts +196 -196
- package/dist/campaigns/generated.d.ts.map +1 -1
- package/dist/cart/generated.d.ts +9 -9
- package/dist/cart/generated.d.ts.map +1 -1
- package/dist/changelog/generated.d.ts +88 -88
- package/dist/changelog/generated.d.ts.map +1 -1
- package/dist/channel/generated.d.ts +252 -252
- package/dist/channel/generated.d.ts.map +1 -1
- package/dist/company/generated.d.ts +58 -58
- package/dist/company/generated.d.ts.map +1 -1
- package/dist/conference/generated.d.ts +30 -30
- package/dist/conference/generated.d.ts.map +1 -1
- package/dist/config/generated.d.ts +25 -25
- package/dist/config/generated.d.ts.map +1 -1
- package/dist/content/generated.d.ts +658 -658
- package/dist/content/generated.d.ts.map +1 -1
- package/dist/cookies/generated.d.ts +46 -46
- package/dist/cookies/generated.d.ts.map +1 -1
- package/dist/courses/generated.d.ts +250 -250
- package/dist/courses/generated.d.ts.map +1 -1
- package/dist/custom/generated.d.ts +70 -70
- package/dist/custom/generated.d.ts.map +1 -1
- package/dist/dashboard/generated.d.ts +202 -202
- package/dist/dashboard/generated.d.ts.map +1 -1
- package/dist/elasticsearch/generated.d.ts +25 -25
- package/dist/elasticsearch/generated.d.ts.map +1 -1
- package/dist/enrollments/generated.d.ts +9 -9
- package/dist/enrollments/generated.d.ts.map +1 -1
- package/dist/errors/generated.d.ts +30 -30
- package/dist/errors/generated.d.ts.map +1 -1
- package/dist/eventconfig/generated.d.ts +103 -103
- package/dist/eventconfig/generated.d.ts.map +1 -1
- package/dist/funnels/generated.d.ts +94 -95
- package/dist/funnels/generated.d.ts.map +1 -1
- package/dist/gamification/generated.d.ts +103 -103
- package/dist/gamification/generated.d.ts.map +1 -1
- package/dist/impersonation/generated.d.ts +77 -77
- package/dist/impersonation/generated.d.ts.map +1 -1
- package/dist/inbox/generated.d.ts +99 -99
- package/dist/inbox/generated.d.ts.map +1 -1
- package/dist/internal/generated.d.ts +9 -9
- package/dist/internal/generated.d.ts.map +1 -1
- package/dist/internationalization/generated.d.ts +11 -11
- package/dist/internationalization/generated.d.ts.map +1 -1
- package/dist/invitations/generated.d.ts +131 -131
- package/dist/invitations/generated.d.ts.map +1 -1
- package/dist/meetings/generated.d.ts +251 -251
- package/dist/meetings/generated.d.ts.map +1 -1
- package/dist/metas/generated.d.ts +183 -183
- package/dist/metas/generated.d.ts.map +1 -1
- package/dist/notification/generated.d.ts +379 -379
- package/dist/notification/generated.d.ts.map +1 -1
- package/dist/notifications/generated.d.ts +9 -9
- package/dist/notifications/generated.d.ts.map +1 -1
- package/dist/onboarding/generated.d.ts +124 -124
- package/dist/onboarding/generated.d.ts.map +1 -1
- package/dist/packages/generated.d.ts +59 -59
- package/dist/packages/generated.d.ts.map +1 -1
- package/dist/payments/generated.d.ts +555 -558
- package/dist/payments/generated.d.ts.map +1 -1
- package/dist/payouts/generated.d.ts +9 -9
- package/dist/payouts/generated.d.ts.map +1 -1
- package/dist/plans/generated.d.ts +227 -227
- package/dist/plans/generated.d.ts.map +1 -1
- package/dist/pricing/generated.d.ts +34 -34
- package/dist/pricing/generated.d.ts.map +1 -1
- package/dist/products/generated.d.ts +610 -610
- package/dist/products/generated.d.ts.map +1 -1
- package/dist/profile/generated.d.ts +286 -286
- package/dist/profile/generated.d.ts.map +1 -1
- package/dist/reasons/generated.d.ts +32 -32
- package/dist/reasons/generated.d.ts.map +1 -1
- package/dist/registration/generated.d.ts +164 -164
- package/dist/registration/generated.d.ts.map +1 -1
- package/dist/reviews/generated.d.ts +51 -51
- package/dist/reviews/generated.d.ts.map +1 -1
- package/dist/role/generated.d.ts +899 -401
- package/dist/role/generated.d.ts.map +1 -1
- package/dist/scheduling/generated.d.ts +156 -156
- package/dist/scheduling/generated.d.ts.map +1 -1
- package/dist/services/generated.d.ts +1028 -1028
- package/dist/services/generated.d.ts.map +1 -1
- package/dist/sessions/generated.d.ts +247 -247
- package/dist/sessions/generated.d.ts.map +1 -1
- package/dist/spaces/generated.d.ts +419 -419
- package/dist/spaces/generated.d.ts.map +1 -1
- package/dist/storefront/generated.d.ts +9 -9
- package/dist/storefront/generated.d.ts.map +1 -1
- package/dist/support/generated.d.ts +1510 -1510
- package/dist/support/generated.d.ts.map +1 -1
- package/dist/sync/generated.d.ts +179 -179
- package/dist/sync/generated.d.ts.map +1 -1
- package/dist/tenant/generated.d.ts +537 -537
- package/dist/tenant/generated.d.ts.map +1 -1
- package/dist/testimonials/generated.d.ts +79 -79
- package/dist/testimonials/generated.d.ts.map +1 -1
- package/dist/tests/generated.d.ts +343 -343
- package/dist/tests/generated.d.ts.map +1 -1
- package/dist/tokens/generated.d.ts +37 -37
- package/dist/tokens/generated.d.ts.map +1 -1
- package/dist/uploads/generated.d.ts +33 -33
- package/dist/uploads/generated.d.ts.map +1 -1
- package/dist/upsell/generated.d.ts +82 -82
- package/dist/upsell/generated.d.ts.map +1 -1
- package/dist/user/generated.d.ts +280 -541
- package/dist/user/generated.d.ts.map +1 -1
- package/dist/webinars/generated.d.ts +183 -183
- package/dist/webinars/generated.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -2055,159 +2055,39 @@ export interface paths {
|
|
|
2055
2055
|
export type webhooks = Record<string, never>;
|
|
2056
2056
|
export interface components {
|
|
2057
2057
|
schemas: {
|
|
2058
|
-
/**
|
|
2059
|
-
|
|
2060
|
-
/**
|
|
2061
|
-
|
|
2062
|
-
/**
|
|
2063
|
-
|
|
2058
|
+
/** SmsTemplateUpdateRequest */
|
|
2059
|
+
SmsTemplateUpdateRequest: {
|
|
2060
|
+
/** Template Name */
|
|
2061
|
+
template_name?: string | null;
|
|
2062
|
+
/** Template Text */
|
|
2063
|
+
template_text?: string | null;
|
|
2064
|
+
/** Description */
|
|
2065
|
+
description?: string | null;
|
|
2064
2066
|
};
|
|
2065
|
-
/**
|
|
2066
|
-
|
|
2067
|
-
|
|
2068
|
-
|
|
2069
|
-
|
|
2070
|
-
|
|
2071
|
-
|
|
2072
|
-
|
|
2073
|
-
|
|
2074
|
-
|
|
2075
|
-
/**
|
|
2076
|
-
* Endpoint Name
|
|
2077
|
-
* @description Human-friendly label
|
|
2078
|
-
*/
|
|
2079
|
-
endpoint_name: string;
|
|
2080
|
-
/**
|
|
2081
|
-
* Endpoint Url
|
|
2082
|
-
* @description HTTPS URL that will receive POST deliveries
|
|
2083
|
-
*/
|
|
2084
|
-
endpoint_url: string;
|
|
2085
|
-
/**
|
|
2086
|
-
* Auth Type
|
|
2087
|
-
* @description Authentication method for deliveries. hmac_sha256: server generates HMAC signing secret (returned once). bearer_token: provide bearer_token or server generates one. api_key_header: provide api_key_header_name + api_key_value. basic_auth: provide basic_auth_username + basic_auth_password. none: no authentication.
|
|
2088
|
-
* @default hmac_sha256
|
|
2089
|
-
*/
|
|
2090
|
-
auth_type: string;
|
|
2091
|
-
/**
|
|
2092
|
-
* Bearer Token
|
|
2093
|
-
* @description bearer_token auth only. Omit to have the server generate a secure token.
|
|
2094
|
-
*/
|
|
2095
|
-
bearer_token?: string | null;
|
|
2096
|
-
/**
|
|
2097
|
-
* Api Key Header Name
|
|
2098
|
-
* @description api_key_header auth only. Header name (e.g. X-Api-Key).
|
|
2099
|
-
*/
|
|
2100
|
-
api_key_header_name?: string | null;
|
|
2101
|
-
/**
|
|
2102
|
-
* Api Key Value
|
|
2103
|
-
* @description api_key_header auth only. API key value.
|
|
2104
|
-
*/
|
|
2105
|
-
api_key_value?: string | null;
|
|
2106
|
-
/**
|
|
2107
|
-
* Basic Auth Username
|
|
2108
|
-
* @description basic_auth only.
|
|
2109
|
-
*/
|
|
2110
|
-
basic_auth_username?: string | null;
|
|
2111
|
-
/**
|
|
2112
|
-
* Basic Auth Password
|
|
2113
|
-
* @description basic_auth only.
|
|
2114
|
-
*/
|
|
2115
|
-
basic_auth_password?: string | null;
|
|
2116
|
-
/**
|
|
2117
|
-
* Ssl Verify
|
|
2118
|
-
* @default true
|
|
2119
|
-
*/
|
|
2120
|
-
ssl_verify: boolean;
|
|
2121
|
-
/**
|
|
2122
|
-
* Timeout Seconds
|
|
2123
|
-
* @default 10
|
|
2124
|
-
*/
|
|
2125
|
-
timeout_seconds: number;
|
|
2126
|
-
/**
|
|
2127
|
-
* Max Retries
|
|
2128
|
-
* @default 3
|
|
2129
|
-
*/
|
|
2130
|
-
max_retries: number;
|
|
2131
|
-
/**
|
|
2132
|
-
* Max Requests Per Minute
|
|
2133
|
-
* @default 60
|
|
2134
|
-
*/
|
|
2135
|
-
max_requests_per_minute: number;
|
|
2136
|
-
/**
|
|
2137
|
-
* Event Filter Json
|
|
2138
|
-
* @description AND-logic event filter conditions: [{"field":"data.status","operator":"eq","value":"completed"}]
|
|
2139
|
-
*/
|
|
2140
|
-
event_filter_json?: {
|
|
2141
|
-
[key: string]: unknown;
|
|
2142
|
-
}[] | null;
|
|
2143
|
-
/**
|
|
2144
|
-
* Payload Template
|
|
2145
|
-
* @description Custom payload template with {{field}} placeholders substituted from event data
|
|
2146
|
-
*/
|
|
2147
|
-
payload_template?: {
|
|
2148
|
-
[key: string]: unknown;
|
|
2149
|
-
} | null;
|
|
2150
|
-
/**
|
|
2151
|
-
* Custom Headers
|
|
2152
|
-
* @description Static headers merged into every delivery request
|
|
2153
|
-
*/
|
|
2154
|
-
custom_headers?: {
|
|
2155
|
-
[key: string]: string;
|
|
2156
|
-
} | null;
|
|
2157
|
-
/**
|
|
2158
|
-
* Skip Verification
|
|
2159
|
-
* @description Skip the verification ping (useful for localhost/testing)
|
|
2160
|
-
* @default false
|
|
2161
|
-
*/
|
|
2162
|
-
skip_verification: boolean;
|
|
2163
|
-
/**
|
|
2164
|
-
* Msd Webhook Endpoint Id
|
|
2165
|
-
* @description Platform webhook endpoint this org endpoint overrides
|
|
2166
|
-
*/
|
|
2167
|
-
msd_webhook_endpoint_id?: number | null;
|
|
2067
|
+
/** EmailTemplateUpdateRequest */
|
|
2068
|
+
EmailTemplateUpdateRequest: {
|
|
2069
|
+
/** Template Name */
|
|
2070
|
+
template_name?: string | null;
|
|
2071
|
+
/** Template Html */
|
|
2072
|
+
template_html?: string | null;
|
|
2073
|
+
/** S3 Path */
|
|
2074
|
+
s3_path?: string | null;
|
|
2075
|
+
/** Description */
|
|
2076
|
+
description?: string | null;
|
|
2168
2077
|
};
|
|
2169
|
-
/**
|
|
2170
|
-
|
|
2171
|
-
/**
|
|
2172
|
-
* Event Id
|
|
2173
|
-
* @description Event ID from msd_events_tbl
|
|
2174
|
-
*/
|
|
2175
|
-
event_id: number;
|
|
2176
|
-
/**
|
|
2177
|
-
* Language
|
|
2178
|
-
* @default en-US
|
|
2179
|
-
*/
|
|
2180
|
-
language: string;
|
|
2181
|
-
/**
|
|
2182
|
-
* Push Title
|
|
2183
|
-
* @description Push notification title
|
|
2184
|
-
*/
|
|
2078
|
+
/** PushContentUpdateRequest */
|
|
2079
|
+
PushContentUpdateRequest: {
|
|
2080
|
+
/** Push Title */
|
|
2185
2081
|
push_title?: string | null;
|
|
2186
|
-
/**
|
|
2187
|
-
* Push Body
|
|
2188
|
-
* @description Push notification body
|
|
2189
|
-
*/
|
|
2082
|
+
/** Push Body */
|
|
2190
2083
|
push_body?: string | null;
|
|
2191
|
-
/**
|
|
2192
|
-
* Status
|
|
2193
|
-
* @description draft, active, disabled
|
|
2194
|
-
* @default draft
|
|
2195
|
-
*/
|
|
2196
|
-
status: string;
|
|
2197
|
-
/** Org Push Template Id */
|
|
2198
|
-
org_push_template_id?: number | null;
|
|
2199
|
-
};
|
|
2200
|
-
/** WhatsAppContentUpdateRequest */
|
|
2201
|
-
WhatsAppContentUpdateRequest: {
|
|
2202
|
-
/** Whatsapp Text */
|
|
2203
|
-
whatsapp_text?: string | null;
|
|
2204
2084
|
/** Status */
|
|
2205
2085
|
status?: string | null;
|
|
2206
|
-
/** Org
|
|
2207
|
-
|
|
2086
|
+
/** Org Push Template Id */
|
|
2087
|
+
org_push_template_id?: number | null;
|
|
2208
2088
|
};
|
|
2209
|
-
/**
|
|
2210
|
-
|
|
2089
|
+
/** SmsContentCreateRequest */
|
|
2090
|
+
SmsContentCreateRequest: {
|
|
2211
2091
|
/**
|
|
2212
2092
|
* Event Id
|
|
2213
2093
|
* @description Event ID from msd_events_tbl
|
|
@@ -2219,41 +2099,21 @@ export interface components {
|
|
|
2219
2099
|
*/
|
|
2220
2100
|
language: string;
|
|
2221
2101
|
/**
|
|
2222
|
-
*
|
|
2223
|
-
* @description
|
|
2224
|
-
*/
|
|
2225
|
-
notification_title?: string | null;
|
|
2226
|
-
/**
|
|
2227
|
-
* Notification Body
|
|
2228
|
-
* @description In-App notification body
|
|
2102
|
+
* Sms Text
|
|
2103
|
+
* @description SMS message text with {{placeholders}}
|
|
2229
2104
|
*/
|
|
2230
|
-
|
|
2105
|
+
sms_text?: string | null;
|
|
2231
2106
|
/**
|
|
2232
2107
|
* Status
|
|
2233
2108
|
* @description draft, active, disabled
|
|
2234
2109
|
* @default draft
|
|
2235
2110
|
*/
|
|
2236
2111
|
status: string;
|
|
2237
|
-
/** Org
|
|
2238
|
-
|
|
2239
|
-
};
|
|
2240
|
-
ErrorResponse: {
|
|
2241
|
-
/** @example about:blank */
|
|
2242
|
-
type?: string;
|
|
2243
|
-
/** @example GENERIC_ERROR */
|
|
2244
|
-
code?: string;
|
|
2245
|
-
/** @example Client Error */
|
|
2246
|
-
title?: string;
|
|
2247
|
-
/** @example 400 */
|
|
2248
|
-
status?: number;
|
|
2249
|
-
/** @example An error occurred */
|
|
2250
|
-
detail?: string;
|
|
2251
|
-
/** @example /v1/cart/items */
|
|
2252
|
-
instance?: string;
|
|
2253
|
-
extensions?: components["schemas"]["Extensions"];
|
|
2112
|
+
/** Org Sms Template Id */
|
|
2113
|
+
org_sms_template_id?: number | null;
|
|
2254
2114
|
};
|
|
2255
|
-
/**
|
|
2256
|
-
|
|
2115
|
+
/** WhatsAppTemplateCreateRequest */
|
|
2116
|
+
WhatsAppTemplateCreateRequest: {
|
|
2257
2117
|
/**
|
|
2258
2118
|
* Template Name
|
|
2259
2119
|
* @description Human-readable template name
|
|
@@ -2266,36 +2126,14 @@ export interface components {
|
|
|
2266
2126
|
language: string;
|
|
2267
2127
|
/**
|
|
2268
2128
|
* Template Text
|
|
2269
|
-
* @description
|
|
2129
|
+
* @description WhatsApp template text with {{placeholders}}
|
|
2270
2130
|
*/
|
|
2271
2131
|
template_text?: string | null;
|
|
2272
2132
|
/** Description */
|
|
2273
2133
|
description?: string | null;
|
|
2274
2134
|
};
|
|
2275
|
-
/**
|
|
2276
|
-
|
|
2277
|
-
/** Push Title */
|
|
2278
|
-
push_title?: string | null;
|
|
2279
|
-
/** Push Body */
|
|
2280
|
-
push_body?: string | null;
|
|
2281
|
-
/** Status */
|
|
2282
|
-
status?: string | null;
|
|
2283
|
-
/** Org Push Template Id */
|
|
2284
|
-
org_push_template_id?: number | null;
|
|
2285
|
-
};
|
|
2286
|
-
/** EmailTemplateUpdateRequest */
|
|
2287
|
-
EmailTemplateUpdateRequest: {
|
|
2288
|
-
/** Template Name */
|
|
2289
|
-
template_name?: string | null;
|
|
2290
|
-
/** Template Html */
|
|
2291
|
-
template_html?: string | null;
|
|
2292
|
-
/** S3 Path */
|
|
2293
|
-
s3_path?: string | null;
|
|
2294
|
-
/** Description */
|
|
2295
|
-
description?: string | null;
|
|
2296
|
-
};
|
|
2297
|
-
/** WhatsAppTemplateCreateRequest */
|
|
2298
|
-
WhatsAppTemplateCreateRequest: {
|
|
2135
|
+
/** InAppTemplateCreateRequest */
|
|
2136
|
+
InAppTemplateCreateRequest: {
|
|
2299
2137
|
/**
|
|
2300
2138
|
* Template Name
|
|
2301
2139
|
* @description Human-readable template name
|
|
@@ -2307,78 +2145,42 @@ export interface components {
|
|
|
2307
2145
|
*/
|
|
2308
2146
|
language: string;
|
|
2309
2147
|
/**
|
|
2310
|
-
* Template
|
|
2311
|
-
* @description
|
|
2148
|
+
* Notification Title Template
|
|
2149
|
+
* @description In-App notification title template
|
|
2312
2150
|
*/
|
|
2313
|
-
|
|
2151
|
+
notification_title_template?: string | null;
|
|
2152
|
+
/**
|
|
2153
|
+
* Notification Body Template
|
|
2154
|
+
* @description In-App notification body template
|
|
2155
|
+
*/
|
|
2156
|
+
notification_body_template?: string | null;
|
|
2314
2157
|
/** Description */
|
|
2315
2158
|
description?: string | null;
|
|
2316
2159
|
};
|
|
2317
|
-
/**
|
|
2318
|
-
|
|
2160
|
+
/** PushTemplateCreateRequest */
|
|
2161
|
+
PushTemplateCreateRequest: {
|
|
2319
2162
|
/**
|
|
2320
|
-
*
|
|
2321
|
-
* @description
|
|
2163
|
+
* Template Name
|
|
2164
|
+
* @description Human-readable template name
|
|
2322
2165
|
*/
|
|
2323
|
-
|
|
2166
|
+
template_name: string;
|
|
2324
2167
|
/**
|
|
2325
2168
|
* Language
|
|
2326
2169
|
* @default en-US
|
|
2327
2170
|
*/
|
|
2328
2171
|
language: string;
|
|
2329
2172
|
/**
|
|
2330
|
-
*
|
|
2331
|
-
* @description
|
|
2332
|
-
*/
|
|
2333
|
-
whatsapp_text?: string | null;
|
|
2334
|
-
/**
|
|
2335
|
-
* Status
|
|
2336
|
-
* @description draft, active, disabled
|
|
2337
|
-
* @default draft
|
|
2338
|
-
*/
|
|
2339
|
-
status: string;
|
|
2340
|
-
/** Org Whatsapp Template Id */
|
|
2341
|
-
org_whatsapp_template_id?: number | null;
|
|
2342
|
-
};
|
|
2343
|
-
Extensions: {
|
|
2344
|
-
/** @example GENERIC_ERROR */
|
|
2345
|
-
message_code?: string;
|
|
2346
|
-
/** @example [] */
|
|
2347
|
-
invalid_params?: components["schemas"]["InvalidParam"][];
|
|
2348
|
-
extra_data?: Record<string, never> | null;
|
|
2349
|
-
/** @example Detailed debug information */
|
|
2350
|
-
debug?: string | null;
|
|
2351
|
-
};
|
|
2352
|
-
/** EmailContentCreateRequest */
|
|
2353
|
-
EmailContentCreateRequest: {
|
|
2354
|
-
/**
|
|
2355
|
-
* Event Id
|
|
2356
|
-
* @description Event ID from msd_events_tbl
|
|
2357
|
-
*/
|
|
2358
|
-
event_id: number;
|
|
2359
|
-
/**
|
|
2360
|
-
* Language
|
|
2361
|
-
* @default en-US
|
|
2173
|
+
* Push Title Template
|
|
2174
|
+
* @description Push notification title template
|
|
2362
2175
|
*/
|
|
2363
|
-
|
|
2364
|
-
/** Org Email Template Id */
|
|
2365
|
-
org_email_template_id?: number | null;
|
|
2366
|
-
/** Email Subject */
|
|
2367
|
-
email_subject?: string | null;
|
|
2368
|
-
/** Email Greet */
|
|
2369
|
-
email_greet?: string | null;
|
|
2370
|
-
/** Email Body */
|
|
2371
|
-
email_body?: string | null;
|
|
2372
|
-
/** Email Signoff */
|
|
2373
|
-
email_signoff?: string | null;
|
|
2374
|
-
/** Email Security Footer */
|
|
2375
|
-
email_security_footer?: string | null;
|
|
2176
|
+
push_title_template?: string | null;
|
|
2376
2177
|
/**
|
|
2377
|
-
*
|
|
2378
|
-
* @description
|
|
2379
|
-
* @default draft
|
|
2178
|
+
* Push Body Template
|
|
2179
|
+
* @description Push notification body template
|
|
2380
2180
|
*/
|
|
2381
|
-
|
|
2181
|
+
push_body_template?: string | null;
|
|
2182
|
+
/** Description */
|
|
2183
|
+
description?: string | null;
|
|
2382
2184
|
};
|
|
2383
2185
|
/** WhatsAppTemplateUpdateRequest */
|
|
2384
2186
|
WhatsAppTemplateUpdateRequest: {
|
|
@@ -2389,20 +2191,14 @@ export interface components {
|
|
|
2389
2191
|
/** Description */
|
|
2390
2192
|
description?: string | null;
|
|
2391
2193
|
};
|
|
2392
|
-
|
|
2393
|
-
|
|
2394
|
-
field?: string;
|
|
2395
|
-
/** @example Input should be greater than or equal to 1 */
|
|
2396
|
-
error?: string;
|
|
2397
|
-
};
|
|
2398
|
-
/** InAppTemplateUpdateRequest */
|
|
2399
|
-
InAppTemplateUpdateRequest: {
|
|
2194
|
+
/** PushTemplateUpdateRequest */
|
|
2195
|
+
PushTemplateUpdateRequest: {
|
|
2400
2196
|
/** Template Name */
|
|
2401
2197
|
template_name?: string | null;
|
|
2402
|
-
/**
|
|
2403
|
-
|
|
2404
|
-
/**
|
|
2405
|
-
|
|
2198
|
+
/** Push Title Template */
|
|
2199
|
+
push_title_template?: string | null;
|
|
2200
|
+
/** Push Body Template */
|
|
2201
|
+
push_body_template?: string | null;
|
|
2406
2202
|
/** Description */
|
|
2407
2203
|
description?: string | null;
|
|
2408
2204
|
};
|
|
@@ -2427,6 +2223,30 @@ export interface components {
|
|
|
2427
2223
|
/** Expires At */
|
|
2428
2224
|
expires_at?: string | null;
|
|
2429
2225
|
};
|
|
2226
|
+
Extensions: {
|
|
2227
|
+
/** @example GENERIC_ERROR */
|
|
2228
|
+
message_code?: string;
|
|
2229
|
+
/** @example [] */
|
|
2230
|
+
invalid_params?: components["schemas"]["InvalidParam"][];
|
|
2231
|
+
extra_data?: Record<string, never> | null;
|
|
2232
|
+
/** @example Detailed debug information */
|
|
2233
|
+
debug?: string | null;
|
|
2234
|
+
};
|
|
2235
|
+
ErrorResponse: {
|
|
2236
|
+
/** @example about:blank */
|
|
2237
|
+
type?: string;
|
|
2238
|
+
/** @example GENERIC_ERROR */
|
|
2239
|
+
code?: string;
|
|
2240
|
+
/** @example Client Error */
|
|
2241
|
+
title?: string;
|
|
2242
|
+
/** @example 400 */
|
|
2243
|
+
status?: number;
|
|
2244
|
+
/** @example An error occurred */
|
|
2245
|
+
detail?: string;
|
|
2246
|
+
/** @example /v1/cart/items */
|
|
2247
|
+
instance?: string;
|
|
2248
|
+
extensions?: components["schemas"]["Extensions"];
|
|
2249
|
+
};
|
|
2430
2250
|
/** InAppContentUpdateRequest */
|
|
2431
2251
|
InAppContentUpdateRequest: {
|
|
2432
2252
|
/** Notification Title */
|
|
@@ -2438,30 +2258,45 @@ export interface components {
|
|
|
2438
2258
|
/** Org Inapp Template Id */
|
|
2439
2259
|
org_inapp_template_id?: number | null;
|
|
2440
2260
|
};
|
|
2441
|
-
/**
|
|
2442
|
-
|
|
2261
|
+
/** EmailContentCreateRequest */
|
|
2262
|
+
EmailContentCreateRequest: {
|
|
2443
2263
|
/**
|
|
2444
|
-
*
|
|
2445
|
-
* @description
|
|
2264
|
+
* Event Id
|
|
2265
|
+
* @description Event ID from msd_events_tbl
|
|
2446
2266
|
*/
|
|
2447
|
-
|
|
2267
|
+
event_id: number;
|
|
2448
2268
|
/**
|
|
2449
2269
|
* Language
|
|
2450
2270
|
* @default en-US
|
|
2451
2271
|
*/
|
|
2452
2272
|
language: string;
|
|
2273
|
+
/** Org Email Template Id */
|
|
2274
|
+
org_email_template_id?: number | null;
|
|
2275
|
+
/** Email Subject */
|
|
2276
|
+
email_subject?: string | null;
|
|
2277
|
+
/** Email Greet */
|
|
2278
|
+
email_greet?: string | null;
|
|
2279
|
+
/** Email Body */
|
|
2280
|
+
email_body?: string | null;
|
|
2281
|
+
/** Email Signoff */
|
|
2282
|
+
email_signoff?: string | null;
|
|
2283
|
+
/** Email Security Footer */
|
|
2284
|
+
email_security_footer?: string | null;
|
|
2453
2285
|
/**
|
|
2454
|
-
*
|
|
2455
|
-
* @description
|
|
2456
|
-
|
|
2457
|
-
push_title_template?: string | null;
|
|
2458
|
-
/**
|
|
2459
|
-
* Push Body Template
|
|
2460
|
-
* @description Push notification body template
|
|
2286
|
+
* Status
|
|
2287
|
+
* @description draft, active, disabled
|
|
2288
|
+
* @default draft
|
|
2461
2289
|
*/
|
|
2462
|
-
|
|
2463
|
-
|
|
2464
|
-
|
|
2290
|
+
status: string;
|
|
2291
|
+
};
|
|
2292
|
+
/** WhatsAppContentUpdateRequest */
|
|
2293
|
+
WhatsAppContentUpdateRequest: {
|
|
2294
|
+
/** Whatsapp Text */
|
|
2295
|
+
whatsapp_text?: string | null;
|
|
2296
|
+
/** Status */
|
|
2297
|
+
status?: string | null;
|
|
2298
|
+
/** Org Whatsapp Template Id */
|
|
2299
|
+
org_whatsapp_template_id?: number | null;
|
|
2465
2300
|
};
|
|
2466
2301
|
/** SmsContentUpdateRequest */
|
|
2467
2302
|
SmsContentUpdateRequest: {
|
|
@@ -2472,33 +2307,8 @@ export interface components {
|
|
|
2472
2307
|
/** Org Sms Template Id */
|
|
2473
2308
|
org_sms_template_id?: number | null;
|
|
2474
2309
|
};
|
|
2475
|
-
/**
|
|
2476
|
-
|
|
2477
|
-
/**
|
|
2478
|
-
* Template Name
|
|
2479
|
-
* @description Human-readable template name
|
|
2480
|
-
*/
|
|
2481
|
-
template_name: string;
|
|
2482
|
-
/**
|
|
2483
|
-
* Language
|
|
2484
|
-
* @default en-US
|
|
2485
|
-
*/
|
|
2486
|
-
language: string;
|
|
2487
|
-
/**
|
|
2488
|
-
* Notification Title Template
|
|
2489
|
-
* @description In-App notification title template
|
|
2490
|
-
*/
|
|
2491
|
-
notification_title_template?: string | null;
|
|
2492
|
-
/**
|
|
2493
|
-
* Notification Body Template
|
|
2494
|
-
* @description In-App notification body template
|
|
2495
|
-
*/
|
|
2496
|
-
notification_body_template?: string | null;
|
|
2497
|
-
/** Description */
|
|
2498
|
-
description?: string | null;
|
|
2499
|
-
};
|
|
2500
|
-
/** SmsContentCreateRequest */
|
|
2501
|
-
SmsContentCreateRequest: {
|
|
2310
|
+
/** PushContentCreateRequest */
|
|
2311
|
+
PushContentCreateRequest: {
|
|
2502
2312
|
/**
|
|
2503
2313
|
* Event Id
|
|
2504
2314
|
* @description Event ID from msd_events_tbl
|
|
@@ -2510,60 +2320,57 @@ export interface components {
|
|
|
2510
2320
|
*/
|
|
2511
2321
|
language: string;
|
|
2512
2322
|
/**
|
|
2513
|
-
*
|
|
2514
|
-
* @description
|
|
2323
|
+
* Push Title
|
|
2324
|
+
* @description Push notification title
|
|
2515
2325
|
*/
|
|
2516
|
-
|
|
2326
|
+
push_title?: string | null;
|
|
2327
|
+
/**
|
|
2328
|
+
* Push Body
|
|
2329
|
+
* @description Push notification body
|
|
2330
|
+
*/
|
|
2331
|
+
push_body?: string | null;
|
|
2517
2332
|
/**
|
|
2518
2333
|
* Status
|
|
2519
2334
|
* @description draft, active, disabled
|
|
2520
2335
|
* @default draft
|
|
2521
2336
|
*/
|
|
2522
2337
|
status: string;
|
|
2523
|
-
/** Org
|
|
2524
|
-
|
|
2525
|
-
};
|
|
2526
|
-
/** SmsTemplateUpdateRequest */
|
|
2527
|
-
SmsTemplateUpdateRequest: {
|
|
2528
|
-
/** Template Name */
|
|
2529
|
-
template_name?: string | null;
|
|
2530
|
-
/** Template Text */
|
|
2531
|
-
template_text?: string | null;
|
|
2532
|
-
/** Description */
|
|
2533
|
-
description?: string | null;
|
|
2534
|
-
};
|
|
2535
|
-
/** PushTemplateUpdateRequest */
|
|
2536
|
-
PushTemplateUpdateRequest: {
|
|
2537
|
-
/** Template Name */
|
|
2538
|
-
template_name?: string | null;
|
|
2539
|
-
/** Push Title Template */
|
|
2540
|
-
push_title_template?: string | null;
|
|
2541
|
-
/** Push Body Template */
|
|
2542
|
-
push_body_template?: string | null;
|
|
2543
|
-
/** Description */
|
|
2544
|
-
description?: string | null;
|
|
2338
|
+
/** Org Push Template Id */
|
|
2339
|
+
org_push_template_id?: number | null;
|
|
2545
2340
|
};
|
|
2546
|
-
/**
|
|
2547
|
-
|
|
2548
|
-
|
|
2549
|
-
|
|
2550
|
-
|
|
2551
|
-
|
|
2552
|
-
|
|
2553
|
-
|
|
2554
|
-
|
|
2555
|
-
|
|
2556
|
-
|
|
2557
|
-
|
|
2558
|
-
|
|
2559
|
-
|
|
2560
|
-
|
|
2561
|
-
|
|
2562
|
-
|
|
2563
|
-
/**
|
|
2564
|
-
|
|
2565
|
-
|
|
2566
|
-
|
|
2341
|
+
/**
|
|
2342
|
+
* @example {
|
|
2343
|
+
* "status": "success",
|
|
2344
|
+
* "message": "Operation successful",
|
|
2345
|
+
* "message_code": "api_suc_20001",
|
|
2346
|
+
* "data": {},
|
|
2347
|
+
* "metadata": {
|
|
2348
|
+
* "timestamp": "2026-03-26T10:00:00.000Z",
|
|
2349
|
+
* "requestId": "07e22004-cb60-4dfc-bc9c-b6f99664dca1",
|
|
2350
|
+
* "traceId": "a9f1204c-bb82-41de-b234-7c3a9e120000",
|
|
2351
|
+
* "version": "v1",
|
|
2352
|
+
* "executionTime": 42,
|
|
2353
|
+
* "language": "en-US"
|
|
2354
|
+
* }
|
|
2355
|
+
* }
|
|
2356
|
+
*/
|
|
2357
|
+
StandardResponse: {
|
|
2358
|
+
/** @example success */
|
|
2359
|
+
status?: string;
|
|
2360
|
+
data?: Record<string, never> | null;
|
|
2361
|
+
/** @example Operation successful */
|
|
2362
|
+
message?: string | null;
|
|
2363
|
+
/** @example api_suc_20001 */
|
|
2364
|
+
message_code?: string | null;
|
|
2365
|
+
metadata?: Record<string, never> | null;
|
|
2366
|
+
error?: components["schemas"]["ErrorResponse"];
|
|
2367
|
+
};
|
|
2368
|
+
/** EventChannelUpdateRequest */
|
|
2369
|
+
EventChannelUpdateRequest: {
|
|
2370
|
+
/** Is Enabled */
|
|
2371
|
+
is_enabled?: boolean | null;
|
|
2372
|
+
/** Priority */
|
|
2373
|
+
priority?: number | null;
|
|
2567
2374
|
};
|
|
2568
2375
|
/**
|
|
2569
2376
|
* WebhookEndpointUpdateRequest
|
|
@@ -2637,32 +2444,225 @@ export interface components {
|
|
|
2637
2444
|
/** Status */
|
|
2638
2445
|
status?: string | null;
|
|
2639
2446
|
};
|
|
2447
|
+
InvalidParam: {
|
|
2448
|
+
/** @example items[0].quantity */
|
|
2449
|
+
field?: string;
|
|
2450
|
+
/** @example Input should be greater than or equal to 1 */
|
|
2451
|
+
error?: string;
|
|
2452
|
+
};
|
|
2453
|
+
/** WhatsAppContentCreateRequest */
|
|
2454
|
+
WhatsAppContentCreateRequest: {
|
|
2455
|
+
/**
|
|
2456
|
+
* Event Id
|
|
2457
|
+
* @description Event ID from msd_events_tbl
|
|
2458
|
+
*/
|
|
2459
|
+
event_id: number;
|
|
2460
|
+
/**
|
|
2461
|
+
* Language
|
|
2462
|
+
* @default en-US
|
|
2463
|
+
*/
|
|
2464
|
+
language: string;
|
|
2465
|
+
/**
|
|
2466
|
+
* Whatsapp Text
|
|
2467
|
+
* @description WhatsApp message text with {{placeholders}}
|
|
2468
|
+
*/
|
|
2469
|
+
whatsapp_text?: string | null;
|
|
2470
|
+
/**
|
|
2471
|
+
* Status
|
|
2472
|
+
* @description draft, active, disabled
|
|
2473
|
+
* @default draft
|
|
2474
|
+
*/
|
|
2475
|
+
status: string;
|
|
2476
|
+
/** Org Whatsapp Template Id */
|
|
2477
|
+
org_whatsapp_template_id?: number | null;
|
|
2478
|
+
};
|
|
2479
|
+
/** EmailTemplateCreateRequest */
|
|
2480
|
+
EmailTemplateCreateRequest: {
|
|
2481
|
+
/**
|
|
2482
|
+
* Template Name
|
|
2483
|
+
* @description Human-readable template name
|
|
2484
|
+
*/
|
|
2485
|
+
template_name: string;
|
|
2486
|
+
/**
|
|
2487
|
+
* Language
|
|
2488
|
+
* @default en-US
|
|
2489
|
+
*/
|
|
2490
|
+
language: string;
|
|
2491
|
+
/**
|
|
2492
|
+
* Template Html
|
|
2493
|
+
* @description Full HTML template body
|
|
2494
|
+
*/
|
|
2495
|
+
template_html?: string | null;
|
|
2496
|
+
/** S3 Path */
|
|
2497
|
+
s3_path?: string | null;
|
|
2498
|
+
/** Description */
|
|
2499
|
+
description?: string | null;
|
|
2500
|
+
};
|
|
2640
2501
|
/**
|
|
2641
|
-
*
|
|
2642
|
-
*
|
|
2643
|
-
* "message": "Operation successful",
|
|
2644
|
-
* "message_code": "api_suc_20001",
|
|
2645
|
-
* "data": {},
|
|
2646
|
-
* "metadata": {
|
|
2647
|
-
* "timestamp": "2026-03-26T10:00:00.000Z",
|
|
2648
|
-
* "requestId": "07e22004-cb60-4dfc-bc9c-b6f99664dca1",
|
|
2649
|
-
* "traceId": "a9f1204c-bb82-41de-b234-7c3a9e120000",
|
|
2650
|
-
* "version": "v1",
|
|
2651
|
-
* "executionTime": 42,
|
|
2652
|
-
* "language": "en-US"
|
|
2653
|
-
* }
|
|
2654
|
-
* }
|
|
2502
|
+
* WebhookEndpointRegisterRequest
|
|
2503
|
+
* @description Register a new org webhook endpoint.
|
|
2655
2504
|
*/
|
|
2656
|
-
|
|
2657
|
-
/**
|
|
2658
|
-
|
|
2659
|
-
|
|
2660
|
-
|
|
2661
|
-
|
|
2662
|
-
/**
|
|
2663
|
-
|
|
2664
|
-
|
|
2665
|
-
|
|
2505
|
+
WebhookEndpointRegisterRequest: {
|
|
2506
|
+
/**
|
|
2507
|
+
* Event Code
|
|
2508
|
+
* @description Event code to subscribe to (e.g. order.created)
|
|
2509
|
+
*/
|
|
2510
|
+
event_code: string;
|
|
2511
|
+
/**
|
|
2512
|
+
* Endpoint Name
|
|
2513
|
+
* @description Human-friendly label
|
|
2514
|
+
*/
|
|
2515
|
+
endpoint_name: string;
|
|
2516
|
+
/**
|
|
2517
|
+
* Endpoint Url
|
|
2518
|
+
* @description HTTPS URL that will receive POST deliveries
|
|
2519
|
+
*/
|
|
2520
|
+
endpoint_url: string;
|
|
2521
|
+
/**
|
|
2522
|
+
* Auth Type
|
|
2523
|
+
* @description Authentication method for deliveries. hmac_sha256: server generates HMAC signing secret (returned once). bearer_token: provide bearer_token or server generates one. api_key_header: provide api_key_header_name + api_key_value. basic_auth: provide basic_auth_username + basic_auth_password. none: no authentication.
|
|
2524
|
+
* @default hmac_sha256
|
|
2525
|
+
*/
|
|
2526
|
+
auth_type: string;
|
|
2527
|
+
/**
|
|
2528
|
+
* Bearer Token
|
|
2529
|
+
* @description bearer_token auth only. Omit to have the server generate a secure token.
|
|
2530
|
+
*/
|
|
2531
|
+
bearer_token?: string | null;
|
|
2532
|
+
/**
|
|
2533
|
+
* Api Key Header Name
|
|
2534
|
+
* @description api_key_header auth only. Header name (e.g. X-Api-Key).
|
|
2535
|
+
*/
|
|
2536
|
+
api_key_header_name?: string | null;
|
|
2537
|
+
/**
|
|
2538
|
+
* Api Key Value
|
|
2539
|
+
* @description api_key_header auth only. API key value.
|
|
2540
|
+
*/
|
|
2541
|
+
api_key_value?: string | null;
|
|
2542
|
+
/**
|
|
2543
|
+
* Basic Auth Username
|
|
2544
|
+
* @description basic_auth only.
|
|
2545
|
+
*/
|
|
2546
|
+
basic_auth_username?: string | null;
|
|
2547
|
+
/**
|
|
2548
|
+
* Basic Auth Password
|
|
2549
|
+
* @description basic_auth only.
|
|
2550
|
+
*/
|
|
2551
|
+
basic_auth_password?: string | null;
|
|
2552
|
+
/**
|
|
2553
|
+
* Ssl Verify
|
|
2554
|
+
* @default true
|
|
2555
|
+
*/
|
|
2556
|
+
ssl_verify: boolean;
|
|
2557
|
+
/**
|
|
2558
|
+
* Timeout Seconds
|
|
2559
|
+
* @default 10
|
|
2560
|
+
*/
|
|
2561
|
+
timeout_seconds: number;
|
|
2562
|
+
/**
|
|
2563
|
+
* Max Retries
|
|
2564
|
+
* @default 3
|
|
2565
|
+
*/
|
|
2566
|
+
max_retries: number;
|
|
2567
|
+
/**
|
|
2568
|
+
* Max Requests Per Minute
|
|
2569
|
+
* @default 60
|
|
2570
|
+
*/
|
|
2571
|
+
max_requests_per_minute: number;
|
|
2572
|
+
/**
|
|
2573
|
+
* Event Filter Json
|
|
2574
|
+
* @description AND-logic event filter conditions: [{"field":"data.status","operator":"eq","value":"completed"}]
|
|
2575
|
+
*/
|
|
2576
|
+
event_filter_json?: {
|
|
2577
|
+
[key: string]: unknown;
|
|
2578
|
+
}[] | null;
|
|
2579
|
+
/**
|
|
2580
|
+
* Payload Template
|
|
2581
|
+
* @description Custom payload template with {{field}} placeholders substituted from event data
|
|
2582
|
+
*/
|
|
2583
|
+
payload_template?: {
|
|
2584
|
+
[key: string]: unknown;
|
|
2585
|
+
} | null;
|
|
2586
|
+
/**
|
|
2587
|
+
* Custom Headers
|
|
2588
|
+
* @description Static headers merged into every delivery request
|
|
2589
|
+
*/
|
|
2590
|
+
custom_headers?: {
|
|
2591
|
+
[key: string]: string;
|
|
2592
|
+
} | null;
|
|
2593
|
+
/**
|
|
2594
|
+
* Skip Verification
|
|
2595
|
+
* @description Skip the verification ping (useful for localhost/testing)
|
|
2596
|
+
* @default false
|
|
2597
|
+
*/
|
|
2598
|
+
skip_verification: boolean;
|
|
2599
|
+
/**
|
|
2600
|
+
* Msd Webhook Endpoint Id
|
|
2601
|
+
* @description Platform webhook endpoint this org endpoint overrides
|
|
2602
|
+
*/
|
|
2603
|
+
msd_webhook_endpoint_id?: number | null;
|
|
2604
|
+
};
|
|
2605
|
+
/** InAppContentCreateRequest */
|
|
2606
|
+
InAppContentCreateRequest: {
|
|
2607
|
+
/**
|
|
2608
|
+
* Event Id
|
|
2609
|
+
* @description Event ID from msd_events_tbl
|
|
2610
|
+
*/
|
|
2611
|
+
event_id: number;
|
|
2612
|
+
/**
|
|
2613
|
+
* Language
|
|
2614
|
+
* @default en-US
|
|
2615
|
+
*/
|
|
2616
|
+
language: string;
|
|
2617
|
+
/**
|
|
2618
|
+
* Notification Title
|
|
2619
|
+
* @description In-App notification title
|
|
2620
|
+
*/
|
|
2621
|
+
notification_title?: string | null;
|
|
2622
|
+
/**
|
|
2623
|
+
* Notification Body
|
|
2624
|
+
* @description In-App notification body
|
|
2625
|
+
*/
|
|
2626
|
+
notification_body?: string | null;
|
|
2627
|
+
/**
|
|
2628
|
+
* Status
|
|
2629
|
+
* @description draft, active, disabled
|
|
2630
|
+
* @default draft
|
|
2631
|
+
*/
|
|
2632
|
+
status: string;
|
|
2633
|
+
/** Org Inapp Template Id */
|
|
2634
|
+
org_inapp_template_id?: number | null;
|
|
2635
|
+
};
|
|
2636
|
+
/** InAppTemplateUpdateRequest */
|
|
2637
|
+
InAppTemplateUpdateRequest: {
|
|
2638
|
+
/** Template Name */
|
|
2639
|
+
template_name?: string | null;
|
|
2640
|
+
/** Notification Title Template */
|
|
2641
|
+
notification_title_template?: string | null;
|
|
2642
|
+
/** Notification Body Template */
|
|
2643
|
+
notification_body_template?: string | null;
|
|
2644
|
+
/** Description */
|
|
2645
|
+
description?: string | null;
|
|
2646
|
+
};
|
|
2647
|
+
/** SmsTemplateCreateRequest */
|
|
2648
|
+
SmsTemplateCreateRequest: {
|
|
2649
|
+
/**
|
|
2650
|
+
* Template Name
|
|
2651
|
+
* @description Human-readable template name
|
|
2652
|
+
*/
|
|
2653
|
+
template_name: string;
|
|
2654
|
+
/**
|
|
2655
|
+
* Language
|
|
2656
|
+
* @default en-US
|
|
2657
|
+
*/
|
|
2658
|
+
language: string;
|
|
2659
|
+
/**
|
|
2660
|
+
* Template Text
|
|
2661
|
+
* @description SMS template text with {{placeholders}}
|
|
2662
|
+
*/
|
|
2663
|
+
template_text?: string | null;
|
|
2664
|
+
/** Description */
|
|
2665
|
+
description?: string | null;
|
|
2666
2666
|
};
|
|
2667
2667
|
};
|
|
2668
2668
|
responses: never;
|