@stripe/extensibility-dev-tools 0.23.5

package/dist/custom-objects/generated/proto/vendor/publicapi/v2ext.pb.d.ts

@@ -0,0 +1,1111 @@
+import { type FieldPrivacySetting } from "../vext/privacy_unified_annotations.pb.js";
+import { type ApiGroup } from "./api_group_enum.pb.js";
+import { type ApiFieldVisibility } from "./api_visibility.pb.js";
+import { type CustomizeDispatchMiddleware } from "./customize_dispatch_middleware_enum.pb.js";
+import { type DocsNamespaceGroup } from "./docs_namespace_group_enum.pb.js";
+import { type Documented } from "./documented_enum.pb.js";
+import { type EventScope } from "./event_scope_enum.pb.js";
+import { type ExtensionImplementationType as ExtensionImplementationType24, type ExtensionRetryPolicy, type ScriptExecutionProfile, type UsageType } from "./extension_interface.pb.js";
+import { type Feature } from "./feature_enum.pb.js";
+import { type Flavor } from "./flavor_enum.pb.js";
+import { type HttpErrorStatus } from "./http_error_status.pb.js";
+import { type MethodKind } from "./method_kind_enum.pb.js";
+import { type Priority } from "./method_priority.pb.js";
+import { type PermissionCheck } from "./permission_check_enum.pb.js";
+import { type Redaction } from "./redaction_enum.pb.js";
+import { type RegionRouter } from "./region_routers.pb.js";
+import { type RolloutConfig_RolloutConfigPhase } from "./rollout_configs.pb.js";
+export declare const protobufPackage = "com.stripe.v2";
+export declare const HttpMethod: {
+    /** HTTP_METHOD_INVALID - buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX */
+    readonly HTTP_METHOD_INVALID: "HTTP_METHOD_INVALID";
+    readonly GET: "GET";
+    readonly POST: "POST";
+    readonly DELETE: "DELETE";
+    readonly UNRECOGNIZED: "UNRECOGNIZED";
+};
+export type HttpMethod = typeof HttpMethod[keyof typeof HttpMethod];
+export declare namespace HttpMethod {
+    type HTTP_METHOD_INVALID = typeof HttpMethod.HTTP_METHOD_INVALID;
+    type GET = typeof HttpMethod.GET;
+    type POST = typeof HttpMethod.POST;
+    type DELETE = typeof HttpMethod.DELETE;
+    type UNRECOGNIZED = typeof HttpMethod.UNRECOGNIZED;
+}
+/** Indicate if a v2 error is expected to be retryable by users */
+export declare const ShouldRetryError: {
+    /**
+     * SHOULD_RETRY_ERROR_INVALID - Defaults to same behavior as based on AUTO
+     * buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX
+     */
+    readonly SHOULD_RETRY_ERROR_INVALID: "SHOULD_RETRY_ERROR_INVALID";
+    /**
+     * SHOULD_RETRY - Indicates an error may be transient and an idempotent retry is likely to succeed
+     * If an error is possibly retryable
+     */
+    readonly SHOULD_RETRY: "SHOULD_RETRY";
+    /** DO_NOT_RETRY - Indicates an idempotent retry will NEVER succeed.  Use sparingly and mostly for invalid requests. */
+    readonly DO_NOT_RETRY: "DO_NOT_RETRY";
+    readonly UNRECOGNIZED: "UNRECOGNIZED";
+};
+export type ShouldRetryError = typeof ShouldRetryError[keyof typeof ShouldRetryError];
+export declare namespace ShouldRetryError {
+    type SHOULD_RETRY_ERROR_INVALID = typeof ShouldRetryError.SHOULD_RETRY_ERROR_INVALID;
+    type SHOULD_RETRY = typeof ShouldRetryError.SHOULD_RETRY;
+    type DO_NOT_RETRY = typeof ShouldRetryError.DO_NOT_RETRY;
+    type UNRECOGNIZED = typeof ShouldRetryError.UNRECOGNIZED;
+}
+export declare const GraphQlOperationType: {
+    /** GRAPH_QL_OPERATION_TYPE_INVALID - buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX */
+    readonly GRAPH_QL_OPERATION_TYPE_INVALID: "GRAPH_QL_OPERATION_TYPE_INVALID";
+    readonly QUERY: "QUERY";
+    readonly MUTATION: "MUTATION";
+    readonly UNRECOGNIZED: "UNRECOGNIZED";
+};
+export type GraphQlOperationType = typeof GraphQlOperationType[keyof typeof GraphQlOperationType];
+export declare namespace GraphQlOperationType {
+    type GRAPH_QL_OPERATION_TYPE_INVALID = typeof GraphQlOperationType.GRAPH_QL_OPERATION_TYPE_INVALID;
+    type QUERY = typeof GraphQlOperationType.QUERY;
+    type MUTATION = typeof GraphQlOperationType.MUTATION;
+    type UNRECOGNIZED = typeof GraphQlOperationType.UNRECOGNIZED;
+}
+/** Represents the presence of a field */
+export declare const FieldPresence: {
+    /** FIELD_PRESENCE_INVALID - buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX */
+    readonly FIELD_PRESENCE_INVALID: "FIELD_PRESENCE_INVALID";
+    readonly PRESENT: "PRESENT";
+    readonly NOT_PRESENT: "NOT_PRESENT";
+    readonly PRESENT_BUT_NULL: "PRESENT_BUT_NULL";
+    readonly UNRECOGNIZED: "UNRECOGNIZED";
+};
+export type FieldPresence = typeof FieldPresence[keyof typeof FieldPresence];
+export declare namespace FieldPresence {
+    type FIELD_PRESENCE_INVALID = typeof FieldPresence.FIELD_PRESENCE_INVALID;
+    type PRESENT = typeof FieldPresence.PRESENT;
+    type NOT_PRESENT = typeof FieldPresence.NOT_PRESENT;
+    type PRESENT_BUT_NULL = typeof FieldPresence.PRESENT_BUT_NULL;
+    type UNRECOGNIZED = typeof FieldPresence.UNRECOGNIZED;
+}
+export declare const ExtensionImplementationType: {
+    /** EXTENSION_IMPLEMENTATION_TYPE_INVALID - buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX */
+    readonly EXTENSION_IMPLEMENTATION_TYPE_INVALID: "EXTENSION_IMPLEMENTATION_TYPE_INVALID";
+    readonly REMOTE_FUNCTION: "REMOTE_FUNCTION";
+    readonly SCRIPT: "SCRIPT";
+    readonly UNRECOGNIZED: "UNRECOGNIZED";
+};
+export type ExtensionImplementationType = typeof ExtensionImplementationType[keyof typeof ExtensionImplementationType];
+export declare namespace ExtensionImplementationType {
+    type EXTENSION_IMPLEMENTATION_TYPE_INVALID = typeof ExtensionImplementationType.EXTENSION_IMPLEMENTATION_TYPE_INVALID;
+    type REMOTE_FUNCTION = typeof ExtensionImplementationType.REMOTE_FUNCTION;
+    type SCRIPT = typeof ExtensionImplementationType.SCRIPT;
+    type UNRECOGNIZED = typeof ExtensionImplementationType.UNRECOGNIZED;
+}
+/** Declares what type of change an event represents. */
+export declare const ChangeTraitStyle: {
+    /** CHANGE_TRAIT_STYLE_INVALID - buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX */
+    readonly CHANGE_TRAIT_STYLE_INVALID: "CHANGE_TRAIT_STYLE_INVALID";
+    /**
+     * CREATION - Creation event: Only "after" state in Changes.
+     * The related object was just created, so there's no "before" state.
+     */
+    readonly CREATION: "CREATION";
+    /**
+     * MODIFICATION - Modification event: Both "before" and "after" states in Changes.
+     * The related object existed and was modified.
+     */
+    readonly MODIFICATION: "MODIFICATION";
+    /**
+     * DELETION - Deletion event: Only "before" state in Changes.
+     * The related object was deleted, so there's no "after" state.
+     */
+    readonly DELETION: "DELETION";
+    /**
+     * NONE - No changes: Event has no Changes field.
+     * Used for events that don't represent object state changes.
+     */
+    readonly NONE: "NONE";
+    readonly UNRECOGNIZED: "UNRECOGNIZED";
+};
+export type ChangeTraitStyle = typeof ChangeTraitStyle[keyof typeof ChangeTraitStyle];
+export declare namespace ChangeTraitStyle {
+    type CHANGE_TRAIT_STYLE_INVALID = typeof ChangeTraitStyle.CHANGE_TRAIT_STYLE_INVALID;
+    type CREATION = typeof ChangeTraitStyle.CREATION;
+    type MODIFICATION = typeof ChangeTraitStyle.MODIFICATION;
+    type DELETION = typeof ChangeTraitStyle.DELETION;
+    type NONE = typeof ChangeTraitStyle.NONE;
+    type UNRECOGNIZED = typeof ChangeTraitStyle.UNRECOGNIZED;
+}
+export interface ExtensionInterfaceSpec {
+    interfaceId: string;
+    /** Project responsible for this service. */
+    project: string;
+    rolloutConfig: string;
+    usageType: UsageType;
+    scriptExecution: ScriptExecutionSpec | undefined;
+    apiGroup: ApiGroup;
+    docs: ExtensionInterfaceSpec_Docs | undefined;
+}
+/** Configures how this extension interface appears on [narrative documentation](docs.stripe.com). */
+export interface ExtensionInterfaceSpec_Docs {
+    /**
+     * The human-readable title for this extension interface shown in documentation.
+     * Derived from the gRPC service name by stripping the "Api" suffix and converting to title case.
+     *
+     * Consider overriding when:
+     * - The derived title includes an unwanted suffix (e.g., "Extension") not part of the public name
+     * - Abbreviations are incorrectly cased (e.g., "ACH", "US")
+     * - The public-facing name differs from the gRPC service name
+     *
+     * Example: "CustomActionExtensionApi" auto-derives to "Custom Action Extension";
+     * override to "Custom Action"
+     */
+    title: string;
+    /**
+     * The URL path for this extension interface's documentation page, relative to docs.stripe.com.
+     * Derived as "/extensions/<dasherized-service-name>" (with the "Api" suffix stripped).
+     *
+     * Consider overriding when:
+     * - The derived path includes unwanted segments (e.g., "-extension" suffix from the service name)
+     * - The desired public route doesn't match the gRPC service name
+     *
+     * Example: "CustomActionExtensionApi" auto-derives to "/extensions/custom-action-extension";
+     * override to "/extensions/custom-action"
+     */
+    route: string;
+    /**
+     * Additional URL paths relative to docs.stripe.com that redirect to this extension interface's documentation page.
+     *
+     * Example: redirect: "/extensions/old-llama-extension-interface"
+     */
+    redirect: string[];
+}
+export interface ScriptExecutionSpec {
+    /** Which execution profile is allowed for scripts run through this extension interface. */
+    profile: ScriptExecutionProfile;
+}
+export interface ExtensionInterfaceMethodSpec {
+    extensionMethodId: string;
+    /** @deprecated */
+    allowedImplementationTypesDeprecated: ExtensionImplementationType[];
+    /** @deprecated */
+    retryPolicyDeprecated: ExtensionInterfaceMethodSpec_RetryPolicy | undefined;
+    errors: ExtensionInterfaceMethodSpec_ErrorDefinition[];
+    allowedImplementationTypes: ExtensionImplementationType24[];
+    retryPolicy: ExtensionRetryPolicy | undefined;
+    rolloutConfig: string;
+    optional: boolean;
+    docs: ExtensionInterfaceMethodSpec_Docs | undefined;
+}
+export interface ExtensionInterfaceMethodSpec_RetryPolicy {
+    type: string;
+    maxRetries: number;
+}
+export interface ExtensionInterfaceMethodSpec_ErrorDefinition {
+    type: string;
+}
+/** Configures how this extension interface method appears on [narrative documentation](docs.stripe.com). */
+export interface ExtensionInterfaceMethodSpec_Docs {
+    /**
+     * The human-readable title for this extension method shown in documentation.
+     * Derived from the gRPC method name converted to title case.
+     *
+     * Consider overriding when:
+     * - Abbreviations are incorrectly cased (e.g., "ACH", "US")
+     * - The public-facing name differs from the gRPC method name
+     *
+     * Example: "ConfirmPaymentCall" auto-derives to "Confirm Payment Call";
+     * override to "The confirm_payment method"
+     */
+    title: string;
+    /**
+     * The anchor fragment for this method on its documentation page.
+     * Defaults to the extension_method_id when not set.
+     *
+     * Consider overriding when:
+     * - The anchor conflicts with another anchor on the same page
+     * - A legacy anchor value needs to be preserved
+     *
+     * Example: extension_method_id "confirm_payment" defaults to anchor "confirm_payment"
+     */
+    anchor: string;
+}
+export interface AuthConfigOptions {
+    allow: AuthConfigOptions_Allow[];
+}
+export declare const AuthConfigOptions_Allow: {
+    /** ALLOW_INVALID - buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX */
+    readonly ALLOW_INVALID: "ALLOW_INVALID";
+    readonly LEGACY_TEST_MODE: "LEGACY_TEST_MODE";
+    readonly LEGACY_TEST_MODE_QA_ONLY: "LEGACY_TEST_MODE_QA_ONLY";
+    readonly UNRECOGNIZED: "UNRECOGNIZED";
+};
+export type AuthConfigOptions_Allow = typeof AuthConfigOptions_Allow[keyof typeof AuthConfigOptions_Allow];
+export declare namespace AuthConfigOptions_Allow {
+    type ALLOW_INVALID = typeof AuthConfigOptions_Allow.ALLOW_INVALID;
+    type LEGACY_TEST_MODE = typeof AuthConfigOptions_Allow.LEGACY_TEST_MODE;
+    type LEGACY_TEST_MODE_QA_ONLY = typeof AuthConfigOptions_Allow.LEGACY_TEST_MODE_QA_ONLY;
+    type UNRECOGNIZED = typeof AuthConfigOptions_Allow.UNRECOGNIZED;
+}
+export interface LocalizationOptions {
+}
+export interface FlattenedArray {
+}
+export interface UnionType {
+}
+export interface BehaviorEnumOptions {
+    /** The enum value number of the version that API gateway should send to the backing service for behavior changes. */
+    current: number;
+}
+export interface ResourceIdOptions {
+}
+/**
+ * Allow certain deprecated features to be used in this file / message.
+ * string values should be JIRA or go links
+ */
+export interface Allow {
+    /** Allow the use of proto3 optional in fields of this message type. */
+    proto3Optional: string;
+}
+export interface FieldOptions {
+    fieldType: //
+    /** Specifies that a field is used in webhooks */
+    {
+        $case: "webhook";
+        value: WebhookFieldOption;
+    } | //
+    /** Specifies that a field should be hidden from the api and be used internally only. */
+    {
+        $case: "internal";
+        value: InternalFieldOption;
+    } | //
+    /** Specifies that a field should be flattened in the json response */
+    {
+        $case: "flatten";
+        value: FlattenFieldOption;
+    } | //
+    /** Specifies details about API Events */
+    {
+        $case: "event";
+        value: ApiEventFieldOption;
+    } | undefined;
+    feature: Feature;
+    rolloutConfig: string;
+    accessCondition: string;
+    /** Specifies that a field should be used for auto permission check. */
+    autoPermission: AutoPermissionCheckFieldOption | undefined;
+    /** Indicates a request field where explicitly sending `null` unsets it. */
+    nullable: boolean;
+    /**
+     * Indicates whether or not a field should not be included in public API documentation.
+     * Fields are public by default. This only needs to be set if you want a field to be INTERNAL.
+     */
+    documented: Documented;
+    /** Opts a path parameter out of Gen6 ID HMAC validation at Edge. */
+    skipGen6Validation: boolean;
+    /**
+     * No longer used.
+     *
+     * @deprecated
+     */
+    generated: boolean;
+    /** External representation of the field, for both serialization and deserialization. */
+    externalName: string;
+    /**
+     * by default everything is visible.
+     * visible_in is to limit returning a field based on technology constraints
+     * not for rollout purposes.
+     */
+    visibleIn: ApiFieldVisibility;
+    /** next: 19 */
+    permission: string;
+}
+export interface WebhookFieldOption {
+}
+export interface InternalFieldOption {
+}
+export interface FlattenFieldOption {
+}
+export interface ApiEventFieldOption {
+    event: {
+        $case: "primaryRelatedObjectId";
+        value: ApiEventPrimaryRelatedObjectId;
+    } | {
+        $case: "compartmentId";
+        value: ApiEventCompartmentId;
+    } | {
+        $case: "eventField";
+        value: ApiEventEventField;
+    } | undefined;
+}
+export interface AutoPermissionCheckFieldOption {
+}
+export interface ApiEventPrimaryRelatedObjectId {
+    /** exposed as the "type" field alongside the primary object id. */
+    type: string;
+    optionalRetrieveUrl: //
+    /** optional. if provided, this will be used to construct a URL to retrieve the primary related object */
+    {
+        $case: "retrieveUrl";
+        value: string;
+    } | undefined;
+}
+export interface ApiEventCompartmentId {
+}
+export interface ApiEventEventField {
+}
+/** Indicates that the message represents a Resource. */
+export interface ResourceOptions {
+    /** The 'object' value of this resource's parent resource, or empty if this resource isn't a child resource. */
+    parent: string;
+    /** TODO: this is currently unused, depcrecate this */
+    idPrefix: string;
+    /** The API Group the resource belongs under. */
+    apiGroup: ApiGroup;
+    /** An override annotation for overriding defaults from API Groups. */
+    override: ResourceOptions_Override | undefined;
+    singleton: boolean;
+    stableId: string;
+    docs: ResourceOptions_Docs | undefined;
+}
+export interface ResourceOptions_Override {
+    objectTag: string;
+    name: string;
+}
+/** Configures how this resource appears in the [API Reference](docs.stripe.com/api). */
+export interface ResourceOptions_Docs {
+    /**
+     * Groups this resource under a shared namespace in the API Reference.
+     * Values are defined in docs_namespace_group_enum.proto.
+     *
+     * The auto-generated namespace group is strongly preferred — it derives the title, route,
+     * anchor, and description automatically from the resource name and doc string. Only use this
+     * when you need multiple resources to share the same namespace group. Methods inherit the
+     * namespace group from their resource automatically. Changes to enum values affect all API
+     * reference versions since the values are un-versioned.
+     *
+     * If you're unsure whether your use case applies, ask in before adding a
+     * new value to the enum.
+     */
+    namespaceGroup: DocsNamespaceGroup;
+    /**
+     * Ability to override the auto-generated namespace group title.
+     * This is only used when `namespace_group` is not set.
+     * Auto-generated by pluralizing the resource name and inserting spaces between PascalCase words.
+     *
+     * Consider overriding when:
+     * - Abbreviations are incorrectly cased (e.g., "A C H Transfers" should be "ACH Transfers")
+     * - The plural form is incorrect due to unusual pluralization
+     *
+     * Example: "PaymentIntent" -> "Payment Intents"
+     */
+    namespaceGroupTitle: string;
+    /**
+     * Additional URL paths relative to docs.stripe.com/api/ that redirect to this resource's namespace group page.
+     * Format: must start with /v2, contain one or more segments of lowercase letters, dashes, or
+     * underscores (underscores allowed for legacy paths), and have no trailing slash.
+     * Must not conflict with an existing route.
+     * Example: "/v2/core/event_destinations" (legacy), "/v2/core/payment-intents"
+     */
+    namespaceGroupRedirect: string[];
+    /**
+     * The human-readable title for this resource shown in the API Reference.
+     * Derived by converting the resource name from PascalCase to title case.
+     *
+     * Consider overriding when:
+     * - Abbreviations are incorrectly cased (e.g., "U S Bank Account" should be "US Bank Account")
+     * - The public-facing name differs from the proto message name
+     *
+     * Example: "PaymentIntent" -> "Payment Intent"
+     */
+    title: string;
+    /**
+     * The URL path for this resource's object page in the API Reference, relative to docs.stripe.com/api/.
+     * Derived as "<api-group-path>/<pluralized-dasherized-name>/object".
+     *
+     * Consider overriding when:
+     * - The derived route doesn't match the intended public URL structure
+     * - The plural form of the resource name in the route is incorrect
+     *
+     * Format: must start with /v2, contain 2–4 segments of lowercase letters and dashes, end with
+     * /object, and have no trailing slash. Must be unique across all routes.
+     * Example: "/v2/core/payment-intents/object"
+     */
+    route: string;
+    /**
+     * Additional URL paths relative to docs.stripe.com/api/ that redirect to this resource's object page.
+     * Format: same as route (starts with /v2, 2–4 segments, lowercase letters and dashes, no
+     * trailing slash), but does not need to end with /object. Must not conflict with an
+     * existing route, and must be unique across all redirects.
+     */
+    redirect: string[];
+    /**
+     * The anchor fragment for this resource on its documentation page.
+     * Derived as "v2_<snake_case_name>_object".
+     *
+     * Consider overriding when:
+     * - The derived anchor is incorrect
+     * - A legacy anchor value needs to be preserved
+     *
+     * Example: "PaymentIntent" -> "v2_payment_intent_object"
+     */
+    anchor: string;
+    /**
+     * The anchor fragment for this resource's namespace group section in the API Reference.
+     * Derived as "v2_<pluralized_snake_case_name>".
+     *
+     * Consider overriding when:
+     * - The derived anchor is incorrect
+     * - A legacy anchor value needs to be preserved
+     *
+     * Example: "PaymentIntent" -> "v2_payment_intents"
+     */
+    namespaceAnchor: string;
+}
+export interface PaginationOptions {
+}
+export interface ServiceOptions {
+    /** [required] Service name passed to RpcClient.resolveEnvoyEndpoint. */
+    envoyServiceName: string;
+    /** All the features whose values will be computed in API gateway and used by the service. */
+    featureRegistered: Feature[];
+    /**
+     * States where the service will be visible. The most common case is in the API.
+     * [Deprecated] This namespace option is currently not used.
+     *
+     * @deprecated
+     */
+    namespace: string;
+    /**
+     * Publicly visible service name if different from the gRPC service name.
+     * Do not use this for new services, instead try to keep the gRPC service name in sync with the public name.
+     *
+     * @deprecated
+     */
+    publicServiceName: string;
+    /** Team responsible for this service. */
+    responsibleTeam: string;
+    /** Project responsible for this service. */
+    project: string;
+}
+export interface MethodOptions {
+    /**
+     * Full URL path for this method (must start with /v2).
+     * May contain path parameters named like ":id".
+     */
+    httpMapping: {
+        $case: "get";
+        value: string;
+    } | {
+        $case: "post";
+        value: string;
+    } | {
+        $case: "delete";
+        value: string;
+    } | {
+        $case: "put";
+        value: string;
+    } | {
+        $case: "graphQlOnly";
+        value: GraphQlOperationType;
+    } | {
+        $case: "patch";
+        value: string;
+    } | undefined;
+    /** V1 permission for a method. */
+    v1Permission: string;
+    /**
+     * Error codes that this method may return.
+     * These values must correspond to an `(v2.error_spec).code` value defined
+     * on some message (not necessarily in the same file).
+     * The method may return other errors without a code (undocumented errors), but should
+     * not return any errors with a code without declaring that code here.
+     */
+    errorCode: string[];
+    feature: Feature;
+    /** Is this method publicly documented (part of SDKs, API ref, etc.) or just internal? */
+    documented: Documented;
+    /** When creating a new gRPC endpoint, mark the old ones as `legacy_version` so that any API request with the new version will only be routed to the new gRPC endpoint. */
+    legacyVersion: boolean;
+    /** Opts the method out of authn/authz entirely and into stricter rate limits for DDoS protection. Mutually exclusive with `permission`. */
+    unauthenticated: boolean;
+    regionRouter: RegionRouter | undefined;
+    graphqlMethodName: string;
+    flavor: Flavor;
+    /** Team responsible for this service. When not set, the responsible_team of the Service will be used. */
+    responsibleTeam: string;
+    docs: MethodOptions_Docs | undefined;
+    /** A unique and stable identifier for the method, guaranteed to not change while the method exists. */
+    stableId: string;
+    /** The kind of the method (e.g. CREATE), required if the method name does not have a standardized prefix. */
+    kind: MethodKind;
+    /** The resource that the method is operating on and/or associated with. DELETE and CUSTOM methods are required to include this resource in their responses */
+    resource: string;
+    customizeDispatchMiddleware: CustomizeDispatchMiddleware;
+    /**
+     * Use with caution. When set to `DISABLED`, API Gateway will not check if the request has the required permission for the method. Possibly useful if your resource's ID does not follow the Gen6 format.
+     *
+     * If you decide to skip permission checking in API Gateway, you **MUST** check the request's permissions in the backing service.
+     */
+    permissionCheck: PermissionCheck;
+    /**
+     * A custom name for the method, powering downstream artifacts such as functions on SDKs. Must be in camelCase.
+     *
+     * If not set, the external name will be derived from the method's kind (e.g. create, delete), or the method's path for custom methods.
+     */
+    externalName: string;
+    priority: Priority | undefined;
+    authConfig: AuthConfigOptions | undefined;
+    rolloutConfig: string;
+    /** next: 39 */
+    accessCondition: string;
+}
+/**
+ * No longer used, retained due to schema evolution requirements
+ *
+ * @deprecated
+ */
+export interface MethodOptions_Override {
+    docsLevelOneGroup: string;
+}
+/** Configures how this method appears in the [API Reference](docs.stripe.com/api). */
+export interface MethodOptions_Docs {
+    /**
+     * Groups this method under a shared namespace in the API Reference, overriding the namespace
+     * inherited from the resource. Values are defined in docs_namespace_group_enum.proto.
+     *
+     * The auto-generated namespace group is strongly preferred. Only use this when you need
+     * multiple resources to share the same namespace group. Changes to enum values affect all API
+     * reference versions since the values are un-versioned.
+     *
+     * If you're unsure whether your use case applies, ask in before adding a
+     * new value to the enum.
+     */
+    namespaceGroup: DocsNamespaceGroup;
+    /**
+     * Override the human-readable title for this method, shown in documentation.
+     * Derived from the method kind and the resource title.
+     *
+     * Consider overriding when:
+     * - Abbreviations are incorrectly cased (e.g., "U S Bank Account" should be "US Bank Account")
+     * - The public-facing name differs from what the derivation produces
+     *
+     * Examples: CREATE + PaymentIntent -> "Create a Payment Intent"
+     * LIST + PaymentIntent -> "List Payment Intents"
+     */
+    title: string;
+    /**
+     * The URL path for this method's page in the API Reference, relative to docs.stripe.com/api/.
+     * Derived as "<resource-route>/<method-kind>".
+     *
+     * Consider overriding when:
+     * - The derived route doesn't match the intended public URL
+     * - The plural form of the resource name in the route is incorrect
+     *
+     * Format: must start with /v2, contain 2–4 segments of lowercase letters and dashes, and have
+     * no trailing slash. Must be unique across all routes.
+     * Example: "/v2/core/payment-intents/create"
+     */
+    route: string;
+    /**
+     * Additional URL paths relative to docs.stripe.com/api/ that redirect to this method's documentation page.
+     * Format: same as route (starts with /v2, 2–4 segments, lowercase letters and dashes, no
+     * trailing slash). Must not conflict with an existing route, and must be unique across
+     * all redirects.
+     */
+    redirect: string[];
+    /**
+     * The anchor fragment for this method on its documentation page.
+     * Derived as "v2_<verb>_<pluralized_snake_case_resource>".
+     *
+     * Consider overriding when:
+     * - The derived anchor is incorrect
+     * - A legacy anchor value needs to be preserved
+     *
+     * Example: CREATE + PaymentIntent -> "v2_create_payment_intents"
+     */
+    anchor: string;
+}
+export interface EnumValueOptions {
+    /**
+     * External representation of the enum, for both serialization and deserialization.
+     * This may only contain lowercase alphanumeric and underscore and period characters, and the first character must be
+     * alphabetic.
+     */
+    externalName: string;
+    /** Feature used to guard the enum value. The enum value should only be requested or returned when the feature is active. */
+    feature: Feature;
+    rolloutConfig: string;
+    accessCondition: string;
+    /**
+     * Fallback enum value to use when this value doesn't exist in the requested API version.
+     * This should reference another enum value in the same enum by its proto name.
+     * When a newer enum value is returned but doesn't exist in an older version, the system will
+     * recursively resolve fallbacks until finding a value that exists in that version or 500 if none found.
+     */
+    fallback: string;
+}
+/** ErrorSpec describes an error response. */
+export interface ErrorSpec {
+    /**
+     * Publicly visible error code that uniquely identifies this error.
+     * Optional: if not specified, this error is considered "undocumented".
+     */
+    code: string;
+    /**
+     * A URL to more information about the error code reported.
+     * Optional.
+     */
+    docUrl: string;
+    /**
+     * Name of the query parameter or field in the request that caused this error
+     * (if applicable).
+     * Optional.
+     */
+    param: string;
+    /** optional http status, defaults to BAD_REQUEST */
+    httpStatus: HttpErrorStatus;
+    /**
+     * Lookup code for internationalizing the error message for the developers who integrate with Stripe.
+     * Note: translation is not yet implemented.
+     * Required.
+     */
+    developerMessageFormatId: string;
+    /**
+     * Example EN-US message format for the developers, can have format placeholders, e.g. "The name {value} cannot be used.".
+     * This will be mapped to the "message" field in the error response for new versions.
+     * Required.
+     */
+    developerMessageFormat: string;
+    /**
+     * Lookup code for internationalizing the error message for the end users.
+     * Note: translation is not yet implemented.
+     * Optional.
+     */
+    userMessageFormatId: string;
+    /**
+     * Example EN-US message format for the end users, can have format placeholders, e.g. "The name {value} cannot be used."
+     * This will be mapped to the "user_message" field in the error response if present.
+     * Optional.
+     */
+    userMessageFormat: string;
+    /**
+     * Indicates if this error is considered retryable or not. This is mostly used to populate the Stripe-Should-Retry
+     * header and give users & the sdk a signal on if retrying is a productive operation. See .
+     */
+    shouldRetry: ShouldRetryError;
+}
+export interface NotificationSpec {
+    eventType: string;
+}
+export interface ApiEventSpec {
+    /** Publicly exposed/documented event name, e.g. 'llama.created' */
+    eventType: string;
+    /** Permission required to view and subscribe to event */
+    v1Permission: string;
+    /** API Event will be hidden unless opted into an API Feature */
+    feature: Feature;
+    /** Rollout configs are planned to replace v2 API Features. */
+    rolloutConfig: string;
+    /** Is this event publicly documented (part of SDKs, API ref, etc.) or just internal? */
+    documented: Documented;
+    /** The API Group the event belongs to */
+    apiGroup: ApiGroup;
+    /** An override annotation for overriding defaults from API Groups. */
+    override: ApiEventSpec_Override | undefined;
+    /** Alias used for routing events using their previous event type. */
+    eventTypeAlias: string[];
+    /** The object value of the resource associated with the event. */
+    primaryRelatedObject: string;
+    /** For events with an associated feature, only persist the event if the feature is enabled. */
+    conditionallyPersisted: boolean;
+    /**
+     * The scope for this event type.
+     * Defaults to WORKSPACE_ONLY when omitted.
+     */
+    eventScope: EventScope;
+    /**
+     * Whether this is an interop event that bridges v1/snapshot and v2/thin event types.
+     * Defaults to false when omitted.
+     */
+    interop: boolean;
+    /**
+     * Was primary_related_object_hidden, replaced by primary_related_object_exposed_as_event_field
+     * Whether the primary related object should be exposed as an event field in event data.
+     * When true, the primary related object ID (annotated with primary_related_object_id)
+     * will also be included as an event field in the generated event data.
+     * Defaults to false when omitted.
+     */
+    primaryRelatedObjectExposedAsEventField: boolean;
+    /**
+     * Polymorphic related object configuration.
+     * Use this instead of primary_related_object when the object type varies at runtime.
+     * When set, primary_related_object should be omitted.
+     */
+    polymorphicRelatedObject: PolymorphicRelatedObjectConfig | undefined;
+    /**
+     * Links a semantic event to its associated platform event.
+     * When this semantic event fires, the platform event should also be fired.
+     */
+    associatedPlatformEvent: string;
+    /** Declares what type of change this event represents (CREATION, MODIFICATION, DELETION, or NONE). */
+    changeTraitStyle: ChangeTraitStyle;
+}
+export interface ApiEventSpec_Override {
+    docsLevelOneGroup: string;
+}
+/**
+ * Configuration for events with polymorphic related_object types.
+ * Use this instead of primary_related_object when the object type varies at runtime.
+ */
+export interface PolymorphicRelatedObjectConfig {
+    /** The kind of polymorphism for this event. */
+    kind: PolymorphicRelatedObjectConfig_Kind;
+    /**
+     * The allowed object types. Only used when kind=STATIC.
+     * In proto3, repeated fields are inherently optional (zero or more).
+     */
+    staticTypes: string[];
+}
+/** The kind of polymorphism. */
+export declare const PolymorphicRelatedObjectConfig_Kind: {
+    /**
+     * KIND_INVALID - Invalid kind, should not be used.
+     * buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX
+     */
+    readonly KIND_INVALID: "KIND_INVALID";
+    /** STATIC - Bounded polymorphism - types are known at build time (e.g., V1 interop events) */
+    readonly STATIC: "STATIC";
+    /** DYNAMIC - Unbounded polymorphism - types come from external registry (e.g., UDP custom objects) */
+    readonly DYNAMIC: "DYNAMIC";
+    readonly UNRECOGNIZED: "UNRECOGNIZED";
+};
+export type PolymorphicRelatedObjectConfig_Kind = typeof PolymorphicRelatedObjectConfig_Kind[keyof typeof PolymorphicRelatedObjectConfig_Kind];
+export declare namespace PolymorphicRelatedObjectConfig_Kind {
+    type KIND_INVALID = typeof PolymorphicRelatedObjectConfig_Kind.KIND_INVALID;
+    type STATIC = typeof PolymorphicRelatedObjectConfig_Kind.STATIC;
+    type DYNAMIC = typeof PolymorphicRelatedObjectConfig_Kind.DYNAMIC;
+    type UNRECOGNIZED = typeof PolymorphicRelatedObjectConfig_Kind.UNRECOGNIZED;
+}
+/** Changes trait for the API Event */
+export interface Changes {
+    optionalBefore: //
+    /** optional. if provided, contains the resource state before changes. */
+    {
+        $case: "before";
+        value: Buffer;
+    } | undefined;
+    optionalAfter: //
+    /** optional. if provided, contains the resource state after changes. */
+    {
+        $case: "after";
+        value: Buffer;
+    } | undefined;
+}
+/** Event Diff field used for output only. */
+export interface EventDiff {
+    /** the fully qualified resource name of the field */
+    resource: string;
+    /** whether the field is pre-rendered */
+    prerendered: boolean;
+}
+export interface ResourceReference {
+    /** Full type name for resource reference */
+    type: string;
+    /** Method name for resource reference */
+    method: string;
+    /** [Optional] Mapping of field name from this message to the param field in the request message */
+    mapping: Mapping[];
+    /** [optional] The account field associated with the object reference. Only used if we need to specify account context. */
+    account: string;
+}
+export interface VirtualField {
+    /** Virtual field name in this message */
+    name: string;
+    /** Resource type */
+    type: string;
+    /** Method name */
+    method: string;
+    /** Mapping of field name from this message to the param field in the request message */
+    mapping: Mapping[];
+}
+export interface Mapping {
+    /** Input field name in the current message */
+    from: string;
+    /** Output field name to set in the request message */
+    to: string;
+}
+/** Represents an arbitrary precision decimal, similar to Java's BigDecimal */
+export interface Decimal {
+    value: string;
+}
+/**
+ * Represents a target compartment for the request
+ *
+ * Target compartment field should be added to the methods with no other resources, e.g., Create or List.
+ *
+ * The target compartment is set automatically by API and GraphQL Gateways for public API calls
+ * and must be set by the caller for service to service calls. The target compartment is not exposed via public API
+ */
+export interface TargetCompartment {
+    id: string;
+    accountToken: string;
+}
+/**
+ * Represents Idempotency Key passed from API Gateway.
+ *
+ * This should be added to methods with idempotent operations
+ *
+ * See for more details.
+ * Recommendation is to annotate this message with OBJECT_IDENTIFIER when used in your protos
+ */
+export interface IdempotencyKey {
+    id: string;
+    /**
+     * The fingerprint of this request, it will be a 128-bit hash.
+     * Requests with the same idempotency scope & key but different fingerprints should be rejected by service owners.
+     * If misuse is detected, raise an IdempotencyKeyMisuseException.
+     */
+    fingerprint: string;
+}
+/**
+ * Represents the API version for the request
+ *
+ * API Version field should only be added to methods that require version information and can't rely
+ * on the standard versioning mechanism.
+ *
+ * The API version is set automatically by API and GraphQL Gateways for public API calls and must
+ * be set by the caller for service to service calls. The API version is not exposed via public API
+ */
+export interface ApiVersion {
+    version: string;
+    requestedVersion: string;
+}
+/** Used when the related object type, URL, or ID cannot be derived from the event spec */
+export interface RuntimeRelatedObject {
+    /** The object type (e.g., "bank_account", "card"). */
+    type: string;
+    /** The retrieve URL for the object. */
+    url: string;
+    /** The object ID. */
+    id: string;
+}
+/**
+ * Represents the metadata necessary for publishing the event.
+ *
+ * This field should be added to any method that publishes events.
+ */
+export interface EventMetadata {
+    /** User-provided idempotency key. */
+    idempotencyKey: string;
+    /** Request id. */
+    requestId: string;
+    /** Override the original event publish time. */
+    overrideCreatedAt: Date | undefined;
+    realIp: string;
+    machineIdentifier: string;
+    /** next 7 */
+    principalId: string;
+}
+export interface SystemFieldOptions {
+    /** Redaction status for Request Logs. This will be added automatically based on privacy annotations */
+    redaction: Redaction;
+    /**
+     * Override redaction status for dashboard responses. Uses the request log redaction by default.
+     * This will be added automatically based on privacy annotations.
+     */
+    dashboardResponseRedaction: Redaction;
+    privacyKind: FieldPrivacySetting | undefined;
+    /** Documentation for this field. This will be added automatically based on comments in the proto file. */
+    docString: string;
+}
+export interface SystemEnumOptions {
+    /** Documentation for this enum. This will be added automatically based on comments in the proto file. */
+    docString: string;
+}
+export interface SystemEnumValueOptions {
+    /** Documentation for this enum value. This will be added automatically based on comments in the proto file. */
+    docString: string;
+    /** next 3 */
+    fallbackOf: number[];
+}
+export interface SystemServiceOptions {
+    /** Documentation for this service. This will be added automatically based on comments in the proto file. */
+    docString: string;
+}
+export interface SystemMethodOptions {
+    /** Documentation for this method. This will be added automatically based on comments in the proto file. */
+    docString: string;
+    /** next 3 */
+    docsSamples: string;
+}
+export interface SystemMessageOptions {
+    /** Documentation for this message. This will be added automatically based on comments in the proto file. */
+    docString: string;
+}
+export interface SystemOneOfOptions {
+    /** Documentation for this one_of. This will be added automatically based on comments in the proto file. */
+    docString: string;
+}
+/** Recommendation is to annotate this message with EXTERNAL_REFERENCE when used in your protos */
+export interface RequestMetadata {
+    requestId: string;
+    realIp: string;
+    httpUserAgent: string;
+    origin: string;
+    referer: string;
+    /** : We need to integrate with the cookie framework to limit sending this to specific services */
+    privateMachineIdentifier: string;
+    machineIdentifier: string;
+    stripeContext: string;
+    acceptLanguage: string;
+}
+/**
+ * LocationHeader represents the content of the Location header that is required to be attached to the response body of
+ * certain SCIM requests.
+ *
+ * The Location header MUST be set in response to a successful HTTP POST request that creates a resource.
+ * The header must provide the URI of the newly created resource. (This allows clients to easily access or interact with
+ * the resource they just created.)
+ *
+ * Backing services should only set this header in response to a SCIM request.
+ *
+ * See https://datatracker.ietf.org/doc/html/rfc7644.
+ */
+export interface LocationHeader {
+    /** Value of the Location header */
+    value: string;
+}
+/** Generated internally from Skycfg definitions. Do not use directly! */
+export interface RolloutConfigSpec {
+    /** The unique ID of the rollout config. */
+    id: string;
+    /** The current release phase of the rollout config. */
+    phase: RolloutConfig_RolloutConfigPhase;
+    /** The current per-phase revision of the rollout config, if it has been revised without changing phase. */
+    phaseRevision: number;
+}
+/** Deprecated! Do not use. */
+export interface DocsSample {
+}
+/**
+ * CustomSuccessStatusCode is a custom 2xx HTTP status code that can optionally be attached to the response body.
+ *
+ * In the absence of this field, the status code of all successful requests will be 200.
+ *
+ * A limited set of success codes are supported at the moment.
+ *
+ * CustomSuccessStatusCode can only be set on responses to SCIM requests.
+ */
+export interface CustomSuccessCode {
+    code: CustomSuccessCode_Code;
+}
+export declare const CustomSuccessCode_Code: {
+    /** CODE_INVALID - buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX */
+    readonly CODE_INVALID: "CODE_INVALID";
+    readonly CREATED_201: "CREATED_201";
+    readonly NO_CONTENT_204: "NO_CONTENT_204";
+    readonly UNRECOGNIZED: "UNRECOGNIZED";
+};
+export type CustomSuccessCode_Code = typeof CustomSuccessCode_Code[keyof typeof CustomSuccessCode_Code];
+export declare namespace CustomSuccessCode_Code {
+    type CODE_INVALID = typeof CustomSuccessCode_Code.CODE_INVALID;
+    type CREATED_201 = typeof CustomSuccessCode_Code.CREATED_201;
+    type NO_CONTENT_204 = typeof CustomSuccessCode_Code.NO_CONTENT_204;
+    type UNRECOGNIZED = typeof CustomSuccessCode_Code.UNRECOGNIZED;
+}
+export interface OneOfOptions {
+    polymorphic: OneOfOptions_Polymorphic | undefined;
+}
+export interface OneOfOptions_Polymorphic {
+    outputOnly: boolean;
+    graphQlRepresentation: OneOfOptions_Polymorphic_GraphQlRepresentation;
+    ignoreUsedForDiffTestingOnly: number;
+}
+export declare const OneOfOptions_Polymorphic_GraphQlRepresentation: {
+    /** GRAPH_QL_REPRESENTATION_INVALID - buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX */
+    readonly GRAPH_QL_REPRESENTATION_INVALID: "GRAPH_QL_REPRESENTATION_INVALID";
+    readonly STRINGIFY: "STRINGIFY";
+    readonly UNRECOGNIZED: "UNRECOGNIZED";
+};
+export type OneOfOptions_Polymorphic_GraphQlRepresentation = typeof OneOfOptions_Polymorphic_GraphQlRepresentation[keyof typeof OneOfOptions_Polymorphic_GraphQlRepresentation];
+export declare namespace OneOfOptions_Polymorphic_GraphQlRepresentation {
+    type GRAPH_QL_REPRESENTATION_INVALID = typeof OneOfOptions_Polymorphic_GraphQlRepresentation.GRAPH_QL_REPRESENTATION_INVALID;
+    type STRINGIFY = typeof OneOfOptions_Polymorphic_GraphQlRepresentation.STRINGIFY;
+    type UNRECOGNIZED = typeof OneOfOptions_Polymorphic_GraphQlRepresentation.UNRECOGNIZED;
+}
+export interface EnumOptions {
+    type: EnumOptions_Type;
+}
+export declare const EnumOptions_Type: {
+    /** TYPE_INVALID - buf:lint:ignore ENUM_ZERO_VALUE_SUFFIX */
+    readonly TYPE_INVALID: "TYPE_INVALID";
+    readonly OPEN: "OPEN";
+    readonly CLOSED: "CLOSED";
+    readonly UNRECOGNIZED: "UNRECOGNIZED";
+};
+export type EnumOptions_Type = typeof EnumOptions_Type[keyof typeof EnumOptions_Type];
+export declare namespace EnumOptions_Type {
+    type TYPE_INVALID = typeof EnumOptions_Type.TYPE_INVALID;
+    type OPEN = typeof EnumOptions_Type.OPEN;
+    type CLOSED = typeof EnumOptions_Type.CLOSED;
+    type UNRECOGNIZED = typeof EnumOptions_Type.UNRECOGNIZED;
+}
+type ProtoMetaMessageOptions = {
+    options?: {
+        [key: string]: any;
+    };
+    fields?: {
+        [key: string]: {
+            [key: string]: any;
+        };
+    };
+    oneof?: {
+        [key: string]: {
+            [key: string]: any;
+        };
+    };
+    nested?: {
+        [key: string]: ProtoMetaMessageOptions;
+    };
+};
+export interface ProtoMetadata {
+    references: {
+        [key: string]: any;
+    };
+    dependencies?: ProtoMetadata[];
+    options?: {
+        options?: {
+            [key: string]: any;
+        };
+        services?: {
+            [key: string]: {
+                options?: {
+                    [key: string]: any;
+                };
+                methods?: {
+                    [key: string]: {
+                        [key: string]: any;
+                    };
+                };
+            };
+        };
+        messages?: {
+            [key: string]: ProtoMetaMessageOptions;
+        };
+        enums?: {
+            [key: string]: {
+                options?: {
+                    [key: string]: any;
+                };
+                values?: {
+                    [key: string]: {
+                        [key: string]: any;
+                    };
+                };
+            };
+        };
+    };
+}
+export declare const protoMetadata: ProtoMetadata;
+export {};
+//# sourceMappingURL=v2ext.pb.d.ts.map