CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

1.3.5

Added

• FieldStatus field to connector metadata Property deserialization.

1.3.4

Added

• Nullable, Format, and Immutable fields to connector metadata Property deserialization.

1.3.3

Fixed

• Deserialization of SetupTestResponse field Details, to be of type interface{}.

1.3.2

Added

• connector_sdk module with full Connector SDK package CRUD support: Create, Get, List, Update, Delete.
• ConnectorSdkPackageData type with FileSha256Hash field for package integrity verification.
• DoMultipart() method on HttpService for multipart/form-data file uploads (used by package Create and Update).
• Client methods: NewConnectorSdkPackageCreate(), NewConnectorSdkPackageDetails(), NewConnectorSdkPackageUpdate(), NewConnectorSdkPackageDelete(), NewConnectorSdkPackageList().

1.3.1

Added

• ConfigurableVariables field (map[string]interface{}) to transformationConfigResponse, deserializing configurable_variables from GET /transformations/{id} and GET /transformations responses.
• ConfigurableVariables field (*map[string]interface{}) to transformationConfigRequest, serializing configurable_variables in POST /transformations and PATCH /transformations/{id} requests.
• configurableVariables field to TransformationConfig builder struct with ConfigurableVariables(value map[string]interface{}) builder method.

Changed

• Renamed ConfigurableVarDefinition to ConfigurableVariableDefinition to align with the API field name (configurable_variables).
• Renamed ConfigurableVars field on quickstartPackageResponseBase to ConfigurableVariables.

1.3.0

Added

• ConfigurableVarDefinition struct with fields Type, Description, AllowedValues for Quickstart package configurable variable definitions.
• ConfigurableVars field (map[string]ConfigurableVarDefinition) to quickstartPackageResponseBase, deserializing configurable_variables from GET /transformations/package-metadata/{id} and GET /transformations/package-metadata responses.

1.2.9

Added

• destination_schema_names field for creating Connection.

1.2.8

Added

Support flexible sync schedule for connector:

• ConnectorSchedule struct with fields ScheduleType, Cron, DaysOfWeek, Interval, TimeOfDay
• ConnectionUpdateService.Schedule method
• DetailsResponseDataCommon.Schedule field in response

1.2.7

Added

Support Proxy Agent Id in Destination API:

• DestinationCreateService.proxyAgentId
• DestinationModifyService.proxyAgentId
• DestinationDetailsService.proxyAgentId

1.2.6

Added

Support for custom config (map[string]interface{}) for external log details:

• ExternalLoggingDetailsService.DoCustom method
• ExternalLoggingDetailsService.DoCustomMerged method

1.2.5

Added

Support for custom config (map[string]interface{}) for destinations:

• DestinationSetupTestsService.DoCustom method

1.2.4

Added

• AccountInfoService for getting information about current account from API key

1.2.3

Added

• GroupID and Schema methods to ConnectionsListService for filtering connection list by group ID and schema name

1.2.2

Added

• field Host into privatelink.PrivateLinkResponseBase

1.2.1

Updated

Change method in ProxyRegenerateSecretsService

1.2.0

Added

• fields ClientCert and ClientPrivateKey from proxy.ProxyCreateData Supported the following Fivetran API endpoint for Proxy Agents Management:
• Regenerate Secrets for Proxy Agent Supported the following Fivetran API endpoints:
• Retrieve connector configuration metadata
• Retrieve source metadata

Removed

• field ProxyServerUri from proxy.ProxyCreateData

Breaking changes

• Service ConnectionsSourceMetadataService replaced with MetadataListService

1.1.1

Re-release

• Re-release due to issues with https://pkg.go.dev/github.com/fivetran/go-fivetran

1.1.0

Added

• Add IsDeprecated, ReplacementRoleName to RolesListResponse

Updated

In order to synchronize terminology, we have renamed all services and structures that use incorrect terminology:

• connectors package is now called connections. All services, data structures, methods with names like Connector* are now named Connection*
• teams package - all nested services, data structures, methods with names like TeamConnector* are now named TeamConnection*
• users package - all nested services, data structures, methods with names like UserConnector* are now named UserConnection*
• certificates package - all nested services, data structures, methods with names like ConnectorCertificate* are now named ConnectionCertificate*
• fingerprints package - all nested services, data structures, methods with names like ConnectorFingerprint* are now named ConnectionFingerprint*
• GroupListConnectorsService are now named GroupListConnectionsService
• all services, data structures, methods with names like *Modify* are now named *Update*

Removed

Removed the following Fivetran API endpoints:

• Retrieve dbt model details
• Retrieve dbt models list
• Create dbt project
• Retrieve dbt projects list
• Retrieve dbt project details
• Update dbt project
• Delete dbt project
• Test dbt Project

1.0.7

Supported the following Fivetran API endpoints:

• List all destinations within account
• List all connectors within account
• List all Log Services

Our old API for dbt projects and transformations is marked as deprecated. Supported the following Fivetran API endpoints:

• Create Transformation Project
• Delete Transformation Project
• List all Transformation Projects within Account
• Retrieve Transformation Project Details
• Test Transformation Project
• Update Transformation Project
• Create Transformation
• Update Transformation
• Delete Transformation
• Retrieve Transformation Details
• List all Transformations within Account
• Upgrade Transformation Package
• Run Transformation
• Cancel Transformation
• List All Quickstart Package Metadata
• Retrieve Quickstart Package Metadata Details

1.0.6

Added

• Fields ConnectorModifyService.dataDelayThreshold and ConnectorModifyService.dataDelaySensitivity
• Fields ConnectorCreateService.dataDelayThreshold and ConnectorCreateService.dataDelaySensitivity

1.0.5

Added

• Add is_primary_key to ConnectorSchemaConfigColumn

1.0.4

Added

• Fix PrivateLinkCreateService.Do with PrivateLinkCreateService.ConfigCustom

1.0.3

Added

• Field HybridDeploymentAgentCreateService.authType
• Field HybridDeploymentAgentReAuthService.authType
• Field HybridDeploymentAgentCreateResponse.Token
• Service HybridDeploymentAgentResetCredentialsService

1.0.2

Added

Support for custom config (map[string]interface{}) for private links:

• PrivateLinkCreateService.ConfigCustom and PrivateLinkCreateService.DoCustom methods
• PrivateLinkModifyService.ConfigCustom and PrivateLinkModifyService.DoCustom methods
• PrivateLinkDetailsService.DoCustom method

1.0.1

Added

• PrivateDnsRegions field in privatelink.PrivateLinkConfig

1.0.0

Renamed the following service from Local Processing Agent to Hybrid Deployment Agent:

• LocalProcessingAgentCreateService to HybridDeploymentAgentCreateService
• LocalProcessingAgentListService to HybridDeploymentAgentListService
• LocalProcessingAgentDetailsService to HybridDeploymentAgentDetailsService
• LocalProcessingAgentDeleteService to HybridDeploymentAgentDeleteService
• LocalProcessingAgentReAuthService to HybridDeploymentAgentReAuthService

Rename fields:

• DestinationCreateService.localProcessingAgentId to DestinationCreateService.hybridDeploymentAgentId
• DestinationModifyService.localProcessingAgentId to DestinationCreateService.hybridDeploymentAgentId
• DestinationDetailsService.localProcessingAgentId to DestinationCreateService.hybridDeploymentAgentId
• ConnectorCreateService.localProcessingAgentId to DestinationCreateService.hybridDeploymentAgentId
• ConnectorModifyService.localProcessingAgentId to DestinationCreateService.hybridDeploymentAgentId
• ConnectorDetailsService.localProcessingAgentId to DestinationCreateService.hybridDeploymentAgentId

0.9.3

Supported the following Fivetran API endpoints:

• Transformations for dbt Core Management: Test dbt Project

0.9.2

Fixed

• Issue with DestinationConfigResponse.data.config.is_private_key_encrypted

0.9.1

Fixed

• Allow to pass nil into ConnectorCreateService.SyncFrequency and ConnectorModifyService.SyncFrequency.

0.9.0

Added

• Ability to modify gitRemoteUrl field in dbt.DbtProjectModifyService

Removed

• fields Token and Salt from proxy.ProxyData

0.8.8

Fixed

• Response model for Retrieve Source Table Columns Config fixed.

Added

• New field connectors.ConnectorSchemaConfigTableResponse.SupportsColumnsConfig added.

0.8.7

Added

Support for a new endpoints:

• Create a Connector Schema Config

0.8.6

Added

Supported the following Fivetran API endpoints for Local Processing Agent Management:

• Create a Local Processing Agent
• List Local Processing Agents
• Retrieve Local Processing Agent Details
• Delete a Local Processing Agent
• Regenerate authentication keys for a Local Processing Agent

Supported the following Fivetran API endpoints for Private Links Management::

• List all Private Links within Account

Added fields to support setting up Local Processing Agent in Destination API:

• DestinationCreateService.localProcessingAgentId
• DestinationModifyService.localProcessingAgentId
• DestinationDetailsService.localProcessingAgentId

Added fields to support setting up Private Link in Destination API:

• DestinationCreateService.privateLinkId
• DestinationModifyService.privateLinkId
• DestinationDetailsService.privateLinkId

Added fields to support setting up Networking Method in Destination API:

• DestinationCreateService.networkingMethod
• DestinationModifyService.networkingMethod
• DestinationDetailsService.networkingMethod

Added fields to support setting up Local Processing Agent in Connector API:

• ConnectorCreateService.localProcessingAgentId
• ConnectorModifyService.localProcessingAgentId
• ConnectorDetailsService.localProcessingAgentId

Added fields to support setting up Proxy Agent in Connector API:

• ConnectorCreateService.proxyAgentId
• ConnectorModifyService.proxyAgentId
• ConnectorDetailsService.proxyAgentId

Added fields to support setting up Private Link in Connector API:

• ConnectorCreateService.privateLinkId
• ConnectorModifyService.privateLinkId
• ConnectorDetailsService.privateLinkId

Added fields to support setting up Networking Method in Connector API:

• ConnectorCreateService.networkingMethod
• ConnectorModifyService.networkingMethod
• ConnectorDetailsService.networkingMethod

Removed

Removed the following deprecated Fivetran API endpoints for Proxy Agents Management:

• Attach connection to the proxy agent
• Detach connection from the proxy agent

Removed the following deprecated Fivetran API endpoints for Private Links Management:

• List all Private Links within Group

0.8.5

Added

Supported the following Fivetran API endpoints for Proxy Agents Management:

• Create a Proxy Agent
• List all Proxy Agents
• Retrieve Proxy Agent Details
• Delete a Proxy Agent
• Return all connections attached to the proxy agent
• Attach connection to the proxy agent
• Detach connection from the proxy agent

0.8.4

Added

Added fields to support Shift my UTC offset with daylight savings time (US Only) in Destination API:

• DestinationCreateService.daylightSavingTimeEnabled
• DestinationModifyService.daylightSavingTimeEnabled
• DestinationDetailsService.daylightSavingTimeEnabled

Removed unneccessary field service from Private Links API PrivateLinksCreateService

0.8.3

Added

Support for custom config (map[string]interface{}) for destinations:

• DestinationCreateService.ConfigCustom and DestinationCreateService.DoCustom methods
• DestinationModifyService.ConfigCustom and DestinationModifyService.DoCustom methods
• DestinationDetailsService.DoCustom method

0.8.2

Added

Supported the following Fivetran API endpoints for Private Links Management:

• Create a Private Link
• List all Private Links within Group
• Retrieve Private Link Details
• Update a Private Link
• Delete a Private Link

0.8.0

Added

Supported the following Fivetran API endpoints:

• User Management API Connector memberships: List all connector memberships
• User Management API Connector memberships: Retrieve connector membership
• User Management API Connector memberships: Add connector membership
• User Management API Connector memberships: Update connector membership
• User Management API Connector memberships: Delete connector membership
• User Management API Group memberships: List all group memberships
• User Management API Group memberships: Retrieve group membership
• User Management API Group memberships: Add group membership
• User Management API Group memberships: Update group membership
• User Management API Group memberships: Delete group membership

Added fields to support Google Cloud Logging:

• ExternalLoggingConfig.projectId

0.7.15

Added

• Support for Retrieve Group Service Account endpoint.
• Support for Retrieve Group Public SSH Key endpoint.

0.7.14

Added

• Support for missing auth fields for connectors.
• OneLake Data-Lake support.

0.7.13

Added

Added fields to support Azure Data Lake Storage:

• DestinationConfig.storageAccountName
• DestinationConfig.containerName
• DestinationConfig.tenantId
• DestinationConfig.clientId
• DestinationConfig.secretValue

0.7.12

Added

Supported the following Fivetran API endpoints:

• List all approved certificates for connector
• List all approved fingerprints for connector
• Retrieve a connector certificate details
• Retrieve a connector fingerprint details
• Revoke a connector certificate
• Revoke a connector fingerprint
• List all approved certificates for destination
• List all approved fingerprints for destination
• Retrieve a destination certificate details
• Retrieve a destination fingerprint details
• Revoke a destination certificate
• Revoke a destination fingerprint
• Modify a connector database schema config
• Modify a connector table config
• Modify a connector column config
• Connect Card

Updated

Extended response object for the following endpoints:

• Approve a connector certificate
• Approve a connector fingerprint
• Approve a destination certificate
• Approve a destination fingerprint

0.7.11

Added

Supported the following Fivetran API endpoints:

• Team Management API: List all teams
• Team Management API: Retrieve team details
• Team Management API: Create a team
• Team Management API: Modify a team
• Team Management API: Delete a team role in the account
• Team Management API: Delete a team
• Team Management API User memberships: List all user memberships
• Team Management API User memberships: Retrieve user membership
• Team Management API User memberships: Add a user to a team
• Team Management API User memberships: Modify a user membership
• Team Management API User memberships: Delete a user from a team
• Team Management API Connector memberships: List all connector memberships
• Team Management API Connector memberships: Retrieve connector membership
• Team Management API Connector memberships: Add connector membership
• Team Management API Connector memberships: Update connector membership
• Team Management API Connector memberships: Delete connector membership
• Team Management API Group memberships: List all group memberships
• Team Management API Group memberships: Retrieve group membership
• Team Management API Group memberships: Add group membership
• Team Management API Group memberships: Update group membership
• Team Management API Group memberships: Delete group membership

0.7.10

Fixed

• Fixed export NewWebhookTest method
• Fixed markup in the README file

0.7.9

Added

• Support for dbt Project status in responses.

0.7.8

Fixed

• Dbt Project setters renamed for consistency ProjectID -> DbtProjectID for all endpoints
• Fixed path for delete dbt project

0.7.7

Added

Supported the following Fivetran API endpoints:

• Retrieve dbt model details
• Retrieve dbt models list
• Create dbt project
• Retrieve dbt projects list
• Retrieve dbt project details
• Update dbt project
• Delete dbt project
• Retrieve schema metadata
• Retrieve table metadata
• Retrieve column metadata
• Create account webhook
• Create group webhook
• Retrieve webhook details
• Update webhook
• Delete webhook
• Retrieve the list of webhooks
• Test webhook
• List all roles

0.7.6

Fixes

• DBT Transformations: paused field update issue.

0.7.5

Fixed

• DBT Transformations: paused field supported.

Added

Supported the following Fivetran API endpoints:

• Create a Log Service
• Retrieve Log Service Details
• Update a Log Service
• Delete a Log Service
• Run Log Service Setup Tests

0.7.4

Added

• Automatic rate-limiting errors handling
• DBT Transformations API support: create, update, delete, get details

0.7.3

Added

• DestinationConfigResponse.FivetranRoleArn missing field added (S3 Data Lake)
• DestinationConfigResponse.PrefixPath missing field added (S3 Data Lake)
• DestinationConfigResponse.Region missing field added (S3 Data Lake)

0.7.2

Fix user/picture set to null issue (#55)

• delete methods for picture and phone
• tests
• refactoring of the picture and phone JSON marshalling + full test
• refactor - move nullableString to common file

0.7.1 - 2022-12-14

Fixed

• Connector response should be deserialized even if response code doesn't match expected to provide exact error that API returned.

0.7.0 - 2022-12-14

Added

• ConnectorConfig.ShareUrl missing field added
• ConnectorConfig.IsKeypair missing field added
• ConnectorConfig.SecretsList missing field added
• New approach that allows to pass connector configuration as raw map[string]interface{}
  • Connector<Operation>Service.ConfigCustom(config map[string]interface{}) method
  • Connector<Operation>Service.AuthCustom(auth map[string]interface{}) method
  • ConnectorCustom<Operation>Response types
  • NewConnector<Operation>Service.DoCustom() methods

0.6.10 - 2022-11-24

Fixed

• ConnectorConfigResponse.UseAPIKeys wrong type string -> bool
• ConnectorConfigResponse.IsSecure wrong type string -> bool
• ConnectorConfigResponse.SkipBefore wrong type int -> *int
• ConnectorConfigResponse.SkipAfter wrong type int -> *int

Added

• DestinationConfigResponse.Catalog missing field added (Databricks)

0.6.9 - 2022-10-04

Fixed

• DestinationConfigResponse.IsPrivateKeyEncrypted wrong type

0.6.8 - 2022-09-13

Added

• DestinationConfigResponse.Role missing field added (Snowflake)
• DestinationConfigResponse.IsPrivateKeyEncrypted missing field added (Snowflake)
• DestinationConfigResponse.Passphrase missing field added (Snowflake)

0.6.7 - 2022-08-29

Added

• ConnectorSchemaConfigTable.SyncMode field that allows to switch table sync mode

0.6.6 - 2022-08-15

Fixed

• DestinationConfigResponse.Location missing field added (field is used by BQ destination as data_set_location field)

0.6.5 - 2022-08-15

Fixed

• DestinationConfigResponse.PublicKey missing field added (field is readonly and represented only in response)
• DestinationConfigResponse.PrivateKey missing field added

0.6.4 - 2022-07-27

Added

Mock HttpClient class with a unit test example

Fixed

• ConnectorSchemaDetailsResponse.Data.Schemas type changed:
  • Old map[string]ConnectorSchemaConfigSchemaResponse
  • New map[string]*ConnectorSchemaConfigSchemaResponse

0.6.3 - 2022-07-20

Fixed

• ConnectorSchemaConfigTableResponse.EnabledPatchSettings missing field added
• ConnectorSchemaConfigTableResponse.NameInDestination missing field added
• ConnectorSchemaConfigSchemaResponse.NameInDestination missing field added

0.6.2 - 2022-07-20

Fixed

• ConnectorConfig.TokenKey missing field added
• ConnectorConfig.TokenSecret missing field added

0.6.1 - 2022-07-15

Fixed

• ConnectorSchemaConfigTableResponse type accesibility

0.6.0 - 2022-07-08

Added

Supported the following Fivetran API endpoints:

• Retrieve a Connector Schema Config
• Reload a Connector Schema Config
• Modify a Connector Schema Config

0.5.11 - 2022-07-05

Fixed

• ConnectorConfig.PAT missing field added (Personal Access Token for github connector)

0.5.10 - 2022-06-16

Fixed

• ConnectorConfig.EuRegion missing field added

0.5.9 - 2022-06-09

Fixed

• ConnectorConfig.PublicationName missing field added

0.5.8 - 2022-05-24

Fixed

• DestinationConfigResponse.CreateExternalTables field type updated

0.5.7 - 2022-05-13

Fixed

• ConnectorConfig.SkipBefore field transformed to type int
• ConnectorConfig.SkipAfter field transformed to type int

0.5.6 - 2022-04-26

Fixed

• ConnectorConfig.APIKeys field transformed to type []string
• ConnectorConfig.AccountIds field transfromed to type []string

0.5.5 - 2022-04-20

Fixed

• Added folder_id missed field to connector config.

0.5.4 - 2022-02-25

Fixed

• Added base_url missed field to connector config.
• Added entity_id missed field to connector config.
• Added soap_uri missed field to connector config.
• Added user_id missed field to connector config.
• Added encryption_key missed field to connector config.

0.5.3 - 2022-02-21

Fixed

• Added api_type missed field to connector config.

0.5.2 - 2022-01-31

Fixed

• Added is_multi_entity_feature_enabled missed field to connector config.
• Added always_encrypted missed field to connector config.

0.5.1 - 2022-01-31

Fixed

• Used connection_type key in destination config responses with v2 accept header for consistency.
• Added connection_type missed field to connector config.

0.5.0 - 2022-01-24

Added

The following fields were added to user resource responses

• UserDetailsResponse.Data.Role - RoleName for user role in account
• UserInviteResponse.Data.Role - RoleName for user role in account
• UserModifyResponse.Data.Role - RoleName for user role in account

0.4.0 - 2022-01-18

Added

• E2E tests. To be sure that SDK is stable we have added e2e tests which are triggered on each pull request to the main branch. Each e2e test has E2E suffix and located in a corresponding _test.go file.
• GitHub actions workflow to run tests on a testing account.

Fixed

• ConnectorConfigRequest.IsNewPackage missing field added
• ConnectorConfigRequest.AdobeAnalyticsConfigurations missing field added

0.3.1 - 2021-12-08

Fixed

• DestinationConfigRequest.ClusterId missing field added.
• DestinationConfigRequest.ClusterRegion missing field added.

0.3.0 - 2021-11-10

Added

• CustomUserAgent method for overriding User-Agent header in http-responses (for applications that uses SDK)

0.2.2 - 2021-09-22

Fixed

• DestinationConfigRequest.SecretKey missing field added.

0.2.1 - 2021-07-27

Fixed

• ConnectorConfigResponse.Port type is now *int as the response type has been fixed in the REST API v2.

0.2.0 - 2021-07-16

Added

• UsersListResponse.Role
• GroupListUsersResponse.Role
• ConnectorConfig.AuthType
• ConnectorCreateService.SyncFrequency
• ConnectorCreateService.DailySyncTime
• ConnectorCreateService.PauseAfterTrial
• ConnectorCreateResponse.Data.Paused
• ConnectorCreateResponse.Data.DailySyncTime
• ConnectorCreateResponse.Data.PauseAfterTrial
• ConnectorDetailsResponse.Data.Paused
• ConnectorDetailsResponse.Data.PauseAfterTrial
• ConnectorDetailsResponse.Data.DailySyncTime
• ConnectorModifyService.PauseAfterTrial

Changed

• ConnectorCreateService, ConnectorDetailsService, ConnectorModifyService, and ConnectorSetupTestsService are now using REST API v2.
• All int and bool fields of all response types are now *int and *bool.

Removed

• Removed the unnecessary ConnectorsSourceMetadataResponse.LinkToErd JSON annotation omitempty.

Fixed

• DestinationConfigResponse field ConnectionType has changed to ConnectionMethod to adequate to the REST API response.

0.1.0 - 2021-07-05

Initial release.

Added

• User Management API: List all Users, Retrieve user details, Invite a user, Modify a user, Delete a user.
• Group Management API: Create a group, List all groups, Retrieve group details, Modify a group, List all connectors within a group, List all users within a group, Add a user to a group, Remove a user from a group, Delete a group.
• Certificate Management API: Approve a connector certificate, Approve a connector fingerprint, Approve a destination certificate, Approve a destination fingerprint.
• Destination Management API: Create a destination, Retrieve destination details, Modify a destination, Run destination setup tests, Delete a destination, Destination Config.
• Connector Management API: Retrieve source metadata, Create a connector, Retrieve connector details, Modify a connector, Sync connector data, Re-sync connector table data, Run connector setup tests, Delete a connector, Connector Config, Connector Auth.