@getbrevo/brevo 2.3.0 → 2.5.0
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/.openapi-generator/FILES +24 -113
- package/.openapi-generator/VERSION +1 -1
- package/api/accountApi.ts +1 -6
- package/api/apis.ts +3 -9
- package/api/companiesApi.ts +69 -247
- package/api/contactsApi.ts +25 -119
- package/api/dealsApi.ts +1 -181
- package/api/ecommerceApi.ts +14 -29
- package/api/emailCampaignsApi.ts +2 -2
- package/api/masterAccountApi.ts +4 -233
- package/api/transactionalEmailsApi.ts +1 -78
- package/api/transactionalSMSApi.ts +0 -60
- package/api/userApi.ts +2 -2
- package/model/addContactToList.ts +2 -11
- package/model/companiesIdPatchRequest.ts +0 -18
- package/model/conversationsMessage.ts +0 -131
- package/model/conversionSourceMetrics.ts +3 -6
- package/model/createAttribute.ts +3 -13
- package/model/createContact.ts +4 -4
- package/model/createDoiContact.ts +3 -3
- package/model/createEmailCampaign.ts +0 -7
- package/model/createEmailCampaignRecipients.ts +0 -9
- package/model/createUpdateProduct.ts +1 -1
- package/model/createUpdateProducts.ts +1 -1
- package/model/createWebhook.ts +1 -14
- package/model/crmDealsIdPatchRequest.ts +0 -18
- package/model/ecommerceAttributionMetricsConversionSourceConversionSourceIdGet200Response.ts +3 -6
- package/model/errorModel.ts +1 -0
- package/model/getAccountAllOfPlan.ts +13 -3
- package/model/getAttributesAttributesInner.ts +1 -12
- package/model/getCampaignStats.ts +0 -18
- package/model/getContactCampaignStats.ts +11 -11
- package/model/getContactCampaignStatsClickedInner.ts +3 -3
- package/model/getContactCampaignStatsUnsubscriptions.ts +6 -6
- package/model/getCorporateInvitedUsersListUsersInnerFeatureAccess.ts +0 -45
- package/model/getCorporateUserPermissionFeatureAccess.ts +0 -45
- package/model/getEmailCampaign.ts +6 -4
- package/model/getExtendedCampaignStats.ts +0 -3
- package/model/getOrdersOrdersInner.ts +8 -24
- package/model/getSegments.ts +3 -3
- package/model/getSmsCampaign.ts +6 -4
- package/model/inviteAdminUserPrivilegesInner.ts +2 -11
- package/model/inviteuserPrivilegesInner.ts +3 -5
- package/model/models.ts +77 -419
- package/model/order.ts +8 -24
- package/model/orderBilling.ts +1 -1
- package/model/removeContactFromList.ts +3 -12
- package/model/requestContactExport.ts +1 -37
- package/model/requestContactExportCustomContactFilter.ts +1 -10
- package/model/sendSmtpEmail.ts +1 -1
- package/model/sendTransacSms.ts +5 -3
- package/model/subAccountDetailsResponsePlanInfoCredits.ts +0 -14
- package/model/subAccountDetailsResponsePlanInfoFeatures.ts +0 -7
- package/model/subAccountDetailsResponsePlanInfoFeaturesUsers.ts +3 -3
- package/model/subAccountUpdatePlanRequestCredits.ts +2 -20
- package/model/subAccountUpdatePlanRequestFeatures.ts +1 -10
- package/model/updateAttribute.ts +1 -10
- package/model/updateContact.ts +3 -3
- package/model/updateEmailCampaign.ts +0 -7
- package/model/updateEmailCampaignRecipients.ts +0 -9
- package/package.json +6 -5
- package/tsconfig.json +1 -0
- package/api/balanceApi.ts +0 -1725
- package/api/programApi.ts +0 -992
- package/api/rewardApi.ts +0 -975
- package/api/tierApi.ts +0 -952
- package/model/addSubscriptionMemberPayload.ts +0 -52
- package/model/aggregateBalance.ts +0 -43
- package/model/balance.ts +0 -106
- package/model/balanceDataPerContact.ts +0 -49
- package/model/balanceDefinition.ts +0 -212
- package/model/balanceDefinitionPage.ts +0 -35
- package/model/balanceLimit.ts +0 -115
- package/model/balanceOrder.ts +0 -136
- package/model/companiesImportPost200Response.ts +0 -34
- package/model/companiesImportPost400Response.ts +0 -31
- package/model/contactBalancesResp.ts +0 -50
- package/model/contactErrorModel.ts +0 -63
- package/model/conversationsMessageAttachmentsInner.ts +0 -79
- package/model/conversationsMessageForwardedToSourceStatus.ts +0 -40
- package/model/conversationsMessageFrom.ts +0 -40
- package/model/conversationsMessageReplyTo.ts +0 -40
- package/model/conversationsMessageToInner.ts +0 -37
- package/model/corporateUserEmailPermissionsPutRequest.ts +0 -41
- package/model/corporateUserEmailPermissionsPutRequestPrivilegesInner.ts +0 -69
- package/model/createBalanceDefinitionPayload.ts +0 -218
- package/model/createBalanceLimitPayload.ts +0 -98
- package/model/createBalancePayload.ts +0 -37
- package/model/createEmailCampaignEmailExpirationDate.ts +0 -53
- package/model/createLoyaltyProgramPayload.ts +0 -61
- package/model/createOrderPayload.ts +0 -91
- package/model/createSubscriptionPayload.ts +0 -52
- package/model/createSubscriptionResponse.ts +0 -88
- package/model/createTierGroupRequest.ts +0 -73
- package/model/createTransactionPayload.ts +0 -109
- package/model/crmAttributesPost200Response.ts +0 -34
- package/model/crmAttributesPostRequest.ts +0 -85
- package/model/errorResponse.ts +0 -31
- package/model/fetchTemplatePreview.ts +0 -52
- package/model/getSegment.ts +0 -61
- package/model/loyaltyProgram.ts +0 -139
- package/model/loyaltyProgramPage.ts +0 -35
- package/model/loyaltyProgramValidationError.ts +0 -52
- package/model/loyaltyTierPage.ts +0 -32
- package/model/mainAttributeRewardPayload.ts +0 -88
- package/model/mainBillingPayload.ts +0 -88
- package/model/mainCodeCountHttpResponse.ts +0 -34
- package/model/mainCreateRedeemPayload.ts +0 -98
- package/model/mainCreateRewardPayload.ts +0 -61
- package/model/mainCreateRewardResponse.ts +0 -97
- package/model/mainErrorResponse.ts +0 -34
- package/model/mainFilter.ts +0 -43
- package/model/mainGenerator.ts +0 -79
- package/model/mainGetContactRewardsPayload.ts +0 -99
- package/model/mainIdentifiersPayload.ts +0 -43
- package/model/mainLimit.ts +0 -97
- package/model/mainModelContactReward.ts +0 -115
- package/model/mainModelContactRewardsResp.ts +0 -71
- package/model/mainNodeResponse.ts +0 -97
- package/model/mainOrderPayload.ts +0 -136
- package/model/mainProduct.ts +0 -61
- package/model/mainProductPayload.ts +0 -70
- package/model/mainRedeem.ts +0 -151
- package/model/mainResultParameterResponse.ts +0 -44
- package/model/mainReward.ts +0 -397
- package/model/mainRewardAttribution.ts +0 -124
- package/model/mainRewardConfigurations.ts +0 -52
- package/model/mainRewardPage.ts +0 -44
- package/model/mainRewardPageObj.ts +0 -106
- package/model/mainRewardValidate.ts +0 -34
- package/model/mainRule.ts +0 -145
- package/model/mainRuleConditionResponse.ts +0 -71
- package/model/mainRuleEventResponse.ts +0 -43
- package/model/mainRuleResultResponse.ts +0 -53
- package/model/mainValidateRewardPayload.ts +0 -79
- package/model/mainValueResponse.ts +0 -98
- package/model/mainVoucherRevokePayload.ts +0 -34
- package/model/memberContact.ts +0 -52
- package/model/modelSubscriptionBalanceResp.ts +0 -32
- package/model/orderIdentifiers.ts +0 -64
- package/model/patchLoyaltyProgramPayload.ts +0 -52
- package/model/sendTransacSmsTag.ts +0 -37
- package/model/subAccountDetailsResponsePlanInfoCreditsExternalFeeds.ts +0 -46
- package/model/subAccountDetailsResponsePlanInfoCreditsWhatsapp.ts +0 -46
- package/model/subAccountDetailsResponsePlanInfoFeaturesSalesUsers.ts +0 -46
- package/model/subAccountsUpdatePlanRequest.ts +0 -51
- package/model/subAccountsUpdatePlanRequestCredits.ts +0 -73
- package/model/subAccountsUpdatePlanRequestFeatures.ts +0 -55
- package/model/subscription.ts +0 -88
- package/model/subscriptionAggregateBalance.ts +0 -43
- package/model/subscriptionAttributedReward.ts +0 -106
- package/model/subscriptionBalances.ts +0 -53
- package/model/subscriptionHandlerInfo.ts +0 -65
- package/model/subscriptionMember.ts +0 -70
- package/model/subscriptionTier.ts +0 -88
- package/model/templatePreview.ts +0 -76
- package/model/tier.ts +0 -102
- package/model/tierAccessConditionsInner.ts +0 -55
- package/model/tierForContact.ts +0 -82
- package/model/tierGroup.ts +0 -109
- package/model/tierGroupPage.ts +0 -32
- package/model/tierRequest.ts +0 -57
- package/model/tierRequestAccessConditionsInner.ts +0 -43
- package/model/tierRequestPutPayload.ts +0 -57
- package/model/tierRequestTierRewardsInner.ts +0 -34
- package/model/tierTierRewardsInner.ts +0 -46
- package/model/transaction.ts +0 -163
- package/model/transactionHistory.ts +0 -118
- package/model/transactionHistoryResp.ts +0 -74
- package/model/unauthorizedResponse.ts +0 -34
- package/model/updateBalanceDefinitionPayload.ts +0 -218
- package/model/updateBalanceLimitPayload.ts +0 -98
- package/model/updateEmailCampaignEmailExpirationDate.ts +0 -53
- package/model/updateLoyaltyProgramPayload.ts +0 -52
- package/model/updateTierGroupRequest.ts +0 -73
package/api/dealsApi.ts
CHANGED
|
@@ -15,10 +15,6 @@ import localVarRequest from 'request';
|
|
|
15
15
|
import http from 'http';
|
|
16
16
|
|
|
17
17
|
/* tslint:disable:no-unused-locals */
|
|
18
|
-
import { CompaniesImportPost200Response } from '../model/companiesImportPost200Response';
|
|
19
|
-
import { CompaniesImportPost400Response } from '../model/companiesImportPost400Response';
|
|
20
|
-
import { CrmAttributesPost200Response } from '../model/crmAttributesPost200Response';
|
|
21
|
-
import { CrmAttributesPostRequest } from '../model/crmAttributesPostRequest';
|
|
22
18
|
import { CrmDealsIdPatchRequest } from '../model/crmDealsIdPatchRequest';
|
|
23
19
|
import { CrmDealsLinkUnlinkIdPatchRequest } from '../model/crmDealsLinkUnlinkIdPatchRequest';
|
|
24
20
|
import { CrmDealsPost201Response } from '../model/crmDealsPost201Response';
|
|
@@ -171,95 +167,18 @@ export class DealsApi {
|
|
|
171
167
|
});
|
|
172
168
|
});
|
|
173
169
|
}
|
|
174
|
-
/**
|
|
175
|
-
*
|
|
176
|
-
* @summary Create a deal/company attribute
|
|
177
|
-
* @param body Attribute creation data for company
|
|
178
|
-
*/
|
|
179
|
-
public async crmAttributesPost (body: CrmAttributesPostRequest, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: CrmAttributesPost200Response; }> {
|
|
180
|
-
const localVarPath = this.basePath + '/crm/attributes';
|
|
181
|
-
let localVarQueryParameters: any = {};
|
|
182
|
-
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
|
183
|
-
const produces = ['application/json'];
|
|
184
|
-
// give precedence to 'application/json'
|
|
185
|
-
if (produces.indexOf('application/json') >= 0) {
|
|
186
|
-
localVarHeaderParams.Accept = 'application/json';
|
|
187
|
-
} else {
|
|
188
|
-
localVarHeaderParams.Accept = produces.join(',');
|
|
189
|
-
}
|
|
190
|
-
let localVarFormParams: any = {};
|
|
191
|
-
|
|
192
|
-
// verify required parameter 'body' is not null or undefined
|
|
193
|
-
if (body === null || body === undefined) {
|
|
194
|
-
throw new Error('Required parameter body was null or undefined when calling crmAttributesPost.');
|
|
195
|
-
}
|
|
196
|
-
|
|
197
|
-
(<any>Object).assign(localVarHeaderParams, options.headers);
|
|
198
|
-
|
|
199
|
-
let localVarUseFormData = false;
|
|
200
|
-
|
|
201
|
-
let localVarRequestOptions: localVarRequest.Options = {
|
|
202
|
-
method: 'POST',
|
|
203
|
-
qs: localVarQueryParameters,
|
|
204
|
-
headers: localVarHeaderParams,
|
|
205
|
-
uri: localVarPath,
|
|
206
|
-
useQuerystring: this._useQuerystring,
|
|
207
|
-
json: true,
|
|
208
|
-
body: ObjectSerializer.serialize(body, "CrmAttributesPostRequest")
|
|
209
|
-
};
|
|
210
|
-
|
|
211
|
-
let authenticationPromise = Promise.resolve();
|
|
212
|
-
if (this.authentications.apiKey.apiKey) {
|
|
213
|
-
authenticationPromise = authenticationPromise.then(() => this.authentications.apiKey.applyToRequest(localVarRequestOptions));
|
|
214
|
-
}
|
|
215
|
-
if (this.authentications.partnerKey.apiKey) {
|
|
216
|
-
authenticationPromise = authenticationPromise.then(() => this.authentications.partnerKey.applyToRequest(localVarRequestOptions));
|
|
217
|
-
}
|
|
218
|
-
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
|
219
|
-
|
|
220
|
-
let interceptorPromise = authenticationPromise;
|
|
221
|
-
for (const interceptor of this.interceptors) {
|
|
222
|
-
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
|
223
|
-
}
|
|
224
|
-
|
|
225
|
-
return interceptorPromise.then(() => {
|
|
226
|
-
if (Object.keys(localVarFormParams).length) {
|
|
227
|
-
if (localVarUseFormData) {
|
|
228
|
-
(<any>localVarRequestOptions).formData = localVarFormParams;
|
|
229
|
-
} else {
|
|
230
|
-
localVarRequestOptions.form = localVarFormParams;
|
|
231
|
-
}
|
|
232
|
-
}
|
|
233
|
-
return new Promise<{ response: http.IncomingMessage; body: CrmAttributesPost200Response; }>((resolve, reject) => {
|
|
234
|
-
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
|
235
|
-
if (error) {
|
|
236
|
-
reject(error);
|
|
237
|
-
} else {
|
|
238
|
-
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
|
239
|
-
body = ObjectSerializer.deserialize(body, "CrmAttributesPost200Response");
|
|
240
|
-
resolve({ response: response, body: body });
|
|
241
|
-
} else {
|
|
242
|
-
reject(new HttpError(response, body, response.statusCode));
|
|
243
|
-
}
|
|
244
|
-
}
|
|
245
|
-
});
|
|
246
|
-
});
|
|
247
|
-
});
|
|
248
|
-
}
|
|
249
170
|
/**
|
|
250
171
|
*
|
|
251
172
|
* @summary Get all deals
|
|
252
173
|
* @param filtersAttributesDealName Filter by attributes. If you have a filter for the owner on your end, please send it as filters[attributes.deal_owner] and utilize the account email for the filtering.
|
|
253
174
|
* @param filtersLinkedCompaniesIds Filter by linked companies ids
|
|
254
175
|
* @param filtersLinkedContactsIds Filter by linked companies ids
|
|
255
|
-
* @param modifiedSince Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
|
|
256
|
-
* @param createdSince Filter (urlencoded) the contacts created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
|
|
257
176
|
* @param offset Index of the first document of the page
|
|
258
177
|
* @param limit Number of documents per page
|
|
259
178
|
* @param sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
|
|
260
179
|
* @param sortBy The field used to sort field names.
|
|
261
180
|
*/
|
|
262
|
-
public async crmDealsGet (filtersAttributesDealName?: string, filtersLinkedCompaniesIds?: string, filtersLinkedContactsIds?: string,
|
|
181
|
+
public async crmDealsGet (filtersAttributesDealName?: string, filtersLinkedCompaniesIds?: string, filtersLinkedContactsIds?: string, offset?: number, limit?: number, sort?: 'asc' | 'desc', sortBy?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: DealsList; }> {
|
|
263
182
|
const localVarPath = this.basePath + '/crm/deals';
|
|
264
183
|
let localVarQueryParameters: any = {};
|
|
265
184
|
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
|
@@ -284,14 +203,6 @@ export class DealsApi {
|
|
|
284
203
|
localVarQueryParameters['filters[linkedContactsIds]'] = ObjectSerializer.serialize(filtersLinkedContactsIds, "string");
|
|
285
204
|
}
|
|
286
205
|
|
|
287
|
-
if (modifiedSince !== undefined) {
|
|
288
|
-
localVarQueryParameters['modifiedSince'] = ObjectSerializer.serialize(modifiedSince, "string");
|
|
289
|
-
}
|
|
290
|
-
|
|
291
|
-
if (createdSince !== undefined) {
|
|
292
|
-
localVarQueryParameters['createdSince'] = ObjectSerializer.serialize(createdSince, "string");
|
|
293
|
-
}
|
|
294
|
-
|
|
295
206
|
if (offset !== undefined) {
|
|
296
207
|
localVarQueryParameters['offset'] = ObjectSerializer.serialize(offset, "number");
|
|
297
208
|
}
|
|
@@ -589,95 +500,6 @@ export class DealsApi {
|
|
|
589
500
|
});
|
|
590
501
|
});
|
|
591
502
|
}
|
|
592
|
-
/**
|
|
593
|
-
* Import deals from a CSV file with mapping options.
|
|
594
|
-
* @summary Import deals(creation and updation)
|
|
595
|
-
* @param file The CSV file to upload.The file should have the first row as the mapping attribute. Some default attribute names are (a) deal_id [brevo mongoID to update deals] (b) associated_contact (c) associated_company (f) any other attribute with internal name
|
|
596
|
-
* @param mapping The mapping options in JSON format. json { \\\"link_entities\\\": true, // Determines whether to link related entities during the import process \\\"unlink_entities\\\": false, //Determines whether to unlink related entities during the import process. \\\"update_existing_records\\\": true, // Determines whether to update based on deal ID or treat every row as create \\\"unset_empty_attributes\\\": false // Determines whether unset a specific attribute during update if values input is blank }
|
|
597
|
-
*/
|
|
598
|
-
public async crmDealsImportPost (file: RequestFile, mapping: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: CompaniesImportPost200Response; }> {
|
|
599
|
-
const localVarPath = this.basePath + '/crm/deals/import';
|
|
600
|
-
let localVarQueryParameters: any = {};
|
|
601
|
-
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
|
602
|
-
const produces = ['application/json'];
|
|
603
|
-
// give precedence to 'application/json'
|
|
604
|
-
if (produces.indexOf('application/json') >= 0) {
|
|
605
|
-
localVarHeaderParams.Accept = 'application/json';
|
|
606
|
-
} else {
|
|
607
|
-
localVarHeaderParams.Accept = produces.join(',');
|
|
608
|
-
}
|
|
609
|
-
let localVarFormParams: any = {};
|
|
610
|
-
|
|
611
|
-
// verify required parameter 'file' is not null or undefined
|
|
612
|
-
if (file === null || file === undefined) {
|
|
613
|
-
throw new Error('Required parameter file was null or undefined when calling crmDealsImportPost.');
|
|
614
|
-
}
|
|
615
|
-
|
|
616
|
-
// verify required parameter 'mapping' is not null or undefined
|
|
617
|
-
if (mapping === null || mapping === undefined) {
|
|
618
|
-
throw new Error('Required parameter mapping was null or undefined when calling crmDealsImportPost.');
|
|
619
|
-
}
|
|
620
|
-
|
|
621
|
-
(<any>Object).assign(localVarHeaderParams, options.headers);
|
|
622
|
-
|
|
623
|
-
let localVarUseFormData = false;
|
|
624
|
-
|
|
625
|
-
if (file !== undefined) {
|
|
626
|
-
localVarFormParams['file'] = file;
|
|
627
|
-
}
|
|
628
|
-
localVarUseFormData = true;
|
|
629
|
-
|
|
630
|
-
if (mapping !== undefined) {
|
|
631
|
-
localVarFormParams['mapping'] = ObjectSerializer.serialize(mapping, "string");
|
|
632
|
-
}
|
|
633
|
-
|
|
634
|
-
let localVarRequestOptions: localVarRequest.Options = {
|
|
635
|
-
method: 'POST',
|
|
636
|
-
qs: localVarQueryParameters,
|
|
637
|
-
headers: localVarHeaderParams,
|
|
638
|
-
uri: localVarPath,
|
|
639
|
-
useQuerystring: this._useQuerystring,
|
|
640
|
-
json: true,
|
|
641
|
-
};
|
|
642
|
-
|
|
643
|
-
let authenticationPromise = Promise.resolve();
|
|
644
|
-
if (this.authentications.apiKey.apiKey) {
|
|
645
|
-
authenticationPromise = authenticationPromise.then(() => this.authentications.apiKey.applyToRequest(localVarRequestOptions));
|
|
646
|
-
}
|
|
647
|
-
if (this.authentications.partnerKey.apiKey) {
|
|
648
|
-
authenticationPromise = authenticationPromise.then(() => this.authentications.partnerKey.applyToRequest(localVarRequestOptions));
|
|
649
|
-
}
|
|
650
|
-
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
|
651
|
-
|
|
652
|
-
let interceptorPromise = authenticationPromise;
|
|
653
|
-
for (const interceptor of this.interceptors) {
|
|
654
|
-
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
|
655
|
-
}
|
|
656
|
-
|
|
657
|
-
return interceptorPromise.then(() => {
|
|
658
|
-
if (Object.keys(localVarFormParams).length) {
|
|
659
|
-
if (localVarUseFormData) {
|
|
660
|
-
(<any>localVarRequestOptions).formData = localVarFormParams;
|
|
661
|
-
} else {
|
|
662
|
-
localVarRequestOptions.form = localVarFormParams;
|
|
663
|
-
}
|
|
664
|
-
}
|
|
665
|
-
return new Promise<{ response: http.IncomingMessage; body: CompaniesImportPost200Response; }>((resolve, reject) => {
|
|
666
|
-
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
|
667
|
-
if (error) {
|
|
668
|
-
reject(error);
|
|
669
|
-
} else {
|
|
670
|
-
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
|
671
|
-
body = ObjectSerializer.deserialize(body, "CompaniesImportPost200Response");
|
|
672
|
-
resolve({ response: response, body: body });
|
|
673
|
-
} else {
|
|
674
|
-
reject(new HttpError(response, body, response.statusCode));
|
|
675
|
-
}
|
|
676
|
-
}
|
|
677
|
-
});
|
|
678
|
-
});
|
|
679
|
-
});
|
|
680
|
-
}
|
|
681
503
|
/**
|
|
682
504
|
*
|
|
683
505
|
* @summary Link and Unlink a deal with contacts and companies
|
|
@@ -905,8 +727,6 @@ export class DealsApi {
|
|
|
905
727
|
/**
|
|
906
728
|
* This endpoint is deprecated. Prefer /crm/pipeline/details/{pipelineID} instead.
|
|
907
729
|
* @summary Get pipeline stages
|
|
908
|
-
*
|
|
909
|
-
* @deprecated
|
|
910
730
|
*/
|
|
911
731
|
public async crmPipelineDetailsGet (options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: Pipeline; }> {
|
|
912
732
|
const localVarPath = this.basePath + '/crm/pipeline/details';
|
package/api/ecommerceApi.ts
CHANGED
|
@@ -627,11 +627,11 @@ export class EcommerceApi {
|
|
|
627
627
|
}
|
|
628
628
|
/**
|
|
629
629
|
*
|
|
630
|
-
* @summary Get detailed attribution metrics for a single Brevo campaign
|
|
631
|
-
* @param conversionSource The Brevo campaign type
|
|
632
|
-
* @param conversionSourceId The Brevo campaign
|
|
630
|
+
* @summary Get detailed attribution metrics for a single Brevo campaign
|
|
631
|
+
* @param conversionSource The Brevo campaign type for which data will be retrieved
|
|
632
|
+
* @param conversionSourceId The Brevo campaign id for which data will be retrieved
|
|
633
633
|
*/
|
|
634
|
-
public async ecommerceAttributionMetricsConversionSourceConversionSourceIdGet (conversionSource: 'email_campaign'
|
|
634
|
+
public async ecommerceAttributionMetricsConversionSourceConversionSourceIdGet (conversionSource: 'email_campaign', conversionSourceId: number, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: EcommerceAttributionMetricsConversionSourceConversionSourceIdGet200Response; }> {
|
|
635
635
|
const localVarPath = this.basePath + '/ecommerce/attribution/metrics/{conversionSource}/{conversionSourceId}'
|
|
636
636
|
.replace('{' + 'conversionSource' + '}', encodeURIComponent(String(conversionSource)))
|
|
637
637
|
.replace('{' + 'conversionSourceId' + '}', encodeURIComponent(String(conversionSourceId)));
|
|
@@ -709,15 +709,12 @@ export class EcommerceApi {
|
|
|
709
709
|
}
|
|
710
710
|
/**
|
|
711
711
|
*
|
|
712
|
-
* @summary Get attribution metrics for one or more Brevo campaigns
|
|
712
|
+
* @summary Get attribution metrics for one or more Brevo campaigns
|
|
713
713
|
* @param periodFrom When getting metrics for a specific period, define the starting datetime in RFC3339 format
|
|
714
714
|
* @param periodTo When getting metrics for a specific period, define the end datetime in RFC3339 format
|
|
715
|
-
* @param emailCampaignId The email campaign
|
|
716
|
-
* @param smsCampaignId The SMS campaign ID(s) to get metrics for
|
|
717
|
-
* @param automationWorkflowEmailId The automation workflow ID(s) to get email attribution metrics for
|
|
718
|
-
* @param automationWorkflowSmsId The automation workflow ID(s) to get SMS attribution metrics for
|
|
715
|
+
* @param emailCampaignId The email campaign id(s) to get metrics for
|
|
719
716
|
*/
|
|
720
|
-
public async ecommerceAttributionMetricsGet (periodFrom?: Date, periodTo?: Date, emailCampaignId?: Array<
|
|
717
|
+
public async ecommerceAttributionMetricsGet (periodFrom?: Date, periodTo?: Date, emailCampaignId?: Array<number>, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: EcommerceAttributionMetricsGet200Response; }> {
|
|
721
718
|
const localVarPath = this.basePath + '/ecommerce/attribution/metrics';
|
|
722
719
|
let localVarQueryParameters: any = {};
|
|
723
720
|
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
|
@@ -739,19 +736,7 @@ export class EcommerceApi {
|
|
|
739
736
|
}
|
|
740
737
|
|
|
741
738
|
if (emailCampaignId !== undefined) {
|
|
742
|
-
localVarQueryParameters['emailCampaignId[]'] = ObjectSerializer.serialize(emailCampaignId, "Array<
|
|
743
|
-
}
|
|
744
|
-
|
|
745
|
-
if (smsCampaignId !== undefined) {
|
|
746
|
-
localVarQueryParameters['smsCampaignId[]'] = ObjectSerializer.serialize(smsCampaignId, "Array<string>");
|
|
747
|
-
}
|
|
748
|
-
|
|
749
|
-
if (automationWorkflowEmailId !== undefined) {
|
|
750
|
-
localVarQueryParameters['automationWorkflowEmailId[]'] = ObjectSerializer.serialize(automationWorkflowEmailId, "Array<string>");
|
|
751
|
-
}
|
|
752
|
-
|
|
753
|
-
if (automationWorkflowSmsId !== undefined) {
|
|
754
|
-
localVarQueryParameters['automationWorkflowSmsId[]'] = ObjectSerializer.serialize(automationWorkflowSmsId, "Array<string>");
|
|
739
|
+
localVarQueryParameters['emailCampaignId[]'] = ObjectSerializer.serialize(emailCampaignId, "Array<number>");
|
|
755
740
|
}
|
|
756
741
|
|
|
757
742
|
(<any>Object).assign(localVarHeaderParams, options.headers);
|
|
@@ -807,11 +792,11 @@ export class EcommerceApi {
|
|
|
807
792
|
}
|
|
808
793
|
/**
|
|
809
794
|
*
|
|
810
|
-
* @summary Get attributed product sales for a single Brevo campaign
|
|
811
|
-
* @param conversionSource The Brevo campaign
|
|
812
|
-
* @param conversionSourceId The Brevo campaign
|
|
795
|
+
* @summary Get attributed product sales for a single Brevo campaign
|
|
796
|
+
* @param conversionSource The Brevo campaign type for which data will be retrieved
|
|
797
|
+
* @param conversionSourceId The Brevo campaign id for which data will be retrieved
|
|
813
798
|
*/
|
|
814
|
-
public async ecommerceAttributionProductsConversionSourceConversionSourceIdGet (conversionSource: 'email_campaign'
|
|
799
|
+
public async ecommerceAttributionProductsConversionSourceConversionSourceIdGet (conversionSource: 'email_campaign', conversionSourceId: number, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: EcommerceAttributionProductsConversionSourceConversionSourceIdGet200Response; }> {
|
|
815
800
|
const localVarPath = this.basePath + '/ecommerce/attribution/products/{conversionSource}/{conversionSourceId}'
|
|
816
801
|
.replace('{' + 'conversionSource' + '}', encodeURIComponent(String(conversionSource)))
|
|
817
802
|
.replace('{' + 'conversionSourceId' + '}', encodeURIComponent(String(conversionSourceId)));
|
|
@@ -963,8 +948,8 @@ export class EcommerceApi {
|
|
|
963
948
|
* @param sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
|
964
949
|
* @param ids Filter by category ids
|
|
965
950
|
* @param name Filter by category name
|
|
966
|
-
* @param modifiedSince Filter (urlencoded) the categories modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.**
|
|
967
|
-
* @param createdSince Filter (urlencoded) the categories created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.**
|
|
951
|
+
* @param modifiedSince Filter (urlencoded) the categories modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.**
|
|
952
|
+
* @param createdSince Filter (urlencoded) the categories created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.**
|
|
968
953
|
*/
|
|
969
954
|
public async getCategories (limit?: number, offset?: number, sort?: 'asc' | 'desc', ids?: Array<string>, name?: string, modifiedSince?: string, createdSince?: string, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: GetCategories; }> {
|
|
970
955
|
const localVarPath = this.basePath + '/categories';
|
package/api/emailCampaignsApi.ts
CHANGED
|
@@ -500,7 +500,7 @@ export class EmailCampaignsApi {
|
|
|
500
500
|
* @param sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
|
501
501
|
* @param excludeHtmlContent Use this flag to exclude htmlContent from the response body. If set to **true**, htmlContent field will be returned as empty string in the response body
|
|
502
502
|
*/
|
|
503
|
-
public async getEmailCampaigns (type?: 'classic' | 'trigger', status?: 'suspended' | 'archive' | 'sent' | 'queued' | 'draft' | 'inProcess'
|
|
503
|
+
public async getEmailCampaigns (type?: 'classic' | 'trigger', status?: 'suspended' | 'archive' | 'sent' | 'queued' | 'draft' | 'inProcess', statistics?: 'globalStats' | 'linksStats' | 'statsByDomain', startDate?: string, endDate?: string, limit?: number, offset?: number, sort?: 'asc' | 'desc', excludeHtmlContent?: boolean, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: GetEmailCampaigns; }> {
|
|
504
504
|
const localVarPath = this.basePath + '/emailCampaigns';
|
|
505
505
|
let localVarQueryParameters: any = {};
|
|
506
506
|
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
|
@@ -518,7 +518,7 @@ export class EmailCampaignsApi {
|
|
|
518
518
|
}
|
|
519
519
|
|
|
520
520
|
if (status !== undefined) {
|
|
521
|
-
localVarQueryParameters['status'] = ObjectSerializer.serialize(status, "'suspended' | 'archive' | 'sent' | 'queued' | 'draft' | 'inProcess'
|
|
521
|
+
localVarQueryParameters['status'] = ObjectSerializer.serialize(status, "'suspended' | 'archive' | 'sent' | 'queued' | 'draft' | 'inProcess'");
|
|
522
522
|
}
|
|
523
523
|
|
|
524
524
|
if (statistics !== undefined) {
|
package/api/masterAccountApi.ts
CHANGED
|
@@ -21,7 +21,6 @@ import { CorporateGroupPostRequest } from '../model/corporateGroupPostRequest';
|
|
|
21
21
|
import { CorporateGroupUnlinkGroupIdSubAccountsPutRequest } from '../model/corporateGroupUnlinkGroupIdSubAccountsPutRequest';
|
|
22
22
|
import { CorporateSubAccountIpAssociatePostRequest } from '../model/corporateSubAccountIpAssociatePostRequest';
|
|
23
23
|
import { CorporateSubAccountIpDissociatePutRequest } from '../model/corporateSubAccountIpDissociatePutRequest';
|
|
24
|
-
import { CorporateUserEmailPermissionsPutRequest } from '../model/corporateUserEmailPermissionsPutRequest';
|
|
25
24
|
import { CorporateUserInvitationActionEmailPut200Response } from '../model/corporateUserInvitationActionEmailPut200Response';
|
|
26
25
|
import { CreateApiKeyRequest } from '../model/createApiKeyRequest';
|
|
27
26
|
import { CreateApiKeyResponse } from '../model/createApiKeyResponse';
|
|
@@ -41,7 +40,6 @@ import { SubAccountAppsToggleRequest } from '../model/subAccountAppsToggleReques
|
|
|
41
40
|
import { SubAccountDetailsResponse } from '../model/subAccountDetailsResponse';
|
|
42
41
|
import { SubAccountUpdatePlanRequest } from '../model/subAccountUpdatePlanRequest';
|
|
43
42
|
import { SubAccountsResponse } from '../model/subAccountsResponse';
|
|
44
|
-
import { SubAccountsUpdatePlanRequest } from '../model/subAccountsUpdatePlanRequest';
|
|
45
43
|
|
|
46
44
|
import { ObjectSerializer, Authentication, VoidAuth, Interceptor } from '../model/models';
|
|
47
45
|
import { HttpBasicAuth, HttpBearerAuth, ApiKeyAuth, OAuth } from '../model/models';
|
|
@@ -503,73 +501,6 @@ export class MasterAccountApi {
|
|
|
503
501
|
});
|
|
504
502
|
});
|
|
505
503
|
}
|
|
506
|
-
/**
|
|
507
|
-
* This endpoint allows you to retrieve the list of active IPs on your Admin account
|
|
508
|
-
* @summary List of all IPs
|
|
509
|
-
*/
|
|
510
|
-
public async corporateIpGet (options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body?: any; }> {
|
|
511
|
-
const localVarPath = this.basePath + '/corporate/ip';
|
|
512
|
-
let localVarQueryParameters: any = {};
|
|
513
|
-
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
|
514
|
-
const produces = ['application/json'];
|
|
515
|
-
// give precedence to 'application/json'
|
|
516
|
-
if (produces.indexOf('application/json') >= 0) {
|
|
517
|
-
localVarHeaderParams.Accept = 'application/json';
|
|
518
|
-
} else {
|
|
519
|
-
localVarHeaderParams.Accept = produces.join(',');
|
|
520
|
-
}
|
|
521
|
-
let localVarFormParams: any = {};
|
|
522
|
-
|
|
523
|
-
(<any>Object).assign(localVarHeaderParams, options.headers);
|
|
524
|
-
|
|
525
|
-
let localVarUseFormData = false;
|
|
526
|
-
|
|
527
|
-
let localVarRequestOptions: localVarRequest.Options = {
|
|
528
|
-
method: 'GET',
|
|
529
|
-
qs: localVarQueryParameters,
|
|
530
|
-
headers: localVarHeaderParams,
|
|
531
|
-
uri: localVarPath,
|
|
532
|
-
useQuerystring: this._useQuerystring,
|
|
533
|
-
json: true,
|
|
534
|
-
};
|
|
535
|
-
|
|
536
|
-
let authenticationPromise = Promise.resolve();
|
|
537
|
-
if (this.authentications.apiKey.apiKey) {
|
|
538
|
-
authenticationPromise = authenticationPromise.then(() => this.authentications.apiKey.applyToRequest(localVarRequestOptions));
|
|
539
|
-
}
|
|
540
|
-
if (this.authentications.partnerKey.apiKey) {
|
|
541
|
-
authenticationPromise = authenticationPromise.then(() => this.authentications.partnerKey.applyToRequest(localVarRequestOptions));
|
|
542
|
-
}
|
|
543
|
-
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
|
544
|
-
|
|
545
|
-
let interceptorPromise = authenticationPromise;
|
|
546
|
-
for (const interceptor of this.interceptors) {
|
|
547
|
-
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
|
548
|
-
}
|
|
549
|
-
|
|
550
|
-
return interceptorPromise.then(() => {
|
|
551
|
-
if (Object.keys(localVarFormParams).length) {
|
|
552
|
-
if (localVarUseFormData) {
|
|
553
|
-
(<any>localVarRequestOptions).formData = localVarFormParams;
|
|
554
|
-
} else {
|
|
555
|
-
localVarRequestOptions.form = localVarFormParams;
|
|
556
|
-
}
|
|
557
|
-
}
|
|
558
|
-
return new Promise<{ response: http.IncomingMessage; body?: any; }>((resolve, reject) => {
|
|
559
|
-
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
|
560
|
-
if (error) {
|
|
561
|
-
reject(error);
|
|
562
|
-
} else {
|
|
563
|
-
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
|
564
|
-
resolve({ response: response, body: body });
|
|
565
|
-
} else {
|
|
566
|
-
reject(new HttpError(response, body, response.statusCode));
|
|
567
|
-
}
|
|
568
|
-
}
|
|
569
|
-
});
|
|
570
|
-
});
|
|
571
|
-
});
|
|
572
|
-
}
|
|
573
504
|
/**
|
|
574
505
|
* This endpoint will provide the details of the master account.
|
|
575
506
|
* @summary Get the details of requested master account
|
|
@@ -1487,162 +1418,7 @@ export class MasterAccountApi {
|
|
|
1487
1418
|
});
|
|
1488
1419
|
}
|
|
1489
1420
|
/**
|
|
1490
|
-
* This endpoint will
|
|
1491
|
-
* @summary Update sub-accounts plan
|
|
1492
|
-
* @param updatePlanDetails Values to update sub-accounts plan
|
|
1493
|
-
*/
|
|
1494
|
-
public async corporateSubAccountsPlanPut (updatePlanDetails: SubAccountsUpdatePlanRequest, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body?: any; }> {
|
|
1495
|
-
const localVarPath = this.basePath + '/corporate/subAccounts/plan';
|
|
1496
|
-
let localVarQueryParameters: any = {};
|
|
1497
|
-
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
|
1498
|
-
const produces = ['application/json'];
|
|
1499
|
-
// give precedence to 'application/json'
|
|
1500
|
-
if (produces.indexOf('application/json') >= 0) {
|
|
1501
|
-
localVarHeaderParams.Accept = 'application/json';
|
|
1502
|
-
} else {
|
|
1503
|
-
localVarHeaderParams.Accept = produces.join(',');
|
|
1504
|
-
}
|
|
1505
|
-
let localVarFormParams: any = {};
|
|
1506
|
-
|
|
1507
|
-
// verify required parameter 'updatePlanDetails' is not null or undefined
|
|
1508
|
-
if (updatePlanDetails === null || updatePlanDetails === undefined) {
|
|
1509
|
-
throw new Error('Required parameter updatePlanDetails was null or undefined when calling corporateSubAccountsPlanPut.');
|
|
1510
|
-
}
|
|
1511
|
-
|
|
1512
|
-
(<any>Object).assign(localVarHeaderParams, options.headers);
|
|
1513
|
-
|
|
1514
|
-
let localVarUseFormData = false;
|
|
1515
|
-
|
|
1516
|
-
let localVarRequestOptions: localVarRequest.Options = {
|
|
1517
|
-
method: 'PUT',
|
|
1518
|
-
qs: localVarQueryParameters,
|
|
1519
|
-
headers: localVarHeaderParams,
|
|
1520
|
-
uri: localVarPath,
|
|
1521
|
-
useQuerystring: this._useQuerystring,
|
|
1522
|
-
json: true,
|
|
1523
|
-
body: ObjectSerializer.serialize(updatePlanDetails, "SubAccountsUpdatePlanRequest")
|
|
1524
|
-
};
|
|
1525
|
-
|
|
1526
|
-
let authenticationPromise = Promise.resolve();
|
|
1527
|
-
if (this.authentications.apiKey.apiKey) {
|
|
1528
|
-
authenticationPromise = authenticationPromise.then(() => this.authentications.apiKey.applyToRequest(localVarRequestOptions));
|
|
1529
|
-
}
|
|
1530
|
-
if (this.authentications.partnerKey.apiKey) {
|
|
1531
|
-
authenticationPromise = authenticationPromise.then(() => this.authentications.partnerKey.applyToRequest(localVarRequestOptions));
|
|
1532
|
-
}
|
|
1533
|
-
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
|
1534
|
-
|
|
1535
|
-
let interceptorPromise = authenticationPromise;
|
|
1536
|
-
for (const interceptor of this.interceptors) {
|
|
1537
|
-
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
|
1538
|
-
}
|
|
1539
|
-
|
|
1540
|
-
return interceptorPromise.then(() => {
|
|
1541
|
-
if (Object.keys(localVarFormParams).length) {
|
|
1542
|
-
if (localVarUseFormData) {
|
|
1543
|
-
(<any>localVarRequestOptions).formData = localVarFormParams;
|
|
1544
|
-
} else {
|
|
1545
|
-
localVarRequestOptions.form = localVarFormParams;
|
|
1546
|
-
}
|
|
1547
|
-
}
|
|
1548
|
-
return new Promise<{ response: http.IncomingMessage; body?: any; }>((resolve, reject) => {
|
|
1549
|
-
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
|
1550
|
-
if (error) {
|
|
1551
|
-
reject(error);
|
|
1552
|
-
} else {
|
|
1553
|
-
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
|
1554
|
-
resolve({ response: response, body: body });
|
|
1555
|
-
} else {
|
|
1556
|
-
reject(new HttpError(response, body, response.statusCode));
|
|
1557
|
-
}
|
|
1558
|
-
}
|
|
1559
|
-
});
|
|
1560
|
-
});
|
|
1561
|
-
});
|
|
1562
|
-
}
|
|
1563
|
-
/**
|
|
1564
|
-
* This endpoint will allow you to change the permissions of Admin users of your Admin account
|
|
1565
|
-
* @summary Change admin user permissions
|
|
1566
|
-
* @param email Email address of Admin user
|
|
1567
|
-
* @param body Values to update an admin user permissions
|
|
1568
|
-
*/
|
|
1569
|
-
public async corporateUserEmailPermissionsPut (email: string, body: CorporateUserEmailPermissionsPutRequest, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body?: any; }> {
|
|
1570
|
-
const localVarPath = this.basePath + '/corporate/user/{email}/permissions'
|
|
1571
|
-
.replace('{' + 'email' + '}', encodeURIComponent(String(email)));
|
|
1572
|
-
let localVarQueryParameters: any = {};
|
|
1573
|
-
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
|
1574
|
-
const produces = ['application/json'];
|
|
1575
|
-
// give precedence to 'application/json'
|
|
1576
|
-
if (produces.indexOf('application/json') >= 0) {
|
|
1577
|
-
localVarHeaderParams.Accept = 'application/json';
|
|
1578
|
-
} else {
|
|
1579
|
-
localVarHeaderParams.Accept = produces.join(',');
|
|
1580
|
-
}
|
|
1581
|
-
let localVarFormParams: any = {};
|
|
1582
|
-
|
|
1583
|
-
// verify required parameter 'email' is not null or undefined
|
|
1584
|
-
if (email === null || email === undefined) {
|
|
1585
|
-
throw new Error('Required parameter email was null or undefined when calling corporateUserEmailPermissionsPut.');
|
|
1586
|
-
}
|
|
1587
|
-
|
|
1588
|
-
// verify required parameter 'body' is not null or undefined
|
|
1589
|
-
if (body === null || body === undefined) {
|
|
1590
|
-
throw new Error('Required parameter body was null or undefined when calling corporateUserEmailPermissionsPut.');
|
|
1591
|
-
}
|
|
1592
|
-
|
|
1593
|
-
(<any>Object).assign(localVarHeaderParams, options.headers);
|
|
1594
|
-
|
|
1595
|
-
let localVarUseFormData = false;
|
|
1596
|
-
|
|
1597
|
-
let localVarRequestOptions: localVarRequest.Options = {
|
|
1598
|
-
method: 'PUT',
|
|
1599
|
-
qs: localVarQueryParameters,
|
|
1600
|
-
headers: localVarHeaderParams,
|
|
1601
|
-
uri: localVarPath,
|
|
1602
|
-
useQuerystring: this._useQuerystring,
|
|
1603
|
-
json: true,
|
|
1604
|
-
body: ObjectSerializer.serialize(body, "CorporateUserEmailPermissionsPutRequest")
|
|
1605
|
-
};
|
|
1606
|
-
|
|
1607
|
-
let authenticationPromise = Promise.resolve();
|
|
1608
|
-
if (this.authentications.apiKey.apiKey) {
|
|
1609
|
-
authenticationPromise = authenticationPromise.then(() => this.authentications.apiKey.applyToRequest(localVarRequestOptions));
|
|
1610
|
-
}
|
|
1611
|
-
if (this.authentications.partnerKey.apiKey) {
|
|
1612
|
-
authenticationPromise = authenticationPromise.then(() => this.authentications.partnerKey.applyToRequest(localVarRequestOptions));
|
|
1613
|
-
}
|
|
1614
|
-
authenticationPromise = authenticationPromise.then(() => this.authentications.default.applyToRequest(localVarRequestOptions));
|
|
1615
|
-
|
|
1616
|
-
let interceptorPromise = authenticationPromise;
|
|
1617
|
-
for (const interceptor of this.interceptors) {
|
|
1618
|
-
interceptorPromise = interceptorPromise.then(() => interceptor(localVarRequestOptions));
|
|
1619
|
-
}
|
|
1620
|
-
|
|
1621
|
-
return interceptorPromise.then(() => {
|
|
1622
|
-
if (Object.keys(localVarFormParams).length) {
|
|
1623
|
-
if (localVarUseFormData) {
|
|
1624
|
-
(<any>localVarRequestOptions).formData = localVarFormParams;
|
|
1625
|
-
} else {
|
|
1626
|
-
localVarRequestOptions.form = localVarFormParams;
|
|
1627
|
-
}
|
|
1628
|
-
}
|
|
1629
|
-
return new Promise<{ response: http.IncomingMessage; body?: any; }>((resolve, reject) => {
|
|
1630
|
-
localVarRequest(localVarRequestOptions, (error, response, body) => {
|
|
1631
|
-
if (error) {
|
|
1632
|
-
reject(error);
|
|
1633
|
-
} else {
|
|
1634
|
-
if (response.statusCode && response.statusCode >= 200 && response.statusCode <= 299) {
|
|
1635
|
-
resolve({ response: response, body: body });
|
|
1636
|
-
} else {
|
|
1637
|
-
reject(new HttpError(response, body, response.statusCode));
|
|
1638
|
-
}
|
|
1639
|
-
}
|
|
1640
|
-
});
|
|
1641
|
-
});
|
|
1642
|
-
});
|
|
1643
|
-
}
|
|
1644
|
-
/**
|
|
1645
|
-
* This endpoint will allow the user to: - Resend an admin user invitation - Cancel an admin user invitation
|
|
1421
|
+
* This endpoint will allow the user to: - Resend an admin user invitation - Cancel an admin user invitation
|
|
1646
1422
|
* @summary Resend / cancel admin user invitation
|
|
1647
1423
|
* @param action Action to be performed (cancel / resend)
|
|
1648
1424
|
* @param email Email address of the recipient
|
|
@@ -1802,11 +1578,10 @@ export class MasterAccountApi {
|
|
|
1802
1578
|
* @summary Get user activity logs
|
|
1803
1579
|
* @param startDate Mandatory if endDate is used. Enter start date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. Additionally, you can retrieve activity logs from the past 12 months from the date of your search.
|
|
1804
1580
|
* @param endDate Mandatory if startDate is used. Enter end date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month.
|
|
1805
|
-
* @param email Enter the user\'s email address to filter their activity in the account.
|
|
1806
1581
|
* @param limit Number of documents per page
|
|
1807
1582
|
* @param offset Index of the first document in the page.
|
|
1808
1583
|
*/
|
|
1809
|
-
public async getAccountActivity (startDate?: string, endDate?: string,
|
|
1584
|
+
public async getAccountActivity (startDate?: string, endDate?: string, limit?: number, offset?: number, options: {headers: {[name: string]: string}} = {headers: {}}) : Promise<{ response: http.IncomingMessage; body: GetAccountActivity; }> {
|
|
1810
1585
|
const localVarPath = this.basePath + '/organization/activities';
|
|
1811
1586
|
let localVarQueryParameters: any = {};
|
|
1812
1587
|
let localVarHeaderParams: any = (<any>Object).assign({}, this._defaultHeaders);
|
|
@@ -1827,10 +1602,6 @@ export class MasterAccountApi {
|
|
|
1827
1602
|
localVarQueryParameters['endDate'] = ObjectSerializer.serialize(endDate, "string");
|
|
1828
1603
|
}
|
|
1829
1604
|
|
|
1830
|
-
if (email !== undefined) {
|
|
1831
|
-
localVarQueryParameters['email'] = ObjectSerializer.serialize(email, "string");
|
|
1832
|
-
}
|
|
1833
|
-
|
|
1834
1605
|
if (limit !== undefined) {
|
|
1835
1606
|
localVarQueryParameters['limit'] = ObjectSerializer.serialize(limit, "number");
|
|
1836
1607
|
}
|
|
@@ -1959,7 +1730,7 @@ export class MasterAccountApi {
|
|
|
1959
1730
|
});
|
|
1960
1731
|
}
|
|
1961
1732
|
/**
|
|
1962
|
-
*
|
|
1733
|
+
*
|
|
1963
1734
|
* @summary Check admin user permissions
|
|
1964
1735
|
* @param email Email of the invited user
|
|
1965
1736
|
*/
|
|
@@ -2102,7 +1873,7 @@ export class MasterAccountApi {
|
|
|
2102
1873
|
});
|
|
2103
1874
|
}
|
|
2104
1875
|
/**
|
|
2105
|
-
* `This endpoint allows you to invite a member to manage the Admin account Features and their respective permissions are as below: - `my_plan`: - \"all\" - `api`: - \"none\" - `user_management`: - \"all\" - `app_management` | Not available in ENTv2: - \"all\"
|
|
1876
|
+
* `This endpoint allows you to invite a member to manage the Admin account Features and their respective permissions are as below: - `my_plan`: - \"all\" - `api`: - \"none\" - `user_management`: - \"all\" - `app_management` | Not available in ENTv2: - \"all\" **Note**: - If `all_features_access: false` then only privileges are required otherwise if `true` then it\'s assumed that all permissions will be there for the invited admin user.
|
|
2106
1877
|
* @summary Send invitation to an admin user
|
|
2107
1878
|
* @param sendInvitation Payload to send an invitation
|
|
2108
1879
|
*/
|