@getivy/node-sdk 0.1.0-alpha.3 → 0.1.0-alpha.30

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 (143) hide show
  1. package/CHANGELOG.md +310 -0
  2. package/README.md +2 -2
  3. package/_shims/index.d.ts +2 -0
  4. package/_shims/index.js +5 -1
  5. package/_shims/index.mjs +5 -1
  6. package/core.d.ts +12 -1
  7. package/core.d.ts.map +1 -1
  8. package/core.js +20 -11
  9. package/core.js.map +1 -1
  10. package/core.mjs +21 -12
  11. package/core.mjs.map +1 -1
  12. package/index.d.mts +8 -2
  13. package/index.d.ts +8 -2
  14. package/index.d.ts.map +1 -1
  15. package/index.js +6 -0
  16. package/index.js.map +1 -1
  17. package/index.mjs +6 -0
  18. package/index.mjs.map +1 -1
  19. package/package.json +1 -1
  20. package/resources/balance.d.ts +2 -2
  21. package/resources/balance.d.ts.map +1 -1
  22. package/resources/banks.d.ts +53 -5
  23. package/resources/banks.d.ts.map +1 -1
  24. package/resources/charges.d.ts +1 -14
  25. package/resources/charges.d.ts.map +1 -1
  26. package/resources/checkoutsession.d.ts +451 -1312
  27. package/resources/checkoutsession.d.ts.map +1 -1
  28. package/resources/customers.d.ts +56 -6
  29. package/resources/customers.d.ts.map +1 -1
  30. package/resources/customers.js +3 -2
  31. package/resources/customers.js.map +1 -1
  32. package/resources/customers.mjs +3 -2
  33. package/resources/customers.mjs.map +1 -1
  34. package/resources/data/accounts.d.ts +104 -0
  35. package/resources/data/accounts.d.ts.map +1 -0
  36. package/resources/data/accounts.js +15 -0
  37. package/resources/data/accounts.js.map +1 -0
  38. package/resources/data/accounts.mjs +11 -0
  39. package/resources/data/accounts.mjs.map +1 -0
  40. package/resources/data/balances.d.ts +45 -0
  41. package/resources/data/balances.d.ts.map +1 -0
  42. package/resources/data/balances.js +15 -0
  43. package/resources/data/balances.js.map +1 -0
  44. package/resources/data/balances.mjs +11 -0
  45. package/resources/data/balances.mjs.map +1 -0
  46. package/resources/data/consent.d.ts +80 -0
  47. package/resources/data/consent.d.ts.map +1 -0
  48. package/resources/data/consent.js +21 -0
  49. package/resources/data/consent.js.map +1 -0
  50. package/resources/data/consent.mjs +17 -0
  51. package/resources/data/consent.mjs.map +1 -0
  52. package/resources/data/data.d.ts +26 -0
  53. package/resources/data/data.d.ts.map +1 -0
  54. package/resources/data/data.js +55 -0
  55. package/resources/data/data.js.map +1 -0
  56. package/resources/data/data.mjs +28 -0
  57. package/resources/data/data.mjs.map +1 -0
  58. package/resources/data/index.d.ts +7 -0
  59. package/resources/data/index.d.ts.map +1 -0
  60. package/resources/data/index.js +17 -0
  61. package/resources/data/index.js.map +1 -0
  62. package/resources/data/index.mjs +8 -0
  63. package/resources/data/index.mjs.map +1 -0
  64. package/resources/data/session.d.ts +233 -0
  65. package/resources/data/session.d.ts.map +1 -0
  66. package/resources/data/session.js +21 -0
  67. package/resources/data/session.js.map +1 -0
  68. package/resources/data/session.mjs +17 -0
  69. package/resources/data/session.mjs.map +1 -0
  70. package/resources/data/transactions.d.ts +54 -0
  71. package/resources/data/transactions.d.ts.map +1 -0
  72. package/resources/data/transactions.js +16 -0
  73. package/resources/data/transactions.js.map +1 -0
  74. package/resources/data/transactions.mjs +12 -0
  75. package/resources/data/transactions.mjs.map +1 -0
  76. package/resources/data.d.ts +2 -0
  77. package/resources/data.d.ts.map +1 -0
  78. package/resources/data.js +19 -0
  79. package/resources/data.js.map +1 -0
  80. package/resources/data.mjs +3 -0
  81. package/resources/data.mjs.map +1 -0
  82. package/resources/index.d.ts +3 -1
  83. package/resources/index.d.ts.map +1 -1
  84. package/resources/index.js +5 -1
  85. package/resources/index.js.map +1 -1
  86. package/resources/index.mjs +2 -0
  87. package/resources/index.mjs.map +1 -1
  88. package/resources/orders.d.ts +251 -105
  89. package/resources/orders.d.ts.map +1 -1
  90. package/resources/orders.js +10 -6
  91. package/resources/orders.js.map +1 -1
  92. package/resources/orders.mjs +10 -6
  93. package/resources/orders.mjs.map +1 -1
  94. package/resources/payouts.d.ts +2 -2
  95. package/resources/payouts.d.ts.map +1 -1
  96. package/resources/refunds.d.ts +1 -1
  97. package/resources/refunds.d.ts.map +1 -1
  98. package/resources/reports.d.ts +2 -2
  99. package/resources/reports.d.ts.map +1 -1
  100. package/resources/webhooksubscription.d.ts +155 -0
  101. package/resources/webhooksubscription.d.ts.map +1 -0
  102. package/resources/webhooksubscription.js +42 -0
  103. package/resources/webhooksubscription.js.map +1 -0
  104. package/resources/webhooksubscription.mjs +38 -0
  105. package/resources/webhooksubscription.mjs.map +1 -0
  106. package/resources.d.ts +2 -0
  107. package/resources.d.ts.map +1 -0
  108. package/resources.js +18 -0
  109. package/resources.js.map +1 -0
  110. package/resources.mjs +2 -0
  111. package/resources.mjs.map +1 -0
  112. package/src/_shims/index.d.ts +2 -0
  113. package/src/_shims/index.js +5 -1
  114. package/src/_shims/index.mjs +5 -1
  115. package/src/core.ts +39 -12
  116. package/src/index.ts +38 -4
  117. package/src/resources/balance.ts +2 -2
  118. package/src/resources/banks.ts +92 -5
  119. package/src/resources/charges.ts +1 -14
  120. package/src/resources/checkoutsession.ts +2100 -4413
  121. package/src/resources/customers.ts +61 -6
  122. package/src/resources/data/accounts.ts +134 -0
  123. package/src/resources/data/balances.ts +57 -0
  124. package/src/resources/data/consent.ts +110 -0
  125. package/src/resources/data/data.ts +75 -0
  126. package/src/resources/data/index.ts +20 -0
  127. package/src/resources/data/session.ts +1298 -0
  128. package/src/resources/data/transactions.ts +71 -0
  129. package/src/resources/data.ts +3 -0
  130. package/src/resources/index.ts +16 -2
  131. package/src/resources/orders.ts +296 -122
  132. package/src/resources/payouts.ts +2 -2
  133. package/src/resources/refunds.ts +0 -1
  134. package/src/resources/reports.ts +2 -2
  135. package/src/resources/webhooksubscription.ts +353 -0
  136. package/src/resources.ts +1 -0
  137. package/src/version.ts +1 -1
  138. package/version.d.ts +1 -1
  139. package/version.d.ts.map +1 -1
  140. package/version.js +1 -1
  141. package/version.js.map +1 -1
  142. package/version.mjs +1 -1
  143. package/version.mjs.map +1 -1
@@ -5,14 +5,15 @@ import * as Core from '../core';
5
5
 
6
6
  export class Customers extends APIResource {
7
7
  /**
8
- * This endpoint allows merchants to create a new customer with email
8
+ * Create a new Customer representing your Customers. You can use the Customer to
9
+ * simplify the checkout process for returning journeys.
9
10
  */
10
11
  create(body: CustomerCreateParams, options?: Core.RequestOptions): Core.APIPromise<CustomerCreateResponse> {
11
12
  return this._client.post('/api/service/customer/create', { body, ...options });
12
13
  }
13
14
 
14
15
  /**
15
- * This endpoint allows merchants to retrieve the customer info by id
16
+ * Retrieve a Customer Object by its id.
16
17
  */
17
18
  retrieve(
18
19
  body: CustomerRetrieveParams,
@@ -26,27 +27,81 @@ export class Customers extends APIResource {
26
27
  * Returns the id and email of the created customer
27
28
  */
28
29
  export interface CustomerCreateResponse {
30
+ /**
31
+ * The id of the created customer
32
+ */
29
33
  id: string;
30
34
 
35
+ /**
36
+ * The email address of the created customer
37
+ */
31
38
  email: string;
32
39
  }
33
40
 
34
- /**
35
- * Returns the id, email and the merchantId of the customer
36
- */
37
41
  export interface CustomerRetrieveResponse {
42
+ /**
43
+ * Customer id
44
+ */
38
45
  id: string;
39
46
 
47
+ /**
48
+ * List of remembered bank accounts for this Customer
49
+ */
50
+ bankAccounts: Array<CustomerRetrieveResponse.BankAccount>;
51
+
52
+ /**
53
+ * Customer email address
54
+ */
40
55
  emailAddress: string;
56
+ }
57
+
58
+ export namespace CustomerRetrieveResponse {
59
+ export interface BankAccount {
60
+ /**
61
+ * Bank details
62
+ */
63
+ bank: BankAccount.Bank;
64
+
65
+ /**
66
+ * Last 4 digits of remembered account number
67
+ */
68
+ last4digits?: string;
69
+ }
70
+
71
+ export namespace BankAccount {
72
+ /**
73
+ * Bank details
74
+ */
75
+ export interface Bank {
76
+ /**
77
+ * Ivy bank id used to initiate checkout session with preselected bank
78
+ */
79
+ id: string;
41
80
 
42
- merchantId: string;
81
+ /**
82
+ * The customer-facing name of the Bank.
83
+ */
84
+ name: string;
85
+
86
+ /**
87
+ * The Bank Logo as a URL
88
+ */
89
+ logo?: string;
90
+ }
91
+ }
43
92
  }
44
93
 
45
94
  export interface CustomerCreateParams {
95
+ /**
96
+ * The email address of the customer
97
+ */
46
98
  email: string;
47
99
  }
48
100
 
49
101
  export interface CustomerRetrieveParams {
102
+ /**
103
+ * The id of the customer
104
+ */
50
105
  id: string;
51
106
  }
52
107
 
@@ -0,0 +1,134 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ import { APIResource } from '../../resource';
4
+ import * as Core from '../../core';
5
+
6
+ export class Accounts extends APIResource {
7
+ /**
8
+ * Retrieves the list of accounts for a given data session.
9
+ */
10
+ list(body: AccountListParams, options?: Core.RequestOptions): Core.APIPromise<AccountListResponse> {
11
+ return this._client.post('/api/service/data/accounts/list', { body, ...options });
12
+ }
13
+ }
14
+
15
+ export interface AccountListResponse {
16
+ accounts: Array<AccountListResponse.Account>;
17
+ }
18
+
19
+ export namespace AccountListResponse {
20
+ export interface Account {
21
+ /**
22
+ * The ID of the account.
23
+ */
24
+ id: string;
25
+
26
+ /**
27
+ * The ID of the bank.
28
+ */
29
+ bankId: string;
30
+
31
+ /**
32
+ * The name of the bank.
33
+ */
34
+ bankName: string;
35
+
36
+ /**
37
+ * The currency of the account.
38
+ */
39
+ currency: string;
40
+
41
+ financialAddress: Array<Account.FinancialAddress>;
42
+
43
+ /**
44
+ * The name of the account.
45
+ */
46
+ accountName?: string;
47
+ }
48
+
49
+ export namespace Account {
50
+ /**
51
+ * The validation logic is based on the "type" field. For example, if "type" is set
52
+ * to "iban", the "iban" object must be filled out.
53
+ */
54
+ export interface FinancialAddress {
55
+ /**
56
+ * The type of the financial address. The actual destination is determined by this
57
+ * field which can be either "iban", "sortCode", "bankCode", or "bban". The
58
+ * validation will fail if you set e.g. type="iban", but then not fill any values
59
+ * in the "iban" object.
60
+ *
61
+ * - iban: The IBAN of the account
62
+ * - sort_code: The sort code of the account
63
+ * - bank_code: The bank code of the account
64
+ * - bban: The BBAN of the account
65
+ */
66
+ type: string;
67
+
68
+ bankCode?: FinancialAddress.BankCode;
69
+
70
+ bban?: FinancialAddress.Bban;
71
+
72
+ iban?: FinancialAddress.Iban;
73
+
74
+ sortCode?: FinancialAddress.SortCode;
75
+ }
76
+
77
+ export namespace FinancialAddress {
78
+ export interface BankCode {
79
+ accountNumber: string;
80
+
81
+ code: string;
82
+
83
+ /**
84
+ * The name of the account holder.
85
+ */
86
+ accountHolderName?: string;
87
+ }
88
+
89
+ export interface Bban {
90
+ bban: string;
91
+
92
+ /**
93
+ * The name of the account holder.
94
+ */
95
+ accountHolderName?: string;
96
+
97
+ bic?: string;
98
+ }
99
+
100
+ export interface Iban {
101
+ iban: string;
102
+
103
+ /**
104
+ * The name of the account holder.
105
+ */
106
+ accountHolderName?: string;
107
+
108
+ bic?: string;
109
+ }
110
+
111
+ export interface SortCode {
112
+ accountNumber: string;
113
+
114
+ sortCode: string;
115
+
116
+ /**
117
+ * The name of the account holder.
118
+ */
119
+ accountHolderName?: string;
120
+ }
121
+ }
122
+ }
123
+ }
124
+
125
+ export interface AccountListParams {
126
+ /**
127
+ * The ID of the data session to retrieve accounts for.
128
+ */
129
+ sessionId: string;
130
+ }
131
+
132
+ export declare namespace Accounts {
133
+ export { type AccountListResponse as AccountListResponse, type AccountListParams as AccountListParams };
134
+ }
@@ -0,0 +1,57 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ import { APIResource } from '../../resource';
4
+ import * as Core from '../../core';
5
+
6
+ export class Balances extends APIResource {
7
+ /**
8
+ * Retrieves the list of account balances for a given data session.
9
+ */
10
+ list(body: BalanceListParams, options?: Core.RequestOptions): Core.APIPromise<BalanceListResponse> {
11
+ return this._client.post('/api/service/data/account-balances/list', { body, ...options });
12
+ }
13
+ }
14
+
15
+ export interface BalanceListResponse {
16
+ balances: Array<BalanceListResponse.Balance>;
17
+ }
18
+
19
+ export namespace BalanceListResponse {
20
+ export interface Balance {
21
+ /**
22
+ * The ID of the account.
23
+ */
24
+ accountId: string;
25
+
26
+ /**
27
+ * The available balance.
28
+ */
29
+ available: string;
30
+
31
+ /**
32
+ * The currency of the balance.
33
+ */
34
+ currency: string;
35
+
36
+ /**
37
+ * The current balance.
38
+ */
39
+ current: string;
40
+
41
+ /**
42
+ * The date and time when the balance was last updated.
43
+ */
44
+ timestamp: string;
45
+ }
46
+ }
47
+
48
+ export interface BalanceListParams {
49
+ /**
50
+ * The ID of the data session to retrieve account balances for.
51
+ */
52
+ sessionId: string;
53
+ }
54
+
55
+ export declare namespace Balances {
56
+ export { type BalanceListResponse as BalanceListResponse, type BalanceListParams as BalanceListParams };
57
+ }
@@ -0,0 +1,110 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ import { APIResource } from '../../resource';
4
+ import * as Core from '../../core';
5
+
6
+ export class Consent extends APIResource {
7
+ /**
8
+ * Retrieves the details of a consent by session ID.
9
+ */
10
+ retrieve(
11
+ body: ConsentRetrieveParams,
12
+ options?: Core.RequestOptions,
13
+ ): Core.APIPromise<ConsentRetrieveResponse> {
14
+ return this._client.post('/api/service/data/consent/details', { body, ...options });
15
+ }
16
+
17
+ /**
18
+ * Revokes a consent by session ID.
19
+ */
20
+ revoke(body: ConsentRevokeParams, options?: Core.RequestOptions): Core.APIPromise<ConsentRevokeResponse> {
21
+ return this._client.post('/api/service/data/consent/revoke', { body, ...options });
22
+ }
23
+ }
24
+
25
+ export interface ConsentRetrieveResponse {
26
+ /**
27
+ * The Epoch time in seconds when the consent was created.
28
+ */
29
+ createdAt: number;
30
+
31
+ /**
32
+ * The permissions granted in this consent.
33
+ */
34
+ permissions: Array<'accounts' | 'balances' | 'transactions'>;
35
+
36
+ /**
37
+ * The current status of the consent.
38
+ */
39
+ status: 'created' | 'authorised' | 'revoked' | 'expired' | 'failed';
40
+
41
+ /**
42
+ * The Epoch time in seconds when the consent was last updated.
43
+ */
44
+ updatedAt: number;
45
+
46
+ /**
47
+ * The Epoch time in seconds at which the consent expires.
48
+ */
49
+ expiresAt?: number;
50
+
51
+ /**
52
+ * The Epoch time in seconds at which the consent was revoked.
53
+ */
54
+ revokedAt?: number;
55
+ }
56
+
57
+ export interface ConsentRevokeResponse {
58
+ /**
59
+ * The Epoch time in seconds when the consent was created.
60
+ */
61
+ createdAt: number;
62
+
63
+ /**
64
+ * The permissions granted in this consent.
65
+ */
66
+ permissions: Array<'accounts' | 'balances' | 'transactions'>;
67
+
68
+ /**
69
+ * The Epoch time in seconds at which the consent was revoked.
70
+ */
71
+ revokedAt: number;
72
+
73
+ /**
74
+ * The current status of the consent.
75
+ */
76
+ status: 'revoked';
77
+
78
+ /**
79
+ * The Epoch time in seconds when the consent was last updated.
80
+ */
81
+ updatedAt: number;
82
+
83
+ /**
84
+ * The Epoch time in seconds at which the consent expires.
85
+ */
86
+ expiresAt?: number;
87
+ }
88
+
89
+ export interface ConsentRetrieveParams {
90
+ /**
91
+ * The ID of the data session to which the consent belongs.
92
+ */
93
+ sessionId: string;
94
+ }
95
+
96
+ export interface ConsentRevokeParams {
97
+ /**
98
+ * The ID of the data session to which the consent belongs.
99
+ */
100
+ sessionId: string;
101
+ }
102
+
103
+ export declare namespace Consent {
104
+ export {
105
+ type ConsentRetrieveResponse as ConsentRetrieveResponse,
106
+ type ConsentRevokeResponse as ConsentRevokeResponse,
107
+ type ConsentRetrieveParams as ConsentRetrieveParams,
108
+ type ConsentRevokeParams as ConsentRevokeParams,
109
+ };
110
+ }
@@ -0,0 +1,75 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ import { APIResource } from '../../resource';
4
+ import * as AccountsAPI from './accounts';
5
+ import { AccountListParams, AccountListResponse, Accounts } from './accounts';
6
+ import * as BalancesAPI from './balances';
7
+ import { BalanceListParams, BalanceListResponse, Balances } from './balances';
8
+ import * as ConsentAPI from './consent';
9
+ import {
10
+ Consent,
11
+ ConsentRetrieveParams,
12
+ ConsentRetrieveResponse,
13
+ ConsentRevokeParams,
14
+ ConsentRevokeResponse,
15
+ } from './consent';
16
+ import * as SessionAPI from './session';
17
+ import {
18
+ Session,
19
+ SessionCreateParams,
20
+ SessionCreateResponse,
21
+ SessionRetrieveParams,
22
+ SessionRetrieveResponse,
23
+ } from './session';
24
+ import * as TransactionsAPI from './transactions';
25
+ import { TransactionListParams, TransactionListResponse, Transactions } from './transactions';
26
+
27
+ export class Data extends APIResource {
28
+ session: SessionAPI.Session = new SessionAPI.Session(this._client);
29
+ consent: ConsentAPI.Consent = new ConsentAPI.Consent(this._client);
30
+ accounts: AccountsAPI.Accounts = new AccountsAPI.Accounts(this._client);
31
+ transactions: TransactionsAPI.Transactions = new TransactionsAPI.Transactions(this._client);
32
+ balances: BalancesAPI.Balances = new BalancesAPI.Balances(this._client);
33
+ }
34
+
35
+ Data.Session = Session;
36
+ Data.Consent = Consent;
37
+ Data.Accounts = Accounts;
38
+ Data.Transactions = Transactions;
39
+ Data.Balances = Balances;
40
+
41
+ export declare namespace Data {
42
+ export {
43
+ Session as Session,
44
+ type SessionCreateResponse as SessionCreateResponse,
45
+ type SessionRetrieveResponse as SessionRetrieveResponse,
46
+ type SessionCreateParams as SessionCreateParams,
47
+ type SessionRetrieveParams as SessionRetrieveParams,
48
+ };
49
+
50
+ export {
51
+ Consent as Consent,
52
+ type ConsentRetrieveResponse as ConsentRetrieveResponse,
53
+ type ConsentRevokeResponse as ConsentRevokeResponse,
54
+ type ConsentRetrieveParams as ConsentRetrieveParams,
55
+ type ConsentRevokeParams as ConsentRevokeParams,
56
+ };
57
+
58
+ export {
59
+ Accounts as Accounts,
60
+ type AccountListResponse as AccountListResponse,
61
+ type AccountListParams as AccountListParams,
62
+ };
63
+
64
+ export {
65
+ Transactions as Transactions,
66
+ type TransactionListResponse as TransactionListResponse,
67
+ type TransactionListParams as TransactionListParams,
68
+ };
69
+
70
+ export {
71
+ Balances as Balances,
72
+ type BalanceListResponse as BalanceListResponse,
73
+ type BalanceListParams as BalanceListParams,
74
+ };
75
+ }
@@ -0,0 +1,20 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ export { Accounts, type AccountListResponse, type AccountListParams } from './accounts';
4
+ export { Balances, type BalanceListResponse, type BalanceListParams } from './balances';
5
+ export {
6
+ Consent,
7
+ type ConsentRetrieveResponse,
8
+ type ConsentRevokeResponse,
9
+ type ConsentRetrieveParams,
10
+ type ConsentRevokeParams,
11
+ } from './consent';
12
+ export { Data } from './data';
13
+ export {
14
+ Session,
15
+ type SessionCreateResponse,
16
+ type SessionRetrieveResponse,
17
+ type SessionCreateParams,
18
+ type SessionRetrieveParams,
19
+ } from './session';
20
+ export { Transactions, type TransactionListResponse, type TransactionListParams } from './transactions';