@gofynd/fdk-client-javascript 1.3.11-beta.7 → 1.3.11-beta.8
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/CartApplicationClient.d.ts +1 -1
- package/sdk/application/Cart/CartApplicationClient.js +5 -3
- package/sdk/application/Cart/CartApplicationModel.d.ts +107 -1
- package/sdk/application/Cart/CartApplicationModel.js +74 -0
- package/sdk/application/Cart/CartApplicationValidator.d.ts +4 -0
- package/sdk/application/Cart/CartApplicationValidator.js +4 -0
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +3 -6
- package/sdk/application/Catalog/CatalogApplicationClient.js +7 -20
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2 -2
- package/sdk/application/Catalog/CatalogApplicationModel.js +2 -2
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +0 -14
- package/sdk/application/Catalog/CatalogApplicationValidator.js +0 -6
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +183 -49
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +173 -31
- package/sdk/application/Content/ContentApplicationClient.d.ts +36 -0
- package/sdk/application/Content/ContentApplicationClient.js +246 -0
- package/sdk/application/Content/ContentApplicationModel.d.ts +208 -1
- package/sdk/application/Content/ContentApplicationModel.js +252 -0
- package/sdk/application/Content/ContentApplicationValidator.d.ts +40 -1
- package/sdk/application/Content/ContentApplicationValidator.js +41 -0
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +67 -0
- package/sdk/application/Logistic/LogisticApplicationClient.js +547 -0
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +456 -1
- package/sdk/application/Logistic/LogisticApplicationModel.js +488 -0
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +211 -1
- package/sdk/application/Logistic/LogisticApplicationValidator.js +131 -0
- package/sdk/application/Order/OrderApplicationClient.d.ts +3 -3
- package/sdk/application/Order/OrderApplicationClient.js +32 -8
- package/sdk/application/Order/OrderApplicationModel.d.ts +6 -0
- package/sdk/application/Order/OrderApplicationModel.js +6 -0
- package/sdk/application/Order/OrderApplicationValidator.d.ts +20 -0
- package/sdk/application/Order/OrderApplicationValidator.js +8 -0
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +46 -2
- package/sdk/application/Payment/PaymentApplicationClient.js +341 -10
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +493 -186
- package/sdk/application/Payment/PaymentApplicationModel.js +341 -70
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +59 -14
- package/sdk/application/Payment/PaymentApplicationValidator.js +64 -10
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +34 -1
- package/sdk/application/PosCart/PosCartApplicationModel.js +24 -0
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +1 -1
- package/sdk/application/Theme/ThemeApplicationClient.js +7 -3
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +222 -36
- package/sdk/application/Theme/ThemeApplicationModel.js +322 -26
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +10 -0
- package/sdk/application/Theme/ThemeApplicationValidator.js +4 -0
- package/sdk/application/User/UserApplicationClient.d.ts +33 -0
- package/sdk/application/User/UserApplicationClient.js +239 -0
- package/sdk/application/User/UserApplicationModel.d.ts +28 -13
- package/sdk/application/User/UserApplicationModel.js +36 -12
- package/sdk/application/User/UserApplicationValidator.d.ts +34 -1
- package/sdk/application/User/UserApplicationValidator.js +36 -0
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +125 -0
- package/sdk/partner/Lead/LeadPartnerClient.js +785 -0
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +1127 -0
- package/sdk/partner/Lead/LeadPartnerModel.js +896 -0
- package/sdk/partner/Lead/LeadPartnerValidator.d.ts +12 -0
- package/sdk/partner/Lead/LeadPartnerValidator.js +67 -0
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +155 -0
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +1195 -0
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +372 -0
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +442 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +16 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +123 -0
- package/sdk/partner/PartnerClient.d.ts +6 -0
- package/sdk/partner/PartnerClient.js +9 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +10 -0
- package/sdk/partner/Theme/ThemePartnerClient.js +80 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +100 -43
- package/sdk/partner/Theme/ThemePartnerModel.js +74 -30
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +1 -0
- package/sdk/partner/Theme/ThemePartnerValidator.js +9 -0
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +99 -0
- package/sdk/partner/Webhook/WebhookPartnerClient.js +753 -0
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +566 -0
- package/sdk/partner/Webhook/WebhookPartnerModel.js +583 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +12 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +74 -0
- package/sdk/partner/index.d.ts +3 -0
- package/sdk/partner/index.js +6 -0
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +2 -2
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +11 -1
- package/sdk/platform/Billing/BillingPlatformClient.js +110 -3
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +67 -1
- package/sdk/platform/Billing/BillingPlatformModel.js +78 -0
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +43 -4
- package/sdk/platform/Billing/BillingPlatformValidator.js +29 -2
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +7 -1
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +4 -0
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +4 -0
- package/sdk/platform/Cart/CartPlatformModel.d.ts +100 -5
- package/sdk/platform/Cart/CartPlatformModel.js +71 -4
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +15 -11
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +52 -21
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +27 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +11 -0
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +26 -4
- package/sdk/platform/Catalog/CatalogPlatformClient.js +173 -7
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +304 -1
- package/sdk/platform/Catalog/CatalogPlatformModel.js +335 -0
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +31 -3
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +27 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +138 -36
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +739 -57
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +128 -3
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +111 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +150 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.js +172 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +8 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +32 -4
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +38 -9
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +42 -8
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +14 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +6 -0
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +8 -8
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +4 -4
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +371 -132
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +288 -77
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +2 -2
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +2 -2
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +391 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +3630 -1059
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +342 -1
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +401 -0
- package/sdk/platform/Content/ContentPlatformClient.d.ts +277 -0
- package/sdk/platform/Content/ContentPlatformClient.js +2000 -0
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1094 -1
- package/sdk/platform/Content/ContentPlatformModel.js +1356 -46
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +238 -0
- package/sdk/platform/Content/ContentPlatformValidator.js +310 -0
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformClient.js +2 -2
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +96 -13
- package/sdk/platform/Discount/DiscountPlatformModel.js +104 -12
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +16 -6
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +117 -8
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +55 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +39 -2
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +16 -5
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +18 -4
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +33 -0
- package/sdk/platform/Finance/FinancePlatformClient.js +240 -0
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +151 -5
- package/sdk/platform/Finance/FinancePlatformModel.js +190 -4
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +38 -1
- package/sdk/platform/Finance/FinancePlatformValidator.js +38 -0
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +38 -28
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +137 -56
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +41 -29
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +33 -21
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +12 -3
- package/sdk/platform/Lead/LeadPlatformModel.js +16 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +23 -1
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +178 -1
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +39 -1
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +32 -0
- package/sdk/platform/Order/OrderPlatformClient.d.ts +202 -31
- package/sdk/platform/Order/OrderPlatformClient.js +2010 -586
- package/sdk/platform/Order/OrderPlatformModel.d.ts +1032 -470
- package/sdk/platform/Order/OrderPlatformModel.js +1187 -534
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +318 -35
- package/sdk/platform/Order/OrderPlatformValidator.js +292 -29
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +119 -13
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +749 -39
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +143 -7
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +133 -6
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +1 -1
- package/sdk/platform/Payment/PaymentPlatformClient.js +1 -1
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +996 -134
- package/sdk/platform/Payment/PaymentPlatformModel.js +721 -58
- package/sdk/platform/PlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/PlatformApplicationClient.js +4 -4
- package/sdk/platform/PlatformClient.d.ts +4 -2
- package/sdk/platform/PlatformClient.js +8 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +142 -66
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +645 -147
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +131 -63
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +126 -47
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +217 -105
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +1136 -347
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +912 -313
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1071 -355
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +382 -133
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +266 -102
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +11 -1
- package/sdk/platform/Theme/ThemePlatformClient.js +87 -3
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +333 -47
- package/sdk/platform/Theme/ThemePlatformModel.js +395 -35
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +28 -4
- package/sdk/platform/Theme/ThemePlatformValidator.js +21 -2
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +116 -1
- package/sdk/platform/User/UserPlatformApplicationClient.js +931 -85
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +224 -7
- package/sdk/platform/User/UserPlatformApplicationValidator.js +173 -5
- package/sdk/platform/User/UserPlatformModel.d.ts +344 -7
- package/sdk/platform/User/UserPlatformModel.js +256 -5
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +47 -39
- package/sdk/platform/Webhook/WebhookPlatformClient.js +63 -61
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +264 -156
- package/sdk/platform/Webhook/WebhookPlatformModel.js +276 -153
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +7 -10
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +6 -6
- package/sdk/platform/index.d.ts +1 -1
- package/sdk/platform/index.js +2 -2
- package/sdk/public/Billing/BillingPublicClient.d.ts +23 -0
- package/sdk/public/Billing/BillingPublicClient.js +116 -0
- package/sdk/public/Billing/BillingPublicModel.d.ts +92 -0
- package/sdk/public/Billing/BillingPublicModel.js +96 -0
- package/sdk/public/Billing/BillingPublicValidator.d.ts +18 -0
- package/sdk/public/Billing/BillingPublicValidator.js +19 -0
- package/sdk/public/Content/ContentPublicClient.d.ts +22 -0
- package/sdk/public/Content/ContentPublicClient.js +114 -0
- package/sdk/public/Content/ContentPublicModel.d.ts +53 -0
- package/sdk/public/Content/ContentPublicModel.js +60 -0
- package/sdk/public/Content/ContentPublicValidator.d.ts +18 -0
- package/sdk/public/Content/ContentPublicValidator.js +19 -0
- package/sdk/public/PublicClient.d.ts +4 -0
- package/sdk/public/PublicClient.js +8 -0
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +33 -0
- package/sdk/public/Webhook/WebhookPublicClient.js +242 -0
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +147 -1
- package/sdk/public/Webhook/WebhookPublicModel.js +177 -1
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +23 -1
- package/sdk/public/Webhook/WebhookPublicValidator.js +31 -0
- package/sdk/public/index.d.ts +2 -0
- package/sdk/public/index.js +4 -0
|
@@ -118,6 +118,26 @@ export = CommunicationPlatformModel;
|
|
|
118
118
|
* @property {string} [from_email]
|
|
119
119
|
* @property {string} [from_name]
|
|
120
120
|
*/
|
|
121
|
+
/**
|
|
122
|
+
* @typedef CommunicationTemplate
|
|
123
|
+
* @property {boolean} [subscribed] - Whether the user is subscribed or not
|
|
124
|
+
* @property {string} [template] - Template ID
|
|
125
|
+
*/
|
|
126
|
+
/**
|
|
127
|
+
* @typedef CreateJobsReq
|
|
128
|
+
* @property {string} [campaign]
|
|
129
|
+
*/
|
|
130
|
+
/**
|
|
131
|
+
* @typedef CreateJobsRes
|
|
132
|
+
* @property {number} [__v]
|
|
133
|
+
* @property {string} [_id]
|
|
134
|
+
* @property {string} [application]
|
|
135
|
+
* @property {string} [campaign]
|
|
136
|
+
* @property {boolean} [completed]
|
|
137
|
+
* @property {string} [created_at]
|
|
138
|
+
* @property {boolean} [is_active]
|
|
139
|
+
* @property {string} [updated_at]
|
|
140
|
+
*/
|
|
121
141
|
/**
|
|
122
142
|
* @typedef DefaultSmsProviders
|
|
123
143
|
* @property {string} [_id]
|
|
@@ -272,6 +292,22 @@ export = CommunicationPlatformModel;
|
|
|
272
292
|
* @property {EventSubscription[]} [items]
|
|
273
293
|
* @property {Page} [page]
|
|
274
294
|
*/
|
|
295
|
+
/**
|
|
296
|
+
* @typedef EventSubscriptionsBulkUpdateRequest
|
|
297
|
+
* @property {SubscriptionsObject[]} [subscriptions]
|
|
298
|
+
*/
|
|
299
|
+
/**
|
|
300
|
+
* @typedef EventSubscriptionsBulkUpdateResponse
|
|
301
|
+
* @property {number} [__v]
|
|
302
|
+
* @property {string} [_id]
|
|
303
|
+
* @property {string} [application]
|
|
304
|
+
* @property {string} [category]
|
|
305
|
+
* @property {string} [created_at]
|
|
306
|
+
* @property {string} [event]
|
|
307
|
+
* @property {string} [slug]
|
|
308
|
+
* @property {EventSubscriptionTemplate} [template]
|
|
309
|
+
* @property {string} [updated_at]
|
|
310
|
+
*/
|
|
275
311
|
/**
|
|
276
312
|
* @typedef EventSubscriptionTemplate
|
|
277
313
|
* @property {EventSubscriptionTemplateEmail} [email]
|
|
@@ -450,6 +486,24 @@ export = CommunicationPlatformModel;
|
|
|
450
486
|
* @property {string} [subtitle]
|
|
451
487
|
* @property {string} [title]
|
|
452
488
|
*/
|
|
489
|
+
/**
|
|
490
|
+
* @typedef OtpConfiguration
|
|
491
|
+
* @property {string} [application_id]
|
|
492
|
+
* @property {string} [company_id]
|
|
493
|
+
* @property {OtpConfigurationExpiry} expiry
|
|
494
|
+
* @property {number} otp_length
|
|
495
|
+
* @property {string} type
|
|
496
|
+
*/
|
|
497
|
+
/**
|
|
498
|
+
* @typedef OtpConfigurationExpiry
|
|
499
|
+
* @property {OtpConfigurationExpiryDuration} duration
|
|
500
|
+
* @property {string} type
|
|
501
|
+
*/
|
|
502
|
+
/**
|
|
503
|
+
* @typedef OtpConfigurationExpiryDuration
|
|
504
|
+
* @property {string} denomination
|
|
505
|
+
* @property {number} time
|
|
506
|
+
*/
|
|
453
507
|
/**
|
|
454
508
|
* @typedef Page
|
|
455
509
|
* @property {number} [current]
|
|
@@ -682,6 +736,11 @@ export = CommunicationPlatformModel;
|
|
|
682
736
|
* @property {number} [success]
|
|
683
737
|
* @property {number} [suppressed]
|
|
684
738
|
*/
|
|
739
|
+
/**
|
|
740
|
+
* @typedef SubscriptionsObject
|
|
741
|
+
* @property {string} [_id] - Subscription ID
|
|
742
|
+
* @property {TemplateObject} [template]
|
|
743
|
+
*/
|
|
685
744
|
/**
|
|
686
745
|
* @typedef SystemEmailTemplate
|
|
687
746
|
* @property {number} [__v]
|
|
@@ -757,6 +816,12 @@ export = CommunicationPlatformModel;
|
|
|
757
816
|
* @property {string} [template]
|
|
758
817
|
* @property {string} [template_type]
|
|
759
818
|
*/
|
|
819
|
+
/**
|
|
820
|
+
* @typedef TemplateObject
|
|
821
|
+
* @property {CommunicationTemplate} [email]
|
|
822
|
+
* @property {CommunicationTemplate} [pushnotification]
|
|
823
|
+
* @property {CommunicationTemplate} [sms]
|
|
824
|
+
*/
|
|
760
825
|
/**
|
|
761
826
|
* @typedef TriggerJobRequest
|
|
762
827
|
* @property {string} [job_id]
|
|
@@ -785,7 +850,7 @@ export = CommunicationPlatformModel;
|
|
|
785
850
|
declare class CommunicationPlatformModel {
|
|
786
851
|
}
|
|
787
852
|
declare namespace CommunicationPlatformModel {
|
|
788
|
-
export { AppProvider, AppProviderReq, AppProviderRes, AppProviderResObj, AppProviderResVoice, Audience, AudienceReq, Audiences, BadRequestSchema, Campaign, CampaignEmail, CampaignEmailTemplate, CampaignReq, Campaigns, CampignEmailProvider, DefaultSmsProviders, DummyDatasources, DummyDatasourcesMeta, DummyDatasourcesMetaObj, EmailProvider, EmailProviderReq, EmailProviderReqFrom, EmailProviders, EmailTemplate, EmailTemplateHeaders, EmailTemplateKeys, EmailTemplateReq, EmailTemplates, EnabledObj, EngineRequest, EngineResponse, EventSubscription, EventSubscriptions, EventSubscriptionTemplate, EventSubscriptionTemplateEmail, EventSubscriptionTemplateSms, GenericDelete, GenericError, GetNRecordsCsvReq, GetNRecordsCsvRes, GetNRecordsCsvResItems, GetStats, GlobalProviders, GlobalProvidersResObj, GlobalVariablesGetResponse, GlobalVariablesPostResponse, GlobalVariablesReq, Job, JobLog, JobLogs, Jobs, Log, LogEmail, LogMeta, LogPushnotification, Logs, Message, metaObj, MetaStructure, NotFound, Notification, Page, PayloadEmailProviderStructure, PayloadEmailStructure, PayloadEmailTemplateStructure, PayloadSmsProviderStructure, PayloadSmsStructure, PayloadSmsTemplateStructure, PayloadStructure, RecipientHeaders, SendOtpCommsReq, SendOtpCommsReqData, SendOtpCommsReqEmail, SendOtpCommsReqSms, SendOtpCommsRes, SendOtpCommsResEmail, SendOtpCommsResSms, SendOtpEmailCommsProvider, SendOtpEmailCommsTemplate, SendOtpSmsCommsProvider, SendOtpSmsCommsTemplate, SmsProvider, SmsProviderReq, SmsProviders, SmsTemplate, SmsTemplateMessage, SmsTemplateReq, SmsTemplates, Stats, StatsImported, StatsProcessed, StatsProcessedEmail, StatsProcessedSms, SystemEmailTemplate, SystemEmailTemplates, SystemNotification, SystemNotifications, SystemNotificationUser, SystemSmsTemplates, TemplateAndType, TriggerJobRequest, TriggerJobResponse, VerifyOtpCommsErrorRes, VerifyOtpCommsReq, VerifyOtpCommsSuccessRes };
|
|
853
|
+
export { AppProvider, AppProviderReq, AppProviderRes, AppProviderResObj, AppProviderResVoice, Audience, AudienceReq, Audiences, BadRequestSchema, Campaign, CampaignEmail, CampaignEmailTemplate, CampaignReq, Campaigns, CampignEmailProvider, CommunicationTemplate, CreateJobsReq, CreateJobsRes, DefaultSmsProviders, DummyDatasources, DummyDatasourcesMeta, DummyDatasourcesMetaObj, EmailProvider, EmailProviderReq, EmailProviderReqFrom, EmailProviders, EmailTemplate, EmailTemplateHeaders, EmailTemplateKeys, EmailTemplateReq, EmailTemplates, EnabledObj, EngineRequest, EngineResponse, EventSubscription, EventSubscriptions, EventSubscriptionsBulkUpdateRequest, EventSubscriptionsBulkUpdateResponse, EventSubscriptionTemplate, EventSubscriptionTemplateEmail, EventSubscriptionTemplateSms, GenericDelete, GenericError, GetNRecordsCsvReq, GetNRecordsCsvRes, GetNRecordsCsvResItems, GetStats, GlobalProviders, GlobalProvidersResObj, GlobalVariablesGetResponse, GlobalVariablesPostResponse, GlobalVariablesReq, Job, JobLog, JobLogs, Jobs, Log, LogEmail, LogMeta, LogPushnotification, Logs, Message, metaObj, MetaStructure, NotFound, Notification, OtpConfiguration, OtpConfigurationExpiry, OtpConfigurationExpiryDuration, Page, PayloadEmailProviderStructure, PayloadEmailStructure, PayloadEmailTemplateStructure, PayloadSmsProviderStructure, PayloadSmsStructure, PayloadSmsTemplateStructure, PayloadStructure, RecipientHeaders, SendOtpCommsReq, SendOtpCommsReqData, SendOtpCommsReqEmail, SendOtpCommsReqSms, SendOtpCommsRes, SendOtpCommsResEmail, SendOtpCommsResSms, SendOtpEmailCommsProvider, SendOtpEmailCommsTemplate, SendOtpSmsCommsProvider, SendOtpSmsCommsTemplate, SmsProvider, SmsProviderReq, SmsProviders, SmsTemplate, SmsTemplateMessage, SmsTemplateReq, SmsTemplates, Stats, StatsImported, StatsProcessed, StatsProcessedEmail, StatsProcessedSms, SubscriptionsObject, SystemEmailTemplate, SystemEmailTemplates, SystemNotification, SystemNotifications, SystemNotificationUser, SystemSmsTemplates, TemplateAndType, TemplateObject, TriggerJobRequest, TriggerJobResponse, VerifyOtpCommsErrorRes, VerifyOtpCommsReq, VerifyOtpCommsSuccessRes };
|
|
789
854
|
}
|
|
790
855
|
/** @returns {AppProvider} */
|
|
791
856
|
declare function AppProvider(): AppProvider;
|
|
@@ -927,6 +992,35 @@ type CampignEmailProvider = {
|
|
|
927
992
|
from_email?: string;
|
|
928
993
|
from_name?: string;
|
|
929
994
|
};
|
|
995
|
+
/** @returns {CommunicationTemplate} */
|
|
996
|
+
declare function CommunicationTemplate(): CommunicationTemplate;
|
|
997
|
+
type CommunicationTemplate = {
|
|
998
|
+
/**
|
|
999
|
+
* - Whether the user is subscribed or not
|
|
1000
|
+
*/
|
|
1001
|
+
subscribed?: boolean;
|
|
1002
|
+
/**
|
|
1003
|
+
* - Template ID
|
|
1004
|
+
*/
|
|
1005
|
+
template?: string;
|
|
1006
|
+
};
|
|
1007
|
+
/** @returns {CreateJobsReq} */
|
|
1008
|
+
declare function CreateJobsReq(): CreateJobsReq;
|
|
1009
|
+
type CreateJobsReq = {
|
|
1010
|
+
campaign?: string;
|
|
1011
|
+
};
|
|
1012
|
+
/** @returns {CreateJobsRes} */
|
|
1013
|
+
declare function CreateJobsRes(): CreateJobsRes;
|
|
1014
|
+
type CreateJobsRes = {
|
|
1015
|
+
__v?: number;
|
|
1016
|
+
_id?: string;
|
|
1017
|
+
application?: string;
|
|
1018
|
+
campaign?: string;
|
|
1019
|
+
completed?: boolean;
|
|
1020
|
+
created_at?: string;
|
|
1021
|
+
is_active?: boolean;
|
|
1022
|
+
updated_at?: string;
|
|
1023
|
+
};
|
|
930
1024
|
/** @returns {DefaultSmsProviders} */
|
|
931
1025
|
declare function DefaultSmsProviders(): DefaultSmsProviders;
|
|
932
1026
|
type DefaultSmsProviders = {
|
|
@@ -1099,6 +1193,24 @@ type EventSubscriptions = {
|
|
|
1099
1193
|
items?: EventSubscription[];
|
|
1100
1194
|
page?: Page;
|
|
1101
1195
|
};
|
|
1196
|
+
/** @returns {EventSubscriptionsBulkUpdateRequest} */
|
|
1197
|
+
declare function EventSubscriptionsBulkUpdateRequest(): EventSubscriptionsBulkUpdateRequest;
|
|
1198
|
+
type EventSubscriptionsBulkUpdateRequest = {
|
|
1199
|
+
subscriptions?: SubscriptionsObject[];
|
|
1200
|
+
};
|
|
1201
|
+
/** @returns {EventSubscriptionsBulkUpdateResponse} */
|
|
1202
|
+
declare function EventSubscriptionsBulkUpdateResponse(): EventSubscriptionsBulkUpdateResponse;
|
|
1203
|
+
type EventSubscriptionsBulkUpdateResponse = {
|
|
1204
|
+
__v?: number;
|
|
1205
|
+
_id?: string;
|
|
1206
|
+
application?: string;
|
|
1207
|
+
category?: string;
|
|
1208
|
+
created_at?: string;
|
|
1209
|
+
event?: string;
|
|
1210
|
+
slug?: string;
|
|
1211
|
+
template?: EventSubscriptionTemplate;
|
|
1212
|
+
updated_at?: string;
|
|
1213
|
+
};
|
|
1102
1214
|
/** @returns {EventSubscriptionTemplate} */
|
|
1103
1215
|
declare function EventSubscriptionTemplate(): EventSubscriptionTemplate;
|
|
1104
1216
|
type EventSubscriptionTemplate = {
|
|
@@ -1308,6 +1420,27 @@ type Notification = {
|
|
|
1308
1420
|
subtitle?: string;
|
|
1309
1421
|
title?: string;
|
|
1310
1422
|
};
|
|
1423
|
+
/** @returns {OtpConfiguration} */
|
|
1424
|
+
declare function OtpConfiguration(): OtpConfiguration;
|
|
1425
|
+
type OtpConfiguration = {
|
|
1426
|
+
application_id?: string;
|
|
1427
|
+
company_id?: string;
|
|
1428
|
+
expiry: OtpConfigurationExpiry;
|
|
1429
|
+
otp_length: number;
|
|
1430
|
+
type: string;
|
|
1431
|
+
};
|
|
1432
|
+
/** @returns {OtpConfigurationExpiry} */
|
|
1433
|
+
declare function OtpConfigurationExpiry(): OtpConfigurationExpiry;
|
|
1434
|
+
type OtpConfigurationExpiry = {
|
|
1435
|
+
duration: OtpConfigurationExpiryDuration;
|
|
1436
|
+
type: string;
|
|
1437
|
+
};
|
|
1438
|
+
/** @returns {OtpConfigurationExpiryDuration} */
|
|
1439
|
+
declare function OtpConfigurationExpiryDuration(): OtpConfigurationExpiryDuration;
|
|
1440
|
+
type OtpConfigurationExpiryDuration = {
|
|
1441
|
+
denomination: string;
|
|
1442
|
+
time: number;
|
|
1443
|
+
};
|
|
1311
1444
|
/** @returns {Page} */
|
|
1312
1445
|
declare function Page(): Page;
|
|
1313
1446
|
type Page = {
|
|
@@ -1608,6 +1741,15 @@ type StatsProcessedSms = {
|
|
|
1608
1741
|
success?: number;
|
|
1609
1742
|
suppressed?: number;
|
|
1610
1743
|
};
|
|
1744
|
+
/** @returns {SubscriptionsObject} */
|
|
1745
|
+
declare function SubscriptionsObject(): SubscriptionsObject;
|
|
1746
|
+
type SubscriptionsObject = {
|
|
1747
|
+
/**
|
|
1748
|
+
* - Subscription ID
|
|
1749
|
+
*/
|
|
1750
|
+
_id?: string;
|
|
1751
|
+
template?: TemplateObject;
|
|
1752
|
+
};
|
|
1611
1753
|
/** @returns {SystemEmailTemplate} */
|
|
1612
1754
|
declare function SystemEmailTemplate(): SystemEmailTemplate;
|
|
1613
1755
|
type SystemEmailTemplate = {
|
|
@@ -1690,6 +1832,13 @@ type TemplateAndType = {
|
|
|
1690
1832
|
template?: string;
|
|
1691
1833
|
template_type?: string;
|
|
1692
1834
|
};
|
|
1835
|
+
/** @returns {TemplateObject} */
|
|
1836
|
+
declare function TemplateObject(): TemplateObject;
|
|
1837
|
+
type TemplateObject = {
|
|
1838
|
+
email?: CommunicationTemplate;
|
|
1839
|
+
pushnotification?: CommunicationTemplate;
|
|
1840
|
+
sms?: CommunicationTemplate;
|
|
1841
|
+
};
|
|
1693
1842
|
/** @returns {TriggerJobRequest} */
|
|
1694
1843
|
declare function TriggerJobRequest(): TriggerJobRequest;
|
|
1695
1844
|
type TriggerJobRequest = {
|
|
@@ -134,6 +134,29 @@ const Joi = require("joi");
|
|
|
134
134
|
* @property {string} [from_name]
|
|
135
135
|
*/
|
|
136
136
|
|
|
137
|
+
/**
|
|
138
|
+
* @typedef CommunicationTemplate
|
|
139
|
+
* @property {boolean} [subscribed] - Whether the user is subscribed or not
|
|
140
|
+
* @property {string} [template] - Template ID
|
|
141
|
+
*/
|
|
142
|
+
|
|
143
|
+
/**
|
|
144
|
+
* @typedef CreateJobsReq
|
|
145
|
+
* @property {string} [campaign]
|
|
146
|
+
*/
|
|
147
|
+
|
|
148
|
+
/**
|
|
149
|
+
* @typedef CreateJobsRes
|
|
150
|
+
* @property {number} [__v]
|
|
151
|
+
* @property {string} [_id]
|
|
152
|
+
* @property {string} [application]
|
|
153
|
+
* @property {string} [campaign]
|
|
154
|
+
* @property {boolean} [completed]
|
|
155
|
+
* @property {string} [created_at]
|
|
156
|
+
* @property {boolean} [is_active]
|
|
157
|
+
* @property {string} [updated_at]
|
|
158
|
+
*/
|
|
159
|
+
|
|
137
160
|
/**
|
|
138
161
|
* @typedef DefaultSmsProviders
|
|
139
162
|
* @property {string} [_id]
|
|
@@ -306,6 +329,24 @@ const Joi = require("joi");
|
|
|
306
329
|
* @property {Page} [page]
|
|
307
330
|
*/
|
|
308
331
|
|
|
332
|
+
/**
|
|
333
|
+
* @typedef EventSubscriptionsBulkUpdateRequest
|
|
334
|
+
* @property {SubscriptionsObject[]} [subscriptions]
|
|
335
|
+
*/
|
|
336
|
+
|
|
337
|
+
/**
|
|
338
|
+
* @typedef EventSubscriptionsBulkUpdateResponse
|
|
339
|
+
* @property {number} [__v]
|
|
340
|
+
* @property {string} [_id]
|
|
341
|
+
* @property {string} [application]
|
|
342
|
+
* @property {string} [category]
|
|
343
|
+
* @property {string} [created_at]
|
|
344
|
+
* @property {string} [event]
|
|
345
|
+
* @property {string} [slug]
|
|
346
|
+
* @property {EventSubscriptionTemplate} [template]
|
|
347
|
+
* @property {string} [updated_at]
|
|
348
|
+
*/
|
|
349
|
+
|
|
309
350
|
/**
|
|
310
351
|
* @typedef EventSubscriptionTemplate
|
|
311
352
|
* @property {EventSubscriptionTemplateEmail} [email]
|
|
@@ -512,6 +553,27 @@ const Joi = require("joi");
|
|
|
512
553
|
* @property {string} [title]
|
|
513
554
|
*/
|
|
514
555
|
|
|
556
|
+
/**
|
|
557
|
+
* @typedef OtpConfiguration
|
|
558
|
+
* @property {string} [application_id]
|
|
559
|
+
* @property {string} [company_id]
|
|
560
|
+
* @property {OtpConfigurationExpiry} expiry
|
|
561
|
+
* @property {number} otp_length
|
|
562
|
+
* @property {string} type
|
|
563
|
+
*/
|
|
564
|
+
|
|
565
|
+
/**
|
|
566
|
+
* @typedef OtpConfigurationExpiry
|
|
567
|
+
* @property {OtpConfigurationExpiryDuration} duration
|
|
568
|
+
* @property {string} type
|
|
569
|
+
*/
|
|
570
|
+
|
|
571
|
+
/**
|
|
572
|
+
* @typedef OtpConfigurationExpiryDuration
|
|
573
|
+
* @property {string} denomination
|
|
574
|
+
* @property {number} time
|
|
575
|
+
*/
|
|
576
|
+
|
|
515
577
|
/**
|
|
516
578
|
* @typedef Page
|
|
517
579
|
* @property {number} [current]
|
|
@@ -776,6 +838,12 @@ const Joi = require("joi");
|
|
|
776
838
|
* @property {number} [suppressed]
|
|
777
839
|
*/
|
|
778
840
|
|
|
841
|
+
/**
|
|
842
|
+
* @typedef SubscriptionsObject
|
|
843
|
+
* @property {string} [_id] - Subscription ID
|
|
844
|
+
* @property {TemplateObject} [template]
|
|
845
|
+
*/
|
|
846
|
+
|
|
779
847
|
/**
|
|
780
848
|
* @typedef SystemEmailTemplate
|
|
781
849
|
* @property {number} [__v]
|
|
@@ -858,6 +926,13 @@ const Joi = require("joi");
|
|
|
858
926
|
* @property {string} [template_type]
|
|
859
927
|
*/
|
|
860
928
|
|
|
929
|
+
/**
|
|
930
|
+
* @typedef TemplateObject
|
|
931
|
+
* @property {CommunicationTemplate} [email]
|
|
932
|
+
* @property {CommunicationTemplate} [pushnotification]
|
|
933
|
+
* @property {CommunicationTemplate} [sms]
|
|
934
|
+
*/
|
|
935
|
+
|
|
861
936
|
/**
|
|
862
937
|
* @typedef TriggerJobRequest
|
|
863
938
|
* @property {string} [job_id]
|
|
@@ -1053,6 +1128,35 @@ class CommunicationPlatformModel {
|
|
|
1053
1128
|
});
|
|
1054
1129
|
}
|
|
1055
1130
|
|
|
1131
|
+
/** @returns {CommunicationTemplate} */
|
|
1132
|
+
static CommunicationTemplate() {
|
|
1133
|
+
return Joi.object({
|
|
1134
|
+
subscribed: Joi.boolean(),
|
|
1135
|
+
template: Joi.string().allow(""),
|
|
1136
|
+
});
|
|
1137
|
+
}
|
|
1138
|
+
|
|
1139
|
+
/** @returns {CreateJobsReq} */
|
|
1140
|
+
static CreateJobsReq() {
|
|
1141
|
+
return Joi.object({
|
|
1142
|
+
campaign: Joi.string().allow(""),
|
|
1143
|
+
});
|
|
1144
|
+
}
|
|
1145
|
+
|
|
1146
|
+
/** @returns {CreateJobsRes} */
|
|
1147
|
+
static CreateJobsRes() {
|
|
1148
|
+
return Joi.object({
|
|
1149
|
+
__v: Joi.number(),
|
|
1150
|
+
_id: Joi.string().allow(""),
|
|
1151
|
+
application: Joi.string().allow(""),
|
|
1152
|
+
campaign: Joi.string().allow(""),
|
|
1153
|
+
completed: Joi.boolean(),
|
|
1154
|
+
created_at: Joi.string().allow(""),
|
|
1155
|
+
is_active: Joi.boolean(),
|
|
1156
|
+
updated_at: Joi.string().allow(""),
|
|
1157
|
+
});
|
|
1158
|
+
}
|
|
1159
|
+
|
|
1056
1160
|
/** @returns {DefaultSmsProviders} */
|
|
1057
1161
|
static DefaultSmsProviders() {
|
|
1058
1162
|
return Joi.object({
|
|
@@ -1269,6 +1373,30 @@ class CommunicationPlatformModel {
|
|
|
1269
1373
|
});
|
|
1270
1374
|
}
|
|
1271
1375
|
|
|
1376
|
+
/** @returns {EventSubscriptionsBulkUpdateRequest} */
|
|
1377
|
+
static EventSubscriptionsBulkUpdateRequest() {
|
|
1378
|
+
return Joi.object({
|
|
1379
|
+
subscriptions: Joi.array().items(
|
|
1380
|
+
CommunicationPlatformModel.SubscriptionsObject()
|
|
1381
|
+
),
|
|
1382
|
+
});
|
|
1383
|
+
}
|
|
1384
|
+
|
|
1385
|
+
/** @returns {EventSubscriptionsBulkUpdateResponse} */
|
|
1386
|
+
static EventSubscriptionsBulkUpdateResponse() {
|
|
1387
|
+
return Joi.object({
|
|
1388
|
+
__v: Joi.number(),
|
|
1389
|
+
_id: Joi.string().allow(""),
|
|
1390
|
+
application: Joi.string().allow(""),
|
|
1391
|
+
category: Joi.string().allow(""),
|
|
1392
|
+
created_at: Joi.string().allow(""),
|
|
1393
|
+
event: Joi.string().allow(""),
|
|
1394
|
+
slug: Joi.string().allow(""),
|
|
1395
|
+
template: CommunicationPlatformModel.EventSubscriptionTemplate(),
|
|
1396
|
+
updated_at: Joi.string().allow(""),
|
|
1397
|
+
});
|
|
1398
|
+
}
|
|
1399
|
+
|
|
1272
1400
|
/** @returns {EventSubscriptionTemplate} */
|
|
1273
1401
|
static EventSubscriptionTemplate() {
|
|
1274
1402
|
return Joi.object({
|
|
@@ -1539,6 +1667,33 @@ class CommunicationPlatformModel {
|
|
|
1539
1667
|
});
|
|
1540
1668
|
}
|
|
1541
1669
|
|
|
1670
|
+
/** @returns {OtpConfiguration} */
|
|
1671
|
+
static OtpConfiguration() {
|
|
1672
|
+
return Joi.object({
|
|
1673
|
+
application_id: Joi.string().allow(""),
|
|
1674
|
+
company_id: Joi.string().allow(""),
|
|
1675
|
+
expiry: CommunicationPlatformModel.OtpConfigurationExpiry().required(),
|
|
1676
|
+
otp_length: Joi.number().required(),
|
|
1677
|
+
type: Joi.string().allow("").required(),
|
|
1678
|
+
});
|
|
1679
|
+
}
|
|
1680
|
+
|
|
1681
|
+
/** @returns {OtpConfigurationExpiry} */
|
|
1682
|
+
static OtpConfigurationExpiry() {
|
|
1683
|
+
return Joi.object({
|
|
1684
|
+
duration: CommunicationPlatformModel.OtpConfigurationExpiryDuration().required(),
|
|
1685
|
+
type: Joi.string().allow("").required(),
|
|
1686
|
+
});
|
|
1687
|
+
}
|
|
1688
|
+
|
|
1689
|
+
/** @returns {OtpConfigurationExpiryDuration} */
|
|
1690
|
+
static OtpConfigurationExpiryDuration() {
|
|
1691
|
+
return Joi.object({
|
|
1692
|
+
denomination: Joi.string().allow("").required(),
|
|
1693
|
+
time: Joi.number().required(),
|
|
1694
|
+
});
|
|
1695
|
+
}
|
|
1696
|
+
|
|
1542
1697
|
/** @returns {Page} */
|
|
1543
1698
|
static Page() {
|
|
1544
1699
|
return Joi.object({
|
|
@@ -1867,6 +2022,14 @@ class CommunicationPlatformModel {
|
|
|
1867
2022
|
});
|
|
1868
2023
|
}
|
|
1869
2024
|
|
|
2025
|
+
/** @returns {SubscriptionsObject} */
|
|
2026
|
+
static SubscriptionsObject() {
|
|
2027
|
+
return Joi.object({
|
|
2028
|
+
_id: Joi.string().allow(""),
|
|
2029
|
+
template: CommunicationPlatformModel.TemplateObject(),
|
|
2030
|
+
});
|
|
2031
|
+
}
|
|
2032
|
+
|
|
1870
2033
|
/** @returns {SystemEmailTemplate} */
|
|
1871
2034
|
static SystemEmailTemplate() {
|
|
1872
2035
|
return Joi.object({
|
|
@@ -1967,6 +2130,15 @@ class CommunicationPlatformModel {
|
|
|
1967
2130
|
});
|
|
1968
2131
|
}
|
|
1969
2132
|
|
|
2133
|
+
/** @returns {TemplateObject} */
|
|
2134
|
+
static TemplateObject() {
|
|
2135
|
+
return Joi.object({
|
|
2136
|
+
email: CommunicationPlatformModel.CommunicationTemplate(),
|
|
2137
|
+
pushnotification: CommunicationPlatformModel.CommunicationTemplate(),
|
|
2138
|
+
sms: CommunicationPlatformModel.CommunicationTemplate(),
|
|
2139
|
+
});
|
|
2140
|
+
}
|
|
2141
|
+
|
|
1970
2142
|
/** @returns {TriggerJobRequest} */
|
|
1971
2143
|
static TriggerJobRequest() {
|
|
1972
2144
|
return Joi.object({
|
|
@@ -152,7 +152,7 @@ declare class CompanyProfile {
|
|
|
152
152
|
* @summary: Get list of locations
|
|
153
153
|
* @description: This API allows to view all the locations associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getLocations/).
|
|
154
154
|
*/
|
|
155
|
-
getLocations({ storeType, q, stage, pageNo, pageSize, locationIds, requestHeaders }?: CompanyProfilePlatformValidator.GetLocationsParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.LocationListSerializer>;
|
|
155
|
+
getLocations({ storeType, q, stage, pageNo, pageSize, locationIds, types, tags, requestHeaders, }?: CompanyProfilePlatformValidator.GetLocationsParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.LocationListSerializer>;
|
|
156
156
|
/**
|
|
157
157
|
* @param {Object} arg - Arg object.
|
|
158
158
|
* @param {string} [arg.storeType] - Helps to sort the location list on the
|
|
@@ -163,16 +163,22 @@ declare class CompanyProfile {
|
|
|
163
163
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
164
164
|
* page. Default is 10.
|
|
165
165
|
* @param {number[]} [arg.locationIds] - Helps to filter stores on the basis of uids.
|
|
166
|
+
* @param {string[]} [arg.types] - Helps to get the location list on the
|
|
167
|
+
* basis of multiple location type.
|
|
168
|
+
* @param {string[]} [arg.tags] - Helps to get the location list on the
|
|
169
|
+
* basis of multiple location tag.
|
|
166
170
|
* @returns {Paginator<CompanyProfilePlatformModel.LocationListSerializer>}
|
|
167
171
|
* @summary: Get list of locations
|
|
168
172
|
* @description: This API allows to view all the locations associated to a company.
|
|
169
173
|
*/
|
|
170
|
-
getLocationsPaginator({ storeType, q, stage, pageSize, locationIds }?: {
|
|
174
|
+
getLocationsPaginator({ storeType, q, stage, pageSize, locationIds, types, tags, }?: {
|
|
171
175
|
storeType?: string;
|
|
172
176
|
q?: string;
|
|
173
177
|
stage?: string;
|
|
174
178
|
pageSize?: number;
|
|
175
179
|
locationIds?: number[];
|
|
180
|
+
types?: string[];
|
|
181
|
+
tags?: string[];
|
|
176
182
|
}): Paginator<CompanyProfilePlatformModel.LocationListSerializer>;
|
|
177
183
|
/**
|
|
178
184
|
* @param {CompanyProfilePlatformValidator.UpdateCompanyParam} arg - Arg object
|
|
@@ -948,9 +948,17 @@ class CompanyProfile {
|
|
|
948
948
|
* @description: This API allows to view all the locations associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/companyprofile/getLocations/).
|
|
949
949
|
*/
|
|
950
950
|
async getLocations(
|
|
951
|
-
{
|
|
952
|
-
|
|
953
|
-
|
|
951
|
+
{
|
|
952
|
+
storeType,
|
|
953
|
+
q,
|
|
954
|
+
stage,
|
|
955
|
+
pageNo,
|
|
956
|
+
pageSize,
|
|
957
|
+
locationIds,
|
|
958
|
+
types,
|
|
959
|
+
tags,
|
|
960
|
+
requestHeaders,
|
|
961
|
+
} = { requestHeaders: {} },
|
|
954
962
|
{ responseHeaders } = { responseHeaders: false }
|
|
955
963
|
) {
|
|
956
964
|
const { error } = CompanyProfilePlatformValidator.getLocations().validate(
|
|
@@ -961,6 +969,8 @@ class CompanyProfile {
|
|
|
961
969
|
pageNo,
|
|
962
970
|
pageSize,
|
|
963
971
|
locationIds,
|
|
972
|
+
types,
|
|
973
|
+
tags,
|
|
964
974
|
},
|
|
965
975
|
{ abortEarly: false, allowUnknown: true }
|
|
966
976
|
);
|
|
@@ -979,6 +989,8 @@ class CompanyProfile {
|
|
|
979
989
|
pageNo,
|
|
980
990
|
pageSize,
|
|
981
991
|
locationIds,
|
|
992
|
+
types,
|
|
993
|
+
tags,
|
|
982
994
|
},
|
|
983
995
|
{ abortEarly: false, allowUnknown: false }
|
|
984
996
|
);
|
|
@@ -996,6 +1008,8 @@ class CompanyProfile {
|
|
|
996
1008
|
query_params["page_no"] = pageNo;
|
|
997
1009
|
query_params["page_size"] = pageSize;
|
|
998
1010
|
query_params["location_ids"] = locationIds;
|
|
1011
|
+
query_params["types"] = types;
|
|
1012
|
+
query_params["tags"] = tags;
|
|
999
1013
|
|
|
1000
1014
|
const xHeaders = {};
|
|
1001
1015
|
|
|
@@ -1045,11 +1059,23 @@ class CompanyProfile {
|
|
|
1045
1059
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
1046
1060
|
* page. Default is 10.
|
|
1047
1061
|
* @param {number[]} [arg.locationIds] - Helps to filter stores on the basis of uids.
|
|
1062
|
+
* @param {string[]} [arg.types] - Helps to get the location list on the
|
|
1063
|
+
* basis of multiple location type.
|
|
1064
|
+
* @param {string[]} [arg.tags] - Helps to get the location list on the
|
|
1065
|
+
* basis of multiple location tag.
|
|
1048
1066
|
* @returns {Paginator<CompanyProfilePlatformModel.LocationListSerializer>}
|
|
1049
1067
|
* @summary: Get list of locations
|
|
1050
1068
|
* @description: This API allows to view all the locations associated to a company.
|
|
1051
1069
|
*/
|
|
1052
|
-
getLocationsPaginator({
|
|
1070
|
+
getLocationsPaginator({
|
|
1071
|
+
storeType,
|
|
1072
|
+
q,
|
|
1073
|
+
stage,
|
|
1074
|
+
pageSize,
|
|
1075
|
+
locationIds,
|
|
1076
|
+
types,
|
|
1077
|
+
tags,
|
|
1078
|
+
} = {}) {
|
|
1053
1079
|
const paginator = new Paginator();
|
|
1054
1080
|
const callback = async () => {
|
|
1055
1081
|
const pageId = paginator.nextId;
|
|
@@ -1062,6 +1088,8 @@ class CompanyProfile {
|
|
|
1062
1088
|
pageNo: pageNo,
|
|
1063
1089
|
pageSize: pageSize,
|
|
1064
1090
|
locationIds: locationIds,
|
|
1091
|
+
types: types,
|
|
1092
|
+
tags: tags,
|
|
1065
1093
|
});
|
|
1066
1094
|
paginator.setPaginator({
|
|
1067
1095
|
hasNext: data.page.has_next ? true : false,
|