@flowio/api-mock-generator 6.17.70 → 6.17.72
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/api.json +367 -3
- package/package.json +2 -2
- package/src/api.json +367 -3
package/dist/api.json
CHANGED
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
"key": "api"
|
|
11
11
|
},
|
|
12
12
|
"namespace": "io.flow.v0",
|
|
13
|
-
"version": "0.18.
|
|
13
|
+
"version": "0.18.16",
|
|
14
14
|
"info": {
|
|
15
15
|
"license": {
|
|
16
16
|
"name": "MIT",
|
|
@@ -76,7 +76,7 @@
|
|
|
76
76
|
"application": {
|
|
77
77
|
"key": "ben-test-internal"
|
|
78
78
|
},
|
|
79
|
-
"version": "0.21.
|
|
79
|
+
"version": "0.21.45",
|
|
80
80
|
"enums": [],
|
|
81
81
|
"interfaces": ["generate_load"],
|
|
82
82
|
"unions": ["generate_load"],
|
|
@@ -5140,6 +5140,9 @@
|
|
|
5140
5140
|
}, {
|
|
5141
5141
|
"name": "shipping_label_service",
|
|
5142
5142
|
"attributes": []
|
|
5143
|
+
}, {
|
|
5144
|
+
"name": "shipping_label_revenue_share",
|
|
5145
|
+
"attributes": []
|
|
5143
5146
|
}, {
|
|
5144
5147
|
"name": "trueup",
|
|
5145
5148
|
"attributes": []
|
|
@@ -5147,7 +5150,7 @@
|
|
|
5147
5150
|
"name": "carrier_charge",
|
|
5148
5151
|
"attributes": []
|
|
5149
5152
|
}, {
|
|
5150
|
-
"name": "
|
|
5153
|
+
"name": "carrier_charge_revenue_share",
|
|
5151
5154
|
"attributes": []
|
|
5152
5155
|
}, {
|
|
5153
5156
|
"name": "platform_fee",
|
|
@@ -6081,6 +6084,12 @@
|
|
|
6081
6084
|
"attributes": [],
|
|
6082
6085
|
"annotations": [],
|
|
6083
6086
|
"description": "Globally unique identifier"
|
|
6087
|
+
}, {
|
|
6088
|
+
"name": "account",
|
|
6089
|
+
"type": "account_id_reference",
|
|
6090
|
+
"required": true,
|
|
6091
|
+
"attributes": [],
|
|
6092
|
+
"annotations": []
|
|
6084
6093
|
}, {
|
|
6085
6094
|
"name": "metadata",
|
|
6086
6095
|
"type": "transaction_metadata",
|
|
@@ -9694,6 +9703,19 @@
|
|
|
9694
9703
|
}],
|
|
9695
9704
|
"attributes": [],
|
|
9696
9705
|
"interfaces": []
|
|
9706
|
+
}, {
|
|
9707
|
+
"name": "account_id_reference",
|
|
9708
|
+
"plural": "account_id_references",
|
|
9709
|
+
"fields": [{
|
|
9710
|
+
"name": "id",
|
|
9711
|
+
"type": "string",
|
|
9712
|
+
"required": true,
|
|
9713
|
+
"attributes": [],
|
|
9714
|
+
"annotations": [],
|
|
9715
|
+
"description": "Globally unique identifier"
|
|
9716
|
+
}],
|
|
9717
|
+
"attributes": [],
|
|
9718
|
+
"interfaces": []
|
|
9697
9719
|
}, {
|
|
9698
9720
|
"name": "account_orders_export_type",
|
|
9699
9721
|
"plural": "account_orders_export_types",
|
|
@@ -16630,6 +16652,12 @@
|
|
|
16630
16652
|
"attributes": [],
|
|
16631
16653
|
"annotations": [],
|
|
16632
16654
|
"description": "Globally unique identifier"
|
|
16655
|
+
}, {
|
|
16656
|
+
"name": "account",
|
|
16657
|
+
"type": "account_id_reference",
|
|
16658
|
+
"required": true,
|
|
16659
|
+
"attributes": [],
|
|
16660
|
+
"annotations": []
|
|
16633
16661
|
}, {
|
|
16634
16662
|
"name": "metadata",
|
|
16635
16663
|
"type": "transaction_metadata",
|
|
@@ -24022,6 +24050,122 @@
|
|
|
24022
24050
|
}],
|
|
24023
24051
|
"attributes": [],
|
|
24024
24052
|
"interfaces": []
|
|
24053
|
+
}, {
|
|
24054
|
+
"name": "flow_transaction",
|
|
24055
|
+
"plural": "flow_transactions",
|
|
24056
|
+
"fields": [{
|
|
24057
|
+
"name": "statement",
|
|
24058
|
+
"type": "billing_channel_statement_reference",
|
|
24059
|
+
"required": false,
|
|
24060
|
+
"attributes": [],
|
|
24061
|
+
"annotations": []
|
|
24062
|
+
}, {
|
|
24063
|
+
"name": "id",
|
|
24064
|
+
"type": "string",
|
|
24065
|
+
"required": true,
|
|
24066
|
+
"attributes": [],
|
|
24067
|
+
"annotations": [],
|
|
24068
|
+
"description": "Globally unique identifier"
|
|
24069
|
+
}, {
|
|
24070
|
+
"name": "account",
|
|
24071
|
+
"type": "account_id_reference",
|
|
24072
|
+
"required": true,
|
|
24073
|
+
"attributes": [],
|
|
24074
|
+
"annotations": []
|
|
24075
|
+
}, {
|
|
24076
|
+
"name": "metadata",
|
|
24077
|
+
"type": "transaction_metadata",
|
|
24078
|
+
"required": false,
|
|
24079
|
+
"attributes": [],
|
|
24080
|
+
"annotations": []
|
|
24081
|
+
}, {
|
|
24082
|
+
"name": "order",
|
|
24083
|
+
"type": "billing_channel_order_summary",
|
|
24084
|
+
"required": false,
|
|
24085
|
+
"attributes": [],
|
|
24086
|
+
"annotations": []
|
|
24087
|
+
}, {
|
|
24088
|
+
"name": "payment_request",
|
|
24089
|
+
"type": "billing_channel_payment_request_reference",
|
|
24090
|
+
"required": false,
|
|
24091
|
+
"attributes": [],
|
|
24092
|
+
"annotations": []
|
|
24093
|
+
}, {
|
|
24094
|
+
"name": "currency",
|
|
24095
|
+
"type": "string",
|
|
24096
|
+
"required": true,
|
|
24097
|
+
"attributes": [],
|
|
24098
|
+
"annotations": []
|
|
24099
|
+
}, {
|
|
24100
|
+
"name": "source",
|
|
24101
|
+
"type": "transaction_source",
|
|
24102
|
+
"required": true,
|
|
24103
|
+
"attributes": [],
|
|
24104
|
+
"annotations": []
|
|
24105
|
+
}, {
|
|
24106
|
+
"name": "parent",
|
|
24107
|
+
"type": "parent_transaction_summary",
|
|
24108
|
+
"required": false,
|
|
24109
|
+
"attributes": [],
|
|
24110
|
+
"annotations": []
|
|
24111
|
+
}, {
|
|
24112
|
+
"name": "gross",
|
|
24113
|
+
"type": "decimal",
|
|
24114
|
+
"required": true,
|
|
24115
|
+
"attributes": [],
|
|
24116
|
+
"annotations": []
|
|
24117
|
+
}, {
|
|
24118
|
+
"name": "fees",
|
|
24119
|
+
"type": "[fee_deduction]",
|
|
24120
|
+
"required": true,
|
|
24121
|
+
"attributes": [],
|
|
24122
|
+
"annotations": [],
|
|
24123
|
+
"default": "[]"
|
|
24124
|
+
}, {
|
|
24125
|
+
"name": "withholdings",
|
|
24126
|
+
"type": "[withholding_deduction]",
|
|
24127
|
+
"required": true,
|
|
24128
|
+
"attributes": [],
|
|
24129
|
+
"annotations": [],
|
|
24130
|
+
"default": "[]"
|
|
24131
|
+
}, {
|
|
24132
|
+
"name": "discounts",
|
|
24133
|
+
"type": "[billing_discount]",
|
|
24134
|
+
"required": true,
|
|
24135
|
+
"attributes": [],
|
|
24136
|
+
"annotations": [],
|
|
24137
|
+
"default": "[]"
|
|
24138
|
+
}, {
|
|
24139
|
+
"name": "net",
|
|
24140
|
+
"type": "decimal",
|
|
24141
|
+
"required": true,
|
|
24142
|
+
"attributes": [],
|
|
24143
|
+
"annotations": [],
|
|
24144
|
+
"description": "net = gross -fees - withholdings"
|
|
24145
|
+
}, {
|
|
24146
|
+
"name": "identifiers",
|
|
24147
|
+
"type": "map[string]",
|
|
24148
|
+
"required": true,
|
|
24149
|
+
"attributes": [],
|
|
24150
|
+
"annotations": [],
|
|
24151
|
+
"description": "We serialize any transaction level identifiers as key/value pairs here",
|
|
24152
|
+
"default": "{}"
|
|
24153
|
+
}, {
|
|
24154
|
+
"name": "created_at",
|
|
24155
|
+
"type": "date-time-iso8601",
|
|
24156
|
+
"required": true,
|
|
24157
|
+
"attributes": [],
|
|
24158
|
+
"annotations": []
|
|
24159
|
+
}, {
|
|
24160
|
+
"name": "updated_at",
|
|
24161
|
+
"type": "date-time-iso8601",
|
|
24162
|
+
"required": true,
|
|
24163
|
+
"attributes": [],
|
|
24164
|
+
"annotations": []
|
|
24165
|
+
}],
|
|
24166
|
+
"attributes": [],
|
|
24167
|
+
"interfaces": ["generic_transaction"],
|
|
24168
|
+
"description": "Provides internal access to all transactions"
|
|
24025
24169
|
}, {
|
|
24026
24170
|
"name": "fraud_email_rule",
|
|
24027
24171
|
"plural": "fraud_email_rules",
|
|
@@ -31335,6 +31479,12 @@
|
|
|
31335
31479
|
"required": false,
|
|
31336
31480
|
"attributes": [],
|
|
31337
31481
|
"annotations": []
|
|
31482
|
+
}, {
|
|
31483
|
+
"name": "deactivate_at",
|
|
31484
|
+
"type": "date-time-iso8601",
|
|
31485
|
+
"required": false,
|
|
31486
|
+
"attributes": [],
|
|
31487
|
+
"annotations": []
|
|
31338
31488
|
}],
|
|
31339
31489
|
"attributes": [],
|
|
31340
31490
|
"interfaces": [],
|
|
@@ -40102,6 +40252,12 @@
|
|
|
40102
40252
|
"attributes": [],
|
|
40103
40253
|
"annotations": [],
|
|
40104
40254
|
"description": "Globally unique identifier"
|
|
40255
|
+
}, {
|
|
40256
|
+
"name": "account",
|
|
40257
|
+
"type": "account_id_reference",
|
|
40258
|
+
"required": true,
|
|
40259
|
+
"attributes": [],
|
|
40260
|
+
"annotations": []
|
|
40105
40261
|
}, {
|
|
40106
40262
|
"name": "metadata",
|
|
40107
40263
|
"type": "transaction_metadata",
|
|
@@ -53383,6 +53539,12 @@
|
|
|
53383
53539
|
"attributes": [],
|
|
53384
53540
|
"annotations": [],
|
|
53385
53541
|
"description": "Globally unique identifier"
|
|
53542
|
+
}, {
|
|
53543
|
+
"name": "account",
|
|
53544
|
+
"type": "account_id_reference",
|
|
53545
|
+
"required": true,
|
|
53546
|
+
"attributes": [],
|
|
53547
|
+
"annotations": []
|
|
53386
53548
|
}, {
|
|
53387
53549
|
"name": "metadata",
|
|
53388
53550
|
"type": "transaction_metadata",
|
|
@@ -53530,6 +53692,13 @@
|
|
|
53530
53692
|
"required": true,
|
|
53531
53693
|
"attributes": [],
|
|
53532
53694
|
"annotations": []
|
|
53695
|
+
}, {
|
|
53696
|
+
"name": "revenue_share_percentage",
|
|
53697
|
+
"type": "decimal",
|
|
53698
|
+
"required": true,
|
|
53699
|
+
"attributes": [],
|
|
53700
|
+
"annotations": [],
|
|
53701
|
+
"description": "Percentage of revenue a channel should receive from shipments made on this ratecard. Omitted when none. Values are expressed as '0.0295' to represent '2.95%'"
|
|
53533
53702
|
}, {
|
|
53534
53703
|
"name": "outbound",
|
|
53535
53704
|
"type": "transaction_metadata_carrier_charge_outbound",
|
|
@@ -83332,6 +83501,11 @@
|
|
|
83332
83501
|
"type": "string",
|
|
83333
83502
|
"location": "Query",
|
|
83334
83503
|
"required": false
|
|
83504
|
+
}, {
|
|
83505
|
+
"name": "order_number",
|
|
83506
|
+
"type": "string",
|
|
83507
|
+
"location": "Query",
|
|
83508
|
+
"required": false
|
|
83335
83509
|
}, {
|
|
83336
83510
|
"name": "since",
|
|
83337
83511
|
"type": "date-time-iso8601",
|
|
@@ -87761,6 +87935,191 @@
|
|
|
87761
87935
|
}],
|
|
87762
87936
|
"path": "/permission",
|
|
87763
87937
|
"description": "Default user roles supported by Flow"
|
|
87938
|
+
}, {
|
|
87939
|
+
"type": "flow_transaction",
|
|
87940
|
+
"plural": "flow_transactions",
|
|
87941
|
+
"operations": [{
|
|
87942
|
+
"method": "GET",
|
|
87943
|
+
"path": "/internal/billing/transactions",
|
|
87944
|
+
"parameters": [{
|
|
87945
|
+
"name": "id",
|
|
87946
|
+
"type": "[string]",
|
|
87947
|
+
"location": "Query",
|
|
87948
|
+
"required": false,
|
|
87949
|
+
"description": "Filter by one or more IDs of this resource",
|
|
87950
|
+
"maximum": 100
|
|
87951
|
+
}, {
|
|
87952
|
+
"name": "source_type",
|
|
87953
|
+
"type": "string",
|
|
87954
|
+
"location": "Query",
|
|
87955
|
+
"required": false
|
|
87956
|
+
}, {
|
|
87957
|
+
"name": "source_id",
|
|
87958
|
+
"type": "string",
|
|
87959
|
+
"location": "Query",
|
|
87960
|
+
"required": false
|
|
87961
|
+
}, {
|
|
87962
|
+
"name": "order_organization_id",
|
|
87963
|
+
"type": "string",
|
|
87964
|
+
"location": "Query",
|
|
87965
|
+
"required": false
|
|
87966
|
+
}, {
|
|
87967
|
+
"name": "statement_id",
|
|
87968
|
+
"type": "string",
|
|
87969
|
+
"location": "Query",
|
|
87970
|
+
"required": false
|
|
87971
|
+
}, {
|
|
87972
|
+
"name": "order_number",
|
|
87973
|
+
"type": "string",
|
|
87974
|
+
"location": "Query",
|
|
87975
|
+
"required": false
|
|
87976
|
+
}, {
|
|
87977
|
+
"name": "since",
|
|
87978
|
+
"type": "date-time-iso8601",
|
|
87979
|
+
"location": "Query",
|
|
87980
|
+
"required": false,
|
|
87981
|
+
"description": "If specified, we return all transactions where created_at >= the provided timestamp"
|
|
87982
|
+
}, {
|
|
87983
|
+
"name": "updated_since",
|
|
87984
|
+
"type": "date-time-iso8601",
|
|
87985
|
+
"location": "Query",
|
|
87986
|
+
"required": false,
|
|
87987
|
+
"description": "If specified, we return all transactions where updated_at >= the provided timestamp"
|
|
87988
|
+
}, {
|
|
87989
|
+
"name": "limit",
|
|
87990
|
+
"type": "long",
|
|
87991
|
+
"location": "Query",
|
|
87992
|
+
"required": true,
|
|
87993
|
+
"description": "The maximum number of results to return",
|
|
87994
|
+
"default": "25",
|
|
87995
|
+
"minimum": 1,
|
|
87996
|
+
"maximum": 100
|
|
87997
|
+
}, {
|
|
87998
|
+
"name": "offset",
|
|
87999
|
+
"type": "long",
|
|
88000
|
+
"location": "Query",
|
|
88001
|
+
"required": true,
|
|
88002
|
+
"description": "The number of results to skip before returning results",
|
|
88003
|
+
"default": "0",
|
|
88004
|
+
"minimum": 0
|
|
88005
|
+
}, {
|
|
88006
|
+
"name": "sort",
|
|
88007
|
+
"type": "string",
|
|
88008
|
+
"location": "Query",
|
|
88009
|
+
"required": true,
|
|
88010
|
+
"default": "-created_at"
|
|
88011
|
+
}],
|
|
88012
|
+
"responses": [{
|
|
88013
|
+
"code": {
|
|
88014
|
+
"integer": {
|
|
88015
|
+
"value": 200
|
|
88016
|
+
}
|
|
88017
|
+
},
|
|
88018
|
+
"type": "[flow_transaction]",
|
|
88019
|
+
"description": "Successful response",
|
|
88020
|
+
"attributes": []
|
|
88021
|
+
}, {
|
|
88022
|
+
"code": {
|
|
88023
|
+
"integer": {
|
|
88024
|
+
"value": 401
|
|
88025
|
+
}
|
|
88026
|
+
},
|
|
88027
|
+
"type": "unit",
|
|
88028
|
+
"description": "Authorization failed",
|
|
88029
|
+
"attributes": []
|
|
88030
|
+
}, {
|
|
88031
|
+
"code": {
|
|
88032
|
+
"integer": {
|
|
88033
|
+
"value": 404
|
|
88034
|
+
}
|
|
88035
|
+
},
|
|
88036
|
+
"type": "unit",
|
|
88037
|
+
"description": "Resource was not found",
|
|
88038
|
+
"attributes": []
|
|
88039
|
+
}, {
|
|
88040
|
+
"code": {
|
|
88041
|
+
"integer": {
|
|
88042
|
+
"value": 422
|
|
88043
|
+
}
|
|
88044
|
+
},
|
|
88045
|
+
"type": "generic_error",
|
|
88046
|
+
"description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.",
|
|
88047
|
+
"attributes": []
|
|
88048
|
+
}],
|
|
88049
|
+
"attributes": [{
|
|
88050
|
+
"name": "sort",
|
|
88051
|
+
"value": {
|
|
88052
|
+
"values": [{
|
|
88053
|
+
"value": "id"
|
|
88054
|
+
}, {
|
|
88055
|
+
"value": "created_at"
|
|
88056
|
+
}, {
|
|
88057
|
+
"value": "updated_at"
|
|
88058
|
+
}]
|
|
88059
|
+
}
|
|
88060
|
+
}, {
|
|
88061
|
+
"name": "linter",
|
|
88062
|
+
"value": {
|
|
88063
|
+
"ignore": ["versions"]
|
|
88064
|
+
}
|
|
88065
|
+
}]
|
|
88066
|
+
}, {
|
|
88067
|
+
"method": "GET",
|
|
88068
|
+
"path": "/internal/billing/transactions/:id",
|
|
88069
|
+
"parameters": [{
|
|
88070
|
+
"name": "id",
|
|
88071
|
+
"type": "string",
|
|
88072
|
+
"location": "Path",
|
|
88073
|
+
"required": true,
|
|
88074
|
+
"description": "Filter by one or more IDs of this resource"
|
|
88075
|
+
}],
|
|
88076
|
+
"responses": [{
|
|
88077
|
+
"code": {
|
|
88078
|
+
"integer": {
|
|
88079
|
+
"value": 200
|
|
88080
|
+
}
|
|
88081
|
+
},
|
|
88082
|
+
"type": "flow_transaction",
|
|
88083
|
+
"description": "Successful response",
|
|
88084
|
+
"attributes": []
|
|
88085
|
+
}, {
|
|
88086
|
+
"code": {
|
|
88087
|
+
"integer": {
|
|
88088
|
+
"value": 401
|
|
88089
|
+
}
|
|
88090
|
+
},
|
|
88091
|
+
"type": "unit",
|
|
88092
|
+
"description": "Authorization failed",
|
|
88093
|
+
"attributes": []
|
|
88094
|
+
}, {
|
|
88095
|
+
"code": {
|
|
88096
|
+
"integer": {
|
|
88097
|
+
"value": 404
|
|
88098
|
+
}
|
|
88099
|
+
},
|
|
88100
|
+
"type": "unit",
|
|
88101
|
+
"description": "Resource was not found",
|
|
88102
|
+
"attributes": []
|
|
88103
|
+
}, {
|
|
88104
|
+
"code": {
|
|
88105
|
+
"integer": {
|
|
88106
|
+
"value": 422
|
|
88107
|
+
}
|
|
88108
|
+
},
|
|
88109
|
+
"type": "generic_error",
|
|
88110
|
+
"description": "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.",
|
|
88111
|
+
"attributes": []
|
|
88112
|
+
}],
|
|
88113
|
+
"attributes": []
|
|
88114
|
+
}],
|
|
88115
|
+
"attributes": [{
|
|
88116
|
+
"name": "docs",
|
|
88117
|
+
"value": {
|
|
88118
|
+
"module": "general"
|
|
88119
|
+
}
|
|
88120
|
+
}],
|
|
88121
|
+
"path": "/internal/billing/transactions",
|
|
88122
|
+
"description": "Provides internal access to all transactions"
|
|
87764
88123
|
}, {
|
|
87765
88124
|
"type": "fraud_email_rule",
|
|
87766
88125
|
"plural": "fraud_email_rules",
|
|
@@ -99388,6 +99747,11 @@
|
|
|
99388
99747
|
"type": "string",
|
|
99389
99748
|
"location": "Query",
|
|
99390
99749
|
"required": false
|
|
99750
|
+
}, {
|
|
99751
|
+
"name": "order_number",
|
|
99752
|
+
"type": "string",
|
|
99753
|
+
"location": "Query",
|
|
99754
|
+
"required": false
|
|
99391
99755
|
}, {
|
|
99392
99756
|
"name": "since",
|
|
99393
99757
|
"type": "date-time-iso8601",
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@flowio/api-mock-generator",
|
|
3
|
-
"version": "6.17.
|
|
3
|
+
"version": "6.17.72",
|
|
4
4
|
"description": "A mock data generator based on our API specifications for JavaScript",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"flowcommerce",
|
|
@@ -28,5 +28,5 @@
|
|
|
28
28
|
"apibuilder-js": "0.0.13",
|
|
29
29
|
"apibuilder-mock-generator": "0.0.13"
|
|
30
30
|
},
|
|
31
|
-
"gitHead": "
|
|
31
|
+
"gitHead": "5fe142f9c051bfc6d8266e2debef0a86210b1e43"
|
|
32
32
|
}
|
package/src/api.json
CHANGED
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
"key" : "api"
|
|
11
11
|
},
|
|
12
12
|
"namespace" : "io.flow.v0",
|
|
13
|
-
"version" : "0.18.
|
|
13
|
+
"version" : "0.18.16",
|
|
14
14
|
"info" : {
|
|
15
15
|
"license" : {
|
|
16
16
|
"name" : "MIT",
|
|
@@ -76,7 +76,7 @@
|
|
|
76
76
|
"application" : {
|
|
77
77
|
"key" : "ben-test-internal"
|
|
78
78
|
},
|
|
79
|
-
"version" : "0.21.
|
|
79
|
+
"version" : "0.21.45",
|
|
80
80
|
"enums" : [ ],
|
|
81
81
|
"interfaces" : [ "generate_load" ],
|
|
82
82
|
"unions" : [ "generate_load" ],
|
|
@@ -5140,6 +5140,9 @@
|
|
|
5140
5140
|
}, {
|
|
5141
5141
|
"name" : "shipping_label_service",
|
|
5142
5142
|
"attributes" : [ ]
|
|
5143
|
+
}, {
|
|
5144
|
+
"name" : "shipping_label_revenue_share",
|
|
5145
|
+
"attributes" : [ ]
|
|
5143
5146
|
}, {
|
|
5144
5147
|
"name" : "trueup",
|
|
5145
5148
|
"attributes" : [ ]
|
|
@@ -5147,7 +5150,7 @@
|
|
|
5147
5150
|
"name" : "carrier_charge",
|
|
5148
5151
|
"attributes" : [ ]
|
|
5149
5152
|
}, {
|
|
5150
|
-
"name" : "
|
|
5153
|
+
"name" : "carrier_charge_revenue_share",
|
|
5151
5154
|
"attributes" : [ ]
|
|
5152
5155
|
}, {
|
|
5153
5156
|
"name" : "platform_fee",
|
|
@@ -6081,6 +6084,12 @@
|
|
|
6081
6084
|
"attributes" : [ ],
|
|
6082
6085
|
"annotations" : [ ],
|
|
6083
6086
|
"description" : "Globally unique identifier"
|
|
6087
|
+
}, {
|
|
6088
|
+
"name" : "account",
|
|
6089
|
+
"type" : "account_id_reference",
|
|
6090
|
+
"required" : true,
|
|
6091
|
+
"attributes" : [ ],
|
|
6092
|
+
"annotations" : [ ]
|
|
6084
6093
|
}, {
|
|
6085
6094
|
"name" : "metadata",
|
|
6086
6095
|
"type" : "transaction_metadata",
|
|
@@ -9694,6 +9703,19 @@
|
|
|
9694
9703
|
} ],
|
|
9695
9704
|
"attributes" : [ ],
|
|
9696
9705
|
"interfaces" : [ ]
|
|
9706
|
+
}, {
|
|
9707
|
+
"name" : "account_id_reference",
|
|
9708
|
+
"plural" : "account_id_references",
|
|
9709
|
+
"fields" : [ {
|
|
9710
|
+
"name" : "id",
|
|
9711
|
+
"type" : "string",
|
|
9712
|
+
"required" : true,
|
|
9713
|
+
"attributes" : [ ],
|
|
9714
|
+
"annotations" : [ ],
|
|
9715
|
+
"description" : "Globally unique identifier"
|
|
9716
|
+
} ],
|
|
9717
|
+
"attributes" : [ ],
|
|
9718
|
+
"interfaces" : [ ]
|
|
9697
9719
|
}, {
|
|
9698
9720
|
"name" : "account_orders_export_type",
|
|
9699
9721
|
"plural" : "account_orders_export_types",
|
|
@@ -16630,6 +16652,12 @@
|
|
|
16630
16652
|
"attributes" : [ ],
|
|
16631
16653
|
"annotations" : [ ],
|
|
16632
16654
|
"description" : "Globally unique identifier"
|
|
16655
|
+
}, {
|
|
16656
|
+
"name" : "account",
|
|
16657
|
+
"type" : "account_id_reference",
|
|
16658
|
+
"required" : true,
|
|
16659
|
+
"attributes" : [ ],
|
|
16660
|
+
"annotations" : [ ]
|
|
16633
16661
|
}, {
|
|
16634
16662
|
"name" : "metadata",
|
|
16635
16663
|
"type" : "transaction_metadata",
|
|
@@ -24022,6 +24050,122 @@
|
|
|
24022
24050
|
} ],
|
|
24023
24051
|
"attributes" : [ ],
|
|
24024
24052
|
"interfaces" : [ ]
|
|
24053
|
+
}, {
|
|
24054
|
+
"name" : "flow_transaction",
|
|
24055
|
+
"plural" : "flow_transactions",
|
|
24056
|
+
"fields" : [ {
|
|
24057
|
+
"name" : "statement",
|
|
24058
|
+
"type" : "billing_channel_statement_reference",
|
|
24059
|
+
"required" : false,
|
|
24060
|
+
"attributes" : [ ],
|
|
24061
|
+
"annotations" : [ ]
|
|
24062
|
+
}, {
|
|
24063
|
+
"name" : "id",
|
|
24064
|
+
"type" : "string",
|
|
24065
|
+
"required" : true,
|
|
24066
|
+
"attributes" : [ ],
|
|
24067
|
+
"annotations" : [ ],
|
|
24068
|
+
"description" : "Globally unique identifier"
|
|
24069
|
+
}, {
|
|
24070
|
+
"name" : "account",
|
|
24071
|
+
"type" : "account_id_reference",
|
|
24072
|
+
"required" : true,
|
|
24073
|
+
"attributes" : [ ],
|
|
24074
|
+
"annotations" : [ ]
|
|
24075
|
+
}, {
|
|
24076
|
+
"name" : "metadata",
|
|
24077
|
+
"type" : "transaction_metadata",
|
|
24078
|
+
"required" : false,
|
|
24079
|
+
"attributes" : [ ],
|
|
24080
|
+
"annotations" : [ ]
|
|
24081
|
+
}, {
|
|
24082
|
+
"name" : "order",
|
|
24083
|
+
"type" : "billing_channel_order_summary",
|
|
24084
|
+
"required" : false,
|
|
24085
|
+
"attributes" : [ ],
|
|
24086
|
+
"annotations" : [ ]
|
|
24087
|
+
}, {
|
|
24088
|
+
"name" : "payment_request",
|
|
24089
|
+
"type" : "billing_channel_payment_request_reference",
|
|
24090
|
+
"required" : false,
|
|
24091
|
+
"attributes" : [ ],
|
|
24092
|
+
"annotations" : [ ]
|
|
24093
|
+
}, {
|
|
24094
|
+
"name" : "currency",
|
|
24095
|
+
"type" : "string",
|
|
24096
|
+
"required" : true,
|
|
24097
|
+
"attributes" : [ ],
|
|
24098
|
+
"annotations" : [ ]
|
|
24099
|
+
}, {
|
|
24100
|
+
"name" : "source",
|
|
24101
|
+
"type" : "transaction_source",
|
|
24102
|
+
"required" : true,
|
|
24103
|
+
"attributes" : [ ],
|
|
24104
|
+
"annotations" : [ ]
|
|
24105
|
+
}, {
|
|
24106
|
+
"name" : "parent",
|
|
24107
|
+
"type" : "parent_transaction_summary",
|
|
24108
|
+
"required" : false,
|
|
24109
|
+
"attributes" : [ ],
|
|
24110
|
+
"annotations" : [ ]
|
|
24111
|
+
}, {
|
|
24112
|
+
"name" : "gross",
|
|
24113
|
+
"type" : "decimal",
|
|
24114
|
+
"required" : true,
|
|
24115
|
+
"attributes" : [ ],
|
|
24116
|
+
"annotations" : [ ]
|
|
24117
|
+
}, {
|
|
24118
|
+
"name" : "fees",
|
|
24119
|
+
"type" : "[fee_deduction]",
|
|
24120
|
+
"required" : true,
|
|
24121
|
+
"attributes" : [ ],
|
|
24122
|
+
"annotations" : [ ],
|
|
24123
|
+
"default" : "[]"
|
|
24124
|
+
}, {
|
|
24125
|
+
"name" : "withholdings",
|
|
24126
|
+
"type" : "[withholding_deduction]",
|
|
24127
|
+
"required" : true,
|
|
24128
|
+
"attributes" : [ ],
|
|
24129
|
+
"annotations" : [ ],
|
|
24130
|
+
"default" : "[]"
|
|
24131
|
+
}, {
|
|
24132
|
+
"name" : "discounts",
|
|
24133
|
+
"type" : "[billing_discount]",
|
|
24134
|
+
"required" : true,
|
|
24135
|
+
"attributes" : [ ],
|
|
24136
|
+
"annotations" : [ ],
|
|
24137
|
+
"default" : "[]"
|
|
24138
|
+
}, {
|
|
24139
|
+
"name" : "net",
|
|
24140
|
+
"type" : "decimal",
|
|
24141
|
+
"required" : true,
|
|
24142
|
+
"attributes" : [ ],
|
|
24143
|
+
"annotations" : [ ],
|
|
24144
|
+
"description" : "net = gross -fees - withholdings"
|
|
24145
|
+
}, {
|
|
24146
|
+
"name" : "identifiers",
|
|
24147
|
+
"type" : "map[string]",
|
|
24148
|
+
"required" : true,
|
|
24149
|
+
"attributes" : [ ],
|
|
24150
|
+
"annotations" : [ ],
|
|
24151
|
+
"description" : "We serialize any transaction level identifiers as key/value pairs here",
|
|
24152
|
+
"default" : "{}"
|
|
24153
|
+
}, {
|
|
24154
|
+
"name" : "created_at",
|
|
24155
|
+
"type" : "date-time-iso8601",
|
|
24156
|
+
"required" : true,
|
|
24157
|
+
"attributes" : [ ],
|
|
24158
|
+
"annotations" : [ ]
|
|
24159
|
+
}, {
|
|
24160
|
+
"name" : "updated_at",
|
|
24161
|
+
"type" : "date-time-iso8601",
|
|
24162
|
+
"required" : true,
|
|
24163
|
+
"attributes" : [ ],
|
|
24164
|
+
"annotations" : [ ]
|
|
24165
|
+
} ],
|
|
24166
|
+
"attributes" : [ ],
|
|
24167
|
+
"interfaces" : [ "generic_transaction" ],
|
|
24168
|
+
"description" : "Provides internal access to all transactions"
|
|
24025
24169
|
}, {
|
|
24026
24170
|
"name" : "fraud_email_rule",
|
|
24027
24171
|
"plural" : "fraud_email_rules",
|
|
@@ -31335,6 +31479,12 @@
|
|
|
31335
31479
|
"required" : false,
|
|
31336
31480
|
"attributes" : [ ],
|
|
31337
31481
|
"annotations" : [ ]
|
|
31482
|
+
}, {
|
|
31483
|
+
"name" : "deactivate_at",
|
|
31484
|
+
"type" : "date-time-iso8601",
|
|
31485
|
+
"required" : false,
|
|
31486
|
+
"attributes" : [ ],
|
|
31487
|
+
"annotations" : [ ]
|
|
31338
31488
|
} ],
|
|
31339
31489
|
"attributes" : [ ],
|
|
31340
31490
|
"interfaces" : [ ],
|
|
@@ -40102,6 +40252,12 @@
|
|
|
40102
40252
|
"attributes" : [ ],
|
|
40103
40253
|
"annotations" : [ ],
|
|
40104
40254
|
"description" : "Globally unique identifier"
|
|
40255
|
+
}, {
|
|
40256
|
+
"name" : "account",
|
|
40257
|
+
"type" : "account_id_reference",
|
|
40258
|
+
"required" : true,
|
|
40259
|
+
"attributes" : [ ],
|
|
40260
|
+
"annotations" : [ ]
|
|
40105
40261
|
}, {
|
|
40106
40262
|
"name" : "metadata",
|
|
40107
40263
|
"type" : "transaction_metadata",
|
|
@@ -53383,6 +53539,12 @@
|
|
|
53383
53539
|
"attributes" : [ ],
|
|
53384
53540
|
"annotations" : [ ],
|
|
53385
53541
|
"description" : "Globally unique identifier"
|
|
53542
|
+
}, {
|
|
53543
|
+
"name" : "account",
|
|
53544
|
+
"type" : "account_id_reference",
|
|
53545
|
+
"required" : true,
|
|
53546
|
+
"attributes" : [ ],
|
|
53547
|
+
"annotations" : [ ]
|
|
53386
53548
|
}, {
|
|
53387
53549
|
"name" : "metadata",
|
|
53388
53550
|
"type" : "transaction_metadata",
|
|
@@ -53530,6 +53692,13 @@
|
|
|
53530
53692
|
"required" : true,
|
|
53531
53693
|
"attributes" : [ ],
|
|
53532
53694
|
"annotations" : [ ]
|
|
53695
|
+
}, {
|
|
53696
|
+
"name" : "revenue_share_percentage",
|
|
53697
|
+
"type" : "decimal",
|
|
53698
|
+
"required" : true,
|
|
53699
|
+
"attributes" : [ ],
|
|
53700
|
+
"annotations" : [ ],
|
|
53701
|
+
"description" : "Percentage of revenue a channel should receive from shipments made on this ratecard. Omitted when none. Values are expressed as '0.0295' to represent '2.95%'"
|
|
53533
53702
|
}, {
|
|
53534
53703
|
"name" : "outbound",
|
|
53535
53704
|
"type" : "transaction_metadata_carrier_charge_outbound",
|
|
@@ -83332,6 +83501,11 @@
|
|
|
83332
83501
|
"type" : "string",
|
|
83333
83502
|
"location" : "Query",
|
|
83334
83503
|
"required" : false
|
|
83504
|
+
}, {
|
|
83505
|
+
"name" : "order_number",
|
|
83506
|
+
"type" : "string",
|
|
83507
|
+
"location" : "Query",
|
|
83508
|
+
"required" : false
|
|
83335
83509
|
}, {
|
|
83336
83510
|
"name" : "since",
|
|
83337
83511
|
"type" : "date-time-iso8601",
|
|
@@ -87761,6 +87935,191 @@
|
|
|
87761
87935
|
} ],
|
|
87762
87936
|
"path" : "/permission",
|
|
87763
87937
|
"description" : "Default user roles supported by Flow"
|
|
87938
|
+
}, {
|
|
87939
|
+
"type" : "flow_transaction",
|
|
87940
|
+
"plural" : "flow_transactions",
|
|
87941
|
+
"operations" : [ {
|
|
87942
|
+
"method" : "GET",
|
|
87943
|
+
"path" : "/internal/billing/transactions",
|
|
87944
|
+
"parameters" : [ {
|
|
87945
|
+
"name" : "id",
|
|
87946
|
+
"type" : "[string]",
|
|
87947
|
+
"location" : "Query",
|
|
87948
|
+
"required" : false,
|
|
87949
|
+
"description" : "Filter by one or more IDs of this resource",
|
|
87950
|
+
"maximum" : 100
|
|
87951
|
+
}, {
|
|
87952
|
+
"name" : "source_type",
|
|
87953
|
+
"type" : "string",
|
|
87954
|
+
"location" : "Query",
|
|
87955
|
+
"required" : false
|
|
87956
|
+
}, {
|
|
87957
|
+
"name" : "source_id",
|
|
87958
|
+
"type" : "string",
|
|
87959
|
+
"location" : "Query",
|
|
87960
|
+
"required" : false
|
|
87961
|
+
}, {
|
|
87962
|
+
"name" : "order_organization_id",
|
|
87963
|
+
"type" : "string",
|
|
87964
|
+
"location" : "Query",
|
|
87965
|
+
"required" : false
|
|
87966
|
+
}, {
|
|
87967
|
+
"name" : "statement_id",
|
|
87968
|
+
"type" : "string",
|
|
87969
|
+
"location" : "Query",
|
|
87970
|
+
"required" : false
|
|
87971
|
+
}, {
|
|
87972
|
+
"name" : "order_number",
|
|
87973
|
+
"type" : "string",
|
|
87974
|
+
"location" : "Query",
|
|
87975
|
+
"required" : false
|
|
87976
|
+
}, {
|
|
87977
|
+
"name" : "since",
|
|
87978
|
+
"type" : "date-time-iso8601",
|
|
87979
|
+
"location" : "Query",
|
|
87980
|
+
"required" : false,
|
|
87981
|
+
"description" : "If specified, we return all transactions where created_at >= the provided timestamp"
|
|
87982
|
+
}, {
|
|
87983
|
+
"name" : "updated_since",
|
|
87984
|
+
"type" : "date-time-iso8601",
|
|
87985
|
+
"location" : "Query",
|
|
87986
|
+
"required" : false,
|
|
87987
|
+
"description" : "If specified, we return all transactions where updated_at >= the provided timestamp"
|
|
87988
|
+
}, {
|
|
87989
|
+
"name" : "limit",
|
|
87990
|
+
"type" : "long",
|
|
87991
|
+
"location" : "Query",
|
|
87992
|
+
"required" : true,
|
|
87993
|
+
"description" : "The maximum number of results to return",
|
|
87994
|
+
"default" : "25",
|
|
87995
|
+
"minimum" : 1,
|
|
87996
|
+
"maximum" : 100
|
|
87997
|
+
}, {
|
|
87998
|
+
"name" : "offset",
|
|
87999
|
+
"type" : "long",
|
|
88000
|
+
"location" : "Query",
|
|
88001
|
+
"required" : true,
|
|
88002
|
+
"description" : "The number of results to skip before returning results",
|
|
88003
|
+
"default" : "0",
|
|
88004
|
+
"minimum" : 0
|
|
88005
|
+
}, {
|
|
88006
|
+
"name" : "sort",
|
|
88007
|
+
"type" : "string",
|
|
88008
|
+
"location" : "Query",
|
|
88009
|
+
"required" : true,
|
|
88010
|
+
"default" : "-created_at"
|
|
88011
|
+
} ],
|
|
88012
|
+
"responses" : [ {
|
|
88013
|
+
"code" : {
|
|
88014
|
+
"integer" : {
|
|
88015
|
+
"value" : 200
|
|
88016
|
+
}
|
|
88017
|
+
},
|
|
88018
|
+
"type" : "[flow_transaction]",
|
|
88019
|
+
"description" : "Successful response",
|
|
88020
|
+
"attributes" : [ ]
|
|
88021
|
+
}, {
|
|
88022
|
+
"code" : {
|
|
88023
|
+
"integer" : {
|
|
88024
|
+
"value" : 401
|
|
88025
|
+
}
|
|
88026
|
+
},
|
|
88027
|
+
"type" : "unit",
|
|
88028
|
+
"description" : "Authorization failed",
|
|
88029
|
+
"attributes" : [ ]
|
|
88030
|
+
}, {
|
|
88031
|
+
"code" : {
|
|
88032
|
+
"integer" : {
|
|
88033
|
+
"value" : 404
|
|
88034
|
+
}
|
|
88035
|
+
},
|
|
88036
|
+
"type" : "unit",
|
|
88037
|
+
"description" : "Resource was not found",
|
|
88038
|
+
"attributes" : [ ]
|
|
88039
|
+
}, {
|
|
88040
|
+
"code" : {
|
|
88041
|
+
"integer" : {
|
|
88042
|
+
"value" : 422
|
|
88043
|
+
}
|
|
88044
|
+
},
|
|
88045
|
+
"type" : "generic_error",
|
|
88046
|
+
"description" : "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.",
|
|
88047
|
+
"attributes" : [ ]
|
|
88048
|
+
} ],
|
|
88049
|
+
"attributes" : [ {
|
|
88050
|
+
"name" : "sort",
|
|
88051
|
+
"value" : {
|
|
88052
|
+
"values" : [ {
|
|
88053
|
+
"value" : "id"
|
|
88054
|
+
}, {
|
|
88055
|
+
"value" : "created_at"
|
|
88056
|
+
}, {
|
|
88057
|
+
"value" : "updated_at"
|
|
88058
|
+
} ]
|
|
88059
|
+
}
|
|
88060
|
+
}, {
|
|
88061
|
+
"name" : "linter",
|
|
88062
|
+
"value" : {
|
|
88063
|
+
"ignore" : [ "versions" ]
|
|
88064
|
+
}
|
|
88065
|
+
} ]
|
|
88066
|
+
}, {
|
|
88067
|
+
"method" : "GET",
|
|
88068
|
+
"path" : "/internal/billing/transactions/:id",
|
|
88069
|
+
"parameters" : [ {
|
|
88070
|
+
"name" : "id",
|
|
88071
|
+
"type" : "string",
|
|
88072
|
+
"location" : "Path",
|
|
88073
|
+
"required" : true,
|
|
88074
|
+
"description" : "Filter by one or more IDs of this resource"
|
|
88075
|
+
} ],
|
|
88076
|
+
"responses" : [ {
|
|
88077
|
+
"code" : {
|
|
88078
|
+
"integer" : {
|
|
88079
|
+
"value" : 200
|
|
88080
|
+
}
|
|
88081
|
+
},
|
|
88082
|
+
"type" : "flow_transaction",
|
|
88083
|
+
"description" : "Successful response",
|
|
88084
|
+
"attributes" : [ ]
|
|
88085
|
+
}, {
|
|
88086
|
+
"code" : {
|
|
88087
|
+
"integer" : {
|
|
88088
|
+
"value" : 401
|
|
88089
|
+
}
|
|
88090
|
+
},
|
|
88091
|
+
"type" : "unit",
|
|
88092
|
+
"description" : "Authorization failed",
|
|
88093
|
+
"attributes" : [ ]
|
|
88094
|
+
}, {
|
|
88095
|
+
"code" : {
|
|
88096
|
+
"integer" : {
|
|
88097
|
+
"value" : 404
|
|
88098
|
+
}
|
|
88099
|
+
},
|
|
88100
|
+
"type" : "unit",
|
|
88101
|
+
"description" : "Resource was not found",
|
|
88102
|
+
"attributes" : [ ]
|
|
88103
|
+
}, {
|
|
88104
|
+
"code" : {
|
|
88105
|
+
"integer" : {
|
|
88106
|
+
"value" : 422
|
|
88107
|
+
}
|
|
88108
|
+
},
|
|
88109
|
+
"type" : "generic_error",
|
|
88110
|
+
"description" : "One or more errors were found with the data sent in the request. The body of the response contains specific details on what data failed validation.",
|
|
88111
|
+
"attributes" : [ ]
|
|
88112
|
+
} ],
|
|
88113
|
+
"attributes" : [ ]
|
|
88114
|
+
} ],
|
|
88115
|
+
"attributes" : [ {
|
|
88116
|
+
"name" : "docs",
|
|
88117
|
+
"value" : {
|
|
88118
|
+
"module" : "general"
|
|
88119
|
+
}
|
|
88120
|
+
} ],
|
|
88121
|
+
"path" : "/internal/billing/transactions",
|
|
88122
|
+
"description" : "Provides internal access to all transactions"
|
|
87764
88123
|
}, {
|
|
87765
88124
|
"type" : "fraud_email_rule",
|
|
87766
88125
|
"plural" : "fraud_email_rules",
|
|
@@ -99388,6 +99747,11 @@
|
|
|
99388
99747
|
"type" : "string",
|
|
99389
99748
|
"location" : "Query",
|
|
99390
99749
|
"required" : false
|
|
99750
|
+
}, {
|
|
99751
|
+
"name" : "order_number",
|
|
99752
|
+
"type" : "string",
|
|
99753
|
+
"location" : "Query",
|
|
99754
|
+
"required" : false
|
|
99391
99755
|
}, {
|
|
99392
99756
|
"name" : "since",
|
|
99393
99757
|
"type" : "date-time-iso8601",
|