@ryan-pip/pulumi-fivetran 0.2.6 → 1.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/connector.d.ts +30 -21
- package/connector.js +4 -2
- package/connector.js.map +1 -1
- package/dbtGitProjectConfig.d.ts +1 -1
- package/dbtGitProjectConfig.js +1 -1
- package/dbtProject.d.ts +1 -1
- package/dbtProject.js +1 -1
- package/dbtTransformation.d.ts +1 -1
- package/dbtTransformation.js +1 -1
- package/destination.d.ts +0 -21
- package/destination.js +0 -2
- package/destination.js.map +1 -1
- package/getConnector.d.ts +2 -1
- package/getConnector.js.map +1 -1
- package/getConnectors.d.ts +33 -0
- package/getConnectors.js +30 -0
- package/getConnectors.js.map +1 -0
- package/getDestination.d.ts +0 -1
- package/getDestination.js.map +1 -1
- package/getDestinations.d.ts +33 -0
- package/getDestinations.js +30 -0
- package/getDestinations.js.map +1 -0
- package/getExternalLogs.d.ts +33 -0
- package/getExternalLogs.js +30 -0
- package/getExternalLogs.js.map +1 -0
- package/getQuickstartPackage.d.ts +74 -0
- package/getQuickstartPackage.js +50 -0
- package/getQuickstartPackage.js.map +1 -0
- package/getQuickstartPackages.d.ts +51 -0
- package/getQuickstartPackages.js +48 -0
- package/getQuickstartPackages.js.map +1 -0
- package/getTransformation.d.ts +90 -0
- package/getTransformation.js +54 -0
- package/getTransformation.js.map +1 -0
- package/getTransformationProject.d.ts +87 -0
- package/getTransformationProject.js +52 -0
- package/getTransformationProject.js.map +1 -0
- package/getTransformationProjects.d.ts +38 -0
- package/getTransformationProjects.js +42 -0
- package/getTransformationProjects.js.map +1 -0
- package/getTransformations.d.ts +51 -0
- package/getTransformations.js +48 -0
- package/getTransformations.js.map +1 -0
- package/index.d.ts +33 -9
- package/index.js +40 -14
- package/index.js.map +1 -1
- package/package.json +1 -1
- package/transformation.d.ts +151 -0
- package/transformation.js +114 -0
- package/transformation.js.map +1 -0
- package/transformationProject.d.ts +136 -0
- package/transformationProject.js +96 -0
- package/transformationProject.js.map +1 -0
- package/types/input.d.ts +2417 -114
- package/types/output.d.ts +1538 -119
- package/getLocalProcessingAgent.d.ts +0 -76
- package/getLocalProcessingAgent.js +0 -54
- package/getLocalProcessingAgent.js.map +0 -1
- package/getLocalProcessingAgents.d.ts +0 -42
- package/getLocalProcessingAgents.js +0 -46
- package/getLocalProcessingAgents.js.map +0 -1
- package/localProcessingAgent.d.ts +0 -127
- package/localProcessingAgent.js +0 -88
- package/localProcessingAgent.js.map +0 -1
package/types/output.d.ts
CHANGED
|
@@ -417,6 +417,7 @@ export interface ConnectorConfig {
|
|
|
417
417
|
* Field usage depends on `service` value:
|
|
418
418
|
* - Service `gainsightCustomerSuccess`: The access key for API authentication.
|
|
419
419
|
* - Service `gongio`: Your Gongio Access key.
|
|
420
|
+
* - Service `lineAds`: Your LINE Ads access key.
|
|
420
421
|
* - Service `planful`: Your Planful access key.
|
|
421
422
|
* - Service `retailnext`: Your RetailNext access key.
|
|
422
423
|
*/
|
|
@@ -426,6 +427,8 @@ export interface ConnectorConfig {
|
|
|
426
427
|
* - Service `appsflyer`: Your AWS access key ID.
|
|
427
428
|
* - Service `awsCostReport`: Access Key ID
|
|
428
429
|
* - Service `checkout`: Your Checkout.com access key ID.
|
|
430
|
+
* - Service `cloudtalk`: Your CloudTalk Access Key ID.
|
|
431
|
+
* - Service `nice`: Your NICE access key ID.
|
|
429
432
|
* - Service `s3`: Access Key ID
|
|
430
433
|
* - Service `wasabiCloudStorage`: Access Key ID
|
|
431
434
|
*/
|
|
@@ -434,7 +437,9 @@ export interface ConnectorConfig {
|
|
|
434
437
|
* Field usage depends on `service` value:
|
|
435
438
|
* - Service `awsCostReport`: Access Key Secret
|
|
436
439
|
* - Service `checkout`: Your Checkout.com access key secret.
|
|
440
|
+
* - Service `cloudtalk`: Your CloudTalk Access Key Secret.
|
|
437
441
|
* - Service `gongio`: Your Gongio Access Key Secret.
|
|
442
|
+
* - Service `nice`: Your NICE access key secret.
|
|
438
443
|
* - Service `s3`: Access Key Secret
|
|
439
444
|
* - Service `wasabiCloudStorage`: Access Key Secret
|
|
440
445
|
*/
|
|
@@ -451,14 +456,18 @@ export interface ConnectorConfig {
|
|
|
451
456
|
* - Service `getfeedback`: Your GetFeedback Access token.
|
|
452
457
|
* - Service `gocardless`: Your GoCardless API token.
|
|
453
458
|
* - Service `ironclad`: Your Ironclad access token.
|
|
459
|
+
* - Service `khorosMarketing`: Your Khoros Marketing access token.
|
|
454
460
|
* - Service `kustomer`: Your Kustomer API key.
|
|
455
461
|
* - Service `lattice`: Your Lattice API access token.
|
|
456
462
|
* - Service `launchdarkly`: Your LaunchDarkly access token.
|
|
463
|
+
* - Service `leapCrm`: Your Leap CRM access token.
|
|
457
464
|
* - Service `nylas`: Your Nylas access_token.
|
|
458
465
|
* - Service `planhat`: Your Planhat access token.
|
|
459
466
|
* - Service `rollbar`: Your Rollbar Access Token.
|
|
460
467
|
* - Service `samsara`: Your Samsara API token.
|
|
461
468
|
* - Service `slab`: Your Slab API key.
|
|
469
|
+
* - Service `stripe`: The Stripe API Restricted Key
|
|
470
|
+
* - Service `stripeTest`: The Stripe API Restricted Key
|
|
462
471
|
* - Service `talkwalker`: Your Talkwalker access token.
|
|
463
472
|
* - Service `workable`: Your Workable Access Token.
|
|
464
473
|
* - Service `workramp`: Your WorkRamp access token.
|
|
@@ -488,6 +497,7 @@ export interface ConnectorConfig {
|
|
|
488
497
|
* - Service `dear`: Your Dear Account ID.
|
|
489
498
|
* - Service `harvest`: Your Harvest Account ID.
|
|
490
499
|
* - Service `optimizely`: Your Optimizely account ID.
|
|
500
|
+
* - Service `rokt`: Your Rokt account ID.
|
|
491
501
|
* - Service `udemyBusiness`: Your Udemy Business account ID.
|
|
492
502
|
*/
|
|
493
503
|
accountId: string;
|
|
@@ -639,6 +649,11 @@ export interface ConnectorConfig {
|
|
|
639
649
|
* - Service `sqlServerSapEccHva`: The host address of the machine running the agent. Often the same as the DB host.
|
|
640
650
|
*/
|
|
641
651
|
agentHost: string;
|
|
652
|
+
/**
|
|
653
|
+
* Field usage depends on `service` value:
|
|
654
|
+
* - Service `phoenixAds`: Your Phoenix Ads Agent ID.
|
|
655
|
+
*/
|
|
656
|
+
agentId?: string;
|
|
642
657
|
/**
|
|
643
658
|
* Field usage depends on `service` value:
|
|
644
659
|
* - Service `oracleHva`: The home directory of the Oracle database.
|
|
@@ -774,6 +789,7 @@ export interface ConnectorConfig {
|
|
|
774
789
|
api?: string;
|
|
775
790
|
/**
|
|
776
791
|
* Field usage depends on `service` value:
|
|
792
|
+
* - Service `flywheelDigital`: Your Flywheel Digital API access token.
|
|
777
793
|
* - Service `shopify`: API access token of your custom app.
|
|
778
794
|
* - Service `square`: The Square API access token of your application.
|
|
779
795
|
*/
|
|
@@ -793,12 +809,14 @@ export interface ConnectorConfig {
|
|
|
793
809
|
* - Service `15five`: Your 15five API key.
|
|
794
810
|
* - Service `360learning`: Your 360Learning API Key.
|
|
795
811
|
* - Service `6sense`: Your 6sense API Key.
|
|
812
|
+
* - Service `acculynx`: Your Acculynx API key.
|
|
796
813
|
* - Service `activecampaign`: Your ActiveCampaign API key.
|
|
797
814
|
* - Service `affinity`: Your Affinity API key.
|
|
798
815
|
* - Service `airtable`: API key of the Airtable account.
|
|
799
816
|
* - Service `algolia`: Your Algolia API key.
|
|
800
817
|
* - Service `anvyl`: Your Anvyl API key.
|
|
801
818
|
* - Service `appcues`: Your Appcues API key.
|
|
819
|
+
* - Service `ashby`: Your Ashby API key.
|
|
802
820
|
* - Service `assembled`: Your Assembled API key.
|
|
803
821
|
* - Service `atlassianJiraAlign`: Your Jira Align API key.
|
|
804
822
|
* - Service `atlassianOpsGenie`: Your Opsgenie API key
|
|
@@ -807,8 +825,9 @@ export interface ConnectorConfig {
|
|
|
807
825
|
* - Service `avantlink`: Your AvantLink API key.
|
|
808
826
|
* - Service `ballotready`: Your BallotReady API token.
|
|
809
827
|
* - Service `bamboohr`: Your API Key.
|
|
810
|
-
* - Service `bazaarvoice`: Your Bazaarvoice
|
|
828
|
+
* - Service `bazaarvoice`: Your Bazaarvoice API key.
|
|
811
829
|
* - Service `betterworks`: Your Betterworks API key.
|
|
830
|
+
* - Service `bigmarker`: Your BigMarker API key.
|
|
812
831
|
* - Service `bizzabo`: Your Bizzabo API key.
|
|
813
832
|
* - Service `braveAds`: Your Brave Ads API key
|
|
814
833
|
* - Service `braze`: Your Braze API Key.
|
|
@@ -827,6 +846,8 @@ export interface ConnectorConfig {
|
|
|
827
846
|
* - Service `cimis`: Your Cimis API key.
|
|
828
847
|
* - Service `circleci`: Your CircleCI API Key.
|
|
829
848
|
* - Service `clickup`: Your ClickUp API key.
|
|
849
|
+
* - Service `clockify`: Your Clockify API key.
|
|
850
|
+
* - Service `clockodo`: Your Clockodo API key.
|
|
830
851
|
* - Service `close`: Your Close API key.
|
|
831
852
|
* - Service `cloudbeds`: Your Cloudbeds API key.
|
|
832
853
|
* - Service `clubspeed`: Your Clubspeed API key.
|
|
@@ -851,7 +872,9 @@ export interface ConnectorConfig {
|
|
|
851
872
|
* - Service `easypost`: Your EasyPost API Key.
|
|
852
873
|
* - Service `electronicTenantSolutions`: Your Electronic Tenant Solutions API key.
|
|
853
874
|
* - Service `eventsforce`: Your Eventsforce API secret key.
|
|
875
|
+
* - Service `everflow`: Your Everflow API key.
|
|
854
876
|
* - Service `everhour`: Your Everhour API Token.
|
|
877
|
+
* - Service `expensein`: Your ExpenseIn API key.
|
|
855
878
|
* - Service `factorial`: Your Factorial API key.
|
|
856
879
|
* - Service `firehydrant`: Your FireHydrant API key.
|
|
857
880
|
* - Service `float`: Your Float API key.
|
|
@@ -897,8 +920,12 @@ export interface ConnectorConfig {
|
|
|
897
920
|
* - Service `linksquares`: Your LinkSquares API key.
|
|
898
921
|
* - Service `lob`: Your Lob API key.
|
|
899
922
|
* - Service `loop`: Your Loop API key.
|
|
923
|
+
* - Service `lucca`: Your Lucca API key.
|
|
900
924
|
* - Service `luma`: Your Luma API key.
|
|
925
|
+
* - Service `maileon`: Your Maileon API key.
|
|
901
926
|
* - Service `mailgun`: Your Mailgun API key.
|
|
927
|
+
* - Service `mailjet`: Your Mailjet API key.
|
|
928
|
+
* - Service `malomo`: Your Malomo API key.
|
|
902
929
|
* - Service `mambu`: Your Mambu API key.
|
|
903
930
|
* - Service `mandrill`: Your Mandrill API key.
|
|
904
931
|
* - Service `maxioChargify`: Enter Your API Key.
|
|
@@ -911,16 +938,19 @@ export interface ConnectorConfig {
|
|
|
911
938
|
* - Service `ordway`: Your Ordway API key.
|
|
912
939
|
* - Service `ortto`: Your Ortto API key.
|
|
913
940
|
* - Service `pagerduty`: Your PagerDuty API key.
|
|
941
|
+
* - Service `pandadoc`: Your PandaDoc API key.
|
|
914
942
|
* - Service `papershift`: Your Papershift API Key
|
|
915
943
|
* - Service `partnerize`: Your Partnerize user API key.
|
|
916
944
|
* - Service `persona`: Your Persona API key.
|
|
917
945
|
* - Service `picqer`: Your Picqer API key.
|
|
946
|
+
* - Service `pigment`: Your Pigment API key.
|
|
918
947
|
* - Service `pinpoint`: Your Pinpoint API key.
|
|
919
948
|
* - Service `pipe17`: The Pipe17 API key.
|
|
920
949
|
* - Service `placerai`: Your Placer.ai API key.
|
|
921
950
|
* - Service `playvox`: Your Playvox API Key.
|
|
922
951
|
* - Service `posthog`: Your PostHog API key.
|
|
923
952
|
* - Service `prive`: Your Prive API key.
|
|
953
|
+
* - Service `prosperstack`: Your ProsperStack API key.
|
|
924
954
|
* - Service `qualaroo`: Your Qualaroo API Key.
|
|
925
955
|
* - Service `quorum`: Your Quorum API key.
|
|
926
956
|
* - Service `reboundReturns`: Your ReBound Returns API key.
|
|
@@ -934,6 +964,7 @@ export interface ConnectorConfig {
|
|
|
934
964
|
* - Service `rippling`: Your Rippling API key.
|
|
935
965
|
* - Service `rocketlane`: Your Rocketlane API key.
|
|
936
966
|
* - Service `rootly`: Your Rootly API key.
|
|
967
|
+
* - Service `ruddr`: Your Ruddr API key.
|
|
937
968
|
* - Service `safebase`: Your SafeBase API key.
|
|
938
969
|
* - Service `sageHr`: Your Sage HR API key.
|
|
939
970
|
* - Service `sailthru`: The Sailthru API key.
|
|
@@ -961,18 +992,23 @@ export interface ConnectorConfig {
|
|
|
961
992
|
* - Service `teamtailor`: Your Teamtailor API key.
|
|
962
993
|
* - Service `testrail`: Your TestRail API key.
|
|
963
994
|
* - Service `ticketTailor`: Your Ticket Tailor API key.
|
|
964
|
-
* - Service `transcend`: Your Transcend API
|
|
995
|
+
* - Service `transcend`: Your Transcend API key.
|
|
965
996
|
* - Service `trello`: Your TRELLO api key.
|
|
997
|
+
* - Service `tripleWhale`: Your Triple Whale API key.
|
|
966
998
|
* - Service `uppromote`: Your UpPromote API key.
|
|
967
999
|
* - Service `veeqo`: Your Veeqo API key.
|
|
1000
|
+
* - Service `venminder`: Your Venminder API key.
|
|
968
1001
|
* - Service `visitByGes`: Your Visit by GES API key.
|
|
969
1002
|
* - Service `vitally`: Your Vitally API key.
|
|
970
1003
|
* - Service `vonage`: Your Vonage API Key.
|
|
971
1004
|
* - Service `vts`: Your VTS API key.
|
|
972
1005
|
* - Service `webconnex`: Your Webconnex API key.
|
|
1006
|
+
* - Service `wickedReports`: Your Wicked Reports API key.
|
|
1007
|
+
* - Service `workleapOfficevibe`: Your Workleap Officevibe API key.
|
|
973
1008
|
* - Service `xsolla`: Your Xsolla API key.
|
|
974
1009
|
* - Service `yougovSport`: Your Yougov Sport API key.
|
|
975
1010
|
* - Service `zingtree`: Your Zingtree API key.
|
|
1011
|
+
* - Service `zip`: Your Zip API key.
|
|
976
1012
|
*/
|
|
977
1013
|
apiKey: string;
|
|
978
1014
|
/**
|
|
@@ -995,6 +1031,11 @@ export interface ConnectorConfig {
|
|
|
995
1031
|
* - Service `marketo`: Allowed number of API requests to Marketo instance per day, the default value is 10000.
|
|
996
1032
|
*/
|
|
997
1033
|
apiQuota: number;
|
|
1034
|
+
/**
|
|
1035
|
+
* Field usage depends on `service` value:
|
|
1036
|
+
* - Service `theMovieDatabase`: Your The Movie Database API read access token.
|
|
1037
|
+
*/
|
|
1038
|
+
apiReadAccessToken?: string;
|
|
998
1039
|
/**
|
|
999
1040
|
* Field usage depends on `service` value:
|
|
1000
1041
|
* - Service `qualtrics`: Allowed number of API requests to Qualtrics per minute, the default value is 2000. Maximum allowed number is 3000 because brands may make up to 3000 API requests per minute across all of its API calls.
|
|
@@ -1005,11 +1046,12 @@ export interface ConnectorConfig {
|
|
|
1005
1046
|
* - Service `confluentCloud`: API Secret
|
|
1006
1047
|
* - Service `forjCommunity`: Your Forj Community API secret.
|
|
1007
1048
|
* - Service `friendbuy`: Your Friendbuy API secret.
|
|
1008
|
-
* - Service `justcall`: Your JustCall API
|
|
1049
|
+
* - Service `justcall`: Your JustCall API secret.
|
|
1009
1050
|
* - Service `liftoff`: Your Liftoff API secret.
|
|
1010
1051
|
* - Service `mixpanel`: Mixpanel API Secret.
|
|
1011
1052
|
* - Service `qualaroo`: Your Qualaroo API Secret.
|
|
1012
1053
|
* - Service `sailthru`: The Sailthru API secret.
|
|
1054
|
+
* - Service `shareasale`: Your ShareASale API secret.
|
|
1013
1055
|
* - Service `vonage`: Your Vonage API Secret.
|
|
1014
1056
|
*/
|
|
1015
1057
|
apiSecret: string;
|
|
@@ -1029,12 +1071,14 @@ export interface ConnectorConfig {
|
|
|
1029
1071
|
* - Service `aircall`: Your Aircall API Token.
|
|
1030
1072
|
* - Service `appsflyer`: API Token for AppsFlyer's PULL API.
|
|
1031
1073
|
* - Service `awin`: Your Awin API Token.
|
|
1074
|
+
* - Service `backbonePlm`: Your Backbone PLM API token.
|
|
1032
1075
|
* - Service `brex`: Your Brex API token
|
|
1033
1076
|
* - Service `buildkite`: Your Buildkite API token.
|
|
1034
1077
|
* - Service `buzzsprout`: Your Buzzsprout API token.
|
|
1035
|
-
* - Service `centra`: Your Centra API
|
|
1078
|
+
* - Service `centra`: Your Centra API token.
|
|
1036
1079
|
* - Service `chameleon`: Your Chameleon API token.
|
|
1037
1080
|
* - Service `clari`: Your Clari API token.
|
|
1081
|
+
* - Service `cloudflareAnalytics`: Your Cloudflare Analytics API token.
|
|
1038
1082
|
* - Service `confluence`: The Confluence API token.
|
|
1039
1083
|
* - Service `dixa`: Your Dixa API token.
|
|
1040
1084
|
* - Service `drip`: Your Drip API Token.
|
|
@@ -1053,6 +1097,7 @@ export interface ConnectorConfig {
|
|
|
1053
1097
|
* - Service `mixmax`: Mixmax API token.
|
|
1054
1098
|
* - Service `okta`: Your Okta API token.
|
|
1055
1099
|
* - Service `ordway`: Your Ordway API token.
|
|
1100
|
+
* - Service `packiyo`: Your Packiyo API token.
|
|
1056
1101
|
* - Service `pipedrive`: (Optional)Your Pipedrive personal API token
|
|
1057
1102
|
* - Service `pivotalTracker`: Pivotal Tracker API token.
|
|
1058
1103
|
* - Service `postmark`: Your Postmark account API token.
|
|
@@ -1063,9 +1108,11 @@ export interface ConnectorConfig {
|
|
|
1063
1108
|
* - Service `referralhero`: Your Referralhero API token.
|
|
1064
1109
|
* - Service `resourceManagementBySmartsheet`: Your Resource Management by Smartsheet API token.
|
|
1065
1110
|
* - Service `retently`: Your Retently API token.
|
|
1111
|
+
* - Service `reviewsai`: Your REVIEWS.ai API token.
|
|
1066
1112
|
* - Service `rundeck`: Your Rundeck API token.
|
|
1067
1113
|
* - Service `safetyculture`: Your SafetyCulture API token.
|
|
1068
1114
|
* - Service `sensorTower`: Your Sensor Tower API token.
|
|
1115
|
+
* - Service `sentry`: Your Sentry auth token.
|
|
1069
1116
|
* - Service `simplecast`: Your Simplecast API token.
|
|
1070
1117
|
* - Service `snyk`: Your Snyk API token.
|
|
1071
1118
|
* - Service `textus`: Your TextUs API token.
|
|
@@ -1084,6 +1131,11 @@ export interface ConnectorConfig {
|
|
|
1084
1131
|
* - Service `braze`: Your Braze API URL.
|
|
1085
1132
|
*/
|
|
1086
1133
|
apiUrl: string;
|
|
1134
|
+
/**
|
|
1135
|
+
* Field usage depends on `service` value:
|
|
1136
|
+
* - Service `amazonDsp`: Your Amazon DSP API URL region.
|
|
1137
|
+
*/
|
|
1138
|
+
apiUrlRegion: string;
|
|
1087
1139
|
/**
|
|
1088
1140
|
* Field usage depends on `service` value:
|
|
1089
1141
|
* - Service `zendesk`: Maximum Zendesk Api Usage allowed
|
|
@@ -1113,6 +1165,7 @@ export interface ConnectorConfig {
|
|
|
1113
1165
|
* Field usage depends on `service` value:
|
|
1114
1166
|
* - Service `churnkey`: Your Churnkey APP ID.
|
|
1115
1167
|
* - Service `openExchangeRates`: Your Open Exchange Rates App Id.
|
|
1168
|
+
* - Service `rokt`: Your Rokt app ID.
|
|
1116
1169
|
*/
|
|
1117
1170
|
appId?: string;
|
|
1118
1171
|
/**
|
|
@@ -1133,6 +1186,11 @@ export interface ConnectorConfig {
|
|
|
1133
1186
|
* - Service `brightpearl`: Your Brightpearl app reference.
|
|
1134
1187
|
*/
|
|
1135
1188
|
appReference?: string;
|
|
1189
|
+
/**
|
|
1190
|
+
* Field usage depends on `service` value:
|
|
1191
|
+
* - Service `rokt`: Your Rokt app secret.
|
|
1192
|
+
*/
|
|
1193
|
+
appSecret?: string;
|
|
1136
1194
|
appSecretToken?: string;
|
|
1137
1195
|
/**
|
|
1138
1196
|
* Field usage depends on `service` value:
|
|
@@ -1163,6 +1221,7 @@ export interface ConnectorConfig {
|
|
|
1163
1221
|
/**
|
|
1164
1222
|
* Field usage depends on `service` value:
|
|
1165
1223
|
* - Service `algolia`: Your Algolia application ID.
|
|
1224
|
+
* - Service `xactly`: Your Xactly Application ID.
|
|
1166
1225
|
*/
|
|
1167
1226
|
applicationId?: string;
|
|
1168
1227
|
/**
|
|
@@ -1264,6 +1323,7 @@ export interface ConnectorConfig {
|
|
|
1264
1323
|
audience?: string;
|
|
1265
1324
|
/**
|
|
1266
1325
|
* Field usage depends on `service` value:
|
|
1326
|
+
* - Service `databricksDb`: Token-based authentication type
|
|
1267
1327
|
* - Service `redshiftDb`: Password-based authentication type
|
|
1268
1328
|
* - Service `snowflakeDb`: Password-based or key-based authentication type
|
|
1269
1329
|
*/
|
|
@@ -1280,8 +1340,16 @@ export interface ConnectorConfig {
|
|
|
1280
1340
|
authEnvironment: string;
|
|
1281
1341
|
/**
|
|
1282
1342
|
* Field usage depends on `service` value:
|
|
1343
|
+
* - Service `auroraPostgres`: Database authentication method
|
|
1344
|
+
* - Service `azurePostgres`: Database authentication method
|
|
1283
1345
|
* - Service `azureSqlDb`: Authentication Method.
|
|
1284
1346
|
* - Service `azureSqlManagedDb`: Authentication Method.
|
|
1347
|
+
* - Service `googleCloudPostgresql`: Database authentication method
|
|
1348
|
+
* - Service `herokuPostgres`: Database authentication method
|
|
1349
|
+
* - Service `postgres`: Database authentication method
|
|
1350
|
+
* - Service `postgresRds`: Database authentication method
|
|
1351
|
+
* - Service `sqlServerHva`: Authentication Method
|
|
1352
|
+
* - Service `sqlServerSapEccHva`: Authentication Method
|
|
1285
1353
|
* - Service `webhooks`: The authentication mechanism you want to use
|
|
1286
1354
|
*/
|
|
1287
1355
|
authMethod?: string;
|
|
@@ -1313,6 +1381,11 @@ export interface ConnectorConfig {
|
|
|
1313
1381
|
* - Service `wasabiCloudStorage`: The Wasabi Cloud Storage Access approach. Required for connector creation. Default value: `ACCESS_KEY`.
|
|
1314
1382
|
*/
|
|
1315
1383
|
authType: string;
|
|
1384
|
+
/**
|
|
1385
|
+
* Field usage depends on `service` value:
|
|
1386
|
+
* - Service `amazonDsp`: Your Amazon DSP auth grant URL region.
|
|
1387
|
+
*/
|
|
1388
|
+
authUrlRegion: string;
|
|
1316
1389
|
/**
|
|
1317
1390
|
* Field usage depends on `service` value:
|
|
1318
1391
|
* - Service `adobeAnalytics`: Authentication Method
|
|
@@ -1320,6 +1393,11 @@ export interface ConnectorConfig {
|
|
|
1320
1393
|
* - Service `esSelfHosted`: The authentication method used to connect to your cluster.
|
|
1321
1394
|
* - Service `opendistro`: The authentication method used to connect to your cluster.
|
|
1322
1395
|
* - Service `opensearch`: The authentication method used to connect to your cluster.
|
|
1396
|
+
* - Service `oracleFusionCloudAppsCrm`: The Oracle Fusion Cloud authentication method.
|
|
1397
|
+
* - Service `oracleFusionCloudAppsFscm`: The Oracle Fusion Cloud authentication method.
|
|
1398
|
+
* - Service `oracleFusionCloudAppsHcm`: The Oracle Fusion Cloud authentication method.
|
|
1399
|
+
* - Service `salesforce`: (Optional) Authentication type (default value = `STANDARD`)
|
|
1400
|
+
* - Service `salesforceSandbox`: (Optional) Authentication type (default value = `STANDARD`)
|
|
1323
1401
|
*/
|
|
1324
1402
|
authenticationMethod: string;
|
|
1325
1403
|
authorizationMethod: string;
|
|
@@ -1330,6 +1408,11 @@ export interface ConnectorConfig {
|
|
|
1330
1408
|
awsRegionCode: string;
|
|
1331
1409
|
backintConfigurationPath?: string;
|
|
1332
1410
|
backintExecutablePath?: string;
|
|
1411
|
+
/**
|
|
1412
|
+
* Field usage depends on `service` value:
|
|
1413
|
+
* - Service `zendesk`: Limit of the Historical Sync Time for selected tables
|
|
1414
|
+
*/
|
|
1415
|
+
backwardSyncLimit?: string;
|
|
1333
1416
|
/**
|
|
1334
1417
|
* Field usage depends on `service` value:
|
|
1335
1418
|
* - Service `openExchangeRates`: Your Open Exchange Rates Base Currency.
|
|
@@ -1348,21 +1431,28 @@ export interface ConnectorConfig {
|
|
|
1348
1431
|
/**
|
|
1349
1432
|
* Field usage depends on `service` value:
|
|
1350
1433
|
* - Service `aha`: Your Aha! subdomain.
|
|
1434
|
+
* - Service `akeneo`: Your Akeneo base URL.
|
|
1351
1435
|
* - Service `billingPlatform`: Your BillingPlatform subdomain.
|
|
1352
1436
|
* - Service `boostr`: Your Boostr base URL.
|
|
1353
1437
|
* - Service `brex`: Your Brex Base URL
|
|
1354
|
-
* - Service `centra`: Your Centra
|
|
1438
|
+
* - Service `centra`: Your Centra base URL.
|
|
1439
|
+
* - Service `cornerstone`: Your Cornerstone base URL.
|
|
1355
1440
|
* - Service `cultureAmp`: Your Culture Amp base URL.
|
|
1441
|
+
* - Service `datadog`: Your Datadog base url.
|
|
1442
|
+
* - Service `factbird`: Your Factbird base url.
|
|
1443
|
+
* - Service `fillout`: Your Fillout Base URL.
|
|
1356
1444
|
* - Service `financialForce`: (Optional) The custom Salesforce domain. Make sure that the `baseUrl` starts with `https://`.
|
|
1357
1445
|
* - Service `freshsales`: Your Freshsales product.
|
|
1358
1446
|
* - Service `gongio`: Your Gong API Base URL.
|
|
1359
1447
|
* - Service `ironclad`: Your Ironclad base url.
|
|
1360
1448
|
* - Service `jotform`: Your Jotform base URL.
|
|
1361
1449
|
* - Service `mailgun`: Your Mailgun base URL.
|
|
1450
|
+
* - Service `nice`: Your NICE base URL.
|
|
1362
1451
|
* - Service `ortto`: Your Ortto base URL. Possible values: `api`, `api.au`, `api.eu`.
|
|
1363
1452
|
* - Service `prismaCloud`: Your Prisma Cloud admin console URL.
|
|
1364
1453
|
* - Service `salesforce`: (Optional) The custom Salesforce domain. Make sure that the `baseUrl` starts with `https://`.
|
|
1365
1454
|
* - Service `salesforceSandbox`: (Optional) The custom Salesforce domain. Make sure that the `baseUrl` starts with `https://`.
|
|
1455
|
+
* - Service `stickyio`: Your sticky.io base URL .
|
|
1366
1456
|
* - Service `veevavault`: Your Veeva Vault base URL.
|
|
1367
1457
|
* - Service `vitally`: Your Vitally base URL.
|
|
1368
1458
|
*/
|
|
@@ -1440,6 +1530,11 @@ export interface ConnectorConfig {
|
|
|
1440
1530
|
* - Service `birdeye`: Your Birdeye Business ID.
|
|
1441
1531
|
*/
|
|
1442
1532
|
businessId?: string;
|
|
1533
|
+
/**
|
|
1534
|
+
* Field usage depends on `service` value:
|
|
1535
|
+
* - Service `deposco`: Your Deposco business unit.
|
|
1536
|
+
*/
|
|
1537
|
+
businessUnit?: string;
|
|
1443
1538
|
/**
|
|
1444
1539
|
* Field usage depends on `service` value:
|
|
1445
1540
|
* - Service `pardot`: Business Unit Id
|
|
@@ -1454,6 +1549,8 @@ export interface ConnectorConfig {
|
|
|
1454
1549
|
* Field usage depends on `service` value:
|
|
1455
1550
|
* - Service `anaplan`: The contents of your PEM certificate file. Must be populated if `authMode` is set to `Certificate`.
|
|
1456
1551
|
* - Service `qualtrics`: Your Client Certificate
|
|
1552
|
+
* - Service `salesforce`: Provide content of the `.pem` certificate (only when authenticationMethod = `ADVANCED`).
|
|
1553
|
+
* - Service `salesforceSandbox`: Provide content of the `.pem` certificate (only when authenticationMethod = `ADVANCED`).
|
|
1457
1554
|
*/
|
|
1458
1555
|
certificate: string;
|
|
1459
1556
|
/**
|
|
@@ -1487,37 +1584,55 @@ export interface ConnectorConfig {
|
|
|
1487
1584
|
* - Service `adobeWorkfront`: Your Adobe Workfront client ID.
|
|
1488
1585
|
* - Service `adpWorkforceNow`: Your ADP Client ID.
|
|
1489
1586
|
* - Service `akamai`: Your Akamai client ID.
|
|
1587
|
+
* - Service `akeneo`: Your Akeneo client ID.
|
|
1490
1588
|
* - Service `auth0`: Your Auth0 client ID.
|
|
1589
|
+
* - Service `autodeskBim360`: Your Autodesk BIM 360 client ID.
|
|
1590
|
+
* - Service `biginByZohoCrm`: Your Bigin by Zoho CRM Client Id
|
|
1491
1591
|
* - Service `billingPlatform`: Your BillingPlatform client ID.
|
|
1592
|
+
* - Service `bingWebmasterTools`: Your Bing Webmaster Tools client ID.
|
|
1492
1593
|
* - Service `brightcove`: Your Brightcove client ID.
|
|
1493
|
-
* - Service `brightpearl`: Your Brightpearl client
|
|
1594
|
+
* - Service `brightpearl`: Your Brightpearl client ID.
|
|
1494
1595
|
* - Service `buildium`: Your Buildium API client ID.
|
|
1495
1596
|
* - Service `canvasByInstructure`: Your Canvas by Instructure client ID.
|
|
1597
|
+
* - Service `canvasData2ByInstructure`: Your Canvas Data 2 by Instructure client ID.
|
|
1496
1598
|
* - Service `castorEdc`: Your Castor EDC client Id.
|
|
1599
|
+
* - Service `clazar`: Your Clazar client ID.
|
|
1600
|
+
* - Service `cloudbeds`: Your Cloudbeds client ID.
|
|
1497
1601
|
* - Service `commercetools`: Your commercetools client ID.
|
|
1498
1602
|
* - Service `concur`: The SAP Concur Client ID.
|
|
1603
|
+
* - Service `constantContact`: Your Constant Contact client ID.
|
|
1604
|
+
* - Service `cornerstone`: Your Cornerstone client ID.
|
|
1499
1605
|
* - Service `coupa`: Your Coupa clientId
|
|
1500
1606
|
* - Service `criteo`: Your Criteo Client ID.
|
|
1501
1607
|
* - Service `criteoRetailMedia`: Your Criteo Retail Media client ID.
|
|
1502
1608
|
* - Service `cultureAmp`: Your Culture Amp client ID.
|
|
1503
1609
|
* - Service `cvent`: Your Cvent client ID.
|
|
1504
1610
|
* - Service `d2lBrightspace`: Your D2L Brightspace client ID.
|
|
1611
|
+
* - Service `dialpad`: Your Dialpad client ID.
|
|
1505
1612
|
* - Service `ebay`: Your eBay app ID.
|
|
1506
1613
|
* - Service `exactOnline`: Your Exact Online client ID.
|
|
1614
|
+
* - Service `fillout`: Your Fillout client ID.
|
|
1507
1615
|
* - Service `flexport`: The Flexport API Key.
|
|
1616
|
+
* - Service `formstack`: Your Formstack client ID.
|
|
1508
1617
|
* - Service `genesys`: Your Genesys client ID.
|
|
1509
1618
|
* - Service `hanaSapHvaEccNetweaver`: Three-digit (000-999) identifier of the SAP client, which is sent to an AS ABAP upon logon.
|
|
1510
1619
|
* - Service `hanaSapHvaS4Netweaver`: Three-digit (000-999) identifier of the SAP client, which is sent to an AS ABAP upon logon.
|
|
1620
|
+
* - Service `hiltiOntrack`: Your Hilti On!Track client ID.
|
|
1511
1621
|
* - Service `ilevel`: Your iLevel Client ID.
|
|
1512
1622
|
* - Service `instructure`: Your Instructure client ID.
|
|
1513
1623
|
* - Service `integralAdScience`: Your integralAdScience client id.
|
|
1624
|
+
* - Service `ironclad`: Your Ironclad client ID.
|
|
1514
1625
|
* - Service `jamaSoftware`: Your Jama Software client ID.
|
|
1626
|
+
* - Service `jibble`: Your Jibble client ID.
|
|
1627
|
+
* - Service `khorosCommunities`: Your Khoros Communities client ID.
|
|
1515
1628
|
* - Service `lookerSource`: Your Looker Client ID.
|
|
1516
1629
|
* - Service `marketo`: Marketo REST API Client Id.
|
|
1517
1630
|
* - Service `medallia`: Medallia Client ID
|
|
1518
1631
|
* - Service `microsoftEntraId`: Your Microsoft Entra ID Client ID.
|
|
1632
|
+
* - Service `microsoftPowerBi`: Your Microsoft Power BI client ID.
|
|
1519
1633
|
* - Service `microsoftTeams`: Your Microsoft Teams Client ID.
|
|
1520
1634
|
* - Service `navan`: Your Navan client ID.
|
|
1635
|
+
* - Service `nice`: Your NICE client ID.
|
|
1521
1636
|
* - Service `on24`: Your ON24 client ID.
|
|
1522
1637
|
* - Service `oracleSapHvaNetweaver`: Three-digit (000-999) identifier of the SAP client, which is sent to an AS ABAP upon logon.
|
|
1523
1638
|
* - Service `paychex`: Your Paychex client ID.
|
|
@@ -1534,6 +1649,7 @@ export interface ConnectorConfig {
|
|
|
1534
1649
|
* - Service `salesforceCommerceCloud`: The Salesforce Commerce Cloud Client ID.
|
|
1535
1650
|
* - Service `salesforceMarketingCloud`: The Salesforce Marketing Cloud client ID.
|
|
1536
1651
|
* - Service `salesloft`: `Client ID` of your Salesloft client application.
|
|
1652
|
+
* - Service `sana`: Your Sana client ID.
|
|
1537
1653
|
* - Service `sapSuccessFactors`: Your SAP SuccessFactors Client ID.
|
|
1538
1654
|
* - Service `servicenow`: ServiceNow Client ID.
|
|
1539
1655
|
* - Service `servicetitan`: Your ServiceTitan client ID.
|
|
@@ -1541,17 +1657,22 @@ export interface ConnectorConfig {
|
|
|
1541
1657
|
* - Service `shipnetwork`: Your ShipNetwork client ID.
|
|
1542
1658
|
* - Service `sigmaComputingSource`: Your Sigma Computing client ID.
|
|
1543
1659
|
* - Service `skillstx`: Your SkillsTX client ID.
|
|
1660
|
+
* - Service `skimlinks`: Your Skimlinks client ID.
|
|
1544
1661
|
* - Service `smartrecruiters`: Your SmartRecruiters client ID.
|
|
1545
1662
|
* - Service `splash`: Your Splash client ID.
|
|
1546
1663
|
* - Service `square`: The Application ID of your organization.
|
|
1547
1664
|
* - Service `standardMetrics`: Your Standard Metrics Client ID.
|
|
1665
|
+
* - Service `sugarcrm`: Your SugarCRM client ID.
|
|
1548
1666
|
* - Service `swoogo`: Your Swoogo client Id.
|
|
1549
1667
|
* - Service `taboola`: The Taboola client ID.
|
|
1550
1668
|
* - Service `talkdesk`: The Client ID of your OAuth Client
|
|
1669
|
+
* - Service `tive`: Your Tive client ID.
|
|
1551
1670
|
* - Service `toast`: Your Toast client ID.
|
|
1552
1671
|
* - Service `trelica`: Your Trelica client ID.
|
|
1672
|
+
* - Service `tremendous`: Your Tremendous client ID.
|
|
1553
1673
|
* - Service `tymeshift`: Your Tymeshift email.
|
|
1554
1674
|
* - Service `udemyBusiness`: Your Udemy Business client ID.
|
|
1675
|
+
* - Service `vimeo`: Your Vimeo client ID.
|
|
1555
1676
|
* - Service `visma`: Your Visma client ID.
|
|
1556
1677
|
* - Service `vonageContactCenter`: Your Vonage Contact Center client ID.
|
|
1557
1678
|
* - Service `walmartMarketplace`: Your Walmart Marketplace client ID.
|
|
@@ -1612,34 +1733,50 @@ export interface ConnectorConfig {
|
|
|
1612
1733
|
* - Service `adobeWorkfront`: Your Adobe Workfront client secret.
|
|
1613
1734
|
* - Service `adpWorkforceNow`: Your ADP Client Secret.
|
|
1614
1735
|
* - Service `akamai`: Your Akamai client secret.
|
|
1615
|
-
* - Service `
|
|
1736
|
+
* - Service `akeneo`: Your Akeneo client secret.
|
|
1737
|
+
* - Service `auth0`: Your Auth0 client secret.
|
|
1738
|
+
* - Service `autodeskBim360`: Your Autodesk BIM 360 client secret.
|
|
1739
|
+
* - Service `biginByZohoCrm`: Your Bigin by Zoho CRM Client Secret
|
|
1616
1740
|
* - Service `billingPlatform`: Your BillingPlatform client secret.
|
|
1741
|
+
* - Service `bingWebmasterTools`: Your Bing Webmaster Tools client secret.
|
|
1617
1742
|
* - Service `brightcove`: Your Brightcove client secret.
|
|
1618
1743
|
* - Service `brightpearl`: Your Brightpearl client secret.
|
|
1619
1744
|
* - Service `canvasByInstructure`: Your Canvas by Instructure client secret.
|
|
1620
1745
|
* - Service `castorEdc`: Your Castor EDC Client Secret.
|
|
1746
|
+
* - Service `clazar`: Your Clazar client secret.
|
|
1747
|
+
* - Service `cloudbeds`: Your Cloudbeds client secret.
|
|
1621
1748
|
* - Service `commercetools`: Your commercetools client secret.
|
|
1622
1749
|
* - Service `concur`: The SAP Concur Client secret.
|
|
1750
|
+
* - Service `constantContact`: Your Constant Contact client secret.
|
|
1751
|
+
* - Service `cornerstone`: Your Cornerstone client secret.
|
|
1623
1752
|
* - Service `coupa`: Your Coupa clientId
|
|
1624
1753
|
* - Service `criteo`: Your Criteo client secret key.
|
|
1625
|
-
* - Service `criteoRetailMedia`: Your Criteo Retail Media client
|
|
1754
|
+
* - Service `criteoRetailMedia`: Your Criteo Retail Media client secret.
|
|
1626
1755
|
* - Service `cultureAmp`: Your Culture Amp client secret.
|
|
1627
1756
|
* - Service `cvent`: Your Cvent client secret.
|
|
1628
1757
|
* - Service `d2lBrightspace`: Your D2L Brightspace client secret.
|
|
1758
|
+
* - Service `dialpad`: Your Dialpad client secret.
|
|
1629
1759
|
* - Service `ebay`: Your eBay cert ID.
|
|
1630
1760
|
* - Service `exactOnline`: Your Exact Online client secret.
|
|
1761
|
+
* - Service `fillout`: Your Fillout client secret
|
|
1631
1762
|
* - Service `flexport`: The Flexport API Secret.
|
|
1763
|
+
* - Service `formstack`: Your Formstack client secret.
|
|
1632
1764
|
* - Service `genesys`: Your Genesys client secret.
|
|
1765
|
+
* - Service `hiltiOntrack`: Your Hilti On!Track client secret.
|
|
1633
1766
|
* - Service `ilevel`: Your iLevel Client Secret.
|
|
1634
1767
|
* - Service `instructure`: Your Instructure client secret.
|
|
1635
1768
|
* - Service `integralAdScience`: Your integralAdScience client secret.
|
|
1769
|
+
* - Service `ironclad`: Your Ironclad client secret.
|
|
1636
1770
|
* - Service `jamaSoftware`: Your Jama Software client secret.
|
|
1771
|
+
* - Service `jibble`: Your Jibble client secret.
|
|
1637
1772
|
* - Service `lookerSource`: Your Looker Client Secret.
|
|
1638
1773
|
* - Service `marketo`: Marketo REST API Client Secret.
|
|
1639
1774
|
* - Service `medallia`: Medallia Client Secret key
|
|
1640
1775
|
* - Service `microsoftEntraId`: Your Microsoft Entra ID Client Secret.
|
|
1776
|
+
* - Service `microsoftPowerBi`: Your Microsoft Power BI client secret.
|
|
1641
1777
|
* - Service `microsoftTeams`: Your Microsoft Teams Client Secret.
|
|
1642
1778
|
* - Service `navan`: Your Navan client secret.
|
|
1779
|
+
* - Service `nice`: Your NICE client secret.
|
|
1643
1780
|
* - Service `paychex`: Your Paychex client secret.
|
|
1644
1781
|
* - Service `personio`: Your Personio secret.
|
|
1645
1782
|
* - Service `piwikPro`: Your Piwik PRO client secret.
|
|
@@ -1652,24 +1789,30 @@ export interface ConnectorConfig {
|
|
|
1652
1789
|
* - Service `salesforceCommerceCloud`: The Salesforce Commerce Cloud Client secret.
|
|
1653
1790
|
* - Service `salesforceMarketingCloud`: The Salesforce Marketing Cloud client secret.
|
|
1654
1791
|
* - Service `salesloft`: `Client Secret` of your Salesloft client application.
|
|
1792
|
+
* - Service `sana`: Your Sana client secret.
|
|
1655
1793
|
* - Service `sapSuccessFactors`: Your SAP SuccessFactors Client Secret that you generated through SAML Assertion.
|
|
1656
1794
|
* - Service `servicenow`: ServiceNow Client Secret.
|
|
1657
1795
|
* - Service `servicetitan`: Your ServiceTitan secret key.
|
|
1658
1796
|
* - Service `sharetribe`: Your Sharetribe client secret.
|
|
1659
1797
|
* - Service `sigmaComputingSource`: Your Sigma Computing client secret.
|
|
1660
1798
|
* - Service `skillstx`: Your SkillsTX client secret.
|
|
1799
|
+
* - Service `skimlinks`: Your Skimlinks client secret.
|
|
1661
1800
|
* - Service `smartrecruiters`: Your SmartRecruiters client secret.
|
|
1662
1801
|
* - Service `splash`: Your Splash client secret.
|
|
1663
1802
|
* - Service `square`: The Application Secret of your organization.
|
|
1664
1803
|
* - Service `standardMetrics`: Your Standard Metrics Client secret.
|
|
1804
|
+
* - Service `sugarcrm`: Your SugarCRM client secret.
|
|
1665
1805
|
* - Service `swoogo`: Your Swoogo Client Secret.
|
|
1666
1806
|
* - Service `taboola`: The Taboola client secret.
|
|
1667
1807
|
* - Service `talkdesk`: The Client Secret of your OAuth Client
|
|
1668
1808
|
* - Service `thinkific`: Your Thinkific client secret.
|
|
1809
|
+
* - Service `tive`: Your Tive client secret.
|
|
1669
1810
|
* - Service `toast`: Your Toast client secret.
|
|
1670
1811
|
* - Service `trelica`: Your Trelica client secret.
|
|
1812
|
+
* - Service `tremendous`: Your Tremendous client secret.
|
|
1671
1813
|
* - Service `tymeshift`: Your Tymeshift password.
|
|
1672
1814
|
* - Service `udemyBusiness`: Your Udemy Business client secret.
|
|
1815
|
+
* - Service `vimeo`: Your Vimeo client secret.
|
|
1673
1816
|
* - Service `visma`: Your Visma client secret.
|
|
1674
1817
|
* - Service `vonageContactCenter`: Your Vonage Contact Center client secret.
|
|
1675
1818
|
* - Service `walmartMarketplace`: Your Walmart Marketplace client secret.
|
|
@@ -1699,6 +1842,16 @@ export interface ConnectorConfig {
|
|
|
1699
1842
|
* - Service `doubleClickPublishers`: Columns provide all trafficking statistics and revenue information available for the chosen Dimensions.
|
|
1700
1843
|
*/
|
|
1701
1844
|
columns?: string[];
|
|
1845
|
+
/**
|
|
1846
|
+
* Field usage depends on `service` value:
|
|
1847
|
+
* - Service `khorosCommunities`: Your Khoros Communities community domain.
|
|
1848
|
+
*/
|
|
1849
|
+
communityDomain?: string;
|
|
1850
|
+
/**
|
|
1851
|
+
* Field usage depends on `service` value:
|
|
1852
|
+
* - Service `khorosCommunities`: Your Khoros Communities community ID.
|
|
1853
|
+
*/
|
|
1854
|
+
communityId?: string;
|
|
1702
1855
|
/**
|
|
1703
1856
|
* Field usage depends on `service` value:
|
|
1704
1857
|
* - Service `businessCentral`: List of companies to sync
|
|
@@ -1727,6 +1880,11 @@ export interface ConnectorConfig {
|
|
|
1727
1880
|
* - Service `upland`: Your Upland Software Company Key.
|
|
1728
1881
|
*/
|
|
1729
1882
|
companyKey?: string;
|
|
1883
|
+
/**
|
|
1884
|
+
* Field usage depends on `service` value:
|
|
1885
|
+
* - Service `clockodo`: Your Clockodo company name.
|
|
1886
|
+
*/
|
|
1887
|
+
companyName?: string;
|
|
1730
1888
|
/**
|
|
1731
1889
|
* Field usage depends on `service` value:
|
|
1732
1890
|
* - Service `concur`: The SAP Concur Company Request Token
|
|
@@ -1770,6 +1928,16 @@ export interface ConnectorConfig {
|
|
|
1770
1928
|
* - Service `googleAnalytics`: Whether to use the [Prebuilt Reports or Custom Reports](https://fivetran.com/docs/connectors/applications/google-analytics#schemainformation).
|
|
1771
1929
|
*/
|
|
1772
1930
|
configType: string;
|
|
1931
|
+
/**
|
|
1932
|
+
* Field usage depends on `service` value:
|
|
1933
|
+
* - Service `xactly`: Your Xactly Connect password.
|
|
1934
|
+
*/
|
|
1935
|
+
connectPassword?: string;
|
|
1936
|
+
/**
|
|
1937
|
+
* Field usage depends on `service` value:
|
|
1938
|
+
* - Service `xactly`: Your Xactly Connect username.
|
|
1939
|
+
*/
|
|
1940
|
+
connectUsername?: string;
|
|
1773
1941
|
connectingUser?: string;
|
|
1774
1942
|
connectingUserEmail?: string;
|
|
1775
1943
|
/**
|
|
@@ -1881,6 +2049,11 @@ export interface ConnectorConfig {
|
|
|
1881
2049
|
* - Service `woocommerce`: Your WooCommerce Consumer key.
|
|
1882
2050
|
*/
|
|
1883
2051
|
consumerKey: string;
|
|
2052
|
+
/**
|
|
2053
|
+
* Field usage depends on `service` value:
|
|
2054
|
+
* - Service `xactly`: Your Xactly Connect consumer name.
|
|
2055
|
+
*/
|
|
2056
|
+
consumerName?: string;
|
|
1884
2057
|
/**
|
|
1885
2058
|
* Field usage depends on `service` value:
|
|
1886
2059
|
* - Service `netsuiteSuiteanalytics`: Consumer Secret
|
|
@@ -1906,6 +2079,11 @@ export interface ConnectorConfig {
|
|
|
1906
2079
|
* - Service `youtubeAnalytics`: Used only for Content Owner reports. The ID of the content owner for whom the API request is being made.
|
|
1907
2080
|
*/
|
|
1908
2081
|
contentOwnerId?: string;
|
|
2082
|
+
/**
|
|
2083
|
+
* Field usage depends on `service` value:
|
|
2084
|
+
* - Service `acumatica`: Your Acumatica contract version.
|
|
2085
|
+
*/
|
|
2086
|
+
contractVersion?: string;
|
|
1909
2087
|
/**
|
|
1910
2088
|
* Field usage depends on `service` value:
|
|
1911
2089
|
* - Service `helpscout`: Your conversation webhook URL
|
|
@@ -1935,8 +2113,15 @@ export interface ConnectorConfig {
|
|
|
1935
2113
|
/**
|
|
1936
2114
|
* Field usage depends on `service` value:
|
|
1937
2115
|
* - Service `criteo`: Currency
|
|
2116
|
+
* - Service `rokt`: Your Rokt currency.
|
|
1938
2117
|
*/
|
|
1939
2118
|
currency?: string;
|
|
2119
|
+
/**
|
|
2120
|
+
* Field usage depends on `service` value:
|
|
2121
|
+
* - Service `datadog`: Your Datadog custom base url.
|
|
2122
|
+
* - Service `deposco`: Your Deposco custom base URL.
|
|
2123
|
+
*/
|
|
2124
|
+
customBaseUrl?: string;
|
|
1940
2125
|
/**
|
|
1941
2126
|
* Field usage depends on `service` value:
|
|
1942
2127
|
* - Service `iterable`: Custom Events Sync Mode.
|
|
@@ -1963,6 +2148,7 @@ export interface ConnectorConfig {
|
|
|
1963
2148
|
/**
|
|
1964
2149
|
* Field usage depends on `service` value:
|
|
1965
2150
|
* - Service `dbtCloud`: Your dbt Cloud access url.
|
|
2151
|
+
* - Service `factbird`: Your Factbird custom base url.
|
|
1966
2152
|
* - Service `jotform`: Your Jotform custom base URL.
|
|
1967
2153
|
*/
|
|
1968
2154
|
customUrl?: string;
|
|
@@ -2008,6 +2194,7 @@ export interface ConnectorConfig {
|
|
|
2008
2194
|
* Field usage depends on `service` value:
|
|
2009
2195
|
* - Service `aurora`: The database name.
|
|
2010
2196
|
* - Service `auroraPostgres`: The database name.
|
|
2197
|
+
* - Service `azureCosmosForMongo`: Authentication database for the source. Usually 'admin'.
|
|
2011
2198
|
* - Service `azurePostgres`: The database name.
|
|
2012
2199
|
* - Service `azureSqlDb`: The database name.
|
|
2013
2200
|
* - Service `azureSqlManagedDb`: The database name.
|
|
@@ -2097,7 +2284,7 @@ export interface ConnectorConfig {
|
|
|
2097
2284
|
delimiter: string;
|
|
2098
2285
|
/**
|
|
2099
2286
|
* Field usage depends on `service` value:
|
|
2100
|
-
* - Service `brightpearl`: Your Brightpearl
|
|
2287
|
+
* - Service `brightpearl`: Your Brightpearl dev reference.
|
|
2101
2288
|
*/
|
|
2102
2289
|
developerReference?: string;
|
|
2103
2290
|
/**
|
|
@@ -2168,6 +2355,7 @@ export interface ConnectorConfig {
|
|
|
2168
2355
|
* - Service `mailchimp`: List of IDs of the Mailchimp E-Commerce Stores to Sync
|
|
2169
2356
|
*/
|
|
2170
2357
|
ecommerceStores?: string[];
|
|
2358
|
+
edition: string;
|
|
2171
2359
|
elements?: string[];
|
|
2172
2360
|
/**
|
|
2173
2361
|
* Field usage depends on `service` value:
|
|
@@ -2184,6 +2372,11 @@ export interface ConnectorConfig {
|
|
|
2184
2372
|
* - Service `zendeskSunshine`: Zendesk email.
|
|
2185
2373
|
*/
|
|
2186
2374
|
email: string;
|
|
2375
|
+
/**
|
|
2376
|
+
* Field usage depends on `service` value:
|
|
2377
|
+
* - Service `clockodo`: Your Clockodo email address.
|
|
2378
|
+
*/
|
|
2379
|
+
emailAddress?: string;
|
|
2187
2380
|
/**
|
|
2188
2381
|
* Field usage depends on `service` value:
|
|
2189
2382
|
* - Service `ordway`: Your Ordway user email ID.
|
|
@@ -2279,22 +2472,33 @@ export interface ConnectorConfig {
|
|
|
2279
2472
|
entityId: string;
|
|
2280
2473
|
/**
|
|
2281
2474
|
* Field usage depends on `service` value:
|
|
2282
|
-
* - Service `bazaarvoice`: Your Bazaarvoice
|
|
2475
|
+
* - Service `bazaarvoice`: Your Bazaarvoice environment.
|
|
2283
2476
|
* - Service `buildium`: Your Buildium environment.
|
|
2284
2477
|
* - Service `checkout`: Your Checkout.com environment.
|
|
2285
2478
|
* - Service `concord`: Your Concord environment.
|
|
2479
|
+
* - Service `deposco`: Your Deposco environment.
|
|
2480
|
+
* - Service `dialpad`: Your Dialpad environment.
|
|
2286
2481
|
* - Service `invoiced`: Your Invoiced environment.
|
|
2482
|
+
* - Service `jibble`: Your Jibble environment.
|
|
2483
|
+
* - Service `lucca`: Your Lucca environment.
|
|
2287
2484
|
* - Service `procore`: Your Procore account environment.
|
|
2288
2485
|
* - Service `reltio`: Your Reltio environment.
|
|
2289
2486
|
* - Service `servicetitan`: Your ServiceTitan environment.
|
|
2290
2487
|
* - Service `smarthr`: Your SmartHR environment.
|
|
2291
2488
|
* - Service `trelica`: Your Trelica environment.
|
|
2489
|
+
* - Service `tremendous`: Your Tremendous environment.
|
|
2292
2490
|
* - Service `vts`: Your VTS environment.
|
|
2491
|
+
* - Service `xactly`: Your Xactly environment.
|
|
2293
2492
|
* - Service `younium`: Your Younium API environment.
|
|
2294
2493
|
* - Service `zuora`: Zuora Sandbox Environment. This accepts either of the two values Sandbox or Central Sandbox based on your subscription. The default environment is Sandbox.
|
|
2295
2494
|
* - Service `zuoraSandbox`: Zuora Sandbox Environment. This accepts either of the two values Sandbox or Central Sandbox based on your subscription. The default environment is Sandbox.
|
|
2296
2495
|
*/
|
|
2297
2496
|
environment: string;
|
|
2497
|
+
/**
|
|
2498
|
+
* Field usage depends on `service` value:
|
|
2499
|
+
* - Service `xactly`: Your Xactly environment host.
|
|
2500
|
+
*/
|
|
2501
|
+
environmentHost?: string;
|
|
2298
2502
|
/**
|
|
2299
2503
|
* Field usage depends on `service` value:
|
|
2300
2504
|
* - Service `businessCentral`: Name of the environment
|
|
@@ -2491,6 +2695,11 @@ export interface ConnectorConfig {
|
|
|
2491
2695
|
* - Service `workday`: Select this option to generate a Primary Key for reports where no single column or combination of columns can be used to form a Primary Key.
|
|
2492
2696
|
*/
|
|
2493
2697
|
generateFivetranPk: boolean;
|
|
2698
|
+
/**
|
|
2699
|
+
* Field usage depends on `service` value:
|
|
2700
|
+
* - Service `lineAds`: Your LINE Ads group ID(s).
|
|
2701
|
+
*/
|
|
2702
|
+
groupId?: string;
|
|
2494
2703
|
/**
|
|
2495
2704
|
* Field usage depends on `service` value:
|
|
2496
2705
|
* - Service `fivetranLog`: (Optional) The group name of the `targetGroupId`.
|
|
@@ -2513,16 +2722,29 @@ export interface ConnectorConfig {
|
|
|
2513
2722
|
hasManagePermissions: boolean;
|
|
2514
2723
|
/**
|
|
2515
2724
|
* Field usage depends on `service` value:
|
|
2725
|
+
* - Service `braze`: Range of data in history you would like to include in the initial sync.
|
|
2726
|
+
* - Service `iterable`: The time range for which historical data should be synced. Default value: `All Time`.
|
|
2516
2727
|
* - Service `klaviyo`: Range of data in history you would like to include in the initial sync. Default value: `ALL_TIME`.
|
|
2517
2728
|
* - Service `marketo`: Range of data in history you would like to include in the initial sync. Default value: `ALL_TIME`.
|
|
2729
|
+
* - Service `sailthru`: Range of historical data you would like to include in the initial sync. Default value: `ALL_TIME`.
|
|
2518
2730
|
* - Service `salesforceMarketingCloud`: Range of data in history you would like to include in the initial sync. Default value: `ALL_TIME`.
|
|
2519
2731
|
*/
|
|
2520
2732
|
historicSyncTimeFrame: string;
|
|
2521
2733
|
/**
|
|
2522
2734
|
* Field usage depends on `service` value:
|
|
2735
|
+
* - Service `concur`: Historical Sync Limit for the Sync
|
|
2736
|
+
* - Service `eloqua`: Range of data in history you would like to include in the initial sync. Default value: `ALL_TIME`.
|
|
2523
2737
|
* - Service `pardot`: The time range for which historical data should be synced. Default value: `All Time`.
|
|
2524
2738
|
*/
|
|
2525
2739
|
historicalSyncLimit: string;
|
|
2740
|
+
/**
|
|
2741
|
+
* Field usage depends on `service` value:
|
|
2742
|
+
* - Service `rokt`: Your Rokt historical sync time frame.
|
|
2743
|
+
* - Service `skimlinks`: Your Skimlinks Historical sync time frame.
|
|
2744
|
+
* - Service `vimeo`: Your Vimeo Historical sync time frame.
|
|
2745
|
+
* - Service `zendesk`: Used to configure Historical sync timeframe for selected tables
|
|
2746
|
+
*/
|
|
2747
|
+
historicalSyncTimeFrame: string;
|
|
2526
2748
|
/**
|
|
2527
2749
|
* Field usage depends on `service` value:
|
|
2528
2750
|
* - Service `appsflyer`: Your S3 home folder path of the Data Locker.
|
|
@@ -2634,7 +2856,7 @@ export interface ConnectorConfig {
|
|
|
2634
2856
|
httpPath?: string;
|
|
2635
2857
|
/**
|
|
2636
2858
|
* Field usage depends on `service` value:
|
|
2637
|
-
* - Service `playvoxWorkforceManagement`: Your Playvox Workforce Management
|
|
2859
|
+
* - Service `playvoxWorkforceManagement`: Your Playvox Workforce Management client identifier.
|
|
2638
2860
|
* - Service `statisticsNetherlandsCbs`: Your Statistics Netherlands CBS catalog identifier.
|
|
2639
2861
|
*/
|
|
2640
2862
|
identifier?: string;
|
|
@@ -2652,6 +2874,7 @@ export interface ConnectorConfig {
|
|
|
2652
2874
|
* Field usage depends on `service` value:
|
|
2653
2875
|
* - Service `acumatica`: Your Acumatica instance name.
|
|
2654
2876
|
* - Service `coupa`: The instance name of your Coupa account in the URL.
|
|
2877
|
+
* - Service `flywheelDigital`: Your Flywheel Digital instance.
|
|
2655
2878
|
* - Service `salesforceMarketingCloud`: The Salesforce Marketing Cloud instance ID
|
|
2656
2879
|
* - Service `servicenow`: ServiceNow Instance ID.
|
|
2657
2880
|
*/
|
|
@@ -2676,6 +2899,11 @@ export interface ConnectorConfig {
|
|
|
2676
2899
|
* - Service `pendo`: The integration key of the Pendo account.
|
|
2677
2900
|
*/
|
|
2678
2901
|
integrationKey: string;
|
|
2902
|
+
/**
|
|
2903
|
+
* Field usage depends on `service` value:
|
|
2904
|
+
* - Service `avevaPi`: IP address of the AF Server
|
|
2905
|
+
*/
|
|
2906
|
+
ipAddress?: string;
|
|
2679
2907
|
/**
|
|
2680
2908
|
* Field usage depends on `service` value:
|
|
2681
2909
|
* - Service `fivetranLog`: (Optional) Retrieve account-level logs.
|
|
@@ -2725,6 +2953,7 @@ export interface ConnectorConfig {
|
|
|
2725
2953
|
/**
|
|
2726
2954
|
* Field usage depends on `service` value:
|
|
2727
2955
|
* - Service `awsLambda`: We use PrivateLink by default if your AWS Lambda is in the same region as Fivetran. Turning on this toggle ensures that Fivetran always connects to AWS lambda over PrivateLink. Learn more in our [PrivateLink documentation](https://fivetran.com/docs/connectors/databases/connection-options#awsprivatelink).
|
|
2956
|
+
* - Service `s3`: Set to `true` if you want to connect to S3 bucket over PrivateLink. Default value: `false`.
|
|
2728
2957
|
*/
|
|
2729
2958
|
isPrivateLinkRequired: boolean;
|
|
2730
2959
|
/**
|
|
@@ -2758,11 +2987,23 @@ export interface ConnectorConfig {
|
|
|
2758
2987
|
* - Service `sharePoint`: Allows the creation of connector using Merge Mode strategy.
|
|
2759
2988
|
*/
|
|
2760
2989
|
isSingleTableMode: boolean;
|
|
2990
|
+
/**
|
|
2991
|
+
* Field usage depends on `service` value:
|
|
2992
|
+
* - Service `adyen`: Whether or not your Adyen Account is a Test Account. Default value: `false`.
|
|
2993
|
+
*/
|
|
2994
|
+
isTestAccount: boolean;
|
|
2761
2995
|
/**
|
|
2762
2996
|
* Field usage depends on `service` value:
|
|
2763
2997
|
* - Service `amazonSellingPartner`: Whether or not you have a Vendor Account. Default value: `false`.
|
|
2764
2998
|
*/
|
|
2765
2999
|
isVendor: boolean;
|
|
3000
|
+
/**
|
|
3001
|
+
* Field usage depends on `service` value:
|
|
3002
|
+
* - Service `oracleFusionCloudAppsCrm`: The Oracle Fusion Cloud issuer name.
|
|
3003
|
+
* - Service `oracleFusionCloudAppsFscm`: The Oracle Fusion Cloud issuer name.
|
|
3004
|
+
* - Service `oracleFusionCloudAppsHcm`: The Oracle Fusion Cloud issuer name.
|
|
3005
|
+
*/
|
|
3006
|
+
issuer?: string;
|
|
2766
3007
|
/**
|
|
2767
3008
|
* Field usage depends on `service` value:
|
|
2768
3009
|
* - Service `awsCostReport`: Control how your JSON data is delivered into your destination
|
|
@@ -2834,6 +3075,11 @@ export interface ConnectorConfig {
|
|
|
2834
3075
|
* - Service `wasabiCloudStorage`: You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.
|
|
2835
3076
|
*/
|
|
2836
3077
|
lineSeparator?: string;
|
|
3078
|
+
/**
|
|
3079
|
+
* Field usage depends on `service` value:
|
|
3080
|
+
* - Service `pigment`: Your Pigment list ID.
|
|
3081
|
+
*/
|
|
3082
|
+
listId?: string;
|
|
2837
3083
|
/**
|
|
2838
3084
|
* Field usage depends on `service` value:
|
|
2839
3085
|
* - Service `cjCommissionDetail`: Your CJ Commission Detail list of company IDs.
|
|
@@ -2899,6 +3145,7 @@ export interface ConnectorConfig {
|
|
|
2899
3145
|
* - Service `avantlink`: Your AvantLink Merchant ID.
|
|
2900
3146
|
* - Service `braintree`: Your Braintree merchant ID.
|
|
2901
3147
|
* - Service `braintreeSandbox`: Your Braintree merchant ID.
|
|
3148
|
+
* - Service `shareasale`: Your ShareASale merchant ID.
|
|
2902
3149
|
* - Service `xsolla`: Your Xsolla Merchant ID.
|
|
2903
3150
|
*/
|
|
2904
3151
|
merchantId: string;
|
|
@@ -2912,6 +3159,11 @@ export interface ConnectorConfig {
|
|
|
2912
3159
|
* - Service `herokuKafka`: Heroku Kafka message type.
|
|
2913
3160
|
*/
|
|
2914
3161
|
messageType: string;
|
|
3162
|
+
/**
|
|
3163
|
+
* Field usage depends on `service` value:
|
|
3164
|
+
* - Service `pigment`: Your Pigment metric ID.
|
|
3165
|
+
*/
|
|
3166
|
+
metricId?: string;
|
|
2915
3167
|
/**
|
|
2916
3168
|
* Field usage depends on `service` value:
|
|
2917
3169
|
* - Service `adroll`: The metrics that you want to sync.
|
|
@@ -3034,6 +3286,7 @@ export interface ConnectorConfig {
|
|
|
3034
3286
|
* - Service `megaphone`: Your Megaphone organization ID.
|
|
3035
3287
|
* - Service `productive`: Your Productive Organization ID.
|
|
3036
3288
|
* - Service `salesforceCommerceCloud`: The organization ID from Salesforce Commerce Cloud account.
|
|
3289
|
+
* - Service `sentry`: Your Sentry organization ID.
|
|
3037
3290
|
* - Service `zohoBooks`: Your Zoho Books Organization ID.
|
|
3038
3291
|
* - Service `zohoInventory`: Your Zoho Inventory organization ID.
|
|
3039
3292
|
*/
|
|
@@ -3111,6 +3364,7 @@ export interface ConnectorConfig {
|
|
|
3111
3364
|
* Field usage depends on `service` value:
|
|
3112
3365
|
* - Service `absorbLms`: Your Absorb LMS password.
|
|
3113
3366
|
* - Service `adobeCommerce`: Your Adobe Commerce password.
|
|
3367
|
+
* - Service `akeneo`: Your Akeneo password.
|
|
3114
3368
|
* - Service `anaplan`: Your Anaplan password. Must be populated if `authMode` is set to `Basic`.
|
|
3115
3369
|
* - Service `appfigures`: Your Appfigures Password.
|
|
3116
3370
|
* - Service `aurora`: The user's password.
|
|
@@ -3125,9 +3379,11 @@ export interface ConnectorConfig {
|
|
|
3125
3379
|
* - Service `clarity`: The user's password.
|
|
3126
3380
|
* - Service `cockroachdb`: The user's password.
|
|
3127
3381
|
* - Service `collibra`: Your collibra password.
|
|
3382
|
+
* - Service `complianceCheckpoint`: Your Compliance Checkpoint account password.
|
|
3128
3383
|
* - Service `contrastSecurity`: Your Contrast Security API Password.
|
|
3129
3384
|
* - Service `db2iHva`: The user's password.
|
|
3130
3385
|
* - Service `db2iSapHva`: The user's password.
|
|
3386
|
+
* - Service `deposco`: Your Deposco password.
|
|
3131
3387
|
* - Service `documentdb`: The user's password.
|
|
3132
3388
|
* - Service `dynamics365Fo`: The user's password.
|
|
3133
3389
|
* - Service `ehr`: The user's password.
|
|
@@ -3146,6 +3402,7 @@ export interface ConnectorConfig {
|
|
|
3146
3402
|
* - Service `hanaSapHvaS4`: The user's password.
|
|
3147
3403
|
* - Service `hanaSapHvaS4Netweaver`: The user's password.
|
|
3148
3404
|
* - Service `herokuPostgres`: The user's password.
|
|
3405
|
+
* - Service `hiltiOntrack`: Your Hilti On!Track password.
|
|
3149
3406
|
* - Service `impact`: Your Impact Account Token
|
|
3150
3407
|
* - Service `integralAdScience`: Your integralAdScience password.
|
|
3151
3408
|
* - Service `itunesConnect`: Your password
|
|
@@ -3185,9 +3442,10 @@ export interface ConnectorConfig {
|
|
|
3185
3442
|
* - Service `outbrain`: The Outbrain user's password.
|
|
3186
3443
|
* - Service `pardot`: The Pardot user's password.
|
|
3187
3444
|
* - Service `partnerize`: Your Partnerize account's password.
|
|
3188
|
-
* - Service `podio`: Your Podio password.
|
|
3445
|
+
* - Service `podio`: Your Podio account password.
|
|
3189
3446
|
* - Service `postgres`: The user's password.
|
|
3190
3447
|
* - Service `postgresRds`: The user's password.
|
|
3448
|
+
* - Service `qmaticDataConnect`: Your Qmatic Data Connect password.
|
|
3191
3449
|
* - Service `redshiftDb`: The Redshift user's password.
|
|
3192
3450
|
* - Service `revx`: Your RevX Password.
|
|
3193
3451
|
* - Service `rtbHouse`: Your RTB House password.
|
|
@@ -3210,7 +3468,9 @@ export interface ConnectorConfig {
|
|
|
3210
3468
|
* - Service `sqlServerRds`: The user's password.
|
|
3211
3469
|
* - Service `sqlServerSapEccHva`: The user's password.
|
|
3212
3470
|
* - Service `starrez`: Your StarRez API password
|
|
3471
|
+
* - Service `stickyio`: Your sticky.io password.
|
|
3213
3472
|
* - Service `stylight`: Your Stylight Password.
|
|
3473
|
+
* - Service `sugarcrm`: Your SugarCRM password.
|
|
3214
3474
|
* - Service `teamwork`: Your Teamwork password.
|
|
3215
3475
|
* - Service `theTradeDesk`: The Trade Desk password. It is a part of the login credentials.
|
|
3216
3476
|
* - Service `togglTrack`: Your Toggl Track Password
|
|
@@ -3335,10 +3595,16 @@ export interface ConnectorConfig {
|
|
|
3335
3595
|
* - Service `itunesConnect`: Register the number on AppleId Account Page for 2FA
|
|
3336
3596
|
*/
|
|
3337
3597
|
phoneNumber?: string;
|
|
3598
|
+
/**
|
|
3599
|
+
* Field usage depends on `service` value:
|
|
3600
|
+
* - Service `justcall`: Your JustCall Plan Type.
|
|
3601
|
+
*/
|
|
3602
|
+
planType: string;
|
|
3338
3603
|
/**
|
|
3339
3604
|
* Field usage depends on `service` value:
|
|
3340
3605
|
* - Service `aurora`: The port number.
|
|
3341
3606
|
* - Service `auroraPostgres`: The port number.
|
|
3607
|
+
* - Service `avevaPi`: Port number at which the AF Server is running
|
|
3342
3608
|
* - Service `azurePostgres`: The port number.
|
|
3343
3609
|
* - Service `azureSqlDb`: The port number.
|
|
3344
3610
|
* - Service `azureSqlManagedDb`: The port number.
|
|
@@ -3446,7 +3712,12 @@ export interface ConnectorConfig {
|
|
|
3446
3712
|
* - Service `appleSearchAds`: The contents of your secret key file. Must be populated if `isAuth2Enabled` is set to `false`.
|
|
3447
3713
|
* - Service `braintree`: The contents of your secret key file.
|
|
3448
3714
|
* - Service `braintreeSandbox`: The contents of your secret key file.
|
|
3715
|
+
* - Service `oracleFusionCloudAppsCrm`: The Oracle Fusion Cloud private key.
|
|
3716
|
+
* - Service `oracleFusionCloudAppsFscm`: The Oracle Fusion Cloud private key.
|
|
3717
|
+
* - Service `oracleFusionCloudAppsHcm`: The Oracle Fusion Cloud private key.
|
|
3449
3718
|
* - Service `qualtrics`: Your private key
|
|
3719
|
+
* - Service `salesforce`: Provide content of the `.key` private key (only when authenticationMethod = `ADVANCED`).
|
|
3720
|
+
* - Service `salesforceSandbox`: Provide content of the `.key` private key (only when authenticationMethod = `ADVANCED`).
|
|
3450
3721
|
* - Service `snowflakeDb`: Private access key. The field should be specified if authentication type is `KEY_PAIR`.
|
|
3451
3722
|
*/
|
|
3452
3723
|
privateKey: string;
|
|
@@ -3467,6 +3738,11 @@ export interface ConnectorConfig {
|
|
|
3467
3738
|
* - Service `googleAnalyticsMcf`: Specific User Profile IDs to sync. Must be populated if `syncMode` is set to `SPECIFIC_ACCOUNTS`.
|
|
3468
3739
|
*/
|
|
3469
3740
|
profiles?: string[];
|
|
3741
|
+
/**
|
|
3742
|
+
* Field usage depends on `service` value:
|
|
3743
|
+
* - Service `amazonDsp`: Comma-separated list of your Amazon DSP profiles.
|
|
3744
|
+
*/
|
|
3745
|
+
profilesAmazonDsp?: string;
|
|
3470
3746
|
/**
|
|
3471
3747
|
* Field usage depends on `service` value:
|
|
3472
3748
|
* - Service `rollbar`: Your Rollbar project access token.
|
|
@@ -3481,6 +3757,11 @@ export interface ConnectorConfig {
|
|
|
3481
3757
|
* - Service `mixpanel`: Project ID
|
|
3482
3758
|
*/
|
|
3483
3759
|
projectId: string;
|
|
3760
|
+
/**
|
|
3761
|
+
* Field usage depends on `service` value:
|
|
3762
|
+
* - Service `sentry`: Your Sentry project IDs.
|
|
3763
|
+
*/
|
|
3764
|
+
projectIds?: string;
|
|
3484
3765
|
/**
|
|
3485
3766
|
* Field usage depends on `service` value:
|
|
3486
3767
|
* - Service `commercetools`: Your commercetools project key.
|
|
@@ -3499,7 +3780,7 @@ export interface ConnectorConfig {
|
|
|
3499
3780
|
properties?: string[];
|
|
3500
3781
|
/**
|
|
3501
3782
|
* Field usage depends on `service` value:
|
|
3502
|
-
* - Service `cloudbeds`: Your Cloudbeds
|
|
3783
|
+
* - Service `cloudbeds`: Your Cloudbeds property IDs.
|
|
3503
3784
|
*/
|
|
3504
3785
|
propertyId?: string;
|
|
3505
3786
|
/**
|
|
@@ -3546,6 +3827,9 @@ export interface ConnectorConfig {
|
|
|
3546
3827
|
* - Service `opensearch`: Public Key
|
|
3547
3828
|
* - Service `oracle`: Public Key
|
|
3548
3829
|
* - Service `oracleEbs`: Public Key
|
|
3830
|
+
* - Service `oracleFusionCloudAppsCrm`: The Oracle Fusion Cloud public key.
|
|
3831
|
+
* - Service `oracleFusionCloudAppsFscm`: The Oracle Fusion Cloud public key.
|
|
3832
|
+
* - Service `oracleFusionCloudAppsHcm`: The Oracle Fusion Cloud public key.
|
|
3549
3833
|
* - Service `oracleHva`: Public Key
|
|
3550
3834
|
* - Service `oracleRac`: Public Key
|
|
3551
3835
|
* - Service `oracleRds`: Public Key
|
|
@@ -3572,11 +3856,17 @@ export interface ConnectorConfig {
|
|
|
3572
3856
|
* - Service `postgresRds`: Publication name. Specify only for `"updatedMethod": "WAL_PGOUTPUT"`.
|
|
3573
3857
|
*/
|
|
3574
3858
|
publicationName: string;
|
|
3859
|
+
/**
|
|
3860
|
+
* Field usage depends on `service` value:
|
|
3861
|
+
* - Service `skimlinks`: Your Skimlinks publisher ID.
|
|
3862
|
+
*/
|
|
3863
|
+
publisherId?: string;
|
|
3575
3864
|
/**
|
|
3576
3865
|
* Field usage depends on `service` value:
|
|
3577
3866
|
* - Service `outbrain`: Include or ignore results from archived campaigns
|
|
3578
3867
|
*/
|
|
3579
3868
|
pullArchivedCampaigns: boolean;
|
|
3869
|
+
pythonVersion?: string;
|
|
3580
3870
|
/**
|
|
3581
3871
|
* Field usage depends on `service` value:
|
|
3582
3872
|
* - Service `googleDisplayAndVideo360`: The ID of the query whose configuration you want to reuse. This is a required parameter when `configMethod` is set to `REUSE_EXISTING`.
|
|
@@ -3593,6 +3883,31 @@ export interface ConnectorConfig {
|
|
|
3593
3883
|
* - Service `bigqueryDb`: Specify a different project ID to account for quota and billing of Fivetran query workload
|
|
3594
3884
|
*/
|
|
3595
3885
|
quotaProjectId?: string;
|
|
3886
|
+
/**
|
|
3887
|
+
* Field usage depends on `service` value:
|
|
3888
|
+
* - Service `azureBlobStorage`: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quoteCharacterEnabled is set to true.
|
|
3889
|
+
* - Service `gcs`: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quoteCharacterEnabled is set to true.
|
|
3890
|
+
* - Service `googleDrive`: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quoteCharacterEnabled is set to true.
|
|
3891
|
+
* - Service `s3`: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quoteCharacterEnabled is set to true.
|
|
3892
|
+
* - Service `sftp`: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quoteCharacterEnabled is set to true.
|
|
3893
|
+
* - Service `sharePoint`: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quoteCharacterEnabled is set to true.
|
|
3894
|
+
*/
|
|
3895
|
+
quoteChar?: string;
|
|
3896
|
+
/**
|
|
3897
|
+
* Field usage depends on `service` value:
|
|
3898
|
+
* - Service `azureBlobStorage`: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character.
|
|
3899
|
+
* - Service `gcs`: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character.
|
|
3900
|
+
* - Service `googleDrive`: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character.
|
|
3901
|
+
* - Service `s3`: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character.
|
|
3902
|
+
* - Service `sftp`: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character.
|
|
3903
|
+
* - Service `sharePoint`: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character.
|
|
3904
|
+
*/
|
|
3905
|
+
quoteCharacterEnabled: boolean;
|
|
3906
|
+
/**
|
|
3907
|
+
* Field usage depends on `service` value:
|
|
3908
|
+
* - Service `vimeo`: Your Vimeo rate limit plan.
|
|
3909
|
+
*/
|
|
3910
|
+
rateLimitPlan: string;
|
|
3596
3911
|
/**
|
|
3597
3912
|
* Field usage depends on `service` value:
|
|
3598
3913
|
* - Service `ironsource`: Your Ironsource `Client Secret`.
|
|
@@ -3612,8 +3927,10 @@ export interface ConnectorConfig {
|
|
|
3612
3927
|
* - Service `atlassianOpsGenie`: Your company's Osgenie region (usually **company**.opsgenie.com)
|
|
3613
3928
|
* - Service `awin`: Your Awin Region.
|
|
3614
3929
|
* - Service `awsLambda`: The AWS region code for the DynamoDB instance.
|
|
3930
|
+
* - Service `biginByZohoCrm`: Your Bigin by Zoho CRM Region
|
|
3615
3931
|
* - Service `concur`: The region.
|
|
3616
3932
|
* - Service `cvent`: Your Cvent region.
|
|
3933
|
+
* - Service `everflow`: Your Everflow region.
|
|
3617
3934
|
* - Service `exactOnline`: Your Exact Online region.
|
|
3618
3935
|
* - Service `getfeedback`: Your GetFeedback region.
|
|
3619
3936
|
* - Service `happyfox`: Your HappyFox region.
|
|
@@ -3630,6 +3947,7 @@ export interface ConnectorConfig {
|
|
|
3630
3947
|
* - Service `snyk`: Your Snyk region.
|
|
3631
3948
|
* - Service `talkdesk`: Your Talkdesk region (".com",".eu","ca.com")
|
|
3632
3949
|
* - Service `totango`: Your Totango region.
|
|
3950
|
+
* - Service `transcend`: Your Transcend region.
|
|
3633
3951
|
* - Service `vonageContactCenter`: Your Vonage Contact Center region.
|
|
3634
3952
|
* - Service `wasabiCloudStorage`: The Wasabi Cloud Storage bucket region. Required for connector creation. Default value: `US_EAST_1`.
|
|
3635
3953
|
* - Service `workdayStrategicSourcing`: Your Workday Strategic Sourcing Region.
|
|
@@ -3656,7 +3974,7 @@ export interface ConnectorConfig {
|
|
|
3656
3974
|
regionTokenUrl: string;
|
|
3657
3975
|
/**
|
|
3658
3976
|
* Field usage depends on `service` value:
|
|
3659
|
-
* - Service `playvoxWorkforceManagement`: Your Playvox Workforce Management
|
|
3977
|
+
* - Service `playvoxWorkforceManagement`: Your Playvox Workforce Management region URL.
|
|
3660
3978
|
*/
|
|
3661
3979
|
regionUrl?: string;
|
|
3662
3980
|
/**
|
|
@@ -3694,12 +4012,22 @@ export interface ConnectorConfig {
|
|
|
3694
4012
|
* - Service `workday`: This is to select report format from JSON and CSV. By default, report format is JSON.
|
|
3695
4013
|
*/
|
|
3696
4014
|
reportFormatType?: string;
|
|
4015
|
+
/**
|
|
4016
|
+
* Field usage depends on `service` value:
|
|
4017
|
+
* - Service `pinterestAds`: Granularity at which reports will be
|
|
4018
|
+
*/
|
|
4019
|
+
reportGranularity: string;
|
|
3697
4020
|
/**
|
|
3698
4021
|
* Field usage depends on `service` value:
|
|
3699
4022
|
* - Service `rakutenadvertising`: Your Rakuten Advertising report keys.
|
|
3700
4023
|
*/
|
|
3701
4024
|
reportKeys?: string;
|
|
3702
4025
|
reportLists?: outputs.ConnectorConfigReportList[];
|
|
4026
|
+
/**
|
|
4027
|
+
* Field usage depends on `service` value:
|
|
4028
|
+
* - Service `adyen`: Your Report Service API key.
|
|
4029
|
+
*/
|
|
4030
|
+
reportServiceApiKey?: string;
|
|
3703
4031
|
reportSuites?: string[];
|
|
3704
4032
|
/**
|
|
3705
4033
|
* Field usage depends on `service` value:
|
|
@@ -3870,6 +4198,7 @@ export interface ConnectorConfig {
|
|
|
3870
4198
|
* Field usage depends on `service` value:
|
|
3871
4199
|
* - Service `db2iHva`: The SAP schema.
|
|
3872
4200
|
* - Service `db2iSapHva`: SAP schema name.
|
|
4201
|
+
* - Service `sqlServerHva`: SAP Schema Name. Required only for High-Volume Agent SAP ECC connector.
|
|
3873
4202
|
* - Service `sqlServerSapEccHva`: SAP Schema Name.
|
|
3874
4203
|
*/
|
|
3875
4204
|
sapSchema?: string;
|
|
@@ -3961,6 +4290,11 @@ export interface ConnectorConfig {
|
|
|
3961
4290
|
* - Service `ebay`: Your eBay scopes.
|
|
3962
4291
|
*/
|
|
3963
4292
|
scope?: string;
|
|
4293
|
+
/**
|
|
4294
|
+
* Field usage depends on `service` value:
|
|
4295
|
+
* - Service `cornerstone`: Your Cornerstone scopes.
|
|
4296
|
+
*/
|
|
4297
|
+
scopes?: string;
|
|
3964
4298
|
/**
|
|
3965
4299
|
* Field usage depends on `service` value:
|
|
3966
4300
|
* - Service `yahooDsp`: Specific Seats to sync. Must be populated if `syncModeSeat` is set to `SPECIFIC_SEATS`.
|
|
@@ -3970,11 +4304,13 @@ export interface ConnectorConfig {
|
|
|
3970
4304
|
* Field usage depends on `service` value:
|
|
3971
4305
|
* - Service `appcues`: Your Appcues Secret.
|
|
3972
4306
|
* - Service `buildium`: Your Buildium API secret.
|
|
4307
|
+
* - Service `canvasData2ByInstructure`: Your Canvas Data 2 by Instructure secret.
|
|
3973
4308
|
* - Service `loopio`: Your Loopio Secret.
|
|
3974
4309
|
* - Service `mode`: Your Mode Secret.
|
|
3975
|
-
* - Service `playvoxWorkforceManagement`: Your Playvox Workforce Management
|
|
4310
|
+
* - Service `playvoxWorkforceManagement`: Your Playvox Workforce Management client secret.
|
|
3976
4311
|
* - Service `twilio`: The Twilio API secret
|
|
3977
4312
|
* - Service `uservoice`: The UserVoice API secret.
|
|
4313
|
+
* - Service `venminder`: Your Venminder secret.
|
|
3978
4314
|
* - Service `vts`: Your VTS secret.
|
|
3979
4315
|
*/
|
|
3980
4316
|
secret: string;
|
|
@@ -3987,9 +4323,12 @@ export interface ConnectorConfig {
|
|
|
3987
4323
|
* - Service `ezofficeinventory`: Your EZOfficeInventory API secret key.
|
|
3988
4324
|
* - Service `gcs`: Your JSON Private Key. Used to authorize service account. Required if you use a Custom Service Account to authenticate the storage bucket.
|
|
3989
4325
|
* - Service `ironsource`: Your Ironsource `Client ID`.
|
|
4326
|
+
* - Service `lineAds`: Your LINE Ads secret key.
|
|
4327
|
+
* - Service `mailjet`: Your Mailjet secret key.
|
|
3990
4328
|
* - Service `partnerstackVendor`: Your PartnerStack Vendor Secret key.
|
|
3991
4329
|
* - Service `paypal`: `Client Secret` of your PayPal client application.
|
|
3992
4330
|
* - Service `paypalSandbox`: `Client Secret` of your PayPal client application.
|
|
4331
|
+
* - Service `phoenixAds`: Your Phoenix Ads Secret key.
|
|
3993
4332
|
* - Service `retailnext`: Your RetailNext secret key.
|
|
3994
4333
|
* - Service `statsig`: Your Statsig secret key.
|
|
3995
4334
|
* - Service `yotpo`: Your Yotpo Secret key
|
|
@@ -4046,6 +4385,11 @@ export interface ConnectorConfig {
|
|
|
4046
4385
|
* - Service `tableauSource`: Your Tableau Source server address.
|
|
4047
4386
|
*/
|
|
4048
4387
|
serverAddress?: string;
|
|
4388
|
+
/**
|
|
4389
|
+
* Field usage depends on `service` value:
|
|
4390
|
+
* - Service `clockify`: Your Clockify server region.
|
|
4391
|
+
*/
|
|
4392
|
+
serverRegion: string;
|
|
4049
4393
|
/**
|
|
4050
4394
|
* Field usage depends on `service` value:
|
|
4051
4395
|
* - Service `oracleBusinessIntelligencePublisher`: The Oracle Business Intelligence Instance URL.
|
|
@@ -4156,6 +4500,11 @@ export interface ConnectorConfig {
|
|
|
4156
4500
|
* - Service `shopify`: The Shopify shop name. Can be found in the URL before **.myshopify.com**.
|
|
4157
4501
|
*/
|
|
4158
4502
|
shop: string;
|
|
4503
|
+
/**
|
|
4504
|
+
* Field usage depends on `service` value:
|
|
4505
|
+
* - Service `tripleWhale`: Your Triple Whale shop domain.
|
|
4506
|
+
*/
|
|
4507
|
+
shopDomain?: string;
|
|
4159
4508
|
/**
|
|
4160
4509
|
* Field usage depends on `service` value:
|
|
4161
4510
|
* - Service `salesforceCommerceCloud`: The Salesforce eight-character string assigned to a realm for routing purposes.
|
|
@@ -4315,6 +4664,7 @@ export interface ConnectorConfig {
|
|
|
4315
4664
|
* - Service `checkr`: Your Checkr subdomain.
|
|
4316
4665
|
* - Service `clubspeed`: Your Clubspeed subdomain.
|
|
4317
4666
|
* - Service `collibra`: Your collibra subdomain.
|
|
4667
|
+
* - Service `complianceCheckpoint`: Your Compliance Checkpoint subdomain.
|
|
4318
4668
|
* - Service `concord`: Your Concord Sub Domain.
|
|
4319
4669
|
* - Service `contrastSecurity`: Your Contrast Security subdomain.
|
|
4320
4670
|
* - Service `customerio`: Your Customer.io region-specific Subdomain.
|
|
@@ -4337,7 +4687,9 @@ export interface ConnectorConfig {
|
|
|
4337
4687
|
* - Service `kandji`: Your Kandji Subdomain.
|
|
4338
4688
|
* - Service `khorosCare`: Your Khoros Care subDomain.
|
|
4339
4689
|
* - Service `lookerSource`: Your looker SubDomain name.
|
|
4690
|
+
* - Service `lucca`: Your Lucca subdomain.
|
|
4340
4691
|
* - Service `mailgun`: Your Mailgun subdomain.
|
|
4692
|
+
* - Service `matomo`: Your Matomo subdomain.
|
|
4341
4693
|
* - Service `maxioChargify`: Enter Your Subdomain.
|
|
4342
4694
|
* - Service `myosh`: Your myosh subdomain.
|
|
4343
4695
|
* - Service `namely`: Your Namely subdomain.
|
|
@@ -4358,6 +4710,7 @@ export interface ConnectorConfig {
|
|
|
4358
4710
|
* - Service `sapSuccessFactors`: Your SAP SuccessFactors Subdomain.
|
|
4359
4711
|
* - Service `sonarqube`: Your Sonarqube subdomain.
|
|
4360
4712
|
* - Service `starrez`: Your StarRez subdomain
|
|
4713
|
+
* - Service `sugarcrm`: Your SugarCRM subdomain.
|
|
4361
4714
|
* - Service `tableauSource`: Your Tableau Source subdomain.
|
|
4362
4715
|
* - Service `tempo`: Your Tempo subdomain.
|
|
4363
4716
|
* - Service `testrail`: Your TestRail subdomain.
|
|
@@ -4385,6 +4738,9 @@ export interface ConnectorConfig {
|
|
|
4385
4738
|
* - Service `learnupon`: Your Learnupon subdomain.
|
|
4386
4739
|
* - Service `maxioSaasoptics`: Your Maxio SaaSOptics subdomain.
|
|
4387
4740
|
* - Service `medallia`: Medallia subdomain
|
|
4741
|
+
* - Service `packiyo`: Your Packiyo subdomain.
|
|
4742
|
+
* - Service `qmaticDataConnect`: Your Qmatic Data Connect subdomain.
|
|
4743
|
+
* - Service `sana`: Your Sana subdomain.
|
|
4388
4744
|
* - Service `skillstx`: Your SkillsTX subdomain.
|
|
4389
4745
|
* - Service `smarthr`: Your SmartHR subdomain.
|
|
4390
4746
|
* - Service `sonarqube`: Your Sonarqube subdomain.
|
|
@@ -4441,8 +4797,9 @@ export interface ConnectorConfig {
|
|
|
4441
4797
|
syncFormat: string;
|
|
4442
4798
|
/**
|
|
4443
4799
|
* Field usage depends on `service` value:
|
|
4444
|
-
* - Service `
|
|
4445
|
-
* - Service `
|
|
4800
|
+
* - Service `financialForce`: Enable this option to sync formula fields directly (default value = `false`)
|
|
4801
|
+
* - Service `salesforce`: Enable this option to sync formula fields directly (default value = `false`)
|
|
4802
|
+
* - Service `salesforceSandbox`: Enable this option to sync formula fields directly (default value = `false`)
|
|
4446
4803
|
*/
|
|
4447
4804
|
syncFormulaFields: boolean;
|
|
4448
4805
|
/**
|
|
@@ -4464,7 +4821,7 @@ export interface ConnectorConfig {
|
|
|
4464
4821
|
* - Service `asana`: Whether to sync all projects or specific projects.
|
|
4465
4822
|
* - Service `bingads`: Whether to sync all accounts or specific accounts. Default value: `AllAccounts`.
|
|
4466
4823
|
* - Service `doubleClickCampaignManager`: Whether to sync all user profiles or specific ones. Default value: `AllAccounts`.
|
|
4467
|
-
* - Service `dynamodb`:
|
|
4824
|
+
* - Service `dynamodb`: Which packed mode setting to use. Default value: `UsePackedModeOnly`.
|
|
4468
4825
|
* - Service `facebook`: Option to select connector should sync all accounts or specific accounts. [Possible syncMode values](https://fivetran.com/docs/applications/facebook-ad-insights/api-config#syncmode).
|
|
4469
4826
|
* - Service `facebookAdAccount`: Whether to sync all accounts or specific accounts. Default value: `AllAccounts`.
|
|
4470
4827
|
* - Service `facebookAds`: Option to select connector should sync all accounts or specific accounts. [Possible syncMode values](https://fivetran.com/docs/connectors/applications/facebook-ads-insights/api-config#syncmode).
|
|
@@ -4541,11 +4898,21 @@ export interface ConnectorConfig {
|
|
|
4541
4898
|
* - Service `hanaSapHvaS4Netweaver`: Unique identifier sapsid of the SAP system. This field is displayed only when the REMOTE SERVICE IDENTIFICATION is set to System ID.
|
|
4542
4899
|
*/
|
|
4543
4900
|
systemId?: string;
|
|
4901
|
+
/**
|
|
4902
|
+
* Field usage depends on `service` value:
|
|
4903
|
+
* - Service `pigment`: Your Pigment table ID.
|
|
4904
|
+
*/
|
|
4905
|
+
tableId?: string;
|
|
4544
4906
|
/**
|
|
4545
4907
|
* Field usage depends on `service` value:
|
|
4546
4908
|
* - Service `airtable`: Name of table in Airtable
|
|
4547
4909
|
*/
|
|
4548
4910
|
tableName?: string;
|
|
4911
|
+
/**
|
|
4912
|
+
* Field usage depends on `service` value:
|
|
4913
|
+
* - Service `hubspot`: Timestamp to indicate when tables without access was updated
|
|
4914
|
+
*/
|
|
4915
|
+
tablesWithoutAccessUpdatedAt?: string;
|
|
4549
4916
|
/**
|
|
4550
4917
|
* Field usage depends on `service` value:
|
|
4551
4918
|
* - Service `cultureAmp`: Your Culture Amp Target entity ID.
|
|
@@ -4598,6 +4965,7 @@ export interface ConnectorConfig {
|
|
|
4598
4965
|
/**
|
|
4599
4966
|
* Field usage depends on `service` value:
|
|
4600
4967
|
* - Service `microsoftEntraId`: Your Microsoft Entra ID Tenant.
|
|
4968
|
+
* - Service `microsoftPowerBi`: Your Microsoft Power BI tenant.
|
|
4601
4969
|
* - Service `microsoftTeams`: Your Microsoft Teams Tenant.
|
|
4602
4970
|
* - Service `unicommerce`: Your uniware tenant.
|
|
4603
4971
|
* - Service `workday`: Workday tenant name
|
|
@@ -4610,6 +4978,11 @@ export interface ConnectorConfig {
|
|
|
4610
4978
|
* - Service `planful`: Your Planful tenant app URL.
|
|
4611
4979
|
*/
|
|
4612
4980
|
tenantAppUrl?: string;
|
|
4981
|
+
/**
|
|
4982
|
+
* Field usage depends on `service` value:
|
|
4983
|
+
* - Service `deposco`: Your Deposco tenant code.
|
|
4984
|
+
*/
|
|
4985
|
+
tenantCode?: string;
|
|
4613
4986
|
tenantConfigs?: outputs.ConnectorConfigTenantConfig[];
|
|
4614
4987
|
/**
|
|
4615
4988
|
* Field usage depends on `service` value:
|
|
@@ -4630,7 +5003,7 @@ export interface ConnectorConfig {
|
|
|
4630
5003
|
/**
|
|
4631
5004
|
* Field usage depends on `service` value:
|
|
4632
5005
|
* - Service `ivanti`: Your Ivanti Tenant URL.
|
|
4633
|
-
* - Service `playvoxWorkforceManagement`: Your Playvox Workforce Management
|
|
5006
|
+
* - Service `playvoxWorkforceManagement`: Your Playvox Workforce Management tenant URL.
|
|
4634
5007
|
* - Service `reltio`: Your Reltio tenant URL.
|
|
4635
5008
|
*/
|
|
4636
5009
|
tenantUrl?: string;
|
|
@@ -4681,6 +5054,16 @@ export interface ConnectorConfig {
|
|
|
4681
5054
|
* - Service `yahooGemini`: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `TWELVE`.
|
|
4682
5055
|
*/
|
|
4683
5056
|
timeframeMonths: string;
|
|
5057
|
+
/**
|
|
5058
|
+
* Field usage depends on `service` value:
|
|
5059
|
+
* - Service `rokt`: Your Rokt timezone.
|
|
5060
|
+
*/
|
|
5061
|
+
timezone: string;
|
|
5062
|
+
/**
|
|
5063
|
+
* Field usage depends on `service` value:
|
|
5064
|
+
* - Service `appleSearchAds`: Determines whether to use UTC or the users timezone from the apple account
|
|
5065
|
+
*/
|
|
5066
|
+
timezoneMode: string;
|
|
4684
5067
|
/**
|
|
4685
5068
|
* Field usage depends on `service` value:
|
|
4686
5069
|
* - Service `oracleHva`: Single-tenant database: The database's SID. Multi-tenant database: The database's TNS.
|
|
@@ -4694,8 +5077,11 @@ export interface ConnectorConfig {
|
|
|
4694
5077
|
toastId?: string;
|
|
4695
5078
|
/**
|
|
4696
5079
|
* Field usage depends on `service` value:
|
|
5080
|
+
* - Service `khorosCommunities`: Your Khoros Communities token.
|
|
5081
|
+
* - Service `matomo`: Your Matomo auth token.
|
|
4697
5082
|
* - Service `mode`: Your Mode Token.
|
|
4698
5083
|
* - Service `oracleMoatAnalytics`: Your Oracle Moat Analytics Token.
|
|
5084
|
+
* - Service `shareasale`: Your ShareASale token.
|
|
4699
5085
|
* - Service `solarwindsServiceDesk`: Your SolarWinds Service Desk token.
|
|
4700
5086
|
*/
|
|
4701
5087
|
token?: string;
|
|
@@ -4733,6 +5119,11 @@ export interface ConnectorConfig {
|
|
|
4733
5119
|
* - Service `mux`: Your Mux token secret key
|
|
4734
5120
|
*/
|
|
4735
5121
|
tokenSecretKey?: string;
|
|
5122
|
+
/**
|
|
5123
|
+
* Field usage depends on `service` value:
|
|
5124
|
+
* - Service `amazonDsp`: Your Amazon DSP token URL region.
|
|
5125
|
+
*/
|
|
5126
|
+
tokenUrlRegion: string;
|
|
4736
5127
|
/**
|
|
4737
5128
|
* Field usage depends on `service` value:
|
|
4738
5129
|
* - Service `azureServiceBus`: The comma-separated list of topics which should be synced. Required if you do not have manage permissions
|
|
@@ -5105,6 +5496,7 @@ export interface ConnectorConfig {
|
|
|
5105
5496
|
* - Service `okendo`: Your Okendo user ID.
|
|
5106
5497
|
* - Service `playvox`: Your Playvox User ID.
|
|
5107
5498
|
* - Service `sageIntacct`: User ID
|
|
5499
|
+
* - Service `vimeo`: Your Vimeo user ID.
|
|
5108
5500
|
*/
|
|
5109
5501
|
userId: string;
|
|
5110
5502
|
userKey: string;
|
|
@@ -5129,22 +5521,27 @@ export interface ConnectorConfig {
|
|
|
5129
5521
|
* Field usage depends on `service` value:
|
|
5130
5522
|
* - Service `absorbLms`: Your Absorb LMS username.
|
|
5131
5523
|
* - Service `adobeCommerce`: Your Adobe Commerce username.
|
|
5524
|
+
* - Service `akeneo`: Your Akeneo username.
|
|
5132
5525
|
* - Service `anaplan`: Your Anaplan user ID. Must be populated if `authMode` is set to `Basic`.
|
|
5133
5526
|
* - Service `appfigures`: Your Appfigures Username.
|
|
5527
|
+
* - Service `avevaPi`: Username for the user to authenticate as with the AF Server
|
|
5134
5528
|
* - Service `ceridianDayforce`: Your Ceridian Dayforce Username.
|
|
5135
5529
|
* - Service `churnzero`: Your ChurnZero username.
|
|
5136
5530
|
* - Service `cin7`: Your Cin7 API Username.
|
|
5137
5531
|
* - Service `collibra`: Your collibra username.
|
|
5532
|
+
* - Service `complianceCheckpoint`: Your Compliance Checkpoint account username.
|
|
5138
5533
|
* - Service `concur`: The SAP Concur username.
|
|
5139
5534
|
* - Service `confluence`: Your Confluence username.
|
|
5140
5535
|
* - Service `contrastSecurity`: Your Contrast Security API Username.
|
|
5141
5536
|
* - Service `dclLogistics`: Your DCL Logistics username.
|
|
5537
|
+
* - Service `deposco`: Your Deposco username.
|
|
5142
5538
|
* - Service `github`: `Login` of your GitHub profile.
|
|
5143
5539
|
* - Service `gladly`: Your Gladly Username.
|
|
5144
5540
|
* - Service `globalmeet`: Your GlobalMeet Username.
|
|
5145
5541
|
* - Service `gorgias`: Your Gorgias username.
|
|
5146
5542
|
* - Service `greenPowerMonitor`: Your GreenPowerMonitor username.
|
|
5147
5543
|
* - Service `guru`: Your Guru username.
|
|
5544
|
+
* - Service `hiltiOntrack`: Your Hilti On!Track username.
|
|
5148
5545
|
* - Service `impact`: Your Impact Account SID
|
|
5149
5546
|
* - Service `integralAdScience`: Your integralAdScience username.
|
|
5150
5547
|
* - Service `itunesConnect`: Your Apple ID
|
|
@@ -5162,7 +5559,8 @@ export interface ConnectorConfig {
|
|
|
5162
5559
|
* - Service `oracleFusionCloudAppsHcm`: The Oracle Fusion Cloud username.
|
|
5163
5560
|
* - Service `partnerize`: Your Partnerize account's username.
|
|
5164
5561
|
* - Service `pingdom`: Your Pingdom Username.
|
|
5165
|
-
* - Service `podio`: Your Podio username.
|
|
5562
|
+
* - Service `podio`: Your Podio account username.
|
|
5563
|
+
* - Service `qmaticDataConnect`: Your Qmatic Data Connect username.
|
|
5166
5564
|
* - Service `quorum`: Your Quorum username .
|
|
5167
5565
|
* - Service `revx`: Your RevX Username.
|
|
5168
5566
|
* - Service `rtbHouse`: Your RTB House username.
|
|
@@ -5174,7 +5572,9 @@ export interface ConnectorConfig {
|
|
|
5174
5572
|
* - Service `shopware`: Your Shopware username.
|
|
5175
5573
|
* - Service `splash`: Your Splash username.
|
|
5176
5574
|
* - Service `starrez`: Your StarRez API username
|
|
5575
|
+
* - Service `stickyio`: Your sticky.io username .
|
|
5177
5576
|
* - Service `stylight`: Your Stylight Username.
|
|
5577
|
+
* - Service `sugarcrm`: Your SugarCRM username.
|
|
5178
5578
|
* - Service `teamwork`: Your Teamwork username.
|
|
5179
5579
|
* - Service `testrail`: Your TestRail username.
|
|
5180
5580
|
* - Service `ukgPro`: Your UKG Pro username.
|
|
@@ -5201,11 +5601,21 @@ export interface ConnectorConfig {
|
|
|
5201
5601
|
* - Service `snapchatAds`: The time period to attribute conversions based on views. Default value: `DAY_1`
|
|
5202
5602
|
*/
|
|
5203
5603
|
viewAttributionWindow: string;
|
|
5604
|
+
/**
|
|
5605
|
+
* Field usage depends on `service` value:
|
|
5606
|
+
* - Service `pigment`: Your Pigment view ID.
|
|
5607
|
+
*/
|
|
5608
|
+
viewId?: string;
|
|
5204
5609
|
/**
|
|
5205
5610
|
* Field usage depends on `service` value:
|
|
5206
5611
|
* - Service `linkedinAds`: The time period to attribute conversions based on views. Default value: `DAY_7`
|
|
5207
5612
|
*/
|
|
5208
5613
|
viewThroughAttributionWindowSize: string;
|
|
5614
|
+
/**
|
|
5615
|
+
* Field usage depends on `service` value:
|
|
5616
|
+
* - Service `adyen`: Your Adyen Web Service API key.
|
|
5617
|
+
*/
|
|
5618
|
+
webServiceApiKey?: string;
|
|
5209
5619
|
/**
|
|
5210
5620
|
* Field usage depends on `service` value:
|
|
5211
5621
|
* - Service `appsflyer`: Webhook Url
|
|
@@ -5582,6 +5992,11 @@ export interface ConnectorConfigReport {
|
|
|
5582
5992
|
*/
|
|
5583
5993
|
filterType?: string;
|
|
5584
5994
|
filterValue?: string;
|
|
5995
|
+
/**
|
|
5996
|
+
* Field usage depends on `service` value:
|
|
5997
|
+
* - Service `workday`: Select this option to generate a Primary Key for reports where no single column or combination of columns can be used to form a Primary Key.
|
|
5998
|
+
*/
|
|
5999
|
+
generateFivetranPk: boolean;
|
|
5585
6000
|
/**
|
|
5586
6001
|
* Field usage depends on `service` value:
|
|
5587
6002
|
* - Service `googleAnalytics`: The report metrics to include into a sync.
|
|
@@ -5595,6 +6010,16 @@ export interface ConnectorConfigReport {
|
|
|
5595
6010
|
* - Service `googleAnalytics4`: The name of the Prebuilt Report from which the connector will sync the data.
|
|
5596
6011
|
*/
|
|
5597
6012
|
prebuiltReport: string;
|
|
6013
|
+
/**
|
|
6014
|
+
* Field usage depends on `service` value:
|
|
6015
|
+
* - Service `workday`: Primary Keys
|
|
6016
|
+
*/
|
|
6017
|
+
primaryKeys?: string[];
|
|
6018
|
+
/**
|
|
6019
|
+
* Field usage depends on `service` value:
|
|
6020
|
+
* - Service `workday`: This is to select report format from JSON and CSV. By default, report format is JSON.
|
|
6021
|
+
*/
|
|
6022
|
+
reportFormatType: string;
|
|
5598
6023
|
/**
|
|
5599
6024
|
* Field usage depends on `service` value:
|
|
5600
6025
|
* - Service `googleAds`: The name of the Google Ads report from which the connector will sync the data. [Possible reportType values](https://developers.google.com/adwords/api/docs/appendix/reports#report-types).
|
|
@@ -5602,6 +6027,11 @@ export interface ConnectorConfigReport {
|
|
|
5602
6027
|
* - Service `googleSearchConsole`: The type of report
|
|
5603
6028
|
*/
|
|
5604
6029
|
reportType: string;
|
|
6030
|
+
/**
|
|
6031
|
+
* Field usage depends on `service` value:
|
|
6032
|
+
* - Service `workday`: URL for a live custom report.
|
|
6033
|
+
*/
|
|
6034
|
+
reportUrl?: string;
|
|
5605
6035
|
/**
|
|
5606
6036
|
* Field usage depends on `service` value:
|
|
5607
6037
|
* - Service `googleAnalytics4`: The custom window size for rollback syncs.
|
|
@@ -5619,6 +6049,11 @@ export interface ConnectorConfigReport {
|
|
|
5619
6049
|
* - Service `googleSearchAds360`: The report segments included to sync.
|
|
5620
6050
|
*/
|
|
5621
6051
|
segments?: string[];
|
|
6052
|
+
/**
|
|
6053
|
+
* Field usage depends on `service` value:
|
|
6054
|
+
* - Service `workday`: This option is to unpack the nested columns and sync them separately. By default, we sync the nested columns as JSON objects.
|
|
6055
|
+
*/
|
|
6056
|
+
supportNestedColumns: boolean;
|
|
5622
6057
|
/**
|
|
5623
6058
|
* Field usage depends on `service` value:
|
|
5624
6059
|
* - Service `googleAds`: The table name within the schema to which connector will sync the data of the specific report.
|
|
@@ -5626,6 +6061,7 @@ export interface ConnectorConfigReport {
|
|
|
5626
6061
|
* - Service `googleAnalytics4`: The table name within the schema to which connector will sync the data of the specific report.
|
|
5627
6062
|
* - Service `googleSearchAds360`: The name of a table within the schema to which connector syncs the data of a given report.
|
|
5628
6063
|
* - Service `googleSearchConsole`: The name of a table within the schema to which connector syncs the data of a given report.
|
|
6064
|
+
* - Service `workday`: The table name within the schema to which connector will sync the data of the specific report.
|
|
5629
6065
|
*/
|
|
5630
6066
|
table: string;
|
|
5631
6067
|
/**
|
|
@@ -5993,10 +6429,23 @@ export interface DestinationConfig {
|
|
|
5993
6429
|
auth: string;
|
|
5994
6430
|
/**
|
|
5995
6431
|
* Field usage depends on `service` value:
|
|
6432
|
+
* - Service `adls`: Authentication type
|
|
5996
6433
|
* - Service `databricks`: Authentication type
|
|
6434
|
+
* - Service `newS3Datalake`: Authentication type
|
|
6435
|
+
* - Service `onelake`: Authentication type
|
|
5997
6436
|
* - Service `redshift`: Authentication type. Default value: `PASSWORD`.
|
|
5998
6437
|
*/
|
|
5999
6438
|
authType: string;
|
|
6439
|
+
/**
|
|
6440
|
+
* Field usage depends on `service` value:
|
|
6441
|
+
* - Service `newS3Datalake`: AWS access key to access the S3 bucket and AWS Glue
|
|
6442
|
+
*/
|
|
6443
|
+
awsAccessKeyId?: string;
|
|
6444
|
+
/**
|
|
6445
|
+
* Field usage depends on `service` value:
|
|
6446
|
+
* - Service `newS3Datalake`: AWS secret access key to access the S3 bucket and AWS Glue
|
|
6447
|
+
*/
|
|
6448
|
+
awsSecretAccessKey?: string;
|
|
6000
6449
|
/**
|
|
6001
6450
|
* Field usage depends on `service` value:
|
|
6002
6451
|
* - Service `confluentCloudWh`: Comma-separated list of Confluent Cloud servers in the `server:port` format.
|
|
@@ -6007,12 +6456,15 @@ export interface DestinationConfig {
|
|
|
6007
6456
|
* - Service `bigQuery`: Customer bucket. If specified, your GCS bucket will be used to process the data instead of a Fivetran-managed bucket. The bucket must be present in the same location as the dataset location.
|
|
6008
6457
|
* - Service `bigQueryDts`: Customer bucket. If specified, your GCS bucket will be used to process the data instead of a Fivetran-managed bucket. The bucket must be present in the same location as the dataset location.
|
|
6009
6458
|
* - Service `managedBigQuery`: Customer bucket. If specified, your GCS bucket will be used to process the data instead of a Fivetran-managed bucket. The bucket must be present in the same location as the dataset location.
|
|
6010
|
-
* - Service `newS3Datalake`: The name of the bucket to be used as destination
|
|
6459
|
+
* - Service `newS3Datalake`: (Immutable) The name of the bucket to be used as destination
|
|
6011
6460
|
*/
|
|
6012
6461
|
bucket?: string;
|
|
6013
6462
|
/**
|
|
6014
6463
|
* Field usage depends on `service` value:
|
|
6464
|
+
* - Service `adls`: Catalog name
|
|
6015
6465
|
* - Service `databricks`: Catalog name
|
|
6466
|
+
* - Service `newS3Datalake`: Catalog name
|
|
6467
|
+
* - Service `onelake`: Catalog name
|
|
6016
6468
|
*/
|
|
6017
6469
|
catalog?: string;
|
|
6018
6470
|
/**
|
|
@@ -6068,7 +6520,7 @@ export interface DestinationConfig {
|
|
|
6068
6520
|
connectionType: string;
|
|
6069
6521
|
/**
|
|
6070
6522
|
* Field usage depends on `service` value:
|
|
6071
|
-
* - Service `adls`: Container to store delta table files
|
|
6523
|
+
* - Service `adls`: (Immutable) Container to store delta table files
|
|
6072
6524
|
* - Service `onelake`: Workspace name to store delta table files
|
|
6073
6525
|
*/
|
|
6074
6526
|
containerName?: string;
|
|
@@ -6113,6 +6565,13 @@ export interface DestinationConfig {
|
|
|
6113
6565
|
* - Service `sqlServerWarehouse`: Database name
|
|
6114
6566
|
*/
|
|
6115
6567
|
database?: string;
|
|
6568
|
+
/**
|
|
6569
|
+
* Field usage depends on `service` value:
|
|
6570
|
+
* - Service `adls`: Databricks Connection method. Default value: `Directly`.
|
|
6571
|
+
* - Service `newS3Datalake`: Databricks Connection method. Default value: `Directly`.
|
|
6572
|
+
* - Service `onelake`: Databricks Connection method. Default value: `Directly`.
|
|
6573
|
+
*/
|
|
6574
|
+
databricksConnectionType: string;
|
|
6116
6575
|
enableRemoteExecution: boolean;
|
|
6117
6576
|
/**
|
|
6118
6577
|
* Field usage depends on `service` value:
|
|
@@ -6159,7 +6618,10 @@ export interface DestinationConfig {
|
|
|
6159
6618
|
host?: string;
|
|
6160
6619
|
/**
|
|
6161
6620
|
* Field usage depends on `service` value:
|
|
6621
|
+
* - Service `adls`: HTTP path
|
|
6162
6622
|
* - Service `databricks`: HTTP path
|
|
6623
|
+
* - Service `newS3Datalake`: HTTP path
|
|
6624
|
+
* - Service `onelake`: HTTP path
|
|
6163
6625
|
*/
|
|
6164
6626
|
httpPath?: string;
|
|
6165
6627
|
/**
|
|
@@ -6179,7 +6641,12 @@ export interface DestinationConfig {
|
|
|
6179
6641
|
isRedshiftServerless: boolean;
|
|
6180
6642
|
/**
|
|
6181
6643
|
* Field usage depends on `service` value:
|
|
6182
|
-
* - Service `onelake`:
|
|
6644
|
+
* - Service `onelake`: (Immutable) OneLake lakehouse GUID
|
|
6645
|
+
*/
|
|
6646
|
+
lakehouseGuid?: string;
|
|
6647
|
+
/**
|
|
6648
|
+
* Field usage depends on `service` value:
|
|
6649
|
+
* - Service `onelake`: (Immutable) Name of your lakehouse
|
|
6183
6650
|
*/
|
|
6184
6651
|
lakehouseName?: string;
|
|
6185
6652
|
mskStsRegion?: string;
|
|
@@ -6190,12 +6657,18 @@ export interface DestinationConfig {
|
|
|
6190
6657
|
numOfPartitions: number;
|
|
6191
6658
|
/**
|
|
6192
6659
|
* Field usage depends on `service` value:
|
|
6660
|
+
* - Service `adls`: OAuth 2.0 client ID
|
|
6193
6661
|
* - Service `databricks`: OAuth 2.0 client ID
|
|
6662
|
+
* - Service `newS3Datalake`: OAuth 2.0 client ID
|
|
6663
|
+
* - Service `onelake`: OAuth 2.0 client ID
|
|
6194
6664
|
*/
|
|
6195
6665
|
oauth2ClientId?: string;
|
|
6196
6666
|
/**
|
|
6197
6667
|
* Field usage depends on `service` value:
|
|
6668
|
+
* - Service `adls`: OAuth 2.0 secret
|
|
6198
6669
|
* - Service `databricks`: OAuth 2.0 secret
|
|
6670
|
+
* - Service `newS3Datalake`: OAuth 2.0 secret
|
|
6671
|
+
* - Service `onelake`: OAuth 2.0 secret
|
|
6199
6672
|
*/
|
|
6200
6673
|
oauth2Secret?: string;
|
|
6201
6674
|
/**
|
|
@@ -6228,11 +6701,15 @@ export interface DestinationConfig {
|
|
|
6228
6701
|
password?: string;
|
|
6229
6702
|
/**
|
|
6230
6703
|
* Field usage depends on `service` value:
|
|
6704
|
+
* - Service `adls`: Personal access token
|
|
6231
6705
|
* - Service `databricks`: Personal access token
|
|
6706
|
+
* - Service `newS3Datalake`: Personal access token
|
|
6707
|
+
* - Service `onelake`: Personal access token
|
|
6232
6708
|
*/
|
|
6233
6709
|
personalAccessToken?: string;
|
|
6234
6710
|
/**
|
|
6235
6711
|
* Field usage depends on `service` value:
|
|
6712
|
+
* - Service `adls`: Server port number
|
|
6236
6713
|
* - Service `auroraPostgresWarehouse`: Server port number
|
|
6237
6714
|
* - Service `auroraWarehouse`: Server port number
|
|
6238
6715
|
* - Service `azurePostgresWarehouse`: Server port number
|
|
@@ -6244,6 +6721,8 @@ export interface DestinationConfig {
|
|
|
6244
6721
|
* - Service `mariaWarehouse`: Server port number
|
|
6245
6722
|
* - Service `mysqlRdsWarehouse`: Server port number
|
|
6246
6723
|
* - Service `mysqlWarehouse`: Server port number
|
|
6724
|
+
* - Service `newS3Datalake`: Server port number
|
|
6725
|
+
* - Service `onelake`: Server port number
|
|
6247
6726
|
* - Service `panoply`: Server port number
|
|
6248
6727
|
* - Service `periscopeWarehouse`: Server port number
|
|
6249
6728
|
* - Service `postgresGcpWarehouse`: Server port number
|
|
@@ -6257,9 +6736,9 @@ export interface DestinationConfig {
|
|
|
6257
6736
|
port: number;
|
|
6258
6737
|
/**
|
|
6259
6738
|
* Field usage depends on `service` value:
|
|
6260
|
-
* - Service `adls`: path/to/data within the container
|
|
6261
|
-
* - Service `newS3Datalake`: Prefix path of the bucket for which you have configured access policy. It is not required if access has been granted to entire Bucket in the access policy
|
|
6262
|
-
* - Service `onelake`: path/to/data within your lakehouse inside the Files directory
|
|
6739
|
+
* - Service `adls`: (Immutable) path/to/data within the container
|
|
6740
|
+
* - Service `newS3Datalake`: (Immutable) Prefix path of the bucket for which you have configured access policy. It is not required if access has been granted to entire Bucket in the access policy
|
|
6741
|
+
* - Service `onelake`: (Immutable) path/to/data within your lakehouse inside the Files directory
|
|
6263
6742
|
*/
|
|
6264
6743
|
prefixPath?: string;
|
|
6265
6744
|
/**
|
|
@@ -6396,9 +6875,19 @@ export interface DestinationConfig {
|
|
|
6396
6875
|
securityProtocol: string;
|
|
6397
6876
|
/**
|
|
6398
6877
|
* Field usage depends on `service` value:
|
|
6878
|
+
* - Service `adls`: Server Host name
|
|
6399
6879
|
* - Service `databricks`: Server name
|
|
6880
|
+
* - Service `newS3Datalake`: Server host name
|
|
6881
|
+
* - Service `onelake`: Server Host name
|
|
6400
6882
|
*/
|
|
6401
6883
|
serverHostName?: string;
|
|
6884
|
+
/**
|
|
6885
|
+
* Field usage depends on `service` value:
|
|
6886
|
+
* - Service `adls`: Should maintain tables in Databricks
|
|
6887
|
+
* - Service `newS3Datalake`: Should maintain tables in Databricks
|
|
6888
|
+
* - Service `onelake`: Should maintain tables in Databricks
|
|
6889
|
+
*/
|
|
6890
|
+
shouldMaintainTablesInDatabricks: boolean;
|
|
6402
6891
|
/**
|
|
6403
6892
|
* Field usage depends on `service` value:
|
|
6404
6893
|
* - Service `adls`: Snapshots older than the retention period are deleted every week. Default value: `ONE_WEEK`.
|
|
@@ -6410,8 +6899,8 @@ export interface DestinationConfig {
|
|
|
6410
6899
|
snowflakeRegion?: string;
|
|
6411
6900
|
/**
|
|
6412
6901
|
* Field usage depends on `service` value:
|
|
6413
|
-
* - Service `adls`: Storage account for Azure Data Lake Storage Gen2 name
|
|
6414
|
-
* - Service `onelake`: Storage account for Azure Data Lake Storage Gen2 name
|
|
6902
|
+
* - Service `adls`: (Immutable) Storage account for Azure Data Lake Storage Gen2 name
|
|
6903
|
+
* - Service `onelake`: (Immutable) Storage account for Azure Data Lake Storage Gen2 name
|
|
6415
6904
|
*/
|
|
6416
6905
|
storageAccountName?: string;
|
|
6417
6906
|
/**
|
|
@@ -6514,6 +7003,11 @@ export interface DestinationConfig {
|
|
|
6514
7003
|
* - Service `sqlServerWarehouse`: Database user name
|
|
6515
7004
|
*/
|
|
6516
7005
|
user?: string;
|
|
7006
|
+
/**
|
|
7007
|
+
* Field usage depends on `service` value:
|
|
7008
|
+
* - Service `onelake`: (Immutable) OneLake workspace GUID
|
|
7009
|
+
*/
|
|
7010
|
+
workspaceGuid?: string;
|
|
6517
7011
|
/**
|
|
6518
7012
|
* Field usage depends on `service` value:
|
|
6519
7013
|
* - Service `onelake`: OneLake workspace name
|
|
@@ -6701,6 +7195,7 @@ export interface GetConnectorConfig {
|
|
|
6701
7195
|
* Field usage depends on `service` value:
|
|
6702
7196
|
* - Service `gainsightCustomerSuccess`: The access key for API authentication.
|
|
6703
7197
|
* - Service `gongio`: Your Gongio Access key.
|
|
7198
|
+
* - Service `lineAds`: Your LINE Ads access key.
|
|
6704
7199
|
* - Service `planful`: Your Planful access key.
|
|
6705
7200
|
* - Service `retailnext`: Your RetailNext access key.
|
|
6706
7201
|
*/
|
|
@@ -6710,6 +7205,8 @@ export interface GetConnectorConfig {
|
|
|
6710
7205
|
* - Service `appsflyer`: Your AWS access key ID.
|
|
6711
7206
|
* - Service `awsCostReport`: Access Key ID
|
|
6712
7207
|
* - Service `checkout`: Your Checkout.com access key ID.
|
|
7208
|
+
* - Service `cloudtalk`: Your CloudTalk Access Key ID.
|
|
7209
|
+
* - Service `nice`: Your NICE access key ID.
|
|
6713
7210
|
* - Service `s3`: Access Key ID
|
|
6714
7211
|
* - Service `wasabiCloudStorage`: Access Key ID
|
|
6715
7212
|
*/
|
|
@@ -6718,7 +7215,9 @@ export interface GetConnectorConfig {
|
|
|
6718
7215
|
* Field usage depends on `service` value:
|
|
6719
7216
|
* - Service `awsCostReport`: Access Key Secret
|
|
6720
7217
|
* - Service `checkout`: Your Checkout.com access key secret.
|
|
7218
|
+
* - Service `cloudtalk`: Your CloudTalk Access Key Secret.
|
|
6721
7219
|
* - Service `gongio`: Your Gongio Access Key Secret.
|
|
7220
|
+
* - Service `nice`: Your NICE access key secret.
|
|
6722
7221
|
* - Service `s3`: Access Key Secret
|
|
6723
7222
|
* - Service `wasabiCloudStorage`: Access Key Secret
|
|
6724
7223
|
*/
|
|
@@ -6735,14 +7234,18 @@ export interface GetConnectorConfig {
|
|
|
6735
7234
|
* - Service `getfeedback`: Your GetFeedback Access token.
|
|
6736
7235
|
* - Service `gocardless`: Your GoCardless API token.
|
|
6737
7236
|
* - Service `ironclad`: Your Ironclad access token.
|
|
7237
|
+
* - Service `khorosMarketing`: Your Khoros Marketing access token.
|
|
6738
7238
|
* - Service `kustomer`: Your Kustomer API key.
|
|
6739
7239
|
* - Service `lattice`: Your Lattice API access token.
|
|
6740
7240
|
* - Service `launchdarkly`: Your LaunchDarkly access token.
|
|
7241
|
+
* - Service `leapCrm`: Your Leap CRM access token.
|
|
6741
7242
|
* - Service `nylas`: Your Nylas access_token.
|
|
6742
7243
|
* - Service `planhat`: Your Planhat access token.
|
|
6743
7244
|
* - Service `rollbar`: Your Rollbar Access Token.
|
|
6744
7245
|
* - Service `samsara`: Your Samsara API token.
|
|
6745
7246
|
* - Service `slab`: Your Slab API key.
|
|
7247
|
+
* - Service `stripe`: The Stripe API Restricted Key
|
|
7248
|
+
* - Service `stripeTest`: The Stripe API Restricted Key
|
|
6746
7249
|
* - Service `talkwalker`: Your Talkwalker access token.
|
|
6747
7250
|
* - Service `workable`: Your Workable Access Token.
|
|
6748
7251
|
* - Service `workramp`: Your WorkRamp access token.
|
|
@@ -6772,6 +7275,7 @@ export interface GetConnectorConfig {
|
|
|
6772
7275
|
* - Service `dear`: Your Dear Account ID.
|
|
6773
7276
|
* - Service `harvest`: Your Harvest Account ID.
|
|
6774
7277
|
* - Service `optimizely`: Your Optimizely account ID.
|
|
7278
|
+
* - Service `rokt`: Your Rokt account ID.
|
|
6775
7279
|
* - Service `udemyBusiness`: Your Udemy Business account ID.
|
|
6776
7280
|
*/
|
|
6777
7281
|
accountId: string;
|
|
@@ -6931,6 +7435,11 @@ export interface GetConnectorConfig {
|
|
|
6931
7435
|
* - Service `sqlServerSapEccHva`: The host address of the machine running the agent. Often the same as the DB host.
|
|
6932
7436
|
*/
|
|
6933
7437
|
agentHost: string;
|
|
7438
|
+
/**
|
|
7439
|
+
* Field usage depends on `service` value:
|
|
7440
|
+
* - Service `phoenixAds`: Your Phoenix Ads Agent ID.
|
|
7441
|
+
*/
|
|
7442
|
+
agentId: string;
|
|
6934
7443
|
/**
|
|
6935
7444
|
* Field usage depends on `service` value:
|
|
6936
7445
|
* - Service `oracleHva`: The home directory of the Oracle database.
|
|
@@ -7066,6 +7575,7 @@ export interface GetConnectorConfig {
|
|
|
7066
7575
|
api: string;
|
|
7067
7576
|
/**
|
|
7068
7577
|
* Field usage depends on `service` value:
|
|
7578
|
+
* - Service `flywheelDigital`: Your Flywheel Digital API access token.
|
|
7069
7579
|
* - Service `shopify`: API access token of your custom app.
|
|
7070
7580
|
* - Service `square`: The Square API access token of your application.
|
|
7071
7581
|
*/
|
|
@@ -7085,12 +7595,14 @@ export interface GetConnectorConfig {
|
|
|
7085
7595
|
* - Service `15five`: Your 15five API key.
|
|
7086
7596
|
* - Service `360learning`: Your 360Learning API Key.
|
|
7087
7597
|
* - Service `6sense`: Your 6sense API Key.
|
|
7598
|
+
* - Service `acculynx`: Your Acculynx API key.
|
|
7088
7599
|
* - Service `activecampaign`: Your ActiveCampaign API key.
|
|
7089
7600
|
* - Service `affinity`: Your Affinity API key.
|
|
7090
7601
|
* - Service `airtable`: API key of the Airtable account.
|
|
7091
7602
|
* - Service `algolia`: Your Algolia API key.
|
|
7092
7603
|
* - Service `anvyl`: Your Anvyl API key.
|
|
7093
7604
|
* - Service `appcues`: Your Appcues API key.
|
|
7605
|
+
* - Service `ashby`: Your Ashby API key.
|
|
7094
7606
|
* - Service `assembled`: Your Assembled API key.
|
|
7095
7607
|
* - Service `atlassianJiraAlign`: Your Jira Align API key.
|
|
7096
7608
|
* - Service `atlassianOpsGenie`: Your Opsgenie API key
|
|
@@ -7099,8 +7611,9 @@ export interface GetConnectorConfig {
|
|
|
7099
7611
|
* - Service `avantlink`: Your AvantLink API key.
|
|
7100
7612
|
* - Service `ballotready`: Your BallotReady API token.
|
|
7101
7613
|
* - Service `bamboohr`: Your API Key.
|
|
7102
|
-
* - Service `bazaarvoice`: Your Bazaarvoice
|
|
7614
|
+
* - Service `bazaarvoice`: Your Bazaarvoice API key.
|
|
7103
7615
|
* - Service `betterworks`: Your Betterworks API key.
|
|
7616
|
+
* - Service `bigmarker`: Your BigMarker API key.
|
|
7104
7617
|
* - Service `bizzabo`: Your Bizzabo API key.
|
|
7105
7618
|
* - Service `braveAds`: Your Brave Ads API key
|
|
7106
7619
|
* - Service `braze`: Your Braze API Key.
|
|
@@ -7119,6 +7632,8 @@ export interface GetConnectorConfig {
|
|
|
7119
7632
|
* - Service `cimis`: Your Cimis API key.
|
|
7120
7633
|
* - Service `circleci`: Your CircleCI API Key.
|
|
7121
7634
|
* - Service `clickup`: Your ClickUp API key.
|
|
7635
|
+
* - Service `clockify`: Your Clockify API key.
|
|
7636
|
+
* - Service `clockodo`: Your Clockodo API key.
|
|
7122
7637
|
* - Service `close`: Your Close API key.
|
|
7123
7638
|
* - Service `cloudbeds`: Your Cloudbeds API key.
|
|
7124
7639
|
* - Service `clubspeed`: Your Clubspeed API key.
|
|
@@ -7143,7 +7658,9 @@ export interface GetConnectorConfig {
|
|
|
7143
7658
|
* - Service `easypost`: Your EasyPost API Key.
|
|
7144
7659
|
* - Service `electronicTenantSolutions`: Your Electronic Tenant Solutions API key.
|
|
7145
7660
|
* - Service `eventsforce`: Your Eventsforce API secret key.
|
|
7661
|
+
* - Service `everflow`: Your Everflow API key.
|
|
7146
7662
|
* - Service `everhour`: Your Everhour API Token.
|
|
7663
|
+
* - Service `expensein`: Your ExpenseIn API key.
|
|
7147
7664
|
* - Service `factorial`: Your Factorial API key.
|
|
7148
7665
|
* - Service `firehydrant`: Your FireHydrant API key.
|
|
7149
7666
|
* - Service `float`: Your Float API key.
|
|
@@ -7189,8 +7706,12 @@ export interface GetConnectorConfig {
|
|
|
7189
7706
|
* - Service `linksquares`: Your LinkSquares API key.
|
|
7190
7707
|
* - Service `lob`: Your Lob API key.
|
|
7191
7708
|
* - Service `loop`: Your Loop API key.
|
|
7709
|
+
* - Service `lucca`: Your Lucca API key.
|
|
7192
7710
|
* - Service `luma`: Your Luma API key.
|
|
7711
|
+
* - Service `maileon`: Your Maileon API key.
|
|
7193
7712
|
* - Service `mailgun`: Your Mailgun API key.
|
|
7713
|
+
* - Service `mailjet`: Your Mailjet API key.
|
|
7714
|
+
* - Service `malomo`: Your Malomo API key.
|
|
7194
7715
|
* - Service `mambu`: Your Mambu API key.
|
|
7195
7716
|
* - Service `mandrill`: Your Mandrill API key.
|
|
7196
7717
|
* - Service `maxioChargify`: Enter Your API Key.
|
|
@@ -7203,16 +7724,19 @@ export interface GetConnectorConfig {
|
|
|
7203
7724
|
* - Service `ordway`: Your Ordway API key.
|
|
7204
7725
|
* - Service `ortto`: Your Ortto API key.
|
|
7205
7726
|
* - Service `pagerduty`: Your PagerDuty API key.
|
|
7727
|
+
* - Service `pandadoc`: Your PandaDoc API key.
|
|
7206
7728
|
* - Service `papershift`: Your Papershift API Key
|
|
7207
7729
|
* - Service `partnerize`: Your Partnerize user API key.
|
|
7208
7730
|
* - Service `persona`: Your Persona API key.
|
|
7209
7731
|
* - Service `picqer`: Your Picqer API key.
|
|
7732
|
+
* - Service `pigment`: Your Pigment API key.
|
|
7210
7733
|
* - Service `pinpoint`: Your Pinpoint API key.
|
|
7211
7734
|
* - Service `pipe17`: The Pipe17 API key.
|
|
7212
7735
|
* - Service `placerai`: Your Placer.ai API key.
|
|
7213
7736
|
* - Service `playvox`: Your Playvox API Key.
|
|
7214
7737
|
* - Service `posthog`: Your PostHog API key.
|
|
7215
7738
|
* - Service `prive`: Your Prive API key.
|
|
7739
|
+
* - Service `prosperstack`: Your ProsperStack API key.
|
|
7216
7740
|
* - Service `qualaroo`: Your Qualaroo API Key.
|
|
7217
7741
|
* - Service `quorum`: Your Quorum API key.
|
|
7218
7742
|
* - Service `reboundReturns`: Your ReBound Returns API key.
|
|
@@ -7226,6 +7750,7 @@ export interface GetConnectorConfig {
|
|
|
7226
7750
|
* - Service `rippling`: Your Rippling API key.
|
|
7227
7751
|
* - Service `rocketlane`: Your Rocketlane API key.
|
|
7228
7752
|
* - Service `rootly`: Your Rootly API key.
|
|
7753
|
+
* - Service `ruddr`: Your Ruddr API key.
|
|
7229
7754
|
* - Service `safebase`: Your SafeBase API key.
|
|
7230
7755
|
* - Service `sageHr`: Your Sage HR API key.
|
|
7231
7756
|
* - Service `sailthru`: The Sailthru API key.
|
|
@@ -7253,18 +7778,23 @@ export interface GetConnectorConfig {
|
|
|
7253
7778
|
* - Service `teamtailor`: Your Teamtailor API key.
|
|
7254
7779
|
* - Service `testrail`: Your TestRail API key.
|
|
7255
7780
|
* - Service `ticketTailor`: Your Ticket Tailor API key.
|
|
7256
|
-
* - Service `transcend`: Your Transcend API
|
|
7781
|
+
* - Service `transcend`: Your Transcend API key.
|
|
7257
7782
|
* - Service `trello`: Your TRELLO api key.
|
|
7783
|
+
* - Service `tripleWhale`: Your Triple Whale API key.
|
|
7258
7784
|
* - Service `uppromote`: Your UpPromote API key.
|
|
7259
7785
|
* - Service `veeqo`: Your Veeqo API key.
|
|
7786
|
+
* - Service `venminder`: Your Venminder API key.
|
|
7260
7787
|
* - Service `visitByGes`: Your Visit by GES API key.
|
|
7261
7788
|
* - Service `vitally`: Your Vitally API key.
|
|
7262
7789
|
* - Service `vonage`: Your Vonage API Key.
|
|
7263
7790
|
* - Service `vts`: Your VTS API key.
|
|
7264
7791
|
* - Service `webconnex`: Your Webconnex API key.
|
|
7792
|
+
* - Service `wickedReports`: Your Wicked Reports API key.
|
|
7793
|
+
* - Service `workleapOfficevibe`: Your Workleap Officevibe API key.
|
|
7265
7794
|
* - Service `xsolla`: Your Xsolla API key.
|
|
7266
7795
|
* - Service `yougovSport`: Your Yougov Sport API key.
|
|
7267
7796
|
* - Service `zingtree`: Your Zingtree API key.
|
|
7797
|
+
* - Service `zip`: Your Zip API key.
|
|
7268
7798
|
*/
|
|
7269
7799
|
apiKey: string;
|
|
7270
7800
|
/**
|
|
@@ -7287,6 +7817,11 @@ export interface GetConnectorConfig {
|
|
|
7287
7817
|
* - Service `marketo`: Allowed number of API requests to Marketo instance per day, the default value is 10000.
|
|
7288
7818
|
*/
|
|
7289
7819
|
apiQuota: number;
|
|
7820
|
+
/**
|
|
7821
|
+
* Field usage depends on `service` value:
|
|
7822
|
+
* - Service `theMovieDatabase`: Your The Movie Database API read access token.
|
|
7823
|
+
*/
|
|
7824
|
+
apiReadAccessToken: string;
|
|
7290
7825
|
/**
|
|
7291
7826
|
* Field usage depends on `service` value:
|
|
7292
7827
|
* - Service `qualtrics`: Allowed number of API requests to Qualtrics per minute, the default value is 2000. Maximum allowed number is 3000 because brands may make up to 3000 API requests per minute across all of its API calls.
|
|
@@ -7297,11 +7832,12 @@ export interface GetConnectorConfig {
|
|
|
7297
7832
|
* - Service `confluentCloud`: API Secret
|
|
7298
7833
|
* - Service `forjCommunity`: Your Forj Community API secret.
|
|
7299
7834
|
* - Service `friendbuy`: Your Friendbuy API secret.
|
|
7300
|
-
* - Service `justcall`: Your JustCall API
|
|
7835
|
+
* - Service `justcall`: Your JustCall API secret.
|
|
7301
7836
|
* - Service `liftoff`: Your Liftoff API secret.
|
|
7302
7837
|
* - Service `mixpanel`: Mixpanel API Secret.
|
|
7303
7838
|
* - Service `qualaroo`: Your Qualaroo API Secret.
|
|
7304
7839
|
* - Service `sailthru`: The Sailthru API secret.
|
|
7840
|
+
* - Service `shareasale`: Your ShareASale API secret.
|
|
7305
7841
|
* - Service `vonage`: Your Vonage API Secret.
|
|
7306
7842
|
*/
|
|
7307
7843
|
apiSecret: string;
|
|
@@ -7321,12 +7857,14 @@ export interface GetConnectorConfig {
|
|
|
7321
7857
|
* - Service `aircall`: Your Aircall API Token.
|
|
7322
7858
|
* - Service `appsflyer`: API Token for AppsFlyer's PULL API.
|
|
7323
7859
|
* - Service `awin`: Your Awin API Token.
|
|
7860
|
+
* - Service `backbonePlm`: Your Backbone PLM API token.
|
|
7324
7861
|
* - Service `brex`: Your Brex API token
|
|
7325
7862
|
* - Service `buildkite`: Your Buildkite API token.
|
|
7326
7863
|
* - Service `buzzsprout`: Your Buzzsprout API token.
|
|
7327
|
-
* - Service `centra`: Your Centra API
|
|
7864
|
+
* - Service `centra`: Your Centra API token.
|
|
7328
7865
|
* - Service `chameleon`: Your Chameleon API token.
|
|
7329
7866
|
* - Service `clari`: Your Clari API token.
|
|
7867
|
+
* - Service `cloudflareAnalytics`: Your Cloudflare Analytics API token.
|
|
7330
7868
|
* - Service `confluence`: The Confluence API token.
|
|
7331
7869
|
* - Service `dixa`: Your Dixa API token.
|
|
7332
7870
|
* - Service `drip`: Your Drip API Token.
|
|
@@ -7345,6 +7883,7 @@ export interface GetConnectorConfig {
|
|
|
7345
7883
|
* - Service `mixmax`: Mixmax API token.
|
|
7346
7884
|
* - Service `okta`: Your Okta API token.
|
|
7347
7885
|
* - Service `ordway`: Your Ordway API token.
|
|
7886
|
+
* - Service `packiyo`: Your Packiyo API token.
|
|
7348
7887
|
* - Service `pipedrive`: (Optional)Your Pipedrive personal API token
|
|
7349
7888
|
* - Service `pivotalTracker`: Pivotal Tracker API token.
|
|
7350
7889
|
* - Service `postmark`: Your Postmark account API token.
|
|
@@ -7355,9 +7894,11 @@ export interface GetConnectorConfig {
|
|
|
7355
7894
|
* - Service `referralhero`: Your Referralhero API token.
|
|
7356
7895
|
* - Service `resourceManagementBySmartsheet`: Your Resource Management by Smartsheet API token.
|
|
7357
7896
|
* - Service `retently`: Your Retently API token.
|
|
7897
|
+
* - Service `reviewsai`: Your REVIEWS.ai API token.
|
|
7358
7898
|
* - Service `rundeck`: Your Rundeck API token.
|
|
7359
7899
|
* - Service `safetyculture`: Your SafetyCulture API token.
|
|
7360
7900
|
* - Service `sensorTower`: Your Sensor Tower API token.
|
|
7901
|
+
* - Service `sentry`: Your Sentry auth token.
|
|
7361
7902
|
* - Service `simplecast`: Your Simplecast API token.
|
|
7362
7903
|
* - Service `snyk`: Your Snyk API token.
|
|
7363
7904
|
* - Service `textus`: Your TextUs API token.
|
|
@@ -7376,6 +7917,11 @@ export interface GetConnectorConfig {
|
|
|
7376
7917
|
* - Service `braze`: Your Braze API URL.
|
|
7377
7918
|
*/
|
|
7378
7919
|
apiUrl: string;
|
|
7920
|
+
/**
|
|
7921
|
+
* Field usage depends on `service` value:
|
|
7922
|
+
* - Service `amazonDsp`: Your Amazon DSP API URL region.
|
|
7923
|
+
*/
|
|
7924
|
+
apiUrlRegion: string;
|
|
7379
7925
|
/**
|
|
7380
7926
|
* Field usage depends on `service` value:
|
|
7381
7927
|
* - Service `zendesk`: Maximum Zendesk Api Usage allowed
|
|
@@ -7405,6 +7951,7 @@ export interface GetConnectorConfig {
|
|
|
7405
7951
|
* Field usage depends on `service` value:
|
|
7406
7952
|
* - Service `churnkey`: Your Churnkey APP ID.
|
|
7407
7953
|
* - Service `openExchangeRates`: Your Open Exchange Rates App Id.
|
|
7954
|
+
* - Service `rokt`: Your Rokt app ID.
|
|
7408
7955
|
*/
|
|
7409
7956
|
appId: string;
|
|
7410
7957
|
/**
|
|
@@ -7429,6 +7976,11 @@ export interface GetConnectorConfig {
|
|
|
7429
7976
|
* - Service `brightpearl`: Your Brightpearl app reference.
|
|
7430
7977
|
*/
|
|
7431
7978
|
appReference: string;
|
|
7979
|
+
/**
|
|
7980
|
+
* Field usage depends on `service` value:
|
|
7981
|
+
* - Service `rokt`: Your Rokt app secret.
|
|
7982
|
+
*/
|
|
7983
|
+
appSecret: string;
|
|
7432
7984
|
appSecretToken: string;
|
|
7433
7985
|
/**
|
|
7434
7986
|
* Field usage depends on `service` value:
|
|
@@ -7459,6 +8011,7 @@ export interface GetConnectorConfig {
|
|
|
7459
8011
|
/**
|
|
7460
8012
|
* Field usage depends on `service` value:
|
|
7461
8013
|
* - Service `algolia`: Your Algolia application ID.
|
|
8014
|
+
* - Service `xactly`: Your Xactly Application ID.
|
|
7462
8015
|
*/
|
|
7463
8016
|
applicationId: string;
|
|
7464
8017
|
/**
|
|
@@ -7560,6 +8113,7 @@ export interface GetConnectorConfig {
|
|
|
7560
8113
|
audience: string;
|
|
7561
8114
|
/**
|
|
7562
8115
|
* Field usage depends on `service` value:
|
|
8116
|
+
* - Service `databricksDb`: Token-based authentication type
|
|
7563
8117
|
* - Service `redshiftDb`: Password-based authentication type
|
|
7564
8118
|
* - Service `snowflakeDb`: Password-based or key-based authentication type
|
|
7565
8119
|
*/
|
|
@@ -7576,8 +8130,16 @@ export interface GetConnectorConfig {
|
|
|
7576
8130
|
authEnvironment: string;
|
|
7577
8131
|
/**
|
|
7578
8132
|
* Field usage depends on `service` value:
|
|
8133
|
+
* - Service `auroraPostgres`: Database authentication method
|
|
8134
|
+
* - Service `azurePostgres`: Database authentication method
|
|
7579
8135
|
* - Service `azureSqlDb`: Authentication Method.
|
|
7580
8136
|
* - Service `azureSqlManagedDb`: Authentication Method.
|
|
8137
|
+
* - Service `googleCloudPostgresql`: Database authentication method
|
|
8138
|
+
* - Service `herokuPostgres`: Database authentication method
|
|
8139
|
+
* - Service `postgres`: Database authentication method
|
|
8140
|
+
* - Service `postgresRds`: Database authentication method
|
|
8141
|
+
* - Service `sqlServerHva`: Authentication Method
|
|
8142
|
+
* - Service `sqlServerSapEccHva`: Authentication Method
|
|
7581
8143
|
* - Service `webhooks`: The authentication mechanism you want to use
|
|
7582
8144
|
*/
|
|
7583
8145
|
authMethod: string;
|
|
@@ -7609,6 +8171,11 @@ export interface GetConnectorConfig {
|
|
|
7609
8171
|
* - Service `wasabiCloudStorage`: The Wasabi Cloud Storage Access approach. Required for connector creation. Default value: `ACCESS_KEY`.
|
|
7610
8172
|
*/
|
|
7611
8173
|
authType: string;
|
|
8174
|
+
/**
|
|
8175
|
+
* Field usage depends on `service` value:
|
|
8176
|
+
* - Service `amazonDsp`: Your Amazon DSP auth grant URL region.
|
|
8177
|
+
*/
|
|
8178
|
+
authUrlRegion: string;
|
|
7612
8179
|
/**
|
|
7613
8180
|
* Field usage depends on `service` value:
|
|
7614
8181
|
* - Service `adobeAnalytics`: Authentication Method
|
|
@@ -7616,6 +8183,11 @@ export interface GetConnectorConfig {
|
|
|
7616
8183
|
* - Service `esSelfHosted`: The authentication method used to connect to your cluster.
|
|
7617
8184
|
* - Service `opendistro`: The authentication method used to connect to your cluster.
|
|
7618
8185
|
* - Service `opensearch`: The authentication method used to connect to your cluster.
|
|
8186
|
+
* - Service `oracleFusionCloudAppsCrm`: The Oracle Fusion Cloud authentication method.
|
|
8187
|
+
* - Service `oracleFusionCloudAppsFscm`: The Oracle Fusion Cloud authentication method.
|
|
8188
|
+
* - Service `oracleFusionCloudAppsHcm`: The Oracle Fusion Cloud authentication method.
|
|
8189
|
+
* - Service `salesforce`: (Optional) Authentication type (default value = `STANDARD`)
|
|
8190
|
+
* - Service `salesforceSandbox`: (Optional) Authentication type (default value = `STANDARD`)
|
|
7619
8191
|
*/
|
|
7620
8192
|
authenticationMethod: string;
|
|
7621
8193
|
authorizationMethod: string;
|
|
@@ -7626,6 +8198,11 @@ export interface GetConnectorConfig {
|
|
|
7626
8198
|
awsRegionCode: string;
|
|
7627
8199
|
backintConfigurationPath: string;
|
|
7628
8200
|
backintExecutablePath: string;
|
|
8201
|
+
/**
|
|
8202
|
+
* Field usage depends on `service` value:
|
|
8203
|
+
* - Service `zendesk`: Limit of the Historical Sync Time for selected tables
|
|
8204
|
+
*/
|
|
8205
|
+
backwardSyncLimit: string;
|
|
7629
8206
|
/**
|
|
7630
8207
|
* Field usage depends on `service` value:
|
|
7631
8208
|
* - Service `openExchangeRates`: Your Open Exchange Rates Base Currency.
|
|
@@ -7644,21 +8221,28 @@ export interface GetConnectorConfig {
|
|
|
7644
8221
|
/**
|
|
7645
8222
|
* Field usage depends on `service` value:
|
|
7646
8223
|
* - Service `aha`: Your Aha! subdomain.
|
|
8224
|
+
* - Service `akeneo`: Your Akeneo base URL.
|
|
7647
8225
|
* - Service `billingPlatform`: Your BillingPlatform subdomain.
|
|
7648
8226
|
* - Service `boostr`: Your Boostr base URL.
|
|
7649
8227
|
* - Service `brex`: Your Brex Base URL
|
|
7650
|
-
* - Service `centra`: Your Centra
|
|
8228
|
+
* - Service `centra`: Your Centra base URL.
|
|
8229
|
+
* - Service `cornerstone`: Your Cornerstone base URL.
|
|
7651
8230
|
* - Service `cultureAmp`: Your Culture Amp base URL.
|
|
8231
|
+
* - Service `datadog`: Your Datadog base url.
|
|
8232
|
+
* - Service `factbird`: Your Factbird base url.
|
|
8233
|
+
* - Service `fillout`: Your Fillout Base URL.
|
|
7652
8234
|
* - Service `financialForce`: (Optional) The custom Salesforce domain. Make sure that the `baseUrl` starts with `https://`.
|
|
7653
8235
|
* - Service `freshsales`: Your Freshsales product.
|
|
7654
8236
|
* - Service `gongio`: Your Gong API Base URL.
|
|
7655
8237
|
* - Service `ironclad`: Your Ironclad base url.
|
|
7656
8238
|
* - Service `jotform`: Your Jotform base URL.
|
|
7657
8239
|
* - Service `mailgun`: Your Mailgun base URL.
|
|
8240
|
+
* - Service `nice`: Your NICE base URL.
|
|
7658
8241
|
* - Service `ortto`: Your Ortto base URL. Possible values: `api`, `api.au`, `api.eu`.
|
|
7659
8242
|
* - Service `prismaCloud`: Your Prisma Cloud admin console URL.
|
|
7660
8243
|
* - Service `salesforce`: (Optional) The custom Salesforce domain. Make sure that the `baseUrl` starts with `https://`.
|
|
7661
8244
|
* - Service `salesforceSandbox`: (Optional) The custom Salesforce domain. Make sure that the `baseUrl` starts with `https://`.
|
|
8245
|
+
* - Service `stickyio`: Your sticky.io base URL .
|
|
7662
8246
|
* - Service `veevavault`: Your Veeva Vault base URL.
|
|
7663
8247
|
* - Service `vitally`: Your Vitally base URL.
|
|
7664
8248
|
*/
|
|
@@ -7736,6 +8320,11 @@ export interface GetConnectorConfig {
|
|
|
7736
8320
|
* - Service `birdeye`: Your Birdeye Business ID.
|
|
7737
8321
|
*/
|
|
7738
8322
|
businessId: string;
|
|
8323
|
+
/**
|
|
8324
|
+
* Field usage depends on `service` value:
|
|
8325
|
+
* - Service `deposco`: Your Deposco business unit.
|
|
8326
|
+
*/
|
|
8327
|
+
businessUnit: string;
|
|
7739
8328
|
/**
|
|
7740
8329
|
* Field usage depends on `service` value:
|
|
7741
8330
|
* - Service `pardot`: Business Unit Id
|
|
@@ -7750,6 +8339,8 @@ export interface GetConnectorConfig {
|
|
|
7750
8339
|
* Field usage depends on `service` value:
|
|
7751
8340
|
* - Service `anaplan`: The contents of your PEM certificate file. Must be populated if `authMode` is set to `Certificate`.
|
|
7752
8341
|
* - Service `qualtrics`: Your Client Certificate
|
|
8342
|
+
* - Service `salesforce`: Provide content of the `.pem` certificate (only when authenticationMethod = `ADVANCED`).
|
|
8343
|
+
* - Service `salesforceSandbox`: Provide content of the `.pem` certificate (only when authenticationMethod = `ADVANCED`).
|
|
7753
8344
|
*/
|
|
7754
8345
|
certificate: string;
|
|
7755
8346
|
/**
|
|
@@ -7783,37 +8374,55 @@ export interface GetConnectorConfig {
|
|
|
7783
8374
|
* - Service `adobeWorkfront`: Your Adobe Workfront client ID.
|
|
7784
8375
|
* - Service `adpWorkforceNow`: Your ADP Client ID.
|
|
7785
8376
|
* - Service `akamai`: Your Akamai client ID.
|
|
8377
|
+
* - Service `akeneo`: Your Akeneo client ID.
|
|
7786
8378
|
* - Service `auth0`: Your Auth0 client ID.
|
|
8379
|
+
* - Service `autodeskBim360`: Your Autodesk BIM 360 client ID.
|
|
8380
|
+
* - Service `biginByZohoCrm`: Your Bigin by Zoho CRM Client Id
|
|
7787
8381
|
* - Service `billingPlatform`: Your BillingPlatform client ID.
|
|
8382
|
+
* - Service `bingWebmasterTools`: Your Bing Webmaster Tools client ID.
|
|
7788
8383
|
* - Service `brightcove`: Your Brightcove client ID.
|
|
7789
|
-
* - Service `brightpearl`: Your Brightpearl client
|
|
8384
|
+
* - Service `brightpearl`: Your Brightpearl client ID.
|
|
7790
8385
|
* - Service `buildium`: Your Buildium API client ID.
|
|
7791
8386
|
* - Service `canvasByInstructure`: Your Canvas by Instructure client ID.
|
|
8387
|
+
* - Service `canvasData2ByInstructure`: Your Canvas Data 2 by Instructure client ID.
|
|
7792
8388
|
* - Service `castorEdc`: Your Castor EDC client Id.
|
|
8389
|
+
* - Service `clazar`: Your Clazar client ID.
|
|
8390
|
+
* - Service `cloudbeds`: Your Cloudbeds client ID.
|
|
7793
8391
|
* - Service `commercetools`: Your commercetools client ID.
|
|
7794
8392
|
* - Service `concur`: The SAP Concur Client ID.
|
|
8393
|
+
* - Service `constantContact`: Your Constant Contact client ID.
|
|
8394
|
+
* - Service `cornerstone`: Your Cornerstone client ID.
|
|
7795
8395
|
* - Service `coupa`: Your Coupa clientId
|
|
7796
8396
|
* - Service `criteo`: Your Criteo Client ID.
|
|
7797
8397
|
* - Service `criteoRetailMedia`: Your Criteo Retail Media client ID.
|
|
7798
8398
|
* - Service `cultureAmp`: Your Culture Amp client ID.
|
|
7799
8399
|
* - Service `cvent`: Your Cvent client ID.
|
|
7800
8400
|
* - Service `d2lBrightspace`: Your D2L Brightspace client ID.
|
|
8401
|
+
* - Service `dialpad`: Your Dialpad client ID.
|
|
7801
8402
|
* - Service `ebay`: Your eBay app ID.
|
|
7802
8403
|
* - Service `exactOnline`: Your Exact Online client ID.
|
|
8404
|
+
* - Service `fillout`: Your Fillout client ID.
|
|
7803
8405
|
* - Service `flexport`: The Flexport API Key.
|
|
8406
|
+
* - Service `formstack`: Your Formstack client ID.
|
|
7804
8407
|
* - Service `genesys`: Your Genesys client ID.
|
|
7805
8408
|
* - Service `hanaSapHvaEccNetweaver`: Three-digit (000-999) identifier of the SAP client, which is sent to an AS ABAP upon logon.
|
|
7806
8409
|
* - Service `hanaSapHvaS4Netweaver`: Three-digit (000-999) identifier of the SAP client, which is sent to an AS ABAP upon logon.
|
|
8410
|
+
* - Service `hiltiOntrack`: Your Hilti On!Track client ID.
|
|
7807
8411
|
* - Service `ilevel`: Your iLevel Client ID.
|
|
7808
8412
|
* - Service `instructure`: Your Instructure client ID.
|
|
7809
8413
|
* - Service `integralAdScience`: Your integralAdScience client id.
|
|
8414
|
+
* - Service `ironclad`: Your Ironclad client ID.
|
|
7810
8415
|
* - Service `jamaSoftware`: Your Jama Software client ID.
|
|
8416
|
+
* - Service `jibble`: Your Jibble client ID.
|
|
8417
|
+
* - Service `khorosCommunities`: Your Khoros Communities client ID.
|
|
7811
8418
|
* - Service `lookerSource`: Your Looker Client ID.
|
|
7812
8419
|
* - Service `marketo`: Marketo REST API Client Id.
|
|
7813
8420
|
* - Service `medallia`: Medallia Client ID
|
|
7814
8421
|
* - Service `microsoftEntraId`: Your Microsoft Entra ID Client ID.
|
|
8422
|
+
* - Service `microsoftPowerBi`: Your Microsoft Power BI client ID.
|
|
7815
8423
|
* - Service `microsoftTeams`: Your Microsoft Teams Client ID.
|
|
7816
8424
|
* - Service `navan`: Your Navan client ID.
|
|
8425
|
+
* - Service `nice`: Your NICE client ID.
|
|
7817
8426
|
* - Service `on24`: Your ON24 client ID.
|
|
7818
8427
|
* - Service `oracleSapHvaNetweaver`: Three-digit (000-999) identifier of the SAP client, which is sent to an AS ABAP upon logon.
|
|
7819
8428
|
* - Service `paychex`: Your Paychex client ID.
|
|
@@ -7830,6 +8439,7 @@ export interface GetConnectorConfig {
|
|
|
7830
8439
|
* - Service `salesforceCommerceCloud`: The Salesforce Commerce Cloud Client ID.
|
|
7831
8440
|
* - Service `salesforceMarketingCloud`: The Salesforce Marketing Cloud client ID.
|
|
7832
8441
|
* - Service `salesloft`: `Client ID` of your Salesloft client application.
|
|
8442
|
+
* - Service `sana`: Your Sana client ID.
|
|
7833
8443
|
* - Service `sapSuccessFactors`: Your SAP SuccessFactors Client ID.
|
|
7834
8444
|
* - Service `servicenow`: ServiceNow Client ID.
|
|
7835
8445
|
* - Service `servicetitan`: Your ServiceTitan client ID.
|
|
@@ -7837,17 +8447,22 @@ export interface GetConnectorConfig {
|
|
|
7837
8447
|
* - Service `shipnetwork`: Your ShipNetwork client ID.
|
|
7838
8448
|
* - Service `sigmaComputingSource`: Your Sigma Computing client ID.
|
|
7839
8449
|
* - Service `skillstx`: Your SkillsTX client ID.
|
|
8450
|
+
* - Service `skimlinks`: Your Skimlinks client ID.
|
|
7840
8451
|
* - Service `smartrecruiters`: Your SmartRecruiters client ID.
|
|
7841
8452
|
* - Service `splash`: Your Splash client ID.
|
|
7842
8453
|
* - Service `square`: The Application ID of your organization.
|
|
7843
8454
|
* - Service `standardMetrics`: Your Standard Metrics Client ID.
|
|
8455
|
+
* - Service `sugarcrm`: Your SugarCRM client ID.
|
|
7844
8456
|
* - Service `swoogo`: Your Swoogo client Id.
|
|
7845
8457
|
* - Service `taboola`: The Taboola client ID.
|
|
7846
8458
|
* - Service `talkdesk`: The Client ID of your OAuth Client
|
|
8459
|
+
* - Service `tive`: Your Tive client ID.
|
|
7847
8460
|
* - Service `toast`: Your Toast client ID.
|
|
7848
8461
|
* - Service `trelica`: Your Trelica client ID.
|
|
8462
|
+
* - Service `tremendous`: Your Tremendous client ID.
|
|
7849
8463
|
* - Service `tymeshift`: Your Tymeshift email.
|
|
7850
8464
|
* - Service `udemyBusiness`: Your Udemy Business client ID.
|
|
8465
|
+
* - Service `vimeo`: Your Vimeo client ID.
|
|
7851
8466
|
* - Service `visma`: Your Visma client ID.
|
|
7852
8467
|
* - Service `vonageContactCenter`: Your Vonage Contact Center client ID.
|
|
7853
8468
|
* - Service `walmartMarketplace`: Your Walmart Marketplace client ID.
|
|
@@ -7908,34 +8523,50 @@ export interface GetConnectorConfig {
|
|
|
7908
8523
|
* - Service `adobeWorkfront`: Your Adobe Workfront client secret.
|
|
7909
8524
|
* - Service `adpWorkforceNow`: Your ADP Client Secret.
|
|
7910
8525
|
* - Service `akamai`: Your Akamai client secret.
|
|
7911
|
-
* - Service `
|
|
8526
|
+
* - Service `akeneo`: Your Akeneo client secret.
|
|
8527
|
+
* - Service `auth0`: Your Auth0 client secret.
|
|
8528
|
+
* - Service `autodeskBim360`: Your Autodesk BIM 360 client secret.
|
|
8529
|
+
* - Service `biginByZohoCrm`: Your Bigin by Zoho CRM Client Secret
|
|
7912
8530
|
* - Service `billingPlatform`: Your BillingPlatform client secret.
|
|
8531
|
+
* - Service `bingWebmasterTools`: Your Bing Webmaster Tools client secret.
|
|
7913
8532
|
* - Service `brightcove`: Your Brightcove client secret.
|
|
7914
8533
|
* - Service `brightpearl`: Your Brightpearl client secret.
|
|
7915
8534
|
* - Service `canvasByInstructure`: Your Canvas by Instructure client secret.
|
|
7916
8535
|
* - Service `castorEdc`: Your Castor EDC Client Secret.
|
|
8536
|
+
* - Service `clazar`: Your Clazar client secret.
|
|
8537
|
+
* - Service `cloudbeds`: Your Cloudbeds client secret.
|
|
7917
8538
|
* - Service `commercetools`: Your commercetools client secret.
|
|
7918
8539
|
* - Service `concur`: The SAP Concur Client secret.
|
|
8540
|
+
* - Service `constantContact`: Your Constant Contact client secret.
|
|
8541
|
+
* - Service `cornerstone`: Your Cornerstone client secret.
|
|
7919
8542
|
* - Service `coupa`: Your Coupa clientId
|
|
7920
8543
|
* - Service `criteo`: Your Criteo client secret key.
|
|
7921
|
-
* - Service `criteoRetailMedia`: Your Criteo Retail Media client
|
|
8544
|
+
* - Service `criteoRetailMedia`: Your Criteo Retail Media client secret.
|
|
7922
8545
|
* - Service `cultureAmp`: Your Culture Amp client secret.
|
|
7923
8546
|
* - Service `cvent`: Your Cvent client secret.
|
|
7924
8547
|
* - Service `d2lBrightspace`: Your D2L Brightspace client secret.
|
|
8548
|
+
* - Service `dialpad`: Your Dialpad client secret.
|
|
7925
8549
|
* - Service `ebay`: Your eBay cert ID.
|
|
7926
8550
|
* - Service `exactOnline`: Your Exact Online client secret.
|
|
8551
|
+
* - Service `fillout`: Your Fillout client secret
|
|
7927
8552
|
* - Service `flexport`: The Flexport API Secret.
|
|
8553
|
+
* - Service `formstack`: Your Formstack client secret.
|
|
7928
8554
|
* - Service `genesys`: Your Genesys client secret.
|
|
8555
|
+
* - Service `hiltiOntrack`: Your Hilti On!Track client secret.
|
|
7929
8556
|
* - Service `ilevel`: Your iLevel Client Secret.
|
|
7930
8557
|
* - Service `instructure`: Your Instructure client secret.
|
|
7931
8558
|
* - Service `integralAdScience`: Your integralAdScience client secret.
|
|
8559
|
+
* - Service `ironclad`: Your Ironclad client secret.
|
|
7932
8560
|
* - Service `jamaSoftware`: Your Jama Software client secret.
|
|
8561
|
+
* - Service `jibble`: Your Jibble client secret.
|
|
7933
8562
|
* - Service `lookerSource`: Your Looker Client Secret.
|
|
7934
8563
|
* - Service `marketo`: Marketo REST API Client Secret.
|
|
7935
8564
|
* - Service `medallia`: Medallia Client Secret key
|
|
7936
8565
|
* - Service `microsoftEntraId`: Your Microsoft Entra ID Client Secret.
|
|
8566
|
+
* - Service `microsoftPowerBi`: Your Microsoft Power BI client secret.
|
|
7937
8567
|
* - Service `microsoftTeams`: Your Microsoft Teams Client Secret.
|
|
7938
8568
|
* - Service `navan`: Your Navan client secret.
|
|
8569
|
+
* - Service `nice`: Your NICE client secret.
|
|
7939
8570
|
* - Service `paychex`: Your Paychex client secret.
|
|
7940
8571
|
* - Service `personio`: Your Personio secret.
|
|
7941
8572
|
* - Service `piwikPro`: Your Piwik PRO client secret.
|
|
@@ -7948,24 +8579,30 @@ export interface GetConnectorConfig {
|
|
|
7948
8579
|
* - Service `salesforceCommerceCloud`: The Salesforce Commerce Cloud Client secret.
|
|
7949
8580
|
* - Service `salesforceMarketingCloud`: The Salesforce Marketing Cloud client secret.
|
|
7950
8581
|
* - Service `salesloft`: `Client Secret` of your Salesloft client application.
|
|
8582
|
+
* - Service `sana`: Your Sana client secret.
|
|
7951
8583
|
* - Service `sapSuccessFactors`: Your SAP SuccessFactors Client Secret that you generated through SAML Assertion.
|
|
7952
8584
|
* - Service `servicenow`: ServiceNow Client Secret.
|
|
7953
8585
|
* - Service `servicetitan`: Your ServiceTitan secret key.
|
|
7954
8586
|
* - Service `sharetribe`: Your Sharetribe client secret.
|
|
7955
8587
|
* - Service `sigmaComputingSource`: Your Sigma Computing client secret.
|
|
7956
8588
|
* - Service `skillstx`: Your SkillsTX client secret.
|
|
8589
|
+
* - Service `skimlinks`: Your Skimlinks client secret.
|
|
7957
8590
|
* - Service `smartrecruiters`: Your SmartRecruiters client secret.
|
|
7958
8591
|
* - Service `splash`: Your Splash client secret.
|
|
7959
8592
|
* - Service `square`: The Application Secret of your organization.
|
|
7960
8593
|
* - Service `standardMetrics`: Your Standard Metrics Client secret.
|
|
8594
|
+
* - Service `sugarcrm`: Your SugarCRM client secret.
|
|
7961
8595
|
* - Service `swoogo`: Your Swoogo Client Secret.
|
|
7962
8596
|
* - Service `taboola`: The Taboola client secret.
|
|
7963
8597
|
* - Service `talkdesk`: The Client Secret of your OAuth Client
|
|
7964
8598
|
* - Service `thinkific`: Your Thinkific client secret.
|
|
8599
|
+
* - Service `tive`: Your Tive client secret.
|
|
7965
8600
|
* - Service `toast`: Your Toast client secret.
|
|
7966
8601
|
* - Service `trelica`: Your Trelica client secret.
|
|
8602
|
+
* - Service `tremendous`: Your Tremendous client secret.
|
|
7967
8603
|
* - Service `tymeshift`: Your Tymeshift password.
|
|
7968
8604
|
* - Service `udemyBusiness`: Your Udemy Business client secret.
|
|
8605
|
+
* - Service `vimeo`: Your Vimeo client secret.
|
|
7969
8606
|
* - Service `visma`: Your Visma client secret.
|
|
7970
8607
|
* - Service `vonageContactCenter`: Your Vonage Contact Center client secret.
|
|
7971
8608
|
* - Service `walmartMarketplace`: Your Walmart Marketplace client secret.
|
|
@@ -7995,6 +8632,16 @@ export interface GetConnectorConfig {
|
|
|
7995
8632
|
* - Service `doubleClickPublishers`: Columns provide all trafficking statistics and revenue information available for the chosen Dimensions.
|
|
7996
8633
|
*/
|
|
7997
8634
|
columns: string[];
|
|
8635
|
+
/**
|
|
8636
|
+
* Field usage depends on `service` value:
|
|
8637
|
+
* - Service `khorosCommunities`: Your Khoros Communities community domain.
|
|
8638
|
+
*/
|
|
8639
|
+
communityDomain: string;
|
|
8640
|
+
/**
|
|
8641
|
+
* Field usage depends on `service` value:
|
|
8642
|
+
* - Service `khorosCommunities`: Your Khoros Communities community ID.
|
|
8643
|
+
*/
|
|
8644
|
+
communityId: string;
|
|
7998
8645
|
/**
|
|
7999
8646
|
* Field usage depends on `service` value:
|
|
8000
8647
|
* - Service `businessCentral`: List of companies to sync
|
|
@@ -8023,6 +8670,11 @@ export interface GetConnectorConfig {
|
|
|
8023
8670
|
* - Service `upland`: Your Upland Software Company Key.
|
|
8024
8671
|
*/
|
|
8025
8672
|
companyKey: string;
|
|
8673
|
+
/**
|
|
8674
|
+
* Field usage depends on `service` value:
|
|
8675
|
+
* - Service `clockodo`: Your Clockodo company name.
|
|
8676
|
+
*/
|
|
8677
|
+
companyName: string;
|
|
8026
8678
|
/**
|
|
8027
8679
|
* Field usage depends on `service` value:
|
|
8028
8680
|
* - Service `concur`: The SAP Concur Company Request Token
|
|
@@ -8066,6 +8718,16 @@ export interface GetConnectorConfig {
|
|
|
8066
8718
|
* - Service `googleAnalytics`: Whether to use the [Prebuilt Reports or Custom Reports](https://fivetran.com/docs/connectors/applications/google-analytics#schemainformation).
|
|
8067
8719
|
*/
|
|
8068
8720
|
configType: string;
|
|
8721
|
+
/**
|
|
8722
|
+
* Field usage depends on `service` value:
|
|
8723
|
+
* - Service `xactly`: Your Xactly Connect password.
|
|
8724
|
+
*/
|
|
8725
|
+
connectPassword: string;
|
|
8726
|
+
/**
|
|
8727
|
+
* Field usage depends on `service` value:
|
|
8728
|
+
* - Service `xactly`: Your Xactly Connect username.
|
|
8729
|
+
*/
|
|
8730
|
+
connectUsername: string;
|
|
8069
8731
|
connectingUser: string;
|
|
8070
8732
|
connectingUserEmail: string;
|
|
8071
8733
|
/**
|
|
@@ -8177,6 +8839,11 @@ export interface GetConnectorConfig {
|
|
|
8177
8839
|
* - Service `woocommerce`: Your WooCommerce Consumer key.
|
|
8178
8840
|
*/
|
|
8179
8841
|
consumerKey: string;
|
|
8842
|
+
/**
|
|
8843
|
+
* Field usage depends on `service` value:
|
|
8844
|
+
* - Service `xactly`: Your Xactly Connect consumer name.
|
|
8845
|
+
*/
|
|
8846
|
+
consumerName: string;
|
|
8180
8847
|
/**
|
|
8181
8848
|
* Field usage depends on `service` value:
|
|
8182
8849
|
* - Service `netsuiteSuiteanalytics`: Consumer Secret
|
|
@@ -8202,6 +8869,11 @@ export interface GetConnectorConfig {
|
|
|
8202
8869
|
* - Service `youtubeAnalytics`: Used only for Content Owner reports. The ID of the content owner for whom the API request is being made.
|
|
8203
8870
|
*/
|
|
8204
8871
|
contentOwnerId: string;
|
|
8872
|
+
/**
|
|
8873
|
+
* Field usage depends on `service` value:
|
|
8874
|
+
* - Service `acumatica`: Your Acumatica contract version.
|
|
8875
|
+
*/
|
|
8876
|
+
contractVersion: string;
|
|
8205
8877
|
/**
|
|
8206
8878
|
* Field usage depends on `service` value:
|
|
8207
8879
|
* - Service `helpscout`: Your conversation webhook URL
|
|
@@ -8231,8 +8903,15 @@ export interface GetConnectorConfig {
|
|
|
8231
8903
|
/**
|
|
8232
8904
|
* Field usage depends on `service` value:
|
|
8233
8905
|
* - Service `criteo`: Currency
|
|
8906
|
+
* - Service `rokt`: Your Rokt currency.
|
|
8234
8907
|
*/
|
|
8235
8908
|
currency: string;
|
|
8909
|
+
/**
|
|
8910
|
+
* Field usage depends on `service` value:
|
|
8911
|
+
* - Service `datadog`: Your Datadog custom base url.
|
|
8912
|
+
* - Service `deposco`: Your Deposco custom base URL.
|
|
8913
|
+
*/
|
|
8914
|
+
customBaseUrl: string;
|
|
8236
8915
|
/**
|
|
8237
8916
|
* Field usage depends on `service` value:
|
|
8238
8917
|
* - Service `iterable`: Custom Events Sync Mode.
|
|
@@ -8275,6 +8954,7 @@ export interface GetConnectorConfig {
|
|
|
8275
8954
|
/**
|
|
8276
8955
|
* Field usage depends on `service` value:
|
|
8277
8956
|
* - Service `dbtCloud`: Your dbt Cloud access url.
|
|
8957
|
+
* - Service `factbird`: Your Factbird custom base url.
|
|
8278
8958
|
* - Service `jotform`: Your Jotform custom base URL.
|
|
8279
8959
|
*/
|
|
8280
8960
|
customUrl: string;
|
|
@@ -8320,6 +9000,7 @@ export interface GetConnectorConfig {
|
|
|
8320
9000
|
* Field usage depends on `service` value:
|
|
8321
9001
|
* - Service `aurora`: The database name.
|
|
8322
9002
|
* - Service `auroraPostgres`: The database name.
|
|
9003
|
+
* - Service `azureCosmosForMongo`: Authentication database for the source. Usually 'admin'.
|
|
8323
9004
|
* - Service `azurePostgres`: The database name.
|
|
8324
9005
|
* - Service `azureSqlDb`: The database name.
|
|
8325
9006
|
* - Service `azureSqlManagedDb`: The database name.
|
|
@@ -8409,7 +9090,7 @@ export interface GetConnectorConfig {
|
|
|
8409
9090
|
delimiter: string;
|
|
8410
9091
|
/**
|
|
8411
9092
|
* Field usage depends on `service` value:
|
|
8412
|
-
* - Service `brightpearl`: Your Brightpearl
|
|
9093
|
+
* - Service `brightpearl`: Your Brightpearl dev reference.
|
|
8413
9094
|
*/
|
|
8414
9095
|
developerReference: string;
|
|
8415
9096
|
/**
|
|
@@ -8480,6 +9161,7 @@ export interface GetConnectorConfig {
|
|
|
8480
9161
|
* - Service `mailchimp`: List of IDs of the Mailchimp E-Commerce Stores to Sync
|
|
8481
9162
|
*/
|
|
8482
9163
|
ecommerceStores: string[];
|
|
9164
|
+
edition: string;
|
|
8483
9165
|
elements: string[];
|
|
8484
9166
|
/**
|
|
8485
9167
|
* Field usage depends on `service` value:
|
|
@@ -8496,6 +9178,11 @@ export interface GetConnectorConfig {
|
|
|
8496
9178
|
* - Service `zendeskSunshine`: Zendesk email.
|
|
8497
9179
|
*/
|
|
8498
9180
|
email: string;
|
|
9181
|
+
/**
|
|
9182
|
+
* Field usage depends on `service` value:
|
|
9183
|
+
* - Service `clockodo`: Your Clockodo email address.
|
|
9184
|
+
*/
|
|
9185
|
+
emailAddress: string;
|
|
8499
9186
|
/**
|
|
8500
9187
|
* Field usage depends on `service` value:
|
|
8501
9188
|
* - Service `ordway`: Your Ordway user email ID.
|
|
@@ -8591,22 +9278,33 @@ export interface GetConnectorConfig {
|
|
|
8591
9278
|
entityId: string;
|
|
8592
9279
|
/**
|
|
8593
9280
|
* Field usage depends on `service` value:
|
|
8594
|
-
* - Service `bazaarvoice`: Your Bazaarvoice
|
|
9281
|
+
* - Service `bazaarvoice`: Your Bazaarvoice environment.
|
|
8595
9282
|
* - Service `buildium`: Your Buildium environment.
|
|
8596
9283
|
* - Service `checkout`: Your Checkout.com environment.
|
|
8597
9284
|
* - Service `concord`: Your Concord environment.
|
|
9285
|
+
* - Service `deposco`: Your Deposco environment.
|
|
9286
|
+
* - Service `dialpad`: Your Dialpad environment.
|
|
8598
9287
|
* - Service `invoiced`: Your Invoiced environment.
|
|
9288
|
+
* - Service `jibble`: Your Jibble environment.
|
|
9289
|
+
* - Service `lucca`: Your Lucca environment.
|
|
8599
9290
|
* - Service `procore`: Your Procore account environment.
|
|
8600
9291
|
* - Service `reltio`: Your Reltio environment.
|
|
8601
9292
|
* - Service `servicetitan`: Your ServiceTitan environment.
|
|
8602
9293
|
* - Service `smarthr`: Your SmartHR environment.
|
|
8603
9294
|
* - Service `trelica`: Your Trelica environment.
|
|
9295
|
+
* - Service `tremendous`: Your Tremendous environment.
|
|
8604
9296
|
* - Service `vts`: Your VTS environment.
|
|
9297
|
+
* - Service `xactly`: Your Xactly environment.
|
|
8605
9298
|
* - Service `younium`: Your Younium API environment.
|
|
8606
9299
|
* - Service `zuora`: Zuora Sandbox Environment. This accepts either of the two values Sandbox or Central Sandbox based on your subscription. The default environment is Sandbox.
|
|
8607
9300
|
* - Service `zuoraSandbox`: Zuora Sandbox Environment. This accepts either of the two values Sandbox or Central Sandbox based on your subscription. The default environment is Sandbox.
|
|
8608
9301
|
*/
|
|
8609
9302
|
environment: string;
|
|
9303
|
+
/**
|
|
9304
|
+
* Field usage depends on `service` value:
|
|
9305
|
+
* - Service `xactly`: Your Xactly environment host.
|
|
9306
|
+
*/
|
|
9307
|
+
environmentHost: string;
|
|
8610
9308
|
/**
|
|
8611
9309
|
* Field usage depends on `service` value:
|
|
8612
9310
|
* - Service `businessCentral`: Name of the environment
|
|
@@ -8803,6 +9501,11 @@ export interface GetConnectorConfig {
|
|
|
8803
9501
|
* - Service `workday`: Select this option to generate a Primary Key for reports where no single column or combination of columns can be used to form a Primary Key.
|
|
8804
9502
|
*/
|
|
8805
9503
|
generateFivetranPk: boolean;
|
|
9504
|
+
/**
|
|
9505
|
+
* Field usage depends on `service` value:
|
|
9506
|
+
* - Service `lineAds`: Your LINE Ads group ID(s).
|
|
9507
|
+
*/
|
|
9508
|
+
groupId: string;
|
|
8806
9509
|
/**
|
|
8807
9510
|
* Field usage depends on `service` value:
|
|
8808
9511
|
* - Service `fivetranLog`: (Optional) The group name of the `targetGroupId`.
|
|
@@ -8825,16 +9528,29 @@ export interface GetConnectorConfig {
|
|
|
8825
9528
|
hasManagePermissions: boolean;
|
|
8826
9529
|
/**
|
|
8827
9530
|
* Field usage depends on `service` value:
|
|
9531
|
+
* - Service `braze`: Range of data in history you would like to include in the initial sync.
|
|
9532
|
+
* - Service `iterable`: The time range for which historical data should be synced. Default value: `All Time`.
|
|
8828
9533
|
* - Service `klaviyo`: Range of data in history you would like to include in the initial sync. Default value: `ALL_TIME`.
|
|
8829
9534
|
* - Service `marketo`: Range of data in history you would like to include in the initial sync. Default value: `ALL_TIME`.
|
|
9535
|
+
* - Service `sailthru`: Range of historical data you would like to include in the initial sync. Default value: `ALL_TIME`.
|
|
8830
9536
|
* - Service `salesforceMarketingCloud`: Range of data in history you would like to include in the initial sync. Default value: `ALL_TIME`.
|
|
8831
9537
|
*/
|
|
8832
9538
|
historicSyncTimeFrame: string;
|
|
8833
9539
|
/**
|
|
8834
9540
|
* Field usage depends on `service` value:
|
|
9541
|
+
* - Service `concur`: Historical Sync Limit for the Sync
|
|
9542
|
+
* - Service `eloqua`: Range of data in history you would like to include in the initial sync. Default value: `ALL_TIME`.
|
|
8835
9543
|
* - Service `pardot`: The time range for which historical data should be synced. Default value: `All Time`.
|
|
8836
9544
|
*/
|
|
8837
9545
|
historicalSyncLimit: string;
|
|
9546
|
+
/**
|
|
9547
|
+
* Field usage depends on `service` value:
|
|
9548
|
+
* - Service `rokt`: Your Rokt historical sync time frame.
|
|
9549
|
+
* - Service `skimlinks`: Your Skimlinks Historical sync time frame.
|
|
9550
|
+
* - Service `vimeo`: Your Vimeo Historical sync time frame.
|
|
9551
|
+
* - Service `zendesk`: Used to configure Historical sync timeframe for selected tables
|
|
9552
|
+
*/
|
|
9553
|
+
historicalSyncTimeFrame: string;
|
|
8838
9554
|
/**
|
|
8839
9555
|
* Field usage depends on `service` value:
|
|
8840
9556
|
* - Service `appsflyer`: Your S3 home folder path of the Data Locker.
|
|
@@ -8946,7 +9662,7 @@ export interface GetConnectorConfig {
|
|
|
8946
9662
|
httpPath: string;
|
|
8947
9663
|
/**
|
|
8948
9664
|
* Field usage depends on `service` value:
|
|
8949
|
-
* - Service `playvoxWorkforceManagement`: Your Playvox Workforce Management
|
|
9665
|
+
* - Service `playvoxWorkforceManagement`: Your Playvox Workforce Management client identifier.
|
|
8950
9666
|
* - Service `statisticsNetherlandsCbs`: Your Statistics Netherlands CBS catalog identifier.
|
|
8951
9667
|
*/
|
|
8952
9668
|
identifier: string;
|
|
@@ -8964,6 +9680,7 @@ export interface GetConnectorConfig {
|
|
|
8964
9680
|
* Field usage depends on `service` value:
|
|
8965
9681
|
* - Service `acumatica`: Your Acumatica instance name.
|
|
8966
9682
|
* - Service `coupa`: The instance name of your Coupa account in the URL.
|
|
9683
|
+
* - Service `flywheelDigital`: Your Flywheel Digital instance.
|
|
8967
9684
|
* - Service `salesforceMarketingCloud`: The Salesforce Marketing Cloud instance ID
|
|
8968
9685
|
* - Service `servicenow`: ServiceNow Instance ID.
|
|
8969
9686
|
*/
|
|
@@ -8988,6 +9705,11 @@ export interface GetConnectorConfig {
|
|
|
8988
9705
|
* - Service `pendo`: The integration key of the Pendo account.
|
|
8989
9706
|
*/
|
|
8990
9707
|
integrationKey: string;
|
|
9708
|
+
/**
|
|
9709
|
+
* Field usage depends on `service` value:
|
|
9710
|
+
* - Service `avevaPi`: IP address of the AF Server
|
|
9711
|
+
*/
|
|
9712
|
+
ipAddress: string;
|
|
8991
9713
|
/**
|
|
8992
9714
|
* Field usage depends on `service` value:
|
|
8993
9715
|
* - Service `fivetranLog`: (Optional) Retrieve account-level logs.
|
|
@@ -9037,6 +9759,7 @@ export interface GetConnectorConfig {
|
|
|
9037
9759
|
/**
|
|
9038
9760
|
* Field usage depends on `service` value:
|
|
9039
9761
|
* - Service `awsLambda`: We use PrivateLink by default if your AWS Lambda is in the same region as Fivetran. Turning on this toggle ensures that Fivetran always connects to AWS lambda over PrivateLink. Learn more in our [PrivateLink documentation](https://fivetran.com/docs/connectors/databases/connection-options#awsprivatelink).
|
|
9762
|
+
* - Service `s3`: Set to `true` if you want to connect to S3 bucket over PrivateLink. Default value: `false`.
|
|
9040
9763
|
*/
|
|
9041
9764
|
isPrivateLinkRequired: boolean;
|
|
9042
9765
|
/**
|
|
@@ -9070,11 +9793,23 @@ export interface GetConnectorConfig {
|
|
|
9070
9793
|
* - Service `sharePoint`: Allows the creation of connector using Merge Mode strategy.
|
|
9071
9794
|
*/
|
|
9072
9795
|
isSingleTableMode: boolean;
|
|
9796
|
+
/**
|
|
9797
|
+
* Field usage depends on `service` value:
|
|
9798
|
+
* - Service `adyen`: Whether or not your Adyen Account is a Test Account. Default value: `false`.
|
|
9799
|
+
*/
|
|
9800
|
+
isTestAccount: boolean;
|
|
9073
9801
|
/**
|
|
9074
9802
|
* Field usage depends on `service` value:
|
|
9075
9803
|
* - Service `amazonSellingPartner`: Whether or not you have a Vendor Account. Default value: `false`.
|
|
9076
9804
|
*/
|
|
9077
9805
|
isVendor: boolean;
|
|
9806
|
+
/**
|
|
9807
|
+
* Field usage depends on `service` value:
|
|
9808
|
+
* - Service `oracleFusionCloudAppsCrm`: The Oracle Fusion Cloud issuer name.
|
|
9809
|
+
* - Service `oracleFusionCloudAppsFscm`: The Oracle Fusion Cloud issuer name.
|
|
9810
|
+
* - Service `oracleFusionCloudAppsHcm`: The Oracle Fusion Cloud issuer name.
|
|
9811
|
+
*/
|
|
9812
|
+
issuer: string;
|
|
9078
9813
|
/**
|
|
9079
9814
|
* Field usage depends on `service` value:
|
|
9080
9815
|
* - Service `awsCostReport`: Control how your JSON data is delivered into your destination
|
|
@@ -9146,6 +9881,11 @@ export interface GetConnectorConfig {
|
|
|
9146
9881
|
* - Service `wasabiCloudStorage`: You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.
|
|
9147
9882
|
*/
|
|
9148
9883
|
lineSeparator: string;
|
|
9884
|
+
/**
|
|
9885
|
+
* Field usage depends on `service` value:
|
|
9886
|
+
* - Service `pigment`: Your Pigment list ID.
|
|
9887
|
+
*/
|
|
9888
|
+
listId: string;
|
|
9149
9889
|
/**
|
|
9150
9890
|
* Field usage depends on `service` value:
|
|
9151
9891
|
* - Service `cjCommissionDetail`: Your CJ Commission Detail list of company IDs.
|
|
@@ -9211,6 +9951,7 @@ export interface GetConnectorConfig {
|
|
|
9211
9951
|
* - Service `avantlink`: Your AvantLink Merchant ID.
|
|
9212
9952
|
* - Service `braintree`: Your Braintree merchant ID.
|
|
9213
9953
|
* - Service `braintreeSandbox`: Your Braintree merchant ID.
|
|
9954
|
+
* - Service `shareasale`: Your ShareASale merchant ID.
|
|
9214
9955
|
* - Service `xsolla`: Your Xsolla Merchant ID.
|
|
9215
9956
|
*/
|
|
9216
9957
|
merchantId: string;
|
|
@@ -9224,6 +9965,11 @@ export interface GetConnectorConfig {
|
|
|
9224
9965
|
* - Service `herokuKafka`: Heroku Kafka message type.
|
|
9225
9966
|
*/
|
|
9226
9967
|
messageType: string;
|
|
9968
|
+
/**
|
|
9969
|
+
* Field usage depends on `service` value:
|
|
9970
|
+
* - Service `pigment`: Your Pigment metric ID.
|
|
9971
|
+
*/
|
|
9972
|
+
metricId: string;
|
|
9227
9973
|
/**
|
|
9228
9974
|
* Field usage depends on `service` value:
|
|
9229
9975
|
* - Service `adroll`: The metrics that you want to sync.
|
|
@@ -9346,6 +10092,7 @@ export interface GetConnectorConfig {
|
|
|
9346
10092
|
* - Service `megaphone`: Your Megaphone organization ID.
|
|
9347
10093
|
* - Service `productive`: Your Productive Organization ID.
|
|
9348
10094
|
* - Service `salesforceCommerceCloud`: The organization ID from Salesforce Commerce Cloud account.
|
|
10095
|
+
* - Service `sentry`: Your Sentry organization ID.
|
|
9349
10096
|
* - Service `zohoBooks`: Your Zoho Books Organization ID.
|
|
9350
10097
|
* - Service `zohoInventory`: Your Zoho Inventory organization ID.
|
|
9351
10098
|
*/
|
|
@@ -9423,6 +10170,7 @@ export interface GetConnectorConfig {
|
|
|
9423
10170
|
* Field usage depends on `service` value:
|
|
9424
10171
|
* - Service `absorbLms`: Your Absorb LMS password.
|
|
9425
10172
|
* - Service `adobeCommerce`: Your Adobe Commerce password.
|
|
10173
|
+
* - Service `akeneo`: Your Akeneo password.
|
|
9426
10174
|
* - Service `anaplan`: Your Anaplan password. Must be populated if `authMode` is set to `Basic`.
|
|
9427
10175
|
* - Service `appfigures`: Your Appfigures Password.
|
|
9428
10176
|
* - Service `aurora`: The user's password.
|
|
@@ -9437,9 +10185,11 @@ export interface GetConnectorConfig {
|
|
|
9437
10185
|
* - Service `clarity`: The user's password.
|
|
9438
10186
|
* - Service `cockroachdb`: The user's password.
|
|
9439
10187
|
* - Service `collibra`: Your collibra password.
|
|
10188
|
+
* - Service `complianceCheckpoint`: Your Compliance Checkpoint account password.
|
|
9440
10189
|
* - Service `contrastSecurity`: Your Contrast Security API Password.
|
|
9441
10190
|
* - Service `db2iHva`: The user's password.
|
|
9442
10191
|
* - Service `db2iSapHva`: The user's password.
|
|
10192
|
+
* - Service `deposco`: Your Deposco password.
|
|
9443
10193
|
* - Service `documentdb`: The user's password.
|
|
9444
10194
|
* - Service `dynamics365Fo`: The user's password.
|
|
9445
10195
|
* - Service `ehr`: The user's password.
|
|
@@ -9458,6 +10208,7 @@ export interface GetConnectorConfig {
|
|
|
9458
10208
|
* - Service `hanaSapHvaS4`: The user's password.
|
|
9459
10209
|
* - Service `hanaSapHvaS4Netweaver`: The user's password.
|
|
9460
10210
|
* - Service `herokuPostgres`: The user's password.
|
|
10211
|
+
* - Service `hiltiOntrack`: Your Hilti On!Track password.
|
|
9461
10212
|
* - Service `impact`: Your Impact Account Token
|
|
9462
10213
|
* - Service `integralAdScience`: Your integralAdScience password.
|
|
9463
10214
|
* - Service `itunesConnect`: Your password
|
|
@@ -9497,9 +10248,10 @@ export interface GetConnectorConfig {
|
|
|
9497
10248
|
* - Service `outbrain`: The Outbrain user's password.
|
|
9498
10249
|
* - Service `pardot`: The Pardot user's password.
|
|
9499
10250
|
* - Service `partnerize`: Your Partnerize account's password.
|
|
9500
|
-
* - Service `podio`: Your Podio password.
|
|
10251
|
+
* - Service `podio`: Your Podio account password.
|
|
9501
10252
|
* - Service `postgres`: The user's password.
|
|
9502
10253
|
* - Service `postgresRds`: The user's password.
|
|
10254
|
+
* - Service `qmaticDataConnect`: Your Qmatic Data Connect password.
|
|
9503
10255
|
* - Service `redshiftDb`: The Redshift user's password.
|
|
9504
10256
|
* - Service `revx`: Your RevX Password.
|
|
9505
10257
|
* - Service `rtbHouse`: Your RTB House password.
|
|
@@ -9522,7 +10274,9 @@ export interface GetConnectorConfig {
|
|
|
9522
10274
|
* - Service `sqlServerRds`: The user's password.
|
|
9523
10275
|
* - Service `sqlServerSapEccHva`: The user's password.
|
|
9524
10276
|
* - Service `starrez`: Your StarRez API password
|
|
10277
|
+
* - Service `stickyio`: Your sticky.io password.
|
|
9525
10278
|
* - Service `stylight`: Your Stylight Password.
|
|
10279
|
+
* - Service `sugarcrm`: Your SugarCRM password.
|
|
9526
10280
|
* - Service `teamwork`: Your Teamwork password.
|
|
9527
10281
|
* - Service `theTradeDesk`: The Trade Desk password. It is a part of the login credentials.
|
|
9528
10282
|
* - Service `togglTrack`: Your Toggl Track Password
|
|
@@ -9647,10 +10401,16 @@ export interface GetConnectorConfig {
|
|
|
9647
10401
|
* - Service `itunesConnect`: Register the number on AppleId Account Page for 2FA
|
|
9648
10402
|
*/
|
|
9649
10403
|
phoneNumber: string;
|
|
10404
|
+
/**
|
|
10405
|
+
* Field usage depends on `service` value:
|
|
10406
|
+
* - Service `justcall`: Your JustCall Plan Type.
|
|
10407
|
+
*/
|
|
10408
|
+
planType: string;
|
|
9650
10409
|
/**
|
|
9651
10410
|
* Field usage depends on `service` value:
|
|
9652
10411
|
* - Service `aurora`: The port number.
|
|
9653
10412
|
* - Service `auroraPostgres`: The port number.
|
|
10413
|
+
* - Service `avevaPi`: Port number at which the AF Server is running
|
|
9654
10414
|
* - Service `azurePostgres`: The port number.
|
|
9655
10415
|
* - Service `azureSqlDb`: The port number.
|
|
9656
10416
|
* - Service `azureSqlManagedDb`: The port number.
|
|
@@ -9758,7 +10518,12 @@ export interface GetConnectorConfig {
|
|
|
9758
10518
|
* - Service `appleSearchAds`: The contents of your secret key file. Must be populated if `isAuth2Enabled` is set to `false`.
|
|
9759
10519
|
* - Service `braintree`: The contents of your secret key file.
|
|
9760
10520
|
* - Service `braintreeSandbox`: The contents of your secret key file.
|
|
10521
|
+
* - Service `oracleFusionCloudAppsCrm`: The Oracle Fusion Cloud private key.
|
|
10522
|
+
* - Service `oracleFusionCloudAppsFscm`: The Oracle Fusion Cloud private key.
|
|
10523
|
+
* - Service `oracleFusionCloudAppsHcm`: The Oracle Fusion Cloud private key.
|
|
9761
10524
|
* - Service `qualtrics`: Your private key
|
|
10525
|
+
* - Service `salesforce`: Provide content of the `.key` private key (only when authenticationMethod = `ADVANCED`).
|
|
10526
|
+
* - Service `salesforceSandbox`: Provide content of the `.key` private key (only when authenticationMethod = `ADVANCED`).
|
|
9762
10527
|
* - Service `snowflakeDb`: Private access key. The field should be specified if authentication type is `KEY_PAIR`.
|
|
9763
10528
|
*/
|
|
9764
10529
|
privateKey: string;
|
|
@@ -9781,9 +10546,14 @@ export interface GetConnectorConfig {
|
|
|
9781
10546
|
profiles: string[];
|
|
9782
10547
|
/**
|
|
9783
10548
|
* Field usage depends on `service` value:
|
|
9784
|
-
* - Service `
|
|
10549
|
+
* - Service `amazonDsp`: Comma-separated list of your Amazon DSP profiles.
|
|
9785
10550
|
*/
|
|
9786
|
-
|
|
10551
|
+
profilesAmazonDsp: string;
|
|
10552
|
+
/**
|
|
10553
|
+
* Field usage depends on `service` value:
|
|
10554
|
+
* - Service `rollbar`: Your Rollbar project access token.
|
|
10555
|
+
*/
|
|
10556
|
+
projectAccessToken: string;
|
|
9787
10557
|
/**
|
|
9788
10558
|
* Field usage depends on `service` value:
|
|
9789
10559
|
* - Service `amplitude`: * Project(s)
|
|
@@ -9797,6 +10567,11 @@ export interface GetConnectorConfig {
|
|
|
9797
10567
|
* - Service `mixpanel`: Project ID
|
|
9798
10568
|
*/
|
|
9799
10569
|
projectId: string;
|
|
10570
|
+
/**
|
|
10571
|
+
* Field usage depends on `service` value:
|
|
10572
|
+
* - Service `sentry`: Your Sentry project IDs.
|
|
10573
|
+
*/
|
|
10574
|
+
projectIds: string;
|
|
9800
10575
|
/**
|
|
9801
10576
|
* Field usage depends on `service` value:
|
|
9802
10577
|
* - Service `commercetools`: Your commercetools project key.
|
|
@@ -9815,7 +10590,7 @@ export interface GetConnectorConfig {
|
|
|
9815
10590
|
properties: string[];
|
|
9816
10591
|
/**
|
|
9817
10592
|
* Field usage depends on `service` value:
|
|
9818
|
-
* - Service `cloudbeds`: Your Cloudbeds
|
|
10593
|
+
* - Service `cloudbeds`: Your Cloudbeds property IDs.
|
|
9819
10594
|
*/
|
|
9820
10595
|
propertyId: string;
|
|
9821
10596
|
/**
|
|
@@ -9862,6 +10637,9 @@ export interface GetConnectorConfig {
|
|
|
9862
10637
|
* - Service `opensearch`: Public Key
|
|
9863
10638
|
* - Service `oracle`: Public Key
|
|
9864
10639
|
* - Service `oracleEbs`: Public Key
|
|
10640
|
+
* - Service `oracleFusionCloudAppsCrm`: The Oracle Fusion Cloud public key.
|
|
10641
|
+
* - Service `oracleFusionCloudAppsFscm`: The Oracle Fusion Cloud public key.
|
|
10642
|
+
* - Service `oracleFusionCloudAppsHcm`: The Oracle Fusion Cloud public key.
|
|
9865
10643
|
* - Service `oracleHva`: Public Key
|
|
9866
10644
|
* - Service `oracleRac`: Public Key
|
|
9867
10645
|
* - Service `oracleRds`: Public Key
|
|
@@ -9888,11 +10666,17 @@ export interface GetConnectorConfig {
|
|
|
9888
10666
|
* - Service `postgresRds`: Publication name. Specify only for `"updatedMethod": "WAL_PGOUTPUT"`.
|
|
9889
10667
|
*/
|
|
9890
10668
|
publicationName: string;
|
|
10669
|
+
/**
|
|
10670
|
+
* Field usage depends on `service` value:
|
|
10671
|
+
* - Service `skimlinks`: Your Skimlinks publisher ID.
|
|
10672
|
+
*/
|
|
10673
|
+
publisherId: string;
|
|
9891
10674
|
/**
|
|
9892
10675
|
* Field usage depends on `service` value:
|
|
9893
10676
|
* - Service `outbrain`: Include or ignore results from archived campaigns
|
|
9894
10677
|
*/
|
|
9895
10678
|
pullArchivedCampaigns: boolean;
|
|
10679
|
+
pythonVersion: string;
|
|
9896
10680
|
/**
|
|
9897
10681
|
* Field usage depends on `service` value:
|
|
9898
10682
|
* - Service `googleDisplayAndVideo360`: The ID of the query whose configuration you want to reuse. This is a required parameter when `configMethod` is set to `REUSE_EXISTING`.
|
|
@@ -9909,6 +10693,31 @@ export interface GetConnectorConfig {
|
|
|
9909
10693
|
* - Service `bigqueryDb`: Specify a different project ID to account for quota and billing of Fivetran query workload
|
|
9910
10694
|
*/
|
|
9911
10695
|
quotaProjectId: string;
|
|
10696
|
+
/**
|
|
10697
|
+
* Field usage depends on `service` value:
|
|
10698
|
+
* - Service `azureBlobStorage`: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quoteCharacterEnabled is set to true.
|
|
10699
|
+
* - Service `gcs`: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quoteCharacterEnabled is set to true.
|
|
10700
|
+
* - Service `googleDrive`: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quoteCharacterEnabled is set to true.
|
|
10701
|
+
* - Service `s3`: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quoteCharacterEnabled is set to true.
|
|
10702
|
+
* - Service `sftp`: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quoteCharacterEnabled is set to true.
|
|
10703
|
+
* - Service `sharePoint`: You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quoteCharacterEnabled is set to true.
|
|
10704
|
+
*/
|
|
10705
|
+
quoteChar: string;
|
|
10706
|
+
/**
|
|
10707
|
+
* Field usage depends on `service` value:
|
|
10708
|
+
* - Service `azureBlobStorage`: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character.
|
|
10709
|
+
* - Service `gcs`: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character.
|
|
10710
|
+
* - Service `googleDrive`: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character.
|
|
10711
|
+
* - Service `s3`: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character.
|
|
10712
|
+
* - Service `sftp`: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character.
|
|
10713
|
+
* - Service `sharePoint`: If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character.
|
|
10714
|
+
*/
|
|
10715
|
+
quoteCharacterEnabled: boolean;
|
|
10716
|
+
/**
|
|
10717
|
+
* Field usage depends on `service` value:
|
|
10718
|
+
* - Service `vimeo`: Your Vimeo rate limit plan.
|
|
10719
|
+
*/
|
|
10720
|
+
rateLimitPlan: string;
|
|
9912
10721
|
/**
|
|
9913
10722
|
* Field usage depends on `service` value:
|
|
9914
10723
|
* - Service `ironsource`: Your Ironsource `Client Secret`.
|
|
@@ -9928,8 +10737,10 @@ export interface GetConnectorConfig {
|
|
|
9928
10737
|
* - Service `atlassianOpsGenie`: Your company's Osgenie region (usually **company**.opsgenie.com)
|
|
9929
10738
|
* - Service `awin`: Your Awin Region.
|
|
9930
10739
|
* - Service `awsLambda`: The AWS region code for the DynamoDB instance.
|
|
10740
|
+
* - Service `biginByZohoCrm`: Your Bigin by Zoho CRM Region
|
|
9931
10741
|
* - Service `concur`: The region.
|
|
9932
10742
|
* - Service `cvent`: Your Cvent region.
|
|
10743
|
+
* - Service `everflow`: Your Everflow region.
|
|
9933
10744
|
* - Service `exactOnline`: Your Exact Online region.
|
|
9934
10745
|
* - Service `getfeedback`: Your GetFeedback region.
|
|
9935
10746
|
* - Service `happyfox`: Your HappyFox region.
|
|
@@ -9946,6 +10757,7 @@ export interface GetConnectorConfig {
|
|
|
9946
10757
|
* - Service `snyk`: Your Snyk region.
|
|
9947
10758
|
* - Service `talkdesk`: Your Talkdesk region (".com",".eu","ca.com")
|
|
9948
10759
|
* - Service `totango`: Your Totango region.
|
|
10760
|
+
* - Service `transcend`: Your Transcend region.
|
|
9949
10761
|
* - Service `vonageContactCenter`: Your Vonage Contact Center region.
|
|
9950
10762
|
* - Service `wasabiCloudStorage`: The Wasabi Cloud Storage bucket region. Required for connector creation. Default value: `US_EAST_1`.
|
|
9951
10763
|
* - Service `workdayStrategicSourcing`: Your Workday Strategic Sourcing Region.
|
|
@@ -9972,7 +10784,7 @@ export interface GetConnectorConfig {
|
|
|
9972
10784
|
regionTokenUrl: string;
|
|
9973
10785
|
/**
|
|
9974
10786
|
* Field usage depends on `service` value:
|
|
9975
|
-
* - Service `playvoxWorkforceManagement`: Your Playvox Workforce Management
|
|
10787
|
+
* - Service `playvoxWorkforceManagement`: Your Playvox Workforce Management region URL.
|
|
9976
10788
|
*/
|
|
9977
10789
|
regionUrl: string;
|
|
9978
10790
|
/**
|
|
@@ -10014,6 +10826,11 @@ export interface GetConnectorConfig {
|
|
|
10014
10826
|
* - Service `workday`: This is to select report format from JSON and CSV. By default, report format is JSON.
|
|
10015
10827
|
*/
|
|
10016
10828
|
reportFormatType: string;
|
|
10829
|
+
/**
|
|
10830
|
+
* Field usage depends on `service` value:
|
|
10831
|
+
* - Service `pinterestAds`: Granularity at which reports will be
|
|
10832
|
+
*/
|
|
10833
|
+
reportGranularity: string;
|
|
10017
10834
|
/**
|
|
10018
10835
|
* Field usage depends on `service` value:
|
|
10019
10836
|
* - Service `rakutenadvertising`: Your Rakuten Advertising report keys.
|
|
@@ -10024,6 +10841,11 @@ export interface GetConnectorConfig {
|
|
|
10024
10841
|
* - Service `spotifyAds`: The list of reports. Each report corresponds to a table within the schema to which connector will sync the data.
|
|
10025
10842
|
*/
|
|
10026
10843
|
reportLists: outputs.GetConnectorConfigReportList[];
|
|
10844
|
+
/**
|
|
10845
|
+
* Field usage depends on `service` value:
|
|
10846
|
+
* - Service `adyen`: Your Report Service API key.
|
|
10847
|
+
*/
|
|
10848
|
+
reportServiceApiKey: string;
|
|
10027
10849
|
reportSuites: string[];
|
|
10028
10850
|
/**
|
|
10029
10851
|
* Field usage depends on `service` value:
|
|
@@ -10050,6 +10872,7 @@ export interface GetConnectorConfig {
|
|
|
10050
10872
|
* - Service `googleAnalytics4`: The list of reports. Each report corresponds to a table within the schema to which connector will sync the data.
|
|
10051
10873
|
* - Service `googleSearchAds360`: The list of reports. Each report corresponds to a table within the schema to which connector syncs the data.
|
|
10052
10874
|
* - Service `googleSearchConsole`: The list of reports. Each report corresponds to a table within the schema to which connector syncs the data.
|
|
10875
|
+
* - Service `workday`: The list of reports. Each report corresponds to a table within the schema to which connector will sync the data.
|
|
10053
10876
|
*/
|
|
10054
10877
|
reports: outputs.GetConnectorConfigReport[];
|
|
10055
10878
|
/**
|
|
@@ -10202,6 +11025,7 @@ export interface GetConnectorConfig {
|
|
|
10202
11025
|
* Field usage depends on `service` value:
|
|
10203
11026
|
* - Service `db2iHva`: The SAP schema.
|
|
10204
11027
|
* - Service `db2iSapHva`: SAP schema name.
|
|
11028
|
+
* - Service `sqlServerHva`: SAP Schema Name. Required only for High-Volume Agent SAP ECC connector.
|
|
10205
11029
|
* - Service `sqlServerSapEccHva`: SAP Schema Name.
|
|
10206
11030
|
*/
|
|
10207
11031
|
sapSchema: string;
|
|
@@ -10293,6 +11117,11 @@ export interface GetConnectorConfig {
|
|
|
10293
11117
|
* - Service `ebay`: Your eBay scopes.
|
|
10294
11118
|
*/
|
|
10295
11119
|
scope: string;
|
|
11120
|
+
/**
|
|
11121
|
+
* Field usage depends on `service` value:
|
|
11122
|
+
* - Service `cornerstone`: Your Cornerstone scopes.
|
|
11123
|
+
*/
|
|
11124
|
+
scopes: string;
|
|
10296
11125
|
/**
|
|
10297
11126
|
* Field usage depends on `service` value:
|
|
10298
11127
|
* - Service `yahooDsp`: Specific Seats to sync. Must be populated if `syncModeSeat` is set to `SPECIFIC_SEATS`.
|
|
@@ -10302,11 +11131,13 @@ export interface GetConnectorConfig {
|
|
|
10302
11131
|
* Field usage depends on `service` value:
|
|
10303
11132
|
* - Service `appcues`: Your Appcues Secret.
|
|
10304
11133
|
* - Service `buildium`: Your Buildium API secret.
|
|
11134
|
+
* - Service `canvasData2ByInstructure`: Your Canvas Data 2 by Instructure secret.
|
|
10305
11135
|
* - Service `loopio`: Your Loopio Secret.
|
|
10306
11136
|
* - Service `mode`: Your Mode Secret.
|
|
10307
|
-
* - Service `playvoxWorkforceManagement`: Your Playvox Workforce Management
|
|
11137
|
+
* - Service `playvoxWorkforceManagement`: Your Playvox Workforce Management client secret.
|
|
10308
11138
|
* - Service `twilio`: The Twilio API secret
|
|
10309
11139
|
* - Service `uservoice`: The UserVoice API secret.
|
|
11140
|
+
* - Service `venminder`: Your Venminder secret.
|
|
10310
11141
|
* - Service `vts`: Your VTS secret.
|
|
10311
11142
|
*/
|
|
10312
11143
|
secret: string;
|
|
@@ -10319,9 +11150,12 @@ export interface GetConnectorConfig {
|
|
|
10319
11150
|
* - Service `ezofficeinventory`: Your EZOfficeInventory API secret key.
|
|
10320
11151
|
* - Service `gcs`: Your JSON Private Key. Used to authorize service account. Required if you use a Custom Service Account to authenticate the storage bucket.
|
|
10321
11152
|
* - Service `ironsource`: Your Ironsource `Client ID`.
|
|
11153
|
+
* - Service `lineAds`: Your LINE Ads secret key.
|
|
11154
|
+
* - Service `mailjet`: Your Mailjet secret key.
|
|
10322
11155
|
* - Service `partnerstackVendor`: Your PartnerStack Vendor Secret key.
|
|
10323
11156
|
* - Service `paypal`: `Client Secret` of your PayPal client application.
|
|
10324
11157
|
* - Service `paypalSandbox`: `Client Secret` of your PayPal client application.
|
|
11158
|
+
* - Service `phoenixAds`: Your Phoenix Ads Secret key.
|
|
10325
11159
|
* - Service `retailnext`: Your RetailNext secret key.
|
|
10326
11160
|
* - Service `statsig`: Your Statsig secret key.
|
|
10327
11161
|
* - Service `yotpo`: Your Yotpo Secret key
|
|
@@ -10384,6 +11218,11 @@ export interface GetConnectorConfig {
|
|
|
10384
11218
|
* - Service `tableauSource`: Your Tableau Source server address.
|
|
10385
11219
|
*/
|
|
10386
11220
|
serverAddress: string;
|
|
11221
|
+
/**
|
|
11222
|
+
* Field usage depends on `service` value:
|
|
11223
|
+
* - Service `clockify`: Your Clockify server region.
|
|
11224
|
+
*/
|
|
11225
|
+
serverRegion: string;
|
|
10387
11226
|
/**
|
|
10388
11227
|
* Field usage depends on `service` value:
|
|
10389
11228
|
* - Service `oracleBusinessIntelligencePublisher`: The Oracle Business Intelligence Instance URL.
|
|
@@ -10494,6 +11333,11 @@ export interface GetConnectorConfig {
|
|
|
10494
11333
|
* - Service `shopify`: The Shopify shop name. Can be found in the URL before **.myshopify.com**.
|
|
10495
11334
|
*/
|
|
10496
11335
|
shop: string;
|
|
11336
|
+
/**
|
|
11337
|
+
* Field usage depends on `service` value:
|
|
11338
|
+
* - Service `tripleWhale`: Your Triple Whale shop domain.
|
|
11339
|
+
*/
|
|
11340
|
+
shopDomain: string;
|
|
10497
11341
|
/**
|
|
10498
11342
|
* Field usage depends on `service` value:
|
|
10499
11343
|
* - Service `salesforceCommerceCloud`: The Salesforce eight-character string assigned to a realm for routing purposes.
|
|
@@ -10653,6 +11497,7 @@ export interface GetConnectorConfig {
|
|
|
10653
11497
|
* - Service `checkr`: Your Checkr subdomain.
|
|
10654
11498
|
* - Service `clubspeed`: Your Clubspeed subdomain.
|
|
10655
11499
|
* - Service `collibra`: Your collibra subdomain.
|
|
11500
|
+
* - Service `complianceCheckpoint`: Your Compliance Checkpoint subdomain.
|
|
10656
11501
|
* - Service `concord`: Your Concord Sub Domain.
|
|
10657
11502
|
* - Service `contrastSecurity`: Your Contrast Security subdomain.
|
|
10658
11503
|
* - Service `customerio`: Your Customer.io region-specific Subdomain.
|
|
@@ -10675,7 +11520,9 @@ export interface GetConnectorConfig {
|
|
|
10675
11520
|
* - Service `kandji`: Your Kandji Subdomain.
|
|
10676
11521
|
* - Service `khorosCare`: Your Khoros Care subDomain.
|
|
10677
11522
|
* - Service `lookerSource`: Your looker SubDomain name.
|
|
11523
|
+
* - Service `lucca`: Your Lucca subdomain.
|
|
10678
11524
|
* - Service `mailgun`: Your Mailgun subdomain.
|
|
11525
|
+
* - Service `matomo`: Your Matomo subdomain.
|
|
10679
11526
|
* - Service `maxioChargify`: Enter Your Subdomain.
|
|
10680
11527
|
* - Service `myosh`: Your myosh subdomain.
|
|
10681
11528
|
* - Service `namely`: Your Namely subdomain.
|
|
@@ -10696,6 +11543,7 @@ export interface GetConnectorConfig {
|
|
|
10696
11543
|
* - Service `sapSuccessFactors`: Your SAP SuccessFactors Subdomain.
|
|
10697
11544
|
* - Service `sonarqube`: Your Sonarqube subdomain.
|
|
10698
11545
|
* - Service `starrez`: Your StarRez subdomain
|
|
11546
|
+
* - Service `sugarcrm`: Your SugarCRM subdomain.
|
|
10699
11547
|
* - Service `tableauSource`: Your Tableau Source subdomain.
|
|
10700
11548
|
* - Service `tempo`: Your Tempo subdomain.
|
|
10701
11549
|
* - Service `testrail`: Your TestRail subdomain.
|
|
@@ -10723,6 +11571,9 @@ export interface GetConnectorConfig {
|
|
|
10723
11571
|
* - Service `learnupon`: Your Learnupon subdomain.
|
|
10724
11572
|
* - Service `maxioSaasoptics`: Your Maxio SaaSOptics subdomain.
|
|
10725
11573
|
* - Service `medallia`: Medallia subdomain
|
|
11574
|
+
* - Service `packiyo`: Your Packiyo subdomain.
|
|
11575
|
+
* - Service `qmaticDataConnect`: Your Qmatic Data Connect subdomain.
|
|
11576
|
+
* - Service `sana`: Your Sana subdomain.
|
|
10726
11577
|
* - Service `skillstx`: Your SkillsTX subdomain.
|
|
10727
11578
|
* - Service `smarthr`: Your SmartHR subdomain.
|
|
10728
11579
|
* - Service `sonarqube`: Your Sonarqube subdomain.
|
|
@@ -10779,8 +11630,9 @@ export interface GetConnectorConfig {
|
|
|
10779
11630
|
syncFormat: string;
|
|
10780
11631
|
/**
|
|
10781
11632
|
* Field usage depends on `service` value:
|
|
10782
|
-
* - Service `
|
|
10783
|
-
* - Service `
|
|
11633
|
+
* - Service `financialForce`: Enable this option to sync formula fields directly (default value = `false`)
|
|
11634
|
+
* - Service `salesforce`: Enable this option to sync formula fields directly (default value = `false`)
|
|
11635
|
+
* - Service `salesforceSandbox`: Enable this option to sync formula fields directly (default value = `false`)
|
|
10784
11636
|
*/
|
|
10785
11637
|
syncFormulaFields: boolean;
|
|
10786
11638
|
/**
|
|
@@ -10802,7 +11654,7 @@ export interface GetConnectorConfig {
|
|
|
10802
11654
|
* - Service `asana`: Whether to sync all projects or specific projects.
|
|
10803
11655
|
* - Service `bingads`: Whether to sync all accounts or specific accounts. Default value: `AllAccounts`.
|
|
10804
11656
|
* - Service `doubleClickCampaignManager`: Whether to sync all user profiles or specific ones. Default value: `AllAccounts`.
|
|
10805
|
-
* - Service `dynamodb`:
|
|
11657
|
+
* - Service `dynamodb`: Which packed mode setting to use. Default value: `UsePackedModeOnly`.
|
|
10806
11658
|
* - Service `facebook`: Option to select connector should sync all accounts or specific accounts. [Possible syncMode values](https://fivetran.com/docs/applications/facebook-ad-insights/api-config#syncmode).
|
|
10807
11659
|
* - Service `facebookAdAccount`: Whether to sync all accounts or specific accounts. Default value: `AllAccounts`.
|
|
10808
11660
|
* - Service `facebookAds`: Option to select connector should sync all accounts or specific accounts. [Possible syncMode values](https://fivetran.com/docs/connectors/applications/facebook-ads-insights/api-config#syncmode).
|
|
@@ -10879,11 +11731,21 @@ export interface GetConnectorConfig {
|
|
|
10879
11731
|
* - Service `hanaSapHvaS4Netweaver`: Unique identifier sapsid of the SAP system. This field is displayed only when the REMOTE SERVICE IDENTIFICATION is set to System ID.
|
|
10880
11732
|
*/
|
|
10881
11733
|
systemId: string;
|
|
11734
|
+
/**
|
|
11735
|
+
* Field usage depends on `service` value:
|
|
11736
|
+
* - Service `pigment`: Your Pigment table ID.
|
|
11737
|
+
*/
|
|
11738
|
+
tableId: string;
|
|
10882
11739
|
/**
|
|
10883
11740
|
* Field usage depends on `service` value:
|
|
10884
11741
|
* - Service `airtable`: Name of table in Airtable
|
|
10885
11742
|
*/
|
|
10886
11743
|
tableName: string;
|
|
11744
|
+
/**
|
|
11745
|
+
* Field usage depends on `service` value:
|
|
11746
|
+
* - Service `hubspot`: Timestamp to indicate when tables without access was updated
|
|
11747
|
+
*/
|
|
11748
|
+
tablesWithoutAccessUpdatedAt: string;
|
|
10887
11749
|
/**
|
|
10888
11750
|
* Field usage depends on `service` value:
|
|
10889
11751
|
* - Service `cultureAmp`: Your Culture Amp Target entity ID.
|
|
@@ -10936,6 +11798,7 @@ export interface GetConnectorConfig {
|
|
|
10936
11798
|
/**
|
|
10937
11799
|
* Field usage depends on `service` value:
|
|
10938
11800
|
* - Service `microsoftEntraId`: Your Microsoft Entra ID Tenant.
|
|
11801
|
+
* - Service `microsoftPowerBi`: Your Microsoft Power BI tenant.
|
|
10939
11802
|
* - Service `microsoftTeams`: Your Microsoft Teams Tenant.
|
|
10940
11803
|
* - Service `unicommerce`: Your uniware tenant.
|
|
10941
11804
|
* - Service `workday`: Workday tenant name
|
|
@@ -10948,6 +11811,11 @@ export interface GetConnectorConfig {
|
|
|
10948
11811
|
* - Service `planful`: Your Planful tenant app URL.
|
|
10949
11812
|
*/
|
|
10950
11813
|
tenantAppUrl: string;
|
|
11814
|
+
/**
|
|
11815
|
+
* Field usage depends on `service` value:
|
|
11816
|
+
* - Service `deposco`: Your Deposco tenant code.
|
|
11817
|
+
*/
|
|
11818
|
+
tenantCode: string;
|
|
10951
11819
|
/**
|
|
10952
11820
|
* Field usage depends on `service` value:
|
|
10953
11821
|
* - Service `reltio`: * tenant(s)
|
|
@@ -10972,7 +11840,7 @@ export interface GetConnectorConfig {
|
|
|
10972
11840
|
/**
|
|
10973
11841
|
* Field usage depends on `service` value:
|
|
10974
11842
|
* - Service `ivanti`: Your Ivanti Tenant URL.
|
|
10975
|
-
* - Service `playvoxWorkforceManagement`: Your Playvox Workforce Management
|
|
11843
|
+
* - Service `playvoxWorkforceManagement`: Your Playvox Workforce Management tenant URL.
|
|
10976
11844
|
* - Service `reltio`: Your Reltio tenant URL.
|
|
10977
11845
|
*/
|
|
10978
11846
|
tenantUrl: string;
|
|
@@ -11023,6 +11891,16 @@ export interface GetConnectorConfig {
|
|
|
11023
11891
|
* - Service `yahooGemini`: Number of months' worth of reporting data you'd like to include in your initial sync. This cannot be modified once the connector is created. Default value: `TWELVE`.
|
|
11024
11892
|
*/
|
|
11025
11893
|
timeframeMonths: string;
|
|
11894
|
+
/**
|
|
11895
|
+
* Field usage depends on `service` value:
|
|
11896
|
+
* - Service `rokt`: Your Rokt timezone.
|
|
11897
|
+
*/
|
|
11898
|
+
timezone: string;
|
|
11899
|
+
/**
|
|
11900
|
+
* Field usage depends on `service` value:
|
|
11901
|
+
* - Service `appleSearchAds`: Determines whether to use UTC or the users timezone from the apple account
|
|
11902
|
+
*/
|
|
11903
|
+
timezoneMode: string;
|
|
11026
11904
|
/**
|
|
11027
11905
|
* Field usage depends on `service` value:
|
|
11028
11906
|
* - Service `oracleHva`: Single-tenant database: The database's SID. Multi-tenant database: The database's TNS.
|
|
@@ -11036,8 +11914,11 @@ export interface GetConnectorConfig {
|
|
|
11036
11914
|
toastId: string;
|
|
11037
11915
|
/**
|
|
11038
11916
|
* Field usage depends on `service` value:
|
|
11917
|
+
* - Service `khorosCommunities`: Your Khoros Communities token.
|
|
11918
|
+
* - Service `matomo`: Your Matomo auth token.
|
|
11039
11919
|
* - Service `mode`: Your Mode Token.
|
|
11040
11920
|
* - Service `oracleMoatAnalytics`: Your Oracle Moat Analytics Token.
|
|
11921
|
+
* - Service `shareasale`: Your ShareASale token.
|
|
11041
11922
|
* - Service `solarwindsServiceDesk`: Your SolarWinds Service Desk token.
|
|
11042
11923
|
*/
|
|
11043
11924
|
token: string;
|
|
@@ -11075,6 +11956,11 @@ export interface GetConnectorConfig {
|
|
|
11075
11956
|
* - Service `mux`: Your Mux token secret key
|
|
11076
11957
|
*/
|
|
11077
11958
|
tokenSecretKey: string;
|
|
11959
|
+
/**
|
|
11960
|
+
* Field usage depends on `service` value:
|
|
11961
|
+
* - Service `amazonDsp`: Your Amazon DSP token URL region.
|
|
11962
|
+
*/
|
|
11963
|
+
tokenUrlRegion: string;
|
|
11078
11964
|
/**
|
|
11079
11965
|
* Field usage depends on `service` value:
|
|
11080
11966
|
* - Service `azureServiceBus`: The comma-separated list of topics which should be synced. Required if you do not have manage permissions
|
|
@@ -11447,6 +12333,7 @@ export interface GetConnectorConfig {
|
|
|
11447
12333
|
* - Service `okendo`: Your Okendo user ID.
|
|
11448
12334
|
* - Service `playvox`: Your Playvox User ID.
|
|
11449
12335
|
* - Service `sageIntacct`: User ID
|
|
12336
|
+
* - Service `vimeo`: Your Vimeo user ID.
|
|
11450
12337
|
*/
|
|
11451
12338
|
userId: string;
|
|
11452
12339
|
userKey: string;
|
|
@@ -11471,22 +12358,27 @@ export interface GetConnectorConfig {
|
|
|
11471
12358
|
* Field usage depends on `service` value:
|
|
11472
12359
|
* - Service `absorbLms`: Your Absorb LMS username.
|
|
11473
12360
|
* - Service `adobeCommerce`: Your Adobe Commerce username.
|
|
12361
|
+
* - Service `akeneo`: Your Akeneo username.
|
|
11474
12362
|
* - Service `anaplan`: Your Anaplan user ID. Must be populated if `authMode` is set to `Basic`.
|
|
11475
12363
|
* - Service `appfigures`: Your Appfigures Username.
|
|
12364
|
+
* - Service `avevaPi`: Username for the user to authenticate as with the AF Server
|
|
11476
12365
|
* - Service `ceridianDayforce`: Your Ceridian Dayforce Username.
|
|
11477
12366
|
* - Service `churnzero`: Your ChurnZero username.
|
|
11478
12367
|
* - Service `cin7`: Your Cin7 API Username.
|
|
11479
12368
|
* - Service `collibra`: Your collibra username.
|
|
12369
|
+
* - Service `complianceCheckpoint`: Your Compliance Checkpoint account username.
|
|
11480
12370
|
* - Service `concur`: The SAP Concur username.
|
|
11481
12371
|
* - Service `confluence`: Your Confluence username.
|
|
11482
12372
|
* - Service `contrastSecurity`: Your Contrast Security API Username.
|
|
11483
12373
|
* - Service `dclLogistics`: Your DCL Logistics username.
|
|
12374
|
+
* - Service `deposco`: Your Deposco username.
|
|
11484
12375
|
* - Service `github`: `Login` of your GitHub profile.
|
|
11485
12376
|
* - Service `gladly`: Your Gladly Username.
|
|
11486
12377
|
* - Service `globalmeet`: Your GlobalMeet Username.
|
|
11487
12378
|
* - Service `gorgias`: Your Gorgias username.
|
|
11488
12379
|
* - Service `greenPowerMonitor`: Your GreenPowerMonitor username.
|
|
11489
12380
|
* - Service `guru`: Your Guru username.
|
|
12381
|
+
* - Service `hiltiOntrack`: Your Hilti On!Track username.
|
|
11490
12382
|
* - Service `impact`: Your Impact Account SID
|
|
11491
12383
|
* - Service `integralAdScience`: Your integralAdScience username.
|
|
11492
12384
|
* - Service `itunesConnect`: Your Apple ID
|
|
@@ -11504,7 +12396,8 @@ export interface GetConnectorConfig {
|
|
|
11504
12396
|
* - Service `oracleFusionCloudAppsHcm`: The Oracle Fusion Cloud username.
|
|
11505
12397
|
* - Service `partnerize`: Your Partnerize account's username.
|
|
11506
12398
|
* - Service `pingdom`: Your Pingdom Username.
|
|
11507
|
-
* - Service `podio`: Your Podio username.
|
|
12399
|
+
* - Service `podio`: Your Podio account username.
|
|
12400
|
+
* - Service `qmaticDataConnect`: Your Qmatic Data Connect username.
|
|
11508
12401
|
* - Service `quorum`: Your Quorum username .
|
|
11509
12402
|
* - Service `revx`: Your RevX Username.
|
|
11510
12403
|
* - Service `rtbHouse`: Your RTB House username.
|
|
@@ -11516,7 +12409,9 @@ export interface GetConnectorConfig {
|
|
|
11516
12409
|
* - Service `shopware`: Your Shopware username.
|
|
11517
12410
|
* - Service `splash`: Your Splash username.
|
|
11518
12411
|
* - Service `starrez`: Your StarRez API username
|
|
12412
|
+
* - Service `stickyio`: Your sticky.io username .
|
|
11519
12413
|
* - Service `stylight`: Your Stylight Username.
|
|
12414
|
+
* - Service `sugarcrm`: Your SugarCRM username.
|
|
11520
12415
|
* - Service `teamwork`: Your Teamwork username.
|
|
11521
12416
|
* - Service `testrail`: Your TestRail username.
|
|
11522
12417
|
* - Service `ukgPro`: Your UKG Pro username.
|
|
@@ -11543,11 +12438,21 @@ export interface GetConnectorConfig {
|
|
|
11543
12438
|
* - Service `snapchatAds`: The time period to attribute conversions based on views. Default value: `DAY_1`
|
|
11544
12439
|
*/
|
|
11545
12440
|
viewAttributionWindow: string;
|
|
12441
|
+
/**
|
|
12442
|
+
* Field usage depends on `service` value:
|
|
12443
|
+
* - Service `pigment`: Your Pigment view ID.
|
|
12444
|
+
*/
|
|
12445
|
+
viewId: string;
|
|
11546
12446
|
/**
|
|
11547
12447
|
* Field usage depends on `service` value:
|
|
11548
12448
|
* - Service `linkedinAds`: The time period to attribute conversions based on views. Default value: `DAY_7`
|
|
11549
12449
|
*/
|
|
11550
12450
|
viewThroughAttributionWindowSize: string;
|
|
12451
|
+
/**
|
|
12452
|
+
* Field usage depends on `service` value:
|
|
12453
|
+
* - Service `adyen`: Your Adyen Web Service API key.
|
|
12454
|
+
*/
|
|
12455
|
+
webServiceApiKey: string;
|
|
11551
12456
|
/**
|
|
11552
12457
|
* Field usage depends on `service` value:
|
|
11553
12458
|
* - Service `appsflyer`: Webhook Url
|
|
@@ -11924,6 +12829,11 @@ export interface GetConnectorConfigReport {
|
|
|
11924
12829
|
*/
|
|
11925
12830
|
filterType: string;
|
|
11926
12831
|
filterValue: string;
|
|
12832
|
+
/**
|
|
12833
|
+
* Field usage depends on `service` value:
|
|
12834
|
+
* - Service `workday`: Select this option to generate a Primary Key for reports where no single column or combination of columns can be used to form a Primary Key.
|
|
12835
|
+
*/
|
|
12836
|
+
generateFivetranPk: boolean;
|
|
11927
12837
|
/**
|
|
11928
12838
|
* Field usage depends on `service` value:
|
|
11929
12839
|
* - Service `googleAnalytics`: The report metrics to include into a sync.
|
|
@@ -11937,6 +12847,16 @@ export interface GetConnectorConfigReport {
|
|
|
11937
12847
|
* - Service `googleAnalytics4`: The name of the Prebuilt Report from which the connector will sync the data.
|
|
11938
12848
|
*/
|
|
11939
12849
|
prebuiltReport: string;
|
|
12850
|
+
/**
|
|
12851
|
+
* Field usage depends on `service` value:
|
|
12852
|
+
* - Service `workday`: Primary Keys
|
|
12853
|
+
*/
|
|
12854
|
+
primaryKeys: string[];
|
|
12855
|
+
/**
|
|
12856
|
+
* Field usage depends on `service` value:
|
|
12857
|
+
* - Service `workday`: This is to select report format from JSON and CSV. By default, report format is JSON.
|
|
12858
|
+
*/
|
|
12859
|
+
reportFormatType: string;
|
|
11940
12860
|
/**
|
|
11941
12861
|
* Field usage depends on `service` value:
|
|
11942
12862
|
* - Service `googleAds`: The name of the Google Ads report from which the connector will sync the data. [Possible reportType values](https://developers.google.com/adwords/api/docs/appendix/reports#report-types).
|
|
@@ -11944,6 +12864,11 @@ export interface GetConnectorConfigReport {
|
|
|
11944
12864
|
* - Service `googleSearchConsole`: The type of report
|
|
11945
12865
|
*/
|
|
11946
12866
|
reportType: string;
|
|
12867
|
+
/**
|
|
12868
|
+
* Field usage depends on `service` value:
|
|
12869
|
+
* - Service `workday`: URL for a live custom report.
|
|
12870
|
+
*/
|
|
12871
|
+
reportUrl: string;
|
|
11947
12872
|
/**
|
|
11948
12873
|
* Field usage depends on `service` value:
|
|
11949
12874
|
* - Service `googleAnalytics4`: The custom window size for rollback syncs.
|
|
@@ -11961,6 +12886,11 @@ export interface GetConnectorConfigReport {
|
|
|
11961
12886
|
* - Service `googleSearchAds360`: The report segments included to sync.
|
|
11962
12887
|
*/
|
|
11963
12888
|
segments: string[];
|
|
12889
|
+
/**
|
|
12890
|
+
* Field usage depends on `service` value:
|
|
12891
|
+
* - Service `workday`: This option is to unpack the nested columns and sync them separately. By default, we sync the nested columns as JSON objects.
|
|
12892
|
+
*/
|
|
12893
|
+
supportNestedColumns: boolean;
|
|
11964
12894
|
/**
|
|
11965
12895
|
* Field usage depends on `service` value:
|
|
11966
12896
|
* - Service `googleAds`: The table name within the schema to which connector will sync the data of the specific report.
|
|
@@ -11968,6 +12898,7 @@ export interface GetConnectorConfigReport {
|
|
|
11968
12898
|
* - Service `googleAnalytics4`: The table name within the schema to which connector will sync the data of the specific report.
|
|
11969
12899
|
* - Service `googleSearchAds360`: The name of a table within the schema to which connector syncs the data of a given report.
|
|
11970
12900
|
* - Service `googleSearchConsole`: The name of a table within the schema to which connector syncs the data of a given report.
|
|
12901
|
+
* - Service `workday`: The table name within the schema to which connector will sync the data of the specific report.
|
|
11971
12902
|
*/
|
|
11972
12903
|
table: string;
|
|
11973
12904
|
/**
|
|
@@ -12151,6 +13082,88 @@ export interface GetConnectorStatusWarning {
|
|
|
12151
13082
|
*/
|
|
12152
13083
|
message: string;
|
|
12153
13084
|
}
|
|
13085
|
+
export interface GetConnectorsConnector {
|
|
13086
|
+
/**
|
|
13087
|
+
* The unique identifier of the user who has created the connector in your account.
|
|
13088
|
+
*/
|
|
13089
|
+
connectedBy: string;
|
|
13090
|
+
/**
|
|
13091
|
+
* The timestamp of the time the connector was created in your account.
|
|
13092
|
+
*/
|
|
13093
|
+
createdAt: string;
|
|
13094
|
+
/**
|
|
13095
|
+
* The optional parameter that defines the sync start time when the sync frequency is already set or being set by the current request to 1440. It can be specified in one hour increments starting from 00:00 to 23:00. If not specified, we will use [the baseline sync start time](https://fivetran.com/docs/getting-started/syncoverview#syncfrequencyandscheduling). This parameter has no effect on the [0 to 60 minutes offset](https://fivetran.com/docs/getting-started/syncoverview#syncstarttimesandoffsets) used to determine the actual sync start time.
|
|
13096
|
+
*/
|
|
13097
|
+
dailySyncTime: string;
|
|
13098
|
+
/**
|
|
13099
|
+
* The level of data delay notification threshold. Possible values: LOW, NORMAL, HIGH, CUSTOM. The default value NORMAL. CUSTOM is only available for customers using the Enterprise plan or above.
|
|
13100
|
+
*/
|
|
13101
|
+
dataDelaySensitivity: string;
|
|
13102
|
+
/**
|
|
13103
|
+
* Custom sync delay notification threshold in minutes. The default value is 0. This parameter is only used when data*delay*sensitivity set to CUSTOM.
|
|
13104
|
+
*/
|
|
13105
|
+
dataDelayThreshold: number;
|
|
13106
|
+
/**
|
|
13107
|
+
* The timestamp of the time the connector sync failed last time.
|
|
13108
|
+
*/
|
|
13109
|
+
failedAt: string;
|
|
13110
|
+
/**
|
|
13111
|
+
* The unique identifier for the Group (Destination) within the Fivetran system.
|
|
13112
|
+
*/
|
|
13113
|
+
groupId: string;
|
|
13114
|
+
/**
|
|
13115
|
+
* The hybrid deployment agent ID that refers to the controller created for the group the connection belongs to. If the value is specified, the system will try to associate the connection with an existing agent.
|
|
13116
|
+
*/
|
|
13117
|
+
hybridDeploymentAgentId: string;
|
|
13118
|
+
/**
|
|
13119
|
+
* The unique identifier for the connector within the Fivetran system.
|
|
13120
|
+
*/
|
|
13121
|
+
id: string;
|
|
13122
|
+
/**
|
|
13123
|
+
* The name used both as the connector's name within the Fivetran system and as the source schema's name within your destination.
|
|
13124
|
+
*/
|
|
13125
|
+
name: string;
|
|
13126
|
+
/**
|
|
13127
|
+
* Possible values: Directly, SshTunnel, ProxyAgent.
|
|
13128
|
+
*/
|
|
13129
|
+
networkingMethod: string;
|
|
13130
|
+
/**
|
|
13131
|
+
* Specifies whether the connector should be paused after the free trial period has ended.
|
|
13132
|
+
*/
|
|
13133
|
+
pauseAfterTrial: boolean;
|
|
13134
|
+
/**
|
|
13135
|
+
* Specifies whether the connector is paused.
|
|
13136
|
+
*/
|
|
13137
|
+
paused: boolean;
|
|
13138
|
+
/**
|
|
13139
|
+
* The private link ID.
|
|
13140
|
+
*/
|
|
13141
|
+
privateLinkId: string;
|
|
13142
|
+
/**
|
|
13143
|
+
* The proxy agent ID.
|
|
13144
|
+
*/
|
|
13145
|
+
proxyAgentId: string;
|
|
13146
|
+
/**
|
|
13147
|
+
* The connector schedule configuration type. Supported values: auto, manual.
|
|
13148
|
+
*/
|
|
13149
|
+
scheduleType: string;
|
|
13150
|
+
/**
|
|
13151
|
+
* The connector type id within the Fivetran system.
|
|
13152
|
+
*/
|
|
13153
|
+
service: string;
|
|
13154
|
+
/**
|
|
13155
|
+
* The connector type version within the Fivetran system.
|
|
13156
|
+
*/
|
|
13157
|
+
serviceVersion: string;
|
|
13158
|
+
/**
|
|
13159
|
+
* The timestamp of the time the connector sync succeeded last time.
|
|
13160
|
+
*/
|
|
13161
|
+
succeededAt: string;
|
|
13162
|
+
/**
|
|
13163
|
+
* The connector sync frequency in minutes.
|
|
13164
|
+
*/
|
|
13165
|
+
syncFrequency: number;
|
|
13166
|
+
}
|
|
12154
13167
|
export interface GetConnectorsMetadataSource {
|
|
12155
13168
|
/**
|
|
12156
13169
|
* The description characterizing the purpose of the connector.
|
|
@@ -12323,10 +13336,23 @@ export interface GetDestinationConfig {
|
|
|
12323
13336
|
auth: string;
|
|
12324
13337
|
/**
|
|
12325
13338
|
* Field usage depends on `service` value:
|
|
13339
|
+
* - Service `adls`: Authentication type
|
|
12326
13340
|
* - Service `databricks`: Authentication type
|
|
13341
|
+
* - Service `newS3Datalake`: Authentication type
|
|
13342
|
+
* - Service `onelake`: Authentication type
|
|
12327
13343
|
* - Service `redshift`: Authentication type. Default value: `PASSWORD`.
|
|
12328
13344
|
*/
|
|
12329
13345
|
authType: string;
|
|
13346
|
+
/**
|
|
13347
|
+
* Field usage depends on `service` value:
|
|
13348
|
+
* - Service `newS3Datalake`: AWS access key to access the S3 bucket and AWS Glue
|
|
13349
|
+
*/
|
|
13350
|
+
awsAccessKeyId: string;
|
|
13351
|
+
/**
|
|
13352
|
+
* Field usage depends on `service` value:
|
|
13353
|
+
* - Service `newS3Datalake`: AWS secret access key to access the S3 bucket and AWS Glue
|
|
13354
|
+
*/
|
|
13355
|
+
awsSecretAccessKey: string;
|
|
12330
13356
|
/**
|
|
12331
13357
|
* Field usage depends on `service` value:
|
|
12332
13358
|
* - Service `confluentCloudWh`: Comma-separated list of Confluent Cloud servers in the `server:port` format.
|
|
@@ -12337,12 +13363,15 @@ export interface GetDestinationConfig {
|
|
|
12337
13363
|
* - Service `bigQuery`: Customer bucket. If specified, your GCS bucket will be used to process the data instead of a Fivetran-managed bucket. The bucket must be present in the same location as the dataset location.
|
|
12338
13364
|
* - Service `bigQueryDts`: Customer bucket. If specified, your GCS bucket will be used to process the data instead of a Fivetran-managed bucket. The bucket must be present in the same location as the dataset location.
|
|
12339
13365
|
* - Service `managedBigQuery`: Customer bucket. If specified, your GCS bucket will be used to process the data instead of a Fivetran-managed bucket. The bucket must be present in the same location as the dataset location.
|
|
12340
|
-
* - Service `newS3Datalake`: The name of the bucket to be used as destination
|
|
13366
|
+
* - Service `newS3Datalake`: (Immutable) The name of the bucket to be used as destination
|
|
12341
13367
|
*/
|
|
12342
13368
|
bucket: string;
|
|
12343
13369
|
/**
|
|
12344
13370
|
* Field usage depends on `service` value:
|
|
13371
|
+
* - Service `adls`: Catalog name
|
|
12345
13372
|
* - Service `databricks`: Catalog name
|
|
13373
|
+
* - Service `newS3Datalake`: Catalog name
|
|
13374
|
+
* - Service `onelake`: Catalog name
|
|
12346
13375
|
*/
|
|
12347
13376
|
catalog: string;
|
|
12348
13377
|
/**
|
|
@@ -12398,7 +13427,7 @@ export interface GetDestinationConfig {
|
|
|
12398
13427
|
connectionType: string;
|
|
12399
13428
|
/**
|
|
12400
13429
|
* Field usage depends on `service` value:
|
|
12401
|
-
* - Service `adls`: Container to store delta table files
|
|
13430
|
+
* - Service `adls`: (Immutable) Container to store delta table files
|
|
12402
13431
|
* - Service `onelake`: Workspace name to store delta table files
|
|
12403
13432
|
*/
|
|
12404
13433
|
containerName: string;
|
|
@@ -12443,6 +13472,13 @@ export interface GetDestinationConfig {
|
|
|
12443
13472
|
* - Service `sqlServerWarehouse`: Database name
|
|
12444
13473
|
*/
|
|
12445
13474
|
database: string;
|
|
13475
|
+
/**
|
|
13476
|
+
* Field usage depends on `service` value:
|
|
13477
|
+
* - Service `adls`: Databricks Connection method. Default value: `Directly`.
|
|
13478
|
+
* - Service `newS3Datalake`: Databricks Connection method. Default value: `Directly`.
|
|
13479
|
+
* - Service `onelake`: Databricks Connection method. Default value: `Directly`.
|
|
13480
|
+
*/
|
|
13481
|
+
databricksConnectionType: string;
|
|
12446
13482
|
enableRemoteExecution: boolean;
|
|
12447
13483
|
/**
|
|
12448
13484
|
* Field usage depends on `service` value:
|
|
@@ -12489,7 +13525,10 @@ export interface GetDestinationConfig {
|
|
|
12489
13525
|
host: string;
|
|
12490
13526
|
/**
|
|
12491
13527
|
* Field usage depends on `service` value:
|
|
13528
|
+
* - Service `adls`: HTTP path
|
|
12492
13529
|
* - Service `databricks`: HTTP path
|
|
13530
|
+
* - Service `newS3Datalake`: HTTP path
|
|
13531
|
+
* - Service `onelake`: HTTP path
|
|
12493
13532
|
*/
|
|
12494
13533
|
httpPath: string;
|
|
12495
13534
|
/**
|
|
@@ -12509,7 +13548,12 @@ export interface GetDestinationConfig {
|
|
|
12509
13548
|
isRedshiftServerless: boolean;
|
|
12510
13549
|
/**
|
|
12511
13550
|
* Field usage depends on `service` value:
|
|
12512
|
-
* - Service `onelake`:
|
|
13551
|
+
* - Service `onelake`: (Immutable) OneLake lakehouse GUID
|
|
13552
|
+
*/
|
|
13553
|
+
lakehouseGuid: string;
|
|
13554
|
+
/**
|
|
13555
|
+
* Field usage depends on `service` value:
|
|
13556
|
+
* - Service `onelake`: (Immutable) Name of your lakehouse
|
|
12513
13557
|
*/
|
|
12514
13558
|
lakehouseName: string;
|
|
12515
13559
|
mskStsRegion: string;
|
|
@@ -12520,12 +13564,18 @@ export interface GetDestinationConfig {
|
|
|
12520
13564
|
numOfPartitions: number;
|
|
12521
13565
|
/**
|
|
12522
13566
|
* Field usage depends on `service` value:
|
|
13567
|
+
* - Service `adls`: OAuth 2.0 client ID
|
|
12523
13568
|
* - Service `databricks`: OAuth 2.0 client ID
|
|
13569
|
+
* - Service `newS3Datalake`: OAuth 2.0 client ID
|
|
13570
|
+
* - Service `onelake`: OAuth 2.0 client ID
|
|
12524
13571
|
*/
|
|
12525
13572
|
oauth2ClientId: string;
|
|
12526
13573
|
/**
|
|
12527
13574
|
* Field usage depends on `service` value:
|
|
13575
|
+
* - Service `adls`: OAuth 2.0 secret
|
|
12528
13576
|
* - Service `databricks`: OAuth 2.0 secret
|
|
13577
|
+
* - Service `newS3Datalake`: OAuth 2.0 secret
|
|
13578
|
+
* - Service `onelake`: OAuth 2.0 secret
|
|
12529
13579
|
*/
|
|
12530
13580
|
oauth2Secret: string;
|
|
12531
13581
|
/**
|
|
@@ -12558,11 +13608,15 @@ export interface GetDestinationConfig {
|
|
|
12558
13608
|
password: string;
|
|
12559
13609
|
/**
|
|
12560
13610
|
* Field usage depends on `service` value:
|
|
13611
|
+
* - Service `adls`: Personal access token
|
|
12561
13612
|
* - Service `databricks`: Personal access token
|
|
13613
|
+
* - Service `newS3Datalake`: Personal access token
|
|
13614
|
+
* - Service `onelake`: Personal access token
|
|
12562
13615
|
*/
|
|
12563
13616
|
personalAccessToken: string;
|
|
12564
13617
|
/**
|
|
12565
13618
|
* Field usage depends on `service` value:
|
|
13619
|
+
* - Service `adls`: Server port number
|
|
12566
13620
|
* - Service `auroraPostgresWarehouse`: Server port number
|
|
12567
13621
|
* - Service `auroraWarehouse`: Server port number
|
|
12568
13622
|
* - Service `azurePostgresWarehouse`: Server port number
|
|
@@ -12574,6 +13628,8 @@ export interface GetDestinationConfig {
|
|
|
12574
13628
|
* - Service `mariaWarehouse`: Server port number
|
|
12575
13629
|
* - Service `mysqlRdsWarehouse`: Server port number
|
|
12576
13630
|
* - Service `mysqlWarehouse`: Server port number
|
|
13631
|
+
* - Service `newS3Datalake`: Server port number
|
|
13632
|
+
* - Service `onelake`: Server port number
|
|
12577
13633
|
* - Service `panoply`: Server port number
|
|
12578
13634
|
* - Service `periscopeWarehouse`: Server port number
|
|
12579
13635
|
* - Service `postgresGcpWarehouse`: Server port number
|
|
@@ -12587,9 +13643,9 @@ export interface GetDestinationConfig {
|
|
|
12587
13643
|
port: number;
|
|
12588
13644
|
/**
|
|
12589
13645
|
* Field usage depends on `service` value:
|
|
12590
|
-
* - Service `adls`: path/to/data within the container
|
|
12591
|
-
* - Service `newS3Datalake`: Prefix path of the bucket for which you have configured access policy. It is not required if access has been granted to entire Bucket in the access policy
|
|
12592
|
-
* - Service `onelake`: path/to/data within your lakehouse inside the Files directory
|
|
13646
|
+
* - Service `adls`: (Immutable) path/to/data within the container
|
|
13647
|
+
* - Service `newS3Datalake`: (Immutable) Prefix path of the bucket for which you have configured access policy. It is not required if access has been granted to entire Bucket in the access policy
|
|
13648
|
+
* - Service `onelake`: (Immutable) path/to/data within your lakehouse inside the Files directory
|
|
12593
13649
|
*/
|
|
12594
13650
|
prefixPath: string;
|
|
12595
13651
|
/**
|
|
@@ -12726,9 +13782,19 @@ export interface GetDestinationConfig {
|
|
|
12726
13782
|
securityProtocol: string;
|
|
12727
13783
|
/**
|
|
12728
13784
|
* Field usage depends on `service` value:
|
|
13785
|
+
* - Service `adls`: Server Host name
|
|
12729
13786
|
* - Service `databricks`: Server name
|
|
13787
|
+
* - Service `newS3Datalake`: Server host name
|
|
13788
|
+
* - Service `onelake`: Server Host name
|
|
12730
13789
|
*/
|
|
12731
13790
|
serverHostName: string;
|
|
13791
|
+
/**
|
|
13792
|
+
* Field usage depends on `service` value:
|
|
13793
|
+
* - Service `adls`: Should maintain tables in Databricks
|
|
13794
|
+
* - Service `newS3Datalake`: Should maintain tables in Databricks
|
|
13795
|
+
* - Service `onelake`: Should maintain tables in Databricks
|
|
13796
|
+
*/
|
|
13797
|
+
shouldMaintainTablesInDatabricks: boolean;
|
|
12732
13798
|
/**
|
|
12733
13799
|
* Field usage depends on `service` value:
|
|
12734
13800
|
* - Service `adls`: Snapshots older than the retention period are deleted every week. Default value: `ONE_WEEK`.
|
|
@@ -12740,8 +13806,8 @@ export interface GetDestinationConfig {
|
|
|
12740
13806
|
snowflakeRegion: string;
|
|
12741
13807
|
/**
|
|
12742
13808
|
* Field usage depends on `service` value:
|
|
12743
|
-
* - Service `adls`: Storage account for Azure Data Lake Storage Gen2 name
|
|
12744
|
-
* - Service `onelake`: Storage account for Azure Data Lake Storage Gen2 name
|
|
13809
|
+
* - Service `adls`: (Immutable) Storage account for Azure Data Lake Storage Gen2 name
|
|
13810
|
+
* - Service `onelake`: (Immutable) Storage account for Azure Data Lake Storage Gen2 name
|
|
12745
13811
|
*/
|
|
12746
13812
|
storageAccountName: string;
|
|
12747
13813
|
/**
|
|
@@ -12844,6 +13910,11 @@ export interface GetDestinationConfig {
|
|
|
12844
13910
|
* - Service `sqlServerWarehouse`: Database user name
|
|
12845
13911
|
*/
|
|
12846
13912
|
user: string;
|
|
13913
|
+
/**
|
|
13914
|
+
* Field usage depends on `service` value:
|
|
13915
|
+
* - Service `onelake`: (Immutable) OneLake workspace GUID
|
|
13916
|
+
*/
|
|
13917
|
+
workspaceGuid: string;
|
|
12847
13918
|
/**
|
|
12848
13919
|
* Field usage depends on `service` value:
|
|
12849
13920
|
* - Service `onelake`: OneLake workspace name
|
|
@@ -12868,6 +13939,48 @@ export interface GetDestinationFingerprintsFingerprint {
|
|
|
12868
13939
|
*/
|
|
12869
13940
|
validatedDate: string;
|
|
12870
13941
|
}
|
|
13942
|
+
export interface GetDestinationsDestination {
|
|
13943
|
+
/**
|
|
13944
|
+
* Shift my UTC offset with daylight savings time (US Only)
|
|
13945
|
+
*/
|
|
13946
|
+
daylightSavingTimeEnabled: boolean;
|
|
13947
|
+
/**
|
|
13948
|
+
* The unique identifier for the Group within the Fivetran system.
|
|
13949
|
+
*/
|
|
13950
|
+
groupId: string;
|
|
13951
|
+
/**
|
|
13952
|
+
* The hybrid deployment agent ID that refers to the controller created for the group the connection belongs to. If the value is specified, the system will try to associate the connection with an existing agent.
|
|
13953
|
+
*/
|
|
13954
|
+
hybridDeploymentAgentId: string;
|
|
13955
|
+
/**
|
|
13956
|
+
* The unique identifier for the destination within the Fivetran system.
|
|
13957
|
+
*/
|
|
13958
|
+
id: string;
|
|
13959
|
+
/**
|
|
13960
|
+
* Possible values: Directly, SshTunnel, ProxyAgent.
|
|
13961
|
+
*/
|
|
13962
|
+
networkingMethod: string;
|
|
13963
|
+
/**
|
|
13964
|
+
* The private link ID.
|
|
13965
|
+
*/
|
|
13966
|
+
privateLinkId: string;
|
|
13967
|
+
/**
|
|
13968
|
+
* Data processing location. This is where Fivetran will operate and run computation on data.
|
|
13969
|
+
*/
|
|
13970
|
+
region: string;
|
|
13971
|
+
/**
|
|
13972
|
+
* The destination type id within the Fivetran system.
|
|
13973
|
+
*/
|
|
13974
|
+
service: string;
|
|
13975
|
+
/**
|
|
13976
|
+
* Destination setup status.
|
|
13977
|
+
*/
|
|
13978
|
+
setupStatus: string;
|
|
13979
|
+
/**
|
|
13980
|
+
* Determines the time zone for the Fivetran sync schedule.
|
|
13981
|
+
*/
|
|
13982
|
+
timeZoneOffset: string;
|
|
13983
|
+
}
|
|
12871
13984
|
export interface GetExternalLoggingConfig {
|
|
12872
13985
|
/**
|
|
12873
13986
|
* API Key
|
|
@@ -12930,6 +14043,20 @@ export interface GetExternalLoggingConfig {
|
|
|
12930
14043
|
*/
|
|
12931
14044
|
workspaceId?: string;
|
|
12932
14045
|
}
|
|
14046
|
+
export interface GetExternalLogsLog {
|
|
14047
|
+
/**
|
|
14048
|
+
* The boolean value specifying whether the log service is enabled.
|
|
14049
|
+
*/
|
|
14050
|
+
enabled: boolean;
|
|
14051
|
+
/**
|
|
14052
|
+
* The unique identifier for the log service within the Fivetran system.
|
|
14053
|
+
*/
|
|
14054
|
+
id: string;
|
|
14055
|
+
/**
|
|
14056
|
+
* The name for the log service type within the Fivetran system. We support the following log services: azure*monitor*log, cloudwatch, datadog*log, new*relic_log, splunkLog, stackdriver.
|
|
14057
|
+
*/
|
|
14058
|
+
service: string;
|
|
14059
|
+
}
|
|
12933
14060
|
export interface GetGroupConnectorsConnector {
|
|
12934
14061
|
/**
|
|
12935
14062
|
* The unique identifier of the user who has created the connector in your account
|
|
@@ -13109,53 +14236,6 @@ export interface GetHybridDeploymentAgentsItem {
|
|
|
13109
14236
|
*/
|
|
13110
14237
|
registeredAt: string;
|
|
13111
14238
|
}
|
|
13112
|
-
export interface GetLocalProcessingAgentUsage {
|
|
13113
|
-
/**
|
|
13114
|
-
* The unique identifier of the connection associated with the agent.
|
|
13115
|
-
*/
|
|
13116
|
-
connectionId: string;
|
|
13117
|
-
/**
|
|
13118
|
-
* The connection schema name.
|
|
13119
|
-
*/
|
|
13120
|
-
schema: string;
|
|
13121
|
-
/**
|
|
13122
|
-
* The connection type.
|
|
13123
|
-
*/
|
|
13124
|
-
service: string;
|
|
13125
|
-
}
|
|
13126
|
-
export interface GetLocalProcessingAgentsItem {
|
|
13127
|
-
/**
|
|
13128
|
-
* The unique name for the local processing agent.
|
|
13129
|
-
*/
|
|
13130
|
-
displayName: string;
|
|
13131
|
-
/**
|
|
13132
|
-
* The unique identifier for the Group within the Fivetran system.
|
|
13133
|
-
*/
|
|
13134
|
-
groupId: string;
|
|
13135
|
-
/**
|
|
13136
|
-
* The unique identifier for the local processing agent within your account.
|
|
13137
|
-
*/
|
|
13138
|
-
id: string;
|
|
13139
|
-
/**
|
|
13140
|
-
* The timestamp of the time the local processing agent was created in your account.
|
|
13141
|
-
*/
|
|
13142
|
-
registeredAt: string;
|
|
13143
|
-
usages: outputs.GetLocalProcessingAgentsItemUsage[];
|
|
13144
|
-
}
|
|
13145
|
-
export interface GetLocalProcessingAgentsItemUsage {
|
|
13146
|
-
/**
|
|
13147
|
-
* The unique identifier of the connection associated with the agent.
|
|
13148
|
-
*/
|
|
13149
|
-
connectionId: string;
|
|
13150
|
-
/**
|
|
13151
|
-
* The connection schema name.
|
|
13152
|
-
*/
|
|
13153
|
-
schema: string;
|
|
13154
|
-
/**
|
|
13155
|
-
* The connection type.
|
|
13156
|
-
*/
|
|
13157
|
-
service: string;
|
|
13158
|
-
}
|
|
13159
14239
|
export interface GetPrivateLinksItem {
|
|
13160
14240
|
/**
|
|
13161
14241
|
* The cloud provider name.
|
|
@@ -13224,6 +14304,28 @@ export interface GetProxyAgentsItem {
|
|
|
13224
14304
|
*/
|
|
13225
14305
|
token: string;
|
|
13226
14306
|
}
|
|
14307
|
+
export interface GetQuickstartPackagesPackage {
|
|
14308
|
+
/**
|
|
14309
|
+
* The set of connector types
|
|
14310
|
+
*/
|
|
14311
|
+
connectorTypes: string[];
|
|
14312
|
+
/**
|
|
14313
|
+
* The unique identifier for the Quickstart transformation package definition within the Fivetran system
|
|
14314
|
+
*/
|
|
14315
|
+
id: string;
|
|
14316
|
+
/**
|
|
14317
|
+
* The Quickstart transformation package name
|
|
14318
|
+
*/
|
|
14319
|
+
name: string;
|
|
14320
|
+
/**
|
|
14321
|
+
* The list of transformation output models
|
|
14322
|
+
*/
|
|
14323
|
+
outputModelNames: string[];
|
|
14324
|
+
/**
|
|
14325
|
+
* The Quickstart package definition version
|
|
14326
|
+
*/
|
|
14327
|
+
version: string;
|
|
14328
|
+
}
|
|
13227
14329
|
export interface GetRolesRole {
|
|
13228
14330
|
/**
|
|
13229
14331
|
* The role description
|
|
@@ -13298,6 +14400,232 @@ export interface GetTeamsTeam {
|
|
|
13298
14400
|
*/
|
|
13299
14401
|
role: string;
|
|
13300
14402
|
}
|
|
14403
|
+
export interface GetTransformationProjectProjectConfig {
|
|
14404
|
+
/**
|
|
14405
|
+
* The version of transformation that should run the project
|
|
14406
|
+
*/
|
|
14407
|
+
dbtVersion: string;
|
|
14408
|
+
/**
|
|
14409
|
+
* Default schema in destination. This production schema will contain your transformed data.
|
|
14410
|
+
*/
|
|
14411
|
+
defaultSchema: string;
|
|
14412
|
+
/**
|
|
14413
|
+
* List of environment variables defined as key-value pairs in the raw string format using = as a separator. The variable name should have the DBT_ prefix and can contain A-Z, 0-9, dash, underscore, or dot characters. Example: "DBT*VARIABLE=variable*value"
|
|
14414
|
+
*/
|
|
14415
|
+
environmentVars: string[];
|
|
14416
|
+
/**
|
|
14417
|
+
* Folder in Git repo with your transformation project
|
|
14418
|
+
*/
|
|
14419
|
+
folderPath: string;
|
|
14420
|
+
/**
|
|
14421
|
+
* Git branch
|
|
14422
|
+
*/
|
|
14423
|
+
gitBranch: string;
|
|
14424
|
+
/**
|
|
14425
|
+
* Git remote URL with your transformation project
|
|
14426
|
+
*/
|
|
14427
|
+
gitRemoteUrl: string;
|
|
14428
|
+
/**
|
|
14429
|
+
* Public key to grant Fivetran SSH access to git repository.
|
|
14430
|
+
*/
|
|
14431
|
+
publicKey: string;
|
|
14432
|
+
/**
|
|
14433
|
+
* Target name to set or override the value from the deployment.yaml
|
|
14434
|
+
*/
|
|
14435
|
+
targetName: string;
|
|
14436
|
+
/**
|
|
14437
|
+
* The number of threads transformation will use (from 1 to 32). Make sure this value is compatible with your destination type. For example, Snowflake supports only 8 concurrent queries on an X-Small warehouse.
|
|
14438
|
+
*/
|
|
14439
|
+
threads: number;
|
|
14440
|
+
}
|
|
14441
|
+
export interface GetTransformationProjectsProject {
|
|
14442
|
+
/**
|
|
14443
|
+
* The timestamp of when the project was created in your account.
|
|
14444
|
+
*/
|
|
14445
|
+
createdAt: string;
|
|
14446
|
+
/**
|
|
14447
|
+
* The unique identifier for the User within the Fivetran system who created the transformation Project.
|
|
14448
|
+
*/
|
|
14449
|
+
createdById: string;
|
|
14450
|
+
/**
|
|
14451
|
+
* The name of the group within your account related to the project.
|
|
14452
|
+
*/
|
|
14453
|
+
groupId: string;
|
|
14454
|
+
/**
|
|
14455
|
+
* The unique identifier for the transformation project within the Fivetran system.
|
|
14456
|
+
*/
|
|
14457
|
+
id: string;
|
|
14458
|
+
/**
|
|
14459
|
+
* Transformation project type.
|
|
14460
|
+
*/
|
|
14461
|
+
type: string;
|
|
14462
|
+
}
|
|
14463
|
+
export interface GetTransformationSchedule {
|
|
14464
|
+
/**
|
|
14465
|
+
* The list of the connection identifiers to be used for the integrated schedule. Not expected for QUICKSTART transformations
|
|
14466
|
+
*/
|
|
14467
|
+
connectionIds: string[];
|
|
14468
|
+
/**
|
|
14469
|
+
* Cron schedule: list of CRON strings. Used for for CRON schedule type
|
|
14470
|
+
*/
|
|
14471
|
+
crons: string[];
|
|
14472
|
+
/**
|
|
14473
|
+
* The set of the days of the week the transformation should be launched on. The following values are supported: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY. Used for for INTEGRATED schedule type
|
|
14474
|
+
*/
|
|
14475
|
+
daysOfWeeks: string[];
|
|
14476
|
+
/**
|
|
14477
|
+
* The time interval in minutes between subsequent transformation runs. Used for for INTERVAL schedule type
|
|
14478
|
+
*/
|
|
14479
|
+
interval: number;
|
|
14480
|
+
/**
|
|
14481
|
+
* The type of the schedule to run the Transformation on. The following values are supported: INTEGRATED, TIME*OF*DAY, INTERVAL, CRON.
|
|
14482
|
+
*/
|
|
14483
|
+
scheduleType: string;
|
|
14484
|
+
/**
|
|
14485
|
+
* The boolean flag that enables the Smart Syncing schedule
|
|
14486
|
+
*/
|
|
14487
|
+
smartSyncing: boolean;
|
|
14488
|
+
/**
|
|
14489
|
+
* The time of the day the transformation should be launched at. Supported values are: "00:00", "01:00", "02:00", "03:00", "04:00", "05:00", "06:00", "07:00", "08:00", "09:00", "10:00", "11:00", "12:00", "13:00", "14:00", "15:00", "16:00", "17:00", "18:00", "19:00", "20:00", "21:00", "22:00", "23:00". Used for for TIME*OF*DAY schedule type
|
|
14490
|
+
*/
|
|
14491
|
+
timeOfDay: string;
|
|
14492
|
+
}
|
|
14493
|
+
export interface GetTransformationTransformationConfig {
|
|
14494
|
+
/**
|
|
14495
|
+
* The list of the connection identifiers to be used for the integrated schedule. Also used to identify package*name automatically if package*name was not specified
|
|
14496
|
+
*/
|
|
14497
|
+
connectionIds: string[];
|
|
14498
|
+
/**
|
|
14499
|
+
* The list of excluded output model names
|
|
14500
|
+
*/
|
|
14501
|
+
excludedModels: string[];
|
|
14502
|
+
/**
|
|
14503
|
+
* The transformation name
|
|
14504
|
+
*/
|
|
14505
|
+
name: string;
|
|
14506
|
+
/**
|
|
14507
|
+
* The Quickstart transformation package name
|
|
14508
|
+
*/
|
|
14509
|
+
packageName: string;
|
|
14510
|
+
/**
|
|
14511
|
+
* The unique identifier for the dbt Core project within the Fivetran system
|
|
14512
|
+
*/
|
|
14513
|
+
projectId: string;
|
|
14514
|
+
steps: outputs.GetTransformationTransformationConfigStep[];
|
|
14515
|
+
/**
|
|
14516
|
+
* The boolean flag indicating that a newer version is available for the transformation package
|
|
14517
|
+
*/
|
|
14518
|
+
upgradeAvailable: boolean;
|
|
14519
|
+
}
|
|
14520
|
+
export interface GetTransformationTransformationConfigStep {
|
|
14521
|
+
/**
|
|
14522
|
+
* The dbt command in the transformation step
|
|
14523
|
+
*/
|
|
14524
|
+
command: string;
|
|
14525
|
+
/**
|
|
14526
|
+
* The step name
|
|
14527
|
+
*/
|
|
14528
|
+
name: string;
|
|
14529
|
+
}
|
|
14530
|
+
export interface GetTransformationsTransformation {
|
|
14531
|
+
/**
|
|
14532
|
+
* The timestamp of when the transformation was created in your account.
|
|
14533
|
+
*/
|
|
14534
|
+
createdAt: string;
|
|
14535
|
+
/**
|
|
14536
|
+
* The unique identifier for the User within the Fivetran system who created the transformation.
|
|
14537
|
+
*/
|
|
14538
|
+
createdById: string;
|
|
14539
|
+
/**
|
|
14540
|
+
* The unique identifier for the Transformation within the Fivetran system.
|
|
14541
|
+
*/
|
|
14542
|
+
id: string;
|
|
14543
|
+
/**
|
|
14544
|
+
* Identifiers of related models.
|
|
14545
|
+
*/
|
|
14546
|
+
outputModelNames: string[];
|
|
14547
|
+
/**
|
|
14548
|
+
* The field indicating whether the transformation will be set into the paused state. By default, the value is false.
|
|
14549
|
+
*/
|
|
14550
|
+
paused: boolean;
|
|
14551
|
+
schedule?: outputs.GetTransformationsTransformationSchedule;
|
|
14552
|
+
/**
|
|
14553
|
+
* Status of transformation Project (NOT_READY, READY, ERROR).
|
|
14554
|
+
*/
|
|
14555
|
+
status: string;
|
|
14556
|
+
transformationConfig?: outputs.GetTransformationsTransformationTransformationConfig;
|
|
14557
|
+
/**
|
|
14558
|
+
* Transformation type. The following values are supported: DBT_CORE, QUICKSTART.
|
|
14559
|
+
*/
|
|
14560
|
+
type: string;
|
|
14561
|
+
}
|
|
14562
|
+
export interface GetTransformationsTransformationSchedule {
|
|
14563
|
+
/**
|
|
14564
|
+
* The list of the connection identifiers to be used for the integrated schedule. Not expected for QUICKSTART transformations
|
|
14565
|
+
*/
|
|
14566
|
+
connectionIds: string[];
|
|
14567
|
+
/**
|
|
14568
|
+
* Cron schedule: list of CRON strings. Used for for CRON schedule type
|
|
14569
|
+
*/
|
|
14570
|
+
crons: string[];
|
|
14571
|
+
/**
|
|
14572
|
+
* The set of the days of the week the transformation should be launched on. The following values are supported: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY. Used for for INTEGRATED schedule type
|
|
14573
|
+
*/
|
|
14574
|
+
daysOfWeeks: string[];
|
|
14575
|
+
/**
|
|
14576
|
+
* The time interval in minutes between subsequent transformation runs. Used for for INTERVAL schedule type
|
|
14577
|
+
*/
|
|
14578
|
+
interval: number;
|
|
14579
|
+
/**
|
|
14580
|
+
* The type of the schedule to run the Transformation on. The following values are supported: INTEGRATED, TIME*OF*DAY, INTERVAL, CRON.
|
|
14581
|
+
*/
|
|
14582
|
+
scheduleType: string;
|
|
14583
|
+
/**
|
|
14584
|
+
* The boolean flag that enables the Smart Syncing schedule
|
|
14585
|
+
*/
|
|
14586
|
+
smartSyncing: boolean;
|
|
14587
|
+
/**
|
|
14588
|
+
* The time of the day the transformation should be launched at. Supported values are: "00:00", "01:00", "02:00", "03:00", "04:00", "05:00", "06:00", "07:00", "08:00", "09:00", "10:00", "11:00", "12:00", "13:00", "14:00", "15:00", "16:00", "17:00", "18:00", "19:00", "20:00", "21:00", "22:00", "23:00". Used for for TIME*OF*DAY schedule type
|
|
14589
|
+
*/
|
|
14590
|
+
timeOfDay: string;
|
|
14591
|
+
}
|
|
14592
|
+
export interface GetTransformationsTransformationTransformationConfig {
|
|
14593
|
+
/**
|
|
14594
|
+
* The list of the connection identifiers to be used for the integrated schedule. Also used to identify package*name automatically if package*name was not specified
|
|
14595
|
+
*/
|
|
14596
|
+
connectionIds: string[];
|
|
14597
|
+
/**
|
|
14598
|
+
* The list of excluded output model names
|
|
14599
|
+
*/
|
|
14600
|
+
excludedModels: string[];
|
|
14601
|
+
/**
|
|
14602
|
+
* The transformation name
|
|
14603
|
+
*/
|
|
14604
|
+
name: string;
|
|
14605
|
+
/**
|
|
14606
|
+
* The Quickstart transformation package name
|
|
14607
|
+
*/
|
|
14608
|
+
packageName: string;
|
|
14609
|
+
/**
|
|
14610
|
+
* The unique identifier for the dbt Core project within the Fivetran system
|
|
14611
|
+
*/
|
|
14612
|
+
projectId: string;
|
|
14613
|
+
steps: outputs.GetTransformationsTransformationTransformationConfigStep[];
|
|
14614
|
+
/**
|
|
14615
|
+
* The boolean flag indicating that a newer version is available for the transformation package
|
|
14616
|
+
*/
|
|
14617
|
+
upgradeAvailable: boolean;
|
|
14618
|
+
}
|
|
14619
|
+
export interface GetTransformationsTransformationTransformationConfigStep {
|
|
14620
|
+
/**
|
|
14621
|
+
* The dbt command in the transformation step
|
|
14622
|
+
*/
|
|
14623
|
+
command: string;
|
|
14624
|
+
/**
|
|
14625
|
+
* The step name
|
|
14626
|
+
*/
|
|
14627
|
+
name: string;
|
|
14628
|
+
}
|
|
13301
14629
|
export interface GetUserConnectorMembershipsConnector {
|
|
13302
14630
|
/**
|
|
13303
14631
|
* The connector unique identifier
|
|
@@ -13424,20 +14752,6 @@ export interface GroupUsersUser {
|
|
|
13424
14752
|
*/
|
|
13425
14753
|
role: string;
|
|
13426
14754
|
}
|
|
13427
|
-
export interface LocalProcessingAgentUsage {
|
|
13428
|
-
/**
|
|
13429
|
-
* The unique identifier of the connection associated with the agent.
|
|
13430
|
-
*/
|
|
13431
|
-
connectionId: string;
|
|
13432
|
-
/**
|
|
13433
|
-
* The connection schema name.
|
|
13434
|
-
*/
|
|
13435
|
-
schema: string;
|
|
13436
|
-
/**
|
|
13437
|
-
* The connection type.
|
|
13438
|
-
*/
|
|
13439
|
-
service: string;
|
|
13440
|
-
}
|
|
13441
14755
|
export interface TeamConnectorMembershipConnector {
|
|
13442
14756
|
/**
|
|
13443
14757
|
* The connector unique identifier
|
|
@@ -13476,6 +14790,111 @@ export interface TeamUserMembershipUser {
|
|
|
13476
14790
|
*/
|
|
13477
14791
|
userId: string;
|
|
13478
14792
|
}
|
|
14793
|
+
export interface TransformationProjectProjectConfig {
|
|
14794
|
+
/**
|
|
14795
|
+
* The version of transformation that should run the project
|
|
14796
|
+
*/
|
|
14797
|
+
dbtVersion?: string;
|
|
14798
|
+
/**
|
|
14799
|
+
* Default schema in destination. This production schema will contain your transformed data.
|
|
14800
|
+
*/
|
|
14801
|
+
defaultSchema?: string;
|
|
14802
|
+
/**
|
|
14803
|
+
* List of environment variables defined as key-value pairs in the raw string format using = as a separator. The variable name should have the DBT_ prefix and can contain A-Z, 0-9, dash, underscore, or dot characters. Example: "DBT*VARIABLE=variable*value"
|
|
14804
|
+
*/
|
|
14805
|
+
environmentVars?: string[];
|
|
14806
|
+
/**
|
|
14807
|
+
* Folder in Git repo with your transformation project
|
|
14808
|
+
*/
|
|
14809
|
+
folderPath?: string;
|
|
14810
|
+
/**
|
|
14811
|
+
* Git branch
|
|
14812
|
+
*/
|
|
14813
|
+
gitBranch?: string;
|
|
14814
|
+
/**
|
|
14815
|
+
* Git remote URL with your transformation project
|
|
14816
|
+
*/
|
|
14817
|
+
gitRemoteUrl?: string;
|
|
14818
|
+
/**
|
|
14819
|
+
* Public key to grant Fivetran SSH access to git repository.
|
|
14820
|
+
*/
|
|
14821
|
+
publicKey: string;
|
|
14822
|
+
/**
|
|
14823
|
+
* Target name to set or override the value from the deployment.yaml
|
|
14824
|
+
*/
|
|
14825
|
+
targetName?: string;
|
|
14826
|
+
/**
|
|
14827
|
+
* The number of threads transformation will use (from 1 to 32). Make sure this value is compatible with your destination type. For example, Snowflake supports only 8 concurrent queries on an X-Small warehouse.
|
|
14828
|
+
*/
|
|
14829
|
+
threads: number;
|
|
14830
|
+
}
|
|
14831
|
+
export interface TransformationSchedule {
|
|
14832
|
+
/**
|
|
14833
|
+
* The list of the connection identifiers to be used for the integrated schedule. Not expected for QUICKSTART transformations
|
|
14834
|
+
*/
|
|
14835
|
+
connectionIds?: string[];
|
|
14836
|
+
/**
|
|
14837
|
+
* Cron schedule: list of CRON strings. Used for for CRON schedule type
|
|
14838
|
+
*/
|
|
14839
|
+
crons?: string[];
|
|
14840
|
+
/**
|
|
14841
|
+
* The set of the days of the week the transformation should be launched on. The following values are supported: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY. Used for for INTEGRATED schedule type
|
|
14842
|
+
*/
|
|
14843
|
+
daysOfWeeks?: string[];
|
|
14844
|
+
/**
|
|
14845
|
+
* The time interval in minutes between subsequent transformation runs. Used for for INTERVAL schedule type
|
|
14846
|
+
*/
|
|
14847
|
+
interval: number;
|
|
14848
|
+
/**
|
|
14849
|
+
* The type of the schedule to run the Transformation on. The following values are supported: INTEGRATED, TIME*OF*DAY, INTERVAL, CRON.
|
|
14850
|
+
*/
|
|
14851
|
+
scheduleType: string;
|
|
14852
|
+
/**
|
|
14853
|
+
* The boolean flag that enables the Smart Syncing schedule
|
|
14854
|
+
*/
|
|
14855
|
+
smartSyncing: boolean;
|
|
14856
|
+
/**
|
|
14857
|
+
* The time of the day the transformation should be launched at. Supported values are: "00:00", "01:00", "02:00", "03:00", "04:00", "05:00", "06:00", "07:00", "08:00", "09:00", "10:00", "11:00", "12:00", "13:00", "14:00", "15:00", "16:00", "17:00", "18:00", "19:00", "20:00", "21:00", "22:00", "23:00". Used for for TIME*OF*DAY schedule type
|
|
14858
|
+
*/
|
|
14859
|
+
timeOfDay?: string;
|
|
14860
|
+
}
|
|
14861
|
+
export interface TransformationTransformationConfig {
|
|
14862
|
+
/**
|
|
14863
|
+
* The list of the connection identifiers to be used for the integrated schedule. Also used to identify package*name automatically if package*name was not specified
|
|
14864
|
+
*/
|
|
14865
|
+
connectionIds?: string[];
|
|
14866
|
+
/**
|
|
14867
|
+
* The list of excluded output model names
|
|
14868
|
+
*/
|
|
14869
|
+
excludedModels?: string[];
|
|
14870
|
+
/**
|
|
14871
|
+
* The transformation name
|
|
14872
|
+
*/
|
|
14873
|
+
name?: string;
|
|
14874
|
+
/**
|
|
14875
|
+
* The Quickstart transformation package name
|
|
14876
|
+
*/
|
|
14877
|
+
packageName?: string;
|
|
14878
|
+
/**
|
|
14879
|
+
* The unique identifier for the dbt Core project within the Fivetran system
|
|
14880
|
+
*/
|
|
14881
|
+
projectId?: string;
|
|
14882
|
+
steps?: outputs.TransformationTransformationConfigStep[];
|
|
14883
|
+
/**
|
|
14884
|
+
* The boolean flag indicating that a newer version is available for the transformation package
|
|
14885
|
+
*/
|
|
14886
|
+
upgradeAvailable: boolean;
|
|
14887
|
+
}
|
|
14888
|
+
export interface TransformationTransformationConfigStep {
|
|
14889
|
+
/**
|
|
14890
|
+
* The dbt command in the transformation step
|
|
14891
|
+
*/
|
|
14892
|
+
command?: string;
|
|
14893
|
+
/**
|
|
14894
|
+
* The step name
|
|
14895
|
+
*/
|
|
14896
|
+
name?: string;
|
|
14897
|
+
}
|
|
13479
14898
|
export interface UserConnectorMembershipConnector {
|
|
13480
14899
|
/**
|
|
13481
14900
|
* The connector unique identifier
|