diff --git a/types/bun/package.json b/types/bun/package.json index 571a55d39646b2..20746910c65a6c 100644 --- a/types/bun/package.json +++ b/types/bun/package.json @@ -3,10 +3,10 @@ "name": "@types/bun", "version": "1.2.9999", "projects": [ - "https://bun.sh" + "https://bun.com" ], "dependencies": { - "bun-types": "1.2.21" + "bun-types": "1.2.22" }, "devDependencies": { "@types/bun": "workspace:." diff --git a/types/facebook-nodejs-business-sdk/facebook-nodejs-business-sdk-tests.ts b/types/facebook-nodejs-business-sdk/facebook-nodejs-business-sdk-tests.ts index 6c5b6d924fcde7..a7877c5b6fe822 100644 --- a/types/facebook-nodejs-business-sdk/facebook-nodejs-business-sdk-tests.ts +++ b/types/facebook-nodejs-business-sdk/facebook-nodejs-business-sdk-tests.ts @@ -15,7 +15,8 @@ import { Campaign, AdsPixel, AdCreative, - Ad + Ad, + AdCampaignStats, } from 'facebook-nodejs-business-sdk'; import { FacebookRequestError } from 'facebook-nodejs-business-sdk/src/exceptions'; import TEventRequest from "facebook-nodejs-business-sdk/src/objects/serverside/event-request"; @@ -162,3 +163,14 @@ export function testBusinessDataApiUserDataConstructor() { export function testAttributionDataConstructor() { const attributionData = new AttributionData(); } + +export function testAdCampaignStatsFields() { + AdCampaignStats.Fields.account_id; + AdCampaignStats.Fields.actions; + AdCampaignStats.Fields.adgroup_id; + AdCampaignStats.Fields.campaign_id; + AdCampaignStats.Fields.campaign_ids; + AdCampaignStats.Fields.clicks; + AdCampaignStats.Fields.end_time; + AdCampaignStats.Fields.id; +} diff --git a/types/facebook-nodejs-business-sdk/index.d.ts b/types/facebook-nodejs-business-sdk/index.d.ts index ffff1cf2dd7fa5..86b83368599ae5 100644 --- a/types/facebook-nodejs-business-sdk/index.d.ts +++ b/types/facebook-nodejs-business-sdk/index.d.ts @@ -25,11 +25,8 @@ export { default as HttpServiceClientConfig } from "./src/objects/serverside/htt export { default as HttpServiceInterface } from "./src/objects/serverside/http-service-interface"; export { default as BatchProcessor } from "./src/objects/serverside/batch-processor"; export { default as ServerSideUtils } from "./src/objects/serverside/utils"; -export { default as SignalUserData } from "./src/objects/signal/user-data"; -export { default as SignalContent } from "./src/objects/signal/content"; -export { default as SignalCustomData } from "./src/objects/signal/custom-data"; -export { default as SignalEvent } from "./src/objects/signal/event"; -export { default as SignalEventRequest } from "./src/objects/signal/event-request"; +export { default as ABTestPostTestActions } from "./src/objects/ab-test-post-test-actions"; +export { default as AIGeneratedProductImage } from "./src/objects/ai-generated-product-image"; export { default as ALMAdAccountInfo } from "./src/objects/alm-ad-account-info"; export { default as ALMEndAdvertiserInfo } from "./src/objects/alm-end-advertiser-info"; export { default as ALMEvent } from "./src/objects/alm-event"; @@ -48,6 +45,7 @@ export { default as AdAccountAdRulesCountByType } from "./src/objects/ad-account export { default as AdAccountAdRulesHistory } from "./src/objects/ad-account-ad-rules-history"; export { default as AdAccountAdVolume } from "./src/objects/ad-account-ad-volume"; export { default as AdAccountAdsRecommendedAudios } from "./src/objects/ad-account-ads-recommended-audios"; +export { default as AdAccountAgencyFeeConfig } from "./src/objects/ad-account-agency-fee-config"; export { default as AdAccountAllPaymentMethods } from "./src/objects/ad-account-all-payment-methods"; export { default as AdAccountAmountSpentHistory } from "./src/objects/ad-account-amount-spent-history"; export { default as AdAccountAppSetupRequirements } from "./src/objects/ad-account-app-setup-requirements"; @@ -80,7 +78,6 @@ export { default as AdAccountSpendCapChangeHistory } from "./src/objects/ad-acco export { default as AdAccountSpendLimit } from "./src/objects/ad-account-spend-limit"; export { default as AdAccountSubscribedApps } from "./src/objects/ad-account-subscribed-apps"; export { default as AdAccountSubsidyAmountDetails } from "./src/objects/ad-account-subsidy-amount-details"; -export { default as AdAccountSuggestedTag } from "./src/objects/ad-account-suggested-tag"; export { default as AdAccountTargetingUnified } from "./src/objects/ad-account-targeting-unified"; export { default as AdAccountTrackingData } from "./src/objects/ad-account-tracking-data"; export { default as AdAccountURLForAssetExtraction } from "./src/objects/ad-account-url-for-asset-extraction"; @@ -128,6 +125,7 @@ export { default as AdCampaignDeliveryStats } from "./src/objects/ad-campaign-de export { default as AdCampaignDeliveryStatsUnsupportedReasons } from "./src/objects/ad-campaign-delivery-stats-unsupported-reasons"; export { default as AdCampaignFrequencyControlSpecs } from "./src/objects/ad-campaign-frequency-control-specs"; export { default as AdCampaignGroupAdvantageState } from "./src/objects/ad-campaign-group-advantage-state"; +export { default as AdCampaignGroupAgencyFeeConfigForApi } from "./src/objects/ad-campaign-group-agency-fee-config-for-api"; export { default as AdCampaignGroupIncrementalConversionOptimizationConfig } from "./src/objects/ad-campaign-group-incremental-conversion-optimization-config"; export { default as AdCampaignGroupMetricsMetadata } from "./src/objects/ad-campaign-group-metrics-metadata"; export { default as AdCampaignGroupStats } from "./src/objects/ad-campaign-group-stats"; @@ -158,6 +156,7 @@ export { default as AdCreativeFeatureActionMetadata } from "./src/objects/ad-cre export { default as AdCreativeFeatureCustomizations } from "./src/objects/ad-creative-feature-customizations"; export { default as AdCreativeFeatureDetails } from "./src/objects/ad-creative-feature-details"; export { default as AdCreativeFeaturesSpec } from "./src/objects/ad-creative-features-spec"; +export { default as AdCreativeFormatTransformationSpec } from "./src/objects/ad-creative-format-transformation-spec"; export { default as AdCreativeGenerativeAssetSpec } from "./src/objects/ad-creative-generative-asset-spec"; export { default as AdCreativeHouseShopsAdsSellerContent } from "./src/objects/ad-creative-house-shops-ads-seller-content"; export { default as AdCreativeImageDataMediaElements } from "./src/objects/ad-creative-image-data-media-elements"; @@ -176,6 +175,7 @@ export { default as AdCreativeLinkDataMoment } from "./src/objects/ad-creative-l export { default as AdCreativeLinkDataSponsorshipInfoSpec } from "./src/objects/ad-creative-link-data-sponsorship-info-spec"; export { default as AdCreativeLinkDataTemplateVideoSpec } from "./src/objects/ad-creative-link-data-template-video-spec"; export { default as AdCreativeMarketingMessageStructuredSpec } from "./src/objects/ad-creative-marketing-message-structured-spec"; +export { default as AdCreativeMediaSourcingSpec } from "./src/objects/ad-creative-media-sourcing-spec"; export { default as AdCreativeObjectStorySpec } from "./src/objects/ad-creative-object-story-spec"; export { default as AdCreativeOmnichannelLinkSpec } from "./src/objects/ad-creative-omnichannel-link-spec"; export { default as AdCreativePhotoData } from "./src/objects/ad-creative-photo-data"; @@ -306,7 +306,6 @@ export { default as AdsTabular } from "./src/objects/ads-tabular"; export { default as AdsTargetingInsights } from "./src/objects/ads-targeting-insights"; export { default as AdsTextSuggestions } from "./src/objects/ads-text-suggestions"; export { default as AdsUserSettings } from "./src/objects/ads-user-settings"; -export { default as AdsValueAdjustmentRule } from "./src/objects/ads-value-adjustment-rule"; export { default as AdsValueAdjustmentRuleCollection } from "./src/objects/ads-value-adjustment-rule-collection"; export { default as AdvAInstance } from "./src/objects/adv-a-instance"; export { default as AdvertiserVerificationStatus } from "./src/objects/advertiser-verification-status"; @@ -321,6 +320,7 @@ export { default as AnalyticsQueryResult } from "./src/objects/analytics-query-r export { default as AnalyticsSegment } from "./src/objects/analytics-segment"; export { default as AnalyticsUserConfig } from "./src/objects/analytics-user-config"; export { default as AndroidAppLink } from "./src/objects/android-app-link"; +export { default as ApacMonSellerStatusAPIContainer } from "./src/objects/apac-mon-seller-status-api-container"; export { default as AppEventConfig } from "./src/objects/app-event-config"; export { default as AppLinks } from "./src/objects/app-links"; export { default as AppOptimizedCustomEvents } from "./src/objects/app-optimized-custom-events"; @@ -343,6 +343,7 @@ export { default as AudioAsset } from "./src/objects/audio-asset"; export { default as AudioCopyright } from "./src/objects/audio-copyright"; export { default as AudioIsrc } from "./src/objects/audio-isrc"; export { default as AudioRelease } from "./src/objects/audio-release"; +export { default as AudioSubLabel } from "./src/objects/audio-sub-label"; export { default as AudioVisualReferenceMatch } from "./src/objects/audio-visual-reference-match"; export { default as AuthLink } from "./src/objects/auth-link"; export { default as AutomotiveModel } from "./src/objects/automotive-model"; @@ -350,7 +351,6 @@ export { default as Avatar } from "./src/objects/avatar"; export { default as AvatarProfilePicture } from "./src/objects/avatar-profile-picture"; export { default as BAPIDomain } from "./src/objects/bapi-domain"; export { default as BCPCampaign } from "./src/objects/bcp-campaign"; -export { default as BespokePartnerGuidanceLaser } from "./src/objects/bespoke-partner-guidance-laser"; export { default as BidSchedule } from "./src/objects/bid-schedule"; export { default as BizInboxOffsiteEmailAccount } from "./src/objects/biz-inbox-offsite-email-account"; export { default as BlindPig } from "./src/objects/blind-pig"; @@ -361,6 +361,7 @@ export { default as BrandSafetyCampaignConfig } from "./src/objects/brand-safety export { default as BrandSafetyDownloadable } from "./src/objects/brand-safety-downloadable"; export { default as BrandedContentAdError } from "./src/objects/branded-content-ad-error"; export { default as BrandedContentEligibleSponsorIDs } from "./src/objects/branded-content-eligible-sponsor-i-ds"; +export { default as BrandedContentFBPromodeUser } from "./src/objects/branded-content-fb-promode-user"; export { default as BrandedContentShadowIGMediaID } from "./src/objects/branded-content-shadow-ig-media-id"; export { default as BrandedContentShadowIGUserID } from "./src/objects/branded-content-shadow-ig-user-id"; export { default as BroadTargetingCategories } from "./src/objects/broad-targeting-categories"; @@ -464,6 +465,7 @@ export { default as ConversionHealthKPI } from "./src/objects/conversion-health- export { default as CopyrightAttributionInsights } from "./src/objects/copyright-attribution-insights"; export { default as CopyrightAudioAsset } from "./src/objects/copyright-audio-asset"; export { default as CopyrightMediaMisuse } from "./src/objects/copyright-media-misuse"; +export { default as CopyrightOwnershipTransfer } from "./src/objects/copyright-ownership-transfer"; export { default as CopyrightReferenceContainer } from "./src/objects/copyright-reference-container"; export { default as CoverPhoto } from "./src/objects/cover-photo"; export { default as CreativeAssetTag } from "./src/objects/creative-asset-tag"; @@ -480,6 +482,7 @@ export { default as CustomAudienceCapabilities } from "./src/objects/custom-audi export { default as CustomAudienceDataSource } from "./src/objects/custom-audience-data-source"; export { default as CustomAudienceGroup } from "./src/objects/custom-audience-group"; export { default as CustomAudienceHealth } from "./src/objects/custom-audience-health"; +export { default as CustomAudienceIntegrityFlagsAndAppealStatus } from "./src/objects/custom-audience-integrity-flags-and-appeal-status"; export { default as CustomAudienceSalts } from "./src/objects/custom-audience-salts"; export { default as CustomAudienceSession } from "./src/objects/custom-audience-session"; export { default as CustomAudienceSharedAccountCampaignInfo } from "./src/objects/custom-audience-shared-account-campaign-info"; @@ -521,7 +524,6 @@ export { default as EventRegistrationSetting } from "./src/objects/event-registr export { default as EventSourceGroup } from "./src/objects/event-source-group"; export { default as EventTicketSetting } from "./src/objects/event-ticket-setting"; export { default as EventTicketTier } from "./src/objects/event-ticket-tier"; -export { default as EventTour } from "./src/objects/event-tour"; export { default as Experience } from "./src/objects/experience"; export { default as ExtendedCredit } from "./src/objects/extended-credit"; export { default as ExtendedCreditAllocationConfig } from "./src/objects/extended-credit-allocation-config"; @@ -578,6 +580,7 @@ export { default as IGUpcomingEvent } from "./src/objects/ig-upcoming-event"; export { default as IGUser } from "./src/objects/ig-user"; export { default as IGUserExportForCAM } from "./src/objects/ig-user-export-for-cam"; export { default as IGUserForIGOnlyAPI } from "./src/objects/ig-user-for-ig-only-api"; +export { default as IGUserMessengerProfile } from "./src/objects/ig-user-messenger-profile"; export { default as IGUserSubscribedAppsData } from "./src/objects/ig-user-subscribed-apps-data"; export { default as IGVideoCopyrightCheckMatchesInformation } from "./src/objects/ig-video-copyright-check-matches-information"; export { default as IGVideoCopyrightCheckStatus } from "./src/objects/ig-video-copyright-check-status"; @@ -587,20 +590,22 @@ export { default as ImageCopyrightDispute } from "./src/objects/image-copyright- export { default as ImageReferenceMatch } from "./src/objects/image-reference-match"; export { default as InsightsResult } from "./src/objects/insights-result"; export { default as InsightsValue } from "./src/objects/insights-value"; +export { default as InstagramBusinessAsset } from "./src/objects/instagram-business-asset"; export { default as InstagramInsightsResult } from "./src/objects/instagram-insights-result"; export { default as InstagramInsightsValue } from "./src/objects/instagram-insights-value"; export { default as InstagramRelatedProductTags } from "./src/objects/instagram-related-product-tags"; export { default as InstagramShoppingMerchantReviewMessage } from "./src/objects/instagram-shopping-merchant-review-message"; +export { default as InstagramThread } from "./src/objects/instagram-thread"; export { default as InstagramUser } from "./src/objects/instagram-user"; export { default as InstantArticleInsightsQueryResult } from "./src/objects/instant-article-insights-query-result"; export { default as IosAppLink } from "./src/objects/ios-app-link"; export { default as JobOpening } from "./src/objects/job-opening"; export { default as KeyValue } from "./src/objects/key-value"; -export { default as KeywordDeliveryReport } from "./src/objects/keyword-delivery-report"; export { default as Lead } from "./src/objects/lead"; export { default as LeadGenAppointmentBookingInfo } from "./src/objects/lead-gen-appointment-booking-info"; export { default as LeadGenAppointmentSlotsByDay } from "./src/objects/lead-gen-appointment-slots-by-day"; export { default as LeadGenAppointmentTimeSlot } from "./src/objects/lead-gen-appointment-time-slot"; +export { default as LeadGenClientValidationRules } from "./src/objects/lead-gen-client-validation-rules"; export { default as LeadGenConditionalQuestionsGroupChoices } from "./src/objects/lead-gen-conditional-questions-group-choices"; export { default as LeadGenConditionalQuestionsGroupQuestions } from "./src/objects/lead-gen-conditional-questions-group-questions"; export { default as LeadGenContextCard } from "./src/objects/lead-gen-context-card"; @@ -640,6 +645,7 @@ export { default as MIXInsightsResult } from "./src/objects/mix-insights-result" export { default as MailingAddress } from "./src/objects/mailing-address"; export { default as ManagedPartnerBusiness } from "./src/objects/managed-partner-business"; export { default as ManagedPartnerExtendedCredit } from "./src/objects/managed-partner-extended-credit"; +export { default as ManagementSiteLink } from "./src/objects/management-site-link"; export { default as McomInvoiceBankAccount } from "./src/objects/mcom-invoice-bank-account"; export { default as McomInvoiceDetails } from "./src/objects/mcom-invoice-details"; export { default as McomInvoiceLists } from "./src/objects/mcom-invoice-lists"; @@ -750,6 +756,7 @@ export { default as PrivacyOption } from "./src/objects/privacy-option"; export { default as PrivateLiftStudyInstance } from "./src/objects/private-lift-study-instance"; export { default as ProductCatalog } from "./src/objects/product-catalog"; export { default as ProductCatalogCategory } from "./src/objects/product-catalog-category"; +export { default as ProductCatalogCheckMarketplacePartnerSellersStatus } from "./src/objects/product-catalog-check-marketplace-partner-sellers-status"; export { default as ProductCatalogDataSource } from "./src/objects/product-catalog-data-source"; export { default as ProductCatalogDiagnosticGroup } from "./src/objects/product-catalog-diagnostic-group"; export { default as ProductCatalogFacets } from "./src/objects/product-catalog-facets"; @@ -790,6 +797,7 @@ export { default as ProductItemOffer } from "./src/objects/product-item-offer"; export { default as ProductItemShipping } from "./src/objects/product-item-shipping"; export { default as ProductItemSubscriptionInfo } from "./src/objects/product-item-subscription-info"; export { default as ProductItemUnitPrice } from "./src/objects/product-item-unit-price"; +export { default as ProductItemVideoData } from "./src/objects/product-item-video-data"; export { default as ProductSet } from "./src/objects/product-set"; export { default as ProductSetMetadata } from "./src/objects/product-set-metadata"; export { default as ProductSetTaxonCategory } from "./src/objects/product-set-taxon-category"; @@ -831,10 +839,10 @@ export { default as ScheduledPost } from "./src/objects/scheduled-post"; export { default as ScimCompanyUserPhoneNumber } from "./src/objects/scim-company-user-phone-number"; export { default as SecuritySettings } from "./src/objects/security-settings"; export { default as ShadowIGHashtag } from "./src/objects/shadow-ig-hashtag"; -export { default as ShadowIGMediaBoostedInsightsResult } from "./src/objects/shadow-ig-media-boosted-insights-result"; export { default as ShadowIGMediaBuilder } from "./src/objects/shadow-ig-media-builder"; export { default as ShadowIGMediaCollaborators } from "./src/objects/shadow-ig-media-collaborators"; export { default as ShadowIGMediaProductTags } from "./src/objects/shadow-ig-media-product-tags"; +export { default as ShadowIGUserCTXPartnerAppWelcomeMessageFlow } from "./src/objects/shadow-ig-user-ctx-partner-app-welcome-message-flow"; export { default as ShadowIGUserCatalogProductSearch } from "./src/objects/shadow-ig-user-catalog-product-search"; export { default as ShadowIGUserCatalogProductVariant } from "./src/objects/shadow-ig-user-catalog-product-variant"; export { default as ShadowIGUserPartnershipAdsMediaErrors } from "./src/objects/shadow-ig-user-partnership-ads-media-errors"; @@ -845,7 +853,6 @@ export { default as SiteLink } from "./src/objects/site-link"; export { default as SlicedEventSourceGroup } from "./src/objects/sliced-event-source-group"; export { default as SmartPixelInsights } from "./src/objects/smart-pixel-insights"; export { default as SocialWifiSite } from "./src/objects/social-wifi-site"; -export { default as SplitTestConfig } from "./src/objects/split-test-config"; export { default as SplitTestWinner } from "./src/objects/split-test-winner"; export { default as Status } from "./src/objects/status"; export { default as StoreCatalogSettings } from "./src/objects/store-catalog-settings"; @@ -936,6 +943,7 @@ export { default as WebAppLink } from "./src/objects/web-app-link"; export { default as WebPublisher } from "./src/objects/web-publisher"; export { default as WebsiteCreativeAssetSource } from "./src/objects/website-creative-asset-source"; export { default as WebsiteCreativeAssetSuggestions } from "./src/objects/website-creative-asset-suggestions"; +export { default as WebsiteCreativeInfo } from "./src/objects/website-creative-info"; export { default as WhatsAppBusinessAccount } from "./src/objects/whats-app-business-account"; export { default as WhatsAppBusinessHealthStatus } from "./src/objects/whats-app-business-health-status"; export { default as WhatsAppBusinessHealthStatusForMessageSend } from "./src/objects/whats-app-business-health-status-for-message-send"; diff --git a/types/facebook-nodejs-business-sdk/package.json b/types/facebook-nodejs-business-sdk/package.json index fecc918129bf7c..322558b14ac60a 100644 --- a/types/facebook-nodejs-business-sdk/package.json +++ b/types/facebook-nodejs-business-sdk/package.json @@ -1,7 +1,7 @@ { "private": true, "name": "@types/facebook-nodejs-business-sdk", - "version": "22.0.9999", + "version": "23.0.9999", "projects": [ "https://github.com/facebook/facebook-nodejs-business-sdk" ], diff --git a/types/facebook-nodejs-business-sdk/scripts/package.json b/types/facebook-nodejs-business-sdk/scripts/package.json index d682632998e841..f2728d66a2a063 100644 --- a/types/facebook-nodejs-business-sdk/scripts/package.json +++ b/types/facebook-nodejs-business-sdk/scripts/package.json @@ -5,7 +5,7 @@ }, "devDependencies": { "@khanacademy/flow-to-ts": "^0.5.2", - "facebook-nodejs-business-sdk": "^22.0.1", + "facebook-nodejs-business-sdk": "^23.0.1", "typescript": "^5.8.3" } } diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-suggested-tag.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ab-test-post-test-actions.d.ts similarity index 54% rename from types/facebook-nodejs-business-sdk/src/objects/ad-account-suggested-tag.d.ts rename to types/facebook-nodejs-business-sdk/src/objects/ab-test-post-test-actions.d.ts index 205d3653882d0a..a6f5a41fd53959 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-account-suggested-tag.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ab-test-post-test-actions.d.ts @@ -1,12 +1,10 @@ import { AbstractCrudObject } from "./../abstract-crud-object"; /** - * AdAccountSuggestedTag + * ABTestPostTestActions * @see {@link https://developers.facebook.com/docs/marketing-api/} */ -export default class AdAccountSuggestedTag extends AbstractCrudObject { +export default class ABTestPostTestActions extends AbstractCrudObject { static get Fields(): Readonly<{ - product_id: "product_id"; - x: "x"; - y: "y"; + auto_change_budget_to_winner: "auto_change_budget_to_winner"; }>; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-ad-rules-history.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-ad-rules-history.d.ts index 8dcc1af810f445..cd5d11d00cc889 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-account-ad-rules-history.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-ad-rules-history.d.ts @@ -24,6 +24,7 @@ export default class AdAccountAdRulesHistory extends AbstractCrudObject { convert_asc_cp_single_instance: "CONVERT_ASC_CP_SINGLE_INSTANCE"; email: "EMAIL"; enable_advantage_campaign_budget: "ENABLE_ADVANTAGE_CAMPAIGN_BUDGET"; + enable_advantage_plus_audience: "ENABLE_ADVANTAGE_PLUS_AUDIENCE"; enable_advantage_plus_creative: "ENABLE_ADVANTAGE_PLUS_CREATIVE"; enable_advantage_plus_placements: "ENABLE_ADVANTAGE_PLUS_PLACEMENTS"; enable_autoflow: "ENABLE_AUTOFLOW"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-ad-volume.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-ad-volume.d.ts index 5870c4dc415bb2..abd332a4b3e0ab 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-account-ad-volume.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-ad-volume.d.ts @@ -26,7 +26,7 @@ export default class AdAccountAdVolume extends AbstractCrudObject { account_spend_limit: "ACCOUNT_SPEND_LIMIT"; account_spend_limit_duplication: "ACCOUNT_SPEND_LIMIT_DUPLICATION"; aco_toggle: "ACO_TOGGLE"; - adopt_capi_gateway_from_test_drive: "ADOPT_CAPI_GATEWAY_FROM_TEST_DRIVE"; + adset_budget_sharing: "ADSET_BUDGET_SHARING"; ads_reporting: "ADS_REPORTING"; ads_status: "ADS_STATUS"; advanced_campaign_budget: "ADVANCED_CAMPAIGN_BUDGET"; @@ -60,12 +60,19 @@ export default class AdAccountAdVolume extends AbstractCrudObject { ad_lift_recall_goal_precreate: "AD_LIFT_RECALL_GOAL_PRECREATE"; ad_lift_recall_optimization_goal: "AD_LIFT_RECALL_OPTIMIZATION_GOAL"; ad_objective: "AD_OBJECTIVE"; + ad_set_budget_sharing_guidance: "AD_SET_BUDGET_SHARING_GUIDANCE"; aem_v2_ineligible: "AEM_V2_INELIGIBLE"; aggregated_bid_limited: "AGGREGATED_BID_LIMITED"; aggregated_budget_limited: "AGGREGATED_BUDGET_LIMITED"; aggregated_cost_limited: "AGGREGATED_COST_LIMITED"; + aplusc_add_overlays: "APLUSC_ADD_OVERLAYS"; + aplusc_dynamic_description: "APLUSC_DYNAMIC_DESCRIPTION"; + aplusc_image_background_generation: "APLUSC_IMAGE_BACKGROUND_GENERATION"; aplusc_music: "APLUSC_MUSIC"; + aplusc_relevant_comments: "APLUSC_RELEVANT_COMMENTS"; + aplusc_standard_enhancements_bundle: "APLUSC_STANDARD_ENHANCEMENTS_BUNDLE"; aplusc_text_improvements: "APLUSC_TEXT_IMPROVEMENTS"; + aplusc_visual_touchups: "APLUSC_VISUAL_TOUCHUPS"; aplus_c_catalog_duplication: "APLUS_C_CATALOG_DUPLICATION"; app_aem_v2_installation_promotion: "APP_AEM_V2_INSTALLATION_PROMOTION"; app_engaged_view_conversions_duplication: "APP_ENGAGED_VIEW_CONVERSIONS_DUPLICATION"; @@ -83,6 +90,7 @@ export default class AdAccountAdVolume extends AbstractCrudObject { audience_expansion_lookalike: "AUDIENCE_EXPANSION_LOOKALIKE"; audience_expansion_retargeting: "AUDIENCE_EXPANSION_RETARGETING"; audience_learning_limited: "AUDIENCE_LEARNING_LIMITED"; + autobid_to_manual_bid: "AUTOBID_TO_MANUAL_BID"; autoflow_opt_in: "AUTOFLOW_OPT_IN"; autoflow_opt_in_fallback_duplication_flow: "AUTOFLOW_OPT_IN_FALLBACK_DUPLICATION_FLOW"; autoflow_opt_in_v2: "AUTOFLOW_OPT_IN_V2"; @@ -91,14 +99,19 @@ export default class AdAccountAdVolume extends AbstractCrudObject { auto_bid: "AUTO_BID"; auto_cat_selection_enhancement: "AUTO_CAT_SELECTION_ENHANCEMENT"; background_generation: "BACKGROUND_GENERATION"; + bid_limited_sensitive: "BID_LIMITED_SENSITIVE"; + bid_limited_starving: "BID_LIMITED_STARVING"; blended_ads: "BLENDED_ADS"; blended_ads_duplication: "BLENDED_ADS_DUPLICATION"; blended_ads_for_shops_ads_duplication: "BLENDED_ADS_FOR_SHOPS_ADS_DUPLICATION"; bpbaa_with_capi_upsell: "BPBAA_WITH_CAPI_UPSELL"; broadgeo_am_upsell_guidance: "BROADGEO_AM_UPSELL_GUIDANCE"; broad_targeting: "BROAD_TARGETING"; + budget_amortization: "BUDGET_AMORTIZATION"; budget_limited: "BUDGET_LIMITED"; budget_reallocation: "BUDGET_REALLOCATION"; + call_ads_dayparting_l3_recommendation: "CALL_ADS_DAYPARTING_L3_RECOMMENDATION"; + campaign_guidance_navigator_reels_tips: "CAMPAIGN_GUIDANCE_NAVIGATOR_REELS_TIPS"; capi: "CAPI"; capi_crm_funnel: "CAPI_CRM_FUNNEL"; capi_crm_guidance: "CAPI_CRM_GUIDANCE"; @@ -108,6 +121,7 @@ export default class AdAccountAdVolume extends AbstractCrudObject { capi_performance_match_key: "CAPI_PERFORMANCE_MATCH_KEY"; capi_performance_match_key_v2: "CAPI_PERFORMANCE_MATCH_KEY_V2"; cash_rewards_opt_in: "CASH_REWARDS_OPT_IN"; + catalog_dynamic_media: "CATALOG_DYNAMIC_MEDIA"; catalog_match_rate: "CATALOG_MATCH_RATE"; commerce_shops_ads_duplication: "COMMERCE_SHOPS_ADS_DUPLICATION"; connected_sources: "CONNECTED_SOURCES"; @@ -135,16 +149,21 @@ export default class AdAccountAdVolume extends AbstractCrudObject { creative_limited_hourly: "CREATIVE_LIMITED_HOURLY"; creator_ads_pa_conversion: "CREATOR_ADS_PA_CONVERSION"; cta: "CTA"; + ctm_ad_objective_growth: "CTM_AD_OBJECTIVE_GROWTH"; + ctm_leads_optimization_upsell: "CTM_LEADS_OPTIMIZATION_UPSELL"; ctx_budget_optimization: "CTX_BUDGET_OPTIMIZATION"; ctx_creation_package: "CTX_CREATION_PACKAGE"; ctx_cta_upgrade_in_duplication: "CTX_CTA_UPGRADE_IN_DUPLICATION"; ctx_ctmpo_upgrade: "CTX_CTMPO_UPGRADE"; + ctx_ctwapo_upgrade: "CTX_CTWAPO_UPGRADE"; ctx_guidance: "CTX_GUIDANCE"; ctx_hvs: "CTX_HVS"; ctx_multi_message_destination: "CTX_MULTI_MESSAGE_DESTINATION"; ctx_precreate: "CTX_PRECREATE"; + ctx_product_extension_duplication: "CTX_PRODUCT_EXTENSION_DUPLICATION"; ctx_sabr_cbo: "CTX_SABR_CBO"; ctx_sabr_non_cbo: "CTX_SABR_NON_CBO"; + ctx_smart_defaulting: "CTX_SMART_DEFAULTING"; ctx_zo_cbo: "CTX_ZO_CBO"; ctx_zo_non_cbo: "CTX_ZO_NON_CBO"; custom_audience_relaxation: "CUSTOM_AUDIENCE_RELAXATION"; @@ -158,6 +177,7 @@ export default class AdAccountAdVolume extends AbstractCrudObject { delivery_warning: "DELIVERY_WARNING"; dynamic_advantage_campaign_budget: "DYNAMIC_ADVANTAGE_CAMPAIGN_BUDGET"; ecosystem_bid_reduce_l1_cardinality: "ECOSYSTEM_BID_REDUCE_L1_CARDINALITY"; + enable_whats_app_ads_data_sharing: "ENABLE_WHATS_APP_ADS_DATA_SHARING"; engaged_view_conversions_creation: "ENGAGED_VIEW_CONVERSIONS_CREATION"; evc_app_duplication_upgrade: "EVC_APP_DUPLICATION_UPGRADE"; evc_web_duplication_upgrade: "EVC_WEB_DUPLICATION_UPGRADE"; @@ -171,8 +191,11 @@ export default class AdAccountAdVolume extends AbstractCrudObject { heuristic_default_duration: "HEURISTIC_DEFAULT_DURATION"; high_cost: "HIGH_COST"; historical_benchmark: "HISTORICAL_BENCHMARK"; + iaa_roas_optimization: "IAA_ROAS_OPTIMIZATION"; ig_multi_ads: "IG_MULTI_ADS"; ig_surfaces_manual_placements: "IG_SURFACES_MANUAL_PLACEMENTS"; + incremental_attribution: "INCREMENTAL_ATTRIBUTION"; + instant_forms_leads: "INSTANT_FORMS_LEADS"; landing_page_view: "LANDING_PAGE_VIEW"; landing_page_view_optimization_goal: "LANDING_PAGE_VIEW_OPTIMIZATION_GOAL"; landing_page_view_precreate: "LANDING_PAGE_VIEW_PRECREATE"; @@ -205,9 +228,11 @@ export default class AdAccountAdVolume extends AbstractCrudObject { optimal_bau: "OPTIMAL_BAU"; outcome_forecaster_budget_recommendation: "OUTCOME_FORECASTER_BUDGET_RECOMMENDATION"; outcome_forecaster_shadow_logging: "OUTCOME_FORECASTER_SHADOW_LOGGING"; + partnership_ads: "PARTNERSHIP_ADS"; payment_method: "PAYMENT_METHOD"; performant_creative_reels_opt_in: "PERFORMANT_CREATIVE_REELS_OPT_IN"; pfr_l1_inline_mmt: "PFR_L1_INLINE_MMT"; + pixelless_lpv_optimization_goal: "PIXELLESS_LPV_OPTIMIZATION_GOAL"; pixel_optimization_aam: "PIXEL_OPTIMIZATION_AAM"; pixel_optimization_aam_precreate: "PIXEL_OPTIMIZATION_AAM_PRECREATE"; pixel_optimization_hie: "PIXEL_OPTIMIZATION_HIE"; @@ -220,6 +245,7 @@ export default class AdAccountAdVolume extends AbstractCrudObject { predictive_creative_limited_hourly: "PREDICTIVE_CREATIVE_LIMITED_HOURLY"; preparing_status: "PREPARING_STATUS"; product_set_boosting: "PRODUCT_SET_BOOSTING"; + promo_ads_upsell_guidance: "PROMO_ADS_UPSELL_GUIDANCE"; purchase_optimization: "PURCHASE_OPTIMIZATION"; rapid_learning_limited: "RAPID_LEARNING_LIMITED"; rapid_learning_phase: "RAPID_LEARNING_PHASE"; @@ -232,18 +258,22 @@ export default class AdAccountAdVolume extends AbstractCrudObject { reels_performant_creative: "REELS_PERFORMANT_CREATIVE"; reels_placement: "REELS_PLACEMENT"; revert: "REVERT"; + review_creative_duplicated_rejected_ads: "REVIEW_CREATIVE_DUPLICATED_REJECTED_ADS"; sabr_default_duration: "SABR_DEFAULT_DURATION"; sales_conversion: "SALES_CONVERSION"; saved_audience: "SAVED_AUDIENCE"; scale_good_campaign: "SCALE_GOOD_CAMPAIGN"; scale_good_campaign_duplication: "SCALE_GOOD_CAMPAIGN_DUPLICATION"; scale_good_campaign_smb: "SCALE_GOOD_CAMPAIGN_SMB"; + scale_good_campaign_v2_duplication: "SCALE_GOOD_CAMPAIGN_V2_DUPLICATION"; scale_good_ctx_campaign: "SCALE_GOOD_CTX_CAMPAIGN"; + seasonal_campaigns: "SEASONAL_CAMPAIGNS"; semantic_based_audience_duplication: "SEMANTIC_BASED_AUDIENCE_DUPLICATION"; semantic_based_audience_expansion: "SEMANTIC_BASED_AUDIENCE_EXPANSION"; setup_pixel: "SETUP_PIXEL"; shops_ads: "SHOPS_ADS"; shops_ads_duplication: "SHOPS_ADS_DUPLICATION"; + shops_ads_saoff: "SHOPS_ADS_SAOFF"; shops_ads_traffic_cap_settings: "SHOPS_ADS_TRAFFIC_CAP_SETTINGS"; shop_ads_v2: "SHOP_ADS_V2"; signals_down_funnel_event_optimization: "SIGNALS_DOWN_FUNNEL_EVENT_OPTIMIZATION"; @@ -260,6 +290,7 @@ export default class AdAccountAdVolume extends AbstractCrudObject { tailored_lead_ad_campaign: "TAILORED_LEAD_AD_CAMPAIGN"; tailored_messages_campaign: "TAILORED_MESSAGES_CAMPAIGN"; targeting_creative_fragmentation: "TARGETING_CREATIVE_FRAGMENTATION"; + threeco_web_plus_app_upsell: "THREECO_WEB_PLUS_APP_UPSELL"; tla_creation_package: "TLA_CREATION_PACKAGE"; top_adsets_with_ads_under_cap: "TOP_ADSETS_WITH_ADS_UNDER_CAP"; top_campaigns_with_ads_under_cap: "TOP_CAMPAIGNS_WITH_ADS_UNDER_CAP"; @@ -273,6 +304,7 @@ export default class AdAccountAdVolume extends AbstractCrudObject { unused_budget: "UNUSED_BUDGET"; value_diagnostics_guidance: "VALUE_DIAGNOSTICS_GUIDANCE"; value_optimization_goal: "VALUE_OPTIMIZATION_GOAL"; + value_rules_guidance: "VALUE_RULES_GUIDANCE"; video_length: "VIDEO_LENGTH"; video_views_upsell: "VIDEO_VIEWS_UPSELL"; video_views_upsell_precreate: "VIDEO_VIEWS_UPSELL_PRECREATE"; @@ -280,6 +312,8 @@ export default class AdAccountAdVolume extends AbstractCrudObject { wa_messaging_partners: "WA_MESSAGING_PARTNERS"; wa_messaging_partners_precreate: "WA_MESSAGING_PARTNERS_PRECREATE"; web_engaged_view_conversions: "WEB_ENGAGED_VIEW_CONVERSIONS"; + wtwa_upsell_in_duplication: "WTWA_UPSELL_IN_DUPLICATION"; + wtwa_upsell_in_syd_and_am_table: "WTWA_UPSELL_IN_SYD_AND_AM_TABLE"; zero_conversion: "ZERO_CONVERSION"; zero_impression: "ZERO_IMPRESSION"; zero_outcome_budget: "ZERO_OUTCOME_BUDGET"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-agency-fee-config.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-agency-fee-config.d.ts new file mode 100644 index 00000000000000..6cd2c3976459bd --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-agency-fee-config.d.ts @@ -0,0 +1,21 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdAccountAgencyFeeConfig + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdAccountAgencyFeeConfig extends AbstractCrudObject { + static get Fields(): Readonly<{ + can_add_agency_fee_to_invoice: "can_add_agency_fee_to_invoice"; + default_agency_fee_pct: "default_agency_fee_pct"; + id: "id"; + is_agency_fee_disabled: "is_agency_fee_disabled"; + status: "status"; + }>; + static get Status(): Readonly<{ + active: "ACTIVE"; + archived: "ARCHIVED"; + draft: "DRAFT"; + unknown: "UNKNOWN"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-delivery-estimate.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-delivery-estimate.d.ts index ab64e54a1bcf46..8bcbc6d291e5eb 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-account-delivery-estimate.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-delivery-estimate.d.ts @@ -17,6 +17,7 @@ export default class AdAccountDeliveryEstimate extends AbstractCrudObject { ad_recall_lift: "AD_RECALL_LIFT"; app_installs: "APP_INSTALLS"; app_installs_and_offsite_conversions: "APP_INSTALLS_AND_OFFSITE_CONVERSIONS"; + automatic_objective: "AUTOMATIC_OBJECTIVE"; conversations: "CONVERSATIONS"; derived_events: "DERIVED_EVENTS"; engaged_users: "ENGAGED_USERS"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-optimization-goals-aemv2-eligibility.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-optimization-goals-aemv2-eligibility.d.ts index 6c0239569efb9a..506909a064a34c 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-account-optimization-goals-aemv2-eligibility.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-optimization-goals-aemv2-eligibility.d.ts @@ -13,6 +13,7 @@ export default class AdAccountOptimizationGoalsAEMv2Eligibility extends Abstract ad_recall_lift: "AD_RECALL_LIFT"; app_installs: "APP_INSTALLS"; app_installs_and_offsite_conversions: "APP_INSTALLS_AND_OFFSITE_CONVERSIONS"; + automatic_objective: "AUTOMATIC_OBJECTIVE"; conversations: "CONVERSATIONS"; derived_events: "DERIVED_EVENTS"; engaged_users: "ENGAGED_USERS"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-targeting-unified.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-targeting-unified.d.ts index 86800179b1fc40..ca1113aaeb9f6e 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-account-targeting-unified.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-targeting-unified.d.ts @@ -67,6 +67,7 @@ export default class AdAccountTargetingUnified extends AbstractCrudObject { online_gambling_and_gaming: "ONLINE_GAMBLING_AND_GAMING"; }>; static get RegulatedCountries(): Readonly<{ + ac: "AC"; ad: "AD"; ae: "AE"; af: "AF"; @@ -398,6 +399,7 @@ export default class AdAccountTargetingUnified extends AbstractCrudObject { industries: "industries"; instagram_hashtags: "instagram_hashtags"; instagram_positions: "instagram_positions"; + install_state_application: "install_state_application"; instream_video_skippable_excluded: "instream_video_skippable_excluded"; instream_video_sponsorship_placements: "instream_video_sponsorship_placements"; interest_defaults_source: "interest_defaults_source"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-user-settings.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-user-settings.d.ts index 5e4ea29474d3e5..9328e6a18f166d 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-account-user-settings.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-user-settings.d.ts @@ -11,6 +11,7 @@ export default class AdAccountUserSettings extends AbstractCrudObject { active_ads_quick_view_created: "active_ads_quick_view_created"; ad_account: "ad_account"; ad_object_export_format: "ad_object_export_format"; + ads_manager_footer_row_toast_impressions: "ads_manager_footer_row_toast_impressions"; auto_review_video_caption: "auto_review_video_caption"; campaign_overview_columns: "campaign_overview_columns"; column_suggestion_status: "column_suggestion_status"; @@ -30,7 +31,9 @@ export default class AdAccountUserSettings extends AbstractCrudObject { has_seen_leads_column_flexing_experience: "has_seen_leads_column_flexing_experience"; has_seen_shops_ads_metrics_onboarding_tour: "has_seen_shops_ads_metrics_onboarding_tour"; has_seen_shops_column_flexing_experience: "has_seen_shops_column_flexing_experience"; + has_used_quick_views_panel: "has_used_quick_views_panel"; hidden_optimization_tips: "hidden_optimization_tips"; + high_performing_quick_view_created: "high_performing_quick_view_created"; id: "id"; is_3p_auth_setting_set: "is_3p_auth_setting_set"; is_ads_manager_footer_row_preference_set: "is_ads_manager_footer_row_preference_set"; @@ -44,6 +47,7 @@ export default class AdAccountUserSettings extends AbstractCrudObject { rb_export_format: "rb_export_format"; rb_export_raw_data: "rb_export_raw_data"; rb_export_summary_row: "rb_export_summary_row"; + recently_used_quick_views: "recently_used_quick_views"; saip_advertiser_setup_optimisation_guidance_overall_state: "saip_advertiser_setup_optimisation_guidance_overall_state"; saip_advertiser_setup_optimisation_guidance_state: "saip_advertiser_setup_optimisation_guidance_state"; shops_ads_metrics_onboarding_tour_close_count: "shops_ads_metrics_onboarding_tour_close_count"; @@ -65,6 +69,8 @@ export default class AdAccountUserSettings extends AbstractCrudObject { syd_campaign_trends_objective: "syd_campaign_trends_objective"; syd_campaign_trends_time_range: "syd_campaign_trends_time_range"; syd_landing_page_opt_in_status: "syd_landing_page_opt_in_status"; + text_gen_persona_opt_in_type: "text_gen_persona_opt_in_type"; + text_variations_opt_in_out_ts: "text_variations_opt_in_out_ts"; text_variations_opt_in_type: "text_variations_opt_in_type"; user: "user"; }>; diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account.d.ts index 35b18af9d74745..faa1e53988348c 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-account.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account.d.ts @@ -1,5 +1,4 @@ import { AbstractCrudObject } from "./../abstract-crud-object"; -import AbstractObject from "./../abstract-object"; import Cursor from "./../cursor"; import AdAccountBusinessConstraints from "./ad-account-business-constraints"; import AdPlacePageSet from "./ad-place-page-set"; @@ -204,7 +203,6 @@ export default class AdAccount extends AbstractCrudObject { generic: "GENERIC"; home_listing: "HOME_LISTING"; hotel: "HOTEL"; - job: "JOB"; local_service_business: "LOCAL_SERVICE_BUSINESS"; media_title: "MEDIA_TITLE"; offline_product: "OFFLINE_PRODUCT"; @@ -284,6 +282,8 @@ export default class AdAccount extends AbstractCrudObject { createAssignedUser(fields: string[], params?: Record, pathOverride?: string | null): Promise; createAsyncBatchRequest(fields: string[], params?: Record, pathOverride?: string | null): Promise; getAsyncRequests(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getAsyncAdCreatives(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createAsyncAdCreative(fields: string[], params?: Record, pathOverride?: string | null): Promise; getAsyncAdRequestSets(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; createAsyncAdRequestSet(fields: string[], params?: Record, pathOverride?: string | null): Promise; getAudienceFunnel(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; @@ -298,7 +298,6 @@ export default class AdAccount extends AbstractCrudObject { getConnectedInstagramAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getConnectedInstagramAccountsWithIabp(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getConversionGoals(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getCpaGuidance(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getCustomAudiences(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; createCustomAudience(fields: string[], params?: Record, pathOverride?: string | null): Promise; getCustomAudiencesTos(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; @@ -314,7 +313,6 @@ export default class AdAccount extends AbstractCrudObject { getInsightsAsync(fields: string[], params?: Record, pathOverride?: string | null): Promise; getInstagramAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getIosFourteenCampaignLimits(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createManagedPartnerAd(fields: string[], params?: Record, pathOverride?: string | null): Promise; getMatchedSearchApplications(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getMaxBid(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getMcmeConversions(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; @@ -333,7 +331,6 @@ export default class AdAccount extends AbstractCrudObject { deleteSubscribedApps(params?: Record): Promise; getSubscribedApps(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; createSubscribedApp(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getSuggestedProductTags(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getTargetingBrowse(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getTargetingSearch(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getTargetingSentenceLines(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; @@ -343,7 +340,6 @@ export default class AdAccount extends AbstractCrudObject { createTracking(fields: string[], params?: Record, pathOverride?: string | null): Promise; getUsers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; deleteUsersOfAnyAudience(params?: Record): Promise; - getValueAdjustmentRules(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getValueRuleSet(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; createValueRuleSet(fields: string[], params?: Record, pathOverride?: string | null): Promise; getVideoAds(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-activity.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-activity.d.ts index 542d24e92453b5..c1a352916d0562 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-activity.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-activity.d.ts @@ -19,6 +19,7 @@ export default class AdActivity extends AbstractCrudObject { translated_event_type: "translated_event_type"; }>; static get EventType(): Readonly<{ + accept_custom_audience_appeal: "accept_custom_audience_appeal"; account_spending_limit_reached: "account_spending_limit_reached"; ad_account_add_user_to_role: "ad_account_add_user_to_role"; ad_account_billing_charge: "ad_account_billing_charge"; @@ -39,15 +40,19 @@ export default class AdActivity extends AbstractCrudObject { adaccount_update_audience_segment: "adaccount_update_audience_segment"; add_funding_source: "add_funding_source"; add_images: "add_images"; + apply_restrictions_custom_audience: "apply_restrictions_custom_audience"; billing_event: "billing_event"; campaign_ended: "campaign_ended"; campaign_spending_limit_reached: "campaign_spending_limit_reached"; conversion_event_updated: "conversion_event_updated"; create_ad: "create_ad"; create_ad_set: "create_ad_set"; + create_adaccount_agency_fee: "create_adaccount_agency_fee"; create_audience: "create_audience"; create_campaign_group: "create_campaign_group"; + create_campaign_group_agency_fee: "create_campaign_group_agency_fee"; create_campaign_legacy: "create_campaign_legacy"; + create_custom_audience_appeal: "create_custom_audience_appeal"; delete_audience: "delete_audience"; delete_images: "delete_images"; di_ad_set_learning_stage_exit: "di_ad_set_learning_stage_exit"; @@ -59,6 +64,7 @@ export default class AdActivity extends AbstractCrudObject { lifetime_budget_spent: "lifetime_budget_spent"; merge_campaigns: "merge_campaigns"; receive_audience: "receive_audience"; + reject_custom_audience_appeal: "reject_custom_audience_appeal"; remove_funding_source: "remove_funding_source"; remove_shared_audience: "remove_shared_audience"; share_audience: "share_audience"; @@ -85,6 +91,7 @@ export default class AdActivity extends AbstractCrudObject { update_ad_set_spend_cap: "update_ad_set_spend_cap"; update_ad_set_target_spec: "update_ad_set_target_spec"; update_ad_targets_spec: "update_ad_targets_spec"; + update_adaccount_agency_fee: "update_adaccount_agency_fee"; update_adgroup_stop_delivery: "update_adgroup_stop_delivery"; update_audience: "update_audience"; update_campaign_ad_scheduling: "update_campaign_ad_scheduling"; @@ -95,6 +102,7 @@ export default class AdActivity extends AbstractCrudObject { update_campaign_delivery_destination: "update_campaign_delivery_destination"; update_campaign_delivery_type: "update_campaign_delivery_type"; update_campaign_group_ad_scheduling: "update_campaign_group_ad_scheduling"; + update_campaign_group_agency_fee: "update_campaign_group_agency_fee"; update_campaign_group_budget_scheduling_state: "update_campaign_group_budget_scheduling_state"; update_campaign_group_delivery_type: "update_campaign_group_delivery_type"; update_campaign_group_high_demand_periods: "update_campaign_group_high_demand_periods"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec.d.ts index 71cc0bb563df4d..33d08b60888c56 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec.d.ts @@ -30,6 +30,7 @@ export default class AdAssetFeedSpec extends AbstractCrudObject { reasons_to_shop: "reasons_to_shop"; shops_bundle: "shops_bundle"; titles: "titles"; + translations: "translations"; upcoming_events: "upcoming_events"; videos: "videos"; }>; @@ -115,6 +116,7 @@ export default class AdAssetFeedSpec extends AbstractCrudObject { video_call: "VIDEO_CALL"; view_cart: "VIEW_CART"; view_channel: "VIEW_CHANNEL"; + view_in_cart: "VIEW_IN_CART"; view_product: "VIEW_PRODUCT"; visit_pages_feed: "VISIT_PAGES_FEED"; watch_live_video: "WATCH_LIVE_VIDEO"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-asset-onsite-destinations.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-onsite-destinations.d.ts index 5eefd258d957d5..ed8534358d8c57 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-asset-onsite-destinations.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-onsite-destinations.d.ts @@ -8,6 +8,7 @@ export default class AdAssetOnsiteDestinations extends AbstractCrudObject { auto_optimization: "auto_optimization"; details_page_product_id: "details_page_product_id"; shop_collection_product_set_id: "shop_collection_product_set_id"; + source: "source"; storefront_shop_id: "storefront_shop_id"; }>; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-asset-target-rule-targeting.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-target-rule-targeting.d.ts index cc55ca1c4e70ad..8eddd66ce47a3d 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-asset-target-rule-targeting.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-target-rule-targeting.d.ts @@ -13,6 +13,7 @@ export default class AdAssetTargetRuleTargeting extends AbstractCrudObject { geo_locations: "geo_locations"; instagram_positions: "instagram_positions"; publisher_platforms: "publisher_platforms"; + threads_positions: "threads_positions"; }>; static get DevicePlatforms(): Readonly<{ desktop: "desktop"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-delivery-estimate.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-delivery-estimate.d.ts index 6d75c6fd02fb6e..73ff2e2ee10def 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-delivery-estimate.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-delivery-estimate.d.ts @@ -17,6 +17,7 @@ export default class AdCampaignDeliveryEstimate extends AbstractCrudObject { ad_recall_lift: "AD_RECALL_LIFT"; app_installs: "APP_INSTALLS"; app_installs_and_offsite_conversions: "APP_INSTALLS_AND_OFFSITE_CONVERSIONS"; + automatic_objective: "AUTOMATIC_OBJECTIVE"; conversations: "CONVERSATIONS"; derived_events: "DERIVED_EVENTS"; engaged_users: "ENGAGED_USERS"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-group-agency-fee-config-for-api.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-group-agency-fee-config-for-api.d.ts new file mode 100644 index 00000000000000..4269dd4b90eec0 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-group-agency-fee-config-for-api.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdCampaignGroupAgencyFeeConfigForApi + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdCampaignGroupAgencyFeeConfigForApi extends AbstractCrudObject { + static get Fields(): Readonly<{ + agency_fee_pct: "agency_fee_pct"; + is_agency_fee_disabled: "is_agency_fee_disabled"; + is_default_agency_fee: "is_default_agency_fee"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-feature-customizations.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-feature-customizations.d.ts index 29afbd095081d2..a6a64bfedc4ac7 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-feature-customizations.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-feature-customizations.d.ts @@ -9,6 +9,7 @@ export default class AdCreativeFeatureCustomizations extends AbstractCrudObject catalog_feed_tag_name: "catalog_feed_tag_name"; font_name: "font_name"; image_crop_style: "image_crop_style"; + pe_carousel: "pe_carousel"; showcase_card_display: "showcase_card_display"; text_extraction: "text_extraction"; text_style: "text_style"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-features-spec.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-features-spec.d.ts index 619231b0ec2c06..0bd50cc668428c 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-features-spec.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-features-spec.d.ts @@ -11,6 +11,7 @@ export default class AdCreativeFeaturesSpec extends AbstractCrudObject { advantage_plus_creative: "advantage_plus_creative"; app_highlights: "app_highlights"; audio: "audio"; + biz_ai: "biz_ai"; carousel_to_video: "carousel_to_video"; catalog_feed_tag: "catalog_feed_tag"; customize_product_recommendation: "customize_product_recommendation"; @@ -23,6 +24,7 @@ export default class AdCreativeFeaturesSpec extends AbstractCrudObject { fb_reels_tag: "fb_reels_tag"; fb_story_tag: "fb_story_tag"; feed_caption_optimization: "feed_caption_optimization"; + hide_price: "hide_price"; ig_feed_tag: "ig_feed_tag"; ig_glados_feed: "ig_glados_feed"; ig_reels_tag: "ig_reels_tag"; @@ -41,19 +43,26 @@ export default class AdCreativeFeaturesSpec extends AbstractCrudObject { media_order: "media_order"; media_type_automation: "media_type_automation"; multi_photo_to_video: "multi_photo_to_video"; + music_generation: "music_generation"; pac_relaxation: "pac_relaxation"; product_extensions: "product_extensions"; product_metadata_automation: "product_metadata_automation"; product_tags: "product_tags"; profile_card: "profile_card"; + profile_extension: "profile_extension"; + show_summary: "show_summary"; site_extensions: "site_extensions"; standard_enhancements: "standard_enhancements"; standard_enhancements_catalog: "standard_enhancements_catalog"; text_generation: "text_generation"; text_optimizations: "text_optimizations"; + text_overlay_translation: "text_overlay_translation"; + text_translation: "text_translation"; video_auto_crop: "video_auto_crop"; video_filtering: "video_filtering"; video_highlight: "video_highlight"; + video_to_image: "video_to_image"; video_uncrop: "video_uncrop"; + wa_mm_text_truncation_length: "wa_mm_text_truncation_length"; }>; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-format-transformation-spec.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-format-transformation-spec.d.ts new file mode 100644 index 00000000000000..3cbcd9e590edb6 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-format-transformation-spec.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdCreativeFormatTransformationSpec + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdCreativeFormatTransformationSpec extends AbstractCrudObject { + static get Fields(): Readonly<{ + data_source: "data_source"; + format: "format"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-link-data-call-to-action.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-link-data-call-to-action.d.ts index b334117f323fd0..34c62c502ecbf9 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-link-data-call-to-action.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-link-data-call-to-action.d.ts @@ -90,6 +90,7 @@ export default class AdCreativeLinkDataCallToAction extends AbstractCrudObject { video_call: "VIDEO_CALL"; view_cart: "VIEW_CART"; view_channel: "VIEW_CHANNEL"; + view_in_cart: "VIEW_IN_CART"; view_product: "VIEW_PRODUCT"; visit_pages_feed: "VISIT_PAGES_FEED"; watch_live_video: "WATCH_LIVE_VIDEO"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-link-data-image-overlay-spec.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-link-data-image-overlay-spec.d.ts index 280c07e562b989..bc39f90504714d 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-link-data-image-overlay-spec.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-link-data-image-overlay-spec.d.ts @@ -17,6 +17,7 @@ export default class AdCreativeLinkDataImageOverlaySpec extends AbstractCrudObje static get CustomTextType(): Readonly<{ free_shipping: "free_shipping"; popular: "popular"; + sale: "sale"; }>; static get OverlayTemplate(): Readonly<{ circle_with_text: "circle_with_text"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-media-sourcing-spec.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-media-sourcing-spec.d.ts new file mode 100644 index 00000000000000..78908ac59d8367 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-media-sourcing-spec.d.ts @@ -0,0 +1,8 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdCreativeMediaSourcingSpec + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdCreativeMediaSourcingSpec extends AbstractCrudObject { + static get Fields(): Readonly<{}>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-site-links-spec.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-site-links-spec.d.ts index 7ffd1b86dc9f07..56273e588d38c2 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-site-links-spec.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-site-links-spec.d.ts @@ -5,6 +5,9 @@ import { AbstractCrudObject } from "./../abstract-crud-object"; */ export default class AdCreativeSiteLinksSpec extends AbstractCrudObject { static get Fields(): Readonly<{ + is_site_link_sticky: "is_site_link_sticky"; + site_link_hash: "site_link_hash"; + site_link_id: "site_link_id"; site_link_image_hash: "site_link_image_hash"; site_link_image_url: "site_link_image_url"; site_link_recommendation_type: "site_link_recommendation_type"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-sourcing-spec.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-sourcing-spec.d.ts index 24b7782c079f45..63a5ca049e924e 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-sourcing-spec.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-sourcing-spec.d.ts @@ -7,9 +7,11 @@ export default class AdCreativeSourcingSpec extends AbstractCrudObject { static get Fields(): Readonly<{ associated_product_set_id: "associated_product_set_id"; brand: "brand"; + dynamic_site_links_spec: "dynamic_site_links_spec"; enable_social_feedback_preservation: "enable_social_feedback_preservation"; promotion_metadata_spec: "promotion_metadata_spec"; site_links_spec: "site_links_spec"; source_url: "source_url"; + website_summary_spec: "website_summary_spec"; }>; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative.d.ts index 0c6d251f3e4af7..88210f8bf0a108 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-creative.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative.d.ts @@ -28,6 +28,7 @@ export default class AdCreative extends AbstractCrudObject { creative_sourcing_spec: "creative_sourcing_spec"; degrees_of_freedom_spec: "degrees_of_freedom_spec"; destination_set_id: "destination_set_id"; + destination_spec: "destination_spec"; dynamic_ad_voice: "dynamic_ad_voice"; effective_authorization_category: "effective_authorization_category"; effective_instagram_media_id: "effective_instagram_media_id"; @@ -35,6 +36,7 @@ export default class AdCreative extends AbstractCrudObject { enable_direct_install: "enable_direct_install"; enable_launch_instant_app: "enable_launch_instant_app"; facebook_branded_content: "facebook_branded_content"; + format_transformation_spec: "format_transformation_spec"; id: "id"; image_crops: "image_crops"; image_hash: "image_hash"; @@ -66,6 +68,7 @@ export default class AdCreative extends AbstractCrudObject { product_set_id: "product_set_id"; recommender_settings: "recommender_settings"; regional_regulation_disclaimer_spec: "regional_regulation_disclaimer_spec"; + source_facebook_post_id: "source_facebook_post_id"; source_instagram_media_id: "source_instagram_media_id"; status: "status"; template_url: "template_url"; @@ -159,6 +162,7 @@ export default class AdCreative extends AbstractCrudObject { video_call: "VIDEO_CALL"; view_cart: "VIEW_CART"; view_channel: "VIEW_CHANNEL"; + view_in_cart: "VIEW_IN_CART"; view_product: "VIEW_PRODUCT"; visit_pages_feed: "VISIT_PAGES_FEED"; watch_live_video: "WATCH_LIVE_VIDEO"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-preview.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-preview.d.ts index ef98266810e5a6..2575cc7b778140 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-preview.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-preview.d.ts @@ -20,6 +20,8 @@ export default class AdPreview extends AbstractCrudObject { facebook_profile_reels_mobile: "FACEBOOK_PROFILE_REELS_MOBILE"; facebook_reels_banner: "FACEBOOK_REELS_BANNER"; facebook_reels_banner_desktop: "FACEBOOK_REELS_BANNER_DESKTOP"; + facebook_reels_banner_fullscreen_ios: "FACEBOOK_REELS_BANNER_FULLSCREEN_IOS"; + facebook_reels_banner_fullscreen_mobile: "FACEBOOK_REELS_BANNER_FULLSCREEN_MOBILE"; facebook_reels_mobile: "FACEBOOK_REELS_MOBILE"; facebook_reels_postloop: "FACEBOOK_REELS_POSTLOOP"; facebook_reels_sticker: "FACEBOOK_REELS_STICKER"; @@ -34,7 +36,9 @@ export default class AdPreview extends AbstractCrudObject { instagram_profile_feed: "INSTAGRAM_PROFILE_FEED"; instagram_profile_reels: "INSTAGRAM_PROFILE_REELS"; instagram_reels: "INSTAGRAM_REELS"; + instagram_reels_instream: "INSTAGRAM_REELS_INSTREAM"; instagram_reels_overlay: "INSTAGRAM_REELS_OVERLAY"; + instagram_reels_web: "INSTAGRAM_REELS_WEB"; instagram_search_chain: "INSTAGRAM_SEARCH_CHAIN"; instagram_search_grid: "INSTAGRAM_SEARCH_GRID"; instagram_standard: "INSTAGRAM_STANDARD"; @@ -45,6 +49,7 @@ export default class AdPreview extends AbstractCrudObject { instant_article_recirculation_ad: "INSTANT_ARTICLE_RECIRCULATION_AD"; instant_article_standard: "INSTANT_ARTICLE_STANDARD"; instream_banner_desktop: "INSTREAM_BANNER_DESKTOP"; + instream_banner_fullscreen_ios: "INSTREAM_BANNER_FULLSCREEN_IOS"; instream_banner_fullscreen_mobile: "INSTREAM_BANNER_FULLSCREEN_MOBILE"; instream_banner_immersive_mobile: "INSTREAM_BANNER_IMMERSIVE_MOBILE"; instream_banner_mobile: "INSTREAM_BANNER_MOBILE"; @@ -78,6 +83,8 @@ export default class AdPreview extends AbstractCrudObject { product_metadata_automation: "product_metadata_automation"; profile_card: "profile_card"; standard_enhancements_catalog: "standard_enhancements_catalog"; + text_overlay_translation: "text_overlay_translation"; + video_to_image: "video_to_image"; }>; static get RenderType(): Readonly<{ fallback: "FALLBACK"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-promoted-object.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-promoted-object.d.ts index 7af8f31612ca16..f32e78e4a9c890 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-promoted-object.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-promoted-object.d.ts @@ -11,7 +11,9 @@ export default class AdPromotedObject extends AbstractCrudObject { custom_conversion_id: "custom_conversion_id"; custom_event_str: "custom_event_str"; custom_event_type: "custom_event_type"; + dataset_split_id: "dataset_split_id"; event_id: "event_id"; + full_funnel_objective: "full_funnel_objective"; fundraiser_campaign_id: "fundraiser_campaign_id"; lead_ads_custom_event_str: "lead_ads_custom_event_str"; lead_ads_custom_event_type: "lead_ads_custom_event_type"; @@ -19,6 +21,7 @@ export default class AdPromotedObject extends AbstractCrudObject { lead_ads_offsite_conversion_type: "lead_ads_offsite_conversion_type"; mcme_conversion_id: "mcme_conversion_id"; object_store_url: "object_store_url"; + object_store_urls: "object_store_urls"; offer_id: "offer_id"; offline_conversion_data_set_id: "offline_conversion_data_set_id"; offsite_conversion_event_id: "offsite_conversion_event_id"; @@ -33,9 +36,11 @@ export default class AdPromotedObject extends AbstractCrudObject { product_item_id: "product_item_id"; product_set: "product_set"; product_set_id: "product_set_id"; + product_set_optimization: "product_set_optimization"; retention_days: "retention_days"; value_semantic_type: "value_semantic_type"; variation: "variation"; + whats_app_business_phone_number_id: "whats_app_business_phone_number_id"; whatsapp_phone_number: "whatsapp_phone_number"; }>; static get CustomEventType(): Readonly<{ @@ -69,6 +74,29 @@ export default class AdPromotedObject extends AbstractCrudObject { subscribe: "SUBSCRIBE"; tutorial_completion: "TUTORIAL_COMPLETION"; }>; + static get FullFunnelObjective(): Readonly<{ + app_installs: "APP_INSTALLS"; + brand_awareness: "BRAND_AWARENESS"; + event_responses: "EVENT_RESPONSES"; + lead_generation: "LEAD_GENERATION"; + link_clicks: "LINK_CLICKS"; + local_awareness: "LOCAL_AWARENESS"; + messages: "MESSAGES"; + offer_claims: "OFFER_CLAIMS"; + outcome_app_promotion: "OUTCOME_APP_PROMOTION"; + outcome_awareness: "OUTCOME_AWARENESS"; + outcome_engagement: "OUTCOME_ENGAGEMENT"; + outcome_leads: "OUTCOME_LEADS"; + outcome_sales: "OUTCOME_SALES"; + outcome_traffic: "OUTCOME_TRAFFIC"; + page_likes: "PAGE_LIKES"; + post_engagement: "POST_ENGAGEMENT"; + product_catalog_sales: "PRODUCT_CATALOG_SALES"; + reach: "REACH"; + store_visits: "STORE_VISITS"; + video_views: "VIDEO_VIEWS"; + website_conversions: "WEBSITE_CONVERSIONS"; + }>; static get LeadAdsCustomEventType(): Readonly<{ achievement_unlocked: "ACHIEVEMENT_UNLOCKED"; add_payment_info: "ADD_PAYMENT_INFO"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-report-run.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-report-run.d.ts index 5065c452120dfd..ec353bcfbd6db6 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-report-run.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-report-run.d.ts @@ -14,6 +14,7 @@ export default class AdReportRun extends AbstractCrudObject { date_start: "date_start"; date_stop: "date_stop"; emails: "emails"; + error_code: "error_code"; friendly_name: "friendly_name"; id: "id"; is_async_export: "is_async_export"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-rule-history.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-rule-history.d.ts index 876312f1b5e743..7bb22240b55703 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-rule-history.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-rule-history.d.ts @@ -23,6 +23,7 @@ export default class AdRuleHistory extends AbstractCrudObject { convert_asc_cp_single_instance: "CONVERT_ASC_CP_SINGLE_INSTANCE"; email: "EMAIL"; enable_advantage_campaign_budget: "ENABLE_ADVANTAGE_CAMPAIGN_BUDGET"; + enable_advantage_plus_audience: "ENABLE_ADVANTAGE_PLUS_AUDIENCE"; enable_advantage_plus_creative: "ENABLE_ADVANTAGE_PLUS_CREATIVE"; enable_advantage_plus_placements: "ENABLE_ADVANTAGE_PLUS_PLACEMENTS"; enable_autoflow: "ENABLE_AUTOFLOW"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-set.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-set.d.ts index 095e61cb8f2deb..aaa5049d1dcd16 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-set.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-set.d.ts @@ -14,6 +14,7 @@ export default class AdSet extends AbstractCrudObject { adset_schedule: "adset_schedule"; asset_feed_id: "asset_feed_id"; attribution_spec: "attribution_spec"; + automatic_manual_state: "automatic_manual_state"; bid_adjustments: "bid_adjustments"; bid_amount: "bid_amount"; bid_constraints: "bid_constraints"; @@ -29,6 +30,7 @@ export default class AdSet extends AbstractCrudObject { configured_status: "configured_status"; created_time: "created_time"; creative_sequence: "creative_sequence"; + creative_sequence_repetition_pattern: "creative_sequence_repetition_pattern"; daily_budget: "daily_budget"; daily_min_spend_target: "daily_min_spend_target"; daily_spend_cap: "daily_spend_cap"; @@ -45,6 +47,7 @@ export default class AdSet extends AbstractCrudObject { is_ba_skip_delayed_eligible: "is_ba_skip_delayed_eligible"; is_budget_schedule_enabled: "is_budget_schedule_enabled"; is_dynamic_creative: "is_dynamic_creative"; + is_incremental_attribution_enabled: "is_incremental_attribution_enabled"; issues_info: "issues_info"; learning_stage_info: "learning_stage_info"; lifetime_budget: "lifetime_budget"; @@ -115,6 +118,7 @@ export default class AdSet extends AbstractCrudObject { ad_recall_lift: "AD_RECALL_LIFT"; app_installs: "APP_INSTALLS"; app_installs_and_offsite_conversions: "APP_INSTALLS_AND_OFFSITE_CONVERSIONS"; + automatic_objective: "AUTOMATIC_OBJECTIVE"; conversations: "CONVERSATIONS"; derived_events: "DERIVED_EVENTS"; engaged_users: "ENGAGED_USERS"; @@ -148,6 +152,19 @@ export default class AdSet extends AbstractCrudObject { deleted: "DELETED"; paused: "PAUSED"; }>; + static get AutomaticManualState(): Readonly<{ + automatic: "AUTOMATIC"; + manual: "MANUAL"; + unset: "UNSET"; + }>; + static get BudgetSource(): Readonly<{ + none: "NONE"; + rmn: "RMN"; + }>; + static get CreativeSequenceRepetitionPattern(): Readonly<{ + full_sequence: "FULL_SEQUENCE"; + last_ad: "LAST_AD"; + }>; static get DatePreset(): Readonly<{ data_maximum: "DATA_MAXIMUM"; last_14d: "LAST_14D"; @@ -174,8 +191,11 @@ export default class AdSet extends AbstractCrudObject { app: "APP"; applinks_automatic: "APPLINKS_AUTOMATIC"; facebook: "FACEBOOK"; + facebook_live: "FACEBOOK_LIVE"; facebook_page: "FACEBOOK_PAGE"; + imagine: "IMAGINE"; instagram_direct: "INSTAGRAM_DIRECT"; + instagram_live: "INSTAGRAM_LIVE"; instagram_profile: "INSTAGRAM_PROFILE"; instagram_profile_and_facebook_page: "INSTAGRAM_PROFILE_AND_FACEBOOK_PAGE"; messaging_instagram_direct_messenger: "MESSAGING_INSTAGRAM_DIRECT_MESSENGER"; @@ -226,6 +246,8 @@ export default class AdSet extends AbstractCrudObject { value_3: "3"; value_4: "4"; value_5: "5"; + value_6: "6"; + value_7: "7"; }>; static get TuneForCategory(): Readonly<{ credit: "CREDIT"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-action-stats.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-action-stats.d.ts index 95a2085767027f..9d0cc2ad1888f4 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ads-action-stats.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-action-stats.d.ts @@ -45,6 +45,9 @@ export default class AdsActionStats extends AbstractCrudObject { action_video_sound: "action_video_sound"; action_video_type: "action_video_type"; dda: "dda"; + incrementality: "incrementality"; + incrementality_all_conversions: "incrementality_all_conversions"; + incrementality_first_conversion: "incrementality_first_conversion"; inline: "inline"; interactive_component_sticker_id: "interactive_component_sticker_id"; interactive_component_sticker_response: "interactive_component_sticker_response"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-dataset.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-dataset.d.ts index 36713c934c237e..642eb010ca570f 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ads-dataset.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-dataset.d.ts @@ -58,4 +58,8 @@ export default class AdsDataset extends AbstractCrudObject { usage: "usage"; valid_entries: "valid_entries"; }>; + static get SortBy(): Readonly<{ + last_fired_time: "LAST_FIRED_TIME"; + name: "NAME"; + }>; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-histogram-stats.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-histogram-stats.d.ts index 0a3cedfd625e70..74d80c8e8d40b5 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ads-histogram-stats.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-histogram-stats.d.ts @@ -45,6 +45,9 @@ export default class AdsHistogramStats extends AbstractCrudObject { action_video_sound: "action_video_sound"; action_video_type: "action_video_type"; dda: "dda"; + incrementality: "incrementality"; + incrementality_all_conversions: "incrementality_all_conversions"; + incrementality_first_conversion: "incrementality_first_conversion"; inline: "inline"; interactive_component_sticker_id: "interactive_component_sticker_id"; interactive_component_sticker_response: "interactive_component_sticker_response"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-insights.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-insights.d.ts index 6ff4905732f893..d1a553ec1951b2 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ads-insights.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-insights.d.ts @@ -40,10 +40,26 @@ export default class AdsInsights extends AbstractCrudObject { conversion_rate_ranking: "conversion_rate_ranking"; conversion_values: "conversion_values"; conversions: "conversions"; + converted_product_app_custom_event_fb_mobile_purchase: "converted_product_app_custom_event_fb_mobile_purchase"; + converted_product_app_custom_event_fb_mobile_purchase_value: "converted_product_app_custom_event_fb_mobile_purchase_value"; + converted_product_offline_purchase: "converted_product_offline_purchase"; + converted_product_offline_purchase_value: "converted_product_offline_purchase_value"; + converted_product_omni_purchase: "converted_product_omni_purchase"; + converted_product_omni_purchase_values: "converted_product_omni_purchase_values"; converted_product_quantity: "converted_product_quantity"; converted_product_value: "converted_product_value"; + converted_product_website_pixel_purchase: "converted_product_website_pixel_purchase"; + converted_product_website_pixel_purchase_value: "converted_product_website_pixel_purchase_value"; + converted_promoted_product_app_custom_event_fb_mobile_purchase: "converted_promoted_product_app_custom_event_fb_mobile_purchase"; + converted_promoted_product_app_custom_event_fb_mobile_purchase_value: "converted_promoted_product_app_custom_event_fb_mobile_purchase_value"; + converted_promoted_product_offline_purchase: "converted_promoted_product_offline_purchase"; + converted_promoted_product_offline_purchase_value: "converted_promoted_product_offline_purchase_value"; + converted_promoted_product_omni_purchase: "converted_promoted_product_omni_purchase"; + converted_promoted_product_omni_purchase_values: "converted_promoted_product_omni_purchase_values"; converted_promoted_product_quantity: "converted_promoted_product_quantity"; converted_promoted_product_value: "converted_promoted_product_value"; + converted_promoted_product_website_pixel_purchase: "converted_promoted_product_website_pixel_purchase"; + converted_promoted_product_website_pixel_purchase_value: "converted_promoted_product_website_pixel_purchase_value"; cost_per_15_sec_video_view: "cost_per_15_sec_video_view"; cost_per_2_sec_continuous_video_view: "cost_per_2_sec_continuous_video_view"; cost_per_action_type: "cost_per_action_type"; @@ -54,8 +70,10 @@ export default class AdsInsights extends AbstractCrudObject { cost_per_estimated_ad_recallers: "cost_per_estimated_ad_recallers"; cost_per_inline_link_click: "cost_per_inline_link_click"; cost_per_inline_post_engagement: "cost_per_inline_post_engagement"; + cost_per_objective_result: "cost_per_objective_result"; cost_per_one_thousand_ad_impression: "cost_per_one_thousand_ad_impression"; cost_per_outbound_click: "cost_per_outbound_click"; + cost_per_result: "cost_per_result"; cost_per_thruplay: "cost_per_thruplay"; cost_per_unique_action_type: "cost_per_unique_action_type"; cost_per_unique_click: "cost_per_unique_click"; @@ -94,8 +112,11 @@ export default class AdsInsights extends AbstractCrudObject { interactive_component_tap: "interactive_component_tap"; labels: "labels"; landing_page_view_actions_per_link_click: "landing_page_view_actions_per_link_click"; + landing_page_view_per_link_click: "landing_page_view_per_link_click"; landing_page_view_per_purchase_rate: "landing_page_view_per_purchase_rate"; + link_clicks_per_results: "link_clicks_per_results"; location: "location"; + marketing_messages_click_rate_benchmark: "marketing_messages_click_rate_benchmark"; marketing_messages_cost_per_delivered: "marketing_messages_cost_per_delivered"; marketing_messages_cost_per_link_btn_click: "marketing_messages_cost_per_link_btn_click"; marketing_messages_delivered: "marketing_messages_delivered"; @@ -108,6 +129,7 @@ export default class AdsInsights extends AbstractCrudObject { marketing_messages_quick_reply_btn_click_rate: "marketing_messages_quick_reply_btn_click_rate"; marketing_messages_read: "marketing_messages_read"; marketing_messages_read_rate: "marketing_messages_read_rate"; + marketing_messages_read_rate_benchmark: "marketing_messages_read_rate_benchmark"; marketing_messages_sent: "marketing_messages_sent"; marketing_messages_spend: "marketing_messages_spend"; marketing_messages_spend_currency: "marketing_messages_spend_currency"; @@ -117,20 +139,39 @@ export default class AdsInsights extends AbstractCrudObject { marketing_messages_website_purchase_values: "marketing_messages_website_purchase_values"; mobile_app_purchase_roas: "mobile_app_purchase_roas"; objective: "objective"; + objective_result_rate: "objective_result_rate"; + objective_results: "objective_results"; onsite_conversion_messaging_detected_purchase_deduped: "onsite_conversion_messaging_detected_purchase_deduped"; optimization_goal: "optimization_goal"; outbound_clicks: "outbound_clicks"; outbound_clicks_ctr: "outbound_clicks_ctr"; place_page_name: "place_page_name"; + product_brand: "product_brand"; + product_category: "product_category"; + product_content_id: "product_content_id"; + product_custom_label_0: "product_custom_label_0"; + product_custom_label_1: "product_custom_label_1"; + product_custom_label_2: "product_custom_label_2"; + product_custom_label_3: "product_custom_label_3"; + product_custom_label_4: "product_custom_label_4"; + product_group_content_id: "product_group_content_id"; + product_group_retailer_id: "product_group_retailer_id"; + product_name: "product_name"; + product_retailer_id: "product_retailer_id"; + product_views: "product_views"; + purchase_per_landing_page_view: "purchase_per_landing_page_view"; purchase_roas: "purchase_roas"; purchases_per_link_click: "purchases_per_link_click"; qualifying_question_qualify_answer_rate: "qualifying_question_qualify_answer_rate"; quality_ranking: "quality_ranking"; reach: "reach"; + result_rate: "result_rate"; result_values_performance_indicator: "result_values_performance_indicator"; + results: "results"; shops_assisted_purchases: "shops_assisted_purchases"; social_spend: "social_spend"; spend: "spend"; + total_card_view: "total_card_view"; total_postbacks: "total_postbacks"; total_postbacks_detailed: "total_postbacks_detailed"; total_postbacks_detailed_v4: "total_postbacks_detailed_v4"; @@ -208,9 +249,12 @@ export default class AdsInsights extends AbstractCrudObject { static get ActionReportTime(): Readonly<{ conversion: "conversion"; impression: "impression"; + lifetime: "lifetime"; mixed: "mixed"; }>; static get Breakdowns(): Readonly<{ + ad_extension_domain: "ad_extension_domain"; + ad_extension_url: "ad_extension_url"; ad_format_asset: "ad_format_asset"; age: "age"; app_id: "app_id"; @@ -219,13 +263,18 @@ export default class AdsInsights extends AbstractCrudObject { breakdown_reporting_ad_id: "breakdown_reporting_ad_id"; call_to_action_asset: "call_to_action_asset"; coarse_conversion_value: "coarse_conversion_value"; + comscore_market: "comscore_market"; + comscore_market_code: "comscore_market_code"; conversion_destination: "conversion_destination"; country: "country"; + creative_relaxation_asset_type: "creative_relaxation_asset_type"; description_asset: "description_asset"; device_platform: "device_platform"; dma: "dma"; fidelity_type: "fidelity_type"; + flexible_format_asset_type: "flexible_format_asset_type"; frequency_value: "frequency_value"; + gen_ai_asset_type: "gen_ai_asset_type"; gender: "gender"; hourly_stats_aggregated_by_advertiser_time_zone: "hourly_stats_aggregated_by_advertiser_time_zone"; hourly_stats_aggregated_by_audience_time_zone: "hourly_stats_aggregated_by_audience_time_zone"; @@ -233,6 +282,7 @@ export default class AdsInsights extends AbstractCrudObject { image_asset: "image_asset"; impression_device: "impression_device"; impression_view_time_advertiser_hour_v2: "impression_view_time_advertiser_hour_v2"; + is_auto_advance: "is_auto_advance"; is_conversion_id_modeled: "is_conversion_id_modeled"; is_rendered_as_delayed_skip_ad: "is_rendered_as_delayed_skip_ad"; landing_destination: "landing_destination"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-naming-template.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-naming-template.d.ts index 639751e5af294c..629fa14f36fe63 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ads-naming-template.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-naming-template.d.ts @@ -22,6 +22,7 @@ export default class AdsNamingTemplate extends AbstractCrudObject { campaign_group: "CAMPAIGN_GROUP"; opportunities: "OPPORTUNITIES"; privacy_info_center: "PRIVACY_INFO_CENTER"; + product: "PRODUCT"; topline: "TOPLINE"; unique_adcreative: "UNIQUE_ADCREATIVE"; }>; diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-capi-integration-quality.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-capi-integration-quality.d.ts index 881769f2ffcf46..066cc6373b757f 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-capi-integration-quality.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-capi-integration-quality.d.ts @@ -5,7 +5,12 @@ import { AbstractCrudObject } from "./../abstract-crud-object"; */ export default class AdsPixelCAPIIntegrationQuality extends AbstractCrudObject { static get Fields(): Readonly<{ + acr: "acr"; + data_freshness: "data_freshness"; + dedupe_key_feedback: "dedupe_key_feedback"; + event_coverage: "event_coverage"; event_match_quality: "event_match_quality"; event_name: "event_name"; + event_potential_aly_acr_increase: "event_potential_aly_acr_increase"; }>; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-user-settings.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-user-settings.d.ts index 7491bb48dbdae4..572f177431e2e1 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ads-user-settings.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-user-settings.d.ts @@ -17,6 +17,7 @@ export default class AdsUserSettings extends AbstractCrudObject { aplusc_local_store_extension_opt_in_status: "aplusc_local_store_extension_opt_in_status"; aplusc_opt_out_friction: "aplusc_opt_out_friction"; aplusc_videofilter_opt_in_status: "aplusc_videofilter_opt_in_status"; + aplusc_videouncrop_opt_in_status: "aplusc_videouncrop_opt_in_status"; autoflow_lite_opt_in_status: "autoflow_lite_opt_in_status"; autoflow_lite_should_opt_in: "autoflow_lite_should_opt_in"; blended_ads_creation_defaulting_opt_in_status: "blended_ads_creation_defaulting_opt_in_status"; @@ -26,6 +27,8 @@ export default class AdsUserSettings extends AbstractCrudObject { campaign_name_template: "campaign_name_template"; carousel_to_video_opt_in_status: "carousel_to_video_opt_in_status"; connected_sources_catalog_opt_in_status: "connected_sources_catalog_opt_in_status"; + da_add_overlays_opt_in_status: "da_add_overlays_opt_in_status"; + da_hide_price_opt_in_status: "da_hide_price_opt_in_status"; default_creation_mode: "default_creation_mode"; dynamic_partnership_ads_opt_in_status: "dynamic_partnership_ads_opt_in_status"; enhance_cta_text_extraction_opt_in_status: "enhance_cta_text_extraction_opt_in_status"; @@ -34,19 +37,25 @@ export default class AdsUserSettings extends AbstractCrudObject { gen_ai_alpha_test_status: "gen_ai_alpha_test_status"; id: "id"; image_background_generation_opt_in_status: "image_background_generation_opt_in_status"; + image_brightness_and_contrast_opt_in_status: "image_brightness_and_contrast_opt_in_status"; image_expansion_opt_in_status: "image_expansion_opt_in_status"; is_ads_ai_consented: "is_ads_ai_consented"; is_cbo_default_on: "is_cbo_default_on"; is_se_removal_guidance_dismissed: "is_se_removal_guidance_dismissed"; last_used_post_format: "last_used_post_format"; last_visited_time: "last_visited_time"; + metadata_brand_kit_opt_in_status: "metadata_brand_kit_opt_in_status"; music_on_reels_opt_in: "music_on_reels_opt_in"; muted_cbo_midflight_education_messages: "muted_cbo_midflight_education_messages"; onsite_destination_optimization_opt_in: "onsite_destination_optimization_opt_in"; open_tabs: "open_tabs"; + pac_relaxation_opt_in_status: "pac_relaxation_opt_in_status"; + placement_group_square_opt_in_status: "placement_group_square_opt_in_status"; + placement_group_vertical_opt_in_status: "placement_group_vertical_opt_in_status"; previously_seen_recommendations: "previously_seen_recommendations"; product_extensions_opt_in: "product_extensions_opt_in"; sa_off_conv_loc_seen: "sa_off_conv_loc_seen"; + saoff_published_l2_conv_loc_seen: "saoff_published_l2_conv_loc_seen"; saon_migr_l1_seen_status: "saon_migr_l1_seen_status"; selected_ad_account: "selected_ad_account"; selected_comparison_timerange: "selected_comparison_timerange"; @@ -62,10 +71,12 @@ export default class AdsUserSettings extends AbstractCrudObject { should_not_show_cbo_campaign_toggle_off_confirmation_message: "should_not_show_cbo_campaign_toggle_off_confirmation_message"; should_not_show_publish_message_on_editor_close: "should_not_show_publish_message_on_editor_close"; show_original_videos_opt_in: "show_original_videos_opt_in"; + show_summary_opt_in_status: "show_summary_opt_in_status"; static_ad_product_extensions_opt_in: "static_ad_product_extensions_opt_in"; sticky_setting_after_default_on: "sticky_setting_after_default_on"; syd_campaign_trends_metric: "syd_campaign_trends_metric"; text_optimizations_text_extraction_opt_in_status: "text_optimizations_text_extraction_opt_in_status"; + text_translation_opt_in_status: "text_translation_opt_in_status"; text_variations_sticky_opt_in_status: "text_variations_sticky_opt_in_status"; total_coupon_syd_dismissals: "total_coupon_syd_dismissals"; total_coupon_upsell_dismissals: "total_coupon_upsell_dismissals"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-value-adjustment-rule-collection.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-value-adjustment-rule-collection.d.ts index d8142918108a4d..da569528aa03ca 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ads-value-adjustment-rule-collection.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-value-adjustment-rule-collection.d.ts @@ -10,12 +10,18 @@ export default class AdsValueAdjustmentRuleCollection extends AbstractCrudObject is_default_setting: "is_default_setting"; name: "name"; product_type: "product_type"; + status: "status"; }>; static get ProductType(): Readonly<{ audience: "AUDIENCE"; leadgen_ads: "LEADGEN_ADS"; omni_channel: "OMNI_CHANNEL"; }>; + static get Status(): Readonly<{ + active: "ACTIVE"; + deleted: "DELETED"; + }>; + createDeleteRuleSet(fields: string[], params?: Record, pathOverride?: string | null): Promise; getRules(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; get(fields: string[], params?: Record): Promise; update(fields: string[], params?: Record): Promise; diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-value-adjustment-rule.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-value-adjustment-rule.d.ts deleted file mode 100644 index 37f5603e5ea8ce..00000000000000 --- a/types/facebook-nodejs-business-sdk/src/objects/ads-value-adjustment-rule.d.ts +++ /dev/null @@ -1,14 +0,0 @@ -import { AbstractCrudObject } from "./../abstract-crud-object"; -import Cursor from "./../cursor"; -/** - * AdsValueAdjustmentRule - * @see {@link https://developers.facebook.com/docs/marketing-api/} - */ -export default class AdsValueAdjustmentRule extends AbstractCrudObject { - static get Fields(): Readonly<{ - base_value: "base_value"; - id: "id"; - }>; - getCriterias(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - get(fields: string[], params?: Record): Promise; -} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ai-generated-product-image.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ai-generated-product-image.d.ts new file mode 100644 index 00000000000000..f6e71303494752 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ai-generated-product-image.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AIGeneratedProductImage + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AIGeneratedProductImage extends AbstractCrudObject { + static get Fields(): Readonly<{ + flagged_for_manual_review: "flagged_for_manual_review"; + transformed_image_url: "transformed_image_url"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/alm-event.d.ts b/types/facebook-nodejs-business-sdk/src/objects/alm-event.d.ts index 5e51a8ddc771ce..cc628490db1f21 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/alm-event.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/alm-event.d.ts @@ -12,6 +12,7 @@ export default class ALMEvent extends AbstractCrudObject { event_time: "event_time"; guidance: "guidance"; guidance_detail: "guidance_detail"; + guidance_type: "guidance_type"; id: "id"; parent_advertiser_ids: "parent_advertiser_ids"; reseller_business_id: "reseller_business_id"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/alm-guidance-metrics.d.ts b/types/facebook-nodejs-business-sdk/src/objects/alm-guidance-metrics.d.ts index d24895b7d036dd..d1eeb9db073349 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/alm-guidance-metrics.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/alm-guidance-metrics.d.ts @@ -13,8 +13,17 @@ export default class ALMGuidanceMetrics extends AbstractCrudObject { l28_available: "l28_available"; l28_click: "l28_click"; l28_conversion: "l28_conversion"; + l28_has_click: "l28_has_click"; + l28_has_impression: "l28_has_impression"; l28_impression: "l28_impression"; + l28_is_actioned: "l28_is_actioned"; + l28_is_adopted: "l28_is_adopted"; + l28_is_available: "l28_is_available"; + l28_is_pitched: "l28_is_pitched"; l28_pitch: "l28_pitch"; + l28d_adopted_revenue: "l28d_adopted_revenue"; + last_actioned_ds: "last_actioned_ds"; + last_adopted_ds: "last_adopted_ds"; last_pitch_ds: "last_pitch_ds"; parent_advertiser_id: "parent_advertiser_id"; report_ds: "report_ds"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/alm-guidance.d.ts b/types/facebook-nodejs-business-sdk/src/objects/alm-guidance.d.ts index 716cddfd40c9b6..e40e7ed8aeb9f6 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/alm-guidance.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/alm-guidance.d.ts @@ -7,6 +7,7 @@ export default class ALMGuidance extends AbstractCrudObject { static get Fields(): Readonly<{ ad_account_id: "ad_account_id"; guidances: "guidances"; + opportunity_score: "opportunity_score"; parent_advertiser_id: "parent_advertiser_id"; parent_advertiser_name: "parent_advertiser_name"; }>; diff --git a/types/facebook-nodejs-business-sdk/src/objects/apac-mon-seller-status-api-container.d.ts b/types/facebook-nodejs-business-sdk/src/objects/apac-mon-seller-status-api-container.d.ts new file mode 100644 index 00000000000000..02bddbf2ddc896 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/apac-mon-seller-status-api-container.d.ts @@ -0,0 +1,10 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ApacMonSellerStatusAPIContainer + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ApacMonSellerStatusAPIContainer extends AbstractCrudObject { + static get Fields(): Readonly<{ + structured_messaging_commerce: "structured_messaging_commerce"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/application.d.ts b/types/facebook-nodejs-business-sdk/src/objects/application.d.ts index feb444ca392286..1952edb5ba1cc9 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/application.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/application.d.ts @@ -212,12 +212,12 @@ export default class Application extends AbstractCrudObject { getButtonAutoDetectionDeviceSelection(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getCloudbridgeSettings(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; createCodelessEventMapping(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getConnectedClientBusinesses(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getDaChecks(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; createDomainReport(fields: string[], params?: Record, pathOverride?: string | null): Promise; getIapPurchases(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getIosDialogConfigs(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getLinkedDataset(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getMessageTemplates(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; createMmpAuditing(fields: string[], params?: Record, pathOverride?: string | null): Promise; getMobileSdkGk(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getMonetizedDigitalStoreObjects(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; @@ -230,6 +230,8 @@ export default class Application extends AbstractCrudObject { getPurchases(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getRoles(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getServerDomainInfos(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getSgwDatasetStatus(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getSgwInstallDeferralLink(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getSubscribedDomains(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; createSubscribedDomain(fields: string[], params?: Record, pathOverride?: string | null): Promise; getSubscribedDomainsPhishing(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; diff --git a/types/facebook-nodejs-business-sdk/src/objects/audio-sub-label.d.ts b/types/facebook-nodejs-business-sdk/src/objects/audio-sub-label.d.ts new file mode 100644 index 00000000000000..87dbb551786979 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/audio-sub-label.d.ts @@ -0,0 +1,17 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AudioSubLabel + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AudioSubLabel extends AbstractCrudObject { + static get Fields(): Readonly<{ + expiration_timestamp: "expiration_timestamp"; + flagged_timestamp: "flagged_timestamp"; + id: "id"; + label_name: "label_name"; + last_update_timestamp: "last_update_timestamp"; + num_audio_tracks: "num_audio_tracks"; + state: "state"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/bespoke-partner-guidance-laser.d.ts b/types/facebook-nodejs-business-sdk/src/objects/bespoke-partner-guidance-laser.d.ts deleted file mode 100644 index e1a8956a0601d5..00000000000000 --- a/types/facebook-nodejs-business-sdk/src/objects/bespoke-partner-guidance-laser.d.ts +++ /dev/null @@ -1,14 +0,0 @@ -import { AbstractCrudObject } from "./../abstract-crud-object"; -/** - * BespokePartnerGuidanceLaser - * @see {@link https://developers.facebook.com/docs/marketing-api/} - */ -export default class BespokePartnerGuidanceLaser extends AbstractCrudObject { - static get Fields(): Readonly<{ - business: "business"; - campaign_group: "campaign_group"; - cpa_improvement: "cpa_improvement"; - guidance_type: "guidance_type"; - id: "id"; - }>; -} diff --git a/types/facebook-nodejs-business-sdk/src/objects/branded-content-fb-promode-user.d.ts b/types/facebook-nodejs-business-sdk/src/objects/branded-content-fb-promode-user.d.ts new file mode 100644 index 00000000000000..ff52a88f3201f4 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/branded-content-fb-promode-user.d.ts @@ -0,0 +1,14 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * BrandedContentFBPromodeUser + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class BrandedContentFBPromodeUser extends AbstractCrudObject { + static get Fields(): Readonly<{ + delegate_page_for_ads_only_id: "delegate_page_for_ads_only_id"; + is_iabp: "is_iabp"; + is_managed: "is_managed"; + name: "name"; + profile_picture_url: "profile_picture_url"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/business-asset-group.d.ts b/types/facebook-nodejs-business-sdk/src/objects/business-asset-group.d.ts index 63fe74707aa423..1896109ab7b986 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/business-asset-group.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/business-asset-group.d.ts @@ -43,6 +43,7 @@ export default class BusinessAssetGroup extends AbstractCrudObject { profile_plus_create_content: "PROFILE_PLUS_CREATE_CONTENT"; profile_plus_facebook_access: "PROFILE_PLUS_FACEBOOK_ACCESS"; profile_plus_full_control: "PROFILE_PLUS_FULL_CONTROL"; + profile_plus_global_structure_management: "PROFILE_PLUS_GLOBAL_STRUCTURE_MANAGEMENT"; profile_plus_manage: "PROFILE_PLUS_MANAGE"; profile_plus_manage_leads: "PROFILE_PLUS_MANAGE_LEADS"; profile_plus_messaging: "PROFILE_PLUS_MESSAGING"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/business-role-request.d.ts b/types/facebook-nodejs-business-sdk/src/objects/business-role-request.d.ts index 3fd8cbf8aaae91..413be4298ef497 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/business-role-request.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/business-role-request.d.ts @@ -19,6 +19,7 @@ export default class BusinessRoleRequest extends AbstractCrudObject { owner: "owner"; role: "role"; status: "status"; + tasks: "tasks"; updated_by: "updated_by"; updated_time: "updated_time"; }>; @@ -39,6 +40,23 @@ export default class BusinessRoleRequest extends AbstractCrudObject { partner_center_marketing: "PARTNER_CENTER_MARKETING"; partner_center_operations: "PARTNER_CENTER_OPERATIONS"; }>; + static get Tasks(): Readonly<{ + admin: "ADMIN"; + ads_rights_reviewer: "ADS_RIGHTS_REVIEWER"; + default: "DEFAULT"; + developer: "DEVELOPER"; + employee: "EMPLOYEE"; + finance_analyst: "FINANCE_ANALYST"; + finance_edit: "FINANCE_EDIT"; + finance_editor: "FINANCE_EDITOR"; + finance_view: "FINANCE_VIEW"; + manage: "MANAGE"; + partner_center_admin: "PARTNER_CENTER_ADMIN"; + partner_center_analyst: "PARTNER_CENTER_ANALYST"; + partner_center_education: "PARTNER_CENTER_EDUCATION"; + partner_center_marketing: "PARTNER_CENTER_MARKETING"; + partner_center_operations: "PARTNER_CENTER_OPERATIONS"; + }>; delete(fields: string[], params?: Record): Promise; get(fields: string[], params?: Record): Promise; update(fields: string[], params?: Record): Promise; diff --git a/types/facebook-nodejs-business-sdk/src/objects/business-user.d.ts b/types/facebook-nodejs-business-sdk/src/objects/business-user.d.ts index f96104191af0d1..1d32fd7a138962 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/business-user.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/business-user.d.ts @@ -19,6 +19,7 @@ export default class BusinessUser extends AbstractCrudObject { name: "name"; pending_email: "pending_email"; role: "role"; + tasks: "tasks"; title: "title"; two_fac_status: "two_fac_status"; }>; @@ -43,10 +44,28 @@ export default class BusinessUser extends AbstractCrudObject { partner_center_marketing: "PARTNER_CENTER_MARKETING"; partner_center_operations: "PARTNER_CENTER_OPERATIONS"; }>; + static get Tasks(): Readonly<{ + admin: "ADMIN"; + ads_rights_reviewer: "ADS_RIGHTS_REVIEWER"; + default: "DEFAULT"; + developer: "DEVELOPER"; + employee: "EMPLOYEE"; + finance_analyst: "FINANCE_ANALYST"; + finance_edit: "FINANCE_EDIT"; + finance_editor: "FINANCE_EDITOR"; + finance_view: "FINANCE_VIEW"; + manage: "MANAGE"; + partner_center_admin: "PARTNER_CENTER_ADMIN"; + partner_center_analyst: "PARTNER_CENTER_ANALYST"; + partner_center_education: "PARTNER_CENTER_EDUCATION"; + partner_center_marketing: "PARTNER_CENTER_MARKETING"; + partner_center_operations: "PARTNER_CENTER_OPERATIONS"; + }>; getAssignedAdAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getAssignedBusinessAssetGroups(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getAssignedPages(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getAssignedProductCatalogs(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getAssignedWhatsAppBusinessAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; delete(fields: string[], params?: Record): Promise; get(fields: string[], params?: Record): Promise; update(fields: string[], params?: Record): Promise; diff --git a/types/facebook-nodejs-business-sdk/src/objects/business.d.ts b/types/facebook-nodejs-business-sdk/src/objects/business.d.ts index 840509babe190c..2383e0261e2ca7 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/business.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/business.d.ts @@ -13,6 +13,7 @@ import CPASBusinessSetupConfig from "./cpas-business-setup-config"; import BusinessCreativeFolder from "./business-creative-folder"; import EventSourceGroup from "./event-source-group"; import BusinessImage from "./business-image"; +import ManagedPartnerBusiness from "./managed-partner-business"; import OpenBridgeConfiguration from "./open-bridge-configuration"; import SystemUser from "./system-user"; import AdVideo from "./ad-video"; @@ -106,6 +107,7 @@ export default class Business extends AbstractCrudObject { profile_plus_create_content: "PROFILE_PLUS_CREATE_CONTENT"; profile_plus_facebook_access: "PROFILE_PLUS_FACEBOOK_ACCESS"; profile_plus_full_control: "PROFILE_PLUS_FULL_CONTROL"; + profile_plus_global_structure_management: "PROFILE_PLUS_GLOBAL_STRUCTURE_MANAGEMENT"; profile_plus_manage: "PROFILE_PLUS_MANAGE"; profile_plus_manage_leads: "PROFILE_PLUS_MANAGE_LEADS"; profile_plus_messaging: "PROFILE_PLUS_MESSAGING"; @@ -623,6 +625,7 @@ export default class Business extends AbstractCrudObject { profile_plus_create_content: "PROFILE_PLUS_CREATE_CONTENT"; profile_plus_facebook_access: "PROFILE_PLUS_FACEBOOK_ACCESS"; profile_plus_full_control: "PROFILE_PLUS_FULL_CONTROL"; + profile_plus_global_structure_management: "PROFILE_PLUS_GLOBAL_STRUCTURE_MANAGEMENT"; profile_plus_manage: "PROFILE_PLUS_MANAGE"; profile_plus_manage_leads: "PROFILE_PLUS_MANAGE_LEADS"; profile_plus_messaging: "PROFILE_PLUS_MESSAGING"; @@ -877,6 +880,7 @@ export default class Business extends AbstractCrudObject { getAdNetworkAnalytics(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; createAdNetworkAnalytic(fields: string[], params?: Record, pathOverride?: string | null): Promise; getAdNetworkAnalyticsResults(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getAdsDataset(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; createAdsDataSet(fields: string[], params?: Record, pathOverride?: string | null): Promise; getAdsReportingMmmReports(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getAdsReportingMmmSchedulers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; @@ -896,6 +900,7 @@ export default class Business extends AbstractCrudObject { getClientAdAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getClientApps(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; createClientApp(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getClientInstagramAssets(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getClientOffsiteSignalContainerBusinessObjects(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getClientPages(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; createClientPage(fields: string[], params?: Record, pathOverride?: string | null): Promise; @@ -925,9 +930,10 @@ export default class Business extends AbstractCrudObject { getInstagramBusinessAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; deleteManagedBusinesses(params?: Record): Promise; createManagedBusiness(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getManagedPartnerAdsFundingSourceDetails(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; createManagedPartnerBusinessSetup(fields: string[], params?: Record, pathOverride?: string | null): Promise; deleteManagedPartnerBusinesses(params?: Record): Promise; - createManagedPartnerBusiness(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createManagedPartnerBusiness(fields: string[], params?: Record, pathOverride?: string | null): Promise; createOnboardPartnersToMmLite(fields: string[], params?: Record, pathOverride?: string | null): Promise; getOpenBridgeConfigurations(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; createOpenBridgeConfiguration(fields: string[], params?: Record, pathOverride?: string | null): Promise; @@ -939,6 +945,7 @@ export default class Business extends AbstractCrudObject { getOwnedBusinesses(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; createOwnedBusiness(fields: string[], params?: Record, pathOverride?: string | null): Promise; getOwnedInstagramAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getOwnedInstagramAssets(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getOwnedOffsiteSignalContainerBusinessObjects(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getOwnedPages(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; createOwnedPage(fields: string[], params?: Record, pathOverride?: string | null): Promise; diff --git a/types/facebook-nodejs-business-sdk/src/objects/campaign.d.ts b/types/facebook-nodejs-business-sdk/src/objects/campaign.d.ts index 5615fbe24bd4f2..96e33404645575 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/campaign.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/campaign.d.ts @@ -141,6 +141,7 @@ export default class Campaign extends AbstractCrudObject { online_gambling_and_gaming: "ONLINE_GAMBLING_AND_GAMING"; }>; static get SpecialAdCategoryCountry(): Readonly<{ + ac: "AC"; ad: "AD"; ae: "AE"; af: "AF"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/canvas.d.ts b/types/facebook-nodejs-business-sdk/src/objects/canvas.d.ts index 45f2f4dc7c5aa8..47dfe0f8cd009d 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/canvas.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/canvas.d.ts @@ -35,7 +35,7 @@ export default class Canvas extends AbstractCrudObject { use_retailer_item_ids: "use_retailer_item_ids"; }>; getPreview(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getPreviews(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getPreViews(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; get(fields: string[], params?: Record): Promise; update(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/catalog-sub-vertical-list.d.ts b/types/facebook-nodejs-business-sdk/src/objects/catalog-sub-vertical-list.d.ts index fa3836bcf3cb7c..0187f24b3ceab3 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/catalog-sub-vertical-list.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/catalog-sub-vertical-list.d.ts @@ -21,7 +21,6 @@ export default class CatalogSubVerticalList extends AbstractCrudObject { computers_and_tablets: "computers_and_tablets"; computers_laptops_and_tablets: "computers_laptops_and_tablets"; diapering_and_potty_training: "diapering_and_potty_training"; - digital_product_offer: "digital_product_offer"; electronic_accessories_and_cables: "electronic_accessories_and_cables"; electronics_accessories: "electronics_accessories"; furniture: "furniture"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/china-business-onboarding-vetting-request.d.ts b/types/facebook-nodejs-business-sdk/src/objects/china-business-onboarding-vetting-request.d.ts index 7e44c92e996fe1..4a4b736aa1db30 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/china-business-onboarding-vetting-request.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/china-business-onboarding-vetting-request.d.ts @@ -9,9 +9,12 @@ export default class ChinaBusinessOnboardingVettingRequest extends AbstractCrudO ad_account_limit: "ad_account_limit"; ad_account_number: "ad_account_number"; ad_accounts_info: "ad_accounts_info"; + advertiser_business_id: "advertiser_business_id"; + advertiser_business_name: "advertiser_business_name"; business_manager_id: "business_manager_id"; business_registration: "business_registration"; business_registration_id: "business_registration_id"; + business_verification_status: "business_verification_status"; chinese_address: "chinese_address"; chinese_legal_entity_name: "chinese_legal_entity_name"; city: "city"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/collaborative-ads-partner-businesses.d.ts b/types/facebook-nodejs-business-sdk/src/objects/collaborative-ads-partner-businesses.d.ts index 8f265db27f77b1..fb7537296a9518 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/collaborative-ads-partner-businesses.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/collaborative-ads-partner-businesses.d.ts @@ -7,5 +7,6 @@ export default class CollaborativeAdsPartnerBusinesses extends AbstractCrudObjec static get Fields(): Readonly<{ collaborative_ads_partner_businesses_info: "collaborative_ads_partner_businesses_info"; dedicated_partner_business_info: "dedicated_partner_business_info"; + dedicated_partners_business_info: "dedicated_partners_business_info"; }>; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/commerce-merchant-settings.d.ts b/types/facebook-nodejs-business-sdk/src/objects/commerce-merchant-settings.d.ts index ddb10cbe580155..db5c7f48793720 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/commerce-merchant-settings.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/commerce-merchant-settings.d.ts @@ -7,6 +7,7 @@ import Cursor from "./../cursor"; */ export default class CommerceMerchantSettings extends AbstractCrudObject { static get Fields(): Readonly<{ + checkout_config: "checkout_config"; checkout_message: "checkout_message"; contact_email: "contact_email"; cta: "cta"; @@ -14,12 +15,17 @@ export default class CommerceMerchantSettings extends AbstractCrudObject { facebook_channel: "facebook_channel"; id: "id"; instagram_channel: "instagram_channel"; + korea_ftc_listing: "korea_ftc_listing"; merchant_page: "merchant_page"; merchant_status: "merchant_status"; + offsite_iab_checkout_enabled_countries: "offsite_iab_checkout_enabled_countries"; onsite_commerce_merchant: "onsite_commerce_merchant"; payment_provider: "payment_provider"; + privacy_policy_localized: "privacy_policy_localized"; + return_policy_localized: "return_policy_localized"; review_rejection_messages: "review_rejection_messages"; review_rejection_reasons: "review_rejection_reasons"; + shops_ads_setup: "shops_ads_setup"; terms: "terms"; }>; createAcknowledgeOrder(fields: string[], params?: Record, pathOverride?: string | null): Promise; diff --git a/types/facebook-nodejs-business-sdk/src/objects/content-delivery-report.d.ts b/types/facebook-nodejs-business-sdk/src/objects/content-delivery-report.d.ts index 67d58404f620bf..41e66c06df806b 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/content-delivery-report.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/content-delivery-report.d.ts @@ -5,10 +5,8 @@ import { AbstractCrudObject } from "./../abstract-crud-object"; */ export default class ContentDeliveryReport extends AbstractCrudObject { static get Fields(): Readonly<{ - content_name: "content_name"; - content_url: "content_url"; - creator_name: "creator_name"; - creator_url: "creator_url"; + content_id: "content_id"; + creator_id: "creator_id"; estimated_impressions: "estimated_impressions"; }>; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/copyright-ownership-transfer.d.ts b/types/facebook-nodejs-business-sdk/src/objects/copyright-ownership-transfer.d.ts new file mode 100644 index 00000000000000..85088a7823806f --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/copyright-ownership-transfer.d.ts @@ -0,0 +1,16 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * CopyrightOwnershipTransfer + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class CopyrightOwnershipTransfer extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + receiving_rights_holder: "receiving_rights_holder"; + sending_rights_holder: "sending_rights_holder"; + status: "status"; + transfer_territories: "transfer_territories"; + transfer_time: "transfer_time"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/creative-multicell-test-config.d.ts b/types/facebook-nodejs-business-sdk/src/objects/creative-multicell-test-config.d.ts index 058c1b411c4f47..e49239f53947f1 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/creative-multicell-test-config.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/creative-multicell-test-config.d.ts @@ -5,7 +5,11 @@ import { AbstractCrudObject } from "./../abstract-crud-object"; */ export default class CreativeMulticellTestConfig extends AbstractCrudObject { static get Fields(): Readonly<{ + budget_percentage: "budget_percentage"; + configured_cell_count: "configured_cell_count"; daily_budget: "daily_budget"; + entry_source: "entry_source"; lifetime_budget: "lifetime_budget"; + use_existing_daily_budget: "use_existing_daily_budget"; }>; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/ctwa-whats-app-numbers-info.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ctwa-whats-app-numbers-info.d.ts index 0b7bf824cd4921..0cb358298b05a3 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ctwa-whats-app-numbers-info.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ctwa-whats-app-numbers-info.d.ts @@ -8,6 +8,7 @@ export default class CTWAWhatsAppNumbersInfo extends AbstractCrudObject { can_manage_wa_flows: "can_manage_wa_flows"; formatted_whatsapp_number: "formatted_whatsapp_number"; is_business_number: "is_business_number"; + is_calling_enabled: "is_calling_enabled"; number_country_prefix: "number_country_prefix"; page_whatsapp_number_id: "page_whatsapp_number_id"; waba_id: "waba_id"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/ctx-default-optimization-config.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ctx-default-optimization-config.d.ts index 24b346f2734cb0..713f239c34a245 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ctx-default-optimization-config.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ctx-default-optimization-config.d.ts @@ -5,6 +5,7 @@ import { AbstractCrudObject } from "./../abstract-crud-object"; */ export default class CTXDefaultOptimizationConfig extends AbstractCrudObject { static get Fields(): Readonly<{ + destination_type: "destination_type"; objective: "objective"; optimization_goal: "optimization_goal"; }>; diff --git a/types/facebook-nodejs-business-sdk/src/objects/custom-audience-integrity-flags-and-appeal-status.d.ts b/types/facebook-nodejs-business-sdk/src/objects/custom-audience-integrity-flags-and-appeal-status.d.ts new file mode 100644 index 00000000000000..d1e3a740c1abd6 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/custom-audience-integrity-flags-and-appeal-status.d.ts @@ -0,0 +1,14 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * CustomAudienceIntegrityFlagsAndAppealStatus + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class CustomAudienceIntegrityFlagsAndAppealStatus extends AbstractCrudObject { + static get Fields(): Readonly<{ + closeout_time: "closeout_time"; + flagged_fields: "flagged_fields"; + latest_appeal_requestor: "latest_appeal_requestor"; + latest_appeal_time: "latest_appeal_time"; + restriction_status: "restriction_status"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/custom-audience.d.ts b/types/facebook-nodejs-business-sdk/src/objects/custom-audience.d.ts index 5cda4fd430a19e..e7820dbfd9dec5 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/custom-audience.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/custom-audience.d.ts @@ -65,7 +65,6 @@ export default class CustomAudience extends AbstractCrudObject { generic: "GENERIC"; home_listing: "HOME_LISTING"; hotel: "HOTEL"; - job: "JOB"; local_service_business: "LOCAL_SERVICE_BUSINESS"; media_title: "MEDIA_TITLE"; offline_product: "OFFLINE_PRODUCT"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/delivery-window.d.ts b/types/facebook-nodejs-business-sdk/src/objects/delivery-window.d.ts index d783f8889c2444..46c421354aa930 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/delivery-window.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/delivery-window.d.ts @@ -5,6 +5,7 @@ import { AbstractCrudObject } from "./../abstract-crud-object"; */ export default class DeliveryWindow extends AbstractCrudObject { static get Fields(): Readonly<{ + ac: "ac"; ad: "ad"; ae: "ae"; af: "af"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/event-tour.d.ts b/types/facebook-nodejs-business-sdk/src/objects/event-tour.d.ts deleted file mode 100644 index ece8b9b93d3e63..00000000000000 --- a/types/facebook-nodejs-business-sdk/src/objects/event-tour.d.ts +++ /dev/null @@ -1,23 +0,0 @@ -import { AbstractCrudObject } from "./../abstract-crud-object"; -/** - * EventTour - * @see {@link https://developers.facebook.com/docs/marketing-api/} - */ -export default class EventTour extends AbstractCrudObject { - static get Fields(): Readonly<{ - description: "description"; - dominant_color: "dominant_color"; - end_time: "end_time"; - id: "id"; - is_past: "is_past"; - last_event_timestamp: "last_event_timestamp"; - name: "name"; - num_events: "num_events"; - photo: "photo"; - scheduled_publish_timestamp: "scheduled_publish_timestamp"; - start_time: "start_time"; - ticketing_uri: "ticketing_uri"; - video: "video"; - }>; - get(fields: string[], params?: Record): Promise; -} diff --git a/types/facebook-nodejs-business-sdk/src/objects/event.d.ts b/types/facebook-nodejs-business-sdk/src/objects/event.d.ts index 5ee5649bc7f10c..e7ea2cbaa7e770 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/event.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/event.d.ts @@ -70,6 +70,7 @@ export default class Event extends AbstractCrudObject { }>; static get OnlineEventFormat(): Readonly<{ fb_live: "fb_live"; + horizon_event: "horizon_event"; horizon_world: "horizon_world"; messenger_room: "messenger_room"; none: "none"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/funding-source-details-coupon.d.ts b/types/facebook-nodejs-business-sdk/src/objects/funding-source-details-coupon.d.ts index 438f541f22f7d8..743aa2f02c66a4 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/funding-source-details-coupon.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/funding-source-details-coupon.d.ts @@ -7,6 +7,8 @@ export default class FundingSourceDetailsCoupon extends AbstractCrudObject { static get Fields(): Readonly<{ amount: "amount"; campaign_ids: "campaign_ids"; + child_ad_account_id: "child_ad_account_id"; + child_bm_id: "child_bm_id"; coupon_id: "coupon_id"; coupon_tiering: "coupon_tiering"; currency: "currency"; @@ -15,5 +17,6 @@ export default class FundingSourceDetailsCoupon extends AbstractCrudObject { original_amount: "original_amount"; original_display_amount: "original_display_amount"; start_date: "start_date"; + vendor_id: "vendor_id"; }>; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/home-listing.d.ts b/types/facebook-nodejs-business-sdk/src/objects/home-listing.d.ts index 7098e88036af8d..7429b1e23cfad2 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/home-listing.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/home-listing.d.ts @@ -59,6 +59,8 @@ export default class HomeListing extends AbstractCrudObject { price: "price"; property_type: "property_type"; sanitized_images: "sanitized_images"; + securitydeposit_currency: "securitydeposit_currency"; + securitydeposit_price: "securitydeposit_price"; tags: "tags"; unit_price: "unit_price"; url: "url"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/ig-comment-from-user.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ig-comment-from-user.d.ts index b9dbf62f91cd3c..0f3c5e340dcc9b 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ig-comment-from-user.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ig-comment-from-user.d.ts @@ -6,6 +6,7 @@ import { AbstractCrudObject } from "./../abstract-crud-object"; export default class IGCommentFromUser extends AbstractCrudObject { static get Fields(): Readonly<{ id: "id"; + self_ig_scoped_id: "self_ig_scoped_id"; username: "username"; }>; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/ig-media.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ig-media.d.ts index 95f33699b23d68..61f126f429feba 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ig-media.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ig-media.d.ts @@ -10,6 +10,7 @@ import ShadowIGMediaProductTags from "./shadow-ig-media-product-tags"; */ export default class IGMedia extends AbstractCrudObject { static get Fields(): Readonly<{ + alt_text: "alt_text"; boost_eligibility_info: "boost_eligibility_info"; caption: "caption"; comments_count: "comments_count"; @@ -29,6 +30,7 @@ export default class IGMedia extends AbstractCrudObject { thumbnail_url: "thumbnail_url"; timestamp: "timestamp"; username: "username"; + view_count: "view_count"; }>; getBoostAdsList(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getBrandedContentPartnerPromote(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; diff --git a/types/facebook-nodejs-business-sdk/src/objects/ig-user-export-for-cam.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ig-user-export-for-cam.d.ts index 9c6d1f9bf33620..871e7c58394b7c 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ig-user-export-for-cam.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ig-user-export-for-cam.d.ts @@ -1,16 +1,548 @@ import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; /** * IGUserExportForCAM * @see {@link https://developers.facebook.com/docs/marketing-api/} */ export default class IGUserExportForCAM extends AbstractCrudObject { static get Fields(): Readonly<{ + age_bucket: "age_bucket"; + biography: "biography"; + country: "country"; email: "email"; + gender: "gender"; + has_brand_partnership_experience: "has_brand_partnership_experience"; id: "id"; + is_account_verified: "is_account_verified"; is_paid_partnership_messages_enabled: "is_paid_partnership_messages_enabled"; messaging_id: "messaging_id"; + onboarded_status: "onboarded_status"; + past_brand_partnership_partners: "past_brand_partnership_partners"; portfolio_url: "portfolio_url"; username: "username"; }>; + static get CreatorCountries(): Readonly<{ + ac: "AC"; + ad: "AD"; + ae: "AE"; + af: "AF"; + ag: "AG"; + ai: "AI"; + al: "AL"; + am: "AM"; + an: "AN"; + ao: "AO"; + aq: "AQ"; + ar: "AR"; + as: "AS"; + at: "AT"; + au: "AU"; + aw: "AW"; + ax: "AX"; + az: "AZ"; + ba: "BA"; + bb: "BB"; + bd: "BD"; + be: "BE"; + bf: "BF"; + bg: "BG"; + bh: "BH"; + bi: "BI"; + bj: "BJ"; + bl: "BL"; + bm: "BM"; + bn: "BN"; + bo: "BO"; + bq: "BQ"; + br: "BR"; + bs: "BS"; + bt: "BT"; + bv: "BV"; + bw: "BW"; + by: "BY"; + bz: "BZ"; + ca: "CA"; + cc: "CC"; + cd: "CD"; + cf: "CF"; + cg: "CG"; + ch: "CH"; + ci: "CI"; + ck: "CK"; + cl: "CL"; + cm: "CM"; + cn: "CN"; + co: "CO"; + cr: "CR"; + cu: "CU"; + cv: "CV"; + cw: "CW"; + cx: "CX"; + cy: "CY"; + cz: "CZ"; + de: "DE"; + dj: "DJ"; + dk: "DK"; + dm: "DM"; + do: "DO"; + dz: "DZ"; + ec: "EC"; + ee: "EE"; + eg: "EG"; + eh: "EH"; + er: "ER"; + es: "ES"; + et: "ET"; + fi: "FI"; + fj: "FJ"; + fk: "FK"; + fm: "FM"; + fo: "FO"; + fr: "FR"; + ga: "GA"; + gb: "GB"; + gd: "GD"; + ge: "GE"; + gf: "GF"; + gg: "GG"; + gh: "GH"; + gi: "GI"; + gl: "GL"; + gm: "GM"; + gn: "GN"; + gp: "GP"; + gq: "GQ"; + gr: "GR"; + gs: "GS"; + gt: "GT"; + gu: "GU"; + gw: "GW"; + gy: "GY"; + hk: "HK"; + hm: "HM"; + hn: "HN"; + hr: "HR"; + ht: "HT"; + hu: "HU"; + id: "ID"; + ie: "IE"; + il: "IL"; + im: "IM"; + in: "IN"; + io: "IO"; + iq: "IQ"; + ir: "IR"; + is: "IS"; + it: "IT"; + je: "JE"; + jm: "JM"; + jo: "JO"; + jp: "JP"; + ke: "KE"; + kg: "KG"; + kh: "KH"; + ki: "KI"; + km: "KM"; + kn: "KN"; + kp: "KP"; + kr: "KR"; + kw: "KW"; + ky: "KY"; + kz: "KZ"; + la: "LA"; + lb: "LB"; + lc: "LC"; + li: "LI"; + lk: "LK"; + lr: "LR"; + ls: "LS"; + lt: "LT"; + lu: "LU"; + lv: "LV"; + ly: "LY"; + ma: "MA"; + mc: "MC"; + md: "MD"; + me: "ME"; + mf: "MF"; + mg: "MG"; + mh: "MH"; + mk: "MK"; + ml: "ML"; + mm: "MM"; + mn: "MN"; + mo: "MO"; + mp: "MP"; + mq: "MQ"; + mr: "MR"; + ms: "MS"; + mt: "MT"; + mu: "MU"; + mv: "MV"; + mw: "MW"; + mx: "MX"; + my: "MY"; + mz: "MZ"; + na: "NA"; + nc: "NC"; + ne: "NE"; + nf: "NF"; + ng: "NG"; + ni: "NI"; + nl: "NL"; + no: "NO"; + np: "NP"; + nr: "NR"; + nu: "NU"; + nz: "NZ"; + om: "OM"; + pa: "PA"; + pe: "PE"; + pf: "PF"; + pg: "PG"; + ph: "PH"; + pk: "PK"; + pl: "PL"; + pm: "PM"; + pn: "PN"; + pr: "PR"; + ps: "PS"; + pt: "PT"; + pw: "PW"; + py: "PY"; + qa: "QA"; + re: "RE"; + ro: "RO"; + rs: "RS"; + ru: "RU"; + rw: "RW"; + sa: "SA"; + sb: "SB"; + sc: "SC"; + sd: "SD"; + se: "SE"; + sg: "SG"; + sh: "SH"; + si: "SI"; + sj: "SJ"; + sk: "SK"; + sl: "SL"; + sm: "SM"; + sn: "SN"; + so: "SO"; + sr: "SR"; + ss: "SS"; + st: "ST"; + sv: "SV"; + sx: "SX"; + sy: "SY"; + sz: "SZ"; + tc: "TC"; + td: "TD"; + tf: "TF"; + tg: "TG"; + th: "TH"; + tj: "TJ"; + tk: "TK"; + tl: "TL"; + tm: "TM"; + tn: "TN"; + to: "TO"; + tr: "TR"; + tt: "TT"; + tv: "TV"; + tw: "TW"; + tz: "TZ"; + ua: "UA"; + ug: "UG"; + um: "UM"; + us: "US"; + uy: "UY"; + uz: "UZ"; + va: "VA"; + vc: "VC"; + ve: "VE"; + vg: "VG"; + vi: "VI"; + vn: "VN"; + vu: "VU"; + wf: "WF"; + ws: "WS"; + xk: "XK"; + ye: "YE"; + yt: "YT"; + za: "ZA"; + zm: "ZM"; + zw: "ZW"; + }>; + static get CreatorGender(): Readonly<{ + custom: "custom"; + female: "female"; + male: "male"; + unknown: "unknown"; + }>; + static get MajorAudienceCountries(): Readonly<{ + ac: "AC"; + ad: "AD"; + ae: "AE"; + af: "AF"; + ag: "AG"; + ai: "AI"; + al: "AL"; + am: "AM"; + an: "AN"; + ao: "AO"; + aq: "AQ"; + ar: "AR"; + as: "AS"; + at: "AT"; + au: "AU"; + aw: "AW"; + ax: "AX"; + az: "AZ"; + ba: "BA"; + bb: "BB"; + bd: "BD"; + be: "BE"; + bf: "BF"; + bg: "BG"; + bh: "BH"; + bi: "BI"; + bj: "BJ"; + bl: "BL"; + bm: "BM"; + bn: "BN"; + bo: "BO"; + bq: "BQ"; + br: "BR"; + bs: "BS"; + bt: "BT"; + bv: "BV"; + bw: "BW"; + by: "BY"; + bz: "BZ"; + ca: "CA"; + cc: "CC"; + cd: "CD"; + cf: "CF"; + cg: "CG"; + ch: "CH"; + ci: "CI"; + ck: "CK"; + cl: "CL"; + cm: "CM"; + cn: "CN"; + co: "CO"; + cr: "CR"; + cu: "CU"; + cv: "CV"; + cw: "CW"; + cx: "CX"; + cy: "CY"; + cz: "CZ"; + de: "DE"; + dj: "DJ"; + dk: "DK"; + dm: "DM"; + do: "DO"; + dz: "DZ"; + ec: "EC"; + ee: "EE"; + eg: "EG"; + eh: "EH"; + er: "ER"; + es: "ES"; + et: "ET"; + fi: "FI"; + fj: "FJ"; + fk: "FK"; + fm: "FM"; + fo: "FO"; + fr: "FR"; + ga: "GA"; + gb: "GB"; + gd: "GD"; + ge: "GE"; + gf: "GF"; + gg: "GG"; + gh: "GH"; + gi: "GI"; + gl: "GL"; + gm: "GM"; + gn: "GN"; + gp: "GP"; + gq: "GQ"; + gr: "GR"; + gs: "GS"; + gt: "GT"; + gu: "GU"; + gw: "GW"; + gy: "GY"; + hk: "HK"; + hm: "HM"; + hn: "HN"; + hr: "HR"; + ht: "HT"; + hu: "HU"; + id: "ID"; + ie: "IE"; + il: "IL"; + im: "IM"; + in: "IN"; + io: "IO"; + iq: "IQ"; + ir: "IR"; + is: "IS"; + it: "IT"; + je: "JE"; + jm: "JM"; + jo: "JO"; + jp: "JP"; + ke: "KE"; + kg: "KG"; + kh: "KH"; + ki: "KI"; + km: "KM"; + kn: "KN"; + kp: "KP"; + kr: "KR"; + kw: "KW"; + ky: "KY"; + kz: "KZ"; + la: "LA"; + lb: "LB"; + lc: "LC"; + li: "LI"; + lk: "LK"; + lr: "LR"; + ls: "LS"; + lt: "LT"; + lu: "LU"; + lv: "LV"; + ly: "LY"; + ma: "MA"; + mc: "MC"; + md: "MD"; + me: "ME"; + mf: "MF"; + mg: "MG"; + mh: "MH"; + mk: "MK"; + ml: "ML"; + mm: "MM"; + mn: "MN"; + mo: "MO"; + mp: "MP"; + mq: "MQ"; + mr: "MR"; + ms: "MS"; + mt: "MT"; + mu: "MU"; + mv: "MV"; + mw: "MW"; + mx: "MX"; + my: "MY"; + mz: "MZ"; + na: "NA"; + nc: "NC"; + ne: "NE"; + nf: "NF"; + ng: "NG"; + ni: "NI"; + nl: "NL"; + no: "NO"; + np: "NP"; + nr: "NR"; + nu: "NU"; + nz: "NZ"; + om: "OM"; + pa: "PA"; + pe: "PE"; + pf: "PF"; + pg: "PG"; + ph: "PH"; + pk: "PK"; + pl: "PL"; + pm: "PM"; + pn: "PN"; + pr: "PR"; + ps: "PS"; + pt: "PT"; + pw: "PW"; + py: "PY"; + qa: "QA"; + re: "RE"; + ro: "RO"; + rs: "RS"; + ru: "RU"; + rw: "RW"; + sa: "SA"; + sb: "SB"; + sc: "SC"; + sd: "SD"; + se: "SE"; + sg: "SG"; + sh: "SH"; + si: "SI"; + sj: "SJ"; + sk: "SK"; + sl: "SL"; + sm: "SM"; + sn: "SN"; + so: "SO"; + sr: "SR"; + ss: "SS"; + st: "ST"; + sv: "SV"; + sx: "SX"; + sy: "SY"; + sz: "SZ"; + tc: "TC"; + td: "TD"; + tf: "TF"; + tg: "TG"; + th: "TH"; + tj: "TJ"; + tk: "TK"; + tl: "TL"; + tm: "TM"; + tn: "TN"; + to: "TO"; + tr: "TR"; + tt: "TT"; + tv: "TV"; + tw: "TW"; + tz: "TZ"; + ua: "UA"; + ug: "UG"; + um: "UM"; + us: "US"; + uy: "UY"; + uz: "UZ"; + va: "VA"; + vc: "VC"; + ve: "VE"; + vg: "VG"; + vi: "VI"; + vn: "VN"; + vu: "VU"; + wf: "WF"; + ws: "WS"; + xk: "XK"; + ye: "YE"; + yt: "YT"; + za: "ZA"; + zm: "ZM"; + zw: "ZW"; + }>; + static get MajorAudienceGender(): Readonly<{ + custom: "custom"; + female: "female"; + male: "male"; + unknown: "unknown"; + }>; + getBrandedContentMedia(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getInsights(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getRecentMedia(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/ig-user-for-ig-only-api.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ig-user-for-ig-only-api.d.ts index f94116c8b34725..909db7c614144f 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ig-user-for-ig-only-api.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ig-user-for-ig-only-api.d.ts @@ -19,6 +19,7 @@ export default class IGUserForIGOnlyAPI extends AbstractCrudObject { username: "username"; website: "website"; }>; + getBusinessMessagingFeatureStatus(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getContentPublishingLimit(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getConversations(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getInsights(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; diff --git a/types/facebook-nodejs-business-sdk/src/objects/ig-user-messenger-profile.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ig-user-messenger-profile.d.ts new file mode 100644 index 00000000000000..4977b4c4648a9b --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ig-user-messenger-profile.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * IGUserMessengerProfile + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class IGUserMessengerProfile extends AbstractCrudObject { + static get Fields(): Readonly<{ + ice_breakers: "ice_breakers"; + persistent_menu: "persistent_menu"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ig-user.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ig-user.d.ts index 4a637e5d313f45..fe45659f6b6533 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ig-user.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ig-user.d.ts @@ -46,6 +46,7 @@ export default class IGUser extends AbstractCrudObject { getCatalogProductSearch(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getConnectedThreadsUser(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getContentPublishingLimit(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getCreatorMarketPlaceCreators(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getDataset(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; createDataset(fields: string[], params?: Record, pathOverride?: string | null): Promise; getInsights(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; @@ -64,5 +65,6 @@ export default class IGUser extends AbstractCrudObject { getTags(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getUpcomingEvents(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; createUpcomingEvent(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getWelcomeMessageFlows(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/image-copyright.d.ts b/types/facebook-nodejs-business-sdk/src/objects/image-copyright.d.ts index c0d7497fd90832..25e2a4bf232256 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/image-copyright.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/image-copyright.d.ts @@ -22,6 +22,7 @@ export default class ImageCopyright extends AbstractCrudObject { update_time: "update_time"; }>; static get GeoOwnership(): Readonly<{ + ac: "AC"; ad: "AD"; ae: "AE"; af: "AF"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/image-reference-match.d.ts b/types/facebook-nodejs-business-sdk/src/objects/image-reference-match.d.ts index 50a9c98578bfe2..eacabf6ced10ee 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/image-reference-match.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/image-reference-match.d.ts @@ -5,6 +5,7 @@ import { AbstractCrudObject } from "./../abstract-crud-object"; */ export default class ImageReferenceMatch extends AbstractCrudObject { static get Fields(): Readonly<{ + conflict_status: "conflict_status"; conflicting_countries: "conflicting_countries"; country_resolution_history: "country_resolution_history"; creation_time: "creation_time"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/insights-result.d.ts b/types/facebook-nodejs-business-sdk/src/objects/insights-result.d.ts index 5f575343affd37..754b2ba15fbf5e 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/insights-result.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/insights-result.d.ts @@ -30,7 +30,6 @@ export default class InsightsResult extends AbstractCrudObject { impressions: "impressions"; likes: "likes"; navigation: "navigation"; - peak_concurrent_viewers: "peak_concurrent_viewers"; plays: "plays"; profile_activity: "profile_activity"; profile_visits: "profile_visits"; @@ -42,9 +41,9 @@ export default class InsightsResult extends AbstractCrudObject { shares: "shares"; thread_replies: "thread_replies"; thread_shares: "thread_shares"; + threads_media_clicks: "threads_media_clicks"; threads_views: "threads_views"; total_interactions: "total_interactions"; - video_views: "video_views"; views: "views"; }>; static get Period(): Readonly<{ diff --git a/types/facebook-nodejs-business-sdk/src/objects/instagram-business-asset.d.ts b/types/facebook-nodejs-business-sdk/src/objects/instagram-business-asset.d.ts new file mode 100644 index 00000000000000..df02136288fb57 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/instagram-business-asset.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * InstagramBusinessAsset + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class InstagramBusinessAsset extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + ig_user_id: "ig_user_id"; + ig_username: "ig_username"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/instagram-thread.d.ts b/types/facebook-nodejs-business-sdk/src/objects/instagram-thread.d.ts new file mode 100644 index 00000000000000..2a11b764fe9405 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/instagram-thread.d.ts @@ -0,0 +1,14 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * InstagramThread + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class InstagramThread extends AbstractCrudObject { + static get Fields(): Readonly<{ + folder: "folder"; + id: "id"; + participants: "participants"; + updated_time: "updated_time"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/instagram-user.d.ts b/types/facebook-nodejs-business-sdk/src/objects/instagram-user.d.ts index 03c7adaf955eff..06c122819ac076 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/instagram-user.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/instagram-user.d.ts @@ -1,6 +1,5 @@ import { AbstractCrudObject } from "./../abstract-crud-object"; import Cursor from "./../cursor"; -import IGUpcomingEvent from "./ig-upcoming-event"; /** * InstagramUser * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -23,8 +22,6 @@ export default class InstagramUser extends AbstractCrudObject { getAgencies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getArEffects(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getAuthorizedAdAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createAuthorizedAdAccount(fields: string[], params?: Record, pathOverride?: string | null): Promise; getUpcomingEvents(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createUpcomingEvent(fields: string[], params?: Record, pathOverride?: string | null): Promise; get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/keyword-delivery-report.d.ts b/types/facebook-nodejs-business-sdk/src/objects/keyword-delivery-report.d.ts deleted file mode 100644 index ba0df8b0fc7b84..00000000000000 --- a/types/facebook-nodejs-business-sdk/src/objects/keyword-delivery-report.d.ts +++ /dev/null @@ -1,18 +0,0 @@ -import { AbstractCrudObject } from "./../abstract-crud-object"; -/** - * KeywordDeliveryReport - * @see {@link https://developers.facebook.com/docs/marketing-api/} - */ -export default class KeywordDeliveryReport extends AbstractCrudObject { - static get Fields(): Readonly<{ - estimated_clicks: "estimated_clicks"; - estimated_conversions: "estimated_conversions"; - estimated_cost: "estimated_cost"; - estimated_cpc: "estimated_cpc"; - estimated_ctr: "estimated_ctr"; - estimated_cvr: "estimated_cvr"; - estimated_impressions: "estimated_impressions"; - estimated_returns: "estimated_returns"; - keyword: "keyword"; - }>; -} diff --git a/types/facebook-nodejs-business-sdk/src/objects/lead-gen-client-validation-rules.d.ts b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-client-validation-rules.d.ts new file mode 100644 index 00000000000000..7d8d95c77b1118 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-client-validation-rules.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * LeadGenClientValidationRules + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class LeadGenClientValidationRules extends AbstractCrudObject { + static get Fields(): Readonly<{ + exclude_emoji_and_special_chars_enabled: "exclude_emoji_and_special_chars_enabled"; + max_length_value: "max_length_value"; + min_length_value: "min_length_value"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/lead-gen-form-preview-details.d.ts b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-form-preview-details.d.ts index 5cf0a38c21c1c4..765e5ecb771aa4 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/lead-gen-form-preview-details.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-form-preview-details.d.ts @@ -49,5 +49,7 @@ export default class LeadGenFormPreviewDetails extends AbstractCrudObject { social_proof_section_headers: "social_proof_section_headers"; submit_button_text: "submit_button_text"; view_file_text: "view_file_text"; + whats_app_opt_in_body: "whats_app_opt_in_body"; + whats_app_opt_in_title: "whats_app_opt_in_title"; }>; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/lead-gen-thank-you-page.d.ts b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-thank-you-page.d.ts index b02534fa0da10c..674aaef3afab32 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/lead-gen-thank-you-page.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-thank-you-page.d.ts @@ -11,6 +11,7 @@ export default class LeadGenThankYouPage extends AbstractCrudObject { button_type: "button_type"; country_code: "country_code"; enable_messenger: "enable_messenger"; + gated_file: "gated_file"; id: "id"; lead_gen_use_case: "lead_gen_use_case"; status: "status"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/lookalike-spec.d.ts b/types/facebook-nodejs-business-sdk/src/objects/lookalike-spec.d.ts index 2ffa230917f0aa..0984804e417d0a 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/lookalike-spec.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/lookalike-spec.d.ts @@ -6,7 +6,9 @@ import { AbstractCrudObject } from "./../abstract-crud-object"; export default class LookalikeSpec extends AbstractCrudObject { static get Fields(): Readonly<{ country: "country"; + is_created_by_recommended_dfca: "is_created_by_recommended_dfca"; is_financial_service: "is_financial_service"; + is_parent_lal: "is_parent_lal"; origin: "origin"; origin_event_name: "origin_event_name"; origin_event_source_name: "origin_event_source_name"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/managed-partner-business.d.ts b/types/facebook-nodejs-business-sdk/src/objects/managed-partner-business.d.ts index 526f0e0853edb7..cbb26243b1c064 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/managed-partner-business.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/managed-partner-business.d.ts @@ -13,4 +13,523 @@ export default class ManagedPartnerBusiness extends AbstractCrudObject { seller_business_status: "seller_business_status"; template: "template"; }>; + static get PartitionType(): Readonly<{ + auth: "AUTH"; + fixed: "FIXED"; + fixed_without_partition: "FIXED_WITHOUT_PARTITION"; + }>; + static get SurveyBusinessType(): Readonly<{ + advertiser: "ADVERTISER"; + agency: "AGENCY"; + app_developer: "APP_DEVELOPER"; + publisher: "PUBLISHER"; + }>; + static get TimezoneId(): Readonly<{ + value_0: "0"; + value_1: "1"; + value_2: "2"; + value_3: "3"; + value_4: "4"; + value_5: "5"; + value_6: "6"; + value_7: "7"; + value_8: "8"; + value_9: "9"; + value_10: "10"; + value_11: "11"; + value_12: "12"; + value_13: "13"; + value_14: "14"; + value_15: "15"; + value_16: "16"; + value_17: "17"; + value_18: "18"; + value_19: "19"; + value_20: "20"; + value_21: "21"; + value_22: "22"; + value_23: "23"; + value_24: "24"; + value_25: "25"; + value_26: "26"; + value_27: "27"; + value_28: "28"; + value_29: "29"; + value_30: "30"; + value_31: "31"; + value_32: "32"; + value_33: "33"; + value_34: "34"; + value_35: "35"; + value_36: "36"; + value_37: "37"; + value_38: "38"; + value_39: "39"; + value_40: "40"; + value_41: "41"; + value_42: "42"; + value_43: "43"; + value_44: "44"; + value_45: "45"; + value_46: "46"; + value_47: "47"; + value_48: "48"; + value_49: "49"; + value_50: "50"; + value_51: "51"; + value_52: "52"; + value_53: "53"; + value_54: "54"; + value_55: "55"; + value_56: "56"; + value_57: "57"; + value_58: "58"; + value_59: "59"; + value_60: "60"; + value_61: "61"; + value_62: "62"; + value_63: "63"; + value_64: "64"; + value_65: "65"; + value_66: "66"; + value_67: "67"; + value_68: "68"; + value_69: "69"; + value_70: "70"; + value_71: "71"; + value_72: "72"; + value_73: "73"; + value_74: "74"; + value_75: "75"; + value_76: "76"; + value_77: "77"; + value_78: "78"; + value_79: "79"; + value_80: "80"; + value_81: "81"; + value_82: "82"; + value_83: "83"; + value_84: "84"; + value_85: "85"; + value_86: "86"; + value_87: "87"; + value_88: "88"; + value_89: "89"; + value_90: "90"; + value_91: "91"; + value_92: "92"; + value_93: "93"; + value_94: "94"; + value_95: "95"; + value_96: "96"; + value_97: "97"; + value_98: "98"; + value_99: "99"; + value_100: "100"; + value_101: "101"; + value_102: "102"; + value_103: "103"; + value_104: "104"; + value_105: "105"; + value_106: "106"; + value_107: "107"; + value_108: "108"; + value_109: "109"; + value_110: "110"; + value_111: "111"; + value_112: "112"; + value_113: "113"; + value_114: "114"; + value_115: "115"; + value_116: "116"; + value_117: "117"; + value_118: "118"; + value_119: "119"; + value_120: "120"; + value_121: "121"; + value_122: "122"; + value_123: "123"; + value_124: "124"; + value_125: "125"; + value_126: "126"; + value_127: "127"; + value_128: "128"; + value_129: "129"; + value_130: "130"; + value_131: "131"; + value_132: "132"; + value_133: "133"; + value_134: "134"; + value_135: "135"; + value_136: "136"; + value_137: "137"; + value_138: "138"; + value_139: "139"; + value_140: "140"; + value_141: "141"; + value_142: "142"; + value_143: "143"; + value_144: "144"; + value_145: "145"; + value_146: "146"; + value_147: "147"; + value_148: "148"; + value_149: "149"; + value_150: "150"; + value_151: "151"; + value_152: "152"; + value_153: "153"; + value_154: "154"; + value_155: "155"; + value_156: "156"; + value_157: "157"; + value_158: "158"; + value_159: "159"; + value_160: "160"; + value_161: "161"; + value_162: "162"; + value_163: "163"; + value_164: "164"; + value_165: "165"; + value_166: "166"; + value_167: "167"; + value_168: "168"; + value_169: "169"; + value_170: "170"; + value_171: "171"; + value_172: "172"; + value_173: "173"; + value_174: "174"; + value_175: "175"; + value_176: "176"; + value_177: "177"; + value_178: "178"; + value_179: "179"; + value_180: "180"; + value_181: "181"; + value_182: "182"; + value_183: "183"; + value_184: "184"; + value_185: "185"; + value_186: "186"; + value_187: "187"; + value_188: "188"; + value_189: "189"; + value_190: "190"; + value_191: "191"; + value_192: "192"; + value_193: "193"; + value_194: "194"; + value_195: "195"; + value_196: "196"; + value_197: "197"; + value_198: "198"; + value_199: "199"; + value_200: "200"; + value_201: "201"; + value_202: "202"; + value_203: "203"; + value_204: "204"; + value_205: "205"; + value_206: "206"; + value_207: "207"; + value_208: "208"; + value_209: "209"; + value_210: "210"; + value_211: "211"; + value_212: "212"; + value_213: "213"; + value_214: "214"; + value_215: "215"; + value_216: "216"; + value_217: "217"; + value_218: "218"; + value_219: "219"; + value_220: "220"; + value_221: "221"; + value_222: "222"; + value_223: "223"; + value_224: "224"; + value_225: "225"; + value_226: "226"; + value_227: "227"; + value_228: "228"; + value_229: "229"; + value_230: "230"; + value_231: "231"; + value_232: "232"; + value_233: "233"; + value_234: "234"; + value_235: "235"; + value_236: "236"; + value_237: "237"; + value_238: "238"; + value_239: "239"; + value_240: "240"; + value_241: "241"; + value_242: "242"; + value_243: "243"; + value_244: "244"; + value_245: "245"; + value_246: "246"; + value_247: "247"; + value_248: "248"; + value_249: "249"; + value_250: "250"; + value_251: "251"; + value_252: "252"; + value_253: "253"; + value_254: "254"; + value_255: "255"; + value_256: "256"; + value_257: "257"; + value_258: "258"; + value_259: "259"; + value_260: "260"; + value_261: "261"; + value_262: "262"; + value_263: "263"; + value_264: "264"; + value_265: "265"; + value_266: "266"; + value_267: "267"; + value_268: "268"; + value_269: "269"; + value_270: "270"; + value_271: "271"; + value_272: "272"; + value_273: "273"; + value_274: "274"; + value_275: "275"; + value_276: "276"; + value_277: "277"; + value_278: "278"; + value_279: "279"; + value_280: "280"; + value_281: "281"; + value_282: "282"; + value_283: "283"; + value_284: "284"; + value_285: "285"; + value_286: "286"; + value_287: "287"; + value_288: "288"; + value_289: "289"; + value_290: "290"; + value_291: "291"; + value_292: "292"; + value_293: "293"; + value_294: "294"; + value_295: "295"; + value_296: "296"; + value_297: "297"; + value_298: "298"; + value_299: "299"; + value_300: "300"; + value_301: "301"; + value_302: "302"; + value_303: "303"; + value_304: "304"; + value_305: "305"; + value_306: "306"; + value_307: "307"; + value_308: "308"; + value_309: "309"; + value_310: "310"; + value_311: "311"; + value_312: "312"; + value_313: "313"; + value_314: "314"; + value_315: "315"; + value_316: "316"; + value_317: "317"; + value_318: "318"; + value_319: "319"; + value_320: "320"; + value_321: "321"; + value_322: "322"; + value_323: "323"; + value_324: "324"; + value_325: "325"; + value_326: "326"; + value_327: "327"; + value_328: "328"; + value_329: "329"; + value_330: "330"; + value_331: "331"; + value_332: "332"; + value_333: "333"; + value_334: "334"; + value_335: "335"; + value_336: "336"; + value_337: "337"; + value_338: "338"; + value_339: "339"; + value_340: "340"; + value_341: "341"; + value_342: "342"; + value_343: "343"; + value_344: "344"; + value_345: "345"; + value_346: "346"; + value_347: "347"; + value_348: "348"; + value_349: "349"; + value_350: "350"; + value_351: "351"; + value_352: "352"; + value_353: "353"; + value_354: "354"; + value_355: "355"; + value_356: "356"; + value_357: "357"; + value_358: "358"; + value_359: "359"; + value_360: "360"; + value_361: "361"; + value_362: "362"; + value_363: "363"; + value_364: "364"; + value_365: "365"; + value_366: "366"; + value_367: "367"; + value_368: "368"; + value_369: "369"; + value_370: "370"; + value_371: "371"; + value_372: "372"; + value_373: "373"; + value_374: "374"; + value_375: "375"; + value_376: "376"; + value_377: "377"; + value_378: "378"; + value_379: "379"; + value_380: "380"; + value_381: "381"; + value_382: "382"; + value_383: "383"; + value_384: "384"; + value_385: "385"; + value_386: "386"; + value_387: "387"; + value_388: "388"; + value_389: "389"; + value_390: "390"; + value_391: "391"; + value_392: "392"; + value_393: "393"; + value_394: "394"; + value_395: "395"; + value_396: "396"; + value_397: "397"; + value_398: "398"; + value_399: "399"; + value_400: "400"; + value_401: "401"; + value_402: "402"; + value_403: "403"; + value_404: "404"; + value_405: "405"; + value_406: "406"; + value_407: "407"; + value_408: "408"; + value_409: "409"; + value_410: "410"; + value_411: "411"; + value_412: "412"; + value_413: "413"; + value_414: "414"; + value_415: "415"; + value_416: "416"; + value_417: "417"; + value_418: "418"; + value_419: "419"; + value_420: "420"; + value_421: "421"; + value_422: "422"; + value_423: "423"; + value_424: "424"; + value_425: "425"; + value_426: "426"; + value_427: "427"; + value_428: "428"; + value_429: "429"; + value_430: "430"; + value_431: "431"; + value_432: "432"; + value_433: "433"; + value_434: "434"; + value_435: "435"; + value_436: "436"; + value_437: "437"; + value_438: "438"; + value_439: "439"; + value_440: "440"; + value_441: "441"; + value_442: "442"; + value_443: "443"; + value_444: "444"; + value_445: "445"; + value_446: "446"; + value_447: "447"; + value_448: "448"; + value_449: "449"; + value_450: "450"; + value_451: "451"; + value_452: "452"; + value_453: "453"; + value_454: "454"; + value_455: "455"; + value_456: "456"; + value_457: "457"; + value_458: "458"; + value_459: "459"; + value_460: "460"; + value_461: "461"; + value_462: "462"; + value_463: "463"; + value_464: "464"; + value_465: "465"; + value_466: "466"; + value_467: "467"; + value_468: "468"; + value_469: "469"; + value_470: "470"; + value_471: "471"; + value_472: "472"; + value_473: "473"; + value_474: "474"; + value_475: "475"; + value_476: "476"; + value_477: "477"; + value_478: "478"; + value_479: "479"; + value_480: "480"; + }>; + static get Vertical(): Readonly<{ + advertising: "ADVERTISING"; + automotive: "AUTOMOTIVE"; + consumer_packaged_goods: "CONSUMER_PACKAGED_GOODS"; + ecommerce: "ECOMMERCE"; + education: "EDUCATION"; + energy_and_utilities: "ENERGY_AND_UTILITIES"; + entertainment_and_media: "ENTERTAINMENT_AND_MEDIA"; + financial_services: "FINANCIAL_SERVICES"; + gaming: "GAMING"; + government_and_politics: "GOVERNMENT_AND_POLITICS"; + health: "HEALTH"; + luxury: "LUXURY"; + marketing: "MARKETING"; + non_profit: "NON_PROFIT"; + not_set: "NOT_SET"; + organizations_and_associations: "ORGANIZATIONS_AND_ASSOCIATIONS"; + other: "OTHER"; + professional_services: "PROFESSIONAL_SERVICES"; + restaurant: "RESTAURANT"; + retail: "RETAIL"; + technology: "TECHNOLOGY"; + telecom: "TELECOM"; + travel: "TRAVEL"; + }>; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/management-site-link.d.ts b/types/facebook-nodejs-business-sdk/src/objects/management-site-link.d.ts new file mode 100644 index 00000000000000..b097ce834519a0 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/management-site-link.d.ts @@ -0,0 +1,19 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ManagementSiteLink + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ManagementSiteLink extends AbstractCrudObject { + static get Fields(): Readonly<{ + ad_account_id: "ad_account_id"; + id: "id"; + link_domain: "link_domain"; + link_hash: "link_hash"; + link_image_hash: "link_image_hash"; + link_image_url: "link_image_url"; + link_title: "link_title"; + link_type: "link_type"; + link_url: "link_url"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/mcom-invoice-status.d.ts b/types/facebook-nodejs-business-sdk/src/objects/mcom-invoice-status.d.ts index edf8819c0c0bc9..ffb845464983ba 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/mcom-invoice-status.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/mcom-invoice-status.d.ts @@ -15,7 +15,10 @@ export default class McomInvoiceStatus extends AbstractCrudObject { payout_amount: "payout_amount"; slip_verification_error: "slip_verification_error"; slip_verification_status: "slip_verification_status"; + sof_transfer_id: "sof_transfer_id"; + sof_transfer_timestamp: "sof_transfer_timestamp"; transaction_fee: "transaction_fee"; transfer_slip: "transfer_slip"; + transfer_slip_qr_code: "transfer_slip_qr_code"; }>; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/message-delivery-estimate.d.ts b/types/facebook-nodejs-business-sdk/src/objects/message-delivery-estimate.d.ts index b3e905c892bc0a..77c6823c2a6353 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/message-delivery-estimate.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/message-delivery-estimate.d.ts @@ -20,6 +20,7 @@ export default class MessageDeliveryEstimate extends AbstractCrudObject { ad_recall_lift: "AD_RECALL_LIFT"; app_installs: "APP_INSTALLS"; app_installs_and_offsite_conversions: "APP_INSTALLS_AND_OFFSITE_CONVERSIONS"; + automatic_objective: "AUTOMATIC_OBJECTIVE"; conversations: "CONVERSATIONS"; derived_events: "DERIVED_EVENTS"; engaged_users: "ENGAGED_USERS"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/messenger-call-settings.d.ts b/types/facebook-nodejs-business-sdk/src/objects/messenger-call-settings.d.ts index 275aa359776b10..033c386c10cfff 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/messenger-call-settings.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/messenger-call-settings.d.ts @@ -6,6 +6,8 @@ import { AbstractCrudObject } from "./../abstract-crud-object"; export default class MessengerCallSettings extends AbstractCrudObject { static get Fields(): Readonly<{ audio_enabled: "audio_enabled"; + call_hours: "call_hours"; + call_routing: "call_routing"; icon_enabled: "icon_enabled"; }>; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/messenger-profile.d.ts b/types/facebook-nodejs-business-sdk/src/objects/messenger-profile.d.ts index b88153cf574c10..88cc0df98786b2 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/messenger-profile.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/messenger-profile.d.ts @@ -10,10 +10,8 @@ export default class MessengerProfile extends AbstractCrudObject { get_started: "get_started"; greeting: "greeting"; ice_breakers: "ice_breakers"; - payment_settings: "payment_settings"; persistent_menu: "persistent_menu"; subject_to_new_eu_privacy_rules: "subject_to_new_eu_privacy_rules"; - target_audience: "target_audience"; whitelisted_domains: "whitelisted_domains"; }>; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/omega-customer-trx.d.ts b/types/facebook-nodejs-business-sdk/src/objects/omega-customer-trx.d.ts index 856b7662c199b8..73db00a161d23b 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/omega-customer-trx.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/omega-customer-trx.d.ts @@ -26,6 +26,10 @@ export default class OmegaCustomerTrx extends AbstractCrudObject { payment_term: "payment_term"; type: "type"; }>; + static get ProductTypes(): Readonly<{ + facebook: "FACEBOOK"; + whatsapp: "WHATSAPP"; + }>; static get Type(): Readonly<{ cm: "CM"; dm: "DM"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/open-bridge-configuration.d.ts b/types/facebook-nodejs-business-sdk/src/objects/open-bridge-configuration.d.ts index 0261d386c1f52f..8ce13a02fc0eb3 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/open-bridge-configuration.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/open-bridge-configuration.d.ts @@ -18,8 +18,12 @@ export default class OpenBridgeConfiguration extends AbstractCrudObject { instance_id: "instance_id"; instance_version: "instance_version"; is_sgw_instance: "is_sgw_instance"; + is_sgw_pixel_from_meta_pixel: "is_sgw_pixel_from_meta_pixel"; partner_name: "partner_name"; pixel_id: "pixel_id"; + sgw_account_id: "sgw_account_id"; + sgw_instance_url: "sgw_instance_url"; + sgw_pixel_id: "sgw_pixel_id"; }>; delete(fields: string[], params?: Record): Promise; get(fields: string[], params?: Record): Promise; diff --git a/types/facebook-nodejs-business-sdk/src/objects/organization.d.ts b/types/facebook-nodejs-business-sdk/src/objects/organization.d.ts index e65740a3b80d29..702ff1ae8760f7 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/organization.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/organization.d.ts @@ -5,10 +5,8 @@ import { AbstractCrudObject } from "./../abstract-crud-object"; */ export default class Organization extends AbstractCrudObject { static get Fields(): Readonly<{ - hq_country: "hq_country"; id: "id"; legal_entity_name: "legal_entity_name"; - master_bm_id: "master_bm_id"; owner_business: "owner_business"; }>; get(fields: string[], params?: Record): Promise; diff --git a/types/facebook-nodejs-business-sdk/src/objects/page.d.ts b/types/facebook-nodejs-business-sdk/src/objects/page.d.ts index 6813dd6470b4ad..44ebe0db706ebf 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/page.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/page.d.ts @@ -9,7 +9,7 @@ import PageUserMessageThreadLabel from "./page-user-message-thread-label"; import Dataset from "./dataset"; import ImageCopyright from "./image-copyright"; import AdVideo from "./ad-video"; -import InstagramUser from "./instagram-user"; +import IGUser from "./ig-user"; import LeadgenForm from "./leadgen-form"; import LiveVideo from "./live-video"; import MediaFingerprint from "./media-fingerprint"; @@ -246,6 +246,7 @@ export default class Page extends AbstractCrudObject { explicit: "EXPLICIT"; explicit_imagine: "EXPLICIT_IMAGINE"; explicit_imagine_me: "EXPLICIT_IMAGINE_ME"; + explicit_restyle: "EXPLICIT_RESTYLE"; invisible_watermark: "INVISIBLE_WATERMARK"; iptc: "IPTC"; iptc_metadata_edited: "IPTC_METADATA_EDITED"; @@ -280,6 +281,7 @@ export default class Page extends AbstractCrudObject { profile_plus_create_content: "PROFILE_PLUS_CREATE_CONTENT"; profile_plus_facebook_access: "PROFILE_PLUS_FACEBOOK_ACCESS"; profile_plus_full_control: "PROFILE_PLUS_FULL_CONTROL"; + profile_plus_global_structure_management: "PROFILE_PLUS_GLOBAL_STRUCTURE_MANAGEMENT"; profile_plus_manage: "PROFILE_PLUS_MANAGE"; profile_plus_manage_leads: "PROFILE_PLUS_MANAGE_LEADS"; profile_plus_messaging: "PROFILE_PLUS_MESSAGING"; @@ -308,6 +310,7 @@ export default class Page extends AbstractCrudObject { profile_plus_create_content: "PROFILE_PLUS_CREATE_CONTENT"; profile_plus_facebook_access: "PROFILE_PLUS_FACEBOOK_ACCESS"; profile_plus_full_control: "PROFILE_PLUS_FULL_CONTROL"; + profile_plus_global_structure_management: "PROFILE_PLUS_GLOBAL_STRUCTURE_MANAGEMENT"; profile_plus_manage: "PROFILE_PLUS_MANAGE"; profile_plus_manage_leads: "PROFILE_PLUS_MANAGE_LEADS"; profile_plus_messaging: "PROFILE_PLUS_MESSAGING"; @@ -594,7 +597,7 @@ export default class Page extends AbstractCrudObject { getNotificationMessageTokens(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; createNotificationMessagesDevSupport(fields: string[], params?: Record, pathOverride?: string | null): Promise; getPageBackedInstagramAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createPageBackedInstagramAccount(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createPageBackedInstagramAccount(fields: string[], params?: Record, pathOverride?: string | null): Promise; createPageWhatsAppNumberVerification(fields: string[], params?: Record, pathOverride?: string | null): Promise; createPassThreadControl(fields: string[], params?: Record, pathOverride?: string | null): Promise; getPersonas(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-catalog-check-marketplace-partner-sellers-status.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-catalog-check-marketplace-partner-sellers-status.d.ts new file mode 100644 index 00000000000000..07d7a0b48692e2 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/product-catalog-check-marketplace-partner-sellers-status.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ProductCatalogCheckMarketplacePartnerSellersStatus + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ProductCatalogCheckMarketplacePartnerSellersStatus extends AbstractCrudObject { + static get Fields(): Readonly<{ + sample_errors: "sample_errors"; + session_id: "session_id"; + status: "status"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-catalog.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-catalog.d.ts index 9c7e084c68b665..5ff74c054d194a 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/product-catalog.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/product-catalog.d.ts @@ -49,13 +49,16 @@ export default class ProductCatalog extends AbstractCrudObject { generic: "generic"; home_listings: "home_listings"; hotels: "hotels"; - jobs: "jobs"; local_service_businesses: "local_service_businesses"; offer_items: "offer_items"; offline_commerce: "offline_commerce"; transactable_items: "transactable_items"; vehicles: "vehicles"; }>; + static get EnabledCollabTerms(): Readonly<{ + enforce_create_new_ad_account: "ENFORCE_CREATE_NEW_AD_ACCOUNT"; + enforce_share_ad_performance_access: "ENFORCE_SHARE_AD_PERFORMANCE_ACCESS"; + }>; static get PermittedRoles(): Readonly<{ admin: "ADMIN"; advertiser: "ADVERTISER"; @@ -103,6 +106,12 @@ export default class ProductCatalog extends AbstractCrudObject { video_game_consoles_and_video_games: "VIDEO_GAME_CONSOLES_AND_VIDEO_GAMES"; watches: "WATCHES"; }>; + static get EventName(): Readonly<{ + add_to_cart: "ADD_TO_CART"; + purchase: "PURCHASE"; + test: "TEST"; + view_item: "VIEW_ITEM"; + }>; deleteAgencies(params?: Record): Promise; getAgencies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; createAgency(fields: string[], params?: Record, pathOverride?: string | null): Promise; @@ -115,6 +124,7 @@ export default class ProductCatalog extends AbstractCrudObject { getCategories(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; createCategory(fields: string[], params?: Record, pathOverride?: string | null): Promise; getCheckBatchRequestStatus(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getCheckMarketplacePartnerSellersStatus(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getCollaborativeAdsLsbImageBank(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getCollaborativeAdsShareSettings(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; createCpasLsbImageBank(fields: string[], params?: Record, pathOverride?: string | null): Promise; @@ -127,6 +137,7 @@ export default class ProductCatalog extends AbstractCrudObject { getExternalEventSources(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; createExternalEventSource(fields: string[], params?: Record, pathOverride?: string | null): Promise; getFlights(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createGeolocatedItemsBatch(fields: string[], params?: Record, pathOverride?: string | null): Promise; getHomeListings(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; createHomeListing(fields: string[], params?: Record, pathOverride?: string | null): Promise; getHotelRoomsBatch(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; @@ -136,6 +147,7 @@ export default class ProductCatalog extends AbstractCrudObject { createItemsBatch(fields: string[], params?: Record, pathOverride?: string | null): Promise; createLocalizedItemsBatch(fields: string[], params?: Record, pathOverride?: string | null): Promise; createMarketPlacePartnerSellersDetail(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createMarketPlacePartnerSignal(fields: string[], params?: Record, pathOverride?: string | null): Promise; getPricingVariablesBatch(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; createPricingVariablesBatch(fields: string[], params?: Record, pathOverride?: string | null): Promise; getProductFeeds(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; @@ -147,6 +159,7 @@ export default class ProductCatalog extends AbstractCrudObject { getProductSetsBatch(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getProducts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; createProduct(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createUpdateGeneratedImageConfig(fields: string[], params?: Record, pathOverride?: string | null): Promise; getVehicleOffers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getVehicles(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; createVehicle(fields: string[], params?: Record, pathOverride?: string | null): Promise; diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-feed.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-feed.d.ts index 2e8b28760ed809..1590ad7c3111c0 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/product-feed.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/product-feed.d.ts @@ -68,6 +68,7 @@ export default class ProductFeed extends AbstractCrudObject { media_title: "MEDIA_TITLE"; offer: "OFFER"; products: "PRODUCTS"; + product_ratings_and_reviews: "PRODUCT_RATINGS_AND_REVIEWS"; transactable_items: "TRANSACTABLE_ITEMS"; vehicles: "VEHICLES"; vehicle_offer: "VEHICLE_OFFER"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-item-video-data.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-item-video-data.d.ts new file mode 100644 index 00000000000000..a112bbb8b3c413 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/product-item-video-data.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ProductItemVideoData + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ProductItemVideoData extends AbstractCrudObject { + static get Fields(): Readonly<{ + tags: "tags"; + url: "url"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-item.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-item.d.ts index b3c61541340271..ab3adc0476a5d8 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/product-item.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/product-item.d.ts @@ -16,6 +16,7 @@ export default class ProductItem extends AbstractCrudObject { brand: "brand"; bundle_items: "bundle_items"; bundle_retailer_ids: "bundle_retailer_ids"; + capabilities_disabled_by_user: "capabilities_disabled_by_user"; capability_to_review_status: "capability_to_review_status"; category: "category"; category_specific_fields: "category_specific_fields"; @@ -39,6 +40,8 @@ export default class ProductItem extends AbstractCrudObject { expiration_date: "expiration_date"; fb_product_category: "fb_product_category"; gender: "gender"; + generated_background_images: "generated_background_images"; + generated_background_images_ad_usage: "generated_background_images_ad_usage"; gtin: "gtin"; id: "id"; image_cdn_urls: "image_cdn_urls"; @@ -85,6 +88,7 @@ export default class ProductItem extends AbstractCrudObject { url: "url"; vendor_id: "vendor_id"; video_fetch_status: "video_fetch_status"; + videos: "videos"; visibility: "visibility"; wa_compliance_category: "wa_compliance_category"; }>; @@ -390,6 +394,7 @@ export default class ProductItem extends AbstractCrudObject { commerce_account_not_legally_compliant: "COMMERCE_ACCOUNT_NOT_LEGALLY_COMPLIANT"; crawled_availability_mismatch: "CRAWLED_AVAILABILITY_MISMATCH"; da_disabled_by_user: "DA_DISABLED_BY_USER"; + da_policy_unfit_for_audience: "DA_POLICY_UNFIT_FOR_AUDIENCE"; da_policy_violation: "DA_POLICY_VIOLATION"; deleted_item: "DELETED_ITEM"; digital_goods_not_available_for_checkout: "DIGITAL_GOODS_NOT_AVAILABLE_FOR_CHECKOUT"; @@ -452,7 +457,11 @@ export default class ProductItem extends AbstractCrudObject { item_stale_out_of_stock: "ITEM_STALE_OUT_OF_STOCK"; marketplace_disabled_by_user: "MARKETPLACE_DISABLED_BY_USER"; marketplace_partner_auction_no_bid_close_time: "MARKETPLACE_PARTNER_AUCTION_NO_BID_CLOSE_TIME"; + marketplace_partner_currency_not_valid: "MARKETPLACE_PARTNER_CURRENCY_NOT_VALID"; + marketplace_partner_listing_country_not_match_catalog: "MARKETPLACE_PARTNER_LISTING_COUNTRY_NOT_MATCH_CATALOG"; marketplace_partner_listing_limit_exceeded: "MARKETPLACE_PARTNER_LISTING_LIMIT_EXCEEDED"; + marketplace_partner_missing_latlong: "MARKETPLACE_PARTNER_MISSING_LATLONG"; + marketplace_partner_missing_shipping_cost: "MARKETPLACE_PARTNER_MISSING_SHIPPING_COST"; marketplace_partner_not_local_item: "MARKETPLACE_PARTNER_NOT_LOCAL_ITEM"; marketplace_partner_not_shipped_item: "MARKETPLACE_PARTNER_NOT_SHIPPED_ITEM"; marketplace_partner_policy_violation: "MARKETPLACE_PARTNER_POLICY_VIOLATION"; @@ -534,6 +543,7 @@ export default class ProductItem extends AbstractCrudObject { not_marked: "not_marked"; }>; static get OriginCountry(): Readonly<{ + ac: "AC"; ad: "AD"; ae: "AE"; af: "AF"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/robot.d.ts b/types/facebook-nodejs-business-sdk/src/objects/robot.d.ts index accb1b6cd3d701..8ab2f8004c3877 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/robot.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/robot.d.ts @@ -12,6 +12,7 @@ export default class Robot extends AbstractCrudObject { init_pos: "init_pos"; last_pos: "last_pos"; meetup_link_hash: "meetup_link_hash"; + robot_notes: "robot_notes"; suite: "suite"; target_map_image_uri: "target_map_image_uri"; target_os_image_uri: "target_os_image_uri"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/serverside/attribution-data.d.ts b/types/facebook-nodejs-business-sdk/src/objects/serverside/attribution-data.d.ts index 7bb4b32345e4ca..177cc8f4005c2a 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/serverside/attribution-data.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/serverside/attribution-data.d.ts @@ -11,6 +11,7 @@ export default class AttributionData { _attribution_share: number; _attribution_model: typeof AttributionModel; _attr_window: number; + _attribution_value: number; /** * @param {String} scope Touchpoint type * @param {Number} visit_time Time that the campaign_id or fbc was first received @@ -20,8 +21,9 @@ export default class AttributionData { * @param {Number} attribution_share Range [0-1] weight of credit assigned to the visit * @param {AttributionModel} attribution_model Attribution model used to attribute the event, check attribution-model.js file. * @param {Number} attr_window Attribution window in days. + * @param {Number} attribution_value The share of value generated by this click-conversion pair that is attributed to Meta. */ - constructor(scope?: string, visit_time?: number, ad_id?: string, adset_id?: string, campaign_id?: string, attribution_share?: number, attribution_model?: typeof AttributionModel, attr_window?: number); + constructor(scope?: string, visit_time?: number, ad_id?: string, adset_id?: string, campaign_id?: string, attribution_share?: number, attribution_model?: typeof AttributionModel, attr_window?: number, attribution_value?: number); /** * Returns the scope of the attribution data. * Exmaple: 'click'. @@ -109,12 +111,12 @@ export default class AttributionData { get attribution_share(): number; /** * Set the attribution share of the attribution data. - * @param {Number} attribution_share Time that the campaign_id or fbc was first received + * @param {Number} attribution_share Range [0-1] weight of credit assigned to the visit. */ set attribution_share(attribution_share: number); /** * Set the attribution share of the attribution data. - * @param {Number} attribution_share Time that the campaign_id or fbc was first received + * @param {Number} attribution_share Range [0-1] weight of credit assigned to the visit. * @returns {AttributionData} */ setAttributionShare(attribution_share: number): AttributionData; @@ -125,7 +127,7 @@ export default class AttributionData { get attribution_model(): typeof AttributionModel; /** * Set the attribution model of the attribution data. - * @param {typeof AttributionModel} attribution_model Advertiser attribution model + * @param {AttributionModel} attribution_model Advertiser attribution model */ set attribution_model(attribution_model: typeof AttributionModel); /** @@ -150,6 +152,22 @@ export default class AttributionData { * @returns {AttributionData} */ setAttrWindow(attr_window: number): AttributionData; + /** + * Returns the attribution value of the attribution data. + * Example: 3.45 + */ + get attribution_value(): number; + /** + * Set the attribution value of the attribution data. + * @param {Number} attribution_value The share of value generated by this click-conversion pair that is attributed to Meta. + */ + set attribution_value(attribution_value: number); + /** + * Set the attribution value of the attribution data. + * @param {Number} attribution_value The share of value generated by this click-conversion pair that is attributed to Meta. + * @returns {AttributionData} + */ + setAttributionValue(attribution_value: number): AttributionData; /** * Returns the normalized payload for the attribution data. * @returns {Object} normalized attribution data payload. diff --git a/types/facebook-nodejs-business-sdk/src/objects/serverside/custom-data.d.ts b/types/facebook-nodejs-business-sdk/src/objects/serverside/custom-data.d.ts index 16b1aba0b1beb3..946d290f2fe32e 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/serverside/custom-data.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/serverside/custom-data.d.ts @@ -5,6 +5,7 @@ import Content from "./content"; */ export default class CustomData { _value: number; + _net_revenue: number; _currency: string; _content_name: string; _content_category: string; @@ -21,6 +22,7 @@ export default class CustomData { _custom_properties: Record; /** * @param {Number} value value of the item Eg: 123.45 + * @param {Number} net_revenue net_revenue of the item Eg: 30.45 * @param {String} currency currency involved in the transaction Eg: usd * @param {String} content_name name of the Content Eg: lettuce * @param {String} content_category category of the content Eg: grocery @@ -36,7 +38,7 @@ export default class CustomData { * @param {String} delivery_category The type of delivery for a purchase event * @param {Object} custom_properties Custom Properties to be added to the Custom Data */ - constructor(value?: number, currency?: string, content_name?: string, content_category?: string, content_ids?: string[], contents?: Content[], content_type?: string, order_id?: string, predicted_ltv?: number, num_items?: number, search_string?: string, status?: string, item_number?: string, delivery_category?: string, custom_properties?: Record); + constructor(value?: number, net_revenue?: number, currency?: string, content_name?: string, content_category?: string, content_ids?: string[], contents?: Content[], content_type?: string, order_id?: string, predicted_ltv?: number, num_items?: number, search_string?: string, status?: string, item_number?: string, delivery_category?: string, custom_properties?: Record); /** * Gets the value of the custom data. * A numeric value associated with this event. This could be a monetary value or a value in some other metric. @@ -55,6 +57,24 @@ export default class CustomData { * Example: 142.54. */ setValue(value: number): CustomData; + /** + * Gets the net_revenue of the custom data. + * A numeric net_revenue associated with this event. This could be a monetary net_revenue or a net_revenue in some other metric. + * Example: 30.54. + */ + get net_revenue(): number; + /** + * Sets the net_revenue of the custom data. + * @param net_revenue A numeric net_revenue associated with this event. This could be a monetary net_revenue or a net_revenue in some other metric. + * Example: 30.54. + */ + set net_revenue(net_revenue: number); + /** + * Sets the net_revenue of the custom data. + * @param {Number} value A numeric net_revenue associated with this event. This could be a monetary net_revenue or a net_revenue in some other metric. + * Example: 30.54. + */ + setNetRevenue(net_revenue: number): CustomData; /** * Gets the currency for the custom data. * The currency for the value specified, if applicable. Currency must be a valid ISO 4217 three digit currency code. diff --git a/types/facebook-nodejs-business-sdk/src/objects/serverside/original-event-data.d.ts b/types/facebook-nodejs-business-sdk/src/objects/serverside/original-event-data.d.ts index 3b79f495b40aa1..2ee4c0bdc69aeb 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/serverside/original-event-data.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/serverside/original-event-data.d.ts @@ -4,22 +4,26 @@ export default class OriginalEventData { _event_name: string; _event_time: number; + _order_id: string; + _event_id: string; /** * @param {String} event_name A Meta pixel Standard Event or Custom Event name. * @param {Number} event_time A Unix timestamp in seconds indicating when the original event occurred. + * @param {String} order_id The order ID for this transaction as a string. + * @param {String} event_id A unique string chosen by the advertiser. */ - constructor(event_name?: string, event_time?: number); + constructor(event_name?: string, event_time?: number, order_id?: string, event_id?: string); /** - * Gets the Event Name for the current Event. + * Gets the Event Name for the original Event. */ get event_name(): string; /** - * Sets the Event Name for the current Event. + * Sets the Event Name for the original Event. * @param {String} event_name a Meta pixel Standard Event or Custom Event name. */ set event_name(event_name: string); /** - * Sets the Event Name for the current Event. + * Sets the Event Name for the original Event. * @param {String} event_name Meta pixel Standard Event or Custom Event name. */ setEventName(event_name: string): OriginalEventData; @@ -37,6 +41,34 @@ export default class OriginalEventData { * @param {Number} event_time is a Unix timestamp in seconds indicating when the original event occurred. */ setEventTime(event_time: number): OriginalEventData; + /** + * Gets the order_id of original Event. + */ + get order_id(): string; + /** + * Sets the Order ID for the original Event. + * @param {String} order_id The order ID for this transaction as a string. + */ + set order_id(order_id: string); + /** + * Sets the Order ID for the original Event. + * @param {String} order_id The order ID for this transaction as a string. + */ + setOrderID(order_id: string): OriginalEventData; + /** + * Gets the event_id of original Event. + */ + get event_id(): string; + /** + * Sets the Event ID for the original Event. + * @param {String} event_id A unique string chosen by the advertiser. + */ + set event_id(event_id: string); + /** + * Sets the Event ID for the original Event. + * @param {String} event_id A unique string chosen by the advertiser. + */ + setEventID(event_id: string): OriginalEventData; /** * Returns the normalized payload for the original event data. * @returns {Object} normalized original event data payload. diff --git a/types/facebook-nodejs-business-sdk/src/objects/serverside/server-event.d.ts b/types/facebook-nodejs-business-sdk/src/objects/serverside/server-event.d.ts index 2561a455c9a82d..10143d06028974 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/serverside/server-event.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/serverside/server-event.d.ts @@ -4,6 +4,8 @@ import CustomData from "./custom-data"; import OriginalEventData from "./original-event-data"; import UserData from "./user-data"; import type {StandardEvents} from './standard-events' + + /** * ServerEvent * @see {@link https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/server-event} @@ -51,12 +53,12 @@ export default class ServerEvent { get event_name(): StandardEvents; /** * Sets the Event Name for the current Event. - * @param {String} event_name a Facebook pixel Standard Event or Custom Event name. + * @param {StandardEvents} event_name a Facebook pixel Standard Event or Custom Event name. */ set event_name(event_name: StandardEvents); /** * Sets the Event Name for the current Event. - * @param {String} event_name Facebook pixel Standard Event or Custom Event name. + * @param {StandardEvents} event_name Facebook pixel Standard Event or Custom Event name. */ setEventName(event_name: StandardEvents): ServerEvent; /** diff --git a/types/facebook-nodejs-business-sdk/src/objects/serverside/standard-events.d.ts b/types/facebook-nodejs-business-sdk/src/objects/serverside/standard-events.d.ts index 4430bfc45213b9..0ca8319ae310bb 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/serverside/standard-events.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/serverside/standard-events.d.ts @@ -1,8 +1,8 @@ /** * StandardEvents - * + * * Represents the standard Facebook Pixel events. Allows any string but provides autocomplete for known standard events. - * + * * Reference: https://developers.facebook.com/docs/meta-pixel/reference */ export type StandardEvents = diff --git a/types/facebook-nodejs-business-sdk/src/objects/serverside/user-data.d.ts b/types/facebook-nodejs-business-sdk/src/objects/serverside/user-data.d.ts index e93bd783190f6f..bfffac34d8398a 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/serverside/user-data.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/serverside/user-data.d.ts @@ -68,13 +68,13 @@ export default class UserData { * An email address, in lowercase. * Example: joe@eg.com */ + get email(): string; /** * Sets the email address for the user data field. * @param email An email address, in lowercase. * Example: joe@eg.com */ set email(email: string); - get email(): string; /** * Gets email addresses for the user data field. * Email addresses, in lowercase. @@ -211,14 +211,14 @@ export default class UserData { * Gets the last name for the user data. * last_name is the last name in lowercase. * Example: smith - */ - get last_name(): string; - /** - * Sets the last name for the user data. - * @param last_name is last name in lowercase. - * Example: smith - */ - set last_name(last_name: string); + */ + get last_name(): string; + /** + * Sets the last name for the user data. + * @param last_name is last name in lowercase. + * Example: smith + */ + set last_name(last_name: string); /** * Gets the last names for the user data. * last_name is the last name in lowercase. diff --git a/types/facebook-nodejs-business-sdk/src/objects/shadow-ig-media-boosted-insights-result.d.ts b/types/facebook-nodejs-business-sdk/src/objects/shadow-ig-media-boosted-insights-result.d.ts deleted file mode 100644 index 0b88bedfd8d28d..00000000000000 --- a/types/facebook-nodejs-business-sdk/src/objects/shadow-ig-media-boosted-insights-result.d.ts +++ /dev/null @@ -1,15 +0,0 @@ -import { AbstractCrudObject } from "./../abstract-crud-object"; -/** - * ShadowIGMediaBoostedInsightsResult - * @see {@link https://developers.facebook.com/docs/marketing-api/} - */ -export default class ShadowIGMediaBoostedInsightsResult extends AbstractCrudObject { - static get Fields(): Readonly<{ - description: "description"; - name: "name"; - organic_media_id: "organic_media_id"; - source_type: "source_type"; - title: "title"; - values: "values"; - }>; -} diff --git a/types/facebook-nodejs-business-sdk/src/objects/shadow-ig-user-ctx-partner-app-welcome-message-flow.d.ts b/types/facebook-nodejs-business-sdk/src/objects/shadow-ig-user-ctx-partner-app-welcome-message-flow.d.ts new file mode 100644 index 00000000000000..c45ed8e9362e6d --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/shadow-ig-user-ctx-partner-app-welcome-message-flow.d.ts @@ -0,0 +1,17 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ShadowIGUserCTXPartnerAppWelcomeMessageFlow + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ShadowIGUserCTXPartnerAppWelcomeMessageFlow extends AbstractCrudObject { + static get Fields(): Readonly<{ + compatible_platforms: "compatible_platforms"; + eligible_platforms: "eligible_platforms"; + id: "id"; + is_ig_only_flow: "is_ig_only_flow"; + is_used_in_ad: "is_used_in_ad"; + last_update_time: "last_update_time"; + name: "name"; + welcome_message_flow: "welcome_message_flow"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/signal/content.d.ts b/types/facebook-nodejs-business-sdk/src/objects/signal/content.d.ts deleted file mode 100644 index c33b9831ae166b..00000000000000 --- a/types/facebook-nodejs-business-sdk/src/objects/signal/content.d.ts +++ /dev/null @@ -1,210 +0,0 @@ -import BusinessDataContent from "../businessdataapi/content"; -import ServerContent from "../serverside/content"; -/** - * UserData represents the User Data Parameters(user_data) of Business Data API and Conversion API Request. - */ -export default class Content { - _business_data_content: BusinessDataContent; - _server_content: ServerContent; - /** - * @param {String} id Product Id of the Item. - * @param {Number} quantity Quantity of the Item. - * @param {Number} price Subtotal for the content/product. - * @param {Number} item_price Price per unit of the content/product. - * @param {String} title Title of the listed Item. - * @param {String} description Product description used for the item. - * @param {String} brand Brand of the item. - * @param {String} category Category of the Item. - * @param {String} delivery_category The type of delivery for a purchase event - * @param {Number} tax Subtotal tax for the content/product. - * @param {String} external_content_id Unique ID for the contents/products that are being involved in the customer interaction. - */ - constructor(id?: string, quantity?: number, price?: number, item_price?: number, title?: string, description?: string, brand?: string, category?: string, delivery_category?: string, tax?: number, external_content_id?: string); - /** - * Gets the Product Id of the Item. - * A string representing the unique Id for the product. - * Example: XYZ. - */ - get id(): string; - /** - * Sets the Product Id of the Item. - * @param id A string representing the unique Id for the product. - * Example: XYZ. - */ - set id(id: string); - /** - * Sets the Product Id of the Item. - * @param id is a string representing the unique id for the product. - * Example: XYZ. - */ - setId(id: string): Content; - /** - * Gets the quantity of the Item. - * The number/quantity of the content that is being involved in the customer interaction. - * Example: 5 - */ - get quantity(): number; - /** - * Sets the quantity of the Item. - * @param quantity The number/quantity of the product that is being involved in the customer interaction. - * Example: 5 - */ - set quantity(quantity: number); - /** - * Sets the quantity of the Content/Item. - * @param {Number} quantity The number/quantity of the product that is being involved in the customer interaction. - * Example: 5 - */ - setQuantity(quantity: number): Content; - /** - * Gets the item price for the Product. - * The item_price or price per unit of the product. - * Example: '123.45' - */ - get item_price(): number; - /** - * Sets the item price for the Content. - * @param item_price The item_price or price per unit of the product. - * Example: '123.45' - */ - set item_price(item_price: number); - /** - * Sets the item price for the Content. - * @param {Number} item_price The item_price or price per unit of the product. - * Example: '123.45' - */ - setItemPrice(item_price: number): Content; - /** - * Gets the Title of the listed Item. - * A string representing the Title for the product. - */ - get title(): string; - /** - * Sets the Title of the listed Item. - * @param title A string representing the Title for the product. - */ - set title(title: string); - /** - * Sets the Title of the Item. - * @param title is a string representing listed title for the product. - */ - setTitle(title: string): Content; - /** - * Gets the Description of the listed Item. - * A string representing the Description for the product. - */ - get description(): string; - /** - * Sets the Description of the listed Item. - * @param description A string representing the Description for the product. - */ - set description(description: string); - /** - * Sets the Product Description of the Item. - * @param description is a string representing the description for the product. - */ - setDescription(description: string): Content; - /** - * Gets the Brand of the listed Item. - * A string representing the Brand for the product. - */ - get brand(): string; - /** - * Sets the Brand of the listed Item. - * @param brand A string representing the Brand for the product. - */ - set brand(brand: string); - /** - * Sets the Brand of the Product. - * @param brand is a string representing the Brand for the product. - */ - setBrand(brand: string): Content; - /** - * Gets the Category of the listed Item. - * A string representing the Category for the product. - */ - get category(): string; - /** - * Sets the Category of the listed Item. - * @param category A string representing the Category for the product. - */ - set category(category: string); - /** - * Sets the Category of the Product. - * @param category is a string representing the Category for the product. - */ - setCategory(category: string): Content; - /** - * Gets the delivery category. - */ - get delivery_category(): string; - /** - * Sets the type of delivery for a purchase event. - * @param delivery_category The delivery category. - */ - set delivery_category(delivery_category: string); - /** - * Sets the type of delivery for a purchase event. - * @param {String} delivery_category The delivery category. - */ - setDeliveryCategory(delivery_category: string): Content; - /** - * Gets the total tax of the Item. - * The total tax for the products that are being involved in the customer interaction. - * Example: 45.5 - */ - get tax(): number; - /** - * Sets the total tax of the Item. - * @param tax The total tax for the products that are being involved in the customer interaction. - * Example: 45.5 - */ - set tax(tax: number); - /** - * Sets the total tax of the Item. - * @param {Number} tax The total tax for the products that are being involved in the customer interaction. - * Example: 45.5 - */ - setTax(tax: number): Content; - /** - * Gets the external id for this order item - * The external id for the products that are being involved in the customer interaction. - */ - get external_content_id(): string; - /** - * Sets the external id for this order item - * @param external_content_id The external id for the products that are being involved in the customer interaction. - */ - set external_content_id(external_content_id: string); - /** - * Sets the total tax of the Item. - * @param {String} external_content_id The total tax for the products that are being involved in the customer interaction. - */ - setExternalContentId(external_content_id: string): Content; - /** - * Gets the total price of the Item. - * The total price for the products that are being involved in the customer interaction. - * Example: '123.45' - */ - get price(): number; - /** - * Sets the total price of the Item. - * @param price The total price for the products that are being involved in the customer interaction. - * Example: '123.45' - */ - set price(price: number); - /** - * Sets the total price of the Item. - * @param {Number} price The total price for the products that are being involved in the customer interaction. - * Example: '123.45' - */ - setPrice(price: number): Content; - /** - * Gets the constructed content for Business Data API - */ - get business_data_content(): BusinessDataContent; - /** - * Gets the constructed content for Conversion API - */ - get server_content(): ServerContent; -} diff --git a/types/facebook-nodejs-business-sdk/src/objects/signal/custom-data.d.ts b/types/facebook-nodejs-business-sdk/src/objects/signal/custom-data.d.ts deleted file mode 100644 index 744d1e92e1a1a4..00000000000000 --- a/types/facebook-nodejs-business-sdk/src/objects/signal/custom-data.d.ts +++ /dev/null @@ -1,403 +0,0 @@ -import BusinessDataCustomData from "../businessdataapi/custom-data"; -import ServerCustomData from "../serverside/custom-data"; -import SignalUserData from "./user-data"; -import SignalContent from "./content"; -/** - * CustomData represents the Custom Data Parameters for both Conversion API and Business Data API. - */ -export default class CustomData { - _business_data_custom_data: BusinessDataCustomData; - _server_custom_data: ServerCustomData; - /** - * params both Business Data API & Conversion API consume - * @param {Number} value value of the item Eg: 123.45 - * @param {String} currency currency involved in the transaction Eg: usd - * @param {SignalContent[]} contents Array of Content Objects. Use {Content} class to define a content. - * @param {String} order_id Unique id representing the order - * @param {String} status Status of the registration in Registration event. - * Use only with CompleteRegistration events for Conversion API. - * Use only with Purchase or UpdateOrder events for Business Data API - * params only Conversion API consumes - * @param {String} content_name name of the Content Eg: lettuce - * @param {String} content_category category of the content Eg: grocery - * @param {String[]} content_ids list of content unique ids involved in the event - * @param {String} content_type Type of the Content group or Product SKU - * @param {Number} predicted_ltv Predicted LifeTime Value for the customer involved in the event - * @param {Number} num_items Number of items involved - * @param {String} search_string query string used for the Search event - * @param {String} item_number The item number - * @param {String} delivery_category The type of delivery for a purchase event - * @param {Object} custom_properties Custom Properties to be added to the Custom Data - * params only Business Data API consumes - * @param {SignalUserData} shipping_contact Shipping contact information. User {UserData} class to define a contact. - * @param {SignalUserData} billing_contact Billing contact information. User {UserData} class to define a contact. - * @param {String} external_order_id Unique ID representing the order, universal across multiple categories from the business - * @param {String} original_order_id Original order id for refund. For Refund event only. - * @param {String} message Reason for refund. For Refund event only. - */ - constructor(value?: number, currency?: string, content_name?: string, content_category?: string, content_ids?: string[], contents?: SignalContent[], content_type?: string, order_id?: string, predicted_ltv?: number, num_items?: number, search_string?: string, status?: string, item_number?: string, delivery_category?: string, custom_properties?: Record, shipping_contact?: SignalUserData, billing_contact?: SignalUserData, external_order_id?: string, original_order_id?: string, message?: string); - /** - * Gets the value of the custom data. - * A numeric value associated with this event. This could be a monetary value or a value in some other metric. - * Example: 142.54. - */ - get value(): number; - /** - * Sets the value of the custom data. - * @param value A numeric value associated with this event. This could be a monetary value or a value in some other metric. - * Example: 142.54. - */ - set value(value: number); - /** - * Sets the value of the custom data. - * @param {Number} value A numeric value associated with this event. This could be a monetary value or a value in some other metric. - * Example: 142.54. - */ - setValue(value: number): CustomData; - /** - * Gets the currency for the custom data. - * The currency for the value specified, if applicable. Currency must be a valid ISO 4217 three digit currency code. - * Example: 'usd' - */ - get currency(): string; - /** - * Sets the currency for the custom data. - * @param currency The currency for the value specified, if applicable. Currency must be a valid ISO 4217 three digit currency code. - * Example: 'usd' - */ - set currency(currency: string); - /** - * Sets the currency for the custom data. - * @param {String} currency The currency for the value specified, if applicable. Currency must be a valid ISO 4217 three digit currency code. - * Example: 'usd' - */ - setCurrency(currency: string): CustomData; - /** - * Gets the contents for the custom data. - * An array of Content objects that contain the product IDs associated with the event plus information about the products. id, quantity, and item_price are available fields. - * Example: [{'id':'ABC123','quantity' :2,'item_price':5.99}, {'id':'XYZ789','quantity':2, 'item_price':9.99}] - */ - get contents(): SignalContent[]; - /** - * Sets the contents for the custom data. - * @param contents An array of Content objects that contain the product IDs associated with the event plus information about the products. id, quantity, and item_price are available fields. - * Example: [{'id':'ABC123','quantity' :2,'item_price':5.99}, {'id':'XYZ789','quantity':2, 'item_price':9.99}] - */ - set contents(contents: SignalContent[]); - /** - * Sets the contents for the custom data. - * @param {Content[]} contents An array of Content objects that contain the product IDs associated with the event plus information about the products. id, quantity, and item_price are available fields. - * Example: [{'id':'ABC123','quantity' :2,'item_price':5.99}, {'id':'XYZ789','quantity':2, 'item_price':9.99}] - */ - setContents(contents: SignalContent[]): CustomData; - /** - * Gets the order id for the custom data. - * order_id is the order ID for this transaction as a String. - * Example: 'order1234' - */ - get order_id(): string; - /** - * Sets the order_id for the custom data. - * @param order_id The order ID for this transaction as a String. - * Example: 'order1234' - */ - set order_id(order_id: string); - /** - * Sets the order_id for the custom data. - * @param {String} order_id The order ID for this transaction as a String. - * Example: 'order1234' - */ - setOrderId(order_id: string): CustomData; - /** - * Status of the registration in Registration event or Status of the order in Purchase/UpdateOrder event. - * - Used only with CompleteRegistration events for Conversion API. - * - Used only with Purchase or UpdateOrder events for Business Data API - */ - get status(): string; - /** - * Sets status of the registration in Registration event or status of the order in Purchase/UpdateOrder event. - * - Used only with CompleteRegistration events for Conversion API. - * - Used only with Purchase or UpdateOrder events for Business Data API - * @param status status, as a String. - */ - set status(status: string); - /** - * Sets status of the registration in Registration event or status of the order in Purchase/UpdateOrder event. - * - Used only with CompleteRegistration events for Conversion API. - * - Used only with Purchase or UpdateOrder events for Business Data API - * @param {String} status status, as a String. - */ - setStatus(status: string): CustomData; - /** - * Gets the content name for the custom data. The name of the page or product associated with the event. - * The name of the page or product associated with the event. - * Example: 'lettuce' - */ - get content_name(): string; - /** - * Sets the content name for the custom data. - * @param content_name The name of the page or product associated with the event. - * Example: 'lettuce' - */ - set content_name(content_name: string); - /** - * Sets the content name for the custom data. - * @param content_name The name of the page or product associated with the event. - * Example: 'lettuce' - */ - setContentName(content_name: string): CustomData; - /** - * Gets the content category for the custom data. - * The category of the content associated with the event. - * Example: 'grocery' - */ - get content_category(): string; - /** - * Sets the content_category for the custom data. - * @param content_category The category of the content associated with the event. - * Example: 'grocery' - */ - set content_category(content_category: string); - /** - * Sets the content_category for the custom data. - * @param content_category The category of the content associated with the event. - * Example: 'grocery' - */ - setContentCategory(content_category: string): CustomData; - /** - * Gets the content_ids for the custom data. - * The content IDs associated with the event, such as product SKUs for items in an AddToCart, represented as Array of string. - * If content_type is a product, then your content IDs must be an array with a single string value. Otherwise, this array can contain any number of string values. - * Example: ['ABC123', 'XYZ789'] - */ - get content_ids(): string[]; - /** - * Sets the content_ids for the custom data. - * @param content_ids The content IDs associated with the event, such as product SKUs for items in an AddToCart, represented as Array of string. - * If content_type is a product, then your content IDs must be an array with a single string value. Otherwise, this array can contain any number of string values. - * Example: ['ABC123', 'XYZ789'] - */ - set content_ids(content_ids: string[]); - /** - * Sets the content_ids for the custom data. - * @param {Array} content_ids The content IDs associated with the event, such as product SKUs for items in an AddToCart, represented as Array of string. - * If content_type is a product, then your content IDs must be an array with a single string value. Otherwise, this array can contain any number of string values. - * Example: ['ABC123', 'XYZ789'] - */ - setContentIds(content_ids: string[]): CustomData; - /** - * Gets the content type for the custom data. - * A String equal to either product or product_group. Set to product if the keys you send content_ids or contents represent products. - * Set to product_group if the keys you send in content_ids represent product groups. - */ - get content_type(): string; - /** - * Sets the content type for the custom data. - * A String equal to either product or product_group. Set to product if the keys you send content_ids or contents represent products. - * Set to product_group if the keys you send in content_ids represent product groups. - */ - set content_type(content_type: string); - /** - * Sets the content type for the custom data. - * @param {String} content_type A string equal to either product or product_group. Set to product if the keys you send content_ids or contents represent products. - * Set to product_group if the keys you send in content_ids represent product groups. - */ - setContentType(content_type: string): CustomData; - /** - * Gets the predicted LifeTimeValue for the (user) in custom data. - * The predicted lifetime value of a conversion event, as a String. - * Example: '432.12' - */ - get predicted_ltv(): number; - /** - * Sets the predicted LifeTimeValue for the custom data. - * @param predicted_ltv The predicted lifetime value of a conversion event, as a String. - * Example: '432.12' - */ - set predicted_ltv(predicted_ltv: number); - /** - * Sets the predicted LifeTimeValue for the custom data. - * @param {Number} predicted_ltv The predicted lifetime value of a conversion event, as a String. - * Example: '432.12' - */ - setPredictedLtv(predicted_ltv: number): CustomData; - /** - * Gets the number of items for the custom data. - * The number of items that a user tries to buy during checkout. Use only with InitiateCheckout type events. - * Example: 5 - */ - get num_items(): number; - /** - * Sets the number of items for the custom data. - * @param num_items The number of items that a user tries to buy during checkout. Use only with InitiateCheckout type events. - * Example: 5 - */ - set num_items(num_items: number); - /** - * Sets the number of items for the custom data. - * @param {Number} num_items The number of items that a user tries to buy during checkout. Use only with InitiateCheckout type events. - * Example: 5 - */ - setNumItems(num_items: number): CustomData; - /** - * Gets the search string for the custom data. - * A search query made by a user.Use only with Search events. - * Eg: 'lettuce' - */ - get search_string(): string; - /** - * Sets the search string for the custom data. - * @param {Number} search_string A search query made by a user.Use only with Search events. - * Eg: 'lettuce' - */ - set search_string(search_string: string); - /** - * Sets the search string for the custom data. - * @param search_string A search query made by a user.Use only with Search events. - * Eg: 'lettuce' - */ - setSearchString(search_string: string): CustomData; - /** - * Gets the item number. - */ - get item_number(): string; - /** - * Sets the item number. - * @param item_number The item number. - */ - set item_number(item_number: string); - /** - * Sets the item number. - * @param {String} item_number The item number. - */ - setItemNumber(item_number: string): CustomData; - /** - * Gets the delivery category. - */ - get delivery_category(): string; - /** - * Sets the type of delivery for a purchase event. - * @param delivery_category The delivery category. - */ - set delivery_category(delivery_category: string); - /** - * Sets the type of delivery for a purchase event. - * @param {String} delivery_category The delivery category. - */ - setDeliveryCategory(delivery_category: string): CustomData; - /** - * Gets the custom properties to be included in the Custom Data. - * If our predefined object properties don't suit your needs, you can include your own, custom properties. Custom properties can be used with both standard and custom events, and can help you further define custom audiences. - * This behavior is the same for Server-Side API and Facebook Pixel. - * @see {@link https://developers.facebook.com/docs/marketing-api/server-side-api/parameters/custom-data#custom-properties} - * Eg: '{ 'warehouse_location' : 'washington', 'package_size' : 'L'}' - */ - get custom_properties(): Record; - /** - * Sets the custom properties to be included in the Custom Data. - * If our predefined object properties don't suit your needs, you can include your own, custom properties. Custom properties can be used with both standard and custom events, and can help you further define custom audiences. - * This behavior is the same for Server-Side API and Facebook Pixel. - * @see {@link https://developers.facebook.com/docs/marketing-api/server-side-api/parameters/custom-data#custom-properties} - * @param {Object} custom_properties custom properties property bag to be included in the Custom Data. Eg: '{ 'warehouse_location' : 'washington', 'package_size' : 'L'}' - */ - set custom_properties(custom_properties: Record); - /** - * Sets the search string for the custom data. - * @param custom_properties A custom properties property bag to be included in the Custom Data. - * If our predefined object properties don't suit your needs, you can include your own, custom properties. Custom properties can be used with both standard and custom events, and can help you further define custom audiences. - * This behavior is the same for Server-Side API and Facebook Pixel. - * @see {@link https://developers.facebook.com/docs/marketing-api/server-side-api/parameters/custom-data#custom-properties} - * Eg: '{ 'warehouse_location' : 'washington', 'package_size' : 'L'}' - * * @returns {Object} custom_properties property bag. - */ - setCustomProperties(custom_properties: Record): CustomData; - /** - * Adds the custom property (key, value) to the custom property bag. - * @param {string} key The Key for the property to be added. - * @param {string} value The Value for the property to be added. - */ - add_custom_property(key: string, value: string): void; - /** - * Gets the shipping_contact for Purchase/Update Order event. - * shipping_contact of an order - */ - get shipping_contact(): SignalUserData; - /** - * Sets the shipping_contact for Purchase/Update Order event. - * @param shipping_contact shipping contact of an order, use {SignalUserData} to build - */ - set shipping_contact(shipping_contact: SignalUserData); - /** - * Sets the shipping_contact for Purchase/Update Order event. - * @param {SignalUserData} shipping_contact shipping contact of an order, use {SignalUserData} to build - */ - setShippingContact(shipping_contact: SignalUserData): CustomData; - /** - * Gets the billing_contact for Purchase/Update Order event. - * billing_contact of an order - */ - get billing_contact(): SignalUserData; - /** - * Sets the billing_contact for Purchase/Update Order event. - * @param billing_contact billing contact of an order, use {SignalUserData} to build - */ - set billing_contact(billing_contact: SignalUserData); - /** - * Sets the billing_contact for Purchase/Update Order event. - * @param {SignalUserData} billing_contact billing contact of an order, use {SignalUserData} to build - */ - setBillingContact(billing_contact: SignalUserData): CustomData; - /** - * Gets the unique id of the order. - * Unique ID representing the order, universal across multiple categories from the business. - */ - get external_order_id(): string; - /** - * Sets the unique id of the order. - * @param external_order_id Unique ID representing the order, universal across multiple categories from the business. - */ - set external_order_id(external_order_id: string); - /** - * Sets the unique id of the order. - * @param {String} external_order_id Unique ID representing the order, universal across multiple categories from the business. - */ - setExternalOrderId(external_order_id: string): CustomData; - /** - * Gets the unique id of the original order. - * Original order id for refund. For Refund event only. - */ - get original_order_id(): string; - /** - * Sets the unique id of the original order. - * @param original_order_id Original order id for refund. For Refund event only. - */ - set original_order_id(original_order_id: string); - /** - * Sets the unique id of the original order. - * @param {String} original_order_id Original order id for refund. For Refund event only. - */ - setOriginalOrderId(original_order_id: string): CustomData; - /** - * Gets the unique id of the original order. - * Reason for refund. For Refund event only. - */ - get message(): string; - /** - * Sets the unique id of the original order. - * @param message Reason for refund. For Refund event only. - */ - set message(message: string); - /** - * Sets the unique id of the original order. - * @param {String} message Reason for refund. For Refund event only. - */ - setMessage(message: string): CustomData; - /** - * Gets the constructed custom data for Business Data API - */ - get business_data_custom_data(): BusinessDataCustomData; - /** - * Gets the constructed custom data for Business Data API - */ - get server_custom_data(): ServerCustomData; -} diff --git a/types/facebook-nodejs-business-sdk/src/objects/signal/event-request.d.ts b/types/facebook-nodejs-business-sdk/src/objects/signal/event-request.d.ts deleted file mode 100644 index 9627799be51e93..00000000000000 --- a/types/facebook-nodejs-business-sdk/src/objects/signal/event-request.d.ts +++ /dev/null @@ -1,185 +0,0 @@ -import BusinessDataEventRequest from "../businessdataapi/event-request"; -import ServerEventRequest from "../serverside/event-request"; -import HttpServiceInterface from "../serverside/http-service-interface"; -import SignalEvent from "./event"; -/** - * EventRequest - */ -export default class EventRequest { - _business_data_event_request: BusinessDataEventRequest; - _server_event_request: ServerEventRequest; - /** - * @param {String} access_token Access Token for the user calling Graph API - * @param {String} pixel_id Pixel Id to which you are sending the events - * @param {String} page_id Page Id to which you are sending the events - * @param {SignalEvent[]} events Data for the request Payload for a Server Side Event - * @param {?String} partner_agent Platform from which the event is sent e.g. wordpress - * @param {?String} test_event_code Test Event Code used to verify that your server events are received correctly by Facebook. - * @param {?String} namespace_id Scope used to resolve extern_id or Third-party ID. Can be another data set or data partner ID. - * @param {?String} upload_id Unique id used to denote the current set being uploaded. - * @param {?String} upload_tag Tag string added to track your Offline event uploads. - * @param {?String} upload_source The origin/source of data for the dataset to be uploaded. - * @param {Boolean} debug_mode_flag Set to true if you want to enable more logging in SDK - * @param {?HttpServiceInterface} http_service Override the default http request method by setting an object that implements HttpServiceInterface - */ - constructor(access_token?: string, pixel_id?: string, page_id?: string, events?: SignalEvent[], partner_agent?: string | null, test_event_code?: string | null, namespace_id?: string | null, upload_id?: string | null, upload_tag?: string | null, upload_source?: string | null, debug_mode_flag?: boolean, http_service?: HttpServiceInterface | null); - /** - * Gets the data for the request Payload for a Server Side Event and Business Data Event. - */ - get events(): SignalEvent[]; - /** - * Sets the events for the request Payload for a Server Side Event and Business Data Event. - * @param events for the current event - */ - set events(events: SignalEvent[]); - /** - * Sets the events for the request Payload for a Server Side Event and Business Data Event. - * @param {SignalEvent[]} events for the current event - */ - setEvents(events: SignalEvent[]): EventRequest; - /** - * Gets the partner_agent for the request - * Allows you to specify the platform from which the event is sent e.g. wordpress, Zapier - */ - get partner_agent(): string; - /** - * Sets the partner_agent for the request - * Allows you to specify the platform from which the event is sent e.g. wordpress, Zapier - * @param {String} partner_agent String value for the partner agent - */ - set partner_agent(partner_agent: string); - /** - * Sets the partner_agent for the request - * Allows you to specify the platform from which the event is sent e.g. wordpress - * @param {String} partner_agent String value for the partner agent - */ - setPartnerAgent(partner_agent: string): EventRequest; - /** - * Gets the test_event_code for the request - */ - get test_event_code(): string; - /** - * Sets the test_event_code for the request - */ - set test_event_code(test_event_code: string); - /** - * Sets the test_event_code for the request - */ - setTestEventCode(test_event_code: string): EventRequest; - /** - * Gets the debug mode flag for the Graph API request - */ - get debug_mode(): boolean; - /** - * Sets the debug mode flag for the Graph API request - * @param debug_mode boolean value representing whether you want to send the request in debug mode to get detailed logging. - */ - set debug_mode(debug_mode: boolean); - /** - * Sets the debug mode flag for the Graph API request - * @param {Boolean} debug_mode boolean value representing whether you want to send the request in debug mode to get detailed logging. - */ - setDebugMode(debug_mode: boolean): EventRequest; - /** - * Gets the access token for the Graph API request - */ - get access_token(): string; - /** - * Sets the access token for the Graph API request - * @param access_token string representing the access token that is used to make the Graph API. - */ - set access_token(access_token: string); - /** - * Sets the access token for the Graph API request - * @param {String} access_token string representing the access token that is used to make the Graph API. - */ - setAccessToken(access_token: string): EventRequest; - /** - * Gets the pixel against which we send the events - */ - get pixel_id(): string; - /** - * Sets the pixel against which we send the events - * @param {String} pixel_id string value representing the Pixel's Id to which you are sending the events. - */ - set pixel_id(pixel_id: string); - /** - * Sets the pixel against which we send the events - * @param {String} pixel_id String value for the pixel_id against which you want to send the events. - */ - setPixelId(pixel_id: string): EventRequest; - /** - * Gets the NamespaceId for the events - */ - get namespace_id(): string; - /** - * Sets the namespace_id for the events - * @param {String} namespace_id Scope used to resolve extern_id or Third-party ID. Can be another data set or data partner ID. - */ - set namespace_id(namespace_id: string); - /** - * Sets the namespace_id for the events - * @param {String} namespace_id Scope used to resolve extern_id or Third-party ID. Can be another data set or data partner ID. - */ - setNamespaceId(namespace_id: string): EventRequest; - /** - * Gets the Upload Tag for the current events upload - */ - get upload_tag(): string; - /** - * Sets the upload_tag for the current events upload - * @param {String} upload_tag Tag string added to Track your Offline event uploads - */ - set upload_tag(upload_tag: string); - /** - * Sets the upload_tag for the current events upload - * @param {String} upload_tag Tag string added to Track your Offline event uploads - */ - setUploadTag(upload_tag: string): EventRequest; - /** - * Gets the Upload Tag for the current events upload - */ - get upload_id(): string; - /** - * Sets the upload_id for the current events upload - * @param {String} upload_id Unique id used to denote the current set being uploaded - */ - set upload_id(upload_id: string); - /** - * Sets the upload_id for the current events upload - * @param {String} upload_id Unique id used to denote the current set being uploaded - */ - setUploadId(upload_id: string): EventRequest; - /** - * Gets the Upload Tag for the current events upload - */ - get upload_source(): string; - /** - * Sets the upload_source for the current events upload - * @param {String} upload_source origin/source of data for the dataset to be uploaded. - */ - set upload_source(upload_source: string); - /** - * Sets the upload_source for the current events upload - * @param {String} upload_source origin/source of data for the dataset to be uploaded. - */ - setUploadSource(upload_source: string): EventRequest; - /** - * Gets the http_service object for making the events request - */ - get http_service(): HttpServiceInterface; - /** - * Sets the http_service object for making the events request - * @param {HttpServiceInterface} http_service - */ - set http_service(http_service: HttpServiceInterface); - /** - * Sets the http_service object for making the events request - * @param {HttpServiceInterface} http_service - */ - setHttpService(http_service: HttpServiceInterface): EventRequest; - /** - * Executes the current event_request data by making a call to the Facebook Graph API. - */ - execute(): Promise>; -} diff --git a/types/facebook-nodejs-business-sdk/src/objects/signal/event.d.ts b/types/facebook-nodejs-business-sdk/src/objects/signal/event.d.ts deleted file mode 100644 index 2dd3ee500c3479..00000000000000 --- a/types/facebook-nodejs-business-sdk/src/objects/signal/event.d.ts +++ /dev/null @@ -1,195 +0,0 @@ -import SignalUserData from "./user-data"; -import SignalCustomData from "./custom-data"; -import BusinessDataEvent from "../businessdataapi/event"; -import ServerEvent from "../serverside/server-event"; -/** - * SignalEvent, event data for both Conversion API and Business Data API - */ -export default class Event { - _business_data_event: BusinessDataEvent; - _server_event: ServerEvent; - /** - * @param {String} event_name A Facebook pixel Standard Event or Custom Event name. - * @param {Number} event_time A Unix timestamp in seconds indicating when the actual event occurred. - * @param {String} event_source_url The browser URL where the event happened. - * @param {String} event_id This ID can be any string chosen by the advertiser. - * @param {String} action_source A string that indicates where the event took place. - * @param {Boolean} opt_out A flag that indicates we should not use this event for ads delivery optimization. - * @param {SignalUserData} user_data SignalUserData contains user data for both Business Data API and Conversion API - * @param {SignalCustomData} custom_data SignalCustomData contains custom data for both Business Data API and Conversion API - * @param {string[]} data_processing_options Processing options you would like to enable for a specific event. - * @param {Number} data_processing_options_country A country that you want to associate to this data processing option. - * @param {Number} data_processing_options_state A state that you want to associate with this data processing option. - */ - constructor(event_name?: string, event_time?: number, event_source_url?: string, user_data?: SignalUserData, custom_data?: SignalCustomData, event_id?: string, opt_out?: boolean, action_source?: string, data_processing_options?: string[], data_processing_options_country?: number, data_processing_options_state?: number); - /** - * Gets the Event Name for the current Event. - */ - get event_name(): string; - /** - * Sets the Event Name for the current Event. - * @param {String} event_name a Facebook pixel Standard Event or Custom Event name. - */ - set event_name(event_name: string); - /** - * Sets the Event Name for the current Event. - * @param {String} event_name Facebook pixel Standard Event or Custom Event name. - */ - setEventName(event_name: string): Event; - /** - * Gets the Event Time when the current Event happened. - */ - get event_time(): number; - /** - * Sets the Event Time when the current Event happened. - * @param {Number} event_time is a Unix timestamp in seconds indicating when the actual event occurred. - */ - set event_time(event_time: number); - /** - * Sets the Event Time when the current Event happened. - * @param {Number} event_time is a Unix timestamp in seconds indicating when the actual event occurred. - */ - setEventTime(event_time: number): Event; - /** - * Gets the browser url source for the current event. - */ - get event_source_url(): string; - /** - * Sets the browser url source for the current event. - * @param {String} event_source_url The browser URL where the event happened. - */ - set event_source_url(event_source_url: string); - /** - * Sets the browser url source for the current event. - * @param {String} event_source_url The browser URL where the event happened. - */ - setEventSourceUrl(event_source_url: string): Event; - /** - * Gets the event_id for the current Event. - */ - get event_id(): string; - /** - * Sets the event Id for the current Event. - * @param {String} event_id can be any string chosen by the advertiser. This is used with event_name to determine if events are identical for Conversion API. - */ - set event_id(event_id: string); - /** - * Sets the event Id for the current Event. - * @param {String} event_id can be any string chosen by the advertiser. This is used with event_name to determine if events are identical for Conversion API. - */ - setEventId(event_id: string): Event; - /** - * Gets the action_source for the current event. The Action Source represents where the action took place. - */ - get action_source(): string; - /** - * Sets the action_source for the current event. - * @param {String} action_source represents where the action took place. One of {'physical_store','app','chat','email','other','phone_call','system_generated','website'} - */ - set action_source(action_source: string); - /** - * Sets the action_source for the current event. - * @param {String} action_source represents where the action took place. One of {'physical_store','app','chat','email','other','phone_call','system_generated','website'} - */ - setActionSource(action_source: string): Event; - /** - * Gets the opt_out feature for the current event.opt_out is a boolean flag that indicates we should not use this event for ads delivery optimization. If set to true, we only use the event for attribution. - */ - get opt_out(): boolean; - /** - * Sets the opt_out feature for the current event. - * @param {Boolean} opt_out is a boolean flag that indicates we should not use this event for ads delivery optimization. If set to true, we only use the event for attribution. - */ - set opt_out(opt_out: boolean); - /** - * Sets the opt_out feature for the current event. - * @param {Boolean} opt_out is a boolean flag that indicates we should not use this event for ads delivery optimization. If set to true, we only use the event for attribution. - */ - setOptOut(opt_out: boolean): Event; - /** - * Gets the user data objects for Business Data API and Conversion API. - * @param user_data contains user data, use SignalUserData to construct - */ - get user_data(): SignalUserData; - /** - * Sets the user data objects for Business Data API and Conversion API. - * @param user_data contains user data, use SignalUserData to construct - */ - set user_data(user_data: SignalUserData); - /** - * Sets the user data objects for Business Data API and Conversion API. - * @param {SignalUserData} user_data contains user data, use SignalUserData to construct - */ - setUserData(user_data: SignalUserData): Event; - /** - * Gets the custom data objects for Business Data API and Conversion API. - */ - get custom_data(): SignalCustomData; - /** - * Sets the custom data objects for Business Data API and Conversion API. - * @param custom_data contains custom data, use SignalCustomData to construct - */ - set custom_data(custom_data: SignalCustomData); - /** - * Sets the custom data objects for Business Data API and Conversion API. - * @param {SignalCustomData} custom_data contains custom data, use SignalCustomData to construct - */ - setCustomData(custom_data: SignalCustomData): Event; - /** - * Gets the data_processing_options for the current event. - * Processing options you would like to enable for a specific event. - */ - get data_processing_options(): string[]; - /** - * Sets the data_processing_options for the current event. - * @param {string[]} data_processing_options represents Data processing options you would like to enable for a specific event, e.g. [] or ['LDU'] - */ - set data_processing_options(data_processing_options: string[]); - /** - * Sets the data_processing_options for the current event. - * @param {string[]} data_processing_options represents Data processing options you would like to enable for a specific event, e.g. [] or ['LDU'] - */ - setDataProcessingOptions(data_processing_options: string[]): Event; - /** - * Gets the data_processing_options_country for the current event. - * A country that you want to associate to this data processing option. - */ - get data_processing_options_country(): number; - /** - * Sets the data_processing_options_country for the current event. - * @param {number} data_processing_options_country represents country that you want to associate to this data processing option. - */ - set data_processing_options_country(data_processing_options_country: number); - /** - * Sets the data_processing_options_country for the current event. - * @param {number} data_processing_options_country represents country that you want to associate to this data processing option. - */ - setDataProcessingOptionsCountry(data_processing_options_country: number): Event; - /** - * Gets the data_processing_options_state for the current event. - * A state that you want to associate with this data processing option. - */ - get data_processing_options_state(): number; - /** - * Sets the data_processing_options_state for the current event. - * @param {number} data_processing_options_state represents state that you want to associate with this data processing option. - */ - set data_processing_options_state(data_processing_options_state: number); - /** - * Sets the data_processing_options_state for the current event. - * @param {number} data_processing_options_state represents state that you want to associate with this data processing option. - */ - setDataProcessingOptionsState(data_processing_options_state: number): Event; - /** - * Gets the constructed custom data for Business Data API - */ - get business_data_event(): BusinessDataEvent; - /** - * Gets the constructed custom data for Business Data API - */ - get server_event(): ServerEvent; - /** - * Convert to Json object for api call - */ - toJson(): Record; -} diff --git a/types/facebook-nodejs-business-sdk/src/objects/signal/user-data.d.ts b/types/facebook-nodejs-business-sdk/src/objects/signal/user-data.d.ts deleted file mode 100644 index 4862b4eabbe943..00000000000000 --- a/types/facebook-nodejs-business-sdk/src/objects/signal/user-data.d.ts +++ /dev/null @@ -1,463 +0,0 @@ -import BusinessDataUserData from "../businessdataapi/user-data"; -import ServerUserData from "../serverside/user-data"; -/** - * UserData represents the User Data Parameters(user_data) of Business Data API and Conversion API Request. - */ -export default class UserData { - _business_data_user_data: BusinessDataUserData; - _server_user_data: ServerUserData; - /** - * @param {String} email An email address, in lowercase. - * @param {String} phone A phone number. Include only digits with country code, area code, and number. - * @param {String} first_name A first name in lowercase. - * @param {String} last_name A last name in lowercase. - * @param {String} date_of_birth A date of birth given as year, month, and day in YYYYMMDD format. - * @param {String} city A city in lower-case without spaces or punctuation. - * @param {String} state A two-letter state code in lowercase. - * @param {String} country A two-letter country code in lowercase. - * @param {String} zip Postal code of the city in your country standard - * @param {String} external_id Any unique ID from the advertiser, - * @param {String} gender Gender, in lowercase. Either f or m. - * @param {String} client_ip_address The IP address of the browser corresponding to the event. - * @param {String} client_user_agent The user agent for the browser corresponding to the event. - * @param {String} fbp The Facebook browser ID value stored in the _fbp browser cookie under your domain. - * @param {String} fbc The Facebook click ID value stored in the _fbc browser cookie under your domain. - * @param {String} subscription_id The subscription ID for the user in this transaction. - * @param {String} fb_login_id The FB login ID for the user. - * @param {String} lead_id The Id associated with a lead generated by Facebook's Lead Ads. - * @param {String} dobd The date of birth day in DD format. - * @param {String} dobm The date of birth month in MM format. - * @param {String} doby The date of birth year in YYYY format. - * @param {String} f5first The first 5 characters of the first name. - * @param {String} f5last The first 5 characters of the last name. - * @param {String} fi The first Name Initial - * @param {String} address An physical address. - */ - constructor(email?: string, phone?: string, first_name?: string, last_name?: string, date_of_birth?: string, city?: string, state?: string, zip?: string, country?: string, external_id?: string, gender?: string, client_ip_address?: string, client_user_agent?: string, fbp?: string, fbc?: string, subscription_id?: string, fb_login_id?: string, lead_id?: string, dobd?: string, dobm?: string, doby?: string, f5first?: string, f5last?: string, fi?: string, address?: string); - /** - * Gets the email address for the user data field. - * An email address, in lowercase. - * Example: joe@eg.com - */ - get email(): string; - /** - * Sets the email address for the user data field. - * @param email An email address, in lowercase. - * Example: joe@eg.com - */ - set email(email: string); - /** - * Sets the email address for the user data field. - * @param {String} email An email address, in lowercase. - * Example: joe@eg.com - */ - setEmail(email: string): UserData; - /** - * Gets the phone number for the user data. - * A phone number. Include only digits with country code, area code, and number. - * Example: 16505551212 - */ - get phone(): string; - /** - * Sets the phone number for the user data. - * @param phone A phone number. Include only digits with country code, area code, and number. - * Example: 16505551212 - */ - set phone(phone: string); - /** - * Sets the phone number for the user data. - * @param {String} phone A phone number. Include only digits with country code, area code, and number. - * Example: 16505551212 - */ - setPhone(phone: string): UserData; - /** - * Gets the date of birth for the user data. - * A date of birth given as year, month, and day in the Format YYYYMMDD - * Example: 19971226 for December 26, 1997. - */ - get date_of_birth(): string; - /** - * Sets the date of birth for the user data. - * @param date_of_birth A date of birth given as year, month, and day in the Format YYYYMMDD - * Example: 19971226 for December 26, 1997. - */ - set date_of_birth(date_of_birth: string); - /** - * Sets the date of birth for the user data. - * @param {String} date_of_birth A date of birth given as year, month, and day in the Format YYYYMMDD - * Example: 19971226 for December 26, 1997. - */ - setDateOfBirth(date_of_birth: string): UserData; - /** - * Gets the last name for the user data. - * last_name is the last name in lowercase. - * Example: smith - */ - get last_name(): string; - /** - * Sets the last name for the user data. - * @param last_name is last name in lowercase. - * Example: smith - */ - set last_name(last_name: string); - /** - * Sets the last name for the user data. - * @param {String} last_name is last name in lowercase. - * Example: smith - */ - setLastName(last_name: string): UserData; - /** - * Gets the first name for the user data. - * first_name is first name in lowercase. - * Example: joe - */ - get first_name(): string; - /** - * Sets the first name for the user data. - * @param first_name is first name in lowercase. - * Example: joe - */ - set first_name(first_name: string); - /** - * Sets the first name for the user data. - * @param {String} first_name is first name in lowercase. - * Example: joe - */ - setFirstName(first_name: string): UserData; - /** - * Gets the city for the user data. - * city is city in lower-case without spaces or punctuation. - * Example: menlopark - */ - get city(): string; - /** - * Sets the city for the user data. - * @param city is city in lower-case without spaces or punctuation. - * Example: menlopark - */ - set city(city: string); - /** - * Sets the city for the user data. - * @param {String} city is city in lower-case without spaces or punctuation. - * Example: menlopark - */ - setCity(city: string): UserData; - /** - * Gets the zip/postal code for the user data. - * zip is a five-digit zip code for United States.For other locations, follow each country's standards. - * Example: 98121 (for United States zip code) - */ - get zip(): string; - /** - * Sets the zip/postal code for the user data. - * @param zip is a five-digit zip code for United States.For other locations, follow each country's standards. - * Example: 98121 (for United States zip code) - */ - set zip(zip: string); - /** - * Sets the zip/postal code for the user data. - * @param {String} zip is a five-digit zip code for United States.For other locations, follow each country's standards. - * Example: 98121 (for United States zip code) - */ - setZip(zip: string): UserData; - /** - * Gets the state for the user data. - * state is state in lower-case without spaces or punctuation. - * Example: ca - */ - get state(): string; - /** - * Sets the state for the user data. - * @param state is state in lower-case without spaces or punctuation. - * Example: ca - */ - set state(state: string); - /** - * Sets the state for the user data. - * @param {String} state is state in lower-case without spaces or punctuation. - * Example: ca - */ - setState(state: string): UserData; - /** - * Gets the country for the user data. - * country is A two-letter country code in lowercase. - * Example: usa - */ - get country(): string; - /** - * Sets the country for the user data. - * @param country is A two-letter country code in lowercase. - * Example: usa - */ - set country(country: string); - /** - * Sets the country for the user data. - * @param {String} country is A two-letter country code in lowercase. - * Example: usa - */ - setCountry(country: string): UserData; - /** - * Gets the external id for the user data. - * external_id is a unique ID from the advertiser, such as loyalty membership IDs, user IDs, and external cookie IDs. - * In the Offline Conversions API this is known as extern_id. For more information, see Offline Conversions. - * If External ID is being sent via other channels, then it should be sent in the same format via the server-side API - * @see {@link https://www.facebook.com/business/help/104039186799009} - */ - get external_id(): string; - /** - * Sets the external id for the user data. - * @param external_id is a unique ID from the advertiser, such as loyalty membership IDs, user IDs, and external cookie IDs. - * In the Offline Conversions API this is known as extern_id. For more information, see Offline Conversions. - * If External ID is being sent via other channels, then it should be sent in the same format via the server-side API - * @see {@link https://www.facebook.com/business/help/104039186799009} - */ - set external_id(external_id: string); - /** - * Sets the external id for the user data. - * @param {String} external_id is a unique ID from the advertiser, such as loyalty membership IDs, user IDs, and external cookie IDs. - * In the Offline Conversions API this is known as extern_id. For more information, see Offline Conversions. - * If External ID is being sent via other channels, then it should be sent in the same format via the server-side API - * @see {@link https://www.facebook.com/business/help/104039186799009} - */ - setExternalId(external_id: string): UserData; - /** - * Gets the gender value for the user data. - * Gender in lowercase. Either f for FEMALE or m for MALE. - * Example: f - */ - get gender(): string; - /** - * Sets the gender value for the user data. - * @param gender Gender in lowercase. Either f for FEMALE or m for MALE. - * Example: f - */ - set gender(gender: string); - /** - * Sets the gender value for the user data. - * @param {String} gender Gender in lowercase. Either f for FEMALE or m for MALE. - * Example: f - */ - setGender(gender: string): UserData; - /** - * Gets the client ip address for the user data. - * client_ip_address is the IP address of the browser corresponding to the event. - */ - get client_ip_address(): string; - /** - * Sets the client ip address for the user data. - * @param client_ip_address is the IP address of the browser corresponding to the event. - */ - set client_ip_address(client_ip_address: string); - /** - * Sets the client ip address for the user data. - * @param {String} client_ip_address is the IP address of the browser corresponding to the event. - */ - setClientIpAddress(client_ip_address: string): UserData; - /** - * Gets the client user agent for the user data. - * client_user_agent is the user agent for the browser corresponding to the event. - */ - get client_user_agent(): string; - /** - * Sets the client user agent for the user data. - * @param client_user_agent is the user agent for the browser corresponding to the event. - */ - set client_user_agent(client_user_agent: string); - /** - * Sets the client user agent for the user data. - * @param {String} client_user_agent is the user agent for the browser corresponding to the event. - */ - setClientUserAgent(client_user_agent: string): UserData; - /** - * Gets the fbc for the user data. - * fbc is the Facebook click ID value stored in the _fbc browser cookie under your domain. - * See Managing fbc and fbp Parameters for how to get this value @see {@link https://developers.facebook.com/docs/marketing-api/facebook-pixel/server-side-api/parameters#fbc}, - * You can also generate this value from a fbclid query parameter. - */ - get fbc(): string; - /** - * Sets the fbc for the user data. - * @param fbc is the Facebook click ID value stored in the _fbc browser cookie under your domain. - * See Managing fbc and fbp Parameters for how to get this value @see {@link https://developers.facebook.com/docs/marketing-api/facebook-pixel/server-side-api/parameters#fbc}, - * You can also generate this value from a fbclid query parameter. - */ - set fbc(fbc: string); - /** - * Sets the fbc for the user data. - * @param {String} fbc is the Facebook click ID value stored in the _fbc browser cookie under your domain. - * See Managing fbc and fbp Parameters for how to get this value @see {@link https://developers.facebook.com/docs/marketing-api/facebook-pixel/server-side-api/parameters#fbc}, - * You can also generate this value from a fbclid query parameter. - */ - setFbc(fbc: string): UserData; - /** - * Gets the fbp for the user data. - * fbp is Facebook browser ID value stored in the _fbp browser cookie under your domain. - * See Managing fbc and fbp Parameters for how to get this value @see {@link https://developers.facebook.com/docs/marketing-api/facebook-pixel/server-side-api/parameters#fbp}, - */ - get fbp(): string; - /** - * Sets the fbp for the user data. - * @param fbp is Facebook browser ID value stored in the _fbp browser cookie under your domain. - * See Managing fbc and fbp Parameters for how to get this value @see {@link https://developers.facebook.com/docs/marketing-api/facebook-pixel/server-side-api/parameters#fbp}, - */ - set fbp(fbp: string); - /** - * Sets the fbp for the user data. - * @param {String} fbp is Facebook browser ID value stored in the _fbp browser cookie under your domain. - * See Managing fbc and fbp Parameters for how to get this value @see {@link https://developers.facebook.com/docs/marketing-api/facebook-pixel/server-side-api/parameters#fbp}, - */ - setFbp(fbp: string): UserData; - /** - * Gets the subscription id for the user data. - * @return subscription_id is the subscription ID for the user in this transaction. This is similar to the order ID for an individual product. - * Example: anid1234. - */ - get subscription_id(): string; - /** - * Sets the subscription id for the user data. - * @param {String} subscription_id is the subscription ID for the user in this transaction. This is similar to the order ID for an individual product. - * Example: anid1234. - */ - set subscription_id(subscription_id: string); - /** - * Sets the subscription id for the user data. - * @param {String} subscription_id is the subscription ID for the user in this transaction. This is similar to the order ID for an individual product. - * Example: anid1234. - */ - setSubscriptionId(subscription_id: string): UserData; - /** - * Gets the fb_login_id for the user data. - */ - get fb_login_id(): string; - /** - * Sets the fb_login_id for the user data. - * @param fb_login_id - */ - set fb_login_id(fb_login_id: string); - /** - * Sets the fb_login_id for the user data. - * @param {String} fb_login_id - */ - setFbLoginId(fb_login_id: string): UserData; - /** - * Gets the lead_id for the user data. Lead ID is associated with a lead generated by Facebook's Lead Ads. - */ - get lead_id(): string; - /** - * Sets the lead_id for the user data. Lead ID is associated with a lead generated by Facebook's Lead Ads. - * @param lead_id - */ - set lead_id(lead_id: string); - /** - * Sets the lead_id for the user data. Lead ID is associated with a lead generated by Facebook's Lead Ads. - * @param {String} lead_id - */ - setLeadId(lead_id: string): UserData; - /** - * Gets the first 5 characters of the FirstName. - */ - get f5first(): string; - /** - * Sets the Gets the first 5 characters of the FirstName. - * @param f5first - */ - set f5first(f5first: string); - /** - * Sets the first 5 characters of the FirstName. - * @param {String} f5first - */ - setF5First(f5first: string): UserData; - /** - * Gets the first 5 characters of the LastName. - */ - get f5last(): string; - /** - * Sets the first 5 characters of the LastName. - * @param f5last - */ - set f5last(f5last: string); - /** - * Sets the first 5 characters of the LastName. - * @param {String} f5last - */ - setF5Last(f5last: string): UserData; - /** - * Gets the first Name Initial. - */ - get fi(): string; - /** - * Sets the first Name Initial. - * @param fi - */ - set fi(fi: string); - /** - * Sets the first Name Initial. - * @param {String} fi - */ - setFi(fi: string): UserData; - /** - * Gets the date of birth day. - */ - get dobd(): string; - /** - * Sets the date of birth day. - * @param dobd - */ - set dobd(dobd: string); - /** - * Sets the date of birth day. - * @param {String} dobd - */ - setDobd(dobd: string): UserData; - /** - * Gets the date of birth month. - */ - get dobm(): string; - /** - * Sets the date of birth month. - * @param dobm - */ - set dobm(dobm: string); - /** - * Sets the date of birth month. - * @param {String} dobm - */ - setDobm(dobm: string): UserData; - /** - * Gets the date of birth year. - */ - get doby(): string; - /** - * Sets the date of birth year. - * @param {String} doby - */ - set doby(doby: string); - /** - * Sets the date of birth year. - * @param {String} doby - */ - setDoby(doby: string): UserData; - /** - * Gets the address for the user data. - * address is a physical address - */ - get address(): string; - /** - * Sets the address for the user data. - * @param address is a physical address - */ - set address(address: string); - /** - * Sets the date of birth year. - * @param {String} address - */ - setAddress(address: string): UserData; - /** - * Gets the user_data for the Business Data API. - */ - get business_data_user_data(): BusinessDataUserData; - /** - * Gets the user_data for the Conversion API. - */ - get server_user_data(): ServerUserData; -} diff --git a/types/facebook-nodejs-business-sdk/src/objects/signal/utils.d.ts b/types/facebook-nodejs-business-sdk/src/objects/signal/utils.d.ts deleted file mode 100644 index 913b45878275ff..00000000000000 --- a/types/facebook-nodejs-business-sdk/src/objects/signal/utils.d.ts +++ /dev/null @@ -1,12 +0,0 @@ -/** - * Utils contains the Utility modules used for sending Signal Events - */ -export default class Utils { - /** - * construct set method return - * @param any server_return - * @param any bdapi_return - * @return {Object} combined server field and business data field return - */ - static constructResponse(server_return: any, bdapi_return: any): Record; -} diff --git a/types/facebook-nodejs-business-sdk/src/objects/split-test-config.d.ts b/types/facebook-nodejs-business-sdk/src/objects/split-test-config.d.ts deleted file mode 100644 index 4f1401378631c5..00000000000000 --- a/types/facebook-nodejs-business-sdk/src/objects/split-test-config.d.ts +++ /dev/null @@ -1,17 +0,0 @@ -import { AbstractCrudObject } from "./../abstract-crud-object"; -/** - * SplitTestConfig - * @see {@link https://developers.facebook.com/docs/marketing-api/} - */ -export default class SplitTestConfig extends AbstractCrudObject { - static get Fields(): Readonly<{ - budget: "budget"; - early_winner_declaration_enabled: "early_winner_declaration_enabled"; - end_time: "end_time"; - splits: "splits"; - start_time: "start_time"; - test_variable: "test_variable"; - id: "id"; - }>; - get(fields: string[], params?: Record): Promise; -} diff --git a/types/facebook-nodejs-business-sdk/src/objects/system-user.d.ts b/types/facebook-nodejs-business-sdk/src/objects/system-user.d.ts index e921ca2abb91d5..c9412d5bd00370 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/system-user.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/system-user.d.ts @@ -34,5 +34,6 @@ export default class SystemUser extends AbstractCrudObject { getAssignedBusinessAssetGroups(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getAssignedPages(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getAssignedProductCatalogs(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getAssignedWhatsAppBusinessAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/targeting.d.ts b/types/facebook-nodejs-business-sdk/src/objects/targeting.d.ts index d70391a7d100e8..c4dbffdfe0b454 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/targeting.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/targeting.d.ts @@ -35,6 +35,7 @@ export default class Targeting extends AbstractCrudObject { effective_instagram_positions: "effective_instagram_positions"; effective_messenger_positions: "effective_messenger_positions"; effective_publisher_platforms: "effective_publisher_platforms"; + effective_threads_positions: "effective_threads_positions"; engagement_specs: "engagement_specs"; ethnic_affinity: "ethnic_affinity"; exclude_reached_since: "exclude_reached_since"; @@ -89,6 +90,7 @@ export default class Targeting extends AbstractCrudObject { targeting_automation: "targeting_automation"; targeting_optimization: "targeting_optimization"; targeting_relaxation_types: "targeting_relaxation_types"; + threads_positions: "threads_positions"; user_adclusters: "user_adclusters"; user_device: "user_device"; user_event: "user_event"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/tech-provider/account.d.ts b/types/facebook-nodejs-business-sdk/src/objects/tech-provider/account.d.ts new file mode 100644 index 00000000000000..7c7defd2bb9c4c --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/tech-provider/account.d.ts @@ -0,0 +1,300 @@ +import FacebookAdsApi from "../../api"; +/** + * These are accounts owned by a tech provider's business, representing + * a user of the tech provider's application. + * + * This class allows the tech provider to decide which assets are shared from an existing + * facebook user's account/business portfolio (which the user has granted the tech provider access to), + * and which assets are created and owned by the tech provider. This class allows the Tech Provider + * to provide monetization experiences for the third party user using a higher level interface + * than the underlying facebook graph apis. + * + * This class simplifies: + * 1. Creating Assets that are owned by the tech provider (Ad Accounts, Pages, Pixels, etc) . + * 2. Accessing Assets from a users facebook account or business account (Pages, Pixels, etc). + * 3. Combining tech provider owned and user owned assets. (ex: a Product Catalog owned by the tech provider using CAPI events from a user owned dataset) + * 3. Allocating a portion of the tech provider's Credit Line to the account. + * 4. Access Token Usage and Management + * 5. Providing Monetization Services to the third party user + * + * All management operations are performed using the {@link ThirdPartyAccountManager} (e.g. CRUD operations) + * + * Creation: + * - {@link ThirdPartyAccountManager.createAccount()} must be used to create a new ThirdPartyAccount + * + * Loading: + * - {@link ThirdPartyAccountManager.getAccount()} must be used to load an existing ThirdPartyAccount + * - {@link ThirdPartyAccountManager.listAccountsAccounts()} must be used to load existing ThirdPartyAccounts + * + * Deletion: + * - {@link ThirdPartyAccountManager.deleteAccount()} must be used to delete an existing ThirdPartyAccount + * + * Usage: + * - Use `getFacebookPageId()` to retrieve the Facebook Page used for advertising by this account + * - Use `disconnectFacebookPage()` to disconnect the Facebook Page used for advertising by this account + * - Use `updateFacebookPage()` to update the Facebook Page used for advertising by this account + */ +declare class ThirdPartyAccount { + #private; + /** + * The GraphAPI resource id that backs the ThirdPartyAccount, essentially + * acting as a container. Currently the only backing type is Business + */ + accountId: string; + constructor(accountId: string, accountManager: ThirdPartyAccountManager, accessToken: string); + /** + * Return the Facebook Page associated with the account. + * This is the Facebook Page that was shared with the account + * during creation. If the page was updated, this will return + * the updated page. + */ + getFacebookPageId(): Promise; + /** + * Disconnects the Facebook Page that was previously connected + * to the third party account. Advertising will not be possible + * until a new Facebook Page is connected to the account + */ + disconnectFacebookPage(): Promise; + /** + * Updates the Facebook Page associated with this account. + * + * This method should be used when a user of the tech provider's application + * wants to change the Facebook Page that is linked to this account. + * If the provided page is the existing page, it no-ops and returns the existing page id. + * If the provided page is a different page, it disconnects the existing page and connects + * the new page to the account. + * + * The method ensures that the new page is properly set up for advertising. + * After updating the page, it refreshes the access token to ensure that the + * account has the correct permissions for the new page. + * + * @param {string} pageId - The ID of the new Facebook Page to be associated with the account. + * @returns {Promise} A promise that resolves to the ID of the updated Facebook Page. + * + * Usage: + * - Use `updateFacebookPage(pageId)` to change the Facebook Page linked to the account. + * - Ensure that the page ID provided is valid and accessible by the tech provider's application + * - For example, having the user grant access to the Page using Facebook Login for Business. + * - If the page is a personal page, the user must grant the tech provider's application + * pages_manage_metadata and pages_read_engagement permissions. + * - If the page is a business page, the user must grant the tech provider's application + * business_management, ads_management, and pages_read_engagement permissions. + * - For more information, see the Facebook Login for Business documentation: https://developers.facebook.com/docs/facebook-login/facebook-login-for-business + * + * @example + * + * ``` + * const account = new ThirdPartyAccount(accountId, accountManager, accessToken); + * account.updateFacebookPage('new-page-id') + * .then(updatedPageId => { + * console.log('Page successfully updated. Page ID:', updatedPageId); + * }).catch(error => { + * console.error(error, 'Error updating page'); + * }); + * ``` + */ + updateFacebookPage(pageId: string): Promise; + /** + * Refreshed the token that provides access to this account. + * This token is hidden by default to prevent logging or accidentally + * leaking it. + */ + refreshToken(): Promise; + /** + * Because the token can be periodically refreshed, this method + * is used to prevent the old token from accidentally being used. + * @returns the GraphAPI instance for this account + */ + getApi(): Promise; +} +export type { ThirdPartyAccount }; +/** + * Read only view of the third party account + * Returned by listAccounts operations + */ +interface ThirdPartyAccountInfo { + id: string; + name: string; +} +/** + * Page ID to use to back the ads + * This is the identity of the advertiser + */ +type PageProps = { + id: string; +}; +/** + * Defines the credit allocation to be + * given to the third party account. + * The tech provider must have a valid Credit Line. + */ +type CreditAllocationProps = { + creditLineId: string; + currencyAmount?: string; + currency?: string; +}; +/** + * Properties needed to create the account + * For now, a page is necessary in order to + * create the account. It is used as the identity + * of the advertiser and must be a real Facebook Page + */ +type CreateAccountProps = { + name: string; + page?: PageProps; + creditAllocation?: CreditAllocationProps; + userAccessToken: string; +}; +type DeleteAccountProps = { + accountId: string; +}; +/** + * ThirdPartyAccountManager is responsible for creating and managing ThirdPartyAccounts + * that represent users of a tech provider's application. + * + * This class provides functionality to: + * 1. Create new third-party accounts with associated assets (Ad Accounts, Pages, Pixels) + * 2. Retrieve existing accounts by ID + * 3. listAccounts all accounts associated with the tech provider's application + * 4. Delete accounts when they are no longer needed + * 5. Manage access tokens for account operations + * + * Each account created through this manager allows the tech provider to: + * - Create assets owned by the tech provider on behalf of the user + * - Access assets shared by the user from their Facebook account + * - Allocate portions of the tech provider's credit line to the user + * - Manage all assets with a single access token + * + * @see ThirdPartyAccount for account usage after creation + */ +export declare class ThirdPartyAccountManager { + #private; + constructor(appId: string, techProvBusinessId: string, systemAccountToken: string); + /** + * Creates a third party account under this tech provider's business. This account is used to represent + * a third party user on the tech provider's platform. + * + * This account allows the tech provider's application to: + * 1. Create Assets (Ad Accounts, Pages, Pixels, etc) that are owned by the tech provider. + * 2. Access Assets (Pages, Pixels, etc) from a users facebook account or business account. + * 3. Allocate a portion of the tech provider's Credit Line to the account. + * 4. Use one access token to manage both created and shared assets. + * + * This account allows the tech provider to decide which assets are shared from an existing + * facebook user, and which assets are created and owned by the tech provider. This allows the Tech Provider + * to provide monetization experiences for the third party user using a higher level abstraction without worrying + * about access token management. + * + * @param {CreateAccountProps} props - Configuration for the new account including name, page, pixel, ad account details, and user access token + * + * @returns a {@link Promise} that resolves to the newly created {@link ThirdPartyAccount} t + * + * @example + * + * ``` + * const manager = new ThirdPartyAccountManager(appId, partnerBusinessId, partnerAccessToken); + * const account = await manager.createAccount({ + * name: 'Client Account', + * page: { id: 'page-id' }, + * creditAllocation: { creditLineId: 'credit-line-id', currencyAmount: '1000', currency: 'USD' } + * userAccessToken: 'user-access-token', + * }); + * ``` + */ + createAccount(props: CreateAccountProps): Promise; + /** + * This method returns a {@link ThirdPartyAccount} instance for the given account ID. If an account token + * is provided, it will be used directly. Otherwise, a new token will be generated, which requires + * an additional API call. + * + * @param {string} accountId - The ID of the account to retrieve. + * @param {string} [accountToken] - Optional. The access token for the account. Using this token is recommended to prevent an extra API call. + * @returns {Promise} A promise that resolves to the `ThirdPartyAccount` instance. + * + * Usage: + * - Use `getAccount(accountId, accountToken)` to retrieve a third-party account with the specified ID. + * - If the account token is not provided, the method will generate a new token. + * + * Example: + * ``` + * const manager = new ThirdPartyAccountManager(appId, techProvBusinessId, systemAccountToken); + * manager.getAccount('account-id', 'optional-account-token').then( + * account => { + * console.log('Retrieved account:', account); + * }).catch(error => { + * console.error('Error retrieving account', error); + * }); + * ``` + */ + getAccount(accountId: string, accountToken?: string): Promise; + regenerateAccessToken(accountId: string): Promise; + /** + * Deletes an account from a tech provider's application and business. + * + * WARNING: This operation is irreversible. + * + * This operation will pause all active campaigns and stop all active ads, then, + * all assets created within the account (Ad Accounts, Catalogs, etc.) will also be deleted, + * and all user owned asset connections will be severed. Finally, the ThirdPartyAccount and backingResource + * will be deleted. + * + * In order to re-create an account for a user, the tech provider's app will have to have a user + * re-authenticate to getAccount a user access token for reconnecting the assets to a new account, as the token + * from the previous login will almost certianly be invalid. User access tokens have a short lifetime. + * + * @param {DeleteAccountProps} props - Object containing the childBusinessId to delete + * @returns {Promise} A promise that resolves to true if deletion was successful, false otherwise + * + * Usage: + * - Use `deleteAccount()` when a client relationship ends or when an account needs to be removed + * - This method is useful when a client no longer is spending an the tech provider needs to reclaim + * some of its credit line (i.e. that portion of the credit line that was allocated to the account + * will be reclaimed for use by other accounts) + * - This operation is also useful when testing the integration because a tech provider is limited + * to 2 accounts when an app is in development mode. + * - This operation cannot be undone, and all data associated with the account will be lost + * + * @example + * + * ``` + * const manager = new ThirdPartyAccountManager(appId, partnerBusinessId, partnerAccessToken); + * manager.deleteAccount({ childBusinessId: 'business-id-to-delete' }).then( + * success => { + * if (success) { + * console.log('Account successfully deleted'); + * } else { + * console.log('Account does not exist'); + * } + * } + * ).catch(error => { + * console.error('Error when trying to delete account', error); + * }); + * ``` + */ + deleteAccount(props: DeleteAccountProps): Promise; + /** + * listAccountss third-party accounts associated with tech provider's app. + * + * By default, this method will return a maximum of 10 accounts. + * + * No matter what max is set, 10 results are returned in each API page. + * + * @returns {Promise} A promise that resolves to an array of ThirdPartyAccount instances. + * + * Usage: + * - Use `listAccounts()` to listAccounts all third-party accounts managed by the partner business. + * + * @example + * + * ``` + * const manager = new ThirdPartyAccountManager(appId, techProvBusinessId, systemAccountToken); + * manager.listAccounts().then( + * accounts => { + * accounts.forEach(account => { + * console.log(account); + * }); + * }); + * ``` + */ + listAccounts(max?: number): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/tech-provider/createAccount.d.ts b/types/facebook-nodejs-business-sdk/src/objects/tech-provider/createAccount.d.ts new file mode 100644 index 00000000000000..cb0ff5c3b541f6 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/tech-provider/createAccount.d.ts @@ -0,0 +1 @@ +export {}; diff --git a/types/facebook-nodejs-business-sdk/src/objects/tech-provider/deleteAccount.d.ts b/types/facebook-nodejs-business-sdk/src/objects/tech-provider/deleteAccount.d.ts new file mode 100644 index 00000000000000..cb0ff5c3b541f6 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/tech-provider/deleteAccount.d.ts @@ -0,0 +1 @@ +export {}; diff --git a/types/facebook-nodejs-business-sdk/src/objects/tech-provider/getPage.d.ts b/types/facebook-nodejs-business-sdk/src/objects/tech-provider/getPage.d.ts new file mode 100644 index 00000000000000..cb0ff5c3b541f6 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/tech-provider/getPage.d.ts @@ -0,0 +1 @@ +export {}; diff --git a/types/facebook-nodejs-business-sdk/src/objects/tech-provider/listAccounts.d.ts b/types/facebook-nodejs-business-sdk/src/objects/tech-provider/listAccounts.d.ts new file mode 100644 index 00000000000000..cb0ff5c3b541f6 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/tech-provider/listAccounts.d.ts @@ -0,0 +1 @@ +export {}; diff --git a/types/facebook-nodejs-business-sdk/src/objects/third-party-partner-viewability-request.d.ts b/types/facebook-nodejs-business-sdk/src/objects/third-party-partner-viewability-request.d.ts index b97e3484413be3..953781bf5d9c1b 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/third-party-partner-viewability-request.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/third-party-partner-viewability-request.d.ts @@ -7,6 +7,7 @@ export default class ThirdPartyPartnerViewabilityRequest extends AbstractCrudObj static get Fields(): Readonly<{ created_time: "created_time"; description: "description"; + ds: "ds"; hour: "hour"; id: "id"; metric: "metric"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/unified-thread.d.ts b/types/facebook-nodejs-business-sdk/src/objects/unified-thread.d.ts index 0cd80e5363f0e1..b8d506fb16c27f 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/unified-thread.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/unified-thread.d.ts @@ -19,7 +19,6 @@ export default class UnifiedThread extends AbstractCrudObject { scoped_thread_key: "scoped_thread_key"; senders: "senders"; snippet: "snippet"; - subject: "subject"; unread_count: "unread_count"; updated_time: "updated_time"; wallpaper: "wallpaper"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/user-page-one-time-opt-in-token-settings.d.ts b/types/facebook-nodejs-business-sdk/src/objects/user-page-one-time-opt-in-token-settings.d.ts index 8da35f27d1f374..56015d1447de7a 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/user-page-one-time-opt-in-token-settings.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/user-page-one-time-opt-in-token-settings.d.ts @@ -7,6 +7,7 @@ export default class UserPageOneTimeOptInTokenSettings extends AbstractCrudObjec static get Fields(): Readonly<{ creation_timestamp: "creation_timestamp"; next_eligible_time: "next_eligible_time"; + next_eligible_time_for_paid_messaging: "next_eligible_time_for_paid_messaging"; notification_messages_frequency: "notification_messages_frequency"; notification_messages_reoptin: "notification_messages_reoptin"; notification_messages_timezone: "notification_messages_timezone"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/user.d.ts b/types/facebook-nodejs-business-sdk/src/objects/user.d.ts index 9d3306e5351f7a..d18584346d983d 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/user.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/user.d.ts @@ -18,6 +18,7 @@ export default class User extends AbstractCrudObject { age_range: "age_range"; avatar_2d_profile_picture: "avatar_2d_profile_picture"; birthday: "birthday"; + client_business_id: "client_business_id"; community: "community"; cover: "cover"; currency: "currency"; @@ -31,7 +32,6 @@ export default class User extends AbstractCrudObject { id: "id"; id_for_avatars: "id_for_avatars"; inspirational_people: "inspirational_people"; - instagram_user_self_asset: "instagram_user_self_asset"; install_type: "install_type"; installed: "installed"; is_guest_user: "is_guest_user"; @@ -99,6 +99,7 @@ export default class User extends AbstractCrudObject { getAssignedBusinessAssetGroups(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getAssignedPages(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getAssignedProductCatalogs(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getAssignedWhatsAppBusinessAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getAvatars(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; getBusinessUsers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; deleteBusinesses(params?: Record): Promise; diff --git a/types/facebook-nodejs-business-sdk/src/objects/vehicle.d.ts b/types/facebook-nodejs-business-sdk/src/objects/vehicle.d.ts index e461932c4ee964..7bb029e04d337b 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/vehicle.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/vehicle.d.ts @@ -9,6 +9,8 @@ export default class Vehicle extends AbstractCrudObject { address: "address"; applinks: "applinks"; availability: "availability"; + availability_circle_radius: "availability_circle_radius"; + availability_circle_radius_unit: "availability_circle_radius_unit"; body_style: "body_style"; category_specific_fields: "category_specific_fields"; condition: "condition"; @@ -86,6 +88,7 @@ export default class Vehicle extends AbstractCrudObject { available: "AVAILABLE"; not_available: "NOT_AVAILABLE"; pending: "PENDING"; + unknown: "UNKNOWN"; }>; static get BodyStyle(): Readonly<{ convertible: "CONVERTIBLE"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/website-creative-info.d.ts b/types/facebook-nodejs-business-sdk/src/objects/website-creative-info.d.ts new file mode 100644 index 00000000000000..dc60dc5265038a --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/website-creative-info.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * WebsiteCreativeInfo + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class WebsiteCreativeInfo extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + image_urls: "image_urls"; + link_url: "link_url"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/whats-app-business-account.d.ts b/types/facebook-nodejs-business-sdk/src/objects/whats-app-business-account.d.ts index bce635ef373955..51835f27379222 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/whats-app-business-account.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/whats-app-business-account.d.ts @@ -19,8 +19,10 @@ export default class WhatsAppBusinessAccount extends AbstractCrudObject { health_status: "health_status"; id: "id"; is_enabled_for_insights: "is_enabled_for_insights"; + is_shared_with_partners: "is_shared_with_partners"; linked_commerce_account: "linked_commerce_account"; marketing_messages_lite_api_status: "marketing_messages_lite_api_status"; + marketing_messages_onboarding_status: "marketing_messages_onboarding_status"; message_template_namespace: "message_template_namespace"; name: "name"; on_behalf_of_business_info: "on_behalf_of_business_info";