Skip to content

Commit

Permalink
Merge pull request #15 from NarrativeScience/mixpanel
Browse files Browse the repository at this point in the history
Adds mixpanel source form
  • Loading branch information
jdrake committed Jul 29, 2020
2 parents e9e5617 + 39cbb91 commit cf8e219
Show file tree
Hide file tree
Showing 40 changed files with 751 additions and 118 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ https://www.stitchdata.com/docs/developers/stitch-connect/api
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 0.3
- Package version: 0.2.2
- Package version: 0.4.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

Table of Contents:
Expand Down Expand Up @@ -66,14 +66,14 @@ Class | Method | HTTP request | Description
*DestinationsApi* | [**update_destination**](docs/DestinationsApi.md#update_destination) | **PUT** /v4/destinations/{destination_id} | Updates an existing destination. Modifications to the type attribute are not supported.
*SourcesApi* | [**create_source**](docs/SourcesApi.md#create_source) | **POST** /v4/sources | Creates a source object, which is the first step in setting up a new data source. After the source object is created, additional configuration steps must be completed.
*SourcesApi* | [**delete_source**](docs/SourcesApi.md#delete_source) | **DELETE** /v4/sources/{source_id} | Deletes an existing data source.
*SourcesApi* | [**get_last_connection_check**](docs/SourcesApi.md#get_last_connection_check) | **GET** /v4/sources/{source_id}/last-connection-check | Retrieves the last connection check for a source by the sources unique identifier.
*SourcesApi* | [**get_last_connection_check**](docs/SourcesApi.md#get_last_connection_check) | **GET** /v4/sources/{source_id}/last-connection-check | Retrieves the last connection check for a source by the source's unique identifier.
*SourcesApi* | [**get_source**](docs/SourcesApi.md#get_source) | **GET** /v4/sources/{source_id} | Retrieves a previously created data source by its unique identifier. This endpoint can be used to retrieve an active, paused, or deleted source.
*SourcesApi* | [**get_sources**](docs/SourcesApi.md#get_sources) | **GET** /v4/sources | Lists the sources for an account, including active, paused, and deleted sources.
*SourcesApi* | [**start_replication**](docs/SourcesApi.md#start_replication) | **POST** /v4/sources/{source_id}/sync | Manually starts a replication job for a source using the sources unique identifier.
*SourcesApi* | [**start_replication**](docs/SourcesApi.md#start_replication) | **POST** /v4/sources/{source_id}/sync | Manually starts a replication job for a source using the source's unique identifier.
*SourcesApi* | [**update_source**](docs/SourcesApi.md#update_source) | **PUT** /v4/sources/{source_id} | Updates an existing data source.
*StreamsApi* | [**get_stream_schema**](docs/StreamsApi.md#get_stream_schema) | **GET** /v4/sources/{source_id}/streams/{stream_id} | Retrieves the schema for a sources stream by the source and streams unique identifiers.
*StreamsApi* | [**get_stream_schema**](docs/StreamsApi.md#get_stream_schema) | **GET** /v4/sources/{source_id}/streams/{stream_id} | Retrieves the schema for a source's stream by the source and stream's unique identifiers.
*StreamsApi* | [**get_streams**](docs/StreamsApi.md#get_streams) | **GET** /v4/sources/{source_id}/streams | Lists the available streams for a source.
*StreamsApi* | [**update_stream_metadata**](docs/StreamsApi.md#update_stream_metadata) | **PUT** /v4/sources/{source_id}/streams/metadata | Updates the metadata for streams and fields. This endpoint is used to define the metadata properties returned in the Stream Schema objects non-discoverable-metadata-keys property.
*StreamsApi* | [**update_stream_metadata**](docs/StreamsApi.md#update_stream_metadata) | **PUT** /v4/sources/{source_id}/streams/metadata | Updates the metadata for streams and fields. This endpoint is used to define the metadata properties returned in the Stream Schema object's non-discoverable-metadata-keys property.


## Documentation for Models
Expand Down Expand Up @@ -101,6 +101,7 @@ Class | Method | HTTP request | Description
- [HookNotificationConfig](docs/HookNotificationConfig.md)
- [Metadata](docs/Metadata.md)
- [MetadataObject](docs/MetadataObject.md)
- [MixpanelSourceFormProperties](docs/MixpanelSourceFormProperties.md)
- [ReplicationJob](docs/ReplicationJob.md)
- [S3DestinationFormProperties](docs/S3DestinationFormProperties.md)
- [SalesforceSourceFormProperties](docs/SalesforceSourceFormProperties.md)
Expand Down Expand Up @@ -149,6 +150,6 @@ npx openapi-generator generate \
--package-name stitch_connect_client \
--git-user-id NarrativeScience \
--git-repo-id stitch-connect-python \
-p packageVersion=0.2.2 \
-p packageVersion=0.4.0 \
-t templates
```
2 changes: 1 addition & 1 deletion docs/ConnectionCheck.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ConnectionCheck

A Connection Check object shows the results from a test of a connections parameters. This is a test performed by Stitch that checks the configuration of a sources connection parameters. The nature of the test varies by connection type.
A Connection Check object shows the results from a test of a connection's parameters. This is a test performed by Stitch that checks the configuration of a source's connection parameters. The nature of the test varies by connection type.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
Expand Down
6 changes: 3 additions & 3 deletions docs/ConnectionDetails.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# ConnectionDetails

Contained in a Source or Destination Report Card object, the Details object contains information about a connection types availability within Stitch.
Contained in a Source or Destination Report Card object, the Details object contains information about a connection type's availability within Stitch.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access** | **bool** | Indicates whether the Stitch client who made the request has access to the connection. This value is based on the connections pricing_tier and pipeline_state. If the Stitch client is using a plan that doesnt meet the pricing_tier requirement, the access value will be false. For example: If pricing_tier: enterprise,the Stitch client must be on an Enterprise plan to access the source. All connections with a pipeline_state value of deprecated will also have an access value of false. | [optional]
**access** | **bool** | Indicates whether the Stitch client who made the request has access to the connection. This value is based on the connection's pricing_tier and pipeline_state. If the Stitch client is using a plan that doesn't meet the pricing_tier requirement, the access value will be false. For example: If pricing_tier: enterprise,the Stitch client must be on an Enterprise plan to access the source. All connections with a pipeline_state value of deprecated will also have an access value of false. | [optional]
**default_scheduling_interval** | **int** | Applicable only to source report cards. The default frequency_in_minutes value for the source. | [optional]
**pricing_tier** | **str** | Indicates the type of Stitch plan required to use the connection. Possible values are: standard - Any Stitch plan can use the connection. premium - A Standard Stitch plan is required to use the connection. enterprise - An Enterprise Stitch plan is required to use the connection. | [optional]
**default_start_date** | **str** | Applicable only to source report cards. The default start_date value for the source. | [optional]
**pipeline_state** | **str** | The connection types release status in Stitch. Possible values are: alpha - The connection is in development and is not available in Stitch. beta - The connection is in open or closed beta and is available in Stitch. released - The connection is in general release and available in Stitch. deprecated - The connection has been deprecated and is no longer available in Stitch. | [optional]
**pipeline_state** | **str** | The connection type's release status in Stitch. Possible values are: alpha - The connection is in development and is not available in Stitch. beta - The connection is in open or closed beta and is available in Stitch. released - The connection is in general release and available in Stitch. deprecated - The connection has been deprecated and is no longer available in Stitch. | [optional]
**protocol** | **str** | The type of the connection. For example: snowflake or platform.facebook | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/ConnectionStepProps.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Name | Type | Description | Notes
**is_required** | **bool** | If true, the property is required for complete configuration. | [optional]
**is_credential** | **bool** | If true, the property is a credential or otherwise sensitive data. | [optional]
**property_type** | **str** | Indicates the type of the property. Possible values are: user_provided - Indicates the property must be set by the user. read_only - Indicates the property is read-only and is not settable by the Generally, this is an internal field set inside of Stitch. system_provided_by_default - Indicates the property used to be system_provided: true, but can now be set by the API consumer. These are generally properties associated with OAuth for generating refresh and access tokens. Note: Use caution when setting these properties, as using incorrect values can put the source into a non-functioning state. | [optional]
**json_schema** | [**list[ConnectionStepPropsJsonSchema]**](ConnectionStepPropsJsonSchema.md) | Note: Data will only be returned for this array if property_type: user_provided or property_type: system_provided_by_default. If property_type: read_only, this property will be null. An array containing: type - A string indicating the expected data type of the propertys value. For example: boolean pattern - A string indicating the expected pattern of the propertys value. For example: ^\\\\d+$ anyOf - A series of arrays containing key-value pairs for the type and format combinations Stitch will accept as the propertys value | [optional]
**json_schema** | [**list[ConnectionStepPropsJsonSchema]**](ConnectionStepPropsJsonSchema.md) | Note: Data will only be returned for this array if property_type: user_provided or property_type: system_provided_by_default. If property_type: read_only, this property will be null. An array containing: type - A string indicating the expected data type of the property's value. For example: boolean pattern - A string indicating the expected pattern of the property's value. For example: ^\\\\d+$ anyOf - A series of arrays containing key-value pairs for the type and format combinations Stitch will accept as the property's value | [optional]
**provided** | **bool** | If true, the property has been provided. For properties where property_type: user_provided, this indicates that the user has provided the property. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
Expand Down
6 changes: 3 additions & 3 deletions docs/ConnectionStepPropsJsonSchema.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **str** | A string indicating the expected data type of the propertys value. For example: boolean | [optional]
**pattern** | **str** | A string indicating the expected pattern of the propertys value. For example: ^\\\\d+$ | [optional]
**any_of** | [**list[ConnectionStepPropsAnyOf]**](ConnectionStepPropsAnyOf.md) | A series of arrays containing key-value pairs for the type and format combinations Stitch will accept as the propertys value. F | [optional]
**type** | **str** | A string indicating the expected data type of the property's value. For example: boolean | [optional]
**pattern** | **str** | A string indicating the expected pattern of the property's value. For example: ^\\\\d+$ | [optional]
**any_of** | [**list[ConnectionStepPropsAnyOf]**](ConnectionStepPropsAnyOf.md) | A series of arrays containing key-value pairs for the type and format combinations Stitch will accept as the property's value. F | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
2 changes: 1 addition & 1 deletion docs/DestinationReportCard.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# DestinationReportCard

A Destination Report Card object contains information about a destinations connection configuration.
A Destination Report Card object contains information about a destination's connection configuration.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
Expand Down
8 changes: 4 additions & 4 deletions docs/FieldLevelMetadata.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# FieldLevelMetadata

Contained in a Metadata object, the Field-level metadata object contains information about a fields inclusion in a streams field selection list.
Contained in a Metadata object, the Field-level metadata object contains information about a field's inclusion in a stream's field selection list.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**inclusion** | **str** | Indicates when a field will be included. Possible values are: automatic - The field is included all the time, regardless of selected-by-default and selected values available - The field is available for selection. The field will be included if selected-by-default or selected is true. unsupported - The field is unsupported and will not be included, regardless of selected-by-default and selected values If a field is unsupported, the `unsupported-description` attribute may provide additonal information. | [optional]
**selected** | **bool** | Indicates whether a field should be included in a streams field selection list. This value will be present only if the stream containing the field is selected (selected: true). null - The value has not been set true - The field is selected false - The field is not selected | [optional]
**selected** | **bool** | Indicates whether a field should be included in a stream's field selection list. This value will be present only if the stream containing the field is selected (selected: true). null - The value has not been set true - The field is selected false - The field is not selected | [optional]
**selected_by_default** | **bool** | Indicates if a field will be selected by default. Possible values are: null - The value has not been set true - The field is selected by default and is included regardless of the `selected` value false - The field is not selected by default. The field will be included if the `selected value` is true. | [optional]
**sql_datatype** | **str** | For database sources only. The data type of a column from a database. | [optional]
**field_exclusions** | **object** | A list of arrays, each array containing an array of strings that correspond to fields that are incompatible when the current field is selected. For example: If the metadata for a DeviceOS field contains a fieldExclusion of [\"properties\":\"ImpressionLostToBidPercent\"], then the DeviceOS and ImpressionLostToBidPercent fields cannot be selected together in the stream. | [optional]
**unsupported_description** | **str** | The reason a field is unsupported (`inclusion`: unsupported). Note: This is not available for all sources. | [optional]
**tap_google_analytics_cubes** | **list[str]** | For Google Analytics sources only. An array of strings containing the ‘cubes the field is a part of. A cube is a group of metrics and dimensions that are compatible together. | [optional]
**tap_google_analytics_cubes** | **list[str]** | For Google Analytics sources only. An array of strings containing the ‘cubes' the field is a part of. A cube is a group of metrics and dimensions that are compatible together. | [optional]
**tap_google_analytics_group** | **str** | For Google Analytics sources only. The group the field belongs to. Possible values are: - Ad Exchange - Adsense - Adwords - App Tracking - Audience - Channel Grouping - Content Experiments - Content Grouping - Custom Variables or Columns - DoubleClick Bid Manager - DoubleClick Campaign Manager - DoubleClick Search - DoubleClick for Publishers - DoubleClick for Publishers Backfill - Ecommerce - Event Tracking - Exceptions - Geo Network - Goal Conversions - Internal Search - Lifetime Value and Cohorts - Page Tracking - Platform or Device - Publisher - Report Fields - Session - Site Speed - Social Activities - Social Interactions - System - Time - Traffic Sources - User - User Timings | [optional]
**behavior** | **str** | For Google Analytics and Google Ads sources only. The type of field. Possible values are: - ATTRIBUTE - Goolgle Ads sources only - METRIC - DIMENSION - Google Analytics sources only - SEGMENT - Goolgle Ads sources only Note: This property wont be present for Google Analytics fields where tap_google_analytics.group: Report Fields. | [optional]
**behavior** | **str** | For Google Analytics and Google Ads sources only. The type of field. Possible values are: - ATTRIBUTE - Goolgle Ads sources only - METRIC - DIMENSION - Google Analytics sources only - SEGMENT - Goolgle Ads sources only Note: This property won't be present for Google Analytics fields where tap_google_analytics.group: Report Fields. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down

0 comments on commit cf8e219

Please sign in to comment.