@foxy.io/sdk 1.5.1 → 1.7.1

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

@@ -65,8 +65,8 @@ export interface ItemCategory extends Graph {
     /** Email address of the administrator you'd like to send an email to every time an item in this category is purchased. */
     admin_email: string;
     /** The date this resource was created. */
-    date_created: string;
+    date_created: string | null;
     /** The date this resource was last modified. */
-    date_modified: string;
+    date_modified: string | null;
   };
 }

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

@@ -27,8 +27,8 @@ export interface ItemOption extends Graph {
     /** The weight modifier for this item option. The weight of the item in the cart will be adjusted by this amount because of this item option. */
     weight_mod: number;
     /** The date this resource was created. */
-    date_created: string;
+    date_created: string | null;
     /** The date this resource was last modified. */
-    date_modified: string;
+    date_modified: string | null;
   };
 }

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

@@ -25,8 +25,8 @@ export interface LanguageOverride extends Graph {
     /** Your custom string for this language code. */
     custom_value: string;
     /** The date this resource was created. */
-    date_created: string;
+    date_created: string | null;
     /** The date this resource was last modified. */
-    date_modified: string;
+    date_modified: string | null;
   };
 }

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

@@ -1,10 +1,6 @@
 import type { Graph } from '../../core';
 import type { PropertyHelpers } from './property_helpers';
 
-interface StringRecord {
-  [key: string]: StringRecord;
-}
-
 export interface LanguageStrings extends Graph {
   curie: 'fx:language_strings';
 
@@ -19,6 +15,6 @@ export interface LanguageStrings extends Graph {
     /** A small, human readable explanation of this property helper. */
     message: string;
     /** JSON objects with the language strings supported. The key values match the language property and each pair represents the language_override `code` and `custom_value`. */
-    values: StringRecord;
+    values: Record<string, Record<string, string>>;
   };
 }

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

@@ -17,8 +17,8 @@ export interface NativeIntegration extends Graph {
     /** A JSON string containing the configuration values and credentials for this native integration. */
     config: string;
     /** The date this resource was created. */
-    date_created: string;
+    date_created: string | null;
     /** The date this resource was last modified. */
-    date_modified: string;
+    date_modified: string | null;
   };
 }

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

@@ -42,8 +42,8 @@ export interface Payment extends Graph {
     /** The total amount of this payment. */
     amount: number;
     /** The date this resource was created. */
-    date_created: string;
+    date_created: string | null;
     /** The date this resource was last modified. */
-    date_modified: string;
+    date_modified: string | null;
   };
 }

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

@@ -41,8 +41,8 @@ export interface PaymentGateway extends Graph {
     /** Your test payment gateway third party key. To view the specific description of this field for the given payment gateway, see {@link https://api-sandbox.foxycart.com/hal-browser/browser.html#https://api-sandbox.foxycart.com/property_helpers/payment_gateways payment_gateways} property helper `third_party_key_description` field. */
     test_third_party_key: string;
     /** The date this resource was created. */
-    date_created: string;
+    date_created: string | null;
     /** The date this resource was last modified. */
-    date_modified: string;
+    date_modified: string | null;
   };
 }

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

@@ -0,0 +1,56 @@
+import type { Graph } from '../../core';
+import type { PropertyHelpers } from './property_helpers';
+
+export interface PaymentGatewaysHelper extends Graph {
+  curie: 'fx:payment_gateways';
+
+  links: {
+    /** This resource. */
+    'self': PaymentGatewaysHelper;
+    /** Various predefined property values. */
+    'fx:property_helpers': PropertyHelpers;
+  };
+
+  props: {
+    /** A small, human readable explanation of this property helper. */
+    message: string;
+    /** JSON objects with the payment gateway names as the keys. */
+    values: {
+      [key: string]: {
+        /** The name of this payment gateway. */
+        name: string;
+        /** The default id you can use for testing this gateway. */
+        test_id: string;
+        /** The default key you can use for testing this gateway. */
+        test_key: string;
+        /** The description of the id field for this gateway. */
+        id_description: string;
+        /** The description of the key field for this gateway. */
+        key_description: string;
+        /** Whether or not this gateway supports 3D Secure functionality. */
+        supports_3d_secure: 0 | 1;
+        /** Whether or not this gateway supports authorize only instead of auth+capture. */
+        supports_auth_only: 0 | 1;
+        /** The default third party key you can use for testing this gateway. */
+        test_third_party_key: string;
+        /** The description of the third party key field for this gateway. */
+        third_party_key_description: string;
+        /** If this gateway requires additional information, this will contain details about the data which needs to be collected to configure this gateway. */
+        additional_fields: null | {
+          blocks: {
+            id: string;
+            is_live: boolean;
+            parent_id: string;
+            fields: {
+              id: string;
+              name: string;
+              type: string;
+              description?: string;
+              default_value: string;
+            }[];
+          }[];
+        };
+      };
+    };
+  };
+}

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

@@ -41,8 +41,8 @@ export interface PaymentMethodExpiring extends Graph {
     /** The payment card expiration year in the YYYY format. */
     cc_exp_year: string;
     /** The date this resource was created. */
-    date_created: string;
+    date_created: string | null;
     /** The date this resource was last modified. */
-    date_modified: string;
+    date_modified: string | null;
   };
 }

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

@@ -33,8 +33,8 @@ export interface PaymentMethodSet extends Graph {
     /** Set this to true to enable the purchase order payment option on your store. This can only be set to true if your store is active. */
     is_purchase_order_enabled: boolean;
     /** The date this resource was created. */
-    date_created: string;
+    date_created: string | null;
     /** The date this resource was last modified. */
-    date_modified: string;
+    date_modified: string | null;
   };
 }

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

@@ -23,8 +23,8 @@ export interface PaymentMethodSetFraudProtection extends Graph {
     /** The full API URI of the fraud protection associated with this payment method set fraud protection. */
     fraud_protection_uri: string;
     /** The date this resource was created. */
-    date_created: string;
+    date_created: string | null;
     /** The date this resource was last modified. */
-    date_modified: string;
+    date_modified: string | null;
   };
 }

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

@@ -23,8 +23,8 @@ export interface PaymentMethodSetHostedPaymentGateway extends Graph {
     /** The full API URI of the hosted payment gateway associated with this payment method set hosted payment gateway. */
     hosted_payment_gateway_uri: string;
     /** The date this resource was created. */
-    date_created: string;
+    date_created: string | null;
     /** The date this resource was last modified. */
-    date_modified: string;
+    date_modified: string | null;
   };
 }

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

@@ -3,11 +3,11 @@ import type { Countries } from './countries';
 import type { CustomerPasswordHashTypes } from './customer_password_hash_types';
 import type { DefaultTemplates } from './default_templates';
 import type { Graph } from '../../core';
-import type { HostedPaymentGateways } from './hosted_payment_gateways';
+import type { HostedPaymentGatewaysHelper } from './hosted_payment_gateways_helper';
 import type { LanguageStrings } from './language_strings';
 import type { Languages } from './languages';
 import type { LocaleCodes } from './locale_codes';
-import type { PaymentGateways } from './payment_gateways';
+import type { PaymentGatewaysHelper } from './payment_gateways_helper';
 import type { Regions } from './regions';
 import type { ShippingAddressTypes } from './shipping_address_types';
 import type { ShippingMethods } from './shipping_methods';
@@ -37,7 +37,7 @@ export interface PropertyHelpers extends Graph {
     /** The shipping carriers used when configuring live shipping rates. */
     'fx:shipping_methods': ShippingMethods;
     /** List of supported payment gateways and valid entries for that resource's `type` setting. */
-    'fx:payment_gateways': PaymentGateways;
+    'fx:payment_gateways': PaymentGatewaysHelper;
     /** List of default language strings that can be overriden. */
     'fx:language_strings': LanguageStrings;
     /** Default templates for the cart, checkout, receipt and email. */
@@ -45,7 +45,7 @@ export interface PropertyHelpers extends Graph {
     /** List of valid address type values for the store's `shipping_address_type` setting. */
     'fx:shipping_address_types': ShippingAddressTypes;
     /** Hosted payment gateways such as PayPal, BitPay, and Dwolla. */
-    'fx:hosted_payment_gateways': HostedPaymentGateways;
+    'fx:hosted_payment_gateways': HostedPaymentGatewaysHelper;
     /** List of valid customer password hash type values for the store's `customer_password_hash_type` setting. */
     'fx:customer_password_hash_types': CustomerPasswordHashTypes;
   };

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

@@ -28,8 +28,8 @@ export interface ReceiptTemplate extends Graph {
     /** The URL of your receipt template hosted on your own server online and publicly available for our server to cache. */
     content_url: string;
     /** The date this resource was created. */
-    date_created: string;
+    date_created: string | null;
     /** The date this resource was last modified. */
-    date_modified: string;
+    date_modified: string | null;
   };
 }

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

@@ -21,8 +21,6 @@ export interface Regions extends Graph {
         default: string;
         /** The code for this region. */
         code: string;
-        /** The official 3 character country code. */
-        cc3: string;
         /** Array of alternative names for this region. */
         alternate_values: string[];
         /** This value determines which regions will show up first in our find-as-you-type system. */

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

@@ -62,8 +62,8 @@ export interface Shipment extends Graph {
     /** The total price of this shipment. */
     total_price: number;
     /** The date this resource was created. */
-    date_created: string;
+    date_created: string | null;
     /** The date this resource was last modified. */
-    date_modified: string;
+    date_modified: string | null;
   };
 }

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

@@ -26,8 +26,8 @@ export interface ShippingContainer extends Graph {
     /** The code for this shipping container */
     code: string;
     /** The date this resource was created. */
-    date_created: string;
+    date_created: string | null;
     /** The date this resource was last modified. */
-    date_modified: string;
+    date_modified: string | null;
   };
 }

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

@@ -26,8 +26,8 @@ export interface ShippingDropType extends Graph {
     /** The code for this shipping drop type */
     code: string;
     /** The date this resource was created. */
-    date_created: string;
+    date_created: string | null;
     /** The date this resource was last modified. */
-    date_modified: string;
+    date_modified: string | null;
   };
 }

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

@@ -29,8 +29,8 @@ export interface ShippingMethod extends Graph {
     /** The code for this shipping method */
     code: string;
     /** The date this resource was created. */
-    date_created: string;
+    date_created: string | null;
     /** The date this resource was last modified. */
-    date_modified: string;
+    date_modified: string | null;
   };
 }

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

@@ -25,8 +25,8 @@ export interface ShippingService extends Graph {
     /** Specifies whether or not this shipping service is for international rate requests only. */
     is_international: boolean;
     /** The date this resource was created. */
-    date_created: string;
+    date_created: string | null;
     /** The date this resource was last modified. */
-    date_modified: string;
+    date_modified: string | null;
   };
 }

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

@@ -167,8 +167,8 @@ export interface Store extends Graph {
     /** The date of the first payment for this FoxyCart store subscription. This can be considered the go live date for this store. */
     first_payment_date: string;
     /** The date this resource was created. */
-    date_created: string;
+    date_created: string | null;
     /** The date this resource was last modified. */
-    date_modified: string;
+    date_modified: string | null;
   };
 }

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

@@ -59,9 +59,9 @@ export interface StoreShippingMethod extends Graph {
     /** For the `CUSTOM-CODE` shipping method. Values are `deploying`, `deployed`, and `error`. */
     deployment_status: 'deploying' | 'deployed' | 'error';
     /** The date this resource was created. */
-    date_created: string;
+    date_created: string | null;
     /** The date this resource was last modified. */
-    date_modified: string;
+    date_modified: string | null;
   };
 
   zooms: {

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

@@ -29,8 +29,8 @@ export interface StoreShippingService extends Graph {
     /** The full API URI of the shipping method shipping service defined in our property helpers. Each shipping method will have it's own shipping services. */
     shipping_service_uri: string;
     /** The date this resource was created. */
-    date_created: string;
+    date_created: string | null;
     /** The date this resource was last modified. */
-    date_modified: string;
+    date_modified: string | null;
   };
 }

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

@@ -24,7 +24,25 @@ export interface StoreVersion extends Graph {
     /** Full content of the changelog as HTML */
     changelog_content: string;
     /** A JSON object for various cart types supported by this version. Examples include colorbox with links to the JavaScript library, FoxyCart JavaScript files, and FoxyCart CSS files. */
-    cart_types: string;
+    cart_types: {
+      [key: string]: {
+        /** Links to FoxyCart CSS files. */
+        css: string[];
+        /** Links to FoxyCart JS files. */
+        javascript: string[];
+        /** JS library needed for FoxyCart JS files to work. If none is needed, this will be an empty array. */
+        javascript_library:
+          | []
+          | {
+              /** Name of the JS library. */
+              name: string;
+              /** Version of the JS library. */
+              version: string;
+              /** URL of the JS library hosted on a CDN. */
+              url: string;
+            };
+      };
+    };
     /** The date this version was publicly released. */
     version_date: string;
     /** If this version is currently visible in the FoxyCart admin. At times, FoxyCart may launch a private beta of the latest version. */
@@ -32,8 +50,8 @@ export interface StoreVersion extends Graph {
     /** If this version is currently considered a beta release. */
     is_beta: boolean;
     /** The date this resource was created. */
-    date_created: string;
+    date_created: string | null;
     /** The date this resource was last modified. */
-    date_modified: string;
+    date_modified: string | null;
   };
 }

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

@@ -50,9 +50,9 @@ export interface Subscription extends Graph {
     /** If this subscription is using a third party subscription system such as PayPal Express, their identifier will be set here. */
     third_party_id: string;
     /** The date this resource was created. */
-    date_created: string;
+    date_created: string | null;
     /** The date this resource was last modified. */
-    date_modified: string;
+    date_modified: string | null;
   };
 
   zooms: {

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

@@ -35,8 +35,8 @@ export interface SubscriptionSettings extends Graph {
     /** When subscriptions run automatically to bill your customers, turning this setting off will prevent the normal receipt emails from being sent for their automated payment. The default value is true. */
     send_email_receipts_for_automated_billing: boolean;
     /** The date this resource was created. */
-    date_created: string;
+    date_created: string | null;
     /** The date this resource was last modified. */
-    date_modified: string;
+    date_modified: string | null;
   };
 }

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

@@ -41,8 +41,8 @@ export interface Tax extends Graph {
     /** The tax rate to be applied for this tax. For 10%, use 10. */
     rate: number;
     /** The date this resource was created. */
-    date_created: string;
+    date_created: string | null;
     /** The date this resource was last modified. */
-    date_modified: string;
+    date_modified: string | null;
   };
 }

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

@@ -23,8 +23,8 @@ export interface TaxItemCategory extends Graph {
     /** A full API URI of the tax resource used in this relationship. When working with hypermedia, it's important to save URIs and not just numeric ids. */
     store_uri: string;
     /** The date this resource was created. */
-    date_created: string;
+    date_created: string | null;
     /** The date this resource was last modified. */
-    date_modified: string;
+    date_modified: string | null;
   };
 }

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

@@ -20,8 +20,8 @@ export interface TemplateConfig extends Graph {
     /** This is the template configuration settings for your store. */
     json: string;
     /** The date this resource was created. */
-    date_created: string;
+    date_created: string | null;
     /** The date this resource was last modified. */
-    date_modified: string;
+    date_modified: string | null;
   };
 }

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

@@ -53,9 +53,9 @@ export interface TemplateSet extends Graph {
     /** This is the template configuration settings for your store. */
     config: string;
     /** The date this resource was created. */
-    date_created: string;
+    date_created: string | null;
     /** The date this resource was last modified. */
-    date_modified: string;
+    date_modified: string | null;
   };
 
   zooms: {

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

@@ -106,9 +106,9 @@ export interface Transaction extends Graph {
     /** The currency symbol, such as $, £, €, etc. */
     currency_symbol: string;
     /** The date this resource was created. */
-    date_created: string;
+    date_created: string | null;
     /** The date this resource was last modified. */
-    date_modified: string;
+    date_modified: string | null;
   };
 
   zooms: {

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

@@ -29,6 +29,6 @@ export interface TransactionLog extends Graph {
     /** Describes the source transaction modification such as admin or hAPI. */
     request_source: string;
     /** The date this resource was created. */
-    date_created: string;
+    date_created: string | null;
   };
 }

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

@@ -37,8 +37,8 @@ export interface User extends Graph {
     /** If this user is a a merchant or store admin involved in the item and money side of the e-commerce business. */
     is_merchant: boolean;
     /** The date this resource was created. */
-    date_created: string;
+    date_created: string | null;
     /** The date this resource was last modified. */
-    date_modified: string;
+    date_modified: string | null;
   };
 }

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

@@ -22,8 +22,8 @@ export interface UserAccess extends Graph {
     /** Set this to true to make this store the default store for this user. That means it will be the first store they see when the log in to the FoxyCart admin. */
     is_default_store: boolean;
     /** The date this resource was created. */
-    date_created: string;
+    date_created: string | null;
     /** The date this resource was last modified. */
-    date_modified: string;
+    date_modified: string | null;
   };
 }

package/dist/types/backend/Rels.d.ts

@@ -65,6 +65,7 @@ export * from './Graph/fraud_protections';
 export * from './Graph/generate_codes';
 export * from './Graph/hosted_payment_gateway';
 export * from './Graph/hosted_payment_gateways';
+export * from './Graph/hosted_payment_gateways_helper';
 export * from './Graph/integration';
 export * from './Graph/item';
 export * from './Graph/item_categories';
@@ -84,6 +85,7 @@ export * from './Graph/original_transaction';
 export * from './Graph/payment';
 export * from './Graph/payment_gateway';
 export * from './Graph/payment_gateways';
+export * from './Graph/payment_gateways_helper';
 export * from './Graph/payment_method_expiring';
 export * from './Graph/payment_method_set';
 export * from './Graph/payment_method_set_fraud_protection';

package/dist/types/backend/createSSOURL.d.ts

@@ -1,11 +1,13 @@
 interface Options {
     /**
-     * Integer, epoch time. The future time that this authentication token will expire.
+     * Integer, epoch time (seconds). The future time that this authentication token will expire.
      * If a customer makes a checkout request with an expired authentication token, then FoxyCart
      * will redirect them to the endpoint in order to generate a new token. You can make use of the
      * timestamp value you received to your endpoint in the GET parameters, and add additional time
      * to it for how long you want it to be valid for. For example, adding 3600 to the timestamp will
-     * extend it by 3600 seconds, or 30 minutes.
+     * extend it by 3600 seconds, or 60 minutes.
+     *
+     * Defaults to an hour from now.
      *
      * @see https://docs.foxycart.com/v/2.0/sso#the_details
      */
@@ -37,7 +39,7 @@ interface Options {
      * that usually looks like this: `https://yourdomain.foxycart.com`.
      *
      * @see https://docs.foxycart.com/v/2.0/sso#the_details
-     * @see https://api.foxycart.com/rels/store
+     * @see https://api.foxy.io/rels/store
      */
     domain: string;
 }

package/dist/types/core/Nucleon/types.d.ts

@@ -28,6 +28,7 @@ export type Context<TData extends Data = Data, TError = unknown, TFailure = unkn
  */
 export type Event<TData extends Data = Data> =
   | { type: 'SET_DATA'; data: TData | null }
+  | { type: 'REFRESH' }
   | { type: 'EDIT'; data: Partial<TData> }
   | { type: 'UNDO' }
   | { type: 'FETCH' }
@@ -51,7 +52,7 @@ export type State<TData extends Data = Data, TError = unknown, TFailure = unknow
     }
   | {
       value: { busy: 'fetching' };
-      context: Context<TData, TError> & { data: null; edits: null; failure: null };
+      context: Context<TData, TError> & { failure: null };
     }
   | {
       value: { busy: 'creating' };

package/dist/types/core/Resource/Link.d.ts

@@ -1,6 +1,6 @@
 /** Represents a hAPI relation link. */
 export type Link = {
-  /** True if this is a template link (example: `https://api.foxycart.com/rels/{rel}`) */
+  /** True if this is a template link (example: `https://api.foxy.io/rels/{rel}`) */
   templated?: boolean;
   /** Short description of this link. */
   title?: string;

package/dist/types/customer/Graph/attribute.d.ts

@@ -19,8 +19,8 @@ export interface Attribute extends Graph {
     /** The value of this attribute. */
     value: string;
     /** The date this resource was created. */
-    date_created: string;
+    date_created: string | null;
     /** The date this resource was last modified. */
-    date_modified: string;
+    date_modified: string | null;
   };
 }

package/dist/types/customer/Graph/customer_address.d.ts

@@ -35,12 +35,12 @@ export interface CustomerAddress extends Graph {
     /** The phone of this address. */
     phone: string;
     /** Specifies if this address is the default billing address for the customer. */
-    is_default_billing: string;
+    is_default_billing: boolean;
     /** Specifies if this address is the default shipping address for the customer. */
-    is_default_shipping: string;
+    is_default_shipping: boolean;
     /** The date this resource was created. */
-    date_created: string;
+    date_created: string | null;
     /** The date this resource was last modified. */
-    date_modified: string;
+    date_modified: string | null;
   };
 }

package/dist/types/customer/Graph/customer_portal_settings.d.ts

@@ -54,8 +54,8 @@ export interface CustomerPortalSettings extends Graph {
     /** Life span of session in minutes. Maximum 40320 (4 weeks). */
     session_lifespan_in_minutes: number;
     /** The date this resource was created. */
-    date_created: string;
+    date_created: string | null;
     /** The date this resource was last modified. */
-    date_modified: string;
+    date_modified: string | null;
   };
 }

package/dist/types/customer/Graph/default_payment_method.d.ts

@@ -24,8 +24,8 @@ export interface DefaultPaymentMethod extends Graph {
     /** The payment card expiration year in the YYYY format. */
     cc_exp_year: string | null;
     /** The date this resource was created. */
-    date_created: string;
+    date_created: string | null;
     /** The date this resource was last modified. */
-    date_modified: string;
+    date_modified: string | null;
   };
 }