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