airbyte.SourceFreshbooks
Explore with Pulumi AI
SourceFreshbooks 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.SourceFreshbooks;
import com.pulumi.airbyte.SourceFreshbooksArgs;
import com.pulumi.airbyte.inputs.SourceFreshbooksConfigurationArgs;
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 mySourceFreshbooks = new SourceFreshbooks("mySourceFreshbooks", SourceFreshbooksArgs.builder()
            .configuration(SourceFreshbooksConfigurationArgs.builder()
                .account_id("...my_account_id...")
                .business_uuid("...my_business_uuid...")
                .client_id("...my_client_id...")
                .client_refresh_token("...my_client_refresh_token...")
                .client_secret("...my_client_secret...")
                .oauth_access_token("...my_oauth_access_token...")
                .oauth_token_expiry_date("2021-05-20T12:27:43.350Z")
                .redirect_uri("...my_redirect_uri...")
                .build())
            .definitionId("7501c030-944b-48f7-bbd3-48fb58904c1c")
            .secretId("...my_secret_id...")
            .workspaceId("53c1a948-4474-4eae-bf5b-7784e0932710")
            .build());
    }
}
resources:
  mySourceFreshbooks:
    type: airbyte:SourceFreshbooks
    properties:
      configuration:
        account_id: '...my_account_id...'
        business_uuid: '...my_business_uuid...'
        client_id: '...my_client_id...'
        client_refresh_token: '...my_client_refresh_token...'
        client_secret: '...my_client_secret...'
        oauth_access_token: '...my_oauth_access_token...'
        oauth_token_expiry_date: 2021-05-20T12:27:43.350Z
        redirect_uri: '...my_redirect_uri...'
      definitionId: 7501c030-944b-48f7-bbd3-48fb58904c1c
      secretId: '...my_secret_id...'
      workspaceId: 53c1a948-4474-4eae-bf5b-7784e0932710
Create SourceFreshbooks Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SourceFreshbooks(name: string, args: SourceFreshbooksArgs, opts?: CustomResourceOptions);@overload
def SourceFreshbooks(resource_name: str,
                     args: SourceFreshbooksArgs,
                     opts: Optional[ResourceOptions] = None)
@overload
def SourceFreshbooks(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     configuration: Optional[SourceFreshbooksConfigurationArgs] = None,
                     workspace_id: Optional[str] = None,
                     definition_id: Optional[str] = None,
                     name: Optional[str] = None,
                     secret_id: Optional[str] = None)func NewSourceFreshbooks(ctx *Context, name string, args SourceFreshbooksArgs, opts ...ResourceOption) (*SourceFreshbooks, error)public SourceFreshbooks(string name, SourceFreshbooksArgs args, CustomResourceOptions? opts = null)
public SourceFreshbooks(String name, SourceFreshbooksArgs args)
public SourceFreshbooks(String name, SourceFreshbooksArgs args, CustomResourceOptions options)
type: airbyte:SourceFreshbooks
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 SourceFreshbooksArgs
- 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 SourceFreshbooksArgs
- 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 SourceFreshbooksArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SourceFreshbooksArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SourceFreshbooksArgs
- 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 sourceFreshbooksResource = new Airbyte.SourceFreshbooks("sourceFreshbooksResource", new()
{
    Configuration = new Airbyte.Inputs.SourceFreshbooksConfigurationArgs
    {
        AccountId = "string",
        BusinessUuid = "string",
        ClientId = "string",
        ClientRefreshToken = "string",
        ClientSecret = "string",
        RedirectUri = "string",
        OauthAccessToken = "string",
        OauthTokenExpiryDate = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});
example, err := airbyte.NewSourceFreshbooks(ctx, "sourceFreshbooksResource", &airbyte.SourceFreshbooksArgs{
Configuration: &.SourceFreshbooksConfigurationArgs{
AccountId: pulumi.String("string"),
BusinessUuid: pulumi.String("string"),
ClientId: pulumi.String("string"),
ClientRefreshToken: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
RedirectUri: pulumi.String("string"),
OauthAccessToken: pulumi.String("string"),
OauthTokenExpiryDate: pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})
var sourceFreshbooksResource = new SourceFreshbooks("sourceFreshbooksResource", SourceFreshbooksArgs.builder()
    .configuration(SourceFreshbooksConfigurationArgs.builder()
        .accountId("string")
        .businessUuid("string")
        .clientId("string")
        .clientRefreshToken("string")
        .clientSecret("string")
        .redirectUri("string")
        .oauthAccessToken("string")
        .oauthTokenExpiryDate("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());
source_freshbooks_resource = airbyte.SourceFreshbooks("sourceFreshbooksResource",
    configuration={
        "account_id": "string",
        "business_uuid": "string",
        "client_id": "string",
        "client_refresh_token": "string",
        "client_secret": "string",
        "redirect_uri": "string",
        "oauth_access_token": "string",
        "oauth_token_expiry_date": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")
const sourceFreshbooksResource = new airbyte.SourceFreshbooks("sourceFreshbooksResource", {
    configuration: {
        accountId: "string",
        businessUuid: "string",
        clientId: "string",
        clientRefreshToken: "string",
        clientSecret: "string",
        redirectUri: "string",
        oauthAccessToken: "string",
        oauthTokenExpiryDate: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});
type: airbyte:SourceFreshbooks
properties:
    configuration:
        accountId: string
        businessUuid: string
        clientId: string
        clientRefreshToken: string
        clientSecret: string
        oauthAccessToken: string
        oauthTokenExpiryDate: string
        redirectUri: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string
SourceFreshbooks 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 SourceFreshbooks resource accepts the following input properties:
- Configuration
SourceFreshbooks Configuration 
- 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
SourceFreshbooks Configuration Args 
- 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
SourceFreshbooks Configuration 
- 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
SourceFreshbooks Configuration 
- 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
SourceFreshbooks Configuration Args 
- 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 SourceFreshbooks 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 SourceFreshbooks Resource
Get an existing SourceFreshbooks 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?: SourceFreshbooksState, opts?: CustomResourceOptions): SourceFreshbooks@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceFreshbooksConfigurationArgs] = 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) -> SourceFreshbooksfunc GetSourceFreshbooks(ctx *Context, name string, id IDInput, state *SourceFreshbooksState, opts ...ResourceOption) (*SourceFreshbooks, error)public static SourceFreshbooks Get(string name, Input<string> id, SourceFreshbooksState? state, CustomResourceOptions? opts = null)public static SourceFreshbooks get(String name, Output<String> id, SourceFreshbooksState state, CustomResourceOptions options)resources:  _:    type: airbyte:SourceFreshbooks    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.
- Configuration
SourceFreshbooks Configuration 
- 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
SourceFreshbooks Configuration Args 
- 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
SourceFreshbooks Configuration 
- 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
SourceFreshbooks Configuration 
- 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
SourceFreshbooks Configuration Args 
- 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
SourceFreshbooksConfiguration, SourceFreshbooksConfigurationArgs      
- AccountId string
- BusinessUuid string
- ClientId string
- ClientRefresh stringToken 
- ClientSecret string
- RedirectUri string
- OauthAccess stringToken 
- The current access token. This field might be overridden by the connector based on the token refresh endpoint response.
- OauthToken stringExpiry Date 
- The date the current access token expires in. This field might be overridden by the connector based on the token refresh endpoint response.
- AccountId string
- BusinessUuid string
- ClientId string
- ClientRefresh stringToken 
- ClientSecret string
- RedirectUri string
- OauthAccess stringToken 
- The current access token. This field might be overridden by the connector based on the token refresh endpoint response.
- OauthToken stringExpiry Date 
- The date the current access token expires in. This field might be overridden by the connector based on the token refresh endpoint response.
- accountId String
- businessUuid String
- clientId String
- clientRefresh StringToken 
- clientSecret String
- redirectUri String
- oauthAccess StringToken 
- The current access token. This field might be overridden by the connector based on the token refresh endpoint response.
- oauthToken StringExpiry Date 
- The date the current access token expires in. This field might be overridden by the connector based on the token refresh endpoint response.
- accountId string
- businessUuid string
- clientId string
- clientRefresh stringToken 
- clientSecret string
- redirectUri string
- oauthAccess stringToken 
- The current access token. This field might be overridden by the connector based on the token refresh endpoint response.
- oauthToken stringExpiry Date 
- The date the current access token expires in. This field might be overridden by the connector based on the token refresh endpoint response.
- account_id str
- business_uuid str
- client_id str
- client_refresh_ strtoken 
- client_secret str
- redirect_uri str
- oauth_access_ strtoken 
- The current access token. This field might be overridden by the connector based on the token refresh endpoint response.
- oauth_token_ strexpiry_ date 
- The date the current access token expires in. This field might be overridden by the connector based on the token refresh endpoint response.
- accountId String
- businessUuid String
- clientId String
- clientRefresh StringToken 
- clientSecret String
- redirectUri String
- oauthAccess StringToken 
- The current access token. This field might be overridden by the connector based on the token refresh endpoint response.
- oauthToken StringExpiry Date 
- The date the current access token expires in. This field might be overridden by the connector based on the token refresh endpoint response.
Import
$ pulumi import airbyte:index/sourceFreshbooks:SourceFreshbooks my_airbyte_source_freshbooks ""
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 airbyteTerraform Provider.