diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 51363f7..bc46124 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -24,13 +24,15 @@ jobs: uses: actions/checkout@v3 - name: Setup node - uses: actions/setup-node@v2 + uses: actions/setup-node@v3 - - name: Download fern + - name: Download Fern run: npm install -g fern-api - - name: Release SDKs + - name: Release SDK env: FERN_NPM_TOKEN: ${{ secrets.FERN_NPM_TOKEN }} - run: fern release ${{github.ref_name}} --log-level debug + FERN_TOKEN: ${{ secrets.FERN_TOKEN }} + run: fern generate --group publish --version ${{ github.ref_name }} --log-level debug + diff --git a/.gitignore b/.gitignore index 496ee2c..e43b0f9 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1 @@ -.DS_Store \ No newline at end of file +.DS_Store diff --git a/fern/api/definition/openapi.yml b/fern/api/definition/openapi.yml index dc74ae4..e7c2a18 100644 --- a/fern/api/definition/openapi.yml +++ b/fern/api/definition/openapi.yml @@ -37,10 +37,10 @@ components: type: string dir: anyOf: - - $ref: '#/components/schemas/OrderByDirection' + - $ref: "#/components/schemas/OrderByDirection" - type: array items: - $ref: '#/components/schemas/OrderByDirection' + $ref: "#/components/schemas/OrderByDirection" limit: type: integer prev: @@ -64,13 +64,9 @@ components: type: object properties: strategy: - $ref: '#/components/schemas/IssueTriggerStrategy' + $ref: "#/components/schemas/IssueTriggerStrategy" connections: - anyOf: - - type: string - - type: array - items: - type: string + type: string required: - strategy - connections @@ -84,17 +80,18 @@ components: - warn - error - fatal + TransformationContentEnv: + type: object + $ref: "#/components/schemas/EmptyProperties" + additionalProperties: + type: string IssueTriggerTransformationConfigs: type: object properties: log_level: - $ref: '#/components/schemas/TransformationExecutionLogLevel' + $ref: "#/components/schemas/TransformationExecutionLogLevel" transformations: - anyOf: - - type: string - - type: array - items: - type: string + type: string required: - log_level - transformations @@ -109,28 +106,15 @@ components: type: object properties: delay: - $ref: '#/components/schemas/IssueTriggerBackpressureDelay' + $ref: "#/components/schemas/IssueTriggerBackpressureDelay" destinations: - anyOf: - - type: string - - type: array - items: - type: string + type: string required: - delay - destinations additionalProperties: false description: Configs for a 'Backpressure' issue trigger - IssueTriggerReference: - anyOf: - - $ref: '#/components/schemas/IssueTriggerDeliveryConfigs' - - $ref: '#/components/schemas/IssueTriggerTransformationConfigs' - - $ref: '#/components/schemas/IssueTriggerBackpressureConfigs' - description: >- - The configurations for an issue trigger. Different issue types, i.e. - 'delivery', 'transformation' and 'backpressure have different - configurations. - 'IssueTrigger ': + IssueTrigger: type: object properties: id: @@ -142,9 +126,9 @@ components: type: string nullable: true type: - $ref: '#/components/schemas/IssueType' + $ref: "#/components/schemas/IssueType" configs: - $ref: '#/components/schemas/IssueTriggerReference' + $ref: "#/components/schemas/IssueTriggerDeliveryConfigs" disabled_at: type: string format: date-time @@ -164,18 +148,33 @@ components: - updated_at - created_at additionalProperties: false - IssueTrigger PaginatedResult: + IssueTriggerPaginatedResult: type: object properties: pagination: - $ref: '#/components/schemas/SeekPagination' + $ref: "#/components/schemas/SeekPagination" count: type: integer models: type: array items: - $ref: '#/components/schemas/IssueTrigger ' + $ref: "#/components/schemas/IssueTrigger" additionalProperties: false + UpdateIssueRequestBodyStatus: + type: string + enum: + - OPENED + - IGNORED + - ACKNOWLEDGED + - RESOLVED + description: New status + APIErrorResponseData: + type: object + $ref: "#/components/schemas/EmptyProperties" + nullable: true + APIErrorResponseMessage: + type: string + description: Error description APIErrorResponse: type: object properties: @@ -187,12 +186,9 @@ components: format: float description: Status code message: - type: string - description: Error description + $ref: "#/components/schemas/APIErrorResponseMessage" data: - type: object - properties: {} - nullable: true + $ref: "#/components/schemas/APIErrorResponseData" required: - code - status @@ -254,6 +250,14 @@ components: - COMPLETED - HOLD nullable: true + AttemptErrorBody: + type: object + $ref: "#/components/schemas/EmptyProperties" + nullable: true + AttemptNumber: + type: number + format: float + nullable: true EventAttempt: type: object properties: @@ -268,17 +272,13 @@ components: format: float nullable: true attempt_number: - type: number - format: float - nullable: true + $ref: "#/components/schemas/AttemptNumber" trigger: - $ref: '#/components/schemas/AttemptTrigger' + $ref: "#/components/schemas/AttemptTrigger" error_code: - $ref: '#/components/schemas/AttemptErrorCodes' + $ref: "#/components/schemas/AttemptErrorCodes" body: - type: object - properties: {} - nullable: true + $ref: "#/components/schemas/AttemptErrorBody" requested_url: type: string nullable: true @@ -286,7 +286,7 @@ components: type: string nullable: true status: - $ref: '#/components/schemas/AttemptStatus' + $ref: "#/components/schemas/AttemptStatus" successful_at: type: string format: date-time @@ -314,7 +314,7 @@ components: type: string format: date-time state: - $ref: '#/components/schemas/AttemptState' + $ref: "#/components/schemas/AttemptState" archived_at: type: string nullable: true @@ -334,13 +334,13 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/SeekPagination' + $ref: "#/components/schemas/SeekPagination" count: type: integer models: type: array items: - $ref: '#/components/schemas/EventAttempt' + $ref: "#/components/schemas/EventAttempt" additionalProperties: false ShortEventData: type: object @@ -355,13 +355,13 @@ components: - type: string nullable: true - type: object - properties: {} + $ref: "#/components/schemas/EmptyProperties" nullable: true headers: anyOf: - type: string - type: object - properties: {} + $ref: "#/components/schemas/EmptyProperties" additionalProperties: type: string nullable: true @@ -370,7 +370,7 @@ components: anyOf: - type: string - type: object - properties: {} + $ref: "#/components/schemas/EmptyProperties" nullable: true is_large_payload: type: boolean @@ -379,6 +379,11 @@ components: - path additionalProperties: false nullable: true + BookmarkTriggerPropertiesTarget: + type: string + enum: + - http + - cli Bookmark: type: object properties: @@ -392,12 +397,12 @@ components: type: string label: type: string - alias: + type: type: string nullable: true data: anyOf: - - $ref: '#/components/schemas/ShortEventData' + - $ref: "#/components/schemas/ShortEventData" - nullable: true nullable: true last_used_at: @@ -423,13 +428,13 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/SeekPagination' + $ref: "#/components/schemas/SeekPagination" count: type: integer models: type: array items: - $ref: '#/components/schemas/Bookmark' + $ref: "#/components/schemas/Bookmark" additionalProperties: false EventStatus: type: string @@ -461,7 +466,7 @@ components: format: float data: anyOf: - - $ref: '#/components/schemas/ShortEventData' + - $ref: "#/components/schemas/ShortEventData" - nullable: true nullable: true last_attempt_at: @@ -477,7 +482,7 @@ components: format: float nullable: true status: - $ref: '#/components/schemas/EventStatus' + $ref: "#/components/schemas/EventStatus" successful_at: type: string format: date-time @@ -507,7 +512,95 @@ components: EventArray: type: array items: - $ref: '#/components/schemas/Event' + $ref: "#/components/schemas/Event" + QueryParametersInclude: + enum: + - data + CreateEventsBulkStatus: + maxLength: 255 + enum: + - SCHEDULED + - QUEUED + - HOLD + - FAILED + - SUCCESSFUL + CreateEventsBulkAttempts: + type: object + properties: + ge: + type: integer + minimum: 0 + gte: + type: integer + minimum: 0 + le: + type: integer + minimum: 0 + lte: + type: integer + minimum: 0 + any: + type: boolean + contains: + type: integer + minimum: 0 + CreateEventsBulkSuccessAt: + type: object + properties: + ge: + type: integer + minimum: 200 + maximum: 600 + gte: + type: integer + minimum: 200 + maximum: 600 + le: + type: integer + minimum: 200 + maximum: 600 + lte: + type: integer + minimum: 200 + maximum: 600 + any: + type: boolean + contains: + type: integer + minimum: 200 + maximum: 600 + CreateEventsBulkResponseCreatedOrLastAttemptAt: + type: object + properties: + ge: + type: string + format: date-time + gte: + type: string + format: date-time + le: + type: string + format: date-time + lte: + type: string + format: date-time + any: + type: boolean + contains: + type: string + format: date-time + CreateEventsBulkResponseOrderBy: + type: string + maxLength: 255 + enum: + - last_attempt_at + - next_attempt_at + - created_at + CreateEventsBulkResponseDir: + type: string + enum: + - asc + - desc DeletedBookmarkResponse: type: object properties: @@ -516,13 +609,33 @@ components: required: - id additionalProperties: false - DestinationRateLimitPeriod: + RateLimitPeriod: type: string enum: - second - minute - hour nullable: true + RateLimit: + type: integer + minimum: 1 + oneOf: + - type: integer + maximum: 100 + - type: integer + maximum: 6000 + - type: integer + maximum: 360000 + nullable: true + RequestBodySource: + properties: + name: + type: string + pattern: ^[A-z0-9-_]+$ + maxLength: 155 + required: + - name + additionalProperties: false Destination: type: object properties: @@ -545,7 +658,7 @@ components: type: integer nullable: true rate_limit_period: - $ref: '#/components/schemas/DestinationRateLimitPeriod' + $ref: "#/components/schemas/RateLimitPeriod" archived_at: type: string format: date-time @@ -567,33 +680,33 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/SeekPagination' + $ref: "#/components/schemas/SeekPagination" count: type: integer models: type: array items: - $ref: '#/components/schemas/Destination' + $ref: "#/components/schemas/Destination" additionalProperties: false EventPaginatedResult: type: object properties: pagination: - $ref: '#/components/schemas/SeekPagination' + $ref: "#/components/schemas/SeekPagination" count: type: integer models: type: array items: - $ref: '#/components/schemas/Event' + $ref: "#/components/schemas/Event" additionalProperties: false RetriedEvent: type: object properties: event: - $ref: '#/components/schemas/Event' + $ref: "#/components/schemas/Event" attempt: - $ref: '#/components/schemas/EventAttempt' + $ref: "#/components/schemas/EventAttempt" required: - event - attempt @@ -608,7 +721,7 @@ components: query: anyOf: - type: object - properties: {} + $ref: "#/components/schemas/EmptyProperties" additionalProperties: nullable: true - type: string @@ -669,13 +782,13 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/SeekPagination' + $ref: "#/components/schemas/SeekPagination" count: type: integer models: type: array items: - $ref: '#/components/schemas/BatchOperation' + $ref: "#/components/schemas/BatchOperation" additionalProperties: false BatchOperationPlan: type: object @@ -716,6 +829,10 @@ components: - VERIFICATION - HANDSHAKE - POLLING + CreateIntegrationConfig: + type: object + $ref: "#/components/schemas/EmptyProperties" + additionalProperties: false APIKeyIntegrationConfigs: type: object properties: @@ -742,20 +859,22 @@ components: - sha1 - sha256 - sha512 + HMACEncoding: + type: string + enum: + - base64 + - hex HMACIntegrationConfigs: type: object properties: webhook_secret_key: type: string algorithm: - $ref: '#/components/schemas/HMACAlgorithms' + $ref: "#/components/schemas/HMACAlgorithms" header_key: type: string encoding: - type: string - enum: - - base64 - - hex + $ref: "#/components/schemas/HMACEncoding" required: - webhook_secret_key - algorithm @@ -773,17 +892,19 @@ components: - name - password additionalProperties: false + ShopifyRateLimitPeriod: + type: string + enum: + - minute + - second + nullable: true ShopifyIntegrationConfigs: type: object properties: webhook_secret_key: type: string rate_limit_period: - type: string - enum: - - minute - - second - nullable: true + $ref: "#/components/schemas/ShopifyRateLimitPeriod" rate_limit: type: number format: float @@ -800,13 +921,26 @@ components: required: - webhook_secret_key additionalProperties: false - IntegrationConfig: - anyOf: - - $ref: '#/components/schemas/APIKeyIntegrationConfigs' - - $ref: '#/components/schemas/HandledHMACConfigs' - - $ref: '#/components/schemas/HMACIntegrationConfigs' - - $ref: '#/components/schemas/BasicAuthIntegrationConfigs' - - $ref: '#/components/schemas/ShopifyIntegrationConfigs' + SourceIntegration: + type: object + properties: + id: + type: string + label: + type: string + provider: + $ref: "#/components/schemas/IntegrationProvider" + features: + type: array + items: + $ref: "#/components/schemas/IntegrationFeature" + required: + - id + - label + - provider + - features + additionalProperties: false + nullable: true Source: type: object properties: @@ -822,25 +956,7 @@ components: type: string nullable: true integration: - type: object - properties: - id: - type: string - label: - type: string - provider: - $ref: '#/components/schemas/IntegrationProvider' - features: - type: array - items: - $ref: '#/components/schemas/IntegrationFeature' - required: - - id - - label - - provider - - features - additionalProperties: false - nullable: true + $ref: "#/components/schemas/SourceIntegration" archived_at: type: string format: date-time @@ -869,17 +985,17 @@ components: label: type: string provider: - $ref: '#/components/schemas/IntegrationProvider' + $ref: "#/components/schemas/IntegrationProvider" features: type: array items: - $ref: '#/components/schemas/IntegrationFeature' + $ref: "#/components/schemas/IntegrationFeature" configs: - $ref: '#/components/schemas/IntegrationConfig' + $ref: "#/components/schemas/APIKeyIntegrationConfigs" sources: type: array items: - $ref: '#/components/schemas/Source' + $ref: "#/components/schemas/Source" updated_at: type: string format: date-time @@ -901,13 +1017,13 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/SeekPagination' + $ref: "#/components/schemas/SeekPagination" count: type: integer models: type: array items: - $ref: '#/components/schemas/Integration' + $ref: "#/components/schemas/Integration" additionalProperties: false AttachedIntegrationToSource: type: object @@ -919,7 +1035,7 @@ components: additionalProperties: false DetachedIntegrationFromSource: type: object - properties: {} + $ref: "#/components/schemas/EmptyProperties" additionalProperties: false DeletedIntegration: type: object @@ -952,7 +1068,7 @@ components: error_code: type: array items: - $ref: '#/components/schemas/AttemptErrorCodes' + $ref: "#/components/schemas/AttemptErrorCodes" required: - webhook_id - response_status @@ -975,12 +1091,16 @@ components: type: object properties: trigger_event: - $ref: '#/components/schemas/Event' + $ref: "#/components/schemas/Event" trigger_attempt: - $ref: '#/components/schemas/EventAttempt' + $ref: "#/components/schemas/EventAttempt" additionalProperties: false nullable: true description: Delivery issue data + DeliveryIssueWithDataType: + type: string + enum: + - delivery DeliveryIssueWithData: type: object properties: @@ -991,7 +1111,7 @@ components: team_id: type: string status: - $ref: '#/components/schemas/IssueStatus' + $ref: "#/components/schemas/IssueStatus" opened_at: type: string format: date-time @@ -1020,15 +1140,13 @@ components: created_at: type: string type: - type: string - enum: - - delivery + $ref: "#/components/schemas/DeliveryIssueWithDataType" aggregation_keys: - $ref: '#/components/schemas/DeliveryIssueAggregationKeys' + $ref: "#/components/schemas/DeliveryIssueAggregationKeys" reference: - $ref: '#/components/schemas/DeliveryIssueReference' + $ref: "#/components/schemas/DeliveryIssueReference" data: - $ref: '#/components/schemas/DeliveryIssueData' + $ref: "#/components/schemas/DeliveryIssueData" required: - id - team_id @@ -1051,7 +1169,7 @@ components: items: type: string log_level: - $ref: '#/components/schemas/TransformationExecutionLogLevel' + $ref: "#/components/schemas/TransformationExecutionLogLevel" required: - transformation_id - log_level @@ -1069,20 +1187,21 @@ components: required: - transformation_execution_id additionalProperties: false - description: >- - Reference to the event request transformation an issue is being created - for. + description: Reference to the event request transformation an issue is being + created for. + ConsoleLinePropertiesType: + type: string + enum: + - error + - log + - warn + - info + - debug ConsoleLine: type: object properties: type: - type: string - enum: - - error - - log - - warn - - info - - debug + $ref: "#/components/schemas/ConsoleLinePropertiesType" message: type: string required: @@ -1105,11 +1224,11 @@ components: webhook_id: type: string log_level: - $ref: '#/components/schemas/TransformationExecutionLogLevel' + $ref: "#/components/schemas/TransformationExecutionLogLevel" logs: type: array items: - $ref: '#/components/schemas/ConsoleLine' + $ref: "#/components/schemas/ConsoleLine" updated_at: type: string format: date-time @@ -1117,9 +1236,9 @@ components: type: string format: date-time original_event_data: - $ref: '#/components/schemas/ShortEventData' + $ref: "#/components/schemas/ShortEventData" transformed_event_data: - $ref: '#/components/schemas/ShortEventData' + $ref: "#/components/schemas/ShortEventData" issue_id: type: string nullable: true @@ -1139,14 +1258,18 @@ components: type: object properties: transformation_execution: - $ref: '#/components/schemas/TransformationExecution' + $ref: "#/components/schemas/TransformationExecution" trigger_attempt: - $ref: '#/components/schemas/EventAttempt' + $ref: "#/components/schemas/EventAttempt" required: - transformation_execution additionalProperties: false nullable: true description: Transformation issue data + TransformationIssueWithDataType: + type: string + enum: + - transformation TransformationIssueWithData: type: object properties: @@ -1157,7 +1280,7 @@ components: team_id: type: string status: - $ref: '#/components/schemas/IssueStatus' + $ref: "#/components/schemas/IssueStatus" opened_at: type: string format: date-time @@ -1186,15 +1309,13 @@ components: created_at: type: string type: - type: string - enum: - - transformation + $ref: "#/components/schemas/TransformationIssueWithDataType" aggregation_keys: - $ref: '#/components/schemas/TransformationIssueAggregationKeys' + $ref: "#/components/schemas/TransformationIssueAggregationKeys" reference: - $ref: '#/components/schemas/TransformationIssueReference' + $ref: "#/components/schemas/TransformationIssueReference" data: - $ref: '#/components/schemas/TransformationIssueData' + $ref: "#/components/schemas/TransformationIssueData" required: - id - team_id @@ -1209,21 +1330,17 @@ components: - reference additionalProperties: false description: Transformation issue - IssueWithData: - anyOf: - - $ref: '#/components/schemas/DeliveryIssueWithData' - - $ref: '#/components/schemas/TransformationIssueWithData' IssueWithDataPaginatedResult: type: object properties: pagination: - $ref: '#/components/schemas/SeekPagination' + $ref: "#/components/schemas/SeekPagination" count: type: integer models: type: array items: - $ref: '#/components/schemas/IssueWithData' + $ref: "#/components/schemas/DeliveryIssueWithData" additionalProperties: false IssueCount: type: object @@ -1235,6 +1352,10 @@ components: required: - count additionalProperties: false + DeliveryIssueType: + type: string + enum: + - delivery DeliveryIssue: type: object properties: @@ -1245,7 +1366,7 @@ components: team_id: type: string status: - $ref: '#/components/schemas/IssueStatus' + $ref: "#/components/schemas/IssueStatus" opened_at: type: string format: date-time @@ -1274,13 +1395,11 @@ components: created_at: type: string type: - type: string - enum: - - delivery + $ref: "#/components/schemas/DeliveryIssueType" aggregation_keys: - $ref: '#/components/schemas/DeliveryIssueAggregationKeys' + $ref: "#/components/schemas/DeliveryIssueAggregationKeys" reference: - $ref: '#/components/schemas/DeliveryIssueReference' + $ref: "#/components/schemas/DeliveryIssueReference" required: - id - team_id @@ -1295,6 +1414,10 @@ components: - reference additionalProperties: false description: Delivery issue + TransformationIssueType: + type: string + enum: + - transformation TransformationIssue: type: object properties: @@ -1305,7 +1428,7 @@ components: team_id: type: string status: - $ref: '#/components/schemas/IssueStatus' + $ref: "#/components/schemas/IssueStatus" opened_at: type: string format: date-time @@ -1334,13 +1457,11 @@ components: created_at: type: string type: - type: string - enum: - - transformation + $ref: "#/components/schemas/TransformationIssueType" aggregation_keys: - $ref: '#/components/schemas/TransformationIssueAggregationKeys' + $ref: "#/components/schemas/TransformationIssueAggregationKeys" reference: - $ref: '#/components/schemas/TransformationIssueReference' + $ref: "#/components/schemas/TransformationIssueReference" required: - id - team_id @@ -1355,11 +1476,6 @@ components: - reference additionalProperties: false description: Transformation issue - Issue: - anyOf: - - $ref: '#/components/schemas/DeliveryIssue' - - $ref: '#/components/schemas/TransformationIssue' - description: Issue RequestRejectionCause: type: string enum: @@ -1373,6 +1489,12 @@ components: - INGESTION_FATAL - UNKNOWN nullable: true + RequestInjestPriority: + type: string + enum: + - NORMAL + - LOW + nullable: true Request: type: object properties: @@ -1394,13 +1516,9 @@ components: format: float nullable: true rejection_cause: - $ref: '#/components/schemas/RequestRejectionCause' + $ref: "#/components/schemas/RequestRejectionCause" ingest_priority: - type: string - enum: - - NORMAL - - LOW - nullable: true + $ref: "#/components/schemas/RequestInjestPriority" ingested_at: type: string format: date-time @@ -1420,7 +1538,7 @@ components: format: float nullable: true data: - $ref: '#/components/schemas/ShortEventData' + $ref: "#/components/schemas/ShortEventData" updated_at: type: string format: date-time @@ -1438,23 +1556,187 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/SeekPagination' + $ref: "#/components/schemas/SeekPagination" count: type: integer models: type: array items: - $ref: '#/components/schemas/Request' + $ref: "#/components/schemas/Request" + additionalProperties: false + RequestStatus: + type: string + enum: + - accepted + - rejected + CreateBulkRetryRequestOrderBy: + type: string + maxLength: 255 + enum: + - ingested_at + - created_at + CreateBulkRetryProperties: + properties: + id: + type: string + maxLength: 255 + status: + $ref: "#/components/schemas/RequestStatus" + rejection_cause: + type: string + maxLength: 255 + nullable: true + ignored_count: + $ref: "#/components/schemas/CreateEventsBulkAttempts" + events_count: + $ref: "#/components/schemas/CreateEventsBulkAttempts" + source_id: + type: string + maxLength: 255 + verified: + type: boolean + headers: + type: string + body: + type: string + parsed_query: + type: string + path: + type: string + created_at: + $ref: "#/components/schemas/CreateEventsBulkResponseCreatedOrLastAttemptAt" + ingested_at: + $ref: "#/components/schemas/CreateEventsBulkResponseCreatedOrLastAttemptAt" + bulk_retry_id: + type: string + maxLength: 255 + order_by: + $ref: "#/components/schemas/CreateEventsBulkResponseCreatedOrLastAttemptAt" + description: Sort key(s) + dir: + $ref: "#/components/schemas/CreateEventsBulkResponseDir" + limit: + type: integer + minimum: 0 + maximum: 255 + description: Result set size + next: + type: string + maxLength: 255 + description: The ID to provide in the query to get the next set of results + prev: + type: string + maxLength: 255 + description: The ID to provide in the query to get the previous set of results + IgnoreBulkRetryQueryProperties: + properties: + cause: + type: string + maxLength: 255 + webhook_id: + type: string + maxLength: 255 + transformation_id: + type: string + maxLength: 255 + BulkRetryRequestProperties: + properties: + include: + type: string + $ref: "#/components/schemas/QueryParametersInclude" + id: + type: string + status: + type: string + issue_id: + type: string + maxLength: 255 + webhook_id: + type: string + maxLength: 255 + destination_id: + type: string + maxLength: 255 + source_id: + type: string + maxLength: 255 + attempts: + $ref: "#/components/schemas/CreateEventsBulkAttempts" + additionalProperties: false + response_status: + type: integer + minimum: 200 + maximum: 600 + nullable: true + successful_at: + $ref: "#/components/schemas/CreateEventsBulkSuccessAt" + additionalProperties: false + nullable: true + created_at: + $ref: "#/components/schemas/CreateEventsBulkResponseCreatedOrLastAttemptAt" + additionalProperties: false + error_code: + type: string + maxLength: 255 + cli_id: + type: string + nullable: true + cli_user_id: + type: string + nullable: true + last_attempt_at: + $ref: "#/components/schemas/CreateEventsBulkResponseCreatedOrLastAttemptAt" + additionalProperties: false + nullable: true + event_data_id: + type: string + maxLength: 255 + headers: + type: string + body: + type: string + parsed_query: + type: string + bulk_retry_id: + type: string + maxLength: 255 + path: + type: string + order_by: + $ref: "#/components/schemas/CreateBulkRetryRequestOrderBy" + description: Sort key(s) + dir: + $ref: "#/components/schemas/CreateEventsBulkResponseDir" + description: Sort direction + limit: + type: integer + minimum: 0 + maximum: 255 + description: Result set size + next: + type: string + maxLength: 255 + description: The ID to provide in the query to get the next set of results + prev: + type: string + maxLength: 255 + description: The ID to provide in the query to get the previous set of results + BulkRetryRequest: + properties: + query: + type: object + $ref: "#/components/schemas/BulkRetryRequestProperties" + additionalProperties: false additionalProperties: false RetryRequest: type: object properties: request: - $ref: '#/components/schemas/Request' + $ref: "#/components/schemas/Request" events: type: array items: - $ref: '#/components/schemas/Event' + $ref: "#/components/schemas/Event" nullable: true required: - request @@ -1491,13 +1773,13 @@ components: webhook_id: type: string cause: - $ref: '#/components/schemas/IgnoredEventCause' + $ref: "#/components/schemas/IgnoredEventCause" request_id: type: string meta: anyOf: - - $ref: '#/components/schemas/FilteredMeta' - - $ref: '#/components/schemas/TransformationFailedMeta' + - $ref: "#/components/schemas/FilteredMeta" + - $ref: "#/components/schemas/TransformationFailedMeta" nullable: true updated_at: type: string @@ -1518,28 +1800,30 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/SeekPagination' + $ref: "#/components/schemas/SeekPagination" count: type: integer models: type: array items: - $ref: '#/components/schemas/IgnoredEvent' + $ref: "#/components/schemas/IgnoredEvent" additionalProperties: false RetryStrategy: type: string enum: - linear - exponential + RetryRulePropertiesType: + type: string + enum: + - retry RetryRule: type: object properties: type: - type: string - enum: - - retry + $ref: "#/components/schemas/RetryRulePropertiesType" strategy: - $ref: '#/components/schemas/RetryStrategy' + $ref: "#/components/schemas/RetryStrategy" interval: type: number format: float @@ -1557,68 +1841,116 @@ components: enum: - each_attempt - last_attempt + AlertRulePropertiesType: + type: string + enum: + - alert AlertRule: type: object properties: type: - type: string - enum: - - alert + $ref: "#/components/schemas/AlertRulePropertiesType" strategy: - $ref: '#/components/schemas/AlertStrategy' + $ref: "#/components/schemas/AlertStrategy" required: - type - strategy additionalProperties: false ConnectionFilterProperty: - anyOf: - - type: string - nullable: true - - type: number - format: float - - type: boolean - - type: object - properties: {} - additionalProperties: false + type: string nullable: true + FilterRulePropertiesType: + type: string + enum: + - filter FilterRule: type: object properties: type: + $ref: "#/components/schemas/FilterRulePropertiesType" + headers: + $ref: "#/components/schemas/ConnectionFilterProperty" + body: + $ref: "#/components/schemas/ConnectionFilterProperty" + query: + $ref: "#/components/schemas/ConnectionFilterProperty" + path: + $ref: "#/components/schemas/ConnectionFilterProperty" + required: + - type + additionalProperties: false + TransformReferencePropertiesType: + type: string + enum: + - transform + TransformReference: + type: object + properties: + type: + $ref: "#/components/schemas/TransformReferencePropertiesType" + transformation_id: + type: string + required: + - type + - transformation_id + additionalProperties: false + EmptyProperties: + properties: {} + SchemaRequestProperties: + properties: + headers: + type: object + $ref: "#/components/schemas/EmptyProperties" + additionalProperties: + type: string + body: + type: object + $ref: "#/components/schemas/EmptyProperties" + additionalProperties: false + nullable: true + path: type: string - enum: - - filter - headers: - $ref: '#/components/schemas/ConnectionFilterProperty' - body: - $ref: '#/components/schemas/ConnectionFilterProperty' + nullable: true query: - $ref: '#/components/schemas/ConnectionFilterProperty' - path: - $ref: '#/components/schemas/ConnectionFilterProperty' - required: - - type - additionalProperties: false - TransformReference: - type: object + type: string + nullable: true + parsed_query: + type: object + $ref: "#/components/schemas/EmptyProperties" + additionalProperties: false + RequestDestinationProperties: properties: - type: + name: type: string - enum: - - transform - transformation_id: + pattern: ^[A-z0-9-_]+$ + maxLength: 155 + url: type: string - required: - - type - - transformation_id - additionalProperties: false + nullable: true + cli_path: + type: string + nullable: true + rate_limit_period: + $ref: "#/components/schemas/RateLimitPeriod" + rate_limit: + $ref: "#/components/schemas/RateLimit" + path_forwarding_disabled: + type: boolean + RequestSourceProperties: + properties: + name: + type: string + pattern: ^[A-z0-9-_]+$ + maxLength: 155 + DelayRulePropertiesType: + type: string + enum: + - delay DelayRule: type: object properties: type: - type: string - enum: - - delay + $ref: "#/components/schemas/DelayRulePropertiesType" delay: type: number format: float @@ -1626,13 +1958,18 @@ components: - type - delay additionalProperties: false - Rule: - anyOf: - - $ref: '#/components/schemas/RetryRule' - - $ref: '#/components/schemas/AlertRule' - - $ref: '#/components/schemas/FilterRule' - - $ref: '#/components/schemas/TransformReference' - - $ref: '#/components/schemas/DelayRule' + RequestRulesetProperties: + properties: + name: + type: string + pattern: ^[A-z0-9-_]+$ + maxLength: 155 + rules: + type: array + items: {} + uniqueItems: true + is_team_default: + type: boolean Ruleset: type: object properties: @@ -1645,7 +1982,7 @@ components: rules: type: array items: - $ref: '#/components/schemas/Rule' + $ref: "#/components/schemas/RetryRule" is_team_default: type: boolean archived_at: @@ -1672,25 +2009,25 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/SeekPagination' + $ref: "#/components/schemas/SeekPagination" count: type: integer models: type: array items: - $ref: '#/components/schemas/Ruleset' + $ref: "#/components/schemas/Ruleset" additionalProperties: false SourcePaginatedResult: type: object properties: pagination: - $ref: '#/components/schemas/SeekPagination' + $ref: "#/components/schemas/SeekPagination" count: type: integer models: type: array items: - $ref: '#/components/schemas/Source' + $ref: "#/components/schemas/Source" additionalProperties: false TopicsValue: type: string @@ -1699,6 +2036,11 @@ components: - issue.updated - deprecated.attempt-failed - event.successful + x-enum-names: + issue.opened: issue_opened + issue.updated: issue_updated + deprecated.attempt-failed: deprecated_attempt_failed + event.successful: event_successful ToggleWebhookNotifications: type: object properties: @@ -1707,7 +2049,7 @@ components: topics: type: array items: - $ref: '#/components/schemas/TopicsValue' + $ref: "#/components/schemas/TopicsValue" nullable: true source_id: type: string @@ -1715,6 +2057,12 @@ components: - enabled - source_id additionalProperties: false + TransformationEnv: + type: object + $ref: "#/components/schemas/EmptyProperties" + additionalProperties: + type: string + nullable: true Transformation: type: object properties: @@ -1733,11 +2081,7 @@ components: type: string nullable: true env: - type: object - properties: {} - additionalProperties: - type: string - nullable: true + $ref: "#/components/schemas/TransformationEnv" updated_at: type: string format: date-time @@ -1756,14 +2100,55 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/SeekPagination' + $ref: "#/components/schemas/SeekPagination" count: type: integer models: type: array items: - $ref: '#/components/schemas/Transformation' + $ref: "#/components/schemas/Transformation" + additionalProperties: false + TransformationExecutorOutputPropertiesRequest: + type: object + properties: + headers: + anyOf: + - type: string + - type: object + $ref: "#/components/schemas/EmptyProperties" + additionalProperties: + nullable: true + nullable: true + path: + type: string + query: + anyOf: + - type: object + $ref: "#/components/schemas/EmptyProperties" + additionalProperties: false + nullable: true + - type: string + nullable: true + parsed_query: + anyOf: + - type: string + nullable: true + - type: object + $ref: "#/components/schemas/EmptyProperties" + additionalProperties: false + nullable: true + body: + anyOf: + - type: string + nullable: true + - type: object + $ref: "#/components/schemas/EmptyProperties" + additionalProperties: false + nullable: true + required: + - path additionalProperties: false + nullable: true TransformationExecutorOutput: type: object properties: @@ -1777,52 +2162,13 @@ components: type: string nullable: true log_level: - $ref: '#/components/schemas/TransformationExecutionLogLevel' + $ref: "#/components/schemas/TransformationExecutionLogLevel" request: - type: object - properties: - headers: - anyOf: - - type: string - - type: object - properties: {} - additionalProperties: - nullable: true - nullable: true - path: - type: string - query: - anyOf: - - type: object - properties: {} - additionalProperties: false - nullable: true - - type: string - nullable: true - parsed_query: - anyOf: - - type: string - nullable: true - - type: object - properties: {} - additionalProperties: false - nullable: true - body: - anyOf: - - type: string - nullable: true - - type: object - properties: {} - additionalProperties: false - nullable: true - required: - - path - additionalProperties: false - nullable: true + $ref: "#/components/schemas/TransformationExecutorOutputPropertiesRequest" console: type: array items: - $ref: '#/components/schemas/ConsoleLine' + $ref: "#/components/schemas/ConsoleLine" nullable: true required: - log_level @@ -1831,13 +2177,13 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/SeekPagination' + $ref: "#/components/schemas/SeekPagination" count: type: integer models: type: array items: - $ref: '#/components/schemas/TransformationExecution' + $ref: "#/components/schemas/TransformationExecution" additionalProperties: false Connection: type: object @@ -1849,20 +2195,20 @@ components: team_id: type: string destination: - $ref: '#/components/schemas/Destination' + $ref: "#/components/schemas/Destination" source: - $ref: '#/components/schemas/Source' + $ref: "#/components/schemas/Source" ruleset: - $ref: '#/components/schemas/Ruleset' + $ref: "#/components/schemas/Ruleset" resolved_rules: type: array items: - $ref: '#/components/schemas/Rule' + $ref: "#/components/schemas/RetryRule" nullable: true rules: type: array items: - $ref: '#/components/schemas/Rule' + $ref: "#/components/schemas/RetryRule" nullable: true archived_at: type: string @@ -1891,36 +2237,36 @@ components: type: object properties: pagination: - $ref: '#/components/schemas/SeekPagination' + $ref: "#/components/schemas/SeekPagination" count: type: integer models: type: array items: - $ref: '#/components/schemas/Connection' + $ref: "#/components/schemas/Connection" additionalProperties: false servers: - url: https://api.hookdeck.com/{version} + x-server-name: Production description: Production API variables: version: enum: - - '2023-01-01' - - '2022-11-01' - - '2022-10-01' - - '2022-07-01' - - '2022-03-01' - - '2021-08-01' - - '2020-01-01' - default: '2023-01-01' + - 2023-01-01 + - 2022-11-01 + - 2022-10-01 + - 2022-07-01 + - 2022-03-01 + - 2021-08-01 + - 2020-01-01 + default: 2023-01-01 security: - bearerAuth: [] - basicAuth: [] tags: - name: Issue Triggers - description: >- - Issue Triggers lets you setup rules that trigger issues when certain - conditions are met. + description: Issue Triggers lets you setup rules that trigger issues when + certain conditions are met. - name: Attempts description: An attempt is any request that Hookdeck makes on behalf of an event. - name: Bookmarks @@ -1930,65 +2276,60 @@ tags: - name: Events description: An event is any request that Hookdeck receives from a source. - name: Bulk retry events - description: '' + description: "" - name: Bulk retry ignored events - description: '' + description: "" - name: Integrations - description: >- - An integration configures platform-specific behaviors, such as signature - verification. + description: An integration configures platform-specific behaviors, such as + signature verification. - name: Issues - description: >- - Issues lets you track problems in your workspace and communicate + description: Issues lets you track problems in your workspace and communicate resolution steps with your team. - name: Requests description: A request represent a webhook received by Hookdeck. - name: Bulk retry requests - description: '' + description: "" - name: Rulesets - description: >- - A ruleset defines a group of rules that can be used across many + description: A ruleset defines a group of rules that can be used across many connections. - name: Sources description: A source represents any third party that sends webhooks to Hookdeck. - name: Notifications description: Notifications let your team receive alerts anytime an issue changes. - name: Transformations - description: >- - A transformation represents JavaScript code that will be executed on a - connection's requests. Transformations are applied to connections using - Rules. + description: A transformation represents JavaScript code that will be executed + on a connection's requests. Transformations are applied to connections + using Rules. - name: Connections - description: >- - A connection lets you route webhooks from a source to a destination, using - a ruleset. + description: A connection lets you route webhooks from a source to a + destination, using a ruleset. paths: /issue-triggers: get: operationId: getIssueTriggers summary: Get issue triggers - description: '' + description: "" tags: - Issue Triggers responses: - '200': + "200": description: List of issue triggers content: application/json: schema: - $ref: '#/components/schemas/IssueTrigger PaginatedResult' - '400': + $ref: "#/components/schemas/IssueTriggerPaginatedResult" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: query name: name @@ -1998,7 +2339,7 @@ paths: - in: query name: type schema: - $ref: '#/components/schemas/IssueType' + $ref: "#/components/schemas/IssueType" - in: query name: disabled_at schema: @@ -2086,31 +2427,32 @@ paths: type: string maxLength: 255 description: The ID to provide in the query to get the previous set of results + x-request-name: GetIssueTriggersRequest post: operationId: createIssueTrigger summary: Create an issue trigger - description: '' + description: "" tags: - Issue Triggers responses: - '200': + "200": description: A single issue trigger content: application/json: schema: - $ref: '#/components/schemas/IssueTrigger ' - '400': + $ref: "#/components/schemas/IssueTrigger" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: [] requestBody: required: true @@ -2120,43 +2462,44 @@ paths: type: object properties: type: - $ref: '#/components/schemas/IssueType' + $ref: "#/components/schemas/IssueType" configs: anyOf: - - $ref: '#/components/schemas/IssueTriggerDeliveryConfigs' - - $ref: '#/components/schemas/IssueTriggerTransformationConfigs' - - $ref: '#/components/schemas/IssueTriggerBackpressureConfigs' + - $ref: "#/components/schemas/IssueTriggerDeliveryConfigs" + - $ref: "#/components/schemas/IssueTriggerTransformationConfigs" + - $ref: "#/components/schemas/IssueTriggerBackpressureConfigs" name: type: string maxLength: 255 required: - type additionalProperties: false + x-request-name: CreateIssueTriggerRequest put: operationId: upsertIssueTrigger summary: Create or update an issue trigger - description: '' + description: "" tags: - Issue Triggers responses: - '200': + "200": description: A single issue trigger content: application/json: schema: - $ref: '#/components/schemas/IssueTrigger ' - '400': + $ref: "#/components/schemas/IssueTrigger" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: [] requestBody: required: true @@ -2166,69 +2509,71 @@ paths: type: object properties: type: - $ref: '#/components/schemas/IssueType' + $ref: "#/components/schemas/IssueType" configs: anyOf: - - $ref: '#/components/schemas/IssueTriggerDeliveryConfigs' - - $ref: '#/components/schemas/IssueTriggerTransformationConfigs' - - $ref: '#/components/schemas/IssueTriggerBackpressureConfigs' + - $ref: "#/components/schemas/IssueTriggerDeliveryConfigs" + - $ref: "#/components/schemas/IssueTriggerTransformationConfigs" + - $ref: "#/components/schemas/IssueTriggerBackpressureConfigs" name: type: string maxLength: 255 required: - type additionalProperties: false - /issue-triggers/{id}: + x-request-name: UpsertIssueTriggerRequest + "/issue-triggers/{id}": get: operationId: getIssueTrigger summary: Get a single issue trigger - description: '' + description: "" tags: - Issue Triggers responses: - '200': + "200": description: A single issue trigger content: application/json: schema: - $ref: '#/components/schemas/IssueTrigger ' - '404': + $ref: "#/components/schemas/IssueTrigger" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id schema: type: string required: true + x-request-name: GetIssueTriggerRequest put: operationId: updateIssueTrigger summary: Update an issue trigger - description: '' + description: "" tags: - Issue Triggers responses: - '200': + "200": description: A single issue trigger content: application/json: schema: - $ref: '#/components/schemas/IssueTrigger ' - '400': + $ref: "#/components/schemas/IssueTrigger" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id @@ -2244,9 +2589,9 @@ paths: properties: configs: anyOf: - - $ref: '#/components/schemas/IssueTriggerDeliveryConfigs' - - $ref: '#/components/schemas/IssueTriggerTransformationConfigs' - - $ref: '#/components/schemas/IssueTriggerBackpressureConfigs' + - $ref: "#/components/schemas/IssueTriggerDeliveryConfigs" + - $ref: "#/components/schemas/IssueTriggerTransformationConfigs" + - $ref: "#/components/schemas/IssueTriggerBackpressureConfigs" disabled_at: type: string format: date-time @@ -2255,109 +2600,113 @@ paths: type: string maxLength: 255 additionalProperties: false + x-request-name: UpdateIssueTriggerRequest delete: operationId: deleteIssueTrigger summary: Delete an issue trigger - description: '' + description: "" tags: - Issue Triggers responses: - '200': + "200": description: An object with deleted issue trigger's id content: application/json: schema: - $ref: '#/components/schemas/DeletedIssueTriggerResponse' - '404': + $ref: "#/components/schemas/DeletedIssueTriggerResponse" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id schema: type: string required: true - /issue-triggers/{id}/disable: + x-request-name: DeleteIssueTriggerRequest + "/issue-triggers/{id}/disable": put: operationId: disableIssueTrigger summary: Disable an issue trigger - description: '' + description: "" tags: - Issue Triggers responses: - '200': + "200": description: A single issue trigger content: application/json: schema: - $ref: '#/components/schemas/IssueTrigger ' - '404': + $ref: "#/components/schemas/IssueTrigger" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id schema: type: string required: true - /issue-triggers/{id}/enable: + x-request-name: DisableIssueTriggerRequest + "/issue-triggers/{id}/enable": put: operationId: enableIssueTrigger summary: Enable an issue trigger - description: '' + description: "" tags: - Issue Triggers responses: - '200': + "200": description: A single issue trigger content: application/json: schema: - $ref: '#/components/schemas/IssueTrigger ' - '404': + $ref: "#/components/schemas/IssueTrigger" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id schema: type: string required: true + x-request-name: EnableIssueTriggerRequest /attempts: get: operationId: getAttempts summary: Get attempts - description: '' + description: "" tags: - Attempts responses: - '200': + "200": description: List of attempts content: application/json: schema: - $ref: '#/components/schemas/EventAttemptPaginatedResult' - '400': + $ref: "#/components/schemas/EventAttemptPaginatedResult" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: query name: event_id @@ -2422,58 +2771,60 @@ paths: type: string maxLength: 255 description: The ID to provide in the query to get the previous set of results - /attempts/{id}: + x-request-name: GetAttemptsRequest + "/attempts/{id}": get: operationId: getAttempt summary: Get a single attempt - description: '' + description: "" tags: - Attempts responses: - '200': + "200": description: A single attempt content: application/json: schema: - $ref: '#/components/schemas/EventAttempt' - '404': + $ref: "#/components/schemas/EventAttempt" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id schema: type: string required: true + x-request-name: GetAttemptRequest /bookmarks: get: operationId: getBookmarks summary: Get bookmarks - description: '' + description: "" tags: - Bookmarks responses: - '200': + "200": description: List of bookmarks content: application/json: schema: - $ref: '#/components/schemas/BookmarkPaginatedResult' - '400': + $ref: "#/components/schemas/BookmarkPaginatedResult" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: query name: id @@ -2612,31 +2963,32 @@ paths: type: string maxLength: 255 description: The ID to provide in the query to get the previous set of results + x-request-name: GetBookmarksRequest post: operationId: createBookmark summary: Create a bookmark - description: '' + description: "" tags: - Bookmarks responses: - '200': + "200": description: A single bookmark content: application/json: schema: - $ref: '#/components/schemas/Bookmark' - '400': + $ref: "#/components/schemas/Bookmark" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: [] requestBody: required: true @@ -2663,63 +3015,65 @@ paths: - webhook_id - label additionalProperties: false - /bookmarks/{id}: + x-request-name: CreateBookmarkRequest + "/bookmarks/{id}": get: operationId: getBookmark summary: Get a single bookmark - description: '' + description: "" tags: - Bookmarks responses: - '200': + "200": description: A single bookmark content: application/json: schema: - $ref: '#/components/schemas/Bookmark' - '404': + $ref: "#/components/schemas/Bookmark" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id schema: type: string required: true + x-request-name: GetBookmarkRequest put: operationId: updateBookmark summary: Update a bookmark - description: '' + description: "" tags: - Bookmarks responses: - '200': + "200": description: A single bookmark content: application/json: schema: - $ref: '#/components/schemas/Bookmark' - '400': + $ref: "#/components/schemas/Bookmark" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '404': + $ref: "#/components/schemas/APIErrorResponse" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id @@ -2747,63 +3101,65 @@ paths: pattern: ^[A-z0-9-_]+$ maxLength: 155 additionalProperties: false + x-request-name: UpdateBookmarkRequest delete: operationId: deleteBookmark summary: Delete a bookmark - description: '' + description: "" tags: - Bookmarks responses: - '200': + "200": description: An object with deleted bookmark's id content: application/json: schema: - $ref: '#/components/schemas/DeletedBookmarkResponse' - '404': + $ref: "#/components/schemas/DeletedBookmarkResponse" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id schema: type: string required: true - /bookmarks/{id}/trigger: + x-request-name: DeleteBookmarkRequest + "/bookmarks/{id}/trigger": post: operationId: triggerBookmark summary: Trigger a bookmark - description: '' + description: "" tags: - Bookmarks responses: - '200': + "200": description: Array of created events content: application/json: schema: - $ref: '#/components/schemas/EventArray' - '400': + $ref: "#/components/schemas/EventArray" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '404': + $ref: "#/components/schemas/APIErrorResponse" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id @@ -2818,37 +3174,35 @@ paths: type: object properties: target: - type: string - enum: - - http - - cli + $ref: "#/components/schemas/BookmarkTriggerPropertiesTarget" additionalProperties: false + x-request-name: TriggerBookmarkRequest /destinations: get: operationId: getDestinations summary: Get destinations - description: '' + description: "" tags: - Destinations responses: - '200': + "200": description: List of destinations content: application/json: schema: - $ref: '#/components/schemas/DestinationPaginatedResult' - '400': + $ref: "#/components/schemas/DestinationPaginatedResult" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: query name: id @@ -3005,31 +3359,32 @@ paths: type: string maxLength: 255 description: The ID to provide in the query to get the previous set of results + x-request-name: GetDestinationsRequest post: operationId: createDestination summary: Create a destination - description: '' + description: "" tags: - Destinations responses: - '200': + "200": description: A single destination content: application/json: schema: - $ref: '#/components/schemas/Destination' - '400': + $ref: "#/components/schemas/Destination" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: [] requestBody: required: true @@ -3049,52 +3404,40 @@ paths: type: string nullable: true rate_limit_period: - type: string - enum: - - second - - minute - - hour + $ref: "#/components/schemas/RateLimitPeriod" rate_limit: - type: integer - minimum: 1 - oneOf: - - type: integer - maximum: 100 - - type: integer - maximum: 6000 - - type: integer - maximum: 360000 - nullable: true + $ref: "#/components/schemas/RateLimit" path_forwarding_disabled: type: boolean required: - name additionalProperties: false + x-request-name: CreateDestinationRequest put: operationId: upsertDestination summary: Update or create a destination - description: '' + description: "" tags: - Destinations responses: - '200': + "200": description: A single destination content: application/json: schema: - $ref: '#/components/schemas/Destination' - '400': + $ref: "#/components/schemas/Destination" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: [] requestBody: required: true @@ -3114,84 +3457,73 @@ paths: type: string nullable: true rate_limit_period: - type: string - enum: - - second - - minute - - hour + $ref: "#/components/schemas/RateLimitPeriod" rate_limit: - type: integer - minimum: 1 - oneOf: - - type: integer - maximum: 100 - - type: integer - maximum: 6000 - - type: integer - maximum: 360000 - nullable: true + $ref: "#/components/schemas/RateLimit" path_forwarding_disabled: type: boolean required: - name additionalProperties: false - /destinations/{id}: + x-request-name: UpsertDestinationRequest + "/destinations/{id}": get: operationId: getDestination summary: Get a destination - description: '' + description: "" tags: - Destinations responses: - '200': + "200": description: A single destination content: application/json: schema: - $ref: '#/components/schemas/Destination' - '404': + $ref: "#/components/schemas/Destination" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id schema: type: string required: true + x-request-name: GetDestinationRequest put: operationId: updateDestination summary: Update a destination - description: '' + description: "" tags: - Destinations responses: - '200': + "200": description: A single destination content: application/json: schema: - $ref: '#/components/schemas/Destination' - '400': + $ref: "#/components/schemas/Destination" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '404': + $ref: "#/components/schemas/APIErrorResponse" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id @@ -3220,101 +3552,99 @@ paths: minimum: 1 nullable: true rate_limit_period: - type: string - enum: - - second - - minute - - hour + $ref: "#/components/schemas/RateLimitPeriod" archived_at: nullable: true path_forwarding_disabled: type: boolean additionalProperties: false - /destinations/{id}/archive: + x-request-name: UpdateDestinationRequest + "/destinations/{id}/archive": put: operationId: archiveDestination summary: Archive a destination - description: '' + description: "" tags: - Destinations responses: - '200': + "200": description: A single destination content: application/json: schema: - $ref: '#/components/schemas/Destination' - '404': + $ref: "#/components/schemas/Destination" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id schema: type: string required: true - /destinations/{id}/unarchive: + x-request-name: ArchiveDestinationRequest + "/destinations/{id}/unarchive": put: operationId: unarchiveDestination summary: Unarchive a destination - description: '' + description: "" tags: - Destinations responses: - '200': + "200": description: A single destination content: application/json: schema: - $ref: '#/components/schemas/Destination' - '404': + $ref: "#/components/schemas/Destination" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id schema: type: string required: true + x-request-name: UnarchiveDestinationRequest /events: get: operationId: getEvents summary: Get events - description: '' + description: "" tags: - Events responses: - '200': + "200": description: List of events content: application/json: schema: - $ref: '#/components/schemas/EventPaginatedResult' - '400': + $ref: "#/components/schemas/EventPaginatedResult" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: query name: include schema: type: string - enum: - - data + $ref: "#/components/schemas/QueryParametersInclude" - in: query name: id schema: @@ -3582,7 +3912,7 @@ paths: anyOf: - type: string - type: object - properties: {} + $ref: "#/components/schemas/EmptyProperties" additionalProperties: false - in: query name: body @@ -3590,7 +3920,7 @@ paths: anyOf: - type: string - type: object - properties: {} + $ref: "#/components/schemas/EmptyProperties" additionalProperties: false - in: query name: parsed_query @@ -3598,7 +3928,7 @@ paths: anyOf: - type: string - type: object - properties: {} + $ref: "#/components/schemas/EmptyProperties" additionalProperties: false - in: query name: bulk_retry_id @@ -3671,110 +4001,114 @@ paths: type: string maxLength: 255 description: The ID to provide in the query to get the previous set of results - /events/{id}: + x-request-name: GetEventsRequest + "/events/{id}": get: operationId: getEvent summary: Get an event - description: '' + description: "" tags: - Events responses: - '200': + "200": description: A single event content: application/json: schema: - $ref: '#/components/schemas/Event' - '404': + $ref: "#/components/schemas/Event" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id schema: type: string required: true - /events/{id}/retry: + x-request-name: GetEventRequest + "/events/{id}/retry": post: operationId: retryEvent summary: Retry an event - description: '' + description: "" tags: - Events responses: - '200': + "200": description: Retried event with event attempt content: application/json: schema: - $ref: '#/components/schemas/RetriedEvent' - '404': + $ref: "#/components/schemas/RetriedEvent" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id schema: type: string required: true - /events/{id}/mute: + x-request-name: RetryEventRequest + "/events/{id}/mute": put: operationId: muteEvent summary: Mute an event - description: '' + description: "" tags: - Events responses: - '200': + "200": description: A single event content: application/json: schema: - $ref: '#/components/schemas/Event' - '404': + $ref: "#/components/schemas/Event" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id schema: type: string required: true + x-request-name: MuteEventRequest /bulk/events/retry: get: operationId: getEventBulkRetries summary: Get events bulk retries - description: '' + description: "" tags: - Bulk retry events responses: - '200': + "200": description: List of events bulk retries content: application/json: schema: - $ref: '#/components/schemas/BatchOperationPaginatedResult' - '400': + $ref: "#/components/schemas/BatchOperationPaginatedResult" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: query name: cancelled_at @@ -4130,19 +4464,19 @@ paths: anyOf: - type: string - type: object - properties: {} + $ref: "#/components/schemas/EmptyProperties" additionalProperties: false body: anyOf: - type: string - type: object - properties: {} + $ref: "#/components/schemas/EmptyProperties" additionalProperties: false parsed_query: anyOf: - type: string - type: object - properties: {} + $ref: "#/components/schemas/EmptyProperties" additionalProperties: false bulk_retry_id: anyOf: @@ -4200,9 +4534,7 @@ paths: prev: type: string maxLength: 255 - description: >- - The ID to provide in the query to get the previous set of - results + description: The ID to provide in the query to get the previous set of results additionalProperties: false - in: query name: query_partial_match @@ -4261,384 +4593,66 @@ paths: type: string maxLength: 255 description: The ID to provide in the query to get the previous set of results + x-request-name: GetEventBulkRetriesRequest post: operationId: createEventBulkRetry summary: Create an events bulk retry - description: '' + description: "" tags: - Bulk retry events responses: - '200': + "200": description: A single events bulk retry content: application/json: schema: - $ref: '#/components/schemas/BatchOperation' - '400': + $ref: "#/components/schemas/BatchOperation" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: [] requestBody: required: true content: application/json: schema: - type: object - properties: - query: - type: object - properties: - include: - type: string - enum: - - data - id: - anyOf: - - type: string - maxLength: 255 - - type: array - items: - type: string - maxLength: 255 - status: - anyOf: - - type: string - maxLength: 255 - enum: - - SCHEDULED - - QUEUED - - HOLD - - FAILED - - SUCCESSFUL - - type: array - items: - type: string - maxLength: 255 - enum: - - SCHEDULED - - QUEUED - - HOLD - - FAILED - - SUCCESSFUL - issue_id: - anyOf: - - type: string - maxLength: 255 - - type: array - items: - type: string - maxLength: 255 - webhook_id: - anyOf: - - type: string - maxLength: 255 - - type: array - items: - type: string - maxLength: 255 - destination_id: - anyOf: - - type: string - maxLength: 255 - - type: array - items: - type: string - maxLength: 255 - source_id: - anyOf: - - type: string - maxLength: 255 - - type: array - items: - type: string - maxLength: 255 - attempts: - anyOf: - - type: integer - minimum: 0 - - type: object - properties: - ge: - type: integer - minimum: 0 - gte: - type: integer - minimum: 0 - le: - type: integer - minimum: 0 - lte: - type: integer - minimum: 0 - any: - type: boolean - contains: - type: integer - minimum: 0 - additionalProperties: false - response_status: - anyOf: - - anyOf: - - type: integer - minimum: 200 - maximum: 600 - - type: object - properties: - ge: - type: integer - minimum: 200 - maximum: 600 - gte: - type: integer - minimum: 200 - maximum: 600 - le: - type: integer - minimum: 200 - maximum: 600 - lte: - type: integer - minimum: 200 - maximum: 600 - any: - type: boolean - contains: - type: integer - minimum: 200 - maximum: 600 - additionalProperties: false - - type: array - items: - type: integer - minimum: 200 - maximum: 600 - nullable: true - successful_at: - anyOf: - - type: string - format: date-time - - type: object - properties: - ge: - type: string - format: date-time - gte: - type: string - format: date-time - le: - type: string - format: date-time - lte: - type: string - format: date-time - any: - type: boolean - contains: - type: string - format: date-time - additionalProperties: false - nullable: true - created_at: - anyOf: - - type: string - format: date-time - - type: object - properties: - ge: - type: string - format: date-time - gte: - type: string - format: date-time - le: - type: string - format: date-time - lte: - type: string - format: date-time - any: - type: boolean - contains: - type: string - format: date-time - additionalProperties: false - error_code: - anyOf: - - type: string - maxLength: 255 - - type: array - items: - type: string - maxLength: 255 - cli_id: - anyOf: - - anyOf: - - type: string - - type: object - properties: - any: - type: boolean - additionalProperties: false - - type: array - items: - type: string - nullable: true - cli_user_id: - anyOf: - - type: string - - type: array - items: - type: string - nullable: true - last_attempt_at: - anyOf: - - type: string - format: date-time - - type: object - properties: - ge: - type: string - format: date-time - gte: - type: string - format: date-time - le: - type: string - format: date-time - lte: - type: string - format: date-time - any: - type: boolean - contains: - type: string - format: date-time - additionalProperties: false - nullable: true - event_data_id: - anyOf: - - type: string - maxLength: 255 - - type: array - items: - type: string - maxLength: 255 - headers: - anyOf: - - type: string - - type: object - properties: {} - additionalProperties: false - body: - anyOf: - - type: string - - type: object - properties: {} - additionalProperties: false - parsed_query: - anyOf: - - type: string - - type: object - properties: {} - additionalProperties: false - bulk_retry_id: - anyOf: - - type: string - maxLength: 255 - - type: array - items: - type: string - maxLength: 255 - path: - type: string - order_by: - anyOf: - - type: string - maxLength: 255 - enum: - - last_attempt_at - - next_attempt_at - - created_at - - type: array - items: - type: string - maxLength: 255 - enum: - - last_attempt_at - - next_attempt_at - - created_at - minItems: 2 - maxItems: 2 - description: Sort key(s) - dir: - anyOf: - - type: string - enum: - - asc - - desc - - type: array - items: - type: string - enum: - - asc - - desc - minItems: 2 - maxItems: 2 - description: Sort direction - limit: - type: integer - minimum: 0 - maximum: 255 - description: Result set size - next: - type: string - maxLength: 255 - description: >- - The ID to provide in the query to get the next set of - results - prev: - type: string - maxLength: 255 - description: >- - The ID to provide in the query to get the previous set - of results - additionalProperties: false - additionalProperties: false + $ref: "#/components/schemas/BulkRetryRequest" + x-request-name: CreateEventBulkRetryRequest /bulk/events/retry/plan: get: operationId: generateEventBulkRetryPlan summary: Generate an events bulk retry plan - description: '' + description: "" tags: - Bulk retry events responses: - '200': + "200": description: Events bulk retry plan content: application/json: schema: - $ref: '#/components/schemas/BatchOperationPlan' - '400': + $ref: "#/components/schemas/BatchOperationPlan" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: query name: query @@ -4884,19 +4898,19 @@ paths: anyOf: - type: string - type: object - properties: {} + $ref: "#/components/schemas/EmptyProperties" additionalProperties: false body: anyOf: - type: string - type: object - properties: {} + $ref: "#/components/schemas/EmptyProperties" additionalProperties: false parsed_query: anyOf: - type: string - type: object - properties: {} + $ref: "#/components/schemas/EmptyProperties" additionalProperties: false bulk_retry_id: anyOf: @@ -4954,88 +4968,89 @@ paths: prev: type: string maxLength: 255 - description: >- - The ID to provide in the query to get the previous set of - results + description: The ID to provide in the query to get the previous set of results additionalProperties: false - /bulk/events/retry/{id}: + x-request-name: GenerateEventBulkRetryPlanRequest + "/bulk/events/retry/{id}": get: operationId: getEventBulkRetry summary: Get an events bulk retry - description: '' + description: "" tags: - Bulk retry events responses: - '200': + "200": description: A single events bulk retry content: application/json: schema: - $ref: '#/components/schemas/BatchOperation' - '404': + $ref: "#/components/schemas/BatchOperation" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id schema: type: string required: true - /bulk/events/retry/{id}/cancel: + x-request-name: GetEventBulkRetryRequest + "/bulk/events/retry/{id}/cancel": post: operationId: cancelEventBulkRetry summary: Cancel an events bulk retry - description: '' + description: "" tags: - Bulk retry events responses: - '200': + "200": description: A single events bulk retry content: application/json: schema: - $ref: '#/components/schemas/BatchOperation' - '404': + $ref: "#/components/schemas/BatchOperation" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id schema: type: string required: true + x-request-name: CancelEventBulkRetryRequest /bulk/ignored-events/retry: get: operationId: getIgnoredEventBulkRetries summary: Get ignored events bulk retries - description: '' + description: "" tags: - Bulk retry ignored events responses: - '200': + "200": description: List of ignored events bulk retries content: application/json: schema: - $ref: '#/components/schemas/BatchOperationPaginatedResult' - '400': + $ref: "#/components/schemas/BatchOperationPaginatedResult" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: query name: cancelled_at @@ -5229,31 +5244,32 @@ paths: type: string maxLength: 255 description: The ID to provide in the query to get the previous set of results + x-request-name: GetIgnoredEventBulkRetriesRequest post: operationId: createIgnoredEventBulkRetry summary: Create an ignored events bulk retry - description: '' + description: "" tags: - Bulk retry ignored events responses: - '200': + "200": description: A single ignored events bulk retry content: application/json: schema: - $ref: '#/components/schemas/BatchOperation' - '400': + $ref: "#/components/schemas/BatchOperation" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: [] requestBody: required: true @@ -5264,54 +5280,36 @@ paths: properties: query: type: object - properties: - cause: - anyOf: - - type: string - maxLength: 255 - - type: array - items: - type: string - maxLength: 255 - webhook_id: - anyOf: - - type: string - maxLength: 255 - - type: array - items: - type: string - maxLength: 255 - transformation_id: - type: string - maxLength: 255 + $ref: "#/components/schemas/IgnoreBulkRetryQueryProperties" additionalProperties: false additionalProperties: false + x-request-name: CreateIgnoredEventBulkRetryRequest /bulk/ignored-events/retry/plan: get: operationId: generateIgnoredEventBulkRetryPlan summary: Generate an ignored events bulk retry plan - description: '' + description: "" tags: - Bulk retry ignored events responses: - '200': + "200": description: Ignored events bulk retry plan content: application/json: schema: - $ref: '#/components/schemas/BatchOperationPlan' - '400': + $ref: "#/components/schemas/BatchOperationPlan" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: query name: query @@ -5338,84 +5336,87 @@ paths: type: string maxLength: 255 additionalProperties: false - /bulk/ignored-events/retry/{id}: + x-request-name: GenerateIgnoredEventBulkRetryPlanRequest + "/bulk/ignored-events/retry/{id}": get: operationId: getIgnoredEventBulkRetry summary: Get an ignored events bulk retry - description: '' + description: "" tags: - Bulk retry ignored events responses: - '200': + "200": description: A single ignored events bulk retry content: application/json: schema: - $ref: '#/components/schemas/BatchOperation' - '404': + $ref: "#/components/schemas/BatchOperation" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id schema: type: string required: true - /bulk/ignored-events/retry/{id}/cancel: + x-request-name: GetIgnoredEventBulkRetryRequest + "/bulk/ignored-events/retry/{id}/cancel": post: operationId: cancelIgnoredEventBulkRetry summary: Cancel an ignored events bulk retry - description: '' + description: "" tags: - Bulk retry ignored events responses: - '200': + "200": description: A single ignored events bulk retry content: application/json: schema: - $ref: '#/components/schemas/BatchOperation' - '404': + $ref: "#/components/schemas/BatchOperation" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id schema: type: string required: true + x-request-name: CancelIgnoredEventBulkRetryRequest /integrations: get: operationId: getIntegrations summary: Get integrations - description: '' + description: "" tags: - Integrations responses: - '200': + "200": description: List of integrations content: application/json: schema: - $ref: '#/components/schemas/IntegrationPaginatedResult' - '400': + $ref: "#/components/schemas/IntegrationPaginatedResult" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: query name: label @@ -5424,32 +5425,33 @@ paths: - in: query name: provider schema: - $ref: '#/components/schemas/IntegrationProvider' + $ref: "#/components/schemas/IntegrationProvider" + x-request-name: GetIntegrationsRequest post: operationId: createIntegration summary: Create an integration - description: '' + description: "" tags: - Integrations responses: - '200': + "200": description: A single integration content: application/json: schema: - $ref: '#/components/schemas/Integration' - '400': + $ref: "#/components/schemas/Integration" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: [] requestBody: required: true @@ -5461,11 +5463,9 @@ paths: label: type: string configs: - type: object - properties: {} - additionalProperties: false + $ref: "#/components/schemas/CreateIntegrationConfig" provider: - $ref: '#/components/schemas/IntegrationProvider' + $ref: "#/components/schemas/IntegrationProvider" features: type: array items: @@ -5476,63 +5476,65 @@ paths: - provider - features additionalProperties: false - /integrations/{id}: + x-request-name: CreateIntegrationRequest + "/integrations/{id}": get: operationId: getIntegration summary: Get an integration - description: '' + description: "" tags: - Integrations responses: - '200': + "200": description: A single integration content: application/json: schema: - $ref: '#/components/schemas/Integration' - '404': + $ref: "#/components/schemas/Integration" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id schema: type: string required: true + x-request-name: GetIntegrationRequest put: operationId: updateIntegration summary: Update an integration - description: '' + description: "" tags: - Integrations responses: - '200': + "200": description: A single integration content: application/json: schema: - $ref: '#/components/schemas/Integration' - '400': + $ref: "#/components/schemas/Integration" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '404': + $ref: "#/components/schemas/APIErrorResponse" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id @@ -5549,9 +5551,7 @@ paths: label: type: string configs: - type: object - properties: {} - additionalProperties: false + $ref: "#/components/schemas/CreateIntegrationConfig" provider: type: string features: @@ -5561,57 +5561,59 @@ paths: required: - features additionalProperties: false + x-request-name: UpdateIntegrationRequest delete: operationId: deleteIntegration summary: Delete an integration - description: '' + description: "" tags: - Integrations responses: - '200': + "200": description: An object with deleted integration id content: application/json: schema: - $ref: '#/components/schemas/DeletedIntegration' - '404': + $ref: "#/components/schemas/DeletedIntegration" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id schema: type: string required: true - /integrations/{id}/attach/{source_id}: + x-request-name: DeleteIntegrationRequest + "/integrations/{id}/attach/{source_id}": put: operationId: attachIntegrationToSource summary: Attach an integration to a source - description: '' + description: "" tags: - Integrations responses: - '200': + "200": description: Attach operation success status content: application/json: schema: - $ref: '#/components/schemas/AttachedIntegrationToSource' - '400': + $ref: "#/components/schemas/AttachedIntegrationToSource" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '404': + $ref: "#/components/schemas/APIErrorResponse" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id @@ -5623,32 +5625,33 @@ paths: schema: type: string required: true - /integrations/{id}/detach/{source_id}: + x-request-name: AttachIntegrationToSourceRequest + "/integrations/{id}/detach/{source_id}": put: operationId: detachIntegrationToSource summary: Detach an integration from a source - description: '' + description: "" tags: - Integrations responses: - '200': + "200": description: Detach operation success status content: application/json: schema: - $ref: '#/components/schemas/DetachedIntegrationFromSource' - '400': + $ref: "#/components/schemas/DetachedIntegrationFromSource" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '404': + $ref: "#/components/schemas/APIErrorResponse" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id @@ -5660,32 +5663,33 @@ paths: schema: type: string required: true + x-request-name: DetachIntegrationToSourceRequest /issues: get: operationId: getIssues summary: Get issues - description: '' + description: "" tags: - Issues responses: - '200': + "200": description: List of issues content: application/json: schema: - $ref: '#/components/schemas/IssueWithDataPaginatedResult' - '400': + $ref: "#/components/schemas/IssueWithDataPaginatedResult" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: query name: id @@ -5786,10 +5790,10 @@ paths: format: float error_code: anyOf: - - $ref: '#/components/schemas/AttemptErrorCodes' + - $ref: "#/components/schemas/AttemptErrorCodes" - type: array items: - $ref: '#/components/schemas/AttemptErrorCodes' + $ref: "#/components/schemas/AttemptErrorCodes" additionalProperties: false description: Filter by aggregation keys - in: query @@ -5985,26 +5989,27 @@ paths: type: string maxLength: 255 description: The ID to provide in the query to get the previous set of results + x-request-name: GetIssuesRequest /issues/count: get: operationId: getIssueCount summary: Get the number of issues - description: '' + description: "" tags: - Issues responses: - '200': + "200": description: Issue count content: application/json: schema: - $ref: '#/components/schemas/IssueCount' - '422': + $ref: "#/components/schemas/IssueCount" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: query name: id @@ -6105,10 +6110,10 @@ paths: format: float error_code: anyOf: - - $ref: '#/components/schemas/AttemptErrorCodes' + - $ref: "#/components/schemas/AttemptErrorCodes" - type: array items: - $ref: '#/components/schemas/AttemptErrorCodes' + $ref: "#/components/schemas/AttemptErrorCodes" additionalProperties: false description: Filter by aggregation keys - in: query @@ -6304,57 +6309,59 @@ paths: type: string maxLength: 255 description: The ID to provide in the query to get the previous set of results - /issues/{id}: + x-request-name: GetIssueCountRequest + "/issues/{id}": get: operationId: getIssue summary: Get a single issue - description: '' + description: "" tags: - Issues responses: - '200': + "200": description: A single issue content: application/json: schema: - $ref: '#/components/schemas/IssueWithData' - '404': + $ref: "#/components/schemas/DeliveryIssueWithData" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id schema: type: string required: true + x-request-name: GetIssueRequest put: operationId: updateIssue summary: Update issue - description: '' + description: "" tags: - Issues responses: - '200': + "200": description: Updated issue content: application/json: schema: - $ref: '#/components/schemas/Issue' - '400': + $ref: "#/components/schemas/DeliveryIssue" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id @@ -6369,67 +6376,63 @@ paths: type: object properties: status: - type: string - enum: - - OPENED - - IGNORED - - ACKNOWLEDGED - - RESOLVED - description: New status + $ref: "#/components/schemas/UpdateIssueRequestBodyStatus" required: - status additionalProperties: false + x-request-name: UpdateIssueRequest delete: operationId: dismissIssue summary: Dismiss an issue - description: '' + description: "" tags: - Issues responses: - '200': + "200": description: Dismissed issue content: application/json: schema: - $ref: '#/components/schemas/Issue' - '404': + $ref: "#/components/schemas/DeliveryIssue" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id schema: type: string required: true + x-request-name: DismissIssueRequest /requests: get: operationId: getRequests summary: Get requests - description: '' + description: "" tags: - Requests responses: - '200': + "200": description: List of requests content: application/json: schema: - $ref: '#/components/schemas/RequestPaginatedResult' - '400': + $ref: "#/components/schemas/RequestPaginatedResult" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: query name: id @@ -6444,10 +6447,7 @@ paths: - in: query name: status schema: - type: string - enum: - - accepted - - rejected + $ref: "#/components/schemas/RequestStatus" - in: query name: rejection_cause schema: @@ -6562,7 +6562,7 @@ paths: anyOf: - type: string - type: object - properties: {} + $ref: "#/components/schemas/EmptyProperties" additionalProperties: false - in: query name: body @@ -6570,7 +6570,7 @@ paths: anyOf: - type: string - type: object - properties: {} + $ref: "#/components/schemas/EmptyProperties" additionalProperties: false - in: query name: parsed_query @@ -6578,7 +6578,7 @@ paths: anyOf: - type: string - type: object - properties: {} + $ref: "#/components/schemas/EmptyProperties" additionalProperties: false - in: query name: path @@ -6701,64 +6701,66 @@ paths: type: string maxLength: 255 description: The ID to provide in the query to get the previous set of results - /requests/{id}: + x-request-name: GetRequestsRequest + "/requests/{id}": get: operationId: getRequest summary: Get a request - description: '' + description: "" tags: - Requests responses: - '200': + "200": description: A single request content: application/json: schema: - $ref: '#/components/schemas/Request' - '404': + $ref: "#/components/schemas/Request" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id schema: type: string required: true - /requests/{id}/retry: + x-request-name: GetRequestRequest + "/requests/{id}/retry": post: operationId: retryRequest summary: Retry a request - description: '' + description: "" tags: - Requests responses: - '200': + "200": description: Retry request operation result content: application/json: schema: - $ref: '#/components/schemas/RetryRequest' - '400': + $ref: "#/components/schemas/RetryRequest" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '404': + $ref: "#/components/schemas/APIErrorResponse" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id @@ -6780,45 +6782,45 @@ paths: required: - webhook_ids additionalProperties: false - /requests/{id}/events: + x-request-name: RetryRequestRequest + "/requests/{id}/events": get: operationId: getRequestEvents summary: Get request events - description: '' + description: "" tags: - Requests responses: - '200': + "200": description: List of events content: application/json: schema: - $ref: '#/components/schemas/EventPaginatedResult' - '400': + $ref: "#/components/schemas/EventPaginatedResult" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '404': + $ref: "#/components/schemas/APIErrorResponse" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: query name: include schema: type: string - enum: - - data + $ref: "#/components/schemas/QueryParametersInclude" - in: query name: id schema: @@ -7086,7 +7088,7 @@ paths: anyOf: - type: string - type: object - properties: {} + $ref: "#/components/schemas/EmptyProperties" additionalProperties: false - in: query name: body @@ -7094,7 +7096,7 @@ paths: anyOf: - type: string - type: object - properties: {} + $ref: "#/components/schemas/EmptyProperties" additionalProperties: false - in: query name: parsed_query @@ -7102,7 +7104,7 @@ paths: anyOf: - type: string - type: object - properties: {} + $ref: "#/components/schemas/EmptyProperties" additionalProperties: false - in: query name: bulk_retry_id @@ -7180,38 +7182,39 @@ paths: schema: type: string required: true - /requests/{id}/ignored_events: + x-request-name: GetRequestEventsRequest + "/requests/{id}/ignored_events": get: operationId: getRequestIgnoredEvents summary: Get request ignored events - description: '' + description: "" tags: - Requests responses: - '200': + "200": description: List of ignored events content: application/json: schema: - $ref: '#/components/schemas/IgnoredEventPaginatedResult' - '400': + $ref: "#/components/schemas/IgnoredEventPaginatedResult" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '404': + $ref: "#/components/schemas/APIErrorResponse" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: query name: id @@ -7281,32 +7284,33 @@ paths: schema: type: string required: true + x-request-name: GetRequestIgnoredEventsRequest /bulk/requests/retry: get: operationId: getRequestBulkRetries summary: Get request bulk retries - description: '' + description: "" tags: - Bulk retry requests responses: - '200': + "200": description: List of request bulk retries content: application/json: schema: - $ref: '#/components/schemas/BatchOperationPaginatedResult' - '400': + $ref: "#/components/schemas/BatchOperationPaginatedResult" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: query name: cancelled_at @@ -7538,19 +7542,19 @@ paths: anyOf: - type: string - type: object - properties: {} + $ref: "#/components/schemas/EmptyProperties" additionalProperties: false body: anyOf: - type: string - type: object - properties: {} + $ref: "#/components/schemas/EmptyProperties" additionalProperties: false parsed_query: anyOf: - type: string - type: object - properties: {} + $ref: "#/components/schemas/EmptyProperties" additionalProperties: false path: type: string @@ -7654,9 +7658,7 @@ paths: prev: type: string maxLength: 255 - description: >- - The ID to provide in the query to get the previous set of - results + description: The ID to provide in the query to get the previous set of results additionalProperties: false - in: query name: query_partial_match @@ -7715,31 +7717,32 @@ paths: type: string maxLength: 255 description: The ID to provide in the query to get the previous set of results + x-request-name: GetRequestBulkRetriesRequest post: operationId: createRequestBulkRetry summary: Create a requests bulk retry - description: '' + description: "" tags: - Bulk retry requests responses: - '200': + "200": description: A single requests bulk retry content: application/json: schema: - $ref: '#/components/schemas/BatchOperation' - '400': + $ref: "#/components/schemas/BatchOperation" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: [] requestBody: required: true @@ -7750,271 +7753,36 @@ paths: properties: query: type: object - properties: - id: - anyOf: - - type: string - maxLength: 255 - - type: array - items: - type: string - maxLength: 255 - status: - type: string - enum: - - accepted - - rejected - rejection_cause: - anyOf: - - anyOf: - - type: string - maxLength: 255 - - type: object - properties: - ge: - type: string - maxLength: 255 - gte: - type: string - maxLength: 255 - le: - type: string - maxLength: 255 - lte: - type: string - maxLength: 255 - any: - type: boolean - contains: - type: string - maxLength: 255 - additionalProperties: false - - type: array - items: - type: string - maxLength: 255 - nullable: true - ignored_count: - anyOf: - - anyOf: - - type: integer - minimum: 0 - - type: object - properties: - ge: - type: integer - minimum: 0 - gte: - type: integer - minimum: 0 - le: - type: integer - minimum: 0 - lte: - type: integer - minimum: 0 - any: - type: boolean - contains: - type: integer - minimum: 0 - additionalProperties: false - - type: array - items: - type: integer - minimum: 0 - events_count: - anyOf: - - anyOf: - - type: integer - minimum: 0 - - type: object - properties: - ge: - type: integer - minimum: 0 - gte: - type: integer - minimum: 0 - le: - type: integer - minimum: 0 - lte: - type: integer - minimum: 0 - any: - type: boolean - contains: - type: integer - minimum: 0 - additionalProperties: false - - type: array - items: - type: integer - minimum: 0 - source_id: - anyOf: - - type: string - maxLength: 255 - - type: array - items: - type: string - maxLength: 255 - verified: - type: boolean - headers: - anyOf: - - type: string - - type: object - properties: {} - additionalProperties: false - body: - anyOf: - - type: string - - type: object - properties: {} - additionalProperties: false - parsed_query: - anyOf: - - type: string - - type: object - properties: {} - additionalProperties: false - path: - type: string - created_at: - anyOf: - - type: string - format: date-time - - type: object - properties: - ge: - type: string - format: date-time - gte: - type: string - format: date-time - le: - type: string - format: date-time - lte: - type: string - format: date-time - any: - type: boolean - contains: - type: string - format: date-time - additionalProperties: false - ingested_at: - anyOf: - - type: string - format: date-time - - type: object - properties: - ge: - type: string - format: date-time - gte: - type: string - format: date-time - le: - type: string - format: date-time - lte: - type: string - format: date-time - any: - type: boolean - contains: - type: string - format: date-time - additionalProperties: false - bulk_retry_id: - anyOf: - - type: string - maxLength: 255 - - type: array - items: - type: string - maxLength: 255 - order_by: - anyOf: - - type: string - maxLength: 255 - enum: - - ingested_at - - created_at - - type: array - items: - type: string - maxLength: 255 - enum: - - ingested_at - - created_at - minItems: 2 - maxItems: 2 - description: Sort key(s) - dir: - anyOf: - - type: string - enum: - - asc - - desc - - type: array - items: - type: string - enum: - - asc - - desc - minItems: 2 - maxItems: 2 - description: Sort direction - limit: - type: integer - minimum: 0 - maximum: 255 - description: Result set size - next: - type: string - maxLength: 255 - description: >- - The ID to provide in the query to get the next set of - results - prev: - type: string - maxLength: 255 - description: >- - The ID to provide in the query to get the previous set - of results + $ref: "#/components/schemas/CreateBulkRetryProperties" additionalProperties: false additionalProperties: false + x-request-name: CreateRequestBulkRetryRequest /bulk/requests/retry/plan: get: operationId: generateRequestBulkRetryPlan summary: Generate a requests bulk retry plan - description: '' + description: "" tags: - Bulk retry requests responses: - '200': + "200": description: Requests bulk retry plan content: application/json: schema: - $ref: '#/components/schemas/BatchOperationPlan' - '400': + $ref: "#/components/schemas/BatchOperationPlan" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: query name: query @@ -8136,19 +7904,19 @@ paths: anyOf: - type: string - type: object - properties: {} + $ref: "#/components/schemas/EmptyProperties" additionalProperties: false body: anyOf: - type: string - type: object - properties: {} + $ref: "#/components/schemas/EmptyProperties" additionalProperties: false parsed_query: anyOf: - type: string - type: object - properties: {} + $ref: "#/components/schemas/EmptyProperties" additionalProperties: false path: type: string @@ -8252,88 +8020,89 @@ paths: prev: type: string maxLength: 255 - description: >- - The ID to provide in the query to get the previous set of - results + description: The ID to provide in the query to get the previous set of results additionalProperties: false - /bulk/requests/retry/{id}: + x-request-name: GenerateRequestBulkRetryPlanRequest + "/bulk/requests/retry/{id}": get: operationId: getRequestBulkRetry summary: Get a requests bulk retry - description: '' + description: "" tags: - Bulk retry requests responses: - '200': + "200": description: A single requests bulk retry content: application/json: schema: - $ref: '#/components/schemas/BatchOperation' - '404': + $ref: "#/components/schemas/BatchOperation" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id schema: type: string required: true - /bulk/requests/retry/{id}/cancel: + x-request-name: GetRequestBulkRetryRequest + "/bulk/requests/retry/{id}/cancel": post: operationId: cancelRequestBulkRetry summary: Cancel a requests bulk retry - description: '' + description: "" tags: - Bulk retry requests responses: - '200': + "200": description: A single requests bulk retry content: application/json: schema: - $ref: '#/components/schemas/BatchOperation' - '404': + $ref: "#/components/schemas/BatchOperation" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id schema: type: string required: true + x-request-name: CancelRequestBulkRetryRequest /rulesets: get: operationId: getRulesets summary: Get rulesets - description: '' + description: "" tags: - Rulesets responses: - '200': + "200": description: List of rulesets content: application/json: schema: - $ref: '#/components/schemas/RulesetPaginatedResult' - '400': + $ref: "#/components/schemas/RulesetPaginatedResult" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: query name: id @@ -8514,31 +8283,32 @@ paths: type: string maxLength: 255 description: The ID to provide in the query to get the previous set of results + x-request-name: GetRulesetsRequest post: operationId: createRuleset summary: Create a ruleset - description: '' + description: "" tags: - Rulesets responses: - '200': + "200": description: A single ruleset content: application/json: schema: - $ref: '#/components/schemas/Ruleset' - '400': + $ref: "#/components/schemas/Ruleset" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: [] requestBody: required: true @@ -8560,31 +8330,32 @@ paths: required: - name additionalProperties: false + x-request-name: CreateRulesetRequest put: operationId: upsertRuleset summary: Update or create a ruleset - description: '' + description: "" tags: - Rulesets responses: - '200': + "200": description: A single ruleset content: application/json: schema: - $ref: '#/components/schemas/Ruleset' - '400': + $ref: "#/components/schemas/Ruleset" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: [] requestBody: required: true @@ -8606,63 +8377,65 @@ paths: required: - name additionalProperties: false - /rulesets/{id}: + x-request-name: UpsertRulesetRequest + "/rulesets/{id}": get: operationId: getRuleset summary: Get a ruleset - description: '' + description: "" tags: - Rulesets responses: - '200': + "200": description: A single ruleset content: application/json: schema: - $ref: '#/components/schemas/Ruleset' - '404': + $ref: "#/components/schemas/Ruleset" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id schema: type: string required: true + x-request-name: GetRulesetRequest put: operationId: updateRuleset summary: Update a ruleset - description: '' + description: "" tags: - Rulesets responses: - '200': + "200": description: A single ruleset content: application/json: schema: - $ref: '#/components/schemas/Ruleset' - '400': + $ref: "#/components/schemas/Ruleset" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '404': + $ref: "#/components/schemas/APIErrorResponse" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id @@ -8689,84 +8462,87 @@ paths: is_team_default: type: boolean additionalProperties: false - /rulesets/{id}/archive: + x-request-name: UpdateRulesetRequest + "/rulesets/{id}/archive": put: operationId: archiveRuleset summary: Archive a ruleset - description: '' + description: "" tags: - Rulesets responses: - '200': + "200": description: A single ruleset content: application/json: schema: - $ref: '#/components/schemas/Ruleset' - '404': + $ref: "#/components/schemas/Ruleset" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id schema: type: string required: true - /rulesets/{id}/unarchive: + x-request-name: ArchiveRulesetRequest + "/rulesets/{id}/unarchive": put: operationId: unarchiveRuleset summary: Unarchive a ruleset - description: '' + description: "" tags: - Rulesets responses: - '200': + "200": description: A single ruleset content: application/json: schema: - $ref: '#/components/schemas/Ruleset' - '404': + $ref: "#/components/schemas/Ruleset" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id schema: type: string required: true + x-request-name: UnarchiveRulesetRequest /sources: get: operationId: getSources summary: Get sources - description: '' + description: "" tags: - Sources responses: - '200': + "200": description: List of sources content: application/json: schema: - $ref: '#/components/schemas/SourcePaginatedResult' - '400': + $ref: "#/components/schemas/SourcePaginatedResult" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: query name: id @@ -8910,31 +8686,32 @@ paths: type: string maxLength: 255 description: The ID to provide in the query to get the previous set of results + x-request-name: GetSourcesRequest post: operationId: createSource summary: Create a source - description: '' + description: "" tags: - Sources responses: - '200': + "200": description: A single source content: application/json: schema: - $ref: '#/components/schemas/Source' - '400': + $ref: "#/components/schemas/Source" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: [] requestBody: required: true @@ -8950,31 +8727,32 @@ paths: required: - name additionalProperties: false + x-request-name: CreateSourceRequest put: operationId: upsertSource summary: Update or create a source - description: '' + description: "" tags: - Sources responses: - '200': + "200": description: A single source content: application/json: schema: - $ref: '#/components/schemas/Source' - '400': + $ref: "#/components/schemas/Source" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: [] requestBody: required: true @@ -8990,63 +8768,65 @@ paths: required: - name additionalProperties: false - /sources/{id}: + x-request-name: UpsertSourceRequest + "/sources/{id}": get: operationId: getSource summary: Get a source - description: '' + description: "" tags: - Sources responses: - '200': + "200": description: A single source content: application/json: schema: - $ref: '#/components/schemas/Source' - '404': + $ref: "#/components/schemas/Source" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id schema: type: string required: true + x-request-name: GetSourceRequest put: operationId: updateSource summary: Update a source - description: '' + description: "" tags: - Sources responses: - '200': + "200": description: A single source content: application/json: schema: - $ref: '#/components/schemas/Source' - '400': + $ref: "#/components/schemas/Source" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '404': + $ref: "#/components/schemas/APIErrorResponse" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id @@ -9067,72 +8847,75 @@ paths: archived_at: nullable: true additionalProperties: false - /sources/{id}/archive: + x-request-name: UpdateSourceRequest + "/sources/{id}/archive": put: operationId: archiveSource summary: Archive a source - description: '' + description: "" tags: - Sources responses: - '200': + "200": description: A single source content: application/json: schema: - $ref: '#/components/schemas/Source' - '404': + $ref: "#/components/schemas/Source" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id schema: type: string required: true - /sources/{id}/unarchive: + x-request-name: ArchiveSourceRequest + "/sources/{id}/unarchive": put: operationId: unarchiveSource summary: Unarchive a source - description: '' + description: "" tags: - Sources responses: - '200': + "200": description: A single source content: application/json: schema: - $ref: '#/components/schemas/Source' - '404': + $ref: "#/components/schemas/Source" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id schema: type: string required: true + x-request-name: UnarchiveSourceRequest /notifications/webhooks: put: operationId: toggleWebhookNotifications summary: Toggle webhook notifications for the workspace - description: '' + description: "" tags: - Notifications responses: - '200': + "200": description: Toggle operation status response content: application/json: schema: - $ref: '#/components/schemas/ToggleWebhookNotifications' + $ref: "#/components/schemas/ToggleWebhookNotifications" parameters: [] requestBody: required: true @@ -9146,62 +8929,64 @@ paths: topics: type: array items: - $ref: '#/components/schemas/TopicsValue' + $ref: "#/components/schemas/TopicsValue" source_id: type: string additionalProperties: false + x-request-name: ToggleWebhookNotificationsRequest /transformations: get: operationId: getTransformations summary: Get transformations - description: '' + description: "" tags: - Transformations responses: - '200': + "200": description: List of transformations content: application/json: schema: - $ref: '#/components/schemas/TransformationPaginatedResult' - '400': + $ref: "#/components/schemas/TransformationPaginatedResult" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: [] + x-request-name: GetTransformationsRequest post: operationId: createTransformation summary: Create a transformation - description: '' + description: "" tags: - Transformations responses: - '200': + "200": description: A single transformation content: application/json: schema: - $ref: '#/components/schemas/Transformation' - '400': + $ref: "#/components/schemas/Transformation" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: [] requestBody: required: true @@ -9217,42 +9002,37 @@ paths: code: type: string env: - type: object - properties: {} - additionalProperties: - anyOf: - - type: string - - type: number - format: float + $ref: "#/components/schemas/TransformationContentEnv" required: - name - code additionalProperties: false + x-request-name: CreateTransformationRequest put: operationId: upsertTransformation summary: Update or create a transformation - description: '' + description: "" tags: - Transformations responses: - '200': + "200": description: A single transformation content: application/json: schema: - $ref: '#/components/schemas/Transformation' - '400': + $ref: "#/components/schemas/Transformation" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: [] requestBody: required: true @@ -9268,74 +9048,70 @@ paths: code: type: string env: - type: object - properties: {} - additionalProperties: - anyOf: - - type: string - - type: number - format: float + $ref: "#/components/schemas/TransformationContentEnv" required: - name - code additionalProperties: false - /transformations/{id}: + x-request-name: UpsertTransformationRequest + "/transformations/{id}": get: operationId: getTransformation summary: Get a transformation - description: '' + description: "" tags: - Transformations responses: - '200': + "200": description: A single transformation content: application/json: schema: - $ref: '#/components/schemas/Transformation' - '404': + $ref: "#/components/schemas/Transformation" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id schema: type: string required: true + x-request-name: GetTransformationRequest put: operationId: updateTransformation summary: Update a transformation - description: '' + description: "" tags: - Transformations responses: - '200': + "200": description: A single transformation content: application/json: schema: - $ref: '#/components/schemas/Transformation' - '400': + $ref: "#/components/schemas/Transformation" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '404': + $ref: "#/components/schemas/APIErrorResponse" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id @@ -9356,40 +9132,35 @@ paths: code: type: string env: - type: object - properties: {} - additionalProperties: - anyOf: - - type: string - - type: number - format: float + $ref: "#/components/schemas/TransformationContentEnv" additionalProperties: false + x-request-name: UpdateTransformationRequest /transformations/run: put: operationId: testTransformation summary: Test a transformation code - description: '' + description: "" tags: - Transformations responses: - '200': + "200": description: Transformation run output content: application/json: schema: - $ref: '#/components/schemas/TransformationExecutorOutput' - '400': + $ref: "#/components/schemas/TransformationExecutorOutput" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: [] requestBody: required: true @@ -9400,7 +9171,7 @@ paths: properties: env: type: object - properties: {} + $ref: "#/components/schemas/EmptyProperties" additionalProperties: false webhook_id: type: string @@ -9410,63 +9181,40 @@ paths: type: string request: type: object - properties: - headers: - type: object - properties: {} - additionalProperties: - type: string - body: - anyOf: - - type: object - properties: {} - additionalProperties: false - - type: string - - type: array - items: {} - nullable: true - path: - type: string - nullable: true - query: - type: string - nullable: true - parsed_query: - type: object - properties: {} - additionalProperties: false + $ref: "#/components/schemas/SchemaRequestProperties" required: - headers additionalProperties: false event_id: type: string additionalProperties: false - /transformations/{id}/executions: + x-request-name: TestTransformationRequest + "/transformations/{id}/executions": get: operationId: getTransformationExecutions summary: Get transformation executions - description: '' + description: "" tags: - Transformations responses: - '200': + "200": description: List of transformation executions content: application/json: schema: - $ref: '#/components/schemas/TransformationExecutionPaginatedResult' - '400': + $ref: "#/components/schemas/TransformationExecutionPaginatedResult" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: query name: log_level @@ -9594,26 +9342,27 @@ paths: schema: type: string required: true - /transformations/{id}/executions/{execution_id}: + x-request-name: GetTransformationExecutionsRequest + "/transformations/{id}/executions/{execution_id}": get: operationId: getTransformationExecution summary: Get a transformation execution - description: '' + description: "" tags: - Transformations responses: - '200': + "200": description: A single transformation execution content: application/json: schema: - $ref: '#/components/schemas/TransformationExecution' - '404': + $ref: "#/components/schemas/TransformationExecution" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id @@ -9625,32 +9374,33 @@ paths: schema: type: string required: true + x-request-name: GetTransformationExecutionRequest /webhooks: get: operationId: getConnections summary: Get connections - description: '' + description: "" tags: - Connections responses: - '200': + "200": description: List of connections content: application/json: schema: - $ref: '#/components/schemas/ConnectionPaginatedResult' - '400': + $ref: "#/components/schemas/ConnectionPaginatedResult" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: query name: id @@ -9841,31 +9591,32 @@ paths: type: string maxLength: 255 description: The ID to provide in the query to get the previous set of results + x-request-name: GetConnectionsRequest post: operationId: createConnection summary: Create a connection - description: '' + description: "" tags: - Connections responses: - '200': + "200": description: A single connection content: application/json: schema: - $ref: '#/components/schemas/Connection' - '400': + $ref: "#/components/schemas/Connection" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: [] requestBody: required: true @@ -9888,62 +9639,19 @@ paths: nullable: true destination: type: object - properties: - name: - type: string - pattern: ^[A-z0-9-_]+$ - maxLength: 155 - url: - type: string - nullable: true - cli_path: - type: string - nullable: true - rate_limit_period: - type: string - enum: - - second - - minute - - hour - rate_limit: - type: integer - minimum: 1 - oneOf: - - type: integer - maximum: 100 - - type: integer - maximum: 6000 - - type: integer - maximum: 360000 - nullable: true - path_forwarding_disabled: - type: boolean + $ref: "#/components/schemas/RequestDestinationProperties" required: - name additionalProperties: false source: type: object - properties: - name: - type: string - pattern: ^[A-z0-9-_]+$ - maxLength: 155 + $ref: "#/components/schemas/RequestSourceProperties" required: - name additionalProperties: false ruleset: type: object - properties: - name: - type: string - pattern: ^[A-z0-9-_]+$ - maxLength: 155 - rules: - type: array - items: {} - uniqueItems: true - is_team_default: - type: boolean + $ref: "#/components/schemas/RequestRulesetProperties" required: - name additionalProperties: false @@ -9958,31 +9666,32 @@ paths: required: - name additionalProperties: false + x-request-name: CreateConnectionRequest put: operationId: upsertConnection summary: Update or create a connection - description: '' + description: "" tags: - Connections responses: - '200': + "200": description: A single connection content: application/json: schema: - $ref: '#/components/schemas/Connection' - '400': + $ref: "#/components/schemas/Connection" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: [] requestBody: required: true @@ -10004,63 +9713,19 @@ paths: maxLength: 255 nullable: true destination: - type: object - properties: - name: - type: string - pattern: ^[A-z0-9-_]+$ - maxLength: 155 - url: - type: string - nullable: true - cli_path: - type: string - nullable: true - rate_limit_period: - type: string - enum: - - second - - minute - - hour - rate_limit: - type: integer - minimum: 1 - oneOf: - - type: integer - maximum: 100 - - type: integer - maximum: 6000 - - type: integer - maximum: 360000 - nullable: true - path_forwarding_disabled: - type: boolean + $ref: "#/components/schemas/RequestDestinationProperties" required: - name additionalProperties: false source: type: object - properties: - name: - type: string - pattern: ^[A-z0-9-_]+$ - maxLength: 155 + $ref: "#/components/schemas/RequestSourceProperties" required: - name additionalProperties: false ruleset: type: object - properties: - name: - type: string - pattern: ^[A-z0-9-_]+$ - maxLength: 155 - rules: - type: array - items: {} - uniqueItems: true - is_team_default: - type: boolean + $ref: "#/components/schemas/RequestRulesetProperties" required: - name additionalProperties: false @@ -10075,63 +9740,65 @@ paths: required: - name additionalProperties: false - /webhooks/{id}: + x-request-name: UpsertConnectionRequest + "/webhooks/{id}": get: operationId: getConnection summary: Get a single connection - description: '' + description: "" tags: - Connections responses: - '200': + "200": description: A single connection content: application/json: schema: - $ref: '#/components/schemas/Connection' - '404': + $ref: "#/components/schemas/Connection" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id schema: type: string required: true + x-request-name: GetConnectionRequest put: operationId: updateConnection summary: Update a connection - description: '' + description: "" tags: - Connections responses: - '200': + "200": description: A single connection content: application/json: schema: - $ref: '#/components/schemas/Connection' - '400': + $ref: "#/components/schemas/Connection" + "400": description: Bad Request content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '404': + $ref: "#/components/schemas/APIErrorResponse" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' - '422': + $ref: "#/components/schemas/APIErrorResponse" + "422": description: Unprocessable Entity content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id @@ -10154,17 +9821,7 @@ paths: maxLength: 255 ruleset: type: object - properties: - name: - type: string - pattern: ^[A-z0-9-_]+$ - maxLength: 155 - rules: - type: array - items: {} - uniqueItems: true - is_team_default: - type: boolean + $ref: "#/components/schemas/RequestRulesetProperties" required: - name additionalProperties: false @@ -10177,107 +9834,112 @@ paths: items: {} uniqueItems: true additionalProperties: false - /webhooks/{id}/archive: + x-request-name: UpdateConnectionRequest + "/webhooks/{id}/archive": put: operationId: archiveConnection summary: Archive a connection - description: '' + description: "" tags: - Connections responses: - '200': + "200": description: A single connection content: application/json: schema: - $ref: '#/components/schemas/Connection' - '404': + $ref: "#/components/schemas/Connection" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id schema: type: string required: true - /webhooks/{id}/unarchive: + x-request-name: ArchiveConnectionRequest + "/webhooks/{id}/unarchive": put: operationId: unarchiveConnection summary: Unarchive a connection - description: '' + description: "" tags: - Connections responses: - '200': + "200": description: A single connection content: application/json: schema: - $ref: '#/components/schemas/Connection' - '404': + $ref: "#/components/schemas/Connection" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id schema: type: string required: true - /webhooks/{id}/pause: + x-request-name: UnarchiveConnectionRequest + "/webhooks/{id}/pause": put: operationId: pauseConnection summary: Pause a connection - description: '' + description: "" tags: - Connections responses: - '200': + "200": description: A single connection content: application/json: schema: - $ref: '#/components/schemas/Connection' - '404': + $ref: "#/components/schemas/Connection" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id schema: type: string required: true - /webhooks/{id}/unpause: + x-request-name: PauseConnectionRequest + "/webhooks/{id}/unpause": put: operationId: unpauseConnection summary: Unpause a connection - description: '' + description: "" tags: - Connections responses: - '200': + "200": description: A single connection content: application/json: schema: - $ref: '#/components/schemas/Connection' - '404': + $ref: "#/components/schemas/Connection" + "404": description: Not Found content: application/json: schema: - $ref: '#/components/schemas/APIErrorResponse' + $ref: "#/components/schemas/APIErrorResponse" parameters: - in: path name: id schema: type: string required: true + x-request-name: UnpauseConnectionRequest diff --git a/fern/api/generators.yml b/fern/api/generators.yml index 7f808bb..e33a5c4 100644 --- a/fern/api/generators.yml +++ b/fern/api/generators.yml @@ -1,5 +1,5 @@ groups: - external: + publish: generators: - name: fernapi/fern-typescript-sdk version: 0.2.0 @@ -8,4 +8,4 @@ groups: package-name: '@fern-api/hookdeck' token: ${FERN_NPM_TOKEN} github: - repository: fern-hookdeck/hookdeck-node + repository: fern-hookdeck/hookdeck-node \ No newline at end of file diff --git a/fern/fern.config.json b/fern/fern.config.json index 986d41e..aa3107c 100644 --- a/fern/fern.config.json +++ b/fern/fern.config.json @@ -1,4 +1,4 @@ { "organization": "hookdeck", - "version": "0.4.24" + "version": "0.4.26" } \ No newline at end of file