@wix/auto_sdk_data-extension-schema_schemas 1.0.317 → 1.0.319

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -22784,18 +22784,21 @@ interface DispatchOrigin {
22784
22784
  declare enum VerificationSource {
22785
22785
  /**
22786
22786
  * One set of material covers every delivery of this connector: a single stored secret for the
22787
- * HMAC and callback-token methods, or the published key set at public_key_url for PUBLIC_KEY
22788
- * and OIDC_BEARER, where nothing is stored at all. The only legal scope for either.
22787
+ * HMAC and callback-token methods, or the published key set at the arm's public_key_url for
22788
+ * PUBLIC_KEY and OIDC_BEARER, where nothing is stored at all. The only legal scope for either.
22789
22789
  */
22790
22790
  CONNECTOR_WIDE = "CONNECTOR_WIDE",
22791
22791
  /**
22792
22792
  * Material is issued per registration and lives on the registration the delivery was sent to.
22793
- * Requires registration_required.
22793
+ * Requires registration_required. A registration is the provider-side one for a single
22794
+ * account, which is that account's subscription; there is no separate registration entity.
22794
22795
  */
22795
22796
  PER_REGISTRATION = "PER_REGISTRATION",
22796
22797
  /**
22797
22798
  * There is no material, because nothing is verified. The only legal scope for
22798
- * NO_VERIFICATION, and legal for nothing else.
22799
+ * NO_VERIFICATION, and legal for nothing else. Redundant with NO_VERIFICATION on purpose:
22800
+ * every enum in a valid config is explicitly set, so "nothing was declared" and "the
22801
+ * declaration is that nothing is verified" stay distinguishable.
22799
22802
  */
22800
22803
  UNSIGNED = "UNSIGNED"
22801
22804
  }
@@ -22840,7 +22843,7 @@ type SignedPayloadWithLiterals = SignedPayload | 'RAW_BODY' | 'TIMESTAMP_DOT_RAW
22840
22843
  /**
22841
22844
  * Per-method payload for the `verification` oneof above. Shared by HMAC_SHA256,
22842
22845
  * HMAC_SHA1, and (wrapped) PUBLIC_KEY - the three methods signatureMethods already groups
22843
- * together in the validator. timestamp_header / timestamp_tolerance_seconds stay flat on
22846
+ * together in the validator. timestamp_header / timestamp_tolerance_seconds stay on
22844
22847
  * WebhookConfig rather than moving in here, since BODY_HASH_WITHIN_TIMESTAMP_WINDOW borrows
22845
22848
  * them independently of which verification_method is selected.
22846
22849
  */
@@ -22854,13 +22857,20 @@ interface HmacConfig {
22854
22857
  signatureHeader?: string;
22855
22858
  /**
22856
22859
  * Literal prefix the provider places in front of the encoded signature, for example
22857
- * "sha256=" or "v0=". Empty when the header holds the bare signature.
22860
+ * "sha256=" or "v0=". Empty when the header holds the bare signature. A constant, never a
22861
+ * template: compared verbatim against the start of the header, and a delivery whose header
22862
+ * does not start with it is rejected.
22858
22863
  * @maxLength 20
22859
22864
  */
22860
22865
  signatureValuePrefix?: string;
22861
22866
  /** How the signature bytes are encoded in signature_header. */
22862
22867
  signatureEncoding?: SignatureEncodingWithLiterals;
22863
- /** Which canonical string the signature is computed over. */
22868
+ /**
22869
+ * Which canonical string the signature is computed over, from a closed set of recipes. There
22870
+ * is deliberately no free-form signing template, which would make the inbound path an
22871
+ * interpreter of app-owner input; a provider whose canonical string is not listed needs a new
22872
+ * enum value.
22873
+ */
22864
22874
  signedPayload?: SignedPayloadWithLiterals;
22865
22875
  }
22866
22876
  declare enum EventsLocation {
@@ -22880,7 +22890,7 @@ declare enum VerificationMethod {
22880
22890
  HMAC_SHA1 = "HMAC_SHA1",
22881
22891
  /**
22882
22892
  * Asymmetric signature over the canonical string, verified with a key fetched from
22883
- * public_key_url.
22893
+ * PublicKeyConfig.public_key_url.
22884
22894
  */
22885
22895
  PUBLIC_KEY = "PUBLIC_KEY",
22886
22896
  /**
@@ -22893,9 +22903,10 @@ declare enum VerificationMethod {
22893
22903
  NO_VERIFICATION = "NO_VERIFICATION",
22894
22904
  /**
22895
22905
  * OIDC bearer JWT in the Authorization header, verified against the key set at
22896
- * public_key_url with the expected audience, issuer and subject, for example Cloud Pub/Sub
22897
- * push authentication. Carries no payload binding, the same limitation CALLBACK_TOKEN
22898
- * documents for itself: it proves the sender's identity, not that the body is intact.
22906
+ * OidcBearerConfig.public_key_url with the expected audience, issuer and subject, for
22907
+ * example Cloud Pub/Sub push authentication. Carries no payload binding, the same
22908
+ * limitation CALLBACK_TOKEN documents for itself: it proves the sender's identity, not that
22909
+ * the body is intact.
22899
22910
  */
22900
22911
  OIDC_BEARER = "OIDC_BEARER"
22901
22912
  }
@@ -22904,8 +22915,8 @@ type VerificationMethodWithLiterals = VerificationMethod | 'HMAC_SHA256' | 'HMAC
22904
22915
  /** How a repeated delivery is recognized, so the same event is not processed twice. */
22905
22916
  declare enum ReplayProtection {
22906
22917
  /**
22907
- * The provider sends a per-delivery id, named by delivery_id_header, and a delivery already
22908
- * seen under that id is discarded.
22918
+ * The provider sends a per-delivery id, named by DeliveryIdHeaderConfig.delivery_id_header,
22919
+ * and a delivery already seen under that id is discarded.
22909
22920
  */
22910
22921
  DELIVERY_ID_HEADER = "DELIVERY_ID_HEADER",
22911
22922
  /**
@@ -23235,8 +23246,9 @@ interface DispatchConfig {
23235
23246
  *
23236
23247
  * No credential material is declared here. This config lives in the app component catalog and is
23237
23248
  * readable by app owners; signing secrets and callback tokens are stored separately and are
23238
- * located through verification_source. public_key_url is the only credential-adjacent field, and
23239
- * it points at material the provider publishes.
23249
+ * located through the selected verification arm's verification_source. The public_key_url on
23250
+ * PublicKeyConfig and OidcBearerConfig is the only credential-adjacent field, and it points at
23251
+ * material the provider publishes.
23240
23252
  *
23241
23253
  * Fields naming something the provider owns carry a provider_ prefix, so the identifiers a
23242
23254
  * delivery arrives with are never confused with the ones Wix mints.
@@ -23267,90 +23279,19 @@ interface WebhookConfig extends WebhookConfigVerificationOneOf, WebhookConfigRep
23267
23279
  * must select a concrete method — an unset method is rejected rather than treated as a default.
23268
23280
  */
23269
23281
  verificationMethod?: VerificationMethodWithLiterals;
23270
- /**
23271
- * Scope of the material used by verification_method: shared by the whole connector, or issued
23272
- * per registration. Names the scope rather than the kind of material, so it stays accurate for
23273
- * PUBLIC_KEY, where the connector-wide material is a published key URL and nothing is stored.
23274
- *
23275
- * "Per registration" is the provider-side registration for one account, which is that account's
23276
- * subscription - there is no separate registration entity to look for.
23277
- *
23278
- * The UNSIGNED arm is redundant with verification_method = NO_VERIFICATION, and deliberately so:
23279
- * every enum in a valid config is explicitly set, which keeps "nothing was declared" and "the
23280
- * declaration is that nothing is verified" distinguishable states rather than the same unset
23281
- * field. The alternative - dropping the arm and making this field conditionally required - moves
23282
- * the same fact into a validation rule instead of removing it.
23283
- *
23284
- * Deprecated: superseded by each `verification` arm's own verification_source field. Kept live
23285
- * and enforced for the flat-shape configs this migration has not yet moved off of.
23286
- * @deprecated
23287
- * @replacedBy verification (each arm's own verification_source field)
23288
- * @targetRemovalDate 2027-06-30
23289
- */
23290
- verificationSource?: VerificationSourceWithLiterals;
23291
- /**
23292
- * Header carrying the signature to verify. Required for HMAC_SHA256, HMAC_SHA1 and PUBLIC_KEY,
23293
- * and must be empty for every other method. For example: "X-Hub-Signature-256".
23294
- *
23295
- * Deprecated: superseded by HmacConfig.signature_header (via the `verification` oneof's
23296
- * hmac_sha256_config, hmac_sha1_config and public_key_config arms).
23297
- * @maxLength 120
23298
- * @deprecated
23299
- * @replacedBy HmacConfig.signature_header (via the verification oneof)
23300
- * @targetRemovalDate 2027-06-30
23301
- */
23302
- signatureHeader?: string;
23303
- /**
23304
- * Literal prefix the provider places in front of the encoded signature, for example "sha256="
23305
- * or "v0=". Empty when the header holds the bare signature.
23306
- *
23307
- * The value is a constant, never a template: it is compared verbatim against the start of the
23308
- * header and stripped before decoding, and a delivery whose header does not start with it is
23309
- * rejected. Nothing in it is interpreted or substituted.
23310
- *
23311
- * Deprecated: superseded by HmacConfig.signature_value_prefix.
23312
- * @maxLength 20
23313
- * @deprecated
23314
- * @replacedBy HmacConfig.signature_value_prefix (via the verification oneof)
23315
- * @targetRemovalDate 2027-06-30
23316
- */
23317
- signatureValuePrefix?: string;
23318
- /**
23319
- * How the signature bytes are encoded in signature_header. Required whenever signature_header
23320
- * is required.
23321
- *
23322
- * Deprecated: superseded by HmacConfig.signature_encoding.
23323
- * @deprecated
23324
- * @replacedBy HmacConfig.signature_encoding (via the verification oneof)
23325
- * @targetRemovalDate 2027-06-30
23326
- */
23327
- signatureEncoding?: SignatureEncodingWithLiterals;
23328
- /**
23329
- * Which canonical string the signature is computed over, selected from a closed set of recipes
23330
- * the server implements. Required whenever signature_header is required.
23331
- *
23332
- * There is deliberately no free-form signing template: a configurable template would make the
23333
- * inbound path an interpreter of app-owner input and an injection surface. A provider whose
23334
- * canonical string is not listed here needs a new enum value, not a new template.
23335
- *
23336
- * Deprecated: superseded by HmacConfig.signed_payload.
23337
- * @deprecated
23338
- * @replacedBy HmacConfig.signed_payload (via the verification oneof)
23339
- * @targetRemovalDate 2027-06-30
23340
- */
23341
- signedPayload?: SignedPayloadWithLiterals;
23342
23282
  /**
23343
23283
  * Header carrying the delivery timestamp, used to reject stale and replayed deliveries. For
23344
- * example: "X-Slack-Request-Timestamp". Required by the signed_payload recipes that include a
23345
- * timestamp, and must be set together with timestamp_tolerance_seconds. The header value is read
23346
- * as epoch seconds, except under METHOD_URI_BODY_TIMESTAMP, which reads it as epoch milliseconds.
23284
+ * example: "X-Slack-Request-Timestamp". Required by the HmacConfig.signed_payload recipes that
23285
+ * include a timestamp, and must be set together with timestamp_tolerance_seconds. The header
23286
+ * value is read as epoch seconds, except under METHOD_URI_BODY_TIMESTAMP, which reads it as
23287
+ * epoch milliseconds.
23347
23288
  * @maxLength 120
23348
23289
  */
23349
23290
  timestampHeader?: string;
23350
23291
  /**
23351
23292
  * How far the delivery timestamp may be from server time before the delivery is rejected. Must
23352
23293
  * be greater than zero when timestamp_header is set, and zero when it is not. Always in seconds,
23353
- * whatever unit the signed_payload recipe reads timestamp_header in.
23294
+ * whatever unit the HmacConfig.signed_payload recipe reads timestamp_header in.
23354
23295
  *
23355
23296
  * The tolerance is a floor on replay-protection retention, not only a freshness bound: whatever
23356
23297
  * remembers seen deliveries has to outlive this window, or a delivery still inside its accepted
@@ -23363,52 +23304,6 @@ interface WebhookConfig extends WebhookConfigVerificationOneOf, WebhookConfigRep
23363
23304
  * @max 3600
23364
23305
  */
23365
23306
  timestampToleranceSeconds?: number;
23366
- /**
23367
- * Header carrying the shared token the provider echoes on every delivery. Required for
23368
- * CALLBACK_TOKEN and must be empty for every other method. For example:
23369
- * "X-Goog-Channel-Token". The token itself is never declared here — it is located through
23370
- * verification_source.
23371
- *
23372
- * Deprecated: superseded by CallbackTokenConfig.callback_token_header.
23373
- * @maxLength 120
23374
- * @deprecated
23375
- * @replacedBy verification.callback_token_config.callback_token_header
23376
- * @targetRemovalDate 2027-06-30
23377
- */
23378
- callbackTokenHeader?: string;
23379
- /**
23380
- * Endpoint publishing the provider's public keys. Required for PUBLIC_KEY and OIDC_BEARER, and
23381
- * must be empty for every other method.
23382
- *
23383
- * Deliberately has no (wix.api.format), following revoke_url above: WEB_URL rejects the empty
23384
- * value this field carries for every other method. HTTPS and a parseable endpoint are enforced
23385
- * when the keys are fetched instead.
23386
- *
23387
- * Deprecated: superseded by PublicKeyConfig.public_key_url for PUBLIC_KEY, and by
23388
- * OidcBearerConfig.public_key_url for OIDC_BEARER.
23389
- * @maxLength 2000
23390
- * @deprecated
23391
- * @replacedBy verification.public_key_config.public_key_url (PUBLIC_KEY) or verification.oidc_bearer_config.public_key_url (OIDC_BEARER)
23392
- * @targetRemovalDate 2027-06-30
23393
- */
23394
- publicKeyUrl?: string;
23395
- /**
23396
- * Header carrying the provider's unique id for this delivery, for example "X-GitHub-Delivery".
23397
- * Required by, and legal only with, replay_protection = DELIVERY_ID_HEADER.
23398
- *
23399
- * The id is only as unique as the provider makes it. Google Calendar's X-Goog-Message-Number,
23400
- * for instance, counts per notification channel rather than globally, so a delivery is
23401
- * identified by the registration it arrived on together with this value, never by the value
23402
- * alone.
23403
- *
23404
- * Deprecated: superseded by DeliveryIdHeaderConfig.delivery_id_header (via the
23405
- * `replay_protection_config` oneof's delivery_id_header_config arm).
23406
- * @maxLength 120
23407
- * @deprecated
23408
- * @replacedBy replay_protection_config.delivery_id_header_config.delivery_id_header
23409
- * @targetRemovalDate 2027-06-30
23410
- */
23411
- deliveryIdHeader?: string;
23412
23307
  /**
23413
23308
  * Header carrying the event type of the delivery, for example "X-GitHub-Event". Optional: at
23414
23309
  * most one of event_type_header and event_type_json_pointer may be set, and a provider with no
@@ -23526,47 +23421,6 @@ interface WebhookConfig extends WebhookConfigVerificationOneOf, WebhookConfigRep
23526
23421
  * @immutable
23527
23422
  */
23528
23423
  deliveryTopic?: string;
23529
- /**
23530
- * Expected `aud` claim of an OIDC_BEARER token. An OIDC issuer's audience is chosen by whoever
23531
- * requested the token, not by the issuer, so pinning the value expected here is what stops a
23532
- * bearer token minted for a different audience — a different Pub/Sub push subscription, for
23533
- * instance — from authenticating against this one. Required for OIDC_BEARER and must be empty
23534
- * for every other method.
23535
- *
23536
- * Deprecated: superseded by OidcBearerConfig.oidc_expected_audience.
23537
- * @maxLength 2000
23538
- * @deprecated
23539
- * @replacedBy verification.oidc_bearer_config.oidc_expected_audience
23540
- * @targetRemovalDate 2027-06-30
23541
- */
23542
- oidcExpectedAudience?: string;
23543
- /**
23544
- * Expected `iss` claim of an OIDC_BEARER token, for example "https://accounts.google.com".
23545
- * Required for OIDC_BEARER and must be empty for every other method.
23546
- *
23547
- * Deprecated: superseded by OidcBearerConfig.oidc_expected_issuer.
23548
- * @maxLength 2000
23549
- * @deprecated
23550
- * @replacedBy verification.oidc_bearer_config.oidc_expected_issuer
23551
- * @targetRemovalDate 2027-06-30
23552
- */
23553
- oidcExpectedIssuer?: string;
23554
- /**
23555
- * Expected `sub` claim of an OIDC_BEARER token — the stable identifier of the specific caller
23556
- * trusted to send this connector's deliveries, for example a Pub/Sub push subscription's
23557
- * service account. iss and aud alone do not identify the sender: aud is a value the token
23558
- * *requester* chooses, not the issuer, so any principal able to mint a same-issuer,
23559
- * same-audience token — a different Google service account with permission to request an ID
23560
- * token for this audience, for instance — would otherwise pass. Required for OIDC_BEARER and
23561
- * must be empty for every other method.
23562
- *
23563
- * Deprecated: superseded by OidcBearerConfig.oidc_expected_subject.
23564
- * @maxLength 2000
23565
- * @deprecated
23566
- * @replacedBy verification.oidc_bearer_config.oidc_expected_subject
23567
- * @targetRemovalDate 2027-06-30
23568
- */
23569
- oidcExpectedSubject?: string;
23570
23424
  /**
23571
23425
  * Set when one delivery body is a batch of events, each possibly for a different provider tenant.
23572
23426
  * The whole request is verified once, then split into one delivery per element.