@foxy.io/sdk 1.8.1 → 1.9.1

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/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/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;
+  };
+}

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

@@ -0,0 +1,42 @@
+import type { Customer } from './customer';
+import type { Graph } from '../../core';
+import type { Store } from './store';
+import type { Subscription } from './subscription';
+import type { Transaction } from './transaction';
+import type { Webhook } from './webhook';
+
+export interface WebhookLog extends Graph {
+  curie: 'fx:webhook_log';
+
+  links: {
+    /** This resource. */
+    'self': WebhookLog;
+    /** The store this webhook status is associated with. */
+    'fx:store': Store;
+    /** The webhook this status is associated with. */
+    'fx:webhook': Webhook;
+    /** The resource changes in which have triggered the webhook. */
+    'fx:resource': Transaction | Subscription | Customer;
+  };
+
+  props: {
+    /** The type of resource changes were observed on. */
+    resource_type: 'subscription' | 'transaction' | 'customer';
+    /** The ID of the resource changes in which have triggered the webhook. */
+    resource_id: number;
+    /** The ID of the webhook this status is associated with. */
+    webhook_id: number;
+    /** The code received from the server the webhook was sent to. */
+    response_code: string;
+    /** The content received from the server the webhook was sent to. */
+    response_body: string | null;
+    /** The date this resource was created. */
+    date_created: string | null;
+    /** The date this resource was last modified. */
+    date_modified: string | null;
+  };
+
+  zooms: {
+    webhook?: Webhook;
+  };
+}

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

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

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

@@ -0,0 +1,40 @@
+import type { Customer } from './customer';
+import type { Graph } from '../../core';
+import type { Store } from './store';
+import type { Subscription } from './subscription';
+import type { Transaction } from './transaction';
+import type { Webhook } from './webhook';
+
+export interface WebhookStatus extends Graph {
+  curie: 'fx:webhook_status';
+
+  links: {
+    /** This resource. */
+    'self': WebhookStatus;
+    /** The store this webhook status is associated with. */
+    'fx:store': Store;
+    /** The webhook this status is associated with. */
+    'fx:webhook': Webhook;
+    /** The resource changes in which have triggered the webhook. */
+    'fx:resource': Transaction | Subscription | Customer;
+  };
+
+  props: {
+    /** The type of resource changes were observed on. */
+    resource_type: 'subscription' | 'transaction' | 'customer';
+    /** The ID of the resource changes in which have triggered the webhook. */
+    resource_id: number;
+    /** The ID of the webhook this status is associated with. */
+    webhook_id: number;
+    /** The current state of this attempt. */
+    status: 'pending' | 'failed' | 'successful';
+    /** The date this resource was created. */
+    date_created: string | null;
+    /** The date this resource was last modified. */
+    date_modified: string | null;
+  };
+
+  zooms: {
+    webhook?: Webhook;
+  };
+}

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

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

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

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

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';
@@ -155,3 +158,9 @@ export * from './Graph/user_access';
 export * from './Graph/user_accesses';
 export * from './Graph/users';
 export * from './Graph/void';
+export * from './Graph/webhook_log';
+export * from './Graph/webhook_logs';
+export * from './Graph/webhook_status';
+export * from './Graph/webhook_statuses';
+export * from './Graph/webhook';
+export * from './Graph/webhooks';

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.1",
+  "version": "1.9.1",
   "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",