import { CreateDonationCampaignRequest as CreateDonationCampaignRequest$1, CreateDonationCampaignResponse as CreateDonationCampaignResponse$1, GetDonationCampaignRequest as GetDonationCampaignRequest$1, GetDonationCampaignResponse as GetDonationCampaignResponse$1, UpdateDonationCampaignRequest as UpdateDonationCampaignRequest$1, UpdateDonationCampaignResponse as UpdateDonationCampaignResponse$1, QueryDonationCampaignsRequest as QueryDonationCampaignsRequest$1, QueryDonationCampaignsResponse as QueryDonationCampaignsResponse$1, BulkCreateDonationCampaignsRequest as BulkCreateDonationCampaignsRequest$1, BulkCreateDonationCampaignsResponse as BulkCreateDonationCampaignsResponse$1, BulkUpdateDonationCampaignsRequest as BulkUpdateDonationCampaignsRequest$1, BulkUpdateDonationCampaignsResponse as BulkUpdateDonationCampaignsResponse$1, GetDonationCampaignMetricsRequest as GetDonationCampaignMetricsRequest$1, GetDonationCampaignMetricsResponse as GetDonationCampaignMetricsResponse$1, BulkUpdateDonationCampaignTagsRequest as BulkUpdateDonationCampaignTagsRequest$1, BulkUpdateDonationCampaignTagsResponse as BulkUpdateDonationCampaignTagsResponse$1, BulkUpdateDonationCampaignTagsByFilterRequest as BulkUpdateDonationCampaignTagsByFilterRequest$1, BulkUpdateDonationCampaignTagsByFilterResponse as BulkUpdateDonationCampaignTagsByFilterResponse$1 } from './index.typings.js'; import '@wix/sdk-types'; /** * A donation campaign represents a fundraising initiative that allows collecting donations * for a specific cause or goal. Campaigns can be configured with various donation options, * including one-time and recurring payments, predefined amounts, and campaign goals. * * Use the Donation Campaigns API to create and manage donation campaigns on your site. */ interface DonationCampaign { /** * Donation campaign ID. * @format GUID * @readonly */ id?: string | null; /** * Revision number, which increments by 1 each time the donation campaign is updated. * To prevent conflicting changes, the current `revision` must be specified when updating the donation campaign. * * Ignored when creating a donation campaign. * @readonly */ revision?: string | null; /** * Date and time the donation campaign was created. * @readonly */ createdDate?: Date | null; /** * Date and time the donation campaign was last updated. * @readonly */ updatedDate?: Date | null; /** * Name of the donation campaign. * @minLength 1 * @maxLength 65 */ name?: string; /** * Whether the donation campaign is archived and hidden from site visitors. * Archived campaigns can't accept donations. * * Default: `false` */ archived?: boolean; /** * Current status of the donation campaign. * * The status is automatically calculated based on campaign settings and current progress: * - `COLLECTING`: Campaign is active and accepting donations * - `EXPIRED`: Campaign has passed its end date and `acceptDonationsAfterEndDate` is `false` * - `GOAL_REACHED`: Campaign has reached its target amount and `acceptDonationsAfterGoal` is `false` * @readonly */ status?: StatusWithLiterals; /** Cover image for the donation campaign. */ coverImage?: Image; /** * Whether donors can specify their own donation amount. * If custom amounts are disabled, at least one predefined amount must be provided. * * Default: `false` */ customAmountEnabled?: boolean | null; /** Optional settings for custom donation amounts. */ customAmountOptions?: CustomAmountOptions; /** * Predefined donation amounts. * * Each amount can include an optional description explaining its impact. For example, "Feed 5 families for a week". * @maxSize 20 */ predefinedDonationAmounts?: PredefinedAmount[]; /** Campaign fundraising goal. */ campaignGoal?: CampaignGoal; /** * Whether donors can add comments to their donations. * * Default: `false` */ commentsEnabled?: boolean; /** * Donation frequencies available for this campaign. * * At least one frequency must be specified. * @minSize 1 * @maxSize 4 */ donationFrequencies?: FrequencyWithLiterals[]; /** * Whether to ask donors during checkout if they want to add 2.9% to their donation to cover fees. * * When `false`, fees are deducted from the donation amount, * meaning the campaign receives less than the donor's original contribution. * * When `true`, donors are presented with an option in the checkout UI to * add a 2.9% fee on top of their donation. This fee helps offset * processing costs, ensuring more of the original donation reaches the campaign. * The donor always has the choice — they are never automatically charged the fee. * * For recurring donations, if the donor opts to cover fees, the 2.9% fee * is applied to each recurring payment (not just the first one). * * > **Notes:** * > + The 2.9% rate is fixed and cannot be customized by campaign owners. * > + This feature works with all payment methods and currencies. * * Default: `false` */ askDonorCoverFee?: boolean; /** * Custom field data for the program definition object. * * [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls. */ extendedFields?: ExtendedFields; /** Tags assigned to this donation campaign. */ tags?: Tags; } declare enum Status { /** Campaign is actively accepting donations. */ COLLECTING = "COLLECTING", /** Campaign has passed its `endDate` and `acceptDonationsAfterEndDate` is `false`. */ EXPIRED = "EXPIRED", /** Campaign has reached its `targetAmount` and `acceptDonationsAfterGoal` is `false`. */ GOAL_REACHED = "GOAL_REACHED" } /** @enumType */ type StatusWithLiterals = Status | 'COLLECTING' | 'EXPIRED' | 'GOAL_REACHED'; interface Image { /** * WixMedia image ID. * @maxLength 256 */ id?: string; /** * Image URL. * @format WEB_URL */ url?: string; /** * Original image height. * @readonly */ height?: number; /** * Original image width. * @readonly */ width?: number; /** * Image alt text. * @maxLength 256 */ altText?: string | null; /** * Image URL expiration date (when relevant). * @internal * @readonly */ urlExpirationDate?: Date | null; /** * Image filename. * @readonly * @maxLength 256 */ filename?: string | null; /** * Image size in bytes. * @internal * @readonly * @format DECIMAL_VALUE * @decimalValue options { maxScale:0 } */ sizeInBytes?: string | null; /** * Focal point of the image. * @internal */ focalPoint?: FocalPoint; } interface FocalPoint { /** X-coordinate of the focal point. */ x?: number; /** Y-coordinate of the focal point. */ y?: number; /** crop by height */ height?: number | null; /** crop by width */ width?: number | null; } /** Configures custom donation amount settings, allowing donors to specify their own contribution amount within optional limits. */ interface CustomAmountOptions { /** Minimum donation amount. */ minimum?: MultiCurrencyPrice; /** Maximum donation amount. */ maximum?: MultiCurrencyPrice; } interface MultiCurrencyPrice { /** * Amount. * @decimalValue options { gte:0, lte:1000000000000000 } */ amount?: string; /** * Converted amount. * @readonly * @decimalValue options { gte:0, lte:1000000000000000 } */ convertedAmount?: string; /** * Amount formatted with currency symbol. * @readonly */ formattedAmount?: string; /** * Converted amount formatted with currency symbol. * @readonly */ formattedConvertedAmount?: string; } interface PredefinedAmount { /** * Predefined amount ID. * You must provide this ID when creating or updating campaigns. * @format GUID */ id?: string; /** * Donation amount. * * Currently supports the site's default currency only. */ price?: MultiCurrencyPrice; /** * Description explaining the impact of this donation amount. For example, "Feed 5 families for a week" or "Plant 10 trees". * @maxLength 200 */ description?: string | null; } interface CampaignGoal { /** * Target fundraising amount. * * Currently supports the site's default currency only. */ targetAmount?: MultiCurrencyPrice; /** * Campaign end date in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. * * The behavior after this date is controlled by `acceptDonationsAfterEndDate`. */ endDate?: Date | null; /** * Whether donations are accepted after `endDate`. This field is ignored if `endDate` is not set. * * Default: `false` */ acceptDonationsAfterEndDate?: boolean | null; /** * Whether donations are accepted after reaching `targetAmount`. * * Default: `true` */ acceptDonationsAfterGoal?: boolean | null; } declare enum Frequency { /** One-time donation. */ ONE_TIME = "ONE_TIME", /** Weekly recurring donation. */ WEEK = "WEEK", /** Monthly recurring donation. */ MONTH = "MONTH", /** Yearly recurring donation. */ YEAR = "YEAR" } /** @enumType */ type FrequencyWithLiterals = Frequency | 'ONE_TIME' | 'WEEK' | 'MONTH' | 'YEAR'; interface ExtendedFields { /** * Extended field data. Each key corresponds to the namespace of the app that created the extended fields. * The value of each key is structured according to the schema defined when the extended fields were configured. * * You can only access fields for which you have the appropriate permissions. * * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields). */ namespaces?: Record>; } /** * Common object for tags. * Should be use as in this example: * message Foo { * option (.wix.api.decomposite_of) = "wix.commons.v2.tags.Foo"; * string id = 1; * ... * Tags tags = 5 * } * * example of taggable entity * { * id: "123" * tags: { * public_tags: { * tag_ids:["11","22"] * }, * private_tags: { * tag_ids: ["33", "44"] * } * } * } */ interface Tags { /** Tags that require an additional permission in order to access them, typically restricted from site members and visitors. */ privateTags?: TagList; /** Tags that are exposed to anyone with access to the entity, including site members and visitors. */ publicTags?: TagList; } interface TagList { /** * List of tag IDs. * @maxSize 100 * @maxLength 5 */ tagIds?: string[]; } interface TagsModified { /** Updated donation campaign. */ donationCampaign?: DonationCampaign; /** Tags that are assigned. */ assignedTags?: Tags; /** Tags that are unassigned. */ unassignedTags?: Tags; } interface StatusChanged { /** Donation campaign with updated status. */ donationCampaign?: DonationCampaign; /** Previous status of the donation campaign. */ previousStatus?: StatusWithLiterals; /** New status of the donation campaign. */ newStatus?: StatusWithLiterals; } interface CreateDonationCampaignRequest { /** Donation campaign to create. */ donationCampaign: DonationCampaign; } interface CreateDonationCampaignResponse { /** Created donation campaign. */ donationCampaign?: DonationCampaign; } interface GetDonationCampaignRequest { /** * ID of the donation campaign to retrieve. * @format GUID */ donationCampaignId: string; } interface GetDonationCampaignResponse { /** Retrieved donation campaign. */ donationCampaign?: DonationCampaign; } interface UpdateDonationCampaignRequest { /** Donation campaign to update. May be partial. */ donationCampaign: DonationCampaign; /** * Set of fields to update. * * Fields that aren't included in `fieldMask.paths` are ignored. * @internal */ fieldMask?: string[]; } interface UpdateDonationCampaignResponse { /** Updated donation campaign. */ donationCampaign?: DonationCampaign; } interface QueryDonationCampaignsRequest { /** Query options. */ query?: CursorQuery; } interface CursorQuery extends CursorQueryPagingMethodOneOf { /** * Cursor paging options. * * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging). */ cursorPaging?: CursorPaging; /** * Filter object. * * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section). */ filter?: Record | null; /** * Sort object. * * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section). * @maxSize 5 */ sort?: Sorting[]; } /** @oneof */ interface CursorQueryPagingMethodOneOf { /** * Cursor paging options. * * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging). */ cursorPaging?: CursorPaging; } interface Sorting { /** * Name of the field to sort by. * @maxLength 512 */ fieldName?: string; /** Sort order. */ order?: SortOrderWithLiterals; /** * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked. * * If multiple filters are provided, they are combined with AND operator. * * Example: * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]} * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] } * @internal * @maxSize 10 */ selectItemsBy?: Record[] | null; } declare enum SortOrder { ASC = "ASC", DESC = "DESC" } /** @enumType */ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC'; interface CursorPaging { /** * Maximum number of items to return in the results. * @max 100 */ limit?: number | null; /** * Pointer to the next or previous page in the list of results. * * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. * Not relevant for the first request. * @maxLength 16000 */ cursor?: string | null; } interface QueryDonationCampaignsResponse { /** List of donation campaigns matching the query. */ donationCampaigns?: DonationCampaign[]; /** Paging metadata for handling large result sets. */ pagingMetadata?: CursorPagingMetadata; } interface CursorPagingMetadata { /** Number of items returned in current page. */ count?: number | null; /** Cursor strings that point to the next page, previous page, or both. */ cursors?: Cursors; /** * Whether there are more pages to retrieve following the current page. * * + `true`: Another page of results can be retrieved. * + `false`: This is the last page. */ hasNext?: boolean | null; /** * Total number of items matching the filter. * Available only on the first page of *Search* results, not included in *Query* or *List* results. * If the Search results span multiple pages, the value of `total` will exceed the number of items returned on the first page. * @internal */ total?: number | null; } interface Cursors { /** * Cursor string pointing to the next page in the list of results. * @maxLength 16000 */ next?: string | null; /** * Cursor pointing to the previous page in the list of results. * @maxLength 16000 */ prev?: string | null; } interface BulkCreateDonationCampaignsRequest { /** * Donation campaigns to create. * @minSize 1 * @maxSize 100 */ donationCampaigns: DonationCampaign[]; /** * Whether to return the created donation campaigns in the response. * * Default: `false` */ returnEntity?: boolean; } interface BulkCreateDonationCampaignsResponse { /** * Results of the bulk create operation including campaigns and metadata. * @minSize 1 * @maxSize 100 */ results?: BulkDonationCampaignResult[]; /** Metadata about the bulk operation. */ bulkActionMetadata?: BulkActionMetadata; } interface ItemMetadata { /** * Item ID. Provided only whenever possible. For example, `itemId` can't be provided when item creation has failed. * @format GUID */ id?: string | null; /** Index of the item within the request array. Allows for correlation between request and response items. */ originalIndex?: number; /** Whether the requested action for this item was successful. When `false`, the `error` field is returned. */ success?: boolean; /** Details about the error in case of failure. */ error?: ApplicationError; } interface ApplicationError { /** Error code. */ code?: string; /** Description of the error. */ description?: string; /** Data related to the error. */ data?: Record | null; } interface BulkDonationCampaignResult { /** Metadata about a single create operation. */ itemMetadata?: ItemMetadata; /** * Created campaign. * * Only present if `returnEntity` was `true`. */ item?: DonationCampaign; } interface BulkActionMetadata { /** Number of items that were successfully processed. */ totalSuccesses?: number; /** Number of items that couldn't be processed. */ totalFailures?: number; /** Number of failures without details because detailed failure threshold was exceeded. */ undetailedFailures?: number; } interface BulkUpdateDonationCampaignsRequest { /** * Donation campaigns to update. * @minSize 1 * @maxSize 100 */ donationCampaigns: MaskedDonationCampaign[]; /** * Whether to return the updated donation campaigns in the response. * * Default: `false` */ returnEntity?: boolean; } interface MaskedDonationCampaign { /** Donation campaign to update. */ donationCampaign?: DonationCampaign; /** * Set of fields to update. * @internal */ fieldMask?: string[]; } interface BulkUpdateDonationCampaignsResponse { /** * Results of the bulk update operation. * @minSize 1 * @maxSize 100 */ results?: BulkUpdateDonationCampaignsResponseBulkDonationCampaignResult[]; /** Metadata about the bulk operation. */ bulkActionMetadata?: BulkActionMetadata; } interface BulkUpdateDonationCampaignsResponseBulkDonationCampaignResult { /** Metadata about a single update operation. */ itemMetadata?: ItemMetadata; /** * Updated campaign. * * Only present if `returnEntity` was `true`. */ item?: DonationCampaign; } interface GetDonationCampaignMetricsRequest { /** * ID of the donation campaign to retrieve metrics for. * @format GUID */ donationCampaignId: string; } interface GetDonationCampaignMetricsResponse { /** * List of metrics per currency. * * Currently returns only the site's default currency. * @maxSize 1 */ currencyMetricsList?: CurrencyMetrics[]; } interface CurrencyMetrics { /** * Three-letter currency code in ISO-4217 alphabetic format. * @maxLength 8 */ currencyCode?: string; /** Total number of successful donations. */ donationCount?: number; /** Total amount collected from all donations. */ totalAmount?: MultiCurrencyPrice; } interface DomainEvent extends DomainEventBodyOneOf { createdEvent?: EntityCreatedEvent; updatedEvent?: EntityUpdatedEvent; deletedEvent?: EntityDeletedEvent; actionEvent?: ActionEvent; /** Event ID. With this ID you can easily spot duplicated events and ignore them. */ id?: string; /** * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities. * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`. */ entityFqdn?: string; /** * Event action name, placed at the top level to make it easier for users to dispatch messages. * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`. */ slug?: string; /** ID of the entity associated with the event. */ entityId?: string; /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */ eventTime?: Date | null; /** * Whether the event was triggered as a result of a privacy regulation application * (for example, GDPR). */ triggeredByAnonymizeRequest?: boolean | null; /** If present, indicates the action that triggered the event. */ originatedFrom?: string | null; /** * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number. * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it. */ entityEventSequence?: string | null; } /** @oneof */ interface DomainEventBodyOneOf { createdEvent?: EntityCreatedEvent; updatedEvent?: EntityUpdatedEvent; deletedEvent?: EntityDeletedEvent; actionEvent?: ActionEvent; } interface EntityCreatedEvent { entityAsJson?: string; /** * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity * @internal */ triggeredByUndelete?: boolean | null; /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */ restoreInfo?: RestoreInfo; /** * Optional domain-specific metadata defined by the API owner, encoded as JSON. * @internal */ additionalMetadataAsJson?: string | null; } interface RestoreInfo { deletedDate?: Date | null; } interface EntityUpdatedEvent { /** * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff. * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects. * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it. */ currentEntityAsJson?: string; /** * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard * wont populate it / have any reference to it in the API. * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed, * the developer should send only the new (current) entity. * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message. * @internal * @deprecated */ previousEntityAsJson?: string | null; /** * Map of fully qualified field paths to their previous values for fields that changed. * For more details please see [AIP](https://dev.wix.com/docs/rnd-general/articles/p13n-guidelines-aips/guidance-aips/design-patterns/7016-events#modified-fields-format) * @internal */ modifiedFields?: Record; /** * Optional domain-specific metadata defined by the API owner, encoded as JSON. * @internal */ additionalMetadataAsJson?: string | null; } interface EntityDeletedEvent { /** * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled * @internal */ movedToTrash?: boolean | null; /** Entity that was deleted. */ deletedEntityAsJson?: string | null; /** * Optional domain-specific metadata defined by the API owner, encoded as JSON. * @internal */ additionalMetadataAsJson?: string | null; } interface ActionEvent { bodyAsJson?: string; } interface Empty { } interface BulkUpdateDonationCampaignTagsRequest { /** * Donation campaign IDs. * @minSize 1 * @maxSize 100 * @format GUID */ ids: string[]; /** * Tags to assign. * If a tag already exists on a campaign, it remains assigned. */ assignTags?: Tags; /** * Tags to unassign. * If a tag doesn't exist on a campaign, it's ignored. */ unassignTags?: Tags; } interface BulkUpdateDonationCampaignTagsResponse { /** * Results of the tag update operation. * @minSize 1 * @maxSize 100 */ results?: BulkUpdateDonationCampaignTagsResult[]; /** Metadata about the bulk operation. */ bulkActionMetadata?: BulkActionMetadata; } interface BulkUpdateDonationCampaignTagsResult { /** Metadata about this specific tag update operation. */ itemMetadata?: ItemMetadata; } interface BulkUpdateDonationCampaignTagsByFilterRequest { /** * Filter object. An empty filter updates all campaigns. * * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters). */ filter: Record | null; /** * Tags to assign. * If a tag already exists on a campaign, it remains assigned. */ assignTags?: Tags; /** * Tags to unassign. * If a tag doesn't exist on a campaign, it's ignored. */ unassignTags?: Tags; } interface BulkUpdateDonationCampaignTagsByFilterResponse { /** * Job ID for tracking the operation. * * Learn more about working with [async jobs](https://dev.wix.com/docs/rest/business-management/async-job/introduction). * @format GUID */ jobId?: string; } interface MessageEnvelope { /** * App instance ID. * @format GUID */ instanceId?: string | null; /** * Event type. * @maxLength 150 */ eventType?: string; /** The identification type and identity data. */ identity?: IdentificationData; /** Stringify payload. */ data?: string; /** Details related to the account */ accountInfo?: AccountInfo; } interface IdentificationData extends IdentificationDataIdOneOf { /** * ID of a site visitor that has not logged in to the site. * @format GUID */ anonymousVisitorId?: string; /** * ID of a site visitor that has logged in to the site. * @format GUID */ memberId?: string; /** * ID of a Wix user (site owner, contributor, etc.). * @format GUID */ wixUserId?: string; /** * ID of an app. * @format GUID */ appId?: string; /** @readonly */ identityType?: WebhookIdentityTypeWithLiterals; } /** @oneof */ interface IdentificationDataIdOneOf { /** * ID of a site visitor that has not logged in to the site. * @format GUID */ anonymousVisitorId?: string; /** * ID of a site visitor that has logged in to the site. * @format GUID */ memberId?: string; /** * ID of a Wix user (site owner, contributor, etc.). * @format GUID */ wixUserId?: string; /** * ID of an app. * @format GUID */ appId?: string; } declare enum WebhookIdentityType { UNKNOWN = "UNKNOWN", ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR", MEMBER = "MEMBER", WIX_USER = "WIX_USER", APP = "APP" } /** @enumType */ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP'; interface AccountInfo { /** * ID of the Wix account associated with the event. * @format GUID */ accountId?: string | null; /** * ID of the parent Wix account. Only included when accountId belongs to a child account. * @format GUID */ parentAccountId?: string | null; /** * ID of the Wix site associated with the event. Only included when the event is tied to a specific site. * @format GUID */ siteId?: string | null; } /** @docsIgnore */ type CreateDonationCampaignApplicationErrors = { code?: 'SITE_CURRENCY_UNAVAILABLE'; description?: string; data?: Record; }; /** @docsIgnore */ type CreateDonationCampaignValidationErrors = { ruleName?: 'NO_PAYMENT_DEFINITION'; } | { ruleName?: 'NON_POSITIVE_CAMPAIGN_GOAL_AMOUNT'; } | { ruleName?: 'INVALID_CUSTOM_AMOUNT_RANGE'; } | { ruleName?: 'DUPLICATE_PREDEFINED_AMOUNTS'; } | { ruleName?: 'NON_POSITIVE_PREDEFINED_AMOUNT'; } | { ruleName?: 'EMPTY_CAMPAIGN_NAME'; }; /** @docsIgnore */ type GetDonationCampaignApplicationErrors = { code?: 'SITE_CURRENCY_UNAVAILABLE'; description?: string; data?: Record; }; /** @docsIgnore */ type UpdateDonationCampaignApplicationErrors = { code?: 'SITE_CURRENCY_UNAVAILABLE'; description?: string; data?: Record; }; /** @docsIgnore */ type UpdateDonationCampaignValidationErrors = { ruleName?: 'NO_PAYMENT_DEFINITION'; } | { ruleName?: 'NON_POSITIVE_CAMPAIGN_GOAL_AMOUNT'; } | { ruleName?: 'INVALID_CUSTOM_AMOUNT_RANGE'; } | { ruleName?: 'DUPLICATE_PREDEFINED_AMOUNTS'; } | { ruleName?: 'NON_POSITIVE_PREDEFINED_AMOUNT'; } | { ruleName?: 'EMPTY_CAMPAIGN_NAME'; }; /** @docsIgnore */ type QueryDonationCampaignsApplicationErrors = { code?: 'SITE_CURRENCY_UNAVAILABLE'; description?: string; data?: Record; }; /** @docsIgnore */ type BulkCreateDonationCampaignsApplicationErrors = { code?: 'SITE_CURRENCY_UNAVAILABLE'; description?: string; data?: Record; }; /** @docsIgnore */ type BulkCreateDonationCampaignsValidationErrors = { ruleName?: 'NO_PAYMENT_DEFINITION'; } | { ruleName?: 'NON_POSITIVE_CAMPAIGN_GOAL_AMOUNT'; } | { ruleName?: 'INVALID_CUSTOM_AMOUNT_RANGE'; } | { ruleName?: 'DUPLICATE_PREDEFINED_AMOUNTS'; } | { ruleName?: 'NON_POSITIVE_PREDEFINED_AMOUNT'; } | { ruleName?: 'EMPTY_CAMPAIGN_NAME'; }; /** @docsIgnore */ type BulkUpdateDonationCampaignsApplicationErrors = { code?: 'SITE_CURRENCY_UNAVAILABLE'; description?: string; data?: Record; }; /** @docsIgnore */ type BulkUpdateDonationCampaignsValidationErrors = { ruleName?: 'NO_PAYMENT_DEFINITION'; } | { ruleName?: 'NON_POSITIVE_CAMPAIGN_GOAL_AMOUNT'; } | { ruleName?: 'INVALID_CUSTOM_AMOUNT_RANGE'; } | { ruleName?: 'DUPLICATE_PREDEFINED_AMOUNTS'; } | { ruleName?: 'NON_POSITIVE_PREDEFINED_AMOUNT'; } | { ruleName?: 'EMPTY_CAMPAIGN_NAME'; }; /** @docsIgnore */ type GetDonationCampaignMetricsApplicationErrors = { code?: 'CAMPAIGN_GOAL_NOT_SET'; description?: string; data?: Record; } | { code?: 'SITE_CURRENCY_UNAVAILABLE'; description?: string; data?: Record; } | { code?: 'METRICS_TEMPORARILY_UNAVAILABLE'; description?: string; data?: Record; }; /** @docsIgnore */ type BulkUpdateDonationCampaignTagsApplicationErrors = { code?: 'EMPTY_ASSIGN_AND_UNASSIGN_LISTS'; description?: string; data?: Record; } | { code?: 'SITE_CURRENCY_UNAVAILABLE'; description?: string; data?: Record; }; /** @docsIgnore */ type BulkUpdateDonationCampaignTagsByFilterApplicationErrors = { code?: 'EMPTY_ASSIGN_AND_UNASSIGN_LISTS'; description?: string; data?: Record; } | { code?: 'SITE_CURRENCY_UNAVAILABLE'; description?: string; data?: Record; }; type __PublicMethodMetaInfo = { getUrl: (context: any) => string; httpMethod: K; path: string; pathParams: M; __requestType: T; __originalRequestType: S; __responseType: Q; __originalResponseType: R; }; declare function createDonationCampaign(): __PublicMethodMetaInfo<'POST', {}, CreateDonationCampaignRequest$1, CreateDonationCampaignRequest, CreateDonationCampaignResponse$1, CreateDonationCampaignResponse>; declare function getDonationCampaign(): __PublicMethodMetaInfo<'GET', { donationCampaignId: string; }, GetDonationCampaignRequest$1, GetDonationCampaignRequest, GetDonationCampaignResponse$1, GetDonationCampaignResponse>; declare function updateDonationCampaign(): __PublicMethodMetaInfo<'PATCH', { donationCampaignId: string; }, UpdateDonationCampaignRequest$1, UpdateDonationCampaignRequest, UpdateDonationCampaignResponse$1, UpdateDonationCampaignResponse>; declare function queryDonationCampaigns(): __PublicMethodMetaInfo<'GET', {}, QueryDonationCampaignsRequest$1, QueryDonationCampaignsRequest, QueryDonationCampaignsResponse$1, QueryDonationCampaignsResponse>; declare function bulkCreateDonationCampaigns(): __PublicMethodMetaInfo<'POST', {}, BulkCreateDonationCampaignsRequest$1, BulkCreateDonationCampaignsRequest, BulkCreateDonationCampaignsResponse$1, BulkCreateDonationCampaignsResponse>; declare function bulkUpdateDonationCampaigns(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateDonationCampaignsRequest$1, BulkUpdateDonationCampaignsRequest, BulkUpdateDonationCampaignsResponse$1, BulkUpdateDonationCampaignsResponse>; declare function getDonationCampaignMetrics(): __PublicMethodMetaInfo<'GET', { donationCampaignId: string; }, GetDonationCampaignMetricsRequest$1, GetDonationCampaignMetricsRequest, GetDonationCampaignMetricsResponse$1, GetDonationCampaignMetricsResponse>; declare function bulkUpdateDonationCampaignTags(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateDonationCampaignTagsRequest$1, BulkUpdateDonationCampaignTagsRequest, BulkUpdateDonationCampaignTagsResponse$1, BulkUpdateDonationCampaignTagsResponse>; declare function bulkUpdateDonationCampaignTagsByFilter(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateDonationCampaignTagsByFilterRequest$1, BulkUpdateDonationCampaignTagsByFilterRequest, BulkUpdateDonationCampaignTagsByFilterResponse$1, BulkUpdateDonationCampaignTagsByFilterResponse>; export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type ApplicationError as ApplicationErrorOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkCreateDonationCampaignsApplicationErrors as BulkCreateDonationCampaignsApplicationErrorsOriginal, type BulkCreateDonationCampaignsRequest as BulkCreateDonationCampaignsRequestOriginal, type BulkCreateDonationCampaignsResponse as BulkCreateDonationCampaignsResponseOriginal, type BulkCreateDonationCampaignsValidationErrors as BulkCreateDonationCampaignsValidationErrorsOriginal, type BulkDonationCampaignResult as BulkDonationCampaignResultOriginal, type BulkUpdateDonationCampaignTagsApplicationErrors as BulkUpdateDonationCampaignTagsApplicationErrorsOriginal, type BulkUpdateDonationCampaignTagsByFilterApplicationErrors as BulkUpdateDonationCampaignTagsByFilterApplicationErrorsOriginal, type BulkUpdateDonationCampaignTagsByFilterRequest as BulkUpdateDonationCampaignTagsByFilterRequestOriginal, type BulkUpdateDonationCampaignTagsByFilterResponse as BulkUpdateDonationCampaignTagsByFilterResponseOriginal, type BulkUpdateDonationCampaignTagsRequest as BulkUpdateDonationCampaignTagsRequestOriginal, type BulkUpdateDonationCampaignTagsResponse as BulkUpdateDonationCampaignTagsResponseOriginal, type BulkUpdateDonationCampaignTagsResult as BulkUpdateDonationCampaignTagsResultOriginal, type BulkUpdateDonationCampaignsApplicationErrors as BulkUpdateDonationCampaignsApplicationErrorsOriginal, type BulkUpdateDonationCampaignsRequest as BulkUpdateDonationCampaignsRequestOriginal, type BulkUpdateDonationCampaignsResponseBulkDonationCampaignResult as BulkUpdateDonationCampaignsResponseBulkDonationCampaignResultOriginal, type BulkUpdateDonationCampaignsResponse as BulkUpdateDonationCampaignsResponseOriginal, type BulkUpdateDonationCampaignsValidationErrors as BulkUpdateDonationCampaignsValidationErrorsOriginal, type CampaignGoal as CampaignGoalOriginal, type CreateDonationCampaignApplicationErrors as CreateDonationCampaignApplicationErrorsOriginal, type CreateDonationCampaignRequest as CreateDonationCampaignRequestOriginal, type CreateDonationCampaignResponse as CreateDonationCampaignResponseOriginal, type CreateDonationCampaignValidationErrors as CreateDonationCampaignValidationErrorsOriginal, type CurrencyMetrics as CurrencyMetricsOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorQuery as CursorQueryOriginal, type CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type CustomAmountOptions as CustomAmountOptionsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type DonationCampaign as DonationCampaignOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ExtendedFields as ExtendedFieldsOriginal, type FocalPoint as FocalPointOriginal, Frequency as FrequencyOriginal, type FrequencyWithLiterals as FrequencyWithLiteralsOriginal, type GetDonationCampaignApplicationErrors as GetDonationCampaignApplicationErrorsOriginal, type GetDonationCampaignMetricsApplicationErrors as GetDonationCampaignMetricsApplicationErrorsOriginal, type GetDonationCampaignMetricsRequest as GetDonationCampaignMetricsRequestOriginal, type GetDonationCampaignMetricsResponse as GetDonationCampaignMetricsResponseOriginal, type GetDonationCampaignRequest as GetDonationCampaignRequestOriginal, type GetDonationCampaignResponse as GetDonationCampaignResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type Image as ImageOriginal, type ItemMetadata as ItemMetadataOriginal, type MaskedDonationCampaign as MaskedDonationCampaignOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MultiCurrencyPrice as MultiCurrencyPriceOriginal, type PredefinedAmount as PredefinedAmountOriginal, type QueryDonationCampaignsApplicationErrors as QueryDonationCampaignsApplicationErrorsOriginal, type QueryDonationCampaignsRequest as QueryDonationCampaignsRequestOriginal, type QueryDonationCampaignsResponse as QueryDonationCampaignsResponseOriginal, type RestoreInfo as RestoreInfoOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type StatusChanged as StatusChangedOriginal, Status as StatusOriginal, type StatusWithLiterals as StatusWithLiteralsOriginal, type TagList as TagListOriginal, type TagsModified as TagsModifiedOriginal, type Tags as TagsOriginal, type UpdateDonationCampaignApplicationErrors as UpdateDonationCampaignApplicationErrorsOriginal, type UpdateDonationCampaignRequest as UpdateDonationCampaignRequestOriginal, type UpdateDonationCampaignResponse as UpdateDonationCampaignResponseOriginal, type UpdateDonationCampaignValidationErrors as UpdateDonationCampaignValidationErrorsOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, bulkCreateDonationCampaigns, bulkUpdateDonationCampaignTags, bulkUpdateDonationCampaignTagsByFilter, bulkUpdateDonationCampaigns, createDonationCampaign, getDonationCampaign, getDonationCampaignMetrics, queryDonationCampaigns, updateDonationCampaign };