diff --git a/airbyte.yaml b/airbyte.yaml index 8ab0923e6..f9f4cabd3 100644 --- a/airbyte.yaml +++ b/airbyte.yaml @@ -1164,6 +1164,45 @@ paths: type: "string" in: "path" required: true + /permissions: + post: + tags: + - "public_permissions" + - "public" + - "Permissions" + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/PermissionCreateRequest" + examples: + Permission Creation Request Example: + value: + permissionType: "workspace_admin" + userId: "7d08fd6c-531e-4a00-937e-3d355f253e63" + workspaceId: "9924bcd0-99be-453d-ba47-c2c9766f7da5" + required: true + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/PermissionResponse" + examples: + Permission Creation Response Example: + value: + permissionId: "9924bcd0-99be-453d-ba47-c2c9766f7da5" + permissionType: "workspace_admin" + userId: "7d08fd6c-531e-4a00-937e-3d355f253e63" + description: "Successful operation" + "400": + description: "Invalid data" + "403": + description: "Not allowed" + operationId: "createPermission" + x-speakeasy-alias: "createPermission" + summary: "Create a permission" + x-speakeasy-entity-operation: Permission#create /sources#Aha: post: requestBody: @@ -17762,6 +17801,92 @@ paths: type: "string" in: "path" required: true + /sources#Custom: + post: + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/SourceCustomCreateRequest" + tags: + - "Sources" + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/SourceResponse" + description: "Successful operation" + "400": + description: "Invalid data" + "403": + description: "Not allowed" + operationId: "createSourceCustom" + summary: "Create a source" + description: + "Creates a source given a name, workspace id, and a json blob containing\ + \ the configuration for the source." + x-use-speakeasy-middleware: true + x-speakeasy-entity-operation: Source_Custom#create + /sources/{sourceId}#Custom: + get: + tags: + - "Sources" + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/SourceResponse" + description: "Get a Source by the id in the path." + "403": + description: "Not allowed" + "404": + description: "Not found" + operationId: "getSourceCustom" + summary: "Get Source details" + x-use-speakeasy-middleware: true + x-speakeasy-entity-operation: Source_Custom#read + put: + tags: + - "Sources" + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/SourceCustomPutRequest" + responses: + "2XX": + description: "The resource was updated successfully" + "403": + description: "Not allowed" + "404": + description: "Not found" + operationId: "putSourceCustom" + summary: "Update a Source fully" + x-use-speakeasy-middleware: true + x-speakeasy-entity-operation: Source_Custom#update + delete: + tags: + - "Sources" + responses: + "2XX": + description: "The resource was deleted successfully" + "403": + description: "Not allowed" + "404": + description: "Not found" + operationId: "deleteSourceCustom" + summary: "Delete a Source" + x-use-speakeasy-middleware: true + x-speakeasy-entity-operation: Source_Custom#delete + parameters: + - name: "sourceId" + schema: + format: "UUID" + type: "string" + in: "path" + required: true /destinations#Astra: post: requestBody: @@ -20772,6 +20897,92 @@ paths: type: "string" in: "path" required: true + /destinations#Custom: + post: + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/DestinationCustomCreateRequest" + tags: + - "Destinations" + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/DestinationResponse" + description: "Successful operation" + "400": + description: "Invalid data" + "403": + description: "Not allowed" + operationId: "createDestinationCustom" + summary: "Create a destination" + description: + "Creates a destination given a name, workspace id, and a json blob containing\ + \ the configuration for the destination." + x-use-speakeasy-middleware: true + x-speakeasy-entity-operation: Destination_Custom#create + /destinations/{destinationId}#Custom: + get: + tags: + - "Destinations" + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/DestinationResponse" + description: "Get a Destination by the id in the path." + "403": + description: "Not allowed" + "404": + description: "Not found" + operationId: "getDestinationCustom" + summary: "Get Destination details" + x-use-speakeasy-middleware: true + x-speakeasy-entity-operation: Destination_Custom#read + put: + tags: + - "Destinations" + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/DestinationCustomPutRequest" + responses: + "2XX": + description: "The resource was updated successfully" + "403": + description: "Not allowed" + "404": + description: "Not found" + operationId: "putDestinationCustom" + summary: "Update a Destination fully" + x-use-speakeasy-middleware: true + x-speakeasy-entity-operation: Destination_Custom#update + delete: + tags: + - "Destinations" + responses: + "2XX": + description: "The resource was deleted successfully" + "403": + description: "Not allowed" + "404": + description: "Not found" + operationId: "deleteDestinationCustom" + summary: "Delete a Destination" + x-use-speakeasy-middleware: true + x-speakeasy-entity-operation: Destination_Custom#delete + parameters: + - name: "destinationId" + schema: + format: "UUID" + type: "string" + in: "path" + required: true components: responses: InitiateOauthResponse: @@ -21382,6 +21593,10 @@ components: name: description: "Name of the workspace" type: "string" + organizationId: + description: "ID of organization to add workspace to." + format: "uuid" + type: "string" x-speakeasy-entity: Workspace x-speakeasy-param-suppress-computed-diff: true x-speakeasy-component: true @@ -36876,8 +37091,8 @@ components: - "{ \"type\": \"service_account\", \"project_id\": YOUR_PROJECT_ID,\ \ \"private_key_id\": YOUR_PRIVATE_KEY, ... }" source-zendesk-talk: - title: "Source Zendesk Talk Spec" type: "object" + title: "Source Zendesk Talk Spec" required: - "start_date" - "subdomain" @@ -36885,8 +37100,8 @@ components: properties: subdomain: type: "string" - title: "Subdomain" order: 0 + title: "Subdomain" description: "This is your Zendesk subdomain that can be found in your account\ \ URL. For example, in https://{MY_SUBDOMAIN}.zendesk.com/, where MY_SUBDOMAIN\ \ is the value of your subdomain." @@ -36953,15 +37168,15 @@ components: x-speakeasy-param-sensitive: true start_date: type: "string" - title: "Start Date" order: 2 + 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 Zendesk\ \ Talk API, in the format YYYY-MM-DDT00:00:00Z. All data generated after\ \ this date will be replicated." examples: - "2020-10-15T00:00:00Z" - pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" - format: "date-time" sourceType: title: "zendesk-talk" const: "zendesk-talk" @@ -36970,16 +37185,16 @@ components: order: 0 type: "string" source-zendesk-talk-update: - title: "Source Zendesk Talk Spec" type: "object" + title: "Source Zendesk Talk Spec" required: - "start_date" - "subdomain" properties: subdomain: type: "string" - title: "Subdomain" order: 0 + title: "Subdomain" description: "This is your Zendesk subdomain that can be found in your account\ \ URL. For example, in https://{MY_SUBDOMAIN}.zendesk.com/, where MY_SUBDOMAIN\ \ is the value of your subdomain." @@ -37044,15 +37259,15 @@ components: airbyte_secret: true start_date: type: "string" - title: "Start Date" order: 2 + 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 Zendesk\ \ Talk API, in the format YYYY-MM-DDT00:00:00Z. All data generated after\ \ this date will be replicated." examples: - "2020-10-15T00:00:00Z" - pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" - format: "date-time" source-freshdesk: type: "object" required: @@ -37800,9 +38015,6 @@ components: - "GET_AFN_INVENTORY_DATA" - "GET_AFN_INVENTORY_DATA_BY_COUNTRY" - "GET_AMAZON_FULFILLED_SHIPMENTS_DATA_GENERAL" - - "GET_BRAND_ANALYTICS_MARKET_BASKET_REPORT" - - "GET_BRAND_ANALYTICS_REPEAT_PURCHASE_REPORT" - - "GET_BRAND_ANALYTICS_SEARCH_TERMS_REPORT" - "GET_FBA_ESTIMATED_FBA_FEES_TXT_DATA" - "GET_FBA_FULFILLMENT_CUSTOMER_RETURNS_DATA" - "GET_FBA_FULFILLMENT_CUSTOMER_SHIPMENT_PROMOTION_DATA" @@ -37831,14 +38043,9 @@ components: - "GET_MERCHANTS_LISTINGS_FYP_REPORT" - "GET_ORDER_REPORT_DATA_SHIPPING" - "GET_RESTOCK_INVENTORY_RECOMMENDATIONS_REPORT" - - "GET_SALES_AND_TRAFFIC_REPORT" - "GET_SELLER_FEEDBACK_DATA" - "GET_STRANDED_INVENTORY_UI_DATA" - "GET_V2_SETTLEMENT_REPORT_DATA_FLAT_FILE" - - "GET_VENDOR_INVENTORY_REPORT" - - "GET_VENDOR_NET_PURE_PRODUCT_MARGIN_REPORT" - - "GET_VENDOR_TRAFFIC_REPORT" - - "GET_VENDOR_SALES_REPORT" - "GET_XML_ALL_ORDERS_DATA_BY_ORDER_DATE_GENERAL" - "GET_XML_BROWSE_TREE_DATA" options_list: @@ -38001,9 +38208,6 @@ components: - "GET_AFN_INVENTORY_DATA" - "GET_AFN_INVENTORY_DATA_BY_COUNTRY" - "GET_AMAZON_FULFILLED_SHIPMENTS_DATA_GENERAL" - - "GET_BRAND_ANALYTICS_MARKET_BASKET_REPORT" - - "GET_BRAND_ANALYTICS_REPEAT_PURCHASE_REPORT" - - "GET_BRAND_ANALYTICS_SEARCH_TERMS_REPORT" - "GET_FBA_ESTIMATED_FBA_FEES_TXT_DATA" - "GET_FBA_FULFILLMENT_CUSTOMER_RETURNS_DATA" - "GET_FBA_FULFILLMENT_CUSTOMER_SHIPMENT_PROMOTION_DATA" @@ -38032,14 +38236,9 @@ components: - "GET_MERCHANTS_LISTINGS_FYP_REPORT" - "GET_ORDER_REPORT_DATA_SHIPPING" - "GET_RESTOCK_INVENTORY_RECOMMENDATIONS_REPORT" - - "GET_SALES_AND_TRAFFIC_REPORT" - "GET_SELLER_FEEDBACK_DATA" - "GET_STRANDED_INVENTORY_UI_DATA" - "GET_V2_SETTLEMENT_REPORT_DATA_FLAT_FILE" - - "GET_VENDOR_INVENTORY_REPORT" - - "GET_VENDOR_NET_PURE_PRODUCT_MARGIN_REPORT" - - "GET_VENDOR_TRAFFIC_REPORT" - - "GET_VENDOR_SALES_REPORT" - "GET_XML_ALL_ORDERS_DATA_BY_ORDER_DATE_GENERAL" - "GET_XML_BROWSE_TREE_DATA" options_list: @@ -48196,7 +48395,6 @@ components: minimum: 1 maximum: 31 source-lemlist: - title: "Lemlist Spec" type: "object" required: - "api_key" @@ -48204,9 +48402,11 @@ components: properties: api_key: type: "string" + title: "API Key" + airbyte_secret: true title": "API key" description: "Lemlist API key," - airbyte_secret: true + order: 0 x-speakeasy-param-sensitive: true sourceType: title: "lemlist" @@ -48216,16 +48416,17 @@ components: order: 0 type: "string" source-lemlist-update: - title: "Lemlist Spec" type: "object" required: - "api_key" properties: api_key: type: "string" + title: "API Key" + airbyte_secret: true title": "API key" description: "Lemlist API key," - airbyte_secret: true + order: 0 source-pexels-api: title: "Pexel API Spec" type: "object" @@ -50634,7 +50835,6 @@ components: order: 1 format: "date-time" source-coinmarketcap: - title: "Coinmarketcap Spec" type: "object" required: - "api_key" @@ -50642,15 +50842,16 @@ components: - "sourceType" properties: api_key: - title: "API Key" type: "string" + title: "API Key" + airbyte_secret: true description: "Your API Key. See here. The token is case sensitive." - airbyte_secret: true + order: 0 x-speakeasy-param-sensitive: true data_type: - title: "Data type" type: "string" + title: "Data type" enum: - "latest" - "historical" @@ -50658,9 +50859,10 @@ components: \ and exchanges. /historical: Intervals of historic market data like OHLCV\ \ data or data for use in charting libraries. See here." + order: 1 symbols: - title: "Symbol" type: "array" + title: "Symbol" items: type: "string" description: "Cryptocurrency symbols. (only used for quotes stream)" @@ -50668,6 +50870,7 @@ components: examples: - "AVAX" - "BTC" + order: 2 sourceType: title: "coinmarketcap" const: "coinmarketcap" @@ -50676,21 +50879,21 @@ components: order: 0 type: "string" source-coinmarketcap-update: - title: "Coinmarketcap Spec" type: "object" required: - "api_key" - "data_type" properties: api_key: - title: "API Key" type: "string" + title: "API Key" + airbyte_secret: true description: "Your API Key. See here. The token is case sensitive." - airbyte_secret: true + order: 0 data_type: - title: "Data type" type: "string" + title: "Data type" enum: - "latest" - "historical" @@ -50698,9 +50901,10 @@ components: \ and exchanges. /historical: Intervals of historic market data like OHLCV\ \ data or data for use in charting libraries. See here." + order: 1 symbols: - title: "Symbol" type: "array" + title: "Symbol" items: type: "string" description: "Cryptocurrency symbols. (only used for quotes stream)" @@ -50708,6 +50912,7 @@ components: examples: - "AVAX" - "BTC" + order: 2 source-dixa: type: "object" required: @@ -52795,23 +53000,24 @@ components: title: "Firebolt Spec" type: "object" required: - - "username" - - "password" + - "client_id" + - "client_secret" + - "account" - "database" + - "engine" - "sourceType" properties: - username: + client_id: type: "string" - title: "Username" - description: "Firebolt email address you use to login." + title: "Client ID" + description: "Firebolt service account ID." examples: - - "username@email.com" - password: + - "bbl9qth066hmxkwyb0hy2iwk8ktez9dz" + client_secret: type: "string" - title: "Password" - description: "Firebolt password." + title: "Client Secret" + description: "Firebolt secret, corresponding to the service account ID." airbyte_secret: true - x-speakeasy-param-sensitive: true account: type: "string" title: "Account" @@ -52829,7 +53035,7 @@ components: engine: type: "string" title: "Engine" - description: "Engine name or url to connect to." + description: "Engine name to connect to." sourceType: title: "firebolt" const: "firebolt" @@ -52841,20 +53047,22 @@ components: title: "Firebolt Spec" type: "object" required: - - "username" - - "password" + - "client_id" + - "client_secret" + - "account" - "database" + - "engine" properties: - username: + client_id: type: "string" - title: "Username" - description: "Firebolt email address you use to login." + title: "Client ID" + description: "Firebolt service account ID." examples: - - "username@email.com" - password: + - "bbl9qth066hmxkwyb0hy2iwk8ktez9dz" + client_secret: type: "string" - title: "Password" - description: "Firebolt password." + title: "Client Secret" + description: "Firebolt secret, corresponding to the service account ID." airbyte_secret: true account: type: "string" @@ -52873,7 +53081,7 @@ components: engine: type: "string" title: "Engine" - description: "Engine name or url to connect to." + description: "Engine name to connect to." source-outreach: title: "Source Outreach Spec" type: "object" @@ -66538,15 +66746,6 @@ components: title: "Disable Final Tables. (WARNING! Unstable option; Columns in raw\ \ table schema might change between versions)" order: 11 - enable_incremental_final_table_updates: - type: "boolean" - default: false - description: "When enabled your data will load into your final tables incrementally\ - \ while your data is still being synced. When Disabled (the default),\ - \ your data loads into your final tables once at the end of a sync. Note\ - \ that this option only applies if you elect to create Final tables" - title: "Enable Loading Data Incrementally to Final Tables" - order: 12 retention_period_days: type: "integer" default: 1 @@ -66732,15 +66931,6 @@ components: title: "Disable Final Tables. (WARNING! Unstable option; Columns in raw\ \ table schema might change between versions)" order: 11 - enable_incremental_final_table_updates: - type: "boolean" - default: false - description: "When enabled your data will load into your final tables incrementally\ - \ while your data is still being synced. When Disabled (the default),\ - \ your data loads into your final tables once at the end of a sync. Note\ - \ that this option only applies if you elect to create Final tables" - title: "Enable Loading Data Incrementally to Final Tables" - order: 12 retention_period_days: type: "integer" default: 1 @@ -80011,6 +80201,32 @@ components: type: "string" x-speakeasy-entity: Source_Zoom x-speakeasy-param-suppress-computed-diff: true + SourceCustomCreateRequest: + required: + - name + - workspaceId + - configuration + type: object + properties: + name: + description: Name of the source e.g. dev-mysql-instance. + type: string + definitionId: + description: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. + format: uuid + type: string + workspaceId: + format: uuid + type: string + configuration: + $ref: "#/components/schemas/source-custom" + secretId: + description: + "Optional secretID obtained through the public API OAuth redirect\ + \ flow." + type: "string" + x-speakeasy-entity: Source_Custom + x-speakeasy-param-suppress-computed-diff: true DestinationAstraCreateRequest: required: - name @@ -80746,6 +80962,27 @@ components: $ref: "#/components/schemas/destination-yellowbrick" x-speakeasy-entity: Destination_Yellowbrick x-speakeasy-param-suppress-computed-diff: true + DestinationCustomCreateRequest: + required: + - name + - workspaceId + - configuration + type: object + properties: + name: + description: Name of the destination e.g. dev-mysql-instance. + type: string + definitionId: + description: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. + format: uuid + type: string + workspaceId: + format: uuid + type: string + configuration: + $ref: "#/components/schemas/destination-custom" + x-speakeasy-entity: Destination_Custom + x-speakeasy-param-suppress-computed-diff: true SourceAhaPutRequest: required: - "name" @@ -83834,6 +84071,22 @@ components: $ref: "#/components/schemas/source-zoom-update" x-speakeasy-entity: Source_Zoom x-speakeasy-param-suppress-computed-diff: true + SourceCustomPutRequest: + required: + - "name" + - "workspaceId" + - "configuration" + type: "object" + properties: + name: + type: "string" + workspaceId: + format: "uuid" + type: "string" + configuration: + $ref: "#/components/schemas/source-custom-update" + x-speakeasy-entity: Source_Custom + x-speakeasy-param-suppress-computed-diff: true DestinationAstraPutRequest: required: - "name" @@ -84394,6 +84647,32 @@ components: $ref: "#/components/schemas/destination-yellowbrick-update" x-speakeasy-entity: Destination_Yellowbrick x-speakeasy-param-suppress-computed-diff: true + DestinationCustomPutRequest: + required: + - "name" + - "workspaceId" + - "configuration" + type: "object" + properties: + name: + type: "string" + workspaceId: + format: "uuid" + type: "string" + configuration: + $ref: "#/components/schemas/destination-custom-update" + x-speakeasy-entity: Destination_Custom + x-speakeasy-param-suppress-computed-diff: true + source-custom: + description: The values required to configure the source. + example: { user: "charles" } + destination-custom: + description: The values required to configure the destination. + example: { user: "charles" } + source-custom-update: + title: "Custom Spec" + destination-custom-update: + title: "Custom Spec" SourceConfiguration: description: The values required to configure the source. example: { user: "charles" } @@ -84412,7 +84691,7 @@ components: type: oauth2 flows: clientCredentials: - tokenUrl: https://cloud.airbyte.io/api/v1/applications/token + tokenUrl: /api/v1/applications/token scopes: {} security: - bearerAuth: []