diff --git a/.dprint.jsonc b/.dprint.jsonc index 0086345c4b90ef..18230365108652 100644 --- a/.dprint.jsonc +++ b/.dprint.jsonc @@ -50,10 +50,10 @@ }, // NOTE: if extending this list, also update settings.template.json. "plugins": [ - "https://plugins.dprint.dev/typescript-0.89.3.wasm", - "https://plugins.dprint.dev/json-0.19.2.wasm", - "https://plugins.dprint.dev/markdown-0.16.4.wasm", - "https://plugins.dprint.dev/prettier-0.39.0.json@896b70f29ef8213c1b0ba81a93cee9c2d4f39ac2194040313cd433906db7bc7c" + "https://plugins.dprint.dev/typescript-0.91.4.wasm", + "https://plugins.dprint.dev/json-0.19.3.wasm", + "https://plugins.dprint.dev/markdown-0.17.1.wasm", + "https://plugins.dprint.dev/prettier-0.40.0.json@68c668863ec834d4be0f6f5ccaab415df75336a992aceb7eeeb14fdf096a9e9c" ], "indentWidth": 4, "lineWidth": 120, diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 2de106adbcc481..d9e6ccf110358f 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -292,7 +292,7 @@ /types/apptimize__apptimize-web-sdk/ @innovation-team @rlbaxter /types/arangodb/ @pluma /types/arbiter/ @arash16 -/types/arc4/ @hofmmaxi +/types/arc4/ @maxiicodes /types/arcgis-rest-api/ @JeffJacobson /types/arcgis-to-geojson-utils/ @JeffJacobson /types/architect/ @greuze @@ -412,7 +412,7 @@ /types/aws-greengrass-core-sdk/ @ozxcorp @lummish /types/aws-iot-device-sdk/ @niik @mlamp /types/aws-kcl/ @vshlos @foqal -/types/aws-lambda/ @darbio @skarum @StefH @buggy @wwwy3y3 @OrthoDex @MichaelMarner @daniel-cottone @kostya-misura @coderbyheart @palmithor @daniloraisi @simonbuchan @Haydabase @repl-chris @aneilbaboo @jeznag @louislarry @dpapukchiev @ohookins @trevor-leach @jagregory @dalen @loikg @skyzenr @redlickigrzegorz @juancarbonel @pwmcintyre @alex-bolenok-centralreach @marianzange @apalumbo @SachinShekhar @ivanmartos @zach-anthony @savnik @bboure @jamesorlakin @aphex @joeykilpatrick @lmanerich +/types/aws-lambda/ @darbio @skarum @StefH @buggy @wwwy3y3 @OrthoDex @MichaelMarner @daniel-cottone @kostya-misura @coderbyheart @palmithor @daniloraisi @simonbuchan @Haydabase @repl-chris @aneilbaboo @jeznag @louislarry @dpapukchiev @ohookins @trevor-leach @jagregory @dalen @loikg @skyzenr @redlickigrzegorz @juancarbonel @pwmcintyre @alex-bolenok-centralreach @marianzange @apalumbo @SachinShekhar @ivanmartos @zach-anthony @savnik @bboure @jamesorlakin @aphex @joeykilpatrick @lmanerich @LucianoTaranto /types/aws-lambda-fastify/ @kentakang /types/aws-lambda-http-server/ @ElayGelbart /types/aws-param-store/ @jasonthomasgray @nathanoertel @@ -778,11 +778,10 @@ /types/capture-console/ @AustonZ /types/car-names/ @peterblazejewicz /types/carbon-components/ @metonym -/types/carbon-components-react/ @kalbert312 @sgregoire @matchilling +/types/carbon-components-react/ @matchilling /types/carbon__colors/ @vpicone @szbihary /types/carbon__elements/ @metonym /types/carbon__feature-flags/ @metonym -/types/carbon__icon-helpers/ @metonym /types/carbon__layout/ @vpicone /types/carbon__motion/ @vpicone /types/carbon__pictograms-react/ @metonym @@ -1239,7 +1238,7 @@ /types/csv2json/ @dex4er /types/csvrow/ @codeanimal @hithomasmorelli /types/cuint/ @ltetzlaff -/types/culori/ @bijela-gora +/types/culori/ @bijela-gora @drwpow /types/currency-formatter/ @mhegazy @davidmpaz @peterblazejewicz /types/current-git-branch/ @maxbogus /types/curtainsjs/ @Blakeinstein @@ -1256,13 +1255,13 @@ /types/cyberblast__logger/ @cyberblast /types/cyberblast__webserver/ @cyberblast /types/cyclonedx/ @eoftedal -/types/cypress-cdp/ @froissant @LouisLoiseau +/types/cypress-cdp/ @froissant @seasheepjoe /types/cypress-cucumber-preprocessor/ @aleccool213 @falconertc @jp7677 @waterfoul /types/cypress-dark/ @peterblazejewicz /types/cypress-dotenv/ @daikiojm @peterblazejewicz /types/cypress-image-snapshot/ @Keysox /types/cypress__code-coverage/ @k-yle -/types/cytoscape/ @phreed @wy193777 @ypconstante @janniclas @gsbelarus @peterjferrarotto @spaxe @Veckodag @jsve @rogerdubbs +/types/cytoscape/ @phreed @wy193777 @ypconstante @janniclas @gsbelarus @peterjferrarotto @spaxe @Veckodag @jsve /types/cytoscape-avsdf/ @rogerdubbs /types/cytoscape-canvas/ @hellomusa /types/cytoscape-context-menus/ @hellomusa @@ -1282,6 +1281,7 @@ /types/d3/v4/ @tomwanzek @gustavderdrache @borisyankov @denisname @Methuselah96 /types/d3/v5/ @tomwanzek @gustavderdrache @borisyankov @denisname @Methuselah96 /types/d3/v6/ @tomwanzek @gustavderdrache @borisyankov @denisname @Methuselah96 +/types/d3-3d/ @aminya /types/d3-array/ @gustavderdrache @borisyankov @tomwanzek @denisname @ledragon @Methuselah96 @Fil /types/d3-array/v1/ @gustavderdrache @borisyankov @tomwanzek @denisname @ledragon @Methuselah96 /types/d3-array/v2/ @gustavderdrache @borisyankov @tomwanzek @denisname @ledragon @Methuselah96 @@ -1564,7 +1564,7 @@ /types/docdown/ @peterblazejewicz /types/docker-events/ @ciffelia /types/docker-modem/ @bacali95 -/types/dockerode/ @seikho @nlaplante @isac322 @lazarusx @meisenzahl @thegecko @CameronDiver @p4sca1 @stuartthomson @userlerueda +/types/dockerode/ @seikho @nlaplante @isac322 @lazarusx @meisenzahl @thegecko @CameronDiver @p4sca1 @userlerueda /types/dockerode-compose/ @Sharknoon /types/docopt/ @giggio /types/doctrine/ @rictic @@ -1891,6 +1891,7 @@ /types/escpos/ @rayosu /types/eseb__request-state/ @inglec-arista /types/eslint/ @pmdartus @j-f1 @saadq @JasonHK @bradzacher @JounQin @bmish +/types/eslint/v8/ @pmdartus @j-f1 @saadq @JasonHK @bradzacher @JounQin @bmish /types/eslint-ast-utils/ @marksmccann /types/eslint-config-prettier/ @JoshuaKGoldberg /types/eslint-plugin-markdown/ @JounQin @@ -1944,7 +1945,7 @@ /types/eventsource/ @scottleedavis @afroozeh @snakedrak @Akuukis /types/evernote/ @corps @fcastilloec /types/ewma/ @LeoDog896 -/types/exaroton/ @hofmmaxi +/types/exaroton/ @maxiicodes /types/excel-column-name/ @sozysozbot /types/excel-style-dataformatter/ @SanderDeWaal1992 /types/exchange-rates-api/ @martonlederer @@ -2040,6 +2041,7 @@ /types/eyes/ @brynbellomy /types/eyevinn-iaf/ @birme @oscnord /types/ez-plus/ @AndersonFriaca +/types/ezuikit-js/ @daiwanxing /types/f1/ @neolwc /types/fabric/ @oklemencic @joewashear007 @mrand01 @NotWoods @bmartinson @RogerioTeixeira @BradleyHill @bmkrol823 @glenngartner @codertx @mike667 @nataliemarleny @buzzyboy @oxwazz /types/facebook-instant-games/ @menushka @oyvindjam @doterax @@ -2091,7 +2093,6 @@ /types/fbemitter/ @kmxz /types/fbjs/ @morrys /types/fbt/ @retyui @alexandernanberg -/types/fcostarodrigo__walk/ @tpluscode /types/feather-icons/ @jineshshah36 @freethewhat /types/featherlight/ @xStrom /types/feathersjs__authentication/ @AbraaoAlves @j2L4e @NickBolles @@ -2176,7 +2177,7 @@ /types/firebase-token-generator/ @dotdotcommadot /types/firebird/ @karak /types/firefox/ @vvakame -/types/firefox-webext-browser/ @jsmnbom @codershiba +/types/firefox-webext-browser/ @jsmnbom /types/firemonkey-browser/ @DrakeTDL /types/fireo/ @AxeemHaider /types/firmata/ @troywweber7 @@ -2208,6 +2209,7 @@ /types/flowjs/ @martinnuc /types/flowjs__flow.js/ @gentoo90 /types/floyd-steinberg/ @tajnymag +/types/flubber/ @huxulm /types/fluent/ @huy-nguyen @jamesnimlos /types/fluent-ffmpeg/ @tcaesvk @DingWeizhe @mabidina @hados99 @buzzertech /types/fluent-langneg/ @huy-nguyen @@ -2325,7 +2327,7 @@ /types/fxjs/ @load28 /types/fxn/ @charrondev /types/gae.channel.api/ @vvakame -/types/gamedig/ @ivansieder @p4sca1 @MaximumWoahverdrive +/types/gamedig/ @ivansieder @p4sca1 @MaximumWoahverdrive @a-sync /types/gamepad/ @Lange /types/gamequery/ @Laubi /types/gandi-livedns/ @xstoudi @@ -2338,8 +2340,8 @@ /types/gapi.client.acceleratedmobilepageurl-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.accessapproval-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.accesscontextmanager-v1/ @Maxim-Mazurok @namoscato @declanvong -/types/gapi.client.accesscontextmanager-v1beta/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.acmedns-v1/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.addressvalidation-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.adexchangebuyer2-v2beta1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.adexperiencereport-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.admin-datatransfer_v1/ @Maxim-Mazurok @namoscato @declanvong @@ -2350,7 +2352,13 @@ /types/gapi.client.adsense-v2/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.adsensehost-v4.1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.advisorynotifications-v1/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.aiplatform-v1/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.aiplatform-v1beta1/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.airquality-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.alertcenter-v1beta1/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.alloydb-v1/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.alloydb-v1alpha/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.alloydb-v1beta/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.analytics-v3/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.analyticsadmin-v1alpha/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.analyticsadmin-v1beta/ @Maxim-Mazurok @namoscato @declanvong @@ -2366,9 +2374,12 @@ /types/gapi.client.apigateway-v1beta/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.apigeeregistry-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.apikeys-v2/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.apim-v1alpha/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.appengine-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.appengine-v1alpha/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.appengine-v1beta/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.apphub-v1/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.apphub-v1alpha/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.area120tables-v1alpha1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.artifactregistry-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.artifactregistry-v1beta1/ @Maxim-Mazurok @namoscato @declanvong @@ -2376,12 +2387,16 @@ /types/gapi.client.assuredworkloads-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.assuredworkloads-v1beta1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.authorizedbuyersmarketplace-v1/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.backupdr-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.baremetalsolution-v2/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.batch-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.beyondcorp-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.beyondcorp-v1alpha/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.biglake-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.bigquery-v2/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.bigqueryconnection-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.bigqueryconnection-v1beta1/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.bigquerydatapolicy-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.bigquerydatatransfer-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.bigqueryreservation-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.bigtableadmin-v2/ @Maxim-Mazurok @namoscato @declanvong @@ -2389,6 +2404,7 @@ /types/gapi.client.billingbudgets-v1beta1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.binaryauthorization-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.binaryauthorization-v1beta1/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.blockchainnodeengine-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.blogger-v2/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.blogger-v3/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.books-v1/ @Maxim-Mazurok @namoscato @declanvong @@ -2396,6 +2412,7 @@ /types/gapi.client.calendar-v3/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.certificatemanager-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.chat-v1/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.checks-v1alpha/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.chromemanagement-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.chromepolicy-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.chromeuxreport-v1/ @Maxim-Mazurok @namoscato @declanvong @@ -2409,7 +2426,10 @@ /types/gapi.client.cloudbilling-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.cloudbilling-v1beta/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.cloudbuild-v1/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.cloudbuild-v2/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.cloudchannel-v1/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.cloudcontrolspartner-v1/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.cloudcontrolspartner-v1beta/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.clouddeploy-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.clouderrorreporting-v1beta1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.cloudfunctions-v1/ @Maxim-Mazurok @namoscato @declanvong @@ -2418,7 +2438,6 @@ /types/gapi.client.cloudfunctions-v2beta/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.cloudidentity-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.cloudidentity-v1beta1/ @Maxim-Mazurok @namoscato @declanvong -/types/gapi.client.cloudiot-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.cloudkms-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.cloudprofiler-v2/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.cloudresourcemanager-v1/ @Maxim-Mazurok @namoscato @declanvong @@ -2430,6 +2449,7 @@ /types/gapi.client.cloudscheduler-v1beta1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.cloudsearch-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.cloudshell-v1/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.cloudsupport-v2/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.cloudsupport-v2beta/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.cloudtasks-v2/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.cloudtasks-v2beta2/ @Maxim-Mazurok @namoscato @declanvong @@ -2442,6 +2462,7 @@ /types/gapi.client.compute-alpha/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.compute-beta/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.compute-v1/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.config-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.connectors-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.connectors-v2/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.contactcenteraiplatform-v1alpha1/ @Maxim-Mazurok @namoscato @declanvong @@ -2466,6 +2487,8 @@ /types/gapi.client.datamigration-v1beta1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.datapipelines-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.dataplex-v1/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.dataportability-v1/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.dataportability-v1beta/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.dataproc-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.datastore-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.datastore-v1beta1/ @Maxim-Mazurok @namoscato @declanvong @@ -2475,6 +2498,7 @@ /types/gapi.client.deploymentmanager-alpha/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.deploymentmanager-v2/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.deploymentmanager-v2beta/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.developerconnect-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.dfareporting-v3.5/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.dfareporting-v4/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.dialogflow-v2/ @Maxim-Mazurok @namoscato @declanvong @@ -2483,10 +2507,11 @@ /types/gapi.client.dialogflow-v3beta1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.digitalassetlinks-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.discovery-v1/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.discoveryengine-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.discoveryengine-v1alpha/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.discoveryengine-v1beta/ @Maxim-Mazurok @namoscato @declanvong -/types/gapi.client.displayvideo-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.displayvideo-v2/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.displayvideo-v3/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.dlp-v2/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.dns-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.dns-v1beta2/ @Maxim-Mazurok @namoscato @declanvong @@ -2498,7 +2523,6 @@ /types/gapi.client.domains-v1alpha2/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.domains-v1beta1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.domainsrdap-v1/ @Maxim-Mazurok @namoscato @declanvong -/types/gapi.client.doubleclickbidmanager-v1.1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.doubleclickbidmanager-v2/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.doubleclicksearch-v2/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.drive-v2/ @Maxim-Mazurok @namoscato @declanvong @@ -2508,7 +2532,6 @@ /types/gapi.client.drivelabels-v2beta/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.essentialcontacts-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.eventarc-v1/ @Maxim-Mazurok @namoscato @declanvong -/types/gapi.client.eventarc-v1beta1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.factchecktools-v1alpha1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.fcm-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.fcmdata-v1beta1/ @Maxim-Mazurok @namoscato @declanvong @@ -2518,12 +2541,14 @@ /types/gapi.client.firebaseappcheck-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.firebaseappcheck-v1beta/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.firebaseappdistribution-v1/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.firebaseappdistribution-v1alpha/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.firebasedatabase-v1beta/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.firebasedynamiclinks-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.firebasehosting-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.firebasehosting-v1beta1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.firebaseml-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.firebaseml-v1beta2/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.firebaseml-v2beta/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.firebaserules-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.firebasestorage-v1beta/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.firestore-v1/ @Maxim-Mazurok @namoscato @declanvong @@ -2534,29 +2559,20 @@ /types/gapi.client.games-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.games_configuration-v1configuration/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.games_management-v1management/ @Maxim-Mazurok @namoscato @declanvong -/types/gapi.client.gameservices-v1/ @Maxim-Mazurok @namoscato @declanvong -/types/gapi.client.gameservices-v1beta/ @Maxim-Mazurok @namoscato @declanvong -/types/gapi.client.genomics-v2alpha1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.gkebackup-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.gkehub-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.gkehub-v1alpha/ @Maxim-Mazurok @namoscato @declanvong -/types/gapi.client.gkehub-v1alpha2/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.gkehub-v1beta/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.gkehub-v1beta1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.gkehub-v2alpha/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.gkeonprem-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.gmail-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.gmailpostmastertools-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.gmailpostmastertools-v1beta1/ @Maxim-Mazurok @namoscato @declanvong -/types/gapi.client.googleads-v10/ @Maxim-Mazurok @namoscato @declanvong -/types/gapi.client.googleads-v11/ @Maxim-Mazurok @namoscato @declanvong -/types/gapi.client.googleads-v12/ @Maxim-Mazurok @namoscato @declanvong -/types/gapi.client.googleads-v13/ @Maxim-Mazurok @namoscato @declanvong -/types/gapi.client.googleads-v4/ @Maxim-Mazurok @namoscato @declanvong -/types/gapi.client.googleads-v5/ @Maxim-Mazurok @namoscato @declanvong -/types/gapi.client.googleads-v6/ @Maxim-Mazurok @namoscato @declanvong -/types/gapi.client.googleads-v7/ @Maxim-Mazurok @namoscato @declanvong -/types/gapi.client.googleads-v8/ @Maxim-Mazurok @namoscato @declanvong -/types/gapi.client.googleads-v9/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.googleads-v14/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.googleads-v15/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.googleads-v16/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.googleads-v17/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.groupsmigration-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.groupssettings-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.healthcare-v1/ @Maxim-Mazurok @namoscato @declanvong @@ -2573,7 +2589,7 @@ /types/gapi.client.identitytoolkit-v3/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.ids-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.indexing-v3/ @Maxim-Mazurok @namoscato @declanvong -/types/gapi.client.integrations-v1alpha/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.integrations-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.jobs-v3/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.jobs-v3p1beta1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.jobs-v4/ @Maxim-Mazurok @namoscato @declanvong @@ -2582,26 +2598,40 @@ /types/gapi.client.kmsinventory-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.language-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.language-v1beta2/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.language-v2/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.libraryagent-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.licensing-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.lifesciences-v2beta/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.localservices-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.logging-v2/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.looker-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.managedidentities-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.managedidentities-v1alpha1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.managedidentities-v1beta1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.manufacturers-v1/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.marketingplatformadmin-v1alpha/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.meet-v2/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.memcache-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.memcache-v1beta2/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.merchantapi-accounts_v1beta/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.merchantapi-conversions_v1beta/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.merchantapi-datasources_v1beta/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.merchantapi-inventories_v1beta/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.merchantapi-lfp_v1beta/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.merchantapi-notifications_v1beta/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.merchantapi-products_v1beta/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.merchantapi-promotions_v1beta/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.merchantapi-quota_v1beta/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.merchantapi-reports_v1beta/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.metastore-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.metastore-v1alpha/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.metastore-v1beta/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.migrationcenter-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.migrationcenter-v1alpha1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.ml-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.monitoring-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.monitoring-v3/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.mybusinessaccountmanagement-v1/ @Maxim-Mazurok @namoscato @declanvong -/types/gapi.client.mybusinessbusinesscalls-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.mybusinessbusinessinformation-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.mybusinesslodging-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.mybusinessnotifications-v1/ @Maxim-Mazurok @namoscato @declanvong @@ -2631,9 +2661,11 @@ /types/gapi.client.pagespeedonline-v5/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.paymentsresellersubscription-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.people-v1/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.places-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.playcustomapp-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.playdeveloperreporting-v1alpha1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.playdeveloperreporting-v1beta1/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.playgrouping-v1alpha1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.playintegrity-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.policyanalyzer-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.policyanalyzer-v1beta1/ @Maxim-Mazurok @namoscato @declanvong @@ -2642,19 +2674,20 @@ /types/gapi.client.policysimulator-v1beta/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.policytroubleshooter-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.policytroubleshooter-v1beta/ @Maxim-Mazurok @namoscato @declanvong -/types/gapi.client.poly-v1/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.pollen-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.privateca-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.privateca-v1beta1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.prod_tt_sasportal-v1alpha1/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.publicca-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.publicca-v1alpha1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.publicca-v1beta1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.pubsub-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.pubsub-v1beta1a/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.pubsub-v1beta2/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.pubsublite-v1/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.rapidmigrationassessment-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.readerrevenuesubscriptionlinking-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.realtimebidding-v1/ @Maxim-Mazurok @namoscato @declanvong -/types/gapi.client.realtimebidding-v1alpha/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.recaptchaenterprise-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.recommendationengine-v1beta1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.recommender-v1/ @Maxim-Mazurok @namoscato @declanvong @@ -2671,12 +2704,14 @@ /types/gapi.client.runtimeconfig-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.runtimeconfig-v1beta1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.safebrowsing-v4/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.safebrowsing-v5/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.sasportal-v1alpha1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.script-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.searchads360-v0/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.searchconsole-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.secretmanager-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.secretmanager-v1beta1/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.secretmanager-v1beta2/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.securitycenter-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.securitycenter-v1beta1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.securitycenter-v1beta2/ @Maxim-Mazurok @namoscato @declanvong @@ -2695,7 +2730,7 @@ /types/gapi.client.site_verification-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.slides-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.smartdevicemanagement-v1/ @Maxim-Mazurok @namoscato @declanvong -/types/gapi.client.sourcerepo-v1/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.solar-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.spanner-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.speech-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.speech-v1p1beta1/ @Maxim-Mazurok @namoscato @declanvong @@ -2718,6 +2753,7 @@ /types/gapi.client.tpu-v2/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.tpu-v2alpha1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.trafficdirector-v2/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.trafficdirector-v3/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.transcoder-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.translate-v2/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.translate-v3/ @Maxim-Mazurok @namoscato @declanvong @@ -2737,8 +2773,10 @@ /types/gapi.client.vision-v1p2beta1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.vmmigration-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.vmmigration-v1alpha1/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.vmwareengine-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.vpcaccess-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.vpcaccess-v1beta1/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.walletobjects-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.webfonts-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.webrisk-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.websecurityscanner-v1/ @Maxim-Mazurok @namoscato @declanvong @@ -2749,6 +2787,8 @@ /types/gapi.client.workflows-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.workflows-v1beta/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.workloadmanager-v1/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.workspaceevents-v1/ @Maxim-Mazurok @namoscato @declanvong +/types/gapi.client.workstations-v1/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.workstations-v1beta/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.youtube-v3/ @Maxim-Mazurok @namoscato @declanvong /types/gapi.client.youtube_analytics-v2/ @Maxim-Mazurok @namoscato @declanvong @@ -2939,6 +2979,7 @@ /types/gopd/ @ljharb /types/gorilla-engine/ @jhwoodward @UJAM-JH @rip-off-hb @pkellett @vpietropaolo-ujam @agachuma /types/got-resume/ @inglec-arista @BendingBender +/types/govuk-frontend/ @colinrotherham /types/graceful-fs/ @Bartvds @BendingBender /types/gradient-parser/ @AviVahl /types/graham_scan/ @hberntsen @@ -3319,7 +3360,6 @@ /types/hyperscript/ @spacejack @jmfirth /types/hypertext-application-language/ @maks3w /types/hyphen/ @krisztianb -/types/hyphenate-style-name/ @peterblazejewicz /types/hystrixjs/ @igorsechyn /types/i18n/ @SomaticIT @FindQ @martin-badin /types/i18n-abide/ @smbell @@ -3377,7 +3417,7 @@ /types/imagesloaded/ @coldacid @apexskier /types/imap/ @psnider /types/imap-simple/ @pushplay @iaarnio -/types/imapflow/ @jeffreyratton98 @martin-badin @grayson-code +/types/imapflow/ @jeffreyratton98 @martin-badin @grayson-code @remscar /types/img-clipboard/ @Nigecat /types/imgur-rest-api/ @lukewestby /types/immediate/ @BendingBender @@ -4047,7 +4087,7 @@ /types/keystonejs__email/ @thekevinbrown @tclain /types/keystonejs__logger/ @thekevinbrown @tclain /types/keystonejs__session/ @thekevinbrown @tclain -/types/keythereum/ @septs +/types/keythereum/ @sircoon4 /types/kik-browser/ @joelday /types/kill-port/ @BendingBender /types/kind-of/ @claasahl @@ -4931,7 +4971,7 @@ /types/micro-cors/ @CallumDenby @moonchanyong /types/micro-events/ @AlexanderSychev /types/microlight/ @ravenclaw900 -/types/micromatch/ @glen-84 @vemoo +/types/micromatch/ @vemoo /types/micromatch/v2/ @glen-84 /types/micromodal/ @wcarson /types/microrouter/ @mathieudutour @@ -4954,7 +4994,6 @@ /types/min-document/ @ifiokjr /types/min-indent/ @BendingBender /types/mina/ @lhk @mattanja @kant2002 -/types/minapp-env/ @chobits4 /types/minecraft-pinger/ @Grayson-code /types/mini-html-webpack-plugin/ @peterblazejewicz /types/minify/ @peterblazejewicz @@ -5253,6 +5292,7 @@ /types/node/ @Microsoft @jkomyno @alvis @r3nya @btoueg @smac89 @touffy @DeividasBakanas @eyqs @Hannes-Magnusson-CK @hoo29 @kjin @ajafff @islishude @mwiktorczyk @mohsen1 @galkin @parambirs @eps1lon @ThomasdenH @WilcoBakker @wwwy3y3 @samuela @kuehlein @bhongy @chyzwar @trivikr @yoursunny @qwelias @ExE-Boss @peterblazejewicz @addaleax @victorperin @ZYSzys @NodeJS @LinusU @wafuwafu13 @mcollina @Semigradsky /types/node/v16/ @Microsoft @jkomyno @alvis @r3nya @btoueg @smac89 @touffy @DeividasBakanas @eyqs @Hannes-Magnusson-CK @hoo29 @kjin @ajafff @islishude @mwiktorczyk @mohsen1 @galkin @parambirs @eps1lon @westy92 @SimonSchick @ThomasdenH @WilcoBakker @wwwy3y3 @samuela @kuehlein @bhongy @chyzwar @trivikr @yoursunny @qwelias @ExE-Boss @peterblazejewicz @addaleax @victorperin @ZYSzys @NodeJS @LinusU @wafuwafu13 /types/node/v18/ @Microsoft @jkomyno @alvis @r3nya @btoueg @smac89 @touffy @DeividasBakanas @eyqs @Hannes-Magnusson-CK @hoo29 @kjin @ajafff @islishude @mwiktorczyk @mohsen1 @galkin @parambirs @eps1lon @SimonSchick @ThomasdenH @WilcoBakker @wwwy3y3 @samuela @kuehlein @bhongy @chyzwar @trivikr @yoursunny @qwelias @ExE-Boss @peterblazejewicz @addaleax @victorperin @ZYSzys @NodeJS @LinusU @wafuwafu13 @mcollina @Semigradsky +/types/node/v20/ @Microsoft @jkomyno @alvis @r3nya @btoueg @smac89 @touffy @DeividasBakanas @eyqs @Hannes-Magnusson-CK @hoo29 @kjin @ajafff @islishude @mwiktorczyk @mohsen1 @galkin @parambirs @eps1lon @ThomasdenH @WilcoBakker @wwwy3y3 @samuela @kuehlein @bhongy @chyzwar @trivikr @yoursunny @qwelias @ExE-Boss @peterblazejewicz @addaleax @victorperin @ZYSzys @NodeJS @LinusU @wafuwafu13 @mcollina @Semigradsky /types/node-7z/ @erkie @colin969 /types/node-abi/ @ffflorian /types/node-apple-receipt-verify/ @serinuntius @@ -5262,6 +5302,7 @@ /types/node-calendar/ @luzianz /types/node-canvas-text/ @carboneater /types/node-cleanup/ @agadar +/types/node-cmd/ @e6nlaq /types/node-crate/ @gjednaszewski /types/node-cron/ @maximelkin @burtek @RMHonor @ataberkylmz @aseidma @ghostebony /types/node-cron/v2/ @maximelkin @burtek @RMHonor @ataberkylmz @@ -5423,7 +5464,7 @@ /types/npm-user-packages/ @BendingBender /types/npm-which/ @manuth /types/npm-whoami/ @JoshuaKGoldberg -/types/npmcli__arborist/ @forivall +/types/npmcli__arborist/ @forivall @russellhaering /types/npmcli__ci-detect/ @aminya /types/npmcli__config/ @forivall /types/npmcli__map-workspaces/ @forivall @@ -5461,7 +5502,7 @@ /types/oauth-signature/ @okcoker /types/oauth.js/ @nobuoka /types/oauth2-implicit/ @maxbogus -/types/oauth2-server/ @vangorra @cirick @d-fischer @rvitorsantos +/types/oauth2-server/ @vangorra @cirick @d-fischer /types/oauth2orize/ @wokim @heycalmdown /types/oauth2orize-pkce/ @mtgto /types/obelisk.js/ @bdrupieski @@ -5612,6 +5653,7 @@ /types/pako/v1/ @calebegg @hlthi /types/palx/ @mikefowler /types/pangu/ @plantain-00 @AH-dark +/types/pannellum/ @zhirzh /types/papaparse/ @torpedro @rainshen49 @jfloff @johnnyreilly @albertorestifo @jliuhtonen @rbarbazz @peterblazejewicz @emmanuelgautier @OpportunityLiu /types/parallel-transform/ @djcsdy /types/paralleljs/ @jbaldwin @@ -5697,6 +5739,7 @@ /types/passport-jwt/ @mugeso @alsiola @carlosscheffer @jindev @stbychkov /types/passport-kakao/ @Park9eon @zerocho /types/passport-lastfm/ @nyo +/types/passport-line/ @niclimcy /types/passport-linkedin-oauth2/ @andrewvetovitz /types/passport-local/ @SomaticIT /types/passport-local-mongoose/ @linusbrolin @@ -5855,7 +5898,7 @@ /types/pleasanter-web-script/ @yamada28go /types/pleasejs/ @nakakura /types/plist/ @higuri -/types/plotly.js/ @chrisgervang @martinduparc @frederikaalund @taoqf @Dadstart @szechyjs @soorajpudiyadath @jonfreedman @meganrm @milesjos @skippercool @mtadams007 @marnett-git @peterblazejewicz @brammitch @blizzardjessica @olegshilov @PabloGracia @jvgogh @jpabdou +/types/plotly.js/ @chrisgervang @martinduparc @frederikaalund @taoqf @Dadstart @szechyjs @soorajpudiyadath @jonfreedman @meganrm @milesjos @skippercool @marnett-git @peterblazejewicz @brammitch @blizzardjessica @olegshilov @PabloGracia @jvgogh @jpabdou /types/plotly.js-basic-dist/ @DreierF /types/plotly.js-basic-dist-min/ @josiahkhor @DreierF /types/plotly.js-dist-min/ @andrefarzat @@ -5887,6 +5930,7 @@ /types/polyline/ @Kern0 /types/polymer/ @lgrignon /types/poool-access/ @maximedasilva @dackmin +/types/poool-engage/ @maximedasilva @dackmin @antoinechassagne /types/popcnt32/ @BendingBender /types/popcorn/ @grapswiz /types/popoto/ @alma3lol @@ -6158,6 +6202,8 @@ /types/rails__request.js/ @alexandergitter /types/rails__ujs/ @fsubal @abcang /types/ramda/ @harris-miller @Nicholaiii @kedashoe @adispring +/types/random-access-file/ @EvanHahn +/types/random-access-storage/ @EvanHahn /types/random-boolean/ @BendingBender /types/random-bytes/ @sripberger /types/random-gradient/ @dm1sh @@ -6247,7 +6293,6 @@ /types/react/v15/ @johnnyreilly @bbenezech @pzavolinsky @ericanderson @DovydasNavickas @onigoetz @zieka /types/react/v16/ @johnnyreilly @bbenezech @pzavolinsky @ericanderson @DovydasNavickas @theruther4d @guilhermehubner @ferdaber @jrakotoharisoa @pascaloliv @hotell @franklixuefei @Jessidhia @saranshkataria @lukyth @eps1lon @zieka @dancerphil @dimitropoulos @disjukr @vhfmag @hellatan @priyanshurav /types/react/v17/ @johnnyreilly @bbenezech @pzavolinsky @ericanderson @DovydasNavickas @theruther4d @guilhermehubner @ferdaber @jrakotoharisoa @pascaloliv @hotell @franklixuefei @Jessidhia @saranshkataria @lukyth @eps1lon @zieka @dancerphil @dimitropoulos @disjukr @vhfmag @hellatan @priyanshurav @konsalex -/types/react-adal/ @dkorolev1 /types/react-adaptive-hooks/ @stramel /types/react-add-to-calendar/ @koss-lebedev /types/react-albus/ @sseppola @conradreuter @kuirak @@ -6339,7 +6384,6 @@ /types/react-datagrid/ @stephenjelfs /types/react-date-range/ @Junbong @Curzy @DemetriouJohn /types/react-date-range/v0/ @Junbong -/types/react-datepicker/ @radziksh @smrq @royxue @KoalaHuman @justingrant @aviklai @seckie @kerry-g @ShiftrTechSAS @1pete @y @inomn /types/react-dates/ @ArturAmpilogov @NathanNZ @cgriebel @jsonunger /types/react-detect-offline/ @rhythmbhiwani /types/react-dev-utils/ @ark120202 @@ -6734,7 +6778,7 @@ /types/react-side-effect/ @remojansen @0xcaff /types/react-sidebar/ @jeroenvervaeke /types/react-signature-canvas/ @ksocha -/types/react-simple-maps/ @thepocp @pronebird @komenank +/types/react-simple-maps/ @thepocp @pronebird @komenank @piercejmorris /types/react-simple-oauth2-login/ @kostassite /types/react-simple-tooltip/ @classdome @foreverealize /types/react-size-reporter/ @MattiasMartens @@ -6872,7 +6916,7 @@ /types/record-locator/ @Kage0x3B /types/recorder-js/ @higuri /types/recordrtc/ @k-yle @moonrailgun -/types/recurly__recurly-js/ @chrissrogers +/types/recurly__recurly-js/ @chrissrogers @douglasmiller /types/recursive-readdir/ @MicahZoltu /types/redact-axios-error/ @AminFazlMondo /types/redact-secrets/ @wrumsby @@ -7020,7 +7064,7 @@ /types/resolve/ @marionebl @ajafff @ljharb /types/resolve-bin/ @cameronhunter /types/resolve-dir/ @mrozio13pl -/types/resolve-id-refs/ @morganmspencer +/types/resolve-id-refs/ @lunchbreakdev /types/resolve-options/ @delprzemo /types/resolve-path/ @fer22f /types/resolve-protobuf-schema/ @claasahl @@ -7725,6 +7769,7 @@ /types/stream-each/ @djcsdy /types/stream-fork/ @mjwwit /types/stream-json/ @uhop +/types/stream-line-wrapper/ @remcohaszing /types/stream-meter/ @mugeso /types/stream-series/ @k-kagurazaka /types/stream-shift/ @djcsdy @@ -7741,7 +7786,6 @@ /types/streamjs/ @erosb /types/streamsaver/ @ennmichael /types/streamsearch/ @awbx -/types/streamtest/ @lummish /types/streamx/ @martinheidegger /types/stremio-addon-sdk/ @sleeyax @victorgveloso /types/strftime/ @cyrilschumacher @@ -7938,7 +7982,7 @@ /types/task-worklet/ @karol-majewski /types/tasker-js-runner/ @ivansoriarab /types/taskkill/ @peterblazejewicz -/types/tcp-ping/ @stegano @rymate1234 +/types/tcp-ping/ @stegano /types/tcp-port-used/ @gautejohan /types/tdigest/ @BendingBender /types/tdweb/ @esindger @@ -8152,7 +8196,6 @@ /types/ttest/ @eps1lon /types/ttf2eot/ @casaper /types/ttf2woff/ @casaper -/types/ttf2woff2/ @ThomasdenH /types/tti-polyfill/ @derduher /types/tunajs/ @pastelmind /types/tunnel/ @BendingBender @@ -8325,7 +8368,7 @@ /types/useragent/ @geoffreak @peterblazejewicz /types/usetube/ @lynellf /types/uslug/ @rokt33r -/types/uswds__uswds/ @morganmspencer @aduth +/types/uswds__uswds/ @lunchbreakdev @aduth /types/utf-8-validate/ @OpportunityLiu /types/utf8/ @peterblazejewicz /types/utif/ @smajl @nkprince007 @massic80 @@ -8424,6 +8467,7 @@ /types/vision/ @jasonswearingen @AJamesPhillips @lenovouser /types/vision/v4/ @jasonswearingen @AJamesPhillips /types/vitalsigns/ @cyrilschumacher +/types/vite-plugin-react-control-statements/ @kirankunigiri /types/vite-plugin-react-svg/ @priyanshurav /types/vivus/ @DanielRosenwasser @lekhmanrus @shuta13 @peterblazejewicz /types/viz.js/ @mckaysalisbury @@ -8575,6 +8619,7 @@ /types/webpack-manifest-plugin/ @r3nya @monsonjeremy /types/webpack-merge-and-include-globally/ @peterblazejewicz /types/webpack-node-externals/ @mtraynham @MrSpoocy @peterblazejewicz +/types/webpack-react-component-name/ @DorianLatchague /types/webpack-serve/ @Jokcy @ZSkycat /types/webpack-serve/v1/ @Jokcy @ZSkycat /types/webpack-shell-plugin/ @peterblazejewicz @@ -8599,6 +8644,7 @@ /types/websql/ @TeamworkGuy2 /types/webtorrent/ @niieani @tlaziuk @gjuchault @cheeseandcereal /types/webvr-api/ @efokschaner +/types/webvtt-parser/ @dodomorandi /types/webxr/ @robrohan @RaananW @capnmidnight @sorskoot /types/wechat-miniprogram/ @wechat-miniprogram @SgLy @TtTRz /types/wechat-miniprogram-xmly/ @Durianicecream @@ -8630,6 +8676,7 @@ /types/wicg-js-self-profiling/ @NotWoods /types/wicg-mediasession/ @jucrouzet @blueset /types/wicg-web-app-launch/ @christianliebel +/types/wicket/ @llamington /types/wif/ @danwbyrne /types/wifgrs/ @gruve-p /types/wiiu/ @mzsm diff --git a/.github/actions/setup-for-scripts/action.yml b/.github/actions/setup-for-scripts/action.yml new file mode 100644 index 00000000000000..54f2e373c7dd92 --- /dev/null +++ b/.github/actions/setup-for-scripts/action.yml @@ -0,0 +1,13 @@ +name: Set up scripts +description: Set up repo for running scripts + +runs: + using: composite + steps: + - uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2 + with: + node-version: '20' + - uses: pnpm/action-setup@fe02b34f77f8bc703788d5817da081398fad5dd2 # v4.0.0 + with: + run_install: | + - args: [--filter, ., --filter, '{./scripts}...'] diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml index d14e02349f41ff..572c96adf30ddf 100644 --- a/.github/workflows/CI.yml +++ b/.github/workflows/CI.yml @@ -30,12 +30,12 @@ jobs: matrix: ${{ steps.matrix.outputs.matrix }} steps: - - uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6 + - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 with: # Need this to be able to inquire about origin/master filter: blob:none # https://github.blog/2020-12-21-get-up-to-speed-with-partial-clone-and-shallow-clone/ fetch-depth: 0 # Default is 1; need to set to 0 to get the benefits of blob:none. - - uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2 + - uses: actions/setup-node@1e60f620b9541d16bece96c5465dc8ee9832be0b # v4.0.3 with: node-version: '20' @@ -62,12 +62,12 @@ jobs: fail-fast: false steps: - - uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6 + - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 with: # Need this to be able to inquire about origin/master filter: blob:none # https://github.blog/2020-12-21-get-up-to-speed-with-partial-clone-and-shallow-clone/ fetch-depth: 0 # Default is 1; need to set to 0 to get the benefits of blob:none. - - uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2 + - uses: actions/setup-node@1e60f620b9541d16bece96c5465dc8ee9832be0b # v4.0.3 with: node-version: '20' @@ -115,7 +115,7 @@ jobs: if: ${{ github.event_name == 'pull_request' }} - name: Upload suggestions - uses: actions/upload-artifact@65462800fd760344b1a7b4382951275a0abb4808 # v4.3.3 + uses: actions/upload-artifact@0b2256b8c012f0828dc542b3febcab082c67f72b # v4.3.4 with: name: suggestions_${{ matrix.shardId }}_${{ matrix.shardCount }} if-no-files-found: ignore @@ -131,21 +131,14 @@ jobs: - test steps: - - uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6 - - uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2 - with: - node-version: '20' - - - uses: pnpm/action-setup@fe02b34f77f8bc703788d5817da081398fad5dd2 # v4.0.0 - with: - run_install: | - - args: [--filter, ., --filter, '{./scripts}...'] + - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 + - uses: ./.github/actions/setup-for-scripts - name: Get suggestions dir id: suggestions-dir run: echo "path=$(node ./scripts/get-suggestions-dir.js)" >> "$GITHUB_OUTPUT" - - uses: actions/download-artifact@65a9edc5881444af0b9093a5e628f2fe47ea3b2e # v4.1.7 + - uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8 with: path: ${{ steps.suggestions-dir.outputs.path }} merge-multiple: true @@ -168,14 +161,7 @@ jobs: if: github.repository == 'DefinitelyTyped/DefinitelyTyped' steps: - - uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6 - - uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2 - with: - node-version: '20' - - - uses: pnpm/action-setup@fe02b34f77f8bc703788d5817da081398fad5dd2 # v4.0.0 - with: - run_install: | - - args: [--filter, ., --filter, '{./scripts}...'] + - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 + - uses: ./.github/actions/setup-for-scripts - run: pnpm tsc -p ./scripts diff --git a/.github/workflows/UpdateCodeowners.yml b/.github/workflows/UpdateCodeowners.yml index c54c856bfc3dfc..c925d73590f53c 100644 --- a/.github/workflows/UpdateCodeowners.yml +++ b/.github/workflows/UpdateCodeowners.yml @@ -21,17 +21,11 @@ jobs: if: github.repository == 'DefinitelyTyped/DefinitelyTyped' steps: - - uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6 + - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 with: fetch-depth: 0 - - uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2 - with: - node-version: '20' - - uses: pnpm/action-setup@fe02b34f77f8bc703788d5817da081398fad5dd2 # v4.0.0 - with: - run_install: | - - args: [--filter, ., --filter, '{./scripts}...'] + - uses: ./.github/actions/setup-for-scripts - run: git config --global user.email "typescriptbot@microsoft.com" - run: git config --global user.name "TypeScript Bot" diff --git a/.github/workflows/format-and-commit.yml b/.github/workflows/format-and-commit.yml index 2a266c8b306888..0513aee6dc20c6 100644 --- a/.github/workflows/format-and-commit.yml +++ b/.github/workflows/format-and-commit.yml @@ -14,18 +14,11 @@ jobs: runs-on: ubuntu-latest if: github.repository == 'DefinitelyTyped/DefinitelyTyped' steps: - - uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6 + - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 with: # Use a deploy key so that CI triggers on pushes; we want to know if formatting broke something. ssh-key: ${{ secrets.DEPLOY_KEY }} - - uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2 - with: - node-version: '20' - - - uses: pnpm/action-setup@fe02b34f77f8bc703788d5817da081398fad5dd2 # v4.0.0 - with: - run_install: | - - args: [--filter, ., --filter, '{./scripts}...'] + - uses: ./.github/actions/setup-for-scripts - name: Get date id: date diff --git a/.github/workflows/ghostbuster.yml b/.github/workflows/ghostbuster.yml index db8276280763ef..7235b4304bb592 100644 --- a/.github/workflows/ghostbuster.yml +++ b/.github/workflows/ghostbuster.yml @@ -23,17 +23,8 @@ jobs: if: github.repository == 'DefinitelyTyped/DefinitelyTyped' steps: - - uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6 - - - uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2 - with: - node-version: '20' - - - uses: pnpm/action-setup@fe02b34f77f8bc703788d5817da081398fad5dd2 # v4.0.0 - with: - run_install: | - - args: [--filter, ., --filter, '{./scripts}...'] - + - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 + - uses: ./.github/actions/setup-for-scripts - run: node ./scripts/ghostbuster.js > ${{ runner.temp }}/comment.md env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} @@ -51,7 +42,7 @@ jobs: fi - if: ${{ inputs.skipPR != 'true' }} - uses: peter-evans/create-pull-request@6d6857d36972b65feb161a90e484f2984215f83e # v6.0.5 + uses: peter-evans/create-pull-request@c5a7806660adbe173f04e3e038b0ccdcd758773c # v6.1.0 with: token: ${{ secrets.GITHUB_TOKEN }} commit-message: 'Remove contributors with deleted accounts #no-publishing-comment' diff --git a/.github/workflows/lint-md.yml b/.github/workflows/lint-md.yml index 7af7e7db49fbc6..7afd2d6ba396e6 100644 --- a/.github/workflows/lint-md.yml +++ b/.github/workflows/lint-md.yml @@ -11,9 +11,6 @@ jobs: runs-on: ubuntu-latest if: github.repository == 'DefinitelyTyped/DefinitelyTyped' steps: - - uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6 - - uses: pnpm/action-setup@fe02b34f77f8bc703788d5817da081398fad5dd2 # v4.0.0 - with: - run_install: | - - args: [--filter, ., --filter, '{./scripts}...'] + - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 + - uses: ./.github/actions/setup-for-scripts - run: pnpm remark --frail . .github diff --git a/.github/workflows/pnpm-cache.yml b/.github/workflows/pnpm-cache.yml index 2a940ee59d4e25..6246636b48be38 100644 --- a/.github/workflows/pnpm-cache.yml +++ b/.github/workflows/pnpm-cache.yml @@ -10,8 +10,8 @@ jobs: create-cache: runs-on: ubuntu-latest steps: - - uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6 - - uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2 + - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 + - uses: actions/setup-node@1e60f620b9541d16bece96c5465dc8ee9832be0b # v4.0.3 with: node-version: '20' - uses: pnpm/action-setup@fe02b34f77f8bc703788d5817da081398fad5dd2 # v4.0.0 diff --git a/.github/workflows/support-window.yml b/.github/workflows/support-window.yml index f204fa445eed4f..7914dfb17b205d 100644 --- a/.github/workflows/support-window.yml +++ b/.github/workflows/support-window.yml @@ -23,15 +23,9 @@ jobs: if: github.repository == 'DefinitelyTyped/DefinitelyTyped' runs-on: ubuntu-latest steps: - - uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6 + - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 + - uses: ./.github/actions/setup-for-scripts - - uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2 - with: - node-version: '20' - - uses: pnpm/action-setup@fe02b34f77f8bc703788d5817da081398fad5dd2 # v4.0.0 - with: - run_install: | - - args: [--filter, ., --filter, '{./scripts}...'] - name: Fetch TypeScript versions and release dates from npm run: | npm view --json typescript time | diff --git a/.github/workflows/watchdog-publisher.yml b/.github/workflows/watchdog-publisher.yml new file mode 100644 index 00000000000000..9ac009aa93ffb9 --- /dev/null +++ b/.github/workflows/watchdog-publisher.yml @@ -0,0 +1,30 @@ +name: Publisher watchdog + +on: + schedule: + # Hourly + - cron: '15 0/2 * * *' + workflow_dispatch: + +jobs: + watchdog: + if: github.repository == 'DefinitelyTyped/DefinitelyTyped' + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 + - uses: ./.github/actions/setup-for-scripts + + - run: node ./scripts/watchdog-publisher.js + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + + - name: Notify dedicated teams channel + if: ${{ failure() }} + uses: jdcargile/ms-teams-notification@28e5ca976c053d54e2b852f3f38da312f35a24fc # v1.4 + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + ms-teams-webhook-uri: ${{ secrets.MS_TEAMS_WATCHDOG_WEBHOOK_URI }} + notification-summary: Publisher watchdog failed + notification-color: dc3545 + timezone: America/Los_Angeles + verbose-logging: true diff --git a/.github/workflows/watchdog-typescript-bot.yml b/.github/workflows/watchdog-typescript-bot.yml new file mode 100644 index 00000000000000..4749b7b357e178 --- /dev/null +++ b/.github/workflows/watchdog-typescript-bot.yml @@ -0,0 +1,19 @@ +name: typescript-bot watchdog + +on: + schedule: + # Hourly + - cron: '15 1/2 * * *' + workflow_dispatch: + +jobs: + watchdog: + if: github.repository == 'DefinitelyTyped/DefinitelyTyped' + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 + - uses: ./.github/actions/setup-for-scripts + + - run: node ./scripts/watchdog-typescript-bot.js + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/README.es.md b/README.es.md index 97899da078aa94..d9a995d1299ffd 100644 --- a/README.es.md +++ b/README.es.md @@ -265,7 +265,7 @@ Si un archivo no es probado ni referenciado en `index.d.ts`, añádelo a un arch DT tiene el concepto de "Propietarios de Definiciones" que son personas que desean mantener la calidad de los tipos de un módulo en particular. - Agregarte a la lista hará que recibas notificaciones (a través de tu nombre de usuario de GitHub) cada vez que alguien haga una solicitud de extracción o informe sobre el paquete. -- Tus revisiones de solicitudes de extracción tendrán una mayor importancia para [el bot](https://github.com/DefinitelyTyped/dt-mergebot) que mantiene este repositorio. +- Tus revisiones de solicitudes de extracción tendrán una mayor importancia para [el bot](https://github.com/microsoft/DefinitelyTyped-tools/tree/main/packages/mergebot) que mantiene este repositorio. - Los mantenedores de DT confían en los propietarios de las definiciones para asegurar un ecosistema estable, así que por favor, no te agregues ligeramente. Para agregarte como Propietario de Definiciones: diff --git a/README.fr.md b/README.fr.md index bd69a3c437d0d8..d09c2dcbdee87d 100644 --- a/README.fr.md +++ b/README.fr.md @@ -127,7 +127,7 @@ Tout d'abord, [fork](https://guides.github.com/activities/forking/) ce dépôt, Nous utilisons un robot pour permettre à un grand nombre de pull requests vers DefinitelyTyped d'être traitées entièrement en libre-service. Vous pouvez en savoir plus sur [pourquoi et comment ici](https://devblogs.microsoft.com/typescript/changes-to-how-we-manage-definitelytyped/). Voici une référence pratique montrant le cycle de vie de pull request à DT : - + #### Partial clone @@ -385,7 +385,7 @@ Si un fichier n'est ni testé ni référencé dans `index.d.ts`, ajoutez-le à u DT a le concept de "propriétaires de définition" qui sont des personnes qui veulent maintenir la qualité des types d'un module particulier. - En vous ajoutant à la liste, vous serez notifié (via votre nom d'utilisateur GitHub) chaque fois que quelqu'un fera une pull request ou posera un problème concernant le paquet. -- Vos évaluations de PR auront une plus grande importance pour [le bot](https://github.com/DefinitelyTyped/dt-mergebot) qui maintient ce repo. +- Vos évaluations de PR auront une plus grande importance pour [le bot](https://github.com/microsoft/DefinitelyTyped-tools/tree/main/packages/mergebot) qui maintient ce repo. - Les mainteneurs de DT font confiance aux propriétaires des définitions pour assurer un écosystème stable, ne vous ajoutez pas à la légère. Pour vous ajouter en tant que titulaire d'une définition : diff --git a/README.it.md b/README.it.md index ef21a00b5f00f3..d59665bbfe56d6 100644 --- a/README.it.md +++ b/README.it.md @@ -129,7 +129,7 @@ Facciamo uso di un bot per far sì che un gran numero di pull request su Definit Ecco qui un'immagine che mostra il ciclo vitale di una pull request su Definitely Typed. - + #### Clone parziale @@ -362,7 +362,7 @@ Se un file non è nè testato nè riferito nell'`index.d.ts`, aggiungilo in un f DT ha il concetto di "Proprietari delle definizioni", che sono coloro i quali vogliono mantenere la qualità delle definizioni dei tipi di un certo modulo. - Aggiungerti da solo farà sì che tu venga notificato (tramite il tuo nome utente GitHub) ogni volta che qualcuno fa una pull request o un issue su quel package. -- Le tue PR review avranno precedenza maggiore di quelle [dei bot](https://github.com/DefinitelyTyped/dt-mergebot) che mantengono questa repo. +- Le tue PR review avranno precedenza maggiore di quelle [dei bot](https://github.com/microsoft/DefinitelyTyped-tools/tree/main/packages/mergebot) che mantengono questa repo. - I mantenitori di DT stanno ponendo la loro fiducia sui proprietari delle definizioni per mantenere un ecosistema stabile, quindi non aggiungerti senza sapere quello che fai. Per aggiungerti come pprietario delle definizioni: diff --git a/README.ja.md b/README.ja.md index c85790817a2495..e612eb87631927 100644 --- a/README.ja.md +++ b/README.ja.md @@ -122,7 +122,7 @@ declare module "libname" { DefinitelyTyped への大量の PR を全てセルフサービス方式で処理するために bot を導入しています。詳しい方法と理由については[こちら](https://devblogs.microsoft.com/typescript/changes-to-how-we-manage-definitelytyped/)（英語）で確認できます。下図は DefinitelyTyped への PR のライフサイクルを簡単に示したものです。 - + #### 部分的なクローン @@ -378,7 +378,7 @@ DefinitelyTypedのパッケージパブリッシャーは、Definitely Typedの DT には「定義オーナー」というコンセプトがあり、特定のモジュールの型の品質を維持したいと考える人々がいます。 - 自分自身をリストに追加すると、誰かがそのパッケージに関するプルリクエストまたは問題を作成したときに通知を受けることができます（GitHub ユーザー名を介して）。 -- あなたのプルリクエストのレビューは、[このリポジトリを管理するボット](https://github.com/DefinitelyTyped/dt-mergebot)にとって重要度が高くなります。 +- あなたのプルリクエストのレビューは、[このリポジトリを管理するボット](https://github.com/microsoft/DefinitelyTyped-tools/tree/main/packages/mergebot)にとって重要度が高くなります。 - DT メンテナーは、安定したエコシステムを確保するために、定義オーナーに信頼を置いていますので、軽率に自分を追加しないでください。 自分自身を定義オーナーとして追加するには： diff --git a/README.ko.md b/README.ko.md index a5d9181a8d58d7..b194c5a82abb84 100644 --- a/README.ko.md +++ b/README.ko.md @@ -298,7 +298,7 @@ If a file is neither tested nor referenced in `index.d.ts`, add it to a file nam DT has the concept of "Definition Owners" which are people who want to maintain the quality of a particular module's types - Adding yourself to the list will cause you to be notified (via your GitHub username) whenever someone makes a pull request or issue about the package. -- Your PR reviews will have a higher precedence of importance to [the bot](https://github.com/DefinitelyTyped/dt-mergebot) which maintains this repo. +- Your PR reviews will have a higher precedence of importance to [the bot](https://github.com/microsoft/DefinitelyTyped-tools/tree/main/packages/mergebot) which maintains this repo. - The DT maintainers are putting trust in the definition owners to ensure a stable eco-system, please don't add yourself lightly. To Add yourself as a Definition Owner: diff --git a/README.md b/README.md index f382380e55574d..f93c890c50d5f0 100644 --- a/README.md +++ b/README.md @@ -19,8 +19,8 @@ It may be helpful for contributors experiencing any issues with their PRs and pa - Most recent build [type-checked/linted](https://github.com/microsoft/DefinitelyTyped-tools/tree/master/packages/dtslint) cleanly: [![Build status](https://github.com/DefinitelyTyped/DefinitelyTyped/actions/workflows/CI.yml/badge.svg?branch=master&event=push)](https://github.com/DefinitelyTyped/DefinitelyTyped/actions/workflows/CI.yml?query=branch%3Amaster+event%3Apush) - All packages are type-checking/linting cleanly: [![Build status](https://github.com/DefinitelyTyped/DefinitelyTyped/actions/workflows/CI.yml/badge.svg?branch=master&event=schedule)](https://github.com/DefinitelyTyped/DefinitelyTyped/actions/workflows/CI.yml?query=branch%3Amaster+event%3Aschedule) -- All packages are being [published to npm](https://github.com/microsoft/DefinitelyTyped-tools/tree/master/packages/publisher) in under an hour and a half: [![Publish Status](https://dev.azure.com/definitelytyped/DefinitelyTyped/_apis/build/status/DefinitelyTyped.types-publisher-watchdog?branchName=master)](https://dev.azure.com/definitelytyped/DefinitelyTyped/_build/latest?definitionId=5&branchName=master) -- [typescript-bot](https://github.com/typescript-bot) has been active on Definitely Typed [![Activity Status](https://dev.azure.com/definitelytyped/DefinitelyTyped/_apis/build/status/DefinitelyTyped.typescript-bot-watchdog?branchName=master)](https://dev.azure.com/definitelytyped/DefinitelyTyped/_build/latest?definitionId=6&branchName=master) +- All packages are being [published to npm](https://github.com/microsoft/DefinitelyTyped-tools/tree/master/packages/publisher) in under an hour and a half: [![Publish Status](https://github.com/DefinitelyTyped/DefinitelyTyped/actions/workflows/watchdog-publisher.yml/badge.svg)](https://github.com/DefinitelyTyped/DefinitelyTyped/actions/workflows/watchdog-publisher.yml) +- [typescript-bot](https://github.com/typescript-bot) has been active on Definitely Typed [![Activity Status](https://github.com/DefinitelyTyped/DefinitelyTyped/actions/workflows/watchdog-typescript-bot.yml/badge.svg)](https://github.com/DefinitelyTyped/DefinitelyTyped/actions/workflows/watchdog-typescript-bot.yml) - Current [infrastructure status updates](https://github.com/DefinitelyTyped/DefinitelyTyped/issues/44317) If anything here seems wrong or any of the above are failing, please let us know in [the Definitely Typed channel on the TypeScript Community Discord server](https://discord.gg/typescript). @@ -146,7 +146,7 @@ its dependencies. If you need to run tests for packages that _depend_ on `@types We use a bot to let a large number of pull requests to DefinitelyTyped be handled entirely in a self-service manner. You can read more about [why and how here](https://devblogs.microsoft.com/typescript/changes-to-how-we-manage-definitelytyped/). Here is a handy reference showing the life cycle of a pull request to DT: - + #### Partial clone @@ -518,7 +518,7 @@ CI will fail if this file contains the wrong contents and provide the intended v DT has the concept of "Definition Owners" which are people who want to maintain the quality of a particular module's types. - Adding yourself to the list will cause you to be notified (via your GitHub username) whenever someone makes a pull request or issue about the package. -- Your PR reviews will have a higher precedence of importance to [the bot](https://github.com/DefinitelyTyped/dt-mergebot) which maintains this repo. +- Your PR reviews will have a higher precedence of importance to [the bot](https://github.com/microsoft/DefinitelyTyped-tools/tree/main/packages/mergebot) which maintains this repo. - The DT maintainers are putting trust in the definition owners to ensure a stable eco-system, please don't add yourself lightly. To add yourself as a Definition Owner, modify the `owners` array in `package.json`: diff --git a/README.pt.md b/README.pt.md index e6b4edecffbb1b..88288f608d0fbf 100644 --- a/README.pt.md +++ b/README.pt.md @@ -315,7 +315,7 @@ Se um arquivo não for testado nem referenciado no `index.d.ts`, adicione-o em u O DT tem o coneito de "Donos de definição", que são pessoas que querem manter a qualidade dos tipos de um módulo específico - Adicionar você mesmo à lista, vai garantir que você seja notificado (pelo seu usuário do GitHub) sempre que qualquer um fizer uma pull request ou um issue sobre o pacote. -- Suas revisões da PR terão uma precedência de importância maior para [o bot](https://github.com/DefinitelyTyped/dt-mergebot) que mantém este repositório. +- Suas revisões da PR terão uma precedência de importância maior para [o bot](https://github.com/microsoft/DefinitelyTyped-tools/tree/main/packages/mergebot) que mantém este repositório. - Os mantenedores do DT estão confiando nos donos da definição para garantir um ecossistema estável, por favor não se adicione apenas por adicionar. Para se adicionar como um Dono de definição: diff --git a/README.ru.md b/README.ru.md index 0b2f94b60201d0..11c12fa65c345d 100644 --- a/README.ru.md +++ b/README.ru.md @@ -297,7 +297,7 @@ If a file is neither tested nor referenced in `index.d.ts`, add it to a file nam DT has the concept of "Definition Owners" which are people who want to maintain the quality of a particular module's types - Adding yourself to the list will cause you to be notified (via your GitHub username) whenever someone makes a pull request or issue about the package. -- Your PR reviews will have a higher precedence of importance to [the bot](https://github.com/DefinitelyTyped/dt-mergebot) which maintains this repo. +- Your PR reviews will have a higher precedence of importance to [the bot](https://github.com/microsoft/DefinitelyTyped-tools/tree/main/packages/mergebot) which maintains this repo. - The DT maintainers are putting trust in the definition owners to ensure a stable eco-system, please don't add yourself lightly. To Add yourself as a Definition Owner: diff --git a/README.zh-Hans.md b/README.zh-Hans.md index aa650f9514bee4..952160a905e2f5 100644 --- a/README.zh-Hans.md +++ b/README.zh-Hans.md @@ -137,7 +137,7 @@ declare module "libname" { 我们使用机器人来确保能像自助服务一样处理提交至 Definitely Typed 的大量拉取请求。欲知详情，请阅读[此处](https://devblogs.microsoft.com/typescript/changes-to-how-we-manage-definitelytyped/)。下图简要展示了拉取请求的生命周期： - + #### 部分克隆 @@ -419,7 +419,7 @@ const enum Enum { // eslint-disable-line no-const-enum Definitely Typed 有“类型定义所有者”的概念——即愿意维护特定模块类型声明的人。 - 如果你将自己添加到了列表中，当他人发起关于此软件包的 PR 或 issue 时，你将会收到通知（通过你的 GitHub 用户名）。 -- 对于维护本仓库的[机器人](https://github.com/DefinitelyTyped/dt-mergebot)而言，你的 PR 审核将会具有更高优先级以及重要性。 +- 对于维护本仓库的[机器人](https://github.com/microsoft/DefinitelyTyped-tools/tree/main/packages/mergebot)而言，你的 PR 审核将会具有更高优先级以及重要性。 - 为维护稳定的社区环境，DT 维护者对类型定义所有者给予了较高的信任，因此将你自己添加为所有者时，请三思而后行。 若要将你自己添加为类型定义所有者，编辑 `package.json` 中的 `owners` 数组： diff --git a/attw.json b/attw.json index ce2bba44e822ad..30f857792297ec 100644 --- a/attw.json +++ b/attw.json @@ -1162,7 +1162,6 @@ "jquery/v1", "jquery/v2", "jquerymobile", - "jqueryui", "js-clipper", "js-schema", "js-url", diff --git a/docs/support-window.json b/docs/support-window.json index 09d0436b68e460..8681d9aa31b154 100644 --- a/docs/support-window.json +++ b/docs/support-window.json @@ -43,5 +43,6 @@ "5.1": "2023-06-01T17:29:55.756Z", "5.2": "2023-08-24T16:38:15.233Z", "5.3": "2023-11-20T17:35:59.945Z", - "5.4": "2024-03-06T18:14:58.798Z" + "5.4": "2024-03-06T18:14:58.798Z", + "5.5": "2024-06-20T17:37:03.845Z" } diff --git a/docs/support-window.svg b/docs/support-window.svg index 29afbfa7027826..57480b27237d03 100644 --- a/docs/support-window.svg +++ b/docs/support-window.svg @@ -2,4 +2,4 @@ #gh-dark-mode-only:target { color: #ffffff; } -20232024202520264.84.95.05.15.25.35.44.84.95.05.15.25.35.42022-082022-112023-032023-062023-082023-112024-032024-082024-112025-032025-062025-082025-112026-03 \ No newline at end of file +20232024202520264.84.95.05.15.25.35.45.54.84.95.05.15.25.35.45.52022-082022-112023-032023-062023-082023-112024-032024-062024-082024-112025-032025-062025-082025-112026-032026-06 \ No newline at end of file diff --git a/notNeededPackages.json b/notNeededPackages.json index cbfbae160036ac..570edac60cd412 100644 --- a/notNeededPackages.json +++ b/notNeededPackages.json @@ -4,6 +4,10 @@ "libraryName": "3d-bin-packing", "asOfVersion": "1.1.3" }, + "@types/hyphenate-style-name": { + "libraryName": "hyphenate-style-name", + "asOfVersion": "1.1.0" + }, "a11y-dialog": { "libraryName": "a11y-dialog", "asOfVersion": "5.3.2" @@ -528,6 +532,10 @@ "libraryName": "canvaskit-wasm", "asOfVersion": "0.18.1" }, + "carbon__icon-helpers": { + "libraryName": "@carbon/icon-helpers", + "asOfVersion": "10.45.0" + }, "carbon__icons-react": { "libraryName": "@carbon/icons-react", "asOfVersion": "11.29.0" @@ -1817,6 +1825,10 @@ "libraryName": "@types/facebook-js-sdk", "asOfVersion": "0.0.28" }, + "fcostarodrigo__walk": { + "libraryName": "@fcostarodrigo/walk", + "asOfVersion": "6.0.0" + }, "fecha": { "libraryName": "fecha", "asOfVersion": "2.3.1" @@ -4799,6 +4811,10 @@ "libraryName": "react-countup", "asOfVersion": "4.3.1" }, + "react-datepicker": { + "libraryName": "react-datepicker", + "asOfVersion": "7.0.0" + }, "react-datetime-picker": { "libraryName": "react-datetime-picker", "asOfVersion": "5.0.0" @@ -5875,6 +5891,10 @@ "libraryName": "stream-to-string", "asOfVersion": "1.2.0" }, + "streamtest": { + "libraryName": "streamtest", + "asOfVersion": "3.0.0" + }, "string-argv": { "libraryName": "string-argv", "asOfVersion": "0.3.0" @@ -6183,6 +6203,10 @@ "libraryName": "tstl", "asOfVersion": "1.5.7" }, + "ttf2woff2": { + "libraryName": "ttf2woff2", + "asOfVersion": "6.0.0" + }, "tus-js-client": { "libraryName": "tus-js-client", "asOfVersion": "2.1.0" diff --git a/package.json b/package.json index 63e3399bb1aef4..2eea6b42636b54 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,7 @@ "@definitelytyped/typescript-versions": "latest", "@definitelytyped/utils": "latest", "danger": "^11.2.3", - "dprint": "^0.45.0", + "dprint": "^0.47.2", "eslint-plugin-jsdoc": "^44.2.7", "husky": "^8.0.3", "lint-staged": "^15.2.0", diff --git a/scripts/ghostbuster.js b/scripts/ghostbuster.js index 6118025a83ef62..64f797c02ac921 100644 --- a/scripts/ghostbuster.js +++ b/scripts/ghostbuster.js @@ -1,5 +1,5 @@ -import { Octokit } from "@octokit/core"; import { existsSync, readdirSync, readFileSync, writeFileSync } from "node:fs"; +import { Octokit } from "octokit"; /** @type {(array: readonly T[] | undefined, mapfn: (x: T, i: number) => readonly U[]) => readonly U[]} */ function flatMap(array, mapfn) { diff --git a/scripts/package.json b/scripts/package.json index 6fa04df5156498..992ef784be6585 100644 --- a/scripts/package.json +++ b/scripts/package.json @@ -2,7 +2,6 @@ "private": true, "type": "module", "devDependencies": { - "@octokit/core": "^3.5.1", "@types/d3-array": "^3.0.0", "@types/d3-axis": "^3.0.0", "@types/d3-scale": "^4.0.0", @@ -24,6 +23,7 @@ "d3-time-format": "^4.0.0", "jsdom": "^17.0.0", "json-stable-stringify": "^1.0.2", + "octokit": "^4.0.2", "shelljs": "^0.8.5", "typescript": "next", "w3c-xmlserializer": "^2.0.0", diff --git a/scripts/tsconfig.json b/scripts/tsconfig.json index 76de2451ad92f8..471561e3ca856a 100644 --- a/scripts/tsconfig.json +++ b/scripts/tsconfig.json @@ -1,6 +1,6 @@ { "compilerOptions": { - "target": "es2019", + "target": "es2023", "module": "nodenext", "strict": true, "allowJs": true, diff --git a/scripts/watchdog-publisher.js b/scripts/watchdog-publisher.js new file mode 100644 index 00000000000000..ba69c76ac45c2d --- /dev/null +++ b/scripts/watchdog-publisher.js @@ -0,0 +1,185 @@ +import { Octokit } from "octokit"; +import sh from "shelljs"; + +var gh = new Octokit({ + auth: process.env.GITHUB_TOKEN, +}); + +// This script calls out to npm; ensure corepack doesn't complain if present. +process.env.COREPACK_ENABLE_STRICT = "0"; + +async function main() { + const prs = await recentPrs(); + const longestLatency = recentPackages(prs); + if (longestLatency > 5400) { + console.log("types-publisher's longest unpublished latency was over 1.5 hour."); + throw new Error(); + } +} + +/** + * 1. Only match paths that begin with types/ + * 2. Only match paths that end with index.d.ts; test changes don't cause a republish + * 3. Capture the package name + */ +const packageNameFromIndexDts = /^types\/([^\/]+?)\/index.d.ts$/; + +/** + * @param {"created" | "updated"} sort + */ +async function getTopFiveMerged(sort) { + const iterator = gh.paginate.iterator(gh.rest.pulls.list, { + owner: "DefinitelyTyped", + repo: "DefinitelyTyped", + state: "closed", + per_page: 100, + direction: "desc", + sort, + }); + + const result = []; + + for await (const { data: pulls } of iterator) { + for (const pull of pulls) { + if (result.length === 5) { + return result; + } + + if (!pull.merged_at) { + continue; + } + + result.push(pull); + } + } + + return result; +} + +/** @returns {Promise>} */ +async function recentPrs() { + console.log("search for 5 most recently created PRs"); + const searchByCreatedDate = await getTopFiveMerged("created"); + console.log("search for 5 most recently updated PRs"); + const searchByUpdateDate = await getTopFiveMerged("updated"); + + /** @type {Map} */ + const prs = new Map(); + for (const it of searchByCreatedDate) { + await addPr(it, prs); + } + for (const it of searchByUpdateDate) { + await addPr(it, prs); + } + return prs; +} +/** + * @param {{ number: number }} item + * @param {Map} prs + */ +async function addPr(item, prs) { + console.log("get merge_at date for PR", item.number); + const mergedAt = (await gh.rest.pulls.get({ + owner: "DefinitelyTyped", + repo: "DefinitelyTyped", + pull_number: item.number, + })).data.merged_at; + if (mergedAt == null) { + return; + } + const mergeDate = new Date(mergedAt); + console.log("list first 100 files for PR", item.number); + const fileEntries = (await gh.rest.pulls.listFiles({ + owner: "DefinitelyTyped", + repo: "DefinitelyTyped", + pull_number: item.number, + per_page: 100, + })).data; + /** @type {Set} */ + const packages = new Set(); + /** @type {Set} */ + const deleteds = new Set(); + const editsNotNeededPackages = !!fileEntries.find(e => e.filename.match("notNeededPackages.json")); + for (const fileChange of fileEntries) { + const packageName = fileChange.filename.match(packageNameFromIndexDts); + if (packageName == null) { + continue; + } + if (fileChange.status === "removed") { + if (editsNotNeededPackages) { + deleteds.add(packageName[1]); + packages.add(packageName[1]); + } + } else { + packages.add(packageName[1]); + } + } + for (const name of packages) { + const prev = prs.get(name); + if (!prev || mergeDate > prev.mergeDate) { + prs.set(name, { mergeDate, pr: item.number, deleted: deleteds.has(name) }); + } + } +} +/** + * @param {Date} m1 + * @param {Date} m2 + */ +function monthSpan(m1, m2) { + var diff = m1.getMonth() - m2.getMonth(); + return diff < 0 ? diff + 12 : diff; +} +/** @param {Map} prs */ +function recentPackages(prs) { + console.log(); + console.log(); + console.log("## Interesting PRs ##"); + let longest = 0; + let longestName = "No unpublished PRs found"; + for (const [name, { mergeDate, pr, deleted }] of prs) { + const { deprecated, publishDate } = parseNpmInfo( + sh.exec(`npm info @types/${name} time.modified deprecated`, { silent: true }).stdout.toString(), + ); + if (mergeDate > publishDate || isNaN(publishDate.getTime()) || deprecated !== deleted) { + console.log( + `${name}: #${pr} not published yet; latency so far: ${(Date.now() - mergeDate.valueOf()) / 1000}`, + ); + console.log(" merged:" + mergeDate); + console.log(" published:" + publishDate); + const latency = Date.now() - mergeDate.valueOf(); + if (latency > longest) { + longest = latency; + longestName = name; + } + } else if (monthSpan(publishDate, mergeDate) > 1) { + console.log(`${name}: published long before merge; probably a rogue edit to #${pr}`); + console.log(" merged:" + mergeDate); + console.log(" published:" + publishDate); + } else if (publishDate.valueOf() - mergeDate.valueOf() > 100000000) { + console.log(`${name}: #${pr} very long latency: ${(publishDate.valueOf() - mergeDate.valueOf()) / 1000}`); + console.log(" merged:" + mergeDate); + console.log(" published:" + publishDate); + } + } + console.log(); + console.log(); + console.log("## Longest publish latency ##"); + console.log(longestName + ": " + (longest / 1000)); + return longest / 1000; +} +/** @param {string} info */ +function parseNpmInfo(info) { + if (info.includes("deprecated")) { + const firstLine = info.split("\n")[0]; + return { + publishDate: new Date(firstLine.slice(firstLine.indexOf("'") + 1, firstLine.length - 1)), + deprecated: true, + }; + } else { + return { publishDate: new Date(info.trim()), deprecated: false }; + } +} +main().catch(error => { + console.error(error && (error.stack || error.message || error)); + process.exit(1); +}); diff --git a/scripts/watchdog-typescript-bot.js b/scripts/watchdog-typescript-bot.js new file mode 100644 index 00000000000000..0187c0559cf45b --- /dev/null +++ b/scripts/watchdog-typescript-bot.js @@ -0,0 +1,54 @@ +import { Octokit } from "octokit"; +var gh = new Octokit({ + auth: process.env.GITHUB_TOKEN, +}); + +async function main() { + const activity = await recentActivity(); + + if (!activity) { + console.log("Couldn't find any recent activity for typescript-bot"); + throw new Error(); + } + const [anyRecent, botRecent] = activity; + // 1. anyRecent - botRecent < 2 hours || present - botRecent < 2 hour + console.log(); + console.log(); + console.log("Time since typescript-bot's last activity: " + (new Date().valueOf() - botRecent.valueOf()) / 1000); + console.log( + "Time between most recent activity and typescript-bot's most recent activity: " + + (anyRecent.valueOf() - botRecent.valueOf()) / 1000, + ); + if ( + (new Date().valueOf() - botRecent.valueOf()) > 7200000 && (anyRecent.valueOf() - botRecent.valueOf()) > 7200000 + ) { + console.log("typescript-bot hasn't responded or been active in over 2 hours (7200 seconds)"); + throw new Error(); + } +} + +/** @returns {Promise<[Date, Date] | undefined>} */ +async function recentActivity() { + const dtEvents = await gh.rest.activity.listRepoEvents({ owner: "DefinitelyTyped", repo: "DefinitelyTyped" }); + let latestEvent; + for (const event of dtEvents.data) { + if (!event.created_at) continue; + latestEvent = new Date(event.created_at); + break; + } + if (!latestEvent) { + throw new Error("couldn't get events for DefinitelyTyped repo"); + } + + const events = await gh.rest.activity.listPublicEventsForUser({ username: "typescript-bot" }); + for (const event of events.data) { + if (!event.created_at) continue; + if (event.repo.name === "DefinitelyTyped/DefinitelyTyped") { + return [latestEvent, new Date(event.created_at)]; + } + } +} +main().catch(e => { + console.log(e); + process.exit(1); +}); diff --git a/types/ads-client/ads-client-tests.ts b/types/ads-client/ads-client-tests.ts index 51fbcc8a33e516..bd41ef21cff395 100644 --- a/types/ads-client/ads-client-tests.ts +++ b/types/ads-client/ads-client-tests.ts @@ -3,6 +3,10 @@ import * as ads from "ads-client"; const client = new ads.Client({ targetAmsNetId: "localhost", targetAdsPort: 851, + localAddress: null, + localTcpPort: null, + localAmsNetId: null, + localAdsPort: null, }); async function usage() { diff --git a/types/ads-client/index.d.ts b/types/ads-client/index.d.ts index 2e3fddd5924f8c..e1d0dbbb86e427 100644 --- a/types/ads-client/index.d.ts +++ b/types/ads-client/index.d.ts @@ -5,26 +5,26 @@ import EventEmitter = require("events"); export interface Settings { targetAmsNetId: string; targetAdsPort: number; - objectifyEnumerations?: boolean; - convertDatesToJavascript?: boolean; - readAndCacheSymbols?: boolean; - readAndCacheDataTypes?: boolean; - disableSymbolVersionMonitoring?: boolean; - routerTcpPort?: number; - routerAddress?: string; - localAddress?: string; - localTcpPort?: number; - localAmsNetId?: string; - localAdsPort?: number; - timeoutDelay?: number; - hideConsoleWarnings?: boolean; - autoReconnect?: boolean; - reconnectInterval?: number; - checkStateInterval?: number; - connectionDownDelay?: number; - allowHalfOpen?: boolean; - disableBigInt?: boolean; - bareClient?: boolean; + objectifyEnumerations?: boolean | null | undefined; + convertDatesToJavascript?: boolean | null | undefined; + readAndCacheSymbols?: boolean | null | undefined; + readAndCacheDataTypes?: boolean | null | undefined; + disableSymbolVersionMonitoring?: boolean | null | undefined; + routerTcpPort?: number | null | undefined; + routerAddress?: string | null | undefined; + localAddress?: string | null | undefined; + localTcpPort?: number | null | undefined; + localAmsNetId?: string | null | undefined; + localAdsPort?: number | null | undefined; + timeoutDelay?: number | null | undefined; + hideConsoleWarnings?: boolean | null | undefined; + autoReconnect?: boolean | null | undefined; + reconnectInterval?: number | null | undefined; + checkStateInterval?: number | null | undefined; + connectionDownDelay?: number | null | undefined; + allowHalfOpen?: boolean | null | undefined; + disableBigInt?: boolean | null | undefined; + bareClient?: boolean | null | undefined; } export interface Metadata { diff --git a/types/aframe/index.d.ts b/types/aframe/index.d.ts index 1d1f739269d825..081326cb3364cb 100644 --- a/types/aframe/index.d.ts +++ b/types/aframe/index.d.ts @@ -4,7 +4,6 @@ import * as anime from "animejs"; import * as three from "three"; -import * as threeDeprecated from "three/examples/jsm/deprecated/Geometry"; export type ThreeLib = typeof three; export type AnimeLib = typeof anime; @@ -194,7 +193,7 @@ export interface EntityEventMap { export interface Geometry { data: T; name: string; - geometry: threeDeprecated.Geometry; + geometry: three.BufferGeometry; schema: Schema; init(data: any): void; diff --git a/types/aframe/test/aframe-tests.ts b/types/aframe/test/aframe-tests.ts index 0aaecc5a16d8ae..14dda219afe4e8 100644 --- a/types/aframe/test/aframe-tests.ts +++ b/types/aframe/test/aframe-tests.ts @@ -9,7 +9,6 @@ import { SystemDefinition, THREE, } from "aframe"; -import * as threeDeprecated from "three/examples/jsm/deprecated/Geometry"; // Global const threeCamera = new AFRAME.THREE.OrthographicCamera(); @@ -122,7 +121,7 @@ AFRAME.registerGeometry("a-test-geometry", { groupIndex: { default: 0 }, }, init(data) { - this.geometry = new threeDeprecated.Geometry(); + this.geometry = new THREE.BufferGeometry(); const temp = data.groupIndex; temp; }, diff --git a/types/alpinejs/alpinejs-tests.ts b/types/alpinejs/alpinejs-tests.ts index 79a5efd91b56a3..47ccc0e4aed0b6 100644 --- a/types/alpinejs/alpinejs-tests.ts +++ b/types/alpinejs/alpinejs-tests.ts @@ -322,9 +322,9 @@ import Alpine, { const el = document.body; - // $ExpectType: () => void + // $ExpectType () => void Alpine.setStyles(el, "visibility: hidden"); - // $ExpectType: () => void + // $ExpectType () => void Alpine.setStyles(el, { visibility: "hidden" }); } @@ -492,7 +492,7 @@ import Alpine, { alpine.magic("foo", () => {}); }; - // $ExpectType: void + // $ExpectType void Alpine.plugin(MyAlpinePlugin); } diff --git a/types/antlr4/test/atn.ts b/types/antlr4/test/atn.ts index 14b8f8cd00664b..5cde3ec7369b12 100644 --- a/types/antlr4/test/atn.ts +++ b/types/antlr4/test/atn.ts @@ -227,7 +227,7 @@ LexerActionType.TYPE; // $ExpectType LexerActionType.TYPE const lexerAtnConfigInstance = new LexerATNConfig(atnStateInstance, atnConfigInstance); lexerAtnConfigInstance.lexerActionExecutor; // $ExpectType LexerActionExecutor | null lexerAtnConfigInstance.passedThroughNonGreedyDecision; // $ExpectType boolean -lexerAtnConfigInstance.checkNonGreedyDecision(atnConfigInstance, atnStateInstance); // $ExpectType +lexerAtnConfigInstance.checkNonGreedyDecision(atnConfigInstance, atnStateInstance); // $ExpectType boolean // LexerATNSimulator const dfaInstance = new DFA(atnInstance, 0); @@ -426,7 +426,7 @@ PredictionMode.hasConflictingAltSet(bitsetCollection); // $ExpectType boolean PredictionMode.allSubsetsEqual(bitsetCollection); // $ExpectType boolean PredictionMode.getUniqueAlt(bitsetCollection); // $ExpectType number PredictionMode.getAlts(bitsetCollection); // $ExpectType BitSet -PredictionMode.getConflictingAltSubsets(atnConfigSetInstance); // $ExpectType +PredictionMode.getConflictingAltSubsets(atnConfigSetInstance); // $ExpectType BitSet[] PredictionMode.getStateToAltMap(atnConfigSetInstance); // $ExpectType AltDict PredictionMode.hasStateAssociatedWithOneAlt(atnConfigSetInstance); // $ExpectType boolean PredictionMode.getSingleViableAlt(bitsetCollection); // $ExpectType number diff --git a/types/arc4/package.json b/types/arc4/package.json index 071eb72d49196b..ade0327ca0bc74 100644 --- a/types/arc4/package.json +++ b/types/arc4/package.json @@ -14,7 +14,7 @@ "owners": [ { "name": "Maximilian Hofmann", - "githubUsername": "hofmmaxi" + "githubUsername": "maxiicodes" } ] } diff --git a/types/archiver/archiver-tests.ts b/types/archiver/archiver-tests.ts index 7159b9620d1416..a86ce2441e1d21 100644 --- a/types/archiver/archiver-tests.ts +++ b/types/archiver/archiver-tests.ts @@ -38,7 +38,7 @@ archiver.append(readStream, { name: "archiver.d.ts" }); archiver.append(readStream, { name: "buffer.txt", date: "05/05/1991" }); archiver.append(readStream, { name: "buffer.txt", date: new Date() }); archiver.append(readStream, { name: "buffer.txt", mode: 1 }); -archiver.append(readStream, { name: "buffer.txt", mode: 1, stats: new fs.Stats() }); +archiver.append(readStream, { name: "buffer.txt", mode: 1, stats: ({} as fs.Stats) }); archiver.append("Some content", { name: "filename", store: true }); archiver.append(readStream, { name: "archiver.d.ts" }).append(readStream, { name: "archiver.d.ts" }); diff --git a/types/ari-client/index.d.ts b/types/ari-client/index.d.ts index a7dccc84ccb9f3..d2fb71fe0d9949 100644 --- a/types/ari-client/index.d.ts +++ b/types/ari-client/index.d.ts @@ -4318,6 +4318,11 @@ export interface Channel extends Resource { */ id: string; + /** + * Protocol id from underlying channel driver (i.e. Call-ID for chan_pjsip; will be empty if not applicable or not implemented by driver). + */ + protocol_id: string; + /** * Name of the channel (i.e. SIP/foo-0000a7e3). */ diff --git a/types/awesome-notifications/index.d.ts b/types/awesome-notifications/index.d.ts index eef03a58d4c17d..95d4985db34ef0 100644 --- a/types/awesome-notifications/index.d.ts +++ b/types/awesome-notifications/index.d.ts @@ -4,7 +4,7 @@ declare namespace AWN { type AwnPosition = "bottom-right" | "bottom-left" | "top-left" | "top-right"; - + type AwnPopupType = "modal" | "confirm"; type AwnToastType = "global" | "tip" | "info" | "success" | "warning" | "alert"; type AwnAsyncType = "async" | "async-block"; type AwnConfirmType = "confirm" | "confirmOk" | "confirmCancel"; @@ -85,12 +85,27 @@ declare namespace AWN { } class Elem { + beforeInsert(): void; + afterInsert(): void; insert(): Elem; + replace(el: Elem): Elem; + beforeDelete(el?: Elem): Promise; + delete(el?: Elem): Promise | null; + afterDelete(): void; + getElement(el?: Elem): T; + addEvent( + name: K, + func: (this: HTMLDivElement, ev: HTMLElementEventMap[K]) => any, + ): void; + toggleClass(classname: string): void; + updateType(type: AwnToastType | AwnPopupType): void; } class Toast extends Elem { el: HTMLDivElement; + parent: HTMLDivElement; + setInnerHtml(html: string): void; /** @@ -100,6 +115,17 @@ declare namespace AWN { * @default this.el */ isDeleted(el?: Elem): boolean; + + get progressBar(): string; + get label(): string; + } + + class Popup extends Elem { + setInnerHtml(html: string): void; + keyupListener(e: KeyboardEvent): void; + + get okBtn(): HTMLButtonElement; + get cancelBtn(): HTMLButtonElement; } } @@ -115,41 +141,41 @@ declare class AWN { * Shows new tip toast * @param message Defines message of the toast. Can be any valid HTML or text string. Will be set from defaults if omitted. * @param options Instance of `AwnOptions`, which will override globals for this call - * @return A new HTMLDivElement instance + * @return A new Toast instance */ - tip(message: string, options?: AWN.AwnOptions): HTMLDivElement; + tip(message: string, options?: AWN.AwnOptions): AWN.Toast; /** * Shows new info toast * @param message Defines message of the toast. Can be any valid HTML or text string. Will be set from defaults if omitted. * @param options Instance of `AwnOptions`, which will override globals for this call - * @return A new HTMLDivElement instance + * @return A new Toast instance */ - info(message: string, options?: AWN.AwnOptions): HTMLDivElement; + info(message: string, options?: AWN.AwnOptions): AWN.Toast; /** * Shows new success toast * @param message Defines message of the toast. Can be any valid HTML or text string. Will be set from defaults if omitted. * @param options Instance of `AwnOptions`, which will override globals for this call - * @return A new HTMLDivElement instance + * @return A new Toast instance */ - success(message: string, options?: AWN.AwnOptions): HTMLDivElement; + success(message: string, options?: AWN.AwnOptions): AWN.Toast; /** * Shows new warning toast * @param message Defines message of the toast. Can be any valid HTML or text string. Will be set from defaults if omitted. * @param options Instance of `AwnOptions`, which will override globals for this call - * @return A new HTMLDivElement instance + * @return A new Toast instance */ - warning(message: string, options?: AWN.AwnOptions): HTMLDivElement; + warning(message: string, options?: AWN.AwnOptions): AWN.Toast; /** * Shows new alert toast * @param message Defines message of the toast. Can be any valid HTML or text string. Will be set from defaults if omitted. * @param options Instance of `AwnOptions`, which will override globals for this call - * @return A new HTMLDivElement instance + * @return A new Toast instance */ - alert(message: string, options?: AWN.AwnOptions): HTMLDivElement; + alert(message: string, options?: AWN.AwnOptions): AWN.Toast; /** * Closes all visible toasts. Do nothing if there’re no visible toasts. @@ -224,8 +250,9 @@ declare class AWN { * @param message Defines message of the modal window. Can be any valid HTML or text string. * @param className Defines modal window DOM element class name, it will be concatenated with default prefix ‘awn-popup-‘ * @param options Instance of `AwnOptions`, which will override globals for this call + * @return A new Popup instance */ - modal(message: string, className?: string, options?: AWN.AwnOptions): void; + modal(message: string, className?: string, options?: AWN.AwnOptions): AWN.Popup; /** * Shows new confirmation window. @@ -241,14 +268,14 @@ declare class AWN { * @param onCancel Defines Function, which will be executed on click to ‘Cancel’ button. * If false was passed, ‘Cancel’ button will be hidden. * @param options Instance of `AwnOptions`, which will override globals for this call - * @return A new HTMLDivElement instance + * @return A new Popup instance */ confirm( message: string, onOk?: () => void, onCancel?: (() => void) | false, options?: AWN.AwnOptions, - ): HTMLDivElement; + ): AWN.Popup; } export = AWN; diff --git a/types/aws-lambda/index.d.ts b/types/aws-lambda/index.d.ts index f1df85fbe753e9..8e0a35c055fbd8 100644 --- a/types/aws-lambda/index.d.ts +++ b/types/aws-lambda/index.d.ts @@ -48,5 +48,6 @@ export * from "./trigger/self-managed-kafka"; export * from "./trigger/ses"; export * from "./trigger/sns"; export * from "./trigger/sqs"; +export * from "./trigger/transfer-family-authorizer"; export as namespace AWSLambda; diff --git a/types/aws-lambda/package.json b/types/aws-lambda/package.json index 4c95c83f8f4464..61e0a9fead9f4b 100644 --- a/types/aws-lambda/package.json +++ b/types/aws-lambda/package.json @@ -171,6 +171,10 @@ { "name": "Luciano Manerich Junior", "githubUsername": "lmanerich" + }, + { + "name": "Luciano M. Taranto", + "githubUsername": "LucianoTaranto" } ] } diff --git a/types/aws-lambda/test/api-gateway-tests.ts b/types/aws-lambda/test/api-gateway-tests.ts index 9ba3e4661a7074..55223c2c7b99e1 100644 --- a/types/aws-lambda/test/api-gateway-tests.ts +++ b/types/aws-lambda/test/api-gateway-tests.ts @@ -48,6 +48,7 @@ import { ProxyCallback, ProxyHandler, Statement, + StatementEffect, } from "aws-lambda"; interface CustomAuthorizerContext extends APIGatewayAuthorizerResultContext { @@ -757,10 +758,10 @@ const legacyAuthorizerHandler: CustomAuthorizerHandler = async (event, context, return result; }; -function createPolicyDocument(): PolicyDocument { +function createPolicyDocument(effect: StatementEffect = "Deny"): PolicyDocument { let statement: Statement = { Action: str, - Effect: str, + Effect: effect, Resource: str, }; @@ -779,6 +780,18 @@ function createPolicyDocument(): PolicyDocument { // @ts-expect-error statement = { Effect: str, Action: str, Principal: 123, Resource: str }; + // Lowercase allow for effect + // @ts-expect-error + statement = { Effect: "allow", Action: str, Resource: 123 }; + + // Lowercase deny for effect + // @ts-expect-error + statement = { Effect: "deny", Action: str, Resource: 123 }; + + // Invalid effect + // @ts-expect-error + statement = { Effect: "foo", Action: str, Resource: 123 }; + // No Effect // @ts-expect-error statement = { Action: str, Principal: str }; @@ -786,7 +799,7 @@ function createPolicyDocument(): PolicyDocument { statement = { Sid: str, Action: [str, str], - Effect: str, + Effect: effect, Resource: [str, str], Condition: { condition1: { key: "value" }, @@ -804,11 +817,11 @@ function createPolicyDocument(): PolicyDocument { NotPrincipal: [str, str], }; - statement = { Action: str, Principal: str, Effect: str }; + statement = { Action: str, Principal: str, Effect: effect }; - statement = { Action: str, NotPrincipal: { Service: str }, Effect: str }; + statement = { Action: str, NotPrincipal: { Service: str }, Effect: effect }; - statement = { Effect: str, NotAction: str, NotResource: str }; + statement = { Effect: effect, NotAction: str, NotResource: str }; let policyDocument: PolicyDocument = { Version: str, Statement: [statement] }; diff --git a/types/aws-lambda/test/cdk-custom-resource-tests.ts b/types/aws-lambda/test/cdk-custom-resource-tests.ts index 03da0dd1d3797b..ac5dbdc20b795f 100644 --- a/types/aws-lambda/test/cdk-custom-resource-tests.ts +++ b/types/aws-lambda/test/cdk-custom-resource-tests.ts @@ -3,19 +3,33 @@ import { CdkCustomResourceIsCompleteHandler, CdkCustomResourceIsCompleteResponse, CdkCustomResourceResponse, + CloudFormationCustomResourceResourcePropertiesCommon, } from "aws-lambda"; -const onEventHandler: CdkCustomResourceHandler = async (event, context) => { +interface CustomResourceProperties extends CloudFormationCustomResourceResourcePropertiesCommon { + customSwitch: boolean; +} + +interface CustomOnEventData { + customOutputString: string; +} + +interface CustomIsCompleteData { + completedWithoutWarnings: boolean; +} + +const defaultOnEventHandler: CdkCustomResourceHandler = async (event, context) => { switch (event.RequestType) { case "Create": str = event.LogicalResourceId; str = event.RequestId; anyObj = event.ResourceProperties; + strOrUndefined = event.ResourceProperties.ServiceTimeout; str = event.ResourceProperties.ServiceToken; str = event.ResourceType; + str = event.ServiceToken; // Should have custom comment to not use: str = event.ResponseURL; - str = event.ServiceToken; str = event.StackId; // @ts-expect-error @@ -51,12 +65,13 @@ const onEventHandler: CdkCustomResourceHandler = async (event, context) => { return validEmptyResponse; }; -const onIsCompleteHandler: CdkCustomResourceIsCompleteHandler = async (event, context) => { +const defaultIsCompleteHandler: CdkCustomResourceIsCompleteHandler = async (event, context) => { switch (event.RequestType) { case "Create": str = event.LogicalResourceId; str = event.RequestId; anyObj = event.ResourceProperties; + strOrUndefined = event.ResourceProperties.ServiceTimeout; str = event.ResourceProperties.ServiceToken; str = event.ResourceType; // Should have custom comment to not use: @@ -92,3 +107,99 @@ const onIsCompleteHandler: CdkCustomResourceIsCompleteHandler = async (event, co return responseComplete; }; + +const customOnEventHandler: CdkCustomResourceHandler = async ( + event, + context, +) => { + switch (event.RequestType) { + case "Create": + str = event.LogicalResourceId; + str = event.RequestId; + anyObj = event.ResourceProperties; + strOrUndefined = event.ResourceProperties.ServiceTimeout; + str = event.ResourceProperties.ServiceToken; + bool = event.ResourceProperties.customSwitch; + str = event.ResourceType; + // Should have custom comment to not use: + str = event.ResponseURL; + str = event.ServiceToken; + str = event.StackId; + + // @ts-expect-error + anyObj = event.OldResourceProperties; + // @ts-expect-error + str = event.PhysicalResourceId; + break; + case "Update": + anyObj = event.OldResourceProperties; + str = event.PhysicalResourceId; + break; + case "Delete": + str = event.PhysicalResourceId; + break; + } + + const response: CdkCustomResourceResponse = { + PhysicalResourceId: str, + Data: { + customOutputString: str, + }, + otherProperties: anyObj, + }; + + const invalidResponse: CdkCustomResourceResponse = { + // @ts-expect-error + PhysicalResourceId: num, + // @ts-expect-error + Data: str, + }; + + const validEmptyResponse: CdkCustomResourceResponse = {}; + return validEmptyResponse; +}; + +const customIsCompleteHandler: CdkCustomResourceIsCompleteHandler = + async (event, context) => { + switch (event.RequestType) { + case "Create": + str = event.LogicalResourceId; + str = event.RequestId; + anyObj = event.ResourceProperties; + strOrUndefined = event.ResourceProperties.ServiceTimeout; + str = event.ResourceProperties.ServiceToken; + bool = event.ResourceProperties.customSwitch; + str = event.ResourceType; + // Should have custom comment to not use: + str = event.ResponseURL; + str = event.ServiceToken; + str = event.StackId; + break; + case "Update": + anyObj = event.OldResourceProperties; + str = event.PhysicalResourceId; + break; + case "Delete": + str = event.PhysicalResourceId; + break; + } + + const responseComplete: CdkCustomResourceIsCompleteResponse = { + IsComplete: true, + Data: { + completedWithoutWarnings: true, + }, + // @ts-expect-error + otherProperties: anyObj, + }; + + const responseWaiting: CdkCustomResourceIsCompleteResponse = { + IsComplete: false, + // @ts-expect-error + Data: { + stringKey: str, + }, + }; + + return responseComplete; + }; diff --git a/types/aws-lambda/test/cloudformation-tests.ts b/types/aws-lambda/test/cloudformation-tests.ts index 30548ad2514e3d..a8392a910d24fc 100644 --- a/types/aws-lambda/test/cloudformation-tests.ts +++ b/types/aws-lambda/test/cloudformation-tests.ts @@ -1,11 +1,24 @@ import { CloudFormationCustomResourceFailedResponse, CloudFormationCustomResourceHandler, + CloudFormationCustomResourceResourcePropertiesCommon, CloudFormationCustomResourceResponse, CloudFormationCustomResourceSuccessResponse, } from "aws-lambda"; -const handler: CloudFormationCustomResourceHandler = async (event, context, callback) => { +interface CustomResourceProperties extends CloudFormationCustomResourceResourcePropertiesCommon { + customSwitch: boolean; +} + +interface CustomOldResourceProperties extends CloudFormationCustomResourceResourcePropertiesCommon { + customNumber: number; +} + +interface CustomData { + customOutputString: string; +} + +const defaultHandler: CloudFormationCustomResourceHandler = async (event, context, callback) => { switch (event.RequestType) { case "Create": str = event.LogicalResourceId; @@ -73,3 +86,168 @@ const handler: CloudFormationCustomResourceHandler = async (event, context, call callback(); callback(new Error()); }; + +const customHandler: CloudFormationCustomResourceHandler = async ( + event, + context, + callback, +) => { + switch (event.RequestType) { + case "Create": + str = event.LogicalResourceId; + str = event.RequestId; + anyObj = event.ResourceProperties; + strOrUndefined = event.ResourceProperties.ServiceTimeout; + str = event.ResourceProperties.ServiceToken; + bool = event.ResourceProperties.customSwitch; + str = event.ResourceType; + str = event.ResponseURL; + str = event.ServiceToken; + str = event.StackId; + break; + case "Update": + anyObj = event.OldResourceProperties; + strOrUndefined = event.OldResourceProperties.ServiceTimeout; + str = event.OldResourceProperties.ServiceToken; + bool = event.OldResourceProperties.customSwitch; + break; + case "Delete": + str = event.PhysicalResourceId; + break; + } + + let response: CloudFormationCustomResourceResponse; + response = { + Data: { + customOutputString: str, + }, + LogicalResourceId: str, + PhysicalResourceId: str, + Reason: strOrUndefined, + RequestId: str, + StackId: str, + Status: "SUCCESS", + NoEcho: boolOrUndefined, + }; + + let successResponse: CloudFormationCustomResourceSuccessResponse; + let failedResponse: CloudFormationCustomResourceFailedResponse; + successResponse = { + LogicalResourceId: str, + PhysicalResourceId: str, + RequestId: str, + StackId: str, + Status: "SUCCESS", + }; + successResponse = { + Data: { + customOutputString: str, + }, + LogicalResourceId: str, + PhysicalResourceId: str, + Reason: strOrUndefined, + RequestId: str, + StackId: str, + Status: "SUCCESS", + NoEcho: boolOrUndefined, + }; + failedResponse = { + Data: { + customOutputString: str, + }, + LogicalResourceId: str, + PhysicalResourceId: str, + Reason: str, + RequestId: str, + StackId: str, + Status: "FAILED", + }; + response = successResponse; + response = failedResponse; + + callback(); + callback(new Error()); +}; + +const customChangedHandler: CloudFormationCustomResourceHandler = + async ( + event, + context, + callback, + ) => { + switch (event.RequestType) { + case "Create": + str = event.LogicalResourceId; + str = event.RequestId; + anyObj = event.ResourceProperties; + strOrUndefined = event.ResourceProperties.ServiceTimeout; + str = event.ResourceProperties.ServiceToken; + bool = event.ResourceProperties.customSwitch; + str = event.ResourceType; + str = event.ResponseURL; + str = event.ServiceToken; + str = event.StackId; + break; + case "Update": + anyObj = event.OldResourceProperties; + strOrUndefined = event.OldResourceProperties.ServiceTimeout; + str = event.OldResourceProperties.ServiceToken; + num = event.OldResourceProperties.customNumber; + break; + case "Delete": + str = event.PhysicalResourceId; + break; + } + + let response: CloudFormationCustomResourceResponse; + response = { + Data: { + customOutputString: str, + }, + LogicalResourceId: str, + PhysicalResourceId: str, + Reason: strOrUndefined, + RequestId: str, + StackId: str, + Status: "SUCCESS", + NoEcho: boolOrUndefined, + }; + + let successResponse: CloudFormationCustomResourceSuccessResponse; + let failedResponse: CloudFormationCustomResourceFailedResponse; + successResponse = { + LogicalResourceId: str, + PhysicalResourceId: str, + RequestId: str, + StackId: str, + Status: "SUCCESS", + }; + successResponse = { + Data: { + customOutputString: str, + }, + LogicalResourceId: str, + PhysicalResourceId: str, + Reason: strOrUndefined, + RequestId: str, + StackId: str, + Status: "SUCCESS", + NoEcho: boolOrUndefined, + }; + failedResponse = { + Data: { + customOutputString: str, + }, + LogicalResourceId: str, + PhysicalResourceId: str, + Reason: str, + RequestId: str, + StackId: str, + Status: "FAILED", + }; + response = successResponse; + response = failedResponse; + + callback(); + callback(new Error()); + }; diff --git a/types/aws-lambda/test/iot-authorizer-tests.ts b/types/aws-lambda/test/iot-authorizer-tests.ts index 5891a4b884262e..3c0f3773ad883e 100644 --- a/types/aws-lambda/test/iot-authorizer-tests.ts +++ b/types/aws-lambda/test/iot-authorizer-tests.ts @@ -8,6 +8,7 @@ import { IoTProtocolType, PolicyDocument, Statement, + StatementEffect, } from "aws-lambda"; // IoT Custom Authorizer @@ -93,27 +94,39 @@ const iotCustomAuthorizerHandler: IoTCustomAuthorizerHandler = async (event, con return result; }; -function createPolicyDocument(): PolicyDocument { +function createPolicyDocument(effect: StatementEffect = "Deny"): PolicyDocument { let statement: Statement = { Action: str, - Effect: str, + Effect: effect, Resource: str, }; // @ts-expect-error - statement = { Effect: str, Action: str, Principal: 123 }; + statement = { Effect: effect, Action: str, Principal: 123 }; // Bad Resource // @ts-expect-error - statement = { Effect: str, Action: str, Resource: 123 }; + statement = { Effect: effect, Action: str, Resource: 123 }; // Bad Resource with valid Principal // @ts-expect-error - statement = { Effect: str, Action: str, Principal: { Service: str }, Resource: 123 }; + statement = { Effect: effect, Action: str, Principal: { Service: str }, Resource: 123 }; // Bad principal with valid Resource // @ts-expect-error - statement = { Effect: str, Action: str, Principal: 123, Resource: str }; + statement = { Effect: effect, Action: str, Principal: 123, Resource: str }; + + // Lowercase allow for effect + // @ts-expect-error + statement = { Effect: "allow", Action: str, Resource: 123 }; + + // Lowercase deny for effect + // @ts-expect-error + statement = { Effect: "deny", Action: str, Resource: 123 }; + + // Invalid effect + // @ts-expect-error + statement = { Effect: "foo", Action: str, Resource: 123 }; // No Effect // @ts-expect-error @@ -122,7 +135,7 @@ function createPolicyDocument(): PolicyDocument { statement = { Sid: str, Action: [str, str], - Effect: str, + Effect: effect, Resource: [str, str], Condition: { condition1: { key: "value" }, @@ -140,11 +153,11 @@ function createPolicyDocument(): PolicyDocument { NotPrincipal: [str, str], }; - statement = { Action: str, Principal: str, Effect: str }; + statement = { Action: str, Principal: str, Effect: effect }; - statement = { Action: str, NotPrincipal: { Service: str }, Effect: str }; + statement = { Action: str, NotPrincipal: { Service: str }, Effect: effect }; - statement = { Effect: str, NotAction: str, NotResource: str }; + statement = { Effect: effect, NotAction: str, NotResource: str }; let policyDocument: PolicyDocument = { Version: str, Statement: [statement] }; diff --git a/types/aws-lambda/test/transfer-family-authorizer-tests.ts b/types/aws-lambda/test/transfer-family-authorizer-tests.ts index cd18a51b87d684..4b3f072009402e 100644 --- a/types/aws-lambda/test/transfer-family-authorizer-tests.ts +++ b/types/aws-lambda/test/transfer-family-authorizer-tests.ts @@ -120,3 +120,14 @@ const getPathBasedDirectoryResponse = (event: TransferFamilyAuthorizerEvent): Tr return response; }; + +/** + * Example that constructs test event for an undefined password for key based auth + */ +const testEvent: TransferFamilyAuthorizerEvent = { + username: "testinguser", + protocol: "SFTP", + serverId: "10.10.10.10.10", + sourceIp: "0.0.0.0.0", +}; +const getPathBasedDirectoryResponseResult = getPathBasedDirectoryResponse(testEvent); diff --git a/types/aws-lambda/trigger/api-gateway-authorizer.d.ts b/types/aws-lambda/trigger/api-gateway-authorizer.d.ts index db55054d733b07..60bf7811c82915 100644 --- a/types/aws-lambda/trigger/api-gateway-authorizer.d.ts +++ b/types/aws-lambda/trigger/api-gateway-authorizer.d.ts @@ -220,8 +220,10 @@ export interface Condition { */ export type Statement = BaseStatement & StatementAction & (StatementResource | StatementPrincipal); +export type StatementEffect = "Allow" | "Deny"; + export interface BaseStatement { - Effect: string; + Effect: StatementEffect; Sid?: string | undefined; Condition?: ConditionBlock | undefined; } diff --git a/types/aws-lambda/trigger/cdk-custom-resource.d.ts b/types/aws-lambda/trigger/cdk-custom-resource.d.ts index cfb46e84368041..89960720d1ead6 100644 --- a/types/aws-lambda/trigger/cdk-custom-resource.d.ts +++ b/types/aws-lambda/trigger/cdk-custom-resource.d.ts @@ -1,67 +1,158 @@ import { Callback, Handler } from "../handler"; -import { CloudFormationCustomResourceEvent } from "./cloudformation-custom-resource"; +import { + CloudFormationCustomResourceEvent, + CloudFormationCustomResourceResourcePropertiesCommon, +} from "./cloudformation-custom-resource"; -// The CDK docs only specify 'important' properties, but in reality the incoming event -// to the Lambda matches that of a traditional custom resource. -// This includes the ResponseURL property which should not be used as the framework -// itself will deal with delivering responses. -export type CdkCustomResourceEvent = CloudFormationCustomResourceEvent & { - /** - * **This URL should not be used.** The CDK Provider Framework will call this URL - * automatically based on the response produced by the Lambda handler. - */ - ResponseURL: string; -}; +/** + * Request event sent to the Lambda `OnEvent` handler for a CDK Custom Resource + * Reference: https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.custom_resources-readme.html#handling-lifecycle-events-onevent + * @template TResourceProperties User-defined input properties passed to the Custom Resource as part of any invocation + * @template TOldResourceProperties User-defined input properties passed to the Custom Resource as part of an `Update` invocation + */ +export type CdkCustomResourceEvent< + TResourceProperties = CloudFormationCustomResourceResourcePropertiesCommon, + TOldResourceProperties = TResourceProperties, +> = + & CloudFormationCustomResourceEvent + & { + /** + * The response URL identifies a presigned S3 bucket that receives responses from the custom resource provider to AWS CloudFormation. + * + * **This URL should not be used.** + * The CDK Provider Framework will call this URL automatically based on the response produced by the Lambda handler. + */ + ResponseURL: string; + }; + +/** + * Lambda handler function for the `OnEvent` CDK Custom Resource + * Reference: https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.custom_resources-readme.html#handling-lifecycle-events-onevent + * + * NOTE: this is not to be confused with traditional CloudFormation custom resources. + * @template TResourceProperties User-defined input properties passed to the Custom Resource as part of any invocation + * @template TData User-defined output properties that are retuned from any invocation + * @template TOldResourceProperties User-defined input properties passed to the Custom Resource as part of an `Update` invocation + */ +export type CdkCustomResourceHandler< + TResourceProperties = CloudFormationCustomResourceResourcePropertiesCommon, + TData extends Record = Record, + TOldResourceProperties = TResourceProperties, +> = Handler, CdkCustomResourceResponse>; /** - * A custom resource based on the AWS CDK custom resource Provider Framework. - * This is not to be confused with traditional CloudFormation custom resources. - * @link https://docs.aws.amazon.com/cdk/api/latest/docs/custom-resources-readme.html#handling-lifecycle-events-onevent + * Lambda `OnEvent` callback function for a CDK Custom Resource + * @template TData User-defined output properties that are retuned from any invocation */ -export type CdkCustomResourceHandler = Handler; -export type CdkCustomResourceCallback = Callback; +export type CdkCustomResourceCallback> = Callback>; -export interface CdkCustomResourceResponse { +/** + * Response from the `OnEvent` Lambda handler for a CDK Custom Resource + * Reference: https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.custom_resources-readme.html#handling-lifecycle-events-onevent + * @template TData User-defined output properties that are retuned from any invocation + */ +export interface CdkCustomResourceResponse = Record> { + /** + * This value should be an identifier unique to the custom resource vendor, and can be up to 1 KB in size. The value must be a non-empty string and must be identical for all responses for the same resource. + * The value returned for a `PhysicalResourceId` can change custom resource update operations. If the value returned is the same, it is considered a normal update. If the value returned is different, AWS CloudFormation recognizes the update as a replacement and sends a delete request to the old resource. + * + * If omitted for `Create` events, the event's `RequestId` will be used. + * For `Update`, the current physical ID will be used. If a different value is returned, CloudFormation will follow with a subsequent `Delete` for the previous ID (resource replacement). + * For `Delete`, it will always return the current physical resource ID, and if the user returns a different one, an error will occur. + */ PhysicalResourceId?: string; - Data?: - | { - [Key: string]: any; - } - | undefined; - // Any extra properties will be provided to the isComplete handler for asynchronous resources. + + /** + * The custom resource provider-defined name-value pairs to send with the response. You can access the values provided here by name in the template with `Fn::GetAtt`. + * NOTE: If the name-value pairs contain sensitive information, you should use the `NoEcho` field to mask the output of the custom resource. Otherwise, the values are visible through APIs that surface property values (such as `DescribeStackEvents`). + */ + Data?: TData; + + /** + * Indicates whether to mask the output of the custom resource when retrieved by using the `Fn::GetAtt` function. If set to `true`, all returned values are masked with asterisks (*****), __except for those stored in the `Metadata` section of the template__. AWS CloudFormation does not transform, modify, or redact any information you include in the `Metadata` section. The default value is `false`. + */ + NoEcho?: boolean; + + /** + * Any other field included in the response will be passed through to `isComplete`. This can sometimes be useful to pass state between the handlers. + */ [Key: string]: any; } -// IsComplete events will contain all normal request fields, as well as those returned from -// the initial onEvent handler. -export type CdkCustomResourceIsCompleteEvent = CdkCustomResourceEvent & CdkCustomResourceResponse; +/** + * Request event sent to the Lambda `IsComplete` handler for an asynchronous CDK Custom Resource + * The input event to isComplete includes all request fields, combined with all fields returned from onEvent. If PhysicalResourceId has not been explicitly returned from onEvent, it's value will be calculated based on heuristics. + * Reference: https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.custom_resources-readme.html#asynchronous-providers-iscomplete + * @template TResourceProperties User-defined input properties passed to the Custom Resource as part of any invocation + * @template TData User-defined output properties that are retuned from any invocation + * @template TOldResourceProperties User-defined input properties passed to the Custom Resource as part of an `Update` invocation + */ +export type CdkCustomResourceIsCompleteEvent< + TResourceProperties = CloudFormationCustomResourceResourcePropertiesCommon, + TData extends Record = Record, + TOldResourceProperties = TResourceProperties, +> = CdkCustomResourceEvent & CdkCustomResourceResponse; -export type CdkCustomResourceIsCompleteResponse = - | CdkCustomResourceIsCompleteResponseSuccess +/** + * Common response properties from the `IsComplete` Lambda handler for a CDK Custom Resource + * Reference: https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.custom_resources-readme.html#asynchronous-providers-iscomplete + * @template TData User-defined output properties that are retuned from any invocation + */ +export type CdkCustomResourceIsCompleteResponse = Record> = + | CdkCustomResourceIsCompleteResponseSuccess | CdkCustomResourceIsCompleteResponseWaiting; -export interface CdkCustomResourceIsCompleteResponseSuccess { +/** + * Response properties that are specifically for a successful `IsComplete` response for a CDK Custom Resource + * Reference: https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.custom_resources-readme.html#asynchronous-providers-iscomplete + * @template TData User-defined output properties that are retuned from any invocation + */ +export interface CdkCustomResourceIsCompleteResponseSuccess = Record> { + /** + * Indicates the operation has finished. + */ IsComplete: true; + /** - * This will be merged with the `Data` property of the onEvent handler's response. + * The custom resource provider-defined name-value pairs to send with the response. You can access the values provided here by name in the template with `Fn::GetAtt`. + * These attributes will be **merged** with the ones returned from `onEvent`. */ - Data?: - | { - [Key: string]: any; - } - | undefined; + Data?: TData; } +/** + * Response properties that are specifically for a still waiting `IsComplete` response for a CDK Custom Resource + * Reference: https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.custom_resources-readme.html#asynchronous-providers-iscomplete + */ export interface CdkCustomResourceIsCompleteResponseWaiting { + /** + * Indicates the operation has not finished. + */ IsComplete: false; } /** - * An asynchronous custom resource handler. - * @link https://docs.aws.amazon.com/cdk/api/latest/docs/custom-resources-readme.html#asynchronous-providers-iscomplete + * Lambda `IsComplete` handler function for asynchronous CDK Custom Resources + * Reference: https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.custom_resources-readme.html#asynchronous-providers-iscomplete + * @template TResourceProperties User-defined input properties passed to the Custom Resource as part of any invocation + * @template TOnEventData User-defined output properties that are retuned from any invocation of the `OnEvent` function + * @template TOldResourceProperties User-defined input properties passed to the Custom Resource as part of an `Update` invocation + * @template TIsCompleteData User-defined output properties that are retuned from any invocation of the `IsComplete` function + */ +export type CdkCustomResourceIsCompleteHandler< + TResourceProperties = CloudFormationCustomResourceResourcePropertiesCommon, + TOnEventData extends Record = Record, + TOldResourceProperties = TResourceProperties, + TIsCompleteData extends Record = TOnEventData, +> = Handler< + CdkCustomResourceIsCompleteEvent, + CdkCustomResourceIsCompleteResponse +>; + +/** + * Lambda `IsComplete` callback function for a CDK Custom Resource + * @template TData User-defined output properties that are retuned from any invocation */ -export type CdkCustomResourceIsCompleteHandler = Handler< - CdkCustomResourceIsCompleteEvent, - CdkCustomResourceIsCompleteResponse +export type CdkCustomResourceIsCompleteCallback = Record> = Callback< + CdkCustomResourceIsCompleteResponse >; -export type CdkCustomResourceIsCompleteCallback = Callback; diff --git a/types/aws-lambda/trigger/cloudformation-custom-resource.d.ts b/types/aws-lambda/trigger/cloudformation-custom-resource.d.ts index 813e98cfdab0dd..9a88d5f80a532f 100644 --- a/types/aws-lambda/trigger/cloudformation-custom-resource.d.ts +++ b/types/aws-lambda/trigger/cloudformation-custom-resource.d.ts @@ -1,70 +1,236 @@ import { Handler } from "../handler"; -// Note, responses are *not* lambda results, they are sent to the event ResponseURL. -export type CloudFormationCustomResourceHandler = Handler; +/** + * Named service-defined resource properties + * Reference: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/crpg-ref-requests.html#crpg-ref-request-properties + */ +export interface CloudFormationCustomResourceResourcePropertiesCommon extends Record { + /** + * The service token, such as an Amazon SNS topic ARN or Lambda function ARN. The service token must be from the same Region as the stack. + */ + ServiceToken: string; + + /** + * The maximum time, in seconds, that can elapse before a custom resource operation times out. + * The value must be an integer from 1 to 3600. The default value is 3600 seconds (1 hour). + */ + ServiceTimeout?: string; +} -export type CloudFormationCustomResourceEvent = - | CloudFormationCustomResourceCreateEvent - | CloudFormationCustomResourceUpdateEvent - | CloudFormationCustomResourceDeleteEvent; +/** + * Lambda handler function for a Lambda-backed CloudFormation Custom Resource + * + * NOTE: responses are *not* returned from the Lambda handler but rather they are sent to the event ResponseURL. + * @template TResourceProperties User-defined input properties passed to the Custom Resource as part of any invocation + * @template TOldResourceProperties User-defined input properties passed to the Custom Resource as part of an `Update` invocation + */ +export type CloudFormationCustomResourceHandler< + TResourceProperties = CloudFormationCustomResourceResourcePropertiesCommon, + TOldResourceProperties = TResourceProperties, +> = Handler, void>; + +/** + * Request event sent to the Lambda handler for a Lambda-backed CloudFormation Custom Resource + * Reference: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/crpg-ref-requests.html#crpg-ref-request-fields + * @template TResourceProperties User-defined input properties passed to the Custom Resource as part of any invocation + * @template TOldResourceProperties User-defined input properties passed to the Custom Resource as part of an `Update` invocation + */ +export type CloudFormationCustomResourceEvent< + TResourceProperties = CloudFormationCustomResourceResourcePropertiesCommon, + TOldResourceProperties = TResourceProperties, +> = + | CloudFormationCustomResourceCreateEvent + | CloudFormationCustomResourceUpdateEvent + | CloudFormationCustomResourceDeleteEvent; -export type CloudFormationCustomResourceResponse = - | CloudFormationCustomResourceSuccessResponse - | CloudFormationCustomResourceFailedResponse; +/** + * Response from a Lambda handler for a Lambda-backed CloudFormation Custom Resource + * Reference: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/crpg-ref-responses.html + * + * NOTE: responses are *not* returned from the Lambda handler but rather they are sent to the event ResponseURL. + * @template TData User-defined output properties that are retuned from any invocation + */ +export type CloudFormationCustomResourceResponse = Record> = + | CloudFormationCustomResourceSuccessResponse + | CloudFormationCustomResourceFailedResponse; /** - * CloudFormation Custom Resource event and response - * http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/crpg-ref.html + * Request properties that are common to all invocations of a Lambda-backed CloudFormation Custom Resource + * Reference: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/crpg-ref-requests.html#crpg-ref-request-fields + * @template TResourceProperties User-defined input properties passed to the Custom Resource as part of any invocation */ -export interface CloudFormationCustomResourceEventCommon { +export interface CloudFormationCustomResourceEventCommon< + TResourceProperties = CloudFormationCustomResourceResourcePropertiesCommon, +> { + /** + * The service token, such as an Amazon SNS topic ARN or Lambda function ARN. The service token must be from the same Region as the stack. + */ ServiceToken: string; + + /** + * The response URL identifies a presigned S3 bucket that receives responses from the custom resource provider to AWS CloudFormation. + */ ResponseURL: string; + + /** + * The Amazon Resource Name (ARN) that identifies the stack that contains the custom resource. + * Combining the `StackId` with the `RequestId` forms a value that you can use to uniquely identify a request on a particular custom resource. + */ StackId: string; + + /** + * A unique ID for the request. + * Combining the `StackId` with the `RequestId` forms a value that you can use to uniquely identify a request on a particular custom resource. + */ RequestId: string; + + /** + * The template developer-chosen name (logical ID) of the custom resource in the AWS CloudFormation template. This is provided to facilitate communication between the custom resource provider and the template developer. + */ LogicalResourceId: string; + + /** + * The template developer-chosen resource type of the custom resource in the CloudFormation template. Custom resource type names can be up to 60 characters long and can include alphanumeric and the following characters: `_@-`. + */ ResourceType: string; - ResourceProperties: { - ServiceToken: string; - [Key: string]: any; - }; + + /** + * This field contains the contents of the `Properties` object sent by the template developer. Its contents are defined by the custom resource provider. + */ + ResourceProperties: TResourceProperties & CloudFormationCustomResourceResourcePropertiesCommon; } -export interface CloudFormationCustomResourceCreateEvent extends CloudFormationCustomResourceEventCommon { +/** + * Request properties specifically for the `Create` invocation of a Lambda-backed CloudFormation Custom Resource + * @template TResourceProperties User-defined input properties passed to the Custom Resource as part of any invocation + */ +export interface CloudFormationCustomResourceCreateEvent< + TResourceProperties = CloudFormationCustomResourceResourcePropertiesCommon, +> extends CloudFormationCustomResourceEventCommon { + /** + * The request type is set by the CloudFormation stack operation (create-stack, update-stack, or delete-stack) that was initiated by the template developer for the stack that contains the custom resource. + */ RequestType: "Create"; } -export interface CloudFormationCustomResourceUpdateEvent extends CloudFormationCustomResourceEventCommon { +/** + * Request properties specifically for the `Update` invocation of a Lambda-backed CloudFormation Custom Resource + * @template TResourceProperties User-defined input properties passed to the Custom Resource as part of any invocation + * @template TOldResourceProperties User-defined input properties passed to the Custom Resource as part of an `Update` invocation + */ +export interface CloudFormationCustomResourceUpdateEvent< + TResourceProperties = CloudFormationCustomResourceResourcePropertiesCommon, + TOldResourceProperties = TResourceProperties, +> extends CloudFormationCustomResourceEventCommon { + /** + * The request type is set by the CloudFormation stack operation (create-stack, update-stack, or delete-stack) that was initiated by the template developer for the stack that contains the custom resource. + */ RequestType: "Update"; + + /** + * A required custom resource provider-defined physical ID that is unique for that provider. + * The value returned for a `PhysicalResourceId` can change custom resource update operations. If the value returned is the same, it is considered a normal update. If the value returned is different, AWS CloudFormation recognizes the update as a replacement and sends a delete request to the old resource. + */ PhysicalResourceId: string; - OldResourceProperties: { - [Key: string]: any; - }; + + /** + * Used only for `Update` requests. Contains the resource properties that were declared previous to the update request. + */ + OldResourceProperties: TOldResourceProperties; } -export interface CloudFormationCustomResourceDeleteEvent extends CloudFormationCustomResourceEventCommon { +/** + * Request properties specifically for the `Delete` invocation of a Lambda-backed CloudFormation Custom Resource + * @template TResourceProperties User-defined input properties passed to the Custom Resource as part of any invocation + */ +export interface CloudFormationCustomResourceDeleteEvent< + TResourceProperties = CloudFormationCustomResourceResourcePropertiesCommon, +> extends CloudFormationCustomResourceEventCommon { + /** + * The request type is set by the CloudFormation stack operation (create-stack, update-stack, or delete-stack) that was initiated by the template developer for the stack that contains the custom resource. + */ RequestType: "Delete"; + + /** + * A required custom resource provider-defined physical ID that is unique for that provider. + * The value returned for a `PhysicalResourceId` can change custom resource update operations. If the value returned is the same, it is considered a normal update. If the value returned is different, AWS CloudFormation recognizes the update as a replacement and sends a delete request to the old resource. + */ PhysicalResourceId: string; } -export interface CloudFormationCustomResourceResponseCommon { +/** + * Response properties that are common to all invocations of a Lambda-backed CloudFormation Custom Resource + * Reference: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/crpg-ref-responses.html + * @template TData User-defined output properties that are retuned from any invocation + */ +export interface CloudFormationCustomResourceResponseCommon = Record> { + /** + * This value should be an identifier unique to the custom resource vendor, and can be up to 1 KB in size. The value must be a non-empty string and must be identical for all responses for the same resource. + * The value returned for a `PhysicalResourceId` can change custom resource update operations. If the value returned is the same, it is considered a normal update. If the value returned is different, AWS CloudFormation recognizes the update as a replacement and sends a delete request to the old resource. + */ PhysicalResourceId: string; + + /** + * The Amazon Resource Name (ARN) that identifies the stack that contains the custom resource. This response value should be copied verbatim from the request. + */ StackId: string; + + /** + * A unique ID for the request. This response value should be copied verbatim from the request. + */ RequestId: string; + + /** + * The template developer-chosen name (logical ID) of the custom resource in the AWS CloudFormation template. This response value should be copied verbatim from the request. + */ LogicalResourceId: string; - Data?: - | { - [Key: string]: any; - } - | undefined; + + /** + * The custom resource provider-defined name-value pairs to send with the response. You can access the values provided here by name in the template with `Fn::GetAtt`. + * NOTE: If the name-value pairs contain sensitive information, you should use the `NoEcho` field to mask the output of the custom resource. Otherwise, the values are visible through APIs that surface property values (such as `DescribeStackEvents`). + */ + Data?: TData | undefined; + + /** + * Indicates whether to mask the output of the custom resource when retrieved by using the `Fn::GetAtt` function. If set to `true`, all returned values are masked with asterisks (*****), __except for those stored in the `Metadata` section of the template__. AWS CloudFormation does not transform, modify, or redact any information you include in the `Metadata` section. The default value is `false`. + */ NoEcho?: boolean | undefined; } -export interface CloudFormationCustomResourceSuccessResponse extends CloudFormationCustomResourceResponseCommon { +/** + * Response properties that are specifically for a response indicating succesful invocation of a Lambda-backed CloudFormation Custom Resource + * Reference: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/crpg-ref-responses.html + * @template TData User-defined output properties that are retuned from any invocation + */ +export interface CloudFormationCustomResourceSuccessResponse = Record> + extends CloudFormationCustomResourceResponseCommon +{ + /** + * The status value sent by the custom resource provider in response to an AWS CloudFormation-generated request. + */ Status: "SUCCESS"; + + /** + * Describes the reason for a failure response. + */ Reason?: string | undefined; } -export interface CloudFormationCustomResourceFailedResponse extends CloudFormationCustomResourceResponseCommon { +/** + * Response properties that are specifically for a response indicating failed invocation of a Lambda-backed CloudFormation Custom Resource + * Reference: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/crpg-ref-responses.html + * @template TData User-defined output properties that are retuned from any invocation + */ +export interface CloudFormationCustomResourceFailedResponse = Record> + extends CloudFormationCustomResourceResponseCommon +{ + /** + * The status value sent by the custom resource provider in response to an AWS CloudFormation-generated request. + */ Status: "FAILED"; + + /** + * Describes the reason for a failure response. + */ Reason: string; } diff --git a/types/aws-lambda/trigger/transfer-family-authorizer.d.ts b/types/aws-lambda/trigger/transfer-family-authorizer.d.ts index cf0ff862766ffe..280b31f97ceb51 100644 --- a/types/aws-lambda/trigger/transfer-family-authorizer.d.ts +++ b/types/aws-lambda/trigger/transfer-family-authorizer.d.ts @@ -15,10 +15,11 @@ export type TransferFamilyAuthorizerHandler = Handler {}); db.function("noop", { deterministic: true, @@ -54,6 +61,9 @@ db.defaultSafeIntegers(true); const vtable: Sqlite.Statement = db.prepare("SELECT * FROM vtable"); vtable.all(); +const vtable_parameters: Sqlite.Statement = db.prepare("SELECT * FROM vtable_parameters('testName')"); +vtable_parameters.all(); + interface TypedParameter { search: string; } diff --git a/types/better-sqlite3/index.d.ts b/types/better-sqlite3/index.d.ts index a33abd7288beec..7da103591569aa 100644 --- a/types/better-sqlite3/index.d.ts +++ b/types/better-sqlite3/index.d.ts @@ -42,7 +42,7 @@ declare namespace BetterSqlite3 { } interface VirtualTableOptions { - rows: () => Generator; + rows: (...params: unknown[]) => Generator; columns: string[]; parameters?: string[] | undefined; safeIntegers?: boolean | undefined; diff --git a/types/braintree-web/data-collector.d.ts b/types/braintree-web/data-collector.d.ts index 2a4c8d2638c955..50ab17e6363f1c 100644 --- a/types/braintree-web/data-collector.d.ts +++ b/types/braintree-web/data-collector.d.ts @@ -17,8 +17,14 @@ export function create(options: { client: Client; kount?: boolean | undefined; paypal?: boolean | undefined; + riskCorrelationId?: string | undefined; }): Promise; export function create( - options: { client: Client; kount?: boolean | undefined; paypal?: boolean | undefined }, + options: { + client: Client; + kount?: boolean | undefined; + paypal?: boolean | undefined; + riskCorrelationId?: string | undefined; + }, callback: callback, ): void; diff --git a/types/bresenham/bresenham-tests.ts b/types/bresenham/bresenham-tests.ts index 3d13fd26de777e..5d9040153fc3d8 100644 --- a/types/bresenham/bresenham-tests.ts +++ b/types/bresenham/bresenham-tests.ts @@ -8,5 +8,5 @@ bresenham(0, 0, 10, 12); bresenham(0, 0, 10, 12, (x: number, y: number) => { }); -// $ExpectType Generator +// $ExpectType Generator || Generator generatorFn(0, 0, 10, 12); diff --git a/types/bun/package.json b/types/bun/package.json index 66c0db33666b66..2e6828cf9c4096 100644 --- a/types/bun/package.json +++ b/types/bun/package.json @@ -6,7 +6,7 @@ "https://bun.sh" ], "dependencies": { - "bun-types": "1.1.9" + "bun-types": "1.1.17" }, "devDependencies": { "@types/bun": "workspace:." diff --git a/types/call-bind/test/callBound.test.ts b/types/call-bind/test/callBound.test.ts index 57d4282f771016..851fde2381697c 100644 --- a/types/call-bind/test/callBound.test.ts +++ b/types/call-bind/test/callBound.test.ts @@ -1,8 +1,8 @@ import callBound = require("call-bind/callBound"); -callBound("%ArrayProto_keys%"); // $ExpectType (thisArg: unknown) => IterableIterator -callBound("%ArrayProto_values%"); // $ExpectType (thisArg: unknown) => IterableIterator -callBound("%ArrayProto_entries%"); // $ExpectType (thisArg: unknown) => IterableIterator<[number, any]> +callBound("%ArrayProto_keys%"); // $ExpectType (thisArg: unknown) => IterableIterator || (thisArg: unknown) => BuiltinIterator +callBound("%ArrayProto_values%"); // $ExpectType (thisArg: unknown) => IterableIterator || (thisArg: unknown) => BuiltinIterator +callBound("%ArrayProto_entries%"); // $ExpectType (thisArg: unknown) => IterableIterator<[number, any]> || (thisArg: unknown) => BuiltinIterator<[number, any], any, any> callBound("%ArrayProto_forEach%"); // $ExpectType (thisArg: unknown, callbackfn: (value: any, index: number, array: any[]) => void, thisArg?: any) => void callBound("%ObjProto_toString%"); // $ExpectType (thisArg: unknown) => string diff --git a/types/camelize/camelize-tests.ts b/types/camelize/camelize-tests.ts index e74d481309110f..bc3da92942fd93 100644 --- a/types/camelize/camelize-tests.ts +++ b/types/camelize/camelize-tests.ts @@ -30,5 +30,20 @@ camelize("foo-bar" as const); // $ExpectType Date camelize(new Date()); +// $ExpectType Date +camelize({ "my-date": new Date() }).myDate; + // $ExpectType RegExp camelize(/foo/); + +// $ExpectType RegExp +camelize({ "my-regexp": /foo/ }).myRegexp; + +// $ExpectType string[] +camelize(["foo-bar", "bar-baz"]); + +// $ExpectType string[] +camelize({ "my-array": ["foo-bar", "bar-baz"] }).myArray; + +// $ExpectType { fooBar: number; }[] +camelize({ "my-array": [{ "foo-bar": 1 }] }).myArray; diff --git a/types/camelize/index.d.ts b/types/camelize/index.d.ts index 81690f28ef780a..b045b1e2d41896 100644 --- a/types/camelize/index.d.ts +++ b/types/camelize/index.d.ts @@ -7,14 +7,14 @@ type CamelCase = S extends `${infer FirstWord}${CamelSeparator ? `${Lowercase}${Uppercase}${CamelCase}` : Lowercase; -type Camelize = { - [K in keyof T as CamelCase]: T[K] extends {} ? Camelize : T[K]; -}; - -declare function camelize(obj: T): T extends string ? CamelCase +type Camelize = T extends Date ? T : T extends RegExp ? T - : T extends Date ? T - : T extends {} ? Camelize + : T extends Array ? Array> + : T extends object ? { + [K in keyof T as CamelCase]: Camelize; + } : T; +declare function camelize(obj: T): T extends string ? CamelCase : Camelize; + export = camelize; diff --git a/types/cannon/cannon-tests.ts b/types/cannon/cannon-tests.ts index 21ebdb8e8cef18..2933edc7af42ea 100644 --- a/types/cannon/cannon-tests.ts +++ b/types/cannon/cannon-tests.ts @@ -3,3 +3,9 @@ import cannon = require("cannon"); var aabb = new cannon.AABB(); aabb.setFromPoints([new cannon.Vec3(1, 2, 3)]); + +var vehicle = new CANNON.RaycastVehicle(); + +vehicle.addWheel({ + isFrontWheel: true, +}); diff --git a/types/cannon/index.d.ts b/types/cannon/index.d.ts index 24dd77181b1fb9..2a26f4e50bb26f 100644 --- a/types/cannon/index.d.ts +++ b/types/cannon/index.d.ts @@ -511,7 +511,7 @@ declare namespace CANNON { deltaRotation?: number | undefined; rollInfluence?: number | undefined; maxSuspensionForce?: number | undefined; - isFronmtWheel?: boolean | undefined; + isFrontWheel?: boolean | undefined; clippedInvContactDotSuspension?: number | undefined; suspensionRelativeVelocity?: number | undefined; suspensionForce?: number | undefined; diff --git a/types/carbon-components-react/lib/components/Toggle/Toggle.d.ts b/types/carbon-components-react/lib/components/Toggle/Toggle.d.ts index 7629517b31bdc6..28c29e30625509 100644 --- a/types/carbon-components-react/lib/components/Toggle/Toggle.d.ts +++ b/types/carbon-components-react/lib/components/Toggle/Toggle.d.ts @@ -1,7 +1,7 @@ import * as React from "react"; import { ReactInputAttr } from "../../../typings/shared"; -type ExcludedAttributes = "aria-labelledby" | "id" | "onChange" | "onKeyUp" | "size" | "type"; +type ExcludedAttributes = "aria-labelledby" | "id" | "onChange" | "onKeyUp" | "onToggle" | "size" | "type"; export interface ToggleProps extends Omit { defaultToggled?: boolean | undefined; diff --git a/types/carbon-components-react/lib/components/ToggleSmall/ToggleSmall.d.ts b/types/carbon-components-react/lib/components/ToggleSmall/ToggleSmall.d.ts index b2f720bf1d31b6..82439e3b528560 100644 --- a/types/carbon-components-react/lib/components/ToggleSmall/ToggleSmall.d.ts +++ b/types/carbon-components-react/lib/components/ToggleSmall/ToggleSmall.d.ts @@ -1,7 +1,7 @@ import * as React from "react"; import { ReactInputAttr } from "../../../typings/shared"; -type ExcludedAttributes = "aria-label" | "id" | "onChange" | "onKeyUp" | "ref" | "type"; +type ExcludedAttributes = "aria-label" | "id" | "onChange" | "onKeyUp" | "onToggle" | "ref" | "type"; export interface ToggleSmallProps extends Omit { "aria-label": string; diff --git a/types/carbon-components-react/lib/components/TreeView/TreeNode.d.ts b/types/carbon-components-react/lib/components/TreeView/TreeNode.d.ts index 702f8a05df5086..9bbb10afa70479 100644 --- a/types/carbon-components-react/lib/components/TreeView/TreeNode.d.ts +++ b/types/carbon-components-react/lib/components/TreeView/TreeNode.d.ts @@ -1,7 +1,9 @@ import * as React from "react"; import { ReactLIAttr } from "../../../typings/shared"; -export interface TreeNodeStandaloneProps extends Omit { +export interface TreeNodeStandaloneProps + extends Omit +{ active?: number | string | undefined; depth?: number | undefined; isExpanded?: boolean | undefined; diff --git a/types/carbon-components-react/lib/components/UIShell/SideNav.d.ts b/types/carbon-components-react/lib/components/UIShell/SideNav.d.ts index 4e0f3fdf13a410..6ae45fd0d083a7 100644 --- a/types/carbon-components-react/lib/components/UIShell/SideNav.d.ts +++ b/types/carbon-components-react/lib/components/UIShell/SideNav.d.ts @@ -3,7 +3,7 @@ import { ForwardRefReturn, InternationalProps, ReactAttr } from "../../../typing export type SideNavTranslationKey = "carbon.sidenav.state.closed" | "carbon.sidenav.state.open"; -export interface SideNavProps extends ReactAttr, InternationalProps { +export interface SideNavProps extends Omit, InternationalProps { addFocusListeners?: boolean | undefined; addMouseListeners?: boolean | undefined; defaultExpanded?: boolean | undefined; diff --git a/types/carbon-components-react/package.json b/types/carbon-components-react/package.json index ebef8a8c9b56fd..909ae3241b3d13 100644 --- a/types/carbon-components-react/package.json +++ b/types/carbon-components-react/package.json @@ -13,14 +13,6 @@ "@types/carbon-components-react": "workspace:." }, "owners": [ - { - "name": "Kyle Albert", - "githubUsername": "kalbert312" - }, - { - "name": "Sebastien Gregoire", - "githubUsername": "sgregoire" - }, { "name": "Mathias Schilling", "githubUsername": "matchilling" diff --git a/types/carbon__icon-helpers/carbon__icon-helpers-tests.ts b/types/carbon__icon-helpers/carbon__icon-helpers-tests.ts deleted file mode 100644 index 666eeaa905a05e..00000000000000 --- a/types/carbon__icon-helpers/carbon__icon-helpers-tests.ts +++ /dev/null @@ -1,36 +0,0 @@ -import { defaultAttributes, formatAttributes, getAttributes, toString, toSVG } from "@carbon/icon-helpers"; - -defaultAttributes.focusable; // $Expect string -defaultAttributes.preserveAspectRatio; // $Expect string -getAttributes({ - width: 16, - height: 16, -}); /* $ExpectType { - width: number; - height: number; - viewBox: string; - title?: string; - role?: string; - focusable: string; - preserveAspectRatio: string; -} */ - -formatAttributes({ width: 16, height: 16 }); // $ExpectType string -toString({ - elem: "svg", - attrs: { width: 16, height: 16 }, - content: [ - { elem: "path", attrs: { d: "" } }, - { elem: "circle", attrs: { cx: "", cy: "", r: "" } }, - { elem: "rect", attrs: { width: "", height: "", x: "", y: "", rx: "" } }, - ], -}); // $Expect string -toSVG({ - elem: "svg", - attrs: { width: 16, height: 16 }, - content: [ - { elem: "path", attrs: { d: "" } }, - { elem: "circle", attrs: { cx: "", cy: "", r: "" } }, - { elem: "rect", attrs: { width: "", height: "", x: "", y: "", rx: "" } }, - ], -}); // $Expect SVGSVGElement diff --git a/types/carbon__icon-helpers/index.d.ts b/types/carbon__icon-helpers/index.d.ts deleted file mode 100644 index e5f761a9083732..00000000000000 --- a/types/carbon__icon-helpers/index.d.ts +++ /dev/null @@ -1,30 +0,0 @@ -export const defaultAttributes: { - focusable: string; - preserveAspectRatio: string; -}; - -export function getAttributes({ - width, - height, - viewBox, - ...attributes -}?: { - width?: number | undefined; - height?: number | undefined; - viewBox?: string | undefined; - tabindex?: number | string | undefined; - title?: string | undefined; - role?: string | undefined; -}): { - width: number; - height: number; - viewBox: string; - title?: string | undefined; - role?: string | undefined; - focusable: string; - preserveAspectRatio: string; -}; - -export function toString(descriptor: any): string; -export function formatAttributes(attrs: any): string; -export function toSVG(descriptor: any): SVGSVGElement; diff --git a/types/carbon__icon-helpers/package.json b/types/carbon__icon-helpers/package.json deleted file mode 100644 index 77ae630bc58905..00000000000000 --- a/types/carbon__icon-helpers/package.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "private": true, - "name": "@types/carbon__icon-helpers", - "version": "10.7.9999", - "projects": [ - "https://github.com/carbon-design-system/carbon/blob/master/packages/icon-helpers" - ], - "devDependencies": { - "@types/carbon__icon-helpers": "workspace:." - }, - "owners": [ - { - "name": "Eric Liu", - "githubUsername": "metonym" - } - ] -} diff --git a/types/chai-xml/package.json b/types/chai-xml/package.json index 0bdf676808a6f6..e7e0bdaf5016cb 100644 --- a/types/chai-xml/package.json +++ b/types/chai-xml/package.json @@ -11,10 +11,5 @@ "devDependencies": { "@types/chai-xml": "workspace:." }, - "owners": [ - { - "name": "Jeff Goddard", - "githubUsername": "jedigo" - } - ] + "owners": [] } diff --git a/types/chai/index.d.ts b/types/chai/index.d.ts index f1cdab73a0635b..b346ab6de75c5b 100644 --- a/types/chai/index.d.ts +++ b/types/chai/index.d.ts @@ -872,7 +872,7 @@ declare namespace Chai { include(haystack: T, needle: Partial, message?: string): void; /** - * Asserts that haystack does not includes needle. + * Asserts that haystack does not include needle. * * @param haystack Container string. * @param needle Potential substring of haystack. @@ -881,7 +881,7 @@ declare namespace Chai { notInclude(haystack: string, needle: string, message?: string): void; /** - * Asserts that haystack does not includes needle. + * Asserts that haystack does not include needle. * * T Type of values in haystack. * @param haystack Container array, set or map. @@ -895,7 +895,7 @@ declare namespace Chai { ): void; /** - * Asserts that haystack does not includes needle. + * Asserts that haystack does not include needle. * * T Type of values in haystack. * @param haystack WeakSet container. @@ -905,7 +905,7 @@ declare namespace Chai { notInclude(haystack: WeakSet, needle: T, message?: string): void; /** - * Asserts that haystack does not includes needle. + * Asserts that haystack does not include needle. * * T Type of haystack. * @param haystack Object. @@ -940,7 +940,7 @@ declare namespace Chai { ): void; /** - * Asserts that haystack does not includes needle. + * Asserts that haystack does not include needle. * * T Type of haystack. * @param haystack Object. @@ -950,7 +950,7 @@ declare namespace Chai { deepInclude(haystack: T, needle: T extends WeakSet ? never : Partial, message?: string): void; /** - * Asserts that haystack does not includes needle. Deep equality is used. + * Asserts that haystack does not include needle. Deep equality is used. * * @param haystack Container string. * @param needle Potential substring of haystack. @@ -961,7 +961,7 @@ declare namespace Chai { notDeepInclude(haystack: string, needle: string, message?: string): void; /** - * Asserts that haystack does not includes needle. Deep equality is used. + * Asserts that haystack does not include needle. Deep equality is used. * * T Type of values in haystack. * @param haystack Container array, set or map. @@ -975,7 +975,7 @@ declare namespace Chai { ): void; /** - * Asserts that haystack does not includes needle. Deep equality is used. + * Asserts that haystack does not include needle. Deep equality is used. * * T Type of haystack. * @param haystack Object. @@ -1109,7 +1109,7 @@ declare namespace Chai { property(object: T, property: string, /* keyof T */ message?: string): void; /** - * Asserts that object has a property named by property. + * Asserts that object does not have a property named by property. * * T Type of object. * @param object Container object. diff --git a/types/chrome-apps/test/index.ts b/types/chrome-apps/test/index.ts index 4fc3b050f17ddc..d2780c3a5b9aca 100644 --- a/types/chrome-apps/test/index.ts +++ b/types/chrome-apps/test/index.ts @@ -2179,5 +2179,5 @@ document.appendChild(appview); // #endregion // #region HTMLElement correctly subtypes Element in TS3.1. -const htmlElement = document.querySelector("zzzzzz") as HTMLElement; +const htmlElement = document.querySelector("zzzzzz") as HTMLElement | null; // #endregion diff --git a/types/chrome/index.d.ts b/types/chrome/index.d.ts index cb056b077f8366..92bd8d284f9620 100644 --- a/types/chrome/index.d.ts +++ b/types/chrome/index.d.ts @@ -2622,9 +2622,7 @@ declare namespace chrome.devtools.panels { onSelectionChanged: SelectionChangedEvent; } - export interface ExtensionSidebarPaneShownEvent - extends chrome.events.Event<(window: chrome.windows.Window) => void> - {} + export interface ExtensionSidebarPaneShownEvent extends chrome.events.Event<(window: Window) => void> {} export interface ExtensionSidebarPaneHiddenEvent extends chrome.events.Event<() => void> {} diff --git a/types/chromecast-caf-receiver/cast.framework.d.ts b/types/chromecast-caf-receiver/cast.framework.d.ts index 9d7d9520e2f30f..91877dc623b673 100644 --- a/types/chromecast-caf-receiver/cast.framework.d.ts +++ b/types/chromecast-caf-receiver/cast.framework.d.ts @@ -568,7 +568,12 @@ export class PlayerManager { /** * Sends a media status message to all senders (broadcast). Applications use this to send a custom state change. */ - broadcastStatus(includeMedia?: boolean, requestId?: number, customData?: any, includeQueueItems?: boolean): void; + broadcastStatus( + includeMedia?: boolean, + requestId?: number, + customData?: messages.MediaStatusCustomData | null, + includeQueueItems?: boolean, + ): void; /** * Convert media time to absolute time. @@ -736,7 +741,7 @@ export class PlayerManager { requestId: number, type: messages.ErrorType, reason?: messages.ErrorReason, - customData?: any, + customData?: unknown, ): void; /** @@ -751,7 +756,7 @@ export class PlayerManager { senderId: string, requestId: number, includeMedia?: boolean, - customData?: any, + customData?: messages.MediaStatusCustomData | null, includeQueueItems?: boolean, ): void; diff --git a/types/chromecast-caf-receiver/cast.framework.messages.d.ts b/types/chromecast-caf-receiver/cast.framework.messages.d.ts index b673369411bb77..18af671470d4bd 100644 --- a/types/chromecast-caf-receiver/cast.framework.messages.d.ts +++ b/types/chromecast-caf-receiver/cast.framework.messages.d.ts @@ -610,6 +610,18 @@ export class AudioTrackInfo { */ spatialAudio?: boolean | undefined; } + +/** + * Custom data set by the receiver application. + * + * @remarks + * + * Augment this interface in custom receivers. + */ +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface TrackCustomData { +} + /** * Describes track metadata information. * @see https://developers.google.com/cast/docs/reference/caf_receiver/cast.framework.messages.Track @@ -625,7 +637,7 @@ export class Track { /** * Custom data set by the receiver application. */ - customData?: any; + customData?: TrackCustomData; /** * Indicate track is in-band and not side-loaded track. Relevant only for text tracks. @@ -683,6 +695,17 @@ export class Track { roles?: string[] | undefined; } +/** + * Custom data set by the receiver application. + * + * @remarks + * + * Augment this interface in custom receivers. + */ +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface TextTrackStyleCustomData { +} + /** * Describes style information for a text track. * @see https://developers.google.com/cast/docs/reference/web_receiver/cast.framework.messages.TextTrackStyle @@ -696,7 +719,7 @@ export class TextTrackStyle { /** * Custom data set by the receiver application. */ - customData?: any; + customData?: TextTrackStyleCustomData; /** * RGBA color for the edge; this value will be ignored if edgeType is NONE. @@ -818,6 +841,17 @@ export class SetCredentialsRequestData extends RequestData { source?: string | undefined; } +/** + * Customizable object for storing session state. + * + * @remarks + * + * Augment this interface in custom receivers. + */ +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface SessionStateCustomData { +} + /** * A state object containing all data to be stored in StoreSession and to be * recovered in ResumeSession. @@ -829,7 +863,7 @@ export class SessionState { /** * Customizable object for storing the state. */ - customData?: any; + customData?: SessionStateCustomData; loadRequestData?: LoadRequestData | undefined; } @@ -1103,6 +1137,17 @@ export class QueueLoadRequestData extends RequestData { startIndex?: number | undefined; } +/** + * The application can define any extra queue item information needed. + * + * @remarks + * + * Augment this interface in custom receivers. + */ +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface QueueItemCustomData { +} + /** * Queue item information. Application developers may need to create a QueueItem to * insert a queue element using InsertQueueItems. In this case they should not @@ -1128,7 +1173,7 @@ export class QueueItem { /** * The application can define any extra queue item information needed. */ - customData?: any; + customData?: QueueItemCustomData; /** * Unique identifier of the item in the queue. @@ -1637,6 +1682,17 @@ export class MovieMediaMetadata { title?: string | undefined; } +/** + * Applicaiton-specific media status. + * + * @remarks + * + * Augment this interface in custom receivers. + */ +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface MediaStatusCustomData { +} + /** * Represents the status of a media session. * [Documentation]{@link https://developers.google.com/cast/docs/reference/caf_receiver/cast.framework.messages.MediaStatus} @@ -1668,7 +1724,7 @@ export class MediaStatus { /** * Application-specific media status. */ - customData?: any; + customData?: MediaStatusCustomData; /** * Extended media status information. @@ -1804,6 +1860,17 @@ export class MediaMetadata { sectionStartTimeInMedia?: number | undefined; } +/** + * Application-specific media information. + * + * @remarks + * + * Augment this interface in custom receivers. + */ +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface MediaInformationCustomData { +} + /** * Represents the media information. * @see https://developers.google.com/cast/docs/reference/web_receiver/cast.framework.messages.MediaInformation @@ -1841,7 +1908,7 @@ export class MediaInformation { /** * Application-specific media information. */ - customData?: any; + customData?: MediaInformationCustomData; /** * The media duration. @@ -2015,6 +2082,17 @@ export class LoadByEntityRequestData extends RequestData { export class LiveSeekableRange { constructor(start?: number, end?: number, isMovingWindow?: boolean, isLiveDone?: boolean); + /** + * The start time (in seconds) of the range relative to the beginning of the stream in seconds. + */ + start?: number | undefined; + + /** + * The maximum possible time (in seconds) the player can seek to + * Based on available segments, relative to the beginning of the stream. + */ + end?: number | undefined; + /** * A boolean value indicates whether a live stream is ended. If it is done; * the end of live seekable range should stop updating. @@ -2383,6 +2461,17 @@ export class BreakStatus { whenSkippable?: number | undefined; } +/** + * Application-specific break clip data. + * + * @remarks + * + * Augment this interface in custom receivers. + */ +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface BreakClipCustomData { +} + /** * Represents break clip (e.g. a clip of ad during ad break) * @see https://developers.google.com/cast/docs/reference/web_receiver/cast.framework.messages.BreakClip @@ -2411,7 +2500,7 @@ export class BreakClip { /** * Application-specific break clip data. */ - customData?: any; + customData?: BreakClipCustomData; /** * Duration of break clip in sec. */ diff --git a/types/chromecast-caf-receiver/chromecast-caf-receiver-tests.ts b/types/chromecast-caf-receiver/chromecast-caf-receiver-tests.ts index 7be1a902eca9e2..984b9cabaa22b7 100644 --- a/types/chromecast-caf-receiver/chromecast-caf-receiver-tests.ts +++ b/types/chromecast-caf-receiver/chromecast-caf-receiver-tests.ts @@ -283,3 +283,47 @@ tracksInfo.activeTrackIds = [1, 2]; tracksInfo.language = "en"; tracksInfo.textTrackStyle = new cast.framework.messages.TextTrackStyle(); tracksInfo.tracks = [new cast.framework.messages.Track(1, cast.framework.messages.TrackType.AUDIO)]; + +// You can extend the types of some customData fields via declaration merging, so that +// custom data passed between your custom receiver and CAF remains statically typed. + +declare module "./cast.framework.messages" { + interface TrackCustomData { + dialect?: string; + } + + interface TextTrackStyleCustomData { + lineHeight?: number; + } + + interface SessionStateCustomData { + userId?: string; + } + + interface QueueItemCustomData { + priority?: number; + } + + interface MediaStatusCustomData { + description?: string; + } + + interface MediaInformationCustomData { + environment: "production" | "staging"; + } + + interface BreakClipCustomData { + advertiser?: string; + } +} + +const sessionState = new cast.framework.messages.SessionState(); +const mediaStatus = new cast.framework.messages.MediaStatus(); + +track.customData = { dialect: "关中话" }; +tracksInfo.textTrackStyle!.customData = { lineHeight: 1.5 }; +sessionState.customData = { userId: "1234" }; +mediaStatus.customData = { description: "Lorem ipsum" }; +queueItem.customData = { priority: 1 }; +queueItem.media.customData = { environment: "production" }; +breakClip.customData = { advertiser: "Umbrella Corporation" }; diff --git a/types/classificator/index.d.ts b/types/classificator/index.d.ts index c763cc5667044c..b57f506bf85b52 100644 --- a/types/classificator/index.d.ts +++ b/types/classificator/index.d.ts @@ -79,7 +79,7 @@ declare namespace Classificator { * - the keys are the entries in `tokens` * - the values are the frequency of each entry in `tokens` */ - frequencyTable(tokens: Readonly): Record; + frequencyTable(tokens: readonly string[]): Record; /** * Dump the classifier's state as a JSON string. diff --git a/types/clerk.io/clerk.io-tests.ts b/types/clerk.io/clerk.io-tests.ts index 7cec5ef9a63b62..a2613d7715b2ba 100644 --- a/types/clerk.io/clerk.io-tests.ts +++ b/types/clerk.io/clerk.io-tests.ts @@ -9,9 +9,23 @@ window.Clerk("call", "test"); return; } - // $ExpectType Promise - window.Clerk("call", "search/predictive", { + // $ExpectType ClerkResponseSearchPredictive + const response = await window.Clerk("call", "search/predictive", { query: "predictive", limit: 5, }); + + // @ts-expect-error + response.results; + + // $ExpectType number[] + response.result; + + const searchResponse = await window.Clerk("call", "search/search", { + query: "test", + limit: 10, + }); + + // $ExpectType string + searchResponse.query; }); diff --git a/types/clerk.io/index.d.ts b/types/clerk.io/index.d.ts index f6388ee2187df2..8e6bc0ecae3340 100644 --- a/types/clerk.io/index.d.ts +++ b/types/clerk.io/index.d.ts @@ -174,7 +174,7 @@ export type ConfigType = T extends keyof ConfigTypes ? export interface ClerkBaseResponse { status: "ok"; - results: number[]; + result: number[]; } export interface ClerkResponseProducts extends ClerkBaseResponse { @@ -202,6 +202,7 @@ export interface ClerkResponseSearchPages extends Omit", callback: (token: string) => {}, "expired-callback": () => {}, - "error-callback": () => {}, + "error-callback": (error: string) => {}, theme: "auto", tabindex: 5, }; @@ -19,7 +19,6 @@ const themeDark: Turnstile.Theme = "dark"; const widgetSizeNormal: Turnstile.WidgetSize = "normal"; const widgetSizeCompact: Turnstile.WidgetSize = "compact"; -const widgetSizeInvisible: Turnstile.WidgetSize = "invisible"; const failureRetryModeNever: Turnstile.FailureRetryMode = "never"; const failureRetryModeAuto: Turnstile.FailureRetryMode = "auto"; diff --git a/types/cloudflare-turnstile/index.d.ts b/types/cloudflare-turnstile/index.d.ts index 96e3f15407253a..d09f5b9e29ba42 100644 --- a/types/cloudflare-turnstile/index.d.ts +++ b/types/cloudflare-turnstile/index.d.ts @@ -58,10 +58,10 @@ declare namespace Turnstile { type Theme = "auto" | "light" | "dark"; /** - * The size of the Turnstile widget. - * The default is "normal", which is the default widget look. This can be set to "compact" to make the widget less large. The "invisible" option is only for invisible mode. + * The widget size. + * Can take the following values: normal, compact. */ - type WidgetSize = "normal" | "compact" | "invisible"; + type WidgetSize = "normal" | "compact"; /** * How to retry on widget failure. @@ -118,9 +118,10 @@ declare namespace Turnstile { "expired-callback"?: (token: string) => void; /** - * Optional. A JavaScript callback that is invoked when an error occurs with the widget. + * Optional. A JavaScript callback invoked when there is an error (e.g. network error or the challenge failed). + * Refer to [Client-side errors](https://developers.cloudflare.com/turnstile/troubleshooting/client-side-errors/). */ - "error-callback"?: VoidFunction | undefined; + "error-callback"?: ((error: string) => void) | undefined; /** * Optional. A JavaScript callback that is invoked when the Turnstile widget times out. diff --git a/types/cloudflare-turnstile/package.json b/types/cloudflare-turnstile/package.json index caabdca60bfb7e..a6bfe1ab9bdbd6 100644 --- a/types/cloudflare-turnstile/package.json +++ b/types/cloudflare-turnstile/package.json @@ -1,7 +1,7 @@ { "private": true, "name": "@types/cloudflare-turnstile", - "version": "0.1.9999", + "version": "0.2.9999", "nonNpm": true, "nonNpmDescription": "Cloudflare Turnstile", "projects": [ diff --git a/types/cloudflare/package.json b/types/cloudflare/package.json index cd4493aa174226..d98d9ba04b7b48 100644 --- a/types/cloudflare/package.json +++ b/types/cloudflare/package.json @@ -8,10 +8,5 @@ "devDependencies": { "@types/cloudflare": "workspace:." }, - "owners": [ - { - "name": "Samuel Corsi-House", - "githubUsername": "Xenfo" - } - ] + "owners": [] } diff --git a/types/clownface/clownface-tests.ts b/types/clownface/clownface-tests.ts index 44891c3a03c529..9a31ef5a4a1aa9 100644 --- a/types/clownface/clownface-tests.ts +++ b/types/clownface/clownface-tests.ts @@ -276,7 +276,9 @@ function testHas() { const cf: AnyPointer = {}; let has: AnyPointer, Dataset> = cf.has(predicate, "Stuart"); has = cf.has([predicate, predicate], "Stuart"); + has = cf.has(new Set([predicate, predicate]), "Stuart"); has = cf.has(predicate, [literal, literal]); + has = cf.has(predicate, new Set([literal, literal])); } function testIn() { @@ -284,6 +286,7 @@ function testIn() { let cfIn: MultiPointer = cf.in(); cfIn = cf.in(node); cfIn = cf.in([node, node]); + cfIn = cf.in(new Set([node, node])); cfIn = cf.in(cf.node(node)); cfIn = cf.in(cf.node([node, node])); @@ -363,6 +366,7 @@ function testNode() { let cfLit: AnyPointer = cf.node("foo"); cfLit = cf.node(123); const cfLitMany: AnyPointer = cf.node(["foo", "bar"]); + const cfLitManyFromSet: AnyPointer = cf.node(new Set(["foo", "bar"])); singleTerm = cf.node("http://example.org/", { type: "NamedNode" }); const cfBlank: AnyPointer = cf.node(null, { type: "BlankNode" }); cfLit = cf.node("example", { datatype: node.value }); @@ -385,6 +389,7 @@ function testOut() { let cfTerm: AnyPointer = cf.out(); cfTerm = cf.out(node); cfTerm = cf.out([node, node]); + cfTerm = cf.out(new Set([node, node])); cfTerm = cf.out(cf.node([node, node])); const singleContext: AnyPointer = {}; @@ -458,7 +463,14 @@ function addInAddOutRetainsType() { const addOutSingle: AnyPointer = singleNamed.addOut(predicate, "foo"); const addOutSingleObjectArray: AnyPointer = singleNamed.addOut(predicate, ["foo", "bar"]); + const addOutSingleObjectSet: AnyPointer = singleNamed.addOut( + predicate, + new Set(["foo", "bar"]), + ); const addOutSinglePredicateArray: AnyPointer = singleNamed.addOut([predicate, predicate]); + const addOutSinglePredicateSet: AnyPointer = singleNamed.addOut( + new Set([predicate, predicate]), + ); const addOutSingleNoObject: AnyPointer = singleNamed.addOut(predicate); const addOutSingleWithCallback: AnyPointer = singleNamed.addOut(predicate, () => {}); const addOutSingleWithObjectAndCallback: AnyPointer = singleNamed.addOut( @@ -469,7 +481,9 @@ function addInAddOutRetainsType() { const addInSingle: AnyPointer = singleNamed.addIn(predicate, "foo"); const addInSingleObjectArray: AnyPointer = singleNamed.addIn(predicate, ["foo", "bar"]); + const addInSingleObjectSet: AnyPointer = singleNamed.addIn(predicate, new Set(["foo", "bar"])); const addInSinglePredicateArray: AnyPointer = singleNamed.addIn([predicate, predicate]); + const addInSinglePredicateSet: AnyPointer = singleNamed.addIn(new Set([predicate, predicate])); const addInSingleNoObject: AnyPointer = singleNamed.addIn(predicate); const addInSingleWithCallback: AnyPointer = singleNamed.addIn(predicate, () => {}); const addInSingleWithObjectAndCallback: AnyPointer = singleNamed.addIn( diff --git a/types/clownface/index.d.ts b/types/clownface/index.d.ts index 886626fa572f10..3d1dc598ad9c0a 100644 --- a/types/clownface/index.d.ts +++ b/types/clownface/index.d.ts @@ -17,7 +17,7 @@ type TermOrClownface = MultiPointer | X; type TermOrLiteral = TermOrClownface | string | number | boolean; type AddCallback = (added: AnyPointer) => void; -type SingleOrArray = T | readonly T[]; +type SingleOrArray = T | readonly T[] | Iterable; type SingleOrOneElementArray = T | readonly [T]; type SingleOrArrayOfTerms = SingleOrArray | MultiPointer; @@ -85,7 +85,7 @@ export interface AnyPointer, options?: NodeOptions): AnyPointer; - node(values: Array, options?: NodeOptions): AnyPointer; + node(values: Iterable, options?: NodeOptions): AnyPointer; node(value: SingleOrOneElementArray | AnyPointer, options?: NodeOptions): AnyPointer; @@ -100,14 +100,14 @@ export interface AnyPointer, options?: NodeOptions): AnyPointer; node( - values: Array | Iterable, + values: Iterable, options?: NodeOptions, ): AnyPointer; blankNode(value?: SingleOrOneElementArray | AnyPointer): AnyPointer; blankNode( - values: string[] | MultiPointer | Iterable | Iterable>, + values: MultiPointer | Iterable | Iterable>, ): AnyPointer; literal( @@ -117,9 +117,8 @@ export interface AnyPointer + | Iterable | MultiPointer - | Iterable | Iterable>, languageOrDatatype?: string | NamedNode, ): AnyPointer; @@ -130,9 +129,8 @@ export interface AnyPointer + | Iterable | MultiPointer - | Iterable | Iterable>, ): AnyPointer; diff --git a/types/color-rgba/color-rgba-tests.ts b/types/color-rgba/color-rgba-tests.ts index 0b4d640f7535f5..dcd93081f75263 100644 --- a/types/color-rgba/color-rgba-tests.ts +++ b/types/color-rgba/color-rgba-tests.ts @@ -1,32 +1,34 @@ import rgba = require("color-rgba"); -// $ExpectType [number, number, number, number] | undefined +// $ExpectType [number, number, number, number] | [] rgba("rgb(80, 120, 160)"); // [80, 120, 160, 1] -// $ExpectType [number, number, number, number] | undefined +// $ExpectType [number, number, number, number] | [] rgba("rgba(80, 120, 160, .5)"); // [80, 120, 160, .5] -// $ExpectType [number, number, number, number] | undefined +// $ExpectType [number, number, number, number] | [] rgba("hsla(109, 50%, 50%, .75)"); // [87.125, 191.25, 63.75, .75] -// $ExpectType [number, number, number, number] | undefined +// $ExpectType [number, number, number, number] | [] rgba([10, 20, 30]); -// $ExpectType [number, number, number, number] | undefined +// $ExpectType [number, number, number, number] | [] rgba({ r: 10, g: 20, b: 30, }); -// $ExpectType [number, number, number, number] | undefined +// $ExpectType [number, number, number, number] | [] rgba({ red: 10, green: 0, blue: 30, }); -// $ExpectType [number, number, number, number] | undefined +// $ExpectType [number, number, number, number] | [] rgba({ h: 10, s: 0, l: 30, }); -// $ExpectType [number, number, number, number] | undefined +// $ExpectType [number, number, number, number] | [] rgba("0x00ff00"); -// $ExpectType [number, number, number, number] | undefined +// $ExpectType [number, number, number, number] | [] rgba("yellow"); +// $ExpectType [number, number, number, number] | [] +rgba("*garbage*"); diff --git a/types/color-rgba/index.d.ts b/types/color-rgba/index.d.ts index 16eec4ca64c727..a222be40499335 100644 --- a/types/color-rgba/index.d.ts +++ b/types/color-rgba/index.d.ts @@ -4,7 +4,7 @@ * `color` can be a CSS color string, * an array with channel values, an object etc., */ -declare function rgba(string: ColorValue): [number, number, number, number] | undefined; +declare function rgba(string: ColorValue): [number, number, number, number] | []; type ColorValue = string | RGBTuple | RGBColor | RGBKeyedColor | HSL; diff --git a/types/consumer-data-standards/README.md b/types/consumer-data-standards/README.md new file mode 100644 index 00000000000000..152bf8d001a6aa --- /dev/null +++ b/types/consumer-data-standards/README.md @@ -0,0 +1,63 @@ +# CDS Type Definition Library + +## Overview + +This fork of the [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped) repository contains specialised type definitions for the Consumer Data Standards (CDS) to support TypeScript projects within the CDR ecosystem. These definitions are aligned with the published [Consumer Data Standards](https://consumerdatastandardsaustralia.github.io/standards/#introduction), ensuring accurate interface representations for CDR API structures. + +## Using the Type Definitions + +The Data Standards Body publishes the Type Definitions as a [npm package](https://www.npmjs.com/package/@types/consumer-data-standards). To use these type definitions in your TypeScript projects, you can install them via npm as part of your development dependencies. Please refer to the [Quick Start Guide](#quick-start-guide) section below for more information. + +This tool: + +- is maintained regularly to ensure compatibility with the latest Consumer Data Standards. +- assists Data Holders with regulatory adherence by providing TypeScript type enforcement that reduces errors, increases code quality, and improves development efficiency. + +## Quick Start Guide + +Please follow these steps to integrate the CDR-specific type definitions into your TypeScript projects: + +1. **Install** via npm or Yarn: Depending on your preference, you can use npm or Yarn to install the CDS type definitions package published to npm. + + ```bash + npm install @types/consumer-data-standards + ``` + + Or + + ```bash + yarn install @types/consumer-data-standards + ``` + +2. **Usage**: Utilise the types in your TypeScript code as needed: + + ```tsx + import { YourType } from 'your-package'; + + function processData(data: YourType) { + // your code here + } + ``` + +3. **Stay Updated**: Regularly check for updates to ensure you have the latest type definitions. + + +## Reporting Issues + +Encountered an issue? We're here to help. Please visit our [issue reporting guidelines](https://d61cds.notion.site/Issue-Reporting-Guidelines-71a329a0658c4b69a232eab95822509b?pvs=4) for submitting an issue. + +## Stay Updated + +Join our newsletter to receive the latest updates, release notes, and alerts. [Subscribe here](https://consumerdatastandards.us18.list-manage.com/subscribe?u=fb3bcb1ec5662d9767ab3c414&id=a4414b3906). + +## Disclaimer + +The artefacts in this repository are offered without warranty or liability, in accordance with the [MIT licence.](https://github.com/ConsumerDataStandardsAustralia/java-artefacts/blob/master/LICENSE) + +[The Data Standards Body](https://consumerdatastandards.gov.au/about/) (DSB) develops these artefacts in the course of its work, in order to perform quality assurance on the Australian Consumer Data Right Standards (Data Standards). + +The DSB makes this repository, and its artefacts, public [on a non-commercial basis](https://github.com/ConsumerDataStandardsAustralia/java-artefacts/blob/master/LICENSE) in the interest of supporting the participants in the CDR ecosystem. + +The resources of the DSB are primarily directed towards assisting the [Data Standards Chair](https://consumerdatastandards.gov.au/about/) for [developing the Data Standards](https://github.com/ConsumerDataStandardsAustralia/standards). + +Consequently, the development work provided on the artefacts in this repository is on a best-effort basis, and the DSB acknowledges the use of these tools alone is not sufficient for, nor should they be relied upon with respect to [accreditation](https://www.accc.gov.au/focus-areas/consumer-data-right-cdr-0/cdr-draft-accreditation-guidelines), conformance, or compliance purposes. diff --git a/types/consumer-data-standards/admin/index.d.ts b/types/consumer-data-standards/admin/index.d.ts index 0ff36d10d8d85e..fee2251c820ac4 100644 --- a/types/consumer-data-standards/admin/index.d.ts +++ b/types/consumer-data-standards/admin/index.d.ts @@ -943,8 +943,18 @@ export interface PeakTPSMetricsV2 { }; [k: string]: unknown; } + +/** + * Percentage of calls within the performance threshold for the specified hour. 0.0 means 0%. 1.0 means 100%. Must be a positive value or zero + */ +export type PerformanceHours = string; /* These are the schema definitions stipulated by the Data Standards Body for the admin api. */ +/** + * Array of contiguous hourly metrics for the specified day. Each element represents a 1 hour period starting from 12am-1am. Timezone for determining 12am must be consistent but is at the discretion of the Data Holder + */ +export type PerformancePreviousDays = PerformanceHours[]; + /** * Percentage of calls within the performance thresholds */ @@ -966,7 +976,7 @@ export interface PerformanceMetrics { */ export interface PerformanceMetricsV3 { /** - * Percentage of calls within the performance thresholds + * Percentage of calls within Primary Data Holder performance thresholds. Note that Secondary Data Holder performance MUST be excluded from this metric. */ aggregate?: { /** @@ -990,7 +1000,7 @@ export interface PerformanceMetricsV3 { /** * Percentage of calls within the performance threshold for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available. 0.0 means 0%. 1.0 means 100%. Values must be a positive or zero */ - previousDays?: string[][] | null; + previousDays?: PerformancePreviousDays[] | null; [k: string]: unknown; }; /** @@ -1004,7 +1014,7 @@ export interface PerformanceMetricsV3 { /** * Percentage of calls within the performance threshold for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available. 0.0 means 0%. 1.0 means 100%. Values must be a positive or zero */ - previousDays?: string[][] | null; + previousDays?: PerformancePreviousDays[] | null; [k: string]: unknown; }; /** @@ -1022,7 +1032,7 @@ export interface PerformanceMetricsV3 { /** * Percentage of calls within the performance threshold for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available. 0.0 means 0%. 1.0 means 100%. Values must be a positive or zero */ - previousDays?: string[][] | null; + previousDays?: PerformancePreviousDays[] | null; [k: string]: unknown; }; /** @@ -1036,7 +1046,7 @@ export interface PerformanceMetricsV3 { /** * Percentage of calls within the performance threshold for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available. 0.0 means 0%. 1.0 means 100%. Values must be a positive or zero */ - previousDays?: string[][] | null; + previousDays?: PerformancePreviousDays[] | null; [k: string]: unknown; }; [k: string]: unknown; @@ -1052,7 +1062,7 @@ export interface PerformanceMetricsV3 { /** * Percentage of calls within the performance threshold for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available. 0.0 means 0%. 1.0 means 100%. Values must be a positive or zero */ - previousDays?: string[][] | null; + previousDays?: PerformancePreviousDays[] | null; [k: string]: unknown; }; /** @@ -1070,7 +1080,7 @@ export interface PerformanceMetricsV3 { /** * Percentage of calls within the performance threshold for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available. 0.0 means 0%. 1.0 means 100%. Values must be a positive or zero */ - previousDays?: string[][] | null; + previousDays?: PerformancePreviousDays[] | null; [k: string]: unknown; }; /** @@ -1084,7 +1094,7 @@ export interface PerformanceMetricsV3 { /** * Percentage of calls within the performance threshold for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available. 0.0 means 0%. 1.0 means 100%. Values must be a positive or zero */ - previousDays?: string[][] | null; + previousDays?: PerformancePreviousDays[] | null; [k: string]: unknown; }; [k: string]: unknown; @@ -1100,7 +1110,7 @@ export interface PerformanceMetricsV3 { /** * Percentage of calls within the performance threshold for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available. 0.0 means 0%. 1.0 means 100%. Values must be a positive or zero */ - previousDays?: string[][] | null; + previousDays?: PerformancePreviousDays[] | null; [k: string]: unknown; }; /** @@ -1114,13 +1124,11 @@ export interface PerformanceMetricsV3 { /** * Percentage of calls within the performance threshold for previous days. The first element indicates yesterday and so on. A maximum of seven entries is required if available. 0.0 means 0%. 1.0 means 100%. Values must be a positive or zero */ - previousDays?: string[][] | null; + previousDays?: PerformancePreviousDays[] | null; [k: string]: unknown; }; [k: string]: unknown; } -/* These are the schema definitions stipulated by the Data Standards Body for the admin api. */ - /** * Number of calls rejected due to traffic thresholds over time */ diff --git a/types/consumer-data-standards/banking/index.d.ts b/types/consumer-data-standards/banking/index.d.ts index 651f460d9f82b8..1230c3c5cadbe6 100644 --- a/types/consumer-data-standards/banking/index.d.ts +++ b/types/consumer-data-standards/banking/index.d.ts @@ -5,15 +5,15 @@ export interface accV3DetailFeatureObj extends BankingProductFeatureV2 { export interface BankingAccountDetailV3 extends BankingAccountV2 { /** - * The unmasked BSB for the account. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces + * The unmasked BSB for the account. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces. */ bsb?: string; /** - * The unmasked account number for the account. Should not be supplied if the account number is a PAN requiring PCI compliance. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces + * The unmasked account number for the account. Should not be supplied if the account number is a PAN requiring PCI compliance. Is expected to be formatted as digits only with leading zeros included and no punctuation or spaces. */ accountNumber?: string; /** - * Optional field to indicate if this account is part of a bundle that is providing additional benefit for to the customer + * Optional field to indicate if this account is part of a bundle that is providing additional benefit to the customer. */ bundleName?: string; /** @@ -24,31 +24,31 @@ export interface BankingAccountDetailV3 extends BankingAccountV2 { creditCard?: BankingCreditCardAccount; loan?: BankingLoanAccountV2; /** - * current rate to calculate interest earned being applied to deposit balances as it stands at the time of the API call + * current rate to calculate interest earned being applied to deposit balances as it stands at the time of the API call. */ depositRate?: string; /** - * The current rate to calculate interest payable being applied to lending balances as it stands at the time of the API call + * The current rate to calculate interest payable being applied to lending balances as it stands at the time of the API call. */ lendingRate?: string; /** - * Fully described deposit rates for this account based on the equivalent structure in Product Reference + * Fully described deposit rates for this account based on the equivalent structure in Product Reference. */ depositRates?: BankingProductDepositRate[]; /** - * Fully described deposit rates for this account based on the equivalent structure in Product Reference + * Fully described lending rates for this account based on the equivalent structure in Product Reference. */ lendingRates?: BankingProductLendingRateV2[]; /** - * Array of features of the account based on the equivalent structure in Product Reference with the following additional field + * Array of features of the account based on the equivalent structure in Product Reference with the following additional field. */ features?: accV3DetailFeatureObj[]; /** - * Fees and charges applicable to the account based on the equivalent structure in Product Reference + * Fees and charges applicable to the account based on the equivalent structure in Product Reference. */ fees?: BankingProductFee[]; /** - * The addresses for the account to be used for correspondence + * The addresses for the account to be used for correspondence. */ addresses?: CommonPhysicalAddress[]; @@ -58,39 +58,39 @@ export interface BankingAccountDetailV3 extends BankingAccountV2 { export interface BankingAccountV2 { /** - * A unique ID of the account adhering to the standards for ID permanence + * A unique ID of the account adhering to the standards for ID permanence. */ accountId: string; /** - * Value indicating the number of customers that have ownership of the account, according to the data holder's definition of account ownership. Does not indicate that all account owners are eligible consumers + * Value indicating the number of customers that have ownership of the account, according to the data holder's definition of account ownership. Does not indicate that all account owners are eligible consumers. */ accountOwnership: "UNKNOWN" | "ONE_PARTY" | "TWO_PARTY" | "MANY_PARTY" | "OTHER"; /** - * Date that the account was created (if known) + * Date that the account was created (if known). */ creationDate?: string | null; /** - * The display name of the account as defined by the bank. This should not incorporate account numbers or PANs. If it does the values should be masked according to the rules of the MaskedAccountString common type. + * The display name of the account as defined by the bank. This should not incorporate account numbers or PANs. If it does the values should be masked according to the rules of the [MaskedAccountString](#common-field-types) common type. */ displayName: string; /** - * Flag indicating that the customer associated with the authorisation is an owner of the account. Does not indicate sole ownership, however. If not present then 'true' is assumed + * Flag indicating that the customer associated with the authorisation is an owner of the account. Does not indicate sole ownership, however. If not present then `true` is assumed. */ isOwned?: boolean | null; /** - * A masked version of the account. Whether BSB/Account Number, Credit Card PAN or another number + * A masked version of the account. Whether BSB/Account Number, Credit Card PAN or another number. */ maskedNumber: string; /** - * A customer supplied nick name for the account + * A customer supplied nick name for the account. */ nickname?: string | null; /** - * Open or closed status for the account. If not present then OPEN is assumed + * Open or closed status for the account. If not present then `OPEN` is assumed. */ openStatus?: ("CLOSED" | "OPEN") | null; /** - * The category to which a product or account belongs. See [here](#product-categories) for more details + * The category to which a product or account belongs. See [here](#product-categories) for more details. */ productCategory: | "BUSINESS_LOANS" @@ -106,7 +106,7 @@ export interface BankingAccountV2 { | "TRANS_AND_SAVINGS_ACCOUNTS" | "TRAVEL_CARDS"; /** - * The unique identifier of the account as defined by the data holder (akin to model number for the account) + * The unique identifier of the account as defined by the data holder (akin to model number for the account). */ productName: string; [k: string]: unknown; @@ -116,23 +116,23 @@ export interface BankingAccountV2 { export interface BankingAuthorisedEntity { /** - * Australian Business Number for the authorised entity + * Australian Business Number for the authorised entity. */ abn?: string | null; /** - * Australian Company Number for the authorised entity + * Australian Company Number for the authorised entity. */ acn?: string | null; /** - * Australian Registered Body Number for the authorised entity + * Australian Registered Body Number for the authorised entity. */ arbn?: string | null; /** - * Description of the authorised entity derived from previously executed direct debits + * Description of the authorised entity derived from previously executed direct debits. */ description?: string | null; /** - * Name of the financial institution through which the direct debit will be executed. Is required unless the payment is made via a credit card scheme + * Name of the financial institution through which the direct debit will be executed. Is required unless the payment is made via a credit card scheme. */ financialInstitution?: string | null; [k: string]: unknown; @@ -141,40 +141,40 @@ export interface BankingAuthorisedEntity { export interface BankingBalance { /** - * A unique ID of the account adhering to the standards for ID permanence + * A unique ID of the account adhering to the standards for ID permanence. */ accountId: string; /** - * Object representing the available limit amortised according to payment schedule. Assumed to be zero if absent + * Object representing the available limit amortised according to payment schedule. Assumed to be zero if absent. */ amortisedLimit?: string | null; /** - * Balance representing the amount of funds available for transfer. Assumed to be zero or positive + * Balance representing the amount of funds available for transfer. Assumed to be zero or positive. */ availableBalance: string; /** - * Object representing the maximum amount of credit that is available for this account. Assumed to be zero if absent + * Object representing the maximum amount of credit that is available for this account. Assumed to be zero if absent. */ creditLimit?: string | null; /** - * The currency for the balance amounts. If absent assumed to be AUD + * The currency for the balance amounts. If absent assumed to be `AUD`. */ currency?: string | null; /** - * The balance of the account at this time. Should align to the balance available via other channels such as Internet Banking. Assumed to be negative if the customer has money owing + * The balance of the account at this time. Should align to the balance available via other channels such as Internet Banking. Assumed to be negative if the customer has money owing. */ currentBalance: string; /** - * Optional array of balances for the account in other currencies. Included to support accounts that support multi-currency purses such as Travel Cards + * Optional array of balances for the account in other currencies. Included to support accounts that support multi-currency purses such as Travel Cards. */ purses?: | Array<{ /** - * The balance available for this additional currency purse + * The balance available for this additional currency purse. */ amount: string; /** - * The currency for the purse + * The currency for the purse. */ currency?: string | null; [k: string]: unknown; @@ -186,11 +186,11 @@ export interface BankingBalance { export interface BankingBalancePurse { /** - * The balance available for this additional currency purse + * The balance available for this additional currency purse. */ amount: string; /** - * The currency for the purse + * The currency for the purse. */ currency?: string | null; [k: string]: unknown; @@ -199,15 +199,15 @@ export interface BankingBalancePurse { export interface BankingBillerPayee { /** - * BPAY Biller Code of the Biller + * BPAY Biller Code of the Biller. */ billerCode: string; /** - * Name of the Biller + * Name of the Biller. */ billerName: string; /** - * BPAY CRN of the Biller (if available).
Where the CRN contains sensitive information, it should be masked in line with how the Data Holder currently displays account identifiers in their existing online banking channels. If the contents of the CRN match the format of a Credit Card PAN they should be masked according to the rules applicable for MaskedPANString. If the contents are otherwise sensitive, then it should be masked using the rules applicable for the MaskedAccountString common type. + * BPAY CRN of the Biller (if available).
Where the CRN contains sensitive information, it should be masked in line with how the Data Holder currently displays account identifiers in their existing online banking channels. If the contents of the CRN match the format of a Credit Card PAN they should be masked according to the rules applicable for [MaskedPANString](#common-field-types). If the contents are otherwise sensitive, then it should be masked using the rules applicable for the [MaskedAccountString](#common-field-types) common type. */ crn?: string | null; [k: string]: unknown; @@ -216,19 +216,19 @@ export interface BankingBillerPayee { export interface BankingCreditCardAccount { /** - * The minimum payment amount due for the next card payment + * The minimum payment amount due for the next card payment. */ minPaymentAmount: string; /** - * If absent assumes AUD + * If absent assumes `AUD`. */ paymentCurrency?: string | null; /** - * The amount due for the next card payment + * The amount due for the next card payment. */ paymentDueAmount: string; /** - * Date that the next payment for the card is due + * Date that the next payment for the card is due. */ paymentDueDate: string; [k: string]: unknown; @@ -237,19 +237,19 @@ export interface BankingCreditCardAccount { export interface BankingDigitalWalletPayee { /** - * The identifier of the digital wallet (dependent on type) + * The identifier of the digital wallet (dependent on type). */ identifier: string; /** - * The name assigned to the digital wallet by the owner of the wallet, else the display name provided by the digital wallet provider + * The display name of the wallet as given by the customer, else a default value defined by the data holder. */ name: string; /** - * The provider of the digital wallet + * The provider of the digital wallet. */ provider: "PAYPAL_AU" | "OTHER"; /** - * The type of the digital wallet identifier + * The type of the digital wallet identifier. */ type: "EMAIL" | "CONTACT_NAME" | "TELEPHONE"; [k: string]: unknown; @@ -263,23 +263,23 @@ export interface BankingDirectDebit { accountId: string; authorisedEntity: { /** - * Australian Business Number for the authorised entity + * Australian Business Number for the authorised entity. */ abn?: string | null; /** - * Australian Company Number for the authorised entity + * Australian Company Number for the authorised entity. */ acn?: string | null; /** - * Australian Registered Body Number for the authorised entity + * Australian Registered Body Number for the authorised entity. */ arbn?: string | null; /** - * Description of the authorised entity derived from previously executed direct debits + * Description of the authorised entity derived from previously executed direct debits. */ description?: string | null; /** - * Name of the financial institution through which the direct debit will be executed. Is required unless the payment is made via a credit card scheme + * Name of the financial institution through which the direct debit will be executed. Is required unless the payment is made via a credit card scheme. */ financialInstitution?: string | null; [k: string]: unknown; @@ -299,37 +299,37 @@ export interface BankingDirectDebit { export interface BankingDomesticPayee { account?: { /** - * Name of the account to pay to + * Name of the account to pay to. */ accountName?: string | null; /** - * Number of the account to pay to + * Number of the account to pay to. */ accountNumber: string; /** - * BSB of the account to pay to + * BSB of the account to pay to. */ bsb: string; [k: string]: unknown; }; card?: { /** - * Name of the account to pay to + * Name of the account to pay to. */ cardNumber: string; [k: string]: unknown; }; payId?: { /** - * The identifier of the PayID (dependent on type) + * The identifier of the PayID (dependent on type). */ identifier: string; /** - * The name assigned to the PayID by the owner of the PayID + * The name assigned to the PayID by the owner of the PayID. */ name?: string | null; /** - * The type of the PayID + * The type of the PayID. */ type: "ABN" | "EMAIL" | "ORG_IDENTIFIER" | "TELEPHONE"; [k: string]: unknown; @@ -344,15 +344,15 @@ export interface BankingDomesticPayee { export interface BankingDomesticPayeeAccount { /** - * Name of the account to pay to + * Name of the account to pay to. */ accountName?: string | null; /** - * Number of the account to pay to + * Number of the account to pay to. */ accountNumber: string; /** - * BSB of the account to pay to + * BSB of the account to pay to. */ bsb: string; [k: string]: unknown; @@ -361,7 +361,7 @@ export interface BankingDomesticPayeeAccount { export interface BankingDomesticPayeeCard { /** - * Name of the account to pay to + * Name of the account to pay to. */ cardNumber: string; [k: string]: unknown; @@ -370,15 +370,15 @@ export interface BankingDomesticPayeeCard { export interface BankingDomesticPayeePayId { /** - * The identifier of the PayID (dependent on type) + * The identifier of the PayID (dependent on type). */ identifier: string; /** - * The name assigned to the PayID by the owner of the PayID + * The name assigned to the PayID by the owner of the PayID. */ name?: string | null; /** - * The type of the PayID + * The type of the PayID. */ type: "ABN" | "EMAIL" | "ORG_IDENTIFIER" | "TELEPHONE"; [k: string]: unknown; @@ -388,61 +388,61 @@ export interface BankingDomesticPayeePayId { export interface BankingInternationalPayee { bankDetails: { /** - * Account Targeted for payment + * Account Targeted for payment. */ accountNumber: string; bankAddress?: { /** - * Address of the recipient Bank + * Address of the recipient Bank. */ address: string; /** - * Name of the recipient Bank + * Name of the recipient Bank. */ name: string; [k: string]: unknown; } | null; /** - * Swift bank code. Aligns with standard [ISO 9362](https://www.iso.org/standard/60390.html) + * Swift bank code. Aligns with standard [ISO 9362](https://www.iso.org/standard/60390.html). */ beneficiaryBankBIC?: string | null; /** - * Number for the Clearing House Interbank Payments System + * Number for the Clearing House Interbank Payments System. */ chipNumber?: string | null; /** - * Country of the recipient institution. A valid [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html) country code + * Country of the recipient institution. A valid [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html) country code. */ country: string; /** - * Number for Fedwire payment (Federal Reserve Wire Network) + * Number for Fedwire payment (Federal Reserve Wire Network). */ fedWireNumber?: string | null; /** - * The legal entity identifier (LEI) for the beneficiary. Aligns with [ISO 17442](https://www.iso.org/standard/59771.html) + * The legal entity identifier (LEI) for the beneficiary. Aligns with [ISO 17442](https://www.iso.org/standard/59771.html). */ legalEntityIdentifier?: string | null; /** - * International bank routing number + * International bank routing number. */ routingNumber?: string | null; /** - * Sort code used for account identification in some jurisdictions + * Sort code used for account identification in some jurisdictions. */ sortCode?: string | null; [k: string]: unknown; }; beneficiaryDetails: { /** - * Country where the beneficiary resides. A valid [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html) country code + * Country where the beneficiary resides. A valid [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html) country code. */ country: string; /** - * Response message for the payment + * Response message for the payment. */ message?: string | null; /** - * Name of the beneficiary + * Name of the beneficiary. */ name?: string | null; [k: string]: unknown; @@ -453,63 +453,63 @@ export interface BankingInternationalPayee { export interface BankingLoanAccountV2 { /** - * Date that the loan is due to be repaid in full + * Date that the loan is due to be repaid in full. */ loanEndDate?: string | null; /** - * Maximum amount of funds that can be redrawn. If not present redraw is not available even if the feature exists for the account + * Maximum amount of funds that can be redrawn. If not present redraw is not available even if the feature exists for the account. */ maxRedraw?: string | null; /** - * If absent assumes AUD + * If absent assumes `AUD`. */ maxRedrawCurrency?: string | null; /** - * Minimum amount of next instalment + * Minimum amount of next instalment. */ minInstalmentAmount?: string | null; /** - * If absent assumes AUD + * If absent assumes `AUD`. */ minInstalmentCurrency?: string | null; /** - * Minimum redraw amount + * Minimum redraw amount. */ minRedraw?: string | null; /** - * If absent assumes AUD + * If absent assumes `AUD`. */ minRedrawCurrency?: string | null; /** - * Next date that an instalment is required + * Next date that an instalment is required. */ nextInstalmentDate?: string | null; /** - * Set to true if one or more offset accounts are configured for this loan account + * Set to `true` if one or more offset accounts are configured for this loan account. */ offsetAccountEnabled?: boolean | null; /** - * The accountIDs of the configured offset accounts attached to this loan. Only offset accounts that can be accessed under the current authorisation should be included. It is expected behaviour that offsetAccountEnabled is set to true but the offsetAccountIds field is absent or empty. This represents a situation where an offset account exists but details can not be accessed under the current authorisation + * The accountIDs of the configured offset accounts attached to this loan. Only offset accounts that can be accessed under the current authorisation should be included. It is expected behaviour that _offsetAccountEnabled_ is set to `true` but the _offsetAccountIds_ field is absent or empty. This represents a situation where an offset account exists but details can not be accessed under the current authorisation. */ offsetAccountIds?: string[] | null; /** - * Optional original loan value + * Optional original loan value. */ originalLoanAmount?: string | null; /** - * If absent assumes AUD + * If absent assumes `AUD`. */ originalLoanCurrency?: string | null; /** - * Optional original start date for the loan + * Optional original start date for the loan. */ originalStartDate?: string | null; /** - * The expected or required repayment frequency. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) + * The expected or required repayment frequency. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax). */ repaymentFrequency?: string | null; /** - * Options in place for repayments. If absent defaults to PRINCIPAL_AND_INTEREST + * Options in place for repayments. If absent defaults to `PRINCIPAL_AND_INTEREST`. */ repaymentType?: ("INTEREST_ONLY" | "PRINCIPAL_AND_INTEREST") | null; [k: string]: unknown; @@ -518,20 +518,20 @@ export interface BankingLoanAccountV2 { export interface BankingPayeeDetailV2 extends BankingPayeeV2 { /** - * Type of object included that describes the payee in detail + * Type of object included that describes the payee in detail. */ payeeUType: "biller" | "digitalWallet" | "domestic" | "international"; biller?: { /** - * BPAY Biller Code of the Biller + * BPAY Biller Code of the Biller. */ billerCode: string; /** - * Name of the Biller + * Name of the Biller. */ billerName: string; /** - * BPAY CRN of the Biller (if available).
Where the CRN contains sensitive information, it should be masked in line with how the Data Holder currently displays account identifiers in their existing online banking channels. If the contents of the CRN match the format of a Credit Card PAN they should be masked according to the rules applicable for MaskedPANString. If the contents are otherwise sensitive, then it should be masked using the rules applicable for the MaskedAccountString common type. + * BPAY CRN of the Biller (if available).
Where the CRN contains sensitive information, it should be masked in line with how the Data Holder currently displays account identifiers in their existing online banking channels. If the contents of the CRN match the format of a Credit Card PAN they should be masked according to the rules applicable for [MaskedPANString](#common-field-types). If the contents are otherwise sensitive, then it should be masked using the rules applicable for the [MaskedAccountString](#common-field-types) common type. */ crn?: string | null; [k: string]: unknown; @@ -539,37 +539,37 @@ export interface BankingPayeeDetailV2 extends BankingPayeeV2 { domestic?: { account?: { /** - * Name of the account to pay to + * Name of the account to pay to. */ accountName?: string | null; /** - * Number of the account to pay to + * Number of the account to pay to. */ accountNumber: string; /** - * BSB of the account to pay to + * BSB of the account to pay to. */ bsb: string; [k: string]: unknown; }; card?: { /** - * Name of the account to pay to + * Name of the account to pay to. */ cardNumber: string; [k: string]: unknown; }; payId?: { /** - * The identifier of the PayID (dependent on type) + * The identifier of the PayID (dependent on type). */ identifier: string; /** - * The name assigned to the PayID by the owner of the PayID + * The name assigned to the PayID by the owner of the PayID. */ name?: string | null; /** - * The type of the PayID + * The type of the PayID. */ type: "ABN" | "EMAIL" | "ORG_IDENTIFIER" | "TELEPHONE"; [k: string]: unknown; @@ -582,19 +582,19 @@ export interface BankingPayeeDetailV2 extends BankingPayeeV2 { }; digitalWallet?: { /** - * The identifier of the digital wallet (dependent on type) + * The identifier of the digital wallet (dependent on type). */ identifier: string; /** - * The name assigned to the digital wallet by the owner of the wallet, else the display name provided by the digital wallet provider + * The display name of the wallet as given by the customer, else a default value defined by the data holder. */ name: string; /** - * The provider of the digital wallet + * The provider of the digital wallet. */ provider: "PAYPAL_AU" | "OTHER"; /** - * The type of the digital wallet identifier + * The type of the digital wallet identifier. */ type: "EMAIL" | "CONTACT_NAME" | "TELEPHONE"; [k: string]: unknown; @@ -602,61 +602,61 @@ export interface BankingPayeeDetailV2 extends BankingPayeeV2 { international?: { bankDetails: { /** - * Account Targeted for payment + * Account Targeted for payment. */ accountNumber: string; bankAddress?: { /** - * Address of the recipient Bank + * Address of the recipient Bank. */ address: string; /** - * Name of the recipient Bank + * Name of the recipient Bank. */ name: string; [k: string]: unknown; } | null; /** - * Swift bank code. Aligns with standard [ISO 9362](https://www.iso.org/standard/60390.html) + * Swift bank code. Aligns with standard [ISO 9362](https://www.iso.org/standard/60390.html). */ beneficiaryBankBIC?: string | null; /** - * Number for the Clearing House Interbank Payments System + * Number for the Clearing House Interbank Payments System. */ chipNumber?: string | null; /** - * Country of the recipient institution. A valid [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html) country code + * Country of the recipient institution. A valid [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html) country code. */ country: string; /** - * Number for Fedwire payment (Federal Reserve Wire Network) + * Number for Fedwire payment (Federal Reserve Wire Network). */ fedWireNumber?: string | null; /** - * The legal entity identifier (LEI) for the beneficiary. Aligns with [ISO 17442](https://www.iso.org/standard/59771.html) + * The legal entity identifier (LEI) for the beneficiary. Aligns with [ISO 17442](https://www.iso.org/standard/59771.html). */ legalEntityIdentifier?: string | null; /** - * International bank routing number + * International bank routing number. */ routingNumber?: string | null; /** - * Sort code used for account identification in some jurisdictions + * Sort code used for account identification in some jurisdictions. */ sortCode?: string | null; [k: string]: unknown; }; beneficiaryDetails: { /** - * Country where the beneficiary resides. A valid [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html) country code + * Country where the beneficiary resides. A valid [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html) country code. */ country: string; /** - * Response message for the payment + * Response message for the payment. */ message?: string | null; /** - * Name of the beneficiary + * Name of the beneficiary. */ name?: string | null; [k: string]: unknown; @@ -669,23 +669,23 @@ export interface BankingPayeeDetailV2 extends BankingPayeeV2 { export interface BankingPayeeV2 { /** - * The date the payee was created by the customer + * The date the payee was created by the customer. */ creationDate?: string | null; /** - * A description of the payee provided by the customer + * A description of the payee provided by the customer. */ description?: string | null; /** - * The short display name of the payee as provided by the customer. Where a customer has not provided a nickname, a display name derived by the bank for the payee consistent with existing digital banking channels + * The short display name of the payee as provided by the customer. Where a customer has not provided a nickname, a display name derived by the bank for the payee consistent with existing digital banking channels. */ nickname: string; /** - * ID of the payee adhering to the rules of ID permanence + * ID of the payee adhering to the rules of ID permanence. */ payeeId: string; /** - * The type of payee.
DOMESTIC means a registered payee for domestic payments including NPP.
INTERNATIONAL means a registered payee for international payments.
BILLER means a registered payee for BPAY.
DIGITAL_WALLET means a registered payee for a bank's digital wallet + * The type of payee.
  • `DOMESTIC` means a registered payee for domestic payments including NPP.
  • `INTERNATIONAL` means a registered payee for international payments.
  • `BILLER` means a registered payee for BPAY.
  • `DIGITAL_WALLET` means a registered payee for a bank's digital wallet.
*/ type: "BILLER" | "DIGITAL_WALLET" | "DOMESTIC" | "INTERNATIONAL"; [k: string]: unknown; @@ -693,11 +693,11 @@ export interface BankingPayeeV2 { /* These are the schema definitions stipulated by the Data Standards Body for the banking api. */ /** - * Object that contains links to additional information on specific topics + * Object that contains links to additional information on specific topics. */ export interface BankingProductAdditionalInformationV2 { /** - * An array of additional bundles for the product, if applicable. To be treated as secondary documents to the `bundleUri`. Only to be used if there is a primary `bundleUri`. + * An array of additional bundles for the product, if applicable. To be treated as secondary documents to the _bundleUri_. Only to be used if there is a primary _bundleUri_. */ additionalBundleUris?: | Array<{ @@ -766,11 +766,11 @@ export interface BankingProductAdditionalInformationV2 { additionalTermsUris?: | Array<{ /** - * The URI describing the additional information + * The URI describing the additional information. */ additionalInfoUri: string; /** - * Display text providing more information about the document URI + * Display text providing more information about the document URI. */ description?: string | null; [k: string]: unknown; @@ -802,11 +802,11 @@ export interface BankingProductAdditionalInformationV2 { export interface BankingProductAdditionalInformationV2AdditionalInformationUris { /** - * The URI describing the additional information + * The URI describing the additional information. */ additionalInfoUri: string; /** - * Display text providing more information about the document URI + * Display text providing more information about the document URI. */ description?: string | null; [k: string]: unknown; @@ -815,23 +815,23 @@ export interface BankingProductAdditionalInformationV2AdditionalInformationUris export interface BankingProductBundle { /** - * Display text providing more information on the bundle + * Display text providing more information on the bundle. */ additionalInfo?: string | null; /** - * Link to a web page with more information on the bundle criteria and benefits + * Link to a web page with more information on the bundle criteria and benefits. */ additionalInfoUri?: string | null; /** - * Description of the bundle + * Description of the bundle. */ description: string; /** - * Name of the bundle + * Name of the bundle. */ name: string; /** - * Array of product IDs for products included in the bundle that are available via the product end points. Note that this array is not intended to represent a comprehensive model of the products included in the bundle and some products available for the bundle may not be available via the product reference end points + * Array of product IDs for products included in the bundle that are available via the product endpoints. Note that this array is not intended to represent a comprehensive model of the products included in the bundle and some products available for the bundle may not be available via the product reference endpoints. */ productIds?: string[] | null; [k: string]: unknown; @@ -839,7 +839,7 @@ export interface BankingProductBundle { /* These are the schema definitions stipulated by the Data Standards Body for the banking api. */ /** - * The category to which a product or account belongs. See [here](#product-categories) for more details + * The category to which a product or account belongs. See [here](#product-categories) for more details. */ export type BankingProductCategory = | "BUSINESS_LOANS" @@ -858,19 +858,19 @@ export type BankingProductCategory = export interface BankingProductConstraint { /** - * Display text providing more information the constraint + * Display text providing more information the constraint. */ additionalInfo?: string | null; /** - * Link to a web page with more information on the constraint + * Link to a web page with more information on the constraint. */ additionalInfoUri?: string | null; /** - * Generic field containing additional information relevant to the [constraintType](#tocSproductconstrainttypedoc) specified. Whether mandatory or not is dependent on the value of [constraintType](#tocSproductconstrainttypedoc) + * Generic field containing additional information relevant to the [_constraintType_](#tocSproductconstrainttypedoc) specified. Whether mandatory or not is dependent on the value of [_constraintType_](#tocSproductconstrainttypedoc). */ additionalValue?: string | null; /** - * The type of constraint described. See the next section for an overview of valid values and their meaning + * The type of constraint described. For further details, refer to [Product Constraint Types](#tocSproductconstrainttypedoc). */ constraintType: "MAX_BALANCE" | "MAX_LIMIT" | "MIN_BALANCE" | "MIN_LIMIT" | "OPENING_BALANCE"; [k: string]: unknown; @@ -879,35 +879,35 @@ export interface BankingProductConstraint { export interface BankingProductDepositRate { /** - * Display text providing more information on the rate + * Display text providing more information on the rate. */ additionalInfo?: string | null; /** - * Link to a web page with more information on this rate + * Link to a web page with more information on this rate. */ additionalInfoUri?: string | null; /** - * Generic field containing additional information relevant to the [depositRateType](#tocSproductdepositratetypedoc) specified. Whether mandatory or not is dependent on the value of [depositRateType](#tocSproductdepositratetypedoc) + * Generic field containing additional information relevant to the [_depositRateType_](#tocSproductdepositratetypedoc) specified. Whether mandatory or not is dependent on the value of [_depositRateType_](#tocSproductdepositratetypedoc). */ additionalValue?: string | null; /** - * The period after which the calculated amount(s) (see calculationFrequency) are 'applied' (i.e. debited or credited) to the account. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) + * The period after which the calculated amount(s) (see _calculationFrequency_) are 'applied' (i.e. debited or credited) to the account. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax). */ applicationFrequency?: string | null; /** - * The period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see applicationFrequency). Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) + * The period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see _applicationFrequency_). Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax). */ calculationFrequency?: string | null; /** - * The type of rate (base, bonus, etc). See the next section for an overview of valid values and their meaning + * The type of rate (`FIXED`, `VARIABLE`, `BONUS`, etc.) For further details, refer to [Product Deposit Rate Types](#tocSproductdepositratetypedoc). */ depositRateType: "BONUS" | "BUNDLE_BONUS" | "FIXED" | "FLOATING" | "INTRODUCTORY" | "MARKET_LINKED" | "VARIABLE"; /** - * The rate to be applied + * The rate to be applied. */ rate: string; /** - * Rate tiers applicable for this rate + * Rate tiers applicable for this rate. */ tiers?: | Array<{ @@ -920,37 +920,37 @@ export interface BankingProductDepositRate { */ additionalInfoUri?: string | null; /** - * Defines a condition for the applicability of a tiered rate + * Defines the criteria and conditions for which a rate applies. */ applicabilityConditions?: { /** - * Display text providing more information on the condition + * Display text providing more information on the rate tier. */ additionalInfo?: string | null; /** - * Link to a web page with more information on this condition + * Link to a web page with more information on this rate tier. */ additionalInfoUri?: string | null; [k: string]: unknown; }; /** - * The number of tierUnitOfMeasure units that form the upper bound of the tier or band. For a tier with a discrete value (as opposed to a range of values e.g. 1 month) this must be the same as tierValueMinimum. Where this is the same as the tierValueMinimum value of the next-higher tier the referenced tier should be exclusive of this value. For example a term deposit of 2 months falls into the upper tier of the following tiers: (1 – 2 months, 2 – 3 months). If absent the tier's range has no upper bound. + * The number of _unitOfMeasure_ units that form the upper bound of the tier or band. For a tier with a discrete value (as opposed to a range of values e.g., 1 month) this must be the same as _minimumValue_. Where this is the same as the _minimumValue_ value of the next-higher tier the referenced tier should be exclusive of this value. For example a term deposit of 2 months falls into the upper tier of the following tiers: (1 – 2 months, 2 – 3 months). If absent the tier's range has no upper bound. */ maximumValue?: number | null; /** - * The number of tierUnitOfMeasure units that form the lower bound of the tier. The tier should be inclusive of this value + * The number of _unitOfMeasure_ units that form the lower bound of the tier. The tier should be inclusive of this value. */ minimumValue: number; /** - * A display name for the tier + * A display name for the tier. */ name: string; /** - * The method used to calculate the amount to be applied using one or more tiers. A single rate may be applied to the entire balance or each applicable tier rate is applied to the portion of the balance that falls into that tier (referred to as 'bands' or 'steps') + * The method used to calculate the amount to be applied using one or more tiers. A single rate may be applied to the entire balance or each applicable tier rate is applied to the portion of the balance that falls into that tier (referred to as 'bands' or 'steps'). */ rateApplicationMethod?: ("PER_TIER" | "WHOLE_BALANCE") | null; /** - * The unit of measure that applies to the tierValueMinimum and tierValueMaximum values e.g. a **DOLLAR** amount. **PERCENT** (in the case of loan-to-value ratio or LVR). Tier term period representing a discrete number of **MONTH**'s or **DAY**'s (in the case of term deposit tiers) + * The unit of measure that applies to the _minimumValue_ and _maximumValue_ values e.g.,
  • `DOLLAR` amount.
  • `PERCENT` (in the case of loan-to-value ratio or LVR).
  • Tier term period representing a discrete number of `MONTH`(s) or `DAY`(s) (in the case of term deposit tiers).
*/ unitOfMeasure: "DAY" | "DOLLAR" | "MONTH" | "PERCENT"; [k: string]: unknown; @@ -966,11 +966,11 @@ export interface BankingProductDetailV4 extends BankingProductV4 { */ bundles?: Array<{ /** - * Display text providing more information on the bundle + * Display text providing more information on the condition. */ additionalInfo?: string | null; /** - * Link to a web page with more information on the bundle criteria and benefits + * Link to a web page with more information on this condition. */ additionalInfoUri?: string | null; /** @@ -1039,7 +1039,7 @@ export interface BankingProductDetailV4 extends BankingProductV4 { [k: string]: unknown; }>; /** - * Constraints on the application for or operation of the product such as minimum balances or limit thresholds + * Constraints on the application for or operation of the product such as minimum balances or limit thresholds. */ constraints?: Array<{ /** @@ -1339,31 +1339,31 @@ export interface BankingProductDetailV4 extends BankingProductV4 { */ additionalInfo?: string | null; /** - * Link to a web page with more information on this rate + * Link to a web page with more information on this rate. */ additionalInfoUri?: string | null; /** - * Generic field containing additional information relevant to the [lendingRateType](#tocSproductlendingratetypedoc) specified. Whether mandatory or not is dependent on the value of [lendingRateType](#tocSproductlendingratetypedoc) + * Generic field containing additional information relevant to the [_lendingRateType_](#tocSproductlendingratetypedoc) specified. Whether mandatory or not is dependent on the value of [_lendingRateType_](#tocSproductlendingratetypedoc). */ additionalValue?: string | null; /** - * The period after which the calculated amount(s) (see calculationFrequency) are 'applied' (i.e. debited or credited) to the account. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) + * The period after which the calculated amount(s) (see _calculationFrequency_) are 'applied' (i.e. debited or credited) to the account. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax). */ applicationFrequency?: string | null; /** - * The period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see applicationFrequency). Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) + * The period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see _applicationFrequency_). Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax). */ calculationFrequency?: string | null; /** - * A comparison rate equivalent for this rate + * A comparison rate equivalent for this rate. */ comparisonRate?: string | null; /** - * When loan payments are due to be paid within each period. The investment benefit of earlier payments affect the rate that can be offered + * When loan payments are due to be paid within each period. The investment benefit of earlier payments affect the rate that can be offered. */ interestPaymentDue?: ("IN_ADVANCE" | "IN_ARREARS") | null; /** - * The type of rate (fixed, variable, etc). See the next section for an overview of valid values and their meaning + * The type of rate (`FIXED`, `VARIABLE`, etc.) For further details, refer to [Product Lending Rate Types](#tocSproductlendingratetypedoc). */ lendingRateType: | "BUNDLE_DISCOUNT_FIXED" @@ -1378,19 +1378,19 @@ export interface BankingProductDetailV4 extends BankingProductV4 { | "PURCHASE" | "VARIABLE"; /** - * The reason for taking out the loan. If absent, the lending rate is applicable to all loan purposes + * The reason for taking out the loan. If absent, the lending rate is applicable to all loan purposes. */ loanPurpose?: ("INVESTMENT" | "OWNER_OCCUPIED") | null; /** - * The rate to be applied + * The rate to be applied. */ rate: string; /** - * Options in place for repayments. If absent, the lending rate is applicable to all repayment types + * Options in place for repayments. If absent, the lending rate is applicable to all repayment types. */ repaymentType?: ("INTEREST_ONLY" | "PRINCIPAL_AND_INTEREST") | null; /** - * Rate tiers applicable for this rate + * Rate tiers applicable for this rate. */ tiers?: | Array<{ @@ -1596,19 +1596,19 @@ export interface BankingProductEligibility { export interface BankingProductFeatureV2 { /** - * Display text providing more information on the feature. Mandatory if the [feature type](#tocSproductfeaturetypedoc) is set to OTHER + * Display text providing more information on the feature. Mandatory if [_featureType_](#tocSproductfeaturetypedoc) is set to `OTHER`. */ additionalInfo?: string | null; /** - * Link to a web page with more information on this feature + * Link to a web page with more information on this feature. */ additionalInfoUri?: string | null; /** - * Generic field containing additional information relevant to the [featureType](#tocSproductfeaturetypedoc) specified. Whether mandatory or not is dependent on the value of the [featureType.](#tocSproductfeaturetypedoc) + * Generic field containing additional information relevant to the [_featureType_](#tocSproductfeaturetypedoc) specified. Whether mandatory or not is dependent on the value of the [_featureType_](#tocSproductfeaturetypedoc). */ additionalValue?: string | null; /** - * The type of feature described + * The type of feature described. For further details, refer to [Product Feature Types](#tocSproductfeaturetypedoc). */ featureType: | "ADDITIONAL_CARDS" @@ -1646,93 +1646,93 @@ export interface BankingProductFeatureV2 { export interface BankingProductFee { /** - * The indicative frequency with which the fee is calculated on the account. Only applies if balanceRate or accruedRate is also present. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) + * The indicative frequency with which the fee is calculated on the account. Only applies if _balanceRate_ or _accruedRate_ is also present. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax). */ accrualFrequency?: string | null; /** - * A fee rate calculated based on a proportion of the calculated interest accrued on the account. One of amount, balanceRate, transactionRate and accruedRate is mandatory unless the *feeType* "VARIABLE" is supplied + * A fee rate calculated based on a proportion of the calculated interest accrued on the account. One of _amount_, _balanceRate_, _transactionRate_ and _accruedRate_ is mandatory unless the _feeType_ `VARIABLE` is supplied. */ accruedRate?: string | null; /** - * Display text providing more information on the fee + * Display text providing more information on the fee. */ additionalInfo?: string | null; /** - * Link to a web page with more information on this fee + * Link to a web page with more information on this fee. */ additionalInfoUri?: string | null; /** - * Generic field containing additional information relevant to the [feeType](#tocSproductfeetypedoc) specified. Whether mandatory or not is dependent on the value of [feeType](#tocSproductfeetypedoc) + * Generic field containing additional information relevant to the [_feeType_](#tocSproductfeetypedoc) specified. Whether mandatory or not is dependent on the value of [_feeType_](#tocSproductfeetypedoc). */ additionalValue?: string | null; /** - * The amount charged for the fee. One of amount, balanceRate, transactionRate and accruedRate is mandatory unless the *feeType* "VARIABLE" is supplied + * The amount charged for the fee. One of _amount_, _balanceRate_, _transactionRate_ and _accruedRate_ is mandatory unless the _feeType_ `VARIABLE` is supplied. */ amount?: string | null; /** - * A fee rate calculated based on a proportion of the balance. One of amount, balanceRate, transactionRate and accruedRate is mandatory unless the *feeType* "VARIABLE" is supplied. + * A fee rate calculated based on a proportion of the balance. One of _amount_, _balanceRate_, _transactionRate_ and _accruedRate_ is mandatory unless the _feeType_ `VARIABLE` is supplied. */ balanceRate?: string | null; /** - * The currency the fee will be charged in. Assumes AUD if absent + * The currency the fee will be charged in. Assumes `AUD` if absent. */ currency?: string | null; /** - * An optional list of discounts to this fee that may be available + * An optional list of discounts to this fee that may be available. */ discounts?: | Array<{ /** - * A discount rate calculated based on a proportion of the calculated interest accrued on the account. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory. Unless noted in additionalInfo, assumes the application and calculation frequency are the same as the corresponding fee + * A discount rate calculated based on a proportion of the calculated interest accrued on the account. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of _amount_, _balanceRate_, _transactionRate_, _accruedRate_ and _feeRate_ is mandatory. Unless noted in _additionalInfo_, assumes the application and calculation frequency are the same as the corresponding fee. */ accruedRate?: string | null; /** - * Display text providing more information on the discount + * Display text providing more information on the discount. */ additionalInfo?: string | null; /** - * Link to a web page with more information on this discount + * Link to a web page with more information on this discount. */ additionalInfoUri?: string | null; /** - * Generic field containing additional information relevant to the [discountType](#tocSproductdiscounttypedoc) specified. Whether mandatory or not is dependent on the value of [discountType](#tocSproductdiscounttypedoc) + * Generic field containing additional information relevant to the [_discountType_](#tocSproductdiscounttypedoc) specified. Whether mandatory or not is dependent on the value of [_discountType_](#tocSproductdiscounttypedoc). */ additionalValue?: string | null; /** - * Dollar value of the discount. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory. + * Dollar value of the discount. One of _amount_, _balanceRate_, _transactionRate_, _accruedRate_ and _feeRate_ is mandatory. */ amount?: string | null; /** - * A discount rate calculated based on a proportion of the balance. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory. Unless noted in additionalInfo, assumes the application and calculation frequency are the same as the corresponding fee + * A discount rate calculated based on a proportion of the balance. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of _amount_, _balanceRate_, _transactionRate_, _accruedRate_ and _feeRate_ is mandatory. Unless noted in _additionalInfo_, assumes the application and calculation frequency are the same as the corresponding fee. */ balanceRate?: string | null; /** - * Description of the discount + * Description of the discount. */ description: string; /** - * The type of discount. See the next section for an overview of valid values and their meaning + * The type of discount. For further details, refer to [Product Discount Types](#tocSproductdiscounttypedoc). */ discountType: "BALANCE" | "DEPOSITS" | "ELIGIBILITY_ONLY" | "FEE_CAP" | "PAYMENTS"; /** - * Eligibility constraints that apply to this discount. Mandatory if ``discountType`` is ``ELIGIBILITY_ONLY``. + * Eligibility constraints that apply to this discount. Mandatory if _discountType_ is `ELIGIBILITY_ONLY`. */ eligibility?: | Array<{ /** - * Display text providing more information on this eligibility constraint. Whether mandatory or not is dependent on the value of [discountEligibilityType](#tocSproductdiscounteligibilitydoc) + * Display text providing more information on this eligibility constraint. Whether mandatory or not is dependent on the value of [_discountEligibilityType_](#tocSproductdiscounteligibilitydoc). */ additionalInfo?: string | null; /** - * Link to a web page with more information on this eligibility constraint + * Link to a web page with more information on this eligibility constraint. */ additionalInfoUri?: string | null; /** - * Generic field containing additional information relevant to the [discountEligibilityType](#tocSproductdiscounteligibilitydoc) specified. Whether mandatory or not is dependent on the value of [discountEligibilityType](#tocSproductdiscounteligibilitydoc) + * Generic field containing additional information relevant to the [_discountEligibilityType_](#tocSproductdiscounteligibilitydoc) specified. Whether mandatory or not is dependent on the value of [_discountEligibilityType_](#tocSproductdiscounteligibilitydoc). */ additionalValue?: string | null; /** - * The type of the specific eligibility constraint for a discount + * The type of the specific eligibility constraint for a discount. For further details, refer to [Product Discount Eligibility Types](#tocSproductdiscounteligibilitydoc). */ discountEligibilityType: | "BUSINESS" @@ -1752,11 +1752,11 @@ export interface BankingProductFee { }> | null; /** - * A discount rate calculated based on a proportion of the fee to which this discount is attached. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory. Unless noted in additionalInfo, assumes the application and calculation frequency are the same as the corresponding fee + * A discount rate calculated based on a proportion of the fee to which this discount is attached. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of _amount_, _balanceRate_, _transactionRate_, _accruedRate_ and _feeRate_ is mandatory. Unless noted in _additionalInfo_, assumes the application and calculation frequency are the same as the corresponding fee. */ feeRate?: string | null; /** - * A discount rate calculated based on a proportion of a transaction. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory + * A discount rate calculated based on a proportion of a transaction. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of _amount_, _balanceRate_, _transactionRate_, _accruedRate_ and _feeRate_ is mandatory. */ transactionRate?: string | null; [k: string]: unknown; @@ -1777,11 +1777,11 @@ export interface BankingProductFee { | "VARIABLE" | "WITHDRAWAL"; /** - * Name of the fee + * Name of the fee. */ name: string; /** - * A fee rate calculated based on a proportion of a transaction. One of amount, balanceRate, transactionRate and accruedRate is mandatory unless the *feeType* "VARIABLE" is supplied + * A fee rate calculated based on a proportion of a transaction. One of _amount_, _balanceRate_, _transactionRate_ and _accruedRate_ is mandatory unless the _feeType_ `VARIABLE` is supplied. */ transactionRate?: string | null; [k: string]: unknown; @@ -1794,31 +1794,31 @@ export interface BankingProductLendingRateV2 { */ additionalInfo?: string | null; /** - * Link to a web page with more information on this rate + * Link to a web page with more information on this rate. */ additionalInfoUri?: string | null; /** - * Generic field containing additional information relevant to the [lendingRateType](#tocSproductlendingratetypedoc) specified. Whether mandatory or not is dependent on the value of [lendingRateType](#tocSproductlendingratetypedoc) + * Generic field containing additional information relevant to the [_lendingRateType_](#tocSproductlendingratetypedoc) specified. Whether mandatory or not is dependent on the value of [_lendingRateType_](#tocSproductlendingratetypedoc). */ additionalValue?: string | null; /** - * The period after which the calculated amount(s) (see calculationFrequency) are 'applied' (i.e. debited or credited) to the account. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) + * The period after which the calculated amount(s) (see _calculationFrequency_) are 'applied' (i.e. debited or credited) to the account. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax). */ applicationFrequency?: string | null; /** - * The period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see applicationFrequency). Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) + * The period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see _applicationFrequency_). Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax). */ calculationFrequency?: string | null; /** - * A comparison rate equivalent for this rate + * A comparison rate equivalent for this rate. */ comparisonRate?: string | null; /** - * When loan payments are due to be paid within each period. The investment benefit of earlier payments affect the rate that can be offered + * When loan payments are due to be paid within each period. The investment benefit of earlier payments affect the rate that can be offered. */ interestPaymentDue?: ("IN_ADVANCE" | "IN_ARREARS") | null; /** - * The type of rate (fixed, variable, etc). See the next section for an overview of valid values and their meaning + * The type of rate (`FIXED`, `VARIABLE`, etc.) For further details, refer to [Product Lending Rate Types](#tocSproductlendingratetypedoc). */ lendingRateType: | "BUNDLE_DISCOUNT_FIXED" @@ -1833,19 +1833,19 @@ export interface BankingProductLendingRateV2 { | "PURCHASE" | "VARIABLE"; /** - * The reason for taking out the loan. If absent, the lending rate is applicable to all loan purposes + * The reason for taking out the loan. If absent, the lending rate is applicable to all loan purposes. */ loanPurpose?: ("INVESTMENT" | "OWNER_OCCUPIED") | null; /** - * The rate to be applied + * The rate to be applied. */ rate: string; /** - * Options in place for repayments. If absent, the lending rate is applicable to all repayment types + * Options in place for repayments. If absent, the lending rate is applicable to all repayment types. */ repaymentType?: ("INTEREST_ONLY" | "PRINCIPAL_AND_INTEREST") | null; /** - * Rate tiers applicable for this rate + * Rate tiers applicable for this rate. */ tiers?: | Array<{ @@ -1872,23 +1872,23 @@ export interface BankingProductLendingRateV2 { [k: string]: unknown; }; /** - * The number of tierUnitOfMeasure units that form the upper bound of the tier or band. For a tier with a discrete value (as opposed to a range of values e.g. 1 month) this must be the same as tierValueMinimum. Where this is the same as the tierValueMinimum value of the next-higher tier the referenced tier should be exclusive of this value. For example a term deposit of 2 months falls into the upper tier of the following tiers: (1 – 2 months, 2 – 3 months). If absent the tier's range has no upper bound. + * The number of _unitOfMeasure_ units that form the upper bound of the tier or band. For a tier with a discrete value (as opposed to a range of values e.g., 1 month) this must be the same as _minimumValue_. Where this is the same as the _minimumValue_ value of the next-higher tier the referenced tier should be exclusive of this value. For example a term deposit of 2 months falls into the upper tier of the following tiers: (1 – 2 months, 2 – 3 months). If absent the tier's range has no upper bound. */ maximumValue?: number | null; /** - * The number of tierUnitOfMeasure units that form the lower bound of the tier. The tier should be inclusive of this value + * The number of _unitOfMeasure_ units that form the lower bound of the tier. The tier should be inclusive of this value. */ minimumValue: number; /** - * A display name for the tier + * A display name for the tier. */ name: string; /** - * The method used to calculate the amount to be applied using one or more tiers. A single rate may be applied to the entire balance or each applicable tier rate is applied to the portion of the balance that falls into that tier (referred to as 'bands' or 'steps') + * The method used to calculate the amount to be applied using one or more tiers. A single rate may be applied to the entire balance or each applicable tier rate is applied to the portion of the balance that falls into that tier (referred to as 'bands' or 'steps'). */ rateApplicationMethod?: ("PER_TIER" | "WHOLE_BALANCE") | null; /** - * The unit of measure that applies to the tierValueMinimum and tierValueMaximum values e.g. a **DOLLAR** amount. **PERCENT** (in the case of loan-to-value ratio or LVR). Tier term period representing a discrete number of **MONTH**'s or **DAY**'s (in the case of term deposit tiers) + * The unit of measure that applies to the _minimumValue_ and _maximumValue_ values e.g.,
  • `DOLLAR` amount.
  • `PERCENT` (in the case of loan-to-value ratio or LVR).
  • Tier term period representing a discrete number of `MONTH`(s) or `DAY`(s) (in the case of term deposit tiers).
*/ unitOfMeasure: "DAY" | "DOLLAR" | "MONTH" | "PERCENT"; [k: string]: unknown; @@ -1899,15 +1899,15 @@ export interface BankingProductLendingRateV2 { /* These are the schema definitions stipulated by the Data Standards Body for the banking api. */ /** - * Defines a condition for the applicability of a tiered rate + * Defines a condition for the applicability of a tiered rate. */ export interface BankingProductRateCondition { /** - * Display text providing more information on the condition + * Display text providing more information on the condition. */ additionalInfo?: string | null; /** - * Link to a web page with more information on this condition + * Link to a web page with more information on this condition. */ additionalInfoUri?: string | null; [k: string]: unknown; @@ -1915,15 +1915,15 @@ export interface BankingProductRateCondition { /* These are the schema definitions stipulated by the Data Standards Body for the banking api. */ /** - * Defines the criteria and conditions for which a rate applies + * Defines a condition for the applicability of a tiered rate. */ export interface BankingProductRateTierV3 { /** - * Display text providing more information on the rate tier. + * Display text providing more information on the condition. */ additionalInfo?: string | null; /** - * Link to a web page with more information on this rate tier + * Link to a web page with more information on this condition. */ additionalInfoUri?: string | null; /** @@ -1931,33 +1931,33 @@ export interface BankingProductRateTierV3 { */ applicabilityConditions?: { /** - * Display text providing more information on the condition + * Display text providing more information on the rate tier. */ additionalInfo?: string | null; /** - * Link to a web page with more information on this condition + * Link to a web page with more information on this rate tier. */ additionalInfoUri?: string | null; [k: string]: unknown; }; /** - * The number of unitOfMeasure units that form the upper bound of the tier or band. For a tier with a discrete value (as opposed to a range of values e.g. 1 month) this must be the same as minimumValue. Where this is the same as the minimumValue value of the next-higher tier the referenced tier should be exclusive of this value. For example a term deposit of 2 months falls into the upper tier of the following tiers: (1 – 2 months, 2 – 3 months). If absent the tier's range has no upper bound. + * The number of _unitOfMeasure_ units that form the upper bound of the tier or band. For a tier with a discrete value (as opposed to a range of values e.g., 1 month) this must be the same as _minimumValue_. Where this is the same as the _minimumValue_ value of the next-higher tier the referenced tier should be exclusive of this value. For example a term deposit of 2 months falls into the upper tier of the following tiers: (1 – 2 months, 2 – 3 months). If absent the tier's range has no upper bound. */ maximumValue?: number | null; /** - * The number of unitOfMeasure units that form the lower bound of the tier. The tier should be inclusive of this value + * The number of _unitOfMeasure_ units that form the lower bound of the tier. The tier should be inclusive of this value. */ minimumValue: number; /** - * A display name for the tier + * A display name for the tier. */ name: string; /** - * The method used to calculate the amount to be applied using one or more tiers. A single rate may be applied to the entire balance or each applicable tier rate is applied to the portion of the balance that falls into that tier (referred to as 'bands' or 'steps') + * The method used to calculate the amount to be applied using one or more tiers. A single rate may be applied to the entire balance or each applicable tier rate is applied to the portion of the balance that falls into that tier (referred to as 'bands' or 'steps'). */ rateApplicationMethod?: ("PER_TIER" | "WHOLE_BALANCE") | null; /** - * The unit of measure that applies to the minimumValue and maximumValue values e.g. a **DOLLAR** amount. **PERCENT** (in the case of loan-to-value ratio or LVR). Tier term period representing a discrete number of **MONTH**'s or **DAY**'s (in the case of term deposit tiers) + * The unit of measure that applies to the _minimumValue_ and _maximumValue_ values e.g.,
  • `DOLLAR` amount.
  • `PERCENT` (in the case of loan-to-value ratio or LVR).
  • Tier term period representing a discrete number of `MONTH`(s) or `DAY`(s) (in the case of term deposit tiers).
*/ unitOfMeasure: "DAY" | "DOLLAR" | "MONTH" | "PERCENT"; [k: string]: unknown; @@ -2076,55 +2076,55 @@ export interface BankingProductV4 { */ applicationUri?: string | null; /** - * A label of the brand for the product. Able to be used for filtering. For data holders with single brands this value is still required + * A label of the brand for the product. Able to be used for filtering. For data holders with single brands this value is still required. */ brand: string; /** - * An optional display name of the brand + * An optional display name of the brand. */ brandName?: string | null; /** - * An array of card art images + * An array of card art images. */ cardArt?: | Array<{ /** - * URI reference to a PNG, JPG or GIF image with proportions defined by ISO 7810 ID-1 and width no greater than 512 pixels. The URI reference may be a link or url-encoded data URI according to **[[RFC2397]](#nref-RFC2397)** + * URI reference to a PNG, JPG or GIF image with proportions defined by ISO 7810 ID-1 and width no greater than 512 pixels. The URI reference may be a link or url-encoded data URI according to **[[RFC2397]](#nref-RFC2397)**. */ imageUri: string; /** - * Display label for the specific image + * Display label for the specific image. */ title?: string; [k: string]: unknown; }> | null; /** - * A description of the product + * A description of the product. */ description: string; /** - * The date and time from which this product is effective (ie. is available for origination). Used to enable the articulation of products to the regime before they are available for customers to originate + * The date and time from which this product is effective (i.e. is available for origination). Used to enable the articulation of products to the regime before they are available for customers to originate. */ effectiveFrom?: string | null; /** - * The date and time at which this product will be retired and will no longer be offered. Used to enable the managed deprecation of products + * The date and time at which this product will be retired and will no longer be offered. Used to enable the managed deprecation of products. */ effectiveTo?: string | null; /** - * Indicates whether the product is specifically tailored to a circumstance. In this case fees and prices are significantly negotiated depending on context. While all products are open to a degree of tailoring this flag indicates that tailoring is expected and thus that the provision of specific fees and rates is not applicable + * Indicates whether the product is specifically tailored to a circumstance. In this case fees and prices are significantly negotiated depending on context. While all products are open to a degree of tailoring this flag indicates that tailoring is expected and thus that the provision of specific fees and rates is not applicable. */ isTailored: boolean; /** - * The last date and time that the information for this product was changed (or the creation date for the product if it has never been altered) + * The last date and time that the information for this product was changed (or the creation date for the product if it has never been altered). */ lastUpdated: string; /** - * The display name of the product + * The display name of the product. */ name: string; /** - * The category to which a product or account belongs. See [here](#product-categories) for more details + * The category to which a product or account belongs. See [here](#product-categories) for more details. */ productCategory: | "BUSINESS_LOANS" @@ -2217,11 +2217,11 @@ export interface BankingScheduledPaymentV2 { /* These are the schema definitions stipulated by the Data Standards Body for the banking api. */ /** - * Object containing details of the source of the payment. Currently only specifies an account ID but provided as an object to facilitate future extensibility and consistency with the to object + * Object containing details of the source of the payment. Currently only specifies an account ID but provided as an object to facilitate future extensibility and consistency with the _to_ object. */ export interface BankingScheduledPaymentFrom { /** - * ID of the account that is the source of funds for the payment + * ID of the account that is the source of funds for the payment. */ accountId: string; [k: string]: unknown; @@ -2230,11 +2230,11 @@ export interface BankingScheduledPaymentFrom { export interface BankingScheduledPaymentInterval { /** - * Uses an interval to define the ordinal day within the interval defined by the interval field on which the payment occurs. If the resulting duration is 0 days in length or larger than the number of days in the interval then the payment will occur on the last day of the interval. A duration of 1 day indicates the first day of the interval. If absent the assumed value is P1D. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) with components less than a day in length ignored. The first day of a week is considered to be Monday. + * Uses an interval to define the ordinal day within the interval defined by the interval field on which the payment occurs. If the resulting duration is 0 days in length or larger than the number of days in the interval then the payment will occur on the last day of the interval. A duration of 1 day indicates the first day of the interval. If absent the assumed value is `P1D`. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) with components less than a day in length ignored. The first day of a week is considered to be Monday. */ dayInInterval?: string | null; /** - * An interval for the payment. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) with components less than a day in length ignored. This duration defines the period between payments starting with nextPaymentDate + * An interval for the payment. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) with components less than a day in length ignored. This duration defines the period between payments starting with _nextPaymentDate_. */ interval: string; [k: string]: unknown; @@ -2242,7 +2242,7 @@ export interface BankingScheduledPaymentInterval { /* These are the schema definitions stipulated by the Data Standards Body for the banking api. */ /** - * Object containing the detail of the schedule for the payment + * Object containing the detail of the schedule for the payment. */ export interface BankingScheduledPaymentRecurrence { /** @@ -2258,7 +2258,7 @@ export interface BankingScheduledPaymentRecurrence { */ lastWeekDay?: BankingScheduledPaymentRecurrenceLastWeekday; /** - * The date of the next payment under the recurrence schedule + * The date of the next payment under the recurrence schedule. */ nextPaymentDate?: string | null; /** @@ -2266,7 +2266,7 @@ export interface BankingScheduledPaymentRecurrence { */ onceOff?: BankingScheduledPaymentRecurrenceOnceOff; /** - * The type of recurrence used to define the schedule + * The type of recurrence used to define the schedule. */ recurrenceUType: "eventBased" | "intervalSchedule" | "lastWeekDay" | "onceOff"; [k: string]: unknown; @@ -2274,11 +2274,11 @@ export interface BankingScheduledPaymentRecurrence { /* These are the schema definitions stipulated by the Data Standards Body for the banking api. */ /** - * Indicates that the schedule of payments is defined according to an external event that cannot be predetermined. Mandatory if recurrenceUType is set to eventBased + * Indicates that the schedule of payments is defined according to an external event that cannot be predetermined. Mandatory if _recurrenceUType_ is set to `eventBased`. */ export interface BankingScheduledPaymentRecurrenceEventBased { /** - * Description of the event and conditions that will result in the payment. Expected to be formatted for display to a customer + * Description of the event and conditions that will result in the payment. Expected to be formatted for display to a customer. */ description: string; [k: string]: unknown; @@ -2286,15 +2286,15 @@ export interface BankingScheduledPaymentRecurrenceEventBased { /* These are the schema definitions stipulated by the Data Standards Body for the banking api. */ /** - * Indicates that the schedule of payments is defined by a series of intervals. Mandatory if recurrenceUType is set to intervalSchedule + * Indicates that the schedule of payments is defined by a series of intervals. Mandatory if _recurrenceUType_ is set to `intervalSchedule`. */ export interface BankingScheduledPaymentRecurrenceIntervalSchedule { /** - * The limit date after which no more payments should be made using this schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely + * The limit date after which no more payments should be made using this schedule. If both _finalPaymentDate_ and _paymentsRemaining_ are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely. */ finalPaymentDate?: string | null; /** - * An array of interval objects defining the payment schedule. Each entry in the array is additive, in that it adds payments to the overall payment schedule. If multiple intervals result in a payment on the same day then only one payment will be made. Must have at least one entry + * An array of interval objects defining the payment schedule. Each entry in the array is additive, in that it adds payments to the overall payment schedule. If multiple intervals result in a payment on the same day then only one payment will be made. Must have at least one entry. */ intervals: Array<{ /** @@ -2320,15 +2320,15 @@ export interface BankingScheduledPaymentRecurrenceIntervalSchedule { /* These are the schema definitions stipulated by the Data Standards Body for the banking api. */ /** - * Indicates that the schedule of payments is defined according to the last occurrence of a specific weekday in an interval. Mandatory if recurrenceUType is set to lastWeekDay + * Indicates that the schedule of payments is defined according to the last occurrence of a specific weekday in an interval. Mandatory if _recurrenceUType_ is set to `lastWeekDay`. */ export interface BankingScheduledPaymentRecurrenceLastWeekday { /** - * The limit date after which no more payments should be made using this schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely + * The limit date after which no more payments should be made using this schedule. If both _finalPaymentDate_ and _paymentsRemaining_ are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely. */ finalPaymentDate?: string | null; /** - * The interval for the payment. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) with components less than a day in length ignored. This duration defines the period between payments starting with nextPaymentDate + * The interval for the payment. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) with components less than a day in length ignored. This duration defines the period between payments starting with _nextPaymentDate_. */ interval: string; /** @@ -2336,11 +2336,11 @@ export interface BankingScheduledPaymentRecurrenceLastWeekday { */ lastWeekDay: "FRI" | "MON" | "SAT" | "SUN" | "THU" | "TUE" | "WED"; /** - * Enumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be ON.
**AFTER** - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.
**BEFORE** - If a scheduled payment date is a non-business day the payment will be made on the first business day before the scheduled payment date.
**ON** - If a scheduled payment date is a non-business day the payment will be made on that day regardless.
**ONLY** - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored + * Enumerated field giving the treatment where a scheduled payment date is not a business day. If absent assumed to be `ON`.
  • `AFTER` - If a scheduled payment date is a non-business day the payment will be made on the first business day after the scheduled payment date.
  • `BEFORE` - If a scheduled payment date is a non-business day the payment will be made on the first business day before the scheduled payment date.
  • `ON` - If a scheduled payment date is a non-business day the payment will be made on that day regardless.
  • `ONLY` - Payments only occur on business days. If a scheduled payment date is a non-business day the payment will be ignored.
*/ nonBusinessDayTreatment?: ("AFTER" | "BEFORE" | "ON" | "ONLY") | null; /** - * Indicates the number of payments remaining in the schedule. If both finalPaymentDate and paymentsRemaining are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely + * Indicates the number of payments remaining in the schedule. If both _finalPaymentDate_ and _paymentsRemaining_ are present then payments will stop according to the most constraining value. If neither field is present the payments will continue indefinitely. */ paymentsRemaining?: number | null; [k: string]: unknown; @@ -2348,11 +2348,11 @@ export interface BankingScheduledPaymentRecurrenceLastWeekday { /* These are the schema definitions stipulated by the Data Standards Body for the banking api. */ /** - * Indicates that the payment is a once off payment on a specific future date. Mandatory if recurrenceUType is set to onceOff + * Indicates that the payment is a once off payment on a specific future date. Mandatory if _recurrenceUType_ is set to `onceOff`. */ export interface BankingScheduledPaymentRecurrenceOnceOff { /** - * The scheduled date for the once off payment + * The scheduled date for the once off payment. */ paymentDate: string; [k: string]: unknown; @@ -2360,7 +2360,7 @@ export interface BankingScheduledPaymentRecurrenceOnceOff { /* These are the schema definitions stipulated by the Data Standards Body for the banking api. */ /** - * The set of payment amounts and destination accounts for this payment accommodating multi-part payments. A single entry indicates a simple payment with one destination account. Must have at least one entry + * Indicates that the schedule of payments is defined according to an external event that cannot be predetermined. Mandatory if _recurrenceUType_ is set to `eventBased`. */ export interface BankingScheduledPaymentSet { /** @@ -2368,7 +2368,7 @@ export interface BankingScheduledPaymentSet { */ amount?: string | null; /** - * The currency for the payment. AUD assumed if not present + * The currency for the payment. `AUD` assumed if not present */ currency?: string | null; /** @@ -2558,11 +2558,11 @@ export interface BankingScheduledPaymentTo { } /** - * Object containing details of the destination of the payment. Used to specify a variety of payment destination types + * Object containing details of the destination of the payment. Used to specify a variety of payment destination types. */ export interface BankingScheduledPaymentToV2 { /** - * Present if toUType is set to accountId. Indicates that the payment is to another account that is accessible under the current consent + * Present if _toUType_ is set to `accountId`. Indicates that the payment is to another account that is accessible under the current consent. */ accountId?: string | null; biller?: { @@ -2708,11 +2708,11 @@ export interface BankingScheduledPaymentToV2 { [k: string]: unknown; }; /** - * The short display name of the payee as provided by the customer unless toUType is set to payeeId. Where a customer has not provided a nickname, a display name derived by the bank for payee should be provided that is consistent with existing digital banking channels + * The short display name of the payee as provided by the customer unless _toUType_ is set to `payeeId`. Where a customer has not provided a nickname, a display name derived by the bank for payee should be provided that is consistent with existing digital banking channels. */ nickname?: string | null; /** - * Present if toUType is set to payeeId. Indicates that the payment is to registered payee that can be accessed using the payee end point. If the Bank Payees scope has not been consented to then a payeeId should not be provided and the full payee details should be provided instead + * Present if _toUType_ is set to `payeeId`. Indicates that the payment is to registered payee that can be accessed using the payee endpoint. If the Bank Payees scope has not been consented to then a _payeeId_ should not be provided and the full payee details should be provided instead. */ payeeId?: string | null; /** @@ -2729,23 +2729,23 @@ export interface BankingScheduledPaymentToV2 { export interface BankingTermDepositAccount { /** - * The lodgement date of the original deposit + * The lodgement date of the original deposit. */ lodgementDate: string; /** - * Amount to be paid upon maturity. If absent it implies the amount to paid is variable and cannot currently be calculated + * Amount to be paid upon maturity. If absent it implies the amount to paid is variable and cannot currently be calculated. */ maturityAmount?: string | null; /** - * If absent assumes AUD + * If absent assumes `AUD`. */ maturityCurrency?: string | null; /** - * Maturity date for the term deposit + * Maturity date for the term deposit. */ maturityDate: string; /** - * Current instructions on action to be taken at maturity. This includes default actions that may be specified in the terms and conditions for the product e.g. roll-over to the same term and frequency of interest payments + * Current instructions on action to be taken at maturity. This includes default actions that may be specified in the terms and conditions for the product e.g., roll-over to the same term and frequency of interest payments. */ maturityInstructions: "HOLD_ON_MATURITY" | "PAID_OUT_AT_MATURITY" | "ROLLED_OVER"; [k: string]: unknown; @@ -2754,11 +2754,11 @@ export interface BankingTermDepositAccount { export interface BankingTransaction { /** - * ID of the account for which transactions are provided + * ID of the account for which transactions are provided. */ accountId: string; /** - * The value of the transaction. Negative values mean money was outgoing from the account + * The value of the transaction. Negative values mean money was outgoing from the account. */ amount: string; /** @@ -2766,59 +2766,59 @@ export interface BankingTransaction { */ apcaNumber?: string | null; /** - * BPAY Biller Code for the transaction (if available) + * BPAY Biller Code for the transaction (if available). */ billerCode?: string | null; /** - * Name of the BPAY biller for the transaction (if available) + * Name of the BPAY biller for the transaction (if available). */ billerName?: string | null; /** - * BPAY CRN for the transaction (if available).
Where the CRN contains sensitive information, it should be masked in line with how the Data Holder currently displays account identifiers in their existing online banking channels. If the contents of the CRN match the format of a Credit Card PAN they should be masked according to the rules applicable for MaskedPANString. If the contents are are otherwise sensitive, then it should be masked using the rules applicable for the MaskedAccountString common type. + * BPAY CRN for the transaction (if available).
Where the CRN contains sensitive information, it should be masked in line with how the Data Holder currently displays account identifiers in their existing online banking channels. If the contents of the CRN match the format of a Credit Card PAN they should be masked according to the rules applicable for [MaskedPANString](#common-field-types). If the contents are otherwise sensitive, then it should be masked using the rules applicable for the [MaskedAccountString](#common-field-types) common type. */ crn?: string | null; /** - * The currency for the transaction amount. AUD assumed if not present + * The currency for the transaction amount. `AUD` assumed if not present. */ currency?: string | null; /** - * The transaction description as applied by the financial institution + * The transaction description as applied by the financial institution. */ description: string; /** - * The time the transaction was executed by the originating customer, if available + * The time the transaction was executed by the originating customer, if available. */ executionDateTime?: string | null; /** - * True if extended information is available using the transaction detail end point. False if extended data is not available + * `true` if extended information is available using the transaction detail endpoint. `false` if extended data is not available. */ isDetailAvailable: boolean; /** - * The merchant category code (or MCC) for an outgoing payment to a merchant + * The merchant category code (or MCC) for an outgoing payment to a merchant. */ merchantCategoryCode?: string | null; /** - * Name of the merchant for an outgoing payment to a merchant + * Name of the merchant for an outgoing payment to a merchant. */ merchantName?: string | null; /** - * The time the transaction was posted. This field is Mandatory if the transaction has status POSTED. This is the time that appears on a standard statement + * The time the transaction was posted. This field is Mandatory if the transaction has status `POSTED`. This is the time that appears on a standard statement. */ postingDateTime?: string | null; /** - * The reference for the transaction provided by the originating institution. Empty string if no data provided + * The reference for the transaction provided by the originating institution. Empty string if no data provided. */ reference: string; /** - * Status of the transaction whether pending or posted. Note that there is currently no provision in the standards to guarantee the ability to correlate a pending transaction with an associated posted transaction + * Status of the transaction whether pending or posted. Note that there is currently no provision in the standards to guarantee the ability to correlate a pending transaction with an associated posted transaction. */ status: "PENDING" | "POSTED"; /** - * A unique ID of the transaction adhering to the standards for ID permanence. This is mandatory (through hashing if necessary) unless there are specific and justifiable technical reasons why a transaction cannot be uniquely identified for a particular account type. It is mandatory if `isDetailAvailable` is set to true. + * A unique ID of the transaction adhering to the standards for ID permanence. This is mandatory (through hashing if necessary) unless there are specific and justifiable technical reasons why a transaction cannot be uniquely identified for a particular account type. It is mandatory if _isDetailAvailable_ is set to `true`. */ transactionId?: string | null; /** - * The type of the transaction + * The type of the transaction. */ type: | "DIRECT_DEBIT" @@ -2830,7 +2830,7 @@ export interface BankingTransaction { | "TRANSFER_INCOMING" | "TRANSFER_OUTGOING"; /** - * Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit transaction entry + * Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit transaction entry. */ valueDateTime?: string | null; [k: string]: unknown; @@ -2840,34 +2840,34 @@ export interface BankingTransaction { export interface BankingTransactionDetail extends BankingTransaction { extendedData: { /** - * Label of the originating payer. Mandatory for inbound payment + * Label of the originating payer. Mandatory for inbound payment. */ payer?: string; /** - * Label of the target PayID. Mandatory for an outbound payment. The name assigned to the BSB/Account Number or PayID (by the owner of the PayID) + * Label of the target PayID. Mandatory for an outbound payment. The name assigned to the BSB/Account Number or PayID (by the owner of the PayID). */ payee?: string; /** - * Optional extended data provided specific to transaction originated via NPP + * Optional extended data specific to transactions originated via NPP. */ extensionUType?: "x2p101Payload"; x2p101Payload?: { /** - * An extended string description. Only present if specified by the extensionUType field + * An extended string description. Required if the _extensionUType_ field is `x2p101Payload`. */ extendedDescription: string; /** - * An end to end ID for the payment created at initiation + * An end to end ID for the payment created at initiation. */ endToEndId?: string; /** - * Purpose of the payment. Format is defined by NPP standards for the x2p1.01 overlay service + * Purpose of the payment. Format is defined by NPP standards for the x2p1.01 overlay service. */ purposeCode?: string; [k: string]: unknown; }; /** - * Identifier of the applicable overlay service. Valid values are: X2P1.01 + * Identifier of the applicable overlay service. Valid values are: `X2P1.01`. */ service: "X2P1.01"; [k: string]: unknown; @@ -2877,95 +2877,95 @@ export interface BankingTransactionDetail extends BankingTransaction { /* These are the schema definitions stipulated by the Data Standards Body for the banking api. */ /** - * Australian address formatted according to the file format defined by the [PAF file format](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf) + * Australian address formatted according to the file format defined by the [PAF file format](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf). */ export interface CommonPAFAddress { /** - * Building/Property name 1 + * Building/Property name 1. */ buildingName1?: string | null; /** - * Building/Property name 2 + * Building/Property name 2. */ buildingName2?: string | null; /** - * Unique identifier for an address as defined by Australia Post. Also known as Delivery Point Identifier + * Unique identifier for an address as defined by Australia Post. Also known as Delivery Point Identifier. */ dpid?: string | null; /** - * Unit number (including suffix, if applicable) + * Unit number (including suffix, if applicable). */ flatUnitNumber?: string | null; /** - * Type of flat or unit for the address + * Type of flat or unit for the address. */ flatUnitType?: string | null; /** - * Floor or level number (including alpha characters) + * Floor or level number (including alpha characters). */ floorLevelNumber?: string | null; /** - * Type of floor or level for the address + * Type of floor or level for the address. */ floorLevelType?: string | null; /** - * Full name of locality + * Full name of locality. */ localityName: string; /** - * Allotment number for the address + * Allotment number for the address. */ lotNumber?: string | null; /** - * Postal delivery number if the address is a postal delivery type + * Postal delivery number if the address is a postal delivery type. */ postalDeliveryNumber?: number | null; /** - * Postal delivery number prefix related to the postal delivery number + * Postal delivery number prefix related to the postal delivery number. */ postalDeliveryNumberPrefix?: string | null; /** - * Postal delivery number suffix related to the postal delivery number + * Postal delivery number suffix related to the postal delivery number. */ postalDeliveryNumberSuffix?: string | null; /** - * Postal delivery type. (eg. PO BOX). Valid enumeration defined by Australia Post PAF code file + * Postal delivery type. (e.g., PO BOX). Valid enumeration defined by Australia Post PAF code file. */ postalDeliveryType?: string | null; /** - * Postcode for the locality + * Postcode for the locality. */ postcode: string; /** - * State in which the address belongs. Valid enumeration defined by Australia Post PAF code file [State Type Abbreviation](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf). NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT + * State in which the address belongs. Valid enumeration defined by Australia Post PAF code file [State Type Abbreviation](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf). `NSW`, `QLD`, `VIC`, `NT`, `WA`, `SA`, `TAS`, `ACT`, `AAT`. */ state: string; /** - * The name of the street + * The name of the street. */ streetName?: string | null; /** - * The street type suffix. Valid enumeration defined by Australia Post PAF code file + * The street type suffix. Valid enumeration defined by Australia Post PAF code file. */ streetSuffix?: string | null; /** - * The street type. Valid enumeration defined by Australia Post PAF code file + * The street type. Valid enumeration defined by Australia Post PAF code file. */ streetType?: string | null; /** - * Thoroughfare number for a property (first number in a property ranged address) + * Thoroughfare number for a property (first number in a property ranged address). */ thoroughfareNumber1?: number | null; /** - * Suffix for the thoroughfare number. Only relevant is thoroughfareNumber1 is populated + * Suffix for the thoroughfare number. Only relevant is _thoroughfareNumber1_ is populated. */ thoroughfareNumber1Suffix?: string | null; /** - * Second thoroughfare number (only used if the property has a ranged address eg 23-25) + * Second thoroughfare number (only used if the property has a ranged address, e.g., 23-25). */ thoroughfareNumber2?: number | null; /** - * Suffix for the second thoroughfare number. Only relevant is thoroughfareNumber2 is populated + * Suffix for the second thoroughfare number. Only relevant is _thoroughfareNumber2_ is populated. */ thoroughfareNumber2Suffix?: string | null; [k: string]: unknown; @@ -2974,134 +2974,134 @@ export interface CommonPAFAddress { export interface CommonPhysicalAddress { /** - * The type of address object present + * The type of address object present. */ addressUType: "paf" | "simple"; /** - * Australian address formatted according to the file format defined by the [PAF file format](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf) + * Australian address formatted according to the file format defined by the [PAF file format](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf). */ paf?: { /** - * Building/Property name 1 + * Building/Property name 1. */ buildingName1?: string | null; /** - * Building/Property name 2 + * Building/Property name 2. */ buildingName2?: string | null; /** - * Unique identifier for an address as defined by Australia Post. Also known as Delivery Point Identifier + * Unique identifier for an address as defined by Australia Post. Also known as Delivery Point Identifier. */ dpid?: string | null; /** - * Unit number (including suffix, if applicable) + * Unit number (including suffix, if applicable). */ flatUnitNumber?: string | null; /** - * Type of flat or unit for the address + * Type of flat or unit for the address. */ flatUnitType?: string | null; /** - * Floor or level number (including alpha characters) + * Floor or level number (including alpha characters). */ floorLevelNumber?: string | null; /** - * Type of floor or level for the address + * Type of floor or level for the address. */ floorLevelType?: string | null; /** - * Full name of locality + * Full name of locality. */ localityName: string; /** - * Allotment number for the address + * Allotment number for the address. */ lotNumber?: string | null; /** - * Postal delivery number if the address is a postal delivery type + * Postal delivery number if the address is a postal delivery type. */ postalDeliveryNumber?: number | null; /** - * Postal delivery number prefix related to the postal delivery number + * Postal delivery number prefix related to the postal delivery number. */ postalDeliveryNumberPrefix?: string | null; /** - * Postal delivery number suffix related to the postal delivery number + * Postal delivery number suffix related to the postal delivery number. */ postalDeliveryNumberSuffix?: string | null; /** - * Postal delivery type. (eg. PO BOX). Valid enumeration defined by Australia Post PAF code file + * Postal delivery type. (e.g., PO BOX). Valid enumeration defined by Australia Post PAF code file. */ postalDeliveryType?: string | null; /** - * Postcode for the locality + * Postcode for the locality. */ postcode: string; /** - * State in which the address belongs. Valid enumeration defined by Australia Post PAF code file [State Type Abbreviation](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf). NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT + * State in which the address belongs. Valid enumeration defined by Australia Post PAF code file [State Type Abbreviation](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf). `NSW`, `QLD`, `VIC`, `NT`, `WA`, `SA`, `TAS`, `ACT`, `AAT`. */ state: string; /** - * The name of the street + * The name of the street. */ streetName?: string | null; /** - * The street type suffix. Valid enumeration defined by Australia Post PAF code file + * The street type suffix. Valid enumeration defined by Australia Post PAF code file. */ streetSuffix?: string | null; /** - * The street type. Valid enumeration defined by Australia Post PAF code file + * The street type. Valid enumeration defined by Australia Post PAF code file. */ streetType?: string | null; /** - * Thoroughfare number for a property (first number in a property ranged address) + * Thoroughfare number for a property (first number in a property ranged address). */ thoroughfareNumber1?: number | null; /** - * Suffix for the thoroughfare number. Only relevant is thoroughfareNumber1 is populated + * Suffix for the thoroughfare number. Only relevant is _thoroughfareNumber1_ is populated. */ thoroughfareNumber1Suffix?: string | null; /** - * Second thoroughfare number (only used if the property has a ranged address eg 23-25) + * Second thoroughfare number (only used if the property has a ranged address, e.g., 23-25). */ thoroughfareNumber2?: number | null; /** - * Suffix for the second thoroughfare number. Only relevant is thoroughfareNumber2 is populated + * Suffix for the second thoroughfare number. Only relevant is _thoroughfareNumber2_ is populated. */ thoroughfareNumber2Suffix?: string | null; [k: string]: unknown; }; simple?: { /** - * First line of the standard address object + * First line of the standard address object. */ addressLine1: string; /** - * Second line of the standard address object + * Second line of the standard address object. */ addressLine2?: string | null; /** - * Third line of the standard address object + * Third line of the standard address object. */ addressLine3?: string | null; /** - * Name of the city or locality + * Name of the city or locality. */ city: string; /** - * A valid [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html) country code. Australia (AUS) is assumed if country is not present. + * A valid [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html) country code. Australia (`AUS`) is assumed if country is not present. */ country?: string | null; /** - * Name of the individual or business formatted for inclusion in an address used for physical mail + * Name of the individual or business formatted for inclusion in an address used for physical mail. */ mailingName?: string | null; /** - * Mandatory for Australian addresses + * Mandatory for Australian addresses. */ postcode?: string | null; /** - * Free text if the country is not Australia. If country is Australia then must be one of the values defined by the [State Type Abbreviation](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf) in the PAF file format. NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT + * Free text if the country is not Australia. If country is Australia then must be one of the values defined by the [State Type Abbreviation](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf) in the PAF file format. `NSW`, `QLD`, `VIC`, `NT`, `WA`, `SA`, `TAS`, `ACT`, `AAT`. */ state: string; [k: string]: unknown; @@ -3112,35 +3112,35 @@ export interface CommonPhysicalAddress { export interface CommonSimpleAddress { /** - * First line of the standard address object + * First line of the standard address object. */ addressLine1: string; /** - * Second line of the standard address object + * Second line of the standard address object. */ addressLine2?: string | null; /** - * Third line of the standard address object + * Third line of the standard address object. */ addressLine3?: string | null; /** - * Name of the city or locality + * Name of the city or locality. */ city: string; /** - * A valid [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html) country code. Australia (AUS) is assumed if country is not present. + * A valid [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html) country code. Australia (`AUS`) is assumed if country is not present. */ country?: string | null; /** - * Name of the individual or business formatted for inclusion in an address used for physical mail + * Name of the individual or business formatted for inclusion in an address used for physical mail. */ mailingName?: string | null; /** - * Mandatory for Australian addresses + * Mandatory for Australian addresses. */ postcode?: string | null; /** - * Free text if the country is not Australia. If country is Australia then must be one of the values defined by the [State Type Abbreviation](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf) in the PAF file format. NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT + * Free text if the country is not Australia. If country is Australia then must be one of the values defined by the [State Type Abbreviation](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf) in the PAF file format. `NSW`, `QLD`, `VIC`, `NT`, `WA`, `SA`, `TAS`, `ACT`, `AAT`. */ state: string; [k: string]: unknown; @@ -3149,7 +3149,7 @@ export interface CommonSimpleAddress { export interface Links { /** - * Fully qualified link that generated the current response document + * Fully qualified link that generated the current response document. */ self: string; [k: string]: unknown; @@ -3158,23 +3158,23 @@ export interface Links { export interface LinksPaginated { /** - * URI to the first page of this set. Mandatory if this response is not the first page + * URI to the first page of this set. Mandatory if this response is not the first page. */ first?: string | null; /** - * URI to the last page of this set. Mandatory if this response is not the last page + * URI to the last page of this set. Mandatory if this response is not the last page. */ last?: string | null; /** - * URI to the next page of this set. Mandatory if this response is not the last page + * URI to the next page of this set. Mandatory if this response is not the last page. */ next?: string | null; /** - * URI to the previous page of this set. Mandatory if this response is not the first page + * URI to the previous page of this set. Mandatory if this response is not the first page. */ prev?: string | null; /** - * Fully qualified link that generated the current response document + * Fully qualified link that generated the current response document. */ self: string; [k: string]: unknown; @@ -3187,11 +3187,11 @@ export interface Meta { /* These are the schema definitions stipulated by the Data Standards Body for the banking api. */ /** - * Additional data for customised error codes + * Additional data for customised error codes. */ export interface MetaError { /** - * The CDR error code URN which the application-specific error code extends. Mandatory if the error `code` is an application-specific error rather than a standardised error code. + * The CDR error code URN which the application-specific error code extends. Mandatory if the error _code_ is an application-specific error rather than a standardised error code. */ urn?: string | null; [k: string]: unknown; @@ -3222,7 +3222,7 @@ export interface MetaPaginatedTransaction { totalRecords: number; [k: string]: unknown; /** - * true if "text" query parameter is not supported + * `true` if _text_ query parameter is not supported. */ isQueryParamUnsupported?: boolean | null; } @@ -3242,7 +3242,7 @@ export interface RequestAccountIds { export interface ResponseBankingAccountByIdV2 { data: { /** - * A unique ID of the account adhering to the standards for ID permanence + * A unique ID of the account adhering to the standards for ID permanence. */ accountId: string; /** @@ -3250,27 +3250,27 @@ export interface ResponseBankingAccountByIdV2 { */ creationDate?: string | null; /** - * The display name of the account as defined by the bank. This should not incorporate account numbers or PANs. If it does the values should be masked according to the rules of the MaskedAccountString common type. + * The display name of the account as defined by the bank. This should not incorporate account numbers or PANs. If it does the values should be masked according to the rules of the [MaskedAccountString](#common-field-types) common type. */ displayName: string; /** - * Flag indicating that the customer associated with the authorisation is an owner of the account. Does not indicate sole ownership, however. If not present then 'true' is assumed + * Flag indicating that the customer associated with the authorisation is an owner of the account. Does not indicate sole ownership, however. If not present then `true` is assumed. */ isOwned?: boolean | null; /** - * A masked version of the account. Whether BSB/Account Number, Credit Card PAN or another number + * A masked version of the account. Whether BSB/Account Number, Credit Card PAN or another number. */ maskedNumber: string; /** - * A customer supplied nick name for the account + * A customer supplied nick name for the account. */ nickname?: string | null; /** - * Open or closed status for the account. If not present then OPEN is assumed + * Open or closed status for the account. If not present then `OPEN` is assumed. */ openStatus?: ("CLOSED" | "OPEN") | null; /** - * The category to which a product or account belongs. See [here](#product-categories) for more details + * The category to which a product or account belongs. See [here](#product-categories) for more details. */ productCategory: | "BUSINESS_LOANS" @@ -3286,7 +3286,7 @@ export interface ResponseBankingAccountByIdV2 { | "TRANS_AND_SAVINGS_ACCOUNTS" | "TRAVEL_CARDS"; /** - * The unique identifier of the account as defined by the data holder (akin to model number for the account) + * The unique identifier of the account as defined by the data holder (akin to model number for the account). */ productName: string; [k: string]: unknown; @@ -3309,105 +3309,105 @@ export interface ResponseBankingAccountByIdV2 { specificAccountUType?: "creditCard" | "loan" | "termDeposit"; termDeposit?: Array<{ /** - * The lodgement date of the original deposit + * The lodgement date of the original deposit. */ lodgementDate: string; /** - * Amount to be paid upon maturity. If absent it implies the amount to paid is variable and cannot currently be calculated + * Amount to be paid upon maturity. If absent it implies the amount to paid is variable and cannot currently be calculated. */ maturityAmount?: string | null; /** - * If absent assumes AUD + * If absent assumes `AUD`. */ maturityCurrency?: string | null; /** - * Maturity date for the term deposit + * Maturity date for the term deposit. */ maturityDate: string; /** - * Current instructions on action to be taken at maturity. This includes default actions that may be specified in the terms and conditions for the product e.g. roll-over to the same term and frequency of interest payments + * Current instructions on action to be taken at maturity. This includes default actions that may be specified in the terms and conditions for the product e.g., roll-over to the same term and frequency of interest payments. */ maturityInstructions: "HOLD_ON_MATURITY" | "PAID_OUT_AT_MATURITY" | "ROLLED_OVER"; [k: string]: unknown; }>; creditCard?: { /** - * The minimum payment amount due for the next card payment + * The minimum payment amount due for the next card payment. */ minPaymentAmount: string; /** - * If absent assumes AUD + * If absent assumes `AUD`. */ paymentCurrency?: string | null; /** - * The amount due for the next card payment + * The amount due for the next card payment. */ paymentDueAmount: string; /** - * Date that the next payment for the card is due + * Date that the next payment for the card is due. */ paymentDueDate: string; [k: string]: unknown; }; loan?: { /** - * Date that the loan is due to be repaid in full + * Date that the loan is due to be repaid in full. */ loanEndDate?: string | null; /** - * Maximum amount of funds that can be redrawn. If not present redraw is not available even if the feature exists for the account + * Maximum amount of funds that can be redrawn. If not present redraw is not available even if the feature exists for the account. */ maxRedraw?: string | null; /** - * If absent assumes AUD + * If absent assumes `AUD`. */ maxRedrawCurrency?: string | null; /** - * Minimum amount of next instalment + * Minimum amount of next instalment. */ minInstalmentAmount?: string | null; /** - * If absent assumes AUD + * If absent assumes `AUD`. */ minInstalmentCurrency?: string | null; /** - * Minimum redraw amount + * Minimum redraw amount. */ minRedraw?: string | null; /** - * If absent assumes AUD + * If absent assumes `AUD`. */ minRedrawCurrency?: string | null; /** - * Next date that an instalment is required + * Next date that an instalment is required. */ nextInstalmentDate?: string | null; /** - * Set to true if one or more offset accounts are configured for this loan account + * Set to `true` if one or more offset accounts are configured for this loan account. */ offsetAccountEnabled?: boolean | null; /** - * The accountIDs of the configured offset accounts attached to this loan. Only offset accounts that can be accessed under the current authorisation should be included. It is expected behaviour that offsetAccountEnabled is set to true but the offsetAccountIds field is absent or empty. This represents a situation where an offset account exists but details can not be accessed under the current authorisation + * The accountIDs of the configured offset accounts attached to this loan. Only offset accounts that can be accessed under the current authorisation should be included. It is expected behaviour that _offsetAccountEnabled_ is set to `true` but the _offsetAccountIds_ field is absent or empty. This represents a situation where an offset account exists but details can not be accessed under the current authorisation. */ offsetAccountIds?: string[] | null; /** - * Optional original loan value + * Optional original loan value. */ originalLoanAmount?: string | null; /** - * If absent assumes AUD + * If absent assumes `AUD`. */ originalLoanCurrency?: string | null; /** - * Optional original start date for the loan + * Optional original start date for the loan. */ originalStartDate?: string | null; /** - * The expected or required repayment frequency. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) + * The expected or required repayment frequency. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax). */ repaymentFrequency?: string | null; /** - * Options in place for repayments. If absent defaults to PRINCIPAL_AND_INTEREST + * Options in place for repayments. If absent defaults to `PRINCIPAL_AND_INTEREST`. */ repaymentType?: ("INTEREST_ONLY" | "PRINCIPAL_AND_INTEREST") | null; [k: string]: unknown; @@ -3425,27 +3425,27 @@ export interface ResponseBankingAccountByIdV2 { */ depositRates?: Array<{ /** - * Display text providing more information on the rate + * Display text providing more information on the rate. */ additionalInfo?: string | null; /** - * Link to a web page with more information on this rate + * Link to a web page with more information on this rate. */ additionalInfoUri?: string | null; /** - * Generic field containing additional information relevant to the [depositRateType](#tocSproductdepositratetypedoc) specified. Whether mandatory or not is dependent on the value of [depositRateType](#tocSproductdepositratetypedoc) + * Generic field containing additional information relevant to the [_depositRateType_](#tocSproductdepositratetypedoc) specified. Whether mandatory or not is dependent on the value of [_depositRateType_](#tocSproductdepositratetypedoc). */ additionalValue?: string | null; /** - * The period after which the calculated amount(s) (see calculationFrequency) are 'applied' (i.e. debited or credited) to the account. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) + * The period after which the calculated amount(s) (see _calculationFrequency_) are 'applied' (i.e. debited or credited) to the account. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax). */ applicationFrequency?: string | null; /** - * The period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see applicationFrequency). Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) + * The period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see _applicationFrequency_). Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax). */ calculationFrequency?: string | null; /** - * The type of rate (base, bonus, etc). See the next section for an overview of valid values and their meaning + * The type of rate (`FIXED`, `VARIABLE`, `BONUS`, etc.) For further details, refer to [Product Deposit Rate Types](#tocSproductdepositratetypedoc). */ depositRateType: | "BONUS" @@ -3456,11 +3456,11 @@ export interface ResponseBankingAccountByIdV2 { | "MARKET_LINKED" | "VARIABLE"; /** - * The rate to be applied + * The rate to be applied. */ rate: string; /** - * Rate tiers applicable for this rate + * Rate tiers applicable for this rate. */ tiers?: | Array<{ @@ -3473,37 +3473,37 @@ export interface ResponseBankingAccountByIdV2 { */ additionalInfoUri?: string | null; /** - * Defines a condition for the applicability of a tiered rate + * Defines the criteria and conditions for which a rate applies. */ applicabilityConditions?: { /** - * Display text providing more information on the condition + * Display text providing more information on the rate tier. */ additionalInfo?: string | null; /** - * Link to a web page with more information on this condition + * Link to a web page with more information on this rate tier. */ additionalInfoUri?: string | null; [k: string]: unknown; }; /** - * The number of tierUnitOfMeasure units that form the upper bound of the tier or band. For a tier with a discrete value (as opposed to a range of values e.g. 1 month) this must be the same as tierValueMinimum. Where this is the same as the tierValueMinimum value of the next-higher tier the referenced tier should be exclusive of this value. For example a term deposit of 2 months falls into the upper tier of the following tiers: (1 – 2 months, 2 – 3 months). If absent the tier's range has no upper bound. + * The number of _unitOfMeasure_ units that form the upper bound of the tier or band. For a tier with a discrete value (as opposed to a range of values e.g., 1 month) this must be the same as _minimumValue_. Where this is the same as the _minimumValue_ value of the next-higher tier the referenced tier should be exclusive of this value. For example a term deposit of 2 months falls into the upper tier of the following tiers: (1 – 2 months, 2 – 3 months). If absent the tier's range has no upper bound. */ maximumValue?: number | null; /** - * The number of tierUnitOfMeasure units that form the lower bound of the tier. The tier should be inclusive of this value + * The number of _unitOfMeasure_ units that form the lower bound of the tier. The tier should be inclusive of this value. */ minimumValue: number; /** - * A display name for the tier + * A display name for the tier. */ name: string; /** - * The method used to calculate the amount to be applied using one or more tiers. A single rate may be applied to the entire balance or each applicable tier rate is applied to the portion of the balance that falls into that tier (referred to as 'bands' or 'steps') + * The method used to calculate the amount to be applied using one or more tiers. A single rate may be applied to the entire balance or each applicable tier rate is applied to the portion of the balance that falls into that tier (referred to as 'bands' or 'steps'). */ rateApplicationMethod?: ("PER_TIER" | "WHOLE_BALANCE") | null; /** - * The unit of measure that applies to the tierValueMinimum and tierValueMaximum values e.g. a **DOLLAR** amount. **PERCENT** (in the case of loan-to-value ratio or LVR). Tier term period representing a discrete number of **MONTH**'s or **DAY**'s (in the case of term deposit tiers) + * The unit of measure that applies to the _minimumValue_ and _maximumValue_ values e.g.,
  • `DOLLAR` amount.
  • `PERCENT` (in the case of loan-to-value ratio or LVR).
  • Tier term period representing a discrete number of `MONTH`(s) or `DAY`(s) (in the case of term deposit tiers).
*/ unitOfMeasure: "DAY" | "DOLLAR" | "MONTH" | "PERCENT"; [k: string]: unknown; @@ -3520,31 +3520,31 @@ export interface ResponseBankingAccountByIdV2 { */ additionalInfo?: string | null; /** - * Link to a web page with more information on this rate + * Link to a web page with more information on this rate. */ additionalInfoUri?: string | null; /** - * Generic field containing additional information relevant to the [lendingRateType](#tocSproductlendingratetypedoc) specified. Whether mandatory or not is dependent on the value of [lendingRateType](#tocSproductlendingratetypedoc) + * Generic field containing additional information relevant to the [_lendingRateType_](#tocSproductlendingratetypedoc) specified. Whether mandatory or not is dependent on the value of [_lendingRateType_](#tocSproductlendingratetypedoc). */ additionalValue?: string | null; /** - * The period after which the calculated amount(s) (see calculationFrequency) are 'applied' (i.e. debited or credited) to the account. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) + * The period after which the calculated amount(s) (see _calculationFrequency_) are 'applied' (i.e. debited or credited) to the account. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax). */ applicationFrequency?: string | null; /** - * The period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see applicationFrequency). Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) + * The period after which the rate is applied to the balance to calculate the amount due for the period. Calculation of the amount is often daily (as balances may change) but accumulated until the total amount is 'applied' to the account (see _applicationFrequency_). Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax). */ calculationFrequency?: string | null; /** - * A comparison rate equivalent for this rate + * A comparison rate equivalent for this rate. */ comparisonRate?: string | null; /** - * When loan payments are due to be paid within each period. The investment benefit of earlier payments affect the rate that can be offered + * When loan payments are due to be paid within each period. The investment benefit of earlier payments affect the rate that can be offered. */ interestPaymentDue?: ("IN_ADVANCE" | "IN_ARREARS") | null; /** - * The type of rate (fixed, variable, etc). See the next section for an overview of valid values and their meaning + * The type of rate (`FIXED`, `VARIABLE`, etc.) For further details, refer to [Product Lending Rate Types](#tocSproductlendingratetypedoc). */ lendingRateType: | "BUNDLE_DISCOUNT_FIXED" @@ -3559,19 +3559,19 @@ export interface ResponseBankingAccountByIdV2 { | "PURCHASE" | "VARIABLE"; /** - * The reason for taking out the loan. If absent, the lending rate is applicable to all loan purposes + * The reason for taking out the loan. If absent, the lending rate is applicable to all loan purposes. */ loanPurpose?: ("INVESTMENT" | "OWNER_OCCUPIED") | null; /** - * The rate to be applied + * The rate to be applied. */ rate: string; /** - * Options in place for repayments. If absent, the lending rate is applicable to all repayment types + * Options in place for repayments. If absent, the lending rate is applicable to all repayment types. */ repaymentType?: ("INTEREST_ONLY" | "PRINCIPAL_AND_INTEREST") | null; /** - * Rate tiers applicable for this rate + * Rate tiers applicable for this rate. */ tiers?: | Array<{ @@ -3628,19 +3628,19 @@ export interface ResponseBankingAccountByIdV2 { features?: Array< { /** - * Display text providing more information on the feature. Mandatory if the [feature type](#tocSproductfeaturetypedoc) is set to OTHER + * Display text providing more information on the feature. Mandatory if [_featureType_](#tocSproductfeaturetypedoc) is set to `OTHER`. */ additionalInfo?: string | null; /** - * Link to a web page with more information on this feature + * Link to a web page with more information on this feature. */ additionalInfoUri?: string | null; /** - * Generic field containing additional information relevant to the [featureType](#tocSproductfeaturetypedoc) specified. Whether mandatory or not is dependent on the value of the [featureType.](#tocSproductfeaturetypedoc) + * Generic field containing additional information relevant to the [_featureType_](#tocSproductfeaturetypedoc) specified. Whether mandatory or not is dependent on the value of the [_featureType_](#tocSproductfeaturetypedoc). */ additionalValue?: string | null; /** - * The type of feature described + * The type of feature described. For further details, refer to [Product Feature Types](#tocSproductfeaturetypedoc). */ featureType: | "ADDITIONAL_CARDS" @@ -3686,93 +3686,93 @@ export interface ResponseBankingAccountByIdV2 { */ fees?: Array<{ /** - * The indicative frequency with which the fee is calculated on the account. Only applies if balanceRate or accruedRate is also present. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) + * The indicative frequency with which the fee is calculated on the account. Only applies if _balanceRate_ or _accruedRate_ is also present. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax). */ accrualFrequency?: string | null; /** - * A fee rate calculated based on a proportion of the calculated interest accrued on the account. One of amount, balanceRate, transactionRate and accruedRate is mandatory unless the *feeType* "VARIABLE" is supplied + * A fee rate calculated based on a proportion of the calculated interest accrued on the account. One of _amount_, _balanceRate_, _transactionRate_ and _accruedRate_ is mandatory unless the _feeType_ `VARIABLE` is supplied. */ accruedRate?: string | null; /** - * Display text providing more information on the fee + * Display text providing more information on the fee. */ additionalInfo?: string | null; /** - * Link to a web page with more information on this fee + * Link to a web page with more information on this fee. */ additionalInfoUri?: string | null; /** - * Generic field containing additional information relevant to the [feeType](#tocSproductfeetypedoc) specified. Whether mandatory or not is dependent on the value of [feeType](#tocSproductfeetypedoc) + * Generic field containing additional information relevant to the [_feeType_](#tocSproductfeetypedoc) specified. Whether mandatory or not is dependent on the value of [_feeType_](#tocSproductfeetypedoc). */ additionalValue?: string | null; /** - * The amount charged for the fee. One of amount, balanceRate, transactionRate and accruedRate is mandatory unless the *feeType* "VARIABLE" is supplied + * The amount charged for the fee. One of _amount_, _balanceRate_, _transactionRate_ and _accruedRate_ is mandatory unless the _feeType_ `VARIABLE` is supplied. */ amount?: string | null; /** - * A fee rate calculated based on a proportion of the balance. One of amount, balanceRate, transactionRate and accruedRate is mandatory unless the *feeType* "VARIABLE" is supplied. + * A fee rate calculated based on a proportion of the balance. One of _amount_, _balanceRate_, _transactionRate_ and _accruedRate_ is mandatory unless the _feeType_ `VARIABLE` is supplied. */ balanceRate?: string | null; /** - * The currency the fee will be charged in. Assumes AUD if absent + * The currency the fee will be charged in. Assumes `AUD` if absent. */ currency?: string | null; /** - * An optional list of discounts to this fee that may be available + * An optional list of discounts to this fee that may be available. */ discounts?: | Array<{ /** - * A discount rate calculated based on a proportion of the calculated interest accrued on the account. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory. Unless noted in additionalInfo, assumes the application and calculation frequency are the same as the corresponding fee + * A discount rate calculated based on a proportion of the calculated interest accrued on the account. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of _amount_, _balanceRate_, _transactionRate_, _accruedRate_ and _feeRate_ is mandatory. Unless noted in _additionalInfo_, assumes the application and calculation frequency are the same as the corresponding fee. */ accruedRate?: string | null; /** - * Display text providing more information on the discount + * Display text providing more information on the discount. */ additionalInfo?: string | null; /** - * Link to a web page with more information on this discount + * Link to a web page with more information on this discount. */ additionalInfoUri?: string | null; /** - * Generic field containing additional information relevant to the [discountType](#tocSproductdiscounttypedoc) specified. Whether mandatory or not is dependent on the value of [discountType](#tocSproductdiscounttypedoc) + * Generic field containing additional information relevant to the [_discountType_](#tocSproductdiscounttypedoc) specified. Whether mandatory or not is dependent on the value of [_discountType_](#tocSproductdiscounttypedoc). */ additionalValue?: string | null; /** - * Dollar value of the discount. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory. + * Dollar value of the discount. One of _amount_, _balanceRate_, _transactionRate_, _accruedRate_ and _feeRate_ is mandatory. */ amount?: string | null; /** - * A discount rate calculated based on a proportion of the balance. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of amount, balanceRate, transactionRate, accruedRate and feeRate is mandatory. Unless noted in additionalInfo, assumes the application and calculation frequency are the same as the corresponding fee + * A discount rate calculated based on a proportion of the balance. Note that the currency of the fee discount is expected to be the same as the currency of the fee itself. One of _amount_, _balanceRate_, _transactionRate_, _accruedRate_ and _feeRate_ is mandatory. Unless noted in _additionalInfo_, assumes the application and calculation frequency are the same as the corresponding fee. */ balanceRate?: string | null; /** - * Description of the discount + * Description of the discount. */ description: string; /** - * The type of discount. See the next section for an overview of valid values and their meaning + * The type of discount. For further details, refer to [Product Discount Types](#tocSproductdiscounttypedoc). */ discountType: "BALANCE" | "DEPOSITS" | "ELIGIBILITY_ONLY" | "FEE_CAP" | "PAYMENTS"; /** - * Eligibility constraints that apply to this discount. Mandatory if ``discountType`` is ``ELIGIBILITY_ONLY``. + * Eligibility constraints that apply to this discount. Mandatory if _discountType_ is `ELIGIBILITY_ONLY`. */ eligibility?: | Array<{ /** - * Display text providing more information on this eligibility constraint. Whether mandatory or not is dependent on the value of [discountEligibilityType](#tocSproductdiscounteligibilitydoc) + * Display text providing more information on this eligibility constraint. Whether mandatory or not is dependent on the value of [_discountEligibilityType_](#tocSproductdiscounteligibilitydoc). */ additionalInfo?: string | null; /** - * Link to a web page with more information on this eligibility constraint + * Link to a web page with more information on this eligibility constraint. */ additionalInfoUri?: string | null; /** - * Generic field containing additional information relevant to the [discountEligibilityType](#tocSproductdiscounteligibilitydoc) specified. Whether mandatory or not is dependent on the value of [discountEligibilityType](#tocSproductdiscounteligibilitydoc) + * Generic field containing additional information relevant to the [_discountEligibilityType_](#tocSproductdiscounteligibilitydoc) specified. Whether mandatory or not is dependent on the value of [_discountEligibilityType_](#tocSproductdiscounteligibilitydoc). */ additionalValue?: string | null; /** - * The type of the specific eligibility constraint for a discount + * The type of the specific eligibility constraint for a discount. For further details, refer to [Product Discount Eligibility Types](#tocSproductdiscounteligibilitydoc). */ discountEligibilityType: | "BUSINESS" @@ -3831,134 +3831,134 @@ export interface ResponseBankingAccountByIdV2 { */ addresses?: Array<{ /** - * The type of address object present + * The type of address object present. */ addressUType: "paf" | "simple"; /** - * Australian address formatted according to the file format defined by the [PAF file format](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf) + * Australian address formatted according to the file format defined by the [PAF file format](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf). */ paf?: { /** - * Building/Property name 1 + * Building/Property name 1. */ buildingName1?: string | null; /** - * Building/Property name 2 + * Building/Property name 2. */ buildingName2?: string | null; /** - * Unique identifier for an address as defined by Australia Post. Also known as Delivery Point Identifier + * Unique identifier for an address as defined by Australia Post. Also known as Delivery Point Identifier. */ dpid?: string | null; /** - * Unit number (including suffix, if applicable) + * Unit number (including suffix, if applicable). */ flatUnitNumber?: string | null; /** - * Type of flat or unit for the address + * Type of flat or unit for the address. */ flatUnitType?: string | null; /** - * Floor or level number (including alpha characters) + * Floor or level number (including alpha characters). */ floorLevelNumber?: string | null; /** - * Type of floor or level for the address + * Type of floor or level for the address. */ floorLevelType?: string | null; /** - * Full name of locality + * Full name of locality. */ localityName: string; /** - * Allotment number for the address + * Allotment number for the address. */ lotNumber?: string | null; /** - * Postal delivery number if the address is a postal delivery type + * Postal delivery number if the address is a postal delivery type. */ postalDeliveryNumber?: number | null; /** - * Postal delivery number prefix related to the postal delivery number + * Postal delivery number prefix related to the postal delivery number. */ postalDeliveryNumberPrefix?: string | null; /** - * Postal delivery number suffix related to the postal delivery number + * Postal delivery number suffix related to the postal delivery number. */ postalDeliveryNumberSuffix?: string | null; /** - * Postal delivery type. (eg. PO BOX). Valid enumeration defined by Australia Post PAF code file + * Postal delivery type. (e.g., PO BOX). Valid enumeration defined by Australia Post PAF code file. */ postalDeliveryType?: string | null; /** - * Postcode for the locality + * Postcode for the locality. */ postcode: string; /** - * State in which the address belongs. Valid enumeration defined by Australia Post PAF code file [State Type Abbreviation](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf). NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT + * State in which the address belongs. Valid enumeration defined by Australia Post PAF code file [State Type Abbreviation](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf). `NSW`, `QLD`, `VIC`, `NT`, `WA`, `SA`, `TAS`, `ACT`, `AAT`. */ state: string; /** - * The name of the street + * The name of the street. */ streetName?: string | null; /** - * The street type suffix. Valid enumeration defined by Australia Post PAF code file + * The street type suffix. Valid enumeration defined by Australia Post PAF code file. */ streetSuffix?: string | null; /** - * The street type. Valid enumeration defined by Australia Post PAF code file + * The street type. Valid enumeration defined by Australia Post PAF code file. */ streetType?: string | null; /** - * Thoroughfare number for a property (first number in a property ranged address) + * Thoroughfare number for a property (first number in a property ranged address). */ thoroughfareNumber1?: number | null; /** - * Suffix for the thoroughfare number. Only relevant is thoroughfareNumber1 is populated + * Suffix for the thoroughfare number. Only relevant is _thoroughfareNumber1_ is populated. */ thoroughfareNumber1Suffix?: string | null; /** - * Second thoroughfare number (only used if the property has a ranged address eg 23-25) + * Second thoroughfare number (only used if the property has a ranged address, e.g., 23-25). */ thoroughfareNumber2?: number | null; /** - * Suffix for the second thoroughfare number. Only relevant is thoroughfareNumber2 is populated + * Suffix for the second thoroughfare number. Only relevant is _thoroughfareNumber2_ is populated. */ thoroughfareNumber2Suffix?: string | null; [k: string]: unknown; }; simple?: { /** - * First line of the standard address object + * First line of the standard address object. */ addressLine1: string; /** - * Second line of the standard address object + * Second line of the standard address object. */ addressLine2?: string | null; /** - * Third line of the standard address object + * Third line of the standard address object. */ addressLine3?: string | null; /** - * Name of the city or locality + * Name of the city or locality. */ city: string; /** - * A valid [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html) country code. Australia (AUS) is assumed if country is not present. + * A valid [ISO 3166 Alpha-3](https://www.iso.org/iso-3166-country-codes.html) country code. Australia (`AUS`) is assumed if country is not present. */ country?: string | null; /** - * Name of the individual or business formatted for inclusion in an address used for physical mail + * Name of the individual or business formatted for inclusion in an address used for physical mail. */ mailingName?: string | null; /** - * Mandatory for Australian addresses + * Mandatory for Australian addresses. */ postcode?: string | null; /** - * Free text if the country is not Australia. If country is Australia then must be one of the values defined by the [State Type Abbreviation](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf) in the PAF file format. NSW, QLD, VIC, NT, WA, SA, TAS, ACT, AAT + * Free text if the country is not Australia. If country is Australia then must be one of the values defined by the [State Type Abbreviation](https://auspost.com.au/content/dam/auspost_corp/media/documents/australia-post-data-guide.pdf) in the PAF file format. `NSW`, `QLD`, `VIC`, `NT`, `WA`, `SA`, `TAS`, `ACT`, `AAT`. */ state: string; [k: string]: unknown; @@ -3969,7 +3969,7 @@ export interface ResponseBankingAccountByIdV2 { }; links: { /** - * Fully qualified link that generated the current response document + * Fully qualified link that generated the current response document. */ self: string; [k: string]: unknown; @@ -3984,39 +3984,39 @@ export interface ResponseBankingAccountByIdV2 { export interface ResponseBankingAccountList { data: { /** - * The list of accounts returned. If the filter results in an empty set then this array may have no records + * The list of accounts returned. If the filter results in an empty set then this array may have no records. */ accounts: Array<{ /** - * A unique ID of the account adhering to the standards for ID permanence + * A unique ID of the account adhering to the standards for ID permanence. */ accountId: string; /** - * Date that the account was created (if known) + * Date that the account was created (if known). */ creationDate?: string | null; /** - * The display name of the account as defined by the bank. This should not incorporate account numbers or PANs. If it does the values should be masked according to the rules of the MaskedAccountString common type. + * The display name of the account as defined by the bank. This should not incorporate account numbers or PANs. If it does the values should be masked according to the rules of the [MaskedAccountString](#common-field-types) common type. */ displayName: string; /** - * Flag indicating that the customer associated with the authorisation is an owner of the account. Does not indicate sole ownership, however. If not present then 'true' is assumed + * Flag indicating that the customer associated with the authorisation is an owner of the account. Does not indicate sole ownership, however. If not present then `true` is assumed. */ isOwned?: boolean | null; /** - * A masked version of the account. Whether BSB/Account Number, Credit Card PAN or another number + * A masked version of the account. Whether BSB/Account Number, Credit Card PAN or another number. */ maskedNumber: string; /** - * A customer supplied nick name for the account + * A customer supplied nick name for the account. */ nickname?: string | null; /** - * Open or closed status for the account. If not present then OPEN is assumed + * Open or closed status for the account. If not present then `OPEN` is assumed. */ openStatus?: ("CLOSED" | "OPEN") | null; /** - * The category to which a product or account belongs. See [here](#product-categories) for more details + * The category to which a product or account belongs. See [here](#product-categories) for more details. */ productCategory: | "BUSINESS_LOANS" @@ -4032,7 +4032,7 @@ export interface ResponseBankingAccountList { | "TRANS_AND_SAVINGS_ACCOUNTS" | "TRAVEL_CARDS"; /** - * The unique identifier of the account as defined by the data holder (akin to model number for the account) + * The unique identifier of the account as defined by the data holder (akin to model number for the account). */ productName: string; [k: string]: unknown; @@ -4041,23 +4041,23 @@ export interface ResponseBankingAccountList { }; links: { /** - * URI to the first page of this set. Mandatory if this response is not the first page + * URI to the first page of this set. Mandatory if this response is not the first page. */ first?: string | null; /** - * URI to the last page of this set. Mandatory if this response is not the last page + * URI to the last page of this set. Mandatory if this response is not the last page. */ last?: string | null; /** - * URI to the next page of this set. Mandatory if this response is not the last page + * URI to the next page of this set. Mandatory if this response is not the last page. */ next?: string | null; /** - * URI to the previous page of this set. Mandatory if this response is not the first page + * URI to the previous page of this set. Mandatory if this response is not the first page. */ prev?: string | null; /** - * Fully qualified link that generated the current response document + * Fully qualified link that generated the current response document. */ self: string; [k: string]: unknown; @@ -4113,7 +4113,7 @@ export interface ResponseBankingAccountByIdV3 { */ openStatus?: ("CLOSED" | "OPEN") | null; /** - * The category to which a product or account belongs. See [here](#product-categories) for more details + * The category to which a product or account belongs. See [here](#product-categories) for more details. */ productCategory: | "BUSINESS_LOANS" @@ -4129,7 +4129,7 @@ export interface ResponseBankingAccountByIdV3 { | "TRANS_AND_SAVINGS_ACCOUNTS" | "TRAVEL_CARDS"; /** - * The unique identifier of the account as defined by the data holder (akin to model number for the account) + * A data holder specific unique identifier for this product. This identifier must be unique to a product but does not otherwise need to adhere to ID permanence guidelines. */ productName: string; [k: string]: unknown; @@ -4847,55 +4847,55 @@ export interface ResponseBankingProductByIdV4 { */ applicationUri?: string | null; /** - * A label of the brand for the product. Able to be used for filtering. For data holders with single brands this value is still required + * A label of the brand for the product. Able to be used for filtering. For data holders with single brands this value is still required. */ brand: string; /** - * An optional display name of the brand + * An optional display name of the brand. */ brandName?: string | null; /** - * An array of card art images + * An array of card art images. */ cardArt?: | Array<{ /** - * URI reference to a PNG, JPG or GIF image with proportions defined by ISO 7810 ID-1 and width no greater than 512 pixels. The URI reference may be a link or url-encoded data URI according to **[[RFC2397]](#nref-RFC2397)** + * URI reference to a PNG, JPG or GIF image with proportions defined by ISO 7810 ID-1 and width no greater than 512 pixels. The URI reference may be a link or url-encoded data URI according to **[[RFC2397]](#nref-RFC2397)**. */ imageUri: string; /** - * Display label for the specific image + * Display label for the specific image. */ title?: string; [k: string]: unknown; }> | null; /** - * A description of the product + * A description of the product. */ description: string; /** - * The date and time from which this product is effective (ie. is available for origination). Used to enable the articulation of products to the regime before they are available for customers to originate + * The date and time from which this product is effective (i.e. is available for origination). Used to enable the articulation of products to the regime before they are available for customers to originate. */ effectiveFrom?: string | null; /** - * The date and time at which this product will be retired and will no longer be offered. Used to enable the managed deprecation of products + * The date and time at which this product will be retired and will no longer be offered. Used to enable the managed deprecation of products. */ effectiveTo?: string | null; /** - * Indicates whether the product is specifically tailored to a circumstance. In this case fees and prices are significantly negotiated depending on context. While all products are open to a degree of tailoring this flag indicates that tailoring is expected and thus that the provision of specific fees and rates is not applicable + * Indicates whether the product is specifically tailored to a circumstance. In this case fees and prices are significantly negotiated depending on context. While all products are open to a degree of tailoring this flag indicates that tailoring is expected and thus that the provision of specific fees and rates is not applicable. */ isTailored: boolean; /** - * The last date and time that the information for this product was changed (or the creation date for the product if it has never been altered) + * The last date and time that the information for this product was changed (or the creation date for the product if it has never been altered). */ lastUpdated: string; /** - * The display name of the product + * The display name of the product. */ name: string; /** - * The category to which a product or account belongs. See [here](#product-categories) for more details + * The category to which a product or account belongs. See [here](#product-categories) for more details. */ productCategory: | "BUSINESS_LOANS" @@ -5419,11 +5419,11 @@ export interface ResponseBankingProductListV2 { */ products: Array<{ /** - * Object that contains links to additional information on specific topics + * Object that contains links to additional information on specific topics. */ additionalInformation?: { /** - * An array of additional bundles for the product, if applicable. To be treated as secondary documents to the `bundleUri`. Only to be used if there is a primary `bundleUri`. + * An array of additional bundles for the product, if applicable. To be treated as secondary documents to the _bundleUri_. Only to be used if there is a primary _bundleUri_. */ additionalBundleUris?: | Array<{ @@ -5439,7 +5439,7 @@ export interface ResponseBankingProductListV2 { }> | null; /** - * An array of additional eligibility rules and criteria for the product, if applicable. To be treated as secondary documents to the `eligibilityUri`. Only to be used if there is a primary `eligibilityUri`. + * An array of additional eligibility rules and criteria for the product, if applicable. To be treated as secondary documents to the _eligibilityUri_. Only to be used if there is a primary _eligibilityUri_. */ additionalEligibilityUris?: | Array<{ @@ -5455,7 +5455,7 @@ export interface ResponseBankingProductListV2 { }> | null; /** - * An array of additional fees, pricing, discounts, exemptions and bonuses for the product, if applicable. To be treated as secondary documents to the `feesAndPricingUri`. Only to be used if there is a primary `feesAndPricingUri`. + * An array of additional fees, pricing, discounts, exemptions and bonuses for the product, if applicable. To be treated as secondary documents to the _feesAndPricingUri_. Only to be used if there is a primary _feesAndPricingUri_. */ additionalFeesAndPricingUris?: | Array<{ @@ -5471,7 +5471,7 @@ export interface ResponseBankingProductListV2 { }> | null; /** - * An array of additional general overviews for the product or features of the product, if applicable. To be treated as secondary documents to the `overviewUri`. Only to be used if there is a primary `overviewUri`. + * An array of additional general overviews for the product or features of the product, if applicable. To be treated as secondary documents to the _overviewUri_. Only to be used if there is a primary _overviewUri_. */ additionalOverviewUris?: | Array<{ @@ -5487,7 +5487,7 @@ export interface ResponseBankingProductListV2 { }> | null; /** - * An array of additional terms and conditions for the product, if applicable. To be treated as secondary documents to the `termsUri`. Only to be used if there is a primary `termsUri`. + * An array of additional terms and conditions for the product, if applicable. To be treated as secondary documents to the _termsUri_. Only to be used if there is a primary _termsUri_. */ additionalTermsUris?: | Array<{ @@ -5503,23 +5503,23 @@ export interface ResponseBankingProductListV2 { }> | null; /** - * Description of a bundle that this product can be part of. Mandatory if `additionalBundleUris` includes one or more supporting documents. + * Description of a bundle that this product can be part of. Mandatory if _additionalBundleUris_ includes one or more supporting documents. */ bundleUri?: string | null; /** - * Eligibility rules and criteria for the product. Mandatory if `additionalEligibilityUris` includes one or more supporting documents. + * Eligibility rules and criteria for the product. Mandatory if _additionalEligibilityUris_ includes one or more supporting documents. */ eligibilityUri?: string | null; /** - * Description of fees, pricing, discounts, exemptions and bonuses for the product. Mandatory if `additionalFeesAndPricingUris` includes one or more supporting documents. + * Description of fees, pricing, discounts, exemptions and bonuses for the product. Mandatory if _additionalFeesAndPricingUris_ includes one or more supporting documents. */ feesAndPricingUri?: string | null; /** - * General overview of the product. Mandatory if `additionalOverviewUris` includes one or more supporting documents. + * General overview of the product. Mandatory if _additionalOverviewUris_ includes one or more supporting documents. */ overviewUri?: string | null; /** - * Terms and conditions for the product. Mandatory if `additionalTermsUris` includes one or more supporting documents. + * Terms and conditions for the product. Mandatory if _additionalTermsUris_ includes one or more supporting documents. */ termsUri?: string | null; [k: string]: unknown; @@ -5602,23 +5602,23 @@ export interface ResponseBankingProductListV2 { }; links: { /** - * URI to the first page of this set. Mandatory if this response is not the first page + * URI to the first page of this set. Mandatory if this response is not the first page. */ first?: string | null; /** - * URI to the last page of this set. Mandatory if this response is not the last page + * URI to the last page of this set. Mandatory if this response is not the last page. */ last?: string | null; /** - * URI to the next page of this set. Mandatory if this response is not the last page + * URI to the next page of this set. Mandatory if this response is not the last page. */ next?: string | null; /** - * URI to the previous page of this set. Mandatory if this response is not the first page + * URI to the previous page of this set. Mandatory if this response is not the first page. */ prev?: string | null; /** - * Fully qualified link that generated the current response document + * Fully qualified link that generated the current response document. */ self: string; [k: string]: unknown; @@ -5641,7 +5641,7 @@ export interface ResponseBankingProductListV2 { export interface ResponseBankingScheduledPaymentsListV2 { data: { /** - * The list of scheduled payments to return + * The list of scheduled payments to return. */ scheduledPayments: Array<{ /** @@ -5655,15 +5655,15 @@ export interface ResponseBankingScheduledPaymentsListV2 { [k: string]: unknown; }; /** - * The short display name of the scheduled payment as provided by the customer if provided. Where a customer has not provided a nickname, a display name derived by the bank for the scheduled payment should be provided that is consistent with existing digital banking channels + * The short display name of the scheduled payment as provided by the customer if provided. Where a customer has not provided a nickname, a display name derived by the bank for the scheduled payment should be provided that is consistent with existing digital banking channels. */ nickname?: string | null; /** - * The reference for the transaction, if applicable, that will be provided by the originating institution for all payments in the payment set. Empty string if no data provided + * The reference for the transaction, if applicable, that will be provided by the originating institution for all payments in the payment set. Empty string if no data provided. */ payeeReference?: string | null; /** - * The reference for the transaction that will be used by the originating institution for the purposes of constructing a statement narrative on the payer’s account. Empty string if no data provided + * The reference for the transaction that will be used by the originating institution for the purposes of constructing a statement narrative on the payer’s account. Empty string if no data provided. */ payerReference: string; paymentSet: Array<{ @@ -5830,11 +5830,11 @@ export interface ResponseBankingScheduledPaymentsListV2 { [k: string]: unknown; }; /** - * The short display name of the payee as provided by the customer unless toUType is set to payeeId. Where a customer has not provided a nickname, a display name derived by the bank for payee should be provided that is consistent with existing digital banking channels + * The short display name of the payee as provided by the customer unless _toUType_ is set to `payeeId`. Where a customer has not provided a nickname, a display name derived by the bank for payee should be provided that is consistent with existing digital banking channels. */ nickname?: string | null; /** - * Present if toUType is set to payeeId. Indicates that the payment is to registered payee that can be accessed using the payee end point. If the Bank Payees scope has not been consented to then a payeeId should not be provided and the full payee details should be provided instead + * Present if _toUType_ is set to `payeeId`. Indicates that the payment is to registered payee that can be accessed using the payee endpoint. If the Bank Payees scope has not been consented to then a _payeeId_ should not be provided and the full payee details should be provided instead. */ payeeId?: string | null; /** @@ -5844,7 +5844,7 @@ export interface ResponseBankingScheduledPaymentsListV2 { /** * The type of object provided that specifies the destination of the funds for the payment. */ - toUType: "accountId" | "biller" | "domestic" | "international" | "payeeId"; + toUType: "accountId" | "biller" | "digitalWallet" | "domestic" | "international" | "payeeId"; [k: string]: unknown; }; [k: string]: unknown; @@ -5955,23 +5955,23 @@ export interface ResponseBankingScheduledPaymentsListV2 { }; links: { /** - * URI to the first page of this set. Mandatory if this response is not the first page + * URI to the first page of this set. Mandatory if this response is not the first page. */ first?: string | null; /** - * URI to the last page of this set. Mandatory if this response is not the last page + * URI to the last page of this set. Mandatory if this response is not the last page. */ last?: string | null; /** - * URI to the next page of this set. Mandatory if this response is not the last page + * URI to the next page of this set. Mandatory if this response is not the last page. */ next?: string | null; /** - * URI to the previous page of this set. Mandatory if this response is not the first page + * URI to the previous page of this set. Mandatory if this response is not the first page. */ prev?: string | null; /** - * Fully qualified link that generated the current response document + * Fully qualified link that generated the current response document. */ self: string; [k: string]: unknown; @@ -6290,23 +6290,23 @@ export interface ResponseBankingScheduledPaymentsList { }; links: { /** - * URI to the first page of this set. Mandatory if this response is not the first page + * URI to the first page of this set. Mandatory if this response is not the first page. */ first?: string | null; /** - * URI to the last page of this set. Mandatory if this response is not the last page + * URI to the last page of this set. Mandatory if this response is not the last page. */ last?: string | null; /** - * URI to the next page of this set. Mandatory if this response is not the last page + * URI to the next page of this set. Mandatory if this response is not the last page. */ next?: string | null; /** - * URI to the previous page of this set. Mandatory if this response is not the first page + * URI to the previous page of this set. Mandatory if this response is not the first page. */ prev?: string | null; /** - * Fully qualified link that generated the current response document + * Fully qualified link that generated the current response document. */ self: string; [k: string]: unknown; @@ -6549,23 +6549,23 @@ export interface ResponseBankingTransactionList { }; links: { /** - * URI to the first page of this set. Mandatory if this response is not the first page + * URI to the first page of this set. Mandatory if this response is not the first page. */ first?: string | null; /** - * URI to the last page of this set. Mandatory if this response is not the last page + * URI to the last page of this set. Mandatory if this response is not the last page. */ last?: string | null; /** - * URI to the next page of this set. Mandatory if this response is not the last page + * URI to the next page of this set. Mandatory if this response is not the last page. */ next?: string | null; /** - * URI to the previous page of this set. Mandatory if this response is not the first page + * URI to the previous page of this set. Mandatory if this response is not the first page. */ prev?: string | null; /** - * Fully qualified link that generated the current response document + * Fully qualified link that generated the current response document. */ self: string; [k: string]: unknown; diff --git a/types/consumer-data-standards/energy/index.d.ts b/types/consumer-data-standards/energy/index.d.ts index c50995f281251b..0d620b2416d50c 100644 --- a/types/consumer-data-standards/energy/index.d.ts +++ b/types/consumer-data-standards/energy/index.d.ts @@ -316,6 +316,11 @@ export interface EnergyAccountDetailResponseV3 { meta: Meta; [k: string]: unknown; } +export interface EnergyAccountDetailResponseV4 { + data: EnergyAccountDetailV4; + links: Links; + meta?: Meta; +} /* These are the schema definitions stipulated by the Data Standards Body for the energy api. */ export interface EnergyAccountDetailV2 extends EnergyAccountBaseV2 { @@ -502,11 +507,15 @@ export interface EnergyAccountDetailV2 extends EnergyAccountBaseV2 { */ days?: Array<"SUN" | "MON" | "TUE" | "WED" | "THU" | "FRI" | "SAT" | "PUBLIC_HOLIDAYS">; /** - * The end of the time period per day for which the controlled load rate applies. Required if startTime provided + * The end of the time period per day for which the controlled load rate applies. Required if startTime provided. + * + * Formatted according to [ISO 8601 Times](https://en.wikipedia.org/wiki/ISO_8601#Times). If the time is provided without a UTC offset, the time zone will be determined by the value of EnergyPlanContract.timeZone. */ endTime?: string; /** - * The beginning of the time period per day for which the controlled load rate applies. Required if endTime provided + * The beginning of the time period per day for which the controlled load rate applies. Required if endTime provided. + * + * Formatted according to [ISO 8601 Times](https://en.wikipedia.org/wiki/ISO_8601#Times). If the time is provided without a UTC offset, the time zone will be determined by the value of EnergyPlanContract.timeZone. */ startTime?: string; [k: string]: unknown; @@ -1844,6 +1853,70 @@ export interface EnergyAccountDetailV3 extends EnergyAccountBaseV2 { [k: string]: unknown; } +export interface EnergyAccountDetailV4 extends EnergyAccountBaseV2 { + /** + * The array of plans containing service points and associated plan details + */ + plans: Array<{ + /** + * Optional display name for the plan provided by the customer to help differentiate multiple plans + */ + nickname?: string; + /** + * An array of servicePointIds, representing NMIs, that this account is linked to + */ + servicePointIds: string[]; + /** + * Mandatory if openStatus is OPEN + */ + planOverview?: { + /** + * The name of the plan if one exists + */ + displayName?: string; + /** + * The start date of the applicability of this plan + */ + startDate: string; + /** + * The end date of the applicability of this plan + */ + endDate?: string; + }; + /** + * Detail on the plan applicable to this account. Mandatory if openStatus is OPEN + */ + planDetail?: { + [k: string]: unknown; + }; + /** + * An array of additional contacts that are authorised to act on this account + */ + authorisedContacts?: Array<{ + /** + * For people with single names this field need not be present. The single name should be in the lastName field + */ + firstName?: string; + /** + * For people with single names the single name should be in this field + */ + lastName: string; + /** + * Field is mandatory but array may be empty + */ + middleNames?: string[]; + /** + * Also known as title or salutation. The prefix to the name (e.g. Mr, Mrs, Ms, Miss, Sir, etc) + */ + prefix?: string; + /** + * Used for a trailing suffix to the name (e.g. Jr) + */ + suffix?: string; + }>; + }>; +} + /* These are the schema definitions stipulated by the Data Standards Body for the energy api. */ export interface EnergyAccountListResponseV2 { @@ -4045,6 +4118,61 @@ export interface EnergyPlanContractV2 { variation?: string | null; [k: string]: unknown; } + +export interface EnergyPlanContractV3 { + /** + * Free text field containing additional information of the fees for this contract + */ + additionalFeeInformation?: string | null; + controlledLoad?: EnergyPlanControlledLoadV2[]; + discounts?: EnergyPlanDiscounts[]; + eligibility?: EnergyPlanEligibility[]; + fees?: EnergyPlanFees[]; + greenPowerCharges?: EnergyPlanGreenPowerCharges[]; + incentives?: EnergyPlanIncentives[]; + /** + * Describes intrinsic green power for the plan. If present then the plan includes a percentage of green power in the base plan. Should not be present for gas contracts + */ + intrinsicGreenPower?: { + /** + * Percentage of green power intrinsically included in the plan + */ + greenPercentage: string; + } | null; + /** + * Flag indicating whether prices are fixed or variable + */ + isFixed: boolean; + /** + * Free text field that describes what will occur on or prior to expiry of the fixed contract term or benefit period + */ + onExpiryDescription?: string | null; + /** + * Payment options for this contract + */ + paymentOption: Array<("PAPER_BILL" | "CREDIT_CARD" | "DIRECT_DEBIT" | "BPAY" | "OTHER")>; + /** + * The pricing model for the contract. Contracts for gas must use SINGLE_RATE. Note that the detail for the enumeration values are:
  • **SINGLE_RATE** - all energy usage is charged at a single unit rate no matter when it is consumed. Multiple unit rates may exist that correspond to varying volumes of usage i.e. a ‘block’ or ‘step’ tariff (first 50kWh @ X cents, next 50kWh at Y cents etc.
  • **SINGLE_RATE_CONT_LOAD** - as above, but with an additional, separate unit rate charged for all energy usage from a controlled load i.e. separately metered appliance like hot water service, pool pump etc.
  • **TIME_OF_USE** - energy usage is charged at unit rates that vary dependent on time of day and day of week that the energy is consumed
  • **TIME_OF_USE_CONT_LOAD** - as above, but with an additional, separate unit rate charged for all energy usage from a controlled load i.e. separately metered appliance like hot water service, pool pump etc.
  • **FLEXIBLE** - energy usage is charged at unit rates that vary based on external factors
  • **FLEXIBLE_CONT_LOAD** - as above, but with an additional, separate unit rate charged for all energy usage from a controlled load i.e. separately metered appliance like hot water service, pool pump etc.
  • **QUOTA** - all energy usage is charged at a single fixed rate, up to a specified usage quota/allowance. All excess usage beyond the allowance is then charged at a single unit rate (may not be the best way to explain it but it is essentially a ‘subscription’ or telco style product i.e. $50/month for up to 150kWh included usage
+ */ + pricingModel: + | "SINGLE_RATE" + | "SINGLE_RATE_CONT_LOAD" + | "TIME_OF_USE" + | "TIME_OF_USE_CONT_LOAD" + | "FLEXIBLE" + | "FLEXIBLE_CONT_LOAD" + | "QUOTA"; + solarFeedInTariff?: EnergyPlanSolarFeedInTariffV3[]; + tariffPeriod: EnergyPlanTariffPeriodV2[]; + /** + * Required if pricingModel is set to TIME_OF_USE. Defines the time zone to use for calculation of the time of use thresholds. Defaults to AEST if absent + */ + timeZone?: ("LOCAL" | "AEST") | null; + /** + * Free text description of price variation policy and conditions for the contract. Mandatory if `isFixed` is false + */ + variation?: string | null; +} /* These are the schema definitions stipulated by the Data Standards Body for the energy api. */ export interface EnergyPlanContractFull extends EnergyPlanContractV2 { @@ -4106,6 +4234,33 @@ export interface EnergyPlanContractFullV2 extends EnergyPlanContractV2 { } /* These are the schema definitions stipulated by the Data Standards Body for the energy api. */ +export interface EnergyPlanContractFullV3 extends EnergyPlanContractV3 { + /** + * The term for the contract. If absent assumes no specified term + */ + termType?: "1_YEAR" | "2_YEAR" | "3_YEAR" | "4_YEAR" | "5_YEAR" | "ONGOING" | "OTHER"; + /** + * Description of the benefit period. Should only be present if termType has the value ONGOING + */ + benefitPeriod?: string; + /** + * Free text description of the terms for the contract + */ + terms?: string; + /** + * An array of the meter types that this contract is available for + */ + meterTypes?: string[]; + /** + * Number of days in the cooling off period for the contract. Mandatory for plans with type of MARKET + */ + coolingOffDays?: number; + /** + * An array of the available billing schedules for this contract. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) + */ + billFrequency: string[]; +} + /** * Required if pricing model is SINGLE_RATE_CONT_LOAD or TIME_OF_USE_CONT_LOAD or FLEXIBLE_CONT_LOAD */ @@ -4234,101 +4389,270 @@ export interface EnergyPlanControlledLoad { }>; [k: string]: unknown; } -/* These are the schema definitions stipulated by the Data Standards Body for the energy api. */ -export interface EnergyPlanDetail extends EnergyPlan { +/** + * Required if pricing model is SINGLE_RATE_CONT_LOAD or TIME_OF_USE_CONT_LOAD or FLEXIBLE_CONT_LOAD + */ +export interface EnergyPlanControlledLoadV2 { /** - * Charges for metering included in the plan + * A display name for the controlled load + */ + displayName: string; + /** + * Optional end date of the application of the controlled load rate + */ + endDate?: string; + /** + * Specifies the type of controlloed load rate + */ + rateBlockUType: "singleRate" | "timeOfUseRates"; + /** + * Object representing a single controlled load rate. Required if rateBlockUType is singleRate */ - meteringCharges?: { + singleRate?: { /** - * Display name of the charge + * The daily supply charge (exclusive of GST) for this controlled load tier */ - displayName: string; + dailySupplyCharge?: string; /** - * Description of the charge + * Description of the controlled load rate */ description?: string; /** - * Minimum value of the charge if the charge is a range or the absolute value of the charge if no range is specified + * Display name of the controlled load rate */ - minimumValue: string; + displayName: string; /** - * The upper limit of the charge if the charge could occur in a range + * Usage period for which the block rate applies. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax). Defaults to P1Y if absent */ - maximumValue?: string; + period?: string; /** - * The charges that occur on a schedule indicates the frequency. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) + * Array of controlled load rates in order of usage volume */ - period?: string; - [k: string]: unknown; + rates: Array<{ + /** + * The measurement unit of rate. Assumed to be KWH if absent + */ + measureUnit?: "KWH" | "KVA" | "KVAR" | "KVARH" | "KW" | "DAYS" | "METER" | "MONTH"; + /** + * Unit price of usage per measure unit (exclusive of GST) + */ + unitPrice: string; + /** + * Volume in kWh that this rate applies to. Only applicable for ‘stepped’ rates where different rates apply for different volumes of usage in a period + */ + volume?: number; + }>; }; /** - * The details of the terms for the supply of electricity under this plan. Is mandatory if fuelType is set to GAS or DUAL - */ - gasContract?: EnergyPlanContractFull; - /** - * The details of the terms for the supply of electricity under this plan. Is mandatory if fuelType is set to ELECTRICITY or DUAL + * Optional start date of the application of the controlled load rate */ - electricityContract?: EnergyPlanContractFull; - [k: string]: unknown; -} -/* These are the schema definitions stipulated by the Data Standards Body for the energy api. */ - -export interface EnergyPlanDetailV2 extends EnergyPlan { + startDate?: string; /** - * Charges for metering included in the plan + * Array of objects representing time of use rates. Required if rateBlockUType is timeOfUseRates */ - meteringCharges?: { + timeOfUseRates?: Array<{ /** - * Display name of the charge + * The daily supply charge (exclusive of GST) for this controlled load tier */ - displayName: string; + dailySupplyCharge?: string; /** - * Description of the charge + * Description of the controlled load rate */ description?: string; /** - * Minimum value of the charge if the charge is a range or the absolute value of the charge if no range is specified + * Display name of the controlled load rate */ - minimumValue: string; + displayName: string; /** - * The upper limit of the charge if the charge could occur in a range + * Usage period for which the block rate applies. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax). Defaults to P1Y if absent */ - maximumValue?: string; + period?: string; /** - * The charges that occur on a schedule indicates the frequency. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) + * Array of controlled load rates in order of usage volume */ - period?: string; - [k: string]: unknown; - }; - /** - * The details of the terms for the supply of electricity under this plan. Is mandatory if fuelType is set to GAS or DUAL - */ - gasContract?: EnergyPlanContractFullV2; - /** - * The details of the terms for the supply of electricity under this plan. Is mandatory if fuelType is set to ELECTRICITY or DUAL - */ - electricityContract?: EnergyPlanContractFullV2; - [k: string]: unknown; -} - -/* These are the schema definitions stipulated by the Data Standards Body for the energy api. */ - -/** - * Optional list of discounts available for the contract - */ -export interface EnergyPlanDiscounts { - /** - * The type of the discount. Mandatory if the discount type is CONDITIONAL - */ - category?: "PAY_ON_TIME" | "DIRECT_DEBIT" | "GUARANTEED_DISCOUNT" | "OTHER"; - /** - * The description of the discount - */ - description?: string; - /** - * The display name of the discount + rates: Array<{ + /** + * The measurement unit of rate. Assumed to be KWH if absent + */ + measureUnit?: "KWH" | "KVA" | "KVAR" | "KVARH" | "KW" | "DAYS" | "METER" | "MONTH"; + /** + * Unit price of usage per measure unit (exclusive of GST) + */ + unitPrice: string; + /** + * Volume in kWh that this rate applies to. Only applicable for ‘stepped’ rates where different rates apply for different volumes of usage in a period + */ + volume?: number; + }>; + /** + * Array of times of use. + */ + timeOfUse: Array<{ + /** + * Display text providing more information on the contrlled load, for e.g. controlled load availability if specific day/time is not known. Required if startTime and endTime absent or if additionalInfoUri provided + */ + additionalInfo?: string; + /** + * Optional link to additional information regarding the controlled load + */ + additionalInfoUri?: string; + /** + * The days that the rate applies to + */ + days?: Array<("SUN" | "MON" | "TUE" | "WED" | "THU" | "FRI" | "SAT" | "PUBLIC_HOLIDAYS")>; + /** + * The end of the time period per day for which the controlled load rate applies. Required if startTime provided. + * + * Formatted according to [ISO 8601 Times](https://en.wikipedia.org/wiki/ISO_8601#Times). If the time is provided without a UTC offset, the time zone will be determined by the value of EnergyPlanContract.timeZone. + */ + endTime?: string; + /** + * The beginning of the time period per day for which the controlled load rate applies. Required if endTime provided. + * + * Formatted according to [ISO 8601 Times](https://en.wikipedia.org/wiki/ISO_8601#Times). If the time is provided without a UTC offset, the time zone will be determined by the value of EnergyPlanContract.timeZone. + */ + startTime?: string; + }>; + /** + * The type of usage that the rate applies to + */ + type: "PEAK" | "OFF_PEAK" | "SHOULDER" | "SOLAR_SPONGE"; + }>; +} +/* These are the schema definitions stipulated by the Data Standards Body for the energy api. */ + +export interface EnergyPlanDetail extends EnergyPlan { + /** + * Charges for metering included in the plan + */ + meteringCharges?: Array<{ + /** + * Display name of the charge + */ + displayName: string; + /** + * Description of the charge + */ + description?: string; + /** + * Minimum value of the charge if the charge is a range or the absolute value of the charge if no range is specified + */ + minimumValue: string; + /** + * The upper limit of the charge if the charge could occur in a range + */ + maximumValue?: string; + /** + * The charges that occur on a schedule indicates the frequency. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) + */ + period?: string; + [k: string]: unknown; + }>; + /** + * The details of the terms for the supply of electricity under this plan. Is mandatory if fuelType is set to GAS or DUAL + */ + gasContract?: EnergyPlanContractFull; + /** + * The details of the terms for the supply of electricity under this plan. Is mandatory if fuelType is set to ELECTRICITY or DUAL + */ + electricityContract?: EnergyPlanContractFull; + [k: string]: unknown; +} +/* These are the schema definitions stipulated by the Data Standards Body for the energy api. */ + +export interface EnergyPlanDetailV2 extends EnergyPlan { + /** + * Charges for metering included in the plan + */ + meteringCharges?: Array<{ + /** + * Display name of the charge + */ + displayName: string; + /** + * Description of the charge + */ + description?: string; + /** + * Minimum value of the charge if the charge is a range or the absolute value of the charge if no range is specified + */ + minimumValue: string; + /** + * The upper limit of the charge if the charge could occur in a range + */ + maximumValue?: string; + /** + * The charges that occur on a schedule indicates the frequency. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) + */ + period?: string; + [k: string]: unknown; + }>; + /** + * The details of the terms for the supply of electricity under this plan. Is mandatory if fuelType is set to GAS or DUAL + */ + gasContract?: EnergyPlanContractFullV2; + /** + * The details of the terms for the supply of electricity under this plan. Is mandatory if fuelType is set to ELECTRICITY or DUAL + */ + electricityContract?: EnergyPlanContractFullV2; + [k: string]: unknown; +} + +export interface EnergyPlanDetailV3 extends EnergyPlan { + /** + * Charges for metering included in the plan + */ + meteringCharges?: Array<{ + /** + * Display name of the charge + */ + displayName: string; + /** + * Description of the charge + */ + description?: string; + /** + * Minimum value of the charge if the charge is a range or the absolute value of the charge if no range is specified + */ + minimumValue: string; + /** + * The upper limit of the charge if the charge could occur in a range + */ + maximumValue?: string; + /** + * The charges that occur on a schedule indicates the frequency. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) + */ + period?: string; + [k: string]: unknown; + }>; + /** + * The details of the terms for the supply of electricity under this plan. Is mandatory if fuelType is set to GAS or DUAL + */ + gasContract?: EnergyPlanContractFullV3; + /** + * The details of the terms for the supply of electricity under this plan. Is mandatory if fuelType is set to ELECTRICITY or DUAL + */ + electricityContract?: EnergyPlanContractFullV3; + [k: string]: unknown; +} + +/* These are the schema definitions stipulated by the Data Standards Body for the energy api. */ + +/** + * Optional list of discounts available for the contract + */ +export interface EnergyPlanDiscounts { + /** + * The type of the discount. Mandatory if the discount type is CONDITIONAL + */ + category?: "PAY_ON_TIME" | "DIRECT_DEBIT" | "GUARANTEED_DISCOUNT" | "OTHER"; + /** + * The description of the discount + */ + description?: string; + /** + * The display name of the discount */ displayName: string; /** @@ -4581,6 +4905,17 @@ export interface EnergyPlanResponse { [k: string]: unknown; } +export interface EnergyPlanResponseV2 { + data: EnergyPlanDetailV2; + links: Links; + meta?: Meta; +} + +export interface EnergyPlanResponseV3 { + data: EnergyPlanDetailV3; + links: Links; + meta?: Meta; +} /* These are the schema definitions stipulated by the Data Standards Body for the energy api. */ /** @@ -4732,6 +5067,128 @@ export interface EnergyPlanSolarFeedInTariffV2 { }; [k: string]: unknown; } + +/** + * Array of feed in tariffs for solar power + */ +export interface EnergyPlanSolarFeedInTariffV3 { + /** + * A description of the tariff + */ + description?: string; + /** + * The name of the tariff + */ + displayName: string; + /** + * The end date of the application of the feed in tariff + */ + endDate?: string; + /** + * The type of the payer + */ + payerType: "GOVERNMENT" | "RETAILER"; + /** + * The applicable scheme + */ + scheme: "PREMIUM" | "CURRENT" | "VARIABLE" | "OTHER"; + /** + * Represents a constant tariff. Mandatory if tariffUType is set to singleTariff + */ + singleTariff?: { + /** + * Usage period for which the block rate applies. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax). Defaults to P1Y if absent + */ + period?: string; + /** + * Array of feed in rates + */ + rates: Array<{ + /** + * The measurement unit of rate. Assumed to be KWH if absent + */ + measureUnit?: "KWH" | "KVA" | "KVAR" | "KVARH" | "KW" | "DAYS" | "METER" | "MONTH"; + /** + * Unit price of usage per measure unit (exclusive of GST) + */ + unitPrice: string; + /** + * Volume that this rate applies to. Only applicable for ‘stepped’ rates where different rates apply for different volumes of usage in a period + */ + volume?: number; + [k: string]: unknown; + }>; + [k: string]: unknown; + }; + /** + * The start date of the application of the feed in tariff + */ + startDate?: string; + /** + * The type of the payer + */ + tariffUType: "singleTariff" | "timeVaryingTariffs"; + /** + * Represents a tariff based on time. Mandatory if tariffUType is set to timeVaryingTariffs + */ + timeVaryingTariffs?: Array<{ + /** + * Display name of the tariff + */ + displayName: string; + /** + * Usage period for which the block rate applies. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax). Defaults to P1Y if absent + */ + period?: string; + /** + * Array of feed in rates + */ + rates?: Array<{ + /** + * The measurement unit of rate. Assumed to be KWH if absent + */ + measureUnit?: "KWH" | "KVA" | "KVAR" | "KVARH" | "KW" | "DAYS" | "METER" | "MONTH"; + /** + * Unit price of usage per measure unit (exclusive of GST) + */ + unitPrice: string; + /** + * Volume that this rate applies to. Only applicable for ‘stepped’ rates where different rates apply for different volumes of usage in a period + */ + volume?: number; + [k: string]: unknown; + }>; + /** + * Array of time periods for which this tariff is applicable + */ + timeVariations: Array<{ + /** + * The days that the tariff applies to. At least one entry required + */ + days: Array<("SUN" | "MON" | "TUE" | "WED" | "THU" | "FRI" | "SAT" | "PUBLIC_HOLIDAYS")>; + /** + * The end of the time period per day for which the tariff applies. If absent assumes end of day (ie. one second before midnight). + * + * Formatted according to [ISO 8601 Times](https://en.wikipedia.org/wiki/ISO_8601#Times). If the time is provided without a UTC offset, the time zone will be determined by the value of EnergyPlanContract.timeZone. + */ + endTime?: string; + /** + * The beginning of the time period per day for which the tariff applies. If absent assumes start of day (ie. midnight). + * + * Formatted according to [ISO 8601 Times](https://en.wikipedia.org/wiki/ISO_8601#Times). If the time is provided without a UTC offset, the time zone will be determined by the value of EnergyPlanContract.timeZone. + */ + startTime?: string; + [k: string]: unknown; + }>; + /** + * The type of the charging time period. If absent applies to all periods + */ + type?: "PEAK" | "OFF_PEAK" | "SHOULDER"; + [k: string]: unknown; + }>; + [k: string]: unknown; +} + /* These are the schema definitions stipulated by the Data Standards Body for the energy api. */ /** @@ -4913,6 +5370,219 @@ export interface EnergyPlanTariffPeriod { type?: "ENVIRONMENTAL" | "REGULATED" | "NETWORK" | "METERING" | "RETAIL_SERVICE" | "RCTI" | "OTHER"; [k: string]: unknown; } + +/** + * Array of tariff periods + */ +export interface EnergyPlanTariffPeriodV2 { + /** + * Array representing banded daily supply charge rates. Mandatory if dailySupplyChargeType is BAND + */ + bandedDailySupplyCharges?: Array<{ + /** + * The measurement unit of rate. Assumed to be DAYS if absent + */ + measureUnit?: "KWH" | "KVA" | "KVAR" | "KVARH" | "KW" | "DAYS" | "METER" | "MONTH"; + /** + * The amount of daily supply charge for the band, in dollars per day exclusive of GST + */ + unitPrice: string; + /** + * Volume the charge applies to + */ + volume?: number; + [k: string]: unknown; + }>; + /** + * The amount of access charge for the tariff period, in dollars per day exclusive of GST. Mandatory if dailySupplyChargeType is SINGLE + */ + dailySupplyCharge?: string; + /** + * Specifies if daily supply charge is single or banded. Default value is SINGLE if field not provided + */ + dailySupplyChargeType?: "SINGLE" | "BAND"; + /** + * Array of demand charges. Required if rateBlockUType is demandCharges + */ + demandCharges?: Array<{ + /** + * The charge amount per measure unit exclusive of GST + */ + amount: string; + /** + * Charge period for the demand tariff + */ + chargePeriod: "DAY" | "MONTH" | "TARIFF_PERIOD"; + /** + * The days that the demand tariff applies to + */ + days?: Array<("SUN" | "MON" | "TUE" | "WED" | "THU" | "FRI" | "SAT" | "PUBLIC_HOLIDAYS")>; + /** + * Description of the charge + */ + description?: string; + /** + * Display name of the charge + */ + displayName: string; + /** + * End of the period. + * + * Formatted according to [ISO 8601 Times](https://en.wikipedia.org/wiki/ISO_8601#Times). If the time is provided without a UTC offset, the time zone will be determined by the value of EnergyPlanContract.timeZone. + */ + endTime: string; + /** + * Maximum demand for this demand tariff in kW. If present, must be higher than the value of the minDemand field + */ + maxDemand?: string; + /** + * The measurement unit of charge amount. Assumed to be KWH if absent + */ + measureUnit?: "KWH" | "KVA" | "KVAR" | "KVARH" | "KW" | "DAYS" | "METER" | "MONTH"; + /** + * Application period for the demand tariff + */ + measurementPeriod: "DAY" | "MONTH" | "TARIFF_PERIOD"; + /** + * Minimum demand for this demand tariff in kW. If absent then 0 is assumed + */ + minDemand?: string; + /** + * Start of the period. + * + * Formatted according to [ISO 8601 Times](https://en.wikipedia.org/wiki/ISO_8601#Times). If the time is provided without a UTC offset, the time zone will be determined by the value of EnergyPlanContract.timeZone. + */ + startTime: string; + [k: string]: unknown; + }>; + /** + * The name of the tariff period + */ + displayName: string; + /** + * The end date of the tariff period in a calendar year. Formatted in mm-dd format + */ + endDate: string; + /** + * Specifies the type of rate applicable to this tariff period + */ + rateBlockUType: "singleRate" | "timeOfUseRates" | "demandCharges"; + /** + * Object representing a single rate. Required if rateBlockUType is singleRate + */ + singleRate?: { + /** + * Description of the rate + */ + description?: string; + /** + * Display name of the rate + */ + displayName: string; + /** + * The block rate (unit price) for any usage above the included fixed usage, in dollars per kWh inclusive of GST. Only required if pricingModel field is ‘QUOTA’ + */ + generalUnitPrice?: string; + /** + * Usage period for which the block rate applies. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax) + */ + period?: string; + /** + * Array of controlled load rates in order of usage volume + */ + rates: Array<{ + /** + * The measurement unit of rate. Assumed to be KWH if absent + */ + measureUnit?: "KWH" | "KVA" | "KVAR" | "KVARH" | "KW" | "DAYS" | "METER" | "MONTH"; + /** + * Unit price of usage per measure unit (exclusive of GST) + */ + unitPrice: string; + /** + * Volume in kWh that this rate applies to. Only applicable for ‘stepped’ rates where different rates apply for different volumes of usage in a period + */ + volume?: number; + [k: string]: unknown; + }>; + [k: string]: unknown; + }; + /** + * The start date of the tariff period in a calendar year. Formatted in mm-dd format + */ + startDate: string; + /** + * Array of objects representing time of use rates. Required if rateBlockUType is timeOfUseRates + */ + timeOfUseRates?: Array<{ + /** + * Description of the rate + */ + description?: string; + /** + * Display name of the rate + */ + displayName: string; + /** + * Usage period for which the block rate applies. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax). Defaults to P1Y if absent + */ + period?: string; + /** + * Array of controlled load rates in order of usage volume + */ + rates: Array<{ + /** + * The measurement unit of rate. Assumed to be KWH if absent + */ + measureUnit?: "KWH" | "KVA" | "KVAR" | "KVARH" | "KW" | "DAYS" | "METER" | "MONTH"; + /** + * Unit price of usage per measure unit (exclusive of GST) + */ + unitPrice: string; + /** + * Volume in kWh that this rate applies to. Only applicable for ‘stepped’ rates where different rates apply for different volumes of usage in a period + */ + volume?: number; + [k: string]: unknown; + }>; + /** + * Array of times of use + */ + timeOfUse: Array<{ + /** + * The days that the rate applies to + */ + days: Array<("SUN" | "MON" | "TUE" | "WED" | "THU" | "FRI" | "SAT" | "PUBLIC_HOLIDAYS")>; + /** + * End of the period. + * + * Formatted according to [ISO 8601 Times](https://en.wikipedia.org/wiki/ISO_8601#Times). If the time is provided without a UTC offset, the time zone will be determined by the value of EnergyPlanContract.timeZone. + */ + endTime: string; + /** + * Start of the period. + * + * Formatted according to [ISO 8601 Times](https://en.wikipedia.org/wiki/ISO_8601#Times). If the time is provided without a UTC offset, the time zone will be determined by the value of EnergyPlanContract.timeZone. + */ + startTime: string; + [k: string]: unknown; + }>; + /** + * The type of usage that the rate applies to + */ + type: "PEAK" | "OFF_PEAK" | "SHOULDER" | "SHOULDER1" | "SHOULDER2"; + [k: string]: unknown; + }>; + /** + * Specifies the charge specific time zone for calculation of the time of use thresholds. If absent, timezone value in EnergyPlanContract is assumed. + */ + timeZone?: "LOCAL" | "AEST"; + /** + * Type of charge. Assumed to be other if absent + */ + type?: "ENVIRONMENTAL" | "REGULATED" | "NETWORK" | "METERING" | "RETAIL_SERVICE" | "RCTI" | "OTHER"; + [k: string]: unknown; +} /* These are the schema definitions stipulated by the Data Standards Body for the energy api. */ export interface EnergyServicePoint { diff --git a/types/crimsonq/crimsonq-tests.ts b/types/crimsonq/crimsonq-tests.ts index a8467c2a1ed17b..ccc7974c13c33a 100644 --- a/types/crimsonq/crimsonq-tests.ts +++ b/types/crimsonq/crimsonq-tests.ts @@ -25,9 +25,9 @@ import CrimsonQClient = require("crimsonq"); password: "crimsonQ!", // default password with docker image }); CQ; // $ExpectType CrimsonQClient - CQ.redisCommander; // $ExpectType typeof IORedis; - CQ.redisSubscriber; // $ExpectType typeof IORedis; - CQ.command; // $ExpectType Command; + CQ.redisCommander; // $ExpectType { default: RedisStatic; Cluster: ClusterStatic; Command: typeof Command; }; + CQ.redisSubscriber; // $ExpectType { default: RedisStatic; Cluster: ClusterStatic; Command: typeof Command; }; + CQ.command; // $ExpectType Command; await CQ.connect(); // $ExpectType { value: string; error: Error; } diff --git a/types/critters-webpack-plugin/critters-webpack-plugin-tests.ts b/types/critters-webpack-plugin/critters-webpack-plugin-tests.ts index bb82da936d991d..203a00ac79b23a 100644 --- a/types/critters-webpack-plugin/critters-webpack-plugin-tests.ts +++ b/types/critters-webpack-plugin/critters-webpack-plugin-tests.ts @@ -1,15 +1,18 @@ import Critters from "critters-webpack-plugin"; +import { Configuration } from "webpack"; -new Critters({ - compress: true, - external: true, - inlineFonts: false, - preloadFonts: true, - keyframes: "critical", - noscriptFallback: true, - inlineThreshold: 0, - mergeStylesheets: true, - additionalStylesheets: ["./base.css"], - pruneSource: true, - minimumExternalSize: 0, -}); +const critters: Configuration["plugins"] = [ + new Critters({ + compress: true, + external: true, + inlineFonts: false, + preloadFonts: true, + keyframes: "critical", + noscriptFallback: true, + inlineThreshold: 0, + mergeStylesheets: true, + additionalStylesheets: ["./base.css"], + pruneSource: true, + minimumExternalSize: 0, + }), +]; diff --git a/types/critters-webpack-plugin/index.d.ts b/types/critters-webpack-plugin/index.d.ts index d0f120e74ff747..1e9523f939d5bf 100644 --- a/types/critters-webpack-plugin/index.d.ts +++ b/types/critters-webpack-plugin/index.d.ts @@ -1,8 +1,13 @@ -import { Plugin } from "webpack"; +import { Compiler, WebpackPluginInstance } from "webpack"; export default Critters; -declare class Critters extends Plugin { +declare class Critters implements WebpackPluginInstance { constructor(options?: Critters.CrittersOptions); + apply: (compiler: Compiler) => void; + getCssAsset(href: any, style: any): Promise; + checkInlineThreshold(link: any, style: any, sheet: any): boolean; + embedAdditionalStylesheet(document: any): Promise; + pruneSource(style: any, before: any, sheetInverse: any): boolean; } declare namespace Critters { diff --git a/types/critters-webpack-plugin/package.json b/types/critters-webpack-plugin/package.json index 22b9540e1b54b0..1f23b8f0eba0f8 100644 --- a/types/critters-webpack-plugin/package.json +++ b/types/critters-webpack-plugin/package.json @@ -1,12 +1,12 @@ { "private": true, "name": "@types/critters-webpack-plugin", - "version": "2.5.9999", + "version": "3.0.9999", "projects": [ "https://github.com/GoogleChromeLabs/critters" ], "dependencies": { - "@types/webpack": "^4" + "@types/webpack": "^5" }, "devDependencies": { "@types/critters-webpack-plugin": "workspace:." diff --git a/types/css-mediaquery/css-mediaquery-tests.ts b/types/css-mediaquery/css-mediaquery-tests.ts index 4656409f118125..bf0b5d93ffaeb4 100644 --- a/types/css-mediaquery/css-mediaquery-tests.ts +++ b/types/css-mediaquery/css-mediaquery-tests.ts @@ -2,7 +2,7 @@ import { Expression, match, parse } from "css-mediaquery"; // @ts-expect-error match("(min-width: 800)"); -// $ExpectType +// $ExpectType boolean match("(min-width: 800)", {}); match("(min-width: 800)", { width: 300 }); match("(min-width: 800)", { width: "300px" }); diff --git a/types/css-tree/css-tree-tests.ts b/types/css-tree/css-tree-tests.ts index 9360ed9e0ff3d0..d8ab1cbdeeb5a3 100644 --- a/types/css-tree/css-tree-tests.ts +++ b/types/css-tree/css-tree-tests.ts @@ -90,6 +90,7 @@ csstree.generate(ast, { return handlers.result.call(handlers); }, }), + mode: "spec", }); const property = csstree.property("*-vendor-property"); // $ExpectType Property diff --git a/types/css-tree/index.d.ts b/types/css-tree/index.d.ts index b9c7c918ec46b4..e293fa6936dc79 100644 --- a/types/css-tree/index.d.ts +++ b/types/css-tree/index.d.ts @@ -528,6 +528,7 @@ export interface GenerateHandlers { export interface GenerateOptions { sourceMap?: boolean | undefined; decorator?: ((handlers: GenerateHandlers) => GenerateHandlers) | undefined; + mode?: "safe" | "spec" | undefined; } export function generate(ast: CssNode, options?: GenerateOptions): string; diff --git a/types/culori/all/index.d.ts b/types/culori/all/index.d.ts new file mode 100644 index 00000000000000..9513ec36b9a271 --- /dev/null +++ b/types/culori/all/index.d.ts @@ -0,0 +1,31 @@ +export { + a98, + cubehelix, + dlab, + dlch, + hsi, + hsl, + hsv, + hwb, + jab, + jch, + lab, + lab65, + lch, + lch65, + lchuv, + lrgb, + luv, + okhsl, + okhsv, + oklab, + oklch, + p3, + prophoto, + rec2020, + rgb, + xyb, + xyz50, + xyz65, + yiq, +} from "../index"; diff --git a/types/culori/css/index.d.ts b/types/culori/css/index.d.ts new file mode 100644 index 00000000000000..3778524821ac00 --- /dev/null +++ b/types/culori/css/index.d.ts @@ -0,0 +1,19 @@ +export { + a98, + hsl, + hsv, + hwb, + lab, + lab65, + lch, + lch65, + lrgb, + oklab, + oklch, + p3, + prophoto, + rec2020, + rgb, + xyz50, + xyz65, +} from "../index"; diff --git a/types/culori/fn/index.d.ts b/types/culori/fn/index.d.ts index ae45af2dd00825..22f21c8ba2bb21 100644 --- a/types/culori/fn/index.d.ts +++ b/types/culori/fn/index.d.ts @@ -70,8 +70,7 @@ export { interpolatorSplineMonotoneClosed, } from "../src/interpolate/splineMonotone"; -export { clampChroma, clampRgb } from "../src/clamp"; -export { default as displayable } from "../src/displayable"; +export { clampChroma, clampGamut, clampRgb, displayable, inGamut, toGamut } from "../src/clamp"; export { default as lerp } from "../src/interpolate/lerp"; export { getMode, removeParser, useMode, useParser } from "../src/modes"; export { default as nearest } from "../src/nearest"; diff --git a/types/culori/index.d.ts b/types/culori/index.d.ts index 15a1057c6d4c9a..cbd5baa4165c22 100644 --- a/types/culori/index.d.ts +++ b/types/culori/index.d.ts @@ -25,6 +25,7 @@ import modeP3 from "./src/p3/definition"; import modeProphoto from "./src/prophoto/definition"; import modeRec2020 from "./src/rec2020/definition"; import modeRgb from "./src/rgb/definition"; +import modeXyb from "./src/xyb/definition"; import modeXyz50 from "./src/xyz50/definition"; import modeXyz65 from "./src/xyz65/definition"; import modeYiq from "./src/yiq/definition"; @@ -72,8 +73,7 @@ export { interpolatorSplineMonotoneClosed, } from "./src/interpolate/splineMonotone"; -export { clampChroma, clampRgb } from "./src/clamp"; -export { default as displayable } from "./src/displayable"; +export { clampChroma, clampGamut, clampRgb, displayable, inGamut, toGamut } from "./src/clamp"; export { default as lerp } from "./src/interpolate/lerp"; export { getMode, removeParser, useMode, useParser } from "./src/modes"; export { default as nearest } from "./src/nearest"; @@ -172,6 +172,8 @@ export { default as convertProphotoToXyz50 } from "./src/prophoto/convertProphot export { default as convertXyz50ToProphoto } from "./src/prophoto/convertXyz50ToProphoto"; export { default as convertRec2020ToXyz65 } from "./src/rec2020/convertRec2020ToXyz65"; export { default as convertXyz65ToRec2020 } from "./src/rec2020/convertXyz65ToRec2020"; +export { default as convertRgbToXyb } from "./src/xyb/convertRgbToXyb"; +export { default as convertXybToRgb } from "./src/xyb/convertXybToRgb"; export { default as convertRgbToXyz50 } from "./src/xyz50/convertRgbToXyz50"; export { default as convertXyz50ToRgb } from "./src/xyz50/convertXyz50ToRgb"; export { default as convertRgbToXyz65 } from "./src/xyz65/convertRgbToXyz65"; @@ -207,6 +209,7 @@ export { modeProphoto, modeRec2020, modeRgb, + modeXyb, modeXyz50, modeXyz65, modeYiq, @@ -238,6 +241,7 @@ export const prophoto: ConvertFn<"prophoto">; export const rec2020: ConvertFn<"rec2020">; // tslint:disable-next-line:use-default-type-parameter export const rgb: ConvertFn<"rgb">; +export const xyb: ConvertFn<"xyb">; export const xyz50: ConvertFn<"xyz50">; export const xyz65: ConvertFn<"xyz65">; export const yiq: ConvertFn<"yiq">; @@ -270,6 +274,7 @@ export type { P3 } from "./src/p3/types"; export type { Prophoto } from "./src/prophoto/types"; export type { Rec2020 } from "./src/rec2020/types"; export type { Rgb } from "./src/rgb/types"; +export type { Xyb } from "./src/xyb/types"; export type { Xyz50 } from "./src/xyz50/types"; export type { Xyz65 } from "./src/xyz65/types"; export type { Yiq } from "./src/yiq/types"; diff --git a/types/culori/package.json b/types/culori/package.json index de944f8bc007b9..c9b0011c5dfaac 100644 --- a/types/culori/package.json +++ b/types/culori/package.json @@ -12,6 +12,10 @@ { "name": "Bijela Gora", "githubUsername": "bijela-gora" + }, + { + "name": "Drew Powrs", + "githubUsername": "drwpow" } ] } diff --git a/types/culori/src/clamp.d.ts b/types/culori/src/clamp.d.ts index f3c68318c6fd34..b19a3de26343d9 100644 --- a/types/culori/src/clamp.d.ts +++ b/types/culori/src/clamp.d.ts @@ -1,7 +1,84 @@ -import { Color, GamutMode, Mode } from "./common"; +import { Color, FindColorByMode, GamutMode, Mode } from "./common"; +/** + * Returns whether the color is in the sRGB gamut. + */ +export function displayable(color: Color | string): boolean; + +/** + * Given a color space `mode`, returns a function + * with which to check whether a color is + * in that color space's gamut. + */ +export function inGamut(mode?: Mode): (color: Color | string) => boolean; + +/* + * Obtain a color that's in the sRGB gamut + * by converting it to sRGB and clipping the channel values + * so that they're within the [0, 1] range. + * + * The result is returned in the color's original color space. + */ export function clampRgb(color: string): Color | undefined; export function clampRgb(color: C): C; -export function clampChroma(color: string, mode?: Mode, rgbGamut?: GamutMode): Color | undefined; +/** + * Given the `mode` color space, returns a function + * with which to obtain a color that's in gamut for + * the `mode` color space by clipping the channel values + * so that they fit in their respective ranges. + * + * It's similar to `clampRgb`, but works for any + * bounded color space (RGB or not) for which + * any combination of in-range channel values + * produces an in-gamut color. + */ +export function clampGamut(mode?: M): (color: Color | string) => FindColorByMode | undefined; + +/** + * Obtain a color that’s in a RGB gamut (by default sRGB) + * by first converting it to `mode` and then finding + * the greatest chroma value that fits the gamut. + * + * By default, the CIELCh color space is used, + * but any color that has a chroma component will do. + * + * The result is returned in the color's original color space. + */ +export function clampChroma( + color: string, + mode?: Mode, + rgbGamut?: GamutMode, +): Color | undefined; export function clampChroma(color: C, mode?: Mode, rgbGamut?: GamutMode): C; + +/* + * Obtain a color that's in the `dest` gamut, + * by first converting it to the `mode` color space + * and then finding the largest chroma that's in gamut, + * similar to `clampChroma`. + * + * The color returned is in the `dest` color space. + * + * To address the shortcomings of `clampChroma`, which can + * sometimes produce colors more desaturated than necessary, + * the test used in the binary search is replaced with + * "is color is roughly in gamut", by comparing the candidate + * to the clipped version (obtained with `clampGamut`). + * The test passes if the colors are not too dissimilar, + * judged by the `delta` color difference function + * and an associated `jnd` just-noticeable difference value. + * + * The default arguments for this function correspond to the + * gamut mapping algorithm defined in CSS Color Level 4: + * https://drafts.csswg.org/css-color/#css-gamut-mapping + * + * To disable the “roughly in gamut” part, pass either + * `null` for the `delta` parameter, or zero for `jnd`. + */ +export function toGamut( + dest: M, + mode: Mode, + delta?: number | null, + jnd?: number, +): (color: string | Color) => FindColorByMode; diff --git a/types/culori/src/common.d.ts b/types/culori/src/common.d.ts index 4ae656f05eec10..43ba5e1f60df0c 100644 --- a/types/culori/src/common.d.ts +++ b/types/culori/src/common.d.ts @@ -23,6 +23,7 @@ import { P3 } from "./p3/types"; import { Prophoto } from "./prophoto/types"; import { Rec2020 } from "./rec2020/types"; import { Rgb } from "./rgb/types"; +import { Xyb } from "./xyb/types"; import { Xyz50 } from "./xyz50/types"; import { Xyz65 } from "./xyz65/types"; import { Yiq } from "./yiq/types"; @@ -53,6 +54,7 @@ export type Color = | Prophoto | Rec2020 | Rgb + | Xyb | Xyz50 | Xyz65 | Yiq; diff --git a/types/culori/src/displayable.d.ts b/types/culori/src/displayable.d.ts deleted file mode 100644 index 4c78d008802452..00000000000000 --- a/types/culori/src/displayable.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -import { Color } from "./common"; - -export default function displayable(color: Color | string): boolean; diff --git a/types/culori/src/xyb/constants.d.ts b/types/culori/src/xyb/constants.d.ts new file mode 100644 index 00000000000000..8ff7594d71464a --- /dev/null +++ b/types/culori/src/xyb/constants.d.ts @@ -0,0 +1,2 @@ +export const bias: number; +export const bias_cbrt: number; diff --git a/types/culori/src/xyb/convertRgbToXyb.d.ts b/types/culori/src/xyb/convertRgbToXyb.d.ts new file mode 100644 index 00000000000000..30af0f35e4efcd --- /dev/null +++ b/types/culori/src/xyb/convertRgbToXyb.d.ts @@ -0,0 +1,6 @@ +import { Rgb } from "../rgb/types"; +import { Xyb } from "./types"; + +declare function convertRgbToXyb(rgb: Omit): Xyb; + +export default convertRgbToXyb; diff --git a/types/culori/src/xyb/convertXybToRgb.d.ts b/types/culori/src/xyb/convertXybToRgb.d.ts new file mode 100644 index 00000000000000..03009b12dde438 --- /dev/null +++ b/types/culori/src/xyb/convertXybToRgb.d.ts @@ -0,0 +1,6 @@ +import { Rgb } from "../rgb/types"; +import { Xyb } from "./types"; + +declare function convertXybToRgb(color: Omit): Rgb; + +export default convertXybToRgb; diff --git a/types/culori/src/xyb/definition.d.ts b/types/culori/src/xyb/definition.d.ts new file mode 100644 index 00000000000000..5cf92b124d4ed5 --- /dev/null +++ b/types/culori/src/xyb/definition.d.ts @@ -0,0 +1,35 @@ +import { fixupAlpha } from "../fixup/alpha"; +import { interpolatorLinear } from "../interpolate/linear"; +import convertRgbToXyb from "./convertRgbToXyb"; +import convertXybToRgb from "./convertXybToRgb"; + +declare const definition: { + mode: "xyb"; + parse: ["xyz-d50", "--xyz-d50"]; + serialize: "xyz-d50"; + + toMode: { + rgb: typeof convertXybToRgb; + }; + + fromMode: { + rgb: typeof convertRgbToXyb; + }; + + channels: ["x", "y", "z", "alpha"]; + + ranges: { + x: [0, 0.964]; + y: [0, 0.999]; + z: [0, 0.825]; + }; + + interpolate: { + x: typeof interpolatorLinear; + y: typeof interpolatorLinear; + b: typeof interpolatorLinear; + alpha: { use: typeof interpolatorLinear; fixup: typeof fixupAlpha }; + }; +}; + +export default definition; diff --git a/types/culori/src/xyb/types.d.ts b/types/culori/src/xyb/types.d.ts new file mode 100644 index 00000000000000..6e8e6db7206344 --- /dev/null +++ b/types/culori/src/xyb/types.d.ts @@ -0,0 +1,7 @@ +export interface Xyb { + mode: "xyb"; + x: number; + y: number; + b: number; + alpha?: number; +} diff --git a/types/culori/test/clamp.test.ts b/types/culori/test/clamp.test.ts index 6a4d6b3fb88b79..980dcd41e64cd5 100644 --- a/types/culori/test/clamp.test.ts +++ b/types/culori/test/clamp.test.ts @@ -1,4 +1,4 @@ -import { clampChroma, clampRgb, Lch } from "culori/fn"; +import { clampChroma, clampGamut, clampRgb, displayable, inGamut, Lch, toGamut } from "culori/fn"; const lch1 = "lch(50% 50 90)"; const lch2: Lch = { mode: "lch", l: 50, c: 50, h: 90, alpha: 1 }; @@ -14,3 +14,23 @@ clampChroma(lch1, mode); // $ExpectType Color | undefined clampChroma(lch2, mode); // $ExpectType Lch clampChroma(lch1, mode, gamutMode); // $ExpectType Color | undefined clampChroma(lch2, mode, gamutMode); // $ExpectType Lch + +clampGamut()(lch2); // $ExpectType Rgb | undefined +clampGamut(mode)(lch1); // $ExpectType Lch | undefined +clampGamut(mode)(lch2); // $ExpectType Lch | undefined + +displayable(lch1); // $ExpectType boolean +displayable(lch2); // $ExpectType boolean + +inGamut(mode)(lch1); // $ExpectType boolean +inGamut(mode)(lch2); // $ExpectType boolean + +toGamut("p3", mode)(lch1); // $ExpectType P3 +toGamut("p3", mode)(lch2); // $ExpectType P3 +toGamut("rgb", mode)(lch2); // $ExpectType Rgb +toGamut("lch", mode)(lch2); // $ExpectType Lch +toGamut("p3", mode, 0)(lch1); // $ExpectType P3 +toGamut("p3", mode, 0)(lch2); // $ExpectType P3 +toGamut("p3", mode, null)(lch2); // $ExpectType P3 +toGamut("p3", mode, 0, 0.02)(lch1); // $ExpectType P3 +toGamut("p3", mode, 0, 0.02)(lch2); // $ExpectType P3 diff --git a/types/culori/tsconfig.json b/types/culori/tsconfig.json index 72188e86f9b404..7af5191e536083 100644 --- a/types/culori/tsconfig.json +++ b/types/culori/tsconfig.json @@ -13,6 +13,9 @@ "forceConsistentCasingInFileNames": true }, "files": [ + "all/index.d.ts", + "css/index.d.ts", + "fn/index.d.ts", "index.d.ts", "test/average.test.ts", "test/blend.test.ts", diff --git a/types/cypress-cdp/package.json b/types/cypress-cdp/package.json index 9596713ecc9249..fd873620a668fe 100644 --- a/types/cypress-cdp/package.json +++ b/types/cypress-cdp/package.json @@ -19,7 +19,7 @@ }, { "name": "Louis Loiseau-Billon", - "githubUsername": "LouisLoiseau" + "githubUsername": "seasheepjoe" } ] } diff --git a/types/cytoscape/cytoscape-tests.ts b/types/cytoscape/cytoscape-tests.ts index f836594f1c5f17..42bb01a01d44c0 100644 --- a/types/cytoscape/cytoscape-tests.ts +++ b/types/cytoscape/cytoscape-tests.ts @@ -1034,7 +1034,7 @@ const concentricAllOptions: ConcentricLayoutOptions = { height: 5, width: 3, spacingFactor: 7, - concentric: _node => 6, + concentric: _node => _node.neighborhood().size(), levelWidth: _nodes => 5, animate: true, animationDuration: 50, @@ -1076,3 +1076,6 @@ const coseAllOptions: CoseLayoutOptions = { minTemp: 10.0, }; cy.layout(coseAllOptions); + +const ccn = cy.nodes().closenessCentralityNormalized({ directed: false }); +ccn.closeness(cy.nodes()[0]); diff --git a/types/cytoscape/index.d.ts b/types/cytoscape/index.d.ts index d0f4a52282f40b..99ee5345217701 100644 --- a/types/cytoscape/index.d.ts +++ b/types/cytoscape/index.d.ts @@ -3414,8 +3414,11 @@ declare namespace cytoscape { } /** * http://js.cytoscape.org/#eles.closenessCentralityNormalized - * trivial */ + interface SearchClosenessCentralityNormalizedResult { + /** the normalised closeness centrality of the specified node */ + closeness(node: NodeSingular): any; + } /** * http://js.cytoscape.org/#eles.betweennessCentrality @@ -3600,7 +3603,7 @@ declare namespace cytoscape { */ closenessCentralityNormalized( options: SearchClosenessCentralityNormalizedOptions, - ): SearchDegreeCentralityNormalizedResultDirected | SearchDegreeCentralityNormalizedResultUndirected; + ): SearchClosenessCentralityNormalizedResult; /** * Considering only the elements in the calling collection, * calculate the betweenness centrality of the nodes. @@ -5533,9 +5536,9 @@ declare namespace cytoscape { // Applies a multiplicative factor (>0) to expand or compress the overall area that the nodes take up spacingFactor?: number; // returns numeric value for each node, placing higher nodes in levels towards the centre - concentric?(node: { degree(): number }): number; + concentric?(node: NodeSingular): number; // the variation of concentric values in each level - levelWidth?(node: { maxDegree(): number }): number; + levelWidth?(node: NodeCollection): number; } /** diff --git a/types/cytoscape/package.json b/types/cytoscape/package.json index aa3eb5095c1ddb..c3eebc53e0a198 100644 --- a/types/cytoscape/package.json +++ b/types/cytoscape/package.json @@ -44,10 +44,6 @@ { "name": "Johan Svensson", "githubUsername": "jsve" - }, - { - "name": "Roger Dubbs", - "githubUsername": "rogerdubbs" } ] } diff --git a/types/carbon__icon-helpers/.npmignore b/types/d3-3d/.npmignore similarity index 100% rename from types/carbon__icon-helpers/.npmignore rename to types/d3-3d/.npmignore diff --git a/types/d3-3d/d3-3d-tests.ts b/types/d3-3d/d3-3d-tests.ts new file mode 100644 index 00000000000000..ccc64fa3cbc262 --- /dev/null +++ b/types/d3-3d/d3-3d-tests.ts @@ -0,0 +1,16 @@ +import { triangles3D } from "d3-3d"; +import { select } from "d3-selection"; + +const triangles3d = triangles3D().scale(100).origin({ x: 480, y: 250 }); + +const projectedData = triangles3d([ + [ + { x: 0, y: -1, z: 0 }, + { x: -1, y: 1, z: 0 }, + { x: 1, y: 1, z: 0 }, + ], +]); + +const triangles = select("svg").selectAll("path").data(projectedData); + +console.log(triangles); diff --git a/types/d3-3d/index.d.ts b/types/d3-3d/index.d.ts new file mode 100644 index 00000000000000..6bd5ec17dfc822 --- /dev/null +++ b/types/d3-3d/index.d.ts @@ -0,0 +1,338 @@ +import type { SvgProperties } from "csstype"; + +/** + * A generic type for a 3D generator function, capable of transforming data into 3D shapes. + */ +export interface Shape3DGenerator { + /** + * Generates 3D shapes based on specified parameters and transformations. + * + * @param data The data representing the 3D shapes. + * @returns An array of 3D shapes generated with the specified parameters and transformations. + */ + (data: ShapeInput[]): Shape[]; + + /** + * Sets or retrieves the origin for rendering the 3D shapes. + * + * @param o The origin point for rendering the 3D shapes. + * @returns If no argument is provided, returns the current origin. Otherwise, sets the origin and returns the function. + */ + origin(o: Coordinate2D): Shape3DGenerator; + origin(): Coordinate2D; + + /** + * Sets or retrieves the scale factor for the 3D shapes. + * + * @param s The scale factor for the 3D shapes. + * @returns If no argument is provided, returns the current scale factor. Otherwise, sets the scale factor and returns the function. + */ + scale(s: number): Shape3DGenerator; + scale(): number; + + /** + * Sets or retrieves the rotation angle around the x-axis. + * + * @param ax The rotation angle around the x-axis. + * @returns If no argument is provided, returns the current rotation angle around the x-axis. Otherwise, sets the rotation angle and returns the function. + */ + rotateX(ax: number): Shape3DGenerator; + rotateX(): number; + + /** + * Sets or retrieves the rotation angle around the y-axis. + * + * @param ay The rotation angle around the y-axis. + * @returns If no argument is provided, returns the current rotation angle around the y-axis. Otherwise, sets the rotation angle and returns the function. + */ + rotateY(ay: number): Shape3DGenerator; + rotateY(): number; + + /** + * Sets or retrieves the rotation angle around the z-axis. + * + * @param az The rotation angle around the z-axis. + * @returns If no argument is provided, returns the current rotation angle around the z-axis. Otherwise, sets the rotation angle and returns the function. + */ + rotateZ(az: number): Shape3DGenerator; + rotateZ(): number; + + /** + * Sets or retrieves the rotation center for the 3D shapes. + * + * @param rc The rotation center for the 3D shapes. + * @returns If no argument is provided, returns the current rotation center. Otherwise, sets the rotation center and returns the function. + */ + rotationCenter(rc: Coordinate3D): Shape3DGenerator; + rotationCenter(): Coordinate3D; + + /** + * Sets or retrieves the x-coordinate for the 3D shapes. + * + * @param px The x-coordinate for the 3D shapes. + * @returns If no argument is provided, returns the current x-coordinate. Otherwise, sets the x-coordinate and returns the function. + */ + x(px: number | ((p: Point3D) => number)): Shape3DGenerator; + x(): number; + + /** + * Sets or retrieves the y-coordinate for the 3D shapes. + * + * @param py The y-coordinate for the 3D shapes. + * @returns If no argument is provided, returns the current y-coordinate. Otherwise, sets the y-coordinate and returns the function. + */ + y(py: number | ((p: Point3D) => number)): Shape3DGenerator; + y(): number; + + /** + * Sets or retrieves the z-coordinate for the 3D shapes. + * + * @param pz The z-coordinate for the 3D shapes. + * @returns If no argument is provided, returns the current z-coordinate. Otherwise, sets the z-coordinate and returns the function. + */ + z(pz: number | ((p: Point3D) => number)): Shape3DGenerator; + z(): number; + + /** + * !IMPORT! ONLY FOR gridplanes + * Sets or retrieves the rows for 3d gridplanes. + * + * @param pz The z-coordinate for the 3D shapes. + * @returns If no argument is provided, returns the current rows. Otherwise, sets the rows and returns the function. + */ + rows(pz: number): Shape3DGenerator; + rows(): number; + + /** + * Comparator function to sort objects based on their centroid z-values. + * + * This function compares the z-values of the centroid property of two objects (a and b). + * It returns a negative number if a should come before b, a positive number if a should come after b, + * and 0 if a and b are considered equal in terms of sorting. + * + * @param a The first object to compare. + * @param b The second object to compare. + * @returns A negative, zero, or positive number indicating the sorting order. + * + * @example + * // Sorting an array of objects based on centroid z-values + * const sortedArray = unsortedArray.sort(sort); + */ + sort(a: ShapeInput, b: ShapeInput): number; + + /** + * A function that draws 3D shapes. + */ + draw(shapes: ShapeInput[]): void; +} + +export interface Coordinate2D { + x: number; + y: number; +} + +export interface Coordinate3D { + x: number; + y: number; + z: number; +} + +/** + * A point in 3D space represented by the element. + * Each point has three coordinates which can be accessed via the x, y, and z accessors. + */ +export type Point3DInput = { + x: number; + y: number; + z: number; +} & SvgProperties; + +/** + * A point in 3D space represented by the element. + * Each point has three coordinates which can be accessed via the x, y, and z accessors. + */ +export type Point3D = Point3DInput & { + rotated: Coordinate3D; + centroid: Coordinate3D; + /** + * The projected point in 2D space. + */ + projected: Coordinate2D; +}; + +/** + * A line in 3D space represented by the element, defined by a start and an endpoint. + */ +export type Line3DInput = { + start: Point3DInput; + end: Point3DInput; +} & SvgProperties; + +/** + * A line in 3D space represented by the element, defined by a start and an endpoint. + */ +export type Line3D = { + start: Point3D; + end: Point3D; + centroid: Coordinate3D; +} & SvgProperties; + +/** + * A line strip in 3D space, constructed from an array of lines, represented by the element. + * Every point will be connected to the next point in the input data array. + */ +export type LineStrips3DInput = Line3DInput[]; + +/** + * A line strip in 3D space, constructed from an array of lines, represented by the element. + * Every point will be connected to the next point in the input data array. + */ +export type LineStrips3D = Line3D[]; + +/** + * A triangle in 3D space, defined by three points in counter-clockwise order, represented by the element. + */ +export type Triangle3DInput = [Point3DInput, Point3DInput, Point3DInput]; + +/** + * A triangle in 3D space, defined by three points in counter-clockwise order, represented by the element. + */ +export type Triangle3D = [Point3D, Point3D, Point3D] & { + centroid: Coordinate3D; + /** + * True if the triangle is counter-clockwise + */ + ccw: boolean; +}; + +/** + * A plane in 3D space, defined by four points in counter-clockwise order, represented by the element. + */ +export type Plane3DInput = [Point3DInput, Point3DInput, Point3DInput, Point3DInput]; + +/** + * A plane in 3D space, defined by four points in counter-clockwise order, represented by the element. + */ +export type Plane3D = [Point3D, Point3D, Point3D, Point3D] & { + centroid: Coordinate3D; + /** + * True if the plane is counter-clockwise + */ + ccw: boolean; +}; + +/** + * A grid plane (multiple planes) in 3D space, constructed from an array of points, represented by x planes. + * Note: A grid must always have the same number of points per row. + */ +export type GridPlane3DInput = Point3DInput[]; + +/** + * A grid plane (multiple planes) in 3D space, constructed from an array of points, represented by x planes. + * Note: A grid must always have the same number of points per row. + */ +export type GridPlane3D = Array; + +/** + * A polygon in 3D space, defined by x points in counter-clockwise order, represented by the element. + */ +export type Polygon3DInput = Point3DInput[]; + +/** + * A polygon in 3D space, defined by x points in counter-clockwise order, represented by the element. + */ +export type Polygon3D = Point3D[] & { + centroid: Coordinate3D; + /** + * True if the polygon is counter-clockwise + */ + ccw: boolean; +}; + +/** + * A cube in 3D space, defined by 8 vertices, represented by 4 planes. + */ +export type Cube3DInput = [ + Point3DInput, + Point3DInput, + Point3DInput, + Point3DInput, + Point3DInput, + Point3DInput, + Point3DInput, + Point3DInput, +]; + +/** + * A cube in 3D space, defined by 8 vertices, represented by 4 planes. + */ +export type Cube3D = [Point3D, Point3D, Point3D, Point3D, Point3D, Point3D, Point3D, Point3D] & { + centroid: Coordinate3D; + faces: [Face, Face, Face, Face, Face, Face]; +}; + +export type Face = Plane3D & { face: "front" | "back" | "left" | "right" | "top" | "bottom" }; + +/** + * Creates a new 3D generator for drawing a shape specified by the shape method. + */ +export function _3d(): Shape3DGenerator & { + /** + * Sets or retrieves the shape for the 3D generator. + * + * @param s The shape for the 3D generator. + * @returns If no argument is provided, returns the current shape. Otherwise, sets the shape and returns the function. + */ + shape(s: ShapeKind, row?: number): Shape3DGenerator; + shape(): ShapeKind; +}; + +export type ShapeKind = + | "CUBE" + | "GRID" + | "LINE" + | "LINE_STRIP" + | "PLANE" + | "POINT" + | "SURFACE" + | "TRIANGLE"; + +/** + * Creates a new 3D generator for drawing points. + */ +export function points3D(): Shape3DGenerator; + +/** + * Creates a new 3D generator for drawing lines. + */ +export function lines3D(): Shape3DGenerator; + +/** + * Creates a new 3D generator for drawing line strips. + */ +export function lineStrips3D(): Shape3DGenerator; + +/** + * Creates a new 3D generator for drawing triangles. + */ +export function triangles3D(): Shape3DGenerator; + +/** + * Creates a new 3D generator for drawing planes. + */ +export function planes3D(): Shape3DGenerator; + +/** + * Creates a new 3D generator for drawing grid planes. + */ +export function gridPlanes3D(): Shape3DGenerator; + +/** + * Creates a new 3D generator for drawing polygons. + */ +export function polygons3D(): Shape3DGenerator; + +/** + * Creates a new 3D generator for drawing cubes. + */ +export function cubes3D(): Shape3DGenerator; diff --git a/types/d3-3d/package.json b/types/d3-3d/package.json new file mode 100644 index 00000000000000..448e1a88a1c6ee --- /dev/null +++ b/types/d3-3d/package.json @@ -0,0 +1,22 @@ +{ + "private": true, + "name": "@types/d3-3d", + "version": "1.0.9999", + "projects": [ + "https://github.com/Niekes/d3-3d" + ], + "type": "module", + "dependencies": { + "csstype": "*" + }, + "devDependencies": { + "@types/d3-3d": "workspace:.", + "@types/d3-selection": "*" + }, + "owners": [ + { + "name": "Amin Yahyaabadi", + "githubUsername": "aminya" + } + ] +} diff --git a/types/carbon__icon-helpers/tsconfig.json b/types/d3-3d/tsconfig.json similarity index 86% rename from types/carbon__icon-helpers/tsconfig.json rename to types/d3-3d/tsconfig.json index d62a50b5424514..69972240c31150 100644 --- a/types/carbon__icon-helpers/tsconfig.json +++ b/types/d3-3d/tsconfig.json @@ -3,7 +3,7 @@ "module": "node16", "lib": [ "es6", - "DOM" + "dom" ], "noImplicitAny": true, "noImplicitThis": true, @@ -15,6 +15,6 @@ }, "files": [ "index.d.ts", - "carbon__icon-helpers-tests.ts" + "d3-3d-tests.ts" ] } diff --git a/types/d3-array/d3-array-tests.ts b/types/d3-array/d3-array-tests.ts index a2e246a52178fd..bf5811538d8a19 100644 --- a/types/d3-array/d3-array-tests.ts +++ b/types/d3-array/d3-array-tests.ts @@ -2603,7 +2603,7 @@ const p1: Array = d3Array.permute(testObject, "when" as "when", "more" as "more", ]); -// $ExpectType: Array +// $ExpectType (Date | number[])[] const p2 = d3Array.permute(testObject, ["when" as "when", "more" as "more"]); // @ts-expect-error const p3 = d3Array.permute(testObject, ["when" as "when", "unknown" as "unknown"]); diff --git a/types/d3-array/v2/d3-array-tests.ts b/types/d3-array/v2/d3-array-tests.ts index 16586554276270..bac98ba7b4e752 100644 --- a/types/d3-array/v2/d3-array-tests.ts +++ b/types/d3-array/v2/d3-array-tests.ts @@ -974,7 +974,7 @@ const p1: Array = d3Array.permute(testObject, "when" as "when", "more" as "more", ]); -// $ExpectType: Array +// $ExpectType (Date | number[])[] const p2 = d3Array.permute(testObject, ["when" as "when", "more" as "more"]); // @ts-expect-error const p3 = d3Array.permute(testObject, ["when" as "when", "unknown" as "unknown"]); diff --git a/types/d3-force/index.d.ts b/types/d3-force/index.d.ts index 1ba235193c90a3..8801ae53bed761 100644 --- a/types/d3-force/index.d.ts +++ b/types/d3-force/index.d.ts @@ -465,7 +465,7 @@ export interface ForceCollide extends For strength(): number; /** * Set the force strength to the specified number in the range [0,1] and return this force. - * The default strength is 0.7. + * The default strength is 1. * * Overlapping nodes are resolved through iterative relaxation. * For each node, the other nodes that are anticipated to overlap at the next tick (using the anticipated positions [x + vx,y + vy]) are determined; diff --git a/types/delaunator/delaunator-tests.ts b/types/delaunator/delaunator-tests.ts index 242898bc9a0c95..6c743627cb322f 100644 --- a/types/delaunator/delaunator-tests.ts +++ b/types/delaunator/delaunator-tests.ts @@ -3,6 +3,7 @@ import Delaunator from "delaunator"; // Zipped points [x0, y0, x1, y1, ...] const zippedPoints = [168, 180, 168, 178, 168, 179, 168, 181, 168, 183, 167, 183, 167, 184]; const zipped = new Delaunator(zippedPoints); +const zippedCoords = zipped.coords; // $ExpectType number[] // Default [x, y] const defaultPoints = [ @@ -45,7 +46,7 @@ Delaunator.from(customPoints, getX, getY); const triangles = d.triangles; // $ExpectType Uint32Array const halfedges = d.halfedges; // $ExpectType Int32Array const hull = d.hull; // $ExpectType Uint32Array -const coords = d.coords; // $ExpectType ArrayLike | Float64Array +const coords = d.coords; // $ExpectType Float64Array const coordinates: number[][][] = []; for (let i = 0; i < triangles.length; i += 3) { coordinates.push([defaultPoints[triangles[i]], defaultPoints[triangles[i + 1]], defaultPoints[triangles[i + 2]]]); @@ -65,5 +66,5 @@ for (let i = 0; i < triangles.length; i += 3) { JSON.stringify(coordinates) === JSON.stringify(coordinates2); // update call -(zipped.coords as Float64Array)[0] = 1; +zipped.coords[0] = 1; zipped.update(); diff --git a/types/delaunator/index.d.ts b/types/delaunator/index.d.ts index 9dbe3e15308038..5fbdda7e301081 100644 --- a/types/delaunator/index.d.ts +++ b/types/delaunator/index.d.ts @@ -1,4 +1,4 @@ -declare class Delaunator

{ +declare class Delaunator> { /** * A Uint32Array array of triangle vertex indices (each group of three numbers forms a triangle). * All triangles are directed counterclockwise. @@ -22,24 +22,28 @@ declare class Delaunator

{ /** * An array of input coordinates in the form [x0, y0, x1, y1, ....], of the type provided in the constructor (or Float64Array if you used Delaunator.from). */ - coords: ArrayLike | Float64Array; + coords: A; /** * Constructs a delaunay triangulation object given a typed array of point coordinates of the form: [x0, y0, x1, y1, ...]. * (use a typed array for best performance). */ - constructor(points: ArrayLike); + constructor(points: A); /** * Constructs a delaunay triangulation object given an array of points ([x, y] by default). */ - static from(points: ArrayLike>): Delaunator>; + static from(points: ArrayLike>): Delaunator; /** * Constructs a delaunay triangulation object given an array of custom points. Duplicate points are skipped. * getX and getY are optional functions for custom point formats. Duplicate points are skipped. */ - static from

(points: ArrayLike

, getX: (point: P) => number, getY: (point: P) => number): Delaunator

; + static from

( + points: ArrayLike

, + getX: (point: P) => number, + getY: (point: P) => number, + ): Delaunator; /** * Updates the triangulation if you modified delaunay.coords values in place, avoiding expensive memory diff --git a/types/dockerode/dockerode-tests.ts b/types/dockerode/dockerode-tests.ts index fc9c8f0e5e9593..5ffbc6c96eed87 100644 --- a/types/dockerode/dockerode-tests.ts +++ b/types/dockerode/dockerode-tests.ts @@ -315,7 +315,7 @@ docker.buildImage( }, ); -docker.buildImage(".", { nocache: true }, (err, response) => { +docker.buildImage(".", { nocache: true, version: "2" }, (err, response) => { // NOOP }); diff --git a/types/dockerode/index.d.ts b/types/dockerode/index.d.ts index 4afa950cb9141b..203ee5378d5eed 100644 --- a/types/dockerode/index.d.ts +++ b/types/dockerode/index.d.ts @@ -973,6 +973,13 @@ declare namespace Dockerode { target?: string | undefined; outputs?: string | undefined; nocache?: boolean | undefined; + + /** + * Version of the builder backend to use. + * - `1` is the first generation classic (deprecated) builder in the Docker daemon (default) + * - `2` is [BuildKit](https://github.com/moby/buildkit) + */ + version?: "1" | "2" | undefined; } interface ImageDistributionOptions { diff --git a/types/dockerode/package.json b/types/dockerode/package.json index ea04379306adfc..2affc37751827d 100644 --- a/types/dockerode/package.json +++ b/types/dockerode/package.json @@ -46,10 +46,6 @@ "name": "Pascal Sthamer", "githubUsername": "p4sca1" }, - { - "name": "Stuart Thomson", - "githubUsername": "stuartthomson" - }, { "name": "Luis Rueda", "githubUsername": "userlerueda" diff --git a/types/dom-view-transitions/dom-view-transitions-tests.ts b/types/dom-view-transitions/dom-view-transitions-tests.ts index b3906a5c3de902..43d44b0b70d538 100644 --- a/types/dom-view-transitions/dom-view-transitions-tests.ts +++ b/types/dom-view-transitions/dom-view-transitions-tests.ts @@ -1,11 +1,11 @@ const updateCallback: () => Promise | void = () => {}; // $ExpectType ViewTransition const viewTransition = document.startViewTransition(updateCallback); -// $ExpectType Promise +// $ExpectType Promise const finished = viewTransition.finished; -// $ExpectType Promise +// $ExpectType Promise const ready = viewTransition.ready; -// $ExpectType Promise +// $ExpectType Promise const updateCallbackdone: Promise = viewTransition.updateCallbackDone; // $ExpectType void viewTransition.skipTransition(); diff --git a/types/dom-view-transitions/index.d.ts b/types/dom-view-transitions/index.d.ts index e3cdbe87101c8b..752aea507a71d6 100644 --- a/types/dom-view-transitions/index.d.ts +++ b/types/dom-view-transitions/index.d.ts @@ -3,9 +3,9 @@ interface Document { } interface ViewTransition { - finished: Promise; - ready: Promise; - updateCallbackDone: Promise; + readonly ready: Promise; + readonly finished: Promise; + readonly updateCallbackDone: Promise; skipTransition(): void; } diff --git a/types/dom-view-transitions/package.json b/types/dom-view-transitions/package.json index 2a344c2806a2aa..37124f32943b67 100644 --- a/types/dom-view-transitions/package.json +++ b/types/dom-view-transitions/package.json @@ -7,6 +7,14 @@ "projects": [ "https://drafts.csswg.org/css-view-transitions-1/" ], + "types": "index", + "typesVersions": { + "<=5.5": { + "*": [ + "ts5.5/*" + ] + } + }, "devDependencies": { "@types/dom-view-transitions": "workspace:." }, diff --git a/types/dom-view-transitions/ts5.5/dom-view-transitions-tests.ts b/types/dom-view-transitions/ts5.5/dom-view-transitions-tests.ts new file mode 100644 index 00000000000000..b3906a5c3de902 --- /dev/null +++ b/types/dom-view-transitions/ts5.5/dom-view-transitions-tests.ts @@ -0,0 +1,11 @@ +const updateCallback: () => Promise | void = () => {}; +// $ExpectType ViewTransition +const viewTransition = document.startViewTransition(updateCallback); +// $ExpectType Promise +const finished = viewTransition.finished; +// $ExpectType Promise +const ready = viewTransition.ready; +// $ExpectType Promise +const updateCallbackdone: Promise = viewTransition.updateCallbackDone; +// $ExpectType void +viewTransition.skipTransition(); diff --git a/types/dom-view-transitions/ts5.5/index.d.ts b/types/dom-view-transitions/ts5.5/index.d.ts new file mode 100644 index 00000000000000..e3cdbe87101c8b --- /dev/null +++ b/types/dom-view-transitions/ts5.5/index.d.ts @@ -0,0 +1,14 @@ +interface Document { + startViewTransition(updateCallback: () => Promise | void): ViewTransition; +} + +interface ViewTransition { + finished: Promise; + ready: Promise; + updateCallbackDone: Promise; + skipTransition(): void; +} + +interface CSSStyleDeclaration { + viewTransitionName: string; +} diff --git a/types/fcostarodrigo__walk/tsconfig.json b/types/dom-view-transitions/ts5.5/tsconfig.json similarity index 83% rename from types/fcostarodrigo__walk/tsconfig.json rename to types/dom-view-transitions/ts5.5/tsconfig.json index 5bbe1bda597b93..0df4c0e8420b5e 100644 --- a/types/fcostarodrigo__walk/tsconfig.json +++ b/types/dom-view-transitions/ts5.5/tsconfig.json @@ -3,7 +3,7 @@ "module": "node16", "lib": [ "es6", - "esnext.asynciterable" + "dom" ], "noImplicitAny": true, "noImplicitThis": true, @@ -15,6 +15,6 @@ }, "files": [ "index.d.ts", - "fcostarodrigo__walk-tests.ts" + "dom-view-transitions-tests.ts" ] } diff --git a/types/drawflow/index.d.ts b/types/drawflow/index.d.ts index 9f2b04cb2c64e9..678a5cfed2cc80 100644 --- a/types/drawflow/index.d.ts +++ b/types/drawflow/index.d.ts @@ -630,6 +630,7 @@ export interface DrawflowConnection { } export interface DrawflowConnectionDetail { + output: string; input: string; node: string; } diff --git a/types/drivelist/drivelist-tests.ts b/types/drivelist/drivelist-tests.ts index 8cda5f9d40fd10..6b191e0be2fe9c 100644 --- a/types/drivelist/drivelist-tests.ts +++ b/types/drivelist/drivelist-tests.ts @@ -38,7 +38,7 @@ drivelist.list((error, drives) => { blockSize; // $ExpectType number | null logicalBlockSize; // $ExpectType number | null - mountpoints; // $ExpectType MountPoint[] + mountpoints; // $ExpectType MountPoint[] mountpoints.forEach(mountpoint => { const { path, label } = mountpoint; diff --git a/types/easy-soap-request/package.json b/types/easy-soap-request/package.json index 571292c289b424..be29ef9b2cacce 100644 --- a/types/easy-soap-request/package.json +++ b/types/easy-soap-request/package.json @@ -1,12 +1,12 @@ { "private": true, "name": "@types/easy-soap-request", - "version": "4.1.9999", + "version": "5.6.9999", "projects": [ "https://github.com/circa10a/easy-soap-request" ], "dependencies": { - "axios": "^0.21.1" + "axios": "^1.6.7" }, "devDependencies": { "@types/easy-soap-request": "workspace:." diff --git a/types/electron-progressbar/package.json b/types/electron-progressbar/package.json index 738bf1da75e54e..35d79f489aec94 100644 --- a/types/electron-progressbar/package.json +++ b/types/electron-progressbar/package.json @@ -11,10 +11,5 @@ "devDependencies": { "@types/electron-progressbar": "workspace:." }, - "owners": [ - { - "name": "Samuel Corsi-House", - "githubUsername": "xenfo" - } - ] + "owners": [] } diff --git a/types/ember-data__adapter/test/error.ts b/types/ember-data__adapter/test/error.ts index f5ce442999c619..f491a8dc327b99 100644 --- a/types/ember-data__adapter/test/error.ts +++ b/types/ember-data__adapter/test/error.ts @@ -24,7 +24,7 @@ class MyInvalid extends InvalidError { const invalid = new MyInvalid(); -const isInvalid = invalid instanceof AdapterError; // $ExpectType +const isInvalid = invalid instanceof AdapterError; // $ExpectType boolean -errorsHashToArray({}); // $ExpectType -errorsArrayToHash([]); // $ExpectType<{}> +errorsHashToArray({}); // $ExpectType any[] +errorsArrayToHash([]); // $ExpectType {} diff --git a/types/ember-data__adapter/v3/test/error.ts b/types/ember-data__adapter/v3/test/error.ts index f5ce442999c619..f491a8dc327b99 100644 --- a/types/ember-data__adapter/v3/test/error.ts +++ b/types/ember-data__adapter/v3/test/error.ts @@ -24,7 +24,7 @@ class MyInvalid extends InvalidError { const invalid = new MyInvalid(); -const isInvalid = invalid instanceof AdapterError; // $ExpectType +const isInvalid = invalid instanceof AdapterError; // $ExpectType boolean -errorsHashToArray({}); // $ExpectType -errorsArrayToHash([]); // $ExpectType<{}> +errorsHashToArray({}); // $ExpectType any[] +errorsArrayToHash([]); // $ExpectType {} diff --git a/types/ember-data__store/ember-data__store-tests.ts b/types/ember-data__store/ember-data__store-tests.ts index 93c954b5152cde..eae2acf26de6bc 100644 --- a/types/ember-data__store/ember-data__store-tests.ts +++ b/types/ember-data__store/ember-data__store-tests.ts @@ -26,7 +26,7 @@ declare module "ember-data/types/registries/model" { } // -- actual tests -Store; // $ExpectType -Snapshot; // $ExpectType -normalizeModelName("post"); // $ExpectType -normalizeModelName("post-comment"); // $ExpectType +Store; // $ExpectType typeof Store +Snapshot; // $ExpectType typeof Snapshot +normalizeModelName("post"); // $ExpectType string +normalizeModelName("post-comment"); // $ExpectType string diff --git a/types/ember-data__store/v3/ember-data__store-tests.ts b/types/ember-data__store/v3/ember-data__store-tests.ts index de49e92abc3b84..0df66fc9caf40f 100644 --- a/types/ember-data__store/v3/ember-data__store-tests.ts +++ b/types/ember-data__store/v3/ember-data__store-tests.ts @@ -26,6 +26,6 @@ declare module "ember-data/types/registries/model" { } // -- actual tests -Store; // $ExpectType -normalizeModelName("post"); // $ExpectType -normalizeModelName("post-comment"); // $ExpectType +Store; // $ExpectType typeof Store +normalizeModelName("post"); // $ExpectType string +normalizeModelName("post-comment"); // $ExpectType string diff --git a/types/ember/test/component.ts b/types/ember/test/component.ts index e0c3a8ecc7ac16..c451c223b514d4 100755 --- a/types/ember/test/component.ts +++ b/types/ember/test/component.ts @@ -102,7 +102,7 @@ Component.extend({ tagName: "input", attributeBindings: ["disabled"], disabled: computed(() => { - if ("someLogic") { + if ("bogus" > "logic") { return true; } else { return false; diff --git a/types/ember/v2/test/component.ts b/types/ember/v2/test/component.ts index e0c3a8ecc7ac16..c451c223b514d4 100755 --- a/types/ember/v2/test/component.ts +++ b/types/ember/v2/test/component.ts @@ -102,7 +102,7 @@ Component.extend({ tagName: "input", attributeBindings: ["disabled"], disabled: computed(() => { - if ("someLogic") { + if ("bogus" > "logic") { return true; } else { return false; diff --git a/types/ember/v3/test/component.ts b/types/ember/v3/test/component.ts index e0c3a8ecc7ac16..c451c223b514d4 100755 --- a/types/ember/v3/test/component.ts +++ b/types/ember/v3/test/component.ts @@ -102,7 +102,7 @@ Component.extend({ tagName: "input", attributeBindings: ["disabled"], disabled: computed(() => { - if ("someLogic") { + if ("bogus" > "logic") { return true; } else { return false; diff --git a/types/ember__component/test/component.ts b/types/ember__component/test/component.ts index dba66c212d5c17..fcf9c49ee0a9f4 100644 --- a/types/ember__component/test/component.ts +++ b/types/ember__component/test/component.ts @@ -101,7 +101,7 @@ Component.extend({ tagName: "input", attributeBindings: ["disabled"], disabled: computed(() => { - if ("someLogic") { + if ("bogus" > "logic") { return true; } else { return false; diff --git a/types/ember__component/v3/test/component.ts b/types/ember__component/v3/test/component.ts index b6c6612bc47f68..5dd7d03e4885dd 100644 --- a/types/ember__component/v3/test/component.ts +++ b/types/ember__component/v3/test/component.ts @@ -101,7 +101,7 @@ Component.extend({ tagName: "input", attributeBindings: ["disabled"], disabled: computed(() => { - if ("someLogic") { + if ("bogus" > "logic") { return true; } else { return false; diff --git a/types/ember__helper/ember__helper-tests.ts b/types/ember__helper/ember__helper-tests.ts index 2eb700010acc2b..da4a4cfff37142 100644 --- a/types/ember__helper/ember__helper-tests.ts +++ b/types/ember__helper/ember__helper-tests.ts @@ -1,10 +1,11 @@ -import { array, capabilities, concat, fn, get, hash, invokeHelper, setHelperManager } from "@ember/helper"; +import { array, capabilities, concat, fn, get, hash, invokeHelper, setHelperManager, uniqueId } from "@ember/helper"; array; // $ExpectType ArrayHelper concat; // $ExpectType ConcatHelper fn; // $ExpectType FnHelper get; // $ExpectType GetHelper hash; // $ExpectType HashHelper +uniqueId; // $ExpectType UniqueIdHelper invokeHelper; // $ExpectType (context: object, definition: object, computeArgs?: ((context: object) => Partial) | undefined) => Cache -capabilities; // $ExpectType (factory: ManagerFactory>, obj: T) => T -setHelperManager; // $ExpectType (factory: ManagerFactory>, obj: T) => T +capabilities; // $ExpectType (managerAPI: Version, options?: Partial | undefined) => HelperCapabilities || (managerAPI: Version, options?: Partial | undefined) => HelperCapabilities +setHelperManager; // $ExpectType (factory: ManagerFactory>, obj: T) => T || (factory: ManagerFactory>, obj: T) => T diff --git a/types/ember__helper/index.d.ts b/types/ember__helper/index.d.ts index 2f907ddac076bf..91669a84415754 100644 --- a/types/ember__helper/index.d.ts +++ b/types/ember__helper/index.d.ts @@ -12,6 +12,7 @@ export interface ConcatHelper extends Opaque<"helper:concat"> {} export interface FnHelper extends Opaque<"helper:fn"> {} export interface GetHelper extends Opaque<"helper:get"> {} export interface HashHelper extends Opaque<"helper:hash"> {} +export interface UniqueIdHelper extends Opaque<"helper:unique-id"> {} /** * Use the `{{array}}` helper to create an array to pass as an option to your components. @@ -49,6 +50,14 @@ export const get: GetHelper; */ export const hash: HashHelper; +/** + * Use the `{{unique-id}}` helper to generate a unique ID string suitable for use as an ID + * attribute in the DOM. + * + * @see https://api.emberjs.com/ember/release/classes/Ember.Templates.helpers/methods/unique-id?anchor=unique-id + */ +export const uniqueId: UniqueIdHelper; + /** `capabilities` returns a capabilities configuration which can be used to modify the behavior of the manager. Manager capabilities _must_ be provided using the diff --git a/types/encoding-japanese/index.d.ts b/types/encoding-japanese/index.d.ts index 97104d53b901a1..10892b0bb7cc87 100644 --- a/types/encoding-japanese/index.d.ts +++ b/types/encoding-japanese/index.d.ts @@ -33,7 +33,7 @@ export interface ConvertStringOptions { to: Encoding; from?: Encoding | undefined; type: "string"; - fallback?: "html-entity" | "html-entity-hex"; + fallback?: "html-entity" | "html-entity-hex" | "ignore" | "error"; bom?: boolean | string | undefined; } @@ -41,7 +41,7 @@ export interface ConvertArrayBufferOptions { to: Encoding; from?: Encoding | undefined; type: "arraybuffer"; - fallback?: "html-entity" | "html-entity-hex"; + fallback?: "html-entity" | "html-entity-hex" | "ignore" | "error"; bom?: boolean | string | undefined; } @@ -49,14 +49,14 @@ export interface ConvertArrayOptions { to: Encoding; from?: Encoding | undefined; type: "array"; - fallback?: "html-entity" | "html-entity-hex"; + fallback?: "html-entity" | "html-entity-hex" | "ignore" | "error"; bom?: boolean | string | undefined; } export interface ConvertUnknownOptions { to: Encoding; from?: Encoding | undefined; - fallback?: "html-entity" | "html-entity-hex"; + fallback?: "html-entity" | "html-entity-hex" | "ignore" | "error"; bom?: boolean | string | undefined; } diff --git a/types/encoding-japanese/package.json b/types/encoding-japanese/package.json index 60edfbc03f9e9a..8af227b199ab0e 100644 --- a/types/encoding-japanese/package.json +++ b/types/encoding-japanese/package.json @@ -1,7 +1,7 @@ { "private": true, "name": "@types/encoding-japanese", - "version": "2.0.9999", + "version": "2.2.9999", "projects": [ "https://github.com/polygonplanet/encoding.js" ], diff --git a/types/encoding-japanese/test/encoding-japanese-tests.cjs.ts b/types/encoding-japanese/test/encoding-japanese-tests.cjs.ts index e7287f47973647..d1cab3a03688f0 100644 --- a/types/encoding-japanese/test/encoding-japanese-tests.cjs.ts +++ b/types/encoding-japanese/test/encoding-japanese-tests.cjs.ts @@ -50,6 +50,24 @@ const sjisArray4 = Encoding.convert("🐙", { sjisArray4; // $ExpectType string // fallback: '🐙' +const sjisArray5 = Encoding.convert("🐙", { + to: "SJIS", // to_encoding + from: "UTF8", // from_encoding + type: "string", + fallback: "ignore", +}); +sjisArray5; // $ExpectType string +// fallback: '' + +const sjisArray6 = Encoding.convert("🐙", { + to: "SJIS", // to_encoding + from: "UTF8", // from_encoding + type: "string", + fallback: "error", +}); +sjisArray6; // $ExpectType string +// throws error: `Character cannot be represented` + const utf8String = "ã\u0081\u0093ã\u0082\u0093ã\u0081«ã\u0081¡ã\u0081¯"; const unicodeString = Encoding.convert(utf8String, { to: "UNICODE", @@ -120,7 +138,7 @@ if (isSJIS) { // Encoding is SJIS' } -const sjisArray5 = [ +const sjisArray7 = [ 130, 177, 130, @@ -145,7 +163,7 @@ const sjisArray5 = [ 230, ]; -const encoded = Encoding.urlEncode(sjisArray5); // $ExpectType string +const encoded = Encoding.urlEncode(sjisArray7); // $ExpectType string // encoded: '%82%B1%82%F1%82%C9%82%BF%82%CD%81A%82%D9%82%B0%81%99%82%D2%82%E6' const decoded = Encoding.urlDecode(encoded); // $ExpectType number[] @@ -154,8 +172,8 @@ const decoded = Encoding.urlDecode(encoded); // $ExpectType number[] // 65, 130, 217, 130, 176, 129, 153, 130, 210, 130, 230 // ] -const sjisArray6 = [130, 177, 130, 241, 130, 201, 130, 191, 130, 205]; -const encoded2 = Encoding.base64Encode(sjisArray6); // $ExpectType string +const sjisArray8 = [130, 177, 130, 241, 130, 201, 130, 191, 130, 205]; +const encoded2 = Encoding.base64Encode(sjisArray8); // $ExpectType string // encoded2: 'grGC8YLJgr+CzQ==' const decoded2 = Encoding.base64Decode(encoded2); // $ExpectType number[] diff --git a/types/es-abstract/test/GetIntrinsic.test.ts b/types/es-abstract/test/GetIntrinsic.test.ts index bb1698644e5555..d1af2154695974 100644 --- a/types/es-abstract/test/GetIntrinsic.test.ts +++ b/types/es-abstract/test/GetIntrinsic.test.ts @@ -23,7 +23,7 @@ declare const boolean: boolean; GetIntrinsic("%ArrayBufferPrototype%"); // $ExpectType ArrayBuffer GetIntrinsic("%ArrayIteratorPrototype%"); // $ExpectType IterableIterator - GetIntrinsic("%AsyncFromSyncIteratorPrototype%"); // $ExpectType AsyncGenerator + GetIntrinsic("%AsyncFromSyncIteratorPrototype%"); // $ExpectType AsyncGenerator || AsyncGenerator GetIntrinsic("%AsyncFunction%"); // $ExpectType FunctionConstructor GetIntrinsic("%AsyncFunction.prototype%"); // $ExpectType Function @@ -31,7 +31,7 @@ declare const boolean: boolean; GetIntrinsic("%AsyncGenerator%"); // $ExpectType AsyncGeneratorFunction GetIntrinsic("%AsyncGeneratorFunction%"); // $ExpectType AsyncGeneratorFunctionConstructor - GetIntrinsic("%AsyncGeneratorPrototype%"); // $ExpectType AsyncGenerator + GetIntrinsic("%AsyncGeneratorPrototype%"); // $ExpectType AsyncGenerator || AsyncGenerator GetIntrinsic("%AsyncIteratorPrototype%"); // $ExpectType AsyncIterable GetIntrinsic("%Atomics%"); // $ExpectType Atomics @@ -78,7 +78,7 @@ declare const boolean: boolean; GetIntrinsic("%Generator%"); // $ExpectType GeneratorFunction GetIntrinsic("%GeneratorFunction%"); // $ExpectType GeneratorFunctionConstructor - GetIntrinsic("%GeneratorPrototype%"); // $ExpectType Generator + GetIntrinsic("%GeneratorPrototype%"); // $ExpectType Generator || Generator GetIntrinsic("%IteratorPrototype%"); // $ExpectType Iterable GetIntrinsic("%Int8Array%"); // $ExpectType Int8ArrayConstructor @@ -232,7 +232,7 @@ declare const boolean: boolean; GetIntrinsic("%ArrayBufferPrototype%", false); // $ExpectType ArrayBuffer GetIntrinsic("%ArrayIteratorPrototype%", false); // $ExpectType IterableIterator - GetIntrinsic("%AsyncFromSyncIteratorPrototype%", false); // $ExpectType AsyncGenerator + GetIntrinsic("%AsyncFromSyncIteratorPrototype%", false); // $ExpectType AsyncGenerator || AsyncGenerator GetIntrinsic("%AsyncFunction%", false); // $ExpectType FunctionConstructor GetIntrinsic("%AsyncFunction.prototype%", false); // $ExpectType Function @@ -240,7 +240,7 @@ declare const boolean: boolean; GetIntrinsic("%AsyncGenerator%", false); // $ExpectType AsyncGeneratorFunction GetIntrinsic("%AsyncGeneratorFunction%", false); // $ExpectType AsyncGeneratorFunctionConstructor - GetIntrinsic("%AsyncGeneratorPrototype%", false); // $ExpectType AsyncGenerator + GetIntrinsic("%AsyncGeneratorPrototype%", false); // $ExpectType AsyncGenerator || AsyncGenerator GetIntrinsic("%AsyncIteratorPrototype%", false); // $ExpectType AsyncIterable GetIntrinsic("%Atomics%", false); // $ExpectType Atomics @@ -287,7 +287,7 @@ declare const boolean: boolean; GetIntrinsic("%Generator%", false); // $ExpectType GeneratorFunction GetIntrinsic("%GeneratorFunction%", false); // $ExpectType GeneratorFunctionConstructor - GetIntrinsic("%GeneratorPrototype%", false); // $ExpectType Generator + GetIntrinsic("%GeneratorPrototype%", false); // $ExpectType Generator || Generator GetIntrinsic("%IteratorPrototype%", false); // $ExpectType Iterable GetIntrinsic("%Int8Array%", false); // $ExpectType Int8ArrayConstructor @@ -441,7 +441,7 @@ declare const boolean: boolean; GetIntrinsic("%ArrayBufferPrototype%", true); // $ExpectType ArrayBuffer | undefined GetIntrinsic("%ArrayIteratorPrototype%", true); // $ExpectType IterableIterator | undefined - GetIntrinsic("%AsyncFromSyncIteratorPrototype%", true); // $ExpectType AsyncGenerator | undefined + GetIntrinsic("%AsyncFromSyncIteratorPrototype%", true); // $ExpectType AsyncGenerator | undefined || AsyncGenerator | undefined GetIntrinsic("%AsyncFunction%", true); // $ExpectType FunctionConstructor | undefined GetIntrinsic("%AsyncFunction.prototype%", true); // $ExpectType Function | undefined @@ -449,7 +449,7 @@ declare const boolean: boolean; GetIntrinsic("%AsyncGenerator%", true); // $ExpectType AsyncGeneratorFunction | undefined GetIntrinsic("%AsyncGeneratorFunction%", true); // $ExpectType AsyncGeneratorFunctionConstructor | undefined - GetIntrinsic("%AsyncGeneratorPrototype%", true); // $ExpectType AsyncGenerator | undefined + GetIntrinsic("%AsyncGeneratorPrototype%", true); // $ExpectType AsyncGenerator | undefined || AsyncGenerator | undefined GetIntrinsic("%AsyncIteratorPrototype%", true); // $ExpectType AsyncIterable | undefined GetIntrinsic("%Atomics%", true); // $ExpectType Atomics | undefined @@ -496,7 +496,7 @@ declare const boolean: boolean; GetIntrinsic("%Generator%", true); // $ExpectType GeneratorFunction | undefined GetIntrinsic("%GeneratorFunction%", true); // $ExpectType GeneratorFunctionConstructor | undefined - GetIntrinsic("%GeneratorPrototype%", true); // $ExpectType Generator | undefined + GetIntrinsic("%GeneratorPrototype%", true); // $ExpectType Generator | undefined || Generator | undefined GetIntrinsic("%IteratorPrototype%", true); // $ExpectType Iterable | undefined GetIntrinsic("%Int8Array%", true); // $ExpectType Int8ArrayConstructor | undefined @@ -650,7 +650,7 @@ declare const boolean: boolean; GetIntrinsic("%ArrayBufferPrototype%", boolean); // $ExpectType ArrayBuffer | undefined GetIntrinsic("%ArrayIteratorPrototype%", boolean); // $ExpectType IterableIterator | undefined - GetIntrinsic("%AsyncFromSyncIteratorPrototype%", boolean); // $ExpectType AsyncGenerator | undefined + GetIntrinsic("%AsyncFromSyncIteratorPrototype%", boolean); // $ExpectType AsyncGenerator | undefined || AsyncGenerator | undefined GetIntrinsic("%AsyncFunction%", boolean); // $ExpectType FunctionConstructor | undefined GetIntrinsic("%AsyncFunction.prototype%", boolean); // $ExpectType Function | undefined @@ -658,7 +658,7 @@ declare const boolean: boolean; GetIntrinsic("%AsyncGenerator%", boolean); // $ExpectType AsyncGeneratorFunction | undefined GetIntrinsic("%AsyncGeneratorFunction%", boolean); // $ExpectType AsyncGeneratorFunctionConstructor | undefined - GetIntrinsic("%AsyncGeneratorPrototype%", boolean); // $ExpectType AsyncGenerator | undefined + GetIntrinsic("%AsyncGeneratorPrototype%", boolean); // $ExpectType AsyncGenerator | undefined || AsyncGenerator | undefined GetIntrinsic("%AsyncIteratorPrototype%", boolean); // $ExpectType AsyncIterable | undefined GetIntrinsic("%Atomics%", boolean); // $ExpectType Atomics | undefined @@ -705,7 +705,7 @@ declare const boolean: boolean; GetIntrinsic("%Generator%", boolean); // $ExpectType GeneratorFunction | undefined GetIntrinsic("%GeneratorFunction%", boolean); // $ExpectType GeneratorFunctionConstructor | undefined - GetIntrinsic("%GeneratorPrototype%", boolean); // $ExpectType Generator | undefined + GetIntrinsic("%GeneratorPrototype%", boolean); // $ExpectType Generator | undefined || Generator | undefined GetIntrinsic("%IteratorPrototype%", boolean); // $ExpectType Iterable | undefined GetIntrinsic("%Int8Array%", boolean); // $ExpectType Int8ArrayConstructor | undefined diff --git a/types/es-abstract/test/es2015.test.ts b/types/es-abstract/test/es2015.test.ts index 9fe40123ca6433..be34585fcef94a 100644 --- a/types/es-abstract/test/es2015.test.ts +++ b/types/es-abstract/test/es2015.test.ts @@ -46,7 +46,7 @@ ES2015.Call(Object.prototype.toString, BigInt(Numbe ES2015.Call(Object.prototype.hasOwnProperty, [], ["length"] as const); // $ExpectType boolean ES2015.Call(Object.prototype.hasOwnProperty, any, args as IArguments & [PropertyKey]); // $ExpectType boolean -// $ExpectType IterableIterator +// $ExpectType IterableIterator || BuiltinIterator ES2015.GetIterator([1, 2, 3]); function* generable() { @@ -103,7 +103,7 @@ if (ES2015.IteratorComplete(iteratorResult)) { const anyIterator = any as Iterator; -ES2015.GetMethod(anyIterator, "next"); // $ExpectType (...args: [] | [unknown]) => IteratorResult +ES2015.GetMethod(anyIterator, "next"); // $ExpectType (...args: [] | [unknown]) => IteratorResult || (...[value]: [] | [unknown]) => IteratorResult ES2015.GetMethod(anyIterator, "throw"); // $ExpectType ((e?: any) => IteratorResult) | undefined ES2015.GetMethod(anyIterator, "return"); // $ExpectType ((value?: unknown) => IteratorResult) | undefined diff --git a/types/es-abstract/test/helpers/callBound.test.ts b/types/es-abstract/test/helpers/callBound.test.ts index d77aef201ed479..a950362518f0b7 100644 --- a/types/es-abstract/test/helpers/callBound.test.ts +++ b/types/es-abstract/test/helpers/callBound.test.ts @@ -1,8 +1,8 @@ import callBound = require("es-abstract/helpers/callBound"); -callBound("%ArrayProto_keys%"); // $ExpectType (thisArg: unknown) => IterableIterator -callBound("%ArrayProto_values%"); // $ExpectType (thisArg: unknown) => IterableIterator -callBound("%ArrayProto_entries%"); // $ExpectType (thisArg: unknown) => IterableIterator<[number, any]> +callBound("%ArrayProto_keys%"); // $ExpectType (thisArg: unknown) => IterableIterator || (thisArg: unknown) => BuiltinIterator +callBound("%ArrayProto_values%"); // $ExpectType (thisArg: unknown) => IterableIterator || (thisArg: unknown) => BuiltinIterator +callBound("%ArrayProto_entries%"); // $ExpectType (thisArg: unknown) => IterableIterator<[number, any]> || (thisArg: unknown) => BuiltinIterator<[number, any], any, any> callBound("%ArrayProto_forEach%"); // $ExpectType (thisArg: unknown, callbackfn: (value: any, index: number, array: any[]) => void, thisArg?: any) => void callBound("%ObjProto_toString%"); // $ExpectType (thisArg: unknown) => string diff --git a/types/es-aggregate-error/es-aggregate-error-tests.ts b/types/es-aggregate-error/es-aggregate-error-tests.ts index efc8e067d296df..dcfbc56f97755e 100644 --- a/types/es-aggregate-error/es-aggregate-error-tests.ts +++ b/types/es-aggregate-error/es-aggregate-error-tests.ts @@ -21,19 +21,19 @@ const explicitError: AggregateError = new AggregateError([oneError, otherError], AggregateError.prototype; // $ExpectType AggregateError AggregateError.shim; // $ExpectType () => typeof AggregateError -AggregateError.shim(); // $ExpectType: AggregateError +AggregateError.shim(); // $ExpectType typeof AggregateError -implicitError.errors; // $ExpectType: Array -implicitError.message; // $ExpectType: string -implicitError.name; // $ExpectType: "AggregateError" +implicitError.errors; // $ExpectType ReadonlyArray +implicitError.message; // $ExpectType string +implicitError.name; // $ExpectType "AggregateError" // @ts-expect-error implicitError.name = "something else"; const err = new Error("test"); if (err instanceof AggregateError) { - const aggregateErr: AggregateError = err; // $ExpectType: AggregateError + const aggregateErr: AggregateError = err; // $ExpectType AggregateError // @ts-expect-error const notAggregateErr: typeof AggregateError = err; - aggregateErr.name; // $ExpectType: "AggregateError" + aggregateErr.name; // $ExpectType "AggregateError" } diff --git a/types/es-get-iterator/es-get-iterator-tests.ts b/types/es-get-iterator/es-get-iterator-tests.ts index 9a3f118d30f136..c3e270737481b0 100644 --- a/types/es-get-iterator/es-get-iterator-tests.ts +++ b/types/es-get-iterator/es-get-iterator-tests.ts @@ -1,21 +1,21 @@ import getIterator = require("es-get-iterator"); -// $ExpectType Iterator +// $ExpectType Iterator || Iterator getIterator("foo"); -// $ExpectType Iterator +// $ExpectType Iterator || Iterator getIterator([]); -// $ExpectType Iterator +// $ExpectType Iterator || Iterator getIterator([0, 1, 2, 3, 4]); -// $ExpectType Iterator +// $ExpectType Iterator || Iterator getIterator([undefined, true, "bar", 0]); -// $ExpectType Iterator<[symbol, unknown], any, undefined> +// $ExpectType Iterator<[symbol, unknown], any, undefined> || Iterator<[symbol, unknown], any, any> getIterator(new Map()); -// $ExpectType Iterator +// $ExpectType Iterator || Iterator getIterator(new Set()); // $ExpectType Iterator<"foo" | "bar", void, unknown> || Iterator<"foo" | "bar", void, any> @@ -32,19 +32,19 @@ getIterator((function*() { })()); declare const ARGUMENTS: IArguments; -// $ExpectType Iterator +// $ExpectType Iterator || Iterator getIterator(ARGUMENTS); declare const ITERABLE_UNION: number[] | Set; -// $ExpectType Iterator | Iterator +// $ExpectType Iterator | Iterator || Iterator | Iterator getIterator(ITERABLE_UNION); declare const ITERABLE_OR_OTHERS_UNION: Map | ArrayBuffer; -// $ExpectType Iterator<[Error, DataView], any, undefined> | undefined +// $ExpectType Iterator<[Error, DataView], any, undefined> | undefined || Iterator<[Error, DataView], any, any> | undefined getIterator(ITERABLE_OR_OTHERS_UNION); declare const UNKNOWN: unknown; -// $ExpectType Iterator | undefined +// $ExpectType Iterator | undefined || Iterator | undefined getIterator(UNKNOWN); // $ExpectType undefined diff --git a/types/es-get-iterator/index.d.ts b/types/es-get-iterator/index.d.ts index b3531a9cf13cde..b588003a99d961 100644 --- a/types/es-get-iterator/index.d.ts +++ b/types/es-get-iterator/index.d.ts @@ -1,9 +1,9 @@ -interface Iterable { +interface Iterable { [Symbol.iterator](): Iterator; } type InferIterable = T extends Iterable ? Iterator - : unknown extends T ? Iterator | undefined + : unknown extends T ? Iterator | undefined : undefined; declare function getIterator(iterable: T): InferIterable; diff --git a/types/eslint/.npmignore b/types/eslint/.npmignore index 93e307400a5456..c67ec9de1648b7 100644 --- a/types/eslint/.npmignore +++ b/types/eslint/.npmignore @@ -3,3 +3,4 @@ !**/*.d.cts !**/*.d.mts !**/*.d.*.ts +/v8/ diff --git a/types/eslint/eslint-tests.ts b/types/eslint/eslint-tests.ts index cdba8903c004a1..fe4e99010f06eb 100644 --- a/types/eslint/eslint-tests.ts +++ b/types/eslint/eslint-tests.ts @@ -1,5 +1,12 @@ -import { AST, ESLint, Linter, Rule, RuleTester, Scope, SourceCode } from "eslint"; +import { AST, ESLint, Linter, loadESLint, Rule, RuleTester, Scope, SourceCode } from "eslint"; import { ESLintRules } from "eslint/rules"; +import { + builtinRules, + FileEnumerator, + FlatESLint, + LegacyESLint, + shouldUseFlatConfig, +} from "eslint/use-at-your-own-risk"; import { Comment, PrivateIdentifier, PropertyDefinition, StaticBlock, WhileStatement } from "estree"; const SOURCE = `var foo = bar;`; @@ -52,9 +59,6 @@ sourceCode.getLines(); sourceCode.getAllComments(); -sourceCode.getComments(AST).leading; -sourceCode.getComments(AST).trailing; - sourceCode.getJSDocComment(AST); // $ExpectType Comment | null sourceCode.getNodeByRangeIndex(0); @@ -319,32 +323,12 @@ reference.isReadWrite(); // #region Rule -let mixedRule: Rule.OldStyleRule | Rule.RuleModule; - -mixedRule = { - create(context) { - return {}; - }, -}; - -mixedRule = (context) => ({}); - -let oldStyleRule: Rule.OldStyleRule; - -oldStyleRule = (context) => ({}); +const oldStyleRule = (context: Rule.RuleContext) => ({}); -// @ts-expect-error -oldStyleRule.schema = []; -// @ts-expect-error -oldStyleRule.schema = {}; - -// @ts-expect-error -oldStyleRule.meta = {}; +let rule: Rule.RuleModule; // @ts-expect-error -oldStyleRule.create = (context) => ({}); - -let rule: Rule.RuleModule; +rule = oldStyleRule; rule = { create(context) { @@ -367,8 +351,8 @@ rule = { category: "Possible Errors", recommended: true, url: "https://eslint.org/docs/rules/no-console", - suggestion: true, }, + hasSuggestions: true, }, }; rule = { @@ -389,6 +373,12 @@ rule = { }, meta: { schema: [{ enum: ["always", "never"] }] }, }; +rule = { + create(context) { + return {}; + }, + meta: { schema: false }, +}; rule = { create(context) { return {}; @@ -514,8 +504,12 @@ rule = { }); return { - onCodePathStart(codePath, node) {}, - onCodePathEnd(codePath, node) {}, + onCodePathStart(codePath, node) { + const origin: Rule.CodePathOrigin = codePath.origin; + }, + onCodePathEnd(codePath, node) { + const origin: Rule.CodePathOrigin = codePath.origin; + }, onCodePathSegmentStart(segment, node) {}, onCodePathSegmentEnd(segment, node) {}, onCodePathSegmentLoop(fromSegment, toSegment, node) {}, @@ -575,6 +569,7 @@ linter.verify(SOURCE, { parserOptions: { ecmaVersion: 2021 } }, "test.js"); linter.verify(SOURCE, { parserOptions: { ecmaVersion: 2022 } }, "test.js"); linter.verify(SOURCE, { parserOptions: { ecmaVersion: 2023 } }, "test.js"); linter.verify(SOURCE, { parserOptions: { ecmaVersion: 2024 } }, "test.js"); +linter.verify(SOURCE, { parserOptions: { ecmaVersion: 2025 } }, "test.js"); linter.verify(SOURCE, { parserOptions: { ecmaVersion: "latest" } }, "test.js"); linter.verify(SOURCE, { parserOptions: { ecmaVersion: 6, ecmaFeatures: { globalReturn: true } } }, "test.js"); linter.verify( @@ -642,8 +637,6 @@ for (const msg of lintingResult) { msg.column = 0; msg.endColumn = 0; - msg.source = SOURCE; - if (msg.fix) { msg.fix.text = "foo"; msg.fix.range = [0, 0]; @@ -709,6 +702,17 @@ linter.defineParser("custom-parser", { }, }); +linter.getFixPassCount(); // $ExpectType number + +((index: number, ruleId: string) => { + const pass = linter.getTimes().passes[index]; + pass.fix.total; // $ExpectType number + pass.parse.total; // $ExpectType number + pass.rules![ruleId].total; // $ExpectType number + delete pass.rules; + pass.total; // $ExpectType number +}); + const _processor: Linter.Processor = { name: "foo", version: "1.2.3", @@ -752,6 +756,7 @@ linterWithFlatConfig.verify(SOURCE, [{ languageOptions: { ecmaVersion: 2021 } }] linterWithFlatConfig.verify(SOURCE, [{ languageOptions: { ecmaVersion: 2022 } }], "test.js"); linterWithFlatConfig.verify(SOURCE, [{ languageOptions: { ecmaVersion: 2023 } }], "test.js"); linterWithFlatConfig.verify(SOURCE, [{ languageOptions: { ecmaVersion: 2024 } }], "test.js"); +linterWithFlatConfig.verify(SOURCE, [{ languageOptions: { ecmaVersion: 2025 } }], "test.js"); linterWithFlatConfig.verify(SOURCE, [{ languageOptions: { ecmaVersion: "latest" } }], "test.js"); linterWithFlatConfig.verify(SOURCE, [{ languageOptions: { ecmaVersion: 6 } }], "test.js"); linterWithFlatConfig.verify( @@ -793,9 +798,14 @@ linterWithFlatConfig.verify( linterWithFlatConfig.verify(SOURCE, [{ rules: { "no-console": "warn" } }], "test.js"); linterWithFlatConfig.verify(SOURCE, [{ rules: { "no-console": "off" } }], "test.js"); -// #endregion +linterWithFlatConfig.verify(SOURCE, { linterOptions: {} }, "test.js"); +linterWithFlatConfig.verify(SOURCE, { linterOptions: {} }, { filename: "test.js" }); +linterWithFlatConfig.verifyAndFix(SOURCE, { linterOptions: {} }, "test.js"); +linterWithFlatConfig.verifyAndFix(SOURCE, { linterOptions: {} }, { filename: "test.js" }); -// # region Linter with eslintrc config +// #endregion Linter with flat config + +// #region Linter with eslintrc config const linterWithEslintrcConfig = new Linter({ configType: "eslintrc" }); @@ -816,6 +826,7 @@ linterWithEslintrcConfig.verify(SOURCE, { parserOptions: { ecmaVersion: 2021 } } linterWithEslintrcConfig.verify(SOURCE, { parserOptions: { ecmaVersion: 2022 } }, "test.js"); linterWithEslintrcConfig.verify(SOURCE, { parserOptions: { ecmaVersion: 2023 } }, "test.js"); linterWithEslintrcConfig.verify(SOURCE, { parserOptions: { ecmaVersion: 2024 } }, "test.js"); +linterWithEslintrcConfig.verify(SOURCE, { parserOptions: { ecmaVersion: 2025 } }, "test.js"); linterWithEslintrcConfig.verify(SOURCE, { parserOptions: { ecmaVersion: "latest" } }, "test.js"); linterWithEslintrcConfig.verify( SOURCE, @@ -871,165 +882,315 @@ linterWithEslintrcConfig.verify(SOURCE, { rules: { "no-console": "off" } }, "tes linterWithEslintrcConfig.getRules(); -// #endregion +// #endregion Linter with eslintrc config + +// #endregion Linter // #region ESLint -let eslint: ESLint; - -eslint = new ESLint(); -eslint = new ESLint({ allowInlineConfig: false }); -eslint = new ESLint({ baseConfig: {} }); -eslint = new ESLint({ overrideConfig: {} }); -eslint = new ESLint({ overrideConfigFile: "foo" }); -eslint = new ESLint({ cache: true }); -eslint = new ESLint({ cacheLocation: "foo" }); -eslint = new ESLint({ cacheStrategy: "content" }); -eslint = new ESLint({ cwd: "foo" }); -eslint = new ESLint({ errorOnUnmatchedPattern: true }); -eslint = new ESLint({ extensions: ["js"] }); -eslint = new ESLint({ fix: true }); -eslint = new ESLint({ fix: message => false }); -eslint = new ESLint({ fixTypes: ["problem"] }); -eslint = new ESLint({ globInputPaths: true }); -eslint = new ESLint({ ignore: true }); -eslint = new ESLint({ ignorePath: "foo" }); -eslint = new ESLint({ useEslintrc: false }); -eslint = new ESLint({ plugins: { foo: {} } }); -eslint = new ESLint({ - plugins: { - bar: { - name: "bar", - version: "1.0.0", - meta: { +{ + let eslint: ESLint; + + eslint = new ESLint(); + eslint = new ESLint({ allowInlineConfig: false }); + eslint = new ESLint({ baseConfig: {} }); + eslint = new ESLint({ overrideConfig: {} }); + eslint = new ESLint({ overrideConfigFile: "foo" }); + eslint = new ESLint({ cache: true }); + eslint = new ESLint({ cacheLocation: "foo" }); + eslint = new ESLint({ cacheStrategy: "content" }); + eslint = new ESLint({ cwd: "foo" }); + eslint = new ESLint({ errorOnUnmatchedPattern: true }); + eslint = new ESLint({ fix: true }); + eslint = new ESLint({ fix: message => false }); + eslint = new ESLint({ fixTypes: ["directive", "problem"] }); + eslint = new ESLint({ flags: ["foo", "bar"] }); + eslint = new ESLint({ globInputPaths: true }); + eslint = new ESLint({ ignore: true }); + eslint = new ESLint({ ignorePatterns: ["foo", "bar"] }); + eslint = new ESLint({ plugins: { foo: {} } }); + eslint = new ESLint({ + ruleFilter({ severity }) { + return severity === 1; + }, + }); + eslint = new ESLint({ stats: true }); + eslint = new ESLint({ + plugins: { + bar: { name: "bar", version: "1.0.0", - }, - configs: { - myConfig: { - noInlineConfig: true, + meta: { + name: "bar", + version: "1.0.0", }, - }, - environments: { - production: { - parserOptions: { - ecmaVersion: 6, + configs: { + myConfig: { + noInlineConfig: true, + }, + production: { + languageOptions: { + ecmaVersion: 6, + }, }, }, - }, - processors: { - myProcessor: { - name: "blah", - version: "1.2.3", - meta: { + processors: { + myProcessor: { name: "blah", version: "1.2.3", + meta: { + name: "blah", + version: "1.2.3", + }, + supportsAutofix: false, }, - supportsAutofix: false, }, - }, - rules: { - myRule: { - create(context) { - return {}; + rules: { + myRule: { + create(context) { + return {}; + }, + meta: {}, }, - meta: {}, }, }, }, - }, -}); -eslint = new ESLint({ reportUnusedDisableDirectives: "error" }); -// @ts-expect-error -eslint = new ESLint({ reportUnusedDisableDirectives: 2 }); -eslint = new ESLint({ resolvePluginsRelativeTo: "test" }); -eslint = new ESLint({ rulePaths: ["foo"] }); + }); -let resultsPromise = eslint.lintFiles(["myfile.js", "lib/"]); + let resultsPromise = eslint.lintFiles(["myfile.js", "lib/"]); -resultsPromise = eslint.lintText(SOURCE, { filePath: "foo" }); + resultsPromise = eslint.lintText(SOURCE, { filePath: "foo" }); -eslint.calculateConfigForFile("./config.json"); + eslint.calculateConfigForFile("./config.json"); -eslint.isPathIgnored("./dist/index.js"); + eslint.isPathIgnored("./dist/index.js"); -let formatterPromise: Promise; + let formatterPromise: Promise; -formatterPromise = eslint.loadFormatter("codeframe"); -formatterPromise = eslint.loadFormatter(); + formatterPromise = eslint.loadFormatter("codeframe"); + formatterPromise = eslint.loadFormatter(); -const customFormatter1: ESLint.Formatter = { format: () => "ok" }; -const customFormatter2: ESLint.Formatter = { format: () => Promise.resolve("ok") }; + const customFormatter1: ESLint.Formatter = { format: () => "ok" }; + const customFormatter2: ESLint.Formatter = { format: () => Promise.resolve("ok") }; -let data: ESLint.LintResultData; -const meta: Rule.RuleMetaData = { - type: "suggestion", - docs: { - description: "disallow unnecessary semicolons", - category: "Possible Errors", - recommended: true, - url: "https://eslint.org/docs/rules/no-extra-semi", - }, - fixable: "code", - schema: [], - messages: { - unexpected: "Unnecessary semicolon.", - }, -}; + let data: ESLint.LintResultData; + const meta: Rule.RuleMetaData = { + type: "suggestion", + docs: { + description: "disallow unnecessary semicolons", + category: "Possible Errors", + recommended: true, + url: "https://eslint.org/docs/rules/no-extra-semi", + }, + fixable: "code", + schema: [], + messages: { + unexpected: "Unnecessary semicolon.", + }, + }; -data = { cwd: "/foo/bar", rulesMeta: { "no-extra-semi": meta } }; + data = { cwd: "/foo/bar", rulesMeta: { "no-extra-semi": meta } }; -const version: string = ESLint.version; + const version: string = ESLint.version; -(async () => { - const results = await resultsPromise; - const formatter = await formatterPromise; + (async () => { + const results: ESLint.LintResult[] = await resultsPromise; + const formatter = await formatterPromise; - const output1: string = await formatter.format(results); - const output2: string = await formatter.format(results, data); + const output: string = await formatter.format(results, data); - eslint.getRulesMetaForResults(results); + eslint.getRulesMetaForResults(results); - ESLint.getErrorResults(results); + ESLint.getErrorResults(results); - ESLint.outputFixes(results); + ESLint.outputFixes(results); + })(); - results[0].errorCount = 0; - results[0].warningCount = 0; - results[0].fixableErrorCount = 0; - results[0].fixableWarningCount = 0; + const hasFooFlag: boolean = eslint.hasFlag("foo"); +} - for (const file of results) { - file.filePath = "foo.js"; +// #endregion - file.errorCount = 0; - file.warningCount = 0; - file.fixableErrorCount = 0; - file.fixableWarningCount = 0; +// #region LegacyESLint + +{ + let eslint: LegacyESLint; + + eslint = new LegacyESLint(); + eslint = new LegacyESLint({ allowInlineConfig: false }); + eslint = new LegacyESLint({ baseConfig: {} }); + eslint = new LegacyESLint({ overrideConfig: {} }); + eslint = new LegacyESLint({ overrideConfigFile: "foo" }); + eslint = new LegacyESLint({ cache: true }); + eslint = new LegacyESLint({ cacheLocation: "foo" }); + eslint = new LegacyESLint({ cacheStrategy: "content" }); + eslint = new LegacyESLint({ cwd: "foo" }); + eslint = new LegacyESLint({ errorOnUnmatchedPattern: true }); + eslint = new LegacyESLint({ extensions: ["js"] }); + eslint = new LegacyESLint({ fix: true }); + eslint = new LegacyESLint({ fix: message => false }); + eslint = new LegacyESLint({ fixTypes: ["directive", "problem"] }); + eslint = new LegacyESLint({ flags: ["foo", "bar"] }); + eslint = new LegacyESLint({ globInputPaths: true }); + eslint = new LegacyESLint({ ignore: true }); + eslint = new LegacyESLint({ ignorePath: "foo" }); + eslint = new LegacyESLint({ useEslintrc: false }); + eslint = new LegacyESLint({ plugins: { foo: {} } }); + eslint = new LegacyESLint({ + plugins: { + bar: { + name: "bar", + version: "1.0.0", + meta: { + name: "bar", + version: "1.0.0", + }, + configs: { + myConfig: { + noInlineConfig: true, + }, + }, + environments: { + production: { + parserOptions: { + ecmaVersion: 6, + }, + }, + }, + processors: { + myProcessor: { + name: "blah", + version: "1.2.3", + meta: { + name: "blah", + version: "1.2.3", + }, + supportsAutofix: false, + }, + }, + rules: { + myRule: { + create(context) { + return {}; + }, + meta: {}, + }, + }, + }, + }, + }); + eslint = new LegacyESLint({ reportUnusedDisableDirectives: "error" }); + // @ts-expect-error + eslint = new LegacyESLint({ reportUnusedDisableDirectives: 2 }); + eslint = new LegacyESLint({ resolvePluginsRelativeTo: "test" }); + eslint = new LegacyESLint({ rulePaths: ["foo"] }); - file.source = "foo"; - file.output = "foo"; + let resultsPromise = eslint.lintFiles(["myfile.js", "lib/"]); - for (const message of file.messages) { - message.ruleId = "foo"; - } + resultsPromise = eslint.lintText(SOURCE, { filePath: "foo" }); - for (const suppressedMessage of file.suppressedMessages) { - suppressedMessage.suppressions = [ - { - kind: "foo", - justification: "just cuz", - }, - ]; - } - } -})(); + eslint.calculateConfigForFile("./config.json"); + + eslint.isPathIgnored("./dist/index.js"); + + let formatterPromise: Promise; + + formatterPromise = eslint.loadFormatter("codeframe"); + formatterPromise = eslint.loadFormatter(); + + const customFormatter1: ESLint.Formatter = { format: () => "ok" }; + const customFormatter2: ESLint.Formatter = { format: () => Promise.resolve("ok") }; + + let data: ESLint.LintResultData; + const meta: Rule.RuleMetaData = { + type: "suggestion", + docs: { + description: "disallow unnecessary semicolons", + category: "Possible Errors", + recommended: true, + url: "https://eslint.org/docs/rules/no-extra-semi", + }, + fixable: "code", + schema: [], + messages: { + unexpected: "Unnecessary semicolon.", + }, + }; + + data = { cwd: "/foo/bar", rulesMeta: { "no-extra-semi": meta } }; + + const version: string = LegacyESLint.version; + + (async () => { + const results: ESLint.LintResult[] = await resultsPromise; + const formatter = await formatterPromise; + + const output: string = await formatter.format(results, data); + + eslint.getRulesMetaForResults(results); + + LegacyESLint.getErrorResults(results); + + LegacyESLint.outputFixes(results); + })(); + + const hasFooFlag: false = eslint.hasFlag("foo"); +} // #endregion +// #region ESLint.LintResult + +let results!: ESLint.LintResult[]; + +for (const result of results) { + result.filePath = "foo.js"; + + result.fatalErrorCount = 0; + result.errorCount = 1; + result.warningCount = 2; + result.fixableErrorCount = 3; + result.fixableWarningCount = 4; + + result.source = "foo"; + result.output = "foo"; + + result.stats = { + fixPasses: 2, + times: { + passes: [{ + parse: { total: 1 }, + fix: { total: 2 }, + total: 3, + }, { + parse: { total: 4 }, + rules: { foo: { total: 0.5 } }, + fix: { total: 5 }, + total: 9, + }], + }, + }; + delete result.stats; + + for (const message of result.messages) { + message.ruleId = "foo"; + } + + for (const suppressedMessage of result.suppressedMessages) { + suppressedMessage.suppressions = [ + { + kind: "foo", + justification: "just cuz", + }, + ]; + } +} + +// #region ESLint.LintResult + // #region ESLintRules -let eslintConfig: Linter.Config; +let eslintConfig: Linter.LegacyConfig; eslintConfig = { rules: { @@ -1062,12 +1223,12 @@ interface TSLinterRules { ]>; } -const eslintConfig2: Linter.Config = eslintConfig; +const eslintConfig2: Linter.LegacyConfig = eslintConfig; eslintConfig2.rules; // $ExpectType Partial | undefined eslintConfig2.overrides?.[1].rules; // $ExpectType Partial | undefined -const eslintConfig3: Linter.Config = eslintConfig2; +const eslintConfig3: Linter.LegacyConfig = eslintConfig2; eslintConfig3.rules; // $ExpectType Partial | undefined eslintConfig3.overrides?.[1].rules; // $ExpectType Partial | undefined @@ -1076,17 +1237,15 @@ eslintConfig3.overrides?.[1].rules; // $ExpectType Partial Promise) {}; + ruleTester.run("simple-valid-test", rule, { valid: ["foo", "bar", { code: "foo", options: [{ allowFoo: true }] }], + invalid: [{ code: "bar", errors: ["baz"] }], }); // #endregion -// #region FlatConfig +// #region Config -((): Linter.FlatConfig => ({ +((): Linter.Config => ({ languageOptions: { parser: { parse: () => AST, @@ -1136,7 +1318,7 @@ ruleTester.run("simple-valid-test", rule, { }, })); -((): Linter.FlatConfig => ({ +((): Linter.Config => ({ languageOptions: { parser: { parseForESLint: () => ({ ast: AST }), @@ -1144,80 +1326,80 @@ ruleTester.run("simple-valid-test", rule, { }, })); -((): Linter.FlatConfig => ({ +((): Linter.Config => ({ languageOptions: { // @ts-expect-error parser: "foo-parser", }, })); -((): Linter.FlatConfig => ({ files: ["abc"] })); -((): Linter.FlatConfig => ({ files: [["abc"]] })); +((): Linter.Config => ({ files: ["abc"] })); +((): Linter.Config => ({ files: [["abc"]] })); -((): Linter.FlatConfig => ({ +((): Linter.Config => ({ // @ts-expect-error // Second level of nesting is not allowed files: ["abc", ["abc"], [["abc"]]], })); -((): Linter.FlatConfig => ({ ignores: ["abc"] })); +((): Linter.Config => ({ ignores: ["abc"] })); -((): Linter.FlatConfig => ({ +((): Linter.Config => ({ // @ts-expect-error // No nesting ignores: ["abc", ["abc"]], })); // @ts-expect-error // Must be an array -((): Linter.FlatConfig => ({ files: "abc" })); +((): Linter.Config => ({ files: "abc" })); // @ts-expect-error // Must be an array -((): Linter.FlatConfig => ({ ignores: "abc" })); +((): Linter.Config => ({ ignores: "abc" })); -((): Linter.FlatConfig => ({ linterOptions: { reportUnusedDisableDirectives: "error" } })); -((): Linter.FlatConfig => ({ linterOptions: { reportUnusedDisableDirectives: "warn" } })); -((): Linter.FlatConfig => ({ linterOptions: { reportUnusedDisableDirectives: "off" } })); -((): Linter.FlatConfig => ({ linterOptions: { reportUnusedDisableDirectives: 2 } })); -((): Linter.FlatConfig => ({ linterOptions: { reportUnusedDisableDirectives: 1 } })); -((): Linter.FlatConfig => ({ linterOptions: { reportUnusedDisableDirectives: 0 } })); -((): Linter.FlatConfig => ({ linterOptions: { reportUnusedDisableDirectives: true } })); -((): Linter.FlatConfig => ({ linterOptions: { reportUnusedDisableDirectives: false } })); +((): Linter.Config => ({ linterOptions: { reportUnusedDisableDirectives: "error" } })); +((): Linter.Config => ({ linterOptions: { reportUnusedDisableDirectives: "warn" } })); +((): Linter.Config => ({ linterOptions: { reportUnusedDisableDirectives: "off" } })); +((): Linter.Config => ({ linterOptions: { reportUnusedDisableDirectives: 2 } })); +((): Linter.Config => ({ linterOptions: { reportUnusedDisableDirectives: 1 } })); +((): Linter.Config => ({ linterOptions: { reportUnusedDisableDirectives: 0 } })); +((): Linter.Config => ({ linterOptions: { reportUnusedDisableDirectives: true } })); +((): Linter.Config => ({ linterOptions: { reportUnusedDisableDirectives: false } })); // @ts-expect-error -((): Linter.FlatConfig => ({ linterOptions: { reportUnusedDisableDirectives: "on" } })); +((): Linter.Config => ({ linterOptions: { reportUnusedDisableDirectives: "on" } })); // @ts-expect-error -((): Linter.FlatConfig => ({ linterOptions: { reportUnusedDisableDirectives: 3 } })); +((): Linter.Config => ({ linterOptions: { reportUnusedDisableDirectives: 3 } })); // @ts-expect-error -((): Linter.FlatConfig => ({ linterOptions: { reportUnusedDisableDirectives: null } })); +((): Linter.Config => ({ linterOptions: { reportUnusedDisableDirectives: null } })); -((): Linter.FlatConfig => ({ name: "eslint:js" })); +((): Linter.Config => ({ name: "eslint:js" })); // @ts-expect-error // Generic passed in does not match the RuleEntry schema -((): Linter.FlatConfig<{ foo?: "bar" }> => ({ +((): Linter.Config<{ foo?: "bar" }> => ({ rules: {}, })); -((): Linter.FlatConfig<{ foo?: Linter.RuleEntry<[1 | 2]> }> => ({ +((): Linter.Config<{ foo?: Linter.RuleEntry<[1 | 2]> }> => ({ rules: { foo: "error", }, })); -((): Linter.FlatConfig<{ foo?: Linter.RuleEntry<[1 | 2]> }> => ({ +((): Linter.Config<{ foo?: Linter.RuleEntry<[1 | 2]> }> => ({ rules: { // @ts-expect-error // Invalid value foo: ["error", 3], }, })); -((): Linter.FlatConfig<{ foo?: Linter.RuleEntry }> => ({ +((): Linter.Config<{ foo?: Linter.RuleEntry }> => ({ rules: { // @ts-expect-error // Unspecified value bar: "error", }, })); -((): Linter.FlatConfig<{ foo: Linter.RuleEntry<[1 | 2]>; [x: string]: Linter.RuleEntry }> => ({ +((): Linter.Config<{ foo: Linter.RuleEntry<[1 | 2]>; [x: string]: Linter.RuleEntry }> => ({ rules: { // @ts-expect-error // Invalid value foo: ["error", 3], @@ -1229,10 +1411,12 @@ ruleTester.run("simple-valid-test", rule, { }, })); -// The following _should_ be an error, but we can't enforce on consumers -// as it requires exactOptionalPropertyTypes: true -// (): Linter.FlatConfig => ({ files: undefined }); -// (): Linter.FlatConfig => ({ ignores: undefined }); +// The following are only errors when `exactOptionalPropertyTypes` is `true`. +// The error can't be enforced on consumers. +// @ts-expect-error +((): Linter.Config => ({ files: undefined })); +// @ts-expect-error +((): Linter.Config => ({ ignores: undefined })); ((): ESLint.Plugin => ({ configs: { @@ -1261,4 +1445,37 @@ ruleTester.run("simple-valid-test", rule, { }, })); +let config!: Linter.Config; +let flatConfig!: Linter.FlatConfig; +config = flatConfig; +flatConfig = config; + +// #endregion Config + +(async (useFlatConfig?: boolean) => { + await loadESLint(); // $ExpectType typeof ESLint | typeof LegacyESLint + await loadESLint({}); // $ExpectType typeof ESLint | typeof LegacyESLint + await loadESLint({ useFlatConfig: undefined }); // $ExpectType typeof ESLint | typeof LegacyESLint + await loadESLint({ useFlatConfig: true }); // $ExpectType typeof ESLint + await loadESLint({ useFlatConfig: false }); // $ExpectType typeof LegacyESLint + await loadESLint({ useFlatConfig }); // $ExpectType typeof ESLint | typeof LegacyESLint + + const DefaultESLint = await loadESLint(); + if (DefaultESLint.configType === "flat") { + const eslint = new DefaultESLint({ stats: true }); // $ExpectType ESLint + } else { + const eslint = new DefaultESLint({ useEslintrc: false }); // $ExpectType LegacyESLint + } +}); + +// #region use-at-your-own-risk + +builtinRules; // $ExpectType Map + +new FileEnumerator(); + +FlatESLint; // $ExpectType typeof ESLint + +shouldUseFlatConfig(); // $ExpectType Promise + // #endregion diff --git a/types/eslint/index.d.ts b/types/eslint/index.d.ts index 2cc90caa655e6b..76dab774b4dc76 100644 --- a/types/eslint/index.d.ts +++ b/types/eslint/index.d.ts @@ -1,7 +1,6 @@ -/// - import * as ESTree from "estree"; import { JSONSchema4 } from "json-schema"; +import { LegacyESLint } from "./use-at-your-own-risk"; export namespace AST { type TokenType = @@ -144,8 +143,6 @@ export class SourceCode { getAncestors(node: ESTree.Node): ESTree.Node[]; - getComments(node: ESTree.Node): { leading: ESTree.Comment[]; trailing: ESTree.Comment[] }; - getDeclaredVariables(node: ESTree.Node): Scope.Variable[]; getJSDocComment(node: ESTree.Node): ESTree.Comment | null; @@ -482,16 +479,9 @@ export namespace SourceCode { // #endregion export namespace Rule { - /** - * TODO: Old style rules are planned to be removed in v9, remove this type then (https://github.com/eslint/rfcs/blob/main/designs/2021-schema-object-rules/README.md) - * @deprecated Use `RuleModule` instead. - */ - type OldStyleRule = RuleModule["create"]; - interface RuleModule { create(context: RuleContext): RuleListener; meta?: RuleMetaData | undefined; - schema?: RuleMetaData["schema"]; } type NodeTypes = ESTree.Node["type"]; @@ -677,13 +667,15 @@ export namespace Rule { | undefined; } + type CodePathOrigin = "program" | "function" | "class-field-initializer" | "class-static-block"; + interface CodePath { id: string; + origin: CodePathOrigin; initialSegment: CodePathSegment; finalSegments: CodePathSegment[]; returnedSegments: CodePathSegment[]; thrownSegments: CodePathSegment[]; - currentSegments: CodePathSegment[]; upper: CodePath | null; childCodePaths: CodePath[]; } @@ -706,11 +698,6 @@ export namespace Rule { recommended?: boolean | undefined; /** Specifies the URL at which the full documentation can be accessed. Code editors often use this to provide a helpful link on highlighted rule violations. */ url?: string | undefined; - /** - * TODO: remove this field in next major release of @types/eslint. - * @deprecated use `meta.hasSuggestions` instead - */ - suggestion?: boolean | undefined; } | undefined; /** Violation and suggestion messages. */ messages?: { [messageId: string]: string } | undefined; @@ -720,11 +707,11 @@ export namespace Rule { */ fixable?: "code" | "whitespace" | undefined; /** - * Specifies the [options](https://eslint.org/docs/latest/developer-guide/working-with-rules#options-schemas) - * so ESLint can prevent invalid [rule configurations](https://eslint.org/docs/latest/user-guide/configuring/rules#configuring-rules). + * Specifies the [options](https://eslint.org/docs/latest/extend/custom-rules#options-schemas) + * so ESLint can prevent invalid [rule configurations](https://eslint.org/docs/latest/use/configure/rules#configuring-rules). * Mandatory for rules with options. */ - schema?: JSONSchema4 | JSONSchema4[] | undefined; + schema?: JSONSchema4 | JSONSchema4[] | false | undefined; /** Indicates whether the rule has been deprecated. Omit if not deprecated. */ deprecated?: boolean | undefined; @@ -752,9 +739,8 @@ export namespace Rule { options: any[]; settings: { [name: string]: any }; parserPath: string | undefined; - languageOptions: Linter.FlatConfig["languageOptions"]; + languageOptions: Linter.LanguageOptions; parserOptions: Linter.ParserOptions; - parserServices: SourceCode.ParserServices; cwd: string; filename: string; physicalFilename: string; @@ -837,7 +823,7 @@ export namespace Rule { // #region Linter export class Linter { - static version: string; + static readonly version: string; version: string; @@ -845,19 +831,23 @@ export class Linter { verify( code: SourceCode | string, - config: Linter.Config | Linter.FlatConfig[], + config: Linter.LegacyConfig | Linter.Config | Linter.Config[], filename?: string, ): Linter.LintMessage[]; verify( code: SourceCode | string, - config: Linter.Config | Linter.FlatConfig[], + config: Linter.LegacyConfig | Linter.Config | Linter.Config[], options: Linter.LintOptions, ): Linter.LintMessage[]; - verifyAndFix(code: string, config: Linter.Config | Linter.FlatConfig[], filename?: string): Linter.FixReport; verifyAndFix( code: string, - config: Linter.Config | Linter.FlatConfig[], + config: Linter.LegacyConfig | Linter.Config | Linter.Config[], + filename?: string, + ): Linter.FixReport; + verifyAndFix( + code: string, + config: Linter.LegacyConfig | Linter.Config | Linter.Config[], options: Linter.FixOptions, ): Linter.FixReport; @@ -869,7 +859,11 @@ export class Linter { getRules(): Map; - defineParser(name: string, parser: Linter.ParserModule): void; + defineParser(name: string, parser: Linter.Parser): void; + + getTimes(): Linter.Stats["times"]; + + getFixPassCount(): Linter.Stats["fixPasses"]; } export namespace Linter { @@ -896,21 +890,21 @@ export namespace Linter { * * @see [Rule Severities](https://eslint.org/docs/latest/use/configure/rules#rule-severities) */ - type RuleLevel = Severity | StringSeverity; + type RuleSeverity = Severity | StringSeverity; /** * An array containing the rule severity level, followed by the rule options. * - * @see [Rules](https://eslint.org/docs/user-guide/configuring/rules) + * @see [Rules](https://eslint.org/docs/latest/use/configure/rules) */ - type RuleLevelAndOptions = Prepend, RuleLevel>; + type RuleSeverityAndOptions = [RuleSeverity, ...Partial]; /** * The severity level for the rule or an array containing the rule severity level, followed by the rule options. * - * @see [Rules](https://eslint.org/docs/user-guide/configuring/rules) + * @see [Rules](https://eslint.org/docs/latest/use/configure/rules) */ - type RuleEntry = RuleLevel | RuleLevelAndOptions; + type RuleEntry = RuleSeverity | RuleSeverityAndOptions; /** * The rules config object is a key/value map of rule names and their severity and options. @@ -927,9 +921,44 @@ export namespace Linter { } /** - * ESLint configuration. + * The ECMAScript version of the code being linted. + */ + type EcmaVersion = + | 3 + | 5 + | 6 + | 7 + | 8 + | 9 + | 10 + | 11 + | 12 + | 13 + | 14 + | 15 + | 16 + | 2015 + | 2016 + | 2017 + | 2018 + | 2019 + | 2020 + | 2021 + | 2022 + | 2023 + | 2024 + | 2025 + | "latest"; + + /** + * The type of JavaScript source code. + */ + type SourceType = "script" | "module" | "commonjs"; + + /** + * ESLint legacy configuration. * - * @see [ESLint Configuration](https://eslint.org/docs/latest/user-guide/configuring/) + * @see [ESLint Legacy Configuration](https://eslint.org/docs/latest/use/configure/) */ interface BaseConfig extends HasRules @@ -939,79 +968,79 @@ export namespace Linter { /** * An environment provides predefined global variables. * - * @see [Environments](https://eslint.org/docs/latest/user-guide/configuring/language-options#specifying-environments) + * @see [Environments](https://eslint.org/docs/latest/use/configure/language-options-deprecated#specifying-environments) */ env?: { [name: string]: boolean } | undefined; /** * Extending configuration files. * - * @see [Extends](https://eslint.org/docs/latest/user-guide/configuring/configuration-files#extending-configuration-files) + * @see [Extends](https://eslint.org/docs/latest/use/configure/configuration-files-deprecated#extending-configuration-files) */ extends?: string | string[] | undefined; /** * Specifying globals. * - * @see [Globals](https://eslint.org/docs/latest/user-guide/configuring/language-options#specifying-globals) + * @see [Globals](https://eslint.org/docs/latest/use/configure/language-options-deprecated#specifying-globals) */ - globals?: { [name: string]: boolean | "off" | "readonly" | "readable" | "writable" | "writeable" } | undefined; + globals?: Linter.Globals | undefined; /** * Disable processing of inline comments. * - * @see [Disabling Inline Comments](https://eslint.org/docs/latest/user-guide/configuring/rules#disabling-inline-comments) + * @see [Disabling Inline Comments](https://eslint.org/docs/latest/use/configure/rules-deprecated#disabling-inline-comments) */ noInlineConfig?: boolean | undefined; /** * Overrides can be used to use a differing configuration for matching sub-directories and files. * - * @see [How do overrides work](https://eslint.org/docs/latest/user-guide/configuring/configuration-files#how-do-overrides-work) + * @see [How do overrides work](https://eslint.org/docs/latest/use/configure/configuration-files-deprecated#how-do-overrides-work) */ overrides?: Array> | undefined; /** * Parser. * - * @see [Working with Custom Parsers](https://eslint.org/docs/latest/developer-guide/working-with-custom-parsers) - * @see [Specifying Parser](https://eslint.org/docs/latest/user-guide/configuring/plugins#configure-a-parser) + * @see [Working with Custom Parsers](https://eslint.org/docs/latest/extend/custom-parsers) + * @see [Specifying Parser](https://eslint.org/docs/latest/use/configure/parser-deprecated) */ parser?: string | undefined; /** * Parser options. * - * @see [Working with Custom Parsers](https://eslint.org/docs/latest/developer-guide/working-with-custom-parsers) - * @see [Specifying Parser Options](https://eslint.org/docs/latest/user-guide/configuring/language-options#specifying-parser-options) + * @see [Working with Custom Parsers](https://eslint.org/docs/latest/extend/custom-parsers) + * @see [Specifying Parser Options](https://eslint.org/docs/latest/use/configure/language-options-deprecated#specifying-parser-options) */ parserOptions?: ParserOptions | undefined; /** * Which third-party plugins define additional rules, environments, configs, etc. for ESLint to use. * - * @see [Configuring Plugins](https://eslint.org/docs/latest/user-guide/configuring/plugins#configure-plugins) + * @see [Configuring Plugins](https://eslint.org/docs/latest/use/configure/plugins-deprecated#configure-plugins) */ plugins?: string[] | undefined; /** * Specifying processor. * - * @see [processor](https://eslint.org/docs/latest/user-guide/configuring/plugins#specify-a-processor) + * @see [processor](https://eslint.org/docs/latest/use/configure/plugins-deprecated#specify-a-processor) */ processor?: string | undefined; /** - * Report unused `ESLint-disable` comments as warning. + * Report unused eslint-disable comments as warning. * - * @see [Report unused `ESLint-disable` comments](https://eslint.org/docs/latest/user-guide/configuring/rules#report-unused-eslint-disable-comments) + * @see [Report unused eslint-disable comments](https://eslint.org/docs/latest/use/configure/rules-deprecated#report-unused-eslint-disable-comments) */ reportUnusedDisableDirectives?: boolean | undefined; /** * Settings. * - * @see [Settings](https://eslint.org/docs/latest/user-guide/configuring/configuration-files#adding-shared-settings) + * @see [Settings](https://eslint.org/docs/latest/use/configure/configuration-files-deprecated#adding-shared-settings) */ settings?: { [name: string]: any } | undefined; } @@ -1032,23 +1061,23 @@ export namespace Linter { } /** - * ESLint configuration. + * ESLint legacy configuration. * - * @see [ESLint Configuration](https://eslint.org/docs/latest/user-guide/configuring/) + * @see [ESLint Legacy Configuration](https://eslint.org/docs/latest/use/configure/) */ - // https://github.com/eslint/eslint/blob/v6.8.0/conf/config-schema.js - interface Config + // https://github.com/eslint/eslint/blob/v8.57.0/conf/config-schema.js + interface LegacyConfig extends BaseConfig { /** * Tell ESLint to ignore specific files and directories. * - * @see [Ignore Patterns](https://eslint.org/docs/latest/user-guide/configuring/ignoring-code) + * @see [Ignore Patterns](https://eslint.org/docs/latest/use/configure/ignore-deprecated#ignorepatterns-in-config-files) */ ignorePatterns?: string | string[] | undefined; /** - * @see [Using Configuration Files](https://eslint.org/docs/latest/user-guide/configuring/configuration-files#using-configuration-files) + * @see [Using Configuration Files](https://eslint.org/docs/latest/use/configure/configuration-files-deprecated#using-configuration-files) */ root?: boolean | undefined; } @@ -1056,7 +1085,7 @@ export namespace Linter { /** * Parser options. * - * @see [Specifying Parser Options](https://eslint.org/docs/user-guide/configuring/language-options#specifying-parser-options) + * @see [Specifying Parser Options](https://eslint.org/docs/latest/use/configure/language-options-deprecated#specifying-parser-options) */ interface ParserOptions { /** @@ -1070,50 +1099,25 @@ export namespace Linter { * * Specifies the version of ECMAScript syntax you want to use. This is used by the parser to determine how to perform scope analysis, and it affects the default * - * @default 2018 - * - * @see https://typescript-eslint.io/architecture/parser/#ecmaversion + * @default 5 */ - ecmaVersion?: - | 3 - | 5 - | 6 - | 7 - | 8 - | 9 - | 10 - | 11 - | 12 - | 13 - | 14 - | 15 - | 2015 - | 2016 - | 2017 - | 2018 - | 2019 - | 2020 - | 2021 - | 2022 - | 2023 - | 2024 - | "latest" - | undefined; + ecmaVersion?: EcmaVersion | undefined; /** - * Set to "script" (default) or "module" if your code is in ECMAScript modules. + * The type of JavaScript source code. Possible values are "script" for + * traditional script files, "module" for ECMAScript modules (ESM), and + * "commonjs" for CommonJS files. * * @default 'script' * - * @see https://eslint.org/docs/latest/user-guide/configuring/language-options#specifying-parser-options + * @see https://eslint.org/docs/latest/use/configure/language-options-deprecated#specifying-parser-options */ - sourceType?: "script" | "module" | undefined; + sourceType?: SourceType | undefined; /** * An object indicating which additional language features you'd like to use. * - * @see https://eslint.org/docs/latest/user-guide/configuring/language-options#specifying-parser-options - * @see https://typescript-eslint.io/architecture/parser#ecmafeatures + * @see https://eslint.org/docs/latest/use/configure/language-options-deprecated#specifying-parser-options */ ecmaFeatures?: { globalReturn?: boolean | undefined; @@ -1151,10 +1155,8 @@ export namespace Linter { messageId?: string | undefined; nodeType?: string | undefined; fatal?: true | undefined; - severity: Severity; + severity: Exclude; fix?: Rule.Fix | undefined; - /** @deprecated Use `linter.getSourceCode()` */ - source?: string | null | undefined; suggestions?: LintSuggestion[] | undefined; } @@ -1178,8 +1180,8 @@ export namespace Linter { } // Temporarily loosen type for just flat config files (see #68232) - type FlatConfigParserModule = - & Omit + type NonESTreeParser = + & Omit & ({ parse(text: string, options?: any): unknown; } | { @@ -1189,13 +1191,15 @@ export namespace Linter { }; }); - type ParserModule = + type ESTreeParser = & ESLint.ObjectMetaProperties & ( | { parse(text: string, options?: any): AST.Program } | { parseForESLint(text: string, options?: any): ESLintParseResult } ); + type Parser = NonESTreeParser | ESTreeParser; + interface ESLintParseResult { ast: AST.Program; parserServices?: SourceCode.ParserServices | undefined; @@ -1208,14 +1212,14 @@ export namespace Linter { filename: string; } - // https://eslint.org/docs/developer-guide/working-with-plugins#processors-in-plugins + // https://eslint.org/docs/latest/extend/plugins#processors-in-plugins interface Processor extends ESLint.ObjectMetaProperties { supportsAutofix?: boolean | undefined; preprocess?(text: string, filename: string): T[]; postprocess?(messages: LintMessage[][], filename: string): LintMessage[]; } - interface FlatConfig { + interface Config { /** * An string to identify the configuration object. Used in error messages and * inspection tools. @@ -1240,56 +1244,12 @@ export namespace Linter { * An object containing settings related to how JavaScript is configured for * linting. */ - languageOptions?: { - /** - * The version of ECMAScript to support. May be any year (i.e., 2022) or - * version (i.e., 5). Set to "latest" for the most recent supported version. - * @default "latest" - */ - ecmaVersion?: ParserOptions["ecmaVersion"]; - - /** - * The type of JavaScript source code. Possible values are "script" for - * traditional script files, "module" for ECMAScript modules (ESM), and - * "commonjs" for CommonJS files. (default: "module" for .js and .mjs - * files; "commonjs" for .cjs files) - */ - sourceType?: "script" | "module" | "commonjs"; - - /** - * An object specifying additional objects that should be added to the - * global scope during linting. - */ - globals?: ESLint.Environment["globals"]; - - /** - * An object containing a parse() or parseForESLint() method. - * If not configured, the default ESLint parser (Espree) will be used. - */ - parser?: FlatConfigParserModule; - - /** - * An object specifying additional options that are passed directly to the - * parser() method on the parser. The available options are parser-dependent - */ - parserOptions?: ESLint.Environment["parserOptions"]; - }; + languageOptions?: LanguageOptions; /** * An object containing settings related to the linting process */ - linterOptions?: { - /** - * A boolean value indicating if inline configuration is allowed. - */ - noInlineConfig?: boolean; - - /** - * A severity value indicating if and how unused disable directives should be - * tracked and reported. - */ - reportUnusedDisableDirectives?: Severity | StringSeverity | boolean; - }; + linterOptions?: LinterOptions; /** * Either an object containing preprocess() and postprocess() methods or a @@ -1316,6 +1276,82 @@ export namespace Linter { */ settings?: Record; } + + /** @deprecated Use `Config` instead of `FlatConfig` */ + type FlatConfig = Config; + + type GlobalConf = boolean | "off" | "readable" | "readonly" | "writable" | "writeable"; + + interface Globals { + [name: string]: GlobalConf; + } + + interface LanguageOptions { + /** + * The version of ECMAScript to support. May be any year (i.e., 2022) or + * version (i.e., 5). Set to "latest" for the most recent supported version. + * @default "latest" + */ + ecmaVersion?: EcmaVersion | undefined; + + /** + * The type of JavaScript source code. Possible values are "script" for + * traditional script files, "module" for ECMAScript modules (ESM), and + * "commonjs" for CommonJS files. (default: "module" for .js and .mjs + * files; "commonjs" for .cjs files) + */ + sourceType?: SourceType | undefined; + + /** + * An object specifying additional objects that should be added to the + * global scope during linting. + */ + globals?: Globals | undefined; + + /** + * An object containing a parse() or parseForESLint() method. + * If not configured, the default ESLint parser (Espree) will be used. + */ + parser?: Parser | undefined; + + /** + * An object specifying additional options that are passed directly to the + * parser() method on the parser. The available options are parser-dependent + */ + parserOptions?: Linter.ParserOptions | undefined; + } + + interface LinterOptions { + /** + * A boolean value indicating if inline configuration is allowed. + */ + noInlineConfig?: boolean; + + /** + * A severity value indicating if and how unused disable directives should be + * tracked and reported. + */ + reportUnusedDisableDirectives?: Severity | StringSeverity | boolean; + } + + interface Stats { + /** + * The number of times ESLint has applied at least one fix after linting. + */ + fixPasses: number; + + /** + * The times spent on (parsing, fixing, linting) a file, where the linting refers to the timing information for each rule. + */ + times: { passes: TimePass[] }; + } + + interface TimePass { + parse: { total: number }; + rules?: Record; + fix: { total: number }; + total: number; + } } // #endregion @@ -1323,7 +1359,9 @@ export namespace Linter { // #region ESLint export class ESLint { - static version: string; + static configType: "flat"; + + static readonly version: string; static outputFixes(results: ESLint.LintResult[]): Promise; @@ -1340,22 +1378,25 @@ export class ESLint { getRulesMetaForResults(results: ESLint.LintResult[]): ESLint.LintResultData["rulesMeta"]; + hasFlag(flag: string): boolean; + calculateConfigForFile(filePath: string): Promise; + findConfigFile(): Promise; + isPathIgnored(filePath: string): Promise; loadFormatter(nameOrPath?: string): Promise; } export namespace ESLint { - type ConfigData = Omit, "$schema">; - - interface Globals { - [name: string]: boolean | "writable" | "readonly" | "off"; - } + type ConfigData = Omit< + Linter.LegacyConfig, + "$schema" + >; interface Environment { - globals?: Globals | undefined; + globals?: Linter.Globals | undefined; parserOptions?: Linter.ParserOptions | undefined; } @@ -1373,13 +1414,49 @@ export namespace ESLint { } interface Plugin extends ObjectMetaProperties { - configs?: Record | undefined; + configs?: Record | undefined; environments?: Record | undefined; processors?: Record | undefined; - rules?: Record | undefined; + rules?: Record | undefined; } + type FixType = "directive" | "problem" | "suggestion" | "layout"; + + type CacheStrategy = "content" | "metadata"; + interface Options { + // File enumeration + cwd?: string | undefined; + errorOnUnmatchedPattern?: boolean | undefined; + globInputPaths?: boolean | undefined; + ignore?: boolean | undefined; + ignorePatterns?: string[] | null | undefined; + passOnNoPatterns?: boolean | undefined; + warnIgnored?: boolean | undefined; + + // Linting + allowInlineConfig?: boolean | undefined; + baseConfig?: Linter.Config | Linter.Config[] | null | undefined; + overrideConfig?: Linter.Config | Linter.Config[] | null | undefined; + overrideConfigFile?: string | boolean | undefined; + plugins?: Record | null | undefined; + ruleFilter?: ((arg: { ruleId: string; severity: Exclude }) => boolean) | undefined; + stats?: boolean | undefined; + + // Autofix + fix?: boolean | ((message: Linter.LintMessage) => boolean) | undefined; + fixTypes?: FixType[] | undefined; + + // Cache-related + cache?: boolean | undefined; + cacheLocation?: string | undefined; + cacheStrategy?: CacheStrategy | undefined; + + // Other Options + flags?: string[] | undefined; + } + + interface LegacyOptions { // File enumeration cwd?: string | undefined; errorOnUnmatchedPattern?: boolean | undefined; @@ -1390,8 +1467,8 @@ export namespace ESLint { // Linting allowInlineConfig?: boolean | undefined; - baseConfig?: Linter.Config | undefined; - overrideConfig?: Linter.Config | undefined; + baseConfig?: Linter.LegacyConfig | undefined; + overrideConfig?: Linter.LegacyConfig | undefined; overrideConfigFile?: string | undefined; plugins?: Record | undefined; reportUnusedDisableDirectives?: Linter.StringSeverity | undefined; @@ -1401,12 +1478,15 @@ export namespace ESLint { // Autofix fix?: boolean | ((message: Linter.LintMessage) => boolean) | undefined; - fixTypes?: Array | undefined; + fixTypes?: FixType[] | undefined; // Cache-related cache?: boolean | undefined; cacheLocation?: string | undefined; - cacheStrategy?: "content" | "metadata" | undefined; + cacheStrategy?: CacheStrategy | undefined; + + // Other Options + flags?: string[] | undefined; } interface LintResult { @@ -1420,6 +1500,7 @@ export namespace ESLint { fixableWarningCount: number; output?: string | undefined; source?: string | undefined; + stats?: Linter.Stats | undefined; usedDeprecatedRules: DeprecatedRuleUse[]; } @@ -1436,26 +1517,38 @@ export namespace ESLint { } interface Formatter { - format(results: LintResult[], data?: LintResultData): string | Promise; + format(results: LintResult[], data: LintResultData): string | Promise; } - // Docs reference the type by this name + // Docs reference the types by those name type EditInfo = Rule.Fix; + type LoadedFormatter = Formatter; + type ResultsMeta = LintResultData; } // #endregion +export function loadESLint(options: { useFlatConfig: true }): Promise; +export function loadESLint(options: { useFlatConfig: false }): Promise; +export function loadESLint( + options?: { useFlatConfig?: boolean | undefined }, +): Promise; + // #region RuleTester export class RuleTester { - constructor(config?: any); + static describe: ((...args: any) => any) | null; + static it: ((...args: any) => any) | null; + static itOnly: ((...args: any) => any) | null; + + constructor(config?: Linter.Config); run( name: string, rule: Rule.RuleModule, tests: { - valid?: Array | undefined; - invalid?: RuleTester.InvalidTestCase[] | undefined; + valid: Array; + invalid: RuleTester.InvalidTestCase[]; }, ): void; @@ -1471,15 +1564,13 @@ export namespace RuleTester { options?: any; filename?: string | undefined; only?: boolean; - parserOptions?: Linter.ParserOptions | undefined; + languageOptions?: Linter.LanguageOptions | undefined; settings?: { [name: string]: any } | undefined; - parser?: string | undefined; - globals?: { [name: string]: boolean } | undefined; } interface SuggestionOutput { - messageId?: string | undefined; - desc?: string | undefined; + messageId?: string; + desc?: string; data?: Record | undefined; output: string; } @@ -1490,8 +1581,8 @@ export namespace RuleTester { } interface TestCaseError { - message?: string | RegExp | undefined; - messageId?: string | undefined; + message?: string | RegExp; + messageId?: string; type?: string | undefined; data?: any; line?: number | undefined; diff --git a/types/eslint/package.json b/types/eslint/package.json index 80cbf28c27f3be..37bda03866e157 100644 --- a/types/eslint/package.json +++ b/types/eslint/package.json @@ -1,7 +1,7 @@ { "private": true, "name": "@types/eslint", - "version": "8.56.9999", + "version": "9.6.9999", "projects": [ "https://eslint.org" ], diff --git a/types/eslint/tsconfig.json b/types/eslint/tsconfig.json index 18d534d29f2457..81a56a8e30fa31 100644 --- a/types/eslint/tsconfig.json +++ b/types/eslint/tsconfig.json @@ -11,7 +11,8 @@ "strictFunctionTypes": true, "types": [], "noEmit": true, - "forceConsistentCasingInFileNames": true + "forceConsistentCasingInFileNames": true, + "exactOptionalPropertyTypes": true }, "files": [ "index.d.ts", diff --git a/types/eslint/use-at-your-own-risk.d.ts b/types/eslint/use-at-your-own-risk.d.ts index 089a657babec22..e2ce2c557459d9 100644 --- a/types/eslint/use-at-your-own-risk.d.ts +++ b/types/eslint/use-at-your-own-risk.d.ts @@ -1,5 +1,8 @@ +import { ESLint, Rule } from "./index.js"; + /** @deprecated */ -export const builtinRules: Map; +export const builtinRules: Map; + /** @deprecated */ export class FileEnumerator { constructor( @@ -17,3 +20,38 @@ export class FileEnumerator { patternOrPatterns: string | string[], ): IterableIterator<{ config: any; filePath: string; ignored: boolean }>; } + +export { /** @deprecated */ ESLint as FlatESLint }; + +/** @deprecated */ +export class LegacyESLint { + static configType: "eslintrc"; + + static readonly version: string; + + static outputFixes(results: ESLint.LintResult[]): Promise; + + static getErrorResults(results: ESLint.LintResult[]): ESLint.LintResult[]; + + constructor(options?: ESLint.LegacyOptions); + + lintFiles(patterns: string | string[]): Promise; + + lintText( + code: string, + options?: { filePath?: string | undefined; warnIgnored?: boolean | undefined }, + ): Promise; + + getRulesMetaForResults(results: ESLint.LintResult[]): ESLint.LintResultData["rulesMeta"]; + + hasFlag(flag: string): false; + + calculateConfigForFile(filePath: string): Promise; + + isPathIgnored(filePath: string): Promise; + + loadFormatter(nameOrPath?: string): Promise; +} + +/** @deprecated */ +export function shouldUseFlatConfig(): Promise; diff --git a/types/eslint/v8/.eslintrc.json b/types/eslint/v8/.eslintrc.json new file mode 100644 index 00000000000000..79ee5b5a1a5836 --- /dev/null +++ b/types/eslint/v8/.eslintrc.json @@ -0,0 +1,5 @@ +{ + "rules": { + "@definitelytyped/no-single-element-tuple-type": "off" + } +} diff --git a/types/fcostarodrigo__walk/.npmignore b/types/eslint/v8/.npmignore similarity index 100% rename from types/fcostarodrigo__walk/.npmignore rename to types/eslint/v8/.npmignore diff --git a/types/eslint/v8/eslint-tests.ts b/types/eslint/v8/eslint-tests.ts new file mode 100644 index 00000000000000..ae1a5604f2dd72 --- /dev/null +++ b/types/eslint/v8/eslint-tests.ts @@ -0,0 +1,1267 @@ +import { AST, ESLint, Linter, Rule, RuleTester, Scope, SourceCode } from "eslint"; +import { ESLintRules } from "eslint/rules"; +import { Comment, PrivateIdentifier, PropertyDefinition, StaticBlock, WhileStatement } from "estree"; + +const SOURCE = `var foo = bar;`; + +const AST: AST.Program = { + type: "Program", + sourceType: "module", + body: [], + comments: [], + tokens: [], + loc: { + start: { line: 0, column: 0 }, + end: { line: 0, column: 0 }, + }, + range: [0, 0], +}; + +const TOKEN: AST.Token = { + type: "Identifier", + value: "foo", + loc: { + start: { line: 0, column: 0 }, + end: { line: 0, column: 3 }, + }, + range: [0, 3], +}; + +const COMMENT: Comment = { + type: "Block", + value: "foo", + loc: { + start: { line: 0, column: 0 }, + end: { line: 0, column: 0 }, + }, + range: [0, 0], +}; + +// #region SourceCode + +let sourceCode = new SourceCode(SOURCE, AST); + +SourceCode.splitLines(SOURCE); + +sourceCode.getText(); +sourceCode.getText(AST); +sourceCode.getText(AST, 0); +sourceCode.getText(AST, 0, 0); + +sourceCode.getLines(); + +sourceCode.getAllComments(); + +sourceCode.getComments(AST).leading; +sourceCode.getComments(AST).trailing; + +sourceCode.getJSDocComment(AST); // $ExpectType Comment | null + +sourceCode.getNodeByRangeIndex(0); + +sourceCode.getNodeByRangeIndex(0); + +sourceCode.isSpaceBetweenTokens(TOKEN, TOKEN); + +sourceCode.isSpaceBetween(TOKEN, TOKEN); +sourceCode.isSpaceBetween(AST, TOKEN); +sourceCode.isSpaceBetween(TOKEN, AST); + +const loc = sourceCode.getLocFromIndex(0); +loc.line; // $ExpectType number +loc.column; // $ExpectType number + +sourceCode.getIndexFromLoc({ line: 0, column: 0 }); + +sourceCode.getTokenByRangeStart(0); // $ExpectType Token | null +sourceCode.getTokenByRangeStart(0, { includeComments: true }); // $ExpectType Comment | Token | null || Token | Comment | null +sourceCode.getTokenByRangeStart(0, { includeComments: false }); // $ExpectType Token | null +sourceCode.getTokenByRangeStart(0, { includeComments: false as boolean }); // $ExpectType Comment | Token | null || Token | Comment | null + +sourceCode.getFirstToken(AST); // $ExpectType Token | null +sourceCode.getFirstToken(AST, 0); +sourceCode.getFirstToken(AST, { skip: 0 }); +sourceCode.getFirstToken(AST, (t): t is AST.Token & { type: "Identifier" } => t.type === "Identifier"); // $ExpectType (Token & { type: "Identifier"; }) | null +sourceCode.getFirstToken(AST, { filter: (t): t is AST.Token & { type: "Identifier" } => t.type === "Identifier" }); // $ExpectType (Token & { type: "Identifier"; }) | null +sourceCode.getFirstToken(AST, { skip: 0, filter: t => t.type === "Identifier" }); +sourceCode.getFirstToken(AST, { includeComments: true }); // $ExpectType Comment | Token | null || Token | Comment | null +sourceCode.getFirstToken(AST, { includeComments: true, skip: 0 }); +// prettier-ignore +sourceCode.getFirstToken(AST, { // $ExpectType (Token & { type: "Identifier"; }) | null + includeComments: true, + skip: 0, + filter: (t): t is AST.Token & { type: "Identifier" } => t.type === "Identifier", +}); + +sourceCode.getFirstTokens(AST); // $ExpectType Token[] +sourceCode.getFirstTokens(AST, 0); // $ExpectType Token[] +sourceCode.getFirstTokens(AST, { count: 0 }); +sourceCode.getFirstTokens(AST, (t): t is AST.Token & { type: "Identifier" } => t.type === "Identifier"); // $ExpectType (Token & { type: "Identifier"; })[] +sourceCode.getFirstTokens(AST, { filter: (t): t is AST.Token & { type: "Identifier" } => t.type === "Identifier" }); // $ExpectType (Token & { type: "Identifier"; })[] +// prettier-ignore +sourceCode.getFirstTokens(AST, { // $ExpectType (Token & { type: "Identifier"; })[] + count: 0, + filter: (t): t is AST.Token & { type: "Identifier" } => t.type === "Identifier", +}); +sourceCode.getFirstTokens(AST, { includeComments: true }); // $ ExpectType (Comment | Token)[] +sourceCode.getFirstTokens(AST, { includeComments: true, count: 0 }); // $ ExpectType (Comment | Token)[] +// prettier-ignore +sourceCode.getFirstTokens(AST, { // $ExpectType (Token & { type: "Identifier"; })[] + includeComments: true, + count: 0, + filter: (t): t is AST.Token & { type: "Identifier" } => t.type === "Identifier", +}); + +sourceCode.getLastToken(AST); +sourceCode.getLastToken(AST, 0); +sourceCode.getLastToken(AST, { skip: 0 }); +sourceCode.getLastToken(AST, t => t.type === "Identifier"); +sourceCode.getLastToken(AST, { filter: t => t.type === "Identifier" }); +sourceCode.getLastToken(AST, { skip: 0, filter: t => t.type === "Identifier" }); +sourceCode.getLastToken(AST, { includeComments: true }); +sourceCode.getLastToken(AST, { includeComments: true, skip: 0 }); +sourceCode.getLastToken(AST, { includeComments: true, skip: 0, filter: t => t.type === "Identifier" }); + +sourceCode.getLastTokens(AST); +sourceCode.getLastTokens(AST, 0); +sourceCode.getLastTokens(AST, { count: 0 }); +sourceCode.getLastTokens(AST, t => t.type === "Identifier"); +sourceCode.getLastTokens(AST, { filter: t => t.type === "Identifier" }); +sourceCode.getLastTokens(AST, { count: 0, filter: t => t.type === "Identifier" }); +sourceCode.getLastTokens(AST, { includeComments: true }); +sourceCode.getLastTokens(AST, { includeComments: true, count: 0 }); +sourceCode.getLastTokens(AST, { includeComments: true, count: 0, filter: t => t.type === "Identifier" }); + +sourceCode.getTokenBefore(AST); +sourceCode.getTokenBefore(AST, 0); +sourceCode.getTokenBefore(AST, { skip: 0 }); +sourceCode.getTokenBefore(AST, t => t.type === "Identifier"); +sourceCode.getTokenBefore(AST, { filter: t => t.type === "Identifier" }); +sourceCode.getTokenBefore(AST, { skip: 0, filter: t => t.type === "Identifier" }); +sourceCode.getTokenBefore(AST, { includeComments: true }); +sourceCode.getTokenBefore(AST, { includeComments: true, skip: 0 }); +sourceCode.getTokenBefore(AST, { includeComments: true, skip: 0, filter: t => t.type === "Identifier" }); +sourceCode.getTokenBefore(TOKEN, 0); +sourceCode.getTokenBefore(COMMENT, 0); + +sourceCode.getTokensBefore(AST); +sourceCode.getTokensBefore(AST, 0); +sourceCode.getTokensBefore(AST, { count: 0 }); +sourceCode.getTokensBefore(AST, t => t.type === "Identifier"); +sourceCode.getTokensBefore(AST, { filter: t => t.type === "Identifier" }); +sourceCode.getTokensBefore(AST, { count: 0, filter: t => t.type === "Identifier" }); +sourceCode.getTokensBefore(AST, { includeComments: true }); +sourceCode.getTokensBefore(AST, { includeComments: true, count: 0 }); +sourceCode.getTokensBefore(AST, { includeComments: true, count: 0, filter: t => t.type === "Identifier" }); +sourceCode.getTokensBefore(TOKEN, 0); +sourceCode.getTokensBefore(COMMENT, 0); + +sourceCode.getTokenAfter(AST); +sourceCode.getTokenAfter(AST, 0); +sourceCode.getTokenAfter(AST, { skip: 0 }); +sourceCode.getTokenAfter(AST, t => t.type === "Identifier"); +sourceCode.getTokenAfter(AST, { filter: t => t.type === "Identifier" }); +sourceCode.getTokenAfter(AST, { skip: 0, filter: t => t.type === "Identifier" }); +sourceCode.getTokenAfter(AST, { includeComments: true }); +sourceCode.getTokenAfter(AST, { includeComments: true, skip: 0 }); +sourceCode.getTokenAfter(AST, { includeComments: true, skip: 0, filter: t => t.type === "Identifier" }); +sourceCode.getTokenAfter(TOKEN, 0); +sourceCode.getTokenAfter(COMMENT, 0); + +sourceCode.getTokensAfter(AST); +sourceCode.getTokensAfter(AST, 0); +sourceCode.getTokensAfter(AST, { count: 0 }); +sourceCode.getTokensAfter(AST, t => t.type === "Identifier"); +sourceCode.getTokensAfter(AST, { filter: t => t.type === "Identifier" }); +sourceCode.getTokensAfter(AST, { count: 0, filter: t => t.type === "Identifier" }); +sourceCode.getTokensAfter(AST, { includeComments: true }); +sourceCode.getTokensAfter(AST, { includeComments: true, count: 0 }); +sourceCode.getTokensAfter(AST, { includeComments: true, count: 0, filter: t => t.type === "Identifier" }); +sourceCode.getTokensAfter(TOKEN, 0); +sourceCode.getTokensAfter(COMMENT, 0); + +sourceCode.getFirstTokenBetween(AST, AST); // $ExpectType Token | null +sourceCode.getFirstTokenBetween(AST, AST, 0); +sourceCode.getFirstTokenBetween(AST, AST, { skip: 0 }); +sourceCode.getFirstTokenBetween(AST, AST, (t): t is AST.Token & { type: "Identifier" } => t.type === "Identifier"); // $ExpectType (Token & { type: "Identifier"; }) | null +// prettier-ignore +sourceCode.getFirstTokenBetween(AST, AST, { // $ExpectType (Token & { type: "Identifier"; }) | null + filter: (t): t is AST.Token & { type: "Identifier" } => t.type === "Identifier", +}); +sourceCode.getFirstTokenBetween(AST, AST, { + skip: 0, + filter: (t): t is AST.Token & { type: "Identifier" } => t.type === "Identifier", +}); +sourceCode.getFirstTokenBetween(AST, AST, { includeComments: true }); // $ExpectType Comment | Token | null || Token | Comment | null +sourceCode.getFirstTokenBetween(AST, AST, { includeComments: true, skip: 0 }); +// prettier-ignore +sourceCode.getFirstTokenBetween(AST, AST, { // $ExpectType (Token & { type: "Identifier"; }) | null + includeComments: true, + skip: 0, + filter: (t): t is AST.Token & { type: "Identifier" } => t.type === "Identifier", +}); + +sourceCode.getFirstTokensBetween(AST, AST); // $ExpectType Token[] +sourceCode.getFirstTokensBetween(AST, AST, 0); +sourceCode.getFirstTokensBetween(AST, AST, { count: 0 }); +sourceCode.getFirstTokensBetween(AST, AST, (t): t is AST.Token & { type: "Identifier" } => t.type === "Identifier"); // $ExpectType (Token & { type: "Identifier"; })[] +// prettier-ignore +sourceCode.getFirstTokensBetween(AST, AST, { // $ExpectType (Token & { type: "Identifier"; })[] + filter: (t): t is AST.Token & { type: "Identifier" } => t.type === "Identifier", +}); +sourceCode.getFirstTokensBetween(AST, AST, { count: 0, filter: t => t.type === "Identifier" }); +sourceCode.getFirstTokensBetween(AST, AST, { includeComments: true }); // $ExpectType (Comment | Token)[] || (Token | Comment)[] +sourceCode.getFirstTokensBetween(AST, AST, { includeComments: true, count: 0 }); +// prettier-ignore +sourceCode.getFirstTokensBetween(AST, AST, { // $ExpectType (Token & { type: "Identifier"; })[] + includeComments: true, + count: 0, + filter: (t): t is AST.Token & { type: "Identifier" } => t.type === "Identifier", +}); + +sourceCode.getLastTokenBetween(AST, AST); +sourceCode.getLastTokenBetween(AST, AST, 0); +sourceCode.getLastTokenBetween(AST, AST, { skip: 0 }); +sourceCode.getLastTokenBetween(AST, AST, t => t.type === "Identifier"); +sourceCode.getLastTokenBetween(AST, AST, { filter: t => t.type === "Identifier" }); +sourceCode.getLastTokenBetween(AST, AST, { skip: 0, filter: t => t.type === "Identifier" }); +sourceCode.getLastTokenBetween(AST, AST, { includeComments: true }); +sourceCode.getLastTokenBetween(AST, AST, { includeComments: true, skip: 0 }); +sourceCode.getLastTokenBetween(AST, AST, { includeComments: true, skip: 0, filter: t => t.type === "Identifier" }); + +sourceCode.getLastTokensBetween(AST, AST); +sourceCode.getLastTokensBetween(AST, AST, 0); +sourceCode.getLastTokensBetween(AST, AST, { count: 0 }); +sourceCode.getLastTokensBetween(AST, AST, t => t.type === "Identifier"); +sourceCode.getLastTokensBetween(AST, AST, { filter: t => t.type === "Identifier" }); +sourceCode.getLastTokensBetween(AST, AST, { count: 0, filter: t => t.type === "Identifier" }); +sourceCode.getLastTokensBetween(AST, AST, { includeComments: true }); +sourceCode.getLastTokensBetween(AST, AST, { includeComments: true, count: 0 }); +sourceCode.getLastTokensBetween(AST, AST, { includeComments: true, count: 0, filter: t => t.type === "Identifier" }); + +sourceCode.getTokensBetween(AST, AST); +sourceCode.getTokensBetween(AST, AST, 0); + +sourceCode.getTokens(AST); // $ExpectType Token[] +sourceCode.getTokens(AST, 0); +sourceCode.getTokens(AST, 0, 0); +sourceCode.getTokens(AST, (t): t is AST.Token & { type: "Identifier" } => t.type === "Identifier"); // $ExpectType (Token & { type: "Identifier"; })[] +sourceCode.getTokens(AST, { filter: (t): t is AST.Token & { type: "Identifier" } => t.type === "Identifier" }); // $ExpectType (Token & { type: "Identifier"; })[] +sourceCode.getTokens(AST, { includeComments: true }); // $ExpectType (Comment | Token)[] || (Token | Comment)[] +// prettier-ignore +sourceCode.getTokens(AST, { // $ExpectType (Token & { type: "Identifier"; })[] + includeComments: true, + filter: (t): t is AST.Token & { type: "Identifier" } => t.type === "Identifier", +}); + +sourceCode.commentsExistBetween(AST, AST); +sourceCode.commentsExistBetween(TOKEN, TOKEN); +sourceCode.commentsExistBetween(COMMENT, COMMENT); + +sourceCode.getCommentsBefore(AST); +sourceCode.getCommentsBefore(TOKEN); + +sourceCode.getCommentsAfter(AST); +sourceCode.getCommentsAfter(TOKEN); + +sourceCode.getCommentsInside(AST); + +sourceCode.markVariableAsUsed("foo"); +sourceCode.markVariableAsUsed("foo", AST); + +sourceCode.getDeclaredVariables(AST); // $ExpectType Variable[] + +sourceCode.getAncestors(AST); // $ExpectType Node[] + +// #endregion + +// #region Scope + +const scopeManager: Scope.ScopeManager = { + scopes: [], + globalScope: null, + acquire(node, inner) { + return scopeManager.scopes[0]; + }, + getDeclaredVariables() { + return []; + }, +}; + +const scope = scopeManager.scopes[0]; + +const variable = scope.variables[0]; + +variable.name = "foo"; + +variable.identifiers[0].type = "Identifier"; + +variable.defs[0].name.type = "Identifier"; +variable.defs[0].type; +variable.defs[0].node; +variable.defs[0].parent; + +const reference = scope.references[0]; + +reference.from = scope; +reference.identifier.type = "Identifier"; +reference.resolved = variable; +reference.writeExpr = AST; +reference.init = true; + +reference.isRead(); +reference.isReadOnly(); +reference.isWrite(); +reference.isWriteOnly(); +reference.isReadWrite(); + +// #endregion + +// #region Rule + +let mixedRule: Rule.OldStyleRule | Rule.RuleModule; + +mixedRule = { + create(context) { + return {}; + }, +}; + +mixedRule = (context) => ({}); + +let oldStyleRule: Rule.OldStyleRule; + +oldStyleRule = (context) => ({}); + +// @ts-expect-error +oldStyleRule.schema = []; +// @ts-expect-error +oldStyleRule.schema = {}; + +// @ts-expect-error +oldStyleRule.meta = {}; + +// @ts-expect-error +oldStyleRule.create = (context) => ({}); + +let rule: Rule.RuleModule; + +rule = { + create(context) { + return {}; + }, +}; +rule = { + create(context) { + return {}; + }, + meta: {}, +}; +rule = { + create(context) { + return {}; + }, + meta: { + docs: { + description: "disallow the use of `console`", + category: "Possible Errors", + recommended: true, + url: "https://eslint.org/docs/rules/no-console", + suggestion: true, + }, + }, +}; +rule = { + create(context) { + return {}; + }, + meta: { fixable: "whitespace" }, +}; +rule = { + create(context) { + return {}; + }, + meta: { fixable: "code" }, +}; +rule = { + create(context) { + return {}; + }, + meta: { schema: [{ enum: ["always", "never"] }] }, +}; +rule = { + create(context) { + return {}; + }, + meta: { deprecated: true, replacedBy: ["other-rule-name"] }, +}; +rule = { + create(context) { + return {}; + }, + meta: { type: "layout" }, +}; +rule = { + create(context) { + return {}; + }, + meta: { + docs: { + description: "disallow the use of `console`", + category: "Possible Errors", + recommended: true, + url: "https://eslint.org/docs/rules/no-console", + }, + hasSuggestions: true, + }, +}; + +rule = { + create(context) { + context.getAncestors(); + + context.getDeclaredVariables(AST); + + context.filename; + + context.getFilename(); + + context.physicalFilename; + + context.getPhysicalFilename(); + + context.cwd; + + context.getCwd(); + + context.sourceCode; + + context.getSourceCode(); + + context.getScope(); + + if (typeof context.parserPath === "string") { + context.parserPath; + } else { + context.languageOptions?.parser; + } + + context.markVariableAsUsed("foo"); + + context.report({ message: "foo", node: AST }); + context.report({ message: "foo", loc: { line: 0, column: 0 } }); + context.report({ message: "foo", node: AST, data: { foo: "bar" } }); + context.report({ message: "foo", node: AST, fix: () => null }); + context.report({ message: "foo", node: AST, fix: ruleFixer => ruleFixer.replaceText(AST, "foo") }); + + context.report({ + message: "foo", + node: AST, + fix: ruleFixer => { + ruleFixer.insertTextAfter(AST, "foo"); + ruleFixer.insertTextAfter(TOKEN, "foo"); + + ruleFixer.insertTextAfterRange([0, 0], "foo"); + + ruleFixer.insertTextBefore(AST, "foo"); + ruleFixer.insertTextBefore(TOKEN, "foo"); + + ruleFixer.insertTextBeforeRange([0, 0], "foo"); + + ruleFixer.remove(AST); + ruleFixer.remove(TOKEN); + + ruleFixer.removeRange([0, 0]); + + ruleFixer.replaceText(AST, "foo"); + ruleFixer.replaceText(TOKEN, "foo"); + + ruleFixer.replaceTextRange([0, 0], "foo"); + + return null; + }, + }); + + context.report({ + message: "foo", + node: AST, + fix: ruleFixer => { + return [ruleFixer.insertTextAfter(AST, "foo"), ruleFixer.insertTextAfter(TOKEN, "foo")]; + }, + }); + + context.report({ + message: "foo", + node: AST, + suggest: [ + { + desc: "foo", + fix: ruleFixer => { + return [ruleFixer.insertTextAfter(AST, "foo"), ruleFixer.insertTextAfter(TOKEN, "foo")]; + }, + }, + { + messageId: "foo", + fix: ruleFixer => { + return [ruleFixer.insertTextAfter(AST, "foo"), ruleFixer.insertTextAfter(TOKEN, "foo")]; + }, + }, + { + desc: "foo", + fix: ruleFixer => null, + }, + ], + }); + + return { + onCodePathStart(codePath, node) {}, + onCodePathEnd(codePath, node) {}, + onCodePathSegmentStart(segment, node) {}, + onCodePathSegmentEnd(segment, node) {}, + onCodePathSegmentLoop(fromSegment, toSegment, node) {}, + IfStatement(node) { + node.parent; + }, + WhileStatement(node: WhileStatement) {}, + Program(node) { + // @ts-expect-error + node.parent; + }, + "Program:exit"(node) { + node.body; + }, + "IfStatement:exit"(node) { + node.parent; + }, + "MemberExpression[object.name=\"req\"]": (node: Rule.Node) => { + node.parent; + }, + PrivateIdentifier(node) { + const expected: PrivateIdentifier & Rule.NodeParentExtension = node; + expected.parent; + }, + PropertyDefinition(node) { + const expected: PropertyDefinition & Rule.NodeParentExtension = node; + expected.parent; + }, + StaticBlock(node) { + const expected: StaticBlock & Rule.NodeParentExtension = node; + expected.parent; + }, + }; + }, +}; + +// #endregion + +// #region Linter + +const linter = new Linter(); + +linter.version; + +linter.verify(SOURCE, {}); +linter.verify(new SourceCode(SOURCE, AST), {}); + +linter.verify(SOURCE, {}, "test.js"); +linter.verify(SOURCE, {}, {}); +linter.verify(SOURCE, {}, { filename: "test.js" }); +linter.verify(SOURCE, {}, { allowInlineConfig: false }); +linter.verify(SOURCE, {}, { reportUnusedDisableDirectives: true }); +linter.verify(SOURCE, {}, { preprocess: input => input.split(" ") }); +linter.verify(SOURCE, {}, { postprocess: problemList => problemList[0] }); + +linter.verify(SOURCE, { parserOptions: { ecmaVersion: 2021 } }, "test.js"); +linter.verify(SOURCE, { parserOptions: { ecmaVersion: 2022 } }, "test.js"); +linter.verify(SOURCE, { parserOptions: { ecmaVersion: 2023 } }, "test.js"); +linter.verify(SOURCE, { parserOptions: { ecmaVersion: 2024 } }, "test.js"); +linter.verify(SOURCE, { parserOptions: { ecmaVersion: "latest" } }, "test.js"); +linter.verify(SOURCE, { parserOptions: { ecmaVersion: 6, ecmaFeatures: { globalReturn: true } } }, "test.js"); +linter.verify( + SOURCE, + { parserOptions: { ecmaVersion: 6, ecmaFeatures: { experimentalObjectRestSpread: true } } }, + "test.js", +); +linter.verify(SOURCE, { env: { node: true } }, "test.js"); +linter.verify(SOURCE, { globals: { foo: true } }, "test.js"); +linter.verify(SOURCE, { globals: { foo: "off" } }, "test.js"); +linter.verify(SOURCE, { globals: { foo: "readonly" } }, "test.js"); +linter.verify(SOURCE, { globals: { foo: "readable" } }, "test.js"); +linter.verify(SOURCE, { globals: { foo: "writable" } }, "test.js"); +linter.verify(SOURCE, { globals: { foo: "writeable" } }, "test.js"); +linter.verify(SOURCE, { parser: "custom-parser" }, "test.js"); +linter.verify(SOURCE, { settings: { info: "foo" } }, "test.js"); +linter.verify(SOURCE, { processor: "a-plugin/a-processor" }, "test.js"); +linter.verify(SOURCE, { plugins: ["a-plugin"] }, "test.js"); +linter.verify(SOURCE, { root: true }, "test.js"); +linter.verify(SOURCE, { extends: "eslint-config-bad-guy" }, "test.js"); +linter.verify(SOURCE, { extends: ["eslint-config-bad-guy", "eslint-config-roblox"] }, "test.js"); + +linter.verify(SOURCE, { rules: {} }, "test.js"); +linter.verify(SOURCE, { rules: { quotes: 2 } }, "test.js"); +linter.verify(SOURCE, { rules: { quotes: [2, "double"] } }, "test.js"); +linter.verify(SOURCE, { rules: { "no-unused-vars": [2, { vars: "all" }] } }, "test.js"); +linter.verify(SOURCE, { rules: { "no-console": 1 } }, "test.js"); +linter.verify(SOURCE, { rules: { "no-console": 0 } }, "test.js"); +linter.verify(SOURCE, { rules: { "no-console": "error" } }, "test.js"); +linter.verify( + SOURCE, + { + rules: { "no-console": "error" }, + overrides: [ + { + extends: ["eslint-config-bad-guy"], + excludedFiles: ["*-test.js", "*.spec.js"], + files: ["*-test.js", "*.spec.js"], + rules: { + "no-unused-expressions": "off", + }, + }, + ], + }, + "test.js", +); +linter.verify(SOURCE, { rules: { "no-console": "warn" } }, "test.js"); +linter.verify(SOURCE, { rules: { "no-console": "off" } }, "test.js"); + +const lintingResult = linter.verify(SOURCE, {}); + +for (const msg of lintingResult) { + msg.severity = 1; + msg.severity = 2; + + msg.ruleId = "foo"; + + msg.fatal = true; + + msg.message = "foo"; + msg.messageId = "foo"; + + msg.line = 0; + msg.endLine = 0; + msg.column = 0; + msg.endColumn = 0; + + msg.source = SOURCE; + + if (msg.fix) { + msg.fix.text = "foo"; + msg.fix.range = [0, 0]; + } + + if (msg.suggestions) { + for (const suggestion of msg.suggestions) { + suggestion.desc = "foo"; + suggestion.messageId = "foo"; + suggestion.fix.text = "foo"; + suggestion.fix.range = [0, 0]; + } + } +} + +linter.verifyAndFix(SOURCE, {}); +linter.verifyAndFix(SOURCE, {}, "test.js"); +linter.verifyAndFix(SOURCE, {}, { fix: false }); + +const fixResult = linter.verifyAndFix(SOURCE, {}); + +fixResult.fixed = true; +fixResult.output = "foo"; + +for (const msg of fixResult.messages) { + msg.ruleId = "foo"; +} + +sourceCode = linter.getSourceCode(); + +linter.defineRule("test", rule); + +linter.defineRules({ + foo: rule, + bar: rule, +}); + +linter.getRules(); + +linter.defineParser("custom-parser", { + name: "foo", + version: "1.2.3", + meta: { + name: "foo", + version: "1.2.3", + }, + parse: (src, opts) => AST, +}); +linter.defineParser("custom-parser", { + name: "foo", + version: "1.2.3", + meta: { + name: "foo", + version: "1.2.3", + }, + parseForESLint(src, opts) { + return { + ast: AST, + visitorKeys: {}, + parserServices: {}, + scopeManager, + }; + }, +}); + +const _processor: Linter.Processor = { + name: "foo", + version: "1.2.3", + meta: { + name: "foo", + version: "1.2.3", + }, + supportsAutofix: true, + preprocess(text, filename) { + return [ + text, + { + text: "", + filename: "1.js", + }, + ]; + }, + postprocess(messages, filename) { + return ([] as Linter.LintMessage[]).concat(...messages); + }, +}; + +// #region Linter with flat config + +const linterWithFlatConfig = new Linter({ configType: "flat" }); + +linterWithFlatConfig.version; + +linterWithFlatConfig.verify(SOURCE, [{}]); +linterWithFlatConfig.verify(new SourceCode(SOURCE, AST), [{}]); + +linterWithFlatConfig.verify(SOURCE, [{}], "test.js"); +linterWithFlatConfig.verify(SOURCE, [{}], {}); +linterWithFlatConfig.verify(SOURCE, [{}], { filename: "test.js" }); +linterWithFlatConfig.verify(SOURCE, [{}], { allowInlineConfig: false }); +linterWithFlatConfig.verify(SOURCE, [{}], { reportUnusedDisableDirectives: true }); +linterWithFlatConfig.verify(SOURCE, [{}], { preprocess: input => input.split(" ") }); +linterWithFlatConfig.verify(SOURCE, [{}], { postprocess: problemList => problemList[0] }); + +linterWithFlatConfig.verify(SOURCE, [{ languageOptions: { ecmaVersion: 2021 } }], "test.js"); +linterWithFlatConfig.verify(SOURCE, [{ languageOptions: { ecmaVersion: 2022 } }], "test.js"); +linterWithFlatConfig.verify(SOURCE, [{ languageOptions: { ecmaVersion: 2023 } }], "test.js"); +linterWithFlatConfig.verify(SOURCE, [{ languageOptions: { ecmaVersion: 2024 } }], "test.js"); +linterWithFlatConfig.verify(SOURCE, [{ languageOptions: { ecmaVersion: "latest" } }], "test.js"); +linterWithFlatConfig.verify(SOURCE, [{ languageOptions: { ecmaVersion: 6 } }], "test.js"); +linterWithFlatConfig.verify( + SOURCE, + [{ + languageOptions: { + ecmaVersion: 6, + globals: { + true: true, + false: false, + foo: "readonly", + bar: "writable", + baz: "off", + }, + }, + }], + "test.js", +); + +linterWithFlatConfig.verify(SOURCE, [{ rules: {} }], "test.js"); +linterWithFlatConfig.verify(SOURCE, [{ rules: { quotes: 2 } }], "test.js"); +linterWithFlatConfig.verify(SOURCE, [{ rules: { quotes: [2, "double"] } }], "test.js"); +linterWithFlatConfig.verify(SOURCE, [{ rules: { "no-unused-vars": [2, { vars: "all" }] } }], "test.js"); +linterWithFlatConfig.verify(SOURCE, [{ rules: { "no-console": 1 } }], "test.js"); +linterWithFlatConfig.verify(SOURCE, [{ rules: { "no-console": 0 } }], "test.js"); +linterWithFlatConfig.verify(SOURCE, [{ rules: { "no-console": "error" } }], "test.js"); +linterWithFlatConfig.verify( + SOURCE, + [{ + rules: { "no-console": "error" }, + }, { + files: ["*-test.js", "*.spec.js"], + rules: { + "no-unused-expressions": "off", + }, + }], + "test.js", +); +linterWithFlatConfig.verify(SOURCE, [{ rules: { "no-console": "warn" } }], "test.js"); +linterWithFlatConfig.verify(SOURCE, [{ rules: { "no-console": "off" } }], "test.js"); + +// #endregion + +// # region Linter with eslintrc config + +const linterWithEslintrcConfig = new Linter({ configType: "eslintrc" }); + +linterWithEslintrcConfig.version; + +linterWithEslintrcConfig.verify(SOURCE, {}); +linterWithEslintrcConfig.verify(new SourceCode(SOURCE, AST), {}); + +linterWithEslintrcConfig.verify(SOURCE, {}, "test.js"); +linterWithEslintrcConfig.verify(SOURCE, {}, {}); +linterWithEslintrcConfig.verify(SOURCE, {}, { filename: "test.js" }); +linterWithEslintrcConfig.verify(SOURCE, {}, { allowInlineConfig: false }); +linterWithEslintrcConfig.verify(SOURCE, {}, { reportUnusedDisableDirectives: true }); +linterWithEslintrcConfig.verify(SOURCE, {}, { preprocess: input => input.split(" ") }); +linterWithEslintrcConfig.verify(SOURCE, {}, { postprocess: problemList => problemList[0] }); + +linterWithEslintrcConfig.verify(SOURCE, { parserOptions: { ecmaVersion: 2021 } }, "test.js"); +linterWithEslintrcConfig.verify(SOURCE, { parserOptions: { ecmaVersion: 2022 } }, "test.js"); +linterWithEslintrcConfig.verify(SOURCE, { parserOptions: { ecmaVersion: 2023 } }, "test.js"); +linterWithEslintrcConfig.verify(SOURCE, { parserOptions: { ecmaVersion: 2024 } }, "test.js"); +linterWithEslintrcConfig.verify(SOURCE, { parserOptions: { ecmaVersion: "latest" } }, "test.js"); +linterWithEslintrcConfig.verify( + SOURCE, + { parserOptions: { ecmaVersion: 6, ecmaFeatures: { globalReturn: true } } }, + "test.js", +); +linterWithEslintrcConfig.verify( + SOURCE, + { parserOptions: { ecmaVersion: 6, ecmaFeatures: { experimentalObjectRestSpread: true } } }, + "test.js", +); +linterWithEslintrcConfig.verify(SOURCE, { env: { node: true } }, "test.js"); +linterWithEslintrcConfig.verify(SOURCE, { globals: { foo: true } }, "test.js"); +linterWithEslintrcConfig.verify(SOURCE, { globals: { foo: "off" } }, "test.js"); +linterWithEslintrcConfig.verify(SOURCE, { globals: { foo: "readonly" } }, "test.js"); +linterWithEslintrcConfig.verify(SOURCE, { globals: { foo: "readable" } }, "test.js"); +linterWithEslintrcConfig.verify(SOURCE, { globals: { foo: "writable" } }, "test.js"); +linterWithEslintrcConfig.verify(SOURCE, { globals: { foo: "writeable" } }, "test.js"); +linterWithEslintrcConfig.verify(SOURCE, { parser: "custom-parser" }, "test.js"); +linterWithEslintrcConfig.verify(SOURCE, { settings: { info: "foo" } }, "test.js"); +linterWithEslintrcConfig.verify(SOURCE, { processor: "a-plugin/a-processor" }, "test.js"); +linterWithEslintrcConfig.verify(SOURCE, { plugins: ["a-plugin"] }, "test.js"); +linterWithEslintrcConfig.verify(SOURCE, { root: true }, "test.js"); +linterWithEslintrcConfig.verify(SOURCE, { extends: "eslint-config-bad-guy" }, "test.js"); +linterWithEslintrcConfig.verify(SOURCE, { extends: ["eslint-config-bad-guy", "eslint-config-roblox"] }, "test.js"); + +linterWithEslintrcConfig.verify(SOURCE, { rules: {} }, "test.js"); +linterWithEslintrcConfig.verify(SOURCE, { rules: { quotes: 2 } }, "test.js"); +linterWithEslintrcConfig.verify(SOURCE, { rules: { quotes: [2, "double"] } }, "test.js"); +linterWithEslintrcConfig.verify(SOURCE, { rules: { "no-unused-vars": [2, { vars: "all" }] } }, "test.js"); +linterWithEslintrcConfig.verify(SOURCE, { rules: { "no-console": 1 } }, "test.js"); +linterWithEslintrcConfig.verify(SOURCE, { rules: { "no-console": 0 } }, "test.js"); +linterWithEslintrcConfig.verify(SOURCE, { rules: { "no-console": "error" } }, "test.js"); +linterWithEslintrcConfig.verify( + SOURCE, + { + rules: { "no-console": "error" }, + overrides: [ + { + extends: ["eslint-config-bad-guy"], + excludedFiles: ["*-test.js", "*.spec.js"], + files: ["*-test.js", "*.spec.js"], + rules: { + "no-unused-expressions": "off", + }, + }, + ], + }, + "test.js", +); +linterWithEslintrcConfig.verify(SOURCE, { rules: { "no-console": "warn" } }, "test.js"); +linterWithEslintrcConfig.verify(SOURCE, { rules: { "no-console": "off" } }, "test.js"); + +linterWithEslintrcConfig.getRules(); + +// #endregion + +// #region ESLint + +let eslint: ESLint; + +eslint = new ESLint(); +eslint = new ESLint({ allowInlineConfig: false }); +eslint = new ESLint({ baseConfig: {} }); +eslint = new ESLint({ overrideConfig: {} }); +eslint = new ESLint({ overrideConfigFile: "foo" }); +eslint = new ESLint({ cache: true }); +eslint = new ESLint({ cacheLocation: "foo" }); +eslint = new ESLint({ cacheStrategy: "content" }); +eslint = new ESLint({ cwd: "foo" }); +eslint = new ESLint({ errorOnUnmatchedPattern: true }); +eslint = new ESLint({ extensions: ["js"] }); +eslint = new ESLint({ fix: true }); +eslint = new ESLint({ fix: message => false }); +eslint = new ESLint({ fixTypes: ["problem"] }); +eslint = new ESLint({ globInputPaths: true }); +eslint = new ESLint({ ignore: true }); +eslint = new ESLint({ ignorePath: "foo" }); +eslint = new ESLint({ useEslintrc: false }); +eslint = new ESLint({ plugins: { foo: {} } }); +eslint = new ESLint({ + plugins: { + bar: { + name: "bar", + version: "1.0.0", + meta: { + name: "bar", + version: "1.0.0", + }, + configs: { + myConfig: { + noInlineConfig: true, + }, + }, + environments: { + production: { + parserOptions: { + ecmaVersion: 6, + }, + }, + }, + processors: { + myProcessor: { + name: "blah", + version: "1.2.3", + meta: { + name: "blah", + version: "1.2.3", + }, + supportsAutofix: false, + }, + }, + rules: { + myRule: { + create(context) { + return {}; + }, + meta: {}, + }, + }, + }, + }, +}); +eslint = new ESLint({ reportUnusedDisableDirectives: "error" }); +// @ts-expect-error +eslint = new ESLint({ reportUnusedDisableDirectives: 2 }); +eslint = new ESLint({ resolvePluginsRelativeTo: "test" }); +eslint = new ESLint({ rulePaths: ["foo"] }); + +let resultsPromise = eslint.lintFiles(["myfile.js", "lib/"]); + +resultsPromise = eslint.lintText(SOURCE, { filePath: "foo" }); + +eslint.calculateConfigForFile("./config.json"); + +eslint.isPathIgnored("./dist/index.js"); + +let formatterPromise: Promise; + +formatterPromise = eslint.loadFormatter("codeframe"); +formatterPromise = eslint.loadFormatter(); + +const customFormatter1: ESLint.Formatter = { format: () => "ok" }; +const customFormatter2: ESLint.Formatter = { format: () => Promise.resolve("ok") }; + +let data: ESLint.LintResultData; +const meta: Rule.RuleMetaData = { + type: "suggestion", + docs: { + description: "disallow unnecessary semicolons", + category: "Possible Errors", + recommended: true, + url: "https://eslint.org/docs/rules/no-extra-semi", + }, + fixable: "code", + schema: [], + messages: { + unexpected: "Unnecessary semicolon.", + }, +}; + +data = { cwd: "/foo/bar", rulesMeta: { "no-extra-semi": meta } }; + +const version: string = ESLint.version; + +(async () => { + const results = await resultsPromise; + const formatter = await formatterPromise; + + const output1: string = await formatter.format(results); + const output2: string = await formatter.format(results, data); + + eslint.getRulesMetaForResults(results); + + ESLint.getErrorResults(results); + + ESLint.outputFixes(results); + + results[0].errorCount = 0; + results[0].warningCount = 0; + results[0].fixableErrorCount = 0; + results[0].fixableWarningCount = 0; + + for (const file of results) { + file.filePath = "foo.js"; + + file.errorCount = 0; + file.warningCount = 0; + file.fixableErrorCount = 0; + file.fixableWarningCount = 0; + + file.source = "foo"; + file.output = "foo"; + + for (const message of file.messages) { + message.ruleId = "foo"; + } + + for (const suppressedMessage of file.suppressedMessages) { + suppressedMessage.suppressions = [ + { + kind: "foo", + justification: "just cuz", + }, + ]; + } + } +})(); + +// #endregion + +// #region ESLintRules + +let eslintConfig: Linter.Config; + +eslintConfig = { + rules: { + "capitalized-comments": [2, "always", { ignorePattern: "const|let" }], + "no-promise-executor-return": [2, { allowVoid: true }], + "sort-keys": [2, "asc", { allowLineSeparatedGroups: true }], + }, + overrides: [{ + files: "*.json", + rules: { + "max-len": 0, + }, + }, { + files: "*.ts", + rules: { + "@typescript-eslint/no-invalid-void-type": [2, { allowAsThisParameter: true }], + }, + }], +}; + +eslintConfig.rules; // $ExpectType Partial | undefined +eslintConfig.overrides?.[0].rules; // $ExpectType Partial | undefined + +interface TSLinterRules { + "@typescript-eslint/no-invalid-void-type"?: Linter.RuleEntry<[ + Partial<{ + allowInGenericTypeArguments: boolean | string[]; + allowAsThisParameter: boolean; + }>, + ]>; +} + +const eslintConfig2: Linter.Config = eslintConfig; + +eslintConfig2.rules; // $ExpectType Partial | undefined +eslintConfig2.overrides?.[1].rules; // $ExpectType Partial | undefined + +const eslintConfig3: Linter.Config = eslintConfig2; + +eslintConfig3.rules; // $ExpectType Partial | undefined +eslintConfig3.overrides?.[1].rules; // $ExpectType Partial | undefined + +let legacyConfig: Linter.LegacyConfig = eslintConfig; +eslintConfig = legacyConfig; + +// #endregion + +// #region RuleTester + +const ruleTester = new RuleTester({ parserOptions: { ecmaVersion: 2015 } }); + +ruleTester.run("my-rule", rule, { + valid: [ + { code: "foo" }, + { code: "foo", options: [{ allowFoo: true }] }, + { code: "foo", filename: "test.js" }, + { code: "foo", parserOptions: {} }, + { code: "foo", settings: { foo: true } }, + { code: "foo", parser: "foo" }, + { code: "foo", globals: { foo: true } }, + RuleTester.only("foo"), + ], + + invalid: [ + { code: "foo", errors: 1 }, + { code: "foo", errors: 1, output: "foo" }, + { code: "foo", errors: ["foo"] }, + { code: "foo", errors: [{ message: "foo" }] }, + { code: "foo", errors: [{ message: "foo", type: "foo" }] }, + { code: "foo", errors: [{ message: "foo", data: { foo: true } }] }, + { code: "foo", errors: [{ message: "foo", line: 0 }] }, + { + code: "foo", + errors: [ + { + message: "foo", + suggestions: [ + { + desc: "foo", + output: "foo", + }, + { + messageId: "foo", + output: "foo", + }, + ], + }, + ], + }, + { code: "foo", errors: 1, only: true }, + ], +}); + +ruleTester.run("simple-valid-test", rule, { + valid: ["foo", "bar", { code: "foo", options: [{ allowFoo: true }] }], +}); + +// #endregion + +// #region FlatConfig + +((): Linter.FlatConfig => ({ + languageOptions: { + parser: { + parse: () => AST, + }, + }, +})); + +((): Linter.FlatConfig => ({ + languageOptions: { + parser: { + parseForESLint: () => ({ ast: AST }), + }, + }, +})); + +((): Linter.FlatConfig => ({ + languageOptions: { + // @ts-expect-error + parser: "foo-parser", + }, +})); + +((): Linter.FlatConfig => ({ files: ["abc"] })); +((): Linter.FlatConfig => ({ files: [["abc"]] })); + +((): Linter.FlatConfig => ({ + // @ts-expect-error // Second level of nesting is not allowed + files: ["abc", ["abc"], [["abc"]]], +})); + +((): Linter.FlatConfig => ({ ignores: ["abc"] })); + +((): Linter.FlatConfig => ({ + // @ts-expect-error // No nesting + ignores: ["abc", ["abc"]], +})); + +// @ts-expect-error // Must be an array +((): Linter.FlatConfig => ({ files: "abc" })); + +// @ts-expect-error // Must be an array +((): Linter.FlatConfig => ({ ignores: "abc" })); + +((): Linter.FlatConfig => ({ linterOptions: { reportUnusedDisableDirectives: "error" } })); +((): Linter.FlatConfig => ({ linterOptions: { reportUnusedDisableDirectives: "warn" } })); +((): Linter.FlatConfig => ({ linterOptions: { reportUnusedDisableDirectives: "off" } })); +((): Linter.FlatConfig => ({ linterOptions: { reportUnusedDisableDirectives: 2 } })); +((): Linter.FlatConfig => ({ linterOptions: { reportUnusedDisableDirectives: 1 } })); +((): Linter.FlatConfig => ({ linterOptions: { reportUnusedDisableDirectives: 0 } })); +((): Linter.FlatConfig => ({ linterOptions: { reportUnusedDisableDirectives: true } })); +((): Linter.FlatConfig => ({ linterOptions: { reportUnusedDisableDirectives: false } })); + +// @ts-expect-error +((): Linter.FlatConfig => ({ linterOptions: { reportUnusedDisableDirectives: "on" } })); + +// @ts-expect-error +((): Linter.FlatConfig => ({ linterOptions: { reportUnusedDisableDirectives: 3 } })); + +// @ts-expect-error +((): Linter.FlatConfig => ({ linterOptions: { reportUnusedDisableDirectives: null } })); + +((): Linter.FlatConfig => ({ name: "eslint:js" })); + +// @ts-expect-error // Generic passed in does not match the RuleEntry schema +((): Linter.FlatConfig<{ foo?: "bar" }> => ({ + rules: {}, +})); + +((): Linter.FlatConfig<{ foo?: Linter.RuleEntry<[1 | 2]> }> => ({ + rules: { + foo: "error", + }, +})); + +((): Linter.FlatConfig<{ foo?: Linter.RuleEntry<[1 | 2]> }> => ({ + rules: { + // @ts-expect-error // Invalid value + foo: ["error", 3], + }, +})); + +((): Linter.FlatConfig<{ foo?: Linter.RuleEntry }> => ({ + rules: { + // @ts-expect-error // Unspecified value + bar: "error", + }, +})); + +((): Linter.FlatConfig<{ foo: Linter.RuleEntry<[1 | 2]>; [x: string]: Linter.RuleEntry }> => ({ + rules: { + // @ts-expect-error // Invalid value + foo: ["error", 3], + // Wildcard values are supported + bar: 2, + baz: "off", + // @ts-expect-error // Invalid value + "foo/bar": "bar", + }, +})); + +// The following _should_ be an error, but we can't enforce on consumers +// as it requires exactOptionalPropertyTypes: true +// (): Linter.FlatConfig => ({ files: undefined }); +// (): Linter.FlatConfig => ({ ignores: undefined }); + +((): ESLint.Plugin => ({ + configs: { + "old-style": { + parser: "foo-parser", + }, + + // @ts-expect-error + "old-style-array": [{ parser: "foo-parser" }], + + "new-style": { + languageOptions: { + parser: { + parseForESLint: () => ({ ast: AST }), + }, + }, + }, + + "new-style-array": [{ + languageOptions: { + parser: { + parseForESLint: () => ({ ast: AST }), + }, + }, + }], + }, +})); + +// #endregion diff --git a/types/eslint/helpers.d.ts b/types/eslint/v8/helpers.d.ts similarity index 100% rename from types/eslint/helpers.d.ts rename to types/eslint/v8/helpers.d.ts diff --git a/types/eslint/v8/index.d.ts b/types/eslint/v8/index.d.ts new file mode 100644 index 00000000000000..70bd1fbf01306a --- /dev/null +++ b/types/eslint/v8/index.d.ts @@ -0,0 +1,1510 @@ +/// + +import * as ESTree from "estree"; +import { JSONSchema4 } from "json-schema"; + +export namespace AST { + type TokenType = + | "Boolean" + | "Null" + | "Identifier" + | "Keyword" + | "Punctuator" + | "JSXIdentifier" + | "JSXText" + | "Numeric" + | "String" + | "RegularExpression"; + + interface Token { + type: TokenType; + value: string; + range: Range; + loc: SourceLocation; + } + + interface SourceLocation { + start: ESTree.Position; + end: ESTree.Position; + } + + type Range = [number, number]; + + interface Program extends ESTree.Program { + comments: ESTree.Comment[]; + tokens: Token[]; + loc: SourceLocation; + range: Range; + } +} + +export namespace Scope { + interface ScopeManager { + scopes: Scope[]; + globalScope: Scope | null; + + acquire(node: ESTree.Node, inner?: boolean): Scope | null; + + getDeclaredVariables(node: ESTree.Node): Variable[]; + } + + interface Scope { + type: + | "block" + | "catch" + | "class" + | "for" + | "function" + | "function-expression-name" + | "global" + | "module" + | "switch" + | "with" + | "TDZ"; + isStrict: boolean; + upper: Scope | null; + childScopes: Scope[]; + variableScope: Scope; + block: ESTree.Node; + variables: Variable[]; + set: Map; + references: Reference[]; + through: Reference[]; + functionExpressionScope: boolean; + } + + interface Variable { + name: string; + scope: Scope; + identifiers: ESTree.Identifier[]; + references: Reference[]; + defs: Definition[]; + } + + interface Reference { + identifier: ESTree.Identifier; + from: Scope; + resolved: Variable | null; + writeExpr: ESTree.Node | null; + init: boolean; + + isWrite(): boolean; + + isRead(): boolean; + + isWriteOnly(): boolean; + + isReadOnly(): boolean; + + isReadWrite(): boolean; + } + + type DefinitionType = + | { type: "CatchClause"; node: ESTree.CatchClause; parent: null } + | { type: "ClassName"; node: ESTree.ClassDeclaration | ESTree.ClassExpression; parent: null } + | { type: "FunctionName"; node: ESTree.FunctionDeclaration | ESTree.FunctionExpression; parent: null } + | { type: "ImplicitGlobalVariable"; node: ESTree.Program; parent: null } + | { + type: "ImportBinding"; + node: ESTree.ImportSpecifier | ESTree.ImportDefaultSpecifier | ESTree.ImportNamespaceSpecifier; + parent: ESTree.ImportDeclaration; + } + | { + type: "Parameter"; + node: ESTree.FunctionDeclaration | ESTree.FunctionExpression | ESTree.ArrowFunctionExpression; + parent: null; + } + | { type: "TDZ"; node: any; parent: null } + | { type: "Variable"; node: ESTree.VariableDeclarator; parent: ESTree.VariableDeclaration }; + + type Definition = DefinitionType & { name: ESTree.Identifier }; +} + +// #region SourceCode + +export class SourceCode { + text: string; + ast: AST.Program; + lines: string[]; + hasBOM: boolean; + parserServices: SourceCode.ParserServices; + scopeManager: Scope.ScopeManager; + visitorKeys: SourceCode.VisitorKeys; + + constructor(text: string, ast: AST.Program); + constructor(config: SourceCode.Config); + + static splitLines(text: string): string[]; + + getText(node?: ESTree.Node, beforeCount?: number, afterCount?: number): string; + + getLines(): string[]; + + getAllComments(): ESTree.Comment[]; + + getAncestors(node: ESTree.Node): ESTree.Node[]; + + getComments(node: ESTree.Node): { leading: ESTree.Comment[]; trailing: ESTree.Comment[] }; + + getDeclaredVariables(node: ESTree.Node): Scope.Variable[]; + + getJSDocComment(node: ESTree.Node): ESTree.Comment | null; + + getNodeByRangeIndex(index: number): ESTree.Node | null; + + isSpaceBetweenTokens(first: AST.Token, second: AST.Token): boolean; + + getLocFromIndex(index: number): ESTree.Position; + + getIndexFromLoc(location: ESTree.Position): number; + + // Inherited methods from TokenStore + // --------------------------------- + + getTokenByRangeStart(offset: number, options?: { includeComments: false }): AST.Token | null; + getTokenByRangeStart(offset: number, options: { includeComments: boolean }): AST.Token | ESTree.Comment | null; + + getFirstToken: SourceCode.UnaryNodeCursorWithSkipOptions; + + getFirstTokens: SourceCode.UnaryNodeCursorWithCountOptions; + + getLastToken: SourceCode.UnaryNodeCursorWithSkipOptions; + + getLastTokens: SourceCode.UnaryNodeCursorWithCountOptions; + + getTokenBefore: SourceCode.UnaryCursorWithSkipOptions; + + getTokensBefore: SourceCode.UnaryCursorWithCountOptions; + + getTokenAfter: SourceCode.UnaryCursorWithSkipOptions; + + getTokensAfter: SourceCode.UnaryCursorWithCountOptions; + + getFirstTokenBetween: SourceCode.BinaryCursorWithSkipOptions; + + getFirstTokensBetween: SourceCode.BinaryCursorWithCountOptions; + + getLastTokenBetween: SourceCode.BinaryCursorWithSkipOptions; + + getLastTokensBetween: SourceCode.BinaryCursorWithCountOptions; + + getTokensBetween: SourceCode.BinaryCursorWithCountOptions; + + getTokens: + & ((node: ESTree.Node, beforeCount?: number, afterCount?: number) => AST.Token[]) + & SourceCode.UnaryNodeCursorWithCountOptions; + + commentsExistBetween( + left: ESTree.Node | AST.Token | ESTree.Comment, + right: ESTree.Node | AST.Token | ESTree.Comment, + ): boolean; + + getCommentsBefore(nodeOrToken: ESTree.Node | AST.Token): ESTree.Comment[]; + + getCommentsAfter(nodeOrToken: ESTree.Node | AST.Token): ESTree.Comment[]; + + getCommentsInside(node: ESTree.Node): ESTree.Comment[]; + + getScope(node: ESTree.Node): Scope.Scope; + + isSpaceBetween( + first: ESTree.Node | AST.Token, + second: ESTree.Node | AST.Token, + ): boolean; + + markVariableAsUsed(name: string, refNode?: ESTree.Node): boolean; +} + +export namespace SourceCode { + interface Config { + text: string; + ast: AST.Program; + parserServices?: ParserServices | undefined; + scopeManager?: Scope.ScopeManager | undefined; + visitorKeys?: VisitorKeys | undefined; + } + + type ParserServices = any; + + interface VisitorKeys { + [nodeType: string]: string[]; + } + + interface UnaryNodeCursorWithSkipOptions { + ( + node: ESTree.Node, + options: + | ((token: AST.Token) => token is T) + | { + filter: (token: AST.Token) => token is T; + includeComments?: false | undefined; + skip?: number | undefined; + }, + ): T | null; + ( + node: ESTree.Node, + options: { + filter: (tokenOrComment: AST.Token | ESTree.Comment) => tokenOrComment is T; + includeComments: boolean; + skip?: number | undefined; + }, + ): T | null; + ( + node: ESTree.Node, + options?: + | { + filter?: ((token: AST.Token) => boolean) | undefined; + includeComments?: false | undefined; + skip?: number | undefined; + } + | ((token: AST.Token) => boolean) + | number, + ): AST.Token | null; + ( + node: ESTree.Node, + options: { + filter?: ((token: AST.Token | ESTree.Comment) => boolean) | undefined; + includeComments: boolean; + skip?: number | undefined; + }, + ): AST.Token | ESTree.Comment | null; + } + + interface UnaryNodeCursorWithCountOptions { + ( + node: ESTree.Node, + options: + | ((token: AST.Token) => token is T) + | { + filter: (token: AST.Token) => token is T; + includeComments?: false | undefined; + count?: number | undefined; + }, + ): T[]; + ( + node: ESTree.Node, + options: { + filter: (tokenOrComment: AST.Token | ESTree.Comment) => tokenOrComment is T; + includeComments: boolean; + count?: number | undefined; + }, + ): T[]; + ( + node: ESTree.Node, + options?: + | { + filter?: ((token: AST.Token) => boolean) | undefined; + includeComments?: false | undefined; + count?: number | undefined; + } + | ((token: AST.Token) => boolean) + | number, + ): AST.Token[]; + ( + node: ESTree.Node, + options: { + filter?: ((token: AST.Token | ESTree.Comment) => boolean) | undefined; + includeComments: boolean; + count?: number | undefined; + }, + ): Array; + } + + interface UnaryCursorWithSkipOptions { + ( + node: ESTree.Node | AST.Token | ESTree.Comment, + options: + | ((token: AST.Token) => token is T) + | { + filter: (token: AST.Token) => token is T; + includeComments?: false | undefined; + skip?: number | undefined; + }, + ): T | null; + ( + node: ESTree.Node | AST.Token | ESTree.Comment, + options: { + filter: (tokenOrComment: AST.Token | ESTree.Comment) => tokenOrComment is T; + includeComments: boolean; + skip?: number | undefined; + }, + ): T | null; + ( + node: ESTree.Node | AST.Token | ESTree.Comment, + options?: + | { + filter?: ((token: AST.Token) => boolean) | undefined; + includeComments?: false | undefined; + skip?: number | undefined; + } + | ((token: AST.Token) => boolean) + | number, + ): AST.Token | null; + ( + node: ESTree.Node | AST.Token | ESTree.Comment, + options: { + filter?: ((token: AST.Token | ESTree.Comment) => boolean) | undefined; + includeComments: boolean; + skip?: number | undefined; + }, + ): AST.Token | ESTree.Comment | null; + } + + interface UnaryCursorWithCountOptions { + ( + node: ESTree.Node | AST.Token | ESTree.Comment, + options: + | ((token: AST.Token) => token is T) + | { + filter: (token: AST.Token) => token is T; + includeComments?: false | undefined; + count?: number | undefined; + }, + ): T[]; + ( + node: ESTree.Node | AST.Token | ESTree.Comment, + options: { + filter: (tokenOrComment: AST.Token | ESTree.Comment) => tokenOrComment is T; + includeComments: boolean; + count?: number | undefined; + }, + ): T[]; + ( + node: ESTree.Node | AST.Token | ESTree.Comment, + options?: + | { + filter?: ((token: AST.Token) => boolean) | undefined; + includeComments?: false | undefined; + count?: number | undefined; + } + | ((token: AST.Token) => boolean) + | number, + ): AST.Token[]; + ( + node: ESTree.Node | AST.Token | ESTree.Comment, + options: { + filter?: ((token: AST.Token | ESTree.Comment) => boolean) | undefined; + includeComments: boolean; + count?: number | undefined; + }, + ): Array; + } + + interface BinaryCursorWithSkipOptions { + ( + left: ESTree.Node | AST.Token | ESTree.Comment, + right: ESTree.Node | AST.Token | ESTree.Comment, + options: + | ((token: AST.Token) => token is T) + | { + filter: (token: AST.Token) => token is T; + includeComments?: false | undefined; + skip?: number | undefined; + }, + ): T | null; + ( + left: ESTree.Node | AST.Token | ESTree.Comment, + right: ESTree.Node | AST.Token | ESTree.Comment, + options: { + filter: (tokenOrComment: AST.Token | ESTree.Comment) => tokenOrComment is T; + includeComments: boolean; + skip?: number | undefined; + }, + ): T | null; + ( + left: ESTree.Node | AST.Token | ESTree.Comment, + right: ESTree.Node | AST.Token | ESTree.Comment, + options?: + | { + filter?: ((token: AST.Token) => boolean) | undefined; + includeComments?: false | undefined; + skip?: number | undefined; + } + | ((token: AST.Token) => boolean) + | number, + ): AST.Token | null; + ( + left: ESTree.Node | AST.Token | ESTree.Comment, + right: ESTree.Node | AST.Token | ESTree.Comment, + options: { + filter?: ((token: AST.Token | ESTree.Comment) => boolean) | undefined; + includeComments: boolean; + skip?: number | undefined; + }, + ): AST.Token | ESTree.Comment | null; + } + + interface BinaryCursorWithCountOptions { + ( + left: ESTree.Node | AST.Token | ESTree.Comment, + right: ESTree.Node | AST.Token | ESTree.Comment, + options: + | ((token: AST.Token) => token is T) + | { + filter: (token: AST.Token) => token is T; + includeComments?: false | undefined; + count?: number | undefined; + }, + ): T[]; + ( + left: ESTree.Node | AST.Token | ESTree.Comment, + right: ESTree.Node | AST.Token | ESTree.Comment, + options: { + filter: (tokenOrComment: AST.Token | ESTree.Comment) => tokenOrComment is T; + includeComments: boolean; + count?: number | undefined; + }, + ): T[]; + ( + left: ESTree.Node | AST.Token | ESTree.Comment, + right: ESTree.Node | AST.Token | ESTree.Comment, + options?: + | { + filter?: ((token: AST.Token) => boolean) | undefined; + includeComments?: false | undefined; + count?: number | undefined; + } + | ((token: AST.Token) => boolean) + | number, + ): AST.Token[]; + ( + left: ESTree.Node | AST.Token | ESTree.Comment, + right: ESTree.Node | AST.Token | ESTree.Comment, + options: { + filter?: ((token: AST.Token | ESTree.Comment) => boolean) | undefined; + includeComments: boolean; + count?: number | undefined; + }, + ): Array; + } +} + +// #endregion + +export namespace Rule { + /** + * TODO: Old style rules are planned to be removed in v9, remove this type then (https://github.com/eslint/rfcs/blob/main/designs/2021-schema-object-rules/README.md) + * @deprecated Use `RuleModule` instead. + */ + type OldStyleRule = RuleModule["create"]; + + interface RuleModule { + create(context: RuleContext): RuleListener; + meta?: RuleMetaData | undefined; + schema?: RuleMetaData["schema"]; + } + + type NodeTypes = ESTree.Node["type"]; + interface NodeListener { + ArrayExpression?: ((node: ESTree.ArrayExpression & NodeParentExtension) => void) | undefined; + "ArrayExpression:exit"?: ((node: ESTree.ArrayExpression & NodeParentExtension) => void) | undefined; + ArrayPattern?: ((node: ESTree.ArrayPattern & NodeParentExtension) => void) | undefined; + "ArrayPattern:exit"?: ((node: ESTree.ArrayPattern & NodeParentExtension) => void) | undefined; + ArrowFunctionExpression?: ((node: ESTree.ArrowFunctionExpression & NodeParentExtension) => void) | undefined; + "ArrowFunctionExpression:exit"?: + | ((node: ESTree.ArrowFunctionExpression & NodeParentExtension) => void) + | undefined; + AssignmentExpression?: ((node: ESTree.AssignmentExpression & NodeParentExtension) => void) | undefined; + "AssignmentExpression:exit"?: ((node: ESTree.AssignmentExpression & NodeParentExtension) => void) | undefined; + AssignmentPattern?: ((node: ESTree.AssignmentPattern & NodeParentExtension) => void) | undefined; + "AssignmentPattern:exit"?: ((node: ESTree.AssignmentPattern & NodeParentExtension) => void) | undefined; + AwaitExpression?: ((node: ESTree.AwaitExpression & NodeParentExtension) => void) | undefined; + "AwaitExpression:exit"?: ((node: ESTree.AwaitExpression & NodeParentExtension) => void) | undefined; + BinaryExpression?: ((node: ESTree.BinaryExpression & NodeParentExtension) => void) | undefined; + "BinaryExpression:exit"?: ((node: ESTree.BinaryExpression & NodeParentExtension) => void) | undefined; + BlockStatement?: ((node: ESTree.BlockStatement & NodeParentExtension) => void) | undefined; + "BlockStatement:exit"?: ((node: ESTree.BlockStatement & NodeParentExtension) => void) | undefined; + BreakStatement?: ((node: ESTree.BreakStatement & NodeParentExtension) => void) | undefined; + "BreakStatement:exit"?: ((node: ESTree.BreakStatement & NodeParentExtension) => void) | undefined; + CallExpression?: ((node: ESTree.CallExpression & NodeParentExtension) => void) | undefined; + "CallExpression:exit"?: ((node: ESTree.CallExpression & NodeParentExtension) => void) | undefined; + CatchClause?: ((node: ESTree.CatchClause & NodeParentExtension) => void) | undefined; + "CatchClause:exit"?: ((node: ESTree.CatchClause & NodeParentExtension) => void) | undefined; + ChainExpression?: ((node: ESTree.ChainExpression & NodeParentExtension) => void) | undefined; + "ChainExpression:exit"?: ((node: ESTree.ChainExpression & NodeParentExtension) => void) | undefined; + ClassBody?: ((node: ESTree.ClassBody & NodeParentExtension) => void) | undefined; + "ClassBody:exit"?: ((node: ESTree.ClassBody & NodeParentExtension) => void) | undefined; + ClassDeclaration?: ((node: ESTree.ClassDeclaration & NodeParentExtension) => void) | undefined; + "ClassDeclaration:exit"?: ((node: ESTree.ClassDeclaration & NodeParentExtension) => void) | undefined; + ClassExpression?: ((node: ESTree.ClassExpression & NodeParentExtension) => void) | undefined; + "ClassExpression:exit"?: ((node: ESTree.ClassExpression & NodeParentExtension) => void) | undefined; + ConditionalExpression?: ((node: ESTree.ConditionalExpression & NodeParentExtension) => void) | undefined; + "ConditionalExpression:exit"?: ((node: ESTree.ConditionalExpression & NodeParentExtension) => void) | undefined; + ContinueStatement?: ((node: ESTree.ContinueStatement & NodeParentExtension) => void) | undefined; + "ContinueStatement:exit"?: ((node: ESTree.ContinueStatement & NodeParentExtension) => void) | undefined; + DebuggerStatement?: ((node: ESTree.DebuggerStatement & NodeParentExtension) => void) | undefined; + "DebuggerStatement:exit"?: ((node: ESTree.DebuggerStatement & NodeParentExtension) => void) | undefined; + DoWhileStatement?: ((node: ESTree.DoWhileStatement & NodeParentExtension) => void) | undefined; + "DoWhileStatement:exit"?: ((node: ESTree.DoWhileStatement & NodeParentExtension) => void) | undefined; + EmptyStatement?: ((node: ESTree.EmptyStatement & NodeParentExtension) => void) | undefined; + "EmptyStatement:exit"?: ((node: ESTree.EmptyStatement & NodeParentExtension) => void) | undefined; + ExportAllDeclaration?: ((node: ESTree.ExportAllDeclaration & NodeParentExtension) => void) | undefined; + "ExportAllDeclaration:exit"?: ((node: ESTree.ExportAllDeclaration & NodeParentExtension) => void) | undefined; + ExportDefaultDeclaration?: ((node: ESTree.ExportDefaultDeclaration & NodeParentExtension) => void) | undefined; + "ExportDefaultDeclaration:exit"?: + | ((node: ESTree.ExportDefaultDeclaration & NodeParentExtension) => void) + | undefined; + ExportNamedDeclaration?: ((node: ESTree.ExportNamedDeclaration & NodeParentExtension) => void) | undefined; + "ExportNamedDeclaration:exit"?: + | ((node: ESTree.ExportNamedDeclaration & NodeParentExtension) => void) + | undefined; + ExportSpecifier?: ((node: ESTree.ExportSpecifier & NodeParentExtension) => void) | undefined; + "ExportSpecifier:exit"?: ((node: ESTree.ExportSpecifier & NodeParentExtension) => void) | undefined; + ExpressionStatement?: ((node: ESTree.ExpressionStatement & NodeParentExtension) => void) | undefined; + "ExpressionStatement:exit"?: ((node: ESTree.ExpressionStatement & NodeParentExtension) => void) | undefined; + ForInStatement?: ((node: ESTree.ForInStatement & NodeParentExtension) => void) | undefined; + "ForInStatement:exit"?: ((node: ESTree.ForInStatement & NodeParentExtension) => void) | undefined; + ForOfStatement?: ((node: ESTree.ForOfStatement & NodeParentExtension) => void) | undefined; + "ForOfStatement:exit"?: ((node: ESTree.ForOfStatement & NodeParentExtension) => void) | undefined; + ForStatement?: ((node: ESTree.ForStatement & NodeParentExtension) => void) | undefined; + "ForStatement:exit"?: ((node: ESTree.ForStatement & NodeParentExtension) => void) | undefined; + FunctionDeclaration?: ((node: ESTree.FunctionDeclaration & NodeParentExtension) => void) | undefined; + "FunctionDeclaration:exit"?: ((node: ESTree.FunctionDeclaration & NodeParentExtension) => void) | undefined; + FunctionExpression?: ((node: ESTree.FunctionExpression & NodeParentExtension) => void) | undefined; + "FunctionExpression:exit"?: ((node: ESTree.FunctionExpression & NodeParentExtension) => void) | undefined; + Identifier?: ((node: ESTree.Identifier & NodeParentExtension) => void) | undefined; + "Identifier:exit"?: ((node: ESTree.Identifier & NodeParentExtension) => void) | undefined; + IfStatement?: ((node: ESTree.IfStatement & NodeParentExtension) => void) | undefined; + "IfStatement:exit"?: ((node: ESTree.IfStatement & NodeParentExtension) => void) | undefined; + ImportDeclaration?: ((node: ESTree.ImportDeclaration & NodeParentExtension) => void) | undefined; + "ImportDeclaration:exit"?: ((node: ESTree.ImportDeclaration & NodeParentExtension) => void) | undefined; + ImportDefaultSpecifier?: ((node: ESTree.ImportDefaultSpecifier & NodeParentExtension) => void) | undefined; + "ImportDefaultSpecifier:exit"?: + | ((node: ESTree.ImportDefaultSpecifier & NodeParentExtension) => void) + | undefined; + ImportExpression?: ((node: ESTree.ImportExpression & NodeParentExtension) => void) | undefined; + "ImportExpression:exit"?: ((node: ESTree.ImportExpression & NodeParentExtension) => void) | undefined; + ImportNamespaceSpecifier?: ((node: ESTree.ImportNamespaceSpecifier & NodeParentExtension) => void) | undefined; + "ImportNamespaceSpecifier:exit"?: + | ((node: ESTree.ImportNamespaceSpecifier & NodeParentExtension) => void) + | undefined; + ImportSpecifier?: ((node: ESTree.ImportSpecifier & NodeParentExtension) => void) | undefined; + "ImportSpecifier:exit"?: ((node: ESTree.ImportSpecifier & NodeParentExtension) => void) | undefined; + LabeledStatement?: ((node: ESTree.LabeledStatement & NodeParentExtension) => void) | undefined; + "LabeledStatement:exit"?: ((node: ESTree.LabeledStatement & NodeParentExtension) => void) | undefined; + Literal?: ((node: ESTree.Literal & NodeParentExtension) => void) | undefined; + "Literal:exit"?: ((node: ESTree.Literal & NodeParentExtension) => void) | undefined; + LogicalExpression?: ((node: ESTree.LogicalExpression & NodeParentExtension) => void) | undefined; + "LogicalExpression:exit"?: ((node: ESTree.LogicalExpression & NodeParentExtension) => void) | undefined; + MemberExpression?: ((node: ESTree.MemberExpression & NodeParentExtension) => void) | undefined; + "MemberExpression:exit"?: ((node: ESTree.MemberExpression & NodeParentExtension) => void) | undefined; + MetaProperty?: ((node: ESTree.MetaProperty & NodeParentExtension) => void) | undefined; + "MetaProperty:exit"?: ((node: ESTree.MetaProperty & NodeParentExtension) => void) | undefined; + MethodDefinition?: ((node: ESTree.MethodDefinition & NodeParentExtension) => void) | undefined; + "MethodDefinition:exit"?: ((node: ESTree.MethodDefinition & NodeParentExtension) => void) | undefined; + NewExpression?: ((node: ESTree.NewExpression & NodeParentExtension) => void) | undefined; + "NewExpression:exit"?: ((node: ESTree.NewExpression & NodeParentExtension) => void) | undefined; + ObjectExpression?: ((node: ESTree.ObjectExpression & NodeParentExtension) => void) | undefined; + "ObjectExpression:exit"?: ((node: ESTree.ObjectExpression & NodeParentExtension) => void) | undefined; + ObjectPattern?: ((node: ESTree.ObjectPattern & NodeParentExtension) => void) | undefined; + "ObjectPattern:exit"?: ((node: ESTree.ObjectPattern & NodeParentExtension) => void) | undefined; + PrivateIdentifier?: ((node: ESTree.PrivateIdentifier & NodeParentExtension) => void) | undefined; + "PrivateIdentifier:exit"?: ((node: ESTree.PrivateIdentifier & NodeParentExtension) => void) | undefined; + Program?: ((node: ESTree.Program) => void) | undefined; + "Program:exit"?: ((node: ESTree.Program) => void) | undefined; + Property?: ((node: ESTree.Property & NodeParentExtension) => void) | undefined; + "Property:exit"?: ((node: ESTree.Property & NodeParentExtension) => void) | undefined; + PropertyDefinition?: ((node: ESTree.PropertyDefinition & NodeParentExtension) => void) | undefined; + "PropertyDefinition:exit"?: ((node: ESTree.PropertyDefinition & NodeParentExtension) => void) | undefined; + RestElement?: ((node: ESTree.RestElement & NodeParentExtension) => void) | undefined; + "RestElement:exit"?: ((node: ESTree.RestElement & NodeParentExtension) => void) | undefined; + ReturnStatement?: ((node: ESTree.ReturnStatement & NodeParentExtension) => void) | undefined; + "ReturnStatement:exit"?: ((node: ESTree.ReturnStatement & NodeParentExtension) => void) | undefined; + SequenceExpression?: ((node: ESTree.SequenceExpression & NodeParentExtension) => void) | undefined; + "SequenceExpression:exit"?: ((node: ESTree.SequenceExpression & NodeParentExtension) => void) | undefined; + SpreadElement?: ((node: ESTree.SpreadElement & NodeParentExtension) => void) | undefined; + "SpreadElement:exit"?: ((node: ESTree.SpreadElement & NodeParentExtension) => void) | undefined; + StaticBlock?: ((node: ESTree.StaticBlock & NodeParentExtension) => void) | undefined; + "StaticBlock:exit"?: ((node: ESTree.StaticBlock & NodeParentExtension) => void) | undefined; + Super?: ((node: ESTree.Super & NodeParentExtension) => void) | undefined; + "Super:exit"?: ((node: ESTree.Super & NodeParentExtension) => void) | undefined; + SwitchCase?: ((node: ESTree.SwitchCase & NodeParentExtension) => void) | undefined; + "SwitchCase:exit"?: ((node: ESTree.SwitchCase & NodeParentExtension) => void) | undefined; + SwitchStatement?: ((node: ESTree.SwitchStatement & NodeParentExtension) => void) | undefined; + "SwitchStatement:exit"?: ((node: ESTree.SwitchStatement & NodeParentExtension) => void) | undefined; + TaggedTemplateExpression?: ((node: ESTree.TaggedTemplateExpression & NodeParentExtension) => void) | undefined; + "TaggedTemplateExpression:exit"?: + | ((node: ESTree.TaggedTemplateExpression & NodeParentExtension) => void) + | undefined; + TemplateElement?: ((node: ESTree.TemplateElement & NodeParentExtension) => void) | undefined; + "TemplateElement:exit"?: ((node: ESTree.TemplateElement & NodeParentExtension) => void) | undefined; + TemplateLiteral?: ((node: ESTree.TemplateLiteral & NodeParentExtension) => void) | undefined; + "TemplateLiteral:exit"?: ((node: ESTree.TemplateLiteral & NodeParentExtension) => void) | undefined; + ThisExpression?: ((node: ESTree.ThisExpression & NodeParentExtension) => void) | undefined; + "ThisExpression:exit"?: ((node: ESTree.ThisExpression & NodeParentExtension) => void) | undefined; + ThrowStatement?: ((node: ESTree.ThrowStatement & NodeParentExtension) => void) | undefined; + "ThrowStatement:exit"?: ((node: ESTree.ThrowStatement & NodeParentExtension) => void) | undefined; + TryStatement?: ((node: ESTree.TryStatement & NodeParentExtension) => void) | undefined; + "TryStatement:exit"?: ((node: ESTree.TryStatement & NodeParentExtension) => void) | undefined; + UnaryExpression?: ((node: ESTree.UnaryExpression & NodeParentExtension) => void) | undefined; + "UnaryExpression:exit"?: ((node: ESTree.UnaryExpression & NodeParentExtension) => void) | undefined; + UpdateExpression?: ((node: ESTree.UpdateExpression & NodeParentExtension) => void) | undefined; + "UpdateExpression:exit"?: ((node: ESTree.UpdateExpression & NodeParentExtension) => void) | undefined; + VariableDeclaration?: ((node: ESTree.VariableDeclaration & NodeParentExtension) => void) | undefined; + "VariableDeclaration:exit"?: ((node: ESTree.VariableDeclaration & NodeParentExtension) => void) | undefined; + VariableDeclarator?: ((node: ESTree.VariableDeclarator & NodeParentExtension) => void) | undefined; + "VariableDeclarator:exit"?: ((node: ESTree.VariableDeclarator & NodeParentExtension) => void) | undefined; + WhileStatement?: ((node: ESTree.WhileStatement & NodeParentExtension) => void) | undefined; + "WhileStatement:exit"?: ((node: ESTree.WhileStatement & NodeParentExtension) => void) | undefined; + WithStatement?: ((node: ESTree.WithStatement & NodeParentExtension) => void) | undefined; + "WithStatement:exit"?: ((node: ESTree.WithStatement & NodeParentExtension) => void) | undefined; + YieldExpression?: ((node: ESTree.YieldExpression & NodeParentExtension) => void) | undefined; + "YieldExpression:exit"?: ((node: ESTree.YieldExpression & NodeParentExtension) => void) | undefined; + } + + interface NodeParentExtension { + parent: Node; + } + type Node = ESTree.Node & NodeParentExtension; + + interface RuleListener extends NodeListener { + onCodePathStart?(codePath: CodePath, node: Node): void; + + onCodePathEnd?(codePath: CodePath, node: Node): void; + + onCodePathSegmentStart?(segment: CodePathSegment, node: Node): void; + + onCodePathSegmentEnd?(segment: CodePathSegment, node: Node): void; + + onCodePathSegmentLoop?(fromSegment: CodePathSegment, toSegment: CodePathSegment, node: Node): void; + + [key: string]: + | ((codePath: CodePath, node: Node) => void) + | ((segment: CodePathSegment, node: Node) => void) + | ((fromSegment: CodePathSegment, toSegment: CodePathSegment, node: Node) => void) + | ((node: Node) => void) + | NodeListener[keyof NodeListener] + | undefined; + } + + interface CodePath { + id: string; + initialSegment: CodePathSegment; + finalSegments: CodePathSegment[]; + returnedSegments: CodePathSegment[]; + thrownSegments: CodePathSegment[]; + currentSegments: CodePathSegment[]; + upper: CodePath | null; + childCodePaths: CodePath[]; + } + + interface CodePathSegment { + id: string; + nextSegments: CodePathSegment[]; + prevSegments: CodePathSegment[]; + reachable: boolean; + } + + interface RuleMetaData { + /** Properties often used for documentation generation and tooling. */ + docs?: { + /** Provides a short description of the rule. Commonly used when generating lists of rules. */ + description?: string | undefined; + /** Historically used by some plugins that divide rules into categories in their documentation. */ + category?: string | undefined; + /** Historically used by some plugins to indicate a rule belongs in their `recommended` configuration. */ + recommended?: boolean | undefined; + /** Specifies the URL at which the full documentation can be accessed. Code editors often use this to provide a helpful link on highlighted rule violations. */ + url?: string | undefined; + /** + * TODO: remove this field in next major release of @types/eslint. + * @deprecated use `meta.hasSuggestions` instead + */ + suggestion?: boolean | undefined; + } | undefined; + /** Violation and suggestion messages. */ + messages?: { [messageId: string]: string } | undefined; + /** + * Specifies if the `--fix` option on the command line automatically fixes problems reported by the rule. + * Mandatory for fixable rules. + */ + fixable?: "code" | "whitespace" | undefined; + /** + * Specifies the [options](https://eslint.org/docs/latest/developer-guide/working-with-rules#options-schemas) + * so ESLint can prevent invalid [rule configurations](https://eslint.org/docs/latest/user-guide/configuring/rules#configuring-rules). + * Mandatory for rules with options. + */ + schema?: JSONSchema4 | JSONSchema4[] | undefined; + + /** Indicates whether the rule has been deprecated. Omit if not deprecated. */ + deprecated?: boolean | undefined; + /** The name of the rule(s) this rule was replaced by, if it was deprecated. */ + replacedBy?: readonly string[]; + + /** + * Indicates the type of rule: + * - `"problem"` means the rule is identifying code that either will cause an error or may cause a confusing behavior. Developers should consider this a high priority to resolve. + * - `"suggestion"` means the rule is identifying something that could be done in a better way but no errors will occur if the code isn’t changed. + * - `"layout"` means the rule cares primarily about whitespace, semicolons, commas, and parentheses, + * all the parts of the program that determine how the code looks rather than how it executes. + * These rules work on parts of the code that aren’t specified in the AST. + */ + type?: "problem" | "suggestion" | "layout" | undefined; + /** + * Specifies whether the rule can return suggestions (defaults to `false` if omitted). + * Mandatory for rules that provide suggestions. + */ + hasSuggestions?: boolean | undefined; + } + + interface RuleContext { + id: string; + options: any[]; + settings: { [name: string]: any }; + parserPath: string | undefined; + languageOptions: Linter.FlatConfig["languageOptions"]; + parserOptions: Linter.ParserOptions; + parserServices: SourceCode.ParserServices; + cwd: string; + filename: string; + physicalFilename: string; + sourceCode: SourceCode; + + getAncestors(): ESTree.Node[]; + + getDeclaredVariables(node: ESTree.Node): Scope.Variable[]; + + /** @deprecated Use property `filename` directly instead */ + getFilename(): string; + + /** @deprecated Use property `physicalFilename` directly instead */ + getPhysicalFilename(): string; + + /** @deprecated Use property `cwd` directly instead */ + getCwd(): string; + + getScope(): Scope.Scope; + + /** @deprecated Use property `sourceCode` directly instead */ + getSourceCode(): SourceCode; + + markVariableAsUsed(name: string): boolean; + + report(descriptor: ReportDescriptor): void; + } + + type ReportFixer = (fixer: RuleFixer) => null | Fix | IterableIterator | Fix[]; + + interface ReportDescriptorOptionsBase { + data?: { [key: string]: string }; + + fix?: null | ReportFixer; + } + + interface SuggestionReportOptions { + data?: { [key: string]: string }; + + fix: ReportFixer; + } + + type SuggestionDescriptorMessage = { desc: string } | { messageId: string }; + type SuggestionReportDescriptor = SuggestionDescriptorMessage & SuggestionReportOptions; + + interface ReportDescriptorOptions extends ReportDescriptorOptionsBase { + suggest?: SuggestionReportDescriptor[] | null | undefined; + } + + type ReportDescriptor = ReportDescriptorMessage & ReportDescriptorLocation & ReportDescriptorOptions; + type ReportDescriptorMessage = { message: string } | { messageId: string }; + type ReportDescriptorLocation = + | { node: ESTree.Node } + | { loc: AST.SourceLocation | { line: number; column: number } }; + + interface RuleFixer { + insertTextAfter(nodeOrToken: ESTree.Node | AST.Token, text: string): Fix; + + insertTextAfterRange(range: AST.Range, text: string): Fix; + + insertTextBefore(nodeOrToken: ESTree.Node | AST.Token, text: string): Fix; + + insertTextBeforeRange(range: AST.Range, text: string): Fix; + + remove(nodeOrToken: ESTree.Node | AST.Token): Fix; + + removeRange(range: AST.Range): Fix; + + replaceText(nodeOrToken: ESTree.Node | AST.Token, text: string): Fix; + + replaceTextRange(range: AST.Range, text: string): Fix; + } + + interface Fix { + range: AST.Range; + text: string; + } +} + +// #region Linter + +export class Linter { + static version: string; + + version: string; + + constructor(options?: { cwd?: string | undefined; configType?: "flat" | "eslintrc" }); + + verify( + code: SourceCode | string, + config: Linter.Config | Linter.FlatConfig[], + filename?: string, + ): Linter.LintMessage[]; + verify( + code: SourceCode | string, + config: Linter.Config | Linter.FlatConfig[], + options: Linter.LintOptions, + ): Linter.LintMessage[]; + + verifyAndFix(code: string, config: Linter.Config | Linter.FlatConfig[], filename?: string): Linter.FixReport; + verifyAndFix( + code: string, + config: Linter.Config | Linter.FlatConfig[], + options: Linter.FixOptions, + ): Linter.FixReport; + + getSourceCode(): SourceCode; + + defineRule(name: string, rule: Rule.RuleModule): void; + + defineRules(rules: { [name: string]: Rule.RuleModule }): void; + + getRules(): Map; + + defineParser(name: string, parser: Linter.ParserModule): void; +} + +export namespace Linter { + /** + * The numeric severity level for a rule. + * + * - `0` means off. + * - `1` means warn. + * - `2` means error. + * + * @see [Rule Severities](https://eslint.org/docs/latest/use/configure/rules#rule-severities) + */ + type Severity = 0 | 1 | 2; + + /** + * The human readable severity level for a rule. + * + * @see [Rule Severities](https://eslint.org/docs/latest/use/configure/rules#rule-severities) + */ + type StringSeverity = "off" | "warn" | "error"; + + /** + * The numeric or human readable severity level for a rule. + * + * @see [Rule Severities](https://eslint.org/docs/latest/use/configure/rules#rule-severities) + */ + type RuleLevel = Severity | StringSeverity; + + /** + * An array containing the rule severity level, followed by the rule options. + * + * @see [Rules](https://eslint.org/docs/user-guide/configuring/rules) + */ + type RuleLevelAndOptions = Prepend, RuleLevel>; + + /** + * The severity level for the rule or an array containing the rule severity level, followed by the rule options. + * + * @see [Rules](https://eslint.org/docs/user-guide/configuring/rules) + */ + type RuleEntry = RuleLevel | RuleLevelAndOptions; + + /** + * The rules config object is a key/value map of rule names and their severity and options. + */ + interface RulesRecord { + [rule: string]: RuleEntry; + } + + /** + * A configuration object that may have a `rules` block. + */ + interface HasRules { + rules?: Partial | undefined; + } + + /** + * ESLint configuration. + * + * @see [ESLint Configuration](https://eslint.org/docs/latest/user-guide/configuring/) + */ + interface BaseConfig + extends HasRules + { + $schema?: string | undefined; + + /** + * An environment provides predefined global variables. + * + * @see [Environments](https://eslint.org/docs/latest/user-guide/configuring/language-options#specifying-environments) + */ + env?: { [name: string]: boolean } | undefined; + + /** + * Extending configuration files. + * + * @see [Extends](https://eslint.org/docs/latest/user-guide/configuring/configuration-files#extending-configuration-files) + */ + extends?: string | string[] | undefined; + + /** + * Specifying globals. + * + * @see [Globals](https://eslint.org/docs/latest/user-guide/configuring/language-options#specifying-globals) + */ + globals?: { [name: string]: boolean | "off" | "readonly" | "readable" | "writable" | "writeable" } | undefined; + + /** + * Disable processing of inline comments. + * + * @see [Disabling Inline Comments](https://eslint.org/docs/latest/user-guide/configuring/rules#disabling-inline-comments) + */ + noInlineConfig?: boolean | undefined; + + /** + * Overrides can be used to use a differing configuration for matching sub-directories and files. + * + * @see [How do overrides work](https://eslint.org/docs/latest/user-guide/configuring/configuration-files#how-do-overrides-work) + */ + overrides?: Array> | undefined; + + /** + * Parser. + * + * @see [Working with Custom Parsers](https://eslint.org/docs/latest/developer-guide/working-with-custom-parsers) + * @see [Specifying Parser](https://eslint.org/docs/latest/user-guide/configuring/plugins#configure-a-parser) + */ + parser?: string | undefined; + + /** + * Parser options. + * + * @see [Working with Custom Parsers](https://eslint.org/docs/latest/developer-guide/working-with-custom-parsers) + * @see [Specifying Parser Options](https://eslint.org/docs/latest/user-guide/configuring/language-options#specifying-parser-options) + */ + parserOptions?: ParserOptions | undefined; + + /** + * Which third-party plugins define additional rules, environments, configs, etc. for ESLint to use. + * + * @see [Configuring Plugins](https://eslint.org/docs/latest/user-guide/configuring/plugins#configure-plugins) + */ + plugins?: string[] | undefined; + + /** + * Specifying processor. + * + * @see [processor](https://eslint.org/docs/latest/user-guide/configuring/plugins#specify-a-processor) + */ + processor?: string | undefined; + + /** + * Report unused `ESLint-disable` comments as warning. + * + * @see [Report unused `ESLint-disable` comments](https://eslint.org/docs/latest/user-guide/configuring/rules#report-unused-eslint-disable-comments) + */ + reportUnusedDisableDirectives?: boolean | undefined; + + /** + * Settings. + * + * @see [Settings](https://eslint.org/docs/latest/user-guide/configuring/configuration-files#adding-shared-settings) + */ + settings?: { [name: string]: any } | undefined; + } + + /** + * The overwrites that apply more differing configuration to specific files or directories. + */ + interface ConfigOverride extends BaseConfig { + /** + * The glob patterns for excluded files. + */ + excludedFiles?: string | string[] | undefined; + + /** + * The glob patterns for target files. + */ + files: string | string[]; + } + + /** + * ESLint configuration. + * + * @see [ESLint Configuration](https://eslint.org/docs/latest/user-guide/configuring/) + */ + // https://github.com/eslint/eslint/blob/v6.8.0/conf/config-schema.js + interface Config + extends BaseConfig + { + /** + * Tell ESLint to ignore specific files and directories. + * + * @see [Ignore Patterns](https://eslint.org/docs/latest/user-guide/configuring/ignoring-code) + */ + ignorePatterns?: string | string[] | undefined; + + /** + * @see [Using Configuration Files](https://eslint.org/docs/latest/user-guide/configuring/configuration-files#using-configuration-files) + */ + root?: boolean | undefined; + } + + /** + * An alias for `Config` for interoperability with `@types/eslint@9`. + */ + type LegacyConfig = Config; + + /** + * Parser options. + * + * @see [Specifying Parser Options](https://eslint.org/docs/user-guide/configuring/language-options#specifying-parser-options) + */ + interface ParserOptions { + /** + * Accepts any valid ECMAScript version number or `'latest'`: + * + * - A version: es3, es5, es6, es7, es8, es9, es10, es11, es12, es13, es14, ..., or + * - A year: es2015, es2016, es2017, es2018, es2019, es2020, es2021, es2022, es2023, ..., or + * - `'latest'` + * + * When it's a version or a year, the value must be a number - so do not include the `es` prefix. + * + * Specifies the version of ECMAScript syntax you want to use. This is used by the parser to determine how to perform scope analysis, and it affects the default + * + * @default 2018 + * + * @see https://typescript-eslint.io/architecture/parser/#ecmaversion + */ + ecmaVersion?: + | 3 + | 5 + | 6 + | 7 + | 8 + | 9 + | 10 + | 11 + | 12 + | 13 + | 14 + | 15 + | 2015 + | 2016 + | 2017 + | 2018 + | 2019 + | 2020 + | 2021 + | 2022 + | 2023 + | 2024 + | "latest" + | undefined; + + /** + * Set to "script" (default) or "module" if your code is in ECMAScript modules. + * + * @default 'script' + * + * @see https://eslint.org/docs/latest/user-guide/configuring/language-options#specifying-parser-options + */ + sourceType?: "script" | "module" | undefined; + + /** + * An object indicating which additional language features you'd like to use. + * + * @see https://eslint.org/docs/latest/user-guide/configuring/language-options#specifying-parser-options + * @see https://typescript-eslint.io/architecture/parser#ecmafeatures + */ + ecmaFeatures?: { + globalReturn?: boolean | undefined; + impliedStrict?: boolean | undefined; + jsx?: boolean | undefined; + experimentalObjectRestSpread?: boolean | undefined; + [key: string]: any; + } | undefined; + [key: string]: any; + } + + interface LintOptions { + filename?: string | undefined; + preprocess?: ((code: string) => string[]) | undefined; + postprocess?: ((problemLists: LintMessage[][]) => LintMessage[]) | undefined; + filterCodeBlock?: boolean | undefined; + disableFixes?: boolean | undefined; + allowInlineConfig?: boolean | undefined; + reportUnusedDisableDirectives?: boolean | undefined; + } + + interface LintSuggestion { + desc: string; + fix: Rule.Fix; + messageId?: string | undefined; + } + + interface LintMessage { + column: number; + line: number; + endColumn?: number | undefined; + endLine?: number | undefined; + ruleId: string | null; + message: string; + messageId?: string | undefined; + nodeType?: string | undefined; + fatal?: true | undefined; + severity: Severity; + fix?: Rule.Fix | undefined; + /** @deprecated Use `linter.getSourceCode()` */ + source?: string | null | undefined; + suggestions?: LintSuggestion[] | undefined; + } + + interface LintSuppression { + kind: string; + justification: string; + } + + interface SuppressedLintMessage extends LintMessage { + suppressions: LintSuppression[]; + } + + interface FixOptions extends LintOptions { + fix?: boolean | undefined; + } + + interface FixReport { + fixed: boolean; + output: string; + messages: LintMessage[]; + } + + // Temporarily loosen type for just flat config files (see #68232) + type FlatConfigParserModule = + & Omit + & ({ + parse(text: string, options?: any): unknown; + } | { + parseForESLint(text: string, options?: any): Omit & { + ast: unknown; + scopeManager?: unknown; + }; + }); + + type ParserModule = + & ESLint.ObjectMetaProperties + & ( + | { parse(text: string, options?: any): AST.Program } + | { parseForESLint(text: string, options?: any): ESLintParseResult } + ); + + interface ESLintParseResult { + ast: AST.Program; + parserServices?: SourceCode.ParserServices | undefined; + scopeManager?: Scope.ScopeManager | undefined; + visitorKeys?: SourceCode.VisitorKeys | undefined; + } + + interface ProcessorFile { + text: string; + filename: string; + } + + // https://eslint.org/docs/developer-guide/working-with-plugins#processors-in-plugins + interface Processor extends ESLint.ObjectMetaProperties { + supportsAutofix?: boolean | undefined; + preprocess?(text: string, filename: string): T[]; + postprocess?(messages: LintMessage[][], filename: string): LintMessage[]; + } + + interface FlatConfig { + /** + * An string to identify the configuration object. Used in error messages and + * inspection tools. + */ + name?: string; + + /** + * An array of glob patterns indicating the files that the configuration + * object should apply to. If not specified, the configuration object applies + * to all files + */ + files?: Array; + + /** + * An array of glob patterns indicating the files that the configuration + * object should not apply to. If not specified, the configuration object + * applies to all files matched by files + */ + ignores?: string[]; + + /** + * An object containing settings related to how JavaScript is configured for + * linting. + */ + languageOptions?: { + /** + * The version of ECMAScript to support. May be any year (i.e., 2022) or + * version (i.e., 5). Set to "latest" for the most recent supported version. + * @default "latest" + */ + ecmaVersion?: ParserOptions["ecmaVersion"]; + + /** + * The type of JavaScript source code. Possible values are "script" for + * traditional script files, "module" for ECMAScript modules (ESM), and + * "commonjs" for CommonJS files. (default: "module" for .js and .mjs + * files; "commonjs" for .cjs files) + */ + sourceType?: "script" | "module" | "commonjs"; + + /** + * An object specifying additional objects that should be added to the + * global scope during linting. + */ + globals?: ESLint.Environment["globals"]; + + /** + * An object containing a parse() or parseForESLint() method. + * If not configured, the default ESLint parser (Espree) will be used. + */ + parser?: FlatConfigParserModule; + + /** + * An object specifying additional options that are passed directly to the + * parser() method on the parser. The available options are parser-dependent + */ + parserOptions?: ESLint.Environment["parserOptions"]; + }; + + /** + * An object containing settings related to the linting process + */ + linterOptions?: { + /** + * A boolean value indicating if inline configuration is allowed. + */ + noInlineConfig?: boolean; + + /** + * A severity value indicating if and how unused disable directives should be + * tracked and reported. + */ + reportUnusedDisableDirectives?: Severity | StringSeverity | boolean; + }; + + /** + * Either an object containing preprocess() and postprocess() methods or a + * string indicating the name of a processor inside of a plugin + * (i.e., "pluginName/processorName"). + */ + processor?: string | Processor; + + /** + * An object containing a name-value mapping of plugin names to plugin objects. + * When files is specified, these plugins are only available to the matching files. + */ + plugins?: Record; + + /** + * An object containing the configured rules. When files or ignores are specified, + * these rule configurations are only available to the matching files. + */ + rules?: Partial; + + /** + * An object containing name-value pairs of information that should be + * available to all rules. + */ + settings?: Record; + } +} + +// #endregion + +// #region ESLint + +export class ESLint { + static version: string; + + static outputFixes(results: ESLint.LintResult[]): Promise; + + static getErrorResults(results: ESLint.LintResult[]): ESLint.LintResult[]; + + constructor(options?: ESLint.Options); + + lintFiles(patterns: string | string[]): Promise; + + lintText( + code: string, + options?: { filePath?: string | undefined; warnIgnored?: boolean | undefined }, + ): Promise; + + getRulesMetaForResults(results: ESLint.LintResult[]): ESLint.LintResultData["rulesMeta"]; + + calculateConfigForFile(filePath: string): Promise; + + isPathIgnored(filePath: string): Promise; + + loadFormatter(nameOrPath?: string): Promise; +} + +export namespace ESLint { + type ConfigData = Omit, "$schema">; + + interface Globals { + [name: string]: boolean | "writable" | "readonly" | "off"; + } + + interface Environment { + globals?: Globals | undefined; + parserOptions?: Linter.ParserOptions | undefined; + } + + interface ObjectMetaProperties { + /** @deprecated Use `meta.name` instead. */ + name?: string | undefined; + + /** @deprecated Use `meta.version` instead. */ + version?: string | undefined; + + meta?: { + name?: string | undefined; + version?: string | undefined; + }; + } + + interface Plugin extends ObjectMetaProperties { + configs?: Record | undefined; + environments?: Record | undefined; + processors?: Record | undefined; + rules?: Record | undefined; + } + + interface Options { + // File enumeration + cwd?: string | undefined; + errorOnUnmatchedPattern?: boolean | undefined; + extensions?: string[] | undefined; + globInputPaths?: boolean | undefined; + ignore?: boolean | undefined; + ignorePath?: string | undefined; + + // Linting + allowInlineConfig?: boolean | undefined; + baseConfig?: Linter.Config | undefined; + overrideConfig?: Linter.Config | undefined; + overrideConfigFile?: string | undefined; + plugins?: Record | undefined; + reportUnusedDisableDirectives?: Linter.StringSeverity | undefined; + resolvePluginsRelativeTo?: string | undefined; + rulePaths?: string[] | undefined; + useEslintrc?: boolean | undefined; + + // Autofix + fix?: boolean | ((message: Linter.LintMessage) => boolean) | undefined; + fixTypes?: Array | undefined; + + // Cache-related + cache?: boolean | undefined; + cacheLocation?: string | undefined; + cacheStrategy?: "content" | "metadata" | undefined; + } + + interface LintResult { + filePath: string; + messages: Linter.LintMessage[]; + suppressedMessages: Linter.SuppressedLintMessage[]; + errorCount: number; + fatalErrorCount: number; + warningCount: number; + fixableErrorCount: number; + fixableWarningCount: number; + output?: string | undefined; + source?: string | undefined; + usedDeprecatedRules: DeprecatedRuleUse[]; + } + + interface LintResultData { + cwd: string; + rulesMeta: { + [ruleId: string]: Rule.RuleMetaData; + }; + } + + interface DeprecatedRuleUse { + ruleId: string; + replacedBy: string[]; + } + + interface Formatter { + format(results: LintResult[], data?: LintResultData): string | Promise; + } + + // Docs reference the type by this name + type EditInfo = Rule.Fix; +} + +// #endregion + +// #region RuleTester + +export class RuleTester { + constructor(config?: any); + + run( + name: string, + rule: Rule.RuleModule, + tests: { + valid?: Array | undefined; + invalid?: RuleTester.InvalidTestCase[] | undefined; + }, + ): void; + + static only( + item: string | RuleTester.ValidTestCase | RuleTester.InvalidTestCase, + ): RuleTester.ValidTestCase | RuleTester.InvalidTestCase; +} + +export namespace RuleTester { + interface ValidTestCase { + name?: string; + code: string; + options?: any; + filename?: string | undefined; + only?: boolean; + parserOptions?: Linter.ParserOptions | undefined; + settings?: { [name: string]: any } | undefined; + parser?: string | undefined; + globals?: { [name: string]: boolean } | undefined; + } + + interface SuggestionOutput { + messageId?: string | undefined; + desc?: string | undefined; + data?: Record | undefined; + output: string; + } + + interface InvalidTestCase extends ValidTestCase { + errors: number | Array; + output?: string | null | undefined; + } + + interface TestCaseError { + message?: string | RegExp | undefined; + messageId?: string | undefined; + type?: string | undefined; + data?: any; + line?: number | undefined; + column?: number | undefined; + endLine?: number | undefined; + endColumn?: number | undefined; + suggestions?: SuggestionOutput[] | undefined; + } +} + +// #endregion diff --git a/types/eslint/v8/package.json b/types/eslint/v8/package.json new file mode 100644 index 00000000000000..80cbf28c27f3be --- /dev/null +++ b/types/eslint/v8/package.json @@ -0,0 +1,56 @@ +{ + "private": true, + "name": "@types/eslint", + "version": "8.56.9999", + "projects": [ + "https://eslint.org" + ], + "exports": { + ".": { + "types": "./index.d.ts" + }, + "./use-at-your-own-risk": { + "types": "./use-at-your-own-risk.d.ts" + }, + "./rules": { + "types": "./rules/index.d.ts" + } + }, + "dependencies": { + "@types/estree": "*", + "@types/json-schema": "*" + }, + "devDependencies": { + "@types/eslint": "workspace:." + }, + "owners": [ + { + "name": "Pierre-Marie Dartus", + "githubUsername": "pmdartus" + }, + { + "name": "Jed Fox", + "githubUsername": "j-f1" + }, + { + "name": "Saad Quadri", + "githubUsername": "saadq" + }, + { + "name": "Jason Kwok", + "githubUsername": "JasonHK" + }, + { + "name": "Brad Zacher", + "githubUsername": "bradzacher" + }, + { + "name": "JounQin", + "githubUsername": "JounQin" + }, + { + "name": "Bryan Mishkin", + "githubUsername": "bmish" + } + ] +} diff --git a/types/eslint/v8/rules/best-practices.d.ts b/types/eslint/v8/rules/best-practices.d.ts new file mode 100644 index 00000000000000..d872242e936f97 --- /dev/null +++ b/types/eslint/v8/rules/best-practices.d.ts @@ -0,0 +1,1039 @@ +import { Linter } from "../index"; + +export interface BestPractices extends Linter.RulesRecord { + /** + * Rule to enforce getter and setter pairs in objects. + * + * @since 0.22.0 + * @see https://eslint.org/docs/rules/accessor-pairs + */ + "accessor-pairs": Linter.RuleEntry< + [ + Partial<{ + /** + * @default true + */ + setWithoutGet: boolean; + /** + * @default false + */ + getWithoutSet: boolean; + /** + * @default true + */ + enforceForClassMembers: boolean; + }>, + ] + >; + + /** + * Rule to enforce `return` statements in callbacks of array methods. + * + * @since 2.0.0-alpha-1 + * @see https://eslint.org/docs/rules/array-callback-return + */ + "array-callback-return": Linter.RuleEntry< + [ + Partial<{ + /** + * @default false + */ + allowImplicit: boolean; + /** + * @default false + */ + checkForEach: boolean; + /** + * @default false + */ + allowVoid: boolean; + }>, + ] + >; + + /** + * Rule to enforce the use of variables within the scope they are defined. + * + * @since 0.1.0 + * @see https://eslint.org/docs/rules/block-scoped-var + */ + "block-scoped-var": Linter.RuleEntry<[]>; + + /** + * Rule to enforce that class methods utilize `this`. + * + * @since 3.4.0 + * @see https://eslint.org/docs/rules/class-methods-use-this + */ + "class-methods-use-this": Linter.RuleEntry< + [ + Partial<{ + exceptMethods: string[]; + }>, + ] + >; + + /** + * Rule to enforce a maximum cyclomatic complexity allowed in a program. + * + * @since 0.0.9 + * @see https://eslint.org/docs/rules/complexity + */ + complexity: Linter.RuleEntry< + [ + | Partial<{ + /** + * @default 20 + */ + max: number; + /** + * @deprecated + * @default 20 + */ + maximum: number; + }> + | number, + ] + >; + + /** + * Rule to require `return` statements to either always or never specify values. + * + * @since 0.4.0 + * @see https://eslint.org/docs/rules/consistent-return + */ + "consistent-return": Linter.RuleEntry< + [ + Partial<{ + /** + * @default false + */ + treatUndefinedAsUnspecified: boolean; + }>, + ] + >; + + /** + * Rule to enforce consistent brace style for all control statements. + * + * @since 0.0.2 + * @see https://eslint.org/docs/rules/curly + */ + curly: Linter.RuleEntry<["all" | "multi" | "multi-line" | "multi-or-nest" | "consistent"]>; + + /** + * Rule to require `default` cases in `switch` statements. + * + * @since 0.6.0 + * @see https://eslint.org/docs/rules/default-case + */ + "default-case": Linter.RuleEntry< + [ + Partial<{ + /** + * @default '^no default$' + */ + commentPattern: string; + }>, + ] + >; + + /** + * Rule to enforce default clauses in switch statements to be last + * + * @since 7.0.0 + * @see https://eslint.org/docs/latest/rules/default-case-last + */ + "default-case-last": Linter.RuleEntry<[]>; + + /** + * Enforce default parameters to be last + * + * @since 6.4.0 + * @see https://eslint.org/docs/latest/rules/default-param-last + */ + "default-param-last": Linter.RuleEntry<[]>; + + /** + * Rule to enforce consistent newlines before and after dots. + * + * @since 0.21.0 + * @see https://eslint.org/docs/rules/dot-location + */ + "dot-location": Linter.RuleEntry<["object" | "property"]>; + + /** + * Rule to enforce dot notation whenever possible. + * + * @since 0.0.7 + * @see https://eslint.org/docs/rules/dot-notation + */ + "dot-notation": Linter.RuleEntry< + [ + Partial<{ + /** + * @default true + */ + allowKeywords: boolean; + allowPattern: string; + }>, + ] + >; + + /** + * Rule to require the use of `===` and `!==`. + * + * @since 0.0.2 + * @see https://eslint.org/docs/rules/eqeqeq + */ + eqeqeq: + | Linter.RuleEntry< + [ + "always", + Partial<{ + /** + * @default 'always' + */ + null: "always" | "never" | "ignore"; + }>, + ] + > + | Linter.RuleEntry<["smart" | "allow-null"]>; + + /** + * Require grouped accessor pairs in object literals and classes. + * + * @since 6.7.0 + * @see https://eslint.org/docs/latest/rules/grouped-accessor-pairs + */ + "grouped-accessor-pairs": Linter.RuleEntry<["anyOrder" | "getBeforeSet" | "setBeforeGet"]>; + + /** + * Rule to require `for-in` loops to include an `if` statement. + * + * @since 0.0.6 + * @see https://eslint.org/docs/rules/guard-for-in + */ + "guard-for-in": Linter.RuleEntry<[]>; + + /** + * Rule to enforce a maximum number of classes per file. + * + * @since 5.0.0-alpha.3 + * @see https://eslint.org/docs/rules/max-classes-per-file + */ + "max-classes-per-file": Linter.RuleEntry<[number]>; + + /** + * Rule to disallow the use of `alert`, `confirm`, and `prompt`. + * + * @since 0.0.5 + * @see https://eslint.org/docs/rules/no-alert + */ + "no-alert": Linter.RuleEntry<[]>; + + /** + * Rule to disallow the use of `arguments.caller` or `arguments.callee`. + * + * @since 0.0.6 + * @see https://eslint.org/docs/rules/no-caller + */ + "no-caller": Linter.RuleEntry<[]>; + + /** + * Rule to disallow lexical declarations in case clauses. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 1.9.0 + * @see https://eslint.org/docs/rules/no-case-declarations + */ + "no-case-declarations": Linter.RuleEntry<[]>; + + /** + * Rule to disallow division operators explicitly at the beginning of regular expressions. + * + * @since 0.1.0 + * @see https://eslint.org/docs/rules/no-div-regex + */ + "no-div-regex": Linter.RuleEntry<[]>; + + /** + * Rule to disallow `else` blocks after `return` statements in `if` statements. + * + * @since 0.0.9 + * @see https://eslint.org/docs/rules/no-else-return + */ + "no-else-return": Linter.RuleEntry< + [ + Partial<{ + /** + * @default true + */ + allowElseIf: boolean; + }>, + ] + >; + + /** + * Rule to disallow empty functions. + * + * @since 2.0.0 + * @see https://eslint.org/docs/rules/no-empty-function + */ + "no-empty-function": Linter.RuleEntry< + [ + Partial<{ + /** + * @default [] + */ + allow: Array< + | "functions" + | "arrowFunctions" + | "generatorFunctions" + | "methods" + | "generatorMethods" + | "getters" + | "setters" + | "constructors" + >; + }>, + ] + >; + + /** + * Rule to disallow empty destructuring patterns. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 1.7.0 + * @see https://eslint.org/docs/rules/no-empty-pattern + */ + "no-empty-pattern": Linter.RuleEntry<[]>; + + /** + * Rule to disallow `null` comparisons without type-checking operators. + * + * @since 0.0.9 + * @see https://eslint.org/docs/rules/no-eq-null + */ + "no-eq-null": Linter.RuleEntry<[]>; + + /** + * Rule to disallow the use of `eval()`. + * + * @since 0.0.2 + * @see https://eslint.org/docs/rules/no-eval + */ + "no-eval": Linter.RuleEntry< + [ + Partial<{ + /** + * @default false + */ + allowIndirect: boolean; + }>, + ] + >; + + /** + * Rule to disallow extending native types. + * + * @since 0.1.4 + * @see https://eslint.org/docs/rules/no-extend-native + */ + "no-extend-native": Linter.RuleEntry< + [ + Partial<{ + exceptions: string[]; + }>, + ] + >; + + /** + * Rule to disallow unnecessary calls to `.bind()`. + * + * @since 0.8.0 + * @see https://eslint.org/docs/rules/no-extra-bind + */ + "no-extra-bind": Linter.RuleEntry<[]>; + + /** + * Rule to disallow unnecessary labels. + * + * @since 2.0.0-rc.0 + * @see https://eslint.org/docs/rules/no-extra-label + */ + "no-extra-label": Linter.RuleEntry<[]>; + + /** + * Rule to disallow fallthrough of `case` statements. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 0.0.7 + * @see https://eslint.org/docs/rules/no-fallthrough + */ + "no-fallthrough": Linter.RuleEntry< + [ + Partial<{ + /** + * @default 'falls?\s?through' + */ + commentPattern: string; + /** + * @default false + */ + allowEmptyCase: boolean; + }>, + ] + >; + + /** + * Rule to disallow leading or trailing decimal points in numeric literals. + * + * @since 0.0.6 + * @see https://eslint.org/docs/rules/no-floating-decimal + */ + "no-floating-decimal": Linter.RuleEntry<[]>; + + /** + * Rule to disallow assignments to native objects or read-only global variables. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 3.3.0 + * @see https://eslint.org/docs/rules/no-global-assign + */ + "no-global-assign": Linter.RuleEntry< + [ + Partial<{ + exceptions: string[]; + }>, + ] + >; + + /** + * Rule to disallow shorthand type conversions. + * + * @since 1.0.0-rc-2 + * @see https://eslint.org/docs/rules/no-implicit-coercion + */ + "no-implicit-coercion": Linter.RuleEntry< + [ + Partial<{ + /** + * @default true + */ + boolean: boolean; + /** + * @default true + */ + number: boolean; + /** + * @default true + */ + string: boolean; + /** + * @default false + */ + disallowTemplateShorthand: boolean; + /** + * @default [] + */ + allow: Array<"~" | "!!" | "+" | "*">; + }>, + ] + >; + + /** + * Rule to disallow variable and `function` declarations in the global scope. + * + * @since 2.0.0-alpha-1 + * @see https://eslint.org/docs/rules/no-implicit-globals + */ + "no-implicit-globals": Linter.RuleEntry<[]>; + + /** + * Rule to disallow the use of `eval()`-like methods. + * + * @since 0.0.7 + * @see https://eslint.org/docs/rules/no-implied-eval + */ + "no-implied-eval": Linter.RuleEntry<[]>; + + /** + * Disallow assigning to imported bindings. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 6.4.0 + * @see https://eslint.org/docs/latest/rules/no-import-assign + */ + "no-import-assign": Linter.RuleEntry<[]>; + + /** + * Rule to disallow `this` keywords outside of classes or class-like objects. + * + * @since 1.0.0-rc-2 + * @see https://eslint.org/docs/rules/no-invalid-this + */ + "no-invalid-this": Linter.RuleEntry< + [ + Partial<{ + /** + * @default true + */ + capIsConstructor: boolean; + }>, + ] + >; + + /** + * Rule to disallow the use of the `__iterator__` property. + * + * @since 0.0.9 + * @see https://eslint.org/docs/rules/no-iterator + */ + "no-iterator": Linter.RuleEntry<[]>; + + /** + * Rule to disallow labeled statements. + * + * @since 0.4.0 + * @see https://eslint.org/docs/rules/no-labels + */ + "no-labels": Linter.RuleEntry< + [ + Partial<{ + /** + * @default false + */ + allowLoop: boolean; + /** + * @default false + */ + allowSwitch: boolean; + }>, + ] + >; + + /** + * Rule to disallow unnecessary nested blocks. + * + * @since 0.4.0 + * @see https://eslint.org/docs/rules/no-lone-blocks + */ + "no-lone-blocks": Linter.RuleEntry<[]>; + + /** + * Rule to disallow function declarations that contain unsafe references inside loop statements. + * + * @since 0.0.9 + * @see https://eslint.org/docs/rules/no-loop-func + */ + "no-loop-func": Linter.RuleEntry<[]>; + + /** + * Rule to disallow magic numbers. + * + * @since 1.7.0 + * @see https://eslint.org/docs/rules/no-magic-numbers + */ + "no-magic-numbers": Linter.RuleEntry< + [ + Partial<{ + /** + * @default [] + */ + ignore: number[]; + /** + * @default false + */ + ignoreArrayIndexes: boolean; + /** + * @default false + */ + enforceConst: boolean; + /** + * @default false + */ + detectObjects: boolean; + }>, + ] + >; + + /** + * Rule to disallow multiple spaces. + * + * @since 0.9.0 + * @see https://eslint.org/docs/rules/no-multi-spaces + */ + "no-multi-spaces": Linter.RuleEntry< + [ + Partial<{ + /** + * @default false + */ + ignoreEOLComments: boolean; + /** + * @default { Property: true } + */ + exceptions: Record; + }>, + ] + >; + + /** + * Rule to disallow multiline strings. + * + * @since 0.0.9 + * @see https://eslint.org/docs/rules/no-multi-str + */ + "no-multi-str": Linter.RuleEntry<[]>; + + /** + * Rule to disallow `new` operators outside of assignments or comparisons. + * + * @since 0.0.7 + * @see https://eslint.org/docs/rules/no-new + */ + "no-new": Linter.RuleEntry<[]>; + + /** + * Rule to disallow `new` operators with the `Function` object. + * + * @since 0.0.7 + * @see https://eslint.org/docs/rules/no-new-func + */ + "no-new-func": Linter.RuleEntry<[]>; + + /** + * Rule to disallow `new` operators with the `String`, `Number`, and `Boolean` objects. + * + * @since 0.0.6 + * @see https://eslint.org/docs/rules/no-new-wrappers + */ + "no-new-wrappers": Linter.RuleEntry<[]>; + + /** + * Disallow `\\8` and `\\9` escape sequences in string literals. + * + * @since 7.14.0 + * @see https://eslint.org/docs/rules/no-nonoctal-decimal-escape + */ + "no-nonoctal-decimal-escape": Linter.RuleEntry<[]>; + + /** + * Rule to disallow octal literals. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 0.0.6 + * @see https://eslint.org/docs/rules/no-octal + */ + "no-octal": Linter.RuleEntry<[]>; + + /** + * Rule to disallow octal escape sequences in string literals. + * + * @since 0.0.9 + * @see https://eslint.org/docs/rules/no-octal-escape + */ + "no-octal-escape": Linter.RuleEntry<[]>; + + /** + * Rule to disallow reassigning `function` parameters. + * + * @since 0.18.0 + * @see https://eslint.org/docs/rules/no-param-reassign + */ + "no-param-reassign": Linter.RuleEntry< + [ + Partial<{ + /** + * @default false + */ + props: boolean; + /** + * @default [] + */ + ignorePropertyModificationsFor: string[]; + }>, + ] + >; + + /** + * Rule to disallow the use of the `__proto__` property. + * + * @since 0.0.9 + * @see https://eslint.org/docs/rules/no-proto + */ + "no-proto": Linter.RuleEntry<[]>; + + /** + * Rule to disallow variable redeclaration. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 0.0.9 + * @see https://eslint.org/docs/rules/no-redeclare + */ + "no-redeclare": Linter.RuleEntry< + [ + Partial<{ + /** + * @default true + */ + builtinGlobals: boolean; + }>, + ] + >; + + /** + * Rule to disallow certain properties on certain objects. + * + * @since 3.5.0 + * @see https://eslint.org/docs/rules/no-restricted-properties + */ + "no-restricted-properties": Linter.RuleEntry< + [ + ...Array< + | { + object: string; + property?: string | undefined; + message?: string | undefined; + } + | { + property: string; + message?: string | undefined; + } + >, + ] + >; + + /** + * Rule to disallow assignment operators in `return` statements. + * + * @since 0.0.9 + * @see https://eslint.org/docs/rules/no-return-assign + */ + "no-return-assign": Linter.RuleEntry<["except-parens" | "always"]>; + + /** + * Rule to disallow unnecessary `return await`. + * + * @since 3.10.0 + * @see https://eslint.org/docs/rules/no-return-await + */ + "no-return-await": Linter.RuleEntry<[]>; + + /** + * Rule to disallow `javascript:` urls. + * + * @since 0.0.9 + * @see https://eslint.org/docs/rules/no-script-url + */ + "no-script-url": Linter.RuleEntry<[]>; + + /** + * Rule to disallow assignments where both sides are exactly the same. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 2.0.0-rc.0 + * @see https://eslint.org/docs/rules/no-self-assign + */ + "no-self-assign": Linter.RuleEntry<[]>; + + /** + * Rule to disallow comparisons where both sides are exactly the same. + * + * @since 0.0.9 + * @see https://eslint.org/docs/rules/no-self-compare + */ + "no-self-compare": Linter.RuleEntry<[]>; + + /** + * Rule to disallow comma operators. + * + * @since 0.5.1 + * @see https://eslint.org/docs/rules/no-sequences + */ + "no-sequences": Linter.RuleEntry<[]>; + + /** + * Rule to disallow throwing literals as exceptions. + * + * @since 0.15.0 + * @see https://eslint.org/docs/rules/no-throw-literal + */ + "no-throw-literal": Linter.RuleEntry<[]>; + + /** + * Rule to disallow unmodified loop conditions. + * + * @since 2.0.0-alpha-2 + * @see https://eslint.org/docs/rules/no-unmodified-loop-condition + */ + "no-unmodified-loop-condition": Linter.RuleEntry<[]>; + + /** + * Rule to disallow unused expressions. + * + * @since 0.1.0 + * @see https://eslint.org/docs/rules/no-unused-expressions + */ + "no-unused-expressions": Linter.RuleEntry< + [ + Partial<{ + /** + * @default false + */ + allowShortCircuit: boolean; + /** + * @default false + */ + allowTernary: boolean; + /** + * @default false + */ + allowTaggedTemplates: boolean; + }>, + ] + >; + + /** + * Rule to disallow unused labels. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 2.0.0-rc.0 + * @see https://eslint.org/docs/rules/no-unused-labels + */ + "no-unused-labels": Linter.RuleEntry<[]>; + + /** + * Disallow useless backreferences in regular expressions + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 7.0.0-alpha.0 + * @see https://eslint.org/docs/latest/rules/no-useless-backreference + */ + "no-useless-backreference": Linter.RuleEntry<[]>; + + /** + * Rule to disallow unnecessary calls to `.call()` and `.apply()`. + * + * @since 1.0.0-rc-1 + * @see https://eslint.org/docs/rules/no-useless-call + */ + "no-useless-call": Linter.RuleEntry<[]>; + + /** + * Rule to disallow unnecessary `catch` clauses. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 5.11.0 + * @see https://eslint.org/docs/rules/no-useless-catch + */ + "no-useless-catch": Linter.RuleEntry<[]>; + + /** + * Rule to disallow unnecessary concatenation of literals or template literals. + * + * @since 1.3.0 + * @see https://eslint.org/docs/rules/no-useless-concat + */ + "no-useless-concat": Linter.RuleEntry<[]>; + + /** + * Rule to disallow unnecessary escape characters. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 2.5.0 + * @see https://eslint.org/docs/rules/no-useless-escape + */ + "no-useless-escape": Linter.RuleEntry<[]>; + + /** + * Rule to disallow redundant return statements. + * + * @since 3.9.0 + * @see https://eslint.org/docs/rules/no-useless-return + */ + "no-useless-return": Linter.RuleEntry<[]>; + + /** + * Rule to disallow `void` operators. + * + * @since 0.8.0 + * @see https://eslint.org/docs/rules/no-void + */ + "no-void": Linter.RuleEntry<[]>; + + /** + * Rule to disallow specified warning terms in comments. + * + * @since 0.4.4 + * @see https://eslint.org/docs/rules/no-warning-comments + */ + "no-warning-comments": Linter.RuleEntry< + [ + { + /** + * @default ["todo", "fixme", "xxx"] + */ + terms: string[]; + /** + * @default 'start' + */ + location: "start" | "anywhere"; + }, + ] + >; + + /** + * Rule to disallow `with` statements. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 0.0.2 + * @see https://eslint.org/docs/rules/no-with + */ + "no-with": Linter.RuleEntry<[]>; + + /** + * Rule to enforce using named capture group in regular expression. + * + * @since 5.15.0 + * @see https://eslint.org/docs/rules/prefer-named-capture-group + */ + "prefer-named-capture-group": Linter.RuleEntry<[]>; + + /** + * Disallow use of `Object.prototype.hasOwnProperty.call()` and prefer use of `Object.hasOwn()`. + * + * @since 3.5.0 + * @see https://eslint.org/docs/rules/prefer-object-has-own + */ + "prefer-object-has-own": Linter.RuleEntry<[]>; + + /** + * Rule to require using Error objects as Promise rejection reasons. + * + * @since 3.14.0 + * @see https://eslint.org/docs/rules/prefer-promise-reject-errors + */ + "prefer-promise-reject-errors": Linter.RuleEntry< + [ + Partial<{ + /** + * @default false + */ + allowEmptyReject: boolean; + }>, + ] + >; + + /** + * Disallow use of the `RegExp` constructor in favor of regular expression literals. + * + * @since 6.4.0 + * @see https://eslint.org/docs/latest/rules/prefer-regex-literals + */ + "prefer-regex-literals": Linter.RuleEntry< + [ + Partial<{ + /** + * @default false + */ + disallowRedundantWrapping: boolean; + }>, + ] + >; + + /** + * Rule to enforce the consistent use of the radix argument when using `parseInt()`. + * + * @since 0.0.7 + * @see https://eslint.org/docs/rules/radix + */ + radix: Linter.RuleEntry<["always" | "as-needed"]>; + + /** + * Rule to disallow async functions which have no `await` expression. + * + * @since 3.11.0 + * @see https://eslint.org/docs/rules/require-await + */ + "require-await": Linter.RuleEntry<[]>; + + /** + * Rule to enforce the use of `u` flag on RegExp. + * + * @since 5.3.0 + * @see https://eslint.org/docs/rules/require-unicode-regexp + */ + "require-unicode-regexp": Linter.RuleEntry<[]>; + + /** + * Rule to require `var` declarations be placed at the top of their containing scope. + * + * @since 0.8.0 + * @see https://eslint.org/docs/rules/vars-on-top + */ + "vars-on-top": Linter.RuleEntry<[]>; + + /** + * Rule to require parentheses around immediate `function` invocations. + * + * @since 0.0.9 + * @see https://eslint.org/docs/rules/wrap-iife + */ + "wrap-iife": Linter.RuleEntry< + [ + "outside" | "inside" | "any", + Partial<{ + /** + * @default false + */ + functionPrototypeMethods: boolean; + }>, + ] + >; + + /** + * Rule to require or disallow “Yoda” conditions. + * + * @since 0.7.1 + * @see https://eslint.org/docs/rules/yoda + */ + yoda: + | Linter.RuleEntry< + [ + "never", + Partial<{ + exceptRange: boolean; + onlyEquality: boolean; + }>, + ] + > + | Linter.RuleEntry<["always"]>; +} diff --git a/types/eslint/v8/rules/deprecated.d.ts b/types/eslint/v8/rules/deprecated.d.ts new file mode 100644 index 00000000000000..0024d8921c7048 --- /dev/null +++ b/types/eslint/v8/rules/deprecated.d.ts @@ -0,0 +1,267 @@ +import { Linter } from "../index"; + +export interface Deprecated extends Linter.RulesRecord { + /** + * Rule to enforce consistent indentation. + * + * @since 4.0.0-alpha.0 + * @deprecated since 4.0.0, use [`indent`](https://eslint.org/docs/rules/indent) instead. + * @see https://eslint.org/docs/rules/indent-legacy + */ + "indent-legacy": Linter.RuleEntry< + [ + number | "tab", + Partial<{ + /** + * @default 0 + */ + SwitchCase: number; + /** + * @default 1 + */ + VariableDeclarator: + | Partial<{ + /** + * @default 1 + */ + var: number | "first"; + /** + * @default 1 + */ + let: number | "first"; + /** + * @default 1 + */ + const: number | "first"; + }> + | number + | "first"; + /** + * @default 1 + */ + outerIIFEBody: number; + /** + * @default 1 + */ + MemberExpression: number | "off"; + /** + * @default { parameters: 1, body: 1 } + */ + FunctionDeclaration: Partial<{ + /** + * @default 1 + */ + parameters: number | "first" | "off"; + /** + * @default 1 + */ + body: number; + }>; + /** + * @default { parameters: 1, body: 1 } + */ + FunctionExpression: Partial<{ + /** + * @default 1 + */ + parameters: number | "first" | "off"; + /** + * @default 1 + */ + body: number; + }>; + /** + * @default { arguments: 1 } + */ + CallExpression: Partial<{ + /** + * @default 1 + */ + arguments: number | "first" | "off"; + }>; + /** + * @default 1 + */ + ArrayExpression: number | "first" | "off"; + /** + * @default 1 + */ + ObjectExpression: number | "first" | "off"; + /** + * @default 1 + */ + ImportDeclaration: number | "first" | "off"; + /** + * @default false + */ + flatTernaryExpressions: boolean; + ignoredNodes: string[]; + /** + * @default false + */ + ignoreComments: boolean; + }>, + ] + >; + + /** + * Rule to require or disallow newlines around directives. + * + * @since 3.5.0 + * @deprecated since 4.0.0, use [`padding-line-between-statements`](https://eslint.org/docs/rules/padding-line-between-statements) instead. + * @see https://eslint.org/docs/rules/lines-around-directive + */ + "lines-around-directive": Linter.RuleEntry<["always" | "never"]>; + + /** + * Rule to require or disallow an empty line after variable declarations. + * + * @since 0.18.0 + * @deprecated since 4.0.0, use [`padding-line-between-statements`](https://eslint.org/docs/rules/padding-line-between-statements) instead. + * @see https://eslint.org/docs/rules/newline-after-var + */ + "newline-after-var": Linter.RuleEntry<["always" | "never"]>; + + /** + * Rule to require an empty line before `return` statements. + * + * @since 2.3.0 + * @deprecated since 4.0.0, use [`padding-line-between-statements`](https://eslint.org/docs/rules/padding-line-between-statements) instead. + * @see https://eslint.org/docs/rules/newline-before-return + */ + "newline-before-return": Linter.RuleEntry<[]>; + + /** + * Rule to disallow shadowing of variables inside of `catch`. + * + * @since 0.0.9 + * @deprecated since 5.1.0, use [`no-shadow`](https://eslint.org/docs/rules/no-shadow) instead. + * @see https://eslint.org/docs/rules/no-catch-shadow + */ + "no-catch-shadow": Linter.RuleEntry<[]>; + + /** + * Rule to disallow reassignment of native objects. + * + * @since 0.0.9 + * @deprecated since 3.3.0, use [`no-global-assign`](https://eslint.org/docs/rules/no-global-assign) instead. + * @see https://eslint.org/docs/rules/no-native-reassign + */ + "no-native-reassign": Linter.RuleEntry< + [ + Partial<{ + exceptions: string[]; + }>, + ] + >; + + /** + * Rule to disallow negating the left operand in `in` expressions. + * + * @since 0.1.2 + * @deprecated since 3.3.0, use [`no-unsafe-negation`](https://eslint.org/docs/rules/no-unsafe-negation) instead. + * @see https://eslint.org/docs/rules/no-negated-in-lhs + */ + "no-negated-in-lhs": Linter.RuleEntry<[]>; + + /** + * Rule to disallow spacing between function identifiers and their applications. + * + * @since 0.1.2 + * @deprecated since 3.3.0, use [`func-call-spacing`](https://eslint.org/docs/rules/func-call-spacing) instead. + * @see https://eslint.org/docs/rules/no-spaced-func + */ + "no-spaced-func": Linter.RuleEntry<[]>; + + /** + * Rule to suggest using `Reflect` methods where applicable. + * + * @since 1.0.0-rc-2 + * @deprecated since 3.9.0 + * @see https://eslint.org/docs/rules/prefer-reflect + */ + "prefer-reflect": Linter.RuleEntry< + [ + Partial<{ + exceptions: string[]; + }>, + ] + >; + + /** + * Rule to require JSDoc comments. + * + * @since 1.4.0 + * @deprecated since 5.10.0 + * @see https://eslint.org/docs/rules/require-jsdoc + */ + "require-jsdoc": Linter.RuleEntry< + [ + Partial<{ + require: Partial<{ + /** + * @default true + */ + FunctionDeclaration: boolean; + /** + * @default false + */ + MethodDefinition: boolean; + /** + * @default false + */ + ClassDeclaration: boolean; + /** + * @default false + */ + ArrowFunctionExpression: boolean; + /** + * @default false + */ + FunctionExpression: boolean; + }>; + }>, + ] + >; + + /** + * Rule to enforce valid JSDoc comments. + * + * @since 0.4.0 + * @deprecated since 5.10.0 + * @see https://eslint.org/docs/rules/valid-jsdoc + */ + "valid-jsdoc": Linter.RuleEntry< + [ + Partial<{ + prefer: Record; + preferType: Record; + /** + * @default true + */ + requireReturn: boolean; + /** + * @default true + */ + requireReturnType: boolean; + /** + * @remarks + * Also accept for regular expression pattern + */ + matchDescription: string; + /** + * @default true + */ + requireParamDescription: boolean; + /** + * @default true + */ + requireReturnDescription: boolean; + /** + * @default true + */ + requireParamType: boolean; + }>, + ] + >; +} diff --git a/types/eslint/v8/rules/ecmascript-6.d.ts b/types/eslint/v8/rules/ecmascript-6.d.ts new file mode 100644 index 00000000000000..564a1dcabff042 --- /dev/null +++ b/types/eslint/v8/rules/ecmascript-6.d.ts @@ -0,0 +1,534 @@ +import { Linter } from "../index"; + +export interface ECMAScript6 extends Linter.RulesRecord { + /** + * Rule to require braces around arrow function bodies. + * + * @since 1.8.0 + * @see https://eslint.org/docs/rules/arrow-body-style + */ + "arrow-body-style": + | Linter.RuleEntry< + [ + "as-needed", + Partial<{ + /** + * @default false + */ + requireReturnForObjectLiteral: boolean; + }>, + ] + > + | Linter.RuleEntry<["always" | "never"]>; + + /** + * Rule to require parentheses around arrow function arguments. + * + * @since 1.0.0-rc-1 + * @see https://eslint.org/docs/rules/arrow-parens + */ + "arrow-parens": + | Linter.RuleEntry<["always"]> + | Linter.RuleEntry< + [ + "as-needed", + Partial<{ + /** + * @default false + */ + requireForBlockBody: boolean; + }>, + ] + >; + + /** + * Rule to enforce consistent spacing before and after the arrow in arrow functions. + * + * @since 1.0.0-rc-1 + * @see https://eslint.org/docs/rules/arrow-spacing + */ + "arrow-spacing": Linter.RuleEntry<[]>; + + /** + * Rule to require `super()` calls in constructors. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 0.24.0 + * @see https://eslint.org/docs/rules/constructor-super + */ + "constructor-super": Linter.RuleEntry<[]>; + + /** + * Rule to enforce consistent spacing around `*` operators in generator functions. + * + * @since 0.17.0 + * @see https://eslint.org/docs/rules/generator-star-spacing + */ + "generator-star-spacing": Linter.RuleEntry< + [ + | Partial<{ + before: boolean; + after: boolean; + named: + | Partial<{ + before: boolean; + after: boolean; + }> + | "before" + | "after" + | "both" + | "neither"; + anonymous: + | Partial<{ + before: boolean; + after: boolean; + }> + | "before" + | "after" + | "both" + | "neither"; + method: + | Partial<{ + before: boolean; + after: boolean; + }> + | "before" + | "after" + | "both" + | "neither"; + }> + | "before" + | "after" + | "both" + | "neither", + ] + >; + + /** + * Require or disallow logical assignment operator shorthand. + * + * @since 8.24.0 + * @see https://eslint.org/docs/rules/logical-assignment-operators + */ + "logical-assignment-operators": + | Linter.RuleEntry< + [ + "always", + Partial<{ + /** + * @default false + */ + enforceForIfStatements: boolean; + }>, + ] + > + | Linter.RuleEntry<["never"]>; + + /** + * Rule to disallow reassigning class members. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 1.0.0-rc-1 + * @see https://eslint.org/docs/rules/no-class-assign + */ + "no-class-assign": Linter.RuleEntry<[]>; + + /** + * Rule to disallow arrow functions where they could be confused with comparisons. + * + * @since 2.0.0-alpha-2 + * @see https://eslint.org/docs/rules/no-confusing-arrow + */ + "no-confusing-arrow": Linter.RuleEntry< + [ + Partial<{ + /** + * @default true + */ + allowParens: boolean; + }>, + ] + >; + + /** + * Rule to disallow reassigning `const` variables. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 1.0.0-rc-1 + * @see https://eslint.org/docs/rules/no-const-assign + */ + "no-const-assign": Linter.RuleEntry<[]>; + + /** + * Rule to disallow duplicate class members. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 1.2.0 + * @see https://eslint.org/docs/rules/no-dupe-class-members + */ + "no-dupe-class-members": Linter.RuleEntry<[]>; + + /** + * Rule to disallow duplicate module imports. + * + * @since 2.5.0 + * @see https://eslint.org/docs/rules/no-duplicate-imports + */ + "no-duplicate-imports": Linter.RuleEntry< + [ + Partial<{ + /** + * @default false + */ + includeExports: boolean; + }>, + ] + >; + + /** + * Rule to disallow `new` operators with the `Symbol` object. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 2.0.0-beta.1 + * @see https://eslint.org/docs/rules/no-new-symbol + */ + "no-new-symbol": Linter.RuleEntry<[]>; + + /** + * Rule to disallow specified modules when loaded by `import`. + * + * @since 2.0.0-alpha-1 + * @see https://eslint.org/docs/rules/no-restricted-imports + */ + "no-restricted-imports": Linter.RuleEntry< + [ + ...Array< + | string + | { + name: string; + importNames?: string[] | undefined; + message?: string | undefined; + } + | Partial<{ + paths: Array< + | string + | { + name: string; + importNames?: string[] | undefined; + message?: string | undefined; + } + >; + patterns: string[]; + }> + >, + ] + >; + + /** + * Rule to disallow `this`/`super` before calling `super()` in constructors. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 0.24.0 + * @see https://eslint.org/docs/rules/no-this-before-super + */ + "no-this-before-super": Linter.RuleEntry<[]>; + + /** + * Rule to disallow unnecessary computed property keys in object literals. + * + * @since 2.9.0 + * @see https://eslint.org/docs/rules/no-useless-computed-key + */ + "no-useless-computed-key": Linter.RuleEntry<[]>; + + /** + * Rule to disallow unnecessary constructors. + * + * @since 2.0.0-beta.1 + * @see https://eslint.org/docs/rules/no-useless-constructor + */ + "no-useless-constructor": Linter.RuleEntry<[]>; + + /** + * Rule to disallow renaming import, export, and destructured assignments to the same name. + * + * @since 2.11.0 + * @see https://eslint.org/docs/rules/no-useless-rename + */ + "no-useless-rename": Linter.RuleEntry< + [ + Partial<{ + /** + * @default false + */ + ignoreImport: boolean; + /** + * @default false + */ + ignoreExport: boolean; + /** + * @default false + */ + ignoreDestructuring: boolean; + }>, + ] + >; + + /** + * Rule to require `let` or `const` instead of `var`. + * + * @since 0.12.0 + * @see https://eslint.org/docs/rules/no-var + */ + "no-var": Linter.RuleEntry<[]>; + + /** + * Rule to require or disallow method and property shorthand syntax for object literals. + * + * @since 0.20.0 + * @see https://eslint.org/docs/rules/object-shorthand + */ + "object-shorthand": + | Linter.RuleEntry< + [ + "always" | "methods", + Partial<{ + /** + * @default false + */ + avoidQuotes: boolean; + /** + * @default false + */ + ignoreConstructors: boolean; + /** + * @default false + */ + avoidExplicitReturnArrows: boolean; + }>, + ] + > + | Linter.RuleEntry< + [ + "properties", + Partial<{ + /** + * @default false + */ + avoidQuotes: boolean; + }>, + ] + > + | Linter.RuleEntry<["never" | "consistent" | "consistent-as-needed"]>; + + /** + * Rule to require using arrow functions for callbacks. + * + * @since 1.2.0 + * @see https://eslint.org/docs/rules/prefer-arrow-callback + */ + "prefer-arrow-callback": Linter.RuleEntry< + [ + Partial<{ + /** + * @default false + */ + allowNamedFunctions: boolean; + /** + * @default true + */ + allowUnboundThis: boolean; + }>, + ] + >; + + /** + * Rule to require `const` declarations for variables that are never reassigned after declared. + * + * @since 0.23.0 + * @see https://eslint.org/docs/rules/prefer-const + */ + "prefer-const": Linter.RuleEntry< + [ + Partial<{ + /** + * @default 'any' + */ + destructuring: "any" | "all"; + /** + * @default false + */ + ignoreReadBeforeAssign: boolean; + }>, + ] + >; + + /** + * Rule to require destructuring from arrays and/or objects. + * + * @since 3.13.0 + * @see https://eslint.org/docs/rules/prefer-destructuring + */ + "prefer-destructuring": Linter.RuleEntry< + [ + Partial< + | { + VariableDeclarator: Partial<{ + array: boolean; + object: boolean; + }>; + AssignmentExpression: Partial<{ + array: boolean; + object: boolean; + }>; + } + | { + array: boolean; + object: boolean; + } + >, + Partial<{ + enforceForRenamedProperties: boolean; + }>, + ] + >; + + /** + * Disallow the use of `Math.pow` in favor of the `**` operator. + * + * @since 6.7.0 + * @see https://eslint.org/docs/latest/rules/prefer-exponentiation-operator + */ + "prefer-exponentiation-operator": Linter.RuleEntry<[]>; + + /** + * Rule to disallow `parseInt()` and `Number.parseInt()` in favor of binary, octal, and hexadecimal literals. + * + * @since 3.5.0 + * @see https://eslint.org/docs/rules/prefer-numeric-literals + */ + "prefer-numeric-literals": Linter.RuleEntry<[]>; + + /** + * Rule to require rest parameters instead of `arguments`. + * + * @since 2.0.0-alpha-1 + * @see https://eslint.org/docs/rules/prefer-rest-params + */ + "prefer-rest-params": Linter.RuleEntry<[]>; + + /** + * Rule to require spread operators instead of `.apply()`. + * + * @since 1.0.0-rc-1 + * @see https://eslint.org/docs/rules/prefer-spread + */ + "prefer-spread": Linter.RuleEntry<[]>; + + /** + * Rule to require template literals instead of string concatenation. + * + * @since 1.2.0 + * @see https://eslint.org/docs/rules/prefer-template + */ + "prefer-template": Linter.RuleEntry<[]>; + + /** + * Rule to require generator functions to contain `yield`. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 1.0.0-rc-1 + * @see https://eslint.org/docs/rules/require-yield + */ + "require-yield": Linter.RuleEntry<[]>; + + /** + * Rule to enforce spacing between rest and spread operators and their expressions. + * + * @since 2.12.0 + * @see https://eslint.org/docs/rules/rest-spread-spacing + */ + "rest-spread-spacing": Linter.RuleEntry<["never" | "always"]>; + + /** + * Rule to enforce sorted import declarations within modules. + * + * @since 2.0.0-beta.1 + * @see https://eslint.org/docs/rules/sort-imports + */ + "sort-imports": Linter.RuleEntry< + [ + Partial<{ + /** + * @default false + */ + ignoreCase: boolean; + /** + * @default false + */ + ignoreDeclarationSort: boolean; + /** + * @default false + */ + ignoreMemberSort: boolean; + /** + * @default ['none', 'all', 'multiple', 'single'] + */ + memberSyntaxSortOrder: Array<"none" | "all" | "multiple" | "single">; + /** + * @default false + */ + allowSeparatedGroups: boolean; + }>, + ] + >; + + /** + * Rule to require symbol descriptions. + * + * @since 3.4.0 + * @see https://eslint.org/docs/rules/symbol-description + */ + "symbol-description": Linter.RuleEntry<[]>; + + /** + * Rule to require or disallow spacing around embedded expressions of template strings. + * + * @since 2.0.0-rc.0 + * @see https://eslint.org/docs/rules/template-curly-spacing + */ + "template-curly-spacing": Linter.RuleEntry<["never" | "always"]>; + + /** + * Rule to require or disallow spacing around the `*` in `yield*` expressions. + * + * @since 2.0.0-alpha-1 + * @see https://eslint.org/docs/rules/yield-star-spacing + */ + "yield-star-spacing": Linter.RuleEntry< + [ + | Partial<{ + before: boolean; + after: boolean; + }> + | "before" + | "after" + | "both" + | "neither", + ] + >; +} diff --git a/types/eslint/v8/rules/index.d.ts b/types/eslint/v8/rules/index.d.ts new file mode 100644 index 00000000000000..7470777c439e0e --- /dev/null +++ b/types/eslint/v8/rules/index.d.ts @@ -0,0 +1,23 @@ +import { Linter } from "../index"; + +import { BestPractices } from "./best-practices"; +import { Deprecated } from "./deprecated"; +import { ECMAScript6 } from "./ecmascript-6"; +import { NodeJSAndCommonJS } from "./node-commonjs"; +import { PossibleErrors } from "./possible-errors"; +import { StrictMode } from "./strict-mode"; +import { StylisticIssues } from "./stylistic-issues"; +import { Variables } from "./variables"; + +export interface ESLintRules + extends + Linter.RulesRecord, + PossibleErrors, + BestPractices, + StrictMode, + Variables, + NodeJSAndCommonJS, + StylisticIssues, + ECMAScript6, + Deprecated +{} diff --git a/types/eslint/v8/rules/node-commonjs.d.ts b/types/eslint/v8/rules/node-commonjs.d.ts new file mode 100644 index 00000000000000..56a96e3e5e235a --- /dev/null +++ b/types/eslint/v8/rules/node-commonjs.d.ts @@ -0,0 +1,133 @@ +import { Linter } from "../index"; + +export interface NodeJSAndCommonJS extends Linter.RulesRecord { + /** + * Rule to require `return` statements after callbacks. + * + * @since 1.0.0-rc-1 + * @see https://eslint.org/docs/rules/callback-return + */ + "callback-return": Linter.RuleEntry<[string[]]>; + + /** + * Rule to require `require()` calls to be placed at top-level module scope. + * + * @since 1.4.0 + * @see https://eslint.org/docs/rules/global-require + */ + "global-require": Linter.RuleEntry<[]>; + + /** + * Rule to require error handling in callbacks. + * + * @since 0.4.5 + * @see https://eslint.org/docs/rules/handle-callback-err + */ + "handle-callback-err": Linter.RuleEntry<[string]>; + + /** + * Rule to disallow use of the `Buffer()` constructor. + * + * @since 4.0.0-alpha.0 + * @see https://eslint.org/docs/rules/no-buffer-constructor + */ + "no-buffer-constructor": Linter.RuleEntry<[]>; + + /** + * Rule to disallow `require` calls to be mixed with regular variable declarations. + * + * @since 0.0.9 + * @see https://eslint.org/docs/rules/no-mixed-requires + */ + "no-mixed-requires": Linter.RuleEntry< + [ + Partial<{ + /** + * @default false + */ + grouping: boolean; + /** + * @default false + */ + allowCall: boolean; + }>, + ] + >; + + /** + * Rule to disallow `new` operators with calls to `require`. + * + * @since 0.6.0 + * @see https://eslint.org/docs/rules/no-new-require + */ + "no-new-require": Linter.RuleEntry<[]>; + + /** + * Rule to disallow string concatenation when using `__dirname` and `__filename`. + * + * @since 0.4.0 + * @see https://eslint.org/docs/rules/no-path-concat + */ + "no-path-concat": Linter.RuleEntry<[]>; + + /** + * Rule to disallow the use of `process.env`. + * + * @since 0.9.0 + * @see https://eslint.org/docs/rules/no-process-env + */ + "no-process-env": Linter.RuleEntry<[]>; + + /** + * Rule to disallow the use of `process.exit()`. + * + * @since 0.4.0 + * @see https://eslint.org/docs/rules/no-process-exit + */ + "no-process-exit": Linter.RuleEntry<[]>; + + /** + * Rule to disallow specified modules when loaded by `require`. + * + * @since 0.6.0 + * @see https://eslint.org/docs/rules/no-restricted-modules + */ + "no-restricted-modules": Linter.RuleEntry< + [ + ...Array< + | string + | { + name: string; + message?: string | undefined; + } + | Partial<{ + paths: Array< + | string + | { + name: string; + message?: string | undefined; + } + >; + patterns: string[]; + }> + >, + ] + >; + + /** + * Rule to disallow synchronous methods. + * + * @since 0.0.9 + * @see https://eslint.org/docs/rules/no-sync + */ + "no-sync": Linter.RuleEntry< + [ + { + /** + * @default false + */ + allowAtRootLevel: boolean; + }, + ] + >; +} diff --git a/types/eslint/v8/rules/possible-errors.d.ts b/types/eslint/v8/rules/possible-errors.d.ts new file mode 100644 index 00000000000000..b6fb185df7fef5 --- /dev/null +++ b/types/eslint/v8/rules/possible-errors.d.ts @@ -0,0 +1,571 @@ +import { Linter } from "../index"; + +export interface PossibleErrors extends Linter.RulesRecord { + /** + * Rule to enforce `for` loop update clause moving the counter in the right direction. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 4.0.0-beta.0 + * @see https://eslint.org/docs/rules/for-direction + */ + "for-direction": Linter.RuleEntry<[]>; + + /** + * Rule to enforce `return` statements in getters. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 4.2.0 + * @see https://eslint.org/docs/rules/getter-return + */ + "getter-return": Linter.RuleEntry< + [ + Partial<{ + /** + * @default false + */ + allowImplicit: boolean; + }>, + ] + >; + + /** + * Rule to disallow using an async function as a `Promise` executor. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 5.3.0 + * @see https://eslint.org/docs/rules/no-async-promise-executor + */ + "no-async-promise-executor": Linter.RuleEntry<[]>; + + /** + * Rule to disallow `await` inside of loops. + * + * @since 3.12.0 + * @see https://eslint.org/docs/rules/no-await-in-loop + */ + "no-await-in-loop": Linter.RuleEntry<[]>; + + /** + * Rule to disallow comparing against `-0`. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 3.17.0 + * @see https://eslint.org/docs/rules/no-compare-neg-zero + */ + "no-compare-neg-zero": Linter.RuleEntry<[]>; + + /** + * Rule to disallow assignment operators in conditional statements. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 0.0.9 + * @see https://eslint.org/docs/rules/no-cond-assign + */ + "no-cond-assign": Linter.RuleEntry<["except-parens" | "always"]>; + + /** + * Rule to disallow the use of `console`. + * + * @since 0.0.2 + * @see https://eslint.org/docs/rules/no-console + */ + "no-console": Linter.RuleEntry< + [ + Partial<{ + allow: Array; + }>, + ] + >; + + /** + * Rule to disallow constant expressions in conditions. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 0.4.1 + * @see https://eslint.org/docs/rules/no-constant-condition + */ + "no-constant-condition": Linter.RuleEntry< + [ + { + /** + * @default true + */ + checkLoops: boolean; + }, + ] + >; + + /** + * Rule to disallow control characters in regular expressions. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 0.1.0 + * @see https://eslint.org/docs/rules/no-control-regex + */ + "no-control-regex": Linter.RuleEntry<[]>; + + /** + * Rule to disallow the use of `debugger`. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 0.0.2 + * @see https://eslint.org/docs/rules/no-debugger + */ + "no-debugger": Linter.RuleEntry<[]>; + + /** + * Rule to disallow duplicate arguments in `function` definitions. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 0.16.0 + * @see https://eslint.org/docs/rules/no-dupe-args + */ + "no-dupe-args": Linter.RuleEntry<[]>; + + /** + * Disallow duplicate conditions in if-else-if chains. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 6.7.0 + * @see https://eslint.org/docs/rules/no-dupe-else-if + */ + "no-dupe-else-if": Linter.RuleEntry<[]>; + + /** + * Rule to disallow duplicate keys in object literals. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 0.0.9 + * @see https://eslint.org/docs/rules/no-dupe-keys + */ + "no-dupe-keys": Linter.RuleEntry<[]>; + + /** + * Rule to disallow a duplicate case label. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 0.17.0 + * @see https://eslint.org/docs/rules/no-duplicate-case + */ + "no-duplicate-case": Linter.RuleEntry<[]>; + + /** + * Rule to disallow empty block statements. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 0.0.2 + * @see https://eslint.org/docs/rules/no-empty + */ + "no-empty": Linter.RuleEntry< + [ + Partial<{ + /** + * @default false + */ + allowEmptyCatch: boolean; + }>, + ] + >; + + /** + * Rule to disallow empty character classes in regular expressions. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 0.22.0 + * @see https://eslint.org/docs/rules/no-empty-character-class + */ + "no-empty-character-class": Linter.RuleEntry<[]>; + + /** + * Rule to disallow reassigning exceptions in `catch` clauses. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 0.0.9 + * @see https://eslint.org/docs/rules/no-ex-assign + */ + "no-ex-assign": Linter.RuleEntry<[]>; + + /** + * Rule to disallow unnecessary boolean casts. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 0.4.0 + * @see https://eslint.org/docs/rules/no-extra-boolean-cast + */ + "no-extra-boolean-cast": Linter.RuleEntry<[]>; + + /** + * Rule to disallow unnecessary parentheses. + * + * @since 0.1.4 + * @see https://eslint.org/docs/rules/no-extra-parens + */ + "no-extra-parens": + | Linter.RuleEntry< + [ + "all", + Partial<{ + /** + * @default true, + */ + conditionalAssign: boolean; + /** + * @default true + */ + returnAssign: boolean; + /** + * @default true + */ + nestedBinaryExpressions: boolean; + /** + * @default 'none' + */ + ignoreJSX: "none" | "all" | "multi-line" | "single-line"; + /** + * @default true + */ + enforceForArrowConditionals: boolean; + }>, + ] + > + | Linter.RuleEntry<["functions"]>; + + /** + * Rule to disallow unnecessary semicolons. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 0.0.9 + * @see https://eslint.org/docs/rules/no-extra-semi + */ + "no-extra-semi": Linter.RuleEntry<[]>; + + /** + * Rule to disallow reassigning `function` declarations. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 0.0.9 + * @see https://eslint.org/docs/rules/no-func-assign + */ + "no-func-assign": Linter.RuleEntry<[]>; + + /** + * Rule to disallow variable or `function` declarations in nested blocks. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 0.6.0 + * @see https://eslint.org/docs/rules/no-inner-declarations + */ + "no-inner-declarations": Linter.RuleEntry<["functions" | "both"]>; + + /** + * Rule to disallow invalid regular expression strings in `RegExp` constructors. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 0.1.4 + * @see https://eslint.org/docs/rules/no-invalid-regexp + */ + "no-invalid-regexp": Linter.RuleEntry< + [ + Partial<{ + allowConstructorFlags: string[]; + }>, + ] + >; + + /** + * Rule to disallow irregular whitespace. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 0.9.0 + * @see https://eslint.org/docs/rules/no-irregular-whitespace + */ + "no-irregular-whitespace": Linter.RuleEntry< + [ + Partial<{ + /** + * @default true + */ + skipStrings: boolean; + /** + * @default false + */ + skipComments: boolean; + /** + * @default false + */ + skipRegExps: boolean; + /** + * @default false + */ + skipTemplates: boolean; + }>, + ] + >; + + /** + * Disallow literal numbers that lose precision. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 7.1.0 + * @see https://eslint.org/docs/latest/rules/no-loss-of-precision + */ + "no-loss-of-precision": Linter.RuleEntry<[]>; + + /** + * Rule to disallow characters which are made with multiple code points in character class syntax. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 5.3.0 + * @see https://eslint.org/docs/rules/no-misleading-character-class + */ + "no-misleading-character-class": Linter.RuleEntry<[]>; + + /** + * Rule to disallow calling global object properties as functions. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 0.0.9 + * @see https://eslint.org/docs/rules/no-obj-calls + */ + "no-obj-calls": Linter.RuleEntry<[]>; + + /** + * Rule to disallow returning values from Promise executor functions. + * + * @since 7.3.0 + * @see https://eslint.org/docs/rules/no-promise-executor-return + */ + "no-promise-executor-return": Linter.RuleEntry<[ + { + /** + * @default false + */ + allowVoid?: boolean; + }, + ]>; + + /** + * Rule to disallow use of `Object.prototypes` builtins directly. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 2.11.0 + * @see https://eslint.org/docs/rules/no-prototype-builtins + */ + "no-prototype-builtins": Linter.RuleEntry<[]>; + + /** + * Rule to disallow multiple spaces in regular expressions. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 0.4.0 + * @see https://eslint.org/docs/rules/no-regex-spaces + */ + "no-regex-spaces": Linter.RuleEntry<[]>; + + /** + * Rule to disallow sparse arrays. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 0.4.0 + * @see https://eslint.org/docs/rules/no-sparse-arrays + */ + "no-sparse-arrays": Linter.RuleEntry<[]>; + + /** + * Rule to disallow template literal placeholder syntax in regular strings. + * + * @since 3.3.0 + * @see https://eslint.org/docs/rules/no-template-curly-in-string + */ + "no-template-curly-in-string": Linter.RuleEntry<[]>; + + /** + * Rule to disallow confusing multiline expressions. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 0.24.0 + * @see https://eslint.org/docs/rules/no-unexpected-multiline + */ + "no-unexpected-multiline": Linter.RuleEntry<[]>; + + /** + * Rule to disallow unreachable code after `return`, `throw`, `continue`, and `break` statements. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 0.0.6 + * @see https://eslint.org/docs/rules/no-unreachable + */ + "no-unreachable": Linter.RuleEntry<[]>; + + /** + * Disallow loops with a body that allows only one iteration. + * + * @since 7.3.0 + * @see https://eslint.org/docs/latest/rules/no-unreachable-loop + */ + "no-unreachable-loop": Linter.RuleEntry< + [ + Partial<{ + /** + * @default [] + */ + ignore: "WhileStatement" | "DoWhileStatement" | "ForStatement" | "ForInStatement" | "ForOfStatement"; + }>, + ] + >; + + /** + * Rule to disallow control flow statements in `finally` blocks. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 2.9.0 + * @see https://eslint.org/docs/rules/no-unsafe-finally + */ + "no-unsafe-finally": Linter.RuleEntry<[]>; + + /** + * Rule to disallow negating the left operand of relational operators. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 3.3.0 + * @see https://eslint.org/docs/rules/no-unsafe-negation + */ + "no-unsafe-negation": Linter.RuleEntry<[]>; + + /** + * Disallow use of optional chaining in contexts where the `undefined` value is not allowed. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 7.15.0 + * @see https://eslint.org/docs/rules/no-unsafe-optional-chaining + */ + "no-unsafe-optional-chaining": Linter.RuleEntry< + [ + Partial<{ + /** + * @default false + */ + disallowArithmeticOperators: boolean; + }>, + ] + >; + + /** + * Rule to disallow assignments that can lead to race conditions due to usage of `await` or `yield`. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 5.3.0 + * @see https://eslint.org/docs/rules/require-atomic-updates + */ + "require-atomic-updates": Linter.RuleEntry<[]>; + + /** + * Rule to require calls to `isNaN()` when checking for `NaN`. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 0.0.6 + * @see https://eslint.org/docs/rules/use-isnan + */ + "use-isnan": Linter.RuleEntry< + [ + Partial<{ + /** + * @default true + */ + enforceForSwitchCase: boolean; + /** + * @default true + */ + enforceForIndexOf: boolean; + }>, + ] + >; + + /** + * Rule to enforce comparing `typeof` expressions against valid strings. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 0.5.0 + * @see https://eslint.org/docs/rules/valid-typeof + */ + "valid-typeof": Linter.RuleEntry< + [ + Partial<{ + /** + * @default false + */ + requireStringLiterals: boolean; + }>, + ] + >; +} diff --git a/types/eslint/v8/rules/strict-mode.d.ts b/types/eslint/v8/rules/strict-mode.d.ts new file mode 100644 index 00000000000000..d63929b1c1baae --- /dev/null +++ b/types/eslint/v8/rules/strict-mode.d.ts @@ -0,0 +1,11 @@ +import { Linter } from "../index"; + +export interface StrictMode extends Linter.RulesRecord { + /** + * Rule to require or disallow strict mode directives. + * + * @since 0.1.0 + * @see https://eslint.org/docs/rules/strict + */ + strict: Linter.RuleEntry<["safe" | "global" | "function" | "never"]>; +} diff --git a/types/eslint/v8/rules/stylistic-issues.d.ts b/types/eslint/v8/rules/stylistic-issues.d.ts new file mode 100644 index 00000000000000..ec2f2028cafff1 --- /dev/null +++ b/types/eslint/v8/rules/stylistic-issues.d.ts @@ -0,0 +1,1905 @@ +import { Linter } from "../index"; + +export interface StylisticIssues extends Linter.RulesRecord { + /** + * Rule to enforce linebreaks after opening and before closing array brackets. + * + * @since 4.0.0-alpha.1 + * @see https://eslint.org/docs/rules/array-bracket-newline + */ + "array-bracket-newline": Linter.RuleEntry< + [ + | "always" + | "never" + | "consistent" + | Partial<{ + /** + * @default true + */ + multiline: boolean; + /** + * @default null + */ + minItems: number | null; + }>, + ] + >; + + /** + * Rule to enforce consistent spacing inside array brackets. + * + * @since 0.24.0 + * @see https://eslint.org/docs/rules/array-bracket-spacing + */ + "array-bracket-spacing": + | Linter.RuleEntry< + [ + "never", + Partial<{ + /** + * @default false + */ + singleValue: boolean; + /** + * @default false + */ + objectsInArrays: boolean; + /** + * @default false + */ + arraysInArrays: boolean; + }>, + ] + > + | Linter.RuleEntry< + [ + "always", + Partial<{ + /** + * @default true + */ + singleValue: boolean; + /** + * @default true + */ + objectsInArrays: boolean; + /** + * @default true + */ + arraysInArrays: boolean; + }>, + ] + >; + + /** + * Rule to enforce line breaks after each array element. + * + * @since 4.0.0-rc.0 + * @see https://eslint.org/docs/rules/array-element-newline + */ + "array-element-newline": Linter.RuleEntry< + [ + | "always" + | "never" + | "consistent" + | Partial<{ + /** + * @default true + */ + multiline: boolean; + /** + * @default null + */ + minItems: number | null; + }>, + ] + >; + + /** + * Rule to disallow or enforce spaces inside of blocks after opening block and before closing block. + * + * @since 1.2.0 + * @see https://eslint.org/docs/rules/block-spacing + */ + "block-spacing": Linter.RuleEntry<["always" | "never"]>; + + /** + * Rule to enforce consistent brace style for blocks. + * + * @since 0.0.7 + * @see https://eslint.org/docs/rules/brace-style + */ + "brace-style": Linter.RuleEntry< + [ + "1tbs" | "stroustrup" | "allman", + Partial<{ + /** + * @default false + */ + allowSingleLine: boolean; + }>, + ] + >; + + /** + * Rule to enforce camelcase naming convention. + * + * @since 0.0.2 + * @see https://eslint.org/docs/rules/camelcase + */ + camelcase: Linter.RuleEntry< + [ + Partial<{ + /** + * @default 'always' + */ + properties: "always" | "never"; + /** + * @default false + */ + ignoreDestructuring: boolean; + /** + * @remarks + * Also accept for regular expression patterns + */ + allow: string[]; + }>, + ] + >; + + /** + * Rule to enforce or disallow capitalization of the first letter of a comment. + * + * @since 3.11.0 + * @see https://eslint.org/docs/rules/capitalized-comments + */ + "capitalized-comments": Linter.RuleEntry< + [ + "always" | "never", + Partial<{ + ignorePattern: string; + /** + * @default false + */ + ignoreInlineComments: boolean; + /** + * @default false + */ + ignoreConsecutiveComments: boolean; + }>, + ] + >; + + /** + * Rule to require or disallow trailing commas. + * + * @since 0.16.0 + * @see https://eslint.org/docs/rules/comma-dangle + */ + "comma-dangle": Linter.RuleEntry< + [ + | "never" + | "always" + | "always-multiline" + | "only-multiline" + | Partial<{ + /** + * @default 'never' + */ + arrays: "never" | "always" | "always-multiline" | "only-multiline"; + /** + * @default 'never' + */ + objects: "never" | "always" | "always-multiline" | "only-multiline"; + /** + * @default 'never' + */ + imports: "never" | "always" | "always-multiline" | "only-multiline"; + /** + * @default 'never' + */ + exports: "never" | "always" | "always-multiline" | "only-multiline"; + /** + * @default 'never' + */ + functions: "never" | "always" | "always-multiline" | "only-multiline"; + }>, + ] + >; + + /** + * Rule to enforce consistent spacing before and after commas. + * + * @since 0.9.0 + * @see https://eslint.org/docs/rules/comma-spacing + */ + "comma-spacing": Linter.RuleEntry< + [ + Partial<{ + /** + * @default false + */ + before: boolean; + /** + * @default true + */ + after: boolean; + }>, + ] + >; + + /** + * Rule to enforce consistent comma style. + * + * @since 0.9.0 + * @see https://eslint.org/docs/rules/comma-style + */ + "comma-style": Linter.RuleEntry< + [ + "last" | "first", + Partial<{ + exceptions: Record; + }>, + ] + >; + + /** + * Rule to enforce consistent spacing inside computed property brackets. + * + * @since 0.23.0 + * @see https://eslint.org/docs/rules/computed-property-spacing + */ + "computed-property-spacing": Linter.RuleEntry<["never" | "always"]>; + + /** + * Rule to enforce consistent naming when capturing the current execution context. + * + * @since 0.0.9 + * @see https://eslint.org/docs/rules/consistent-this + */ + "consistent-this": Linter.RuleEntry<[...string[]]>; + + /** + * Rule to require or disallow newline at the end of files. + * + * @since 0.7.1 + * @see https://eslint.org/docs/rules/eol-last + */ + "eol-last": Linter.RuleEntry< + [ + "always" | "never", // | 'unix' | 'windows' + ] + >; + + /** + * Rule to require or disallow spacing between function identifiers and their invocations. + * + * @since 3.3.0 + * @see https://eslint.org/docs/rules/func-call-spacing + */ + "func-call-spacing": Linter.RuleEntry<["never" | "always"]>; + + /** + * Rule to require function names to match the name of the variable or property to which they are assigned. + * + * @since 3.8.0 + * @see https://eslint.org/docs/rules/func-name-matching + */ + "func-name-matching": + | Linter.RuleEntry< + [ + "always" | "never", + Partial<{ + /** + * @default false + */ + considerPropertyDescriptor: boolean; + /** + * @default false + */ + includeCommonJSModuleExports: boolean; + }>, + ] + > + | Linter.RuleEntry< + [ + Partial<{ + /** + * @default false + */ + considerPropertyDescriptor: boolean; + /** + * @default false + */ + includeCommonJSModuleExports: boolean; + }>, + ] + >; + + /** + * Rule to require or disallow named `function` expressions. + * + * @since 0.4.0 + * @see https://eslint.org/docs/rules/func-names + */ + "func-names": Linter.RuleEntry< + [ + "always" | "as-needed" | "never", + Partial<{ + generators: "always" | "as-needed" | "never"; + }>, + ] + >; + + /** + * Rule to enforce the consistent use of either `function` declarations or expressions. + * + * @since 0.2.0 + * @see https://eslint.org/docs/rules/func-style + */ + "func-style": Linter.RuleEntry< + [ + "expression" | "declaration", + Partial<{ + /** + * @default false + */ + allowArrowFunctions: boolean; + }>, + ] + >; + + /** + * Rule to enforce consistent line breaks inside function parentheses. + * + * @since 4.6.0 + * @see https://eslint.org/docs/rules/function-paren-newline + */ + "function-paren-newline": Linter.RuleEntry< + [ + | "always" + | "never" + | "multiline" + | "multiline-arguments" + | "consistent" + | Partial<{ + minItems: number; + }>, + ] + >; + + /** + * Rule to disallow specified identifiers. + * + * @since 2.0.0-beta.2 + * @see https://eslint.org/docs/rules/id-blacklist + */ + "id-blacklist": Linter.RuleEntry<[...string[]]>; + + /** + * Rule to enforce minimum and maximum identifier lengths. + * + * @since 1.0.0 + * @see https://eslint.org/docs/rules/id-length + */ + "id-length": Linter.RuleEntry< + [ + Partial<{ + /** + * @default 2 + */ + min: number; + /** + * @default Infinity + */ + max: number; + /** + * @default 'always' + */ + properties: "always" | "never"; + exceptions: string[]; + }>, + ] + >; + + /** + * Rule to require identifiers to match a specified regular expression. + * + * @since 1.0.0 + * @see https://eslint.org/docs/rules/id-match + */ + "id-match": Linter.RuleEntry< + [ + string, + Partial<{ + /** + * @default false + */ + properties: boolean; + /** + * @default false + */ + onlyDeclarations: boolean; + /** + * @default false + */ + ignoreDestructuring: boolean; + }>, + ] + >; + + /** + * Rule to enforce the location of arrow function bodies. + * + * @since 4.12.0 + * @see https://eslint.org/docs/rules/implicit-arrow-linebreak + */ + "implicit-arrow-linebreak": Linter.RuleEntry<["beside" | "below"]>; + + /** + * Rule to enforce consistent indentation. + * + * @since 0.14.0 + * @see https://eslint.org/docs/rules/indent + */ + indent: Linter.RuleEntry< + [ + number | "tab", + Partial<{ + /** + * @default 0 + */ + SwitchCase: number; + /** + * @default 1 + */ + VariableDeclarator: + | Partial<{ + /** + * @default 1 + */ + var: number | "first"; + /** + * @default 1 + */ + let: number | "first"; + /** + * @default 1 + */ + const: number | "first"; + }> + | number + | "first"; + /** + * @default 1 + */ + outerIIFEBody: number; + /** + * @default 1 + */ + MemberExpression: number | "off"; + /** + * @default { parameters: 1, body: 1 } + */ + FunctionDeclaration: Partial<{ + /** + * @default 1 + */ + parameters: number | "first" | "off"; + /** + * @default 1 + */ + body: number; + }>; + /** + * @default { parameters: 1, body: 1 } + */ + FunctionExpression: Partial<{ + /** + * @default 1 + */ + parameters: number | "first" | "off"; + /** + * @default 1 + */ + body: number; + }>; + /** + * @default { arguments: 1 } + */ + CallExpression: Partial<{ + /** + * @default 1 + */ + arguments: number | "first" | "off"; + }>; + /** + * @default 1 + */ + ArrayExpression: number | "first" | "off"; + /** + * @default 1 + */ + ObjectExpression: number | "first" | "off"; + /** + * @default 1 + */ + ImportDeclaration: number | "first" | "off"; + /** + * @default false + */ + flatTernaryExpressions: boolean; + ignoredNodes: string[]; + /** + * @default false + */ + ignoreComments: boolean; + }>, + ] + >; + + /** + * Rule to enforce the consistent use of either double or single quotes in JSX attributes. + * + * @since 1.4.0 + * @see https://eslint.org/docs/rules/jsx-quotes + */ + "jsx-quotes": Linter.RuleEntry<["prefer-double" | "prefer-single"]>; + + /** + * Rule to enforce consistent spacing between keys and values in object literal properties. + * + * @since 0.9.0 + * @see https://eslint.org/docs/rules/key-spacing + */ + "key-spacing": Linter.RuleEntry< + [ + | Partial< + | { + /** + * @default false + */ + beforeColon: boolean; + /** + * @default true + */ + afterColon: boolean; + /** + * @default 'strict' + */ + mode: "strict" | "minimum"; + align: + | Partial<{ + /** + * @default false + */ + beforeColon: boolean; + /** + * @default true + */ + afterColon: boolean; + /** + * @default 'colon' + */ + on: "value" | "colon"; + /** + * @default 'strict' + */ + mode: "strict" | "minimum"; + }> + | "value" + | "colon"; + } + | { + singleLine?: + | Partial<{ + /** + * @default false + */ + beforeColon: boolean; + /** + * @default true + */ + afterColon: boolean; + /** + * @default 'strict' + */ + mode: "strict" | "minimum"; + }> + | undefined; + multiLine?: + | Partial<{ + /** + * @default false + */ + beforeColon: boolean; + /** + * @default true + */ + afterColon: boolean; + /** + * @default 'strict' + */ + mode: "strict" | "minimum"; + align: + | Partial<{ + /** + * @default false + */ + beforeColon: boolean; + /** + * @default true + */ + afterColon: boolean; + /** + * @default 'colon' + */ + on: "value" | "colon"; + /** + * @default 'strict' + */ + mode: "strict" | "minimum"; + }> + | "value" + | "colon"; + }> + | undefined; + } + > + | { + align: Partial<{ + /** + * @default false + */ + beforeColon: boolean; + /** + * @default true + */ + afterColon: boolean; + /** + * @default 'colon' + */ + on: "value" | "colon"; + /** + * @default 'strict' + */ + mode: "strict" | "minimum"; + }>; + singleLine?: + | Partial<{ + /** + * @default false + */ + beforeColon: boolean; + /** + * @default true + */ + afterColon: boolean; + /** + * @default 'strict' + */ + mode: "strict" | "minimum"; + }> + | undefined; + multiLine?: + | Partial<{ + /** + * @default false + */ + beforeColon: boolean; + /** + * @default true + */ + afterColon: boolean; + /** + * @default 'strict' + */ + mode: "strict" | "minimum"; + }> + | undefined; + }, + ] + >; + + /** + * Rule to enforce consistent spacing before and after keywords. + * + * @since 2.0.0-beta.1 + * @see https://eslint.org/docs/rules/keyword-spacing + */ + "keyword-spacing": Linter.RuleEntry< + [ + Partial<{ + /** + * @default true + */ + before: boolean; + /** + * @default true + */ + after: boolean; + overrides: Record< + string, + Partial<{ + before: boolean; + after: boolean; + }> + >; + }>, + ] + >; + + /** + * Rule to enforce position of line comments. + * + * @since 3.5.0 + * @see https://eslint.org/docs/rules/line-comment-position + */ + "line-comment-position": Linter.RuleEntry< + [ + Partial<{ + /** + * @default 'above' + */ + position: "above" | "beside"; + ignorePattern: string; + /** + * @default true + */ + applyDefaultIgnorePatterns: boolean; + }>, + ] + >; + + /** + * Rule to enforce consistent linebreak style. + * + * @since 0.21.0 + * @see https://eslint.org/docs/rules/linebreak-style + */ + "linebreak-style": Linter.RuleEntry<["unix" | "windows"]>; + + /** + * Rule to require empty lines around comments. + * + * @since 0.22.0 + * @see https://eslint.org/docs/rules/lines-around-comment + */ + "lines-around-comment": Linter.RuleEntry< + [ + Partial<{ + /** + * @default true + */ + beforeBlockComment: boolean; + /** + * @default false + */ + afterBlockComment: boolean; + /** + * @default false + */ + beforeLineComment: boolean; + /** + * @default false + */ + afterLineComment: boolean; + /** + * @default false + */ + allowBlockStart: boolean; + /** + * @default false + */ + allowBlockEnd: boolean; + /** + * @default false + */ + allowObjectStart: boolean; + /** + * @default false + */ + allowObjectEnd: boolean; + /** + * @default false + */ + allowArrayStart: boolean; + /** + * @default false + */ + allowArrayEnd: boolean; + /** + * @default false + */ + allowClassStart: boolean; + /** + * @default false + */ + allowClassEnd: boolean; + ignorePattern: string; + /** + * @default true + */ + applyDefaultIgnorePatterns: boolean; + }>, + ] + >; + + /** + * Rule to require or disallow an empty line between class members. + * + * @since 4.9.0 + * @see https://eslint.org/docs/rules/lines-between-class-members + */ + "lines-between-class-members": Linter.RuleEntry< + [ + "always" | "never", + Partial<{ + /** + * @default false + */ + exceptAfterSingleLine: boolean; + }>, + ] + >; + + /** + * Rule to enforce a maximum depth that blocks can be nested. + * + * @since 0.0.9 + * @see https://eslint.org/docs/rules/max-depth + */ + "max-depth": Linter.RuleEntry< + [ + Partial<{ + /** + * @default 4 + */ + max: number; + }>, + ] + >; + + /** + * Rule to enforce a maximum line length. + * + * @since 0.0.9 + * @see https://eslint.org/docs/rules/max-len + */ + "max-len": Linter.RuleEntry< + [ + Partial<{ + /** + * @default 80 + */ + code: number; + /** + * @default 4 + */ + tabWidth: number; + comments: number; + ignorePattern: string; + /** + * @default false + */ + ignoreComments: boolean; + /** + * @default false + */ + ignoreTrailingComments: boolean; + /** + * @default false + */ + ignoreUrls: boolean; + /** + * @default false + */ + ignoreStrings: boolean; + /** + * @default false + */ + ignoreTemplateLiterals: boolean; + /** + * @default false + */ + ignoreRegExpLiterals: boolean; + }>, + ] + >; + + /** + * Rule to enforce a maximum number of lines per file. + * + * @since 2.12.0 + * @see https://eslint.org/docs/rules/max-lines + */ + "max-lines": Linter.RuleEntry< + [ + | Partial<{ + /** + * @default 300 + */ + max: number; + /** + * @default false + */ + skipBlankLines: boolean; + /** + * @default false + */ + skipComments: boolean; + }> + | number, + ] + >; + + /** + * Rule to enforce a maximum number of line of code in a function. + * + * @since 5.0.0 + * @see https://eslint.org/docs/rules/max-lines-per-function + */ + "max-lines-per-function": Linter.RuleEntry< + [ + Partial<{ + /** + * @default 50 + */ + max: number; + /** + * @default false + */ + skipBlankLines: boolean; + /** + * @default false + */ + skipComments: boolean; + /** + * @default false + */ + IIFEs: boolean; + }>, + ] + >; + + /** + * Rule to enforce a maximum depth that callbacks can be nested. + * + * @since 0.2.0 + * @see https://eslint.org/docs/rules/max-nested-callbacks + */ + "max-nested-callbacks": Linter.RuleEntry< + [ + | Partial<{ + /** + * @default 10 + */ + max: number; + }> + | number, + ] + >; + + /** + * Rule to enforce a maximum number of parameters in function definitions. + * + * @since 0.0.9 + * @see https://eslint.org/docs/rules/max-params + */ + "max-params": Linter.RuleEntry< + [ + | Partial<{ + /** + * @default 3 + */ + max: number; + }> + | number, + ] + >; + + /** + * Rule to enforce a maximum number of statements allowed in function blocks. + * + * @since 0.0.9 + * @see https://eslint.org/docs/rules/max-statements + */ + "max-statements": Linter.RuleEntry< + [ + | Partial<{ + /** + * @default 10 + */ + max: number; + /** + * @default false + */ + ignoreTopLevelFunctions: boolean; + }> + | number, + ] + >; + + /** + * Rule to enforce a maximum number of statements allowed per line. + * + * @since 2.5.0 + * @see https://eslint.org/docs/rules/max-statements-per-line + */ + "max-statements-per-line": Linter.RuleEntry< + [ + | Partial<{ + /** + * @default 1 + */ + max: number; + }> + | number, + ] + >; + + /** + * Rule to enforce a particular style for multiline comments. + * + * @since 4.10.0 + * @see https://eslint.org/docs/rules/multiline-comment-style + */ + "multiline-comment-style": Linter.RuleEntry<["starred-block" | "bare-block" | "separate-lines"]>; + + /** + * Rule to enforce newlines between operands of ternary expressions. + * + * @since 3.1.0 + * @see https://eslint.org/docs/rules/multiline-ternary + */ + "multiline-ternary": Linter.RuleEntry<["always" | "always-multiline" | "never"]>; + + /** + * Rule to require constructor names to begin with a capital letter. + * + * @since 0.0.3-0 + * @see https://eslint.org/docs/rules/new-cap + */ + "new-cap": Linter.RuleEntry< + [ + Partial<{ + /** + * @default true + */ + newIsCap: boolean; + /** + * @default true + */ + capIsNew: boolean; + newIsCapExceptions: string[]; + newIsCapExceptionPattern: string; + capIsNewExceptions: string[]; + capIsNewExceptionPattern: string; + /** + * @default true + */ + properties: boolean; + }>, + ] + >; + + /** + * Rule to enforce or disallow parentheses when invoking a constructor with no arguments. + * + * @since 0.0.6 + * @see https://eslint.org/docs/rules/new-parens + */ + "new-parens": Linter.RuleEntry<["always" | "never"]>; + + /** + * Rule to require a newline after each call in a method chain. + * + * @since 2.0.0-rc.0 + * @see https://eslint.org/docs/rules/newline-per-chained-call + */ + "newline-per-chained-call": Linter.RuleEntry< + [ + { + /** + * @default 2 + */ + ignoreChainWithDepth: number; + }, + ] + >; + + /** + * Rule to disallow `Array` constructors. + * + * @since 0.4.0 + * @see https://eslint.org/docs/rules/no-array-constructor + */ + "no-array-constructor": Linter.RuleEntry<[]>; + + /** + * Rule to disallow bitwise operators. + * + * @since 0.0.2 + * @see https://eslint.org/docs/rules/no-bitwise + */ + "no-bitwise": Linter.RuleEntry< + [ + Partial<{ + allow: string[]; + /** + * @default false + */ + int32Hint: boolean; + }>, + ] + >; + + /** + * Rule to disallow `continue` statements. + * + * @since 0.19.0 + * @see https://eslint.org/docs/rules/no-continue + */ + "no-continue": Linter.RuleEntry<[]>; + + /** + * Rule to disallow inline comments after code. + * + * @since 0.10.0 + * @see https://eslint.org/docs/rules/no-inline-comments + */ + "no-inline-comments": Linter.RuleEntry<[]>; + + /** + * Rule to disallow `if` statements as the only statement in `else` blocks. + * + * @since 0.6.0 + * @see https://eslint.org/docs/rules/no-lonely-if + */ + "no-lonely-if": Linter.RuleEntry<[]>; + + /** + * Rule to disallow mixed binary operators. + * + * @since 2.12.0 + * @see https://eslint.org/docs/rules/no-mixed-operators + */ + "no-mixed-operators": Linter.RuleEntry< + [ + Partial<{ + /** + * @default + * [ + * ["+", "-", "*", "/", "%", "**"], + * ["&", "|", "^", "~", "<<", ">>", ">>>"], + * ["==", "!=", "===", "!==", ">", ">=", "<", "<="], + * ["&&", "||"], + * ["in", "instanceof"] + * ] + */ + groups: string[][]; + /** + * @default true + */ + allowSamePrecedence: boolean; + }>, + ] + >; + + /** + * Rule to disallow mixed spaces and tabs for indentation. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 0.7.1 + * @see https://eslint.org/docs/rules/no-mixed-spaces-and-tabs + */ + "no-mixed-spaces-and-tabs": Linter.RuleEntry<["smart-tabs"]>; + + /** + * Rule to disallow use of chained assignment expressions. + * + * @since 3.14.0 + * @see https://eslint.org/docs/rules/no-multi-assign + */ + "no-multi-assign": Linter.RuleEntry<[]>; + + /** + * Rule to disallow multiple empty lines. + * + * @since 0.9.0 + * @see https://eslint.org/docs/rules/no-multiple-empty-lines + */ + "no-multiple-empty-lines": Linter.RuleEntry< + [ + | Partial<{ + /** + * @default 2 + */ + max: number; + maxEOF: number; + maxBOF: number; + }> + | number, + ] + >; + + /** + * Rule to disallow negated conditions. + * + * @since 1.6.0 + * @see https://eslint.org/docs/rules/no-negated-condition + */ + "no-negated-condition": Linter.RuleEntry<[]>; + + /** + * Rule to disallow nested ternary expressions. + * + * @since 0.2.0 + * @see https://eslint.org/docs/rules/no-nested-ternary + */ + "no-nested-ternary": Linter.RuleEntry<[]>; + + /** + * Rule to disallow `Object` constructors. + * + * @since 0.0.9 + * @see https://eslint.org/docs/rules/no-new-object + */ + "no-new-object": Linter.RuleEntry<[]>; + + /** + * Rule to disallow the unary operators `++` and `--`. + * + * @since 0.0.9 + * @see https://eslint.org/docs/rules/no-plusplus + */ + "no-plusplus": Linter.RuleEntry< + [ + Partial<{ + /** + * @default false + */ + allowForLoopAfterthoughts: boolean; + }>, + ] + >; + + /** + * Rule to disallow specified syntax. + * + * @since 1.4.0 + * @see https://eslint.org/docs/rules/no-restricted-syntax + */ + "no-restricted-syntax": Linter.RuleEntry< + [ + ...Array< + | string + | { + selector: string; + message?: string | undefined; + } + >, + ] + >; + + /** + * Rule to disallow all tabs. + * + * @since 3.2.0 + * @see https://eslint.org/docs/rules/no-tabs + */ + "no-tabs": Linter.RuleEntry< + [ + Partial<{ + /** + * @default false + */ + allowIndentationTabs: boolean; + }>, + ] + >; + + /** + * Rule to disallow ternary operators. + * + * @since 0.0.9 + * @see https://eslint.org/docs/rules/no-ternary + */ + "no-ternary": Linter.RuleEntry<[]>; + + /** + * Rule to disallow trailing whitespace at the end of lines. + * + * @since 0.7.1 + * @see https://eslint.org/docs/rules/no-trailing-spaces + */ + "no-trailing-spaces": Linter.RuleEntry< + [ + Partial<{ + /** + * @default false + */ + skipBlankLines: boolean; + /** + * @default false + */ + ignoreComments: boolean; + }>, + ] + >; + + /** + * Rule to disallow dangling underscores in identifiers. + * + * @since 0.0.9 + * @see https://eslint.org/docs/rules/no-underscore-dangle + */ + "no-underscore-dangle": Linter.RuleEntry< + [ + Partial<{ + allow: string[]; + /** + * @default false + */ + allowAfterThis: boolean; + /** + * @default false + */ + allowAfterSuper: boolean; + /** + * @default false + */ + enforceInMethodNames: boolean; + }>, + ] + >; + + /** + * Rule to disallow ternary operators when simpler alternatives exist. + * + * @since 0.21.0 + * @see https://eslint.org/docs/rules/no-unneeded-ternary + */ + "no-unneeded-ternary": Linter.RuleEntry< + [ + Partial<{ + /** + * @default true + */ + defaultAssignment: boolean; + }>, + ] + >; + + /** + * Rule to disallow whitespace before properties. + * + * @since 2.0.0-beta.1 + * @see https://eslint.org/docs/rules/no-whitespace-before-property + */ + "no-whitespace-before-property": Linter.RuleEntry<[]>; + + /** + * Rule to enforce the location of single-line statements. + * + * @since 3.17.0 + * @see https://eslint.org/docs/rules/nonblock-statement-body-position + */ + "nonblock-statement-body-position": Linter.RuleEntry< + [ + "beside" | "below" | "any", + Partial<{ + overrides: Record; + }>, + ] + >; + + /** + * Rule to enforce consistent line breaks inside braces. + * + * @since 2.12.0 + * @see https://eslint.org/docs/rules/object-curly-newline + */ + "object-curly-newline": Linter.RuleEntry< + [ + | "always" + | "never" + | Partial<{ + /** + * @default false + */ + multiline: boolean; + minProperties: number; + /** + * @default true + */ + consistent: boolean; + }> + | Partial< + Record< + "ObjectExpression" | "ObjectPattern" | "ImportDeclaration" | "ExportDeclaration", + | "always" + | "never" + | Partial<{ + /** + * @default false + */ + multiline: boolean; + minProperties: number; + /** + * @default true + */ + consistent: boolean; + }> + > + >, + ] + >; + + /** + * Rule to enforce consistent spacing inside braces. + * + * @since 0.22.0 + * @see https://eslint.org/docs/rules/object-curly-spacing + */ + "object-curly-spacing": + | Linter.RuleEntry< + [ + "never", + { + /** + * @default false + */ + arraysInObjects: boolean; + /** + * @default false + */ + objectsInObjects: boolean; + }, + ] + > + | Linter.RuleEntry< + [ + "always", + { + /** + * @default true + */ + arraysInObjects: boolean; + /** + * @default true + */ + objectsInObjects: boolean; + }, + ] + >; + + /** + * Rule to enforce placing object properties on separate lines. + * + * @since 2.10.0 + * @see https://eslint.org/docs/rules/object-property-newline + */ + "object-property-newline": Linter.RuleEntry< + [ + Partial<{ + /** + * @default false + */ + allowAllPropertiesOnSameLine: boolean; + }>, + ] + >; + + /** + * Rule to enforce variables to be declared either together or separately in functions. + * + * @since 0.0.9 + * @see https://eslint.org/docs/rules/one-var + */ + "one-var": Linter.RuleEntry< + [ + | "always" + | "never" + | "consecutive" + | Partial< + { + /** + * @default false + */ + separateRequires: boolean; + } & Record<"var" | "let" | "const", "always" | "never" | "consecutive"> + > + | Partial>, + ] + >; + + /** + * Rule to require or disallow newlines around variable declarations. + * + * @since 2.0.0-beta.3 + * @see https://eslint.org/docs/rules/one-var-declaration-per-line + */ + "one-var-declaration-per-line": Linter.RuleEntry<["initializations" | "always"]>; + + /** + * Rule to require or disallow assignment operator shorthand where possible. + * + * @since 0.10.0 + * @see https://eslint.org/docs/rules/operator-assignment + */ + "operator-assignment": Linter.RuleEntry<["always" | "never"]>; + + /** + * Rule to enforce consistent linebreak style for operators. + * + * @since 0.19.0 + * @see https://eslint.org/docs/rules/operator-linebreak + */ + "operator-linebreak": Linter.RuleEntry< + [ + "after" | "before" | "none", + Partial<{ + overrides: Record; + }>, + ] + >; + + /** + * Rule to require or disallow padding within blocks. + * + * @since 0.9.0 + * @see https://eslint.org/docs/rules/padded-blocks + */ + "padded-blocks": Linter.RuleEntry< + [ + "always" | "never" | Partial>, + { + /** + * @default false + */ + allowSingleLineBlocks: boolean; + }, + ] + >; + + /** + * Rule to require or disallow padding lines between statements. + * + * @since 4.0.0-beta.0 + * @see https://eslint.org/docs/rules/padding-line-between-statements + */ + "padding-line-between-statements": Linter.RuleEntry< + [ + ...Array< + { + blankLine: "any" | "never" | "always"; + } & Record<"prev" | "next", string | string[]> + >, + ] + >; + + /** + * Rule to disallow using Object.assign with an object literal as the first argument and prefer the use of object spread instead. + * + * @since 5.0.0-alpha.3 + * @see https://eslint.org/docs/rules/prefer-object-spread + */ + "prefer-object-spread": Linter.RuleEntry<[]>; + + /** + * Rule to require quotes around object literal property names. + * + * @since 0.0.6 + * @see https://eslint.org/docs/rules/quote-props + */ + "quote-props": + | Linter.RuleEntry<["always" | "consistent"]> + | Linter.RuleEntry< + [ + "as-needed", + Partial<{ + /** + * @default false + */ + keywords: boolean; + /** + * @default true + */ + unnecessary: boolean; + /** + * @default false + */ + numbers: boolean; + }>, + ] + > + | Linter.RuleEntry< + [ + "consistent-as-needed", + Partial<{ + /** + * @default false + */ + keywords: boolean; + }>, + ] + >; + + /** + * Rule to enforce the consistent use of either backticks, double, or single quotes. + * + * @since 0.0.7 + * @see https://eslint.org/docs/rules/quotes + */ + quotes: Linter.RuleEntry< + [ + "double" | "single" | "backtick", + Partial<{ + /** + * @default false + */ + avoidEscape: boolean; + /** + * @default false + */ + allowTemplateLiterals: boolean; + }>, + ] + >; + + /** + * Rule to require or disallow semicolons instead of ASI. + * + * @since 0.0.6 + * @see https://eslint.org/docs/rules/semi + */ + semi: + | Linter.RuleEntry< + [ + "always", + Partial<{ + /** + * @default false + */ + omitLastInOneLineBlock: boolean; + }>, + ] + > + | Linter.RuleEntry< + [ + "never", + Partial<{ + /** + * @default 'any' + */ + beforeStatementContinuationChars: "any" | "always" | "never"; + }>, + ] + >; + + /** + * Rule to enforce consistent spacing before and after semicolons. + * + * @since 0.16.0 + * @see https://eslint.org/docs/rules/semi-spacing + */ + "semi-spacing": Linter.RuleEntry< + [ + Partial<{ + /** + * @default false + */ + before: boolean; + /** + * @default true + */ + after: boolean; + }>, + ] + >; + + /** + * Rule to enforce location of semicolons. + * + * @since 4.0.0-beta.0 + * @see https://eslint.org/docs/rules/semi-style + */ + "semi-style": Linter.RuleEntry<["last" | "first"]>; + + /** + * Rule to require object keys to be sorted. + * + * @since 3.3.0 + * @see https://eslint.org/docs/rules/sort-keys + */ + "sort-keys": Linter.RuleEntry< + [ + "asc" | "desc", + Partial<{ + /** + * @default true + */ + caseSensitive: boolean; + /** + * @default 2 + */ + minKeys: number; + /** + * @default false + */ + natural: boolean; + /** + * @default false + */ + allowLineSeparatedGroups: boolean; + }>, + ] + >; + + /** + * Rule to require variables within the same declaration block to be sorted. + * + * @since 0.2.0 + * @see https://eslint.org/docs/rules/sort-vars + */ + "sort-vars": Linter.RuleEntry< + [ + Partial<{ + /** + * @default false + */ + ignoreCase: boolean; + }>, + ] + >; + + /** + * Rule to enforce consistent spacing before blocks. + * + * @since 0.9.0 + * @see https://eslint.org/docs/rules/space-before-blocks + */ + "space-before-blocks": Linter.RuleEntry< + ["always" | "never" | Partial>] + >; + + /** + * Rule to enforce consistent spacing before `function` definition opening parenthesis. + * + * @since 0.18.0 + * @see https://eslint.org/docs/rules/space-before-function-paren + */ + "space-before-function-paren": Linter.RuleEntry< + ["always" | "never" | Partial>] + >; + + /** + * Rule to enforce consistent spacing inside parentheses. + * + * @since 0.8.0 + * @see https://eslint.org/docs/rules/space-in-parens + */ + "space-in-parens": Linter.RuleEntry< + [ + "never" | "always", + Partial<{ + exceptions: string[]; + }>, + ] + >; + + /** + * Rule to require spacing around infix operators. + * + * @since 0.2.0 + * @see https://eslint.org/docs/rules/space-infix-ops + */ + "space-infix-ops": Linter.RuleEntry< + [ + Partial<{ + /** + * @default false + */ + int32Hint: boolean; + }>, + ] + >; + + /** + * Rule to enforce consistent spacing before or after unary operators. + * + * @since 0.10.0 + * @see https://eslint.org/docs/rules/space-unary-ops + */ + "space-unary-ops": Linter.RuleEntry< + [ + Partial<{ + /** + * @default true + */ + words: boolean; + /** + * @default false + */ + nonwords: boolean; + overrides: Record; + }>, + ] + >; + + /** + * Rule to enforce consistent spacing after the `//` or `/*` in a comment. + * + * @since 0.23.0 + * @see https://eslint.org/docs/rules/spaced-comment + */ + "spaced-comment": Linter.RuleEntry< + [ + "always" | "never", + { + exceptions: string[]; + markers: string[]; + line: { + exceptions: string[]; + markers: string[]; + }; + block: { + exceptions: string[]; + markers: string[]; + /** + * @default false + */ + balanced: boolean; + }; + }, + ] + >; + + /** + * Rule to enforce spacing around colons of switch statements. + * + * @since 4.0.0-beta.0 + * @see https://eslint.org/docs/rules/switch-colon-spacing + */ + "switch-colon-spacing": Linter.RuleEntry< + [ + Partial<{ + /** + * @default false + */ + before: boolean; + /** + * @default true + */ + after: boolean; + }>, + ] + >; + + /** + * Rule to require or disallow spacing between template tags and their literals. + * + * @since 3.15.0 + * @see https://eslint.org/docs/rules/template-tag-spacing + */ + "template-tag-spacing": Linter.RuleEntry<["never" | "always"]>; + + /** + * Rule to require or disallow Unicode byte order mark (BOM). + * + * @since 2.11.0 + * @see https://eslint.org/docs/rules/unicode-bom + */ + "unicode-bom": Linter.RuleEntry<["never" | "always"]>; + + /** + * Rule to require parenthesis around regex literals. + * + * @since 0.1.0 + * @see https://eslint.org/docs/rules/wrap-regex + */ + "wrap-regex": Linter.RuleEntry<[]>; +} diff --git a/types/eslint/v8/rules/variables.d.ts b/types/eslint/v8/rules/variables.d.ts new file mode 100644 index 00000000000000..796274d16de270 --- /dev/null +++ b/types/eslint/v8/rules/variables.d.ts @@ -0,0 +1,194 @@ +import { Linter } from "../index"; + +export interface Variables extends Linter.RulesRecord { + /** + * Rule to require or disallow initialization in variable declarations. + * + * @since 1.0.0-rc-1 + * @see https://eslint.org/docs/rules/init-declarations + */ + "init-declarations": + | Linter.RuleEntry<["always"]> + | Linter.RuleEntry< + [ + "never", + Partial<{ + ignoreForLoopInit: boolean; + }>, + ] + >; + + /** + * Rule to disallow deleting variables. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 0.0.9 + * @see https://eslint.org/docs/rules/no-delete-var + */ + "no-delete-var": Linter.RuleEntry<[]>; + + /** + * Rule to disallow labels that share a name with a variable. + * + * @since 0.0.9 + * @see https://eslint.org/docs/rules/no-label-var + */ + "no-label-var": Linter.RuleEntry<[]>; + + /** + * Rule to disallow specified global variables. + * + * @since 2.3.0 + * @see https://eslint.org/docs/rules/no-restricted-globals + */ + "no-restricted-globals": Linter.RuleEntry< + [ + ...Array< + | string + | { + name: string; + message?: string | undefined; + } + >, + ] + >; + + /** + * Rule to disallow variable declarations from shadowing variables declared in the outer scope. + * + * @since 0.0.9 + * @see https://eslint.org/docs/rules/no-shadow + */ + "no-shadow": Linter.RuleEntry< + [ + Partial<{ + /** + * @default false + */ + builtinGlobals: boolean; + /** + * @default 'functions' + */ + hoist: "functions" | "all" | "never"; + allow: string[]; + }>, + ] + >; + + /** + * Rule to disallow identifiers from shadowing restricted names. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 0.1.4 + * @see https://eslint.org/docs/rules/no-shadow-restricted-names + */ + "no-shadow-restricted-names": Linter.RuleEntry<[]>; + + /** + * Rule to disallow the use of undeclared variables unless mentioned in `global` comments. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 0.0.9 + * @see https://eslint.org/docs/rules/no-undef + */ + "no-undef": Linter.RuleEntry< + [ + Partial<{ + /** + * @default false + */ + typeof: boolean; + }>, + ] + >; + + /** + * Rule to disallow initializing variables to `undefined`. + * + * @since 0.0.6 + * @see https://eslint.org/docs/rules/no-undef-init + */ + "no-undef-init": Linter.RuleEntry<[]>; + + /** + * Rule to disallow the use of `undefined` as an identifier. + * + * @since 0.7.1 + * @see https://eslint.org/docs/rules/no-undefined + */ + "no-undefined": Linter.RuleEntry<[]>; + + /** + * Rule to disallow unused variables. + * + * @remarks + * Recommended by ESLint, the rule was enabled in `eslint:recommended`. + * + * @since 0.0.9 + * @see https://eslint.org/docs/rules/no-unused-vars + */ + "no-unused-vars": Linter.RuleEntry< + [ + | "all" + | "local" + | Partial<{ + /** + * @default 'all' + */ + vars: "all" | "local"; + varsIgnorePattern: string; + /** + * @default 'after-used' + */ + args: "after-used" | "all" | "none"; + /** + * @default false + */ + ignoreRestSiblings: boolean; + argsIgnorePattern: string; + /** + * @default 'none' + */ + caughtErrors: "none" | "all"; + caughtErrorsIgnorePattern: string; + destructuredArrayIgnorePattern: string; + }>, + ] + >; + + /** + * Rule to disallow the use of variables before they are defined. + * + * @since 0.0.9 + * @see https://eslint.org/docs/rules/no-use-before-define + */ + "no-use-before-define": Linter.RuleEntry< + [ + | Partial<{ + /** + * @default true + */ + functions: boolean; + /** + * @default true + */ + classes: boolean; + /** + * @default true + */ + variables: boolean; + /** + * @default false + */ + allowNamedExports: boolean; + }> + | "nofunc", + ] + >; +} diff --git a/types/eslint/v8/tsconfig.json b/types/eslint/v8/tsconfig.json new file mode 100644 index 00000000000000..18d534d29f2457 --- /dev/null +++ b/types/eslint/v8/tsconfig.json @@ -0,0 +1,20 @@ +{ + "compilerOptions": { + "module": "node16", + "lib": [ + "dom", + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "eslint-tests.ts" + ] +} diff --git a/types/eslint/v8/use-at-your-own-risk.d.ts b/types/eslint/v8/use-at-your-own-risk.d.ts new file mode 100644 index 00000000000000..089a657babec22 --- /dev/null +++ b/types/eslint/v8/use-at-your-own-risk.d.ts @@ -0,0 +1,19 @@ +/** @deprecated */ +export const builtinRules: Map; +/** @deprecated */ +export class FileEnumerator { + constructor( + params?: { + cwd?: string; + configArrayFactory?: any; + extensions?: any; + globInputPaths?: boolean; + errorOnUnmatchedPattern?: boolean; + ignore?: boolean; + }, + ); + isTargetPath(filePath: string, providedConfig?: any): boolean; + iterateFiles( + patternOrPatterns: string | string[], + ): IterableIterator<{ config: any; filePath: string; ignored: boolean }>; +} diff --git a/types/eslint__eslintrc/eslint__eslintrc-tests.ts b/types/eslint__eslintrc/eslint__eslintrc-tests.ts index ad6cc3993fe6d8..4da09182f54072 100644 --- a/types/eslint__eslintrc/eslint__eslintrc-tests.ts +++ b/types/eslint__eslintrc/eslint__eslintrc-tests.ts @@ -9,19 +9,19 @@ const compat = new FlatCompat({ }); const config: Linter.FlatConfig[] = [ - // $ExpectType FlatConfig + // $ExpectType FlatConfig ...compat.extends("standard", "example"), - // $ExpectType FlatConfig + // $ExpectType FlatConfig ...compat.env({ es2020: true, node: true, }), - // $ExpectType FlatConfig + // $ExpectType FlatConfig ...compat.plugins("airbnb", "react"), - // $ExpectType FlatConfig + // $ExpectType FlatConfig ...compat.config({ plugins: ["airbnb", "react"], extends: "standard", diff --git a/types/eslint__eslintrc/index.d.ts b/types/eslint__eslintrc/index.d.ts index 6c8787d4641993..7ab9f84dd939db 100644 --- a/types/eslint__eslintrc/index.d.ts +++ b/types/eslint__eslintrc/index.d.ts @@ -15,8 +15,8 @@ export class FlatCompat { */ baseDirectory?: string; resolvePluginsRelativeTo?: string; - recommendedConfig?: Linter.Config; - allConfig?: Linter.Config; + recommendedConfig?: Linter.LegacyConfig; + allConfig?: Linter.LegacyConfig; }); /** @@ -24,7 +24,7 @@ export class FlatCompat { * @param eslintrcConfig The ESLintRC-style config object. * @returns A flag-config-style config object. */ - config(eslintrcConfig: Linter.Config): Linter.FlatConfig[]; + config(eslintrcConfig: Linter.LegacyConfig): Linter.FlatConfig[]; /** * Translates the `env` section of an ESLintRC-style config. diff --git a/types/espree/espree-tests.ts b/types/espree/espree-tests.ts index 8563a2fde6a1fc..138b903301ada2 100644 --- a/types/espree/espree-tests.ts +++ b/types/espree/espree-tests.ts @@ -34,3 +34,7 @@ const full_options: Options = { }; const empty_options: Options = {}; + +const latest_options: Options = { + ecmaVersion: 16, +}; diff --git a/types/espree/index.d.cts b/types/espree/index.d.cts index dad1d5dc8c618f..68fab8e3ac1fba 100644 --- a/types/espree/index.d.cts +++ b/types/espree/index.d.cts @@ -59,8 +59,8 @@ export interface Options { tokens?: boolean; /** - * Set to 3, 5 (the default), 6, 7, 8, 9, 10, 11, 12, 13, 14 or 15 to specify the version of ECMAScript syntax you want to use. - * You can also set to 2015 (same as 6), 2016 (same as 7), 2017 (same as 8), 2018 (same as 9), 2019 (same as 10), 2020 (same as 11), 2021 (same as 12), 2022 (same as 13), 2023 (same as 14) or 2024 (same as 15) to use the year-based naming. + * Set to 3, 5 (the default), 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 or 16 to specify the version of ECMAScript syntax you want to use. + * You can also set to 2015 (same as 6), 2016 (same as 7), 2017 (same as 8), 2018 (same as 9), 2019 (same as 10), 2020 (same as 11), 2021 (same as 12), 2022 (same as 13), 2023 (same as 14), 2024 (same as 15) or 2025 (same as 16) to use the year-based naming. * You can also set "latest" to use the most recently supported version. */ ecmaVersion?: @@ -76,6 +76,7 @@ export interface Options { | 13 | 14 | 15 + | 16 | 2015 | 2016 | 2017 @@ -86,6 +87,7 @@ export interface Options { | 2022 | 2023 | 2024 + | 2025 | "latest"; /** diff --git a/types/espree/package.json b/types/espree/package.json index c89ee400864241..f4508211753a47 100644 --- a/types/espree/package.json +++ b/types/espree/package.json @@ -1,7 +1,7 @@ { "private": true, "name": "@types/espree", - "version": "10.0.9999", + "version": "10.1.9999", "type": "module", "exports": { ".": { @@ -14,7 +14,7 @@ "https://github.com/eslint/espree" ], "dependencies": { - "acorn": "^8.11.3", + "acorn": "^8.12.0", "eslint-visitor-keys": "^4.0.0" }, "devDependencies": { diff --git a/types/exaroton/exaroton-tests.ts b/types/exaroton/exaroton-tests.ts index 9ca542014e3848..28b3efdaf4fefb 100644 --- a/types/exaroton/exaroton-tests.ts +++ b/types/exaroton/exaroton-tests.ts @@ -6,7 +6,7 @@ const startServer = async (name: string) => { const servers = await client.getServers(); const myServer = servers.find(s => s.name === name); if (!myServer) throw Error("Server not found"); - myServer.setMOTD("Hello World"); + await myServer.setMOTD("Hello World"); console.log(myServer?.status); if (myServer?.hasStatus([myServer.STATUS.ONLINE, myServer.STATUS.STARTING])) return; await myServer?.start(); @@ -15,7 +15,41 @@ const startServer = async (name: string) => { console.log(myServer?.players.max); const myServerProperties = myServer.getFile("server.properties"); + const config = myServerProperties.getConfig(); console.log(myServerProperties.getContent()); + + let options = await config.getOptions(); + + options.get("max-players")?.setValue(26); + options.get("pvp")?.setValue(false); + + await config.save(); + + let pools = await client.getPools(); + console.log(pools); + + let pool = client.pool("id"); + await pool.get(); + console.log(`${pool.name}: ${pool.credits}`); + + let members = await pool.getMembers(); + console.log(members); + + let poolServers = await pool.getServers(); + console.log(poolServers); + + myServer.subscribe(); + myServer.on("status", server => console.log(server.status)); + myServer.subscribe("console"); + myServer.on("console:line", data => console.log(data)); + myServer.subscribe("tick"); + myServer.on("tick:tick", data => { + console.log(`Tick time: ${data.averageTickTime}ms`); + console.log(`TPS: ${data.tps}`); + }); + myServer.subscribe(["stats", "heap"]); + myServer.on("stats:stats", data => console.log(data.memory.usage)); + myServer.on("heap:heap", data => console.log(data.usage)); }; startServer("my server"); diff --git a/types/exaroton/index.d.ts b/types/exaroton/index.d.ts index 9bb505b4ff649f..90051f6ec4e8a2 100644 --- a/types/exaroton/index.d.ts +++ b/types/exaroton/index.d.ts @@ -1,126 +1,184 @@ -import { EventEmitter } from "events"; +import { Method, Options as GotOptions, ResponseType } from "got"; +import { EventEmitter } from "node:events"; +import { ReadStream, WriteStream } from "node:fs"; import { WebSocket } from "ws"; -import FormData = require("form-data"); -import { ReadableStream, WritableStream } from "node:stream/web"; -// Exported types -export { Client, Request, Response, Server, Software }; -declare class Client { - protocol: string | "https"; - - host: string | "api.exaroton.com"; +export { Client, ConfigOptionType, Pool, PoolMember, Request, Response, Server, ServerStatus, Software }; + +declare enum ServerStatus { + OFFLINE = 0, + ONLINE = 1, + STARTING = 2, + STOPPING = 3, + RESTARTING = 4, + SAVING = 5, + LOADING = 6, + CRASHED = 7, + PENDING = 8, + PREPARING = 10, +} - basePath: string | "/v1"; +declare class Client { + /** + * The protocol type used for request + * + * Can be http, https, ws or wss + * @defaultValue htttps + */ + protocol: string; /** - * API base URL used for all requests + * The hostname the client uses to retireve all data + * + * @defaultValue api.exaroton.com */ - get baseUrl(): string; + host: string; /** - * API token used for authentication + * Represents the api version + * + * @defaultValue /v1/ */ - private apiToken: string | null; + basePath: string; /** - * User agent sent with all requests + * API base URL used for all requests */ - private userAgent: string; + get baseUrl(): string; + + #apiToken: string | null; + + #userAgent: string; /** - * @param apiToken string API token, create one here: https://exaroton.com/account/ + * Client constructor + * + * @param {string} apiToken string API token, create one here: https://exaroton.com/account/ */ constructor(apiToken: string); /** * Set the API token * - * @param apiToken + * @param {string} apiToken */ - setAPIToken(apiToken: string): string; + setAPIToken(apiToken: string): this; + /** + * Returns the currently set api token used for requests + */ getAPIToken(): string; /** * Set the user agent * - * @param userAgent + * @param {string} userAgent */ - setUserAgent(userAgent: string): Client; + setUserAgent(userAgent: string): this; /** * Send a {Request} to the API and get a {Response} * - * @param request - * @throws {RequestError} + * @param {Request} request + * @throws {RequestError} if the request was unsuccessful */ - request(request: Request): Promise; + request(request: T): Promise; /** - * @param url - * @param gotOptions - * @param outputStream + * @param {string} url + * @param {GotOptions & { + isStream?: true | boolean; + }} gotOptions + * @param {stream.Writable} outputStream */ - streamResponse(url: string, gotOptions: object, outputStream: WritableStream): Promise; + streamResponse( + url: string, + gotOptions: GotOptions & { + isStream?: true | boolean; + }, + outputStream: T, + ): Promise; /** * Get a list of all servers - * @throws {RequestError} + * + * @return {Promise} + * @throws {RequestError} if the request was unsuccessful */ getServers(): Promise; + /** + * Get a list of all credit pools + * + * @return {Promise} + * @throws {RequestError} if the request was unsuccessful + */ + getPools(): Promise; + /** * Get account info for the current account * - * @throws {RequestError} + * @throws {RequestError} if the request was unsuccessful + * @returns {Promise} */ getAccount(): Promise; /** - * Initialize a new server object + * Retrieve a specific server via its ID * - * @param id + * @param {string} id + * @return {Server} */ server(id: string): Server; + + /** + * Retrieve a specific credit pool via its ID + * + * @param {string} id + * @return {Pool} + */ + pool(id: string): Pool; } declare class Request { /** * Request method, e.g. "GET" or "POST" */ - readonly method: Method; + method: Method; /** * Endpoint URL, without base, version or starting / */ - readonly endpoint: string; + endpoint: string; /** * URL parameters, which are replaced in the endpoint string */ - readonly parameters: object; + parameters: Record; /** * HTTP request headers */ - readonly headers: object; + headers: Record; /** * Post body data */ - readonly data: null | object | string; + data: null | Record | string; /** * Response class used to create/parse responses to this request + * + * @defaultValue {Response} */ - readonly responseClass: Response; + responseClass: Response; /** * Response type (text|json|buffer) * - * @see https://github.com/sindresorhus/got/blob/main/documentation/2-options.md#responsetype + * @link https://github.com/sindresorhus/got/blob/main/documentation/2-options.md#responsetype */ - readonly responseType: ResponseType; + responseType: ResponseType; /** * Optional path to write the response body to @@ -128,9 +186,9 @@ declare class Request { outputPath?: string; /** - * Optional stream tonstream the response body to + * Optional stream to stream the response body to */ - outputStream?: WritableStream | null; + outputStream?: WriteStream | null; /** * Optional path to read the request body from @@ -140,21 +198,28 @@ declare class Request { /** * Optional stream to read the request body from */ - inputStream?: ReadableStream | null; + inputStream?: ReadStream | null; + + /** + * Client that has executed this request + */ + client: Client; /** * Set a URL parameter * - * URL parameters replace {key} variables in the endpoint URL + * URL parameters replace key variables in the endpoint URL * - * @param key - * @param value + * @param {string} key + * @param {string} value */ setParameter(key: string, value: string): void; /** - * @param key - * @param value + * Set request headers + * + * @param {string} key + * @param {string} value */ setHeader(key: string, value: string): void; @@ -171,85 +236,106 @@ declare class Request { /** * Get body for request */ - getBody(): FormData | string | ReadableStream; + getBody(): string | ReadStream; /** * Create a response object for this request * - * @param body + * @param {Record|string|null} body + * @return {Response} */ - createResponse(body: object | string | null): Response; + createResponse(body: Record | string | null): Response; + /** + * @return {boolean} + */ expectsJsonResponse(): boolean; - getOutputStream(): WritableStream | null; + /** + * @return {null|WriteStream} + */ + getOutputStream(): WriteStream | null; + /** + * @return {boolean} + */ hasOutputStream(): boolean; - getInputStream(): WritableStream | null; + /** + * @return {null|ReadStream} + */ + getInputStream(): ReadStream | null; + /** + * @return {boolean} + */ hasInputStream(): boolean; /** - * Set a file as output file for the response body + * Set the data to put as string * - * @param outputPath + * @param {string|Record} data + * @return {this} */ - setOutputPath(outputPath: string): Request; + setData(data: string | Record): this; /** - * Set a stream as input stream for request body + * Set a file as input file for the request body * - * @param inputStream + * @param {string} inputPath + * @return {this} */ - setInputStream(inputStream: ReadableStream): Request; + setInputPath(inputPath: string): Request; /** - * Set a stream as output stream for the request body + * Set a file as output file for the response body * - * @param outputStream + * @param {string} outputPath + * @return {this} */ - setOutputStream(outputStream: WritableStream): Request; + setOutputPath(outputPath: string): Request; /** - * Set the data to put as string + * Set a stream as input stream for the request body + * + * @param {ReadStream} inputStream + * @return {this} */ - setData(data: string | object): Request; + setInputStream(inputStream: ReadStream): this; /** - * Set a file as input file for the request body + * Set a stream as output stream for the response body * - * @param inputPath + * @param {WriteStream} outputStream + * @return {this} */ - setInputPath(inputPath: string): Request; + setOutputStream(outputStream: WriteStream): this; } declare class Response { - request: Request; + readonly request: Request; /** * (raw/parsed) response body */ - body: object | string; + readonly body: Record | string; /** - * Request constructor + * Response constructor * - * @param request + * @param {Request} request */ constructor(request: Request); /** * Get the data from the response */ - getData(): object | null; + getData(): Record | null; /** * Set the body to this.body and maybe parse content - * - * @param body */ - setBody(body: object | string): void; + setBody(body: Record | string): void; } declare class File { @@ -279,33 +365,46 @@ declare class File { readonly children: File[] | null; - private readonly server: Server; + #server: Server; - private readonly client: Client; + #client: Client; constructor(path: string | null); setPath(path: string): void; /** - * Apply data from the API Response + * Apply data from the API response + * + * @param {Record} object + * @return {File} */ - applyData(object: object): File; + applyData(object: Record): File; /** * Set the server * - * @param server + * @param {Server} server + * @returns {this} */ setServer(server: Server): File; /** - * Set the API client + * Set the client to be used for further requests + * + * @param {Client} client + * @returns {this} */ setClient(client: Client): File; + getClient(): Client; + + getServer(): Server; + /** * Get file information from the API + * + * @returns {Promise} */ getInfo(): Promise; @@ -313,25 +412,36 @@ declare class File { * Get the data/content of a file * * If you want to download the file to a local file use File.download() instead + * + * @return {Promise} */ getContent(): Promise; /** * Download the data/content of a file to a local file * - * If you want to use the content of a file directly use File.getContent() instead + * If you want to use the content of the file directly use File.getContent() instead + * + * @param {string} outputPath + * @return {Promise} */ download(outputPath: string): Promise; /** * Download the data/content of a file into a writable stream + * + * @param {WriteStream} outputStream + * @return {Promise} */ - downloadToStream(outputStream: WritableStream): Promise; + downloadToStream(outputStream: WriteStream): Promise; /** * Put the content of a file * * If you want to upload a local file use File.upload() instead + * + * @param {string} content + * @return {Promise} */ putContent(content: string | object): Promise; @@ -339,28 +449,202 @@ declare class File { * Upload a local file * * If you want to upload the content of the file directly as a string use File.putContent() instead + * + * @param {string} inputPath + * @return {Promise} */ upload(inputPath: string): Promise; /** * Upload from a readable stream + * + * @param {ReadStream} inputStream + * @return {Promise} */ - uploadFromStream(inputStream: ReadableStream): Promise; + uploadFromStream(inputStream: ReadStream): Promise; /** - * Delete a file + * Delete the file + * + * @return {Promise} */ delete(): Promise; /** * Create a directory + * + * @return {Promise} */ createAsDirectory(): Promise; /** * Get the children of a directory + * + * @return {Promise} */ getChildren(): Promise; + + /** + * Get Config object for this file + * Only available if the file is a config file + * + * @return {Config} + */ + getConfig(): Config; +} + +declare class Config { + #file?: File; + #options: Map | null; + #originalValues: Map | null; + + constructor(file: File); + + applyData(object: Record): this; + + private loadOptions(): Promise; + + getOptions(update?: boolean): Promise>; + + getOption(key: PropertyKey): Promise; + + /** + * Save all changes made to this config file + * + * @return {Promise} null if no changes were made + */ + save(): Promise | null; +} + +type ConfigOptionValue = string | number | boolean | string[]; + +declare class ConfigOption { + #key: string; + #label: string; + #type: string; + #value: ConfigOptionValue; + #options: string[] | null; + + constructor(key: string, label: string, type: string, value: ConfigOptionValue, options?: string[] | null); + + getKey(): string; + + getLabel(): string; + + getType(): string; + + getValue(): ConfigOptionValue; + + setValue(value: ConfigOptionValue): ConfigOption; + + getOptions(): string[] | null; +} + +declare class ConfigOptionType { + static STRING: string; + static INTEGER: string; + static FLOAT: string; + static BOOLEAN: string; + static MULTI_SELECT: string; + static SELECT: string; +} + +declare class Pool { + #client: Client; + + id: string; + + name?: string; + + /** + * Pool credit balance + */ + credits?: number; + + /** + * Pool server count + */ + servers?: number; + + /** + * Pool owner ID + */ + owner?: string; + + /** + * Is pool owner + */ + isOwner?: boolean; + + /** + * Pool member count + */ + members?: number; + + /** + * Share of this pool owned by the current account + */ + ownShare?: number; + + /** + * Credits in this pool owned by the current account + */ + ownCredits?: number; + + constructor(client: Client, id: string); + + setFromObject(poolObject: Record): this; + + /** + * Get credit pool info + * + * @return {this} + * @throws {RequestError} if the request was unsuccessful + */ + get(): Promise; + + /** + * Get pool members + * + * @return {Promise} + */ + getMembers(): Promise; + + /** + * Get pool servers + * + * @return {Promise} + */ + getServers(): Promise; +} + +declare class PoolMember { + /** + * Pool member account ID + */ + account: string; + + /** + * Pool member name + */ + name: string; + + /** + * Pool member share + */ + share: number; + + /** + * Pool member credits + */ + credits: number; + + /** + * Is pool owner + */ + isOwner: boolean; + + constructor(poolMemberObject: Record); } interface Server { @@ -382,47 +666,56 @@ interface Software { readonly version: string; } +export interface StreamTypes { + status: [server: Server]; + "console:line": [data: string]; + "tick:tick": [data: { averageTickTime: number; tps: number }]; + "stats:stats": [data: { memory: { percent: number; usage: number } }]; + "heap:heap": [data: { usage: number }]; +} + declare class Server extends EventEmitter { /** * Shorthand to get server status constants */ readonly STATUS: { - OFFLINE: 0; - ONLINE: 1; - STARTING: 2; - STOPPING: 3; - RESTARTING: 4; - SAVING: 5; - LOADING: 6; - CRASHED: 7; - PENDING: 8; - PREPARING: 10; + readonly OFFLINE: 0; + readonly ONLINE: 1; + readonly STARTING: 2; + readonly STOPPING: 3; + readonly RESTARTING: 4; + readonly SAVING: 5; + readonly LOADING: 6; + readonly CRASHED: 7; + readonly PENDING: 8; + readonly PREPARING: 10; }; - private readonly client: Client; + #client: Client; + + #websocketClient: WebsocketClient; /** * Unique server ID */ readonly id: string; - /** - * Server name - */ readonly name: string; /** - * Full server address (e.g. example.exaroton.me) + * Full server address + * @example example.exaroton.me */ readonly address: string; /** - * MOTD + * Message of the day */ readonly motd: string; /** * Server status + * @see {STATUS} */ readonly status: number; @@ -437,9 +730,9 @@ declare class Server extends EventEmitter { readonly port: number | null; /** - * Check if this is an owned or shared server + * Check if this an owned or a shared server */ - readonly shared: false | boolean; + readonly shared: boolean; /** * Server software @@ -447,16 +740,15 @@ declare class Server extends EventEmitter { readonly software: Software; /** - * Player lists + * Player data */ readonly player: Players; /** - * Server constructor - * - * @param client - * @param id + * Player lists */ + #playerLists: Record; + constructor(client: Client, id: string); getClient(): Server; @@ -464,35 +756,41 @@ declare class Server extends EventEmitter { /** * Get/update the server info * - * @throws {RequestError} + * @return {this} + * @throws {RequestError} if the request was unsuccessful */ get(): Promise; /** * Start the server * - * @throws {RequestError} + * @param {boolean} useOwnCredits Use your own credits instead of the server owner's ones + * @return {Promise} + * @throws {RequestError} if the request was unsuccessful */ - start(): Promise; + start(useOwnCredits?: boolean): Promise; /** * Stop the server * - * @throws {RequestError} + * @return {Promise} + * @throws {RequestError} if the request was unsuccessful */ stop(): Promise; /** * Restart the server * - * @throws {RequestError} + * @return {Promise} + * @throws {RequestError} if the request was unsuccessful */ restart(): Promise; /** * Execute a command in the server console * - * @param command + * @param {string} command + * @return {Promise} */ executeCommand(command: string): Promise; @@ -500,6 +798,8 @@ declare class Server extends EventEmitter { * Get the content of the server logs * * This is cached and will not return the latest updates immediately. + * + * @returns {Promise} */ getLogs(): Promise; @@ -507,30 +807,38 @@ declare class Server extends EventEmitter { * Upload the content of the server logs to mclo.gs * * Returns the URL of the logs on mclo.gs + * + * @returns {Promise} */ shareLogs(): Promise; /** * Get the assigned max server RAM in GB + * + * @return {Promise} */ getRAM(): Promise; /** * Set the assigned max server RAM in GB * - * @param ram + * @param {number} ram + * @return {Promise} */ setRAM(ram: number): Promise; /** - * Get the server MOTD + * Get the server Message of the day + * + * @returns {Promise} */ getMOTD(): Promise; /** - * Set the server MOTD + * Set a new Message of the day * - * @param motd + * @param {string} motd + * @returns {Promise} */ setMOTD(motd: string): Promise; @@ -538,19 +846,23 @@ declare class Server extends EventEmitter { * Get a server option * * @param option + * @return {Promise<*>} */ - getOption(option: string): Promise; + getOption(option: string): Promise | null>; /** * Set a server option * * @param option * @param value + * @return {Promise} */ setOption(option: string, value: string): Promise; /** * Get all player lists available for the server + * + * @returns {Promise} */ getPlayerLists(): Promise; @@ -558,16 +870,18 @@ declare class Server extends EventEmitter { * Get a player list by name * * @param name + * @returns {PlayerList} */ - getPlayerList(name: PlayerListTypes): PlayerList; + getPlayerList(name: PlayerListType): PlayerList; /** * Get a file object for a server file * * This doesn't request file info or content yet. - * Use the File.getInfo() and File.getContent() methods for that + * Use the File.getInfo() and File.getContent() functions for that * - * @param path The path of the file relative to the server root + * @param {string} path The path of the file relative to the server root + * @return {File} */ getFile(path: string): File; @@ -576,404 +890,119 @@ declare class Server extends EventEmitter { * * Use this.STATUS. for status codes * - * @param status + * @param {int|int[]} status */ hasStatus(status: number | number[]): boolean; /** * Get a websocket client for this server + * + * @return {WebsocketClient} */ getWebsocketClient(): WebsocketClient; /** * Subscribe to one or multiple streams * - * @param streams + * @return {boolean} + * @param {string[]|string} [streams] */ subscribe(streams?: SubscriptionType[] | SubscriptionType): boolean; /** * Unsubscribe from one, multiple or all streams * - * @param streams + * @param {string[]|string} [streams] */ unsubscribe(streams?: SubscriptionType[] | SubscriptionType): boolean; /** * Map raw object to this instance * - * @param server + * @param {Record} server + * @return {this} */ - setFromObject(server: object): Server; + setFromObject(server: Record): Server; /** * Only return intended public fields for JSON serialization * * Otherwise, fields inherited from EventEmitter would be serialized as well + * + * @returns {Record} */ - toJSON(): Server; + toJSON(): Record; + + on( + stream: StreamType, + listener: (...args: StreamTypes[StreamType]) => void, + ): this; } declare class Software { - /** - * Software ID - */ readonly id: string; - /** - * Software name - */ readonly name: string; - /** - * Software version - */ readonly version: string; - /** - * Software constructor - * - * @param softwareObject - */ constructor(softwareObject: Software); } // Internal types -declare enum ResponseType { - Text = "text", - JSON = "json", - Buffer = "buffer", -} declare class Account { - private readonly client: Client; + #client: Client; - /** - * Username - */ readonly name: string; - /** - * Email address - */ readonly email: string; - /** - * Email address verification - */ readonly verified: boolean; - /** - * The amount of credits currently available - */ readonly credits: number; - /** - * Account constructor - * - * @param client - */ constructor(client: Client); - /** - * Get/update the account info - * - * @throws {RequestError} - */ get(): Promise; - /** - * Map raw objects to this instance - * - * @param account - */ setFromObject(account: object): Account; } -declare class RequestError extends Error { - readonly statusCode: number; - readonly response: Response; - - /** - * Set error and status code from response object - * - * Returns if an error message was found - * - * @param response - */ - setErrorFromResponseBody(response: object): boolean; -} - -declare class RequestBodyError extends RequestError { - constructor(response: Response); -} - -declare class RequestStatusError extends RequestError { - constructor(error: RequestError); -} - -type Method = "GET" | "POST" | "PUT" | "DELETE"; - -declare class FileRequest extends ServerRequest { - /** - * FileRequest constructor - */ - constructor(id: string, path: string); - - /** - * Set the path parameter and url encode all characters except slashes - */ - setPath(path: string): FileRequest; -} - -declare class FileDataRequest extends FileRequest { - endpoint: string; -} - -declare class PutFileDataRequest extends FileDataRequest { - method: Method; -} - -declare class CreateDirectoryRequest extends PutFileDataRequest { - headers: object; -} - -declare class DeleteFileDataRequest extends FileDataRequest { - method: Method; -} - -declare class GetFileDataRequest extends FileDataRequest { - responseType: ResponseType.Text; -} - -declare class GetFileInformationRequest extends FileRequest { - endpoint: string; -} - -declare class GetServersRequest extends Request { - readonly endpoint: string; - readonly responseClass: ServersResponse; -} - -declare class ServerRequest extends Request { - /** - * Server request constructor - * - * @param id - */ - constructor(id: string); -} - -declare class ExecuteServerCommandRequest extends ServerRequest { - readonly endpoint: string; - readonly method: "POST"; - - /** - * Server request constructor - * - * @param id - * @param command - */ - constructor(id: string, command: string); -} - -declare class GetServerLogsRequest extends ServerRequest { - readonly endpoint: string; -} - -declare class GetServerOptionRequest extends ServerRequest { - readonly endpoint: string; - - /** - * GetServerOptionRequest constructor - * - * @param id - * @param option - */ - constructor(id: string, option: string); - - /** - * Set the option name - * - * @param option - */ - setOption(option: string): void; -} - -declare class GetServerRequest extends ServerRequest { - readonly endpoint: string; -} - -declare class RestartServerRequest extends ServerRequest { - readonly endpoint: string; -} - -declare class SetServerOptionRequest extends GetServerOptionRequest { - readonly method: "POST"; - - /** - * SetServerOptionRequest constructor - * - * @param id - * @param option - * @param value - */ - constructor(id: string, option: "ram" | "motd", value: string); -} - -declare class ShareServerLogsRequest extends ServerRequest { - readonly endpoint: string; -} - -declare class StartServerRequest extends ServerRequest { - readonly endpoint: string; -} - -declare class StopServerRequest extends ServerRequest { - readonly endpoint: string; -} - -declare class PlayerListRequest extends ServerRequest { - readonly endpoint: string; - constructor(id: string, name: string); -} - -declare class DeletePlayerListEntriesRequest extends PlayerListRequest { - readonly method: "DELETE"; - constructor(id: string, name: string, entries: string); -} - -declare class GetPlayerListEntriesRequest extends PlayerListRequest {} - -declare class GetPlayerListRequest extends ServerRequest { - readonly endpoint: string; - readonly responseClass: PlayerListResponse; -} - -declare class PutPlayerListEntriesRequest extends PlayerListRequest { - readonly method: "PUT"; - constructor(id: string, name: string, entries: string); -} - -declare class GetAccountRequest extends Request { - readonly endpoint: string; -} - -declare class PlayerListResponse extends Response { - lists: PlayerList[]; - - /** - * @inheritdoc - */ - setBody(body: object): void; - - /** - * @inheritdoc - */ - getData(): PlayerList[]; -} - -declare class ServersResponse extends Response { - servers: Server[]; - - /** - * @inheritdoc - */ - setBody(body: object): void; - - /** - * @inheritdoc - */ - getData(): Server[]; -} - -type PlayerListTypes = "whitelist" | "ops" | "banned-ips" | "banned-players"; +type PlayerListType = "whitelist" | "ops" | "banned-ips" | "banned-players"; declare class PlayerList { - /** - * List name / identifier - */ name: string; private server: Server; private client: Client; - /** - * @param name - */ constructor(name: string); - /** - * Set the server for this list - * - * @param server - */ setServer(server: Server): PlayerList; - /** - * Set the API client - * - * @param client - */ setClient(client: Client): PlayerList; - /** - * Get the list name - */ getName(): string; getEntries(): Promise; - /** - * Add multiple entries - * - * @param entries - */ addEntries(entries: string[]): Promise; - /** - * Add a single entry - * - * @param entry - */ addEntry(entry: string): Promise; - /** - * Delete multiple entries - * - * @param entries - */ deleteEntries(entries: string[]): Promise; - /** - * Delete a single entry - * - * @param entry - */ deleteEntry(entry: string): Promise; } declare class Players { - /** - * Max amount of players / slots - */ max: number; - /** - * Current amount of players - */ count: number; - /** - * List of player names - */ list: string[]; - /** - * Players constructor - * - * @param playersObject - */ constructor(playersObject: Players); } @@ -981,27 +1010,14 @@ type Message = "started" | "stopped"; type StreamStatus = 1 | 2 | 3 | 4; -/** - * @classdesc Websocket client to connect to the websocket for this server - */ declare class WebsocketClient extends EventEmitter { - readonly protocol: "wss" | "ws"; + readonly protocol: string; private client: Client; private server: Server; private websocket: WebSocket; - /** - * Automatically reconnect in cas of a disconnect - */ autoReconnect: boolean; - /** - * Time to wait to reconnect - * - * Only change this with caution. A time too low here can - * cause a spam in requests which can get your application - * rate limited or even blocked. - */ reconnectTimeout: 3000 | number; private reconnectInterval; @@ -1018,19 +1034,10 @@ declare class WebsocketClient extends EventEmitter { tick: TickStream; }; - /** - * @param server - */ constructor(server: Server); - /** - * Connect to websocket - */ connect(): void; - /** - * Disconnect from the websocket and all streams - */ disconnect(): void; onOpen(): void; @@ -1049,11 +1056,6 @@ declare class WebsocketClient extends EventEmitter { getServerStatus(): Promise; - /** - * Get a stream by name - * - * @param stream - */ getStreams(stream: string): boolean | Stream; hasStream(stream: string): boolean; @@ -1062,11 +1064,6 @@ declare class WebsocketClient extends EventEmitter { removeStreams(stream: string): void; - /** - * @param stream - * @param type - * @param data - */ send(stream: string, type: string, data: string): boolean; } @@ -1078,60 +1075,28 @@ declare class Stream extends EventEmitter { readonly startData: object | string; readonly startStatuses: StreamStatus[]; - /** - * @param client - */ constructor(client: WebsocketClient); send(type: SubscriptionType, data: any): boolean; - /** - * Status change event - */ onStatusChange(): boolean; - /** - * Message event listener - * - * @param message - */ onMessage(message: Message): void; onDataMessage(type: string, message: any): void; onDisconnect(): void; - /** - * Double event emitter for generic or specific event handling - * - * @param type - * @param data - */ emitEvent(type: string, data: object[]): void; - /** - * Start this stream - */ start(data?: any): void; - /** - * Should/can this stream be started - */ shouldBeStarted(): Promise; - /** - * Try to start if possible - */ tryToStart(): Promise; - /** - * Stop this stream - */ stop(): void; - /** - * Try to stop this stream if possible - */ tryToStop(): Promise; isStarted(): boolean; @@ -1140,25 +1105,30 @@ declare class Stream extends EventEmitter { type SubscriptionType = "tick" | "heap" | "stats" | "console"; type TickDataType = "start" | "stop" | "started" | "tick"; + declare class TickStream extends Stream { readonly name: string; - startStatuses: [1]; + startStatuses: StreamStatus[]; + onDataMessage(type: TickDataType, message: string): void; } type StatsDataType = "start" | "stop" | "started" | "stats"; + declare class StatsStream extends Stream { readonly name: string; - startStatuses: [1]; + startStatuses: StreamStatus[]; } type HeapDataType = "start" | "stop" | "started" | "heap"; + declare class HeapStream extends Stream { readonly name: string; - startStatuses: [1]; + startStatuses: StreamStatus[]; } type ConsoleDataType = "start" | "stop" | "command" | "started" | "line"; + declare class ConsoleStream extends Stream { private ansiRegex: RegExpConstructor; readonly name: string; diff --git a/types/exaroton/package.json b/types/exaroton/package.json index c608d588dd8f9c..aa97cb7397cda7 100644 --- a/types/exaroton/package.json +++ b/types/exaroton/package.json @@ -1,14 +1,14 @@ { "private": true, "name": "@types/exaroton", - "version": "1.8.9999", + "version": "1.11.9999", "projects": [ "https://github.com/exaroton/node-exaroton-api" ], "dependencies": { "@types/node": "*", "@types/ws": "*", - "form-data": "^3.0.1" + "got": "^11.8.2" }, "devDependencies": { "@types/exaroton": "workspace:." @@ -16,7 +16,7 @@ "owners": [ { "name": "Maximilian Hofmann", - "githubUsername": "hofmmaxi" + "githubUsername": "maxiicodes" } ] } diff --git a/types/exaroton/tsconfig.json b/types/exaroton/tsconfig.json index 55aba3b617dc9b..590a1433c4d02d 100644 --- a/types/exaroton/tsconfig.json +++ b/types/exaroton/tsconfig.json @@ -4,6 +4,7 @@ "lib": [ "es6" ], + "target": "ES6", "noImplicitAny": true, "noImplicitThis": true, "strictFunctionTypes": true, diff --git a/types/gapi.client.accesscontextmanager-v1beta/.npmignore b/types/ezuikit-js/.npmignore similarity index 100% rename from types/gapi.client.accesscontextmanager-v1beta/.npmignore rename to types/ezuikit-js/.npmignore diff --git a/types/ezuikit-js/ezuikit-js-tests.ts b/types/ezuikit-js/ezuikit-js-tests.ts new file mode 100644 index 00000000000000..1dd0839bae5fcd --- /dev/null +++ b/types/ezuikit-js/ezuikit-js-tests.ts @@ -0,0 +1,40 @@ +import EZUIKit from "ezuikit-js"; + +var player = new EZUIKit.EZUIKitPlayer({ + id: "video-container", // 视频容器ID + accessToken: "at.3bvmj4ycamlgdwgw1ig1jruma0wpohl6-48zifyb39c-13t5am6-yukyi86mz", + url: "ezopen://open.ys7.com/G39444019/1.live", + width: 600, + height: 400, + handleError: (err) => { + if (err.type === "handleRunTimeInfoError" && err.data.nErrorCode === 5) { + // 加密设备密码错误 + } + }, +}); + +// 执行播放 +player.play(); + +// or +player.play().then(() => {}); + +// 关闭播放 +player.stop(); + +// or +player.stop().then(() => {}); + +player.stopTalk(); + +player.capturePicture("file-1"); + +player.capturePicture("file-1", args => {}); + +player.getOSDTime(); + +player.changePlayUrl({ + type: "rec", + deviceSerial: "foobarvz", + channelNo: 1, +}); diff --git a/types/ezuikit-js/index.d.ts b/types/ezuikit-js/index.d.ts new file mode 100644 index 00000000000000..b63cc0d6ddb90f --- /dev/null +++ b/types/ezuikit-js/index.d.ts @@ -0,0 +1,217 @@ +declare namespace EZUIKit { + interface EZUIKitPlayerOptions { + /** + * @description 播放器容器 DOM 的 id + */ + id: string; + /** + * @description 授权过程获取的 access_token + */ + accessToken: string; + /** + * @description 视频 ezopen 协议播放地址 + * @example + * { url: "ezopen://open.ys7.com/${设备序列号}/{通道号}.live" } + * @example + * { url: "ezopen://open.ys7.com/${设备序列号}/{通道号}.hd.live" } + * @example + * { url: "ezopen://open.ys7.com/${设备序列号}/{通道号}.rec?begin=yyyyMMddhhmmss" } + */ + url: string; + /** + * @description 是否默认开启声音 1：打开（默认） 0：关闭 + * @default 1 + */ + audio?: number; + /** + * @description 视频宽度，默认值为容器容器 DOM 宽度 + */ + width?: number; + /** + * @description 视频高度，默认值为容器容器 DOM 高度 + */ + height?: number; + /** + * @description 设置静态资源地址, 自定义可以自行下载 `ezuikit_static`放置在自己的服务器下， 设置 {staticPath: "/ezuikit_static"} + */ + staticPath?: string; + /** + * @description 播放器模板，可以通过选定模板，使用内置的播放器样式，组件 simple：极简版;standard：标准版;security：安防版;vioce：语音版 + */ + template?: string; + /** + * @description themeData 将主题数据本地化，设置本地数据，需要删除 `template` 参数 + * 你可以通过 themeData 修改按钮位置，颜色，头部底部颜色等配置。 + */ + themeData?: Record; + /** + * @description 视频头部可选UI组件，可选值：capturePicture：截图,save：录像保存,zoom：电子放大 + */ + header?: Array<"capturePicture" | "save" | "zoom">; + /** + * @description 视频底部部可选UI组件，可选值：talk：对讲,broadcast：语音播报,hd：高清标清切换,fullScreen：全屏 + */ + footer?: Array<"talk" | "broadcast" | "hd" | "fullScreen">; + /** + * @description 按需加载插件，可选值： talk：对讲 + */ + plugin?: string[]; + /** + * @description 播放成功回调 + */ + handleSuccess?: (...args: any[]) => void; + /** + * @description 播放错误回调 + */ + handleError?: (...args: any[]) => void; + /** + * @description 为避免频繁拖动播放异常，可设置模板回放时间轴拖动防抖间隔，默认值为2000（2秒），可取2000（2秒），3000（3秒），4000（4秒），5000（5秒） + */ + seekFrequency?: () => number; + } + + class EZUIKitPlayer { + constructor(options: EZUIKit.EZUIKitPlayerOptions); + + /** + * @description 开启播放 + * @example + * // 方式一 + * player.play(); + * // 方式二 + * player.play().then(()=>{ console.log("执行播放成功后其他动作");}); + */ + play(): Promise; + + /** + * @description 结束播放 + * @example + * // 方式一 + * player.stop(); + * // 方式二 + * player.stop().then(()=>{ console.log("执行停止成功后其他动作");}); + */ + stop(): Promise; + + /** + * @description 暂停播放 + */ + pause(): Promise; + + /** + * @description 开启声音 + */ + openSound(): Promise; + + /** + * @description 关闭声音 + */ + closeSound(): Promise; + + /** + * @description 开始录像 + */ + startSave(): Promise; + + /** + * @description 结束录像 + */ + stopSave(): Promise; + + /** + * @description 视频截图 + * @example + * // 方式1 - 下载到本地 + player.capturePicture("文件名"); + // 方式2 - 返回base64格式 + const capCallback = (data) => { + console.log("data",data) + } + player.capturePicture('default',capCallback) + */ + capturePicture(filename: string, fn?: (data: any) => void): void; + + /** + * 全屏（自动适配移动端和PC端全屏） + */ + fullScreen(): void; + + /** + * @description 取消全屏 + */ + cancelFullScreen(): void; + + /** + * @description 获取播放时间回调 + * @example + * player.getOSDTime() + .then((time) => { console.log("获取到的当前播放时间", time)}); + */ + getOSDTime(): Promise<{ code: number; data: number; retCode: number }>; + + /** + * @description 开始对讲 + */ + startTalk(): void; + + /** + * @description 结束对讲 + */ + stopTalk(): void; + + /** + * @description 重置画面宽高 + */ + reSize(width: number, height: number): void; + + /** + * @description 开启电子放大 + */ + enableZoom(): Promise; + + /** + * @description 关闭电子放大 + */ + closeZoom(): Promise; + + /** + * @description 切换地址播放 + */ + changePlayUrl(opts: { + /** + * 播放地址类型，"live":预览，"rec"：回放；“cloud.rec”：云存储回放 + */ + type: "live" | "rec" | "cloud.rec"; + /** + * 设备序列号,存在英文字母的设备序列号，字母需为大写 + */ + deviceSerial: string; + /** + * 通道号 + */ + channelNo: number; + /** + * 授权过程获取的access_token + */ + accessToken?: string; + /** + * 是否为高清 true-主码流（高清） false-子码流(标清) + */ + hd?: boolean; + /** + * 设备验证码（加密设备播放需要输入验证码） + */ + validCode?: string; + /** + * type类型为回放有效，开始时间 格式为“YYYYMMDDHHmmss” + */ + begin?: string; + /** + * type类型为回放有效，结束时间 格式为 “YYYYMMDDHHmmss” + */ + end?: string; + }): Promise; + } +} + +export default EZUIKit; diff --git a/types/ezuikit-js/package.json b/types/ezuikit-js/package.json new file mode 100644 index 00000000000000..38097992101c57 --- /dev/null +++ b/types/ezuikit-js/package.json @@ -0,0 +1,17 @@ +{ + "private": true, + "name": "@types/ezuikit-js", + "version": "8.0.9999", + "projects": [ + "https://github.com/Hikvision-Ezviz/EZUIKit-JavaScript-npm#readme" + ], + "devDependencies": { + "@types/ezuikit-js": "workspace:." + }, + "owners": [ + { + "name": "daiwanxing", + "githubUsername": "daiwanxing" + } + ] +} diff --git a/types/ezuikit-js/tsconfig.json b/types/ezuikit-js/tsconfig.json new file mode 100644 index 00000000000000..accc6ec2e5f9da --- /dev/null +++ b/types/ezuikit-js/tsconfig.json @@ -0,0 +1,19 @@ +{ + "compilerOptions": { + "module": "Node16", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictFunctionTypes": true, + "strictNullChecks": true, + "forceConsistentCasingInFileNames": true, + "types": [], + "noEmit": true + }, + "files": [ + "index.d.ts", + "ezuikit-js-tests.ts" + ] +} diff --git a/types/fabric/fabric-impl.d.ts b/types/fabric/fabric-impl.d.ts index 37a9bb815d3b28..8be45d49ab337d 100644 --- a/types/fabric/fabric-impl.d.ts +++ b/types/fabric/fabric-impl.d.ts @@ -1219,6 +1219,10 @@ interface IStaticCanvasOptions { * a zoomed canvas will then produce zoomed SVG output. */ svgViewportTransformation?: boolean | undefined; + /** + * When the option is enabled, PointerEvent is used instead of MouseEvent. + */ + enablePointerEvents?: boolean | undefined; } export interface StaticCanvas 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 2745031b0af37c..798f95df4ead3a 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 @@ -7,7 +7,15 @@ import { ServerEvent, UserData, IGUser, - InstagramInsightsResult + InstagramInsightsResult, + AppData, + ExtendedDeviceInfo, + AbstractCrudObject, + AdSet, + Campaign, + AdsPixel, + AdCreative, + Ad } 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"; @@ -18,8 +26,8 @@ async function testGetAdsFetchFirstPageFalse(): Promise 0.5; const cursorOrPromise = fbAdAccount.getAds(['id', 'name'], { limit: 10 }, fetchFirstPage); const cursor = cursorOrPromise instanceof Promise ? await cursorOrPromise : cursorOrPromise; @@ -97,7 +105,7 @@ async function testGetAdsFetchFirstPageBoolean(): Promise { @@ -105,11 +113,12 @@ async function testConversionEvent(): Promise { .setEmails(['joe@eg.com']) .setPhones(['12345678901', '14251234567']); - const content = (new Content()) - .setId('product123'); + const content = new Content(); const customData = (new CustomData()) .setContents([content]); + const extendedDeviceInfo = new ExtendedDeviceInfo(); + const appData = new AppData(); const serverEvent = (new ServerEvent()) .setEventName('Purchase') @@ -129,3 +138,17 @@ async function checkStaticFields() { const fields = [IGUser.Fields.biography, IGUser.Fields.follows_count]; const metrics = [InstagramInsightsResult.Metric.reach, InstagramInsightsResult.Metric.shares]; } + +export function testAbstractCrudObjectClassConstructor () { + const abstractCrudObject = new AbstractCrudObject(); + const abstractCrudObject2 = new AbstractCrudObject('some-id'); +} + +export function testDeleteFunctionInAbstractCrudObjects(){ + const deleteAdSetFunction = new AdSet().delete; + const deleteCampaignFunction = new Campaign().delete; + const deleteAdAccountFunction = new AdAccount().delete; + const deletePixelFunction = new AdsPixel().delete; + const deleteAdCreativeFunction = new AdCreative().delete; + const deleteAdFunction = new Ad().delete; +} diff --git a/types/facebook-nodejs-business-sdk/index.d.ts b/types/facebook-nodejs-business-sdk/index.d.ts index b1febe79e4955c..08c1ecb1534c5e 100644 --- a/types/facebook-nodejs-business-sdk/index.d.ts +++ b/types/facebook-nodejs-business-sdk/index.d.ts @@ -1,504 +1,953 @@ -export { default as FacebookAdsApi } from './src/api'; -export { default as FacebookAdsApiBatch } from './src/api-batch'; -export { default as AbstractCrudObject } from './src/abstract-crud-object'; -export { default as APIRequest } from './src/api-request'; -export { default as APIResponse } from './src/api-response'; -export { default as CrashReporter } from './src/crash-reporter'; -export { default as Content } from './src/objects/serverside/content'; -export { default as CustomData } from './src/objects/serverside/custom-data'; -export { default as EventRequest } from './src/objects/serverside/event-request'; -export { default as EventResponse } from './src/objects/serverside/event-response'; -export { default as ServerEvent } from './src/objects/serverside/server-event'; -export { default as UserData } from './src/objects/serverside/user-data'; -export { default as ExtendedDeviceInfo } from './src/objects/serverside/extended-device-info'; -export { default as AppData } from './src/objects/serverside/app-data'; -export { default as DeliveryCategory } from './src/objects/serverside/delivery-category'; -export { default as HttpMethod } from './src/objects/serverside/http-method'; -export { default as HttpServiceClientConfig } from './src/objects/serverside/http-service-client-config'; -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 Ad } from './src/objects/ad'; -export { default as AdAccount } 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 AdAccountBusinessConstraints } from './src/objects/ad-account-business-constraints'; -export { default as AdAccountDefaultDestination } from './src/objects/ad-account-default-destination'; -export { default as AdAccountDefaultObjective } from './src/objects/ad-account-default-objective'; -export { default as AdAccountDeliveryEstimate } from './src/objects/ad-account-delivery-estimate'; -export { default as AdAccountDsaRecommendations } from './src/objects/ad-account-dsa-recommendations'; -export { default as AdAccountIosFourteenCampaignLimits } from './src/objects/ad-account-ios-fourteen-campaign-limits'; -export { default as AdAccountMatchedSearchApplicationsEdgeData } from './src/objects/ad-account-matched-search-applications-edge-data'; -export { default as AdAccountMaxBid } from './src/objects/ad-account-max-bid'; -export { default as AdAccountPromotableObjects } from './src/objects/ad-account-promotable-objects'; -export { default as AdAccountReachEstimate } from './src/objects/ad-account-reach-estimate'; -export { default as AdAccountRecommendedCamapaignBudget } from './src/objects/ad-account-recommended-camapaign-budget'; -export { default as AdAccountSubscribedApps } from './src/objects/ad-account-subscribed-apps'; -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 AdAccountUser } from './src/objects/ad-account-user'; -export { default as AdActivity } from './src/objects/ad-activity'; -export { default as AdAssetCustomizationRuleCustomizationSpec } from './src/objects/ad-asset-customization-rule-customization-spec'; -export { default as AdAssetFeedSpec } from './src/objects/ad-asset-feed-spec'; -export { default as AdAssetFeedSpecAssetCustomizationRule } from './src/objects/ad-asset-feed-spec-asset-customization-rule'; -export { default as AdAssetFeedSpecAssetLabel } from './src/objects/ad-asset-feed-spec-asset-label'; -export { default as AdAssetFeedSpecBody } from './src/objects/ad-asset-feed-spec-body'; -export { default as AdAssetFeedSpecCaption } from './src/objects/ad-asset-feed-spec-caption'; -export { default as AdAssetFeedSpecDescription } from './src/objects/ad-asset-feed-spec-description'; -export { default as AdAssetFeedSpecGroupRule } from './src/objects/ad-asset-feed-spec-group-rule'; -export { default as AdAssetFeedSpecImage } from './src/objects/ad-asset-feed-spec-image'; -export { default as AdAssetFeedSpecLinkURL } from './src/objects/ad-asset-feed-spec-link-url'; -export { default as AdAssetFeedSpecTitle } from './src/objects/ad-asset-feed-spec-title'; -export { default as AdAssetFeedSpecVideo } from './src/objects/ad-asset-feed-spec-video'; -export { default as AdAssetMessageExtensions } from './src/objects/ad-asset-message-extensions'; -export { default as AdAssetTargetRuleTargeting } from './src/objects/ad-asset-target-rule-targeting'; -export { default as AdAsyncRequest } from './src/objects/ad-async-request'; -export { default as AdAsyncRequestSet } from './src/objects/ad-async-request-set'; -export { default as AdAsyncRequestSetNotificationResult } from './src/objects/ad-async-request-set-notification-result'; -export { default as AdBidAdjustments } from './src/objects/ad-bid-adjustments'; -export { default as AdCampaignBidConstraint } from './src/objects/ad-campaign-bid-constraint'; -export { default as AdCampaignDeliveryEstimate } from './src/objects/ad-campaign-delivery-estimate'; -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 AdCampaignIssuesInfo } from './src/objects/ad-campaign-issues-info'; -export { default as AdCampaignLearningStageInfo } from './src/objects/ad-campaign-learning-stage-info'; -export { default as AdCampaignOptimizationEvent } from './src/objects/ad-campaign-optimization-event'; -export { default as AdCampaignPacedBidInfo } from './src/objects/ad-campaign-paced-bid-info'; -export { default as AdCreative } from './src/objects/ad-creative'; -export { default as AdCreativeAdDisclaimer } from './src/objects/ad-creative-ad-disclaimer'; -export { default as AdCreativeBrandedContentAds } from './src/objects/ad-creative-branded-content-ads'; -export { default as AdCreativeCollectionThumbnailInfo } from './src/objects/ad-creative-collection-thumbnail-info'; -export { default as AdCreativeDegreesOfFreedomSpec } from './src/objects/ad-creative-degrees-of-freedom-spec'; -export { default as AdCreativeFacebookBrandedContent } from './src/objects/ad-creative-facebook-branded-content'; -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 AdCreativeInsights } from './src/objects/ad-creative-insights'; -export { default as AdCreativeInstagramBrandedContent } from './src/objects/ad-creative-instagram-branded-content'; -export { default as AdCreativeInteractiveComponentsSpec } from './src/objects/ad-creative-interactive-components-spec'; -export { default as AdCreativeLinkData } from './src/objects/ad-creative-link-data'; -export { default as AdCreativeLinkDataAppLinkSpec } from './src/objects/ad-creative-link-data-app-link-spec'; -export { default as AdCreativeLinkDataCallToAction } from './src/objects/ad-creative-link-data-call-to-action'; -export { default as AdCreativeLinkDataCallToActionValue } from './src/objects/ad-creative-link-data-call-to-action-value'; -export { default as AdCreativeLinkDataChildAttachment } from './src/objects/ad-creative-link-data-child-attachment'; -export { default as AdCreativeLinkDataImageLayerSpec } from './src/objects/ad-creative-link-data-image-layer-spec'; -export { default as AdCreativeLinkDataImageOverlaySpec } from './src/objects/ad-creative-link-data-image-overlay-spec'; -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 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'; -export { default as AdCreativePhotoDataMediaElements } from './src/objects/ad-creative-photo-data-media-elements'; -export { default as AdCreativePlaceData } from './src/objects/ad-creative-place-data'; -export { default as AdCreativePlatformCustomization } from './src/objects/ad-creative-platform-customization'; -export { default as AdCreativePortraitCustomizations } from './src/objects/ad-creative-portrait-customizations'; -export { default as AdCreativePostClickConfiguration } from './src/objects/ad-creative-post-click-configuration'; -export { default as AdCreativeRecommenderSettings } from './src/objects/ad-creative-recommender-settings'; -export { default as AdCreativeSourcingSpec } from './src/objects/ad-creative-sourcing-spec'; -export { default as AdCreativeStaticFallbackSpec } from './src/objects/ad-creative-static-fallback-spec'; -export { default as AdCreativeTemplateURLSpec } from './src/objects/ad-creative-template-url-spec'; -export { default as AdCreativeTextData } from './src/objects/ad-creative-text-data'; -export { default as AdCreativeVideoData } from './src/objects/ad-creative-video-data'; -export { default as AdCustomizationRuleSpec } from './src/objects/ad-customization-rule-spec'; -export { default as AdDynamicCreative } from './src/objects/ad-dynamic-creative'; -export { default as AdEntityTargetSpend } from './src/objects/ad-entity-target-spend'; -export { default as AdImage } from './src/objects/ad-image'; -export { default as AdKeywords } from './src/objects/ad-keywords'; -export { default as AdLabel } from './src/objects/ad-label'; -export { default as AdMonetizationProperty } from './src/objects/ad-monetization-property'; -export { default as AdNetworkAnalyticsAsyncQueryResult } from './src/objects/ad-network-analytics-async-query-result'; -export { default as AdNetworkAnalyticsSyncQueryResult } from './src/objects/ad-network-analytics-sync-query-result'; -export { default as AdPlacePageSet } from './src/objects/ad-place-page-set'; -export { default as AdPlacePageSetMetadata } from './src/objects/ad-place-page-set-metadata'; -export { default as AdPlacement } from './src/objects/ad-placement'; -export { default as AdPreview } from './src/objects/ad-preview'; -export { default as AdPromotedObject } from './src/objects/ad-promoted-object'; -export { default as AdRecommendation } from './src/objects/ad-recommendation'; -export { default as AdRecommendationData } from './src/objects/ad-recommendation-data'; -export { default as AdReportRun } from './src/objects/ad-report-run'; -export { default as AdRule } from './src/objects/ad-rule'; -export { default as AdRuleEvaluationSpec } from './src/objects/ad-rule-evaluation-spec'; -export { default as AdRuleExecutionOptions } from './src/objects/ad-rule-execution-options'; -export { default as AdRuleExecutionSpec } from './src/objects/ad-rule-execution-spec'; -export { default as AdRuleFilters } from './src/objects/ad-rule-filters'; -export { default as AdRuleHistory } from './src/objects/ad-rule-history'; -export { default as AdRuleHistoryResult } from './src/objects/ad-rule-history-result'; -export { default as AdRuleHistoryResultAction } from './src/objects/ad-rule-history-result-action'; -export { default as AdRuleSchedule } from './src/objects/ad-rule-schedule'; -export { default as AdRuleScheduleSpec } from './src/objects/ad-rule-schedule-spec'; -export { default as AdRuleTrigger } from './src/objects/ad-rule-trigger'; -export { default as AdSet } from './src/objects/ad-set'; -export { default as AdStudy } from './src/objects/ad-study'; -export { default as AdStudyCell } from './src/objects/ad-study-cell'; -export { default as AdStudyObjective } from './src/objects/ad-study-objective'; -export { default as AdStudyObjectiveID } from './src/objects/ad-study-objective-id'; -export { default as AdStudyObjectiveOffsiteDatasets } from './src/objects/ad-study-objective-offsite-datasets'; -export { default as AdVideo } from './src/objects/ad-video'; -export { default as AdgroupIssuesInfo } from './src/objects/adgroup-issues-info'; -export { default as AdgroupMetadata } from './src/objects/adgroup-metadata'; -export { default as AdgroupPlacementSpecificReviewFeedback } from './src/objects/adgroup-placement-specific-review-feedback'; -export { default as AdgroupReviewFeedback } from './src/objects/adgroup-review-feedback'; -export { default as AdsActionStats } from './src/objects/ads-action-stats'; -export { default as AdsHistogramStats } from './src/objects/ads-histogram-stats'; -export { default as AdsImageCrops } from './src/objects/ads-image-crops'; -export { default as AdsInsights } from './src/objects/ads-insights'; -export { default as AdsOptimalDeliveryGrowthOpportunity } from './src/objects/ads-optimal-delivery-growth-opportunity'; -export { default as AdsPixel } from './src/objects/ads-pixel'; -export { default as AdsPixelStats } from './src/objects/ads-pixel-stats'; -export { default as AdsPixelStatsResult } from './src/objects/ads-pixel-stats-result'; -export { default as AgeRange } from './src/objects/age-range'; -export { default as AgencyClientDeclaration } from './src/objects/agency-client-declaration'; -export { default as Album } from './src/objects/album'; -export { default as AndroidAppLink } from './src/objects/android-app-link'; -export { default as AppRequest } from './src/objects/app-request'; -export { default as AppRequestFormerRecipient } from './src/objects/app-request-former-recipient'; -export { default as Application } from './src/objects/application'; -export { default as AssignedUser } from './src/objects/assigned-user'; -export { default as AsyncRequest } from './src/objects/async-request'; -export { default as AsyncSession } from './src/objects/async-session'; -export { default as AttributionSpec } from './src/objects/attribution-spec'; -export { default as AudiencePermissionForActions } from './src/objects/audience-permission-for-actions'; -export { default as AudioCopyright } from './src/objects/audio-copyright'; -export { default as AutomotiveModel } from './src/objects/automotive-model'; -export { default as Avatar } from './src/objects/avatar'; -export { default as AvatarProfilePicture } from './src/objects/avatar-profile-picture'; -export { default as BrandRequest } from './src/objects/brand-request'; -export { default as BrandSafetyBlockListUsage } from './src/objects/brand-safety-block-list-usage'; -export { default as BroadTargetingCategories } from './src/objects/broad-targeting-categories'; -export { default as Business } from './src/objects/business'; -export { default as BusinessAdAccountRequest } from './src/objects/business-ad-account-request'; -export { default as BusinessApplicationRequest } from './src/objects/business-application-request'; -export { default as BusinessAssetGroup } from './src/objects/business-asset-group'; -export { default as BusinessAssetSharingAgreement } from './src/objects/business-asset-sharing-agreement'; -export { default as BusinessCreativeFolder } from './src/objects/business-creative-folder'; -export { default as BusinessImage } from './src/objects/business-image'; -export { default as BusinessManagedPartnerEligibility } from './src/objects/business-managed-partner-eligibility'; -export { default as BusinessOwnedObjectOnBehalfOfRequest } from './src/objects/business-owned-object-on-behalf-of-request'; -export { default as BusinessPageRequest } from './src/objects/business-page-request'; -export { default as BusinessPartnerPremiumOptions } from './src/objects/business-partner-premium-options'; -export { default as BusinessRoleRequest } from './src/objects/business-role-request'; -export { default as BusinessUser } from './src/objects/business-user'; -export { default as BusinessVideo } from './src/objects/business-video'; -export { default as CPASAdvertiserPartnershipRecommendation } from './src/objects/cpas-advertiser-partnership-recommendation'; -export { default as CPASBusinessSetupConfig } from './src/objects/cpas-business-setup-config'; -export { default as CPASCollaborationRequest } from './src/objects/cpas-collaboration-request'; -export { default as CPASMerchantConfig } from './src/objects/cpas-merchant-config'; -export { default as CRMAddress } from './src/objects/crm-address'; -export { default as CTXPartnerAppWelcomeMessageFlow } from './src/objects/ctx-partner-app-welcome-message-flow'; -export { default as Campaign } from './src/objects/campaign'; -export { default as CampaignGroupBrandConfiguration } from './src/objects/campaign-group-brand-configuration'; -export { default as CampaignGroupCollaborativeAdsPartnerInfo } from './src/objects/campaign-group-collaborative-ads-partner-info'; -export { default as Canvas } from './src/objects/canvas'; -export { default as CanvasAdSettings } from './src/objects/canvas-ad-settings'; -export { default as CanvasBodyElement } from './src/objects/canvas-body-element'; -export { default as CanvasCollectionThumbnail } from './src/objects/canvas-collection-thumbnail'; -export { default as CanvasDynamicSetting } from './src/objects/canvas-dynamic-setting'; -export { default as CatalogBasedTargeting } from './src/objects/catalog-based-targeting'; -export { default as CatalogItemAppLinks } from './src/objects/catalog-item-app-links'; -export { default as CatalogItemAppealStatus } from './src/objects/catalog-item-appeal-status'; -export { default as CatalogItemChannelsToIntegrityStatus } from './src/objects/catalog-item-channels-to-integrity-status'; -export { default as CatalogSegmentAllMatchCountLaser } from './src/objects/catalog-segment-all-match-count-laser'; -export { default as CatalogSubVerticalList } from './src/objects/catalog-sub-vertical-list'; -export { default as ChatPlugin } from './src/objects/chat-plugin'; -export { default as CheckBatchRequestStatus } from './src/objects/check-batch-request-status'; -export { default as ChildEvent } from './src/objects/child-event'; -export { default as CloudGame } from './src/objects/cloud-game'; -export { default as CollaborativeAdsPartnerInfoListItem } from './src/objects/collaborative-ads-partner-info-list-item'; -export { default as CollaborativeAdsShareSettings } from './src/objects/collaborative-ads-share-settings'; -export { default as Comment } from './src/objects/comment'; -export { default as CommerceMerchantSettings } from './src/objects/commerce-merchant-settings'; -export { default as CommerceMerchantSettingsSetupStatus } from './src/objects/commerce-merchant-settings-setup-status'; -export { default as CommerceOrder } from './src/objects/commerce-order'; -export { default as CommerceOrderTransactionDetail } from './src/objects/commerce-order-transaction-detail'; -export { default as CommercePayout } from './src/objects/commerce-payout'; -export { default as CommerceSettings } from './src/objects/commerce-settings'; -export { default as ConnectionsTargeting } from './src/objects/connections-targeting'; -export { default as ContentPublishingLimitResponse } from './src/objects/content-publishing-limit-response'; -export { default as ContextualBundlingSpec } from './src/objects/contextual-bundling-spec'; -export { default as ConversionActionQuery } from './src/objects/conversion-action-query'; -export { default as CopyrightReferenceContainer } from './src/objects/copyright-reference-container'; -export { default as CoverPhoto } from './src/objects/cover-photo'; -export { default as CreativeHistory } from './src/objects/creative-history'; -export { default as CreditCard } from './src/objects/credit-card'; -export { default as CreditPartitionActionOptions } from './src/objects/credit-partition-action-options'; -export { default as Currency } from './src/objects/currency'; -export { default as CurrencyAmount } from './src/objects/currency-amount'; -export { default as CustomAudience } from './src/objects/custom-audience'; -export { default as CustomAudienceAdAccount } from './src/objects/custom-audience-ad-account'; -export { default as CustomAudienceDataSource } from './src/objects/custom-audience-data-source'; -export { default as CustomAudienceGroup } from './src/objects/custom-audience-group'; -export { default as CustomAudienceSession } from './src/objects/custom-audience-session'; -export { default as CustomAudienceSharingStatus } from './src/objects/custom-audience-sharing-status'; -export { default as CustomAudienceStatus } from './src/objects/custom-audience-status'; -export { default as CustomAudiencesTOS } from './src/objects/custom-audiences-tos'; -export { default as CustomAudiencesharedAccountInfo } from './src/objects/custom-audienceshared-account-info'; -export { default as CustomConversion } from './src/objects/custom-conversion'; -export { default as CustomConversionStatsResult } from './src/objects/custom-conversion-stats-result'; -export { default as CustomUserSettings } from './src/objects/custom-user-settings'; -export { default as DACheck } from './src/objects/da-check'; -export { default as Dataset } from './src/objects/dataset'; -export { default as DayPart } from './src/objects/day-part'; -export { default as DeliveryCheck } from './src/objects/delivery-check'; -export { default as DeliveryCheckExtraInfo } from './src/objects/delivery-check-extra-info'; -export { default as DeliveryWindow } from './src/objects/delivery-window'; -export { default as Destination } from './src/objects/destination'; -export { default as DestinationCatalogSettings } from './src/objects/destination-catalog-settings'; -export { default as DynamicPostChildAttachment } from './src/objects/dynamic-post-child-attachment'; -export { default as DynamicPriceConfigByDate } from './src/objects/dynamic-price-config-by-date'; -export { default as DynamicVideoMetadata } from './src/objects/dynamic-video-metadata'; -export { default as Engagement } from './src/objects/engagement'; -export { default as EntityAtTextRange } from './src/objects/entity-at-text-range'; -export { default as Event } from './src/objects/event'; -export { default as EventSourceGroup } from './src/objects/event-source-group'; -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'; -export { default as ExtendedCreditInvoiceGroup } from './src/objects/extended-credit-invoice-group'; -export { default as ExternalEventSource } from './src/objects/external-event-source'; -export { default as FAMEExportConfig } from './src/objects/fame-export-config'; -export { default as FlexibleTargeting } from './src/objects/flexible-targeting'; -export { default as Flight } from './src/objects/flight'; -export { default as FundingSourceDetails } from './src/objects/funding-source-details'; -export { default as FundingSourceDetailsCoupon } from './src/objects/funding-source-details-coupon'; -export { default as FundraiserPersonToCharity } from './src/objects/fundraiser-person-to-charity'; -export { default as GameItem } from './src/objects/game-item'; -export { default as Group } from './src/objects/group'; -export { default as HasLeadAccess } from './src/objects/has-lead-access'; -export { default as HighDemandPeriod } from './src/objects/high-demand-period'; -export { default as HighDemandPeriodTimeSuggestionWeeklySegment } from './src/objects/high-demand-period-time-suggestion-weekly-segment'; -export { default as HomeListing } from './src/objects/home-listing'; -export { default as Hotel } from './src/objects/hotel'; -export { default as HotelRoom } from './src/objects/hotel-room'; -export { default as IDName } from './src/objects/id-name'; -export { default as IGBCAdsPermission } from './src/objects/igbc-ads-permission'; -export { default as IGComment } from './src/objects/ig-comment'; -export { default as IGCommentFromUser } from './src/objects/ig-comment-from-user'; -export { default as IGMedia } from './src/objects/ig-media'; -export { default as IGShoppingProductAppeal } from './src/objects/ig-shopping-product-appeal'; -export { default as IGShoppingReviewStatus } from './src/objects/ig-shopping-review-status'; -export { default as IGShoppingReviewStatusOnsiteEligibility } from './src/objects/ig-shopping-review-status-onsite-eligibility'; -export { default as IGShoppingReviewStatusReasonWithHelpMessage } from './src/objects/ig-shopping-review-status-reason-with-help-message'; -export { default as IGUser } from './src/objects/ig-user'; -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'; -export { default as ImageCopyright } from './src/objects/image-copyright'; -export { default as InsightsResult } from './src/objects/insights-result'; -export { default as InstagramCarousel } from './src/objects/instagram-carousel'; -export { default as InstagramComment } from './src/objects/instagram-comment'; -export { default as InstagramInsightsResult } from './src/objects/instagram-insights-result'; -export { default as InstagramInsightsValue } from './src/objects/instagram-insights-value'; -export { default as InstagramMedia } from './src/objects/instagram-media'; -export { default as InstagramShoppingMerchantReviewMessage } from './src/objects/instagram-shopping-merchant-review-message'; -export { default as InstagramUser } from './src/objects/instagram-user'; -export { default as InstagramVideoMetadata } from './src/objects/instagram-video-metadata'; -export { default as InstantArticlesStats } from './src/objects/instant-articles-stats'; -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 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 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'; -export { default as LeadGenCustomDisclaimer } from './src/objects/lead-gen-custom-disclaimer'; -export { default as LeadGenCustomDisclaimerBody } from './src/objects/lead-gen-custom-disclaimer-body'; -export { default as LeadGenDraftQuestion } from './src/objects/lead-gen-draft-question'; -export { default as LeadGenLegalContent } from './src/objects/lead-gen-legal-content'; -export { default as LeadGenLegalContentCheckbox } from './src/objects/lead-gen-legal-content-checkbox'; -export { default as LeadGenPostSubmissionCheckResult } from './src/objects/lead-gen-post-submission-check-result'; -export { default as LeadGenPrivacyPolicy } from './src/objects/lead-gen-privacy-policy'; -export { default as LeadGenQuestion } from './src/objects/lead-gen-question'; -export { default as LeadGenQuestionOption } from './src/objects/lead-gen-question-option'; -export { default as LeadGenThankYouPage } from './src/objects/lead-gen-thank-you-page'; -export { default as LeadGenURLEntityAtRanges } from './src/objects/lead-gen-url-entity-at-ranges'; -export { default as LeadgenForm } from './src/objects/leadgen-form'; -export { default as LifeEvent } from './src/objects/life-event'; -export { default as Link } from './src/objects/link'; -export { default as LiveVideo } from './src/objects/live-video'; -export { default as LiveVideoAdBreakConfig } from './src/objects/live-video-ad-break-config'; -export { default as LiveVideoError } from './src/objects/live-video-error'; -export { default as LiveVideoInputStream } from './src/objects/live-video-input-stream'; -export { default as LiveVideoRecommendedEncoderSettings } from './src/objects/live-video-recommended-encoder-settings'; -export { default as LiveVideoTargeting } from './src/objects/live-video-targeting'; -export { default as LocalServiceBusiness } from './src/objects/local-service-business'; -export { default as Location } from './src/objects/location'; -export { default as LookalikeSpec } from './src/objects/lookalike-spec'; -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 MediaFingerprint } from './src/objects/media-fingerprint'; -export { default as MediaTitle } from './src/objects/media-title'; -export { default as MessagingFeatureReview } from './src/objects/messaging-feature-review'; -export { default as MessagingFeatureStatus } from './src/objects/messaging-feature-status'; -export { default as MessengerAdsPartialAutomatedStepList } from './src/objects/messenger-ads-partial-automated-step-list'; -export { default as MessengerProfile } from './src/objects/messenger-profile'; -export { default as MinimumBudget } from './src/objects/minimum-budget'; -export { default as MusicVideoCopyright } from './src/objects/music-video-copyright'; -export { default as NullNode } from './src/objects/null-node'; -export { default as OfflineConversionDataSet } from './src/objects/offline-conversion-data-set'; -export { default as OfflineConversionDataSetPermissions } from './src/objects/offline-conversion-data-set-permissions'; -export { default as OfflineConversionDataSetUpload } from './src/objects/offline-conversion-data-set-upload'; -export { default as OfflineConversionDataSetUsage } from './src/objects/offline-conversion-data-set-usage'; -export { default as OffsitePixel } from './src/objects/offsite-pixel'; -export { default as OmegaCustomerTrx } from './src/objects/omega-customer-trx'; -export { default as OpenBridgeConfiguration } from './src/objects/open-bridge-configuration'; -export { default as OpenGraphContext } from './src/objects/open-graph-context'; -export { default as OutcomePredictionPoint } from './src/objects/outcome-prediction-point'; -export { default as Page } from './src/objects/page'; -export { default as PageAboutStory } from './src/objects/page-about-story'; -export { default as PageAboutStoryComposedBlock } from './src/objects/page-about-story-composed-block'; -export { default as PageAboutStoryComposedBlockEntityRanges } from './src/objects/page-about-story-composed-block-entity-ranges'; -export { default as PageAboutStoryComposedBlockInlineStyle } from './src/objects/page-about-story-composed-block-inline-style'; -export { default as PageCallToAction } from './src/objects/page-call-to-action'; -export { default as PageCategory } from './src/objects/page-category'; -export { default as PageChangeProposal } from './src/objects/page-change-proposal'; -export { default as PageCommerceEligibility } from './src/objects/page-commerce-eligibility'; -export { default as PageParking } from './src/objects/page-parking'; -export { default as PagePaymentOptions } from './src/objects/page-payment-options'; -export { default as PagePost } from './src/objects/page-post'; -export { default as PagePostExperiment } from './src/objects/page-post-experiment'; -export { default as PageRestaurantServices } from './src/objects/page-restaurant-services'; -export { default as PageRestaurantSpecialties } from './src/objects/page-restaurant-specialties'; -export { default as PageSavedFilter } from './src/objects/page-saved-filter'; -export { default as PageSettings } from './src/objects/page-settings'; -export { default as PageStartInfo } from './src/objects/page-start-info'; -export { default as PageThreadOwner } from './src/objects/page-thread-owner'; -export { default as PageUpcomingChange } from './src/objects/page-upcoming-change'; -export { default as PageUserMessageThreadLabel } from './src/objects/page-user-message-thread-label'; -export { default as PartnerStudy } from './src/objects/partner-study'; -export { default as PaymentEnginePayment } from './src/objects/payment-engine-payment'; -export { default as PaymentPricepoints } from './src/objects/payment-pricepoints'; -export { default as PaymentSubscription } from './src/objects/payment-subscription'; -export { default as Permission } from './src/objects/permission'; -export { default as Persona } from './src/objects/persona'; -export { default as Photo } from './src/objects/photo'; -export { default as Place } from './src/objects/place'; -export { default as PlaceTopic } from './src/objects/place-topic'; -export { default as PlatformImageSource } from './src/objects/platform-image-source'; -export { default as PlayableContent } from './src/objects/playable-content'; -export { default as Post } from './src/objects/post'; -export { default as Privacy } from './src/objects/privacy'; -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 ProductCatalogDataSource } from './src/objects/product-catalog-data-source'; -export { default as ProductCatalogDiagnosticGroup } from './src/objects/product-catalog-diagnostic-group'; -export { default as ProductCatalogHotelRoomsBatch } from './src/objects/product-catalog-hotel-rooms-batch'; -export { default as ProductCatalogImageSettings } from './src/objects/product-catalog-image-settings'; -export { default as ProductCatalogImageSettingsOperation } from './src/objects/product-catalog-image-settings-operation'; -export { default as ProductCatalogPricingVariablesBatch } from './src/objects/product-catalog-pricing-variables-batch'; -export { default as ProductCatalogProductSetsBatch } from './src/objects/product-catalog-product-sets-batch'; -export { default as ProductEventStat } from './src/objects/product-event-stat'; -export { default as ProductFeed } from './src/objects/product-feed'; -export { default as ProductFeedMissingFeedItemReplacement } from './src/objects/product-feed-missing-feed-item-replacement'; -export { default as ProductFeedRule } from './src/objects/product-feed-rule'; -export { default as ProductFeedRuleSuggestion } from './src/objects/product-feed-rule-suggestion'; -export { default as ProductFeedSchedule } from './src/objects/product-feed-schedule'; -export { default as ProductFeedUpload } from './src/objects/product-feed-upload'; -export { default as ProductFeedUploadError } from './src/objects/product-feed-upload-error'; -export { default as ProductFeedUploadErrorReport } from './src/objects/product-feed-upload-error-report'; -export { default as ProductFeedUploadErrorSample } from './src/objects/product-feed-upload-error-sample'; -export { default as ProductGroup } from './src/objects/product-group'; -export { default as ProductImage } from './src/objects/product-image'; -export { default as ProductItem } from './src/objects/product-item'; -export { default as ProductItemCommerceInsights } from './src/objects/product-item-commerce-insights'; -export { default as ProductItemError } from './src/objects/product-item-error'; -export { default as ProductItemImporterAddress } from './src/objects/product-item-importer-address'; -export { default as ProductItemLocalInfo } from './src/objects/product-item-local-info'; -export { default as ProductItemLocalInfoLatLongShape } from './src/objects/product-item-local-info-lat-long-shape'; -export { default as ProductSet } from './src/objects/product-set'; -export { default as ProductSetMetadata } from './src/objects/product-set-metadata'; -export { default as ProductVariant } from './src/objects/product-variant'; -export { default as Profile } from './src/objects/profile'; -export { default as ProfilePictureSource } from './src/objects/profile-picture-source'; -export { default as PublisherBlockList } from './src/objects/publisher-block-list'; -export { default as RTBDynamicPost } from './src/objects/rtb-dynamic-post'; -export { default as RawCustomAudience } from './src/objects/raw-custom-audience'; -export { default as ReachFrequencyActivity } from './src/objects/reach-frequency-activity'; -export { default as ReachFrequencyAdFormat } from './src/objects/reach-frequency-ad-format'; -export { default as ReachFrequencyCurveLowerConfidenceRange } from './src/objects/reach-frequency-curve-lower-confidence-range'; -export { default as ReachFrequencyCurveUpperConfidenceRange } from './src/objects/reach-frequency-curve-upper-confidence-range'; -export { default as ReachFrequencyDayPart } from './src/objects/reach-frequency-day-part'; -export { default as ReachFrequencyEstimatesCurve } from './src/objects/reach-frequency-estimates-curve'; -export { default as ReachFrequencyEstimatesPlacementBreakdown } from './src/objects/reach-frequency-estimates-placement-breakdown'; -export { default as ReachFrequencyPrediction } from './src/objects/reach-frequency-prediction'; -export { default as ReachFrequencySpec } from './src/objects/reach-frequency-spec'; -export { default as Recommendation } from './src/objects/recommendation'; -export { default as RevSharePolicy } from './src/objects/rev-share-policy'; -export { default as RichMediaElement } from './src/objects/rich-media-element'; -export { default as SavedAudience } from './src/objects/saved-audience'; -export { default as SavedMessageResponse } from './src/objects/saved-message-response'; -export { default as SecuritySettings } from './src/objects/security-settings'; -export { default as ShadowIGHashtag } from './src/objects/shadow-ig-hashtag'; -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 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 Shop } from './src/objects/shop'; -export { default as SplitTestWinner } from './src/objects/split-test-winner'; -export { default as StoreCatalogSettings } from './src/objects/store-catalog-settings'; -export { default as Stories } from './src/objects/stories'; -export { default as SystemUser } from './src/objects/system-user'; -export { default as Tab } from './src/objects/tab'; -export { default as Targeting } from './src/objects/targeting'; -export { default as TargetingDynamicRule } from './src/objects/targeting-dynamic-rule'; -export { default as TargetingGeoLocation } from './src/objects/targeting-geo-location'; -export { default as TargetingGeoLocationCity } from './src/objects/targeting-geo-location-city'; -export { default as TargetingGeoLocationCustomLocation } from './src/objects/targeting-geo-location-custom-location'; -export { default as TargetingGeoLocationElectoralDistrict } from './src/objects/targeting-geo-location-electoral-district'; -export { default as TargetingGeoLocationGeoEntities } from './src/objects/targeting-geo-location-geo-entities'; -export { default as TargetingGeoLocationLocationCluster } from './src/objects/targeting-geo-location-location-cluster'; -export { default as TargetingGeoLocationLocationExpansion } from './src/objects/targeting-geo-location-location-expansion'; -export { default as TargetingGeoLocationMarket } from './src/objects/targeting-geo-location-market'; -export { default as TargetingGeoLocationPlace } from './src/objects/targeting-geo-location-place'; -export { default as TargetingGeoLocationPoliticalDistrict } from './src/objects/targeting-geo-location-political-district'; -export { default as TargetingGeoLocationRegion } from './src/objects/targeting-geo-location-region'; -export { default as TargetingGeoLocationZip } from './src/objects/targeting-geo-location-zip'; -export { default as TargetingProductAudienceSpec } from './src/objects/targeting-product-audience-spec'; -export { default as TargetingProductAudienceSubSpec } from './src/objects/targeting-product-audience-sub-spec'; -export { default as TargetingProspectingAudience } from './src/objects/targeting-prospecting-audience'; -export { default as TargetingRelaxation } from './src/objects/targeting-relaxation'; -export { default as TargetingSentenceLine } from './src/objects/targeting-sentence-line'; -export { default as TextWithEntities } from './src/objects/text-with-entities'; -export { default as TrackingAndConversionWithDefaults } from './src/objects/tracking-and-conversion-with-defaults'; -export { default as URL } from './src/objects/url'; -export { default as UnifiedThread } from './src/objects/unified-thread'; -export { default as User } from './src/objects/user'; -export { default as UserAvailableCatalogs } from './src/objects/user-available-catalogs'; -export { default as UserCoverPhoto } from './src/objects/user-cover-photo'; -export { default as UserDevice } from './src/objects/user-device'; -export { default as UserIDForApp } from './src/objects/user-id-for-app'; -export { default as UserIDForPage } from './src/objects/user-id-for-page'; -export { default as UserLeadGenDisclaimerResponse } from './src/objects/user-lead-gen-disclaimer-response'; -export { default as UserLeadGenFieldData } from './src/objects/user-lead-gen-field-data'; -export { default as UserPageOneTimeOptInTokenSettings } from './src/objects/user-page-one-time-opt-in-token-settings'; -export { default as UserPaymentMobilePricepoints } from './src/objects/user-payment-mobile-pricepoints'; -export { default as ValueBasedEligibleSource } from './src/objects/value-based-eligible-source'; -export { default as Vehicle } from './src/objects/vehicle'; -export { default as VehicleOffer } from './src/objects/vehicle-offer'; -export { default as VideoCopyright } from './src/objects/video-copyright'; -export { default as VideoCopyrightConditionGroup } from './src/objects/video-copyright-condition-group'; -export { default as VideoCopyrightGeoGate } from './src/objects/video-copyright-geo-gate'; -export { default as VideoCopyrightRule } from './src/objects/video-copyright-rule'; -export { default as VideoCopyrightSegment } from './src/objects/video-copyright-segment'; -export { default as VideoList } from './src/objects/video-list'; -export { default as VideoPoll } from './src/objects/video-poll'; -export { default as VideoThumbnail } from './src/objects/video-thumbnail'; -export { default as VideoUploadLimits } from './src/objects/video-upload-limits'; -export { default as VoipInfo } from './src/objects/voip-info'; -export { default as WebAppLink } from './src/objects/web-app-link'; -export { default as WhatsAppBusinessAccount } from './src/objects/whats-app-business-account'; -export { default as WhatsAppBusinessPreVerifiedPhoneNumber } from './src/objects/whats-app-business-pre-verified-phone-number'; -export { default as WhatsAppBusinessProfile } from './src/objects/whats-app-business-profile'; -export { default as WindowsAppLink } from './src/objects/windows-app-link'; -export { default as WindowsPhoneAppLink } from './src/objects/windows-phone-app-link'; -export { default as WoodhengePurchasedPAYGReceipt } from './src/objects/woodhenge-purchased-payg-receipt'; -export { default as WorkUserFrontline } from './src/objects/work-user-frontline'; +/** + * Copyright (c) 2017-present, Facebook, Inc. + * All rights reserved. + * + * This source code is licensed under the license found in the + * LICENSE file in the root directory of this source tree. + */ +export { default as FacebookAdsApi } from "./src/api"; +export { default as FacebookAdsApiBatch } from "./src/api-batch"; +export { default as AbstractCrudObject } from "./src/abstract-crud-object"; +export { default as APIRequest } from "./src/api-request"; +export { default as APIResponse } from "./src/api-response"; +export { default as CrashReporter } from "./src/crash-reporter"; +export { default as Content } from "./src/objects/serverside/content"; +export { default as CustomData } from "./src/objects/serverside/custom-data"; +export { default as EventRequest } from "./src/objects/serverside/event-request"; +export { default as EventResponse } from "./src/objects/serverside/event-response"; +export { default as ServerEvent } from "./src/objects/serverside/server-event"; +export { default as UserData } from "./src/objects/serverside/user-data"; +export { default as ExtendedDeviceInfo } from "./src/objects/serverside/extended-device-info"; +export { default as AppData } from "./src/objects/serverside/app-data"; +export { default as DeliveryCategory } from "./src/objects/serverside/delivery-category"; +export { default as HttpMethod } from "./src/objects/serverside/http-method"; +export { default as HttpServiceClientConfig } from "./src/objects/serverside/http-service-client-config"; +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 AMOneshopSettings } from "./src/objects/am-oneshop-settings"; +export { default as ANBlockedBICategory } from "./src/objects/an-blocked-bi-category"; +export { default as AREffect } from "./src/objects/ar-effect"; +export { default as Ad } from "./src/objects/ad"; +export { default as AdAccount } from "./src/objects/ad-account"; +export { default as AdAccountAAACompatibleAdObjects } from "./src/objects/ad-account-aaa-compatible-ad-objects"; +export { default as AdAccountAAASimilarCampaigns } from "./src/objects/ad-account-aaa-similar-campaigns"; +export { default as AdAccountASLSchedule } from "./src/objects/ad-account-asl-schedule"; +export { default as AdAccountAdLimitsInsights } from "./src/objects/ad-account-ad-limits-insights"; +export { default as AdAccountAdRulesCountByType } from "./src/objects/ad-account-ad-rules-count-by-type"; +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 AdAccountAllPaymentMethods } from "./src/objects/ad-account-all-payment-methods"; +export { default as AdAccountAppSetupRequirements } from "./src/objects/ad-account-app-setup-requirements"; +export { default as AdAccountBankInfoList } from "./src/objects/ad-account-bank-info-list"; +export { default as AdAccountBillingDatePreference } from "./src/objects/ad-account-billing-date-preference"; +export { default as AdAccountBusinessConstraints } from "./src/objects/ad-account-business-constraints"; +export { default as AdAccountCampaignAttributionOptionInfo } from "./src/objects/ad-account-campaign-attribution-option-info"; +export { default as AdAccountCreationRequest } from "./src/objects/ad-account-creation-request"; +export { default as AdAccountCustomAudienceLimits } from "./src/objects/ad-account-custom-audience-limits"; +export { default as AdAccountDefaultDestination } from "./src/objects/ad-account-default-destination"; +export { default as AdAccountDefaultObjective } from "./src/objects/ad-account-default-objective"; +export { default as AdAccountDeliveryEstimate } from "./src/objects/ad-account-delivery-estimate"; +export { default as AdAccountDsaRecommendations } from "./src/objects/ad-account-dsa-recommendations"; +export { default as AdAccountIosFourteenCampaignLimits } from "./src/objects/ad-account-ios-fourteen-campaign-limits"; +export { default as AdAccountMatchedSearchApplicationsEdgeData } from "./src/objects/ad-account-matched-search-applications-edge-data"; +export { default as AdAccountMaxBid } from "./src/objects/ad-account-max-bid"; +export { default as AdAccountOptimizationGoalsAEMv2Eligibility } from "./src/objects/ad-account-optimization-goals-ae-mv2-eligibility"; +export { default as AdAccountPaymentDetails } from "./src/objects/ad-account-payment-details"; +export { default as AdAccountPaymentOptions } from "./src/objects/ad-account-payment-options"; +export { default as AdAccountPrepayDetails } from "./src/objects/ad-account-prepay-details"; +export { default as AdAccountPromotableObjects } from "./src/objects/ad-account-promotable-objects"; +export { default as AdAccountPromotionProgressBar } from "./src/objects/ad-account-promotion-progress-bar"; +export { default as AdAccountReachEstimate } from "./src/objects/ad-account-reach-estimate"; +export { default as AdAccountRecommendations } from "./src/objects/ad-account-recommendations"; +export { default as AdAccountRecommendedCamapaignBudget } from "./src/objects/ad-account-recommended-camapaign-budget"; +export { default as AdAccountRelatedIcoStudy } from "./src/objects/ad-account-related-ico-study"; +export { default as AdAccountSmartSuggestedAds } from "./src/objects/ad-account-smart-suggested-ads"; +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"; +export { default as AdAccountUser } from "./src/objects/ad-account-user"; +export { default as AdAccountUserPermissions } from "./src/objects/ad-account-user-permissions"; +export { default as AdAccountUserSettings } from "./src/objects/ad-account-user-settings"; +export { default as AdAccountYouthAdsAdvertiser } from "./src/objects/ad-account-youth-ads-advertiser"; +export { default as AdActivity } from "./src/objects/ad-activity"; +export { default as AdAssetBody } from "./src/objects/ad-asset-body"; +export { default as AdAssetCallToActionType } from "./src/objects/ad-asset-call-to-action-type"; +export { default as AdAssetCustomizationRuleCustomizationSpec } from "./src/objects/ad-asset-customization-rule-customization-spec"; +export { default as AdAssetDescription } from "./src/objects/ad-asset-description"; +export { default as AdAssetFeedAdditionalData } from "./src/objects/ad-asset-feed-additional-data"; +export { default as AdAssetFeedAdditionalDataPageNudgeMessage } from "./src/objects/ad-asset-feed-additional-data-page-nudge-message"; +export { default as AdAssetFeedSpec } from "./src/objects/ad-asset-feed-spec"; +export { default as AdAssetFeedSpecAssetCustomizationRule } from "./src/objects/ad-asset-feed-spec-asset-customization-rule"; +export { default as AdAssetFeedSpecAssetLabel } from "./src/objects/ad-asset-feed-spec-asset-label"; +export { default as AdAssetFeedSpecBody } from "./src/objects/ad-asset-feed-spec-body"; +export { default as AdAssetFeedSpecCallToAction } from "./src/objects/ad-asset-feed-spec-call-to-action"; +export { default as AdAssetFeedSpecCaption } from "./src/objects/ad-asset-feed-spec-caption"; +export { default as AdAssetFeedSpecCarousel } from "./src/objects/ad-asset-feed-spec-carousel"; +export { default as AdAssetFeedSpecCarouselChildAttachment } from "./src/objects/ad-asset-feed-spec-carousel-child-attachment"; +export { default as AdAssetFeedSpecDescription } from "./src/objects/ad-asset-feed-spec-description"; +export { default as AdAssetFeedSpecEvents } from "./src/objects/ad-asset-feed-spec-events"; +export { default as AdAssetFeedSpecGroupRule } from "./src/objects/ad-asset-feed-spec-group-rule"; +export { default as AdAssetFeedSpecImage } from "./src/objects/ad-asset-feed-spec-image"; +export { default as AdAssetFeedSpecLinkURL } from "./src/objects/ad-asset-feed-spec-link-url"; +export { default as AdAssetFeedSpecTitle } from "./src/objects/ad-asset-feed-spec-title"; +export { default as AdAssetFeedSpecVideo } from "./src/objects/ad-asset-feed-spec-video"; +export { default as AdAssetImage } from "./src/objects/ad-asset-image"; +export { default as AdAssetLinkURL } from "./src/objects/ad-asset-link-url"; +export { default as AdAssetMessageExtensions } from "./src/objects/ad-asset-message-extensions"; +export { default as AdAssetOnsiteDestinations } from "./src/objects/ad-asset-onsite-destinations"; +export { default as AdAssetTargetRuleTargeting } from "./src/objects/ad-asset-target-rule-targeting"; +export { default as AdAssetTitle } from "./src/objects/ad-asset-title"; +export { default as AdAssetVideo } from "./src/objects/ad-asset-video"; +export { default as AdAsyncRequest } from "./src/objects/ad-async-request"; +export { default as AdAsyncRequestSet } from "./src/objects/ad-async-request-set"; +export { default as AdAsyncRequestSetNotificationResult } from "./src/objects/ad-async-request-set-notification-result"; +export { default as AdBidAdjustments } from "./src/objects/ad-bid-adjustments"; +export { default as AdCampaignBidConstraint } from "./src/objects/ad-campaign-bid-constraint"; +export { default as AdCampaignDeliveryEstimate } from "./src/objects/ad-campaign-delivery-estimate"; +export { default as AdCampaignDeliveryStats } from "./src/objects/ad-campaign-delivery-stats"; +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 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"; +export { default as AdCampaignGroupStructureTree } from "./src/objects/ad-campaign-group-structure-tree"; +export { default as AdCampaignIssuesInfo } from "./src/objects/ad-campaign-issues-info"; +export { default as AdCampaignLearningStageInfo } from "./src/objects/ad-campaign-learning-stage-info"; +export { default as AdCampaignMetricsMetadata } from "./src/objects/ad-campaign-metrics-metadata"; +export { default as AdCampaignMultiAds } from "./src/objects/ad-campaign-multi-ads"; +export { default as AdCampaignOptimizationEvent } from "./src/objects/ad-campaign-optimization-event"; +export { default as AdCampaignPacedBidInfo } from "./src/objects/ad-campaign-paced-bid-info"; +export { default as AdCampaignStats } from "./src/objects/ad-campaign-stats"; +export { default as AdColumnSizes } from "./src/objects/ad-column-sizes"; +export { default as AdContract } from "./src/objects/ad-contract"; +export { default as AdConversionValues } from "./src/objects/ad-conversion-values"; +export { default as AdConversions } from "./src/objects/ad-conversions"; +export { default as AdCreationPackageConfig } from "./src/objects/ad-creation-package-config"; +export { default as AdCreative } from "./src/objects/ad-creative"; +export { default as AdCreativeAdDisclaimer } from "./src/objects/ad-creative-ad-disclaimer"; +export { default as AdCreativeAssetGroupsSpec } from "./src/objects/ad-creative-asset-groups-spec"; +export { default as AdCreativeBrandedContentAds } from "./src/objects/ad-creative-branded-content-ads"; +export { default as AdCreativeBrandedContentAdsPartners } from "./src/objects/ad-creative-branded-content-ads-partners"; +export { default as AdCreativeCollectionThumbnailInfo } from "./src/objects/ad-creative-collection-thumbnail-info"; +export { default as AdCreativeContextualMultiAds } from "./src/objects/ad-creative-contextual-multi-ads"; +export { default as AdCreativeDegreesOfFreedomSpec } from "./src/objects/ad-creative-degrees-of-freedom-spec"; +export { default as AdCreativeFacebookBrandedContent } from "./src/objects/ad-creative-facebook-branded-content"; +export { default as AdCreativeFeatureActionMetadata } from "./src/objects/ad-creative-feature-action-metadata"; +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 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"; +export { default as AdCreativeInsights } from "./src/objects/ad-creative-insights"; +export { default as AdCreativeInstagramBrandedContent } from "./src/objects/ad-creative-instagram-branded-content"; +export { default as AdCreativeInteractiveComponentsSpec } from "./src/objects/ad-creative-interactive-components-spec"; +export { default as AdCreativeLinkData } from "./src/objects/ad-creative-link-data"; +export { default as AdCreativeLinkDataAppLinkSpec } from "./src/objects/ad-creative-link-data-app-link-spec"; +export { default as AdCreativeLinkDataCallToAction } from "./src/objects/ad-creative-link-data-call-to-action"; +export { default as AdCreativeLinkDataCallToActionValue } from "./src/objects/ad-creative-link-data-call-to-action-value"; +export { default as AdCreativeLinkDataChildAttachment } from "./src/objects/ad-creative-link-data-child-attachment"; +export { default as AdCreativeLinkDataCustomOverlaySpec } from "./src/objects/ad-creative-link-data-custom-overlay-spec"; +export { default as AdCreativeLinkDataImageLayerSpec } from "./src/objects/ad-creative-link-data-image-layer-spec"; +export { default as AdCreativeLinkDataImageOverlaySpec } from "./src/objects/ad-creative-link-data-image-overlay-spec"; +export { default as AdCreativeLinkDataMoment } from "./src/objects/ad-creative-link-data-moment"; +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 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"; +export { default as AdCreativePhotoDataMediaElements } from "./src/objects/ad-creative-photo-data-media-elements"; +export { default as AdCreativePlaceData } from "./src/objects/ad-creative-place-data"; +export { default as AdCreativePlatformCustomization } from "./src/objects/ad-creative-platform-customization"; +export { default as AdCreativePortraitCustomizations } from "./src/objects/ad-creative-portrait-customizations"; +export { default as AdCreativePostClickConfiguration } from "./src/objects/ad-creative-post-click-configuration"; +export { default as AdCreativePromotionMetadataSpec } from "./src/objects/ad-creative-promotion-metadata-spec"; +export { default as AdCreativeRecommenderSettings } from "./src/objects/ad-creative-recommender-settings"; +export { default as AdCreativeRegionalRegulationDisclaimer } from "./src/objects/ad-creative-regional-regulation-disclaimer"; +export { default as AdCreativeRewardInfo } from "./src/objects/ad-creative-reward-info"; +export { default as AdCreativeShopSpec } from "./src/objects/ad-creative-shop-spec"; +export { default as AdCreativeSiteLinksSpec } from "./src/objects/ad-creative-site-links-spec"; +export { default as AdCreativeSourcingSpec } from "./src/objects/ad-creative-sourcing-spec"; +export { default as AdCreativeStaticFallbackSpec } from "./src/objects/ad-creative-static-fallback-spec"; +export { default as AdCreativeTemplateURLSpec } from "./src/objects/ad-creative-template-url-spec"; +export { default as AdCreativeTextData } from "./src/objects/ad-creative-text-data"; +export { default as AdCreativeVideoData } from "./src/objects/ad-creative-video-data"; +export { default as AdCreativeVideoDataCustomOverlaySpec } from "./src/objects/ad-creative-video-data-custom-overlay-spec"; +export { default as AdCreativeVideoDataMediaElements } from "./src/objects/ad-creative-video-data-media-elements"; +export { default as AdCreativeWhatsAppChannelSpec } from "./src/objects/ad-creative-whats-app-channel-spec"; +export { default as AdCustomDerivedMetrics } from "./src/objects/ad-custom-derived-metrics"; +export { default as AdCustomizationRuleSpec } from "./src/objects/ad-customization-rule-spec"; +export { default as AdDefaultValues } from "./src/objects/ad-default-values"; +export { default as AdDraft } from "./src/objects/ad-draft"; +export { default as AdDynamicCreative } from "./src/objects/ad-dynamic-creative"; +export { default as AdEntityTargetSpend } from "./src/objects/ad-entity-target-spend"; +export { default as AdExportPreset } from "./src/objects/ad-export-preset"; +export { default as AdImage } from "./src/objects/ad-image"; +export { default as AdKeywordStats } from "./src/objects/ad-keyword-stats"; +export { default as AdKeywords } from "./src/objects/ad-keywords"; +export { default as AdKpiShift } from "./src/objects/ad-kpi-shift"; +export { default as AdLabel } from "./src/objects/ad-label"; +export { default as AdLightAdgroup } from "./src/objects/ad-light-adgroup"; +export { default as AdLightCampaign } from "./src/objects/ad-light-campaign"; +export { default as AdLightCampaignGroup } from "./src/objects/ad-light-campaign-group"; +export { default as AdLimitSetting } from "./src/objects/ad-limit-setting"; +export { default as AdLimitsEnforcementData } from "./src/objects/ad-limits-enforcement-data"; +export { default as AdMonetizationProperty } from "./src/objects/ad-monetization-property"; +export { default as AdNetworkAnalyticsAsyncQueryExport } from "./src/objects/ad-network-analytics-async-query-export"; +export { default as AdNetworkAnalyticsAsyncQueryResult } from "./src/objects/ad-network-analytics-async-query-result"; +export { default as AdNetworkAnalyticsSyncQueryResult } from "./src/objects/ad-network-analytics-sync-query-result"; +export { default as AdPlacePageSet } from "./src/objects/ad-place-page-set"; +export { default as AdPlacePageSetMetadata } from "./src/objects/ad-place-page-set-metadata"; +export { default as AdPlacement } from "./src/objects/ad-placement"; +export { default as AdPreview } from "./src/objects/ad-preview"; +export { default as AdPromotedObject } from "./src/objects/ad-promoted-object"; +export { default as AdProposal } from "./src/objects/ad-proposal"; +export { default as AdRecommendation } from "./src/objects/ad-recommendation"; +export { default as AdRecommendationData } from "./src/objects/ad-recommendation-data"; +export { default as AdReportRun } from "./src/objects/ad-report-run"; +export { default as AdRule } from "./src/objects/ad-rule"; +export { default as AdRuleEvaluationSpec } from "./src/objects/ad-rule-evaluation-spec"; +export { default as AdRuleExecutionOptions } from "./src/objects/ad-rule-execution-options"; +export { default as AdRuleExecutionSpec } from "./src/objects/ad-rule-execution-spec"; +export { default as AdRuleFilters } from "./src/objects/ad-rule-filters"; +export { default as AdRuleHistory } from "./src/objects/ad-rule-history"; +export { default as AdRuleHistoryResult } from "./src/objects/ad-rule-history-result"; +export { default as AdRuleHistoryResultAction } from "./src/objects/ad-rule-history-result-action"; +export { default as AdRuleSchedule } from "./src/objects/ad-rule-schedule"; +export { default as AdRuleScheduleSpec } from "./src/objects/ad-rule-schedule-spec"; +export { default as AdRuleTrigger } from "./src/objects/ad-rule-trigger"; +export { default as AdSavedKeywords } from "./src/objects/ad-saved-keywords"; +export { default as AdSavedLocation } from "./src/objects/ad-saved-location"; +export { default as AdSavedReport } from "./src/objects/ad-saved-report"; +export { default as AdSet } from "./src/objects/ad-set"; +export { default as AdStudy } from "./src/objects/ad-study"; +export { default as AdStudyCell } from "./src/objects/ad-study-cell"; +export { default as AdStudyObjective } from "./src/objects/ad-study-objective"; +export { default as AdStudyObjectiveID } from "./src/objects/ad-study-objective-id"; +export { default as AdStudyObjectiveOffsiteDatasets } from "./src/objects/ad-study-objective-offsite-datasets"; +export { default as AdTopline } from "./src/objects/ad-topline"; +export { default as AdToplineDetail } from "./src/objects/ad-topline-detail"; +export { default as AdVideo } from "./src/objects/ad-video"; +export { default as AdVolume } from "./src/objects/ad-volume"; +export { default as AdgroupFacebookFeedback } from "./src/objects/adgroup-facebook-feedback"; +export { default as AdgroupIssuesInfo } from "./src/objects/adgroup-issues-info"; +export { default as AdgroupMetadata } from "./src/objects/adgroup-metadata"; +export { default as AdgroupPlacementSpecificReviewFeedback } from "./src/objects/adgroup-placement-specific-review-feedback"; +export { default as AdgroupReviewFeedback } from "./src/objects/adgroup-review-feedback"; +export { default as AdjacentContentDeliveryReport } from "./src/objects/adjacent-content-delivery-report"; +export { default as AdoptablePet } from "./src/objects/adoptable-pet"; +export { default as AdsActionStats } from "./src/objects/ads-action-stats"; +export { default as AdsAnomalyDetection } from "./src/objects/ads-anomaly-detection"; +export { default as AdsConversionGoal } from "./src/objects/ads-conversion-goal"; +export { default as AdsCreationSavedState } from "./src/objects/ads-creation-saved-state"; +export { default as AdsCustomPivotsPreview } from "./src/objects/ads-custom-pivots-preview"; +export { default as AdsDataPartner } from "./src/objects/ads-data-partner"; +export { default as AdsDataset } from "./src/objects/ads-dataset"; +export { default as AdsGuidanceQEExposure } from "./src/objects/ads-guidance-qe-exposure"; +export { default as AdsHistogramStats } from "./src/objects/ads-histogram-stats"; +export { default as AdsImageCrops } from "./src/objects/ads-image-crops"; +export { default as AdsInsights } from "./src/objects/ads-insights"; +export { default as AdsNamingTemplate } from "./src/objects/ads-naming-template"; +export { default as AdsOptimalDeliveryGrowthOpportunity } from "./src/objects/ads-optimal-delivery-growth-opportunity"; +export { default as AdsPaymentCycle } from "./src/objects/ads-payment-cycle"; +export { default as AdsPivotRules } from "./src/objects/ads-pivot-rules"; +export { default as AdsPixel } from "./src/objects/ads-pixel"; +export { default as AdsPixelCAPISetupQuality } from "./src/objects/ads-pixel-capi-setup-quality"; +export { default as AdsPixelCapabilityOverride } from "./src/objects/ads-pixel-capability-override"; +export { default as AdsPixelDeliveryRecommendations } from "./src/objects/ads-pixel-delivery-recommendations"; +export { default as AdsPixelDomainControlRule } from "./src/objects/ads-pixel-domain-control-rule"; +export { default as AdsPixelDomainLastFiredTime } from "./src/objects/ads-pixel-domain-last-fired-time"; +export { default as AdsPixelEventLastFiredTime } from "./src/objects/ads-pixel-event-last-fired-time"; +export { default as AdsPixelEventPrediction } from "./src/objects/ads-pixel-event-prediction"; +export { default as AdsPixelEventSuggestionRule } from "./src/objects/ads-pixel-event-suggestion-rule"; +export { default as AdsPixelItemPrice } from "./src/objects/ads-pixel-item-price"; +export { default as AdsPixelMicrodataStats } from "./src/objects/ads-pixel-microdata-stats"; +export { default as AdsPixelRawFiresResult } from "./src/objects/ads-pixel-raw-fires-result"; +export { default as AdsPixelRealTimeEventLogResult } from "./src/objects/ads-pixel-real-time-event-log-result"; +export { default as AdsPixelRecentEventsResult } from "./src/objects/ads-pixel-recent-events-result"; +export { default as AdsPixelSignalsIWLFeedbackNux } from "./src/objects/ads-pixel-signals-iwl-feedback-nux"; +export { default as AdsPixelSignalsIWLNux } from "./src/objects/ads-pixel-signals-iwl-nux"; +export { default as AdsPixelStats } from "./src/objects/ads-pixel-stats"; +export { default as AdsPixelStatsResult } from "./src/objects/ads-pixel-stats-result"; +export { default as AdsReportBuilder } from "./src/objects/ads-report-builder"; +export { default as AdsReportBuilderExportCore } from "./src/objects/ads-report-builder-export-core"; +export { default as AdsReportBuilderMMMReport } from "./src/objects/ads-report-builder-mmm-report"; +export { default as AdsReportBuilderMMMReportScheduler } from "./src/objects/ads-report-builder-mmm-report-scheduler"; +export { default as AdsReportBuilderSavedReport } from "./src/objects/ads-report-builder-saved-report"; +export { default as AdsSegments } from "./src/objects/ads-segments"; +export { default as AdsSignalDiagnosticIssue } from "./src/objects/ads-signal-diagnostic-issue"; +export { default as AdsStartYourDayWidget } from "./src/objects/ads-start-your-day-widget"; +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"; +export { default as AgeRange } from "./src/objects/age-range"; +export { default as AgencyClientDeclaration } from "./src/objects/agency-client-declaration"; +export { default as Album } from "./src/objects/album"; +export { default as AnalyticsCohortQueryResult } from "./src/objects/analytics-cohort-query-result"; +export { default as AnalyticsConfig } from "./src/objects/analytics-config"; +export { default as AnalyticsEntityUserConfig } from "./src/objects/analytics-entity-user-config"; +export { default as AnalyticsFunnelQueryResult } from "./src/objects/analytics-funnel-query-result"; +export { default as AnalyticsPlatformMetricsConfig } from "./src/objects/analytics-platform-metrics-config"; +export { default as AnalyticsQueryResult } from "./src/objects/analytics-query-result"; +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 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"; +export { default as AppPublisher } from "./src/objects/app-publisher"; +export { default as AppRequest } from "./src/objects/app-request"; +export { default as AppRequestFormerRecipient } from "./src/objects/app-request-former-recipient"; +export { default as Application } from "./src/objects/application"; +export { default as ArAdsDataContainer } from "./src/objects/ar-ads-data-container"; +export { default as AssignedUser } from "./src/objects/assigned-user"; +export { default as AsyncRequest } from "./src/objects/async-request"; +export { default as AsyncSession } from "./src/objects/async-session"; +export { default as AttributionSpec } from "./src/objects/attribution-spec"; +export { default as AudienceFunnel } from "./src/objects/audience-funnel"; +export { default as AudienceOverlap } from "./src/objects/audience-overlap"; +export { default as AudiencePermission } from "./src/objects/audience-permission"; +export { default as AudiencePermissionForActions } from "./src/objects/audience-permission-for-actions"; +export { default as AudienceSharingAccountValid } from "./src/objects/audience-sharing-account-valid"; +export { default as AudienceSharingRecipientAccounts } from "./src/objects/audience-sharing-recipient-accounts"; +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 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"; +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 BCPCreatorIgUser } from "./src/objects/bcp-creator-ig-user"; +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"; +export { default as BlockedUserInfo } from "./src/objects/blocked-user-info"; +export { default as BrandRequest } from "./src/objects/brand-request"; +export { default as BrandSafetyBlockListUsage } from "./src/objects/brand-safety-block-list-usage"; +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 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"; +export { default as Business } from "./src/objects/business"; +export { default as BusinessAdAccountRequest } from "./src/objects/business-ad-account-request"; +export { default as BusinessAdsReportingReportSpecs } from "./src/objects/business-ads-reporting-report-specs"; +export { default as BusinessAdvertisableApplicationsResult } from "./src/objects/business-advertisable-applications-result"; +export { default as BusinessAgreement } from "./src/objects/business-agreement"; +export { default as BusinessApplicationRequest } from "./src/objects/business-application-request"; +export { default as BusinessAssetGroup } from "./src/objects/business-asset-group"; +export { default as BusinessAssetSharingAgreement } from "./src/objects/business-asset-sharing-agreement"; +export { default as BusinessCreative } from "./src/objects/business-creative"; +export { default as BusinessCreativeFolder } from "./src/objects/business-creative-folder"; +export { default as BusinessCreativeInsights } from "./src/objects/business-creative-insights"; +export { default as BusinessFranchiseConfig } from "./src/objects/business-franchise-config"; +export { default as BusinessImage } from "./src/objects/business-image"; +export { default as BusinessImageTBusinessFolderPathItem } from "./src/objects/business-image-t-business-folder-path-item"; +export { default as BusinessManagedPartnerEligibility } from "./src/objects/business-managed-partner-eligibility"; +export { default as BusinessMediaAdPlacementValidationResult } from "./src/objects/business-media-ad-placement-validation-result"; +export { default as BusinessObject } from "./src/objects/business-object"; +export { default as BusinessObjectTransferOwnershipAgreement } from "./src/objects/business-object-transfer-ownership-agreement"; +export { default as BusinessOwnedObjectOnBehalfOfRequest } from "./src/objects/business-owned-object-on-behalf-of-request"; +export { default as BusinessPageRequest } from "./src/objects/business-page-request"; +export { default as BusinessPartnerPremiumOptions } from "./src/objects/business-partner-premium-options"; +export { default as BusinessProductCatalogTOS } from "./src/objects/business-product-catalog-tos"; +export { default as BusinessProject } from "./src/objects/business-project"; +export { default as BusinessRequest } from "./src/objects/business-request"; +export { default as BusinessRoleRequest } from "./src/objects/business-role-request"; +export { default as BusinessSettingLogsData } from "./src/objects/business-setting-logs-data"; +export { default as BusinessTag } from "./src/objects/business-tag"; +export { default as BusinessTrafficAnalysisReport } from "./src/objects/business-traffic-analysis-report"; +export { default as BusinessUser } from "./src/objects/business-user"; +export { default as BusinessVideo } from "./src/objects/business-video"; +export { default as BusinessVideoTBusinessFolderPathItem } from "./src/objects/business-video-t-business-folder-path-item"; +export { default as CASSSetupOfflineEventSetProgress } from "./src/objects/cass-setup-offline-event-set-progress"; +export { default as CPASAdCreationTemplate } from "./src/objects/cpas-ad-creation-template"; +export { default as CPASAdvertiserPartnershipRecommendation } from "./src/objects/cpas-advertiser-partnership-recommendation"; +export { default as CPASBusinessSetupConfig } from "./src/objects/cpas-business-setup-config"; +export { default as CPASCollaborationRequest } from "./src/objects/cpas-collaboration-request"; +export { default as CPASLsbImageBank } from "./src/objects/cpas-lsb-image-bank"; +export { default as CPASMerchantConfig } from "./src/objects/cpas-merchant-config"; +export { default as CPASParentCatalogSettings } from "./src/objects/cpas-parent-catalog-settings"; +export { default as CPASSetup } from "./src/objects/cpas-setup"; +export { default as CPASSetupCatalogProgress } from "./src/objects/cpas-setup-catalog-progress"; +export { default as CPASSetupPageStructureProgress } from "./src/objects/cpas-setup-page-structure-progress"; +export { default as CRMAddress } from "./src/objects/crm-address"; +export { default as CTWAWhatsAppNumbersInfo } from "./src/objects/ctwa-whats-app-numbers-info"; +export { default as CTXOptimizationEligibility } from "./src/objects/ctx-optimization-eligibility"; +export { default as CTXPartnerAppWelcomeMessageFlow } from "./src/objects/ctx-partner-app-welcome-message-flow"; +export { default as CalibratorExistingRule } from "./src/objects/calibrator-existing-rule"; +export { default as CallAdsPhoneData } from "./src/objects/call-ads-phone-data"; +export { default as Campaign } from "./src/objects/campaign"; +export { default as CampaignActionsData } from "./src/objects/campaign-actions-data"; +export { default as CampaignGroupBrandConfiguration } from "./src/objects/campaign-group-brand-configuration"; +export { default as CampaignGroupCollaborativeAdsPartnerInfo } from "./src/objects/campaign-group-collaborative-ads-partner-info"; +export { default as Canvas } from "./src/objects/canvas"; +export { default as CanvasAdSettings } from "./src/objects/canvas-ad-settings"; +export { default as CanvasBodyElement } from "./src/objects/canvas-body-element"; +export { default as CanvasCollectionThumbnail } from "./src/objects/canvas-collection-thumbnail"; +export { default as CanvasDynamicSetting } from "./src/objects/canvas-dynamic-setting"; +export { default as CanvasPreview } from "./src/objects/canvas-preview"; +export { default as CanvasTemplate } from "./src/objects/canvas-template"; +export { default as CatalogBasedTargeting } from "./src/objects/catalog-based-targeting"; +export { default as CatalogItemAppLinks } from "./src/objects/catalog-item-app-links"; +export { default as CatalogItemAppealStatus } from "./src/objects/catalog-item-appeal-status"; +export { default as CatalogItemChannelsToIntegrityStatus } from "./src/objects/catalog-item-channels-to-integrity-status"; +export { default as CatalogItemOverride } from "./src/objects/catalog-item-override"; +export { default as CatalogItemRejectionReasons } from "./src/objects/catalog-item-rejection-reasons"; +export { default as CatalogItemValidationErrorList } from "./src/objects/catalog-item-validation-error-list"; +export { default as CatalogSmartPixelSettings } from "./src/objects/catalog-smart-pixel-settings"; +export { default as CatalogSubVerticalList } from "./src/objects/catalog-sub-vertical-list"; +export { default as CatalogWebsiteOnboardingSettings } from "./src/objects/catalog-website-onboarding-settings"; +export { default as CatalogWebsiteSettings } from "./src/objects/catalog-website-settings"; +export { default as ChatPlugin } from "./src/objects/chat-plugin"; +export { default as CheckBatchRequestStatus } from "./src/objects/check-batch-request-status"; +export { default as ChildEvent } from "./src/objects/child-event"; +export { default as ChinaBusinessOnboardingVettingRequest } from "./src/objects/china-business-onboarding-vetting-request"; +export { default as CloudGame } from "./src/objects/cloud-game"; +export { default as CloudbridgeDatasetStatus } from "./src/objects/cloudbridge-dataset-status"; +export { default as CollaborativeAdsPartnerBusinesses } from "./src/objects/collaborative-ads-partner-businesses"; +export { default as CollaborativeAdsPartnerInfoListItem } from "./src/objects/collaborative-ads-partner-info-list-item"; +export { default as CollaborativeAdsShareSettings } from "./src/objects/collaborative-ads-share-settings"; +export { default as ColumnSuggestions } from "./src/objects/column-suggestions"; +export { default as Comment } from "./src/objects/comment"; +export { default as CommerceMerchantSettings } from "./src/objects/commerce-merchant-settings"; +export { default as CommerceMerchantSettingsSetupStatus } from "./src/objects/commerce-merchant-settings-setup-status"; +export { default as CommerceOrder } from "./src/objects/commerce-order"; +export { default as CommerceOrderTransactionDetail } from "./src/objects/commerce-order-transaction-detail"; +export { default as CommercePayout } from "./src/objects/commerce-payout"; +export { default as CommerceSettings } from "./src/objects/commerce-settings"; +export { default as ConnectionsTargeting } from "./src/objects/connections-targeting"; +export { default as ContactsMessengerSyncConfig } from "./src/objects/contacts-messenger-sync-config"; +export { default as ContentDeliveryReport } from "./src/objects/content-delivery-report"; +export { default as ContentPublishingLimitResponse } from "./src/objects/content-publishing-limit-response"; +export { default as ContextualBundlingSpec } from "./src/objects/contextual-bundling-spec"; +export { default as ConversionActionQuery } from "./src/objects/conversion-action-query"; +export { default as ConversionHealthKPI } from "./src/objects/conversion-health-kpi"; +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 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"; +export { default as CreativeHistory } from "./src/objects/creative-history"; +export { default as CreatorAssetCreative } from "./src/objects/creator-asset-creative"; +export { default as CreditCard } from "./src/objects/credit-card"; +export { default as CreditPartitionActionOptions } from "./src/objects/credit-partition-action-options"; +export { default as Currency } from "./src/objects/currency"; +export { default as CurrencyAmount } from "./src/objects/currency-amount"; +export { default as CustomAudience } from "./src/objects/custom-audience"; +export { default as CustomAudienceAdAccount } from "./src/objects/custom-audience-ad-account"; +export { default as CustomAudienceCapabilities } from "./src/objects/custom-audience-capabilities"; +export { default as CustomAudienceDataSource } from "./src/objects/custom-audience-data-source"; +export { default as CustomAudienceGroup } from "./src/objects/custom-audience-group"; +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"; +export { default as CustomAudienceSharingStatus } from "./src/objects/custom-audience-sharing-status"; +export { default as CustomAudienceStatus } from "./src/objects/custom-audience-status"; +export { default as CustomAudiencesTOS } from "./src/objects/custom-audiences-tos"; +export { default as CustomAudiencesharedAccountInfo } from "./src/objects/custom-audienceshared-account-info"; +export { default as CustomConversion } from "./src/objects/custom-conversion"; +export { default as CustomConversionActivities } from "./src/objects/custom-conversion-activities"; +export { default as CustomConversionStatsResult } from "./src/objects/custom-conversion-stats-result"; +export { default as CustomUserSettings } from "./src/objects/custom-user-settings"; +export { default as DACheck } from "./src/objects/da-check"; +export { default as DayPart } from "./src/objects/day-part"; +export { default as DeliveryCheck } from "./src/objects/delivery-check"; +export { default as DeliveryCheckExtraInfo } from "./src/objects/delivery-check-extra-info"; +export { default as DeliveryInfo } from "./src/objects/delivery-info"; +export { default as DeliveryStatus } from "./src/objects/delivery-status"; +export { default as DeliveryWindow } from "./src/objects/delivery-window"; +export { default as Destination } from "./src/objects/destination"; +export { default as DirectDebit } from "./src/objects/direct-debit"; +export { default as DogNotificationSettings } from "./src/objects/dog-notification-settings"; +export { default as Domain } from "./src/objects/domain"; +export { default as DraftPost } from "./src/objects/draft-post"; +export { default as DynamicARMetadata } from "./src/objects/dynamic-ar-metadata"; +export { default as DynamicContentSet } from "./src/objects/dynamic-content-set"; +export { default as DynamicItemDisplayBundle } from "./src/objects/dynamic-item-display-bundle"; +export { default as DynamicItemDisplayBundleFolder } from "./src/objects/dynamic-item-display-bundle-folder"; +export { default as DynamicPostChildAttachment } from "./src/objects/dynamic-post-child-attachment"; +export { default as DynamicPriceConfigByDate } from "./src/objects/dynamic-price-config-by-date"; +export { default as DynamicVideoMetadata } from "./src/objects/dynamic-video-metadata"; +export { default as EducationExperience } from "./src/objects/education-experience"; +export { default as EmailImport } from "./src/objects/email-import"; +export { default as EndStudyCriteria } from "./src/objects/end-study-criteria"; +export { default as Engagement } from "./src/objects/engagement"; +export { default as EntWithSponsor } from "./src/objects/ent-with-sponsor"; +export { default as EntityAtTextRange } from "./src/objects/entity-at-text-range"; +export { default as Event } from "./src/objects/event"; +export { default as EventExternalTicketInfo } from "./src/objects/event-external-ticket-info"; +export { default as EventRegistrationSetting } from "./src/objects/event-registration-setting"; +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 ExpirablePost } from "./src/objects/expirable-post"; +export { default as ExtendedCredit } from "./src/objects/extended-credit"; +export { default as ExtendedCreditAllocationConfig } from "./src/objects/extended-credit-allocation-config"; +export { default as ExtendedCreditApplication } from "./src/objects/extended-credit-application"; +export { default as ExtendedCreditEmail } from "./src/objects/extended-credit-email"; +export { default as ExtendedCreditInfo } from "./src/objects/extended-credit-info"; +export { default as ExtendedCreditInvoiceGroup } from "./src/objects/extended-credit-invoice-group"; +export { default as ExternalEventSource } from "./src/objects/external-event-source"; +export { default as ExternalEventSourceCPASEventsDebugging } from "./src/objects/external-event-source-cpas-events-debugging"; +export { default as ExternalEventSourceCPASEventsDebuggingInfo } from "./src/objects/external-event-source-cpas-events-debugging-info"; +export { default as ExternalEventSourceDAStatsResult } from "./src/objects/external-event-source-da-stats-result"; +export { default as ExternalMerchantSettings } from "./src/objects/external-merchant-settings"; +export { default as FAMEKumo } from "./src/objects/fame-kumo"; +export { default as FBImageCopyrightMatch } from "./src/objects/fb-image-copyright-match"; +export { default as FBLiteToNTTransitions } from "./src/objects/fb-lite-to-nt-transitions"; +export { default as FBPageAndInstagramAccount } from "./src/objects/fb-page-and-instagram-account"; +export { default as FBPayButtonLogin } from "./src/objects/fb-pay-button-login"; +export { default as FantasyGame } from "./src/objects/fantasy-game"; +export { default as FavoriteCatalog } from "./src/objects/favorite-catalog"; +export { default as FinanceObject } from "./src/objects/finance-object"; +export { default as FlexibleTargeting } from "./src/objects/flexible-targeting"; +export { default as Flight } from "./src/objects/flight"; +export { default as FranchiseProgram } from "./src/objects/franchise-program"; +export { default as FranchiseProgramMember } from "./src/objects/franchise-program-member"; +export { default as FundingSourceDetails } from "./src/objects/funding-source-details"; +export { default as FundingSourceDetailsCoupon } from "./src/objects/funding-source-details-coupon"; +export { default as FundraiserPersonToCharity } from "./src/objects/fundraiser-person-to-charity"; +export { default as GenericVideoAsset } from "./src/objects/generic-video-asset"; +export { default as GeoGatingPolicy } from "./src/objects/geo-gating-policy"; +export { default as Group } from "./src/objects/group"; +export { default as HasLeadAccess } from "./src/objects/has-lead-access"; +export { default as HighDemandPeriod } from "./src/objects/high-demand-period"; +export { default as HighDemandPeriodTimeSuggestionWeeklySegment } from "./src/objects/high-demand-period-time-suggestion-weekly-segment"; +export { default as HomeListing } from "./src/objects/home-listing"; +export { default as Hotel } from "./src/objects/hotel"; +export { default as HotelRoom } from "./src/objects/hotel-room"; +export { default as Hours } from "./src/objects/hours"; +export { default as IDName } from "./src/objects/id-name"; +export { default as IGAccessTokenForIGOnlyAPI } from "./src/objects/ig-access-token-for-ig-only-api"; +export { default as IGBCAdsPermission } from "./src/objects/igbc-ads-permission"; +export { default as IGBoostMediaAd } from "./src/objects/ig-boost-media-ad"; +export { default as IGComment } from "./src/objects/ig-comment"; +export { default as IGCommentFromUser } from "./src/objects/ig-comment-from-user"; +export { default as IGMedia } from "./src/objects/ig-media"; +export { default as IGMediaBoostEligibilityInfo } from "./src/objects/ig-media-boost-eligibility-info"; +export { default as IGMediaForIGOnlyAPI } from "./src/objects/ig-media-for-ig-only-api"; +export { default as IGProductTaggingInvalidationError } from "./src/objects/ig-product-tagging-invalidation-error"; +export { default as IGRefreshAccessTokenForIGOnlyAPI } from "./src/objects/ig-refresh-access-token-for-ig-only-api"; +export { default as IGResumableVideoUploadStatus } from "./src/objects/ig-resumable-video-upload-status"; +export { default as IGShoppingProductAppeal } from "./src/objects/ig-shopping-product-appeal"; +export { default as IGShoppingReviewStatus } from "./src/objects/ig-shopping-review-status"; +export { default as IGShoppingReviewStatusOnsiteEligibility } from "./src/objects/ig-shopping-review-status-onsite-eligibility"; +export { default as IGShoppingReviewStatusReasonWithHelpMessage } from "./src/objects/ig-shopping-review-status-reason-with-help-message"; +export { default as IGUpcomingEvent } from "./src/objects/ig-upcoming-event"; +export { default as IGUser } from "./src/objects/ig-user"; +export { default as IGUserForIGOnlyAPI } from "./src/objects/ig-user-for-ig-only-api"; +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"; +export { default as IPObject } from "./src/objects/ip-object"; +export { default as ImageCopyright } from "./src/objects/image-copyright"; +export { default as ImageCopyrightDispute } from "./src/objects/image-copyright-dispute"; +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 InstagramBoostableMediaForAccessToken } from "./src/objects/instagram-boostable-media-for-access-token"; +export { default as InstagramCarousel } from "./src/objects/instagram-carousel"; +export { default as InstagramComment } from "./src/objects/instagram-comment"; +export { default as InstagramInsightsResult } from "./src/objects/instagram-insights-result"; +export { default as InstagramInsightsValue } from "./src/objects/instagram-insights-value"; +export { default as InstagramMedia } from "./src/objects/instagram-media"; +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 InstagramUser } from "./src/objects/instagram-user"; +export { default as InstagramVideoMetadata } from "./src/objects/instagram-video-metadata"; +export { default as InstantArticleCTA } from "./src/objects/instant-article-cta"; +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 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"; +export { default as LeadGenCustomDisclaimer } from "./src/objects/lead-gen-custom-disclaimer"; +export { default as LeadGenCustomDisclaimerBody } from "./src/objects/lead-gen-custom-disclaimer-body"; +export { default as LeadGenDataDraft } from "./src/objects/lead-gen-data-draft"; +export { default as LeadGenDirectCRMIntegrationConfig } from "./src/objects/lead-gen-direct-crm-integration-config"; +export { default as LeadGenDraftQuestion } from "./src/objects/lead-gen-draft-question"; +export { default as LeadGenFormPreviewDetails } from "./src/objects/lead-gen-form-preview-details"; +export { default as LeadGenLegalContent } from "./src/objects/lead-gen-legal-content"; +export { default as LeadGenLegalContentCheckbox } from "./src/objects/lead-gen-legal-content-checkbox"; +export { default as LeadGenPostSubmissionCheckResult } from "./src/objects/lead-gen-post-submission-check-result"; +export { default as LeadGenPrivacyPolicy } from "./src/objects/lead-gen-privacy-policy"; +export { default as LeadGenQuestion } from "./src/objects/lead-gen-question"; +export { default as LeadGenQuestionOption } from "./src/objects/lead-gen-question-option"; +export { default as LeadGenThankYouPage } from "./src/objects/lead-gen-thank-you-page"; +export { default as LeadGenThankYouPageGatedFile } from "./src/objects/lead-gen-thank-you-page-gated-file"; +export { default as LeadGenThankYouPageGatedPromo } from "./src/objects/lead-gen-thank-you-page-gated-promo"; +export { default as LeadGenURLEntityAtRanges } from "./src/objects/lead-gen-url-entity-at-ranges"; +export { default as LeadgenForm } from "./src/objects/leadgen-form"; +export { default as LifeEvent } from "./src/objects/life-event"; +export { default as Link } from "./src/objects/link"; +export { default as LinkedInstagramAccountData } from "./src/objects/linked-instagram-account-data"; +export { default as LiveVideo } from "./src/objects/live-video"; +export { default as LiveVideoAdBreakConfig } from "./src/objects/live-video-ad-break-config"; +export { default as LiveVideoError } from "./src/objects/live-video-error"; +export { default as LiveVideoInputStream } from "./src/objects/live-video-input-stream"; +export { default as LiveVideoRecommendedEncoderSettings } from "./src/objects/live-video-recommended-encoder-settings"; +export { default as LiveVideoTargeting } from "./src/objects/live-video-targeting"; +export { default as LocalServiceBusiness } from "./src/objects/local-service-business"; +export { default as Location } from "./src/objects/location"; +export { default as LocationBasedItem } from "./src/objects/location-based-item"; +export { default as LookalikeSpec } from "./src/objects/lookalike-spec"; +export { default as LoomConfig } from "./src/objects/loom-config"; +export { default as MCExperienceConfigForApi } from "./src/objects/mc-experience-config-for-api"; +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 MarketingMessageTargeting } from "./src/objects/marketing-message-targeting"; +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"; +export { default as McomInvoiceStatus } from "./src/objects/mcom-invoice-status"; +export { default as McomOnboardingStatus } from "./src/objects/mcom-onboarding-status"; +export { default as McomPayouts } from "./src/objects/mcom-payouts"; +export { default as MeasurementReport } from "./src/objects/measurement-report"; +export { default as MediaCopyrightAttribution } from "./src/objects/media-copyright-attribution"; +export { default as MediaCopyrightUpdateRecord } from "./src/objects/media-copyright-update-record"; +export { default as MediaFingerprint } from "./src/objects/media-fingerprint"; +export { default as MediaTitle } from "./src/objects/media-title"; +export { default as MerchantCompliance } from "./src/objects/merchant-compliance"; +export { default as MerchantReport } from "./src/objects/merchant-report"; +export { default as MessagingAppsInfo } from "./src/objects/messaging-apps-info"; +export { default as MessagingFeatureReview } from "./src/objects/messaging-feature-review"; +export { default as MessagingFeatureStatus } from "./src/objects/messaging-feature-status"; +export { default as MessengerAdsPartialAutomatedStepList } from "./src/objects/messenger-ads-partial-automated-step-list"; +export { default as MessengerCallSettings } from "./src/objects/messenger-call-settings"; +export { default as MessengerDestinationPageWelcomeMessage } from "./src/objects/messenger-destination-page-welcome-message"; +export { default as MessengerProfile } from "./src/objects/messenger-profile"; +export { default as MinimumBudget } from "./src/objects/minimum-budget"; +export { default as MusicVideoCopyright } from "./src/objects/music-video-copyright"; +export { default as MusicWorkCopyright } from "./src/objects/music-work-copyright"; +export { default as NegativeKeywordList } from "./src/objects/negative-keyword-list"; +export { default as NullNode } from "./src/objects/null-node"; +export { default as OfflineConversionDataSet } from "./src/objects/offline-conversion-data-set"; +export { default as OfflineConversionDataSetActivities } from "./src/objects/offline-conversion-data-set-activities"; +export { default as OfflineConversionDataSetOptimizationStatus } from "./src/objects/offline-conversion-data-set-optimization-status"; +export { default as OfflineConversionDataSetPermissions } from "./src/objects/offline-conversion-data-set-permissions"; +export { default as OfflineConversionDataSetUpload } from "./src/objects/offline-conversion-data-set-upload"; +export { default as OfflineConversionDataSetUsage } from "./src/objects/offline-conversion-data-set-usage"; +export { default as OfflineProductItem } from "./src/objects/offline-product-item"; +export { default as OfflineTermsOfService } from "./src/objects/offline-terms-of-service"; +export { default as OffsitePixel } from "./src/objects/offsite-pixel"; +export { default as OffsiteSignalContainerBusinessObject } from "./src/objects/offsite-signal-container-business-object"; +export { default as OmegaCustomerTrx } from "./src/objects/omega-customer-trx"; +export { default as OpenBridgeConfiguration } from "./src/objects/open-bridge-configuration"; +export { default as OpenGraphContext } from "./src/objects/open-graph-context"; +export { default as OrderIDAttributions } from "./src/objects/order-id-attributions"; +export { default as Organization } from "./src/objects/organization"; +export { default as OutcomePredictionPoint } from "./src/objects/outcome-prediction-point"; +export { default as OwnedDomain } from "./src/objects/owned-domain"; +export { default as P2MInvoicePayments } from "./src/objects/p2-m-invoice-payments"; +export { default as Page } from "./src/objects/page"; +export { default as PageAboutStoryComposedBlock } from "./src/objects/page-about-story-composed-block"; +export { default as PageAboutStoryComposedBlockEntityRanges } from "./src/objects/page-about-story-composed-block-entity-ranges"; +export { default as PageAboutStoryComposedBlockInlineStyle } from "./src/objects/page-about-story-composed-block-inline-style"; +export { default as PageAppWithLeadsAccess } from "./src/objects/page-app-with-leads-access"; +export { default as PageBroadcast } from "./src/objects/page-broadcast"; +export { default as PageCTSTopic } from "./src/objects/page-cts-topic"; +export { default as PageCTXBudgetSimilarAdvertiserBudgetRecommendation } from "./src/objects/page-ctx-budget-similar-advertiser-budget-recommendation"; +export { default as PageCTXDefaultGreetingText } from "./src/objects/page-ctx-default-greeting-text"; +export { default as PageCallToAction } from "./src/objects/page-call-to-action"; +export { default as PageCategory } from "./src/objects/page-category"; +export { default as PageChangeProposal } from "./src/objects/page-change-proposal"; +export { default as PageCrmsWithLeadsAccess } from "./src/objects/page-crms-with-leads-access"; +export { default as PageDirectIntegrationCrmWithLeadsAccess } from "./src/objects/page-direct-integration-crm-with-leads-access"; +export { default as PageGameBotQuotaInformation } from "./src/objects/page-game-bot-quota-information"; +export { default as PageGetStartedNullstate } from "./src/objects/page-get-started-nullstate"; +export { default as PageInsightsAsyncExportRun } from "./src/objects/page-insights-async-export-run"; +export { default as PageLeadsAccessConfig } from "./src/objects/page-leads-access-config"; +export { default as PageLocationsBreakdown } from "./src/objects/page-locations-breakdown"; +export { default as PageMessageResponsivenessMetrics } from "./src/objects/page-message-responsiveness-metrics"; +export { default as PageParking } from "./src/objects/page-parking"; +export { default as PagePartnerWithLeadsAccess } from "./src/objects/page-partner-with-leads-access"; +export { default as PagePaymentOptions } from "./src/objects/page-payment-options"; +export { default as PagePost } from "./src/objects/page-post"; +export { default as PagePostExperiment } from "./src/objects/page-post-experiment"; +export { default as PagePublisher } from "./src/objects/page-publisher"; +export { default as PageRestaurantServices } from "./src/objects/page-restaurant-services"; +export { default as PageRestaurantSpecialties } from "./src/objects/page-restaurant-specialties"; +export { default as PageSettings } from "./src/objects/page-settings"; +export { default as PageStartInfo } from "./src/objects/page-start-info"; +export { default as PageThreadOwner } from "./src/objects/page-thread-owner"; +export { default as PageUpcomingChange } from "./src/objects/page-upcoming-change"; +export { default as PageUserMessageThreadLabel } from "./src/objects/page-user-message-thread-label"; +export { default as PageUserPermissions } from "./src/objects/page-user-permissions"; +export { default as PageUserWithLeadsAccess } from "./src/objects/page-user-with-leads-access"; +export { default as PageVideosYouCanUse } from "./src/objects/page-videos-you-can-use"; +export { default as PanelAPIReport } from "./src/objects/panel-api-report"; +export { default as ParentCatalogReport } from "./src/objects/parent-catalog-report"; +export { default as PartnerAccountLinking } from "./src/objects/partner-account-linking"; +export { default as PartnerCategory } from "./src/objects/partner-category"; +export { default as PartnerIntegrationLinked } from "./src/objects/partner-integration-linked"; +export { default as PartnerStudy } from "./src/objects/partner-study"; +export { default as PartnershipAdContentSearchMedia } from "./src/objects/partnership-ad-content-search-media"; +export { default as PartnershipAdsIdentity } from "./src/objects/partnership-ads-identity"; +export { default as PaymentEnginePayment } from "./src/objects/payment-engine-payment"; +export { default as PaymentPricepoints } from "./src/objects/payment-pricepoints"; +export { default as PaymentRequestDetails } from "./src/objects/payment-request-details"; +export { default as PaymentSubscription } from "./src/objects/payment-subscription"; +export { default as Permission } from "./src/objects/permission"; +export { default as Persona } from "./src/objects/persona"; +export { default as PersonalAdsPersona } from "./src/objects/personal-ads-persona"; +export { default as Photo } from "./src/objects/photo"; +export { default as PhotoMetadata } from "./src/objects/photo-metadata"; +export { default as Place } from "./src/objects/place"; +export { default as PlaceTag } from "./src/objects/place-tag"; +export { default as PlaceTopic } from "./src/objects/place-topic"; +export { default as PlatformImageSource } from "./src/objects/platform-image-source"; +export { default as PlatformSessionKey } from "./src/objects/platform-session-key"; +export { default as PlayableContent } from "./src/objects/playable-content"; +export { default as Post } from "./src/objects/post"; +export { default as PreapprovalReview } from "./src/objects/preapproval-review"; +export { default as PremiumMusicVideo } from "./src/objects/premium-music-video"; +export { default as Privacy } from "./src/objects/privacy"; +export { default as PrivacyOption } from "./src/objects/privacy-option"; +export { default as PrivateComputationEnvironment } from "./src/objects/private-computation-environment"; +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 ProductCatalogDataSource } from "./src/objects/product-catalog-data-source"; +export { default as ProductCatalogDiagnosticGroup } from "./src/objects/product-catalog-diagnostic-group"; +export { default as ProductCatalogExampleFeed } from "./src/objects/product-catalog-example-feed"; +export { default as ProductCatalogFacets } from "./src/objects/product-catalog-facets"; +export { default as ProductCatalogHotelRoomsBatch } from "./src/objects/product-catalog-hotel-rooms-batch"; +export { default as ProductCatalogImageSettings } from "./src/objects/product-catalog-image-settings"; +export { default as ProductCatalogImageSettingsInternal } from "./src/objects/product-catalog-image-settings-internal"; +export { default as ProductCatalogImageSettingsOperation } from "./src/objects/product-catalog-image-settings-operation"; +export { default as ProductCatalogLocalizationSettings } from "./src/objects/product-catalog-localization-settings"; +export { default as ProductCatalogMicrodataStatsPixelInfo } from "./src/objects/product-catalog-microdata-stats-pixel-info"; +export { default as ProductCatalogPricingVariablesBatch } from "./src/objects/product-catalog-pricing-variables-batch"; +export { default as ProductCatalogProductSetsBatch } from "./src/objects/product-catalog-product-sets-batch"; +export { default as ProductCatalogUserActions } from "./src/objects/product-catalog-user-actions"; +export { default as ProductCatalogUserPermissions } from "./src/objects/product-catalog-user-permissions"; +export { default as ProductCatalogUserTasks } from "./src/objects/product-catalog-user-tasks"; +export { default as ProductDaEventSamplesBatch } from "./src/objects/product-da-event-samples-batch"; +export { default as ProductEventStat } from "./src/objects/product-event-stat"; +export { default as ProductFeed } from "./src/objects/product-feed"; +export { default as ProductFeedMissingFeedItemReplacement } from "./src/objects/product-feed-missing-feed-item-replacement"; +export { default as ProductFeedRule } from "./src/objects/product-feed-rule"; +export { default as ProductFeedRulePreviewSample } from "./src/objects/product-feed-rule-preview-sample"; +export { default as ProductFeedRuleSuggestion } from "./src/objects/product-feed-rule-suggestion"; +export { default as ProductFeedSchedule } from "./src/objects/product-feed-schedule"; +export { default as ProductFeedUpload } from "./src/objects/product-feed-upload"; +export { default as ProductFeedUploadError } from "./src/objects/product-feed-upload-error"; +export { default as ProductFeedUploadErrorReport } from "./src/objects/product-feed-upload-error-report"; +export { default as ProductFeedUploadErrorSample } from "./src/objects/product-feed-upload-error-sample"; +export { default as ProductFeedUploadProgress } from "./src/objects/product-feed-upload-progress"; +export { default as ProductGroup } from "./src/objects/product-group"; +export { default as ProductImage } from "./src/objects/product-image"; +export { default as ProductItem } from "./src/objects/product-item"; +export { default as ProductItemCommerceInsights } from "./src/objects/product-item-commerce-insights"; +export { default as ProductItemError } from "./src/objects/product-item-error"; +export { default as ProductItemImporterAddress } from "./src/objects/product-item-importer-address"; +export { default as ProductItemInsights } from "./src/objects/product-item-insights"; +export { default as ProductItemInvalidationError } from "./src/objects/product-item-invalidation-error"; +export { default as ProductItemLandingPageData } from "./src/objects/product-item-landing-page-data"; +export { default as ProductItemLocalInfo } from "./src/objects/product-item-local-info"; +export { default as ProductItemLocalInfoLatLongShape } from "./src/objects/product-item-local-info-lat-long-shape"; +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 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"; +export { default as ProductSetUsage } from "./src/objects/product-set-usage"; +export { default as ProductVariant } from "./src/objects/product-variant"; +export { default as ProductVisualVariant } from "./src/objects/product-visual-variant"; +export { default as Profile } from "./src/objects/profile"; +export { default as ProfilePictureSource } from "./src/objects/profile-picture-source"; +export { default as PublisherBlockList } from "./src/objects/publisher-block-list"; +export { default as PublisherDeliveryReport } from "./src/objects/publisher-delivery-report"; +export { default as PublisherWhiteList } from "./src/objects/publisher-white-list"; +export { default as RTBDynamicPost } from "./src/objects/rtb-dynamic-post"; +export { default as RawCustomAudience } from "./src/objects/raw-custom-audience"; +export { default as ReachFrequencyActivity } from "./src/objects/reach-frequency-activity"; +export { default as ReachFrequencyAdFormat } from "./src/objects/reach-frequency-ad-format"; +export { default as ReachFrequencyCurveLowerConfidenceRange } from "./src/objects/reach-frequency-curve-lower-confidence-range"; +export { default as ReachFrequencyCurveUpperConfidenceRange } from "./src/objects/reach-frequency-curve-upper-confidence-range"; +export { default as ReachFrequencyDayPart } from "./src/objects/reach-frequency-day-part"; +export { default as ReachFrequencyEstimatesCurve } from "./src/objects/reach-frequency-estimates-curve"; +export { default as ReachFrequencyEstimatesPlacementBreakdown } from "./src/objects/reach-frequency-estimates-placement-breakdown"; +export { default as ReachFrequencyPrediction } from "./src/objects/reach-frequency-prediction"; +export { default as ReachFrequencySpec } from "./src/objects/reach-frequency-spec"; +export { default as Recommendation } from "./src/objects/recommendation"; +export { default as RecommendedIGMedia } from "./src/objects/recommended-ig-media"; +export { default as RecommendedPagePost } from "./src/objects/recommended-page-post"; +export { default as RegionalRegulationIdentities } from "./src/objects/regional-regulation-identities"; +export { default as ReportingAudience } from "./src/objects/reporting-audience"; +export { default as ResearchPollStudy } from "./src/objects/research-poll-study"; +export { default as ResellerGuidance } from "./src/objects/reseller-guidance"; +export { default as RevSharePolicy } from "./src/objects/rev-share-policy"; +export { default as RichMediaElement } from "./src/objects/rich-media-element"; +export { default as RightsManagerDataExport } from "./src/objects/rights-manager-data-export"; +export { default as RightsManagerInsights } from "./src/objects/rights-manager-insights"; +export { default as Robot } from "./src/objects/robot"; +export { default as SalesRightsInventoryManagement } from "./src/objects/sales-rights-inventory-management"; +export { default as SavedAudience } from "./src/objects/saved-audience"; +export { default as SavedMessageResponse } from "./src/objects/saved-message-response"; +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 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 Shop } from "./src/objects/shop"; +export { default as SignalsIWLExtractor } from "./src/objects/signals-iwl-extractor"; +export { default as SingleOwnerAdditionalProfile } from "./src/objects/single-owner-additional-profile"; +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"; +export { default as Stories } from "./src/objects/stories"; +export { default as StreamFilter } from "./src/objects/stream-filter"; +export { default as SystemUser } from "./src/objects/system-user"; +export { default as Tab } from "./src/objects/tab"; +export { default as TaggableSubject } from "./src/objects/taggable-subject"; +export { default as Targeting } from "./src/objects/targeting"; +export { default as TargetingAutomation } from "./src/objects/targeting-automation"; +export { default as TargetingDynamicRule } from "./src/objects/targeting-dynamic-rule"; +export { default as TargetingGeoLocation } from "./src/objects/targeting-geo-location"; +export { default as TargetingGeoLocationCity } from "./src/objects/targeting-geo-location-city"; +export { default as TargetingGeoLocationCustomLocation } from "./src/objects/targeting-geo-location-custom-location"; +export { default as TargetingGeoLocationElectoralDistrict } from "./src/objects/targeting-geo-location-electoral-district"; +export { default as TargetingGeoLocationGeoEntities } from "./src/objects/targeting-geo-location-geo-entities"; +export { default as TargetingGeoLocationLocationCluster } from "./src/objects/targeting-geo-location-location-cluster"; +export { default as TargetingGeoLocationLocationExpansion } from "./src/objects/targeting-geo-location-location-expansion"; +export { default as TargetingGeoLocationMarket } from "./src/objects/targeting-geo-location-market"; +export { default as TargetingGeoLocationPlace } from "./src/objects/targeting-geo-location-place"; +export { default as TargetingGeoLocationPoliticalDistrict } from "./src/objects/targeting-geo-location-political-district"; +export { default as TargetingGeoLocationRegion } from "./src/objects/targeting-geo-location-region"; +export { default as TargetingGeoLocationZip } from "./src/objects/targeting-geo-location-zip"; +export { default as TargetingMarketingMessageChannels } from "./src/objects/targeting-marketing-message-channels"; +export { default as TargetingProductAudienceSpec } from "./src/objects/targeting-product-audience-spec"; +export { default as TargetingProductAudienceSubSpec } from "./src/objects/targeting-product-audience-sub-spec"; +export { default as TargetingProspectingAudience } from "./src/objects/targeting-prospecting-audience"; +export { default as TargetingRelaxation } from "./src/objects/targeting-relaxation"; +export { default as TargetingSentenceLine } from "./src/objects/targeting-sentence-line"; +export { default as TextWithEntities } from "./src/objects/text-with-entities"; +export { default as ThirdPartyMeasurementReportDataset } from "./src/objects/third-party-measurement-report-dataset"; +export { default as ThirdPartyPartnerLiftRequest } from "./src/objects/third-party-partner-lift-request"; +export { default as ThirdPartyPartnerPanelRequest } from "./src/objects/third-party-partner-panel-request"; +export { default as ThirdPartyPartnerPanelScheduled } from "./src/objects/third-party-partner-panel-scheduled"; +export { default as ThirdPartyPartnerViewabilityRequest } from "./src/objects/third-party-partner-viewability-request"; +export { default as TimeSuggestion } from "./src/objects/time-suggestion"; +export { default as TimezoneOffset } from "./src/objects/timezone-offset"; +export { default as TrackingAndConversionWithDefaults } from "./src/objects/tracking-and-conversion-with-defaults"; +export { default as TransactableItem } from "./src/objects/transactable-item"; +export { default as Transaction } from "./src/objects/transaction"; +export { default as URL } from "./src/objects/url"; +export { default as UnifiedThread } from "./src/objects/unified-thread"; +export { default as UniqueAdCreative } from "./src/objects/unique-ad-creative"; +export { default as User } from "./src/objects/user"; +export { default as UserAvailableCatalogs } from "./src/objects/user-available-catalogs"; +export { default as UserContext } from "./src/objects/user-context"; +export { default as UserCoverPhoto } from "./src/objects/user-cover-photo"; +export { default as UserDevice } from "./src/objects/user-device"; +export { default as UserIDForApp } from "./src/objects/user-id-for-app"; +export { default as UserIDForPage } from "./src/objects/user-id-for-page"; +export { default as UserLeadGenDisclaimerResponse } from "./src/objects/user-lead-gen-disclaimer-response"; +export { default as UserLeadGenFieldData } from "./src/objects/user-lead-gen-field-data"; +export { default as UserMobileConfig } from "./src/objects/user-mobile-config"; +export { default as UserNotificationSeenStateData } from "./src/objects/user-notification-seen-state-data"; +export { default as UserPageOneTimeOptInTokenSettings } from "./src/objects/user-page-one-time-opt-in-token-settings"; +export { default as UserPaymentMethodsInfo } from "./src/objects/user-payment-methods-info"; +export { default as UserPaymentMobilePricepoints } from "./src/objects/user-payment-mobile-pricepoints"; +export { default as UserPaymentModulesOptions } from "./src/objects/user-payment-modules-options"; +export { default as UserSetReportingRoot } from "./src/objects/user-set-reporting-root"; +export { default as ValueBasedEligibleSource } from "./src/objects/value-based-eligible-source"; +export { default as Vehicle } from "./src/objects/vehicle"; +export { default as VehicleOffer } from "./src/objects/vehicle-offer"; +export { default as VideoAsset } from "./src/objects/video-asset"; +export { default as VideoCopyright } from "./src/objects/video-copyright"; +export { default as VideoCopyrightCheckStatus } from "./src/objects/video-copyright-check-status"; +export { default as VideoCopyrightConditionGroup } from "./src/objects/video-copyright-condition-group"; +export { default as VideoCopyrightGeoGate } from "./src/objects/video-copyright-geo-gate"; +export { default as VideoCopyrightMatch } from "./src/objects/video-copyright-match"; +export { default as VideoCopyrightRule } from "./src/objects/video-copyright-rule"; +export { default as VideoCopyrightSegment } from "./src/objects/video-copyright-segment"; +export { default as VideoGroup } from "./src/objects/video-group"; +export { default as VideoList } from "./src/objects/video-list"; +export { default as VideoMetricsReport } from "./src/objects/video-metrics-report"; +export { default as VideoPoll } from "./src/objects/video-poll"; +export { default as VideoStats } from "./src/objects/video-stats"; +export { default as VideoStatus } from "./src/objects/video-status"; +export { default as VideoStatusError } from "./src/objects/video-status-error"; +export { default as VideoStatusProcessingPhase } from "./src/objects/video-status-processing-phase"; +export { default as VideoStatusPublishingPhase } from "./src/objects/video-status-publishing-phase"; +export { default as VideoStatusUploadingPhase } from "./src/objects/video-status-uploading-phase"; +export { default as VideoTextQuestion } from "./src/objects/video-text-question"; +export { default as VideoThumbnail } from "./src/objects/video-thumbnail"; +export { default as VideoUploadLimits } from "./src/objects/video-upload-limits"; +export { default as VidwallaBroadcast } from "./src/objects/vidwalla-broadcast"; +export { default as VoipInfo } from "./src/objects/voip-info"; +export { default as WITUser } from "./src/objects/wit-user"; +export { default as WearableDevicePublicKey } from "./src/objects/wearable-device-public-key"; +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 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"; +export { default as WhatsAppBusinessPartnerClientVerificationSubmission } from "./src/objects/whats-app-business-partner-client-verification-submission"; +export { default as WhatsAppBusinessPreVerifiedPhoneNumber } from "./src/objects/whats-app-business-pre-verified-phone-number"; +export { default as WhatsAppBusinessProfile } from "./src/objects/whats-app-business-profile"; +export { default as WhatsAppPaymentCapabilities } from "./src/objects/whats-app-payment-capabilities"; +export { default as WhatsappSubscribedAppsInfo } from "./src/objects/whatsapp-subscribed-apps-info"; +export { default as WhitehatFBDLRun } from "./src/objects/whitehat-fbdl-run"; +export { default as WifiInformation } from "./src/objects/wifi-information"; +export { default as WindowsAppLink } from "./src/objects/windows-app-link"; +export { default as WindowsPhoneAppLink } from "./src/objects/windows-phone-app-link"; +export { default as WithAsset3D } from "./src/objects/with-asset3-d"; +export { default as WoodhengePurchasedPAYGReceipt } from "./src/objects/woodhenge-purchased-payg-receipt"; +export { default as WoodhengeSupporter } from "./src/objects/woodhenge-supporter"; +export { default as WorkAccessCode } from "./src/objects/work-access-code"; +export { default as WorkExperience } from "./src/objects/work-experience"; +export { default as WorkSkill } from "./src/objects/work-skill"; +export { default as WorkUserBadges } from "./src/objects/work-user-badges"; +export { default as WorkUserFrontline } from "./src/objects/work-user-frontline"; diff --git a/types/facebook-nodejs-business-sdk/package.json b/types/facebook-nodejs-business-sdk/package.json index d7cbaf2caa79b9..340363dd25ca3f 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": "18.0.9999", + "version": "20.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 7b061d7d35d02a..4786ce58aa5f2b 100644 --- a/types/facebook-nodejs-business-sdk/scripts/package.json +++ b/types/facebook-nodejs-business-sdk/scripts/package.json @@ -2,7 +2,7 @@ "private": true, "devDependencies": { "@khanacademy/flow-to-ts": "^0.5.2", - "facebook-nodejs-business-sdk": "^15.0.0", + "facebook-nodejs-business-sdk": "^20.0.0", "typescript": "^4.8.4" } } diff --git a/types/facebook-nodejs-business-sdk/src/abstract-crud-object.d.ts b/types/facebook-nodejs-business-sdk/src/abstract-crud-object.d.ts index 52188066ba2d57..0fde11ec6008aa 100644 --- a/types/facebook-nodejs-business-sdk/src/abstract-crud-object.d.ts +++ b/types/facebook-nodejs-business-sdk/src/abstract-crud-object.d.ts @@ -1,9 +1,9 @@ -import FacebookAdsApi from './api'; -import AbstractObject from './abstract-object'; -import Cursor from './cursor'; +import FacebookAdsApi from "./api"; +import AbstractObject from "./abstract-object"; +import Cursor from "./cursor"; export class AbstractCrudObject extends AbstractObject { _parentId: string | null | undefined; - _changes: Record; + _changes: Record; _api: FacebookAdsApi; id: string; /** @@ -11,7 +11,7 @@ export class AbstractCrudObject extends AbstractObject { * @param {String} parentId * @param {FacebookAdApi} [api] */ - constructor(id?: number | string | null, data?: Record, parentId?: string | null, api?: FacebookAdsApi | null); + constructor(id?: number |string | null, data?: Record, parentId?: string | null , api?: FacebookAdsApi | null ); /** * Define data getter and setter recording changes * @param {String} field @@ -22,22 +22,22 @@ export class AbstractCrudObject extends AbstractObject { * @param {Object} data * @return this */ - setData(data: Record): AbstractCrudObject; + setData(data: Record): AbstractCrudObject; /** * Export changed object data * @return {Object} */ - exportData(): Record; + exportData(): Record; /** * Export object data * @return {Object} */ - exportAllData(): Record; + exportAllData(): Record; /** * Clear change history * @return this */ - clearHistory(): Record; + clearHistory(): Record; /** * @throws {Error} if object has no id * @return {String} @@ -64,19 +64,19 @@ export class AbstractCrudObject extends AbstractObject { * @param {Object} [params] * @return {Promise} */ - read(fields: string[], params?: Record): Promise; + read(fields: string[], params?: Record): Promise; /** * Update object * @param {Object} [params] * @return {Promise} */ - update(params?: Record): Promise; + update(params?: Record): Promise; /** * Delete object * @param {Object} [params] * @return {Promise} */ - delete(params?: Record): Promise; + delete(params?: Record): Promise; /** * Initialize Cursor to paginate on edges * @param {Object} targetClass @@ -86,7 +86,7 @@ export class AbstractCrudObject extends AbstractObject { * @param {String} [endpoint] * @return {Cursor} */ - getEdge(targetClass: Record, fields: string[], params?: Record, fetchFirstPage?: boolean, endpoint?: string | null): Cursor | Promise; + getEdge(targetClass: Record, fields: string[], params: Record, fetchFirstPage: boolean, endpoint: string | null | undefined): Cursor | Promise; /** * Create edge object * @param {String} [endpoint] @@ -95,14 +95,14 @@ export class AbstractCrudObject extends AbstractObject { * @param {Function} [targetClassConstructor] * @return {Promise} */ - createEdge(endpoint: string, fields: string[], params?: Record, targetClassConstructor?: any, pathOverride?: string | null): Promise; + createEdge(endpoint: string, fields: string[], params?: Record, targetClassConstructor?: (...args: any[]) => any, pathOverride?: string | null): Promise; /** * Delete edge object * @param {String} [endpoint] * @param {Object} [params] * @return {Promise} */ - deleteEdge(endpoint: string, params?: Record): Promise; + deleteEdge(endpoint: string, params?: Record): Promise; /** * Read Objects by Ids * @param {Array} ids @@ -111,6 +111,6 @@ export class AbstractCrudObject extends AbstractObject { * @param {FacebookAdsApi} [api] * @return {Promise} */ - static getByIds(ids: number[], fields: string[], params: Record | null | undefined, api: FacebookAdsApi): Promise; + static getByIds(ids: number[], fields: string[], params: Record, api: FacebookAdsApi): Promise; } export default AbstractCrudObject; diff --git a/types/facebook-nodejs-business-sdk/src/abstract-object.d.ts b/types/facebook-nodejs-business-sdk/src/abstract-object.d.ts index 222005f0ec14df..23b371b57ff612 100644 --- a/types/facebook-nodejs-business-sdk/src/abstract-object.d.ts +++ b/types/facebook-nodejs-business-sdk/src/abstract-object.d.ts @@ -3,7 +3,7 @@ export default class AbstractObject { _fields: string[]; $key: string; $value: unknown; - static get Fields(): Record; + static get Fields(): {}; constructor(); /** * Define data getter and setter field @@ -22,10 +22,10 @@ export default class AbstractObject { * @param {Object} data * @return this */ - setData(data: Record): AbstractObject; + setData(data: Record): AbstractObject; /** * Export object data * @return {Object} */ - exportData(): Record; + exportData(): Record; } diff --git a/types/facebook-nodejs-business-sdk/src/api-batch.d.ts b/types/facebook-nodejs-business-sdk/src/api-batch.d.ts index 5a36b620ef2d4a..ad7fc77c4fe0ee 100644 --- a/types/facebook-nodejs-business-sdk/src/api-batch.d.ts +++ b/types/facebook-nodejs-business-sdk/src/api-batch.d.ts @@ -1,21 +1,21 @@ -import FacebookAdsApi from './api'; -import APIRequest from './api-request'; +import FacebookAdsApi from "./api"; +import APIRequest from "./api-request"; /** * Facebook Ads API Batch */ declare class FacebookAdsApiBatch { _api: FacebookAdsApi; - _files: Array>; - _batch: Array>; - _successCallbacks: any[]; - _failureCallbacks: any[]; + _files: Array>; + _batch: Array>; + _successCallbacks: Array<(...args: any[]) => any>; + _failureCallbacks: Array<(...args: any[]) => any>; _requests: APIRequest[]; /** * @param {FacebookAdsApi} api * @param {Function} successCallback * @param {Function} failureCallback */ - constructor(api: FacebookAdsApi, successCallback?: any, failureCallback?: any); + constructor(api: FacebookAdsApi, successCallback?: (...args: any[]) => any, failureCallback?: (...args: any[]) => any); /** * Adds a call to the batch. * @param {string} method The HTTP method name (e.g. 'GET'). @@ -35,7 +35,7 @@ declare class FacebookAdsApiBatch { * @param {APIRequest} [request] The APIRequest object * @return {Object} An object describing the call */ - add(method: string, relativePath: string[] | string, params?: Record, files?: Record, successCallback?: any, failureCallback?: any, request?: APIRequest): { + add(method: string, relativePath: string[] | string, params?: Record, files?: Record, successCallback?: (...args: any[]) => any, failureCallback?: (...args: any[]) => any, request?: APIRequest): { attachedFiles: undefined | string; body: undefined | string; method: string; @@ -51,7 +51,7 @@ declare class FacebookAdsApiBatch { * will be called with the FacebookResponse of this call if the call failed. * @return {Object} An object describing the call */ - addRequest(request: APIRequest, successCallback?: any, failureCallback?: any): { + addRequest(request: APIRequest, successCallback?: (...args: any[]) => any, failureCallback?: (...args: any[]) => any): { attachedFiles: undefined | string; body: undefined | string; method: string; diff --git a/types/facebook-nodejs-business-sdk/src/api-request.d.ts b/types/facebook-nodejs-business-sdk/src/api-request.d.ts index 4dfb5ba1dc2df4..e0e0df456cab3c 100644 --- a/types/facebook-nodejs-business-sdk/src/api-request.d.ts +++ b/types/facebook-nodejs-business-sdk/src/api-request.d.ts @@ -7,8 +7,8 @@ declare class APIRequest { _endpoint: string; _path: string[]; _fields: string[]; - _params: Record; - _fileParams: Record; + _params: Record; + _fileParams: Record; _fileCounter: number; /** * @param {string} nodeId The node id to perform the api call. @@ -33,24 +33,24 @@ declare class APIRequest { get endpoint(): string; /** * Getter function for path tokens - * @return {string[]} Array of path tokens + * @return {Array} Array of path tokens */ get path(): string[]; /** * Getter function for requested fields - * @return {string[]} Array of request fields + * @return {Array} Array of request fields */ get fields(): string[]; /** * Getter function for API params * @return {Object} Object containing API Params */ - get params(): Record; + get params(): Record; /** * Getter function for API fileparams * @return {Object} Object containing API fileParams */ - get fileParams(): Record; + get fileParams(): Record; /** * @param {string} filePath Path to file attached to the request * @return {APIReqeust} APIRequest instance @@ -81,6 +81,6 @@ declare class APIRequest { * @param {Object} params An object containing param keys and values * @return {APIRequest} APIRequest instance */ - addParams(params: Record): APIRequest; + addParams(params: Record): APIRequest; } export default APIRequest; diff --git a/types/facebook-nodejs-business-sdk/src/api-response.d.ts b/types/facebook-nodejs-business-sdk/src/api-response.d.ts index d3c089b6560784..18ea774e4318ad 100644 --- a/types/facebook-nodejs-business-sdk/src/api-response.d.ts +++ b/types/facebook-nodejs-business-sdk/src/api-response.d.ts @@ -2,12 +2,12 @@ * Encapsulates an http response from Facebook's Graph API. */ declare class APIResponse { - _body: Record; + _body: Record; _httpStatus: string; - _headers: Record; - _call: Record; - _response: Record; - constructor(response: Record, call?: Record); + _headers: Record; + _call: Record; + _response: Record; + constructor(response: Record, call?: Record); /** * @return {Object} The response body */ diff --git a/types/facebook-nodejs-business-sdk/src/api.d.ts b/types/facebook-nodejs-business-sdk/src/api.d.ts index fbbe5d18ee9488..462f45120790c8 100644 --- a/types/facebook-nodejs-business-sdk/src/api.d.ts +++ b/types/facebook-nodejs-business-sdk/src/api.d.ts @@ -36,6 +36,6 @@ export default class FacebookAdsApi { * @param {Object} [files] * @return {Promise} */ - call(method: string, path: string | string[] | string, params?: Record, files?: Record, useMultipartFormData?: boolean, urlOverride?: string): Promise; - static _encodeParams(params: Record): string; + call(method: string, path: string | string[] | string, params?: Record, files?: Record, useMultipartFormData?: boolean, urlOverride?: string): Promise; + static _encodeParams(params: Record): string; } diff --git a/types/facebook-nodejs-business-sdk/src/cursor.d.ts b/types/facebook-nodejs-business-sdk/src/cursor.d.ts index 3e0052d6c4c440..2c33339ed3a592 100644 --- a/types/facebook-nodejs-business-sdk/src/cursor.d.ts +++ b/types/facebook-nodejs-business-sdk/src/cursor.d.ts @@ -1,10 +1,10 @@ -import FacebookAdsApi from './api'; -export default class Cursor extends Array> { - sourceObject: Record; +import FacebookAdsApi from "./api"; +export default class Cursor extends Array> { + sourceObject: Record; _api: FacebookAdsApi; - _targetClass: Record; + _targetClass: Record; _loadPage: (path: string) => Promise; - _buildObjectsFromResponse: (response: Record) => Array>; + _buildObjectsFromResponse: (response: Record) => Array>; paging: any; summary: any; headers: any; @@ -13,12 +13,12 @@ export default class Cursor extends Array> { previous: () => Promise; hasNext: () => boolean; hasPrevious: () => boolean; - set: (array: Array>) => void; + set: (array: Array>) => void; /** * @param {Object} sourceObject * @param {Object} targetClass * @param {Object} [params] * @param {String} [endpoint] */ - constructor(sourceObject: Record, targetClass: Record, params: Record, endpoint?: string | null); + constructor(sourceObject: Record, targetClass: Record, params: Record, endpoint: string | null | undefined); } diff --git a/types/facebook-nodejs-business-sdk/src/exceptions.d.ts b/types/facebook-nodejs-business-sdk/src/exceptions.d.ts index cca3ecae5c404b..82609300c336e7 100644 --- a/types/facebook-nodejs-business-sdk/src/exceptions.d.ts +++ b/types/facebook-nodejs-business-sdk/src/exceptions.d.ts @@ -1,26 +1,17 @@ +declare function FacebookError(error: any): void; +declare namespace FacebookError { + var prototype: any; +} /** * Raised when an api request fails. */ -export class FacebookRequestError extends FacebookError { +export declare class FacebookRequestError extends FacebookError { /** - * @param {Object} response + * @param {[Object} response * @param {String} method * @param {String} url * @param {Object} data */ - constructor(response: any, method: string, url: string, data: any); - status: any; - response: any; - headers: any; - method: string; - url: string; - data: any; -} -declare function FacebookError(error: any): void; -declare class FacebookError { - constructor(error: any); - name: string; - message: any; - stack: string; + constructor(response: any, method: any, url: any, data: any); } export {}; diff --git a/types/facebook-nodejs-business-sdk/src/http-status.d.ts b/types/facebook-nodejs-business-sdk/src/http-status.d.ts index b7fc960c9e46c7..8bbfd30ad04411 100644 --- a/types/facebook-nodejs-business-sdk/src/http-status.d.ts +++ b/types/facebook-nodejs-business-sdk/src/http-status.d.ts @@ -1,5 +1,14 @@ -declare namespace _default { - let OK: string; - let NOT_MODIFIED: string; -} +/** + * Copyright (c) 2017-present, Facebook, Inc. + * All rights reserved. + * + * This source code is licensed under the license found in the + * LICENSE file in the root directory of this source tree. + * + * @format + */ +declare const _default: { + OK: string; + NOT_MODIFIED: string; +}; export default _default; diff --git a/types/facebook-nodejs-business-sdk/src/http.d.ts b/types/facebook-nodejs-business-sdk/src/http.d.ts index 3bfca234963bfe..ecc89f0719653e 100644 --- a/types/facebook-nodejs-business-sdk/src/http.d.ts +++ b/types/facebook-nodejs-business-sdk/src/http.d.ts @@ -6,7 +6,7 @@ export default class Http { * @param {Object} [data] * @return {Promise} */ - static request(method: string, url: string, data: Record, files: Record, useMultipartFormData: boolean, showHeader: boolean): Promise; + static request(method: string, url: string, data: Record, files: Record, useMultipartFormData: Boolean, showHeader: Boolean): Promise; /** * XmlHttpRequest request * @param {String} method @@ -28,5 +28,5 @@ export default class Http { * multipart/form-data. * @return {Promise} */ - static requestPromise(method: string, url: string, data: Record, files: Record, useMultipartFormData?: boolean, showHeader?: boolean): Promise; + static requestPromise(method: string, url: string, data: Record, files: Record, useMultipartFormData?: Boolean, showHeader?: Boolean): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-aaa-compatible-ad-objects.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-aaa-compatible-ad-objects.d.ts new file mode 100644 index 00000000000000..c944c7a4271c53 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-aaa-compatible-ad-objects.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdAccountAAACompatibleAdObjects + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdAccountAAACompatibleAdObjects extends AbstractCrudObject { + static get Fields(): Readonly<{ + adgroup_ids: "adgroup_ids"; + campaign_group_ids: "campaign_group_ids"; + campaign_ids: "campaign_ids"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-aaa-similar-campaigns.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-aaa-similar-campaigns.d.ts new file mode 100644 index 00000000000000..307a8f2e6a3cf1 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-aaa-similar-campaigns.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdAccountAAASimilarCampaigns + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdAccountAAASimilarCampaigns extends AbstractCrudObject { + static get Fields(): Readonly<{ + similar_campaign_limit: "similar_campaign_limit"; + similar_campaigns_info: "similar_campaigns_info"; + used_campaign_slots: "used_campaign_slots"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-ad-limits-insights.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-ad-limits-insights.d.ts new file mode 100644 index 00000000000000..d8b760ed0d51d7 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-ad-limits-insights.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdAccountAdLimitsInsights + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdAccountAdLimitsInsights extends AbstractCrudObject { + static get Fields(): Readonly<{ + date_start: "date_start"; + date_stop: "date_stop"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-ad-rules-count-by-type.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-ad-rules-count-by-type.d.ts new file mode 100644 index 00000000000000..ab768894fb552c --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-ad-rules-count-by-type.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdAccountAdRulesCountByType + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdAccountAdRulesCountByType extends AbstractCrudObject { + static get Fields(): Readonly<{ + count: "count"; + evaluation_type: "evaluation_type"; + }>; +} 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 2ed04ac0fdabce..bf6309af7667bd 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 @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdAccountAdRulesHistory * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -20,8 +20,14 @@ export default class AdAccountAdRulesHistory extends AbstractCrudObject { changed_bid: "CHANGED_BID"; changed_budget: "CHANGED_BUDGET"; email: "EMAIL"; + enable_advantage_campaign_budget: "ENABLE_ADVANTAGE_CAMPAIGN_BUDGET"; enable_advantage_plus_creative: "ENABLE_ADVANTAGE_PLUS_CREATIVE"; + enable_advantage_plus_placements: "ENABLE_ADVANTAGE_PLUS_PLACEMENTS"; enable_autoflow: "ENABLE_AUTOFLOW"; + enable_gen_uncrop: "ENABLE_GEN_UNCROP"; + enable_music: "ENABLE_MUSIC"; + enable_semantic_based_audience_expansion: "ENABLE_SEMANTIC_BASED_AUDIENCE_EXPANSION"; + enable_shops_ads: "ENABLE_SHOPS_ADS"; endpoint_pinged: "ENDPOINT_PINGED"; error: "ERROR"; facebook_notification_sent: "FACEBOOK_NOTIFICATION_SENT"; 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 bb22a3c4d31dd5..8fc7e46f00f4a8 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 @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdAccountAdVolume * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -19,17 +19,27 @@ export default class AdAccountAdVolume extends AbstractCrudObject { recommendations: "recommendations"; }>; static get RecommendationType(): Readonly<{ + aac_creation_package: "AAC_CREATION_PACKAGE"; ab_test: "AB_TEST"; account_spend_limit: "ACCOUNT_SPEND_LIMIT"; aco_toggle: "ACO_TOGGLE"; ads_reporting: "ADS_REPORTING"; advanced_campaign_budget: "ADVANCED_CAMPAIGN_BUDGET"; + advantage_app_campaign: "ADVANTAGE_APP_CAMPAIGN"; advantage_custom_audience: "ADVANTAGE_CUSTOM_AUDIENCE"; advantage_custom_audience_upsell: "ADVANTAGE_CUSTOM_AUDIENCE_UPSELL"; + advantage_detailed_targeting: "ADVANTAGE_DETAILED_TARGETING"; + advantage_lookalike_audience: "ADVANTAGE_LOOKALIKE_AUDIENCE"; + advantage_plus_audience: "ADVANTAGE_PLUS_AUDIENCE"; + advantage_plus_audience_duplication: "ADVANTAGE_PLUS_AUDIENCE_DUPLICATION"; advantage_plus_audience_friction: "ADVANTAGE_PLUS_AUDIENCE_FRICTION"; advantage_plus_audience_toggle: "ADVANTAGE_PLUS_AUDIENCE_TOGGLE"; + advantage_plus_campaign_budget: "ADVANTAGE_PLUS_CAMPAIGN_BUDGET"; advantage_plus_creative: "ADVANTAGE_PLUS_CREATIVE"; advantage_plus_creative_catalog: "ADVANTAGE_PLUS_CREATIVE_CATALOG"; + advantage_plus_creative_se: "ADVANTAGE_PLUS_CREATIVE_SE"; + advantage_plus_placements_duplication: "ADVANTAGE_PLUS_PLACEMENTS_DUPLICATION"; + advantage_plus_placements_friction: "ADVANTAGE_PLUS_PLACEMENTS_FRICTION"; advantage_shopping_campaign: "ADVANTAGE_SHOPPING_CAMPAIGN"; advantage_shopping_campaign_fragmentation: "ADVANTAGE_SHOPPING_CAMPAIGN_FRAGMENTATION"; ad_objective: "AD_OBJECTIVE"; @@ -39,30 +49,41 @@ export default class AdAccountAdVolume extends AbstractCrudObject { aggregated_cost_limited: "AGGREGATED_COST_LIMITED"; app_aem_v2_installation_promotion: "APP_AEM_V2_INSTALLATION_PROMOTION"; asc_budget_optimization: "ASC_BUDGET_OPTIMIZATION"; - asc_budget_optimization_pfr: "ASC_BUDGET_OPTIMIZATION_PFR"; + asc_creation_package: "ASC_CREATION_PACKAGE"; + asc_fragmentation_v2: "ASC_FRAGMENTATION_V2"; aspect_ratio: "ASPECT_RATIO"; atleast_6_placements: "ATLEAST_6_PLACEMENTS"; auction_overlap: "AUCTION_OVERLAP"; auction_overlap_consolidation: "AUCTION_OVERLAP_CONSOLIDATION"; audience_expansion: "AUDIENCE_EXPANSION"; + audience_expansion_georadius: "AUDIENCE_EXPANSION_GEORADIUS"; audience_expansion_retargeting: "AUDIENCE_EXPANSION_RETARGETING"; audience_learning_limited: "AUDIENCE_LEARNING_LIMITED"; 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"; automatic_placements: "AUTOMATIC_PLACEMENTS"; + automatic_placements_v2: "AUTOMATIC_PLACEMENTS_V2"; auto_bid: "AUTO_BID"; + blended_ads: "BLENDED_ADS"; broad_targeting: "BROAD_TARGETING"; + budget_limited: "BUDGET_LIMITED"; capi: "CAPI"; 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"; + connected_sources: "CONNECTED_SOURCES"; connect_facebook_page_to_instagram: "CONNECT_FACEBOOK_PAGE_TO_INSTAGRAM"; connect_facebook_page_to_whatsapp: "CONNECT_FACEBOOK_PAGE_TO_WHATSAPP"; + conversion_lead_ads: "CONVERSION_LEAD_ADS"; cost_goal: "COST_GOAL"; cost_goal_budget_limited: "COST_GOAL_BUDGET_LIMITED"; cost_goal_cpa_limited: "COST_GOAL_CPA_LIMITED"; cost_per_result: "COST_PER_RESULT"; creation_package_upgrade_to_asc: "CREATION_PACKAGE_UPGRADE_TO_ASC"; + creation_package_upgrade_to_ctx: "CREATION_PACKAGE_UPGRADE_TO_CTX"; creation_package_upgrade_to_tla: "CREATION_PACKAGE_UPGRADE_TO_TLA"; + creation_package_upgrade_to_tmc: "CREATION_PACKAGE_UPGRADE_TO_TMC"; creative_badge: "CREATIVE_BADGE"; creative_diversity: "CREATIVE_DIVERSITY"; creative_fatigue: "CREATIVE_FATIGUE"; @@ -71,15 +92,26 @@ export default class AdAccountAdVolume extends AbstractCrudObject { creative_limited_hourly: "CREATIVE_LIMITED_HOURLY"; creator_ads_pa_conversion: "CREATOR_ADS_PA_CONVERSION"; cta: "CTA"; + ctx_budget_optimization: "CTX_BUDGET_OPTIMIZATION"; + ctx_creation_package: "CTX_CREATION_PACKAGE"; + ctx_guidance: "CTX_GUIDANCE"; da_advantage_plus_creative_info_labels: "DA_ADVANTAGE_PLUS_CREATIVE_INFO_LABELS"; + da_duplication_product_tags: "DA_DUPLICATION_PRODUCT_TAGS"; dead_link: "DEAD_LINK"; + defragmentation_acb: "DEFRAGMENTATION_ACB"; dynamic_advantage_campaign_budget: "DYNAMIC_ADVANTAGE_CAMPAIGN_BUDGET"; ecosystem_bid_reduce_l1_cardinality: "ECOSYSTEM_BID_REDUCE_L1_CARDINALITY"; + evc_app_duplication_upgrade: "EVC_APP_DUPLICATION_UPGRADE"; + evc_web_duplication_upgrade: "EVC_WEB_DUPLICATION_UPGRADE"; fragmentation: "FRAGMENTATION"; + fragmentation_v2: "FRAGMENTATION_V2"; ges_test: "GES_TEST"; guidance_center_code_gen: "GUIDANCE_CENTER_CODE_GEN"; + heuristic_default_duration: "HEURISTIC_DEFAULT_DURATION"; high_cost: "HIGH_COST"; historical_benchmark: "HISTORICAL_BENCHMARK"; + ig_multi_ads: "IG_MULTI_ADS"; + lead_ads_guidance: "LEAD_ADS_GUIDANCE"; learning_limited: "LEARNING_LIMITED"; learning_pause_friction: "LEARNING_PAUSE_FRICTION"; learning_phase_budget_edits: "LEARNING_PHASE_BUDGET_EDITS"; @@ -92,25 +124,36 @@ export default class AdAccountAdVolume extends AbstractCrudObject { multi_text: "MULTI_TEXT"; music: "MUSIC"; not_applicable: "NOT_APPLICABLE"; + no_delivery_status: "NO_DELIVERY_STATUS"; optimal_bau: "OPTIMAL_BAU"; payment_method: "PAYMENT_METHOD"; performant_creative_reels_opt_in: "PERFORMANT_CREATIVE_REELS_OPT_IN"; pfr_l1_inline_mmt: "PFR_L1_INLINE_MMT"; + pixel_upsell: "PIXEL_UPSELL"; predictive_creative_limited: "PREDICTIVE_CREATIVE_LIMITED"; predictive_creative_limited_hourly: "PREDICTIVE_CREATIVE_LIMITED_HOURLY"; + preparing_status: "PREPARING_STATUS"; + purchase_optimization: "PURCHASE_OPTIMIZATION"; rapid_learning_limited: "RAPID_LEARNING_LIMITED"; rapid_learning_phase: "RAPID_LEARNING_PHASE"; reels_duplication_upsell: "REELS_DUPLICATION_UPSELL"; + reels_placement: "REELS_PLACEMENT"; revert: "REVERT"; scale_good_campaign: "SCALE_GOOD_CAMPAIGN"; semantic_based_audience_expansion: "SEMANTIC_BASED_AUDIENCE_EXPANSION"; setup_pixel: "SETUP_PIXEL"; shops_ads: "SHOPS_ADS"; + shops_ads_duplication: "SHOPS_ADS_DUPLICATION"; signals_growth_capi: "SIGNALS_GROWTH_CAPI"; signals_growth_capi_table: "SIGNALS_GROWTH_CAPI_TABLE"; + signals_growth_capi_v2: "SIGNALS_GROWTH_CAPI_V2"; + similar_advertiser_budget_recommendation: "SIMILAR_ADVERTISER_BUDGET_RECOMMENDATION"; six_plus_manual_placements: "SIX_PLUS_MANUAL_PLACEMENTS"; spend_limit: "SPEND_LIMIT"; syd_test_mode: "SYD_TEST_MODE"; + tailored_lead_ad_campaign: "TAILORED_LEAD_AD_CAMPAIGN"; + tailored_messages_campaign: "TAILORED_MESSAGES_CAMPAIGN"; + 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"; two_p_guidance_card_aaa: "TWO_P_GUIDANCE_CARD_AAA"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-ads-recommended-audios.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-ads-recommended-audios.d.ts new file mode 100644 index 00000000000000..155aabe09491f2 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-ads-recommended-audios.d.ts @@ -0,0 +1,10 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdAccountAdsRecommendedAudios + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdAccountAdsRecommendedAudios extends AbstractCrudObject { + static get Fields(): Readonly<{ + audio_assets: "audio_assets"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-all-payment-methods.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-all-payment-methods.d.ts new file mode 100644 index 00000000000000..05cb0ac7cd2460 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-all-payment-methods.d.ts @@ -0,0 +1,8 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdAccountAllPaymentMethods + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdAccountAllPaymentMethods extends AbstractCrudObject { + static get Fields(): Readonly<{}>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-app-setup-requirements.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-app-setup-requirements.d.ts new file mode 100644 index 00000000000000..14eb7cc6bdab1c --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-app-setup-requirements.d.ts @@ -0,0 +1,8 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdAccountAppSetupRequirements + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdAccountAppSetupRequirements extends AbstractCrudObject { + static get Fields(): Readonly<{}>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-asl-schedule.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-asl-schedule.d.ts new file mode 100644 index 00000000000000..ff614919f00f09 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-asl-schedule.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdAccountASLSchedule + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdAccountASLSchedule extends AbstractCrudObject { + static get Fields(): Readonly<{ + ad_account: "ad_account"; + id: "id"; + time_created: "time_created"; + time_updated: "time_updated"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-bank-info-list.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-bank-info-list.d.ts new file mode 100644 index 00000000000000..b43a37ee15aa35 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-bank-info-list.d.ts @@ -0,0 +1,10 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdAccountBankInfoList + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdAccountBankInfoList extends AbstractCrudObject { + static get Fields(): Readonly<{ + banks: "banks"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-billing-date-preference.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-billing-date-preference.d.ts new file mode 100644 index 00000000000000..224b5c4497f91b --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-billing-date-preference.d.ts @@ -0,0 +1,15 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdAccountBillingDatePreference + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdAccountBillingDatePreference extends AbstractCrudObject { + static get Fields(): Readonly<{ + ad_account: "ad_account"; + day_of_month: "day_of_month"; + id: "id"; + next_bill_date: "next_bill_date"; + time_created: "time_created"; + time_effective: "time_effective"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-business-constraints.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-business-constraints.d.ts index 455cce013342af..576b21b3611a7a 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-account-business-constraints.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-business-constraints.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdAccountBusinessConstraints * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -6,6 +6,13 @@ import { AbstractCrudObject } from './../abstract-crud-object'; export default class AdAccountBusinessConstraints extends AbstractCrudObject { static get Fields(): Readonly<{ audience_controls: "audience_controls"; + campaigns_with_error: "campaigns_with_error"; placement_controls: "placement_controls"; + status: "status"; + }>; + static get Status(): Readonly<{ + active: "ACTIVE"; + application_in_progress: "APPLICATION_IN_PROGRESS"; + with_campaign_error: "WITH_CAMPAIGN_ERROR"; }>; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-campaign-attribution-option-info.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-campaign-attribution-option-info.d.ts new file mode 100644 index 00000000000000..90191bf9a5a70b --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-campaign-attribution-option-info.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdAccountCampaignAttributionOptionInfo + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdAccountCampaignAttributionOptionInfo extends AbstractCrudObject { + static get Fields(): Readonly<{ + is_eligible: "is_eligible"; + value: "value"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-creation-request.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-creation-request.d.ts new file mode 100644 index 00000000000000..460ec919c91d53 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-creation-request.d.ts @@ -0,0 +1,47 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; +/** + * AdAccountCreationRequest + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdAccountCreationRequest extends AbstractCrudObject { + static get Fields(): Readonly<{ + ad_accounts_currency: "ad_accounts_currency"; + ad_accounts_info: "ad_accounts_info"; + additional_comment: "additional_comment"; + address_in_chinese: "address_in_chinese"; + address_in_english: "address_in_english"; + address_in_local_language: "address_in_local_language"; + advertiser_business: "advertiser_business"; + appeal_reason: "appeal_reason"; + business: "business"; + business_registration_id: "business_registration_id"; + chinese_legal_entity_name: "chinese_legal_entity_name"; + contact: "contact"; + creator: "creator"; + credit_card_id: "credit_card_id"; + disapproval_reasons: "disapproval_reasons"; + english_legal_entity_name: "english_legal_entity_name"; + extended_credit_id: "extended_credit_id"; + id: "id"; + is_smb: "is_smb"; + is_test: "is_test"; + legal_entity_name_in_local_language: "legal_entity_name_in_local_language"; + oe_request_id: "oe_request_id"; + official_website_url: "official_website_url"; + planning_agency_business: "planning_agency_business"; + planning_agency_business_id: "planning_agency_business_id"; + promotable_app_ids: "promotable_app_ids"; + promotable_page_ids: "promotable_page_ids"; + promotable_urls: "promotable_urls"; + request_change_reasons: "request_change_reasons"; + status: "status"; + subvertical: "subvertical"; + subvertical_v2: "subvertical_v2"; + time_created: "time_created"; + vertical: "vertical"; + vertical_v2: "vertical_v2"; + }>; + getAdAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-custom-audience-limits.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-custom-audience-limits.d.ts new file mode 100644 index 00000000000000..14cc3061bdcca2 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-custom-audience-limits.d.ts @@ -0,0 +1,14 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdAccountCustomAudienceLimits + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdAccountCustomAudienceLimits extends AbstractCrudObject { + static get Fields(): Readonly<{ + audience_update_quota_in_total: "audience_update_quota_in_total"; + audience_update_quota_left: "audience_update_quota_left"; + has_hit_audience_update_limit: "has_hit_audience_update_limit"; + next_audience_update_available_time: "next_audience_update_available_time"; + rate_limit_reset_time: "rate_limit_reset_time"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-default-destination.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-default-destination.d.ts index 0c9248a176bfcd..faf56d4e8353e7 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-account-default-destination.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-default-destination.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdAccountDefaultDestination * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-default-objective.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-default-objective.d.ts index 61be07de01015f..646d18c2e6e398 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-account-default-objective.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-default-objective.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdAccountDefaultObjective * @see {@link https://developers.facebook.com/docs/marketing-api/} 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 0eaefafea4f252..0a8f411d70e34a 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 @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdAccountDeliveryEstimate * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -25,12 +25,14 @@ export default class AdAccountDeliveryEstimate extends AbstractCrudObject { landing_page_views: "LANDING_PAGE_VIEWS"; lead_generation: "LEAD_GENERATION"; link_clicks: "LINK_CLICKS"; + meaningful_call_attempt: "MEANINGFUL_CALL_ATTEMPT"; messaging_appointment_conversion: "MESSAGING_APPOINTMENT_CONVERSION"; messaging_purchase_conversion: "MESSAGING_PURCHASE_CONVERSION"; none: "NONE"; offsite_conversions: "OFFSITE_CONVERSIONS"; page_likes: "PAGE_LIKES"; post_engagement: "POST_ENGAGEMENT"; + profile_visit: "PROFILE_VISIT"; quality_call: "QUALITY_CALL"; quality_lead: "QUALITY_LEAD"; reach: "REACH"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-dsa-recommendations.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-dsa-recommendations.d.ts index e70eb21218802e..dae7f77fe83352 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-account-dsa-recommendations.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-dsa-recommendations.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdAccountDsaRecommendations * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-ios-fourteen-campaign-limits.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-ios-fourteen-campaign-limits.d.ts index 88a303438745fd..9c4dc977428ab9 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-account-ios-fourteen-campaign-limits.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-ios-fourteen-campaign-limits.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdAccountIosFourteenCampaignLimits * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-matched-search-applications-edge-data.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-matched-search-applications-edge-data.d.ts index e74271cc119a0a..4d9942fe6adc6e 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-account-matched-search-applications-edge-data.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-matched-search-applications-edge-data.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdAccountMatchedSearchApplicationsEdgeData * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-max-bid.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-max-bid.d.ts index 3207cec44fb255..46ce6fce057eeb 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-account-max-bid.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-max-bid.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdAccountMaxBid * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-optimization-goals-ae-mv2-eligibility.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-optimization-goals-ae-mv2-eligibility.d.ts new file mode 100644 index 00000000000000..cf776399622546 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-optimization-goals-ae-mv2-eligibility.d.ts @@ -0,0 +1,41 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdAccountOptimizationGoalsAEMv2Eligibility + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdAccountOptimizationGoalsAEMv2Eligibility extends AbstractCrudObject { + static get Fields(): Readonly<{ + is_disabled: "is_disabled"; + optimization_goal: "optimization_goal"; + }>; + static get OptimizationGoal(): Readonly<{ + ad_recall_lift: "AD_RECALL_LIFT"; + app_installs: "APP_INSTALLS"; + app_installs_and_offsite_conversions: "APP_INSTALLS_AND_OFFSITE_CONVERSIONS"; + conversations: "CONVERSATIONS"; + derived_events: "DERIVED_EVENTS"; + engaged_users: "ENGAGED_USERS"; + event_responses: "EVENT_RESPONSES"; + impressions: "IMPRESSIONS"; + in_app_value: "IN_APP_VALUE"; + landing_page_views: "LANDING_PAGE_VIEWS"; + lead_generation: "LEAD_GENERATION"; + link_clicks: "LINK_CLICKS"; + meaningful_call_attempt: "MEANINGFUL_CALL_ATTEMPT"; + messaging_appointment_conversion: "MESSAGING_APPOINTMENT_CONVERSION"; + messaging_purchase_conversion: "MESSAGING_PURCHASE_CONVERSION"; + none: "NONE"; + offsite_conversions: "OFFSITE_CONVERSIONS"; + page_likes: "PAGE_LIKES"; + post_engagement: "POST_ENGAGEMENT"; + profile_visit: "PROFILE_VISIT"; + quality_call: "QUALITY_CALL"; + quality_lead: "QUALITY_LEAD"; + reach: "REACH"; + reminders_set: "REMINDERS_SET"; + subscribers: "SUBSCRIBERS"; + thruplay: "THRUPLAY"; + value: "VALUE"; + visit_instagram_profile: "VISIT_INSTAGRAM_PROFILE"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-payment-details.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-payment-details.d.ts new file mode 100644 index 00000000000000..7fc4a359be612b --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-payment-details.d.ts @@ -0,0 +1,15 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdAccountPaymentDetails + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdAccountPaymentDetails extends AbstractCrudObject { + static get Fields(): Readonly<{ + amount: "amount"; + create_date: "create_date"; + id: "id"; + last_action_status: "last_action_status"; + metadata: "metadata"; + payment_details_id: "payment_details_id"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-payment-options.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-payment-options.d.ts new file mode 100644 index 00000000000000..fbde460add27f6 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-payment-options.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdAccountPaymentOptions + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdAccountPaymentOptions extends AbstractCrudObject { + static get Fields(): Readonly<{ + available_altpay_options: "available_altpay_options"; + available_card_types: "available_card_types"; + available_payment_options: "available_payment_options"; + existing_payment_methods: "existing_payment_methods"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-prepay-details.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-prepay-details.d.ts new file mode 100644 index 00000000000000..022b2efebc552c --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-prepay-details.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdAccountPrepayDetails + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdAccountPrepayDetails extends AbstractCrudObject { + static get Fields(): Readonly<{ + default_funding_amount: "default_funding_amount"; + max_acceptable_amount: "max_acceptable_amount"; + min_acceptable_amount: "min_acceptable_amount"; + should_collect_business_details: "should_collect_business_details"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-promotable-objects.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-promotable-objects.d.ts index c361eeabb3bc9c..056373c1b178b6 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-account-promotable-objects.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-promotable-objects.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdAccountPromotableObjects * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-promotion-progress-bar.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-promotion-progress-bar.d.ts new file mode 100644 index 00000000000000..db385b9fab5a27 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-promotion-progress-bar.d.ts @@ -0,0 +1,17 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdAccountPromotionProgressBar + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdAccountPromotionProgressBar extends AbstractCrudObject { + static get Fields(): Readonly<{ + adaccount_permission: "adaccount_permission"; + coupon_currency: "coupon_currency"; + coupon_value: "coupon_value"; + expiration_time: "expiration_time"; + progress_completed: "progress_completed"; + promotion_type: "promotion_type"; + spend_requirement_in_cent: "spend_requirement_in_cent"; + spend_since_enrollment: "spend_since_enrollment"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-reach-estimate.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-reach-estimate.d.ts index 75025157b79127..74775121b101b6 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-account-reach-estimate.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-reach-estimate.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdAccountReachEstimate * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-recommendations.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-recommendations.d.ts new file mode 100644 index 00000000000000..0d1cffda5f05ae --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-recommendations.d.ts @@ -0,0 +1,10 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdAccountRecommendations + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdAccountRecommendations extends AbstractCrudObject { + static get Fields(): Readonly<{ + recommendations: "recommendations"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-recommended-camapaign-budget.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-recommended-camapaign-budget.d.ts index c789aad221821f..db0673247acf3a 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-account-recommended-camapaign-budget.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-recommended-camapaign-budget.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdAccountRecommendedCamapaignBudget * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-related-ico-study.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-related-ico-study.d.ts new file mode 100644 index 00000000000000..16a0b2d73642c0 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-related-ico-study.d.ts @@ -0,0 +1,8 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdAccountRelatedIcoStudy + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdAccountRelatedIcoStudy extends AbstractCrudObject { + static get Fields(): Readonly<{}>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-smart-suggested-ads.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-smart-suggested-ads.d.ts new file mode 100644 index 00000000000000..5fef9bcb3a181d --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-smart-suggested-ads.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdAccountSmartSuggestedAds + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdAccountSmartSuggestedAds extends AbstractCrudObject { + static get Fields(): Readonly<{ + ad_creative_spec: "ad_creative_spec"; + description: "description"; + guidance_spec: "guidance_spec"; + thumbnail_url: "thumbnail_url"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-spend-limit.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-spend-limit.d.ts new file mode 100644 index 00000000000000..a6d510f5375fe2 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-spend-limit.d.ts @@ -0,0 +1,16 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdAccountSpendLimit + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdAccountSpendLimit extends AbstractCrudObject { + static get Fields(): Readonly<{ + amount_spent: "amount_spent"; + group_id: "group_id"; + limit_id: "limit_id"; + limit_value: "limit_value"; + time_created: "time_created"; + time_start: "time_start"; + time_stop: "time_stop"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-subscribed-apps.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-subscribed-apps.d.ts index 9d9b665f4b153d..474dbf7f7ee551 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-account-subscribed-apps.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-subscribed-apps.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdAccountSubscribedApps * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-subsidy-amount-details.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-subsidy-amount-details.d.ts new file mode 100644 index 00000000000000..7ba41d54efd3aa --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-subsidy-amount-details.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdAccountSubsidyAmountDetails + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdAccountSubsidyAmountDetails extends AbstractCrudObject { + static get Fields(): Readonly<{ + entered_amount: "entered_amount"; + fee_amount: "fee_amount"; + total_amount: "total_amount"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-suggested-tag.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-suggested-tag.d.ts new file mode 100644 index 00000000000000..205d3653882d0a --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-suggested-tag.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdAccountSuggestedTag + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdAccountSuggestedTag extends AbstractCrudObject { + static get Fields(): Readonly<{ + product_id: "product_id"; + x: "x"; + y: "y"; + }>; +} 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 f1704005e90bcb..bd936a7cbb3114 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 @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdAccountTargetingUnified * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -408,6 +408,7 @@ export default class AdAccountTargetingUnified extends AbstractCrudObject { location_categories: "location_categories"; location_cluster_ids: "location_cluster_ids"; location_expansion: "location_expansion"; + marketing_message_channels: "marketing_message_channels"; marketing_message_targeting: "marketing_message_targeting"; marketplace_product_categories: "marketplace_product_categories"; messenger_positions: "messenger_positions"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-tracking-data.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-tracking-data.d.ts index f2986abcff1b90..77a4081dbeae82 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-account-tracking-data.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-tracking-data.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdAccountTrackingData * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-url-for-asset-extraction.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-url-for-asset-extraction.d.ts new file mode 100644 index 00000000000000..313e8d4dbd19ea --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-url-for-asset-extraction.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdAccountURLForAssetExtraction + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdAccountURLForAssetExtraction extends AbstractCrudObject { + static get Fields(): Readonly<{ + source_type: "source_type"; + source_url: "source_url"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-user-permissions.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-user-permissions.d.ts new file mode 100644 index 00000000000000..44f264a4ceccfa --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-user-permissions.d.ts @@ -0,0 +1,19 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdAccountUserPermissions + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdAccountUserPermissions extends AbstractCrudObject { + static get Fields(): Readonly<{ + business: "business"; + business_persona: "business_persona"; + created_by: "created_by"; + created_time: "created_time"; + email: "email"; + status: "status"; + tasks: "tasks"; + updated_by: "updated_by"; + updated_time: "updated_time"; + user: "user"; + }>; +} 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 new file mode 100644 index 00000000000000..5763d926511ce8 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-user-settings.d.ts @@ -0,0 +1,87 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdAccountUserSettings + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdAccountUserSettings extends AbstractCrudObject { + static get Fields(): Readonly<{ + acf_should_opt_out_video_adjustments: "acf_should_opt_out_video_adjustments"; + aco_sticky_settings: "aco_sticky_settings"; + ad_account: "ad_account"; + ad_object_export_format: "ad_object_export_format"; + auto_review_video_caption: "auto_review_video_caption"; + campaign_overview_columns: "campaign_overview_columns"; + column_suggestion_status: "column_suggestion_status"; + default_account_overview_agegender_metrics: "default_account_overview_agegender_metrics"; + default_account_overview_location_metrics: "default_account_overview_location_metrics"; + default_account_overview_metrics: "default_account_overview_metrics"; + default_account_overview_time_metrics: "default_account_overview_time_metrics"; + default_builtin_column_preset: "default_builtin_column_preset"; + default_nam_time_range: "default_nam_time_range"; + draft_mode_enabled: "draft_mode_enabled"; + export_deleted_items_with_delivery: "export_deleted_items_with_delivery"; + export_summary_row: "export_summary_row"; + has_seen_groups_column_flexing_experience: "has_seen_groups_column_flexing_experience"; + 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"; + hidden_optimization_tips: "hidden_optimization_tips"; + id: "id"; + is_3p_auth_setting_set: "is_3p_auth_setting_set"; + is_text_variation_nux_close: "is_text_variation_nux_close"; + last_used_columns: "last_used_columns"; + last_used_pe_filters: "last_used_pe_filters"; + last_used_website_urls: "last_used_website_urls"; + outlier_preferences: "outlier_preferences"; + pinned_ad_object_ids: "pinned_ad_object_ids"; + rb_export_format: "rb_export_format"; + rb_export_raw_data: "rb_export_raw_data"; + rb_export_summary_row: "rb_export_summary_row"; + 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"; + shops_ads_metrics_onboarding_tour_last_action_time: "shops_ads_metrics_onboarding_tour_last_action_time"; + should_default_image_auto_crop: "should_default_image_auto_crop"; + should_default_image_auto_crop_for_tail: "should_default_image_auto_crop_for_tail"; + should_default_image_auto_crop_optimization: "should_default_image_auto_crop_optimization"; + should_default_image_dof_toggle: "should_default_image_dof_toggle"; + should_default_image_lpp_ads_to_square: "should_default_image_lpp_ads_to_square"; + should_default_instagram_profile_card_optimization: "should_default_instagram_profile_card_optimization"; + should_default_text_swapping_optimization: "should_default_text_swapping_optimization"; + should_logout_of_3p_sourcing: "should_logout_of_3p_sourcing"; + show_archived_data: "show_archived_data"; + show_text_variation_nux_tooltip: "show_text_variation_nux_tooltip"; + syd_campaign_trends_activemetric: "syd_campaign_trends_activemetric"; + syd_campaign_trends_attribution: "syd_campaign_trends_attribution"; + syd_campaign_trends_metrics: "syd_campaign_trends_metrics"; + 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_variations_opt_in_type: "text_variations_opt_in_type"; + user: "user"; + }>; + static get SydCampaignTrendsObjective(): 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"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-user.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-user.d.ts index 765da1677d8467..abd30bd2151c63 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-account-user.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-user.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdAccountUser * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-account-youth-ads-advertiser.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-account-youth-ads-advertiser.d.ts new file mode 100644 index 00000000000000..214749af49c0b5 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-account-youth-ads-advertiser.d.ts @@ -0,0 +1,10 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdAccountYouthAdsAdvertiser + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdAccountYouthAdsAdvertiser extends AbstractCrudObject { + static get Fields(): Readonly<{ + is_youth_ads_advertiser: "is_youth_ads_advertiser"; + }>; +} 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 c4d3ce3dbd7b9b..b06b4cc86c9da0 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,25 +1,25 @@ -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'; -import AdCreative from './ad-creative'; -import AdImage from './ad-image'; -import AdLabel from './ad-label'; -import PlayableContent from './playable-content'; -import AdRule from './ad-rule'; -import Ad from './ad'; -import AdSet from './ad-set'; -import AdsPixel from './ads-pixel'; -import AdVideo from './ad-video'; -import Campaign from './campaign'; -import AdAsyncRequestSet from './ad-async-request-set'; -import CustomAudience from './custom-audience'; -import CustomConversion from './custom-conversion'; -import AdReportRun from './ad-report-run'; -import PublisherBlockList from './publisher-block-list'; -import ReachFrequencyPrediction from './reach-frequency-prediction'; -import AdAccountSubscribedApps from './ad-account-subscribed-apps'; +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"; +import AdCreative from "./ad-creative"; +import AdImage from "./ad-image"; +import AdLabel from "./ad-label"; +import PlayableContent from "./playable-content"; +import AdRule from "./ad-rule"; +import Ad from "./ad"; +import AdSet from "./ad-set"; +import AdsPixel from "./ads-pixel"; +import AdVideo from "./ad-video"; +import Campaign from "./campaign"; +import AdAsyncRequestSet from "./ad-async-request-set"; +import CustomAudience from "./custom-audience"; +import CustomConversion from "./custom-conversion"; +import AdReportRun from "./ad-report-run"; +import PublisherBlockList from "./publisher-block-list"; +import ReachFrequencyPrediction from "./reach-frequency-prediction"; +import AdAccountSubscribedApps from "./ad-account-subscribed-apps"; /** * AdAccount * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -35,6 +35,7 @@ export default class AdAccount extends AbstractCrudObject { amount_spent: "amount_spent"; attribution_spec: "attribution_spec"; balance: "balance"; + brand_safety_content_filter_levels: "brand_safety_content_filter_levels"; business: "business"; business_city: "business_city"; business_country_code: "business_country_code"; @@ -154,6 +155,13 @@ export default class AdAccount extends AbstractCrudObject { vnd: "VND"; zar: "ZAR"; }>; + static get PermittedTasks(): Readonly<{ + aa_analyze: "AA_ANALYZE"; + advertise: "ADVERTISE"; + analyze: "ANALYZE"; + draft: "DRAFT"; + manage: "MANAGE"; + }>; static get Tasks(): Readonly<{ aa_analyze: "AA_ANALYZE"; advertise: "ADVERTISE"; @@ -175,11 +183,11 @@ export default class AdAccount extends AbstractCrudObject { automotive_model: "AUTOMOTIVE_MODEL"; destination: "DESTINATION"; flight: "FLIGHT"; + generic: "GENERIC"; home_listing: "HOME_LISTING"; hotel: "HOTEL"; job: "JOB"; local_service_business: "LOCAL_SERVICE_BUSINESS"; - location_based_item: "LOCATION_BASED_ITEM"; media_title: "MEDIA_TITLE"; offline_product: "OFFLINE_PRODUCT"; product: "PRODUCT"; @@ -193,6 +201,7 @@ export default class AdAccount extends AbstractCrudObject { claim: "CLAIM"; custom: "CUSTOM"; engagement: "ENGAGEMENT"; + exclusion: "EXCLUSION"; fox: "FOX"; lookalike: "LOOKALIKE"; managed: "MANAGED"; @@ -210,235 +219,109 @@ export default class AdAccount extends AbstractCrudObject { physical_store: "PHYSICAL_STORE"; website: "WEBSITE"; }>; - getAccountControls(fields: string[], params?: Record): Promise; - getAccountControls(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAccountControls(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createAccountControl(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getActivities(fields: string[], params?: Record): Promise; - getActivities(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getActivities(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAdPlacePageSets(fields: string[], params?: Record): Promise; - getAdPlacePageSets(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdPlacePageSets(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createAdPlacePageSet(fields: string[], params?: Record, pathOverride?: string | null): Promise; - createAdPlacePageSetsAsync(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getAdSavedKeywords(fields: string[], params?: Record): Promise; - getAdSavedKeywords(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdSavedKeywords(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAdStudies(fields: string[], params?: Record): Promise; - getAdStudies(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdStudies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAdCloudPlayables(fields: string[], params?: Record): Promise; - getAdCloudPlayables(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdCloudPlayables(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAdCreatives(fields: string[], params?: Record): Promise; - getAdCreatives(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdCreatives(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createAdCreative(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getAdCreativesByLabels(fields: string[], params?: Record): Promise; - getAdCreativesByLabels(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdCreativesByLabels(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - deleteAdImages(params?: Record): Promise; - getAdImages(fields: string[], params?: Record): Promise; - getAdImages(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdImages(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createAdImage(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getAdLabels(fields: string[], params?: Record): Promise; - getAdLabels(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdLabels(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createAdLabel(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getAdPlayables(fields: string[], params?: Record): Promise; - getAdPlayables(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdPlayables(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createAdPlayable(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getAdRulesHistory(fields: string[], params?: Record): Promise; - getAdRulesHistory(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdRulesHistory(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAdRulesLibrary(fields: string[], params?: Record): Promise; - getAdRulesLibrary(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdRulesLibrary(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createAdRulesLibrary(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getAds(fields: string[], params?: Record): Promise; - getAds(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAds(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createAd(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getAdsReportingMmmReports(fields: string[], params?: Record): Promise; - getAdsReportingMmmReports(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdsReportingMmmReports(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAdsReportingMmmSchedulers(fields: string[], params?: Record): Promise; - getAdsReportingMmmSchedulers(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdsReportingMmmSchedulers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAdsVolume(fields: string[], params?: Record): Promise; - getAdsVolume(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdsVolume(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAdsByLabels(fields: string[], params?: Record): Promise; - getAdsByLabels(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdsByLabels(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAdSets(fields: string[], params?: Record): Promise; - getAdSets(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdSets(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createAdSet(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getAdSetsByLabels(fields: string[], params?: Record): Promise; - getAdSetsByLabels(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdSetsByLabels(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAdsPixels(fields: string[], params?: Record): Promise; - getAdsPixels(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdsPixels(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createAdsPixel(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getAdvertisableApplications(fields: string[], params?: Record): Promise; - getAdvertisableApplications(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdvertisableApplications(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - deleteAdVideos(params?: Record): Promise; - getAdVideos(fields: string[], params?: Record): Promise; - getAdVideos(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdVideos(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createAdVideo(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getAffectedAdSets(fields: string[], params?: Record): Promise; - getAffectedAdSets(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAffectedAdSets(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - deleteAgencies(params?: Record): Promise; - getAgencies(fields: string[], params?: Record): Promise; - getAgencies(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAgencies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getApplications(fields: string[], params?: Record): Promise; - getApplications(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getApplications(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - deleteAssignedUsers(params?: Record): Promise; - getAssignedUsers(fields: string[], params?: Record): Promise; - getAssignedUsers(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAssignedUsers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createAssignedUser(fields: string[], params?: Record, pathOverride?: string | null): Promise; - createAsyncBatchRequest(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getAsyncRequests(fields: string[], params?: Record): Promise; - getAsyncRequests(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAsyncRequests(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAsyncAdRequestSets(fields: string[], params?: Record): Promise; - getAsyncAdRequestSets(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAsyncAdRequestSets(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createAsyncAdRequestSet(fields: string[], params?: Record, pathOverride?: string | null): Promise; - createBlockListDraft(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getBroadTargetingCategories(fields: string[], params?: Record): Promise; - getBroadTargetingCategories(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getBroadTargetingCategories(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getBusinessProjects(fields: string[], params?: Record): Promise; - getBusinessProjects(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getBusinessProjects(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - deleteCampaigns(params?: Record): Promise; - getCampaigns(fields: string[], params?: Record): Promise; - getCampaigns(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCampaigns(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createCampaign(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getCampaignsByLabels(fields: string[], params?: Record): Promise; - getCampaignsByLabels(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCampaignsByLabels(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getConnectedInstagramAccounts(fields: string[], params?: Record): Promise; - getConnectedInstagramAccounts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getConnectedInstagramAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getConversionGoals(fields: string[], params?: Record): Promise; - getConversionGoals(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getConversionGoals(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getCustomAudiences(fields: string[], params?: Record): Promise; - getCustomAudiences(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCustomAudiences(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createCustomAudience(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getCustomAudiencesTos(fields: string[], params?: Record): Promise; - getCustomAudiencesTos(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCustomAudiencesTos(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createCustomAudiencesTo(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getCustomConversions(fields: string[], params?: Record): Promise; - getCustomConversions(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCustomConversions(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createCustomConversion(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getDeliveryEstimate(fields: string[], params?: Record): Promise; - getDeliveryEstimate(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getDeliveryEstimate(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getDeprecatedTargetingAdSets(fields: string[], params?: Record): Promise; - getDeprecatedTargetingAdSets(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getDeprecatedTargetingAdSets(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getDsaRecommendations(fields: string[], params?: Record): Promise; - getDsaRecommendations(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getDsaRecommendations(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getGeneratePreviews(fields: string[], params?: Record): Promise; - getGeneratePreviews(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getGeneratePreviews(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getImpactingAdStudies(fields: string[], params?: Record): Promise; - getImpactingAdStudies(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getImpactingAdStudies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getInsights(fields: string[], params?: Record): Promise; - getInsights(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getInsights(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getInsightsAsync(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getInstagramAccounts(fields: string[], params?: Record): Promise; - getInstagramAccounts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getInstagramAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getIosFourteenCampaignLimits(fields: string[], params?: Record): Promise; - getIosFourteenCampaignLimits(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getIosFourteenCampaignLimits(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createManagedPartnerAd(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getMatchedSearchApplications(fields: string[], params?: Record): Promise; - getMatchedSearchApplications(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getMatchedSearchApplications(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getMaxBid(fields: string[], params?: Record): Promise; - getMaxBid(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getMaxBid(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getMinimumBudgets(fields: string[], params?: Record): Promise; - getMinimumBudgets(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getMinimumBudgets(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getOfflineConversionDataSets(fields: string[], params?: Record): Promise; - getOfflineConversionDataSets(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getOfflineConversionDataSets(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getOnBehalfRequests(fields: string[], params?: Record): Promise; - getOnBehalfRequests(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getOnBehalfRequests(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createProductAudience(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getPromotePages(fields: string[], params?: Record): Promise; - getPromotePages(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPromotePages(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getPublisherBlockLists(fields: string[], params?: Record): Promise; - getPublisherBlockLists(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPublisherBlockLists(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createPublisherBlockList(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getReachEstimate(fields: string[], params?: Record): Promise; - getReachEstimate(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getReachEstimate(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getReachFrequencyPredictions(fields: string[], params?: Record): Promise; - getReachFrequencyPredictions(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getReachFrequencyPredictions(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createReachFrequencyPrediction(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getSavedAudiences(fields: string[], params?: Record): Promise; - getSavedAudiences(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getSavedAudiences(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - deleteSubscribedApps(params?: Record): Promise; - getSubscribedApps(fields: string[], params?: Record): Promise; - getSubscribedApps(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getSubscribedApps(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createSubscribedApp(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getTargetingBrowse(fields: string[], params?: Record): Promise; - getTargetingBrowse(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getTargetingBrowse(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getTargetingSearch(fields: string[], params?: Record): Promise; - getTargetingSearch(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getTargetingSearch(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getTargetingSentenceLines(fields: string[], params?: Record): Promise; - getTargetingSentenceLines(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getTargetingSentenceLines(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getTargetingSuggestions(fields: string[], params?: Record): Promise; - getTargetingSuggestions(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getTargetingSuggestions(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getTargetingValidation(fields: string[], params?: Record): Promise; - getTargetingValidation(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getTargetingValidation(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getTracking(fields: string[], params?: Record): Promise; - getTracking(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getTracking(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createTracking(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getUsers(fields: string[], params?: Record): Promise; - getUsers(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getUsers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - deleteUsersOfAnyAudience(params?: Record): Promise; - getValueAdjustmentRules(fields: string[], params?: Record): Promise; - getValueAdjustmentRules(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getValueAdjustmentRules(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - get(fields: string[], params?: Record): Promise; - update(fields: string[], params?: Record): Promise; + getAccountControls(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createAccountControl(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getActivities(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getAdPlacePageSets(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createAdPlacePageSet(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createAdPlacePageSetsAsync(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getAdSavedKeywords(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getAdStudies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getAdCloudPlayables(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getAdCreatives(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createAdCreative(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getAdCreativesByLabels(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + deleteAdImages(params?: Record): Promise; + getAdImages(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createAdImage(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getAdLabels(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createAdLabel(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getAdPlayables(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createAdPlayable(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getAdRulesHistory(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getAdRulesLibrary(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createAdRulesLibrary(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getAds(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createAd(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; + getAdsVolume(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getAdsByLabels(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getAdSets(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createAdSet(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getAdSetsByLabels(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getAdsPixels(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createAdsPixel(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getAdvertisableApplications(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + deleteAdVideos(params?: Record): Promise; + getAdVideos(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createAdVideo(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getAffectedAdSets(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + deleteAgencies(params?: Record): Promise; + getAgencies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createAgency(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getApplications(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + deleteAssignedUsers(params?: Record): Promise; + getAssignedUsers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + 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; + 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; + createBlockListDraft(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getBroadTargetingCategories(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getBusinessProjects(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + deleteCampaigns(params?: Record): Promise; + getCampaigns(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createCampaign(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getCampaignsByLabels(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + 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; + createCustomAudiencesTo(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getCustomConversions(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createCustomConversion(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getDeliveryEstimate(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getDeprecatedTargetingAdSets(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getDsaRecommendations(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getGeneratePreviews(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getImpactingAdStudies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getInsights(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + 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; + getMinimumBudgets(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getOnBehalfRequests(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createProductAudience(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getPromotePages(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getPublisherBlockLists(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createPublisherBlockList(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getReachEstimate(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getReachFrequencyPredictions(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createReachFrequencyPrediction(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getSavedAudiences(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + deleteSubscribedApps(params?: Record): Promise; + getSubscribedApps(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createSubscribedApp(fields: string[], params?: Record, pathOverride?: string | null): 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; + getTargetingSuggestions(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getTargetingValidATIOn(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getTracking(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createTracking(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getUsers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + deleteUsersOfAnyAudience(params?: Record): Promise; + getValueAdjustmentRuleCollections(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getValueAdjustmentRules(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/ad-activity.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-activity.d.ts index 7b3d30f304b475..5cd38f16515ec2 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 @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdActivity * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -100,6 +100,7 @@ export default class AdActivity extends AbstractCrudObject { update_campaign_name: "update_campaign_name"; update_campaign_run_status: "update_campaign_run_status"; update_campaign_schedule: "update_campaign_schedule"; + update_campaign_value_adjustment_rule: "update_campaign_value_adjustment_rule"; update_delivery_type_cross_level_shift: "update_delivery_type_cross_level_shift"; }>; static get Category(): Readonly<{ diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-asset-body.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-body.d.ts new file mode 100644 index 00000000000000..ce85cee6f4a203 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-body.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdAssetBody + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdAssetBody extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + text: "text"; + url_tags: "url_tags"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-asset-call-to-action-type.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-call-to-action-type.d.ts new file mode 100644 index 00000000000000..64814930c374ce --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-call-to-action-type.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdAssetCallToActionType + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdAssetCallToActionType extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + name: "name"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-asset-customization-rule-customization-spec.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-customization-rule-customization-spec.d.ts index 0f10e17bc44d41..4a45ac8c81b724 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-asset-customization-rule-customization-spec.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-customization-rule-customization-spec.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdAssetCustomizationRuleCustomizationSpec * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-asset-description.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-description.d.ts new file mode 100644 index 00000000000000..4f78fa1c636e43 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-description.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdAssetDescription + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdAssetDescription extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + text: "text"; + url_tags: "url_tags"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-additional-data-page-nudge-message.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-additional-data-page-nudge-message.d.ts new file mode 100644 index 00000000000000..d4d80d71aa6043 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-additional-data-page-nudge-message.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdAssetFeedAdditionalDataPageNudgeMessage + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdAssetFeedAdditionalDataPageNudgeMessage extends AbstractCrudObject { + static get Fields(): Readonly<{ + enabled: "enabled"; + quick_replies: "quick_replies"; + text: "text"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-additional-data.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-additional-data.d.ts new file mode 100644 index 00000000000000..c71f3540558038 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-additional-data.d.ts @@ -0,0 +1,15 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdAssetFeedAdditionalData + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdAssetFeedAdditionalData extends AbstractCrudObject { + static get Fields(): Readonly<{ + automated_product_tags: "automated_product_tags"; + brand_page_id: "brand_page_id"; + is_click_to_message: "is_click_to_message"; + multi_share_end_card: "multi_share_end_card"; + page_welcome_message: "page_welcome_message"; + partner_app_welcome_message_flow_id: "partner_app_welcome_message_flow_id"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-asset-customization-rule.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-asset-customization-rule.d.ts index 34c3e794464071..4a8de708bf716c 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-asset-customization-rule.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-asset-customization-rule.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdAssetFeedSpecAssetCustomizationRule * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-asset-label.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-asset-label.d.ts index 675ab6905c1e6c..ca3f5a95d94863 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-asset-label.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-asset-label.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdAssetFeedSpecAssetLabel * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-body.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-body.d.ts index f06ff0c241f90b..77b8629f64a534 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-body.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-body.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdAssetFeedSpecBody * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-call-to-action.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-call-to-action.d.ts new file mode 100644 index 00000000000000..46621a94f188fa --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-call-to-action.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdAssetFeedSpecCallToAction + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdAssetFeedSpecCallToAction extends AbstractCrudObject { + static get Fields(): Readonly<{ + adlabels: "adlabels"; + type: "type"; + value: "value"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-caption.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-caption.d.ts index 922c15d9084db8..057201b1e108af 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-caption.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-caption.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdAssetFeedSpecCaption * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-carousel-child-attachment.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-carousel-child-attachment.d.ts new file mode 100644 index 00000000000000..90cf1aa45cee75 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-carousel-child-attachment.d.ts @@ -0,0 +1,19 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdAssetFeedSpecCarouselChildAttachment + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdAssetFeedSpecCarouselChildAttachment extends AbstractCrudObject { + static get Fields(): Readonly<{ + body_label: "body_label"; + call_to_action_type_label: "call_to_action_type_label"; + caption_label: "caption_label"; + description_label: "description_label"; + image_label: "image_label"; + link_url_label: "link_url_label"; + phone_data_ids_label: "phone_data_ids_label"; + static_card: "static_card"; + title_label: "title_label"; + video_label: "video_label"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-carousel.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-carousel.d.ts new file mode 100644 index 00000000000000..3a93b566c842dc --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-carousel.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdAssetFeedSpecCarousel + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdAssetFeedSpecCarousel extends AbstractCrudObject { + static get Fields(): Readonly<{ + adlabels: "adlabels"; + child_attachments: "child_attachments"; + multi_share_end_card: "multi_share_end_card"; + multi_share_optimized: "multi_share_optimized"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-description.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-description.d.ts index 1a91b522382294..479106d4647883 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-description.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-description.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdAssetFeedSpecDescription * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-events.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-events.d.ts new file mode 100644 index 00000000000000..3b7527b651b53f --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-events.d.ts @@ -0,0 +1,10 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdAssetFeedSpecEvents + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdAssetFeedSpecEvents extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-group-rule.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-group-rule.d.ts index 6eb2f033a89a61..0fcb5d9f293814 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-group-rule.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-group-rule.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdAssetFeedSpecGroupRule * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-image.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-image.d.ts index 4876edf2fb6d73..056d46677b98c9 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-image.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-image.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdAssetFeedSpecImage * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-link-url.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-link-url.d.ts index 19f6faefb1c6df..a59169bfab1cbd 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-link-url.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-link-url.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdAssetFeedSpecLinkURL * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-title.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-title.d.ts index 9bd54c7ecfb3ca..a0a9196b9f0cd1 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-title.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-title.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdAssetFeedSpecTitle * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-video.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-video.d.ts index 4b00089e496dff..cff46f305b5176 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-video.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-feed-spec-video.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdAssetFeedSpecVideo * @see {@link https://developers.facebook.com/docs/marketing-api/} 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 223cc67b70c483..80c9b74ee56c83 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 @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdAssetFeedSpec * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -23,23 +23,30 @@ export default class AdAssetFeedSpec extends AbstractCrudObject { message_extensions: "message_extensions"; onsite_destinations: "onsite_destinations"; optimization_type: "optimization_type"; + promotional_metadata: "promotional_metadata"; reasons_to_shop: "reasons_to_shop"; shops_bundle: "shops_bundle"; titles: "titles"; + upcoming_events: "upcoming_events"; videos: "videos"; }>; static get CallToActionTypes(): Readonly<{ add_to_cart: "ADD_TO_CART"; apply_now: "APPLY_NOW"; + ask_about_services: "ASK_ABOUT_SERVICES"; + ask_for_more_info: "ASK_FOR_MORE_INFO"; audio_call: "AUDIO_CALL"; + book_a_consultation: "BOOK_A_CONSULTATION"; book_now: "BOOK_NOW"; book_travel: "BOOK_TRAVEL"; buy: "BUY"; buy_now: "BUY_NOW"; buy_tickets: "BUY_TICKETS"; + buy_via_message: "BUY_VIA_MESSAGE"; call: "CALL"; call_me: "CALL_ME"; call_now: "CALL_NOW"; + chat_with_us: "CHAT_WITH_US"; confirm: "CONFIRM"; contact: "CONTACT"; contact_us: "CONTACT_US"; @@ -52,6 +59,7 @@ export default class AdAssetFeedSpec extends AbstractCrudObject { follow_news_storyline: "FOLLOW_NEWS_STORYLINE"; follow_page: "FOLLOW_PAGE"; follow_user: "FOLLOW_USER"; + get_a_quote: "GET_A_QUOTE"; get_directions: "GET_DIRECTIONS"; get_offer: "GET_OFFER"; get_offer_view: "GET_OFFER_VIEW"; @@ -62,10 +70,12 @@ export default class AdAssetFeedSpec extends AbstractCrudObject { inquire_now: "INQUIRE_NOW"; install_app: "INSTALL_APP"; install_mobile_app: "INSTALL_MOBILE_APP"; + join_channel: "JOIN_CHANNEL"; learn_more: "LEARN_MORE"; like_page: "LIKE_PAGE"; listen_music: "LISTEN_MUSIC"; listen_now: "LISTEN_NOW"; + make_an_appointment: "MAKE_AN_APPOINTMENT"; message_page: "MESSAGE_PAGE"; mobile_download: "MOBILE_DOWNLOAD"; no_button: "NO_BUTTON"; @@ -99,6 +109,7 @@ export default class AdAssetFeedSpec extends AbstractCrudObject { use_mobile_app: "USE_MOBILE_APP"; video_annotation: "VIDEO_ANNOTATION"; video_call: "VIDEO_CALL"; + view_product: "VIEW_PRODUCT"; visit_pages_feed: "VISIT_PAGES_FEED"; watch_more: "WATCH_MORE"; watch_video: "WATCH_VIDEO"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-asset-image.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-image.d.ts new file mode 100644 index 00000000000000..8a90aa38888236 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-image.d.ts @@ -0,0 +1,16 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdAssetImage + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdAssetImage extends AbstractCrudObject { + static get Fields(): Readonly<{ + hash: "hash"; + id: "id"; + image_crops: "image_crops"; + name: "name"; + tag: "tag"; + url: "url"; + url_tags: "url_tags"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-asset-link-url.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-link-url.d.ts new file mode 100644 index 00000000000000..90856cdbfd75f1 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-link-url.d.ts @@ -0,0 +1,18 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdAssetLinkURL + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdAssetLinkURL extends AbstractCrudObject { + static get Fields(): Readonly<{ + android_deeplink_url: "android_deeplink_url"; + carousel_see_more_url: "carousel_see_more_url"; + deeplink_url: "deeplink_url"; + display_url: "display_url"; + id: "id"; + ipad_deeplink_url: "ipad_deeplink_url"; + iphone_deeplink_url: "iphone_deeplink_url"; + url_tags: "url_tags"; + website_url: "website_url"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-asset-message-extensions.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-message-extensions.d.ts index 0b90399d2b9b2f..95f836b1b1d781 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-asset-message-extensions.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-message-extensions.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdAssetMessageExtensions * @see {@link https://developers.facebook.com/docs/marketing-api/} 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 new file mode 100644 index 00000000000000..5eefd258d957d5 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-onsite-destinations.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdAssetOnsiteDestinations + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdAssetOnsiteDestinations extends AbstractCrudObject { + static get Fields(): Readonly<{ + auto_optimization: "auto_optimization"; + details_page_product_id: "details_page_product_id"; + shop_collection_product_set_id: "shop_collection_product_set_id"; + 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 d949504563dd68..cc55ca1c4e70ad 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 @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdAssetTargetRuleTargeting * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-asset-title.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-title.d.ts new file mode 100644 index 00000000000000..2851e19d781b25 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-title.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdAssetTitle + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdAssetTitle extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + text: "text"; + url_tags: "url_tags"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-asset-video.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-video.d.ts new file mode 100644 index 00000000000000..0dd712ed02e5d7 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-asset-video.d.ts @@ -0,0 +1,20 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdAssetVideo + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdAssetVideo extends AbstractCrudObject { + static get Fields(): Readonly<{ + caption_ids: "caption_ids"; + id: "id"; + source_image_url: "source_image_url"; + tag: "tag"; + thumbnail_hash: "thumbnail_hash"; + thumbnail_source: "thumbnail_source"; + thumbnail_url: "thumbnail_url"; + url: "url"; + url_tags: "url_tags"; + video_id: "video_id"; + video_name: "video_name"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-async-request-set-notification-result.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-async-request-set-notification-result.d.ts index a916b8a418a8b3..47b752824ad969 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-async-request-set-notification-result.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-async-request-set-notification-result.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdAsyncRequestSetNotificationResult * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-async-request-set.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-async-request-set.d.ts index d6723b02fa9ea2..a1c98e23e35a8f 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-async-request-set.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-async-request-set.d.ts @@ -1,6 +1,6 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; +import Cursor from "./../cursor"; /** * AdAsyncRequestSet * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -28,10 +28,8 @@ export default class AdAsyncRequestSet extends AbstractCrudObject { off: "OFF"; on_complete: "ON_COMPLETE"; }>; - getRequests(fields: string[], params?: Record): Promise; - getRequests(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getRequests(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; + getRequests(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/ad-async-request.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-async-request.d.ts index 675e2856b42511..984f01daa7e922 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-async-request.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-async-request.d.ts @@ -1,5 +1,5 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; /** * AdAsyncRequest * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -31,6 +31,6 @@ export default class AdAsyncRequest extends AbstractCrudObject { user_canceled: "USER_CANCELED"; user_canceled_dependency: "USER_CANCELED_DEPENDENCY"; }>; - delete(fields: string[], params?: Record): Promise; - get(fields: string[], params?: Record): Promise; + delete(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-bid-adjustments.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-bid-adjustments.d.ts index d5e6f22ee9bd70..14facd4bc8334d 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-bid-adjustments.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-bid-adjustments.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdBidAdjustments * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-bid-constraint.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-bid-constraint.d.ts index 16a7a40c4890a3..d41932dd759a0d 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-bid-constraint.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-bid-constraint.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdCampaignBidConstraint * @see {@link https://developers.facebook.com/docs/marketing-api/} 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 8c3aa87a041031..9dcc96ce47080f 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 @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdCampaignDeliveryEstimate * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -25,12 +25,14 @@ export default class AdCampaignDeliveryEstimate extends AbstractCrudObject { landing_page_views: "LANDING_PAGE_VIEWS"; lead_generation: "LEAD_GENERATION"; link_clicks: "LINK_CLICKS"; + meaningful_call_attempt: "MEANINGFUL_CALL_ATTEMPT"; messaging_appointment_conversion: "MESSAGING_APPOINTMENT_CONVERSION"; messaging_purchase_conversion: "MESSAGING_PURCHASE_CONVERSION"; none: "NONE"; offsite_conversions: "OFFSITE_CONVERSIONS"; page_likes: "PAGE_LIKES"; post_engagement: "POST_ENGAGEMENT"; + profile_visit: "PROFILE_VISIT"; quality_call: "QUALITY_CALL"; quality_lead: "QUALITY_LEAD"; reach: "REACH"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-delivery-stats-unsupported-reasons.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-delivery-stats-unsupported-reasons.d.ts index ba92f12e6e5df5..0f77dd0056be71 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-delivery-stats-unsupported-reasons.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-delivery-stats-unsupported-reasons.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdCampaignDeliveryStatsUnsupportedReasons * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-delivery-stats.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-delivery-stats.d.ts new file mode 100644 index 00000000000000..07807713fa4fae --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-delivery-stats.d.ts @@ -0,0 +1,15 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdCampaignDeliveryStats + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdCampaignDeliveryStats extends AbstractCrudObject { + static get Fields(): Readonly<{ + bid_recommendation: "bid_recommendation"; + current_average_cost: "current_average_cost"; + last_significant_edit_ts: "last_significant_edit_ts"; + learning_stage_exit_info: "learning_stage_exit_info"; + learning_stage_info: "learning_stage_info"; + unsupported_features: "unsupported_features"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-frequency-control-specs.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-frequency-control-specs.d.ts index 0e77903050d49f..fd51c76a8977d5 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-frequency-control-specs.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-frequency-control-specs.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdCampaignFrequencyControlSpecs * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-group-incremental-conversion-optimization-config.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-group-incremental-conversion-optimization-config.d.ts new file mode 100644 index 00000000000000..043a631d08294c --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-group-incremental-conversion-optimization-config.d.ts @@ -0,0 +1,19 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdCampaignGroupIncrementalConversionOptimizationConfig + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdCampaignGroupIncrementalConversionOptimizationConfig extends AbstractCrudObject { + static get Fields(): Readonly<{ + action_type: "action_type"; + ad_study_end_time: "ad_study_end_time"; + ad_study_id: "ad_study_id"; + ad_study_name: "ad_study_name"; + ad_study_start_time: "ad_study_start_time"; + cell_id: "cell_id"; + cell_name: "cell_name"; + holdout_size: "holdout_size"; + ico_type: "ico_type"; + objectives: "objectives"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-group-metrics-metadata.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-group-metrics-metadata.d.ts new file mode 100644 index 00000000000000..cf36b538cd8d44 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-group-metrics-metadata.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdCampaignGroupMetricsMetadata + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdCampaignGroupMetricsMetadata extends AbstractCrudObject { + static get Fields(): Readonly<{ + budget_optimization: "budget_optimization"; + duplication_flow_tips: "duplication_flow_tips"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-group-stats.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-group-stats.d.ts new file mode 100644 index 00000000000000..8b647b26e31273 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-group-stats.d.ts @@ -0,0 +1,24 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdCampaignGroupStats + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdCampaignGroupStats extends AbstractCrudObject { + static get Fields(): Readonly<{ + actions: "actions"; + campaign_group_id: "campaign_group_id"; + clicks: "clicks"; + end_time: "end_time"; + impressions: "impressions"; + inline_actions: "inline_actions"; + social_clicks: "social_clicks"; + social_impressions: "social_impressions"; + social_spent: "social_spent"; + social_unique_clicks: "social_unique_clicks"; + social_unique_impressions: "social_unique_impressions"; + spent: "spent"; + start_time: "start_time"; + unique_clicks: "unique_clicks"; + unique_impressions: "unique_impressions"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-group-structure-tree.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-group-structure-tree.d.ts new file mode 100644 index 00000000000000..312d279b477897 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-group-structure-tree.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdCampaignGroupStructureTree + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdCampaignGroupStructureTree extends AbstractCrudObject { + static get Fields(): Readonly<{ + children: "children"; + id: "id"; + name: "name"; + time_updated: "time_updated"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-issues-info.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-issues-info.d.ts index 4bfc10ff20bbe0..0b46f866238615 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-issues-info.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-issues-info.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdCampaignIssuesInfo * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-learning-stage-info.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-learning-stage-info.d.ts index 059d0e67448818..c7dae978c873d6 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-learning-stage-info.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-learning-stage-info.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdCampaignLearningStageInfo * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-metrics-metadata.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-metrics-metadata.d.ts new file mode 100644 index 00000000000000..2eae79d11ac6b0 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-metrics-metadata.d.ts @@ -0,0 +1,15 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdCampaignMetricsMetadata + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdCampaignMetricsMetadata extends AbstractCrudObject { + static get Fields(): Readonly<{ + boosted_component_optimization: "boosted_component_optimization"; + creation_flow_tips: "creation_flow_tips"; + default_opted_in_placements: "default_opted_in_placements"; + delivery_growth_optimizations: "delivery_growth_optimizations"; + duplication_flow_tips: "duplication_flow_tips"; + edit_flow_tips: "edit_flow_tips"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-multi-ads.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-multi-ads.d.ts new file mode 100644 index 00000000000000..1307c8f4d90e4f --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-multi-ads.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdCampaignMultiAds + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdCampaignMultiAds extends AbstractCrudObject { + static get Fields(): Readonly<{ + enroll_status: "enroll_status"; + source_type: "source_type"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-optimization-event.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-optimization-event.d.ts index a3f9a9e4806aef..3ddb6c579d54d1 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-optimization-event.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-optimization-event.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdCampaignOptimizationEvent * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-paced-bid-info.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-paced-bid-info.d.ts index 3cd562c9b5637c..2f734451de974c 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-paced-bid-info.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-paced-bid-info.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdCampaignPacedBidInfo * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-stats.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-stats.d.ts new file mode 100644 index 00000000000000..6dddba50147599 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-campaign-stats.d.ts @@ -0,0 +1,33 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdCampaignStats + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdCampaignStats extends AbstractCrudObject { + static get Fields(): Readonly<{ + account_id: "account_id"; + actions: "actions"; + adgroup_id: "adgroup_id"; + campaign_id: "campaign_id"; + campaign_ids: "campaign_ids"; + clicks: "clicks"; + end_time: "end_time"; + id: "id"; + impressions: "impressions"; + inline_actions: "inline_actions"; + io_number: "io_number"; + is_completed: "is_completed"; + line_number: "line_number"; + newsfeed_position: "newsfeed_position"; + social_clicks: "social_clicks"; + social_impressions: "social_impressions"; + social_spent: "social_spent"; + social_unique_clicks: "social_unique_clicks"; + social_unique_impressions: "social_unique_impressions"; + spent: "spent"; + start_time: "start_time"; + topline_id: "topline_id"; + unique_clicks: "unique_clicks"; + unique_impressions: "unique_impressions"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-column-sizes.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-column-sizes.d.ts new file mode 100644 index 00000000000000..49abb4d2a9df1d --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-column-sizes.d.ts @@ -0,0 +1,19 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdColumnSizes + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdColumnSizes extends AbstractCrudObject { + static get Fields(): Readonly<{ + admarket_account: "admarket_account"; + app_id: "app_id"; + columns: "columns"; + id: "id"; + owner: "owner"; + page: "page"; + report: "report"; + tab: "tab"; + view: "view"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-contract.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-contract.d.ts new file mode 100644 index 00000000000000..f5d3b5215bd358 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-contract.d.ts @@ -0,0 +1,50 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdContract + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdContract extends AbstractCrudObject { + static get Fields(): Readonly<{ + account_id: "account_id"; + account_mgr_fbid: "account_mgr_fbid"; + account_mgr_name: "account_mgr_name"; + adops_person_name: "adops_person_name"; + advertiser_address_fbid: "advertiser_address_fbid"; + advertiser_fbid: "advertiser_fbid"; + advertiser_name: "advertiser_name"; + agency_discount: "agency_discount"; + agency_name: "agency_name"; + bill_to_address_fbid: "bill_to_address_fbid"; + bill_to_fbid: "bill_to_fbid"; + campaign_name: "campaign_name"; + created_by: "created_by"; + created_date: "created_date"; + customer_io: "customer_io"; + io_number: "io_number"; + io_terms: "io_terms"; + io_type: "io_type"; + last_updated_by: "last_updated_by"; + last_updated_date: "last_updated_date"; + max_end_date: "max_end_date"; + mdc_fbid: "mdc_fbid"; + media_plan_number: "media_plan_number"; + min_start_date: "min_start_date"; + msa_contract: "msa_contract"; + payment_terms: "payment_terms"; + rev_hold_flag: "rev_hold_flag"; + rev_hold_released_by: "rev_hold_released_by"; + rev_hold_released_on: "rev_hold_released_on"; + salesrep_fbid: "salesrep_fbid"; + salesrep_name: "salesrep_name"; + sold_to_address_fbid: "sold_to_address_fbid"; + sold_to_fbid: "sold_to_fbid"; + status: "status"; + subvertical: "subvertical"; + thirdparty_billed: "thirdparty_billed"; + thirdparty_uid: "thirdparty_uid"; + thirdparty_url: "thirdparty_url"; + vat_country: "vat_country"; + version: "version"; + vertical: "vertical"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-conversion-values.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-conversion-values.d.ts new file mode 100644 index 00000000000000..8a6ea39a8be2a8 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-conversion-values.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdConversionValues + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdConversionValues extends AbstractCrudObject { + static get Fields(): Readonly<{ + adgroup_id: "adgroup_id"; + campaign_id: "campaign_id"; + values: "values"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-conversions.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-conversions.d.ts new file mode 100644 index 00000000000000..c041127655c88d --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-conversions.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdConversions + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdConversions extends AbstractCrudObject { + static get Fields(): Readonly<{ + account_id: "account_id"; + adgroup_id: "adgroup_id"; + campaign_id: "campaign_id"; + values: "values"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creation-package-config.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creation-package-config.d.ts new file mode 100644 index 00000000000000..99ff9310bb779c --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creation-package-config.d.ts @@ -0,0 +1,16 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdCreationPackageConfig + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdCreationPackageConfig extends AbstractCrudObject { + static get Fields(): Readonly<{ + api_version: "api_version"; + id: "id"; + is_eligible_for_default_opt_in: "is_eligible_for_default_opt_in"; + objective: "objective"; + package_id: "package_id"; + status: "status"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-ad-disclaimer.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-ad-disclaimer.d.ts index 94bc8daf5358d0..5d26b939fa514d 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-ad-disclaimer.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-ad-disclaimer.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdCreativeAdDisclaimer * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-asset-groups-spec.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-asset-groups-spec.d.ts new file mode 100644 index 00000000000000..3574f41f32aac7 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-asset-groups-spec.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdCreativeAssetGroupsSpec + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdCreativeAssetGroupsSpec extends AbstractCrudObject { + static get Fields(): Readonly<{ + groups: "groups"; + origin: "origin"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-branded-content-ads-partners.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-branded-content-ads-partners.d.ts new file mode 100644 index 00000000000000..31c27de5ca513b --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-branded-content-ads-partners.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdCreativeBrandedContentAdsPartners + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdCreativeBrandedContentAdsPartners extends AbstractCrudObject { + static get Fields(): Readonly<{ + fb_page_id: "fb_page_id"; + identity_type: "identity_type"; + ig_asset_id: "ig_asset_id"; + ig_user_id: "ig_user_id"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-branded-content-ads.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-branded-content-ads.d.ts index 417f5c5f2b1294..4a01b6714e2eee 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-branded-content-ads.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-branded-content-ads.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdCreativeBrandedContentAds * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -6,10 +6,13 @@ import { AbstractCrudObject } from './../abstract-crud-object'; export default class AdCreativeBrandedContentAds extends AbstractCrudObject { static get Fields(): Readonly<{ ad_format: "ad_format"; + content_search_input: "content_search_input"; creator_ad_permission_type: "creator_ad_permission_type"; + facebook_boost_post_access_token: "facebook_boost_post_access_token"; instagram_boost_post_access_token: "instagram_boost_post_access_token"; is_mca_internal: "is_mca_internal"; partners: "partners"; + promoted_page_id: "promoted_page_id"; ui_version: "ui_version"; }>; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-collection-thumbnail-info.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-collection-thumbnail-info.d.ts index 3d0155811a4f16..bd7ae90342aad5 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-collection-thumbnail-info.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-collection-thumbnail-info.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdCreativeCollectionThumbnailInfo * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-contextual-multi-ads.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-contextual-multi-ads.d.ts new file mode 100644 index 00000000000000..91903688880bf6 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-contextual-multi-ads.d.ts @@ -0,0 +1,10 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdCreativeContextualMultiAds + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdCreativeContextualMultiAds extends AbstractCrudObject { + static get Fields(): Readonly<{ + enroll_status: "enroll_status"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-degrees-of-freedom-spec.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-degrees-of-freedom-spec.d.ts index 9485eb07c4ddef..54de4c91de2c64 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-degrees-of-freedom-spec.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-degrees-of-freedom-spec.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdCreativeDegreesOfFreedomSpec * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-facebook-branded-content.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-facebook-branded-content.d.ts index f3f6212047357b..3a6c963f927695 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-facebook-branded-content.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-facebook-branded-content.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdCreativeFacebookBrandedContent * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-feature-action-metadata.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-feature-action-metadata.d.ts new file mode 100644 index 00000000000000..06a64ddf643100 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-feature-action-metadata.d.ts @@ -0,0 +1,10 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdCreativeFeatureActionMetadata + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdCreativeFeatureActionMetadata extends AbstractCrudObject { + static get Fields(): Readonly<{ + type: "type"; + }>; +} 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 new file mode 100644 index 00000000000000..56adafa29fb483 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-feature-customizations.d.ts @@ -0,0 +1,16 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdCreativeFeatureCustomizations + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdCreativeFeatureCustomizations extends AbstractCrudObject { + static get Fields(): Readonly<{ + background_color: "background_color"; + catalog_feed_tag_name: "catalog_feed_tag_name"; + font_name: "font_name"; + product_recommendation_type: "product_recommendation_type"; + showcase_card_display: "showcase_card_display"; + text_style: "text_style"; + video_crop_style: "video_crop_style"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-feature-details.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-feature-details.d.ts index 4402cd37f9cc8f..395d77c0edafca 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-feature-details.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-feature-details.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdCreativeFeatureDetails * @see {@link https://developers.facebook.com/docs/marketing-api/} 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 3aa8d9e1d1a387..b556124e53183b 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 @@ -1,19 +1,26 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdCreativeFeaturesSpec * @see {@link https://developers.facebook.com/docs/marketing-api/} */ export default class AdCreativeFeaturesSpec extends AbstractCrudObject { static get Fields(): Readonly<{ + adapt_to_placement: "adapt_to_placement"; + ads_with_benefits: "ads_with_benefits"; advantage_plus_creative: "advantage_plus_creative"; + app_highlights: "app_highlights"; audio: "audio"; carousel_to_video: "carousel_to_video"; + catalog_feed_tag: "catalog_feed_tag"; + customize_product_recommendation: "customize_product_recommendation"; cv_transformation: "cv_transformation"; description_automation: "description_automation"; dha_optimization: "dha_optimization"; + feed_caption_optimization: "feed_caption_optimization"; ig_glados_feed: "ig_glados_feed"; image_auto_crop: "image_auto_crop"; image_background_gen: "image_background_gen"; + image_brightness_and_contrast: "image_brightness_and_contrast"; image_enhancement: "image_enhancement"; image_templates: "image_templates"; image_touchups: "image_touchups"; @@ -26,11 +33,13 @@ export default class AdCreativeFeaturesSpec extends AbstractCrudObject { product_metadata_automation: "product_metadata_automation"; product_tags: "product_tags"; profile_card: "profile_card"; + site_extensions: "site_extensions"; standard_enhancements: "standard_enhancements"; standard_enhancements_catalog: "standard_enhancements_catalog"; text_generation: "text_generation"; text_optimizations: "text_optimizations"; video_auto_crop: "video_auto_crop"; + video_filtering: "video_filtering"; video_highlight: "video_highlight"; }>; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-generative-asset-spec.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-generative-asset-spec.d.ts new file mode 100644 index 00000000000000..785fe0adaaf351 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-generative-asset-spec.d.ts @@ -0,0 +1,8 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdCreativeGenerativeAssetSpec + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdCreativeGenerativeAssetSpec extends AbstractCrudObject { + static get Fields(): Readonly<{}>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-house-shops-ads-seller-content.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-house-shops-ads-seller-content.d.ts new file mode 100644 index 00000000000000..935e4bc860bd8c --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-house-shops-ads-seller-content.d.ts @@ -0,0 +1,8 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdCreativeHouseShopsAdsSellerContent + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdCreativeHouseShopsAdsSellerContent extends AbstractCrudObject { + static get Fields(): Readonly<{}>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-image-data-media-elements.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-image-data-media-elements.d.ts new file mode 100644 index 00000000000000..82145fce67f486 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-image-data-media-elements.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdCreativeImageDataMediaElements + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdCreativeImageDataMediaElements extends AbstractCrudObject { + static get Fields(): Readonly<{ + element_id: "element_id"; + element_type: "element_type"; + x: "x"; + y: "y"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-insights.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-insights.d.ts index b7ad8d9b33c608..4d73fb2a5959cb 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-insights.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-insights.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdCreativeInsights * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-instagram-branded-content.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-instagram-branded-content.d.ts index a8c17c5dfcb124..5602af4eeb16f1 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-instagram-branded-content.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-instagram-branded-content.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdCreativeInstagramBrandedContent * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-interactive-components-spec.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-interactive-components-spec.d.ts index 1461ff54eda718..360ae4758a978e 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-interactive-components-spec.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-interactive-components-spec.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdCreativeInteractiveComponentsSpec * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-link-data-app-link-spec.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-link-data-app-link-spec.d.ts index caabf3ec0a32bf..ebf5d10f3716e8 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-link-data-app-link-spec.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-link-data-app-link-spec.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdCreativeLinkDataAppLinkSpec * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-link-data-call-to-action-value.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-link-data-call-to-action-value.d.ts index 3da0032e5158ca..6e2e9a57c33ce9 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-link-data-call-to-action-value.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-link-data-call-to-action-value.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdCreativeLinkDataCallToActionValue * @see {@link https://developers.facebook.com/docs/marketing-api/} 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 b66c034dba4728..52af7ffa5d99d8 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 @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdCreativeLinkDataCallToAction * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -11,15 +11,20 @@ export default class AdCreativeLinkDataCallToAction extends AbstractCrudObject { static get Type(): Readonly<{ add_to_cart: "ADD_TO_CART"; apply_now: "APPLY_NOW"; + ask_about_services: "ASK_ABOUT_SERVICES"; + ask_for_more_info: "ASK_FOR_MORE_INFO"; audio_call: "AUDIO_CALL"; + book_a_consultation: "BOOK_A_CONSULTATION"; book_now: "BOOK_NOW"; book_travel: "BOOK_TRAVEL"; buy: "BUY"; buy_now: "BUY_NOW"; buy_tickets: "BUY_TICKETS"; + buy_via_message: "BUY_VIA_MESSAGE"; call: "CALL"; call_me: "CALL_ME"; call_now: "CALL_NOW"; + chat_with_us: "CHAT_WITH_US"; confirm: "CONFIRM"; contact: "CONTACT"; contact_us: "CONTACT_US"; @@ -32,6 +37,7 @@ export default class AdCreativeLinkDataCallToAction extends AbstractCrudObject { follow_news_storyline: "FOLLOW_NEWS_STORYLINE"; follow_page: "FOLLOW_PAGE"; follow_user: "FOLLOW_USER"; + get_a_quote: "GET_A_QUOTE"; get_directions: "GET_DIRECTIONS"; get_offer: "GET_OFFER"; get_offer_view: "GET_OFFER_VIEW"; @@ -42,10 +48,12 @@ export default class AdCreativeLinkDataCallToAction extends AbstractCrudObject { inquire_now: "INQUIRE_NOW"; install_app: "INSTALL_APP"; install_mobile_app: "INSTALL_MOBILE_APP"; + join_channel: "JOIN_CHANNEL"; learn_more: "LEARN_MORE"; like_page: "LIKE_PAGE"; listen_music: "LISTEN_MUSIC"; listen_now: "LISTEN_NOW"; + make_an_appointment: "MAKE_AN_APPOINTMENT"; message_page: "MESSAGE_PAGE"; mobile_download: "MOBILE_DOWNLOAD"; no_button: "NO_BUTTON"; @@ -79,6 +87,7 @@ export default class AdCreativeLinkDataCallToAction extends AbstractCrudObject { use_mobile_app: "USE_MOBILE_APP"; video_annotation: "VIDEO_ANNOTATION"; video_call: "VIDEO_CALL"; + view_product: "VIEW_PRODUCT"; visit_pages_feed: "VISIT_PAGES_FEED"; watch_more: "WATCH_MORE"; watch_video: "WATCH_VIDEO"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-link-data-child-attachment.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-link-data-child-attachment.d.ts index 3bbf5c3ef4fb08..4b9038eca4979a 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-link-data-child-attachment.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-link-data-child-attachment.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdCreativeLinkDataChildAttachment * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-link-data-custom-overlay-spec.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-link-data-custom-overlay-spec.d.ts new file mode 100644 index 00000000000000..8ebf922f54749d --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-link-data-custom-overlay-spec.d.ts @@ -0,0 +1,70 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdCreativeLinkDataCustomOverlaySpec + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdCreativeLinkDataCustomOverlaySpec extends AbstractCrudObject { + static get Fields(): Readonly<{ + background_color: "background_color"; + float_with_margin: "float_with_margin"; + font: "font"; + option: "option"; + position: "position"; + render_with_icon: "render_with_icon"; + template: "template"; + text_color: "text_color"; + }>; + static get BackgroundColor(): Readonly<{ + background_000000: "background_000000"; + background_0090ff: "background_0090ff"; + background_00af4c: "background_00af4c"; + background_595959: "background_595959"; + background_755dde: "background_755dde"; + background_e50900: "background_e50900"; + background_f23474: "background_f23474"; + background_f78400: "background_f78400"; + background_ffffff: "background_ffffff"; + }>; + static get Font(): Readonly<{ + droid_serif_regular: "droid_serif_regular"; + lato_regular: "lato_regular"; + noto_sans_regular: "noto_sans_regular"; + nunito_sans_bold: "nunito_sans_bold"; + open_sans_bold: "open_sans_bold"; + pt_serif_bold: "pt_serif_bold"; + roboto_condensed_regular: "roboto_condensed_regular"; + roboto_medium: "roboto_medium"; + }>; + static get Option(): Readonly<{ + bank_transfer: "bank_transfer"; + boleto: "boleto"; + cash_on_delivery: "cash_on_delivery"; + discount_with_boleto: "discount_with_boleto"; + fast_delivery: "fast_delivery"; + free_shipping: "free_shipping"; + home_delivery: "home_delivery"; + inventory: "inventory"; + pay_at_hotel: "pay_at_hotel"; + pay_on_arrival: "pay_on_arrival"; + }>; + static get Position(): Readonly<{ + bottom_left: "bottom_left"; + bottom_right: "bottom_right"; + top_left: "top_left"; + top_right: "top_right"; + }>; + static get Template(): Readonly<{ + pill_with_text: "pill_with_text"; + }>; + static get TextColor(): Readonly<{ + text_000000: "text_000000"; + text_007ad0: "text_007ad0"; + text_009c2a: "text_009c2a"; + text_646464: "text_646464"; + text_755dde: "text_755dde"; + text_c91b00: "text_c91b00"; + text_f23474: "text_f23474"; + text_f78400: "text_f78400"; + text_ffffff: "text_ffffff"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-link-data-image-layer-spec.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-link-data-image-layer-spec.d.ts index b23c88cec6f3a4..ab6453f40710bb 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-link-data-image-layer-spec.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-link-data-image-layer-spec.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdCreativeLinkDataImageLayerSpec * @see {@link https://developers.facebook.com/docs/marketing-api/} 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 2711270ec515d3..280c07e562b989 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 @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdCreativeLinkDataImageOverlaySpec * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-link-data-moment.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-link-data-moment.d.ts new file mode 100644 index 00000000000000..f013b0a4ba0f34 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-link-data-moment.d.ts @@ -0,0 +1,16 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdCreativeLinkDataMoment + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdCreativeLinkDataMoment extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + type: "type"; + }>; + static get Type(): Readonly<{ + fb_live_shopping: "FB_LIVE_SHOPPING"; + ig_drops: "IG_DROPS"; + ig_live_shopping: "IG_LIVE_SHOPPING"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-link-data-sponsorship-info-spec.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-link-data-sponsorship-info-spec.d.ts index 3cabdaf81f08da..d6e1babcb19d87 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-link-data-sponsorship-info-spec.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-link-data-sponsorship-info-spec.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdCreativeLinkDataSponsorshipInfoSpec * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-link-data-template-video-spec.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-link-data-template-video-spec.d.ts index 142421e480de0b..8ccd900cf3d246 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-link-data-template-video-spec.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-link-data-template-video-spec.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdCreativeLinkDataTemplateVideoSpec * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-link-data.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-link-data.d.ts index d685be28715b55..a7a52956346aa2 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-link-data.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-link-data.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdCreativeLinkData * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -45,6 +45,7 @@ export default class AdCreativeLinkData extends AbstractCrudObject { carousel_images_multi_items: "carousel_images_multi_items"; carousel_images_single_item: "carousel_images_single_item"; carousel_slideshows: "carousel_slideshows"; + collection_video: "collection_video"; single_image: "single_image"; }>; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-marketing-message-structured-spec.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-marketing-message-structured-spec.d.ts new file mode 100644 index 00000000000000..fb735c299c35ba --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-marketing-message-structured-spec.d.ts @@ -0,0 +1,15 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdCreativeMarketingMessageStructuredSpec + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdCreativeMarketingMessageStructuredSpec extends AbstractCrudObject { + static get Fields(): Readonly<{ + buttons: "buttons"; + footer: "footer"; + greeting: "greeting"; + language: "language"; + referenced_adgroup_id: "referenced_adgroup_id"; + whats_app_business_phone_number_id: "whats_app_business_phone_number_id"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-object-story-spec.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-object-story-spec.d.ts index 6a98405bbee9cb..4204889382e38d 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-object-story-spec.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-object-story-spec.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdCreativeObjectStorySpec * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-omnichannel-link-spec.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-omnichannel-link-spec.d.ts index 95746c3e77c6f6..6031f187975ca2 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-omnichannel-link-spec.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-omnichannel-link-spec.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdCreativeOmnichannelLinkSpec * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-photo-data-media-elements.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-photo-data-media-elements.d.ts index ba958a7b5686c4..4b6ccd3627a766 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-photo-data-media-elements.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-photo-data-media-elements.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdCreativePhotoDataMediaElements * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-photo-data.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-photo-data.d.ts index e5aa628460045b..334bd9b29985c0 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-photo-data.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-photo-data.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdCreativePhotoData * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-place-data.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-place-data.d.ts index 8f4c4493e5e371..f11b73c0e6d3f6 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-place-data.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-place-data.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdCreativePlaceData * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-platform-customization.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-platform-customization.d.ts index a887b14df8327a..264b593154c77d 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-platform-customization.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-platform-customization.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdCreativePlatformCustomization * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-portrait-customizations.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-portrait-customizations.d.ts index f42aa36be48fd2..92c1be1bbfe27c 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-portrait-customizations.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-portrait-customizations.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdCreativePortraitCustomizations * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-post-click-configuration.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-post-click-configuration.d.ts index 36199aa141344a..fb5cef39d7edc5 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-post-click-configuration.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-post-click-configuration.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdCreativePostClickConfiguration * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-promotion-metadata-spec.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-promotion-metadata-spec.d.ts new file mode 100644 index 00000000000000..4a7f94eeec8f3c --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-promotion-metadata-spec.d.ts @@ -0,0 +1,16 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdCreativePromotionMetadataSpec + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdCreativePromotionMetadataSpec extends AbstractCrudObject { + static get Fields(): Readonly<{ + end_date: "end_date"; + id: "id"; + promotion_source: "promotion_source"; + promotion_type: "promotion_type"; + promotion_value: "promotion_value"; + required_code: "required_code"; + start_date: "start_date"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-recommender-settings.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-recommender-settings.d.ts index 7cd3f01b77f9fb..b64cf3c7dc766a 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-recommender-settings.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-recommender-settings.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdCreativeRecommenderSettings * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-regional-regulation-disclaimer.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-regional-regulation-disclaimer.d.ts new file mode 100644 index 00000000000000..eeaed79e87f9ff --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-regional-regulation-disclaimer.d.ts @@ -0,0 +1,8 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdCreativeRegionalRegulationDisclaimer + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdCreativeRegionalRegulationDisclaimer extends AbstractCrudObject { + static get Fields(): Readonly<{}>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-reward-info.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-reward-info.d.ts new file mode 100644 index 00000000000000..b4f1992d38e569 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-reward-info.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdCreativeRewardInfo + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdCreativeRewardInfo extends AbstractCrudObject { + static get Fields(): Readonly<{ + reward_offer_id: "reward_offer_id"; + reward_program_id: "reward_program_id"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-shop-spec.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-shop-spec.d.ts new file mode 100644 index 00000000000000..0db99006d579f4 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-shop-spec.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdCreativeShopSpec + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdCreativeShopSpec extends AbstractCrudObject { + static get Fields(): Readonly<{ + collection_id: "collection_id"; + landing_view: "landing_view"; + shop_id: "shop_id"; + }>; +} 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 new file mode 100644 index 00000000000000..922c9ef6dda81c --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-site-links-spec.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdCreativeSiteLinksSpec + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdCreativeSiteLinksSpec extends AbstractCrudObject { + static get Fields(): Readonly<{ + site_link_title: "site_link_title"; + site_link_url: "site_link_url"; + }>; +} 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 a51012491294d7..24500f3018ccef 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 @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdCreativeSourcingSpec * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -6,5 +6,8 @@ import { AbstractCrudObject } from './../abstract-crud-object'; export default class AdCreativeSourcingSpec extends AbstractCrudObject { static get Fields(): Readonly<{ associated_product_set_id: "associated_product_set_id"; + promotion_metadata_spec: "promotion_metadata_spec"; + site_links_spec: "site_links_spec"; + source_url: "source_url"; }>; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-static-fallback-spec.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-static-fallback-spec.d.ts index 5203f5294b2878..2a8d6009793b89 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-static-fallback-spec.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-static-fallback-spec.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdCreativeStaticFallbackSpec * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-template-url-spec.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-template-url-spec.d.ts index b295ecdd382ef6..b4ad32eb22a8ab 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-template-url-spec.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-template-url-spec.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdCreativeTemplateURLSpec * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-text-data.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-text-data.d.ts index c8cb4bbbed1b15..603bb73d076d26 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-text-data.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-text-data.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdCreativeTextData * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-video-data-custom-overlay-spec.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-video-data-custom-overlay-spec.d.ts new file mode 100644 index 00000000000000..3eb818e598bbe2 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-video-data-custom-overlay-spec.d.ts @@ -0,0 +1,46 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdCreativeVideoDataCustomOverlaySpec + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdCreativeVideoDataCustomOverlaySpec extends AbstractCrudObject { + static get Fields(): Readonly<{ + background_color: "background_color"; + background_opacity: "background_opacity"; + duration: "duration"; + float_with_margin: "float_with_margin"; + full_width: "full_width"; + option: "option"; + position: "position"; + start: "start"; + template: "template"; + text_color: "text_color"; + }>; + static get BackgroundOpacity(): Readonly<{ + half: "half"; + solid: "solid"; + }>; + static get Option(): Readonly<{ + bank_transfer: "bank_transfer"; + boleto: "boleto"; + cash_on_delivery: "cash_on_delivery"; + discount_with_boleto: "discount_with_boleto"; + fast_delivery: "fast_delivery"; + free_shipping: "free_shipping"; + home_delivery: "home_delivery"; + inventory: "inventory"; + pay_at_hotel: "pay_at_hotel"; + pay_on_arrival: "pay_on_arrival"; + }>; + static get Position(): Readonly<{ + middle_center: "middle_center"; + middle_left: "middle_left"; + middle_right: "middle_right"; + top_center: "top_center"; + top_left: "top_left"; + top_right: "top_right"; + }>; + static get Template(): Readonly<{ + rectangle_with_text: "rectangle_with_text"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-video-data-media-elements.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-video-data-media-elements.d.ts new file mode 100644 index 00000000000000..3c00a2d0b22e3f --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-video-data-media-elements.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdCreativeVideoDataMediaElements + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdCreativeVideoDataMediaElements extends AbstractCrudObject { + static get Fields(): Readonly<{ + element_id: "element_id"; + element_type: "element_type"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-video-data.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-video-data.d.ts index 00cc71adeb8c3c..4fa24056b87863 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-video-data.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-video-data.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdCreativeVideoData * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-creative-whats-app-channel-spec.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-whats-app-channel-spec.d.ts new file mode 100644 index 00000000000000..f166a4c901b11d --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-creative-whats-app-channel-spec.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdCreativeWhatsAppChannelSpec + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdCreativeWhatsAppChannelSpec extends AbstractCrudObject { + static get Fields(): Readonly<{ + channel_id: "channel_id"; + channel_url: "channel_url"; + }>; +} 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 36967275d479f4..627910395a47dd 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 @@ -1,6 +1,6 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; +import Cursor from "./../cursor"; /** * AdCreative * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -22,6 +22,7 @@ export default class AdCreative extends AbstractCrudObject { categorization_criteria: "categorization_criteria"; category_media_source: "category_media_source"; collaborative_ads_lsb_image_bank_id: "collaborative_ads_lsb_image_bank_id"; + contextual_multi_ads: "contextual_multi_ads"; creative_sourcing_spec: "creative_sourcing_spec"; degrees_of_freedom_spec: "degrees_of_freedom_spec"; destination_set_id: "destination_set_id"; @@ -47,7 +48,6 @@ export default class AdCreative extends AbstractCrudObject { link_destination_display_url: "link_destination_display_url"; link_og_id: "link_og_id"; link_url: "link_url"; - messenger_sponsored_message: "messenger_sponsored_message"; name: "name"; object_id: "object_id"; object_store_url: "object_store_url"; @@ -56,6 +56,7 @@ export default class AdCreative extends AbstractCrudObject { object_type: "object_type"; object_url: "object_url"; omnichannel_link_spec: "omnichannel_link_spec"; + page_welcome_message: "page_welcome_message"; photo_album_source_object_story_id: "photo_album_source_object_story_id"; place_page_set_id: "place_page_set_id"; platform_customizations: "platform_customizations"; @@ -77,15 +78,20 @@ export default class AdCreative extends AbstractCrudObject { static get CallToActionType(): Readonly<{ add_to_cart: "ADD_TO_CART"; apply_now: "APPLY_NOW"; + ask_about_services: "ASK_ABOUT_SERVICES"; + ask_for_more_info: "ASK_FOR_MORE_INFO"; audio_call: "AUDIO_CALL"; + book_a_consultation: "BOOK_A_CONSULTATION"; book_now: "BOOK_NOW"; book_travel: "BOOK_TRAVEL"; buy: "BUY"; buy_now: "BUY_NOW"; buy_tickets: "BUY_TICKETS"; + buy_via_message: "BUY_VIA_MESSAGE"; call: "CALL"; call_me: "CALL_ME"; call_now: "CALL_NOW"; + chat_with_us: "CHAT_WITH_US"; confirm: "CONFIRM"; contact: "CONTACT"; contact_us: "CONTACT_US"; @@ -98,6 +104,7 @@ export default class AdCreative extends AbstractCrudObject { follow_news_storyline: "FOLLOW_NEWS_STORYLINE"; follow_page: "FOLLOW_PAGE"; follow_user: "FOLLOW_USER"; + get_a_quote: "GET_A_QUOTE"; get_directions: "GET_DIRECTIONS"; get_offer: "GET_OFFER"; get_offer_view: "GET_OFFER_VIEW"; @@ -108,10 +115,12 @@ export default class AdCreative extends AbstractCrudObject { inquire_now: "INQUIRE_NOW"; install_app: "INSTALL_APP"; install_mobile_app: "INSTALL_MOBILE_APP"; + join_channel: "JOIN_CHANNEL"; learn_more: "LEARN_MORE"; like_page: "LIKE_PAGE"; listen_music: "LISTEN_MUSIC"; listen_now: "LISTEN_NOW"; + make_an_appointment: "MAKE_AN_APPOINTMENT"; message_page: "MESSAGE_PAGE"; mobile_download: "MOBILE_DOWNLOAD"; no_button: "NO_BUTTON"; @@ -145,6 +154,7 @@ export default class AdCreative extends AbstractCrudObject { use_mobile_app: "USE_MOBILE_APP"; video_annotation: "VIDEO_ANNOTATION"; video_call: "VIDEO_CALL"; + view_product: "VIEW_PRODUCT"; visit_pages_feed: "VISIT_PAGES_FEED"; watch_more: "WATCH_MORE"; watch_video: "WATCH_VIDEO"; @@ -181,6 +191,7 @@ export default class AdCreative extends AbstractCrudObject { static get AuthorizationCategory(): Readonly<{ none: "NONE"; political: "POLITICAL"; + political_with_digitally_created_media: "POLITICAL_WITH_DIGITALLY_CREATED_MEDIA"; }>; static get CategorizationCriteria(): Readonly<{ brand: "brand"; @@ -201,14 +212,10 @@ export default class AdCreative extends AbstractCrudObject { all: "ALL"; any: "ANY"; }>; - createAdLabel(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getCreativeInsights(fields: string[], params?: Record): Promise; - getCreativeInsights(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCreativeInsights(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getPreviews(fields: string[], params?: Record): Promise; - getPreviews(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPreviews(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; + createAdLabel(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getCreativeInsights(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getPreviews(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/ad-custom-derived-metrics.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-custom-derived-metrics.d.ts new file mode 100644 index 00000000000000..b17b03354966c3 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-custom-derived-metrics.d.ts @@ -0,0 +1,27 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdCustomDerivedMetrics + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdCustomDerivedMetrics extends AbstractCrudObject { + static get Fields(): Readonly<{ + ad_account_id: "ad_account_id"; + business: "business"; + creation_time: "creation_time"; + creator: "creator"; + custom_derived_metric_type: "custom_derived_metric_type"; + deletion_time: "deletion_time"; + deletor: "deletor"; + description: "description"; + format_type: "format_type"; + formula: "formula"; + has_attribution_windows: "has_attribution_windows"; + has_inline_attribution_window: "has_inline_attribution_window"; + id: "id"; + name: "name"; + permission: "permission"; + saved_report_id: "saved_report_id"; + scope: "scope"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-customization-rule-spec.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-customization-rule-spec.d.ts index ad8eb7e62e5a0c..17506a6aedbed9 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-customization-rule-spec.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-customization-rule-spec.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdCustomizationRuleSpec * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-default-values.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-default-values.d.ts new file mode 100644 index 00000000000000..8ad5f72a754a88 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-default-values.d.ts @@ -0,0 +1,10 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdDefaultValues + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdDefaultValues extends AbstractCrudObject { + static get Fields(): Readonly<{ + campaign_group: "campaign_group"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-draft.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-draft.d.ts new file mode 100644 index 00000000000000..deb8f1a2b27812 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-draft.d.ts @@ -0,0 +1,25 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdDraft + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdDraft extends AbstractCrudObject { + static get Fields(): Readonly<{ + account_id: "account_id"; + api_version: "api_version"; + async_request_set: "async_request_set"; + author_id: "author_id"; + created_by: "created_by"; + draft_version: "draft_version"; + id: "id"; + is_active: "is_active"; + name: "name"; + ownership_type: "ownership_type"; + publish_status: "publish_status"; + state: "state"; + summary: "summary"; + time_created: "time_created"; + time_updated: "time_updated"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-dynamic-creative.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-dynamic-creative.d.ts index 9f1276f3936e42..0073865d1da460 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-dynamic-creative.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-dynamic-creative.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdDynamicCreative * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-entity-target-spend.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-entity-target-spend.d.ts index f4c63dfa5eaacf..c0857d8a85bb80 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-entity-target-spend.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-entity-target-spend.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdEntityTargetSpend * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-export-preset.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-export-preset.d.ts new file mode 100644 index 00000000000000..eddbc8b3b1ce5d --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-export-preset.d.ts @@ -0,0 +1,16 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdExportPreset + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdExportPreset extends AbstractCrudObject { + static get Fields(): Readonly<{ + created_time: "created_time"; + fields: "fields"; + id: "id"; + name: "name"; + owner: "owner"; + updated_time: "updated_time"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-image.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-image.d.ts index e65ec2e84a2971..72298bf14ee962 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-image.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-image.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdImage * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -28,5 +28,5 @@ export default class AdImage extends AbstractCrudObject { deleted: "DELETED"; internal: "INTERNAL"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-keyword-stats.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-keyword-stats.d.ts new file mode 100644 index 00000000000000..97e26d3533b767 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-keyword-stats.d.ts @@ -0,0 +1,29 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdKeywordStats + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdKeywordStats extends AbstractCrudObject { + static get Fields(): Readonly<{ + actions: "actions"; + clicks: "clicks"; + cost_per_total_action: "cost_per_total_action"; + cost_per_unique_click: "cost_per_unique_click"; + cpc: "cpc"; + cpm: "cpm"; + cpp: "cpp"; + ctr: "ctr"; + frequency: "frequency"; + id: "id"; + impressions: "impressions"; + name: "name"; + reach: "reach"; + spend: "spend"; + total_actions: "total_actions"; + total_unique_actions: "total_unique_actions"; + unique_actions: "unique_actions"; + unique_clicks: "unique_clicks"; + unique_ctr: "unique_ctr"; + unique_impressions: "unique_impressions"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-keywords.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-keywords.d.ts index b8939247bfb9b8..e4ac0adcb5fce6 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-keywords.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-keywords.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdKeywords * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-kpi-shift.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-kpi-shift.d.ts new file mode 100644 index 00000000000000..7cf461dc364f77 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-kpi-shift.d.ts @@ -0,0 +1,15 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdKpiShift + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdKpiShift extends AbstractCrudObject { + static get Fields(): Readonly<{ + ad_set: "ad_set"; + cost_per_result_shift: "cost_per_result_shift"; + enough_effective_days: "enough_effective_days"; + result_indicator: "result_indicator"; + result_shift: "result_shift"; + spend_shift: "spend_shift"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-label.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-label.d.ts index 31dc2557278c1d..ab17e50d19b8a1 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-label.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-label.d.ts @@ -1,6 +1,6 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; +import Cursor from "./../cursor"; /** * AdLabel * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -13,19 +13,11 @@ export default class AdLabel extends AbstractCrudObject { name: "name"; updated_time: "updated_time"; }>; - getAdCreatives(fields: string[], params?: Record): Promise; - getAdCreatives(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdCreatives(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAds(fields: string[], params?: Record): Promise; - getAds(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAds(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAdSets(fields: string[], params?: Record): Promise; - getAdSets(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdSets(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getCampaigns(fields: string[], params?: Record): Promise; - getCampaigns(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCampaigns(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; + getAdCreatives(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getAds(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getAdSets(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getCampaigns(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/ad-light-adgroup.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-light-adgroup.d.ts new file mode 100644 index 00000000000000..2109143c02f379 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-light-adgroup.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdLightAdgroup + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdLightAdgroup extends AbstractCrudObject { + static get Fields(): Readonly<{ + adset_id: "adset_id"; + id: "id"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-light-campaign-group.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-light-campaign-group.d.ts new file mode 100644 index 00000000000000..411ed3430632d5 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-light-campaign-group.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdLightCampaignGroup + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdLightCampaignGroup extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-light-campaign.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-light-campaign.d.ts new file mode 100644 index 00000000000000..83a564ff604f58 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-light-campaign.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdLightCampaign + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdLightCampaign extends AbstractCrudObject { + static get Fields(): Readonly<{ + campaign_id: "campaign_id"; + id: "id"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-limit-setting.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-limit-setting.d.ts new file mode 100644 index 00000000000000..4f4d68211cdeaa --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-limit-setting.d.ts @@ -0,0 +1,10 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdLimitSetting + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdLimitSetting extends AbstractCrudObject { + static get Fields(): Readonly<{ + limit_allocation_by_page_advertisers: "limit_allocation_by_page_advertisers"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-limits-enforcement-data.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-limits-enforcement-data.d.ts new file mode 100644 index 00000000000000..521916136feac2 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-limits-enforcement-data.d.ts @@ -0,0 +1,15 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdLimitsEnforcementData + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdLimitsEnforcementData extends AbstractCrudObject { + static get Fields(): Readonly<{ + ad_limit_on_page: "ad_limit_on_page"; + ad_limit_on_scope: "ad_limit_on_scope"; + ad_volume_on_page: "ad_volume_on_page"; + ad_volume_on_scope: "ad_volume_on_scope"; + is_admin: "is_admin"; + page_name: "page_name"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-monetization-property.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-monetization-property.d.ts index ff22da8f6925b0..0c279368819608 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-monetization-property.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-monetization-property.d.ts @@ -1,5 +1,5 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; /** * AdMonetizationProperty * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -9,12 +9,8 @@ export default class AdMonetizationProperty extends AbstractCrudObject { owner_business: "owner_business"; id: "id"; }>; - getAdNetworkAnalytics(fields: string[], params?: Record): Promise; - getAdNetworkAnalytics(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdNetworkAnalytics(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createAdNetworkAnalytic(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getAdNetworkAnalyticsResults(fields: string[], params?: Record): Promise; - getAdNetworkAnalyticsResults(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdNetworkAnalyticsResults(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - get(fields: string[], params?: Record): Promise; + 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; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-network-analytics-async-query-export.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-network-analytics-async-query-export.d.ts new file mode 100644 index 00000000000000..2801f72498c7b9 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-network-analytics-async-query-export.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdNetworkAnalyticsAsyncQueryExport + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdNetworkAnalyticsAsyncQueryExport extends AbstractCrudObject { + static get Fields(): Readonly<{ + error: "error"; + export_link: "export_link"; + query_id: "query_id"; + status: "status"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-network-analytics-async-query-result.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-network-analytics-async-query-result.d.ts index c18a9fe7896d23..5c7f1f99ae484a 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-network-analytics-async-query-result.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-network-analytics-async-query-result.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdNetworkAnalyticsAsyncQueryResult * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-network-analytics-sync-query-result.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-network-analytics-sync-query-result.d.ts index e545a9c4cf2db0..c1ae8a1b48123e 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-network-analytics-sync-query-result.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-network-analytics-sync-query-result.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdNetworkAnalyticsSyncQueryResult * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-place-page-set-metadata.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-place-page-set-metadata.d.ts index d3ec4181d640d2..13c471486031e2 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-place-page-set-metadata.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-place-page-set-metadata.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdPlacePageSetMetadata * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-place-page-set.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-place-page-set.d.ts index dcb4ef98d1c6de..a2f6353b866e26 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-place-page-set.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-place-page-set.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdPlacePageSet * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -21,5 +21,5 @@ export default class AdPlacePageSet extends AbstractCrudObject { marketing_area: "MARKETING_AREA"; none: "NONE"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-placement.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-placement.d.ts index ffa78f906c03ac..daf052dbc93108 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-placement.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-placement.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdPlacement * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -15,5 +15,5 @@ export default class AdPlacement extends AbstractCrudObject { platform: "platform"; status: "status"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } 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 4c13755cea0648..419c03f034b71e 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 @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdPreview * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -17,6 +17,7 @@ export default class AdPreview extends AbstractCrudObject { desktop_feed_standard: "DESKTOP_FEED_STANDARD"; facebook_profile_feed_desktop: "FACEBOOK_PROFILE_FEED_DESKTOP"; facebook_profile_feed_mobile: "FACEBOOK_PROFILE_FEED_MOBILE"; + facebook_profile_reels_mobile: "FACEBOOK_PROFILE_REELS_MOBILE"; facebook_reels_banner: "FACEBOOK_REELS_BANNER"; facebook_reels_banner_desktop: "FACEBOOK_REELS_BANNER_DESKTOP"; facebook_reels_mobile: "FACEBOOK_REELS_MOBILE"; @@ -29,6 +30,7 @@ export default class AdPreview extends AbstractCrudObject { instagram_explore_immersive: "INSTAGRAM_EXPLORE_IMMERSIVE"; instagram_feed_web: "INSTAGRAM_FEED_WEB"; instagram_feed_web_m_site: "INSTAGRAM_FEED_WEB_M_SITE"; + instagram_lead_gen_multi_submit_ads: "INSTAGRAM_LEAD_GEN_MULTI_SUBMIT_ADS"; instagram_profile_feed: "INSTAGRAM_PROFILE_FEED"; instagram_profile_reels: "INSTAGRAM_PROFILE_REELS"; instagram_reels: "INSTAGRAM_REELS"; @@ -43,9 +45,13 @@ 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_mobile: "INSTREAM_BANNER_FULLSCREEN_MOBILE"; + instream_banner_immersive_mobile: "INSTREAM_BANNER_IMMERSIVE_MOBILE"; instream_banner_mobile: "INSTREAM_BANNER_MOBILE"; instream_video_desktop: "INSTREAM_VIDEO_DESKTOP"; + instream_video_fullscreen_mobile: "INSTREAM_VIDEO_FULLSCREEN_MOBILE"; instream_video_image: "INSTREAM_VIDEO_IMAGE"; + instream_video_immersive_mobile: "INSTREAM_VIDEO_IMMERSIVE_MOBILE"; instream_video_mobile: "INSTREAM_VIDEO_MOBILE"; job_browser_desktop: "JOB_BROWSER_DESKTOP"; job_browser_mobile: "JOB_BROWSER_MOBILE"; @@ -61,6 +67,8 @@ export default class AdPreview extends AbstractCrudObject { mobile_native: "MOBILE_NATIVE"; right_column_standard: "RIGHT_COLUMN_STANDARD"; suggested_video_desktop: "SUGGESTED_VIDEO_DESKTOP"; + suggested_video_fullscreen_mobile: "SUGGESTED_VIDEO_FULLSCREEN_MOBILE"; + suggested_video_immersive_mobile: "SUGGESTED_VIDEO_IMMERSIVE_MOBILE"; suggested_video_mobile: "SUGGESTED_VIDEO_MOBILE"; watch_feed_home: "WATCH_FEED_HOME"; watch_feed_mobile: "WATCH_FEED_MOBILE"; 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 447a708f39346d..0e7cd8fe5637be 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 @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdPromotedObject * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -26,8 +26,10 @@ export default class AdPromotedObject extends AbstractCrudObject { place_page_set_id: "place_page_set_id"; product_catalog_id: "product_catalog_id"; product_item_id: "product_item_id"; + product_set: "product_set"; product_set_id: "product_set_id"; retention_days: "retention_days"; + whatsapp_phone_number: "whatsapp_phone_number"; }>; static get CustomEventType(): Readonly<{ achievement_unlocked: "ACHIEVEMENT_UNLOCKED"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-proposal.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-proposal.d.ts new file mode 100644 index 00000000000000..809d8f3e400c2d --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-proposal.d.ts @@ -0,0 +1,29 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdProposal + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdProposal extends AbstractCrudObject { + static get Fields(): Readonly<{ + ad_proposal_type_name: "ad_proposal_type_name"; + adaccount: "adaccount"; + creation_time: "creation_time"; + creator: "creator"; + delivery_interface: "delivery_interface"; + expiration_time: "expiration_time"; + has_conflict: "has_conflict"; + id: "id"; + kpi_metric: "kpi_metric"; + message: "message"; + name: "name"; + proposal_dts_template: "proposal_dts_template"; + proposal_template_name: "proposal_template_name"; + recommendation: "recommendation"; + review_time: "review_time"; + reviewed_by: "reviewed_by"; + send_time: "send_time"; + status: "status"; + use_testing: "use_testing"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-recommendation-data.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-recommendation-data.d.ts index aeb5549df3f286..76a0b29cd2b377 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-recommendation-data.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-recommendation-data.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdRecommendationData * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-recommendation.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-recommendation.d.ts index 3cfcbaf24c251b..3762934d5a4096 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-recommendation.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-recommendation.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdRecommendation * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -12,6 +12,7 @@ export default class AdRecommendation extends AbstractCrudObject { message: "message"; recommendation_data: "recommendation_data"; title: "title"; + value: "value"; }>; static get Confidence(): Readonly<{ high: "HIGH"; 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 1df19048e064c3..673cabafd3234f 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 @@ -1,6 +1,6 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import Cursor from './../cursor'; -import FacebookAdsApi from './../api'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; +import FacebookAdsApi from "./../api"; /** * AdReportRun * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -21,9 +21,7 @@ export default class AdReportRun extends AbstractCrudObject { time_completed: "time_completed"; time_ref: "time_ref"; }>; - getInsights(fields: string[], params?: Record): Promise; - getInsights(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getInsights(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - get(fields: string[], params?: Record): Promise; - constructor(id?: number | string | null, data?: Record, parentId?: string | null, api?: FacebookAdsApi | null); + getInsights(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + get(fields: string[], params?: Record): Promise; + constructor(id: number | (string | null | undefined), data: Record, parentId: string | null | undefined, api: FacebookAdsApi | null | undefined); } diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-rule-evaluation-spec.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-rule-evaluation-spec.d.ts index 8d5bf3bf832d1a..aabf80da89e542 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-rule-evaluation-spec.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-rule-evaluation-spec.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdRuleEvaluationSpec * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -14,5 +14,5 @@ export default class AdRuleEvaluationSpec extends AbstractCrudObject { schedule: "SCHEDULE"; trigger: "TRIGGER"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-rule-execution-options.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-rule-execution-options.d.ts index 38dbbc7dc3d4e8..92d1b0685cd1c9 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-rule-execution-options.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-rule-execution-options.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdRuleExecutionOptions * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-rule-execution-spec.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-rule-execution-spec.d.ts index 4b4e2d03eb6393..032bb15b733a90 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-rule-execution-spec.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-rule-execution-spec.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdRuleExecutionSpec * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -17,6 +17,7 @@ export default class AdRuleExecutionSpec extends AbstractCrudObject { change_bid: "CHANGE_BID"; change_budget: "CHANGE_BUDGET"; change_campaign_budget: "CHANGE_CAMPAIGN_BUDGET"; + dco: "DCO"; increase_radius: "INCREASE_RADIUS"; notification: "NOTIFICATION"; pause: "PAUSE"; @@ -28,5 +29,5 @@ export default class AdRuleExecutionSpec extends AbstractCrudObject { update_lax_budget: "UPDATE_LAX_BUDGET"; update_lax_duration: "UPDATE_LAX_DURATION"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-rule-filters.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-rule-filters.d.ts index c68293f851fc4b..95f3f6f882f55e 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-rule-filters.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-rule-filters.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdRuleFilters * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-rule-history-result-action.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-rule-history-result-action.d.ts index ab9d23038e3f69..e941a9dfaba866 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-rule-history-result-action.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-rule-history-result-action.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdRuleHistoryResultAction * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-rule-history-result.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-rule-history-result.d.ts index bc8fc6ecaefc83..bf790ab234df67 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-rule-history-result.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-rule-history-result.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdRuleHistoryResult * @see {@link https://developers.facebook.com/docs/marketing-api/} 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 200661ed16a15e..a3cbc22bd7e776 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 @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdRuleHistory * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -19,8 +19,14 @@ export default class AdRuleHistory extends AbstractCrudObject { changed_bid: "CHANGED_BID"; changed_budget: "CHANGED_BUDGET"; email: "EMAIL"; + enable_advantage_campaign_budget: "ENABLE_ADVANTAGE_CAMPAIGN_BUDGET"; enable_advantage_plus_creative: "ENABLE_ADVANTAGE_PLUS_CREATIVE"; + enable_advantage_plus_placements: "ENABLE_ADVANTAGE_PLUS_PLACEMENTS"; enable_autoflow: "ENABLE_AUTOFLOW"; + enable_gen_uncrop: "ENABLE_GEN_UNCROP"; + enable_music: "ENABLE_MUSIC"; + enable_semantic_based_audience_expansion: "ENABLE_SEMANTIC_BASED_AUDIENCE_EXPANSION"; + enable_shops_ads: "ENABLE_SHOPS_ADS"; endpoint_pinged: "ENDPOINT_PINGED"; error: "ERROR"; facebook_notification_sent: "FACEBOOK_NOTIFICATION_SENT"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-rule-schedule-spec.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-rule-schedule-spec.d.ts index 0dc2ea1d02a1db..bbd7fff5987ba8 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-rule-schedule-spec.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-rule-schedule-spec.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdRuleScheduleSpec * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-rule-schedule.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-rule-schedule.d.ts index 0a1a41001a6268..92941a41b8ab20 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-rule-schedule.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-rule-schedule.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdRuleSchedule * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-rule-trigger.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-rule-trigger.d.ts index ba4b02fd663fbc..e82450a0d2f326 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-rule-trigger.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-rule-trigger.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdRuleTrigger * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-rule.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-rule.d.ts index ea1a067d58f1e1..5b6cfd7c42aefa 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-rule.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-rule.d.ts @@ -1,6 +1,6 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; +import Cursor from "./../cursor"; /** * AdRule * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -55,12 +55,10 @@ export default class AdRule extends AbstractCrudObject { rule_syd_redirect: "RULE_SYD_REDIRECT"; rule_templates_dialog: "RULE_TEMPLATES_DIALOG"; }>; - createExecute(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getHistory(fields: string[], params?: Record): Promise; - getHistory(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getHistory(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createPreview(fields: string[], params?: Record, pathOverride?: string | null): Promise; - delete(fields: string[], params?: Record): Promise; - get(fields: string[], params?: Record): Promise; - update(fields: string[], params?: Record): Promise; + createExecute(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getHistory(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createPreview(fields: string[], params?: Record, pathOverride?: string | null): 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/ad-saved-keywords.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-saved-keywords.d.ts new file mode 100644 index 00000000000000..8a5319320c9f76 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-saved-keywords.d.ts @@ -0,0 +1,17 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdSavedKeywords + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdSavedKeywords extends AbstractCrudObject { + static get Fields(): Readonly<{ + account: "account"; + id: "id"; + keywords: "keywords"; + name: "name"; + run_status: "run_status"; + time_created: "time_created"; + time_updated: "time_updated"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-saved-location.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-saved-location.d.ts new file mode 100644 index 00000000000000..7249777627ba73 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-saved-location.d.ts @@ -0,0 +1,20 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdSavedLocation + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdSavedLocation extends AbstractCrudObject { + static get Fields(): Readonly<{ + cities: "cities"; + countries: "countries"; + country_groups: "country_groups"; + custom_locations: "custom_locations"; + geo_markets: "geo_markets"; + id: "id"; + location_sentences: "location_sentences"; + name: "name"; + regions: "regions"; + zips: "zips"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-saved-report.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-saved-report.d.ts new file mode 100644 index 00000000000000..08a48b024d2772 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-saved-report.d.ts @@ -0,0 +1,28 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdSavedReport + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdSavedReport extends AbstractCrudObject { + static get Fields(): Readonly<{ + app_owner: "app_owner"; + breakdowns: "breakdowns"; + builtin_column_set: "builtin_column_set"; + creation_source: "creation_source"; + date_interval: "date_interval"; + date_preset: "date_preset"; + format_version: "format_version"; + id: "id"; + insights_section: "insights_section"; + is_shared_unread: "is_shared_unread"; + level: "level"; + name: "name"; + normalized_filter: "normalized_filter"; + sort: "sort"; + user_attribution_windows: "user_attribution_windows"; + user_columns: "user_columns"; + user_filter: "user_filter"; + user_owner: "user_owner"; + }>; + get(fields: string[], params?: Record): Promise; +} 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 24249b2954a0af..854c728fbfbfe1 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 @@ -1,8 +1,8 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; -import Cursor from './../cursor'; -import HighDemandPeriod from './high-demand-period'; -import AdReportRun from './ad-report-run'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; +import Cursor from "./../cursor"; +import HighDemandPeriod from "./high-demand-period"; +import AdReportRun from "./ad-report-run"; /** * AdSet * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -57,6 +57,8 @@ export default class AdSet extends AbstractCrudObject { promoted_object: "promoted_object"; recommendations: "recommendations"; recurring_budget_semantics: "recurring_budget_semantics"; + regional_regulated_categories: "regional_regulated_categories"; + regional_regulation_identities: "regional_regulation_identities"; review_feedback: "review_feedback"; rf_prediction_id: "rf_prediction_id"; source_adset: "source_adset"; @@ -74,6 +76,7 @@ export default class AdSet extends AbstractCrudObject { cost_cap: "COST_CAP"; lowest_cost_without_cap: "LOWEST_COST_WITHOUT_CAP"; lowest_cost_with_bid_cap: "LOWEST_COST_WITH_BID_CAP"; + lowest_cost_with_min_roas: "LOWEST_COST_WITH_MIN_ROAS"; }>; static get BillingEvent(): Readonly<{ app_installs: "APP_INSTALLS"; @@ -116,12 +119,14 @@ export default class AdSet extends AbstractCrudObject { landing_page_views: "LANDING_PAGE_VIEWS"; lead_generation: "LEAD_GENERATION"; link_clicks: "LINK_CLICKS"; + meaningful_call_attempt: "MEANINGFUL_CALL_ATTEMPT"; messaging_appointment_conversion: "MESSAGING_APPOINTMENT_CONVERSION"; messaging_purchase_conversion: "MESSAGING_PURCHASE_CONVERSION"; none: "NONE"; offsite_conversions: "OFFSITE_CONVERSIONS"; page_likes: "PAGE_LIKES"; post_engagement: "POST_ENGAGEMENT"; + profile_visit: "PROFILE_VISIT"; quality_call: "QUALITY_CALL"; quality_lead: "QUALITY_LEAD"; reach: "REACH"; @@ -138,34 +143,46 @@ export default class AdSet extends AbstractCrudObject { paused: "PAUSED"; }>; static get DatePreset(): Readonly<{ - data_maximum: "data_maximum"; - last_14d: "last_14d"; - last_28d: "last_28d"; - last_30d: "last_30d"; - last_3d: "last_3d"; - last_7d: "last_7d"; - last_90d: "last_90d"; - last_month: "last_month"; - last_quarter: "last_quarter"; - last_week_mon_sun: "last_week_mon_sun"; - last_week_sun_sat: "last_week_sun_sat"; - last_year: "last_year"; - maximum: "maximum"; - this_month: "this_month"; - this_quarter: "this_quarter"; - this_week_mon_today: "this_week_mon_today"; - this_week_sun_today: "this_week_sun_today"; - this_year: "this_year"; - today: "today"; - yesterday: "yesterday"; + data_maximum: "DATA_MAXIMUM"; + last_14d: "LAST_14D"; + last_28d: "LAST_28D"; + last_30d: "LAST_30D"; + last_3d: "LAST_3D"; + last_7d: "LAST_7D"; + last_90d: "LAST_90D"; + last_month: "LAST_MONTH"; + last_quarter: "LAST_QUARTER"; + last_week_mon_sun: "LAST_WEEK_MON_SUN"; + last_week_sun_sat: "LAST_WEEK_SUN_SAT"; + last_year: "LAST_YEAR"; + maximum: "MAXIMUM"; + this_month: "THIS_MONTH"; + this_quarter: "THIS_QUARTER"; + this_week_mon_today: "THIS_WEEK_MON_TODAY"; + this_week_sun_today: "THIS_WEEK_SUN_TODAY"; + this_year: "THIS_YEAR"; + today: "TODAY"; + yesterday: "YESTERDAY"; }>; static get DestinationType(): Readonly<{ app: "APP"; applinks_automatic: "APPLINKS_AUTOMATIC"; facebook: "FACEBOOK"; + instagram_direct: "INSTAGRAM_DIRECT"; + instagram_profile: "INSTAGRAM_PROFILE"; + messaging_instagram_direct_messenger: "MESSAGING_INSTAGRAM_DIRECT_MESSENGER"; + messaging_instagram_direct_messenger_whatsapp: "MESSAGING_INSTAGRAM_DIRECT_MESSENGER_WHATSAPP"; + messaging_instagram_direct_whatsapp: "MESSAGING_INSTAGRAM_DIRECT_WHATSAPP"; + messaging_messenger_whatsapp: "MESSAGING_MESSENGER_WHATSAPP"; messenger: "MESSENGER"; - undefined: "UNDEFINED"; + on_ad: "ON_AD"; + on_event: "ON_EVENT"; + on_page: "ON_PAGE"; + on_post: "ON_POST"; + on_video: "ON_VIDEO"; + shop_automatic: "SHOP_AUTOMATIC"; website: "WEBSITE"; + whatsapp: "WHATSAPP"; }>; static get ExecutionOptions(): Readonly<{ include_recommendations: "include_recommendations"; @@ -194,6 +211,10 @@ export default class AdSet extends AbstractCrudObject { trip_consideration: "TRIP_CONSIDERATION"; video_sound_on: "VIDEO_SOUND_ON"; }>; + static get RegionalRegulatedCategories(): Readonly<{ + value_0: "0"; + value_1: "1"; + }>; static get TuneForCategory(): Readonly<{ credit: "CREDIT"; employment: "EMPLOYMENT"; @@ -211,42 +232,22 @@ export default class AdSet extends AbstractCrudObject { inherited_from_source: "INHERITED_FROM_SOURCE"; paused: "PAUSED"; }>; - getActivities(fields: string[], params?: Record): Promise; - getActivities(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getActivities(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAdStudies(fields: string[], params?: Record): Promise; - getAdStudies(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdStudies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAdCreatives(fields: string[], params?: Record): Promise; - getAdCreatives(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdCreatives(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - deleteAdLabels(params?: Record): Promise; - createAdLabel(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getAdRulesGoverned(fields: string[], params?: Record): Promise; - getAdRulesGoverned(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdRulesGoverned(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAds(fields: string[], params?: Record): Promise; - getAds(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAds(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAsyncAdRequests(fields: string[], params?: Record): Promise; - getAsyncAdRequests(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAsyncAdRequests(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createBudgetSchedule(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getCopies(fields: string[], params?: Record): Promise; - getCopies(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCopies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createCopy(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getDeliveryEstimate(fields: string[], params?: Record): Promise; - getDeliveryEstimate(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getDeliveryEstimate(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getInsights(fields: string[], params?: Record): Promise; - getInsights(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getInsights(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getInsightsAsync(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getTargetingSentenceLines(fields: string[], params?: Record): Promise; - getTargetingSentenceLines(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getTargetingSentenceLines(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; + getActivities(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getAdStudies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getAdCreatives(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + deleteAdLabels(params?: Record): Promise; + createAdLabel(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getAdRulesGoverned(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getAds(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getAsyncAdRequests(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createBudgetSchedule(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getCopies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createCopy(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getDeliveryEstimate(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getInsights(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getInsightsAsync(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getTargetingSentenceLines(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/ad-study-cell.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-study-cell.d.ts index 9e2e8e33da8db8..ebfb98426b9fa7 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-study-cell.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-study-cell.d.ts @@ -1,5 +1,5 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; /** * AdStudyCell * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -32,15 +32,9 @@ export default class AdStudyCell extends AbstractCrudObject { tv_facebook: "TV_FACEBOOK"; video_view_optimization: "VIDEO_VIEW_OPTIMIZATION"; }>; - getAdAccounts(fields: string[], params?: Record): Promise; - getAdAccounts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAdSets(fields: string[], params?: Record): Promise; - getAdSets(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdSets(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getCampaigns(fields: string[], params?: Record): Promise; - getCampaigns(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCampaigns(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - get(fields: string[], params?: Record): Promise; - update(fields: string[], params?: Record): Promise; + getAdAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getAdSets(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getCampaigns(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/ad-study-objective-id.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-study-objective-id.d.ts index ea98f2857917ea..6b5b5080064816 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-study-objective-id.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-study-objective-id.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdStudyObjectiveID * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-study-objective-offsite-datasets.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-study-objective-offsite-datasets.d.ts index 4c4437689f176d..20379e6c1bf845 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-study-objective-offsite-datasets.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-study-objective-offsite-datasets.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdStudyObjectiveOffsiteDatasets * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-study-objective.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-study-objective.d.ts index 01da95cfeb0644..e0ee7da914e249 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-study-objective.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-study-objective.d.ts @@ -1,5 +1,5 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; /** * AdStudyObjective * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -26,27 +26,13 @@ export default class AdStudyObjective extends AbstractCrudObject { sales: "SALES"; telco: "TELCO"; }>; - getAdsPixels(fields: string[], params?: Record): Promise; - getAdsPixels(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdsPixels(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getApplications(fields: string[], params?: Record): Promise; - getApplications(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getApplications(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getBrandRequests(fields: string[], params?: Record): Promise; - getBrandRequests(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getBrandRequests(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getCustomConversions(fields: string[], params?: Record): Promise; - getCustomConversions(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCustomConversions(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getOfflineConversionDataSets(fields: string[], params?: Record): Promise; - getOfflineConversionDataSets(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getOfflineConversionDataSets(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getPartnerPrivateStudies(fields: string[], params?: Record): Promise; - getPartnerPrivateStudies(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPartnerPrivateStudies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getPartnerStudies(fields: string[], params?: Record): Promise; - getPartnerStudies(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPartnerStudies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - get(fields: string[], params?: Record): Promise; - update(fields: string[], params?: Record): Promise; + getAdsPixels(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getApplications(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getBrandRequests(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getCustomConversions(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getOfflineConversionDataSets(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getPartnerPrivateStudies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getPartnerStudies(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/ad-study.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-study.d.ts index d00d567dd0db6a..fcd68edb53e6ca 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-study.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-study.d.ts @@ -1,7 +1,7 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; -import Cursor from './../cursor'; -import PrivateLiftStudyInstance from './private-lift-study-instance'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; +import Cursor from "./../cursor"; +import PrivateLiftStudyInstance from "./private-lift-study-instance"; /** * AdStudy * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -28,23 +28,18 @@ export default class AdStudy extends AbstractCrudObject { updated_time: "updated_time"; }>; static get Type(): Readonly<{ + backend_ab_testing: "BACKEND_AB_TESTING"; continuous_lift_config: "CONTINUOUS_LIFT_CONFIG"; geo_lift: "GEO_LIFT"; lift: "LIFT"; split_test: "SPLIT_TEST"; }>; - getCells(fields: string[], params?: Record): Promise; - getCells(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCells(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createCheckPoint(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getInstances(fields: string[], params?: Record): Promise; - getInstances(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getInstances(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createInstance(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getObjectives(fields: string[], params?: Record): Promise; - getObjectives(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getObjectives(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; + getCells(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createCheckPoint(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getInstances(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createInstance(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getObjectives(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/ad-topline-detail.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-topline-detail.d.ts new file mode 100644 index 00000000000000..25f36f651a1634 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-topline-detail.d.ts @@ -0,0 +1,24 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdToplineDetail + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdToplineDetail extends AbstractCrudObject { + static get Fields(): Readonly<{ + active_status: "active_status"; + ad_account_id: "ad_account_id"; + flight_end_date: "flight_end_date"; + flight_start_date: "flight_start_date"; + id: "id"; + io_number: "io_number"; + line_number: "line_number"; + price: "price"; + quantity: "quantity"; + sf_detail_line_id: "sf_detail_line_id"; + subline_id: "subline_id"; + targets: "targets"; + time_created: "time_created"; + time_updated: "time_updated"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-topline.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-topline.d.ts new file mode 100644 index 00000000000000..5c58aaa68b5afe --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-topline.d.ts @@ -0,0 +1,45 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdTopline + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdTopline extends AbstractCrudObject { + static get Fields(): Readonly<{ + account_id: "account_id"; + client_approval_date: "client_approval_date"; + created_by: "created_by"; + created_date: "created_date"; + description: "description"; + flight_end_date: "flight_end_date"; + flight_start_date: "flight_start_date"; + func_cap_amount: "func_cap_amount"; + func_cap_amount_with_offset: "func_cap_amount_with_offset"; + func_line_amount: "func_line_amount"; + func_line_amount_with_offset: "func_line_amount_with_offset"; + func_price: "func_price"; + func_price_with_offset: "func_price_with_offset"; + gender: "gender"; + id: "id"; + impressions: "impressions"; + io_number: "io_number"; + is_bonus_line: "is_bonus_line"; + keywords: "keywords"; + last_updated_by: "last_updated_by"; + last_updated_date: "last_updated_date"; + line_number: "line_number"; + line_position: "line_position"; + line_type: "line_type"; + location: "location"; + max_age: "max_age"; + max_budget: "max_budget"; + min_age: "min_age"; + price_per_trp: "price_per_trp"; + product_type: "product_type"; + rev_assurance_approval_date: "rev_assurance_approval_date"; + targets: "targets"; + trp_updated_time: "trp_updated_time"; + trp_value: "trp_value"; + uom: "uom"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-video.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-video.d.ts index 4ef6954c42c223..e644ab60715b09 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad-video.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-video.d.ts @@ -1,27 +1,23 @@ -import { AbstractCrudObject } from '../abstract-crud-object'; -import Cursor from '../cursor'; -import FacebookAdsBatchApi from '../api-batch'; +import { AbstractCrudObject } from "../abstract-crud-object"; +import Cursor from "../cursor"; +import FacebookAdsBatchApi from "../api-batch"; import type { SlideshowSpec } from "../video-uploader"; /** * AdVideo * @see {@link https://developers.facebook.com/docs/marketing-api/} */ export default class AdVideo extends AbstractCrudObject { - static get Fields(): Readonly<{ - filepath: "filepath"; - id: "id"; - slideshow_spec: "slideshow_spec"; - }>; + static get Fields(): Record; get filepath(): string; get slideshow_spec(): SlideshowSpec | null | undefined; /** * Uploads filepath and creates the AdVideo object from it. * It requires 'filepath' property to be defined. - */ - create(batch: FacebookAdsBatchApi, failureHandler: any, successHandler: any): any; + **/ + create(batch: FacebookAdsBatchApi, failureHandler: (...args: any[]) => any, successHandler: (...args: any[]) => any): any; waitUntilEncodingReady(interval?: number, timeout?: number): void; /** * Returns all the thumbnails associated with the ad video */ - getThumbnails(fields: Record, params: Record): Cursor | Promise; + getThumbnails(fields: Record, params: Record): Cursor | Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad-volume.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad-volume.d.ts new file mode 100644 index 00000000000000..dffd1a3343198a --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ad-volume.d.ts @@ -0,0 +1,19 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdVolume + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdVolume extends AbstractCrudObject { + static get Fields(): Readonly<{ + ad_volume_break_down: "ad_volume_break_down"; + ads_running_or_in_review_count: "ads_running_or_in_review_count"; + future_limit_activation_date: "future_limit_activation_date"; + future_limit_on_ads_running_or_in_review: "future_limit_on_ads_running_or_in_review"; + individual_accounts_ad_volume: "individual_accounts_ad_volume"; + is_gpa_page: "is_gpa_page"; + limit_on_ads_running_or_in_review: "limit_on_ads_running_or_in_review"; + owning_business_ad_volume: "owning_business_ad_volume"; + partner_business_ad_volume: "partner_business_ad_volume"; + user_role: "user_role"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ad.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ad.d.ts index 46688b439d1b3c..01c9ccbbf53a3a 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ad.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ad.d.ts @@ -1,7 +1,7 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; -import Cursor from './../cursor'; -import AdReportRun from './ad-report-run'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; +import Cursor from "./../cursor"; +import AdReportRun from "./ad-report-run"; /** * Ad * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -26,6 +26,7 @@ export default class Ad extends AbstractCrudObject { conversion_specs: "conversion_specs"; created_time: "created_time"; creative: "creative"; + creative_asset_groups_spec: "creative_asset_groups_spec"; demolink_hash: "demolink_hash"; display_sequence: "display_sequence"; effective_status: "effective_status"; @@ -115,31 +116,17 @@ export default class Ad extends AbstractCrudObject { inherited_from_source: "INHERITED_FROM_SOURCE"; paused: "PAUSED"; }>; - getAdCreatives(fields: string[], params?: Record): Promise; - getAdCreatives(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdCreatives(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createAdLabel(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getAdRulesGoverned(fields: string[], params?: Record): Promise; - getAdRulesGoverned(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdRulesGoverned(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getCopies(fields: string[], params?: Record): Promise; - getCopies(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCopies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createCopy(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getInsights(fields: string[], params?: Record): Promise; - getInsights(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getInsights(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getInsightsAsync(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getLeads(fields: string[], params?: Record): Promise; - getLeads(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getLeads(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getPreviews(fields: string[], params?: Record): Promise; - getPreviews(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPreviews(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getTargetingSentenceLines(fields: string[], params?: Record): Promise; - getTargetingSentenceLines(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getTargetingSentenceLines(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; + getAdCreatives(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createAdLabel(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getAdRulesGoverned(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getCopies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createCopy(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getInsights(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getInsightsAsync(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getLeads(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getPreviews(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getTargetingSentenceLines(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/adgroup-facebook-feedback.d.ts b/types/facebook-nodejs-business-sdk/src/objects/adgroup-facebook-feedback.d.ts new file mode 100644 index 00000000000000..305f598312fed5 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/adgroup-facebook-feedback.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; +/** + * AdgroupFacebookFeedback + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdgroupFacebookFeedback extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + preview: "preview"; + }>; + getComments(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/adgroup-issues-info.d.ts b/types/facebook-nodejs-business-sdk/src/objects/adgroup-issues-info.d.ts index 476c2a60a36141..cec72b9ba78792 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/adgroup-issues-info.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/adgroup-issues-info.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdgroupIssuesInfo * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/adgroup-metadata.d.ts b/types/facebook-nodejs-business-sdk/src/objects/adgroup-metadata.d.ts index 15a4adade6b533..44c19fc2758d3f 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/adgroup-metadata.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/adgroup-metadata.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdgroupMetadata * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/adgroup-placement-specific-review-feedback.d.ts b/types/facebook-nodejs-business-sdk/src/objects/adgroup-placement-specific-review-feedback.d.ts index 6409abdbb5686a..e1fa2f4803f8ac 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/adgroup-placement-specific-review-feedback.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/adgroup-placement-specific-review-feedback.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdgroupPlacementSpecificReviewFeedback * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -13,6 +13,7 @@ export default class AdgroupPlacementSpecificReviewFeedback extends AbstractCrud bsg: "bsg"; city_community: "city_community"; commerce: "commerce"; + compromise: "compromise"; daily_deals: "daily_deals"; daily_deals_legacy: "daily_deals_legacy"; dpa: "dpa"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/adgroup-review-feedback.d.ts b/types/facebook-nodejs-business-sdk/src/objects/adgroup-review-feedback.d.ts index 4373ca1431b353..cff29d9f03e82e 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/adgroup-review-feedback.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/adgroup-review-feedback.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdgroupReviewFeedback * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/adjacent-content-delivery-report.d.ts b/types/facebook-nodejs-business-sdk/src/objects/adjacent-content-delivery-report.d.ts new file mode 100644 index 00000000000000..9ff2e7b6140af6 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/adjacent-content-delivery-report.d.ts @@ -0,0 +1,10 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdjacentContentDeliveryReport + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdjacentContentDeliveryReport extends AbstractCrudObject { + static get Fields(): Readonly<{ + content: "content"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/adoptable-pet.d.ts b/types/facebook-nodejs-business-sdk/src/objects/adoptable-pet.d.ts new file mode 100644 index 00000000000000..6d20d1b53ba0f1 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/adoptable-pet.d.ts @@ -0,0 +1,55 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; +/** + * AdoptablePet + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdoptablePet extends AbstractCrudObject { + static get Fields(): Readonly<{ + adoptable_pet_id: "adoptable_pet_id"; + adoption_application_form_url: "adoption_application_form_url"; + age_bucket: "age_bucket"; + animal_type: "animal_type"; + applinks: "applinks"; + availability: "availability"; + breed: "breed"; + category_specific_fields: "category_specific_fields"; + coat_length: "coat_length"; + color: "color"; + currency: "currency"; + description: "description"; + features: "features"; + gender: "gender"; + id: "id"; + image_fetch_status: "image_fetch_status"; + images: "images"; + name: "name"; + price: "price"; + sanitized_images: "sanitized_images"; + secondary_color: "secondary_color"; + shelter_email: "shelter_email"; + shelter_name: "shelter_name"; + shelter_page_id: "shelter_page_id"; + shelter_phone: "shelter_phone"; + size: "size"; + tertiary_color: "tertiary_color"; + url: "url"; + visibility: "visibility"; + }>; + static get ImageFetchStatus(): Readonly<{ + direct_upload: "DIRECT_UPLOAD"; + fetched: "FETCHED"; + fetch_failed: "FETCH_FAILED"; + no_status: "NO_STATUS"; + outdated: "OUTDATED"; + partial_fetch: "PARTIAL_FETCH"; + }>; + static get Visibility(): Readonly<{ + published: "PUBLISHED"; + staging: "STAGING"; + }>; + getAugmentedRealitiesMetadata(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getChannelsToIntegrityStatus(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getVideosMetadata(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + get(fields: string[], params?: Record): Promise; +} 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 3d6777bf8f6807..95a2085767027f 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 @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdsActionStats * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -6,12 +6,26 @@ import { AbstractCrudObject } from './../abstract-crud-object'; export default class AdsActionStats extends AbstractCrudObject { static get Fields(): Readonly<{ value_1d_click: "1d_click"; + value_1d_click_all_conversions: "1d_click_all_conversions"; + value_1d_click_first_conversion: "1d_click_first_conversion"; value_1d_ev: "1d_ev"; + value_1d_ev_all_conversions: "1d_ev_all_conversions"; + value_1d_ev_first_conversion: "1d_ev_first_conversion"; value_1d_view: "1d_view"; + value_1d_view_all_conversions: "1d_view_all_conversions"; + value_1d_view_first_conversion: "1d_view_first_conversion"; value_28d_click: "28d_click"; + value_28d_click_all_conversions: "28d_click_all_conversions"; + value_28d_click_first_conversion: "28d_click_first_conversion"; value_28d_view: "28d_view"; + value_28d_view_all_conversions: "28d_view_all_conversions"; + value_28d_view_first_conversion: "28d_view_first_conversion"; value_7d_click: "7d_click"; + value_7d_click_all_conversions: "7d_click_all_conversions"; + value_7d_click_first_conversion: "7d_click_first_conversion"; value_7d_view: "7d_view"; + value_7d_view_all_conversions: "7d_view_all_conversions"; + value_7d_view_first_conversion: "7d_view_first_conversion"; action_brand: "action_brand"; action_canvas_component_id: "action_canvas_component_id"; action_canvas_component_name: "action_canvas_component_name"; @@ -35,7 +49,11 @@ export default class AdsActionStats extends AbstractCrudObject { interactive_component_sticker_id: "interactive_component_sticker_id"; interactive_component_sticker_response: "interactive_component_sticker_response"; skan_click: "skan_click"; + skan_click_second_postback: "skan_click_second_postback"; + skan_click_third_postback: "skan_click_third_postback"; skan_view: "skan_view"; + skan_view_second_postback: "skan_view_second_postback"; + skan_view_third_postback: "skan_view_third_postback"; value: "value"; }>; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-anomaly-detection.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-anomaly-detection.d.ts new file mode 100644 index 00000000000000..ff62c37fd9fefe --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-anomaly-detection.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdsAnomalyDetection + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdsAnomalyDetection extends AbstractCrudObject { + static get Fields(): Readonly<{ + anomaly_data: "anomaly_data"; + day: "day"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-conversion-goal.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-conversion-goal.d.ts new file mode 100644 index 00000000000000..45b7561a888f3b --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-conversion-goal.d.ts @@ -0,0 +1,20 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; +/** + * AdsConversionGoal + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdsConversionGoal extends AbstractCrudObject { + static get Fields(): Readonly<{ + ad_account_id: "ad_account_id"; + conversion_event_value_source: "conversion_event_value_source"; + description: "description"; + goal_creation_method: "goal_creation_method"; + id: "id"; + name: "name"; + performance_goal: "performance_goal"; + update_status: "update_status"; + }>; + getConversionEvents(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-creation-saved-state.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-creation-saved-state.d.ts new file mode 100644 index 00000000000000..02fc5d21715f04 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-creation-saved-state.d.ts @@ -0,0 +1,15 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdsCreationSavedState + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdsCreationSavedState extends AbstractCrudObject { + static get Fields(): Readonly<{ + ad_account: "ad_account"; + id: "id"; + serialized_store_data: "serialized_store_data"; + time_updated: "time_updated"; + user: "user"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-custom-pivots-preview.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-custom-pivots-preview.d.ts new file mode 100644 index 00000000000000..37eead1394c6ee --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-custom-pivots-preview.d.ts @@ -0,0 +1,18 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdsCustomPivotsPreview + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdsCustomPivotsPreview extends AbstractCrudObject { + static get Fields(): Readonly<{ + account_id: "account_id"; + account_name: "account_name"; + ad_id: "ad_id"; + ad_name: "ad_name"; + adset_id: "adset_id"; + adset_name: "adset_name"; + campaign_id: "campaign_id"; + campaign_name: "campaign_name"; + custom_breakdown: "custom_breakdown"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-data-partner.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-data-partner.d.ts new file mode 100644 index 00000000000000..f0a686ff18b58c --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-data-partner.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdsDataPartner + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdsDataPartner extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + name: "name"; + rev_share_policies: "rev_share_policies"; + }>; + get(fields: string[], params?: Record): Promise; +} 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 new file mode 100644 index 00000000000000..36713c934c237e --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-dataset.d.ts @@ -0,0 +1,61 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdsDataset + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdsDataset extends AbstractCrudObject { + static get Fields(): Readonly<{ + can_proxy: "can_proxy"; + collection_rate: "collection_rate"; + config: "config"; + creation_time: "creation_time"; + creator: "creator"; + dataset_id: "dataset_id"; + description: "description"; + duplicate_entries: "duplicate_entries"; + enable_auto_assign_to_accounts: "enable_auto_assign_to_accounts"; + enable_automatic_events: "enable_automatic_events"; + enable_automatic_matching: "enable_automatic_matching"; + enable_real_time_event_log: "enable_real_time_event_log"; + event_stats: "event_stats"; + event_time_max: "event_time_max"; + event_time_min: "event_time_min"; + first_party_cookie_status: "first_party_cookie_status"; + has_bapi_domains: "has_bapi_domains"; + has_catalog_microdata_activity: "has_catalog_microdata_activity"; + has_ofa_redacted_keys: "has_ofa_redacted_keys"; + has_sent_pii: "has_sent_pii"; + id: "id"; + is_consolidated_container: "is_consolidated_container"; + is_created_by_business: "is_created_by_business"; + is_crm: "is_crm"; + is_eligible_for_sharing_to_ad_account: "is_eligible_for_sharing_to_ad_account"; + is_eligible_for_sharing_to_business: "is_eligible_for_sharing_to_business"; + is_eligible_for_value_optimization: "is_eligible_for_value_optimization"; + is_mta_use: "is_mta_use"; + is_restricted_use: "is_restricted_use"; + is_unavailable: "is_unavailable"; + last_fired_time: "last_fired_time"; + last_upload_app: "last_upload_app"; + last_upload_app_changed_time: "last_upload_app_changed_time"; + last_upload_time: "last_upload_time"; + late_upload_reminder_eligibility: "late_upload_reminder_eligibility"; + match_rate_approx: "match_rate_approx"; + matched_entries: "matched_entries"; + name: "name"; + no_ads_tracked_for_weekly_uploaded_events_reminder_eligibility: "no_ads_tracked_for_weekly_uploaded_events_reminder_eligibility"; + num_active_ad_set_tracked: "num_active_ad_set_tracked"; + num_recent_offline_conversions_uploaded: "num_recent_offline_conversions_uploaded"; + num_uploads: "num_uploads"; + owner_ad_account: "owner_ad_account"; + owner_business: "owner_business"; + percentage_of_late_uploads_in_external_suboptimal_window: "percentage_of_late_uploads_in_external_suboptimal_window"; + permissions: "permissions"; + server_last_fired_time: "server_last_fired_time"; + show_automatic_events: "show_automatic_events"; + upload_rate: "upload_rate"; + upload_reminder_eligibility: "upload_reminder_eligibility"; + usage: "usage"; + valid_entries: "valid_entries"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-guidance-qe-exposure.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-guidance-qe-exposure.d.ts new file mode 100644 index 00000000000000..3ac31e6466e541 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-guidance-qe-exposure.d.ts @@ -0,0 +1,10 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdsGuidanceQEExposure + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdsGuidanceQEExposure extends AbstractCrudObject { + static get Fields(): Readonly<{ + account_exposed: "account_exposed"; + }>; +} 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 d02a83bfe5cf2b..0a3cedfd625e70 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 @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdsHistogramStats * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -6,12 +6,26 @@ import { AbstractCrudObject } from './../abstract-crud-object'; export default class AdsHistogramStats extends AbstractCrudObject { static get Fields(): Readonly<{ value_1d_click: "1d_click"; + value_1d_click_all_conversions: "1d_click_all_conversions"; + value_1d_click_first_conversion: "1d_click_first_conversion"; value_1d_ev: "1d_ev"; + value_1d_ev_all_conversions: "1d_ev_all_conversions"; + value_1d_ev_first_conversion: "1d_ev_first_conversion"; value_1d_view: "1d_view"; + value_1d_view_all_conversions: "1d_view_all_conversions"; + value_1d_view_first_conversion: "1d_view_first_conversion"; value_28d_click: "28d_click"; + value_28d_click_all_conversions: "28d_click_all_conversions"; + value_28d_click_first_conversion: "28d_click_first_conversion"; value_28d_view: "28d_view"; + value_28d_view_all_conversions: "28d_view_all_conversions"; + value_28d_view_first_conversion: "28d_view_first_conversion"; value_7d_click: "7d_click"; + value_7d_click_all_conversions: "7d_click_all_conversions"; + value_7d_click_first_conversion: "7d_click_first_conversion"; value_7d_view: "7d_view"; + value_7d_view_all_conversions: "7d_view_all_conversions"; + value_7d_view_first_conversion: "7d_view_first_conversion"; action_brand: "action_brand"; action_canvas_component_id: "action_canvas_component_id"; action_canvas_component_name: "action_canvas_component_name"; @@ -35,7 +49,11 @@ export default class AdsHistogramStats extends AbstractCrudObject { interactive_component_sticker_id: "interactive_component_sticker_id"; interactive_component_sticker_response: "interactive_component_sticker_response"; skan_click: "skan_click"; + skan_click_second_postback: "skan_click_second_postback"; + skan_click_third_postback: "skan_click_third_postback"; skan_view: "skan_view"; + skan_view_second_postback: "skan_view_second_postback"; + skan_view_third_postback: "skan_view_third_postback"; value: "value"; }>; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-image-crops.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-image-crops.d.ts index aaad7397118835..12447b796a5450 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ads-image-crops.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-image-crops.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdsImageCrops * @see {@link https://developers.facebook.com/docs/marketing-api/} 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 354f285452a947..5543f7106265c1 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 @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdsInsights * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -14,6 +14,7 @@ export default class AdsInsights extends AbstractCrudObject { ad_id: "ad_id"; ad_impression_actions: "ad_impression_actions"; ad_name: "ad_name"; + adjusted_offline_purchase: "adjusted_offline_purchase"; adset_end: "adset_end"; adset_id: "adset_id"; adset_name: "adset_name"; @@ -34,7 +35,6 @@ export default class AdsInsights extends AbstractCrudObject { catalog_segment_value_omni_purchase_roas: "catalog_segment_value_omni_purchase_roas"; catalog_segment_value_website_purchase_roas: "catalog_segment_value_website_purchase_roas"; clicks: "clicks"; - conversion_lead_rate: "conversion_lead_rate"; conversion_rate_ranking: "conversion_rate_ranking"; conversion_values: "conversion_values"; conversions: "conversions"; @@ -45,7 +45,6 @@ export default class AdsInsights extends AbstractCrudObject { cost_per_action_type: "cost_per_action_type"; cost_per_ad_click: "cost_per_ad_click"; cost_per_conversion: "cost_per_conversion"; - cost_per_conversion_lead: "cost_per_conversion_lead"; cost_per_dda_countby_convs: "cost_per_dda_countby_convs"; cost_per_estimated_ad_recallers: "cost_per_estimated_ad_recallers"; cost_per_inline_link_click: "cost_per_inline_link_click"; @@ -93,8 +92,10 @@ export default class AdsInsights extends AbstractCrudObject { 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_spend: "marketing_messages_spend"; + marketing_messages_website_purchase_values: "marketing_messages_website_purchase_values"; mobile_app_purchase_roas: "mobile_app_purchase_roas"; objective: "objective"; + 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"; @@ -103,6 +104,7 @@ export default class AdsInsights extends AbstractCrudObject { qualifying_question_qualify_answer_rate: "qualifying_question_qualify_answer_rate"; quality_ranking: "quality_ranking"; reach: "reach"; + shops_assisted_purchases: "shops_assisted_purchases"; social_spend: "social_spend"; spend: "spend"; total_postbacks: "total_postbacks"; @@ -146,8 +148,12 @@ export default class AdsInsights extends AbstractCrudObject { value_1d_view: "1d_view"; value_28d_click: "28d_click"; value_28d_view: "28d_view"; + value_28d_view_all_conversions: "28d_view_all_conversions"; + value_28d_view_first_conversion: "28d_view_first_conversion"; value_7d_click: "7d_click"; value_7d_view: "7d_view"; + value_7d_view_all_conversions: "7d_view_all_conversions"; + value_7d_view_first_conversion: "7d_view_first_conversion"; dda: "dda"; default: "default"; skan_click: "skan_click"; @@ -164,6 +170,10 @@ export default class AdsInsights extends AbstractCrudObject { action_type: "action_type"; action_video_sound: "action_video_sound"; action_video_type: "action_video_type"; + conversion_destination: "conversion_destination"; + matched_persona_id: "matched_persona_id"; + matched_persona_name: "matched_persona_name"; + signal_source_bucket: "signal_source_bucket"; standard_event_content_type: "standard_event_content_type"; }>; static get ActionReportTime(): Readonly<{ @@ -178,6 +188,7 @@ export default class AdsInsights extends AbstractCrudObject { body_asset: "body_asset"; call_to_action_asset: "call_to_action_asset"; coarse_conversion_value: "coarse_conversion_value"; + conversion_destination: "conversion_destination"; country: "country"; description_asset: "description_asset"; device_platform: "device_platform"; @@ -191,6 +202,7 @@ export default class AdsInsights extends AbstractCrudObject { image_asset: "image_asset"; impression_device: "impression_device"; is_conversion_id_modeled: "is_conversion_id_modeled"; + landing_destination: "landing_destination"; link_url_asset: "link_url_asset"; marketing_messages_btn_name: "marketing_messages_btn_name"; mdsa_landing_destination: "mdsa_landing_destination"; @@ -208,11 +220,14 @@ export default class AdsInsights extends AbstractCrudObject { publisher_platform: "publisher_platform"; redownload: "redownload"; region: "region"; + signal_source_bucket: "signal_source_bucket"; skan_campaign_id: "skan_campaign_id"; skan_conversion_id: "skan_conversion_id"; skan_version: "skan_version"; standard_event_content_type: "standard_event_content_type"; title_asset: "title_asset"; + user_persona_id: "user_persona_id"; + user_persona_name: "user_persona_name"; video_asset: "video_asset"; }>; static get DatePreset(): Readonly<{ @@ -254,6 +269,10 @@ export default class AdsInsights extends AbstractCrudObject { action_type: "action_type"; action_video_sound: "action_video_sound"; action_video_type: "action_video_type"; + conversion_destination: "conversion_destination"; + matched_persona_id: "matched_persona_id"; + matched_persona_name: "matched_persona_name"; + signal_source_bucket: "signal_source_bucket"; standard_event_content_type: "standard_event_content_type"; }>; } 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 new file mode 100644 index 00000000000000..639751e5af294c --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-naming-template.d.ts @@ -0,0 +1,29 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdsNamingTemplate + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdsNamingTemplate extends AbstractCrudObject { + static get Fields(): Readonly<{ + api_fields: "api_fields"; + api_version: "api_version"; + field_order: "field_order"; + id: "id"; + level: "level"; + separator: "separator"; + template_version: "template_version"; + user_defined_fields: "user_defined_fields"; + value_separator: "value_separator"; + }>; + static get Level(): Readonly<{ + adgroup: "ADGROUP"; + ad_account: "AD_ACCOUNT"; + campaign: "CAMPAIGN"; + campaign_group: "CAMPAIGN_GROUP"; + opportunities: "OPPORTUNITIES"; + privacy_info_center: "PRIVACY_INFO_CENTER"; + topline: "TOPLINE"; + unique_adcreative: "UNIQUE_ADCREATIVE"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-optimal-delivery-growth-opportunity.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-optimal-delivery-growth-opportunity.d.ts index 1f435832e0322f..2b18ab8effb87e 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ads-optimal-delivery-growth-opportunity.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-optimal-delivery-growth-opportunity.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdsOptimalDeliveryGrowthOpportunity * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-payment-cycle.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-payment-cycle.d.ts new file mode 100644 index 00000000000000..64b0c3415870f4 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-payment-cycle.d.ts @@ -0,0 +1,15 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdsPaymentCycle + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdsPaymentCycle extends AbstractCrudObject { + static get Fields(): Readonly<{ + account_id: "account_id"; + created_time: "created_time"; + multiplier: "multiplier"; + requested_threshold_amount: "requested_threshold_amount"; + threshold_amount: "threshold_amount"; + updated_time: "updated_time"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-pivot-rules.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-pivot-rules.d.ts new file mode 100644 index 00000000000000..19a64fdc41e86b --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-pivot-rules.d.ts @@ -0,0 +1,20 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdsPivotRules + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdsPivotRules extends AbstractCrudObject { + static get Fields(): Readonly<{ + creation_time: "creation_time"; + creator: "creator"; + description: "description"; + id: "id"; + name: "name"; + permission: "permission"; + rules: "rules"; + scope: "scope"; + update_by: "update_by"; + update_time: "update_time"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-capability-override.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-capability-override.d.ts new file mode 100644 index 00000000000000..f005ed2f57a862 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-capability-override.d.ts @@ -0,0 +1,14 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdsPixelCapabilityOverride + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdsPixelCapabilityOverride extends AbstractCrudObject { + static get Fields(): Readonly<{ + capability: "capability"; + id: "id"; + override_value: "override_value"; + reason: "reason"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-capi-setup-quality.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-capi-setup-quality.d.ts new file mode 100644 index 00000000000000..3f0905d3329999 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-capi-setup-quality.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdsPixelCAPISetupQuality + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdsPixelCAPISetupQuality extends AbstractCrudObject { + static get Fields(): Readonly<{ + event_match_quality: "event_match_quality"; + event_name: "event_name"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-delivery-recommendations.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-delivery-recommendations.d.ts new file mode 100644 index 00000000000000..033014ce601e54 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-delivery-recommendations.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdsPixelDeliveryRecommendations + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdsPixelDeliveryRecommendations extends AbstractCrudObject { + static get Fields(): Readonly<{ + custom_event_type: "custom_event_type"; + optimization_goal: "optimization_goal"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-domain-control-rule.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-domain-control-rule.d.ts new file mode 100644 index 00000000000000..6359f80141b926 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-domain-control-rule.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdsPixelDomainControlRule + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdsPixelDomainControlRule extends AbstractCrudObject { + static get Fields(): Readonly<{ + domain_list: "domain_list"; + type: "type"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-domain-last-fired-time.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-domain-last-fired-time.d.ts new file mode 100644 index 00000000000000..98499e7281acdb --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-domain-last-fired-time.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdsPixelDomainLastFiredTime + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdsPixelDomainLastFiredTime extends AbstractCrudObject { + static get Fields(): Readonly<{ + domain_name: "domain_name"; + last_fired_time: "last_fired_time"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-event-last-fired-time.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-event-last-fired-time.d.ts new file mode 100644 index 00000000000000..f415f9596eb9cc --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-event-last-fired-time.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdsPixelEventLastFiredTime + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdsPixelEventLastFiredTime extends AbstractCrudObject { + static get Fields(): Readonly<{ + event: "event"; + last_fired_time: "last_fired_time"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-event-prediction.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-event-prediction.d.ts new file mode 100644 index 00000000000000..ff393e80d896b2 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-event-prediction.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdsPixelEventPrediction + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdsPixelEventPrediction extends AbstractCrudObject { + static get Fields(): Readonly<{ + dismissed: "dismissed"; + event_type: "event_type"; + rule: "rule"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-event-suggestion-rule.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-event-suggestion-rule.d.ts new file mode 100644 index 00000000000000..75750011fead15 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-event-suggestion-rule.d.ts @@ -0,0 +1,17 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdsPixelEventSuggestionRule + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdsPixelEventSuggestionRule extends AbstractCrudObject { + static get Fields(): Readonly<{ + value_7d_volume: "7d_volume"; + dismissed: "dismissed"; + end_time: "end_time"; + event_type: "event_type"; + rank: "rank"; + rule: "rule"; + sample_urls: "sample_urls"; + start_time: "start_time"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-item-price.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-item-price.d.ts new file mode 100644 index 00000000000000..650738e1c43d32 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-item-price.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdsPixelItemPrice + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdsPixelItemPrice extends AbstractCrudObject { + static get Fields(): Readonly<{ + date: "date"; + item_price_coverage: "item_price_coverage"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-microdata-stats.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-microdata-stats.d.ts new file mode 100644 index 00000000000000..a7ad1757141e87 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-microdata-stats.d.ts @@ -0,0 +1,14 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdsPixelMicrodataStats + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdsPixelMicrodataStats extends AbstractCrudObject { + static get Fields(): Readonly<{ + allowed_domains: "allowed_domains"; + errors_stats_for_time_ranges: "errors_stats_for_time_ranges"; + has_valid_events: "has_valid_events"; + suggested_allowed_domains_count_max: "suggested_allowed_domains_count_max"; + suggested_trusted_domains: "suggested_trusted_domains"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-raw-fires-result.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-raw-fires-result.d.ts new file mode 100644 index 00000000000000..e62a065546ff19 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-raw-fires-result.d.ts @@ -0,0 +1,17 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdsPixelRawFiresResult + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdsPixelRawFiresResult extends AbstractCrudObject { + static get Fields(): Readonly<{ + data_json: "data_json"; + device_type: "device_type"; + event: "event"; + event_detection_method: "event_detection_method"; + event_src: "event_src"; + placed_url: "placed_url"; + timestamp: "timestamp"; + user_pii_keys: "user_pii_keys"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-real-time-event-log-result.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-real-time-event-log-result.d.ts new file mode 100644 index 00000000000000..5e1569ea349dcd --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-real-time-event-log-result.d.ts @@ -0,0 +1,22 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdsPixelRealTimeEventLogResult + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdsPixelRealTimeEventLogResult extends AbstractCrudObject { + static get Fields(): Readonly<{ + data_json: "data_json"; + dedup_data: "dedup_data"; + device_type: "device_type"; + domain_control_rule_rejection: "domain_control_rule_rejection"; + event: "event"; + event_detection_method: "event_detection_method"; + in_iframe: "in_iframe"; + matched_rule_conditions: "matched_rule_conditions"; + resolved_link: "resolved_link"; + source_rule_condition: "source_rule_condition"; + timestamp: "timestamp"; + trace_id: "trace_id"; + url: "url"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-recent-events-result.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-recent-events-result.d.ts new file mode 100644 index 00000000000000..7b1839e490c596 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-recent-events-result.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdsPixelRecentEventsResult + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdsPixelRecentEventsResult extends AbstractCrudObject { + static get Fields(): Readonly<{ + count: "count"; + event: "event"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-signals-iwl-feedback-nux.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-signals-iwl-feedback-nux.d.ts new file mode 100644 index 00000000000000..6153befa7f5ddf --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-signals-iwl-feedback-nux.d.ts @@ -0,0 +1,10 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdsPixelSignalsIWLFeedbackNux + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdsPixelSignalsIWLFeedbackNux extends AbstractCrudObject { + static get Fields(): Readonly<{ + should_ask_to_rate: "should_ask_to_rate"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-signals-iwl-nux.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-signals-iwl-nux.d.ts new file mode 100644 index 00000000000000..bb830f5efc0d19 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-signals-iwl-nux.d.ts @@ -0,0 +1,14 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdsPixelSignalsIWLNux + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdsPixelSignalsIWLNux extends AbstractCrudObject { + static get Fields(): Readonly<{ + background_color: "background_color"; + content: "content"; + content_color: "content_color"; + content_size: "content_size"; + img_url: "img_url"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-stats-result.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-stats-result.d.ts index cdf0efe91c907b..725a53544c6e4f 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-stats-result.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-stats-result.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdsPixelStatsResult * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-stats.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-stats.d.ts index 3c83634278adb0..28b93c63c4b428 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-stats.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-pixel-stats.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AdsPixelStats * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-pixel.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-pixel.d.ts index a424bf1250c878..0611c27ea337f3 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ads-pixel.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-pixel.d.ts @@ -1,6 +1,6 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; +import Cursor from "./../cursor"; /** * AdsPixel * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -22,6 +22,7 @@ export default class AdsPixel extends AbstractCrudObject { event_time_max: "event_time_max"; event_time_min: "event_time_min"; first_party_cookie_status: "first_party_cookie_status"; + has_1p_pixel_event: "has_1p_pixel_event"; id: "id"; is_consolidated_container: "is_consolidated_container"; is_created_by_business: "is_created_by_business"; @@ -68,6 +69,11 @@ export default class AdsPixel extends AbstractCrudObject { first_party_cookie_disabled: "FIRST_PARTY_COOKIE_DISABLED"; first_party_cookie_enabled: "FIRST_PARTY_COOKIE_ENABLED"; }>; + static get PermittedTasks(): Readonly<{ + advertise: "ADVERTISE"; + analyze: "ANALYZE"; + upload: "UPLOAD"; + }>; static get Tasks(): Readonly<{ aa_analyze: "AA_ANALYZE"; advertise: "ADVERTISE"; @@ -75,41 +81,23 @@ export default class AdsPixel extends AbstractCrudObject { edit: "EDIT"; upload: "UPLOAD"; }>; - getAdAccounts(fields: string[], params?: Record): Promise; - getAdAccounts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAgencies(fields: string[], params?: Record): Promise; - getAgencies(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAgencies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createAhpConfig(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getAssignedUsers(fields: string[], params?: Record): Promise; - getAssignedUsers(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAssignedUsers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createAssignedUser(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getDaChecks(fields: string[], params?: Record): Promise; - getDaChecks(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getDaChecks(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createEvent(fields: string[], params?: Record, pathOverride?: string | null): Promise; - createMeapitocapiconsolidationhelper(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getOfflineEventUploads(fields: string[], params?: Record): Promise; - getOfflineEventUploads(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getOfflineEventUploads(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getOpenBridgeConfigurations(fields: string[], params?: Record): Promise; - getOpenBridgeConfigurations(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getOpenBridgeConfigurations(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createShadowTrafficHelper(fields: string[], params?: Record, pathOverride?: string | null): Promise; - deleteSharedAccounts(params?: Record): Promise; - getSharedAccounts(fields: string[], params?: Record): Promise; - getSharedAccounts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getSharedAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createSharedAccount(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getSharedAgencies(fields: string[], params?: Record): Promise; - getSharedAgencies(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getSharedAgencies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getStats(fields: string[], params?: Record): Promise; - getStats(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getStats(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createTelemetry(fields: string[], params?: Record, pathOverride?: string | null): Promise; - get(fields: string[], params?: Record): Promise; - update(fields: string[], params?: Record): Promise; + getAdAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + deleteAgencies(params?: Record): Promise; + getAgencies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createAgency(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createAhpConfig(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getAssignedUsers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createAssignedUser(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getDaChecks(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createEvent(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getOfflineEventUploads(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getOpenBridgeConfigurations(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createShadowTrafficHelper(fields: string[], params?: Record, pathOverride?: string | null): Promise; + deleteShareDAccounts(params?: Record): Promise; + getShareDAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createShareDAccount(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getShareDAgencies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getStats(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-report-builder-export-core.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-report-builder-export-core.d.ts new file mode 100644 index 00000000000000..017f46d5cb552c --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-report-builder-export-core.d.ts @@ -0,0 +1,26 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdsReportBuilderExportCore + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdsReportBuilderExportCore extends AbstractCrudObject { + static get Fields(): Readonly<{ + async_percent_completion: "async_percent_completion"; + async_report_url: "async_report_url"; + async_status: "async_status"; + client_creation_value: "client_creation_value"; + expiry_time: "expiry_time"; + export_download_time: "export_download_time"; + export_format: "export_format"; + export_name: "export_name"; + export_type: "export_type"; + has_seen: "has_seen"; + id: "id"; + is_sharing: "is_sharing"; + link_sharing_expiration_time: "link_sharing_expiration_time"; + link_sharing_uri: "link_sharing_uri"; + time_completed: "time_completed"; + time_start: "time_start"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-report-builder-mmm-report-scheduler.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-report-builder-mmm-report-scheduler.d.ts new file mode 100644 index 00000000000000..d48d2378f2a76e --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-report-builder-mmm-report-scheduler.d.ts @@ -0,0 +1,15 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdsReportBuilderMMMReportScheduler + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdsReportBuilderMMMReportScheduler extends AbstractCrudObject { + static get Fields(): Readonly<{ + ad_account_ids: "ad_account_ids"; + filtering: "filtering"; + id: "id"; + report_name: "report_name"; + schedule_frequency: "schedule_frequency"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-report-builder-mmm-report.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-report-builder-mmm-report.d.ts new file mode 100644 index 00000000000000..ea03eeea5b9e96 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-report-builder-mmm-report.d.ts @@ -0,0 +1,18 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdsReportBuilderMMMReport + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdsReportBuilderMMMReport extends AbstractCrudObject { + static get Fields(): Readonly<{ + async_status: "async_status"; + export_format: "export_format"; + export_name: "export_name"; + export_type: "export_type"; + has_seen: "has_seen"; + id: "id"; + mmm_status: "mmm_status"; + time_start: "time_start"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-report-builder-saved-report.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-report-builder-saved-report.d.ts new file mode 100644 index 00000000000000..9b7e84b853639f --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-report-builder-saved-report.d.ts @@ -0,0 +1,49 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdsReportBuilderSavedReport + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdsReportBuilderSavedReport extends AbstractCrudObject { + static get Fields(): Readonly<{ + action_report_time: "action_report_time"; + ad_account_id: "ad_account_id"; + attribution_windows: "attribution_windows"; + comparison_date_interval: "comparison_date_interval"; + creation_source: "creation_source"; + creation_time: "creation_time"; + currency: "currency"; + date_interval: "date_interval"; + date_preset: "date_preset"; + default_attribution_windows: "default_attribution_windows"; + dimension_groups: "dimension_groups"; + dimensions: "dimensions"; + filtering: "filtering"; + formatting: "formatting"; + id: "id"; + last_access_by: "last_access_by"; + last_access_time: "last_access_time"; + last_report_snapshot_id: "last_report_snapshot_id"; + last_report_snapshot_time: "last_report_snapshot_time"; + last_shared_report_expiration: "last_shared_report_expiration"; + limit: "limit"; + locked_dimensions: "locked_dimensions"; + metrics: "metrics"; + report_name: "report_name"; + report_snapshot_async_percent_completion: "report_snapshot_async_percent_completion"; + report_snapshot_async_status: "report_snapshot_async_status"; + schedule_frequency: "schedule_frequency"; + scope: "scope"; + show_deprecate_aw_banner: "show_deprecate_aw_banner"; + sorting: "sorting"; + start_date: "start_date"; + status: "status"; + subscribers: "subscribers"; + update_by: "update_by"; + update_time: "update_time"; + user: "user"; + user_dimensions: "user_dimensions"; + user_metrics: "user_metrics"; + view_type: "view_type"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-report-builder.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-report-builder.d.ts new file mode 100644 index 00000000000000..7f504582b6361d --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-report-builder.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdsReportBuilder + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdsReportBuilder extends AbstractCrudObject { + static get Fields(): Readonly<{ + headers: "headers"; + rows: "rows"; + skan_readiness_status: "skan_readiness_status"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-segments.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-segments.d.ts new file mode 100644 index 00000000000000..a20349330fd866 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-segments.d.ts @@ -0,0 +1,18 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdsSegments + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdsSegments extends AbstractCrudObject { + static get Fields(): Readonly<{ + daily_audience_size: "daily_audience_size"; + daily_impressions: "daily_impressions"; + description: "description"; + id: "id"; + name: "name"; + path: "path"; + popularity: "popularity"; + projected_cpm: "projected_cpm"; + projected_daily_revenue: "projected_daily_revenue"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-signal-diagnostic-issue.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-signal-diagnostic-issue.d.ts new file mode 100644 index 00000000000000..b57d9a6f26b719 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-signal-diagnostic-issue.d.ts @@ -0,0 +1,15 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdsSignalDiagnosticIssue + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdsSignalDiagnosticIssue extends AbstractCrudObject { + static get Fields(): Readonly<{ + data_source_id: "data_source_id"; + data_source_type: "data_source_type"; + diagnostic_type: "diagnostic_type"; + event_name: "event_name"; + traffic_anomaly_drop_percentage: "traffic_anomaly_drop_percentage"; + traffic_anomaly_drop_timestamp: "traffic_anomaly_drop_timestamp"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-start-your-day-widget.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-start-your-day-widget.d.ts new file mode 100644 index 00000000000000..15bdb07ea7a6e4 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-start-your-day-widget.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdsStartYourDayWidget + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdsStartYourDayWidget extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + widget_id: "widget_id"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-tabular.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-tabular.d.ts new file mode 100644 index 00000000000000..592f2529e303fd --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-tabular.d.ts @@ -0,0 +1,10 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdsTabular + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdsTabular extends AbstractCrudObject { + static get Fields(): Readonly<{ + rows: "rows"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-targeting-insights.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-targeting-insights.d.ts new file mode 100644 index 00000000000000..e1e1ac718ef604 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-targeting-insights.d.ts @@ -0,0 +1,20 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdsTargetingInsights + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdsTargetingInsights extends AbstractCrudObject { + static get Fields(): Readonly<{ + audience_size: "audience_size"; + clicks: "clicks"; + conversion_cost: "conversion_cost"; + conversions: "conversions"; + description: "description"; + id: "id"; + impressions: "impressions"; + name: "name"; + revenue: "revenue"; + spend: "spend"; + type: "type"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ads-text-suggestions.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ads-text-suggestions.d.ts new file mode 100644 index 00000000000000..15b0555e6658af --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-text-suggestions.d.ts @@ -0,0 +1,16 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdsTextSuggestions + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdsTextSuggestions extends AbstractCrudObject { + static get Fields(): Readonly<{ + ad_account_id: "ad_account_id"; + bodies: "bodies"; + descriptions: "descriptions"; + inactive_session_tally: "inactive_session_tally"; + long: "long"; + short: "short"; + titles: "titles"; + }>; +} 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 new file mode 100644 index 00000000000000..9695f51c62e9ac --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-user-settings.d.ts @@ -0,0 +1,65 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdsUserSettings + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdsUserSettings extends AbstractCrudObject { + static get Fields(): Readonly<{ + a_plus_c_survey_seen: "a_plus_c_survey_seen"; + adgroup_name_template: "adgroup_name_template"; + ads_tool_visits: "ads_tool_visits"; + aplusc_carousel_cda_opt_in_status: "aplusc_carousel_cda_opt_in_status"; + aplusc_carousel_inline_comment_opt_in_status: "aplusc_carousel_inline_comment_opt_in_status"; + aplusc_epa_opt_in_status: "aplusc_epa_opt_in_status"; + aplusc_opt_out_friction: "aplusc_opt_out_friction"; + 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"; + bookmarked_pages: "bookmarked_pages"; + campaign_group_name_template: "campaign_group_name_template"; + 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"; + default_creation_mode: "default_creation_mode"; + export_format_default: "export_format_default"; + focus_mode_default: "focus_mode_default"; + gen_ai_alpha_test_status: "gen_ai_alpha_test_status"; + id: "id"; + 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"; + multi_ads_settings: "multi_ads_settings"; + 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"; + previously_seen_recommendations: "previously_seen_recommendations"; + product_extensions_opt_in: "product_extensions_opt_in"; + selected_ad_account: "selected_ad_account"; + selected_comparison_timerange: "selected_comparison_timerange"; + selected_metric_cic: "selected_metric_cic"; + selected_metrics_cic: "selected_metrics_cic"; + selected_page: "selected_page"; + selected_page_section: "selected_page_section"; + selected_power_editor_pane: "selected_power_editor_pane"; + selected_stat_range: "selected_stat_range"; + should_export_filter_empty_cols: "should_export_filter_empty_cols"; + should_export_rows_without_unsupported_feature: "should_export_rows_without_unsupported_feature"; + should_not_auto_expand_tree_table: "should_not_auto_expand_tree_table"; + 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"; + 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"; + total_coupon_syd_dismissals: "total_coupon_syd_dismissals"; + total_coupon_upsell_dismissals: "total_coupon_upsell_dismissals"; + use_pe_create_flow: "use_pe_create_flow"; + use_stepper_primary_entry: "use_stepper_primary_entry"; + user: "user"; + }>; + get(fields: string[], params?: Record): Promise; +} 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 new file mode 100644 index 00000000000000..4561f709cc9313 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-value-adjustment-rule-collection.d.ts @@ -0,0 +1,14 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; +/** + * AdsValueAdjustmentRuleCollection + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdsValueAdjustmentRuleCollection extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + name: "name"; + }>; + getPersonas(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + get(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 new file mode 100644 index 00000000000000..37f5603e5ea8ce --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ads-value-adjustment-rule.d.ts @@ -0,0 +1,14 @@ +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/adv-a-instance.d.ts b/types/facebook-nodejs-business-sdk/src/objects/adv-a-instance.d.ts new file mode 100644 index 00000000000000..73f94fa6e7498e --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/adv-a-instance.d.ts @@ -0,0 +1,14 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdvAInstance + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdvAInstance extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + instance_type: "instance_type"; + name: "name"; + owner_business: "owner_business"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/advertiser-verification-status.d.ts b/types/facebook-nodejs-business-sdk/src/objects/advertiser-verification-status.d.ts new file mode 100644 index 00000000000000..e65a7df70a439f --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/advertiser-verification-status.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AdvertiserVerificationStatus + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AdvertiserVerificationStatus extends AbstractCrudObject { + static get Fields(): Readonly<{ + banner_type: "banner_type"; + grace_period_ends_at: "grace_period_ends_at"; + ufac_redirect_uri: "ufac_redirect_uri"; + verification_status: "verification_status"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/age-range.d.ts b/types/facebook-nodejs-business-sdk/src/objects/age-range.d.ts index 98c6907742cf98..4de3cb10cb45b2 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/age-range.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/age-range.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AgeRange * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/agency-client-declaration.d.ts b/types/facebook-nodejs-business-sdk/src/objects/agency-client-declaration.d.ts index 16adb96eebc3dd..3dea9cb9e220f1 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/agency-client-declaration.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/agency-client-declaration.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AgencyClientDeclaration * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/album.d.ts b/types/facebook-nodejs-business-sdk/src/objects/album.d.ts index 1cf3732e9b2745..8a71623a914a2f 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/album.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/album.d.ts @@ -1,7 +1,7 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import Cursor from './../cursor'; -import Comment from './comment'; -import Photo from './photo'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; +import Comment from "./comment"; +import Photo from "./photo"; /** * Album * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -32,20 +32,12 @@ export default class Album extends AbstractCrudObject { updated_time: "updated_time"; video_count: "video_count"; }>; - getComments(fields: string[], params?: Record): Promise; - getComments(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getComments(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createComment(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getLikes(fields: string[], params?: Record): Promise; - getLikes(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getLikes(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createLike(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getPhotos(fields: string[], params?: Record): Promise; - getPhotos(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPhotos(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createPhoto(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getPicture(fields: string[], params?: Record): Promise; - getPicture(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPicture(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - get(fields: string[], params?: Record): Promise; + getComments(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createComment(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getLikes(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createLike(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getPhotos(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createPhoto(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getPicture(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/am-oneshop-settings.d.ts b/types/facebook-nodejs-business-sdk/src/objects/am-oneshop-settings.d.ts new file mode 100644 index 00000000000000..241aaf20465ccc --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/am-oneshop-settings.d.ts @@ -0,0 +1,8 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AMOneshopSettings + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AMOneshopSettings extends AbstractCrudObject { + static get Fields(): Readonly<{}>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/an-blocked-bi-category.d.ts b/types/facebook-nodejs-business-sdk/src/objects/an-blocked-bi-category.d.ts new file mode 100644 index 00000000000000..f63873c34e7562 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/an-blocked-bi-category.d.ts @@ -0,0 +1,10 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ANBlockedBICategory + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ANBlockedBICategory extends AbstractCrudObject { + static get Fields(): Readonly<{ + key: "key"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/analytics-cohort-query-result.d.ts b/types/facebook-nodejs-business-sdk/src/objects/analytics-cohort-query-result.d.ts new file mode 100644 index 00000000000000..f4277a91a6a0b9 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/analytics-cohort-query-result.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AnalyticsCohortQueryResult + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AnalyticsCohortQueryResult extends AbstractCrudObject { + static get Fields(): Readonly<{ + data: "data"; + error: "error"; + query_id: "query_id"; + status: "status"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/analytics-config.d.ts b/types/facebook-nodejs-business-sdk/src/objects/analytics-config.d.ts new file mode 100644 index 00000000000000..eab87666e09a78 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/analytics-config.d.ts @@ -0,0 +1,35 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AnalyticsConfig + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AnalyticsConfig extends AbstractCrudObject { + static get Fields(): Readonly<{ + analytics_access_for_authorized_ad_account: "analytics_access_for_authorized_ad_account"; + breakdowns_config: "breakdowns_config"; + builtin_fields_config: "builtin_fields_config"; + deprecated_events_config: "deprecated_events_config"; + events_config: "events_config"; + ios_purchase_validation_secret: "ios_purchase_validation_secret"; + is_any_role_able_to_see_restricted_insights: "is_any_role_able_to_see_restricted_insights"; + is_implicit_purchase_logging_on_android_supported: "is_implicit_purchase_logging_on_android_supported"; + is_implicit_purchase_logging_on_ios_supported: "is_implicit_purchase_logging_on_ios_supported"; + is_track_ios_app_uninstall_supported: "is_track_ios_app_uninstall_supported"; + journey_backfill_status: "journey_backfill_status"; + journey_conversion_events: "journey_conversion_events"; + journey_enabled: "journey_enabled"; + journey_impacting_change_time: "journey_impacting_change_time"; + journey_timeout: "journey_timeout"; + latest_sdk_versions: "latest_sdk_versions"; + log_android_implicit_purchase_events: "log_android_implicit_purchase_events"; + log_automatic_analytics_events: "log_automatic_analytics_events"; + log_implicit_purchase_events: "log_implicit_purchase_events"; + prev_journey_conversion_events: "prev_journey_conversion_events"; + query_approximation_accuracy_level: "query_approximation_accuracy_level"; + query_currency: "query_currency"; + query_timezone: "query_timezone"; + recent_events_update_time: "recent_events_update_time"; + session_timeout_interval: "session_timeout_interval"; + track_ios_app_uninstall: "track_ios_app_uninstall"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/analytics-entity-user-config.d.ts b/types/facebook-nodejs-business-sdk/src/objects/analytics-entity-user-config.d.ts new file mode 100644 index 00000000000000..4ef4af02c6a302 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/analytics-entity-user-config.d.ts @@ -0,0 +1,10 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AnalyticsEntityUserConfig + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AnalyticsEntityUserConfig extends AbstractCrudObject { + static get Fields(): Readonly<{ + dismissed_notices: "dismissed_notices"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/analytics-funnel-query-result.d.ts b/types/facebook-nodejs-business-sdk/src/objects/analytics-funnel-query-result.d.ts new file mode 100644 index 00000000000000..48684fc257f2e2 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/analytics-funnel-query-result.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AnalyticsFunnelQueryResult + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AnalyticsFunnelQueryResult extends AbstractCrudObject { + static get Fields(): Readonly<{ + data: "data"; + error: "error"; + query_id: "query_id"; + status: "status"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/analytics-platform-metrics-config.d.ts b/types/facebook-nodejs-business-sdk/src/objects/analytics-platform-metrics-config.d.ts new file mode 100644 index 00000000000000..c584163e71fbb3 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/analytics-platform-metrics-config.d.ts @@ -0,0 +1,18 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AnalyticsPlatformMetricsConfig + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AnalyticsPlatformMetricsConfig extends AbstractCrudObject { + static get Fields(): Readonly<{ + has_a2u: "has_a2u"; + has_api_calls: "has_api_calls"; + has_app_invites: "has_app_invites"; + has_fb_login: "has_fb_login"; + has_game_requests: "has_game_requests"; + has_payments: "has_payments"; + has_referrals: "has_referrals"; + has_stories: "has_stories"; + has_structured_requests: "has_structured_requests"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/analytics-query-result.d.ts b/types/facebook-nodejs-business-sdk/src/objects/analytics-query-result.d.ts new file mode 100644 index 00000000000000..d6b73b900ee99a --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/analytics-query-result.d.ts @@ -0,0 +1,14 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AnalyticsQueryResult + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AnalyticsQueryResult extends AbstractCrudObject { + static get Fields(): Readonly<{ + columns: "columns"; + datapoints: "datapoints"; + error: "error"; + query_id: "query_id"; + status: "status"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/analytics-segment.d.ts b/types/facebook-nodejs-business-sdk/src/objects/analytics-segment.d.ts new file mode 100644 index 00000000000000..6a06166884aa78 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/analytics-segment.d.ts @@ -0,0 +1,27 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AnalyticsSegment + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AnalyticsSegment extends AbstractCrudObject { + static get Fields(): Readonly<{ + custom_audience_ineligiblity_reasons: "custom_audience_ineligiblity_reasons"; + description: "description"; + estimated_custom_audience_size: "estimated_custom_audience_size"; + event_info_rules: "event_info_rules"; + event_rules: "event_rules"; + filter_set: "filter_set"; + has_demographic_rules: "has_demographic_rules"; + id: "id"; + is_all_user: "is_all_user"; + is_eligible_for_push_campaign: "is_eligible_for_push_campaign"; + is_internal: "is_internal"; + name: "name"; + percentile_rules: "percentile_rules"; + time_last_seen: "time_last_seen"; + time_last_updated: "time_last_updated"; + user_property_rules: "user_property_rules"; + web_param_rules: "web_param_rules"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/analytics-user-config.d.ts b/types/facebook-nodejs-business-sdk/src/objects/analytics-user-config.d.ts new file mode 100644 index 00000000000000..41bbc5981a3f4e --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/analytics-user-config.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AnalyticsUserConfig + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AnalyticsUserConfig extends AbstractCrudObject { + static get Fields(): Readonly<{ + demo_app_nux_config: "demo_app_nux_config"; + flags: "flags"; + id: "id"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/android-app-link.d.ts b/types/facebook-nodejs-business-sdk/src/objects/android-app-link.d.ts index 66665852be7558..168bd1a0e2b791 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/android-app-link.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/android-app-link.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AndroidAppLink * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/app-event-config.d.ts b/types/facebook-nodejs-business-sdk/src/objects/app-event-config.d.ts new file mode 100644 index 00000000000000..c4d32b2ce0dde8 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/app-event-config.d.ts @@ -0,0 +1,37 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AppEventConfig + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AppEventConfig extends AbstractCrudObject { + static get Fields(): Readonly<{ + breakdowns_config: "breakdowns_config"; + builtin_fields_config: "builtin_fields_config"; + deprecated_events_config: "deprecated_events_config"; + events_config: "events_config"; + id: "id"; + ios_purchase_validation_secret: "ios_purchase_validation_secret"; + is_any_role_able_to_see_restricted_insights: "is_any_role_able_to_see_restricted_insights"; + is_implicit_purchase_logging_on_android_supported: "is_implicit_purchase_logging_on_android_supported"; + is_implicit_purchase_logging_on_ios_supported: "is_implicit_purchase_logging_on_ios_supported"; + is_track_android_app_uninstall_supported: "is_track_android_app_uninstall_supported"; + is_track_ios_app_uninstall_supported: "is_track_ios_app_uninstall_supported"; + journey_backfill_status: "journey_backfill_status"; + journey_conversion_events: "journey_conversion_events"; + journey_enabled: "journey_enabled"; + journey_timeout: "journey_timeout"; + latest_sdk_versions: "latest_sdk_versions"; + log_android_implicit_purchase_events: "log_android_implicit_purchase_events"; + log_automatic_analytics_events: "log_automatic_analytics_events"; + log_implicit_purchase_events: "log_implicit_purchase_events"; + prev_journey_conversion_events: "prev_journey_conversion_events"; + query_approximation_accuracy_level: "query_approximation_accuracy_level"; + query_currency: "query_currency"; + query_timezone: "query_timezone"; + recent_events_update_time: "recent_events_update_time"; + session_timeout_interval: "session_timeout_interval"; + track_android_app_uninstall: "track_android_app_uninstall"; + track_ios_app_uninstall: "track_ios_app_uninstall"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/app-links.d.ts b/types/facebook-nodejs-business-sdk/src/objects/app-links.d.ts new file mode 100644 index 00000000000000..926a0e7efbd28c --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/app-links.d.ts @@ -0,0 +1,19 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AppLinks + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AppLinks extends AbstractCrudObject { + static get Fields(): Readonly<{ + android: "android"; + id: "id"; + ios: "ios"; + ipad: "ipad"; + iphone: "iphone"; + web: "web"; + windows: "windows"; + windows_phone: "windows_phone"; + windows_universal: "windows_universal"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/app-optimized-custom-events.d.ts b/types/facebook-nodejs-business-sdk/src/objects/app-optimized-custom-events.d.ts new file mode 100644 index 00000000000000..e24cdd24bca13c --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/app-optimized-custom-events.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AppOptimizedCustomEvents + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AppOptimizedCustomEvents extends AbstractCrudObject { + static get Fields(): Readonly<{ + app_id: "app_id"; + app_name: "app_name"; + event_names: "event_names"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/app-publisher.d.ts b/types/facebook-nodejs-business-sdk/src/objects/app-publisher.d.ts new file mode 100644 index 00000000000000..ca99665c2561cb --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/app-publisher.d.ts @@ -0,0 +1,16 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AppPublisher + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AppPublisher extends AbstractCrudObject { + static get Fields(): Readonly<{ + content_id: "content_id"; + icon_url: "icon_url"; + id: "id"; + name: "name"; + platform: "platform"; + store_name: "store_name"; + store_url: "store_url"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/app-request-former-recipient.d.ts b/types/facebook-nodejs-business-sdk/src/objects/app-request-former-recipient.d.ts index 58df286166acb6..c8d13e85a2c6a8 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/app-request-former-recipient.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/app-request-former-recipient.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AppRequestFormerRecipient * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/app-request.d.ts b/types/facebook-nodejs-business-sdk/src/objects/app-request.d.ts index 8efec0564bf93c..2da3c5ddf08277 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/app-request.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/app-request.d.ts @@ -1,5 +1,5 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; /** * AppRequest * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -16,6 +16,6 @@ export default class AppRequest extends AbstractCrudObject { object: "object"; to: "to"; }>; - delete(fields: string[], params?: Record): Promise; - get(fields: string[], params?: Record): Promise; + delete(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } 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 9f805a445fcee6..9fe1f341578010 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/application.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/application.d.ts @@ -1,6 +1,6 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; +import Cursor from "./../cursor"; /** * Application * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -32,6 +32,8 @@ export default class Application extends AbstractCrudObject { auto_event_mapping_android: "auto_event_mapping_android"; auto_event_mapping_ios: "auto_event_mapping_ios"; auto_event_setup_enabled: "auto_event_setup_enabled"; + auto_log_app_events_default: "auto_log_app_events_default"; + auto_log_app_events_enabled: "auto_log_app_events_enabled"; business: "business"; canvas_fluid_height: "canvas_fluid_height"; canvas_fluid_width: "canvas_fluid_width"; @@ -89,8 +91,6 @@ export default class Application extends AbstractCrudObject { restrictions: "restrictions"; restrictive_data_filter_params: "restrictive_data_filter_params"; restrictive_data_filter_rules: "restrictive_data_filter_rules"; - sdk_auto_logging_default_value: "sdk_auto_logging_default_value"; - sdk_auto_logging_override_value: "sdk_auto_logging_override_value"; sdk_update_message: "sdk_update_message"; seamless_login: "seamless_login"; secure_canvas_url: "secure_canvas_url"; @@ -167,133 +167,87 @@ export default class Application extends AbstractCrudObject { app_and_page: "APP_AND_PAGE"; page: "PAGE"; }>; - deleteAccounts(params?: Record): Promise; - getAccounts(fields: string[], params?: Record): Promise; - getAccounts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createAccount(fields: string[], params?: Record, pathOverride?: string | null): Promise; - createActivity(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getAdPlacementGroups(fields: string[], params?: Record): Promise; - getAdPlacementGroups(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdPlacementGroups(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAdNetworkPlacements(fields: string[], params?: Record): Promise; - getAdNetworkPlacements(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdNetworkPlacements(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAdNetworkAnalytics(fields: string[], params?: Record): Promise; - getAdNetworkAnalytics(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdNetworkAnalytics(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createAdNetworkAnalytic(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getAdNetworkAnalyticsResults(fields: string[], params?: Record): Promise; - getAdNetworkAnalyticsResults(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdNetworkAnalyticsResults(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAemAttribution(fields: string[], params?: Record): Promise; - getAemAttribution(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAemAttribution(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAemConversionConfigs(fields: string[], params?: Record): Promise; - getAemConversionConfigs(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAemConversionConfigs(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAemConversionFilter(fields: string[], params?: Record): Promise; - getAemConversionFilter(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAemConversionFilter(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createAemConversion(fields: string[], params?: Record, pathOverride?: string | null): Promise; - createAemSkanReadiness(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getAgencies(fields: string[], params?: Record): Promise; - getAgencies(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAgencies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createAggregateRevenue(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getAndroidDialogConfigs(fields: string[], params?: Record): Promise; - getAndroidDialogConfigs(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAndroidDialogConfigs(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAppCapiSettings(fields: string[], params?: Record): Promise; - getAppCapiSettings(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAppCapiSettings(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAppEventTypes(fields: string[], params?: Record): Promise; - getAppEventTypes(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAppEventTypes(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createAppIndexing(fields: string[], params?: Record, pathOverride?: string | null): Promise; - createAppIndexingSession(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getAppInstalledGroups(fields: string[], params?: Record): Promise; - getAppInstalledGroups(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAppInstalledGroups(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createAppPushDeviceToken(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getAppAssets(fields: string[], params?: Record): Promise; - getAppAssets(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAppAssets(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createAsset(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getAuthorizedAdAccounts(fields: string[], params?: Record): Promise; - getAuthorizedAdAccounts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAuthorizedAdAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getBanned(fields: string[], params?: Record): Promise; - getBanned(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getBanned(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getButtonAutoDetectionDeviceSelection(fields: string[], params?: Record): Promise; - getButtonAutoDetectionDeviceSelection(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getButtonAutoDetectionDeviceSelection(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getCloudbridgeSettings(fields: string[], params?: Record): Promise; - getCloudbridgeSettings(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCloudbridgeSettings(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createCodelessEventMapping(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getDaChecks(fields: string[], params?: Record): Promise; - getDaChecks(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getDaChecks(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getEvents(fields: string[], params?: Record): Promise; - getEvents(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getEvents(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getIapPurchases(fields: string[], params?: Record): Promise; - getIapPurchases(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getIapPurchases(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getInsightsPushSchedule(fields: string[], params?: Record): Promise; - getInsightsPushSchedule(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getInsightsPushSchedule(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getIosDialogConfigs(fields: string[], params?: Record): Promise; - getIosDialogConfigs(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getIosDialogConfigs(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getLinkedDataset(fields: string[], params?: Record): Promise; - getLinkedDataset(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getLinkedDataset(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createMmpAuditing(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getMobileSdkGk(fields: string[], params?: Record): Promise; - getMobileSdkGk(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getMobileSdkGk(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getMonetizedDigitalStoreObjects(fields: string[], params?: Record): Promise; - getMonetizedDigitalStoreObjects(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getMonetizedDigitalStoreObjects(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createMonetizedDigitalStoreObject(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getObjectTypes(fields: string[], params?: Record): Promise; - getObjectTypes(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getObjectTypes(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getObjects(fields: string[], params?: Record): Promise; - getObjects(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getObjects(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createOccludesPopup(fields: string[], params?: Record, pathOverride?: string | null): Promise; - createPageActivity(fields: string[], params?: Record, pathOverride?: string | null): Promise; - createPaymentCurrency(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getPermissions(fields: string[], params?: Record): Promise; - getPermissions(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPermissions(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getProducts(fields: string[], params?: Record): Promise; - getProducts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getProducts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getPurchases(fields: string[], params?: Record): Promise; - getPurchases(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPurchases(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getRoles(fields: string[], params?: Record): Promise; - getRoles(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getRoles(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getServerDomainInfos(fields: string[], params?: Record): Promise; - getServerDomainInfos(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getServerDomainInfos(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getSubscribedDomains(fields: string[], params?: Record): Promise; - getSubscribedDomains(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getSubscribedDomains(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createSubscribedDomain(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getSubscribedDomainsPhishing(fields: string[], params?: Record): Promise; - getSubscribedDomainsPhishing(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getSubscribedDomainsPhishing(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createSubscribedDomainsPhishing(fields: string[], params?: Record, pathOverride?: string | null): Promise; - deleteSubscriptions(params?: Record): Promise; - createSubscription(fields: string[], params?: Record, pathOverride?: string | null): Promise; - createUpload(fields: string[], params?: Record, pathOverride?: string | null): Promise; - get(fields: string[], params?: Record): Promise; - update(fields: string[], params?: Record): Promise; + static get OwnerPermissions(): Readonly<{ + develop: "DEVELOP"; + manage: "MANAGE"; + manage_extensions: "MANAGE_EXTENSIONS"; + manage_phone: "MANAGE_PHONE"; + manage_phone_assets: "MANAGE_PHONE_ASSETS"; + manage_templates: "MANAGE_TEMPLATES"; + messaging: "MESSAGING"; + view_cost: "VIEW_COST"; + view_phone_assets: "VIEW_PHONE_ASSETS"; + view_templates: "VIEW_TEMPLATES"; + }>; + static get PartnerPermissions(): Readonly<{ + develop: "DEVELOP"; + manage: "MANAGE"; + manage_extensions: "MANAGE_EXTENSIONS"; + manage_phone: "MANAGE_PHONE"; + manage_phone_assets: "MANAGE_PHONE_ASSETS"; + manage_templates: "MANAGE_TEMPLATES"; + messaging: "MESSAGING"; + view_cost: "VIEW_COST"; + view_phone_assets: "VIEW_PHONE_ASSETS"; + view_templates: "VIEW_TEMPLATES"; + }>; + deleteAccounts(params?: Record): Promise; + getAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createAccount(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createActivity(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getAdPlacementGroups(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getAdNetworkPlacements(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + 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; + getAemAttribution(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getAemConversionConfigs(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getAemConversionFilter(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createAemConversion(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createAemSkanReadiness(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getAgencies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createAggregateRevenue(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getAndroidDialogConfigs(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getAppCapiSettings(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getAppEventTypes(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createAppIndexing(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createAppIndexingSession(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getAppInstalledGroups(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createAppPushDeviceToken(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getAppAssets(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createAsset(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getAuthorizedAdAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + 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; + 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; + 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; + createMonetizedDigitalStoreObject(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getObjectTypes(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getObjects(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createOccludesPopup(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createPageActivity(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createPaymentCurrency(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getPermissions(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getProducts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + 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; + 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; + createSubscribedDomainsPhishing(fields: string[], params?: Record, pathOverride?: string | null): Promise; + deleteSubscriptions(params?: Record): Promise; + createSubscription(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createUpload(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createWhatsAppBusinessSolution(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getWhatsAppBusinessSolutions(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/ar-ads-data-container.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ar-ads-data-container.d.ts new file mode 100644 index 00000000000000..b2471255550b95 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ar-ads-data-container.d.ts @@ -0,0 +1,17 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ArAdsDataContainer + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ArAdsDataContainer extends AbstractCrudObject { + static get Fields(): Readonly<{ + camera_facing_override: "camera_facing_override"; + creation_time: "creation_time"; + effect: "effect"; + id: "id"; + is_published: "is_published"; + last_modified_time: "last_modified_time"; + name: "name"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ar-effect.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ar-effect.d.ts new file mode 100644 index 00000000000000..c253f233d9c1a5 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ar-effect.d.ts @@ -0,0 +1,16 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AREffect + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AREffect extends AbstractCrudObject { + static get Fields(): Readonly<{ + creation_time: "creation_time"; + id: "id"; + last_modified_time: "last_modified_time"; + name: "name"; + status: "status"; + surfaces: "surfaces"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/assigned-user.d.ts b/types/facebook-nodejs-business-sdk/src/objects/assigned-user.d.ts index 753ea3d3e55edf..6535626429b3cc 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/assigned-user.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/assigned-user.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AssignedUser * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/async-request.d.ts b/types/facebook-nodejs-business-sdk/src/objects/async-request.d.ts index 5537ed5bea3ae1..baec916d6add0e 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/async-request.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/async-request.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AsyncRequest * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/async-session.d.ts b/types/facebook-nodejs-business-sdk/src/objects/async-session.d.ts index d4d420ffb6d402..fa2e636e443496 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/async-session.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/async-session.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AsyncSession * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -21,5 +21,5 @@ export default class AsyncSession extends AbstractCrudObject { uri: "uri"; user: "user"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/attribution-spec.d.ts b/types/facebook-nodejs-business-sdk/src/objects/attribution-spec.d.ts index 6fbb0a29e5820f..a7f1aaf086b227 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/attribution-spec.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/attribution-spec.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AttributionSpec * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/audience-funnel.d.ts b/types/facebook-nodejs-business-sdk/src/objects/audience-funnel.d.ts new file mode 100644 index 00000000000000..039248de809089 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/audience-funnel.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AudienceFunnel + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AudienceFunnel extends AbstractCrudObject { + static get Fields(): Readonly<{ + audience_type_param_name: "audience_type_param_name"; + audience_type_param_tags: "audience_type_param_tags"; + custom_audience_groups_info: "custom_audience_groups_info"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/audience-overlap.d.ts b/types/facebook-nodejs-business-sdk/src/objects/audience-overlap.d.ts new file mode 100644 index 00000000000000..eb93a3fc4f951c --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/audience-overlap.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AudienceOverlap + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AudienceOverlap extends AbstractCrudObject { + static get Fields(): Readonly<{ + estimated_reach: "estimated_reach"; + id: "id"; + name: "name"; + overlap: "overlap"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/audience-permission-for-actions.d.ts b/types/facebook-nodejs-business-sdk/src/objects/audience-permission-for-actions.d.ts index d8c34aa384052f..7c3b6a2a500994 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/audience-permission-for-actions.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/audience-permission-for-actions.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AudiencePermissionForActions * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/audience-permission.d.ts b/types/facebook-nodejs-business-sdk/src/objects/audience-permission.d.ts new file mode 100644 index 00000000000000..19993f60025f53 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/audience-permission.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AudiencePermission + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AudiencePermission extends AbstractCrudObject { + static get Fields(): Readonly<{ + audience: "audience"; + share_account_id: "share_account_id"; + share_account_name: "share_account_name"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/audience-sharing-account-valid.d.ts b/types/facebook-nodejs-business-sdk/src/objects/audience-sharing-account-valid.d.ts new file mode 100644 index 00000000000000..ec2644e5cebcc5 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/audience-sharing-account-valid.d.ts @@ -0,0 +1,15 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AudienceSharingAccountValid + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AudienceSharingAccountValid extends AbstractCrudObject { + static get Fields(): Readonly<{ + account_id: "account_id"; + account_type: "account_type"; + business_id: "business_id"; + business_name: "business_name"; + can_ad_account_use_lookalike_container: "can_ad_account_use_lookalike_container"; + sharing_agreement_status: "sharing_agreement_status"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/audience-sharing-recipient-accounts.d.ts b/types/facebook-nodejs-business-sdk/src/objects/audience-sharing-recipient-accounts.d.ts new file mode 100644 index 00000000000000..6b69d24baddeb9 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/audience-sharing-recipient-accounts.d.ts @@ -0,0 +1,16 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AudienceSharingRecipientAccounts + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AudienceSharingRecipientAccounts extends AbstractCrudObject { + static get Fields(): Readonly<{ + account_id: "account_id"; + account_name: "account_name"; + account_type: "account_type"; + business_id: "business_id"; + business_name: "business_name"; + can_ad_account_use_lookalike_container: "can_ad_account_use_lookalike_container"; + sharing_agreement_status: "sharing_agreement_status"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/audio-asset.d.ts b/types/facebook-nodejs-business-sdk/src/objects/audio-asset.d.ts new file mode 100644 index 00000000000000..87de528c017fd4 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/audio-asset.d.ts @@ -0,0 +1,29 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AudioAsset + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AudioAsset extends AbstractCrudObject { + static get Fields(): Readonly<{ + all_ddex_featured_artists: "all_ddex_featured_artists"; + all_ddex_main_artists: "all_ddex_main_artists"; + audio_cluster_id: "audio_cluster_id"; + cover_image_source: "cover_image_source"; + display_artist: "display_artist"; + download_hd_url: "download_hd_url"; + download_sd_url: "download_sd_url"; + duration_in_ms: "duration_in_ms"; + freeform_genre: "freeform_genre"; + grid: "grid"; + id: "id"; + is_test: "is_test"; + original_release_date: "original_release_date"; + owner: "owner"; + parental_warning_type: "parental_warning_type"; + subtitle: "subtitle"; + title: "title"; + title_with_featured_artists: "title_with_featured_artists"; + upc: "upc"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/audio-copyright.d.ts b/types/facebook-nodejs-business-sdk/src/objects/audio-copyright.d.ts index 44ff60c727cafd..a1941769539fa8 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/audio-copyright.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/audio-copyright.d.ts @@ -1,5 +1,5 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; /** * AudioCopyright * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -13,6 +13,7 @@ export default class AudioCopyright extends AbstractCrudObject { isrc: "isrc"; match_rule: "match_rule"; ownership_countries: "ownership_countries"; + ownership_details: "ownership_details"; reference_file_status: "reference_file_status"; ridge_monitoring_status: "ridge_monitoring_status"; tags: "tags"; @@ -20,8 +21,6 @@ export default class AudioCopyright extends AbstractCrudObject { whitelisted_fb_users: "whitelisted_fb_users"; whitelisted_ig_users: "whitelisted_ig_users"; }>; - getUpdateRecords(fields: string[], params?: Record): Promise; - getUpdateRecords(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getUpdateRecords(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - get(fields: string[], params?: Record): Promise; + getUpdateRecords(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/audio-isrc.d.ts b/types/facebook-nodejs-business-sdk/src/objects/audio-isrc.d.ts new file mode 100644 index 00000000000000..c30e700211b045 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/audio-isrc.d.ts @@ -0,0 +1,19 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AudioIsrc + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AudioIsrc extends AbstractCrudObject { + static get Fields(): Readonly<{ + all_kg_featured_artists: "all_kg_featured_artists"; + all_kg_main_artists: "all_kg_main_artists"; + artist_profile_picture_url: "artist_profile_picture_url"; + id: "id"; + isrc: "isrc"; + publishing_rights_data: "publishing_rights_data"; + top_searchable_artist_id: "top_searchable_artist_id"; + top_searchable_artist_name: "top_searchable_artist_name"; + top_searchable_artist_profile_pic_url: "top_searchable_artist_profile_pic_url"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/audio-release.d.ts b/types/facebook-nodejs-business-sdk/src/objects/audio-release.d.ts new file mode 100644 index 00000000000000..d5669919630658 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/audio-release.d.ts @@ -0,0 +1,26 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AudioRelease + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AudioRelease extends AbstractCrudObject { + static get Fields(): Readonly<{ + album_title: "album_title"; + asset_availability_status: "asset_availability_status"; + audio_availability_status: "audio_availability_status"; + audio_release_image_uri: "audio_release_image_uri"; + created_time: "created_time"; + displayed_artist: "displayed_artist"; + ean: "ean"; + genre: "genre"; + grid: "grid"; + id: "id"; + isrc: "isrc"; + label_name: "label_name"; + original_release_date: "original_release_date"; + parental_warning_type: "parental_warning_type"; + proprietary_id: "proprietary_id"; + upc: "upc"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/audio-visual-reference-match.d.ts b/types/facebook-nodejs-business-sdk/src/objects/audio-visual-reference-match.d.ts new file mode 100644 index 00000000000000..b39d581418fb57 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/audio-visual-reference-match.d.ts @@ -0,0 +1,40 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AudioVisualReferenceMatch + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AudioVisualReferenceMatch extends AbstractCrudObject { + static get Fields(): Readonly<{ + audio_conflicting_segments: "audio_conflicting_segments"; + audio_current_conflict_resolved_segments: "audio_current_conflict_resolved_segments"; + audio_segment_resolution_history: "audio_segment_resolution_history"; + conflict_type: "conflict_type"; + conflicting_countries: "conflicting_countries"; + country_resolution_history: "country_resolution_history"; + creation_time: "creation_time"; + current_conflict_resolved_countries: "current_conflict_resolved_countries"; + displayed_match_state: "displayed_match_state"; + dispute_form_data_entries_with_translations: "dispute_form_data_entries_with_translations"; + expiration_time: "expiration_time"; + id: "id"; + is_disputable: "is_disputable"; + match_state: "match_state"; + matched_overlap_percentage: "matched_overlap_percentage"; + matched_owner_match_duration_in_sec: "matched_owner_match_duration_in_sec"; + matched_reference_owner: "matched_reference_owner"; + modification_history: "modification_history"; + num_matches_on_matched_side: "num_matches_on_matched_side"; + num_matches_on_ref_side: "num_matches_on_ref_side"; + ref_owner_match_duration_in_sec: "ref_owner_match_duration_in_sec"; + reference_overlap_percentage: "reference_overlap_percentage"; + reference_owner: "reference_owner"; + rejection_form_data_entries_with_translations: "rejection_form_data_entries_with_translations"; + resolution_details: "resolution_details"; + resolution_reason: "resolution_reason"; + update_time: "update_time"; + views_on_matched_side: "views_on_matched_side"; + visual_conflicting_segments: "visual_conflicting_segments"; + visual_current_conflict_resolved_segments: "visual_current_conflict_resolved_segments"; + visual_segment_resolution_history: "visual_segment_resolution_history"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/auth-link.d.ts b/types/facebook-nodejs-business-sdk/src/objects/auth-link.d.ts new file mode 100644 index 00000000000000..eada4da2ea7fcc --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/auth-link.d.ts @@ -0,0 +1,10 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * AuthLink + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class AuthLink extends AbstractCrudObject { + static get Fields(): Readonly<{ + link: "link"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/automotive-model.d.ts b/types/facebook-nodejs-business-sdk/src/objects/automotive-model.d.ts index fbc76476b459c9..d78d7f658f8e8f 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/automotive-model.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/automotive-model.d.ts @@ -1,5 +1,5 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; /** * AutomotiveModel * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -49,14 +49,8 @@ export default class AutomotiveModel extends AbstractCrudObject { published: "PUBLISHED"; staging: "STAGING"; }>; - getAugmentedRealitiesMetadata(fields: string[], params?: Record): Promise; - getAugmentedRealitiesMetadata(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAugmentedRealitiesMetadata(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getChannelsToIntegrityStatus(fields: string[], params?: Record): Promise; - getChannelsToIntegrityStatus(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getChannelsToIntegrityStatus(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getVideosMetadata(fields: string[], params?: Record): Promise; - getVideosMetadata(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getVideosMetadata(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - get(fields: string[], params?: Record): Promise; + getAugmentedRealitiesMetadata(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getChannelsToIntegrityStatus(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getVideosMetadata(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/avatar-profile-picture.d.ts b/types/facebook-nodejs-business-sdk/src/objects/avatar-profile-picture.d.ts index 4a4f7875d73a85..bf0578e7e0281f 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/avatar-profile-picture.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/avatar-profile-picture.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * AvatarProfilePicture * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -8,5 +8,5 @@ export default class AvatarProfilePicture extends AbstractCrudObject { id: "id"; url: "url"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/avatar.d.ts b/types/facebook-nodejs-business-sdk/src/objects/avatar.d.ts index 192e277f3db0b8..257b072b111ef8 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/avatar.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/avatar.d.ts @@ -1,5 +1,5 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; /** * Avatar * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -8,8 +8,6 @@ export default class Avatar extends AbstractCrudObject { static get Fields(): Readonly<{ id: "id"; }>; - getModels(fields: string[], params?: Record): Promise; - getModels(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getModels(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - get(fields: string[], params?: Record): Promise; + getModels(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/bapi-domain.d.ts b/types/facebook-nodejs-business-sdk/src/objects/bapi-domain.d.ts new file mode 100644 index 00000000000000..48ffaec2e8396e --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/bapi-domain.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * BAPIDomain + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class BAPIDomain extends AbstractCrudObject { + static get Fields(): Readonly<{ + domain: "domain"; + in_cool_down_until: "in_cool_down_until"; + is_eligible_for_vo: "is_eligible_for_vo"; + is_in_cool_down: "is_in_cool_down"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/bcp-campaign.d.ts b/types/facebook-nodejs-business-sdk/src/objects/bcp-campaign.d.ts new file mode 100644 index 00000000000000..7ec848642c2648 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/bcp-campaign.d.ts @@ -0,0 +1,27 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * BCPCampaign + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class BCPCampaign extends AbstractCrudObject { + static get Fields(): Readonly<{ + ads_permission_required: "ads_permission_required"; + application_deadline: "application_deadline"; + campaign_goal: "campaign_goal"; + campaign_goal_other: "campaign_goal_other"; + content_delivery_deadline: "content_delivery_deadline"; + content_delivery_start_date: "content_delivery_start_date"; + content_requirements: "content_requirements"; + content_requirements_description: "content_requirements_description"; + currency: "currency"; + deal_negotiation_type: "deal_negotiation_type"; + description: "description"; + has_free_product: "has_free_product"; + id: "id"; + name: "name"; + payment_amount_for_ads: "payment_amount_for_ads"; + payment_amount_for_content: "payment_amount_for_content"; + payment_description: "payment_description"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/bcp-creator-ig-user.d.ts b/types/facebook-nodejs-business-sdk/src/objects/bcp-creator-ig-user.d.ts new file mode 100644 index 00000000000000..5cac006dcf62ea --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/bcp-creator-ig-user.d.ts @@ -0,0 +1,16 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * BCPCreatorIgUser + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class BCPCreatorIgUser extends AbstractCrudObject { + static get Fields(): Readonly<{ + email: "email"; + id: "id"; + is_paid_partnership_messages_enabled: "is_paid_partnership_messages_enabled"; + messaging_id: "messaging_id"; + portfolio_url: "portfolio_url"; + username: "username"; + }>; + 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 new file mode 100644 index 00000000000000..e1a8956a0601d5 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/bespoke-partner-guidance-laser.d.ts @@ -0,0 +1,14 @@ +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/bid-schedule.d.ts b/types/facebook-nodejs-business-sdk/src/objects/bid-schedule.d.ts new file mode 100644 index 00000000000000..26e9a8763303ba --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/bid-schedule.d.ts @@ -0,0 +1,18 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * BidSchedule + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class BidSchedule extends AbstractCrudObject { + static get Fields(): Readonly<{ + ad_object_id: "ad_object_id"; + bid_recurrence_type: "bid_recurrence_type"; + bid_timezone: "bid_timezone"; + bid_value: "bid_value"; + id: "id"; + status: "status"; + time_end: "time_end"; + time_start: "time_start"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/biz-inbox-offsite-email-account.d.ts b/types/facebook-nodejs-business-sdk/src/objects/biz-inbox-offsite-email-account.d.ts new file mode 100644 index 00000000000000..e603fdc9a94b2c --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/biz-inbox-offsite-email-account.d.ts @@ -0,0 +1,14 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; +/** + * BizInboxOffsiteEmailAccount + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class BizInboxOffsiteEmailAccount extends AbstractCrudObject { + static get Fields(): Readonly<{ + email_address: "email_address"; + id: "id"; + }>; + getAssignedUsers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/blind-pig.d.ts b/types/facebook-nodejs-business-sdk/src/objects/blind-pig.d.ts new file mode 100644 index 00000000000000..7526739288b580 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/blind-pig.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * BlindPig + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class BlindPig extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + name: "name"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/blocked-user-info.d.ts b/types/facebook-nodejs-business-sdk/src/objects/blocked-user-info.d.ts new file mode 100644 index 00000000000000..101d517630956c --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/blocked-user-info.d.ts @@ -0,0 +1,14 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * BlockedUserInfo + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class BlockedUserInfo extends AbstractCrudObject { + static get Fields(): Readonly<{ + block_time: "block_time"; + block_type: "block_type"; + fbid: "fbid"; + name: "name"; + username: "username"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/brand-request.d.ts b/types/facebook-nodejs-business-sdk/src/objects/brand-request.d.ts index 6ab8abfcaf9d52..21237170d6f6c6 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/brand-request.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/brand-request.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * BrandRequest * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -27,5 +27,5 @@ export default class BrandRequest extends AbstractCrudObject { submit_date: "submit_date"; total_budget: "total_budget"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/brand-safety-block-list-usage.d.ts b/types/facebook-nodejs-business-sdk/src/objects/brand-safety-block-list-usage.d.ts index 2c32ee1f257f30..8aca5f048375f7 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/brand-safety-block-list-usage.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/brand-safety-block-list-usage.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * BrandSafetyBlockListUsage * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/brand-safety-downloadable.d.ts b/types/facebook-nodejs-business-sdk/src/objects/brand-safety-downloadable.d.ts new file mode 100644 index 00000000000000..308fe87eda02b9 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/brand-safety-downloadable.d.ts @@ -0,0 +1,17 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * BrandSafetyDownloadable + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class BrandSafetyDownloadable extends AbstractCrudObject { + static get Fields(): Readonly<{ + account_context_id: "account_context_id"; + async_job_percent_complete: "async_job_percent_complete"; + async_job_status: "async_job_status"; + file_name: "file_name"; + id: "id"; + request_surface: "request_surface"; + url: "url"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/branded-content-ad-error.d.ts b/types/facebook-nodejs-business-sdk/src/objects/branded-content-ad-error.d.ts new file mode 100644 index 00000000000000..513c44eafe2724 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/branded-content-ad-error.d.ts @@ -0,0 +1,16 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * BrandedContentAdError + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class BrandedContentAdError extends AbstractCrudObject { + static get Fields(): Readonly<{ + blame_field_spec: "blame_field_spec"; + error_code: "error_code"; + error_description: "error_description"; + error_message: "error_message"; + error_placement: "error_placement"; + error_severity: "error_severity"; + help_center_id: "help_center_id"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/branded-content-eligible-sponsor-i-ds.d.ts b/types/facebook-nodejs-business-sdk/src/objects/branded-content-eligible-sponsor-i-ds.d.ts new file mode 100644 index 00000000000000..62cfac8dfde4a4 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/branded-content-eligible-sponsor-i-ds.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * BrandedContentEligibleSponsorIDs + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class BrandedContentEligibleSponsorIDs extends AbstractCrudObject { + static get Fields(): Readonly<{ + fb_page: "fb_page"; + ig_account_v2: "ig_account_v2"; + ig_approval_needed: "ig_approval_needed"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/branded-content-shadow-ig-media-id.d.ts b/types/facebook-nodejs-business-sdk/src/objects/branded-content-shadow-ig-media-id.d.ts new file mode 100644 index 00000000000000..1d6bb3c1b3f21c --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/branded-content-shadow-ig-media-id.d.ts @@ -0,0 +1,14 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * BrandedContentShadowIGMediaID + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class BrandedContentShadowIGMediaID extends AbstractCrudObject { + static get Fields(): Readonly<{ + eligibility_errors: "eligibility_errors"; + has_permission_for_partnership_ad: "has_permission_for_partnership_ad"; + id: "id"; + owner_id: "owner_id"; + permalink: "permalink"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/branded-content-shadow-ig-user-id.d.ts b/types/facebook-nodejs-business-sdk/src/objects/branded-content-shadow-ig-user-id.d.ts new file mode 100644 index 00000000000000..cc475df328e06f --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/branded-content-shadow-ig-user-id.d.ts @@ -0,0 +1,10 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * BrandedContentShadowIGUserID + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class BrandedContentShadowIGUserID extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/broad-targeting-categories.d.ts b/types/facebook-nodejs-business-sdk/src/objects/broad-targeting-categories.d.ts index 7bc08ce8f9e5f1..0d23c7e7c9db3a 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/broad-targeting-categories.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/broad-targeting-categories.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * BroadTargetingCategories * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/business-ad-account-request.d.ts b/types/facebook-nodejs-business-sdk/src/objects/business-ad-account-request.d.ts index 9c807264bf9d5b..228d0f4101b434 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/business-ad-account-request.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/business-ad-account-request.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * BusinessAdAccountRequest * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/business-ads-reporting-report-specs.d.ts b/types/facebook-nodejs-business-sdk/src/objects/business-ads-reporting-report-specs.d.ts new file mode 100644 index 00000000000000..fa75e65ddeea09 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/business-ads-reporting-report-specs.d.ts @@ -0,0 +1,48 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * BusinessAdsReportingReportSpecs + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class BusinessAdsReportingReportSpecs extends AbstractCrudObject { + static get Fields(): Readonly<{ + action_report_time: "action_report_time"; + ad_account_id: "ad_account_id"; + ad_account_ids: "ad_account_ids"; + ad_accounts: "ad_accounts"; + attribution_windows: "attribution_windows"; + business: "business"; + business_asset_group: "business_asset_group"; + comparison_date_interval: "comparison_date_interval"; + creation_source: "creation_source"; + creation_time: "creation_time"; + currency: "currency"; + date_preset: "date_preset"; + default_attribution_windows: "default_attribution_windows"; + filtering: "filtering"; + formatting: "formatting"; + id: "id"; + last_access_by: "last_access_by"; + last_access_time: "last_access_time"; + last_report_snapshot_id: "last_report_snapshot_id"; + last_report_snapshot_time: "last_report_snapshot_time"; + last_shared_report_expiration: "last_shared_report_expiration"; + limit: "limit"; + locked_dimensions: "locked_dimensions"; + report_name: "report_name"; + report_snapshot_async_percent_completion: "report_snapshot_async_percent_completion"; + report_snapshot_async_status: "report_snapshot_async_status"; + schedule_frequency: "schedule_frequency"; + scope: "scope"; + show_deprecate_aw_banner: "show_deprecate_aw_banner"; + sorting: "sorting"; + start_date: "start_date"; + status: "status"; + subscribers: "subscribers"; + update_by: "update_by"; + update_time: "update_time"; + user: "user"; + user_dimensions: "user_dimensions"; + user_metrics: "user_metrics"; + view_type: "view_type"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/business-advertisable-applications-result.d.ts b/types/facebook-nodejs-business-sdk/src/objects/business-advertisable-applications-result.d.ts new file mode 100644 index 00000000000000..f9e239060d5a8d --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/business-advertisable-applications-result.d.ts @@ -0,0 +1,15 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * BusinessAdvertisableApplicationsResult + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class BusinessAdvertisableApplicationsResult extends AbstractCrudObject { + static get Fields(): Readonly<{ + are_app_events_unavailable: "are_app_events_unavailable"; + business: "business"; + has_insight_permission: "has_insight_permission"; + id: "id"; + name: "name"; + photo_url: "photo_url"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/business-agreement.d.ts b/types/facebook-nodejs-business-sdk/src/objects/business-agreement.d.ts new file mode 100644 index 00000000000000..e9e86e940bad77 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/business-agreement.d.ts @@ -0,0 +1,22 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * BusinessAgreement + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class BusinessAgreement extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + request_status: "request_status"; + }>; + static get RequestStatus(): Readonly<{ + approve: "APPROVE"; + decline: "DECLINE"; + expired: "EXPIRED"; + in_progress: "IN_PROGRESS"; + pending: "PENDING"; + pending_email_verification: "PENDING_EMAIL_VERIFICATION"; + pending_integrity_review: "PENDING_INTEGRITY_REVIEW"; + }>; + get(fields: string[], params?: Record): Promise; + update(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/business-application-request.d.ts b/types/facebook-nodejs-business-sdk/src/objects/business-application-request.d.ts index c011a343ea094f..ae8319e9553378 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/business-application-request.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/business-application-request.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * BusinessApplicationRequest * @see {@link https://developers.facebook.com/docs/marketing-api/} 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 3fe8cbf368fd64..303f8b7ff199b8 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 @@ -1,5 +1,5 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; /** * BusinessAssetGroup * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -58,51 +58,30 @@ export default class BusinessAssetGroup extends AbstractCrudObject { edit: "EDIT"; upload: "UPLOAD"; }>; - deleteAssignedUsers(params?: Record): Promise; - getAssignedUsers(fields: string[], params?: Record): Promise; - getAssignedUsers(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAssignedUsers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createAssignedUser(fields: string[], params?: Record, pathOverride?: string | null): Promise; - deleteContainedAdAccounts(params?: Record): Promise; - getContainedAdAccounts(fields: string[], params?: Record): Promise; - getContainedAdAccounts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getContainedAdAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createContainedAdAccount(fields: string[], params?: Record, pathOverride?: string | null): Promise; - deleteContainedApplications(params?: Record): Promise; - getContainedApplications(fields: string[], params?: Record): Promise; - getContainedApplications(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getContainedApplications(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createContainedApplication(fields: string[], params?: Record, pathOverride?: string | null): Promise; - deleteContainedCustomConversions(params?: Record): Promise; - getContainedCustomConversions(fields: string[], params?: Record): Promise; - getContainedCustomConversions(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getContainedCustomConversions(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createContainedCustomConversion(fields: string[], params?: Record, pathOverride?: string | null): Promise; - deleteContainedInstagramAccounts(params?: Record): Promise; - getContainedInstagramAccounts(fields: string[], params?: Record): Promise; - getContainedInstagramAccounts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getContainedInstagramAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createContainedInstagramAccount(fields: string[], params?: Record, pathOverride?: string | null): Promise; - deleteContainedOfflineConversionDataSets(params?: Record): Promise; - getContainedOfflineConversionDataSets(fields: string[], params?: Record): Promise; - getContainedOfflineConversionDataSets(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getContainedOfflineConversionDataSets(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createContainedOfflineConversionDataSet(fields: string[], params?: Record, pathOverride?: string | null): Promise; - deleteContainedPages(params?: Record): Promise; - getContainedPages(fields: string[], params?: Record): Promise; - getContainedPages(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getContainedPages(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createContainedPage(fields: string[], params?: Record, pathOverride?: string | null): Promise; - deleteContainedPixels(params?: Record): Promise; - getContainedPixels(fields: string[], params?: Record): Promise; - getContainedPixels(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getContainedPixels(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createContainedPixel(fields: string[], params?: Record, pathOverride?: string | null): Promise; - deleteContainedProductCatalogs(params?: Record): Promise; - getContainedProductCatalogs(fields: string[], params?: Record): Promise; - getContainedProductCatalogs(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getContainedProductCatalogs(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createContainedProductCatalog(fields: string[], params?: Record, pathOverride?: string | null): Promise; - get(fields: string[], params?: Record): Promise; - update(fields: string[], params?: Record): Promise; + deleteAssignedUsers(params?: Record): Promise; + getAssignedUsers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createAssignedUser(fields: string[], params?: Record, pathOverride?: string | null): Promise; + deleteContainedAdAccounts(params?: Record): Promise; + getContainedAdAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createContainedAdAccount(fields: string[], params?: Record, pathOverride?: string | null): Promise; + deleteContainedApplications(params?: Record): Promise; + getContainedApplications(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createContainedApplication(fields: string[], params?: Record, pathOverride?: string | null): Promise; + deleteContainedCustomConversions(params?: Record): Promise; + getContainedCustomConversions(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createContainedCustomConversion(fields: string[], params?: Record, pathOverride?: string | null): Promise; + deleteContainedInstagramAccounts(params?: Record): Promise; + getContainedInstagramAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createContainedInstagramAccount(fields: string[], params?: Record, pathOverride?: string | null): Promise; + deleteContainedPages(params?: Record): Promise; + getContainedPages(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createContainedPage(fields: string[], params?: Record, pathOverride?: string | null): Promise; + deleteContainedPixels(params?: Record): Promise; + getContainedPixels(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createContainedPixel(fields: string[], params?: Record, pathOverride?: string | null): Promise; + deleteContainedProductCatalogs(params?: Record): Promise; + getContainedProductCatalogs(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createContainedProductCatalog(fields: string[], params?: Record, pathOverride?: string | null): Promise; + get(fields: string[], params?: Record): Promise; + update(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/business-asset-sharing-agreement.d.ts b/types/facebook-nodejs-business-sdk/src/objects/business-asset-sharing-agreement.d.ts index 8c09449b821b7b..f85c9c3505395f 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/business-asset-sharing-agreement.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/business-asset-sharing-agreement.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * BusinessAssetSharingAgreement * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -21,6 +21,6 @@ export default class BusinessAssetSharingAgreement extends AbstractCrudObject { pending_email_verification: "PENDING_EMAIL_VERIFICATION"; pending_integrity_review: "PENDING_INTEGRITY_REVIEW"; }>; - get(fields: string[], params?: Record): Promise; - update(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-creative-folder.d.ts b/types/facebook-nodejs-business-sdk/src/objects/business-creative-folder.d.ts index e2046b82b3bcde..aec8bf176f19a7 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/business-creative-folder.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/business-creative-folder.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * BusinessCreativeFolder * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -14,5 +14,5 @@ export default class BusinessCreativeFolder extends AbstractCrudObject { name: "name"; owner_business: "owner_business"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/business-creative-insights.d.ts b/types/facebook-nodejs-business-sdk/src/objects/business-creative-insights.d.ts new file mode 100644 index 00000000000000..56b1dec228cc02 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/business-creative-insights.d.ts @@ -0,0 +1,25 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * BusinessCreativeInsights + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class BusinessCreativeInsights extends AbstractCrudObject { + static get Fields(): Readonly<{ + actions: "actions"; + age: "age"; + country: "country"; + date_end: "date_end"; + date_start: "date_start"; + device_platform: "device_platform"; + gender: "gender"; + impressions: "impressions"; + inline_link_clicks: "inline_link_clicks"; + objective: "objective"; + optimization_goal: "optimization_goal"; + platform_position: "platform_position"; + publisher_platform: "publisher_platform"; + quality_ranking: "quality_ranking"; + video_play_actions: "video_play_actions"; + video_thruplay_watched_actions: "video_thruplay_watched_actions"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/business-creative.d.ts b/types/facebook-nodejs-business-sdk/src/objects/business-creative.d.ts new file mode 100644 index 00000000000000..8ecb0d0ca4aca4 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/business-creative.d.ts @@ -0,0 +1,20 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * BusinessCreative + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class BusinessCreative extends AbstractCrudObject { + static get Fields(): Readonly<{ + creation_time: "creation_time"; + duration: "duration"; + hash: "hash"; + height: "height"; + id: "id"; + name: "name"; + thumbnail: "thumbnail"; + type: "type"; + url: "url"; + video_id: "video_id"; + width: "width"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/business-franchise-config.d.ts b/types/facebook-nodejs-business-sdk/src/objects/business-franchise-config.d.ts new file mode 100644 index 00000000000000..fddab97146cfa0 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/business-franchise-config.d.ts @@ -0,0 +1,23 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * BusinessFranchiseConfig + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class BusinessFranchiseConfig extends AbstractCrudObject { + static get Fields(): Readonly<{ + active_partner_count: "active_partner_count"; + agency_business: "agency_business"; + agency_business_asset_group: "agency_business_asset_group"; + brand_name: "brand_name"; + business: "business"; + business_vertical: "business_vertical"; + id: "id"; + partner_count: "partner_count"; + pending_agency_business: "pending_agency_business"; + program_count: "program_count"; + shared_business_asset_group: "shared_business_asset_group"; + shared_creative_folder_count: "shared_creative_folder_count"; + shared_custom_audience_count: "shared_custom_audience_count"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/business-image-t-business-folder-path-item.d.ts b/types/facebook-nodejs-business-sdk/src/objects/business-image-t-business-folder-path-item.d.ts new file mode 100644 index 00000000000000..3016619a3b4cd7 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/business-image-t-business-folder-path-item.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * BusinessImageTBusinessFolderPathItem + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class BusinessImageTBusinessFolderPathItem extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + parent_folder_id: "parent_folder_id"; + type: "type"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/business-image.d.ts b/types/facebook-nodejs-business-sdk/src/objects/business-image.d.ts index 76cd7697846d2b..fcf7e9397e345c 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/business-image.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/business-image.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * BusinessImage * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -41,5 +41,5 @@ export default class BusinessImage extends AbstractCrudObject { right_column_standard: "RIGHT_COLUMN_STANDARD"; suggested_video_mobile: "SUGGESTED_VIDEO_MOBILE"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/business-managed-partner-eligibility.d.ts b/types/facebook-nodejs-business-sdk/src/objects/business-managed-partner-eligibility.d.ts index 235ae036c44b65..44424d34a3ec62 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/business-managed-partner-eligibility.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/business-managed-partner-eligibility.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * BusinessManagedPartnerEligibility * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/business-media-ad-placement-validation-result.d.ts b/types/facebook-nodejs-business-sdk/src/objects/business-media-ad-placement-validation-result.d.ts new file mode 100644 index 00000000000000..7a0edd9c7539fd --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/business-media-ad-placement-validation-result.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * BusinessMediaAdPlacementValidationResult + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class BusinessMediaAdPlacementValidationResult extends AbstractCrudObject { + static get Fields(): Readonly<{ + ad_placement: "ad_placement"; + ad_placement_label: "ad_placement_label"; + error_messages: "error_messages"; + is_valid: "is_valid"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/business-object-transfer-ownership-agreement.d.ts b/types/facebook-nodejs-business-sdk/src/objects/business-object-transfer-ownership-agreement.d.ts new file mode 100644 index 00000000000000..3483ab1acecc57 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/business-object-transfer-ownership-agreement.d.ts @@ -0,0 +1,14 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * BusinessObjectTransferOwnershipAgreement + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class BusinessObjectTransferOwnershipAgreement extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + receiving_business: "receiving_business"; + requesting_business: "requesting_business"; + status: "status"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/business-object.d.ts b/types/facebook-nodejs-business-sdk/src/objects/business-object.d.ts new file mode 100644 index 00000000000000..01c48c5a5e09ea --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/business-object.d.ts @@ -0,0 +1,14 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * BusinessObject + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class BusinessObject extends AbstractCrudObject { + static get Fields(): Readonly<{ + asset: "asset"; + asset_type: "asset_type"; + id: "id"; + name: "name"; + picture: "picture"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/business-owned-object-on-behalf-of-request.d.ts b/types/facebook-nodejs-business-sdk/src/objects/business-owned-object-on-behalf-of-request.d.ts index 3c91af1c68f651..d0afa7b18e3e43 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/business-owned-object-on-behalf-of-request.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/business-owned-object-on-behalf-of-request.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * BusinessOwnedObjectOnBehalfOfRequest * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -20,5 +20,5 @@ export default class BusinessOwnedObjectOnBehalfOfRequest extends AbstractCrudOb pending_email_verification: "PENDING_EMAIL_VERIFICATION"; pending_integrity_review: "PENDING_INTEGRITY_REVIEW"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/business-page-request.d.ts b/types/facebook-nodejs-business-sdk/src/objects/business-page-request.d.ts index 9904cef5fe306c..a23d6d1297a857 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/business-page-request.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/business-page-request.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * BusinessPageRequest * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/business-partner-premium-options.d.ts b/types/facebook-nodejs-business-sdk/src/objects/business-partner-premium-options.d.ts index 36b0002d76c96e..1e22688602ed58 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/business-partner-premium-options.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/business-partner-premium-options.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * BusinessPartnerPremiumOptions * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/business-product-catalog-tos.d.ts b/types/facebook-nodejs-business-sdk/src/objects/business-product-catalog-tos.d.ts new file mode 100644 index 00000000000000..ba115000414f59 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/business-product-catalog-tos.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * BusinessProductCatalogTOS + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class BusinessProductCatalogTOS extends AbstractCrudObject { + static get Fields(): Readonly<{ + accepted: "accepted"; + content: "content"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/business-project.d.ts b/types/facebook-nodejs-business-sdk/src/objects/business-project.d.ts new file mode 100644 index 00000000000000..47ef5229c0f8a1 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/business-project.d.ts @@ -0,0 +1,15 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * BusinessProject + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class BusinessProject extends AbstractCrudObject { + static get Fields(): Readonly<{ + business: "business"; + created_time: "created_time"; + creator: "creator"; + id: "id"; + name: "name"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/business-request.d.ts b/types/facebook-nodejs-business-sdk/src/objects/business-request.d.ts new file mode 100644 index 00000000000000..e54ae359686caa --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/business-request.d.ts @@ -0,0 +1,19 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * BusinessRequest + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class BusinessRequest extends AbstractCrudObject { + static get Fields(): Readonly<{ + accessor: "accessor"; + creation_time: "creation_time"; + id: "id"; + object_id: "object_id"; + object_type: "object_type"; + permitted_tasks: "permitted_tasks"; + request_status: "request_status"; + request_type: "request_type"; + requestor: "requestor"; + }>; + get(fields: string[], params?: Record): Promise; +} 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 0435f96569e9cf..0c150cdc19a176 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 @@ -1,5 +1,5 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; /** * BusinessRoleRequest * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -38,7 +38,7 @@ export default class BusinessRoleRequest extends AbstractCrudObject { 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; + 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-setting-logs-data.d.ts b/types/facebook-nodejs-business-sdk/src/objects/business-setting-logs-data.d.ts new file mode 100644 index 00000000000000..906e48502c5489 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/business-setting-logs-data.d.ts @@ -0,0 +1,14 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * BusinessSettingLogsData + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class BusinessSettingLogsData extends AbstractCrudObject { + static get Fields(): Readonly<{ + actor: "actor"; + event_object: "event_object"; + event_time: "event_time"; + event_type: "event_type"; + extra_data: "extra_data"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/business-tag.d.ts b/types/facebook-nodejs-business-sdk/src/objects/business-tag.d.ts new file mode 100644 index 00000000000000..5452fcc771c322 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/business-tag.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * BusinessTag + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class BusinessTag extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + name: "name"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/business-traffic-analysis-report.d.ts b/types/facebook-nodejs-business-sdk/src/objects/business-traffic-analysis-report.d.ts new file mode 100644 index 00000000000000..6f56c45ef19c3c --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/business-traffic-analysis-report.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * BusinessTrafficAnalysisReport + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class BusinessTrafficAnalysisReport extends AbstractCrudObject { + static get Fields(): Readonly<{ + audience_location: "audience_location"; + event_category: "event_category"; + traffic_analysis_impressions: "traffic_analysis_impressions"; + }>; +} 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 2c53037106321a..f4538bac53a74c 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 @@ -1,6 +1,6 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; +import Cursor from "./../cursor"; /** * BusinessUser * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -39,19 +39,11 @@ export default class BusinessUser extends AbstractCrudObject { partner_center_marketing: "PARTNER_CENTER_MARKETING"; partner_center_operations: "PARTNER_CENTER_OPERATIONS"; }>; - getAssignedAdAccounts(fields: string[], params?: Record): Promise; - getAssignedAdAccounts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAssignedAdAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAssignedBusinessAssetGroups(fields: string[], params?: Record): Promise; - getAssignedBusinessAssetGroups(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAssignedBusinessAssetGroups(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAssignedPages(fields: string[], params?: Record): Promise; - getAssignedPages(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAssignedPages(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAssignedProductCatalogs(fields: string[], params?: Record): Promise; - getAssignedProductCatalogs(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAssignedProductCatalogs(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; + 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; + 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-video-t-business-folder-path-item.d.ts b/types/facebook-nodejs-business-sdk/src/objects/business-video-t-business-folder-path-item.d.ts new file mode 100644 index 00000000000000..8aafe8f8b5e2e3 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/business-video-t-business-folder-path-item.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * BusinessVideoTBusinessFolderPathItem + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class BusinessVideoTBusinessFolderPathItem extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + parent_folder_id: "parent_folder_id"; + type: "type"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/business-video.d.ts b/types/facebook-nodejs-business-sdk/src/objects/business-video.d.ts index 51685cdd70f9c3..1f7e8b515bd572 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/business-video.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/business-video.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * BusinessVideo * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -11,5 +11,5 @@ export default class BusinessVideo extends AbstractCrudObject { name: "name"; video: "video"; }>; - get(fields: string[], params?: Record): Promise; + get(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 92f277f235282e..69adf14c46917c 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/business.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/business.d.ts @@ -1,22 +1,21 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; -import Cursor from './../cursor'; -import AdStudy from './ad-study'; -import AdAccount from './ad-account'; -import Application from './application'; -import AdsPixel from './ads-pixel'; -import BusinessUser from './business-user'; -import CustomConversion from './custom-conversion'; -import ProductCatalog from './product-catalog'; -import CPASCollaborationRequest from './cpas-collaboration-request'; -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 OfflineConversionDataSet from './offline-conversion-data-set'; -import OpenBridgeConfiguration from './open-bridge-configuration'; -import SystemUser from './system-user'; -import AdVideo from './ad-video'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; +import Cursor from "./../cursor"; +import AdStudy from "./ad-study"; +import AdAccount from "./ad-account"; +import Application from "./application"; +import AdsPixel from "./ads-pixel"; +import BusinessUser from "./business-user"; +import CustomConversion from "./custom-conversion"; +import ProductCatalog from "./product-catalog"; +import CPASCollaborationRequest from "./cpas-collaboration-request"; +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 OpenBridgeConfiguration from "./open-bridge-configuration"; +import SystemUser from "./system-user"; +import AdVideo from "./ad-video"; /** * Business * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -66,6 +65,7 @@ export default class Business extends AbstractCrudObject { luxury: "LUXURY"; marketing: "MARKETING"; non_profit: "NON_PROFIT"; + not_set: "NOT_SET"; organizations_and_associations: "ORGANIZATIONS_AND_ASSOCIATIONS"; other: "OTHER"; professional_services: "PROFESSIONAL_SERVICES"; @@ -108,6 +108,489 @@ export default class Business extends AbstractCrudObject { 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 PagePermittedTasks(): Readonly<{ advertise: "ADVERTISE"; analyze: "ANALYZE"; @@ -337,222 +820,108 @@ export default class Business extends AbstractCrudObject { physical_store: "PHYSICAL_STORE"; website: "WEBSITE"; }>; - createAccessToken(fields: string[], params?: Record, pathOverride?: string | null): Promise; - deleteAdAccounts(params?: Record): Promise; - getAdStudies(fields: string[], params?: Record): Promise; - getAdStudies(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdStudies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createAdStudy(fields: string[], params?: Record, pathOverride?: string | null): Promise; - createAdAccount(fields: string[], params?: Record, pathOverride?: string | null): Promise; - createAddPhoneNumber(fields: string[], params?: Record, pathOverride?: string | null): Promise; - createAdNetworkApplication(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getAdNetworkAnalytics(fields: string[], params?: Record): Promise; - getAdNetworkAnalytics(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdNetworkAnalytics(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createAdNetworkAnalytic(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getAdNetworkAnalyticsResults(fields: string[], params?: Record): Promise; - getAdNetworkAnalyticsResults(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdNetworkAnalyticsResults(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAdsReportingMmmReports(fields: string[], params?: Record): Promise; - getAdsReportingMmmReports(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdsReportingMmmReports(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAdsReportingMmmSchedulers(fields: string[], params?: Record): Promise; - getAdsReportingMmmSchedulers(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdsReportingMmmSchedulers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAdsPixels(fields: string[], params?: Record): Promise; - getAdsPixels(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdsPixels(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createAdsPixel(fields: string[], params?: Record, pathOverride?: string | null): Promise; - deleteAgencies(params?: Record): Promise; - getAgencies(fields: string[], params?: Record): Promise; - getAgencies(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAgencies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAnPlacements(fields: string[], params?: Record): Promise; - getAnPlacements(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAnPlacements(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createBlockListDraft(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getBusinessAssetGroups(fields: string[], params?: Record): Promise; - getBusinessAssetGroups(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getBusinessAssetGroups(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getBusinessInvoices(fields: string[], params?: Record): Promise; - getBusinessInvoices(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getBusinessInvoices(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getBusinessUsers(fields: string[], params?: Record): Promise; - getBusinessUsers(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getBusinessUsers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createBusinessUser(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getBusinessProjects(fields: string[], params?: Record): Promise; - getBusinessProjects(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getBusinessProjects(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createClaimCustomConversion(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getClientAdAccounts(fields: string[], params?: Record): Promise; - getClientAdAccounts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getClientAdAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getClientApps(fields: string[], params?: Record): Promise; - getClientApps(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getClientApps(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createClientApp(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getClientOffsiteSignalContainerBusinessObjects(fields: string[], params?: Record): Promise; - getClientOffsiteSignalContainerBusinessObjects(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getClientOffsiteSignalContainerBusinessObjects(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getClientPages(fields: string[], params?: Record): Promise; - getClientPages(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getClientPages(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createClientPage(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getClientPixels(fields: string[], params?: Record): Promise; - getClientPixels(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getClientPixels(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getClientProductCatalogs(fields: string[], params?: Record): Promise; - getClientProductCatalogs(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getClientProductCatalogs(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getClientWhatsAppBusinessAccounts(fields: string[], params?: Record): Promise; - getClientWhatsAppBusinessAccounts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getClientWhatsAppBusinessAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - deleteClients(params?: Record): Promise; - getClients(fields: string[], params?: Record): Promise; - getClients(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getClients(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getCollaborativeAdsCollaborationRequests(fields: string[], params?: Record): Promise; - getCollaborativeAdsCollaborationRequests(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCollaborativeAdsCollaborationRequests(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createCollaborativeAdsCollaborationRequest(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getCollaborativeAdsSuggestedPartners(fields: string[], params?: Record): Promise; - getCollaborativeAdsSuggestedPartners(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCollaborativeAdsSuggestedPartners(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getCommerceMerchantSettings(fields: string[], params?: Record): Promise; - getCommerceMerchantSettings(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCommerceMerchantSettings(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getCpasBusinessSetupConfig(fields: string[], params?: Record): Promise; - getCpasBusinessSetupConfig(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCpasBusinessSetupConfig(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createCpasBusinessSetupConfig(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getCpasMerchantConfig(fields: string[], params?: Record): Promise; - getCpasMerchantConfig(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCpasMerchantConfig(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createCreativeFolder(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getCreditCards(fields: string[], params?: Record): Promise; - getCreditCards(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCreditCards(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createCustomConversion(fields: string[], params?: Record, pathOverride?: string | null): Promise; - createDraftNegativeKeywordList(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getEventSourceGroups(fields: string[], params?: Record): Promise; - getEventSourceGroups(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getEventSourceGroups(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createEventSourceGroup(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getExtendedCreditApplications(fields: string[], params?: Record): Promise; - getExtendedCreditApplications(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getExtendedCreditApplications(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getExtendedCredits(fields: string[], params?: Record): Promise; - getExtendedCredits(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getExtendedCredits(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createImage(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getInitiatedAudienceSharingRequests(fields: string[], params?: Record): Promise; - getInitiatedAudienceSharingRequests(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getInitiatedAudienceSharingRequests(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - deleteInstagramAccounts(params?: Record): Promise; - getInstagramAccounts(fields: string[], params?: Record): Promise; - getInstagramAccounts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getInstagramAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getInstagramBusinessAccounts(fields: string[], params?: Record): Promise; - getInstagramBusinessAccounts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getInstagramBusinessAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - deleteManagedBusinesses(params?: Record): Promise; - createManagedBusiness(fields: string[], params?: Record, pathOverride?: string | null): Promise; - createManagedPartnerBusinessSetup(fields: string[], params?: Record, pathOverride?: string | null): Promise; - deleteManagedPartnerBusinesses(params?: Record): Promise; - createManagedPartnerBusiness(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getNegativeKeywordLists(fields: string[], params?: Record): Promise; - getNegativeKeywordLists(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getNegativeKeywordLists(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getOfflineConversionDataSets(fields: string[], params?: Record): Promise; - getOfflineConversionDataSets(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getOfflineConversionDataSets(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createOfflineConversionDataSet(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getOpenBridgeConfigurations(fields: string[], params?: Record): Promise; - getOpenBridgeConfigurations(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getOpenBridgeConfigurations(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createOpenBridgeConfiguration(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getOwnedAdAccounts(fields: string[], params?: Record): Promise; - getOwnedAdAccounts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getOwnedAdAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createOwnedAdAccount(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getOwnedApps(fields: string[], params?: Record): Promise; - getOwnedApps(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getOwnedApps(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createOwnedApp(fields: string[], params?: Record, pathOverride?: string | null): Promise; - deleteOwnedBusinesses(params?: Record): Promise; - getOwnedBusinesses(fields: string[], params?: Record): Promise; - getOwnedBusinesses(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getOwnedBusinesses(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createOwnedBusiness(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getOwnedInstagramAccounts(fields: string[], params?: Record): Promise; - getOwnedInstagramAccounts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getOwnedInstagramAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getOwnedOffsiteSignalContainerBusinessObjects(fields: string[], params?: Record): Promise; - getOwnedOffsiteSignalContainerBusinessObjects(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getOwnedOffsiteSignalContainerBusinessObjects(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getOwnedPages(fields: string[], params?: Record): Promise; - getOwnedPages(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getOwnedPages(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createOwnedPage(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getOwnedPixels(fields: string[], params?: Record): Promise; - getOwnedPixels(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getOwnedPixels(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getOwnedProductCatalogs(fields: string[], params?: Record): Promise; - getOwnedProductCatalogs(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getOwnedProductCatalogs(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createOwnedProductCatalog(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getOwnedWhatsAppBusinessAccounts(fields: string[], params?: Record): Promise; - getOwnedWhatsAppBusinessAccounts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getOwnedWhatsAppBusinessAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - deletePages(params?: Record): Promise; - getPartnerAccountLinking(fields: string[], params?: Record): Promise; - getPartnerAccountLinking(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPartnerAccountLinking(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createPartnerPremiumOption(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getPendingClientAdAccounts(fields: string[], params?: Record): Promise; - getPendingClientAdAccounts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPendingClientAdAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getPendingClientApps(fields: string[], params?: Record): Promise; - getPendingClientApps(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPendingClientApps(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getPendingClientPages(fields: string[], params?: Record): Promise; - getPendingClientPages(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPendingClientPages(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getPendingOwnedAdAccounts(fields: string[], params?: Record): Promise; - getPendingOwnedAdAccounts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPendingOwnedAdAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getPendingOwnedPages(fields: string[], params?: Record): Promise; - getPendingOwnedPages(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPendingOwnedPages(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getPendingSharedOffsiteSignalContainerBusinessObjects(fields: string[], params?: Record): Promise; - getPendingSharedOffsiteSignalContainerBusinessObjects(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPendingSharedOffsiteSignalContainerBusinessObjects(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getPendingUsers(fields: string[], params?: Record): Promise; - getPendingUsers(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPendingUsers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getPicture(fields: string[], params?: Record): Promise; - getPicture(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPicture(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createPixelTo(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getPreVerifiedNumbers(fields: string[], params?: Record): Promise; - getPreVerifiedNumbers(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPreVerifiedNumbers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getReceivedAudienceSharingRequests(fields: string[], params?: Record): Promise; - getReceivedAudienceSharingRequests(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getReceivedAudienceSharingRequests(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createSetupManagedPartnerAdAccount(fields: string[], params?: Record, pathOverride?: string | null): Promise; - deleteSharePreVerifiedNumbers(params?: Record): Promise; - createSharePreVerifiedNumber(fields: string[], params?: Record, pathOverride?: string | null): Promise; - createSystemUserAccessToken(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getSystemUsers(fields: string[], params?: Record): Promise; - getSystemUsers(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getSystemUsers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createSystemUser(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getThirdPartyMeasurementReportDataset(fields: string[], params?: Record): Promise; - getThirdPartyMeasurementReportDataset(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getThirdPartyMeasurementReportDataset(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createVideo(fields: string[], params?: Record, pathOverride?: string | null): Promise; - get(fields: string[], params?: Record): Promise; - update(fields: string[], params?: Record): Promise; + createAccessToken(fields: string[], params?: Record, pathOverride?: string | null): Promise; + deleteAdAccounts(params?: Record): Promise; + getAdStudies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createAdStudy(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createAdAccount(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createAddPhoneNumber(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createAdNetworkApplication(fields: string[], params?: Record, pathOverride?: string | null): Promise; + 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; + getAdsReportingMmmReports(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getAdsReportingMmmSchedulers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getAdsPixels(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createAdsPixel(fields: string[], params?: Record, pathOverride?: string | null): Promise; + deleteAgencies(params?: Record): Promise; + getAgencies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getAnPlacements(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createBlockListDraft(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getBusinessAssetGroups(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getBusinessInvoices(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getBusinessUsers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createBusinessUser(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getBusinessProjects(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createClaimCustomConversion(fields: string[], params?: Record, pathOverride?: string | null): Promise; + 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; + 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; + getClientPixels(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getClientProductCatalogs(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getClientWhatsAppBusinessAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + deleteClients(params?: Record): Promise; + getClients(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getCollaborativeAdsCollaborationRequests(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createCollaborativeAdsCollaborationRequest(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getCollaborativeAdsSuggestedPartners(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getCommerceMerchantSettings(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getCpasBusinessSetupConfig(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createCpasBusinessSetupConfig(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getCpasMerchantConfig(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createCreativeFolder(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getCreditCards(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createCustomConversion(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createDraftNegativeKeywordList(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getEventSourceGroups(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createEventSourceGroup(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getExtendedCreditApplications(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getExtendedCredits(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createImage(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getInitiatedAudienceSharingRequests(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + deleteInstagramAccounts(params?: Record): Promise; + getInstagramAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getInstagramBusinessAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + deleteMAnAgeDBusinesses(params?: Record): Promise; + createMAnAgeDBusiness(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createMAnAgeDPartnerBusinessSetup(fields: string[], params?: Record, pathOverride?: string | null): Promise; + deleteMAnAgeDPartnerBusinesses(params?: Record): Promise; + createMAnAgeDPartnerBusiness(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getNegativeKeywordLists(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getOpenBridgeConfigurations(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createOpenBridgeConfiguration(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getOwnedAdAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createOwnedAdAccount(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getOwnedApps(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createOwnedApp(fields: string[], params?: Record, pathOverride?: string | null): Promise; + deleteOwnedBusinesses(params?: Record): Promise; + 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; + 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; + getOwnedPixels(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getOwnedProductCatalogs(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createOwnedProductCatalog(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getOwnedWhatsAppBusinessAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + deletePages(params?: Record): Promise; + getPartnerAccountLinking(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createPartnerPremiumOption(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getPendingClientAdAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getPendingClientApps(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getPendingClientPages(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getPendingOwnedAdAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getPendingOwnedPages(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getPendingShareDOffsiteSignalContainerBusinessObjects(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getPendingUsers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getPicture(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createPixelTo(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getPreVerifiedNumbers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getReceivedAudienceSharingRequests(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getResellerGuidances(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getSelfCertifiedWhatsappBusinessSubmissions(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createSetupMAnAgeDPartnerAdAccount(fields: string[], params?: Record, pathOverride?: string | null): Promise; + deleteSharePreVerifiedNumbers(params?: Record): Promise; + createSharePreVerifiedNumber(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createSystemUserAccessToken(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getSystemUsers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createSystemUser(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getThirdPartyMeasurementReportDataset(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createVideo(fields: string[], params?: Record, pathOverride?: string | null): Promise; + get(fields: string[], params?: Record): Promise; + update(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/businessdataapi/content.d.ts b/types/facebook-nodejs-business-sdk/src/objects/businessdataapi/content.d.ts index bdcd4fa0458168..09bdf2931ca628 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/businessdataapi/content.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/businessdataapi/content.d.ts @@ -122,5 +122,5 @@ export default class Content { /** * Convert to Json object for api call */ - toJson(): Record; + toJson(): Record; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/businessdataapi/custom-data.d.ts b/types/facebook-nodejs-business-sdk/src/objects/businessdataapi/custom-data.d.ts index 3e769e60d116f3..b90a45bb3f25ae 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/businessdataapi/custom-data.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/businessdataapi/custom-data.d.ts @@ -1,5 +1,5 @@ -import Content from './content.js'; -import UserData from './user-data.js'; +import Content from "./content"; +import UserData from "./user-data"; /** * CustomData represents the Custom Data Parameters of a Business Data Event Request. */ @@ -17,7 +17,7 @@ export default class CustomData { /** * @param {Number} value value of the order Eg: 123.45 * @param {String} currency currency involved in the transaction Eg: usd - * @param {Content[]} contents Array of Content Objects. Use {Content} class to define a content. + * @param {Array} 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 order * @param {String} shipping_contact Shipping contact information. User {UserData} class to define a contact. @@ -77,7 +77,7 @@ export default class CustomData { set contents(contents: Content[]); /** * 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. + * @param { Array< Content >} contents An array of Content objects that contain the product IDs associated with the event plus information about the products. * Example: [{'id':'ABC123','quantity' :2,'item_price':5.99}, {'id':'XYZ789','quantity':2, 'item_price':9.99}] */ setContents(contents: Content[]): CustomData; @@ -192,5 +192,5 @@ export default class CustomData { /** * Convert to Json object for api call */ - toJson(): Record; + toJson(): Record; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/businessdataapi/event-request.d.ts b/types/facebook-nodejs-business-sdk/src/objects/businessdataapi/event-request.d.ts index 58b7c17e83886f..38157918b791eb 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/businessdataapi/event-request.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/businessdataapi/event-request.d.ts @@ -1,5 +1,5 @@ -import Event from './event'; -import EventResponse from './event-response'; +import Event from "./event"; +import EventResponse from "./event-response"; /** * EventRequest for Business Data API */ @@ -8,11 +8,11 @@ export default class EventRequest { _page_id: string; _events: Event[]; _partner_agent: string | null | undefined; - _api: Record; + _api: Record; /** * @param {String} access_token Access Token for the user calling Graph API * @param {String} page_id Page Id to which you are sending the events - * @param {Event[]} events Data for the request Payload for a Business Data Event + * @param {Array} events Data for the request Payload for a Business Data Event * @param {String} partner_agent Platform from which the event is sent e.g. Zapier */ constructor(access_token: string, page_id: string, events?: Event[], partner_agent?: string | null); diff --git a/types/facebook-nodejs-business-sdk/src/objects/businessdataapi/event-response.d.ts b/types/facebook-nodejs-business-sdk/src/objects/businessdataapi/event-response.d.ts index ea8dc73c16dc55..146fc333a9069f 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/businessdataapi/event-response.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/businessdataapi/event-response.d.ts @@ -4,13 +4,13 @@ export default class EventResponse { _events_received: number; _events_dropped: number; - _message: Array>; + _message: Array>; /** * @param {Number} events_received * @param {Number} events_dropped * @param {Array} message */ - constructor(events_received: number, events_dropped: number, message?: Array>); + constructor(events_received: number, events_dropped: number, message?: Array>); /** * Gets the events received number from the Graph API Response. */ @@ -47,15 +47,15 @@ export default class EventResponse { * Gets the messages from the response received from Graph API. * @return messages in the event Response */ - get message(): Array>; + get message(): Array>; /** * Sets the messages as array for the response received from Graph API. * @param message in the event Response */ - set message(message: Array>); + set message(message: Array>); /** * Sets the messages as array for the response received from Graph API. * @param {Array} message in the event Response */ - setMessage(message: Array>): EventResponse; + setMessage(message: Array>): EventResponse; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/businessdataapi/event.d.ts b/types/facebook-nodejs-business-sdk/src/objects/businessdataapi/event.d.ts index 0ed2422af71a13..4a44ba39f58f10 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/businessdataapi/event.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/businessdataapi/event.d.ts @@ -1,5 +1,5 @@ -import UserData from './user-data'; -import CustomData from './custom-data'; +import UserData from "./user-data"; +import CustomData from "./custom-data"; /** * Event for Business Data API */ @@ -18,7 +18,7 @@ export default class Event { * @param {String} event_id This ID can be any string chosen by the advertiser. * @param {UserData} user_data A map that contains user data. See UserData Class for options. * @param {CustomData} custom_data A map that contains user data. See CustomData Class for options. - * @param {string[]} data_processing_options Processing options you would like to enable for a specific event. + * @param {Array} 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. */ @@ -75,7 +75,7 @@ export default class 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'] + * @param {Array} data_processing_options represents Data processing options you would like to enable for a specific event, e.g. [] or ['LDU'] * @see {@link https://developers.facebook.com/docs/marketing-apis/data-processing-options} */ set data_processing_options(data_processing_options: string[]); @@ -103,5 +103,5 @@ export default class Event { /** * Convert to Json object for api call */ - toJson(): Record; + toJson(): Record; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/businessdataapi/user-data.d.ts b/types/facebook-nodejs-business-sdk/src/objects/businessdataapi/user-data.d.ts index 470e2794f6fa97..a1424247680092 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/businessdataapi/user-data.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/businessdataapi/user-data.d.ts @@ -222,5 +222,5 @@ export default class UserData { /** * Convert to Json object for api call */ - toJson(): Record; + toJson(): Record; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/calibrator-existing-rule.d.ts b/types/facebook-nodejs-business-sdk/src/objects/calibrator-existing-rule.d.ts new file mode 100644 index 00000000000000..cea0ed2db83c11 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/calibrator-existing-rule.d.ts @@ -0,0 +1,21 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * CalibratorExistingRule + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class CalibratorExistingRule extends AbstractCrudObject { + static get Fields(): Readonly<{ + value_7d_volume: "7d_volume"; + creation_source: "creation_source"; + creation_time: "creation_time"; + creator: "creator"; + event_type: "event_type"; + id: "id"; + rule: "rule"; + rule_type: "rule_type"; + sample_urls: "sample_urls"; + status: "status"; + transforms: "transforms"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/call-ads-phone-data.d.ts b/types/facebook-nodejs-business-sdk/src/objects/call-ads-phone-data.d.ts new file mode 100644 index 00000000000000..f93bf215e3af6f --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/call-ads-phone-data.d.ts @@ -0,0 +1,16 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * CallAdsPhoneData + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class CallAdsPhoneData extends AbstractCrudObject { + static get Fields(): Readonly<{ + call_ads_phone_data_use_case: "call_ads_phone_data_use_case"; + callback_variant: "callback_variant"; + destination_website_url: "destination_website_url"; + id: "id"; + page: "page"; + phone_number: "phone_number"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/campaign-actions-data.d.ts b/types/facebook-nodejs-business-sdk/src/objects/campaign-actions-data.d.ts new file mode 100644 index 00000000000000..9021bf735510d0 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/campaign-actions-data.d.ts @@ -0,0 +1,8 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * CampaignActionsData + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class CampaignActionsData extends AbstractCrudObject { + static get Fields(): Readonly<{}>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/campaign-group-brand-configuration.d.ts b/types/facebook-nodejs-business-sdk/src/objects/campaign-group-brand-configuration.d.ts index 061c06e823a63b..05e86832f02fc6 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/campaign-group-brand-configuration.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/campaign-group-brand-configuration.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * CampaignGroupBrandConfiguration * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/campaign-group-collaborative-ads-partner-info.d.ts b/types/facebook-nodejs-business-sdk/src/objects/campaign-group-collaborative-ads-partner-info.d.ts index 96acabf9e57263..65a0993c373ee1 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/campaign-group-collaborative-ads-partner-info.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/campaign-group-collaborative-ads-partner-info.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * CampaignGroupCollaborativeAdsPartnerInfo * @see {@link https://developers.facebook.com/docs/marketing-api/} 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 c472e6a6a811f1..7a2b9440fdf23c 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/campaign.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/campaign.d.ts @@ -1,8 +1,8 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; -import Cursor from './../cursor'; -import HighDemandPeriod from './high-demand-period'; -import AdReportRun from './ad-report-run'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; +import Cursor from "./../cursor"; +import HighDemandPeriod from "./high-demand-period"; +import AdReportRun from "./ad-report-run"; /** * Campaign * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -54,6 +54,7 @@ export default class Campaign extends AbstractCrudObject { cost_cap: "COST_CAP"; lowest_cost_without_cap: "LOWEST_COST_WITHOUT_CAP"; lowest_cost_with_bid_cap: "LOWEST_COST_WITH_BID_CAP"; + lowest_cost_with_min_roas: "LOWEST_COST_WITH_MIN_ROAS"; }>; static get ConfiguredStatus(): Readonly<{ active: "ACTIVE"; @@ -406,29 +407,17 @@ export default class Campaign extends AbstractCrudObject { inherited_from_source: "INHERITED_FROM_SOURCE"; paused: "PAUSED"; }>; - getAdStudies(fields: string[], params?: Record): Promise; - getAdStudies(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdStudies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createAdLabel(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getAdRulesGoverned(fields: string[], params?: Record): Promise; - getAdRulesGoverned(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdRulesGoverned(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAds(fields: string[], params?: Record): Promise; - getAds(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAds(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAdSets(fields: string[], params?: Record): Promise; - getAdSets(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdSets(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createBudgetSchedule(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getCopies(fields: string[], params?: Record): Promise; - getCopies(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCopies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createCopy(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getInsights(fields: string[], params?: Record): Promise; - getInsights(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getInsights(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getInsightsAsync(fields: string[], params?: Record, pathOverride?: string | null): Promise; - delete(fields: string[], params?: Record): Promise; - get(fields: string[], params?: Record): Promise; - update(fields: string[], params?: Record): Promise; + getAdStudies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createAdLabel(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getAdRulesGoverned(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getAds(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getAdSets(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createBudgetSchedule(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getCopies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createCopy(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getInsights(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getInsightsAsync(fields: string[], params?: Record, pathOverride?: string | null): 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/canvas-ad-settings.d.ts b/types/facebook-nodejs-business-sdk/src/objects/canvas-ad-settings.d.ts index fd9a4531859ba7..90c8676164e18c 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/canvas-ad-settings.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/canvas-ad-settings.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * CanvasAdSettings * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/canvas-body-element.d.ts b/types/facebook-nodejs-business-sdk/src/objects/canvas-body-element.d.ts index 9aa463e7c4ed8a..1fde56760da09e 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/canvas-body-element.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/canvas-body-element.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * CanvasBodyElement * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/canvas-collection-thumbnail.d.ts b/types/facebook-nodejs-business-sdk/src/objects/canvas-collection-thumbnail.d.ts index 802f9ec24dd217..8ef572698535e4 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/canvas-collection-thumbnail.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/canvas-collection-thumbnail.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * CanvasCollectionThumbnail * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/canvas-dynamic-setting.d.ts b/types/facebook-nodejs-business-sdk/src/objects/canvas-dynamic-setting.d.ts index bc04407f16da81..65e63ad3daf4df 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/canvas-dynamic-setting.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/canvas-dynamic-setting.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * CanvasDynamicSetting * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -9,5 +9,5 @@ export default class CanvasDynamicSetting extends AbstractCrudObject { product_set_id: "product_set_id"; id: "id"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/canvas-preview.d.ts b/types/facebook-nodejs-business-sdk/src/objects/canvas-preview.d.ts new file mode 100644 index 00000000000000..930ac80a0e111a --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/canvas-preview.d.ts @@ -0,0 +1,10 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * CanvasPreview + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class CanvasPreview extends AbstractCrudObject { + static get Fields(): Readonly<{ + body: "body"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/canvas-template.d.ts b/types/facebook-nodejs-business-sdk/src/objects/canvas-template.d.ts new file mode 100644 index 00000000000000..7a4141a95a87d4 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/canvas-template.d.ts @@ -0,0 +1,24 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * CanvasTemplate + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class CanvasTemplate extends AbstractCrudObject { + static get Fields(): Readonly<{ + channels: "channels"; + description: "description"; + document: "document"; + id: "id"; + is_multi_tab_supportable: "is_multi_tab_supportable"; + is_new: "is_new"; + name: "name"; + objectives: "objectives"; + owner_id: "owner_id"; + required_capabilities: "required_capabilities"; + snapshot_photo: "snapshot_photo"; + status: "status"; + sub_verticals: "sub_verticals"; + verticals: "verticals"; + }>; + get(fields: string[], params?: Record): Promise; +} 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 737220851dcd02..45f2f4dc7c5aa8 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/canvas.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/canvas.d.ts @@ -1,5 +1,5 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; /** * Canvas * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -34,9 +34,8 @@ export default class Canvas extends AbstractCrudObject { update_time: "update_time"; use_retailer_item_ids: "use_retailer_item_ids"; }>; - getPreviews(fields: string[], params?: Record): Promise; - getPreviews(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPreviews(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - get(fields: string[], params?: Record): Promise; - update(fields: string[], params?: Record): Promise; + getPreview(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/cass-setup-offline-event-set-progress.d.ts b/types/facebook-nodejs-business-sdk/src/objects/cass-setup-offline-event-set-progress.d.ts new file mode 100644 index 00000000000000..2478c5e08b80d6 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/cass-setup-offline-event-set-progress.d.ts @@ -0,0 +1,8 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * CASSSetupOfflineEventSetProgress + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class CASSSetupOfflineEventSetProgress extends AbstractCrudObject { + static get Fields(): Readonly<{}>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/catalog-based-targeting.d.ts b/types/facebook-nodejs-business-sdk/src/objects/catalog-based-targeting.d.ts index 7bcaab60d3da39..8da8dbeee9d335 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/catalog-based-targeting.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/catalog-based-targeting.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * CatalogBasedTargeting * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/catalog-item-app-links.d.ts b/types/facebook-nodejs-business-sdk/src/objects/catalog-item-app-links.d.ts index 15ff0c0f90e6e7..1262a09899a076 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/catalog-item-app-links.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/catalog-item-app-links.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * CatalogItemAppLinks * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/catalog-item-appeal-status.d.ts b/types/facebook-nodejs-business-sdk/src/objects/catalog-item-appeal-status.d.ts index d1a58f47c09e1f..67dee28b33cca9 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/catalog-item-appeal-status.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/catalog-item-appeal-status.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * CatalogItemAppealStatus * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/catalog-item-channels-to-integrity-status.d.ts b/types/facebook-nodejs-business-sdk/src/objects/catalog-item-channels-to-integrity-status.d.ts index 61e2ffd7ba6219..6fbf134626617c 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/catalog-item-channels-to-integrity-status.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/catalog-item-channels-to-integrity-status.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * CatalogItemChannelsToIntegrityStatus * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/catalog-item-override.d.ts b/types/facebook-nodejs-business-sdk/src/objects/catalog-item-override.d.ts new file mode 100644 index 00000000000000..134528db6680a1 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/catalog-item-override.d.ts @@ -0,0 +1,14 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * CatalogItemOverride + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class CatalogItemOverride extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + local_info: "local_info"; + override_type: "override_type"; + override_value: "override_value"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/catalog-item-rejection-reasons.d.ts b/types/facebook-nodejs-business-sdk/src/objects/catalog-item-rejection-reasons.d.ts new file mode 100644 index 00000000000000..3a88067ca10b98 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/catalog-item-rejection-reasons.d.ts @@ -0,0 +1,18 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * CatalogItemRejectionReasons + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class CatalogItemRejectionReasons extends AbstractCrudObject { + static get Fields(): Readonly<{ + capability: "capability"; + rejection_information: "rejection_information"; + }>; + static get Capability(): Readonly<{ + business_inbox_in_messenger: "business_inbox_in_messenger"; + shops: "shops"; + test_capability: "test_capability"; + universal_checkout: "universal_checkout"; + us_marketplace: "us_marketplace"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/catalog-item-validation-error-list.d.ts b/types/facebook-nodejs-business-sdk/src/objects/catalog-item-validation-error-list.d.ts new file mode 100644 index 00000000000000..3ec58947270749 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/catalog-item-validation-error-list.d.ts @@ -0,0 +1,10 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * CatalogItemValidationErrorList + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class CatalogItemValidationErrorList extends AbstractCrudObject { + static get Fields(): Readonly<{ + errors: "errors"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/catalog-segment-all-match-count-laser.d.ts b/types/facebook-nodejs-business-sdk/src/objects/catalog-segment-all-match-count-laser.d.ts deleted file mode 100644 index 09c013b91e932b..00000000000000 --- a/types/facebook-nodejs-business-sdk/src/objects/catalog-segment-all-match-count-laser.d.ts +++ /dev/null @@ -1,15 +0,0 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -/** - * CatalogSegmentAllMatchCountLaser - * @see {@link https://developers.facebook.com/docs/marketing-api/} - */ -export default class CatalogSegmentAllMatchCountLaser extends AbstractCrudObject { - static get Fields(): Readonly<{ - date_start: "date_start"; - date_stop: "date_stop"; - event: "event"; - source: "source"; - total_matched_content_ids: "total_matched_content_ids"; - unique_matched_content_ids: "unique_matched_content_ids"; - }>; -} diff --git a/types/facebook-nodejs-business-sdk/src/objects/catalog-smart-pixel-settings.d.ts b/types/facebook-nodejs-business-sdk/src/objects/catalog-smart-pixel-settings.d.ts new file mode 100644 index 00000000000000..000a95f76ea484 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/catalog-smart-pixel-settings.d.ts @@ -0,0 +1,29 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * CatalogSmartPixelSettings + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class CatalogSmartPixelSettings extends AbstractCrudObject { + static get Fields(): Readonly<{ + allowed_domains: "allowed_domains"; + available_property_filters: "available_property_filters"; + catalog: "catalog"; + cbb_custom_override_filters: "cbb_custom_override_filters"; + cbb_default_filter: "cbb_default_filter"; + cbb_default_filter_crawl_params: "cbb_default_filter_crawl_params"; + cbb_override_type_field_mapping: "cbb_override_type_field_mapping"; + defaults: "defaults"; + filters: "filters"; + id: "id"; + is_cbb_enabled: "is_cbb_enabled"; + is_create_enabled: "is_create_enabled"; + is_delete_enabled: "is_delete_enabled"; + is_update_enabled: "is_update_enabled"; + microdata_format_precedence: "microdata_format_precedence"; + pixel: "pixel"; + property_filter: "property_filter"; + retention_time_sec: "retention_time_sec"; + trusted_domains: "trusted_domains"; + }>; + get(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 ae0f22c52b8ace..fa3836bcf3cb7c 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 @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * CatalogSubVerticalList * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -34,7 +34,6 @@ export default class CatalogSubVerticalList extends AbstractCrudObject { local_service_business_item: "local_service_business_item"; local_service_business_restaurant: "local_service_business_restaurant"; loyalty_offer: "loyalty_offer"; - meetup_space: "meetup_space"; nursery: "nursery"; printers_and_scanners: "printers_and_scanners"; printers_scanners_and_fax_machines: "printers_scanners_and_fax_machines"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/catalog-website-onboarding-settings.d.ts b/types/facebook-nodejs-business-sdk/src/objects/catalog-website-onboarding-settings.d.ts new file mode 100644 index 00000000000000..743c952b0bfe5f --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/catalog-website-onboarding-settings.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * CatalogWebsiteOnboardingSettings + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class CatalogWebsiteOnboardingSettings extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + status: "status"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/catalog-website-settings.d.ts b/types/facebook-nodejs-business-sdk/src/objects/catalog-website-settings.d.ts new file mode 100644 index 00000000000000..c42476e040b284 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/catalog-website-settings.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * CatalogWebsiteSettings + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class CatalogWebsiteSettings extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + is_allowed_to_crawl: "is_allowed_to_crawl"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/chat-plugin.d.ts b/types/facebook-nodejs-business-sdk/src/objects/chat-plugin.d.ts index 7ea214c45dd5b4..879d3e9a62dd66 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/chat-plugin.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/chat-plugin.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ChatPlugin * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/check-batch-request-status.d.ts b/types/facebook-nodejs-business-sdk/src/objects/check-batch-request-status.d.ts index fc9f57790f9446..c51621994997c3 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/check-batch-request-status.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/check-batch-request-status.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * CheckBatchRequestStatus * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/child-event.d.ts b/types/facebook-nodejs-business-sdk/src/objects/child-event.d.ts index 16c6a8c33be232..b88bfb70828b17 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/child-event.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/child-event.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ChildEvent * @see {@link https://developers.facebook.com/docs/marketing-api/} 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 new file mode 100644 index 00000000000000..7e44c92e996fe1 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/china-business-onboarding-vetting-request.d.ts @@ -0,0 +1,52 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ChinaBusinessOnboardingVettingRequest + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ChinaBusinessOnboardingVettingRequest extends AbstractCrudObject { + static get Fields(): Readonly<{ + ad_account_creation_request_status: "ad_account_creation_request_status"; + ad_account_limit: "ad_account_limit"; + ad_account_number: "ad_account_number"; + ad_accounts_info: "ad_accounts_info"; + business_manager_id: "business_manager_id"; + business_registration: "business_registration"; + business_registration_id: "business_registration_id"; + chinese_address: "chinese_address"; + chinese_legal_entity_name: "chinese_legal_entity_name"; + city: "city"; + contact: "contact"; + coupon_code: "coupon_code"; + disapprove_reason: "disapprove_reason"; + english_business_name: "english_business_name"; + id: "id"; + official_website_url: "official_website_url"; + org_ad_account_count: "org_ad_account_count"; + payment_type: "payment_type"; + planning_agency_id: "planning_agency_id"; + planning_agency_name: "planning_agency_name"; + promotable_app_ids: "promotable_app_ids"; + promotable_page_ids: "promotable_page_ids"; + promotable_pages: "promotable_pages"; + promotable_urls: "promotable_urls"; + request_changes_reason: "request_changes_reason"; + reviewed_user: "reviewed_user"; + spend_limit: "spend_limit"; + status: "status"; + subvertical: "subvertical"; + subvertical_v2: "subvertical_v2"; + supporting_document: "supporting_document"; + time_changes_requested: "time_changes_requested"; + time_created: "time_created"; + time_updated: "time_updated"; + time_zone: "time_zone"; + used_reseller_link: "used_reseller_link"; + user_id: "user_id"; + user_name: "user_name"; + vertical: "vertical"; + vertical_v2: "vertical_v2"; + viewed_by_reseller: "viewed_by_reseller"; + zip_code: "zip_code"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/cloud-game.d.ts b/types/facebook-nodejs-business-sdk/src/objects/cloud-game.d.ts index 7e170b38775f16..bebefff2423a73 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/cloud-game.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/cloud-game.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * CloudGame * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -15,5 +15,5 @@ export default class CloudGame extends AbstractCrudObject { playable_ad_status: "playable_ad_status"; playable_ad_upload_time: "playable_ad_upload_time"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/cloudbridge-dataset-status.d.ts b/types/facebook-nodejs-business-sdk/src/objects/cloudbridge-dataset-status.d.ts new file mode 100644 index 00000000000000..327e4237f05c06 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/cloudbridge-dataset-status.d.ts @@ -0,0 +1,15 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * CloudbridgeDatasetStatus + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class CloudbridgeDatasetStatus extends AbstractCrudObject { + static get Fields(): Readonly<{ + app_redacted_event: "app_redacted_event"; + app_sensitive_params: "app_sensitive_params"; + app_unverified_event: "app_unverified_event"; + has_app_associated: "has_app_associated"; + is_app_prohibited: "is_app_prohibited"; + is_dataset: "is_dataset"; + }>; +} 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 new file mode 100644 index 00000000000000..8f265db27f77b1 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/collaborative-ads-partner-businesses.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * CollaborativeAdsPartnerBusinesses + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class CollaborativeAdsPartnerBusinesses extends AbstractCrudObject { + static get Fields(): Readonly<{ + collaborative_ads_partner_businesses_info: "collaborative_ads_partner_businesses_info"; + dedicated_partner_business_info: "dedicated_partner_business_info"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/collaborative-ads-partner-info-list-item.d.ts b/types/facebook-nodejs-business-sdk/src/objects/collaborative-ads-partner-info-list-item.d.ts index d50b1e1d600432..7e6c2f388b2c9e 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/collaborative-ads-partner-info-list-item.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/collaborative-ads-partner-info-list-item.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * CollaborativeAdsPartnerInfoListItem * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/collaborative-ads-share-settings.d.ts b/types/facebook-nodejs-business-sdk/src/objects/collaborative-ads-share-settings.d.ts index 3f79e1601edbd6..7c139dbce994a0 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/collaborative-ads-share-settings.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/collaborative-ads-share-settings.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * CollaborativeAdsShareSettings * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -12,5 +12,5 @@ export default class CollaborativeAdsShareSettings extends AbstractCrudObject { utm_medium: "utm_medium"; utm_source: "utm_source"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/column-suggestions.d.ts b/types/facebook-nodejs-business-sdk/src/objects/column-suggestions.d.ts new file mode 100644 index 00000000000000..b05534488fad7c --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/column-suggestions.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ColumnSuggestions + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ColumnSuggestions extends AbstractCrudObject { + static get Fields(): Readonly<{ + explanations: "explanations"; + format: "format"; + objective: "objective"; + optimization_goals: "optimization_goals"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/comment.d.ts b/types/facebook-nodejs-business-sdk/src/objects/comment.d.ts index 190d9ed1acc9c2..ba2cd567a30cad 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/comment.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/comment.d.ts @@ -1,6 +1,6 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; +import Cursor from "./../cursor"; /** * Comment * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -31,6 +31,10 @@ export default class Comment extends AbstractCrudObject { private_reply_conversation: "private_reply_conversation"; user_likes: "user_likes"; }>; + static get Order(): Readonly<{ + chronological: "chronological"; + reverse_chronological: "reverse_chronological"; + }>; static get CommentPrivacyValue(): Readonly<{ declined_by_admin_assistant: "DECLINED_BY_ADMIN_ASSISTANT"; default_privacy: "DEFAULT_PRIVACY"; @@ -52,23 +56,13 @@ export default class Comment extends AbstractCrudObject { filter_low_quality: "filter_low_quality"; no_filter: "no_filter"; }>; - static get Order(): Readonly<{ - chronological: "chronological"; - reverse_chronological: "reverse_chronological"; - }>; - getComments(fields: string[], params?: Record): Promise; - getComments(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getComments(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createComment(fields: string[], params?: Record, pathOverride?: string | null): Promise; - deleteLikes(params?: Record): Promise; - getLikes(fields: string[], params?: Record): Promise; - getLikes(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getLikes(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createLike(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getReactions(fields: string[], params?: Record): Promise; - getReactions(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getReactions(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; + getComments(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createComment(fields: string[], params?: Record, pathOverride?: string | null): Promise; + deleteLikes(params?: Record): Promise; + getLikes(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createLike(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getReactions(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/commerce-merchant-settings-setup-status.d.ts b/types/facebook-nodejs-business-sdk/src/objects/commerce-merchant-settings-setup-status.d.ts index 036de1afcd316c..9f50c8dd541d5d 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/commerce-merchant-settings-setup-status.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/commerce-merchant-settings-setup-status.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * CommerceMerchantSettingsSetupStatus * @see {@link https://developers.facebook.com/docs/marketing-api/} 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 6425de1b934975..5c9d4b27b7f1b9 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 @@ -1,77 +1,39 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; +import Cursor from "./../cursor"; /** * CommerceMerchantSettings * @see {@link https://developers.facebook.com/docs/marketing-api/} */ export default class CommerceMerchantSettings extends AbstractCrudObject { static get Fields(): Readonly<{ - braintree_merchant_id: "braintree_merchant_id"; checkout_message: "checkout_message"; contact_email: "contact_email"; cta: "cta"; - disable_checkout_urls: "disable_checkout_urls"; display_name: "display_name"; - external_merchant_id: "external_merchant_id"; facebook_channel: "facebook_channel"; - feature_eligibility: "feature_eligibility"; - has_discount_code: "has_discount_code"; - has_onsite_intent: "has_onsite_intent"; id: "id"; instagram_channel: "instagram_channel"; - merchant_alert_email: "merchant_alert_email"; merchant_page: "merchant_page"; merchant_status: "merchant_status"; onsite_commerce_merchant: "onsite_commerce_merchant"; payment_provider: "payment_provider"; - privacy_url_by_locale: "privacy_url_by_locale"; review_rejection_messages: "review_rejection_messages"; review_rejection_reasons: "review_rejection_reasons"; - supported_card_types: "supported_card_types"; terms: "terms"; - terms_url_by_locale: "terms_url_by_locale"; - whatsapp_channel: "whatsapp_channel"; }>; - createAcknowledgeOrder(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getCommerceOrders(fields: string[], params?: Record): Promise; - getCommerceOrders(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCommerceOrders(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getCommercePayouts(fields: string[], params?: Record): Promise; - getCommercePayouts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCommercePayouts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getCommerceTransactions(fields: string[], params?: Record): Promise; - getCommerceTransactions(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCommerceTransactions(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getOnsiteConversionEvents(fields: string[], params?: Record): Promise; - getOnsiteConversionEvents(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getOnsiteConversionEvents(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getOrderManagementApps(fields: string[], params?: Record): Promise; - getOrderManagementApps(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getOrderManagementApps(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createOrderManagementApp(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getProductCatalogs(fields: string[], params?: Record): Promise; - getProductCatalogs(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getProductCatalogs(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getReturns(fields: string[], params?: Record): Promise; - getReturns(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getReturns(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getSellerIssues(fields: string[], params?: Record): Promise; - getSellerIssues(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getSellerIssues(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getSetupStatus(fields: string[], params?: Record): Promise; - getSetupStatus(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getSetupStatus(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getShippingProfiles(fields: string[], params?: Record): Promise; - getShippingProfiles(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getShippingProfiles(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createShippingProfile(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getShops(fields: string[], params?: Record): Promise; - getShops(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getShops(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getTaxSettings(fields: string[], params?: Record): Promise; - getTaxSettings(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getTaxSettings(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createWhatsappChannel(fields: string[], params?: Record, pathOverride?: string | null): Promise; - get(fields: string[], params?: Record): Promise; + createAcknowledgeOrder(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getCommerceOrders(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getCommercePayouts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getCommerceTransactions(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getOrderMAnAgeMEntApps(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createOrderMAnAgeMEntApp(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getProductCatalogs(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getReturns(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getSetupStatus(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getShippingProfiles(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createShippingProfile(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getShops(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getTaxSettings(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/commerce-order-transaction-detail.d.ts b/types/facebook-nodejs-business-sdk/src/objects/commerce-order-transaction-detail.d.ts index 5d7d0c7eedcc22..420eec79f41e77 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/commerce-order-transaction-detail.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/commerce-order-transaction-detail.d.ts @@ -1,5 +1,5 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; /** * CommerceOrderTransactionDetail * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -16,10 +16,6 @@ export default class CommerceOrderTransactionDetail extends AbstractCrudObject { transfer_id: "transfer_id"; id: "id"; }>; - getItems(fields: string[], params?: Record): Promise; - getItems(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getItems(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getTaxDetails(fields: string[], params?: Record): Promise; - getTaxDetails(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getTaxDetails(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getItems(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getTaxDetails(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/commerce-order.d.ts b/types/facebook-nodejs-business-sdk/src/objects/commerce-order.d.ts index 589600d1825f6b..87278545b5fb74 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/commerce-order.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/commerce-order.d.ts @@ -1,5 +1,5 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; /** * CommerceOrder * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -8,6 +8,7 @@ export default class CommerceOrder extends AbstractCrudObject { static get Fields(): Readonly<{ buyer_details: "buyer_details"; channel: "channel"; + contains_bopis_items: "contains_bopis_items"; created: "created"; estimated_payment_details: "estimated_payment_details"; id: "id"; @@ -47,36 +48,21 @@ export default class CommerceOrder extends AbstractCrudObject { refund_sfi_real: "REFUND_SFI_REAL"; wrong_item: "WRONG_ITEM"; }>; - createAcknowledgeOrder(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getCancellations(fields: string[], params?: Record): Promise; - getCancellations(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCancellations(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createCancellation(fields: string[], params?: Record, pathOverride?: string | null): Promise; - createFulfillOrder(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getItems(fields: string[], params?: Record): Promise; - getItems(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getItems(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getPayments(fields: string[], params?: Record): Promise; - getPayments(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPayments(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getPromotionDetails(fields: string[], params?: Record): Promise; - getPromotionDetails(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPromotionDetails(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getPromotions(fields: string[], params?: Record): Promise; - getPromotions(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPromotions(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getRefunds(fields: string[], params?: Record): Promise; - getRefunds(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getRefunds(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createRefund(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getReturns(fields: string[], params?: Record): Promise; - getReturns(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getReturns(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createReturn(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getShipments(fields: string[], params?: Record): Promise; - getShipments(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getShipments(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createShipment(fields: string[], params?: Record, pathOverride?: string | null): Promise; - createUpdateShipment(fields: string[], params?: Record, pathOverride?: string | null): Promise; - get(fields: string[], params?: Record): Promise; + createAcknowledgeOrder(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getCancellations(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createCanCellATIOn(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createItemUpdate(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getItems(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getPayments(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getPromotionDetails(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getPromoTIOns(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getRefunds(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createRefund(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getReturns(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createReturn(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getShipments(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createShipment(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createUpdateShipment(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createUpdate(fields: string[], params?: Record, pathOverride?: string | null): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/commerce-payout.d.ts b/types/facebook-nodejs-business-sdk/src/objects/commerce-payout.d.ts index 4af2b3715466e2..030e5cd7f915f7 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/commerce-payout.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/commerce-payout.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * CommercePayout * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/commerce-settings.d.ts b/types/facebook-nodejs-business-sdk/src/objects/commerce-settings.d.ts index 0ce1aeee0d8648..b17147bea63e71 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/commerce-settings.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/commerce-settings.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * CommerceSettings * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/connections-targeting.d.ts b/types/facebook-nodejs-business-sdk/src/objects/connections-targeting.d.ts index a2f3be12b54219..80fd1d36f3c353 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/connections-targeting.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/connections-targeting.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ConnectionsTargeting * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/contacts-messenger-sync-config.d.ts b/types/facebook-nodejs-business-sdk/src/objects/contacts-messenger-sync-config.d.ts new file mode 100644 index 00000000000000..5bf1c7f19b71df --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/contacts-messenger-sync-config.d.ts @@ -0,0 +1,10 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ContactsMessengerSyncConfig + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ContactsMessengerSyncConfig extends AbstractCrudObject { + static get Fields(): Readonly<{ + enabled: "enabled"; + }>; +} 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 new file mode 100644 index 00000000000000..67d58404f620bf --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/content-delivery-report.d.ts @@ -0,0 +1,14 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ContentDeliveryReport + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +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"; + estimated_impressions: "estimated_impressions"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/content-publishing-limit-response.d.ts b/types/facebook-nodejs-business-sdk/src/objects/content-publishing-limit-response.d.ts index 4c1789d0346e49..d203225c9791a7 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/content-publishing-limit-response.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/content-publishing-limit-response.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ContentPublishingLimitResponse * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/contextual-bundling-spec.d.ts b/types/facebook-nodejs-business-sdk/src/objects/contextual-bundling-spec.d.ts index 3fcea3723e8232..9654b870081c44 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/contextual-bundling-spec.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/contextual-bundling-spec.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ContextualBundlingSpec * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/conversion-action-query.d.ts b/types/facebook-nodejs-business-sdk/src/objects/conversion-action-query.d.ts index 49bf29579dfda3..f74cd6d08ca914 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/conversion-action-query.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/conversion-action-query.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ConversionActionQuery * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/conversion-health-kpi.d.ts b/types/facebook-nodejs-business-sdk/src/objects/conversion-health-kpi.d.ts new file mode 100644 index 00000000000000..3d8b120f06ac23 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/conversion-health-kpi.d.ts @@ -0,0 +1,18 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ConversionHealthKPI + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ConversionHealthKPI extends AbstractCrudObject { + static get Fields(): Readonly<{ + health_indicator: "health_indicator"; + impacted_browsers_match_rate: "impacted_browsers_match_rate"; + impacted_browsers_match_rate_mom_trend: "impacted_browsers_match_rate_mom_trend"; + impacted_browsers_traffic_share: "impacted_browsers_traffic_share"; + impacted_browsers_traffic_share_mom_trend: "impacted_browsers_traffic_share_mom_trend"; + match_rate: "match_rate"; + match_rate_mom_trend: "match_rate_mom_trend"; + match_rate_vertical_benchmark: "match_rate_vertical_benchmark"; + match_rate_vs_benchmark_mom_trend: "match_rate_vs_benchmark_mom_trend"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/copyright-attribution-insights.d.ts b/types/facebook-nodejs-business-sdk/src/objects/copyright-attribution-insights.d.ts new file mode 100644 index 00000000000000..406c2a00758bf1 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/copyright-attribution-insights.d.ts @@ -0,0 +1,14 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * CopyrightAttributionInsights + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class CopyrightAttributionInsights extends AbstractCrudObject { + static get Fields(): Readonly<{ + l7_attribution_page_view: "l7_attribution_page_view"; + l7_attribution_page_view_delta: "l7_attribution_page_view_delta"; + l7_attribution_video_view: "l7_attribution_video_view"; + l7_attribution_video_view_delta: "l7_attribution_video_view_delta"; + metrics_ending_date: "metrics_ending_date"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/copyright-audio-asset.d.ts b/types/facebook-nodejs-business-sdk/src/objects/copyright-audio-asset.d.ts new file mode 100644 index 00000000000000..b25f75dcb83713 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/copyright-audio-asset.d.ts @@ -0,0 +1,16 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * CopyrightAudioAsset + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class CopyrightAudioAsset extends AbstractCrudObject { + static get Fields(): Readonly<{ + audio_availability_status: "audio_availability_status"; + audio_library_policy: "audio_library_policy"; + creation_time: "creation_time"; + id: "id"; + reference_files: "reference_files"; + title: "title"; + update_time: "update_time"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/copyright-media-misuse.d.ts b/types/facebook-nodejs-business-sdk/src/objects/copyright-media-misuse.d.ts new file mode 100644 index 00000000000000..176ccf3764238a --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/copyright-media-misuse.d.ts @@ -0,0 +1,27 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * CopyrightMediaMisuse + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class CopyrightMediaMisuse extends AbstractCrudObject { + static get Fields(): Readonly<{ + audio_segments: "audio_segments"; + creation_time: "creation_time"; + disabled_audio_segments: "disabled_audio_segments"; + disabled_video_segments: "disabled_video_segments"; + entire_file_issue: "entire_file_issue"; + entire_file_issue_reasons: "entire_file_issue_reasons"; + expiration_time: "expiration_time"; + id: "id"; + media_asset_id: "media_asset_id"; + reasons: "reasons"; + requested_audio_segments: "requested_audio_segments"; + requested_video_segments: "requested_video_segments"; + resolution_type: "resolution_type"; + status: "status"; + update_time: "update_time"; + video_copyright: "video_copyright"; + video_segments: "video_segments"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/copyright-reference-container.d.ts b/types/facebook-nodejs-business-sdk/src/objects/copyright-reference-container.d.ts index ee23386d22edcd..f6cc3940e74d40 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/copyright-reference-container.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/copyright-reference-container.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * CopyrightReferenceContainer * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/cover-photo.d.ts b/types/facebook-nodejs-business-sdk/src/objects/cover-photo.d.ts index f72e79a579b1ec..4b9c7e5ae7ac1c 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/cover-photo.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/cover-photo.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * CoverPhoto * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/cpas-ad-creation-template.d.ts b/types/facebook-nodejs-business-sdk/src/objects/cpas-ad-creation-template.d.ts new file mode 100644 index 00000000000000..6aeac8fd683408 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/cpas-ad-creation-template.d.ts @@ -0,0 +1,17 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * CPASAdCreationTemplate + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class CPASAdCreationTemplate extends AbstractCrudObject { + static get Fields(): Readonly<{ + description: "description"; + id: "id"; + is_unused_template: "is_unused_template"; + name: "name"; + optimization_goal: "optimization_goal"; + targeting_type: "targeting_type"; + template_type: "template_type"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/cpas-advertiser-partnership-recommendation.d.ts b/types/facebook-nodejs-business-sdk/src/objects/cpas-advertiser-partnership-recommendation.d.ts index ccd711f08131b6..10e8794179da97 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/cpas-advertiser-partnership-recommendation.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/cpas-advertiser-partnership-recommendation.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * CPASAdvertiserPartnershipRecommendation * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -15,5 +15,5 @@ export default class CPASAdvertiserPartnershipRecommendation extends AbstractCru status: "status"; status_reason: "status_reason"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/cpas-business-setup-config.d.ts b/types/facebook-nodejs-business-sdk/src/objects/cpas-business-setup-config.d.ts index 3de621604b0ab8..698d4fd62ab5e5 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/cpas-business-setup-config.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/cpas-business-setup-config.d.ts @@ -1,5 +1,5 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; /** * CPASBusinessSetupConfig * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -12,8 +12,6 @@ export default class CPASBusinessSetupConfig extends AbstractCrudObject { capabilities_compliance_status: "capabilities_compliance_status"; id: "id"; }>; - getAdAccounts(fields: string[], params?: Record): Promise; - getAdAccounts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - get(fields: string[], params?: Record): Promise; + getAdAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/cpas-collaboration-request.d.ts b/types/facebook-nodejs-business-sdk/src/objects/cpas-collaboration-request.d.ts index 9d5a18362c55e1..9384a5e9a3f414 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/cpas-collaboration-request.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/cpas-collaboration-request.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * CPASCollaborationRequest * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -21,5 +21,5 @@ export default class CPASCollaborationRequest extends AbstractCrudObject { brand: "BRAND"; merchant: "MERCHANT"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/cpas-lsb-image-bank.d.ts b/types/facebook-nodejs-business-sdk/src/objects/cpas-lsb-image-bank.d.ts new file mode 100644 index 00000000000000..ba6502c033f44d --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/cpas-lsb-image-bank.d.ts @@ -0,0 +1,16 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; +/** + * CPASLsbImageBank + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class CPASLsbImageBank extends AbstractCrudObject { + static get Fields(): Readonly<{ + ad_group_id: "ad_group_id"; + catalog_segment_proxy_id: "catalog_segment_proxy_id"; + id: "id"; + }>; + getBackupImages(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/cpas-merchant-config.d.ts b/types/facebook-nodejs-business-sdk/src/objects/cpas-merchant-config.d.ts index 039a006861f1d6..3eec43dca32b42 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/cpas-merchant-config.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/cpas-merchant-config.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * CPASMerchantConfig * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -13,5 +13,5 @@ export default class CPASMerchantConfig extends AbstractCrudObject { outcomes_compliance_status: "outcomes_compliance_status"; qualified_to_onboard: "qualified_to_onboard"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/cpas-parent-catalog-settings.d.ts b/types/facebook-nodejs-business-sdk/src/objects/cpas-parent-catalog-settings.d.ts new file mode 100644 index 00000000000000..1aa9190e7ed168 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/cpas-parent-catalog-settings.d.ts @@ -0,0 +1,14 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * CPASParentCatalogSettings + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class CPASParentCatalogSettings extends AbstractCrudObject { + static get Fields(): Readonly<{ + attribution_windows: "attribution_windows"; + default_currency: "default_currency"; + disable_use_as_parent_catalog: "disable_use_as_parent_catalog"; + id: "id"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/cpas-setup-catalog-progress.d.ts b/types/facebook-nodejs-business-sdk/src/objects/cpas-setup-catalog-progress.d.ts new file mode 100644 index 00000000000000..95db13c9ff8857 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/cpas-setup-catalog-progress.d.ts @@ -0,0 +1,14 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * CPASSetupCatalogProgress + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class CPASSetupCatalogProgress extends AbstractCrudObject { + static get Fields(): Readonly<{ + child_catalog_count: "child_catalog_count"; + child_catalog_issues: "child_catalog_issues"; + id: "id"; + issues: "issues"; + name: "name"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/cpas-setup-page-structure-progress.d.ts b/types/facebook-nodejs-business-sdk/src/objects/cpas-setup-page-structure-progress.d.ts new file mode 100644 index 00000000000000..3613aa2cea4dac --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/cpas-setup-page-structure-progress.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * CPASSetupPageStructureProgress + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class CPASSetupPageStructureProgress extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + issues: "issues"; + name: "name"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/cpas-setup.d.ts b/types/facebook-nodejs-business-sdk/src/objects/cpas-setup.d.ts new file mode 100644 index 00000000000000..f1beb561f37a8e --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/cpas-setup.d.ts @@ -0,0 +1,8 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * CPASSetup + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class CPASSetup extends AbstractCrudObject { + static get Fields(): Readonly<{}>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/creative-asset-tag.d.ts b/types/facebook-nodejs-business-sdk/src/objects/creative-asset-tag.d.ts new file mode 100644 index 00000000000000..0ff6b3dc22dce6 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/creative-asset-tag.d.ts @@ -0,0 +1,10 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * CreativeAssetTag + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class CreativeAssetTag extends AbstractCrudObject { + static get Fields(): Readonly<{ + name: "name"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/creative-history.d.ts b/types/facebook-nodejs-business-sdk/src/objects/creative-history.d.ts index 533f9f44f0c83e..0a57a2285ef817 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/creative-history.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/creative-history.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * CreativeHistory * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/creator-asset-creative.d.ts b/types/facebook-nodejs-business-sdk/src/objects/creator-asset-creative.d.ts new file mode 100644 index 00000000000000..be89642ab450f3 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/creator-asset-creative.d.ts @@ -0,0 +1,26 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * CreatorAssetCreative + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class CreatorAssetCreative extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + image_url: "image_url"; + moderation_status: "moderation_status"; + product_item_retailer_id: "product_item_retailer_id"; + product_url: "product_url"; + retailer_id: "retailer_id"; + video_url: "video_url"; + }>; + static get ModerationStatus(): Readonly<{ + archived: "ARCHIVED"; + eligible: "ELIGIBLE"; + expired: "EXPIRED"; + ineligible: "INELIGIBLE"; + in_review: "IN_REVIEW"; + paused: "PAUSED"; + unknown: "UNKNOWN"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/credit-card.d.ts b/types/facebook-nodejs-business-sdk/src/objects/credit-card.d.ts index c50348ce8969b5..bd44b5f336bdc5 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/credit-card.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/credit-card.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * CreditCard * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -27,5 +27,5 @@ export default class CreditCard extends AbstractCrudObject { time_created_ts: "time_created_ts"; type: "type"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/credit-partition-action-options.d.ts b/types/facebook-nodejs-business-sdk/src/objects/credit-partition-action-options.d.ts index 9f9e49cd6ba0e7..328ccca0097522 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/credit-partition-action-options.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/credit-partition-action-options.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * CreditPartitionActionOptions * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/crm-address.d.ts b/types/facebook-nodejs-business-sdk/src/objects/crm-address.d.ts index e5ecbe57c4fe21..3fb0ca3305fd0d 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/crm-address.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/crm-address.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * CRMAddress * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -20,5 +20,5 @@ export default class CRMAddress extends AbstractCrudObject { validation_status: "validation_status"; vat_tax_id: "vat_tax_id"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } 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 new file mode 100644 index 00000000000000..4829c1c2d8336d --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ctwa-whats-app-numbers-info.d.ts @@ -0,0 +1,15 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * CTWAWhatsAppNumbersInfo + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class CTWAWhatsAppNumbersInfo extends AbstractCrudObject { + static get Fields(): Readonly<{ + can_manage_wa_flows: "can_manage_wa_flows"; + formatted_whatsapp_number: "formatted_whatsapp_number"; + is_business_number: "is_business_number"; + page_whatsapp_number_id: "page_whatsapp_number_id"; + whatsapp_number: "whatsapp_number"; + whatsapp_smb_device: "whatsapp_smb_device"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ctx-optimization-eligibility.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ctx-optimization-eligibility.d.ts new file mode 100644 index 00000000000000..6196013a5515f1 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ctx-optimization-eligibility.d.ts @@ -0,0 +1,10 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * CTXOptimizationEligibility + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class CTXOptimizationEligibility extends AbstractCrudObject { + static get Fields(): Readonly<{ + ctm: "ctm"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ctx-partner-app-welcome-message-flow.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ctx-partner-app-welcome-message-flow.d.ts index 629c294d325eab..1ff3466eea5ac3 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ctx-partner-app-welcome-message-flow.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ctx-partner-app-welcome-message-flow.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * CTXPartnerAppWelcomeMessageFlow * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -13,5 +13,5 @@ export default class CTXPartnerAppWelcomeMessageFlow extends AbstractCrudObject name: "name"; welcome_message_flow: "welcome_message_flow"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/currency-amount.d.ts b/types/facebook-nodejs-business-sdk/src/objects/currency-amount.d.ts index 18cae60af97d9c..402e7af62ce7f1 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/currency-amount.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/currency-amount.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * CurrencyAmount * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/currency.d.ts b/types/facebook-nodejs-business-sdk/src/objects/currency.d.ts index b0c712ca6f8cad..cc04294980c786 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/currency.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/currency.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * Currency * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/custom-audience-ad-account.d.ts b/types/facebook-nodejs-business-sdk/src/objects/custom-audience-ad-account.d.ts index befe57ed2a4317..07b11f7b25483d 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/custom-audience-ad-account.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/custom-audience-ad-account.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * CustomAudienceAdAccount * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/custom-audience-capabilities.d.ts b/types/facebook-nodejs-business-sdk/src/objects/custom-audience-capabilities.d.ts new file mode 100644 index 00000000000000..c85b217630b0d1 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/custom-audience-capabilities.d.ts @@ -0,0 +1,10 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * CustomAudienceCapabilities + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class CustomAudienceCapabilities extends AbstractCrudObject { + static get Fields(): Readonly<{ + capabilities: "capabilities"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/custom-audience-data-source.d.ts b/types/facebook-nodejs-business-sdk/src/objects/custom-audience-data-source.d.ts index 08748b04637fc9..6ef2976f272e5f 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/custom-audience-data-source.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/custom-audience-data-source.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * CustomAudienceDataSource * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -10,6 +10,7 @@ export default class CustomAudienceDataSource extends AbstractCrudObject { type: "type"; }>; static get SubType(): Readonly<{ + ad_campaign: "AD_CAMPAIGN"; anything: "ANYTHING"; app_users: "APP_USERS"; ar_effects_events: "AR_EFFECTS_EVENTS"; @@ -31,6 +32,7 @@ export default class CustomAudienceDataSource extends AbstractCrudObject { facebook_wifi_events: "FACEBOOK_WIFI_EVENTS"; fb_event_signals: "FB_EVENT_SIGNALS"; fb_pixel_hits: "FB_PIXEL_HITS"; + group_events: "GROUP_EVENTS"; hashes: "HASHES"; hashes_or_user_ids: "HASHES_OR_USER_IDS"; household_expansion: "HOUSEHOLD_EXPANSION"; @@ -39,6 +41,7 @@ export default class CustomAudienceDataSource extends AbstractCrudObject { instant_article_events: "INSTANT_ARTICLE_EVENTS"; lookalike_platform: "LOOKALIKE_PLATFORM"; mail_chimp_email_hashes: "MAIL_CHIMP_EMAIL_HASHES"; + marketplace_listings: "MARKETPLACE_LISTINGS"; messenger_onsite_subscription: "MESSENGER_ONSITE_SUBSCRIPTION"; mobile_advertiser_ids: "MOBILE_ADVERTISER_IDS"; mobile_app_combination_events: "MOBILE_APP_COMBINATION_EVENTS"; @@ -69,6 +72,7 @@ export default class CustomAudienceDataSource extends AbstractCrudObject { web_pixel_combination_events: "WEB_PIXEL_COMBINATION_EVENTS"; web_pixel_hits: "WEB_PIXEL_HITS"; web_pixel_hits_custom_audience_users: "WEB_PIXEL_HITS_CUSTOM_AUDIENCE_USERS"; + whatsapp_subscriber_pool: "WHATSAPP_SUBSCRIBER_POOL"; }>; static get Type(): Readonly<{ contact_importer: "CONTACT_IMPORTER"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/custom-audience-group.d.ts b/types/facebook-nodejs-business-sdk/src/objects/custom-audience-group.d.ts index f1e844b7576cab..2b907b74f5804c 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/custom-audience-group.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/custom-audience-group.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * CustomAudienceGroup * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/custom-audience-salts.d.ts b/types/facebook-nodejs-business-sdk/src/objects/custom-audience-salts.d.ts new file mode 100644 index 00000000000000..79ee4759b8f231 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/custom-audience-salts.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * CustomAudienceSalts + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class CustomAudienceSalts extends AbstractCrudObject { + static get Fields(): Readonly<{ + app_id: "app_id"; + public_key: "public_key"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/custom-audience-session.d.ts b/types/facebook-nodejs-business-sdk/src/objects/custom-audience-session.d.ts index b59923f829c55e..e78d20fc48c855 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/custom-audience-session.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/custom-audience-session.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * CustomAudienceSession * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/custom-audience-shared-account-campaign-info.d.ts b/types/facebook-nodejs-business-sdk/src/objects/custom-audience-shared-account-campaign-info.d.ts new file mode 100644 index 00000000000000..92144fa2031c07 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/custom-audience-shared-account-campaign-info.d.ts @@ -0,0 +1,17 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * CustomAudienceSharedAccountCampaignInfo + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class CustomAudienceSharedAccountCampaignInfo extends AbstractCrudObject { + static get Fields(): Readonly<{ + account_id: "account_id"; + account_name: "account_name"; + adset_excluding_count: "adset_excluding_count"; + adset_including_count: "adset_including_count"; + campaign_delivery_status: "campaign_delivery_status"; + campaign_objective: "campaign_objective"; + campaign_pages: "campaign_pages"; + campaign_schedule: "campaign_schedule"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/custom-audience-sharing-status.d.ts b/types/facebook-nodejs-business-sdk/src/objects/custom-audience-sharing-status.d.ts index e003b3a9eeaf20..9edb1fb1d33dda 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/custom-audience-sharing-status.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/custom-audience-sharing-status.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * CustomAudienceSharingStatus * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/custom-audience-status.d.ts b/types/facebook-nodejs-business-sdk/src/objects/custom-audience-status.d.ts index 4d1ab9e05cbfe7..a0fe4e5c5cf3f8 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/custom-audience-status.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/custom-audience-status.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * CustomAudienceStatus * @see {@link https://developers.facebook.com/docs/marketing-api/} 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 130bacab173bd3..244971889438a2 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 @@ -1,6 +1,6 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; +import Cursor from "./../cursor"; /** * CustomAudience * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -61,11 +61,11 @@ export default class CustomAudience extends AbstractCrudObject { automotive_model: "AUTOMOTIVE_MODEL"; destination: "DESTINATION"; flight: "FLIGHT"; + generic: "GENERIC"; home_listing: "HOME_LISTING"; hotel: "HOTEL"; job: "JOB"; local_service_business: "LOCAL_SERVICE_BUSINESS"; - location_based_item: "LOCATION_BASED_ITEM"; media_title: "MEDIA_TITLE"; offline_product: "OFFLINE_PRODUCT"; product: "PRODUCT"; @@ -84,6 +84,7 @@ export default class CustomAudience extends AbstractCrudObject { claim: "CLAIM"; custom: "CUSTOM"; engagement: "ENGAGEMENT"; + exclusion: "EXCLUSION"; fox: "FOX"; lookalike: "LOOKALIKE"; managed: "MANAGED"; @@ -101,24 +102,18 @@ export default class CustomAudience extends AbstractCrudObject { physical_store: "PHYSICAL_STORE"; website: "WEBSITE"; }>; - deleteAdAccounts(params?: Record): Promise; - getAdAccounts(fields: string[], params?: Record): Promise; - getAdAccounts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createAdAccount(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getAds(fields: string[], params?: Record): Promise; - getAds(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAds(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getSessions(fields: string[], params?: Record): Promise; - getSessions(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getSessions(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getSharedAccountInfo(fields: string[], params?: Record): Promise; - getSharedAccountInfo(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getSharedAccountInfo(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - deleteUsers(params?: Record): Promise; - createUser(fields: string[], params?: Record, pathOverride?: string | null): Promise; - createUsersReplace(fields: string[], params?: Record, pathOverride?: string | null): Promise; - delete(fields: string[], params?: Record): Promise; - get(fields: string[], params?: Record): Promise; - update(fields: string[], params?: Record): Promise; + deleteAdAccounts(params?: Record): Promise; + getAdAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createAdAccount(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getAds(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getSalts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createSalt(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getSessions(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getShareDAccountInfo(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + deleteUsers(params?: Record): Promise; + createUser(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createUsersReplace(fields: string[], params?: Record, pathOverride?: string | null): 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/custom-audiences-tos.d.ts b/types/facebook-nodejs-business-sdk/src/objects/custom-audiences-tos.d.ts index 183556c372751c..c9455b98dbdd9b 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/custom-audiences-tos.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/custom-audiences-tos.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * CustomAudiencesTOS * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/custom-audienceshared-account-info.d.ts b/types/facebook-nodejs-business-sdk/src/objects/custom-audienceshared-account-info.d.ts index 4ec939d08ed630..af729e0454d90e 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/custom-audienceshared-account-info.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/custom-audienceshared-account-info.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * CustomAudiencesharedAccountInfo * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/custom-conversion-activities.d.ts b/types/facebook-nodejs-business-sdk/src/objects/custom-conversion-activities.d.ts new file mode 100644 index 00000000000000..e4ebe34a9d55b4 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/custom-conversion-activities.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * CustomConversionActivities + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class CustomConversionActivities extends AbstractCrudObject { + static get Fields(): Readonly<{ + app_id: "app_id"; + data: "data"; + event_type: "event_type"; + timestamp: "timestamp"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/custom-conversion-stats-result.d.ts b/types/facebook-nodejs-business-sdk/src/objects/custom-conversion-stats-result.d.ts index 9cdc884c089148..c29d4c36a211a4 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/custom-conversion-stats-result.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/custom-conversion-stats-result.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * CustomConversionStatsResult * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/custom-conversion.d.ts b/types/facebook-nodejs-business-sdk/src/objects/custom-conversion.d.ts index a4e6d223c50574..212f633e39eb15 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/custom-conversion.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/custom-conversion.d.ts @@ -1,6 +1,6 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; +import Cursor from "./../cursor"; /** * CustomConversion * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -49,10 +49,19 @@ export default class CustomConversion extends AbstractCrudObject { submit_application: "SUBMIT_APPLICATION"; subscribe: "SUBSCRIBE"; }>; - getStats(fields: string[], params?: Record): Promise; - getStats(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getStats(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; + static get ActionSourceType(): Readonly<{ + app: "app"; + business_messaging: "business_messaging"; + chat: "chat"; + email: "email"; + other: "other"; + phone_call: "phone_call"; + physical_store: "physical_store"; + system_generated: "system_generated"; + website: "website"; + }>; + getStats(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/custom-user-settings.d.ts b/types/facebook-nodejs-business-sdk/src/objects/custom-user-settings.d.ts index 76fcf2e915e6f4..86bec631415e3e 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/custom-user-settings.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/custom-user-settings.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * CustomUserSettings * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/da-check.d.ts b/types/facebook-nodejs-business-sdk/src/objects/da-check.d.ts index 659ffe7a5d0394..e825ec05bcda84 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/da-check.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/da-check.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * DACheck * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/day-part.d.ts b/types/facebook-nodejs-business-sdk/src/objects/day-part.d.ts index 64c2cd57ac791b..ce1b0ccc3179aa 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/day-part.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/day-part.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * DayPart * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/delivery-check-extra-info.d.ts b/types/facebook-nodejs-business-sdk/src/objects/delivery-check-extra-info.d.ts index 5d03d91ba97a4a..a8cf04094e6c81 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/delivery-check-extra-info.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/delivery-check-extra-info.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * DeliveryCheckExtraInfo * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/delivery-check.d.ts b/types/facebook-nodejs-business-sdk/src/objects/delivery-check.d.ts index 05d17f788d9e34..ff54ce56e0624f 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/delivery-check.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/delivery-check.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * DeliveryCheck * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/delivery-info.d.ts b/types/facebook-nodejs-business-sdk/src/objects/delivery-info.d.ts new file mode 100644 index 00000000000000..ebd42a541e15db --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/delivery-info.d.ts @@ -0,0 +1,51 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * DeliveryInfo + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class DeliveryInfo extends AbstractCrudObject { + static get Fields(): Readonly<{ + active_accelerated_campaign_count: "active_accelerated_campaign_count"; + active_day_parted_campaign_count: "active_day_parted_campaign_count"; + ad_penalty_map: "ad_penalty_map"; + are_all_daily_budgets_spent: "are_all_daily_budgets_spent"; + credit_needed_ads_count: "credit_needed_ads_count"; + eligible_for_delivery_insights: "eligible_for_delivery_insights"; + end_time: "end_time"; + has_account_hit_spend_limit: "has_account_hit_spend_limit"; + has_campaign_group_hit_spend_limit: "has_campaign_group_hit_spend_limit"; + has_no_active_ads: "has_no_active_ads"; + has_no_ads: "has_no_ads"; + inactive_ads_count: "inactive_ads_count"; + inactive_campaign_count: "inactive_campaign_count"; + is_account_closed: "is_account_closed"; + is_account_disabled: "is_account_disabled"; + is_ad_uneconomical: "is_ad_uneconomical"; + is_adfarm_penalized: "is_adfarm_penalized"; + is_adgroup_partially_rejected: "is_adgroup_partially_rejected"; + is_campaign_accelerated: "is_campaign_accelerated"; + is_campaign_completed: "is_campaign_completed"; + is_campaign_day_parted: "is_campaign_day_parted"; + is_campaign_disabled: "is_campaign_disabled"; + is_campaign_group_disabled: "is_campaign_group_disabled"; + is_clickbait_penalized: "is_clickbait_penalized"; + is_daily_budget_spent: "is_daily_budget_spent"; + is_engagement_bait_penalized: "is_engagement_bait_penalized"; + is_lqwe_penalized: "is_lqwe_penalized"; + is_reach_and_frequency_misconfigured: "is_reach_and_frequency_misconfigured"; + is_sensationalism_penalized: "is_sensationalism_penalized"; + is_split_test_active: "is_split_test_active"; + is_split_test_valid: "is_split_test_valid"; + lift_study_time_period: "lift_study_time_period"; + needs_credit: "needs_credit"; + needs_tax_number: "needs_tax_number"; + non_deleted_ads_count: "non_deleted_ads_count"; + not_delivering_campaign_count: "not_delivering_campaign_count"; + pending_ads_count: "pending_ads_count"; + reach_frequency_campaign_underdelivery_reason: "reach_frequency_campaign_underdelivery_reason"; + rejected_ads_count: "rejected_ads_count"; + start_time: "start_time"; + status: "status"; + text_penalty_level: "text_penalty_level"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/delivery-status.d.ts b/types/facebook-nodejs-business-sdk/src/objects/delivery-status.d.ts new file mode 100644 index 00000000000000..4c418634396d85 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/delivery-status.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * DeliveryStatus + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class DeliveryStatus extends AbstractCrudObject { + static get Fields(): Readonly<{ + status: "status"; + substatuses: "substatuses"; + }>; +} 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 652ed33f04560c..d783f8889c2444 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 @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * DeliveryWindow * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/destination-catalog-settings.d.ts b/types/facebook-nodejs-business-sdk/src/objects/destination-catalog-settings.d.ts deleted file mode 100644 index d183e0e3406c29..00000000000000 --- a/types/facebook-nodejs-business-sdk/src/objects/destination-catalog-settings.d.ts +++ /dev/null @@ -1,12 +0,0 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -/** - * DestinationCatalogSettings - * @see {@link https://developers.facebook.com/docs/marketing-api/} - */ -export default class DestinationCatalogSettings extends AbstractCrudObject { - static get Fields(): Readonly<{ - generate_items_from_pages: "generate_items_from_pages"; - id: "id"; - }>; - get(fields: string[], params?: Record): Promise; -} diff --git a/types/facebook-nodejs-business-sdk/src/objects/destination.d.ts b/types/facebook-nodejs-business-sdk/src/objects/destination.d.ts index 425cc7658cd9de..af9483ad610754 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/destination.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/destination.d.ts @@ -1,5 +1,5 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; /** * Destination * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -19,6 +19,7 @@ export default class Destination extends AbstractCrudObject { price: "price"; price_change: "price_change"; sanitized_images: "sanitized_images"; + tags: "tags"; types: "types"; unit_price: "unit_price"; url: "url"; @@ -36,14 +37,8 @@ export default class Destination extends AbstractCrudObject { published: "PUBLISHED"; staging: "STAGING"; }>; - getAugmentedRealitiesMetadata(fields: string[], params?: Record): Promise; - getAugmentedRealitiesMetadata(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAugmentedRealitiesMetadata(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getChannelsToIntegrityStatus(fields: string[], params?: Record): Promise; - getChannelsToIntegrityStatus(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getChannelsToIntegrityStatus(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getVideosMetadata(fields: string[], params?: Record): Promise; - getVideosMetadata(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getVideosMetadata(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - get(fields: string[], params?: Record): Promise; + getAugmentedRealitiesMetadata(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getChannelsToIntegrityStatus(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getVideosMetadata(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/direct-debit.d.ts b/types/facebook-nodejs-business-sdk/src/objects/direct-debit.d.ts new file mode 100644 index 00000000000000..de0889025793e4 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/direct-debit.d.ts @@ -0,0 +1,19 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * DirectDebit + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class DirectDebit extends AbstractCrudObject { + static get Fields(): Readonly<{ + bank_account_last_4: "bank_account_last_4"; + bank_code_last_4: "bank_code_last_4"; + bank_name: "bank_name"; + default_receiving_method_products: "default_receiving_method_products"; + display_string: "display_string"; + id: "id"; + last_four_digits: "last_four_digits"; + onboarding_url: "onboarding_url"; + owner_name: "owner_name"; + status: "status"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/dog-notification-settings.d.ts b/types/facebook-nodejs-business-sdk/src/objects/dog-notification-settings.d.ts new file mode 100644 index 00000000000000..d86ed0fbe366cb --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/dog-notification-settings.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * DogNotificationSettings + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class DogNotificationSettings extends AbstractCrudObject { + static get Fields(): Readonly<{ + dog_check_key: "dog_check_key"; + id: "id"; + subscription_status_per_channel: "subscription_status_per_channel"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/domain.d.ts b/types/facebook-nodejs-business-sdk/src/objects/domain.d.ts new file mode 100644 index 00000000000000..3dc3400bfb1edc --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/domain.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * Domain + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class Domain extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + name: "name"; + url: "url"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/draft-post.d.ts b/types/facebook-nodejs-business-sdk/src/objects/draft-post.d.ts new file mode 100644 index 00000000000000..963a2503924c63 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/draft-post.d.ts @@ -0,0 +1,26 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * DraftPost + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class DraftPost extends AbstractCrudObject { + static get Fields(): Readonly<{ + admin_creator: "admin_creator"; + creation_time: "creation_time"; + feed_audience_description: "feed_audience_description"; + feed_targeting: "feed_targeting"; + id: "id"; + is_post_in_good_state: "is_post_in_good_state"; + message: "message"; + modified_time: "modified_time"; + og_action_summary: "og_action_summary"; + permalink_url: "permalink_url"; + place: "place"; + privacy_description: "privacy_description"; + scheduled_failure_notice: "scheduled_failure_notice"; + scheduled_publish_time: "scheduled_publish_time"; + story_token: "story_token"; + thumbnail: "thumbnail"; + video_id: "video_id"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/dynamic-ar-metadata.d.ts b/types/facebook-nodejs-business-sdk/src/objects/dynamic-ar-metadata.d.ts new file mode 100644 index 00000000000000..e5076c968cea73 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/dynamic-ar-metadata.d.ts @@ -0,0 +1,22 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * DynamicARMetadata + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class DynamicARMetadata extends AbstractCrudObject { + static get Fields(): Readonly<{ + anchor_point: "anchor_point"; + container_effect_enum: "container_effect_enum"; + effect_icon_url: "effect_icon_url"; + effect_id: "effect_id"; + id: "id"; + platforms: "platforms"; + scale_factor: "scale_factor"; + shadow_texture_url: "shadow_texture_url"; + source_url: "source_url"; + state: "state"; + tags: "tags"; + variant_picker_url: "variant_picker_url"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/dynamic-content-set.d.ts b/types/facebook-nodejs-business-sdk/src/objects/dynamic-content-set.d.ts new file mode 100644 index 00000000000000..76112252e58b36 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/dynamic-content-set.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * DynamicContentSet + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class DynamicContentSet extends AbstractCrudObject { + static get Fields(): Readonly<{ + business_id: "business_id"; + id: "id"; + name: "name"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/dynamic-item-display-bundle-folder.d.ts b/types/facebook-nodejs-business-sdk/src/objects/dynamic-item-display-bundle-folder.d.ts new file mode 100644 index 00000000000000..0e098d3b0b2afb --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/dynamic-item-display-bundle-folder.d.ts @@ -0,0 +1,16 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * DynamicItemDisplayBundleFolder + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class DynamicItemDisplayBundleFolder extends AbstractCrudObject { + static get Fields(): Readonly<{ + categorization_criteria: "categorization_criteria"; + id: "id"; + name: "name"; + product_catalog: "product_catalog"; + product_set: "product_set"; + valid_labels: "valid_labels"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/dynamic-item-display-bundle.d.ts b/types/facebook-nodejs-business-sdk/src/objects/dynamic-item-display-bundle.d.ts new file mode 100644 index 00000000000000..ae823c21db749e --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/dynamic-item-display-bundle.d.ts @@ -0,0 +1,17 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * DynamicItemDisplayBundle + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class DynamicItemDisplayBundle extends AbstractCrudObject { + static get Fields(): Readonly<{ + additional_urls: "additional_urls"; + description: "description"; + id: "id"; + name: "name"; + product_set: "product_set"; + text_tokens: "text_tokens"; + url: "url"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/dynamic-post-child-attachment.d.ts b/types/facebook-nodejs-business-sdk/src/objects/dynamic-post-child-attachment.d.ts index 64aee59dd19365..8a37415979cffd 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/dynamic-post-child-attachment.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/dynamic-post-child-attachment.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * DynamicPostChildAttachment * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/dynamic-price-config-by-date.d.ts b/types/facebook-nodejs-business-sdk/src/objects/dynamic-price-config-by-date.d.ts index 3ef5c988ae90e1..17a64186f1a2ff 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/dynamic-price-config-by-date.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/dynamic-price-config-by-date.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * DynamicPriceConfigByDate * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -10,5 +10,5 @@ export default class DynamicPriceConfigByDate extends AbstractCrudObject { prices_pretty: "prices_pretty"; id: "id"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/dynamic-video-metadata.d.ts b/types/facebook-nodejs-business-sdk/src/objects/dynamic-video-metadata.d.ts index eefb8dd6b5c145..d8acce3fa1cc71 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/dynamic-video-metadata.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/dynamic-video-metadata.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * DynamicVideoMetadata * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -10,5 +10,5 @@ export default class DynamicVideoMetadata extends AbstractCrudObject { url: "url"; video: "video"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/education-experience.d.ts b/types/facebook-nodejs-business-sdk/src/objects/education-experience.d.ts new file mode 100644 index 00000000000000..26ec6282618d9a --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/education-experience.d.ts @@ -0,0 +1,18 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * EducationExperience + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class EducationExperience extends AbstractCrudObject { + static get Fields(): Readonly<{ + classes: "classes"; + concentration: "concentration"; + degree: "degree"; + id: "id"; + school: "school"; + type: "type"; + with: "with"; + year: "year"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/email-import.d.ts b/types/facebook-nodejs-business-sdk/src/objects/email-import.d.ts new file mode 100644 index 00000000000000..c0f45bf0aa5f59 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/email-import.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * EmailImport + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class EmailImport extends AbstractCrudObject { + static get Fields(): Readonly<{ + lists: "lists"; + total: "total"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/end-study-criteria.d.ts b/types/facebook-nodejs-business-sdk/src/objects/end-study-criteria.d.ts new file mode 100644 index 00000000000000..cdb0bf02599cb7 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/end-study-criteria.d.ts @@ -0,0 +1,8 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * EndStudyCriteria + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class EndStudyCriteria extends AbstractCrudObject { + static get Fields(): Readonly<{}>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/engagement.d.ts b/types/facebook-nodejs-business-sdk/src/objects/engagement.d.ts index 8c0e56c7f21bd9..60e91ba1d6b0c9 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/engagement.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/engagement.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * Engagement * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ent-with-sponsor.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ent-with-sponsor.d.ts new file mode 100644 index 00000000000000..86cd793d7cf83c --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ent-with-sponsor.d.ts @@ -0,0 +1,14 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * EntWithSponsor + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class EntWithSponsor extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + owner_linked_instagram_user_v1_id: "owner_linked_instagram_user_v1_id"; + owner_picture: "owner_picture"; + post_id: "post_id"; + post_info: "post_info"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/entity-at-text-range.d.ts b/types/facebook-nodejs-business-sdk/src/objects/entity-at-text-range.d.ts index d5e28989eb2815..1a6d4d9c60de91 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/entity-at-text-range.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/entity-at-text-range.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * EntityAtTextRange * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/event-external-ticket-info.d.ts b/types/facebook-nodejs-business-sdk/src/objects/event-external-ticket-info.d.ts new file mode 100644 index 00000000000000..6479304b8d33d1 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/event-external-ticket-info.d.ts @@ -0,0 +1,14 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * EventExternalTicketInfo + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class EventExternalTicketInfo extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + max_sales_price: "max_sales_price"; + min_sales_price: "min_sales_price"; + sales_status: "sales_status"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/event-registration-setting.d.ts b/types/facebook-nodejs-business-sdk/src/objects/event-registration-setting.d.ts new file mode 100644 index 00000000000000..c12ba1226590a2 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/event-registration-setting.d.ts @@ -0,0 +1,14 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * EventRegistrationSetting + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class EventRegistrationSetting extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + questions: "questions"; + target_type: "target_type"; + ticket_tier_ids: "ticket_tier_ids"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/event-source-group.d.ts b/types/facebook-nodejs-business-sdk/src/objects/event-source-group.d.ts index 69f8ab6d3eb74e..ce71654a8f9fb8 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/event-source-group.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/event-source-group.d.ts @@ -1,5 +1,5 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; /** * EventSourceGroup * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -12,10 +12,8 @@ export default class EventSourceGroup extends AbstractCrudObject { name: "name"; owner_business: "owner_business"; }>; - getSharedAccounts(fields: string[], params?: Record): Promise; - getSharedAccounts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getSharedAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createSharedAccount(fields: string[], params?: Record, pathOverride?: string | null): Promise; - get(fields: string[], params?: Record): Promise; - update(fields: string[], params?: Record): Promise; + getShareDAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createShareDAccount(fields: string[], params?: Record, pathOverride?: string | null): Promise; + get(fields: string[], params?: Record): Promise; + update(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/event-ticket-setting.d.ts b/types/facebook-nodejs-business-sdk/src/objects/event-ticket-setting.d.ts new file mode 100644 index 00000000000000..85fcd446af2618 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/event-ticket-setting.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * EventTicketSetting + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class EventTicketSetting extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + ticket_delivery_type: "ticket_delivery_type"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/event-ticket-tier.d.ts b/types/facebook-nodejs-business-sdk/src/objects/event-ticket-tier.d.ts new file mode 100644 index 00000000000000..cf523d312f101b --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/event-ticket-tier.d.ts @@ -0,0 +1,28 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * EventTicketTier + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class EventTicketTier extends AbstractCrudObject { + static get Fields(): Readonly<{ + currency: "currency"; + description: "description"; + end_sales_time: "end_sales_time"; + end_show_time: "end_show_time"; + fee_settings: "fee_settings"; + id: "id"; + maximum_quantity: "maximum_quantity"; + metadata: "metadata"; + minimum_quantity: "minimum_quantity"; + name: "name"; + price: "price"; + priority: "priority"; + retailer_id: "retailer_id"; + seating_map_image_url: "seating_map_image_url"; + start_sales_time: "start_sales_time"; + start_show_time: "start_show_time"; + status: "status"; + total_quantity: "total_quantity"; + }>; + get(fields: string[], params?: Record): Promise; +} 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 new file mode 100644 index 00000000000000..ece8b9b93d3e63 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/event-tour.d.ts @@ -0,0 +1,23 @@ +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 9128bcb61ba5b0..5dfdb17bc91dea 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/event.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/event.d.ts @@ -1,6 +1,6 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import Cursor from './../cursor'; -import LiveVideo from './live-video'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; +import LiveVideo from "./live-video"; /** * Event * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -93,33 +93,15 @@ export default class Event extends AbstractCrudObject { past: "past"; upcoming: "upcoming"; }>; - getComments(fields: string[], params?: Record): Promise; - getComments(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getComments(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getFeed(fields: string[], params?: Record): Promise; - getFeed(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getFeed(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getLiveVideos(fields: string[], params?: Record): Promise; - getLiveVideos(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getLiveVideos(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createLiveVideo(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getPhotos(fields: string[], params?: Record): Promise; - getPhotos(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPhotos(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getPicture(fields: string[], params?: Record): Promise; - getPicture(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPicture(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getPosts(fields: string[], params?: Record): Promise; - getPosts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPosts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getRoles(fields: string[], params?: Record): Promise; - getRoles(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getRoles(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getTicketTiers(fields: string[], params?: Record): Promise; - getTicketTiers(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getTicketTiers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getVideos(fields: string[], params?: Record): Promise; - getVideos(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getVideos(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - get(fields: string[], params?: Record): Promise; + getComments(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getFeed(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getLiveVideos(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createLiveVideo(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getPhotos(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getPicture(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getPosts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getRoles(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getTicketTiers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getVideos(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/experience.d.ts b/types/facebook-nodejs-business-sdk/src/objects/experience.d.ts index c7e2645b5a4120..79262dfc8d8b9a 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/experience.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/experience.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * Experience * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/expirable-post.d.ts b/types/facebook-nodejs-business-sdk/src/objects/expirable-post.d.ts new file mode 100644 index 00000000000000..e1573653149fb3 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/expirable-post.d.ts @@ -0,0 +1,29 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ExpirablePost + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ExpirablePost extends AbstractCrudObject { + static get Fields(): Readonly<{ + admin_creator: "admin_creator"; + can_republish: "can_republish"; + content_type: "content_type"; + creation_time: "creation_time"; + expiration: "expiration"; + feed_audience_description: "feed_audience_description"; + feed_targeting: "feed_targeting"; + id: "id"; + is_post_in_good_state: "is_post_in_good_state"; + message: "message"; + modified_time: "modified_time"; + og_action_summary: "og_action_summary"; + permalink_url: "permalink_url"; + place: "place"; + privacy_description: "privacy_description"; + scheduled_failure_notice: "scheduled_failure_notice"; + scheduled_publish_time: "scheduled_publish_time"; + story_token: "story_token"; + thumbnail: "thumbnail"; + video_id: "video_id"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/extended-credit-allocation-config.d.ts b/types/facebook-nodejs-business-sdk/src/objects/extended-credit-allocation-config.d.ts index 38d3fe64ed8fc9..d276bacc605d6d 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/extended-credit-allocation-config.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/extended-credit-allocation-config.d.ts @@ -1,5 +1,5 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; /** * ExtendedCreditAllocationConfig * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -31,7 +31,7 @@ export default class ExtendedCreditAllocationConfig extends AbstractCrudObject { advertiser: "Advertiser"; agency: "Agency"; }>; - delete(fields: string[], params?: Record): Promise; - get(fields: string[], params?: Record): Promise; - update(fields: string[], params?: Record): 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/extended-credit-application.d.ts b/types/facebook-nodejs-business-sdk/src/objects/extended-credit-application.d.ts new file mode 100644 index 00000000000000..910cd72e8c382d --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/extended-credit-application.d.ts @@ -0,0 +1,35 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ExtendedCreditApplication + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ExtendedCreditApplication extends AbstractCrudObject { + static get Fields(): Readonly<{ + billing_country: "billing_country"; + city: "city"; + cnpj: "cnpj"; + country: "country"; + display_currency: "display_currency"; + duns_number: "duns_number"; + id: "id"; + invoice_email_address: "invoice_email_address"; + is_umi: "is_umi"; + legal_entity_name: "legal_entity_name"; + original_online_limit: "original_online_limit"; + phone_number: "phone_number"; + postal_code: "postal_code"; + product_types: "product_types"; + proposed_credit_limit: "proposed_credit_limit"; + registration_number: "registration_number"; + run_id: "run_id"; + state: "state"; + status: "status"; + street1: "street1"; + street2: "street2"; + submitter: "submitter"; + tax_exempt_status: "tax_exempt_status"; + tax_id: "tax_id"; + terms: "terms"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/extended-credit-email.d.ts b/types/facebook-nodejs-business-sdk/src/objects/extended-credit-email.d.ts new file mode 100644 index 00000000000000..765c8b9bd73049 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/extended-credit-email.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ExtendedCreditEmail + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ExtendedCreditEmail extends AbstractCrudObject { + static get Fields(): Readonly<{ + email: "email"; + id: "id"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/extended-credit-info.d.ts b/types/facebook-nodejs-business-sdk/src/objects/extended-credit-info.d.ts new file mode 100644 index 00000000000000..16ecfa91d8e5a7 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/extended-credit-info.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ExtendedCreditInfo + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ExtendedCreditInfo extends AbstractCrudObject { + static get Fields(): Readonly<{ + credit_left: "credit_left"; + credit_revoked: "credit_revoked"; + credit_used: "credit_used"; + using_biz_ec: "using_biz_ec"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/extended-credit-invoice-group.d.ts b/types/facebook-nodejs-business-sdk/src/objects/extended-credit-invoice-group.d.ts index 513dafda98e7ef..a0f6617a2d12ca 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/extended-credit-invoice-group.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/extended-credit-invoice-group.d.ts @@ -1,7 +1,7 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; -import Cursor from './../cursor'; -import AdAccount from './ad-account'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; +import Cursor from "./../cursor"; +import AdAccount from "./ad-account"; /** * ExtendedCreditInvoiceGroup * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -18,12 +18,10 @@ export default class ExtendedCreditInvoiceGroup extends AbstractCrudObject { name: "name"; sold_to_address: "sold_to_address"; }>; - deleteAdAccounts(params?: Record): Promise; - getAdAccounts(fields: string[], params?: Record): Promise; - getAdAccounts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createAdAccount(fields: string[], params?: Record, pathOverride?: string | null): Promise; - delete(fields: string[], params?: Record): Promise; - get(fields: string[], params?: Record): Promise; - update(fields: string[], params?: Record): Promise; + deleteAdAccounts(params?: Record): Promise; + getAdAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createAdAccount(fields: string[], params?: Record, pathOverride?: string | null): 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/extended-credit.d.ts b/types/facebook-nodejs-business-sdk/src/objects/extended-credit.d.ts index 1b13056751a7c1..28dc1b1127f2ab 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/extended-credit.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/extended-credit.d.ts @@ -1,8 +1,8 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; -import Cursor from './../cursor'; -import ExtendedCreditInvoiceGroup from './extended-credit-invoice-group'; -import ExtendedCreditAllocationConfig from './extended-credit-allocation-config'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; +import Cursor from "./../cursor"; +import ExtendedCreditInvoiceGroup from "./extended-credit-invoice-group"; +import ExtendedCreditAllocationConfig from "./extended-credit-allocation-config"; /** * ExtendedCredit * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -29,14 +29,10 @@ export default class ExtendedCredit extends AbstractCrudObject { send_bill_to_biz_name: "send_bill_to_biz_name"; sold_to_address: "sold_to_address"; }>; - getExtendedCreditInvoiceGroups(fields: string[], params?: Record): Promise; - getExtendedCreditInvoiceGroups(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getExtendedCreditInvoiceGroups(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createExtendedCreditInvoiceGroup(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getOwningCreditAllocationConfigs(fields: string[], params?: Record): Promise; - getOwningCreditAllocationConfigs(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getOwningCreditAllocationConfigs(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createOwningCreditAllocationConfig(fields: string[], params?: Record, pathOverride?: string | null): Promise; - createWhatsappCreditSharingAndAttach(fields: string[], params?: Record, pathOverride?: string | null): Promise; - get(fields: string[], params?: Record): Promise; + getExtendedCreditInvoiceGroups(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createExtendedCreditInvoiceGroup(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getOwningCreditAllocationConfigs(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createOwningCreditAllocationConfig(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createWhatsAppCreditSharingAnDAttach(fields: string[], params?: Record, pathOverride?: string | null): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/external-event-source-cpas-events-debugging-info.d.ts b/types/facebook-nodejs-business-sdk/src/objects/external-event-source-cpas-events-debugging-info.d.ts new file mode 100644 index 00000000000000..678c4acb02286b --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/external-event-source-cpas-events-debugging-info.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ExternalEventSourceCPASEventsDebuggingInfo + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ExternalEventSourceCPASEventsDebuggingInfo extends AbstractCrudObject { + static get Fields(): Readonly<{ + counts: "counts"; + diagnostic: "diagnostic"; + event_name: "event_name"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/external-event-source-cpas-events-debugging.d.ts b/types/facebook-nodejs-business-sdk/src/objects/external-event-source-cpas-events-debugging.d.ts new file mode 100644 index 00000000000000..b0023bb246a224 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/external-event-source-cpas-events-debugging.d.ts @@ -0,0 +1,18 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ExternalEventSourceCPASEventsDebugging + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ExternalEventSourceCPASEventsDebugging extends AbstractCrudObject { + static get Fields(): Readonly<{ + actual_event_time: "actual_event_time"; + app_version: "app_version"; + content_url: "content_url"; + device_os: "device_os"; + diagnostic: "diagnostic"; + event_name: "event_name"; + event_time: "event_time"; + missing_ids: "missing_ids"; + severity: "severity"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/external-event-source-da-stats-result.d.ts b/types/facebook-nodejs-business-sdk/src/objects/external-event-source-da-stats-result.d.ts new file mode 100644 index 00000000000000..d567bd448739b9 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/external-event-source-da-stats-result.d.ts @@ -0,0 +1,15 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ExternalEventSourceDAStatsResult + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ExternalEventSourceDAStatsResult extends AbstractCrudObject { + static get Fields(): Readonly<{ + count_content_ids: "count_content_ids"; + count_content_ids_match_any_catalog: "count_content_ids_match_any_catalog"; + count_fires: "count_fires"; + count_fires_match_any_catalog: "count_fires_match_any_catalog"; + date: "date"; + percentage_missed_users: "percentage_missed_users"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/external-event-source.d.ts b/types/facebook-nodejs-business-sdk/src/objects/external-event-source.d.ts index 6b80991a48ec3d..b1b65d6857a753 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/external-event-source.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/external-event-source.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ExternalEventSource * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/external-merchant-settings.d.ts b/types/facebook-nodejs-business-sdk/src/objects/external-merchant-settings.d.ts new file mode 100644 index 00000000000000..49da332d0bb1c2 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/external-merchant-settings.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ExternalMerchantSettings + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ExternalMerchantSettings extends AbstractCrudObject { + static get Fields(): Readonly<{ + connect_woo: "connect_woo"; + external_platform: "external_platform"; + id: "id"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/fame-export-config.d.ts b/types/facebook-nodejs-business-sdk/src/objects/fame-export-config.d.ts deleted file mode 100644 index d9d559a3fc5853..00000000000000 --- a/types/facebook-nodejs-business-sdk/src/objects/fame-export-config.d.ts +++ /dev/null @@ -1,13 +0,0 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -/** - * FAMEExportConfig - * @see {@link https://developers.facebook.com/docs/marketing-api/} - */ -export default class FAMEExportConfig extends AbstractCrudObject { - static get Fields(): Readonly<{ - can_edit: "can_edit"; - column_id: "column_id"; - display_name: "display_name"; - format: "format"; - }>; -} diff --git a/types/facebook-nodejs-business-sdk/src/objects/fame-kumo.d.ts b/types/facebook-nodejs-business-sdk/src/objects/fame-kumo.d.ts new file mode 100644 index 00000000000000..f591c1799d7a93 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/fame-kumo.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * FAMEKumo + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class FAMEKumo extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/fantasy-game.d.ts b/types/facebook-nodejs-business-sdk/src/objects/fantasy-game.d.ts new file mode 100644 index 00000000000000..362238ee02e0dd --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/fantasy-game.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * FantasyGame + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class FantasyGame extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + name: "name"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/favorite-catalog.d.ts b/types/facebook-nodejs-business-sdk/src/objects/favorite-catalog.d.ts new file mode 100644 index 00000000000000..f17cdd02243f01 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/favorite-catalog.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * FavoriteCatalog + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class FavoriteCatalog extends AbstractCrudObject { + static get Fields(): Readonly<{ + catalog: "catalog"; + id: "id"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/fb-image-copyright-match.d.ts b/types/facebook-nodejs-business-sdk/src/objects/fb-image-copyright-match.d.ts new file mode 100644 index 00000000000000..7c8e672fe9dbf6 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/fb-image-copyright-match.d.ts @@ -0,0 +1,23 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * FBImageCopyrightMatch + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class FBImageCopyrightMatch extends AbstractCrudObject { + static get Fields(): Readonly<{ + added_to_dashboard_time: "added_to_dashboard_time"; + applied_actions: "applied_actions"; + audit_log: "audit_log"; + available_ui_actions: "available_ui_actions"; + expiration_days: "expiration_days"; + id: "id"; + is_business_page_match: "is_business_page_match"; + last_modified_time: "last_modified_time"; + match_data: "match_data"; + match_status: "match_status"; + ownership_countries: "ownership_countries"; + reference_owner: "reference_owner"; + time_to_appeal: "time_to_appeal"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/fb-lite-to-nt-transitions.d.ts b/types/facebook-nodejs-business-sdk/src/objects/fb-lite-to-nt-transitions.d.ts new file mode 100644 index 00000000000000..7760cdc92e0db7 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/fb-lite-to-nt-transitions.d.ts @@ -0,0 +1,10 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * FBLiteToNTTransitions + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class FBLiteToNTTransitions extends AbstractCrudObject { + static get Fields(): Readonly<{ + transition: "transition"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/fb-page-and-instagram-account.d.ts b/types/facebook-nodejs-business-sdk/src/objects/fb-page-and-instagram-account.d.ts new file mode 100644 index 00000000000000..1bf6f30a616d97 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/fb-page-and-instagram-account.d.ts @@ -0,0 +1,14 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * FBPageAndInstagramAccount + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class FBPageAndInstagramAccount extends AbstractCrudObject { + static get Fields(): Readonly<{ + ad_permissions: "ad_permissions"; + bc_permission_status: "bc_permission_status"; + bc_permissions: "bc_permissions"; + is_managed: "is_managed"; + matched_by: "matched_by"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/fb-pay-button-login.d.ts b/types/facebook-nodejs-business-sdk/src/objects/fb-pay-button-login.d.ts new file mode 100644 index 00000000000000..5cada11816d168 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/fb-pay-button-login.d.ts @@ -0,0 +1,8 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * FBPayButtonLogin + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class FBPayButtonLogin extends AbstractCrudObject { + static get Fields(): Readonly<{}>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/finance-object.d.ts b/types/facebook-nodejs-business-sdk/src/objects/finance-object.d.ts new file mode 100644 index 00000000000000..f3b2853a8f838f --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/finance-object.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * FinanceObject + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class FinanceObject extends AbstractCrudObject { + static get Fields(): Readonly<{ + finance_permission: "finance_permission"; + user: "user"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/flexible-targeting.d.ts b/types/facebook-nodejs-business-sdk/src/objects/flexible-targeting.d.ts index 1161228b6f7126..2725ab27ffe0fd 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/flexible-targeting.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/flexible-targeting.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * FlexibleTargeting * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/flight.d.ts b/types/facebook-nodejs-business-sdk/src/objects/flight.d.ts index 49ec28f38ab51d..0221641ca2dc2f 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/flight.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/flight.d.ts @@ -1,5 +1,5 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; /** * Flight * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -22,6 +22,7 @@ export default class Flight extends AbstractCrudObject { origin_city: "origin_city"; price: "price"; sanitized_images: "sanitized_images"; + tags: "tags"; unit_price: "unit_price"; url: "url"; visibility: "visibility"; @@ -38,15 +39,9 @@ export default class Flight extends AbstractCrudObject { published: "PUBLISHED"; staging: "STAGING"; }>; - getAugmentedRealitiesMetadata(fields: string[], params?: Record): Promise; - getAugmentedRealitiesMetadata(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAugmentedRealitiesMetadata(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getChannelsToIntegrityStatus(fields: string[], params?: Record): Promise; - getChannelsToIntegrityStatus(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getChannelsToIntegrityStatus(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getVideosMetadata(fields: string[], params?: Record): Promise; - getVideosMetadata(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getVideosMetadata(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - get(fields: string[], params?: Record): Promise; - update(fields: string[], params?: Record): Promise; + getAugmentedRealitiesMetadata(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getChannelsToIntegrityStatus(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getVideosMetadata(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/franchise-program-member.d.ts b/types/facebook-nodejs-business-sdk/src/objects/franchise-program-member.d.ts new file mode 100644 index 00000000000000..6c41000da2cab7 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/franchise-program-member.d.ts @@ -0,0 +1,18 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * FranchiseProgramMember + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class FranchiseProgramMember extends AbstractCrudObject { + static get Fields(): Readonly<{ + business: "business"; + end_date: "end_date"; + id: "id"; + join_date: "join_date"; + member_ad_account: "member_ad_account"; + member_user: "member_user"; + membership_status: "membership_status"; + page: "page"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/franchise-program.d.ts b/types/facebook-nodejs-business-sdk/src/objects/franchise-program.d.ts new file mode 100644 index 00000000000000..e8bd80f534cc86 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/franchise-program.d.ts @@ -0,0 +1,22 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * FranchiseProgram + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class FranchiseProgram extends AbstractCrudObject { + static get Fields(): Readonly<{ + business_asset_group: "business_asset_group"; + creator_business: "creator_business"; + description: "description"; + end_date: "end_date"; + id: "id"; + name: "name"; + program_access_type: "program_access_type"; + program_approval_type: "program_approval_type"; + program_image_link: "program_image_link"; + program_url: "program_url"; + shared_custom_audience: "shared_custom_audience"; + start_date: "start_date"; + }>; + get(fields: string[], params?: Record): Promise; +} 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 b857ca9331bf85..218aa792d5b930 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 @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * FundingSourceDetailsCoupon * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -6,6 +6,7 @@ import { AbstractCrudObject } from './../abstract-crud-object'; export default class FundingSourceDetailsCoupon extends AbstractCrudObject { static get Fields(): Readonly<{ amount: "amount"; + campaign_ids: "campaign_ids"; currency: "currency"; display_amount: "display_amount"; expiration: "expiration"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/funding-source-details.d.ts b/types/facebook-nodejs-business-sdk/src/objects/funding-source-details.d.ts index bd34ccc47b50dc..8c16eff221cc4f 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/funding-source-details.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/funding-source-details.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * FundingSourceDetails * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -6,6 +6,7 @@ import { AbstractCrudObject } from './../abstract-crud-object'; export default class FundingSourceDetails extends AbstractCrudObject { static get Fields(): Readonly<{ coupon: "coupon"; + coupons: "coupons"; display_string: "display_string"; id: "id"; type: "type"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/fundraiser-person-to-charity.d.ts b/types/facebook-nodejs-business-sdk/src/objects/fundraiser-person-to-charity.d.ts index 38db03c102ae72..5551384cea72f0 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/fundraiser-person-to-charity.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/fundraiser-person-to-charity.d.ts @@ -1,6 +1,6 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; +import Cursor from "./../cursor"; /** * FundraiserPersonToCharity * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -33,14 +33,10 @@ export default class FundraiserPersonToCharity extends AbstractCrudObject { static get FundraiserType(): Readonly<{ person_for_charity: "person_for_charity"; }>; - getDonations(fields: string[], params?: Record): Promise; - getDonations(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getDonations(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createEndFundraiser(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getExternalDonations(fields: string[], params?: Record): Promise; - getExternalDonations(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getExternalDonations(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createExternalDonation(fields: string[], params?: Record, pathOverride?: string | null): Promise; - get(fields: string[], params?: Record): Promise; - update(fields: string[], params?: Record): Promise; + getDonations(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createEndFundraiser(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getExternalDonations(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createExternalDonation(fields: string[], params?: Record, pathOverride?: string | null): Promise; + get(fields: string[], params?: Record): Promise; + update(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/game-item.d.ts b/types/facebook-nodejs-business-sdk/src/objects/game-item.d.ts deleted file mode 100644 index c396b576135e94..00000000000000 --- a/types/facebook-nodejs-business-sdk/src/objects/game-item.d.ts +++ /dev/null @@ -1,23 +0,0 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -/** - * GameItem - * @see {@link https://developers.facebook.com/docs/marketing-api/} - */ -export default class GameItem extends AbstractCrudObject { - static get Fields(): Readonly<{ - count: "count"; - created: "created"; - ext_id: "ext_id"; - id: "id"; - item_def: "item_def"; - owner: "owner"; - status: "status"; - updated: "updated"; - }>; - static get Action(): Readonly<{ - consume: "CONSUME"; - drop: "DROP"; - mark: "MARK"; - }>; - get(fields: string[], params?: Record): Promise; -} diff --git a/types/facebook-nodejs-business-sdk/src/objects/generic-video-asset.d.ts b/types/facebook-nodejs-business-sdk/src/objects/generic-video-asset.d.ts new file mode 100644 index 00000000000000..6f88104011f4f1 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/generic-video-asset.d.ts @@ -0,0 +1,55 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * GenericVideoAsset + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class GenericVideoAsset extends AbstractCrudObject { + static get Fields(): Readonly<{ + broadcast_id: "broadcast_id"; + broadcast_planned_start_time: "broadcast_planned_start_time"; + can_viewer_edit: "can_viewer_edit"; + copyright_monitoring_status: "copyright_monitoring_status"; + created_time: "created_time"; + creator: "creator"; + description: "description"; + download_hd_url: "download_hd_url"; + download_sd_url: "download_sd_url"; + embeddable: "embeddable"; + expiration: "expiration"; + feed_type: "feed_type"; + id: "id"; + is_crossposting_eligible: "is_crossposting_eligible"; + is_crossposting_within_bm_eligible: "is_crossposting_within_bm_eligible"; + is_crossposting_within_bm_enabled: "is_crossposting_within_bm_enabled"; + is_episode: "is_episode"; + is_featured: "is_featured"; + is_live_premiere: "is_live_premiere"; + is_video_asset: "is_video_asset"; + last_added_time: "last_added_time"; + latest_creator: "latest_creator"; + latest_owned_description: "latest_owned_description"; + latest_owned_title: "latest_owned_title"; + length: "length"; + live_status: "live_status"; + no_story: "no_story"; + owner_name: "owner_name"; + owner_picture: "owner_picture"; + owner_post_state: "owner_post_state"; + permalink_url: "permalink_url"; + picture: "picture"; + posts_count: "posts_count"; + posts_ids: "posts_ids"; + posts_status: "posts_status"; + premiere_living_room_status: "premiere_living_room_status"; + published: "published"; + scheduled_publish_time: "scheduled_publish_time"; + secret: "secret"; + secure_stream_url: "secure_stream_url"; + social_actions: "social_actions"; + status: "status"; + stream_url: "stream_url"; + thumbnail_while_encoding: "thumbnail_while_encoding"; + title: "title"; + views: "views"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/geo-gating-policy.d.ts b/types/facebook-nodejs-business-sdk/src/objects/geo-gating-policy.d.ts new file mode 100644 index 00000000000000..306e9323d65b27 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/geo-gating-policy.d.ts @@ -0,0 +1,17 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * GeoGatingPolicy + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class GeoGatingPolicy extends AbstractCrudObject { + static get Fields(): Readonly<{ + after_schedule: "after_schedule"; + exclude_country: "exclude_country"; + id: "id"; + include_country: "include_country"; + name: "name"; + valid_from: "valid_from"; + valid_until: "valid_until"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/group.d.ts b/types/facebook-nodejs-business-sdk/src/objects/group.d.ts index 258435f9a1ed16..3cbeb132923b69 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/group.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/group.d.ts @@ -1,10 +1,10 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import Cursor from './../cursor'; -import Album from './album'; -import Post from './post'; -import LiveVideo from './live-video'; -import Photo from './photo'; -import AdVideo from './ad-video'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; +import Album from "./album"; +import Post from "./post"; +import LiveVideo from "./live-video"; +import Photo from "./photo"; +import AdVideo from "./ad-video"; /** * Group * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -37,9 +37,9 @@ export default class Group extends AbstractCrudObject { none: "NONE"; }>; static get PostPermissions(): Readonly<{ - value_0: "0"; - value_1: "1"; - value_2: "2"; + admin_only: "ADMIN_ONLY"; + anyone: "ANYONE"; + none: "NONE"; }>; static get Purpose(): Readonly<{ casual: "CASUAL"; @@ -101,46 +101,26 @@ export default class Group extends AbstractCrudObject { work_team: "WORK_TEAM"; work_teamwork: "WORK_TEAMWORK"; }>; - deleteAdmins(params?: Record): Promise; - createAdmin(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getAlbums(fields: string[], params?: Record): Promise; - getAlbums(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAlbums(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createAlbum(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getDocs(fields: string[], params?: Record): Promise; - getDocs(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getDocs(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getEvents(fields: string[], params?: Record): Promise; - getEvents(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getEvents(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getFeed(fields: string[], params?: Record): Promise; - getFeed(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getFeed(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createFeed(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getFiles(fields: string[], params?: Record): Promise; - getFiles(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getFiles(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getGroups(fields: string[], params?: Record): Promise; - getGroups(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getGroups(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createGroup(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getLiveVideos(fields: string[], params?: Record): Promise; - getLiveVideos(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getLiveVideos(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createLiveVideo(fields: string[], params?: Record, pathOverride?: string | null): Promise; - deleteMembers(params?: Record): Promise; - createMember(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getOptedInMembers(fields: string[], params?: Record): Promise; - getOptedInMembers(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getOptedInMembers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createPhoto(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getPicture(fields: string[], params?: Record): Promise; - getPicture(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPicture(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getVideos(fields: string[], params?: Record): Promise; - getVideos(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getVideos(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createVideo(fields: string[], params?: Record, pathOverride?: string | null): Promise; - get(fields: string[], params?: Record): Promise; - update(fields: string[], params?: Record): Promise; + deleteAdMIns(params?: Record): Promise; + createAdMIn(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getAlbums(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createAlbum(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getDocs(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getEvents(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getFeed(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createFeed(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getFiles(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getGroups(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createGroup(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getLiveVideos(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createLiveVideo(fields: string[], params?: Record, pathOverride?: string | null): Promise; + deleteMembers(params?: Record): Promise; + createMember(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getOptedInMembers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createPhoto(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getPicture(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getVideos(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createVideo(fields: string[], params?: Record, pathOverride?: string | null): Promise; + get(fields: string[], params?: Record): Promise; + update(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/has-lead-access.d.ts b/types/facebook-nodejs-business-sdk/src/objects/has-lead-access.d.ts index f55ed6e5f4a835..9c59a7cd9146f6 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/has-lead-access.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/has-lead-access.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * HasLeadAccess * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/high-demand-period-time-suggestion-weekly-segment.d.ts b/types/facebook-nodejs-business-sdk/src/objects/high-demand-period-time-suggestion-weekly-segment.d.ts index 1dff7727abb9da..d5449949051e4f 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/high-demand-period-time-suggestion-weekly-segment.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/high-demand-period-time-suggestion-weekly-segment.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * HighDemandPeriodTimeSuggestionWeeklySegment * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/high-demand-period.d.ts b/types/facebook-nodejs-business-sdk/src/objects/high-demand-period.d.ts index 4aef6383afb041..b234ea9be1addf 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/high-demand-period.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/high-demand-period.d.ts @@ -1,5 +1,5 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; /** * HighDemandPeriod * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -19,7 +19,7 @@ export default class HighDemandPeriod extends AbstractCrudObject { absolute: "ABSOLUTE"; multiplier: "MULTIPLIER"; }>; - delete(fields: string[], params?: Record): Promise; - get(fields: string[], params?: Record): Promise; - update(fields: string[], params?: Record): 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/home-listing.d.ts b/types/facebook-nodejs-business-sdk/src/objects/home-listing.d.ts index 33f8f7850f1524..4571248d650852 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 @@ -1,6 +1,6 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; +import Cursor from "./../cursor"; /** * HomeListing * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -66,16 +66,10 @@ export default class HomeListing extends AbstractCrudObject { published: "PUBLISHED"; staging: "STAGING"; }>; - getAugmentedRealitiesMetadata(fields: string[], params?: Record): Promise; - getAugmentedRealitiesMetadata(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAugmentedRealitiesMetadata(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getChannelsToIntegrityStatus(fields: string[], params?: Record): Promise; - getChannelsToIntegrityStatus(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getChannelsToIntegrityStatus(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getVideosMetadata(fields: string[], params?: Record): Promise; - getVideosMetadata(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getVideosMetadata(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; + getAugmentedRealitiesMetadata(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getChannelsToIntegrityStatus(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getVideosMetadata(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/hotel-room.d.ts b/types/facebook-nodejs-business-sdk/src/objects/hotel-room.d.ts index 5a8a86fee289cd..dfd55eff76543d 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/hotel-room.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/hotel-room.d.ts @@ -1,5 +1,5 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; /** * HotelRoom * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -18,8 +18,6 @@ export default class HotelRoom extends AbstractCrudObject { sale_price: "sale_price"; url: "url"; }>; - getPricingVariables(fields: string[], params?: Record): Promise; - getPricingVariables(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPricingVariables(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - get(fields: string[], params?: Record): Promise; + getPricingVariables(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/hotel.d.ts b/types/facebook-nodejs-business-sdk/src/objects/hotel.d.ts index 7456ae075746b8..ebade0d74b458d 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/hotel.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/hotel.d.ts @@ -1,6 +1,6 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; +import Cursor from "./../cursor"; /** * Hotel * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -27,6 +27,7 @@ export default class Hotel extends AbstractCrudObject { sale_price: "sale_price"; sanitized_images: "sanitized_images"; star_rating: "star_rating"; + tags: "tags"; unit_price: "unit_price"; url: "url"; visibility: "visibility"; @@ -43,19 +44,11 @@ export default class Hotel extends AbstractCrudObject { published: "PUBLISHED"; staging: "STAGING"; }>; - getAugmentedRealitiesMetadata(fields: string[], params?: Record): Promise; - getAugmentedRealitiesMetadata(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAugmentedRealitiesMetadata(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getChannelsToIntegrityStatus(fields: string[], params?: Record): Promise; - getChannelsToIntegrityStatus(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getChannelsToIntegrityStatus(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getHotelRooms(fields: string[], params?: Record): Promise; - getHotelRooms(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getHotelRooms(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getVideosMetadata(fields: string[], params?: Record): Promise; - getVideosMetadata(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getVideosMetadata(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; + getAugmentedRealitiesMetadata(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getChannelsToIntegrityStatus(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getHotelRooms(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getVideosMetadata(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/hours.d.ts b/types/facebook-nodejs-business-sdk/src/objects/hours.d.ts new file mode 100644 index 00000000000000..75d9b31473aca5 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/hours.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * Hours + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class Hours extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + permanent_status: "permanent_status"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/id-name.d.ts b/types/facebook-nodejs-business-sdk/src/objects/id-name.d.ts index 590fee497bf47e..39892d8795ca0f 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/id-name.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/id-name.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * IDName * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ig-access-token-for-ig-only-api.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ig-access-token-for-ig-only-api.d.ts new file mode 100644 index 00000000000000..cee19f2f8ee8fc --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ig-access-token-for-ig-only-api.d.ts @@ -0,0 +1,14 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * IGAccessTokenForIGOnlyAPI + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class IGAccessTokenForIGOnlyAPI extends AbstractCrudObject { + static get Fields(): Readonly<{ + access_token: "access_token"; + expires_in: "expires_in"; + token_type: "token_type"; + id: "id"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ig-boost-media-ad.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ig-boost-media-ad.d.ts new file mode 100644 index 00000000000000..4216678f5f5765 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ig-boost-media-ad.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * IGBoostMediaAd + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class IGBoostMediaAd extends AbstractCrudObject { + static get Fields(): Readonly<{ + ad_id: "ad_id"; + ad_status: "ad_status"; + id: "id"; + }>; + get(fields: string[], params?: Record): Promise; +} 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 3979d8d2352dfa..b9dbf62f91cd3c 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 @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * IGCommentFromUser * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ig-comment.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ig-comment.d.ts index b817c1fa1c5e2e..e7670d508757e8 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ig-comment.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ig-comment.d.ts @@ -1,6 +1,6 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; +import Cursor from "./../cursor"; /** * IGComment * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -18,11 +18,9 @@ export default class IGComment extends AbstractCrudObject { user: "user"; username: "username"; }>; - getReplies(fields: string[], params?: Record): Promise; - getReplies(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getReplies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createReply(fields: string[], params?: Record, pathOverride?: string | null): Promise; - delete(fields: string[], params?: Record): Promise; - get(fields: string[], params?: Record): Promise; - update(fields: string[], params?: Record): Promise; + getReplies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createReply(fields: string[], params?: Record, pathOverride?: string | null): 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/ig-media-boost-eligibility-info.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ig-media-boost-eligibility-info.d.ts new file mode 100644 index 00000000000000..79a2be472cf38c --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ig-media-boost-eligibility-info.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * IGMediaBoostEligibilityInfo + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class IGMediaBoostEligibilityInfo extends AbstractCrudObject { + static get Fields(): Readonly<{ + boost_ineligible_reason: "boost_ineligible_reason"; + eligible_to_boost: "eligible_to_boost"; + id: "id"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ig-media-for-ig-only-api.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ig-media-for-ig-only-api.d.ts new file mode 100644 index 00000000000000..5912b2a7a06093 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ig-media-for-ig-only-api.d.ts @@ -0,0 +1,25 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; +/** + * IGMediaForIGOnlyAPI + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class IGMediaForIGOnlyAPI extends AbstractCrudObject { + static get Fields(): Readonly<{ + caption: "caption"; + id: "id"; + is_shared_to_feed: "is_shared_to_feed"; + like_count: "like_count"; + media_product_type: "media_product_type"; + media_type: "media_type"; + media_url: "media_url"; + owner: "owner"; + permalink: "permalink"; + shortcode: "shortcode"; + thumbnail_url: "thumbnail_url"; + timestamp: "timestamp"; + username: "username"; + }>; + getChildren(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-media.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ig-media.d.ts index 2193b0eda14ccc..b1be836b7df95f 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 @@ -1,13 +1,15 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import Cursor from './../cursor'; -import IGComment from './ig-comment'; -import ShadowIGMediaProductTags from './shadow-ig-media-product-tags'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; +import BrandedContentShadowIGUserID from "./branded-content-shadow-ig-user-id"; +import IGComment from "./ig-comment"; +import ShadowIGMediaProductTags from "./shadow-ig-media-product-tags"; /** * IGMedia * @see {@link https://developers.facebook.com/docs/marketing-api/} */ export default class IGMedia extends AbstractCrudObject { static get Fields(): Readonly<{ + boost_eligibility_info: "boost_eligibility_info"; caption: "caption"; comments_count: "comments_count"; copyright_check_information: "copyright_check_information"; @@ -26,24 +28,17 @@ export default class IGMedia extends AbstractCrudObject { timestamp: "timestamp"; username: "username"; }>; - getChildren(fields: string[], params?: Record): Promise; - getChildren(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getChildren(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getCollaborators(fields: string[], params?: Record): Promise; - getCollaborators(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCollaborators(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getComments(fields: string[], params?: Record): Promise; - getComments(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getComments(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createComment(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getInsights(fields: string[], params?: Record): Promise; - getInsights(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getInsights(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - deleteProductTags(params?: Record): Promise; - getProductTags(fields: string[], params?: Record): Promise; - getProductTags(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getProductTags(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createProductTag(fields: string[], params?: Record, pathOverride?: string | null): Promise; - get(fields: string[], params?: Record): Promise; - update(fields: string[], params?: Record): Promise; + getBoostAdsList(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getBrandedContentPartnerPromote(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createBrandedContentPartnerPromote(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getChildren(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getCollaborators(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getComments(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createComment(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getInsights(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + deleteProductTags(params?: Record): Promise; + getProductTags(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createProductTag(fields: string[], params?: Record, pathOverride?: string | null): Promise; + get(fields: string[], params?: Record): Promise; + update(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/ig-product-tagging-invalidation-error.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ig-product-tagging-invalidation-error.d.ts new file mode 100644 index 00000000000000..1bc975ceadf0f7 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ig-product-tagging-invalidation-error.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * IGProductTaggingInvalidationError + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class IGProductTaggingInvalidationError extends AbstractCrudObject { + static get Fields(): Readonly<{ + description: "description"; + taggability_state: "taggability_state"; + title: "title"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ig-refresh-access-token-for-ig-only-api.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ig-refresh-access-token-for-ig-only-api.d.ts new file mode 100644 index 00000000000000..bce7b5bf512969 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ig-refresh-access-token-for-ig-only-api.d.ts @@ -0,0 +1,14 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * IGRefreshAccessTokenForIGOnlyAPI + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class IGRefreshAccessTokenForIGOnlyAPI extends AbstractCrudObject { + static get Fields(): Readonly<{ + access_token: "access_token"; + expires_in: "expires_in"; + token_type: "token_type"; + id: "id"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ig-resumable-video-upload-status.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ig-resumable-video-upload-status.d.ts new file mode 100644 index 00000000000000..c7ddf40eb4d9a2 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ig-resumable-video-upload-status.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * IGResumableVideoUploadStatus + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class IGResumableVideoUploadStatus extends AbstractCrudObject { + static get Fields(): Readonly<{ + processing_phase: "processing_phase"; + uploading_phase: "uploading_phase"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ig-shopping-product-appeal.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ig-shopping-product-appeal.d.ts index 48a7e8af706be7..b4a4a5bb5c9520 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ig-shopping-product-appeal.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ig-shopping-product-appeal.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * IGShoppingProductAppeal * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ig-shopping-review-status-onsite-eligibility.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ig-shopping-review-status-onsite-eligibility.d.ts index e73eb7a33920d7..4f2f8499e5a2e5 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ig-shopping-review-status-onsite-eligibility.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ig-shopping-review-status-onsite-eligibility.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * IGShoppingReviewStatusOnsiteEligibility * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ig-shopping-review-status-reason-with-help-message.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ig-shopping-review-status-reason-with-help-message.d.ts index e645488058d6fd..7a418a5e914e6b 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ig-shopping-review-status-reason-with-help-message.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ig-shopping-review-status-reason-with-help-message.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * IGShoppingReviewStatusReasonWithHelpMessage * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ig-shopping-review-status.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ig-shopping-review-status.d.ts index afffe44aec2344..abbb7e78326797 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ig-shopping-review-status.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ig-shopping-review-status.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * IGShoppingReviewStatus * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ig-upcoming-event.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ig-upcoming-event.d.ts new file mode 100644 index 00000000000000..89a776973c78b2 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ig-upcoming-event.d.ts @@ -0,0 +1,15 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * IGUpcomingEvent + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class IGUpcomingEvent extends AbstractCrudObject { + static get Fields(): Readonly<{ + end_time: "end_time"; + id: "id"; + start_time: "start_time"; + title: "title"; + }>; + get(fields: string[], params?: Record): Promise; + update(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 new file mode 100644 index 00000000000000..37cec39f7b271d --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ig-user-for-ig-only-api.d.ts @@ -0,0 +1,18 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; +/** + * IGUserForIGOnlyAPI + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class IGUserForIGOnlyAPI extends AbstractCrudObject { + static get Fields(): Readonly<{ + account_type: "account_type"; + id: "id"; + media_count: "media_count"; + username: "username"; + }>; + getLiveMedia(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getMedia(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getStories(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.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ig-user.d.ts index cacf08b97cb124..97acc262699e03 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 @@ -1,8 +1,11 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; -import Cursor from './../cursor'; -import IGMedia from './ig-media'; -import IGShoppingProductAppeal from './ig-shopping-product-appeal'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; +import Cursor from "./../cursor"; +import IGBCAdsPermission from "./igbc-ads-permission"; +import BrandedContentShadowIGUserID from "./branded-content-shadow-ig-user-id"; +import AdsPixel from "./ads-pixel"; +import IGMedia from "./ig-media"; +import IGShoppingProductAppeal from "./ig-shopping-product-appeal"; /** * IGUser * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -26,45 +29,28 @@ export default class IGUser extends AbstractCrudObject { username: "username"; website: "website"; }>; - getAvailableCatalogs(fields: string[], params?: Record): Promise; - getAvailableCatalogs(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAvailableCatalogs(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getCatalogProductSearch(fields: string[], params?: Record): Promise; - getCatalogProductSearch(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCatalogProductSearch(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getContentPublishingLimit(fields: string[], params?: Record): Promise; - getContentPublishingLimit(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getContentPublishingLimit(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getDataset(fields: string[], params?: Record): Promise; - getDataset(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getDataset(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getInsights(fields: string[], params?: Record): Promise; - getInsights(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getInsights(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getLiveMedia(fields: string[], params?: Record): Promise; - getLiveMedia(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getLiveMedia(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getMedia(fields: string[], params?: Record): Promise; - getMedia(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getMedia(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createMedia(fields: string[], params?: Record, pathOverride?: string | null): Promise; - createMediaPublish(fields: string[], params?: Record, pathOverride?: string | null): Promise; - createMention(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getNotificationMessageTokens(fields: string[], params?: Record): Promise; - getNotificationMessageTokens(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getNotificationMessageTokens(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getProductAppeal(fields: string[], params?: Record): Promise; - getProductAppeal(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getProductAppeal(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createProductAppeal(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getRecentlySearchedHashtags(fields: string[], params?: Record): Promise; - getRecentlySearchedHashtags(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getRecentlySearchedHashtags(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getStories(fields: string[], params?: Record): Promise; - getStories(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getStories(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getTags(fields: string[], params?: Record): Promise; - getTags(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getTags(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - get(fields: string[], params?: Record): Promise; + getAvailableCatalogs(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getBrandedContentAdPermissions(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createBrandedContentAdPermission(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getBrandedContentAdvertisableMedias(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + deleteBrandedContentTagApproval(params?: Record): Promise; + getBrandedContentTagApproval(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createBrandedContentTagApproval(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getCatalogProductSearch(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getContentPublishingLimit(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; + getLiveMedia(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getMedia(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createMedia(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createMediaPublish(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createMention(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getNotificationMessageTokens(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getProductAppeal(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createProductAppeal(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getRecentlySearchedHashtags(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getStories(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getTags(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-video-copyright-check-matches-information.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ig-video-copyright-check-matches-information.d.ts index 2773efcbf25151..e74d11c3865e99 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ig-video-copyright-check-matches-information.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ig-video-copyright-check-matches-information.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * IGVideoCopyrightCheckMatchesInformation * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ig-video-copyright-check-status.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ig-video-copyright-check-status.d.ts index d27695e25a1b1e..4b8b2ddab1ef7f 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ig-video-copyright-check-status.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ig-video-copyright-check-status.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * IGVideoCopyrightCheckStatus * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/igbc-ads-permission.d.ts b/types/facebook-nodejs-business-sdk/src/objects/igbc-ads-permission.d.ts index da87eb62e5f497..76917070b577c4 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/igbc-ads-permission.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/igbc-ads-permission.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * IGBCAdsPermission * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -9,5 +9,5 @@ export default class IGBCAdsPermission extends AbstractCrudObject { permission_type: "permission_type"; status: "status"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/image-copyright-dispute.d.ts b/types/facebook-nodejs-business-sdk/src/objects/image-copyright-dispute.d.ts new file mode 100644 index 00000000000000..35e171ed7276eb --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/image-copyright-dispute.d.ts @@ -0,0 +1,19 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ImageCopyrightDispute + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ImageCopyrightDispute extends AbstractCrudObject { + static get Fields(): Readonly<{ + appeal_form_data: "appeal_form_data"; + dispute_form_data: "dispute_form_data"; + expiration_time: "expiration_time"; + id: "id"; + match_id: "match_id"; + status: "status"; + time_appealed: "time_appealed"; + time_created: "time_created"; + time_updated: "time_updated"; + }>; + 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 ebcb77bba9c4a8..c0d7497fd90832 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 @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ImageCopyright * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -275,6 +275,6 @@ export default class ImageCopyright extends AbstractCrudObject { zm: "ZM"; zw: "ZW"; }>; - get(fields: string[], params?: Record): Promise; - update(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/image-reference-match.d.ts b/types/facebook-nodejs-business-sdk/src/objects/image-reference-match.d.ts new file mode 100644 index 00000000000000..50a9c98578bfe2 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/image-reference-match.d.ts @@ -0,0 +1,27 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ImageReferenceMatch + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ImageReferenceMatch extends AbstractCrudObject { + static get Fields(): Readonly<{ + conflicting_countries: "conflicting_countries"; + country_resolution_history: "country_resolution_history"; + creation_time: "creation_time"; + current_conflict_resolved_countries: "current_conflict_resolved_countries"; + displayed_match_state: "displayed_match_state"; + dispute_form_data_entries_with_translations: "dispute_form_data_entries_with_translations"; + expiration_time: "expiration_time"; + id: "id"; + match_state: "match_state"; + matched_reference_copyright: "matched_reference_copyright"; + matched_reference_owner: "matched_reference_owner"; + modification_history: "modification_history"; + reference_copyright: "reference_copyright"; + reference_owner: "reference_owner"; + rejection_form_data_entries_with_translations: "rejection_form_data_entries_with_translations"; + resolution_reason: "resolution_reason"; + update_time: "update_time"; + }>; + get(fields: string[], params?: Record): Promise; +} 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 19079a90621b22..dd3a7e7359c865 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 @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * InsightsResult * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -43,4 +43,196 @@ export default class InsightsResult extends AbstractCrudObject { total_over_range: "total_over_range"; week: "week"; }>; + static get Metric(): Readonly<{ + blue_reels_play_count: "blue_reels_play_count"; + creator_monetization_qualified_views: "creator_monetization_qualified_views"; + fb_media_matching_copyright_comment_count: "fb_media_matching_copyright_comment_count"; + fb_media_matching_copyright_daily_comment_count: "fb_media_matching_copyright_daily_comment_count"; + fb_media_matching_copyright_daily_like_count: "fb_media_matching_copyright_daily_like_count"; + fb_media_matching_copyright_daily_post_impressions: "fb_media_matching_copyright_daily_post_impressions"; + fb_media_matching_copyright_daily_post_impressions_by_age_bucket_and_gender: "fb_media_matching_copyright_daily_post_impressions_by_age_bucket_and_gender"; + fb_media_matching_copyright_daily_post_impressions_by_country: "fb_media_matching_copyright_daily_post_impressions_by_country"; + fb_media_matching_copyright_daily_post_impressions_by_locale: "fb_media_matching_copyright_daily_post_impressions_by_locale"; + fb_media_matching_copyright_daily_post_impressions_by_matching_post_id: "fb_media_matching_copyright_daily_post_impressions_by_matching_post_id"; + fb_media_matching_copyright_daily_post_impressions_by_matching_post_owner_id: "fb_media_matching_copyright_daily_post_impressions_by_matching_post_owner_id"; + fb_media_matching_copyright_daily_post_reactions_anger_count: "fb_media_matching_copyright_daily_post_reactions_anger_count"; + fb_media_matching_copyright_daily_post_reactions_haha_count: "fb_media_matching_copyright_daily_post_reactions_haha_count"; + fb_media_matching_copyright_daily_post_reactions_like_count: "fb_media_matching_copyright_daily_post_reactions_like_count"; + fb_media_matching_copyright_daily_post_reactions_love_count: "fb_media_matching_copyright_daily_post_reactions_love_count"; + fb_media_matching_copyright_daily_post_reactions_sorry_count: "fb_media_matching_copyright_daily_post_reactions_sorry_count"; + fb_media_matching_copyright_daily_post_reactions_wow_count: "fb_media_matching_copyright_daily_post_reactions_wow_count"; + fb_media_matching_copyright_daily_post_share_count: "fb_media_matching_copyright_daily_post_share_count"; + fb_media_matching_copyright_like_count: "fb_media_matching_copyright_like_count"; + fb_media_matching_copyright_post_impressions: "fb_media_matching_copyright_post_impressions"; + fb_media_matching_copyright_post_impressions_by_age_bucket_and_gender: "fb_media_matching_copyright_post_impressions_by_age_bucket_and_gender"; + fb_media_matching_copyright_post_impressions_by_country: "fb_media_matching_copyright_post_impressions_by_country"; + fb_media_matching_copyright_post_impressions_by_locale: "fb_media_matching_copyright_post_impressions_by_locale"; + fb_media_matching_copyright_post_impressions_by_matching_post_id: "fb_media_matching_copyright_post_impressions_by_matching_post_id"; + fb_media_matching_copyright_post_impressions_by_matching_post_owner_id: "fb_media_matching_copyright_post_impressions_by_matching_post_owner_id"; + fb_media_matching_copyright_post_reactions_anger_count: "fb_media_matching_copyright_post_reactions_anger_count"; + fb_media_matching_copyright_post_reactions_haha_count: "fb_media_matching_copyright_post_reactions_haha_count"; + fb_media_matching_copyright_post_reactions_like_count: "fb_media_matching_copyright_post_reactions_like_count"; + fb_media_matching_copyright_post_reactions_love_count: "fb_media_matching_copyright_post_reactions_love_count"; + fb_media_matching_copyright_post_reactions_sorry_count: "fb_media_matching_copyright_post_reactions_sorry_count"; + fb_media_matching_copyright_post_reactions_wow_count: "fb_media_matching_copyright_post_reactions_wow_count"; + fb_media_matching_copyright_post_share_count: "fb_media_matching_copyright_post_share_count"; + fb_reels_replay_count: "fb_reels_replay_count"; + fb_reels_total_plays: "fb_reels_total_plays"; + has_total_video_views_by_publisher_platform_type: "has_total_video_views_by_publisher_platform_type"; + post_impressions_unique: "post_impressions_unique"; + post_video_avg_time_watched: "post_video_avg_time_watched"; + post_video_followers: "post_video_followers"; + post_video_likes_by_reaction_type: "post_video_likes_by_reaction_type"; + post_video_retention_graph: "post_video_retention_graph"; + post_video_social_actions: "post_video_social_actions"; + post_video_view_time: "post_video_view_time"; + rights_manager_matching_copyright_matching_page_or_profile_view_count: "rights_manager_matching_copyright_matching_page_or_profile_view_count"; + rights_manager_matching_copyright_matching_video_view_count: "rights_manager_matching_copyright_matching_video_view_count"; + rights_manager_matching_copyright_video_view_count: "rights_manager_matching_copyright_video_view_count"; + rights_manager_matching_copyright_video_view_count_60s: "rights_manager_matching_copyright_video_view_count_60s"; + rights_manager_matching_copyright_video_view_count_60s_by_age_bucket_and_gender: "rights_manager_matching_copyright_video_view_count_60s_by_age_bucket_and_gender"; + rights_manager_matching_copyright_video_view_count_60s_by_country_id: "rights_manager_matching_copyright_video_view_count_60s_by_country_id"; + rights_manager_matching_copyright_video_view_count_60s_by_locale: "rights_manager_matching_copyright_video_view_count_60s_by_locale"; + total_audio_only_product_listen_count: "total_audio_only_product_listen_count"; + total_video_10s_views: "total_video_10s_views"; + total_video_10s_views_auto_played: "total_video_10s_views_auto_played"; + total_video_10s_views_clicked_to_play: "total_video_10s_views_clicked_to_play"; + total_video_10s_views_organic: "total_video_10s_views_organic"; + total_video_10s_views_paid: "total_video_10s_views_paid"; + total_video_10s_views_sound_on: "total_video_10s_views_sound_on"; + total_video_10s_views_unique: "total_video_10s_views_unique"; + total_video_15s_views: "total_video_15s_views"; + total_video_30s_views: "total_video_30s_views"; + total_video_30s_views_auto_played: "total_video_30s_views_auto_played"; + total_video_30s_views_clicked_to_play: "total_video_30s_views_clicked_to_play"; + total_video_30s_views_organic: "total_video_30s_views_organic"; + total_video_30s_views_paid: "total_video_30s_views_paid"; + total_video_30s_views_unique: "total_video_30s_views_unique"; + total_video_60s_excludes_shorter_views: "total_video_60s_excludes_shorter_views"; + total_video_60s_excludes_shorter_views_by_age_bucket_and_gender: "total_video_60s_excludes_shorter_views_by_age_bucket_and_gender"; + total_video_60s_excludes_shorter_views_by_distribution_source: "total_video_60s_excludes_shorter_views_by_distribution_source"; + total_video_60s_excludes_shorter_views_by_growth_accounting_bucket: "total_video_60s_excludes_shorter_views_by_growth_accounting_bucket"; + total_video_60s_excludes_shorter_views_by_growth_accounting_bucket_and_time_since_creation_bucket: "total_video_60s_excludes_shorter_views_by_growth_accounting_bucket_and_time_since_creation_bucket"; + total_video_60s_excludes_shorter_views_by_is_60s_returning_viewer: "total_video_60s_excludes_shorter_views_by_is_60s_returning_viewer"; + total_video_60s_excludes_shorter_views_by_is_60s_returning_viewer_and_time_since_creation_bucket: "total_video_60s_excludes_shorter_views_by_is_60s_returning_viewer_and_time_since_creation_bucket"; + total_video_60s_excludes_shorter_views_live: "total_video_60s_excludes_shorter_views_live"; + total_video_60s_excludes_shorter_views_unique: "total_video_60s_excludes_shorter_views_unique"; + total_video_60s_excludes_shorter_views_unique_by_age_bucket_and_gender: "total_video_60s_excludes_shorter_views_unique_by_age_bucket_and_gender"; + total_video_60s_excludes_shorter_views_unique_by_growth_accounting_bucket: "total_video_60s_excludes_shorter_views_unique_by_growth_accounting_bucket"; + total_video_60s_excludes_shorter_views_unique_by_growth_accounting_bucket_and_time_since_creation_bucket: "total_video_60s_excludes_shorter_views_unique_by_growth_accounting_bucket_and_time_since_creation_bucket"; + total_video_60s_excludes_shorter_views_unique_by_is_60s_returning_viewer: "total_video_60s_excludes_shorter_views_unique_by_is_60s_returning_viewer"; + total_video_60s_excludes_shorter_views_unique_by_is_60s_returning_viewer_and_time_since_creation_bucket: "total_video_60s_excludes_shorter_views_unique_by_is_60s_returning_viewer_and_time_since_creation_bucket"; + total_video_ad_break_ad_cpm: "total_video_ad_break_ad_cpm"; + total_video_ad_break_ad_impressions: "total_video_ad_break_ad_impressions"; + total_video_ad_break_earnings: "total_video_ad_break_earnings"; + total_video_ad_break_earnings_with_subsidy: "total_video_ad_break_earnings_with_subsidy"; + total_video_ad_impressions_by_monetization_type: "total_video_ad_impressions_by_monetization_type"; + total_video_avg_time_watched: "total_video_avg_time_watched"; + total_video_avg_time_watched_by_distribution_source: "total_video_avg_time_watched_by_distribution_source"; + total_video_avg_time_watched_by_is_60s_returning_viewer: "total_video_avg_time_watched_by_is_60s_returning_viewer"; + total_video_avg_time_watched_by_time_since_creation_bucket: "total_video_avg_time_watched_by_time_since_creation_bucket"; + total_video_avg_time_watched_followers: "total_video_avg_time_watched_followers"; + total_video_avg_time_watched_live: "total_video_avg_time_watched_live"; + total_video_comment_sentiment: "total_video_comment_sentiment"; + total_video_comment_sentiment_by_factors: "total_video_comment_sentiment_by_factors"; + total_video_complete_views: "total_video_complete_views"; + total_video_complete_views_auto_played: "total_video_complete_views_auto_played"; + total_video_complete_views_clicked_to_play: "total_video_complete_views_clicked_to_play"; + total_video_complete_views_organic: "total_video_complete_views_organic"; + total_video_complete_views_organic_unique: "total_video_complete_views_organic_unique"; + total_video_complete_views_paid: "total_video_complete_views_paid"; + total_video_complete_views_paid_unique: "total_video_complete_views_paid_unique"; + total_video_complete_views_unique: "total_video_complete_views_unique"; + total_video_consumption_rate: "total_video_consumption_rate"; + total_video_followers_unique: "total_video_followers_unique"; + total_video_growth_score: "total_video_growth_score"; + total_video_growth_score_by_factors: "total_video_growth_score_by_factors"; + total_video_impressions: "total_video_impressions"; + total_video_impressions_fan: "total_video_impressions_fan"; + total_video_impressions_fan_paid: "total_video_impressions_fan_paid"; + total_video_impressions_fan_paid_unique: "total_video_impressions_fan_paid_unique"; + total_video_impressions_fan_unique: "total_video_impressions_fan_unique"; + total_video_impressions_organic: "total_video_impressions_organic"; + total_video_impressions_organic_unique: "total_video_impressions_organic_unique"; + total_video_impressions_paid: "total_video_impressions_paid"; + total_video_impressions_paid_unique: "total_video_impressions_paid_unique"; + total_video_impressions_unique: "total_video_impressions_unique"; + total_video_impressions_viral: "total_video_impressions_viral"; + total_video_impressions_viral_unique: "total_video_impressions_viral_unique"; + total_video_imps_count_unique_by_age_bucket: "total_video_imps_count_unique_by_age_bucket"; + total_video_imps_count_unique_by_age_bucket_and_gender: "total_video_imps_count_unique_by_age_bucket_and_gender"; + total_video_imps_count_unique_by_gender: "total_video_imps_count_unique_by_gender"; + total_video_likes_by_reaction_type: "total_video_likes_by_reaction_type"; + total_video_negative_feedback: "total_video_negative_feedback"; + total_video_net_followers: "total_video_net_followers"; + total_video_net_followers_unique: "total_video_net_followers_unique"; + total_video_net_followers_unique_by_time_since_creation_bucket: "total_video_net_followers_unique_by_time_since_creation_bucket"; + total_video_play_count: "total_video_play_count"; + total_video_play_count_by_is_60s_returning_viewer_and_time_since_creation_bucket: "total_video_play_count_by_is_60s_returning_viewer_and_time_since_creation_bucket"; + total_video_play_count_by_time_since_creation_bucket: "total_video_play_count_by_time_since_creation_bucket"; + total_video_reactions_by_type_total: "total_video_reactions_by_type_total"; + total_video_relative_retention_graph: "total_video_relative_retention_graph"; + total_video_retention_graph: "total_video_retention_graph"; + total_video_retention_graph_15s: "total_video_retention_graph_15s"; + total_video_retention_graph_15s_followers: "total_video_retention_graph_15s_followers"; + total_video_retention_graph_15s_newsfeed: "total_video_retention_graph_15s_newsfeed"; + total_video_retention_graph_15s_recommended: "total_video_retention_graph_15s_recommended"; + total_video_retention_graph_15s_shares: "total_video_retention_graph_15s_shares"; + total_video_retention_graph_15s_watch: "total_video_retention_graph_15s_watch"; + total_video_retention_graph_autoplayed: "total_video_retention_graph_autoplayed"; + total_video_retention_graph_clicked_to_play: "total_video_retention_graph_clicked_to_play"; + total_video_retention_graph_gender_female: "total_video_retention_graph_gender_female"; + total_video_retention_graph_gender_male: "total_video_retention_graph_gender_male"; + total_video_social_actions: "total_video_social_actions"; + total_video_social_actions_comment_by_distribution_type: "total_video_social_actions_comment_by_distribution_type"; + total_video_social_actions_count_unique: "total_video_social_actions_count_unique"; + total_video_social_actions_count_unique_by_age_bucket: "total_video_social_actions_count_unique_by_age_bucket"; + total_video_social_actions_count_unique_by_age_bucket_and_gender: "total_video_social_actions_count_unique_by_age_bucket_and_gender"; + total_video_social_actions_count_unique_by_gender: "total_video_social_actions_count_unique_by_gender"; + total_video_social_actions_reaction_by_distribution_type: "total_video_social_actions_reaction_by_distribution_type"; + total_video_stories_by_action_type: "total_video_stories_by_action_type"; + total_video_unfollowers: "total_video_unfollowers"; + total_video_unfollowers_unique: "total_video_unfollowers_unique"; + total_video_view_count_unique_by_age_bucket: "total_video_view_count_unique_by_age_bucket"; + total_video_view_count_unique_by_age_bucket_and_gender: "total_video_view_count_unique_by_age_bucket_and_gender"; + total_video_view_count_unique_by_gender: "total_video_view_count_unique_by_gender"; + total_video_view_time_by_age_bucket_and_gender: "total_video_view_time_by_age_bucket_and_gender"; + total_video_view_time_by_country_id: "total_video_view_time_by_country_id"; + total_video_view_time_by_distribution_source: "total_video_view_time_by_distribution_source"; + total_video_view_time_by_distribution_type: "total_video_view_time_by_distribution_type"; + total_video_view_time_by_is_60s_returning_viewer_and_time_since_creation_bucket: "total_video_view_time_by_is_60s_returning_viewer_and_time_since_creation_bucket"; + total_video_view_time_by_region_id: "total_video_view_time_by_region_id"; + total_video_view_time_by_time_since_creation_bucket: "total_video_view_time_by_time_since_creation_bucket"; + total_video_view_total_time: "total_video_view_total_time"; + total_video_view_total_time_by_is_60s_returning_viewer: "total_video_view_total_time_by_is_60s_returning_viewer"; + total_video_view_total_time_by_paid_non_paid: "total_video_view_total_time_by_paid_non_paid"; + total_video_view_total_time_live: "total_video_view_total_time_live"; + total_video_view_total_time_organic: "total_video_view_total_time_organic"; + total_video_view_total_time_paid: "total_video_view_total_time_paid"; + total_video_view_total_time_vod: "total_video_view_total_time_vod"; + total_video_views: "total_video_views"; + total_video_views_autoplayed: "total_video_views_autoplayed"; + total_video_views_by_age_bucket_and_gender: "total_video_views_by_age_bucket_and_gender"; + total_video_views_by_country_id: "total_video_views_by_country_id"; + total_video_views_by_distribution_type: "total_video_views_by_distribution_type"; + total_video_views_by_paid_non_paid: "total_video_views_by_paid_non_paid"; + total_video_views_by_region_id: "total_video_views_by_region_id"; + total_video_views_by_region_id_proper: "total_video_views_by_region_id_proper"; + total_video_views_clicked_to_play: "total_video_views_clicked_to_play"; + total_video_views_gender_female: "total_video_views_gender_female"; + total_video_views_gender_female_live: "total_video_views_gender_female_live"; + total_video_views_gender_male: "total_video_views_gender_male"; + total_video_views_gender_male_live: "total_video_views_gender_male_live"; + total_video_views_live: "total_video_views_live"; + total_video_views_live_autoplayed: "total_video_views_live_autoplayed"; + total_video_views_live_clicked_to_play: "total_video_views_live_clicked_to_play"; + total_video_views_organic: "total_video_views_organic"; + total_video_views_organic_unique: "total_video_views_organic_unique"; + total_video_views_paid: "total_video_views_paid"; + total_video_views_paid_unique: "total_video_views_paid_unique"; + total_video_views_sound_on: "total_video_views_sound_on"; + total_video_views_unique: "total_video_views_unique"; + total_video_views_vod: "total_video_views_vod"; + video_asset_60s_video_view_total_count_by_is_monetizable: "video_asset_60s_video_view_total_count_by_is_monetizable"; + }>; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/insights-value.d.ts b/types/facebook-nodejs-business-sdk/src/objects/insights-value.d.ts new file mode 100644 index 00000000000000..f96e09bd336c94 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/insights-value.d.ts @@ -0,0 +1,19 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * InsightsValue + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class InsightsValue extends AbstractCrudObject { + static get Fields(): Readonly<{ + campaign_id: "campaign_id"; + end_time: "end_time"; + engagement_source: "engagement_source"; + message_type: "message_type"; + messaging_channel: "messaging_channel"; + recurring_notifications_entry_point: "recurring_notifications_entry_point"; + recurring_notifications_frequency: "recurring_notifications_frequency"; + recurring_notifications_topic: "recurring_notifications_topic"; + start_time: "start_time"; + value: "value"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/instagram-boostable-media-for-access-token.d.ts b/types/facebook-nodejs-business-sdk/src/objects/instagram-boostable-media-for-access-token.d.ts new file mode 100644 index 00000000000000..1a6e9e5182ac40 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/instagram-boostable-media-for-access-token.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * InstagramBoostableMediaForAccessToken + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class InstagramBoostableMediaForAccessToken extends AbstractCrudObject { + static get Fields(): Readonly<{ + has_product_tags: "has_product_tags"; + media: "media"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/instagram-carousel.d.ts b/types/facebook-nodejs-business-sdk/src/objects/instagram-carousel.d.ts index 18a7d857b1e79f..0c4f5fb16fb14a 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/instagram-carousel.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/instagram-carousel.d.ts @@ -1,6 +1,6 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import Cursor from './../cursor'; -import InstagramComment from './instagram-comment'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; +import InstagramComment from "./instagram-comment"; /** * InstagramCarousel * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -18,9 +18,7 @@ export default class InstagramCarousel extends AbstractCrudObject { taken_at: "taken_at"; video_url: "video_url"; }>; - getComments(fields: string[], params?: Record): Promise; - getComments(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getComments(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createComment(fields: string[], params?: Record, pathOverride?: string | null): Promise; - get(fields: string[], params?: Record): Promise; + getComments(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createComment(fields: string[], params?: Record, pathOverride?: string | null): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/instagram-comment.d.ts b/types/facebook-nodejs-business-sdk/src/objects/instagram-comment.d.ts index 73fede9d2178cf..91c9e9cdf6c608 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/instagram-comment.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/instagram-comment.d.ts @@ -1,6 +1,6 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; +import Cursor from "./../cursor"; /** * InstagramComment * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -16,11 +16,9 @@ export default class InstagramComment extends AbstractCrudObject { message: "message"; username: "username"; }>; - getReplies(fields: string[], params?: Record): Promise; - getReplies(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getReplies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createReply(fields: string[], params?: Record, pathOverride?: string | null): Promise; - delete(fields: string[], params?: Record): Promise; - get(fields: string[], params?: Record): Promise; - update(fields: string[], params?: Record): Promise; + getReplies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createReply(fields: string[], params?: Record, pathOverride?: string | null): 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/instagram-insights-result.d.ts b/types/facebook-nodejs-business-sdk/src/objects/instagram-insights-result.d.ts index 78d33dd6d98824..c4356978ec3797 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/instagram-insights-result.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/instagram-insights-result.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * InstagramInsightsResult * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -20,15 +20,10 @@ export default class InstagramInsightsResult extends AbstractCrudObject { surface_type: "surface_type"; }>; static get Metric(): Readonly<{ - carousel_album_engagement: "carousel_album_engagement"; - carousel_album_impressions: "carousel_album_impressions"; - carousel_album_reach: "carousel_album_reach"; - carousel_album_saved: "carousel_album_saved"; - carousel_album_video_views: "carousel_album_video_views"; + clips_replays_count: "clips_replays_count"; comments: "comments"; - engagement: "engagement"; - exits: "exits"; follows: "follows"; + ig_reels_aggregated_all_plays_count: "ig_reels_aggregated_all_plays_count"; ig_reels_avg_watch_time: "ig_reels_avg_watch_time"; ig_reels_video_view_total_time: "ig_reels_video_view_total_time"; impressions: "impressions"; @@ -41,8 +36,6 @@ export default class InstagramInsightsResult extends AbstractCrudObject { replies: "replies"; saved: "saved"; shares: "shares"; - taps_back: "taps_back"; - taps_forward: "taps_forward"; total_interactions: "total_interactions"; video_views: "video_views"; }>; diff --git a/types/facebook-nodejs-business-sdk/src/objects/instagram-insights-value.d.ts b/types/facebook-nodejs-business-sdk/src/objects/instagram-insights-value.d.ts index 26176b82d45d86..5c6cf1857d2674 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/instagram-insights-value.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/instagram-insights-value.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * InstagramInsightsValue * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/instagram-media.d.ts b/types/facebook-nodejs-business-sdk/src/objects/instagram-media.d.ts index c3dc704741d423..368d88134ab6ba 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/instagram-media.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/instagram-media.d.ts @@ -1,6 +1,6 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import Cursor from './../cursor'; -import InstagramComment from './instagram-comment'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; +import InstagramComment from "./instagram-comment"; /** * InstagramMedia * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -23,9 +23,7 @@ export default class InstagramMedia extends AbstractCrudObject { taken_at: "taken_at"; video_url: "video_url"; }>; - getComments(fields: string[], params?: Record): Promise; - getComments(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getComments(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createComment(fields: string[], params?: Record, pathOverride?: string | null): Promise; - get(fields: string[], params?: Record): Promise; + getComments(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createComment(fields: string[], params?: Record, pathOverride?: string | null): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/instagram-related-product-tags.d.ts b/types/facebook-nodejs-business-sdk/src/objects/instagram-related-product-tags.d.ts new file mode 100644 index 00000000000000..f261600db3726a --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/instagram-related-product-tags.d.ts @@ -0,0 +1,15 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * InstagramRelatedProductTags + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class InstagramRelatedProductTags extends AbstractCrudObject { + static get Fields(): Readonly<{ + checkout_setting: "checkout_setting"; + id: "id"; + image_uri: "image_uri"; + name: "name"; + price_label: "price_label"; + sale_price_label: "sale_price_label"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/instagram-shopping-merchant-review-message.d.ts b/types/facebook-nodejs-business-sdk/src/objects/instagram-shopping-merchant-review-message.d.ts index 15438467064974..e58788e73284d2 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/instagram-shopping-merchant-review-message.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/instagram-shopping-merchant-review-message.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * InstagramShoppingMerchantReviewMessage * @see {@link https://developers.facebook.com/docs/marketing-api/} 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 ba52870c9a2c39..dcfa71903658ed 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,5 +1,6 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import Cursor from './../cursor'; +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/} @@ -18,15 +19,11 @@ export default class InstagramUser extends AbstractCrudObject { profile_pic: "profile_pic"; username: "username"; }>; - getAgencies(fields: string[], params?: Record): Promise; - getAgencies(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAgencies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getArEffects(fields: string[], params?: Record): Promise; - getArEffects(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getArEffects(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAuthorizedAdAccounts(fields: string[], params?: Record): Promise; - getAuthorizedAdAccounts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAuthorizedAdAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createAuthorizedAdAccount(fields: string[], params?: Record, pathOverride?: string | null): Promise; - get(fields: string[], params?: Record): Promise; + 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/instagram-video-metadata.d.ts b/types/facebook-nodejs-business-sdk/src/objects/instagram-video-metadata.d.ts index 78c0c6c6a206bf..27096e83958532 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/instagram-video-metadata.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/instagram-video-metadata.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * InstagramVideoMetadata * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/instant-article-cta.d.ts b/types/facebook-nodejs-business-sdk/src/objects/instant-article-cta.d.ts new file mode 100644 index 00000000000000..2ac2e0e7d3b013 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/instant-article-cta.d.ts @@ -0,0 +1,14 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * InstantArticleCTA + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class InstantArticleCTA extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + is_enabled: "is_enabled"; + publisher_defined_value: "publisher_defined_value"; + type: "type"; + update_time: "update_time"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/instant-article-insights-query-result.d.ts b/types/facebook-nodejs-business-sdk/src/objects/instant-article-insights-query-result.d.ts new file mode 100644 index 00000000000000..b1a885aa137a5d --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/instant-article-insights-query-result.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * InstantArticleInsightsQueryResult + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class InstantArticleInsightsQueryResult extends AbstractCrudObject { + static get Fields(): Readonly<{ + breakdowns: "breakdowns"; + name: "name"; + time: "time"; + value: "value"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ios-app-link.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ios-app-link.d.ts index a6043e58dc0a31..e2123f2a308204 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/ios-app-link.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/ios-app-link.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * IosAppLink * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/ip-object.d.ts b/types/facebook-nodejs-business-sdk/src/objects/ip-object.d.ts new file mode 100644 index 00000000000000..94413b4bc1499d --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/ip-object.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * IPObject + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class IPObject extends AbstractCrudObject { + static get Fields(): Readonly<{ + ip_permission: "ip_permission"; + user: "user"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/job-opening.d.ts b/types/facebook-nodejs-business-sdk/src/objects/job-opening.d.ts index 60ec07859eaeae..3580021b6d2c62 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/job-opening.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/job-opening.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * JobOpening * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -59,5 +59,5 @@ export default class JobOpening extends AbstractCrudObject { part_time: "PART_TIME"; volunteer: "VOLUNTEER"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/key-value.d.ts b/types/facebook-nodejs-business-sdk/src/objects/key-value.d.ts index 2b4acc5da1a3b1..730abefadc2cd6 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/key-value.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/key-value.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * KeyValue * @see {@link https://developers.facebook.com/docs/marketing-api/} 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 new file mode 100644 index 00000000000000..ba0df8b0fc7b84 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/keyword-delivery-report.d.ts @@ -0,0 +1,18 @@ +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-appointment-booking-info.d.ts b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-appointment-booking-info.d.ts index 9e57454389f7db..ff089569929712 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/lead-gen-appointment-booking-info.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-appointment-booking-info.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * LeadGenAppointmentBookingInfo * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/lead-gen-appointment-slots-by-day.d.ts b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-appointment-slots-by-day.d.ts index 85f34ae067744c..3fbf9f4610126d 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/lead-gen-appointment-slots-by-day.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-appointment-slots-by-day.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * LeadGenAppointmentSlotsByDay * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/lead-gen-appointment-time-slot.d.ts b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-appointment-time-slot.d.ts index 991a7f53b2fe40..f150d0e14da64e 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/lead-gen-appointment-time-slot.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-appointment-time-slot.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * LeadGenAppointmentTimeSlot * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/lead-gen-conditional-questions-group-choices.d.ts b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-conditional-questions-group-choices.d.ts index e1a8c50d3ca7b1..89394a312804f8 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/lead-gen-conditional-questions-group-choices.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-conditional-questions-group-choices.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * LeadGenConditionalQuestionsGroupChoices * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/lead-gen-conditional-questions-group-questions.d.ts b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-conditional-questions-group-questions.d.ts index 4d29789cd73385..c0456a1ecc91b5 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/lead-gen-conditional-questions-group-questions.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-conditional-questions-group-questions.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * LeadGenConditionalQuestionsGroupQuestions * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/lead-gen-context-card.d.ts b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-context-card.d.ts index 9177016edcfbb3..845d33943aed85 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/lead-gen-context-card.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-context-card.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * LeadGenContextCard * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/lead-gen-custom-disclaimer-body.d.ts b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-custom-disclaimer-body.d.ts index 7db222b82c2e9c..d17dec10fc3674 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/lead-gen-custom-disclaimer-body.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-custom-disclaimer-body.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * LeadGenCustomDisclaimerBody * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/lead-gen-custom-disclaimer.d.ts b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-custom-disclaimer.d.ts index f64e2da5dfb1f1..b2d499ec572bd3 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/lead-gen-custom-disclaimer.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-custom-disclaimer.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * LeadGenCustomDisclaimer * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/lead-gen-data-draft.d.ts b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-data-draft.d.ts new file mode 100644 index 00000000000000..89a0da5de63ae4 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-data-draft.d.ts @@ -0,0 +1,25 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * LeadGenDataDraft + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class LeadGenDataDraft extends AbstractCrudObject { + static get Fields(): Readonly<{ + block_display_for_non_targeted_viewer: "block_display_for_non_targeted_viewer"; + created_time: "created_time"; + disqualified_end_component: "disqualified_end_component"; + follow_up_action_url: "follow_up_action_url"; + id: "id"; + is_optimized_for_quality: "is_optimized_for_quality"; + legal_content: "legal_content"; + locale: "locale"; + name: "name"; + page: "page"; + question_page_custom_headline: "question_page_custom_headline"; + questions: "questions"; + status: "status"; + thank_you_page: "thank_you_page"; + tracking_parameters: "tracking_parameters"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/lead-gen-direct-crm-integration-config.d.ts b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-direct-crm-integration-config.d.ts new file mode 100644 index 00000000000000..f84071d40d054e --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-direct-crm-integration-config.d.ts @@ -0,0 +1,18 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * LeadGenDirectCRMIntegrationConfig + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class LeadGenDirectCRMIntegrationConfig extends AbstractCrudObject { + static get Fields(): Readonly<{ + auth_id: "auth_id"; + creation_time: "creation_time"; + id: "id"; + lead_gen_data: "lead_gen_data"; + matched_fields: "matched_fields"; + matched_fields_labels: "matched_fields_labels"; + resources: "resources"; + third_party_app_id: "third_party_app_id"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/lead-gen-draft-question.d.ts b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-draft-question.d.ts index 4d20ad5098e06a..2de32a0a626c0d 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/lead-gen-draft-question.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-draft-question.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * LeadGenDraftQuestion * @see {@link https://developers.facebook.com/docs/marketing-api/} 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 new file mode 100644 index 00000000000000..a6e847f0a1b274 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-form-preview-details.d.ts @@ -0,0 +1,42 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * LeadGenFormPreviewDetails + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class LeadGenFormPreviewDetails extends AbstractCrudObject { + static get Fields(): Readonly<{ + call_to_action_title: "call_to_action_title"; + contact_information_text: "contact_information_text"; + creatives_overview_default_text: "creatives_overview_default_text"; + data_privacy_policy_setting_description: "data_privacy_policy_setting_description"; + default_appointment_scheduling_inline_context: "default_appointment_scheduling_inline_context"; + default_disqualified_end_component: "default_disqualified_end_component"; + default_thank_you_page: "default_thank_you_page"; + disqualified_thank_you_card_transparency_info_text: "disqualified_thank_you_card_transparency_info_text"; + edit_text: "edit_text"; + email_inline_context_text: "email_inline_context_text"; + email_messenger_push_opt_in_disclaimer: "email_messenger_push_opt_in_disclaimer"; + email_messenger_push_opt_in_transparency_text: "email_messenger_push_opt_in_transparency_text"; + form_clarity_description_content: "form_clarity_description_content"; + form_clarity_description_title: "form_clarity_description_title"; + form_clarity_headline: "form_clarity_headline"; + gated_content_locked_description: "gated_content_locked_description"; + gated_content_locked_headline: "gated_content_locked_headline"; + gated_content_unlocked_description: "gated_content_unlocked_description"; + gated_content_unlocked_headline: "gated_content_unlocked_headline"; + how_it_works_section_headers: "how_it_works_section_headers"; + next_button_text: "next_button_text"; + optional_question_text: "optional_question_text"; + personal_info_text: "personal_info_text"; + phone_number_inline_context_text: "phone_number_inline_context_text"; + privacy_policy_title_section_title_text: "privacy_policy_title_section_title_text"; + privacy_setting_description: "privacy_setting_description"; + products_section_headers: "products_section_headers"; + qualified_thank_you_card_transparency_info_text: "qualified_thank_you_card_transparency_info_text"; + review_your_info_text: "review_your_info_text"; + secure_sharing_text: "secure_sharing_text"; + slide_to_submit_text: "slide_to_submit_text"; + social_proof_section_headers: "social_proof_section_headers"; + submit_button_text: "submit_button_text"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/lead-gen-legal-content-checkbox.d.ts b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-legal-content-checkbox.d.ts index fd51ba6bb947b3..10e1821261c7b8 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/lead-gen-legal-content-checkbox.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-legal-content-checkbox.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * LeadGenLegalContentCheckbox * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/lead-gen-legal-content.d.ts b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-legal-content.d.ts index fa88d829e786e8..7bfd6af4505c11 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/lead-gen-legal-content.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-legal-content.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * LeadGenLegalContent * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/lead-gen-post-submission-check-result.d.ts b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-post-submission-check-result.d.ts index fc4e7c9fc024b5..0c8610ecc6f456 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/lead-gen-post-submission-check-result.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-post-submission-check-result.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * LeadGenPostSubmissionCheckResult * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/lead-gen-privacy-policy.d.ts b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-privacy-policy.d.ts index 6d11ef5c1f2a24..827631ae2acd68 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/lead-gen-privacy-policy.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-privacy-policy.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * LeadGenPrivacyPolicy * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/lead-gen-question-option.d.ts b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-question-option.d.ts index 634b2a1c300314..490083395ad98b 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/lead-gen-question-option.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-question-option.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * LeadGenQuestionOption * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/lead-gen-question.d.ts b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-question.d.ts index 8b5bf6bfba1b1f..ab1c26512559e5 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/lead-gen-question.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-question.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * LeadGenQuestion * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/lead-gen-thank-you-page-gated-file.d.ts b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-thank-you-page-gated-file.d.ts new file mode 100644 index 00000000000000..ab0c89668bdfe0 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-thank-you-page-gated-file.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * LeadGenThankYouPageGatedFile + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class LeadGenThankYouPageGatedFile extends AbstractCrudObject { + static get Fields(): Readonly<{ + file_cdn_url: "file_cdn_url"; + file_name: "file_name"; + file_size_bytes: "file_size_bytes"; + id: "id"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/lead-gen-thank-you-page-gated-promo.d.ts b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-thank-you-page-gated-promo.d.ts new file mode 100644 index 00000000000000..138a3a6a73d6ce --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-thank-you-page-gated-promo.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * LeadGenThankYouPageGatedPromo + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class LeadGenThankYouPageGatedPromo extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + online_offer_url: "online_offer_url"; + online_promo_code: "online_promo_code"; + }>; +} 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 d415c4780594b3..b02534fa0da10c 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 @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * LeadGenThankYouPage * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/lead-gen-url-entity-at-ranges.d.ts b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-url-entity-at-ranges.d.ts index 950c281ed8a289..bcadf3e7b0c0b6 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/lead-gen-url-entity-at-ranges.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/lead-gen-url-entity-at-ranges.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * LeadGenURLEntityAtRanges * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/lead.d.ts b/types/facebook-nodejs-business-sdk/src/objects/lead.d.ts index cdf8e245b5ef63..0a75a90f4b17e4 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/lead.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/lead.d.ts @@ -1,5 +1,5 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; /** * Lead * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -26,6 +26,6 @@ export default class Lead extends AbstractCrudObject { retailer_item_id: "retailer_item_id"; vehicle: "vehicle"; }>; - delete(fields: string[], params?: Record): Promise; - get(fields: string[], params?: Record): Promise; + delete(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/leadgen-form.d.ts b/types/facebook-nodejs-business-sdk/src/objects/leadgen-form.d.ts index 44b98f4315d3e4..f3b06d9d67a6bc 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/leadgen-form.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/leadgen-form.d.ts @@ -1,6 +1,6 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import Cursor from './../cursor'; -import Lead from './lead'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; +import Lead from "./lead"; /** * LeadgenForm * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -71,13 +71,9 @@ export default class LeadgenForm extends AbstractCrudObject { zh_hk: "ZH_HK"; zh_tw: "ZH_TW"; }>; - getLeads(fields: string[], params?: Record): Promise; - getLeads(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getLeads(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getTestLeads(fields: string[], params?: Record): Promise; - getTestLeads(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getTestLeads(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createTestLead(fields: string[], params?: Record, pathOverride?: string | null): Promise; - get(fields: string[], params?: Record): Promise; - update(fields: string[], params?: Record): Promise; + getLeads(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getTestLeads(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createTestLead(fields: string[], params?: Record, pathOverride?: string | null): Promise; + get(fields: string[], params?: Record): Promise; + update(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/life-event.d.ts b/types/facebook-nodejs-business-sdk/src/objects/life-event.d.ts index f503b8ba40348b..1488861ecb7294 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/life-event.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/life-event.d.ts @@ -1,5 +1,5 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; /** * LifeEvent * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -15,8 +15,6 @@ export default class LifeEvent extends AbstractCrudObject { title: "title"; updated_time: "updated_time"; }>; - getLikes(fields: string[], params?: Record): Promise; - getLikes(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getLikes(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - get(fields: string[], params?: Record): Promise; + getLikes(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/link.d.ts b/types/facebook-nodejs-business-sdk/src/objects/link.d.ts index 60e4f36c432cfd..5efd9481a9c784 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/link.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/link.d.ts @@ -1,6 +1,6 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import Cursor from './../cursor'; -import Comment from './comment'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; +import Comment from "./comment"; /** * Link * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -20,9 +20,7 @@ export default class Link extends AbstractCrudObject { privacy: "privacy"; via: "via"; }>; - createComment(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getLikes(fields: string[], params?: Record): Promise; - getLikes(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getLikes(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - get(fields: string[], params?: Record): Promise; + createComment(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getLikes(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/linked-instagram-account-data.d.ts b/types/facebook-nodejs-business-sdk/src/objects/linked-instagram-account-data.d.ts new file mode 100644 index 00000000000000..17c83095a25369 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/linked-instagram-account-data.d.ts @@ -0,0 +1,15 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * LinkedInstagramAccountData + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class LinkedInstagramAccountData extends AbstractCrudObject { + static get Fields(): Readonly<{ + access_token: "access_token"; + analytics_claim: "analytics_claim"; + full_name: "full_name"; + profile_picture_url: "profile_picture_url"; + user_id: "user_id"; + user_name: "user_name"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/live-video-ad-break-config.d.ts b/types/facebook-nodejs-business-sdk/src/objects/live-video-ad-break-config.d.ts index 8497eb0f2b0695..523b7b00bae39f 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/live-video-ad-break-config.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/live-video-ad-break-config.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * LiveVideoAdBreakConfig * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/live-video-error.d.ts b/types/facebook-nodejs-business-sdk/src/objects/live-video-error.d.ts index d2200049fec80b..5f952d3e26991b 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/live-video-error.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/live-video-error.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * LiveVideoError * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -11,5 +11,5 @@ export default class LiveVideoError extends AbstractCrudObject { error_type: "error_type"; id: "id"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/live-video-input-stream.d.ts b/types/facebook-nodejs-business-sdk/src/objects/live-video-input-stream.d.ts index a10da21853c357..68750edbcd61d0 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/live-video-input-stream.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/live-video-input-stream.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * LiveVideoInputStream * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -14,5 +14,5 @@ export default class LiveVideoInputStream extends AbstractCrudObject { stream_id: "stream_id"; stream_url: "stream_url"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/live-video-recommended-encoder-settings.d.ts b/types/facebook-nodejs-business-sdk/src/objects/live-video-recommended-encoder-settings.d.ts index 758f813b01aff0..a40347de89bd0f 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/live-video-recommended-encoder-settings.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/live-video-recommended-encoder-settings.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * LiveVideoRecommendedEncoderSettings * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/live-video-targeting.d.ts b/types/facebook-nodejs-business-sdk/src/objects/live-video-targeting.d.ts index 49e3f0eec89059..ba990922c42393 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/live-video-targeting.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/live-video-targeting.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * LiveVideoTargeting * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/live-video.d.ts b/types/facebook-nodejs-business-sdk/src/objects/live-video.d.ts index 4fe96b1d00ff8e..0bf1f35691afdf 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/live-video.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/live-video.d.ts @@ -1,8 +1,8 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; -import Cursor from './../cursor'; -import LiveVideoInputStream from './live-video-input-stream'; -import VideoPoll from './video-poll'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; +import Cursor from "./../cursor"; +import LiveVideoInputStream from "./live-video-input-stream"; +import VideoPoll from "./video-poll"; /** * LiveVideo * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -93,30 +93,16 @@ export default class LiveVideo extends AbstractCrudObject { enable: "ENABLE"; regenerate: "REGENERATE"; }>; - getBlockedUsers(fields: string[], params?: Record): Promise; - getBlockedUsers(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getBlockedUsers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getComments(fields: string[], params?: Record): Promise; - getComments(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getComments(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getCrosspostSharedPages(fields: string[], params?: Record): Promise; - getCrosspostSharedPages(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCrosspostSharedPages(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getCrosspostedBroadcasts(fields: string[], params?: Record): Promise; - getCrosspostedBroadcasts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCrosspostedBroadcasts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getErrors(fields: string[], params?: Record): Promise; - getErrors(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getErrors(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createInputStream(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getPolls(fields: string[], params?: Record): Promise; - getPolls(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPolls(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createPoll(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getReactions(fields: string[], params?: Record): Promise; - getReactions(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getReactions(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; + getBlockedUsers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getComments(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getCrosspostShareDPages(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getCrosspostedBroadcasts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getErrors(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createInputStream(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getPolls(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createPoll(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getReactions(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/local-service-business.d.ts b/types/facebook-nodejs-business-sdk/src/objects/local-service-business.d.ts index ecbb073de045ca..48add960b2bcba 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/local-service-business.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/local-service-business.d.ts @@ -1,5 +1,5 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; /** * LocalServiceBusiness * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -40,6 +40,7 @@ export default class LocalServiceBusiness extends AbstractCrudObject { retailer_category: "retailer_category"; sanitized_images: "sanitized_images"; size: "size"; + tags: "tags"; title: "title"; unit_price: "unit_price"; url: "url"; @@ -77,8 +78,6 @@ export default class LocalServiceBusiness extends AbstractCrudObject { published: "PUBLISHED"; staging: "STAGING"; }>; - getChannelsToIntegrityStatus(fields: string[], params?: Record): Promise; - getChannelsToIntegrityStatus(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getChannelsToIntegrityStatus(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - get(fields: string[], params?: Record): Promise; + getChannelsToIntegrityStatus(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/location-based-item.d.ts b/types/facebook-nodejs-business-sdk/src/objects/location-based-item.d.ts new file mode 100644 index 00000000000000..5f8cb7853a9ab3 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/location-based-item.d.ts @@ -0,0 +1,37 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; +/** + * LocationBasedItem + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class LocationBasedItem extends AbstractCrudObject { + static get Fields(): Readonly<{ + applinks: "applinks"; + category_specific_fields: "category_specific_fields"; + currency: "currency"; + description: "description"; + id: "id"; + image_fetch_status: "image_fetch_status"; + images: "images"; + location_based_item_id: "location_based_item_id"; + name: "name"; + price: "price"; + sanitized_images: "sanitized_images"; + url: "url"; + visibility: "visibility"; + }>; + static get ImageFetchStatus(): Readonly<{ + direct_upload: "DIRECT_UPLOAD"; + fetched: "FETCHED"; + fetch_failed: "FETCH_FAILED"; + no_status: "NO_STATUS"; + outdated: "OUTDATED"; + partial_fetch: "PARTIAL_FETCH"; + }>; + static get Visibility(): Readonly<{ + published: "PUBLISHED"; + staging: "STAGING"; + }>; + getChannelsToIntegrityStatus(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/location.d.ts b/types/facebook-nodejs-business-sdk/src/objects/location.d.ts index dc2e1c29afc628..f39bbdf419849c 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/location.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/location.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * Location * @see {@link https://developers.facebook.com/docs/marketing-api/} 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 56bfba42a6e3df..2ffa230917f0aa 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 @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * LookalikeSpec * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/dataset.d.ts b/types/facebook-nodejs-business-sdk/src/objects/loom-config.d.ts similarity index 50% rename from types/facebook-nodejs-business-sdk/src/objects/dataset.d.ts rename to types/facebook-nodejs-business-sdk/src/objects/loom-config.d.ts index bbc3b619dc230b..d01d5c046ef288 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/dataset.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/loom-config.d.ts @@ -1,9 +1,9 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** - * Dataset + * LoomConfig * @see {@link https://developers.facebook.com/docs/marketing-api/} */ -export default class Dataset extends AbstractCrudObject { +export default class LoomConfig extends AbstractCrudObject { static get Fields(): Readonly<{ id: "id"; }>; diff --git a/types/facebook-nodejs-business-sdk/src/objects/mailing-address.d.ts b/types/facebook-nodejs-business-sdk/src/objects/mailing-address.d.ts index 32e757be72857b..a37d8741e9225d 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/mailing-address.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/mailing-address.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * MailingAddress * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -14,5 +14,5 @@ export default class MailingAddress extends AbstractCrudObject { street1: "street1"; street2: "street2"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } 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 e4622003e023ce..526f0e0853edb7 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 @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ManagedPartnerBusiness * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/managed-partner-extended-credit.d.ts b/types/facebook-nodejs-business-sdk/src/objects/managed-partner-extended-credit.d.ts index db11bf84166d2b..ef9b55943b83c9 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/managed-partner-extended-credit.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/managed-partner-extended-credit.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ManagedPartnerExtendedCredit * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/marketing-message-targeting.d.ts b/types/facebook-nodejs-business-sdk/src/objects/marketing-message-targeting.d.ts new file mode 100644 index 00000000000000..b74cc2a666f180 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/marketing-message-targeting.d.ts @@ -0,0 +1,14 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * MarketingMessageTargeting + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class MarketingMessageTargeting extends AbstractCrudObject { + static get Fields(): Readonly<{ + automation_type: "automation_type"; + delay_send_time_second: "delay_send_time_second"; + delay_send_time_unit: "delay_send_time_unit"; + subscriber_lists: "subscriber_lists"; + targeting_rules: "targeting_rules"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/mc-experience-config-for-api.d.ts b/types/facebook-nodejs-business-sdk/src/objects/mc-experience-config-for-api.d.ts new file mode 100644 index 00000000000000..c7dd42f7afca54 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/mc-experience-config-for-api.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * MCExperienceConfigForApi + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class MCExperienceConfigForApi extends AbstractCrudObject { + static get Fields(): Readonly<{ + is_campaign_enabled: "is_campaign_enabled"; + is_terms_signed: "is_terms_signed"; + merchant_type: "merchant_type"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/mcom-invoice-bank-account.d.ts b/types/facebook-nodejs-business-sdk/src/objects/mcom-invoice-bank-account.d.ts new file mode 100644 index 00000000000000..53d05df13964cb --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/mcom-invoice-bank-account.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * McomInvoiceBankAccount + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class McomInvoiceBankAccount extends AbstractCrudObject { + static get Fields(): Readonly<{ + num_pending_verification_accounts: "num_pending_verification_accounts"; + num_verified_accounts: "num_verified_accounts"; + pending_verification_accounts: "pending_verification_accounts"; + verified_accounts: "verified_accounts"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/mcom-invoice-details.d.ts b/types/facebook-nodejs-business-sdk/src/objects/mcom-invoice-details.d.ts new file mode 100644 index 00000000000000..cc0b4295ff853e --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/mcom-invoice-details.d.ts @@ -0,0 +1,28 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * McomInvoiceDetails + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class McomInvoiceDetails extends AbstractCrudObject { + static get Fields(): Readonly<{ + additional_amounts: "additional_amounts"; + buyer_notes: "buyer_notes"; + currency_amount: "currency_amount"; + external_invoice_id: "external_invoice_id"; + features: "features"; + invoice_created: "invoice_created"; + invoice_id: "invoice_id"; + invoice_instructions: "invoice_instructions"; + invoice_instructions_image_url: "invoice_instructions_image_url"; + invoice_updated: "invoice_updated"; + outstanding_amount: "outstanding_amount"; + paid_amount: "paid_amount"; + payments: "payments"; + platform_logo_url: "platform_logo_url"; + platform_name: "platform_name"; + product_items: "product_items"; + shipping_address: "shipping_address"; + status: "status"; + tracking_info: "tracking_info"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/mcom-invoice-lists.d.ts b/types/facebook-nodejs-business-sdk/src/objects/mcom-invoice-lists.d.ts new file mode 100644 index 00000000000000..2dc053e50d048a --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/mcom-invoice-lists.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * McomInvoiceLists + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class McomInvoiceLists extends AbstractCrudObject { + static get Fields(): Readonly<{ + invoice_details: "invoice_details"; + invoice_ids: "invoice_ids"; + page_id: "page_id"; + }>; +} 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 new file mode 100644 index 00000000000000..edf8819c0c0bc9 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/mcom-invoice-status.d.ts @@ -0,0 +1,21 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * McomInvoiceStatus + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class McomInvoiceStatus extends AbstractCrudObject { + static get Fields(): Readonly<{ + bank_account_number: "bank_account_number"; + bank_code: "bank_code"; + invoice_id: "invoice_id"; + invoice_status: "invoice_status"; + page_id: "page_id"; + payment_method: "payment_method"; + payment_type: "payment_type"; + payout_amount: "payout_amount"; + slip_verification_error: "slip_verification_error"; + slip_verification_status: "slip_verification_status"; + transaction_fee: "transaction_fee"; + transfer_slip: "transfer_slip"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/mcom-onboarding-status.d.ts b/types/facebook-nodejs-business-sdk/src/objects/mcom-onboarding-status.d.ts new file mode 100644 index 00000000000000..23f49b61255ffa --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/mcom-onboarding-status.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * McomOnboardingStatus + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class McomOnboardingStatus extends AbstractCrudObject { + static get Fields(): Readonly<{ + onboarding_status: "onboarding_status"; + page_id: "page_id"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/mcom-payouts.d.ts b/types/facebook-nodejs-business-sdk/src/objects/mcom-payouts.d.ts new file mode 100644 index 00000000000000..30b1a2d5373a4d --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/mcom-payouts.d.ts @@ -0,0 +1,16 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * McomPayouts + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class McomPayouts extends AbstractCrudObject { + static get Fields(): Readonly<{ + number_of_orders: "number_of_orders"; + order_ids: "order_ids"; + payout_amount: "payout_amount"; + payout_provider_reference_id: "payout_provider_reference_id"; + payout_status: "payout_status"; + payout_time: "payout_time"; + provider: "provider"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/measurement-report.d.ts b/types/facebook-nodejs-business-sdk/src/objects/measurement-report.d.ts new file mode 100644 index 00000000000000..5d7010fba303ff --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/measurement-report.d.ts @@ -0,0 +1,15 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * MeasurementReport + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class MeasurementReport extends AbstractCrudObject { + static get Fields(): Readonly<{ + download_urls: "download_urls"; + id: "id"; + metadata: "metadata"; + report_type: "report_type"; + status: "status"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/media-copyright-attribution.d.ts b/types/facebook-nodejs-business-sdk/src/objects/media-copyright-attribution.d.ts new file mode 100644 index 00000000000000..69de9d05cdfc88 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/media-copyright-attribution.d.ts @@ -0,0 +1,26 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * MediaCopyrightAttribution + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class MediaCopyrightAttribution extends AbstractCrudObject { + static get Fields(): Readonly<{ + attribution_ig_target_id: "attribution_ig_target_id"; + attribution_target_email_address: "attribution_target_email_address"; + attribution_target_id: "attribution_target_id"; + attribution_target_name: "attribution_target_name"; + attribution_type: "attribution_type"; + attribution_uri: "attribution_uri"; + copyright_count: "copyright_count"; + creation_time: "creation_time"; + creator: "creator"; + id: "id"; + is_enabled: "is_enabled"; + link_title: "link_title"; + match_count: "match_count"; + owner: "owner"; + status: "status"; + title: "title"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/media-copyright-update-record.d.ts b/types/facebook-nodejs-business-sdk/src/objects/media-copyright-update-record.d.ts new file mode 100644 index 00000000000000..42e78aee304bfa --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/media-copyright-update-record.d.ts @@ -0,0 +1,17 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * MediaCopyrightUpdateRecord + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class MediaCopyrightUpdateRecord extends AbstractCrudObject { + static get Fields(): Readonly<{ + action_types: "action_types"; + actor: "actor"; + actor_type: "actor_type"; + creation_time: "creation_time"; + id: "id"; + ownership_countries: "ownership_countries"; + whitelisted_accounts: "whitelisted_accounts"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/media-fingerprint.d.ts b/types/facebook-nodejs-business-sdk/src/objects/media-fingerprint.d.ts index 70bd2a91fca4da..cde1d9f18373ff 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/media-fingerprint.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/media-fingerprint.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * MediaFingerprint * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -20,6 +20,6 @@ export default class MediaFingerprint extends AbstractCrudObject { other: "OTHER"; songtrack: "SONGTRACK"; }>; - get(fields: string[], params?: Record): Promise; - update(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/media-title.d.ts b/types/facebook-nodejs-business-sdk/src/objects/media-title.d.ts index e4c2ba3160e7ee..caf369eb8da270 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/media-title.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/media-title.d.ts @@ -1,6 +1,6 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; +import Cursor from "./../cursor"; /** * MediaTitle * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -46,16 +46,10 @@ export default class MediaTitle extends AbstractCrudObject { music: "MUSIC"; tv_show: "TV_SHOW"; }>; - getAugmentedRealitiesMetadata(fields: string[], params?: Record): Promise; - getAugmentedRealitiesMetadata(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAugmentedRealitiesMetadata(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getChannelsToIntegrityStatus(fields: string[], params?: Record): Promise; - getChannelsToIntegrityStatus(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getChannelsToIntegrityStatus(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getVideosMetadata(fields: string[], params?: Record): Promise; - getVideosMetadata(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getVideosMetadata(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; + getAugmentedRealitiesMetadata(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getChannelsToIntegrityStatus(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getVideosMetadata(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/merchant-compliance.d.ts b/types/facebook-nodejs-business-sdk/src/objects/merchant-compliance.d.ts new file mode 100644 index 00000000000000..69e0577f7d69de --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/merchant-compliance.d.ts @@ -0,0 +1,14 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * MerchantCompliance + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class MerchantCompliance extends AbstractCrudObject { + static get Fields(): Readonly<{ + active_campaigns: "active_campaigns"; + compliance_status: "compliance_status"; + count_down_start_time: "count_down_start_time"; + purchase: "purchase"; + purchase_conversion_value: "purchase_conversion_value"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/merchant-report.d.ts b/types/facebook-nodejs-business-sdk/src/objects/merchant-report.d.ts new file mode 100644 index 00000000000000..969df093ac9d5f --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/merchant-report.d.ts @@ -0,0 +1,24 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * MerchantReport + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class MerchantReport extends AbstractCrudObject { + static get Fields(): Readonly<{ + add_to_cart: "add_to_cart"; + brand: "brand"; + catalog_segment_id: "catalog_segment_id"; + catalog_segment_purchase_value: "catalog_segment_purchase_value"; + category: "category"; + date: "date"; + latest_date: "latest_date"; + link_clicks: "link_clicks"; + merchant_currency: "merchant_currency"; + page_id: "page_id"; + product_id: "product_id"; + product_quantity: "product_quantity"; + product_total_value: "product_total_value"; + purchase: "purchase"; + purchase_value: "purchase_value"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/messaging-apps-info.d.ts b/types/facebook-nodejs-business-sdk/src/objects/messaging-apps-info.d.ts new file mode 100644 index 00000000000000..0504b3e13ab747 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/messaging-apps-info.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * MessagingAppsInfo + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class MessagingAppsInfo extends AbstractCrudObject { + static get Fields(): Readonly<{ + has_instagram_messaging_permission: "has_instagram_messaging_permission"; + has_messenger_messaging_permission: "has_messenger_messaging_permission"; + id: "id"; + name: "name"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/messaging-feature-review.d.ts b/types/facebook-nodejs-business-sdk/src/objects/messaging-feature-review.d.ts index 9ab9bb719c7d26..081e3186823037 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/messaging-feature-review.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/messaging-feature-review.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * MessagingFeatureReview * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/messaging-feature-status.d.ts b/types/facebook-nodejs-business-sdk/src/objects/messaging-feature-status.d.ts index 30b286df0a02c1..7c2eb510315363 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/messaging-feature-status.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/messaging-feature-status.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * MessagingFeatureStatus * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/messenger-ads-partial-automated-step-list.d.ts b/types/facebook-nodejs-business-sdk/src/objects/messenger-ads-partial-automated-step-list.d.ts index a3797f21971914..284262ffdf478e 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/messenger-ads-partial-automated-step-list.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/messenger-ads-partial-automated-step-list.d.ts @@ -1,5 +1,5 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; /** * MessengerAdsPartialAutomatedStepList * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -14,8 +14,6 @@ export default class MessengerAdsPartialAutomatedStepList extends AbstractCrudOb reminder_text: "reminder_text"; stop_question_message: "stop_question_message"; }>; - getSteps(fields: string[], params?: Record): Promise; - getSteps(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getSteps(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - get(fields: string[], params?: Record): Promise; + getSteps(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + get(fields: string[], params?: Record): Promise; } 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 new file mode 100644 index 00000000000000..c993d0f8b0cc60 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/messenger-call-settings.d.ts @@ -0,0 +1,10 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * MessengerCallSettings + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class MessengerCallSettings extends AbstractCrudObject { + static get Fields(): Readonly<{ + audio_enabled: "audio_enabled"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/messenger-destination-page-welcome-message.d.ts b/types/facebook-nodejs-business-sdk/src/objects/messenger-destination-page-welcome-message.d.ts new file mode 100644 index 00000000000000..8bb1d1e19fabdf --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/messenger-destination-page-welcome-message.d.ts @@ -0,0 +1,15 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * MessengerDestinationPageWelcomeMessage + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class MessengerDestinationPageWelcomeMessage extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + page_welcome_message_body: "page_welcome_message_body"; + page_welcome_message_type: "page_welcome_message_type"; + template_name: "template_name"; + time_created: "time_created"; + time_last_used: "time_last_used"; + }>; +} 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 8f909a17b65f00..b88153cf574c10 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 @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * MessengerProfile * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -6,6 +6,7 @@ import { AbstractCrudObject } from './../abstract-crud-object'; export default class MessengerProfile extends AbstractCrudObject { static get Fields(): Readonly<{ account_linking_url: "account_linking_url"; + commands: "commands"; get_started: "get_started"; greeting: "greeting"; ice_breakers: "ice_breakers"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/minimum-budget.d.ts b/types/facebook-nodejs-business-sdk/src/objects/minimum-budget.d.ts index c5c70887c33e3b..ef6759de7248a5 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/minimum-budget.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/minimum-budget.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * MinimumBudget * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/mix-insights-result.d.ts b/types/facebook-nodejs-business-sdk/src/objects/mix-insights-result.d.ts new file mode 100644 index 00000000000000..98b3d26e1984d7 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/mix-insights-result.d.ts @@ -0,0 +1,30 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * MIXInsightsResult + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class MIXInsightsResult extends AbstractCrudObject { + static get Fields(): Readonly<{ + daily_age_gender_breakdown: "daily_age_gender_breakdown"; + daily_audio_library_values: "daily_audio_library_values"; + daily_ugc_values: "daily_ugc_values"; + daily_values: "daily_values"; + metric: "metric"; + monthly_audio_library_values: "monthly_audio_library_values"; + monthly_ugc_values: "monthly_ugc_values"; + monthly_values: "monthly_values"; + percent_growth: "percent_growth"; + shielded_fields: "shielded_fields"; + total_age_gender_breakdown: "total_age_gender_breakdown"; + total_audio_library_value: "total_audio_library_value"; + total_country_breakdown: "total_country_breakdown"; + total_locale_breakdown: "total_locale_breakdown"; + total_product_breakdown: "total_product_breakdown"; + total_ugc_value: "total_ugc_value"; + total_value: "total_value"; + trending_age: "trending_age"; + trending_gender: "trending_gender"; + trending_interest: "trending_interest"; + trending_territory: "trending_territory"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/music-video-copyright.d.ts b/types/facebook-nodejs-business-sdk/src/objects/music-video-copyright.d.ts index b93d72af9b820e..c914ed9556b53d 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/music-video-copyright.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/music-video-copyright.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * MusicVideoCopyright * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -20,5 +20,5 @@ export default class MusicVideoCopyright extends AbstractCrudObject { whitelisted_fb_users: "whitelisted_fb_users"; whitelisted_ig_users: "whitelisted_ig_users"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/music-work-copyright.d.ts b/types/facebook-nodejs-business-sdk/src/objects/music-work-copyright.d.ts new file mode 100644 index 00000000000000..d214571f50e6ff --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/music-work-copyright.d.ts @@ -0,0 +1,21 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * MusicWorkCopyright + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class MusicWorkCopyright extends AbstractCrudObject { + static get Fields(): Readonly<{ + available_ui_actions: "available_ui_actions"; + claim_status: "claim_status"; + creation_time: "creation_time"; + displayed_fb_matches_count: "displayed_fb_matches_count"; + displayed_ig_matches_count: "displayed_ig_matches_count"; + displayed_matches_count: "displayed_matches_count"; + id: "id"; + match_rule: "match_rule"; + status: "status"; + tags: "tags"; + update_time: "update_time"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/negative-keyword-list.d.ts b/types/facebook-nodejs-business-sdk/src/objects/negative-keyword-list.d.ts new file mode 100644 index 00000000000000..69d18ed49fe75f --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/negative-keyword-list.d.ts @@ -0,0 +1,23 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * NegativeKeywordList + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class NegativeKeywordList extends AbstractCrudObject { + static get Fields(): Readonly<{ + applied_active_ad_campaign_groups: "applied_active_ad_campaign_groups"; + applied_inactive_ad_campaign_groups: "applied_inactive_ad_campaign_groups"; + creator_id: "creator_id"; + id: "id"; + is_fully_reviewed: "is_fully_reviewed"; + last_update_time: "last_update_time"; + last_update_user_id: "last_update_user_id"; + list_name: "list_name"; + total_approved_keyword_count: "total_approved_keyword_count"; + total_declined_keyword_count: "total_declined_keyword_count"; + total_negative_keyword_count: "total_negative_keyword_count"; + total_validated_keyword_count: "total_validated_keyword_count"; + }>; + get(fields: string[], params?: Record): Promise; + update(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/null-node.d.ts b/types/facebook-nodejs-business-sdk/src/objects/null-node.d.ts index 020e928700909c..57427de2d90ca6 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/null-node.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/null-node.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * NullNode * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/offline-conversion-data-set-activities.d.ts b/types/facebook-nodejs-business-sdk/src/objects/offline-conversion-data-set-activities.d.ts new file mode 100644 index 00000000000000..4fecd451d35416 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/offline-conversion-data-set-activities.d.ts @@ -0,0 +1,18 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * OfflineConversionDataSetActivities + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class OfflineConversionDataSetActivities extends AbstractCrudObject { + static get Fields(): Readonly<{ + actor_id: "actor_id"; + actor_name: "actor_name"; + adaccount_id: "adaccount_id"; + adaccount_name: "adaccount_name"; + event_time: "event_time"; + event_type: "event_type"; + extra_data: "extra_data"; + object_id: "object_id"; + object_name: "object_name"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/offline-conversion-data-set-optimization-status.d.ts b/types/facebook-nodejs-business-sdk/src/objects/offline-conversion-data-set-optimization-status.d.ts new file mode 100644 index 00000000000000..7e69cb2ffc066e --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/offline-conversion-data-set-optimization-status.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * OfflineConversionDataSetOptimizationStatus + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class OfflineConversionDataSetOptimizationStatus extends AbstractCrudObject { + static get Fields(): Readonly<{ + event: "event"; + last_changed_time: "last_changed_time"; + last_detected_time: "last_detected_time"; + status: "status"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/offline-conversion-data-set-permissions.d.ts b/types/facebook-nodejs-business-sdk/src/objects/offline-conversion-data-set-permissions.d.ts index 6d6c4deeb5eb6e..8a3c0b05755ef3 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/offline-conversion-data-set-permissions.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/offline-conversion-data-set-permissions.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * OfflineConversionDataSetPermissions * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/offline-conversion-data-set-upload.d.ts b/types/facebook-nodejs-business-sdk/src/objects/offline-conversion-data-set-upload.d.ts index 748f24a0b41482..eedaf09932ebe4 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/offline-conversion-data-set-upload.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/offline-conversion-data-set-upload.d.ts @@ -1,5 +1,5 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; /** * OfflineConversionDataSetUpload * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -34,11 +34,7 @@ export default class OfflineConversionDataSetUpload extends AbstractCrudObject { is_excluded_for_lift: "IS_EXCLUDED_FOR_LIFT"; last_upload_time: "LAST_UPLOAD_TIME"; }>; - getProgress(fields: string[], params?: Record): Promise; - getProgress(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getProgress(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getPullSessions(fields: string[], params?: Record): Promise; - getPullSessions(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPullSessions(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - get(fields: string[], params?: Record): Promise; + getProgress(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getPullSessions(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/offline-conversion-data-set-usage.d.ts b/types/facebook-nodejs-business-sdk/src/objects/offline-conversion-data-set-usage.d.ts index 39bd0fcec692b2..8180a1c9282ea2 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/offline-conversion-data-set-usage.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/offline-conversion-data-set-usage.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * OfflineConversionDataSetUsage * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/offline-conversion-data-set.d.ts b/types/facebook-nodejs-business-sdk/src/objects/offline-conversion-data-set.d.ts index 6f455e7e217927..d3f34a5326c06e 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/offline-conversion-data-set.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/offline-conversion-data-set.d.ts @@ -1,7 +1,5 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; -import Cursor from './../cursor'; -import OfflineConversionDataSetUpload from './offline-conversion-data-set-upload'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; /** * OfflineConversionDataSet * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -41,50 +39,14 @@ export default class OfflineConversionDataSet extends AbstractCrudObject { usage: "usage"; valid_entries: "valid_entries"; }>; - static get PermittedRoles(): Readonly<{ - admin: "ADMIN"; - advertiser: "ADVERTISER"; - uploader: "UPLOADER"; - }>; - static get RelationshipType(): Readonly<{ - ad_manager: "AD_MANAGER"; - agency: "AGENCY"; - aggregator: "AGGREGATOR"; - audience_manager: "AUDIENCE_MANAGER"; - other: "OTHER"; - }>; - getAdAccounts(fields: string[], params?: Record): Promise; - getAdAccounts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createAdAccount(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getAgencies(fields: string[], params?: Record): Promise; - getAgencies(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAgencies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createAgency(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getAudiences(fields: string[], params?: Record): Promise; - getAudiences(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAudiences(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getCustomConversions(fields: string[], params?: Record): Promise; - getCustomConversions(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCustomConversions(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getServerEventsPermittedBusiness(fields: string[], params?: Record): Promise; - getServerEventsPermittedBusiness(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getServerEventsPermittedBusiness(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getSharedAccounts(fields: string[], params?: Record): Promise; - getSharedAccounts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getSharedAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getSharedAgencies(fields: string[], params?: Record): Promise; - getSharedAgencies(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getSharedAgencies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getStats(fields: string[], params?: Record): Promise; - getStats(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getStats(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getUploads(fields: string[], params?: Record): Promise; - getUploads(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getUploads(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createUpload(fields: string[], params?: Record, pathOverride?: string | null): Promise; - createValidate(fields: string[], params?: Record, pathOverride?: string | null): Promise; - delete(fields: string[], params?: Record): Promise; - get(fields: string[], params?: Record): Promise; - update(fields: string[], params?: Record): Promise; + getAdAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getAgencies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getAudiences(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getCustomConversions(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getServerEventsPermittedBusiness(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getShareDAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getShareDAgencies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getStats(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getUploads(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/offline-product-item.d.ts b/types/facebook-nodejs-business-sdk/src/objects/offline-product-item.d.ts new file mode 100644 index 00000000000000..0752340d368bf2 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/offline-product-item.d.ts @@ -0,0 +1,40 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; +/** + * OfflineProductItem + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class OfflineProductItem extends AbstractCrudObject { + static get Fields(): Readonly<{ + applinks: "applinks"; + brand: "brand"; + category: "category"; + category_specific_fields: "category_specific_fields"; + currency: "currency"; + description: "description"; + id: "id"; + image_fetch_status: "image_fetch_status"; + image_url: "image_url"; + images: "images"; + name: "name"; + offline_product_item_id: "offline_product_item_id"; + price: "price"; + sanitized_images: "sanitized_images"; + url: "url"; + visibility: "visibility"; + }>; + static get ImageFetchStatus(): Readonly<{ + direct_upload: "DIRECT_UPLOAD"; + fetched: "FETCHED"; + fetch_failed: "FETCH_FAILED"; + no_status: "NO_STATUS"; + outdated: "OUTDATED"; + partial_fetch: "PARTIAL_FETCH"; + }>; + static get Visibility(): Readonly<{ + published: "PUBLISHED"; + staging: "STAGING"; + }>; + getChannelsToIntegrityStatus(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/offline-terms-of-service.d.ts b/types/facebook-nodejs-business-sdk/src/objects/offline-terms-of-service.d.ts new file mode 100644 index 00000000000000..401ff07eb2784d --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/offline-terms-of-service.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * OfflineTermsOfService + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class OfflineTermsOfService extends AbstractCrudObject { + static get Fields(): Readonly<{ + accept_time: "accept_time"; + id: "id"; + signed_by_user: "signed_by_user"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/offsite-pixel.d.ts b/types/facebook-nodejs-business-sdk/src/objects/offsite-pixel.d.ts index 775c95a38dde64..4aab73d7954f5e 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/offsite-pixel.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/offsite-pixel.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * OffsitePixel * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -12,5 +12,5 @@ export default class OffsitePixel extends AbstractCrudObject { name: "name"; tag: "tag"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/offsite-signal-container-business-object.d.ts b/types/facebook-nodejs-business-sdk/src/objects/offsite-signal-container-business-object.d.ts new file mode 100644 index 00000000000000..31540a65c28494 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/offsite-signal-container-business-object.d.ts @@ -0,0 +1,20 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; +/** + * OffsiteSignalContainerBusinessObject + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class OffsiteSignalContainerBusinessObject extends AbstractCrudObject { + static get Fields(): Readonly<{ + business: "business"; + id: "id"; + is_eligible_for_sharing_to_ad_account: "is_eligible_for_sharing_to_ad_account"; + is_eligible_for_sharing_to_business: "is_eligible_for_sharing_to_business"; + is_unavailable: "is_unavailable"; + name: "name"; + primary_container_id: "primary_container_id"; + }>; + getLinkedApplication(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getLinkedPage(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + get(fields: string[], params?: Record): Promise; +} 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 ad9d62555a8976..856b7662c199b8 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 @@ -1,5 +1,5 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; /** * OmegaCustomerTrx * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -32,8 +32,6 @@ export default class OmegaCustomerTrx extends AbstractCrudObject { inv: "INV"; pro_forma: "PRO_FORMA"; }>; - getCampaigns(fields: string[], params?: Record): Promise; - getCampaigns(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCampaigns(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - get(fields: string[], params?: Record): Promise; + getCampaigns(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + get(fields: string[], params?: Record): Promise; } 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 ca9df3cafcabeb..b6a5c1827701c9 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 @@ -1,12 +1,11 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; /** * OpenBridgeConfiguration * @see {@link https://developers.facebook.com/docs/marketing-api/} */ export default class OpenBridgeConfiguration extends AbstractCrudObject { static get Fields(): Readonly<{ - access_key: "access_key"; active: "active"; endpoint: "endpoint"; fallback_domain: "fallback_domain"; @@ -14,9 +13,10 @@ export default class OpenBridgeConfiguration extends AbstractCrudObject { host_business_id: "host_business_id"; host_external_id: "host_external_id"; id: "id"; + instance_id: "instance_id"; pixel_id: "pixel_id"; }>; - delete(fields: string[], params?: Record): Promise; - get(fields: string[], params?: Record): Promise; - update(fields: string[], params?: Record): 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/open-graph-context.d.ts b/types/facebook-nodejs-business-sdk/src/objects/open-graph-context.d.ts index 816737022ae993..17807cf10585a0 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/open-graph-context.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/open-graph-context.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * OpenGraphContext * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -7,5 +7,5 @@ export default class OpenGraphContext extends AbstractCrudObject { static get Fields(): Readonly<{ id: "id"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/order-id-attributions.d.ts b/types/facebook-nodejs-business-sdk/src/objects/order-id-attributions.d.ts new file mode 100644 index 00000000000000..4e24ddf80c5a23 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/order-id-attributions.d.ts @@ -0,0 +1,18 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * OrderIDAttributions + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class OrderIDAttributions extends AbstractCrudObject { + static get Fields(): Readonly<{ + app_id: "app_id"; + attribution_type: "attribution_type"; + attributions: "attributions"; + conversion_device: "conversion_device"; + dataset_id: "dataset_id"; + holdout_status: "holdout_status"; + order_id: "order_id"; + order_timestamp: "order_timestamp"; + pixel_id: "pixel_id"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/organization.d.ts b/types/facebook-nodejs-business-sdk/src/objects/organization.d.ts new file mode 100644 index 00000000000000..e65740a3b80d29 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/organization.d.ts @@ -0,0 +1,15 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * Organization + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +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/outcome-prediction-point.d.ts b/types/facebook-nodejs-business-sdk/src/objects/outcome-prediction-point.d.ts index 256f11b5ebe309..bd61c1e04406bf 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/outcome-prediction-point.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/outcome-prediction-point.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * OutcomePredictionPoint * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/owned-domain.d.ts b/types/facebook-nodejs-business-sdk/src/objects/owned-domain.d.ts new file mode 100644 index 00000000000000..11d0f65675f916 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/owned-domain.d.ts @@ -0,0 +1,15 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * OwnedDomain + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class OwnedDomain extends AbstractCrudObject { + static get Fields(): Readonly<{ + domain_name: "domain_name"; + id: "id"; + owner_business: "owner_business"; + status: "status"; + verification_code: "verification_code"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/p2-m-invoice-payments.d.ts b/types/facebook-nodejs-business-sdk/src/objects/p2-m-invoice-payments.d.ts new file mode 100644 index 00000000000000..2170e86d80948c --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/p2-m-invoice-payments.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * P2MInvoicePayments + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class P2MInvoicePayments extends AbstractCrudObject { + static get Fields(): Readonly<{ + page_id: "page_id"; + payments: "payments"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/page-about-story-composed-block-entity-ranges.d.ts b/types/facebook-nodejs-business-sdk/src/objects/page-about-story-composed-block-entity-ranges.d.ts index 9b7304e752a490..9b84b844ef107c 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/page-about-story-composed-block-entity-ranges.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/page-about-story-composed-block-entity-ranges.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * PageAboutStoryComposedBlockEntityRanges * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/page-about-story-composed-block-inline-style.d.ts b/types/facebook-nodejs-business-sdk/src/objects/page-about-story-composed-block-inline-style.d.ts index 0118c15773ca56..247d90ba6ac9ae 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/page-about-story-composed-block-inline-style.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/page-about-story-composed-block-inline-style.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * PageAboutStoryComposedBlockInlineStyle * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/page-about-story-composed-block.d.ts b/types/facebook-nodejs-business-sdk/src/objects/page-about-story-composed-block.d.ts index 75ea1a8c3429fe..8b76f1909ad6aa 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/page-about-story-composed-block.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/page-about-story-composed-block.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * PageAboutStoryComposedBlock * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/page-about-story.d.ts b/types/facebook-nodejs-business-sdk/src/objects/page-about-story.d.ts deleted file mode 100644 index 682afa5aebb40c..00000000000000 --- a/types/facebook-nodejs-business-sdk/src/objects/page-about-story.d.ts +++ /dev/null @@ -1,17 +0,0 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -/** - * PageAboutStory - * @see {@link https://developers.facebook.com/docs/marketing-api/} - */ -export default class PageAboutStory extends AbstractCrudObject { - static get Fields(): Readonly<{ - composed_text: "composed_text"; - cover_photo: "cover_photo"; - entity_map: "entity_map"; - id: "id"; - is_published: "is_published"; - page_id: "page_id"; - title: "title"; - }>; - get(fields: string[], params?: Record): Promise; -} diff --git a/types/facebook-nodejs-business-sdk/src/objects/page-app-with-leads-access.d.ts b/types/facebook-nodejs-business-sdk/src/objects/page-app-with-leads-access.d.ts new file mode 100644 index 00000000000000..bcf161af34c3d5 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/page-app-with-leads-access.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * PageAppWithLeadsAccess + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class PageAppWithLeadsAccess extends AbstractCrudObject { + static get Fields(): Readonly<{ + can_access_leads: "can_access_leads"; + type: "type"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/page-broadcast.d.ts b/types/facebook-nodejs-business-sdk/src/objects/page-broadcast.d.ts new file mode 100644 index 00000000000000..c41a3075b5b41c --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/page-broadcast.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * PageBroadcast + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class PageBroadcast extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + scheduled_time: "scheduled_time"; + status: "status"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/page-call-to-action.d.ts b/types/facebook-nodejs-business-sdk/src/objects/page-call-to-action.d.ts index ea487a8c19403d..1329fdc6f02212 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/page-call-to-action.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/page-call-to-action.d.ts @@ -1,5 +1,5 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; /** * PageCallToAction * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -64,6 +64,7 @@ export default class PageCallToAction extends AbstractCrudObject { buy_tickets: "BUY_TICKETS"; call_now: "CALL_NOW"; charity_donate: "CHARITY_DONATE"; + check_in: "CHECK_IN"; contact_us: "CONTACT_US"; donate_now: "DONATE_NOW"; email: "EMAIL"; @@ -105,7 +106,7 @@ export default class PageCallToAction extends AbstractCrudObject { shop_on_facebook: "SHOP_ON_FACEBOOK"; website: "WEBSITE"; }>; - delete(fields: string[], params?: Record): Promise; - get(fields: string[], params?: Record): Promise; - update(fields: string[], params?: Record): 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/page-category.d.ts b/types/facebook-nodejs-business-sdk/src/objects/page-category.d.ts index 80e0612b0a5e2b..c677e10cfa1e87 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/page-category.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/page-category.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * PageCategory * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/page-change-proposal.d.ts b/types/facebook-nodejs-business-sdk/src/objects/page-change-proposal.d.ts index 86a8851c6e39d9..4d9cef108c0bcb 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/page-change-proposal.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/page-change-proposal.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * PageChangeProposal * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/page-commerce-eligibility.d.ts b/types/facebook-nodejs-business-sdk/src/objects/page-commerce-eligibility.d.ts deleted file mode 100644 index 5c6aa0af863747..00000000000000 --- a/types/facebook-nodejs-business-sdk/src/objects/page-commerce-eligibility.d.ts +++ /dev/null @@ -1,11 +0,0 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -/** - * PageCommerceEligibility - * @see {@link https://developers.facebook.com/docs/marketing-api/} - */ -export default class PageCommerceEligibility extends AbstractCrudObject { - static get Fields(): Readonly<{ - offsite: "offsite"; - onsite: "onsite"; - }>; -} diff --git a/types/facebook-nodejs-business-sdk/src/objects/page-crms-with-leads-access.d.ts b/types/facebook-nodejs-business-sdk/src/objects/page-crms-with-leads-access.d.ts new file mode 100644 index 00000000000000..acb77cbeef4d11 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/page-crms-with-leads-access.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * PageCrmsWithLeadsAccess + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class PageCrmsWithLeadsAccess extends AbstractCrudObject { + static get Fields(): Readonly<{ + can_access_leads: "can_access_leads"; + id: "id"; + integration_type: "integration_type"; + name: "name"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/page-cts-topic.d.ts b/types/facebook-nodejs-business-sdk/src/objects/page-cts-topic.d.ts new file mode 100644 index 00000000000000..758d6927aabc51 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/page-cts-topic.d.ts @@ -0,0 +1,15 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * PageCTSTopic + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class PageCTSTopic extends AbstractCrudObject { + static get Fields(): Readonly<{ + app_id: "app_id"; + frequency: "frequency"; + image_hash: "image_hash"; + image_url: "image_url"; + subscriber: "subscriber"; + title: "title"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/page-ctx-budget-similar-advertiser-budget-recommendation.d.ts b/types/facebook-nodejs-business-sdk/src/objects/page-ctx-budget-similar-advertiser-budget-recommendation.d.ts new file mode 100644 index 00000000000000..440e144f9b4adc --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/page-ctx-budget-similar-advertiser-budget-recommendation.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * PageCTXBudgetSimilarAdvertiserBudgetRecommendation + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class PageCTXBudgetSimilarAdvertiserBudgetRecommendation extends AbstractCrudObject { + static get Fields(): Readonly<{ + budget: "budget"; + reported_conversion: "reported_conversion"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/page-ctx-default-greeting-text.d.ts b/types/facebook-nodejs-business-sdk/src/objects/page-ctx-default-greeting-text.d.ts new file mode 100644 index 00000000000000..ee9818b9a5e78f --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/page-ctx-default-greeting-text.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * PageCTXDefaultGreetingText + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class PageCTXDefaultGreetingText extends AbstractCrudObject { + static get Fields(): Readonly<{ + ctd: "ctd"; + ctm: "ctm"; + ctwa: "ctwa"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/page-direct-integration-crm-with-leads-access.d.ts b/types/facebook-nodejs-business-sdk/src/objects/page-direct-integration-crm-with-leads-access.d.ts new file mode 100644 index 00000000000000..1091166aef37db --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/page-direct-integration-crm-with-leads-access.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * PageDirectIntegrationCrmWithLeadsAccess + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class PageDirectIntegrationCrmWithLeadsAccess extends AbstractCrudObject { + static get Fields(): Readonly<{ + can_access_leads: "can_access_leads"; + id: "id"; + name: "name"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/page-game-bot-quota-information.d.ts b/types/facebook-nodejs-business-sdk/src/objects/page-game-bot-quota-information.d.ts new file mode 100644 index 00000000000000..5a6b8cae78be52 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/page-game-bot-quota-information.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * PageGameBotQuotaInformation + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class PageGameBotQuotaInformation extends AbstractCrudObject { + static get Fields(): Readonly<{ + count: "count"; + time_window: "time_window"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/page-get-started-nullstate.d.ts b/types/facebook-nodejs-business-sdk/src/objects/page-get-started-nullstate.d.ts new file mode 100644 index 00000000000000..dffcd328eccd8d --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/page-get-started-nullstate.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * PageGetStartedNullstate + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class PageGetStartedNullstate extends AbstractCrudObject { + static get Fields(): Readonly<{ + cta_title: "cta_title"; + processed_greeting: "processed_greeting"; + responsiveness: "responsiveness"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/page-insights-async-export-run.d.ts b/types/facebook-nodejs-business-sdk/src/objects/page-insights-async-export-run.d.ts new file mode 100644 index 00000000000000..9580af07c8387a --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/page-insights-async-export-run.d.ts @@ -0,0 +1,19 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * PageInsightsAsyncExportRun + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class PageInsightsAsyncExportRun extends AbstractCrudObject { + static get Fields(): Readonly<{ + data_level: "data_level"; + filters: "filters"; + format: "format"; + gen_report_date: "gen_report_date"; + id: "id"; + report_end_date: "report_end_date"; + report_start_date: "report_start_date"; + sorters: "sorters"; + status: "status"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/page-leads-access-config.d.ts b/types/facebook-nodejs-business-sdk/src/objects/page-leads-access-config.d.ts new file mode 100644 index 00000000000000..7743549aa0a236 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/page-leads-access-config.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * PageLeadsAccessConfig + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class PageLeadsAccessConfig extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + page: "page"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/page-locations-breakdown.d.ts b/types/facebook-nodejs-business-sdk/src/objects/page-locations-breakdown.d.ts new file mode 100644 index 00000000000000..51f6d60940b435 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/page-locations-breakdown.d.ts @@ -0,0 +1,18 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * PageLocationsBreakdown + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class PageLocationsBreakdown extends AbstractCrudObject { + static get Fields(): Readonly<{ + location_id: "location_id"; + location_name: "location_name"; + location_type: "location_type"; + num_pages: "num_pages"; + num_pages_eligible_for_store_visit_reporting: "num_pages_eligible_for_store_visit_reporting"; + num_unpublished_or_closed_pages: "num_unpublished_or_closed_pages"; + parent_country_code: "parent_country_code"; + parent_region_id: "parent_region_id"; + parent_region_name: "parent_region_name"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/page-message-responsiveness-metrics.d.ts b/types/facebook-nodejs-business-sdk/src/objects/page-message-responsiveness-metrics.d.ts new file mode 100644 index 00000000000000..b60c4fdb372bb8 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/page-message-responsiveness-metrics.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * PageMessageResponsivenessMetrics + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class PageMessageResponsivenessMetrics extends AbstractCrudObject { + static get Fields(): Readonly<{ + is_very_responsive: "is_very_responsive"; + response_rate: "response_rate"; + response_time: "response_time"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/page-parking.d.ts b/types/facebook-nodejs-business-sdk/src/objects/page-parking.d.ts index 9d016ed34591d1..e2df22285326de 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/page-parking.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/page-parking.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * PageParking * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/page-partner-with-leads-access.d.ts b/types/facebook-nodejs-business-sdk/src/objects/page-partner-with-leads-access.d.ts new file mode 100644 index 00000000000000..6703720bea68b7 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/page-partner-with-leads-access.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * PagePartnerWithLeadsAccess + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class PagePartnerWithLeadsAccess extends AbstractCrudObject { + static get Fields(): Readonly<{ + can_access_leads: "can_access_leads"; + partner_business: "partner_business"; + permitted_tasks: "permitted_tasks"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/page-payment-options.d.ts b/types/facebook-nodejs-business-sdk/src/objects/page-payment-options.d.ts index f5d1c308a07282..81adcd66c06413 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/page-payment-options.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/page-payment-options.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * PagePaymentOptions * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/page-post-experiment.d.ts b/types/facebook-nodejs-business-sdk/src/objects/page-post-experiment.d.ts index 3378aabc261129..b2428ecf57fc88 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/page-post-experiment.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/page-post-experiment.d.ts @@ -1,6 +1,6 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; +import Cursor from "./../cursor"; /** * PagePostExperiment * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -19,7 +19,6 @@ export default class PagePostExperiment extends AbstractCrudObject { insight_snapshots: "insight_snapshots"; name: "name"; optimization_goal: "optimization_goal"; - post_variant_fields: "post_variant_fields"; publish_status: "publish_status"; publish_time: "publish_time"; scheduled_experiment_timestamp: "scheduled_experiment_timestamp"; @@ -38,9 +37,7 @@ export default class PagePostExperiment extends AbstractCrudObject { shares: "SHARES"; video_views_60s: "VIDEO_VIEWS_60S"; }>; - getVideoInsights(fields: string[], params?: Record): Promise; - getVideoInsights(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getVideoInsights(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - delete(fields: string[], params?: Record): Promise; - get(fields: string[], params?: Record): Promise; + getVideoInsights(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + delete(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/page-post.d.ts b/types/facebook-nodejs-business-sdk/src/objects/page-post.d.ts index ace87fdbf12641..07282886a2fd72 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/page-post.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/page-post.d.ts @@ -1,7 +1,7 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; -import Cursor from './../cursor'; -import Comment from './comment'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; +import Cursor from "./../cursor"; +import Comment from "./comment"; /** * PagePost * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -84,37 +84,19 @@ export default class PagePost extends AbstractCrudObject { hidden: "hidden"; normal: "normal"; }>; - getAttachments(fields: string[], params?: Record): Promise; - getAttachments(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAttachments(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getComments(fields: string[], params?: Record): Promise; - getComments(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getComments(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createComment(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getDynamicPosts(fields: string[], params?: Record): Promise; - getDynamicPosts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getDynamicPosts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getInsights(fields: string[], params?: Record): Promise; - getInsights(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getInsights(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - deleteLikes(params?: Record): Promise; - getLikes(fields: string[], params?: Record): Promise; - getLikes(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getLikes(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createLike(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getReactions(fields: string[], params?: Record): Promise; - getReactions(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getReactions(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getSharedPosts(fields: string[], params?: Record): Promise; - getSharedPosts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getSharedPosts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getSponsorTags(fields: string[], params?: Record): Promise; - getSponsorTags(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getSponsorTags(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getTo(fields: string[], params?: Record): Promise; - getTo(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getTo(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; + getAttachMEnts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getComments(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createComment(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getDynamicPosts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getInsights(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + deleteLikes(params?: Record): Promise; + getLikes(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createLike(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getReactions(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getShareDPosts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getSponsorTags(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getTo(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/page-publisher.d.ts b/types/facebook-nodejs-business-sdk/src/objects/page-publisher.d.ts new file mode 100644 index 00000000000000..065b44e86a867e --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/page-publisher.d.ts @@ -0,0 +1,14 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * PagePublisher + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class PagePublisher extends AbstractCrudObject { + static get Fields(): Readonly<{ + global_parent_id: "global_parent_id"; + icon: "icon"; + id: "id"; + name: "name"; + url: "url"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/page-restaurant-services.d.ts b/types/facebook-nodejs-business-sdk/src/objects/page-restaurant-services.d.ts index 4a530928b4a19a..5dd5008b3f9afd 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/page-restaurant-services.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/page-restaurant-services.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * PageRestaurantServices * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/page-restaurant-specialties.d.ts b/types/facebook-nodejs-business-sdk/src/objects/page-restaurant-specialties.d.ts index a2c559dacd6ef5..69d8d8db2ff617 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/page-restaurant-specialties.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/page-restaurant-specialties.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * PageRestaurantSpecialties * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/page-saved-filter.d.ts b/types/facebook-nodejs-business-sdk/src/objects/page-saved-filter.d.ts deleted file mode 100644 index 8db48a039aa7fc..00000000000000 --- a/types/facebook-nodejs-business-sdk/src/objects/page-saved-filter.d.ts +++ /dev/null @@ -1,17 +0,0 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -/** - * PageSavedFilter - * @see {@link https://developers.facebook.com/docs/marketing-api/} - */ -export default class PageSavedFilter extends AbstractCrudObject { - static get Fields(): Readonly<{ - display_name: "display_name"; - filters: "filters"; - id: "id"; - page_id: "page_id"; - section: "section"; - time_created: "time_created"; - time_updated: "time_updated"; - }>; - get(fields: string[], params?: Record): Promise; -} diff --git a/types/facebook-nodejs-business-sdk/src/objects/page-settings.d.ts b/types/facebook-nodejs-business-sdk/src/objects/page-settings.d.ts index d3364d95582635..646b23fc1f5fd7 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/page-settings.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/page-settings.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * PageSettings * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/page-start-info.d.ts b/types/facebook-nodejs-business-sdk/src/objects/page-start-info.d.ts index 56eb36231297b1..8a84a262bf981e 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/page-start-info.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/page-start-info.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * PageStartInfo * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/page-thread-owner.d.ts b/types/facebook-nodejs-business-sdk/src/objects/page-thread-owner.d.ts index 25d3a99dfb26f0..e130035ed083ed 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/page-thread-owner.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/page-thread-owner.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * PageThreadOwner * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/page-upcoming-change.d.ts b/types/facebook-nodejs-business-sdk/src/objects/page-upcoming-change.d.ts index a979077bbbef10..04914bb4a803c9 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/page-upcoming-change.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/page-upcoming-change.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * PageUpcomingChange * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -12,5 +12,5 @@ export default class PageUpcomingChange extends AbstractCrudObject { proposal: "proposal"; timer_status: "timer_status"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/page-user-message-thread-label.d.ts b/types/facebook-nodejs-business-sdk/src/objects/page-user-message-thread-label.d.ts index 6c38dd38d22323..9bd3db651842cf 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/page-user-message-thread-label.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/page-user-message-thread-label.d.ts @@ -1,5 +1,5 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; /** * PageUserMessageThreadLabel * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -9,8 +9,8 @@ export default class PageUserMessageThreadLabel extends AbstractCrudObject { id: "id"; page_label_name: "page_label_name"; }>; - deleteLabel(params?: Record): Promise; - createLabel(fields: string[], params?: Record, pathOverride?: string | null): Promise; - delete(fields: string[], params?: Record): Promise; - get(fields: string[], params?: Record): Promise; + deleteLabel(params?: Record): Promise; + createLabel(fields: string[], params?: Record, pathOverride?: string | null): Promise; + delete(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/page-user-permissions.d.ts b/types/facebook-nodejs-business-sdk/src/objects/page-user-permissions.d.ts new file mode 100644 index 00000000000000..edddac636e504a --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/page-user-permissions.d.ts @@ -0,0 +1,19 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * PageUserPermissions + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class PageUserPermissions extends AbstractCrudObject { + static get Fields(): Readonly<{ + business: "business"; + business_persona: "business_persona"; + created_by: "created_by"; + created_time: "created_time"; + email: "email"; + status: "status"; + tasks: "tasks"; + updated_by: "updated_by"; + updated_time: "updated_time"; + user: "user"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/page-user-with-leads-access.d.ts b/types/facebook-nodejs-business-sdk/src/objects/page-user-with-leads-access.d.ts new file mode 100644 index 00000000000000..eeb1aa2ddb99b3 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/page-user-with-leads-access.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * PageUserWithLeadsAccess + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class PageUserWithLeadsAccess extends AbstractCrudObject { + static get Fields(): Readonly<{ + active_on_business: "active_on_business"; + business_role: "business_role"; + can_access_leads: "can_access_leads"; + page_role: "page_role"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/page-videos-you-can-use.d.ts b/types/facebook-nodejs-business-sdk/src/objects/page-videos-you-can-use.d.ts new file mode 100644 index 00000000000000..5a9109aa7fcb00 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/page-videos-you-can-use.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * PageVideosYouCanUse + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class PageVideosYouCanUse extends AbstractCrudObject { + static get Fields(): Readonly<{ + description: "description"; + id: "id"; + title: "title"; + }>; +} 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 375e63e2ded95a..30aaea3071a5bd 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/page.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/page.d.ts @@ -1,21 +1,23 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; -import Cursor from './../cursor'; -import PagePostExperiment from './page-post-experiment'; -import CanvasBodyElement from './canvas-body-element'; -import Canvas from './canvas'; -import PageUserMessageThreadLabel from './page-user-message-thread-label'; -import ImageCopyright from './image-copyright'; -import AdVideo from './ad-video'; -import InstagramUser from './instagram-user'; -import LeadgenForm from './leadgen-form'; -import LiveVideo from './live-video'; -import MediaFingerprint from './media-fingerprint'; -import Persona from './persona'; -import Photo from './photo'; -import ProfilePictureSource from './profile-picture-source'; -import VideoCopyrightRule from './video-copyright-rule'; -import VideoCopyright from './video-copyright'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; +import Cursor from "./../cursor"; +import PagePostExperiment from "./page-post-experiment"; +import CanvasBodyElement from "./canvas-body-element"; +import Canvas from "./canvas"; +import VideoCopyrightMatch from "./video-copyright-match"; +import PageUserMessageThreadLabel from "./page-user-message-thread-label"; +import AdsPixel from "./ads-pixel"; +import ImageCopyright from "./image-copyright"; +import AdVideo from "./ad-video"; +import InstagramUser from "./instagram-user"; +import LeadgenForm from "./leadgen-form"; +import LiveVideo from "./live-video"; +import MediaFingerprint from "./media-fingerprint"; +import Persona from "./persona"; +import Photo from "./photo"; +import ProfilePictureSource from "./profile-picture-source"; +import VideoCopyrightRule from "./video-copyright-rule"; +import VideoCopyright from "./video-copyright"; /** * Page * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -29,6 +31,7 @@ export default class Page extends AbstractCrudObject { app_id: "app_id"; artists_we_like: "artists_we_like"; attire: "attire"; + available_promo_offer_ids: "available_promo_offer_ids"; awards: "awards"; band_interests: "band_interests"; band_members: "band_members"; @@ -36,6 +39,7 @@ export default class Page extends AbstractCrudObject { bio: "bio"; birthday: "birthday"; booking_agent: "booking_agent"; + breaking_news_usage: "breaking_news_usage"; built: "built"; business: "business"; can_checkin: "can_checkin"; @@ -77,7 +81,6 @@ export default class Page extends AbstractCrudObject { has_lead_access: "has_lead_access"; has_transitioned_to_new_page_experience: "has_transitioned_to_new_page_experience"; has_whatsapp_business_number: "has_whatsapp_business_number"; - has_whatsapp_enterprise_number_using_cloud_api: "has_whatsapp_enterprise_number_using_cloud_api"; has_whatsapp_number: "has_whatsapp_number"; hometown: "hometown"; hours: "hours"; @@ -86,6 +89,7 @@ export default class Page extends AbstractCrudObject { influences: "influences"; instagram_business_account: "instagram_business_account"; is_always_open: "is_always_open"; + is_calling_eligible: "is_calling_eligible"; is_chain: "is_chain"; is_community_page: "is_community_page"; is_eligible_for_branded_content: "is_eligible_for_branded_content"; @@ -121,7 +125,6 @@ export default class Page extends AbstractCrudObject { offer_eligible: "offer_eligible"; overall_star_rating: "overall_star_rating"; owner_business: "owner_business"; - page_about_story: "page_about_story"; page_token: "page_token"; parent_page: "parent_page"; parking: "parking"; @@ -431,6 +434,7 @@ export default class Page extends AbstractCrudObject { awards: "awards"; bio: "bio"; birthday: "birthday"; + calls: "calls"; category: "category"; checkins: "checkins"; company_overview: "company_overview"; @@ -465,6 +469,7 @@ export default class Page extends AbstractCrudObject { message_context: "message_context"; message_deliveries: "message_deliveries"; message_echoes: "message_echoes"; + message_edits: "message_edits"; message_mention: "message_mention"; message_reactions: "message_reactions"; message_reads: "message_reads"; @@ -494,6 +499,7 @@ export default class Page extends AbstractCrudObject { page_upcoming_change: "page_upcoming_change"; parking: "parking"; payment_options: "payment_options"; + payment_request_update: "payment_request_update"; personal_info: "personal_info"; personal_interests: "personal_interests"; phone: "phone"; @@ -505,6 +511,7 @@ export default class Page extends AbstractCrudObject { publisher_subscriptions: "publisher_subscriptions"; ratings: "ratings"; registration: "registration"; + response_feedback: "response_feedback"; send_cart: "send_cart"; standby: "standby"; user_action: "user_action"; @@ -512,260 +519,135 @@ export default class Page extends AbstractCrudObject { videos: "videos"; website: "website"; }>; - getAbTests(fields: string[], params?: Record): Promise; - getAbTests(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAbTests(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createAbTest(fields: string[], params?: Record, pathOverride?: string | null): Promise; - createAcknowledgeOrder(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getAdsPosts(fields: string[], params?: Record): Promise; - getAdsPosts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdsPosts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - deleteAgencies(params?: Record): Promise; - getAgencies(fields: string[], params?: Record): Promise; - getAgencies(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAgencies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createAgency(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getAlbums(fields: string[], params?: Record): Promise; - getAlbums(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAlbums(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getArExperience(fields: string[], params?: Record): Promise; - getArExperience(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getArExperience(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - deleteAssignedUsers(params?: Record): Promise; - getAssignedUsers(fields: string[], params?: Record): Promise; - getAssignedUsers(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAssignedUsers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createAssignedUser(fields: string[], params?: Record, pathOverride?: string | null): Promise; - deleteBlocked(params?: Record): Promise; - getBlocked(fields: string[], params?: Record): Promise; - getBlocked(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getBlocked(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createBlocked(fields: string[], params?: Record, pathOverride?: string | null): Promise; - createBusinessDatum(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getBusinessProjects(fields: string[], params?: Record): Promise; - getBusinessProjects(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getBusinessProjects(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getCallToActions(fields: string[], params?: Record): Promise; - getCallToActions(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCallToActions(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getCanvasElements(fields: string[], params?: Record): Promise; - getCanvasElements(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCanvasElements(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createCanvasElement(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getCanvases(fields: string[], params?: Record): Promise; - getCanvases(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCanvases(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createCanvase(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getChatPlugin(fields: string[], params?: Record): Promise; - getChatPlugin(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getChatPlugin(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createChatPlugin(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getCommerceEligibility(fields: string[], params?: Record): Promise; - getCommerceEligibility(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCommerceEligibility(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getCommerceMerchantSettings(fields: string[], params?: Record): Promise; - getCommerceMerchantSettings(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCommerceMerchantSettings(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getCommerceOrders(fields: string[], params?: Record): Promise; - getCommerceOrders(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCommerceOrders(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getCommercePayouts(fields: string[], params?: Record): Promise; - getCommercePayouts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCommercePayouts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getCommerceTransactions(fields: string[], params?: Record): Promise; - getCommerceTransactions(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCommerceTransactions(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getConversations(fields: string[], params?: Record): Promise; - getConversations(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getConversations(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createCopyrightManualClaim(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getCrosspostWhitelistedPages(fields: string[], params?: Record): Promise; - getCrosspostWhitelistedPages(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCrosspostWhitelistedPages(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getCustomLabels(fields: string[], params?: Record): Promise; - getCustomLabels(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCustomLabels(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createCustomLabel(fields: string[], params?: Record, pathOverride?: string | null): Promise; - deleteCustomUserSettings(params?: Record): Promise; - getCustomUserSettings(fields: string[], params?: Record): Promise; - getCustomUserSettings(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCustomUserSettings(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createCustomUserSetting(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getDataset(fields: string[], params?: Record): Promise; - getDataset(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getDataset(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getEvents(fields: string[], params?: Record): Promise; - getEvents(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getEvents(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createExtendThreadControl(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getFantasyGames(fields: string[], params?: Record): Promise; - getFantasyGames(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getFantasyGames(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getFeed(fields: string[], params?: Record): Promise; - getFeed(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getFeed(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createFeed(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getGlobalBrandChildren(fields: string[], params?: Record): Promise; - getGlobalBrandChildren(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getGlobalBrandChildren(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getGroups(fields: string[], params?: Record): Promise; - getGroups(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getGroups(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getImageCopyrights(fields: string[], params?: Record): Promise; - getImageCopyrights(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getImageCopyrights(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createImageCopyright(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getIndexedVideos(fields: string[], params?: Record): Promise; - getIndexedVideos(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getIndexedVideos(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getInsights(fields: string[], params?: Record): Promise; - getInsights(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getInsights(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getInstagramAccounts(fields: string[], params?: Record): Promise; - getInstagramAccounts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getInstagramAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getInstantArticlesStats(fields: string[], params?: Record): Promise; - getInstantArticlesStats(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getInstantArticlesStats(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getLeadGenForms(fields: string[], params?: Record): Promise; - getLeadGenForms(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getLeadGenForms(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createLeadGenForm(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getLikes(fields: string[], params?: Record): Promise; - getLikes(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getLikes(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getLiveVideos(fields: string[], params?: Record): Promise; - getLiveVideos(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getLiveVideos(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createLiveVideo(fields: string[], params?: Record, pathOverride?: string | null): Promise; - deleteLocations(params?: Record): Promise; - getLocations(fields: string[], params?: Record): Promise; - getLocations(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getLocations(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createLocation(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getMediaFingerprints(fields: string[], params?: Record): Promise; - getMediaFingerprints(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getMediaFingerprints(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createMediaFingerprint(fields: string[], params?: Record, pathOverride?: string | null): Promise; - createMessageAttachment(fields: string[], params?: Record, pathOverride?: string | null): Promise; - createMessage(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getMessagingFeatureReview(fields: string[], params?: Record): Promise; - getMessagingFeatureReview(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getMessagingFeatureReview(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getMessengerLeadForms(fields: string[], params?: Record): Promise; - getMessengerLeadForms(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getMessengerLeadForms(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createMessengerLeadForm(fields: string[], params?: Record, pathOverride?: string | null): Promise; - deleteMessengerProfile(params?: Record): Promise; - getMessengerProfile(fields: string[], params?: Record): Promise; - getMessengerProfile(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getMessengerProfile(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createMessengerProfile(fields: string[], params?: Record, pathOverride?: string | null): Promise; - createNlpConfig(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getNotificationMessageTokens(fields: string[], params?: Record): Promise; - getNotificationMessageTokens(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getNotificationMessageTokens(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createNotificationMessagesDevSupport(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getPageBackedInstagramAccounts(fields: string[], params?: Record): Promise; - getPageBackedInstagramAccounts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPageBackedInstagramAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | 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; - createPassThreadMetadatum(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getPersonas(fields: string[], params?: Record): Promise; - getPersonas(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPersonas(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createPersona(fields: string[], params?: Record, pathOverride?: string | null): Promise; - createPhotoStory(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getPhotos(fields: string[], params?: Record): Promise; - getPhotos(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPhotos(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createPhoto(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getPicture(fields: string[], params?: Record): Promise; - getPicture(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPicture(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createPicture(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getPosts(fields: string[], params?: Record): Promise; - getPosts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPosts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getProductCatalogs(fields: string[], params?: Record): Promise; - getProductCatalogs(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getProductCatalogs(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getPublishedPosts(fields: string[], params?: Record): Promise; - getPublishedPosts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPublishedPosts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getRatings(fields: string[], params?: Record): Promise; - getRatings(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getRatings(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createReleaseThreadControl(fields: string[], params?: Record, pathOverride?: string | null): Promise; - createRequestThreadControl(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getRoles(fields: string[], params?: Record): Promise; - getRoles(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getRoles(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getRtbDynamicPosts(fields: string[], params?: Record): Promise; - getRtbDynamicPosts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getRtbDynamicPosts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getScheduledPosts(fields: string[], params?: Record): Promise; - getScheduledPosts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getScheduledPosts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getSecondaryReceivers(fields: string[], params?: Record): Promise; - getSecondaryReceivers(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getSecondaryReceivers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getSettings(fields: string[], params?: Record): Promise; - getSettings(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getSettings(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createSetting(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getShopSetupStatus(fields: string[], params?: Record): Promise; - getShopSetupStatus(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getShopSetupStatus(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getStories(fields: string[], params?: Record): Promise; - getStories(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getStories(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - deleteSubscribedApps(params?: Record): Promise; - getSubscribedApps(fields: string[], params?: Record): Promise; - getSubscribedApps(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getSubscribedApps(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createSubscribedApp(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getTabs(fields: string[], params?: Record): Promise; - getTabs(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getTabs(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getTagged(fields: string[], params?: Record): Promise; - getTagged(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getTagged(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createTakeThreadControl(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getThreadOwner(fields: string[], params?: Record): Promise; - getThreadOwner(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getThreadOwner(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getThreads(fields: string[], params?: Record): Promise; - getThreads(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getThreads(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createUnlinkAccount(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getVideoCopyrightRules(fields: string[], params?: Record): Promise; - getVideoCopyrightRules(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getVideoCopyrightRules(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createVideoCopyrightRule(fields: string[], params?: Record, pathOverride?: string | null): Promise; - createVideoCopyright(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getVideoLists(fields: string[], params?: Record): Promise; - getVideoLists(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getVideoLists(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getVideoReels(fields: string[], params?: Record): Promise; - getVideoReels(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getVideoReels(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createVideoReel(fields: string[], params?: Record, pathOverride?: string | null): Promise; - createVideoStory(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getVideos(fields: string[], params?: Record): Promise; - getVideos(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getVideos(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createVideo(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getVisitorPosts(fields: string[], params?: Record): Promise; - getVisitorPosts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getVisitorPosts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - deleteWelcomeMessageFlows(params?: Record): Promise; - getWelcomeMessageFlows(fields: string[], params?: Record): Promise; - getWelcomeMessageFlows(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getWelcomeMessageFlows(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createWelcomeMessageFlow(fields: string[], params?: Record, pathOverride?: string | null): Promise; - get(fields: string[], params?: Record): Promise; - update(fields: string[], params?: Record): Promise; + static get Action(): Readonly<{ + spam: "SPAM"; + }>; + static get ActionType(): Readonly<{ + report_thread: "REPORT_THREAD"; + }>; + getAbTests(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createAbTest(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createAcknowledgeOrder(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getAdsPosts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + deleteAgencies(params?: Record): Promise; + getAgencies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createAgency(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getAlbums(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getArExperience(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + deleteAssignedUsers(params?: Record): Promise; + getAssignedUsers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createAssignedUser(fields: string[], params?: Record, pathOverride?: string | null): Promise; + deleteBlocked(params?: Record): Promise; + getBlocked(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createBlocked(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createBusinessDatum(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getBusinessProjects(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getCallToActions(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createCall(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getCanvasElements(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createCanvasElement(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getCanvases(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createCanvase(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getChatPlugin(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createChatPlugin(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getCommerceMerchantSettings(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getCommerceOrders(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getCommercePayouts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getCommerceTransactions(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getConversations(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createCopyrightManualClaim(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getCrosspostWhitelistedPages(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getCustomLabels(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createCustomLabel(fields: string[], params?: Record, pathOverride?: string | null): Promise; + deleteCustomUserSettings(params?: Record): Promise; + getCustomUserSettings(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createCustomUserSetting(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getDataSet(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createDataSet(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getEvents(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createExtendThreadControl(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getFantasyGames(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getFeed(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createFeed(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getGlobalBrandChildren(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getGroups(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getImageCopyrights(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createImageCopyright(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getIndexedVideos(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getInsights(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getInstagramAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getLeadGenForms(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createLeadGenForm(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getLikes(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getLiveVideos(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createLiveVideo(fields: string[], params?: Record, pathOverride?: string | null): Promise; + deleteLocations(params?: Record): Promise; + getLocations(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createLocation(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getMediaFingerprints(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createMediaFingerprint(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createMessageAttachMEnt(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createMessage(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getMessagingFeatureReview(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getMessengerCallSettings(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createMessengerCallSetting(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getMessengerLeadForMs(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createMessengerLeadForM(fields: string[], params?: Record, pathOverride?: string | null): Promise; + deleteMessengerProfile(params?: Record): Promise; + getMessengerProfile(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createMessengerProfile(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createNlpConfig(fields: string[], params?: Record, pathOverride?: string | null): Promise; + 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; + createPageWhatsAppNumberVerification(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createPassThreadControl(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createPassThreadMetadatum(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getPersonas(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createPersona(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createPhotoStory(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getPhotos(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createPhoto(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getPicture(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createPicture(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getPosts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getProductCatalogs(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getPublishedPosts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getRatings(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createReleaseThreadControl(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createRequestThreadControl(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getRoles(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getRtbDynamicPosts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getScheduleDPosts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getSecondaryReceivers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getSettings(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createSetting(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getShopSetupStatus(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getStories(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + deleteSubscribedApps(params?: Record): Promise; + getSubscribedApps(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createSubscribedApp(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getTabs(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getTagged(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createTakeThreadControl(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createThreadAction(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getThreadOwner(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getThreads(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createUnlinkAccount(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getVideoCopyrightRules(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createVideoCopyrightRule(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createVideoCopyright(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getVideoLists(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getVideoReels(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createVideoReel(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createVideoStory(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getVideos(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createVideo(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getVisitorPosts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + deleteWelcomeMessageFlows(params?: Record): Promise; + getWelcomeMessageFlows(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createWelcomeMessageFlow(fields: string[], params?: Record, pathOverride?: string | null): Promise; + get(fields: string[], params?: Record): Promise; + update(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/panel-api-report.d.ts b/types/facebook-nodejs-business-sdk/src/objects/panel-api-report.d.ts new file mode 100644 index 00000000000000..be80af647e1929 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/panel-api-report.d.ts @@ -0,0 +1,20 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * PanelAPIReport + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class PanelAPIReport extends AbstractCrudObject { + static get Fields(): Readonly<{ + checksum: "checksum"; + download_url: "download_url"; + end_date: "end_date"; + export_file_type: "export_file_type"; + id: "id"; + index: "index"; + name: "name"; + number_of_chunks: "number_of_chunks"; + start_date: "start_date"; + upload_date: "upload_date"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/parent-catalog-report.d.ts b/types/facebook-nodejs-business-sdk/src/objects/parent-catalog-report.d.ts new file mode 100644 index 00000000000000..c6e370bd8c1439 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/parent-catalog-report.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ParentCatalogReport + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ParentCatalogReport extends AbstractCrudObject { + static get Fields(): Readonly<{ + purchase_conversion_value: "purchase_conversion_value"; + purchases: "purchases"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/partner-account-linking.d.ts b/types/facebook-nodejs-business-sdk/src/objects/partner-account-linking.d.ts new file mode 100644 index 00000000000000..254b9a8c90b36c --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/partner-account-linking.d.ts @@ -0,0 +1,18 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * PartnerAccountLinking + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class PartnerAccountLinking extends AbstractCrudObject { + static get Fields(): Readonly<{ + adaccount: "adaccount"; + app: "app"; + business: "business"; + externalidentifier: "externalidentifier"; + externalidentifieruri: "externalidentifieruri"; + id: "id"; + partnername: "partnername"; + pixel: "pixel"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/partner-category.d.ts b/types/facebook-nodejs-business-sdk/src/objects/partner-category.d.ts new file mode 100644 index 00000000000000..bf7474037cb93f --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/partner-category.d.ts @@ -0,0 +1,20 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * PartnerCategory + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class PartnerCategory extends AbstractCrudObject { + static get Fields(): Readonly<{ + approximate_count: "approximate_count"; + country: "country"; + description: "description"; + details: "details"; + id: "id"; + is_private: "is_private"; + name: "name"; + parent_category: "parent_category"; + source: "source"; + status: "status"; + targeting_type: "targeting_type"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/partner-integration-linked.d.ts b/types/facebook-nodejs-business-sdk/src/objects/partner-integration-linked.d.ts new file mode 100644 index 00000000000000..1e2889fc1f34e6 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/partner-integration-linked.d.ts @@ -0,0 +1,26 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * PartnerIntegrationLinked + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class PartnerIntegrationLinked extends AbstractCrudObject { + static get Fields(): Readonly<{ + ads_pixel: "ads_pixel"; + application: "application"; + completed_integration_types: "completed_integration_types"; + external_business_connection_id: "external_business_connection_id"; + external_id: "external_id"; + has_oauth_token: "has_oauth_token"; + id: "id"; + mbe_app_id: "mbe_app_id"; + mbe_asset_id: "mbe_asset_id"; + mbe_external_business_id: "mbe_external_business_id"; + name: "name"; + offline_conversion_data_set: "offline_conversion_data_set"; + page: "page"; + partner: "partner"; + product_catalog: "product_catalog"; + setup_status: "setup_status"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/partner-study.d.ts b/types/facebook-nodejs-business-sdk/src/objects/partner-study.d.ts index 44539e06c58931..24668e82a38e00 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/partner-study.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/partner-study.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * PartnerStudy * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -24,5 +24,5 @@ export default class PartnerStudy extends AbstractCrudObject { study_type: "study_type"; submit_date: "submit_date"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/partnership-ad-content-search-media.d.ts b/types/facebook-nodejs-business-sdk/src/objects/partnership-ad-content-search-media.d.ts new file mode 100644 index 00000000000000..9adffd2e45a793 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/partnership-ad-content-search-media.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * PartnershipAdContentSearchMedia + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class PartnershipAdContentSearchMedia extends AbstractCrudObject { + static get Fields(): Readonly<{ + ig_media: "ig_media"; + ig_media_has_product_tags: "ig_media_has_product_tags"; + is_ad_code_entry: "is_ad_code_entry"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/partnership-ads-identity.d.ts b/types/facebook-nodejs-business-sdk/src/objects/partnership-ads-identity.d.ts new file mode 100644 index 00000000000000..b3bc8be018ca00 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/partnership-ads-identity.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * PartnershipAdsIdentity + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class PartnershipAdsIdentity extends AbstractCrudObject { + static get Fields(): Readonly<{ + post_types: "post_types"; + secondary_identities: "secondary_identities"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/payment-engine-payment.d.ts b/types/facebook-nodejs-business-sdk/src/objects/payment-engine-payment.d.ts index 3140d763cc2040..c5132d9e1391bb 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/payment-engine-payment.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/payment-engine-payment.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * PaymentEnginePayment * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -31,7 +31,7 @@ export default class PaymentEnginePayment extends AbstractCrudObject { denied_refund: "DENIED_REFUND"; granted_replacement_item: "GRANTED_REPLACEMENT_ITEM"; }>; - createDispute(fields: string[], params?: Record, pathOverride?: string | null): Promise; - createRefund(fields: string[], params?: Record, pathOverride?: string | null): Promise; - get(fields: string[], params?: Record): Promise; + createDispute(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createRefund(fields: string[], params?: Record, pathOverride?: string | null): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/payment-pricepoints.d.ts b/types/facebook-nodejs-business-sdk/src/objects/payment-pricepoints.d.ts index 0d1d4e9712b674..771e404425c1c6 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/payment-pricepoints.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/payment-pricepoints.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * PaymentPricepoints * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/payment-request-details.d.ts b/types/facebook-nodejs-business-sdk/src/objects/payment-request-details.d.ts new file mode 100644 index 00000000000000..8707d0230ab266 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/payment-request-details.d.ts @@ -0,0 +1,18 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * PaymentRequestDetails + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class PaymentRequestDetails extends AbstractCrudObject { + static get Fields(): Readonly<{ + amount: "amount"; + creation_time: "creation_time"; + note: "note"; + payment_request_id: "payment_request_id"; + receiver_id: "receiver_id"; + reference_number: "reference_number"; + sender_id: "sender_id"; + status: "status"; + transaction_time: "transaction_time"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/payment-subscription.d.ts b/types/facebook-nodejs-business-sdk/src/objects/payment-subscription.d.ts index 860fc62a99e4df..2ea948dbbdadac 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/payment-subscription.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/payment-subscription.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * PaymentSubscription * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -30,5 +30,5 @@ export default class PaymentSubscription extends AbstractCrudObject { updated_time: "updated_time"; user: "user"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/permission.d.ts b/types/facebook-nodejs-business-sdk/src/objects/permission.d.ts index e8253387ca5bf6..09acb884ece7b0 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/permission.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/permission.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * Permission * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/persona.d.ts b/types/facebook-nodejs-business-sdk/src/objects/persona.d.ts index 4d8c04ab9c0d1a..0a25c48b6e83da 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/persona.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/persona.d.ts @@ -1,5 +1,5 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; /** * Persona * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -10,6 +10,6 @@ export default class Persona extends AbstractCrudObject { name: "name"; profile_picture_url: "profile_picture_url"; }>; - delete(fields: string[], params?: Record): Promise; - get(fields: string[], params?: Record): Promise; + delete(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/personal-ads-persona.d.ts b/types/facebook-nodejs-business-sdk/src/objects/personal-ads-persona.d.ts new file mode 100644 index 00000000000000..4f60b0ab3adb99 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/personal-ads-persona.d.ts @@ -0,0 +1,15 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * PersonalAdsPersona + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class PersonalAdsPersona extends AbstractCrudObject { + static get Fields(): Readonly<{ + email: "email"; + first_name: "first_name"; + id: "id"; + last_name: "last_name"; + pending_email: "pending_email"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/photo-metadata.d.ts b/types/facebook-nodejs-business-sdk/src/objects/photo-metadata.d.ts new file mode 100644 index 00000000000000..81bd851860d915 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/photo-metadata.d.ts @@ -0,0 +1,21 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * PhotoMetadata + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class PhotoMetadata extends AbstractCrudObject { + static get Fields(): Readonly<{ + camera_make: "camera_make"; + camera_model: "camera_model"; + datetime_modified: "datetime_modified"; + datetime_taken: "datetime_taken"; + exposure: "exposure"; + focal_length: "focal_length"; + fstop: "fstop"; + iso_speed: "iso_speed"; + offline_id: "offline_id"; + orientation: "orientation"; + original_height: "original_height"; + original_width: "original_width"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/photo.d.ts b/types/facebook-nodejs-business-sdk/src/objects/photo.d.ts index a7ce26f0a57739..fcbe847972b922 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/photo.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/photo.d.ts @@ -1,7 +1,7 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; -import Cursor from './../cursor'; -import Comment from './comment'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; +import Cursor from "./../cursor"; +import Comment from "./comment"; /** * Photo * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -58,20 +58,12 @@ export default class Photo extends AbstractCrudObject { tagged: "tagged"; uploaded: "uploaded"; }>; - getComments(fields: string[], params?: Record): Promise; - getComments(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getComments(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createComment(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getInsights(fields: string[], params?: Record): Promise; - getInsights(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getInsights(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getLikes(fields: string[], params?: Record): Promise; - getLikes(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getLikes(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createLike(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getSponsorTags(fields: string[], params?: Record): Promise; - getSponsorTags(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getSponsorTags(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - delete(fields: string[], params?: Record): Promise; - get(fields: string[], params?: Record): Promise; + getComments(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createComment(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getInsights(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getLikes(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createLike(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getSponsorTags(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + delete(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/place-tag.d.ts b/types/facebook-nodejs-business-sdk/src/objects/place-tag.d.ts new file mode 100644 index 00000000000000..1186e9fd8bc987 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/place-tag.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * PlaceTag + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class PlaceTag extends AbstractCrudObject { + static get Fields(): Readonly<{ + created_time: "created_time"; + id: "id"; + place: "place"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/place-topic.d.ts b/types/facebook-nodejs-business-sdk/src/objects/place-topic.d.ts index 5d0f1068415f54..c0afe83e252925 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/place-topic.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/place-topic.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * PlaceTopic * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -14,5 +14,5 @@ export default class PlaceTopic extends AbstractCrudObject { plural_name: "plural_name"; top_subtopic_names: "top_subtopic_names"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/place.d.ts b/types/facebook-nodejs-business-sdk/src/objects/place.d.ts index c50d96a77985b7..f5b76b76b100fa 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/place.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/place.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * Place * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -10,5 +10,5 @@ export default class Place extends AbstractCrudObject { name: "name"; overall_rating: "overall_rating"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/platform-image-source.d.ts b/types/facebook-nodejs-business-sdk/src/objects/platform-image-source.d.ts index 63cb381736b790..c64911cbd14628 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/platform-image-source.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/platform-image-source.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * PlatformImageSource * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/platform-session-key.d.ts b/types/facebook-nodejs-business-sdk/src/objects/platform-session-key.d.ts new file mode 100644 index 00000000000000..9ab20ed95212ef --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/platform-session-key.d.ts @@ -0,0 +1,10 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * PlatformSessionKey + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class PlatformSessionKey extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/playable-content.d.ts b/types/facebook-nodejs-business-sdk/src/objects/playable-content.d.ts index 11a4c2b94614a4..9aa5e96ea72208 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/playable-content.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/playable-content.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * PlayableContent * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -9,5 +9,5 @@ export default class PlayableContent extends AbstractCrudObject { name: "name"; owner: "owner"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/post.d.ts b/types/facebook-nodejs-business-sdk/src/objects/post.d.ts index 9112bf0b366d69..29b725fce6d985 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/post.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/post.d.ts @@ -1,7 +1,7 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; -import Cursor from './../cursor'; -import Comment from './comment'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; +import Cursor from "./../cursor"; +import Comment from "./comment"; /** * Post * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -120,34 +120,18 @@ export default class Post extends AbstractCrudObject { hidden: "hidden"; normal: "normal"; }>; - getAttachments(fields: string[], params?: Record): Promise; - getAttachments(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAttachments(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getComments(fields: string[], params?: Record): Promise; - getComments(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getComments(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createComment(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getDynamicPosts(fields: string[], params?: Record): Promise; - getDynamicPosts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getDynamicPosts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getInsights(fields: string[], params?: Record): Promise; - getInsights(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getInsights(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - deleteLikes(params?: Record): Promise; - createLike(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getReactions(fields: string[], params?: Record): Promise; - getReactions(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getReactions(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getSharedPosts(fields: string[], params?: Record): Promise; - getSharedPosts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getSharedPosts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getSponsorTags(fields: string[], params?: Record): Promise; - getSponsorTags(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getSponsorTags(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getTo(fields: string[], params?: Record): Promise; - getTo(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getTo(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; + getAttachMEnts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getComments(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createComment(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getDynamicPosts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getInsights(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + deleteLikes(params?: Record): Promise; + createLike(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getReactions(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getShareDPosts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getSponsorTags(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getTo(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/preapproval-review.d.ts b/types/facebook-nodejs-business-sdk/src/objects/preapproval-review.d.ts new file mode 100644 index 00000000000000..61d178971e095c --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/preapproval-review.d.ts @@ -0,0 +1,14 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * PreapprovalReview + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class PreapprovalReview extends AbstractCrudObject { + static get Fields(): Readonly<{ + comp_type: "comp_type"; + crow_component_id: "crow_component_id"; + is_human_reviewed: "is_human_reviewed"; + is_reviewed: "is_reviewed"; + policy_info: "policy_info"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/premium-music-video.d.ts b/types/facebook-nodejs-business-sdk/src/objects/premium-music-video.d.ts new file mode 100644 index 00000000000000..0575c4d79ce09e --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/premium-music-video.d.ts @@ -0,0 +1,17 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * PremiumMusicVideo + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class PremiumMusicVideo extends AbstractCrudObject { + static get Fields(): Readonly<{ + creation_time: "creation_time"; + cross_post_videos: "cross_post_videos"; + eligible_cross_post_pages: "eligible_cross_post_pages"; + id: "id"; + preferred_video_thumbnail_image_uri: "preferred_video_thumbnail_image_uri"; + premium_music_video_metadata: "premium_music_video_metadata"; + scheduled_publish_time: "scheduled_publish_time"; + title: "title"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/privacy-option.d.ts b/types/facebook-nodejs-business-sdk/src/objects/privacy-option.d.ts new file mode 100644 index 00000000000000..6c95b8b2da77bb --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/privacy-option.d.ts @@ -0,0 +1,15 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * PrivacyOption + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class PrivacyOption extends AbstractCrudObject { + static get Fields(): Readonly<{ + description: "description"; + icon_src: "icon_src"; + id: "id"; + is_currently_selected: "is_currently_selected"; + type: "type"; + user_id: "user_id"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/privacy.d.ts b/types/facebook-nodejs-business-sdk/src/objects/privacy.d.ts index ac12fb059c7433..156e0032cc0f6a 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/privacy.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/privacy.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * Privacy * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/private-computation-environment.d.ts b/types/facebook-nodejs-business-sdk/src/objects/private-computation-environment.d.ts new file mode 100644 index 00000000000000..361f970b7f1a10 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/private-computation-environment.d.ts @@ -0,0 +1,16 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * PrivateComputationEnvironment + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class PrivateComputationEnvironment extends AbstractCrudObject { + static get Fields(): Readonly<{ + publisher_account_id: "publisher_account_id"; + publisher_pce_deployment_status: "publisher_pce_deployment_status"; + publisher_pce_id: "publisher_pce_id"; + publisher_region: "publisher_region"; + publisher_vpc_id: "publisher_vpc_id"; + id: "id"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/private-lift-study-instance.d.ts b/types/facebook-nodejs-business-sdk/src/objects/private-lift-study-instance.d.ts index 4b1e836f46cb92..520831b92bffd0 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/private-lift-study-instance.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/private-lift-study-instance.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * PrivateLiftStudyInstance * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -25,6 +25,6 @@ export default class PrivateLiftStudyInstance extends AbstractCrudObject { next: "NEXT"; none: "NONE"; }>; - get(fields: string[], params?: Record): Promise; - update(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/product-catalog-category.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-catalog-category.d.ts index d467f588cb21ce..c0b5986601b64f 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/product-catalog-category.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/product-catalog-category.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ProductCatalogCategory * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-catalog-data-source.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-catalog-data-source.d.ts index 310a0d91ebc0eb..69bbdc85955e50 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/product-catalog-data-source.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/product-catalog-data-source.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ProductCatalogDataSource * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-catalog-diagnostic-group.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-catalog-diagnostic-group.d.ts index b8f7d08a745bac..f81a655594f830 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/product-catalog-diagnostic-group.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/product-catalog-diagnostic-group.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ProductCatalogDiagnosticGroup * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -18,14 +18,24 @@ export default class ProductCatalogDiagnosticGroup extends AbstractCrudObject { type: "type"; }>; static get AffectedChannels(): Readonly<{ - business_inbox_in_messenger: "business_inbox_in_messenger"; + b2c_marketplace: "b2c_marketplace"; + c2c_marketplace: "c2c_marketplace"; + da: "da"; + daily_deals: "daily_deals"; + daily_deals_legacy: "daily_deals_legacy"; + ig_product_tagging: "ig_product_tagging"; + marketplace: "marketplace"; + marketplace_ads_deprecated: "marketplace_ads_deprecated"; + marketplace_shops: "marketplace_shops"; + mini_shops: "mini_shops"; + offline_conversions: "offline_conversions"; shops: "shops"; - test_capability: "test_capability"; universal_checkout: "universal_checkout"; - us_marketplace: "us_marketplace"; + whatsapp: "whatsapp"; }>; static get AffectedEntity(): Readonly<{ product_catalog: "product_catalog"; + product_event: "product_event"; product_item: "product_item"; product_set: "product_set"; }>; @@ -44,6 +54,7 @@ export default class ProductCatalogDiagnosticGroup extends AbstractCrudObject { category: "CATEGORY"; checkout: "CHECKOUT"; da_visibility_issues: "DA_VISIBILITY_ISSUES"; + event_source_issues: "EVENT_SOURCE_ISSUES"; image_quality: "IMAGE_QUALITY"; low_quality_title_and_description: "LOW_QUALITY_TITLE_AND_DESCRIPTION"; policy_violation: "POLICY_VIOLATION"; @@ -51,6 +62,7 @@ export default class ProductCatalogDiagnosticGroup extends AbstractCrudObject { }>; static get AffectedEntities(): Readonly<{ product_catalog: "product_catalog"; + product_event: "product_event"; product_item: "product_item"; product_set: "product_set"; }>; @@ -65,6 +77,7 @@ export default class ProductCatalogDiagnosticGroup extends AbstractCrudObject { category: "CATEGORY"; checkout: "CHECKOUT"; da_visibility_issues: "DA_VISIBILITY_ISSUES"; + event_source_issues: "EVENT_SOURCE_ISSUES"; image_quality: "IMAGE_QUALITY"; low_quality_title_and_description: "LOW_QUALITY_TITLE_AND_DESCRIPTION"; policy_violation: "POLICY_VIOLATION"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-catalog-example-feed.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-catalog-example-feed.d.ts new file mode 100644 index 00000000000000..b73778f069a4e2 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/product-catalog-example-feed.d.ts @@ -0,0 +1,10 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ProductCatalogExampleFeed + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ProductCatalogExampleFeed extends AbstractCrudObject { + static get Fields(): Readonly<{ + example_feed: "example_feed"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-catalog-facets.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-catalog-facets.d.ts new file mode 100644 index 00000000000000..ed437cf31772d4 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/product-catalog-facets.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ProductCatalogFacets + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ProductCatalogFacets extends AbstractCrudObject { + static get Fields(): Readonly<{ + facets: "facets"; + item_count: "item_count"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-catalog-hotel-rooms-batch.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-catalog-hotel-rooms-batch.d.ts index 468d968cece8bb..553f6926bed988 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/product-catalog-hotel-rooms-batch.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/product-catalog-hotel-rooms-batch.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ProductCatalogHotelRoomsBatch * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-catalog-image-settings-internal.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-catalog-image-settings-internal.d.ts new file mode 100644 index 00000000000000..3ec092a5c74795 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/product-catalog-image-settings-internal.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ProductCatalogImageSettingsInternal + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ProductCatalogImageSettingsInternal extends AbstractCrudObject { + static get Fields(): Readonly<{ + carousel_ad: "carousel_ad"; + shops_pdp: "shops_pdp"; + single_ad: "single_ad"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-catalog-image-settings-operation.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-catalog-image-settings-operation.d.ts index a5265de1ba5eff..26639bfb685ed3 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/product-catalog-image-settings-operation.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/product-catalog-image-settings-operation.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ProductCatalogImageSettingsOperation * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-catalog-image-settings.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-catalog-image-settings.d.ts index e7fa22c0dd8c61..be6245977c13d3 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/product-catalog-image-settings.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/product-catalog-image-settings.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ProductCatalogImageSettings * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-catalog-localization-settings.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-catalog-localization-settings.d.ts new file mode 100644 index 00000000000000..aac8de9411277a --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/product-catalog-localization-settings.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ProductCatalogLocalizationSettings + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ProductCatalogLocalizationSettings extends AbstractCrudObject { + static get Fields(): Readonly<{ + default_country: "default_country"; + default_language: "default_language"; + id: "id"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-catalog-microdata-stats-pixel-info.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-catalog-microdata-stats-pixel-info.d.ts new file mode 100644 index 00000000000000..0b148811f6b485 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/product-catalog-microdata-stats-pixel-info.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ProductCatalogMicrodataStatsPixelInfo + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ProductCatalogMicrodataStatsPixelInfo extends AbstractCrudObject { + static get Fields(): Readonly<{ + is_already_connected: "is_already_connected"; + pixel_id: "pixel_id"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-catalog-pricing-variables-batch.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-catalog-pricing-variables-batch.d.ts index ec7480df7362f6..fa2276cf1cdfbd 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/product-catalog-pricing-variables-batch.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/product-catalog-pricing-variables-batch.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ProductCatalogPricingVariablesBatch * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-catalog-product-sets-batch.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-catalog-product-sets-batch.d.ts index b53ab34600eac0..e4a9cf7779fec5 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/product-catalog-product-sets-batch.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/product-catalog-product-sets-batch.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ProductCatalogProductSetsBatch * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-catalog-user-actions.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-catalog-user-actions.d.ts new file mode 100644 index 00000000000000..5646852446fded --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/product-catalog-user-actions.d.ts @@ -0,0 +1,10 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ProductCatalogUserActions + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ProductCatalogUserActions extends AbstractCrudObject { + static get Fields(): Readonly<{ + actions: "actions"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-catalog-user-permissions.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-catalog-user-permissions.d.ts new file mode 100644 index 00000000000000..81a2f5a051c426 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/product-catalog-user-permissions.d.ts @@ -0,0 +1,19 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ProductCatalogUserPermissions + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ProductCatalogUserPermissions extends AbstractCrudObject { + static get Fields(): Readonly<{ + business: "business"; + business_persona: "business_persona"; + created_by: "created_by"; + created_time: "created_time"; + email: "email"; + role: "role"; + status: "status"; + updated_by: "updated_by"; + updated_time: "updated_time"; + user: "user"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-catalog-user-tasks.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-catalog-user-tasks.d.ts new file mode 100644 index 00000000000000..b486ca0f5880dd --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/product-catalog-user-tasks.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ProductCatalogUserTasks + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ProductCatalogUserTasks extends AbstractCrudObject { + static get Fields(): Readonly<{ + business: "business"; + tasks: "tasks"; + }>; +} 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 bf89a3b031c472..05b70a06d8ba5e 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 @@ -1,15 +1,16 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; -import Cursor from './../cursor'; -import StoreCatalogSettings from './store-catalog-settings'; -import ProductCatalogCategory from './product-catalog-category'; -import HomeListing from './home-listing'; -import Hotel from './hotel'; -import ProductFeed from './product-feed'; -import ProductGroup from './product-group'; -import ProductSet from './product-set'; -import ProductItem from './product-item'; -import Vehicle from './vehicle'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; +import Cursor from "./../cursor"; +import StoreCatalogSettings from "./store-catalog-settings"; +import ProductCatalogCategory from "./product-catalog-category"; +import CPASLsbImageBank from "./cpas-lsb-image-bank"; +import HomeListing from "./home-listing"; +import Hotel from "./hotel"; +import ProductFeed from "./product-feed"; +import ProductGroup from "./product-group"; +import ProductSet from "./product-set"; +import ProductItem from "./product-item"; +import Vehicle from "./vehicle"; /** * ProductCatalog * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -28,6 +29,7 @@ export default class ProductCatalog extends AbstractCrudObject { feed_count: "feed_count"; id: "id"; is_catalog_segment: "is_catalog_segment"; + is_local_catalog: "is_local_catalog"; name: "name"; owner_business: "owner_business"; product_count: "product_count"; @@ -35,20 +37,22 @@ export default class ProductCatalog extends AbstractCrudObject { user_access_expire_time: "user_access_expire_time"; vertical: "vertical"; }>; + static get AdditionalVerticalOption(): Readonly<{ + local_da_catalog: "LOCAL_DA_CATALOG"; + local_products: "LOCAL_PRODUCTS"; + }>; static get Vertical(): Readonly<{ adoptable_pets: "adoptable_pets"; - bookable: "bookable"; commerce: "commerce"; destinations: "destinations"; flights: "flights"; + generic: "generic"; home_listings: "home_listings"; hotels: "hotels"; jobs: "jobs"; - local_delivery_shipping_profiles: "local_delivery_shipping_profiles"; local_service_businesses: "local_service_businesses"; offer_items: "offer_items"; offline_commerce: "offline_commerce"; - ticketed_experiences: "ticketed_experiences"; transactable_items: "transactable_items"; vehicles: "vehicles"; }>; @@ -99,103 +103,54 @@ export default class ProductCatalog extends AbstractCrudObject { video_game_consoles_and_video_games: "VIDEO_GAME_CONSOLES_AND_VIDEO_GAMES"; watches: "WATCHES"; }>; - deleteAgencies(params?: Record): Promise; - getAgencies(fields: string[], params?: Record): Promise; - getAgencies(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAgencies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createAgency(fields: string[], params?: Record, pathOverride?: string | null): Promise; - deleteAssignedUsers(params?: Record): Promise; - getAssignedUsers(fields: string[], params?: Record): Promise; - getAssignedUsers(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAssignedUsers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createAssignedUser(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getAutomotiveModels(fields: string[], params?: Record): Promise; - getAutomotiveModels(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAutomotiveModels(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createBatch(fields: string[], params?: Record, pathOverride?: string | null): Promise; - createCatalogStore(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getCategories(fields: string[], params?: Record): Promise; - getCategories(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCategories(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createCategory(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getCheckBatchRequestStatus(fields: string[], params?: Record): Promise; - getCheckBatchRequestStatus(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCheckBatchRequestStatus(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getCollaborativeAdsEventStats(fields: string[], params?: Record): Promise; - getCollaborativeAdsEventStats(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCollaborativeAdsEventStats(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getCollaborativeAdsLsbImageBank(fields: string[], params?: Record): Promise; - getCollaborativeAdsLsbImageBank(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCollaborativeAdsLsbImageBank(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getCollaborativeAdsShareSettings(fields: string[], params?: Record): Promise; - getCollaborativeAdsShareSettings(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCollaborativeAdsShareSettings(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createCpasLsbImageBank(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getDataSources(fields: string[], params?: Record): Promise; - getDataSources(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getDataSources(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getDestinations(fields: string[], params?: Record): Promise; - getDestinations(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getDestinations(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getDiagnostics(fields: string[], params?: Record): Promise; - getDiagnostics(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getDiagnostics(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getEventStats(fields: string[], params?: Record): Promise; - getEventStats(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getEventStats(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - deleteExternalEventSources(params?: Record): Promise; - getExternalEventSources(fields: string[], params?: Record): Promise; - getExternalEventSources(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getExternalEventSources(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createExternalEventSource(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getFlights(fields: string[], params?: Record): Promise; - getFlights(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getFlights(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getHomeListings(fields: string[], params?: Record): Promise; - getHomeListings(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getHomeListings(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createHomeListing(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getHotelRoomsBatch(fields: string[], params?: Record): Promise; - getHotelRoomsBatch(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getHotelRoomsBatch(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createHotelRoomsBatch(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getHotels(fields: string[], params?: Record): Promise; - getHotels(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getHotels(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createHotel(fields: string[], params?: Record, pathOverride?: string | null): Promise; - createItemsBatch(fields: string[], params?: Record, pathOverride?: string | null): Promise; - createLocalizedItemsBatch(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getPricingVariablesBatch(fields: string[], params?: Record): Promise; - getPricingVariablesBatch(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPricingVariablesBatch(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createPricingVariablesBatch(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getProductFeeds(fields: string[], params?: Record): Promise; - getProductFeeds(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getProductFeeds(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createProductFeed(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getProductGroups(fields: string[], params?: Record): Promise; - getProductGroups(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getProductGroups(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createProductGroup(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getProductSets(fields: string[], params?: Record): Promise; - getProductSets(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getProductSets(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createProductSet(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getProductSetsBatch(fields: string[], params?: Record): Promise; - getProductSetsBatch(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getProductSetsBatch(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getProducts(fields: string[], params?: Record): Promise; - getProducts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getProducts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createProduct(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getVehicleOffers(fields: string[], params?: Record): Promise; - getVehicleOffers(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getVehicleOffers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getVehicles(fields: string[], params?: Record): Promise; - getVehicles(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getVehicles(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createVehicle(fields: string[], params?: Record, pathOverride?: string | null): Promise; - delete(fields: string[], params?: Record): Promise; - get(fields: string[], params?: Record): Promise; - update(fields: string[], params?: Record): Promise; + deleteAgencies(params?: Record): Promise; + getAgencies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createAgency(fields: string[], params?: Record, pathOverride?: string | null): Promise; + deleteAssignedUsers(params?: Record): Promise; + getAssignedUsers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createAssignedUser(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getAutomotiveModels(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createBatch(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createCatalogStore(fields: string[], params?: Record, pathOverride?: string | null): Promise; + 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; + 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; + getCreatorAssetCreatives(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getDataSources(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getDestinations(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getDiagnostics(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getEventStats(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + deleteExternalEventSources(params?: Record): Promise; + 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; + 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; + createHotelRoomsBatch(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getHotels(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createHotel(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createItemsBatch(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createLocalizedItemsBatch(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; + createProductFeed(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getProductGroups(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createProductGroup(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getProductSets(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createProductSet(fields: string[], params?: Record, pathOverride?: string | null): Promise; + 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; + 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; + createVersionItemsBatch(fields: string[], params?: Record, pathOverride?: string | null): 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/product-da-event-samples-batch.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-da-event-samples-batch.d.ts new file mode 100644 index 00000000000000..00966375c9eb02 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/product-da-event-samples-batch.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ProductDaEventSamplesBatch + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ProductDaEventSamplesBatch extends AbstractCrudObject { + static get Fields(): Readonly<{ + samples: "samples"; + time_start: "time_start"; + time_stop: "time_stop"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-event-stat.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-event-stat.d.ts index e5915f7418bdf0..7e0e0830f4acde 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/product-event-stat.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/product-event-stat.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ProductEventStat * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-feed-missing-feed-item-replacement.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-feed-missing-feed-item-replacement.d.ts index ca2ba9180705f8..487a7e2a609b03 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/product-feed-missing-feed-item-replacement.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/product-feed-missing-feed-item-replacement.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ProductFeedMissingFeedItemReplacement * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-feed-rule-preview-sample.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-feed-rule-preview-sample.d.ts new file mode 100644 index 00000000000000..41afdaff64f5b3 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/product-feed-rule-preview-sample.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ProductFeedRulePreviewSample + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ProductFeedRulePreviewSample extends AbstractCrudObject { + static get Fields(): Readonly<{ + properties_after: "properties_after"; + properties_before: "properties_before"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-feed-rule-suggestion.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-feed-rule-suggestion.d.ts index 0c40f7838ce94a..ac894f5c5888c4 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/product-feed-rule-suggestion.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/product-feed-rule-suggestion.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ProductFeedRuleSuggestion * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-feed-rule.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-feed-rule.d.ts index 2490337ab7ef14..f066f0c2428719 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/product-feed-rule.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/product-feed-rule.d.ts @@ -1,5 +1,5 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; /** * ProductFeedRule * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -18,7 +18,7 @@ export default class ProductFeedRule extends AbstractCrudObject { regex_replace_rule: "regex_replace_rule"; value_mapping_rule: "value_mapping_rule"; }>; - delete(fields: string[], params?: Record): Promise; - get(fields: string[], params?: Record): Promise; - update(fields: string[], params?: Record): 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/product-feed-schedule.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-feed-schedule.d.ts index 5c960f2f36d614..609854253ad011 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/product-feed-schedule.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/product-feed-schedule.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ProductFeedSchedule * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -22,5 +22,5 @@ export default class ProductFeedSchedule extends AbstractCrudObject { monthly: "MONTHLY"; weekly: "WEEKLY"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-feed-upload-error-report.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-feed-upload-error-report.d.ts index a65a813f4ec79d..c385ed0d1b33be 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/product-feed-upload-error-report.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/product-feed-upload-error-report.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ProductFeedUploadErrorReport * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-feed-upload-error-sample.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-feed-upload-error-sample.d.ts index 962f182d455d59..60ced5a20c48b8 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/product-feed-upload-error-sample.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/product-feed-upload-error-sample.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ProductFeedUploadErrorSample * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -9,5 +9,5 @@ export default class ProductFeedUploadErrorSample extends AbstractCrudObject { retailer_id: "retailer_id"; row_number: "row_number"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-feed-upload-error.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-feed-upload-error.d.ts index 62540547ab8b5e..b0fe99f6012083 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/product-feed-upload-error.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/product-feed-upload-error.d.ts @@ -1,5 +1,5 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; /** * ProductFeedUploadError * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -28,11 +28,7 @@ export default class ProductFeedUploadError extends AbstractCrudObject { low: "LOW"; medium: "MEDIUM"; }>; - getSamples(fields: string[], params?: Record): Promise; - getSamples(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getSamples(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getSuggestedRules(fields: string[], params?: Record): Promise; - getSuggestedRules(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getSuggestedRules(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - get(fields: string[], params?: Record): Promise; + getSamples(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getSuggestedRules(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-feed-upload-progress.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-feed-upload-progress.d.ts new file mode 100644 index 00000000000000..8933fd269f6286 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/product-feed-upload-progress.d.ts @@ -0,0 +1,14 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ProductFeedUploadProgress + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ProductFeedUploadProgress extends AbstractCrudObject { + static get Fields(): Readonly<{ + pos: "pos"; + size: "size"; + step: "step"; + unit: "unit"; + updated_time: "updated_time"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-feed-upload.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-feed-upload.d.ts index 4bbc0ef065d62f..2d1bb5525346b2 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/product-feed-upload.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/product-feed-upload.d.ts @@ -1,5 +1,5 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; /** * ProductFeedUpload * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -27,9 +27,7 @@ export default class ProductFeedUpload extends AbstractCrudObject { server_fetch: "Server Fetch"; user_initiated_server_fetch: "User initiated server fetch"; }>; - createErrorReport(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getErrors(fields: string[], params?: Record): Promise; - getErrors(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getErrors(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - get(fields: string[], params?: Record): Promise; + createErrorReport(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getErrors(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + get(fields: string[], params?: Record): 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 cceacfd96b59cf..291c5b2e8408d2 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 @@ -1,8 +1,8 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; -import Cursor from './../cursor'; -import ProductFeedRule from './product-feed-rule'; -import ProductFeedUpload from './product-feed-upload'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; +import Cursor from "./../cursor"; +import ProductFeedRule from "./product-feed-rule"; +import ProductFeedUpload from "./product-feed-upload"; /** * ProductFeed * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -107,48 +107,25 @@ export default class ProductFeed extends AbstractCrudObject { language_and_country: "LANGUAGE_AND_COUNTRY"; local: "LOCAL"; smart_pixel_language_or_country: "SMART_PIXEL_LANGUAGE_OR_COUNTRY"; + version: "VERSION"; }>; - getAutomotiveModels(fields: string[], params?: Record): Promise; - getAutomotiveModels(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAutomotiveModels(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getDestinations(fields: string[], params?: Record): Promise; - getDestinations(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getDestinations(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getFlights(fields: string[], params?: Record): Promise; - getFlights(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getFlights(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getHomeListings(fields: string[], params?: Record): Promise; - getHomeListings(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getHomeListings(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getHotels(fields: string[], params?: Record): Promise; - getHotels(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getHotels(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getMediaTitles(fields: string[], params?: Record): Promise; - getMediaTitles(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getMediaTitles(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getProducts(fields: string[], params?: Record): Promise; - getProducts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getProducts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getRules(fields: string[], params?: Record): Promise; - getRules(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getRules(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createRule(fields: string[], params?: Record, pathOverride?: string | null): Promise; - createSupplementaryFeedAssoc(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getUploadSchedules(fields: string[], params?: Record): Promise; - getUploadSchedules(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getUploadSchedules(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createUploadSchedule(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getUploads(fields: string[], params?: Record): Promise; - getUploads(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getUploads(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createUpload(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getVehicleOffers(fields: string[], params?: Record): Promise; - getVehicleOffers(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getVehicleOffers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getVehicles(fields: string[], params?: Record): Promise; - getVehicles(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getVehicles(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; + getAutomotiveModels(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getDestinations(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getFlights(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getHomeListings(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getHotels(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getMediaTitles(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getProducts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getRules(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createRule(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createSupplementaryFeedAssoc(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getUploadSchedules(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createUploadSchedule(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getUploads(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createUpload(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; + 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/product-group.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-group.d.ts index 2d3825f2429706..5569ba97477a14 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/product-group.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/product-group.d.ts @@ -1,7 +1,7 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; -import Cursor from './../cursor'; -import ProductItem from './product-item'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; +import Cursor from "./../cursor"; +import ProductItem from "./product-item"; /** * ProductGroup * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -13,11 +13,9 @@ export default class ProductGroup extends AbstractCrudObject { retailer_id: "retailer_id"; variants: "variants"; }>; - getProducts(fields: string[], params?: Record): Promise; - getProducts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getProducts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createProduct(fields: string[], params?: Record, pathOverride?: string | null): Promise; - delete(fields: string[], params?: Record): Promise; - get(fields: string[], params?: Record): Promise; - update(fields: string[], params?: Record): Promise; + getProducts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createProduct(fields: string[], params?: Record, pathOverride?: string | null): 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/product-image.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-image.d.ts index 50e72337cb7f93..e31a7923f8f1e3 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/product-image.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/product-image.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ProductImage * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -10,5 +10,5 @@ export default class ProductImage extends AbstractCrudObject { image_url: "image_url"; width: "width"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-item-commerce-insights.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-item-commerce-insights.d.ts index 1c5a6d91c907c0..6599535d717b7e 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/product-item-commerce-insights.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/product-item-commerce-insights.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ProductItemCommerceInsights * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-item-error.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-item-error.d.ts index 12019ea9351a8e..fc5a8bcb22a457 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/product-item-error.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/product-item-error.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ProductItemError * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-item-importer-address.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-item-importer-address.d.ts index 703a23345ce073..0ecd3cb6ef98cd 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/product-item-importer-address.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/product-item-importer-address.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ProductItemImporterAddress * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-item-insights.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-item-insights.d.ts new file mode 100644 index 00000000000000..8f8312ffc99369 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/product-item-insights.d.ts @@ -0,0 +1,14 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ProductItemInsights + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ProductItemInsights extends AbstractCrudObject { + static get Fields(): Readonly<{ + ad_click_count: "ad_click_count"; + ad_impression_count: "ad_impression_count"; + add_to_cart_count: "add_to_cart_count"; + purchase_count: "purchase_count"; + view_content_count: "view_content_count"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-item-invalidation-error.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-item-invalidation-error.d.ts new file mode 100644 index 00000000000000..db424c9bf4cee6 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/product-item-invalidation-error.d.ts @@ -0,0 +1,8 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ProductItemInvalidationError + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ProductItemInvalidationError extends AbstractCrudObject { + static get Fields(): Readonly<{}>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-item-landing-page-data.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-item-landing-page-data.d.ts new file mode 100644 index 00000000000000..6e201cb73813ee --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/product-item-landing-page-data.d.ts @@ -0,0 +1,19 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ProductItemLandingPageData + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ProductItemLandingPageData extends AbstractCrudObject { + static get Fields(): Readonly<{ + availability: "availability"; + }>; + static get Availability(): Readonly<{ + available_for_order: "available for order"; + discontinued: "discontinued"; + in_stock: "in stock"; + mark_as_sold: "mark_as_sold"; + out_of_stock: "out of stock"; + pending: "pending"; + preorder: "preorder"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-item-local-info-lat-long-shape.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-item-local-info-lat-long-shape.d.ts index 6836645f7f1051..3aff9486c82c30 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/product-item-local-info-lat-long-shape.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/product-item-local-info-lat-long-shape.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ProductItemLocalInfoLatLongShape * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-item-local-info.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-item-local-info.d.ts index 97736db69ee534..c4d747f5253e51 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/product-item-local-info.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/product-item-local-info.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ProductItemLocalInfo * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -15,5 +15,5 @@ export default class ProductItemLocalInfo extends AbstractCrudObject { inferred_circle_origin: "inferred_circle_origin"; inferred_circle_radius: "inferred_circle_radius"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-item-offer.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-item-offer.d.ts new file mode 100644 index 00000000000000..f78ebeb145d138 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/product-item-offer.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ProductItemOffer + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ProductItemOffer extends AbstractCrudObject { + static get Fields(): Readonly<{ + availability_area: "availability_area"; + availability_radius: "availability_radius"; + id: "id"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-item-shipping.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-item-shipping.d.ts new file mode 100644 index 00000000000000..82e3f22b06d74b --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/product-item-shipping.d.ts @@ -0,0 +1,14 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ProductItemShipping + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ProductItemShipping extends AbstractCrudObject { + static get Fields(): Readonly<{ + shipping_country: "shipping_country"; + shipping_price_currency: "shipping_price_currency"; + shipping_price_value: "shipping_price_value"; + shipping_region: "shipping_region"; + shipping_service: "shipping_service"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-item-subscription-info.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-item-subscription-info.d.ts new file mode 100644 index 00000000000000..b5dc479b71db41 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/product-item-subscription-info.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ProductItemSubscriptionInfo + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ProductItemSubscriptionInfo extends AbstractCrudObject { + static get Fields(): Readonly<{ + is_subscribable: "is_subscribable"; + subscription_billing_period: "subscription_billing_period"; + subscription_billing_type: "subscription_billing_type"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-item-unit-price.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-item-unit-price.d.ts new file mode 100644 index 00000000000000..d8e794684b802d --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/product-item-unit-price.d.ts @@ -0,0 +1,8 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ProductItemUnitPrice + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ProductItemUnitPrice extends AbstractCrudObject { + static get Fields(): Readonly<{}>; +} 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 6f9f8cb0b5d654..85e4f806a89bb5 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 @@ -1,6 +1,6 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; +import Cursor from "./../cursor"; /** * ProductItem * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -77,6 +77,7 @@ export default class ProductItem extends AbstractCrudObject { short_description: "short_description"; size: "size"; start_date: "start_date"; + tags: "tags"; url: "url"; video_fetch_status: "video_fetch_status"; visibility: "visibility"; @@ -360,26 +361,40 @@ export default class ProductItem extends AbstractCrudObject { medium: "MEDIUM"; }>; static get ErrorType(): Readonly<{ + address_blocklisted_in_market: "ADDRESS_BLOCKLISTED_IN_MARKET"; + aggregated_localization_issues: "AGGREGATED_LOCALIZATION_ISSUES"; + app_has_no_aem_setup: "APP_HAS_NO_AEM_SETUP"; ar_deleted_due_to_update: "AR_DELETED_DUE_TO_UPDATE"; ar_policy_violated: "AR_POLICY_VIOLATED"; available: "AVAILABLE"; bad_quality_image: "BAD_QUALITY_IMAGE"; + big_catalog_with_all_items_in_stock: "BIG_CATALOG_WITH_ALL_ITEMS_IN_STOCK"; + biz_msg_ai_agent_disabled_by_user: "BIZ_MSG_AI_AGENT_DISABLED_BY_USER"; cannot_edit_subscription_products: "CANNOT_EDIT_SUBSCRIPTION_PRODUCTS"; + catalog_not_connected_to_event_source: "CATALOG_NOT_CONNECTED_TO_EVENT_SOURCE"; + checkout_disabled_by_user: "CHECKOUT_DISABLED_BY_USER"; + commerce_account_legal_address_invalid: "COMMERCE_ACCOUNT_LEGAL_ADDRESS_INVALID"; 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_violation: "DA_POLICY_VIOLATION"; + deleted_item: "DELETED_ITEM"; digital_goods_not_available_for_checkout: "DIGITAL_GOODS_NOT_AVAILABLE_FOR_CHECKOUT"; duplicate_images: "DUPLICATE_IMAGES"; duplicate_title_and_description: "DUPLICATE_TITLE_AND_DESCRIPTION"; empty_availability: "EMPTY_AVAILABILITY"; empty_condition: "EMPTY_CONDITION"; empty_description: "EMPTY_DESCRIPTION"; + empty_image_url: "EMPTY_IMAGE_URL"; + empty_price: "EMPTY_PRICE"; empty_product_url: "EMPTY_PRODUCT_URL"; empty_seller_description: "EMPTY_SELLER_DESCRIPTION"; + empty_title: "EMPTY_TITLE"; external_merchant_id_mismatch: "EXTERNAL_MERCHANT_ID_MISMATCH"; generic_invalid_field: "GENERIC_INVALID_FIELD"; + groups_disabled_by_user: "GROUPS_DISABLED_BY_USER"; hidden_until_product_launch: "HIDDEN_UNTIL_PRODUCT_LAUNCH"; + illegal_product_category: "ILLEGAL_PRODUCT_CATEGORY"; image_fetch_failed: "IMAGE_FETCH_FAILED"; image_fetch_failed_bad_gateway: "IMAGE_FETCH_FAILED_BAD_GATEWAY"; image_fetch_failed_file_size_exceeded: "IMAGE_FETCH_FAILED_FILE_SIZE_EXCEEDED"; @@ -389,13 +404,29 @@ export default class ProductItem extends AbstractCrudObject { image_resolution_low: "IMAGE_RESOLUTION_LOW"; inactive_shopify_product: "INACTIVE_SHOPIFY_PRODUCT"; invalid_commerce_tax_category: "INVALID_COMMERCE_TAX_CATEGORY"; + invalid_consolidated_locality_information: "INVALID_CONSOLIDATED_LOCALITY_INFORMATION"; + invalid_content_id: "INVALID_CONTENT_ID"; + invalid_dealer_communication_parameters: "INVALID_DEALER_COMMUNICATION_PARAMETERS"; + invalid_dma_codes: "INVALID_DMA_CODES"; + invalid_fb_page_id: "INVALID_FB_PAGE_ID"; invalid_images: "INVALID_IMAGES"; invalid_monetizer_return_policy: "INVALID_MONETIZER_RETURN_POLICY"; + invalid_offer_disclaimer_url: "INVALID_OFFER_DISCLAIMER_URL"; + invalid_offer_end_date: "INVALID_OFFER_END_DATE"; invalid_pre_order_params: "INVALID_PRE_ORDER_PARAMS"; + invalid_range_for_area_size: "INVALID_RANGE_FOR_AREA_SIZE"; + invalid_range_for_built_up_area_size: "INVALID_RANGE_FOR_BUILT_UP_AREA_SIZE"; + invalid_range_for_num_of_baths: "INVALID_RANGE_FOR_NUM_OF_BATHS"; + invalid_range_for_num_of_beds: "INVALID_RANGE_FOR_NUM_OF_BEDS"; + invalid_range_for_num_of_rooms: "INVALID_RANGE_FOR_NUM_OF_ROOMS"; + invalid_range_for_parking_spaces: "INVALID_RANGE_FOR_PARKING_SPACES"; + invalid_shelter_page_id: "INVALID_SHELTER_PAGE_ID"; invalid_shipping_profile_params: "INVALID_SHIPPING_PROFILE_PARAMS"; invalid_subscription_disable_params: "INVALID_SUBSCRIPTION_DISABLE_PARAMS"; invalid_subscription_enable_params: "INVALID_SUBSCRIPTION_ENABLE_PARAMS"; invalid_subscription_params: "INVALID_SUBSCRIPTION_PARAMS"; + invalid_vehicle_state: "INVALID_VEHICLE_STATE"; + invalid_virtual_tour_url_domain: "INVALID_VIRTUAL_TOUR_URL_DOMAIN"; inventory_zero_availability_in_stock: "INVENTORY_ZERO_AVAILABILITY_IN_STOCK"; in_another_product_launch: "IN_ANOTHER_PRODUCT_LAUNCH"; item_group_not_specified: "ITEM_GROUP_NOT_SPECIFIED"; @@ -403,20 +434,28 @@ export default class ProductItem extends AbstractCrudObject { item_override_empty_availability: "ITEM_OVERRIDE_EMPTY_AVAILABILITY"; item_override_empty_price: "ITEM_OVERRIDE_EMPTY_PRICE"; item_override_not_visible: "ITEM_OVERRIDE_NOT_VISIBLE"; + item_price_not_positive: "ITEM_PRICE_NOT_POSITIVE"; item_stale_out_of_stock: "ITEM_STALE_OUT_OF_STOCK"; + marketplace_disabled_by_user: "MARKETPLACE_DISABLED_BY_USER"; mini_shops_disabled_by_user: "MINI_SHOPS_DISABLED_BY_USER"; missing_checkout: "MISSING_CHECKOUT"; missing_checkout_currency: "MISSING_CHECKOUT_CURRENCY"; missing_color: "MISSING_COLOR"; missing_country_override_in_shipping_profile: "MISSING_COUNTRY_OVERRIDE_IN_SHIPPING_PROFILE"; + missing_event: "MISSING_EVENT"; missing_india_compliance_fields: "MISSING_INDIA_COMPLIANCE_FIELDS"; missing_shipping_profile: "MISSING_SHIPPING_PROFILE"; missing_size: "MISSING_SIZE"; missing_tax_category: "MISSING_TAX_CATEGORY"; negative_community_feedback: "NEGATIVE_COMMUNITY_FEEDBACK"; + negative_price: "NEGATIVE_PRICE"; not_enough_images: "NOT_ENOUGH_IMAGES"; not_enough_unique_products: "NOT_ENOUGH_UNIQUE_PRODUCTS"; + no_content_id: "NO_CONTENT_ID"; + overlay_disclaimer_exceeded_max_length: "OVERLAY_DISCLAIMER_EXCEEDED_MAX_LENGTH"; part_of_product_launch: "PART_OF_PRODUCT_LAUNCH"; + passing_multiple_content_ids: "PASSING_MULTIPLE_CONTENT_IDS"; + product_dominant_currency_mismatch: "PRODUCT_DOMINANT_CURRENCY_MISMATCH"; product_expired: "PRODUCT_EXPIRED"; product_item_hidden_from_all_shops: "PRODUCT_ITEM_HIDDEN_FROM_ALL_SHOPS"; product_item_invalid_partner_tokens: "PRODUCT_ITEM_INVALID_PARTNER_TOKENS"; @@ -440,6 +479,8 @@ export default class ProductItem extends AbstractCrudObject { property_value_string_too_short: "PROPERTY_VALUE_STRING_TOO_SHORT"; property_value_uppercase: "PROPERTY_VALUE_UPPERCASE"; property_value_uppercase_warning: "PROPERTY_VALUE_UPPERCASE_WARNING"; + purchase_rate_below_addtocart: "PURCHASE_RATE_BELOW_ADDTOCART"; + purchase_rate_below_viewcontent: "PURCHASE_RATE_BELOW_VIEWCONTENT"; quality_duplicated_description: "QUALITY_DUPLICATED_DESCRIPTION"; quality_item_link_broken: "QUALITY_ITEM_LINK_BROKEN"; quality_item_link_redirecting: "QUALITY_ITEM_LINK_REDIRECTING"; @@ -449,6 +490,8 @@ export default class ProductItem extends AbstractCrudObject { shops_policy_violation: "SHOPS_POLICY_VIOLATION"; subscription_info_not_enabled_for_feed: "SUBSCRIPTION_INFO_NOT_ENABLED_FOR_FEED"; tax_category_not_supported_in_uk: "TAX_CATEGORY_NOT_SUPPORTED_IN_UK"; + unique_product_identifier_missing: "UNIQUE_PRODUCT_IDENTIFIER_MISSING"; + unmatched_events: "UNMATCHED_EVENTS"; unsupported_product_category: "UNSUPPORTED_PRODUCT_CATEGORY"; variant_attribute_issue: "VARIANT_ATTRIBUTE_ISSUE"; video_fetch_failed: "VIDEO_FETCH_FAILED"; @@ -458,6 +501,8 @@ export default class ProductItem extends AbstractCrudObject { video_fetch_failed_link_broken: "VIDEO_FETCH_FAILED_LINK_BROKEN"; video_fetch_failed_timed_out: "VIDEO_FETCH_FAILED_TIMED_OUT"; video_not_downloadable: "VIDEO_NOT_DOWNLOADABLE"; + whatsapp_disabled_by_user: "WHATSAPP_DISABLED_BY_USER"; + whatsapp_policy_violation: "WHATSAPP_POLICY_VIOLATION"; }>; static get MarkedForProductLaunch(): Readonly<{ default: "default"; @@ -721,16 +766,10 @@ export default class ProductItem extends AbstractCrudObject { country_origin_exempt: "COUNTRY_ORIGIN_EXEMPT"; default: "DEFAULT"; }>; - getChannelsToIntegrityStatus(fields: string[], params?: Record): Promise; - getChannelsToIntegrityStatus(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getChannelsToIntegrityStatus(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getProductSets(fields: string[], params?: Record): Promise; - getProductSets(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getProductSets(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getVideosMetadata(fields: string[], params?: Record): Promise; - getVideosMetadata(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getVideosMetadata(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; + getChannelsToIntegrityStatus(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getProductSets(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getVideosMetadata(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/product-set-metadata.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-set-metadata.d.ts index ba564266315faa..201db422462c17 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/product-set-metadata.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/product-set-metadata.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ProductSetMetadata * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-set-taxon-category.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-set-taxon-category.d.ts new file mode 100644 index 00000000000000..14f50ec9241afd --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/product-set-taxon-category.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ProductSetTaxonCategory + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ProductSetTaxonCategory extends AbstractCrudObject { + static get Fields(): Readonly<{ + category_id: "category_id"; + category_name: "category_name"; + image_url: "image_url"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-set-usage.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-set-usage.d.ts new file mode 100644 index 00000000000000..55b906a337b1ef --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/product-set-usage.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ProductSetUsage + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ProductSetUsage extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + product_set: "product_set"; + usage_type: "usage_type"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-set.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-set.d.ts index 4e84a4e4eb6b69..d3988baaf0a73e 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/product-set.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/product-set.d.ts @@ -1,6 +1,6 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; +import Cursor from "./../cursor"; /** * ProductSet * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -18,34 +18,16 @@ export default class ProductSet extends AbstractCrudObject { product_count: "product_count"; retailer_id: "retailer_id"; }>; - getAutomotiveModels(fields: string[], params?: Record): Promise; - getAutomotiveModels(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAutomotiveModels(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getDestinations(fields: string[], params?: Record): Promise; - getDestinations(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getDestinations(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getFlights(fields: string[], params?: Record): Promise; - getFlights(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getFlights(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getHomeListings(fields: string[], params?: Record): Promise; - getHomeListings(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getHomeListings(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getHotels(fields: string[], params?: Record): Promise; - getHotels(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getHotels(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getMediaTitles(fields: string[], params?: Record): Promise; - getMediaTitles(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getMediaTitles(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getProducts(fields: string[], params?: Record): Promise; - getProducts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getProducts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getVehicleOffers(fields: string[], params?: Record): Promise; - getVehicleOffers(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getVehicleOffers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getVehicles(fields: string[], params?: Record): Promise; - getVehicles(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getVehicles(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; + getAutomotiveModels(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getDestinations(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getFlights(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getHomeListings(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getHotels(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getMediaTitles(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getProducts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getVehicleOffers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getVehicles(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/product-variant.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-variant.d.ts index cfdc2b4c8916e7..8ede20eca1a4de 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/product-variant.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/product-variant.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ProductVariant * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/product-visual-variant.d.ts b/types/facebook-nodejs-business-sdk/src/objects/product-visual-variant.d.ts new file mode 100644 index 00000000000000..dae49ee4d53222 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/product-visual-variant.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ProductVisualVariant + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ProductVisualVariant extends AbstractCrudObject { + static get Fields(): Readonly<{ + items: "items"; + unique_key: "unique_key"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/profile-picture-source.d.ts b/types/facebook-nodejs-business-sdk/src/objects/profile-picture-source.d.ts index 78f85eb58b274f..b6a162c40760cc 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/profile-picture-source.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/profile-picture-source.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ProfilePictureSource * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -20,7 +20,4 @@ export default class ProfilePictureSource extends AbstractCrudObject { small: "small"; thumbnail: "thumbnail"; }>; - static get BreakingChange(): Readonly<{ - profile_picture: "PROFILE_PICTURE"; - }>; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/profile.d.ts b/types/facebook-nodejs-business-sdk/src/objects/profile.d.ts index e886cd67945578..b4ae7da852c48c 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/profile.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/profile.d.ts @@ -1,5 +1,5 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; /** * Profile * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -39,8 +39,6 @@ export default class Profile extends AbstractCrudObject { thankful: "THANKFUL"; wow: "WOW"; }>; - getPicture(fields: string[], params?: Record): Promise; - getPicture(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPicture(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - get(fields: string[], params?: Record): Promise; + getPicture(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/publisher-block-list.d.ts b/types/facebook-nodejs-business-sdk/src/objects/publisher-block-list.d.ts index 3f899e09b82d3f..43db6aae67f3ab 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/publisher-block-list.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/publisher-block-list.d.ts @@ -1,6 +1,6 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; +import Cursor from "./../cursor"; /** * PublisherBlockList * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -18,11 +18,9 @@ export default class PublisherBlockList extends AbstractCrudObject { owner_ad_account_id: "owner_ad_account_id"; web_publishers: "web_publishers"; }>; - createAppEndPublisherUrl(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getPagedWebPublishers(fields: string[], params?: Record): Promise; - getPagedWebPublishers(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPagedWebPublishers(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; + createAppendPublisherUrl(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getPagedWebPublishers(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/publisher-delivery-report.d.ts b/types/facebook-nodejs-business-sdk/src/objects/publisher-delivery-report.d.ts new file mode 100644 index 00000000000000..97ab431824dd4e --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/publisher-delivery-report.d.ts @@ -0,0 +1,14 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * PublisherDeliveryReport + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class PublisherDeliveryReport extends AbstractCrudObject { + static get Fields(): Readonly<{ + content_types: "content_types"; + estimated_impressions: "estimated_impressions"; + name: "name"; + status: "status"; + url: "url"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/publisher-white-list.d.ts b/types/facebook-nodejs-business-sdk/src/objects/publisher-white-list.d.ts new file mode 100644 index 00000000000000..8ad2eafac5714e --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/publisher-white-list.d.ts @@ -0,0 +1,16 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * PublisherWhiteList + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class PublisherWhiteList extends AbstractCrudObject { + static get Fields(): Readonly<{ + business_owner_id: "business_owner_id"; + id: "id"; + last_updated_time: "last_updated_time"; + last_updated_user: "last_updated_user"; + name: "name"; + placement_type: "placement_type"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/raw-custom-audience.d.ts b/types/facebook-nodejs-business-sdk/src/objects/raw-custom-audience.d.ts index 1a87f8b2e05624..ee7499a1dfc057 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/raw-custom-audience.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/raw-custom-audience.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * RawCustomAudience * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/reach-frequency-activity.d.ts b/types/facebook-nodejs-business-sdk/src/objects/reach-frequency-activity.d.ts index c3dc537268365c..325b3327491b7b 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/reach-frequency-activity.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/reach-frequency-activity.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ReachFrequencyActivity * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/reach-frequency-ad-format.d.ts b/types/facebook-nodejs-business-sdk/src/objects/reach-frequency-ad-format.d.ts index 6e61882d30cb2d..b964189b9a2020 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/reach-frequency-ad-format.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/reach-frequency-ad-format.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ReachFrequencyAdFormat * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/reach-frequency-curve-lower-confidence-range.d.ts b/types/facebook-nodejs-business-sdk/src/objects/reach-frequency-curve-lower-confidence-range.d.ts index f53f5438a9e594..bef111a546d949 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/reach-frequency-curve-lower-confidence-range.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/reach-frequency-curve-lower-confidence-range.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ReachFrequencyCurveLowerConfidenceRange * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/reach-frequency-curve-upper-confidence-range.d.ts b/types/facebook-nodejs-business-sdk/src/objects/reach-frequency-curve-upper-confidence-range.d.ts index 151a20759df8cc..04fd1a66625afb 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/reach-frequency-curve-upper-confidence-range.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/reach-frequency-curve-upper-confidence-range.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ReachFrequencyCurveUpperConfidenceRange * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/reach-frequency-day-part.d.ts b/types/facebook-nodejs-business-sdk/src/objects/reach-frequency-day-part.d.ts index 39e6629f59eae3..70ae3dd766187f 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/reach-frequency-day-part.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/reach-frequency-day-part.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ReachFrequencyDayPart * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/reach-frequency-estimates-curve.d.ts b/types/facebook-nodejs-business-sdk/src/objects/reach-frequency-estimates-curve.d.ts index eeb0e186cf1d40..520f5967d02a80 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/reach-frequency-estimates-curve.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/reach-frequency-estimates-curve.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ReachFrequencyEstimatesCurve * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/reach-frequency-estimates-placement-breakdown.d.ts b/types/facebook-nodejs-business-sdk/src/objects/reach-frequency-estimates-placement-breakdown.d.ts index c36e6504caa0c9..c78e6f1aee5e63 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/reach-frequency-estimates-placement-breakdown.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/reach-frequency-estimates-placement-breakdown.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ReachFrequencyEstimatesPlacementBreakdown * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/reach-frequency-prediction.d.ts b/types/facebook-nodejs-business-sdk/src/objects/reach-frequency-prediction.d.ts index b132e6bea7c08b..d2dcf19ec26187 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/reach-frequency-prediction.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/reach-frequency-prediction.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ReachFrequencyPrediction * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -122,5 +122,5 @@ export default class ReachFrequencyPrediction extends AbstractCrudObject { spanish: "SPANISH"; sports: "SPORTS"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/reach-frequency-spec.d.ts b/types/facebook-nodejs-business-sdk/src/objects/reach-frequency-spec.d.ts index 8c3b234f38169d..4fba72a299b65d 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/reach-frequency-spec.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/reach-frequency-spec.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ReachFrequencySpec * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/recommendation.d.ts b/types/facebook-nodejs-business-sdk/src/objects/recommendation.d.ts index ad325dcc111b58..2a2bff8c431942 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/recommendation.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/recommendation.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * Recommendation * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/recommended-ig-media.d.ts b/types/facebook-nodejs-business-sdk/src/objects/recommended-ig-media.d.ts new file mode 100644 index 00000000000000..9a311546c8e718 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/recommended-ig-media.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * RecommendedIGMedia + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class RecommendedIGMedia extends AbstractCrudObject { + static get Fields(): Readonly<{ + intent_score: "intent_score"; + media: "media"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/recommended-page-post.d.ts b/types/facebook-nodejs-business-sdk/src/objects/recommended-page-post.d.ts new file mode 100644 index 00000000000000..25567d33750e2e --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/recommended-page-post.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * RecommendedPagePost + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class RecommendedPagePost extends AbstractCrudObject { + static get Fields(): Readonly<{ + intent_score: "intent_score"; + is_ig_media: "is_ig_media"; + post_id: "post_id"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/regional-regulation-identities.d.ts b/types/facebook-nodejs-business-sdk/src/objects/regional-regulation-identities.d.ts new file mode 100644 index 00000000000000..d4518196090576 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/regional-regulation-identities.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * RegionalRegulationIdentities + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class RegionalRegulationIdentities extends AbstractCrudObject { + static get Fields(): Readonly<{ + taiwan_finserv_beneficiary: "taiwan_finserv_beneficiary"; + taiwan_finserv_payer: "taiwan_finserv_payer"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/reporting-audience.d.ts b/types/facebook-nodejs-business-sdk/src/objects/reporting-audience.d.ts new file mode 100644 index 00000000000000..9d3875d462f11f --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/reporting-audience.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ReportingAudience + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ReportingAudience extends AbstractCrudObject { + static get Fields(): Readonly<{ + custom_audiences: "custom_audiences"; + custom_audiences_url_param_name: "custom_audiences_url_param_name"; + custom_audiences_url_param_type: "custom_audiences_url_param_type"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/research-poll-study.d.ts b/types/facebook-nodejs-business-sdk/src/objects/research-poll-study.d.ts new file mode 100644 index 00000000000000..891e992c266d6c --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/research-poll-study.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ResearchPollStudy + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ResearchPollStudy extends AbstractCrudObject { + static get Fields(): Readonly<{ + account: "account"; + id: "id"; + name: "name"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/reseller-guidance.d.ts b/types/facebook-nodejs-business-sdk/src/objects/reseller-guidance.d.ts new file mode 100644 index 00000000000000..7cd40257a50c58 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/reseller-guidance.d.ts @@ -0,0 +1,26 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ResellerGuidance + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ResellerGuidance extends AbstractCrudObject { + static get Fields(): Readonly<{ + ad_account_first_spend_date: "ad_account_first_spend_date"; + ad_account_id: "ad_account_id"; + adopted_guidance_l7d: "adopted_guidance_l7d"; + advertiser_name: "advertiser_name"; + attributed_to_reseller_l7d: "attributed_to_reseller_l7d"; + available_guidance: "available_guidance"; + benchmark_report_link: "benchmark_report_link"; + guidance_adoption_rate_l7d: "guidance_adoption_rate_l7d"; + no_adsets_gte_benchmark: "no_adsets_gte_benchmark"; + no_adsets_lt_benchmark: "no_adsets_lt_benchmark"; + nurtured_by_reseller_l7d: "nurtured_by_reseller_l7d"; + planning_agency_name: "planning_agency_name"; + recommendation_time: "recommendation_time"; + reporting_ds: "reporting_ds"; + reseller: "reseller"; + revenue_l30d: "revenue_l30d"; + ultimate_advertiser_name: "ultimate_advertiser_name"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/rev-share-policy.d.ts b/types/facebook-nodejs-business-sdk/src/objects/rev-share-policy.d.ts index db40b18b598775..c9bd7daff27fea 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/rev-share-policy.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/rev-share-policy.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * RevSharePolicy * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/rich-media-element.d.ts b/types/facebook-nodejs-business-sdk/src/objects/rich-media-element.d.ts index b4df4f8d616fa3..af80376e073555 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/rich-media-element.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/rich-media-element.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * RichMediaElement * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/rights-manager-data-export.d.ts b/types/facebook-nodejs-business-sdk/src/objects/rights-manager-data-export.d.ts new file mode 100644 index 00000000000000..467368fb642ea1 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/rights-manager-data-export.d.ts @@ -0,0 +1,17 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * RightsManagerDataExport + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class RightsManagerDataExport extends AbstractCrudObject { + static get Fields(): Readonly<{ + download_uri: "download_uri"; + export_scope: "export_scope"; + id: "id"; + name: "name"; + record_type: "record_type"; + time_range_end: "time_range_end"; + time_range_start: "time_range_start"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/instant-articles-stats.d.ts b/types/facebook-nodejs-business-sdk/src/objects/rights-manager-insights.d.ts similarity index 55% rename from types/facebook-nodejs-business-sdk/src/objects/instant-articles-stats.d.ts rename to types/facebook-nodejs-business-sdk/src/objects/rights-manager-insights.d.ts index e263b8dfca363b..05e08cd1e1b9b5 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/instant-articles-stats.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/rights-manager-insights.d.ts @@ -1,13 +1,13 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** - * InstantArticlesStats + * RightsManagerInsights * @see {@link https://developers.facebook.com/docs/marketing-api/} */ -export default class InstantArticlesStats extends AbstractCrudObject { +export default class RightsManagerInsights extends AbstractCrudObject { static get Fields(): Readonly<{ error: "error"; + error_message: "error_message"; metadata: "metadata"; - metric: "metric"; totals: "totals"; x_axis_breakdown: "x_axis_breakdown"; }>; diff --git a/types/facebook-nodejs-business-sdk/src/objects/robot.d.ts b/types/facebook-nodejs-business-sdk/src/objects/robot.d.ts new file mode 100644 index 00000000000000..accb1b6cd3d701 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/robot.d.ts @@ -0,0 +1,22 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * Robot + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class Robot extends AbstractCrudObject { + static get Fields(): Readonly<{ + bringup_vars: "bringup_vars"; + configurations: "configurations"; + data_center: "data_center"; + id: "id"; + init_pos: "init_pos"; + last_pos: "last_pos"; + meetup_link_hash: "meetup_link_hash"; + suite: "suite"; + target_map_image_uri: "target_map_image_uri"; + target_os_image_uri: "target_os_image_uri"; + target_sw_image_uri: "target_sw_image_uri"; + user: "user"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/rtb-dynamic-post.d.ts b/types/facebook-nodejs-business-sdk/src/objects/rtb-dynamic-post.d.ts index 0f6a4d9e5a79d8..ea3693bc53de1c 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/rtb-dynamic-post.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/rtb-dynamic-post.d.ts @@ -1,5 +1,5 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; /** * RTBDynamicPost * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -18,11 +18,7 @@ export default class RTBDynamicPost extends AbstractCrudObject { product_id: "product_id"; title: "title"; }>; - getComments(fields: string[], params?: Record): Promise; - getComments(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getComments(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getLikes(fields: string[], params?: Record): Promise; - getLikes(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getLikes(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - get(fields: string[], params?: Record): Promise; + getComments(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getLikes(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/sales-rights-inventory-management.d.ts b/types/facebook-nodejs-business-sdk/src/objects/sales-rights-inventory-management.d.ts new file mode 100644 index 00000000000000..17c5b1c5cf94b4 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/sales-rights-inventory-management.d.ts @@ -0,0 +1,16 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * SalesRightsInventoryManagement + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class SalesRightsInventoryManagement extends AbstractCrudObject { + static get Fields(): Readonly<{ + available_impressions: "available_impressions"; + booked_impressions: "booked_impressions"; + overbooked_impressions: "overbooked_impressions"; + supported_countries: "supported_countries"; + total_impressions: "total_impressions"; + unavailable_impressions: "unavailable_impressions"; + warning_messages: "warning_messages"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/saved-audience.d.ts b/types/facebook-nodejs-business-sdk/src/objects/saved-audience.d.ts index 4856ad20430b4b..fb07280cd7d42b 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/saved-audience.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/saved-audience.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * SavedAudience * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -22,5 +22,5 @@ export default class SavedAudience extends AbstractCrudObject { time_created: "time_created"; time_updated: "time_updated"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/saved-message-response.d.ts b/types/facebook-nodejs-business-sdk/src/objects/saved-message-response.d.ts index cbf25ce6f5a313..d663173758aa6f 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/saved-message-response.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/saved-message-response.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * SavedMessageResponse * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -12,5 +12,5 @@ export default class SavedMessageResponse extends AbstractCrudObject { message: "message"; title: "title"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/scheduled-post.d.ts b/types/facebook-nodejs-business-sdk/src/objects/scheduled-post.d.ts new file mode 100644 index 00000000000000..e31f1d503ac741 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/scheduled-post.d.ts @@ -0,0 +1,26 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ScheduledPost + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ScheduledPost extends AbstractCrudObject { + static get Fields(): Readonly<{ + admin_creator: "admin_creator"; + creation_time: "creation_time"; + feed_audience_description: "feed_audience_description"; + feed_targeting: "feed_targeting"; + id: "id"; + is_post_in_good_state: "is_post_in_good_state"; + message: "message"; + modified_time: "modified_time"; + og_action_summary: "og_action_summary"; + permalink_url: "permalink_url"; + place: "place"; + privacy_description: "privacy_description"; + scheduled_failure_notice: "scheduled_failure_notice"; + scheduled_publish_time: "scheduled_publish_time"; + story_token: "story_token"; + thumbnail: "thumbnail"; + video_id: "video_id"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/scim-company-user-phone-number.d.ts b/types/facebook-nodejs-business-sdk/src/objects/scim-company-user-phone-number.d.ts new file mode 100644 index 00000000000000..01e1bfd60c13ce --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/scim-company-user-phone-number.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ScimCompanyUserPhoneNumber + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ScimCompanyUserPhoneNumber extends AbstractCrudObject { + static get Fields(): Readonly<{ + number: "number"; + primary: "primary"; + type: "type"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/security-settings.d.ts b/types/facebook-nodejs-business-sdk/src/objects/security-settings.d.ts index 63e1487a422659..ea0d7cf862298a 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/security-settings.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/security-settings.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * SecuritySettings * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/serverside/app-data.d.ts b/types/facebook-nodejs-business-sdk/src/objects/serverside/app-data.d.ts index 24138ee7ef1c04..df66e3396a0ce1 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/serverside/app-data.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/serverside/app-data.d.ts @@ -1,4 +1,4 @@ -import ExtendedDeviceInfo from './extended-device-info'; +import ExtendedDeviceInfo from "./extended-device-info"; export default class AppData { _application_tracking_enabled: boolean; _advertiser_tracking_enabled: boolean; @@ -12,7 +12,7 @@ export default class AppData { _receipt_data: string; _url_schemes: string; _windows_attribution_id: string; - constructor(application_tracking_enabled: boolean, advertiser_tracking_enabled: boolean, campaign_ids: string, consider_views: boolean, extinfo: ExtendedDeviceInfo, include_dwell_data: boolean, include_video_data: boolean, install_referrer: string, installer_package: string, receipt_data: string, url_schemes: string, windows_attribution_id: string); + constructor(application_tracking_enabled?: boolean, advertiser_tracking_enabled?: boolean, campaign_ids?: string, consider_views?: boolean, extinfo?: ExtendedDeviceInfo, include_dwell_data?: boolean, include_video_data?: boolean, install_referrer?: string, installer_package?: string, receipt_data?: string, url_schemes?: string, windows_attribution_id?: string); get application_tracking_enabled(): boolean; set application_tracking_enabled(application_tracking_enabled: boolean); setApplicationTrackingEnabled(application_tracking_enabled: boolean): AppData; @@ -49,6 +49,6 @@ export default class AppData { get windows_attribution_id(): string; set windows_attribution_id(windows_attribution_id: string); setWindowsAttributionId(windows_attribution_id: string): AppData; - normalize(): Record; - toJson(): Record; + normalize(): Record; + toJson(): Record; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/serverside/content.d.ts b/types/facebook-nodejs-business-sdk/src/objects/serverside/content.d.ts index 37da550955c34e..1d83fded15ba8a 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/serverside/content.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/serverside/content.d.ts @@ -1,7 +1,3 @@ -/** - * Content is part of the Custom Data Parameters of a Conversions API Event Request. Content can be used to set the item/product details added in the Custom Data. - * @see {@link https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/custom-data#contents} - */ export default class Content { _id: string; _quantity: number; @@ -35,10 +31,10 @@ export default class Content { */ 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. - */ + * 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. @@ -53,10 +49,10 @@ export default class Content { */ 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 - */ + * 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. @@ -71,10 +67,10 @@ export default class Content { */ 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' - */ + * 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. @@ -87,9 +83,9 @@ export default class Content { */ set title(title: string); /** - * Sets the Title of the Item. - * @param title is a string representing listed title for the product. - */ + * 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. @@ -102,9 +98,9 @@ export default class Content { */ set description(description: string); /** - * Sets the Product Description of the Item. - * @param description is a string representing the description for the product. - */ + * 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. @@ -154,5 +150,5 @@ export default class Content { * Returns the normalized payload for the Content. * @returns {Object} normalized Content payload. */ - normalize(): Record; + normalize(): Record; } 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 05eb8d303440d6..05d701119f942f 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 @@ -1,4 +1,4 @@ -import Content from './content.js'; +import Content from "./content"; /** * CustomData represents the Custom Data Parameters of a Conversions API Event Request. Use these parameters to send additional data we can use for ads delivery optimization. * @see {@link https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/custom-data} @@ -18,14 +18,14 @@ export default class CustomData { _status: string; _item_number: string; _delivery_category: string; - _custom_properties: Record; + _custom_properties: Record; /** * @param {Number} value value of the item Eg: 123.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 - * @param {string[]} content_ids list of content unique ids involved in the event - * @param {Content[]} contents Array of Content Objects. Use {Content} class to define a content. + * @param {Array} content_ids list of content unique ids involved in the event + * @param {Array} contents Array of Content Objects. Use {Content} class to define a content. * @param {String} content_type Type of the Content group or Product SKU * @param {String} order_id Unique id representing the order * @param {Number} predicted_ltv Predicted LifeTime Value for the customer involved in the event @@ -36,7 +36,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, 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. @@ -144,7 +144,7 @@ export default class CustomData { set contents(contents: Content[]); /** * 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. + * @param {Array} 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: Content[]): CustomData; @@ -273,7 +273,7 @@ export default class CustomData { * @see {@link https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/custom-data#custom-properties} * Eg: '{ 'warehouse_location' : 'washington', 'package_size' : 'L'}' */ - get custom_properties(): Record; + 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. @@ -281,7 +281,7 @@ export default class CustomData { * @see {@link https://developers.facebook.com/docs/marketing-api/conversions-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); + 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. @@ -291,7 +291,7 @@ export default class CustomData { * Eg: '{ 'warehouse_location' : 'washington', 'package_size' : 'L'}' * * @returns {Object} custom_properties property bag. */ - setCustomProperties(custom_properties: Record): CustomData; + setCustomProperties(custom_properties: Record): CustomData; /** * Gets the status of the registration event. * Status of the registration event, as a String.Use only with CompleteRegistration events. @@ -317,5 +317,5 @@ export default class CustomData { * Returns the normalized payload for the custom_data. * @returns {Object} normalized custom_data payload. */ - normalize(): Record; + normalize(): Record; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/serverside/delivery-category.d.ts b/types/facebook-nodejs-business-sdk/src/objects/serverside/delivery-category.d.ts index 0cd7b4ec73ef7d..4acbd95776224d 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/serverside/delivery-category.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/serverside/delivery-category.d.ts @@ -3,16 +3,16 @@ */ declare const _default: Readonly<{ /** - * Customer needs to enter the store to get the purchased product. - */ + * Customer needs to enter the store to get the purchased product. + */ IN_STORE: "in_store"; /** - * Customer picks up their order by driving to a store and waiting inside their vehicle. - */ + * Customer picks up their order by driving to a store and waiting inside their vehicle. + */ CURBSIDE: "curbside"; /** - * Purchase is delivered to the customer's home. - */ + * Purchase is delivered to the customer's home. + */ HOME_DELIVERY: "home_delivery"; }>; export default _default; diff --git a/types/facebook-nodejs-business-sdk/src/objects/serverside/event-request.d.ts b/types/facebook-nodejs-business-sdk/src/objects/serverside/event-request.d.ts index 2ed5fcda367458..293a60ffe9acb0 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/serverside/event-request.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/serverside/event-request.d.ts @@ -1,6 +1,6 @@ -import EventResponse from './event-response'; -import HttpServiceInterface from './http-service-interface'; -import ServerEvent from './server-event'; +import EventResponse from "./event-response"; +import HttpServiceInterface from "./http-service-interface"; +import ServerEvent from "./server-event"; /** * EventRequest * @see {@link https://developers.facebook.com/docs/marketing-api/conversions-api/parameters} @@ -9,19 +9,19 @@ export default class EventRequest { _access_token: string; _pixel_id: string; _events: ServerEvent[]; - _partner_agent: string | null | undefined; - _test_event_code: string | null | undefined; - _namespace_id: string | null | undefined; - _upload_id: string | null | undefined; - _upload_tag: string | null | undefined; - _upload_source: string | null | undefined; + _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: boolean; - _api: Record; - _http_service: HttpServiceInterface | null | undefined; + _api: Record; + _http_service: HttpServiceInterface | null; /** * @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 {ServerEvent[]} events Data for the request Payload for a Conversions API Event + * @param {Array} events Data for the request Payload for a Conversions API 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. diff --git a/types/facebook-nodejs-business-sdk/src/objects/serverside/event-response.d.ts b/types/facebook-nodejs-business-sdk/src/objects/serverside/event-response.d.ts index 083d93bac20b57..43a7728a575b5a 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/serverside/event-response.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/serverside/event-response.d.ts @@ -10,7 +10,7 @@ export default class EventResponse { _num_processed_entries: number; /** * @param {Number} events_received - * @param {string[]} messages + * @param {Array} messages * @param {String} fbtrace_id * @param {String} id * @param {Number} num_processed_entries @@ -29,10 +29,10 @@ export default class EventResponse { */ set events_received(events_received: number); /** - * Sets the events received for the response received from Graph API. - * events_received is represented by integer. - * @param {Number} events_received representing the number of events received for the event Request - */ + * Sets the events received for the response received from Graph API. + * events_received is represented by integer. + * @param {Number} events_received representing the number of events received for the event Request + */ setEventsReceived(events_received: number): EventResponse; /** * Sets the messages as array for the response received from Graph API. @@ -45,9 +45,9 @@ export default class EventResponse { */ set messages(messages: string[]); /** - * Sets the messages as array for the response received from Graph API. - * @param {Array} messages in the event Response - */ + * Sets the messages as array for the response received from Graph API. + * @param {Array} messages in the event Response + */ setMessages(messages: string[]): EventResponse; /** * Gets the fbtrace_id for the response received from Graph API. @@ -60,9 +60,9 @@ export default class EventResponse { */ set fbtrace_id(fbtrace_id: string); /** - * Sets the fbtrace_id for the response received from Graph API. - * @param {String} fbtrace_id in the event Response that can used for debugging purposes - */ + * Sets the fbtrace_id for the response received from Graph API. + * @param {String} fbtrace_id in the event Response that can used for debugging purposes + */ setFbtraceId(fbtrace_id: string): EventResponse; /** * Gets the id of container to which the event request was successfully posted to. diff --git a/types/facebook-nodejs-business-sdk/src/objects/serverside/extended-device-info.d.ts b/types/facebook-nodejs-business-sdk/src/objects/serverside/extended-device-info.d.ts index 48812ef71f9dee..d837a092a2de50 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/serverside/extended-device-info.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/serverside/extended-device-info.d.ts @@ -15,7 +15,7 @@ export default class ExtendedDeviceInfo { _total_disk_space_gb: number; _free_disk_space_gb: number; _device_time_zone: string; - constructor(ext_info_version: string, app_package_name: string, short_version: string, long_version: string, os_version: string, device_model_name: string, locale: string, timezone_abbreviation: string, carrier: string, screen_width: number, screen_height: number, screen_density: string, cpu_core_count: number, total_disk_space_gb: number, free_disk_space_gb: number, device_time_zone: string); + constructor(ext_info_version?: string, app_package_name?: string, short_version?: string, long_version?: string, os_version?: string, device_model_name?: string, locale?: string, timezone_abbreviation?: string, carrier?: string, screen_width?: number, screen_height?: number, screen_density?: string, cpu_core_count?: number, total_disk_space_gb?: number, free_disk_space_gb?: number, device_time_zone?: string); get ext_info_version(): string; set ext_info_version(ext_info_version: string); setExtInfoVersion(ext_info_version: string): ExtendedDeviceInfo; @@ -64,6 +64,6 @@ export default class ExtendedDeviceInfo { get device_time_zone(): string; set device_time_zone(device_time_zone: string); setDeviceTimeZone(device_time_zone: string): ExtendedDeviceInfo; - normalize(): Record; - toJson(): Record; + normalize(): Record; + toJson(): Record; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/serverside/http-service-client-config.d.ts b/types/facebook-nodejs-business-sdk/src/objects/serverside/http-service-client-config.d.ts index 3af190ac56f0ff..69c94984c5bc64 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/serverside/http-service-client-config.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/serverside/http-service-client-config.d.ts @@ -1,7 +1,6 @@ -import HttpServiceInterface from './http-service-interface'; -declare namespace HttpServiceClientConfig { - const _client: HttpServiceInterface; - function setClient(client: HttpServiceInterface): void; - function getClient(): HttpServiceInterface; +import HttpServiceInterface from "./http-service-interface"; +export default class HttpServiceClientConfig { + static _client: HttpServiceInterface; + static setClient(client: HttpServiceInterface): void; + static getClient(): HttpServiceInterface; } -export default HttpServiceClientConfig; diff --git a/types/facebook-nodejs-business-sdk/src/objects/serverside/http-service-interface.d.ts b/types/facebook-nodejs-business-sdk/src/objects/serverside/http-service-interface.d.ts index 30a3c9e087c477..c9cf88c15883a6 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/serverside/http-service-interface.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/serverside/http-service-interface.d.ts @@ -1,10 +1,10 @@ export default class HttpServiceInterface { /** - * @param {String} $url The graph API endpoint that will be requested - * @param {HttpMethod} $method The HTTP request method - * @param {Object} $headers Contains HTTP request headers including User-Agent and Accept-Encoding - * @param {Object} $params Contains request parameters including access_token, data, test_event_code, etc. - * @return {Promise} - */ - executeRequest(url: string, method: string, headers: Record, params: Record): Promise>; + * @param {String} $url The graph API endpoint that will be requested + * @param {HttpMethod} $method The HTTP request method + * @param {Object} $headers Contains HTTP request headers including User-Agent and Accept-Encoding + * @param {Object} $params Contains request parameters including access_token, data, test_event_code, etc. + * @return {Promise} + */ + executeRequest(url: string, method: string, headers: Record, params: Record): Promise>; } 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 0edbc641f1234d..296e99be8e371d 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 @@ -1,6 +1,6 @@ -import UserData from './user-data'; -import CustomData from './custom-data'; -import AppData from './app-data'; +import UserData from "./user-data"; +import CustomData from "./custom-data"; +import AppData from "./app-data"; /** * ServerEvent * @see {@link https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/server-event} @@ -20,6 +20,7 @@ export default class ServerEvent { _data_processing_options_country: number; _advanced_measurement_table: string; _advertiser_tracking_enabled: boolean; + _messaging_channel: string; /** * @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. @@ -29,13 +30,14 @@ export default class ServerEvent { * @param {Boolean} opt_out A flag that indicates we should not use this event for ads delivery optimization. * @param {UserData} user_data A map that contains user data. See UserData Class for options. * @param {CustomData} custom_data A map that contains user data. See CustomData Class for options. - * @param {string[]} data_processing_options Processing options you would like to enable for a specific event. + * @param {Array} 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. * @param {String} advanced_measurement_table Name of Advanced Measurement table. Only used for the Advanced Measurement API in the Advanced Analytics product. * @param {Boolean} advertiser_tracking_enabled A boolean that indicates whether the user has opted into/out of advertiser tracker on apps. + * @param {String} messaging_channel Indicates which channel was used to send the message. */ - constructor(event_name?: string, event_time?: number, event_source_url?: string, user_data?: UserData, custom_data?: CustomData, app_data?: AppData, event_id?: string, opt_out?: boolean, action_source?: string, data_processing_options?: string[], data_processing_options_country?: number, data_processing_options_state?: number, advanced_measurement_table?: string, advertiser_tracking_enabled?: boolean); + constructor(event_name?: string, event_time?: number, event_source_url?: string, user_data?: UserData, custom_data?: CustomData, app_data?: AppData, event_id?: string, opt_out?: boolean, action_source?: string, data_processing_options?: string[], data_processing_options_country?: number, data_processing_options_state?: number, advanced_measurement_table?: string, advertiser_tracking_enabled?: boolean, messaging_channel?: string); /** * Gets the Event Name for the current Event. */ @@ -177,13 +179,13 @@ export default class ServerEvent { 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'] + * @param {Array} data_processing_options represents Data processing options you would like to enable for a specific event, e.g. [] or ['LDU'] * @see {@link https://developers.facebook.com/docs/marketing-apis/data-processing-options} */ 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'] + * @param {Array} data_processing_options represents Data processing options you would like to enable for a specific event, e.g. [] or ['LDU'] * @see {@link https://developers.facebook.com/docs/marketing-apis/data-processing-options} */ setDataProcessingOptions(data_processing_options: string[]): ServerEvent; @@ -249,9 +251,23 @@ export default class ServerEvent { * @param {number} data_processing_options_country represents whether the user has opted into/out of advertiser tracking on apps. */ setAdvertiserTrackingEnabled(advertiser_tracking_enabled: boolean): ServerEvent; + /** + * Gets the messaging_channel for the current event. + */ + get messaging_channel(): string; + /** + * Sets the messaging_channel for the current event. + * @param {boolean} messaging_channel represents where the conversation occurred. + */ + set messaging_channel(messaging_channel: string); + /** + * Sets the messaging_channel for the current event. + * @param {number} messaging_channel represents where the conversation occurred. + */ + setMessagingChannel(messaging_channel: string): ServerEvent; /** * Returns the normalized payload for the event. * @returns {Object} normalized event payload. */ - normalize(): Record; + normalize(): Record; } 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 32a89bd6048500..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 @@ -31,6 +31,8 @@ export default class UserData { _madid: string; _anon_id: string; _app_user_id: string; + _ctwa_clid: string; + _page_id: string; /** * @param {String} email An email address, in lowercase. * @param {String} phone A phone number. Include only digits with country code, area code, and number. @@ -56,9 +58,11 @@ export default class UserData { * @param {String} madid * @param {String} anon_id * @param {String} app_user_id + * @param {String} ctwa_clid ID of a conversation that was started on WhatsApp + * @param {String} page_id ID of the page that the ad is associated with */ - constructor(email?: string, phone?: string, gender?: string, first_name?: string, last_name?: string, date_of_birth?: string, city?: string, state?: string, zip?: string, country?: string, external_id?: 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, madid?: string, anon_id?: string, app_user_id?: string); - static get Gender(): Record; + constructor(email?: string, phone?: string, gender?: string, first_name?: string, last_name?: string, date_of_birth?: string, city?: string, state?: string, zip?: string, country?: string, external_id?: 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, madid?: string, anon_id?: string, app_user_id?: string, ctwa_clid?: string, page_id?: string); + static get Gender(): Record; /** * Gets the email address for the user data field. * An email address, in lowercase. @@ -252,16 +256,16 @@ export default class UserData { */ set first_name(first_name: string); /** - * Gets the first names for the user data. - * first_name is first name in lowercase. - * Example: ['joe', 'mary'] - */ + * Gets the first names for the user data. + * first_name is first name in lowercase. + * Example: ['joe', 'mary'] + */ get first_names(): string[]; /** - * Sets the first names for the user data. - * @param first_names is first name in lowercase. - * Example: ['joe', 'mary'] - */ + * Sets the first names for the user data. + * @param first_names is first name in lowercase. + * Example: ['joe', 'mary'] + */ set first_names(first_names: string[]); /** * Sets the first name for the user data. @@ -694,15 +698,39 @@ export default class UserData { * */ setAppUserId(app_user_id: string): UserData; + /** + * + */ + get ctwa_clid(): string; + /** + * + */ + set ctwa_clid(ctwa_clid: string); + /** + * + */ + setCtwaClid(ctwa_clid: string): UserData; + /** + * + */ + get page_id(): string; + /** + * + */ + set page_id(page_id: string); + /** + * + */ + setPageId(page_id: string): UserData; /** * Returns the normalized payload for the user_data parameter. * @returns {Object} normalized user data payload. */ - normalize(): Record; + normalize(): Record; /** - * Returns the deduped and normalized payload for the given array of values and the field. - * @returns {string[]} dedupped and normalized values. - */ + * Returns the deduped and normalized payload for the given array of values and the field. + * @returns {string[]} dedupped and normalized values. + */ normalizeAndHashMultiValues(arr: string[], fieldName: string): string[]; /** * Returns the deduped payload for the given array of values. diff --git a/types/facebook-nodejs-business-sdk/src/objects/serverside/utils.d.ts b/types/facebook-nodejs-business-sdk/src/objects/serverside/utils.d.ts index 14ee329652e1c2..fec355e915dd07 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/serverside/utils.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/serverside/utils.d.ts @@ -1,104 +1,102 @@ /** * ServerSideUtils contains the Utility modules used for sending Conversions API Events */ -declare namespace ServerSideUtils { +export default class ServerSideUtils { /** * Normalizes and hashes the input given the field name. * @param {String} [input] Value to be normalized. eg: `foo@bar.com` for email input. * @param {String} [field] Key(Type) of Value to be normalized eg: 'em' for email field. * @return {String} Normalized and hashed value for the string. */ - function normalizeAndHash(input: string, field: string): any; + static normalizeAndHash(input: string, field: string): any; /** * Normalizes the given country token and returns acceptable two letter ISO country code * @param {String} [country] country value to be normalized. * @return {String} Normalized ISO country code. */ - function normalizeCountry(country: string): string; + static normalizeCountry(country: string): string; /** * Normalizes the given city and returns acceptable city value * @param {String} [city] city value to be normalized. * @return {String} Normalized city value. */ - function normalizeCity(city: string): string; + static normalizeCity(city: string): string; /** * Normalizes the given currency string and returns acceptable three letter ISO code * @param {String} [currency] country value to be normalized. * @return {String} Normalized ISO currency code. */ - function normalizeCurrency(currency: string): string; + static normalizeCurrency(currency: string): string; /** * Normalizes the given delivery category value and returns a valid string. * @param {String} [input] delivery_category input to be validated. * @return {String} Valid delivery_category value. */ - function normalizeDeliveryCategory(input: string): string; + static normalizeDeliveryCategory(input: string): string; /** * Normalizes the given email to RFC 822 standard and returns acceptable email value * @param {String} [email] email value to be normalized. * @return {String} Normalized email value. */ - function normalizeEmail(email: string): string; + static normalizeEmail(email: string): string; /** * Normalizes the given gender and returns acceptable('f' or 'm') gender value * @param {String} [gender] gender value to be normalized. * @return {String} Normalized gender value. */ - function normalizeGender(gender: string): string; + static normalizeGender(gender: string): string; /** - * Normalizes the 5 character name field. - * @param {String} [name] name value to be normalized. - * @return {String} Normalized 5 character {first,last}name field value. - */ - function normalizeF5NameField(name: string): string; + * Normalizes the 5 character name field. + * @param {String} [name] name value to be normalized. + * @return {String} Normalized 5 character {first,last}name field value. + */ + static normalizeF5NameField(name: string): string; /** * Normalizes the given phone and returns acceptable phone value * @param {String} [phone_number] phone number value to be normalized. * @return {String} Normalized phone number value. */ - function normalizePhone(phone_number: string): string; + static normalizePhone(phone_number: string): string; /** * Normalizes the given state and returns acceptable city value * @param {String} [state] state value to be normalized. * @return {String} Normalized state value. */ - function normalizeState(state: string): string; + static normalizeState(state: string): string; /** * Normalizes the given zip/postal code and returns acceptable zip code value * @param {String} [zip] zip value to be normalized. * @return {String} Normalized zip code value. */ - function normalizeZip(zip: string): string; + static normalizeZip(zip: string): string; /** * Normalizes the given date of birth day * @param {String} [dobd] value to be normalized. * @return {String} Normalized value. */ - function normalizeDobd(dobd: string): string; + static normalizeDobd(dobd: string): string; /** * Normalizes the given date of birth month * @param {String} [dobm] value to be normalized. * @return {String} Normalized value. */ - function normalizeDobm(dobm: string): string; + static normalizeDobm(dobm: string): string; /** * Normalizes the given date of birth year * @param {String} [doby] value to be normalized. * @return {String} Normalized value. */ - function normalizeDoby(doby: string): string; + static normalizeDoby(doby: string): string; /** * Boolean method which checks if a given number is represented in international format * @param {String} phone_number that has to be tested. * @return {Boolean} value if a number is represented international format */ - function isInternationalPhoneNumber(phone_number: string): boolean; + static isInternationalPhoneNumber(phone_number: string): boolean; /** * Calculates the SHA 256 hash of a given non-null string. * @param {String} [input] String to be hashed * @return {String} SHA 256 Hash of the string */ - function toSHA256(input?: string | null): any; + static toSHA256(input: string | null | undefined): any; } - -export default ServerSideUtils; diff --git a/types/facebook-nodejs-business-sdk/src/objects/shadow-ig-hashtag.d.ts b/types/facebook-nodejs-business-sdk/src/objects/shadow-ig-hashtag.d.ts index 868ad6c6aab7c2..9ce29b6f66f921 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/shadow-ig-hashtag.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/shadow-ig-hashtag.d.ts @@ -1,5 +1,5 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; /** * ShadowIGHashtag * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -9,11 +9,7 @@ export default class ShadowIGHashtag extends AbstractCrudObject { id: "id"; name: "name"; }>; - getRecentMedia(fields: string[], params?: Record): Promise; - getRecentMedia(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getRecentMedia(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getTopMedia(fields: string[], params?: Record): Promise; - getTopMedia(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getTopMedia(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - get(fields: string[], params?: Record): Promise; + getRecentMedia(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getTopMedia(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + get(fields: string[], params?: Record): Promise; } 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 new file mode 100644 index 00000000000000..0b88bedfd8d28d --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/shadow-ig-media-boosted-insights-result.d.ts @@ -0,0 +1,15 @@ +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-media-builder.d.ts b/types/facebook-nodejs-business-sdk/src/objects/shadow-ig-media-builder.d.ts index 9d90468731bbf0..9a27413c5cab86 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/shadow-ig-media-builder.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/shadow-ig-media-builder.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ShadowIGMediaBuilder * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -9,6 +9,7 @@ export default class ShadowIGMediaBuilder extends AbstractCrudObject { id: "id"; status: "status"; status_code: "status_code"; + video_status: "video_status"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/shadow-ig-media-collaborators.d.ts b/types/facebook-nodejs-business-sdk/src/objects/shadow-ig-media-collaborators.d.ts index 39632f49f08fc8..fe2da97705f604 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/shadow-ig-media-collaborators.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/shadow-ig-media-collaborators.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ShadowIGMediaCollaborators * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/shadow-ig-media-product-tags.d.ts b/types/facebook-nodejs-business-sdk/src/objects/shadow-ig-media-product-tags.d.ts index 8596dd31cf4e79..e25fa660804c14 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/shadow-ig-media-product-tags.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/shadow-ig-media-product-tags.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ShadowIGMediaProductTags * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/shadow-ig-user-catalog-product-search.d.ts b/types/facebook-nodejs-business-sdk/src/objects/shadow-ig-user-catalog-product-search.d.ts index 07080db87f6aff..93a5bfa50ced64 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/shadow-ig-user-catalog-product-search.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/shadow-ig-user-catalog-product-search.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ShadowIGUserCatalogProductSearch * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/shadow-ig-user-catalog-product-variant.d.ts b/types/facebook-nodejs-business-sdk/src/objects/shadow-ig-user-catalog-product-variant.d.ts index b51380381798f8..45012d5e71adfc 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/shadow-ig-user-catalog-product-variant.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/shadow-ig-user-catalog-product-variant.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ShadowIGUserCatalogProductVariant * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/shop.d.ts b/types/facebook-nodejs-business-sdk/src/objects/shop.d.ts index 3f8fe43b79659b..1e7bcbd581511e 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/shop.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/shop.d.ts @@ -1,10 +1,11 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * Shop * @see {@link https://developers.facebook.com/docs/marketing-api/} */ export default class Shop extends AbstractCrudObject { static get Fields(): Readonly<{ + commerce_merchant_settings: "commerce_merchant_settings"; fb_sales_channel: "fb_sales_channel"; id: "id"; ig_sales_channel: "ig_sales_channel"; @@ -12,5 +13,5 @@ export default class Shop extends AbstractCrudObject { shop_status: "shop_status"; workspace: "workspace"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } 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 index dfaf1aa77244b5..86d6fd889b1bd6 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/signal/content.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/signal/content.d.ts @@ -1,5 +1,5 @@ -import BusinessDataContent from '../businessdataapi/content'; -import ServerContent from '../serverside/content'; +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. */ 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 index 7b58fcd82f0fab..6288f55472c87d 100644 --- 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 @@ -1,7 +1,7 @@ -import BusinessDataCustomData from '../businessdataapi/custom-data'; -import ServerCustomData from '../serverside/custom-data'; -import SignalUserData from './user-data'; -import SignalContent from './content'; +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. */ @@ -12,7 +12,7 @@ export default class CustomData { * 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 {Array} 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. @@ -20,7 +20,7 @@ export default class CustomData { * 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 {Array} 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 @@ -35,7 +35,7 @@ export default class CustomData { * @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); + 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. @@ -86,7 +86,7 @@ export default class CustomData { 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. + * @param {Array} 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; @@ -292,7 +292,7 @@ export default class CustomData { * @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; + 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. @@ -300,7 +300,7 @@ export default class CustomData { * @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); + 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. @@ -310,7 +310,7 @@ export default class CustomData { * Eg: '{ 'warehouse_location' : 'washington', 'package_size' : 'L'}' * * @returns {Object} custom_properties property bag. */ - setCustomProperties(custom_properties: Record): CustomData; + 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. 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 index 0e2c8f6b00583f..c79eee651f6659 100644 --- 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 @@ -1,7 +1,7 @@ -import BusinessDataEventRequest from '../businessdataapi/event-request'; -import ServerEventRequest from '../serverside/event-request'; -import HttpServiceInterface from '../serverside/http-service-interface'; -import SignalEvent from './event'; +import BusinessDataEventRequest from "../businessdataapi/event-request"; +import ServerEventRequest from "../serverside/event-request"; +import HttpServiceInterface from "../serverside/http-service-interface"; +import SignalEvent from "./event"; /** * EventRequest */ @@ -12,7 +12,7 @@ export default class EventRequest { * @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 {Array} 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. @@ -34,7 +34,7 @@ export default class EventRequest { 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 + * @param {Array} events for the current event */ setEvents(events: SignalEvent[]): EventRequest; /** @@ -181,5 +181,5 @@ export default class EventRequest { /** * Executes the current event_request data by making a call to the Facebook Graph API. */ - execute(): Promise>; + 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 index ad4a779b885ba9..4fa00455f79a7a 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/signal/event.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/signal/event.d.ts @@ -1,7 +1,7 @@ -import SignalUserData from './user-data'; -import SignalCustomData from './custom-data'; -import BusinessDataEvent from '../businessdataapi/event'; -import ServerEvent from '../serverside/server-event'; +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 */ @@ -17,7 +17,7 @@ export default class Event { * @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 {Array} 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. */ @@ -142,12 +142,12 @@ export default class 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'] + * @param {Array} 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'] + * @param {Array} 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; /** @@ -191,5 +191,5 @@ export default class Event { /** * Convert to Json object for api call */ - toJson(): Record; + 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 index 56bb188a1a6bba..58b802d3e3058e 100644 --- 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 @@ -1,5 +1,5 @@ -import BusinessDataUserData from '../businessdataapi/user-data'; -import ServerUserData from '../serverside/user-data'; +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. */ 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 index 5c00a02c8845d0..913b45878275ff 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/signal/utils.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/signal/utils.d.ts @@ -8,5 +8,5 @@ export default class Utils { * @param any bdapi_return * @return {Object} combined server field and business data field return */ - static constructResponse(server_return: any, bdapi_return: any): Record; + static constructResponse(server_return: any, bdapi_return: any): Record; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/signals-iwl-extractor.d.ts b/types/facebook-nodejs-business-sdk/src/objects/signals-iwl-extractor.d.ts new file mode 100644 index 00000000000000..140db550e473e7 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/signals-iwl-extractor.d.ts @@ -0,0 +1,14 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * SignalsIWLExtractor + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class SignalsIWLExtractor extends AbstractCrudObject { + static get Fields(): Readonly<{ + domain_uri: "domain_uri"; + event_type: "event_type"; + extractor_type: "extractor_type"; + id: "id"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/single-owner-additional-profile.d.ts b/types/facebook-nodejs-business-sdk/src/objects/single-owner-additional-profile.d.ts new file mode 100644 index 00000000000000..79b0a9b8c5ffcc --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/single-owner-additional-profile.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * SingleOwnerAdditionalProfile + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class SingleOwnerAdditionalProfile extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + name: "name"; + user_name: "user_name"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/site-link.d.ts b/types/facebook-nodejs-business-sdk/src/objects/site-link.d.ts new file mode 100644 index 00000000000000..2bd0347089b70b --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/site-link.d.ts @@ -0,0 +1,15 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * SiteLink + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class SiteLink extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + link_image_hash: "link_image_hash"; + 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/sliced-event-source-group.d.ts b/types/facebook-nodejs-business-sdk/src/objects/sliced-event-source-group.d.ts new file mode 100644 index 00000000000000..42c7738448aebb --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/sliced-event-source-group.d.ts @@ -0,0 +1,14 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * SlicedEventSourceGroup + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class SlicedEventSourceGroup extends AbstractCrudObject { + static get Fields(): Readonly<{ + event_source_group: "event_source_group"; + filter: "filter"; + id: "id"; + name: "name"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/smart-pixel-insights.d.ts b/types/facebook-nodejs-business-sdk/src/objects/smart-pixel-insights.d.ts new file mode 100644 index 00000000000000..64c969cf2bbe66 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/smart-pixel-insights.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * SmartPixelInsights + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class SmartPixelInsights extends AbstractCrudObject { + static get Fields(): Readonly<{ + source: "source"; + stats: "stats"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/social-wifi-site.d.ts b/types/facebook-nodejs-business-sdk/src/objects/social-wifi-site.d.ts new file mode 100644 index 00000000000000..c58da7f5574d0b --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/social-wifi-site.d.ts @@ -0,0 +1,10 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * SocialWifiSite + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class SocialWifiSite extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + }>; +} 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 new file mode 100644 index 00000000000000..4f1401378631c5 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/split-test-config.d.ts @@ -0,0 +1,17 @@ +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/split-test-winner.d.ts b/types/facebook-nodejs-business-sdk/src/objects/split-test-winner.d.ts index e83517f9714596..f34eaa749d5780 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/split-test-winner.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/split-test-winner.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * SplitTestWinner * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/status.d.ts b/types/facebook-nodejs-business-sdk/src/objects/status.d.ts new file mode 100644 index 00000000000000..fd218c7843879e --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/status.d.ts @@ -0,0 +1,17 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * Status + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class Status extends AbstractCrudObject { + static get Fields(): Readonly<{ + event: "event"; + from: "from"; + id: "id"; + message: "message"; + place: "place"; + updated_time: "updated_time"; + }>; + createLike(fields: string[], params?: Record, pathOverride?: string | null): Promise; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/store-catalog-settings.d.ts b/types/facebook-nodejs-business-sdk/src/objects/store-catalog-settings.d.ts index 006cda952e083f..bf903f2a6d7a54 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/store-catalog-settings.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/store-catalog-settings.d.ts @@ -1,5 +1,5 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; /** * StoreCatalogSettings * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -9,6 +9,6 @@ export default class StoreCatalogSettings extends AbstractCrudObject { id: "id"; page: "page"; }>; - delete(fields: string[], params?: Record): Promise; - get(fields: string[], params?: Record): Promise; + delete(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/stories.d.ts b/types/facebook-nodejs-business-sdk/src/objects/stories.d.ts index fa8cb7153873d6..e681e4d8e2884a 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/stories.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/stories.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * Stories * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/stream-filter.d.ts b/types/facebook-nodejs-business-sdk/src/objects/stream-filter.d.ts new file mode 100644 index 00000000000000..2172743462cc30 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/stream-filter.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * StreamFilter + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class StreamFilter extends AbstractCrudObject { + static get Fields(): Readonly<{ + filter_key: "filter_key"; + name: "name"; + type: "type"; + }>; +} 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 f983291b129708..e921ca2abb91d5 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 @@ -1,5 +1,5 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; /** * SystemUser * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -30,17 +30,9 @@ export default class SystemUser extends AbstractCrudObject { partner_center_marketing: "PARTNER_CENTER_MARKETING"; partner_center_operations: "PARTNER_CENTER_OPERATIONS"; }>; - getAssignedAdAccounts(fields: string[], params?: Record): Promise; - getAssignedAdAccounts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAssignedAdAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAssignedBusinessAssetGroups(fields: string[], params?: Record): Promise; - getAssignedBusinessAssetGroups(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAssignedBusinessAssetGroups(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAssignedPages(fields: string[], params?: Record): Promise; - getAssignedPages(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAssignedPages(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAssignedProductCatalogs(fields: string[], params?: Record): Promise; - getAssignedProductCatalogs(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAssignedProductCatalogs(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - get(fields: string[], params?: Record): Promise; + 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; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/tab.d.ts b/types/facebook-nodejs-business-sdk/src/objects/tab.d.ts index 25fe9e162c1824..756c7e9c707db2 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/tab.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/tab.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * Tab * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/taggable-subject.d.ts b/types/facebook-nodejs-business-sdk/src/objects/taggable-subject.d.ts new file mode 100644 index 00000000000000..4454a4a84c56b4 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/taggable-subject.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * TaggableSubject + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class TaggableSubject extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + name: "name"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/targeting-automation.d.ts b/types/facebook-nodejs-business-sdk/src/objects/targeting-automation.d.ts new file mode 100644 index 00000000000000..485bc37d5b20ec --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/targeting-automation.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * TargetingAutomation + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class TargetingAutomation extends AbstractCrudObject { + static get Fields(): Readonly<{ + advantage_audience: "advantage_audience"; + individual_setting: "individual_setting"; + shared_audiences: "shared_audiences"; + value_expression: "value_expression"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/targeting-dynamic-rule.d.ts b/types/facebook-nodejs-business-sdk/src/objects/targeting-dynamic-rule.d.ts index 74189ad00d0f47..39a7c48ba79356 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/targeting-dynamic-rule.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/targeting-dynamic-rule.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * TargetingDynamicRule * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location-city.d.ts b/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location-city.d.ts index 8931b00476d8cf..84242569f17ead 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location-city.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location-city.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * TargetingGeoLocationCity * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location-custom-location.d.ts b/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location-custom-location.d.ts index 96cd24e5693f4d..e66b0d818b3946 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location-custom-location.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location-custom-location.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * TargetingGeoLocationCustomLocation * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location-electoral-district.d.ts b/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location-electoral-district.d.ts index 361b33fca6cf86..512ee4b7546927 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location-electoral-district.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location-electoral-district.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * TargetingGeoLocationElectoralDistrict * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location-geo-entities.d.ts b/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location-geo-entities.d.ts index 9aaeba9dd74bf3..af80767d8d224b 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location-geo-entities.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location-geo-entities.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * TargetingGeoLocationGeoEntities * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location-location-cluster.d.ts b/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location-location-cluster.d.ts index e2263eeb8a3082..3efe2e7918b0b6 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location-location-cluster.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location-location-cluster.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * TargetingGeoLocationLocationCluster * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location-location-expansion.d.ts b/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location-location-expansion.d.ts index 726f8b0047ae30..0cd612eb992317 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location-location-expansion.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location-location-expansion.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * TargetingGeoLocationLocationExpansion * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -6,5 +6,6 @@ import { AbstractCrudObject } from './../abstract-crud-object'; export default class TargetingGeoLocationLocationExpansion extends AbstractCrudObject { static get Fields(): Readonly<{ allowed: "allowed"; + intent: "intent"; }>; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location-market.d.ts b/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location-market.d.ts index e6afb6afadfa48..734b5f4f931ff8 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location-market.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location-market.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * TargetingGeoLocationMarket * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location-place.d.ts b/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location-place.d.ts index dda0fd5d32d48b..2511e2c06f3762 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location-place.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location-place.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * TargetingGeoLocationPlace * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location-political-district.d.ts b/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location-political-district.d.ts index f1da658e885a46..00dedb31fa1794 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location-political-district.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location-political-district.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * TargetingGeoLocationPoliticalDistrict * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location-region.d.ts b/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location-region.d.ts index b16ab6e30252fb..0aa26f6a32b5c5 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location-region.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location-region.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * TargetingGeoLocationRegion * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location-zip.d.ts b/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location-zip.d.ts index 480da8f5f6db2b..16d62c88516b50 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location-zip.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location-zip.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * TargetingGeoLocationZip * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location.d.ts b/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location.d.ts index f262f3c5796832..6491a16027d20f 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/targeting-geo-location.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * TargetingGeoLocation * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -13,7 +13,6 @@ export default class TargetingGeoLocation extends AbstractCrudObject { geo_markets: "geo_markets"; large_geo_areas: "large_geo_areas"; location_cluster_ids: "location_cluster_ids"; - location_expansion: "location_expansion"; location_types: "location_types"; medium_geo_areas: "medium_geo_areas"; metro_areas: "metro_areas"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/targeting-marketing-message-channels.d.ts b/types/facebook-nodejs-business-sdk/src/objects/targeting-marketing-message-channels.d.ts new file mode 100644 index 00000000000000..330592d2d154d0 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/targeting-marketing-message-channels.d.ts @@ -0,0 +1,10 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * TargetingMarketingMessageChannels + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class TargetingMarketingMessageChannels extends AbstractCrudObject { + static get Fields(): Readonly<{ + whatsapp: "whatsapp"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/targeting-product-audience-spec.d.ts b/types/facebook-nodejs-business-sdk/src/objects/targeting-product-audience-spec.d.ts index 02907ef0ab1358..f331b163664c12 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/targeting-product-audience-spec.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/targeting-product-audience-spec.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * TargetingProductAudienceSpec * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/targeting-product-audience-sub-spec.d.ts b/types/facebook-nodejs-business-sdk/src/objects/targeting-product-audience-sub-spec.d.ts index c16d3bf390d79b..64be82009c9f9c 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/targeting-product-audience-sub-spec.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/targeting-product-audience-sub-spec.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * TargetingProductAudienceSubSpec * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/targeting-prospecting-audience.d.ts b/types/facebook-nodejs-business-sdk/src/objects/targeting-prospecting-audience.d.ts index d6257354b7cb24..9f7f89baead9d0 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/targeting-prospecting-audience.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/targeting-prospecting-audience.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * TargetingProspectingAudience * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/targeting-relaxation.d.ts b/types/facebook-nodejs-business-sdk/src/objects/targeting-relaxation.d.ts index d52fadb3044e9d..51e7e6b8c62193 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/targeting-relaxation.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/targeting-relaxation.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * TargetingRelaxation * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/targeting-sentence-line.d.ts b/types/facebook-nodejs-business-sdk/src/objects/targeting-sentence-line.d.ts index a3be34eb62a894..75e3cc92a793f2 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/targeting-sentence-line.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/targeting-sentence-line.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * TargetingSentenceLine * @see {@link https://developers.facebook.com/docs/marketing-api/} 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 308d6e00f3380d..d70391a7d100e8 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/targeting.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/targeting.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * Targeting * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -8,6 +8,7 @@ export default class Targeting extends AbstractCrudObject { adgroup_id: "adgroup_id"; age_max: "age_max"; age_min: "age_min"; + age_range: "age_range"; alternate_auto_targeting_option: "alternate_auto_targeting_option"; app_install_state: "app_install_state"; audience_network_positions: "audience_network_positions"; @@ -85,6 +86,7 @@ export default class Targeting extends AbstractCrudObject { regions: "regions"; relationship_statuses: "relationship_statuses"; site_category: "site_category"; + targeting_automation: "targeting_automation"; targeting_optimization: "targeting_optimization"; targeting_relaxation_types: "targeting_relaxation_types"; user_adclusters: "user_adclusters"; diff --git a/types/facebook-nodejs-business-sdk/src/objects/text-with-entities.d.ts b/types/facebook-nodejs-business-sdk/src/objects/text-with-entities.d.ts index f46a14c4a256d6..64d256032dae2d 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/text-with-entities.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/text-with-entities.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * TextWithEntities * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/third-party-measurement-report-dataset.d.ts b/types/facebook-nodejs-business-sdk/src/objects/third-party-measurement-report-dataset.d.ts new file mode 100644 index 00000000000000..317a655cdfa43f --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/third-party-measurement-report-dataset.d.ts @@ -0,0 +1,15 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ThirdPartyMeasurementReportDataset + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ThirdPartyMeasurementReportDataset extends AbstractCrudObject { + static get Fields(): Readonly<{ + category: "category"; + id: "id"; + partner: "partner"; + product: "product"; + schema: "schema"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/third-party-partner-lift-request.d.ts b/types/facebook-nodejs-business-sdk/src/objects/third-party-partner-lift-request.d.ts new file mode 100644 index 00000000000000..731aaceced8daf --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/third-party-partner-lift-request.d.ts @@ -0,0 +1,30 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ThirdPartyPartnerLiftRequest + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ThirdPartyPartnerLiftRequest extends AbstractCrudObject { + static get Fields(): Readonly<{ + ad_entities: "ad_entities"; + country: "country"; + created_time: "created_time"; + description: "description"; + holdout_size: "holdout_size"; + id: "id"; + modified_time: "modified_time"; + owner_instance_id: "owner_instance_id"; + region: "region"; + status: "status"; + study_cells: "study_cells"; + study_end_time: "study_end_time"; + study_start_time: "study_start_time"; + }>; + static get Status(): Readonly<{ + created: "CREATED"; + failure: "FAILURE"; + in_progress: "IN_PROGRESS"; + scheduled: "SCHEDULED"; + success: "SUCCESS"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/third-party-partner-panel-request.d.ts b/types/facebook-nodejs-business-sdk/src/objects/third-party-partner-panel-request.d.ts new file mode 100644 index 00000000000000..6c7c1aa6aa8a32 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/third-party-partner-panel-request.d.ts @@ -0,0 +1,35 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ThirdPartyPartnerPanelRequest + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ThirdPartyPartnerPanelRequest extends AbstractCrudObject { + static get Fields(): Readonly<{ + adentities_ids: "adentities_ids"; + country: "country"; + created_time: "created_time"; + description: "description"; + id: "id"; + modified_time: "modified_time"; + owner_instance_id: "owner_instance_id"; + owner_panel_id: "owner_panel_id"; + owner_panel_name: "owner_panel_name"; + status: "status"; + study_end_time: "study_end_time"; + study_start_time: "study_start_time"; + study_type: "study_type"; + }>; + static get Status(): Readonly<{ + created: "CREATED"; + failure: "FAILURE"; + in_progress: "IN_PROGRESS"; + scheduled: "SCHEDULED"; + success: "SUCCESS"; + }>; + static get StudyType(): Readonly<{ + brand_lift: "BRAND_LIFT"; + panel_sales_attribution: "PANEL_SALES_ATTRIBUTION"; + reach: "REACH"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/third-party-partner-panel-scheduled.d.ts b/types/facebook-nodejs-business-sdk/src/objects/third-party-partner-panel-scheduled.d.ts new file mode 100644 index 00000000000000..c28012e4a7928d --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/third-party-partner-panel-scheduled.d.ts @@ -0,0 +1,35 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ThirdPartyPartnerPanelScheduled + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ThirdPartyPartnerPanelScheduled extends AbstractCrudObject { + static get Fields(): Readonly<{ + adentities_ids: "adentities_ids"; + cadence: "cadence"; + country: "country"; + created_time: "created_time"; + description: "description"; + end_time: "end_time"; + id: "id"; + modified_time: "modified_time"; + owner_instance_id: "owner_instance_id"; + owner_panel_id: "owner_panel_id"; + owner_panel_name: "owner_panel_name"; + start_time: "start_time"; + status: "status"; + study_type: "study_type"; + }>; + static get Status(): Readonly<{ + cancelled: "CANCELLED"; + created: "CREATED"; + finished: "FINISHED"; + ongoing: "ONGOING"; + }>; + static get StudyType(): Readonly<{ + brand_lift: "BRAND_LIFT"; + panel_sales_attribution: "PANEL_SALES_ATTRIBUTION"; + reach: "REACH"; + }>; + get(fields: string[], params?: Record): Promise; +} 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 new file mode 100644 index 00000000000000..c9e9dde5db1f03 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/third-party-partner-viewability-request.d.ts @@ -0,0 +1,27 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * ThirdPartyPartnerViewabilityRequest + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class ThirdPartyPartnerViewabilityRequest extends AbstractCrudObject { + static get Fields(): Readonly<{ + created_time: "created_time"; + description: "description"; + hour: "hour"; + id: "id"; + metric: "metric"; + modified_time: "modified_time"; + owner_instance_id: "owner_instance_id"; + platform: "platform"; + status: "status"; + total_file_count: "total_file_count"; + }>; + static get Status(): Readonly<{ + created: "CREATED"; + failure: "FAILURE"; + in_progress: "IN_PROGRESS"; + scheduled: "SCHEDULED"; + success: "SUCCESS"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/time-suggestion.d.ts b/types/facebook-nodejs-business-sdk/src/objects/time-suggestion.d.ts new file mode 100644 index 00000000000000..09d592788d4f33 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/time-suggestion.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * TimeSuggestion + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class TimeSuggestion extends AbstractCrudObject { + static get Fields(): Readonly<{ + high_demand_periods: "high_demand_periods"; + is_enabled: "is_enabled"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/timezone-offset.d.ts b/types/facebook-nodejs-business-sdk/src/objects/timezone-offset.d.ts new file mode 100644 index 00000000000000..d229fba7dcfb56 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/timezone-offset.d.ts @@ -0,0 +1,14 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * TimezoneOffset + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class TimezoneOffset extends AbstractCrudObject { + static get Fields(): Readonly<{ + abbr: "abbr"; + isdst: "isdst"; + offset: "offset"; + time: "time"; + ts: "ts"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/tracking-and-conversion-with-defaults.d.ts b/types/facebook-nodejs-business-sdk/src/objects/tracking-and-conversion-with-defaults.d.ts index 70f38b5c638779..0ecbeb35b2906a 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/tracking-and-conversion-with-defaults.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/tracking-and-conversion-with-defaults.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * TrackingAndConversionWithDefaults * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/transactable-item.d.ts b/types/facebook-nodejs-business-sdk/src/objects/transactable-item.d.ts new file mode 100644 index 00000000000000..88436b262ec212 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/transactable-item.d.ts @@ -0,0 +1,44 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; +/** + * TransactableItem + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class TransactableItem extends AbstractCrudObject { + static get Fields(): Readonly<{ + action_title: "action_title"; + applinks: "applinks"; + category_specific_fields: "category_specific_fields"; + currency: "currency"; + description: "description"; + duration_time: "duration_time"; + duration_type: "duration_type"; + id: "id"; + image_fetch_status: "image_fetch_status"; + images: "images"; + order_index: "order_index"; + price: "price"; + price_type: "price_type"; + sanitized_images: "sanitized_images"; + session_type: "session_type"; + time_padding_after_end: "time_padding_after_end"; + title: "title"; + transactable_item_id: "transactable_item_id"; + url: "url"; + visibility: "visibility"; + }>; + static get ImageFetchStatus(): Readonly<{ + direct_upload: "DIRECT_UPLOAD"; + fetched: "FETCHED"; + fetch_failed: "FETCH_FAILED"; + no_status: "NO_STATUS"; + outdated: "OUTDATED"; + partial_fetch: "PARTIAL_FETCH"; + }>; + static get Visibility(): Readonly<{ + published: "PUBLISHED"; + staging: "STAGING"; + }>; + getChannelsToIntegrityStatus(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/transaction.d.ts b/types/facebook-nodejs-business-sdk/src/objects/transaction.d.ts new file mode 100644 index 00000000000000..d1ed4d807f3820 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/transaction.d.ts @@ -0,0 +1,38 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * Transaction + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class Transaction extends AbstractCrudObject { + static get Fields(): Readonly<{ + account_id: "account_id"; + app_amount: "app_amount"; + billing_end_time: "billing_end_time"; + billing_reason: "billing_reason"; + billing_start_time: "billing_start_time"; + card_charge_mode: "card_charge_mode"; + charge_type: "charge_type"; + checkout_campaign_group_id: "checkout_campaign_group_id"; + credential_id: "credential_id"; + fatura_id: "fatura_id"; + id: "id"; + is_business_ec_charge: "is_business_ec_charge"; + is_funding_event: "is_funding_event"; + payment_option: "payment_option"; + product_type: "product_type"; + provider_amount: "provider_amount"; + status: "status"; + time: "time"; + tracking_id: "tracking_id"; + transaction_type: "transaction_type"; + tx_type: "tx_type"; + vat_invoice_id: "vat_invoice_id"; + }>; + static get ProductType(): Readonly<{ + cp_return_label: "cp_return_label"; + facebook_ad: "facebook_ad"; + ig_ad: "ig_ad"; + whatsapp: "whatsapp"; + workplace: "workplace"; + }>; +} 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 ad638b07e503a5..0cd80e5363f0e1 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 @@ -1,5 +1,5 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; /** * UnifiedThread * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -28,8 +28,6 @@ export default class UnifiedThread extends AbstractCrudObject { instagram: "INSTAGRAM"; messenger: "MESSENGER"; }>; - getMessages(fields: string[], params?: Record): Promise; - getMessages(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getMessages(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - get(fields: string[], params?: Record): Promise; + getMessages(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/unique-ad-creative.d.ts b/types/facebook-nodejs-business-sdk/src/objects/unique-ad-creative.d.ts new file mode 100644 index 00000000000000..d6b76738b08b49 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/unique-ad-creative.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * UniqueAdCreative + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class UniqueAdCreative extends AbstractCrudObject { + static get Fields(): Readonly<{ + sample_creative: "sample_creative"; + visual_hash: "visual_hash"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/url.d.ts b/types/facebook-nodejs-business-sdk/src/objects/url.d.ts index 734a57850e285b..e80fd115e57984 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/url.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/url.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * URL * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -15,6 +15,6 @@ export default class URL extends AbstractCrudObject { news_tab: "NEWS_TAB"; news_tab_dev_env: "NEWS_TAB_DEV_ENV"; }>; - get(fields: string[], params?: Record): Promise; - update(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/user-available-catalogs.d.ts b/types/facebook-nodejs-business-sdk/src/objects/user-available-catalogs.d.ts index 69f34b639908d9..9c05ef6026f374 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/user-available-catalogs.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/user-available-catalogs.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * UserAvailableCatalogs * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/user-context.d.ts b/types/facebook-nodejs-business-sdk/src/objects/user-context.d.ts new file mode 100644 index 00000000000000..0b3a0b34f93932 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/user-context.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * UserContext + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class UserContext extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/user-cover-photo.d.ts b/types/facebook-nodejs-business-sdk/src/objects/user-cover-photo.d.ts index 504c5e327be546..449c216596b856 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/user-cover-photo.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/user-cover-photo.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * UserCoverPhoto * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/user-device.d.ts b/types/facebook-nodejs-business-sdk/src/objects/user-device.d.ts index 8d920d09a1404c..90e46399aef739 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/user-device.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/user-device.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * UserDevice * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/user-id-for-app.d.ts b/types/facebook-nodejs-business-sdk/src/objects/user-id-for-app.d.ts index 2a6bf1aadb7523..1a2c58d2e73792 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/user-id-for-app.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/user-id-for-app.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * UserIDForApp * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/user-id-for-page.d.ts b/types/facebook-nodejs-business-sdk/src/objects/user-id-for-page.d.ts index e5a9023ef93cc4..c355cc605f19ee 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/user-id-for-page.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/user-id-for-page.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * UserIDForPage * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/user-lead-gen-disclaimer-response.d.ts b/types/facebook-nodejs-business-sdk/src/objects/user-lead-gen-disclaimer-response.d.ts index c59a7da6311f18..48321043c24884 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/user-lead-gen-disclaimer-response.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/user-lead-gen-disclaimer-response.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * UserLeadGenDisclaimerResponse * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/user-lead-gen-field-data.d.ts b/types/facebook-nodejs-business-sdk/src/objects/user-lead-gen-field-data.d.ts index d6cd6e71c07ada..d1e058d97c5380 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/user-lead-gen-field-data.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/user-lead-gen-field-data.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * UserLeadGenFieldData * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/user-mobile-config.d.ts b/types/facebook-nodejs-business-sdk/src/objects/user-mobile-config.d.ts new file mode 100644 index 00000000000000..98adda784b6851 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/user-mobile-config.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * UserMobileConfig + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class UserMobileConfig extends AbstractCrudObject { + static get Fields(): Readonly<{ + section_name: "section_name"; + value: "value"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/user-notification-seen-state-data.d.ts b/types/facebook-nodejs-business-sdk/src/objects/user-notification-seen-state-data.d.ts new file mode 100644 index 00000000000000..78e0fd8ec53a57 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/user-notification-seen-state-data.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * UserNotificationSeenStateData + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class UserNotificationSeenStateData extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + seen_state: "seen_state"; + }>; +} 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 0c50a0aad4f2af..8da35f27d1f374 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 @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * UserPageOneTimeOptInTokenSettings * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -17,5 +17,5 @@ export default class UserPageOneTimeOptInTokenSettings extends AbstractCrudObjec user_token_status: "user_token_status"; id: "id"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/user-payment-methods-info.d.ts b/types/facebook-nodejs-business-sdk/src/objects/user-payment-methods-info.d.ts new file mode 100644 index 00000000000000..cad4e924c6bae4 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/user-payment-methods-info.d.ts @@ -0,0 +1,16 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * UserPaymentMethodsInfo + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class UserPaymentMethodsInfo extends AbstractCrudObject { + static get Fields(): Readonly<{ + account_id: "account_id"; + available_card_types: "available_card_types"; + available_payment_methods: "available_payment_methods"; + available_payment_methods_details: "available_payment_methods_details"; + country: "country"; + currency: "currency"; + existing_payment_methods: "existing_payment_methods"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/user-payment-mobile-pricepoints.d.ts b/types/facebook-nodejs-business-sdk/src/objects/user-payment-mobile-pricepoints.d.ts index 28843bf33adeef..6029a82ddb5e88 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/user-payment-mobile-pricepoints.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/user-payment-mobile-pricepoints.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * UserPaymentMobilePricepoints * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/user-payment-modules-options.d.ts b/types/facebook-nodejs-business-sdk/src/objects/user-payment-modules-options.d.ts new file mode 100644 index 00000000000000..144eb523258d49 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/user-payment-modules-options.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * UserPaymentModulesOptions + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class UserPaymentModulesOptions extends AbstractCrudObject { + static get Fields(): Readonly<{ + account_id: "account_id"; + available_payment_options: "available_payment_options"; + country: "country"; + currency: "currency"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/user-set-reporting-root.d.ts b/types/facebook-nodejs-business-sdk/src/objects/user-set-reporting-root.d.ts new file mode 100644 index 00000000000000..060cba1e04fc07 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/user-set-reporting-root.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * UserSetReportingRoot + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class UserSetReportingRoot extends AbstractCrudObject { + static get Fields(): Readonly<{ + creation_time: "creation_time"; + id: "id"; + last_modified_time: "last_modified_time"; + }>; + get(fields: string[], params?: Record): Promise; +} 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 60dacb1471d666..6cbf4fb2cccb3b 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/user.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/user.d.ts @@ -1,14 +1,13 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; -import Cursor from './../cursor'; -import AdStudy from './ad-study'; -import Business from './business'; -import Post from './post'; -import FundraiserPersonToCharity from './fundraiser-person-to-charity'; -import GameItem from './game-item'; -import LiveVideo from './live-video'; -import Photo from './photo'; -import AdVideo from './ad-video'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; +import Cursor from "./../cursor"; +import AdStudy from "./ad-study"; +import Business from "./business"; +import Post from "./post"; +import FundraiserPersonToCharity from "./fundraiser-person-to-charity"; +import LiveVideo from "./live-video"; +import Photo from "./photo"; +import AdVideo from "./ad-video"; /** * User * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -82,127 +81,58 @@ export default class User extends AbstractCrudObject { content_update: "content_update"; generic: "generic"; }>; - deleteAccessTokens(params?: Record): Promise; - createAccessToken(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getAccounts(fields: string[], params?: Record): Promise; - getAccounts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createAccount(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getAdStudies(fields: string[], params?: Record): Promise; - getAdStudies(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdStudies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createAdStudy(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getAdAccounts(fields: string[], params?: Record): Promise; - getAdAccounts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAdAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAlbums(fields: string[], params?: Record): Promise; - getAlbums(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAlbums(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createApplication(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getAppRequestFormerRecipients(fields: string[], params?: Record): Promise; - getAppRequestFormerRecipients(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAppRequestFormerRecipients(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAppRequests(fields: string[], params?: Record): Promise; - getAppRequests(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAppRequests(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAssignedAdAccounts(fields: string[], params?: Record): Promise; - getAssignedAdAccounts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAssignedAdAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAssignedBusinessAssetGroups(fields: string[], params?: Record): Promise; - getAssignedBusinessAssetGroups(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAssignedBusinessAssetGroups(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAssignedPages(fields: string[], params?: Record): Promise; - getAssignedPages(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAssignedPages(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAssignedProductCatalogs(fields: string[], params?: Record): Promise; - getAssignedProductCatalogs(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAssignedProductCatalogs(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getAvatars(fields: string[], params?: Record): Promise; - getAvatars(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAvatars(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getBusinessUsers(fields: string[], params?: Record): Promise; - getBusinessUsers(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getBusinessUsers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - deleteBusinesses(params?: Record): Promise; - getBusinesses(fields: string[], params?: Record): Promise; - getBusinesses(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getBusinesses(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createBusiness(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getConversations(fields: string[], params?: Record): Promise; - getConversations(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getConversations(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getCustomLabels(fields: string[], params?: Record): Promise; - getCustomLabels(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getCustomLabels(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getEvents(fields: string[], params?: Record): Promise; - getEvents(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getEvents(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getFeed(fields: string[], params?: Record): Promise; - getFeed(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getFeed(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createFeed(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getFriends(fields: string[], params?: Record): Promise; - getFriends(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getFriends(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getFundraisers(fields: string[], params?: Record): Promise; - getFundraisers(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getFundraisers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createFundraiser(fields: string[], params?: Record, pathOverride?: string | null): Promise; - createGameItem(fields: string[], params?: Record, pathOverride?: string | null): Promise; - createGameTime(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getGroups(fields: string[], params?: Record): Promise; - getGroups(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getGroups(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getIdsForApps(fields: string[], params?: Record): Promise; - getIdsForApps(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getIdsForApps(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getIdsForBusiness(fields: string[], params?: Record): Promise; - getIdsForBusiness(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getIdsForBusiness(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getIdsForPages(fields: string[], params?: Record): Promise; - getIdsForPages(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getIdsForPages(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getLikes(fields: string[], params?: Record): Promise; - getLikes(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getLikes(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getLiveVideos(fields: string[], params?: Record): Promise; - getLiveVideos(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getLiveVideos(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createLiveVideo(fields: string[], params?: Record, pathOverride?: string | null): Promise; - createMessengerDesktopPerformanceTrace(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getMusic(fields: string[], params?: Record): Promise; - getMusic(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getMusic(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createNotification(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getPaymentTransactions(fields: string[], params?: Record): Promise; - getPaymentTransactions(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPaymentTransactions(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - deletePermissions(params?: Record): Promise; - getPermissions(fields: string[], params?: Record): Promise; - getPermissions(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPermissions(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getPersonalAdAccounts(fields: string[], params?: Record): Promise; - getPersonalAdAccounts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPersonalAdAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getPhotos(fields: string[], params?: Record): Promise; - getPhotos(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPhotos(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createPhoto(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getPicture(fields: string[], params?: Record): Promise; - getPicture(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPicture(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getPosts(fields: string[], params?: Record): Promise; - getPosts(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPosts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getRichMediaDocuments(fields: string[], params?: Record): Promise; - getRichMediaDocuments(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getRichMediaDocuments(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createStagingResource(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getVideos(fields: string[], params?: Record): Promise; - getVideos(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getVideos(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createVideo(fields: string[], params?: Record, pathOverride?: string | null): Promise; - delete(fields: string[], params?: Record): Promise; - get(fields: string[], params?: Record): Promise; - update(fields: string[], params?: Record): Promise; + deleteAccessTokens(params?: Record): Promise; + createAccessToken(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createAccount(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getAdStudies(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createAdStudy(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getAdAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getAlbums(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createApplication(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getAppRequestFormerRecipients(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getAppRequests(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getAssignedAdAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getAssignedApplications(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; + getAvatars(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getBusinessUsers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + deleteBusinesses(params?: Record): Promise; + getBusinesses(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createBusiness(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getConversations(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getCustomLabels(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getEvents(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getFeed(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createFeed(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getFriends(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getFundraisers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createFundraiser(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getGroups(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getIdsForApps(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getIdsForBusiness(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getIdsForPages(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getLikes(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getLiveVideos(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createLiveVideo(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createMessengerDesktopPerformanceTrace(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getMusic(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createNotification(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getPaymentTransactions(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + deletePermissions(params?: Record): Promise; + getPermissions(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getPersonalAdAccounts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getPhotos(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createPhoto(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getPicture(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getPosts(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getRichMediaDocuments(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createStagingResource(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getVideos(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createVideo(fields: string[], params?: Record, pathOverride?: string | null): 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/value-based-eligible-source.d.ts b/types/facebook-nodejs-business-sdk/src/objects/value-based-eligible-source.d.ts index 1466e057f10a8d..645db9c587a3be 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/value-based-eligible-source.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/value-based-eligible-source.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * ValueBasedEligibleSource * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/vehicle-offer.d.ts b/types/facebook-nodejs-business-sdk/src/objects/vehicle-offer.d.ts index 649e915cda72c2..d747c80c4a2802 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/vehicle-offer.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/vehicle-offer.d.ts @@ -1,5 +1,5 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; /** * VehicleOffer * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -64,14 +64,8 @@ export default class VehicleOffer extends AbstractCrudObject { published: "PUBLISHED"; staging: "STAGING"; }>; - getAugmentedRealitiesMetadata(fields: string[], params?: Record): Promise; - getAugmentedRealitiesMetadata(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAugmentedRealitiesMetadata(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getChannelsToIntegrityStatus(fields: string[], params?: Record): Promise; - getChannelsToIntegrityStatus(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getChannelsToIntegrityStatus(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getVideosMetadata(fields: string[], params?: Record): Promise; - getVideosMetadata(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getVideosMetadata(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - get(fields: string[], params?: Record): Promise; + getAugmentedRealitiesMetadata(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getChannelsToIntegrityStatus(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getVideosMetadata(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + get(fields: string[], 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 55ebd07aabcc77..baa3342bd574e8 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/vehicle.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/vehicle.d.ts @@ -1,5 +1,5 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; /** * Vehicle * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -147,15 +147,9 @@ export default class Vehicle extends AbstractCrudObject { rv_camper: "RV_CAMPER"; trailer: "TRAILER"; }>; - getAugmentedRealitiesMetadata(fields: string[], params?: Record): Promise; - getAugmentedRealitiesMetadata(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAugmentedRealitiesMetadata(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getChannelsToIntegrityStatus(fields: string[], params?: Record): Promise; - getChannelsToIntegrityStatus(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getChannelsToIntegrityStatus(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getVideosMetadata(fields: string[], params?: Record): Promise; - getVideosMetadata(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getVideosMetadata(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - get(fields: string[], params?: Record): Promise; - update(fields: string[], params?: Record): Promise; + getAugmentedRealitiesMetadata(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getChannelsToIntegrityStatus(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getVideosMetadata(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/video-asset.d.ts b/types/facebook-nodejs-business-sdk/src/objects/video-asset.d.ts new file mode 100644 index 00000000000000..c0824790a5d0db --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/video-asset.d.ts @@ -0,0 +1,58 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; +/** + * VideoAsset + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class VideoAsset extends AbstractCrudObject { + static get Fields(): Readonly<{ + broadcast_id: "broadcast_id"; + broadcast_planned_start_time: "broadcast_planned_start_time"; + can_viewer_edit: "can_viewer_edit"; + copyright_monitoring_status: "copyright_monitoring_status"; + created_time: "created_time"; + creator: "creator"; + description: "description"; + download_hd_url: "download_hd_url"; + download_sd_url: "download_sd_url"; + embeddable: "embeddable"; + expiration: "expiration"; + feed_type: "feed_type"; + id: "id"; + is_crossposting_eligible: "is_crossposting_eligible"; + is_crossposting_within_bm_eligible: "is_crossposting_within_bm_eligible"; + is_crossposting_within_bm_enabled: "is_crossposting_within_bm_enabled"; + is_episode: "is_episode"; + is_featured: "is_featured"; + is_live_premiere: "is_live_premiere"; + is_video_asset: "is_video_asset"; + last_added_time: "last_added_time"; + latest_creator: "latest_creator"; + latest_owned_description: "latest_owned_description"; + latest_owned_title: "latest_owned_title"; + length: "length"; + live_status: "live_status"; + no_story: "no_story"; + owner_name: "owner_name"; + owner_picture: "owner_picture"; + owner_post_state: "owner_post_state"; + permalink_url: "permalink_url"; + picture: "picture"; + posts_count: "posts_count"; + posts_ids: "posts_ids"; + posts_status: "posts_status"; + premiere_living_room_status: "premiere_living_room_status"; + published: "published"; + scheduled_publish_time: "scheduled_publish_time"; + secret: "secret"; + secure_stream_url: "secure_stream_url"; + social_actions: "social_actions"; + status: "status"; + stream_url: "stream_url"; + thumbnail_while_encoding: "thumbnail_while_encoding"; + title: "title"; + views: "views"; + }>; + getInsights(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/video-copyright-check-status.d.ts b/types/facebook-nodejs-business-sdk/src/objects/video-copyright-check-status.d.ts new file mode 100644 index 00000000000000..a0946288fd671f --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/video-copyright-check-status.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * VideoCopyrightCheckStatus + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class VideoCopyrightCheckStatus extends AbstractCrudObject { + static get Fields(): Readonly<{ + matches_found: "matches_found"; + status: "status"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/video-copyright-condition-group.d.ts b/types/facebook-nodejs-business-sdk/src/objects/video-copyright-condition-group.d.ts index f46e77ada1875a..64b8eb21b1752b 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/video-copyright-condition-group.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/video-copyright-condition-group.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * VideoCopyrightConditionGroup * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/video-copyright-geo-gate.d.ts b/types/facebook-nodejs-business-sdk/src/objects/video-copyright-geo-gate.d.ts index fc205dcd22ada8..5c847f0eb23a7b 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/video-copyright-geo-gate.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/video-copyright-geo-gate.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * VideoCopyrightGeoGate * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/video-copyright-match.d.ts b/types/facebook-nodejs-business-sdk/src/objects/video-copyright-match.d.ts new file mode 100644 index 00000000000000..8a557c6aba3fbc --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/video-copyright-match.d.ts @@ -0,0 +1,39 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * VideoCopyrightMatch + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class VideoCopyrightMatch extends AbstractCrudObject { + static get Fields(): Readonly<{ + created_date: "created_date"; + id: "id"; + last_modified_user: "last_modified_user"; + match_data: "match_data"; + match_status: "match_status"; + notes: "notes"; + permalink: "permalink"; + }>; + static get Action(): Readonly<{ + block: "BLOCK"; + claim_ad_earnings: "CLAIM_AD_EARNINGS"; + manual_review: "MANUAL_REVIEW"; + monitor: "MONITOR"; + request_takedown: "REQUEST_TAKEDOWN"; + }>; + static get ActionReason(): Readonly<{ + article_17_preflagging: "ARTICLE_17_PREFLAGGING"; + artist_objection: "ARTIST_OBJECTION"; + objectionable_content: "OBJECTIONABLE_CONTENT"; + premium_music_video: "PREMIUM_MUSIC_VIDEO"; + prerelease_content: "PRERELEASE_CONTENT"; + product_parameters: "PRODUCT_PARAMETERS"; + restricted_content: "RESTRICTED_CONTENT"; + unauthorized_commercial_use: "UNAUTHORIZED_COMMERCIAL_USE"; + }>; + static get MatchContentType(): Readonly<{ + audio_only: "AUDIO_ONLY"; + video_and_audio: "VIDEO_AND_AUDIO"; + video_only: "VIDEO_ONLY"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/video-copyright-rule.d.ts b/types/facebook-nodejs-business-sdk/src/objects/video-copyright-rule.d.ts index 0932b61f78e70e..d00368b6b0f046 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/video-copyright-rule.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/video-copyright-rule.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * VideoCopyrightRule * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -18,5 +18,5 @@ export default class VideoCopyrightRule extends AbstractCrudObject { rules_selector: "RULES_SELECTOR"; rules_tab: "RULES_TAB"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/video-copyright-segment.d.ts b/types/facebook-nodejs-business-sdk/src/objects/video-copyright-segment.d.ts index e884e1c13054e2..32390f327e4c18 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/video-copyright-segment.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/video-copyright-segment.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * VideoCopyrightSegment * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/video-copyright.d.ts b/types/facebook-nodejs-business-sdk/src/objects/video-copyright.d.ts index cb8310dd9448bc..4d7790858360cf 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/video-copyright.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/video-copyright.d.ts @@ -1,5 +1,5 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; /** * VideoCopyright * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -33,9 +33,7 @@ export default class VideoCopyright extends AbstractCrudObject { video_and_audio: "VIDEO_AND_AUDIO"; video_only: "VIDEO_ONLY"; }>; - getUpdateRecords(fields: string[], params?: Record): Promise; - getUpdateRecords(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getUpdateRecords(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - get(fields: string[], params?: Record): Promise; - update(fields: string[], params?: Record): Promise; + getUpdateRecords(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/video-group.d.ts b/types/facebook-nodejs-business-sdk/src/objects/video-group.d.ts new file mode 100644 index 00000000000000..f5d703e8df3ca9 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/video-group.d.ts @@ -0,0 +1,26 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * VideoGroup + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class VideoGroup extends AbstractCrudObject { + static get Fields(): Readonly<{ + created_time: "created_time"; + description: "description"; + disable_reason: "disable_reason"; + id: "id"; + ig_profile_ids: "ig_profile_ids"; + is_disabled: "is_disabled"; + is_fb_video_group: "is_fb_video_group"; + last_used_time: "last_used_time"; + length: "length"; + name: "name"; + page_id: "page_id"; + page_ids: "page_ids"; + picture: "picture"; + placements: "placements"; + video_group_types: "video_group_types"; + videos: "videos"; + views: "views"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/video-list.d.ts b/types/facebook-nodejs-business-sdk/src/objects/video-list.d.ts index 5cd58190a70b64..1bd3773a488240 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/video-list.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/video-list.d.ts @@ -1,5 +1,5 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; /** * VideoList * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -16,8 +16,6 @@ export default class VideoList extends AbstractCrudObject { title: "title"; videos_count: "videos_count"; }>; - getVideos(fields: string[], params?: Record): Promise; - getVideos(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getVideos(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - get(fields: string[], params?: Record): Promise; + getVideos(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/video-metrics-report.d.ts b/types/facebook-nodejs-business-sdk/src/objects/video-metrics-report.d.ts new file mode 100644 index 00000000000000..5ceecbb71b973d --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/video-metrics-report.d.ts @@ -0,0 +1,21 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * VideoMetricsReport + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class VideoMetricsReport extends AbstractCrudObject { + static get Fields(): Readonly<{ + checksum: "checksum"; + chunks: "chunks"; + end_date: "end_date"; + id: "id"; + index: "index"; + name: "name"; + platform: "platform"; + start_date: "start_date"; + type: "type"; + upload_date: "upload_date"; + url: "url"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/video-poll.d.ts b/types/facebook-nodejs-business-sdk/src/objects/video-poll.d.ts index 63e0c0c1f99e1f..e0f4d1fdc6ddd5 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/video-poll.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/video-poll.d.ts @@ -1,5 +1,5 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; /** * VideoPoll * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -26,9 +26,7 @@ export default class VideoPoll extends AbstractCrudObject { show_results: "SHOW_RESULTS"; show_voting: "SHOW_VOTING"; }>; - getPollOptions(fields: string[], params?: Record): Promise; - getPollOptions(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPollOptions(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - get(fields: string[], params?: Record): Promise; - update(fields: string[], params?: Record): Promise; + getPollOptions(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/video-stats.d.ts b/types/facebook-nodejs-business-sdk/src/objects/video-stats.d.ts new file mode 100644 index 00000000000000..dd1d0f151dcd0d --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/video-stats.d.ts @@ -0,0 +1,15 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * VideoStats + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class VideoStats extends AbstractCrudObject { + static get Fields(): Readonly<{ + aggregate: "aggregate"; + error: "error"; + metadata: "metadata"; + time_series: "time_series"; + totals: "totals"; + x_axis_breakdown: "x_axis_breakdown"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/video-status-error.d.ts b/types/facebook-nodejs-business-sdk/src/objects/video-status-error.d.ts new file mode 100644 index 00000000000000..9dfb39fd07d530 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/video-status-error.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * VideoStatusError + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class VideoStatusError extends AbstractCrudObject { + static get Fields(): Readonly<{ + code: "code"; + message: "message"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/video-status-processing-phase.d.ts b/types/facebook-nodejs-business-sdk/src/objects/video-status-processing-phase.d.ts new file mode 100644 index 00000000000000..e5eb7d7626ce1b --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/video-status-processing-phase.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * VideoStatusProcessingPhase + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class VideoStatusProcessingPhase extends AbstractCrudObject { + static get Fields(): Readonly<{ + errors: "errors"; + status: "status"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/video-status-publishing-phase.d.ts b/types/facebook-nodejs-business-sdk/src/objects/video-status-publishing-phase.d.ts new file mode 100644 index 00000000000000..2919820f98832b --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/video-status-publishing-phase.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * VideoStatusPublishingPhase + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class VideoStatusPublishingPhase extends AbstractCrudObject { + static get Fields(): Readonly<{ + errors: "errors"; + publish_status: "publish_status"; + publish_time: "publish_time"; + status: "status"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/video-status-uploading-phase.d.ts b/types/facebook-nodejs-business-sdk/src/objects/video-status-uploading-phase.d.ts new file mode 100644 index 00000000000000..0a3542e44fd957 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/video-status-uploading-phase.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * VideoStatusUploadingPhase + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class VideoStatusUploadingPhase extends AbstractCrudObject { + static get Fields(): Readonly<{ + bytes_transferred: "bytes_transferred"; + errors: "errors"; + source_file_size: "source_file_size"; + status: "status"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/video-status.d.ts b/types/facebook-nodejs-business-sdk/src/objects/video-status.d.ts new file mode 100644 index 00000000000000..47b878d8b5aefc --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/video-status.d.ts @@ -0,0 +1,15 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * VideoStatus + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class VideoStatus extends AbstractCrudObject { + static get Fields(): Readonly<{ + copyright_check_status: "copyright_check_status"; + processing_phase: "processing_phase"; + processing_progress: "processing_progress"; + publishing_phase: "publishing_phase"; + uploading_phase: "uploading_phase"; + video_status: "video_status"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/video-text-question.d.ts b/types/facebook-nodejs-business-sdk/src/objects/video-text-question.d.ts new file mode 100644 index 00000000000000..7480bb35486a8f --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/video-text-question.d.ts @@ -0,0 +1,14 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * VideoTextQuestion + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class VideoTextQuestion extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + question_target_id: "question_target_id"; + question_text: "question_text"; + status: "status"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/video-thumbnail.d.ts b/types/facebook-nodejs-business-sdk/src/objects/video-thumbnail.d.ts index 8889ace12c95c4..97c49a0afa48fa 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/video-thumbnail.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/video-thumbnail.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * VideoThumbnail * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/video-upload-limits.d.ts b/types/facebook-nodejs-business-sdk/src/objects/video-upload-limits.d.ts index f55006f0945cfc..11e16d0bf09337 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/video-upload-limits.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/video-upload-limits.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * VideoUploadLimits * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/vidwalla-broadcast.d.ts b/types/facebook-nodejs-business-sdk/src/objects/vidwalla-broadcast.d.ts new file mode 100644 index 00000000000000..bdd58fc3192f91 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/vidwalla-broadcast.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * VidwallaBroadcast + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class VidwallaBroadcast extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + overlay_url: "overlay_url"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/voip-info.d.ts b/types/facebook-nodejs-business-sdk/src/objects/voip-info.d.ts index e5bb883c73a8f6..8a9e1da59c84a7 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/voip-info.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/voip-info.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * VoipInfo * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/wearable-device-public-key.d.ts b/types/facebook-nodejs-business-sdk/src/objects/wearable-device-public-key.d.ts new file mode 100644 index 00000000000000..4b7c9f81a36499 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/wearable-device-public-key.d.ts @@ -0,0 +1,18 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * WearableDevicePublicKey + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class WearableDevicePublicKey extends AbstractCrudObject { + static get Fields(): Readonly<{ + base64_encoded_public_key: "base64_encoded_public_key"; + creation_time_on_device: "creation_time_on_device"; + device_uuid: "device_uuid"; + id: "id"; + key_type: "key_type"; + owner_id: "owner_id"; + product_use_case: "product_use_case"; + version: "version"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/web-app-link.d.ts b/types/facebook-nodejs-business-sdk/src/objects/web-app-link.d.ts index 7ca0ea84ec0df8..d7dfe2b1f7e02d 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/web-app-link.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/web-app-link.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * WebAppLink * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/web-publisher.d.ts b/types/facebook-nodejs-business-sdk/src/objects/web-publisher.d.ts new file mode 100644 index 00000000000000..14c337463cd42a --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/web-publisher.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * WebPublisher + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class WebPublisher extends AbstractCrudObject { + static get Fields(): Readonly<{ + domain_url: "domain_url"; + id: "id"; + publisher_name: "publisher_name"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/website-creative-asset-source.d.ts b/types/facebook-nodejs-business-sdk/src/objects/website-creative-asset-source.d.ts new file mode 100644 index 00000000000000..8a6be8f3923d5a --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/website-creative-asset-source.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * WebsiteCreativeAssetSource + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class WebsiteCreativeAssetSource extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + source_url: "source_url"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/website-creative-asset-suggestions.d.ts b/types/facebook-nodejs-business-sdk/src/objects/website-creative-asset-suggestions.d.ts new file mode 100644 index 00000000000000..6427ad25b684a4 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/website-creative-asset-suggestions.d.ts @@ -0,0 +1,14 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * WebsiteCreativeAssetSuggestions + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class WebsiteCreativeAssetSuggestions extends AbstractCrudObject { + static get Fields(): Readonly<{ + ad_account_id: "ad_account_id"; + extraction_status: "extraction_status"; + id: "id"; + 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 38d043a5e5b41a..47f37647c74da0 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 @@ -1,7 +1,7 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; -import Cursor from './../cursor'; -import ProductCatalog from './product-catalog'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; +import Cursor from "./../cursor"; +import ProductCatalog from "./product-catalog"; /** * WhatsAppBusinessAccount * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -10,6 +10,7 @@ export default class WhatsAppBusinessAccount extends AbstractCrudObject { static get Fields(): Readonly<{ account_review_status: "account_review_status"; analytics: "analytics"; + auth_international_rate_eligibility: "auth_international_rate_eligibility"; business_verification_status: "business_verification_status"; country: "country"; creation_time: "creation_time"; @@ -17,12 +18,14 @@ export default class WhatsAppBusinessAccount extends AbstractCrudObject { health_status: "health_status"; id: "id"; is_enabled_for_insights: "is_enabled_for_insights"; + linked_commerce_account: "linked_commerce_account"; message_template_namespace: "message_template_namespace"; name: "name"; on_behalf_of_business_info: "on_behalf_of_business_info"; owner_business: "owner_business"; owner_business_info: "owner_business_info"; ownership_type: "ownership_type"; + primary_business_location: "primary_business_location"; primary_funding_id: "primary_funding_id"; purchase_order_number: "purchase_order_number"; status: "status"; @@ -35,6 +38,7 @@ export default class WhatsAppBusinessAccount extends AbstractCrudObject { manage_phone: "MANAGE_PHONE"; manage_phone_assets: "MANAGE_PHONE_ASSETS"; manage_templates: "MANAGE_TEMPLATES"; + messaging: "MESSAGING"; view_cost: "VIEW_COST"; view_phone_assets: "VIEW_PHONE_ASSETS"; view_templates: "VIEW_TEMPLATES"; @@ -44,62 +48,41 @@ export default class WhatsAppBusinessAccount extends AbstractCrudObject { marketing: "MARKETING"; utility: "UTILITY"; }>; + static get DisplayFormat(): Readonly<{ + order_details: "ORDER_DETAILS"; + }>; static get SubCategory(): Readonly<{ - custom: "CUSTOM"; order_details: "ORDER_DETAILS"; order_status: "ORDER_STATUS"; }>; - deleteAssignedUsers(params?: Record): Promise; - getAssignedUsers(fields: string[], params?: Record): Promise; - getAssignedUsers(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAssignedUsers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createAssignedUser(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getAudiences(fields: string[], params?: Record): Promise; - getAudiences(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getAudiences(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getConversationAnalytics(fields: string[], params?: Record): Promise; - getConversationAnalytics(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getConversationAnalytics(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getFlows(fields: string[], params?: Record): Promise; - getFlows(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getFlows(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createFlow(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getMessageCampaigns(fields: string[], params?: Record): Promise; - getMessageCampaigns(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getMessageCampaigns(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getMessageTemplatePreviews(fields: string[], params?: Record): Promise; - getMessageTemplatePreviews(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getMessageTemplatePreviews(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - deleteMessageTemplates(params?: Record): Promise; - getMessageTemplates(fields: string[], params?: Record): Promise; - getMessageTemplates(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getMessageTemplates(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createMessageTemplate(fields: string[], params?: Record, pathOverride?: string | null): Promise; - createMigrateMessageTemplate(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getPhoneNumbers(fields: string[], params?: Record): Promise; - getPhoneNumbers(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPhoneNumbers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createPhoneNumber(fields: string[], params?: Record, pathOverride?: string | null): Promise; - deleteProductCatalogs(params?: Record): Promise; - getProductCatalogs(fields: string[], params?: Record): Promise; - getProductCatalogs(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getProductCatalogs(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createProductCatalog(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getSchedules(fields: string[], params?: Record): Promise; - getSchedules(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getSchedules(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - deleteSubscribedApps(params?: Record): Promise; - getSubscribedApps(fields: string[], params?: Record): Promise; - getSubscribedApps(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getSubscribedApps(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createSubscribedApp(fields: string[], params?: Record, pathOverride?: string | null): Promise; - getTemplateAnalytics(fields: string[], params?: Record): Promise; - getTemplateAnalytics(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getTemplateAnalytics(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - getTemplatePerformanceMetrics(fields: string[], params?: Record): Promise; - getTemplatePerformanceMetrics(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getTemplatePerformanceMetrics(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createUpsertMessageTemplate(fields: string[], params?: Record, pathOverride?: string | null): Promise; - get(fields: string[], params?: Record): Promise; - update(fields: string[], params?: Record): Promise; + deleteAssignedUsers(params?: Record): Promise; + getAssignedUsers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createAssignedUser(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getAudiences(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getConversationAnalytics(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getDccConfig(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getFlows(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createFlow(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getMessageCampaigns(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getMessageTemplatePreviews(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + deleteMessageTemplates(params?: Record): Promise; + getMessageTemplates(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createMessageTemplate(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createMigrateMessageTemplate(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getPhoneNumbers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createPhoneNumber(fields: string[], params?: Record, pathOverride?: string | null): Promise; + deleteProductCatalogs(params?: Record): Promise; + getProductCatalogs(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createProductCatalog(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getSchedules(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createSetOboMobilityIntent(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getSolutions(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + deleteSubscribedApps(params?: Record): Promise; + getSubscribedApps(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createSubscribedApp(fields: string[], params?: Record, pathOverride?: string | null): Promise; + getTemplateAnalytics(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + getTemplatePerformanceMetrics(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createUpsertMessageTemplate(fields: string[], params?: Record, pathOverride?: string | null): Promise; + get(fields: string[], params?: Record): Promise; + update(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/whats-app-business-health-status-for-message-send.d.ts b/types/facebook-nodejs-business-sdk/src/objects/whats-app-business-health-status-for-message-send.d.ts new file mode 100644 index 00000000000000..38fe92d42951f5 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/whats-app-business-health-status-for-message-send.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * WhatsAppBusinessHealthStatusForMessageSend + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class WhatsAppBusinessHealthStatusForMessageSend extends AbstractCrudObject { + static get Fields(): Readonly<{ + can_send_message: "can_send_message"; + entities: "entities"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/whats-app-business-health-status.d.ts b/types/facebook-nodejs-business-sdk/src/objects/whats-app-business-health-status.d.ts new file mode 100644 index 00000000000000..b7fa3963f45892 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/whats-app-business-health-status.d.ts @@ -0,0 +1,14 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * WhatsAppBusinessHealthStatus + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class WhatsAppBusinessHealthStatus extends AbstractCrudObject { + static get Fields(): Readonly<{ + additional_info: "additional_info"; + can_send_message: "can_send_message"; + entity_type: "entity_type"; + errors: "errors"; + id: "id"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/whats-app-business-partner-client-verification-submission.d.ts b/types/facebook-nodejs-business-sdk/src/objects/whats-app-business-partner-client-verification-submission.d.ts new file mode 100644 index 00000000000000..2f34ae1d1bf327 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/whats-app-business-partner-client-verification-submission.d.ts @@ -0,0 +1,28 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * WhatsAppBusinessPartnerClientVerificationSubmission + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class WhatsAppBusinessPartnerClientVerificationSubmission extends AbstractCrudObject { + static get Fields(): Readonly<{ + client_business_id: "client_business_id"; + id: "id"; + rejection_reasons: "rejection_reasons"; + submitted_info: "submitted_info"; + submitted_time: "submitted_time"; + update_time: "update_time"; + verification_status: "verification_status"; + }>; + static get RejectionReasons(): Readonly<{ + address_not_matching: "ADDRESS_NOT_MATCHING"; + legal_name_not_matching: "LEGAL_NAME_NOT_MATCHING"; + none: "NONE"; + website_not_matching: "WEBSITE_NOT_MATCHING"; + }>; + static get VerificationStatus(): Readonly<{ + approved: "APPROVED"; + failed: "FAILED"; + pending: "PENDING"; + revoked: "REVOKED"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/whats-app-business-pre-verified-phone-number.d.ts b/types/facebook-nodejs-business-sdk/src/objects/whats-app-business-pre-verified-phone-number.d.ts index f2abf1f2d1a46b..2aaab2af10b8a4 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/whats-app-business-pre-verified-phone-number.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/whats-app-business-pre-verified-phone-number.d.ts @@ -1,6 +1,6 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; -import AbstractObject from './../abstract-object'; -import Cursor from './../cursor'; +import { AbstractCrudObject } from "./../abstract-crud-object"; +import AbstractObject from "./../abstract-object"; +import Cursor from "./../cursor"; /** * WhatsAppBusinessPreVerifiedPhoneNumber * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -19,11 +19,9 @@ export default class WhatsAppBusinessPreVerifiedPhoneNumber extends AbstractCrud not_verified: "NOT_VERIFIED"; verified: "VERIFIED"; }>; - getPartners(fields: string[], params?: Record): Promise; - getPartners(fields: string[], params: Record | undefined, fetchFirstPage: false): Cursor; - getPartners(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; - createRequestCode(fields: string[], params?: Record, pathOverride?: string | null): Promise; - createVerifyCode(fields: string[], params?: Record, pathOverride?: string | null): Promise; - delete(fields: string[], params?: Record): Promise; - get(fields: string[], params?: Record): Promise; + getPartners(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + createRequestCode(fields: string[], params?: Record, pathOverride?: string | null): Promise; + createVerifyCode(fields: string[], params?: Record, pathOverride?: string | null): Promise; + delete(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/whats-app-business-profile.d.ts b/types/facebook-nodejs-business-sdk/src/objects/whats-app-business-profile.d.ts index f44d4e9351f911..e20085cba37a48 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/whats-app-business-profile.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/whats-app-business-profile.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * WhatsAppBusinessProfile * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -9,6 +9,6 @@ export default class WhatsAppBusinessProfile extends AbstractCrudObject { name_verification: "name_verification"; whatsapp_business_api_data: "whatsapp_business_api_data"; }>; - get(fields: string[], params?: Record): Promise; - update(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/whats-app-payment-capabilities.d.ts b/types/facebook-nodejs-business-sdk/src/objects/whats-app-payment-capabilities.d.ts new file mode 100644 index 00000000000000..6b972ae23325b3 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/whats-app-payment-capabilities.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * WhatsAppPaymentCapabilities + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class WhatsAppPaymentCapabilities extends AbstractCrudObject { + static get Fields(): Readonly<{ + is_enabled: "is_enabled"; + payment_capability_details: "payment_capability_details"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/whatsapp-subscribed-apps-info.d.ts b/types/facebook-nodejs-business-sdk/src/objects/whatsapp-subscribed-apps-info.d.ts new file mode 100644 index 00000000000000..5eb4debe8ff3a7 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/whatsapp-subscribed-apps-info.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * WhatsappSubscribedAppsInfo + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class WhatsappSubscribedAppsInfo extends AbstractCrudObject { + static get Fields(): Readonly<{ + page_whatsapp_number: "page_whatsapp_number"; + subscribed_apps: "subscribed_apps"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/whitehat-fbdl-run.d.ts b/types/facebook-nodejs-business-sdk/src/objects/whitehat-fbdl-run.d.ts new file mode 100644 index 00000000000000..58524a76be9f03 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/whitehat-fbdl-run.d.ts @@ -0,0 +1,18 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * WhitehatFBDLRun + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class WhitehatFBDLRun extends AbstractCrudObject { + static get Fields(): Readonly<{ + creation_time: "creation_time"; + id: "id"; + is_pinned: "is_pinned"; + note: "note"; + result: "result"; + run_code: "run_code"; + status: "status"; + user_type: "user_type"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/wifi-information.d.ts b/types/facebook-nodejs-business-sdk/src/objects/wifi-information.d.ts new file mode 100644 index 00000000000000..52206b08c0460d --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/wifi-information.d.ts @@ -0,0 +1,13 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * WifiInformation + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class WifiInformation extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + name: "name"; + network_access_type: "network_access_type"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/windows-app-link.d.ts b/types/facebook-nodejs-business-sdk/src/objects/windows-app-link.d.ts index a5e199bd822f8c..ba11d85daf9f66 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/windows-app-link.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/windows-app-link.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * WindowsAppLink * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/windows-phone-app-link.d.ts b/types/facebook-nodejs-business-sdk/src/objects/windows-phone-app-link.d.ts index 3c501564a4e102..97b4c8f0d96569 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/windows-phone-app-link.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/windows-phone-app-link.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * WindowsPhoneAppLink * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/objects/wit-user.d.ts b/types/facebook-nodejs-business-sdk/src/objects/wit-user.d.ts new file mode 100644 index 00000000000000..be33379f040276 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/wit-user.d.ts @@ -0,0 +1,12 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * WITUser + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class WITUser extends AbstractCrudObject { + static get Fields(): Readonly<{ + access_token: "access_token"; + id: "id"; + name: "name"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/with-asset3-d.d.ts b/types/facebook-nodejs-business-sdk/src/objects/with-asset3-d.d.ts new file mode 100644 index 00000000000000..34f7b7be9bb514 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/with-asset3-d.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * WithAsset3D + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class WithAsset3D extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/woodhenge-purchased-payg-receipt.d.ts b/types/facebook-nodejs-business-sdk/src/objects/woodhenge-purchased-payg-receipt.d.ts index 7fb28d1f2f207d..83189fa32aecf7 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/woodhenge-purchased-payg-receipt.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/woodhenge-purchased-payg-receipt.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * WoodhengePurchasedPAYGReceipt * @see {@link https://developers.facebook.com/docs/marketing-api/} @@ -10,5 +10,5 @@ export default class WoodhengePurchasedPAYGReceipt extends AbstractCrudObject { purchase_time: "purchase_time"; user: "user"; }>; - get(fields: string[], params?: Record): Promise; + get(fields: string[], params?: Record): Promise; } diff --git a/types/facebook-nodejs-business-sdk/src/objects/woodhenge-supporter.d.ts b/types/facebook-nodejs-business-sdk/src/objects/woodhenge-supporter.d.ts new file mode 100644 index 00000000000000..76ed5f13d12cb6 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/woodhenge-supporter.d.ts @@ -0,0 +1,16 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * WoodhengeSupporter + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class WoodhengeSupporter extends AbstractCrudObject { + static get Fields(): Readonly<{ + creation_time: "creation_time"; + id: "id"; + is_gifted_subscription: "is_gifted_subscription"; + most_recent_subscription_time: "most_recent_subscription_time"; + number_of_months_subscribed: "number_of_months_subscribed"; + user: "user"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/work-access-code.d.ts b/types/facebook-nodejs-business-sdk/src/objects/work-access-code.d.ts new file mode 100644 index 00000000000000..78f269bda7d040 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/work-access-code.d.ts @@ -0,0 +1,11 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * WorkAccessCode + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class WorkAccessCode extends AbstractCrudObject { + static get Fields(): Readonly<{ + code: "code"; + expiration_time: "expiration_time"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/work-experience.d.ts b/types/facebook-nodejs-business-sdk/src/objects/work-experience.d.ts new file mode 100644 index 00000000000000..fe9371d94498b5 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/work-experience.d.ts @@ -0,0 +1,20 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * WorkExperience + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class WorkExperience extends AbstractCrudObject { + static get Fields(): Readonly<{ + description: "description"; + employer: "employer"; + end_date: "end_date"; + from: "from"; + id: "id"; + location: "location"; + position: "position"; + projects: "projects"; + start_date: "start_date"; + with: "with"; + }>; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/work-skill.d.ts b/types/facebook-nodejs-business-sdk/src/objects/work-skill.d.ts new file mode 100644 index 00000000000000..49a7d8964bedf7 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/work-skill.d.ts @@ -0,0 +1,14 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +import Cursor from "./../cursor"; +/** + * WorkSkill + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class WorkSkill extends AbstractCrudObject { + static get Fields(): Readonly<{ + id: "id"; + name: "name"; + }>; + getUsers(fields: string[], params?: Record, fetchFirstPage?: boolean): Cursor | Promise; + get(fields: string[], params?: Record): Promise; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/work-user-badges.d.ts b/types/facebook-nodejs-business-sdk/src/objects/work-user-badges.d.ts new file mode 100644 index 00000000000000..9d33ed182d6ba6 --- /dev/null +++ b/types/facebook-nodejs-business-sdk/src/objects/work-user-badges.d.ts @@ -0,0 +1,14 @@ +import { AbstractCrudObject } from "./../abstract-crud-object"; +/** + * WorkUserBadges + * @see {@link https://developers.facebook.com/docs/marketing-api/} + */ +export default class WorkUserBadges extends AbstractCrudObject { + static get Fields(): Readonly<{ + category: "category"; + description: "description"; + icon: "icon"; + id: "id"; + name: "name"; + }>; +} diff --git a/types/facebook-nodejs-business-sdk/src/objects/work-user-frontline.d.ts b/types/facebook-nodejs-business-sdk/src/objects/work-user-frontline.d.ts index 87df5c31fae64b..0e86065fc7c9a8 100644 --- a/types/facebook-nodejs-business-sdk/src/objects/work-user-frontline.d.ts +++ b/types/facebook-nodejs-business-sdk/src/objects/work-user-frontline.d.ts @@ -1,4 +1,4 @@ -import { AbstractCrudObject } from './../abstract-crud-object'; +import { AbstractCrudObject } from "./../abstract-crud-object"; /** * WorkUserFrontline * @see {@link https://developers.facebook.com/docs/marketing-api/} diff --git a/types/facebook-nodejs-business-sdk/src/video-uploader.d.ts b/types/facebook-nodejs-business-sdk/src/video-uploader.d.ts index 7e887b4458c38e..4c11a8c871ea20 100644 --- a/types/facebook-nodejs-business-sdk/src/video-uploader.d.ts +++ b/types/facebook-nodejs-business-sdk/src/video-uploader.d.ts @@ -1,8 +1,8 @@ -import AdVideo from './objects/ad-video'; -import FacebookAdsApi from './api'; +import AdVideo from "./objects/ad-video"; +import FacebookAdsApi from "./api"; /** * Video uploader that can upload videos to adaccount - */ + **/ declare class VideoUploader { _session: VideoUploadSession | null | undefined; constructor(); @@ -11,8 +11,8 @@ declare class VideoUploader { * @param {AdVideo} video The AdVideo object that will be uploaded * @param {Boolean} [waitForEncoding] Whether to wait until encoding * is finished - */ - upload(video: AdVideo, waitForEncoding: boolean): Record; + **/ + upload(video: AdVideo, waitForEncoding: boolean): Record; } interface SlideshowSpec { images_urls: string[]; @@ -33,45 +33,45 @@ declare class VideoUploadSession { _video: AdVideo; _waitForEncoding: boolean; constructor(video: AdVideo, waitForEncoding?: boolean); - start(): Promise>; + start(): Record; getStartRequestContext(): VideoUploadRequestContext; getTransferRequestContext(): VideoUploadRequestContext; getFinishRequestContext(): VideoUploadRequestContext; } /** * Abstract class for request managers - */ + **/ declare class VideoUploadRequestManager { _api: FacebookAdsApi; constructor(api: FacebookAdsApi); - sendRequest(context: VideoUploadRequestContext): Record; - getParamsFromContext(context: VideoUploadRequestContext): Record; + sendRequest(context: VideoUploadRequestContext): Record; + getParamsFromContext(context: VideoUploadRequestContext): Record; } declare class VideoUploadStartRequestManager extends VideoUploadRequestManager { /** * Send start request with the given context - */ - sendRequest(context: VideoUploadRequestContext): Promise>; - getParamsFromContext(context: VideoUploadRequestContext): Record; + **/ + sendRequest(context: VideoUploadRequestContext): Record; + getParamsFromContext(context: VideoUploadRequestContext): Record; } declare class VideoUploadTransferRequestManager extends VideoUploadRequestManager { _startOffset: number; _endOffset: number; /** * Send transfer request with the given context - */ - sendRequest(context: VideoUploadRequestContext): Promise>; + **/ + sendRequest(context: VideoUploadRequestContext): Record; } declare class VideoUploadFinishRequestManager extends VideoUploadRequestManager { /** * Send transfer request with the given context - */ - sendRequest(context: VideoUploadRequestContext): Promise>; - getParamsFromContext(context: VideoUploadRequestContext): Record; + **/ + sendRequest(context: VideoUploadRequestContext): Record; + getParamsFromContext(context: VideoUploadRequestContext): Record; } /** * Upload request context that contains the param data - */ + **/ declare class VideoUploadRequestContext { _accountId: string; _fileName: string; @@ -105,19 +105,19 @@ declare class VideoUploadRequestContext { set videoFileChunk(videoFileChunk: string); } declare class VideoUploadRequest { - _params: Record; - _files: Record; + _params: Record; + _files: Record; _api: FacebookAdsApi; constructor(api: FacebookAdsApi); /** * Send the current request - */ - send(path: string | string[]): Record; - setParams(params: Record, files?: Record): void; + **/ + send(path: string | string[]): Record; + setParams(params: Record, files?: Record): void; } -declare namespace VideoEncodingStatusChecker { - function waitUntilReady(api: FacebookAdsApi, videoId: number, interval: number, timeout: number): Promise; - function getStatus(api: FacebookAdsApi, videoId: number): any; +declare class VideoEncodingStatusChecker { + static waitUntilReady(api: FacebookAdsApi, videoId: number, interval: number, timeout: number): Promise; + static getStatus(api: FacebookAdsApi, videoId: number): any; } export { VideoUploader, VideoUploadRequest, VideoEncodingStatusChecker }; export type { SlideshowSpec }; diff --git a/types/fcostarodrigo__walk/fcostarodrigo__walk-tests.ts b/types/fcostarodrigo__walk/fcostarodrigo__walk-tests.ts deleted file mode 100644 index fdcba123724bdd..00000000000000 --- a/types/fcostarodrigo__walk/fcostarodrigo__walk-tests.ts +++ /dev/null @@ -1,29 +0,0 @@ -import walk = require("@fcostarodrigo/walk"); - -async function parameterless() { - for await (const file of walk()) { - const fileStr: string = file; - } -} - -async function pathParam() { - for await (const file of walk("foo")) { - const fileStr: string = file; - } -} - -async function filesAndDirs() { - for await (const file of walk("foo", true)) { - const fileStr: string = file; - } -} - -async function withCallback() { - function shouldList(dir: string): boolean { - return true; - } - - for await (const file of walk("foo", false, shouldList)) { - const fileStr: string = file; - } -} diff --git a/types/fcostarodrigo__walk/index.d.ts b/types/fcostarodrigo__walk/index.d.ts deleted file mode 100644 index d88908864e6ed2..00000000000000 --- a/types/fcostarodrigo__walk/index.d.ts +++ /dev/null @@ -1,7 +0,0 @@ -interface Walk { - (path?: string, listFolders?: boolean, walkFolder?: (path: string) => boolean): AsyncIterable; -} - -declare const walk: Walk; - -export = walk; diff --git a/types/fcostarodrigo__walk/package.json b/types/fcostarodrigo__walk/package.json deleted file mode 100644 index a98fa20e233609..00000000000000 --- a/types/fcostarodrigo__walk/package.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "private": true, - "name": "@types/fcostarodrigo__walk", - "version": "5.0.9999", - "projects": [ - "https://github.com/fcostarodrigo/walk#readme" - ], - "devDependencies": { - "@types/fcostarodrigo__walk": "workspace:." - }, - "owners": [ - { - "name": "tpluscode", - "githubUsername": "tpluscode" - } - ] -} diff --git a/types/fernet/fernet-tests.ts b/types/fernet/fernet-tests.ts index 7a6c61705f3755..08825770d55eee 100644 --- a/types/fernet/fernet-tests.ts +++ b/types/fernet/fernet-tests.ts @@ -32,12 +32,12 @@ fInst.ttl; // $ExpectType number fInst.versionHex; // $ExpectType string fInst.ivHex; // $ExpectType string fInst.iv; // $ExpectType WordArray -fInst.secret; // $ExpectType: Secret | undefined +fInst.secret; // $ExpectType Secret | undefined fernet.ttl; // $ExpectType number fernet.versionHex; // $ExpectType string fernet.ivHex; // $ExpectType string fernet.iv; // $ExpectType WordArray -fernet.secret; // $ExpectType: Secret | undefined +fernet.secret; // $ExpectType Secret | undefined fInst.parseHex("123"); // $ExpectType number fInst.decode64toHex("123"); // $ExpectType string diff --git a/types/firefox-webext-browser/package.json b/types/firefox-webext-browser/package.json index 76774419b0c28c..eb281e17beb763 100644 --- a/types/firefox-webext-browser/package.json +++ b/types/firefox-webext-browser/package.json @@ -14,10 +14,6 @@ { "name": "Jasmin Bom", "githubUsername": "jsmnbom" - }, - { - "name": "Coder Shiba", - "githubUsername": "codershiba" } ] } diff --git a/types/firstline/firstline-tests.ts b/types/firstline/firstline-tests.ts index 455f917c5e07a7..0a428d9075d932 100644 --- a/types/firstline/firstline-tests.ts +++ b/types/firstline/firstline-tests.ts @@ -1,10 +1,10 @@ import firstline = require("firstline"); -// $ExpectType: Promise +// $ExpectType Promise firstline("./my-file.txt"); -// $ExpectType: Promise +// $ExpectType Promise firstline("./my-file.txt", { lineEnding: "\r" }); -// $ExpectType: Promise +// $ExpectType Promise firstline("./my-file.txt", { lineEnding: "\r", encoding: "ascii" }); // @ts-expect-error firstline("./my-file.txt", { lineEnding: "\r", encoding: "utf88" }); diff --git a/types/floreal/floreal-tests.ts b/types/floreal/floreal-tests.ts index 98fbc74c7bf9e6..678283bfce5527 100644 --- a/types/floreal/floreal-tests.ts +++ b/types/floreal/floreal-tests.ts @@ -5,8 +5,8 @@ const fd2 = new Floreal("1799-11-09"); // $ExpectType FlorealDate const fd3 = new Floreal(Date.now()); // $ExpectType FlorealDate const fd4 = new Floreal(new Date()); // $ExpectType FlorealDate -fd1.dayName(); // $ExpectType: string -fd2.firstDayOfYear(); // $ExpectType: Date +fd1.dayName(); // $ExpectType string +fd2.firstDayOfYear(); // $ExpectType Date // @ts-expect-error fd1.foo(); fd1.setYear("XII"); diff --git a/types/gapi.client.cloudiot-v1/.npmignore b/types/flubber/.npmignore similarity index 100% rename from types/gapi.client.cloudiot-v1/.npmignore rename to types/flubber/.npmignore diff --git a/types/flubber/flubber-tests.ts b/types/flubber/flubber-tests.ts new file mode 100644 index 00000000000000..eab6b3de0d93f0 --- /dev/null +++ b/types/flubber/flubber-tests.ts @@ -0,0 +1,22 @@ +import flubber = require("flubber"); + +var triangle = "M1,0 L2,2 L0,2 Z", + pentagon = [[0, 0], [2, 0], [2, 1], [1, 2], [0, 1]]; + +var interpolator = flubber.interpolate(triangle, pentagon); +interpolator(0); // returns an SVG triangle path string +interpolator(0.5); // returns something halfway between the triangle and the octagon +interpolator(1); // returns an SVG octagon path string + +var interpolator = flubber.toCircle(triangle, 100, 100, 10); +interpolator(0); // returns an SVG triangle path string +interpolator(0.5); // returns something halfway between the triangle and the circle +interpolator(1); // returns a circle path string centered at 100, 100 with a radius of 10 + +var interpolator = flubber.toRect(triangle, 10, 50, 100, 200); +interpolator(0); // returns an SVG triangle path string +interpolator(0.5); // returns something halfway between the triangle and the rectangle +interpolator(1); // returns a rectangle path string from [10, 50] in the upper left to [110, 250] in the lower right + +flubber.toPathString([[1, 1], [2, 1], [1.5, 2]]); +flubber.splitPathString("M1,1 L2,1 L1.5,2Z M3,3 L4,3 L3.5,4 Z"); diff --git a/types/flubber/index.d.ts b/types/flubber/index.d.ts new file mode 100644 index 00000000000000..d14c6d91104e7b --- /dev/null +++ b/types/flubber/index.d.ts @@ -0,0 +1,43 @@ +export type Interpolator = (t: number) => string; + +export type Shape = number[][] | string; + +export interface Options { + maxSegmentLength?: number; + string?: boolean; + single?: boolean; +} + +export function interpolate(fromShape: Shape, toShape: Shape, options?: Options): Interpolator; + +export function toCircle(fromShape: Shape, x: number, y: number, r: number): Interpolator; + +export function toRect( + fromShape: Shape, + x: number, + y: number, + width: number, + height: number, + options?: Options, +): Interpolator; + +export function fromCircle(x: number, y: number, radius: number, toShape: Shape, options?: Options): Interpolator; + +export function fromRect( + x: number, + y: number, + width: number, + height: number, + toShape: Shape, + options?: Options, +): Interpolator; + +export function separate(fromShape: Shape, toShapeList: Shape[], options?: Options): Interpolator; + +export function combine(fromShapeList: Shape[], toShape: Shape, options?: Options): Interpolator; + +export function interpolateAll(fromShapeList: Shape[], toShapeList: Shape[], options?: Options): Interpolator; + +export function toPathString(ring: Array<[number, number]>): string; + +export function splitPathString(pathString: string): string[]; diff --git a/types/flubber/package.json b/types/flubber/package.json new file mode 100644 index 00000000000000..66bc98440be46c --- /dev/null +++ b/types/flubber/package.json @@ -0,0 +1,17 @@ +{ + "private": true, + "name": "@types/flubber", + "version": "0.4.9999", + "projects": [ + "https://github.com/veltman/flubber#readme" + ], + "devDependencies": { + "@types/flubber": "workspace:." + }, + "owners": [ + { + "name": "Huxulm", + "githubUsername": "huxulm" + } + ] +} diff --git a/types/streamtest/tsconfig.json b/types/flubber/tsconfig.json similarity index 92% rename from types/streamtest/tsconfig.json rename to types/flubber/tsconfig.json index 08a19b94fb03d9..54aed6062de0c0 100644 --- a/types/streamtest/tsconfig.json +++ b/types/flubber/tsconfig.json @@ -6,14 +6,14 @@ ], "noImplicitAny": true, "noImplicitThis": true, - "strictNullChecks": true, "strictFunctionTypes": true, + "strictNullChecks": true, "types": [], "noEmit": true, "forceConsistentCasingInFileNames": true }, "files": [ "index.d.ts", - "streamtest-tests.ts" + "flubber-tests.ts" ] } diff --git a/types/fluent-ffmpeg/fluent-ffmpeg-tests.ts b/types/fluent-ffmpeg/fluent-ffmpeg-tests.ts index f264ce454a5d18..08366d75733124 100644 --- a/types/fluent-ffmpeg/fluent-ffmpeg-tests.ts +++ b/types/fluent-ffmpeg/fluent-ffmpeg-tests.ts @@ -105,3 +105,26 @@ ffmpeg("/path/to/part1.avi") .input("/path/to/part2.avi") .input("/path/to/part2.avi") .mergeToFile("/path/to/merged.avi", "/path/to/tempDir"); + +ffmpeg("/path/to/file.avi") + .on("start", (commandLine) => { + console.log("Spawned Ffmpeg with command: " + commandLine); + }) + .on("codecData", (data) => { + console.log( + "Input is " + data.audio + " audio " + + "with " + data.video + " video", + ); + }) + .on("progress", (progress) => { + console.log("Processing: " + progress.percent + "% done"); + }) + .on("stderr", (stderrLine) => { + console.log("Stderr output: " + stderrLine); + }) + .on("error", (err, stdout, stderr) => { + console.log("Cannot process video: " + err.message); + }) + .on("end", () => { + console.log("Transcoding succeeded !"); + }); diff --git a/types/fluent-ffmpeg/index.d.ts b/types/fluent-ffmpeg/index.d.ts index dfd183b9b07049..ee9f49232a8b9e 100644 --- a/types/fluent-ffmpeg/index.d.ts +++ b/types/fluent-ffmpeg/index.d.ts @@ -382,6 +382,88 @@ declare namespace Ffmpeg { ffprobe(options: string[], callback: (err: any, data: FfprobeData) => void): void; // tslint:disable-line unified-signatures ffprobe(index: number, options: string[], callback: (err: any, data: FfprobeData) => void): void; + // event listeners + /** + * Emitted just after ffmpeg has been spawned. + * + * @event FfmpegCommand#start + * @param {String} command ffmpeg command line + */ + on(event: "start", listener: (command: string) => void): this; + + /** + * Emitted when ffmpeg reports progress information + * + * @event FfmpegCommand#progress + * @param {Object} progress progress object + * @param {Number} progress.frames number of frames transcoded + * @param {Number} progress.currentFps current processing speed in frames per second + * @param {Number} progress.currentKbps current output generation speed in kilobytes per second + * @param {Number} progress.targetSize current output file size + * @param {String} progress.timemark current video timemark + * @param {Number} [progress.percent] processing progress (may not be available depending on input) + */ + on( + event: "progress", + listener: (progress: { + frames: number; + currentFps: number; + currentKbps: number; + targetSize: number; + timemark: string; + percent?: number | undefined; + }) => void, + ): this; + + /** + * Emitted when ffmpeg outputs to stderr + * + * @event FfmpegCommand#stderr + * @param {String} line stderr output line + */ + on(event: "stderr", listener: (line: string) => void): this; + + /** + * Emitted when ffmpeg reports input codec data + * + * @event FfmpegCommand#codecData + * @param {Object} codecData codec data object + * @param {String} codecData.format input format name + * @param {String} codecData.audio input audio codec name + * @param {String} codecData.audio_details input audio codec parameters + * @param {String} codecData.video input video codec name + * @param {String} codecData.video_details input video codec parameters + */ + on( + event: "codecData", + listener: (codecData: { + format: string; + audio: string; + audio_details: string; + video: string; + video_details: string; + }) => void, + ): this; + + /** + * Emitted when an error happens when preparing or running a command + * + * @event FfmpegCommand#error + * @param {Error} error error object, with optional properties 'inputStreamError' / 'outputStreamError' for errors on their respective streams + * @param {String|null} stdout ffmpeg stdout, unless outputting to a stream + * @param {String|null} stderr ffmpeg stderr + */ + on(event: "error", listener: (error: Error, stdout: string | null, stderr: string | null) => void): this; + + /** + * Emitted when a command finishes processing + * + * @event FfmpegCommand#end + * @param {Array|String|null} [filenames|stdout] generated filenames when taking screenshots, ffmpeg stdout when not outputting to a stream, null otherwise + * @param {String|null} stderr ffmpeg stderr + */ + on(event: "end", listener: (filenames: string[] | string | null, stderr: string | null) => void): this; + // recipes saveToFile(output: string): FfmpegCommand; save(output: string): FfmpegCommand; diff --git a/types/forge-viewer/forge-viewer-tests.ts b/types/forge-viewer/forge-viewer-tests.ts index 0cf93809610787..b4fa17e2ef54d8 100644 --- a/types/forge-viewer/forge-viewer-tests.ts +++ b/types/forge-viewer/forge-viewer-tests.ts @@ -47,6 +47,7 @@ Autodesk.Viewing.Initializer(options, async () => { showHideTests(viewer); worldUpTests(viewer); selectionTests(viewer); + errorCodeTests(); await bulkPropertiesTests(model); await compGeomTests(viewer); await dataVizTests(viewer); @@ -758,3 +759,38 @@ async function dbIdRemappingTest(viewer: Autodesk.Viewing.GuiViewer3D): Promise< this.model.idRemap = result.dbidOldToNew; }; } + +function errorCodeTests(): void { + // $ExpectType ErrorCodes.UNKNOWN_FAILURE + Autodesk.Viewing.ErrorCodes.UNKNOWN_FAILURE; + // $ExpectType ErrorCodes.BAD_DATA + Autodesk.Viewing.ErrorCodes.BAD_DATA; + // $ExpectType ErrorCodes.NETWORK_FAILURE + Autodesk.Viewing.ErrorCodes.NETWORK_FAILURE; + // $ExpectType ErrorCodes.NETWORK_ACCESS_DENIED + Autodesk.Viewing.ErrorCodes.NETWORK_ACCESS_DENIED; + // $ExpectType ErrorCodes.NETWORK_FILE_NOT_FOUND + Autodesk.Viewing.ErrorCodes.NETWORK_FILE_NOT_FOUND; + // $ExpectType ErrorCodes.NETWORK_SERVER_ERROR + Autodesk.Viewing.ErrorCodes.NETWORK_SERVER_ERROR; + // $ExpectType ErrorCodes.NETWORK_UNHANDLED_RESPONSE_CODE + Autodesk.Viewing.ErrorCodes.NETWORK_UNHANDLED_RESPONSE_CODE; + // $ExpectType ErrorCodes.BROWSER_WEBGL_NOT_SUPPORTED + Autodesk.Viewing.ErrorCodes.BROWSER_WEBGL_NOT_SUPPORTED; + // $ExpectType ErrorCodes.BAD_DATA_NO_VIEWABLE_CONTENT + Autodesk.Viewing.ErrorCodes.BAD_DATA_NO_VIEWABLE_CONTENT; + // $ExpectType ErrorCodes.BROWSER_WEBGL_DISABLED + Autodesk.Viewing.ErrorCodes.BROWSER_WEBGL_DISABLED; + // $ExpectType ErrorCodes.BAD_DATA_MODEL_IS_EMPTY + Autodesk.Viewing.ErrorCodes.BAD_DATA_MODEL_IS_EMPTY; + // $ExpectType ErrorCodes.RTC_ERROR + Autodesk.Viewing.ErrorCodes.RTC_ERROR; + // $ExpectType ErrorCodes.UNSUPORTED_FILE_EXTENSION + Autodesk.Viewing.ErrorCodes.UNSUPORTED_FILE_EXTENSION; + // $ExpectType ErrorCodes.VIEWER_INTERNAL_ERROR + Autodesk.Viewing.ErrorCodes.VIEWER_INTERNAL_ERROR; + // $ExpectType ErrorCodes.WEBGL_LOST_CONTEXT + Autodesk.Viewing.ErrorCodes.WEBGL_LOST_CONTEXT; + // $ExpectType ErrorCodes.LOAD_CANCELED + Autodesk.Viewing.ErrorCodes.LOAD_CANCELED; +} diff --git a/types/forge-viewer/index.d.ts b/types/forge-viewer/index.d.ts index 0cb07be15c4822..6eb7dcd5e70458 100644 --- a/types/forge-viewer/index.d.ts +++ b/types/forge-viewer/index.d.ts @@ -32,6 +32,8 @@ declare namespace Autodesk { RTC_ERROR = 12, UNSUPORTED_FILE_EXTENSION = 13, VIEWER_INTERNAL_ERROR = 14, + WEBGL_LOST_CONTEXT = 15, + LOAD_CANCELED = 16, } enum SelectionMode { diff --git a/types/gamedig/gamedig-tests.ts b/types/gamedig/gamedig-tests.ts index 8bd106706f620b..fe3710b7018519 100644 --- a/types/gamedig/gamedig-tests.ts +++ b/types/gamedig/gamedig-tests.ts @@ -21,6 +21,8 @@ gamedig.GameDig.query( requestPlayersRequired: true, checkOldIDs: true, // checkAlias: true, + username: "admin", + password: "mypass", }, (error: any, state: gamedig.QueryResult) => { if (error) throw error; @@ -48,6 +50,8 @@ gd.query( requestPlayersRequired: true, checkOldIDs: true, // checkAlias: true, + username: "admin", + password: "mypass", }, (error: any, state: gamedig.QueryResult) => { if (error) throw error; diff --git a/types/gamedig/index.d.cts b/types/gamedig/index.d.cts index 61875ae77c9b20..5c7a1c39a37e18 100644 --- a/types/gamedig/index.d.cts +++ b/types/gamedig/index.d.cts @@ -63,11 +63,14 @@ export interface QueryOptions { guildId?: string; // Nadeo login?: string; + // Nadeo / Palworld password?: string; // Teamspeak 3 teamspeakQueryPort?: number; // Terraria token?: string; + // Palworld + username?: string; } export interface QueryResult { diff --git a/types/gamedig/package.json b/types/gamedig/package.json index 9f399e7388781f..46dcfb24c3d8f2 100644 --- a/types/gamedig/package.json +++ b/types/gamedig/package.json @@ -21,10 +21,22 @@ { "name": "Joshua Schmeder", "githubUsername": "MaximumWoahverdrive" + }, + { + "name": "a-sync", + "githubUsername": "a-sync" } ], "exports": { - "import": "./index.d.ts", - "require": "./index.d.cts" + ".": { + "import": { + "types": "./index.d.ts", + "default": "./index.js" + }, + "require": { + "types": "./index.d.cts", + "default": "./index.cjs" + } + } } } diff --git a/types/gamedig/tsconfig.json b/types/gamedig/tsconfig.json index 676b683f6a1252..51796faa9f25a3 100644 --- a/types/gamedig/tsconfig.json +++ b/types/gamedig/tsconfig.json @@ -1,6 +1,6 @@ { "compilerOptions": { - "module": "commonjs", + "module": "node16", "target": "es6", "lib": [ "es6" diff --git a/types/gapi.client.accessapproval-v1/package.json b/types/gapi.client.accessapproval-v1/package.json index 1d2903ad154bcd..4c63ee857005c9 100644 --- a/types/gapi.client.accessapproval-v1/package.json +++ b/types/gapi.client.accessapproval-v1/package.json @@ -5,7 +5,7 @@ "nonNpm": true, "nonNpmDescription": "Access Approval API v1", "projects": [ - "https://cloud.google.com/cloud-provider-access-management/access-approval/docs" + "https://cloud.google.com/assured-workloads/access-approval/docs" ], "dependencies": { "@maxim_mazurok/gapi.client.accessapproval-v1": "latest" diff --git a/types/gapi.client.displayvideo-v1/.npmignore b/types/gapi.client.addressvalidation-v1/.npmignore similarity index 100% rename from types/gapi.client.displayvideo-v1/.npmignore rename to types/gapi.client.addressvalidation-v1/.npmignore diff --git a/types/gapi.client.addressvalidation-v1/index.d.ts b/types/gapi.client.addressvalidation-v1/index.d.ts new file mode 100644 index 00000000000000..009e50ec1fae6d --- /dev/null +++ b/types/gapi.client.addressvalidation-v1/index.d.ts @@ -0,0 +1,4 @@ +// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator +// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new + +/// diff --git a/types/gapi.client.sourcerepo-v1/package.json b/types/gapi.client.addressvalidation-v1/package.json similarity index 60% rename from types/gapi.client.sourcerepo-v1/package.json rename to types/gapi.client.addressvalidation-v1/package.json index 922d7500c0b76c..a82999cf5ab7e3 100644 --- a/types/gapi.client.sourcerepo-v1/package.json +++ b/types/gapi.client.addressvalidation-v1/package.json @@ -1,17 +1,17 @@ { "private": true, - "name": "@types/gapi.client.sourcerepo-v1", + "name": "@types/gapi.client.addressvalidation-v1", "version": "0.0.9999", "nonNpm": true, - "nonNpmDescription": "Cloud Source Repositories API v1", + "nonNpmDescription": "Address Validation API v1", "projects": [ - "https://cloud.google.com/source-repositories/docs/apis" + "https://developers.google.com/maps/documentation/addressvalidation" ], "dependencies": { - "@maxim_mazurok/gapi.client.sourcerepo-v1": "latest" + "@maxim_mazurok/gapi.client.addressvalidation-v1": "latest" }, "devDependencies": { - "@types/gapi.client.sourcerepo-v1": "workspace:." + "@types/gapi.client.addressvalidation-v1": "workspace:." }, "owners": [ { diff --git a/types/gapi.client.accesscontextmanager-v1beta/tsconfig.json b/types/gapi.client.addressvalidation-v1/tsconfig.json similarity index 100% rename from types/gapi.client.accesscontextmanager-v1beta/tsconfig.json rename to types/gapi.client.addressvalidation-v1/tsconfig.json diff --git a/types/gapi.client.doubleclickbidmanager-v1.1/.npmignore b/types/gapi.client.aiplatform-v1/.npmignore similarity index 100% rename from types/gapi.client.doubleclickbidmanager-v1.1/.npmignore rename to types/gapi.client.aiplatform-v1/.npmignore diff --git a/types/gapi.client.googleads-v10/index.d.ts b/types/gapi.client.aiplatform-v1/index.d.ts similarity index 78% rename from types/gapi.client.googleads-v10/index.d.ts rename to types/gapi.client.aiplatform-v1/index.d.ts index 709a8ad6cf9c30..2a99e837f255f0 100644 --- a/types/gapi.client.googleads-v10/index.d.ts +++ b/types/gapi.client.aiplatform-v1/index.d.ts @@ -1,4 +1,4 @@ // Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator // In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new -/// +/// diff --git a/types/gapi.client.googleads-v4/package.json b/types/gapi.client.aiplatform-v1/package.json similarity index 64% rename from types/gapi.client.googleads-v4/package.json rename to types/gapi.client.aiplatform-v1/package.json index b03b3ccf04c861..4f1de0ecda4391 100644 --- a/types/gapi.client.googleads-v4/package.json +++ b/types/gapi.client.aiplatform-v1/package.json @@ -1,17 +1,17 @@ { "private": true, - "name": "@types/gapi.client.googleads-v4", + "name": "@types/gapi.client.aiplatform-v1", "version": "0.0.9999", "nonNpm": true, - "nonNpmDescription": "Google Ads API v4", + "nonNpmDescription": "Vertex AI API v1", "projects": [ - "https://developers.google.com/google-ads/api/" + "https://cloud.google.com/vertex-ai/" ], "dependencies": { - "@maxim_mazurok/gapi.client.googleads-v4": "latest" + "@maxim_mazurok/gapi.client.aiplatform-v1": "latest" }, "devDependencies": { - "@types/gapi.client.googleads-v4": "workspace:." + "@types/gapi.client.aiplatform-v1": "workspace:." }, "owners": [ { diff --git a/types/gapi.client.cloudiot-v1/tsconfig.json b/types/gapi.client.aiplatform-v1/tsconfig.json similarity index 100% rename from types/gapi.client.cloudiot-v1/tsconfig.json rename to types/gapi.client.aiplatform-v1/tsconfig.json diff --git a/types/gapi.client.eventarc-v1beta1/.npmignore b/types/gapi.client.aiplatform-v1beta1/.npmignore similarity index 100% rename from types/gapi.client.eventarc-v1beta1/.npmignore rename to types/gapi.client.aiplatform-v1beta1/.npmignore diff --git a/types/gapi.client.aiplatform-v1beta1/index.d.ts b/types/gapi.client.aiplatform-v1beta1/index.d.ts new file mode 100644 index 00000000000000..e6398706779e1f --- /dev/null +++ b/types/gapi.client.aiplatform-v1beta1/index.d.ts @@ -0,0 +1,4 @@ +// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator +// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new + +/// diff --git a/types/gapi.client.aiplatform-v1beta1/package.json b/types/gapi.client.aiplatform-v1beta1/package.json new file mode 100644 index 00000000000000..9f35ed447959f7 --- /dev/null +++ b/types/gapi.client.aiplatform-v1beta1/package.json @@ -0,0 +1,30 @@ +{ + "private": true, + "name": "@types/gapi.client.aiplatform-v1beta1", + "version": "0.0.9999", + "nonNpm": true, + "nonNpmDescription": "Vertex AI API v1beta1", + "projects": [ + "https://cloud.google.com/vertex-ai/" + ], + "dependencies": { + "@maxim_mazurok/gapi.client.aiplatform-v1beta1": "latest" + }, + "devDependencies": { + "@types/gapi.client.aiplatform-v1beta1": "workspace:." + }, + "owners": [ + { + "name": "Maxim Mazurok", + "githubUsername": "Maxim-Mazurok" + }, + { + "name": "Nick Amoscato", + "githubUsername": "namoscato" + }, + { + "name": "Declan Vong", + "githubUsername": "declanvong" + } + ] +} diff --git a/types/gapi.client.displayvideo-v1/tsconfig.json b/types/gapi.client.aiplatform-v1beta1/tsconfig.json similarity index 100% rename from types/gapi.client.displayvideo-v1/tsconfig.json rename to types/gapi.client.aiplatform-v1beta1/tsconfig.json diff --git a/types/gapi.client.gameservices-v1/.npmignore b/types/gapi.client.airquality-v1/.npmignore similarity index 100% rename from types/gapi.client.gameservices-v1/.npmignore rename to types/gapi.client.airquality-v1/.npmignore diff --git a/types/gapi.client.googleads-v13/index.d.ts b/types/gapi.client.airquality-v1/index.d.ts similarity index 78% rename from types/gapi.client.googleads-v13/index.d.ts rename to types/gapi.client.airquality-v1/index.d.ts index f788a8e4fc842d..14cda5d4c937d9 100644 --- a/types/gapi.client.googleads-v13/index.d.ts +++ b/types/gapi.client.airquality-v1/index.d.ts @@ -1,4 +1,4 @@ // Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator // In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new -/// +/// diff --git a/types/gapi.client.airquality-v1/package.json b/types/gapi.client.airquality-v1/package.json new file mode 100644 index 00000000000000..66fd37a08513de --- /dev/null +++ b/types/gapi.client.airquality-v1/package.json @@ -0,0 +1,30 @@ +{ + "private": true, + "name": "@types/gapi.client.airquality-v1", + "version": "0.0.9999", + "nonNpm": true, + "nonNpmDescription": "Air Quality API v1", + "projects": [ + "https://developers.google.com/maps/documentation/air-quality" + ], + "dependencies": { + "@maxim_mazurok/gapi.client.airquality-v1": "latest" + }, + "devDependencies": { + "@types/gapi.client.airquality-v1": "workspace:." + }, + "owners": [ + { + "name": "Maxim Mazurok", + "githubUsername": "Maxim-Mazurok" + }, + { + "name": "Nick Amoscato", + "githubUsername": "namoscato" + }, + { + "name": "Declan Vong", + "githubUsername": "declanvong" + } + ] +} diff --git a/types/gapi.client.doubleclickbidmanager-v1.1/tsconfig.json b/types/gapi.client.airquality-v1/tsconfig.json similarity index 100% rename from types/gapi.client.doubleclickbidmanager-v1.1/tsconfig.json rename to types/gapi.client.airquality-v1/tsconfig.json diff --git a/types/gapi.client.gameservices-v1beta/.npmignore b/types/gapi.client.alloydb-v1/.npmignore similarity index 100% rename from types/gapi.client.gameservices-v1beta/.npmignore rename to types/gapi.client.alloydb-v1/.npmignore diff --git a/types/gapi.client.googleads-v5/index.d.ts b/types/gapi.client.alloydb-v1/index.d.ts similarity index 77% rename from types/gapi.client.googleads-v5/index.d.ts rename to types/gapi.client.alloydb-v1/index.d.ts index e3c21f18cea911..a51a3a725939fa 100644 --- a/types/gapi.client.googleads-v5/index.d.ts +++ b/types/gapi.client.alloydb-v1/index.d.ts @@ -1,4 +1,4 @@ // Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator // In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new -/// +/// diff --git a/types/gapi.client.poly-v1/package.json b/types/gapi.client.alloydb-v1/package.json similarity index 66% rename from types/gapi.client.poly-v1/package.json rename to types/gapi.client.alloydb-v1/package.json index 243d866a099976..4ec0f5efb95b5d 100644 --- a/types/gapi.client.poly-v1/package.json +++ b/types/gapi.client.alloydb-v1/package.json @@ -1,17 +1,17 @@ { "private": true, - "name": "@types/gapi.client.poly-v1", + "name": "@types/gapi.client.alloydb-v1", "version": "0.0.9999", "nonNpm": true, - "nonNpmDescription": "Poly API v1", + "nonNpmDescription": "AlloyDB API v1", "projects": [ - "https://developers.google.com/poly/" + "https://cloud.google.com/alloydb/" ], "dependencies": { - "@maxim_mazurok/gapi.client.poly-v1": "latest" + "@maxim_mazurok/gapi.client.alloydb-v1": "latest" }, "devDependencies": { - "@types/gapi.client.poly-v1": "workspace:." + "@types/gapi.client.alloydb-v1": "workspace:." }, "owners": [ { diff --git a/types/gapi.client.eventarc-v1beta1/tsconfig.json b/types/gapi.client.alloydb-v1/tsconfig.json similarity index 100% rename from types/gapi.client.eventarc-v1beta1/tsconfig.json rename to types/gapi.client.alloydb-v1/tsconfig.json diff --git a/types/gapi.client.genomics-v2alpha1/.npmignore b/types/gapi.client.alloydb-v1alpha/.npmignore similarity index 100% rename from types/gapi.client.genomics-v2alpha1/.npmignore rename to types/gapi.client.alloydb-v1alpha/.npmignore diff --git a/types/gapi.client.displayvideo-v1/index.d.ts b/types/gapi.client.alloydb-v1alpha/index.d.ts similarity index 78% rename from types/gapi.client.displayvideo-v1/index.d.ts rename to types/gapi.client.alloydb-v1alpha/index.d.ts index 4e9cbc79eb22b9..6b95fce4a0c042 100644 --- a/types/gapi.client.displayvideo-v1/index.d.ts +++ b/types/gapi.client.alloydb-v1alpha/index.d.ts @@ -1,4 +1,4 @@ // Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator // In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new -/// +/// diff --git a/types/gapi.client.googleads-v5/package.json b/types/gapi.client.alloydb-v1alpha/package.json similarity index 64% rename from types/gapi.client.googleads-v5/package.json rename to types/gapi.client.alloydb-v1alpha/package.json index 2653ba5a6b519e..96a526259693c1 100644 --- a/types/gapi.client.googleads-v5/package.json +++ b/types/gapi.client.alloydb-v1alpha/package.json @@ -1,17 +1,17 @@ { "private": true, - "name": "@types/gapi.client.googleads-v5", + "name": "@types/gapi.client.alloydb-v1alpha", "version": "0.0.9999", "nonNpm": true, - "nonNpmDescription": "Google Ads API v5", + "nonNpmDescription": "AlloyDB API v1alpha", "projects": [ - "https://developers.google.com/google-ads/api/" + "https://cloud.google.com/alloydb/" ], "dependencies": { - "@maxim_mazurok/gapi.client.googleads-v5": "latest" + "@maxim_mazurok/gapi.client.alloydb-v1alpha": "latest" }, "devDependencies": { - "@types/gapi.client.googleads-v5": "workspace:." + "@types/gapi.client.alloydb-v1alpha": "workspace:." }, "owners": [ { diff --git a/types/gapi.client.gameservices-v1/tsconfig.json b/types/gapi.client.alloydb-v1alpha/tsconfig.json similarity index 100% rename from types/gapi.client.gameservices-v1/tsconfig.json rename to types/gapi.client.alloydb-v1alpha/tsconfig.json diff --git a/types/gapi.client.gkehub-v1alpha2/.npmignore b/types/gapi.client.alloydb-v1beta/.npmignore similarity index 100% rename from types/gapi.client.gkehub-v1alpha2/.npmignore rename to types/gapi.client.alloydb-v1beta/.npmignore diff --git a/types/gapi.client.alloydb-v1beta/index.d.ts b/types/gapi.client.alloydb-v1beta/index.d.ts new file mode 100644 index 00000000000000..996d10e8682984 --- /dev/null +++ b/types/gapi.client.alloydb-v1beta/index.d.ts @@ -0,0 +1,4 @@ +// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator +// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new + +/// diff --git a/types/gapi.client.alloydb-v1beta/package.json b/types/gapi.client.alloydb-v1beta/package.json new file mode 100644 index 00000000000000..2fd5741416ca6b --- /dev/null +++ b/types/gapi.client.alloydb-v1beta/package.json @@ -0,0 +1,30 @@ +{ + "private": true, + "name": "@types/gapi.client.alloydb-v1beta", + "version": "0.0.9999", + "nonNpm": true, + "nonNpmDescription": "AlloyDB API v1beta", + "projects": [ + "https://cloud.google.com/alloydb/" + ], + "dependencies": { + "@maxim_mazurok/gapi.client.alloydb-v1beta": "latest" + }, + "devDependencies": { + "@types/gapi.client.alloydb-v1beta": "workspace:." + }, + "owners": [ + { + "name": "Maxim Mazurok", + "githubUsername": "Maxim-Mazurok" + }, + { + "name": "Nick Amoscato", + "githubUsername": "namoscato" + }, + { + "name": "Declan Vong", + "githubUsername": "declanvong" + } + ] +} diff --git a/types/gapi.client.gameservices-v1beta/tsconfig.json b/types/gapi.client.alloydb-v1beta/tsconfig.json similarity index 100% rename from types/gapi.client.gameservices-v1beta/tsconfig.json rename to types/gapi.client.alloydb-v1beta/tsconfig.json diff --git a/types/gapi.client.googleads-v10/.npmignore b/types/gapi.client.apim-v1alpha/.npmignore similarity index 100% rename from types/gapi.client.googleads-v10/.npmignore rename to types/gapi.client.apim-v1alpha/.npmignore diff --git a/types/gapi.client.googleads-v4/index.d.ts b/types/gapi.client.apim-v1alpha/index.d.ts similarity index 78% rename from types/gapi.client.googleads-v4/index.d.ts rename to types/gapi.client.apim-v1alpha/index.d.ts index 85d10c4aaa4c91..feebeafacbe496 100644 --- a/types/gapi.client.googleads-v4/index.d.ts +++ b/types/gapi.client.apim-v1alpha/index.d.ts @@ -1,4 +1,4 @@ // Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator // In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new -/// +/// diff --git a/types/gapi.client.apim-v1alpha/package.json b/types/gapi.client.apim-v1alpha/package.json new file mode 100644 index 00000000000000..db2d7c1575c8a3 --- /dev/null +++ b/types/gapi.client.apim-v1alpha/package.json @@ -0,0 +1,30 @@ +{ + "private": true, + "name": "@types/gapi.client.apim-v1alpha", + "version": "0.0.9999", + "nonNpm": true, + "nonNpmDescription": "API Management API v1alpha", + "projects": [ + "https://cloud.google.com/apigee/" + ], + "dependencies": { + "@maxim_mazurok/gapi.client.apim-v1alpha": "latest" + }, + "devDependencies": { + "@types/gapi.client.apim-v1alpha": "workspace:." + }, + "owners": [ + { + "name": "Maxim Mazurok", + "githubUsername": "Maxim-Mazurok" + }, + { + "name": "Nick Amoscato", + "githubUsername": "namoscato" + }, + { + "name": "Declan Vong", + "githubUsername": "declanvong" + } + ] +} diff --git a/types/gapi.client.genomics-v2alpha1/tsconfig.json b/types/gapi.client.apim-v1alpha/tsconfig.json similarity index 100% rename from types/gapi.client.genomics-v2alpha1/tsconfig.json rename to types/gapi.client.apim-v1alpha/tsconfig.json diff --git a/types/gapi.client.googleads-v11/.npmignore b/types/gapi.client.apphub-v1/.npmignore similarity index 100% rename from types/gapi.client.googleads-v11/.npmignore rename to types/gapi.client.apphub-v1/.npmignore diff --git a/types/gapi.client.googleads-v6/index.d.ts b/types/gapi.client.apphub-v1/index.d.ts similarity index 77% rename from types/gapi.client.googleads-v6/index.d.ts rename to types/gapi.client.apphub-v1/index.d.ts index c79c2f1c36056c..e9efa09a686c0a 100644 --- a/types/gapi.client.googleads-v6/index.d.ts +++ b/types/gapi.client.apphub-v1/index.d.ts @@ -1,4 +1,4 @@ // Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator // In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new -/// +/// diff --git a/types/gapi.client.apphub-v1/package.json b/types/gapi.client.apphub-v1/package.json new file mode 100644 index 00000000000000..f274d4fbb3fcd9 --- /dev/null +++ b/types/gapi.client.apphub-v1/package.json @@ -0,0 +1,30 @@ +{ + "private": true, + "name": "@types/gapi.client.apphub-v1", + "version": "0.0.9999", + "nonNpm": true, + "nonNpmDescription": "App Hub API v1", + "projects": [ + "https://cloud.google.com/app-hub/docs/" + ], + "dependencies": { + "@maxim_mazurok/gapi.client.apphub-v1": "latest" + }, + "devDependencies": { + "@types/gapi.client.apphub-v1": "workspace:." + }, + "owners": [ + { + "name": "Maxim Mazurok", + "githubUsername": "Maxim-Mazurok" + }, + { + "name": "Nick Amoscato", + "githubUsername": "namoscato" + }, + { + "name": "Declan Vong", + "githubUsername": "declanvong" + } + ] +} diff --git a/types/gapi.client.gkehub-v1alpha2/tsconfig.json b/types/gapi.client.apphub-v1/tsconfig.json similarity index 100% rename from types/gapi.client.gkehub-v1alpha2/tsconfig.json rename to types/gapi.client.apphub-v1/tsconfig.json diff --git a/types/gapi.client.googleads-v12/.npmignore b/types/gapi.client.apphub-v1alpha/.npmignore similarity index 100% rename from types/gapi.client.googleads-v12/.npmignore rename to types/gapi.client.apphub-v1alpha/.npmignore diff --git a/types/gapi.client.apphub-v1alpha/index.d.ts b/types/gapi.client.apphub-v1alpha/index.d.ts new file mode 100644 index 00000000000000..284e85b5d22ad7 --- /dev/null +++ b/types/gapi.client.apphub-v1alpha/index.d.ts @@ -0,0 +1,4 @@ +// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator +// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new + +/// diff --git a/types/gapi.client.googleads-v6/package.json b/types/gapi.client.apphub-v1alpha/package.json similarity index 64% rename from types/gapi.client.googleads-v6/package.json rename to types/gapi.client.apphub-v1alpha/package.json index c1f9c5e303a1b5..e08bfb0d234516 100644 --- a/types/gapi.client.googleads-v6/package.json +++ b/types/gapi.client.apphub-v1alpha/package.json @@ -1,17 +1,17 @@ { "private": true, - "name": "@types/gapi.client.googleads-v6", + "name": "@types/gapi.client.apphub-v1alpha", "version": "0.0.9999", "nonNpm": true, - "nonNpmDescription": "Google Ads API v6", + "nonNpmDescription": "App Hub API v1alpha", "projects": [ - "https://developers.google.com/google-ads/api/" + "https://cloud.google.com/app-hub/docs/" ], "dependencies": { - "@maxim_mazurok/gapi.client.googleads-v6": "latest" + "@maxim_mazurok/gapi.client.apphub-v1alpha": "latest" }, "devDependencies": { - "@types/gapi.client.googleads-v6": "workspace:." + "@types/gapi.client.apphub-v1alpha": "workspace:." }, "owners": [ { diff --git a/types/gapi.client.googleads-v10/tsconfig.json b/types/gapi.client.apphub-v1alpha/tsconfig.json similarity index 100% rename from types/gapi.client.googleads-v10/tsconfig.json rename to types/gapi.client.apphub-v1alpha/tsconfig.json diff --git a/types/gapi.client.googleads-v13/.npmignore b/types/gapi.client.backupdr-v1/.npmignore similarity index 100% rename from types/gapi.client.googleads-v13/.npmignore rename to types/gapi.client.backupdr-v1/.npmignore diff --git a/types/gapi.client.cloudiot-v1/index.d.ts b/types/gapi.client.backupdr-v1/index.d.ts similarity index 78% rename from types/gapi.client.cloudiot-v1/index.d.ts rename to types/gapi.client.backupdr-v1/index.d.ts index 1e2b9b761be5e2..2c80f8a87ca224 100644 --- a/types/gapi.client.cloudiot-v1/index.d.ts +++ b/types/gapi.client.backupdr-v1/index.d.ts @@ -1,4 +1,4 @@ // Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator // In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new -/// +/// diff --git a/types/gapi.client.backupdr-v1/package.json b/types/gapi.client.backupdr-v1/package.json new file mode 100644 index 00000000000000..e90ef55e90500d --- /dev/null +++ b/types/gapi.client.backupdr-v1/package.json @@ -0,0 +1,30 @@ +{ + "private": true, + "name": "@types/gapi.client.backupdr-v1", + "version": "0.0.9999", + "nonNpm": true, + "nonNpmDescription": "Backup and DR Service API v1", + "projects": [ + "https://cloud.google.com/backup-disaster-recovery" + ], + "dependencies": { + "@maxim_mazurok/gapi.client.backupdr-v1": "latest" + }, + "devDependencies": { + "@types/gapi.client.backupdr-v1": "workspace:." + }, + "owners": [ + { + "name": "Maxim Mazurok", + "githubUsername": "Maxim-Mazurok" + }, + { + "name": "Nick Amoscato", + "githubUsername": "namoscato" + }, + { + "name": "Declan Vong", + "githubUsername": "declanvong" + } + ] +} diff --git a/types/gapi.client.googleads-v11/tsconfig.json b/types/gapi.client.backupdr-v1/tsconfig.json similarity index 100% rename from types/gapi.client.googleads-v11/tsconfig.json rename to types/gapi.client.backupdr-v1/tsconfig.json diff --git a/types/gapi.client.googleads-v4/.npmignore b/types/gapi.client.biglake-v1/.npmignore similarity index 100% rename from types/gapi.client.googleads-v4/.npmignore rename to types/gapi.client.biglake-v1/.npmignore diff --git a/types/gapi.client.biglake-v1/index.d.ts b/types/gapi.client.biglake-v1/index.d.ts new file mode 100644 index 00000000000000..9d4204632ac53c --- /dev/null +++ b/types/gapi.client.biglake-v1/index.d.ts @@ -0,0 +1,4 @@ +// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator +// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new + +/// diff --git a/types/gapi.client.biglake-v1/package.json b/types/gapi.client.biglake-v1/package.json new file mode 100644 index 00000000000000..03acd743e0f839 --- /dev/null +++ b/types/gapi.client.biglake-v1/package.json @@ -0,0 +1,30 @@ +{ + "private": true, + "name": "@types/gapi.client.biglake-v1", + "version": "0.0.9999", + "nonNpm": true, + "nonNpmDescription": "BigLake API v1", + "projects": [ + "https://cloud.google.com/bigquery/" + ], + "dependencies": { + "@maxim_mazurok/gapi.client.biglake-v1": "latest" + }, + "devDependencies": { + "@types/gapi.client.biglake-v1": "workspace:." + }, + "owners": [ + { + "name": "Maxim Mazurok", + "githubUsername": "Maxim-Mazurok" + }, + { + "name": "Nick Amoscato", + "githubUsername": "namoscato" + }, + { + "name": "Declan Vong", + "githubUsername": "declanvong" + } + ] +} diff --git a/types/gapi.client.googleads-v12/tsconfig.json b/types/gapi.client.biglake-v1/tsconfig.json similarity index 100% rename from types/gapi.client.googleads-v12/tsconfig.json rename to types/gapi.client.biglake-v1/tsconfig.json diff --git a/types/gapi.client.googleads-v5/.npmignore b/types/gapi.client.bigqueryconnection-v1/.npmignore similarity index 100% rename from types/gapi.client.googleads-v5/.npmignore rename to types/gapi.client.bigqueryconnection-v1/.npmignore diff --git a/types/gapi.client.bigqueryconnection-v1/index.d.ts b/types/gapi.client.bigqueryconnection-v1/index.d.ts new file mode 100644 index 00000000000000..fd6717bd3618fa --- /dev/null +++ b/types/gapi.client.bigqueryconnection-v1/index.d.ts @@ -0,0 +1,4 @@ +// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator +// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new + +/// diff --git a/types/gapi.client.bigqueryconnection-v1/package.json b/types/gapi.client.bigqueryconnection-v1/package.json new file mode 100644 index 00000000000000..34fb32cd97fe36 --- /dev/null +++ b/types/gapi.client.bigqueryconnection-v1/package.json @@ -0,0 +1,30 @@ +{ + "private": true, + "name": "@types/gapi.client.bigqueryconnection-v1", + "version": "0.0.9999", + "nonNpm": true, + "nonNpmDescription": "BigQuery Connection API v1", + "projects": [ + "https://cloud.google.com/bigquery/docs/connections-api-intro" + ], + "dependencies": { + "@maxim_mazurok/gapi.client.bigqueryconnection-v1": "latest" + }, + "devDependencies": { + "@types/gapi.client.bigqueryconnection-v1": "workspace:." + }, + "owners": [ + { + "name": "Maxim Mazurok", + "githubUsername": "Maxim-Mazurok" + }, + { + "name": "Nick Amoscato", + "githubUsername": "namoscato" + }, + { + "name": "Declan Vong", + "githubUsername": "declanvong" + } + ] +} diff --git a/types/gapi.client.googleads-v13/tsconfig.json b/types/gapi.client.bigqueryconnection-v1/tsconfig.json similarity index 100% rename from types/gapi.client.googleads-v13/tsconfig.json rename to types/gapi.client.bigqueryconnection-v1/tsconfig.json diff --git a/types/gapi.client.bigqueryconnection-v1beta1/package.json b/types/gapi.client.bigqueryconnection-v1beta1/package.json index a74238c075ad4b..89f01e97d23749 100644 --- a/types/gapi.client.bigqueryconnection-v1beta1/package.json +++ b/types/gapi.client.bigqueryconnection-v1beta1/package.json @@ -5,7 +5,7 @@ "nonNpm": true, "nonNpmDescription": "BigQuery Connection API v1beta1", "projects": [ - "https://cloud.google.com/bigquery/" + "https://cloud.google.com/bigquery/docs/connections-api-intro" ], "dependencies": { "@maxim_mazurok/gapi.client.bigqueryconnection-v1beta1": "latest" diff --git a/types/gapi.client.googleads-v6/.npmignore b/types/gapi.client.bigquerydatapolicy-v1/.npmignore similarity index 100% rename from types/gapi.client.googleads-v6/.npmignore rename to types/gapi.client.bigquerydatapolicy-v1/.npmignore diff --git a/types/gapi.client.bigquerydatapolicy-v1/index.d.ts b/types/gapi.client.bigquerydatapolicy-v1/index.d.ts new file mode 100644 index 00000000000000..67a8685768bf3b --- /dev/null +++ b/types/gapi.client.bigquerydatapolicy-v1/index.d.ts @@ -0,0 +1,4 @@ +// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator +// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new + +/// diff --git a/types/gapi.client.bigquerydatapolicy-v1/package.json b/types/gapi.client.bigquerydatapolicy-v1/package.json new file mode 100644 index 00000000000000..b96c320fac7d74 --- /dev/null +++ b/types/gapi.client.bigquerydatapolicy-v1/package.json @@ -0,0 +1,30 @@ +{ + "private": true, + "name": "@types/gapi.client.bigquerydatapolicy-v1", + "version": "0.0.9999", + "nonNpm": true, + "nonNpmDescription": "BigQuery Data Policy API v1", + "projects": [ + "https://cloud.google.com/bigquery/docs/column-data-masking" + ], + "dependencies": { + "@maxim_mazurok/gapi.client.bigquerydatapolicy-v1": "latest" + }, + "devDependencies": { + "@types/gapi.client.bigquerydatapolicy-v1": "workspace:." + }, + "owners": [ + { + "name": "Maxim Mazurok", + "githubUsername": "Maxim-Mazurok" + }, + { + "name": "Nick Amoscato", + "githubUsername": "namoscato" + }, + { + "name": "Declan Vong", + "githubUsername": "declanvong" + } + ] +} diff --git a/types/gapi.client.googleads-v4/tsconfig.json b/types/gapi.client.bigquerydatapolicy-v1/tsconfig.json similarity index 100% rename from types/gapi.client.googleads-v4/tsconfig.json rename to types/gapi.client.bigquerydatapolicy-v1/tsconfig.json diff --git a/types/gapi.client.googleads-v7/.npmignore b/types/gapi.client.blockchainnodeengine-v1/.npmignore similarity index 100% rename from types/gapi.client.googleads-v7/.npmignore rename to types/gapi.client.blockchainnodeengine-v1/.npmignore diff --git a/types/gapi.client.blockchainnodeengine-v1/index.d.ts b/types/gapi.client.blockchainnodeengine-v1/index.d.ts new file mode 100644 index 00000000000000..4192141afc9953 --- /dev/null +++ b/types/gapi.client.blockchainnodeengine-v1/index.d.ts @@ -0,0 +1,4 @@ +// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator +// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new + +/// diff --git a/types/gapi.client.blockchainnodeengine-v1/package.json b/types/gapi.client.blockchainnodeengine-v1/package.json new file mode 100644 index 00000000000000..5d324e48fae7ec --- /dev/null +++ b/types/gapi.client.blockchainnodeengine-v1/package.json @@ -0,0 +1,30 @@ +{ + "private": true, + "name": "@types/gapi.client.blockchainnodeengine-v1", + "version": "0.0.9999", + "nonNpm": true, + "nonNpmDescription": "Blockchain Node Engine API v1", + "projects": [ + "https://cloud.google.com/blockchain-node-engine" + ], + "dependencies": { + "@maxim_mazurok/gapi.client.blockchainnodeengine-v1": "latest" + }, + "devDependencies": { + "@types/gapi.client.blockchainnodeengine-v1": "workspace:." + }, + "owners": [ + { + "name": "Maxim Mazurok", + "githubUsername": "Maxim-Mazurok" + }, + { + "name": "Nick Amoscato", + "githubUsername": "namoscato" + }, + { + "name": "Declan Vong", + "githubUsername": "declanvong" + } + ] +} diff --git a/types/gapi.client.googleads-v5/tsconfig.json b/types/gapi.client.blockchainnodeengine-v1/tsconfig.json similarity index 100% rename from types/gapi.client.googleads-v5/tsconfig.json rename to types/gapi.client.blockchainnodeengine-v1/tsconfig.json diff --git a/types/gapi.client.googleads-v8/.npmignore b/types/gapi.client.checks-v1alpha/.npmignore similarity index 100% rename from types/gapi.client.googleads-v8/.npmignore rename to types/gapi.client.checks-v1alpha/.npmignore diff --git a/types/gapi.client.checks-v1alpha/index.d.ts b/types/gapi.client.checks-v1alpha/index.d.ts new file mode 100644 index 00000000000000..69ff4d173c8588 --- /dev/null +++ b/types/gapi.client.checks-v1alpha/index.d.ts @@ -0,0 +1,4 @@ +// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator +// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new + +/// diff --git a/types/gapi.client.checks-v1alpha/package.json b/types/gapi.client.checks-v1alpha/package.json new file mode 100644 index 00000000000000..e3721d33150bc2 --- /dev/null +++ b/types/gapi.client.checks-v1alpha/package.json @@ -0,0 +1,30 @@ +{ + "private": true, + "name": "@types/gapi.client.checks-v1alpha", + "version": "0.0.9999", + "nonNpm": true, + "nonNpmDescription": "Checks API v1alpha", + "projects": [ + "https://developers.google.com/checks" + ], + "dependencies": { + "@maxim_mazurok/gapi.client.checks-v1alpha": "latest" + }, + "devDependencies": { + "@types/gapi.client.checks-v1alpha": "workspace:." + }, + "owners": [ + { + "name": "Maxim Mazurok", + "githubUsername": "Maxim-Mazurok" + }, + { + "name": "Nick Amoscato", + "githubUsername": "namoscato" + }, + { + "name": "Declan Vong", + "githubUsername": "declanvong" + } + ] +} diff --git a/types/gapi.client.googleads-v6/tsconfig.json b/types/gapi.client.checks-v1alpha/tsconfig.json similarity index 100% rename from types/gapi.client.googleads-v6/tsconfig.json rename to types/gapi.client.checks-v1alpha/tsconfig.json diff --git a/types/gapi.client.cloudbilling-v1/package.json b/types/gapi.client.cloudbilling-v1/package.json index 5bb1851321e1b3..03f5308201d959 100644 --- a/types/gapi.client.cloudbilling-v1/package.json +++ b/types/gapi.client.cloudbilling-v1/package.json @@ -5,7 +5,7 @@ "nonNpm": true, "nonNpmDescription": "Cloud Billing API v1", "projects": [ - "https://cloud.google.com/billing/" + "https://cloud.google.com/billing/docs/apis" ], "dependencies": { "@maxim_mazurok/gapi.client.cloudbilling-v1": "latest" diff --git a/types/gapi.client.cloudbilling-v1beta/package.json b/types/gapi.client.cloudbilling-v1beta/package.json index 96fa0039682a6f..30e8edb18cca0b 100644 --- a/types/gapi.client.cloudbilling-v1beta/package.json +++ b/types/gapi.client.cloudbilling-v1beta/package.json @@ -5,7 +5,7 @@ "nonNpm": true, "nonNpmDescription": "Cloud Billing API v1beta", "projects": [ - "https://cloud.google.com/billing/" + "https://cloud.google.com/billing/docs/apis" ], "dependencies": { "@maxim_mazurok/gapi.client.cloudbilling-v1beta": "latest" diff --git a/types/gapi.client.googleads-v9/.npmignore b/types/gapi.client.cloudbuild-v2/.npmignore similarity index 100% rename from types/gapi.client.googleads-v9/.npmignore rename to types/gapi.client.cloudbuild-v2/.npmignore diff --git a/types/gapi.client.googleads-v11/index.d.ts b/types/gapi.client.cloudbuild-v2/index.d.ts similarity index 78% rename from types/gapi.client.googleads-v11/index.d.ts rename to types/gapi.client.cloudbuild-v2/index.d.ts index 71835ca3e129bf..a646b0d327e9cc 100644 --- a/types/gapi.client.googleads-v11/index.d.ts +++ b/types/gapi.client.cloudbuild-v2/index.d.ts @@ -1,4 +1,4 @@ // Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator // In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new -/// +/// diff --git a/types/gapi.client.cloudbuild-v2/package.json b/types/gapi.client.cloudbuild-v2/package.json new file mode 100644 index 00000000000000..9232851de12462 --- /dev/null +++ b/types/gapi.client.cloudbuild-v2/package.json @@ -0,0 +1,30 @@ +{ + "private": true, + "name": "@types/gapi.client.cloudbuild-v2", + "version": "0.0.9999", + "nonNpm": true, + "nonNpmDescription": "Cloud Build API v2", + "projects": [ + "https://cloud.google.com/cloud-build/docs/" + ], + "dependencies": { + "@maxim_mazurok/gapi.client.cloudbuild-v2": "latest" + }, + "devDependencies": { + "@types/gapi.client.cloudbuild-v2": "workspace:." + }, + "owners": [ + { + "name": "Maxim Mazurok", + "githubUsername": "Maxim-Mazurok" + }, + { + "name": "Nick Amoscato", + "githubUsername": "namoscato" + }, + { + "name": "Declan Vong", + "githubUsername": "declanvong" + } + ] +} diff --git a/types/gapi.client.googleads-v7/tsconfig.json b/types/gapi.client.cloudbuild-v2/tsconfig.json similarity index 100% rename from types/gapi.client.googleads-v7/tsconfig.json rename to types/gapi.client.cloudbuild-v2/tsconfig.json diff --git a/types/gapi.client.integrations-v1alpha/.npmignore b/types/gapi.client.cloudcontrolspartner-v1/.npmignore similarity index 100% rename from types/gapi.client.integrations-v1alpha/.npmignore rename to types/gapi.client.cloudcontrolspartner-v1/.npmignore diff --git a/types/gapi.client.cloudcontrolspartner-v1/index.d.ts b/types/gapi.client.cloudcontrolspartner-v1/index.d.ts new file mode 100644 index 00000000000000..457b71a0a48e0d --- /dev/null +++ b/types/gapi.client.cloudcontrolspartner-v1/index.d.ts @@ -0,0 +1,4 @@ +// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator +// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new + +/// diff --git a/types/gapi.client.realtimebidding-v1alpha/package.json b/types/gapi.client.cloudcontrolspartner-v1/package.json similarity index 58% rename from types/gapi.client.realtimebidding-v1alpha/package.json rename to types/gapi.client.cloudcontrolspartner-v1/package.json index 36e82f4dec1b29..4c79b7f82e8f65 100644 --- a/types/gapi.client.realtimebidding-v1alpha/package.json +++ b/types/gapi.client.cloudcontrolspartner-v1/package.json @@ -1,17 +1,17 @@ { "private": true, - "name": "@types/gapi.client.realtimebidding-v1alpha", + "name": "@types/gapi.client.cloudcontrolspartner-v1", "version": "0.0.9999", "nonNpm": true, - "nonNpmDescription": "Real-time Bidding API v1alpha", + "nonNpmDescription": "Cloud Controls Partner API v1", "projects": [ - "https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/" + "https://cloud.google.com/sovereign-controls-by-partners/docs/sovereign-partners/reference/rest" ], "dependencies": { - "@maxim_mazurok/gapi.client.realtimebidding-v1alpha": "latest" + "@maxim_mazurok/gapi.client.cloudcontrolspartner-v1": "latest" }, "devDependencies": { - "@types/gapi.client.realtimebidding-v1alpha": "workspace:." + "@types/gapi.client.cloudcontrolspartner-v1": "workspace:." }, "owners": [ { diff --git a/types/gapi.client.googleads-v8/tsconfig.json b/types/gapi.client.cloudcontrolspartner-v1/tsconfig.json similarity index 100% rename from types/gapi.client.googleads-v8/tsconfig.json rename to types/gapi.client.cloudcontrolspartner-v1/tsconfig.json diff --git a/types/gapi.client.mybusinessbusinesscalls-v1/.npmignore b/types/gapi.client.cloudcontrolspartner-v1beta/.npmignore similarity index 100% rename from types/gapi.client.mybusinessbusinesscalls-v1/.npmignore rename to types/gapi.client.cloudcontrolspartner-v1beta/.npmignore diff --git a/types/gapi.client.accesscontextmanager-v1beta/index.d.ts b/types/gapi.client.cloudcontrolspartner-v1beta/index.d.ts similarity index 74% rename from types/gapi.client.accesscontextmanager-v1beta/index.d.ts rename to types/gapi.client.cloudcontrolspartner-v1beta/index.d.ts index d6e6d187be354c..88ab973acb308a 100644 --- a/types/gapi.client.accesscontextmanager-v1beta/index.d.ts +++ b/types/gapi.client.cloudcontrolspartner-v1beta/index.d.ts @@ -1,4 +1,4 @@ // Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator // In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new -/// +/// diff --git a/types/gapi.client.cloudcontrolspartner-v1beta/package.json b/types/gapi.client.cloudcontrolspartner-v1beta/package.json new file mode 100644 index 00000000000000..b0dd9d8f3bf89a --- /dev/null +++ b/types/gapi.client.cloudcontrolspartner-v1beta/package.json @@ -0,0 +1,30 @@ +{ + "private": true, + "name": "@types/gapi.client.cloudcontrolspartner-v1beta", + "version": "0.0.9999", + "nonNpm": true, + "nonNpmDescription": "Cloud Controls Partner API v1beta", + "projects": [ + "https://cloud.google.com/sovereign-controls-by-partners/docs/sovereign-partners/reference/rest" + ], + "dependencies": { + "@maxim_mazurok/gapi.client.cloudcontrolspartner-v1beta": "latest" + }, + "devDependencies": { + "@types/gapi.client.cloudcontrolspartner-v1beta": "workspace:." + }, + "owners": [ + { + "name": "Maxim Mazurok", + "githubUsername": "Maxim-Mazurok" + }, + { + "name": "Nick Amoscato", + "githubUsername": "namoscato" + }, + { + "name": "Declan Vong", + "githubUsername": "declanvong" + } + ] +} diff --git a/types/gapi.client.googleads-v9/tsconfig.json b/types/gapi.client.cloudcontrolspartner-v1beta/tsconfig.json similarity index 100% rename from types/gapi.client.googleads-v9/tsconfig.json rename to types/gapi.client.cloudcontrolspartner-v1beta/tsconfig.json diff --git a/types/gapi.client.clouddeploy-v1/package.json b/types/gapi.client.clouddeploy-v1/package.json index 713de05e0764a1..d2ec2faa48aa59 100644 --- a/types/gapi.client.clouddeploy-v1/package.json +++ b/types/gapi.client.clouddeploy-v1/package.json @@ -3,7 +3,7 @@ "name": "@types/gapi.client.clouddeploy-v1", "version": "0.0.9999", "nonNpm": true, - "nonNpmDescription": "Google Cloud Deploy API v1", + "nonNpmDescription": "Cloud Deploy API v1", "projects": [ "https://cloud.google.com/deploy/" ], diff --git a/types/gapi.client.poly-v1/.npmignore b/types/gapi.client.cloudsupport-v2/.npmignore similarity index 100% rename from types/gapi.client.poly-v1/.npmignore rename to types/gapi.client.cloudsupport-v2/.npmignore diff --git a/types/gapi.client.gameservices-v1/index.d.ts b/types/gapi.client.cloudsupport-v2/index.d.ts similarity index 78% rename from types/gapi.client.gameservices-v1/index.d.ts rename to types/gapi.client.cloudsupport-v2/index.d.ts index b299d91a83d581..be5f54b1ef0257 100644 --- a/types/gapi.client.gameservices-v1/index.d.ts +++ b/types/gapi.client.cloudsupport-v2/index.d.ts @@ -1,4 +1,4 @@ // Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator // In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new -/// +/// diff --git a/types/gapi.client.cloudsupport-v2/package.json b/types/gapi.client.cloudsupport-v2/package.json new file mode 100644 index 00000000000000..f026f1320166c1 --- /dev/null +++ b/types/gapi.client.cloudsupport-v2/package.json @@ -0,0 +1,30 @@ +{ + "private": true, + "name": "@types/gapi.client.cloudsupport-v2", + "version": "0.0.9999", + "nonNpm": true, + "nonNpmDescription": "Google Cloud Support API v2", + "projects": [ + "https://cloud.google.com/support/docs/apis" + ], + "dependencies": { + "@maxim_mazurok/gapi.client.cloudsupport-v2": "latest" + }, + "devDependencies": { + "@types/gapi.client.cloudsupport-v2": "workspace:." + }, + "owners": [ + { + "name": "Maxim Mazurok", + "githubUsername": "Maxim-Mazurok" + }, + { + "name": "Nick Amoscato", + "githubUsername": "namoscato" + }, + { + "name": "Declan Vong", + "githubUsername": "declanvong" + } + ] +} diff --git a/types/gapi.client.integrations-v1alpha/tsconfig.json b/types/gapi.client.cloudsupport-v2/tsconfig.json similarity index 100% rename from types/gapi.client.integrations-v1alpha/tsconfig.json rename to types/gapi.client.cloudsupport-v2/tsconfig.json diff --git a/types/gapi.client.realtimebidding-v1alpha/.npmignore b/types/gapi.client.config-v1/.npmignore similarity index 100% rename from types/gapi.client.realtimebidding-v1alpha/.npmignore rename to types/gapi.client.config-v1/.npmignore diff --git a/types/gapi.client.config-v1/index.d.ts b/types/gapi.client.config-v1/index.d.ts new file mode 100644 index 00000000000000..bc7d9efaf3317a --- /dev/null +++ b/types/gapi.client.config-v1/index.d.ts @@ -0,0 +1,4 @@ +// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator +// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new + +/// diff --git a/types/gapi.client.config-v1/package.json b/types/gapi.client.config-v1/package.json new file mode 100644 index 00000000000000..034b8b16604018 --- /dev/null +++ b/types/gapi.client.config-v1/package.json @@ -0,0 +1,30 @@ +{ + "private": true, + "name": "@types/gapi.client.config-v1", + "version": "0.0.9999", + "nonNpm": true, + "nonNpmDescription": "Infrastructure Manager API v1", + "projects": [ + "https://cloud.google.com/infrastructure-manager/docs" + ], + "dependencies": { + "@maxim_mazurok/gapi.client.config-v1": "latest" + }, + "devDependencies": { + "@types/gapi.client.config-v1": "workspace:." + }, + "owners": [ + { + "name": "Maxim Mazurok", + "githubUsername": "Maxim-Mazurok" + }, + { + "name": "Nick Amoscato", + "githubUsername": "namoscato" + }, + { + "name": "Declan Vong", + "githubUsername": "declanvong" + } + ] +} diff --git a/types/gapi.client.mybusinessbusinesscalls-v1/tsconfig.json b/types/gapi.client.config-v1/tsconfig.json similarity index 100% rename from types/gapi.client.mybusinessbusinesscalls-v1/tsconfig.json rename to types/gapi.client.config-v1/tsconfig.json diff --git a/types/gapi.client.sourcerepo-v1/.npmignore b/types/gapi.client.dataportability-v1/.npmignore similarity index 100% rename from types/gapi.client.sourcerepo-v1/.npmignore rename to types/gapi.client.dataportability-v1/.npmignore diff --git a/types/gapi.client.dataportability-v1/index.d.ts b/types/gapi.client.dataportability-v1/index.d.ts new file mode 100644 index 00000000000000..c3da982b6203ef --- /dev/null +++ b/types/gapi.client.dataportability-v1/index.d.ts @@ -0,0 +1,4 @@ +// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator +// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new + +/// diff --git a/types/gapi.client.dataportability-v1/package.json b/types/gapi.client.dataportability-v1/package.json new file mode 100644 index 00000000000000..4515494e558c6b --- /dev/null +++ b/types/gapi.client.dataportability-v1/package.json @@ -0,0 +1,30 @@ +{ + "private": true, + "name": "@types/gapi.client.dataportability-v1", + "version": "0.0.9999", + "nonNpm": true, + "nonNpmDescription": "Data Portability API v1", + "projects": [ + "https://developers.google.com/data-portability" + ], + "dependencies": { + "@maxim_mazurok/gapi.client.dataportability-v1": "latest" + }, + "devDependencies": { + "@types/gapi.client.dataportability-v1": "workspace:." + }, + "owners": [ + { + "name": "Maxim Mazurok", + "githubUsername": "Maxim-Mazurok" + }, + { + "name": "Nick Amoscato", + "githubUsername": "namoscato" + }, + { + "name": "Declan Vong", + "githubUsername": "declanvong" + } + ] +} diff --git a/types/gapi.client.poly-v1/tsconfig.json b/types/gapi.client.dataportability-v1/tsconfig.json similarity index 100% rename from types/gapi.client.poly-v1/tsconfig.json rename to types/gapi.client.dataportability-v1/tsconfig.json diff --git a/types/hyphenate-style-name/.npmignore b/types/gapi.client.dataportability-v1beta/.npmignore similarity index 100% rename from types/hyphenate-style-name/.npmignore rename to types/gapi.client.dataportability-v1beta/.npmignore diff --git a/types/gapi.client.dataportability-v1beta/index.d.ts b/types/gapi.client.dataportability-v1beta/index.d.ts new file mode 100644 index 00000000000000..ac7cb91bd46f9e --- /dev/null +++ b/types/gapi.client.dataportability-v1beta/index.d.ts @@ -0,0 +1,4 @@ +// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator +// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new + +/// diff --git a/types/gapi.client.dataportability-v1beta/package.json b/types/gapi.client.dataportability-v1beta/package.json new file mode 100644 index 00000000000000..db1803d3505400 --- /dev/null +++ b/types/gapi.client.dataportability-v1beta/package.json @@ -0,0 +1,30 @@ +{ + "private": true, + "name": "@types/gapi.client.dataportability-v1beta", + "version": "0.0.9999", + "nonNpm": true, + "nonNpmDescription": "Data Portability API v1beta", + "projects": [ + "https://developers.google.com/data-portability" + ], + "dependencies": { + "@maxim_mazurok/gapi.client.dataportability-v1beta": "latest" + }, + "devDependencies": { + "@types/gapi.client.dataportability-v1beta": "workspace:." + }, + "owners": [ + { + "name": "Maxim Mazurok", + "githubUsername": "Maxim-Mazurok" + }, + { + "name": "Nick Amoscato", + "githubUsername": "namoscato" + }, + { + "name": "Declan Vong", + "githubUsername": "declanvong" + } + ] +} diff --git a/types/gapi.client.realtimebidding-v1alpha/tsconfig.json b/types/gapi.client.dataportability-v1beta/tsconfig.json similarity index 100% rename from types/gapi.client.realtimebidding-v1alpha/tsconfig.json rename to types/gapi.client.dataportability-v1beta/tsconfig.json diff --git a/types/react-datepicker/.npmignore b/types/gapi.client.developerconnect-v1/.npmignore similarity index 100% rename from types/react-datepicker/.npmignore rename to types/gapi.client.developerconnect-v1/.npmignore diff --git a/types/gapi.client.developerconnect-v1/index.d.ts b/types/gapi.client.developerconnect-v1/index.d.ts new file mode 100644 index 00000000000000..9a5df175fd11ee --- /dev/null +++ b/types/gapi.client.developerconnect-v1/index.d.ts @@ -0,0 +1,4 @@ +// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator +// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new + +/// diff --git a/types/gapi.client.gameservices-v1beta/package.json b/types/gapi.client.developerconnect-v1/package.json similarity index 61% rename from types/gapi.client.gameservices-v1beta/package.json rename to types/gapi.client.developerconnect-v1/package.json index 4994d51da4744c..1b154eeef2ff41 100644 --- a/types/gapi.client.gameservices-v1beta/package.json +++ b/types/gapi.client.developerconnect-v1/package.json @@ -1,17 +1,17 @@ { "private": true, - "name": "@types/gapi.client.gameservices-v1beta", + "name": "@types/gapi.client.developerconnect-v1", "version": "0.0.9999", "nonNpm": true, - "nonNpmDescription": "Game Services API v1beta", + "nonNpmDescription": "Developer Connect API v1", "projects": [ - "https://cloud.google.com/solutions/gaming/" + "http://cloud.google.com/developer-connect/docs/overview" ], "dependencies": { - "@maxim_mazurok/gapi.client.gameservices-v1beta": "latest" + "@maxim_mazurok/gapi.client.developerconnect-v1": "latest" }, "devDependencies": { - "@types/gapi.client.gameservices-v1beta": "workspace:." + "@types/gapi.client.developerconnect-v1": "workspace:." }, "owners": [ { diff --git a/types/gapi.client.sourcerepo-v1/tsconfig.json b/types/gapi.client.developerconnect-v1/tsconfig.json similarity index 100% rename from types/gapi.client.sourcerepo-v1/tsconfig.json rename to types/gapi.client.developerconnect-v1/tsconfig.json diff --git a/types/streamtest/.npmignore b/types/gapi.client.discoveryengine-v1/.npmignore similarity index 100% rename from types/streamtest/.npmignore rename to types/gapi.client.discoveryengine-v1/.npmignore diff --git a/types/gapi.client.discoveryengine-v1/index.d.ts b/types/gapi.client.discoveryengine-v1/index.d.ts new file mode 100644 index 00000000000000..2b8657904cb61c --- /dev/null +++ b/types/gapi.client.discoveryengine-v1/index.d.ts @@ -0,0 +1,4 @@ +// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator +// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new + +/// diff --git a/types/gapi.client.discoveryengine-v1/package.json b/types/gapi.client.discoveryengine-v1/package.json new file mode 100644 index 00000000000000..95a5ccadc6bba1 --- /dev/null +++ b/types/gapi.client.discoveryengine-v1/package.json @@ -0,0 +1,30 @@ +{ + "private": true, + "name": "@types/gapi.client.discoveryengine-v1", + "version": "0.0.9999", + "nonNpm": true, + "nonNpmDescription": "Discovery Engine API v1", + "projects": [ + "https://cloud.google.com/discovery-engine/docs" + ], + "dependencies": { + "@maxim_mazurok/gapi.client.discoveryengine-v1": "latest" + }, + "devDependencies": { + "@types/gapi.client.discoveryengine-v1": "workspace:." + }, + "owners": [ + { + "name": "Maxim Mazurok", + "githubUsername": "Maxim-Mazurok" + }, + { + "name": "Nick Amoscato", + "githubUsername": "namoscato" + }, + { + "name": "Declan Vong", + "githubUsername": "declanvong" + } + ] +} diff --git a/types/ttf2woff2/tsconfig.json b/types/gapi.client.discoveryengine-v1/tsconfig.json similarity index 73% rename from types/ttf2woff2/tsconfig.json rename to types/gapi.client.discoveryengine-v1/tsconfig.json index 1e994e706c2e1c..0a036c4d046ec9 100644 --- a/types/ttf2woff2/tsconfig.json +++ b/types/gapi.client.discoveryengine-v1/tsconfig.json @@ -7,13 +7,12 @@ "noImplicitAny": true, "noImplicitThis": true, "strictNullChecks": true, - "types": [], + "strictFunctionTypes": true, "noEmit": true, "forceConsistentCasingInFileNames": true, - "strictFunctionTypes": true + "types": [] }, "files": [ - "index.d.ts", - "ttf2woff2-tests.ts" + "index.d.ts" ] } diff --git a/types/ttf2woff2/.npmignore b/types/gapi.client.displayvideo-v3/.npmignore similarity index 100% rename from types/ttf2woff2/.npmignore rename to types/gapi.client.displayvideo-v3/.npmignore diff --git a/types/gapi.client.gkehub-v1alpha2/index.d.ts b/types/gapi.client.displayvideo-v3/index.d.ts similarity index 78% rename from types/gapi.client.gkehub-v1alpha2/index.d.ts rename to types/gapi.client.displayvideo-v3/index.d.ts index 3656623ae5d6fa..4d7c70f6648fe1 100644 --- a/types/gapi.client.gkehub-v1alpha2/index.d.ts +++ b/types/gapi.client.displayvideo-v3/index.d.ts @@ -1,4 +1,4 @@ // Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator // In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new -/// +/// diff --git a/types/gapi.client.displayvideo-v1/package.json b/types/gapi.client.displayvideo-v3/package.json similarity index 70% rename from types/gapi.client.displayvideo-v1/package.json rename to types/gapi.client.displayvideo-v3/package.json index 21b83ac64088c6..95d5a2c9d9351f 100644 --- a/types/gapi.client.displayvideo-v1/package.json +++ b/types/gapi.client.displayvideo-v3/package.json @@ -1,17 +1,17 @@ { "private": true, - "name": "@types/gapi.client.displayvideo-v1", + "name": "@types/gapi.client.displayvideo-v3", "version": "0.0.9999", "nonNpm": true, - "nonNpmDescription": "Display & Video 360 API v1", + "nonNpmDescription": "Display & Video 360 API v3", "projects": [ "https://developers.google.com/display-video/" ], "dependencies": { - "@maxim_mazurok/gapi.client.displayvideo-v1": "latest" + "@maxim_mazurok/gapi.client.displayvideo-v3": "latest" }, "devDependencies": { - "@types/gapi.client.displayvideo-v1": "workspace:." + "@types/gapi.client.displayvideo-v3": "workspace:." }, "owners": [ { diff --git a/types/gapi.client.displayvideo-v3/tsconfig.json b/types/gapi.client.displayvideo-v3/tsconfig.json new file mode 100644 index 00000000000000..0a036c4d046ec9 --- /dev/null +++ b/types/gapi.client.displayvideo-v3/tsconfig.json @@ -0,0 +1,18 @@ +{ + "compilerOptions": { + "module": "node16", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "types": [] + }, + "files": [ + "index.d.ts" + ] +} diff --git a/types/gapi.client.dlp-v2/package.json b/types/gapi.client.dlp-v2/package.json index dd484df7b2f533..17058d4052c6f6 100644 --- a/types/gapi.client.dlp-v2/package.json +++ b/types/gapi.client.dlp-v2/package.json @@ -3,9 +3,9 @@ "name": "@types/gapi.client.dlp-v2", "version": "0.0.9999", "nonNpm": true, - "nonNpmDescription": "Cloud Data Loss Prevention (DLP) API v2", + "nonNpmDescription": "Sensitive Data Protection (DLP) v2", "projects": [ - "https://cloud.google.com/dlp/docs/" + "https://cloud.google.com/sensitive-data-protection/docs/" ], "dependencies": { "@maxim_mazurok/gapi.client.dlp-v2": "latest" diff --git a/types/gapi.client.drive-v2/package.json b/types/gapi.client.drive-v2/package.json index 14dd40daa3ef56..7eaf32f6618e9d 100644 --- a/types/gapi.client.drive-v2/package.json +++ b/types/gapi.client.drive-v2/package.json @@ -3,7 +3,7 @@ "name": "@types/gapi.client.drive-v2", "version": "0.0.9999", "nonNpm": true, - "nonNpmDescription": "Drive API v2", + "nonNpmDescription": "Google Drive API v2", "projects": [ "https://developers.google.com/drive/" ], diff --git a/types/gapi.client.drive-v3/package.json b/types/gapi.client.drive-v3/package.json index 9ef1bfa222debc..19cddcfce1befb 100644 --- a/types/gapi.client.drive-v3/package.json +++ b/types/gapi.client.drive-v3/package.json @@ -3,7 +3,7 @@ "name": "@types/gapi.client.drive-v3", "version": "0.0.9999", "nonNpm": true, - "nonNpmDescription": "Drive API v3", + "nonNpmDescription": "Google Drive API v3", "projects": [ "https://developers.google.com/drive/" ], diff --git a/types/gapi.client.firebaseappdistribution-v1alpha/.npmignore b/types/gapi.client.firebaseappdistribution-v1alpha/.npmignore new file mode 100644 index 00000000000000..93e307400a5456 --- /dev/null +++ b/types/gapi.client.firebaseappdistribution-v1alpha/.npmignore @@ -0,0 +1,5 @@ +* +!**/*.d.ts +!**/*.d.cts +!**/*.d.mts +!**/*.d.*.ts diff --git a/types/gapi.client.firebaseappdistribution-v1alpha/index.d.ts b/types/gapi.client.firebaseappdistribution-v1alpha/index.d.ts new file mode 100644 index 00000000000000..3fae007797ed4d --- /dev/null +++ b/types/gapi.client.firebaseappdistribution-v1alpha/index.d.ts @@ -0,0 +1,4 @@ +// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator +// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new + +/// diff --git a/types/gapi.client.firebaseappdistribution-v1alpha/package.json b/types/gapi.client.firebaseappdistribution-v1alpha/package.json new file mode 100644 index 00000000000000..19ea92b30a0d15 --- /dev/null +++ b/types/gapi.client.firebaseappdistribution-v1alpha/package.json @@ -0,0 +1,30 @@ +{ + "private": true, + "name": "@types/gapi.client.firebaseappdistribution-v1alpha", + "version": "0.0.9999", + "nonNpm": true, + "nonNpmDescription": "Firebase App Distribution API v1alpha", + "projects": [ + "https://firebase.google.com/products/app-distribution" + ], + "dependencies": { + "@maxim_mazurok/gapi.client.firebaseappdistribution-v1alpha": "latest" + }, + "devDependencies": { + "@types/gapi.client.firebaseappdistribution-v1alpha": "workspace:." + }, + "owners": [ + { + "name": "Maxim Mazurok", + "githubUsername": "Maxim-Mazurok" + }, + { + "name": "Nick Amoscato", + "githubUsername": "namoscato" + }, + { + "name": "Declan Vong", + "githubUsername": "declanvong" + } + ] +} diff --git a/types/gapi.client.firebaseappdistribution-v1alpha/tsconfig.json b/types/gapi.client.firebaseappdistribution-v1alpha/tsconfig.json new file mode 100644 index 00000000000000..0a036c4d046ec9 --- /dev/null +++ b/types/gapi.client.firebaseappdistribution-v1alpha/tsconfig.json @@ -0,0 +1,18 @@ +{ + "compilerOptions": { + "module": "node16", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "types": [] + }, + "files": [ + "index.d.ts" + ] +} diff --git a/types/gapi.client.firebaseml-v2beta/.npmignore b/types/gapi.client.firebaseml-v2beta/.npmignore new file mode 100644 index 00000000000000..93e307400a5456 --- /dev/null +++ b/types/gapi.client.firebaseml-v2beta/.npmignore @@ -0,0 +1,5 @@ +* +!**/*.d.ts +!**/*.d.cts +!**/*.d.mts +!**/*.d.*.ts diff --git a/types/gapi.client.firebaseml-v2beta/index.d.ts b/types/gapi.client.firebaseml-v2beta/index.d.ts new file mode 100644 index 00000000000000..7aa8d2144e1e4c --- /dev/null +++ b/types/gapi.client.firebaseml-v2beta/index.d.ts @@ -0,0 +1,4 @@ +// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator +// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new + +/// diff --git a/types/gapi.client.firebaseml-v2beta/package.json b/types/gapi.client.firebaseml-v2beta/package.json new file mode 100644 index 00000000000000..0dda7c16df1789 --- /dev/null +++ b/types/gapi.client.firebaseml-v2beta/package.json @@ -0,0 +1,30 @@ +{ + "private": true, + "name": "@types/gapi.client.firebaseml-v2beta", + "version": "0.0.9999", + "nonNpm": true, + "nonNpmDescription": "Firebase ML API v2beta", + "projects": [ + "https://firebase.google.com" + ], + "dependencies": { + "@maxim_mazurok/gapi.client.firebaseml-v2beta": "latest" + }, + "devDependencies": { + "@types/gapi.client.firebaseml-v2beta": "workspace:." + }, + "owners": [ + { + "name": "Maxim Mazurok", + "githubUsername": "Maxim-Mazurok" + }, + { + "name": "Nick Amoscato", + "githubUsername": "namoscato" + }, + { + "name": "Declan Vong", + "githubUsername": "declanvong" + } + ] +} diff --git a/types/gapi.client.firebaseml-v2beta/tsconfig.json b/types/gapi.client.firebaseml-v2beta/tsconfig.json new file mode 100644 index 00000000000000..0a036c4d046ec9 --- /dev/null +++ b/types/gapi.client.firebaseml-v2beta/tsconfig.json @@ -0,0 +1,18 @@ +{ + "compilerOptions": { + "module": "node16", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "types": [] + }, + "files": [ + "index.d.ts" + ] +} diff --git a/types/gapi.client.gameservices-v1beta/index.d.ts b/types/gapi.client.gameservices-v1beta/index.d.ts deleted file mode 100644 index e41e2401a9c8e5..00000000000000 --- a/types/gapi.client.gameservices-v1beta/index.d.ts +++ /dev/null @@ -1,4 +0,0 @@ -// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator -// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new - -/// diff --git a/types/gapi.client.genomics-v2alpha1/index.d.ts b/types/gapi.client.genomics-v2alpha1/index.d.ts deleted file mode 100644 index 92f8a20a43861f..00000000000000 --- a/types/gapi.client.genomics-v2alpha1/index.d.ts +++ /dev/null @@ -1,4 +0,0 @@ -// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator -// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new - -/// diff --git a/types/gapi.client.gkehub-v1alpha2/package.json b/types/gapi.client.gkehub-v1alpha2/package.json deleted file mode 100644 index 098519d9b3b3a2..00000000000000 --- a/types/gapi.client.gkehub-v1alpha2/package.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "private": true, - "name": "@types/gapi.client.gkehub-v1alpha2", - "version": "0.0.9999", - "nonNpm": true, - "nonNpmDescription": "GKE Hub API v1alpha2", - "projects": [ - "https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster" - ], - "dependencies": { - "@maxim_mazurok/gapi.client.gkehub-v1alpha2": "latest" - }, - "devDependencies": { - "@types/gapi.client.gkehub-v1alpha2": "workspace:." - }, - "owners": [ - { - "name": "Maxim Mazurok", - "githubUsername": "Maxim-Mazurok" - }, - { - "name": "Nick Amoscato", - "githubUsername": "namoscato" - }, - { - "name": "Declan Vong", - "githubUsername": "declanvong" - } - ] -} diff --git a/types/gapi.client.gkeonprem-v1/.npmignore b/types/gapi.client.gkeonprem-v1/.npmignore new file mode 100644 index 00000000000000..93e307400a5456 --- /dev/null +++ b/types/gapi.client.gkeonprem-v1/.npmignore @@ -0,0 +1,5 @@ +* +!**/*.d.ts +!**/*.d.cts +!**/*.d.mts +!**/*.d.*.ts diff --git a/types/gapi.client.googleads-v7/index.d.ts b/types/gapi.client.gkeonprem-v1/index.d.ts similarity index 78% rename from types/gapi.client.googleads-v7/index.d.ts rename to types/gapi.client.gkeonprem-v1/index.d.ts index 8ea4f7336bb202..3161162549455d 100644 --- a/types/gapi.client.googleads-v7/index.d.ts +++ b/types/gapi.client.gkeonprem-v1/index.d.ts @@ -1,4 +1,4 @@ // Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator // In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new -/// +/// diff --git a/types/gapi.client.gkeonprem-v1/package.json b/types/gapi.client.gkeonprem-v1/package.json new file mode 100644 index 00000000000000..a6a01d26b6c4cb --- /dev/null +++ b/types/gapi.client.gkeonprem-v1/package.json @@ -0,0 +1,30 @@ +{ + "private": true, + "name": "@types/gapi.client.gkeonprem-v1", + "version": "0.0.9999", + "nonNpm": true, + "nonNpmDescription": "Anthos On-Prem API v1", + "projects": [ + "https://cloud.google.com/anthos/clusters/docs/on-prem/" + ], + "dependencies": { + "@maxim_mazurok/gapi.client.gkeonprem-v1": "latest" + }, + "devDependencies": { + "@types/gapi.client.gkeonprem-v1": "workspace:." + }, + "owners": [ + { + "name": "Maxim Mazurok", + "githubUsername": "Maxim-Mazurok" + }, + { + "name": "Nick Amoscato", + "githubUsername": "namoscato" + }, + { + "name": "Declan Vong", + "githubUsername": "declanvong" + } + ] +} diff --git a/types/gapi.client.gkeonprem-v1/tsconfig.json b/types/gapi.client.gkeonprem-v1/tsconfig.json new file mode 100644 index 00000000000000..0a036c4d046ec9 --- /dev/null +++ b/types/gapi.client.gkeonprem-v1/tsconfig.json @@ -0,0 +1,18 @@ +{ + "compilerOptions": { + "module": "node16", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "types": [] + }, + "files": [ + "index.d.ts" + ] +} diff --git a/types/gapi.client.googleads-v14/.npmignore b/types/gapi.client.googleads-v14/.npmignore new file mode 100644 index 00000000000000..93e307400a5456 --- /dev/null +++ b/types/gapi.client.googleads-v14/.npmignore @@ -0,0 +1,5 @@ +* +!**/*.d.ts +!**/*.d.cts +!**/*.d.mts +!**/*.d.*.ts diff --git a/types/gapi.client.googleads-v12/index.d.ts b/types/gapi.client.googleads-v14/index.d.ts similarity index 78% rename from types/gapi.client.googleads-v12/index.d.ts rename to types/gapi.client.googleads-v14/index.d.ts index 47173ca1b41f23..b9c5dc595c02b2 100644 --- a/types/gapi.client.googleads-v12/index.d.ts +++ b/types/gapi.client.googleads-v14/index.d.ts @@ -1,4 +1,4 @@ // Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator // In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new -/// +/// diff --git a/types/gapi.client.googleads-v12/package.json b/types/gapi.client.googleads-v14/package.json similarity index 71% rename from types/gapi.client.googleads-v12/package.json rename to types/gapi.client.googleads-v14/package.json index 012b2fbbc2c302..0906af90fbad80 100644 --- a/types/gapi.client.googleads-v12/package.json +++ b/types/gapi.client.googleads-v14/package.json @@ -1,17 +1,17 @@ { "private": true, - "name": "@types/gapi.client.googleads-v12", + "name": "@types/gapi.client.googleads-v14", "version": "0.0.9999", "nonNpm": true, - "nonNpmDescription": "Google Ads API v12", + "nonNpmDescription": "Google Ads API v14", "projects": [ "https://developers.google.com/google-ads/api/" ], "dependencies": { - "@maxim_mazurok/gapi.client.googleads-v12": "latest" + "@maxim_mazurok/gapi.client.googleads-v14": "latest" }, "devDependencies": { - "@types/gapi.client.googleads-v12": "workspace:." + "@types/gapi.client.googleads-v14": "workspace:." }, "owners": [ { diff --git a/types/gapi.client.googleads-v14/tsconfig.json b/types/gapi.client.googleads-v14/tsconfig.json new file mode 100644 index 00000000000000..0a036c4d046ec9 --- /dev/null +++ b/types/gapi.client.googleads-v14/tsconfig.json @@ -0,0 +1,18 @@ +{ + "compilerOptions": { + "module": "node16", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "types": [] + }, + "files": [ + "index.d.ts" + ] +} diff --git a/types/gapi.client.googleads-v15/.npmignore b/types/gapi.client.googleads-v15/.npmignore new file mode 100644 index 00000000000000..93e307400a5456 --- /dev/null +++ b/types/gapi.client.googleads-v15/.npmignore @@ -0,0 +1,5 @@ +* +!**/*.d.ts +!**/*.d.cts +!**/*.d.mts +!**/*.d.*.ts diff --git a/types/gapi.client.googleads-v15/index.d.ts b/types/gapi.client.googleads-v15/index.d.ts new file mode 100644 index 00000000000000..ff683c3dd7266a --- /dev/null +++ b/types/gapi.client.googleads-v15/index.d.ts @@ -0,0 +1,4 @@ +// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator +// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new + +/// diff --git a/types/gapi.client.googleads-v13/package.json b/types/gapi.client.googleads-v15/package.json similarity index 71% rename from types/gapi.client.googleads-v13/package.json rename to types/gapi.client.googleads-v15/package.json index 9db963c949dc6d..107e252949c5fb 100644 --- a/types/gapi.client.googleads-v13/package.json +++ b/types/gapi.client.googleads-v15/package.json @@ -1,17 +1,17 @@ { "private": true, - "name": "@types/gapi.client.googleads-v13", + "name": "@types/gapi.client.googleads-v15", "version": "0.0.9999", "nonNpm": true, - "nonNpmDescription": "Google Ads API v13", + "nonNpmDescription": "Google Ads API v15", "projects": [ "https://developers.google.com/google-ads/api/" ], "dependencies": { - "@maxim_mazurok/gapi.client.googleads-v13": "latest" + "@maxim_mazurok/gapi.client.googleads-v15": "latest" }, "devDependencies": { - "@types/gapi.client.googleads-v13": "workspace:." + "@types/gapi.client.googleads-v15": "workspace:." }, "owners": [ { diff --git a/types/gapi.client.googleads-v15/tsconfig.json b/types/gapi.client.googleads-v15/tsconfig.json new file mode 100644 index 00000000000000..0a036c4d046ec9 --- /dev/null +++ b/types/gapi.client.googleads-v15/tsconfig.json @@ -0,0 +1,18 @@ +{ + "compilerOptions": { + "module": "node16", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "types": [] + }, + "files": [ + "index.d.ts" + ] +} diff --git a/types/gapi.client.googleads-v16/.npmignore b/types/gapi.client.googleads-v16/.npmignore new file mode 100644 index 00000000000000..93e307400a5456 --- /dev/null +++ b/types/gapi.client.googleads-v16/.npmignore @@ -0,0 +1,5 @@ +* +!**/*.d.ts +!**/*.d.cts +!**/*.d.mts +!**/*.d.*.ts diff --git a/types/gapi.client.googleads-v16/index.d.ts b/types/gapi.client.googleads-v16/index.d.ts new file mode 100644 index 00000000000000..8983f8dec61a64 --- /dev/null +++ b/types/gapi.client.googleads-v16/index.d.ts @@ -0,0 +1,4 @@ +// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator +// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new + +/// diff --git a/types/gapi.client.googleads-v10/package.json b/types/gapi.client.googleads-v16/package.json similarity index 71% rename from types/gapi.client.googleads-v10/package.json rename to types/gapi.client.googleads-v16/package.json index bfd6d3bfe28482..f8d6e43b4da46a 100644 --- a/types/gapi.client.googleads-v10/package.json +++ b/types/gapi.client.googleads-v16/package.json @@ -1,17 +1,17 @@ { "private": true, - "name": "@types/gapi.client.googleads-v10", + "name": "@types/gapi.client.googleads-v16", "version": "0.0.9999", "nonNpm": true, - "nonNpmDescription": "Google Ads API v10", + "nonNpmDescription": "Google Ads API v16", "projects": [ "https://developers.google.com/google-ads/api/" ], "dependencies": { - "@maxim_mazurok/gapi.client.googleads-v10": "latest" + "@maxim_mazurok/gapi.client.googleads-v16": "latest" }, "devDependencies": { - "@types/gapi.client.googleads-v10": "workspace:." + "@types/gapi.client.googleads-v16": "workspace:." }, "owners": [ { diff --git a/types/gapi.client.googleads-v16/tsconfig.json b/types/gapi.client.googleads-v16/tsconfig.json new file mode 100644 index 00000000000000..0a036c4d046ec9 --- /dev/null +++ b/types/gapi.client.googleads-v16/tsconfig.json @@ -0,0 +1,18 @@ +{ + "compilerOptions": { + "module": "node16", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "types": [] + }, + "files": [ + "index.d.ts" + ] +} diff --git a/types/gapi.client.googleads-v17/.npmignore b/types/gapi.client.googleads-v17/.npmignore new file mode 100644 index 00000000000000..93e307400a5456 --- /dev/null +++ b/types/gapi.client.googleads-v17/.npmignore @@ -0,0 +1,5 @@ +* +!**/*.d.ts +!**/*.d.cts +!**/*.d.mts +!**/*.d.*.ts diff --git a/types/gapi.client.googleads-v17/index.d.ts b/types/gapi.client.googleads-v17/index.d.ts new file mode 100644 index 00000000000000..6504b13310e4c1 --- /dev/null +++ b/types/gapi.client.googleads-v17/index.d.ts @@ -0,0 +1,4 @@ +// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator +// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new + +/// diff --git a/types/gapi.client.googleads-v11/package.json b/types/gapi.client.googleads-v17/package.json similarity index 71% rename from types/gapi.client.googleads-v11/package.json rename to types/gapi.client.googleads-v17/package.json index 9b3801106962ad..88eb2bab7eedb9 100644 --- a/types/gapi.client.googleads-v11/package.json +++ b/types/gapi.client.googleads-v17/package.json @@ -1,17 +1,17 @@ { "private": true, - "name": "@types/gapi.client.googleads-v11", + "name": "@types/gapi.client.googleads-v17", "version": "0.0.9999", "nonNpm": true, - "nonNpmDescription": "Google Ads API v11", + "nonNpmDescription": "Google Ads API v17", "projects": [ "https://developers.google.com/google-ads/api/" ], "dependencies": { - "@maxim_mazurok/gapi.client.googleads-v11": "latest" + "@maxim_mazurok/gapi.client.googleads-v17": "latest" }, "devDependencies": { - "@types/gapi.client.googleads-v11": "workspace:." + "@types/gapi.client.googleads-v17": "workspace:." }, "owners": [ { diff --git a/types/gapi.client.googleads-v17/tsconfig.json b/types/gapi.client.googleads-v17/tsconfig.json new file mode 100644 index 00000000000000..0a036c4d046ec9 --- /dev/null +++ b/types/gapi.client.googleads-v17/tsconfig.json @@ -0,0 +1,18 @@ +{ + "compilerOptions": { + "module": "node16", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "types": [] + }, + "files": [ + "index.d.ts" + ] +} diff --git a/types/gapi.client.googleads-v7/package.json b/types/gapi.client.googleads-v7/package.json deleted file mode 100644 index 6cc472e286868a..00000000000000 --- a/types/gapi.client.googleads-v7/package.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "private": true, - "name": "@types/gapi.client.googleads-v7", - "version": "0.0.9999", - "nonNpm": true, - "nonNpmDescription": "Google Ads API v7", - "projects": [ - "https://developers.google.com/google-ads/api/" - ], - "dependencies": { - "@maxim_mazurok/gapi.client.googleads-v7": "latest" - }, - "devDependencies": { - "@types/gapi.client.googleads-v7": "workspace:." - }, - "owners": [ - { - "name": "Maxim Mazurok", - "githubUsername": "Maxim-Mazurok" - }, - { - "name": "Nick Amoscato", - "githubUsername": "namoscato" - }, - { - "name": "Declan Vong", - "githubUsername": "declanvong" - } - ] -} diff --git a/types/gapi.client.googleads-v8/index.d.ts b/types/gapi.client.googleads-v8/index.d.ts deleted file mode 100644 index 4e7983ccd931b0..00000000000000 --- a/types/gapi.client.googleads-v8/index.d.ts +++ /dev/null @@ -1,4 +0,0 @@ -// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator -// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new - -/// diff --git a/types/gapi.client.googleads-v8/package.json b/types/gapi.client.googleads-v8/package.json deleted file mode 100644 index 6c51179a664b8d..00000000000000 --- a/types/gapi.client.googleads-v8/package.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "private": true, - "name": "@types/gapi.client.googleads-v8", - "version": "0.0.9999", - "nonNpm": true, - "nonNpmDescription": "Google Ads API v8", - "projects": [ - "https://developers.google.com/google-ads/api/" - ], - "dependencies": { - "@maxim_mazurok/gapi.client.googleads-v8": "latest" - }, - "devDependencies": { - "@types/gapi.client.googleads-v8": "workspace:." - }, - "owners": [ - { - "name": "Maxim Mazurok", - "githubUsername": "Maxim-Mazurok" - }, - { - "name": "Nick Amoscato", - "githubUsername": "namoscato" - }, - { - "name": "Declan Vong", - "githubUsername": "declanvong" - } - ] -} diff --git a/types/gapi.client.googleads-v9/index.d.ts b/types/gapi.client.googleads-v9/index.d.ts deleted file mode 100644 index 9b4635ffb3d14b..00000000000000 --- a/types/gapi.client.googleads-v9/index.d.ts +++ /dev/null @@ -1,4 +0,0 @@ -// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator -// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new - -/// diff --git a/types/gapi.client.googleads-v9/package.json b/types/gapi.client.googleads-v9/package.json deleted file mode 100644 index 8c9212e05c3312..00000000000000 --- a/types/gapi.client.googleads-v9/package.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "private": true, - "name": "@types/gapi.client.googleads-v9", - "version": "0.0.9999", - "nonNpm": true, - "nonNpmDescription": "Google Ads API v9", - "projects": [ - "https://developers.google.com/google-ads/api/" - ], - "dependencies": { - "@maxim_mazurok/gapi.client.googleads-v9": "latest" - }, - "devDependencies": { - "@types/gapi.client.googleads-v9": "workspace:." - }, - "owners": [ - { - "name": "Maxim Mazurok", - "githubUsername": "Maxim-Mazurok" - }, - { - "name": "Nick Amoscato", - "githubUsername": "namoscato" - }, - { - "name": "Declan Vong", - "githubUsername": "declanvong" - } - ] -} diff --git a/types/gapi.client.indexing-v3/package.json b/types/gapi.client.indexing-v3/package.json index d5a80d2fa3ddce..0fe563e1ee7cb8 100644 --- a/types/gapi.client.indexing-v3/package.json +++ b/types/gapi.client.indexing-v3/package.json @@ -3,7 +3,7 @@ "name": "@types/gapi.client.indexing-v3", "version": "0.0.9999", "nonNpm": true, - "nonNpmDescription": "Indexing API v3", + "nonNpmDescription": "Web Search Indexing API v3", "projects": [ "https://developers.google.com/search/apis/indexing-api/" ], diff --git a/types/gapi.client.integrations-v1/.npmignore b/types/gapi.client.integrations-v1/.npmignore new file mode 100644 index 00000000000000..93e307400a5456 --- /dev/null +++ b/types/gapi.client.integrations-v1/.npmignore @@ -0,0 +1,5 @@ +* +!**/*.d.ts +!**/*.d.cts +!**/*.d.mts +!**/*.d.*.ts diff --git a/types/gapi.client.integrations-v1alpha/index.d.ts b/types/gapi.client.integrations-v1/index.d.ts similarity index 96% rename from types/gapi.client.integrations-v1alpha/index.d.ts rename to types/gapi.client.integrations-v1/index.d.ts index 0b9ac5cc8765ee..0b3ad5c5da75c3 100644 --- a/types/gapi.client.integrations-v1alpha/index.d.ts +++ b/types/gapi.client.integrations-v1/index.d.ts @@ -1,4 +1,4 @@ // Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator // In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new -/// +/// diff --git a/types/gapi.client.integrations-v1alpha/package.json b/types/gapi.client.integrations-v1/package.json similarity index 68% rename from types/gapi.client.integrations-v1alpha/package.json rename to types/gapi.client.integrations-v1/package.json index 96558f3b95e36e..3dd25749603d98 100644 --- a/types/gapi.client.integrations-v1alpha/package.json +++ b/types/gapi.client.integrations-v1/package.json @@ -1,17 +1,17 @@ { "private": true, - "name": "@types/gapi.client.integrations-v1alpha", + "name": "@types/gapi.client.integrations-v1", "version": "0.0.9999", "nonNpm": true, - "nonNpmDescription": "Application Integration API v1alpha", + "nonNpmDescription": "Application Integration API v1", "projects": [ "https://cloud.google.com/application-integration" ], "dependencies": { - "@maxim_mazurok/gapi.client.integrations-v1alpha": "latest" + "@maxim_mazurok/gapi.client.integrations-v1": "latest" }, "devDependencies": { - "@types/gapi.client.integrations-v1alpha": "workspace:." + "@types/gapi.client.integrations-v1": "workspace:." }, "owners": [ { diff --git a/types/gapi.client.integrations-v1/tsconfig.json b/types/gapi.client.integrations-v1/tsconfig.json new file mode 100644 index 00000000000000..0a036c4d046ec9 --- /dev/null +++ b/types/gapi.client.integrations-v1/tsconfig.json @@ -0,0 +1,18 @@ +{ + "compilerOptions": { + "module": "node16", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "types": [] + }, + "files": [ + "index.d.ts" + ] +} diff --git a/types/gapi.client.language-v2/.npmignore b/types/gapi.client.language-v2/.npmignore new file mode 100644 index 00000000000000..93e307400a5456 --- /dev/null +++ b/types/gapi.client.language-v2/.npmignore @@ -0,0 +1,5 @@ +* +!**/*.d.ts +!**/*.d.cts +!**/*.d.mts +!**/*.d.*.ts diff --git a/types/gapi.client.language-v2/index.d.ts b/types/gapi.client.language-v2/index.d.ts new file mode 100644 index 00000000000000..c05117a4123991 --- /dev/null +++ b/types/gapi.client.language-v2/index.d.ts @@ -0,0 +1,4 @@ +// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator +// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new + +/// diff --git a/types/gapi.client.eventarc-v1beta1/package.json b/types/gapi.client.language-v2/package.json similarity index 63% rename from types/gapi.client.eventarc-v1beta1/package.json rename to types/gapi.client.language-v2/package.json index 966cc41f1b1308..d43e7e919d1045 100644 --- a/types/gapi.client.eventarc-v1beta1/package.json +++ b/types/gapi.client.language-v2/package.json @@ -1,17 +1,17 @@ { "private": true, - "name": "@types/gapi.client.eventarc-v1beta1", + "name": "@types/gapi.client.language-v2", "version": "0.0.9999", "nonNpm": true, - "nonNpmDescription": "Eventarc API v1beta1", + "nonNpmDescription": "Cloud Natural Language API v2", "projects": [ - "https://cloud.google.com/eventarc" + "https://cloud.google.com/natural-language/" ], "dependencies": { - "@maxim_mazurok/gapi.client.eventarc-v1beta1": "latest" + "@maxim_mazurok/gapi.client.language-v2": "latest" }, "devDependencies": { - "@types/gapi.client.eventarc-v1beta1": "workspace:." + "@types/gapi.client.language-v2": "workspace:." }, "owners": [ { diff --git a/types/gapi.client.language-v2/tsconfig.json b/types/gapi.client.language-v2/tsconfig.json new file mode 100644 index 00000000000000..0a036c4d046ec9 --- /dev/null +++ b/types/gapi.client.language-v2/tsconfig.json @@ -0,0 +1,18 @@ +{ + "compilerOptions": { + "module": "node16", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "types": [] + }, + "files": [ + "index.d.ts" + ] +} diff --git a/types/gapi.client.looker-v1/.npmignore b/types/gapi.client.looker-v1/.npmignore new file mode 100644 index 00000000000000..93e307400a5456 --- /dev/null +++ b/types/gapi.client.looker-v1/.npmignore @@ -0,0 +1,5 @@ +* +!**/*.d.ts +!**/*.d.cts +!**/*.d.mts +!**/*.d.*.ts diff --git a/types/gapi.client.looker-v1/index.d.ts b/types/gapi.client.looker-v1/index.d.ts new file mode 100644 index 00000000000000..d0e29ae010faaf --- /dev/null +++ b/types/gapi.client.looker-v1/index.d.ts @@ -0,0 +1,4 @@ +// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator +// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new + +/// diff --git a/types/gapi.client.looker-v1/package.json b/types/gapi.client.looker-v1/package.json new file mode 100644 index 00000000000000..87f625b7f2c9e6 --- /dev/null +++ b/types/gapi.client.looker-v1/package.json @@ -0,0 +1,30 @@ +{ + "private": true, + "name": "@types/gapi.client.looker-v1", + "version": "0.0.9999", + "nonNpm": true, + "nonNpmDescription": "Looker (Google Cloud core) API v1", + "projects": [ + "https://cloud.google.com/looker/docs/reference/rest/" + ], + "dependencies": { + "@maxim_mazurok/gapi.client.looker-v1": "latest" + }, + "devDependencies": { + "@types/gapi.client.looker-v1": "workspace:." + }, + "owners": [ + { + "name": "Maxim Mazurok", + "githubUsername": "Maxim-Mazurok" + }, + { + "name": "Nick Amoscato", + "githubUsername": "namoscato" + }, + { + "name": "Declan Vong", + "githubUsername": "declanvong" + } + ] +} diff --git a/types/gapi.client.looker-v1/tsconfig.json b/types/gapi.client.looker-v1/tsconfig.json new file mode 100644 index 00000000000000..0a036c4d046ec9 --- /dev/null +++ b/types/gapi.client.looker-v1/tsconfig.json @@ -0,0 +1,18 @@ +{ + "compilerOptions": { + "module": "node16", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "types": [] + }, + "files": [ + "index.d.ts" + ] +} diff --git a/types/gapi.client.marketingplatformadmin-v1alpha/.npmignore b/types/gapi.client.marketingplatformadmin-v1alpha/.npmignore new file mode 100644 index 00000000000000..93e307400a5456 --- /dev/null +++ b/types/gapi.client.marketingplatformadmin-v1alpha/.npmignore @@ -0,0 +1,5 @@ +* +!**/*.d.ts +!**/*.d.cts +!**/*.d.mts +!**/*.d.*.ts diff --git a/types/gapi.client.marketingplatformadmin-v1alpha/index.d.ts b/types/gapi.client.marketingplatformadmin-v1alpha/index.d.ts new file mode 100644 index 00000000000000..b51bdf2c0eb3c1 --- /dev/null +++ b/types/gapi.client.marketingplatformadmin-v1alpha/index.d.ts @@ -0,0 +1,4 @@ +// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator +// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new + +/// diff --git a/types/gapi.client.marketingplatformadmin-v1alpha/package.json b/types/gapi.client.marketingplatformadmin-v1alpha/package.json new file mode 100644 index 00000000000000..7659b4e63a9ae3 --- /dev/null +++ b/types/gapi.client.marketingplatformadmin-v1alpha/package.json @@ -0,0 +1,30 @@ +{ + "private": true, + "name": "@types/gapi.client.marketingplatformadmin-v1alpha", + "version": "0.0.9999", + "nonNpm": true, + "nonNpmDescription": "Google Marketing Platform Admin API v1alpha", + "projects": [ + "https://developers.google.com/analytics/devguides/config/gmp/v1" + ], + "dependencies": { + "@maxim_mazurok/gapi.client.marketingplatformadmin-v1alpha": "latest" + }, + "devDependencies": { + "@types/gapi.client.marketingplatformadmin-v1alpha": "workspace:." + }, + "owners": [ + { + "name": "Maxim Mazurok", + "githubUsername": "Maxim-Mazurok" + }, + { + "name": "Nick Amoscato", + "githubUsername": "namoscato" + }, + { + "name": "Declan Vong", + "githubUsername": "declanvong" + } + ] +} diff --git a/types/gapi.client.marketingplatformadmin-v1alpha/tsconfig.json b/types/gapi.client.marketingplatformadmin-v1alpha/tsconfig.json new file mode 100644 index 00000000000000..0a036c4d046ec9 --- /dev/null +++ b/types/gapi.client.marketingplatformadmin-v1alpha/tsconfig.json @@ -0,0 +1,18 @@ +{ + "compilerOptions": { + "module": "node16", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "types": [] + }, + "files": [ + "index.d.ts" + ] +} diff --git a/types/gapi.client.meet-v2/.npmignore b/types/gapi.client.meet-v2/.npmignore new file mode 100644 index 00000000000000..93e307400a5456 --- /dev/null +++ b/types/gapi.client.meet-v2/.npmignore @@ -0,0 +1,5 @@ +* +!**/*.d.ts +!**/*.d.cts +!**/*.d.mts +!**/*.d.*.ts diff --git a/types/gapi.client.poly-v1/index.d.ts b/types/gapi.client.meet-v2/index.d.ts similarity index 79% rename from types/gapi.client.poly-v1/index.d.ts rename to types/gapi.client.meet-v2/index.d.ts index ec2580dedc87af..951042241ac08a 100644 --- a/types/gapi.client.poly-v1/index.d.ts +++ b/types/gapi.client.meet-v2/index.d.ts @@ -1,4 +1,4 @@ // Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator // In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new -/// +/// diff --git a/types/gapi.client.cloudiot-v1/package.json b/types/gapi.client.meet-v2/package.json similarity index 66% rename from types/gapi.client.cloudiot-v1/package.json rename to types/gapi.client.meet-v2/package.json index 89e3131f1a0d93..698fd1ff257b32 100644 --- a/types/gapi.client.cloudiot-v1/package.json +++ b/types/gapi.client.meet-v2/package.json @@ -1,17 +1,17 @@ { "private": true, - "name": "@types/gapi.client.cloudiot-v1", + "name": "@types/gapi.client.meet-v2", "version": "0.0.9999", "nonNpm": true, - "nonNpmDescription": "Cloud IoT API v1", + "nonNpmDescription": "Google Meet API v2", "projects": [ - "https://cloud.google.com/iot" + "https://developers.google.com/meet/api" ], "dependencies": { - "@maxim_mazurok/gapi.client.cloudiot-v1": "latest" + "@maxim_mazurok/gapi.client.meet-v2": "latest" }, "devDependencies": { - "@types/gapi.client.cloudiot-v1": "workspace:." + "@types/gapi.client.meet-v2": "workspace:." }, "owners": [ { diff --git a/types/gapi.client.meet-v2/tsconfig.json b/types/gapi.client.meet-v2/tsconfig.json new file mode 100644 index 00000000000000..0a036c4d046ec9 --- /dev/null +++ b/types/gapi.client.meet-v2/tsconfig.json @@ -0,0 +1,18 @@ +{ + "compilerOptions": { + "module": "node16", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "types": [] + }, + "files": [ + "index.d.ts" + ] +} diff --git a/types/gapi.client.merchantapi-accounts_v1beta/.npmignore b/types/gapi.client.merchantapi-accounts_v1beta/.npmignore new file mode 100644 index 00000000000000..93e307400a5456 --- /dev/null +++ b/types/gapi.client.merchantapi-accounts_v1beta/.npmignore @@ -0,0 +1,5 @@ +* +!**/*.d.ts +!**/*.d.cts +!**/*.d.mts +!**/*.d.*.ts diff --git a/types/gapi.client.merchantapi-accounts_v1beta/index.d.ts b/types/gapi.client.merchantapi-accounts_v1beta/index.d.ts new file mode 100644 index 00000000000000..73b8713447f67b --- /dev/null +++ b/types/gapi.client.merchantapi-accounts_v1beta/index.d.ts @@ -0,0 +1,4 @@ +// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator +// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new + +/// diff --git a/types/gapi.client.accesscontextmanager-v1beta/package.json b/types/gapi.client.merchantapi-accounts_v1beta/package.json similarity index 60% rename from types/gapi.client.accesscontextmanager-v1beta/package.json rename to types/gapi.client.merchantapi-accounts_v1beta/package.json index a0b438902217e9..b65e1d223e74bb 100644 --- a/types/gapi.client.accesscontextmanager-v1beta/package.json +++ b/types/gapi.client.merchantapi-accounts_v1beta/package.json @@ -1,17 +1,17 @@ { "private": true, - "name": "@types/gapi.client.accesscontextmanager-v1beta", + "name": "@types/gapi.client.merchantapi-accounts_v1beta", "version": "0.0.9999", "nonNpm": true, - "nonNpmDescription": "Access Context Manager API v1beta", + "nonNpmDescription": "Merchant API accounts_v1beta", "projects": [ - "https://cloud.google.com/access-context-manager/docs/reference/rest/" + "https://developers.devsite.corp.google.com/merchant/api" ], "dependencies": { - "@maxim_mazurok/gapi.client.accesscontextmanager-v1beta": "latest" + "@maxim_mazurok/gapi.client.merchantapi-accounts_v1beta": "latest" }, "devDependencies": { - "@types/gapi.client.accesscontextmanager-v1beta": "workspace:." + "@types/gapi.client.merchantapi-accounts_v1beta": "workspace:." }, "owners": [ { diff --git a/types/gapi.client.merchantapi-accounts_v1beta/tsconfig.json b/types/gapi.client.merchantapi-accounts_v1beta/tsconfig.json new file mode 100644 index 00000000000000..0a036c4d046ec9 --- /dev/null +++ b/types/gapi.client.merchantapi-accounts_v1beta/tsconfig.json @@ -0,0 +1,18 @@ +{ + "compilerOptions": { + "module": "node16", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "types": [] + }, + "files": [ + "index.d.ts" + ] +} diff --git a/types/gapi.client.merchantapi-conversions_v1beta/.npmignore b/types/gapi.client.merchantapi-conversions_v1beta/.npmignore new file mode 100644 index 00000000000000..93e307400a5456 --- /dev/null +++ b/types/gapi.client.merchantapi-conversions_v1beta/.npmignore @@ -0,0 +1,5 @@ +* +!**/*.d.ts +!**/*.d.cts +!**/*.d.mts +!**/*.d.*.ts diff --git a/types/gapi.client.merchantapi-conversions_v1beta/index.d.ts b/types/gapi.client.merchantapi-conversions_v1beta/index.d.ts new file mode 100644 index 00000000000000..1e0bdd343ff128 --- /dev/null +++ b/types/gapi.client.merchantapi-conversions_v1beta/index.d.ts @@ -0,0 +1,4 @@ +// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator +// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new + +/// diff --git a/types/gapi.client.merchantapi-conversions_v1beta/package.json b/types/gapi.client.merchantapi-conversions_v1beta/package.json new file mode 100644 index 00000000000000..d5dc9d5a32d556 --- /dev/null +++ b/types/gapi.client.merchantapi-conversions_v1beta/package.json @@ -0,0 +1,30 @@ +{ + "private": true, + "name": "@types/gapi.client.merchantapi-conversions_v1beta", + "version": "0.0.9999", + "nonNpm": true, + "nonNpmDescription": "Merchant API conversions_v1beta", + "projects": [ + "https://developers.devsite.corp.google.com/merchant/api" + ], + "dependencies": { + "@maxim_mazurok/gapi.client.merchantapi-conversions_v1beta": "latest" + }, + "devDependencies": { + "@types/gapi.client.merchantapi-conversions_v1beta": "workspace:." + }, + "owners": [ + { + "name": "Maxim Mazurok", + "githubUsername": "Maxim-Mazurok" + }, + { + "name": "Nick Amoscato", + "githubUsername": "namoscato" + }, + { + "name": "Declan Vong", + "githubUsername": "declanvong" + } + ] +} diff --git a/types/gapi.client.merchantapi-conversions_v1beta/tsconfig.json b/types/gapi.client.merchantapi-conversions_v1beta/tsconfig.json new file mode 100644 index 00000000000000..0a036c4d046ec9 --- /dev/null +++ b/types/gapi.client.merchantapi-conversions_v1beta/tsconfig.json @@ -0,0 +1,18 @@ +{ + "compilerOptions": { + "module": "node16", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "types": [] + }, + "files": [ + "index.d.ts" + ] +} diff --git a/types/gapi.client.merchantapi-datasources_v1beta/.npmignore b/types/gapi.client.merchantapi-datasources_v1beta/.npmignore new file mode 100644 index 00000000000000..93e307400a5456 --- /dev/null +++ b/types/gapi.client.merchantapi-datasources_v1beta/.npmignore @@ -0,0 +1,5 @@ +* +!**/*.d.ts +!**/*.d.cts +!**/*.d.mts +!**/*.d.*.ts diff --git a/types/gapi.client.merchantapi-datasources_v1beta/index.d.ts b/types/gapi.client.merchantapi-datasources_v1beta/index.d.ts new file mode 100644 index 00000000000000..b7da294810529f --- /dev/null +++ b/types/gapi.client.merchantapi-datasources_v1beta/index.d.ts @@ -0,0 +1,4 @@ +// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator +// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new + +/// diff --git a/types/gapi.client.merchantapi-datasources_v1beta/package.json b/types/gapi.client.merchantapi-datasources_v1beta/package.json new file mode 100644 index 00000000000000..dfac9842a20898 --- /dev/null +++ b/types/gapi.client.merchantapi-datasources_v1beta/package.json @@ -0,0 +1,30 @@ +{ + "private": true, + "name": "@types/gapi.client.merchantapi-datasources_v1beta", + "version": "0.0.9999", + "nonNpm": true, + "nonNpmDescription": "Merchant API datasources_v1beta", + "projects": [ + "https://developers.devsite.corp.google.com/merchant/api" + ], + "dependencies": { + "@maxim_mazurok/gapi.client.merchantapi-datasources_v1beta": "latest" + }, + "devDependencies": { + "@types/gapi.client.merchantapi-datasources_v1beta": "workspace:." + }, + "owners": [ + { + "name": "Maxim Mazurok", + "githubUsername": "Maxim-Mazurok" + }, + { + "name": "Nick Amoscato", + "githubUsername": "namoscato" + }, + { + "name": "Declan Vong", + "githubUsername": "declanvong" + } + ] +} diff --git a/types/gapi.client.merchantapi-datasources_v1beta/tsconfig.json b/types/gapi.client.merchantapi-datasources_v1beta/tsconfig.json new file mode 100644 index 00000000000000..0a036c4d046ec9 --- /dev/null +++ b/types/gapi.client.merchantapi-datasources_v1beta/tsconfig.json @@ -0,0 +1,18 @@ +{ + "compilerOptions": { + "module": "node16", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "types": [] + }, + "files": [ + "index.d.ts" + ] +} diff --git a/types/gapi.client.merchantapi-inventories_v1beta/.npmignore b/types/gapi.client.merchantapi-inventories_v1beta/.npmignore new file mode 100644 index 00000000000000..93e307400a5456 --- /dev/null +++ b/types/gapi.client.merchantapi-inventories_v1beta/.npmignore @@ -0,0 +1,5 @@ +* +!**/*.d.ts +!**/*.d.cts +!**/*.d.mts +!**/*.d.*.ts diff --git a/types/gapi.client.merchantapi-inventories_v1beta/index.d.ts b/types/gapi.client.merchantapi-inventories_v1beta/index.d.ts new file mode 100644 index 00000000000000..ce267707499c79 --- /dev/null +++ b/types/gapi.client.merchantapi-inventories_v1beta/index.d.ts @@ -0,0 +1,4 @@ +// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator +// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new + +/// diff --git a/types/gapi.client.merchantapi-inventories_v1beta/package.json b/types/gapi.client.merchantapi-inventories_v1beta/package.json new file mode 100644 index 00000000000000..67995f75bb91e1 --- /dev/null +++ b/types/gapi.client.merchantapi-inventories_v1beta/package.json @@ -0,0 +1,30 @@ +{ + "private": true, + "name": "@types/gapi.client.merchantapi-inventories_v1beta", + "version": "0.0.9999", + "nonNpm": true, + "nonNpmDescription": "Merchant API inventories_v1beta", + "projects": [ + "https://developers.devsite.corp.google.com/merchant/api" + ], + "dependencies": { + "@maxim_mazurok/gapi.client.merchantapi-inventories_v1beta": "latest" + }, + "devDependencies": { + "@types/gapi.client.merchantapi-inventories_v1beta": "workspace:." + }, + "owners": [ + { + "name": "Maxim Mazurok", + "githubUsername": "Maxim-Mazurok" + }, + { + "name": "Nick Amoscato", + "githubUsername": "namoscato" + }, + { + "name": "Declan Vong", + "githubUsername": "declanvong" + } + ] +} diff --git a/types/gapi.client.merchantapi-inventories_v1beta/tsconfig.json b/types/gapi.client.merchantapi-inventories_v1beta/tsconfig.json new file mode 100644 index 00000000000000..0a036c4d046ec9 --- /dev/null +++ b/types/gapi.client.merchantapi-inventories_v1beta/tsconfig.json @@ -0,0 +1,18 @@ +{ + "compilerOptions": { + "module": "node16", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "types": [] + }, + "files": [ + "index.d.ts" + ] +} diff --git a/types/gapi.client.merchantapi-lfp_v1beta/.npmignore b/types/gapi.client.merchantapi-lfp_v1beta/.npmignore new file mode 100644 index 00000000000000..93e307400a5456 --- /dev/null +++ b/types/gapi.client.merchantapi-lfp_v1beta/.npmignore @@ -0,0 +1,5 @@ +* +!**/*.d.ts +!**/*.d.cts +!**/*.d.mts +!**/*.d.*.ts diff --git a/types/gapi.client.merchantapi-lfp_v1beta/index.d.ts b/types/gapi.client.merchantapi-lfp_v1beta/index.d.ts new file mode 100644 index 00000000000000..f2391b944de501 --- /dev/null +++ b/types/gapi.client.merchantapi-lfp_v1beta/index.d.ts @@ -0,0 +1,4 @@ +// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator +// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new + +/// diff --git a/types/gapi.client.merchantapi-lfp_v1beta/package.json b/types/gapi.client.merchantapi-lfp_v1beta/package.json new file mode 100644 index 00000000000000..11013741942e8b --- /dev/null +++ b/types/gapi.client.merchantapi-lfp_v1beta/package.json @@ -0,0 +1,30 @@ +{ + "private": true, + "name": "@types/gapi.client.merchantapi-lfp_v1beta", + "version": "0.0.9999", + "nonNpm": true, + "nonNpmDescription": "Merchant API lfp_v1beta", + "projects": [ + "https://developers.devsite.corp.google.com/merchant/api" + ], + "dependencies": { + "@maxim_mazurok/gapi.client.merchantapi-lfp_v1beta": "latest" + }, + "devDependencies": { + "@types/gapi.client.merchantapi-lfp_v1beta": "workspace:." + }, + "owners": [ + { + "name": "Maxim Mazurok", + "githubUsername": "Maxim-Mazurok" + }, + { + "name": "Nick Amoscato", + "githubUsername": "namoscato" + }, + { + "name": "Declan Vong", + "githubUsername": "declanvong" + } + ] +} diff --git a/types/gapi.client.merchantapi-lfp_v1beta/tsconfig.json b/types/gapi.client.merchantapi-lfp_v1beta/tsconfig.json new file mode 100644 index 00000000000000..0a036c4d046ec9 --- /dev/null +++ b/types/gapi.client.merchantapi-lfp_v1beta/tsconfig.json @@ -0,0 +1,18 @@ +{ + "compilerOptions": { + "module": "node16", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "types": [] + }, + "files": [ + "index.d.ts" + ] +} diff --git a/types/gapi.client.merchantapi-notifications_v1beta/.npmignore b/types/gapi.client.merchantapi-notifications_v1beta/.npmignore new file mode 100644 index 00000000000000..93e307400a5456 --- /dev/null +++ b/types/gapi.client.merchantapi-notifications_v1beta/.npmignore @@ -0,0 +1,5 @@ +* +!**/*.d.ts +!**/*.d.cts +!**/*.d.mts +!**/*.d.*.ts diff --git a/types/gapi.client.merchantapi-notifications_v1beta/index.d.ts b/types/gapi.client.merchantapi-notifications_v1beta/index.d.ts new file mode 100644 index 00000000000000..f12b39d56a9aab --- /dev/null +++ b/types/gapi.client.merchantapi-notifications_v1beta/index.d.ts @@ -0,0 +1,4 @@ +// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator +// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new + +/// diff --git a/types/gapi.client.merchantapi-notifications_v1beta/package.json b/types/gapi.client.merchantapi-notifications_v1beta/package.json new file mode 100644 index 00000000000000..1aa9052d4dd1eb --- /dev/null +++ b/types/gapi.client.merchantapi-notifications_v1beta/package.json @@ -0,0 +1,30 @@ +{ + "private": true, + "name": "@types/gapi.client.merchantapi-notifications_v1beta", + "version": "0.0.9999", + "nonNpm": true, + "nonNpmDescription": "Merchant API notifications_v1beta", + "projects": [ + "https://developers.devsite.corp.google.com/merchant/api" + ], + "dependencies": { + "@maxim_mazurok/gapi.client.merchantapi-notifications_v1beta": "latest" + }, + "devDependencies": { + "@types/gapi.client.merchantapi-notifications_v1beta": "workspace:." + }, + "owners": [ + { + "name": "Maxim Mazurok", + "githubUsername": "Maxim-Mazurok" + }, + { + "name": "Nick Amoscato", + "githubUsername": "namoscato" + }, + { + "name": "Declan Vong", + "githubUsername": "declanvong" + } + ] +} diff --git a/types/gapi.client.merchantapi-notifications_v1beta/tsconfig.json b/types/gapi.client.merchantapi-notifications_v1beta/tsconfig.json new file mode 100644 index 00000000000000..0a036c4d046ec9 --- /dev/null +++ b/types/gapi.client.merchantapi-notifications_v1beta/tsconfig.json @@ -0,0 +1,18 @@ +{ + "compilerOptions": { + "module": "node16", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "types": [] + }, + "files": [ + "index.d.ts" + ] +} diff --git a/types/gapi.client.merchantapi-products_v1beta/.npmignore b/types/gapi.client.merchantapi-products_v1beta/.npmignore new file mode 100644 index 00000000000000..93e307400a5456 --- /dev/null +++ b/types/gapi.client.merchantapi-products_v1beta/.npmignore @@ -0,0 +1,5 @@ +* +!**/*.d.ts +!**/*.d.cts +!**/*.d.mts +!**/*.d.*.ts diff --git a/types/gapi.client.merchantapi-products_v1beta/index.d.ts b/types/gapi.client.merchantapi-products_v1beta/index.d.ts new file mode 100644 index 00000000000000..e3387757930e0a --- /dev/null +++ b/types/gapi.client.merchantapi-products_v1beta/index.d.ts @@ -0,0 +1,4 @@ +// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator +// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new + +/// diff --git a/types/gapi.client.merchantapi-products_v1beta/package.json b/types/gapi.client.merchantapi-products_v1beta/package.json new file mode 100644 index 00000000000000..13d1cedd61679e --- /dev/null +++ b/types/gapi.client.merchantapi-products_v1beta/package.json @@ -0,0 +1,30 @@ +{ + "private": true, + "name": "@types/gapi.client.merchantapi-products_v1beta", + "version": "0.0.9999", + "nonNpm": true, + "nonNpmDescription": "Merchant API products_v1beta", + "projects": [ + "https://developers.devsite.corp.google.com/merchant/api" + ], + "dependencies": { + "@maxim_mazurok/gapi.client.merchantapi-products_v1beta": "latest" + }, + "devDependencies": { + "@types/gapi.client.merchantapi-products_v1beta": "workspace:." + }, + "owners": [ + { + "name": "Maxim Mazurok", + "githubUsername": "Maxim-Mazurok" + }, + { + "name": "Nick Amoscato", + "githubUsername": "namoscato" + }, + { + "name": "Declan Vong", + "githubUsername": "declanvong" + } + ] +} diff --git a/types/gapi.client.merchantapi-products_v1beta/tsconfig.json b/types/gapi.client.merchantapi-products_v1beta/tsconfig.json new file mode 100644 index 00000000000000..0a036c4d046ec9 --- /dev/null +++ b/types/gapi.client.merchantapi-products_v1beta/tsconfig.json @@ -0,0 +1,18 @@ +{ + "compilerOptions": { + "module": "node16", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "types": [] + }, + "files": [ + "index.d.ts" + ] +} diff --git a/types/gapi.client.merchantapi-promotions_v1beta/.npmignore b/types/gapi.client.merchantapi-promotions_v1beta/.npmignore new file mode 100644 index 00000000000000..93e307400a5456 --- /dev/null +++ b/types/gapi.client.merchantapi-promotions_v1beta/.npmignore @@ -0,0 +1,5 @@ +* +!**/*.d.ts +!**/*.d.cts +!**/*.d.mts +!**/*.d.*.ts diff --git a/types/gapi.client.merchantapi-promotions_v1beta/index.d.ts b/types/gapi.client.merchantapi-promotions_v1beta/index.d.ts new file mode 100644 index 00000000000000..b21c60efa70bb1 --- /dev/null +++ b/types/gapi.client.merchantapi-promotions_v1beta/index.d.ts @@ -0,0 +1,4 @@ +// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator +// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new + +/// diff --git a/types/gapi.client.merchantapi-promotions_v1beta/package.json b/types/gapi.client.merchantapi-promotions_v1beta/package.json new file mode 100644 index 00000000000000..72d5e93233211a --- /dev/null +++ b/types/gapi.client.merchantapi-promotions_v1beta/package.json @@ -0,0 +1,30 @@ +{ + "private": true, + "name": "@types/gapi.client.merchantapi-promotions_v1beta", + "version": "0.0.9999", + "nonNpm": true, + "nonNpmDescription": "Merchant API promotions_v1beta", + "projects": [ + "https://developers.devsite.corp.google.com/merchant/api" + ], + "dependencies": { + "@maxim_mazurok/gapi.client.merchantapi-promotions_v1beta": "latest" + }, + "devDependencies": { + "@types/gapi.client.merchantapi-promotions_v1beta": "workspace:." + }, + "owners": [ + { + "name": "Maxim Mazurok", + "githubUsername": "Maxim-Mazurok" + }, + { + "name": "Nick Amoscato", + "githubUsername": "namoscato" + }, + { + "name": "Declan Vong", + "githubUsername": "declanvong" + } + ] +} diff --git a/types/gapi.client.merchantapi-promotions_v1beta/tsconfig.json b/types/gapi.client.merchantapi-promotions_v1beta/tsconfig.json new file mode 100644 index 00000000000000..0a036c4d046ec9 --- /dev/null +++ b/types/gapi.client.merchantapi-promotions_v1beta/tsconfig.json @@ -0,0 +1,18 @@ +{ + "compilerOptions": { + "module": "node16", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "types": [] + }, + "files": [ + "index.d.ts" + ] +} diff --git a/types/gapi.client.merchantapi-quota_v1beta/.npmignore b/types/gapi.client.merchantapi-quota_v1beta/.npmignore new file mode 100644 index 00000000000000..93e307400a5456 --- /dev/null +++ b/types/gapi.client.merchantapi-quota_v1beta/.npmignore @@ -0,0 +1,5 @@ +* +!**/*.d.ts +!**/*.d.cts +!**/*.d.mts +!**/*.d.*.ts diff --git a/types/gapi.client.merchantapi-quota_v1beta/index.d.ts b/types/gapi.client.merchantapi-quota_v1beta/index.d.ts new file mode 100644 index 00000000000000..f975971edd9d07 --- /dev/null +++ b/types/gapi.client.merchantapi-quota_v1beta/index.d.ts @@ -0,0 +1,4 @@ +// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator +// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new + +/// diff --git a/types/gapi.client.doubleclickbidmanager-v1.1/package.json b/types/gapi.client.merchantapi-quota_v1beta/package.json similarity index 60% rename from types/gapi.client.doubleclickbidmanager-v1.1/package.json rename to types/gapi.client.merchantapi-quota_v1beta/package.json index bc6d2f907da857..e308d55e996528 100644 --- a/types/gapi.client.doubleclickbidmanager-v1.1/package.json +++ b/types/gapi.client.merchantapi-quota_v1beta/package.json @@ -1,17 +1,17 @@ { "private": true, - "name": "@types/gapi.client.doubleclickbidmanager-v1.1", + "name": "@types/gapi.client.merchantapi-quota_v1beta", "version": "0.0.9999", "nonNpm": true, - "nonNpmDescription": "DoubleClick Bid Manager API v1.1", + "nonNpmDescription": "Merchant API quota_v1beta", "projects": [ - "https://developers.google.com/bid-manager/" + "https://developers.devsite.corp.google.com/merchant/api" ], "dependencies": { - "@maxim_mazurok/gapi.client.doubleclickbidmanager-v1.1": "latest" + "@maxim_mazurok/gapi.client.merchantapi-quota_v1beta": "latest" }, "devDependencies": { - "@types/gapi.client.doubleclickbidmanager-v1.1": "workspace:." + "@types/gapi.client.merchantapi-quota_v1beta": "workspace:." }, "owners": [ { diff --git a/types/gapi.client.merchantapi-quota_v1beta/tsconfig.json b/types/gapi.client.merchantapi-quota_v1beta/tsconfig.json new file mode 100644 index 00000000000000..0a036c4d046ec9 --- /dev/null +++ b/types/gapi.client.merchantapi-quota_v1beta/tsconfig.json @@ -0,0 +1,18 @@ +{ + "compilerOptions": { + "module": "node16", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "types": [] + }, + "files": [ + "index.d.ts" + ] +} diff --git a/types/gapi.client.merchantapi-reports_v1beta/.npmignore b/types/gapi.client.merchantapi-reports_v1beta/.npmignore new file mode 100644 index 00000000000000..93e307400a5456 --- /dev/null +++ b/types/gapi.client.merchantapi-reports_v1beta/.npmignore @@ -0,0 +1,5 @@ +* +!**/*.d.ts +!**/*.d.cts +!**/*.d.mts +!**/*.d.*.ts diff --git a/types/gapi.client.doubleclickbidmanager-v1.1/index.d.ts b/types/gapi.client.merchantapi-reports_v1beta/index.d.ts similarity index 74% rename from types/gapi.client.doubleclickbidmanager-v1.1/index.d.ts rename to types/gapi.client.merchantapi-reports_v1beta/index.d.ts index 7a8690662fdac8..31715880c1823e 100644 --- a/types/gapi.client.doubleclickbidmanager-v1.1/index.d.ts +++ b/types/gapi.client.merchantapi-reports_v1beta/index.d.ts @@ -1,4 +1,4 @@ // Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator // In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new -/// +/// diff --git a/types/gapi.client.mybusinessbusinesscalls-v1/package.json b/types/gapi.client.merchantapi-reports_v1beta/package.json similarity index 61% rename from types/gapi.client.mybusinessbusinesscalls-v1/package.json rename to types/gapi.client.merchantapi-reports_v1beta/package.json index 1f43307d16c89c..63db765fe44f3b 100644 --- a/types/gapi.client.mybusinessbusinesscalls-v1/package.json +++ b/types/gapi.client.merchantapi-reports_v1beta/package.json @@ -1,17 +1,17 @@ { "private": true, - "name": "@types/gapi.client.mybusinessbusinesscalls-v1", + "name": "@types/gapi.client.merchantapi-reports_v1beta", "version": "0.0.9999", "nonNpm": true, - "nonNpmDescription": "My Business Business Calls API v1", + "nonNpmDescription": "Merchant API reports_v1beta", "projects": [ - "https://developers.google.com/my-business/" + "https://developers.devsite.corp.google.com/merchant/api" ], "dependencies": { - "@maxim_mazurok/gapi.client.mybusinessbusinesscalls-v1": "latest" + "@maxim_mazurok/gapi.client.merchantapi-reports_v1beta": "latest" }, "devDependencies": { - "@types/gapi.client.mybusinessbusinesscalls-v1": "workspace:." + "@types/gapi.client.merchantapi-reports_v1beta": "workspace:." }, "owners": [ { diff --git a/types/gapi.client.merchantapi-reports_v1beta/tsconfig.json b/types/gapi.client.merchantapi-reports_v1beta/tsconfig.json new file mode 100644 index 00000000000000..0a036c4d046ec9 --- /dev/null +++ b/types/gapi.client.merchantapi-reports_v1beta/tsconfig.json @@ -0,0 +1,18 @@ +{ + "compilerOptions": { + "module": "node16", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "types": [] + }, + "files": [ + "index.d.ts" + ] +} diff --git a/types/gapi.client.migrationcenter-v1/.npmignore b/types/gapi.client.migrationcenter-v1/.npmignore new file mode 100644 index 00000000000000..93e307400a5456 --- /dev/null +++ b/types/gapi.client.migrationcenter-v1/.npmignore @@ -0,0 +1,5 @@ +* +!**/*.d.ts +!**/*.d.cts +!**/*.d.mts +!**/*.d.*.ts diff --git a/types/gapi.client.migrationcenter-v1/index.d.ts b/types/gapi.client.migrationcenter-v1/index.d.ts new file mode 100644 index 00000000000000..ba703949699bab --- /dev/null +++ b/types/gapi.client.migrationcenter-v1/index.d.ts @@ -0,0 +1,4 @@ +// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator +// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new + +/// diff --git a/types/gapi.client.migrationcenter-v1/package.json b/types/gapi.client.migrationcenter-v1/package.json new file mode 100644 index 00000000000000..f9417021acea8f --- /dev/null +++ b/types/gapi.client.migrationcenter-v1/package.json @@ -0,0 +1,30 @@ +{ + "private": true, + "name": "@types/gapi.client.migrationcenter-v1", + "version": "0.0.9999", + "nonNpm": true, + "nonNpmDescription": "Migration Center API v1", + "projects": [ + "https://cloud.google.com/migration-center" + ], + "dependencies": { + "@maxim_mazurok/gapi.client.migrationcenter-v1": "latest" + }, + "devDependencies": { + "@types/gapi.client.migrationcenter-v1": "workspace:." + }, + "owners": [ + { + "name": "Maxim Mazurok", + "githubUsername": "Maxim-Mazurok" + }, + { + "name": "Nick Amoscato", + "githubUsername": "namoscato" + }, + { + "name": "Declan Vong", + "githubUsername": "declanvong" + } + ] +} diff --git a/types/gapi.client.migrationcenter-v1/tsconfig.json b/types/gapi.client.migrationcenter-v1/tsconfig.json new file mode 100644 index 00000000000000..0a036c4d046ec9 --- /dev/null +++ b/types/gapi.client.migrationcenter-v1/tsconfig.json @@ -0,0 +1,18 @@ +{ + "compilerOptions": { + "module": "node16", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "types": [] + }, + "files": [ + "index.d.ts" + ] +} diff --git a/types/gapi.client.mybusinessbusinesscalls-v1/index.d.ts b/types/gapi.client.mybusinessbusinesscalls-v1/index.d.ts deleted file mode 100644 index 51c75e4b17ed42..00000000000000 --- a/types/gapi.client.mybusinessbusinesscalls-v1/index.d.ts +++ /dev/null @@ -1,4 +0,0 @@ -// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator -// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new - -/// diff --git a/types/gapi.client.places-v1/.npmignore b/types/gapi.client.places-v1/.npmignore new file mode 100644 index 00000000000000..93e307400a5456 --- /dev/null +++ b/types/gapi.client.places-v1/.npmignore @@ -0,0 +1,5 @@ +* +!**/*.d.ts +!**/*.d.cts +!**/*.d.mts +!**/*.d.*.ts diff --git a/types/gapi.client.places-v1/index.d.ts b/types/gapi.client.places-v1/index.d.ts new file mode 100644 index 00000000000000..88795e332199ee --- /dev/null +++ b/types/gapi.client.places-v1/index.d.ts @@ -0,0 +1,4 @@ +// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator +// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new + +/// diff --git a/types/gapi.client.gameservices-v1/package.json b/types/gapi.client.places-v1/package.json similarity index 63% rename from types/gapi.client.gameservices-v1/package.json rename to types/gapi.client.places-v1/package.json index 133dcc618b85ca..a5c5534bde3356 100644 --- a/types/gapi.client.gameservices-v1/package.json +++ b/types/gapi.client.places-v1/package.json @@ -1,17 +1,17 @@ { "private": true, - "name": "@types/gapi.client.gameservices-v1", + "name": "@types/gapi.client.places-v1", "version": "0.0.9999", "nonNpm": true, - "nonNpmDescription": "Game Services API v1", + "nonNpmDescription": "Places API (New) v1", "projects": [ - "https://cloud.google.com/solutions/gaming/" + "https://mapsplatform.google.com/maps-products/#places-section" ], "dependencies": { - "@maxim_mazurok/gapi.client.gameservices-v1": "latest" + "@maxim_mazurok/gapi.client.places-v1": "latest" }, "devDependencies": { - "@types/gapi.client.gameservices-v1": "workspace:." + "@types/gapi.client.places-v1": "workspace:." }, "owners": [ { diff --git a/types/gapi.client.places-v1/tsconfig.json b/types/gapi.client.places-v1/tsconfig.json new file mode 100644 index 00000000000000..0a036c4d046ec9 --- /dev/null +++ b/types/gapi.client.places-v1/tsconfig.json @@ -0,0 +1,18 @@ +{ + "compilerOptions": { + "module": "node16", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "types": [] + }, + "files": [ + "index.d.ts" + ] +} diff --git a/types/gapi.client.playgrouping-v1alpha1/.npmignore b/types/gapi.client.playgrouping-v1alpha1/.npmignore new file mode 100644 index 00000000000000..93e307400a5456 --- /dev/null +++ b/types/gapi.client.playgrouping-v1alpha1/.npmignore @@ -0,0 +1,5 @@ +* +!**/*.d.ts +!**/*.d.cts +!**/*.d.mts +!**/*.d.*.ts diff --git a/types/gapi.client.playgrouping-v1alpha1/index.d.ts b/types/gapi.client.playgrouping-v1alpha1/index.d.ts new file mode 100644 index 00000000000000..0ccdf5730b7b71 --- /dev/null +++ b/types/gapi.client.playgrouping-v1alpha1/index.d.ts @@ -0,0 +1,4 @@ +// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator +// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new + +/// diff --git a/types/gapi.client.playgrouping-v1alpha1/package.json b/types/gapi.client.playgrouping-v1alpha1/package.json new file mode 100644 index 00000000000000..381b961163440c --- /dev/null +++ b/types/gapi.client.playgrouping-v1alpha1/package.json @@ -0,0 +1,30 @@ +{ + "private": true, + "name": "@types/gapi.client.playgrouping-v1alpha1", + "version": "0.0.9999", + "nonNpm": true, + "nonNpmDescription": "Google Play Grouping API v1alpha1", + "projects": [ + "https://cloud.google.com/playgrouping/" + ], + "dependencies": { + "@maxim_mazurok/gapi.client.playgrouping-v1alpha1": "latest" + }, + "devDependencies": { + "@types/gapi.client.playgrouping-v1alpha1": "workspace:." + }, + "owners": [ + { + "name": "Maxim Mazurok", + "githubUsername": "Maxim-Mazurok" + }, + { + "name": "Nick Amoscato", + "githubUsername": "namoscato" + }, + { + "name": "Declan Vong", + "githubUsername": "declanvong" + } + ] +} diff --git a/types/gapi.client.playgrouping-v1alpha1/tsconfig.json b/types/gapi.client.playgrouping-v1alpha1/tsconfig.json new file mode 100644 index 00000000000000..0a036c4d046ec9 --- /dev/null +++ b/types/gapi.client.playgrouping-v1alpha1/tsconfig.json @@ -0,0 +1,18 @@ +{ + "compilerOptions": { + "module": "node16", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "types": [] + }, + "files": [ + "index.d.ts" + ] +} diff --git a/types/gapi.client.pollen-v1/.npmignore b/types/gapi.client.pollen-v1/.npmignore new file mode 100644 index 00000000000000..93e307400a5456 --- /dev/null +++ b/types/gapi.client.pollen-v1/.npmignore @@ -0,0 +1,5 @@ +* +!**/*.d.ts +!**/*.d.cts +!**/*.d.mts +!**/*.d.*.ts diff --git a/types/gapi.client.pollen-v1/index.d.ts b/types/gapi.client.pollen-v1/index.d.ts new file mode 100644 index 00000000000000..af805932fd1a6a --- /dev/null +++ b/types/gapi.client.pollen-v1/index.d.ts @@ -0,0 +1,4 @@ +// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator +// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new + +/// diff --git a/types/gapi.client.pollen-v1/package.json b/types/gapi.client.pollen-v1/package.json new file mode 100644 index 00000000000000..ffb8f1c5db9b8c --- /dev/null +++ b/types/gapi.client.pollen-v1/package.json @@ -0,0 +1,30 @@ +{ + "private": true, + "name": "@types/gapi.client.pollen-v1", + "version": "0.0.9999", + "nonNpm": true, + "nonNpmDescription": "Pollen API v1", + "projects": [ + "https://developers.google.com/maps/documentation/pollen" + ], + "dependencies": { + "@maxim_mazurok/gapi.client.pollen-v1": "latest" + }, + "devDependencies": { + "@types/gapi.client.pollen-v1": "workspace:." + }, + "owners": [ + { + "name": "Maxim Mazurok", + "githubUsername": "Maxim-Mazurok" + }, + { + "name": "Nick Amoscato", + "githubUsername": "namoscato" + }, + { + "name": "Declan Vong", + "githubUsername": "declanvong" + } + ] +} diff --git a/types/gapi.client.pollen-v1/tsconfig.json b/types/gapi.client.pollen-v1/tsconfig.json new file mode 100644 index 00000000000000..0a036c4d046ec9 --- /dev/null +++ b/types/gapi.client.pollen-v1/tsconfig.json @@ -0,0 +1,18 @@ +{ + "compilerOptions": { + "module": "node16", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "types": [] + }, + "files": [ + "index.d.ts" + ] +} diff --git a/types/gapi.client.publicca-v1/.npmignore b/types/gapi.client.publicca-v1/.npmignore new file mode 100644 index 00000000000000..93e307400a5456 --- /dev/null +++ b/types/gapi.client.publicca-v1/.npmignore @@ -0,0 +1,5 @@ +* +!**/*.d.ts +!**/*.d.cts +!**/*.d.mts +!**/*.d.*.ts diff --git a/types/gapi.client.publicca-v1/index.d.ts b/types/gapi.client.publicca-v1/index.d.ts new file mode 100644 index 00000000000000..c0c48422d66d3b --- /dev/null +++ b/types/gapi.client.publicca-v1/index.d.ts @@ -0,0 +1,4 @@ +// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator +// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new + +/// diff --git a/types/gapi.client.publicca-v1/package.json b/types/gapi.client.publicca-v1/package.json new file mode 100644 index 00000000000000..761864ce9b1043 --- /dev/null +++ b/types/gapi.client.publicca-v1/package.json @@ -0,0 +1,30 @@ +{ + "private": true, + "name": "@types/gapi.client.publicca-v1", + "version": "0.0.9999", + "nonNpm": true, + "nonNpmDescription": "Public Certificate Authority API v1", + "projects": [ + "https://cloud.google.com/public-certificate-authority/docs" + ], + "dependencies": { + "@maxim_mazurok/gapi.client.publicca-v1": "latest" + }, + "devDependencies": { + "@types/gapi.client.publicca-v1": "workspace:." + }, + "owners": [ + { + "name": "Maxim Mazurok", + "githubUsername": "Maxim-Mazurok" + }, + { + "name": "Nick Amoscato", + "githubUsername": "namoscato" + }, + { + "name": "Declan Vong", + "githubUsername": "declanvong" + } + ] +} diff --git a/types/gapi.client.publicca-v1/tsconfig.json b/types/gapi.client.publicca-v1/tsconfig.json new file mode 100644 index 00000000000000..0a036c4d046ec9 --- /dev/null +++ b/types/gapi.client.publicca-v1/tsconfig.json @@ -0,0 +1,18 @@ +{ + "compilerOptions": { + "module": "node16", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "types": [] + }, + "files": [ + "index.d.ts" + ] +} diff --git a/types/gapi.client.rapidmigrationassessment-v1/.npmignore b/types/gapi.client.rapidmigrationassessment-v1/.npmignore new file mode 100644 index 00000000000000..93e307400a5456 --- /dev/null +++ b/types/gapi.client.rapidmigrationassessment-v1/.npmignore @@ -0,0 +1,5 @@ +* +!**/*.d.ts +!**/*.d.cts +!**/*.d.mts +!**/*.d.*.ts diff --git a/types/gapi.client.rapidmigrationassessment-v1/index.d.ts b/types/gapi.client.rapidmigrationassessment-v1/index.d.ts new file mode 100644 index 00000000000000..7822a8461c36f0 --- /dev/null +++ b/types/gapi.client.rapidmigrationassessment-v1/index.d.ts @@ -0,0 +1,4 @@ +// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator +// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new + +/// diff --git a/types/gapi.client.rapidmigrationassessment-v1/package.json b/types/gapi.client.rapidmigrationassessment-v1/package.json new file mode 100644 index 00000000000000..86c5df395358cb --- /dev/null +++ b/types/gapi.client.rapidmigrationassessment-v1/package.json @@ -0,0 +1,30 @@ +{ + "private": true, + "name": "@types/gapi.client.rapidmigrationassessment-v1", + "version": "0.0.9999", + "nonNpm": true, + "nonNpmDescription": "Rapid Migration Assessment API v1", + "projects": [ + "https://cloud.google.com/migration-center" + ], + "dependencies": { + "@maxim_mazurok/gapi.client.rapidmigrationassessment-v1": "latest" + }, + "devDependencies": { + "@types/gapi.client.rapidmigrationassessment-v1": "workspace:." + }, + "owners": [ + { + "name": "Maxim Mazurok", + "githubUsername": "Maxim-Mazurok" + }, + { + "name": "Nick Amoscato", + "githubUsername": "namoscato" + }, + { + "name": "Declan Vong", + "githubUsername": "declanvong" + } + ] +} diff --git a/types/gapi.client.rapidmigrationassessment-v1/tsconfig.json b/types/gapi.client.rapidmigrationassessment-v1/tsconfig.json new file mode 100644 index 00000000000000..0a036c4d046ec9 --- /dev/null +++ b/types/gapi.client.rapidmigrationassessment-v1/tsconfig.json @@ -0,0 +1,18 @@ +{ + "compilerOptions": { + "module": "node16", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "types": [] + }, + "files": [ + "index.d.ts" + ] +} diff --git a/types/gapi.client.realtimebidding-v1alpha/index.d.ts b/types/gapi.client.realtimebidding-v1alpha/index.d.ts deleted file mode 100644 index e358068b8b2e11..00000000000000 --- a/types/gapi.client.realtimebidding-v1alpha/index.d.ts +++ /dev/null @@ -1,4 +0,0 @@ -// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator -// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new - -/// diff --git a/types/gapi.client.retail-v2/package.json b/types/gapi.client.retail-v2/package.json index 2713d4455b2859..1426e111a96d00 100644 --- a/types/gapi.client.retail-v2/package.json +++ b/types/gapi.client.retail-v2/package.json @@ -3,7 +3,7 @@ "name": "@types/gapi.client.retail-v2", "version": "0.0.9999", "nonNpm": true, - "nonNpmDescription": "Retail API v2", + "nonNpmDescription": "Vertex AI Search for Retail API v2", "projects": [ "https://cloud.google.com/recommendations" ], diff --git a/types/gapi.client.retail-v2alpha/package.json b/types/gapi.client.retail-v2alpha/package.json index 31666858692ef9..b06ebcf7090e54 100644 --- a/types/gapi.client.retail-v2alpha/package.json +++ b/types/gapi.client.retail-v2alpha/package.json @@ -3,7 +3,7 @@ "name": "@types/gapi.client.retail-v2alpha", "version": "0.0.9999", "nonNpm": true, - "nonNpmDescription": "Retail API v2alpha", + "nonNpmDescription": "Vertex AI Search for Retail API v2alpha", "projects": [ "https://cloud.google.com/recommendations" ], diff --git a/types/gapi.client.retail-v2beta/package.json b/types/gapi.client.retail-v2beta/package.json index 257c1a7c0963bf..afe1d3cafcf24d 100644 --- a/types/gapi.client.retail-v2beta/package.json +++ b/types/gapi.client.retail-v2beta/package.json @@ -3,7 +3,7 @@ "name": "@types/gapi.client.retail-v2beta", "version": "0.0.9999", "nonNpm": true, - "nonNpmDescription": "Retail API v2beta", + "nonNpmDescription": "Vertex AI Search for Retail API v2beta", "projects": [ "https://cloud.google.com/recommendations" ], diff --git a/types/gapi.client.safebrowsing-v5/.npmignore b/types/gapi.client.safebrowsing-v5/.npmignore new file mode 100644 index 00000000000000..93e307400a5456 --- /dev/null +++ b/types/gapi.client.safebrowsing-v5/.npmignore @@ -0,0 +1,5 @@ +* +!**/*.d.ts +!**/*.d.cts +!**/*.d.mts +!**/*.d.*.ts diff --git a/types/gapi.client.safebrowsing-v5/index.d.ts b/types/gapi.client.safebrowsing-v5/index.d.ts new file mode 100644 index 00000000000000..64c0aa36b22a6f --- /dev/null +++ b/types/gapi.client.safebrowsing-v5/index.d.ts @@ -0,0 +1,4 @@ +// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator +// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new + +/// diff --git a/types/gapi.client.safebrowsing-v5/package.json b/types/gapi.client.safebrowsing-v5/package.json new file mode 100644 index 00000000000000..e441130a49122c --- /dev/null +++ b/types/gapi.client.safebrowsing-v5/package.json @@ -0,0 +1,30 @@ +{ + "private": true, + "name": "@types/gapi.client.safebrowsing-v5", + "version": "0.0.9999", + "nonNpm": true, + "nonNpmDescription": "Safe Browsing API v5", + "projects": [ + "https://developers.google.com/safe-browsing/" + ], + "dependencies": { + "@maxim_mazurok/gapi.client.safebrowsing-v5": "latest" + }, + "devDependencies": { + "@types/gapi.client.safebrowsing-v5": "workspace:." + }, + "owners": [ + { + "name": "Maxim Mazurok", + "githubUsername": "Maxim-Mazurok" + }, + { + "name": "Nick Amoscato", + "githubUsername": "namoscato" + }, + { + "name": "Declan Vong", + "githubUsername": "declanvong" + } + ] +} diff --git a/types/gapi.client.safebrowsing-v5/tsconfig.json b/types/gapi.client.safebrowsing-v5/tsconfig.json new file mode 100644 index 00000000000000..0a036c4d046ec9 --- /dev/null +++ b/types/gapi.client.safebrowsing-v5/tsconfig.json @@ -0,0 +1,18 @@ +{ + "compilerOptions": { + "module": "node16", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "types": [] + }, + "files": [ + "index.d.ts" + ] +} diff --git a/types/gapi.client.secretmanager-v1beta2/.npmignore b/types/gapi.client.secretmanager-v1beta2/.npmignore new file mode 100644 index 00000000000000..93e307400a5456 --- /dev/null +++ b/types/gapi.client.secretmanager-v1beta2/.npmignore @@ -0,0 +1,5 @@ +* +!**/*.d.ts +!**/*.d.cts +!**/*.d.mts +!**/*.d.*.ts diff --git a/types/gapi.client.secretmanager-v1beta2/index.d.ts b/types/gapi.client.secretmanager-v1beta2/index.d.ts new file mode 100644 index 00000000000000..8b7126acdfee66 --- /dev/null +++ b/types/gapi.client.secretmanager-v1beta2/index.d.ts @@ -0,0 +1,4 @@ +// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator +// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new + +/// diff --git a/types/gapi.client.secretmanager-v1beta2/package.json b/types/gapi.client.secretmanager-v1beta2/package.json new file mode 100644 index 00000000000000..657b03a206e774 --- /dev/null +++ b/types/gapi.client.secretmanager-v1beta2/package.json @@ -0,0 +1,30 @@ +{ + "private": true, + "name": "@types/gapi.client.secretmanager-v1beta2", + "version": "0.0.9999", + "nonNpm": true, + "nonNpmDescription": "Secret Manager API v1beta2", + "projects": [ + "https://cloud.google.com/secret-manager/" + ], + "dependencies": { + "@maxim_mazurok/gapi.client.secretmanager-v1beta2": "latest" + }, + "devDependencies": { + "@types/gapi.client.secretmanager-v1beta2": "workspace:." + }, + "owners": [ + { + "name": "Maxim Mazurok", + "githubUsername": "Maxim-Mazurok" + }, + { + "name": "Nick Amoscato", + "githubUsername": "namoscato" + }, + { + "name": "Declan Vong", + "githubUsername": "declanvong" + } + ] +} diff --git a/types/gapi.client.secretmanager-v1beta2/tsconfig.json b/types/gapi.client.secretmanager-v1beta2/tsconfig.json new file mode 100644 index 00000000000000..0a036c4d046ec9 --- /dev/null +++ b/types/gapi.client.secretmanager-v1beta2/tsconfig.json @@ -0,0 +1,18 @@ +{ + "compilerOptions": { + "module": "node16", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "types": [] + }, + "files": [ + "index.d.ts" + ] +} diff --git a/types/gapi.client.solar-v1/.npmignore b/types/gapi.client.solar-v1/.npmignore new file mode 100644 index 00000000000000..93e307400a5456 --- /dev/null +++ b/types/gapi.client.solar-v1/.npmignore @@ -0,0 +1,5 @@ +* +!**/*.d.ts +!**/*.d.cts +!**/*.d.mts +!**/*.d.*.ts diff --git a/types/gapi.client.solar-v1/index.d.ts b/types/gapi.client.solar-v1/index.d.ts new file mode 100644 index 00000000000000..0e15821609e6e4 --- /dev/null +++ b/types/gapi.client.solar-v1/index.d.ts @@ -0,0 +1,4 @@ +// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator +// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new + +/// diff --git a/types/gapi.client.solar-v1/package.json b/types/gapi.client.solar-v1/package.json new file mode 100644 index 00000000000000..a272d69fdff550 --- /dev/null +++ b/types/gapi.client.solar-v1/package.json @@ -0,0 +1,30 @@ +{ + "private": true, + "name": "@types/gapi.client.solar-v1", + "version": "0.0.9999", + "nonNpm": true, + "nonNpmDescription": "Solar API v1", + "projects": [ + "https://developers.google.com/maps/documentation/solar" + ], + "dependencies": { + "@maxim_mazurok/gapi.client.solar-v1": "latest" + }, + "devDependencies": { + "@types/gapi.client.solar-v1": "workspace:." + }, + "owners": [ + { + "name": "Maxim Mazurok", + "githubUsername": "Maxim-Mazurok" + }, + { + "name": "Nick Amoscato", + "githubUsername": "namoscato" + }, + { + "name": "Declan Vong", + "githubUsername": "declanvong" + } + ] +} diff --git a/types/gapi.client.solar-v1/tsconfig.json b/types/gapi.client.solar-v1/tsconfig.json new file mode 100644 index 00000000000000..0a036c4d046ec9 --- /dev/null +++ b/types/gapi.client.solar-v1/tsconfig.json @@ -0,0 +1,18 @@ +{ + "compilerOptions": { + "module": "node16", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "types": [] + }, + "files": [ + "index.d.ts" + ] +} diff --git a/types/gapi.client.sourcerepo-v1/index.d.ts b/types/gapi.client.sourcerepo-v1/index.d.ts deleted file mode 100644 index baa099a8fb5827..00000000000000 --- a/types/gapi.client.sourcerepo-v1/index.d.ts +++ /dev/null @@ -1,4 +0,0 @@ -// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator -// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new - -/// diff --git a/types/gapi.client.testing-v1/package.json b/types/gapi.client.testing-v1/package.json index 31d18d7ac9d3ca..1359ccdadaf297 100644 --- a/types/gapi.client.testing-v1/package.json +++ b/types/gapi.client.testing-v1/package.json @@ -5,7 +5,7 @@ "nonNpm": true, "nonNpmDescription": "Cloud Testing API v1", "projects": [ - "https://developers.google.com/cloud-test-lab/" + "https://firebase.google.com/docs/test-lab/" ], "dependencies": { "@maxim_mazurok/gapi.client.testing-v1": "latest" diff --git a/types/gapi.client.trafficdirector-v3/.npmignore b/types/gapi.client.trafficdirector-v3/.npmignore new file mode 100644 index 00000000000000..93e307400a5456 --- /dev/null +++ b/types/gapi.client.trafficdirector-v3/.npmignore @@ -0,0 +1,5 @@ +* +!**/*.d.ts +!**/*.d.cts +!**/*.d.mts +!**/*.d.*.ts diff --git a/types/gapi.client.trafficdirector-v3/index.d.ts b/types/gapi.client.trafficdirector-v3/index.d.ts new file mode 100644 index 00000000000000..aa0c975e1ad68f --- /dev/null +++ b/types/gapi.client.trafficdirector-v3/index.d.ts @@ -0,0 +1,4 @@ +// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator +// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new + +/// diff --git a/types/gapi.client.trafficdirector-v3/package.json b/types/gapi.client.trafficdirector-v3/package.json new file mode 100644 index 00000000000000..7fd9d3b2ab0e71 --- /dev/null +++ b/types/gapi.client.trafficdirector-v3/package.json @@ -0,0 +1,30 @@ +{ + "private": true, + "name": "@types/gapi.client.trafficdirector-v3", + "version": "0.0.9999", + "nonNpm": true, + "nonNpmDescription": "Traffic Director API v3", + "projects": [ + "https://cloud.google.com/traffic-director" + ], + "dependencies": { + "@maxim_mazurok/gapi.client.trafficdirector-v3": "latest" + }, + "devDependencies": { + "@types/gapi.client.trafficdirector-v3": "workspace:." + }, + "owners": [ + { + "name": "Maxim Mazurok", + "githubUsername": "Maxim-Mazurok" + }, + { + "name": "Nick Amoscato", + "githubUsername": "namoscato" + }, + { + "name": "Declan Vong", + "githubUsername": "declanvong" + } + ] +} diff --git a/types/gapi.client.trafficdirector-v3/tsconfig.json b/types/gapi.client.trafficdirector-v3/tsconfig.json new file mode 100644 index 00000000000000..0a036c4d046ec9 --- /dev/null +++ b/types/gapi.client.trafficdirector-v3/tsconfig.json @@ -0,0 +1,18 @@ +{ + "compilerOptions": { + "module": "node16", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "types": [] + }, + "files": [ + "index.d.ts" + ] +} diff --git a/types/gapi.client.vmwareengine-v1/.npmignore b/types/gapi.client.vmwareengine-v1/.npmignore new file mode 100644 index 00000000000000..93e307400a5456 --- /dev/null +++ b/types/gapi.client.vmwareengine-v1/.npmignore @@ -0,0 +1,5 @@ +* +!**/*.d.ts +!**/*.d.cts +!**/*.d.mts +!**/*.d.*.ts diff --git a/types/gapi.client.vmwareengine-v1/index.d.ts b/types/gapi.client.vmwareengine-v1/index.d.ts new file mode 100644 index 00000000000000..f2c58fc2e1ec3b --- /dev/null +++ b/types/gapi.client.vmwareengine-v1/index.d.ts @@ -0,0 +1,4 @@ +// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator +// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new + +/// diff --git a/types/gapi.client.vmwareengine-v1/package.json b/types/gapi.client.vmwareengine-v1/package.json new file mode 100644 index 00000000000000..26155a96ff4518 --- /dev/null +++ b/types/gapi.client.vmwareengine-v1/package.json @@ -0,0 +1,30 @@ +{ + "private": true, + "name": "@types/gapi.client.vmwareengine-v1", + "version": "0.0.9999", + "nonNpm": true, + "nonNpmDescription": "VMware Engine API v1", + "projects": [ + "https://cloud.google.com/solutions/vmware-as-a-service" + ], + "dependencies": { + "@maxim_mazurok/gapi.client.vmwareengine-v1": "latest" + }, + "devDependencies": { + "@types/gapi.client.vmwareengine-v1": "workspace:." + }, + "owners": [ + { + "name": "Maxim Mazurok", + "githubUsername": "Maxim-Mazurok" + }, + { + "name": "Nick Amoscato", + "githubUsername": "namoscato" + }, + { + "name": "Declan Vong", + "githubUsername": "declanvong" + } + ] +} diff --git a/types/gapi.client.vmwareengine-v1/tsconfig.json b/types/gapi.client.vmwareengine-v1/tsconfig.json new file mode 100644 index 00000000000000..0a036c4d046ec9 --- /dev/null +++ b/types/gapi.client.vmwareengine-v1/tsconfig.json @@ -0,0 +1,18 @@ +{ + "compilerOptions": { + "module": "node16", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "types": [] + }, + "files": [ + "index.d.ts" + ] +} diff --git a/types/gapi.client.walletobjects-v1/.npmignore b/types/gapi.client.walletobjects-v1/.npmignore new file mode 100644 index 00000000000000..93e307400a5456 --- /dev/null +++ b/types/gapi.client.walletobjects-v1/.npmignore @@ -0,0 +1,5 @@ +* +!**/*.d.ts +!**/*.d.cts +!**/*.d.mts +!**/*.d.*.ts diff --git a/types/gapi.client.eventarc-v1beta1/index.d.ts b/types/gapi.client.walletobjects-v1/index.d.ts similarity index 78% rename from types/gapi.client.eventarc-v1beta1/index.d.ts rename to types/gapi.client.walletobjects-v1/index.d.ts index e23f5a858ee5f5..f1c69e5268615f 100644 --- a/types/gapi.client.eventarc-v1beta1/index.d.ts +++ b/types/gapi.client.walletobjects-v1/index.d.ts @@ -1,4 +1,4 @@ // Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator // In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new -/// +/// diff --git a/types/gapi.client.walletobjects-v1/package.json b/types/gapi.client.walletobjects-v1/package.json new file mode 100644 index 00000000000000..f22f798afd2635 --- /dev/null +++ b/types/gapi.client.walletobjects-v1/package.json @@ -0,0 +1,30 @@ +{ + "private": true, + "name": "@types/gapi.client.walletobjects-v1", + "version": "0.0.9999", + "nonNpm": true, + "nonNpmDescription": "Google Wallet API v1", + "projects": [ + "https://developers.google.com/pay/passes" + ], + "dependencies": { + "@maxim_mazurok/gapi.client.walletobjects-v1": "latest" + }, + "devDependencies": { + "@types/gapi.client.walletobjects-v1": "workspace:." + }, + "owners": [ + { + "name": "Maxim Mazurok", + "githubUsername": "Maxim-Mazurok" + }, + { + "name": "Nick Amoscato", + "githubUsername": "namoscato" + }, + { + "name": "Declan Vong", + "githubUsername": "declanvong" + } + ] +} diff --git a/types/gapi.client.walletobjects-v1/tsconfig.json b/types/gapi.client.walletobjects-v1/tsconfig.json new file mode 100644 index 00000000000000..0a036c4d046ec9 --- /dev/null +++ b/types/gapi.client.walletobjects-v1/tsconfig.json @@ -0,0 +1,18 @@ +{ + "compilerOptions": { + "module": "node16", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "types": [] + }, + "files": [ + "index.d.ts" + ] +} diff --git a/types/gapi.client.workspaceevents-v1/.npmignore b/types/gapi.client.workspaceevents-v1/.npmignore new file mode 100644 index 00000000000000..93e307400a5456 --- /dev/null +++ b/types/gapi.client.workspaceevents-v1/.npmignore @@ -0,0 +1,5 @@ +* +!**/*.d.ts +!**/*.d.cts +!**/*.d.mts +!**/*.d.*.ts diff --git a/types/gapi.client.workspaceevents-v1/index.d.ts b/types/gapi.client.workspaceevents-v1/index.d.ts new file mode 100644 index 00000000000000..c58bc1adee602f --- /dev/null +++ b/types/gapi.client.workspaceevents-v1/index.d.ts @@ -0,0 +1,4 @@ +// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator +// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new + +/// diff --git a/types/gapi.client.workspaceevents-v1/package.json b/types/gapi.client.workspaceevents-v1/package.json new file mode 100644 index 00000000000000..f6a0b658968809 --- /dev/null +++ b/types/gapi.client.workspaceevents-v1/package.json @@ -0,0 +1,30 @@ +{ + "private": true, + "name": "@types/gapi.client.workspaceevents-v1", + "version": "0.0.9999", + "nonNpm": true, + "nonNpmDescription": "Google Workspace Events API v1", + "projects": [ + "https://developers.google.com/workspace/events" + ], + "dependencies": { + "@maxim_mazurok/gapi.client.workspaceevents-v1": "latest" + }, + "devDependencies": { + "@types/gapi.client.workspaceevents-v1": "workspace:." + }, + "owners": [ + { + "name": "Maxim Mazurok", + "githubUsername": "Maxim-Mazurok" + }, + { + "name": "Nick Amoscato", + "githubUsername": "namoscato" + }, + { + "name": "Declan Vong", + "githubUsername": "declanvong" + } + ] +} diff --git a/types/gapi.client.workspaceevents-v1/tsconfig.json b/types/gapi.client.workspaceevents-v1/tsconfig.json new file mode 100644 index 00000000000000..0a036c4d046ec9 --- /dev/null +++ b/types/gapi.client.workspaceevents-v1/tsconfig.json @@ -0,0 +1,18 @@ +{ + "compilerOptions": { + "module": "node16", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "types": [] + }, + "files": [ + "index.d.ts" + ] +} diff --git a/types/gapi.client.workstations-v1/.npmignore b/types/gapi.client.workstations-v1/.npmignore new file mode 100644 index 00000000000000..93e307400a5456 --- /dev/null +++ b/types/gapi.client.workstations-v1/.npmignore @@ -0,0 +1,5 @@ +* +!**/*.d.ts +!**/*.d.cts +!**/*.d.mts +!**/*.d.*.ts diff --git a/types/gapi.client.workstations-v1/index.d.ts b/types/gapi.client.workstations-v1/index.d.ts new file mode 100644 index 00000000000000..bc84fa9f0b70a5 --- /dev/null +++ b/types/gapi.client.workstations-v1/index.d.ts @@ -0,0 +1,4 @@ +// Referenced type definitions are generated by https://github.com/Maxim-Mazurok/google-api-typings-generator +// In case of any problems please open issue in https://github.com/Maxim-Mazurok/google-api-typings-generator/issues/new + +/// diff --git a/types/gapi.client.genomics-v2alpha1/package.json b/types/gapi.client.workstations-v1/package.json similarity index 63% rename from types/gapi.client.genomics-v2alpha1/package.json rename to types/gapi.client.workstations-v1/package.json index a9017b7560d420..4190b732e6b577 100644 --- a/types/gapi.client.genomics-v2alpha1/package.json +++ b/types/gapi.client.workstations-v1/package.json @@ -1,17 +1,17 @@ { "private": true, - "name": "@types/gapi.client.genomics-v2alpha1", + "name": "@types/gapi.client.workstations-v1", "version": "0.0.9999", "nonNpm": true, - "nonNpmDescription": "Genomics API v2alpha1", + "nonNpmDescription": "Cloud Workstations API v1", "projects": [ - "https://cloud.google.com/genomics" + "https://cloud.google.com/workstations" ], "dependencies": { - "@maxim_mazurok/gapi.client.genomics-v2alpha1": "latest" + "@maxim_mazurok/gapi.client.workstations-v1": "latest" }, "devDependencies": { - "@types/gapi.client.genomics-v2alpha1": "workspace:." + "@types/gapi.client.workstations-v1": "workspace:." }, "owners": [ { diff --git a/types/gapi.client.workstations-v1/tsconfig.json b/types/gapi.client.workstations-v1/tsconfig.json new file mode 100644 index 00000000000000..0a036c4d046ec9 --- /dev/null +++ b/types/gapi.client.workstations-v1/tsconfig.json @@ -0,0 +1,18 @@ +{ + "compilerOptions": { + "module": "node16", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "types": [] + }, + "files": [ + "index.d.ts" + ] +} diff --git a/types/get-intrinsic/get-intrinsic-tests.ts b/types/get-intrinsic/get-intrinsic-tests.ts index 067e1236e7dbcd..fa1e714801711a 100644 --- a/types/get-intrinsic/get-intrinsic-tests.ts +++ b/types/get-intrinsic/get-intrinsic-tests.ts @@ -31,7 +31,7 @@ declare const boolean: boolean; GetIntrinsic('%ArrayBufferPrototype%'); // $ExpectType ArrayBuffer GetIntrinsic('%ArrayIteratorPrototype%'); // $ExpectType IterableIterator - GetIntrinsic('%AsyncFromSyncIteratorPrototype%'); // $ExpectType AsyncGenerator + GetIntrinsic('%AsyncFromSyncIteratorPrototype%'); // $ExpectType AsyncGenerator || AsyncGenerator GetIntrinsic('%AsyncFunction%'); // $ExpectType FunctionConstructor GetIntrinsic('%AsyncFunction.prototype%'); // $ExpectType Function @@ -39,7 +39,7 @@ declare const boolean: boolean; GetIntrinsic('%AsyncGenerator%'); // $ExpectType AsyncGeneratorFunction GetIntrinsic('%AsyncGeneratorFunction%'); // $ExpectType AsyncGeneratorFunctionConstructor - GetIntrinsic('%AsyncGeneratorPrototype%'); // $ExpectType AsyncGenerator + GetIntrinsic('%AsyncGeneratorPrototype%'); // $ExpectType AsyncGenerator || AsyncGenerator GetIntrinsic('%AsyncIteratorPrototype%'); // $ExpectType AsyncIterable GetIntrinsic('%Atomics%'); // $ExpectType Atomics @@ -95,7 +95,7 @@ declare const boolean: boolean; GetIntrinsic('%Generator%'); // $ExpectType GeneratorFunction GetIntrinsic('%GeneratorFunction%'); // $ExpectType GeneratorFunctionConstructor - GetIntrinsic('%GeneratorPrototype%'); // $ExpectType Generator + GetIntrinsic('%GeneratorPrototype%'); // $ExpectType Generator || Generator GetIntrinsic('%IteratorPrototype%'); // $ExpectType Iterable GetIntrinsic('%Int8Array%'); // $ExpectType Int8ArrayConstructor @@ -252,7 +252,7 @@ declare const boolean: boolean; GetIntrinsic('%ArrayBufferPrototype%', false); // $ExpectType ArrayBuffer GetIntrinsic('%ArrayIteratorPrototype%', false); // $ExpectType IterableIterator - GetIntrinsic('%AsyncFromSyncIteratorPrototype%', false); // $ExpectType AsyncGenerator + GetIntrinsic('%AsyncFromSyncIteratorPrototype%', false); // $ExpectType AsyncGenerator || AsyncGenerator GetIntrinsic('%AsyncFunction%', false); // $ExpectType FunctionConstructor GetIntrinsic('%AsyncFunction.prototype%', false); // $ExpectType Function @@ -260,7 +260,7 @@ declare const boolean: boolean; GetIntrinsic('%AsyncGenerator%', false); // $ExpectType AsyncGeneratorFunction GetIntrinsic('%AsyncGeneratorFunction%', false); // $ExpectType AsyncGeneratorFunctionConstructor - GetIntrinsic('%AsyncGeneratorPrototype%', false); // $ExpectType AsyncGenerator + GetIntrinsic('%AsyncGeneratorPrototype%', false); // $ExpectType AsyncGenerator || AsyncGenerator GetIntrinsic('%AsyncIteratorPrototype%', false); // $ExpectType AsyncIterable GetIntrinsic('%Atomics%', false); // $ExpectType Atomics @@ -310,7 +310,7 @@ declare const boolean: boolean; GetIntrinsic('%Generator%', false); // $ExpectType GeneratorFunction GetIntrinsic('%GeneratorFunction%', false); // $ExpectType GeneratorFunctionConstructor - GetIntrinsic('%GeneratorPrototype%', false); // $ExpectType Generator + GetIntrinsic('%GeneratorPrototype%', false); // $ExpectType Generator || Generator GetIntrinsic('%IteratorPrototype%', false); // $ExpectType Iterable GetIntrinsic('%Int8Array%', false); // $ExpectType Int8ArrayConstructor @@ -467,7 +467,7 @@ declare const boolean: boolean; GetIntrinsic('%ArrayBufferPrototype%', true); // $ExpectType ArrayBuffer | undefined GetIntrinsic('%ArrayIteratorPrototype%', true); // $ExpectType IterableIterator | undefined - GetIntrinsic('%AsyncFromSyncIteratorPrototype%', true); // $ExpectType AsyncGenerator | undefined + GetIntrinsic('%AsyncFromSyncIteratorPrototype%', true); // $ExpectType AsyncGenerator | undefined || AsyncGenerator | undefined GetIntrinsic('%AsyncFunction%', true); // $ExpectType FunctionConstructor | undefined GetIntrinsic('%AsyncFunction.prototype%', true); // $ExpectType Function | undefined @@ -475,7 +475,7 @@ declare const boolean: boolean; GetIntrinsic('%AsyncGenerator%', true); // $ExpectType AsyncGeneratorFunction | undefined GetIntrinsic('%AsyncGeneratorFunction%', true); // $ExpectType AsyncGeneratorFunctionConstructor | undefined - GetIntrinsic('%AsyncGeneratorPrototype%', true); // $ExpectType AsyncGenerator | undefined + GetIntrinsic('%AsyncGeneratorPrototype%', true); // $ExpectType AsyncGenerator | undefined || AsyncGenerator | undefined GetIntrinsic('%AsyncIteratorPrototype%', true); // $ExpectType AsyncIterable | undefined GetIntrinsic('%Atomics%', true); // $ExpectType Atomics | undefined @@ -525,7 +525,7 @@ declare const boolean: boolean; GetIntrinsic('%Generator%', true); // $ExpectType GeneratorFunction | undefined GetIntrinsic('%GeneratorFunction%', true); // $ExpectType GeneratorFunctionConstructor | undefined - GetIntrinsic('%GeneratorPrototype%', true); // $ExpectType Generator | undefined + GetIntrinsic('%GeneratorPrototype%', true); // $ExpectType Generator | undefined || Generator | undefined GetIntrinsic('%IteratorPrototype%', true); // $ExpectType Iterable | undefined GetIntrinsic('%Int8Array%', true); // $ExpectType Int8ArrayConstructor | undefined @@ -682,7 +682,7 @@ declare const boolean: boolean; GetIntrinsic('%ArrayBufferPrototype%', boolean); // $ExpectType ArrayBuffer | undefined GetIntrinsic('%ArrayIteratorPrototype%', boolean); // $ExpectType IterableIterator | undefined - GetIntrinsic('%AsyncFromSyncIteratorPrototype%', boolean); // $ExpectType AsyncGenerator | undefined + GetIntrinsic('%AsyncFromSyncIteratorPrototype%', boolean); // $ExpectType AsyncGenerator | undefined || AsyncGenerator | undefined GetIntrinsic('%AsyncFunction%', boolean); // $ExpectType FunctionConstructor | undefined GetIntrinsic('%AsyncFunction.prototype%', boolean); // $ExpectType Function | undefined @@ -690,7 +690,7 @@ declare const boolean: boolean; GetIntrinsic('%AsyncGenerator%', boolean); // $ExpectType AsyncGeneratorFunction | undefined GetIntrinsic('%AsyncGeneratorFunction%', boolean); // $ExpectType AsyncGeneratorFunctionConstructor | undefined - GetIntrinsic('%AsyncGeneratorPrototype%', boolean); // $ExpectType AsyncGenerator | undefined + GetIntrinsic('%AsyncGeneratorPrototype%', boolean); // $ExpectType AsyncGenerator | undefined || AsyncGenerator | undefined GetIntrinsic('%AsyncIteratorPrototype%', boolean); // $ExpectType AsyncIterable | undefined GetIntrinsic('%Atomics%', boolean); // $ExpectType Atomics | undefined @@ -740,7 +740,7 @@ declare const boolean: boolean; GetIntrinsic('%Generator%', boolean); // $ExpectType GeneratorFunction | undefined GetIntrinsic('%GeneratorFunction%', boolean); // $ExpectType GeneratorFunctionConstructor | undefined - GetIntrinsic('%GeneratorPrototype%', boolean); // $ExpectType Generator | undefined + GetIntrinsic('%GeneratorPrototype%', boolean); // $ExpectType Generator | undefined || Generator | undefined GetIntrinsic('%IteratorPrototype%', boolean); // $ExpectType Iterable | undefined GetIntrinsic('%Int8Array%', boolean); // $ExpectType Int8ArrayConstructor | undefined diff --git a/types/google-publisher-tag/google-publisher-tag-tests.ts b/types/google-publisher-tag/google-publisher-tag-tests.ts index bbf052470c3aea..467b16d0cdd244 100644 --- a/types/google-publisher-tag/google-publisher-tag-tests.ts +++ b/types/google-publisher-tag/google-publisher-tag-tests.ts @@ -1,5 +1,5 @@ -// Tests for Google Publisher Tag 1.20240219 -// Synced from: https://github.com/googleads/google-publisher-tag-types/commit/42bfb2b9b8d977aeafe03d51562dca96323f5f38 +// Tests for Google Publisher Tag 1.20240729 +// Synced from: https://github.com/googleads/google-publisher-tag-types/commit/1b9687184a46e7cf847a897b13539b78c3393305 // Test for googletag.cmd function test_googletag_cmd() { @@ -92,6 +92,15 @@ function test_googletag_companionAdsService_setRefreshUnfilledSlots() { googletag.companionAds().setRefreshUnfilledSlots(true); } +// Test for googletag.PrivacySettingsConfig.limitedAds +function test_googletag_privacySettingsConfig_limitedAds() { + // Manually enable limited ads serving. + // GPT must be loaded from the limited ads URL to configure this setting. + googletag.pubads().setPrivacySettings({ + limitedAds: true, + }); +} + // Test for googletag.PrivacySettingsConfig.trafficSource function test_googletag_privacySettingsConfig_trafficSource() { // Indicate requests represent organic traffic. @@ -593,7 +602,7 @@ function test_googletag_slot_getSlotElementId() { const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div")!.addService(googletag.pubads()); slot.getSlotElementId(); - // Returns 'div-1'. + // Returns 'div'. } // Test for googletag.Slot.setForceSafeFrame @@ -637,6 +646,18 @@ function test_googletag_config_adExpansionConfig() { }); } +// Test for googletag.config.PageSettingsConfig.adYield +function test_googletag_config_pageSettingsConfig_adYield() { + // Disable yielding. + googletag.setConfig({ adYield: "DISABLED" }); + + // Enable yielding for all slots. + googletag.setConfig({ adYield: "ENABLED_ALL_SLOTS" }); + + // Enable yielding only for slots outside of the viewport (default). + googletag.setConfig({ adYield: null }); +} + // Test for googletag.config.PrivacyTreatmentsConfig.treatments function test_googletag_config_privacyTreatmentsConfig_treatments() { // Disable personalization across the entire page. diff --git a/types/google-publisher-tag/index.d.ts b/types/google-publisher-tag/index.d.ts index 14fac9a58a3e8d..bb483edf84fe73 100644 --- a/types/google-publisher-tag/index.d.ts +++ b/types/google-publisher-tag/index.d.ts @@ -362,9 +362,31 @@ declare namespace googletag { /** * Enables serving to run in * [limited ads](https://support.google.com/admanager/answer/9882911) mode to - * aid in publisher regulatory compliance needs. When enabled, the GPT library - * itself may optionally be requested from a cookie-less, [limited ads + * aid in publisher regulatory compliance needs. + * + * You can instruct GPT to request limited ads in two ways: + * + * - Automatically, by using a signal from an + * [IAB TCF v2.0](https://iabeurope.eu/tcf-2-0/) consent management + * platform. + * - Manually, by setting the value of this field to `true`. + * + * Manually configuring limited ads is only possible when GPT is loaded from + * the [limited ads * URL](https://developers.google.com/publisher-tag/guides/general-best-practices#load_from_an_official_source). + * Attempting to modify this setting when GPT has been loaded from the + * standard URL will generate a [Publisher Console + * warning](http://developers.google.com/publisher-tag/guides/publisher-console-messages#147). + * + * Note that it is not necessary to manually enable limited ads when a CMP is + * in use. + * + * @example + * // Manually enable limited ads serving. + * // GPT must be loaded from the limited ads URL to configure this setting. + * googletag.pubads().setPrivacySettings({ + * limitedAds: true, + * }); * * @see [Display a limited ad](https://developers.google.com/publisher-tag/samples/display-limited-ad) */ @@ -1524,7 +1546,7 @@ declare namespace googletag { * .addService(googletag.pubads()); * * slot.getSlotElementId(); - * // Returns 'div-1'. + * // Returns 'div'. * * @return Slot `div` ID. */ @@ -1780,6 +1802,34 @@ declare namespace googletag { * Settings to control publisher provided signals (PPS). */ pps?: PublisherProvidedSignalsConfig | null; + + /** + * Setting to control whether GPT should yield the JS thread when + * rendering creatives. + * + * GPT will yield only for browsers that support the Scheduler.postTask + * API. + * + * Supported values: + * - `null` (default): GPT will yield the JS thread for slots outside of + * the viewport. + * - `ENABLED_ALL_SLOTS`: GPT will yield the JS thread for all slots + * regardless of whether the slot is within the viewport. + * - `DISABLED`: GPT will not yield the JS thread. + * + * @example + * // Disable yielding. + * googletag.setConfig({adYield: 'DISABLED'}); + * + * // Enable yielding for all slots. + * googletag.setConfig({adYield: 'ENABLED_ALL_SLOTS'}); + * + * // Enable yielding only for slots outside of the viewport (default). + * googletag.setConfig({adYield: null}); + * + * @see [Scheduler: postTask() method](https://developer.mozilla.org/docs/Web/API/Scheduler/postTask) + */ + adYield?: "DISABLED" | "ENABLED_ALL_SLOTS" | null; } /** @@ -2189,7 +2239,12 @@ declare namespace googletag { push(provider: SecureSignalProvider): void; /** - * Clears all cached signals from local storage. + * Clears all signals for all collectors from cache. + * + * Calling this method may reduce the likelihood of signals being included + * in ad requests for the current and potentially later page views. Due to + * this, it should only be called when meaningful state changes occur, + * such as events that indicate a new user (log in, log out, sign up, etc.). */ clearAllCache(): void; } diff --git a/types/google-publisher-tag/package.json b/types/google-publisher-tag/package.json index 61c81820dad492..780130ca807102 100644 --- a/types/google-publisher-tag/package.json +++ b/types/google-publisher-tag/package.json @@ -1,7 +1,7 @@ { "private": true, "name": "@types/google-publisher-tag", - "version": "1.20240219.9999", + "version": "1.20240729.9999", "nonNpm": true, "nonNpmDescription": "Google Publisher Tag", "projects": [ diff --git a/types/google.maps/google.maps-tests.ts b/types/google.maps/google.maps-tests.ts index 91f41d0bfbe1b6..aa42112a222809 100644 --- a/types/google.maps/google.maps-tests.ts +++ b/types/google.maps/google.maps-tests.ts @@ -1,3 +1,3 @@ // No tests required for generated types -// Synced from: https://github.com/googlemaps/js-types/commit/d76763332fe0e45c617d71b58c8882057650bb4f +// Synced from: https://github.com/googlemaps/js-types/commit/b9d6039db4fee2c90719e2eaa88b4a18fe664a16 google.maps.Map; diff --git a/types/google.maps/index.d.ts b/types/google.maps/index.d.ts index f90cec7a0f5890..dfb1c15546472d 100644 --- a/types/google.maps/index.d.ts +++ b/types/google.maps/index.d.ts @@ -1,7 +1,7 @@ // To report an issue with these types, please open a support ticket at: // https://issuetracker.google.com/savedsearches/558438 -// Google Maps JS API Version: 3.56 +// Google Maps JS API Version: 3.57 // tslint:disable:enforce-name-casing // tslint:disable:no-any // tslint:disable:interface-over-type-literal @@ -13,6 +13,24 @@ // Generated by an automated process. DO NOT EDIT! declare namespace google.maps { + /** + * Available only in the v=beta channel: https://goo.gle/3oAthT3. + * + * A relational description of a location. Includes a ranked set of nearby + * landmarks and the areas containing the target location. + */ + export interface AddressDescriptor { + /** + * A ranked list of containing or adjacent areas. The most useful + * (recognizable and precise) areas are ranked first. + */ + areas: google.maps.Area[]; + /** + * A ranked list of nearby landmarks. The most useful (recognizable and + * nearby) landmarks are ranked first. + */ + landmarks: google.maps.Landmark[]; + } /** * Animations that can be played on a marker. Use the {@link * google.maps.Marker.setAnimation} method on Marker or the {@link @@ -36,6 +54,32 @@ declare namespace google.maps { */ DROP = 1.0, } + /** + * Available only in the v=beta channel: https://goo.gle/3oAthT3. + * + * A place that is a small region, such as a neighborhood, sublocality, or + * large complex that contains the target location. + */ + export interface Area { + /** + * Defines the spatial relationship between the target location and the + * area. + */ + containment: google.maps.Containment; + /** + * The name for the area. + */ + display_name: string; + /** + * The language of the name for the area. + */ + display_name_language_code: string; + /** + * The Place ID of the underlying area. Can be used to resolve more + * information about the area through Place Details or Place ID Lookup. + */ + place_id: string; + } /** * A layer showing bike lanes and paths. * @@ -267,6 +311,30 @@ declare namespace google.maps { */ REQUIRED_AND_HIDES_OPTIONAL = 'REQUIRED_AND_HIDES_OPTIONAL', } + /** + * Available only in the v=beta channel: https://goo.gle/3oAthT3. + * + * An enum representing the spatial relationship between the area and the + * target location. + * + * Access by calling `const {Containment} = await + * google.maps.importLibrary("geocoding")`. See + * https://developers.google.com/maps/documentation/javascript/libraries. + */ + export enum Containment { + /** + * The target location is outside the area region, but close by. + */ + NEAR = 'NEAR', + /** + * The target location is within the area region, close to the edge. + */ + OUTSKIRTS = 'OUTSKIRTS', + /** + * The target location is within the area region, close to the center. + */ + WITHIN = 'WITHIN', + } /** * Identifiers used to specify the placement of controls on the map. Controls * are positioned relative to other controls in the same layout position. @@ -1710,6 +1778,21 @@ declare namespace google.maps { */ error: Error; } + /** + * Available only in the v=beta channel: https://goo.gle/3oAthT3. + * + * Extra computations to perform while completing a geocoding request. + * + * Access by calling `const {ExtraGeocodeComputation} = await + * google.maps.importLibrary("geocoding")`. See + * https://developers.google.com/maps/documentation/javascript/libraries. + */ + export enum ExtraGeocodeComputation { + /** + * Generate an address descriptor. + */ + ADDRESS_DESCRIPTORS = 'ADDRESS_DESCRIPTORS', + } /** * An interface representing a vector map tile feature. These are inputs to * the FeatureStyleFunction. Do not save a reference to a @@ -2022,6 +2105,18 @@ declare namespace google.maps { * and partial matching as other geocoding requests. Optional. */ componentRestrictions?: google.maps.GeocoderComponentRestrictions | null; + /** + * Available only in the v=beta channel: https://goo.gle/3oAthT3. + * A list of extra computations which may be used to complete the request. + * Note: These extra computations may return extra fields on the response. + */ + extraComputations?: google.maps.ExtraGeocodeComputation[]; + /** + * Fulfill the promise on a ZERO_RESULT status in the response. This may be + * desired because even with zero geocoding results there may still be + * additional response level fields returned. + */ + fulfillOnZeroResults?: boolean | null; /** * A language identifier for the language in which results should be * returned, when possible. See the GeocoderAddressComponents */ address_components: google.maps.GeocoderAddressComponent[]; + /** + * Available only in the v=beta channel: https://goo.gle/3oAthT3. + * A relational description of the location associated with this geocode. + * Includes a ranked set of nearby landmarks and the areas containing the + * target location. This will only be populated for forward geocoding and + * place ID lookup requests, only when {@link + * google.maps.ExtraGeocodeComputation.ADDRESS_DESCRIPTORS} is enabled, and + * only for certain localized places. + */ + address_descriptor?: google.maps.AddressDescriptor; /** * A string containing the human-readable address of this location. */ @@ -2163,9 +2280,12 @@ declare namespace google.maps { ZERO_RESULTS = 'ZERO_RESULTS', } export interface GeocodingLibrary { + Containment: typeof google.maps.Containment; + ExtraGeocodeComputation: typeof google.maps.ExtraGeocodeComputation; Geocoder: typeof google.maps.Geocoder; GeocoderLocationType: typeof google.maps.GeocoderLocationType; GeocoderStatus: typeof google.maps.GeocoderStatus; + SpatialRelationship: typeof google.maps.SpatialRelationship; } export interface GeometryLibrary { encoding: typeof google.maps.geometry.encoding; @@ -2451,8 +2571,14 @@ declare namespace google.maps { */ focus(): void; getContent(): string | Element | null | Text | undefined; + getHeaderContent(): string | Element | null | Text | undefined; + getHeaderDisabled(): boolean | undefined; getPosition(): google.maps.LatLng | null | undefined; getZIndex(): number; + /** + * Checks if the InfoWindow is open. + */ + isOpen: boolean; /** * Opens this InfoWindow on the given map. Optionally, an InfoWindow can be * associated with an anchor. In the core API, the only anchor is the Marker @@ -2487,6 +2613,16 @@ declare namespace google.maps { * @param content The content to be displayed by this InfoWindow. */ setContent(content?: string | Element | null | Text): void; + /** + * @param headerContent The header content to be displayed by this + * InfoWindow. See {@link google.maps.InfoWindowOptions.headerContent}. + */ + setHeaderContent(headerContent?: string | Element | null | Text): void; + /** + * @param headerDisabled Specifies whether to disable the whole header row. + * See {@link google.maps.InfoWindowOptions.headerDisabled}. + */ + setHeaderDisabled(headerDisabled?: boolean | null): void; setOptions(options?: google.maps.InfoWindowOptions | null): void; /** * @param position The LatLng position at which to display this InfoWindow. @@ -2552,20 +2688,18 @@ declare namespace google.maps { */ disableAutoPan?: boolean | null; /** - * Available only in the v=beta channel: https://goo.gle/3oAthT3. * The content to display in the InfoWindow header row. This can be an HTML - * element, or a string containing HTML. The InfoWindow will be sized + * element, or a string of plain text. The InfoWindow will be sized * according to the content. To set an explicit size for the header content, * set headerContent to be a HTML element with that size. */ - headerContent?: string|Element|Text|null; + headerContent?: string | Element | Text | null; /** - * Available only in the v=beta channel: https://goo.gle/3oAthT3. * Disables the whole header row in the InfoWindow. When set to true, the * header will be removed so that the header content and the close button * will be hidden. */ - headerDisabled?: boolean|null; + headerDisabled?: boolean | null; /** * Maximum width of the InfoWindow, regardless of content's width. This * value is only considered if it is set before a call to @@ -2873,6 +3007,50 @@ declare namespace google.maps { */ pixelOffset: google.maps.Size | null; } + /** + * Available only in the v=beta channel: https://goo.gle/3oAthT3. + * + * A place that represents a point of reference for the address. + */ + export interface Landmark { + /** + * The name for the landmark. + */ + display_name: string; + /** + * The language of the name for the landmark. + */ + display_name_language_code: string; + /** + * The Place ID of the underlying establishment serving as the landmark. Can + * be used to resolve more information about the landmark through Place + * Details or Place Id Lookup. + */ + place_id: string; + /** + * Defines the spatial relationship between the target location and the + * landmark. + */ + spatial_relationship: google.maps.SpatialRelationship; + /** + * The straight line distance between the target location and the landmark. + */ + straight_line_distance_meters: number; + /** + * The travel distance along the road network between the target location + * and the landmark. This can be unpopulated if the landmark is disconnected + * from the part of the road network the target is closest to OR if the + * target location was not actually considered to be on the road network. + */ + travel_distance_meters?: number; + /** + * One or more values indicating the type of the returned result. Please see + * Types + * for more detail. + */ + types: string[]; + } /** * A LatLng is a point in geographical coordinates: latitude and * longitude.
  • Latitude ranges between -90 and 90 degrees, @@ -5278,7 +5456,16 @@ declare namespace google.maps { Autocomplete: typeof google.maps.places.Autocomplete; AutocompleteService: typeof google.maps.places.AutocompleteService; AutocompleteSessionToken: typeof google.maps.places.AutocompleteSessionToken; + AutocompleteSuggestion: typeof google.maps.places.AutocompleteSuggestion; BusinessStatus: typeof google.maps.places.BusinessStatus; + ConnectorAggregation: typeof google.maps.places.ConnectorAggregation; + EVChargeOptions: typeof google.maps.places.EVChargeOptions; + EVConnectorType: typeof google.maps.places.EVConnectorType; + FormattableText: typeof google.maps.places.FormattableText; + FuelOptions: typeof google.maps.places.FuelOptions; + FuelPrice: typeof google.maps.places.FuelPrice; + FuelType: typeof google.maps.places.FuelType; + Money: typeof google.maps.places.Money; OpeningHours: typeof google.maps.places.OpeningHours; OpeningHoursPeriod: typeof google.maps.places.OpeningHoursPeriod; OpeningHoursPoint: typeof google.maps.places.OpeningHoursPoint; @@ -5286,6 +5473,7 @@ declare namespace google.maps { PaymentOptions: typeof google.maps.places.PaymentOptions; Photo: typeof google.maps.places.Photo; Place: typeof google.maps.places.Place; + PlacePrediction: typeof google.maps.places.PlacePrediction; PlacesService: typeof google.maps.places.PlacesService; PlacesServiceStatus: typeof google.maps.places.PlacesServiceStatus; PlusCode: typeof google.maps.places.PlusCode; @@ -5295,6 +5483,7 @@ declare namespace google.maps { SearchBox: typeof google.maps.places.SearchBox; SearchByTextRankPreference: typeof google.maps.places.SearchByTextRankPreference; SearchNearbyRankPreference: typeof google.maps.places.SearchNearbyRankPreference; + StringRange: typeof google.maps.places.StringRange; } /** * Access by calling `const {Point} = await @@ -5947,6 +6136,49 @@ declare namespace google.maps { */ width: number; } + /** + * Available only in the v=beta channel: https://goo.gle/3oAthT3. + * + * An enum representing the relationship in space between the landmark and the + * target. + * + * Access by calling `const {SpatialRelationship} = await + * google.maps.importLibrary("geocoding")`. See + * https://developers.google.com/maps/documentation/javascript/libraries. + */ + export enum SpatialRelationship { + /** + * The target is directly opposite the landmark on the other side of the + * road. + */ + ACROSS_THE_ROAD = 'ACROSS_THE_ROAD', + /** + * Not on the same route as the landmark but a single turn away. + */ + AROUND_THE_CORNER = 'AROUND_THE_CORNER', + /** + * Close to the landmark's structure but further away from its access + * point. + */ + BEHIND = 'BEHIND', + /** + * The target is directly adjacent to the landmark. + */ + BESIDE = 'BESIDE', + /** + * On the same route as the landmark but not besides or across. + */ + DOWN_THE_ROAD = 'DOWN_THE_ROAD', + /** + * This is the default relationship when nothing more specific below + * applies. + */ + NEAR = 'NEAR', + /** + * The landmark has a spatial geometry and the target is within its bounds. + */ + WITHIN = 'WITHIN', + } /** * Options for the rendering of the Street View address control. */ @@ -7502,15 +7734,22 @@ declare namespace google.maps { * namespace is not generally recommended.) */ export function importLibrary( - libraryName: string, - ): - Promise<|google.maps.CoreLibrary|google.maps.MapsLibrary| - google.maps.Maps3DLibrary|google.maps.PlacesLibrary| - google.maps.GeocodingLibrary|google.maps.RoutesLibrary| - google.maps.MarkerLibrary|google.maps.GeometryLibrary| - google.maps.ElevationLibrary|google.maps.StreetViewLibrary| - google.maps.JourneySharingLibrary| - google.maps.DrawingLibrary|google.maps.VisualizationLibrary>; + libraryName: string, + ): Promise< + | google.maps.CoreLibrary + | google.maps.MapsLibrary + | google.maps.Maps3DLibrary + | google.maps.PlacesLibrary + | google.maps.GeocodingLibrary + | google.maps.RoutesLibrary + | google.maps.MarkerLibrary + | google.maps.GeometryLibrary + | google.maps.ElevationLibrary + | google.maps.StreetViewLibrary + | google.maps.JourneySharingLibrary + | google.maps.DrawingLibrary + | google.maps.VisualizationLibrary + >; /** * Google Maps JavaScript API version loaded by the browser. See https://developers.google.com/maps/documentation/javascript/versions @@ -12118,7 +12357,7 @@ declare namespace google.maps.maps3d { * returned. Also, sea floor elevation may be returned for the altitude * value when clicking at the water surface from higher camera positions. */ - position: google.maps.LatLngAltitude|null; + position: google.maps.LatLngAltitude | null; } /** * Available only in the v=alpha channel: https://goo.gle/js-alpha-channel. @@ -12152,8 +12391,10 @@ declare namespace google.maps.maps3d { * google.maps.importLibrary("maps3d")`. See * https://developers.google.com/maps/documentation/javascript/libraries. */ - export class Map3DElement extends HTMLElement implements - google.maps.maps3d.Map3DElementOptions { + export class Map3DElement + extends HTMLElement + implements google.maps.maps3d.Map3DElementOptions + { /** * Available only in the v=alpha channel: https://goo.gle/js-alpha-channel. * @@ -12173,7 +12414,7 @@ declare namespace google.maps.maps3d { * longitude-only bounds use north and south latitudes of 90 * and -90, respectively. */ - bounds?: google.maps.LatLngBounds|google.maps.LatLngBoundsLiteral|null; + bounds?: google.maps.LatLngBounds | google.maps.LatLngBoundsLiteral | null; /** * The center of the map given as a LatLngAltitude, where altitude is in * meters above ground level. Note that this is not necessarily where the @@ -12182,23 +12423,23 @@ declare namespace google.maps.maps3d { * {lat: 0, lng: 0, altitude: 63170000}. 63170000 meters is a * maximum allowed altitude (Earth radius multiplied by 10). */ - center?: google.maps.LatLngAltitudeLiteral|null; + center?: google.maps.LatLngAltitudeLiteral | null; /** * When true, default map labels aren't rendered. * @defaultValue false */ - defaultLabelsDisabled?: boolean|null; + defaultLabelsDisabled?: boolean | null; /** * The compass heading of the map, in degrees, where due north is zero. When * there is no tilt, any roll will be interpreted as heading. */ - heading?: number|null; + heading?: number | null; /** * The maximum altitude above the ground which will be displayed on the map. * A valid value is between 0 and 63170000 meters * (Earth radius multiplied by 10). */ - maxAltitude?: number|null; + maxAltitude?: number | null; /** * The maximum angle of heading (rotation) of the map. A valid value is * between 0 and 360 degrees. @@ -12209,18 +12450,18 @@ declare namespace google.maps.maps3d { * 360]. minHeading = 90 and maxHeading = * 180 will allow heading in [90, 180]. */ - maxHeading?: number|null; + maxHeading?: number | null; /** * The maximum angle of incidence of the map. A valid value is between * 0 and 90 degrees. */ - maxTilt?: number|null; + maxTilt?: number | null; /** * The minimum altitude above the ground which will be displayed on the map. * A valid value is between 0 and 63170000 meters * (Earth radius multiplied by 10). */ - minAltitude?: number|null; + minAltitude?: number | null; /** * The minimum angle of heading (rotation) of the map. A valid value is * between 0 and 360 degrees. @@ -12231,29 +12472,29 @@ declare namespace google.maps.maps3d { * 360]. minHeading = 90 and maxHeading = * 180 will allow heading in [90, 180]. */ - minHeading?: number|null; + minHeading?: number | null; /** * The minimum angle of incidence of the map. A valid value is between * 0 and 90 degrees. */ - minTilt?: number|null; + minTilt?: number | null; /** * The distance from camera to the center of the map, in meters. */ - range?: number|null; + range?: number | null; /** * The roll of the camera around the view vector in degrees. To resolve * ambiguities, when there is no tilt, any roll will be interpreted as * heading. */ - roll?: number|null; + roll?: number | null; /** * The tilt of the camera's view vector in degrees. A view vector * looking directly down at the earth would have a tilt of zero degrees. A * view vector pointing away from the earth would have a tilt of * 180 degrees. */ - tilt?: number|null; + tilt?: number | null; } /** * Available only in the v=alpha channel: https://goo.gle/js-alpha-channel. @@ -12265,55 +12506,55 @@ declare namespace google.maps.maps3d { /** * See {@link google.maps.maps3d.Map3DElement.bounds}. */ - bounds?: google.maps.LatLngBounds|google.maps.LatLngBoundsLiteral|null; + bounds?: google.maps.LatLngBounds | google.maps.LatLngBoundsLiteral | null; /** * See {@link google.maps.maps3d.Map3DElement.center}. */ - center?: google.maps.LatLngAltitudeLiteral|null; + center?: google.maps.LatLngAltitudeLiteral | null; /** * See {@link google.maps.maps3d.Map3DElement.defaultLabelsDisabled}. */ - defaultLabelsDisabled?: boolean|null; + defaultLabelsDisabled?: boolean | null; /** * See {@link google.maps.maps3d.Map3DElement.heading}. */ - heading?: number|null; + heading?: number | null; /** * See {@link google.maps.maps3d.Map3DElement.maxAltitude}. */ - maxAltitude?: number|null; + maxAltitude?: number | null; /** * See {@link google.maps.maps3d.Map3DElement.maxHeading}. */ - maxHeading?: number|null; + maxHeading?: number | null; /** * See {@link google.maps.maps3d.Map3DElement.maxTilt}. */ - maxTilt?: number|null; + maxTilt?: number | null; /** * See {@link google.maps.maps3d.Map3DElement.minAltitude}. */ - minAltitude?: number|null; + minAltitude?: number | null; /** * See {@link google.maps.maps3d.Map3DElement.minHeading}. */ - minHeading?: number|null; + minHeading?: number | null; /** * See {@link google.maps.maps3d.Map3DElement.minTilt}. */ - minTilt?: number|null; + minTilt?: number | null; /** * See {@link google.maps.maps3d.Map3DElement.range}. */ - range?: number|null; + range?: number | null; /** * See {@link google.maps.maps3d.Map3DElement.roll}. */ - roll?: number|null; + roll?: number | null; /** * See {@link google.maps.maps3d.Map3DElement.tilt}. */ - tilt?: number|null; + tilt?: number | null; } /** * Available only in the v=alpha channel: https://goo.gle/js-alpha-channel. @@ -12326,8 +12567,10 @@ declare namespace google.maps.maps3d { * google.maps.importLibrary("maps3d")`. See * https://developers.google.com/maps/documentation/javascript/libraries. */ - export class Polygon3DElement extends HTMLElement implements - google.maps.maps3d.Polygon3DElementOptions { + export class Polygon3DElement + extends HTMLElement + implements google.maps.maps3d.Polygon3DElementOptions + { /** * Available only in the v=alpha channel: https://goo.gle/js-alpha-channel. * @@ -12344,64 +12587,64 @@ declare namespace google.maps.maps3d { * Specifies how altitude components in the coordinates are interpreted. * @defaultValue {@link google.maps.maps3d.AltitudeMode.ABSOLUTE} */ - altitudeMode?: google.maps.maps3d.AltitudeMode|null; + altitudeMode?: google.maps.maps3d.AltitudeMode | null; /** * Specifies whether parts of the polygon which could be occluded are drawn * or not. Polygons can be occluded by map geometry (e.g. buildings). * @defaultValue false */ - drawsOccludedSegments?: boolean|null; + drawsOccludedSegments?: boolean | null; /** * Specifies whether to connect the polygon to the ground. To extrude a * polygon, the altitudeMode must be either * RELATIVE_TO_GROUND or ABSOLUTE. * @defaultValue false */ - extruded?: boolean|null; + extruded?: boolean | null; /** * The fill color. All CSS3 colors are supported except for extended named * colors. */ - fillColor?: string|null; + fillColor?: string | null; /** * The fill opacity between 0.0 and 1.0. */ - fillOpacity?: number|null; + fillOpacity?: number | null; /** * When true, edges of the polygon are interpreted as geodesic * and will follow the curvature of the Earth. When false, * edges of the polygon are rendered as straight lines in screen space. * @defaultValue false */ - geodesic?: boolean|null; + geodesic?: boolean | null; /** * The ordered sequence of coordinates that designates a closed loop. Unlike * polylines, a polygon may consist of one or more paths, which create * multiple cut-outs inside the polygon. */ - innerCoordinates?: Iterable>|null; + innerCoordinates?: Iterable> | null; /** * The ordered sequence of coordinates that designates a closed loop. * Altitude is ignored in certain modes and thus optional. */ - outerCoordinates?: Iterable|null; + outerCoordinates?: Iterable | null; /** * The stroke color. All CSS3 colors are supported except for extended named * colors. */ - strokeColor?: string|null; + strokeColor?: string | null; /** * The stroke opacity between 0.0 and 1.0. */ - strokeOpacity?: number|null; + strokeOpacity?: number | null; /** * The stroke width in pixels. */ - strokeWidth?: number|null; + strokeWidth?: number | null; /** * The zIndex compared to other polys. */ - zIndex?: number|null; + zIndex?: number | null; } /** * Available only in the v=alpha channel: https://goo.gle/js-alpha-channel. @@ -12414,54 +12657,54 @@ declare namespace google.maps.maps3d { * See {@link google.maps.maps3d.Polygon3DElement.altitudeMode}. * @defaultValue {@link google.maps.maps3d.AltitudeMode.ABSOLUTE} */ - altitudeMode?: google.maps.maps3d.AltitudeMode|null; + altitudeMode?: google.maps.maps3d.AltitudeMode | null; /** * See {@link google.maps.maps3d.Polygon3DElement.drawsOccludedSegments}. * @defaultValue false */ - drawsOccludedSegments?: boolean|null; + drawsOccludedSegments?: boolean | null; /** * See {@link google.maps.maps3d.Polygon3DElement.extruded}. * @defaultValue false */ - extruded?: boolean|null; + extruded?: boolean | null; /** * See {@link google.maps.maps3d.Polygon3DElement.fillColor}. */ - fillColor?: string|null; + fillColor?: string | null; /** * See {@link google.maps.maps3d.Polygon3DElement.fillOpacity}. */ - fillOpacity?: number|null; + fillOpacity?: number | null; /** * See {@link google.maps.maps3d.Polygon3DElement.geodesic}. * @defaultValue false */ - geodesic?: boolean|null; + geodesic?: boolean | null; /** * See {@link google.maps.maps3d.Polygon3DElement.innerCoordinates}. */ - innerCoordinates?: Iterable>|null; + innerCoordinates?: Iterable> | null; /** * See {@link google.maps.maps3d.Polygon3DElement.outerCoordinates}. */ - outerCoordinates?: Iterable|null; + outerCoordinates?: Iterable | null; /** * See {@link google.maps.maps3d.Polygon3DElement.strokeColor}. */ - strokeColor?: string|null; + strokeColor?: string | null; /** * See {@link google.maps.maps3d.Polygon3DElement.strokeOpacity}. */ - strokeOpacity?: number|null; + strokeOpacity?: number | null; /** * See {@link google.maps.maps3d.Polygon3DElement.strokeWidth}. */ - strokeWidth?: number|null; + strokeWidth?: number | null; /** * See {@link google.maps.maps3d.Polygon3DElement.zIndex}. */ - zIndex?: number|null; + zIndex?: number | null; } /** * Available only in the v=alpha channel: https://goo.gle/js-alpha-channel. @@ -12472,8 +12715,10 @@ declare namespace google.maps.maps3d { * google.maps.importLibrary("maps3d")`. See * https://developers.google.com/maps/documentation/javascript/libraries. */ - export class Polyline3DElement extends HTMLElement implements - google.maps.maps3d.Polyline3DElementOptions { + export class Polyline3DElement + extends HTMLElement + implements google.maps.maps3d.Polyline3DElementOptions + { /** * Available only in the v=alpha channel: https://goo.gle/js-alpha-channel. * @@ -12488,63 +12733,63 @@ declare namespace google.maps.maps3d { * Specifies how altitude components in the coordinates are interpreted. * @defaultValue {@link google.maps.maps3d.AltitudeMode.ABSOLUTE} */ - altitudeMode?: google.maps.maps3d.AltitudeMode|null; + altitudeMode?: google.maps.maps3d.AltitudeMode | null; /** * The ordered sequence of coordinates of the Polyline. Altitude is ignored * in certain modes and thus optional. */ - coordinates?: Iterable|null; + coordinates?: Iterable | null; /** * Specifies whether parts of the polyline which could be occluded are drawn * or not. Polylines can be occluded by map geometry (e.g. buildings). * @defaultValue false */ - drawsOccludedSegments?: boolean|null; + drawsOccludedSegments?: boolean | null; /** * Specifies whether to connect the polyline to the ground. To extrude a * polyline, the altitudeMode must be either * RELATIVE_TO_GROUND or ABSOLUTE. * @defaultValue false */ - extruded?: boolean|null; + extruded?: boolean | null; /** * When true, edges of the polyline are interpreted as geodesic * and will follow the curvature of the Earth. When false, * edges of the polyline are rendered as straight lines in screen space. * @defaultValue false */ - geodesic?: boolean|null; + geodesic?: boolean | null; /** * The outer color. All CSS3 colors are supported except for extended named * colors. */ - outerColor?: string|null; + outerColor?: string | null; /** * The outer opacity between 0.0 and 1.0. */ - outerOpacity?: number|null; + outerOpacity?: number | null; /** * The outer width is between 0.0 and 1.0. This is * a percentage of the strokeWidth. */ - outerWidth?: number|null; + outerWidth?: number | null; /** * The stroke color. All CSS3 colors are supported except for extended named * colors. */ - strokeColor?: string|null; + strokeColor?: string | null; /** * The stroke opacity between 0.0 and 1.0. */ - strokeOpacity?: number|null; + strokeOpacity?: number | null; /** * The stroke width in pixels. */ - strokeWidth?: number|null; + strokeWidth?: number | null; /** * The zIndex compared to other polys. */ - zIndex?: number|null; + zIndex?: number | null; } /** * Available only in the v=alpha channel: https://goo.gle/js-alpha-channel. @@ -12557,54 +12802,54 @@ declare namespace google.maps.maps3d { * See {@link google.maps.maps3d.Polyline3DElement.altitudeMode}. * @defaultValue {@link google.maps.maps3d.AltitudeMode.ABSOLUTE} */ - altitudeMode?: google.maps.maps3d.AltitudeMode|null; + altitudeMode?: google.maps.maps3d.AltitudeMode | null; /** * See {@link google.maps.maps3d.Polyline3DElement.coordinates}. */ - coordinates?: Iterable|null; + coordinates?: Iterable | null; /** * See {@link google.maps.maps3d.Polyline3DElement.drawsOccludedSegments}. * @defaultValue false */ - drawsOccludedSegments?: boolean|null; + drawsOccludedSegments?: boolean | null; /** * See {@link google.maps.maps3d.Polyline3DElement.extruded}. * @defaultValue false */ - extruded?: boolean|null; + extruded?: boolean | null; /** * See {@link google.maps.maps3d.Polyline3DElement.geodesic}. * @defaultValue false */ - geodesic?: boolean|null; + geodesic?: boolean | null; /** * See {@link google.maps.maps3d.Polyline3DElement.outerColor}. */ - outerColor?: string|null; + outerColor?: string | null; /** * See {@link google.maps.maps3d.Polyline3DElement.outerOpacity}. */ - outerOpacity?: number|null; + outerOpacity?: number | null; /** * See {@link google.maps.maps3d.Polyline3DElement.outerWidth}. */ - outerWidth?: number|null; + outerWidth?: number | null; /** * See {@link google.maps.maps3d.Polyline3DElement.strokeColor}. */ - strokeColor?: string|null; + strokeColor?: string | null; /** * See {@link google.maps.maps3d.Polyline3DElement.strokeOpacity}. */ - strokeOpacity?: number|null; + strokeOpacity?: number | null; /** * See {@link google.maps.maps3d.Polyline3DElement.strokeWidth}. */ - strokeWidth?: number|null; + strokeWidth?: number | null; /** * See {@link google.maps.maps3d.Polyline3DElement.zIndex}. */ - zIndex?: number|null; + zIndex?: number | null; } /** * Available only in the v=alpha channel: https://goo.gle/js-alpha-channel. @@ -13255,6 +13500,108 @@ declare namespace google.maps.places { */ types: string[]; } + /** + * Request interface for {@link + * google.maps.places.AutocompleteSuggestion.fetchAutocompleteSuggestions}. + */ + export interface AutocompleteRequest { + /** + * Included primary Place + * type (for example, "restaurant" or + * "gas_station").

    A Place is only returned if its + * primary type is included in this list. Up to 5 values can be specified. + * If no types are specified, all Place types are returned. + */ + includedPrimaryTypes?: string[]; + /** + * Only include results in the specified regions, specified as up to 15 CLDR + * two-character region codes. An empty set will not restrict the results. + * If both locationRestriction and + * includedRegionCodes are set, the results will be located in + * the area of intersection. + */ + includedRegionCodes?: string[]; + /** + * The text string on which to search. + */ + input: string; + /** + * A zero-based Unicode character offset of input indicating + * the cursor position in input. The cursor position may + * influence what predictions are returned. If not specified, defaults to + * the length of input. + */ + inputOffset?: number; + /** + * The language in which to return results. Will default to the + * browser's language preference. The results may be in mixed languages + * if the language used in input is different from + * language, or if the returned Place does not have a + * translation from the local language to language. + */ + language?: string; + /** + * Bias results to a specified location.

    At most one of + * locationBias or locationRestriction should be + * set. If neither are set, the results will be biased by IP address, + * meaning the IP address will be mapped to an imprecise location and used + * as a biasing signal. + */ + locationBias?: + | google.maps.LatLng + | google.maps.LatLngLiteral + | google.maps.LatLngBounds + | google.maps.LatLngBoundsLiteral + | google.maps.Circle + | google.maps.CircleLiteral + | string; + /** + * Restrict results to a specified location.

    At most one of + * locationBias or locationRestriction should be + * set. If neither are set, the results will be biased by IP address, + * meaning the IP address will be mapped to an imprecise location and used + * as a biasing signal. + */ + locationRestriction?: + | google.maps.LatLngBounds + | google.maps.LatLngBoundsLiteral; + /** + * The origin point from which to calculate geodesic distance to the + * destination (returned as {@link + * google.maps.places.PlacePrediction.distanceMeters}). If this value is + * omitted, geodesic distance will not be returned. + */ + origin?: google.maps.LatLng | google.maps.LatLngLiteral; + /** + * The region code, specified as a CLDR two-character region code. This + * affects address formatting, result ranking, and may influence what + * results are returned. This does not restrict results to the specified + * region. + */ + region?: string; + /** + * A token which identifies an Autocomplete session for billing purposes. + * Generate a new session token via {@link + * google.maps.places.AutocompleteSessionToken}.

    The session + * begins when the user starts typing a query, and concludes when they + * select a place and call {@link google.maps.places.Place.fetchFields}. + * Each session can have multiple queries, followed by one + * fetchFields call. The credentials used for each request + * within a session must belong to the same Google Cloud Console project. + * Once a session has concluded, the token is no longer valid; your app must + * generate a fresh token for each session. If the sessionToken + * parameter is omitted, or if you reuse a session token, the session is + * charged as if no session token was provided (each request is billed + * separately).

    We recommend the following guidelines: + *
    • Use session tokens for all Place Autocomplete calls.
      • + *
    • Generate a fresh token for each session.
    • Be sure to pass a + * unique session token for each new session. Using the same token for more + * than one session will result in each request being billed + * individually.
    + */ + sessionToken?: google.maps.places.AutocompleteSessionToken; + } /** * An Autocomplete response returned by the call to {@link * google.maps.places.AutocompleteService.getPlacePredictions} containing a @@ -13305,16 +13652,34 @@ declare namespace google.maps.places { ): void; } /** - * Represents a session token used for tracking an autocomplete session, which - * can be a series of {@link - * google.maps.places.AutocompleteService.getPlacePredictions} calls followed - * by a single {@link google.maps.places.PlacesService.getDetails} call. + * Represents a session token used for tracking an autocomplete session. * * Access by calling `const {AutocompleteSessionToken} = await * google.maps.importLibrary("places")`. See * https://developers.google.com/maps/documentation/javascript/libraries. */ export class AutocompleteSessionToken {} + /** + * An Autocomplete suggestion result. + * + * Access by calling `const {AutocompleteSuggestion} = await + * google.maps.importLibrary("places")`. See + * https://developers.google.com/maps/documentation/javascript/libraries. + */ + export class AutocompleteSuggestion { + /** + * Contains the human-readable name for the returned result. For + * establishment results, this is usually the business name and address. + */ + placePrediction: google.maps.places.PlacePrediction | null; + /** + * Fetches a list of AutocompleteSuggestions. + */ + static fetchAutocompleteSuggestions( + this: any, + autocompleteRequest: google.maps.places.AutocompleteRequest, + ): Promise<{suggestions: google.maps.places.AutocompleteSuggestion[]}>; + } /** * An Autocompletion request to be sent to {@link * google.maps.places.AutocompleteService.getPlacePredictions}. @@ -13464,6 +13829,129 @@ declare namespace google.maps.places { */ country: string | string[] | null; } + /** + * EV charging information, aggregated for connectors of the same type and the + * same charge rate. + * + * Access by calling `const {ConnectorAggregation} = await + * google.maps.importLibrary("places")`. See + * https://developers.google.com/maps/documentation/javascript/libraries. + */ + export class ConnectorAggregation { + /** + * The time when the connector availability information in this aggregation + * was last updated. + */ + availabilityLastUpdateTime: Date | null; + /** + * Number of connectors in this aggregation that are currently available. + */ + availableCount: number | null; + /** + * Number of connectors in this aggregation. + */ + count: number; + /** + * The static max charging rate in kw of each connector of the aggregation. + */ + maxChargeRateKw: number; + /** + * Number of connectors in this aggregation that are currently out of + * service. + */ + outOfServiceCount: number | null; + /** + * The connector type of this aggregation. + */ + type: google.maps.places.EVConnectorType | null; + } + /** + * Information about the EV charging station hosted in the place. + * + * Access by calling `const {EVChargeOptions} = await + * google.maps.importLibrary("places")`. See + * https://developers.google.com/maps/documentation/javascript/libraries. + */ + export class EVChargeOptions { + /** + * A list of EV charging connector aggregations that contain connectors of + * the same type and same charge rate. + */ + connectorAggregations: google.maps.places.ConnectorAggregation[]; + /** + * Number of connectors at this station. Because some ports can have + * multiple connectors but only be able to charge one car at a time, the + * number of connectors may be greater than the total number of cars which + * can charge simultaneously. + */ + connectorCount: number; + } + /** + * EV charging connector types. + * + * Access by calling `const {EVConnectorType} = await + * google.maps.importLibrary("places")`. See + * https://developers.google.com/maps/documentation/javascript/libraries. + */ + export enum EVConnectorType { + /** + * Combined Charging System (AC and DC). Based on SAE Type-1 J-1772 + * connector. + */ + CCS_COMBO_1 = 'CCS_COMBO_1', + /** + * Combined Charging System (AC and DC). Based on Type-2 Mennekes connector. + */ + CCS_COMBO_2 = 'CCS_COMBO_2', + /** + * CHAdeMO type connector. + */ + CHADEMO = 'CHADEMO', + /** + * J1772 type 1 connector. + */ + J1772 = 'J1772', + /** + * Other connector types. + */ + OTHER = 'OTHER', + /** + * The generic TESLA connector. This is NACS in the North America but can be + * non-NACS in other parts of the world (e.g. CCS Combo 2 (CCS2) or GB/T). + * This value is less representative of an actual connector type, and more + * represents the ability to charge a Tesla brand vehicle at a Tesla owned + * charging station. + */ + TESLA = 'TESLA', + /** + * IEC 62196 type 2 connector. Often referred to as MENNEKES. + */ + TYPE_2 = 'TYPE_2', + /** + * GB/T type corresponds to the GB/T standard in China. This type covers all + * GB_T types. + */ + UNSPECIFIED_GB_T = 'UNSPECIFIED_GB_T', + /** + * Unspecified wall outlet. + */ + UNSPECIFIED_WALL_OUTLET = 'UNSPECIFIED_WALL_OUTLET', + } + /** + * EV-related options that can be specified for a place search request. + */ + export interface EVSearchOptions { + /** + * The list of preferred EV connector types. A place that does not support + * any of the listed connector types is filtered out. + */ + connectorTypes?: google.maps.places.EVConnectorType[]; + /** + * Minimum required charging rate in kilowatts. A place with a charging rate + * less than the specified rate is filtered out. + */ + minimumChargingRateKw?: number; + } /** * Options for fetching Place fields. */ @@ -13554,6 +14042,150 @@ declare namespace google.maps.places { */ query: string; } + /** + * Text representing a Place prediction. The text may be used as is or + * formatted. + * + * Access by calling `const {FormattableText} = await + * google.maps.importLibrary("places")`. See + * https://developers.google.com/maps/documentation/javascript/libraries. + */ + export class FormattableText { + /** + * A list of string ranges identifying where the input request matched + * in {@link google.maps.places.FormattableText.text}. The ranges can be + * used to format specific parts of text. The substrings may + * not be exact matches of {@link + * google.maps.places.AutocompleteRequest.input} if the matching was + * determined by criteria other than string matching (for example, spell + * corrections or transliterations). These values are Unicode character + * offsets of {@link google.maps.places.FormattableText.text}. The ranges + * are guaranteed to be ordered in increasing offset values. + */ + matches: google.maps.places.StringRange[]; + /** + * Text that may be used as is or formatted with {@link + * google.maps.places.FormattableText.matches}. + */ + text: string; + } + /** + * The most recent information about fuel options in a gas station. This + * information is updated regularly. + * + * Access by calling `const {FuelOptions} = await + * google.maps.importLibrary("places")`. See + * https://developers.google.com/maps/documentation/javascript/libraries. + */ + export class FuelOptions { + /** + * A list of fuel prices for each type of fuel this station has, one entry + * per fuel type. + */ + fuelPrices: google.maps.places.FuelPrice[]; + } + /** + * Fuel price information for a given type of fuel. + * + * Access by calling `const {FuelPrice} = await + * google.maps.importLibrary("places")`. See + * https://developers.google.com/maps/documentation/javascript/libraries. + */ + export class FuelPrice { + /** + * The price of the fuel. + */ + price: google.maps.places.Money | null; + /** + * The type of fuel. + */ + type: google.maps.places.FuelType | null; + /** + * The time the fuel price was last updated. + */ + updateTime: Date | null; + } + /** + * Types of fuel. + * + * Access by calling `const {FuelType} = await + * google.maps.importLibrary("places")`. See + * https://developers.google.com/maps/documentation/javascript/libraries. + */ + export enum FuelType { + /** + * Bio-diesel. + */ + BIO_DIESEL = 'BIO_DIESEL', + /** + * Diesel fuel. + */ + DIESEL = 'DIESEL', + /** + * E 80. + */ + E80 = 'E80', + /** + * E 85. + */ + E85 = 'E85', + /** + * LPG. + */ + LPG = 'LPG', + /** + * Methane. + */ + METHANE = 'METHANE', + /** + * Midgrade. + */ + MIDGRADE = 'MIDGRADE', + /** + * Premium. + */ + PREMIUM = 'PREMIUM', + /** + * Regular unleaded. + */ + REGULAR_UNLEADED = 'REGULAR_UNLEADED', + /** + * SP 100. + */ + SP100 = 'SP100', + /** + * SP 91. + */ + SP91 = 'SP91', + /** + * SP 91 E10. + */ + SP91_E10 = 'SP91_E10', + /** + * SP 92. + */ + SP92 = 'SP92', + /** + * SP 95. + */ + SP95 = 'SP95', + /** + * SP95 E10. + */ + SP95_E10 = 'SP95_E10', + /** + * SP 98. + */ + SP98 = 'SP98', + /** + * SP 99. + */ + SP99 = 'SP99', + /** + * Truck diesel. + */ + TRUCK_DIESEL = 'TRUCK_DIESEL', + } export type LocationBias = | google.maps.LatLng | google.maps.LatLngLiteral @@ -13565,6 +14197,34 @@ declare namespace google.maps.places { export type LocationRestriction = | google.maps.LatLngBounds | google.maps.LatLngBoundsLiteral; + /** + * A representation of an amount of money with its currency type. + * + * Access by calling `const {Money} = await + * google.maps.importLibrary("places")`. See + * https://developers.google.com/maps/documentation/javascript/libraries. + */ + export class Money { + /** + * The three-letter currency code, defined in ISO 4217. + */ + currencyCode: string; + /** + * Number of nano (10^-9) units of the amount. + */ + nanos: number; + /** + * Returns a human-readable representation of the amount of money with its + * currency symbol. + */ + toString(): string; + /** + * The whole units of the amount. For example, if {@link + * google.maps.places.Money.currencyCode} is "USD", then 1 unit is + * 1 US dollar. + */ + units: number; + } /** * Available only in the v=beta channel: https://goo.gle/3oAthT3. * @@ -13808,6 +14468,11 @@ declare namespace google.maps.places { * has not yet been requested. */ editorialSummaryLanguageCode?: string | null; + /** + * EV Charge options provided by the place. undefined if the EV + * charge options have not been called for from the server. + */ + evChargeOptions?: google.maps.places.EVChargeOptions | null; fetchFields( options: google.maps.places.FetchFieldsRequest, ): Promise<{place: google.maps.places.Place}>; @@ -13815,6 +14480,11 @@ declare namespace google.maps.places { * The locations’s full address. */ formattedAddress?: string | null; + /** + * Fuel options provided by the place. undefined if the fuel + * options have not been called for from the server. + */ + fuelOptions?: google.maps.places.FuelOptions | null; /** * Available only in the v=beta channel: https://goo.gle/3oAthT3. * Calculates the Date representing the next OpeningHoursTime. Returns @@ -14483,6 +15153,55 @@ declare namespace google.maps.places { */ global_code: string; } + /** + * Prediction results for a Place Autocomplete prediction. + * + * Access by calling `const {PlacePrediction} = await + * google.maps.importLibrary("places")`. See + * https://developers.google.com/maps/documentation/javascript/libraries. + */ + export class PlacePrediction { + /** + * The length of the geodesic in meters from origin if + * origin is specified. + */ + distanceMeters: number | null; + /** + * Represents the name of the Place. + */ + mainText: google.maps.places.FormattableText | null; + /** + * The unique identifier of the suggested Place. This identifier can be used + * in other APIs that accept Place IDs. + */ + placeId: string; + /** + * Represents additional disambiguating features (such as a city or region) + * to further identify the Place. + */ + secondaryText: google.maps.places.FormattableText | null; + /** + * Contains the human-readable name for the returned result. For + * establishment results, this is usually the business name and address. + *

    text is recommended for developers who wish to + * show a single UI element. Developers who wish to show two separate, but + * related, UI elements may want to use {@link + * google.maps.places.PlacePrediction.mainText} and {@link + * google.maps.places.PlacePrediction.secondaryText} instead. + */ + text: google.maps.places.FormattableText; + /** + * Returns a Place representation of this PlacePrediction. A subsequent call + * to {@link google.maps.places.Place.fetchFields} is required to get full + * Place details. + */ + toPlace(): google.maps.places.Place; + /** + * List of types that apply to this Place from Table A or Table B in https://developers.google.com/maps/documentation/places/web-service/place-types. + */ + types: string[]; + } /** * Defines information about a Place. */ @@ -15213,14 +15932,17 @@ declare namespace google.maps.places { * Request interface for {@link google.maps.places.Place.searchByText}. */ export interface SearchByTextRequest { + /** + * EV-related options that can be specified for a place search request. + */ + evSearchOptions?: google.maps.places.EVSearchOptions; /** * Fields to be included in the response, which * will be billed for. If ['*'] is passed in, all * available fields will be returned and billed for (this is not recommended - * for production deployments). For a list of fields see {@link - * google.maps.places.PlaceResult}. Nested fields can be specified with - * dot-paths (for example, "geometry.location"). + * for production deployments). You can request any property in the {@link + * google.maps.places.Place} class as a field. */ fields: string[]; /** @@ -15349,14 +16071,22 @@ declare namespace google.maps.places { * INVALID_ARGUMENT error is returned. */ excludedPrimaryTypes?: string[]; + /** + * Excluded place type. See the full + * list of types supported. A place can have many different place types. + * Up to 50 types may be specified. If you specify the same type in both + * included and excluded lists, an + * INVALID_ARGUMENT error is returned. + */ + excludedTypes?: string[]; /** * Fields to be included in the response, which * will be billed for. If ['*'] is passed in, all * available fields will be returned and billed for (this is not recommended - * for production deployments). For a list of fields see {@link - * google.maps.places.PlaceResult}. Nested fields can be specified with - * dot-paths (for example, "geometry.location"). + * for production deployments). You can request any property in the {@link + * google.maps.places.Place} class as a field. */ fields: string[]; /** @@ -15409,6 +16139,25 @@ declare namespace google.maps.places { */ region?: string; } + /** + * Identifies a substring within a given text. + * + * Access by calling `const {StringRange} = await + * google.maps.importLibrary("places")`. See + * https://developers.google.com/maps/documentation/javascript/libraries. + */ + export class StringRange { + /** + * Zero-based offset of the last Unicode character of the substring + * (exclusive). + */ + endOffset: number; + /** + * Zero-based offset of the first Unicode character of the substring + * (inclusive). + */ + startOffset: number; + } /** * Contains structured information about the place's description, divided * into a main text and a secondary text, including an array of matched diff --git a/types/govuk-frontend/.npmignore b/types/govuk-frontend/.npmignore new file mode 100644 index 00000000000000..93e307400a5456 --- /dev/null +++ b/types/govuk-frontend/.npmignore @@ -0,0 +1,5 @@ +* +!**/*.d.ts +!**/*.d.cts +!**/*.d.mts +!**/*.d.*.ts diff --git a/types/govuk-frontend/dist/govuk/all.bundle.d.mts b/types/govuk-frontend/dist/govuk/all.bundle.d.mts new file mode 100644 index 00000000000000..b07a131202aaed --- /dev/null +++ b/types/govuk-frontend/dist/govuk/all.bundle.d.mts @@ -0,0 +1,14 @@ +export { version } from "./common/govuk-frontend-version.mjs"; +export { Accordion } from "./components/accordion/accordion.mjs"; +export { Button } from "./components/button/button.mjs"; +export { CharacterCount } from "./components/character-count/character-count.mjs"; +export { Checkboxes } from "./components/checkboxes/checkboxes.mjs"; +export { ErrorSummary } from "./components/error-summary/error-summary.mjs"; +export { ExitThisPage } from "./components/exit-this-page/exit-this-page.mjs"; +export { Header } from "./components/header/header.mjs"; +export { NotificationBanner } from "./components/notification-banner/notification-banner.mjs"; +export { PasswordInput } from "./components/password-input/password-input.mjs"; +export { Radios } from "./components/radios/radios.mjs"; +export { SkipLink } from "./components/skip-link/skip-link.mjs"; +export { Tabs } from "./components/tabs/tabs.mjs"; +export { type Config, type ConfigKey, createAll, initAll } from "./init.mjs"; diff --git a/types/govuk-frontend/dist/govuk/all.bundle.d.ts b/types/govuk-frontend/dist/govuk/all.bundle.d.ts new file mode 100644 index 00000000000000..e682e5e0ef5c12 --- /dev/null +++ b/types/govuk-frontend/dist/govuk/all.bundle.d.ts @@ -0,0 +1,39 @@ +import { version } from "./common/govuk-frontend-version.js"; +import { Accordion } from "./components/accordion/accordion.js"; +import { Button } from "./components/button/button.js"; +import { CharacterCount } from "./components/character-count/character-count.js"; +import { Checkboxes } from "./components/checkboxes/checkboxes.js"; +import { ErrorSummary } from "./components/error-summary/error-summary.js"; +import { ExitThisPage } from "./components/exit-this-page/exit-this-page.js"; +import { Header } from "./components/header/header.js"; +import { NotificationBanner } from "./components/notification-banner/notification-banner.js"; +import { PasswordInput } from "./components/password-input/password-input.js"; +import { Radios } from "./components/radios/radios.js"; +import { SkipLink } from "./components/skip-link/skip-link.js"; +import { Tabs } from "./components/tabs/tabs.js"; +import { type Config as ConfigImport, type ConfigKey as ConfigKeyImport, createAll, initAll } from "./init.js"; + +declare namespace GOVUKFrontend { + type Config = ConfigImport; + type ConfigKey = ConfigKeyImport; +} + +declare const GOVUKFrontend: { + version: typeof version; + Accordion: typeof Accordion; + Button: typeof Button; + CharacterCount: typeof CharacterCount; + Checkboxes: typeof Checkboxes; + ErrorSummary: typeof ErrorSummary; + ExitThisPage: typeof ExitThisPage; + Header: typeof Header; + NotificationBanner: typeof NotificationBanner; + PasswordInput: typeof PasswordInput; + Radios: typeof Radios; + SkipLink: typeof SkipLink; + Tabs: typeof Tabs; + createAll: typeof createAll; + initAll: typeof initAll; +}; + +export = GOVUKFrontend; diff --git a/types/govuk-frontend/dist/govuk/all.d.mts b/types/govuk-frontend/dist/govuk/all.d.mts new file mode 100644 index 00000000000000..40c7af55cff85e --- /dev/null +++ b/types/govuk-frontend/dist/govuk/all.d.mts @@ -0,0 +1 @@ +export * from "./all.bundle.mjs"; diff --git a/types/govuk-frontend/dist/govuk/common/closest-attribute-value.d.mts b/types/govuk-frontend/dist/govuk/common/closest-attribute-value.d.mts new file mode 100644 index 00000000000000..6d739a296d3d95 --- /dev/null +++ b/types/govuk-frontend/dist/govuk/common/closest-attribute-value.d.mts @@ -0,0 +1 @@ +export * from "./closest-attribute-value.js"; diff --git a/types/govuk-frontend/dist/govuk/common/closest-attribute-value.d.ts b/types/govuk-frontend/dist/govuk/common/closest-attribute-value.d.ts new file mode 100644 index 00000000000000..f8b233519c97b9 --- /dev/null +++ b/types/govuk-frontend/dist/govuk/common/closest-attribute-value.d.ts @@ -0,0 +1,9 @@ +/** + * Returns the value of the given attribute closest to the given element (including itself) + * + * @internal + * @param {Element} $element - The element to start walking the DOM tree up + * @param {string} attributeName - The name of the attribute + * @returns {string | null} Attribute value + */ +export function closestAttributeValue($element: Element, attributeName: string): string | null; diff --git a/types/govuk-frontend/dist/govuk/common/govuk-frontend-version.d.mts b/types/govuk-frontend/dist/govuk/common/govuk-frontend-version.d.mts new file mode 100644 index 00000000000000..36ab710d27e7c5 --- /dev/null +++ b/types/govuk-frontend/dist/govuk/common/govuk-frontend-version.d.mts @@ -0,0 +1 @@ +export * from "./govuk-frontend-version.js"; diff --git a/types/govuk-frontend/dist/govuk/common/govuk-frontend-version.d.ts b/types/govuk-frontend/dist/govuk/common/govuk-frontend-version.d.ts new file mode 100644 index 00000000000000..41b01481011d31 --- /dev/null +++ b/types/govuk-frontend/dist/govuk/common/govuk-frontend-version.d.ts @@ -0,0 +1,6 @@ +/** + * GOV.UK Frontend release version + * + * {@link https://github.com/alphagov/govuk-frontend/releases} + */ +export const version: "development"; diff --git a/types/govuk-frontend/dist/govuk/common/index.d.mts b/types/govuk-frontend/dist/govuk/common/index.d.mts new file mode 100644 index 00000000000000..8e893de15df158 --- /dev/null +++ b/types/govuk-frontend/dist/govuk/common/index.d.mts @@ -0,0 +1 @@ +export * from "./index.js"; diff --git a/types/govuk-frontend/dist/govuk/common/index.d.ts b/types/govuk-frontend/dist/govuk/common/index.d.ts new file mode 100644 index 00000000000000..a4e0a81196f15c --- /dev/null +++ b/types/govuk-frontend/dist/govuk/common/index.d.ts @@ -0,0 +1,159 @@ +/** + * Common helpers which do not require polyfill. + * + * IMPORTANT: If a helper require a polyfill, please isolate it in its own module + * so that the polyfill can be properly tree-shaken and does not burden + * the components that do not need that helper + */ +/** + * Config merging function + * + * Takes any number of objects and combines them together, with + * greatest priority on the LAST item passed in. + * + * @internal + * @param {...{ [key: string]: unknown }} configObjects - Config objects to merge + * @returns {{ [key: string]: unknown }} A merged config object + */ +export function mergeConfigs( + ...configObjects: Array<{ + [key: string]: unknown; + }> +): { + [key: string]: unknown; +}; + +/** + * Extracts keys starting with a particular namespace from dataset ('data-*') + * object, removing the namespace in the process, normalising all values + * + * @internal + * @param {{ schema: Schema }} Component - Component class + * @param {DOMStringMap} dataset - The object to extract key-value pairs from + * @param {string} namespace - The namespace to filter keys with + * @returns {ObjectNested | undefined} Nested object with dot-separated key namespace removed + */ +export function extractConfigByNamespace( + Component: { + schema: Schema; + }, + dataset: DOMStringMap, + namespace: string, +): ObjectNested | undefined; + +/** + * Get hash fragment from URL + * + * Extract the hash fragment (everything after the hash) from a URL, + * but not including the hash symbol + * + * @param {string} url - URL + * @returns {string | undefined} Fragment from URL, without the hash + */ +export function getFragmentFromUrl(url: string): string | undefined; + +/** + * Get GOV.UK Frontend breakpoint value from CSS custom property + * + * @param {string} name - Breakpoint name + * @returns {{ property: string, value?: string }} Breakpoint object + */ +export function getBreakpoint(name: string): { + property: string; + value?: string; +}; + +/** + * Move focus to element + * + * Sets tabindex to -1 to make the element programmatically focusable, + * but removes it on blur as the element doesn't need to be focused again. + * + * @template {HTMLElement} FocusElement + * @param {FocusElement} $element - HTML element + * @param {object} [options] - Handler options + * @param {function(this: FocusElement): void} [options.onBeforeFocus] - Callback before focus + * @param {function(this: FocusElement): void} [options.onBlur] - Callback on blur + */ +export function setFocus( + $element: FocusElement, + options?: { + onBeforeFocus?: ((this: FocusElement) => void) | undefined; + onBlur?: ((this: FocusElement) => void) | undefined; + }, +): void; + +/** + * Checks if GOV.UK Frontend is supported on this page + * + * Some browsers will load and run our JavaScript but GOV.UK Frontend + * won't be supported. + * + * @internal + * @param {HTMLElement | null} [$scope] - HTML element `` checked for browser support + * @returns {boolean} Whether GOV.UK Frontend is supported on this page + */ +export function isSupported($scope?: HTMLElement | null): boolean; + +/** + * Validate component config by schema + * + * Follows limited examples in JSON schema for wider support in future + * + * {@link https://ajv.js.org/json-schema.html#compound-keywords} + * {@link https://ajv.js.org/packages/ajv-errors.html#single-message} + * + * @internal + * @param {Schema} schema - Config schema + * @param {{ [key: string]: unknown }} config - Component config + * @returns {string[]} List of validation errors + */ +export function validateConfig(schema: Schema, config: { + [key: string]: unknown; +}): string[]; + +/** + * Schema for component config + */ +export interface Schema { + /** + * - Schema properties + */ + properties: { + [field: string]: SchemaProperty | undefined; + }; + + /** + * - List of schema conditions + */ + anyOf?: SchemaCondition[] | undefined; +} + +/** + * Schema property for component config + */ +export interface SchemaProperty { + /** + * - Property type + */ + type: "string" | "boolean" | "number" | "object"; +} + +/** + * Schema condition for component config + */ +export interface SchemaCondition { + /** + * - List of required config fields + */ + required: string[]; + + /** + * - Error message when required config fields not provided + */ + errorMessage: string; +} +export type NestedKey = keyof ObjectNested; +export interface ObjectNested { + [key: string]: string | boolean | number | ObjectNested | undefined; +} diff --git a/types/govuk-frontend/dist/govuk/common/normalise-dataset.d.mts b/types/govuk-frontend/dist/govuk/common/normalise-dataset.d.mts new file mode 100644 index 00000000000000..3aee2984454bc9 --- /dev/null +++ b/types/govuk-frontend/dist/govuk/common/normalise-dataset.d.mts @@ -0,0 +1 @@ +export * from "./normalise-dataset.js"; diff --git a/types/govuk-frontend/dist/govuk/common/normalise-dataset.d.ts b/types/govuk-frontend/dist/govuk/common/normalise-dataset.d.ts new file mode 100644 index 00000000000000..b90fc62a64c38f --- /dev/null +++ b/types/govuk-frontend/dist/govuk/common/normalise-dataset.d.ts @@ -0,0 +1,16 @@ +import { type ObjectNested, type Schema } from "./index.js"; + +/** + * Normalise dataset + * + * Loop over an object and normalise each value using {@link normaliseString}, + * optionally expanding nested `i18n.field` + * + * @internal + * @param {{ schema: Schema }} Component - Component class + * @param {DOMStringMap} dataset - HTML element dataset + * @returns {ObjectNested} Normalised dataset + */ +export function normaliseDataset(Component: { + schema: Schema; +}, dataset: DOMStringMap): ObjectNested; diff --git a/types/govuk-frontend/dist/govuk/common/normalise-string.d.mts b/types/govuk-frontend/dist/govuk/common/normalise-string.d.mts new file mode 100644 index 00000000000000..9dd38047046c41 --- /dev/null +++ b/types/govuk-frontend/dist/govuk/common/normalise-string.d.mts @@ -0,0 +1 @@ +export * from "./normalise-string.js"; diff --git a/types/govuk-frontend/dist/govuk/common/normalise-string.d.ts b/types/govuk-frontend/dist/govuk/common/normalise-string.d.ts new file mode 100644 index 00000000000000..1166f986ae5f77 --- /dev/null +++ b/types/govuk-frontend/dist/govuk/common/normalise-string.d.ts @@ -0,0 +1,22 @@ +import { type SchemaProperty } from "./index.js"; + +/** + * Normalise string + * + * 'If it looks like a duck, and it quacks like a duck…' 🦆 + * + * If the passed value looks like a boolean or a number, convert it to a boolean + * or number. + * + * Designed to be used to convert config passed via data attributes (which are + * always strings) into something sensible. + * + * @internal + * @param {DOMStringMap[string]} value - The value to normalise + * @param {SchemaProperty} [property] - Component schema property + * @returns {string | boolean | number | undefined} Normalised data + */ +export function normaliseString( + value: DOMStringMap[string], + property?: SchemaProperty, +): string | boolean | number | undefined; diff --git a/types/govuk-frontend/dist/govuk/components/accordion/accordion.d.mts b/types/govuk-frontend/dist/govuk/components/accordion/accordion.d.mts new file mode 100644 index 00000000000000..9b21c8d1f5f20d --- /dev/null +++ b/types/govuk-frontend/dist/govuk/components/accordion/accordion.d.mts @@ -0,0 +1 @@ +export * from "./accordion.js"; diff --git a/types/govuk-frontend/dist/govuk/components/accordion/accordion.d.ts b/types/govuk-frontend/dist/govuk/components/accordion/accordion.d.ts new file mode 100644 index 00000000000000..36f807f1761795 --- /dev/null +++ b/types/govuk-frontend/dist/govuk/components/accordion/accordion.d.ts @@ -0,0 +1,120 @@ +import { GOVUKFrontendComponent } from "../../govuk-frontend-component.js"; + +/** + * Accordion component + * + * This allows a collection of sections to be collapsed by default, showing only + * their headers. Sections can be expanded or collapsed individually by clicking + * their headers. A "Show all sections" button is also added to the top of the + * accordion, which switches to "Hide all sections" when all the sections are + * expanded. + * + * The state of each section is saved to the DOM via the `aria-expanded` + * attribute, which also provides accessibility. + */ +export class Accordion extends GOVUKFrontendComponent { + /** + * Name for the component used when initialising using data-module attributes. + */ + static moduleName: string; + + /** + * Accordion default config + * + * @see {@link AccordionConfig} + */ + static defaults: AccordionConfig; + + /** + * Accordion config schema + * + * @satisfies {Schema} + */ + static schema: Readonly<{ + properties: { + i18n: { + type: "object"; + }; + rememberExpanded: { + type: "boolean"; + }; + }; + }>; + + /** + * @param {Element | null} $module - HTML element to use for accordion + * @param {AccordionConfig} [config] - Accordion config + */ + constructor($module: Element | null, config?: AccordionConfig); + + /** + * Get the identifier for a section + * + * We need a unique way of identifying each content in the Accordion. + * Since an `#id` should be unique and an `id` is required for `aria-` + * attributes `id` can be safely used. + * + * @param {Element} $section - Section element + * @returns {string | undefined | null} Identifier for section + */ + getIdentifier($section: Element): string | undefined | null; +} + +/** + * Accordion config + */ +export interface AccordionConfig { + /** + * - Accordion translations + */ + i18n?: AccordionTranslations | undefined; + + /** + * - Whether the expanded and collapsed + * state of each section is remembered and restored when navigating. + */ + rememberExpanded?: boolean | undefined; +} + +/** + * Messages used by the component for the labels of its buttons. This includes + * the visible text shown on screen, and text to help assistive technology users + * for the buttons toggling each section. + */ +export interface AccordionTranslations { + /** + * - The text content for the 'Hide all + * sections' button, used when at least one section is expanded. + */ + hideAllSections?: string | undefined; + + /** + * - The text content for the 'Hide' + * button, used when a section is expanded. + */ + hideSection?: string | undefined; + + /** + * - The text content appended to the + * 'Hide' button's accessible name when a section is expanded. + */ + hideSectionAriaLabel?: string | undefined; + + /** + * - The text content for the 'Show all + * sections' button, used when all sections are collapsed. + */ + showAllSections?: string | undefined; + + /** + * - The text content for the 'Show' + * button, used when a section is collapsed. + */ + showSection?: string | undefined; + + /** + * - The text content appended to the + * 'Show' button's accessible name when a section is expanded. + */ + showSectionAriaLabel?: string | undefined; +} diff --git a/types/govuk-frontend/dist/govuk/components/button/button.d.mts b/types/govuk-frontend/dist/govuk/components/button/button.d.mts new file mode 100644 index 00000000000000..1968cbf4fa37e3 --- /dev/null +++ b/types/govuk-frontend/dist/govuk/components/button/button.d.mts @@ -0,0 +1 @@ +export * from "./button.js"; diff --git a/types/govuk-frontend/dist/govuk/components/button/button.d.ts b/types/govuk-frontend/dist/govuk/components/button/button.d.ts new file mode 100644 index 00000000000000..27c06945e4c58a --- /dev/null +++ b/types/govuk-frontend/dist/govuk/components/button/button.d.ts @@ -0,0 +1,48 @@ +import { GOVUKFrontendComponent } from "../../govuk-frontend-component.js"; + +/** + * JavaScript enhancements for the Button component + */ +export class Button extends GOVUKFrontendComponent { + /** + * Name for the component used when initialising using data-module attributes. + */ + static moduleName: string; + + /** + * Button default config + * + * @see {@link ButtonConfig} + */ + static defaults: ButtonConfig; + + /** + * Button config schema + * + * @satisfies {Schema} + */ + static schema: Readonly<{ + properties: { + preventDoubleClick: { + type: "boolean"; + }; + }; + }>; + + /** + * @param {Element | null} $module - HTML element to use for button + * @param {ButtonConfig} [config] - Button config + */ + constructor($module: Element | null, config?: ButtonConfig); +} + +/** + * Button config + */ +export interface ButtonConfig { + /** + * - Prevent accidental double + * clicks on submit buttons from submitting forms multiple times. + */ + preventDoubleClick?: boolean | undefined; +} diff --git a/types/govuk-frontend/dist/govuk/components/character-count/character-count.d.mts b/types/govuk-frontend/dist/govuk/components/character-count/character-count.d.mts new file mode 100644 index 00000000000000..8b45944b365015 --- /dev/null +++ b/types/govuk-frontend/dist/govuk/components/character-count/character-count.d.mts @@ -0,0 +1 @@ +export * from "./character-count.js"; diff --git a/types/govuk-frontend/dist/govuk/components/character-count/character-count.d.ts b/types/govuk-frontend/dist/govuk/components/character-count/character-count.d.ts new file mode 100644 index 00000000000000..b58e3d3e99ceb4 --- /dev/null +++ b/types/govuk-frontend/dist/govuk/components/character-count/character-count.d.ts @@ -0,0 +1,158 @@ +import { GOVUKFrontendComponent } from "../../govuk-frontend-component.js"; +import { type TranslationPluralForms } from "../../i18n.js"; + +/** + * Character count component + * + * Tracks the number of characters or words in the `.govuk-js-character-count` + * `