@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,1330 @@
|
|
|
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 * as runtime from '../runtime.js';
|
|
15
|
+
import type {
|
|
16
|
+
AddChildDomain,
|
|
17
|
+
AddCredits,
|
|
18
|
+
CreateChild,
|
|
19
|
+
CreateReseller,
|
|
20
|
+
GetChildAccountCreationStatus,
|
|
21
|
+
GetChildDomain,
|
|
22
|
+
GetChildInfo,
|
|
23
|
+
GetChildrenList,
|
|
24
|
+
GetSsoToken,
|
|
25
|
+
ManageIp,
|
|
26
|
+
RemainingCreditModel,
|
|
27
|
+
RemoveCredits,
|
|
28
|
+
UpdateChild,
|
|
29
|
+
UpdateChildAccountStatus,
|
|
30
|
+
UpdateChildDomain,
|
|
31
|
+
} from '../models/index.js';
|
|
32
|
+
import {
|
|
33
|
+
AddChildDomainToJSON,
|
|
34
|
+
AddCreditsToJSON,
|
|
35
|
+
CreateChildToJSON,
|
|
36
|
+
CreateResellerFromJSON,
|
|
37
|
+
GetChildAccountCreationStatusFromJSON,
|
|
38
|
+
GetChildDomainFromJSON,
|
|
39
|
+
GetChildInfoFromJSON,
|
|
40
|
+
GetChildrenListFromJSON,
|
|
41
|
+
GetSsoTokenFromJSON,
|
|
42
|
+
ManageIpToJSON,
|
|
43
|
+
RemainingCreditModelFromJSON,
|
|
44
|
+
RemoveCreditsToJSON,
|
|
45
|
+
UpdateChildAccountStatusToJSON,
|
|
46
|
+
UpdateChildDomainToJSON,
|
|
47
|
+
UpdateChildToJSON,
|
|
48
|
+
} from '../models/index.js';
|
|
49
|
+
|
|
50
|
+
export interface AddCreditsRequest {
|
|
51
|
+
childIdentifier: string;
|
|
52
|
+
addCredits: AddCredits;
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
export interface AssociateIpToChildRequest {
|
|
56
|
+
childIdentifier: string;
|
|
57
|
+
ip: ManageIp;
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
export interface CreateChildDomainRequest {
|
|
61
|
+
childIdentifier: string;
|
|
62
|
+
addChildDomain: AddChildDomain;
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
export interface CreateResellerChildRequest {
|
|
66
|
+
resellerChild?: CreateChild;
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
export interface DeleteChildDomainRequest {
|
|
70
|
+
childIdentifier: string;
|
|
71
|
+
domainName: string;
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
export interface DeleteResellerChildRequest {
|
|
75
|
+
childIdentifier: string;
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
export interface DissociateIpFromChildRequest {
|
|
79
|
+
childIdentifier: string;
|
|
80
|
+
ip: ManageIp;
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
export interface GetChildAccountCreationStatusRequest {
|
|
84
|
+
childIdentifier: string;
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
export interface GetChildDomainsRequest {
|
|
88
|
+
childIdentifier: string;
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
export interface GetChildInfoRequest {
|
|
92
|
+
childIdentifier: string;
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
export interface GetResellerChildsRequest {
|
|
96
|
+
limit?: number;
|
|
97
|
+
offset?: number;
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
export interface GetSsoTokenRequest {
|
|
101
|
+
childIdentifier: string;
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
export interface RemoveCreditsRequest {
|
|
105
|
+
childIdentifier: string;
|
|
106
|
+
removeCredits: RemoveCredits;
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
export interface UpdateChildAccountStatusRequest {
|
|
110
|
+
childIdentifier: string;
|
|
111
|
+
updateChildAccountStatus: UpdateChildAccountStatus;
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
export interface UpdateChildDomainRequest {
|
|
115
|
+
childIdentifier: string;
|
|
116
|
+
domainName: string;
|
|
117
|
+
updateChildDomain: UpdateChildDomain;
|
|
118
|
+
}
|
|
119
|
+
|
|
120
|
+
export interface UpdateResellerChildRequest {
|
|
121
|
+
childIdentifier: string;
|
|
122
|
+
resellerChild: UpdateChild;
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
/**
|
|
126
|
+
* ResellerApi - interface
|
|
127
|
+
*
|
|
128
|
+
* @export
|
|
129
|
+
* @interface ResellerApiInterface
|
|
130
|
+
*/
|
|
131
|
+
export interface ResellerApiInterface {
|
|
132
|
+
/**
|
|
133
|
+
*
|
|
134
|
+
* @summary Add Email and/or SMS credits to a specific child account
|
|
135
|
+
* @param {string} childIdentifier Either auth key or id of reseller\'s child
|
|
136
|
+
* @param {AddCredits} addCredits Values to post to add credit to a specific child account
|
|
137
|
+
* @param {*} [options] Override http request option.
|
|
138
|
+
* @throws {RequiredError}
|
|
139
|
+
* @memberof ResellerApiInterface
|
|
140
|
+
*/
|
|
141
|
+
addCreditsRaw(
|
|
142
|
+
requestParameters: AddCreditsRequest,
|
|
143
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
144
|
+
): Promise<runtime.ApiResponse<RemainingCreditModel>>;
|
|
145
|
+
|
|
146
|
+
/**
|
|
147
|
+
* Add Email and/or SMS credits to a specific child account
|
|
148
|
+
*/
|
|
149
|
+
addCredits(
|
|
150
|
+
requestParameters: AddCreditsRequest,
|
|
151
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
152
|
+
): Promise<RemainingCreditModel>;
|
|
153
|
+
|
|
154
|
+
/**
|
|
155
|
+
*
|
|
156
|
+
* @summary Associate a dedicated IP to the child
|
|
157
|
+
* @param {string} childIdentifier Either auth key or id of reseller\'s child
|
|
158
|
+
* @param {ManageIp} ip IP to associate
|
|
159
|
+
* @param {*} [options] Override http request option.
|
|
160
|
+
* @throws {RequiredError}
|
|
161
|
+
* @memberof ResellerApiInterface
|
|
162
|
+
*/
|
|
163
|
+
associateIpToChildRaw(
|
|
164
|
+
requestParameters: AssociateIpToChildRequest,
|
|
165
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
166
|
+
): Promise<runtime.ApiResponse<void>>;
|
|
167
|
+
|
|
168
|
+
/**
|
|
169
|
+
* Associate a dedicated IP to the child
|
|
170
|
+
*/
|
|
171
|
+
associateIpToChild(
|
|
172
|
+
requestParameters: AssociateIpToChildRequest,
|
|
173
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
174
|
+
): Promise<void>;
|
|
175
|
+
|
|
176
|
+
/**
|
|
177
|
+
*
|
|
178
|
+
* @summary Create a domain for a child account
|
|
179
|
+
* @param {string} childIdentifier Either auth key or id of reseller\'s child
|
|
180
|
+
* @param {AddChildDomain} addChildDomain Sender domain to add for a specific child account. This will not be displayed to the parent account.
|
|
181
|
+
* @param {*} [options] Override http request option.
|
|
182
|
+
* @throws {RequiredError}
|
|
183
|
+
* @memberof ResellerApiInterface
|
|
184
|
+
*/
|
|
185
|
+
createChildDomainRaw(
|
|
186
|
+
requestParameters: CreateChildDomainRequest,
|
|
187
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
188
|
+
): Promise<runtime.ApiResponse<void>>;
|
|
189
|
+
|
|
190
|
+
/**
|
|
191
|
+
* Create a domain for a child account
|
|
192
|
+
*/
|
|
193
|
+
createChildDomain(requestParameters: CreateChildDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
194
|
+
|
|
195
|
+
/**
|
|
196
|
+
*
|
|
197
|
+
* @summary Creates a reseller child
|
|
198
|
+
* @param {CreateChild} [resellerChild] reseller child to add
|
|
199
|
+
* @param {*} [options] Override http request option.
|
|
200
|
+
* @throws {RequiredError}
|
|
201
|
+
* @memberof ResellerApiInterface
|
|
202
|
+
*/
|
|
203
|
+
createResellerChildRaw(
|
|
204
|
+
requestParameters: CreateResellerChildRequest,
|
|
205
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
206
|
+
): Promise<runtime.ApiResponse<CreateReseller>>;
|
|
207
|
+
|
|
208
|
+
/**
|
|
209
|
+
* Creates a reseller child
|
|
210
|
+
*/
|
|
211
|
+
createResellerChild(
|
|
212
|
+
requestParameters: CreateResellerChildRequest,
|
|
213
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
214
|
+
): Promise<CreateReseller>;
|
|
215
|
+
|
|
216
|
+
/**
|
|
217
|
+
*
|
|
218
|
+
* @summary Delete the sender domain of the reseller child based on the childIdentifier and domainName passed
|
|
219
|
+
* @param {string} childIdentifier Either auth key or id of reseller\'s child
|
|
220
|
+
* @param {string} domainName Pass the existing domain that needs to be deleted
|
|
221
|
+
* @param {*} [options] Override http request option.
|
|
222
|
+
* @throws {RequiredError}
|
|
223
|
+
* @memberof ResellerApiInterface
|
|
224
|
+
*/
|
|
225
|
+
deleteChildDomainRaw(
|
|
226
|
+
requestParameters: DeleteChildDomainRequest,
|
|
227
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
228
|
+
): Promise<runtime.ApiResponse<void>>;
|
|
229
|
+
|
|
230
|
+
/**
|
|
231
|
+
* Delete the sender domain of the reseller child based on the childIdentifier and domainName passed
|
|
232
|
+
*/
|
|
233
|
+
deleteChildDomain(requestParameters: DeleteChildDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
234
|
+
|
|
235
|
+
/**
|
|
236
|
+
*
|
|
237
|
+
* @summary Delete a single reseller child based on the child identifier supplied
|
|
238
|
+
* @param {string} childIdentifier Either auth key or child id of reseller\'s child
|
|
239
|
+
* @param {*} [options] Override http request option.
|
|
240
|
+
* @throws {RequiredError}
|
|
241
|
+
* @memberof ResellerApiInterface
|
|
242
|
+
*/
|
|
243
|
+
deleteResellerChildRaw(
|
|
244
|
+
requestParameters: DeleteResellerChildRequest,
|
|
245
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
246
|
+
): Promise<runtime.ApiResponse<void>>;
|
|
247
|
+
|
|
248
|
+
/**
|
|
249
|
+
* Delete a single reseller child based on the child identifier supplied
|
|
250
|
+
*/
|
|
251
|
+
deleteResellerChild(
|
|
252
|
+
requestParameters: DeleteResellerChildRequest,
|
|
253
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
254
|
+
): Promise<void>;
|
|
255
|
+
|
|
256
|
+
/**
|
|
257
|
+
*
|
|
258
|
+
* @summary Dissociate a dedicated IP to the child
|
|
259
|
+
* @param {string} childIdentifier Either auth key or id of reseller\'s child
|
|
260
|
+
* @param {ManageIp} ip IP to dissociate
|
|
261
|
+
* @param {*} [options] Override http request option.
|
|
262
|
+
* @throws {RequiredError}
|
|
263
|
+
* @memberof ResellerApiInterface
|
|
264
|
+
*/
|
|
265
|
+
dissociateIpFromChildRaw(
|
|
266
|
+
requestParameters: DissociateIpFromChildRequest,
|
|
267
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
268
|
+
): Promise<runtime.ApiResponse<void>>;
|
|
269
|
+
|
|
270
|
+
/**
|
|
271
|
+
* Dissociate a dedicated IP to the child
|
|
272
|
+
*/
|
|
273
|
+
dissociateIpFromChild(
|
|
274
|
+
requestParameters: DissociateIpFromChildRequest,
|
|
275
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
276
|
+
): Promise<void>;
|
|
277
|
+
|
|
278
|
+
/**
|
|
279
|
+
*
|
|
280
|
+
* @summary Get the status of a reseller\'s child account creation, whether it is successfully created (exists) or not based on the childIdentifier supplied
|
|
281
|
+
* @param {string} childIdentifier Either auth key or id of reseller\'s child
|
|
282
|
+
* @param {*} [options] Override http request option.
|
|
283
|
+
* @throws {RequiredError}
|
|
284
|
+
* @memberof ResellerApiInterface
|
|
285
|
+
*/
|
|
286
|
+
getChildAccountCreationStatusRaw(
|
|
287
|
+
requestParameters: GetChildAccountCreationStatusRequest,
|
|
288
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
289
|
+
): Promise<runtime.ApiResponse<GetChildAccountCreationStatus>>;
|
|
290
|
+
|
|
291
|
+
/**
|
|
292
|
+
* Get the status of a reseller\'s child account creation, whether it is successfully created (exists) or not based on the childIdentifier supplied
|
|
293
|
+
*/
|
|
294
|
+
getChildAccountCreationStatus(
|
|
295
|
+
requestParameters: GetChildAccountCreationStatusRequest,
|
|
296
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
297
|
+
): Promise<GetChildAccountCreationStatus>;
|
|
298
|
+
|
|
299
|
+
/**
|
|
300
|
+
*
|
|
301
|
+
* @summary Get all sender domains for a specific child account
|
|
302
|
+
* @param {string} childIdentifier Either auth key or id of reseller\'s child
|
|
303
|
+
* @param {*} [options] Override http request option.
|
|
304
|
+
* @throws {RequiredError}
|
|
305
|
+
* @memberof ResellerApiInterface
|
|
306
|
+
*/
|
|
307
|
+
getChildDomainsRaw(
|
|
308
|
+
requestParameters: GetChildDomainsRequest,
|
|
309
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
310
|
+
): Promise<runtime.ApiResponse<Array<GetChildDomain>>>;
|
|
311
|
+
|
|
312
|
+
/**
|
|
313
|
+
* Get all sender domains for a specific child account
|
|
314
|
+
*/
|
|
315
|
+
getChildDomains(
|
|
316
|
+
requestParameters: GetChildDomainsRequest,
|
|
317
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
318
|
+
): Promise<Array<GetChildDomain>>;
|
|
319
|
+
|
|
320
|
+
/**
|
|
321
|
+
*
|
|
322
|
+
* @summary Get a child account\'s details
|
|
323
|
+
* @param {string} childIdentifier Either auth key or id of reseller\'s child
|
|
324
|
+
* @param {*} [options] Override http request option.
|
|
325
|
+
* @throws {RequiredError}
|
|
326
|
+
* @memberof ResellerApiInterface
|
|
327
|
+
*/
|
|
328
|
+
getChildInfoRaw(
|
|
329
|
+
requestParameters: GetChildInfoRequest,
|
|
330
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
331
|
+
): Promise<runtime.ApiResponse<GetChildInfo>>;
|
|
332
|
+
|
|
333
|
+
/**
|
|
334
|
+
* Get a child account\'s details
|
|
335
|
+
*/
|
|
336
|
+
getChildInfo(requestParameters: GetChildInfoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetChildInfo>;
|
|
337
|
+
|
|
338
|
+
/**
|
|
339
|
+
*
|
|
340
|
+
* @summary Get the list of all children accounts
|
|
341
|
+
* @param {number} [limit] Number of documents for child accounts information per page
|
|
342
|
+
* @param {number} [offset] Index of the first document in the page
|
|
343
|
+
* @param {*} [options] Override http request option.
|
|
344
|
+
* @throws {RequiredError}
|
|
345
|
+
* @memberof ResellerApiInterface
|
|
346
|
+
*/
|
|
347
|
+
getResellerChildsRaw(
|
|
348
|
+
requestParameters: GetResellerChildsRequest,
|
|
349
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
350
|
+
): Promise<runtime.ApiResponse<GetChildrenList>>;
|
|
351
|
+
|
|
352
|
+
/**
|
|
353
|
+
* Get the list of all children accounts
|
|
354
|
+
*/
|
|
355
|
+
getResellerChilds(
|
|
356
|
+
requestParameters: GetResellerChildsRequest,
|
|
357
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
358
|
+
): Promise<GetChildrenList>;
|
|
359
|
+
|
|
360
|
+
/**
|
|
361
|
+
* It returns a session [token] which will remain valid for a short period of time. A child account will be able to access a white-labeled section by using the following url pattern => https:/email.mydomain.com/login/sso?token=[token]
|
|
362
|
+
* @summary Get session token to access Sendinblue (SSO)
|
|
363
|
+
* @param {string} childIdentifier Either auth key or id of reseller\'s child
|
|
364
|
+
* @param {*} [options] Override http request option.
|
|
365
|
+
* @throws {RequiredError}
|
|
366
|
+
* @memberof ResellerApiInterface
|
|
367
|
+
*/
|
|
368
|
+
getSsoTokenRaw(
|
|
369
|
+
requestParameters: GetSsoTokenRequest,
|
|
370
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
371
|
+
): Promise<runtime.ApiResponse<GetSsoToken>>;
|
|
372
|
+
|
|
373
|
+
/**
|
|
374
|
+
* It returns a session [token] which will remain valid for a short period of time. A child account will be able to access a white-labeled section by using the following url pattern => https:/email.mydomain.com/login/sso?token=[token]
|
|
375
|
+
* Get session token to access Sendinblue (SSO)
|
|
376
|
+
*/
|
|
377
|
+
getSsoToken(requestParameters: GetSsoTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSsoToken>;
|
|
378
|
+
|
|
379
|
+
/**
|
|
380
|
+
*
|
|
381
|
+
* @summary Remove Email and/or SMS credits from a specific child account
|
|
382
|
+
* @param {string} childIdentifier Either auth key or id of reseller\'s child
|
|
383
|
+
* @param {RemoveCredits} removeCredits Values to post to remove email or SMS credits from a specific child account
|
|
384
|
+
* @param {*} [options] Override http request option.
|
|
385
|
+
* @throws {RequiredError}
|
|
386
|
+
* @memberof ResellerApiInterface
|
|
387
|
+
*/
|
|
388
|
+
removeCreditsRaw(
|
|
389
|
+
requestParameters: RemoveCreditsRequest,
|
|
390
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
391
|
+
): Promise<runtime.ApiResponse<RemainingCreditModel>>;
|
|
392
|
+
|
|
393
|
+
/**
|
|
394
|
+
* Remove Email and/or SMS credits from a specific child account
|
|
395
|
+
*/
|
|
396
|
+
removeCredits(
|
|
397
|
+
requestParameters: RemoveCreditsRequest,
|
|
398
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
399
|
+
): Promise<RemainingCreditModel>;
|
|
400
|
+
|
|
401
|
+
/**
|
|
402
|
+
*
|
|
403
|
+
* @summary Update info of reseller\'s child account status based on the identifier supplied
|
|
404
|
+
* @param {string} childIdentifier Either auth key or id of reseller\'s child
|
|
405
|
+
* @param {UpdateChildAccountStatus} updateChildAccountStatus values to update in child account status
|
|
406
|
+
* @param {*} [options] Override http request option.
|
|
407
|
+
* @throws {RequiredError}
|
|
408
|
+
* @memberof ResellerApiInterface
|
|
409
|
+
*/
|
|
410
|
+
updateChildAccountStatusRaw(
|
|
411
|
+
requestParameters: UpdateChildAccountStatusRequest,
|
|
412
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
413
|
+
): Promise<runtime.ApiResponse<void>>;
|
|
414
|
+
|
|
415
|
+
/**
|
|
416
|
+
* Update info of reseller\'s child account status based on the identifier supplied
|
|
417
|
+
*/
|
|
418
|
+
updateChildAccountStatus(
|
|
419
|
+
requestParameters: UpdateChildAccountStatusRequest,
|
|
420
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
421
|
+
): Promise<void>;
|
|
422
|
+
|
|
423
|
+
/**
|
|
424
|
+
*
|
|
425
|
+
* @summary Update the sender domain of reseller\'s child based on the childIdentifier and domainName passed
|
|
426
|
+
* @param {string} childIdentifier Either auth key or id of reseller\'s child
|
|
427
|
+
* @param {string} domainName Pass the existing domain that needs to be updated
|
|
428
|
+
* @param {UpdateChildDomain} updateChildDomain value to update for sender domain
|
|
429
|
+
* @param {*} [options] Override http request option.
|
|
430
|
+
* @throws {RequiredError}
|
|
431
|
+
* @memberof ResellerApiInterface
|
|
432
|
+
*/
|
|
433
|
+
updateChildDomainRaw(
|
|
434
|
+
requestParameters: UpdateChildDomainRequest,
|
|
435
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
436
|
+
): Promise<runtime.ApiResponse<void>>;
|
|
437
|
+
|
|
438
|
+
/**
|
|
439
|
+
* Update the sender domain of reseller\'s child based on the childIdentifier and domainName passed
|
|
440
|
+
*/
|
|
441
|
+
updateChildDomain(requestParameters: UpdateChildDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
442
|
+
|
|
443
|
+
/**
|
|
444
|
+
*
|
|
445
|
+
* @summary Update info of reseller\'s child based on the child identifier supplied
|
|
446
|
+
* @param {string} childIdentifier Either auth key or id of reseller\'s child
|
|
447
|
+
* @param {UpdateChild} resellerChild values to update in child profile
|
|
448
|
+
* @param {*} [options] Override http request option.
|
|
449
|
+
* @throws {RequiredError}
|
|
450
|
+
* @memberof ResellerApiInterface
|
|
451
|
+
*/
|
|
452
|
+
updateResellerChildRaw(
|
|
453
|
+
requestParameters: UpdateResellerChildRequest,
|
|
454
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
455
|
+
): Promise<runtime.ApiResponse<void>>;
|
|
456
|
+
|
|
457
|
+
/**
|
|
458
|
+
* Update info of reseller\'s child based on the child identifier supplied
|
|
459
|
+
*/
|
|
460
|
+
updateResellerChild(
|
|
461
|
+
requestParameters: UpdateResellerChildRequest,
|
|
462
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
463
|
+
): Promise<void>;
|
|
464
|
+
}
|
|
465
|
+
|
|
466
|
+
/**
|
|
467
|
+
*
|
|
468
|
+
*/
|
|
469
|
+
export class ResellerApi extends runtime.BaseAPI implements ResellerApiInterface {
|
|
470
|
+
/**
|
|
471
|
+
* Add Email and/or SMS credits to a specific child account
|
|
472
|
+
*/
|
|
473
|
+
async addCreditsRaw(
|
|
474
|
+
requestParameters: AddCreditsRequest,
|
|
475
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
476
|
+
): Promise<runtime.ApiResponse<RemainingCreditModel>> {
|
|
477
|
+
if (requestParameters.childIdentifier === null || requestParameters.childIdentifier === undefined) {
|
|
478
|
+
throw new runtime.RequiredError(
|
|
479
|
+
'childIdentifier',
|
|
480
|
+
'Required parameter requestParameters.childIdentifier was null or undefined when calling addCredits.',
|
|
481
|
+
);
|
|
482
|
+
}
|
|
483
|
+
|
|
484
|
+
if (requestParameters.addCredits === null || requestParameters.addCredits === undefined) {
|
|
485
|
+
throw new runtime.RequiredError(
|
|
486
|
+
'addCredits',
|
|
487
|
+
'Required parameter requestParameters.addCredits was null or undefined when calling addCredits.',
|
|
488
|
+
);
|
|
489
|
+
}
|
|
490
|
+
|
|
491
|
+
const queryParameters: any = {};
|
|
492
|
+
|
|
493
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
494
|
+
|
|
495
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
496
|
+
|
|
497
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
498
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
499
|
+
}
|
|
500
|
+
|
|
501
|
+
const response = await this.request(
|
|
502
|
+
{
|
|
503
|
+
path: `/reseller/children/{childIdentifier}/credits/add`.replace(
|
|
504
|
+
`{${'childIdentifier'}}`,
|
|
505
|
+
encodeURIComponent(String(requestParameters.childIdentifier)),
|
|
506
|
+
),
|
|
507
|
+
method: 'POST',
|
|
508
|
+
headers: headerParameters,
|
|
509
|
+
query: queryParameters,
|
|
510
|
+
body: AddCreditsToJSON(requestParameters.addCredits),
|
|
511
|
+
},
|
|
512
|
+
initOverrides,
|
|
513
|
+
);
|
|
514
|
+
|
|
515
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => RemainingCreditModelFromJSON(jsonValue));
|
|
516
|
+
}
|
|
517
|
+
|
|
518
|
+
/**
|
|
519
|
+
* Add Email and/or SMS credits to a specific child account
|
|
520
|
+
*/
|
|
521
|
+
async addCredits(
|
|
522
|
+
requestParameters: AddCreditsRequest,
|
|
523
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
524
|
+
): Promise<RemainingCreditModel> {
|
|
525
|
+
const response = await this.addCreditsRaw(requestParameters, initOverrides);
|
|
526
|
+
return await response.value();
|
|
527
|
+
}
|
|
528
|
+
|
|
529
|
+
/**
|
|
530
|
+
* Associate a dedicated IP to the child
|
|
531
|
+
*/
|
|
532
|
+
async associateIpToChildRaw(
|
|
533
|
+
requestParameters: AssociateIpToChildRequest,
|
|
534
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
535
|
+
): Promise<runtime.ApiResponse<void>> {
|
|
536
|
+
if (requestParameters.childIdentifier === null || requestParameters.childIdentifier === undefined) {
|
|
537
|
+
throw new runtime.RequiredError(
|
|
538
|
+
'childIdentifier',
|
|
539
|
+
'Required parameter requestParameters.childIdentifier was null or undefined when calling associateIpToChild.',
|
|
540
|
+
);
|
|
541
|
+
}
|
|
542
|
+
|
|
543
|
+
if (requestParameters.ip === null || requestParameters.ip === undefined) {
|
|
544
|
+
throw new runtime.RequiredError(
|
|
545
|
+
'ip',
|
|
546
|
+
'Required parameter requestParameters.ip was null or undefined when calling associateIpToChild.',
|
|
547
|
+
);
|
|
548
|
+
}
|
|
549
|
+
|
|
550
|
+
const queryParameters: any = {};
|
|
551
|
+
|
|
552
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
553
|
+
|
|
554
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
555
|
+
|
|
556
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
557
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
558
|
+
}
|
|
559
|
+
|
|
560
|
+
const response = await this.request(
|
|
561
|
+
{
|
|
562
|
+
path: `/reseller/children/{childIdentifier}/ips/associate`.replace(
|
|
563
|
+
`{${'childIdentifier'}}`,
|
|
564
|
+
encodeURIComponent(String(requestParameters.childIdentifier)),
|
|
565
|
+
),
|
|
566
|
+
method: 'POST',
|
|
567
|
+
headers: headerParameters,
|
|
568
|
+
query: queryParameters,
|
|
569
|
+
body: ManageIpToJSON(requestParameters.ip),
|
|
570
|
+
},
|
|
571
|
+
initOverrides,
|
|
572
|
+
);
|
|
573
|
+
|
|
574
|
+
return new runtime.VoidApiResponse(response);
|
|
575
|
+
}
|
|
576
|
+
|
|
577
|
+
/**
|
|
578
|
+
* Associate a dedicated IP to the child
|
|
579
|
+
*/
|
|
580
|
+
async associateIpToChild(
|
|
581
|
+
requestParameters: AssociateIpToChildRequest,
|
|
582
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
583
|
+
): Promise<void> {
|
|
584
|
+
await this.associateIpToChildRaw(requestParameters, initOverrides);
|
|
585
|
+
}
|
|
586
|
+
|
|
587
|
+
/**
|
|
588
|
+
* Create a domain for a child account
|
|
589
|
+
*/
|
|
590
|
+
async createChildDomainRaw(
|
|
591
|
+
requestParameters: CreateChildDomainRequest,
|
|
592
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
593
|
+
): Promise<runtime.ApiResponse<void>> {
|
|
594
|
+
if (requestParameters.childIdentifier === null || requestParameters.childIdentifier === undefined) {
|
|
595
|
+
throw new runtime.RequiredError(
|
|
596
|
+
'childIdentifier',
|
|
597
|
+
'Required parameter requestParameters.childIdentifier was null or undefined when calling createChildDomain.',
|
|
598
|
+
);
|
|
599
|
+
}
|
|
600
|
+
|
|
601
|
+
if (requestParameters.addChildDomain === null || requestParameters.addChildDomain === undefined) {
|
|
602
|
+
throw new runtime.RequiredError(
|
|
603
|
+
'addChildDomain',
|
|
604
|
+
'Required parameter requestParameters.addChildDomain was null or undefined when calling createChildDomain.',
|
|
605
|
+
);
|
|
606
|
+
}
|
|
607
|
+
|
|
608
|
+
const queryParameters: any = {};
|
|
609
|
+
|
|
610
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
611
|
+
|
|
612
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
613
|
+
|
|
614
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
615
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
616
|
+
}
|
|
617
|
+
|
|
618
|
+
const response = await this.request(
|
|
619
|
+
{
|
|
620
|
+
path: `/reseller/children/{childIdentifier}/domains`.replace(
|
|
621
|
+
`{${'childIdentifier'}}`,
|
|
622
|
+
encodeURIComponent(String(requestParameters.childIdentifier)),
|
|
623
|
+
),
|
|
624
|
+
method: 'POST',
|
|
625
|
+
headers: headerParameters,
|
|
626
|
+
query: queryParameters,
|
|
627
|
+
body: AddChildDomainToJSON(requestParameters.addChildDomain),
|
|
628
|
+
},
|
|
629
|
+
initOverrides,
|
|
630
|
+
);
|
|
631
|
+
|
|
632
|
+
return new runtime.VoidApiResponse(response);
|
|
633
|
+
}
|
|
634
|
+
|
|
635
|
+
/**
|
|
636
|
+
* Create a domain for a child account
|
|
637
|
+
*/
|
|
638
|
+
async createChildDomain(
|
|
639
|
+
requestParameters: CreateChildDomainRequest,
|
|
640
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
641
|
+
): Promise<void> {
|
|
642
|
+
await this.createChildDomainRaw(requestParameters, initOverrides);
|
|
643
|
+
}
|
|
644
|
+
|
|
645
|
+
/**
|
|
646
|
+
* Creates a reseller child
|
|
647
|
+
*/
|
|
648
|
+
async createResellerChildRaw(
|
|
649
|
+
requestParameters: CreateResellerChildRequest,
|
|
650
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
651
|
+
): Promise<runtime.ApiResponse<CreateReseller>> {
|
|
652
|
+
const queryParameters: any = {};
|
|
653
|
+
|
|
654
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
655
|
+
|
|
656
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
657
|
+
|
|
658
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
659
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
660
|
+
}
|
|
661
|
+
|
|
662
|
+
const response = await this.request(
|
|
663
|
+
{
|
|
664
|
+
path: `/reseller/children`,
|
|
665
|
+
method: 'POST',
|
|
666
|
+
headers: headerParameters,
|
|
667
|
+
query: queryParameters,
|
|
668
|
+
body: CreateChildToJSON(requestParameters.resellerChild),
|
|
669
|
+
},
|
|
670
|
+
initOverrides,
|
|
671
|
+
);
|
|
672
|
+
|
|
673
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => CreateResellerFromJSON(jsonValue));
|
|
674
|
+
}
|
|
675
|
+
|
|
676
|
+
/**
|
|
677
|
+
* Creates a reseller child
|
|
678
|
+
*/
|
|
679
|
+
async createResellerChild(
|
|
680
|
+
requestParameters: CreateResellerChildRequest = {},
|
|
681
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
682
|
+
): Promise<CreateReseller> {
|
|
683
|
+
const response = await this.createResellerChildRaw(requestParameters, initOverrides);
|
|
684
|
+
return await response.value();
|
|
685
|
+
}
|
|
686
|
+
|
|
687
|
+
/**
|
|
688
|
+
* Delete the sender domain of the reseller child based on the childIdentifier and domainName passed
|
|
689
|
+
*/
|
|
690
|
+
async deleteChildDomainRaw(
|
|
691
|
+
requestParameters: DeleteChildDomainRequest,
|
|
692
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
693
|
+
): Promise<runtime.ApiResponse<void>> {
|
|
694
|
+
if (requestParameters.childIdentifier === null || requestParameters.childIdentifier === undefined) {
|
|
695
|
+
throw new runtime.RequiredError(
|
|
696
|
+
'childIdentifier',
|
|
697
|
+
'Required parameter requestParameters.childIdentifier was null or undefined when calling deleteChildDomain.',
|
|
698
|
+
);
|
|
699
|
+
}
|
|
700
|
+
|
|
701
|
+
if (requestParameters.domainName === null || requestParameters.domainName === undefined) {
|
|
702
|
+
throw new runtime.RequiredError(
|
|
703
|
+
'domainName',
|
|
704
|
+
'Required parameter requestParameters.domainName was null or undefined when calling deleteChildDomain.',
|
|
705
|
+
);
|
|
706
|
+
}
|
|
707
|
+
|
|
708
|
+
const queryParameters: any = {};
|
|
709
|
+
|
|
710
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
711
|
+
|
|
712
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
713
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
714
|
+
}
|
|
715
|
+
|
|
716
|
+
const response = await this.request(
|
|
717
|
+
{
|
|
718
|
+
path: `/reseller/children/{childIdentifier}/domains/{domainName}`
|
|
719
|
+
.replace(`{${'childIdentifier'}}`, encodeURIComponent(String(requestParameters.childIdentifier)))
|
|
720
|
+
.replace(`{${'domainName'}}`, encodeURIComponent(String(requestParameters.domainName))),
|
|
721
|
+
method: 'DELETE',
|
|
722
|
+
headers: headerParameters,
|
|
723
|
+
query: queryParameters,
|
|
724
|
+
},
|
|
725
|
+
initOverrides,
|
|
726
|
+
);
|
|
727
|
+
|
|
728
|
+
return new runtime.VoidApiResponse(response);
|
|
729
|
+
}
|
|
730
|
+
|
|
731
|
+
/**
|
|
732
|
+
* Delete the sender domain of the reseller child based on the childIdentifier and domainName passed
|
|
733
|
+
*/
|
|
734
|
+
async deleteChildDomain(
|
|
735
|
+
requestParameters: DeleteChildDomainRequest,
|
|
736
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
737
|
+
): Promise<void> {
|
|
738
|
+
await this.deleteChildDomainRaw(requestParameters, initOverrides);
|
|
739
|
+
}
|
|
740
|
+
|
|
741
|
+
/**
|
|
742
|
+
* Delete a single reseller child based on the child identifier supplied
|
|
743
|
+
*/
|
|
744
|
+
async deleteResellerChildRaw(
|
|
745
|
+
requestParameters: DeleteResellerChildRequest,
|
|
746
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
747
|
+
): Promise<runtime.ApiResponse<void>> {
|
|
748
|
+
if (requestParameters.childIdentifier === null || requestParameters.childIdentifier === undefined) {
|
|
749
|
+
throw new runtime.RequiredError(
|
|
750
|
+
'childIdentifier',
|
|
751
|
+
'Required parameter requestParameters.childIdentifier was null or undefined when calling deleteResellerChild.',
|
|
752
|
+
);
|
|
753
|
+
}
|
|
754
|
+
|
|
755
|
+
const queryParameters: any = {};
|
|
756
|
+
|
|
757
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
758
|
+
|
|
759
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
760
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
761
|
+
}
|
|
762
|
+
|
|
763
|
+
const response = await this.request(
|
|
764
|
+
{
|
|
765
|
+
path: `/reseller/children/{childIdentifier}`.replace(
|
|
766
|
+
`{${'childIdentifier'}}`,
|
|
767
|
+
encodeURIComponent(String(requestParameters.childIdentifier)),
|
|
768
|
+
),
|
|
769
|
+
method: 'DELETE',
|
|
770
|
+
headers: headerParameters,
|
|
771
|
+
query: queryParameters,
|
|
772
|
+
},
|
|
773
|
+
initOverrides,
|
|
774
|
+
);
|
|
775
|
+
|
|
776
|
+
return new runtime.VoidApiResponse(response);
|
|
777
|
+
}
|
|
778
|
+
|
|
779
|
+
/**
|
|
780
|
+
* Delete a single reseller child based on the child identifier supplied
|
|
781
|
+
*/
|
|
782
|
+
async deleteResellerChild(
|
|
783
|
+
requestParameters: DeleteResellerChildRequest,
|
|
784
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
785
|
+
): Promise<void> {
|
|
786
|
+
await this.deleteResellerChildRaw(requestParameters, initOverrides);
|
|
787
|
+
}
|
|
788
|
+
|
|
789
|
+
/**
|
|
790
|
+
* Dissociate a dedicated IP to the child
|
|
791
|
+
*/
|
|
792
|
+
async dissociateIpFromChildRaw(
|
|
793
|
+
requestParameters: DissociateIpFromChildRequest,
|
|
794
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
795
|
+
): Promise<runtime.ApiResponse<void>> {
|
|
796
|
+
if (requestParameters.childIdentifier === null || requestParameters.childIdentifier === undefined) {
|
|
797
|
+
throw new runtime.RequiredError(
|
|
798
|
+
'childIdentifier',
|
|
799
|
+
'Required parameter requestParameters.childIdentifier was null or undefined when calling dissociateIpFromChild.',
|
|
800
|
+
);
|
|
801
|
+
}
|
|
802
|
+
|
|
803
|
+
if (requestParameters.ip === null || requestParameters.ip === undefined) {
|
|
804
|
+
throw new runtime.RequiredError(
|
|
805
|
+
'ip',
|
|
806
|
+
'Required parameter requestParameters.ip was null or undefined when calling dissociateIpFromChild.',
|
|
807
|
+
);
|
|
808
|
+
}
|
|
809
|
+
|
|
810
|
+
const queryParameters: any = {};
|
|
811
|
+
|
|
812
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
813
|
+
|
|
814
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
815
|
+
|
|
816
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
817
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
818
|
+
}
|
|
819
|
+
|
|
820
|
+
const response = await this.request(
|
|
821
|
+
{
|
|
822
|
+
path: `/reseller/children/{childIdentifier}/ips/dissociate`.replace(
|
|
823
|
+
`{${'childIdentifier'}}`,
|
|
824
|
+
encodeURIComponent(String(requestParameters.childIdentifier)),
|
|
825
|
+
),
|
|
826
|
+
method: 'POST',
|
|
827
|
+
headers: headerParameters,
|
|
828
|
+
query: queryParameters,
|
|
829
|
+
body: ManageIpToJSON(requestParameters.ip),
|
|
830
|
+
},
|
|
831
|
+
initOverrides,
|
|
832
|
+
);
|
|
833
|
+
|
|
834
|
+
return new runtime.VoidApiResponse(response);
|
|
835
|
+
}
|
|
836
|
+
|
|
837
|
+
/**
|
|
838
|
+
* Dissociate a dedicated IP to the child
|
|
839
|
+
*/
|
|
840
|
+
async dissociateIpFromChild(
|
|
841
|
+
requestParameters: DissociateIpFromChildRequest,
|
|
842
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
843
|
+
): Promise<void> {
|
|
844
|
+
await this.dissociateIpFromChildRaw(requestParameters, initOverrides);
|
|
845
|
+
}
|
|
846
|
+
|
|
847
|
+
/**
|
|
848
|
+
* Get the status of a reseller\'s child account creation, whether it is successfully created (exists) or not based on the childIdentifier supplied
|
|
849
|
+
*/
|
|
850
|
+
async getChildAccountCreationStatusRaw(
|
|
851
|
+
requestParameters: GetChildAccountCreationStatusRequest,
|
|
852
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
853
|
+
): Promise<runtime.ApiResponse<GetChildAccountCreationStatus>> {
|
|
854
|
+
if (requestParameters.childIdentifier === null || requestParameters.childIdentifier === undefined) {
|
|
855
|
+
throw new runtime.RequiredError(
|
|
856
|
+
'childIdentifier',
|
|
857
|
+
'Required parameter requestParameters.childIdentifier was null or undefined when calling getChildAccountCreationStatus.',
|
|
858
|
+
);
|
|
859
|
+
}
|
|
860
|
+
|
|
861
|
+
const queryParameters: any = {};
|
|
862
|
+
|
|
863
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
864
|
+
|
|
865
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
866
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
867
|
+
}
|
|
868
|
+
|
|
869
|
+
const response = await this.request(
|
|
870
|
+
{
|
|
871
|
+
path: `/reseller/children/{childIdentifier}/accountCreationStatus`.replace(
|
|
872
|
+
`{${'childIdentifier'}}`,
|
|
873
|
+
encodeURIComponent(String(requestParameters.childIdentifier)),
|
|
874
|
+
),
|
|
875
|
+
method: 'GET',
|
|
876
|
+
headers: headerParameters,
|
|
877
|
+
query: queryParameters,
|
|
878
|
+
},
|
|
879
|
+
initOverrides,
|
|
880
|
+
);
|
|
881
|
+
|
|
882
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetChildAccountCreationStatusFromJSON(jsonValue));
|
|
883
|
+
}
|
|
884
|
+
|
|
885
|
+
/**
|
|
886
|
+
* Get the status of a reseller\'s child account creation, whether it is successfully created (exists) or not based on the childIdentifier supplied
|
|
887
|
+
*/
|
|
888
|
+
async getChildAccountCreationStatus(
|
|
889
|
+
requestParameters: GetChildAccountCreationStatusRequest,
|
|
890
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
891
|
+
): Promise<GetChildAccountCreationStatus> {
|
|
892
|
+
const response = await this.getChildAccountCreationStatusRaw(requestParameters, initOverrides);
|
|
893
|
+
return await response.value();
|
|
894
|
+
}
|
|
895
|
+
|
|
896
|
+
/**
|
|
897
|
+
* Get all sender domains for a specific child account
|
|
898
|
+
*/
|
|
899
|
+
async getChildDomainsRaw(
|
|
900
|
+
requestParameters: GetChildDomainsRequest,
|
|
901
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
902
|
+
): Promise<runtime.ApiResponse<Array<GetChildDomain>>> {
|
|
903
|
+
if (requestParameters.childIdentifier === null || requestParameters.childIdentifier === undefined) {
|
|
904
|
+
throw new runtime.RequiredError(
|
|
905
|
+
'childIdentifier',
|
|
906
|
+
'Required parameter requestParameters.childIdentifier was null or undefined when calling getChildDomains.',
|
|
907
|
+
);
|
|
908
|
+
}
|
|
909
|
+
|
|
910
|
+
const queryParameters: any = {};
|
|
911
|
+
|
|
912
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
913
|
+
|
|
914
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
915
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
916
|
+
}
|
|
917
|
+
|
|
918
|
+
const response = await this.request(
|
|
919
|
+
{
|
|
920
|
+
path: `/reseller/children/{childIdentifier}/domains`.replace(
|
|
921
|
+
`{${'childIdentifier'}}`,
|
|
922
|
+
encodeURIComponent(String(requestParameters.childIdentifier)),
|
|
923
|
+
),
|
|
924
|
+
method: 'GET',
|
|
925
|
+
headers: headerParameters,
|
|
926
|
+
query: queryParameters,
|
|
927
|
+
},
|
|
928
|
+
initOverrides,
|
|
929
|
+
);
|
|
930
|
+
|
|
931
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GetChildDomainFromJSON));
|
|
932
|
+
}
|
|
933
|
+
|
|
934
|
+
/**
|
|
935
|
+
* Get all sender domains for a specific child account
|
|
936
|
+
*/
|
|
937
|
+
async getChildDomains(
|
|
938
|
+
requestParameters: GetChildDomainsRequest,
|
|
939
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
940
|
+
): Promise<Array<GetChildDomain>> {
|
|
941
|
+
const response = await this.getChildDomainsRaw(requestParameters, initOverrides);
|
|
942
|
+
return await response.value();
|
|
943
|
+
}
|
|
944
|
+
|
|
945
|
+
/**
|
|
946
|
+
* Get a child account\'s details
|
|
947
|
+
*/
|
|
948
|
+
async getChildInfoRaw(
|
|
949
|
+
requestParameters: GetChildInfoRequest,
|
|
950
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
951
|
+
): Promise<runtime.ApiResponse<GetChildInfo>> {
|
|
952
|
+
if (requestParameters.childIdentifier === null || requestParameters.childIdentifier === undefined) {
|
|
953
|
+
throw new runtime.RequiredError(
|
|
954
|
+
'childIdentifier',
|
|
955
|
+
'Required parameter requestParameters.childIdentifier was null or undefined when calling getChildInfo.',
|
|
956
|
+
);
|
|
957
|
+
}
|
|
958
|
+
|
|
959
|
+
const queryParameters: any = {};
|
|
960
|
+
|
|
961
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
962
|
+
|
|
963
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
964
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
965
|
+
}
|
|
966
|
+
|
|
967
|
+
const response = await this.request(
|
|
968
|
+
{
|
|
969
|
+
path: `/reseller/children/{childIdentifier}`.replace(
|
|
970
|
+
`{${'childIdentifier'}}`,
|
|
971
|
+
encodeURIComponent(String(requestParameters.childIdentifier)),
|
|
972
|
+
),
|
|
973
|
+
method: 'GET',
|
|
974
|
+
headers: headerParameters,
|
|
975
|
+
query: queryParameters,
|
|
976
|
+
},
|
|
977
|
+
initOverrides,
|
|
978
|
+
);
|
|
979
|
+
|
|
980
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetChildInfoFromJSON(jsonValue));
|
|
981
|
+
}
|
|
982
|
+
|
|
983
|
+
/**
|
|
984
|
+
* Get a child account\'s details
|
|
985
|
+
*/
|
|
986
|
+
async getChildInfo(
|
|
987
|
+
requestParameters: GetChildInfoRequest,
|
|
988
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
989
|
+
): Promise<GetChildInfo> {
|
|
990
|
+
const response = await this.getChildInfoRaw(requestParameters, initOverrides);
|
|
991
|
+
return await response.value();
|
|
992
|
+
}
|
|
993
|
+
|
|
994
|
+
/**
|
|
995
|
+
* Get the list of all children accounts
|
|
996
|
+
*/
|
|
997
|
+
async getResellerChildsRaw(
|
|
998
|
+
requestParameters: GetResellerChildsRequest,
|
|
999
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1000
|
+
): Promise<runtime.ApiResponse<GetChildrenList>> {
|
|
1001
|
+
const queryParameters: any = {};
|
|
1002
|
+
|
|
1003
|
+
if (requestParameters.limit !== undefined) {
|
|
1004
|
+
queryParameters['limit'] = requestParameters.limit;
|
|
1005
|
+
}
|
|
1006
|
+
|
|
1007
|
+
if (requestParameters.offset !== undefined) {
|
|
1008
|
+
queryParameters['offset'] = requestParameters.offset;
|
|
1009
|
+
}
|
|
1010
|
+
|
|
1011
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1012
|
+
|
|
1013
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1014
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
1015
|
+
}
|
|
1016
|
+
|
|
1017
|
+
const response = await this.request(
|
|
1018
|
+
{
|
|
1019
|
+
path: `/reseller/children`,
|
|
1020
|
+
method: 'GET',
|
|
1021
|
+
headers: headerParameters,
|
|
1022
|
+
query: queryParameters,
|
|
1023
|
+
},
|
|
1024
|
+
initOverrides,
|
|
1025
|
+
);
|
|
1026
|
+
|
|
1027
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetChildrenListFromJSON(jsonValue));
|
|
1028
|
+
}
|
|
1029
|
+
|
|
1030
|
+
/**
|
|
1031
|
+
* Get the list of all children accounts
|
|
1032
|
+
*/
|
|
1033
|
+
async getResellerChilds(
|
|
1034
|
+
requestParameters: GetResellerChildsRequest = {},
|
|
1035
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1036
|
+
): Promise<GetChildrenList> {
|
|
1037
|
+
const response = await this.getResellerChildsRaw(requestParameters, initOverrides);
|
|
1038
|
+
return await response.value();
|
|
1039
|
+
}
|
|
1040
|
+
|
|
1041
|
+
/**
|
|
1042
|
+
* It returns a session [token] which will remain valid for a short period of time. A child account will be able to access a white-labeled section by using the following url pattern => https:/email.mydomain.com/login/sso?token=[token]
|
|
1043
|
+
* Get session token to access Sendinblue (SSO)
|
|
1044
|
+
*/
|
|
1045
|
+
async getSsoTokenRaw(
|
|
1046
|
+
requestParameters: GetSsoTokenRequest,
|
|
1047
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1048
|
+
): Promise<runtime.ApiResponse<GetSsoToken>> {
|
|
1049
|
+
if (requestParameters.childIdentifier === null || requestParameters.childIdentifier === undefined) {
|
|
1050
|
+
throw new runtime.RequiredError(
|
|
1051
|
+
'childIdentifier',
|
|
1052
|
+
'Required parameter requestParameters.childIdentifier was null or undefined when calling getSsoToken.',
|
|
1053
|
+
);
|
|
1054
|
+
}
|
|
1055
|
+
|
|
1056
|
+
const queryParameters: any = {};
|
|
1057
|
+
|
|
1058
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1059
|
+
|
|
1060
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1061
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
1062
|
+
}
|
|
1063
|
+
|
|
1064
|
+
const response = await this.request(
|
|
1065
|
+
{
|
|
1066
|
+
path: `/reseller/children/{childIdentifier}/auth`.replace(
|
|
1067
|
+
`{${'childIdentifier'}}`,
|
|
1068
|
+
encodeURIComponent(String(requestParameters.childIdentifier)),
|
|
1069
|
+
),
|
|
1070
|
+
method: 'GET',
|
|
1071
|
+
headers: headerParameters,
|
|
1072
|
+
query: queryParameters,
|
|
1073
|
+
},
|
|
1074
|
+
initOverrides,
|
|
1075
|
+
);
|
|
1076
|
+
|
|
1077
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetSsoTokenFromJSON(jsonValue));
|
|
1078
|
+
}
|
|
1079
|
+
|
|
1080
|
+
/**
|
|
1081
|
+
* It returns a session [token] which will remain valid for a short period of time. A child account will be able to access a white-labeled section by using the following url pattern => https:/email.mydomain.com/login/sso?token=[token]
|
|
1082
|
+
* Get session token to access Sendinblue (SSO)
|
|
1083
|
+
*/
|
|
1084
|
+
async getSsoToken(
|
|
1085
|
+
requestParameters: GetSsoTokenRequest,
|
|
1086
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1087
|
+
): Promise<GetSsoToken> {
|
|
1088
|
+
const response = await this.getSsoTokenRaw(requestParameters, initOverrides);
|
|
1089
|
+
return await response.value();
|
|
1090
|
+
}
|
|
1091
|
+
|
|
1092
|
+
/**
|
|
1093
|
+
* Remove Email and/or SMS credits from a specific child account
|
|
1094
|
+
*/
|
|
1095
|
+
async removeCreditsRaw(
|
|
1096
|
+
requestParameters: RemoveCreditsRequest,
|
|
1097
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1098
|
+
): Promise<runtime.ApiResponse<RemainingCreditModel>> {
|
|
1099
|
+
if (requestParameters.childIdentifier === null || requestParameters.childIdentifier === undefined) {
|
|
1100
|
+
throw new runtime.RequiredError(
|
|
1101
|
+
'childIdentifier',
|
|
1102
|
+
'Required parameter requestParameters.childIdentifier was null or undefined when calling removeCredits.',
|
|
1103
|
+
);
|
|
1104
|
+
}
|
|
1105
|
+
|
|
1106
|
+
if (requestParameters.removeCredits === null || requestParameters.removeCredits === undefined) {
|
|
1107
|
+
throw new runtime.RequiredError(
|
|
1108
|
+
'removeCredits',
|
|
1109
|
+
'Required parameter requestParameters.removeCredits was null or undefined when calling removeCredits.',
|
|
1110
|
+
);
|
|
1111
|
+
}
|
|
1112
|
+
|
|
1113
|
+
const queryParameters: any = {};
|
|
1114
|
+
|
|
1115
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1116
|
+
|
|
1117
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
1118
|
+
|
|
1119
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1120
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
1121
|
+
}
|
|
1122
|
+
|
|
1123
|
+
const response = await this.request(
|
|
1124
|
+
{
|
|
1125
|
+
path: `/reseller/children/{childIdentifier}/credits/remove`.replace(
|
|
1126
|
+
`{${'childIdentifier'}}`,
|
|
1127
|
+
encodeURIComponent(String(requestParameters.childIdentifier)),
|
|
1128
|
+
),
|
|
1129
|
+
method: 'POST',
|
|
1130
|
+
headers: headerParameters,
|
|
1131
|
+
query: queryParameters,
|
|
1132
|
+
body: RemoveCreditsToJSON(requestParameters.removeCredits),
|
|
1133
|
+
},
|
|
1134
|
+
initOverrides,
|
|
1135
|
+
);
|
|
1136
|
+
|
|
1137
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => RemainingCreditModelFromJSON(jsonValue));
|
|
1138
|
+
}
|
|
1139
|
+
|
|
1140
|
+
/**
|
|
1141
|
+
* Remove Email and/or SMS credits from a specific child account
|
|
1142
|
+
*/
|
|
1143
|
+
async removeCredits(
|
|
1144
|
+
requestParameters: RemoveCreditsRequest,
|
|
1145
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1146
|
+
): Promise<RemainingCreditModel> {
|
|
1147
|
+
const response = await this.removeCreditsRaw(requestParameters, initOverrides);
|
|
1148
|
+
return await response.value();
|
|
1149
|
+
}
|
|
1150
|
+
|
|
1151
|
+
/**
|
|
1152
|
+
* Update info of reseller\'s child account status based on the identifier supplied
|
|
1153
|
+
*/
|
|
1154
|
+
async updateChildAccountStatusRaw(
|
|
1155
|
+
requestParameters: UpdateChildAccountStatusRequest,
|
|
1156
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1157
|
+
): Promise<runtime.ApiResponse<void>> {
|
|
1158
|
+
if (requestParameters.childIdentifier === null || requestParameters.childIdentifier === undefined) {
|
|
1159
|
+
throw new runtime.RequiredError(
|
|
1160
|
+
'childIdentifier',
|
|
1161
|
+
'Required parameter requestParameters.childIdentifier was null or undefined when calling updateChildAccountStatus.',
|
|
1162
|
+
);
|
|
1163
|
+
}
|
|
1164
|
+
|
|
1165
|
+
if (requestParameters.updateChildAccountStatus === null || requestParameters.updateChildAccountStatus === undefined) {
|
|
1166
|
+
throw new runtime.RequiredError(
|
|
1167
|
+
'updateChildAccountStatus',
|
|
1168
|
+
'Required parameter requestParameters.updateChildAccountStatus was null or undefined when calling updateChildAccountStatus.',
|
|
1169
|
+
);
|
|
1170
|
+
}
|
|
1171
|
+
|
|
1172
|
+
const queryParameters: any = {};
|
|
1173
|
+
|
|
1174
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1175
|
+
|
|
1176
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
1177
|
+
|
|
1178
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1179
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
1180
|
+
}
|
|
1181
|
+
|
|
1182
|
+
const response = await this.request(
|
|
1183
|
+
{
|
|
1184
|
+
path: `/reseller/children/{childIdentifier}/accountStatus`.replace(
|
|
1185
|
+
`{${'childIdentifier'}}`,
|
|
1186
|
+
encodeURIComponent(String(requestParameters.childIdentifier)),
|
|
1187
|
+
),
|
|
1188
|
+
method: 'PUT',
|
|
1189
|
+
headers: headerParameters,
|
|
1190
|
+
query: queryParameters,
|
|
1191
|
+
body: UpdateChildAccountStatusToJSON(requestParameters.updateChildAccountStatus),
|
|
1192
|
+
},
|
|
1193
|
+
initOverrides,
|
|
1194
|
+
);
|
|
1195
|
+
|
|
1196
|
+
return new runtime.VoidApiResponse(response);
|
|
1197
|
+
}
|
|
1198
|
+
|
|
1199
|
+
/**
|
|
1200
|
+
* Update info of reseller\'s child account status based on the identifier supplied
|
|
1201
|
+
*/
|
|
1202
|
+
async updateChildAccountStatus(
|
|
1203
|
+
requestParameters: UpdateChildAccountStatusRequest,
|
|
1204
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1205
|
+
): Promise<void> {
|
|
1206
|
+
await this.updateChildAccountStatusRaw(requestParameters, initOverrides);
|
|
1207
|
+
}
|
|
1208
|
+
|
|
1209
|
+
/**
|
|
1210
|
+
* Update the sender domain of reseller\'s child based on the childIdentifier and domainName passed
|
|
1211
|
+
*/
|
|
1212
|
+
async updateChildDomainRaw(
|
|
1213
|
+
requestParameters: UpdateChildDomainRequest,
|
|
1214
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1215
|
+
): Promise<runtime.ApiResponse<void>> {
|
|
1216
|
+
if (requestParameters.childIdentifier === null || requestParameters.childIdentifier === undefined) {
|
|
1217
|
+
throw new runtime.RequiredError(
|
|
1218
|
+
'childIdentifier',
|
|
1219
|
+
'Required parameter requestParameters.childIdentifier was null or undefined when calling updateChildDomain.',
|
|
1220
|
+
);
|
|
1221
|
+
}
|
|
1222
|
+
|
|
1223
|
+
if (requestParameters.domainName === null || requestParameters.domainName === undefined) {
|
|
1224
|
+
throw new runtime.RequiredError(
|
|
1225
|
+
'domainName',
|
|
1226
|
+
'Required parameter requestParameters.domainName was null or undefined when calling updateChildDomain.',
|
|
1227
|
+
);
|
|
1228
|
+
}
|
|
1229
|
+
|
|
1230
|
+
if (requestParameters.updateChildDomain === null || requestParameters.updateChildDomain === undefined) {
|
|
1231
|
+
throw new runtime.RequiredError(
|
|
1232
|
+
'updateChildDomain',
|
|
1233
|
+
'Required parameter requestParameters.updateChildDomain was null or undefined when calling updateChildDomain.',
|
|
1234
|
+
);
|
|
1235
|
+
}
|
|
1236
|
+
|
|
1237
|
+
const queryParameters: any = {};
|
|
1238
|
+
|
|
1239
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1240
|
+
|
|
1241
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
1242
|
+
|
|
1243
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1244
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
1245
|
+
}
|
|
1246
|
+
|
|
1247
|
+
const response = await this.request(
|
|
1248
|
+
{
|
|
1249
|
+
path: `/reseller/children/{childIdentifier}/domains/{domainName}`
|
|
1250
|
+
.replace(`{${'childIdentifier'}}`, encodeURIComponent(String(requestParameters.childIdentifier)))
|
|
1251
|
+
.replace(`{${'domainName'}}`, encodeURIComponent(String(requestParameters.domainName))),
|
|
1252
|
+
method: 'PUT',
|
|
1253
|
+
headers: headerParameters,
|
|
1254
|
+
query: queryParameters,
|
|
1255
|
+
body: UpdateChildDomainToJSON(requestParameters.updateChildDomain),
|
|
1256
|
+
},
|
|
1257
|
+
initOverrides,
|
|
1258
|
+
);
|
|
1259
|
+
|
|
1260
|
+
return new runtime.VoidApiResponse(response);
|
|
1261
|
+
}
|
|
1262
|
+
|
|
1263
|
+
/**
|
|
1264
|
+
* Update the sender domain of reseller\'s child based on the childIdentifier and domainName passed
|
|
1265
|
+
*/
|
|
1266
|
+
async updateChildDomain(
|
|
1267
|
+
requestParameters: UpdateChildDomainRequest,
|
|
1268
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1269
|
+
): Promise<void> {
|
|
1270
|
+
await this.updateChildDomainRaw(requestParameters, initOverrides);
|
|
1271
|
+
}
|
|
1272
|
+
|
|
1273
|
+
/**
|
|
1274
|
+
* Update info of reseller\'s child based on the child identifier supplied
|
|
1275
|
+
*/
|
|
1276
|
+
async updateResellerChildRaw(
|
|
1277
|
+
requestParameters: UpdateResellerChildRequest,
|
|
1278
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1279
|
+
): Promise<runtime.ApiResponse<void>> {
|
|
1280
|
+
if (requestParameters.childIdentifier === null || requestParameters.childIdentifier === undefined) {
|
|
1281
|
+
throw new runtime.RequiredError(
|
|
1282
|
+
'childIdentifier',
|
|
1283
|
+
'Required parameter requestParameters.childIdentifier was null or undefined when calling updateResellerChild.',
|
|
1284
|
+
);
|
|
1285
|
+
}
|
|
1286
|
+
|
|
1287
|
+
if (requestParameters.resellerChild === null || requestParameters.resellerChild === undefined) {
|
|
1288
|
+
throw new runtime.RequiredError(
|
|
1289
|
+
'resellerChild',
|
|
1290
|
+
'Required parameter requestParameters.resellerChild was null or undefined when calling updateResellerChild.',
|
|
1291
|
+
);
|
|
1292
|
+
}
|
|
1293
|
+
|
|
1294
|
+
const queryParameters: any = {};
|
|
1295
|
+
|
|
1296
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1297
|
+
|
|
1298
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
1299
|
+
|
|
1300
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
1301
|
+
headerParameters['api-key'] = await this.configuration.apiKey('api-key'); // api-key authentication
|
|
1302
|
+
}
|
|
1303
|
+
|
|
1304
|
+
const response = await this.request(
|
|
1305
|
+
{
|
|
1306
|
+
path: `/reseller/children/{childIdentifier}`.replace(
|
|
1307
|
+
`{${'childIdentifier'}}`,
|
|
1308
|
+
encodeURIComponent(String(requestParameters.childIdentifier)),
|
|
1309
|
+
),
|
|
1310
|
+
method: 'PUT',
|
|
1311
|
+
headers: headerParameters,
|
|
1312
|
+
query: queryParameters,
|
|
1313
|
+
body: UpdateChildToJSON(requestParameters.resellerChild),
|
|
1314
|
+
},
|
|
1315
|
+
initOverrides,
|
|
1316
|
+
);
|
|
1317
|
+
|
|
1318
|
+
return new runtime.VoidApiResponse(response);
|
|
1319
|
+
}
|
|
1320
|
+
|
|
1321
|
+
/**
|
|
1322
|
+
* Update info of reseller\'s child based on the child identifier supplied
|
|
1323
|
+
*/
|
|
1324
|
+
async updateResellerChild(
|
|
1325
|
+
requestParameters: UpdateResellerChildRequest,
|
|
1326
|
+
initOverrides?: RequestInit | runtime.InitOverrideFunction,
|
|
1327
|
+
): Promise<void> {
|
|
1328
|
+
await this.updateResellerChildRaw(requestParameters, initOverrides);
|
|
1329
|
+
}
|
|
1330
|
+
}
|