@gofynd/fdk-client-javascript 1.4.2-beta.2 → 1.4.2-beta.4
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/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationModel.d.ts +1742 -1726
- package/sdk/application/Cart/CartApplicationModel.js +1497 -1481
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +1917 -1917
- package/sdk/application/Catalog/CatalogApplicationModel.js +1611 -1611
- package/sdk/application/Common/CommonApplicationModel.d.ts +235 -235
- package/sdk/application/Common/CommonApplicationModel.js +172 -172
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +72 -72
- package/sdk/application/Communication/CommunicationApplicationModel.js +64 -64
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +1614 -1614
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +1151 -1151
- package/sdk/application/Content/ContentApplicationModel.d.ts +797 -797
- package/sdk/application/Content/ContentApplicationModel.js +757 -757
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +79 -79
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +84 -84
- package/sdk/application/Lead/LeadApplicationModel.d.ts +417 -417
- package/sdk/application/Lead/LeadApplicationModel.js +301 -301
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +666 -666
- package/sdk/application/Logistic/LogisticApplicationModel.js +601 -601
- package/sdk/application/Order/OrderApplicationModel.d.ts +852 -846
- package/sdk/application/Order/OrderApplicationModel.js +828 -822
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +5 -5
- package/sdk/application/Payment/PaymentApplicationClient.js +10 -10
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +2176 -2145
- package/sdk/application/Payment/PaymentApplicationModel.js +1474 -1453
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
- package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +1462 -1462
- package/sdk/application/PosCart/PosCartApplicationModel.js +1260 -1260
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +214 -214
- package/sdk/application/Rewards/RewardsApplicationModel.js +211 -211
- package/sdk/application/Share/ShareApplicationModel.d.ts +114 -114
- package/sdk/application/Share/ShareApplicationModel.js +121 -121
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +895 -895
- package/sdk/application/Theme/ThemeApplicationModel.js +684 -684
- package/sdk/application/User/UserApplicationClient.d.ts +2 -2
- package/sdk/application/User/UserApplicationClient.js +4 -7
- package/sdk/application/User/UserApplicationModel.d.ts +769 -764
- package/sdk/application/User/UserApplicationModel.js +731 -741
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +63 -63
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +65 -65
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +661 -661
- package/sdk/partner/Lead/LeadPartnerModel.js +491 -491
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +223 -223
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +235 -235
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +1087 -1087
- package/sdk/partner/Theme/ThemePartnerModel.js +819 -819
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +386 -386
- package/sdk/partner/Webhook/WebhookPartnerModel.js +342 -342
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +123 -123
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +109 -109
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +801 -801
- package/sdk/platform/Billing/BillingPlatformModel.js +783 -783
- package/sdk/platform/Cart/CartPlatformModel.d.ts +3333 -3317
- package/sdk/platform/Cart/CartPlatformModel.js +2936 -2920
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +26 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +182 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +70 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +44 -0
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1013 -980
- package/sdk/platform/Catalog/CatalogPlatformModel.js +977 -933
- package/sdk/platform/Common/CommonPlatformModel.d.ts +255 -255
- package/sdk/platform/Common/CommonPlatformModel.js +187 -187
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +1238 -1238
- package/sdk/platform/Communication/CommunicationPlatformModel.js +1273 -1273
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +661 -661
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +692 -692
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +3198 -3198
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2247 -2247
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1842 -1825
- package/sdk/platform/Content/ContentPlatformModel.js +1868 -1848
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +245 -245
- package/sdk/platform/Discount/DiscountPlatformModel.js +248 -248
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +2 -0
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +2 -0
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +7 -4
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +882 -869
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +894 -878
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +1044 -1044
- package/sdk/platform/Finance/FinancePlatformModel.js +974 -974
- package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +942 -942
- package/sdk/platform/Inventory/InventoryPlatformModel.js +1003 -1003
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +608 -608
- package/sdk/platform/Lead/LeadPlatformModel.js +465 -465
- package/sdk/platform/Order/OrderPlatformModel.d.ts +5192 -5176
- package/sdk/platform/Order/OrderPlatformModel.js +4752 -4736
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +22 -22
- package/sdk/platform/Partner/PartnerPlatformModel.js +22 -22
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2693 -2657
- package/sdk/platform/Payment/PaymentPlatformModel.js +1842 -1819
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +204 -204
- package/sdk/platform/Rewards/RewardsPlatformModel.js +199 -199
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +7 -6
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +11 -10
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1674 -1539
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1663 -1534
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +4 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +4 -4
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Share/SharePlatformApplicationClient.js +19 -6
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +13 -3
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +6 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +147 -147
- package/sdk/platform/Share/SharePlatformModel.js +139 -139
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +1046 -1046
- package/sdk/platform/Theme/ThemePlatformModel.js +789 -789
- package/sdk/platform/User/UserPlatformModel.d.ts +823 -753
- package/sdk/platform/User/UserPlatformModel.js +731 -661
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +439 -439
- package/sdk/platform/Webhook/WebhookPlatformModel.js +364 -364
- package/sdk/public/Billing/BillingPublicModel.d.ts +55 -55
- package/sdk/public/Billing/BillingPublicModel.js +51 -51
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +237 -237
- package/sdk/public/Configuration/ConfigurationPublicModel.js +174 -174
- package/sdk/public/Content/ContentPublicModel.d.ts +26 -26
- package/sdk/public/Content/ContentPublicModel.js +28 -28
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +237 -237
- package/sdk/public/Inventory/InventoryPublicModel.js +257 -257
- package/sdk/public/Partner/PartnerPublicModel.d.ts +104 -104
- package/sdk/public/Partner/PartnerPublicModel.js +113 -113
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +87 -87
- package/sdk/public/Webhook/WebhookPublicModel.js +93 -93
|
@@ -1,17 +1,4 @@
|
|
|
1
1
|
export = ShareApplicationModel;
|
|
2
|
-
/**
|
|
3
|
-
* @typedef Attribution
|
|
4
|
-
* @property {string} [campaign_cookie_expiry]
|
|
5
|
-
*/
|
|
6
|
-
/**
|
|
7
|
-
* @typedef CampaignShortLink
|
|
8
|
-
* @property {string} [medium]
|
|
9
|
-
* @property {string} [source]
|
|
10
|
-
*/
|
|
11
|
-
/**
|
|
12
|
-
* @typedef ErrorRes
|
|
13
|
-
* @property {string} [message]
|
|
14
|
-
*/
|
|
15
2
|
/**
|
|
16
3
|
* @typedef QRCodeResp
|
|
17
4
|
* @property {string} [link]
|
|
@@ -22,89 +9,86 @@ export = ShareApplicationModel;
|
|
|
22
9
|
* @property {string} [link]
|
|
23
10
|
* @property {string} [type]
|
|
24
11
|
*/
|
|
12
|
+
/**
|
|
13
|
+
* @typedef WebRedirect
|
|
14
|
+
* @property {string} [link]
|
|
15
|
+
* @property {string} [type]
|
|
16
|
+
*/
|
|
25
17
|
/**
|
|
26
18
|
* @typedef Redirects
|
|
27
|
-
* @property {RedirectDevice} [android]
|
|
28
|
-
* @property {boolean} [force_web]
|
|
29
19
|
* @property {RedirectDevice} [ios]
|
|
20
|
+
* @property {RedirectDevice} [android]
|
|
30
21
|
* @property {WebRedirect} [web]
|
|
22
|
+
* @property {boolean} [force_web]
|
|
23
|
+
*/
|
|
24
|
+
/**
|
|
25
|
+
* @typedef CampaignShortLink
|
|
26
|
+
* @property {string} [source]
|
|
27
|
+
* @property {string} [medium]
|
|
28
|
+
*/
|
|
29
|
+
/**
|
|
30
|
+
* @typedef Attribution
|
|
31
|
+
* @property {string} [campaign_cookie_expiry]
|
|
32
|
+
*/
|
|
33
|
+
/**
|
|
34
|
+
* @typedef SocialMediaTags
|
|
35
|
+
* @property {string} [title]
|
|
36
|
+
* @property {string} [description]
|
|
37
|
+
* @property {string} [image]
|
|
31
38
|
*/
|
|
32
39
|
/**
|
|
33
40
|
* @typedef ShortLinkReq
|
|
41
|
+
* @property {string} title - Give a name to the link.
|
|
42
|
+
* @property {string} url - The web address to shorten.
|
|
43
|
+
* @property {string} [hash]
|
|
34
44
|
* @property {boolean} [active]
|
|
35
|
-
* @property {Attribution} [attribution]
|
|
36
|
-
* @property {CampaignShortLink} [campaign]
|
|
37
|
-
* @property {number} [count]
|
|
38
|
-
* @property {boolean} [enable_tracking]
|
|
39
45
|
* @property {string} [expire_at]
|
|
40
|
-
* @property {
|
|
46
|
+
* @property {boolean} [enable_tracking]
|
|
41
47
|
* @property {boolean} [personalized] - To create personalized short links.
|
|
48
|
+
* @property {CampaignShortLink} [campaign]
|
|
42
49
|
* @property {Redirects} [redirects]
|
|
50
|
+
* @property {Attribution} [attribution]
|
|
43
51
|
* @property {SocialMediaTags} [social_media_tags]
|
|
44
|
-
* @property {
|
|
45
|
-
|
|
52
|
+
* @property {number} [count]
|
|
53
|
+
*/
|
|
54
|
+
/**
|
|
55
|
+
* @typedef UrlInfo
|
|
56
|
+
* @property {string} [original]
|
|
57
|
+
* @property {string} [short]
|
|
58
|
+
* @property {string} [hash]
|
|
46
59
|
*/
|
|
47
60
|
/**
|
|
48
61
|
* @typedef ShortLinkRes
|
|
49
|
-
* @property {string} [
|
|
50
|
-
* @property {
|
|
51
|
-
* @property {boolean} [app_redirect]
|
|
52
|
-
* @property {string} [application]
|
|
53
|
-
* @property {Attribution} [attribution]
|
|
54
|
-
* @property {CampaignShortLink} [campaign]
|
|
55
|
-
* @property {number} [count]
|
|
56
|
-
* @property {string} [created_at]
|
|
62
|
+
* @property {string} [title]
|
|
63
|
+
* @property {UrlInfo} [url]
|
|
57
64
|
* @property {string} [created_by]
|
|
65
|
+
* @property {boolean} [app_redirect]
|
|
66
|
+
* @property {string} [fallback]
|
|
67
|
+
* @property {boolean} [active]
|
|
68
|
+
* @property {string} [_id]
|
|
58
69
|
* @property {boolean} [enable_tracking]
|
|
59
70
|
* @property {string} [expire_at]
|
|
60
|
-
* @property {string} [
|
|
71
|
+
* @property {string} [application]
|
|
72
|
+
* @property {string} [user_id]
|
|
73
|
+
* @property {string} [created_at]
|
|
61
74
|
* @property {Object} [meta]
|
|
75
|
+
* @property {string} [updated_at]
|
|
62
76
|
* @property {boolean} [personalized] - To create personalized short links
|
|
77
|
+
* @property {CampaignShortLink} [campaign]
|
|
63
78
|
* @property {Redirects} [redirects]
|
|
79
|
+
* @property {Attribution} [attribution]
|
|
64
80
|
* @property {SocialMediaTags} [social_media_tags]
|
|
65
|
-
* @property {
|
|
66
|
-
* @property {string} [updated_at]
|
|
67
|
-
* @property {UrlInfo} [url]
|
|
68
|
-
* @property {string} [user_id]
|
|
69
|
-
*/
|
|
70
|
-
/**
|
|
71
|
-
* @typedef SocialMediaTags
|
|
72
|
-
* @property {string} [description]
|
|
73
|
-
* @property {string} [image]
|
|
74
|
-
* @property {string} [title]
|
|
75
|
-
*/
|
|
76
|
-
/**
|
|
77
|
-
* @typedef UrlInfo
|
|
78
|
-
* @property {string} [hash]
|
|
79
|
-
* @property {string} [original]
|
|
80
|
-
* @property {string} [short]
|
|
81
|
+
* @property {number} [count]
|
|
81
82
|
*/
|
|
82
83
|
/**
|
|
83
|
-
* @typedef
|
|
84
|
-
* @property {string} [
|
|
85
|
-
* @property {string} [type]
|
|
84
|
+
* @typedef ErrorRes
|
|
85
|
+
* @property {string} [message]
|
|
86
86
|
*/
|
|
87
87
|
declare class ShareApplicationModel {
|
|
88
88
|
}
|
|
89
89
|
declare namespace ShareApplicationModel {
|
|
90
|
-
export {
|
|
90
|
+
export { QRCodeResp, RedirectDevice, WebRedirect, Redirects, CampaignShortLink, Attribution, SocialMediaTags, ShortLinkReq, UrlInfo, ShortLinkRes, ErrorRes };
|
|
91
91
|
}
|
|
92
|
-
/** @returns {Attribution} */
|
|
93
|
-
declare function Attribution(): Attribution;
|
|
94
|
-
type Attribution = {
|
|
95
|
-
campaign_cookie_expiry?: string;
|
|
96
|
-
};
|
|
97
|
-
/** @returns {CampaignShortLink} */
|
|
98
|
-
declare function CampaignShortLink(): CampaignShortLink;
|
|
99
|
-
type CampaignShortLink = {
|
|
100
|
-
medium?: string;
|
|
101
|
-
source?: string;
|
|
102
|
-
};
|
|
103
|
-
/** @returns {ErrorRes} */
|
|
104
|
-
declare function ErrorRes(): ErrorRes;
|
|
105
|
-
type ErrorRes = {
|
|
106
|
-
message?: string;
|
|
107
|
-
};
|
|
108
92
|
/** @returns {QRCodeResp} */
|
|
109
93
|
declare function QRCodeResp(): QRCodeResp;
|
|
110
94
|
type QRCodeResp = {
|
|
@@ -117,30 +101,41 @@ type RedirectDevice = {
|
|
|
117
101
|
link?: string;
|
|
118
102
|
type?: string;
|
|
119
103
|
};
|
|
104
|
+
/** @returns {WebRedirect} */
|
|
105
|
+
declare function WebRedirect(): WebRedirect;
|
|
106
|
+
type WebRedirect = {
|
|
107
|
+
link?: string;
|
|
108
|
+
type?: string;
|
|
109
|
+
};
|
|
120
110
|
/** @returns {Redirects} */
|
|
121
111
|
declare function Redirects(): Redirects;
|
|
122
112
|
type Redirects = {
|
|
123
|
-
android?: RedirectDevice;
|
|
124
|
-
force_web?: boolean;
|
|
125
113
|
ios?: RedirectDevice;
|
|
114
|
+
android?: RedirectDevice;
|
|
126
115
|
web?: WebRedirect;
|
|
116
|
+
force_web?: boolean;
|
|
117
|
+
};
|
|
118
|
+
/** @returns {CampaignShortLink} */
|
|
119
|
+
declare function CampaignShortLink(): CampaignShortLink;
|
|
120
|
+
type CampaignShortLink = {
|
|
121
|
+
source?: string;
|
|
122
|
+
medium?: string;
|
|
123
|
+
};
|
|
124
|
+
/** @returns {Attribution} */
|
|
125
|
+
declare function Attribution(): Attribution;
|
|
126
|
+
type Attribution = {
|
|
127
|
+
campaign_cookie_expiry?: string;
|
|
128
|
+
};
|
|
129
|
+
/** @returns {SocialMediaTags} */
|
|
130
|
+
declare function SocialMediaTags(): SocialMediaTags;
|
|
131
|
+
type SocialMediaTags = {
|
|
132
|
+
title?: string;
|
|
133
|
+
description?: string;
|
|
134
|
+
image?: string;
|
|
127
135
|
};
|
|
128
136
|
/** @returns {ShortLinkReq} */
|
|
129
137
|
declare function ShortLinkReq(): ShortLinkReq;
|
|
130
138
|
type ShortLinkReq = {
|
|
131
|
-
active?: boolean;
|
|
132
|
-
attribution?: Attribution;
|
|
133
|
-
campaign?: CampaignShortLink;
|
|
134
|
-
count?: number;
|
|
135
|
-
enable_tracking?: boolean;
|
|
136
|
-
expire_at?: string;
|
|
137
|
-
hash?: string;
|
|
138
|
-
/**
|
|
139
|
-
* - To create personalized short links.
|
|
140
|
-
*/
|
|
141
|
-
personalized?: boolean;
|
|
142
|
-
redirects?: Redirects;
|
|
143
|
-
social_media_tags?: SocialMediaTags;
|
|
144
139
|
/**
|
|
145
140
|
* - Give a name to the link.
|
|
146
141
|
*/
|
|
@@ -149,51 +144,56 @@ type ShortLinkReq = {
|
|
|
149
144
|
* - The web address to shorten.
|
|
150
145
|
*/
|
|
151
146
|
url: string;
|
|
147
|
+
hash?: string;
|
|
148
|
+
active?: boolean;
|
|
149
|
+
expire_at?: string;
|
|
150
|
+
enable_tracking?: boolean;
|
|
151
|
+
/**
|
|
152
|
+
* - To create personalized short links.
|
|
153
|
+
*/
|
|
154
|
+
personalized?: boolean;
|
|
155
|
+
campaign?: CampaignShortLink;
|
|
156
|
+
redirects?: Redirects;
|
|
157
|
+
attribution?: Attribution;
|
|
158
|
+
social_media_tags?: SocialMediaTags;
|
|
159
|
+
count?: number;
|
|
160
|
+
};
|
|
161
|
+
/** @returns {UrlInfo} */
|
|
162
|
+
declare function UrlInfo(): UrlInfo;
|
|
163
|
+
type UrlInfo = {
|
|
164
|
+
original?: string;
|
|
165
|
+
short?: string;
|
|
166
|
+
hash?: string;
|
|
152
167
|
};
|
|
153
168
|
/** @returns {ShortLinkRes} */
|
|
154
169
|
declare function ShortLinkRes(): ShortLinkRes;
|
|
155
170
|
type ShortLinkRes = {
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
app_redirect?: boolean;
|
|
159
|
-
application?: string;
|
|
160
|
-
attribution?: Attribution;
|
|
161
|
-
campaign?: CampaignShortLink;
|
|
162
|
-
count?: number;
|
|
163
|
-
created_at?: string;
|
|
171
|
+
title?: string;
|
|
172
|
+
url?: UrlInfo;
|
|
164
173
|
created_by?: string;
|
|
174
|
+
app_redirect?: boolean;
|
|
175
|
+
fallback?: string;
|
|
176
|
+
active?: boolean;
|
|
177
|
+
_id?: string;
|
|
165
178
|
enable_tracking?: boolean;
|
|
166
179
|
expire_at?: string;
|
|
167
|
-
|
|
180
|
+
application?: string;
|
|
181
|
+
user_id?: string;
|
|
182
|
+
created_at?: string;
|
|
168
183
|
meta?: any;
|
|
184
|
+
updated_at?: string;
|
|
169
185
|
/**
|
|
170
186
|
* - To create personalized short links
|
|
171
187
|
*/
|
|
172
188
|
personalized?: boolean;
|
|
189
|
+
campaign?: CampaignShortLink;
|
|
173
190
|
redirects?: Redirects;
|
|
191
|
+
attribution?: Attribution;
|
|
174
192
|
social_media_tags?: SocialMediaTags;
|
|
175
|
-
|
|
176
|
-
updated_at?: string;
|
|
177
|
-
url?: UrlInfo;
|
|
178
|
-
user_id?: string;
|
|
179
|
-
};
|
|
180
|
-
/** @returns {SocialMediaTags} */
|
|
181
|
-
declare function SocialMediaTags(): SocialMediaTags;
|
|
182
|
-
type SocialMediaTags = {
|
|
183
|
-
description?: string;
|
|
184
|
-
image?: string;
|
|
185
|
-
title?: string;
|
|
186
|
-
};
|
|
187
|
-
/** @returns {UrlInfo} */
|
|
188
|
-
declare function UrlInfo(): UrlInfo;
|
|
189
|
-
type UrlInfo = {
|
|
190
|
-
hash?: string;
|
|
191
|
-
original?: string;
|
|
192
|
-
short?: string;
|
|
193
|
+
count?: number;
|
|
193
194
|
};
|
|
194
|
-
/** @returns {
|
|
195
|
-
declare function
|
|
196
|
-
type
|
|
197
|
-
|
|
198
|
-
type?: string;
|
|
195
|
+
/** @returns {ErrorRes} */
|
|
196
|
+
declare function ErrorRes(): ErrorRes;
|
|
197
|
+
type ErrorRes = {
|
|
198
|
+
message?: string;
|
|
199
199
|
};
|
|
@@ -1,21 +1,5 @@
|
|
|
1
1
|
const Joi = require("joi");
|
|
2
2
|
|
|
3
|
-
/**
|
|
4
|
-
* @typedef Attribution
|
|
5
|
-
* @property {string} [campaign_cookie_expiry]
|
|
6
|
-
*/
|
|
7
|
-
|
|
8
|
-
/**
|
|
9
|
-
* @typedef CampaignShortLink
|
|
10
|
-
* @property {string} [medium]
|
|
11
|
-
* @property {string} [source]
|
|
12
|
-
*/
|
|
13
|
-
|
|
14
|
-
/**
|
|
15
|
-
* @typedef ErrorRes
|
|
16
|
-
* @property {string} [message]
|
|
17
|
-
*/
|
|
18
|
-
|
|
19
3
|
/**
|
|
20
4
|
* @typedef QRCodeResp
|
|
21
5
|
* @property {string} [link]
|
|
@@ -28,97 +12,91 @@ const Joi = require("joi");
|
|
|
28
12
|
* @property {string} [type]
|
|
29
13
|
*/
|
|
30
14
|
|
|
15
|
+
/**
|
|
16
|
+
* @typedef WebRedirect
|
|
17
|
+
* @property {string} [link]
|
|
18
|
+
* @property {string} [type]
|
|
19
|
+
*/
|
|
20
|
+
|
|
31
21
|
/**
|
|
32
22
|
* @typedef Redirects
|
|
33
|
-
* @property {RedirectDevice} [android]
|
|
34
|
-
* @property {boolean} [force_web]
|
|
35
23
|
* @property {RedirectDevice} [ios]
|
|
24
|
+
* @property {RedirectDevice} [android]
|
|
36
25
|
* @property {WebRedirect} [web]
|
|
26
|
+
* @property {boolean} [force_web]
|
|
27
|
+
*/
|
|
28
|
+
|
|
29
|
+
/**
|
|
30
|
+
* @typedef CampaignShortLink
|
|
31
|
+
* @property {string} [source]
|
|
32
|
+
* @property {string} [medium]
|
|
33
|
+
*/
|
|
34
|
+
|
|
35
|
+
/**
|
|
36
|
+
* @typedef Attribution
|
|
37
|
+
* @property {string} [campaign_cookie_expiry]
|
|
38
|
+
*/
|
|
39
|
+
|
|
40
|
+
/**
|
|
41
|
+
* @typedef SocialMediaTags
|
|
42
|
+
* @property {string} [title]
|
|
43
|
+
* @property {string} [description]
|
|
44
|
+
* @property {string} [image]
|
|
37
45
|
*/
|
|
38
46
|
|
|
39
47
|
/**
|
|
40
48
|
* @typedef ShortLinkReq
|
|
49
|
+
* @property {string} title - Give a name to the link.
|
|
50
|
+
* @property {string} url - The web address to shorten.
|
|
51
|
+
* @property {string} [hash]
|
|
41
52
|
* @property {boolean} [active]
|
|
42
|
-
* @property {Attribution} [attribution]
|
|
43
|
-
* @property {CampaignShortLink} [campaign]
|
|
44
|
-
* @property {number} [count]
|
|
45
|
-
* @property {boolean} [enable_tracking]
|
|
46
53
|
* @property {string} [expire_at]
|
|
47
|
-
* @property {
|
|
54
|
+
* @property {boolean} [enable_tracking]
|
|
48
55
|
* @property {boolean} [personalized] - To create personalized short links.
|
|
56
|
+
* @property {CampaignShortLink} [campaign]
|
|
49
57
|
* @property {Redirects} [redirects]
|
|
58
|
+
* @property {Attribution} [attribution]
|
|
50
59
|
* @property {SocialMediaTags} [social_media_tags]
|
|
51
|
-
* @property {
|
|
52
|
-
|
|
60
|
+
* @property {number} [count]
|
|
61
|
+
*/
|
|
62
|
+
|
|
63
|
+
/**
|
|
64
|
+
* @typedef UrlInfo
|
|
65
|
+
* @property {string} [original]
|
|
66
|
+
* @property {string} [short]
|
|
67
|
+
* @property {string} [hash]
|
|
53
68
|
*/
|
|
54
69
|
|
|
55
70
|
/**
|
|
56
71
|
* @typedef ShortLinkRes
|
|
57
|
-
* @property {string} [
|
|
58
|
-
* @property {
|
|
59
|
-
* @property {boolean} [app_redirect]
|
|
60
|
-
* @property {string} [application]
|
|
61
|
-
* @property {Attribution} [attribution]
|
|
62
|
-
* @property {CampaignShortLink} [campaign]
|
|
63
|
-
* @property {number} [count]
|
|
64
|
-
* @property {string} [created_at]
|
|
72
|
+
* @property {string} [title]
|
|
73
|
+
* @property {UrlInfo} [url]
|
|
65
74
|
* @property {string} [created_by]
|
|
75
|
+
* @property {boolean} [app_redirect]
|
|
76
|
+
* @property {string} [fallback]
|
|
77
|
+
* @property {boolean} [active]
|
|
78
|
+
* @property {string} [_id]
|
|
66
79
|
* @property {boolean} [enable_tracking]
|
|
67
80
|
* @property {string} [expire_at]
|
|
68
|
-
* @property {string} [
|
|
81
|
+
* @property {string} [application]
|
|
82
|
+
* @property {string} [user_id]
|
|
83
|
+
* @property {string} [created_at]
|
|
69
84
|
* @property {Object} [meta]
|
|
85
|
+
* @property {string} [updated_at]
|
|
70
86
|
* @property {boolean} [personalized] - To create personalized short links
|
|
87
|
+
* @property {CampaignShortLink} [campaign]
|
|
71
88
|
* @property {Redirects} [redirects]
|
|
89
|
+
* @property {Attribution} [attribution]
|
|
72
90
|
* @property {SocialMediaTags} [social_media_tags]
|
|
73
|
-
* @property {
|
|
74
|
-
* @property {string} [updated_at]
|
|
75
|
-
* @property {UrlInfo} [url]
|
|
76
|
-
* @property {string} [user_id]
|
|
77
|
-
*/
|
|
78
|
-
|
|
79
|
-
/**
|
|
80
|
-
* @typedef SocialMediaTags
|
|
81
|
-
* @property {string} [description]
|
|
82
|
-
* @property {string} [image]
|
|
83
|
-
* @property {string} [title]
|
|
84
|
-
*/
|
|
85
|
-
|
|
86
|
-
/**
|
|
87
|
-
* @typedef UrlInfo
|
|
88
|
-
* @property {string} [hash]
|
|
89
|
-
* @property {string} [original]
|
|
90
|
-
* @property {string} [short]
|
|
91
|
+
* @property {number} [count]
|
|
91
92
|
*/
|
|
92
93
|
|
|
93
94
|
/**
|
|
94
|
-
* @typedef
|
|
95
|
-
* @property {string} [
|
|
96
|
-
* @property {string} [type]
|
|
95
|
+
* @typedef ErrorRes
|
|
96
|
+
* @property {string} [message]
|
|
97
97
|
*/
|
|
98
98
|
|
|
99
99
|
class ShareApplicationModel {
|
|
100
|
-
/** @returns {Attribution} */
|
|
101
|
-
static Attribution() {
|
|
102
|
-
return Joi.object({
|
|
103
|
-
campaign_cookie_expiry: Joi.string().allow(""),
|
|
104
|
-
});
|
|
105
|
-
}
|
|
106
|
-
|
|
107
|
-
/** @returns {CampaignShortLink} */
|
|
108
|
-
static CampaignShortLink() {
|
|
109
|
-
return Joi.object({
|
|
110
|
-
medium: Joi.string().allow(""),
|
|
111
|
-
source: Joi.string().allow(""),
|
|
112
|
-
});
|
|
113
|
-
}
|
|
114
|
-
|
|
115
|
-
/** @returns {ErrorRes} */
|
|
116
|
-
static ErrorRes() {
|
|
117
|
-
return Joi.object({
|
|
118
|
-
message: Joi.string().allow(""),
|
|
119
|
-
});
|
|
120
|
-
}
|
|
121
|
-
|
|
122
100
|
/** @returns {QRCodeResp} */
|
|
123
101
|
static QRCodeResp() {
|
|
124
102
|
return Joi.object({
|
|
@@ -135,83 +113,105 @@ class ShareApplicationModel {
|
|
|
135
113
|
});
|
|
136
114
|
}
|
|
137
115
|
|
|
116
|
+
/** @returns {WebRedirect} */
|
|
117
|
+
static WebRedirect() {
|
|
118
|
+
return Joi.object({
|
|
119
|
+
link: Joi.string().allow(""),
|
|
120
|
+
type: Joi.string().allow(""),
|
|
121
|
+
});
|
|
122
|
+
}
|
|
123
|
+
|
|
138
124
|
/** @returns {Redirects} */
|
|
139
125
|
static Redirects() {
|
|
140
126
|
return Joi.object({
|
|
141
|
-
android: ShareApplicationModel.RedirectDevice(),
|
|
142
|
-
force_web: Joi.boolean(),
|
|
143
127
|
ios: ShareApplicationModel.RedirectDevice(),
|
|
128
|
+
android: ShareApplicationModel.RedirectDevice(),
|
|
144
129
|
web: ShareApplicationModel.WebRedirect(),
|
|
130
|
+
force_web: Joi.boolean(),
|
|
145
131
|
});
|
|
146
132
|
}
|
|
147
133
|
|
|
148
|
-
/** @returns {
|
|
149
|
-
static
|
|
134
|
+
/** @returns {CampaignShortLink} */
|
|
135
|
+
static CampaignShortLink() {
|
|
150
136
|
return Joi.object({
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
campaign: ShareApplicationModel.CampaignShortLink(),
|
|
154
|
-
count: Joi.number(),
|
|
155
|
-
enable_tracking: Joi.boolean(),
|
|
156
|
-
expire_at: Joi.string().allow(""),
|
|
157
|
-
hash: Joi.string().allow(""),
|
|
158
|
-
personalized: Joi.boolean(),
|
|
159
|
-
redirects: ShareApplicationModel.Redirects(),
|
|
160
|
-
social_media_tags: ShareApplicationModel.SocialMediaTags(),
|
|
161
|
-
title: Joi.string().allow("").required(),
|
|
162
|
-
url: Joi.string().allow("").required(),
|
|
137
|
+
source: Joi.string().allow(""),
|
|
138
|
+
medium: Joi.string().allow(""),
|
|
163
139
|
});
|
|
164
140
|
}
|
|
165
141
|
|
|
166
|
-
/** @returns {
|
|
167
|
-
static
|
|
142
|
+
/** @returns {Attribution} */
|
|
143
|
+
static Attribution() {
|
|
168
144
|
return Joi.object({
|
|
169
|
-
|
|
170
|
-
active: Joi.boolean(),
|
|
171
|
-
app_redirect: Joi.boolean(),
|
|
172
|
-
application: Joi.string().allow(""),
|
|
173
|
-
attribution: ShareApplicationModel.Attribution(),
|
|
174
|
-
campaign: ShareApplicationModel.CampaignShortLink(),
|
|
175
|
-
count: Joi.number(),
|
|
176
|
-
created_at: Joi.string().allow(""),
|
|
177
|
-
created_by: Joi.string().allow(""),
|
|
178
|
-
enable_tracking: Joi.boolean(),
|
|
179
|
-
expire_at: Joi.string().allow(""),
|
|
180
|
-
fallback: Joi.string().allow(""),
|
|
181
|
-
meta: Joi.any(),
|
|
182
|
-
personalized: Joi.boolean(),
|
|
183
|
-
redirects: ShareApplicationModel.Redirects(),
|
|
184
|
-
social_media_tags: ShareApplicationModel.SocialMediaTags(),
|
|
185
|
-
title: Joi.string().allow(""),
|
|
186
|
-
updated_at: Joi.string().allow(""),
|
|
187
|
-
url: ShareApplicationModel.UrlInfo(),
|
|
188
|
-
user_id: Joi.string().allow(""),
|
|
145
|
+
campaign_cookie_expiry: Joi.string().allow(""),
|
|
189
146
|
});
|
|
190
147
|
}
|
|
191
148
|
|
|
192
149
|
/** @returns {SocialMediaTags} */
|
|
193
150
|
static SocialMediaTags() {
|
|
194
151
|
return Joi.object({
|
|
152
|
+
title: Joi.string().allow(""),
|
|
195
153
|
description: Joi.string().allow(""),
|
|
196
154
|
image: Joi.string().allow(""),
|
|
197
|
-
|
|
155
|
+
});
|
|
156
|
+
}
|
|
157
|
+
|
|
158
|
+
/** @returns {ShortLinkReq} */
|
|
159
|
+
static ShortLinkReq() {
|
|
160
|
+
return Joi.object({
|
|
161
|
+
title: Joi.string().allow("").required(),
|
|
162
|
+
url: Joi.string().allow("").required(),
|
|
163
|
+
hash: Joi.string().allow(""),
|
|
164
|
+
active: Joi.boolean(),
|
|
165
|
+
expire_at: Joi.string().allow(""),
|
|
166
|
+
enable_tracking: Joi.boolean(),
|
|
167
|
+
personalized: Joi.boolean(),
|
|
168
|
+
campaign: ShareApplicationModel.CampaignShortLink(),
|
|
169
|
+
redirects: ShareApplicationModel.Redirects(),
|
|
170
|
+
attribution: ShareApplicationModel.Attribution(),
|
|
171
|
+
social_media_tags: ShareApplicationModel.SocialMediaTags(),
|
|
172
|
+
count: Joi.number(),
|
|
198
173
|
});
|
|
199
174
|
}
|
|
200
175
|
|
|
201
176
|
/** @returns {UrlInfo} */
|
|
202
177
|
static UrlInfo() {
|
|
203
178
|
return Joi.object({
|
|
204
|
-
hash: Joi.string().allow(""),
|
|
205
179
|
original: Joi.string().allow(""),
|
|
206
180
|
short: Joi.string().allow(""),
|
|
181
|
+
hash: Joi.string().allow(""),
|
|
207
182
|
});
|
|
208
183
|
}
|
|
209
184
|
|
|
210
|
-
/** @returns {
|
|
211
|
-
static
|
|
185
|
+
/** @returns {ShortLinkRes} */
|
|
186
|
+
static ShortLinkRes() {
|
|
212
187
|
return Joi.object({
|
|
213
|
-
|
|
214
|
-
|
|
188
|
+
title: Joi.string().allow(""),
|
|
189
|
+
url: ShareApplicationModel.UrlInfo(),
|
|
190
|
+
created_by: Joi.string().allow(""),
|
|
191
|
+
app_redirect: Joi.boolean(),
|
|
192
|
+
fallback: Joi.string().allow(""),
|
|
193
|
+
active: Joi.boolean(),
|
|
194
|
+
_id: Joi.string().allow(""),
|
|
195
|
+
enable_tracking: Joi.boolean(),
|
|
196
|
+
expire_at: Joi.string().allow(""),
|
|
197
|
+
application: Joi.string().allow(""),
|
|
198
|
+
user_id: Joi.string().allow(""),
|
|
199
|
+
created_at: Joi.string().allow(""),
|
|
200
|
+
meta: Joi.any(),
|
|
201
|
+
updated_at: Joi.string().allow(""),
|
|
202
|
+
personalized: Joi.boolean(),
|
|
203
|
+
campaign: ShareApplicationModel.CampaignShortLink(),
|
|
204
|
+
redirects: ShareApplicationModel.Redirects(),
|
|
205
|
+
attribution: ShareApplicationModel.Attribution(),
|
|
206
|
+
social_media_tags: ShareApplicationModel.SocialMediaTags(),
|
|
207
|
+
count: Joi.number(),
|
|
208
|
+
});
|
|
209
|
+
}
|
|
210
|
+
|
|
211
|
+
/** @returns {ErrorRes} */
|
|
212
|
+
static ErrorRes() {
|
|
213
|
+
return Joi.object({
|
|
214
|
+
message: Joi.string().allow(""),
|
|
215
215
|
});
|
|
216
216
|
}
|
|
217
217
|
}
|