@parra/parra-js-sdk 0.3.612 → 0.3.614
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/ParraAPI.d.ts +147 -49
- package/dist/ParraAPI.js +15 -10
- package/package.json +1 -1
package/dist/ParraAPI.d.ts
CHANGED
@@ -1035,6 +1035,10 @@ export interface AppArticleCollectionResponse {
|
|
1035
1035
|
total_count: number;
|
1036
1036
|
data: Array<AppArticleStub>;
|
1037
1037
|
}
|
1038
|
+
export declare enum ProductType {
|
1039
|
+
digital = "digital",
|
1040
|
+
external = "external"
|
1041
|
+
}
|
1038
1042
|
export declare enum Currency {
|
1039
1043
|
usd = "usd"
|
1040
1044
|
}
|
@@ -1064,13 +1068,20 @@ export interface Cta {
|
|
1064
1068
|
title: string;
|
1065
1069
|
type: CtaType;
|
1066
1070
|
}
|
1067
|
-
export interface
|
1071
|
+
export interface AppProductStub {
|
1068
1072
|
id: string;
|
1069
|
-
|
1070
|
-
|
1073
|
+
created_at: string;
|
1074
|
+
updated_at: string;
|
1075
|
+
deleted_at?: string | null;
|
1076
|
+
tenant_id: string;
|
1077
|
+
title: string;
|
1078
|
+
key: string;
|
1079
|
+
type: ProductType;
|
1071
1080
|
description?: string | null;
|
1081
|
+
image?: ImageAssetStub | null;
|
1082
|
+
icon?: ImageAssetStub | null;
|
1072
1083
|
price?: AnyPrice | null;
|
1073
|
-
cta
|
1084
|
+
cta?: Cta | null;
|
1074
1085
|
}
|
1075
1086
|
export interface AppSponsor {
|
1076
1087
|
id: string;
|
@@ -1202,7 +1213,7 @@ export interface AppArticle {
|
|
1202
1213
|
json_content: ArticleContent;
|
1203
1214
|
html_content: string;
|
1204
1215
|
text_content: string;
|
1205
|
-
products?: Array<
|
1216
|
+
products?: Array<AppProductStub>;
|
1206
1217
|
sponsors?: Array<AppSponsor>;
|
1207
1218
|
content?: Content;
|
1208
1219
|
}
|
@@ -1403,8 +1414,14 @@ export interface ProductStub {
|
|
1403
1414
|
tenant_id: string;
|
1404
1415
|
title: string;
|
1405
1416
|
key: string;
|
1417
|
+
type: ProductType;
|
1406
1418
|
description?: string | null;
|
1407
1419
|
disabled: boolean;
|
1420
|
+
image?: ImageAssetStub | null;
|
1421
|
+
icon?: ImageAssetStub | null;
|
1422
|
+
price?: AnyPrice | null;
|
1423
|
+
cta?: Cta | null;
|
1424
|
+
sort_order?: number;
|
1408
1425
|
}
|
1409
1426
|
export interface AppleInAppPurchase {
|
1410
1427
|
id: string;
|
@@ -1676,16 +1693,25 @@ export interface Entitlement {
|
|
1676
1693
|
is_consumable: boolean;
|
1677
1694
|
products?: Array<ProductEntitlementProductStub> | null;
|
1678
1695
|
}
|
1679
|
-
export interface
|
1680
|
-
|
1696
|
+
export interface CreateDigitalProductRequestBody {
|
1697
|
+
type: string;
|
1698
|
+
title: string;
|
1681
1699
|
key?: string;
|
1682
1700
|
description?: string | null;
|
1701
|
+
icon_asset_id?: string | null;
|
1702
|
+
image_asset_id?: string | null;
|
1683
1703
|
}
|
1684
|
-
export interface
|
1685
|
-
|
1704
|
+
export interface CreateExternalProductRequestBody {
|
1705
|
+
type: string;
|
1706
|
+
title: string;
|
1686
1707
|
key?: string;
|
1687
1708
|
description?: string | null;
|
1709
|
+
icon_asset_id?: string | null;
|
1710
|
+
image_asset_id?: string | null;
|
1711
|
+
cta_title: string;
|
1712
|
+
cta_url: string | null;
|
1688
1713
|
}
|
1714
|
+
export type CreateProductRequestBody = CreateDigitalProductRequestBody | CreateExternalProductRequestBody;
|
1689
1715
|
export interface ProductEntitlement {
|
1690
1716
|
id: string;
|
1691
1717
|
title: string;
|
@@ -1704,10 +1730,21 @@ export interface Product {
|
|
1704
1730
|
tenant_id: string;
|
1705
1731
|
title: string;
|
1706
1732
|
key: string;
|
1733
|
+
type: ProductType;
|
1707
1734
|
description?: string | null;
|
1708
1735
|
disabled: boolean;
|
1736
|
+
image?: ImageAssetStub | null;
|
1737
|
+
icon?: ImageAssetStub | null;
|
1738
|
+
price?: AnyPrice | null;
|
1739
|
+
cta?: Cta | null;
|
1740
|
+
sort_order?: number;
|
1709
1741
|
entitlements?: Array<ProductEntitlement> | null;
|
1710
1742
|
}
|
1743
|
+
export interface UpdateProductRequestBody {
|
1744
|
+
title?: string;
|
1745
|
+
key?: string;
|
1746
|
+
description?: string | null;
|
1747
|
+
}
|
1711
1748
|
export interface CreateProductEntitlementRequestBody {
|
1712
1749
|
entitlement_id: string;
|
1713
1750
|
consumable_quantity?: number | null;
|
@@ -1984,6 +2021,8 @@ export interface Ref {
|
|
1984
2021
|
}
|
1985
2022
|
export type FontSize = FontSizeType | FontSizeToken | Ref;
|
1986
2023
|
export interface FontSizes {
|
2024
|
+
"3xs"?: FontSizeType | FontSizeToken | Ref;
|
2025
|
+
"2xs"?: FontSizeType | FontSizeToken | Ref;
|
1987
2026
|
xs?: FontSizeType | FontSizeToken | Ref;
|
1988
2027
|
sm?: FontSizeType | FontSizeToken | Ref;
|
1989
2028
|
md?: FontSizeType | FontSizeToken | Ref;
|
@@ -2049,11 +2088,63 @@ export interface ResolvedColor {
|
|
2049
2088
|
hex_value: string;
|
2050
2089
|
ref?: string;
|
2051
2090
|
}
|
2052
|
-
export
|
2091
|
+
export type BorderWidth = CssValue | Ref;
|
2092
|
+
export declare enum BorderStyle {
|
2093
|
+
solid = "solid",
|
2094
|
+
dashed = "dashed",
|
2095
|
+
dotted = "dotted"
|
2096
|
+
}
|
2097
|
+
export declare enum BorderRadiusType {
|
2053
2098
|
none = "none",
|
2054
|
-
|
2055
|
-
|
2056
|
-
|
2099
|
+
sm = "sm",
|
2100
|
+
md = "md",
|
2101
|
+
lg = "lg",
|
2102
|
+
xl = "xl",
|
2103
|
+
"2xl" = "2xl",
|
2104
|
+
full = "full"
|
2105
|
+
}
|
2106
|
+
export type BorderRadius = BorderRadiusType | CssValue | Ref;
|
2107
|
+
export interface ResolvedPaddingToken {
|
2108
|
+
ref?: string;
|
2109
|
+
px_value: number;
|
2110
|
+
}
|
2111
|
+
export interface ResolvedPaddingAll {
|
2112
|
+
all: ResolvedPaddingToken;
|
2113
|
+
}
|
2114
|
+
export interface ResolvedPaddingEdges {
|
2115
|
+
top?: ResolvedPaddingToken;
|
2116
|
+
right?: ResolvedPaddingToken;
|
2117
|
+
bottom?: ResolvedPaddingToken;
|
2118
|
+
left?: ResolvedPaddingToken;
|
2119
|
+
}
|
2120
|
+
export interface ResolvedPaddingDirectional {
|
2121
|
+
vertical: ResolvedPaddingToken;
|
2122
|
+
horizontal: ResolvedPaddingToken;
|
2123
|
+
}
|
2124
|
+
export type ResolvedPadding = ResolvedPaddingAll | ResolvedPaddingEdges | ResolvedPaddingDirectional;
|
2125
|
+
export interface EmojiBase {
|
2126
|
+
background_color?: ResolvedColor;
|
2127
|
+
color?: ResolvedColor;
|
2128
|
+
border_width?: CssValue | Ref;
|
2129
|
+
border_style?: BorderStyle;
|
2130
|
+
border_color?: ResolvedColor;
|
2131
|
+
border_radius?: BorderRadiusType | CssValue | Ref;
|
2132
|
+
padding?: ResolvedPaddingAll | ResolvedPaddingEdges | ResolvedPaddingDirectional;
|
2133
|
+
alpha?: number;
|
2134
|
+
}
|
2135
|
+
export interface EmojiVariantStates {
|
2136
|
+
hover: EmojiBase;
|
2137
|
+
active: EmojiBase;
|
2138
|
+
focus: EmojiBase;
|
2139
|
+
disabled: EmojiBase;
|
2140
|
+
}
|
2141
|
+
export interface EmojiVariant {
|
2142
|
+
base?: EmojiBase;
|
2143
|
+
states: EmojiVariantStates;
|
2144
|
+
}
|
2145
|
+
export interface EmojiVariants {
|
2146
|
+
primary: EmojiVariant;
|
2147
|
+
secondary: EmojiVariant;
|
2057
2148
|
}
|
2058
2149
|
export interface ResolvedRemValue {
|
2059
2150
|
ref?: string;
|
@@ -2072,6 +2163,30 @@ export interface ResolvedFontWeight {
|
|
2072
2163
|
ref?: string;
|
2073
2164
|
value: number;
|
2074
2165
|
}
|
2166
|
+
export interface EmojiSize {
|
2167
|
+
font_size?: ResolvedRemValue | ResolvedPxValue | ResolvedEmValue;
|
2168
|
+
font_weight?: ResolvedFontWeight;
|
2169
|
+
padding?: ResolvedPaddingAll | ResolvedPaddingEdges | ResolvedPaddingDirectional;
|
2170
|
+
border_radius?: BorderRadiusType | CssValue | Ref;
|
2171
|
+
}
|
2172
|
+
export interface EmojiSizes {
|
2173
|
+
xs: EmojiSize;
|
2174
|
+
sm: EmojiSize;
|
2175
|
+
md: EmojiSize;
|
2176
|
+
lg: EmojiSize;
|
2177
|
+
xl: EmojiSize;
|
2178
|
+
}
|
2179
|
+
export interface EmojiTheme {
|
2180
|
+
base: EmojiBase;
|
2181
|
+
variants: EmojiVariants;
|
2182
|
+
sizes: EmojiSizes;
|
2183
|
+
}
|
2184
|
+
export declare enum TextTransform {
|
2185
|
+
none = "none",
|
2186
|
+
uppercase = "uppercase",
|
2187
|
+
lowercase = "lowercase",
|
2188
|
+
capitalize = "capitalize"
|
2189
|
+
}
|
2075
2190
|
export interface ResolvedMarginToken {
|
2076
2191
|
ref?: string;
|
2077
2192
|
px_value: number;
|
@@ -2090,24 +2205,6 @@ export interface ResolvedMarginDirectional {
|
|
2090
2205
|
horizontal: ResolvedMarginToken;
|
2091
2206
|
}
|
2092
2207
|
export type ResolvedMargin = ResolvedMarginAll | ResolvedMarginEdges | ResolvedMarginDirectional;
|
2093
|
-
export interface ResolvedPaddingToken {
|
2094
|
-
ref?: string;
|
2095
|
-
px_value: number;
|
2096
|
-
}
|
2097
|
-
export interface ResolvedPaddingAll {
|
2098
|
-
all: ResolvedPaddingToken;
|
2099
|
-
}
|
2100
|
-
export interface ResolvedPaddingEdges {
|
2101
|
-
top?: ResolvedPaddingToken;
|
2102
|
-
right?: ResolvedPaddingToken;
|
2103
|
-
bottom?: ResolvedPaddingToken;
|
2104
|
-
left?: ResolvedPaddingToken;
|
2105
|
-
}
|
2106
|
-
export interface ResolvedPaddingDirectional {
|
2107
|
-
vertical: ResolvedPaddingToken;
|
2108
|
-
horizontal: ResolvedPaddingToken;
|
2109
|
-
}
|
2110
|
-
export type ResolvedPadding = ResolvedPaddingAll | ResolvedPaddingEdges | ResolvedPaddingDirectional;
|
2111
2208
|
export interface FormLabelTheme {
|
2112
2209
|
font_family?: FontFamilyType | FontFamilyToken | Ref;
|
2113
2210
|
color?: ResolvedColor;
|
@@ -2126,22 +2223,6 @@ export interface BackgroundTheme {
|
|
2126
2223
|
primary: ResolvedColor;
|
2127
2224
|
secondary: ResolvedColor;
|
2128
2225
|
}
|
2129
|
-
export declare enum BorderStyle {
|
2130
|
-
solid = "solid",
|
2131
|
-
dashed = "dashed",
|
2132
|
-
dotted = "dotted"
|
2133
|
-
}
|
2134
|
-
export type BorderWidth = CssValue | Ref;
|
2135
|
-
export declare enum BorderRadiusType {
|
2136
|
-
none = "none",
|
2137
|
-
sm = "sm",
|
2138
|
-
md = "md",
|
2139
|
-
lg = "lg",
|
2140
|
-
xl = "xl",
|
2141
|
-
"2xl" = "2xl",
|
2142
|
-
full = "full"
|
2143
|
-
}
|
2144
|
-
export type BorderRadius = BorderRadiusType | CssValue | Ref;
|
2145
2226
|
export interface BadgeSize {
|
2146
2227
|
font_size?: ResolvedRemValue | ResolvedPxValue | ResolvedEmValue;
|
2147
2228
|
font_weight?: ResolvedFontWeight;
|
@@ -2360,7 +2441,7 @@ export interface ResolvedZIndex {
|
|
2360
2441
|
}
|
2361
2442
|
export interface DialogBase {
|
2362
2443
|
background_color: ResolvedColor;
|
2363
|
-
padding
|
2444
|
+
padding?: ResolvedPaddingAll | ResolvedPaddingEdges | ResolvedPaddingDirectional;
|
2364
2445
|
margin?: ResolvedMarginAll | ResolvedMarginEdges | ResolvedMarginDirectional;
|
2365
2446
|
border_width?: CssValue | Ref;
|
2366
2447
|
border_style?: BorderStyle;
|
@@ -2373,6 +2454,8 @@ export interface DialogSize {
|
|
2373
2454
|
width: string | number;
|
2374
2455
|
max_width?: string | number;
|
2375
2456
|
max_height?: string | number;
|
2457
|
+
padding?: ResolvedPaddingAll | ResolvedPaddingEdges | ResolvedPaddingDirectional;
|
2458
|
+
margin?: ResolvedMarginAll | ResolvedMarginEdges | ResolvedMarginDirectional;
|
2376
2459
|
}
|
2377
2460
|
export interface DialogSizes {
|
2378
2461
|
xs: DialogSize;
|
@@ -2485,12 +2568,26 @@ export interface NavItemVariants {
|
|
2485
2568
|
secondary: NavItemVariant;
|
2486
2569
|
}
|
2487
2570
|
export interface NavItemTheme {
|
2571
|
+
base?: NavItemBase;
|
2488
2572
|
variants: NavItemVariants;
|
2489
2573
|
}
|
2574
|
+
export interface NavDropdownBase {
|
2575
|
+
background_color?: ResolvedColor;
|
2576
|
+
color?: ResolvedColor;
|
2577
|
+
border_width?: CssValue | Ref;
|
2578
|
+
border_style?: BorderStyle;
|
2579
|
+
border_color?: ResolvedColor;
|
2580
|
+
border_radius?: BorderRadiusType | CssValue | Ref;
|
2581
|
+
padding?: ResolvedPaddingAll | ResolvedPaddingEdges | ResolvedPaddingDirectional;
|
2582
|
+
}
|
2583
|
+
export interface NavDropdownTheme {
|
2584
|
+
base: NavDropdownBase;
|
2585
|
+
}
|
2490
2586
|
export interface NavTheme {
|
2491
2587
|
base: NavBase;
|
2492
2588
|
states: NavStates;
|
2493
2589
|
items: NavItemTheme;
|
2590
|
+
dropdown?: NavDropdownTheme;
|
2494
2591
|
}
|
2495
2592
|
export interface MenuBase {
|
2496
2593
|
background_color?: ResolvedColor;
|
@@ -2713,6 +2810,7 @@ export interface TypographyTheme {
|
|
2713
2810
|
sizes: TypographySizes;
|
2714
2811
|
}
|
2715
2812
|
export interface ResolvedComponents {
|
2813
|
+
emoji: EmojiTheme;
|
2716
2814
|
form: FormTheme;
|
2717
2815
|
background: BackgroundTheme;
|
2718
2816
|
badge: BadgeTheme;
|
@@ -3835,7 +3933,7 @@ export interface AppVideo {
|
|
3835
3933
|
reaction_options?: Array<ReactionOptionGroup>;
|
3836
3934
|
reactions?: Array<ReactionSummary>;
|
3837
3935
|
comments?: CommentSummary;
|
3838
|
-
products?: Array<
|
3936
|
+
products?: Array<AppProductStub>;
|
3839
3937
|
sponsors?: Array<AppSponsor>;
|
3840
3938
|
content?: Content;
|
3841
3939
|
}
|
package/dist/ParraAPI.js
CHANGED
@@ -11,9 +11,9 @@ var __assign = (this && this.__assign) || function () {
|
|
11
11
|
return __assign.apply(this, arguments);
|
12
12
|
};
|
13
13
|
Object.defineProperty(exports, "__esModule", { value: true });
|
14
|
-
exports.
|
15
|
-
exports.
|
16
|
-
exports.PolicyDocumentVersionStatus = exports.PolicyDocumentStatus = exports.MailTemplateStatus = void 0;
|
14
|
+
exports.QrCodeStyle = exports.QrCodeLogoPaddingStyle = exports.TextTransform = exports.BorderRadiusType = exports.BorderStyle = exports.FontFamilyType = exports.FontWeightType = exports.FontSizeType = exports.ParraTemplateType = exports.AttachmentType = exports.ChannelMemberRole = exports.ChannelMemberType = exports.ChatChannelStatus = exports.ChatChannelType = exports.BillingSourceType = exports.ApplePurchaseType = exports.ApplePurchaseEnvironment = exports.PurchaseEnvironment = exports.PurchasePlatform = exports.PurchaseStatus = exports.PurchaseType = exports.PaywallIapType = exports.AppPaywallType = exports.ShareAssetType = exports.DesignTokenType = exports.ThemeCornerRadiusStyle = exports.ContentType = exports.CtaType = exports.Interval = exports.Currency = exports.ProductType = exports.ReactionType = exports.ArticleStatus = exports.TagPool = exports.FeedbackFormFieldType = exports.ContentCardActionType = exports.IdentityType = exports.PolicyDocumentType = exports.AppleSsoScope = exports.TenantBrand = exports.TenantArchetype = exports.DomainStatus = exports.DomainType = exports.ApplicationType = exports.ReleaseType = exports.ReleaseStatus = exports.TicketIconType = exports.TicketPriority = exports.TicketStatus = exports.TicketType = void 0;
|
15
|
+
exports.MailTemplateType = exports.TenantUserMetricType = exports.IntegrationScope = exports.IntegrationConnectionStatus = exports.IntegrationType = exports.ConnectedAppConnectionStatus = exports.ConnectedAppType = exports.ApiKeyType = exports.TenantOnboardingGoal = exports.DashboardChecklistItemStatus = exports.DashboardChecklistItemType = exports.RefreshTokenRotationType = exports.RefreshTokenExpirationType = exports.JwtAlgorithm = exports.GrantType = exports.ClientType = exports.PasswordlessStrategy = exports.SsoProvider = exports.SettingsItemType = exports.SubscriptionStatus = exports.ApnsPushType = exports.ApnsEnvironment = exports.ChannelType = exports.AppVersionStatus = exports.TicketDisplayStatus = exports.UserNoteStatus = exports.TicketLinkType = exports.BoardType = exports.TemplateType = exports.CampaignStatus = exports.CampaignActionDisplayType = exports.CampaignActionType = exports.CardItemDisplayType = exports.CardItemType = exports.QuestionKind = exports.QuestionType = exports.SubmitCommentReviewStatus = exports.CommentReviewStatus = exports.FeedChannelType = exports.FeedItemType = exports.SocialAccountType = exports.CreatorUpdateGiveawayCriteria = exports.CreatorUpdateChannelType = exports.CreatorUpdateStatus = exports.CreatorUpdateVisibilityType = exports.CreatorUpdateTopic = exports.LessonType = exports.TextAlign = exports.HeadingTag = exports.QrCodeEcLevel = void 0;
|
16
|
+
exports.PolicyDocumentVersionStatus = exports.PolicyDocumentStatus = exports.MailTemplateStatus = exports.MailTemplateVersionStatus = void 0;
|
17
17
|
var TicketType;
|
18
18
|
(function (TicketType) {
|
19
19
|
TicketType["bug"] = "bug";
|
@@ -139,6 +139,11 @@ var ReactionType;
|
|
139
139
|
ReactionType["emoji"] = "emoji";
|
140
140
|
ReactionType["custom"] = "custom";
|
141
141
|
})(ReactionType || (exports.ReactionType = ReactionType = {}));
|
142
|
+
var ProductType;
|
143
|
+
(function (ProductType) {
|
144
|
+
ProductType["digital"] = "digital";
|
145
|
+
ProductType["external"] = "external";
|
146
|
+
})(ProductType || (exports.ProductType = ProductType = {}));
|
142
147
|
var Currency;
|
143
148
|
(function (Currency) {
|
144
149
|
Currency["usd"] = "usd";
|
@@ -292,13 +297,6 @@ var FontFamilyType;
|
|
292
297
|
FontFamilyType["heading"] = "heading";
|
293
298
|
FontFamilyType["monospace"] = "monospace";
|
294
299
|
})(FontFamilyType || (exports.FontFamilyType = FontFamilyType = {}));
|
295
|
-
var TextTransform;
|
296
|
-
(function (TextTransform) {
|
297
|
-
TextTransform["none"] = "none";
|
298
|
-
TextTransform["uppercase"] = "uppercase";
|
299
|
-
TextTransform["lowercase"] = "lowercase";
|
300
|
-
TextTransform["capitalize"] = "capitalize";
|
301
|
-
})(TextTransform || (exports.TextTransform = TextTransform = {}));
|
302
300
|
var BorderStyle;
|
303
301
|
(function (BorderStyle) {
|
304
302
|
BorderStyle["solid"] = "solid";
|
@@ -315,6 +313,13 @@ var BorderRadiusType;
|
|
315
313
|
BorderRadiusType["2xl"] = "2xl";
|
316
314
|
BorderRadiusType["full"] = "full";
|
317
315
|
})(BorderRadiusType || (exports.BorderRadiusType = BorderRadiusType = {}));
|
316
|
+
var TextTransform;
|
317
|
+
(function (TextTransform) {
|
318
|
+
TextTransform["none"] = "none";
|
319
|
+
TextTransform["uppercase"] = "uppercase";
|
320
|
+
TextTransform["lowercase"] = "lowercase";
|
321
|
+
TextTransform["capitalize"] = "capitalize";
|
322
|
+
})(TextTransform || (exports.TextTransform = TextTransform = {}));
|
318
323
|
var QrCodeLogoPaddingStyle;
|
319
324
|
(function (QrCodeLogoPaddingStyle) {
|
320
325
|
QrCodeLogoPaddingStyle["square"] = "square";
|