Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Airbyte Provider
  3. API Docs
  4. SourceFreshsales
airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq
airbytehq/terraform-provider-airbyte

airbyte.SourceFreshsales

Explore with Pulumi AI

airbyte logo
airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq
airbytehq/terraform-provider-airbyte

    SourceFreshsales Resource

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.airbyte.SourceFreshsales;
import com.pulumi.airbyte.SourceFreshsalesArgs;
import com.pulumi.airbyte.inputs.SourceFreshsalesConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var mySourceFreshsales = new SourceFreshsales("mySourceFreshsales", SourceFreshsalesArgs.builder()
            .configuration(SourceFreshsalesConfigurationArgs.builder()
                .api_key("...my_api_key...")
                .domain_name("mydomain.myfreshworks.com")
                .build())
            .definitionId("7e6b9794-aab6-4906-9afe-0f7150bf456c")
            .secretId("...my_secret_id...")
            .workspaceId("2a428ffe-b32d-47b4-8a00-7e7ef3c8329d")
            .build());

    }
}

    resources:
  mySourceFreshsales:
    type: airbyte:SourceFreshsales
    properties:
      configuration:
        api_key: '...my_api_key...'
        domain_name: mydomain.myfreshworks.com
      definitionId: 7e6b9794-aab6-4906-9afe-0f7150bf456c
      secretId: '...my_secret_id...'
      workspaceId: 2a428ffe-b32d-47b4-8a00-7e7ef3c8329d

    Create SourceFreshsales Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new SourceFreshsales(name: string, args: SourceFreshsalesArgs, opts?: CustomResourceOptions);
    @overload
def SourceFreshsales(resource_name: str,
                     args: SourceFreshsalesArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def SourceFreshsales(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     configuration: Optional[SourceFreshsalesConfigurationArgs] = None,
                     workspace_id: Optional[str] = None,
                     definition_id: Optional[str] = None,
                     name: Optional[str] = None,
                     secret_id: Optional[str] = None)
    func NewSourceFreshsales(ctx *Context, name string, args SourceFreshsalesArgs, opts ...ResourceOption) (*SourceFreshsales, error)
    public SourceFreshsales(string name, SourceFreshsalesArgs args, CustomResourceOptions? opts = null)
    public SourceFreshsales(String name, SourceFreshsalesArgs args)
public SourceFreshsales(String name, SourceFreshsalesArgs args, CustomResourceOptions options)

    type: airbyte:SourceFreshsales
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args SourceFreshsalesArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SourceFreshsalesArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SourceFreshsalesArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SourceFreshsalesArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SourceFreshsalesArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var sourceFreshsalesResource = new Airbyte.SourceFreshsales("sourceFreshsalesResource", new()
{
    Configuration = new Airbyte.Inputs.SourceFreshsalesConfigurationArgs
    {
        ApiKey = "string",
        DomainName = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});

    example, err := airbyte.NewSourceFreshsales(ctx, "sourceFreshsalesResource", &airbyte.SourceFreshsalesArgs{
Configuration: &.SourceFreshsalesConfigurationArgs{
ApiKey: pulumi.String("string"),
DomainName: pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})

    var sourceFreshsalesResource = new SourceFreshsales("sourceFreshsalesResource", SourceFreshsalesArgs.builder()
    .configuration(SourceFreshsalesConfigurationArgs.builder()
        .apiKey("string")
        .domainName("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());

    source_freshsales_resource = airbyte.SourceFreshsales("sourceFreshsalesResource",
    configuration={
        "api_key": "string",
        "domain_name": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")

    const sourceFreshsalesResource = new airbyte.SourceFreshsales("sourceFreshsalesResource", {
    configuration: {
        apiKey: "string",
        domainName: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});

    type: airbyte:SourceFreshsales
properties:
    configuration:
        apiKey: string
        domainName: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string

    SourceFreshsales Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The SourceFreshsales resource accepts the following input properties:

    Configuration SourceFreshsalesConfiguration
    WorkspaceId string
    DefinitionId string
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    Name string
    Name of the source e.g. dev-mysql-instance.
    SecretId string
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    Configuration SourceFreshsalesConfigurationArgs
    WorkspaceId string
    DefinitionId string
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    Name string
    Name of the source e.g. dev-mysql-instance.
    SecretId string
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    configuration SourceFreshsalesConfiguration
    workspaceId String
    definitionId String
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    name String
    Name of the source e.g. dev-mysql-instance.
    secretId String
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    configuration SourceFreshsalesConfiguration
    workspaceId string
    definitionId string
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    name string
    Name of the source e.g. dev-mysql-instance.
    secretId string
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    configuration SourceFreshsalesConfigurationArgs
    workspace_id str
    definition_id str
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    name str
    Name of the source e.g. dev-mysql-instance.
    secret_id str
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    configuration Property Map
    workspaceId String
    definitionId String
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    name String
    Name of the source e.g. dev-mysql-instance.
    secretId String
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SourceFreshsales resource produces the following output properties:

    CreatedAt double
    Id string
    The provider-assigned unique ID for this managed resource.
    SourceId string
    SourceType string
    CreatedAt float64
    Id string
    The provider-assigned unique ID for this managed resource.
    SourceId string
    SourceType string
    createdAt Double
    id String
    The provider-assigned unique ID for this managed resource.
    sourceId String
    sourceType String
    createdAt number
    id string
    The provider-assigned unique ID for this managed resource.
    sourceId string
    sourceType string
    created_at float
    id str
    The provider-assigned unique ID for this managed resource.
    source_id str
    source_type str
    createdAt Number
    id String
    The provider-assigned unique ID for this managed resource.
    sourceId String
    sourceType String

    Look up Existing SourceFreshsales Resource

    Get an existing SourceFreshsales resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: SourceFreshsalesState, opts?: CustomResourceOptions): SourceFreshsales
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceFreshsalesConfigurationArgs] = None,
        created_at: Optional[float] = None,
        definition_id: Optional[str] = None,
        name: Optional[str] = None,
        secret_id: Optional[str] = None,
        source_id: Optional[str] = None,
        source_type: Optional[str] = None,
        workspace_id: Optional[str] = None) -> SourceFreshsales
    func GetSourceFreshsales(ctx *Context, name string, id IDInput, state *SourceFreshsalesState, opts ...ResourceOption) (*SourceFreshsales, error)
    public static SourceFreshsales Get(string name, Input<string> id, SourceFreshsalesState? state, CustomResourceOptions? opts = null)
    public static SourceFreshsales get(String name, Output<String> id, SourceFreshsalesState state, CustomResourceOptions options)
    resources:  _:    type: airbyte:SourceFreshsales    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Configuration SourceFreshsalesConfiguration
    CreatedAt double
    DefinitionId string
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    Name string
    Name of the source e.g. dev-mysql-instance.
    SecretId string
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    SourceId string
    SourceType string
    WorkspaceId string
    Configuration SourceFreshsalesConfigurationArgs
    CreatedAt float64
    DefinitionId string
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    Name string
    Name of the source e.g. dev-mysql-instance.
    SecretId string
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    SourceId string
    SourceType string
    WorkspaceId string
    configuration SourceFreshsalesConfiguration
    createdAt Double
    definitionId String
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    name String
    Name of the source e.g. dev-mysql-instance.
    secretId String
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    sourceId String
    sourceType String
    workspaceId String
    configuration SourceFreshsalesConfiguration
    createdAt number
    definitionId string
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    name string
    Name of the source e.g. dev-mysql-instance.
    secretId string
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    sourceId string
    sourceType string
    workspaceId string
    configuration SourceFreshsalesConfigurationArgs
    created_at float
    definition_id str
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    name str
    Name of the source e.g. dev-mysql-instance.
    secret_id str
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    source_id str
    source_type str
    workspace_id str
    configuration Property Map
    createdAt Number
    definitionId String
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    name String
    Name of the source e.g. dev-mysql-instance.
    secretId String
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    sourceId String
    sourceType String
    workspaceId String

    Supporting Types

    SourceFreshsalesConfiguration, SourceFreshsalesConfigurationArgs

    ApiKey string
    Freshsales API Key. See \n\nhere\n\n. The key is case sensitive.
    DomainName string
    The Name of your Freshsales domain
    ApiKey string
    Freshsales API Key. See \n\nhere\n\n. The key is case sensitive.
    DomainName string
    The Name of your Freshsales domain
    apiKey String
    Freshsales API Key. See \n\nhere\n\n. The key is case sensitive.
    domainName String
    The Name of your Freshsales domain
    apiKey string
    Freshsales API Key. See \n\nhere\n\n. The key is case sensitive.
    domainName string
    The Name of your Freshsales domain
    api_key str
    Freshsales API Key. See \n\nhere\n\n. The key is case sensitive.
    domain_name str
    The Name of your Freshsales domain
    apiKey String
    Freshsales API Key. See \n\nhere\n\n. The key is case sensitive.
    domainName String
    The Name of your Freshsales domain

    Import

    $ pulumi import airbyte:index/sourceFreshsales:SourceFreshsales my_airbyte_source_freshsales ""

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    airbyte airbytehq/terraform-provider-airbyte
    License
    Notes
    This Pulumi package is based on the airbyte Terraform Provider.
    airbyte logo
    airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq
    airbytehq/terraform-provider-airbyte