@ampeco/public-api-mcp 3.248.0 → 3.249.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/generated/build-stats.json +9 -9
- package/dist/generated/endpoints.json +399 -50
- package/dist/generated/response-schemas.json +1211 -13
- package/dist/generated/schemas.d.ts +99 -21
- package/dist/generated/schemas.d.ts.map +1 -1
- package/dist/generated/schemas.js +38 -11
- package/dist/generated/schemas.js.map +1 -1
- package/dist/generated/schemas.ts +43 -11
- package/package.json +1 -1
|
@@ -10388,7 +10388,7 @@
|
|
|
10388
10388
|
"ga-IE",
|
|
10389
10389
|
"bs",
|
|
10390
10390
|
"ja",
|
|
10391
|
-
"ko",
|
|
10391
|
+
"ko-KR",
|
|
10392
10392
|
"cs",
|
|
10393
10393
|
"lv",
|
|
10394
10394
|
"et",
|
|
@@ -83300,6 +83300,90 @@
|
|
|
83300
83300
|
"format": "date-time",
|
|
83301
83301
|
"description": "ISO 8601 formatted date",
|
|
83302
83302
|
"readOnly": true
|
|
83303
|
+
},
|
|
83304
|
+
"settlementOverrides": {
|
|
83305
|
+
"type": "array",
|
|
83306
|
+
"description": "⚠️ Experimental — not yet a stable contract. The embedded settlement override objects may change without a version bump, including breaking changes within `v1.0` itself. Consume them for evaluation only, or coordinate adoption with your account manager so changes can be sequenced with you.\n\nActive settlement overrides of the contract, newest first. Returned only by `GET /public-api/resources/partner-contracts/v1.0/{partnerContract}` and only when requested through `include[]=settlementOverrides`. The listing, create and update responses never carry this property, because they do not accept the `include` parameter — read the overrides of a contract through `GET /public-api/resources/partner-contracts/v1.0/{partnerContract}/settlement-overrides` instead.\n",
|
|
83307
|
+
"items": {
|
|
83308
|
+
"description": "⚠️ Experimental endpoint — not yet a stable contract. This resource ships as experimental / beta. While experimental, its schema and behaviour may change without a version bump — including breaking changes within v1.0 itself. Anyone consuming it does so for evaluation only, or by coordinating adoption with their account manager so changes can be sequenced with them. It graduates to a stable, version-locked contract (where the normal breaking-change rules apply) only when this experimental notice is removed.\n\nSettlement override read schema. Each record scopes an AC / DC partner share percentage to one driver population on the partner contract; the contract's own settlement fields remain the default rule.\n",
|
|
83309
|
+
"type": "object",
|
|
83310
|
+
"required": [
|
|
83311
|
+
"id",
|
|
83312
|
+
"name",
|
|
83313
|
+
"priority",
|
|
83314
|
+
"restriction",
|
|
83315
|
+
"acPercent",
|
|
83316
|
+
"dcPercent"
|
|
83317
|
+
],
|
|
83318
|
+
"properties": {
|
|
83319
|
+
"name": {
|
|
83320
|
+
"type": "string",
|
|
83321
|
+
"maxLength": 255,
|
|
83322
|
+
"description": "Name of the settlement override, unique among the active overrides of the partner contract.",
|
|
83323
|
+
"example": "Fleet drivers"
|
|
83324
|
+
},
|
|
83325
|
+
"priority": {
|
|
83326
|
+
"type": "integer",
|
|
83327
|
+
"minimum": 1,
|
|
83328
|
+
"maximum": 4294967295,
|
|
83329
|
+
"description": "Evaluation priority of the override, unique among the active overrides of the partner contract.\nThe lowest value that matches a session wins.\n",
|
|
83330
|
+
"example": 1
|
|
83331
|
+
},
|
|
83332
|
+
"id": {
|
|
83333
|
+
"type": "integer",
|
|
83334
|
+
"description": "Unique identifier for the settlement override",
|
|
83335
|
+
"example": 123
|
|
83336
|
+
},
|
|
83337
|
+
"restriction": {
|
|
83338
|
+
"type": "object",
|
|
83339
|
+
"description": "Which users of the partner contract the override applies to. `type` is the discriminator and\ndetermines what `targetIds` references.\n",
|
|
83340
|
+
"required": [
|
|
83341
|
+
"type"
|
|
83342
|
+
],
|
|
83343
|
+
"properties": {
|
|
83344
|
+
"type": {
|
|
83345
|
+
"type": "string",
|
|
83346
|
+
"description": "Which users of the partner contract the settlement override applies to.\n\nAllowed values:\n- `users_of_the_partner` - Applies to sessions of users belonging to the contract's partner.\n- `user_groups` - Applies to sessions of users in the listed user groups. Requires `userGroupIds`.\n- `ad_hoc_users` - Applies to sessions of ad hoc (unregistered) users.\n- `users_of_specific_partners` - Applies to sessions of users belonging to the listed partners. Requires `partnerIds`.\n",
|
|
83347
|
+
"enum": [
|
|
83348
|
+
"users_of_the_partner",
|
|
83349
|
+
"user_groups",
|
|
83350
|
+
"ad_hoc_users",
|
|
83351
|
+
"users_of_specific_partners"
|
|
83352
|
+
]
|
|
83353
|
+
},
|
|
83354
|
+
"targetIds": {
|
|
83355
|
+
"type": "array",
|
|
83356
|
+
"description": "Identifiers of the records the override applies to, as determined by `type`: user group IDs\nfor `user_groups` and partner IDs for `users_of_specific_partners`. Required for those two\ntypes and omitted for every other type.\n",
|
|
83357
|
+
"items": {
|
|
83358
|
+
"type": "integer"
|
|
83359
|
+
},
|
|
83360
|
+
"example": [
|
|
83361
|
+
12,
|
|
83362
|
+
34
|
|
83363
|
+
]
|
|
83364
|
+
}
|
|
83365
|
+
}
|
|
83366
|
+
},
|
|
83367
|
+
"acPercent": {
|
|
83368
|
+
"type": "number",
|
|
83369
|
+
"format": "float",
|
|
83370
|
+
"nullable": true,
|
|
83371
|
+
"minimum": 0,
|
|
83372
|
+
"maximum": 100,
|
|
83373
|
+
"description": "Partner share percentage applied to AC sessions matched by this override.\n`null` means the value is inherited from the partner contract.\n",
|
|
83374
|
+
"example": 70.5
|
|
83375
|
+
},
|
|
83376
|
+
"dcPercent": {
|
|
83377
|
+
"type": "number",
|
|
83378
|
+
"format": "float",
|
|
83379
|
+
"nullable": true,
|
|
83380
|
+
"minimum": 0,
|
|
83381
|
+
"maximum": 100,
|
|
83382
|
+
"description": "Partner share percentage applied to DC sessions matched by this override.\n`null` means the value is inherited from the partner contract.\n",
|
|
83383
|
+
"example": 60
|
|
83384
|
+
}
|
|
83385
|
+
}
|
|
83386
|
+
}
|
|
83303
83387
|
}
|
|
83304
83388
|
},
|
|
83305
83389
|
"required": [
|
|
@@ -83647,6 +83731,90 @@
|
|
|
83647
83731
|
"format": "date-time",
|
|
83648
83732
|
"description": "ISO 8601 formatted date",
|
|
83649
83733
|
"readOnly": true
|
|
83734
|
+
},
|
|
83735
|
+
"settlementOverrides": {
|
|
83736
|
+
"type": "array",
|
|
83737
|
+
"description": "⚠️ Experimental — not yet a stable contract. The embedded settlement override objects may change without a version bump, including breaking changes within `v1.0` itself. Consume them for evaluation only, or coordinate adoption with your account manager so changes can be sequenced with you.\n\nActive settlement overrides of the contract, newest first. Returned only by `GET /public-api/resources/partner-contracts/v1.0/{partnerContract}` and only when requested through `include[]=settlementOverrides`. The listing, create and update responses never carry this property, because they do not accept the `include` parameter — read the overrides of a contract through `GET /public-api/resources/partner-contracts/v1.0/{partnerContract}/settlement-overrides` instead.\n",
|
|
83738
|
+
"items": {
|
|
83739
|
+
"description": "⚠️ Experimental endpoint — not yet a stable contract. This resource ships as experimental / beta. While experimental, its schema and behaviour may change without a version bump — including breaking changes within v1.0 itself. Anyone consuming it does so for evaluation only, or by coordinating adoption with their account manager so changes can be sequenced with them. It graduates to a stable, version-locked contract (where the normal breaking-change rules apply) only when this experimental notice is removed.\n\nSettlement override read schema. Each record scopes an AC / DC partner share percentage to one driver population on the partner contract; the contract's own settlement fields remain the default rule.\n",
|
|
83740
|
+
"type": "object",
|
|
83741
|
+
"required": [
|
|
83742
|
+
"id",
|
|
83743
|
+
"name",
|
|
83744
|
+
"priority",
|
|
83745
|
+
"restriction",
|
|
83746
|
+
"acPercent",
|
|
83747
|
+
"dcPercent"
|
|
83748
|
+
],
|
|
83749
|
+
"properties": {
|
|
83750
|
+
"name": {
|
|
83751
|
+
"type": "string",
|
|
83752
|
+
"maxLength": 255,
|
|
83753
|
+
"description": "Name of the settlement override, unique among the active overrides of the partner contract.",
|
|
83754
|
+
"example": "Fleet drivers"
|
|
83755
|
+
},
|
|
83756
|
+
"priority": {
|
|
83757
|
+
"type": "integer",
|
|
83758
|
+
"minimum": 1,
|
|
83759
|
+
"maximum": 4294967295,
|
|
83760
|
+
"description": "Evaluation priority of the override, unique among the active overrides of the partner contract.\nThe lowest value that matches a session wins.\n",
|
|
83761
|
+
"example": 1
|
|
83762
|
+
},
|
|
83763
|
+
"id": {
|
|
83764
|
+
"type": "integer",
|
|
83765
|
+
"description": "Unique identifier for the settlement override",
|
|
83766
|
+
"example": 123
|
|
83767
|
+
},
|
|
83768
|
+
"restriction": {
|
|
83769
|
+
"type": "object",
|
|
83770
|
+
"description": "Which users of the partner contract the override applies to. `type` is the discriminator and\ndetermines what `targetIds` references.\n",
|
|
83771
|
+
"required": [
|
|
83772
|
+
"type"
|
|
83773
|
+
],
|
|
83774
|
+
"properties": {
|
|
83775
|
+
"type": {
|
|
83776
|
+
"type": "string",
|
|
83777
|
+
"description": "Which users of the partner contract the settlement override applies to.\n\nAllowed values:\n- `users_of_the_partner` - Applies to sessions of users belonging to the contract's partner.\n- `user_groups` - Applies to sessions of users in the listed user groups. Requires `userGroupIds`.\n- `ad_hoc_users` - Applies to sessions of ad hoc (unregistered) users.\n- `users_of_specific_partners` - Applies to sessions of users belonging to the listed partners. Requires `partnerIds`.\n",
|
|
83778
|
+
"enum": [
|
|
83779
|
+
"users_of_the_partner",
|
|
83780
|
+
"user_groups",
|
|
83781
|
+
"ad_hoc_users",
|
|
83782
|
+
"users_of_specific_partners"
|
|
83783
|
+
]
|
|
83784
|
+
},
|
|
83785
|
+
"targetIds": {
|
|
83786
|
+
"type": "array",
|
|
83787
|
+
"description": "Identifiers of the records the override applies to, as determined by `type`: user group IDs\nfor `user_groups` and partner IDs for `users_of_specific_partners`. Required for those two\ntypes and omitted for every other type.\n",
|
|
83788
|
+
"items": {
|
|
83789
|
+
"type": "integer"
|
|
83790
|
+
},
|
|
83791
|
+
"example": [
|
|
83792
|
+
12,
|
|
83793
|
+
34
|
|
83794
|
+
]
|
|
83795
|
+
}
|
|
83796
|
+
}
|
|
83797
|
+
},
|
|
83798
|
+
"acPercent": {
|
|
83799
|
+
"type": "number",
|
|
83800
|
+
"format": "float",
|
|
83801
|
+
"nullable": true,
|
|
83802
|
+
"minimum": 0,
|
|
83803
|
+
"maximum": 100,
|
|
83804
|
+
"description": "Partner share percentage applied to AC sessions matched by this override.\n`null` means the value is inherited from the partner contract.\n",
|
|
83805
|
+
"example": 70.5
|
|
83806
|
+
},
|
|
83807
|
+
"dcPercent": {
|
|
83808
|
+
"type": "number",
|
|
83809
|
+
"format": "float",
|
|
83810
|
+
"nullable": true,
|
|
83811
|
+
"minimum": 0,
|
|
83812
|
+
"maximum": 100,
|
|
83813
|
+
"description": "Partner share percentage applied to DC sessions matched by this override.\n`null` means the value is inherited from the partner contract.\n",
|
|
83814
|
+
"example": 60
|
|
83815
|
+
}
|
|
83816
|
+
}
|
|
83817
|
+
}
|
|
83650
83818
|
}
|
|
83651
83819
|
},
|
|
83652
83820
|
"required": [
|
|
@@ -83901,6 +84069,90 @@
|
|
|
83901
84069
|
"format": "date-time",
|
|
83902
84070
|
"description": "ISO 8601 formatted date",
|
|
83903
84071
|
"readOnly": true
|
|
84072
|
+
},
|
|
84073
|
+
"settlementOverrides": {
|
|
84074
|
+
"type": "array",
|
|
84075
|
+
"description": "⚠️ Experimental — not yet a stable contract. The embedded settlement override objects may change without a version bump, including breaking changes within `v1.0` itself. Consume them for evaluation only, or coordinate adoption with your account manager so changes can be sequenced with you.\n\nActive settlement overrides of the contract, newest first. Returned only by `GET /public-api/resources/partner-contracts/v1.0/{partnerContract}` and only when requested through `include[]=settlementOverrides`. The listing, create and update responses never carry this property, because they do not accept the `include` parameter — read the overrides of a contract through `GET /public-api/resources/partner-contracts/v1.0/{partnerContract}/settlement-overrides` instead.\n",
|
|
84076
|
+
"items": {
|
|
84077
|
+
"description": "⚠️ Experimental endpoint — not yet a stable contract. This resource ships as experimental / beta. While experimental, its schema and behaviour may change without a version bump — including breaking changes within v1.0 itself. Anyone consuming it does so for evaluation only, or by coordinating adoption with their account manager so changes can be sequenced with them. It graduates to a stable, version-locked contract (where the normal breaking-change rules apply) only when this experimental notice is removed.\n\nSettlement override read schema. Each record scopes an AC / DC partner share percentage to one driver population on the partner contract; the contract's own settlement fields remain the default rule.\n",
|
|
84078
|
+
"type": "object",
|
|
84079
|
+
"required": [
|
|
84080
|
+
"id",
|
|
84081
|
+
"name",
|
|
84082
|
+
"priority",
|
|
84083
|
+
"restriction",
|
|
84084
|
+
"acPercent",
|
|
84085
|
+
"dcPercent"
|
|
84086
|
+
],
|
|
84087
|
+
"properties": {
|
|
84088
|
+
"name": {
|
|
84089
|
+
"type": "string",
|
|
84090
|
+
"maxLength": 255,
|
|
84091
|
+
"description": "Name of the settlement override, unique among the active overrides of the partner contract.",
|
|
84092
|
+
"example": "Fleet drivers"
|
|
84093
|
+
},
|
|
84094
|
+
"priority": {
|
|
84095
|
+
"type": "integer",
|
|
84096
|
+
"minimum": 1,
|
|
84097
|
+
"maximum": 4294967295,
|
|
84098
|
+
"description": "Evaluation priority of the override, unique among the active overrides of the partner contract.\nThe lowest value that matches a session wins.\n",
|
|
84099
|
+
"example": 1
|
|
84100
|
+
},
|
|
84101
|
+
"id": {
|
|
84102
|
+
"type": "integer",
|
|
84103
|
+
"description": "Unique identifier for the settlement override",
|
|
84104
|
+
"example": 123
|
|
84105
|
+
},
|
|
84106
|
+
"restriction": {
|
|
84107
|
+
"type": "object",
|
|
84108
|
+
"description": "Which users of the partner contract the override applies to. `type` is the discriminator and\ndetermines what `targetIds` references.\n",
|
|
84109
|
+
"required": [
|
|
84110
|
+
"type"
|
|
84111
|
+
],
|
|
84112
|
+
"properties": {
|
|
84113
|
+
"type": {
|
|
84114
|
+
"type": "string",
|
|
84115
|
+
"description": "Which users of the partner contract the settlement override applies to.\n\nAllowed values:\n- `users_of_the_partner` - Applies to sessions of users belonging to the contract's partner.\n- `user_groups` - Applies to sessions of users in the listed user groups. Requires `userGroupIds`.\n- `ad_hoc_users` - Applies to sessions of ad hoc (unregistered) users.\n- `users_of_specific_partners` - Applies to sessions of users belonging to the listed partners. Requires `partnerIds`.\n",
|
|
84116
|
+
"enum": [
|
|
84117
|
+
"users_of_the_partner",
|
|
84118
|
+
"user_groups",
|
|
84119
|
+
"ad_hoc_users",
|
|
84120
|
+
"users_of_specific_partners"
|
|
84121
|
+
]
|
|
84122
|
+
},
|
|
84123
|
+
"targetIds": {
|
|
84124
|
+
"type": "array",
|
|
84125
|
+
"description": "Identifiers of the records the override applies to, as determined by `type`: user group IDs\nfor `user_groups` and partner IDs for `users_of_specific_partners`. Required for those two\ntypes and omitted for every other type.\n",
|
|
84126
|
+
"items": {
|
|
84127
|
+
"type": "integer"
|
|
84128
|
+
},
|
|
84129
|
+
"example": [
|
|
84130
|
+
12,
|
|
84131
|
+
34
|
|
84132
|
+
]
|
|
84133
|
+
}
|
|
84134
|
+
}
|
|
84135
|
+
},
|
|
84136
|
+
"acPercent": {
|
|
84137
|
+
"type": "number",
|
|
84138
|
+
"format": "float",
|
|
84139
|
+
"nullable": true,
|
|
84140
|
+
"minimum": 0,
|
|
84141
|
+
"maximum": 100,
|
|
84142
|
+
"description": "Partner share percentage applied to AC sessions matched by this override.\n`null` means the value is inherited from the partner contract.\n",
|
|
84143
|
+
"example": 70.5
|
|
84144
|
+
},
|
|
84145
|
+
"dcPercent": {
|
|
84146
|
+
"type": "number",
|
|
84147
|
+
"format": "float",
|
|
84148
|
+
"nullable": true,
|
|
84149
|
+
"minimum": 0,
|
|
84150
|
+
"maximum": 100,
|
|
84151
|
+
"description": "Partner share percentage applied to DC sessions matched by this override.\n`null` means the value is inherited from the partner contract.\n",
|
|
84152
|
+
"example": 60
|
|
84153
|
+
}
|
|
84154
|
+
}
|
|
84155
|
+
}
|
|
83904
84156
|
}
|
|
83905
84157
|
},
|
|
83906
84158
|
"required": [
|
|
@@ -84143,6 +84395,90 @@
|
|
|
84143
84395
|
"format": "date-time",
|
|
84144
84396
|
"description": "ISO 8601 formatted date",
|
|
84145
84397
|
"readOnly": true
|
|
84398
|
+
},
|
|
84399
|
+
"settlementOverrides": {
|
|
84400
|
+
"type": "array",
|
|
84401
|
+
"description": "⚠️ Experimental — not yet a stable contract. The embedded settlement override objects may change without a version bump, including breaking changes within `v1.0` itself. Consume them for evaluation only, or coordinate adoption with your account manager so changes can be sequenced with you.\n\nActive settlement overrides of the contract, newest first. Returned only by `GET /public-api/resources/partner-contracts/v1.0/{partnerContract}` and only when requested through `include[]=settlementOverrides`. The listing, create and update responses never carry this property, because they do not accept the `include` parameter — read the overrides of a contract through `GET /public-api/resources/partner-contracts/v1.0/{partnerContract}/settlement-overrides` instead.\n",
|
|
84402
|
+
"items": {
|
|
84403
|
+
"description": "⚠️ Experimental endpoint — not yet a stable contract. This resource ships as experimental / beta. While experimental, its schema and behaviour may change without a version bump — including breaking changes within v1.0 itself. Anyone consuming it does so for evaluation only, or by coordinating adoption with their account manager so changes can be sequenced with them. It graduates to a stable, version-locked contract (where the normal breaking-change rules apply) only when this experimental notice is removed.\n\nSettlement override read schema. Each record scopes an AC / DC partner share percentage to one driver population on the partner contract; the contract's own settlement fields remain the default rule.\n",
|
|
84404
|
+
"type": "object",
|
|
84405
|
+
"required": [
|
|
84406
|
+
"id",
|
|
84407
|
+
"name",
|
|
84408
|
+
"priority",
|
|
84409
|
+
"restriction",
|
|
84410
|
+
"acPercent",
|
|
84411
|
+
"dcPercent"
|
|
84412
|
+
],
|
|
84413
|
+
"properties": {
|
|
84414
|
+
"name": {
|
|
84415
|
+
"type": "string",
|
|
84416
|
+
"maxLength": 255,
|
|
84417
|
+
"description": "Name of the settlement override, unique among the active overrides of the partner contract.",
|
|
84418
|
+
"example": "Fleet drivers"
|
|
84419
|
+
},
|
|
84420
|
+
"priority": {
|
|
84421
|
+
"type": "integer",
|
|
84422
|
+
"minimum": 1,
|
|
84423
|
+
"maximum": 4294967295,
|
|
84424
|
+
"description": "Evaluation priority of the override, unique among the active overrides of the partner contract.\nThe lowest value that matches a session wins.\n",
|
|
84425
|
+
"example": 1
|
|
84426
|
+
},
|
|
84427
|
+
"id": {
|
|
84428
|
+
"type": "integer",
|
|
84429
|
+
"description": "Unique identifier for the settlement override",
|
|
84430
|
+
"example": 123
|
|
84431
|
+
},
|
|
84432
|
+
"restriction": {
|
|
84433
|
+
"type": "object",
|
|
84434
|
+
"description": "Which users of the partner contract the override applies to. `type` is the discriminator and\ndetermines what `targetIds` references.\n",
|
|
84435
|
+
"required": [
|
|
84436
|
+
"type"
|
|
84437
|
+
],
|
|
84438
|
+
"properties": {
|
|
84439
|
+
"type": {
|
|
84440
|
+
"type": "string",
|
|
84441
|
+
"description": "Which users of the partner contract the settlement override applies to.\n\nAllowed values:\n- `users_of_the_partner` - Applies to sessions of users belonging to the contract's partner.\n- `user_groups` - Applies to sessions of users in the listed user groups. Requires `userGroupIds`.\n- `ad_hoc_users` - Applies to sessions of ad hoc (unregistered) users.\n- `users_of_specific_partners` - Applies to sessions of users belonging to the listed partners. Requires `partnerIds`.\n",
|
|
84442
|
+
"enum": [
|
|
84443
|
+
"users_of_the_partner",
|
|
84444
|
+
"user_groups",
|
|
84445
|
+
"ad_hoc_users",
|
|
84446
|
+
"users_of_specific_partners"
|
|
84447
|
+
]
|
|
84448
|
+
},
|
|
84449
|
+
"targetIds": {
|
|
84450
|
+
"type": "array",
|
|
84451
|
+
"description": "Identifiers of the records the override applies to, as determined by `type`: user group IDs\nfor `user_groups` and partner IDs for `users_of_specific_partners`. Required for those two\ntypes and omitted for every other type.\n",
|
|
84452
|
+
"items": {
|
|
84453
|
+
"type": "integer"
|
|
84454
|
+
},
|
|
84455
|
+
"example": [
|
|
84456
|
+
12,
|
|
84457
|
+
34
|
|
84458
|
+
]
|
|
84459
|
+
}
|
|
84460
|
+
}
|
|
84461
|
+
},
|
|
84462
|
+
"acPercent": {
|
|
84463
|
+
"type": "number",
|
|
84464
|
+
"format": "float",
|
|
84465
|
+
"nullable": true,
|
|
84466
|
+
"minimum": 0,
|
|
84467
|
+
"maximum": 100,
|
|
84468
|
+
"description": "Partner share percentage applied to AC sessions matched by this override.\n`null` means the value is inherited from the partner contract.\n",
|
|
84469
|
+
"example": 70.5
|
|
84470
|
+
},
|
|
84471
|
+
"dcPercent": {
|
|
84472
|
+
"type": "number",
|
|
84473
|
+
"format": "float",
|
|
84474
|
+
"nullable": true,
|
|
84475
|
+
"minimum": 0,
|
|
84476
|
+
"maximum": 100,
|
|
84477
|
+
"description": "Partner share percentage applied to DC sessions matched by this override.\n`null` means the value is inherited from the partner contract.\n",
|
|
84478
|
+
"example": 60
|
|
84479
|
+
}
|
|
84480
|
+
}
|
|
84481
|
+
}
|
|
84146
84482
|
}
|
|
84147
84483
|
},
|
|
84148
84484
|
"required": [
|
|
@@ -84430,6 +84766,90 @@
|
|
|
84430
84766
|
"format": "date-time",
|
|
84431
84767
|
"description": "ISO 8601 formatted date",
|
|
84432
84768
|
"readOnly": true
|
|
84769
|
+
},
|
|
84770
|
+
"settlementOverrides": {
|
|
84771
|
+
"type": "array",
|
|
84772
|
+
"description": "⚠️ Experimental — not yet a stable contract. The embedded settlement override objects may change without a version bump, including breaking changes within `v1.0` itself. Consume them for evaluation only, or coordinate adoption with your account manager so changes can be sequenced with you.\n\nActive settlement overrides of the contract, newest first. Returned only by `GET /public-api/resources/partner-contracts/v1.0/{partnerContract}` and only when requested through `include[]=settlementOverrides`. The listing, create and update responses never carry this property, because they do not accept the `include` parameter — read the overrides of a contract through `GET /public-api/resources/partner-contracts/v1.0/{partnerContract}/settlement-overrides` instead.\n",
|
|
84773
|
+
"items": {
|
|
84774
|
+
"description": "⚠️ Experimental endpoint — not yet a stable contract. This resource ships as experimental / beta. While experimental, its schema and behaviour may change without a version bump — including breaking changes within v1.0 itself. Anyone consuming it does so for evaluation only, or by coordinating adoption with their account manager so changes can be sequenced with them. It graduates to a stable, version-locked contract (where the normal breaking-change rules apply) only when this experimental notice is removed.\n\nSettlement override read schema. Each record scopes an AC / DC partner share percentage to one driver population on the partner contract; the contract's own settlement fields remain the default rule.\n",
|
|
84775
|
+
"type": "object",
|
|
84776
|
+
"required": [
|
|
84777
|
+
"id",
|
|
84778
|
+
"name",
|
|
84779
|
+
"priority",
|
|
84780
|
+
"restriction",
|
|
84781
|
+
"acPercent",
|
|
84782
|
+
"dcPercent"
|
|
84783
|
+
],
|
|
84784
|
+
"properties": {
|
|
84785
|
+
"name": {
|
|
84786
|
+
"type": "string",
|
|
84787
|
+
"maxLength": 255,
|
|
84788
|
+
"description": "Name of the settlement override, unique among the active overrides of the partner contract.",
|
|
84789
|
+
"example": "Fleet drivers"
|
|
84790
|
+
},
|
|
84791
|
+
"priority": {
|
|
84792
|
+
"type": "integer",
|
|
84793
|
+
"minimum": 1,
|
|
84794
|
+
"maximum": 4294967295,
|
|
84795
|
+
"description": "Evaluation priority of the override, unique among the active overrides of the partner contract.\nThe lowest value that matches a session wins.\n",
|
|
84796
|
+
"example": 1
|
|
84797
|
+
},
|
|
84798
|
+
"id": {
|
|
84799
|
+
"type": "integer",
|
|
84800
|
+
"description": "Unique identifier for the settlement override",
|
|
84801
|
+
"example": 123
|
|
84802
|
+
},
|
|
84803
|
+
"restriction": {
|
|
84804
|
+
"type": "object",
|
|
84805
|
+
"description": "Which users of the partner contract the override applies to. `type` is the discriminator and\ndetermines what `targetIds` references.\n",
|
|
84806
|
+
"required": [
|
|
84807
|
+
"type"
|
|
84808
|
+
],
|
|
84809
|
+
"properties": {
|
|
84810
|
+
"type": {
|
|
84811
|
+
"type": "string",
|
|
84812
|
+
"description": "Which users of the partner contract the settlement override applies to.\n\nAllowed values:\n- `users_of_the_partner` - Applies to sessions of users belonging to the contract's partner.\n- `user_groups` - Applies to sessions of users in the listed user groups. Requires `userGroupIds`.\n- `ad_hoc_users` - Applies to sessions of ad hoc (unregistered) users.\n- `users_of_specific_partners` - Applies to sessions of users belonging to the listed partners. Requires `partnerIds`.\n",
|
|
84813
|
+
"enum": [
|
|
84814
|
+
"users_of_the_partner",
|
|
84815
|
+
"user_groups",
|
|
84816
|
+
"ad_hoc_users",
|
|
84817
|
+
"users_of_specific_partners"
|
|
84818
|
+
]
|
|
84819
|
+
},
|
|
84820
|
+
"targetIds": {
|
|
84821
|
+
"type": "array",
|
|
84822
|
+
"description": "Identifiers of the records the override applies to, as determined by `type`: user group IDs\nfor `user_groups` and partner IDs for `users_of_specific_partners`. Required for those two\ntypes and omitted for every other type.\n",
|
|
84823
|
+
"items": {
|
|
84824
|
+
"type": "integer"
|
|
84825
|
+
},
|
|
84826
|
+
"example": [
|
|
84827
|
+
12,
|
|
84828
|
+
34
|
|
84829
|
+
]
|
|
84830
|
+
}
|
|
84831
|
+
}
|
|
84832
|
+
},
|
|
84833
|
+
"acPercent": {
|
|
84834
|
+
"type": "number",
|
|
84835
|
+
"format": "float",
|
|
84836
|
+
"nullable": true,
|
|
84837
|
+
"minimum": 0,
|
|
84838
|
+
"maximum": 100,
|
|
84839
|
+
"description": "Partner share percentage applied to AC sessions matched by this override.\n`null` means the value is inherited from the partner contract.\n",
|
|
84840
|
+
"example": 70.5
|
|
84841
|
+
},
|
|
84842
|
+
"dcPercent": {
|
|
84843
|
+
"type": "number",
|
|
84844
|
+
"format": "float",
|
|
84845
|
+
"nullable": true,
|
|
84846
|
+
"minimum": 0,
|
|
84847
|
+
"maximum": 100,
|
|
84848
|
+
"description": "Partner share percentage applied to DC sessions matched by this override.\n`null` means the value is inherited from the partner contract.\n",
|
|
84849
|
+
"example": 60
|
|
84850
|
+
}
|
|
84851
|
+
}
|
|
84852
|
+
}
|
|
84433
84853
|
}
|
|
84434
84854
|
},
|
|
84435
84855
|
"required": [
|
|
@@ -84507,6 +84927,764 @@
|
|
|
84507
84927
|
}
|
|
84508
84928
|
}
|
|
84509
84929
|
},
|
|
84930
|
+
"partnerContractSettlementOverridesListing": {
|
|
84931
|
+
"200": {
|
|
84932
|
+
"schema": {
|
|
84933
|
+
"type": "object",
|
|
84934
|
+
"properties": {
|
|
84935
|
+
"data": {
|
|
84936
|
+
"type": "array",
|
|
84937
|
+
"items": {
|
|
84938
|
+
"description": "⚠️ Experimental endpoint — not yet a stable contract. This resource ships as experimental / beta. While experimental, its schema and behaviour may change without a version bump — including breaking changes within v1.0 itself. Anyone consuming it does so for evaluation only, or by coordinating adoption with their account manager so changes can be sequenced with them. It graduates to a stable, version-locked contract (where the normal breaking-change rules apply) only when this experimental notice is removed.\n\nSettlement override read schema. Each record scopes an AC / DC partner share percentage to one driver population on the partner contract; the contract's own settlement fields remain the default rule.\n",
|
|
84939
|
+
"type": "object",
|
|
84940
|
+
"required": [
|
|
84941
|
+
"id",
|
|
84942
|
+
"name",
|
|
84943
|
+
"priority",
|
|
84944
|
+
"restriction",
|
|
84945
|
+
"acPercent",
|
|
84946
|
+
"dcPercent"
|
|
84947
|
+
],
|
|
84948
|
+
"properties": {
|
|
84949
|
+
"name": {
|
|
84950
|
+
"type": "string",
|
|
84951
|
+
"maxLength": 255,
|
|
84952
|
+
"description": "Name of the settlement override, unique among the active overrides of the partner contract.",
|
|
84953
|
+
"example": "Fleet drivers"
|
|
84954
|
+
},
|
|
84955
|
+
"priority": {
|
|
84956
|
+
"type": "integer",
|
|
84957
|
+
"minimum": 1,
|
|
84958
|
+
"maximum": 4294967295,
|
|
84959
|
+
"description": "Evaluation priority of the override, unique among the active overrides of the partner contract.\nThe lowest value that matches a session wins.\n",
|
|
84960
|
+
"example": 1
|
|
84961
|
+
},
|
|
84962
|
+
"id": {
|
|
84963
|
+
"type": "integer",
|
|
84964
|
+
"description": "Unique identifier for the settlement override",
|
|
84965
|
+
"example": 123
|
|
84966
|
+
},
|
|
84967
|
+
"restriction": {
|
|
84968
|
+
"type": "object",
|
|
84969
|
+
"description": "Which users of the partner contract the override applies to. `type` is the discriminator and\ndetermines what `targetIds` references.\n",
|
|
84970
|
+
"required": [
|
|
84971
|
+
"type"
|
|
84972
|
+
],
|
|
84973
|
+
"properties": {
|
|
84974
|
+
"type": {
|
|
84975
|
+
"type": "string",
|
|
84976
|
+
"description": "Which users of the partner contract the settlement override applies to.\n\nAllowed values:\n- `users_of_the_partner` - Applies to sessions of users belonging to the contract's partner.\n- `user_groups` - Applies to sessions of users in the listed user groups. Requires `userGroupIds`.\n- `ad_hoc_users` - Applies to sessions of ad hoc (unregistered) users.\n- `users_of_specific_partners` - Applies to sessions of users belonging to the listed partners. Requires `partnerIds`.\n",
|
|
84977
|
+
"enum": [
|
|
84978
|
+
"users_of_the_partner",
|
|
84979
|
+
"user_groups",
|
|
84980
|
+
"ad_hoc_users",
|
|
84981
|
+
"users_of_specific_partners"
|
|
84982
|
+
]
|
|
84983
|
+
},
|
|
84984
|
+
"targetIds": {
|
|
84985
|
+
"type": "array",
|
|
84986
|
+
"description": "Identifiers of the records the override applies to, as determined by `type`: user group IDs\nfor `user_groups` and partner IDs for `users_of_specific_partners`. Required for those two\ntypes and omitted for every other type.\n",
|
|
84987
|
+
"items": {
|
|
84988
|
+
"type": "integer"
|
|
84989
|
+
},
|
|
84990
|
+
"example": [
|
|
84991
|
+
12,
|
|
84992
|
+
34
|
|
84993
|
+
]
|
|
84994
|
+
}
|
|
84995
|
+
}
|
|
84996
|
+
},
|
|
84997
|
+
"acPercent": {
|
|
84998
|
+
"type": "number",
|
|
84999
|
+
"format": "float",
|
|
85000
|
+
"nullable": true,
|
|
85001
|
+
"minimum": 0,
|
|
85002
|
+
"maximum": 100,
|
|
85003
|
+
"description": "Partner share percentage applied to AC sessions matched by this override.\n`null` means the value is inherited from the partner contract.\n",
|
|
85004
|
+
"example": 70.5
|
|
85005
|
+
},
|
|
85006
|
+
"dcPercent": {
|
|
85007
|
+
"type": "number",
|
|
85008
|
+
"format": "float",
|
|
85009
|
+
"nullable": true,
|
|
85010
|
+
"minimum": 0,
|
|
85011
|
+
"maximum": 100,
|
|
85012
|
+
"description": "Partner share percentage applied to DC sessions matched by this override.\n`null` means the value is inherited from the partner contract.\n",
|
|
85013
|
+
"example": 60
|
|
85014
|
+
}
|
|
85015
|
+
}
|
|
85016
|
+
}
|
|
85017
|
+
},
|
|
85018
|
+
"links": {
|
|
85019
|
+
"type": "object",
|
|
85020
|
+
"properties": {
|
|
85021
|
+
"first": {
|
|
85022
|
+
"type": "string",
|
|
85023
|
+
"description": "The URL to fetch the first page",
|
|
85024
|
+
"nullable": true
|
|
85025
|
+
},
|
|
85026
|
+
"last": {
|
|
85027
|
+
"type": "string",
|
|
85028
|
+
"description": "The URL to fetch the last page",
|
|
85029
|
+
"nullable": true
|
|
85030
|
+
},
|
|
85031
|
+
"prev": {
|
|
85032
|
+
"type": "string",
|
|
85033
|
+
"description": "The URL to fetch the previous page",
|
|
85034
|
+
"nullable": true
|
|
85035
|
+
},
|
|
85036
|
+
"next": {
|
|
85037
|
+
"type": "string",
|
|
85038
|
+
"description": "The URL to fetch the next page. Use this link always in order to utilize the cursor pagination",
|
|
85039
|
+
"nullable": true
|
|
85040
|
+
}
|
|
85041
|
+
}
|
|
85042
|
+
},
|
|
85043
|
+
"meta": {
|
|
85044
|
+
"type": "object",
|
|
85045
|
+
"properties": {
|
|
85046
|
+
"path": {
|
|
85047
|
+
"type": "string",
|
|
85048
|
+
"description": "The base route of the endpoint (unpaginated)"
|
|
85049
|
+
},
|
|
85050
|
+
"per_page": {
|
|
85051
|
+
"type": "integer",
|
|
85052
|
+
"description": "The max number of items in each page"
|
|
85053
|
+
},
|
|
85054
|
+
"next_cursor": {
|
|
85055
|
+
"type": "string",
|
|
85056
|
+
"description": "The cursor to fetch the next page. Do not use this directly. It will be populated by using the previous response's links.next.",
|
|
85057
|
+
"nullable": true
|
|
85058
|
+
},
|
|
85059
|
+
"prev_cursor": {
|
|
85060
|
+
"type": "string",
|
|
85061
|
+
"description": "The cursor to fetch the previous page. Do not use this directly. It will be populated by using the previous response's links.prev.",
|
|
85062
|
+
"nullable": true
|
|
85063
|
+
}
|
|
85064
|
+
}
|
|
85065
|
+
}
|
|
85066
|
+
}
|
|
85067
|
+
}
|
|
85068
|
+
},
|
|
85069
|
+
"401": {
|
|
85070
|
+
"schema": {
|
|
85071
|
+
"type": "object",
|
|
85072
|
+
"properties": {
|
|
85073
|
+
"message": {
|
|
85074
|
+
"type": "string"
|
|
85075
|
+
}
|
|
85076
|
+
}
|
|
85077
|
+
}
|
|
85078
|
+
},
|
|
85079
|
+
"403": {
|
|
85080
|
+
"schema": {
|
|
85081
|
+
"type": "object",
|
|
85082
|
+
"properties": {
|
|
85083
|
+
"message": {
|
|
85084
|
+
"type": "string",
|
|
85085
|
+
"default": "This action is unauthorized."
|
|
85086
|
+
}
|
|
85087
|
+
}
|
|
85088
|
+
}
|
|
85089
|
+
},
|
|
85090
|
+
"404": {
|
|
85091
|
+
"schema": {
|
|
85092
|
+
"type": "object",
|
|
85093
|
+
"properties": {
|
|
85094
|
+
"message": {
|
|
85095
|
+
"type": "string"
|
|
85096
|
+
}
|
|
85097
|
+
}
|
|
85098
|
+
}
|
|
85099
|
+
},
|
|
85100
|
+
"429": {
|
|
85101
|
+
"schema": {
|
|
85102
|
+
"type": "object",
|
|
85103
|
+
"properties": {
|
|
85104
|
+
"message": {
|
|
85105
|
+
"type": "string"
|
|
85106
|
+
}
|
|
85107
|
+
}
|
|
85108
|
+
}
|
|
85109
|
+
}
|
|
85110
|
+
},
|
|
85111
|
+
"partnerContractSettlementOverrideCreate": {
|
|
85112
|
+
"201": {
|
|
85113
|
+
"schema": {
|
|
85114
|
+
"type": "object",
|
|
85115
|
+
"properties": {
|
|
85116
|
+
"data": {
|
|
85117
|
+
"description": "⚠️ Experimental endpoint — not yet a stable contract. This resource ships as experimental / beta. While experimental, its schema and behaviour may change without a version bump — including breaking changes within v1.0 itself. Anyone consuming it does so for evaluation only, or by coordinating adoption with their account manager so changes can be sequenced with them. It graduates to a stable, version-locked contract (where the normal breaking-change rules apply) only when this experimental notice is removed.\n\nSettlement override read schema. Each record scopes an AC / DC partner share percentage to one driver population on the partner contract; the contract's own settlement fields remain the default rule.\n",
|
|
85118
|
+
"type": "object",
|
|
85119
|
+
"required": [
|
|
85120
|
+
"id",
|
|
85121
|
+
"name",
|
|
85122
|
+
"priority",
|
|
85123
|
+
"restriction",
|
|
85124
|
+
"acPercent",
|
|
85125
|
+
"dcPercent"
|
|
85126
|
+
],
|
|
85127
|
+
"properties": {
|
|
85128
|
+
"name": {
|
|
85129
|
+
"type": "string",
|
|
85130
|
+
"maxLength": 255,
|
|
85131
|
+
"description": "Name of the settlement override, unique among the active overrides of the partner contract.",
|
|
85132
|
+
"example": "Fleet drivers"
|
|
85133
|
+
},
|
|
85134
|
+
"priority": {
|
|
85135
|
+
"type": "integer",
|
|
85136
|
+
"minimum": 1,
|
|
85137
|
+
"maximum": 4294967295,
|
|
85138
|
+
"description": "Evaluation priority of the override, unique among the active overrides of the partner contract.\nThe lowest value that matches a session wins.\n",
|
|
85139
|
+
"example": 1
|
|
85140
|
+
},
|
|
85141
|
+
"id": {
|
|
85142
|
+
"type": "integer",
|
|
85143
|
+
"description": "Unique identifier for the settlement override",
|
|
85144
|
+
"example": 123
|
|
85145
|
+
},
|
|
85146
|
+
"restriction": {
|
|
85147
|
+
"type": "object",
|
|
85148
|
+
"description": "Which users of the partner contract the override applies to. `type` is the discriminator and\ndetermines what `targetIds` references.\n",
|
|
85149
|
+
"required": [
|
|
85150
|
+
"type"
|
|
85151
|
+
],
|
|
85152
|
+
"properties": {
|
|
85153
|
+
"type": {
|
|
85154
|
+
"type": "string",
|
|
85155
|
+
"description": "Which users of the partner contract the settlement override applies to.\n\nAllowed values:\n- `users_of_the_partner` - Applies to sessions of users belonging to the contract's partner.\n- `user_groups` - Applies to sessions of users in the listed user groups. Requires `userGroupIds`.\n- `ad_hoc_users` - Applies to sessions of ad hoc (unregistered) users.\n- `users_of_specific_partners` - Applies to sessions of users belonging to the listed partners. Requires `partnerIds`.\n",
|
|
85156
|
+
"enum": [
|
|
85157
|
+
"users_of_the_partner",
|
|
85158
|
+
"user_groups",
|
|
85159
|
+
"ad_hoc_users",
|
|
85160
|
+
"users_of_specific_partners"
|
|
85161
|
+
]
|
|
85162
|
+
},
|
|
85163
|
+
"targetIds": {
|
|
85164
|
+
"type": "array",
|
|
85165
|
+
"description": "Identifiers of the records the override applies to, as determined by `type`: user group IDs\nfor `user_groups` and partner IDs for `users_of_specific_partners`. Required for those two\ntypes and omitted for every other type.\n",
|
|
85166
|
+
"items": {
|
|
85167
|
+
"type": "integer"
|
|
85168
|
+
},
|
|
85169
|
+
"example": [
|
|
85170
|
+
12,
|
|
85171
|
+
34
|
|
85172
|
+
]
|
|
85173
|
+
}
|
|
85174
|
+
}
|
|
85175
|
+
},
|
|
85176
|
+
"acPercent": {
|
|
85177
|
+
"type": "number",
|
|
85178
|
+
"format": "float",
|
|
85179
|
+
"nullable": true,
|
|
85180
|
+
"minimum": 0,
|
|
85181
|
+
"maximum": 100,
|
|
85182
|
+
"description": "Partner share percentage applied to AC sessions matched by this override.\n`null` means the value is inherited from the partner contract.\n",
|
|
85183
|
+
"example": 70.5
|
|
85184
|
+
},
|
|
85185
|
+
"dcPercent": {
|
|
85186
|
+
"type": "number",
|
|
85187
|
+
"format": "float",
|
|
85188
|
+
"nullable": true,
|
|
85189
|
+
"minimum": 0,
|
|
85190
|
+
"maximum": 100,
|
|
85191
|
+
"description": "Partner share percentage applied to DC sessions matched by this override.\n`null` means the value is inherited from the partner contract.\n",
|
|
85192
|
+
"example": 60
|
|
85193
|
+
}
|
|
85194
|
+
}
|
|
85195
|
+
}
|
|
85196
|
+
}
|
|
85197
|
+
}
|
|
85198
|
+
},
|
|
85199
|
+
"401": {
|
|
85200
|
+
"schema": {
|
|
85201
|
+
"type": "object",
|
|
85202
|
+
"properties": {
|
|
85203
|
+
"message": {
|
|
85204
|
+
"type": "string"
|
|
85205
|
+
}
|
|
85206
|
+
}
|
|
85207
|
+
}
|
|
85208
|
+
},
|
|
85209
|
+
"403": {
|
|
85210
|
+
"schema": {
|
|
85211
|
+
"type": "object",
|
|
85212
|
+
"properties": {
|
|
85213
|
+
"message": {
|
|
85214
|
+
"type": "string",
|
|
85215
|
+
"default": "This action is unauthorized."
|
|
85216
|
+
}
|
|
85217
|
+
}
|
|
85218
|
+
}
|
|
85219
|
+
},
|
|
85220
|
+
"404": {
|
|
85221
|
+
"schema": {
|
|
85222
|
+
"type": "object",
|
|
85223
|
+
"properties": {
|
|
85224
|
+
"message": {
|
|
85225
|
+
"type": "string"
|
|
85226
|
+
}
|
|
85227
|
+
}
|
|
85228
|
+
}
|
|
85229
|
+
},
|
|
85230
|
+
"409": {
|
|
85231
|
+
"schema": {
|
|
85232
|
+
"type": "object",
|
|
85233
|
+
"required": [
|
|
85234
|
+
"errorCode"
|
|
85235
|
+
],
|
|
85236
|
+
"properties": {
|
|
85237
|
+
"message": {
|
|
85238
|
+
"type": "string"
|
|
85239
|
+
},
|
|
85240
|
+
"errorCode": {
|
|
85241
|
+
"type": "string",
|
|
85242
|
+
"description": "Machine-readable error code describing the conflict.\n\nAllowed values:\n- `override_priority_taken` - Another active override on the same partner contract already uses the requested priority.\n",
|
|
85243
|
+
"enum": [
|
|
85244
|
+
"override_priority_taken"
|
|
85245
|
+
]
|
|
85246
|
+
}
|
|
85247
|
+
}
|
|
85248
|
+
}
|
|
85249
|
+
},
|
|
85250
|
+
"412": {
|
|
85251
|
+
"schema": {
|
|
85252
|
+
"type": "object",
|
|
85253
|
+
"required": [
|
|
85254
|
+
"errorCode"
|
|
85255
|
+
],
|
|
85256
|
+
"properties": {
|
|
85257
|
+
"message": {
|
|
85258
|
+
"type": "string"
|
|
85259
|
+
},
|
|
85260
|
+
"errorCode": {
|
|
85261
|
+
"type": "string",
|
|
85262
|
+
"description": "Machine-readable error code describing the unmet precondition.\n\nAllowed values:\n- `settlement_overrides_not_enabled` - Settlement overrides are not enabled for the operator owning the partner contract.\n",
|
|
85263
|
+
"enum": [
|
|
85264
|
+
"settlement_overrides_not_enabled"
|
|
85265
|
+
]
|
|
85266
|
+
}
|
|
85267
|
+
}
|
|
85268
|
+
}
|
|
85269
|
+
},
|
|
85270
|
+
"422": {
|
|
85271
|
+
"schema": {
|
|
85272
|
+
"type": "object",
|
|
85273
|
+
"required": [
|
|
85274
|
+
"message"
|
|
85275
|
+
],
|
|
85276
|
+
"properties": {
|
|
85277
|
+
"message": {
|
|
85278
|
+
"type": "string"
|
|
85279
|
+
},
|
|
85280
|
+
"errors": {
|
|
85281
|
+
"type": "object",
|
|
85282
|
+
"additionalProperties": {
|
|
85283
|
+
"type": "array",
|
|
85284
|
+
"items": {
|
|
85285
|
+
"type": "string"
|
|
85286
|
+
}
|
|
85287
|
+
}
|
|
85288
|
+
}
|
|
85289
|
+
}
|
|
85290
|
+
}
|
|
85291
|
+
},
|
|
85292
|
+
"429": {
|
|
85293
|
+
"schema": {
|
|
85294
|
+
"type": "object",
|
|
85295
|
+
"properties": {
|
|
85296
|
+
"message": {
|
|
85297
|
+
"type": "string"
|
|
85298
|
+
}
|
|
85299
|
+
}
|
|
85300
|
+
}
|
|
85301
|
+
}
|
|
85302
|
+
},
|
|
85303
|
+
"partnerContractSettlementOverrideRead": {
|
|
85304
|
+
"200": {
|
|
85305
|
+
"schema": {
|
|
85306
|
+
"type": "object",
|
|
85307
|
+
"properties": {
|
|
85308
|
+
"data": {
|
|
85309
|
+
"description": "⚠️ Experimental endpoint — not yet a stable contract. This resource ships as experimental / beta. While experimental, its schema and behaviour may change without a version bump — including breaking changes within v1.0 itself. Anyone consuming it does so for evaluation only, or by coordinating adoption with their account manager so changes can be sequenced with them. It graduates to a stable, version-locked contract (where the normal breaking-change rules apply) only when this experimental notice is removed.\n\nSettlement override read schema. Each record scopes an AC / DC partner share percentage to one driver population on the partner contract; the contract's own settlement fields remain the default rule.\n",
|
|
85310
|
+
"type": "object",
|
|
85311
|
+
"required": [
|
|
85312
|
+
"id",
|
|
85313
|
+
"name",
|
|
85314
|
+
"priority",
|
|
85315
|
+
"restriction",
|
|
85316
|
+
"acPercent",
|
|
85317
|
+
"dcPercent"
|
|
85318
|
+
],
|
|
85319
|
+
"properties": {
|
|
85320
|
+
"name": {
|
|
85321
|
+
"type": "string",
|
|
85322
|
+
"maxLength": 255,
|
|
85323
|
+
"description": "Name of the settlement override, unique among the active overrides of the partner contract.",
|
|
85324
|
+
"example": "Fleet drivers"
|
|
85325
|
+
},
|
|
85326
|
+
"priority": {
|
|
85327
|
+
"type": "integer",
|
|
85328
|
+
"minimum": 1,
|
|
85329
|
+
"maximum": 4294967295,
|
|
85330
|
+
"description": "Evaluation priority of the override, unique among the active overrides of the partner contract.\nThe lowest value that matches a session wins.\n",
|
|
85331
|
+
"example": 1
|
|
85332
|
+
},
|
|
85333
|
+
"id": {
|
|
85334
|
+
"type": "integer",
|
|
85335
|
+
"description": "Unique identifier for the settlement override",
|
|
85336
|
+
"example": 123
|
|
85337
|
+
},
|
|
85338
|
+
"restriction": {
|
|
85339
|
+
"type": "object",
|
|
85340
|
+
"description": "Which users of the partner contract the override applies to. `type` is the discriminator and\ndetermines what `targetIds` references.\n",
|
|
85341
|
+
"required": [
|
|
85342
|
+
"type"
|
|
85343
|
+
],
|
|
85344
|
+
"properties": {
|
|
85345
|
+
"type": {
|
|
85346
|
+
"type": "string",
|
|
85347
|
+
"description": "Which users of the partner contract the settlement override applies to.\n\nAllowed values:\n- `users_of_the_partner` - Applies to sessions of users belonging to the contract's partner.\n- `user_groups` - Applies to sessions of users in the listed user groups. Requires `userGroupIds`.\n- `ad_hoc_users` - Applies to sessions of ad hoc (unregistered) users.\n- `users_of_specific_partners` - Applies to sessions of users belonging to the listed partners. Requires `partnerIds`.\n",
|
|
85348
|
+
"enum": [
|
|
85349
|
+
"users_of_the_partner",
|
|
85350
|
+
"user_groups",
|
|
85351
|
+
"ad_hoc_users",
|
|
85352
|
+
"users_of_specific_partners"
|
|
85353
|
+
]
|
|
85354
|
+
},
|
|
85355
|
+
"targetIds": {
|
|
85356
|
+
"type": "array",
|
|
85357
|
+
"description": "Identifiers of the records the override applies to, as determined by `type`: user group IDs\nfor `user_groups` and partner IDs for `users_of_specific_partners`. Required for those two\ntypes and omitted for every other type.\n",
|
|
85358
|
+
"items": {
|
|
85359
|
+
"type": "integer"
|
|
85360
|
+
},
|
|
85361
|
+
"example": [
|
|
85362
|
+
12,
|
|
85363
|
+
34
|
|
85364
|
+
]
|
|
85365
|
+
}
|
|
85366
|
+
}
|
|
85367
|
+
},
|
|
85368
|
+
"acPercent": {
|
|
85369
|
+
"type": "number",
|
|
85370
|
+
"format": "float",
|
|
85371
|
+
"nullable": true,
|
|
85372
|
+
"minimum": 0,
|
|
85373
|
+
"maximum": 100,
|
|
85374
|
+
"description": "Partner share percentage applied to AC sessions matched by this override.\n`null` means the value is inherited from the partner contract.\n",
|
|
85375
|
+
"example": 70.5
|
|
85376
|
+
},
|
|
85377
|
+
"dcPercent": {
|
|
85378
|
+
"type": "number",
|
|
85379
|
+
"format": "float",
|
|
85380
|
+
"nullable": true,
|
|
85381
|
+
"minimum": 0,
|
|
85382
|
+
"maximum": 100,
|
|
85383
|
+
"description": "Partner share percentage applied to DC sessions matched by this override.\n`null` means the value is inherited from the partner contract.\n",
|
|
85384
|
+
"example": 60
|
|
85385
|
+
}
|
|
85386
|
+
}
|
|
85387
|
+
}
|
|
85388
|
+
}
|
|
85389
|
+
}
|
|
85390
|
+
},
|
|
85391
|
+
"401": {
|
|
85392
|
+
"schema": {
|
|
85393
|
+
"type": "object",
|
|
85394
|
+
"properties": {
|
|
85395
|
+
"message": {
|
|
85396
|
+
"type": "string"
|
|
85397
|
+
}
|
|
85398
|
+
}
|
|
85399
|
+
}
|
|
85400
|
+
},
|
|
85401
|
+
"403": {
|
|
85402
|
+
"schema": {
|
|
85403
|
+
"type": "object",
|
|
85404
|
+
"properties": {
|
|
85405
|
+
"message": {
|
|
85406
|
+
"type": "string",
|
|
85407
|
+
"default": "This action is unauthorized."
|
|
85408
|
+
}
|
|
85409
|
+
}
|
|
85410
|
+
}
|
|
85411
|
+
},
|
|
85412
|
+
"404": {
|
|
85413
|
+
"schema": {
|
|
85414
|
+
"type": "object",
|
|
85415
|
+
"properties": {
|
|
85416
|
+
"message": {
|
|
85417
|
+
"type": "string"
|
|
85418
|
+
}
|
|
85419
|
+
}
|
|
85420
|
+
}
|
|
85421
|
+
},
|
|
85422
|
+
"429": {
|
|
85423
|
+
"schema": {
|
|
85424
|
+
"type": "object",
|
|
85425
|
+
"properties": {
|
|
85426
|
+
"message": {
|
|
85427
|
+
"type": "string"
|
|
85428
|
+
}
|
|
85429
|
+
}
|
|
85430
|
+
}
|
|
85431
|
+
}
|
|
85432
|
+
},
|
|
85433
|
+
"partnerContractSettlementOverrideDelete": {
|
|
85434
|
+
"401": {
|
|
85435
|
+
"schema": {
|
|
85436
|
+
"type": "object",
|
|
85437
|
+
"properties": {
|
|
85438
|
+
"message": {
|
|
85439
|
+
"type": "string"
|
|
85440
|
+
}
|
|
85441
|
+
}
|
|
85442
|
+
}
|
|
85443
|
+
},
|
|
85444
|
+
"403": {
|
|
85445
|
+
"schema": {
|
|
85446
|
+
"type": "object",
|
|
85447
|
+
"properties": {
|
|
85448
|
+
"message": {
|
|
85449
|
+
"type": "string",
|
|
85450
|
+
"default": "This action is unauthorized."
|
|
85451
|
+
}
|
|
85452
|
+
}
|
|
85453
|
+
}
|
|
85454
|
+
},
|
|
85455
|
+
"404": {
|
|
85456
|
+
"schema": {
|
|
85457
|
+
"type": "object",
|
|
85458
|
+
"properties": {
|
|
85459
|
+
"message": {
|
|
85460
|
+
"type": "string"
|
|
85461
|
+
}
|
|
85462
|
+
}
|
|
85463
|
+
}
|
|
85464
|
+
},
|
|
85465
|
+
"412": {
|
|
85466
|
+
"schema": {
|
|
85467
|
+
"type": "object",
|
|
85468
|
+
"required": [
|
|
85469
|
+
"errorCode"
|
|
85470
|
+
],
|
|
85471
|
+
"properties": {
|
|
85472
|
+
"message": {
|
|
85473
|
+
"type": "string"
|
|
85474
|
+
},
|
|
85475
|
+
"errorCode": {
|
|
85476
|
+
"type": "string",
|
|
85477
|
+
"description": "Machine-readable error code describing the unmet precondition.\n\nAllowed values:\n- `settlement_overrides_not_enabled` - Settlement overrides are not enabled for the operator owning the partner contract.\n",
|
|
85478
|
+
"enum": [
|
|
85479
|
+
"settlement_overrides_not_enabled"
|
|
85480
|
+
]
|
|
85481
|
+
}
|
|
85482
|
+
}
|
|
85483
|
+
}
|
|
85484
|
+
},
|
|
85485
|
+
"429": {
|
|
85486
|
+
"schema": {
|
|
85487
|
+
"type": "object",
|
|
85488
|
+
"properties": {
|
|
85489
|
+
"message": {
|
|
85490
|
+
"type": "string"
|
|
85491
|
+
}
|
|
85492
|
+
}
|
|
85493
|
+
}
|
|
85494
|
+
}
|
|
85495
|
+
},
|
|
85496
|
+
"partnerContractSettlementOverrideUpdate": {
|
|
85497
|
+
"200": {
|
|
85498
|
+
"schema": {
|
|
85499
|
+
"type": "object",
|
|
85500
|
+
"properties": {
|
|
85501
|
+
"data": {
|
|
85502
|
+
"description": "⚠️ Experimental endpoint — not yet a stable contract. This resource ships as experimental / beta. While experimental, its schema and behaviour may change without a version bump — including breaking changes within v1.0 itself. Anyone consuming it does so for evaluation only, or by coordinating adoption with their account manager so changes can be sequenced with them. It graduates to a stable, version-locked contract (where the normal breaking-change rules apply) only when this experimental notice is removed.\n\nSettlement override read schema. Each record scopes an AC / DC partner share percentage to one driver population on the partner contract; the contract's own settlement fields remain the default rule.\n",
|
|
85503
|
+
"type": "object",
|
|
85504
|
+
"required": [
|
|
85505
|
+
"id",
|
|
85506
|
+
"name",
|
|
85507
|
+
"priority",
|
|
85508
|
+
"restriction",
|
|
85509
|
+
"acPercent",
|
|
85510
|
+
"dcPercent"
|
|
85511
|
+
],
|
|
85512
|
+
"properties": {
|
|
85513
|
+
"name": {
|
|
85514
|
+
"type": "string",
|
|
85515
|
+
"maxLength": 255,
|
|
85516
|
+
"description": "Name of the settlement override, unique among the active overrides of the partner contract.",
|
|
85517
|
+
"example": "Fleet drivers"
|
|
85518
|
+
},
|
|
85519
|
+
"priority": {
|
|
85520
|
+
"type": "integer",
|
|
85521
|
+
"minimum": 1,
|
|
85522
|
+
"maximum": 4294967295,
|
|
85523
|
+
"description": "Evaluation priority of the override, unique among the active overrides of the partner contract.\nThe lowest value that matches a session wins.\n",
|
|
85524
|
+
"example": 1
|
|
85525
|
+
},
|
|
85526
|
+
"id": {
|
|
85527
|
+
"type": "integer",
|
|
85528
|
+
"description": "Unique identifier for the settlement override",
|
|
85529
|
+
"example": 123
|
|
85530
|
+
},
|
|
85531
|
+
"restriction": {
|
|
85532
|
+
"type": "object",
|
|
85533
|
+
"description": "Which users of the partner contract the override applies to. `type` is the discriminator and\ndetermines what `targetIds` references.\n",
|
|
85534
|
+
"required": [
|
|
85535
|
+
"type"
|
|
85536
|
+
],
|
|
85537
|
+
"properties": {
|
|
85538
|
+
"type": {
|
|
85539
|
+
"type": "string",
|
|
85540
|
+
"description": "Which users of the partner contract the settlement override applies to.\n\nAllowed values:\n- `users_of_the_partner` - Applies to sessions of users belonging to the contract's partner.\n- `user_groups` - Applies to sessions of users in the listed user groups. Requires `userGroupIds`.\n- `ad_hoc_users` - Applies to sessions of ad hoc (unregistered) users.\n- `users_of_specific_partners` - Applies to sessions of users belonging to the listed partners. Requires `partnerIds`.\n",
|
|
85541
|
+
"enum": [
|
|
85542
|
+
"users_of_the_partner",
|
|
85543
|
+
"user_groups",
|
|
85544
|
+
"ad_hoc_users",
|
|
85545
|
+
"users_of_specific_partners"
|
|
85546
|
+
]
|
|
85547
|
+
},
|
|
85548
|
+
"targetIds": {
|
|
85549
|
+
"type": "array",
|
|
85550
|
+
"description": "Identifiers of the records the override applies to, as determined by `type`: user group IDs\nfor `user_groups` and partner IDs for `users_of_specific_partners`. Required for those two\ntypes and omitted for every other type.\n",
|
|
85551
|
+
"items": {
|
|
85552
|
+
"type": "integer"
|
|
85553
|
+
},
|
|
85554
|
+
"example": [
|
|
85555
|
+
12,
|
|
85556
|
+
34
|
|
85557
|
+
]
|
|
85558
|
+
}
|
|
85559
|
+
}
|
|
85560
|
+
},
|
|
85561
|
+
"acPercent": {
|
|
85562
|
+
"type": "number",
|
|
85563
|
+
"format": "float",
|
|
85564
|
+
"nullable": true,
|
|
85565
|
+
"minimum": 0,
|
|
85566
|
+
"maximum": 100,
|
|
85567
|
+
"description": "Partner share percentage applied to AC sessions matched by this override.\n`null` means the value is inherited from the partner contract.\n",
|
|
85568
|
+
"example": 70.5
|
|
85569
|
+
},
|
|
85570
|
+
"dcPercent": {
|
|
85571
|
+
"type": "number",
|
|
85572
|
+
"format": "float",
|
|
85573
|
+
"nullable": true,
|
|
85574
|
+
"minimum": 0,
|
|
85575
|
+
"maximum": 100,
|
|
85576
|
+
"description": "Partner share percentage applied to DC sessions matched by this override.\n`null` means the value is inherited from the partner contract.\n",
|
|
85577
|
+
"example": 60
|
|
85578
|
+
}
|
|
85579
|
+
}
|
|
85580
|
+
}
|
|
85581
|
+
}
|
|
85582
|
+
}
|
|
85583
|
+
},
|
|
85584
|
+
"401": {
|
|
85585
|
+
"schema": {
|
|
85586
|
+
"type": "object",
|
|
85587
|
+
"properties": {
|
|
85588
|
+
"message": {
|
|
85589
|
+
"type": "string"
|
|
85590
|
+
}
|
|
85591
|
+
}
|
|
85592
|
+
}
|
|
85593
|
+
},
|
|
85594
|
+
"403": {
|
|
85595
|
+
"schema": {
|
|
85596
|
+
"type": "object",
|
|
85597
|
+
"properties": {
|
|
85598
|
+
"message": {
|
|
85599
|
+
"type": "string",
|
|
85600
|
+
"default": "This action is unauthorized."
|
|
85601
|
+
}
|
|
85602
|
+
}
|
|
85603
|
+
}
|
|
85604
|
+
},
|
|
85605
|
+
"404": {
|
|
85606
|
+
"schema": {
|
|
85607
|
+
"type": "object",
|
|
85608
|
+
"properties": {
|
|
85609
|
+
"message": {
|
|
85610
|
+
"type": "string"
|
|
85611
|
+
}
|
|
85612
|
+
}
|
|
85613
|
+
}
|
|
85614
|
+
},
|
|
85615
|
+
"409": {
|
|
85616
|
+
"schema": {
|
|
85617
|
+
"type": "object",
|
|
85618
|
+
"required": [
|
|
85619
|
+
"errorCode"
|
|
85620
|
+
],
|
|
85621
|
+
"properties": {
|
|
85622
|
+
"message": {
|
|
85623
|
+
"type": "string"
|
|
85624
|
+
},
|
|
85625
|
+
"errorCode": {
|
|
85626
|
+
"type": "string",
|
|
85627
|
+
"description": "Machine-readable error code describing the conflict.\n\nAllowed values:\n- `override_priority_taken` - Another active override on the same partner contract already uses the requested priority.\n",
|
|
85628
|
+
"enum": [
|
|
85629
|
+
"override_priority_taken"
|
|
85630
|
+
]
|
|
85631
|
+
}
|
|
85632
|
+
}
|
|
85633
|
+
}
|
|
85634
|
+
},
|
|
85635
|
+
"412": {
|
|
85636
|
+
"schema": {
|
|
85637
|
+
"type": "object",
|
|
85638
|
+
"required": [
|
|
85639
|
+
"errorCode"
|
|
85640
|
+
],
|
|
85641
|
+
"properties": {
|
|
85642
|
+
"message": {
|
|
85643
|
+
"type": "string"
|
|
85644
|
+
},
|
|
85645
|
+
"errorCode": {
|
|
85646
|
+
"type": "string",
|
|
85647
|
+
"description": "Machine-readable error code describing the unmet precondition.\n\nAllowed values:\n- `settlement_overrides_not_enabled` - Settlement overrides are not enabled for the operator owning the partner contract.\n",
|
|
85648
|
+
"enum": [
|
|
85649
|
+
"settlement_overrides_not_enabled"
|
|
85650
|
+
]
|
|
85651
|
+
}
|
|
85652
|
+
}
|
|
85653
|
+
}
|
|
85654
|
+
},
|
|
85655
|
+
"422": {
|
|
85656
|
+
"schema": {
|
|
85657
|
+
"type": "object",
|
|
85658
|
+
"required": [
|
|
85659
|
+
"message"
|
|
85660
|
+
],
|
|
85661
|
+
"properties": {
|
|
85662
|
+
"message": {
|
|
85663
|
+
"type": "string"
|
|
85664
|
+
},
|
|
85665
|
+
"errors": {
|
|
85666
|
+
"type": "object",
|
|
85667
|
+
"additionalProperties": {
|
|
85668
|
+
"type": "array",
|
|
85669
|
+
"items": {
|
|
85670
|
+
"type": "string"
|
|
85671
|
+
}
|
|
85672
|
+
}
|
|
85673
|
+
}
|
|
85674
|
+
}
|
|
85675
|
+
}
|
|
85676
|
+
},
|
|
85677
|
+
"429": {
|
|
85678
|
+
"schema": {
|
|
85679
|
+
"type": "object",
|
|
85680
|
+
"properties": {
|
|
85681
|
+
"message": {
|
|
85682
|
+
"type": "string"
|
|
85683
|
+
}
|
|
85684
|
+
}
|
|
85685
|
+
}
|
|
85686
|
+
}
|
|
85687
|
+
},
|
|
84510
85688
|
"expensesListingDeprecated": {
|
|
84511
85689
|
"200": {
|
|
84512
85690
|
"schema": {
|
|
@@ -92345,7 +93523,7 @@
|
|
|
92345
93523
|
"ga-IE",
|
|
92346
93524
|
"bs",
|
|
92347
93525
|
"ja",
|
|
92348
|
-
"ko",
|
|
93526
|
+
"ko-KR",
|
|
92349
93527
|
"cs",
|
|
92350
93528
|
"lv",
|
|
92351
93529
|
"et",
|
|
@@ -92656,7 +93834,7 @@
|
|
|
92656
93834
|
"ga-IE",
|
|
92657
93835
|
"bs",
|
|
92658
93836
|
"ja",
|
|
92659
|
-
"ko",
|
|
93837
|
+
"ko-KR",
|
|
92660
93838
|
"cs",
|
|
92661
93839
|
"lv",
|
|
92662
93840
|
"et",
|
|
@@ -92918,7 +94096,7 @@
|
|
|
92918
94096
|
"ga-IE",
|
|
92919
94097
|
"bs",
|
|
92920
94098
|
"ja",
|
|
92921
|
-
"ko",
|
|
94099
|
+
"ko-KR",
|
|
92922
94100
|
"cs",
|
|
92923
94101
|
"lv",
|
|
92924
94102
|
"et",
|
|
@@ -93211,7 +94389,7 @@
|
|
|
93211
94389
|
"ga-IE",
|
|
93212
94390
|
"bs",
|
|
93213
94391
|
"ja",
|
|
93214
|
-
"ko",
|
|
94392
|
+
"ko-KR",
|
|
93215
94393
|
"cs",
|
|
93216
94394
|
"lv",
|
|
93217
94395
|
"et",
|
|
@@ -100246,7 +101424,7 @@
|
|
|
100246
101424
|
"ga-IE",
|
|
100247
101425
|
"bs",
|
|
100248
101426
|
"ja",
|
|
100249
|
-
"ko",
|
|
101427
|
+
"ko-KR",
|
|
100250
101428
|
"cs",
|
|
100251
101429
|
"lv",
|
|
100252
101430
|
"et",
|
|
@@ -101487,7 +102665,7 @@
|
|
|
101487
102665
|
"ga-IE",
|
|
101488
102666
|
"bs",
|
|
101489
102667
|
"ja",
|
|
101490
|
-
"ko",
|
|
102668
|
+
"ko-KR",
|
|
101491
102669
|
"cs",
|
|
101492
102670
|
"lv",
|
|
101493
102671
|
"et",
|
|
@@ -102603,7 +103781,7 @@
|
|
|
102603
103781
|
"ga-IE",
|
|
102604
103782
|
"bs",
|
|
102605
103783
|
"ja",
|
|
102606
|
-
"ko",
|
|
103784
|
+
"ko-KR",
|
|
102607
103785
|
"cs",
|
|
102608
103786
|
"lv",
|
|
102609
103787
|
"et",
|
|
@@ -103782,7 +104960,7 @@
|
|
|
103782
104960
|
"ga-IE",
|
|
103783
104961
|
"bs",
|
|
103784
104962
|
"ja",
|
|
103785
|
-
"ko",
|
|
104963
|
+
"ko-KR",
|
|
103786
104964
|
"cs",
|
|
103787
104965
|
"lv",
|
|
103788
104966
|
"et",
|
|
@@ -120131,7 +121309,7 @@
|
|
|
120131
121309
|
},
|
|
120132
121310
|
"partnerContractId": {
|
|
120133
121311
|
"type": "integer",
|
|
120134
|
-
"description": "Partner contract the policy is scoped to.
|
|
121312
|
+
"description": "Partner contract the policy is scoped to. Required whenever `partnerId` is set, and must belong to that partner. Policies without a partner are not scoped to a contract."
|
|
120135
121313
|
},
|
|
120136
121314
|
"electricityRateId": {
|
|
120137
121315
|
"type": "integer",
|
|
@@ -120321,7 +121499,7 @@
|
|
|
120321
121499
|
},
|
|
120322
121500
|
"partnerContractId": {
|
|
120323
121501
|
"type": "integer",
|
|
120324
|
-
"description": "Partner contract the policy is scoped to.
|
|
121502
|
+
"description": "Partner contract the policy is scoped to. Required whenever `partnerId` is set, and must belong to that partner. Policies without a partner are not scoped to a contract."
|
|
120325
121503
|
},
|
|
120326
121504
|
"electricityRateId": {
|
|
120327
121505
|
"type": "integer",
|
|
@@ -120452,7 +121630,7 @@
|
|
|
120452
121630
|
},
|
|
120453
121631
|
"partnerContractId": {
|
|
120454
121632
|
"type": "integer",
|
|
120455
|
-
"description": "Partner contract the policy is scoped to.
|
|
121633
|
+
"description": "Partner contract the policy is scoped to. Required whenever `partnerId` is set, and must belong to that partner. Policies without a partner are not scoped to a contract."
|
|
120456
121634
|
},
|
|
120457
121635
|
"electricityRateId": {
|
|
120458
121636
|
"type": "integer",
|
|
@@ -120646,7 +121824,7 @@
|
|
|
120646
121824
|
},
|
|
120647
121825
|
"partnerContractId": {
|
|
120648
121826
|
"type": "integer",
|
|
120649
|
-
"description": "Partner contract the policy is scoped to.
|
|
121827
|
+
"description": "Partner contract the policy is scoped to. Required whenever `partnerId` is set, and must belong to that partner. Policies without a partner are not scoped to a contract."
|
|
120650
121828
|
},
|
|
120651
121829
|
"electricityRateId": {
|
|
120652
121830
|
"type": "integer",
|
|
@@ -139463,6 +140641,11 @@
|
|
|
139463
140641
|
"type": "string",
|
|
139464
140642
|
"maxLength": 150,
|
|
139465
140643
|
"description": "The information that would be shown on the display of the charge point when offline."
|
|
140644
|
+
},
|
|
140645
|
+
"totalCostFallbackMessage": {
|
|
140646
|
+
"type": "string",
|
|
140647
|
+
"maxLength": 150,
|
|
140648
|
+
"description": "The message shown on the charge point screen when a session ends but the final cost cannot be retrieved."
|
|
139466
140649
|
}
|
|
139467
140650
|
}
|
|
139468
140651
|
},
|
|
@@ -139700,6 +140883,11 @@
|
|
|
139700
140883
|
"type": "string",
|
|
139701
140884
|
"maxLength": 150,
|
|
139702
140885
|
"description": "The information that would be shown on the display of the charge point when offline."
|
|
140886
|
+
},
|
|
140887
|
+
"totalCostFallbackMessage": {
|
|
140888
|
+
"type": "string",
|
|
140889
|
+
"maxLength": 150,
|
|
140890
|
+
"description": "The message shown on the charge point screen when a session ends but the final cost cannot be retrieved."
|
|
139703
140891
|
}
|
|
139704
140892
|
}
|
|
139705
140893
|
},
|
|
@@ -139822,6 +141010,11 @@
|
|
|
139822
141010
|
"type": "string",
|
|
139823
141011
|
"maxLength": 150,
|
|
139824
141012
|
"description": "The information that would be shown on the display of the charge point when offline."
|
|
141013
|
+
},
|
|
141014
|
+
"totalCostFallbackMessage": {
|
|
141015
|
+
"type": "string",
|
|
141016
|
+
"maxLength": 150,
|
|
141017
|
+
"description": "The message shown on the charge point screen when a session ends but the final cost cannot be retrieved."
|
|
139825
141018
|
}
|
|
139826
141019
|
}
|
|
139827
141020
|
},
|
|
@@ -139932,6 +141125,11 @@
|
|
|
139932
141125
|
"type": "string",
|
|
139933
141126
|
"maxLength": 150,
|
|
139934
141127
|
"description": "The information that would be shown on the display of the charge point when offline."
|
|
141128
|
+
},
|
|
141129
|
+
"totalCostFallbackMessage": {
|
|
141130
|
+
"type": "string",
|
|
141131
|
+
"maxLength": 150,
|
|
141132
|
+
"description": "The message shown on the charge point screen when a session ends but the final cost cannot be retrieved."
|
|
139935
141133
|
}
|
|
139936
141134
|
}
|
|
139937
141135
|
},
|