From cf6ebff012179977be00f1ff7ce31d61d4037c30 Mon Sep 17 00:00:00 2001 From: btkcodedev Date: Sat, 11 May 2024 23:00:14 +0530 Subject: [PATCH 1/5] feat: make compatable with builder --- .../connectors/source-insightly/metadata.yaml | 6 +- .../source-insightly/pyproject.toml | 2 +- .../source_insightly/manifest.yaml | 7655 ++++++++++------- docs/integrations/sources/insightly.md | 1 + 4 files changed, 4497 insertions(+), 3167 deletions(-) diff --git a/airbyte-integrations/connectors/source-insightly/metadata.yaml b/airbyte-integrations/connectors/source-insightly/metadata.yaml index 8bf2d9887f61..2f56df6d7fb7 100644 --- a/airbyte-integrations/connectors/source-insightly/metadata.yaml +++ b/airbyte-integrations/connectors/source-insightly/metadata.yaml @@ -4,13 +4,13 @@ data: sl: 100 allowedHosts: hosts: - - TODO + - api.na1.insightly.com connectorBuildOptions: baseImage: docker.io/airbyte/python-connector-base:1.2.0@sha256:c22a9d97464b69d6ef01898edf3f8612dc11614f05a84984451dde195f337db9 connectorSubtype: api connectorType: source definitionId: 38f84314-fe6a-4257-97be-a8dcd942d693 - dockerImageTag: 0.2.4 + dockerImageTag: 0.2.5 dockerRepository: airbyte/source-insightly documentationUrl: https://docs.airbyte.com/integrations/sources/insightly githubIssueLabel: source-insightly @@ -20,7 +20,7 @@ data: registries: cloud: enabled: true - dockerImageTag: 0.2.0 + dockerImageTag: 0.2.5 oss: enabled: true releaseStage: alpha diff --git a/airbyte-integrations/connectors/source-insightly/pyproject.toml b/airbyte-integrations/connectors/source-insightly/pyproject.toml index ce65f9a4eb4a..87ade47558e8 100644 --- a/airbyte-integrations/connectors/source-insightly/pyproject.toml +++ b/airbyte-integrations/connectors/source-insightly/pyproject.toml @@ -3,7 +3,7 @@ requires = [ "poetry-core>=1.0.0",] build-backend = "poetry.core.masonry.api" [tool.poetry] -version = "0.2.4" +version = "0.2.5" name = "source-insightly" description = "Source implementation for Insightly." authors = [ "Airbyte ",] diff --git a/airbyte-integrations/connectors/source-insightly/source_insightly/manifest.yaml b/airbyte-integrations/connectors/source-insightly/source_insightly/manifest.yaml index 5fdd957a1361..de5964a9d995 100644 --- a/airbyte-integrations/connectors/source-insightly/source_insightly/manifest.yaml +++ b/airbyte-integrations/connectors/source-insightly/source_insightly/manifest.yaml @@ -1,3186 +1,4515 @@ -version: "0.29.0" +version: 0.78.5 -definitions: - selector: - type: RecordSelector - extractor: - type: DpathExtractor - field_path: [] +type: DeclarativeSource + +check: + type: CheckStream + stream_names: + - activity_sets + - contacts - requester: +definitions: + streams: + activity_sets: + type: DeclarativeStream + name: activity_sets + primary_key: + - ACTIVITYSET_ID + retriever: + type: SimpleRetriever + requester: + $ref: '#/definitions/base_requester' + path: /ActivitySets + http_method: GET + request_parameters: + count_total: 'True' + updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + error_handler: + type: CompositeErrorHandler + error_handlers: + - type: DefaultErrorHandler + path: /ActivitySets + response_filters: + - type: HttpResponseFilter + http_codes: + - 403 + action: IGNORE + - type: DefaultErrorHandler + backoff_strategies: + - type: ConstantBackoffStrategy + backoff_time_in_seconds: 6 + response_filters: + - type: HttpResponseFilter + http_codes: + - 429 + action: RETRY + record_selector: + type: RecordSelector + extractor: + type: DpathExtractor + field_path: [] + paginator: + type: DefaultPaginator + page_token_option: + type: RequestOption + inject_into: request_parameter + field_name: skip + page_size_option: + type: RequestOption + inject_into: request_parameter + field_name: top + pagination_strategy: + type: OffsetIncrement + page_size: 500 + schema_loader: + type: InlineSchemaLoader + schema: + $ref: '#/schemas/activity_sets' + contacts: + type: DeclarativeStream + name: contacts + primary_key: + - CONTACT_ID + retriever: + type: SimpleRetriever + requester: + $ref: '#/definitions/base_requester' + path: /Contacts/Search + http_method: GET + request_parameters: + count_total: 'True' + updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + error_handler: + type: CompositeErrorHandler + error_handlers: + - type: DefaultErrorHandler + response_filters: + - type: HttpResponseFilter + http_codes: + - 403 + action: IGNORE + - type: DefaultErrorHandler + backoff_strategies: + - type: ConstantBackoffStrategy + backoff_time_in_seconds: 6 + response_filters: + - type: HttpResponseFilter + http_codes: + - 429 + action: RETRY + record_selector: + type: RecordSelector + extractor: + type: DpathExtractor + field_path: [] + paginator: + type: DefaultPaginator + page_token_option: + type: RequestOption + inject_into: request_parameter + field_name: skip + page_size_option: + type: RequestOption + inject_into: request_parameter + field_name: top + pagination_strategy: + type: OffsetIncrement + page_size: 500 + incremental_sync: + type: DatetimeBasedCursor + cursor_field: DATE_UPDATED_UTC + path: /Contacts/Search + cursor_datetime_formats: + - '%Y-%m-%d %H:%M:%S' + datetime_format: '%Y-%m-%d %H:%M:%S' + start_datetime: + type: MinMaxDatetime + datetime: '{{ config[''start_date''] }}' + datetime_format: '%Y-%m-%dT%H:%M:%SZ' + end_datetime: + type: MinMaxDatetime + datetime: '{{ now_utc() }}' + datetime_format: '%Y-%m-%d %H:%M:%S.%f+00:00' + step: P30D + cursor_granularity: PT1S + schema_loader: + type: InlineSchemaLoader + schema: + $ref: '#/schemas/contacts' + countries: + type: DeclarativeStream + name: countries + primary_key: + - COUNTRY_NAME + retriever: + type: SimpleRetriever + requester: + $ref: '#/definitions/base_requester' + path: /Countries + http_method: GET + request_parameters: + count_total: 'True' + updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + error_handler: + type: CompositeErrorHandler + error_handlers: + - type: DefaultErrorHandler + response_filters: + - type: HttpResponseFilter + http_codes: + - 403 + action: IGNORE + - type: DefaultErrorHandler + backoff_strategies: + - type: ConstantBackoffStrategy + backoff_time_in_seconds: 6 + response_filters: + - type: HttpResponseFilter + http_codes: + - 429 + action: RETRY + record_selector: + type: RecordSelector + extractor: + type: DpathExtractor + field_path: [] + paginator: + type: DefaultPaginator + page_token_option: + type: RequestOption + inject_into: request_parameter + field_name: skip + page_size_option: + type: RequestOption + inject_into: request_parameter + field_name: top + pagination_strategy: + type: OffsetIncrement + page_size: 500 + schema_loader: + type: InlineSchemaLoader + schema: + $ref: '#/schemas/countries' + currencies: + type: DeclarativeStream + name: currencies + primary_key: + - CURRENCY_CODE + retriever: + type: SimpleRetriever + requester: + $ref: '#/definitions/base_requester' + path: /Currencies + http_method: GET + request_parameters: + count_total: 'True' + updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + error_handler: + type: CompositeErrorHandler + error_handlers: + - type: DefaultErrorHandler + response_filters: + - type: HttpResponseFilter + http_codes: + - 403 + action: IGNORE + - type: DefaultErrorHandler + backoff_strategies: + - type: ConstantBackoffStrategy + backoff_time_in_seconds: 6 + response_filters: + - type: HttpResponseFilter + http_codes: + - 429 + action: RETRY + record_selector: + type: RecordSelector + extractor: + type: DpathExtractor + field_path: [] + paginator: + type: DefaultPaginator + page_token_option: + type: RequestOption + inject_into: request_parameter + field_name: skip + page_size_option: + type: RequestOption + inject_into: request_parameter + field_name: top + pagination_strategy: + type: OffsetIncrement + page_size: 500 + schema_loader: + type: InlineSchemaLoader + schema: + $ref: '#/schemas/currencies' + emails: + type: DeclarativeStream + name: emails + primary_key: + - EMAIL_ID + retriever: + type: SimpleRetriever + requester: + $ref: '#/definitions/base_requester' + path: /Emails/Search + http_method: GET + request_parameters: + count_total: 'True' + updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + error_handler: + type: CompositeErrorHandler + error_handlers: + - type: DefaultErrorHandler + response_filters: + - type: HttpResponseFilter + http_codes: + - 403 + action: IGNORE + - type: DefaultErrorHandler + backoff_strategies: + - type: ConstantBackoffStrategy + backoff_time_in_seconds: 6 + response_filters: + - type: HttpResponseFilter + http_codes: + - 429 + action: RETRY + record_selector: + type: RecordSelector + extractor: + type: DpathExtractor + field_path: [] + paginator: + type: DefaultPaginator + page_token_option: + type: RequestOption + inject_into: request_parameter + field_name: skip + page_size_option: + type: RequestOption + inject_into: request_parameter + field_name: top + pagination_strategy: + type: OffsetIncrement + page_size: 500 + schema_loader: + type: InlineSchemaLoader + schema: + $ref: '#/schemas/emails' + events: + type: DeclarativeStream + name: events + primary_key: + - EVENT_ID + retriever: + type: SimpleRetriever + requester: + $ref: '#/definitions/base_requester' + path: /Events/Search + http_method: GET + request_parameters: + count_total: 'True' + updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + error_handler: + type: CompositeErrorHandler + error_handlers: + - type: DefaultErrorHandler + response_filters: + - type: HttpResponseFilter + http_codes: + - 403 + action: IGNORE + - type: DefaultErrorHandler + backoff_strategies: + - type: ConstantBackoffStrategy + backoff_time_in_seconds: 6 + response_filters: + - type: HttpResponseFilter + http_codes: + - 429 + action: RETRY + record_selector: + type: RecordSelector + extractor: + type: DpathExtractor + field_path: [] + paginator: + type: DefaultPaginator + page_token_option: + type: RequestOption + inject_into: request_parameter + field_name: skip + page_size_option: + type: RequestOption + inject_into: request_parameter + field_name: top + pagination_strategy: + type: OffsetIncrement + page_size: 500 + incremental_sync: + type: DatetimeBasedCursor + cursor_field: DATE_UPDATED_UTC + path: /Events/Search + cursor_datetime_formats: + - '%Y-%m-%d %H:%M:%S' + datetime_format: '%Y-%m-%d %H:%M:%S' + start_datetime: + type: MinMaxDatetime + datetime: '{{ config[''start_date''] }}' + datetime_format: '%Y-%m-%dT%H:%M:%SZ' + end_datetime: + type: MinMaxDatetime + datetime: '{{ now_utc() }}' + datetime_format: '%Y-%m-%d %H:%M:%S.%f+00:00' + step: P30D + cursor_granularity: PT1S + schema_loader: + type: InlineSchemaLoader + schema: + $ref: '#/schemas/events' + knowledge_article_categories: + type: DeclarativeStream + name: knowledge_article_categories + primary_key: + - CATEGORY_ID + retriever: + type: SimpleRetriever + requester: + $ref: '#/definitions/base_requester' + path: /KnowledgeArticleCategory/Search + http_method: GET + request_parameters: + count_total: 'True' + updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + error_handler: + type: CompositeErrorHandler + error_handlers: + - type: DefaultErrorHandler + response_filters: + - type: HttpResponseFilter + http_codes: + - 403 + action: IGNORE + - type: DefaultErrorHandler + backoff_strategies: + - type: ConstantBackoffStrategy + backoff_time_in_seconds: 6 + response_filters: + - type: HttpResponseFilter + http_codes: + - 429 + action: RETRY + record_selector: + type: RecordSelector + extractor: + type: DpathExtractor + field_path: [] + paginator: + type: DefaultPaginator + page_token_option: + type: RequestOption + inject_into: request_parameter + field_name: skip + page_size_option: + type: RequestOption + inject_into: request_parameter + field_name: top + pagination_strategy: + type: OffsetIncrement + page_size: 500 + incremental_sync: + type: DatetimeBasedCursor + cursor_field: DATE_UPDATED_UTC + path: /KnowledgeArticleCategory/Search + cursor_datetime_formats: + - '%Y-%m-%d %H:%M:%S' + datetime_format: '%Y-%m-%d %H:%M:%S' + start_datetime: + type: MinMaxDatetime + datetime: '{{ config[''start_date''] }}' + datetime_format: '%Y-%m-%dT%H:%M:%SZ' + end_datetime: + type: MinMaxDatetime + datetime: '{{ now_utc() }}' + datetime_format: '%Y-%m-%d %H:%M:%S.%f+00:00' + step: P30D + cursor_granularity: PT1S + schema_loader: + type: InlineSchemaLoader + schema: + $ref: '#/schemas/knowledge_article_categories' + knowledge_article_folders: + type: DeclarativeStream + name: knowledge_article_folders + primary_key: + - FOLDER_ID + retriever: + type: SimpleRetriever + requester: + $ref: '#/definitions/base_requester' + path: /KnowledgeArticleFolder/Search + http_method: GET + request_parameters: + count_total: 'True' + updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + error_handler: + type: CompositeErrorHandler + error_handlers: + - type: DefaultErrorHandler + response_filters: + - type: HttpResponseFilter + http_codes: + - 403 + action: IGNORE + - type: DefaultErrorHandler + backoff_strategies: + - type: ConstantBackoffStrategy + backoff_time_in_seconds: 6 + response_filters: + - type: HttpResponseFilter + http_codes: + - 429 + action: RETRY + record_selector: + type: RecordSelector + extractor: + type: DpathExtractor + field_path: [] + paginator: + type: DefaultPaginator + page_token_option: + type: RequestOption + inject_into: request_parameter + field_name: skip + page_size_option: + type: RequestOption + inject_into: request_parameter + field_name: top + pagination_strategy: + type: OffsetIncrement + page_size: 500 + incremental_sync: + type: DatetimeBasedCursor + cursor_field: DATE_UPDATED_UTC + path: /KnowledgeArticleFolder/Search + cursor_datetime_formats: + - '%Y-%m-%d %H:%M:%S' + datetime_format: '%Y-%m-%d %H:%M:%S' + start_datetime: + type: MinMaxDatetime + datetime: '{{ config[''start_date''] }}' + datetime_format: '%Y-%m-%dT%H:%M:%SZ' + end_datetime: + type: MinMaxDatetime + datetime: '{{ now_utc() }}' + datetime_format: '%Y-%m-%d %H:%M:%S.%f+00:00' + step: P30D + cursor_granularity: PT1S + schema_loader: + type: InlineSchemaLoader + schema: + $ref: '#/schemas/knowledge_article_folders' + knowledge_articles: + type: DeclarativeStream + name: knowledge_articles + primary_key: + - ARTICLE_ID + retriever: + type: SimpleRetriever + requester: + $ref: '#/definitions/base_requester' + path: /KnowledgeArticle/Search + http_method: GET + request_parameters: + count_total: 'True' + updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + error_handler: + type: CompositeErrorHandler + error_handlers: + - type: DefaultErrorHandler + response_filters: + - type: HttpResponseFilter + http_codes: + - 403 + action: IGNORE + - type: DefaultErrorHandler + backoff_strategies: + - type: ConstantBackoffStrategy + backoff_time_in_seconds: 6 + response_filters: + - type: HttpResponseFilter + http_codes: + - 429 + action: RETRY + record_selector: + type: RecordSelector + extractor: + type: DpathExtractor + field_path: [] + paginator: + type: DefaultPaginator + page_token_option: + type: RequestOption + inject_into: request_parameter + field_name: skip + page_size_option: + type: RequestOption + inject_into: request_parameter + field_name: top + pagination_strategy: + type: OffsetIncrement + page_size: 500 + incremental_sync: + type: DatetimeBasedCursor + cursor_field: DATE_UPDATED_UTC + path: /KnowledgeArticle/Search + cursor_datetime_formats: + - '%Y-%m-%d %H:%M:%S' + datetime_format: '%Y-%m-%d %H:%M:%S' + start_datetime: + type: MinMaxDatetime + datetime: '{{ config[''start_date''] }}' + datetime_format: '%Y-%m-%dT%H:%M:%SZ' + end_datetime: + type: MinMaxDatetime + datetime: '{{ now_utc() }}' + datetime_format: '%Y-%m-%d %H:%M:%S.%f+00:00' + step: P30D + cursor_granularity: PT1S + schema_loader: + type: InlineSchemaLoader + schema: + $ref: '#/schemas/knowledge_articles' + lead_sources: + type: DeclarativeStream + name: lead_sources + primary_key: + - LEAD_SOURCE_ID + retriever: + type: SimpleRetriever + requester: + $ref: '#/definitions/base_requester' + path: /LeadSources + http_method: GET + request_parameters: + count_total: 'True' + updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + error_handler: + type: CompositeErrorHandler + error_handlers: + - type: DefaultErrorHandler + response_filters: + - type: HttpResponseFilter + http_codes: + - 403 + action: IGNORE + - type: DefaultErrorHandler + backoff_strategies: + - type: ConstantBackoffStrategy + backoff_time_in_seconds: 6 + response_filters: + - type: HttpResponseFilter + http_codes: + - 429 + action: RETRY + record_selector: + type: RecordSelector + extractor: + type: DpathExtractor + field_path: [] + paginator: + type: DefaultPaginator + page_token_option: + type: RequestOption + inject_into: request_parameter + field_name: skip + page_size_option: + type: RequestOption + inject_into: request_parameter + field_name: top + pagination_strategy: + type: OffsetIncrement + page_size: 500 + schema_loader: + type: InlineSchemaLoader + schema: + $ref: '#/schemas/lead_sources' + lead_statuses: + type: DeclarativeStream + name: lead_statuses + primary_key: + - LEAD_STATUS_ID + retriever: + type: SimpleRetriever + requester: + $ref: '#/definitions/base_requester' + path: /LeadStatuses + http_method: GET + request_parameters: + count_total: 'True' + updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + error_handler: + type: CompositeErrorHandler + error_handlers: + - type: DefaultErrorHandler + response_filters: + - type: HttpResponseFilter + http_codes: + - 403 + action: IGNORE + - type: DefaultErrorHandler + backoff_strategies: + - type: ConstantBackoffStrategy + backoff_time_in_seconds: 6 + response_filters: + - type: HttpResponseFilter + http_codes: + - 429 + action: RETRY + record_selector: + type: RecordSelector + extractor: + type: DpathExtractor + field_path: [] + paginator: + type: DefaultPaginator + page_token_option: + type: RequestOption + inject_into: request_parameter + field_name: skip + page_size_option: + type: RequestOption + inject_into: request_parameter + field_name: top + pagination_strategy: + type: OffsetIncrement + page_size: 500 + schema_loader: + type: InlineSchemaLoader + schema: + $ref: '#/schemas/lead_statuses' + milestones: + type: DeclarativeStream + name: milestones + primary_key: + - MILESTONE_ID + retriever: + type: SimpleRetriever + requester: + $ref: '#/definitions/base_requester' + path: /Milestones/Search + http_method: GET + request_parameters: + count_total: 'True' + updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + error_handler: + type: CompositeErrorHandler + error_handlers: + - type: DefaultErrorHandler + response_filters: + - type: HttpResponseFilter + http_codes: + - 403 + action: IGNORE + - type: DefaultErrorHandler + backoff_strategies: + - type: ConstantBackoffStrategy + backoff_time_in_seconds: 6 + response_filters: + - type: HttpResponseFilter + http_codes: + - 429 + action: RETRY + record_selector: + type: RecordSelector + extractor: + type: DpathExtractor + field_path: [] + paginator: + type: DefaultPaginator + page_token_option: + type: RequestOption + inject_into: request_parameter + field_name: skip + page_size_option: + type: RequestOption + inject_into: request_parameter + field_name: top + pagination_strategy: + type: OffsetIncrement + page_size: 500 + incremental_sync: + type: DatetimeBasedCursor + cursor_field: DATE_UPDATED_UTC + path: /Milestones/Search + cursor_datetime_formats: + - '%Y-%m-%d %H:%M:%S' + datetime_format: '%Y-%m-%d %H:%M:%S' + start_datetime: + type: MinMaxDatetime + datetime: '{{ config[''start_date''] }}' + datetime_format: '%Y-%m-%dT%H:%M:%SZ' + end_datetime: + type: MinMaxDatetime + datetime: '{{ now_utc() }}' + datetime_format: '%Y-%m-%d %H:%M:%S.%f+00:00' + step: P30D + cursor_granularity: PT1S + schema_loader: + type: InlineSchemaLoader + schema: + $ref: '#/schemas/milestones' + notes: + type: DeclarativeStream + name: notes + primary_key: + - NOTE_ID + retriever: + type: SimpleRetriever + requester: + $ref: '#/definitions/base_requester' + path: /Notes/Search + http_method: GET + request_parameters: + count_total: 'True' + updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + error_handler: + type: CompositeErrorHandler + error_handlers: + - type: DefaultErrorHandler + response_filters: + - type: HttpResponseFilter + http_codes: + - 403 + action: IGNORE + - type: DefaultErrorHandler + backoff_strategies: + - type: ConstantBackoffStrategy + backoff_time_in_seconds: 6 + response_filters: + - type: HttpResponseFilter + http_codes: + - 429 + action: RETRY + record_selector: + type: RecordSelector + extractor: + type: DpathExtractor + field_path: [] + paginator: + type: DefaultPaginator + page_token_option: + type: RequestOption + inject_into: request_parameter + field_name: skip + page_size_option: + type: RequestOption + inject_into: request_parameter + field_name: top + pagination_strategy: + type: OffsetIncrement + page_size: 500 + incremental_sync: + type: DatetimeBasedCursor + cursor_field: DATE_UPDATED_UTC + path: /Notes/Search + cursor_datetime_formats: + - '%Y-%m-%d %H:%M:%S' + datetime_format: '%Y-%m-%d %H:%M:%S' + start_datetime: + type: MinMaxDatetime + datetime: '{{ config[''start_date''] }}' + datetime_format: '%Y-%m-%dT%H:%M:%SZ' + end_datetime: + type: MinMaxDatetime + datetime: '{{ now_utc() }}' + datetime_format: '%Y-%m-%d %H:%M:%S.%f+00:00' + step: P30D + cursor_granularity: PT1S + schema_loader: + type: InlineSchemaLoader + schema: + $ref: '#/schemas/notes' + opportunities: + type: DeclarativeStream + name: opportunities + primary_key: + - OPPORTUNITY_ID + retriever: + type: SimpleRetriever + requester: + $ref: '#/definitions/base_requester' + path: /Opportunities/Search + http_method: GET + request_parameters: + count_total: 'True' + updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + error_handler: + type: CompositeErrorHandler + error_handlers: + - type: DefaultErrorHandler + response_filters: + - type: HttpResponseFilter + http_codes: + - 403 + action: IGNORE + - type: DefaultErrorHandler + backoff_strategies: + - type: ConstantBackoffStrategy + backoff_time_in_seconds: 6 + response_filters: + - type: HttpResponseFilter + http_codes: + - 429 + action: RETRY + record_selector: + type: RecordSelector + extractor: + type: DpathExtractor + field_path: [] + paginator: + type: DefaultPaginator + page_token_option: + type: RequestOption + inject_into: request_parameter + field_name: skip + page_size_option: + type: RequestOption + inject_into: request_parameter + field_name: top + pagination_strategy: + type: OffsetIncrement + page_size: 500 + incremental_sync: + type: DatetimeBasedCursor + cursor_field: DATE_UPDATED_UTC + path: /Opportunities/Search + cursor_datetime_formats: + - '%Y-%m-%d %H:%M:%S' + datetime_format: '%Y-%m-%d %H:%M:%S' + start_datetime: + type: MinMaxDatetime + datetime: '{{ config[''start_date''] }}' + datetime_format: '%Y-%m-%dT%H:%M:%SZ' + end_datetime: + type: MinMaxDatetime + datetime: '{{ now_utc() }}' + datetime_format: '%Y-%m-%d %H:%M:%S.%f+00:00' + step: P30D + cursor_granularity: PT1S + schema_loader: + type: InlineSchemaLoader + schema: + $ref: '#/schemas/opportunities' + opportunity_categories: + type: DeclarativeStream + name: opportunity_categories + primary_key: + - CATEGORY_ID + retriever: + type: SimpleRetriever + requester: + $ref: '#/definitions/base_requester' + path: /OpportunityCategories + http_method: GET + request_parameters: + count_total: 'True' + updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + error_handler: + type: CompositeErrorHandler + error_handlers: + - type: DefaultErrorHandler + response_filters: + - type: HttpResponseFilter + http_codes: + - 403 + action: IGNORE + - type: DefaultErrorHandler + backoff_strategies: + - type: ConstantBackoffStrategy + backoff_time_in_seconds: 6 + response_filters: + - type: HttpResponseFilter + http_codes: + - 429 + action: RETRY + record_selector: + type: RecordSelector + extractor: + type: DpathExtractor + field_path: [] + paginator: + type: DefaultPaginator + page_token_option: + type: RequestOption + inject_into: request_parameter + field_name: skip + page_size_option: + type: RequestOption + inject_into: request_parameter + field_name: top + pagination_strategy: + type: OffsetIncrement + page_size: 500 + schema_loader: + type: InlineSchemaLoader + schema: + $ref: '#/schemas/opportunity_categories' + opportunity_state_reasons: + type: DeclarativeStream + name: opportunity_state_reasons + primary_key: + - STATE_REASON_ID + retriever: + type: SimpleRetriever + requester: + $ref: '#/definitions/base_requester' + path: /OpportunityStateReasons + http_method: GET + request_parameters: + count_total: 'True' + updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + error_handler: + type: CompositeErrorHandler + error_handlers: + - type: DefaultErrorHandler + response_filters: + - type: HttpResponseFilter + http_codes: + - 403 + action: IGNORE + - type: DefaultErrorHandler + backoff_strategies: + - type: ConstantBackoffStrategy + backoff_time_in_seconds: 6 + response_filters: + - type: HttpResponseFilter + http_codes: + - 429 + action: RETRY + record_selector: + type: RecordSelector + extractor: + type: DpathExtractor + field_path: [] + paginator: + type: DefaultPaginator + page_token_option: + type: RequestOption + inject_into: request_parameter + field_name: skip + page_size_option: + type: RequestOption + inject_into: request_parameter + field_name: top + pagination_strategy: + type: OffsetIncrement + page_size: 500 + schema_loader: + type: InlineSchemaLoader + schema: + $ref: '#/schemas/opportunity_state_reasons' + organisations: + type: DeclarativeStream + name: organisations + primary_key: + - ORGANISATION_ID + retriever: + type: SimpleRetriever + requester: + $ref: '#/definitions/base_requester' + path: /Organisations/Search + http_method: GET + request_parameters: + count_total: 'True' + updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + error_handler: + type: CompositeErrorHandler + error_handlers: + - type: DefaultErrorHandler + response_filters: + - type: HttpResponseFilter + http_codes: + - 403 + action: IGNORE + - type: DefaultErrorHandler + backoff_strategies: + - type: ConstantBackoffStrategy + backoff_time_in_seconds: 6 + response_filters: + - type: HttpResponseFilter + http_codes: + - 429 + action: RETRY + record_selector: + type: RecordSelector + extractor: + type: DpathExtractor + field_path: [] + paginator: + type: DefaultPaginator + page_token_option: + type: RequestOption + inject_into: request_parameter + field_name: skip + page_size_option: + type: RequestOption + inject_into: request_parameter + field_name: top + pagination_strategy: + type: OffsetIncrement + page_size: 500 + incremental_sync: + type: DatetimeBasedCursor + cursor_field: DATE_UPDATED_UTC + path: /Organisations/Search + cursor_datetime_formats: + - '%Y-%m-%d %H:%M:%S' + datetime_format: '%Y-%m-%d %H:%M:%S' + start_datetime: + type: MinMaxDatetime + datetime: '{{ config[''start_date''] }}' + datetime_format: '%Y-%m-%dT%H:%M:%SZ' + end_datetime: + type: MinMaxDatetime + datetime: '{{ now_utc() }}' + datetime_format: '%Y-%m-%d %H:%M:%S.%f+00:00' + step: P30D + cursor_granularity: PT1S + schema_loader: + type: InlineSchemaLoader + schema: + $ref: '#/schemas/organisations' + pipelines: + type: DeclarativeStream + name: pipelines + primary_key: + - PIPELINE_ID + retriever: + type: SimpleRetriever + requester: + $ref: '#/definitions/base_requester' + path: /Pipelines + http_method: GET + request_parameters: + count_total: 'True' + updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + error_handler: + type: CompositeErrorHandler + error_handlers: + - type: DefaultErrorHandler + response_filters: + - type: HttpResponseFilter + http_codes: + - 403 + action: IGNORE + - type: DefaultErrorHandler + backoff_strategies: + - type: ConstantBackoffStrategy + backoff_time_in_seconds: 6 + response_filters: + - type: HttpResponseFilter + http_codes: + - 429 + action: RETRY + record_selector: + type: RecordSelector + extractor: + type: DpathExtractor + field_path: [] + paginator: + type: DefaultPaginator + page_token_option: + type: RequestOption + inject_into: request_parameter + field_name: skip + page_size_option: + type: RequestOption + inject_into: request_parameter + field_name: top + pagination_strategy: + type: OffsetIncrement + page_size: 500 + schema_loader: + type: InlineSchemaLoader + schema: + $ref: '#/schemas/pipelines' + pipeline_stages: + type: DeclarativeStream + name: pipeline_stages + primary_key: + - STAGE_ID + retriever: + type: SimpleRetriever + requester: + $ref: '#/definitions/base_requester' + path: /PipelineStages + http_method: GET + request_parameters: + count_total: 'True' + updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + error_handler: + type: CompositeErrorHandler + error_handlers: + - type: DefaultErrorHandler + response_filters: + - type: HttpResponseFilter + http_codes: + - 403 + action: IGNORE + - type: DefaultErrorHandler + backoff_strategies: + - type: ConstantBackoffStrategy + backoff_time_in_seconds: 6 + response_filters: + - type: HttpResponseFilter + http_codes: + - 429 + action: RETRY + record_selector: + type: RecordSelector + extractor: + type: DpathExtractor + field_path: [] + paginator: + type: DefaultPaginator + page_token_option: + type: RequestOption + inject_into: request_parameter + field_name: skip + page_size_option: + type: RequestOption + inject_into: request_parameter + field_name: top + pagination_strategy: + type: OffsetIncrement + page_size: 500 + schema_loader: + type: InlineSchemaLoader + schema: + $ref: '#/schemas/pipeline_stages' + project_categories: + type: DeclarativeStream + name: project_categories + primary_key: + - CATEGORY_ID + retriever: + type: SimpleRetriever + requester: + $ref: '#/definitions/base_requester' + path: /ProjectCategories + http_method: GET + request_parameters: + count_total: 'True' + updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + error_handler: + type: CompositeErrorHandler + error_handlers: + - type: DefaultErrorHandler + response_filters: + - type: HttpResponseFilter + http_codes: + - 403 + action: IGNORE + - type: DefaultErrorHandler + backoff_strategies: + - type: ConstantBackoffStrategy + backoff_time_in_seconds: 6 + response_filters: + - type: HttpResponseFilter + http_codes: + - 429 + action: RETRY + record_selector: + type: RecordSelector + extractor: + type: DpathExtractor + field_path: [] + paginator: + type: DefaultPaginator + page_token_option: + type: RequestOption + inject_into: request_parameter + field_name: skip + page_size_option: + type: RequestOption + inject_into: request_parameter + field_name: top + pagination_strategy: + type: OffsetIncrement + page_size: 500 + schema_loader: + type: InlineSchemaLoader + schema: + $ref: '#/schemas/project_categories' + projects: + type: DeclarativeStream + name: projects + primary_key: + - PROJECT_ID + retriever: + type: SimpleRetriever + requester: + $ref: '#/definitions/base_requester' + path: /Projects/Search + http_method: GET + request_parameters: + count_total: 'True' + updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + error_handler: + type: CompositeErrorHandler + error_handlers: + - type: DefaultErrorHandler + response_filters: + - type: HttpResponseFilter + http_codes: + - 403 + action: IGNORE + - type: DefaultErrorHandler + backoff_strategies: + - type: ConstantBackoffStrategy + backoff_time_in_seconds: 6 + response_filters: + - type: HttpResponseFilter + http_codes: + - 429 + action: RETRY + record_selector: + type: RecordSelector + extractor: + type: DpathExtractor + field_path: [] + paginator: + type: DefaultPaginator + page_token_option: + type: RequestOption + inject_into: request_parameter + field_name: skip + page_size_option: + type: RequestOption + inject_into: request_parameter + field_name: top + pagination_strategy: + type: OffsetIncrement + page_size: 500 + incremental_sync: + type: DatetimeBasedCursor + cursor_field: DATE_UPDATED_UTC + path: /Projects/Search + cursor_datetime_formats: + - '%Y-%m-%d %H:%M:%S' + datetime_format: '%Y-%m-%d %H:%M:%S' + start_datetime: + type: MinMaxDatetime + datetime: '{{ config[''start_date''] }}' + datetime_format: '%Y-%m-%dT%H:%M:%SZ' + end_datetime: + type: MinMaxDatetime + datetime: '{{ now_utc() }}' + datetime_format: '%Y-%m-%d %H:%M:%S.%f+00:00' + step: P30D + cursor_granularity: PT1S + schema_loader: + type: InlineSchemaLoader + schema: + $ref: '#/schemas/projects' + prospects: + type: DeclarativeStream + name: prospects + primary_key: + - PROSPECT_ID + retriever: + type: SimpleRetriever + requester: + $ref: '#/definitions/base_requester' + path: /Prospect/Search + http_method: GET + request_parameters: + count_total: 'True' + updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + error_handler: + type: CompositeErrorHandler + error_handlers: + - type: DefaultErrorHandler + response_filters: + - type: HttpResponseFilter + http_codes: + - 403 + action: IGNORE + - type: DefaultErrorHandler + backoff_strategies: + - type: ConstantBackoffStrategy + backoff_time_in_seconds: 6 + response_filters: + - type: HttpResponseFilter + http_codes: + - 429 + action: RETRY + record_selector: + type: RecordSelector + extractor: + type: DpathExtractor + field_path: [] + paginator: + type: DefaultPaginator + page_token_option: + type: RequestOption + inject_into: request_parameter + field_name: skip + page_size_option: + type: RequestOption + inject_into: request_parameter + field_name: top + pagination_strategy: + type: OffsetIncrement + page_size: 500 + incremental_sync: + type: DatetimeBasedCursor + cursor_field: DATE_UPDATED_UTC + path: /Prospect/Search + cursor_datetime_formats: + - '%Y-%m-%d %H:%M:%S' + datetime_format: '%Y-%m-%d %H:%M:%S' + start_datetime: + type: MinMaxDatetime + datetime: '{{ config[''start_date''] }}' + datetime_format: '%Y-%m-%dT%H:%M:%SZ' + end_datetime: + type: MinMaxDatetime + datetime: '{{ now_utc() }}' + datetime_format: '%Y-%m-%d %H:%M:%S.%f+00:00' + step: P30D + cursor_granularity: PT1S + schema_loader: + type: InlineSchemaLoader + schema: + $ref: '#/schemas/prospects' + relationships: + type: DeclarativeStream + name: relationships + primary_key: + - RELATIONSHIP_ID + retriever: + type: SimpleRetriever + requester: + $ref: '#/definitions/base_requester' + path: /Relationships + http_method: GET + request_parameters: + count_total: 'True' + updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + error_handler: + type: CompositeErrorHandler + error_handlers: + - type: DefaultErrorHandler + response_filters: + - type: HttpResponseFilter + http_codes: + - 403 + action: IGNORE + - type: DefaultErrorHandler + backoff_strategies: + - type: ConstantBackoffStrategy + backoff_time_in_seconds: 6 + response_filters: + - type: HttpResponseFilter + http_codes: + - 429 + action: RETRY + record_selector: + type: RecordSelector + extractor: + type: DpathExtractor + field_path: [] + paginator: + type: DefaultPaginator + page_token_option: + type: RequestOption + inject_into: request_parameter + field_name: skip + page_size_option: + type: RequestOption + inject_into: request_parameter + field_name: top + pagination_strategy: + type: OffsetIncrement + page_size: 500 + schema_loader: + type: InlineSchemaLoader + schema: + $ref: '#/schemas/relationships' + task_categories: + type: DeclarativeStream + name: task_categories + primary_key: + - CATEGORY_ID + retriever: + type: SimpleRetriever + requester: + $ref: '#/definitions/base_requester' + path: /TaskCategories + http_method: GET + request_parameters: + count_total: 'True' + updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + error_handler: + type: CompositeErrorHandler + error_handlers: + - type: DefaultErrorHandler + response_filters: + - type: HttpResponseFilter + http_codes: + - 403 + action: IGNORE + - type: DefaultErrorHandler + backoff_strategies: + - type: ConstantBackoffStrategy + backoff_time_in_seconds: 6 + response_filters: + - type: HttpResponseFilter + http_codes: + - 429 + action: RETRY + record_selector: + type: RecordSelector + extractor: + type: DpathExtractor + field_path: [] + paginator: + type: DefaultPaginator + page_token_option: + type: RequestOption + inject_into: request_parameter + field_name: skip + page_size_option: + type: RequestOption + inject_into: request_parameter + field_name: top + pagination_strategy: + type: OffsetIncrement + page_size: 500 + schema_loader: + type: InlineSchemaLoader + schema: + $ref: '#/schemas/task_categories' + tasks: + type: DeclarativeStream + name: tasks + primary_key: + - TASK_ID + retriever: + type: SimpleRetriever + requester: + $ref: '#/definitions/base_requester' + path: /Tasks/Search + http_method: GET + request_parameters: + count_total: 'True' + updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + error_handler: + type: CompositeErrorHandler + error_handlers: + - type: DefaultErrorHandler + response_filters: + - type: HttpResponseFilter + http_codes: + - 403 + action: IGNORE + - type: DefaultErrorHandler + backoff_strategies: + - type: ConstantBackoffStrategy + backoff_time_in_seconds: 6 + response_filters: + - type: HttpResponseFilter + http_codes: + - 429 + action: RETRY + record_selector: + type: RecordSelector + extractor: + type: DpathExtractor + field_path: [] + paginator: + type: DefaultPaginator + page_token_option: + type: RequestOption + inject_into: request_parameter + field_name: skip + page_size_option: + type: RequestOption + inject_into: request_parameter + field_name: top + pagination_strategy: + type: OffsetIncrement + page_size: 500 + incremental_sync: + type: DatetimeBasedCursor + cursor_field: DATE_UPDATED_UTC + path: /Tasks/Search + cursor_datetime_formats: + - '%Y-%m-%d %H:%M:%S' + datetime_format: '%Y-%m-%d %H:%M:%S' + start_datetime: + type: MinMaxDatetime + datetime: '{{ config[''start_date''] }}' + datetime_format: '%Y-%m-%dT%H:%M:%SZ' + end_datetime: + type: MinMaxDatetime + datetime: '{{ now_utc() }}' + datetime_format: '%Y-%m-%d %H:%M:%S.%f+00:00' + step: P30D + cursor_granularity: PT1S + schema_loader: + type: InlineSchemaLoader + schema: + $ref: '#/schemas/tasks' + team_members: + type: DeclarativeStream + name: team_members + primary_key: + - MEMBER_USER_ID + retriever: + type: SimpleRetriever + requester: + $ref: '#/definitions/base_requester' + path: /TeamMembers + http_method: GET + request_parameters: + count_total: 'True' + updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + error_handler: + type: CompositeErrorHandler + error_handlers: + - type: DefaultErrorHandler + response_filters: + - type: HttpResponseFilter + http_codes: + - 403 + action: IGNORE + - type: DefaultErrorHandler + backoff_strategies: + - type: ConstantBackoffStrategy + backoff_time_in_seconds: 6 + response_filters: + - type: HttpResponseFilter + http_codes: + - 429 + action: RETRY + record_selector: + type: RecordSelector + extractor: + type: DpathExtractor + field_path: [] + paginator: + type: DefaultPaginator + page_token_option: + type: RequestOption + inject_into: request_parameter + field_name: skip + page_size_option: + type: RequestOption + inject_into: request_parameter + field_name: top + pagination_strategy: + type: OffsetIncrement + page_size: 500 + schema_loader: + type: InlineSchemaLoader + schema: + $ref: '#/schemas/team_members' + teams: + type: DeclarativeStream + name: teams + primary_key: + - TEAM_ID + retriever: + type: SimpleRetriever + requester: + $ref: '#/definitions/base_requester' + path: /Teams + http_method: GET + request_parameters: + count_total: 'True' + updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + error_handler: + type: CompositeErrorHandler + error_handlers: + - type: DefaultErrorHandler + response_filters: + - type: HttpResponseFilter + http_codes: + - 403 + action: IGNORE + - type: DefaultErrorHandler + backoff_strategies: + - type: ConstantBackoffStrategy + backoff_time_in_seconds: 6 + response_filters: + - type: HttpResponseFilter + http_codes: + - 429 + action: RETRY + record_selector: + type: RecordSelector + extractor: + type: DpathExtractor + field_path: [] + paginator: + type: DefaultPaginator + page_token_option: + type: RequestOption + inject_into: request_parameter + field_name: skip + page_size_option: + type: RequestOption + inject_into: request_parameter + field_name: top + pagination_strategy: + type: OffsetIncrement + page_size: 500 + schema_loader: + type: InlineSchemaLoader + schema: + $ref: '#/schemas/teams' + users: + type: DeclarativeStream + name: users + primary_key: + - USER_ID + retriever: + type: SimpleRetriever + requester: + $ref: '#/definitions/base_requester' + path: /Users/Search + http_method: GET + request_parameters: + count_total: 'True' + updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + error_handler: + type: CompositeErrorHandler + error_handlers: + - type: DefaultErrorHandler + response_filters: + - type: HttpResponseFilter + http_codes: + - 403 + action: IGNORE + - type: DefaultErrorHandler + backoff_strategies: + - type: ConstantBackoffStrategy + backoff_time_in_seconds: 6 + response_filters: + - type: HttpResponseFilter + http_codes: + - 429 + action: RETRY + record_selector: + type: RecordSelector + extractor: + type: DpathExtractor + field_path: [] + paginator: + type: DefaultPaginator + page_token_option: + type: RequestOption + inject_into: request_parameter + field_name: skip + page_size_option: + type: RequestOption + inject_into: request_parameter + field_name: top + pagination_strategy: + type: OffsetIncrement + page_size: 500 + incremental_sync: + type: DatetimeBasedCursor + cursor_field: DATE_UPDATED_UTC + path: /Users/Search + cursor_datetime_formats: + - '%Y-%m-%d %H:%M:%S' + datetime_format: '%Y-%m-%d %H:%M:%S' + start_datetime: + type: MinMaxDatetime + datetime: '{{ config[''start_date''] }}' + datetime_format: '%Y-%m-%dT%H:%M:%SZ' + end_datetime: + type: MinMaxDatetime + datetime: '{{ now_utc() }}' + datetime_format: '%Y-%m-%d %H:%M:%S.%f+00:00' + step: P30D + cursor_granularity: PT1S + schema_loader: + type: InlineSchemaLoader + schema: + $ref: '#/schemas/users' + base_requester: type: HttpRequester - url_base: "https://api.na1.insightly.com/v3.1/" - http_method: "GET" + url_base: https://api.na1.insightly.com/v3.1/ authenticator: type: BasicHttpAuthenticator - username: "{{ config['token'] }}" - request_parameters: - count_total: "True" - updated_after_utc: "{{ stream_state['DATE_UPDATED_UTC'] }}" - error_handler: - type: "CompositeErrorHandler" - error_handlers: - - response_filters: - - http_codes: [403] - action: IGNORE #ignore 403 errors for knowledge_article streams, lead streams and prospects - - response_filters: - - http_codes: [429] - action: RETRY - backoff_strategies: - - type: "ConstantBackoffStrategy" - backoff_time_in_seconds: 6.0 - - date_incremental_sync: - type: DatetimeBasedCursor - start_datetime: - datetime: "{{ config['start_date'] }}" - datetime_format: "%Y-%m-%dT%H:%M:%SZ" - end_datetime: - datetime: "{{ now_utc() }}" - datetime_format: "%Y-%m-%d %H:%M:%S.%f+00:00" - datetime_format: "%Y-%m-%d %H:%M:%S" - cursor_granularity: PT1S - step: P30D # Step should reflect the actual time granularity you need - cursor_field: "DATE_UPDATED_UTC" - - retriever: - type: SimpleRetriever - record_selector: - $ref: "#/definitions/selector" - paginator: - type: DefaultPaginator - pagination_strategy: - type: "OffsetIncrement" - page_size: 500 - page_token_option: - type: RequestOption - inject_into: "request_parameter" - field_name: "skip" - page_size_option: - inject_into: "request_parameter" - field_name: "top" - requester: - $ref: "#/definitions/requester" - - base_stream: - type: DeclarativeStream - retriever: - $ref: "#/definitions/retriever" - - base_incremental_stream: - incremental_sync: - $ref: "#/definitions/date_incremental_sync" - retriever: - $ref: "#/definitions/retriever" - - activity_sets_stream: - $ref: "#/definitions/base_stream" - name: "activity_sets" - primary_key: "ACTIVITYSET_ID" - $parameters: - path: "/ActivitySets" - - schema_loader: - type: InlineSchemaLoader - schema: - $schema: http://json-schema.org/draft-07/schema# - type: object - properties: - ACTIVITYSET_ID: - description: ID of the activity set - type: integer - NAME: - description: Name of the activity set - type: - - string - - "null" - FOR_CONTACTS: - description: Activity set associated with contacts - type: - - boolean - - "null" - FOR_ORGANISATIONS: - description: Activity set associated with organizations - type: - - boolean - - "null" - FOR_OPPORTUNITIES: - description: Activity set associated with opportunities - type: - - boolean - - "null" - FOR_PROJECTS: - description: Activity set associated with projects - type: - - boolean - - "null" - FOR_LEADS: - description: Activity set associated with leads - type: - - boolean - - "null" - OWNER_USER_ID: - description: ID of the user who owns the activity set - type: - - integer - - "null" - ACTIVITIES: - description: List of activities included in the activity set - type: array - items: - type: object - properties: - ACTIVITY_ID: - description: ID of the activity - type: - - integer - - "null" - ACTIVITYSET_ID: - description: ID of the activity set to which the activity belongs - type: - - integer - - "null" - ACTIVITY_NAME: - description: Name of the activity - type: - - string - - "null" - ACTIVITY_DETAILS: - description: Details or description of the activity - type: - - string - - "null" - ACTIVITY_TYPE: - description: Type of the activity - type: - - string - - "null" - CATEGORY_ID: - description: ID of the category to which the activity belongs - type: - - integer - - "null" - REMINDER: - description: Details about the reminder set for the activity - type: - - boolean - - "null" - REMINDER_DAYS_BEFORE_DUE: - description: - Number of days before the due date when the reminder - is triggered - type: - - integer - - "null" - REMINDER_TIME: - description: Time of day when the reminder is triggered - type: - - string - - "null" - PUBLICLY_VISIBLE: - description: - Boolean flag indicating if the activity is publicly - visible - type: - - boolean - - "null" - OWNER_VISIBLE: - description: - Boolean flag indicating if the activity is visible - to the owner - type: - - boolean - - "null" - OWNER_USER_ID: - description: ID of the user who owns the activity - type: - - integer - - "null" - RESPONSIBLE_USER_ID: - description: ID of the user responsible for the activity - type: - - integer - - "null" - ASSIGNED_TEAM_ID: - description: ID of the team assigned to the activity - type: - - integer - - "null" - SKIP_SUN: - description: - Boolean flag indicating if the activity is skipped - on Sundays - type: - - boolean - - "null" - SKIP_MON: - description: - Boolean flag indicating if the activity is skipped - on Mondays - type: - - boolean - - "null" - SKIP_TUE: - description: - Boolean flag indicating if the activity is skipped - on Tuesdays - type: - - boolean - - "null" - SKIP_WED: - description: - Boolean flag indicating if the activity is skipped - on Wednesdays - type: - - boolean - - "null" - SKIP_THU: - description: - Boolean flag indicating if the activity is skipped - on Thursdays - type: - - boolean - - "null" - SKIP_FRI: - description: - Boolean flag indicating if the activity is skipped - on Fridays - type: - - boolean - - "null" - SKIP_SAT: - description: - Boolean flag indicating if the activity is skipped - on Saturdays - type: - - boolean - - "null" - DUE_DAYS_AFTER_START: - description: - Number of days after the start of the activity by which - it is due - type: - - integer - - "null" - DUE_DAYS_BEFORE_END: - description: - Number of days before the end of the activity by which - it is due - type: - - integer - - "null" - EVENT_DAYS_AFTER_START: - description: - Number of days after the start of the activity when - the event occurs - type: - - integer - - "null" - EVENT_DAYS_BEFORE_END: - description: - Number of days before the end of the activity when - the event occurs - type: - - integer - - "null" - EVENT_TIME: - description: Time of the event associated with the activity - type: - - string - - "null" - ALL_DAY: - description: - Boolean flag indicating if the activity is an all-day - event - type: - - boolean - - "null" - DURATION: - description: Duration of the activity - type: - - integer - - "null" - contacts_stream: - $ref: "#/definitions/base_incremental_stream" - name: "contacts" - primary_key: "CONTACT_ID" - $parameters: - path: "/Contacts/Search" - - schema_loader: - type: InlineSchemaLoader - schema: - $schema: http://json-schema.org/draft-07/schema# - additionalProperties: true - type: object - properties: - CONTACT_ID: - description: The unique identifier for the contact - type: integer - SALUTATION: - description: The salutation for the contact - type: - - string - - "null" - FIRST_NAME: - description: The first name of the contact - type: - - string - - "null" - LAST_NAME: - description: The last name of the contact - type: - - string - - "null" - IMAGE_URL: - description: URL of the contact's image - type: - - string - - "null" - BACKGROUND: - description: Background information about the contact - type: - - string - - "null" - OWNER_USER_ID: - description: The ID of the user who owns the contact - type: - - integer - - "null" - DATE_CREATED_UTC: - description: The date and time the contact was created in UTC - type: - - string - - "null" - format: date-time - DATE_UPDATED_UTC: - description: The date and time the contact was last updated in UTC - type: - - string - - "null" - format: date-time - SOCIAL_LINKEDIN: - description: The LinkedIn profile of the contact - type: - - string - - "null" - SOCIAL_FACEBOOK: - description: The Facebook profile of the contact - type: - - string - - "null" - SOCIAL_TWITTER: - description: The Twitter profile of the contact - type: - - string - - "null" - DATE_OF_BIRTH: - description: The date of birth of the contact - type: - - string - - "null" - PHONE: - description: The primary phone number of the contact - type: - - string - - "null" - PHONE_HOME: - description: The home phone number of the contact - type: - - string - - "null" - PHONE_MOBILE: - description: The mobile phone number of the contact - type: - - string - - "null" - PHONE_OTHER: - description: Another phone number of the contact - type: - - string - - "null" - PHONE_ASSISTANT: - description: The phone number of the contact's assistant - type: - - string - - "null" - PHONE_FAX: - description: The fax number of the contact - type: - - string - - "null" - EMAIL_ADDRESS: - description: The email address of the contact - type: - - string - - "null" - ASSISTANT_NAME: - description: The name of the contact's assistant - type: - - string - - "null" - ADDRESS_MAIL_STREET: - description: The street address of the mailing address - type: - - string - - "null" - ADDRESS_MAIL_CITY: - description: The city of the mailing address - type: - - string - - "null" - ADDRESS_MAIL_STATE: - description: The state of the mailing address - type: - - string - - "null" - ADDRESS_MAIL_POSTCODE: - description: The postcode of the mailing address - type: - - string - - "null" - ADDRESS_MAIL_COUNTRY: - description: The country of the mailing address - type: - - string - - "null" - ADDRESS_OTHER_STREET: - description: The street address of the other address - type: - - string - - "null" - ADDRESS_OTHER_CITY: - description: The city of the other address - type: - - string - - "null" - ADDRESS_OTHER_STATE: - description: The state of the other address - type: - - string - - "null" - ADDRESS_OTHER_POSTCODE: - description: The postcode of the other address - type: - - string - - "null" - ADDRESS_OTHER_COUNTRY: - description: The country of the other address - type: - - string - - "null" - LAST_ACTIVITY_DATE_UTC: - description: - The date and time of the last activity related to the contact - in UTC - type: - - string - - "null" - format: date-time - NEXT_ACTIVITY_DATE_UTC: - description: - The date and time of the next activity related to the contact - in UTC - type: - - string - - "null" - format: date-time - CREATED_USER_ID: - description: The user ID of the user who created the contact - type: - - integer - - "null" - ORGANISATION_ID: - description: The ID of the organization the contact is associated with - type: - - integer - - "null" - TITLE: - description: The title of the contact - type: - - string - - "null" - VISIBLE_TEAM_ID: - description: The ID of the team the contact is visible to - type: - - integer - - "null" - VISIBLE_TO: - description: Indicates who the contact is visible to - type: - - string - - "null" - EMAIL_OPTED_OUT: - description: Whether the contact has opted out of email communication - type: - - boolean - - "null" - CUSTOMFIELDS: - description: Custom fields associated with the contact - type: array - items: - type: object - properties: - FIELD_NAME: - description: The name of the custom field - type: - - string - - "null" - FIELD_VALUE: - description: The value of the custom field for this contact - type: object - TAGS: - description: Tags or categories associated with the contact - type: array - items: - type: object - properties: - TAG_NAME: - description: The name of the tag associated with the contact - type: - - string - - "null" - DATES: - description: Important dates related to the contact - type: array - items: - type: object - properties: - DATE_ID: - description: The unique identifier for the date event - type: - - integer - - "null" - OCCASION_NAME: - description: The name of the occasion - type: - - string - - "null" - OCCASION_DATE: - description: The date of the occasion - type: - - string - - "null" - REPEAT_YEARLY: - description: Indicates if the occasion repeats yearly - type: - - boolean - - "null" - CREATE_TASK_YEARLY: - description: Indicates whether a task should be created yearly - type: - - boolean - - "null" - LINKS: - description: Links or references related to the contact - type: array - items: - type: object - properties: - LINK_ID: - description: Unique identifier for the link - type: - - integer - - "null" - OBJECT_NAME: - description: The name of the object - type: - - string - - "null" - OBJECT_ID: - description: The ID of the object - type: - - integer - - "null" - LINK_OBJECT_NAME: - description: The name of the linked object - type: - - string - - "null" - LINK_OBJECT_ID: - description: The ID of the linked object - type: - - integer - - "null" - ROLE: - description: The role of the contact in the relationship - type: - - string - - "null" - DETAILS: - description: Details about the link - type: - - string - - "null" - RELATIONSHIP_ID: - description: The ID of the relationship - type: - - integer - - "null" - IS_FORWARD: - description: Flag indicating if the link is forward - type: - - boolean - - "null" - countries_stream: - $ref: "#/definitions/base_stream" - name: "countries" - primary_key: "COUNTRY_NAME" - $parameters: - path: "/Countries" - - schema_loader: - type: InlineSchemaLoader - schema: - $schema: http://json-schema.org/draft-07/schema# - type: object - properties: - COUNTRY_NAME: - description: The name of the country. - type: string - currencies_stream: - $ref: "#/definitions/base_stream" - name: "currencies" - primary_key: "CURRENCY_CODE" - $parameters: - path: "/Currencies" - - schema_loader: - type: InlineSchemaLoader - schema: - $schema: http://json-schema.org/draft-07/schema# - type: object - properties: - CURRENCY_CODE: - description: The unique code representing the currency. - type: string - CURRENCY_SYMBOL: - description: The symbol used to denote the currency. - type: - - string - - "null" - emails_stream: - $ref: "#/definitions/base_stream" - name: "emails" - primary_key: "EMAIL_ID" - $parameters: - path: "/Emails/Search" - - schema_loader: - type: InlineSchemaLoader - schema: - $schema: http://json-schema.org/draft-07/schema# - type: object - properties: - EMAIL_ID: - description: The unique identifier of the email - type: integer - EMAIL_FROM: - description: The sender of the email - type: - - string - - "null" - SUBJECT: - description: The subject of the email - type: - - string - - "null" - EMAIL_DATE_UTC: - description: The date and time when the email was sent/received - type: - - string - - "null" - format: date-time - FORMAT: - description: The format of the email content - type: - - string - - "null" - SIZE: - description: The size of the email content - type: - - integer - - "null" - OWNER_USER_ID: - description: The ID of the user who owns the email - type: - - integer - - "null" - DATE_CREATED_UTC: - description: The date and time when the email record was created - type: - - string - - "null" - format: date-time - QUEUED_SEND_DATE_UTC: - description: The date and time when the email was queued for sending - type: - - string - - "null" - format: date-time - CREATED_USER_ID: - description: The ID of the user who created the email - type: - - integer - - "null" - TAGS: - description: Tags associated with the email - type: array - items: - type: object - properties: - TAG_NAME: - description: The name of the tag - type: - - string - - "null" - LINKS: - description: Related links associated with the email - type: array - items: - type: object - properties: - LINK_ID: - description: The ID of the link - type: - - integer - - "null" - OBJECT_NAME: - description: The name of the object associated with the email - type: - - string - - "null" - OBJECT_ID: - description: The ID of the object associated with the email - type: - - integer - - "null" - LINK_OBJECT_NAME: - description: The name of the linked object - type: - - string - - "null" - LINK_OBJECT_ID: - description: The ID of the linked object - type: - - integer - - "null" - ROLE: - description: The role of the linked object - type: - - string - - "null" - DETAILS: - description: Details about the link - type: - - string - - "null" - RELATIONSHIP_ID: - description: The ID representing the relationship with the link - type: - - integer - - "null" - IS_FORWARD: - description: Indicates if the link is a forward link - type: - - boolean - - "null" - events_stream: - $ref: "#/definitions/base_incremental_stream" - name: "events" - primary_key: "EVENT_ID" - $parameters: - path: "/Events/Search" - - schema_loader: - type: InlineSchemaLoader - schema: - $schema: http://json-schema.org/draft-04/schema# - type: object - properties: - EVENT_ID: - description: Unique identifier for the event - type: integer - TITLE: - description: Title of the event - type: - - string - - "null" - LOCATION: - description: Location of the event - type: - - string - - "null" - START_DATE_UTC: - description: Start date and time of the event (UTC) - type: - - string - - "null" - format: date-time - END_DATE_UTC: - description: End date and time of the event (UTC) - type: - - string - - "null" - format: date-time - ALL_DAY: - description: Indicates if the event is an all-day event - type: - - boolean - - "null" - DETAILS: - description: Additional details of the event - type: - - string - - "null" - DATE_CREATED_UTC: - description: DateTime when the event was created (UTC) - type: - - string - - "null" - format: date-time - DATE_UPDATED_UTC: - description: DateTime when the event was last updated (UTC) - type: - - string - - "null" - format: date-time - REMINDER_DATE_UTC: - description: - DateTime when the reminder for the event is set to trigger - (UTC) - type: - - string - - "null" - format: date-time - REMINDER_SENT: - description: Indicates if the reminder for the event has been sent - type: - - boolean - - "null" - OWNER_USER_ID: - description: User ID of the event owner - type: - - integer - - "null" - CUSTOMFIELDS: - description: Custom fields associated with the event - type: array - items: - type: object - properties: - FIELD_NAME: - description: Name of the custom field - type: - - string - - "null" - FIELD_VALUE: - description: Value of the custom field - type: object - LINKS: - description: Links associated with the event - type: array - items: - type: object - properties: - LINK_ID: - description: Unique identifier for the link - type: - - integer - - "null" - OBJECT_NAME: - description: Name of the object - type: - - string - - "null" - OBJECT_ID: - description: ID of the object - type: - - integer - - "null" - LINK_OBJECT_NAME: - description: Name of the linked object - type: - - string - - "null" - LINK_OBJECT_ID: - description: ID of the linked object - type: - - integer - - "null" - ROLE: - description: Role of the link in the relationship - type: - - string - - "null" - DETAILS: - description: Details of the link - type: - - string - - "null" - RELATIONSHIP_ID: - description: ID of the relationship - type: - - integer - - "null" - IS_FORWARD: - description: Indicates if the link is forward - type: - - boolean - - "null" - knowledge_article_categories_stream: - $ref: "#/definitions/base_incremental_stream" - name: "knowledge_article_categories" - primary_key: "CATEGORY_ID" - $parameters: - path: "/KnowledgeArticleCategory/Search" - - schema_loader: - type: InlineSchemaLoader - schema: - $schema: http://json-schema.org/draft-04/schema# - type: object - properties: - CATEGORY_ID: - description: Unique identifier for the knowledge article category. - type: integer - CATEGORY_NAME: - description: Name of the knowledge article category. - type: - - string - - "null" - DESCRIPTION: - description: Detailed description of the knowledge article category. - type: - - string - - "null" - CREATED_USER_ID: - description: - Identifier of the user who created the knowledge article - category. - type: - - integer - - "null" - DATE_CREATED_UTC: - description: Date and time when the knowledge article category was created. - type: - - string - - "null" - format: date-time - DATE_UPDATED_UTC: - description: - Date and time when the knowledge article category was last - updated. - type: - - string - - "null" - format: date-time - knowledge_article_folders_stream: - $ref: "#/definitions/base_incremental_stream" - name: "knowledge_article_folders" - primary_key: "FOLDER_ID" - $parameters: - path: "/KnowledgeArticleFolder/Search" - - schema_loader: - type: InlineSchemaLoader - schema: - $schema: http://json-schema.org/draft-04/schema# - type: object - properties: - FOLDER_ID: - description: Unique identifier for the knowledge article folder. - type: integer - FOLDER_NAME: - description: The name of the knowledge article folder. - type: - - string - - "null" - CATEGORY_ID: - description: - Unique identifier for the knowledge article category to which - the folder belongs. - type: - - string - - "null" - VISIBILITY: - description: - Indicates the visibility of the knowledge article folder - (e.g., public, private, restricted). - type: - - string - - "null" - ORDER_ARTICLES: - description: Defines the order in which articles appear within the folder. - type: - - string - - "null" - CREATED_USER_ID: - description: - Unique identifier of the user who created the knowledge article - folder. - type: - - integer - - "null" - DATE_CREATED_UTC: - description: The date and time when the knowledge article folder was created. - type: - - string - - "null" - format: date-time - DATE_UPDATED_UTC: - description: - The date and time when the knowledge article folder was last - updated. - type: - - string - - "null" - format: date-time - knowledge_articles_stream: - $ref: "#/definitions/base_incremental_stream" - name: "knowledge_articles" - primary_key: "ARTICLE_ID" - $parameters: - path: "/KnowledgeArticle/Search" - - schema_loader: - type: InlineSchemaLoader - schema: - $schema: http://json-schema.org/draft-04/schema# - type: object - properties: - ARTICLE_ID: - description: The unique identifier for the knowledge article - type: integer - CATEGORY_ID: - description: The category ID to which the article belongs - type: - - integer - - "null" - FOLDER_ID: - description: The ID of the folder where the article is stored - type: - - integer - - "null" - ARTICLE_NO: - description: The article number for reference - type: - - integer - - "null" - ArticleVersion: - description: The version of the article - type: - - string - - "null" - Status: - description: The status of the article (e.g., draft, published) - type: - - string - - "null" - Language: - description: The language in which the article is written - type: - - string - - "null" - Title: - description: The title of the knowledge article - type: - - string - - "null" - Body: - description: The main content of the knowledge article - type: - - string - - "null" - URL_SLUG: - description: The URL-friendly slug for the article - type: - - string - - "null" - DOWNVOTE_COUNT: - description: Number of downvotes received for the article - type: - - integer - - "null" - UPVOTE_COUNT: - description: Number of upvotes received for the article - type: - - integer - - "null" - PROMOTED: - description: Indicates if the article is promoted or not - type: - - boolean - - "null" - FIRST_PUBLISHED_DATE_UTC: - description: - The date and time when the article was first published in - UTC timezone - type: - - string - - "null" - format: date-time - LAST_PUBLISHED_DATE_UTC: - description: - The date and time when the article was last published in - UTC timezone - type: - - string - - "null" - format: date-time - ARCHIVED_DATE_UTC: - description: The date and time when the article was archived in UTC timezone - type: - - string - - "null" - format: date-time - DATE_CREATED_UTC: - description: The date and time when the article was created in UTC timezone - type: - - string - - "null" - format: date-time - DATE_UPDATED_UTC: - description: - The date and time when the article was last updated in UTC - timezone - type: - - string - - "null" - format: date-time - OWNER_USER_ID: - description: The user ID of the owner of the article - type: - - integer - - "null" - CREATED_USER_ID: - description: The user ID of the creator of the knowledge article - type: - - integer - - "null" - ExternalLinkCount: - description: Number of external links referenced in the article - type: - - string - - "null" - CUSTOMFIELDS: - description: Custom fields associated with the article - type: array - items: - type: object - properties: - FIELD_NAME: - description: Name of the custom field - type: - - string - - "null" - FIELD_VALUE: - description: Value of the custom field - type: object - TAGS: - description: Tags associated with the article - type: array - items: - type: object - properties: - TAG_NAME: - description: The name of the tag - type: - - string - - "null" - leads_stream: - $ref: "#/definitions/base_incremental_stream" - name: "leads" - primary_key: "LEAD_ID" - $parameters: - path: "/Leads/Search" - - lead_sources_stream: - $ref: "#/definitions/base_stream" - name: "lead_sources" - primary_key: "LEAD_SOURCE_ID" - $parameters: - path: "/LeadSources" - - schema_loader: - type: InlineSchemaLoader - schema: - $schema: http://json-schema.org/draft-04/schema# - type: object - properties: - LEAD_SOURCE_ID: - description: The unique identifier for the lead source. - type: integer - LEAD_SOURCE: - description: The name or label of the lead source. - type: - - string - - "null" - DEFAULT_VALUE: - description: - The default value for the lead source, used when no specific - lead source is assigned. - type: - - boolean - - "null" - FIELD_ORDER: - description: The order in which the lead sources are displayed or prioritized. - type: - - integer - - "null" - lead_statuses_stream: - $ref: "#/definitions/base_stream" - name: "lead_statuses" - primary_key: "LEAD_STATUS_ID" - $parameters: - path: "/LeadStatuses" - - schema_loader: - type: InlineSchemaLoader - schema: - $schema: http://json-schema.org/draft-04/schema# - type: object - properties: - LEAD_STATUS_ID: - description: Unique identifier for each lead status. - type: integer - LEAD_STATUS: - description: Represents the name or label of the lead status. - type: - - string - - "null" - DEFAULT_STATUS: - description: Specifies the default status for leads. - type: - - boolean - - "null" - STATUS_TYPE: - description: Indicates the type or category of the lead status. - type: - - integer - - "null" - FIELD_ORDER: - description: Designates the order of fields for lead status. - type: - - integer - - "null" - milestones_stream: - $ref: "#/definitions/base_incremental_stream" - name: "milestones" - primary_key: "MILESTONE_ID" - $parameters: - path: "/Milestones/Search" - - schema_loader: - type: InlineSchemaLoader - schema: - $schema: http://json-schema.org/draft-04/schema# - type: object - properties: - MILESTONE_ID: - description: Unique identifier for the milestone - type: integer - TITLE: - description: Title or name of the milestone - type: - - string - - "null" - COMPLETED: - description: Flag indicating if the milestone has been completed or not - type: - - boolean - - "null" - DUE_DATE: - description: Due date for completion of the milestone - type: - - string - - "null" - OWNER_USER_ID: - description: User ID of the owner of the milestone - type: - - integer - - "null" - DATE_CREATED_UTC: - description: Date and time when the milestone was created in UTC - type: - - string - - "null" - format: date-time - DATE_UPDATED_UTC: - description: Date and time when the milestone was last updated in UTC - type: - - string - - "null" - format: date-time - COMPLETED_DATE_UTC: - description: Date and time when the milestone was completed in UTC - type: - - string - - "null" - format: date-time - PROJECT_ID: - description: Identifier of the project to which the milestone belongs - type: - - integer - - "null" - RESPONSIBLE_USER: - description: User responsible for completing the milestone - type: - - integer - - "null" - notes_stream: - $ref: "#/definitions/base_incremental_stream" - name: "notes" - primary_key: "NOTE_ID" - $parameters: - path: "/Notes/Search" - - schema_loader: - type: InlineSchemaLoader - schema: - $schema: http://json-schema.org/draft-04/schema# - type: object - properties: - NOTE_ID: - description: The unique identifier of the note. - type: integer - TITLE: - description: The title or subject of the note. - type: - - string - - "null" - BODY: - description: The content or text of the note. - type: - - string - - "null" - DATE_CREATED_UTC: - description: The date and time the note was created in UTC timezone. - type: - - string - - "null" - format: date-time - DATE_UPDATED_UTC: - description: The date and time the note was last updated in UTC timezone. - type: - - string - - "null" - format: date-time - OWNER_USER_ID: - description: The ID of the user who owns the note. - type: - - integer - - "null" - LINKS: - description: Array of links associated with the note. - type: array - items: - type: object - properties: - LINK_ID: - description: The ID of the link. - type: - - integer - - "null" - OBJECT_NAME: - description: The name of the linked object. - type: - - string - - "null" - OBJECT_ID: - description: The ID of the linked object. - type: - - integer - - "null" - LINK_OBJECT_NAME: - description: The name of the object the link is associated with. - type: - - string - - "null" - LINK_OBJECT_ID: - description: The ID of the object the link is associated with. - type: - - integer - - "null" - ROLE: - description: The role or type of relationship between the objects. - type: - - string - - "null" - DETAILS: - description: Additional details or description for the link. - type: - - string - - "null" - RELATIONSHIP_ID: - description: The ID of the relationship between the objects. - type: - - integer - - "null" - IS_FORWARD: - description: Indicates if the link is forward or backward. - type: - - boolean - - "null" - opportunities_stream: - $ref: "#/definitions/base_incremental_stream" - name: "opportunities" - primary_key: "OPPORTUNITY_ID" - $parameters: - path: "/Opportunities/Search" - - schema_loader: - type: InlineSchemaLoader - schema: - $schema: http://json-schema.org/draft-04/schema# - additionalProperties: true - type: object - properties: - OPPORTUNITY_ID: - description: The unique identifier of the opportunity - type: integer - OPPORTUNITY_NAME: - description: The name of the opportunity - type: - - string - - "null" - OPPORTUNITY_DETAILS: - description: Detailed information about the opportunity - type: - - string - - "null" - OPPORTUNITY_STATE: - description: The state of the opportunity - type: - - string - - "null" - RESPONSIBLE_USER_ID: - description: The ID of the user responsible for the opportunity - type: - - integer - - "null" - CATEGORY_ID: - description: The category ID associated with the opportunity - type: - - integer - - "null" - IMAGE_URL: - description: URL of any image associated with the opportunity - type: - - string - - "null" - BID_CURRENCY: - description: The currency used for the bid amount - type: - - string - - "null" - BID_AMOUNT: - description: The amount bid for the opportunity - type: - - number - - "null" - BID_TYPE: - description: The type of bid placed - type: - - string - - "null" - BID_DURATION: - description: The duration for which the bid is valid - type: - - integer - - "null" - ACTUAL_CLOSE_DATE: - description: The actual date when the opportunity was closed - type: - - string - - "null" - format: date-time - DATE_CREATED_UTC: - description: The date and time when the opportunity was created (in UTC) - type: - - string - - "null" - format: date-time - DATE_UPDATED_UTC: - description: - The date and time when the opportunity was last updated (in - UTC) - type: - - string - - "null" - format: date-time - OPPORTUNITY_VALUE: - description: The value associated with the opportunity - type: - - number - - "null" - PROBABILITY: - description: The probability of the opportunity being successful - type: - - integer - - "null" - FORECAST_CLOSE_DATE: - description: The forecasted date for closing the opportunity - type: - - string - - "null" - format: date-time - OWNER_USER_ID: - description: The ID of the user who owns the opportunity - type: - - integer - - "null" - LAST_ACTIVITY_DATE_UTC: - description: - The date and time of the last activity related to the opportunity - (in UTC) - type: - - string - - "null" - format: date-time - NEXT_ACTIVITY_DATE_UTC: - description: The date and time of the next planned activity (in UTC) - type: - - string - - "null" - format: date-time - PIPELINE_ID: - description: The ID of the pipeline the opportunity belongs to - type: - - integer - - "null" - STAGE_ID: - description: The ID of the stage the opportunity is in - type: - - integer - - "null" - CREATED_USER_ID: - description: The ID of the user who created the opportunity - type: - - integer - - "null" - ORGANISATION_ID: - description: The ID of the organization associated with the opportunity - type: - - integer - - "null" - PRICEBOOK_ID: - description: The ID of the price book associated with the opportunity - type: - - integer - - "null" - VISIBLE_TEAM_ID: - description: The ID of the team with visibility rights to the opportunity - type: - - integer - - "null" - VISIBLE_TO: - description: The visibility settings for the opportunity - type: - - string - - "null" - CUSTOMFIELDS: - description: Custom fields associated with the opportunity - type: array - items: - type: object - properties: - FIELD_NAME: - description: Name of the custom field - type: - - string - - "null" - FIELD_VALUE: - description: Value of the custom field - type: object - TAGS: - description: Tags associated with the opportunity - type: array - items: - type: object - properties: - TAG_NAME: - description: Name of the tag associated with the opportunity - type: - - string - - "null" - required: - - TAG_NAME - LINKS: - description: Links associated with the opportunity - type: array - items: - type: object - properties: - LINK_ID: - description: ID of the linked object - type: - - integer - - "null" - OBJECT_NAME: - description: Name of the linked object - type: - - string - - "null" - OBJECT_ID: - description: ID of the linked object - type: - - integer - - "null" - LINK_OBJECT_NAME: - description: Name of the linked object - type: - - string - - "null" - LINK_OBJECT_ID: - description: ID of the linked object - type: - - integer - - "null" - ROLE: - description: Role of the link - type: - - string - - "null" - DETAILS: - description: Details of the link - type: - - string - - "null" - RELATIONSHIP_ID: - description: ID of the relationship - type: - - integer - - "null" - IS_FORWARD: - description: Indicates if the link is being forwarded - type: - - boolean - - "null" - opportunity_categories_stream: - $ref: "#/definitions/base_stream" - name: "opportunity_categories" - primary_key: "CATEGORY_ID" - $parameters: - path: "/OpportunityCategories" - - schema_loader: - type: InlineSchemaLoader - schema: - $schema: http://json-schema.org/draft-04/schema# - type: object - properties: - CATEGORY_ID: - description: The unique identifier for the opportunity category - type: integer - CATEGORY_NAME: - description: The name or label of the opportunity category - type: - - string - - "null" - ACTIVE: - description: Indicates whether the opportunity category is active or inactive - type: - - boolean - - "null" - BACKGROUND_COLOR: - description: The background color associated with the opportunity category - type: - - string - - "null" - opportunity_products_stream: - $ref: "#/definitions/base_incremental_stream" - name: "opportunity_products" - primary_key: "OPPORTUNITY_ITEM_ID" - $parameters: - path: "/OpportunityLineItem/Search" - - opportunity_state_reasons_stream: - $ref: "#/definitions/base_stream" - name: "opportunity_state_reasons" - primary_key: "STATE_REASON_ID" - $parameters: - path: "/OpportunityStateReasons" - - schema_loader: - type: InlineSchemaLoader - schema: - $schema: http://json-schema.org/draft-04/schema# - type: object - properties: - STATE_REASON_ID: - description: Unique identifier for the state reason. - type: integer - STATE_REASON: - description: The reason associated with the opportunity state. - type: - - string - - "null" - FOR_OPPORTUNITY_STATE: - description: - The particular opportunity state that the reason applies - to. - type: - - string - - "null" - organisations_stream: - $ref: "#/definitions/base_incremental_stream" - name: "organisations" - primary_key: "ORGANISATION_ID" - $parameters: - path: "/Organisations/Search" - - schema_loader: - type: InlineSchemaLoader - schema: - $schema: http://json-schema.org/draft-04/schema# - additionalProperties: true - type: object - properties: - ORGANISATION_ID: - description: The unique ID of the organisation. - type: integer - ORGANISATION_NAME: - description: The name of the organisation. - type: - - string - - "null" - BACKGROUND: - description: Background information or description about the organisation. - type: - - string - - "null" - IMAGE_URL: - description: URL of the image associated with the organisation. - type: - - string - - "null" - OWNER_USER_ID: - description: The user ID of the owner of the organisation. - type: - - integer - - "null" - DATE_CREATED_UTC: - description: - The date and time when the organisation record was created - in Coordinated Universal Time (UTC). - type: - - string - - "null" - format: date-time - DATE_UPDATED_UTC: - description: - The date and time when the organisation record was last updated - in Coordinated Universal Time (UTC). - type: - - string - - "null" - format: date-time - LAST_ACTIVITY_DATE_UTC: - description: - The date and time of the last activity related to the organisation - in Coordinated Universal Time (UTC). - type: - - string - - "null" - format: date-time - NEXT_ACTIVITY_DATE_UTC: - description: - The date and time of the next planned activity related to - the organisation in Coordinated Universal Time (UTC). - type: - - string - - "null" - format: date-time - CREATED_USER_ID: - description: The user ID of the user who created the organisation record. - type: - - integer - - "null" - PHONE: - description: The phone number associated with the organisation. - type: - - string - - "null" - PHONE_FAX: - description: The fax number associated with the organisation. - type: - - string - - "null" - WEBSITE: - description: Website URL of the organisation. - type: - - string - - "null" - ADDRESS_BILLING_STREET: - description: The street address of the billing address of the organisation. - type: - - string - - "null" - ADDRESS_BILLING_CITY: - description: The city of the billing address of the organisation. - type: - - string - - "null" - ADDRESS_BILLING_STATE: - description: The state of the billing address of the organisation. - type: - - string - - "null" - ADDRESS_BILLING_COUNTRY: - description: The country of the billing address of the organisation. - type: - - string - - "null" - ADDRESS_BILLING_POSTCODE: - description: The postal code of the billing address of the organisation. - type: - - string - - "null" - ADDRESS_SHIP_STREET: - description: The street address of the shipping address of the organisation. - type: - - string - - "null" - ADDRESS_SHIP_CITY: - description: The city of the shipping address of the organisation. - type: - - string - - "null" - ADDRESS_SHIP_STATE: - description: The state of the shipping address of the organisation. - type: - - string - - "null" - ADDRESS_SHIP_POSTCODE: - description: The postal code of the shipping address of the organisation. - type: - - string - - "null" - ADDRESS_SHIP_COUNTRY: - description: The country of the shipping address of the organisation. - type: - - string - - "null" - SOCIAL_LINKEDIN: - description: LinkedIn profile URL associated with the organisation. - type: - - string - - "null" - SOCIAL_FACEBOOK: - description: Facebook page URL associated with the organisation. - type: - - string - - "null" - SOCIAL_TWITTER: - description: Twitter handle associated with the organisation. - type: - - string - - "null" - VISIBLE_TEAM_ID: - description: The team ID that has visibility permission for the organisation. - type: - - integer - - "null" - VISIBLE_TO: - description: Visibility level of the organisation. - type: - - string - - "null" - CUSTOMFIELDS: - description: Custom fields associated with the organisation. - type: array - items: - type: object - properties: - FIELD_NAME: - description: The name of the custom field. - type: - - string - - "null" - FIELD_VALUE: - description: The value of the custom field. - type: object - TAGS: - description: Tags associated with the organisation. - type: array - items: - type: object - properties: - TAG_NAME: - description: The name of the tag. - type: - - string - - "null" - DATES: - description: Important dates associated with the organisation. - type: array - items: - type: object - properties: - DATE_ID: - description: The ID of the date record. - type: - - integer - - "null" - OCCASION_NAME: - description: Name of the occasion associated with the date. - type: - - string - - "null" - OCCASION_DATE: - description: The date of a particular occasion. - type: - - string - - "null" - REPEAT_YEARLY: - description: Flag indicating if the occasion repeats yearly. - type: - - boolean - - "null" - CREATE_TASK_YEARLY: - description: Flag indicating if a task is created yearly. - type: - - boolean - - "null" - EMAILDOMAINS: - description: Email domains associated with the organisation. - type: array - items: - type: object - properties: - EMAIL_DOMAIN_ID: - description: The ID of the email domain. - type: - - integer - - "null" - EMAIL_DOMAIN: - description: - The domain of an email address associated with the - organisation. - type: - - string - - "null" - LINKS: - description: Links related to the organisation. - type: array - items: - type: object - properties: - LINK_ID: - description: The ID of the link. - type: - - integer - - "null" - OBJECT_NAME: - description: - Name of the organisation or entity the link is associated - with. - type: - - string - - "null" - OBJECT_ID: - description: - The ID of the organisation or entity the link is associated - with. - type: - - integer - - "null" - LINK_OBJECT_NAME: - description: Name of the object linked to. - type: - - string - - "null" - LINK_OBJECT_ID: - description: The ID of the object linked to. - type: - - integer - - "null" - ROLE: - description: Role of the organisation in the linked relationship. - type: - - string - - "null" - DETAILS: - description: Details of the link. - type: - - string - - "null" - RELATIONSHIP_ID: - description: The ID of the relationship between the linked objects. - type: - - integer - - "null" - IS_FORWARD: - description: Flag indicating if the link is in a forward direction. - type: - - boolean - - "null" - pipelines_stream: - $ref: "#/definitions/base_stream" - name: "pipelines" - primary_key: "PIPELINE_ID" - $parameters: - path: "/Pipelines" - - schema_loader: - type: InlineSchemaLoader - schema: - $schema: http://json-schema.org/draft-04/schema# - type: object - properties: - PIPELINE_ID: - description: Unique identifier of the pipeline - type: integer - PIPELINE_NAME: - description: Name of the pipeline - type: - - string - - "null" - FOR_OPPORTUNITIES: - description: Flag indicating if the pipeline is for opportunities - type: - - boolean - - "null" - FOR_PROJECTS: - description: Flag indicating if the pipeline is for projects - type: - - boolean - - "null" - OWNER_USER_ID: - description: Unique identifier of the user who owns the pipeline - type: - - integer - - "null" - pipeline_stages_stream: - $ref: "#/definitions/base_stream" - name: "pipeline_stages" - primary_key: "STAGE_ID" - $parameters: - path: "/PipelineStages" - - schema_loader: - type: InlineSchemaLoader - schema: - $schema: http://json-schema.org/draft-04/schema# - type: object - properties: - STAGE_ID: - description: Unique identifier for the pipeline stage - type: integer - PIPELINE_ID: - description: Unique identifier for the pipeline to which the stage belongs - type: - - integer - - "null" - STAGE_NAME: - description: Name or label for the pipeline stage - type: - - string - - "null" - STAGE_ORDER: - description: - Numerical order value indicating the position of the pipeline - stage in the pipeline flow - type: - - integer - - "null" - ACTIVITYSET_ID: - description: - Unique identifier for the activity set associated with the - pipeline stage - type: - - integer - - "null" - OWNER_USER_ID: - description: - Unique identifier for the user who owns or is responsible - for the pipeline stage - type: - - integer - - "null" - pricebook_entries_stream: - $ref: "#/definitions/base_incremental_stream" - name: "price_book_entries" - primary_key: "PRICEBOOK_ENTRY_ID" - $parameters: - path: "/PricebookEntry/Search" - - pricebooks_stream: - $ref: "#/definitions/base_incremental_stream" - name: "price_books" - primary_key: "PRICEBOOK_ID" - $parameters: - path: "/Pricebook/Search" - - products_stream: - $ref: "#/definitions/base_incremental_stream" - name: "products" - primary_key: "PRODUCT_ID" - $parameters: - path: "/Product/Search" - - project_categories_stream: - $ref: "#/definitions/base_stream" - name: "project_categories" - primary_key: "CATEGORY_ID" - $parameters: - path: "/ProjectCategories" - - schema_loader: - type: InlineSchemaLoader - schema: - $schema: http://json-schema.org/draft-04/schema# - type: object - properties: - CATEGORY_ID: - description: Unique identifier for the project category - type: integer - CATEGORY_NAME: - description: The name or title of the project category - type: - - string - - "null" - ACTIVE: - description: - Indicates if the project category is currently active or - not - type: - - boolean - - "null" - BACKGROUND_COLOR: - description: The background color associated with the project category - type: - - string - - "null" - projects_stream: - $ref: "#/definitions/base_incremental_stream" - name: "projects" - primary_key: "PROJECT_ID" - $parameters: - path: "/Projects/Search" - - schema_loader: - type: InlineSchemaLoader - schema: - $schema: http://json-schema.org/draft-04/schema# - additionalProperties: true - type: object - properties: - PROJECT_ID: - description: Unique identifier for the project. - type: integer - PROJECT_NAME: - description: Name of the project. - type: - - string - - "null" - STATUS: - description: Status of the project. - type: - - string - - "null" - PROJECT_DETAILS: - description: Details or description of the project. - type: - - string - - "null" - STARTED_DATE: - description: Date and time when the project was started. - type: - - string - - "null" - format: date-time - COMPLETED_DATE: - description: Date and time when the project was completed. - type: - - string - - "null" - format: date-time - OPPORTUNITY_ID: - description: - Unique identifier of the opportunity associated with the - project. - type: - - integer - - "null" - CATEGORY_ID: - description: Unique identifier for the project category. - type: - - integer - - "null" - PIPELINE_ID: - description: Unique identifier of the pipeline to which the project belongs. - type: - - integer - - "null" - STAGE_ID: - description: Unique identifier of the stage to which the project belongs. - type: - - integer - - "null" - IMAGE_URL: - description: URL of the image associated with the project. - type: - - string - - "null" - OWNER_USER_ID: - description: Unique identifier of the user who owns the project. - type: - - integer - - "null" - DATE_CREATED_UTC: - description: Date and time when the project was created (in UTC). - type: - - string - - "null" - format: date-time - DATE_UPDATED_UTC: - description: Date and time when the project was last updated (in UTC). - type: - - string - - "null" - format: date-time - LAST_ACTIVITY_DATE_UTC: - description: - Date and time of the last activity related to the project - (in UTC). - type: - - string - - "null" - NEXT_ACTIVITY_DATE_UTC: - description: - Date and time of the next activity related to the project - (in UTC). - type: - - string - - "null" - CREATED_USER_ID: - description: Unique identifier of the user who created the project. - type: - - integer - - "null" - RESPONSIBLE_USER_ID: - description: Unique identifier of the user responsible for the project. - type: - - integer - - "null" - VISIBLE_TEAM_ID: - description: Unique identifier of the team that can view the project. - type: - - integer - - "null" - VISIBLE_TO: - description: Visibility setting for the project. - type: - - string - - "null" - CUSTOMFIELDS: - description: Custom fields associated with the project. - type: array - items: - type: object - properties: - FIELD_NAME: - description: Name of the custom field. - type: - - string - - "null" - FIELD_VALUE: - description: Value of the custom field. - type: object - TAGS: - description: Tags associated with the project. - type: array - items: - type: object - properties: - TAG_NAME: - description: Name of the tag. - type: - - string - - "null" - LINKS: - description: Links associated with the project. - type: array - items: - type: object - properties: - LINK_ID: - description: Unique identifier for the link. - type: - - integer - - "null" - OBJECT_NAME: - description: Name of the object. - type: - - string - - "null" - OBJECT_ID: - description: Unique identifier of the object. - type: - - integer - - "null" - LINK_OBJECT_NAME: - description: Name of the linked object. - type: - - string - - "null" - LINK_OBJECT_ID: - description: Unique identifier of the linked object. - type: - - integer - - "null" - ROLE: - description: Role associated with the link. - type: - - string - - "null" - DETAILS: - description: Details of the link. - type: - - string - - "null" - RELATIONSHIP_ID: - description: Unique identifier for the relationship. - type: - - integer - - "null" - IS_FORWARD: - description: Flag indicating if the link is forward. - type: - - boolean - - "null" - prospects_stream: - $ref: "#/definitions/base_incremental_stream" - name: "prospects" - primary_key: "PROSPECT_ID" - $parameters: - path: "/Prospect/Search" - - schema_loader: - type: InlineSchemaLoader - schema: - $schema: http://json-schema.org/draft-04/schema# - type: object - properties: - PROSPECT_ID: - description: The ID of the prospect. - type: integer - LEAD_ID: - description: The ID of the lead associated with the prospect. - type: - - integer - - "null" - CONTACT_ID: - description: The ID of the contact associated with the prospect. - type: - - integer - - "null" - ORGANISATION_ID: - description: The ID of the organization associated with the prospect. - type: - - integer - - "null" - SALUTATION: - description: The salutation or title used when addressing the prospect. - type: - - string - - "null" - FIRST_NAME: - description: The first name of the prospect. - type: - - string - - "null" - LAST_NAME: - description: The last name of the prospect. - type: - - string - - "null" - ORGANISATION_NAME: - description: The name of the organization associated with the prospect. - type: - - string - - "null" - TITLE: - description: The job title of the prospect. - type: - - string - - "null" - EMAIL_ADDRESS: - description: The email address of the prospect. - type: - - string - - "null" - PHONE: - description: The phone number of the prospect. - type: - - string - - "null" - MOBILE: - description: The mobile number of the prospect. - type: - - string - - "null" - FAX: - description: The fax number of the prospect. - type: - - string - - "null" - WEBSITE: - description: The website URL of the prospect's organization. - type: - - string - - "null" - ADDRESS_STREET: - description: The street address of the prospect. - type: - - string - - "null" - ADDRESS_CITY: - description: The city where the prospect is located. - type: - - string - - "null" - ADDRESS_STATE: - description: The state or region where the prospect is located. - type: - - string - - "null" - ADDRESS_POSTCODE: - description: The postcode of the prospect's address. - type: - - string - - "null" - ADDRESS_COUNTRY: - description: The country where the prospect is located. - type: - - string - - "null" - INDUSTRY: - description: The industry of the prospect. - type: - - string - - "null" - EMPLOYEE_COUNT: - description: The number of employees in the prospect's organization. - type: - - integer - - "null" - SCORE: - description: The score assigned to the prospect. - type: - - integer - - "null" - GRADE: - description: The grade of the prospect. - type: - - string - - "null" - DESCRIPTION: - description: A description or notes related to the prospect. - type: - - string - - "null" - DO_NOT_EMAIL: - description: Indicates if the prospect should not be contacted via email. - type: - - boolean - - "null" - DO_NOT_CALL: - description: Indicates if the prospect should not be contacted via phone. - type: - - boolean - - "null" - OPTED_OUT: - description: Indicates if the prospect has opted out of communications. - type: - - boolean - - "null" - LAST_ACTIVITY_DATE_UTC: - description: The date and time of the prospect's last activity in UTC. - type: - - string - - "null" - format: date-time - CREATED_USER_ID: - description: The ID of the user who created the prospect. - type: - - integer - - "null" - OWNER_USER_ID: - description: The ID of the user who owns or is responsible for the prospect. - type: - - integer - - "null" - DATE_CREATED_UTC: - description: The date and time when the prospect was created in UTC. - type: - - string - - "null" - format: date-time - DATE_UPDATED_UTC: - description: The date and time when the prospect was last updated in UTC. - type: - - string - - "null" - format: date-time - DO_NOT_SYNC: - description: Indicates if the prospect should not be synchronized. - type: - - boolean - - "null" - LEAD_CONVERSION_DATE_UTC: - description: - The date and time when the prospect was converted to a lead - in UTC. - type: - - string - - "null" - format: date-time - GRADE_PROFILE_ID: - description: The ID of the grade profile associated with the prospect. - type: - - integer - - "null" - CUSTOMFIELDS: - description: Custom fields associated with the prospect - type: array - items: - type: object - properties: - FIELD_NAME: - description: The name of a custom field. - type: - - string - - "null" - FIELD_VALUE: - description: The value of the custom field. - type: object - TAGS: - description: Tags associated with the prospect - type: array - items: - type: object - properties: - TAG_NAME: - description: The name of a tag associated with the prospect. - type: - - string - - "null" - quote_products_stream: - $ref: "#/definitions/base_incremental_stream" - name: "quote_products" - primary_key: "QUOTATION_ITEM_ID" - $parameters: - path: "/QuotationLineItem/Search" - - quotes_stream: - $ref: "#/definitions/base_incremental_stream" - name: "quotes" - primary_key: "QUOTE_ID" - $parameters: - path: "/Quotation/Search" + username: '{{ config[''token''] }}' + password: '{{ config[''nothing''] }}' - relationships_stream: - $ref: "#/definitions/base_stream" - name: "relationships" - primary_key: "RELATIONSHIP_ID" - $parameters: - path: "/Relationships" - - schema_loader: - type: InlineSchemaLoader - schema: - $schema: http://json-schema.org/draft-04/schema# - type: object - properties: - RELATIONSHIP_ID: - description: The unique identifier for this relationship. - type: integer - FORWARD_TITLE: - description: The name or title of the object on one side of the relationship. - type: - - string - - "null" - FORWARD: - description: The ID of the object on one side of the relationship. - type: - - string - - "null" - REVERSE_TITLE: - description: - The name or title of the object on the other side of the - relationship. - type: - - string - - "null" - REVERSE: - description: The ID of the object on the other side of the relationship. - type: - - string - - "null" - FOR_CONTACTS: - description: List of contacts associated with this relationship. - type: - - boolean - - "null" - FOR_ORGANISATIONS: - description: List of organizations associated with this relationship. - type: - - boolean - - "null" - tags_stream: - $ref: "#/definitions/base_stream" - name: "tags" - primary_key: "TAG_NAME" - $parameters: - path: "/Tags" - - task_categories_stream: - $ref: "#/definitions/base_stream" - name: "task_categories" - primary_key: "CATEGORY_ID" - $parameters: - path: "/TaskCategories" - - schema_loader: - type: InlineSchemaLoader - schema: - $schema: http://json-schema.org/draft-04/schema# - type: object - properties: - CATEGORY_ID: - description: Unique identifier for the task category. - type: integer - CATEGORY_NAME: - description: The name or label assigned to the task category. - type: - - string - - "null" - ACTIVE: - description: - Flag indicating if the task category is currently active - or not. - type: - - boolean - - "null" - BACKGROUND_COLOR: - description: - The background color associated with the task category for - visual representation. - type: - - string - - "null" - tasks_stream: - $ref: "#/definitions/base_incremental_stream" - name: "tasks" - primary_key: "TASK_ID" - $parameters: - path: "/Tasks/Search" - - schema_loader: - type: InlineSchemaLoader - schema: - $schema: http://json-schema.org/draft-04/schema# - additionalProperties: true - type: object - properties: - TASK_ID: - description: The unique ID of the task. - type: integer - TITLE: - description: The title or name of the task. - type: - - string - - "null" - CATEGORY_ID: - description: The category ID associated with the task. - type: - - integer - - "null" - DUE_DATE: - description: The deadline or due date for the task. - type: - - string - - "null" - format: date-time - COMPLETED_DATE_UTC: - description: The date and time when the task was completed. - type: - - string - - "null" - format: date-time - COMPLETED: - description: Indicates if the task has been completed or not. - type: - - boolean - - "null" - DETAILS: - description: Additional details or description of the task. - type: - - string - - "null" - STATUS: - description: The current status of the task. - type: - - string - - "null" - PRIORITY: - description: The priority level of the task. - type: - - integer - - "null" - PERCENT_COMPLETE: - description: The completion percentage of the task. - type: - - integer - - "null" - PUBLICLY_VISIBLE: - description: Indicates if the task is publicly visible. - type: - - "null" - - boolean - START_DATE: - description: The start date of the task. - type: - - string - - "null" - format: date-time - MILESTONE_ID: - description: The milestone ID associated with the task. - type: - - integer - - "null" - RESPONSIBLE_USER_ID: - description: The user ID of the individual responsible for the task. - type: - - integer - - "null" - OWNER_USER_ID: - description: The user ID of the owner of the task. - type: - - integer - - "null" - DATE_CREATED_UTC: - description: The date and time when the task was created. - type: - - string - - "null" - format: date-time - DATE_UPDATED_UTC: - description: The date and time when the task was last updated. - type: - - string - - "null" - format: date-time - EMAIL_ID: - description: The email ID associated with the task. - type: - - integer - - "null" - PROJECT_ID: - description: The project ID associated with the task. - type: - - integer - - "null" - REMINDER_DATE_UTC: - description: The date and time for the reminder of the task. - type: - - string - - "null" - format: date-time - REMINDER_SENT: - description: Indicates if a reminder has been sent for the task. - type: - - boolean - - "null" - OWNER_VISIBLE: - description: Indicates if the owner is visible or not. - type: - - boolean - - "null" - STAGE_ID: - description: The stage ID of the task. - type: - - integer - - "null" - ASSIGNED_BY_USER_ID: - description: The user ID of the individual who assigned the task. - type: - - integer - - "null" - PARENT_TASK_ID: - description: The ID of the parent task if this task is a subtask. - type: - - integer - - "null" - RECURRENCE: - description: Details of any recurring pattern for the task. - type: - - string - - "null" - OPPORTUNITY_ID: - description: The opportunity ID associated with the task. - type: - - integer - - "null" - ASSIGNED_TEAM_ID: - description: The team ID to which the task is assigned. - type: - - integer - - "null" - ASSIGNED_DATE_UTC: - description: The date and time when the task was assigned. - type: - - string - - "null" - format: date-time - CREATED_USER_ID: - description: The user ID of the user who created the task. - type: - - integer - - "null" - CUSTOMFIELDS: - description: Custom fields associated with the task. - type: array - items: - type: object - properties: - FIELD_NAME: - description: The name of the custom field. - type: - - string - - "null" - FIELD_VALUE: - description: The value of the custom field. - type: object - LINKS: - description: Links related to the task. - type: array - items: - type: object - properties: - LINK_ID: - description: The ID of the link. - type: - - integer - - "null" - OBJECT_NAME: - description: The name of the object linked to the task. - type: - - string - - "null" - OBJECT_ID: - description: The ID of the object linked to the task. - type: - - integer - - "null" - LINK_OBJECT_NAME: - description: The name of the object associated with the link. - type: - - string - - "null" - LINK_OBJECT_ID: - description: The object ID associated with the link. - type: - - integer - - "null" - ROLE: - description: The role associated with the link. - type: - - string - - "null" - DETAILS: - description: Details or description of the link. - type: - - string - - "null" - RELATIONSHIP_ID: - description: The relationship ID associated with the link. - type: - - integer - - "null" - IS_FORWARD: - description: Indicates if the link is forward or not. - type: - - boolean - - "null" - team_members_stream: - $ref: "#/definitions/base_stream" - name: "team_members" - primary_key: "MEMBER_USER_ID" - $parameters: - path: "/TeamMembers" - - schema_loader: - type: InlineSchemaLoader - schema: - $schema: http://json-schema.org/draft-07/schema# - type: object - properties: - PERMISSION_ID: - description: The permission level associated with the team member - type: - - integer - - "null" - TEAM_ID: - description: The identifier for the team to which the member belongs - type: - - integer - - "null" - MEMBER_USER_ID: - description: The unique identifier for the team member user - type: integer - teams_stream: - $ref: "#/definitions/base_stream" - name: "teams" - primary_key: "TEAM_ID" - $parameters: - path: "/Teams" - - schema_loader: - type: InlineSchemaLoader - schema: - $schema: http://json-schema.org/draft-07/schema# - additionalProperties: true - type: object - properties: - TEAM_ID: - description: The unique identifier for the team. - type: integer - TEAM_NAME: - description: The name of the team. - type: - - string - - "null" - ANONYMOUS_TEAM: - description: Indicates if the team is anonymous or not. - type: - - boolean - - "null" - DATE_CREATED_UTC: - description: The date and time when the team was created. - type: - - string - - "null" - format: date-time - DATE_UPDATED_UTC: - description: The date and time when the team was last updated. - type: - - string - - "null" - format: date-time - TEAMMEMBERS: - description: List of team members associated with the team. - type: array - tickets_stream: - $ref: "#/definitions/base_incremental_stream" - name: "tickets" - primary_key: "TICKET_ID" - $parameters: - path: "/Ticket/Search" - - users_stream: - $ref: "#/definitions/base_incremental_stream" - name: "users" - primary_key: "USER_ID" - $parameters: - path: "/Users/Search" - - schema_loader: - type: InlineSchemaLoader - schema: - $schema: http://json-schema.org/draft-04/schema# - type: object - properties: - USER_ID: - description: The unique identifier of the user - type: integer - CONTACT_ID: - description: The unique identifier for the user contact - type: - - integer - - "null" - FIRST_NAME: - description: The first name of the user - type: - - string - - "null" - LAST_NAME: - description: The last name of the user - type: - - string - - "null" - TIMEZONE_ID: - description: The timezone identifier of the user - type: - - string - - "null" - EMAIL_ADDRESS: - description: The email address of the user - type: - - string - - "null" - EMAIL_DROPBOX_IDENTIFIER: - description: The Dropbox identifier of the user - type: - - string - - "null" - EMAIL_DROPBOX_ADDRESS: - description: The Dropbox email address associated with the user - type: - - string - - "null" - ADMINISTRATOR: - description: Indicates if the user has administrator privileges - type: - - boolean - - "null" - ACCOUNT_OWNER: - description: Indicates if the user is the owner of the account - type: - - boolean - - "null" - ACTIVE: - description: Indicates if the user is currently active - type: - - boolean - - "null" - DATE_CREATED_UTC: - description: The date and time when the user was created in UTC timezone - type: - - string - - "null" - format: date-time - DATE_UPDATED_UTC: - description: The date and time when the user was last updated in UTC timezone - type: - - string - - "null" - format: date-time - USER_CURRENCY: - description: The currency used by the user - type: - - string - - "null" - CONTACT_DISPLAY: - description: The display name of the user - type: - - string - - "null" - CONTACT_ORDER: - description: The order of the contact - type: - - string - - "null" - TASK_WEEK_START: - description: The start day of the week for tasks - type: - - integer - - "null" - INSTANCE_ID: - description: The unique identifier of the instance - type: - - integer - - "null" - PROFILE_ID: - description: The profile identifier of the user - type: - - integer - - "null" - ROLE_ID: - description: The role identifier of the user - type: - - integer - - "null" streams: - - "#/definitions/activity_sets_stream" - - "#/definitions/contacts_stream" - - "#/definitions/countries_stream" - - "#/definitions/currencies_stream" - - "#/definitions/emails_stream" - - "#/definitions/events_stream" - - "#/definitions/knowledge_article_categories_stream" - - "#/definitions/knowledge_article_folders_stream" - - "#/definitions/knowledge_articles_stream" - # - "#/definitions/leads_stream" - - "#/definitions/lead_sources_stream" - - "#/definitions/lead_statuses_stream" - - "#/definitions/milestones_stream" - - "#/definitions/notes_stream" - - "#/definitions/opportunities_stream" - - "#/definitions/opportunity_categories_stream" - # - "#/definitions/opportunity_products_stream" - - "#/definitions/opportunity_state_reasons_stream" - - "#/definitions/organisations_stream" - - "#/definitions/pipelines_stream" - - "#/definitions/pipeline_stages_stream" - # - "#/definitions/pricebook_entries_stream" - # - "#/definitions/pricebooks_stream" - # - "#/definitions/products_stream" - - "#/definitions/project_categories_stream" - - "#/definitions/projects_stream" - - "#/definitions/prospects_stream" - # - "#/definitions/quote_products_stream" - # - "#/definitions/quotes_stream" - - "#/definitions/relationships_stream" - # - "#/definitions/tags_stream" - - "#/definitions/task_categories_stream" - - "#/definitions/tasks_stream" - - "#/definitions/team_members_stream" - - "#/definitions/teams_stream" - # - "#/definitions/tickets_stream" - - "#/definitions/users_stream" - -check: - type: CheckStream - stream_names: - - "activity_sets" - - "contacts" - # - "countries" - # - "currencies" - # - "opportunities" - # - "opportunity_state_reasons" - # - "organizations" - # - "pipelines" - # - "pipeline_stages" - # - "projects" - # - "relationships" - # - "task_categories" - # - "tasks" - # - "team_members" - # - "teams" - # - "users" + - $ref: '#/definitions/streams/activity_sets' + - $ref: '#/definitions/streams/contacts' + - $ref: '#/definitions/streams/countries' + - $ref: '#/definitions/streams/currencies' + - $ref: '#/definitions/streams/emails' + - $ref: '#/definitions/streams/events' + - $ref: '#/definitions/streams/knowledge_article_categories' + - $ref: '#/definitions/streams/knowledge_article_folders' + - $ref: '#/definitions/streams/knowledge_articles' + - $ref: '#/definitions/streams/lead_sources' + - $ref: '#/definitions/streams/lead_statuses' + - $ref: '#/definitions/streams/milestones' + - $ref: '#/definitions/streams/notes' + - $ref: '#/definitions/streams/opportunities' + - $ref: '#/definitions/streams/opportunity_categories' + - $ref: '#/definitions/streams/opportunity_state_reasons' + - $ref: '#/definitions/streams/organisations' + - $ref: '#/definitions/streams/pipelines' + - $ref: '#/definitions/streams/pipeline_stages' + - $ref: '#/definitions/streams/project_categories' + - $ref: '#/definitions/streams/projects' + - $ref: '#/definitions/streams/prospects' + - $ref: '#/definitions/streams/relationships' + - $ref: '#/definitions/streams/task_categories' + - $ref: '#/definitions/streams/tasks' + - $ref: '#/definitions/streams/team_members' + - $ref: '#/definitions/streams/teams' + - $ref: '#/definitions/streams/users' spec: type: Spec - documentationUrl: https://docs.airbyte.com/integrations/sources/insightly connection_specification: - "$schema": http://json-schema.org/draft-07/schema# - title: Insightly Spec type: object + $schema: http://json-schema.org/draft-07/schema# required: - - token - start_date - additionalProperties: true + - token properties: + start_date: + type: + - string + - 'null' + title: Start Date + format: date-time + pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$ + description: >- + The date from which you'd like to replicate data for Insightly in the + format YYYY-MM-DDT00:00:00Z. All data generated after this date will + be replicated. Note that it will be used only for incremental streams. + examples: + - '2021-03-01T00:00:00Z' + order: 0 token: type: - string - - "null" + - 'null' title: API Token description: Your Insightly API token. airbyte_secret: true - start_date: + order: 1 + additionalProperties: true + +metadata: + autoImportSchema: + activity_sets: false + contacts: false + countries: false + currencies: false + emails: false + events: false + knowledge_article_categories: false + knowledge_article_folders: false + knowledge_articles: false + lead_sources: false + lead_statuses: false + milestones: false + notes: false + opportunities: false + opportunity_categories: false + opportunity_state_reasons: false + organisations: false + pipelines: false + pipeline_stages: false + project_categories: false + projects: false + prospects: false + relationships: false + task_categories: false + tasks: false + team_members: false + teams: false + users: false + +schemas: + activity_sets: + type: object + $schema: http://json-schema.org/draft-07/schema# + properties: + ACTIVITIES: + type: array + description: List of activities included in the activity set + items: + type: object + properties: + ACTIVITYSET_ID: + type: + - integer + - 'null' + description: ID of the activity set to which the activity belongs + ACTIVITY_DETAILS: + type: + - string + - 'null' + description: Details or description of the activity + ACTIVITY_ID: + type: + - integer + - 'null' + description: ID of the activity + ACTIVITY_NAME: + type: + - string + - 'null' + description: Name of the activity + ACTIVITY_TYPE: + type: + - string + - 'null' + description: Type of the activity + ALL_DAY: + type: + - boolean + - 'null' + description: Boolean flag indicating if the activity is an all-day event + ASSIGNED_TEAM_ID: + type: + - integer + - 'null' + description: ID of the team assigned to the activity + CATEGORY_ID: + type: + - integer + - 'null' + description: ID of the category to which the activity belongs + DUE_DAYS_AFTER_START: + type: + - integer + - 'null' + description: >- + Number of days after the start of the activity by which it is + due + DUE_DAYS_BEFORE_END: + type: + - integer + - 'null' + description: Number of days before the end of the activity by which it is due + DURATION: + type: + - integer + - 'null' + description: Duration of the activity + EVENT_DAYS_AFTER_START: + type: + - integer + - 'null' + description: >- + Number of days after the start of the activity when the event + occurs + EVENT_DAYS_BEFORE_END: + type: + - integer + - 'null' + description: >- + Number of days before the end of the activity when the event + occurs + EVENT_TIME: + type: + - string + - 'null' + description: Time of the event associated with the activity + OWNER_USER_ID: + type: + - integer + - 'null' + description: ID of the user who owns the activity + OWNER_VISIBLE: + type: + - boolean + - 'null' + description: Boolean flag indicating if the activity is visible to the owner + PUBLICLY_VISIBLE: + type: + - boolean + - 'null' + description: Boolean flag indicating if the activity is publicly visible + REMINDER: + type: + - boolean + - 'null' + description: Details about the reminder set for the activity + REMINDER_DAYS_BEFORE_DUE: + type: + - integer + - 'null' + description: >- + Number of days before the due date when the reminder is + triggered + REMINDER_TIME: + type: + - string + - 'null' + description: Time of day when the reminder is triggered + RESPONSIBLE_USER_ID: + type: + - integer + - 'null' + description: ID of the user responsible for the activity + SKIP_FRI: + type: + - boolean + - 'null' + description: Boolean flag indicating if the activity is skipped on Fridays + SKIP_MON: + type: + - boolean + - 'null' + description: Boolean flag indicating if the activity is skipped on Mondays + SKIP_SAT: + type: + - boolean + - 'null' + description: Boolean flag indicating if the activity is skipped on Saturdays + SKIP_SUN: + type: + - boolean + - 'null' + description: Boolean flag indicating if the activity is skipped on Sundays + SKIP_THU: + type: + - boolean + - 'null' + description: Boolean flag indicating if the activity is skipped on Thursdays + SKIP_TUE: + type: + - boolean + - 'null' + description: Boolean flag indicating if the activity is skipped on Tuesdays + SKIP_WED: + type: + - boolean + - 'null' + description: Boolean flag indicating if the activity is skipped on Wednesdays + ACTIVITYSET_ID: + type: integer + description: ID of the activity set + FOR_CONTACTS: + type: + - boolean + - 'null' + description: Activity set associated with contacts + FOR_LEADS: + type: + - boolean + - 'null' + description: Activity set associated with leads + FOR_OPPORTUNITIES: + type: + - boolean + - 'null' + description: Activity set associated with opportunities + FOR_ORGANISATIONS: + type: + - boolean + - 'null' + description: Activity set associated with organizations + FOR_PROJECTS: + type: + - boolean + - 'null' + description: Activity set associated with projects + NAME: type: - string - - "null" - title: Start Date - description: - The date from which you'd like to replicate data for Insightly - in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will - be replicated. Note that it will be used only for incremental streams. - examples: - - "2021-03-01T00:00:00Z" - pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" + - 'null' + description: Name of the activity set + OWNER_USER_ID: + type: + - integer + - 'null' + description: ID of the user who owns the activity set + additionalProperties: true + contacts: + type: object + $schema: http://json-schema.org/draft-07/schema# + additionalProperties: true + properties: + ADDRESS_MAIL_CITY: + type: + - string + - 'null' + description: The city of the mailing address + ADDRESS_MAIL_COUNTRY: + type: + - string + - 'null' + description: The country of the mailing address + ADDRESS_MAIL_POSTCODE: + type: + - string + - 'null' + description: The postcode of the mailing address + ADDRESS_MAIL_STATE: + type: + - string + - 'null' + description: The state of the mailing address + ADDRESS_MAIL_STREET: + type: + - string + - 'null' + description: The street address of the mailing address + ADDRESS_OTHER_CITY: + type: + - string + - 'null' + description: The city of the other address + ADDRESS_OTHER_COUNTRY: + type: + - string + - 'null' + description: The country of the other address + ADDRESS_OTHER_POSTCODE: + type: + - string + - 'null' + description: The postcode of the other address + ADDRESS_OTHER_STATE: + type: + - string + - 'null' + description: The state of the other address + ADDRESS_OTHER_STREET: + type: + - string + - 'null' + description: The street address of the other address + ASSISTANT_NAME: + type: + - string + - 'null' + description: The name of the contact's assistant + BACKGROUND: + type: + - string + - 'null' + description: Background information about the contact + CONTACT_ID: + type: integer + description: The unique identifier for the contact + CREATED_USER_ID: + type: + - integer + - 'null' + description: The user ID of the user who created the contact + CUSTOMFIELDS: + type: array + description: Custom fields associated with the contact + items: + type: object + properties: + FIELD_NAME: + type: + - string + - 'null' + description: The name of the custom field + FIELD_VALUE: + type: object + description: The value of the custom field for this contact + DATES: + type: array + description: Important dates related to the contact + items: + type: object + properties: + CREATE_TASK_YEARLY: + type: + - boolean + - 'null' + description: Indicates whether a task should be created yearly + DATE_ID: + type: + - integer + - 'null' + description: The unique identifier for the date event + OCCASION_DATE: + type: + - string + - 'null' + description: The date of the occasion + OCCASION_NAME: + type: + - string + - 'null' + description: The name of the occasion + REPEAT_YEARLY: + type: + - boolean + - 'null' + description: Indicates if the occasion repeats yearly + DATE_CREATED_UTC: + type: + - string + - 'null' + description: The date and time the contact was created in UTC + format: date-time + DATE_OF_BIRTH: + type: + - string + - 'null' + description: The date of birth of the contact + DATE_UPDATED_UTC: + type: + - string + - 'null' + description: The date and time the contact was last updated in UTC + format: date-time + EMAIL_ADDRESS: + type: + - string + - 'null' + description: The email address of the contact + EMAIL_OPTED_OUT: + type: + - boolean + - 'null' + description: Whether the contact has opted out of email communication + FIRST_NAME: + type: + - string + - 'null' + description: The first name of the contact + IMAGE_URL: + type: + - string + - 'null' + description: URL of the contact's image + LAST_ACTIVITY_DATE_UTC: + type: + - string + - 'null' + description: The date and time of the last activity related to the contact in UTC + format: date-time + LAST_NAME: + type: + - string + - 'null' + description: The last name of the contact + LINKS: + type: array + description: Links or references related to the contact + items: + type: object + properties: + DETAILS: + type: + - string + - 'null' + description: Details about the link + IS_FORWARD: + type: + - boolean + - 'null' + description: Flag indicating if the link is forward + LINK_ID: + type: + - integer + - 'null' + description: Unique identifier for the link + LINK_OBJECT_ID: + type: + - integer + - 'null' + description: The ID of the linked object + LINK_OBJECT_NAME: + type: + - string + - 'null' + description: The name of the linked object + OBJECT_ID: + type: + - integer + - 'null' + description: The ID of the object + OBJECT_NAME: + type: + - string + - 'null' + description: The name of the object + RELATIONSHIP_ID: + type: + - integer + - 'null' + description: The ID of the relationship + ROLE: + type: + - string + - 'null' + description: The role of the contact in the relationship + NEXT_ACTIVITY_DATE_UTC: + type: + - string + - 'null' + description: The date and time of the next activity related to the contact in UTC + format: date-time + ORGANISATION_ID: + type: + - integer + - 'null' + description: The ID of the organization the contact is associated with + OWNER_USER_ID: + type: + - integer + - 'null' + description: The ID of the user who owns the contact + PHONE: + type: + - string + - 'null' + description: The primary phone number of the contact + PHONE_ASSISTANT: + type: + - string + - 'null' + description: The phone number of the contact's assistant + PHONE_FAX: + type: + - string + - 'null' + description: The fax number of the contact + PHONE_HOME: + type: + - string + - 'null' + description: The home phone number of the contact + PHONE_MOBILE: + type: + - string + - 'null' + description: The mobile phone number of the contact + PHONE_OTHER: + type: + - string + - 'null' + description: Another phone number of the contact + SALUTATION: + type: + - string + - 'null' + description: The salutation for the contact + SOCIAL_FACEBOOK: + type: + - string + - 'null' + description: The Facebook profile of the contact + SOCIAL_LINKEDIN: + type: + - string + - 'null' + description: The LinkedIn profile of the contact + SOCIAL_TWITTER: + type: + - string + - 'null' + description: The Twitter profile of the contact + TAGS: + type: array + description: Tags or categories associated with the contact + items: + type: object + properties: + TAG_NAME: + type: + - string + - 'null' + description: The name of the tag associated with the contact + TITLE: + type: + - string + - 'null' + description: The title of the contact + VISIBLE_TEAM_ID: + type: + - integer + - 'null' + description: The ID of the team the contact is visible to + VISIBLE_TO: + type: + - string + - 'null' + description: Indicates who the contact is visible to + countries: + type: object + $schema: http://json-schema.org/draft-07/schema# + properties: + COUNTRY_NAME: + type: string + description: The name of the country. + additionalProperties: true + currencies: + type: object + $schema: http://json-schema.org/draft-07/schema# + properties: + CURRENCY_CODE: + type: string + description: The unique code representing the currency. + CURRENCY_SYMBOL: + type: + - string + - 'null' + description: The symbol used to denote the currency. + additionalProperties: true + emails: + type: object + $schema: http://json-schema.org/draft-07/schema# + properties: + CREATED_USER_ID: + type: + - integer + - 'null' + description: The ID of the user who created the email + DATE_CREATED_UTC: + type: + - string + - 'null' + description: The date and time when the email record was created + format: date-time + EMAIL_DATE_UTC: + type: + - string + - 'null' + description: The date and time when the email was sent/received + format: date-time + EMAIL_FROM: + type: + - string + - 'null' + description: The sender of the email + EMAIL_ID: + type: integer + description: The unique identifier of the email + FORMAT: + type: + - string + - 'null' + description: The format of the email content + LINKS: + type: array + description: Related links associated with the email + items: + type: object + properties: + DETAILS: + type: + - string + - 'null' + description: Details about the link + IS_FORWARD: + type: + - boolean + - 'null' + description: Indicates if the link is a forward link + LINK_ID: + type: + - integer + - 'null' + description: The ID of the link + LINK_OBJECT_ID: + type: + - integer + - 'null' + description: The ID of the linked object + LINK_OBJECT_NAME: + type: + - string + - 'null' + description: The name of the linked object + OBJECT_ID: + type: + - integer + - 'null' + description: The ID of the object associated with the email + OBJECT_NAME: + type: + - string + - 'null' + description: The name of the object associated with the email + RELATIONSHIP_ID: + type: + - integer + - 'null' + description: The ID representing the relationship with the link + ROLE: + type: + - string + - 'null' + description: The role of the linked object + OWNER_USER_ID: + type: + - integer + - 'null' + description: The ID of the user who owns the email + QUEUED_SEND_DATE_UTC: + type: + - string + - 'null' + description: The date and time when the email was queued for sending + format: date-time + SIZE: + type: + - integer + - 'null' + description: The size of the email content + SUBJECT: + type: + - string + - 'null' + description: The subject of the email + TAGS: + type: array + description: Tags associated with the email + items: + type: object + properties: + TAG_NAME: + type: + - string + - 'null' + description: The name of the tag + additionalProperties: true + events: + type: object + $schema: http://json-schema.org/draft-04/schema# + properties: + ALL_DAY: + type: + - boolean + - 'null' + description: Indicates if the event is an all-day event + CUSTOMFIELDS: + type: array + description: Custom fields associated with the event + items: + type: object + properties: + FIELD_NAME: + type: + - string + - 'null' + description: Name of the custom field + FIELD_VALUE: + type: object + description: Value of the custom field + DATE_CREATED_UTC: + type: + - string + - 'null' + description: DateTime when the event was created (UTC) + format: date-time + DATE_UPDATED_UTC: + type: + - string + - 'null' + description: DateTime when the event was last updated (UTC) + format: date-time + DETAILS: + type: + - string + - 'null' + description: Additional details of the event + END_DATE_UTC: + type: + - string + - 'null' + description: End date and time of the event (UTC) + format: date-time + EVENT_ID: + type: integer + description: Unique identifier for the event + LINKS: + type: array + description: Links associated with the event + items: + type: object + properties: + DETAILS: + type: + - string + - 'null' + description: Details of the link + IS_FORWARD: + type: + - boolean + - 'null' + description: Indicates if the link is forward + LINK_ID: + type: + - integer + - 'null' + description: Unique identifier for the link + LINK_OBJECT_ID: + type: + - integer + - 'null' + description: ID of the linked object + LINK_OBJECT_NAME: + type: + - string + - 'null' + description: Name of the linked object + OBJECT_ID: + type: + - integer + - 'null' + description: ID of the object + OBJECT_NAME: + type: + - string + - 'null' + description: Name of the object + RELATIONSHIP_ID: + type: + - integer + - 'null' + description: ID of the relationship + ROLE: + type: + - string + - 'null' + description: Role of the link in the relationship + LOCATION: + type: + - string + - 'null' + description: Location of the event + OWNER_USER_ID: + type: + - integer + - 'null' + description: User ID of the event owner + REMINDER_DATE_UTC: + type: + - string + - 'null' + description: DateTime when the reminder for the event is set to trigger (UTC) + format: date-time + REMINDER_SENT: + type: + - boolean + - 'null' + description: Indicates if the reminder for the event has been sent + START_DATE_UTC: + type: + - string + - 'null' + description: Start date and time of the event (UTC) + format: date-time + TITLE: + type: + - string + - 'null' + description: Title of the event + additionalProperties: true + knowledge_article_categories: + type: object + $schema: http://json-schema.org/draft-04/schema# + properties: + CATEGORY_ID: + type: integer + description: Unique identifier for the knowledge article category. + CATEGORY_NAME: + type: + - string + - 'null' + description: Name of the knowledge article category. + CREATED_USER_ID: + type: + - integer + - 'null' + description: Identifier of the user who created the knowledge article category. + DATE_CREATED_UTC: + type: + - string + - 'null' + description: Date and time when the knowledge article category was created. + format: date-time + DATE_UPDATED_UTC: + type: + - string + - 'null' + description: Date and time when the knowledge article category was last updated. + format: date-time + DESCRIPTION: + type: + - string + - 'null' + description: Detailed description of the knowledge article category. + additionalProperties: true + knowledge_article_folders: + type: object + $schema: http://json-schema.org/draft-04/schema# + properties: + CATEGORY_ID: + type: + - string + - 'null' + description: >- + Unique identifier for the knowledge article category to which the + folder belongs. + CREATED_USER_ID: + type: + - integer + - 'null' + description: >- + Unique identifier of the user who created the knowledge article + folder. + DATE_CREATED_UTC: + type: + - string + - 'null' + description: The date and time when the knowledge article folder was created. + format: date-time + DATE_UPDATED_UTC: + type: + - string + - 'null' + description: The date and time when the knowledge article folder was last updated. + format: date-time + FOLDER_ID: + type: integer + description: Unique identifier for the knowledge article folder. + FOLDER_NAME: + type: + - string + - 'null' + description: The name of the knowledge article folder. + ORDER_ARTICLES: + type: + - string + - 'null' + description: Defines the order in which articles appear within the folder. + VISIBILITY: + type: + - string + - 'null' + description: >- + Indicates the visibility of the knowledge article folder (e.g., + public, private, restricted). + additionalProperties: true + knowledge_articles: + type: object + $schema: http://json-schema.org/draft-04/schema# + properties: + ARCHIVED_DATE_UTC: + type: + - string + - 'null' + description: The date and time when the article was archived in UTC timezone + format: date-time + ARTICLE_ID: + type: integer + description: The unique identifier for the knowledge article + ARTICLE_NO: + type: + - integer + - 'null' + description: The article number for reference + ArticleVersion: + type: + - string + - 'null' + description: The version of the article + Body: + type: + - string + - 'null' + description: The main content of the knowledge article + CATEGORY_ID: + type: + - integer + - 'null' + description: The category ID to which the article belongs + CREATED_USER_ID: + type: + - integer + - 'null' + description: The user ID of the creator of the knowledge article + CUSTOMFIELDS: + type: array + description: Custom fields associated with the article + items: + type: object + properties: + FIELD_NAME: + type: + - string + - 'null' + description: Name of the custom field + FIELD_VALUE: + type: object + description: Value of the custom field + DATE_CREATED_UTC: + type: + - string + - 'null' + description: The date and time when the article was created in UTC timezone + format: date-time + DATE_UPDATED_UTC: + type: + - string + - 'null' + description: The date and time when the article was last updated in UTC timezone + format: date-time + DOWNVOTE_COUNT: + type: + - integer + - 'null' + description: Number of downvotes received for the article + ExternalLinkCount: + type: + - string + - 'null' + description: Number of external links referenced in the article + FIRST_PUBLISHED_DATE_UTC: + type: + - string + - 'null' + description: The date and time when the article was first published in UTC timezone + format: date-time + FOLDER_ID: + type: + - integer + - 'null' + description: The ID of the folder where the article is stored + LAST_PUBLISHED_DATE_UTC: + type: + - string + - 'null' + description: The date and time when the article was last published in UTC timezone + format: date-time + Language: + type: + - string + - 'null' + description: The language in which the article is written + OWNER_USER_ID: + type: + - integer + - 'null' + description: The user ID of the owner of the article + PROMOTED: + type: + - boolean + - 'null' + description: Indicates if the article is promoted or not + Status: + type: + - string + - 'null' + description: The status of the article (e.g., draft, published) + TAGS: + type: array + description: Tags associated with the article + items: + type: object + properties: + TAG_NAME: + type: + - string + - 'null' + description: The name of the tag + Title: + type: + - string + - 'null' + description: The title of the knowledge article + UPVOTE_COUNT: + type: + - integer + - 'null' + description: Number of upvotes received for the article + URL_SLUG: + type: + - string + - 'null' + description: The URL-friendly slug for the article + additionalProperties: true + lead_sources: + type: object + $schema: http://json-schema.org/draft-04/schema# + properties: + DEFAULT_VALUE: + type: + - boolean + - 'null' + description: >- + The default value for the lead source, used when no specific lead + source is assigned. + FIELD_ORDER: + type: + - integer + - 'null' + description: The order in which the lead sources are displayed or prioritized. + LEAD_SOURCE: + type: + - string + - 'null' + description: The name or label of the lead source. + LEAD_SOURCE_ID: + type: integer + description: The unique identifier for the lead source. + additionalProperties: true + lead_statuses: + type: object + $schema: http://json-schema.org/draft-04/schema# + properties: + DEFAULT_STATUS: + type: + - boolean + - 'null' + description: Specifies the default status for leads. + FIELD_ORDER: + type: + - integer + - 'null' + description: Designates the order of fields for lead status. + LEAD_STATUS: + type: + - string + - 'null' + description: Represents the name or label of the lead status. + LEAD_STATUS_ID: + type: integer + description: Unique identifier for each lead status. + STATUS_TYPE: + type: + - integer + - 'null' + description: Indicates the type or category of the lead status. + additionalProperties: true + milestones: + type: object + $schema: http://json-schema.org/draft-04/schema# + properties: + COMPLETED: + type: + - boolean + - 'null' + description: Flag indicating if the milestone has been completed or not + COMPLETED_DATE_UTC: + type: + - string + - 'null' + description: Date and time when the milestone was completed in UTC + format: date-time + DATE_CREATED_UTC: + type: + - string + - 'null' + description: Date and time when the milestone was created in UTC + format: date-time + DATE_UPDATED_UTC: + type: + - string + - 'null' + description: Date and time when the milestone was last updated in UTC + format: date-time + DUE_DATE: + type: + - string + - 'null' + description: Due date for completion of the milestone + MILESTONE_ID: + type: integer + description: Unique identifier for the milestone + OWNER_USER_ID: + type: + - integer + - 'null' + description: User ID of the owner of the milestone + PROJECT_ID: + type: + - integer + - 'null' + description: Identifier of the project to which the milestone belongs + RESPONSIBLE_USER: + type: + - integer + - 'null' + description: User responsible for completing the milestone + TITLE: + type: + - string + - 'null' + description: Title or name of the milestone + additionalProperties: true + notes: + type: object + $schema: http://json-schema.org/draft-04/schema# + properties: + BODY: + type: + - string + - 'null' + description: The content or text of the note. + DATE_CREATED_UTC: + type: + - string + - 'null' + description: The date and time the note was created in UTC timezone. + format: date-time + DATE_UPDATED_UTC: + type: + - string + - 'null' + description: The date and time the note was last updated in UTC timezone. + format: date-time + LINKS: + type: array + description: Array of links associated with the note. + items: + type: object + properties: + DETAILS: + type: + - string + - 'null' + description: Additional details or description for the link. + IS_FORWARD: + type: + - boolean + - 'null' + description: Indicates if the link is forward or backward. + LINK_ID: + type: + - integer + - 'null' + description: The ID of the link. + LINK_OBJECT_ID: + type: + - integer + - 'null' + description: The ID of the object the link is associated with. + LINK_OBJECT_NAME: + type: + - string + - 'null' + description: The name of the object the link is associated with. + OBJECT_ID: + type: + - integer + - 'null' + description: The ID of the linked object. + OBJECT_NAME: + type: + - string + - 'null' + description: The name of the linked object. + RELATIONSHIP_ID: + type: + - integer + - 'null' + description: The ID of the relationship between the objects. + ROLE: + type: + - string + - 'null' + description: The role or type of relationship between the objects. + NOTE_ID: + type: integer + description: The unique identifier of the note. + OWNER_USER_ID: + type: + - integer + - 'null' + description: The ID of the user who owns the note. + TITLE: + type: + - string + - 'null' + description: The title or subject of the note. + additionalProperties: true + opportunities: + type: object + $schema: http://json-schema.org/draft-04/schema# + additionalProperties: true + properties: + ACTUAL_CLOSE_DATE: + type: + - string + - 'null' + description: The actual date when the opportunity was closed + format: date-time + BID_AMOUNT: + type: + - number + - 'null' + description: The amount bid for the opportunity + BID_CURRENCY: + type: + - string + - 'null' + description: The currency used for the bid amount + BID_DURATION: + type: + - integer + - 'null' + description: The duration for which the bid is valid + BID_TYPE: + type: + - string + - 'null' + description: The type of bid placed + CATEGORY_ID: + type: + - integer + - 'null' + description: The category ID associated with the opportunity + CREATED_USER_ID: + type: + - integer + - 'null' + description: The ID of the user who created the opportunity + CUSTOMFIELDS: + type: array + description: Custom fields associated with the opportunity + items: + type: object + properties: + FIELD_NAME: + type: + - string + - 'null' + description: Name of the custom field + FIELD_VALUE: + type: object + description: Value of the custom field + DATE_CREATED_UTC: + type: + - string + - 'null' + description: The date and time when the opportunity was created (in UTC) + format: date-time + DATE_UPDATED_UTC: + type: + - string + - 'null' + description: The date and time when the opportunity was last updated (in UTC) + format: date-time + FORECAST_CLOSE_DATE: + type: + - string + - 'null' + description: The forecasted date for closing the opportunity + format: date-time + IMAGE_URL: + type: + - string + - 'null' + description: URL of any image associated with the opportunity + LAST_ACTIVITY_DATE_UTC: + type: + - string + - 'null' + description: >- + The date and time of the last activity related to the opportunity (in + UTC) + format: date-time + LINKS: + type: array + description: Links associated with the opportunity + items: + type: object + properties: + DETAILS: + type: + - string + - 'null' + description: Details of the link + IS_FORWARD: + type: + - boolean + - 'null' + description: Indicates if the link is being forwarded + LINK_ID: + type: + - integer + - 'null' + description: ID of the linked object + LINK_OBJECT_ID: + type: + - integer + - 'null' + description: ID of the linked object + LINK_OBJECT_NAME: + type: + - string + - 'null' + description: Name of the linked object + OBJECT_ID: + type: + - integer + - 'null' + description: ID of the linked object + OBJECT_NAME: + type: + - string + - 'null' + description: Name of the linked object + RELATIONSHIP_ID: + type: + - integer + - 'null' + description: ID of the relationship + ROLE: + type: + - string + - 'null' + description: Role of the link + NEXT_ACTIVITY_DATE_UTC: + type: + - string + - 'null' + description: The date and time of the next planned activity (in UTC) + format: date-time + OPPORTUNITY_DETAILS: + type: + - string + - 'null' + description: Detailed information about the opportunity + OPPORTUNITY_ID: + type: integer + description: The unique identifier of the opportunity + OPPORTUNITY_NAME: + type: + - string + - 'null' + description: The name of the opportunity + OPPORTUNITY_STATE: + type: + - string + - 'null' + description: The state of the opportunity + OPPORTUNITY_VALUE: + type: + - number + - 'null' + description: The value associated with the opportunity + ORGANISATION_ID: + type: + - integer + - 'null' + description: The ID of the organization associated with the opportunity + OWNER_USER_ID: + type: + - integer + - 'null' + description: The ID of the user who owns the opportunity + PIPELINE_ID: + type: + - integer + - 'null' + description: The ID of the pipeline the opportunity belongs to + PRICEBOOK_ID: + type: + - integer + - 'null' + description: The ID of the price book associated with the opportunity + PROBABILITY: + type: + - integer + - 'null' + description: The probability of the opportunity being successful + RESPONSIBLE_USER_ID: + type: + - integer + - 'null' + description: The ID of the user responsible for the opportunity + STAGE_ID: + type: + - integer + - 'null' + description: The ID of the stage the opportunity is in + TAGS: + type: array + description: Tags associated with the opportunity + items: + type: object + properties: + TAG_NAME: + type: + - string + - 'null' + description: Name of the tag associated with the opportunity + required: + - TAG_NAME + VISIBLE_TEAM_ID: + type: + - integer + - 'null' + description: The ID of the team with visibility rights to the opportunity + VISIBLE_TO: + type: + - string + - 'null' + description: The visibility settings for the opportunity + opportunity_categories: + type: object + $schema: http://json-schema.org/draft-04/schema# + properties: + ACTIVE: + type: + - boolean + - 'null' + description: Indicates whether the opportunity category is active or inactive + BACKGROUND_COLOR: + type: + - string + - 'null' + description: The background color associated with the opportunity category + CATEGORY_ID: + type: integer + description: The unique identifier for the opportunity category + CATEGORY_NAME: + type: + - string + - 'null' + description: The name or label of the opportunity category + additionalProperties: true + opportunity_state_reasons: + type: object + $schema: http://json-schema.org/draft-04/schema# + properties: + FOR_OPPORTUNITY_STATE: + type: + - string + - 'null' + description: The particular opportunity state that the reason applies to. + STATE_REASON: + type: + - string + - 'null' + description: The reason associated with the opportunity state. + STATE_REASON_ID: + type: integer + description: Unique identifier for the state reason. + additionalProperties: true + organisations: + type: object + $schema: http://json-schema.org/draft-04/schema# + additionalProperties: true + properties: + ADDRESS_BILLING_CITY: + type: + - string + - 'null' + description: The city of the billing address of the organisation. + ADDRESS_BILLING_COUNTRY: + type: + - string + - 'null' + description: The country of the billing address of the organisation. + ADDRESS_BILLING_POSTCODE: + type: + - string + - 'null' + description: The postal code of the billing address of the organisation. + ADDRESS_BILLING_STATE: + type: + - string + - 'null' + description: The state of the billing address of the organisation. + ADDRESS_BILLING_STREET: + type: + - string + - 'null' + description: The street address of the billing address of the organisation. + ADDRESS_SHIP_CITY: + type: + - string + - 'null' + description: The city of the shipping address of the organisation. + ADDRESS_SHIP_COUNTRY: + type: + - string + - 'null' + description: The country of the shipping address of the organisation. + ADDRESS_SHIP_POSTCODE: + type: + - string + - 'null' + description: The postal code of the shipping address of the organisation. + ADDRESS_SHIP_STATE: + type: + - string + - 'null' + description: The state of the shipping address of the organisation. + ADDRESS_SHIP_STREET: + type: + - string + - 'null' + description: The street address of the shipping address of the organisation. + BACKGROUND: + type: + - string + - 'null' + description: Background information or description about the organisation. + CREATED_USER_ID: + type: + - integer + - 'null' + description: The user ID of the user who created the organisation record. + CUSTOMFIELDS: + type: array + description: Custom fields associated with the organisation. + items: + type: object + properties: + FIELD_NAME: + type: + - string + - 'null' + description: The name of the custom field. + FIELD_VALUE: + type: object + description: The value of the custom field. + DATES: + type: array + description: Important dates associated with the organisation. + items: + type: object + properties: + CREATE_TASK_YEARLY: + type: + - boolean + - 'null' + description: Flag indicating if a task is created yearly. + DATE_ID: + type: + - integer + - 'null' + description: The ID of the date record. + OCCASION_DATE: + type: + - string + - 'null' + description: The date of a particular occasion. + OCCASION_NAME: + type: + - string + - 'null' + description: Name of the occasion associated with the date. + REPEAT_YEARLY: + type: + - boolean + - 'null' + description: Flag indicating if the occasion repeats yearly. + DATE_CREATED_UTC: + type: + - string + - 'null' + description: >- + The date and time when the organisation record was created in + Coordinated Universal Time (UTC). + format: date-time + DATE_UPDATED_UTC: + type: + - string + - 'null' + description: >- + The date and time when the organisation record was last updated in + Coordinated Universal Time (UTC). + format: date-time + EMAILDOMAINS: + type: array + description: Email domains associated with the organisation. + items: + type: object + properties: + EMAIL_DOMAIN: + type: + - string + - 'null' + description: The domain of an email address associated with the organisation. + EMAIL_DOMAIN_ID: + type: + - integer + - 'null' + description: The ID of the email domain. + IMAGE_URL: + type: + - string + - 'null' + description: URL of the image associated with the organisation. + LAST_ACTIVITY_DATE_UTC: + type: + - string + - 'null' + description: >- + The date and time of the last activity related to the organisation in + Coordinated Universal Time (UTC). + format: date-time + LINKS: + type: array + description: Links related to the organisation. + items: + type: object + properties: + DETAILS: + type: + - string + - 'null' + description: Details of the link. + IS_FORWARD: + type: + - boolean + - 'null' + description: Flag indicating if the link is in a forward direction. + LINK_ID: + type: + - integer + - 'null' + description: The ID of the link. + LINK_OBJECT_ID: + type: + - integer + - 'null' + description: The ID of the object linked to. + LINK_OBJECT_NAME: + type: + - string + - 'null' + description: Name of the object linked to. + OBJECT_ID: + type: + - integer + - 'null' + description: >- + The ID of the organisation or entity the link is associated + with. + OBJECT_NAME: + type: + - string + - 'null' + description: Name of the organisation or entity the link is associated with. + RELATIONSHIP_ID: + type: + - integer + - 'null' + description: The ID of the relationship between the linked objects. + ROLE: + type: + - string + - 'null' + description: Role of the organisation in the linked relationship. + NEXT_ACTIVITY_DATE_UTC: + type: + - string + - 'null' + description: >- + The date and time of the next planned activity related to the + organisation in Coordinated Universal Time (UTC). + format: date-time + ORGANISATION_ID: + type: integer + description: The unique ID of the organisation. + ORGANISATION_NAME: + type: + - string + - 'null' + description: The name of the organisation. + OWNER_USER_ID: + type: + - integer + - 'null' + description: The user ID of the owner of the organisation. + PHONE: + type: + - string + - 'null' + description: The phone number associated with the organisation. + PHONE_FAX: + type: + - string + - 'null' + description: The fax number associated with the organisation. + SOCIAL_FACEBOOK: + type: + - string + - 'null' + description: Facebook page URL associated with the organisation. + SOCIAL_LINKEDIN: + type: + - string + - 'null' + description: LinkedIn profile URL associated with the organisation. + SOCIAL_TWITTER: + type: + - string + - 'null' + description: Twitter handle associated with the organisation. + TAGS: + type: array + description: Tags associated with the organisation. + items: + type: object + properties: + TAG_NAME: + type: + - string + - 'null' + description: The name of the tag. + VISIBLE_TEAM_ID: + type: + - integer + - 'null' + description: The team ID that has visibility permission for the organisation. + VISIBLE_TO: + type: + - string + - 'null' + description: Visibility level of the organisation. + WEBSITE: + type: + - string + - 'null' + description: Website URL of the organisation. + pipelines: + type: object + $schema: http://json-schema.org/draft-04/schema# + properties: + FOR_OPPORTUNITIES: + type: + - boolean + - 'null' + description: Flag indicating if the pipeline is for opportunities + FOR_PROJECTS: + type: + - boolean + - 'null' + description: Flag indicating if the pipeline is for projects + OWNER_USER_ID: + type: + - integer + - 'null' + description: Unique identifier of the user who owns the pipeline + PIPELINE_ID: + type: integer + description: Unique identifier of the pipeline + PIPELINE_NAME: + type: + - string + - 'null' + description: Name of the pipeline + additionalProperties: true + pipeline_stages: + type: object + $schema: http://json-schema.org/draft-04/schema# + properties: + ACTIVITYSET_ID: + type: + - integer + - 'null' + description: >- + Unique identifier for the activity set associated with the pipeline + stage + OWNER_USER_ID: + type: + - integer + - 'null' + description: >- + Unique identifier for the user who owns or is responsible for the + pipeline stage + PIPELINE_ID: + type: + - integer + - 'null' + description: Unique identifier for the pipeline to which the stage belongs + STAGE_ID: + type: integer + description: Unique identifier for the pipeline stage + STAGE_NAME: + type: + - string + - 'null' + description: Name or label for the pipeline stage + STAGE_ORDER: + type: + - integer + - 'null' + description: >- + Numerical order value indicating the position of the pipeline stage in + the pipeline flow + additionalProperties: true + project_categories: + type: object + $schema: http://json-schema.org/draft-04/schema# + properties: + ACTIVE: + type: + - boolean + - 'null' + description: Indicates if the project category is currently active or not + BACKGROUND_COLOR: + type: + - string + - 'null' + description: The background color associated with the project category + CATEGORY_ID: + type: integer + description: Unique identifier for the project category + CATEGORY_NAME: + type: + - string + - 'null' + description: The name or title of the project category + additionalProperties: true + projects: + type: object + $schema: http://json-schema.org/draft-04/schema# + additionalProperties: true + properties: + CATEGORY_ID: + type: + - integer + - 'null' + description: Unique identifier for the project category. + COMPLETED_DATE: + type: + - string + - 'null' + description: Date and time when the project was completed. + format: date-time + CREATED_USER_ID: + type: + - integer + - 'null' + description: Unique identifier of the user who created the project. + CUSTOMFIELDS: + type: array + description: Custom fields associated with the project. + items: + type: object + properties: + FIELD_NAME: + type: + - string + - 'null' + description: Name of the custom field. + FIELD_VALUE: + type: object + description: Value of the custom field. + DATE_CREATED_UTC: + type: + - string + - 'null' + description: Date and time when the project was created (in UTC). + format: date-time + DATE_UPDATED_UTC: + type: + - string + - 'null' + description: Date and time when the project was last updated (in UTC). + format: date-time + IMAGE_URL: + type: + - string + - 'null' + description: URL of the image associated with the project. + LAST_ACTIVITY_DATE_UTC: + type: + - string + - 'null' + description: Date and time of the last activity related to the project (in UTC). + LINKS: + type: array + description: Links associated with the project. + items: + type: object + properties: + DETAILS: + type: + - string + - 'null' + description: Details of the link. + IS_FORWARD: + type: + - boolean + - 'null' + description: Flag indicating if the link is forward. + LINK_ID: + type: + - integer + - 'null' + description: Unique identifier for the link. + LINK_OBJECT_ID: + type: + - integer + - 'null' + description: Unique identifier of the linked object. + LINK_OBJECT_NAME: + type: + - string + - 'null' + description: Name of the linked object. + OBJECT_ID: + type: + - integer + - 'null' + description: Unique identifier of the object. + OBJECT_NAME: + type: + - string + - 'null' + description: Name of the object. + RELATIONSHIP_ID: + type: + - integer + - 'null' + description: Unique identifier for the relationship. + ROLE: + type: + - string + - 'null' + description: Role associated with the link. + NEXT_ACTIVITY_DATE_UTC: + type: + - string + - 'null' + description: Date and time of the next activity related to the project (in UTC). + OPPORTUNITY_ID: + type: + - integer + - 'null' + description: Unique identifier of the opportunity associated with the project. + OWNER_USER_ID: + type: + - integer + - 'null' + description: Unique identifier of the user who owns the project. + PIPELINE_ID: + type: + - integer + - 'null' + description: Unique identifier of the pipeline to which the project belongs. + PROJECT_DETAILS: + type: + - string + - 'null' + description: Details or description of the project. + PROJECT_ID: + type: integer + description: Unique identifier for the project. + PROJECT_NAME: + type: + - string + - 'null' + description: Name of the project. + RESPONSIBLE_USER_ID: + type: + - integer + - 'null' + description: Unique identifier of the user responsible for the project. + STAGE_ID: + type: + - integer + - 'null' + description: Unique identifier of the stage to which the project belongs. + STARTED_DATE: + type: + - string + - 'null' + description: Date and time when the project was started. + format: date-time + STATUS: + type: + - string + - 'null' + description: Status of the project. + TAGS: + type: array + description: Tags associated with the project. + items: + type: object + properties: + TAG_NAME: + type: + - string + - 'null' + description: Name of the tag. + VISIBLE_TEAM_ID: + type: + - integer + - 'null' + description: Unique identifier of the team that can view the project. + VISIBLE_TO: + type: + - string + - 'null' + description: Visibility setting for the project. + prospects: + type: object + $schema: http://json-schema.org/draft-04/schema# + properties: + ADDRESS_CITY: + type: + - string + - 'null' + description: The city where the prospect is located. + ADDRESS_COUNTRY: + type: + - string + - 'null' + description: The country where the prospect is located. + ADDRESS_POSTCODE: + type: + - string + - 'null' + description: The postcode of the prospect's address. + ADDRESS_STATE: + type: + - string + - 'null' + description: The state or region where the prospect is located. + ADDRESS_STREET: + type: + - string + - 'null' + description: The street address of the prospect. + CONTACT_ID: + type: + - integer + - 'null' + description: The ID of the contact associated with the prospect. + CREATED_USER_ID: + type: + - integer + - 'null' + description: The ID of the user who created the prospect. + CUSTOMFIELDS: + type: array + description: Custom fields associated with the prospect + items: + type: object + properties: + FIELD_NAME: + type: + - string + - 'null' + description: The name of a custom field. + FIELD_VALUE: + type: object + description: The value of the custom field. + DATE_CREATED_UTC: + type: + - string + - 'null' + description: The date and time when the prospect was created in UTC. + format: date-time + DATE_UPDATED_UTC: + type: + - string + - 'null' + description: The date and time when the prospect was last updated in UTC. + format: date-time + DESCRIPTION: + type: + - string + - 'null' + description: A description or notes related to the prospect. + DO_NOT_CALL: + type: + - boolean + - 'null' + description: Indicates if the prospect should not be contacted via phone. + DO_NOT_EMAIL: + type: + - boolean + - 'null' + description: Indicates if the prospect should not be contacted via email. + DO_NOT_SYNC: + type: + - boolean + - 'null' + description: Indicates if the prospect should not be synchronized. + EMAIL_ADDRESS: + type: + - string + - 'null' + description: The email address of the prospect. + EMPLOYEE_COUNT: + type: + - integer + - 'null' + description: The number of employees in the prospect's organization. + FAX: + type: + - string + - 'null' + description: The fax number of the prospect. + FIRST_NAME: + type: + - string + - 'null' + description: The first name of the prospect. + GRADE: + type: + - string + - 'null' + description: The grade of the prospect. + GRADE_PROFILE_ID: + type: + - integer + - 'null' + description: The ID of the grade profile associated with the prospect. + INDUSTRY: + type: + - string + - 'null' + description: The industry of the prospect. + LAST_ACTIVITY_DATE_UTC: + type: + - string + - 'null' + description: The date and time of the prospect's last activity in UTC. + format: date-time + LAST_NAME: + type: + - string + - 'null' + description: The last name of the prospect. + LEAD_CONVERSION_DATE_UTC: + type: + - string + - 'null' + description: The date and time when the prospect was converted to a lead in UTC. + format: date-time + LEAD_ID: + type: + - integer + - 'null' + description: The ID of the lead associated with the prospect. + MOBILE: + type: + - string + - 'null' + description: The mobile number of the prospect. + OPTED_OUT: + type: + - boolean + - 'null' + description: Indicates if the prospect has opted out of communications. + ORGANISATION_ID: + type: + - integer + - 'null' + description: The ID of the organization associated with the prospect. + ORGANISATION_NAME: + type: + - string + - 'null' + description: The name of the organization associated with the prospect. + OWNER_USER_ID: + type: + - integer + - 'null' + description: The ID of the user who owns or is responsible for the prospect. + PHONE: + type: + - string + - 'null' + description: The phone number of the prospect. + PROSPECT_ID: + type: integer + description: The ID of the prospect. + SALUTATION: + type: + - string + - 'null' + description: The salutation or title used when addressing the prospect. + SCORE: + type: + - integer + - 'null' + description: The score assigned to the prospect. + TAGS: + type: array + description: Tags associated with the prospect + items: + type: object + properties: + TAG_NAME: + type: + - string + - 'null' + description: The name of a tag associated with the prospect. + TITLE: + type: + - string + - 'null' + description: The job title of the prospect. + WEBSITE: + type: + - string + - 'null' + description: The website URL of the prospect's organization. + additionalProperties: true + relationships: + type: object + $schema: http://json-schema.org/draft-04/schema# + properties: + FORWARD: + type: + - string + - 'null' + description: The ID of the object on one side of the relationship. + FORWARD_TITLE: + type: + - string + - 'null' + description: The name or title of the object on one side of the relationship. + FOR_CONTACTS: + type: + - boolean + - 'null' + description: List of contacts associated with this relationship. + FOR_ORGANISATIONS: + type: + - boolean + - 'null' + description: List of organizations associated with this relationship. + RELATIONSHIP_ID: + type: integer + description: The unique identifier for this relationship. + REVERSE: + type: + - string + - 'null' + description: The ID of the object on the other side of the relationship. + REVERSE_TITLE: + type: + - string + - 'null' + description: The name or title of the object on the other side of the relationship. + additionalProperties: true + task_categories: + type: object + $schema: http://json-schema.org/draft-04/schema# + properties: + ACTIVE: + type: + - boolean + - 'null' + description: Flag indicating if the task category is currently active or not. + BACKGROUND_COLOR: + type: + - string + - 'null' + description: >- + The background color associated with the task category for visual + representation. + CATEGORY_ID: + type: integer + description: Unique identifier for the task category. + CATEGORY_NAME: + type: + - string + - 'null' + description: The name or label assigned to the task category. + additionalProperties: true + tasks: + type: object + $schema: http://json-schema.org/draft-04/schema# + additionalProperties: true + properties: + ASSIGNED_BY_USER_ID: + type: + - integer + - 'null' + description: The user ID of the individual who assigned the task. + ASSIGNED_DATE_UTC: + type: + - string + - 'null' + description: The date and time when the task was assigned. + format: date-time + ASSIGNED_TEAM_ID: + type: + - integer + - 'null' + description: The team ID to which the task is assigned. + CATEGORY_ID: + type: + - integer + - 'null' + description: The category ID associated with the task. + COMPLETED: + type: + - boolean + - 'null' + description: Indicates if the task has been completed or not. + COMPLETED_DATE_UTC: + type: + - string + - 'null' + description: The date and time when the task was completed. + format: date-time + CREATED_USER_ID: + type: + - integer + - 'null' + description: The user ID of the user who created the task. + CUSTOMFIELDS: + type: array + description: Custom fields associated with the task. + items: + type: object + properties: + FIELD_NAME: + type: + - string + - 'null' + description: The name of the custom field. + FIELD_VALUE: + type: object + description: The value of the custom field. + DATE_CREATED_UTC: + type: + - string + - 'null' + description: The date and time when the task was created. + format: date-time + DATE_UPDATED_UTC: + type: + - string + - 'null' + description: The date and time when the task was last updated. + format: date-time + DETAILS: + type: + - string + - 'null' + description: Additional details or description of the task. + DUE_DATE: + type: + - string + - 'null' + description: The deadline or due date for the task. + format: date-time + EMAIL_ID: + type: + - integer + - 'null' + description: The email ID associated with the task. + LINKS: + type: array + description: Links related to the task. + items: + type: object + properties: + DETAILS: + type: + - string + - 'null' + description: Details or description of the link. + IS_FORWARD: + type: + - boolean + - 'null' + description: Indicates if the link is forward or not. + LINK_ID: + type: + - integer + - 'null' + description: The ID of the link. + LINK_OBJECT_ID: + type: + - integer + - 'null' + description: The object ID associated with the link. + LINK_OBJECT_NAME: + type: + - string + - 'null' + description: The name of the object associated with the link. + OBJECT_ID: + type: + - integer + - 'null' + description: The ID of the object linked to the task. + OBJECT_NAME: + type: + - string + - 'null' + description: The name of the object linked to the task. + RELATIONSHIP_ID: + type: + - integer + - 'null' + description: The relationship ID associated with the link. + ROLE: + type: + - string + - 'null' + description: The role associated with the link. + MILESTONE_ID: + type: + - integer + - 'null' + description: The milestone ID associated with the task. + OPPORTUNITY_ID: + type: + - integer + - 'null' + description: The opportunity ID associated with the task. + OWNER_USER_ID: + type: + - integer + - 'null' + description: The user ID of the owner of the task. + OWNER_VISIBLE: + type: + - boolean + - 'null' + description: Indicates if the owner is visible or not. + PARENT_TASK_ID: + type: + - integer + - 'null' + description: The ID of the parent task if this task is a subtask. + PERCENT_COMPLETE: + type: + - integer + - 'null' + description: The completion percentage of the task. + PRIORITY: + type: + - integer + - 'null' + description: The priority level of the task. + PROJECT_ID: + type: + - integer + - 'null' + description: The project ID associated with the task. + PUBLICLY_VISIBLE: + type: + - 'null' + - boolean + description: Indicates if the task is publicly visible. + RECURRENCE: + type: + - string + - 'null' + description: Details of any recurring pattern for the task. + REMINDER_DATE_UTC: + type: + - string + - 'null' + description: The date and time for the reminder of the task. + format: date-time + REMINDER_SENT: + type: + - boolean + - 'null' + description: Indicates if a reminder has been sent for the task. + RESPONSIBLE_USER_ID: + type: + - integer + - 'null' + description: The user ID of the individual responsible for the task. + STAGE_ID: + type: + - integer + - 'null' + description: The stage ID of the task. + START_DATE: + type: + - string + - 'null' + description: The start date of the task. + format: date-time + STATUS: + type: + - string + - 'null' + description: The current status of the task. + TASK_ID: + type: integer + description: The unique ID of the task. + TITLE: + type: + - string + - 'null' + description: The title or name of the task. + team_members: + type: object + $schema: http://json-schema.org/draft-07/schema# + properties: + MEMBER_USER_ID: + type: integer + description: The unique identifier for the team member user + PERMISSION_ID: + type: + - integer + - 'null' + description: The permission level associated with the team member + TEAM_ID: + type: + - integer + - 'null' + description: The identifier for the team to which the member belongs + additionalProperties: true + teams: + type: object + $schema: http://json-schema.org/draft-07/schema# + additionalProperties: true + properties: + ANONYMOUS_TEAM: + type: + - boolean + - 'null' + description: Indicates if the team is anonymous or not. + DATE_CREATED_UTC: + type: + - string + - 'null' + description: The date and time when the team was created. + format: date-time + DATE_UPDATED_UTC: + type: + - string + - 'null' + description: The date and time when the team was last updated. + format: date-time + TEAMMEMBERS: + type: array + description: List of team members associated with the team. + TEAM_ID: + type: integer + description: The unique identifier for the team. + TEAM_NAME: + type: + - string + - 'null' + description: The name of the team. + users: + type: object + $schema: http://json-schema.org/draft-04/schema# + properties: + ACCOUNT_OWNER: + type: + - boolean + - 'null' + description: Indicates if the user is the owner of the account + ACTIVE: + type: + - boolean + - 'null' + description: Indicates if the user is currently active + ADMINISTRATOR: + type: + - boolean + - 'null' + description: Indicates if the user has administrator privileges + CONTACT_DISPLAY: + type: + - string + - 'null' + description: The display name of the user + CONTACT_ID: + type: + - integer + - 'null' + description: The unique identifier for the user contact + CONTACT_ORDER: + type: + - string + - 'null' + description: The order of the contact + DATE_CREATED_UTC: + type: + - string + - 'null' + description: The date and time when the user was created in UTC timezone + format: date-time + DATE_UPDATED_UTC: + type: + - string + - 'null' + description: The date and time when the user was last updated in UTC timezone + format: date-time + EMAIL_ADDRESS: + type: + - string + - 'null' + description: The email address of the user + EMAIL_DROPBOX_ADDRESS: + type: + - string + - 'null' + description: The Dropbox email address associated with the user + EMAIL_DROPBOX_IDENTIFIER: + type: + - string + - 'null' + description: The Dropbox identifier of the user + FIRST_NAME: + type: + - string + - 'null' + description: The first name of the user + INSTANCE_ID: + type: + - integer + - 'null' + description: The unique identifier of the instance + LAST_NAME: + type: + - string + - 'null' + description: The last name of the user + PROFILE_ID: + type: + - integer + - 'null' + description: The profile identifier of the user + ROLE_ID: + type: + - integer + - 'null' + description: The role identifier of the user + TASK_WEEK_START: + type: + - integer + - 'null' + description: The start day of the week for tasks + TIMEZONE_ID: + type: + - string + - 'null' + description: The timezone identifier of the user + USER_CURRENCY: + type: + - string + - 'null' + description: The currency used by the user + USER_ID: + type: integer + description: The unique identifier of the user + additionalProperties: true diff --git a/docs/integrations/sources/insightly.md b/docs/integrations/sources/insightly.md index abb47c15ddc2..b0fd2974f8c4 100644 --- a/docs/integrations/sources/insightly.md +++ b/docs/integrations/sources/insightly.md @@ -69,6 +69,7 @@ The connector is restricted by Insightly [requests limitation](https://api.na1.i | Version | Date | Pull Request | Subject | | :------ | :--------- | :------------------------------------------------------- | :------------------------------------------------------------------------------ | +| 0.2.5 | 2024-05-30 | [00000](https://github.com/airbytehq/airbyte/pull/00000) | Make compatable with builder | | 0.2.4 | 2024-04-19 | [37177](https://github.com/airbytehq/airbyte/pull/37177) | Updating to 0.80.0 CDK | | 0.2.3 | 2024-04-18 | [37177](https://github.com/airbytehq/airbyte/pull/37177) | Manage dependencies with Poetry. | | 0.2.2 | 2024-04-15 | [37177](https://github.com/airbytehq/airbyte/pull/37177) | Base image migration: remove Dockerfile and use the python-connector-base image | From aeceb661ba656f404f5b609650600c0c65dc856f Mon Sep 17 00:00:00 2001 From: btkcodedev Date: Sat, 11 May 2024 23:01:32 +0530 Subject: [PATCH 2/5] chore: format --- .../source_insightly/manifest.yaml | 1310 ++++++++--------- 1 file changed, 655 insertions(+), 655 deletions(-) diff --git a/airbyte-integrations/connectors/source-insightly/source_insightly/manifest.yaml b/airbyte-integrations/connectors/source-insightly/source_insightly/manifest.yaml index de5964a9d995..d5174720ede5 100644 --- a/airbyte-integrations/connectors/source-insightly/source_insightly/manifest.yaml +++ b/airbyte-integrations/connectors/source-insightly/source_insightly/manifest.yaml @@ -18,12 +18,12 @@ definitions: retriever: type: SimpleRetriever requester: - $ref: '#/definitions/base_requester' + $ref: "#/definitions/base_requester" path: /ActivitySets http_method: GET request_parameters: - count_total: 'True' - updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + count_total: "True" + updated_after_utc: "{{ stream_state['DATE_UPDATED_UTC'] }}" error_handler: type: CompositeErrorHandler error_handlers: @@ -64,7 +64,7 @@ definitions: schema_loader: type: InlineSchemaLoader schema: - $ref: '#/schemas/activity_sets' + $ref: "#/schemas/activity_sets" contacts: type: DeclarativeStream name: contacts @@ -73,12 +73,12 @@ definitions: retriever: type: SimpleRetriever requester: - $ref: '#/definitions/base_requester' + $ref: "#/definitions/base_requester" path: /Contacts/Search http_method: GET request_parameters: - count_total: 'True' - updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + count_total: "True" + updated_after_utc: "{{ stream_state['DATE_UPDATED_UTC'] }}" error_handler: type: CompositeErrorHandler error_handlers: @@ -120,22 +120,22 @@ definitions: cursor_field: DATE_UPDATED_UTC path: /Contacts/Search cursor_datetime_formats: - - '%Y-%m-%d %H:%M:%S' - datetime_format: '%Y-%m-%d %H:%M:%S' + - "%Y-%m-%d %H:%M:%S" + datetime_format: "%Y-%m-%d %H:%M:%S" start_datetime: type: MinMaxDatetime - datetime: '{{ config[''start_date''] }}' - datetime_format: '%Y-%m-%dT%H:%M:%SZ' + datetime: "{{ config['start_date'] }}" + datetime_format: "%Y-%m-%dT%H:%M:%SZ" end_datetime: type: MinMaxDatetime - datetime: '{{ now_utc() }}' - datetime_format: '%Y-%m-%d %H:%M:%S.%f+00:00' + datetime: "{{ now_utc() }}" + datetime_format: "%Y-%m-%d %H:%M:%S.%f+00:00" step: P30D cursor_granularity: PT1S schema_loader: type: InlineSchemaLoader schema: - $ref: '#/schemas/contacts' + $ref: "#/schemas/contacts" countries: type: DeclarativeStream name: countries @@ -144,12 +144,12 @@ definitions: retriever: type: SimpleRetriever requester: - $ref: '#/definitions/base_requester' + $ref: "#/definitions/base_requester" path: /Countries http_method: GET request_parameters: - count_total: 'True' - updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + count_total: "True" + updated_after_utc: "{{ stream_state['DATE_UPDATED_UTC'] }}" error_handler: type: CompositeErrorHandler error_handlers: @@ -189,7 +189,7 @@ definitions: schema_loader: type: InlineSchemaLoader schema: - $ref: '#/schemas/countries' + $ref: "#/schemas/countries" currencies: type: DeclarativeStream name: currencies @@ -198,12 +198,12 @@ definitions: retriever: type: SimpleRetriever requester: - $ref: '#/definitions/base_requester' + $ref: "#/definitions/base_requester" path: /Currencies http_method: GET request_parameters: - count_total: 'True' - updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + count_total: "True" + updated_after_utc: "{{ stream_state['DATE_UPDATED_UTC'] }}" error_handler: type: CompositeErrorHandler error_handlers: @@ -243,7 +243,7 @@ definitions: schema_loader: type: InlineSchemaLoader schema: - $ref: '#/schemas/currencies' + $ref: "#/schemas/currencies" emails: type: DeclarativeStream name: emails @@ -252,12 +252,12 @@ definitions: retriever: type: SimpleRetriever requester: - $ref: '#/definitions/base_requester' + $ref: "#/definitions/base_requester" path: /Emails/Search http_method: GET request_parameters: - count_total: 'True' - updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + count_total: "True" + updated_after_utc: "{{ stream_state['DATE_UPDATED_UTC'] }}" error_handler: type: CompositeErrorHandler error_handlers: @@ -297,7 +297,7 @@ definitions: schema_loader: type: InlineSchemaLoader schema: - $ref: '#/schemas/emails' + $ref: "#/schemas/emails" events: type: DeclarativeStream name: events @@ -306,12 +306,12 @@ definitions: retriever: type: SimpleRetriever requester: - $ref: '#/definitions/base_requester' + $ref: "#/definitions/base_requester" path: /Events/Search http_method: GET request_parameters: - count_total: 'True' - updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + count_total: "True" + updated_after_utc: "{{ stream_state['DATE_UPDATED_UTC'] }}" error_handler: type: CompositeErrorHandler error_handlers: @@ -353,22 +353,22 @@ definitions: cursor_field: DATE_UPDATED_UTC path: /Events/Search cursor_datetime_formats: - - '%Y-%m-%d %H:%M:%S' - datetime_format: '%Y-%m-%d %H:%M:%S' + - "%Y-%m-%d %H:%M:%S" + datetime_format: "%Y-%m-%d %H:%M:%S" start_datetime: type: MinMaxDatetime - datetime: '{{ config[''start_date''] }}' - datetime_format: '%Y-%m-%dT%H:%M:%SZ' + datetime: "{{ config['start_date'] }}" + datetime_format: "%Y-%m-%dT%H:%M:%SZ" end_datetime: type: MinMaxDatetime - datetime: '{{ now_utc() }}' - datetime_format: '%Y-%m-%d %H:%M:%S.%f+00:00' + datetime: "{{ now_utc() }}" + datetime_format: "%Y-%m-%d %H:%M:%S.%f+00:00" step: P30D cursor_granularity: PT1S schema_loader: type: InlineSchemaLoader schema: - $ref: '#/schemas/events' + $ref: "#/schemas/events" knowledge_article_categories: type: DeclarativeStream name: knowledge_article_categories @@ -377,12 +377,12 @@ definitions: retriever: type: SimpleRetriever requester: - $ref: '#/definitions/base_requester' + $ref: "#/definitions/base_requester" path: /KnowledgeArticleCategory/Search http_method: GET request_parameters: - count_total: 'True' - updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + count_total: "True" + updated_after_utc: "{{ stream_state['DATE_UPDATED_UTC'] }}" error_handler: type: CompositeErrorHandler error_handlers: @@ -424,22 +424,22 @@ definitions: cursor_field: DATE_UPDATED_UTC path: /KnowledgeArticleCategory/Search cursor_datetime_formats: - - '%Y-%m-%d %H:%M:%S' - datetime_format: '%Y-%m-%d %H:%M:%S' + - "%Y-%m-%d %H:%M:%S" + datetime_format: "%Y-%m-%d %H:%M:%S" start_datetime: type: MinMaxDatetime - datetime: '{{ config[''start_date''] }}' - datetime_format: '%Y-%m-%dT%H:%M:%SZ' + datetime: "{{ config['start_date'] }}" + datetime_format: "%Y-%m-%dT%H:%M:%SZ" end_datetime: type: MinMaxDatetime - datetime: '{{ now_utc() }}' - datetime_format: '%Y-%m-%d %H:%M:%S.%f+00:00' + datetime: "{{ now_utc() }}" + datetime_format: "%Y-%m-%d %H:%M:%S.%f+00:00" step: P30D cursor_granularity: PT1S schema_loader: type: InlineSchemaLoader schema: - $ref: '#/schemas/knowledge_article_categories' + $ref: "#/schemas/knowledge_article_categories" knowledge_article_folders: type: DeclarativeStream name: knowledge_article_folders @@ -448,12 +448,12 @@ definitions: retriever: type: SimpleRetriever requester: - $ref: '#/definitions/base_requester' + $ref: "#/definitions/base_requester" path: /KnowledgeArticleFolder/Search http_method: GET request_parameters: - count_total: 'True' - updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + count_total: "True" + updated_after_utc: "{{ stream_state['DATE_UPDATED_UTC'] }}" error_handler: type: CompositeErrorHandler error_handlers: @@ -495,22 +495,22 @@ definitions: cursor_field: DATE_UPDATED_UTC path: /KnowledgeArticleFolder/Search cursor_datetime_formats: - - '%Y-%m-%d %H:%M:%S' - datetime_format: '%Y-%m-%d %H:%M:%S' + - "%Y-%m-%d %H:%M:%S" + datetime_format: "%Y-%m-%d %H:%M:%S" start_datetime: type: MinMaxDatetime - datetime: '{{ config[''start_date''] }}' - datetime_format: '%Y-%m-%dT%H:%M:%SZ' + datetime: "{{ config['start_date'] }}" + datetime_format: "%Y-%m-%dT%H:%M:%SZ" end_datetime: type: MinMaxDatetime - datetime: '{{ now_utc() }}' - datetime_format: '%Y-%m-%d %H:%M:%S.%f+00:00' + datetime: "{{ now_utc() }}" + datetime_format: "%Y-%m-%d %H:%M:%S.%f+00:00" step: P30D cursor_granularity: PT1S schema_loader: type: InlineSchemaLoader schema: - $ref: '#/schemas/knowledge_article_folders' + $ref: "#/schemas/knowledge_article_folders" knowledge_articles: type: DeclarativeStream name: knowledge_articles @@ -519,12 +519,12 @@ definitions: retriever: type: SimpleRetriever requester: - $ref: '#/definitions/base_requester' + $ref: "#/definitions/base_requester" path: /KnowledgeArticle/Search http_method: GET request_parameters: - count_total: 'True' - updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + count_total: "True" + updated_after_utc: "{{ stream_state['DATE_UPDATED_UTC'] }}" error_handler: type: CompositeErrorHandler error_handlers: @@ -566,22 +566,22 @@ definitions: cursor_field: DATE_UPDATED_UTC path: /KnowledgeArticle/Search cursor_datetime_formats: - - '%Y-%m-%d %H:%M:%S' - datetime_format: '%Y-%m-%d %H:%M:%S' + - "%Y-%m-%d %H:%M:%S" + datetime_format: "%Y-%m-%d %H:%M:%S" start_datetime: type: MinMaxDatetime - datetime: '{{ config[''start_date''] }}' - datetime_format: '%Y-%m-%dT%H:%M:%SZ' + datetime: "{{ config['start_date'] }}" + datetime_format: "%Y-%m-%dT%H:%M:%SZ" end_datetime: type: MinMaxDatetime - datetime: '{{ now_utc() }}' - datetime_format: '%Y-%m-%d %H:%M:%S.%f+00:00' + datetime: "{{ now_utc() }}" + datetime_format: "%Y-%m-%d %H:%M:%S.%f+00:00" step: P30D cursor_granularity: PT1S schema_loader: type: InlineSchemaLoader schema: - $ref: '#/schemas/knowledge_articles' + $ref: "#/schemas/knowledge_articles" lead_sources: type: DeclarativeStream name: lead_sources @@ -590,12 +590,12 @@ definitions: retriever: type: SimpleRetriever requester: - $ref: '#/definitions/base_requester' + $ref: "#/definitions/base_requester" path: /LeadSources http_method: GET request_parameters: - count_total: 'True' - updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + count_total: "True" + updated_after_utc: "{{ stream_state['DATE_UPDATED_UTC'] }}" error_handler: type: CompositeErrorHandler error_handlers: @@ -635,7 +635,7 @@ definitions: schema_loader: type: InlineSchemaLoader schema: - $ref: '#/schemas/lead_sources' + $ref: "#/schemas/lead_sources" lead_statuses: type: DeclarativeStream name: lead_statuses @@ -644,12 +644,12 @@ definitions: retriever: type: SimpleRetriever requester: - $ref: '#/definitions/base_requester' + $ref: "#/definitions/base_requester" path: /LeadStatuses http_method: GET request_parameters: - count_total: 'True' - updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + count_total: "True" + updated_after_utc: "{{ stream_state['DATE_UPDATED_UTC'] }}" error_handler: type: CompositeErrorHandler error_handlers: @@ -689,7 +689,7 @@ definitions: schema_loader: type: InlineSchemaLoader schema: - $ref: '#/schemas/lead_statuses' + $ref: "#/schemas/lead_statuses" milestones: type: DeclarativeStream name: milestones @@ -698,12 +698,12 @@ definitions: retriever: type: SimpleRetriever requester: - $ref: '#/definitions/base_requester' + $ref: "#/definitions/base_requester" path: /Milestones/Search http_method: GET request_parameters: - count_total: 'True' - updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + count_total: "True" + updated_after_utc: "{{ stream_state['DATE_UPDATED_UTC'] }}" error_handler: type: CompositeErrorHandler error_handlers: @@ -745,22 +745,22 @@ definitions: cursor_field: DATE_UPDATED_UTC path: /Milestones/Search cursor_datetime_formats: - - '%Y-%m-%d %H:%M:%S' - datetime_format: '%Y-%m-%d %H:%M:%S' + - "%Y-%m-%d %H:%M:%S" + datetime_format: "%Y-%m-%d %H:%M:%S" start_datetime: type: MinMaxDatetime - datetime: '{{ config[''start_date''] }}' - datetime_format: '%Y-%m-%dT%H:%M:%SZ' + datetime: "{{ config['start_date'] }}" + datetime_format: "%Y-%m-%dT%H:%M:%SZ" end_datetime: type: MinMaxDatetime - datetime: '{{ now_utc() }}' - datetime_format: '%Y-%m-%d %H:%M:%S.%f+00:00' + datetime: "{{ now_utc() }}" + datetime_format: "%Y-%m-%d %H:%M:%S.%f+00:00" step: P30D cursor_granularity: PT1S schema_loader: type: InlineSchemaLoader schema: - $ref: '#/schemas/milestones' + $ref: "#/schemas/milestones" notes: type: DeclarativeStream name: notes @@ -769,12 +769,12 @@ definitions: retriever: type: SimpleRetriever requester: - $ref: '#/definitions/base_requester' + $ref: "#/definitions/base_requester" path: /Notes/Search http_method: GET request_parameters: - count_total: 'True' - updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + count_total: "True" + updated_after_utc: "{{ stream_state['DATE_UPDATED_UTC'] }}" error_handler: type: CompositeErrorHandler error_handlers: @@ -816,22 +816,22 @@ definitions: cursor_field: DATE_UPDATED_UTC path: /Notes/Search cursor_datetime_formats: - - '%Y-%m-%d %H:%M:%S' - datetime_format: '%Y-%m-%d %H:%M:%S' + - "%Y-%m-%d %H:%M:%S" + datetime_format: "%Y-%m-%d %H:%M:%S" start_datetime: type: MinMaxDatetime - datetime: '{{ config[''start_date''] }}' - datetime_format: '%Y-%m-%dT%H:%M:%SZ' + datetime: "{{ config['start_date'] }}" + datetime_format: "%Y-%m-%dT%H:%M:%SZ" end_datetime: type: MinMaxDatetime - datetime: '{{ now_utc() }}' - datetime_format: '%Y-%m-%d %H:%M:%S.%f+00:00' + datetime: "{{ now_utc() }}" + datetime_format: "%Y-%m-%d %H:%M:%S.%f+00:00" step: P30D cursor_granularity: PT1S schema_loader: type: InlineSchemaLoader schema: - $ref: '#/schemas/notes' + $ref: "#/schemas/notes" opportunities: type: DeclarativeStream name: opportunities @@ -840,12 +840,12 @@ definitions: retriever: type: SimpleRetriever requester: - $ref: '#/definitions/base_requester' + $ref: "#/definitions/base_requester" path: /Opportunities/Search http_method: GET request_parameters: - count_total: 'True' - updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + count_total: "True" + updated_after_utc: "{{ stream_state['DATE_UPDATED_UTC'] }}" error_handler: type: CompositeErrorHandler error_handlers: @@ -887,22 +887,22 @@ definitions: cursor_field: DATE_UPDATED_UTC path: /Opportunities/Search cursor_datetime_formats: - - '%Y-%m-%d %H:%M:%S' - datetime_format: '%Y-%m-%d %H:%M:%S' + - "%Y-%m-%d %H:%M:%S" + datetime_format: "%Y-%m-%d %H:%M:%S" start_datetime: type: MinMaxDatetime - datetime: '{{ config[''start_date''] }}' - datetime_format: '%Y-%m-%dT%H:%M:%SZ' + datetime: "{{ config['start_date'] }}" + datetime_format: "%Y-%m-%dT%H:%M:%SZ" end_datetime: type: MinMaxDatetime - datetime: '{{ now_utc() }}' - datetime_format: '%Y-%m-%d %H:%M:%S.%f+00:00' + datetime: "{{ now_utc() }}" + datetime_format: "%Y-%m-%d %H:%M:%S.%f+00:00" step: P30D cursor_granularity: PT1S schema_loader: type: InlineSchemaLoader schema: - $ref: '#/schemas/opportunities' + $ref: "#/schemas/opportunities" opportunity_categories: type: DeclarativeStream name: opportunity_categories @@ -911,12 +911,12 @@ definitions: retriever: type: SimpleRetriever requester: - $ref: '#/definitions/base_requester' + $ref: "#/definitions/base_requester" path: /OpportunityCategories http_method: GET request_parameters: - count_total: 'True' - updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + count_total: "True" + updated_after_utc: "{{ stream_state['DATE_UPDATED_UTC'] }}" error_handler: type: CompositeErrorHandler error_handlers: @@ -956,7 +956,7 @@ definitions: schema_loader: type: InlineSchemaLoader schema: - $ref: '#/schemas/opportunity_categories' + $ref: "#/schemas/opportunity_categories" opportunity_state_reasons: type: DeclarativeStream name: opportunity_state_reasons @@ -965,12 +965,12 @@ definitions: retriever: type: SimpleRetriever requester: - $ref: '#/definitions/base_requester' + $ref: "#/definitions/base_requester" path: /OpportunityStateReasons http_method: GET request_parameters: - count_total: 'True' - updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + count_total: "True" + updated_after_utc: "{{ stream_state['DATE_UPDATED_UTC'] }}" error_handler: type: CompositeErrorHandler error_handlers: @@ -1010,7 +1010,7 @@ definitions: schema_loader: type: InlineSchemaLoader schema: - $ref: '#/schemas/opportunity_state_reasons' + $ref: "#/schemas/opportunity_state_reasons" organisations: type: DeclarativeStream name: organisations @@ -1019,12 +1019,12 @@ definitions: retriever: type: SimpleRetriever requester: - $ref: '#/definitions/base_requester' + $ref: "#/definitions/base_requester" path: /Organisations/Search http_method: GET request_parameters: - count_total: 'True' - updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + count_total: "True" + updated_after_utc: "{{ stream_state['DATE_UPDATED_UTC'] }}" error_handler: type: CompositeErrorHandler error_handlers: @@ -1066,22 +1066,22 @@ definitions: cursor_field: DATE_UPDATED_UTC path: /Organisations/Search cursor_datetime_formats: - - '%Y-%m-%d %H:%M:%S' - datetime_format: '%Y-%m-%d %H:%M:%S' + - "%Y-%m-%d %H:%M:%S" + datetime_format: "%Y-%m-%d %H:%M:%S" start_datetime: type: MinMaxDatetime - datetime: '{{ config[''start_date''] }}' - datetime_format: '%Y-%m-%dT%H:%M:%SZ' + datetime: "{{ config['start_date'] }}" + datetime_format: "%Y-%m-%dT%H:%M:%SZ" end_datetime: type: MinMaxDatetime - datetime: '{{ now_utc() }}' - datetime_format: '%Y-%m-%d %H:%M:%S.%f+00:00' + datetime: "{{ now_utc() }}" + datetime_format: "%Y-%m-%d %H:%M:%S.%f+00:00" step: P30D cursor_granularity: PT1S schema_loader: type: InlineSchemaLoader schema: - $ref: '#/schemas/organisations' + $ref: "#/schemas/organisations" pipelines: type: DeclarativeStream name: pipelines @@ -1090,12 +1090,12 @@ definitions: retriever: type: SimpleRetriever requester: - $ref: '#/definitions/base_requester' + $ref: "#/definitions/base_requester" path: /Pipelines http_method: GET request_parameters: - count_total: 'True' - updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + count_total: "True" + updated_after_utc: "{{ stream_state['DATE_UPDATED_UTC'] }}" error_handler: type: CompositeErrorHandler error_handlers: @@ -1135,7 +1135,7 @@ definitions: schema_loader: type: InlineSchemaLoader schema: - $ref: '#/schemas/pipelines' + $ref: "#/schemas/pipelines" pipeline_stages: type: DeclarativeStream name: pipeline_stages @@ -1144,12 +1144,12 @@ definitions: retriever: type: SimpleRetriever requester: - $ref: '#/definitions/base_requester' + $ref: "#/definitions/base_requester" path: /PipelineStages http_method: GET request_parameters: - count_total: 'True' - updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + count_total: "True" + updated_after_utc: "{{ stream_state['DATE_UPDATED_UTC'] }}" error_handler: type: CompositeErrorHandler error_handlers: @@ -1189,7 +1189,7 @@ definitions: schema_loader: type: InlineSchemaLoader schema: - $ref: '#/schemas/pipeline_stages' + $ref: "#/schemas/pipeline_stages" project_categories: type: DeclarativeStream name: project_categories @@ -1198,12 +1198,12 @@ definitions: retriever: type: SimpleRetriever requester: - $ref: '#/definitions/base_requester' + $ref: "#/definitions/base_requester" path: /ProjectCategories http_method: GET request_parameters: - count_total: 'True' - updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + count_total: "True" + updated_after_utc: "{{ stream_state['DATE_UPDATED_UTC'] }}" error_handler: type: CompositeErrorHandler error_handlers: @@ -1243,7 +1243,7 @@ definitions: schema_loader: type: InlineSchemaLoader schema: - $ref: '#/schemas/project_categories' + $ref: "#/schemas/project_categories" projects: type: DeclarativeStream name: projects @@ -1252,12 +1252,12 @@ definitions: retriever: type: SimpleRetriever requester: - $ref: '#/definitions/base_requester' + $ref: "#/definitions/base_requester" path: /Projects/Search http_method: GET request_parameters: - count_total: 'True' - updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + count_total: "True" + updated_after_utc: "{{ stream_state['DATE_UPDATED_UTC'] }}" error_handler: type: CompositeErrorHandler error_handlers: @@ -1299,22 +1299,22 @@ definitions: cursor_field: DATE_UPDATED_UTC path: /Projects/Search cursor_datetime_formats: - - '%Y-%m-%d %H:%M:%S' - datetime_format: '%Y-%m-%d %H:%M:%S' + - "%Y-%m-%d %H:%M:%S" + datetime_format: "%Y-%m-%d %H:%M:%S" start_datetime: type: MinMaxDatetime - datetime: '{{ config[''start_date''] }}' - datetime_format: '%Y-%m-%dT%H:%M:%SZ' + datetime: "{{ config['start_date'] }}" + datetime_format: "%Y-%m-%dT%H:%M:%SZ" end_datetime: type: MinMaxDatetime - datetime: '{{ now_utc() }}' - datetime_format: '%Y-%m-%d %H:%M:%S.%f+00:00' + datetime: "{{ now_utc() }}" + datetime_format: "%Y-%m-%d %H:%M:%S.%f+00:00" step: P30D cursor_granularity: PT1S schema_loader: type: InlineSchemaLoader schema: - $ref: '#/schemas/projects' + $ref: "#/schemas/projects" prospects: type: DeclarativeStream name: prospects @@ -1323,12 +1323,12 @@ definitions: retriever: type: SimpleRetriever requester: - $ref: '#/definitions/base_requester' + $ref: "#/definitions/base_requester" path: /Prospect/Search http_method: GET request_parameters: - count_total: 'True' - updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + count_total: "True" + updated_after_utc: "{{ stream_state['DATE_UPDATED_UTC'] }}" error_handler: type: CompositeErrorHandler error_handlers: @@ -1370,22 +1370,22 @@ definitions: cursor_field: DATE_UPDATED_UTC path: /Prospect/Search cursor_datetime_formats: - - '%Y-%m-%d %H:%M:%S' - datetime_format: '%Y-%m-%d %H:%M:%S' + - "%Y-%m-%d %H:%M:%S" + datetime_format: "%Y-%m-%d %H:%M:%S" start_datetime: type: MinMaxDatetime - datetime: '{{ config[''start_date''] }}' - datetime_format: '%Y-%m-%dT%H:%M:%SZ' + datetime: "{{ config['start_date'] }}" + datetime_format: "%Y-%m-%dT%H:%M:%SZ" end_datetime: type: MinMaxDatetime - datetime: '{{ now_utc() }}' - datetime_format: '%Y-%m-%d %H:%M:%S.%f+00:00' + datetime: "{{ now_utc() }}" + datetime_format: "%Y-%m-%d %H:%M:%S.%f+00:00" step: P30D cursor_granularity: PT1S schema_loader: type: InlineSchemaLoader schema: - $ref: '#/schemas/prospects' + $ref: "#/schemas/prospects" relationships: type: DeclarativeStream name: relationships @@ -1394,12 +1394,12 @@ definitions: retriever: type: SimpleRetriever requester: - $ref: '#/definitions/base_requester' + $ref: "#/definitions/base_requester" path: /Relationships http_method: GET request_parameters: - count_total: 'True' - updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + count_total: "True" + updated_after_utc: "{{ stream_state['DATE_UPDATED_UTC'] }}" error_handler: type: CompositeErrorHandler error_handlers: @@ -1439,7 +1439,7 @@ definitions: schema_loader: type: InlineSchemaLoader schema: - $ref: '#/schemas/relationships' + $ref: "#/schemas/relationships" task_categories: type: DeclarativeStream name: task_categories @@ -1448,12 +1448,12 @@ definitions: retriever: type: SimpleRetriever requester: - $ref: '#/definitions/base_requester' + $ref: "#/definitions/base_requester" path: /TaskCategories http_method: GET request_parameters: - count_total: 'True' - updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + count_total: "True" + updated_after_utc: "{{ stream_state['DATE_UPDATED_UTC'] }}" error_handler: type: CompositeErrorHandler error_handlers: @@ -1493,7 +1493,7 @@ definitions: schema_loader: type: InlineSchemaLoader schema: - $ref: '#/schemas/task_categories' + $ref: "#/schemas/task_categories" tasks: type: DeclarativeStream name: tasks @@ -1502,12 +1502,12 @@ definitions: retriever: type: SimpleRetriever requester: - $ref: '#/definitions/base_requester' + $ref: "#/definitions/base_requester" path: /Tasks/Search http_method: GET request_parameters: - count_total: 'True' - updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + count_total: "True" + updated_after_utc: "{{ stream_state['DATE_UPDATED_UTC'] }}" error_handler: type: CompositeErrorHandler error_handlers: @@ -1549,22 +1549,22 @@ definitions: cursor_field: DATE_UPDATED_UTC path: /Tasks/Search cursor_datetime_formats: - - '%Y-%m-%d %H:%M:%S' - datetime_format: '%Y-%m-%d %H:%M:%S' + - "%Y-%m-%d %H:%M:%S" + datetime_format: "%Y-%m-%d %H:%M:%S" start_datetime: type: MinMaxDatetime - datetime: '{{ config[''start_date''] }}' - datetime_format: '%Y-%m-%dT%H:%M:%SZ' + datetime: "{{ config['start_date'] }}" + datetime_format: "%Y-%m-%dT%H:%M:%SZ" end_datetime: type: MinMaxDatetime - datetime: '{{ now_utc() }}' - datetime_format: '%Y-%m-%d %H:%M:%S.%f+00:00' + datetime: "{{ now_utc() }}" + datetime_format: "%Y-%m-%d %H:%M:%S.%f+00:00" step: P30D cursor_granularity: PT1S schema_loader: type: InlineSchemaLoader schema: - $ref: '#/schemas/tasks' + $ref: "#/schemas/tasks" team_members: type: DeclarativeStream name: team_members @@ -1573,12 +1573,12 @@ definitions: retriever: type: SimpleRetriever requester: - $ref: '#/definitions/base_requester' + $ref: "#/definitions/base_requester" path: /TeamMembers http_method: GET request_parameters: - count_total: 'True' - updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + count_total: "True" + updated_after_utc: "{{ stream_state['DATE_UPDATED_UTC'] }}" error_handler: type: CompositeErrorHandler error_handlers: @@ -1618,7 +1618,7 @@ definitions: schema_loader: type: InlineSchemaLoader schema: - $ref: '#/schemas/team_members' + $ref: "#/schemas/team_members" teams: type: DeclarativeStream name: teams @@ -1627,12 +1627,12 @@ definitions: retriever: type: SimpleRetriever requester: - $ref: '#/definitions/base_requester' + $ref: "#/definitions/base_requester" path: /Teams http_method: GET request_parameters: - count_total: 'True' - updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + count_total: "True" + updated_after_utc: "{{ stream_state['DATE_UPDATED_UTC'] }}" error_handler: type: CompositeErrorHandler error_handlers: @@ -1672,7 +1672,7 @@ definitions: schema_loader: type: InlineSchemaLoader schema: - $ref: '#/schemas/teams' + $ref: "#/schemas/teams" users: type: DeclarativeStream name: users @@ -1681,12 +1681,12 @@ definitions: retriever: type: SimpleRetriever requester: - $ref: '#/definitions/base_requester' + $ref: "#/definitions/base_requester" path: /Users/Search http_method: GET request_parameters: - count_total: 'True' - updated_after_utc: '{{ stream_state[''DATE_UPDATED_UTC''] }}' + count_total: "True" + updated_after_utc: "{{ stream_state['DATE_UPDATED_UTC'] }}" error_handler: type: CompositeErrorHandler error_handlers: @@ -1728,59 +1728,59 @@ definitions: cursor_field: DATE_UPDATED_UTC path: /Users/Search cursor_datetime_formats: - - '%Y-%m-%d %H:%M:%S' - datetime_format: '%Y-%m-%d %H:%M:%S' + - "%Y-%m-%d %H:%M:%S" + datetime_format: "%Y-%m-%d %H:%M:%S" start_datetime: type: MinMaxDatetime - datetime: '{{ config[''start_date''] }}' - datetime_format: '%Y-%m-%dT%H:%M:%SZ' + datetime: "{{ config['start_date'] }}" + datetime_format: "%Y-%m-%dT%H:%M:%SZ" end_datetime: type: MinMaxDatetime - datetime: '{{ now_utc() }}' - datetime_format: '%Y-%m-%d %H:%M:%S.%f+00:00' + datetime: "{{ now_utc() }}" + datetime_format: "%Y-%m-%d %H:%M:%S.%f+00:00" step: P30D cursor_granularity: PT1S schema_loader: type: InlineSchemaLoader schema: - $ref: '#/schemas/users' + $ref: "#/schemas/users" base_requester: type: HttpRequester url_base: https://api.na1.insightly.com/v3.1/ authenticator: type: BasicHttpAuthenticator - username: '{{ config[''token''] }}' - password: '{{ config[''nothing''] }}' + username: "{{ config['token'] }}" + password: "{{ config['nothing'] }}" streams: - - $ref: '#/definitions/streams/activity_sets' - - $ref: '#/definitions/streams/contacts' - - $ref: '#/definitions/streams/countries' - - $ref: '#/definitions/streams/currencies' - - $ref: '#/definitions/streams/emails' - - $ref: '#/definitions/streams/events' - - $ref: '#/definitions/streams/knowledge_article_categories' - - $ref: '#/definitions/streams/knowledge_article_folders' - - $ref: '#/definitions/streams/knowledge_articles' - - $ref: '#/definitions/streams/lead_sources' - - $ref: '#/definitions/streams/lead_statuses' - - $ref: '#/definitions/streams/milestones' - - $ref: '#/definitions/streams/notes' - - $ref: '#/definitions/streams/opportunities' - - $ref: '#/definitions/streams/opportunity_categories' - - $ref: '#/definitions/streams/opportunity_state_reasons' - - $ref: '#/definitions/streams/organisations' - - $ref: '#/definitions/streams/pipelines' - - $ref: '#/definitions/streams/pipeline_stages' - - $ref: '#/definitions/streams/project_categories' - - $ref: '#/definitions/streams/projects' - - $ref: '#/definitions/streams/prospects' - - $ref: '#/definitions/streams/relationships' - - $ref: '#/definitions/streams/task_categories' - - $ref: '#/definitions/streams/tasks' - - $ref: '#/definitions/streams/team_members' - - $ref: '#/definitions/streams/teams' - - $ref: '#/definitions/streams/users' + - $ref: "#/definitions/streams/activity_sets" + - $ref: "#/definitions/streams/contacts" + - $ref: "#/definitions/streams/countries" + - $ref: "#/definitions/streams/currencies" + - $ref: "#/definitions/streams/emails" + - $ref: "#/definitions/streams/events" + - $ref: "#/definitions/streams/knowledge_article_categories" + - $ref: "#/definitions/streams/knowledge_article_folders" + - $ref: "#/definitions/streams/knowledge_articles" + - $ref: "#/definitions/streams/lead_sources" + - $ref: "#/definitions/streams/lead_statuses" + - $ref: "#/definitions/streams/milestones" + - $ref: "#/definitions/streams/notes" + - $ref: "#/definitions/streams/opportunities" + - $ref: "#/definitions/streams/opportunity_categories" + - $ref: "#/definitions/streams/opportunity_state_reasons" + - $ref: "#/definitions/streams/organisations" + - $ref: "#/definitions/streams/pipelines" + - $ref: "#/definitions/streams/pipeline_stages" + - $ref: "#/definitions/streams/project_categories" + - $ref: "#/definitions/streams/projects" + - $ref: "#/definitions/streams/prospects" + - $ref: "#/definitions/streams/relationships" + - $ref: "#/definitions/streams/task_categories" + - $ref: "#/definitions/streams/tasks" + - $ref: "#/definitions/streams/team_members" + - $ref: "#/definitions/streams/teams" + - $ref: "#/definitions/streams/users" spec: type: Spec @@ -1794,7 +1794,7 @@ spec: start_date: type: - string - - 'null' + - "null" title: Start Date format: date-time pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$ @@ -1803,12 +1803,12 @@ spec: format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated. Note that it will be used only for incremental streams. examples: - - '2021-03-01T00:00:00Z' + - "2021-03-01T00:00:00Z" order: 0 token: type: - string - - 'null' + - "null" title: API Token description: Your Insightly API token. airbyte_secret: true @@ -1860,150 +1860,150 @@ schemas: ACTIVITYSET_ID: type: - integer - - 'null' + - "null" description: ID of the activity set to which the activity belongs ACTIVITY_DETAILS: type: - string - - 'null' + - "null" description: Details or description of the activity ACTIVITY_ID: type: - integer - - 'null' + - "null" description: ID of the activity ACTIVITY_NAME: type: - string - - 'null' + - "null" description: Name of the activity ACTIVITY_TYPE: type: - string - - 'null' + - "null" description: Type of the activity ALL_DAY: type: - boolean - - 'null' + - "null" description: Boolean flag indicating if the activity is an all-day event ASSIGNED_TEAM_ID: type: - integer - - 'null' + - "null" description: ID of the team assigned to the activity CATEGORY_ID: type: - integer - - 'null' + - "null" description: ID of the category to which the activity belongs DUE_DAYS_AFTER_START: type: - integer - - 'null' + - "null" description: >- Number of days after the start of the activity by which it is due DUE_DAYS_BEFORE_END: type: - integer - - 'null' + - "null" description: Number of days before the end of the activity by which it is due DURATION: type: - integer - - 'null' + - "null" description: Duration of the activity EVENT_DAYS_AFTER_START: type: - integer - - 'null' + - "null" description: >- Number of days after the start of the activity when the event occurs EVENT_DAYS_BEFORE_END: type: - integer - - 'null' + - "null" description: >- Number of days before the end of the activity when the event occurs EVENT_TIME: type: - string - - 'null' + - "null" description: Time of the event associated with the activity OWNER_USER_ID: type: - integer - - 'null' + - "null" description: ID of the user who owns the activity OWNER_VISIBLE: type: - boolean - - 'null' + - "null" description: Boolean flag indicating if the activity is visible to the owner PUBLICLY_VISIBLE: type: - boolean - - 'null' + - "null" description: Boolean flag indicating if the activity is publicly visible REMINDER: type: - boolean - - 'null' + - "null" description: Details about the reminder set for the activity REMINDER_DAYS_BEFORE_DUE: type: - integer - - 'null' + - "null" description: >- Number of days before the due date when the reminder is triggered REMINDER_TIME: type: - string - - 'null' + - "null" description: Time of day when the reminder is triggered RESPONSIBLE_USER_ID: type: - integer - - 'null' + - "null" description: ID of the user responsible for the activity SKIP_FRI: type: - boolean - - 'null' + - "null" description: Boolean flag indicating if the activity is skipped on Fridays SKIP_MON: type: - boolean - - 'null' + - "null" description: Boolean flag indicating if the activity is skipped on Mondays SKIP_SAT: type: - boolean - - 'null' + - "null" description: Boolean flag indicating if the activity is skipped on Saturdays SKIP_SUN: type: - boolean - - 'null' + - "null" description: Boolean flag indicating if the activity is skipped on Sundays SKIP_THU: type: - boolean - - 'null' + - "null" description: Boolean flag indicating if the activity is skipped on Thursdays SKIP_TUE: type: - boolean - - 'null' + - "null" description: Boolean flag indicating if the activity is skipped on Tuesdays SKIP_WED: type: - boolean - - 'null' + - "null" description: Boolean flag indicating if the activity is skipped on Wednesdays ACTIVITYSET_ID: type: integer @@ -2011,37 +2011,37 @@ schemas: FOR_CONTACTS: type: - boolean - - 'null' + - "null" description: Activity set associated with contacts FOR_LEADS: type: - boolean - - 'null' + - "null" description: Activity set associated with leads FOR_OPPORTUNITIES: type: - boolean - - 'null' + - "null" description: Activity set associated with opportunities FOR_ORGANISATIONS: type: - boolean - - 'null' + - "null" description: Activity set associated with organizations FOR_PROJECTS: type: - boolean - - 'null' + - "null" description: Activity set associated with projects NAME: type: - string - - 'null' + - "null" description: Name of the activity set OWNER_USER_ID: type: - integer - - 'null' + - "null" description: ID of the user who owns the activity set additionalProperties: true contacts: @@ -2052,62 +2052,62 @@ schemas: ADDRESS_MAIL_CITY: type: - string - - 'null' + - "null" description: The city of the mailing address ADDRESS_MAIL_COUNTRY: type: - string - - 'null' + - "null" description: The country of the mailing address ADDRESS_MAIL_POSTCODE: type: - string - - 'null' + - "null" description: The postcode of the mailing address ADDRESS_MAIL_STATE: type: - string - - 'null' + - "null" description: The state of the mailing address ADDRESS_MAIL_STREET: type: - string - - 'null' + - "null" description: The street address of the mailing address ADDRESS_OTHER_CITY: type: - string - - 'null' + - "null" description: The city of the other address ADDRESS_OTHER_COUNTRY: type: - string - - 'null' + - "null" description: The country of the other address ADDRESS_OTHER_POSTCODE: type: - string - - 'null' + - "null" description: The postcode of the other address ADDRESS_OTHER_STATE: type: - string - - 'null' + - "null" description: The state of the other address ADDRESS_OTHER_STREET: type: - string - - 'null' + - "null" description: The street address of the other address ASSISTANT_NAME: type: - string - - 'null' + - "null" description: The name of the contact's assistant BACKGROUND: type: - string - - 'null' + - "null" description: Background information about the contact CONTACT_ID: type: integer @@ -2115,7 +2115,7 @@ schemas: CREATED_USER_ID: type: - integer - - 'null' + - "null" description: The user ID of the user who created the contact CUSTOMFIELDS: type: array @@ -2126,7 +2126,7 @@ schemas: FIELD_NAME: type: - string - - 'null' + - "null" description: The name of the custom field FIELD_VALUE: type: object @@ -2140,75 +2140,75 @@ schemas: CREATE_TASK_YEARLY: type: - boolean - - 'null' + - "null" description: Indicates whether a task should be created yearly DATE_ID: type: - integer - - 'null' + - "null" description: The unique identifier for the date event OCCASION_DATE: type: - string - - 'null' + - "null" description: The date of the occasion OCCASION_NAME: type: - string - - 'null' + - "null" description: The name of the occasion REPEAT_YEARLY: type: - boolean - - 'null' + - "null" description: Indicates if the occasion repeats yearly DATE_CREATED_UTC: type: - string - - 'null' + - "null" description: The date and time the contact was created in UTC format: date-time DATE_OF_BIRTH: type: - string - - 'null' + - "null" description: The date of birth of the contact DATE_UPDATED_UTC: type: - string - - 'null' + - "null" description: The date and time the contact was last updated in UTC format: date-time EMAIL_ADDRESS: type: - string - - 'null' + - "null" description: The email address of the contact EMAIL_OPTED_OUT: type: - boolean - - 'null' + - "null" description: Whether the contact has opted out of email communication FIRST_NAME: type: - string - - 'null' + - "null" description: The first name of the contact IMAGE_URL: type: - string - - 'null' + - "null" description: URL of the contact's image LAST_ACTIVITY_DATE_UTC: type: - string - - 'null' + - "null" description: The date and time of the last activity related to the contact in UTC format: date-time LAST_NAME: type: - string - - 'null' + - "null" description: The last name of the contact LINKS: type: array @@ -2219,113 +2219,113 @@ schemas: DETAILS: type: - string - - 'null' + - "null" description: Details about the link IS_FORWARD: type: - boolean - - 'null' + - "null" description: Flag indicating if the link is forward LINK_ID: type: - integer - - 'null' + - "null" description: Unique identifier for the link LINK_OBJECT_ID: type: - integer - - 'null' + - "null" description: The ID of the linked object LINK_OBJECT_NAME: type: - string - - 'null' + - "null" description: The name of the linked object OBJECT_ID: type: - integer - - 'null' + - "null" description: The ID of the object OBJECT_NAME: type: - string - - 'null' + - "null" description: The name of the object RELATIONSHIP_ID: type: - integer - - 'null' + - "null" description: The ID of the relationship ROLE: type: - string - - 'null' + - "null" description: The role of the contact in the relationship NEXT_ACTIVITY_DATE_UTC: type: - string - - 'null' + - "null" description: The date and time of the next activity related to the contact in UTC format: date-time ORGANISATION_ID: type: - integer - - 'null' + - "null" description: The ID of the organization the contact is associated with OWNER_USER_ID: type: - integer - - 'null' + - "null" description: The ID of the user who owns the contact PHONE: type: - string - - 'null' + - "null" description: The primary phone number of the contact PHONE_ASSISTANT: type: - string - - 'null' + - "null" description: The phone number of the contact's assistant PHONE_FAX: type: - string - - 'null' + - "null" description: The fax number of the contact PHONE_HOME: type: - string - - 'null' + - "null" description: The home phone number of the contact PHONE_MOBILE: type: - string - - 'null' + - "null" description: The mobile phone number of the contact PHONE_OTHER: type: - string - - 'null' + - "null" description: Another phone number of the contact SALUTATION: type: - string - - 'null' + - "null" description: The salutation for the contact SOCIAL_FACEBOOK: type: - string - - 'null' + - "null" description: The Facebook profile of the contact SOCIAL_LINKEDIN: type: - string - - 'null' + - "null" description: The LinkedIn profile of the contact SOCIAL_TWITTER: type: - string - - 'null' + - "null" description: The Twitter profile of the contact TAGS: type: array @@ -2336,22 +2336,22 @@ schemas: TAG_NAME: type: - string - - 'null' + - "null" description: The name of the tag associated with the contact TITLE: type: - string - - 'null' + - "null" description: The title of the contact VISIBLE_TEAM_ID: type: - integer - - 'null' + - "null" description: The ID of the team the contact is visible to VISIBLE_TO: type: - string - - 'null' + - "null" description: Indicates who the contact is visible to countries: type: object @@ -2371,7 +2371,7 @@ schemas: CURRENCY_SYMBOL: type: - string - - 'null' + - "null" description: The symbol used to denote the currency. additionalProperties: true emails: @@ -2381,24 +2381,24 @@ schemas: CREATED_USER_ID: type: - integer - - 'null' + - "null" description: The ID of the user who created the email DATE_CREATED_UTC: type: - string - - 'null' + - "null" description: The date and time when the email record was created format: date-time EMAIL_DATE_UTC: type: - string - - 'null' + - "null" description: The date and time when the email was sent/received format: date-time EMAIL_FROM: type: - string - - 'null' + - "null" description: The sender of the email EMAIL_ID: type: integer @@ -2406,7 +2406,7 @@ schemas: FORMAT: type: - string - - 'null' + - "null" description: The format of the email content LINKS: type: array @@ -2417,68 +2417,68 @@ schemas: DETAILS: type: - string - - 'null' + - "null" description: Details about the link IS_FORWARD: type: - boolean - - 'null' + - "null" description: Indicates if the link is a forward link LINK_ID: type: - integer - - 'null' + - "null" description: The ID of the link LINK_OBJECT_ID: type: - integer - - 'null' + - "null" description: The ID of the linked object LINK_OBJECT_NAME: type: - string - - 'null' + - "null" description: The name of the linked object OBJECT_ID: type: - integer - - 'null' + - "null" description: The ID of the object associated with the email OBJECT_NAME: type: - string - - 'null' + - "null" description: The name of the object associated with the email RELATIONSHIP_ID: type: - integer - - 'null' + - "null" description: The ID representing the relationship with the link ROLE: type: - string - - 'null' + - "null" description: The role of the linked object OWNER_USER_ID: type: - integer - - 'null' + - "null" description: The ID of the user who owns the email QUEUED_SEND_DATE_UTC: type: - string - - 'null' + - "null" description: The date and time when the email was queued for sending format: date-time SIZE: type: - integer - - 'null' + - "null" description: The size of the email content SUBJECT: type: - string - - 'null' + - "null" description: The subject of the email TAGS: type: array @@ -2489,7 +2489,7 @@ schemas: TAG_NAME: type: - string - - 'null' + - "null" description: The name of the tag additionalProperties: true events: @@ -2499,7 +2499,7 @@ schemas: ALL_DAY: type: - boolean - - 'null' + - "null" description: Indicates if the event is an all-day event CUSTOMFIELDS: type: array @@ -2510,7 +2510,7 @@ schemas: FIELD_NAME: type: - string - - 'null' + - "null" description: Name of the custom field FIELD_VALUE: type: object @@ -2518,24 +2518,24 @@ schemas: DATE_CREATED_UTC: type: - string - - 'null' + - "null" description: DateTime when the event was created (UTC) format: date-time DATE_UPDATED_UTC: type: - string - - 'null' + - "null" description: DateTime when the event was last updated (UTC) format: date-time DETAILS: type: - string - - 'null' + - "null" description: Additional details of the event END_DATE_UTC: type: - string - - 'null' + - "null" description: End date and time of the event (UTC) format: date-time EVENT_ID: @@ -2550,79 +2550,79 @@ schemas: DETAILS: type: - string - - 'null' + - "null" description: Details of the link IS_FORWARD: type: - boolean - - 'null' + - "null" description: Indicates if the link is forward LINK_ID: type: - integer - - 'null' + - "null" description: Unique identifier for the link LINK_OBJECT_ID: type: - integer - - 'null' + - "null" description: ID of the linked object LINK_OBJECT_NAME: type: - string - - 'null' + - "null" description: Name of the linked object OBJECT_ID: type: - integer - - 'null' + - "null" description: ID of the object OBJECT_NAME: type: - string - - 'null' + - "null" description: Name of the object RELATIONSHIP_ID: type: - integer - - 'null' + - "null" description: ID of the relationship ROLE: type: - string - - 'null' + - "null" description: Role of the link in the relationship LOCATION: type: - string - - 'null' + - "null" description: Location of the event OWNER_USER_ID: type: - integer - - 'null' + - "null" description: User ID of the event owner REMINDER_DATE_UTC: type: - string - - 'null' + - "null" description: DateTime when the reminder for the event is set to trigger (UTC) format: date-time REMINDER_SENT: type: - boolean - - 'null' + - "null" description: Indicates if the reminder for the event has been sent START_DATE_UTC: type: - string - - 'null' + - "null" description: Start date and time of the event (UTC) format: date-time TITLE: type: - string - - 'null' + - "null" description: Title of the event additionalProperties: true knowledge_article_categories: @@ -2635,29 +2635,29 @@ schemas: CATEGORY_NAME: type: - string - - 'null' + - "null" description: Name of the knowledge article category. CREATED_USER_ID: type: - integer - - 'null' + - "null" description: Identifier of the user who created the knowledge article category. DATE_CREATED_UTC: type: - string - - 'null' + - "null" description: Date and time when the knowledge article category was created. format: date-time DATE_UPDATED_UTC: type: - string - - 'null' + - "null" description: Date and time when the knowledge article category was last updated. format: date-time DESCRIPTION: type: - string - - 'null' + - "null" description: Detailed description of the knowledge article category. additionalProperties: true knowledge_article_folders: @@ -2667,27 +2667,27 @@ schemas: CATEGORY_ID: type: - string - - 'null' + - "null" description: >- Unique identifier for the knowledge article category to which the folder belongs. CREATED_USER_ID: type: - integer - - 'null' + - "null" description: >- Unique identifier of the user who created the knowledge article folder. DATE_CREATED_UTC: type: - string - - 'null' + - "null" description: The date and time when the knowledge article folder was created. format: date-time DATE_UPDATED_UTC: type: - string - - 'null' + - "null" description: The date and time when the knowledge article folder was last updated. format: date-time FOLDER_ID: @@ -2696,17 +2696,17 @@ schemas: FOLDER_NAME: type: - string - - 'null' + - "null" description: The name of the knowledge article folder. ORDER_ARTICLES: type: - string - - 'null' + - "null" description: Defines the order in which articles appear within the folder. VISIBILITY: type: - string - - 'null' + - "null" description: >- Indicates the visibility of the knowledge article folder (e.g., public, private, restricted). @@ -2718,7 +2718,7 @@ schemas: ARCHIVED_DATE_UTC: type: - string - - 'null' + - "null" description: The date and time when the article was archived in UTC timezone format: date-time ARTICLE_ID: @@ -2727,27 +2727,27 @@ schemas: ARTICLE_NO: type: - integer - - 'null' + - "null" description: The article number for reference ArticleVersion: type: - string - - 'null' + - "null" description: The version of the article Body: type: - string - - 'null' + - "null" description: The main content of the knowledge article CATEGORY_ID: type: - integer - - 'null' + - "null" description: The category ID to which the article belongs CREATED_USER_ID: type: - integer - - 'null' + - "null" description: The user ID of the creator of the knowledge article CUSTOMFIELDS: type: array @@ -2758,7 +2758,7 @@ schemas: FIELD_NAME: type: - string - - 'null' + - "null" description: Name of the custom field FIELD_VALUE: type: object @@ -2766,61 +2766,61 @@ schemas: DATE_CREATED_UTC: type: - string - - 'null' + - "null" description: The date and time when the article was created in UTC timezone format: date-time DATE_UPDATED_UTC: type: - string - - 'null' + - "null" description: The date and time when the article was last updated in UTC timezone format: date-time DOWNVOTE_COUNT: type: - integer - - 'null' + - "null" description: Number of downvotes received for the article ExternalLinkCount: type: - string - - 'null' + - "null" description: Number of external links referenced in the article FIRST_PUBLISHED_DATE_UTC: type: - string - - 'null' + - "null" description: The date and time when the article was first published in UTC timezone format: date-time FOLDER_ID: type: - integer - - 'null' + - "null" description: The ID of the folder where the article is stored LAST_PUBLISHED_DATE_UTC: type: - string - - 'null' + - "null" description: The date and time when the article was last published in UTC timezone format: date-time Language: type: - string - - 'null' + - "null" description: The language in which the article is written OWNER_USER_ID: type: - integer - - 'null' + - "null" description: The user ID of the owner of the article PROMOTED: type: - boolean - - 'null' + - "null" description: Indicates if the article is promoted or not Status: type: - string - - 'null' + - "null" description: The status of the article (e.g., draft, published) TAGS: type: array @@ -2831,22 +2831,22 @@ schemas: TAG_NAME: type: - string - - 'null' + - "null" description: The name of the tag Title: type: - string - - 'null' + - "null" description: The title of the knowledge article UPVOTE_COUNT: type: - integer - - 'null' + - "null" description: Number of upvotes received for the article URL_SLUG: type: - string - - 'null' + - "null" description: The URL-friendly slug for the article additionalProperties: true lead_sources: @@ -2856,19 +2856,19 @@ schemas: DEFAULT_VALUE: type: - boolean - - 'null' + - "null" description: >- The default value for the lead source, used when no specific lead source is assigned. FIELD_ORDER: type: - integer - - 'null' + - "null" description: The order in which the lead sources are displayed or prioritized. LEAD_SOURCE: type: - string - - 'null' + - "null" description: The name or label of the lead source. LEAD_SOURCE_ID: type: integer @@ -2881,17 +2881,17 @@ schemas: DEFAULT_STATUS: type: - boolean - - 'null' + - "null" description: Specifies the default status for leads. FIELD_ORDER: type: - integer - - 'null' + - "null" description: Designates the order of fields for lead status. LEAD_STATUS: type: - string - - 'null' + - "null" description: Represents the name or label of the lead status. LEAD_STATUS_ID: type: integer @@ -2899,7 +2899,7 @@ schemas: STATUS_TYPE: type: - integer - - 'null' + - "null" description: Indicates the type or category of the lead status. additionalProperties: true milestones: @@ -2909,30 +2909,30 @@ schemas: COMPLETED: type: - boolean - - 'null' + - "null" description: Flag indicating if the milestone has been completed or not COMPLETED_DATE_UTC: type: - string - - 'null' + - "null" description: Date and time when the milestone was completed in UTC format: date-time DATE_CREATED_UTC: type: - string - - 'null' + - "null" description: Date and time when the milestone was created in UTC format: date-time DATE_UPDATED_UTC: type: - string - - 'null' + - "null" description: Date and time when the milestone was last updated in UTC format: date-time DUE_DATE: type: - string - - 'null' + - "null" description: Due date for completion of the milestone MILESTONE_ID: type: integer @@ -2940,22 +2940,22 @@ schemas: OWNER_USER_ID: type: - integer - - 'null' + - "null" description: User ID of the owner of the milestone PROJECT_ID: type: - integer - - 'null' + - "null" description: Identifier of the project to which the milestone belongs RESPONSIBLE_USER: type: - integer - - 'null' + - "null" description: User responsible for completing the milestone TITLE: type: - string - - 'null' + - "null" description: Title or name of the milestone additionalProperties: true notes: @@ -2965,18 +2965,18 @@ schemas: BODY: type: - string - - 'null' + - "null" description: The content or text of the note. DATE_CREATED_UTC: type: - string - - 'null' + - "null" description: The date and time the note was created in UTC timezone. format: date-time DATE_UPDATED_UTC: type: - string - - 'null' + - "null" description: The date and time the note was last updated in UTC timezone. format: date-time LINKS: @@ -2988,47 +2988,47 @@ schemas: DETAILS: type: - string - - 'null' + - "null" description: Additional details or description for the link. IS_FORWARD: type: - boolean - - 'null' + - "null" description: Indicates if the link is forward or backward. LINK_ID: type: - integer - - 'null' + - "null" description: The ID of the link. LINK_OBJECT_ID: type: - integer - - 'null' + - "null" description: The ID of the object the link is associated with. LINK_OBJECT_NAME: type: - string - - 'null' + - "null" description: The name of the object the link is associated with. OBJECT_ID: type: - integer - - 'null' + - "null" description: The ID of the linked object. OBJECT_NAME: type: - string - - 'null' + - "null" description: The name of the linked object. RELATIONSHIP_ID: type: - integer - - 'null' + - "null" description: The ID of the relationship between the objects. ROLE: type: - string - - 'null' + - "null" description: The role or type of relationship between the objects. NOTE_ID: type: integer @@ -3036,12 +3036,12 @@ schemas: OWNER_USER_ID: type: - integer - - 'null' + - "null" description: The ID of the user who owns the note. TITLE: type: - string - - 'null' + - "null" description: The title or subject of the note. additionalProperties: true opportunities: @@ -3052,38 +3052,38 @@ schemas: ACTUAL_CLOSE_DATE: type: - string - - 'null' + - "null" description: The actual date when the opportunity was closed format: date-time BID_AMOUNT: type: - number - - 'null' + - "null" description: The amount bid for the opportunity BID_CURRENCY: type: - string - - 'null' + - "null" description: The currency used for the bid amount BID_DURATION: type: - integer - - 'null' + - "null" description: The duration for which the bid is valid BID_TYPE: type: - string - - 'null' + - "null" description: The type of bid placed CATEGORY_ID: type: - integer - - 'null' + - "null" description: The category ID associated with the opportunity CREATED_USER_ID: type: - integer - - 'null' + - "null" description: The ID of the user who created the opportunity CUSTOMFIELDS: type: array @@ -3094,7 +3094,7 @@ schemas: FIELD_NAME: type: - string - - 'null' + - "null" description: Name of the custom field FIELD_VALUE: type: object @@ -3102,30 +3102,30 @@ schemas: DATE_CREATED_UTC: type: - string - - 'null' + - "null" description: The date and time when the opportunity was created (in UTC) format: date-time DATE_UPDATED_UTC: type: - string - - 'null' + - "null" description: The date and time when the opportunity was last updated (in UTC) format: date-time FORECAST_CLOSE_DATE: type: - string - - 'null' + - "null" description: The forecasted date for closing the opportunity format: date-time IMAGE_URL: type: - string - - 'null' + - "null" description: URL of any image associated with the opportunity LAST_ACTIVITY_DATE_UTC: type: - string - - 'null' + - "null" description: >- The date and time of the last activity related to the opportunity (in UTC) @@ -3139,58 +3139,58 @@ schemas: DETAILS: type: - string - - 'null' + - "null" description: Details of the link IS_FORWARD: type: - boolean - - 'null' + - "null" description: Indicates if the link is being forwarded LINK_ID: type: - integer - - 'null' + - "null" description: ID of the linked object LINK_OBJECT_ID: type: - integer - - 'null' + - "null" description: ID of the linked object LINK_OBJECT_NAME: type: - string - - 'null' + - "null" description: Name of the linked object OBJECT_ID: type: - integer - - 'null' + - "null" description: ID of the linked object OBJECT_NAME: type: - string - - 'null' + - "null" description: Name of the linked object RELATIONSHIP_ID: type: - integer - - 'null' + - "null" description: ID of the relationship ROLE: type: - string - - 'null' + - "null" description: Role of the link NEXT_ACTIVITY_DATE_UTC: type: - string - - 'null' + - "null" description: The date and time of the next planned activity (in UTC) format: date-time OPPORTUNITY_DETAILS: type: - string - - 'null' + - "null" description: Detailed information about the opportunity OPPORTUNITY_ID: type: integer @@ -3198,52 +3198,52 @@ schemas: OPPORTUNITY_NAME: type: - string - - 'null' + - "null" description: The name of the opportunity OPPORTUNITY_STATE: type: - string - - 'null' + - "null" description: The state of the opportunity OPPORTUNITY_VALUE: type: - number - - 'null' + - "null" description: The value associated with the opportunity ORGANISATION_ID: type: - integer - - 'null' + - "null" description: The ID of the organization associated with the opportunity OWNER_USER_ID: type: - integer - - 'null' + - "null" description: The ID of the user who owns the opportunity PIPELINE_ID: type: - integer - - 'null' + - "null" description: The ID of the pipeline the opportunity belongs to PRICEBOOK_ID: type: - integer - - 'null' + - "null" description: The ID of the price book associated with the opportunity PROBABILITY: type: - integer - - 'null' + - "null" description: The probability of the opportunity being successful RESPONSIBLE_USER_ID: type: - integer - - 'null' + - "null" description: The ID of the user responsible for the opportunity STAGE_ID: type: - integer - - 'null' + - "null" description: The ID of the stage the opportunity is in TAGS: type: array @@ -3254,19 +3254,19 @@ schemas: TAG_NAME: type: - string - - 'null' + - "null" description: Name of the tag associated with the opportunity required: - TAG_NAME VISIBLE_TEAM_ID: type: - integer - - 'null' + - "null" description: The ID of the team with visibility rights to the opportunity VISIBLE_TO: type: - string - - 'null' + - "null" description: The visibility settings for the opportunity opportunity_categories: type: object @@ -3275,12 +3275,12 @@ schemas: ACTIVE: type: - boolean - - 'null' + - "null" description: Indicates whether the opportunity category is active or inactive BACKGROUND_COLOR: type: - string - - 'null' + - "null" description: The background color associated with the opportunity category CATEGORY_ID: type: integer @@ -3288,7 +3288,7 @@ schemas: CATEGORY_NAME: type: - string - - 'null' + - "null" description: The name or label of the opportunity category additionalProperties: true opportunity_state_reasons: @@ -3298,12 +3298,12 @@ schemas: FOR_OPPORTUNITY_STATE: type: - string - - 'null' + - "null" description: The particular opportunity state that the reason applies to. STATE_REASON: type: - string - - 'null' + - "null" description: The reason associated with the opportunity state. STATE_REASON_ID: type: integer @@ -3317,62 +3317,62 @@ schemas: ADDRESS_BILLING_CITY: type: - string - - 'null' + - "null" description: The city of the billing address of the organisation. ADDRESS_BILLING_COUNTRY: type: - string - - 'null' + - "null" description: The country of the billing address of the organisation. ADDRESS_BILLING_POSTCODE: type: - string - - 'null' + - "null" description: The postal code of the billing address of the organisation. ADDRESS_BILLING_STATE: type: - string - - 'null' + - "null" description: The state of the billing address of the organisation. ADDRESS_BILLING_STREET: type: - string - - 'null' + - "null" description: The street address of the billing address of the organisation. ADDRESS_SHIP_CITY: type: - string - - 'null' + - "null" description: The city of the shipping address of the organisation. ADDRESS_SHIP_COUNTRY: type: - string - - 'null' + - "null" description: The country of the shipping address of the organisation. ADDRESS_SHIP_POSTCODE: type: - string - - 'null' + - "null" description: The postal code of the shipping address of the organisation. ADDRESS_SHIP_STATE: type: - string - - 'null' + - "null" description: The state of the shipping address of the organisation. ADDRESS_SHIP_STREET: type: - string - - 'null' + - "null" description: The street address of the shipping address of the organisation. BACKGROUND: type: - string - - 'null' + - "null" description: Background information or description about the organisation. CREATED_USER_ID: type: - integer - - 'null' + - "null" description: The user ID of the user who created the organisation record. CUSTOMFIELDS: type: array @@ -3383,7 +3383,7 @@ schemas: FIELD_NAME: type: - string - - 'null' + - "null" description: The name of the custom field. FIELD_VALUE: type: object @@ -3397,32 +3397,32 @@ schemas: CREATE_TASK_YEARLY: type: - boolean - - 'null' + - "null" description: Flag indicating if a task is created yearly. DATE_ID: type: - integer - - 'null' + - "null" description: The ID of the date record. OCCASION_DATE: type: - string - - 'null' + - "null" description: The date of a particular occasion. OCCASION_NAME: type: - string - - 'null' + - "null" description: Name of the occasion associated with the date. REPEAT_YEARLY: type: - boolean - - 'null' + - "null" description: Flag indicating if the occasion repeats yearly. DATE_CREATED_UTC: type: - string - - 'null' + - "null" description: >- The date and time when the organisation record was created in Coordinated Universal Time (UTC). @@ -3430,7 +3430,7 @@ schemas: DATE_UPDATED_UTC: type: - string - - 'null' + - "null" description: >- The date and time when the organisation record was last updated in Coordinated Universal Time (UTC). @@ -3444,22 +3444,22 @@ schemas: EMAIL_DOMAIN: type: - string - - 'null' + - "null" description: The domain of an email address associated with the organisation. EMAIL_DOMAIN_ID: type: - integer - - 'null' + - "null" description: The ID of the email domain. IMAGE_URL: type: - string - - 'null' + - "null" description: URL of the image associated with the organisation. LAST_ACTIVITY_DATE_UTC: type: - string - - 'null' + - "null" description: >- The date and time of the last activity related to the organisation in Coordinated Universal Time (UTC). @@ -3473,54 +3473,54 @@ schemas: DETAILS: type: - string - - 'null' + - "null" description: Details of the link. IS_FORWARD: type: - boolean - - 'null' + - "null" description: Flag indicating if the link is in a forward direction. LINK_ID: type: - integer - - 'null' + - "null" description: The ID of the link. LINK_OBJECT_ID: type: - integer - - 'null' + - "null" description: The ID of the object linked to. LINK_OBJECT_NAME: type: - string - - 'null' + - "null" description: Name of the object linked to. OBJECT_ID: type: - integer - - 'null' + - "null" description: >- The ID of the organisation or entity the link is associated with. OBJECT_NAME: type: - string - - 'null' + - "null" description: Name of the organisation or entity the link is associated with. RELATIONSHIP_ID: type: - integer - - 'null' + - "null" description: The ID of the relationship between the linked objects. ROLE: type: - string - - 'null' + - "null" description: Role of the organisation in the linked relationship. NEXT_ACTIVITY_DATE_UTC: type: - string - - 'null' + - "null" description: >- The date and time of the next planned activity related to the organisation in Coordinated Universal Time (UTC). @@ -3531,37 +3531,37 @@ schemas: ORGANISATION_NAME: type: - string - - 'null' + - "null" description: The name of the organisation. OWNER_USER_ID: type: - integer - - 'null' + - "null" description: The user ID of the owner of the organisation. PHONE: type: - string - - 'null' + - "null" description: The phone number associated with the organisation. PHONE_FAX: type: - string - - 'null' + - "null" description: The fax number associated with the organisation. SOCIAL_FACEBOOK: type: - string - - 'null' + - "null" description: Facebook page URL associated with the organisation. SOCIAL_LINKEDIN: type: - string - - 'null' + - "null" description: LinkedIn profile URL associated with the organisation. SOCIAL_TWITTER: type: - string - - 'null' + - "null" description: Twitter handle associated with the organisation. TAGS: type: array @@ -3572,22 +3572,22 @@ schemas: TAG_NAME: type: - string - - 'null' + - "null" description: The name of the tag. VISIBLE_TEAM_ID: type: - integer - - 'null' + - "null" description: The team ID that has visibility permission for the organisation. VISIBLE_TO: type: - string - - 'null' + - "null" description: Visibility level of the organisation. WEBSITE: type: - string - - 'null' + - "null" description: Website URL of the organisation. pipelines: type: object @@ -3596,17 +3596,17 @@ schemas: FOR_OPPORTUNITIES: type: - boolean - - 'null' + - "null" description: Flag indicating if the pipeline is for opportunities FOR_PROJECTS: type: - boolean - - 'null' + - "null" description: Flag indicating if the pipeline is for projects OWNER_USER_ID: type: - integer - - 'null' + - "null" description: Unique identifier of the user who owns the pipeline PIPELINE_ID: type: integer @@ -3614,7 +3614,7 @@ schemas: PIPELINE_NAME: type: - string - - 'null' + - "null" description: Name of the pipeline additionalProperties: true pipeline_stages: @@ -3624,21 +3624,21 @@ schemas: ACTIVITYSET_ID: type: - integer - - 'null' + - "null" description: >- Unique identifier for the activity set associated with the pipeline stage OWNER_USER_ID: type: - integer - - 'null' + - "null" description: >- Unique identifier for the user who owns or is responsible for the pipeline stage PIPELINE_ID: type: - integer - - 'null' + - "null" description: Unique identifier for the pipeline to which the stage belongs STAGE_ID: type: integer @@ -3646,12 +3646,12 @@ schemas: STAGE_NAME: type: - string - - 'null' + - "null" description: Name or label for the pipeline stage STAGE_ORDER: type: - integer - - 'null' + - "null" description: >- Numerical order value indicating the position of the pipeline stage in the pipeline flow @@ -3663,12 +3663,12 @@ schemas: ACTIVE: type: - boolean - - 'null' + - "null" description: Indicates if the project category is currently active or not BACKGROUND_COLOR: type: - string - - 'null' + - "null" description: The background color associated with the project category CATEGORY_ID: type: integer @@ -3676,7 +3676,7 @@ schemas: CATEGORY_NAME: type: - string - - 'null' + - "null" description: The name or title of the project category additionalProperties: true projects: @@ -3687,18 +3687,18 @@ schemas: CATEGORY_ID: type: - integer - - 'null' + - "null" description: Unique identifier for the project category. COMPLETED_DATE: type: - string - - 'null' + - "null" description: Date and time when the project was completed. format: date-time CREATED_USER_ID: type: - integer - - 'null' + - "null" description: Unique identifier of the user who created the project. CUSTOMFIELDS: type: array @@ -3709,7 +3709,7 @@ schemas: FIELD_NAME: type: - string - - 'null' + - "null" description: Name of the custom field. FIELD_VALUE: type: object @@ -3717,24 +3717,24 @@ schemas: DATE_CREATED_UTC: type: - string - - 'null' + - "null" description: Date and time when the project was created (in UTC). format: date-time DATE_UPDATED_UTC: type: - string - - 'null' + - "null" description: Date and time when the project was last updated (in UTC). format: date-time IMAGE_URL: type: - string - - 'null' + - "null" description: URL of the image associated with the project. LAST_ACTIVITY_DATE_UTC: type: - string - - 'null' + - "null" description: Date and time of the last activity related to the project (in UTC). LINKS: type: array @@ -3745,72 +3745,72 @@ schemas: DETAILS: type: - string - - 'null' + - "null" description: Details of the link. IS_FORWARD: type: - boolean - - 'null' + - "null" description: Flag indicating if the link is forward. LINK_ID: type: - integer - - 'null' + - "null" description: Unique identifier for the link. LINK_OBJECT_ID: type: - integer - - 'null' + - "null" description: Unique identifier of the linked object. LINK_OBJECT_NAME: type: - string - - 'null' + - "null" description: Name of the linked object. OBJECT_ID: type: - integer - - 'null' + - "null" description: Unique identifier of the object. OBJECT_NAME: type: - string - - 'null' + - "null" description: Name of the object. RELATIONSHIP_ID: type: - integer - - 'null' + - "null" description: Unique identifier for the relationship. ROLE: type: - string - - 'null' + - "null" description: Role associated with the link. NEXT_ACTIVITY_DATE_UTC: type: - string - - 'null' + - "null" description: Date and time of the next activity related to the project (in UTC). OPPORTUNITY_ID: type: - integer - - 'null' + - "null" description: Unique identifier of the opportunity associated with the project. OWNER_USER_ID: type: - integer - - 'null' + - "null" description: Unique identifier of the user who owns the project. PIPELINE_ID: type: - integer - - 'null' + - "null" description: Unique identifier of the pipeline to which the project belongs. PROJECT_DETAILS: type: - string - - 'null' + - "null" description: Details or description of the project. PROJECT_ID: type: integer @@ -3818,28 +3818,28 @@ schemas: PROJECT_NAME: type: - string - - 'null' + - "null" description: Name of the project. RESPONSIBLE_USER_ID: type: - integer - - 'null' + - "null" description: Unique identifier of the user responsible for the project. STAGE_ID: type: - integer - - 'null' + - "null" description: Unique identifier of the stage to which the project belongs. STARTED_DATE: type: - string - - 'null' + - "null" description: Date and time when the project was started. format: date-time STATUS: type: - string - - 'null' + - "null" description: Status of the project. TAGS: type: array @@ -3850,17 +3850,17 @@ schemas: TAG_NAME: type: - string - - 'null' + - "null" description: Name of the tag. VISIBLE_TEAM_ID: type: - integer - - 'null' + - "null" description: Unique identifier of the team that can view the project. VISIBLE_TO: type: - string - - 'null' + - "null" description: Visibility setting for the project. prospects: type: object @@ -3869,37 +3869,37 @@ schemas: ADDRESS_CITY: type: - string - - 'null' + - "null" description: The city where the prospect is located. ADDRESS_COUNTRY: type: - string - - 'null' + - "null" description: The country where the prospect is located. ADDRESS_POSTCODE: type: - string - - 'null' + - "null" description: The postcode of the prospect's address. ADDRESS_STATE: type: - string - - 'null' + - "null" description: The state or region where the prospect is located. ADDRESS_STREET: type: - string - - 'null' + - "null" description: The street address of the prospect. CONTACT_ID: type: - integer - - 'null' + - "null" description: The ID of the contact associated with the prospect. CREATED_USER_ID: type: - integer - - 'null' + - "null" description: The ID of the user who created the prospect. CUSTOMFIELDS: type: array @@ -3910,7 +3910,7 @@ schemas: FIELD_NAME: type: - string - - 'null' + - "null" description: The name of a custom field. FIELD_VALUE: type: object @@ -3918,121 +3918,121 @@ schemas: DATE_CREATED_UTC: type: - string - - 'null' + - "null" description: The date and time when the prospect was created in UTC. format: date-time DATE_UPDATED_UTC: type: - string - - 'null' + - "null" description: The date and time when the prospect was last updated in UTC. format: date-time DESCRIPTION: type: - string - - 'null' + - "null" description: A description or notes related to the prospect. DO_NOT_CALL: type: - boolean - - 'null' + - "null" description: Indicates if the prospect should not be contacted via phone. DO_NOT_EMAIL: type: - boolean - - 'null' + - "null" description: Indicates if the prospect should not be contacted via email. DO_NOT_SYNC: type: - boolean - - 'null' + - "null" description: Indicates if the prospect should not be synchronized. EMAIL_ADDRESS: type: - string - - 'null' + - "null" description: The email address of the prospect. EMPLOYEE_COUNT: type: - integer - - 'null' + - "null" description: The number of employees in the prospect's organization. FAX: type: - string - - 'null' + - "null" description: The fax number of the prospect. FIRST_NAME: type: - string - - 'null' + - "null" description: The first name of the prospect. GRADE: type: - string - - 'null' + - "null" description: The grade of the prospect. GRADE_PROFILE_ID: type: - integer - - 'null' + - "null" description: The ID of the grade profile associated with the prospect. INDUSTRY: type: - string - - 'null' + - "null" description: The industry of the prospect. LAST_ACTIVITY_DATE_UTC: type: - string - - 'null' + - "null" description: The date and time of the prospect's last activity in UTC. format: date-time LAST_NAME: type: - string - - 'null' + - "null" description: The last name of the prospect. LEAD_CONVERSION_DATE_UTC: type: - string - - 'null' + - "null" description: The date and time when the prospect was converted to a lead in UTC. format: date-time LEAD_ID: type: - integer - - 'null' + - "null" description: The ID of the lead associated with the prospect. MOBILE: type: - string - - 'null' + - "null" description: The mobile number of the prospect. OPTED_OUT: type: - boolean - - 'null' + - "null" description: Indicates if the prospect has opted out of communications. ORGANISATION_ID: type: - integer - - 'null' + - "null" description: The ID of the organization associated with the prospect. ORGANISATION_NAME: type: - string - - 'null' + - "null" description: The name of the organization associated with the prospect. OWNER_USER_ID: type: - integer - - 'null' + - "null" description: The ID of the user who owns or is responsible for the prospect. PHONE: type: - string - - 'null' + - "null" description: The phone number of the prospect. PROSPECT_ID: type: integer @@ -4040,12 +4040,12 @@ schemas: SALUTATION: type: - string - - 'null' + - "null" description: The salutation or title used when addressing the prospect. SCORE: type: - integer - - 'null' + - "null" description: The score assigned to the prospect. TAGS: type: array @@ -4056,17 +4056,17 @@ schemas: TAG_NAME: type: - string - - 'null' + - "null" description: The name of a tag associated with the prospect. TITLE: type: - string - - 'null' + - "null" description: The job title of the prospect. WEBSITE: type: - string - - 'null' + - "null" description: The website URL of the prospect's organization. additionalProperties: true relationships: @@ -4076,22 +4076,22 @@ schemas: FORWARD: type: - string - - 'null' + - "null" description: The ID of the object on one side of the relationship. FORWARD_TITLE: type: - string - - 'null' + - "null" description: The name or title of the object on one side of the relationship. FOR_CONTACTS: type: - boolean - - 'null' + - "null" description: List of contacts associated with this relationship. FOR_ORGANISATIONS: type: - boolean - - 'null' + - "null" description: List of organizations associated with this relationship. RELATIONSHIP_ID: type: integer @@ -4099,12 +4099,12 @@ schemas: REVERSE: type: - string - - 'null' + - "null" description: The ID of the object on the other side of the relationship. REVERSE_TITLE: type: - string - - 'null' + - "null" description: The name or title of the object on the other side of the relationship. additionalProperties: true task_categories: @@ -4114,12 +4114,12 @@ schemas: ACTIVE: type: - boolean - - 'null' + - "null" description: Flag indicating if the task category is currently active or not. BACKGROUND_COLOR: type: - string - - 'null' + - "null" description: >- The background color associated with the task category for visual representation. @@ -4129,7 +4129,7 @@ schemas: CATEGORY_NAME: type: - string - - 'null' + - "null" description: The name or label assigned to the task category. additionalProperties: true tasks: @@ -4140,39 +4140,39 @@ schemas: ASSIGNED_BY_USER_ID: type: - integer - - 'null' + - "null" description: The user ID of the individual who assigned the task. ASSIGNED_DATE_UTC: type: - string - - 'null' + - "null" description: The date and time when the task was assigned. format: date-time ASSIGNED_TEAM_ID: type: - integer - - 'null' + - "null" description: The team ID to which the task is assigned. CATEGORY_ID: type: - integer - - 'null' + - "null" description: The category ID associated with the task. COMPLETED: type: - boolean - - 'null' + - "null" description: Indicates if the task has been completed or not. COMPLETED_DATE_UTC: type: - string - - 'null' + - "null" description: The date and time when the task was completed. format: date-time CREATED_USER_ID: type: - integer - - 'null' + - "null" description: The user ID of the user who created the task. CUSTOMFIELDS: type: array @@ -4183,7 +4183,7 @@ schemas: FIELD_NAME: type: - string - - 'null' + - "null" description: The name of the custom field. FIELD_VALUE: type: object @@ -4191,30 +4191,30 @@ schemas: DATE_CREATED_UTC: type: - string - - 'null' + - "null" description: The date and time when the task was created. format: date-time DATE_UPDATED_UTC: type: - string - - 'null' + - "null" description: The date and time when the task was last updated. format: date-time DETAILS: type: - string - - 'null' + - "null" description: Additional details or description of the task. DUE_DATE: type: - string - - 'null' + - "null" description: The deadline or due date for the task. format: date-time EMAIL_ID: type: - integer - - 'null' + - "null" description: The email ID associated with the task. LINKS: type: array @@ -4225,129 +4225,129 @@ schemas: DETAILS: type: - string - - 'null' + - "null" description: Details or description of the link. IS_FORWARD: type: - boolean - - 'null' + - "null" description: Indicates if the link is forward or not. LINK_ID: type: - integer - - 'null' + - "null" description: The ID of the link. LINK_OBJECT_ID: type: - integer - - 'null' + - "null" description: The object ID associated with the link. LINK_OBJECT_NAME: type: - string - - 'null' + - "null" description: The name of the object associated with the link. OBJECT_ID: type: - integer - - 'null' + - "null" description: The ID of the object linked to the task. OBJECT_NAME: type: - string - - 'null' + - "null" description: The name of the object linked to the task. RELATIONSHIP_ID: type: - integer - - 'null' + - "null" description: The relationship ID associated with the link. ROLE: type: - string - - 'null' + - "null" description: The role associated with the link. MILESTONE_ID: type: - integer - - 'null' + - "null" description: The milestone ID associated with the task. OPPORTUNITY_ID: type: - integer - - 'null' + - "null" description: The opportunity ID associated with the task. OWNER_USER_ID: type: - integer - - 'null' + - "null" description: The user ID of the owner of the task. OWNER_VISIBLE: type: - boolean - - 'null' + - "null" description: Indicates if the owner is visible or not. PARENT_TASK_ID: type: - integer - - 'null' + - "null" description: The ID of the parent task if this task is a subtask. PERCENT_COMPLETE: type: - integer - - 'null' + - "null" description: The completion percentage of the task. PRIORITY: type: - integer - - 'null' + - "null" description: The priority level of the task. PROJECT_ID: type: - integer - - 'null' + - "null" description: The project ID associated with the task. PUBLICLY_VISIBLE: type: - - 'null' + - "null" - boolean description: Indicates if the task is publicly visible. RECURRENCE: type: - string - - 'null' + - "null" description: Details of any recurring pattern for the task. REMINDER_DATE_UTC: type: - string - - 'null' + - "null" description: The date and time for the reminder of the task. format: date-time REMINDER_SENT: type: - boolean - - 'null' + - "null" description: Indicates if a reminder has been sent for the task. RESPONSIBLE_USER_ID: type: - integer - - 'null' + - "null" description: The user ID of the individual responsible for the task. STAGE_ID: type: - integer - - 'null' + - "null" description: The stage ID of the task. START_DATE: type: - string - - 'null' + - "null" description: The start date of the task. format: date-time STATUS: type: - string - - 'null' + - "null" description: The current status of the task. TASK_ID: type: integer @@ -4355,7 +4355,7 @@ schemas: TITLE: type: - string - - 'null' + - "null" description: The title or name of the task. team_members: type: object @@ -4367,12 +4367,12 @@ schemas: PERMISSION_ID: type: - integer - - 'null' + - "null" description: The permission level associated with the team member TEAM_ID: type: - integer - - 'null' + - "null" description: The identifier for the team to which the member belongs additionalProperties: true teams: @@ -4383,18 +4383,18 @@ schemas: ANONYMOUS_TEAM: type: - boolean - - 'null' + - "null" description: Indicates if the team is anonymous or not. DATE_CREATED_UTC: type: - string - - 'null' + - "null" description: The date and time when the team was created. format: date-time DATE_UPDATED_UTC: type: - string - - 'null' + - "null" description: The date and time when the team was last updated. format: date-time TEAMMEMBERS: @@ -4406,7 +4406,7 @@ schemas: TEAM_NAME: type: - string - - 'null' + - "null" description: The name of the team. users: type: object @@ -4415,99 +4415,99 @@ schemas: ACCOUNT_OWNER: type: - boolean - - 'null' + - "null" description: Indicates if the user is the owner of the account ACTIVE: type: - boolean - - 'null' + - "null" description: Indicates if the user is currently active ADMINISTRATOR: type: - boolean - - 'null' + - "null" description: Indicates if the user has administrator privileges CONTACT_DISPLAY: type: - string - - 'null' + - "null" description: The display name of the user CONTACT_ID: type: - integer - - 'null' + - "null" description: The unique identifier for the user contact CONTACT_ORDER: type: - string - - 'null' + - "null" description: The order of the contact DATE_CREATED_UTC: type: - string - - 'null' + - "null" description: The date and time when the user was created in UTC timezone format: date-time DATE_UPDATED_UTC: type: - string - - 'null' + - "null" description: The date and time when the user was last updated in UTC timezone format: date-time EMAIL_ADDRESS: type: - string - - 'null' + - "null" description: The email address of the user EMAIL_DROPBOX_ADDRESS: type: - string - - 'null' + - "null" description: The Dropbox email address associated with the user EMAIL_DROPBOX_IDENTIFIER: type: - string - - 'null' + - "null" description: The Dropbox identifier of the user FIRST_NAME: type: - string - - 'null' + - "null" description: The first name of the user INSTANCE_ID: type: - integer - - 'null' + - "null" description: The unique identifier of the instance LAST_NAME: type: - string - - 'null' + - "null" description: The last name of the user PROFILE_ID: type: - integer - - 'null' + - "null" description: The profile identifier of the user ROLE_ID: type: - integer - - 'null' + - "null" description: The role identifier of the user TASK_WEEK_START: type: - integer - - 'null' + - "null" description: The start day of the week for tasks TIMEZONE_ID: type: - string - - 'null' + - "null" description: The timezone identifier of the user USER_CURRENCY: type: - string - - 'null' + - "null" description: The currency used by the user USER_ID: type: integer From c9cb6f412765f790aeb94705858bd6d8f66d74be Mon Sep 17 00:00:00 2001 From: btkcodedev Date: Sat, 11 May 2024 23:03:53 +0530 Subject: [PATCH 3/5] update docs --- docs/integrations/sources/insightly.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/sources/insightly.md b/docs/integrations/sources/insightly.md index b0fd2974f8c4..0785ade2d0d2 100644 --- a/docs/integrations/sources/insightly.md +++ b/docs/integrations/sources/insightly.md @@ -69,7 +69,7 @@ The connector is restricted by Insightly [requests limitation](https://api.na1.i | Version | Date | Pull Request | Subject | | :------ | :--------- | :------------------------------------------------------- | :------------------------------------------------------------------------------ | -| 0.2.5 | 2024-05-30 | [00000](https://github.com/airbytehq/airbyte/pull/00000) | Make compatable with builder | +| 0.2.5 | 2024-05-30 | [38140](https://github.com/airbytehq/airbyte/pull/38140) | Make compatable with builder | | 0.2.4 | 2024-04-19 | [37177](https://github.com/airbytehq/airbyte/pull/37177) | Updating to 0.80.0 CDK | | 0.2.3 | 2024-04-18 | [37177](https://github.com/airbytehq/airbyte/pull/37177) | Manage dependencies with Poetry. | | 0.2.2 | 2024-04-15 | [37177](https://github.com/airbytehq/airbyte/pull/37177) | Base image migration: remove Dockerfile and use the python-connector-base image | From 5edbe4c9bb0937267e5b9fb695b24d48dfd94f27 Mon Sep 17 00:00:00 2001 From: btkcodedev Date: Sat, 11 May 2024 23:05:06 +0530 Subject: [PATCH 4/5] delete schemas --- .../source_insightly/schemas/leads.json | 230 ------------------ .../schemas/opportunity_products.json | 81 ------ .../schemas/pricebook_entries.json | 65 ----- .../source_insightly/schemas/pricebooks.json | 48 ---- .../source_insightly/schemas/products.json | 81 ------ .../schemas/quote_products.json | 85 ------- .../source_insightly/schemas/quotes.json | 178 -------------- .../source_insightly/schemas/tags.json | 10 - .../source_insightly/schemas/tickets.json | 110 --------- 9 files changed, 888 deletions(-) delete mode 100644 airbyte-integrations/connectors/source-insightly/source_insightly/schemas/leads.json delete mode 100644 airbyte-integrations/connectors/source-insightly/source_insightly/schemas/opportunity_products.json delete mode 100644 airbyte-integrations/connectors/source-insightly/source_insightly/schemas/pricebook_entries.json delete mode 100644 airbyte-integrations/connectors/source-insightly/source_insightly/schemas/pricebooks.json delete mode 100644 airbyte-integrations/connectors/source-insightly/source_insightly/schemas/products.json delete mode 100644 airbyte-integrations/connectors/source-insightly/source_insightly/schemas/quote_products.json delete mode 100644 airbyte-integrations/connectors/source-insightly/source_insightly/schemas/quotes.json delete mode 100644 airbyte-integrations/connectors/source-insightly/source_insightly/schemas/tags.json delete mode 100644 airbyte-integrations/connectors/source-insightly/source_insightly/schemas/tickets.json diff --git a/airbyte-integrations/connectors/source-insightly/source_insightly/schemas/leads.json b/airbyte-integrations/connectors/source-insightly/source_insightly/schemas/leads.json deleted file mode 100644 index c967311f064d..000000000000 --- a/airbyte-integrations/connectors/source-insightly/source_insightly/schemas/leads.json +++ /dev/null @@ -1,230 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-04/schema#", - "type": "object", - "properties": { - "LEAD_ID": { - "description": "The unique ID of the lead", - "type": "integer" - }, - "SALUTATION": { - "description": "The salutation or title of the lead", - "type": ["string", "null"] - }, - "FIRST_NAME": { - "description": "The first name of the lead", - "type": ["string", "null"] - }, - "LAST_NAME": { - "description": "The last name of the lead", - "type": ["string", "null"] - }, - "LEAD_SOURCE_ID": { - "description": "The ID of the lead source", - "type": ["integer", "null"] - }, - "LEAD_STATUS_ID": { - "description": "The ID of the lead status", - "type": ["integer", "null"] - }, - "TITLE": { - "description": "The title of the lead", - "type": ["string", "null"] - }, - "CONVERTED": { - "description": "Indicates if the lead has been converted", - "type": ["boolean", "null"] - }, - "CONVERTED_CONTACT_ID": { - "description": "The ID of the contact associated with the converted lead", - "type": ["integer", "null"] - }, - "CONVERTED_DATE_UTC": { - "description": "The date and time of lead conversion in UTC", - "type": ["string", "null"], - "format": "date-time" - }, - "CONVERTED_OPPORTUNITY_ID": { - "description": "The ID of the opportunity associated with the converted lead", - "type": ["integer", "null"] - }, - "CONVERTED_ORGANISATION_ID": { - "description": "The ID of the organization associated with the converted lead", - "type": ["integer", "null"] - }, - "DATE_CREATED_UTC": { - "description": "The date and time when the lead was created in UTC", - "type": ["string", "null"], - "format": "date-time" - }, - "DATE_UPDATED_UTC": { - "description": "The date and time when the lead was last updated in UTC", - "type": ["string", "null"], - "format": "date-time" - }, - "EMAIL": { - "description": "The email address of the lead", - "type": ["string", "null"] - }, - "EMPLOYEE_COUNT": { - "description": "The number of employees in the lead's organization", - "type": ["integer", "null"] - }, - "FAX": { - "description": "The fax number of the lead", - "type": ["string", "null"] - }, - "INDUSTRY": { - "description": "The industry of the lead's organization", - "type": ["string", "null"] - }, - "LEAD_DESCRIPTION": { - "description": "A description of the lead", - "type": ["string", "null"] - }, - "LEAD_RATING": { - "description": "The rating assigned to the lead", - "type": ["integer", "null"] - }, - "MOBILE": { - "description": "The mobile number of the lead", - "type": ["string", "null"] - }, - "OWNER_USER_ID": { - "description": "The ID of the user who owns the lead", - "type": ["integer", "null"] - }, - "PHONE": { - "description": "The phone number of the lead", - "type": ["string", "null"] - }, - "RESPONSIBLE_USER_ID": { - "description": "The ID of the user responsible for the lead", - "type": ["integer", "null"] - }, - "WEBSITE": { - "description": "The website URL of the lead's organization", - "type": ["string", "null"] - }, - "ADDRESS_STREET": { - "description": "The street address of the lead", - "type": ["string", "null"] - }, - "ADDRESS_CITY": { - "description": "The city of the lead's address", - "type": ["string", "null"] - }, - "ADDRESS_STATE": { - "description": "The state of the lead's address", - "type": ["string", "null"] - }, - "ADDRESS_POSTCODE": { - "description": "The postal code of the lead's address", - "type": ["string", "null"] - }, - "ADDRESS_COUNTRY": { - "description": "The country of the lead's address", - "type": ["string", "null"] - }, - "LAST_ACTIVITY_DATE_UTC": { - "description": "The date and time of the lead's last activity in UTC", - "type": ["string", "null"], - "format": "date-time" - }, - "NEXT_ACTIVITY_DATE_UTC": { - "description": "The date and time of the lead's next activity in UTC", - "type": ["string", "null"], - "format": "date-time" - }, - "ORGANISATION_NAME": { - "description": "The name of the lead's organization", - "type": ["string", "null"] - }, - "CREATED_USER_ID": { - "description": "The ID of the user who created the lead", - "type": ["integer", "null"] - }, - "IMAGE_URL": { - "description": "The URL of the lead's image", - "type": ["string", "null"] - }, - "EMAIL_OPTED_OUT": { - "description": "Indicates if the lead has opted out of email communications", - "type": ["boolean", "null"] - }, - "CUSTOMFIELDS": { - "description": "Custom fields associated with the lead", - "type": "array", - "items": { - "type": "object", - "properties": { - "FIELD_NAME": { - "description": "The name of the custom field", - "type": ["string", "null"] - }, - "FIELD_VALUE": { - "description": "The value of the custom field", - "type": "object" - } - } - } - }, - "TAGS": { - "description": "Tags associated with the lead", - "type": "array", - "items": { - "type": "object", - "properties": { - "TAG_NAME": { - "description": "The name of the tag", - "type": ["string", "null"] - } - } - } - }, - "LINKS": { - "description": "Links associated with the lead", - "type": "array", - "items": { - "type": "object", - "properties": { - "LINK_ID": { - "description": "The ID of the link", - "type": ["integer", "null"] - }, - "OBJECT_NAME": { - "description": "The name of the linked object", - "type": ["string", "null"] - }, - "OBJECT_ID": { - "description": "The ID of the linked object", - "type": ["integer", "null"] - }, - "LINK_OBJECT_NAME": { - "description": "The name of the object linked to", - "type": ["string", "null"] - }, - "LINK_OBJECT_ID": { - "description": "The ID of the object linked to", - "type": ["integer", "null"] - }, - "ROLE": { - "description": "The role of the link", - "type": ["string", "null"] - }, - "DETAILS": { - "description": "Additional details of the link", - "type": ["string", "null"] - }, - "RELATIONSHIP_ID": { - "description": "The ID of the relationship", - "type": ["integer", "null"] - }, - "IS_FORWARD": { - "description": "Indicates if the link is forward", - "type": ["boolean", "null"] - } - } - } - } - } -} diff --git a/airbyte-integrations/connectors/source-insightly/source_insightly/schemas/opportunity_products.json b/airbyte-integrations/connectors/source-insightly/source_insightly/schemas/opportunity_products.json deleted file mode 100644 index da4eced3fb37..000000000000 --- a/airbyte-integrations/connectors/source-insightly/source_insightly/schemas/opportunity_products.json +++ /dev/null @@ -1,81 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-04/schema#", - "type": "object", - "properties": { - "OPPORTUNITY_ITEM_ID": { - "description": "ID of the opportunity item", - "type": "integer" - }, - "OPPORTUNITY_ID": { - "description": "ID of the opportunity associated with the product", - "type": ["integer", "null"] - }, - "PRICEBOOK_ENTRY_ID": { - "description": "ID of the price book entry associated with the product", - "type": ["integer", "null"] - }, - "CURRENCY_CODE": { - "description": "The currency code used for the opportunity product", - "type": ["string", "null"] - }, - "UNIT_PRICE": { - "description": "Unit price of the opportunity product", - "type": ["integer", "null"] - }, - "DESCRIPTION": { - "description": "Description of the opportunity product", - "type": ["string", "null"] - }, - "QUANTITY": { - "description": "The quantity of the opportunity product", - "type": ["integer", "null"] - }, - "SERVICE_DATE": { - "description": "The service date of the opportunity product", - "type": ["string", "null"] - }, - "TOTAL_PRICE": { - "description": "Total price of the opportunity product", - "type": ["integer", "null"] - }, - "DATE_CREATED_UTC": { - "description": "The date and time when the opportunity product was created in UTC", - "type": ["string", "null"], - "format": "date-time" - }, - "DATE_UPDATED_UTC": { - "description": "The date and time when the opportunity product was last updated in UTC", - "type": ["string", "null"], - "format": "date-time" - }, - "LIST_PRICE": { - "description": "List price of the opportunity product", - "type": ["integer", "null"] - }, - "SUBTOTAL": { - "description": "Subtotal of the opportunity product", - "type": ["integer", "null"] - }, - "DISCOUNT": { - "description": "Discount applied to the opportunity product", - "type": ["integer", "null"] - }, - "CUSTOMFIELDS": { - "description": "Custom fields associated with the opportunity product", - "type": "array", - "items": { - "type": "object", - "properties": { - "FIELD_NAME": { - "description": "Name of the custom field", - "type": ["string", "null"] - }, - "FIELD_VALUE": { - "description": "Value of the custom field", - "type": "object" - } - } - } - } - } -} diff --git a/airbyte-integrations/connectors/source-insightly/source_insightly/schemas/pricebook_entries.json b/airbyte-integrations/connectors/source-insightly/source_insightly/schemas/pricebook_entries.json deleted file mode 100644 index e8ebcb460577..000000000000 --- a/airbyte-integrations/connectors/source-insightly/source_insightly/schemas/pricebook_entries.json +++ /dev/null @@ -1,65 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-04/schema#", - "type": "object", - "properties": { - "PRICEBOOK_ENTRY_ID": { - "description": "The unique identifier of the pricebook entry.", - "type": "integer" - }, - "PRICEBOOK_ID": { - "description": "The identifier of the pricebook to which the entry belongs.", - "type": ["integer", "null"] - }, - "PRODUCT_ID": { - "description": "The unique identifier of the product associated with the pricebook entry.", - "type": ["integer", "null"] - }, - "CURRENCY_CODE": { - "description": "The currency code used for pricing.", - "type": ["string", "null"] - }, - "PRICE": { - "description": "The price of the product associated with the pricebook entry.", - "type": ["integer", "null"] - }, - "USE_STANDARD_PRICE": { - "description": "Indicates whether the standard price should be used.", - "type": ["boolean", "null"] - }, - "ACTIVE": { - "description": "Indicates if the pricebook entry is active or not.", - "type": ["boolean", "null"] - }, - "CREATED_USER_ID": { - "description": "The ID of the user who created the pricebook entry.", - "type": ["integer", "null"] - }, - "DATE_CREATED_UTC": { - "description": "The date and time when the pricebook entry was created in UTC.", - "type": ["string", "null"], - "format": "date-time" - }, - "DATE_UPDATED_UTC": { - "description": "The date and time when the pricebook entry was last updated in UTC.", - "type": ["string", "null"], - "format": "date-time" - }, - "CUSTOMFIELDS": { - "description": "Custom fields associated with the pricebook entry.", - "type": "array", - "items": { - "type": "object", - "properties": { - "FIELD_NAME": { - "description": "The name of the custom field.", - "type": ["string", "null"] - }, - "FIELD_VALUE": { - "description": "The value of the custom field.", - "type": "object" - } - } - } - } - } -} diff --git a/airbyte-integrations/connectors/source-insightly/source_insightly/schemas/pricebooks.json b/airbyte-integrations/connectors/source-insightly/source_insightly/schemas/pricebooks.json deleted file mode 100644 index 7822a619993b..000000000000 --- a/airbyte-integrations/connectors/source-insightly/source_insightly/schemas/pricebooks.json +++ /dev/null @@ -1,48 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-04/schema#", - "type": "object", - "properties": { - "PRICEBOOK_ID": { - "description": "The unique identifier of the pricebook.", - "type": "integer" - }, - "NAME": { - "description": "The name of the pricebook.", - "type": ["string", "null"] - }, - "DESCRIPTION": { - "description": "A brief description of the pricebook.", - "type": ["string", "null"] - }, - "CURRENCY_CODE": { - "description": "The currency code used for prices in the pricebook.", - "type": ["string", "null"] - }, - "IS_STANDARD": { - "description": "Indicates if the pricebook is a standard pricebook or not.", - "type": ["boolean", "null"] - }, - "ACTIVE": { - "description": "Indicates if the pricebook is currently active or not.", - "type": ["boolean", "null"] - }, - "OWNER_USER_ID": { - "description": "The ID of the user who owns the pricebook.", - "type": ["integer", "null"] - }, - "CREATED_USER_ID": { - "description": "The ID of the user who created the pricebook.", - "type": ["integer", "null"] - }, - "DATE_CREATED_UTC": { - "description": "The date and time when the pricebook was created.", - "type": ["string", "null"], - "format": "date-time" - }, - "DATE_UPDATED_UTC": { - "description": "The date and time when the pricebook was last updated.", - "type": ["string", "null"], - "format": "date-time" - } - } -} diff --git a/airbyte-integrations/connectors/source-insightly/source_insightly/schemas/products.json b/airbyte-integrations/connectors/source-insightly/source_insightly/schemas/products.json deleted file mode 100644 index 587efd761c99..000000000000 --- a/airbyte-integrations/connectors/source-insightly/source_insightly/schemas/products.json +++ /dev/null @@ -1,81 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-04/schema#", - "type": "object", - "properties": { - "PRODUCT_ID": { - "description": "The ID of the product", - "type": "integer" - }, - "PRODUCT_NAME": { - "description": "Name or title of the product", - "type": ["string", "null"] - }, - "PRODUCT_CODE": { - "description": "Unique code assigned to the product", - "type": ["string", "null"] - }, - "PRODUCT_SKU": { - "description": "Stock keeping unit (SKU) of the product", - "type": ["string", "null"] - }, - "DESCRIPTION": { - "description": "A description or brief information about the product", - "type": ["string", "null"] - }, - "PRODUCT_FAMILY": { - "description": "The family or category the product belongs to", - "type": ["string", "null"] - }, - "PRODUCT_IMAGE_URL": { - "description": "URL of the product image", - "type": ["string", "null"] - }, - "CURRENCY_CODE": { - "description": "The currency code used for pricing the product", - "type": ["string", "null"] - }, - "DEFAULT_PRICE": { - "description": "The default price of the product", - "type": ["integer", "null"] - }, - "DATE_CREATED_UTC": { - "description": "The date and time when the product was created in UTC", - "type": ["string", "null"], - "format": "date-time" - }, - "DATE_UPDATED_UTC": { - "description": "The date and time when the product was last updated in UTC", - "type": ["string", "null"], - "format": "date-time" - }, - "CREATED_USER_ID": { - "description": "The ID of the user who created the product", - "type": ["integer", "null"] - }, - "OWNER_USER_ID": { - "description": "The ID of the user who owns the product", - "type": ["integer", "null"] - }, - "ACTIVE": { - "description": "Indicates if the product is currently active or not", - "type": ["boolean", "null"] - }, - "CUSTOMFIELDS": { - "description": "Custom fields associated with the product", - "type": "array", - "items": { - "type": "object", - "properties": { - "FIELD_NAME": { - "description": "The name of the custom field", - "type": ["string", "null"] - }, - "FIELD_VALUE": { - "description": "The value of the custom field", - "type": "object" - } - } - } - } - } -} diff --git a/airbyte-integrations/connectors/source-insightly/source_insightly/schemas/quote_products.json b/airbyte-integrations/connectors/source-insightly/source_insightly/schemas/quote_products.json deleted file mode 100644 index ee6272f8c68e..000000000000 --- a/airbyte-integrations/connectors/source-insightly/source_insightly/schemas/quote_products.json +++ /dev/null @@ -1,85 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-04/schema#", - "type": "object", - "properties": { - "QUOTATION_ITEM_ID": { - "description": "The ID of the quotation item associated with the quote product.", - "type": "integer" - }, - "QUOTE_ID": { - "description": "The ID of the quote associated with the quote product.", - "type": ["integer", "null"] - }, - "OPPORTUNITY_ITEM_ID": { - "description": "The ID of the opportunity item associated with the quote product.", - "type": ["integer", "null"] - }, - "PRICEBOOK_ENTRY_ID": { - "description": "The ID of the pricebook entry associated with the quote product.", - "type": ["integer", "null"] - }, - "DESCRIPTION": { - "description": "A description of the quote product.", - "type": ["string", "null"] - }, - "CURRENCY_CODE": { - "description": "The code representing the currency used for the quote product.", - "type": ["string", "null"] - }, - "QUANTITY": { - "description": "The quantity of the quote product.", - "type": ["integer", "null"] - }, - "LIST_PRICE": { - "description": "The list price of the quote product.", - "type": ["integer", "null"] - }, - "UNIT_PRICE": { - "description": "The unit price of the quote product.", - "type": ["integer", "null"] - }, - "SUBTOTAL": { - "description": "The subtotal of the quote product.", - "type": ["integer", "null"] - }, - "DISCOUNT": { - "description": "The discount applied to the quote product.", - "type": ["integer", "null"] - }, - "TOTAL_PRICE": { - "description": "The total price of the quote product.", - "type": ["integer", "null"] - }, - "DATE_CREATED_UTC": { - "description": "The date and time when the quote product was created in UTC format.", - "type": ["string", "null"], - "format": "date-time" - }, - "DATE_UPDATED_UTC": { - "description": "The date and time when the quote product was last updated in UTC format.", - "type": ["string", "null"], - "format": "date-time" - }, - "SORT_ORDER": { - "description": "The sort order of the quote product.", - "type": ["integer", "null"] - }, - "CUSTOMFIELDS": { - "description": "Custom fields specific to the quote product.", - "type": "array", - "items": { - "type": "object", - "properties": { - "FIELD_NAME": { - "description": "The name of the custom field.", - "type": ["string", "null"] - }, - "FIELD_VALUE": { - "description": "The value of the custom field.", - "type": "object" - } - } - } - } - } -} diff --git a/airbyte-integrations/connectors/source-insightly/source_insightly/schemas/quotes.json b/airbyte-integrations/connectors/source-insightly/source_insightly/schemas/quotes.json deleted file mode 100644 index 2539ee0ed1b0..000000000000 --- a/airbyte-integrations/connectors/source-insightly/source_insightly/schemas/quotes.json +++ /dev/null @@ -1,178 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-04/schema#", - "type": "object", - "properties": { - "QUOTE_ID": { - "description": "The ID of the quote", - "type": "integer" - }, - "QUOTATION_NAME": { - "description": "The name or title of the quote", - "type": ["string", "null"] - }, - "OPPORTUNITY_ID": { - "description": "The ID of the opportunity associated with the quote", - "type": ["integer", "null"] - }, - "CONTACT_ID": { - "description": "The ID of the contact associated with the quote", - "type": ["integer", "null"] - }, - "ORGANISATION_ID": { - "description": "The ID of the organization associated with the quote", - "type": ["integer", "null"] - }, - "PRICEBOOK_ID": { - "description": "The ID of the price book used for pricing in the quote", - "type": ["integer", "null"] - }, - "QUOTATION_NUMBER": { - "description": "The unique number or identifier of the quote", - "type": ["string", "null"] - }, - "QUOTATION_DESCRIPTION": { - "description": "The description or notes associated with the quote", - "type": ["string", "null"] - }, - "QUOTATION_PHONE": { - "description": "The phone number associated with the quote", - "type": ["string", "null"] - }, - "QUOTATION_EMAIL": { - "description": "The email address associated with the quote", - "type": ["string", "null"] - }, - "QUOTATION_FAX": { - "description": "The fax number associated with the quote", - "type": ["string", "null"] - }, - "QUOTE_STATUS": { - "description": "The status of the quote (e.g., drafted, sent, accepted)", - "type": ["string", "null"] - }, - "QUOTATION_EXPIRATION_DATE": { - "description": "The date and time the quote is set to expire", - "type": ["string", "null"], - "format": "date-time" - }, - "LINE_ITEM_COUNT": { - "description": "The number of line items in the quote", - "type": ["integer", "null"] - }, - "IS_SYNCING": { - "description": "Flag indicating if the quote is currently being synced", - "type": ["boolean", "null"] - }, - "QUOTATION_CURRENCY_CODE": { - "description": "The currency code used for the quote", - "type": ["string", "null"] - }, - "SUBTOTAL": { - "description": "The subtotal amount before discounts and taxes", - "type": ["integer", "null"] - }, - "DISCOUNT": { - "description": "The discount applied to the quote", - "type": ["integer", "null"] - }, - "TOTAL_PRICE": { - "description": "The total price of the quote after applying all charges and discounts", - "type": ["integer", "null"] - }, - "SHIPPING_HANDLING": { - "description": "The shipping and handling charges applied to the quote", - "type": ["integer", "null"] - }, - "TAX": { - "description": "The tax amount applied to the quote", - "type": ["integer", "null"] - }, - "GRAND_TOTAL": { - "description": "The total amount of the quote including all charges and discounts", - "type": ["integer", "null"] - }, - "ADDRESS_BILLING_NAME": { - "description": "The name associated with the billing address", - "type": ["string", "null"] - }, - "ADDRESS_BILLING_STREET": { - "description": "The street of the billing address", - "type": ["string", "null"] - }, - "ADDRESS_BILLING_CITY": { - "description": "The city of the billing address", - "type": ["string", "null"] - }, - "ADDRESS_BILLING_STATE": { - "description": "The state of the billing address", - "type": ["string", "null"] - }, - "ADDRESS_BILLING_POSTCODE": { - "description": "The postal code of the billing address", - "type": ["string", "null"] - }, - "ADDRESS_BILLING_COUNTRY": { - "description": "The country of the billing address", - "type": ["string", "null"] - }, - "ADDRESS_SHIPPING_NAME": { - "description": "The name associated with the shipping address", - "type": ["string", "null"] - }, - "ADDRESS_SHIPPING_STREET": { - "description": "The street of the shipping address", - "type": ["string", "null"] - }, - "ADDRESS_SHIPPING_CITY": { - "description": "The city of the shipping address", - "type": ["string", "null"] - }, - "ADDRESS_SHIPPING_STATE": { - "description": "The state of the shipping address", - "type": ["string", "null"] - }, - "ADDRESS_SHIPPING_POSTCODE": { - "description": "The postal code of the shipping address", - "type": ["string", "null"] - }, - "ADDRESS_SHIPPING_COUNTRY": { - "description": "The country of the shipping address", - "type": ["string", "null"] - }, - "OWNER_USER_ID": { - "description": "The ID of the user who owns the quote", - "type": ["integer", "null"] - }, - "DATE_CREATED_UTC": { - "description": "The date and time the quote was created in UTC", - "type": ["string", "null"], - "format": "date-time" - }, - "DATE_UPDATED_UTC": { - "description": "The date and time the quote was last updated in UTC", - "type": ["string", "null"], - "format": "date-time" - }, - "CREATED_USER_ID": { - "description": "The ID of the user who created the quote", - "type": ["integer", "null"] - }, - "CUSTOMFIELDS": { - "description": "Custom fields associated with the quote", - "type": "array", - "items": { - "type": "object", - "properties": { - "FIELD_NAME": { - "description": "The name of the custom field", - "type": ["string", "null"] - }, - "FIELD_VALUE": { - "description": "The value of the custom field", - "type": "object" - } - } - } - } - } -} diff --git a/airbyte-integrations/connectors/source-insightly/source_insightly/schemas/tags.json b/airbyte-integrations/connectors/source-insightly/source_insightly/schemas/tags.json deleted file mode 100644 index fb2dcdb39d74..000000000000 --- a/airbyte-integrations/connectors/source-insightly/source_insightly/schemas/tags.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-04/schema#", - "type": "object", - "properties": { - "TAG_NAME": { - "description": "The name of the tag associated with the record.", - "type": "string" - } - } -} diff --git a/airbyte-integrations/connectors/source-insightly/source_insightly/schemas/tickets.json b/airbyte-integrations/connectors/source-insightly/source_insightly/schemas/tickets.json deleted file mode 100644 index f59d2045096e..000000000000 --- a/airbyte-integrations/connectors/source-insightly/source_insightly/schemas/tickets.json +++ /dev/null @@ -1,110 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-04/schema#", - "type": "object", - "properties": { - "TICKET_ID": { - "description": "The unique identifier of the ticket.", - "type": "integer" - }, - "ORGANISATION_ID": { - "description": "The unique identifier of the organization associated with the ticket.", - "type": ["integer", "null"] - }, - "TICKET_TYPE": { - "description": "The type or category of the ticket.", - "type": ["string", "null"] - }, - "SUBJECT": { - "description": "The subject or title of the ticket.", - "type": ["string", "null"] - }, - "TICKET_STATUS": { - "description": "The status of the ticket (e.g., open, closed, resolved).", - "type": ["string", "null"] - }, - "PRIORITY": { - "description": "The priority level of the ticket.", - "type": ["string", "null"] - }, - "TO_EMAIL_ADDRESS": { - "description": "The email address the ticket is associated with.", - "type": ["string", "null"] - }, - "CONTACT_ID": { - "description": "The unique identifier of the contact associated with the ticket.", - "type": ["integer", "null"] - }, - "CREATED_USER_ID": { - "description": "The unique identifier of the user who created the ticket.", - "type": ["integer", "null"] - }, - "OWNER_USER_ID": { - "description": "The unique identifier of the user who owns the ticket.", - "type": ["integer", "null"] - }, - "DATE_CREATED_UTC": { - "description": "The date and time the ticket was created in Coordinated Universal Time (UTC).", - "type": ["string", "null"], - "format": "date-time" - }, - "DATE_UPDATED_UTC": { - "description": "The date and time the ticket was last updated in Coordinated Universal Time (UTC).", - "type": ["string", "null"], - "format": "date-time" - }, - "TICKET_NUMBER": { - "description": "The ticket number assigned to the ticket.", - "type": ["string", "null"] - }, - "SOURCE": { - "description": "The source of the ticket (e.g., email, chat, phone).", - "type": ["string", "null"] - }, - "DATE_SOLVED_UTC": { - "description": "The date and time the ticket was solved in Coordinated Universal Time (UTC).", - "type": ["string", "null"], - "format": "date-time" - }, - "DATE_CLOSED_UTC": { - "description": "The date and time the ticket was closed in Coordinated Universal Time (UTC).", - "type": ["string", "null"], - "format": "date-time" - }, - "TicketCommentBodyHtml": { - "description": "The HTML content of the ticket comments.", - "type": ["string", "null"] - }, - "CUSTOMFIELDS": { - "description": "Additional custom fields associated with the ticket.", - "type": "array", - "items": { - "description": "Custom fields associated with the ticket.", - "type": "object", - "properties": { - "FIELD_NAME": { - "description": "The name of the custom field.", - "type": ["string", "null"] - }, - "FIELD_VALUE": { - "description": "The value of the custom field.", - "type": "object" - } - } - } - }, - "TAGS": { - "description": "Tags associated with the ticket for categorization or grouping purposes.", - "type": "array", - "items": { - "description": "Tags associated with the ticket.", - "type": "object", - "properties": { - "TAG_NAME": { - "description": "The name of the tag.", - "type": ["string", "null"] - } - } - } - } - } -} From 996973338704943673c06749e5bd01af2605a1ca Mon Sep 17 00:00:00 2001 From: btkcodedev Date: Tue, 14 May 2024 06:52:02 +0530 Subject: [PATCH 5/5] Update docs/integrations/sources/insightly.md Co-authored-by: Alexandre Girard --- docs/integrations/sources/insightly.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/sources/insightly.md b/docs/integrations/sources/insightly.md index 0785ade2d0d2..3ef2b320b4af 100644 --- a/docs/integrations/sources/insightly.md +++ b/docs/integrations/sources/insightly.md @@ -69,7 +69,7 @@ The connector is restricted by Insightly [requests limitation](https://api.na1.i | Version | Date | Pull Request | Subject | | :------ | :--------- | :------------------------------------------------------- | :------------------------------------------------------------------------------ | -| 0.2.5 | 2024-05-30 | [38140](https://github.com/airbytehq/airbyte/pull/38140) | Make compatable with builder | +| 0.2.5 | 2024-05-14 | [38140](https://github.com/airbytehq/airbyte/pull/38140) | Make compatible with builder | | 0.2.4 | 2024-04-19 | [37177](https://github.com/airbytehq/airbyte/pull/37177) | Updating to 0.80.0 CDK | | 0.2.3 | 2024-04-18 | [37177](https://github.com/airbytehq/airbyte/pull/37177) | Manage dependencies with Poetry. | | 0.2.2 | 2024-04-15 | [37177](https://github.com/airbytehq/airbyte/pull/37177) | Base image migration: remove Dockerfile and use the python-connector-base image |