@dynamic-labs/sdk-api 0.0.956 → 0.0.958

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dynamic-labs/sdk-api",
3
- "version": "0.0.956",
3
+ "version": "0.0.958",
4
4
  "author": "Dynamic Labs",
5
5
  "license": "Apache-2.0",
6
6
  "publishConfig": {
@@ -122,7 +122,7 @@ require('../models/WalletTransactionType.cjs');
122
122
  /**
123
123
  *
124
124
  */
125
- class DepositApi extends runtime.BaseAPI {
125
+ class CheckoutApi extends runtime.BaseAPI {
126
126
  /**
127
127
  * Creates a new checkout config for the specified environment.
128
128
  * Create a checkout
@@ -244,4 +244,4 @@ class DepositApi extends runtime.BaseAPI {
244
244
  }
245
245
  }
246
246
 
247
- exports.DepositApi = DepositApi;
247
+ exports.CheckoutApi = CheckoutApi;
@@ -31,7 +31,7 @@ export interface UpdateCheckoutRequest {
31
31
  /**
32
32
  *
33
33
  */
34
- export declare class DepositApi extends runtime.BaseAPI {
34
+ export declare class CheckoutApi extends runtime.BaseAPI {
35
35
  /**
36
36
  * Creates a new checkout config for the specified environment.
37
37
  * Create a checkout
@@ -118,7 +118,7 @@ import '../models/WalletTransactionType.js';
118
118
  /**
119
119
  *
120
120
  */
121
- class DepositApi extends BaseAPI {
121
+ class CheckoutApi extends BaseAPI {
122
122
  /**
123
123
  * Creates a new checkout config for the specified environment.
124
124
  * Create a checkout
@@ -240,4 +240,4 @@ class DepositApi extends BaseAPI {
240
240
  }
241
241
  }
242
242
 
243
- export { DepositApi };
243
+ export { CheckoutApi };
@@ -156,7 +156,7 @@ class OrganizationSettingsApi extends runtime.BaseAPI {
156
156
  return await response.value();
157
157
  }
158
158
  /**
159
- * Updates settings for the specified organization. Creates the settings row if it does not exist.
159
+ * Updates settings for the specified organization. Creates the settings row if it does not exist. When approvalRequiredApprovals is above the current (owners + admins) - 1 cap, responds with 400 APPROVAL_THRESHOLD_TOO_HIGH so a request could not otherwise reach quorum.
160
160
  * Update organization settings
161
161
  */
162
162
  async updateOrganizationSettingsRaw(requestParameters, initOverrides) {
@@ -186,7 +186,7 @@ class OrganizationSettingsApi extends runtime.BaseAPI {
186
186
  return new runtime.JSONApiResponse(response, (jsonValue) => OrganizationSettingsResponse.OrganizationSettingsResponseFromJSON(jsonValue));
187
187
  }
188
188
  /**
189
- * Updates settings for the specified organization. Creates the settings row if it does not exist.
189
+ * Updates settings for the specified organization. Creates the settings row if it does not exist. When approvalRequiredApprovals is above the current (owners + admins) - 1 cap, responds with 400 APPROVAL_THRESHOLD_TOO_HIGH so a request could not otherwise reach quorum.
190
190
  * Update organization settings
191
191
  */
192
192
  async updateOrganizationSettings(requestParameters, initOverrides) {
@@ -33,12 +33,12 @@ export declare class OrganizationSettingsApi extends runtime.BaseAPI {
33
33
  */
34
34
  getOrganizationSettings(requestParameters: GetOrganizationSettingsRequest, initOverrides?: RequestInit): Promise<OrganizationSettingsResponse>;
35
35
  /**
36
- * Updates settings for the specified organization. Creates the settings row if it does not exist.
36
+ * Updates settings for the specified organization. Creates the settings row if it does not exist. When approvalRequiredApprovals is above the current (owners + admins) - 1 cap, responds with 400 APPROVAL_THRESHOLD_TOO_HIGH so a request could not otherwise reach quorum.
37
37
  * Update organization settings
38
38
  */
39
39
  updateOrganizationSettingsRaw(requestParameters: UpdateOrganizationSettingsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<OrganizationSettingsResponse>>;
40
40
  /**
41
- * Updates settings for the specified organization. Creates the settings row if it does not exist.
41
+ * Updates settings for the specified organization. Creates the settings row if it does not exist. When approvalRequiredApprovals is above the current (owners + admins) - 1 cap, responds with 400 APPROVAL_THRESHOLD_TOO_HIGH so a request could not otherwise reach quorum.
42
42
  * Update organization settings
43
43
  */
44
44
  updateOrganizationSettings(requestParameters: UpdateOrganizationSettingsRequest, initOverrides?: RequestInit): Promise<OrganizationSettingsResponse>;
@@ -152,7 +152,7 @@ class OrganizationSettingsApi extends BaseAPI {
152
152
  return await response.value();
153
153
  }
154
154
  /**
155
- * Updates settings for the specified organization. Creates the settings row if it does not exist.
155
+ * Updates settings for the specified organization. Creates the settings row if it does not exist. When approvalRequiredApprovals is above the current (owners + admins) - 1 cap, responds with 400 APPROVAL_THRESHOLD_TOO_HIGH so a request could not otherwise reach quorum.
156
156
  * Update organization settings
157
157
  */
158
158
  async updateOrganizationSettingsRaw(requestParameters, initOverrides) {
@@ -182,7 +182,7 @@ class OrganizationSettingsApi extends BaseAPI {
182
182
  return new JSONApiResponse(response, (jsonValue) => OrganizationSettingsResponseFromJSON(jsonValue));
183
183
  }
184
184
  /**
185
- * Updates settings for the specified organization. Creates the settings row if it does not exist.
185
+ * Updates settings for the specified organization. Creates the settings row if it does not exist. When approvalRequiredApprovals is above the current (owners + admins) - 1 cap, responds with 400 APPROVAL_THRESHOLD_TOO_HIGH so a request could not otherwise reach quorum.
186
186
  * Update organization settings
187
187
  */
188
188
  async updateOrganizationSettings(requestParameters, initOverrides) {
@@ -3,11 +3,11 @@ export * from './AllowlistsApi';
3
3
  export * from './AnalyticsApi';
4
4
  export * from './ChainalysisApi';
5
5
  export * from './ChainsApi';
6
+ export * from './CheckoutApi';
6
7
  export * from './CustomFieldsApi';
7
8
  export * from './CustomHostnamesApi';
8
9
  export * from './CustomNetworksApi';
9
10
  export * from './DeeplinkUrlsApi';
10
- export * from './DepositApi';
11
11
  export * from './EnvironmentsApi';
12
12
  export * from './EventsApi';
13
13
  export * from './ExchangesApi';
package/src/index.cjs CHANGED
@@ -8,11 +8,11 @@ var AllowlistsApi = require('./apis/AllowlistsApi.cjs');
8
8
  var AnalyticsApi = require('./apis/AnalyticsApi.cjs');
9
9
  var ChainalysisApi = require('./apis/ChainalysisApi.cjs');
10
10
  var ChainsApi = require('./apis/ChainsApi.cjs');
11
+ var CheckoutApi = require('./apis/CheckoutApi.cjs');
11
12
  var CustomFieldsApi = require('./apis/CustomFieldsApi.cjs');
12
13
  var CustomHostnamesApi = require('./apis/CustomHostnamesApi.cjs');
13
14
  var CustomNetworksApi = require('./apis/CustomNetworksApi.cjs');
14
15
  var DeeplinkUrlsApi = require('./apis/DeeplinkUrlsApi.cjs');
15
- var DepositApi = require('./apis/DepositApi.cjs');
16
16
  var EnvironmentsApi = require('./apis/EnvironmentsApi.cjs');
17
17
  var EventsApi = require('./apis/EventsApi.cjs');
18
18
  var ExchangesApi = require('./apis/ExchangesApi.cjs');
@@ -748,11 +748,11 @@ Object.defineProperty(exports, 'GetAnalyticsOverviewGranularityEnum', {
748
748
  });
749
749
  exports.ChainalysisApi = ChainalysisApi.ChainalysisApi;
750
750
  exports.ChainsApi = ChainsApi.ChainsApi;
751
+ exports.CheckoutApi = CheckoutApi.CheckoutApi;
751
752
  exports.CustomFieldsApi = CustomFieldsApi.CustomFieldsApi;
752
753
  exports.CustomHostnamesApi = CustomHostnamesApi.CustomHostnamesApi;
753
754
  exports.CustomNetworksApi = CustomNetworksApi.CustomNetworksApi;
754
755
  exports.DeeplinkUrlsApi = DeeplinkUrlsApi.DeeplinkUrlsApi;
755
- exports.DepositApi = DepositApi.DepositApi;
756
756
  exports.EnvironmentsApi = EnvironmentsApi.EnvironmentsApi;
757
757
  exports.EventsApi = EventsApi.EventsApi;
758
758
  exports.ExchangesApi = ExchangesApi.ExchangesApi;
package/src/index.js CHANGED
@@ -4,11 +4,11 @@ export { AllowlistsApi } from './apis/AllowlistsApi.js';
4
4
  export { AnalyticsApi, GetAnalyticsOverviewGranularityEnum } from './apis/AnalyticsApi.js';
5
5
  export { ChainalysisApi } from './apis/ChainalysisApi.js';
6
6
  export { ChainsApi } from './apis/ChainsApi.js';
7
+ export { CheckoutApi } from './apis/CheckoutApi.js';
7
8
  export { CustomFieldsApi } from './apis/CustomFieldsApi.js';
8
9
  export { CustomHostnamesApi } from './apis/CustomHostnamesApi.js';
9
10
  export { CustomNetworksApi } from './apis/CustomNetworksApi.js';
10
11
  export { DeeplinkUrlsApi } from './apis/DeeplinkUrlsApi.js';
11
- export { DepositApi } from './apis/DepositApi.js';
12
12
  export { EnvironmentsApi } from './apis/EnvironmentsApi.js';
13
13
  export { EventsApi } from './apis/EventsApi.js';
14
14
  export { ExchangesApi } from './apis/ExchangesApi.js';
@@ -50,7 +50,7 @@ export interface AdminActionRequest {
50
50
  */
51
51
  submittedBy?: AdminActionRequestUser;
52
52
  /**
53
- * Review responses from admins. Each approve or deny creates a separate response row, enabling future quorum support.
53
+ * Review responses from admins, one row per reviewer per request. Under quorum, multiple approve responses may accumulate before the request reaches requiredApprovals and transitions to approved.
54
54
  * @type {Array<AdminActionResponseItem>}
55
55
  * @memberof AdminActionRequest
56
56
  */
@@ -104,13 +104,13 @@ export interface AdminActionRequest {
104
104
  */
105
105
  actionPayload: object;
106
106
  /**
107
- * Number of approvals needed to execute. Always 1 in v1, reserved for future quorum.
107
+ * Number of distinct admin approvals needed to execute this request, snapshotted from the organization settings at creation time. Subsequent changes to the org setting do not affect in-flight requests.
108
108
  * @type {number}
109
109
  * @memberof AdminActionRequest
110
110
  */
111
111
  requiredApprovals: number;
112
112
  /**
113
- * Number of approvals received so far.
113
+ * Number of approvals received so far. The request transitions to approved when this reaches requiredApprovals. A single deny at any point transitions the request to denied regardless of this counter.
114
114
  * @type {number}
115
115
  * @memberof AdminActionRequest
116
116
  */
@@ -50,7 +50,7 @@ export interface CheckoutTransaction {
50
50
  */
51
51
  userId?: string;
52
52
  /**
53
- * Deposit amount in the specified currency
53
+ * Payment/Deposit amount in the specified currency
54
54
  * @type {string}
55
55
  * @memberof CheckoutTransaction
56
56
  */
@@ -17,7 +17,7 @@ import { CheckoutTransactionDestinationAddress } from './CheckoutTransactionDest
17
17
  */
18
18
  export interface CheckoutTransactionCreateRequest {
19
19
  /**
20
- * Deposit amount in the specified currency
20
+ * Payment/Deposit amount in the specified currency
21
21
  * @type {string}
22
22
  * @memberof CheckoutTransactionCreateRequest
23
23
  */
@@ -40,7 +40,7 @@ export interface OrganizationSettings {
40
40
  */
41
41
  approvalTtlHours: number;
42
42
  /**
43
- * Number of approvals required before an action is executed. Default 1 (v1). Reserved for future quorum support.
43
+ * Number of distinct admins (not counting the submitter) that must approve before an action is executed. Default 1. The upper bound enforced on update is the current owner + admin count minus 1.
44
44
  * @type {number}
45
45
  * @memberof OrganizationSettings
46
46
  */
@@ -28,7 +28,7 @@ export interface OrganizationSettingsUpdateRequest {
28
28
  */
29
29
  approvalTtlHours?: number;
30
30
  /**
31
- * Number of approvals required (minimum 1).
31
+ * Number of distinct admins (not counting the submitter) required to approve before an action is executed. Minimum 1, maximum (owners + admins in the organization) - 1. Requests rejected with 400 APPROVAL_THRESHOLD_TOO_HIGH when above the cap.
32
32
  * @type {number}
33
33
  * @memberof OrganizationSettingsUpdateRequest
34
34
  */