@foxy.io/sdk 1.9.2 → 1.9.3

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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@foxy.io/sdk",
   "type": "commonjs",
-  "version": "1.9.2",
+  "version": "1.9.3",
   "description": "Universal SDK for a full server-side and a limited in-browser access to Foxy hAPI.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -42,7 +42,7 @@
     "build:cdn": "webpack",
     "build:cjs": "tsc --outdir \"dist/cjs\"",
     "build:esm": "ttsc --project tsconfig.esm.json --outdir \"dist/esm\" && copyfiles --up 1 \"./build/esm/**/*\" \"./dist\"",
-    "build:docs": "typedoc --excludePrivate --ignoreCompilerErrors --mode library --out docs src/index.ts",
+    "build:docs": "typedoc --excludePrivate --out docs src/index.ts",
     "build:types": "tsc --declarationdir \"dist/types\" --declaration --emitdeclarationonly && copyfiles --up 1 \"./src/**/*.d.ts\" \"./dist/types\"",
     "prepack": "rimraf dist && run-p \"build:!(docs)\""
   },
@@ -88,7 +88,7 @@
     "ts-loader": "^8.0.9",
     "ts-node": "^9.1.1",
     "ttypescript": "^1.5.12",
-    "typedoc": "0.17.0-3",
+    "typedoc": "^0.22.18",
     "typescript": "^4.0.3",
     "webpack": "^5.4.0",
     "webpack-cli": "^4.2.0",