@zernio/node 0.2.953 → 0.2.955
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +22 -0
- package/dist/index.d.mts +607 -25
- package/dist/index.d.ts +607 -25
- package/dist/index.js +138 -1
- package/dist/index.mjs +138 -1
- package/package.json +1 -1
- package/src/client.ts +48 -0
- package/src/generated/sdk.gen.ts +222 -1
- package/src/generated/types.gen.ts +645 -24
|
@@ -2042,6 +2042,180 @@ export type BlueskyPlatformData = {
|
|
|
2042
2042
|
}>;
|
|
2043
2043
|
};
|
|
2044
2044
|
|
|
2045
|
+
export type BrandedCallingAddress = {
|
|
2046
|
+
streetAddress: string;
|
|
2047
|
+
extendedAddress?: string;
|
|
2048
|
+
city: string;
|
|
2049
|
+
/**
|
|
2050
|
+
* State or province code (IL, ON).
|
|
2051
|
+
*/
|
|
2052
|
+
administrativeArea: string;
|
|
2053
|
+
postalCode: string;
|
|
2054
|
+
/**
|
|
2055
|
+
* ISO 3166-1 alpha-2 (US or CA).
|
|
2056
|
+
*/
|
|
2057
|
+
country: string;
|
|
2058
|
+
};
|
|
2059
|
+
|
|
2060
|
+
export type BrandedCallingContact = {
|
|
2061
|
+
firstName: string;
|
|
2062
|
+
lastName: string;
|
|
2063
|
+
email: string;
|
|
2064
|
+
/**
|
|
2065
|
+
* Required on organizationContact.
|
|
2066
|
+
*/
|
|
2067
|
+
jobTitle?: string;
|
|
2068
|
+
/**
|
|
2069
|
+
* E.164 with a leading +.
|
|
2070
|
+
*/
|
|
2071
|
+
phoneNumber: string;
|
|
2072
|
+
};
|
|
2073
|
+
|
|
2074
|
+
export type BrandedCallingEnterprise = {
|
|
2075
|
+
id?: string;
|
|
2076
|
+
legalName?: string;
|
|
2077
|
+
doingBusinessAs?: string;
|
|
2078
|
+
organizationType?: 'commercial' | 'government' | 'non_profit';
|
|
2079
|
+
organizationLegalType?: 'corporation' | 'llc' | 'partnership' | 'nonprofit' | 'other';
|
|
2080
|
+
countryCode?: 'US' | 'CA';
|
|
2081
|
+
jurisdictionOfIncorporation?: string;
|
|
2082
|
+
website?: string;
|
|
2083
|
+
/**
|
|
2084
|
+
* Last four digits of the tax id; the full id is never returned.
|
|
2085
|
+
*/
|
|
2086
|
+
feinLast4?: string;
|
|
2087
|
+
industry?: string;
|
|
2088
|
+
numberOfEmployees?: '1-10' | '11-50' | '51-200' | '201-500' | '501-2000' | '2001-10000' | '10001+';
|
|
2089
|
+
organizationContact?: BrandedCallingContact;
|
|
2090
|
+
billingContact?: BrandedCallingContact;
|
|
2091
|
+
physicalAddress?: BrandedCallingAddress;
|
|
2092
|
+
billingAddress?: BrandedCallingAddress;
|
|
2093
|
+
/**
|
|
2094
|
+
* True once the business exists at the carrier (happens when its first identity passes review).
|
|
2095
|
+
*/
|
|
2096
|
+
registered?: boolean;
|
|
2097
|
+
createdAt?: (string) | null;
|
|
2098
|
+
};
|
|
2099
|
+
|
|
2100
|
+
export type organizationType = 'commercial' | 'government' | 'non_profit';
|
|
2101
|
+
|
|
2102
|
+
export type organizationLegalType = 'corporation' | 'llc' | 'partnership' | 'nonprofit' | 'other';
|
|
2103
|
+
|
|
2104
|
+
export type countryCode = 'US' | 'CA';
|
|
2105
|
+
|
|
2106
|
+
export type numberOfEmployees = '1-10' | '11-50' | '51-200' | '201-500' | '501-2000' | '2001-10000' | '10001+';
|
|
2107
|
+
|
|
2108
|
+
export type BrandedCallingIdentity = {
|
|
2109
|
+
id?: string;
|
|
2110
|
+
enterpriseId?: string;
|
|
2111
|
+
displayName?: string;
|
|
2112
|
+
callReasons?: Array<(string)>;
|
|
2113
|
+
/**
|
|
2114
|
+
* Every call reason matches the carrier catalogue (GET /v1/branded-calling/call-reasons); anything else is vetted by hand and takes longer.
|
|
2115
|
+
*/
|
|
2116
|
+
callReasonsPreApproved?: boolean;
|
|
2117
|
+
/**
|
|
2118
|
+
* The image you sent. Zernio hosts the 256x256 BMP the carriers require.
|
|
2119
|
+
*/
|
|
2120
|
+
logoUrl?: (string) | null;
|
|
2121
|
+
authorizer?: {
|
|
2122
|
+
name?: string;
|
|
2123
|
+
email?: string;
|
|
2124
|
+
};
|
|
2125
|
+
references?: BrandedCallingReferences;
|
|
2126
|
+
/**
|
|
2127
|
+
* requested = in Zernio review; changes_requested = answer the review (PATCH); pending_email_verification = confirm the code emailed to the authorizer; in_review = with the carrier vetting team; verified = attach numbers; rejected = fix and PATCH to resubmit; suspended = an infringement claim is open; expired = the yearly verification lapsed; permanently_rejected = terminal.
|
|
2128
|
+
*/
|
|
2129
|
+
status?: 'requested' | 'changes_requested' | 'rejected' | 'pending_email_verification' | 'in_review' | 'verified' | 'suspended' | 'expired' | 'permanently_rejected';
|
|
2130
|
+
rejectionReasons?: Array<{
|
|
2131
|
+
code?: string;
|
|
2132
|
+
title?: string;
|
|
2133
|
+
detail?: string;
|
|
2134
|
+
/**
|
|
2135
|
+
* Free-text note from the vetting team, on the first entry only.
|
|
2136
|
+
*/
|
|
2137
|
+
message?: (string) | null;
|
|
2138
|
+
}>;
|
|
2139
|
+
/**
|
|
2140
|
+
* The open change request, as text.
|
|
2141
|
+
*/
|
|
2142
|
+
reviewNote?: (string) | null;
|
|
2143
|
+
/**
|
|
2144
|
+
* The open change request as points; answer each by id in reviewAnswers on PATCH.
|
|
2145
|
+
*/
|
|
2146
|
+
reviewRequest?: {
|
|
2147
|
+
id?: string;
|
|
2148
|
+
intro?: string;
|
|
2149
|
+
points?: Array<{
|
|
2150
|
+
id?: string;
|
|
2151
|
+
title?: string;
|
|
2152
|
+
detail?: string;
|
|
2153
|
+
answer?: 'text' | 'link' | 'file' | 'link_or_file';
|
|
2154
|
+
}>;
|
|
2155
|
+
} | null;
|
|
2156
|
+
emailVerifiedAt?: (string) | null;
|
|
2157
|
+
submittedAt?: (string) | null;
|
|
2158
|
+
verifiedAt?: (string) | null;
|
|
2159
|
+
/**
|
|
2160
|
+
* Verification lasts one year; Zernio resubmits 30 days before this date.
|
|
2161
|
+
*/
|
|
2162
|
+
expiringAt?: (string) | null;
|
|
2163
|
+
numbers?: Array<BrandedCallingIdentityNumber>;
|
|
2164
|
+
createdAt?: (string) | null;
|
|
2165
|
+
updatedAt?: (string) | null;
|
|
2166
|
+
};
|
|
2167
|
+
|
|
2168
|
+
/**
|
|
2169
|
+
* requested = in Zernio review; changes_requested = answer the review (PATCH); pending_email_verification = confirm the code emailed to the authorizer; in_review = with the carrier vetting team; verified = attach numbers; rejected = fix and PATCH to resubmit; suspended = an infringement claim is open; expired = the yearly verification lapsed; permanently_rejected = terminal.
|
|
2170
|
+
*/
|
|
2171
|
+
export type status4 = 'requested' | 'changes_requested' | 'rejected' | 'pending_email_verification' | 'in_review' | 'verified' | 'suspended' | 'expired' | 'permanently_rejected';
|
|
2172
|
+
|
|
2173
|
+
export type BrandedCallingIdentityNumber = {
|
|
2174
|
+
phoneNumberId?: string;
|
|
2175
|
+
phoneNumber?: string;
|
|
2176
|
+
/**
|
|
2177
|
+
* verified = the identity shows on calls from this number. permanently_rejected cannot be attached again anywhere.
|
|
2178
|
+
*/
|
|
2179
|
+
status?: 'submitted' | 'in_review' | 'verified' | 'unsuccessful' | 'suspended' | 'expired' | 'permanently_rejected';
|
|
2180
|
+
rejectionReason?: {
|
|
2181
|
+
code?: string;
|
|
2182
|
+
title?: string;
|
|
2183
|
+
detail?: string;
|
|
2184
|
+
message?: (string) | null;
|
|
2185
|
+
} | null;
|
|
2186
|
+
verifiedAt?: (string) | null;
|
|
2187
|
+
addedAt?: (string) | null;
|
|
2188
|
+
};
|
|
2189
|
+
|
|
2190
|
+
/**
|
|
2191
|
+
* verified = the identity shows on calls from this number. permanently_rejected cannot be attached again anywhere.
|
|
2192
|
+
*/
|
|
2193
|
+
export type status5 = 'submitted' | 'in_review' | 'verified' | 'unsuccessful' | 'suspended' | 'expired' | 'permanently_rejected';
|
|
2194
|
+
|
|
2195
|
+
/**
|
|
2196
|
+
* A person the carrier vetting team phones to confirm the business. Business references are senior contacts at a vendor, partner or client; the financial reference is a CPA or a bank contact. Calls are placed in the reference's local 8am-9pm window.
|
|
2197
|
+
*/
|
|
2198
|
+
export type BrandedCallingReference = {
|
|
2199
|
+
fullName: string;
|
|
2200
|
+
jobTitle?: string;
|
|
2201
|
+
organization?: string;
|
|
2202
|
+
relationshipToRegistrant?: string;
|
|
2203
|
+
/**
|
|
2204
|
+
* E.164 with a leading +.
|
|
2205
|
+
*/
|
|
2206
|
+
phoneNumber: string;
|
|
2207
|
+
email: string;
|
|
2208
|
+
/**
|
|
2209
|
+
* IANA timezone id, e.g. America/New_York.
|
|
2210
|
+
*/
|
|
2211
|
+
timezone: string;
|
|
2212
|
+
};
|
|
2213
|
+
|
|
2214
|
+
export type BrandedCallingReferences = {
|
|
2215
|
+
business: Array<BrandedCallingReference>;
|
|
2216
|
+
financial: BrandedCallingReference;
|
|
2217
|
+
};
|
|
2218
|
+
|
|
2045
2219
|
/**
|
|
2046
2220
|
* Result of a CSV bulk upload. The same shape is returned for `200` (all rows
|
|
2047
2221
|
* succeeded or all failed) and `207` (mixed). Per-row outcomes live in `results`;
|
|
@@ -2248,7 +2422,7 @@ export type BusinessAgentEventStatus = {
|
|
|
2248
2422
|
updated_at: string;
|
|
2249
2423
|
};
|
|
2250
2424
|
|
|
2251
|
-
export type
|
|
2425
|
+
export type status6 = 'request_received' | 'processing' | 'sent' | 'failed' | 'skipped' | 'success';
|
|
2252
2426
|
|
|
2253
2427
|
export type BusinessAgentFaq = BusinessAgentFaqInput & {
|
|
2254
2428
|
id: string;
|
|
@@ -2345,7 +2519,7 @@ export type BusinessAgentSkill = BusinessAgentSkillInput & {
|
|
|
2345
2519
|
/**
|
|
2346
2520
|
* pending_review right after a write; blocked means Meta content review rejected it and the agent never applies it.
|
|
2347
2521
|
*/
|
|
2348
|
-
export type
|
|
2522
|
+
export type status7 = 'active' | 'pending_review' | 'blocked';
|
|
2349
2523
|
|
|
2350
2524
|
export type BusinessAgentSkillInput = {
|
|
2351
2525
|
/**
|
|
@@ -2447,7 +2621,7 @@ export type BusinessAgentUiSkillInput = {
|
|
|
2447
2621
|
|
|
2448
2622
|
export type component_type = 'carousel_quick_reply' | 'carousel_url' | 'cta_url' | 'flow' | 'image' | 'interactive_list' | 'interactive_reply_buttons' | 'location' | 'location_request';
|
|
2449
2623
|
|
|
2450
|
-
export type
|
|
2624
|
+
export type status8 = 'enabled' | 'disabled';
|
|
2451
2625
|
|
|
2452
2626
|
export type BusinessAgentWebsite = BusinessAgentWebsiteInput & {
|
|
2453
2627
|
id: string;
|
|
@@ -2638,7 +2812,7 @@ export type channel = 'whatsapp' | 'pstn';
|
|
|
2638
2812
|
|
|
2639
2813
|
export type direction = 'inbound' | 'outbound';
|
|
2640
2814
|
|
|
2641
|
-
export type
|
|
2815
|
+
export type status9 = 'ringing' | 'answered' | 'ended' | 'failed';
|
|
2642
2816
|
|
|
2643
2817
|
/**
|
|
2644
2818
|
* Caller ID presented on the forwarded leg.
|
|
@@ -3022,7 +3196,7 @@ export type ConversionDestination = {
|
|
|
3022
3196
|
* For LinkedIn, `inactive` means the rule is soft-deleted (`enabled: false`).
|
|
3023
3197
|
*
|
|
3024
3198
|
*/
|
|
3025
|
-
export type
|
|
3199
|
+
export type status10 = 'active' | 'inactive';
|
|
3026
3200
|
|
|
3027
3201
|
/**
|
|
3028
3202
|
* A single conversion event to relay to the ad platform. All PII fields
|
|
@@ -3701,7 +3875,7 @@ export type objective = 'OUTCOME_ENGAGEMENT' | 'OUTCOME_SALES' | 'OUTCOME_LEADS'
|
|
|
3701
3875
|
* newly created ad(s) after Meta accepts them.
|
|
3702
3876
|
*
|
|
3703
3877
|
*/
|
|
3704
|
-
export type
|
|
3878
|
+
export type status11 = 'ACTIVE' | 'PAUSED';
|
|
3705
3879
|
|
|
3706
3880
|
/**
|
|
3707
3881
|
* Campaign-level status, same semantics as `POST /v1/ads/create`. Defaults
|
|
@@ -4069,7 +4243,7 @@ export type privacy_level = 2;
|
|
|
4069
4243
|
/**
|
|
4070
4244
|
* 1=SCHEDULED, 2=ACTIVE, 3=COMPLETED, 4=CANCELED
|
|
4071
4245
|
*/
|
|
4072
|
-
export type
|
|
4246
|
+
export type status12 = 1 | 2 | 3 | 4;
|
|
4073
4247
|
|
|
4074
4248
|
/**
|
|
4075
4249
|
* 1=STAGE_INSTANCE, 2=VOICE, 3=EXTERNAL
|
|
@@ -4597,7 +4771,7 @@ export type FeedbackReceipt = {
|
|
|
4597
4771
|
duplicate?: boolean;
|
|
4598
4772
|
};
|
|
4599
4773
|
|
|
4600
|
-
export type
|
|
4774
|
+
export type status13 = 'received';
|
|
4601
4775
|
|
|
4602
4776
|
export type FollowerStatsResponse = {
|
|
4603
4777
|
accounts?: Array<AccountWithFollowerStats>;
|
|
@@ -4722,7 +4896,7 @@ export type GoogleAdLabel = {
|
|
|
4722
4896
|
description?: (string) | null;
|
|
4723
4897
|
};
|
|
4724
4898
|
|
|
4725
|
-
export type
|
|
4899
|
+
export type status14 = 'ENABLED' | 'REMOVED' | 'UNKNOWN';
|
|
4726
4900
|
|
|
4727
4901
|
/**
|
|
4728
4902
|
* At least one id across the four target lists. Up to 1000 ids per list.
|
|
@@ -4820,7 +4994,7 @@ export type GoogleAdsManagerLink = {
|
|
|
4820
4994
|
/**
|
|
4821
4995
|
* Status the link has after this call.
|
|
4822
4996
|
*/
|
|
4823
|
-
export type
|
|
4997
|
+
export type status15 = 'PENDING' | 'ACTIVE' | 'REFUSED' | 'CANCELED' | 'INACTIVE';
|
|
4824
4998
|
|
|
4825
4999
|
/**
|
|
4826
5000
|
* Link one asset to the asset group. Send exactly one of asset (an existing asset), text, imageUrl or youtubeVideoId (new content, created in the same request).
|
|
@@ -5487,6 +5661,62 @@ export type GooglePmaxAssetGroupUpdate = {
|
|
|
5487
5661
|
youtubeVideoIds?: Array<(string)>;
|
|
5488
5662
|
};
|
|
5489
5663
|
|
|
5664
|
+
export type GoogleRecommendation = {
|
|
5665
|
+
/**
|
|
5666
|
+
* customers/{customerId}/recommendations/{id}. Pass it to apply or dismiss.
|
|
5667
|
+
*/
|
|
5668
|
+
resourceName: string;
|
|
5669
|
+
id: string;
|
|
5670
|
+
/**
|
|
5671
|
+
* Google RecommendationType, such as CAMPAIGN_BUDGET, KEYWORD or SET_TARGET_CPA.
|
|
5672
|
+
*/
|
|
5673
|
+
type: string;
|
|
5674
|
+
dismissed: boolean;
|
|
5675
|
+
campaignId: (string) | null;
|
|
5676
|
+
/**
|
|
5677
|
+
* Every campaign the recommendation targets (several for account-level types).
|
|
5678
|
+
*/
|
|
5679
|
+
campaignIds: Array<(string)>;
|
|
5680
|
+
adGroupId: (string) | null;
|
|
5681
|
+
campaignBudgetId: (string) | null;
|
|
5682
|
+
/**
|
|
5683
|
+
* Google's estimate over its own window. Null when Google gives none for the type.
|
|
5684
|
+
*/
|
|
5685
|
+
impact: {
|
|
5686
|
+
base?: GoogleRecommendationMetrics;
|
|
5687
|
+
potential?: GoogleRecommendationMetrics;
|
|
5688
|
+
} | null;
|
|
5689
|
+
/**
|
|
5690
|
+
* The type-specific recommendation payload exactly as Google returns it (camelCase, amounts in micros), for example recommendedTargetCpaMicros or budgetOptions.
|
|
5691
|
+
*/
|
|
5692
|
+
details: {
|
|
5693
|
+
[key: string]: unknown;
|
|
5694
|
+
} | null;
|
|
5695
|
+
};
|
|
5696
|
+
|
|
5697
|
+
export type GoogleRecommendationMetrics = {
|
|
5698
|
+
impressions?: number;
|
|
5699
|
+
clicks?: number;
|
|
5700
|
+
/**
|
|
5701
|
+
* Account currency units.
|
|
5702
|
+
*/
|
|
5703
|
+
cost?: number;
|
|
5704
|
+
conversions?: number;
|
|
5705
|
+
conversionsValue?: number;
|
|
5706
|
+
videoViews?: number;
|
|
5707
|
+
};
|
|
5708
|
+
|
|
5709
|
+
export type GoogleRecommendationResult = {
|
|
5710
|
+
resourceName: string;
|
|
5711
|
+
status: 'applied' | 'dismissed' | 'failed';
|
|
5712
|
+
/**
|
|
5713
|
+
* Google's message when status is failed.
|
|
5714
|
+
*/
|
|
5715
|
+
error?: string;
|
|
5716
|
+
};
|
|
5717
|
+
|
|
5718
|
+
export type status16 = 'applied' | 'dismissed' | 'failed';
|
|
5719
|
+
|
|
5490
5720
|
export type GoogleRsaDescription = {
|
|
5491
5721
|
text: string;
|
|
5492
5722
|
/**
|
|
@@ -5617,7 +5847,7 @@ export type kind = 'phone' | 'email';
|
|
|
5617
5847
|
|
|
5618
5848
|
export type region = 'US' | 'GB';
|
|
5619
5849
|
|
|
5620
|
-
export type
|
|
5850
|
+
export type status17 = 'ordering' | 'activating' | 'active' | 'suspended' | 'canceled' | 'failed';
|
|
5621
5851
|
|
|
5622
5852
|
/**
|
|
5623
5853
|
* Attachment snapshot inside an edit-history entry.
|
|
@@ -5689,7 +5919,7 @@ export type InboxWebhookConversation = {
|
|
|
5689
5919
|
contactId?: string;
|
|
5690
5920
|
};
|
|
5691
5921
|
|
|
5692
|
-
export type
|
|
5922
|
+
export type status18 = 'active' | 'archived';
|
|
5693
5923
|
|
|
5694
5924
|
/**
|
|
5695
5925
|
* The conversation object included in conversation lifecycle webhook payloads (conversation.started, conversation.control_changed).
|
|
@@ -7276,7 +7506,7 @@ export type OwnedPhoneNumber = {
|
|
|
7276
7506
|
}>;
|
|
7277
7507
|
};
|
|
7278
7508
|
|
|
7279
|
-
export type
|
|
7509
|
+
export type status19 = 'pending_payment' | 'pending_regulatory' | 'regulatory_declined' | 'provisioning' | 'verifying' | 'active' | 'suspended' | 'releasing' | 'released';
|
|
7280
7510
|
|
|
7281
7511
|
export type metaVerificationStatus = 'pending' | 'code_requested' | 'verified' | 'expired';
|
|
7282
7512
|
|
|
@@ -7401,7 +7631,7 @@ export type PlatformAnalytics = {
|
|
|
7401
7631
|
errorMessage?: (string) | null;
|
|
7402
7632
|
};
|
|
7403
7633
|
|
|
7404
|
-
export type
|
|
7634
|
+
export type status20 = 'published' | 'failed';
|
|
7405
7635
|
|
|
7406
7636
|
/**
|
|
7407
7637
|
* Sync state of analytics for this platform
|
|
@@ -7803,7 +8033,7 @@ export type Product = {
|
|
|
7803
8033
|
|
|
7804
8034
|
export type platform8 = 'shopify';
|
|
7805
8035
|
|
|
7806
|
-
export type
|
|
8036
|
+
export type status21 = 'active' | 'draft' | 'archived';
|
|
7807
8037
|
|
|
7808
8038
|
export type ProductImage = {
|
|
7809
8039
|
url?: string;
|
|
@@ -9079,7 +9309,7 @@ export type UploadTokenResponse = {
|
|
|
9079
9309
|
status?: 'pending' | 'completed' | 'expired';
|
|
9080
9310
|
};
|
|
9081
9311
|
|
|
9082
|
-
export type
|
|
9312
|
+
export type status22 = 'pending' | 'completed' | 'expired';
|
|
9083
9313
|
|
|
9084
9314
|
export type UploadTokenStatusResponse = {
|
|
9085
9315
|
token?: string;
|
|
@@ -9578,7 +9808,7 @@ export type Verification = {
|
|
|
9578
9808
|
resend?: boolean;
|
|
9579
9809
|
};
|
|
9580
9810
|
|
|
9581
|
-
export type
|
|
9811
|
+
export type status23 = 'pending' | 'approved' | 'expired' | 'max_attempts_reached' | 'canceled' | 'delivery_failed';
|
|
9582
9812
|
|
|
9583
9813
|
export type channel4 = 'sms';
|
|
9584
9814
|
|
|
@@ -9727,7 +9957,7 @@ export type WebhookLog = {
|
|
|
9727
9957
|
/**
|
|
9728
9958
|
* Delivery outcome
|
|
9729
9959
|
*/
|
|
9730
|
-
export type
|
|
9960
|
+
export type status24 = 'success' | 'failed';
|
|
9731
9961
|
|
|
9732
9962
|
/**
|
|
9733
9963
|
* Webhook payload for `account.ads.initial_sync_completed` events.
|
|
@@ -9839,7 +10069,7 @@ export type event = 'account.ads.initial_sync_completed';
|
|
|
9839
10069
|
/**
|
|
9840
10070
|
* Overall outcome of the initial sync.
|
|
9841
10071
|
*/
|
|
9842
|
-
export type
|
|
10072
|
+
export type status25 = 'success' | 'failure';
|
|
9843
10073
|
|
|
9844
10074
|
/**
|
|
9845
10075
|
* Stable category for UX branching. New values may be added; existing ones are
|
|
@@ -11871,7 +12101,7 @@ export type event24 = 'post.platform.published' | 'post.platform.failed' | 'post
|
|
|
11871
12101
|
/**
|
|
11872
12102
|
* Terminal status this event fires on. Matches the event suffix.
|
|
11873
12103
|
*/
|
|
11874
|
-
export type
|
|
12104
|
+
export type status26 = 'published' | 'failed' | 'deleted';
|
|
11875
12105
|
|
|
11876
12106
|
/**
|
|
11877
12107
|
* Webhook payload for reaction received events (WhatsApp, Telegram, Slack, Instagram, Facebook Messenger, TikTok)
|
|
@@ -12137,7 +12367,7 @@ export type platform15 = 'whatsapp';
|
|
|
12137
12367
|
/**
|
|
12138
12368
|
* Normalized from Meta's `decision` (REJECTED -> DECLINED, DEFERRED -> PENDING_REVIEW; the review is still open on DEFERRED, not a rejection).
|
|
12139
12369
|
*/
|
|
12140
|
-
export type
|
|
12370
|
+
export type status27 = 'APPROVED' | 'DECLINED' | 'PENDING_REVIEW';
|
|
12141
12371
|
|
|
12142
12372
|
/**
|
|
12143
12373
|
* Webhook payload for the `whatsapp.template.category_updated` event.
|
|
@@ -12286,7 +12516,7 @@ export type event32 = 'whatsapp.template.status_updated';
|
|
|
12286
12516
|
* request before the template is actually removed.
|
|
12287
12517
|
*
|
|
12288
12518
|
*/
|
|
12289
|
-
export type
|
|
12519
|
+
export type status28 = 'APPROVED' | 'REJECTED' | 'PENDING' | 'PAUSED' | 'DISABLED' | 'IN_APPEAL' | 'PENDING_DELETION';
|
|
12290
12520
|
|
|
12291
12521
|
export type WhatsAppBodyComponent = {
|
|
12292
12522
|
type: 'body';
|
|
@@ -12440,7 +12670,7 @@ export type WhatsAppSandboxSession = {
|
|
|
12440
12670
|
* list responses.
|
|
12441
12671
|
*
|
|
12442
12672
|
*/
|
|
12443
|
-
export type
|
|
12673
|
+
export type status29 = 'pending' | 'active';
|
|
12444
12674
|
|
|
12445
12675
|
export type WhatsAppTemplateButton = {
|
|
12446
12676
|
type: 'quick_reply' | 'url' | 'phone_number' | 'otp' | 'copy_code' | 'flow' | 'mpm' | 'catalog';
|
|
@@ -12598,7 +12828,7 @@ export type WorkflowExecutionEvent = {
|
|
|
12598
12828
|
|
|
12599
12829
|
export type action2 = 'execution_started' | 'execution_completed' | 'execution_exited' | 'execution_paused' | 'execution_resumed' | 'node_started' | 'node_completed' | 'node_failed' | 'node_skipped';
|
|
12600
12830
|
|
|
12601
|
-
export type
|
|
12831
|
+
export type status30 = 'success' | 'failed' | 'pending';
|
|
12602
12832
|
|
|
12603
12833
|
/**
|
|
12604
12834
|
* A node in a workflow graph. `config` shape depends on `type`.
|
|
@@ -28434,6 +28664,300 @@ export type DeleteSmsSenderIdError = (ErrorResponse | {
|
|
|
28434
28664
|
error?: string;
|
|
28435
28665
|
} | unknown);
|
|
28436
28666
|
|
|
28667
|
+
export type CreateBrandedCallingEnterpriseData = {
|
|
28668
|
+
body: {
|
|
28669
|
+
/**
|
|
28670
|
+
* Exactly as on the tax record.
|
|
28671
|
+
*/
|
|
28672
|
+
legalName: string;
|
|
28673
|
+
doingBusinessAs: string;
|
|
28674
|
+
organizationType: 'commercial' | 'government' | 'non_profit';
|
|
28675
|
+
organizationLegalType: 'corporation' | 'llc' | 'partnership' | 'nonprofit' | 'other';
|
|
28676
|
+
/**
|
|
28677
|
+
* ISO 3166-1 alpha-2. US or CA.
|
|
28678
|
+
*/
|
|
28679
|
+
countryCode: string;
|
|
28680
|
+
/**
|
|
28681
|
+
* State, province or country of registration.
|
|
28682
|
+
*/
|
|
28683
|
+
jurisdictionOfIncorporation: string;
|
|
28684
|
+
website: string;
|
|
28685
|
+
/**
|
|
28686
|
+
* US Federal Employer Identification Number (NN-NNNNNNN) or the Canadian equivalent. Stored encrypted; only the last four digits are ever returned.
|
|
28687
|
+
*/
|
|
28688
|
+
fein: string;
|
|
28689
|
+
/**
|
|
28690
|
+
* One of the carrier industry labels, e.g. technology, healthcare, retail, finance, legal, insurance, real estate, logistics, education.
|
|
28691
|
+
*/
|
|
28692
|
+
industry: string;
|
|
28693
|
+
numberOfEmployees: '1-10' | '11-50' | '51-200' | '201-500' | '501-2000' | '2001-10000' | '10001+';
|
|
28694
|
+
organizationContact: BrandedCallingContact;
|
|
28695
|
+
billingContact: BrandedCallingContact;
|
|
28696
|
+
physicalAddress: BrandedCallingAddress;
|
|
28697
|
+
billingAddress: BrandedCallingAddress;
|
|
28698
|
+
};
|
|
28699
|
+
};
|
|
28700
|
+
|
|
28701
|
+
export type CreateBrandedCallingEnterpriseResponse = (BrandedCallingEnterprise);
|
|
28702
|
+
|
|
28703
|
+
export type CreateBrandedCallingEnterpriseError = (ErrorResponse | {
|
|
28704
|
+
error?: string;
|
|
28705
|
+
} | unknown);
|
|
28706
|
+
|
|
28707
|
+
export type ListBrandedCallingEnterprisesResponse = ({
|
|
28708
|
+
enterprises?: Array<BrandedCallingEnterprise>;
|
|
28709
|
+
});
|
|
28710
|
+
|
|
28711
|
+
export type ListBrandedCallingEnterprisesError = ({
|
|
28712
|
+
error?: string;
|
|
28713
|
+
});
|
|
28714
|
+
|
|
28715
|
+
export type GetBrandedCallingEnterpriseData = {
|
|
28716
|
+
path: {
|
|
28717
|
+
id: string;
|
|
28718
|
+
};
|
|
28719
|
+
};
|
|
28720
|
+
|
|
28721
|
+
export type GetBrandedCallingEnterpriseResponse = (BrandedCallingEnterprise);
|
|
28722
|
+
|
|
28723
|
+
export type GetBrandedCallingEnterpriseError = (ErrorResponse | {
|
|
28724
|
+
error?: string;
|
|
28725
|
+
} | unknown);
|
|
28726
|
+
|
|
28727
|
+
export type DeleteBrandedCallingEnterpriseData = {
|
|
28728
|
+
path: {
|
|
28729
|
+
id: string;
|
|
28730
|
+
};
|
|
28731
|
+
};
|
|
28732
|
+
|
|
28733
|
+
export type DeleteBrandedCallingEnterpriseResponse = ({
|
|
28734
|
+
status?: 'deleted';
|
|
28735
|
+
});
|
|
28736
|
+
|
|
28737
|
+
export type DeleteBrandedCallingEnterpriseError = (ErrorResponse | {
|
|
28738
|
+
error?: string;
|
|
28739
|
+
} | unknown);
|
|
28740
|
+
|
|
28741
|
+
export type ListBrandedCallingCallReasonsResponse = ({
|
|
28742
|
+
callReasons?: Array<(string)>;
|
|
28743
|
+
});
|
|
28744
|
+
|
|
28745
|
+
export type ListBrandedCallingCallReasonsError = ({
|
|
28746
|
+
error?: string;
|
|
28747
|
+
});
|
|
28748
|
+
|
|
28749
|
+
export type CreateBrandedCallingIdentityData = {
|
|
28750
|
+
body: {
|
|
28751
|
+
/**
|
|
28752
|
+
* A business from POST /v1/branded-calling/enterprises.
|
|
28753
|
+
*/
|
|
28754
|
+
enterpriseId: string;
|
|
28755
|
+
/**
|
|
28756
|
+
* Shown on the callee's screen. No emoji.
|
|
28757
|
+
*/
|
|
28758
|
+
displayName: string;
|
|
28759
|
+
/**
|
|
28760
|
+
* 1 to 10 reasons you call, each up to 64 characters. Pick from GET /v1/branded-calling/call-reasons to skip manual vetting.
|
|
28761
|
+
*/
|
|
28762
|
+
callReasons: Array<(string)>;
|
|
28763
|
+
/**
|
|
28764
|
+
* HTTPS URL of a PNG, JPEG, WebP or SVG logo. Zernio converts it to the 256x256 BMP the carriers require and hosts it.
|
|
28765
|
+
*/
|
|
28766
|
+
logoUrl?: string;
|
|
28767
|
+
authorizer: {
|
|
28768
|
+
/**
|
|
28769
|
+
* A real person at the business who authorizes the registration.
|
|
28770
|
+
*/
|
|
28771
|
+
name: string;
|
|
28772
|
+
/**
|
|
28773
|
+
* The carrier emails a 6-digit code here once the identity passes review.
|
|
28774
|
+
*/
|
|
28775
|
+
email: string;
|
|
28776
|
+
};
|
|
28777
|
+
references: BrandedCallingReferences;
|
|
28778
|
+
};
|
|
28779
|
+
};
|
|
28780
|
+
|
|
28781
|
+
export type CreateBrandedCallingIdentityResponse = (BrandedCallingIdentity);
|
|
28782
|
+
|
|
28783
|
+
export type CreateBrandedCallingIdentityError = (ErrorResponse | {
|
|
28784
|
+
error?: string;
|
|
28785
|
+
} | unknown);
|
|
28786
|
+
|
|
28787
|
+
export type ListBrandedCallingIdentitiesResponse = ({
|
|
28788
|
+
identities?: Array<BrandedCallingIdentity>;
|
|
28789
|
+
});
|
|
28790
|
+
|
|
28791
|
+
export type ListBrandedCallingIdentitiesError = ({
|
|
28792
|
+
error?: string;
|
|
28793
|
+
});
|
|
28794
|
+
|
|
28795
|
+
export type GetBrandedCallingIdentityData = {
|
|
28796
|
+
path: {
|
|
28797
|
+
id: string;
|
|
28798
|
+
};
|
|
28799
|
+
};
|
|
28800
|
+
|
|
28801
|
+
export type GetBrandedCallingIdentityResponse = (BrandedCallingIdentity);
|
|
28802
|
+
|
|
28803
|
+
export type GetBrandedCallingIdentityError = (ErrorResponse | {
|
|
28804
|
+
error?: string;
|
|
28805
|
+
} | unknown);
|
|
28806
|
+
|
|
28807
|
+
export type UpdateBrandedCallingIdentityData = {
|
|
28808
|
+
body: {
|
|
28809
|
+
/**
|
|
28810
|
+
* Shown on the callee's screen. No emoji.
|
|
28811
|
+
*/
|
|
28812
|
+
displayName?: string;
|
|
28813
|
+
/**
|
|
28814
|
+
* 1 to 10 reasons you call, each up to 64 characters. Pick from GET /v1/branded-calling/call-reasons to skip manual vetting.
|
|
28815
|
+
*/
|
|
28816
|
+
callReasons?: Array<(string)>;
|
|
28817
|
+
/**
|
|
28818
|
+
* HTTPS URL of a PNG, JPEG, WebP or SVG logo. Zernio converts it to the 256x256 BMP the carriers require and hosts it.
|
|
28819
|
+
*/
|
|
28820
|
+
logoUrl?: string;
|
|
28821
|
+
authorizer?: {
|
|
28822
|
+
/**
|
|
28823
|
+
* A real person at the business who authorizes the registration.
|
|
28824
|
+
*/
|
|
28825
|
+
name: string;
|
|
28826
|
+
/**
|
|
28827
|
+
* The carrier emails a 6-digit code here once the identity passes review.
|
|
28828
|
+
*/
|
|
28829
|
+
email: string;
|
|
28830
|
+
};
|
|
28831
|
+
references?: BrandedCallingReferences;
|
|
28832
|
+
/**
|
|
28833
|
+
* One entry per point id of the open reviewRequest.
|
|
28834
|
+
*/
|
|
28835
|
+
reviewAnswers?: {
|
|
28836
|
+
[key: string]: {
|
|
28837
|
+
text?: string;
|
|
28838
|
+
url?: string;
|
|
28839
|
+
};
|
|
28840
|
+
};
|
|
28841
|
+
reviewNote?: string;
|
|
28842
|
+
};
|
|
28843
|
+
path: {
|
|
28844
|
+
id: string;
|
|
28845
|
+
};
|
|
28846
|
+
};
|
|
28847
|
+
|
|
28848
|
+
export type UpdateBrandedCallingIdentityResponse = (BrandedCallingIdentity);
|
|
28849
|
+
|
|
28850
|
+
export type UpdateBrandedCallingIdentityError = (ErrorResponse | {
|
|
28851
|
+
error?: string;
|
|
28852
|
+
} | unknown);
|
|
28853
|
+
|
|
28854
|
+
export type DeleteBrandedCallingIdentityData = {
|
|
28855
|
+
path: {
|
|
28856
|
+
id: string;
|
|
28857
|
+
};
|
|
28858
|
+
};
|
|
28859
|
+
|
|
28860
|
+
export type DeleteBrandedCallingIdentityResponse = ({
|
|
28861
|
+
status?: 'deleted';
|
|
28862
|
+
});
|
|
28863
|
+
|
|
28864
|
+
export type DeleteBrandedCallingIdentityError = (ErrorResponse | {
|
|
28865
|
+
error?: string;
|
|
28866
|
+
} | unknown);
|
|
28867
|
+
|
|
28868
|
+
export type ResendBrandedCallingAuthorizerCodeData = {
|
|
28869
|
+
path: {
|
|
28870
|
+
id: string;
|
|
28871
|
+
};
|
|
28872
|
+
};
|
|
28873
|
+
|
|
28874
|
+
export type ResendBrandedCallingAuthorizerCodeResponse = ({
|
|
28875
|
+
status?: 'sent';
|
|
28876
|
+
});
|
|
28877
|
+
|
|
28878
|
+
export type ResendBrandedCallingAuthorizerCodeError = (ErrorResponse | {
|
|
28879
|
+
error?: string;
|
|
28880
|
+
} | unknown);
|
|
28881
|
+
|
|
28882
|
+
export type ConfirmBrandedCallingAuthorizerEmailData = {
|
|
28883
|
+
body: {
|
|
28884
|
+
code: string;
|
|
28885
|
+
};
|
|
28886
|
+
path: {
|
|
28887
|
+
id: string;
|
|
28888
|
+
};
|
|
28889
|
+
};
|
|
28890
|
+
|
|
28891
|
+
export type ConfirmBrandedCallingAuthorizerEmailResponse = (BrandedCallingIdentity);
|
|
28892
|
+
|
|
28893
|
+
export type ConfirmBrandedCallingAuthorizerEmailError = (unknown | {
|
|
28894
|
+
error?: string;
|
|
28895
|
+
});
|
|
28896
|
+
|
|
28897
|
+
export type ListBrandedCallingIdentityNumbersData = {
|
|
28898
|
+
path: {
|
|
28899
|
+
id: string;
|
|
28900
|
+
};
|
|
28901
|
+
};
|
|
28902
|
+
|
|
28903
|
+
export type ListBrandedCallingIdentityNumbersResponse = ({
|
|
28904
|
+
numbers?: Array<BrandedCallingIdentityNumber>;
|
|
28905
|
+
});
|
|
28906
|
+
|
|
28907
|
+
export type ListBrandedCallingIdentityNumbersError = (ErrorResponse | {
|
|
28908
|
+
error?: string;
|
|
28909
|
+
} | unknown);
|
|
28910
|
+
|
|
28911
|
+
export type AttachBrandedCallingNumbersData = {
|
|
28912
|
+
body: {
|
|
28913
|
+
/**
|
|
28914
|
+
* Phone number record ids (from GET /v1/phone-numbers). Active US numbers only.
|
|
28915
|
+
*/
|
|
28916
|
+
phoneNumberIds: Array<(string)>;
|
|
28917
|
+
signature: {
|
|
28918
|
+
/**
|
|
28919
|
+
* The signer's drawn signature as a PNG, base64 (a data:image/png;base64 prefix is accepted).
|
|
28920
|
+
*/
|
|
28921
|
+
imageBase64: string;
|
|
28922
|
+
/**
|
|
28923
|
+
* Printed under the signature. Defaults to the business contact's name.
|
|
28924
|
+
*/
|
|
28925
|
+
signerName?: string;
|
|
28926
|
+
};
|
|
28927
|
+
};
|
|
28928
|
+
path: {
|
|
28929
|
+
id: string;
|
|
28930
|
+
};
|
|
28931
|
+
};
|
|
28932
|
+
|
|
28933
|
+
export type AttachBrandedCallingNumbersResponse = ({
|
|
28934
|
+
numbers?: Array<BrandedCallingIdentityNumber>;
|
|
28935
|
+
});
|
|
28936
|
+
|
|
28937
|
+
export type AttachBrandedCallingNumbersError = (ErrorResponse | {
|
|
28938
|
+
error?: string;
|
|
28939
|
+
} | unknown);
|
|
28940
|
+
|
|
28941
|
+
export type DetachBrandedCallingNumbersData = {
|
|
28942
|
+
body: {
|
|
28943
|
+
/**
|
|
28944
|
+
* E.164 numbers currently on this identity.
|
|
28945
|
+
*/
|
|
28946
|
+
phoneNumbers: Array<(string)>;
|
|
28947
|
+
};
|
|
28948
|
+
path: {
|
|
28949
|
+
id: string;
|
|
28950
|
+
};
|
|
28951
|
+
};
|
|
28952
|
+
|
|
28953
|
+
export type DetachBrandedCallingNumbersResponse = ({
|
|
28954
|
+
removed?: Array<(string)>;
|
|
28955
|
+
});
|
|
28956
|
+
|
|
28957
|
+
export type DetachBrandedCallingNumbersError = (ErrorResponse | {
|
|
28958
|
+
error?: string;
|
|
28959
|
+
} | unknown);
|
|
28960
|
+
|
|
28437
28961
|
export type StartSmsRegistrationData = {
|
|
28438
28962
|
body: {
|
|
28439
28963
|
registrationType: 'standard_10dlc' | 'sole_prop_10dlc' | 'toll_free';
|
|
@@ -35741,6 +36265,103 @@ export type GetAdsSearchTermsError = (ErrorResponse | {
|
|
|
35741
36265
|
error?: string;
|
|
35742
36266
|
} | unknown);
|
|
35743
36267
|
|
|
36268
|
+
export type ListGoogleRecommendationsData = {
|
|
36269
|
+
query: {
|
|
36270
|
+
/**
|
|
36271
|
+
* Google ads SocialAccount id.
|
|
36272
|
+
*/
|
|
36273
|
+
accountId: string;
|
|
36274
|
+
/**
|
|
36275
|
+
* Google customer id, digits only. Defaults to the connection's only customer.
|
|
36276
|
+
*/
|
|
36277
|
+
adAccountId?: string;
|
|
36278
|
+
/**
|
|
36279
|
+
* Only recommendations targeting this campaign.
|
|
36280
|
+
*/
|
|
36281
|
+
campaignId?: string;
|
|
36282
|
+
/**
|
|
36283
|
+
* Alias of adAccountId, kept for consistency with other Google endpoints.
|
|
36284
|
+
* @deprecated
|
|
36285
|
+
*/
|
|
36286
|
+
customerId?: string;
|
|
36287
|
+
/**
|
|
36288
|
+
* Comma-separated Google RecommendationType values, for example CAMPAIGN_BUDGET,KEYWORD,SET_TARGET_CPA.
|
|
36289
|
+
*/
|
|
36290
|
+
types?: string;
|
|
36291
|
+
};
|
|
36292
|
+
};
|
|
36293
|
+
|
|
36294
|
+
export type ListGoogleRecommendationsResponse = ({
|
|
36295
|
+
adAccountId: string;
|
|
36296
|
+
recommendations: Array<GoogleRecommendation>;
|
|
36297
|
+
cachedAt: (string) | null;
|
|
36298
|
+
stale: boolean;
|
|
36299
|
+
});
|
|
36300
|
+
|
|
36301
|
+
export type ListGoogleRecommendationsError = (ErrorResponse | {
|
|
36302
|
+
error?: string;
|
|
36303
|
+
} | unknown);
|
|
36304
|
+
|
|
36305
|
+
export type ApplyGoogleRecommendationsData = {
|
|
36306
|
+
body: {
|
|
36307
|
+
/**
|
|
36308
|
+
* Google ads SocialAccount id.
|
|
36309
|
+
*/
|
|
36310
|
+
accountId: string;
|
|
36311
|
+
/**
|
|
36312
|
+
* Google customer id, digits only. Required when the connection has several customers.
|
|
36313
|
+
*/
|
|
36314
|
+
adAccountId?: string;
|
|
36315
|
+
recommendations: Array<{
|
|
36316
|
+
/**
|
|
36317
|
+
* Recommendation resource name from the list, or its id.
|
|
36318
|
+
*/
|
|
36319
|
+
resourceName: string;
|
|
36320
|
+
/**
|
|
36321
|
+
* One key, such as campaignBudget, keyword, textAd, targetCpaOptIn, targetRoasOptIn, callAsset, calloutAsset, sitelinkAsset, moveUnusedBudget, responsiveSearchAd, responsiveSearchAdAsset, responsiveSearchAdImproveAdStrength, useBroadMatchKeyword, raiseTargetCpa, lowerTargetRoas, setTargetCpa, setTargetRoas, forecastingSetTargetCpa, forecastingSetTargetRoas, leadFormAsset, raiseTargetCpaBidTooLow, raiseTargetCpaPerformanceBidTooLow, lowerTargetRoasPerformanceBidTooLow, calloutExtension, callExtension or sitelinkExtension.
|
|
36322
|
+
*/
|
|
36323
|
+
parameters?: {
|
|
36324
|
+
[key: string]: unknown;
|
|
36325
|
+
};
|
|
36326
|
+
}>;
|
|
36327
|
+
};
|
|
36328
|
+
};
|
|
36329
|
+
|
|
36330
|
+
export type ApplyGoogleRecommendationsResponse = ({
|
|
36331
|
+
adAccountId: string;
|
|
36332
|
+
results: Array<GoogleRecommendationResult>;
|
|
36333
|
+
});
|
|
36334
|
+
|
|
36335
|
+
export type ApplyGoogleRecommendationsError = (ErrorResponse | {
|
|
36336
|
+
error?: string;
|
|
36337
|
+
} | unknown);
|
|
36338
|
+
|
|
36339
|
+
export type DismissGoogleRecommendationsData = {
|
|
36340
|
+
body: {
|
|
36341
|
+
/**
|
|
36342
|
+
* Google ads SocialAccount id.
|
|
36343
|
+
*/
|
|
36344
|
+
accountId: string;
|
|
36345
|
+
/**
|
|
36346
|
+
* Google customer id, digits only. Required when the connection has several customers.
|
|
36347
|
+
*/
|
|
36348
|
+
adAccountId?: string;
|
|
36349
|
+
/**
|
|
36350
|
+
* Recommendation resource names from the list, or their ids.
|
|
36351
|
+
*/
|
|
36352
|
+
resourceNames: Array<(string)>;
|
|
36353
|
+
};
|
|
36354
|
+
};
|
|
36355
|
+
|
|
36356
|
+
export type DismissGoogleRecommendationsResponse = ({
|
|
36357
|
+
adAccountId: string;
|
|
36358
|
+
results: Array<GoogleRecommendationResult>;
|
|
36359
|
+
});
|
|
36360
|
+
|
|
36361
|
+
export type DismissGoogleRecommendationsError = (ErrorResponse | {
|
|
36362
|
+
error?: string;
|
|
36363
|
+
} | unknown);
|
|
36364
|
+
|
|
35744
36365
|
export type ListBidStrategiesData = {
|
|
35745
36366
|
query: {
|
|
35746
36367
|
/**
|