@parra/parra-js-sdk 0.3.426 → 0.3.428
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 +85 -50
- package/dist/ParraAPI.js +23 -8
- package/package.json +1 -1
package/dist/ParraAPI.d.ts
CHANGED
@@ -603,9 +603,63 @@ export interface CreateContentCardRequestBody {
|
|
603
603
|
export interface ContentCardBackground {
|
604
604
|
image: ImageAssetStub | null;
|
605
605
|
}
|
606
|
+
export declare enum ContentCardActionType {
|
607
|
+
link = "link",
|
608
|
+
feedbackForm = "feedback_form"
|
609
|
+
}
|
610
|
+
export declare enum FeedbackFormFieldType {
|
611
|
+
text = "text",
|
612
|
+
input = "input",
|
613
|
+
select = "select"
|
614
|
+
}
|
615
|
+
export interface FeedbackFormTextFieldData {
|
616
|
+
placeholder?: string | null;
|
617
|
+
lines?: number | null;
|
618
|
+
max_lines?: number | null;
|
619
|
+
min_characters?: number | null;
|
620
|
+
max_characters?: number | null;
|
621
|
+
max_height?: number | null;
|
622
|
+
}
|
623
|
+
export interface FeedbackFormSelectFieldOption {
|
624
|
+
title: string;
|
625
|
+
value: string;
|
626
|
+
is_other?: boolean;
|
627
|
+
}
|
628
|
+
export interface FeedbackFormSelectFieldData {
|
629
|
+
placeholder?: string | null;
|
630
|
+
options: Array<FeedbackFormSelectFieldOption>;
|
631
|
+
}
|
632
|
+
export interface FeedbackFormInputFieldData {
|
633
|
+
placeholder?: string | null;
|
634
|
+
}
|
635
|
+
export type FeedbackFormFieldData = FeedbackFormTextFieldData | FeedbackFormSelectFieldData | FeedbackFormInputFieldData;
|
636
|
+
export interface FeedbackFormField {
|
637
|
+
name: string;
|
638
|
+
title?: string;
|
639
|
+
helper_text?: string | null;
|
640
|
+
type: FeedbackFormFieldType;
|
641
|
+
required: boolean;
|
642
|
+
hidden?: boolean;
|
643
|
+
data: FeedbackFormFieldData;
|
644
|
+
}
|
645
|
+
export interface FeedbackFormData {
|
646
|
+
title: string;
|
647
|
+
description?: string | null;
|
648
|
+
fields: Array<FeedbackFormField>;
|
649
|
+
}
|
650
|
+
export interface FeedbackFormDataStub {
|
651
|
+
id: string;
|
652
|
+
created_at: string;
|
653
|
+
updated_at: string;
|
654
|
+
deleted_at?: string | null;
|
655
|
+
data: FeedbackFormData;
|
656
|
+
}
|
606
657
|
export interface ContentCardAction {
|
607
|
-
|
658
|
+
type: ContentCardActionType;
|
659
|
+
url?: string | null;
|
608
660
|
confirmation_message?: string | null;
|
661
|
+
form_id?: string | null;
|
662
|
+
form?: FeedbackFormDataStub | null;
|
609
663
|
}
|
610
664
|
export interface ContentCard {
|
611
665
|
id: string;
|
@@ -669,7 +723,7 @@ export interface Link {
|
|
669
723
|
short_link: string;
|
670
724
|
title?: string | null;
|
671
725
|
description?: string | null;
|
672
|
-
|
726
|
+
utm?: LinkUtmParameters | null;
|
673
727
|
proxy: boolean;
|
674
728
|
rewrite: boolean;
|
675
729
|
}
|
@@ -806,6 +860,11 @@ export declare enum AppPaywallType {
|
|
806
860
|
apple = "apple",
|
807
861
|
parra = "parra"
|
808
862
|
}
|
863
|
+
export declare enum PaywallIapType {
|
864
|
+
inAppPurchase = "in_app_purchase",
|
865
|
+
subscription = "subscription",
|
866
|
+
subscriptionGroup = "subscription_group"
|
867
|
+
}
|
809
868
|
export interface ApplePaywallMarketingContent {
|
810
869
|
title: string;
|
811
870
|
subtitle?: string | null;
|
@@ -834,6 +893,7 @@ export interface AppPaywall {
|
|
834
893
|
updated_at: string;
|
835
894
|
deleted_at?: string | null;
|
836
895
|
type: AppPaywallType;
|
896
|
+
iap_type?: PaywallIapType;
|
837
897
|
group_id?: string | null;
|
838
898
|
product_ids?: Array<string> | null;
|
839
899
|
marketing_content?: ApplePaywallMarketingContent | null;
|
@@ -1127,53 +1187,6 @@ export interface AppFaqSection {
|
|
1127
1187
|
description?: string | null;
|
1128
1188
|
items: Array<AppFaq>;
|
1129
1189
|
}
|
1130
|
-
export declare enum FeedbackFormFieldType {
|
1131
|
-
text = "text",
|
1132
|
-
input = "input",
|
1133
|
-
select = "select"
|
1134
|
-
}
|
1135
|
-
export interface FeedbackFormTextFieldData {
|
1136
|
-
placeholder?: string | null;
|
1137
|
-
lines?: number | null;
|
1138
|
-
max_lines?: number | null;
|
1139
|
-
min_characters?: number | null;
|
1140
|
-
max_characters?: number | null;
|
1141
|
-
max_height?: number | null;
|
1142
|
-
}
|
1143
|
-
export interface FeedbackFormSelectFieldOption {
|
1144
|
-
title: string;
|
1145
|
-
value: string;
|
1146
|
-
is_other?: boolean;
|
1147
|
-
}
|
1148
|
-
export interface FeedbackFormSelectFieldData {
|
1149
|
-
placeholder?: string | null;
|
1150
|
-
options: Array<FeedbackFormSelectFieldOption>;
|
1151
|
-
}
|
1152
|
-
export interface FeedbackFormInputFieldData {
|
1153
|
-
placeholder?: string | null;
|
1154
|
-
}
|
1155
|
-
export type FeedbackFormFieldData = FeedbackFormTextFieldData | FeedbackFormSelectFieldData | FeedbackFormInputFieldData;
|
1156
|
-
export interface FeedbackFormField {
|
1157
|
-
name: string;
|
1158
|
-
title?: string;
|
1159
|
-
helper_text?: string | null;
|
1160
|
-
type: FeedbackFormFieldType;
|
1161
|
-
required: boolean;
|
1162
|
-
hidden?: boolean;
|
1163
|
-
data: FeedbackFormFieldData;
|
1164
|
-
}
|
1165
|
-
export interface FeedbackFormData {
|
1166
|
-
title: string;
|
1167
|
-
description?: string | null;
|
1168
|
-
fields: Array<FeedbackFormField>;
|
1169
|
-
}
|
1170
|
-
export interface FeedbackFormDataStub {
|
1171
|
-
id: string;
|
1172
|
-
created_at: string;
|
1173
|
-
updated_at: string;
|
1174
|
-
deleted_at?: string | null;
|
1175
|
-
data: FeedbackFormData;
|
1176
|
-
}
|
1177
1190
|
export interface AppFaqView {
|
1178
1191
|
id: string;
|
1179
1192
|
created_at: string;
|
@@ -1282,8 +1295,10 @@ export interface UpdateContentCardRequestBody {
|
|
1282
1295
|
description?: string | null;
|
1283
1296
|
display_title?: string | null;
|
1284
1297
|
display_description?: string | null;
|
1298
|
+
action_type?: ContentCardActionType;
|
1285
1299
|
action_url?: string | null;
|
1286
1300
|
action_confirmation_message?: string | null;
|
1301
|
+
action_form_id?: string | null;
|
1287
1302
|
badge?: string | null;
|
1288
1303
|
}
|
1289
1304
|
export interface CreatorUpdateSender {
|
@@ -3104,11 +3119,22 @@ export interface SubdomainAvailabilityResponse {
|
|
3104
3119
|
valid: boolean;
|
3105
3120
|
message?: string | null;
|
3106
3121
|
}
|
3122
|
+
export interface LinkCollectionResponse {
|
3123
|
+
page: number;
|
3124
|
+
page_count: number;
|
3125
|
+
page_size: number;
|
3126
|
+
total_count: number;
|
3127
|
+
data: Array<Link>;
|
3128
|
+
}
|
3107
3129
|
export interface CreateLinkRequestBody {
|
3108
3130
|
domain: string;
|
3109
3131
|
key: string;
|
3110
3132
|
url: string;
|
3111
|
-
|
3133
|
+
utm_source?: string | null;
|
3134
|
+
utm_medium?: string | null;
|
3135
|
+
utm_campaign?: string | null;
|
3136
|
+
utm_term?: string | null;
|
3137
|
+
utm_content?: string | null;
|
3112
3138
|
proxy?: boolean;
|
3113
3139
|
rewrite?: boolean;
|
3114
3140
|
title?: string;
|
@@ -4837,6 +4863,15 @@ declare class ParraAPI {
|
|
4837
4863
|
deleteExternalDomainByIdForTenantById: (tenant_id: string, external_domain_id: string, options?: Options) => Promise<Response>;
|
4838
4864
|
checkExternalDomainByIdForTenantById: (tenant_id: string, external_domain_id: string, options?: Options) => Promise<ExternalDomain>;
|
4839
4865
|
checkSubdomainAvailability: (body: SubdomainAvailabilityRequestBody, options?: Options) => Promise<SubdomainAvailabilityResponse>;
|
4866
|
+
paginateLinksForTenantById: (tenant_id: string, query?: {
|
4867
|
+
$select?: string;
|
4868
|
+
$top?: number;
|
4869
|
+
$skip?: number;
|
4870
|
+
$orderby?: string;
|
4871
|
+
$filter?: string;
|
4872
|
+
$expand?: string;
|
4873
|
+
$search?: string;
|
4874
|
+
}, options?: Options) => Promise<LinkCollectionResponse>;
|
4840
4875
|
createLinkForTenantById: (tenant_id: string, body: CreateLinkRequestBody, options?: Options) => Promise<Link>;
|
4841
4876
|
updateLinkByIdForTenantById: (tenant_id: string, link_id: string, body?: UpdateLinkRequestBody, options?: Options) => Promise<Link>;
|
4842
4877
|
deleteLinkByIdForTenantById: (tenant_id: string, link_id: string, options?: Options) => Promise<Response>;
|
package/dist/ParraAPI.js
CHANGED
@@ -11,8 +11,8 @@ 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.PolicyDocumentVersionStatus = exports.PolicyDocumentStatus = exports.MailTemplateStatus = exports.MailTemplateVersionStatus = exports.MailTemplateType = exports.IntegrationScope = exports.IntegrationConnectionStatus = exports.IntegrationType = exports.ConnectedAppConnectionStatus = exports.ConnectedAppType = exports.TenantOnboardingGoal = exports.DashboardChecklistItemStatus = exports.DashboardChecklistItemType = exports.RefreshTokenRotationType = void 0;
|
14
|
+
exports.GrantType = exports.PasswordlessStrategy = exports.SsoProvider = exports.SettingsItemType = exports.ApnsPushType = exports.ApnsEnvironment = exports.ChannelType = exports.AppVersionStatus = exports.TicketDisplayStatus = exports.UserNoteStatus = exports.TicketLinkType = exports.TemplateType = exports.CampaignStatus = exports.CampaignActionDisplayType = exports.CampaignActionType = exports.CardItemDisplayType = exports.CardItemType = exports.QuestionKind = exports.QuestionType = exports.SubmitCommentReviewStatus = exports.CommentReviewStatus = exports.ReactionType = exports.FeedItemType = exports.CreatorUpdateChannelType = exports.CreatorUpdateStatus = exports.CreatorUpdateVisibilityType = exports.ChannelMemberRole = exports.ChannelMemberType = exports.ChatChannelStatus = exports.ChatChannelType = exports.BillingSourceType = exports.PaywallIapType = exports.AppPaywallType = exports.SubscriptionStatus = exports.Interval = exports.Currency = exports.FeedbackFormFieldType = exports.ContentCardActionType = exports.IdentityType = exports.PolicyDocumentType = exports.AppleSsoScope = exports.DomainStatus = exports.DomainType = exports.ApplicationType = exports.ReleaseType = exports.ReleaseStatus = exports.TicketIconType = exports.TicketPriority = exports.TicketStatus = exports.TicketType = void 0;
|
15
|
+
exports.PolicyDocumentVersionStatus = exports.PolicyDocumentStatus = exports.MailTemplateStatus = exports.MailTemplateVersionStatus = exports.MailTemplateType = exports.IntegrationScope = exports.IntegrationConnectionStatus = exports.IntegrationType = exports.ConnectedAppConnectionStatus = exports.ConnectedAppType = exports.TenantOnboardingGoal = exports.DashboardChecklistItemStatus = exports.DashboardChecklistItemType = exports.RefreshTokenRotationType = exports.RefreshTokenExpirationType = exports.JwtAlgorithm = void 0;
|
16
16
|
var TicketType;
|
17
17
|
(function (TicketType) {
|
18
18
|
TicketType["bug"] = "bug";
|
@@ -100,6 +100,17 @@ var IdentityType;
|
|
100
100
|
IdentityType["phoneNumber"] = "phone_number";
|
101
101
|
IdentityType["externalId"] = "external_id";
|
102
102
|
})(IdentityType || (exports.IdentityType = IdentityType = {}));
|
103
|
+
var ContentCardActionType;
|
104
|
+
(function (ContentCardActionType) {
|
105
|
+
ContentCardActionType["link"] = "link";
|
106
|
+
ContentCardActionType["feedbackForm"] = "feedback_form";
|
107
|
+
})(ContentCardActionType || (exports.ContentCardActionType = ContentCardActionType = {}));
|
108
|
+
var FeedbackFormFieldType;
|
109
|
+
(function (FeedbackFormFieldType) {
|
110
|
+
FeedbackFormFieldType["text"] = "text";
|
111
|
+
FeedbackFormFieldType["input"] = "input";
|
112
|
+
FeedbackFormFieldType["select"] = "select";
|
113
|
+
})(FeedbackFormFieldType || (exports.FeedbackFormFieldType = FeedbackFormFieldType = {}));
|
103
114
|
var Currency;
|
104
115
|
(function (Currency) {
|
105
116
|
Currency["usd"] = "usd";
|
@@ -124,6 +135,12 @@ var AppPaywallType;
|
|
124
135
|
AppPaywallType["apple"] = "apple";
|
125
136
|
AppPaywallType["parra"] = "parra";
|
126
137
|
})(AppPaywallType || (exports.AppPaywallType = AppPaywallType = {}));
|
138
|
+
var PaywallIapType;
|
139
|
+
(function (PaywallIapType) {
|
140
|
+
PaywallIapType["inAppPurchase"] = "in_app_purchase";
|
141
|
+
PaywallIapType["subscription"] = "subscription";
|
142
|
+
PaywallIapType["subscriptionGroup"] = "subscription_group";
|
143
|
+
})(PaywallIapType || (exports.PaywallIapType = PaywallIapType = {}));
|
127
144
|
var BillingSourceType;
|
128
145
|
(function (BillingSourceType) {
|
129
146
|
BillingSourceType["stripe"] = "stripe";
|
@@ -161,12 +178,6 @@ var ChannelMemberRole;
|
|
161
178
|
ChannelMemberRole["member"] = "member";
|
162
179
|
ChannelMemberRole["guest"] = "guest";
|
163
180
|
})(ChannelMemberRole || (exports.ChannelMemberRole = ChannelMemberRole = {}));
|
164
|
-
var FeedbackFormFieldType;
|
165
|
-
(function (FeedbackFormFieldType) {
|
166
|
-
FeedbackFormFieldType["text"] = "text";
|
167
|
-
FeedbackFormFieldType["input"] = "input";
|
168
|
-
FeedbackFormFieldType["select"] = "select";
|
169
|
-
})(FeedbackFormFieldType || (exports.FeedbackFormFieldType = FeedbackFormFieldType = {}));
|
170
181
|
var CreatorUpdateVisibilityType;
|
171
182
|
(function (CreatorUpdateVisibilityType) {
|
172
183
|
CreatorUpdateVisibilityType["public"] = "public";
|
@@ -1630,6 +1641,10 @@ var ParraAPI = /** @class */ (function () {
|
|
1630
1641
|
"content-type": "application/json",
|
1631
1642
|
} }, options));
|
1632
1643
|
};
|
1644
|
+
this.paginateLinksForTenantById = function (tenant_id, query, options) {
|
1645
|
+
if (options === void 0) { options = {}; }
|
1646
|
+
return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/links"), __assign({ method: "get", query: query }, options));
|
1647
|
+
};
|
1633
1648
|
this.createLinkForTenantById = function (tenant_id, body, options) {
|
1634
1649
|
if (options === void 0) { options = {}; }
|
1635
1650
|
return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/links"), __assign({ method: "post", body: JSON.stringify(body), headers: {
|