@bitblit/ratchet-misc 6.0.146-alpha → 6.0.148-alpha
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/package.json +5 -4
- package/src/brevo/brevo-keys.ts +7 -0
- package/src/brevo/brevo-mail-sending-provider.ts +49 -0
- package/src/brevo/brevo-ratchet.spec.ts +35 -0
- package/src/brevo/brevo-ratchet.ts +50 -0
- package/src/brevo/generated/.openapi-generator/FILES +208 -0
- package/src/brevo/generated/.openapi-generator/VERSION +1 -0
- package/src/brevo/generated/.openapi-generator-ignore +23 -0
- package/src/brevo/generated/apis/AccountApi.ts +76 -0
- package/src/brevo/generated/apis/AttributesApi.ts +366 -0
- package/src/brevo/generated/apis/ContactsApi.ts +2295 -0
- package/src/brevo/generated/apis/EmailCampaignsApi.ts +1130 -0
- package/src/brevo/generated/apis/FoldersApi.ts +502 -0
- package/src/brevo/generated/apis/ListsApi.ts +770 -0
- package/src/brevo/generated/apis/ProcessApi.ts +165 -0
- package/src/brevo/generated/apis/ResellerApi.ts +1330 -0
- package/src/brevo/generated/apis/SMSCampaignsApi.ts +839 -0
- package/src/brevo/generated/apis/SMTPApi.ts +1674 -0
- package/src/brevo/generated/apis/SendersApi.ts +425 -0
- package/src/brevo/generated/apis/TransactionalSMSApi.ts +433 -0
- package/src/brevo/generated/apis/WebhooksApi.ts +393 -0
- package/src/brevo/generated/apis/WhatsAppCampaignsApi.ts +371 -0
- package/src/brevo/generated/models/AbTestCampaignResult.ts +142 -0
- package/src/brevo/generated/models/AbTestCampaignResultClickedLinks.ts +73 -0
- package/src/brevo/generated/models/AbTestCampaignResultStatistics.ts +109 -0
- package/src/brevo/generated/models/AbTestVersionClicksInner.ts +79 -0
- package/src/brevo/generated/models/AbTestVersionStats.ts +70 -0
- package/src/brevo/generated/models/AddChildDomain.ts +62 -0
- package/src/brevo/generated/models/AddContactToList.ts +62 -0
- package/src/brevo/generated/models/AddCredits.ts +70 -0
- package/src/brevo/generated/models/BlockDomain.ts +61 -0
- package/src/brevo/generated/models/ComponentItems.ts +70 -0
- package/src/brevo/generated/models/CreateAttribute.ts +95 -0
- package/src/brevo/generated/models/CreateAttributeEnumerationInner.ts +70 -0
- package/src/brevo/generated/models/CreateChild.ts +120 -0
- package/src/brevo/generated/models/CreateContact.ts +110 -0
- package/src/brevo/generated/models/CreateDoiContact.ts +106 -0
- package/src/brevo/generated/models/CreateEmailCampaign.ts +293 -0
- package/src/brevo/generated/models/CreateEmailCampaignRecipients.ts +70 -0
- package/src/brevo/generated/models/CreateEmailCampaignSender.ts +78 -0
- package/src/brevo/generated/models/CreateList.ts +70 -0
- package/src/brevo/generated/models/CreateModel.ts +61 -0
- package/src/brevo/generated/models/CreateReseller.ts +71 -0
- package/src/brevo/generated/models/CreateSender.ts +82 -0
- package/src/brevo/generated/models/CreateSenderIpsInner.ts +80 -0
- package/src/brevo/generated/models/CreateSenderModel.ts +79 -0
- package/src/brevo/generated/models/CreateSmsCampaign.ts +99 -0
- package/src/brevo/generated/models/CreateSmsCampaignRecipients.ts +71 -0
- package/src/brevo/generated/models/CreateSmtpEmail.ts +61 -0
- package/src/brevo/generated/models/CreateSmtpTemplate.ts +139 -0
- package/src/brevo/generated/models/CreateSmtpTemplateSender.ts +78 -0
- package/src/brevo/generated/models/CreateUpdateContactModel.ts +62 -0
- package/src/brevo/generated/models/CreateUpdateFolder.ts +62 -0
- package/src/brevo/generated/models/CreateWebhook.ts +119 -0
- package/src/brevo/generated/models/CreatedProcessId.ts +61 -0
- package/src/brevo/generated/models/DeleteHardbounces.ts +78 -0
- package/src/brevo/generated/models/EmailExportRecipients.ts +86 -0
- package/src/brevo/generated/models/ErrorModel.ts +92 -0
- package/src/brevo/generated/models/GetAccount.ts +138 -0
- package/src/brevo/generated/models/GetAccountAllOfMarketingAutomation.ts +74 -0
- package/src/brevo/generated/models/GetAccountAllOfPlan.ts +124 -0
- package/src/brevo/generated/models/GetAccountAllOfRelay.ts +73 -0
- package/src/brevo/generated/models/GetAccountAllOfRelayData.ts +79 -0
- package/src/brevo/generated/models/GetAggregatedReport.ts +169 -0
- package/src/brevo/generated/models/GetAttributes.ts +64 -0
- package/src/brevo/generated/models/GetAttributesAttributesInner.ts +129 -0
- package/src/brevo/generated/models/GetAttributesAttributesInnerEnumerationInner.ts +73 -0
- package/src/brevo/generated/models/GetBlockedDomains.ts +61 -0
- package/src/brevo/generated/models/GetCampaignOverview.ts +183 -0
- package/src/brevo/generated/models/GetCampaignRecipients.ts +70 -0
- package/src/brevo/generated/models/GetCampaignStats.ts +177 -0
- package/src/brevo/generated/models/GetChildAccountCreationStatus.ts +61 -0
- package/src/brevo/generated/models/GetChildDomain.ts +70 -0
- package/src/brevo/generated/models/GetChildInfo.ts +137 -0
- package/src/brevo/generated/models/GetChildInfoAllOfApiKeys.ts +75 -0
- package/src/brevo/generated/models/GetChildInfoAllOfApiKeysV2.ts +70 -0
- package/src/brevo/generated/models/GetChildInfoAllOfApiKeysV3.ts +70 -0
- package/src/brevo/generated/models/GetChildInfoAllOfCredits.ts +70 -0
- package/src/brevo/generated/models/GetChildInfoAllOfStatistics.ts +78 -0
- package/src/brevo/generated/models/GetChildrenList.ts +73 -0
- package/src/brevo/generated/models/GetChildrenListChildrenInner.ts +145 -0
- package/src/brevo/generated/models/GetClient.ts +88 -0
- package/src/brevo/generated/models/GetContactCampaignStats.ts +168 -0
- package/src/brevo/generated/models/GetContactCampaignStatsClickedInner.ts +79 -0
- package/src/brevo/generated/models/GetContactCampaignStatsOpenedInner.ts +91 -0
- package/src/brevo/generated/models/GetContactCampaignStatsTransacAttributesInner.ts +82 -0
- package/src/brevo/generated/models/GetContactCampaignStatsUnsubscriptions.ts +92 -0
- package/src/brevo/generated/models/GetContactDetails.ts +133 -0
- package/src/brevo/generated/models/GetContacts.ts +73 -0
- package/src/brevo/generated/models/GetDeviceBrowserStats.ts +88 -0
- package/src/brevo/generated/models/GetEmailCampaign.ts +348 -0
- package/src/brevo/generated/models/GetEmailCampaigns.ts +73 -0
- package/src/brevo/generated/models/GetEmailCampaignsCampaignsInner.ts +348 -0
- package/src/brevo/generated/models/GetEmailEventReport.ts +64 -0
- package/src/brevo/generated/models/GetEmailEventReportEventsInner.ts +157 -0
- package/src/brevo/generated/models/GetExtendedCampaignOverview.ts +326 -0
- package/src/brevo/generated/models/GetExtendedCampaignOverviewAllOfSender.ts +81 -0
- package/src/brevo/generated/models/GetExtendedCampaignStats.ts +132 -0
- package/src/brevo/generated/models/GetExtendedClient.ts +100 -0
- package/src/brevo/generated/models/GetExtendedClientAllOfAddress.ts +88 -0
- package/src/brevo/generated/models/GetExtendedContactDetails.ts +147 -0
- package/src/brevo/generated/models/GetExtendedContactDetailsAllOfStatistics.ts +168 -0
- package/src/brevo/generated/models/GetExtendedContactDetailsAllOfStatisticsClicked.ts +79 -0
- package/src/brevo/generated/models/GetExtendedContactDetailsAllOfStatisticsLinks.ts +91 -0
- package/src/brevo/generated/models/GetExtendedContactDetailsAllOfStatisticsMessagesSent.ts +77 -0
- package/src/brevo/generated/models/GetExtendedContactDetailsAllOfStatisticsOpened.ts +91 -0
- package/src/brevo/generated/models/GetExtendedContactDetailsAllOfStatisticsUnsubscriptions.ts +96 -0
- package/src/brevo/generated/models/GetExtendedContactDetailsAllOfStatisticsUnsubscriptionsAdminUnsubscription.ts +78 -0
- package/src/brevo/generated/models/GetExtendedContactDetailsAllOfStatisticsUnsubscriptionsUserUnsubscription.ts +87 -0
- package/src/brevo/generated/models/GetExtendedList.ts +129 -0
- package/src/brevo/generated/models/GetExtendedListAllOfCampaignStats.ts +73 -0
- package/src/brevo/generated/models/GetFolder.ts +97 -0
- package/src/brevo/generated/models/GetFolderLists.ts +73 -0
- package/src/brevo/generated/models/GetFolders.ts +72 -0
- package/src/brevo/generated/models/GetIp.ts +88 -0
- package/src/brevo/generated/models/GetIpFromSender.ts +88 -0
- package/src/brevo/generated/models/GetIps.ts +64 -0
- package/src/brevo/generated/models/GetIpsFromSender.ts +64 -0
- package/src/brevo/generated/models/GetList.ts +88 -0
- package/src/brevo/generated/models/GetLists.ts +73 -0
- package/src/brevo/generated/models/GetListsListsInner.ts +97 -0
- package/src/brevo/generated/models/GetProcess.ts +99 -0
- package/src/brevo/generated/models/GetProcesses.ts +73 -0
- package/src/brevo/generated/models/GetReports.ts +64 -0
- package/src/brevo/generated/models/GetReportsReportsInner.ts +169 -0
- package/src/brevo/generated/models/GetSegments.ts +72 -0
- package/src/brevo/generated/models/GetSegmentsSegments.ts +86 -0
- package/src/brevo/generated/models/GetSendersList.ts +64 -0
- package/src/brevo/generated/models/GetSendersListSendersInner.ts +103 -0
- package/src/brevo/generated/models/GetSendersListSendersInnerIpsInner.ts +82 -0
- package/src/brevo/generated/models/GetSharedTemplateUrl.ts +61 -0
- package/src/brevo/generated/models/GetSmsCampaign.ts +160 -0
- package/src/brevo/generated/models/GetSmsCampaignOverview.ts +137 -0
- package/src/brevo/generated/models/GetSmsCampaignStats.ts +115 -0
- package/src/brevo/generated/models/GetSmsCampaigns.ts +73 -0
- package/src/brevo/generated/models/GetSmsCampaignsCampaignsInner.ts +160 -0
- package/src/brevo/generated/models/GetSmsEventReport.ts +64 -0
- package/src/brevo/generated/models/GetSmsEventReportEventsInner.ts +131 -0
- package/src/brevo/generated/models/GetSmtpTemplateOverview.ts +172 -0
- package/src/brevo/generated/models/GetSmtpTemplateOverviewSender.ts +78 -0
- package/src/brevo/generated/models/GetSmtpTemplates.ts +72 -0
- package/src/brevo/generated/models/GetSsoToken.ts +61 -0
- package/src/brevo/generated/models/GetStatsByDevice.ts +88 -0
- package/src/brevo/generated/models/GetTransacAggregatedSmsReport.ts +142 -0
- package/src/brevo/generated/models/GetTransacBlockedContacts.ts +75 -0
- package/src/brevo/generated/models/GetTransacBlockedContactsContactsInner.ts +97 -0
- package/src/brevo/generated/models/GetTransacBlockedContactsContactsInnerReason.ts +86 -0
- package/src/brevo/generated/models/GetTransacEmailContent.ts +118 -0
- package/src/brevo/generated/models/GetTransacEmailContentEventsInner.ts +70 -0
- package/src/brevo/generated/models/GetTransacEmailsList.ts +72 -0
- package/src/brevo/generated/models/GetTransacEmailsListTransactionalEmailsInner.ts +126 -0
- package/src/brevo/generated/models/GetTransacSmsReport.ts +64 -0
- package/src/brevo/generated/models/GetTransacSmsReportReportsInner.ts +142 -0
- package/src/brevo/generated/models/GetWATemplates.ts +73 -0
- package/src/brevo/generated/models/GetWATemplatesTemplatesInner.ts +125 -0
- package/src/brevo/generated/models/GetWebhook.ts +124 -0
- package/src/brevo/generated/models/GetWebhooks.ts +64 -0
- package/src/brevo/generated/models/GetWhatsappCampaignOverview.ts +152 -0
- package/src/brevo/generated/models/GetWhatsappCampaigns.ts +75 -0
- package/src/brevo/generated/models/GetWhatsappCampaignsCampaignsInner.ts +169 -0
- package/src/brevo/generated/models/ManageIp.ts +62 -0
- package/src/brevo/generated/models/PostContactInfo.ts +64 -0
- package/src/brevo/generated/models/PostContactInfoContacts.ts +86 -0
- package/src/brevo/generated/models/PostSendFailed.ts +96 -0
- package/src/brevo/generated/models/PostSendSmsTestFailed.ts +88 -0
- package/src/brevo/generated/models/RemainingCreditModel.ts +75 -0
- package/src/brevo/generated/models/RemainingCreditModelChild.ts +70 -0
- package/src/brevo/generated/models/RemainingCreditModelReseller.ts +70 -0
- package/src/brevo/generated/models/RemoveContactFromList.ts +70 -0
- package/src/brevo/generated/models/RemoveCredits.ts +70 -0
- package/src/brevo/generated/models/RequestContactExport.ts +94 -0
- package/src/brevo/generated/models/RequestContactExportCustomContactFilter.ts +141 -0
- package/src/brevo/generated/models/RequestContactImport.ts +136 -0
- package/src/brevo/generated/models/RequestContactImportNewList.ts +70 -0
- package/src/brevo/generated/models/RequestSmsRecipientExport.ts +84 -0
- package/src/brevo/generated/models/SendEmail.ts +129 -0
- package/src/brevo/generated/models/SendEmailAttachmentInner.ts +70 -0
- package/src/brevo/generated/models/SendReport.ts +86 -0
- package/src/brevo/generated/models/SendReportEmail.ts +70 -0
- package/src/brevo/generated/models/SendSms.ts +96 -0
- package/src/brevo/generated/models/SendSmtpEmail.ts +171 -0
- package/src/brevo/generated/models/SendSmtpEmailAttachmentInner.ts +78 -0
- package/src/brevo/generated/models/SendSmtpEmailBccInner.ts +71 -0
- package/src/brevo/generated/models/SendSmtpEmailCcInner.ts +71 -0
- package/src/brevo/generated/models/SendSmtpEmailReplyTo.ts +71 -0
- package/src/brevo/generated/models/SendSmtpEmailSender.ts +71 -0
- package/src/brevo/generated/models/SendSmtpEmailToInner.ts +71 -0
- package/src/brevo/generated/models/SendTemplateEmail.ts +61 -0
- package/src/brevo/generated/models/SendTestEmail.ts +62 -0
- package/src/brevo/generated/models/SendTestSms.ts +62 -0
- package/src/brevo/generated/models/SendTransacSms.ts +122 -0
- package/src/brevo/generated/models/UpdateAttribute.ts +74 -0
- package/src/brevo/generated/models/UpdateAttributeEnumerationInner.ts +70 -0
- package/src/brevo/generated/models/UpdateCampaignStatus.ts +77 -0
- package/src/brevo/generated/models/UpdateChild.ts +94 -0
- package/src/brevo/generated/models/UpdateChildAccountStatus.ts +86 -0
- package/src/brevo/generated/models/UpdateChildDomain.ts +62 -0
- package/src/brevo/generated/models/UpdateContact.ts +102 -0
- package/src/brevo/generated/models/UpdateEmailCampaign.ts +291 -0
- package/src/brevo/generated/models/UpdateEmailCampaignRecipients.ts +70 -0
- package/src/brevo/generated/models/UpdateEmailCampaignSender.ts +78 -0
- package/src/brevo/generated/models/UpdateList.ts +70 -0
- package/src/brevo/generated/models/UpdateSender.ts +80 -0
- package/src/brevo/generated/models/UpdateSmsCampaign.ts +96 -0
- package/src/brevo/generated/models/UpdateSmtpTemplate.ts +136 -0
- package/src/brevo/generated/models/UpdateSmtpTemplateSender.ts +78 -0
- package/src/brevo/generated/models/UpdateWebhook.ts +100 -0
- package/src/brevo/generated/models/UploadImageToGallery.ts +71 -0
- package/src/brevo/generated/models/VariablesItems.ts +78 -0
- package/src/brevo/generated/models/WhatsappCampStats.ts +97 -0
- package/src/brevo/generated/models/WhatsappCampTemplate.ts +146 -0
- package/src/brevo/generated/models/index.ts +189 -0
- package/src/brevo/generated/runtime.ts +455 -0
- package/src/build/ratchet-misc-info.ts +19 -0
- package/src/handlebars/handlebars-ratchet.spec.ts +117 -0
- package/src/handlebars/handlebars-ratchet.ts +151 -0
- package/src/handlebars/remote-handlebars-template-renderer.ts +87 -0
- package/src/model-validator/model-validator.spec.ts +43 -0
- package/src/model-validator/model-validator.ts +67 -0
- package/src/rxjs/observable-ratchet.spec.ts +21 -0
- package/src/rxjs/observable-ratchet.ts +27 -0
- package/src/rxjs/rxjs-ratchet.spec.ts +22 -0
- package/src/rxjs/rxjs-ratchet.ts +44 -0
- package/src/sobol/generated/.openapi-generator/FILES +53 -0
- package/src/sobol/generated/.openapi-generator/VERSION +1 -0
- package/src/sobol/generated/.openapi-generator-ignore +23 -0
- package/src/sobol/generated/apis/AgreementsApi.ts +656 -0
- package/src/sobol/generated/apis/CustomFieldValuesApi.ts +412 -0
- package/src/sobol/generated/apis/CustomFieldsApi.ts +460 -0
- package/src/sobol/generated/apis/GoalsApi.ts +565 -0
- package/src/sobol/generated/apis/RoleAssignmentsApi.ts +289 -0
- package/src/sobol/generated/apis/RolesApi.ts +736 -0
- package/src/sobol/generated/apis/TeamsApi.ts +748 -0
- package/src/sobol/generated/apis/UsersApi.ts +640 -0
- package/src/sobol/generated/apis/index.ts +8 -0
- package/src/sobol/generated/index.ts +3 -0
- package/src/sobol/generated/models/Address.ts +220 -0
- package/src/sobol/generated/models/AddressTypeInternalEnum.ts +35 -0
- package/src/sobol/generated/models/Agreement.ts +281 -0
- package/src/sobol/generated/models/AgreementOwnersInner.ts +80 -0
- package/src/sobol/generated/models/AgreementSignatoriesInner.ts +78 -0
- package/src/sobol/generated/models/CustomField.ts +265 -0
- package/src/sobol/generated/models/CustomFieldBadgeConfig.ts +67 -0
- package/src/sobol/generated/models/CustomFieldBadgeConfigOptionsValue.ts +105 -0
- package/src/sobol/generated/models/CustomFieldBadgeContent.ts +67 -0
- package/src/sobol/generated/models/CustomFieldBadgeContentBadgesInner.ts +73 -0
- package/src/sobol/generated/models/CustomFieldConfig.ts +88 -0
- package/src/sobol/generated/models/CustomFieldMultiSelectDropDownConfig.ts +70 -0
- package/src/sobol/generated/models/CustomFieldMultiSelectDropDownContent.ts +72 -0
- package/src/sobol/generated/models/CustomFieldMultiSelectDropDownContentSelectedOptions.ts +77 -0
- package/src/sobol/generated/models/CustomFieldSingleSelectDropDownConfig.ts +70 -0
- package/src/sobol/generated/models/CustomFieldSingleSelectDropDownConfigOptionsValue.ts +75 -0
- package/src/sobol/generated/models/CustomFieldSingleSelectDropDownContent.ts +72 -0
- package/src/sobol/generated/models/CustomFieldSingleSelectDropDownContentSelectedOptions.ts +77 -0
- package/src/sobol/generated/models/CustomFieldTextConfig.ts +62 -0
- package/src/sobol/generated/models/CustomFieldTextContent.ts +62 -0
- package/src/sobol/generated/models/CustomFieldValue.ts +249 -0
- package/src/sobol/generated/models/CustomFieldValueContent.ts +88 -0
- package/src/sobol/generated/models/FeatureToggle.ts +123 -0
- package/src/sobol/generated/models/GlobalIdentity.ts +218 -0
- package/src/sobol/generated/models/GlobalUserSettings.ts +187 -0
- package/src/sobol/generated/models/Goal.ts +322 -0
- package/src/sobol/generated/models/GoalOwnersInner.ts +80 -0
- package/src/sobol/generated/models/GoalParentGoal.ts +78 -0
- package/src/sobol/generated/models/GoalValue.ts +178 -0
- package/src/sobol/generated/models/LocalIdentity.ts +220 -0
- package/src/sobol/generated/models/ObjectRef.ts +82 -0
- package/src/sobol/generated/models/Role.ts +258 -0
- package/src/sobol/generated/models/RoleAccountableTo.ts +78 -0
- package/src/sobol/generated/models/RoleAssignment.ts +202 -0
- package/src/sobol/generated/models/RoleAssignmentsInner.ts +78 -0
- package/src/sobol/generated/models/RoleContributesTo.ts +78 -0
- package/src/sobol/generated/models/Team.ts +273 -0
- package/src/sobol/generated/models/TeamOwnersInner.ts +79 -0
- package/src/sobol/generated/models/User.ts +396 -0
- package/src/sobol/generated/models/UserLocalIdentitiesInner.ts +78 -0
- package/src/sobol/generated/models/index.ts +40 -0
- package/src/sobol/generated/runtime.ts +455 -0
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
/* eslint-disable */
|
|
2
|
+
/**
|
|
3
|
+
* SendinBlue API
|
|
4
|
+
* SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
|
|
5
|
+
*
|
|
6
|
+
* The version of the OpenAPI document: 3.0.0
|
|
7
|
+
* Contact: contact@sendinblue.com
|
|
8
|
+
*
|
|
9
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
10
|
+
* https://openapi-generator.tech
|
|
11
|
+
* Do not edit the class manually.
|
|
12
|
+
*/
|
|
13
|
+
|
|
14
|
+
import type { RemainingCreditModelChild } from './RemainingCreditModelChild.js';
|
|
15
|
+
import { RemainingCreditModelChildFromJSON, RemainingCreditModelChildToJSON } from './RemainingCreditModelChild.js';
|
|
16
|
+
import type { RemainingCreditModelReseller } from './RemainingCreditModelReseller.js';
|
|
17
|
+
import { RemainingCreditModelResellerFromJSON, RemainingCreditModelResellerToJSON } from './RemainingCreditModelReseller.js';
|
|
18
|
+
|
|
19
|
+
/**
|
|
20
|
+
*
|
|
21
|
+
* @export
|
|
22
|
+
* @interface RemainingCreditModel
|
|
23
|
+
*/
|
|
24
|
+
export interface RemainingCreditModel {
|
|
25
|
+
/**
|
|
26
|
+
*
|
|
27
|
+
* @type {RemainingCreditModelChild}
|
|
28
|
+
* @memberof RemainingCreditModel
|
|
29
|
+
*/
|
|
30
|
+
child: RemainingCreditModelChild;
|
|
31
|
+
/**
|
|
32
|
+
*
|
|
33
|
+
* @type {RemainingCreditModelReseller}
|
|
34
|
+
* @memberof RemainingCreditModel
|
|
35
|
+
*/
|
|
36
|
+
reseller: RemainingCreditModelReseller;
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
/**
|
|
40
|
+
* Check if a given object implements the RemainingCreditModel interface.
|
|
41
|
+
*/
|
|
42
|
+
export function instanceOfRemainingCreditModel(value: object): boolean {
|
|
43
|
+
let isInstance = true;
|
|
44
|
+
isInstance = isInstance && 'child' in value;
|
|
45
|
+
isInstance = isInstance && 'reseller' in value;
|
|
46
|
+
|
|
47
|
+
return isInstance;
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
export function RemainingCreditModelFromJSON(json: any): RemainingCreditModel {
|
|
51
|
+
return RemainingCreditModelFromJSONTyped(json, false);
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
export function RemainingCreditModelFromJSONTyped(json: any, ignoreDiscriminator: boolean): RemainingCreditModel {
|
|
55
|
+
if (json === undefined || json === null) {
|
|
56
|
+
return json;
|
|
57
|
+
}
|
|
58
|
+
return {
|
|
59
|
+
child: RemainingCreditModelChildFromJSON(json['child']),
|
|
60
|
+
reseller: RemainingCreditModelResellerFromJSON(json['reseller']),
|
|
61
|
+
};
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
export function RemainingCreditModelToJSON(value?: RemainingCreditModel | null): any {
|
|
65
|
+
if (value === undefined) {
|
|
66
|
+
return undefined;
|
|
67
|
+
}
|
|
68
|
+
if (value === null) {
|
|
69
|
+
return null;
|
|
70
|
+
}
|
|
71
|
+
return {
|
|
72
|
+
child: RemainingCreditModelChildToJSON(value.child),
|
|
73
|
+
reseller: RemainingCreditModelResellerToJSON(value.reseller),
|
|
74
|
+
};
|
|
75
|
+
}
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
/* eslint-disable */
|
|
2
|
+
/**
|
|
3
|
+
* SendinBlue API
|
|
4
|
+
* SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
|
|
5
|
+
*
|
|
6
|
+
* The version of the OpenAPI document: 3.0.0
|
|
7
|
+
* Contact: contact@sendinblue.com
|
|
8
|
+
*
|
|
9
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
10
|
+
* https://openapi-generator.tech
|
|
11
|
+
* Do not edit the class manually.
|
|
12
|
+
*/
|
|
13
|
+
|
|
14
|
+
/**
|
|
15
|
+
* Credits remaining for child account
|
|
16
|
+
* @export
|
|
17
|
+
* @interface RemainingCreditModelChild
|
|
18
|
+
*/
|
|
19
|
+
export interface RemainingCreditModelChild {
|
|
20
|
+
/**
|
|
21
|
+
* SMS Credits remaining for child account
|
|
22
|
+
* @type {number}
|
|
23
|
+
* @memberof RemainingCreditModelChild
|
|
24
|
+
*/
|
|
25
|
+
sms: number;
|
|
26
|
+
/**
|
|
27
|
+
* Email Credits remaining for child account
|
|
28
|
+
* @type {number}
|
|
29
|
+
* @memberof RemainingCreditModelChild
|
|
30
|
+
*/
|
|
31
|
+
email: number;
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
/**
|
|
35
|
+
* Check if a given object implements the RemainingCreditModelChild interface.
|
|
36
|
+
*/
|
|
37
|
+
export function instanceOfRemainingCreditModelChild(value: object): boolean {
|
|
38
|
+
let isInstance = true;
|
|
39
|
+
isInstance = isInstance && 'sms' in value;
|
|
40
|
+
isInstance = isInstance && 'email' in value;
|
|
41
|
+
|
|
42
|
+
return isInstance;
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
export function RemainingCreditModelChildFromJSON(json: any): RemainingCreditModelChild {
|
|
46
|
+
return RemainingCreditModelChildFromJSONTyped(json, false);
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
export function RemainingCreditModelChildFromJSONTyped(json: any, ignoreDiscriminator: boolean): RemainingCreditModelChild {
|
|
50
|
+
if (json === undefined || json === null) {
|
|
51
|
+
return json;
|
|
52
|
+
}
|
|
53
|
+
return {
|
|
54
|
+
sms: json['sms'],
|
|
55
|
+
email: json['email'],
|
|
56
|
+
};
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
export function RemainingCreditModelChildToJSON(value?: RemainingCreditModelChild | null): any {
|
|
60
|
+
if (value === undefined) {
|
|
61
|
+
return undefined;
|
|
62
|
+
}
|
|
63
|
+
if (value === null) {
|
|
64
|
+
return null;
|
|
65
|
+
}
|
|
66
|
+
return {
|
|
67
|
+
sms: value.sms,
|
|
68
|
+
email: value.email,
|
|
69
|
+
};
|
|
70
|
+
}
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
/* eslint-disable */
|
|
2
|
+
/**
|
|
3
|
+
* SendinBlue API
|
|
4
|
+
* SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
|
|
5
|
+
*
|
|
6
|
+
* The version of the OpenAPI document: 3.0.0
|
|
7
|
+
* Contact: contact@sendinblue.com
|
|
8
|
+
*
|
|
9
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
10
|
+
* https://openapi-generator.tech
|
|
11
|
+
* Do not edit the class manually.
|
|
12
|
+
*/
|
|
13
|
+
|
|
14
|
+
/**
|
|
15
|
+
*
|
|
16
|
+
* @export
|
|
17
|
+
* @interface RemainingCreditModelReseller
|
|
18
|
+
*/
|
|
19
|
+
export interface RemainingCreditModelReseller {
|
|
20
|
+
/**
|
|
21
|
+
* SMS Credits remaining for reseller account
|
|
22
|
+
* @type {number}
|
|
23
|
+
* @memberof RemainingCreditModelReseller
|
|
24
|
+
*/
|
|
25
|
+
sms: number;
|
|
26
|
+
/**
|
|
27
|
+
* Email Credits remaining for reseller account
|
|
28
|
+
* @type {number}
|
|
29
|
+
* @memberof RemainingCreditModelReseller
|
|
30
|
+
*/
|
|
31
|
+
email: number;
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
/**
|
|
35
|
+
* Check if a given object implements the RemainingCreditModelReseller interface.
|
|
36
|
+
*/
|
|
37
|
+
export function instanceOfRemainingCreditModelReseller(value: object): boolean {
|
|
38
|
+
let isInstance = true;
|
|
39
|
+
isInstance = isInstance && 'sms' in value;
|
|
40
|
+
isInstance = isInstance && 'email' in value;
|
|
41
|
+
|
|
42
|
+
return isInstance;
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
export function RemainingCreditModelResellerFromJSON(json: any): RemainingCreditModelReseller {
|
|
46
|
+
return RemainingCreditModelResellerFromJSONTyped(json, false);
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
export function RemainingCreditModelResellerFromJSONTyped(json: any, ignoreDiscriminator: boolean): RemainingCreditModelReseller {
|
|
50
|
+
if (json === undefined || json === null) {
|
|
51
|
+
return json;
|
|
52
|
+
}
|
|
53
|
+
return {
|
|
54
|
+
sms: json['sms'],
|
|
55
|
+
email: json['email'],
|
|
56
|
+
};
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
export function RemainingCreditModelResellerToJSON(value?: RemainingCreditModelReseller | null): any {
|
|
60
|
+
if (value === undefined) {
|
|
61
|
+
return undefined;
|
|
62
|
+
}
|
|
63
|
+
if (value === null) {
|
|
64
|
+
return null;
|
|
65
|
+
}
|
|
66
|
+
return {
|
|
67
|
+
sms: value.sms,
|
|
68
|
+
email: value.email,
|
|
69
|
+
};
|
|
70
|
+
}
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
/* eslint-disable */
|
|
2
|
+
/**
|
|
3
|
+
* SendinBlue API
|
|
4
|
+
* SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
|
|
5
|
+
*
|
|
6
|
+
* The version of the OpenAPI document: 3.0.0
|
|
7
|
+
* Contact: contact@sendinblue.com
|
|
8
|
+
*
|
|
9
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
10
|
+
* https://openapi-generator.tech
|
|
11
|
+
* Do not edit the class manually.
|
|
12
|
+
*/
|
|
13
|
+
|
|
14
|
+
import { exists } from '../runtime.js';
|
|
15
|
+
|
|
16
|
+
/**
|
|
17
|
+
*
|
|
18
|
+
* @export
|
|
19
|
+
* @interface RemoveContactFromList
|
|
20
|
+
*/
|
|
21
|
+
export interface RemoveContactFromList {
|
|
22
|
+
/**
|
|
23
|
+
* Required if 'all' is false. Emails to remove from a list. You can pass a maximum of 150 emails for removal in one request.
|
|
24
|
+
* @type {Array<string>}
|
|
25
|
+
* @memberof RemoveContactFromList
|
|
26
|
+
*/
|
|
27
|
+
emails?: Array<string>;
|
|
28
|
+
/**
|
|
29
|
+
* Required if 'emails' is empty. Remove all existing contacts from a list. A process will be created in this scenario. You can fetch the process details to know about the progress
|
|
30
|
+
* @type {boolean}
|
|
31
|
+
* @memberof RemoveContactFromList
|
|
32
|
+
*/
|
|
33
|
+
all?: boolean;
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
/**
|
|
37
|
+
* Check if a given object implements the RemoveContactFromList interface.
|
|
38
|
+
*/
|
|
39
|
+
export function instanceOfRemoveContactFromList(value: object): boolean {
|
|
40
|
+
let isInstance = true;
|
|
41
|
+
|
|
42
|
+
return isInstance;
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
export function RemoveContactFromListFromJSON(json: any): RemoveContactFromList {
|
|
46
|
+
return RemoveContactFromListFromJSONTyped(json, false);
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
export function RemoveContactFromListFromJSONTyped(json: any, ignoreDiscriminator: boolean): RemoveContactFromList {
|
|
50
|
+
if (json === undefined || json === null) {
|
|
51
|
+
return json;
|
|
52
|
+
}
|
|
53
|
+
return {
|
|
54
|
+
emails: !exists(json, 'emails') ? undefined : json['emails'],
|
|
55
|
+
all: !exists(json, 'all') ? undefined : json['all'],
|
|
56
|
+
};
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
export function RemoveContactFromListToJSON(value?: RemoveContactFromList | null): any {
|
|
60
|
+
if (value === undefined) {
|
|
61
|
+
return undefined;
|
|
62
|
+
}
|
|
63
|
+
if (value === null) {
|
|
64
|
+
return null;
|
|
65
|
+
}
|
|
66
|
+
return {
|
|
67
|
+
emails: value.emails,
|
|
68
|
+
all: value.all,
|
|
69
|
+
};
|
|
70
|
+
}
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
/* eslint-disable */
|
|
2
|
+
/**
|
|
3
|
+
* SendinBlue API
|
|
4
|
+
* SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
|
|
5
|
+
*
|
|
6
|
+
* The version of the OpenAPI document: 3.0.0
|
|
7
|
+
* Contact: contact@sendinblue.com
|
|
8
|
+
*
|
|
9
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
10
|
+
* https://openapi-generator.tech
|
|
11
|
+
* Do not edit the class manually.
|
|
12
|
+
*/
|
|
13
|
+
|
|
14
|
+
import { exists } from '../runtime.js';
|
|
15
|
+
|
|
16
|
+
/**
|
|
17
|
+
*
|
|
18
|
+
* @export
|
|
19
|
+
* @interface RemoveCredits
|
|
20
|
+
*/
|
|
21
|
+
export interface RemoveCredits {
|
|
22
|
+
/**
|
|
23
|
+
* Required if email credits are empty. SMS credits to be removed from the child account
|
|
24
|
+
* @type {number}
|
|
25
|
+
* @memberof RemoveCredits
|
|
26
|
+
*/
|
|
27
|
+
sms?: number;
|
|
28
|
+
/**
|
|
29
|
+
* Required if sms credits are empty. Email credits to be removed from the child account
|
|
30
|
+
* @type {number}
|
|
31
|
+
* @memberof RemoveCredits
|
|
32
|
+
*/
|
|
33
|
+
email?: number;
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
/**
|
|
37
|
+
* Check if a given object implements the RemoveCredits interface.
|
|
38
|
+
*/
|
|
39
|
+
export function instanceOfRemoveCredits(value: object): boolean {
|
|
40
|
+
let isInstance = true;
|
|
41
|
+
|
|
42
|
+
return isInstance;
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
export function RemoveCreditsFromJSON(json: any): RemoveCredits {
|
|
46
|
+
return RemoveCreditsFromJSONTyped(json, false);
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
export function RemoveCreditsFromJSONTyped(json: any, ignoreDiscriminator: boolean): RemoveCredits {
|
|
50
|
+
if (json === undefined || json === null) {
|
|
51
|
+
return json;
|
|
52
|
+
}
|
|
53
|
+
return {
|
|
54
|
+
sms: !exists(json, 'sms') ? undefined : json['sms'],
|
|
55
|
+
email: !exists(json, 'email') ? undefined : json['email'],
|
|
56
|
+
};
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
export function RemoveCreditsToJSON(value?: RemoveCredits | null): any {
|
|
60
|
+
if (value === undefined) {
|
|
61
|
+
return undefined;
|
|
62
|
+
}
|
|
63
|
+
if (value === null) {
|
|
64
|
+
return null;
|
|
65
|
+
}
|
|
66
|
+
return {
|
|
67
|
+
sms: value.sms,
|
|
68
|
+
email: value.email,
|
|
69
|
+
};
|
|
70
|
+
}
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
/* eslint-disable */
|
|
2
|
+
/**
|
|
3
|
+
* SendinBlue API
|
|
4
|
+
* SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
|
|
5
|
+
*
|
|
6
|
+
* The version of the OpenAPI document: 3.0.0
|
|
7
|
+
* Contact: contact@sendinblue.com
|
|
8
|
+
*
|
|
9
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
10
|
+
* https://openapi-generator.tech
|
|
11
|
+
* Do not edit the class manually.
|
|
12
|
+
*/
|
|
13
|
+
|
|
14
|
+
import { exists } from '../runtime.js';
|
|
15
|
+
import type { RequestContactExportCustomContactFilter } from './RequestContactExportCustomContactFilter.js';
|
|
16
|
+
import {
|
|
17
|
+
RequestContactExportCustomContactFilterFromJSON,
|
|
18
|
+
RequestContactExportCustomContactFilterToJSON,
|
|
19
|
+
} from './RequestContactExportCustomContactFilter.js';
|
|
20
|
+
|
|
21
|
+
/**
|
|
22
|
+
*
|
|
23
|
+
* @export
|
|
24
|
+
* @interface RequestContactExport
|
|
25
|
+
*/
|
|
26
|
+
export interface RequestContactExport {
|
|
27
|
+
/**
|
|
28
|
+
* List of all the attributes that you want to export. These attributes must be present in your contact database. For example, ['fname', 'lname', 'email'].
|
|
29
|
+
* @type {Array<string>}
|
|
30
|
+
* @memberof RequestContactExport
|
|
31
|
+
*/
|
|
32
|
+
exportAttributes?: Array<string>;
|
|
33
|
+
/**
|
|
34
|
+
* This attribute has been deprecated and will be removed by January 1st, 2021. Only one of the two filter options (contactFilter or customContactFilter) can be passed in the request. Set the filter for the contacts to be exported. For example, {"blacklisted":true} will export all the blacklisted contacts.
|
|
35
|
+
*
|
|
36
|
+
* @type {object}
|
|
37
|
+
* @memberof RequestContactExport
|
|
38
|
+
*/
|
|
39
|
+
contactFilter?: object;
|
|
40
|
+
/**
|
|
41
|
+
*
|
|
42
|
+
* @type {RequestContactExportCustomContactFilter}
|
|
43
|
+
* @memberof RequestContactExport
|
|
44
|
+
*/
|
|
45
|
+
customContactFilter?: RequestContactExportCustomContactFilter;
|
|
46
|
+
/**
|
|
47
|
+
* Webhook that will be called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479
|
|
48
|
+
* @type {string}
|
|
49
|
+
* @memberof RequestContactExport
|
|
50
|
+
*/
|
|
51
|
+
notifyUrl?: string;
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
/**
|
|
55
|
+
* Check if a given object implements the RequestContactExport interface.
|
|
56
|
+
*/
|
|
57
|
+
export function instanceOfRequestContactExport(value: object): boolean {
|
|
58
|
+
let isInstance = true;
|
|
59
|
+
|
|
60
|
+
return isInstance;
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
export function RequestContactExportFromJSON(json: any): RequestContactExport {
|
|
64
|
+
return RequestContactExportFromJSONTyped(json, false);
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
export function RequestContactExportFromJSONTyped(json: any, ignoreDiscriminator: boolean): RequestContactExport {
|
|
68
|
+
if (json === undefined || json === null) {
|
|
69
|
+
return json;
|
|
70
|
+
}
|
|
71
|
+
return {
|
|
72
|
+
exportAttributes: !exists(json, 'exportAttributes') ? undefined : json['exportAttributes'],
|
|
73
|
+
contactFilter: !exists(json, 'contactFilter') ? undefined : json['contactFilter'],
|
|
74
|
+
customContactFilter: !exists(json, 'customContactFilter')
|
|
75
|
+
? undefined
|
|
76
|
+
: RequestContactExportCustomContactFilterFromJSON(json['customContactFilter']),
|
|
77
|
+
notifyUrl: !exists(json, 'notifyUrl') ? undefined : json['notifyUrl'],
|
|
78
|
+
};
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
export function RequestContactExportToJSON(value?: RequestContactExport | null): any {
|
|
82
|
+
if (value === undefined) {
|
|
83
|
+
return undefined;
|
|
84
|
+
}
|
|
85
|
+
if (value === null) {
|
|
86
|
+
return null;
|
|
87
|
+
}
|
|
88
|
+
return {
|
|
89
|
+
exportAttributes: value.exportAttributes,
|
|
90
|
+
contactFilter: value.contactFilter,
|
|
91
|
+
customContactFilter: RequestContactExportCustomContactFilterToJSON(value.customContactFilter),
|
|
92
|
+
notifyUrl: value.notifyUrl,
|
|
93
|
+
};
|
|
94
|
+
}
|
|
@@ -0,0 +1,141 @@
|
|
|
1
|
+
/* eslint-disable */
|
|
2
|
+
/**
|
|
3
|
+
* SendinBlue API
|
|
4
|
+
* SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
|
|
5
|
+
*
|
|
6
|
+
* The version of the OpenAPI document: 3.0.0
|
|
7
|
+
* Contact: contact@sendinblue.com
|
|
8
|
+
*
|
|
9
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
10
|
+
* https://openapi-generator.tech
|
|
11
|
+
* Do not edit the class manually.
|
|
12
|
+
*/
|
|
13
|
+
|
|
14
|
+
import { exists } from '../runtime.js';
|
|
15
|
+
|
|
16
|
+
/**
|
|
17
|
+
* Only one of the two filter options (contactFilter or customContactFilter) can be passed in the request. Set the filter for the contacts to be exported.
|
|
18
|
+
* @export
|
|
19
|
+
* @interface RequestContactExportCustomContactFilter
|
|
20
|
+
*/
|
|
21
|
+
export interface RequestContactExportCustomContactFilter {
|
|
22
|
+
/**
|
|
23
|
+
* Mandatory if neither actionForEmailCampaigns nor actionForSmsCampaigns is passed. This will export the contacts on the basis of provided action applied on contacts as per the list id. * allContacts - Fetch the list of all contacts for a particular list. * subscribed & unsubscribed - Fetch the list of subscribed / unsubscribed (blacklisted via any means) contacts for a particular list. * unsubscribedPerList - Fetch the list of contacts that are unsubscribed from a particular list only.
|
|
24
|
+
*
|
|
25
|
+
* @type {string}
|
|
26
|
+
* @memberof RequestContactExportCustomContactFilter
|
|
27
|
+
*/
|
|
28
|
+
actionForContacts?: RequestContactExportCustomContactFilterActionForContactsEnum;
|
|
29
|
+
/**
|
|
30
|
+
* Mandatory if neither actionForContacts nor actionForSmsCampaigns is passed. This will export the contacts on the basis of provided action applied on email campaigns. * openers & nonOpeners - emailCampaignId is mandatory. Fetch the list of readers / non-readers for a particular email campaign. * clickers & nonClickers - emailCampaignId is mandatory. Fetch the list of clickers / non-clickers for a particular email campaign. * unsubscribed - emailCampaignId is mandatory. Fetch the list of all unsubscribed (blacklisted via any means) contacts for a particular email campaign. * hardBounces & softBounces - emailCampaignId is optional. Fetch the list of hard bounces / soft bounces for a particular / all email campaign(s).
|
|
31
|
+
*
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof RequestContactExportCustomContactFilter
|
|
34
|
+
*/
|
|
35
|
+
actionForEmailCampaigns?: RequestContactExportCustomContactFilterActionForEmailCampaignsEnum;
|
|
36
|
+
/**
|
|
37
|
+
* Mandatory if neither actionForContacts nor actionForEmailCampaigns is passed. This will export the contacts on the basis of provided action applied on sms campaigns. * unsubscribed - Fetch the list of all unsubscribed (blacklisted via any means) contacts for all / particular sms campaigns. * hardBounces & softBounces - Fetch the list of hard bounces / soft bounces for all / particular sms campaigns.
|
|
38
|
+
*
|
|
39
|
+
* @type {string}
|
|
40
|
+
* @memberof RequestContactExportCustomContactFilter
|
|
41
|
+
*/
|
|
42
|
+
actionForSmsCampaigns?: RequestContactExportCustomContactFilterActionForSmsCampaignsEnum;
|
|
43
|
+
/**
|
|
44
|
+
* Mandatory if actionForContacts is passed, ignored otherwise. Id of the list for which the corresponding action shall be applied in the filter.
|
|
45
|
+
* @type {number}
|
|
46
|
+
* @memberof RequestContactExportCustomContactFilter
|
|
47
|
+
*/
|
|
48
|
+
listId?: number;
|
|
49
|
+
/**
|
|
50
|
+
* Considered only if actionForEmailCampaigns is passed, ignored otherwise. Mandatory if action is one of the following - openers, nonOpeners, clickers, nonClickers, unsubscribed. The id of the email campaign for which the corresponding action shall be applied in the filter.
|
|
51
|
+
* @type {number}
|
|
52
|
+
* @memberof RequestContactExportCustomContactFilter
|
|
53
|
+
*/
|
|
54
|
+
emailCampaignId?: number;
|
|
55
|
+
/**
|
|
56
|
+
* Considered only if actionForSmsCampaigns is passed, ignored otherwise. The id of sms campaign for which the corresponding action shall be applied in the filter.
|
|
57
|
+
* @type {number}
|
|
58
|
+
* @memberof RequestContactExportCustomContactFilter
|
|
59
|
+
*/
|
|
60
|
+
smsCampaignId?: number;
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
/**
|
|
64
|
+
* @export
|
|
65
|
+
* @enum {string}
|
|
66
|
+
*/
|
|
67
|
+
export enum RequestContactExportCustomContactFilterActionForContactsEnum {
|
|
68
|
+
AllContacts = 'allContacts',
|
|
69
|
+
Subscribed = 'subscribed',
|
|
70
|
+
Unsubscribed = 'unsubscribed',
|
|
71
|
+
UnsubscribedPerList = 'unsubscribedPerList',
|
|
72
|
+
}
|
|
73
|
+
/**
|
|
74
|
+
* @export
|
|
75
|
+
* @enum {string}
|
|
76
|
+
*/
|
|
77
|
+
export enum RequestContactExportCustomContactFilterActionForEmailCampaignsEnum {
|
|
78
|
+
Openers = 'openers',
|
|
79
|
+
NonOpeners = 'nonOpeners',
|
|
80
|
+
Clickers = 'clickers',
|
|
81
|
+
NonClickers = 'nonClickers',
|
|
82
|
+
Unsubscribed = 'unsubscribed',
|
|
83
|
+
HardBounces = 'hardBounces',
|
|
84
|
+
SoftBounces = 'softBounces',
|
|
85
|
+
}
|
|
86
|
+
/**
|
|
87
|
+
* @export
|
|
88
|
+
* @enum {string}
|
|
89
|
+
*/
|
|
90
|
+
export enum RequestContactExportCustomContactFilterActionForSmsCampaignsEnum {
|
|
91
|
+
HardBounces = 'hardBounces',
|
|
92
|
+
SoftBounces = 'softBounces',
|
|
93
|
+
Unsubscribed = 'unsubscribed',
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
/**
|
|
97
|
+
* Check if a given object implements the RequestContactExportCustomContactFilter interface.
|
|
98
|
+
*/
|
|
99
|
+
export function instanceOfRequestContactExportCustomContactFilter(value: object): boolean {
|
|
100
|
+
let isInstance = true;
|
|
101
|
+
|
|
102
|
+
return isInstance;
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
export function RequestContactExportCustomContactFilterFromJSON(json: any): RequestContactExportCustomContactFilter {
|
|
106
|
+
return RequestContactExportCustomContactFilterFromJSONTyped(json, false);
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
export function RequestContactExportCustomContactFilterFromJSONTyped(
|
|
110
|
+
json: any,
|
|
111
|
+
ignoreDiscriminator: boolean,
|
|
112
|
+
): RequestContactExportCustomContactFilter {
|
|
113
|
+
if (json === undefined || json === null) {
|
|
114
|
+
return json;
|
|
115
|
+
}
|
|
116
|
+
return {
|
|
117
|
+
actionForContacts: !exists(json, 'actionForContacts') ? undefined : json['actionForContacts'],
|
|
118
|
+
actionForEmailCampaigns: !exists(json, 'actionForEmailCampaigns') ? undefined : json['actionForEmailCampaigns'],
|
|
119
|
+
actionForSmsCampaigns: !exists(json, 'actionForSmsCampaigns') ? undefined : json['actionForSmsCampaigns'],
|
|
120
|
+
listId: !exists(json, 'listId') ? undefined : json['listId'],
|
|
121
|
+
emailCampaignId: !exists(json, 'emailCampaignId') ? undefined : json['emailCampaignId'],
|
|
122
|
+
smsCampaignId: !exists(json, 'smsCampaignId') ? undefined : json['smsCampaignId'],
|
|
123
|
+
};
|
|
124
|
+
}
|
|
125
|
+
|
|
126
|
+
export function RequestContactExportCustomContactFilterToJSON(value?: RequestContactExportCustomContactFilter | null): any {
|
|
127
|
+
if (value === undefined) {
|
|
128
|
+
return undefined;
|
|
129
|
+
}
|
|
130
|
+
if (value === null) {
|
|
131
|
+
return null;
|
|
132
|
+
}
|
|
133
|
+
return {
|
|
134
|
+
actionForContacts: value.actionForContacts,
|
|
135
|
+
actionForEmailCampaigns: value.actionForEmailCampaigns,
|
|
136
|
+
actionForSmsCampaigns: value.actionForSmsCampaigns,
|
|
137
|
+
listId: value.listId,
|
|
138
|
+
emailCampaignId: value.emailCampaignId,
|
|
139
|
+
smsCampaignId: value.smsCampaignId,
|
|
140
|
+
};
|
|
141
|
+
}
|