@brokerize/client 1.2.3 → 1.2.5

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 (28) hide show
  1. package/dist/client.d.ts +125 -0
  2. package/dist/swagger/models/CancelOrderChallengeResponse.d.ts +7 -0
  3. package/dist/swagger/models/CancelOrderChallengeResponse.js +4 -0
  4. package/dist/swagger/models/CancelOrderChallengeResponseSpecifics.d.ts +7 -0
  5. package/dist/swagger/models/CancelOrderChallengeResponseSpecifics.js +4 -0
  6. package/dist/swagger/models/CancelOrderDecoupled.d.ts +7 -0
  7. package/dist/swagger/models/CancelOrderDecoupled.js +4 -0
  8. package/dist/swagger/models/CancelOrderDecoupledSpecifics.d.ts +7 -0
  9. package/dist/swagger/models/CancelOrderDecoupledSpecifics.js +4 -0
  10. package/dist/swagger/models/ChangeOrderParams.d.ts +7 -0
  11. package/dist/swagger/models/ChangeOrderParams.js +4 -0
  12. package/dist/swagger/models/ClientConfig.d.ts +6 -0
  13. package/dist/swagger/models/ClientConfig.js +4 -0
  14. package/dist/swagger/models/ClientConfigUpdate.d.ts +6 -0
  15. package/dist/swagger/models/ClientConfigUpdate.js +4 -0
  16. package/dist/swagger/models/ConfirmOAuthParams.d.ts +6 -0
  17. package/dist/swagger/models/ConfirmOAuthParams.js +5 -0
  18. package/dist/swagger/models/CreateModeSessionTan.d.ts +7 -0
  19. package/dist/swagger/models/CreateModeSessionTan.js +5 -0
  20. package/dist/swagger/models/CreateModeSessionTanSpecifics.d.ts +28 -0
  21. package/dist/swagger/models/CreateModeSessionTanSpecifics.js +40 -0
  22. package/dist/swagger/models/CreateOrderParams.d.ts +7 -0
  23. package/dist/swagger/models/CreateOrderParams.js +4 -0
  24. package/dist/swagger/models/TradeStatistics.d.ts +20 -0
  25. package/dist/swagger/models/TradeStatistics.js +8 -0
  26. package/dist/swagger/models/index.d.ts +1 -0
  27. package/dist/swagger/models/index.js +1 -0
  28. package/package.json +1 -1
package/dist/client.d.ts CHANGED
@@ -1958,6 +1958,13 @@ declare interface CancelOrderChallengeResponse {
1958
1958
  * @memberof CancelOrderChallengeResponse
1959
1959
  */
1960
1960
  challengeResponse: string;
1961
+ /**
1962
+ * An optional client-defined tag which will appear in order reports. Note that the number of tags is limited per client and
1963
+ * if you use more tags, they will not be recorded.
1964
+ * @type {string}
1965
+ * @memberof CancelOrderChallengeResponse
1966
+ */
1967
+ reportingTag?: string;
1961
1968
  }
1962
1969
 
1963
1970
  /**
@@ -2048,6 +2055,13 @@ declare interface CancelOrderChallengeResponseSpecifics {
2048
2055
  * @memberof CancelOrderChallengeResponseSpecifics
2049
2056
  */
2050
2057
  challengeResponse?: string;
2058
+ /**
2059
+ * An optional client-defined tag which will appear in order reports. Note that the number of tags is limited per client and
2060
+ * if you use more tags, they will not be recorded.
2061
+ * @type {string}
2062
+ * @memberof CancelOrderChallengeResponseSpecifics
2063
+ */
2064
+ reportingTag?: string;
2051
2065
  }
2052
2066
 
2053
2067
  declare function CancelOrderChallengeResponseSpecificsFromJSON(json: any): CancelOrderChallengeResponseSpecifics;
@@ -2090,6 +2104,13 @@ declare interface CancelOrderDecoupled {
2090
2104
  * @memberof CancelOrderDecoupled
2091
2105
  */
2092
2106
  authMethod?: string;
2107
+ /**
2108
+ * An optional client-defined tag which will appear in order reports. Note that the number of tags is limited per client and
2109
+ * if you use more tags, they will not be recorded.
2110
+ * @type {string}
2111
+ * @memberof CancelOrderDecoupled
2112
+ */
2113
+ reportingTag?: string;
2093
2114
  }
2094
2115
 
2095
2116
  /**
@@ -2168,6 +2189,13 @@ declare interface CancelOrderDecoupledSpecifics {
2168
2189
  * @memberof CancelOrderDecoupledSpecifics
2169
2190
  */
2170
2191
  authMethod?: string;
2192
+ /**
2193
+ * An optional client-defined tag which will appear in order reports. Note that the number of tags is limited per client and
2194
+ * if you use more tags, they will not be recorded.
2195
+ * @type {string}
2196
+ * @memberof CancelOrderDecoupledSpecifics
2197
+ */
2198
+ reportingTag?: string;
2171
2199
  }
2172
2200
 
2173
2201
  declare function CancelOrderDecoupledSpecificsFromJSON(json: any): CancelOrderDecoupledSpecifics;
@@ -2519,6 +2547,13 @@ declare interface ChangeOrderParams {
2519
2547
  * @memberof ChangeOrderParams
2520
2548
  */
2521
2549
  changes: OrderChanges;
2550
+ /**
2551
+ * An optional client-defined tag which will appear in order reports. Note that the number of tags is limited per client and
2552
+ * if you use more tags, they will not be recorded.
2553
+ * @type {string}
2554
+ * @memberof ChangeOrderParams
2555
+ */
2556
+ reportingTag?: string;
2522
2557
  }
2523
2558
 
2524
2559
  declare function ChangeOrderParamsFromJSON(json: any): ChangeOrderParams;
@@ -2672,6 +2707,12 @@ declare interface ClientConfig {
2672
2707
  * @memberof ClientConfig
2673
2708
  */
2674
2709
  page: any | null;
2710
+ /**
2711
+ * These flags are used in supporting the reporting logic
2712
+ * @type {Array<string>}
2713
+ * @memberof ClientConfig
2714
+ */
2715
+ reportingFlags?: Array<string>;
2675
2716
  }
2676
2717
 
2677
2718
  declare function ClientConfigFromJSON(json: any): ClientConfig;
@@ -2854,6 +2895,12 @@ declare interface ClientConfigUpdate {
2854
2895
  * @memberof ClientConfigUpdate
2855
2896
  */
2856
2897
  rateLimitPointsToConsume?: ClientConfigUpdateRateLimitPointsToConsume;
2898
+ /**
2899
+ * These flags are used in supporting the reporting logic
2900
+ * @type {Array<string>}
2901
+ * @memberof ClientConfigUpdate
2902
+ */
2903
+ reportingFlags?: Array<string>;
2857
2904
  }
2858
2905
 
2859
2906
  declare function ClientConfigUpdateFromJSON(json: any): ClientConfigUpdate;
@@ -3195,6 +3242,12 @@ declare interface ConfirmOAuthParams {
3195
3242
  * @memberof ConfirmOAuthParams
3196
3243
  */
3197
3244
  code: string;
3245
+ /**
3246
+ *
3247
+ * @type {string}
3248
+ * @memberof ConfirmOAuthParams
3249
+ */
3250
+ reportingTag?: string | null;
3198
3251
  /**
3199
3252
  *
3200
3253
  * @type {string}
@@ -3524,6 +3577,13 @@ declare interface CreateModeSessionTan {
3524
3577
  * @memberof CreateModeSessionTan
3525
3578
  */
3526
3579
  mode: CreateModeSessionTanModeEnum;
3580
+ /**
3581
+ * An optional client-defined tag which will appear in order reports. Note that the number of tags is limited per client and
3582
+ * if you use more tags, they will not be recorded.
3583
+ * @type {string}
3584
+ * @memberof CreateModeSessionTan
3585
+ */
3586
+ reportingTag?: string;
3527
3587
  }
3528
3588
 
3529
3589
  /**
@@ -3580,6 +3640,39 @@ declare const CreateModeSessionTanModeEnum: {
3580
3640
 
3581
3641
  declare type CreateModeSessionTanModeEnum = (typeof CreateModeSessionTanModeEnum)[keyof typeof CreateModeSessionTanModeEnum];
3582
3642
 
3643
+ /**
3644
+ * brokerize
3645
+ * The brokerize API allows clients to implement multi-brokerage with a unified interface. For more information, visit brokerize.com
3646
+ *
3647
+ *
3648
+ *
3649
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
3650
+ * https://openapi-generator.tech
3651
+ * Do not edit the class manually.
3652
+ */
3653
+ /**
3654
+ *
3655
+ * @export
3656
+ * @interface CreateModeSessionTanSpecifics
3657
+ */
3658
+ declare interface CreateModeSessionTanSpecifics {
3659
+ /**
3660
+ * An optional client-defined tag which will appear in order reports. Note that the number of tags is limited per client and
3661
+ * if you use more tags, they will not be recorded.
3662
+ * @type {string}
3663
+ * @memberof CreateModeSessionTanSpecifics
3664
+ */
3665
+ reportingTag?: string;
3666
+ }
3667
+
3668
+ declare function CreateModeSessionTanSpecificsFromJSON(json: any): CreateModeSessionTanSpecifics;
3669
+
3670
+ declare function CreateModeSessionTanSpecificsFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateModeSessionTanSpecifics;
3671
+
3672
+ declare function CreateModeSessionTanSpecificsToJSON(value?: CreateModeSessionTanSpecifics | null): any;
3673
+
3674
+ declare function CreateModeSessionTanSpecificsToJSONRecursive(value?: CreateModeSessionTanSpecifics | null, ignoreParent?: boolean): any;
3675
+
3583
3676
  declare function CreateModeSessionTanToJSON(value?: CreateModeSessionTan | null): any;
3584
3677
 
3585
3678
  declare function CreateModeSessionTanToJSONRecursive(value?: CreateModeSessionTan | null, ignoreParent?: boolean): any;
@@ -3656,6 +3749,13 @@ declare interface CreateOrderParams {
3656
3749
  * @memberof CreateOrderParams
3657
3750
  */
3658
3751
  order: OrderCreate;
3752
+ /**
3753
+ * An optional client-defined tag which will appear in order reports. Note that the number of tags is limited per client and
3754
+ * if you use more tags, they will not be recorded.
3755
+ * @type {string}
3756
+ * @memberof CreateOrderParams
3757
+ */
3758
+ reportingTag?: string;
3659
3759
  }
3660
3760
 
3661
3761
  declare function CreateOrderParamsFromJSON(json: any): CreateOrderParams;
@@ -8311,6 +8411,11 @@ declare namespace openApiClient {
8311
8411
  CreateModeSessionTanAllOfToJSON,
8312
8412
  CreateModeSessionTanAllOf,
8313
8413
  CreateModeSessionTanAllOfModeEnum,
8414
+ CreateModeSessionTanSpecificsFromJSON,
8415
+ CreateModeSessionTanSpecificsFromJSONTyped,
8416
+ CreateModeSessionTanSpecificsToJSONRecursive,
8417
+ CreateModeSessionTanSpecificsToJSON,
8418
+ CreateModeSessionTanSpecifics,
8314
8419
  CreateOrderChallengeParamsFromJSON,
8315
8420
  CreateOrderChallengeParamsFromJSONTyped,
8316
8421
  CreateOrderChallengeParamsToJSONRecursive,
@@ -13545,6 +13650,26 @@ declare interface TradeStatistics {
13545
13650
  * @memberof TradeStatistics
13546
13651
  */
13547
13652
  winnerCount: number;
13653
+ /**
13654
+ * The proportion of trading days that ended with a net profit within the selected timeframe.
13655
+ *
13656
+ * - Calculated as the number of profitable trading days divided by the total number of trading days with activity.
13657
+ * - For example, if trades were executed on 10 days and 2 of those days resulted in a net profit, the ratio would be `0.2`.
13658
+ * - If no trades occurred during the selected period, the value is `undefined`.
13659
+ * @type {number}
13660
+ * @memberof TradeStatistics
13661
+ */
13662
+ winnerDaysRatio?: number;
13663
+ /**
13664
+ * The proportion of months that ended with a net profit within the selected timeframe.
13665
+ *
13666
+ * - Calculated as the number of profitable trading months divided by the total number of trading months with activity.
13667
+ * - For example, if trades were executed in 10 months and 2 of those months resulted in a net profit, the ratio would be `0.2`.
13668
+ * - If no trades occurred during the selected period, the value is `undefined`.
13669
+ * @type {number}
13670
+ * @memberof TradeStatistics
13671
+ */
13672
+ winnerMonthsRatio?: number;
13548
13673
  /**
13549
13674
  *
13550
13675
  * @type {SummarizedTrade}
@@ -38,6 +38,13 @@ export interface CancelOrderChallengeResponse {
38
38
  * @memberof CancelOrderChallengeResponse
39
39
  */
40
40
  challengeResponse: string;
41
+ /**
42
+ * An optional client-defined tag which will appear in order reports. Note that the number of tags is limited per client and
43
+ * if you use more tags, they will not be recorded.
44
+ * @type {string}
45
+ * @memberof CancelOrderChallengeResponse
46
+ */
47
+ reportingTag?: string;
41
48
  }
42
49
  /**
43
50
  * @export
@@ -29,6 +29,9 @@ export function CancelOrderChallengeResponseFromJSONTyped(json, ignoreDiscrimina
29
29
  authMethod: !exists(json, "authMethod") ? undefined : json["authMethod"],
30
30
  challengeId: !exists(json, "challengeId") ? undefined : json["challengeId"],
31
31
  challengeResponse: json["challengeResponse"],
32
+ reportingTag: !exists(json, "reportingTag")
33
+ ? undefined
34
+ : json["reportingTag"],
32
35
  };
33
36
  }
34
37
  export function CancelOrderChallengeResponseToJSONRecursive(value, ignoreParent = false) {
@@ -43,6 +46,7 @@ export function CancelOrderChallengeResponseToJSONRecursive(value, ignoreParent
43
46
  authMethod: value.authMethod,
44
47
  challengeId: value.challengeId,
45
48
  challengeResponse: value.challengeResponse,
49
+ reportingTag: value.reportingTag,
46
50
  };
47
51
  }
48
52
  export function CancelOrderChallengeResponseToJSON(value) {
@@ -32,6 +32,13 @@ export interface CancelOrderChallengeResponseSpecifics {
32
32
  * @memberof CancelOrderChallengeResponseSpecifics
33
33
  */
34
34
  challengeResponse?: string;
35
+ /**
36
+ * An optional client-defined tag which will appear in order reports. Note that the number of tags is limited per client and
37
+ * if you use more tags, they will not be recorded.
38
+ * @type {string}
39
+ * @memberof CancelOrderChallengeResponseSpecifics
40
+ */
41
+ reportingTag?: string;
35
42
  }
36
43
  export declare function CancelOrderChallengeResponseSpecificsFromJSON(json: any): CancelOrderChallengeResponseSpecifics;
37
44
  export declare function CancelOrderChallengeResponseSpecificsFromJSONTyped(json: any, ignoreDiscriminator: boolean): CancelOrderChallengeResponseSpecifics;
@@ -24,6 +24,9 @@ export function CancelOrderChallengeResponseSpecificsFromJSONTyped(json, ignoreD
24
24
  challengeResponse: !exists(json, "challengeResponse")
25
25
  ? undefined
26
26
  : json["challengeResponse"],
27
+ reportingTag: !exists(json, "reportingTag")
28
+ ? undefined
29
+ : json["reportingTag"],
27
30
  };
28
31
  }
29
32
  export function CancelOrderChallengeResponseSpecificsToJSONRecursive(value, ignoreParent = false) {
@@ -37,6 +40,7 @@ export function CancelOrderChallengeResponseSpecificsToJSONRecursive(value, igno
37
40
  authMethod: value.authMethod,
38
41
  challengeId: value.challengeId,
39
42
  challengeResponse: value.challengeResponse,
43
+ reportingTag: value.reportingTag,
40
44
  };
41
45
  }
42
46
  export function CancelOrderChallengeResponseSpecificsToJSON(value) {
@@ -26,6 +26,13 @@ export interface CancelOrderDecoupled {
26
26
  * @memberof CancelOrderDecoupled
27
27
  */
28
28
  authMethod?: string;
29
+ /**
30
+ * An optional client-defined tag which will appear in order reports. Note that the number of tags is limited per client and
31
+ * if you use more tags, they will not be recorded.
32
+ * @type {string}
33
+ * @memberof CancelOrderDecoupled
34
+ */
35
+ reportingTag?: string;
29
36
  }
30
37
  /**
31
38
  * @export
@@ -27,6 +27,9 @@ export function CancelOrderDecoupledFromJSONTyped(json, ignoreDiscriminator) {
27
27
  return {
28
28
  mode: json["mode"],
29
29
  authMethod: !exists(json, "authMethod") ? undefined : json["authMethod"],
30
+ reportingTag: !exists(json, "reportingTag")
31
+ ? undefined
32
+ : json["reportingTag"],
30
33
  };
31
34
  }
32
35
  export function CancelOrderDecoupledToJSONRecursive(value, ignoreParent = false) {
@@ -39,6 +42,7 @@ export function CancelOrderDecoupledToJSONRecursive(value, ignoreParent = false)
39
42
  return {
40
43
  mode: value.mode,
41
44
  authMethod: value.authMethod,
45
+ reportingTag: value.reportingTag,
42
46
  };
43
47
  }
44
48
  export function CancelOrderDecoupledToJSON(value) {
@@ -20,6 +20,13 @@ export interface CancelOrderDecoupledSpecifics {
20
20
  * @memberof CancelOrderDecoupledSpecifics
21
21
  */
22
22
  authMethod?: string;
23
+ /**
24
+ * An optional client-defined tag which will appear in order reports. Note that the number of tags is limited per client and
25
+ * if you use more tags, they will not be recorded.
26
+ * @type {string}
27
+ * @memberof CancelOrderDecoupledSpecifics
28
+ */
29
+ reportingTag?: string;
23
30
  }
24
31
  export declare function CancelOrderDecoupledSpecificsFromJSON(json: any): CancelOrderDecoupledSpecifics;
25
32
  export declare function CancelOrderDecoupledSpecificsFromJSONTyped(json: any, ignoreDiscriminator: boolean): CancelOrderDecoupledSpecifics;
@@ -20,6 +20,9 @@ export function CancelOrderDecoupledSpecificsFromJSONTyped(json, ignoreDiscrimin
20
20
  }
21
21
  return {
22
22
  authMethod: !exists(json, "authMethod") ? undefined : json["authMethod"],
23
+ reportingTag: !exists(json, "reportingTag")
24
+ ? undefined
25
+ : json["reportingTag"],
23
26
  };
24
27
  }
25
28
  export function CancelOrderDecoupledSpecificsToJSONRecursive(value, ignoreParent = false) {
@@ -31,6 +34,7 @@ export function CancelOrderDecoupledSpecificsToJSONRecursive(value, ignoreParent
31
34
  }
32
35
  return {
33
36
  authMethod: value.authMethod,
37
+ reportingTag: value.reportingTag,
34
38
  };
35
39
  }
36
40
  export function CancelOrderDecoupledSpecificsToJSON(value) {
@@ -39,6 +39,13 @@ export interface ChangeOrderParams {
39
39
  * @memberof ChangeOrderParams
40
40
  */
41
41
  changes: OrderChanges;
42
+ /**
43
+ * An optional client-defined tag which will appear in order reports. Note that the number of tags is limited per client and
44
+ * if you use more tags, they will not be recorded.
45
+ * @type {string}
46
+ * @memberof ChangeOrderParams
47
+ */
48
+ reportingTag?: string;
42
49
  }
43
50
  export declare function ChangeOrderParamsFromJSON(json: any): ChangeOrderParams;
44
51
  export declare function ChangeOrderParamsFromJSONTyped(json: any, ignoreDiscriminator: boolean): ChangeOrderParams;
@@ -26,6 +26,9 @@ export function ChangeOrderParamsFromJSONTyped(json, ignoreDiscriminator) {
26
26
  ? undefined
27
27
  : json["challengeResponse"],
28
28
  changes: OrderChangesFromJSON(json["changes"]),
29
+ reportingTag: !exists(json, "reportingTag")
30
+ ? undefined
31
+ : json["reportingTag"],
29
32
  };
30
33
  }
31
34
  export function ChangeOrderParamsToJSONRecursive(value, ignoreParent = false) {
@@ -40,6 +43,7 @@ export function ChangeOrderParamsToJSONRecursive(value, ignoreParent = false) {
40
43
  challengeId: value.challengeId,
41
44
  challengeResponse: value.challengeResponse,
42
45
  changes: OrderChangesToJSON(value.changes),
46
+ reportingTag: value.reportingTag,
43
47
  };
44
48
  }
45
49
  export function ChangeOrderParamsToJSON(value) {
@@ -117,6 +117,12 @@ export interface ClientConfig {
117
117
  * @memberof ClientConfig
118
118
  */
119
119
  page: any | null;
120
+ /**
121
+ * These flags are used in supporting the reporting logic
122
+ * @type {Array<string>}
123
+ * @memberof ClientConfig
124
+ */
125
+ reportingFlags?: Array<string>;
120
126
  }
121
127
  export declare function ClientConfigFromJSON(json: any): ClientConfig;
122
128
  export declare function ClientConfigFromJSONTyped(json: any, ignoreDiscriminator: boolean): ClientConfig;
@@ -51,6 +51,9 @@ export function ClientConfigFromJSONTyped(json, ignoreDiscriminator) {
51
51
  oAuthReturnToRegularExpressions: json["oAuthReturnToRegularExpressions"],
52
52
  oAuthReturnToUrls: json["oAuthReturnToUrls"],
53
53
  page: json["page"],
54
+ reportingFlags: !exists(json, "reportingFlags")
55
+ ? undefined
56
+ : json["reportingFlags"],
54
57
  };
55
58
  }
56
59
  export function ClientConfigToJSONRecursive(value, ignoreParent = false) {
@@ -77,6 +80,7 @@ export function ClientConfigToJSONRecursive(value, ignoreParent = false) {
77
80
  oAuthReturnToRegularExpressions: value.oAuthReturnToRegularExpressions,
78
81
  oAuthReturnToUrls: value.oAuthReturnToUrls,
79
82
  page: value.page,
83
+ reportingFlags: value.reportingFlags,
80
84
  };
81
85
  }
82
86
  export function ClientConfigToJSON(value) {
@@ -149,6 +149,12 @@ export interface ClientConfigUpdate {
149
149
  * @memberof ClientConfigUpdate
150
150
  */
151
151
  rateLimitPointsToConsume?: ClientConfigUpdateRateLimitPointsToConsume;
152
+ /**
153
+ * These flags are used in supporting the reporting logic
154
+ * @type {Array<string>}
155
+ * @memberof ClientConfigUpdate
156
+ */
157
+ reportingFlags?: Array<string>;
152
158
  }
153
159
  export declare function ClientConfigUpdateFromJSON(json: any): ClientConfigUpdate;
154
160
  export declare function ClientConfigUpdateFromJSONTyped(json: any, ignoreDiscriminator: boolean): ClientConfigUpdate;
@@ -85,6 +85,9 @@ export function ClientConfigUpdateFromJSONTyped(json, ignoreDiscriminator) {
85
85
  rateLimitPointsToConsume: !exists(json, "rateLimitPointsToConsume")
86
86
  ? undefined
87
87
  : ClientConfigUpdateRateLimitPointsToConsumeFromJSON(json["rateLimitPointsToConsume"]),
88
+ reportingFlags: !exists(json, "reportingFlags")
89
+ ? undefined
90
+ : json["reportingFlags"],
88
91
  };
89
92
  }
90
93
  export function ClientConfigUpdateToJSONRecursive(value, ignoreParent = false) {
@@ -118,6 +121,7 @@ export function ClientConfigUpdateToJSONRecursive(value, ignoreParent = false) {
118
121
  optionalClientSecrets: value.optionalClientSecrets,
119
122
  page: ClientConfigUpdatePageToJSON(value.page),
120
123
  rateLimitPointsToConsume: ClientConfigUpdateRateLimitPointsToConsumeToJSON(value.rateLimitPointsToConsume),
124
+ reportingFlags: value.reportingFlags,
121
125
  };
122
126
  }
123
127
  export function ClientConfigUpdateToJSON(value) {
@@ -20,6 +20,12 @@ export interface ConfirmOAuthParams {
20
20
  * @memberof ConfirmOAuthParams
21
21
  */
22
22
  code: string;
23
+ /**
24
+ *
25
+ * @type {string}
26
+ * @memberof ConfirmOAuthParams
27
+ */
28
+ reportingTag?: string | null;
23
29
  /**
24
30
  *
25
31
  * @type {string}
@@ -10,6 +10,7 @@
10
10
  * https://openapi-generator.tech
11
11
  * Do not edit the class manually.
12
12
  */
13
+ import { exists } from "../runtime";
13
14
  export function ConfirmOAuthParamsFromJSON(json) {
14
15
  return ConfirmOAuthParamsFromJSONTyped(json, false);
15
16
  }
@@ -19,6 +20,9 @@ export function ConfirmOAuthParamsFromJSONTyped(json, ignoreDiscriminator) {
19
20
  }
20
21
  return {
21
22
  code: json["code"],
23
+ reportingTag: !exists(json, "reportingTag")
24
+ ? undefined
25
+ : json["reportingTag"],
22
26
  ticketId: json["ticketId"],
23
27
  };
24
28
  }
@@ -31,6 +35,7 @@ export function ConfirmOAuthParamsToJSONRecursive(value, ignoreParent = false) {
31
35
  }
32
36
  return {
33
37
  code: value.code,
38
+ reportingTag: value.reportingTag,
34
39
  ticketId: value.ticketId,
35
40
  };
36
41
  }
@@ -20,6 +20,13 @@ export interface CreateModeSessionTan {
20
20
  * @memberof CreateModeSessionTan
21
21
  */
22
22
  mode: CreateModeSessionTanModeEnum;
23
+ /**
24
+ * An optional client-defined tag which will appear in order reports. Note that the number of tags is limited per client and
25
+ * if you use more tags, they will not be recorded.
26
+ * @type {string}
27
+ * @memberof CreateModeSessionTan
28
+ */
29
+ reportingTag?: string;
23
30
  }
24
31
  /**
25
32
  * @export
@@ -10,6 +10,7 @@
10
10
  * https://openapi-generator.tech
11
11
  * Do not edit the class manually.
12
12
  */
13
+ import { exists } from "../runtime";
13
14
  /**
14
15
  * @export
15
16
  */
@@ -25,6 +26,9 @@ export function CreateModeSessionTanFromJSONTyped(json, ignoreDiscriminator) {
25
26
  }
26
27
  return {
27
28
  mode: json["mode"],
29
+ reportingTag: !exists(json, "reportingTag")
30
+ ? undefined
31
+ : json["reportingTag"],
28
32
  };
29
33
  }
30
34
  export function CreateModeSessionTanToJSONRecursive(value, ignoreParent = false) {
@@ -36,6 +40,7 @@ export function CreateModeSessionTanToJSONRecursive(value, ignoreParent = false)
36
40
  }
37
41
  return {
38
42
  mode: value.mode,
43
+ reportingTag: value.reportingTag,
39
44
  };
40
45
  }
41
46
  export function CreateModeSessionTanToJSON(value) {
@@ -0,0 +1,28 @@
1
+ /**
2
+ * brokerize
3
+ * The brokerize API allows clients to implement multi-brokerage with a unified interface. For more information, visit brokerize.com
4
+ *
5
+ *
6
+ *
7
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
8
+ * https://openapi-generator.tech
9
+ * Do not edit the class manually.
10
+ */
11
+ /**
12
+ *
13
+ * @export
14
+ * @interface CreateModeSessionTanSpecifics
15
+ */
16
+ export interface CreateModeSessionTanSpecifics {
17
+ /**
18
+ * An optional client-defined tag which will appear in order reports. Note that the number of tags is limited per client and
19
+ * if you use more tags, they will not be recorded.
20
+ * @type {string}
21
+ * @memberof CreateModeSessionTanSpecifics
22
+ */
23
+ reportingTag?: string;
24
+ }
25
+ export declare function CreateModeSessionTanSpecificsFromJSON(json: any): CreateModeSessionTanSpecifics;
26
+ export declare function CreateModeSessionTanSpecificsFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateModeSessionTanSpecifics;
27
+ export declare function CreateModeSessionTanSpecificsToJSONRecursive(value?: CreateModeSessionTanSpecifics | null, ignoreParent?: boolean): any;
28
+ export declare function CreateModeSessionTanSpecificsToJSON(value?: CreateModeSessionTanSpecifics | null): any;
@@ -0,0 +1,40 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * brokerize
5
+ * The brokerize API allows clients to implement multi-brokerage with a unified interface. For more information, visit brokerize.com
6
+ *
7
+ *
8
+ *
9
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
10
+ * https://openapi-generator.tech
11
+ * Do not edit the class manually.
12
+ */
13
+ import { exists } from "../runtime";
14
+ export function CreateModeSessionTanSpecificsFromJSON(json) {
15
+ return CreateModeSessionTanSpecificsFromJSONTyped(json, false);
16
+ }
17
+ export function CreateModeSessionTanSpecificsFromJSONTyped(json, ignoreDiscriminator) {
18
+ if (json === undefined || json === null) {
19
+ return json;
20
+ }
21
+ return {
22
+ reportingTag: !exists(json, "reportingTag")
23
+ ? undefined
24
+ : json["reportingTag"],
25
+ };
26
+ }
27
+ export function CreateModeSessionTanSpecificsToJSONRecursive(value, ignoreParent = false) {
28
+ if (value === undefined) {
29
+ return undefined;
30
+ }
31
+ if (value === null) {
32
+ return null;
33
+ }
34
+ return {
35
+ reportingTag: value.reportingTag,
36
+ };
37
+ }
38
+ export function CreateModeSessionTanSpecificsToJSON(value) {
39
+ return CreateModeSessionTanSpecificsToJSONRecursive(value, false);
40
+ }
@@ -46,6 +46,13 @@ export interface CreateOrderParams {
46
46
  * @memberof CreateOrderParams
47
47
  */
48
48
  order: OrderCreate;
49
+ /**
50
+ * An optional client-defined tag which will appear in order reports. Note that the number of tags is limited per client and
51
+ * if you use more tags, they will not be recorded.
52
+ * @type {string}
53
+ * @memberof CreateOrderParams
54
+ */
55
+ reportingTag?: string;
49
56
  }
50
57
  export declare function CreateOrderParamsFromJSON(json: any): CreateOrderParams;
51
58
  export declare function CreateOrderParamsFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateOrderParams;
@@ -29,6 +29,9 @@ export function CreateOrderParamsFromJSONTyped(json, ignoreDiscriminator) {
29
29
  ? undefined
30
30
  : json["challengeResponse"],
31
31
  order: OrderCreateFromJSON(json["order"]),
32
+ reportingTag: !exists(json, "reportingTag")
33
+ ? undefined
34
+ : json["reportingTag"],
32
35
  };
33
36
  }
34
37
  export function CreateOrderParamsToJSONRecursive(value, ignoreParent = false) {
@@ -44,6 +47,7 @@ export function CreateOrderParamsToJSONRecursive(value, ignoreParent = false) {
44
47
  challengeId: value.challengeId,
45
48
  challengeResponse: value.challengeResponse,
46
49
  order: OrderCreateToJSON(value.order),
50
+ reportingTag: value.reportingTag,
47
51
  };
48
52
  }
49
53
  export function CreateOrderParamsToJSON(value) {
@@ -97,6 +97,26 @@ export interface TradeStatistics {
97
97
  * @memberof TradeStatistics
98
98
  */
99
99
  winnerCount: number;
100
+ /**
101
+ * The proportion of trading days that ended with a net profit within the selected timeframe.
102
+ *
103
+ * - Calculated as the number of profitable trading days divided by the total number of trading days with activity.
104
+ * - For example, if trades were executed on 10 days and 2 of those days resulted in a net profit, the ratio would be `0.2`.
105
+ * - If no trades occurred during the selected period, the value is `undefined`.
106
+ * @type {number}
107
+ * @memberof TradeStatistics
108
+ */
109
+ winnerDaysRatio?: number;
110
+ /**
111
+ * The proportion of months that ended with a net profit within the selected timeframe.
112
+ *
113
+ * - Calculated as the number of profitable trading months divided by the total number of trading months with activity.
114
+ * - For example, if trades were executed in 10 months and 2 of those months resulted in a net profit, the ratio would be `0.2`.
115
+ * - If no trades occurred during the selected period, the value is `undefined`.
116
+ * @type {number}
117
+ * @memberof TradeStatistics
118
+ */
119
+ winnerMonthsRatio?: number;
100
120
  /**
101
121
  *
102
122
  * @type {SummarizedTrade}
@@ -47,6 +47,12 @@ export function TradeStatisticsFromJSONTyped(json, ignoreDiscriminator) {
47
47
  : AmountFromJSON(json["profitLossAbs"]),
48
48
  tradeCount: json["tradeCount"],
49
49
  winnerCount: json["winnerCount"],
50
+ winnerDaysRatio: !exists(json, "winnerDaysRatio")
51
+ ? undefined
52
+ : json["winnerDaysRatio"],
53
+ winnerMonthsRatio: !exists(json, "winnerMonthsRatio")
54
+ ? undefined
55
+ : json["winnerMonthsRatio"],
50
56
  worstTrade: !exists(json, "worstTrade")
51
57
  ? undefined
52
58
  : SummarizedTradeFromJSON(json["worstTrade"]),
@@ -73,6 +79,8 @@ export function TradeStatisticsToJSONRecursive(value, ignoreParent = false) {
73
79
  profitLossAbs: AmountToJSON(value.profitLossAbs),
74
80
  tradeCount: value.tradeCount,
75
81
  winnerCount: value.winnerCount,
82
+ winnerDaysRatio: value.winnerDaysRatio,
83
+ winnerMonthsRatio: value.winnerMonthsRatio,
76
84
  worstTrade: SummarizedTradeToJSON(value.worstTrade),
77
85
  };
78
86
  }
@@ -60,6 +60,7 @@ export * from "./CreateClient200Response";
60
60
  export * from "./CreateGuestUserResponse";
61
61
  export * from "./CreateModeSessionTan";
62
62
  export * from "./CreateModeSessionTanAllOf";
63
+ export * from "./CreateModeSessionTanSpecifics";
63
64
  export * from "./CreateOrderChallengeParams";
64
65
  export * from "./CreateOrderParams";
65
66
  export * from "./CreateTanChallengeParams";
@@ -62,6 +62,7 @@ export * from "./CreateClient200Response";
62
62
  export * from "./CreateGuestUserResponse";
63
63
  export * from "./CreateModeSessionTan";
64
64
  export * from "./CreateModeSessionTanAllOf";
65
+ export * from "./CreateModeSessionTanSpecifics";
65
66
  export * from "./CreateOrderChallengeParams";
66
67
  export * from "./CreateOrderParams";
67
68
  export * from "./CreateTanChallengeParams";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@brokerize/client",
3
- "version": "1.2.3",
3
+ "version": "1.2.5",
4
4
  "description": "Client for the brokerize.com API",
5
5
  "keywords": [],
6
6
  "homepage": "https://github.com/brokerize/client-js#readme",