airbyte 0.7.0-beta2, Mar 7 25

airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq

airbyte.SourceHelpScout

Explore with Pulumi AI

airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq

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.SourceHelpScout;
import com.pulumi.airbyte.SourceHelpScoutArgs;
import com.pulumi.airbyte.inputs.SourceHelpScoutConfigurationArgs;
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 mySourceHelpscout = new SourceHelpScout("mySourceHelpscout", SourceHelpScoutArgs.builder()
            .configuration(SourceHelpScoutConfigurationArgs.builder()
                .client_id("...my_client_id...")
                .client_secret("...my_client_secret...")
                .start_date("2022-08-01T01:51:06.502Z")
                .build())
            .definitionId("4c8b8f51-7a25-4c17-a1ed-10ca39d831ee")
            .secretId("...my_secret_id...")
            .workspaceId("27ae639f-32a2-4107-9640-154f690b48dc")
            .build());

    }
}

resources:
  mySourceHelpscout:
    type: airbyte:SourceHelpScout
    properties:
      configuration:
        client_id: '...my_client_id...'
        client_secret: '...my_client_secret...'
        start_date: 2022-08-01T01:51:06.502Z
      definitionId: 4c8b8f51-7a25-4c17-a1ed-10ca39d831ee
      secretId: '...my_secret_id...'
      workspaceId: 27ae639f-32a2-4107-9640-154f690b48dc

Create SourceHelpScout Resource

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

Constructor syntax

new SourceHelpScout(name: string, args: SourceHelpScoutArgs, opts?: CustomResourceOptions);

@overload
def SourceHelpScout(resource_name: str,
                    args: SourceHelpScoutArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def SourceHelpScout(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    configuration: Optional[SourceHelpScoutConfigurationArgs] = None,
                    workspace_id: Optional[str] = None,
                    definition_id: Optional[str] = None,
                    name: Optional[str] = None,
                    secret_id: Optional[str] = None)

func NewSourceHelpScout(ctx *Context, name string, args SourceHelpScoutArgs, opts ...ResourceOption) (*SourceHelpScout, error)

public SourceHelpScout(string name, SourceHelpScoutArgs args, CustomResourceOptions? opts = null)

public SourceHelpScout(String name, SourceHelpScoutArgs args)
public SourceHelpScout(String name, SourceHelpScoutArgs args, CustomResourceOptions options)

type: airbyte:SourceHelpScout
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 SourceHelpScoutArgs: 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 SourceHelpScoutArgs: 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 SourceHelpScoutArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SourceHelpScoutArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args SourceHelpScoutArgs: 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 sourceHelpScoutResource = new Airbyte.SourceHelpScout("sourceHelpScoutResource", new()
{
    Configuration = new Airbyte.Inputs.SourceHelpScoutConfigurationArgs
    {
        ClientId = "string",
        ClientSecret = "string",
        StartDate = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});

example, err := airbyte.NewSourceHelpScout(ctx, "sourceHelpScoutResource", &airbyte.SourceHelpScoutArgs{
Configuration: &.SourceHelpScoutConfigurationArgs{
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
StartDate: pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})

var sourceHelpScoutResource = new SourceHelpScout("sourceHelpScoutResource", SourceHelpScoutArgs.builder()
    .configuration(SourceHelpScoutConfigurationArgs.builder()
        .clientId("string")
        .clientSecret("string")
        .startDate("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());

source_help_scout_resource = airbyte.SourceHelpScout("sourceHelpScoutResource",
    configuration={
        "client_id": "string",
        "client_secret": "string",
        "start_date": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")

const sourceHelpScoutResource = new airbyte.SourceHelpScout("sourceHelpScoutResource", {
    configuration: {
        clientId: "string",
        clientSecret: "string",
        startDate: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});

type: airbyte:SourceHelpScout
properties:
    configuration:
        clientId: string
        clientSecret: string
        startDate: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string

SourceHelpScout 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 SourceHelpScout resource accepts the following input properties:

Configuration SourceHelpScoutConfiguration
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 SourceHelpScoutConfigurationArgs
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 SourceHelpScoutConfiguration
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 SourceHelpScoutConfiguration
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 SourceHelpScoutConfigurationArgs
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 SourceHelpScout 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 SourceHelpScout Resource

Get an existing SourceHelpScout 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?: SourceHelpScoutState, opts?: CustomResourceOptions): SourceHelpScout

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceHelpScoutConfigurationArgs] = 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) -> SourceHelpScout

func GetSourceHelpScout(ctx *Context, name string, id IDInput, state *SourceHelpScoutState, opts ...ResourceOption) (*SourceHelpScout, error)

public static SourceHelpScout Get(string name, Input<string> id, SourceHelpScoutState? state, CustomResourceOptions? opts = null)

public static SourceHelpScout get(String name, Output<String> id, SourceHelpScoutState state, CustomResourceOptions options)

resources:  _:    type: airbyte:SourceHelpScout    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 SourceHelpScoutConfiguration
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 SourceHelpScoutConfigurationArgs
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 SourceHelpScoutConfiguration
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 SourceHelpScoutConfiguration
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 SourceHelpScoutConfigurationArgs
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

SourceHelpScoutConfiguration, SourceHelpScoutConfigurationArgs

ClientId string
ClientSecret string
StartDate string

ClientId string
ClientSecret string
StartDate string

clientId String
clientSecret String
startDate String

clientId string
clientSecret string
startDate string

client_id str
client_secret str
start_date str

clientId String
clientSecret String
startDate String

Import

$ pulumi import airbyte:index/sourceHelpScout:SourceHelpScout my_airbyte_source_help_scout ""

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 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq

airbytehq/terraform-provider-airbyte

airbyte.SourceHelpScout

On this page

On this page

Example Usage

Create SourceHelpScout Resource

Constructor syntax

Parameters

Constructor example

SourceHelpScout Resource Properties

Inputs

Outputs

Look up Existing SourceHelpScout Resource

Supporting Types

SourceHelpScoutConfiguration, SourceHelpScoutConfigurationArgs

Import

Package Details

On this page

On this page