@foxy.io/sdk 1.8.0 → 1.9.0

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

@@ -8,3 +8,12 @@ export interface CouponCodes extends Graph {
   props: CollectionGraphProps;
   child: CouponCode;
 }
+
+export interface CouponCodesImport extends Graph {
+  curie: 'fx:coupon_codes';
+
+  props: {
+    /** List of codes to import. */
+    coupon_codes: string[];
+  };
+}

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

@@ -0,0 +1,5 @@
+import type { Graph } from '../../core';
+
+export interface DownloadUrl extends Graph {
+  curie: 'fx:download_url';
+}

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

@@ -10,5 +10,7 @@ export interface GenerateCodes extends Graph {
     number_of_codes: number;
     /** Optional number of coupon code variations you would like to generate. For example, if you would like all the coupon code variations to have a "summer_special" prefix, set that here. */
     prefix: string;
+    /** Optional initial balance (gift cards only). Defaults to 0. */
+    current_balance?: number;
   };
 }

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

@@ -8,3 +8,14 @@ export interface GiftCardCodes extends Graph {
   props: CollectionGraphProps;
   child: GiftCardCode;
 }
+
+export interface GiftCardCodesImport extends Graph {
+  curie: 'fx:gift_card_codes';
+
+  props: {
+    /** List of codes to import. */
+    gift_card_codes: string[];
+    /** Initial balance. */
+    current_balance: number;
+  };
+}

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

@@ -0,0 +1,30 @@
+import type { DownloadUrl } from './download_url';
+import type { Graph } from '../../core';
+import type { User } from './user';
+
+export interface Report extends Graph {
+  curie: 'fx:report';
+
+  links: {
+    'self': Report;
+    'fx:download_url': DownloadUrl;
+    'fx:user': User;
+  };
+
+  props: {
+    /** The type of report generated, indicating the content of the report. `complete` includes transaction details, summaries, coupon usage, subscription forecasts, and more. `customers` is for exporting customers to import elsewhere. `customers_ltv` includes the lifetime value per customer. */
+    name: 'complete' | 'customers' | 'customers_ltv';
+    /** In the event a report changes significantly, a new version of the report may be available. Leave this empty to retrieve the latest version, or pass a 1 to request a specific version. In the future, additional versions of each named report may be available. */
+    version: '1';
+    /** Current status of the report. Possible values include `queued`, `error`, and `ready`. */
+    status: 'queued' | 'error' | 'ready';
+    /** A timestamp in the `YYYY-MM-DD HH:MM:SS` format, for the start of the reporting period, for your store's configured timezone. Note that any offset will be ignored, and the datetime passed in will be used as your store's configured timezone. */
+    datetime_start: string;
+    /** Same as `datetime_start`, but for the end of the report's timeframe. Note that you likely want to pass `23:59:59` as the time portion, or you may inadvertently miss data from the last day of the reporting period. */
+    datetime_end: string;
+    /** The date this resource was created. */
+    date_created: string | null;
+    /** The date this resource was last modified. */
+    date_modified: string | null;
+  };
+}

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

@@ -0,0 +1,10 @@
+import type { CollectionGraphLinks, CollectionGraphProps } from '../../core/defaults';
+import type { Graph } from '../../core';
+import type { Report } from './report';
+
+export interface Reports extends Graph {
+  curie: 'fx:reports';
+  links: CollectionGraphLinks<Reports>;
+  props: CollectionGraphProps;
+  child: Report;
+}

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

@@ -17,6 +17,7 @@ import type { ItemCategories } from './item_categories';
 import type { PaymentMethodSets } from './payment_method_sets';
 import type { ProcessSubscriptionWebhook } from './process_subscription_webhook';
 import type { ReceiptTemplates } from './receipt_templates';
+import type { Reports } from './reports';
 import type { StoreVersion } from './store_version';
 import type { SubscriptionSettings } from './subscription_settings';
 import type { Subscriptions } from './subscriptions';
@@ -38,6 +39,8 @@ export interface Store extends Graph {
     'fx:users': Users;
     /** List of taxes configured for this store. */
     'fx:taxes': Taxes;
+    /** List of reports for this store. */
+    'fx:reports': Reports;
     /** List of coupons available in this store. */
     'fx:coupons': Coupons;
     /** List of customers of this store. */

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

@@ -109,9 +109,12 @@ export * from './Graph/receipt_template';
 export * from './Graph/receipt_templates';
 export * from './Graph/refund';
 export * from './Graph/regions';
+export * from './Graph/report';
+export * from './Graph/download_url';
 export * from './Graph/reporting';
 export * from './Graph/reporting_email_exists';
 export * from './Graph/reporting_store_domain_exists';
+export * from './Graph/reports';
 export * from './Graph/send_emails';
 export * from './Graph/shipment';
 export * from './Graph/shipments';

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

@@ -12,8 +12,6 @@ export interface Attribute extends Graph {
   };
 
   props: {
-    /** Controls who can see this attribute. Only public attributes are accessible via this API. */
-    visibility: 'public';
     /** The name of this attribute. */
     name: string;
     /** The value of this attribute. */

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

@@ -0,0 +1,24 @@
+import type { Graph } from '../../core';
+import type { Transaction } from './transaction';
+
+export interface CustomField extends Graph {
+  curie: 'fx:custom_field';
+
+  links: {
+    /** This resource. */
+    'self': CustomField;
+    /** Transaction this custom field is linked to. */
+    'fx:transaction': Transaction;
+  };
+
+  props: {
+    /** The name of the custom field. */
+    name: string;
+    /** The value of this custom field. */
+    value: string;
+    /** The date this resource was created. */
+    date_created: string | null;
+    /** The date this resource was last modified. */
+    date_modified: string | null;
+  };
+}

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

@@ -0,0 +1,10 @@
+import type { CollectionGraphLinks, CollectionGraphProps } from '../../core/defaults';
+import type { CustomField } from './custom_field';
+import type { Graph } from '../../core';
+
+export interface CustomFields extends Graph {
+  curie: 'fx:custom_fields';
+  links: CollectionGraphLinks<CustomFields>;
+  props: CollectionGraphProps;
+  child: CustomField;
+}

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

@@ -1,4 +1,5 @@
 import type { Attributes } from './attributes';
+import type { CustomFields } from './custom_fields';
 import type { Graph as Customer } from './index';
 import type { Graph } from '../../core';
 import type { Items } from './items';
@@ -15,6 +16,8 @@ export interface Transaction extends Graph {
     'fx:customer': Customer;
     /** List of custom attributes on this transaction. */
     'fx:attributes': Attributes;
+    /** List of custom fields on this transaction. */
+    'fx:custom_fields': CustomFields;
     /** List of items for this transaction. */
     'fx:items': Items;
   };
@@ -71,6 +74,7 @@ export interface Transaction extends Graph {
   };
 
   zooms: {
+    custom_fields?: CustomFields;
     attributes: Attributes;
     customer?: Customer;
     items?: Items;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@foxy.io/sdk",
   "type": "commonjs",
-  "version": "1.8.0",
+  "version": "1.9.0",
   "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",