@foxy.io/sdk 1.6.0 → 1.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -4
- package/dist/cdn/FoxySDKCustomer.js +1 -1
- package/dist/cjs/backend/API.js +2 -2
- package/dist/cjs/backend/createSSOURL.js +1 -1
- package/dist/cjs/core/API/Node.js +11 -11
- package/dist/cjs/core/Rumour/Rumour.js +4 -1
- package/dist/esm/backend/API.js +2 -2
- package/dist/esm/backend/createSSOURL.js +1 -1
- package/dist/esm/core/API/Node.js +11 -11
- package/dist/esm/core/Rumour/Rumour.js +4 -1
- package/dist/types/backend/API.d.ts +2 -2
- package/dist/types/backend/Graph/applied_coupon_code.d.ts +2 -2
- package/dist/types/backend/Graph/applied_tax.d.ts +2 -2
- package/dist/types/backend/Graph/attribute.d.ts +2 -2
- package/dist/types/backend/Graph/billing_address.d.ts +2 -2
- package/dist/types/backend/Graph/cart.d.ts +2 -2
- package/dist/types/backend/Graph/cart_include_template.d.ts +2 -2
- package/dist/types/backend/Graph/cart_template.d.ts +2 -2
- package/dist/types/backend/Graph/checkout_template.d.ts +2 -2
- package/dist/types/backend/Graph/client.d.ts +2 -2
- package/dist/types/backend/Graph/coupon.d.ts +4 -4
- package/dist/types/backend/Graph/coupon_code.d.ts +2 -2
- package/dist/types/backend/Graph/coupon_code_transaction.d.ts +2 -2
- package/dist/types/backend/Graph/coupon_detail.d.ts +2 -2
- package/dist/types/backend/Graph/coupon_item_category.d.ts +2 -2
- package/dist/types/backend/Graph/custom_field.d.ts +2 -2
- package/dist/types/backend/Graph/customer.d.ts +2 -2
- package/dist/types/backend/Graph/customer_address.d.ts +4 -4
- package/dist/types/backend/Graph/customer_portal_settings.d.ts +2 -2
- package/dist/types/backend/Graph/default_payment_method.d.ts +2 -2
- package/dist/types/backend/Graph/discount.d.ts +2 -2
- package/dist/types/backend/Graph/discount_detail.d.ts +2 -2
- package/dist/types/backend/Graph/downloadable.d.ts +2 -2
- package/dist/types/backend/Graph/downloadable_purchase.d.ts +2 -2
- package/dist/types/backend/Graph/email_template.d.ts +2 -2
- package/dist/types/backend/Graph/error_entry.d.ts +2 -2
- package/dist/types/backend/Graph/fraud_protection.d.ts +2 -2
- package/dist/types/backend/Graph/gift_card.d.ts +42 -0
- package/dist/types/backend/Graph/gift_card_code.d.ts +35 -0
- package/dist/types/backend/Graph/gift_card_code_logs.d.ts +10 -0
- package/dist/types/backend/Graph/gift_card_codes.d.ts +10 -0
- package/dist/types/backend/Graph/gift_card_item_categories.d.ts +10 -0
- package/dist/types/backend/Graph/gift_card_item_category.d.ts +30 -0
- package/dist/types/backend/Graph/gift_cards.d.ts +10 -0
- package/dist/types/backend/Graph/hosted_payment_gateways_helper.d.ts +56 -0
- package/dist/types/backend/Graph/integration.d.ts +10 -10
- package/dist/types/backend/Graph/item.d.ts +2 -2
- package/dist/types/backend/Graph/item_category.d.ts +2 -2
- package/dist/types/backend/Graph/item_option.d.ts +2 -2
- package/dist/types/backend/Graph/language_override.d.ts +2 -2
- package/dist/types/backend/Graph/language_strings.d.ts +1 -5
- package/dist/types/backend/Graph/native_integration.d.ts +2 -2
- package/dist/types/backend/Graph/payment.d.ts +2 -2
- package/dist/types/backend/Graph/payment_gateway.d.ts +2 -2
- package/dist/types/backend/Graph/payment_gateways_helper.d.ts +56 -0
- package/dist/types/backend/Graph/payment_method_expiring.d.ts +2 -2
- package/dist/types/backend/Graph/payment_method_set.d.ts +2 -2
- package/dist/types/backend/Graph/payment_method_set_fraud_protection.d.ts +2 -2
- package/dist/types/backend/Graph/payment_method_set_hosted_payment_gateway.d.ts +2 -2
- package/dist/types/backend/Graph/property_helpers.d.ts +4 -4
- package/dist/types/backend/Graph/receipt_template.d.ts +2 -2
- package/dist/types/backend/Graph/regions.d.ts +0 -2
- package/dist/types/backend/Graph/shipment.d.ts +2 -2
- package/dist/types/backend/Graph/shipping_container.d.ts +2 -2
- package/dist/types/backend/Graph/shipping_drop_type.d.ts +2 -2
- package/dist/types/backend/Graph/shipping_method.d.ts +2 -2
- package/dist/types/backend/Graph/shipping_service.d.ts +2 -2
- package/dist/types/backend/Graph/store.d.ts +5 -2
- package/dist/types/backend/Graph/store_shipping_method.d.ts +2 -2
- package/dist/types/backend/Graph/store_shipping_service.d.ts +2 -2
- package/dist/types/backend/Graph/store_version.d.ts +21 -3
- package/dist/types/backend/Graph/subscription.d.ts +2 -2
- package/dist/types/backend/Graph/subscription_settings.d.ts +2 -2
- package/dist/types/backend/Graph/tax.d.ts +2 -2
- package/dist/types/backend/Graph/tax_item_category.d.ts +2 -2
- package/dist/types/backend/Graph/template_config.d.ts +2 -2
- package/dist/types/backend/Graph/template_set.d.ts +2 -2
- package/dist/types/backend/Graph/transaction.d.ts +2 -2
- package/dist/types/backend/Graph/transaction_log.d.ts +1 -1
- package/dist/types/backend/Graph/user.d.ts +2 -2
- package/dist/types/backend/Graph/user_access.d.ts +2 -2
- package/dist/types/backend/Rels.d.ts +9 -0
- package/dist/types/backend/createSSOURL.d.ts +5 -3
- package/dist/types/core/Resource/Link.d.ts +1 -1
- package/dist/types/core/Rumour/Rumour.d.ts +1 -0
- package/dist/types/customer/Graph/attribute.d.ts +2 -2
- package/dist/types/customer/Graph/customer_address.d.ts +4 -4
- package/dist/types/customer/Graph/customer_portal_settings.d.ts +2 -2
- package/dist/types/customer/Graph/default_payment_method.d.ts +2 -2
- package/dist/types/customer/Graph/index.d.ts +2 -2
- package/dist/types/customer/Graph/item.d.ts +2 -2
- package/dist/types/customer/Graph/subscription.d.ts +2 -2
- package/dist/types/customer/Graph/transaction.d.ts +2 -2
- package/dist/types/customer/Graph/transaction_template.d.ts +2 -2
- package/package.json +1 -1
|
@@ -53,9 +53,9 @@ export interface TemplateSet extends Graph {
|
|
|
53
53
|
/** This is the template configuration settings for your store. */
|
|
54
54
|
config: string;
|
|
55
55
|
/** The date this resource was created. */
|
|
56
|
-
date_created: string;
|
|
56
|
+
date_created: string | null;
|
|
57
57
|
/** The date this resource was last modified. */
|
|
58
|
-
date_modified: string;
|
|
58
|
+
date_modified: string | null;
|
|
59
59
|
};
|
|
60
60
|
|
|
61
61
|
zooms: {
|
|
@@ -106,9 +106,9 @@ export interface Transaction extends Graph {
|
|
|
106
106
|
/** The currency symbol, such as $, £, €, etc. */
|
|
107
107
|
currency_symbol: string;
|
|
108
108
|
/** The date this resource was created. */
|
|
109
|
-
date_created: string;
|
|
109
|
+
date_created: string | null;
|
|
110
110
|
/** The date this resource was last modified. */
|
|
111
|
-
date_modified: string;
|
|
111
|
+
date_modified: string | null;
|
|
112
112
|
};
|
|
113
113
|
|
|
114
114
|
zooms: {
|
|
@@ -29,6 +29,6 @@ export interface TransactionLog extends Graph {
|
|
|
29
29
|
/** Describes the source transaction modification such as admin or hAPI. */
|
|
30
30
|
request_source: string;
|
|
31
31
|
/** The date this resource was created. */
|
|
32
|
-
date_created: string;
|
|
32
|
+
date_created: string | null;
|
|
33
33
|
};
|
|
34
34
|
}
|
|
@@ -37,8 +37,8 @@ export interface User extends Graph {
|
|
|
37
37
|
/** If this user is a a merchant or store admin involved in the item and money side of the e-commerce business. */
|
|
38
38
|
is_merchant: boolean;
|
|
39
39
|
/** The date this resource was created. */
|
|
40
|
-
date_created: string;
|
|
40
|
+
date_created: string | null;
|
|
41
41
|
/** The date this resource was last modified. */
|
|
42
|
-
date_modified: string;
|
|
42
|
+
date_modified: string | null;
|
|
43
43
|
};
|
|
44
44
|
}
|
|
@@ -22,8 +22,8 @@ export interface UserAccess extends Graph {
|
|
|
22
22
|
/** 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. */
|
|
23
23
|
is_default_store: boolean;
|
|
24
24
|
/** The date this resource was created. */
|
|
25
|
-
date_created: string;
|
|
25
|
+
date_created: string | null;
|
|
26
26
|
/** The date this resource was last modified. */
|
|
27
|
-
date_modified: string;
|
|
27
|
+
date_modified: string | null;
|
|
28
28
|
};
|
|
29
29
|
}
|
|
@@ -63,8 +63,16 @@ export * from './Graph/error_entry';
|
|
|
63
63
|
export * from './Graph/fraud_protection';
|
|
64
64
|
export * from './Graph/fraud_protections';
|
|
65
65
|
export * from './Graph/generate_codes';
|
|
66
|
+
export * from './Graph/gift_card_code_logs';
|
|
67
|
+
export * from './Graph/gift_card_code';
|
|
68
|
+
export * from './Graph/gift_card_codes';
|
|
69
|
+
export * from './Graph/gift_card_item_categories';
|
|
70
|
+
export * from './Graph/gift_card_item_category';
|
|
71
|
+
export * from './Graph/gift_card';
|
|
72
|
+
export * from './Graph/gift_cards';
|
|
66
73
|
export * from './Graph/hosted_payment_gateway';
|
|
67
74
|
export * from './Graph/hosted_payment_gateways';
|
|
75
|
+
export * from './Graph/hosted_payment_gateways_helper';
|
|
68
76
|
export * from './Graph/integration';
|
|
69
77
|
export * from './Graph/item';
|
|
70
78
|
export * from './Graph/item_categories';
|
|
@@ -84,6 +92,7 @@ export * from './Graph/original_transaction';
|
|
|
84
92
|
export * from './Graph/payment';
|
|
85
93
|
export * from './Graph/payment_gateway';
|
|
86
94
|
export * from './Graph/payment_gateways';
|
|
95
|
+
export * from './Graph/payment_gateways_helper';
|
|
87
96
|
export * from './Graph/payment_method_expiring';
|
|
88
97
|
export * from './Graph/payment_method_set';
|
|
89
98
|
export * from './Graph/payment_method_set_fraud_protection';
|
|
@@ -1,11 +1,13 @@
|
|
|
1
1
|
interface Options {
|
|
2
2
|
/**
|
|
3
|
-
* Integer, epoch time. The future time that this authentication token will expire.
|
|
3
|
+
* Integer, epoch time (seconds). The future time that this authentication token will expire.
|
|
4
4
|
* If a customer makes a checkout request with an expired authentication token, then FoxyCart
|
|
5
5
|
* will redirect them to the endpoint in order to generate a new token. You can make use of the
|
|
6
6
|
* timestamp value you received to your endpoint in the GET parameters, and add additional time
|
|
7
7
|
* to it for how long you want it to be valid for. For example, adding 3600 to the timestamp will
|
|
8
|
-
* extend it by 3600 seconds, or
|
|
8
|
+
* extend it by 3600 seconds, or 60 minutes.
|
|
9
|
+
*
|
|
10
|
+
* Defaults to an hour from now.
|
|
9
11
|
*
|
|
10
12
|
* @see https://docs.foxycart.com/v/2.0/sso#the_details
|
|
11
13
|
*/
|
|
@@ -37,7 +39,7 @@ interface Options {
|
|
|
37
39
|
* that usually looks like this: `https://yourdomain.foxycart.com`.
|
|
38
40
|
*
|
|
39
41
|
* @see https://docs.foxycart.com/v/2.0/sso#the_details
|
|
40
|
-
* @see https://api.
|
|
42
|
+
* @see https://api.foxy.io/rels/store
|
|
41
43
|
*/
|
|
42
44
|
domain: string;
|
|
43
45
|
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/** Represents a hAPI relation link. */
|
|
2
2
|
export type Link = {
|
|
3
|
-
/** True if this is a template link (example: `https://api.
|
|
3
|
+
/** True if this is a template link (example: `https://api.foxy.io/rels/{rel}`) */
|
|
4
4
|
templated?: boolean;
|
|
5
5
|
/** Short description of this link. */
|
|
6
6
|
title?: string;
|
|
@@ -78,6 +78,7 @@ export declare class Rumour {
|
|
|
78
78
|
track(callback: TrackCallback): CeaseCallback;
|
|
79
79
|
/** Removes all update listeners. */
|
|
80
80
|
cease(): void;
|
|
81
|
+
private static __isCollection;
|
|
81
82
|
private static __isResource;
|
|
82
83
|
private static __approximateURI;
|
|
83
84
|
private static __createPatch;
|
|
@@ -19,8 +19,8 @@ export interface Attribute extends Graph {
|
|
|
19
19
|
/** The value of this attribute. */
|
|
20
20
|
value: string;
|
|
21
21
|
/** The date this resource was created. */
|
|
22
|
-
date_created: string;
|
|
22
|
+
date_created: string | null;
|
|
23
23
|
/** The date this resource was last modified. */
|
|
24
|
-
date_modified: string;
|
|
24
|
+
date_modified: string | null;
|
|
25
25
|
};
|
|
26
26
|
}
|
|
@@ -35,12 +35,12 @@ export interface CustomerAddress extends Graph {
|
|
|
35
35
|
/** The phone of this address. */
|
|
36
36
|
phone: string;
|
|
37
37
|
/** Specifies if this address is the default billing address for the customer. */
|
|
38
|
-
is_default_billing:
|
|
38
|
+
is_default_billing: boolean;
|
|
39
39
|
/** Specifies if this address is the default shipping address for the customer. */
|
|
40
|
-
is_default_shipping:
|
|
40
|
+
is_default_shipping: boolean;
|
|
41
41
|
/** The date this resource was created. */
|
|
42
|
-
date_created: string;
|
|
42
|
+
date_created: string | null;
|
|
43
43
|
/** The date this resource was last modified. */
|
|
44
|
-
date_modified: string;
|
|
44
|
+
date_modified: string | null;
|
|
45
45
|
};
|
|
46
46
|
}
|
|
@@ -54,8 +54,8 @@ export interface CustomerPortalSettings extends Graph {
|
|
|
54
54
|
/** Life span of session in minutes. Maximum 40320 (4 weeks). */
|
|
55
55
|
session_lifespan_in_minutes: number;
|
|
56
56
|
/** The date this resource was created. */
|
|
57
|
-
date_created: string;
|
|
57
|
+
date_created: string | null;
|
|
58
58
|
/** The date this resource was last modified. */
|
|
59
|
-
date_modified: string;
|
|
59
|
+
date_modified: string | null;
|
|
60
60
|
};
|
|
61
61
|
}
|
|
@@ -24,8 +24,8 @@ export interface DefaultPaymentMethod extends Graph {
|
|
|
24
24
|
/** The payment card expiration year in the YYYY format. */
|
|
25
25
|
cc_exp_year: string | null;
|
|
26
26
|
/** The date this resource was created. */
|
|
27
|
-
date_created: string;
|
|
27
|
+
date_created: string | null;
|
|
28
28
|
/** The date this resource was last modified. */
|
|
29
|
-
date_modified: string;
|
|
29
|
+
date_modified: string | null;
|
|
30
30
|
};
|
|
31
31
|
}
|
|
@@ -49,9 +49,9 @@ interface Customer extends Graph {
|
|
|
49
49
|
/** A tax identification number for this customer. */
|
|
50
50
|
tax_id: string;
|
|
51
51
|
/** The date this resource was created. */
|
|
52
|
-
date_created: string;
|
|
52
|
+
date_created: string | null;
|
|
53
53
|
/** The date this resource was last modified. */
|
|
54
|
-
date_modified: string;
|
|
54
|
+
date_modified: string | null;
|
|
55
55
|
};
|
|
56
56
|
|
|
57
57
|
zooms: {
|
|
@@ -58,8 +58,8 @@ export interface Item extends Graph {
|
|
|
58
58
|
/** As a unix timestamp, this is the point in the future when this item will no longer be valid and will be removed from the cart. */
|
|
59
59
|
expires: number;
|
|
60
60
|
/** The date this resource was created. */
|
|
61
|
-
date_created: string;
|
|
61
|
+
date_created: string | null;
|
|
62
62
|
/** The date this resource was last modified. */
|
|
63
|
-
date_modified: string;
|
|
63
|
+
date_modified: string | null;
|
|
64
64
|
};
|
|
65
65
|
}
|
|
@@ -47,9 +47,9 @@ export interface Subscription extends Graph {
|
|
|
47
47
|
/** If this subscription is using a third party subscription system such as PayPal Express, their identifier will be set here. */
|
|
48
48
|
third_party_id: string;
|
|
49
49
|
/** The date this resource was created. */
|
|
50
|
-
date_created: string;
|
|
50
|
+
date_created: string | null;
|
|
51
51
|
/** The date this resource was last modified. */
|
|
52
|
-
date_modified: string;
|
|
52
|
+
date_modified: string | null;
|
|
53
53
|
};
|
|
54
54
|
|
|
55
55
|
zooms: {
|
|
@@ -65,9 +65,9 @@ export interface Transaction extends Graph {
|
|
|
65
65
|
/** The currency symbol, such as $, £, €, etc. */
|
|
66
66
|
currency_symbol: string;
|
|
67
67
|
/** The date this resource was created. */
|
|
68
|
-
date_created: string;
|
|
68
|
+
date_created: string | null;
|
|
69
69
|
/** The date this resource was last modified. */
|
|
70
|
-
date_modified: string;
|
|
70
|
+
date_modified: string | null;
|
|
71
71
|
};
|
|
72
72
|
|
|
73
73
|
zooms: {
|
|
@@ -80,9 +80,9 @@ export interface TransactionTemplate extends Graph {
|
|
|
80
80
|
/** The currency symbol, such as $, £, €, etc. */
|
|
81
81
|
currency_symbol: string;
|
|
82
82
|
/** The date this resource was created. */
|
|
83
|
-
date_created: string;
|
|
83
|
+
date_created: string | null;
|
|
84
84
|
/** The date this resource was last modified. */
|
|
85
|
-
date_modified: string;
|
|
85
|
+
date_modified: string | null;
|
|
86
86
|
};
|
|
87
87
|
|
|
88
88
|
zooms: {
|
package/package.json
CHANGED