@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/model/createWebhook.ts
CHANGED
|
@@ -24,7 +24,7 @@ export class CreateWebhook {
|
|
|
24
24
|
*/
|
|
25
25
|
'description'?: string;
|
|
26
26
|
/**
|
|
27
|
-
* - Events triggering the webhook. Possible values for **Transactional** type webhook: #### `sent` OR `request`, `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`, `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and `unsubscribed` - Possible values for **Marketing** type webhook: #### `spam`, `opened`, `click`, `hardBounce`, `softBounce`, `unsubscribed`, `listAddition` & `delivered` - Possible values for **Inbound** type webhook: #### `inboundEmailProcessed`
|
|
27
|
+
* - Events triggering the webhook. Possible values for **Transactional** type webhook: #### `sent` OR `request`, `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`, `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and `unsubscribed` - Possible values for **Marketing** type webhook: #### `spam`, `opened`, `click`, `hardBounce`, `softBounce`, `unsubscribed`, `listAddition` & `delivered` - Possible values for **Inbound** type webhook: #### `inboundEmailProcessed`
|
|
28
28
|
*/
|
|
29
29
|
'events': Array<CreateWebhook.EventsEnum>;
|
|
30
30
|
/**
|
|
@@ -32,10 +32,6 @@ export class CreateWebhook {
|
|
|
32
32
|
*/
|
|
33
33
|
'type'?: CreateWebhook.TypeEnum = CreateWebhook.TypeEnum.Transactional;
|
|
34
34
|
/**
|
|
35
|
-
* channel of webhook
|
|
36
|
-
*/
|
|
37
|
-
'channel'?: CreateWebhook.ChannelEnum = CreateWebhook.ChannelEnum.Email;
|
|
38
|
-
/**
|
|
39
35
|
* Inbound domain of webhook, required in case of event type `inbound`
|
|
40
36
|
*/
|
|
41
37
|
'domain'?: string;
|
|
@@ -72,11 +68,6 @@ export class CreateWebhook {
|
|
|
72
68
|
"baseName": "type",
|
|
73
69
|
"type": "CreateWebhook.TypeEnum"
|
|
74
70
|
},
|
|
75
|
-
{
|
|
76
|
-
"name": "channel",
|
|
77
|
-
"baseName": "channel",
|
|
78
|
-
"type": "CreateWebhook.ChannelEnum"
|
|
79
|
-
},
|
|
80
71
|
{
|
|
81
72
|
"name": "domain",
|
|
82
73
|
"baseName": "domain",
|
|
@@ -128,8 +119,4 @@ export namespace CreateWebhook {
|
|
|
128
119
|
Marketing = <any> 'marketing',
|
|
129
120
|
Inbound = <any> 'inbound'
|
|
130
121
|
}
|
|
131
|
-
export enum ChannelEnum {
|
|
132
|
-
Sms = <any> 'sms',
|
|
133
|
-
Email = <any> 'email'
|
|
134
|
-
}
|
|
135
122
|
}
|
|
@@ -21,14 +21,6 @@ export class CrmDealsIdPatchRequest {
|
|
|
21
21
|
* Attributes for deal update To assign owner of a Deal you can send attributes.deal_owner and utilize the account email or ID. If you wish to update the pipeline of a deal you need to provide the `pipeline` and the `deal_stage`. Pipeline and deal_stage are ids you can fetch using this endpoint `/crm/pipeline/details/{pipelineID}`
|
|
22
22
|
*/
|
|
23
23
|
'attributes'?: object;
|
|
24
|
-
/**
|
|
25
|
-
* Warning - Using PATCH on linkedContactIds replaces the list of linked contacts. Omitted IDs will be removed.
|
|
26
|
-
*/
|
|
27
|
-
'linkedContactsIds'?: Array<number>;
|
|
28
|
-
/**
|
|
29
|
-
* Warning - Using PATCH on linkedCompaniesIds replaces the list of linked contacts. Omitted IDs will be removed.
|
|
30
|
-
*/
|
|
31
|
-
'linkedCompaniesIds'?: Array<string>;
|
|
32
24
|
|
|
33
25
|
static discriminator: string | undefined = undefined;
|
|
34
26
|
|
|
@@ -42,16 +34,6 @@ export class CrmDealsIdPatchRequest {
|
|
|
42
34
|
"name": "attributes",
|
|
43
35
|
"baseName": "attributes",
|
|
44
36
|
"type": "object"
|
|
45
|
-
},
|
|
46
|
-
{
|
|
47
|
-
"name": "linkedContactsIds",
|
|
48
|
-
"baseName": "linkedContactsIds",
|
|
49
|
-
"type": "Array<number>"
|
|
50
|
-
},
|
|
51
|
-
{
|
|
52
|
-
"name": "linkedCompaniesIds",
|
|
53
|
-
"baseName": "linkedCompaniesIds",
|
|
54
|
-
"type": "Array<string>"
|
|
55
37
|
} ];
|
|
56
38
|
|
|
57
39
|
static getAttributeTypeMap() {
|
package/model/ecommerceAttributionMetricsConversionSourceConversionSourceIdGet200Response.ts
CHANGED
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
import { RequestFile } from './models';
|
|
14
14
|
|
|
15
15
|
export class EcommerceAttributionMetricsConversionSourceConversionSourceIdGet200Response {
|
|
16
|
-
'id':
|
|
16
|
+
'id': number;
|
|
17
17
|
'conversionSource': EcommerceAttributionMetricsConversionSourceConversionSourceIdGet200Response.ConversionSourceEnum;
|
|
18
18
|
'ordersCount': number;
|
|
19
19
|
'revenue': number;
|
|
@@ -26,7 +26,7 @@ export class EcommerceAttributionMetricsConversionSourceConversionSourceIdGet200
|
|
|
26
26
|
{
|
|
27
27
|
"name": "id",
|
|
28
28
|
"baseName": "id",
|
|
29
|
-
"type": "
|
|
29
|
+
"type": "number"
|
|
30
30
|
},
|
|
31
31
|
{
|
|
32
32
|
"name": "conversionSource",
|
|
@@ -61,9 +61,6 @@ export class EcommerceAttributionMetricsConversionSourceConversionSourceIdGet200
|
|
|
61
61
|
|
|
62
62
|
export namespace EcommerceAttributionMetricsConversionSourceConversionSourceIdGet200Response {
|
|
63
63
|
export enum ConversionSourceEnum {
|
|
64
|
-
EmailCampaign = <any> 'email_campaign'
|
|
65
|
-
SmsCampaign = <any> 'sms_campaign',
|
|
66
|
-
AutomationWorkflowEmail = <any> 'automation_workflow_email',
|
|
67
|
-
AutomationWorkflowSms = <any> 'automation_workflow_sms'
|
|
64
|
+
EmailCampaign = <any> 'email_campaign'
|
|
68
65
|
}
|
|
69
66
|
}
|
package/model/errorModel.ts
CHANGED
|
@@ -49,6 +49,7 @@ export namespace ErrorModel {
|
|
|
49
49
|
CampaignProcessing = <any> 'campaign_processing',
|
|
50
50
|
CampaignSent = <any> 'campaign_sent',
|
|
51
51
|
DocumentNotFound = <any> 'document_not_found',
|
|
52
|
+
ResellerPermissionDenied = <any> 'reseller_permission_denied',
|
|
52
53
|
NotEnoughCredits = <any> 'not_enough_credits',
|
|
53
54
|
PermissionDenied = <any> 'permission_denied',
|
|
54
55
|
DuplicateParameter = <any> 'duplicate_parameter',
|
|
@@ -26,13 +26,17 @@ export class GetAccountAllOfPlan {
|
|
|
26
26
|
*/
|
|
27
27
|
'credits': number;
|
|
28
28
|
/**
|
|
29
|
-
* Date of the period from which the plan will start (only available for \"subscription\" plan type)
|
|
29
|
+
* Date of the period from which the plan will start (only available for \"subscription\" and \"reseller\" plan type)
|
|
30
30
|
*/
|
|
31
31
|
'startDate'?: string;
|
|
32
32
|
/**
|
|
33
|
-
* Date of the period from which the plan will end (only available for \"subscription\" plan type)
|
|
33
|
+
* Date of the period from which the plan will end (only available for \"subscription\" and \"reseller\" plan type)
|
|
34
34
|
*/
|
|
35
35
|
'endDate'?: string;
|
|
36
|
+
/**
|
|
37
|
+
* Only in case of reseller account. It implies the total number of child accounts you can add to your account.
|
|
38
|
+
*/
|
|
39
|
+
'userLimit'?: number;
|
|
36
40
|
|
|
37
41
|
static discriminator: string | undefined = undefined;
|
|
38
42
|
|
|
@@ -61,6 +65,11 @@ export class GetAccountAllOfPlan {
|
|
|
61
65
|
"name": "endDate",
|
|
62
66
|
"baseName": "endDate",
|
|
63
67
|
"type": "string"
|
|
68
|
+
},
|
|
69
|
+
{
|
|
70
|
+
"name": "userLimit",
|
|
71
|
+
"baseName": "userLimit",
|
|
72
|
+
"type": "number"
|
|
64
73
|
} ];
|
|
65
74
|
|
|
66
75
|
static getAttributeTypeMap() {
|
|
@@ -73,7 +82,8 @@ export namespace GetAccountAllOfPlan {
|
|
|
73
82
|
PayAsYouGo = <any> 'payAsYouGo',
|
|
74
83
|
Free = <any> 'free',
|
|
75
84
|
Subscription = <any> 'subscription',
|
|
76
|
-
Sms = <any> 'sms'
|
|
85
|
+
Sms = <any> 'sms',
|
|
86
|
+
Reseller = <any> 'reseller'
|
|
77
87
|
}
|
|
78
88
|
export enum CreditsTypeEnum {
|
|
79
89
|
SendLimit = <any> 'sendLimit'
|
|
@@ -34,10 +34,6 @@ export class GetAttributesAttributesInner {
|
|
|
34
34
|
* Calculated value formula
|
|
35
35
|
*/
|
|
36
36
|
'calculatedValue'?: string;
|
|
37
|
-
/**
|
|
38
|
-
* Parameter only available for \"multiple-choice\" type attributes.
|
|
39
|
-
*/
|
|
40
|
-
'multiCategoryOptions'?: Array<string>;
|
|
41
37
|
|
|
42
38
|
static discriminator: string | undefined = undefined;
|
|
43
39
|
|
|
@@ -66,11 +62,6 @@ export class GetAttributesAttributesInner {
|
|
|
66
62
|
"name": "calculatedValue",
|
|
67
63
|
"baseName": "calculatedValue",
|
|
68
64
|
"type": "string"
|
|
69
|
-
},
|
|
70
|
-
{
|
|
71
|
-
"name": "multiCategoryOptions",
|
|
72
|
-
"baseName": "multiCategoryOptions",
|
|
73
|
-
"type": "Array<string>"
|
|
74
65
|
} ];
|
|
75
66
|
|
|
76
67
|
static getAttributeTypeMap() {
|
|
@@ -91,8 +82,6 @@ export namespace GetAttributesAttributesInner {
|
|
|
91
82
|
Date = <any> 'date',
|
|
92
83
|
Float = <any> 'float',
|
|
93
84
|
Id = <any> 'id',
|
|
94
|
-
Boolean = <any> 'boolean'
|
|
95
|
-
MultipleChoice = <any> 'multiple-choice',
|
|
96
|
-
User = <any> 'user'
|
|
85
|
+
Boolean = <any> 'boolean'
|
|
97
86
|
}
|
|
98
87
|
}
|
|
@@ -77,14 +77,6 @@ export class GetCampaignStats {
|
|
|
77
77
|
* Total number of non-delivered campaigns for a particular campaign id.
|
|
78
78
|
*/
|
|
79
79
|
'returnBounce'?: number;
|
|
80
|
-
/**
|
|
81
|
-
* Percentage of recipients who open the email out of your total number of recipients. Depending on your Campaign settings, they may include Apple MPP opens.
|
|
82
|
-
*/
|
|
83
|
-
'opensRate': number;
|
|
84
|
-
/**
|
|
85
|
-
* Numbers of times your email has been opened automatically through Apple MPP.
|
|
86
|
-
*/
|
|
87
|
-
'appleMppOpens': number;
|
|
88
80
|
|
|
89
81
|
static discriminator: string | undefined = undefined;
|
|
90
82
|
|
|
@@ -168,16 +160,6 @@ export class GetCampaignStats {
|
|
|
168
160
|
"name": "returnBounce",
|
|
169
161
|
"baseName": "returnBounce",
|
|
170
162
|
"type": "number"
|
|
171
|
-
},
|
|
172
|
-
{
|
|
173
|
-
"name": "opensRate",
|
|
174
|
-
"baseName": "opensRate",
|
|
175
|
-
"type": "number"
|
|
176
|
-
},
|
|
177
|
-
{
|
|
178
|
-
"name": "appleMppOpens",
|
|
179
|
-
"baseName": "appleMppOpens",
|
|
180
|
-
"type": "number"
|
|
181
163
|
} ];
|
|
182
164
|
|
|
183
165
|
static getAttributeTypeMap() {
|
|
@@ -12,24 +12,24 @@
|
|
|
12
12
|
|
|
13
13
|
import { RequestFile } from './models';
|
|
14
14
|
import { GetContactCampaignStatsClickedInner } from './getContactCampaignStatsClickedInner';
|
|
15
|
+
import { GetContactCampaignStatsMessagesSentInner } from './getContactCampaignStatsMessagesSentInner';
|
|
15
16
|
import { GetContactCampaignStatsOpenedInner } from './getContactCampaignStatsOpenedInner';
|
|
16
17
|
import { GetContactCampaignStatsTransacAttributesInner } from './getContactCampaignStatsTransacAttributesInner';
|
|
17
18
|
import { GetContactCampaignStatsUnsubscriptions } from './getContactCampaignStatsUnsubscriptions';
|
|
18
|
-
import { GetExtendedContactDetailsAllOfStatisticsMessagesSent } from './getExtendedContactDetailsAllOfStatisticsMessagesSent';
|
|
19
19
|
|
|
20
20
|
/**
|
|
21
21
|
* Campaign Statistics for the contact
|
|
22
22
|
*/
|
|
23
23
|
export class GetContactCampaignStats {
|
|
24
|
-
'messagesSent'?: Array<
|
|
25
|
-
'hardBounces'?: Array<
|
|
26
|
-
'softBounces'?: Array<
|
|
27
|
-
'complaints'?: Array<
|
|
24
|
+
'messagesSent'?: Array<GetContactCampaignStatsMessagesSentInner>;
|
|
25
|
+
'hardBounces'?: Array<GetContactCampaignStatsMessagesSentInner>;
|
|
26
|
+
'softBounces'?: Array<GetContactCampaignStatsMessagesSentInner>;
|
|
27
|
+
'complaints'?: Array<GetContactCampaignStatsMessagesSentInner>;
|
|
28
28
|
'unsubscriptions'?: GetContactCampaignStatsUnsubscriptions;
|
|
29
29
|
'opened'?: Array<GetContactCampaignStatsOpenedInner>;
|
|
30
30
|
'clicked'?: Array<GetContactCampaignStatsClickedInner>;
|
|
31
31
|
'transacAttributes'?: Array<GetContactCampaignStatsTransacAttributesInner>;
|
|
32
|
-
'delivered'?: Array<
|
|
32
|
+
'delivered'?: Array<GetContactCampaignStatsMessagesSentInner>;
|
|
33
33
|
|
|
34
34
|
static discriminator: string | undefined = undefined;
|
|
35
35
|
|
|
@@ -37,22 +37,22 @@ export class GetContactCampaignStats {
|
|
|
37
37
|
{
|
|
38
38
|
"name": "messagesSent",
|
|
39
39
|
"baseName": "messagesSent",
|
|
40
|
-
"type": "Array<
|
|
40
|
+
"type": "Array<GetContactCampaignStatsMessagesSentInner>"
|
|
41
41
|
},
|
|
42
42
|
{
|
|
43
43
|
"name": "hardBounces",
|
|
44
44
|
"baseName": "hardBounces",
|
|
45
|
-
"type": "Array<
|
|
45
|
+
"type": "Array<GetContactCampaignStatsMessagesSentInner>"
|
|
46
46
|
},
|
|
47
47
|
{
|
|
48
48
|
"name": "softBounces",
|
|
49
49
|
"baseName": "softBounces",
|
|
50
|
-
"type": "Array<
|
|
50
|
+
"type": "Array<GetContactCampaignStatsMessagesSentInner>"
|
|
51
51
|
},
|
|
52
52
|
{
|
|
53
53
|
"name": "complaints",
|
|
54
54
|
"baseName": "complaints",
|
|
55
|
-
"type": "Array<
|
|
55
|
+
"type": "Array<GetContactCampaignStatsMessagesSentInner>"
|
|
56
56
|
},
|
|
57
57
|
{
|
|
58
58
|
"name": "unsubscriptions",
|
|
@@ -77,7 +77,7 @@ export class GetContactCampaignStats {
|
|
|
77
77
|
{
|
|
78
78
|
"name": "delivered",
|
|
79
79
|
"baseName": "delivered",
|
|
80
|
-
"type": "Array<
|
|
80
|
+
"type": "Array<GetContactCampaignStatsMessagesSentInner>"
|
|
81
81
|
} ];
|
|
82
82
|
|
|
83
83
|
static getAttributeTypeMap() {
|
|
@@ -11,14 +11,14 @@
|
|
|
11
11
|
*/
|
|
12
12
|
|
|
13
13
|
import { RequestFile } from './models';
|
|
14
|
-
import {
|
|
14
|
+
import { GetContactCampaignStatsClickedInnerLinksInner } from './getContactCampaignStatsClickedInnerLinksInner';
|
|
15
15
|
|
|
16
16
|
export class GetContactCampaignStatsClickedInner {
|
|
17
17
|
/**
|
|
18
18
|
* ID of the campaign which generated the event
|
|
19
19
|
*/
|
|
20
20
|
'campaignId': number;
|
|
21
|
-
'links': Array<
|
|
21
|
+
'links': Array<GetContactCampaignStatsClickedInnerLinksInner>;
|
|
22
22
|
|
|
23
23
|
static discriminator: string | undefined = undefined;
|
|
24
24
|
|
|
@@ -31,7 +31,7 @@ export class GetContactCampaignStatsClickedInner {
|
|
|
31
31
|
{
|
|
32
32
|
"name": "links",
|
|
33
33
|
"baseName": "links",
|
|
34
|
-
"type": "Array<
|
|
34
|
+
"type": "Array<GetContactCampaignStatsClickedInnerLinksInner>"
|
|
35
35
|
} ];
|
|
36
36
|
|
|
37
37
|
static getAttributeTypeMap() {
|
|
@@ -11,18 +11,18 @@
|
|
|
11
11
|
*/
|
|
12
12
|
|
|
13
13
|
import { RequestFile } from './models';
|
|
14
|
-
import {
|
|
15
|
-
import {
|
|
14
|
+
import { GetContactCampaignStatsUnsubscriptionsAdminUnsubscriptionInner } from './getContactCampaignStatsUnsubscriptionsAdminUnsubscriptionInner';
|
|
15
|
+
import { GetContactCampaignStatsUnsubscriptionsUserUnsubscriptionInner } from './getContactCampaignStatsUnsubscriptionsUserUnsubscriptionInner';
|
|
16
16
|
|
|
17
17
|
export class GetContactCampaignStatsUnsubscriptions {
|
|
18
18
|
/**
|
|
19
19
|
* Contact has unsubscribed via the unsubscription link in the email
|
|
20
20
|
*/
|
|
21
|
-
'userUnsubscription': Array<
|
|
21
|
+
'userUnsubscription': Array<GetContactCampaignStatsUnsubscriptionsUserUnsubscriptionInner>;
|
|
22
22
|
/**
|
|
23
23
|
* Contact has been unsubscribed from the administrator
|
|
24
24
|
*/
|
|
25
|
-
'adminUnsubscription': Array<
|
|
25
|
+
'adminUnsubscription': Array<GetContactCampaignStatsUnsubscriptionsAdminUnsubscriptionInner>;
|
|
26
26
|
|
|
27
27
|
static discriminator: string | undefined = undefined;
|
|
28
28
|
|
|
@@ -30,12 +30,12 @@ export class GetContactCampaignStatsUnsubscriptions {
|
|
|
30
30
|
{
|
|
31
31
|
"name": "userUnsubscription",
|
|
32
32
|
"baseName": "userUnsubscription",
|
|
33
|
-
"type": "Array<
|
|
33
|
+
"type": "Array<GetContactCampaignStatsUnsubscriptionsUserUnsubscriptionInner>"
|
|
34
34
|
},
|
|
35
35
|
{
|
|
36
36
|
"name": "adminUnsubscription",
|
|
37
37
|
"baseName": "adminUnsubscription",
|
|
38
|
-
"type": "Array<
|
|
38
|
+
"type": "Array<GetContactCampaignStatsUnsubscriptionsAdminUnsubscriptionInner>"
|
|
39
39
|
} ];
|
|
40
40
|
|
|
41
41
|
static getAttributeTypeMap() {
|
|
@@ -32,26 +32,6 @@ export class GetCorporateInvitedUsersListUsersInnerFeatureAccess {
|
|
|
32
32
|
* Apps management accessiblity | Not available in ENTv2
|
|
33
33
|
*/
|
|
34
34
|
'appsManagement'?: Array<string>;
|
|
35
|
-
/**
|
|
36
|
-
* Group creation, modification or deletion accessibility
|
|
37
|
-
*/
|
|
38
|
-
'subOrganizationGroups'?: Array<string>;
|
|
39
|
-
/**
|
|
40
|
-
* Authorization to create sub-organization in the admin account. If the user creating the sub-organization, belongs to a group, the user must choose a group at the sub-organization creation.
|
|
41
|
-
*/
|
|
42
|
-
'createSubOrganizations'?: Array<string>;
|
|
43
|
-
/**
|
|
44
|
-
* Authorization to manage and access sub-organizations in the admin account.
|
|
45
|
-
*/
|
|
46
|
-
'manageSubOrganizations'?: Array<string>;
|
|
47
|
-
/**
|
|
48
|
-
* Analytics dashboard accessibility
|
|
49
|
-
*/
|
|
50
|
-
'analytics'?: Array<string>;
|
|
51
|
-
/**
|
|
52
|
-
* Security page accessibility
|
|
53
|
-
*/
|
|
54
|
-
'security'?: Array<string>;
|
|
55
35
|
|
|
56
36
|
static discriminator: string | undefined = undefined;
|
|
57
37
|
|
|
@@ -75,31 +55,6 @@ export class GetCorporateInvitedUsersListUsersInnerFeatureAccess {
|
|
|
75
55
|
"name": "appsManagement",
|
|
76
56
|
"baseName": "apps_management",
|
|
77
57
|
"type": "Array<string>"
|
|
78
|
-
},
|
|
79
|
-
{
|
|
80
|
-
"name": "subOrganizationGroups",
|
|
81
|
-
"baseName": "sub_organization_groups",
|
|
82
|
-
"type": "Array<string>"
|
|
83
|
-
},
|
|
84
|
-
{
|
|
85
|
-
"name": "createSubOrganizations",
|
|
86
|
-
"baseName": "create_sub_organizations",
|
|
87
|
-
"type": "Array<string>"
|
|
88
|
-
},
|
|
89
|
-
{
|
|
90
|
-
"name": "manageSubOrganizations",
|
|
91
|
-
"baseName": "manage_sub_organizations",
|
|
92
|
-
"type": "Array<string>"
|
|
93
|
-
},
|
|
94
|
-
{
|
|
95
|
-
"name": "analytics",
|
|
96
|
-
"baseName": "analytics",
|
|
97
|
-
"type": "Array<string>"
|
|
98
|
-
},
|
|
99
|
-
{
|
|
100
|
-
"name": "security",
|
|
101
|
-
"baseName": "security",
|
|
102
|
-
"type": "Array<string>"
|
|
103
58
|
} ];
|
|
104
59
|
|
|
105
60
|
static getAttributeTypeMap() {
|
|
@@ -32,26 +32,6 @@ export class GetCorporateUserPermissionFeatureAccess {
|
|
|
32
32
|
* Permission on apps management
|
|
33
33
|
*/
|
|
34
34
|
'appsManagement'?: Array<string>;
|
|
35
|
-
/**
|
|
36
|
-
* Permission on groups
|
|
37
|
-
*/
|
|
38
|
-
'subOrganizationGroups'?: Array<string>;
|
|
39
|
-
/**
|
|
40
|
-
* Permission on create sub-accounts
|
|
41
|
-
*/
|
|
42
|
-
'createSubOrganizations'?: Array<string>;
|
|
43
|
-
/**
|
|
44
|
-
* Permission on manage sub-accounts
|
|
45
|
-
*/
|
|
46
|
-
'manageSubOrganizations'?: Array<string>;
|
|
47
|
-
/**
|
|
48
|
-
* Permission on analytics
|
|
49
|
-
*/
|
|
50
|
-
'analytics'?: Array<string>;
|
|
51
|
-
/**
|
|
52
|
-
* Permission on security
|
|
53
|
-
*/
|
|
54
|
-
'security'?: Array<string>;
|
|
55
35
|
|
|
56
36
|
static discriminator: string | undefined = undefined;
|
|
57
37
|
|
|
@@ -75,31 +55,6 @@ export class GetCorporateUserPermissionFeatureAccess {
|
|
|
75
55
|
"name": "appsManagement",
|
|
76
56
|
"baseName": "apps_management",
|
|
77
57
|
"type": "Array<string>"
|
|
78
|
-
},
|
|
79
|
-
{
|
|
80
|
-
"name": "subOrganizationGroups",
|
|
81
|
-
"baseName": "sub_organization_groups",
|
|
82
|
-
"type": "Array<string>"
|
|
83
|
-
},
|
|
84
|
-
{
|
|
85
|
-
"name": "createSubOrganizations",
|
|
86
|
-
"baseName": "create_sub_organizations",
|
|
87
|
-
"type": "Array<string>"
|
|
88
|
-
},
|
|
89
|
-
{
|
|
90
|
-
"name": "manageSubOrganizations",
|
|
91
|
-
"baseName": "manage_sub_organizations",
|
|
92
|
-
"type": "Array<string>"
|
|
93
|
-
},
|
|
94
|
-
{
|
|
95
|
-
"name": "analytics",
|
|
96
|
-
"baseName": "analytics",
|
|
97
|
-
"type": "Array<string>"
|
|
98
|
-
},
|
|
99
|
-
{
|
|
100
|
-
"name": "security",
|
|
101
|
-
"baseName": "security",
|
|
102
|
-
"type": "Array<string>"
|
|
103
58
|
} ];
|
|
104
59
|
|
|
105
60
|
static getAttributeTypeMap() {
|
|
@@ -11,7 +11,9 @@
|
|
|
11
11
|
*/
|
|
12
12
|
|
|
13
13
|
import { RequestFile } from './models';
|
|
14
|
+
import { GetCampaignRecipients } from './getCampaignRecipients';
|
|
14
15
|
import { GetExtendedCampaignOverviewAllOfSender } from './getExtendedCampaignOverviewAllOfSender';
|
|
16
|
+
import { GetExtendedCampaignStats } from './getExtendedCampaignStats';
|
|
15
17
|
|
|
16
18
|
export class GetEmailCampaign {
|
|
17
19
|
/**
|
|
@@ -147,8 +149,8 @@ export class GetEmailCampaign {
|
|
|
147
149
|
* Total number of non-delivered campaigns for a particular campaign id.
|
|
148
150
|
*/
|
|
149
151
|
'returnBounce'?: number;
|
|
150
|
-
'recipients':
|
|
151
|
-
'statistics':
|
|
152
|
+
'recipients': GetCampaignRecipients;
|
|
153
|
+
'statistics': GetExtendedCampaignStats;
|
|
152
154
|
|
|
153
155
|
static discriminator: string | undefined = undefined;
|
|
154
156
|
|
|
@@ -326,12 +328,12 @@ export class GetEmailCampaign {
|
|
|
326
328
|
{
|
|
327
329
|
"name": "recipients",
|
|
328
330
|
"baseName": "recipients",
|
|
329
|
-
"type": "
|
|
331
|
+
"type": "GetCampaignRecipients"
|
|
330
332
|
},
|
|
331
333
|
{
|
|
332
334
|
"name": "statistics",
|
|
333
335
|
"baseName": "statistics",
|
|
334
|
-
"type": "
|
|
336
|
+
"type": "GetExtendedCampaignStats"
|
|
335
337
|
} ];
|
|
336
338
|
|
|
337
339
|
static getAttributeTypeMap() {
|
|
@@ -16,9 +16,6 @@ import { GetDeviceBrowserStats } from './getDeviceBrowserStats';
|
|
|
16
16
|
import { GetStatsByDevice } from './getStatsByDevice';
|
|
17
17
|
|
|
18
18
|
export class GetExtendedCampaignStats {
|
|
19
|
-
/**
|
|
20
|
-
* Overall statistics of the campaign
|
|
21
|
-
*/
|
|
22
19
|
'globalStats': GetCampaignStats;
|
|
23
20
|
/**
|
|
24
21
|
* List-wise statistics of the campaign.
|
|
@@ -12,7 +12,6 @@
|
|
|
12
12
|
|
|
13
13
|
import { RequestFile } from './models';
|
|
14
14
|
import { OrderBilling } from './orderBilling';
|
|
15
|
-
import { OrderIdentifiers } from './orderIdentifiers';
|
|
16
15
|
import { OrderProductsInner } from './orderProductsInner';
|
|
17
16
|
|
|
18
17
|
export class GetOrdersOrdersInner {
|
|
@@ -36,22 +35,17 @@ export class GetOrdersOrdersInner {
|
|
|
36
35
|
* Total amount of the order, including all shipping expenses, tax and the price of items.
|
|
37
36
|
*/
|
|
38
37
|
'amount': number;
|
|
38
|
+
'products': Array<OrderProductsInner>;
|
|
39
39
|
/**
|
|
40
|
-
*
|
|
40
|
+
* Email of the contact, Mandatory if \"phone\" field is not passed in \"billing\" parameter.
|
|
41
41
|
*/
|
|
42
|
-
'
|
|
43
|
-
'identifiers'?: OrderIdentifiers;
|
|
44
|
-
'products': Array<OrderProductsInner>;
|
|
42
|
+
'email'?: string;
|
|
45
43
|
'billing'?: OrderBilling;
|
|
46
44
|
/**
|
|
47
45
|
* Coupons applied to the order. Stored case insensitive.
|
|
48
46
|
*/
|
|
49
47
|
'coupons'?: Array<string>;
|
|
50
48
|
/**
|
|
51
|
-
* Meta data of order to store additional detal such as custom message, customer type, source.
|
|
52
|
-
*/
|
|
53
|
-
'metaInfo'?: { [key: string]: object; };
|
|
54
|
-
/**
|
|
55
49
|
* Contact ID for the order
|
|
56
50
|
*/
|
|
57
51
|
'contactId'?: number;
|
|
@@ -84,21 +78,16 @@ export class GetOrdersOrdersInner {
|
|
|
84
78
|
"baseName": "amount",
|
|
85
79
|
"type": "number"
|
|
86
80
|
},
|
|
87
|
-
{
|
|
88
|
-
"name": "storeId",
|
|
89
|
-
"baseName": "storeId",
|
|
90
|
-
"type": "string"
|
|
91
|
-
},
|
|
92
|
-
{
|
|
93
|
-
"name": "identifiers",
|
|
94
|
-
"baseName": "identifiers",
|
|
95
|
-
"type": "OrderIdentifiers"
|
|
96
|
-
},
|
|
97
81
|
{
|
|
98
82
|
"name": "products",
|
|
99
83
|
"baseName": "products",
|
|
100
84
|
"type": "Array<OrderProductsInner>"
|
|
101
85
|
},
|
|
86
|
+
{
|
|
87
|
+
"name": "email",
|
|
88
|
+
"baseName": "email",
|
|
89
|
+
"type": "string"
|
|
90
|
+
},
|
|
102
91
|
{
|
|
103
92
|
"name": "billing",
|
|
104
93
|
"baseName": "billing",
|
|
@@ -109,11 +98,6 @@ export class GetOrdersOrdersInner {
|
|
|
109
98
|
"baseName": "coupons",
|
|
110
99
|
"type": "Array<string>"
|
|
111
100
|
},
|
|
112
|
-
{
|
|
113
|
-
"name": "metaInfo",
|
|
114
|
-
"baseName": "metaInfo",
|
|
115
|
-
"type": "{ [key: string]: object; }"
|
|
116
|
-
},
|
|
117
101
|
{
|
|
118
102
|
"name": "contactId",
|
|
119
103
|
"baseName": "contact_id",
|
package/model/getSegments.ts
CHANGED
|
@@ -11,10 +11,10 @@
|
|
|
11
11
|
*/
|
|
12
12
|
|
|
13
13
|
import { RequestFile } from './models';
|
|
14
|
-
import {
|
|
14
|
+
import { GetSegmentsSegments } from './getSegmentsSegments';
|
|
15
15
|
|
|
16
16
|
export class GetSegments {
|
|
17
|
-
'segments'?:
|
|
17
|
+
'segments'?: GetSegmentsSegments;
|
|
18
18
|
/**
|
|
19
19
|
* Number of Segments available in your account
|
|
20
20
|
*/
|
|
@@ -26,7 +26,7 @@ export class GetSegments {
|
|
|
26
26
|
{
|
|
27
27
|
"name": "segments",
|
|
28
28
|
"baseName": "segments",
|
|
29
|
-
"type": "
|
|
29
|
+
"type": "GetSegmentsSegments"
|
|
30
30
|
},
|
|
31
31
|
{
|
|
32
32
|
"name": "count",
|
package/model/getSmsCampaign.ts
CHANGED
|
@@ -11,6 +11,8 @@
|
|
|
11
11
|
*/
|
|
12
12
|
|
|
13
13
|
import { RequestFile } from './models';
|
|
14
|
+
import { GetCampaignRecipients } from './getCampaignRecipients';
|
|
15
|
+
import { GetSmsCampaignStats } from './getSmsCampaignStats';
|
|
14
16
|
|
|
15
17
|
export class GetSmsCampaign {
|
|
16
18
|
/**
|
|
@@ -45,8 +47,8 @@ export class GetSmsCampaign {
|
|
|
45
47
|
* UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)
|
|
46
48
|
*/
|
|
47
49
|
'modifiedAt': string;
|
|
48
|
-
'recipients':
|
|
49
|
-
'statistics':
|
|
50
|
+
'recipients': GetCampaignRecipients;
|
|
51
|
+
'statistics': GetSmsCampaignStats;
|
|
50
52
|
|
|
51
53
|
static discriminator: string | undefined = undefined;
|
|
52
54
|
|
|
@@ -94,12 +96,12 @@ export class GetSmsCampaign {
|
|
|
94
96
|
{
|
|
95
97
|
"name": "recipients",
|
|
96
98
|
"baseName": "recipients",
|
|
97
|
-
"type": "
|
|
99
|
+
"type": "GetCampaignRecipients"
|
|
98
100
|
},
|
|
99
101
|
{
|
|
100
102
|
"name": "statistics",
|
|
101
103
|
"baseName": "statistics",
|
|
102
|
-
"type": "
|
|
104
|
+
"type": "GetSmsCampaignStats"
|
|
103
105
|
} ];
|
|
104
106
|
|
|
105
107
|
static getAttributeTypeMap() {
|