@parra/parra-js-sdk 0.3.362 → 0.3.363
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 +106 -15
- package/dist/ParraAPI.js +46 -6
- package/package.json +1 -1
package/dist/ParraAPI.d.ts
CHANGED
@@ -1008,19 +1008,46 @@ export interface FaqSectionItemStub {
|
|
1008
1008
|
faq_id: string;
|
1009
1009
|
section_id: string;
|
1010
1010
|
}
|
1011
|
-
export interface
|
1011
|
+
export interface CreatorUpdateSender {
|
1012
1012
|
id: string;
|
1013
|
-
|
1014
|
-
|
1015
|
-
|
1016
|
-
|
1013
|
+
created_at: string;
|
1014
|
+
updated_at: string;
|
1015
|
+
deleted_at?: string | null;
|
1016
|
+
tenant_id: string;
|
1017
|
+
name: string;
|
1018
|
+
avatar?: ImageAssetStub | null;
|
1019
|
+
verified?: boolean;
|
1017
1020
|
}
|
1018
|
-
export interface
|
1019
|
-
|
1020
|
-
|
1021
|
-
|
1022
|
-
|
1023
|
-
|
1021
|
+
export interface CreatorUpdateSenderCollectionResponse {
|
1022
|
+
page: number;
|
1023
|
+
page_count: number;
|
1024
|
+
page_size: number;
|
1025
|
+
total_count: number;
|
1026
|
+
data: Array<CreatorUpdateSender>;
|
1027
|
+
}
|
1028
|
+
export interface CreateCreatorUpdateSenderRequestBody {
|
1029
|
+
name: string;
|
1030
|
+
avatar?: ImageAssetStub | null;
|
1031
|
+
verified: boolean;
|
1032
|
+
}
|
1033
|
+
export interface UpdateCreatorUpdateSenderRequestBody {
|
1034
|
+
name?: string;
|
1035
|
+
avatar?: ImageAssetStub | null;
|
1036
|
+
verified?: boolean;
|
1037
|
+
}
|
1038
|
+
export declare enum CreatorUpdateVisibilityType {
|
1039
|
+
public = "public",
|
1040
|
+
private = "private"
|
1041
|
+
}
|
1042
|
+
export interface CreateCreatorUpdateTemplateRequestBody {
|
1043
|
+
name: string;
|
1044
|
+
description?: string | null;
|
1045
|
+
sender_id: string;
|
1046
|
+
feed_view_id: string;
|
1047
|
+
notification_template_id: string;
|
1048
|
+
entitlement_id?: string | null;
|
1049
|
+
post_visibility?: CreatorUpdateVisibilityType;
|
1050
|
+
attachment_visibility?: CreatorUpdateVisibilityType;
|
1024
1051
|
}
|
1025
1052
|
export declare enum CreatorUpdateStatus {
|
1026
1053
|
draft = "draft",
|
@@ -1036,10 +1063,6 @@ export interface CreatorUpdateAttachmentStub {
|
|
1036
1063
|
id: string;
|
1037
1064
|
image?: ImageAssetStub | null;
|
1038
1065
|
}
|
1039
|
-
export declare enum CreatorUpdateVisibilityType {
|
1040
|
-
public = "public",
|
1041
|
-
private = "private"
|
1042
|
-
}
|
1043
1066
|
export interface CreatorUpdateVisibility {
|
1044
1067
|
entitlement_id?: string | null;
|
1045
1068
|
post_visibility: CreatorUpdateVisibilityType;
|
@@ -1084,6 +1107,50 @@ export interface CreatorUpdate {
|
|
1084
1107
|
visibility: CreatorUpdateVisibility;
|
1085
1108
|
channels: Array<CreatorUpdateChannel>;
|
1086
1109
|
}
|
1110
|
+
export interface CreatorUpdateTemplate {
|
1111
|
+
id: string;
|
1112
|
+
created_at: string;
|
1113
|
+
updated_at: string;
|
1114
|
+
deleted_at?: string | null;
|
1115
|
+
tenant_id: string;
|
1116
|
+
sender_id?: string;
|
1117
|
+
feed_view_id?: string;
|
1118
|
+
notification_template_id?: string;
|
1119
|
+
name: string;
|
1120
|
+
description?: string;
|
1121
|
+
visibility: CreatorUpdateVisibility;
|
1122
|
+
}
|
1123
|
+
export interface CreatorUpdateTemplateCollectionResponse {
|
1124
|
+
page: number;
|
1125
|
+
page_count: number;
|
1126
|
+
page_size: number;
|
1127
|
+
total_count: number;
|
1128
|
+
data: Array<CreatorUpdateTemplate>;
|
1129
|
+
}
|
1130
|
+
export interface UpdateCreatorUpdateTemplateRequestBody {
|
1131
|
+
name?: string;
|
1132
|
+
description?: string | null;
|
1133
|
+
sender_id?: string;
|
1134
|
+
feed_view_id?: string;
|
1135
|
+
notification_template_id?: string;
|
1136
|
+
entitlement_id?: string | null;
|
1137
|
+
post_visibility?: CreatorUpdateVisibilityType;
|
1138
|
+
attachment_visibility?: CreatorUpdateVisibilityType;
|
1139
|
+
}
|
1140
|
+
export interface CreateCreatorAttachmentAttachmentRequestBody {
|
1141
|
+
id: string;
|
1142
|
+
size: Size;
|
1143
|
+
url: string;
|
1144
|
+
blur_hash?: string | null;
|
1145
|
+
thumbnails?: ImageAssetThumbnails | null;
|
1146
|
+
}
|
1147
|
+
export interface CreateCreatorUpdateRequestBody {
|
1148
|
+
publish?: boolean | null;
|
1149
|
+
template_id?: string | null;
|
1150
|
+
title: string;
|
1151
|
+
body?: string | null;
|
1152
|
+
attachments?: Array<CreateCreatorAttachmentAttachmentRequestBody>;
|
1153
|
+
}
|
1087
1154
|
export interface CreatorUpdateCollectionResponse {
|
1088
1155
|
page: number;
|
1089
1156
|
page_count: number;
|
@@ -3937,6 +4004,30 @@ declare class ParraAPI {
|
|
3937
4004
|
deleteFaqSectionById: (tenant_id: string, faq_view_id: string, faq_section_id: string, options?: Options) => Promise<Response>;
|
3938
4005
|
addFaqToSection: (tenant_id: string, faq_view_id: string, faq_section_id: string, body: AddFaqToSectionRequestBody, options?: Options) => Promise<FaqSectionItemStub>;
|
3939
4006
|
removeFaqFromSection: (tenant_id: string, faq_view_id: string, faq_section_id: string, faq_section_item_id: string, options?: Options) => Promise<Response>;
|
4007
|
+
paginateCreatorUpdateSendersForTenant: (tenant_id: string, query?: {
|
4008
|
+
$select?: string;
|
4009
|
+
$top?: number;
|
4010
|
+
$skip?: number;
|
4011
|
+
$orderby?: string;
|
4012
|
+
$filter?: string;
|
4013
|
+
$expand?: string;
|
4014
|
+
$search?: string;
|
4015
|
+
}, options?: Options) => Promise<CreatorUpdateSenderCollectionResponse>;
|
4016
|
+
createCreatorUpdateSenderForTenant: (tenant_id: string, body: CreateCreatorUpdateSenderRequestBody, options?: Options) => Promise<CreatorUpdateSender>;
|
4017
|
+
updateCreatorUpdateSenderById: (tenant_id: string, creator_update_sender_id: string, body?: UpdateCreatorUpdateSenderRequestBody, options?: Options) => Promise<CreatorUpdateSender>;
|
4018
|
+
deleteCreatorUpdateSenderById: (tenant_id: string, creator_update_sender_id: string, options?: Options) => Promise<Response>;
|
4019
|
+
createCreatorUpdateTemplateForTenant: (tenant_id: string, body: CreateCreatorUpdateTemplateRequestBody, options?: Options) => Promise<CreatorUpdate>;
|
4020
|
+
paginateCreatorUpdateTemplatesForTenant: (tenant_id: string, query?: {
|
4021
|
+
$select?: string;
|
4022
|
+
$top?: number;
|
4023
|
+
$skip?: number;
|
4024
|
+
$orderby?: string;
|
4025
|
+
$filter?: string;
|
4026
|
+
$expand?: string;
|
4027
|
+
$search?: string;
|
4028
|
+
}, options?: Options) => Promise<CreatorUpdateTemplateCollectionResponse>;
|
4029
|
+
updateCreatorUpdateTemplateById: (tenant_id: string, creator_update_template_id: string, body?: UpdateCreatorUpdateTemplateRequestBody, options?: Options) => Promise<CreatorUpdateTemplate>;
|
4030
|
+
deleteCreatorUpdateTemplateById: (tenant_id: string, creator_update_template_id: string, options?: Options) => Promise<Response>;
|
3940
4031
|
createCreatorUpdateForTenant: (tenant_id: string, body: CreateCreatorUpdateRequestBody, options?: Options) => Promise<CreatorUpdate>;
|
3941
4032
|
paginateCreatorUpdatesForTenant: (tenant_id: string, query?: {
|
3942
4033
|
$select?: string;
|
package/dist/ParraAPI.js
CHANGED
@@ -11,7 +11,7 @@ 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.IntegrationScope = exports.IntegrationConnectionStatus = exports.IntegrationType = exports.ConnectedAppConnectionStatus = exports.ConnectedAppType = exports.TenantOnboardingGoal = exports.DashboardChecklistItemStatus = exports.DashboardChecklistItemType = exports.RefreshTokenRotationType = exports.RefreshTokenExpirationType = exports.JwtAlgorithm = exports.GrantType = exports.PasswordlessStrategy = 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.ReactionType = exports.FeedItemType = exports.CreatorUpdateChannelType = exports.
|
14
|
+
exports.IntegrationScope = exports.IntegrationConnectionStatus = exports.IntegrationType = exports.ConnectedAppConnectionStatus = exports.ConnectedAppType = exports.TenantOnboardingGoal = exports.DashboardChecklistItemStatus = exports.DashboardChecklistItemType = exports.RefreshTokenRotationType = exports.RefreshTokenExpirationType = exports.JwtAlgorithm = exports.GrantType = exports.PasswordlessStrategy = 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.ReactionType = exports.FeedItemType = exports.CreatorUpdateChannelType = exports.CreatorUpdateStatus = exports.CreatorUpdateVisibilityType = exports.FeedbackFormFieldType = exports.BillingSourceType = exports.SubscriptionStatus = exports.Interval = exports.Currency = exports.IdentityType = exports.PolicyDocumentType = exports.DomainStatus = exports.DomainType = exports.ApplicationType = exports.ReleaseType = exports.ReleaseStatus = exports.TicketIconType = exports.TicketPriority = exports.TicketStatus = exports.TicketType = void 0;
|
15
15
|
exports.PolicyDocumentVersionStatus = exports.PolicyDocumentStatus = exports.MailTemplateStatus = exports.MailTemplateVersionStatus = exports.MailTemplateType = void 0;
|
16
16
|
var TicketType;
|
17
17
|
(function (TicketType) {
|
@@ -130,16 +130,16 @@ var FeedbackFormFieldType;
|
|
130
130
|
FeedbackFormFieldType["input"] = "input";
|
131
131
|
FeedbackFormFieldType["select"] = "select";
|
132
132
|
})(FeedbackFormFieldType || (exports.FeedbackFormFieldType = FeedbackFormFieldType = {}));
|
133
|
-
var CreatorUpdateStatus;
|
134
|
-
(function (CreatorUpdateStatus) {
|
135
|
-
CreatorUpdateStatus["draft"] = "draft";
|
136
|
-
CreatorUpdateStatus["published"] = "published";
|
137
|
-
})(CreatorUpdateStatus || (exports.CreatorUpdateStatus = CreatorUpdateStatus = {}));
|
138
133
|
var CreatorUpdateVisibilityType;
|
139
134
|
(function (CreatorUpdateVisibilityType) {
|
140
135
|
CreatorUpdateVisibilityType["public"] = "public";
|
141
136
|
CreatorUpdateVisibilityType["private"] = "private";
|
142
137
|
})(CreatorUpdateVisibilityType || (exports.CreatorUpdateVisibilityType = CreatorUpdateVisibilityType = {}));
|
138
|
+
var CreatorUpdateStatus;
|
139
|
+
(function (CreatorUpdateStatus) {
|
140
|
+
CreatorUpdateStatus["draft"] = "draft";
|
141
|
+
CreatorUpdateStatus["published"] = "published";
|
142
|
+
})(CreatorUpdateStatus || (exports.CreatorUpdateStatus = CreatorUpdateStatus = {}));
|
143
143
|
var CreatorUpdateChannelType;
|
144
144
|
(function (CreatorUpdateChannelType) {
|
145
145
|
CreatorUpdateChannelType["feed"] = "feed";
|
@@ -708,6 +708,46 @@ var ParraAPI = /** @class */ (function () {
|
|
708
708
|
if (options === void 0) { options = {}; }
|
709
709
|
return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/faqs/views/").concat(faq_view_id, "/sections/").concat(faq_section_id, "/items/").concat(faq_section_item_id), __assign({ method: "delete" }, options));
|
710
710
|
};
|
711
|
+
this.paginateCreatorUpdateSendersForTenant = function (tenant_id, query, options) {
|
712
|
+
if (options === void 0) { options = {}; }
|
713
|
+
return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/creator/updates/senders"), __assign({ method: "get", query: query }, options));
|
714
|
+
};
|
715
|
+
this.createCreatorUpdateSenderForTenant = function (tenant_id, body, options) {
|
716
|
+
if (options === void 0) { options = {}; }
|
717
|
+
return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/creator/updates/senders"), __assign({ method: "post", body: JSON.stringify(body), headers: {
|
718
|
+
"content-type": "application/json",
|
719
|
+
} }, options));
|
720
|
+
};
|
721
|
+
this.updateCreatorUpdateSenderById = function (tenant_id, creator_update_sender_id, body, options) {
|
722
|
+
if (options === void 0) { options = {}; }
|
723
|
+
return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/creator/updates/senders/").concat(creator_update_sender_id), __assign({ method: "put", body: JSON.stringify(body), headers: {
|
724
|
+
"content-type": "application/json",
|
725
|
+
} }, options));
|
726
|
+
};
|
727
|
+
this.deleteCreatorUpdateSenderById = function (tenant_id, creator_update_sender_id, options) {
|
728
|
+
if (options === void 0) { options = {}; }
|
729
|
+
return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/creator/updates/senders/").concat(creator_update_sender_id), __assign({ method: "delete" }, options));
|
730
|
+
};
|
731
|
+
this.createCreatorUpdateTemplateForTenant = function (tenant_id, body, options) {
|
732
|
+
if (options === void 0) { options = {}; }
|
733
|
+
return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/creator/updates/templates"), __assign({ method: "post", body: JSON.stringify(body), headers: {
|
734
|
+
"content-type": "application/json",
|
735
|
+
} }, options));
|
736
|
+
};
|
737
|
+
this.paginateCreatorUpdateTemplatesForTenant = function (tenant_id, query, options) {
|
738
|
+
if (options === void 0) { options = {}; }
|
739
|
+
return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/creator/updates/templates"), __assign({ method: "get", query: query }, options));
|
740
|
+
};
|
741
|
+
this.updateCreatorUpdateTemplateById = function (tenant_id, creator_update_template_id, body, options) {
|
742
|
+
if (options === void 0) { options = {}; }
|
743
|
+
return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/creator/updates/templates/").concat(creator_update_template_id), __assign({ method: "put", body: JSON.stringify(body), headers: {
|
744
|
+
"content-type": "application/json",
|
745
|
+
} }, options));
|
746
|
+
};
|
747
|
+
this.deleteCreatorUpdateTemplateById = function (tenant_id, creator_update_template_id, options) {
|
748
|
+
if (options === void 0) { options = {}; }
|
749
|
+
return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/creator/updates/templates/").concat(creator_update_template_id), __assign({ method: "delete" }, options));
|
750
|
+
};
|
711
751
|
this.createCreatorUpdateForTenant = function (tenant_id, body, options) {
|
712
752
|
if (options === void 0) { options = {}; }
|
713
753
|
return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/creator/updates"), __assign({ method: "post", body: JSON.stringify(body), headers: {
|