@foxy.io/sdk 1.9.0 → 1.9.3

package/dist/esm/core/BooleanSelector.js

@@ -1,8 +1,3 @@
-var Entity;
-(function (Entity) {
-    Entity[Entity["List"] = 0] = "List";
-    Entity[Entity["Set"] = 1] = "Set";
-})(Entity || (Entity = {}));
 /**
  * Boolean selector is an HTML boolean attribute value format that allows
  * developers to write configurations for elements deep in a shadow DOM. Here's
@@ -54,7 +49,6 @@ export class BooleanSelector {
      * @param value boolean selector value, e.g. `foo:bar baz:not=qux`
      */
     constructor(value) {
-        this.__value = value;
         this.__tree = BooleanSelector.__parse(value);
     }
     /**
@@ -123,24 +117,38 @@ export class BooleanSelector {
         return isFullMatch ? selector === 'not=*' : selector !== '';
     }
     /**
-     * Zooms on the given top-level identifier.
+     * Zooms on the given top-level identifier or follows a path.
      *
      * @example
+     * new BooleanSelector('foo:bar:baz').zoom('foo:bar').toString() // => "baz"
      * new BooleanSelector('foo:bar:baz').zoom('foo').toString() // => "bar:baz"
      * new BooleanSelector('not=foo').zoom('bar').toString() // => "not=*"
      * new BooleanSelector('not=foo').zoom('foo').toString() // => ""
      *
-     * @param id identifier to look for
-     * @returns `true` is current selector includes rules for the given identifier
+     * @param path path to look for
+     * @returns zoomed BooleanSelector
      */
-    zoom(id) {
-        const [firstPart, ...rest] = id.split(':');
-        const { only, not } = this.__tree;
-        if (only === null || only === void 0 ? void 0 : only[firstPart]) {
-            const selector = new BooleanSelector(BooleanSelector.__stringify(only[firstPart]));
-            return rest.length === 0 ? selector : selector.zoom(rest.join(':'));
-        }
-        return !not || not.includes(firstPart) ? BooleanSelector.False : BooleanSelector.True;
+    zoom(path) {
+        const zoomedSelector = new BooleanSelector('');
+        zoomedSelector.__tree = path.split(':').reduce((currentTree, id) => {
+            let zoomedTree;
+            if ('include' in currentTree) {
+                zoomedTree = currentTree.include[id];
+                if (zoomedTree === undefined)
+                    return { include: {} };
+                if (zoomedTree === true)
+                    return { exclude: { '*': true } };
+            }
+            else {
+                zoomedTree = currentTree.exclude[id];
+                if (zoomedTree === undefined)
+                    return { exclude: { '*': true } };
+                if (zoomedTree === true)
+                    return { include: {} };
+            }
+            return zoomedTree;
+        }, this.__tree);
+        return zoomedSelector;
     }
     /**
      * Converts this selector to string.
@@ -151,7 +159,7 @@ export class BooleanSelector {
      * @returns serialized representation of this selector
      */
     toString() {
-        return this.__value;
+        return BooleanSelector.__stringifyTree(this.__tree);
     }
     /**
      * Converts this selector to an attribute value.
@@ -166,103 +174,226 @@ export class BooleanSelector {
      * @returns attribute value representing this selector.
      */
     toAttribute(truthyValue = '') {
-        var _a;
-        if (((_a = this.__tree.not) === null || _a === void 0 ? void 0 : _a[0]) === '*')
+        const serializedSelector = this.toString();
+        if (serializedSelector === 'not=*')
             return truthyValue;
-        return this.__value.trim().length === 0 ? null : this.toString();
+        return serializedSelector.length === 0 ? null : serializedSelector;
+    }
+    static __parsePath(path, tree) {
+        const firstSeparatorIndex = path.indexOf(':');
+        const topLevelId = path.substring(0, firstSeparatorIndex);
+        const nestedPath = path.substring(firstSeparatorIndex + 1);
+        if ('exclude' in tree) {
+            const subTree = tree.exclude[topLevelId];
+            if (subTree)
+                tree.exclude[topLevelId] = this.__parseListItem(nestedPath, subTree === true ? void 0 : subTree);
+        }
+        else {
+            const subTree = tree.include[topLevelId];
+            if (subTree !== true)
+                tree.include[topLevelId] = this.__parseListItem(nestedPath, subTree);
+        }
+        return tree;
+    }
+    static __parseSet(set, tree) {
+        const setItems = set.split(',');
+        if ('include' in tree) {
+            tree = { exclude: tree.include };
+            for (const id in tree.exclude)
+                if (!setItems.includes(id))
+                    delete tree.exclude[id];
+            for (const item of setItems) {
+                if (item in tree.exclude) {
+                    delete tree.exclude[item];
+                }
+                else {
+                    tree.exclude[item] = true;
+                }
+            }
+        }
+        else {
+            for (const id in tree.exclude)
+                if (!setItems.includes(id))
+                    delete tree.exclude[id];
+        }
+        return tree;
     }
-    static __stringify(tree, path = '') {
-        if (tree.only) {
-            return Object.entries(tree.only).reduce((output, [key, subtree]) => {
-                const result = BooleanSelector.__stringify(subtree, path.length === 0 ? key : `${path}:${key}`);
-                return output.length === 0 ? result : `${output} ${result}`;
-            }, '');
+    static __parseListItem(listItem, tree = { include: {} }) {
+        if (listItem.includes(':'))
+            return this.__parsePath(listItem, tree);
+        if (listItem.startsWith('not='))
+            return this.__parseSet(listItem.substring(4), tree);
+        if ('include' in tree) {
+            tree.include[listItem] = true;
         }
-        if (tree.not)
-            return `${path.length === 0 ? '' : `${path}:`}not=${tree.not.join(',')}`;
-        return path;
+        else {
+            for (const id in tree.exclude)
+                if (id === listItem)
+                    delete tree.exclude[id];
+        }
+        return tree;
     }
-    static __parse(value) {
-        const tree = {};
-        const output = { branch: tree, buffer: '', entity: Entity.List, tree };
-        Array.from(`${value} `).forEach((character, position) => {
+    static __parseList(list, tree = { include: {} }) {
+        return list.split(' ').reduce((newTree, listItem) => this.__parseListItem(listItem, newTree), tree);
+    }
+    static __lintList(list) {
+        var _a;
+        let position = 'list';
+        let result = '';
+        for (let i = 0; i < list.length; ++i) {
+            const character = list.charAt(i);
             try {
-                BooleanSelector.__processors[output.entity](output, character);
+                if (position === 'list') {
+                    if (/^\s$/.test(character)) {
+                        if (!/^\s$/.test((_a = list[i - 1]) !== null && _a !== void 0 ? _a : ' '))
+                            result += ' ';
+                        continue;
+                    }
+                    if (/^[a-z]$/.test(character)) {
+                        result += character;
+                        position = 'path';
+                        continue;
+                    }
+                    throw new SyntaxError(`Expected [a-z] or a whitespace, but got "${character}" instead.`);
+                }
+                if (position === 'path') {
+                    if (/^[a-z]$/.test(character)) {
+                        result += character;
+                        continue;
+                    }
+                    if (character === '-') {
+                        if (list[i - 1] === '-' || list[i - 1] === ':') {
+                            throw new SyntaxError(`Expected [a-z], but got "${character}" instead.`);
+                        }
+                        else {
+                            result += character;
+                            continue;
+                        }
+                    }
+                    if (character === ':') {
+                        if (list[i - 1] === ':' || list[i - 1] === '-') {
+                            throw new SyntaxError(`Expected [a-z], but got "${character}" instead.`);
+                        }
+                        else {
+                            result += character;
+                            continue;
+                        }
+                    }
+                    if (character === '=') {
+                        if (list[i - 1] === '=' || list[i - 1] === ':' || list[i - 1] === '-') {
+                            throw new SyntaxError(`Expected [a-z], but got "${character}" instead.`);
+                        }
+                        if (result.endsWith('not') && (result.length === 3 || !/[a-z]|-/.test(result[i - 4]))) {
+                            result += character;
+                            position = 'set';
+                            continue;
+                        }
+                        else {
+                            throw new SyntaxError(`Expected [a-z] or ":", but got "${character}" instead.`);
+                        }
+                    }
+                    if (/^\s$/.test(character)) {
+                        result += ' ';
+                        position = 'list';
+                        continue;
+                    }
+                    throw new SyntaxError(`Expected [a-z], ",", ":", ":" or a whitespace, but got "${character}" instead.`);
+                }
+                if (position === 'set') {
+                    if (/^\s$/.test(character))
+                        continue;
+                    if (/^[a-z]|\*$/.test(character)) {
+                        position = 'set-item';
+                        result += character;
+                        continue;
+                    }
+                    throw new SyntaxError(`Expected [a-z] or a whitespace, but got "${character}" instead.`);
+                }
+                if (position === 'set-item') {
+                    if (list[i - 1] === '*') {
+                        if (character === ',') {
+                            result += character;
+                            position = 'set';
+                            continue;
+                        }
+                        if (/^\s$/.test(character)) {
+                            if (i !== list.length - 1)
+                                result += ' ';
+                            position = 'list';
+                            continue;
+                        }
+                        throw new SyntaxError(`Expected "," or a whitespace, but got "${character}" instead.`);
+                    }
+                    else {
+                        if (/^[a-z]$/.test(character)) {
+                            result += character;
+                            continue;
+                        }
+                        if (character === '-') {
+                            if (list[i - 1] === '-' || list[i - 1] === ':' || list[i - 1] === '=') {
+                                throw new SyntaxError(`Expected [a-z], but got "${character}" instead.`);
+                            }
+                            else {
+                                result += character;
+                                continue;
+                            }
+                        }
+                        if (character === ',') {
+                            result += character;
+                            position = 'set';
+                            continue;
+                        }
+                        if (/^\s$/.test(character)) {
+                            if (i !== list.length - 1)
+                                result += ' ';
+                            position = 'list';
+                            continue;
+                        }
+                        throw new SyntaxError(`Expected [a-z], "," or a whitespace, but got "${character}" instead.`);
+                    }
+                }
             }
             catch (err) {
                 const hint = 'This error occured at: ';
-                const trim = (v) => v.substring(Math.max(0, position - 30), position + 30);
-                const preview = trim(value);
-                const pointer = ' '.repeat(hint.length) + trim('^'.padStart(position + 1, ' '));
+                const trim = (v) => v.substring(Math.max(0, i - 30), i + 30);
+                const preview = trim(list);
+                const pointer = ' '.repeat(hint.length) + trim('^'.padStart(i + 1, ' '));
                 throw new SyntaxError([err.message, `${hint}${preview}`, pointer].join('\n'));
             }
-        });
-        return tree;
-    }
-}
-BooleanSelector.__processors = {
-    [Entity.List](output, character) {
-        var _a, _b, _c, _d;
-        /* istanbul ignore next */
-        if (Array.isArray(output.branch))
-            throw new SyntaxError('Paths are not allowed in sets.');
-        if (character === '=') {
-            if (output.buffer === 'not') {
-                const newBranch = (_a = output.branch.not) !== null && _a !== void 0 ? _a : [];
-                delete output.branch.only;
-                output.branch.not = newBranch;
-                output.entity = Entity.Set;
-                output.branch = newBranch;
-                output.buffer = '';
-                return;
-            }
-            else {
-                throw new SyntaxError(`Unknown modifier "${output.buffer}".`);
-            }
         }
-        if (/^\s$/.test(character) || character === ':') {
-            if (output.buffer.length > 0) {
-                const selector = output.buffer;
-                const newBranch = (_c = (_b = output.branch.only) === null || _b === void 0 ? void 0 : _b[selector]) !== null && _c !== void 0 ? _c : {};
-                if (character !== ':')
-                    newBranch.not = ['*'];
-                if (((_d = output.branch.not) === null || _d === void 0 ? void 0 : _d.includes('*')) !== true) {
-                    output.branch.only = Object.assign(Object.assign({}, output.branch.only), { [selector]: newBranch });
-                    delete output.branch.not;
+        return result.trimEnd();
+    }
+    static __parse(list) {
+        return this.__parseList(this.__lintList(list));
+    }
+    static __stringifyTree(tree, path) {
+        const parts = [];
+        if ('include' in tree) {
+            for (const id in tree.include) {
+                const nestedTree = tree.include[id];
+                const newPath = path ? [path, id].join(':') : id;
+                if (nestedTree === true) {
+                    parts.push(newPath);
+                }
+                else {
+                    parts.push(this.__stringifyTree(nestedTree, newPath));
                 }
-                output.branch = character === ':' ? newBranch : output.tree;
-                output.buffer = '';
             }
-            return;
         }
-        if (/^[a-z]|-$/.test(character)) {
-            output.buffer += character;
-            return;
-        }
-        throw new SyntaxError(`Expected [a-z], "-", ":" or a whitespace, but got "${character}" instead.`);
-    },
-    [Entity.Set](output, character) {
-        /* istanbul ignore next */
-        if (!Array.isArray(output.branch))
-            throw new SyntaxError('Unexpected set item.');
-        if (output.buffer.length === 0 && /^\s$/.test(character))
-            return;
-        if (character === ',' || character === '*' || /^\s$/.test(character)) {
-            const newItem = character === '*' ? '*' : output.buffer;
-            const updatedSet = new Set([...output.branch, newItem]);
-            const normalizedSet = updatedSet.has('*') ? new Set(['*']) : updatedSet;
-            output.branch.splice(0, output.branch.length, ...normalizedSet);
-            output.entity = character === ',' ? Entity.Set : Entity.List;
-            output.branch = character === ',' ? output.branch : output.tree;
-            output.buffer = '';
-            return;
-        }
-        if (/^[a-z]|-$/.test(character)) {
-            output.buffer += character;
-            return;
+        else {
+            const ids = [];
+            const partsToPush = [];
+            for (const id in tree.exclude) {
+                const nestedTree = tree.exclude[id];
+                const newPath = path ? [path, id].join(':') : id;
+                ids.push(id);
+                if (nestedTree !== true)
+                    partsToPush.push(this.__stringifyTree(nestedTree, newPath));
+            }
+            parts.push(`${path ? `${path}:` : ''}not=${ids.join(',')}`, ...partsToPush);
         }
-        throw new SyntaxError(`Expected [a-z], "-", "," or a whitespace, but got "${character}" instead.`);
-    },
-};
+        return parts.join(' ');
+    }
+}
 const falseBooleanSelectorSingleton = new BooleanSelector('');
 const trueBooleanSelectorSingleton = new BooleanSelector('not=*');

package/dist/types/backend/Graph/gift_card.d.ts

@@ -29,6 +29,17 @@ export interface GiftCard extends Graph {
     expires_after: string | null;
     /** If you want to limit which products can use this gift card, you can enter a comma separated listed of product codes or partial product codes using `*` as a wild card at the beginning or end of the value. So `abc123`, `fun_*`, `*-small` would match `abc123`, `fun_` and `fun_times`, and `example-small`. It wouldn't match `abc12`, `abc1234`, `fun`, or `good-smalls`. Optional. 5000 characters or less. */
     product_code_restrictions: string | null;
+    /** SKU used to add the gift card to the cart in order to buy it. Optional. 200 characters or less. */
+    sku: string | null;
+    /** Used for provisioning the gift card. */
+    provisioning_config: {
+      /** Set to `true` to activate automatic code provisioning for this gift card. */
+      allow_autoprovisioning: boolean;
+      /** Minimum initial gift card code balance. When this gift card is added to a cart, its price will have to be greater or equal to this value. */
+      initial_balance_min: number;
+      /** Maximum initial gift card code balance. When this gift card is added to a cart, its price will have to be less or equal to this value. */
+      initial_balance_max: number;
+    } | null;
     /** The date this resource was created. ISO date. Read only. */
     date_created: string | null;
     /** The date this resource was last modified. ISO date. Read only. */

package/dist/types/backend/Graph/gift_card_code.d.ts

@@ -3,6 +3,7 @@ import type { GiftCard } from './gift_card';
 import type { GiftCardCodeLogs } from './gift_card_code_logs';
 import type { Graph } from '../../core';
 import type { Store } from './store';
+import type { Transaction } from './transaction';
 
 export interface GiftCardCode extends Graph {
   curie: 'fx:gift_card_code';
@@ -18,6 +19,8 @@ export interface GiftCardCode extends Graph {
     'fx:gift_card': GiftCard;
     /** Transactions using this gift card code. */
     'fx:gift_card_code_logs': GiftCardCodeLogs;
+    /** Transaction that resulted in the creation of this gift card code, if applicable. */
+    'fx:provisioned_by_transaction_detail_id': Transaction;
   };
 
   props: {

package/dist/types/backend/Graph/gift_card_code_log.d.ts

@@ -0,0 +1,43 @@
+import type { GiftCard } from './gift_card';
+import type { GiftCardCode } from './gift_card_code';
+import type { Graph } from '../../core';
+import type { Store } from './store';
+import type { Transaction } from './transaction';
+
+export interface GiftCardCodeLog extends Graph {
+  curie: 'fx:gift_card_code_log';
+
+  links: {
+    /** This resource. */
+    'self': GiftCardCodeLog;
+    /** Store this resource belongs to. */
+    'fx:store': Store;
+    /** Transaction involving the relevant gift card code. */
+    'fx:transaction': Transaction;
+    /** Gift card this log belongs to. */
+    'fx:gift_card': GiftCard;
+    /** Gift card code this log was created for. */
+    'fx:gift_card_code': GiftCardCode;
+  };
+
+  props: {
+    /** User id that made the change, for store admin or API initiated balance adjustments. Integer, optional. */
+    user_id: number | null;
+    /** External id associated with gift card. If you maintain gift card balances across multiple systems, you can use this field to track non-Foxy transactions. Optional. 50 characters or less. */
+    external_id: string | null;
+    /** The Foxy transaction ID associated with gift card usage. Integer, optional. */
+    transaction_id: number | null;
+    /** Balance adjustment for the gift card. Decimal, optional. */
+    balance_adjustment: number | null;
+    /** Source that made the change for the gift card. Readonly. */
+    source: string | null;
+    /** The date this resource was created. Readonly. */
+    date_created: string | null;
+    /** The date this resource was last modified. Readonly. */
+    date_modified: string | null;
+  };
+
+  zooms: {
+    gift_card?: GiftCard;
+  };
+}

package/dist/types/backend/Graph/gift_card_code_logs.d.ts

@@ -1,10 +1,10 @@
 import type { CollectionGraphLinks, CollectionGraphProps } from '../../core/defaults';
+import type { GiftCardCodeLog } from './gift_card_code_log';
 import type { Graph } from '../../core';
-import type { Transaction } from './transaction';
 
 export interface GiftCardCodeLogs extends Graph {
   curie: 'fx:gift_card_code_logs';
   links: CollectionGraphLinks<GiftCardCodeLogs>;
   props: CollectionGraphProps;
-  child: Transaction;
+  child: GiftCardCodeLog;
 }

package/dist/types/backend/Graph/item_category.d.ts

@@ -1,3 +1,4 @@
+import type { EmailTemplate } from './email_template';
 import type { EmailTemplates } from './email_templates';
 import type { Graph } from '../../core';
 import type { Store } from './store';
@@ -15,6 +16,8 @@ export interface ItemCategory extends Graph {
     'fx:email_templates': EmailTemplates;
     /** Related tax item categories. */
     'fx:tax_item_categories': TaxItemCategories;
+    /** Gift recipient email template for this item category, if applicable. */
+    'fx:gift_recipient_email_template': EmailTemplate;
   };
 
   props: {
@@ -22,12 +25,14 @@ export interface ItemCategory extends Graph {
     admin_email_template_uri: string;
     /** The full API URI of the email template used by this category for sending an additional customer email if send_customer_email is true. */
     customer_email_template_uri: string;
+    /** The full API URI of the email template used by this category for sending an additional customer email for gift items that are in the cart. URL, optional. */
+    gift_recipient_email_template_uri: string | null;
     /** The category code used when applying this item category to the cart. */
     code: string;
     /** The name of this category. */
     name: string;
-    /** The delivery type of the items in this category. */
-    item_delivery_type: string;
+    /** The delivery type of the items in this category. Required. Defaults to `notshipped`. */
+    item_delivery_type: 'shipped' | 'downloaded' | 'flat_rate' | 'pickup' | 'notshipped';
     /** Determines how many times the same customer can attempt to download a purchased downloadable item before they are given an error. */
     max_downloads_per_customer: number;
     /** Determines how long in hours after the initial purchase a customer can attempt to download a purchased downloadable item before they are given an error. Some helpful values include: 1 day = 24 hours, 1 Week = 168 hours, 1 Month = 672 hours, 6 Months = 4032 hours */

package/dist/types/backend/Graph/shipment.d.ts

@@ -1,3 +1,5 @@
+import type { Attributes } from './attributes';
+import type { CustomFields } from './custom_fields';
 import type { Customer } from './customer';
 import type { CustomerAddress } from './customer_address';
 import type { Graph } from '../../core';
@@ -24,6 +26,10 @@ export interface Shipment extends Graph {
     'fx:transaction': Transaction;
     /** Customer's address. */
     'fx:customer_address': CustomerAddress;
+    /** Custom fields associated with this shipment. */
+    'fx:custom_fields': CustomFields;
+    /** Attributes associated with this shipment. */
+    'fx:attributes': Attributes;
   };
 
   props: {
@@ -66,4 +72,10 @@ export interface Shipment extends Graph {
     /** The date this resource was last modified. */
     date_modified: string | null;
   };
+
+  zooms: {
+    custom_fields?: CustomFields;
+    attributes?: Attributes;
+    items?: Items;
+  };
 }

package/dist/types/backend/Graph/store_shipping_method.d.ts

@@ -39,25 +39,25 @@ export interface StoreShippingMethod extends Graph {
     /** The full API URI of the shipping method defined in our property helpers. */
     shipping_method_uri: string;
     /** The full API URI of the shipping method container defined in our property helpers. Each shipping method will have it's own shipping containers. */
-    shipping_container_uri: string;
+    shipping_container_uri?: string;
     /** The full API URI of the shipping method drop type defined in our property helpers. Each shipping method will have it's own shipping drop types. */
-    shipping_drop_type_uri: string;
-    /** If using account specific rates, enter your shipping account id here. */
-    accountid: string;
+    shipping_drop_type_uri?: string;
+    /** If using account specific rates, enter your shipping account id here. If using the `CUSTOM-ENDPOINT-POST` method, enter your endpoint URL here. */
+    accountid?: string | null;
     /** If using account specific rates, enter your shipping account password here. */
-    password: string;
+    password?: string | null;
     /** If using account specific rates, enter your shipping account meter number here, if applicable. */
-    meter_number: string;
+    meter_number?: string | null;
     /** If using account specific rates, enter your shipping account authentication key here, if applicable. */
-    authentication_key: string;
+    authentication_key?: string | null;
     /** Set to true if you want this shipping method to apply to domestic shipping rate requests. <br>Note: This value is read only `true` for `CUSTOM-CODE`. */
-    use_for_domestic: string;
+    use_for_domestic: boolean;
     /** Set to true if you want this shipping method to apply to international shipping rate requests. <br>Note: This value is read only `true` for `CUSTOM-CODE`. */
-    use_for_international: string;
+    use_for_international: boolean;
     /** For the `CUSTOM-CODE` shipping method. JavaScript used to create and modify shipping rates. */
-    custom_code: string;
+    custom_code?: string;
     /** For the `CUSTOM-CODE` shipping method. Values are `deploying`, `deployed`, and `error`. */
-    deployment_status: 'deploying' | 'deployed' | 'error';
+    deployment_status?: 'deploying' | 'deployed' | 'error';
     /** The date this resource was created. */
     date_created: string | null;
     /** The date this resource was last modified. */
@@ -65,9 +65,9 @@ export interface StoreShippingMethod extends Graph {
   };
 
   zooms: {
-    store_shipping_services: StoreShippingServices;
-    shipping_container: ShippingContainer;
-    shipping_drop_type: ShippingDropType;
-    shipping_method: ShippingMethod;
+    store_shipping_services?: StoreShippingServices;
+    shipping_container?: ShippingContainer;
+    shipping_drop_type?: ShippingDropType;
+    shipping_method?: ShippingMethod;
   };
 }

package/dist/types/backend/Graph/webhook.d.ts

@@ -0,0 +1,43 @@
+import type { Graph } from '../../core';
+import type { Store } from './store';
+import type { WebhookLogs } from './webhook_logs';
+import type { WebhookStatuses } from './webhook_statuses';
+import type { Webhooks } from './webhooks';
+
+export interface Webhook extends Graph {
+  curie: 'fx:webhook';
+
+  links: {
+    /** This resource. */
+    'self': Webhook;
+    /** Store this webhook was created in. */
+    'fx:store': Store;
+    /** List of all webhooks for the store. */
+    'fx:webhooks': Webhooks;
+    /** List of all webhook delivery attempts and their current states. */
+    'fx:statuses': WebhookStatuses;
+    /** List of all endpoint responses received during webhook delivery attempts. */
+    'fx:logs': WebhookLogs;
+  };
+
+  props: {
+    /** The type of this webhook. Required. */
+    format: 'json' | 'webflow' | 'zapier';
+    /** The version of this webhook. Should not be modified unless you have specific instructions from Foxy. Default value is 2. */
+    version: number;
+    /** The name of this webhook. Required. 255 characters or less. */
+    name: string;
+    /** The endpoint where we will send the webhook data. 1000 characters or less. */
+    url: string | null;
+    /** The webhook payload mirrors the API, and you can include more or less data according to your needs (using `zoom` and other modifiers). 1000 characters or less. Something like `zoom=items,items:options,customer`. */
+    query: string | null;
+    /** The JSON webhooks are encrypted in certain situations. This key is also used to generate a signature to verify the integrity of the payload. 1000 characters or less. */
+    encryption_key: string | null;
+    /** The type of resource to observe changes on. */
+    event_resource: ('subscription' | 'transaction' | 'customer')[];
+    /** The date this resource was created. */
+    date_created: string | null;
+    /** The date this resource was last modified. */
+    date_modified: string | null;
+  };
+}