@foxy.io/sdk 2.0.0-beta.1 → 2.0.0-beta.2

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.
Files changed (102) hide show
  1. package/README.md +4 -4
  2. package/dist/cdn/FoxySDKCustomer.js +3 -3
  3. package/dist/cjs/backend/API.js +2 -2
  4. package/dist/cjs/backend/createSSOURL.js +1 -1
  5. package/dist/cjs/core/API/AuthError.js +1 -1
  6. package/dist/cjs/core/API/Node.js +11 -11
  7. package/dist/cjs/core/Nucleon/machine.js +1 -0
  8. package/dist/cjs/core/Rumour/Rumour.js +4 -1
  9. package/dist/esm/backend/API.js +2 -2
  10. package/dist/esm/backend/createSSOURL.js +1 -1
  11. package/dist/esm/core/API/AuthError.js +1 -1
  12. package/dist/esm/core/API/Node.js +11 -11
  13. package/dist/esm/core/Nucleon/machine.js +1 -0
  14. package/dist/esm/core/Rumour/Rumour.js +4 -1
  15. package/dist/types/backend/API.d.ts +2 -2
  16. package/dist/types/backend/Graph/applied_coupon_code.d.ts +2 -2
  17. package/dist/types/backend/Graph/applied_tax.d.ts +2 -2
  18. package/dist/types/backend/Graph/attribute.d.ts +2 -2
  19. package/dist/types/backend/Graph/billing_address.d.ts +2 -2
  20. package/dist/types/backend/Graph/cart.d.ts +2 -2
  21. package/dist/types/backend/Graph/cart_include_template.d.ts +2 -2
  22. package/dist/types/backend/Graph/cart_template.d.ts +2 -2
  23. package/dist/types/backend/Graph/checkout_template.d.ts +2 -2
  24. package/dist/types/backend/Graph/client.d.ts +2 -2
  25. package/dist/types/backend/Graph/coupon.d.ts +4 -4
  26. package/dist/types/backend/Graph/coupon_code.d.ts +2 -2
  27. package/dist/types/backend/Graph/coupon_code_transaction.d.ts +2 -2
  28. package/dist/types/backend/Graph/coupon_codes.d.ts +9 -0
  29. package/dist/types/backend/Graph/coupon_detail.d.ts +2 -2
  30. package/dist/types/backend/Graph/coupon_item_category.d.ts +2 -2
  31. package/dist/types/backend/Graph/custom_field.d.ts +2 -2
  32. package/dist/types/backend/Graph/customer.d.ts +2 -2
  33. package/dist/types/backend/Graph/customer_address.d.ts +4 -4
  34. package/dist/types/backend/Graph/customer_portal_settings.d.ts +2 -2
  35. package/dist/types/backend/Graph/default_payment_method.d.ts +7 -7
  36. package/dist/types/backend/Graph/discount.d.ts +2 -2
  37. package/dist/types/backend/Graph/discount_detail.d.ts +2 -2
  38. package/dist/types/backend/Graph/downloadable.d.ts +2 -2
  39. package/dist/types/backend/Graph/downloadable_purchase.d.ts +2 -2
  40. package/dist/types/backend/Graph/email_template.d.ts +2 -2
  41. package/dist/types/backend/Graph/error_entry.d.ts +2 -2
  42. package/dist/types/backend/Graph/fraud_protection.d.ts +2 -2
  43. package/dist/types/backend/Graph/generate_codes.d.ts +2 -0
  44. package/dist/types/backend/Graph/gift_card.d.ts +42 -0
  45. package/dist/types/backend/Graph/gift_card_code.d.ts +35 -0
  46. package/dist/types/backend/Graph/gift_card_code_logs.d.ts +10 -0
  47. package/dist/types/backend/Graph/gift_card_codes.d.ts +21 -0
  48. package/dist/types/backend/Graph/gift_card_item_categories.d.ts +10 -0
  49. package/dist/types/backend/Graph/gift_card_item_category.d.ts +30 -0
  50. package/dist/types/backend/Graph/gift_cards.d.ts +10 -0
  51. package/dist/types/backend/Graph/hosted_payment_gateways_helper.d.ts +56 -0
  52. package/dist/types/backend/Graph/integration.d.ts +10 -10
  53. package/dist/types/backend/Graph/item.d.ts +2 -2
  54. package/dist/types/backend/Graph/item_category.d.ts +2 -2
  55. package/dist/types/backend/Graph/item_option.d.ts +2 -2
  56. package/dist/types/backend/Graph/language_override.d.ts +2 -2
  57. package/dist/types/backend/Graph/language_strings.d.ts +1 -5
  58. package/dist/types/backend/Graph/native_integration.d.ts +2 -2
  59. package/dist/types/backend/Graph/payment.d.ts +5 -5
  60. package/dist/types/backend/Graph/payment_gateway.d.ts +2 -2
  61. package/dist/types/backend/Graph/payment_gateways_helper.d.ts +56 -0
  62. package/dist/types/backend/Graph/payment_method_expiring.d.ts +2 -2
  63. package/dist/types/backend/Graph/payment_method_set.d.ts +2 -2
  64. package/dist/types/backend/Graph/payment_method_set_fraud_protection.d.ts +2 -2
  65. package/dist/types/backend/Graph/payment_method_set_hosted_payment_gateway.d.ts +2 -2
  66. package/dist/types/backend/Graph/property_helpers.d.ts +4 -4
  67. package/dist/types/backend/Graph/receipt_template.d.ts +2 -2
  68. package/dist/types/backend/Graph/regions.d.ts +0 -2
  69. package/dist/types/backend/Graph/shipment.d.ts +2 -2
  70. package/dist/types/backend/Graph/shipping_container.d.ts +2 -2
  71. package/dist/types/backend/Graph/shipping_drop_type.d.ts +2 -2
  72. package/dist/types/backend/Graph/shipping_method.d.ts +2 -2
  73. package/dist/types/backend/Graph/shipping_service.d.ts +2 -2
  74. package/dist/types/backend/Graph/store.d.ts +5 -2
  75. package/dist/types/backend/Graph/store_shipping_method.d.ts +2 -2
  76. package/dist/types/backend/Graph/store_shipping_service.d.ts +2 -2
  77. package/dist/types/backend/Graph/store_version.d.ts +21 -3
  78. package/dist/types/backend/Graph/subscription.d.ts +2 -2
  79. package/dist/types/backend/Graph/subscription_settings.d.ts +2 -2
  80. package/dist/types/backend/Graph/tax.d.ts +2 -2
  81. package/dist/types/backend/Graph/tax_item_category.d.ts +2 -2
  82. package/dist/types/backend/Graph/template_config.d.ts +2 -2
  83. package/dist/types/backend/Graph/template_set.d.ts +2 -2
  84. package/dist/types/backend/Graph/transaction.d.ts +2 -2
  85. package/dist/types/backend/Graph/transaction_log.d.ts +1 -1
  86. package/dist/types/backend/Graph/user.d.ts +2 -2
  87. package/dist/types/backend/Graph/user_access.d.ts +2 -2
  88. package/dist/types/backend/Rels.d.ts +9 -0
  89. package/dist/types/backend/createSSOURL.d.ts +5 -3
  90. package/dist/types/core/Nucleon/types.d.ts +2 -1
  91. package/dist/types/core/Resource/Link.d.ts +1 -1
  92. package/dist/types/core/Rumour/Rumour.d.ts +1 -0
  93. package/dist/types/customer/Graph/attribute.d.ts +2 -2
  94. package/dist/types/customer/Graph/customer_address.d.ts +4 -4
  95. package/dist/types/customer/Graph/customer_portal_settings.d.ts +2 -2
  96. package/dist/types/customer/Graph/default_payment_method.d.ts +7 -7
  97. package/dist/types/customer/Graph/index.d.ts +2 -2
  98. package/dist/types/customer/Graph/item.d.ts +2 -2
  99. package/dist/types/customer/Graph/subscription.d.ts +2 -2
  100. package/dist/types/customer/Graph/transaction.d.ts +2 -2
  101. package/dist/types/customer/Graph/transaction_template.d.ts +2 -2
  102. package/package.json +1 -1
@@ -0,0 +1,42 @@
1
+ import type { GenerateCodes } from './generate_codes';
2
+ import type { GiftCardCodes } from './gift_card_codes';
3
+ import type { GiftCardItemCategories } from './gift_card_item_categories';
4
+ import type { Graph } from '../../core';
5
+ import type { Store } from './store';
6
+
7
+ export interface GiftCard extends Graph {
8
+ curie: 'fx:gift_card';
9
+
10
+ links: {
11
+ /** This resource. */
12
+ 'self': GiftCard;
13
+ /** Store this gift card is assigned to. */
14
+ 'fx:store': Store;
15
+ /** POST here to generate random gift card codes. */
16
+ 'fx:generate_codes': GenerateCodes;
17
+ /** Collection of codes for this gift card. */
18
+ 'fx:gift_card_codes': GiftCardCodes;
19
+ /** Collection of item category to gift card mappings for this card. */
20
+ 'fx:gift_card_item_categories': GiftCardItemCategories;
21
+ };
22
+
23
+ props: {
24
+ /** The name of this gift card. This will be displayed to the customer, such as "Gift Card" or "Store Credit". Required. 50 characters or less. */
25
+ name: string;
26
+ /** Currency code for this gift card. Note that gift cards are only usable if the cart's currency matches. Optional. The 3 character ISO code for the currency. */
27
+ currency_code: string;
28
+ /** This determines when the gift card will expire. The format is a number followed by a date type such as `d` (day), `w` (week), `m` (month), or `y` (year). You can also use `.5m` for twice a month, as with subscription frequency settings. Check with your local laws to ensure expiring gift cards is legal, according to your use case. The actual expiration date will be set on the `gift_card_code` resources when they are created, according to this setting. Optional. If present, the format must be valid, such as `1m`, `3w`, `45d`, etc. */
29
+ expires_after: string | null;
30
+ /** 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. */
31
+ product_code_restrictions: string | null;
32
+ /** The date this resource was created. ISO date. Read only. */
33
+ date_created: string | null;
34
+ /** The date this resource was last modified. ISO date. Read only. */
35
+ date_modified: string | null;
36
+ };
37
+
38
+ zooms: {
39
+ gift_card_codes?: GiftCardCodes;
40
+ gift_card_item_categories?: GiftCardItemCategories;
41
+ };
42
+ }
@@ -0,0 +1,35 @@
1
+ import type { Customer } from './customer';
2
+ import type { GiftCard } from './gift_card';
3
+ import type { GiftCardCodeLogs } from './gift_card_code_logs';
4
+ import type { Graph } from '../../core';
5
+ import type { Store } from './store';
6
+
7
+ export interface GiftCardCode extends Graph {
8
+ curie: 'fx:gift_card_code';
9
+
10
+ links: {
11
+ /** This resource. */
12
+ 'self': GiftCardCode;
13
+ /** Store this gift card code belongs to. */
14
+ 'fx:store': Store;
15
+ /** Customer this gift card belongs to. */
16
+ 'fx:customer': Customer;
17
+ /** Gift card this code corresponds to. */
18
+ 'fx:gift_card': GiftCard;
19
+ /** Transactions using this gift card code. */
20
+ 'fx:gift_card_code_logs': GiftCardCodeLogs;
21
+ };
22
+
23
+ props: {
24
+ /** The string value of this gift card code which your customer will add to their cart to use this gift card. Required. 50 characters or less. */
25
+ code: string;
26
+ /** The date when this gift card code will expire. ISO date. Optional. */
27
+ end_date: string | null;
28
+ /** Current balance on the gift card. Decimal. Required. */
29
+ current_balance: number;
30
+ /** The date this resource was created. Readonly. */
31
+ date_created: string | null;
32
+ /** The date this resource was last modified. Readonly. */
33
+ date_modified: string | null;
34
+ };
35
+ }
@@ -0,0 +1,10 @@
1
+ import type { CollectionGraphLinks, CollectionGraphProps } from '../../core/defaults';
2
+ import type { Graph } from '../../core';
3
+ import type { Transaction } from './transaction';
4
+
5
+ export interface GiftCardCodeLogs extends Graph {
6
+ curie: 'fx:gift_card_code_logs';
7
+ links: CollectionGraphLinks<GiftCardCodeLogs>;
8
+ props: CollectionGraphProps;
9
+ child: Transaction;
10
+ }
@@ -0,0 +1,21 @@
1
+ import type { CollectionGraphLinks, CollectionGraphProps } from '../../core/defaults';
2
+ import type { GiftCardCode } from './gift_card_code';
3
+ import type { Graph } from '../../core';
4
+
5
+ export interface GiftCardCodes extends Graph {
6
+ curie: 'fx:gift_card_codes';
7
+ links: CollectionGraphLinks<GiftCardCodes>;
8
+ props: CollectionGraphProps;
9
+ child: GiftCardCode;
10
+ }
11
+
12
+ export interface GiftCardCodesImport extends Graph {
13
+ curie: 'fx:gift_card_codes';
14
+
15
+ props: {
16
+ /** List of codes to import. */
17
+ gift_card_codes: string[];
18
+ /** Initial balance. */
19
+ current_balance: number;
20
+ };
21
+ }
@@ -0,0 +1,10 @@
1
+ import type { CollectionGraphLinks, CollectionGraphProps } from '../../core/defaults';
2
+ import type { GiftCardItemCategory } from './gift_card_item_category';
3
+ import type { Graph } from '../../core';
4
+
5
+ export interface GiftCardItemCategories extends Graph {
6
+ curie: 'fx:gift_card_item_categories';
7
+ links: CollectionGraphLinks<GiftCardItemCategories>;
8
+ props: CollectionGraphProps;
9
+ child: GiftCardItemCategory;
10
+ }
@@ -0,0 +1,30 @@
1
+ import type { GiftCard } from './gift_card';
2
+ import type { Graph } from '../../core';
3
+ import type { ItemCategory } from './item_category';
4
+ import type { Store } from './store';
5
+
6
+ export interface GiftCardItemCategory extends Graph {
7
+ curie: 'fx:gift_card_item_category';
8
+
9
+ links: {
10
+ /** This resource. */
11
+ 'self': GiftCardItemCategory;
12
+ /** Store the gift card belongs to. */
13
+ 'fx:store': Store;
14
+ /** Gift card this category belongs to. */
15
+ 'fx:gift_card': GiftCard;
16
+ /** Item category this resource links to. */
17
+ 'fx:item_category': ItemCategory;
18
+ };
19
+
20
+ props: {
21
+ /** The full API URI of the gift card associated with this gift card item category. */
22
+ gift_card_uri: string;
23
+ /** The full API URI of the item category associated with this gift card item category. */
24
+ item_category_uri: string;
25
+ /** The date this resource was created. */
26
+ date_created: string | null;
27
+ /** The date this resource was last modified. */
28
+ date_modified: string | null;
29
+ };
30
+ }
@@ -0,0 +1,10 @@
1
+ import type { CollectionGraphLinks, CollectionGraphProps } from '../../core/defaults';
2
+ import type { GiftCard } from './gift_card';
3
+ import type { Graph } from '../../core';
4
+
5
+ export interface GiftCards extends Graph {
6
+ curie: 'fx:gift_cards';
7
+ links: CollectionGraphLinks<GiftCards>;
8
+ props: CollectionGraphProps;
9
+ child: GiftCard;
10
+ }
@@ -0,0 +1,56 @@
1
+ import type { Graph } from '../../core';
2
+ import type { PropertyHelpers } from './property_helpers';
3
+
4
+ export interface HostedPaymentGatewaysHelper extends Graph {
5
+ curie: 'fx:hosted_payment_gateways';
6
+
7
+ links: {
8
+ /** This resource. */
9
+ 'self': HostedPaymentGatewaysHelper;
10
+ /** Various predefined property values. */
11
+ 'fx:property_helpers': PropertyHelpers;
12
+ };
13
+
14
+ props: {
15
+ /** A small, human readable explanation of this property helper. */
16
+ message: string;
17
+ /** JSON objects with the payment gateway names as the keys. */
18
+ values: {
19
+ [key: string]: {
20
+ /** The name of this hosted payment gateway. */
21
+ name: string;
22
+ /** The default id you can use for testing this hosted gateway. */
23
+ test_id: string;
24
+ /** The default key you can use for testing this hosted gateway. */
25
+ test_key: string;
26
+ /** The description of the id field for this hosted gateway. */
27
+ id_description: string;
28
+ /** The description of the key field for this hosted gateway. */
29
+ key_description: string;
30
+ /** Whether or not this hosted gateway supports 3D Secure functionality. */
31
+ supports_3d_secure: 0 | 1;
32
+ /** Whether or not this hosted gateway supports authorize only instead of auth+capture. */
33
+ supports_auth_only: 0 | 1;
34
+ /** The default third party key you can use for testing this hosted gateway. */
35
+ test_third_party_key: string;
36
+ /** The description of the third party key field for this hosted gateway. */
37
+ third_party_key_description: string;
38
+ /** If this hosted gateway requires additional information, this will contain details about the data which needs to be collected to configure this hosted gateway. */
39
+ additional_fields: null | {
40
+ blocks: {
41
+ id: string;
42
+ is_live: boolean;
43
+ parent_id: string;
44
+ fields: {
45
+ id: string;
46
+ name: string;
47
+ type: string;
48
+ description?: string;
49
+ default_value: string;
50
+ }[];
51
+ }[];
52
+ };
53
+ };
54
+ };
55
+ };
56
+ }
@@ -20,29 +20,29 @@ export interface Integration extends Graph {
20
20
  props: {
21
21
  /** A full API URI of the user resource used in this relationship. When working with hypermedia, it's important to save URIs and not just numeric ids. */
22
22
  user_uri: string;
23
- /** A unique identifier for this client. Maps to the client_id of the {@link https://api.foxycart.com/rels/client client} resource. */
23
+ /** A unique identifier for this client. Maps to the client_id of the {@link https://api.foxy.io/rels/client client} resource. */
24
24
  client_id: string;
25
25
  /** The OAuth scope granted to this integration. */
26
26
  scope: string;
27
27
  /** When this OAuth refresh token expires. */
28
28
  expires: number;
29
- /** Maps to the project_name of the {@link https://api.foxycart.com/rels/client client} resource. */
29
+ /** Maps to the project_name of the {@link https://api.foxy.io/rels/client client} resource. */
30
30
  project_name: string;
31
- /** Maps to the project_description of the {@link https://api.foxycart.com/rels/client client} resource. */
31
+ /** Maps to the project_description of the {@link https://api.foxy.io/rels/client client} resource. */
32
32
  project_description: string;
33
- /** Maps to the company_name of the {@link https://api.foxycart.com/rels/client client} resource. */
33
+ /** Maps to the company_name of the {@link https://api.foxy.io/rels/client client} resource. */
34
34
  company_name: string;
35
- /** Maps to the company_url of the {@link https://api.foxycart.com/rels/client client} resource. */
35
+ /** Maps to the company_url of the {@link https://api.foxy.io/rels/client client} resource. */
36
36
  company_url: string;
37
- /** Maps to the company_logo of the {@link https://api.foxycart.com/rels/client client} resource. */
37
+ /** Maps to the company_logo of the {@link https://api.foxy.io/rels/client client} resource. */
38
38
  company_logo: string;
39
- /** Maps to the contact_name of the {@link https://api.foxycart.com/rels/client client} resource. */
39
+ /** Maps to the contact_name of the {@link https://api.foxy.io/rels/client client} resource. */
40
40
  contact_name: string;
41
- /** Maps to the contact_email of the {@link https://api.foxycart.com/rels/client client} resource. */
41
+ /** Maps to the contact_email of the {@link https://api.foxy.io/rels/client client} resource. */
42
42
  contact_email: string;
43
- /** Maps to the first_name and last_name of the {@link https://api.foxycart.com/rels/user user} resource. */
43
+ /** Maps to the first_name and last_name of the {@link https://api.foxy.io/rels/user user} resource. */
44
44
  added_by_name: string;
45
- /** Maps to the email of the {@link https://api.foxycart.com/rels/user user} resource. */
45
+ /** Maps to the email of the {@link https://api.foxy.io/rels/user user} resource. */
46
46
  added_by_email: string;
47
47
  };
48
48
  }
@@ -82,9 +82,9 @@ export interface Item extends Graph {
82
82
  /** 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. */
83
83
  expires: number;
84
84
  /** The date this resource was created. */
85
- date_created: string;
85
+ date_created: string | null;
86
86
  /** The date this resource was last modified. */
87
- date_modified: string;
87
+ date_modified: string | null;
88
88
  };
89
89
 
90
90
  zooms: {
@@ -65,8 +65,8 @@ export interface ItemCategory extends Graph {
65
65
  /** Email address of the administrator you'd like to send an email to every time an item in this category is purchased. */
66
66
  admin_email: 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
  }
@@ -27,8 +27,8 @@ export interface ItemOption extends Graph {
27
27
  /** 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. */
28
28
  weight_mod: number;
29
29
  /** The date this resource was created. */
30
- date_created: string;
30
+ date_created: string | null;
31
31
  /** The date this resource was last modified. */
32
- date_modified: string;
32
+ date_modified: string | null;
33
33
  };
34
34
  }
@@ -25,8 +25,8 @@ export interface LanguageOverride extends Graph {
25
25
  /** Your custom string for this language code. */
26
26
  custom_value: string;
27
27
  /** The date this resource was created. */
28
- date_created: string;
28
+ date_created: string | null;
29
29
  /** The date this resource was last modified. */
30
- date_modified: string;
30
+ date_modified: string | null;
31
31
  };
32
32
  }
@@ -1,10 +1,6 @@
1
1
  import type { Graph } from '../../core';
2
2
  import type { PropertyHelpers } from './property_helpers';
3
3
 
4
- interface StringRecord {
5
- [key: string]: StringRecord;
6
- }
7
-
8
4
  export interface LanguageStrings extends Graph {
9
5
  curie: 'fx:language_strings';
10
6
 
@@ -19,6 +15,6 @@ export interface LanguageStrings extends Graph {
19
15
  /** A small, human readable explanation of this property helper. */
20
16
  message: string;
21
17
  /** 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`. */
22
- values: StringRecord;
18
+ values: Record<string, Record<string, string>>;
23
19
  };
24
20
  }
@@ -17,8 +17,8 @@ export interface NativeIntegration extends Graph {
17
17
  /** A JSON string containing the configuration values and credentials for this native integration. */
18
18
  config: string;
19
19
  /** The date this resource was created. */
20
- date_created: string;
20
+ date_created: string | null;
21
21
  /** The date this resource was last modified. */
22
- date_modified: string;
22
+ date_modified: string | null;
23
23
  };
24
24
  }
@@ -28,11 +28,11 @@ export interface Payment extends Graph {
28
28
  /** The masked credit card number used for this payment (for plastic payment types). */
29
29
  cc_number_masked: string;
30
30
  /** The type of credit card such as Visa or MasterCard (for plastic payment types). */
31
- cc_type: string;
31
+ cc_type: string | null;
32
32
  /** The credit card expiration month (for plastic payment types). */
33
- cc_exp_month: string;
33
+ cc_exp_month: string | null;
34
34
  /** The credit card expiration year (for plastic payment types). */
35
- cc_exp_year: string;
35
+ cc_exp_year: string | null;
36
36
  /** If this payment gateway set is configured with a fraud protection system, the fraud score for this payment will be listed here. */
37
37
  fraud_protection_score: number;
38
38
  /** The payer id for this payment (for Paypal payment types). */
@@ -42,8 +42,8 @@ export interface Payment extends Graph {
42
42
  /** The total amount of this payment. */
43
43
  amount: number;
44
44
  /** The date this resource was created. */
45
- date_created: string;
45
+ date_created: string | null;
46
46
  /** The date this resource was last modified. */
47
- date_modified: string;
47
+ date_modified: string | null;
48
48
  };
49
49
  }
@@ -41,8 +41,8 @@ export interface PaymentGateway extends Graph {
41
41
  /** 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. */
42
42
  test_third_party_key: string;
43
43
  /** The date this resource was created. */
44
- date_created: string;
44
+ date_created: string | null;
45
45
  /** The date this resource was last modified. */
46
- date_modified: string;
46
+ date_modified: string | null;
47
47
  };
48
48
  }
@@ -0,0 +1,56 @@
1
+ import type { Graph } from '../../core';
2
+ import type { PropertyHelpers } from './property_helpers';
3
+
4
+ export interface PaymentGatewaysHelper extends Graph {
5
+ curie: 'fx:payment_gateways';
6
+
7
+ links: {
8
+ /** This resource. */
9
+ 'self': PaymentGatewaysHelper;
10
+ /** Various predefined property values. */
11
+ 'fx:property_helpers': PropertyHelpers;
12
+ };
13
+
14
+ props: {
15
+ /** A small, human readable explanation of this property helper. */
16
+ message: string;
17
+ /** JSON objects with the payment gateway names as the keys. */
18
+ values: {
19
+ [key: string]: {
20
+ /** The name of this payment gateway. */
21
+ name: string;
22
+ /** The default id you can use for testing this gateway. */
23
+ test_id: string;
24
+ /** The default key you can use for testing this gateway. */
25
+ test_key: string;
26
+ /** The description of the id field for this gateway. */
27
+ id_description: string;
28
+ /** The description of the key field for this gateway. */
29
+ key_description: string;
30
+ /** Whether or not this gateway supports 3D Secure functionality. */
31
+ supports_3d_secure: 0 | 1;
32
+ /** Whether or not this gateway supports authorize only instead of auth+capture. */
33
+ supports_auth_only: 0 | 1;
34
+ /** The default third party key you can use for testing this gateway. */
35
+ test_third_party_key: string;
36
+ /** The description of the third party key field for this gateway. */
37
+ third_party_key_description: string;
38
+ /** If this gateway requires additional information, this will contain details about the data which needs to be collected to configure this gateway. */
39
+ additional_fields: null | {
40
+ blocks: {
41
+ id: string;
42
+ is_live: boolean;
43
+ parent_id: string;
44
+ fields: {
45
+ id: string;
46
+ name: string;
47
+ type: string;
48
+ description?: string;
49
+ default_value: string;
50
+ }[];
51
+ }[];
52
+ };
53
+ };
54
+ };
55
+ };
56
+ }
@@ -41,8 +41,8 @@ export interface PaymentMethodExpiring extends Graph {
41
41
  /** The payment card expiration year in the YYYY format. */
42
42
  cc_exp_year: string;
43
43
  /** The date this resource was created. */
44
- date_created: string;
44
+ date_created: string | null;
45
45
  /** The date this resource was last modified. */
46
- date_modified: string;
46
+ date_modified: string | null;
47
47
  };
48
48
  }
@@ -33,8 +33,8 @@ export interface PaymentMethodSet extends Graph {
33
33
  /** 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. */
34
34
  is_purchase_order_enabled: boolean;
35
35
  /** The date this resource was created. */
36
- date_created: string;
36
+ date_created: string | null;
37
37
  /** The date this resource was last modified. */
38
- date_modified: string;
38
+ date_modified: string | null;
39
39
  };
40
40
  }
@@ -23,8 +23,8 @@ export interface PaymentMethodSetFraudProtection extends Graph {
23
23
  /** The full API URI of the fraud protection associated with this payment method set fraud protection. */
24
24
  fraud_protection_uri: string;
25
25
  /** The date this resource was created. */
26
- date_created: string;
26
+ date_created: string | null;
27
27
  /** The date this resource was last modified. */
28
- date_modified: string;
28
+ date_modified: string | null;
29
29
  };
30
30
  }
@@ -23,8 +23,8 @@ export interface PaymentMethodSetHostedPaymentGateway extends Graph {
23
23
  /** The full API URI of the hosted payment gateway associated with this payment method set hosted payment gateway. */
24
24
  hosted_payment_gateway_uri: string;
25
25
  /** The date this resource was created. */
26
- date_created: string;
26
+ date_created: string | null;
27
27
  /** The date this resource was last modified. */
28
- date_modified: string;
28
+ date_modified: string | null;
29
29
  };
30
30
  }
@@ -3,11 +3,11 @@ import type { Countries } from './countries';
3
3
  import type { CustomerPasswordHashTypes } from './customer_password_hash_types';
4
4
  import type { DefaultTemplates } from './default_templates';
5
5
  import type { Graph } from '../../core';
6
- import type { HostedPaymentGateways } from './hosted_payment_gateways';
6
+ import type { HostedPaymentGatewaysHelper } from './hosted_payment_gateways_helper';
7
7
  import type { LanguageStrings } from './language_strings';
8
8
  import type { Languages } from './languages';
9
9
  import type { LocaleCodes } from './locale_codes';
10
- import type { PaymentGateways } from './payment_gateways';
10
+ import type { PaymentGatewaysHelper } from './payment_gateways_helper';
11
11
  import type { Regions } from './regions';
12
12
  import type { ShippingAddressTypes } from './shipping_address_types';
13
13
  import type { ShippingMethods } from './shipping_methods';
@@ -37,7 +37,7 @@ export interface PropertyHelpers extends Graph {
37
37
  /** The shipping carriers used when configuring live shipping rates. */
38
38
  'fx:shipping_methods': ShippingMethods;
39
39
  /** List of supported payment gateways and valid entries for that resource's `type` setting. */
40
- 'fx:payment_gateways': PaymentGateways;
40
+ 'fx:payment_gateways': PaymentGatewaysHelper;
41
41
  /** List of default language strings that can be overriden. */
42
42
  'fx:language_strings': LanguageStrings;
43
43
  /** Default templates for the cart, checkout, receipt and email. */
@@ -45,7 +45,7 @@ export interface PropertyHelpers extends Graph {
45
45
  /** List of valid address type values for the store's `shipping_address_type` setting. */
46
46
  'fx:shipping_address_types': ShippingAddressTypes;
47
47
  /** Hosted payment gateways such as PayPal, BitPay, and Dwolla. */
48
- 'fx:hosted_payment_gateways': HostedPaymentGateways;
48
+ 'fx:hosted_payment_gateways': HostedPaymentGatewaysHelper;
49
49
  /** List of valid customer password hash type values for the store's `customer_password_hash_type` setting. */
50
50
  'fx:customer_password_hash_types': CustomerPasswordHashTypes;
51
51
  };
@@ -28,8 +28,8 @@ export interface ReceiptTemplate extends Graph {
28
28
  /** The URL of your receipt template hosted on your own server online and publicly available for our server to cache. */
29
29
  content_url: string;
30
30
  /** The date this resource was created. */
31
- date_created: string;
31
+ date_created: string | null;
32
32
  /** The date this resource was last modified. */
33
- date_modified: string;
33
+ date_modified: string | null;
34
34
  };
35
35
  }
@@ -21,8 +21,6 @@ export interface Regions extends Graph {
21
21
  default: string;
22
22
  /** The code for this region. */
23
23
  code: string;
24
- /** The official 3 character country code. */
25
- cc3: string;
26
24
  /** Array of alternative names for this region. */
27
25
  alternate_values: string[];
28
26
  /** This value determines which regions will show up first in our find-as-you-type system. */
@@ -62,8 +62,8 @@ export interface Shipment extends Graph {
62
62
  /** The total price of this shipment. */
63
63
  total_price: number;
64
64
  /** The date this resource was created. */
65
- date_created: string;
65
+ date_created: string | null;
66
66
  /** The date this resource was last modified. */
67
- date_modified: string;
67
+ date_modified: string | null;
68
68
  };
69
69
  }
@@ -26,8 +26,8 @@ export interface ShippingContainer extends Graph {
26
26
  /** The code for this shipping container */
27
27
  code: string;
28
28
  /** The date this resource was created. */
29
- date_created: string;
29
+ date_created: string | null;
30
30
  /** The date this resource was last modified. */
31
- date_modified: string;
31
+ date_modified: string | null;
32
32
  };
33
33
  }
@@ -26,8 +26,8 @@ export interface ShippingDropType extends Graph {
26
26
  /** The code for this shipping drop type */
27
27
  code: string;
28
28
  /** The date this resource was created. */
29
- date_created: string;
29
+ date_created: string | null;
30
30
  /** The date this resource was last modified. */
31
- date_modified: string;
31
+ date_modified: string | null;
32
32
  };
33
33
  }
@@ -29,8 +29,8 @@ export interface ShippingMethod extends Graph {
29
29
  /** The code for this shipping method */
30
30
  code: string;
31
31
  /** The date this resource was created. */
32
- date_created: string;
32
+ date_created: string | null;
33
33
  /** The date this resource was last modified. */
34
- date_modified: string;
34
+ date_modified: string | null;
35
35
  };
36
36
  }
@@ -25,8 +25,8 @@ export interface ShippingService extends Graph {
25
25
  /** Specifies whether or not this shipping service is for international rate requests only. */
26
26
  is_international: boolean;
27
27
  /** The date this resource was created. */
28
- date_created: string;
28
+ date_created: string | null;
29
29
  /** The date this resource was last modified. */
30
- date_modified: string;
30
+ date_modified: string | null;
31
31
  };
32
32
  }
@@ -10,6 +10,7 @@ import type { Downloadables } from './downloadables';
10
10
  import type { EmailTemplates } from './email_templates';
11
11
  import type { ErrorEntries } from './error_entries';
12
12
  import type { FraudProtections } from './fraud_protections';
13
+ import type { GiftCards } from './gift_cards';
13
14
  import type { Graph } from '../../core';
14
15
  import type { HostedPaymentGateways } from './hosted_payment_gateways';
15
16
  import type { ItemCategories } from './item_categories';
@@ -41,6 +42,8 @@ export interface Store extends Graph {
41
42
  'fx:coupons': Coupons;
42
43
  /** List of customers of this store. */
43
44
  'fx:customers': Customers;
45
+ /** List of gift cards available in this store. */
46
+ 'fx:gift_cards': GiftCards;
44
47
  /** List of custom attributes of this store. */
45
48
  'fx:attributes': Attributes;
46
49
  /** List of transactions performed in this store. */
@@ -167,8 +170,8 @@ export interface Store extends Graph {
167
170
  /** The date of the first payment for this FoxyCart store subscription. This can be considered the go live date for this store. */
168
171
  first_payment_date: string;
169
172
  /** The date this resource was created. */
170
- date_created: string;
173
+ date_created: string | null;
171
174
  /** The date this resource was last modified. */
172
- date_modified: string;
175
+ date_modified: string | null;
173
176
  };
174
177
  }