@flowio/api-mock-generator 6.17.57 → 6.17.58

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/dist/api.json +780 -588
  2. package/package.json +2 -2
  3. package/src/api.json +780 -588
package/src/api.json CHANGED
@@ -10,7 +10,7 @@
10
10
  "key" : "api"
11
11
  },
12
12
  "namespace" : "io.flow.v0",
13
- "version" : "0.17.65",
13
+ "version" : "0.17.67",
14
14
  "info" : {
15
15
  "license" : {
16
16
  "name" : "MIT",
@@ -76,11 +76,11 @@
76
76
  "application" : {
77
77
  "key" : "billing-true-up"
78
78
  },
79
- "version" : "0.19.94",
79
+ "version" : "0.19.99",
80
80
  "enums" : [ "true_up_surcharge_type" ],
81
- "interfaces" : [ "label_invoice" ],
82
- "unions" : [ "label_surcharge_detail" ],
83
- "models" : [ "label_base", "label_destination", "label_invoice_request", "label_invoice_response_file", "label_invoice_response_file_form", "label_invoice_response_file_result", "label_invoice_response_form", "label_metadata", "label_response_units", "label_surcharge", "label_surcharge_detail_flat", "label_surcharge_detail_per_weight_unit", "label_surcharge_detail_percentage", "label_surcharge_form", "label_surcharge_single_form", "label_units", "metadata_proposition", "metadata_ratecard", "metadata_weights", "shipping_method_reference", "true_up_label_summary", "weights_dead", "weights_dimensional" ],
81
+ "interfaces" : [ "carrier_charge_form" ],
82
+ "unions" : [ "carrier_charge_form", "label_surcharge_detail" ],
83
+ "models" : [ "carrier_charge_file", "carrier_charge_file_form", "carrier_charge_file_result", "carrier_charge_form_label", "carrier_charge_form_return_to_origin", "carrier_charge_units", "label_base", "label_destination", "label_invoice_request", "label_metadata", "label_surcharge", "label_surcharge_detail_flat", "label_surcharge_detail_per_weight_unit", "label_surcharge_detail_percentage", "label_surcharge_form", "label_surcharge_single_form", "label_units", "metadata_proposition", "metadata_ratecard", "metadata_weights", "shipping_method_reference", "true_up_label_summary", "weights_dead", "weights_dimensional" ],
84
84
  "annotations" : [ ]
85
85
  }, {
86
86
  "uri" : "https://app.apibuilder.io/flow/ben-test-internal/latest/service.json",
@@ -91,7 +91,7 @@
91
91
  "application" : {
92
92
  "key" : "ben-test-internal"
93
93
  },
94
- "version" : "0.19.94",
94
+ "version" : "0.19.98",
95
95
  "enums" : [ ],
96
96
  "interfaces" : [ "generate_load" ],
97
97
  "unions" : [ "generate_load" ],
@@ -1272,6 +1272,18 @@
1272
1272
  }, {
1273
1273
  "name" : "organization_payout_deleted",
1274
1274
  "attributes" : [ ]
1275
+ }, {
1276
+ "name" : "channel_pending_payout_transaction_upserted",
1277
+ "attributes" : [ ]
1278
+ }, {
1279
+ "name" : "channel_pending_payout_transaction_deleted",
1280
+ "attributes" : [ ]
1281
+ }, {
1282
+ "name" : "organization_pending_payout_transaction_upserted",
1283
+ "attributes" : [ ]
1284
+ }, {
1285
+ "name" : "organization_pending_payout_transaction_deleted",
1286
+ "attributes" : [ ]
1275
1287
  }, {
1276
1288
  "name" : "attribute_upserted",
1277
1289
  "attributes" : [ ]
@@ -3732,6 +3744,29 @@
3732
3744
  } ],
3733
3745
  "attributes" : [ ],
3734
3746
  "description" : "Modeled from stripe: https://stripe.com/docs/api/payouts/failures"
3747
+ }, {
3748
+ "name" : "pending_payout_transaction_reason_code",
3749
+ "plural" : "pending_payout_transaction_reason_codes",
3750
+ "values" : [ {
3751
+ "name" : "waiting_for_full_refund",
3752
+ "attributes" : [ ]
3753
+ }, {
3754
+ "name" : "waiting_for_fulfillment",
3755
+ "attributes" : [ ]
3756
+ }, {
3757
+ "name" : "waiting_for_in_transit",
3758
+ "attributes" : [ ]
3759
+ }, {
3760
+ "name" : "waiting_for_next_payout_date",
3761
+ "attributes" : [ ]
3762
+ }, {
3763
+ "name" : "external_fulfillment_missing_tracking_info",
3764
+ "attributes" : [ ]
3765
+ }, {
3766
+ "name" : "waiting_for_positive_account_balance",
3767
+ "attributes" : [ ]
3768
+ } ],
3769
+ "attributes" : [ ]
3735
3770
  }, {
3736
3771
  "name" : "permitted_http_method",
3737
3772
  "plural" : "permitted_http_methods",
@@ -4897,29 +4932,6 @@
4897
4932
  "attributes" : [ ]
4898
4933
  } ],
4899
4934
  "attributes" : [ ]
4900
- }, {
4901
- "name" : "transaction_payout_pending_reason",
4902
- "plural" : "transaction_payout_pending_reasons",
4903
- "values" : [ {
4904
- "name" : "waiting_for_full_refund",
4905
- "attributes" : [ ]
4906
- }, {
4907
- "name" : "waiting_for_fulfillment",
4908
- "attributes" : [ ]
4909
- }, {
4910
- "name" : "waiting_for_in_transit",
4911
- "attributes" : [ ]
4912
- }, {
4913
- "name" : "waiting_for_next_payout_date",
4914
- "attributes" : [ ]
4915
- }, {
4916
- "name" : "external_fulfillment_missing_tracking_info",
4917
- "attributes" : [ ]
4918
- }, {
4919
- "name" : "waiting_for_positive_account_balance",
4920
- "attributes" : [ ]
4921
- } ],
4922
- "attributes" : [ ]
4923
4935
  }, {
4924
4936
  "name" : "transaction_source",
4925
4937
  "plural" : "transaction_sources",
@@ -6172,6 +6184,31 @@
6172
6184
  "annotations" : [ ]
6173
6185
  } ],
6174
6186
  "attributes" : [ ]
6187
+ }, {
6188
+ "name" : "pending_payout_transaction",
6189
+ "plural" : "pending_payout_transactions",
6190
+ "fields" : [ {
6191
+ "name" : "id",
6192
+ "type" : "string",
6193
+ "required" : true,
6194
+ "attributes" : [ ],
6195
+ "annotations" : [ ],
6196
+ "description" : "The id of the actual transaction that is pending payout"
6197
+ }, {
6198
+ "name" : "reason",
6199
+ "type" : "pending_payout_transaction_reason",
6200
+ "required" : true,
6201
+ "attributes" : [ ],
6202
+ "annotations" : [ ]
6203
+ }, {
6204
+ "name" : "timeout",
6205
+ "type" : "pending_payout_transaction_timeout",
6206
+ "required" : false,
6207
+ "attributes" : [ ],
6208
+ "annotations" : [ ]
6209
+ } ],
6210
+ "attributes" : [ ],
6211
+ "description" : "A transaction that is pending payout."
6175
6212
  }, {
6176
6213
  "name" : "ratecard_estimate",
6177
6214
  "plural" : "ratecard_estimates",
@@ -6329,30 +6366,6 @@
6329
6366
  "annotations" : [ ]
6330
6367
  } ],
6331
6368
  "attributes" : [ ]
6332
- }, {
6333
- "name" : "transaction_payout",
6334
- "plural" : "transaction_payouts",
6335
- "fields" : [ {
6336
- "name" : "transaction",
6337
- "type" : "transaction_reference",
6338
- "required" : true,
6339
- "attributes" : [ ],
6340
- "annotations" : [ ]
6341
- }, {
6342
- "name" : "waiting_for",
6343
- "type" : "transaction_payout_pending_reason",
6344
- "required" : false,
6345
- "attributes" : [ ],
6346
- "annotations" : [ ]
6347
- }, {
6348
- "name" : "payout",
6349
- "type" : "payout_reference",
6350
- "required" : false,
6351
- "attributes" : [ ],
6352
- "annotations" : [ ]
6353
- } ],
6354
- "attributes" : [ ],
6355
- "description" : "Provides either the reference to the payout, or if no payout, a reason for what we are waiting for"
6356
6369
  } ],
6357
6370
  "unions" : [ {
6358
6371
  "name" : "abandoned_order_promotion_details",
@@ -6984,6 +6997,22 @@
6984
6997
  "type" : "organization_payout_deleted",
6985
6998
  "attributes" : [ ],
6986
6999
  "discriminator_value" : "organization_payout_deleted"
7000
+ }, {
7001
+ "type" : "channel_pending_payout_transaction_upserted",
7002
+ "attributes" : [ ],
7003
+ "discriminator_value" : "channel_pending_payout_transaction_upserted"
7004
+ }, {
7005
+ "type" : "channel_pending_payout_transaction_deleted",
7006
+ "attributes" : [ ],
7007
+ "discriminator_value" : "channel_pending_payout_transaction_deleted"
7008
+ }, {
7009
+ "type" : "organization_pending_payout_transaction_upserted",
7010
+ "attributes" : [ ],
7011
+ "discriminator_value" : "organization_pending_payout_transaction_upserted"
7012
+ }, {
7013
+ "type" : "organization_pending_payout_transaction_deleted",
7014
+ "attributes" : [ ],
7015
+ "discriminator_value" : "organization_pending_payout_transaction_deleted"
6987
7016
  }, {
6988
7017
  "type" : "attribute_upserted",
6989
7018
  "attributes" : [ ],
@@ -15871,6 +15900,93 @@
15871
15900
  } ],
15872
15901
  "attributes" : [ ],
15873
15902
  "interfaces" : [ ]
15903
+ }, {
15904
+ "name" : "channel_pending_payout_transaction",
15905
+ "plural" : "channel_pending_payout_transactions",
15906
+ "fields" : [ {
15907
+ "name" : "id",
15908
+ "type" : "string",
15909
+ "required" : true,
15910
+ "attributes" : [ ],
15911
+ "annotations" : [ ],
15912
+ "description" : "The id of the actual transaction that is pending payout"
15913
+ }, {
15914
+ "name" : "reason",
15915
+ "type" : "pending_payout_transaction_reason",
15916
+ "required" : true,
15917
+ "attributes" : [ ],
15918
+ "annotations" : [ ]
15919
+ }, {
15920
+ "name" : "timeout",
15921
+ "type" : "pending_payout_transaction_timeout",
15922
+ "required" : false,
15923
+ "attributes" : [ ],
15924
+ "annotations" : [ ]
15925
+ } ],
15926
+ "attributes" : [ ],
15927
+ "interfaces" : [ "pending_payout_transaction" ],
15928
+ "description" : "A transaction that is pending payout."
15929
+ }, {
15930
+ "name" : "channel_pending_payout_transaction_deleted",
15931
+ "plural" : "channel_pending_payout_transaction_deleteds",
15932
+ "fields" : [ {
15933
+ "name" : "event_id",
15934
+ "type" : "string",
15935
+ "required" : true,
15936
+ "attributes" : [ ],
15937
+ "annotations" : [ ]
15938
+ }, {
15939
+ "name" : "timestamp",
15940
+ "type" : "date-time-iso8601",
15941
+ "required" : true,
15942
+ "attributes" : [ ],
15943
+ "annotations" : [ ]
15944
+ }, {
15945
+ "name" : "channel_id",
15946
+ "type" : "string",
15947
+ "required" : true,
15948
+ "attributes" : [ ],
15949
+ "annotations" : [ ]
15950
+ }, {
15951
+ "name" : "id",
15952
+ "type" : "string",
15953
+ "required" : true,
15954
+ "attributes" : [ ],
15955
+ "annotations" : [ ],
15956
+ "description" : "Globally unique identifier"
15957
+ } ],
15958
+ "attributes" : [ ],
15959
+ "interfaces" : [ ]
15960
+ }, {
15961
+ "name" : "channel_pending_payout_transaction_upserted",
15962
+ "plural" : "channel_pending_payout_transaction_upserteds",
15963
+ "fields" : [ {
15964
+ "name" : "event_id",
15965
+ "type" : "string",
15966
+ "required" : true,
15967
+ "attributes" : [ ],
15968
+ "annotations" : [ ]
15969
+ }, {
15970
+ "name" : "timestamp",
15971
+ "type" : "date-time-iso8601",
15972
+ "required" : true,
15973
+ "attributes" : [ ],
15974
+ "annotations" : [ ]
15975
+ }, {
15976
+ "name" : "channel_id",
15977
+ "type" : "string",
15978
+ "required" : true,
15979
+ "attributes" : [ ],
15980
+ "annotations" : [ ]
15981
+ }, {
15982
+ "name" : "channel_pending_payout_transaction",
15983
+ "type" : "channel_pending_payout_transaction",
15984
+ "required" : true,
15985
+ "attributes" : [ ],
15986
+ "annotations" : [ ]
15987
+ } ],
15988
+ "attributes" : [ ],
15989
+ "interfaces" : [ ]
15874
15990
  }, {
15875
15991
  "name" : "channel_rate",
15876
15992
  "plural" : "channel_rates",
@@ -16270,31 +16386,6 @@
16270
16386
  } ],
16271
16387
  "attributes" : [ ],
16272
16388
  "interfaces" : [ ]
16273
- }, {
16274
- "name" : "channel_transaction_payout",
16275
- "plural" : "channel_transaction_payouts",
16276
- "fields" : [ {
16277
- "name" : "transaction",
16278
- "type" : "transaction_reference",
16279
- "required" : true,
16280
- "attributes" : [ ],
16281
- "annotations" : [ ]
16282
- }, {
16283
- "name" : "waiting_for",
16284
- "type" : "transaction_payout_pending_reason",
16285
- "required" : false,
16286
- "attributes" : [ ],
16287
- "annotations" : [ ]
16288
- }, {
16289
- "name" : "payout",
16290
- "type" : "payout_reference",
16291
- "required" : false,
16292
- "attributes" : [ ],
16293
- "annotations" : [ ]
16294
- } ],
16295
- "attributes" : [ ],
16296
- "interfaces" : [ "transaction_payout" ],
16297
- "description" : "Provides either the reference to the payout, or if no payout, a reason for what we are waiting for"
16298
16389
  }, {
16299
16390
  "name" : "channel_transaction_upserted",
16300
16391
  "plural" : "channel_transaction_upserteds",
@@ -35530,6 +35621,95 @@
35530
35621
  } ],
35531
35622
  "attributes" : [ ],
35532
35623
  "interfaces" : [ ]
35624
+ }, {
35625
+ "name" : "organization_pending_payout_transaction",
35626
+ "plural" : "organization_pending_payout_transactions",
35627
+ "fields" : [ {
35628
+ "name" : "id",
35629
+ "type" : "string",
35630
+ "required" : true,
35631
+ "attributes" : [ ],
35632
+ "annotations" : [ ],
35633
+ "description" : "The id of the actual transaction that is pending payout"
35634
+ }, {
35635
+ "name" : "reason",
35636
+ "type" : "pending_payout_transaction_reason",
35637
+ "required" : true,
35638
+ "attributes" : [ ],
35639
+ "annotations" : [ ]
35640
+ }, {
35641
+ "name" : "timeout",
35642
+ "type" : "pending_payout_transaction_timeout",
35643
+ "required" : false,
35644
+ "attributes" : [ ],
35645
+ "annotations" : [ ]
35646
+ } ],
35647
+ "attributes" : [ ],
35648
+ "interfaces" : [ "pending_payout_transaction" ],
35649
+ "description" : "A transaction that is pending payout."
35650
+ }, {
35651
+ "name" : "organization_pending_payout_transaction_deleted",
35652
+ "plural" : "organization_pending_payout_transaction_deleteds",
35653
+ "fields" : [ {
35654
+ "name" : "event_id",
35655
+ "type" : "string",
35656
+ "required" : true,
35657
+ "attributes" : [ ],
35658
+ "annotations" : [ ]
35659
+ }, {
35660
+ "name" : "timestamp",
35661
+ "type" : "date-time-iso8601",
35662
+ "required" : true,
35663
+ "attributes" : [ ],
35664
+ "annotations" : [ ]
35665
+ }, {
35666
+ "name" : "organization",
35667
+ "type" : "string",
35668
+ "required" : true,
35669
+ "attributes" : [ ],
35670
+ "annotations" : [ ],
35671
+ "description" : "Refers to your organization's account identifier"
35672
+ }, {
35673
+ "name" : "id",
35674
+ "type" : "string",
35675
+ "required" : true,
35676
+ "attributes" : [ ],
35677
+ "annotations" : [ ],
35678
+ "description" : "Globally unique identifier"
35679
+ } ],
35680
+ "attributes" : [ ],
35681
+ "interfaces" : [ ]
35682
+ }, {
35683
+ "name" : "organization_pending_payout_transaction_upserted",
35684
+ "plural" : "organization_pending_payout_transaction_upserteds",
35685
+ "fields" : [ {
35686
+ "name" : "event_id",
35687
+ "type" : "string",
35688
+ "required" : true,
35689
+ "attributes" : [ ],
35690
+ "annotations" : [ ]
35691
+ }, {
35692
+ "name" : "timestamp",
35693
+ "type" : "date-time-iso8601",
35694
+ "required" : true,
35695
+ "attributes" : [ ],
35696
+ "annotations" : [ ]
35697
+ }, {
35698
+ "name" : "organization",
35699
+ "type" : "string",
35700
+ "required" : true,
35701
+ "attributes" : [ ],
35702
+ "annotations" : [ ],
35703
+ "description" : "Refers to your organization's account identifier"
35704
+ }, {
35705
+ "name" : "organization_pending_payout_transaction",
35706
+ "type" : "organization_pending_payout_transaction",
35707
+ "required" : true,
35708
+ "attributes" : [ ],
35709
+ "annotations" : [ ]
35710
+ } ],
35711
+ "attributes" : [ ],
35712
+ "interfaces" : [ ]
35533
35713
  }, {
35534
35714
  "name" : "organization_put_form",
35535
35715
  "plural" : "organization_put_forms",
@@ -35998,31 +36178,6 @@
35998
36178
  } ],
35999
36179
  "attributes" : [ ],
36000
36180
  "interfaces" : [ ]
36001
- }, {
36002
- "name" : "organization_transaction_payout",
36003
- "plural" : "organization_transaction_payouts",
36004
- "fields" : [ {
36005
- "name" : "transaction",
36006
- "type" : "transaction_reference",
36007
- "required" : true,
36008
- "attributes" : [ ],
36009
- "annotations" : [ ]
36010
- }, {
36011
- "name" : "waiting_for",
36012
- "type" : "transaction_payout_pending_reason",
36013
- "required" : false,
36014
- "attributes" : [ ],
36015
- "annotations" : [ ]
36016
- }, {
36017
- "name" : "payout",
36018
- "type" : "payout_reference",
36019
- "required" : false,
36020
- "attributes" : [ ],
36021
- "annotations" : [ ]
36022
- } ],
36023
- "attributes" : [ ],
36024
- "interfaces" : [ "transaction_payout" ],
36025
- "description" : "Provides either the reference to the payout, or if no payout, a reason for what we are waiting for"
36026
36181
  }, {
36027
36182
  "name" : "organization_transaction_upserted",
36028
36183
  "plural" : "organization_transaction_upserteds",
@@ -39434,32 +39589,35 @@
39434
39589
  "attributes" : [ ],
39435
39590
  "interfaces" : [ ]
39436
39591
  }, {
39437
- "name" : "pending_transaction",
39438
- "plural" : "pending_transactions",
39592
+ "name" : "pending_payout_transaction_reason",
39593
+ "plural" : "pending_payout_transaction_reasons",
39439
39594
  "fields" : [ {
39440
- "name" : "id",
39441
- "type" : "string",
39595
+ "name" : "code",
39596
+ "type" : "pending_payout_transaction_reason_code",
39442
39597
  "required" : true,
39443
39598
  "attributes" : [ ],
39444
- "annotations" : [ ],
39445
- "description" : "The id of the actual transaction that is pending payout."
39599
+ "annotations" : [ ]
39446
39600
  }, {
39447
- "name" : "reason",
39448
- "type" : "transaction_payout_pending_reason",
39601
+ "name" : "created_at",
39602
+ "type" : "date-time-iso8601",
39449
39603
  "required" : true,
39450
39604
  "attributes" : [ ],
39451
39605
  "annotations" : [ ]
39452
- }, {
39453
- "name" : "reason_set_at",
39606
+ } ],
39607
+ "attributes" : [ ],
39608
+ "interfaces" : [ ]
39609
+ }, {
39610
+ "name" : "pending_payout_transaction_timeout",
39611
+ "plural" : "pending_payout_transaction_timeouts",
39612
+ "fields" : [ {
39613
+ "name" : "created_at",
39454
39614
  "type" : "date-time-iso8601",
39455
39615
  "required" : true,
39456
39616
  "attributes" : [ ],
39457
- "annotations" : [ ],
39458
- "description" : "The time at which this specific reason for this transaction was set. For example, the time at which it was identified that this transaction is waiting for fulfillment."
39617
+ "annotations" : [ ]
39459
39618
  } ],
39460
39619
  "attributes" : [ ],
39461
- "interfaces" : [ ],
39462
- "description" : "A transaction that is pending payout."
39620
+ "interfaces" : [ ]
39463
39621
  }, {
39464
39622
  "name" : "percent_margin",
39465
39623
  "plural" : "percent_margins",
@@ -52563,6 +52721,12 @@
52563
52721
  "name" : "transaction_metadata_trueup",
52564
52722
  "plural" : "transaction_metadata_trueups",
52565
52723
  "fields" : [ {
52724
+ "name" : "original",
52725
+ "type" : "transaction_metadata_trueup_original_transaction",
52726
+ "required" : true,
52727
+ "attributes" : [ ],
52728
+ "annotations" : [ ]
52729
+ }, {
52566
52730
  "name" : "estimate",
52567
52731
  "type" : "transaction_metadata_trueup_data",
52568
52732
  "required" : true,
@@ -52613,6 +52777,19 @@
52613
52777
  } ],
52614
52778
  "attributes" : [ ],
52615
52779
  "interfaces" : [ ]
52780
+ }, {
52781
+ "name" : "transaction_metadata_trueup_original_transaction",
52782
+ "plural" : "transaction_metadata_trueup_original_transactions",
52783
+ "fields" : [ {
52784
+ "name" : "id",
52785
+ "type" : "string",
52786
+ "required" : true,
52787
+ "attributes" : [ ],
52788
+ "annotations" : [ ],
52789
+ "description" : "Globally unique identifier"
52790
+ } ],
52791
+ "attributes" : [ ],
52792
+ "interfaces" : [ ]
52616
52793
  }, {
52617
52794
  "name" : "transaction_network_details_card",
52618
52795
  "plural" : "transaction_network_details_cards",
@@ -81297,6 +81474,170 @@
81297
81474
  }
81298
81475
  } ],
81299
81476
  "path" : "/channel/:channel/billing/payouts"
81477
+ }, {
81478
+ "type" : "channel_pending_payout_transaction",
81479
+ "plural" : "channel_pending_payout_transactions",
81480
+ "operations" : [ {
81481
+ "method" : "GET",
81482
+ "path" : "/channel/:channel/billing/pending/payout/transactions",
81483
+ "parameters" : [ {
81484
+ "name" : "channel",
81485
+ "type" : "string",
81486
+ "location" : "Path",
81487
+ "required" : true
81488
+ }, {
81489
+ "name" : "id",
81490
+ "type" : "[string]",
81491
+ "location" : "Query",
81492
+ "required" : false,
81493
+ "description" : "Filter by one or more IDs of this resource",
81494
+ "maximum" : 100
81495
+ }, {
81496
+ "name" : "since",
81497
+ "type" : "date-time-iso8601",
81498
+ "location" : "Query",
81499
+ "required" : false,
81500
+ "description" : "If specified, we return all pending payout transactions where updated_at >= the provided timestamp"
81501
+ }, {
81502
+ "name" : "limit",
81503
+ "type" : "long",
81504
+ "location" : "Query",
81505
+ "required" : true,
81506
+ "description" : "The maximum number of results to return",
81507
+ "default" : "25",
81508
+ "minimum" : 1,
81509
+ "maximum" : 100
81510
+ }, {
81511
+ "name" : "offset",
81512
+ "type" : "long",
81513
+ "location" : "Query",
81514
+ "required" : true,
81515
+ "description" : "The number of results to skip before returning results",
81516
+ "default" : "0",
81517
+ "minimum" : 0
81518
+ }, {
81519
+ "name" : "sort",
81520
+ "type" : "string",
81521
+ "location" : "Query",
81522
+ "required" : true,
81523
+ "default" : "-created_at"
81524
+ } ],
81525
+ "responses" : [ {
81526
+ "code" : {
81527
+ "integer" : {
81528
+ "value" : 200
81529
+ }
81530
+ },
81531
+ "type" : "[channel_pending_payout_transaction]",
81532
+ "description" : "Successful response",
81533
+ "attributes" : [ ]
81534
+ }, {
81535
+ "code" : {
81536
+ "integer" : {
81537
+ "value" : 401
81538
+ }
81539
+ },
81540
+ "type" : "unit",
81541
+ "description" : "Authorization failed",
81542
+ "attributes" : [ ]
81543
+ }, {
81544
+ "code" : {
81545
+ "integer" : {
81546
+ "value" : 404
81547
+ }
81548
+ },
81549
+ "type" : "unit",
81550
+ "description" : "Resource was not found",
81551
+ "attributes" : [ ]
81552
+ }, {
81553
+ "code" : {
81554
+ "integer" : {
81555
+ "value" : 422
81556
+ }
81557
+ },
81558
+ "type" : "generic_error",
81559
+ "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.",
81560
+ "attributes" : [ ]
81561
+ } ],
81562
+ "attributes" : [ {
81563
+ "name" : "sort",
81564
+ "value" : {
81565
+ "values" : [ {
81566
+ "value" : "id"
81567
+ }, {
81568
+ "value" : "created_at"
81569
+ }, {
81570
+ "value" : "updated_at"
81571
+ } ]
81572
+ }
81573
+ }, {
81574
+ "name" : "linter",
81575
+ "value" : {
81576
+ "ignore" : [ "get", "versions" ]
81577
+ }
81578
+ } ]
81579
+ }, {
81580
+ "method" : "GET",
81581
+ "path" : "/channel/:channel/billing/pending/payout/transactions/:id",
81582
+ "parameters" : [ {
81583
+ "name" : "channel",
81584
+ "type" : "string",
81585
+ "location" : "Path",
81586
+ "required" : true
81587
+ }, {
81588
+ "name" : "id",
81589
+ "type" : "string",
81590
+ "location" : "Path",
81591
+ "required" : true,
81592
+ "description" : "Filter by one or more IDs of this resource"
81593
+ } ],
81594
+ "responses" : [ {
81595
+ "code" : {
81596
+ "integer" : {
81597
+ "value" : 200
81598
+ }
81599
+ },
81600
+ "type" : "channel_pending_payout_transaction",
81601
+ "description" : "Successful response",
81602
+ "attributes" : [ ]
81603
+ }, {
81604
+ "code" : {
81605
+ "integer" : {
81606
+ "value" : 401
81607
+ }
81608
+ },
81609
+ "type" : "unit",
81610
+ "description" : "Authorization failed",
81611
+ "attributes" : [ ]
81612
+ }, {
81613
+ "code" : {
81614
+ "integer" : {
81615
+ "value" : 404
81616
+ }
81617
+ },
81618
+ "type" : "unit",
81619
+ "description" : "Resource was not found",
81620
+ "attributes" : [ ]
81621
+ }, {
81622
+ "code" : {
81623
+ "integer" : {
81624
+ "value" : 422
81625
+ }
81626
+ },
81627
+ "type" : "generic_error",
81628
+ "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.",
81629
+ "attributes" : [ ]
81630
+ } ],
81631
+ "attributes" : [ ]
81632
+ } ],
81633
+ "attributes" : [ {
81634
+ "name" : "docs",
81635
+ "value" : {
81636
+ "module" : "general"
81637
+ }
81638
+ } ],
81639
+ "path" : "/channel/:channel/billing/pending/payout/transactions",
81640
+ "description" : "A transaction that is pending payout."
81300
81641
  }, {
81301
81642
  "type" : "channel_rate",
81302
81643
  "plural" : "channel_rates",
@@ -81945,32 +82286,25 @@
81945
82286
  } ],
81946
82287
  "path" : "/channel/:channel/billing/transactions"
81947
82288
  }, {
81948
- "type" : "channel_transaction_payout",
81949
- "plural" : "channel_transaction_payouts",
82289
+ "type" : "channel_vies_registration",
82290
+ "plural" : "channel_vies_registrations",
81950
82291
  "operations" : [ {
81951
- "method" : "GET",
81952
- "path" : "/channel/:channel/billing/transaction/payouts",
82292
+ "method" : "POST",
82293
+ "path" : "/channel/:channel_id/vies/registrations",
81953
82294
  "parameters" : [ {
81954
- "name" : "channel",
82295
+ "name" : "channel_id",
81955
82296
  "type" : "string",
81956
82297
  "location" : "Path",
81957
82298
  "required" : true
81958
- }, {
81959
- "name" : "transaction_id",
81960
- "type" : "[string]",
81961
- "location" : "Query",
81962
- "required" : true,
81963
- "minimum" : 1,
81964
- "maximum" : 100
81965
82299
  } ],
81966
82300
  "responses" : [ {
81967
82301
  "code" : {
81968
82302
  "integer" : {
81969
- "value" : 200
82303
+ "value" : 201
81970
82304
  }
81971
82305
  },
81972
- "type" : "[channel_transaction_payout]",
81973
- "description" : "Successful response",
82306
+ "type" : "channel_vies_registration",
82307
+ "description" : "Operation succeeded and the resource was created",
81974
82308
  "attributes" : [ ]
81975
82309
  }, {
81976
82310
  "code" : {
@@ -82000,99 +82334,35 @@
82000
82334
  "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.",
82001
82335
  "attributes" : [ ]
82002
82336
  } ],
82003
- "attributes" : [ {
82004
- "name" : "linter",
82005
- "value" : {
82006
- "ignore" : [ "get", "versions" ]
82007
- }
82008
- } ]
82009
- } ],
82010
- "attributes" : [ {
82011
- "name" : "docs",
82012
- "value" : {
82013
- "module" : "general"
82337
+ "attributes" : [ ],
82338
+ "body" : {
82339
+ "type" : "channel_vies_registration_form",
82340
+ "attributes" : [ ]
82014
82341
  }
82015
- } ],
82016
- "path" : "/channel/:channel/billing/transaction/payouts",
82017
- "description" : "Provides either the reference to the payout, or if no payout, a reason for what we are waiting for"
82018
- }, {
82019
- "type" : "channel_vies_registration",
82020
- "plural" : "channel_vies_registrations",
82021
- "operations" : [ {
82022
- "method" : "POST",
82023
- "path" : "/channel/:channel_id/vies/registrations",
82342
+ }, {
82343
+ "method" : "PUT",
82344
+ "path" : "/channel/:channel_id/vies/registrations/:key",
82024
82345
  "parameters" : [ {
82025
82346
  "name" : "channel_id",
82026
82347
  "type" : "string",
82027
82348
  "location" : "Path",
82028
82349
  "required" : true
82350
+ }, {
82351
+ "name" : "key",
82352
+ "type" : "string",
82353
+ "location" : "Path",
82354
+ "required" : true
82029
82355
  } ],
82030
82356
  "responses" : [ {
82031
- "code" : {
82032
- "integer" : {
82033
- "value" : 201
82034
- }
82035
- },
82036
- "type" : "channel_vies_registration",
82037
- "description" : "Operation succeeded and the resource was created",
82038
- "attributes" : [ ]
82039
- }, {
82040
- "code" : {
82041
- "integer" : {
82042
- "value" : 401
82043
- }
82044
- },
82045
- "type" : "unit",
82046
- "description" : "Authorization failed",
82047
- "attributes" : [ ]
82048
- }, {
82049
- "code" : {
82050
- "integer" : {
82051
- "value" : 404
82052
- }
82053
- },
82054
- "type" : "unit",
82055
- "description" : "Resource was not found",
82056
- "attributes" : [ ]
82057
- }, {
82058
- "code" : {
82059
- "integer" : {
82060
- "value" : 422
82061
- }
82062
- },
82063
- "type" : "generic_error",
82064
- "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.",
82065
- "attributes" : [ ]
82066
- } ],
82067
- "attributes" : [ ],
82068
- "body" : {
82069
- "type" : "channel_vies_registration_form",
82070
- "attributes" : [ ]
82071
- }
82072
- }, {
82073
- "method" : "PUT",
82074
- "path" : "/channel/:channel_id/vies/registrations/:key",
82075
- "parameters" : [ {
82076
- "name" : "channel_id",
82077
- "type" : "string",
82078
- "location" : "Path",
82079
- "required" : true
82080
- }, {
82081
- "name" : "key",
82082
- "type" : "string",
82083
- "location" : "Path",
82084
- "required" : true
82085
- } ],
82086
- "responses" : [ {
82087
- "code" : {
82088
- "integer" : {
82089
- "value" : 200
82090
- }
82091
- },
82092
- "type" : "channel_vies_registration",
82093
- "description" : "Successful response",
82094
- "attributes" : [ ]
82095
- }, {
82357
+ "code" : {
82358
+ "integer" : {
82359
+ "value" : 200
82360
+ }
82361
+ },
82362
+ "type" : "channel_vies_registration",
82363
+ "description" : "Successful response",
82364
+ "attributes" : [ ]
82365
+ }, {
82096
82366
  "code" : {
82097
82367
  "integer" : {
82098
82368
  "value" : 201
@@ -90691,11 +90961,11 @@
90691
90961
  } ],
90692
90962
  "path" : "/:organization/billing/payouts"
90693
90963
  }, {
90694
- "type" : "organization_token",
90695
- "plural" : "organization_tokens",
90964
+ "type" : "organization_pending_payout_transaction",
90965
+ "plural" : "organization_pending_payout_transactions",
90696
90966
  "operations" : [ {
90697
90967
  "method" : "GET",
90698
- "path" : "/:organization/tokens",
90968
+ "path" : "/:organization/billing/pending/payout/transactions",
90699
90969
  "parameters" : [ {
90700
90970
  "name" : "organization",
90701
90971
  "type" : "string",
@@ -90710,11 +90980,11 @@
90710
90980
  "description" : "Filter by one or more IDs of this resource",
90711
90981
  "maximum" : 100
90712
90982
  }, {
90713
- "name" : "mine",
90714
- "type" : "boolean",
90983
+ "name" : "since",
90984
+ "type" : "date-time-iso8601",
90715
90985
  "location" : "Query",
90716
90986
  "required" : false,
90717
- "description" : "Filter to tokens created by the requesting user"
90987
+ "description" : "If specified, we return all pending payout transactions where updated_at >= the provided timestamp"
90718
90988
  }, {
90719
90989
  "name" : "limit",
90720
90990
  "type" : "long",
@@ -90745,7 +91015,7 @@
90745
91015
  "value" : 200
90746
91016
  }
90747
91017
  },
90748
- "type" : "[organization_token]",
91018
+ "type" : "[organization_pending_payout_transaction]",
90749
91019
  "description" : "Successful response",
90750
91020
  "attributes" : [ ]
90751
91021
  }, {
@@ -90757,34 +91027,57 @@
90757
91027
  "type" : "unit",
90758
91028
  "description" : "Authorization failed",
90759
91029
  "attributes" : [ ]
91030
+ }, {
91031
+ "code" : {
91032
+ "integer" : {
91033
+ "value" : 404
91034
+ }
91035
+ },
91036
+ "type" : "unit",
91037
+ "description" : "Resource was not found",
91038
+ "attributes" : [ ]
91039
+ }, {
91040
+ "code" : {
91041
+ "integer" : {
91042
+ "value" : 422
91043
+ }
91044
+ },
91045
+ "type" : "generic_error",
91046
+ "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.",
91047
+ "attributes" : [ ]
90760
91048
  } ],
90761
91049
  "attributes" : [ {
90762
91050
  "name" : "sort",
90763
91051
  "value" : {
90764
91052
  "values" : [ {
90765
91053
  "value" : "id"
90766
- }, {
90767
- "value" : "description"
90768
91054
  }, {
90769
91055
  "value" : "created_at"
91056
+ }, {
91057
+ "value" : "updated_at"
90770
91058
  } ]
90771
91059
  }
90772
91060
  }, {
90773
91061
  "name" : "linter",
90774
91062
  "value" : {
90775
- "ignore" : [ "versions" ]
91063
+ "ignore" : [ "get", "versions" ]
90776
91064
  }
90777
- } ],
90778
- "description" : "Get all tokens for the specified organization"
91065
+ } ]
90779
91066
  }, {
90780
- "method" : "POST",
90781
- "path" : "/:organization/tokens",
91067
+ "method" : "GET",
91068
+ "path" : "/:organization/billing/pending/payout/transactions/:id",
90782
91069
  "parameters" : [ {
90783
91070
  "name" : "organization",
90784
91071
  "type" : "string",
90785
91072
  "location" : "Path",
90786
91073
  "required" : true,
90787
91074
  "description" : "Refers to your organization's account identifier"
91075
+ }, {
91076
+ "name" : "id",
91077
+ "type" : "string",
91078
+ "location" : "Path",
91079
+ "required" : true,
91080
+ "description" : "Filter by one or more IDs of this resource"
90788
91081
  } ],
90789
91082
  "responses" : [ {
90790
91083
  "code" : {
@@ -90792,7 +91085,7 @@
90792
91085
  "value" : 200
90793
91086
  }
90794
91087
  },
90795
- "type" : "organization_token",
91088
+ "type" : "organization_pending_payout_transaction",
90796
91089
  "description" : "Successful response",
90797
91090
  "attributes" : [ ]
90798
91091
  }, {
@@ -90804,6 +91097,15 @@
90804
91097
  "type" : "unit",
90805
91098
  "description" : "Authorization failed",
90806
91099
  "attributes" : [ ]
91100
+ }, {
91101
+ "code" : {
91102
+ "integer" : {
91103
+ "value" : 404
91104
+ }
91105
+ },
91106
+ "type" : "unit",
91107
+ "description" : "Resource was not found",
91108
+ "attributes" : [ ]
90807
91109
  }, {
90808
91110
  "code" : {
90809
91111
  "integer" : {
@@ -90814,12 +91116,7 @@
90814
91116
  "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.",
90815
91117
  "attributes" : [ ]
90816
91118
  } ],
90817
- "attributes" : [ ],
90818
- "description" : "Create a new organization",
90819
- "body" : {
90820
- "type" : "organization_token_form",
90821
- "attributes" : [ ]
90822
- }
91119
+ "attributes" : [ ]
90823
91120
  } ],
90824
91121
  "attributes" : [ {
90825
91122
  "name" : "docs",
@@ -90827,23 +91124,112 @@
90827
91124
  "module" : "general"
90828
91125
  }
90829
91126
  } ],
90830
- "path" : "/:organization/tokens",
90831
- "description" : "All of the metadata associated with a given token."
91127
+ "path" : "/:organization/billing/pending/payout/transactions",
91128
+ "description" : "A transaction that is pending payout."
90832
91129
  }, {
90833
- "type" : "organization_token_v2",
90834
- "plural" : "organization_token_v2",
91130
+ "type" : "organization_token",
91131
+ "plural" : "organization_tokens",
90835
91132
  "operations" : [ {
91133
+ "method" : "GET",
91134
+ "path" : "/:organization/tokens",
91135
+ "parameters" : [ {
91136
+ "name" : "organization",
91137
+ "type" : "string",
91138
+ "location" : "Path",
91139
+ "required" : true,
91140
+ "description" : "Refers to your organization's account identifier"
91141
+ }, {
91142
+ "name" : "id",
91143
+ "type" : "[string]",
91144
+ "location" : "Query",
91145
+ "required" : false,
91146
+ "description" : "Filter by one or more IDs of this resource",
91147
+ "maximum" : 100
91148
+ }, {
91149
+ "name" : "mine",
91150
+ "type" : "boolean",
91151
+ "location" : "Query",
91152
+ "required" : false,
91153
+ "description" : "Filter to tokens created by the requesting user"
91154
+ }, {
91155
+ "name" : "limit",
91156
+ "type" : "long",
91157
+ "location" : "Query",
91158
+ "required" : true,
91159
+ "description" : "The maximum number of results to return",
91160
+ "default" : "25",
91161
+ "minimum" : 1,
91162
+ "maximum" : 100
91163
+ }, {
91164
+ "name" : "offset",
91165
+ "type" : "long",
91166
+ "location" : "Query",
91167
+ "required" : true,
91168
+ "description" : "The number of results to skip before returning results",
91169
+ "default" : "0",
91170
+ "minimum" : 0
91171
+ }, {
91172
+ "name" : "sort",
91173
+ "type" : "string",
91174
+ "location" : "Query",
91175
+ "required" : true,
91176
+ "default" : "-created_at"
91177
+ } ],
91178
+ "responses" : [ {
91179
+ "code" : {
91180
+ "integer" : {
91181
+ "value" : 200
91182
+ }
91183
+ },
91184
+ "type" : "[organization_token]",
91185
+ "description" : "Successful response",
91186
+ "attributes" : [ ]
91187
+ }, {
91188
+ "code" : {
91189
+ "integer" : {
91190
+ "value" : 401
91191
+ }
91192
+ },
91193
+ "type" : "unit",
91194
+ "description" : "Authorization failed",
91195
+ "attributes" : [ ]
91196
+ } ],
91197
+ "attributes" : [ {
91198
+ "name" : "sort",
91199
+ "value" : {
91200
+ "values" : [ {
91201
+ "value" : "id"
91202
+ }, {
91203
+ "value" : "description"
91204
+ }, {
91205
+ "value" : "created_at"
91206
+ } ]
91207
+ }
91208
+ }, {
91209
+ "name" : "linter",
91210
+ "value" : {
91211
+ "ignore" : [ "versions" ]
91212
+ }
91213
+ } ],
91214
+ "description" : "Get all tokens for the specified organization"
91215
+ }, {
90836
91216
  "method" : "POST",
90837
- "path" : "/tokens/channel/organization",
90838
- "parameters" : [ ],
91217
+ "path" : "/:organization/tokens",
91218
+ "parameters" : [ {
91219
+ "name" : "organization",
91220
+ "type" : "string",
91221
+ "location" : "Path",
91222
+ "required" : true,
91223
+ "description" : "Refers to your organization's account identifier"
91224
+ } ],
90839
91225
  "responses" : [ {
90840
91226
  "code" : {
90841
91227
  "integer" : {
90842
- "value" : 201
91228
+ "value" : 200
90843
91229
  }
90844
91230
  },
90845
- "type" : "organization_token_v2",
90846
- "description" : "Operation succeeded and the resource was created",
91231
+ "type" : "organization_token",
91232
+ "description" : "Successful response",
90847
91233
  "attributes" : [ ]
90848
91234
  }, {
90849
91235
  "code" : {
@@ -90865,9 +91251,9 @@
90865
91251
  "attributes" : [ ]
90866
91252
  } ],
90867
91253
  "attributes" : [ ],
90868
- "description" : "Creates an organization token",
91254
+ "description" : "Create a new organization",
90869
91255
  "body" : {
90870
- "type" : "organization_token_form_v2",
91256
+ "type" : "organization_token_form",
90871
91257
  "attributes" : [ ]
90872
91258
  }
90873
91259
  } ],
@@ -90877,35 +91263,23 @@
90877
91263
  "module" : "general"
90878
91264
  }
90879
91265
  } ],
90880
- "path" : "/tokens/channel/organization"
91266
+ "path" : "/:organization/tokens",
91267
+ "description" : "All of the metadata associated with a given token."
90881
91268
  }, {
90882
- "type" : "organization_transaction_payout",
90883
- "plural" : "organization_transaction_payouts",
91269
+ "type" : "organization_token_v2",
91270
+ "plural" : "organization_token_v2",
90884
91271
  "operations" : [ {
90885
- "method" : "GET",
90886
- "path" : "/:organization/billing/transaction/payouts",
90887
- "parameters" : [ {
90888
- "name" : "organization",
90889
- "type" : "string",
90890
- "location" : "Path",
90891
- "required" : true,
90892
- "description" : "Refers to your organization's account identifier"
90893
- }, {
90894
- "name" : "transaction_id",
90895
- "type" : "[string]",
90896
- "location" : "Query",
90897
- "required" : true,
90898
- "minimum" : 1,
90899
- "maximum" : 100
90900
- } ],
91272
+ "method" : "POST",
91273
+ "path" : "/tokens/channel/organization",
91274
+ "parameters" : [ ],
90901
91275
  "responses" : [ {
90902
91276
  "code" : {
90903
91277
  "integer" : {
90904
- "value" : 200
91278
+ "value" : 201
90905
91279
  }
90906
91280
  },
90907
- "type" : "[organization_transaction_payout]",
90908
- "description" : "Successful response",
91281
+ "type" : "organization_token_v2",
91282
+ "description" : "Operation succeeded and the resource was created",
90909
91283
  "attributes" : [ ]
90910
91284
  }, {
90911
91285
  "code" : {
@@ -90916,15 +91290,6 @@
90916
91290
  "type" : "unit",
90917
91291
  "description" : "Authorization failed",
90918
91292
  "attributes" : [ ]
90919
- }, {
90920
- "code" : {
90921
- "integer" : {
90922
- "value" : 404
90923
- }
90924
- },
90925
- "type" : "unit",
90926
- "description" : "Resource was not found",
90927
- "attributes" : [ ]
90928
91293
  }, {
90929
91294
  "code" : {
90930
91295
  "integer" : {
@@ -90935,12 +91300,12 @@
90935
91300
  "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.",
90936
91301
  "attributes" : [ ]
90937
91302
  } ],
90938
- "attributes" : [ {
90939
- "name" : "linter",
90940
- "value" : {
90941
- "ignore" : [ "get", "versions" ]
90942
- }
90943
- } ]
91303
+ "attributes" : [ ],
91304
+ "description" : "Creates an organization token",
91305
+ "body" : {
91306
+ "type" : "organization_token_form_v2",
91307
+ "attributes" : [ ]
91308
+ }
90944
91309
  } ],
90945
91310
  "attributes" : [ {
90946
91311
  "name" : "docs",
@@ -90948,8 +91313,7 @@
90948
91313
  "module" : "general"
90949
91314
  }
90950
91315
  } ],
90951
- "path" : "/:organization/billing/transaction/payouts",
90952
- "description" : "Provides either the reference to the payout, or if no payout, a reason for what we are waiting for"
91316
+ "path" : "/tokens/channel/organization"
90953
91317
  }, {
90954
91318
  "type" : "package_dimensions",
90955
91319
  "plural" : "package_dimensionses",
@@ -91424,187 +91788,10 @@
91424
91788
  "attributes" : [ ]
91425
91789
  } ],
91426
91790
  "attributes" : [ ],
91427
- "description" : "Returns information about a specific payment request"
91428
- }, {
91429
- "method" : "PUT",
91430
- "path" : "/:organization/payment/requests/:id",
91431
- "parameters" : [ {
91432
- "name" : "organization",
91433
- "type" : "string",
91434
- "location" : "Path",
91435
- "required" : true,
91436
- "description" : "Refers to your organization's account identifier"
91437
- }, {
91438
- "name" : "id",
91439
- "type" : "string",
91440
- "location" : "Path",
91441
- "required" : true,
91442
- "description" : "Filter by one or more IDs of this resource"
91443
- } ],
91444
- "responses" : [ {
91445
- "code" : {
91446
- "integer" : {
91447
- "value" : 200
91448
- }
91449
- },
91450
- "type" : "payment_request",
91451
- "description" : "Successful response",
91452
- "attributes" : [ ]
91453
- }, {
91454
- "code" : {
91455
- "integer" : {
91456
- "value" : 401
91457
- }
91458
- },
91459
- "type" : "unit",
91460
- "description" : "Authorization failed",
91461
- "attributes" : [ ]
91462
- }, {
91463
- "code" : {
91464
- "integer" : {
91465
- "value" : 404
91466
- }
91467
- },
91468
- "type" : "unit",
91469
- "description" : "Resource was not found",
91470
- "attributes" : [ ]
91471
- }, {
91472
- "code" : {
91473
- "integer" : {
91474
- "value" : 422
91475
- }
91476
- },
91477
- "type" : "generic_error",
91478
- "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.",
91479
- "attributes" : [ ]
91480
- } ],
91481
- "attributes" : [ ],
91482
- "description" : "Updates payment request, i.e. by adding authorization data or a new payment method",
91483
- "body" : {
91484
- "type" : "payment_request_form",
91485
- "attributes" : [ ]
91486
- }
91487
- }, {
91488
- "method" : "POST",
91489
- "path" : "/:organization/payment/requests/:id/capture",
91490
- "parameters" : [ {
91491
- "name" : "organization",
91492
- "type" : "string",
91493
- "location" : "Path",
91494
- "required" : true,
91495
- "description" : "Refers to your organization's account identifier"
91496
- }, {
91497
- "name" : "id",
91498
- "type" : "string",
91499
- "location" : "Path",
91500
- "required" : true,
91501
- "description" : "Filter by one or more IDs of this resource"
91502
- } ],
91503
- "responses" : [ {
91504
- "code" : {
91505
- "integer" : {
91506
- "value" : 200
91507
- }
91508
- },
91509
- "type" : "payment_request",
91510
- "description" : "Successful response",
91511
- "attributes" : [ ]
91512
- }, {
91513
- "code" : {
91514
- "integer" : {
91515
- "value" : 401
91516
- }
91517
- },
91518
- "type" : "unit",
91519
- "description" : "Authorization failed",
91520
- "attributes" : [ ]
91521
- }, {
91522
- "code" : {
91523
- "integer" : {
91524
- "value" : 404
91525
- }
91526
- },
91527
- "type" : "unit",
91528
- "description" : "Resource was not found",
91529
- "attributes" : [ ]
91530
- }, {
91531
- "code" : {
91532
- "integer" : {
91533
- "value" : 422
91534
- }
91535
- },
91536
- "type" : "generic_error",
91537
- "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.",
91538
- "attributes" : [ ]
91539
- } ],
91540
- "attributes" : [ ],
91541
- "description" : "Captures payment",
91542
- "body" : {
91543
- "type" : "payment_capture_form",
91544
- "attributes" : [ ]
91545
- }
91546
- }, {
91547
- "method" : "POST",
91548
- "path" : "/:organization/payment/requests/:id/payment/method/data",
91549
- "parameters" : [ {
91550
- "name" : "organization",
91551
- "type" : "string",
91552
- "location" : "Path",
91553
- "required" : true,
91554
- "description" : "Refers to your organization's account identifier"
91555
- }, {
91556
- "name" : "id",
91557
- "type" : "string",
91558
- "location" : "Path",
91559
- "required" : true,
91560
- "description" : "Filter by one or more IDs of this resource"
91561
- } ],
91562
- "responses" : [ {
91563
- "code" : {
91564
- "integer" : {
91565
- "value" : 200
91566
- }
91567
- },
91568
- "type" : "payment_request",
91569
- "description" : "Successful response",
91570
- "attributes" : [ ]
91571
- }, {
91572
- "code" : {
91573
- "integer" : {
91574
- "value" : 401
91575
- }
91576
- },
91577
- "type" : "unit",
91578
- "description" : "Authorization failed",
91579
- "attributes" : [ ]
91580
- }, {
91581
- "code" : {
91582
- "integer" : {
91583
- "value" : 404
91584
- }
91585
- },
91586
- "type" : "unit",
91587
- "description" : "Resource was not found",
91588
- "attributes" : [ ]
91589
- }, {
91590
- "code" : {
91591
- "integer" : {
91592
- "value" : 422
91593
- }
91594
- },
91595
- "type" : "generic_error",
91596
- "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.",
91597
- "attributes" : [ ]
91598
- } ],
91599
- "attributes" : [ ],
91600
- "description" : "Update the payment method data to progress the payment through relevant actions",
91601
- "body" : {
91602
- "type" : "payment_method_data",
91603
- "attributes" : [ ]
91604
- }
91791
+ "description" : "Returns information about a specific payment request"
91605
91792
  }, {
91606
- "method" : "POST",
91607
- "path" : "/:organization/payment/requests/:id/payment_method_data",
91793
+ "method" : "PUT",
91794
+ "path" : "/:organization/payment/requests/:id",
91608
91795
  "parameters" : [ {
91609
91796
  "name" : "organization",
91610
91797
  "type" : "string",
@@ -91656,14 +91843,14 @@
91656
91843
  "attributes" : [ ]
91657
91844
  } ],
91658
91845
  "attributes" : [ ],
91659
- "description" : "Update the payment method data to progress the payment through relevant actions",
91846
+ "description" : "Updates payment request, i.e. by adding authorization data or a new payment method",
91660
91847
  "body" : {
91661
- "type" : "payment_method_data",
91848
+ "type" : "payment_request_form",
91662
91849
  "attributes" : [ ]
91663
91850
  }
91664
91851
  }, {
91665
91852
  "method" : "POST",
91666
- "path" : "/:organization/payment/requests/:id/refund",
91853
+ "path" : "/:organization/payment/requests/:id/capture",
91667
91854
  "parameters" : [ {
91668
91855
  "name" : "organization",
91669
91856
  "type" : "string",
@@ -91715,14 +91902,14 @@
91715
91902
  "attributes" : [ ]
91716
91903
  } ],
91717
91904
  "attributes" : [ ],
91718
- "description" : "Refunds the payment",
91905
+ "description" : "Captures payment",
91719
91906
  "body" : {
91720
- "type" : "payment_refund_form",
91907
+ "type" : "payment_capture_form",
91721
91908
  "attributes" : [ ]
91722
91909
  }
91723
91910
  }, {
91724
91911
  "method" : "POST",
91725
- "path" : "/:organization/payment/requests/:id/refund/reversal",
91912
+ "path" : "/:organization/payment/requests/:id/payment/method/data",
91726
91913
  "parameters" : [ {
91727
91914
  "name" : "organization",
91728
91915
  "type" : "string",
@@ -91774,10 +91961,14 @@
91774
91961
  "attributes" : [ ]
91775
91962
  } ],
91776
91963
  "attributes" : [ ],
91777
- "description" : "Reverses the authorization hold if the authorization is not captured yet otherwise refunds the payment entirely."
91964
+ "description" : "Update the payment method data to progress the payment through relevant actions",
91965
+ "body" : {
91966
+ "type" : "payment_method_data",
91967
+ "attributes" : [ ]
91968
+ }
91778
91969
  }, {
91779
91970
  "method" : "POST",
91780
- "path" : "/:organization/payment/requests/:id/reversal",
91971
+ "path" : "/:organization/payment/requests/:id/payment_method_data",
91781
91972
  "parameters" : [ {
91782
91973
  "name" : "organization",
91783
91974
  "type" : "string",
@@ -91829,14 +92020,14 @@
91829
92020
  "attributes" : [ ]
91830
92021
  } ],
91831
92022
  "attributes" : [ ],
91832
- "description" : "Reverses payment authorization",
92023
+ "description" : "Update the payment method data to progress the payment through relevant actions",
91833
92024
  "body" : {
91834
- "type" : "payment_reversal_form",
92025
+ "type" : "payment_method_data",
91835
92026
  "attributes" : [ ]
91836
92027
  }
91837
92028
  }, {
91838
92029
  "method" : "POST",
91839
- "path" : "/:organization/payment/requests/:id/reverse",
92030
+ "path" : "/:organization/payment/requests/:id/refund",
91840
92031
  "parameters" : [ {
91841
92032
  "name" : "organization",
91842
92033
  "type" : "string",
@@ -91888,43 +92079,35 @@
91888
92079
  "attributes" : [ ]
91889
92080
  } ],
91890
92081
  "attributes" : [ ],
91891
- "description" : "Reverses payment authorization",
91892
- "deprecation" : {
91893
- "description" : "Use POST /:id/reversal"
91894
- },
92082
+ "description" : "Refunds the payment",
91895
92083
  "body" : {
91896
- "type" : "payment_reversal_form",
92084
+ "type" : "payment_refund_form",
91897
92085
  "attributes" : [ ]
91898
92086
  }
91899
- } ],
91900
- "attributes" : [ {
91901
- "name" : "docs",
91902
- "value" : {
91903
- "module" : "general"
91904
- }
91905
- } ],
91906
- "path" : "/:organization/payment/requests"
91907
- }, {
91908
- "type" : "payment_request_bundle",
91909
- "plural" : "payment_request_bundles",
91910
- "operations" : [ {
92087
+ }, {
91911
92088
  "method" : "POST",
91912
- "path" : "/:organization/payment/request/bundles",
92089
+ "path" : "/:organization/payment/requests/:id/refund/reversal",
91913
92090
  "parameters" : [ {
91914
92091
  "name" : "organization",
91915
92092
  "type" : "string",
91916
92093
  "location" : "Path",
91917
92094
  "required" : true,
91918
92095
  "description" : "Refers to your organization's account identifier"
92096
+ }, {
92097
+ "name" : "id",
92098
+ "type" : "string",
92099
+ "location" : "Path",
92100
+ "required" : true,
92101
+ "description" : "Filter by one or more IDs of this resource"
91919
92102
  } ],
91920
92103
  "responses" : [ {
91921
92104
  "code" : {
91922
92105
  "integer" : {
91923
- "value" : 201
92106
+ "value" : 200
91924
92107
  }
91925
92108
  },
91926
- "type" : "payment_request_bundle",
91927
- "description" : "Operation succeeded and the resource was created",
92109
+ "type" : "payment_request",
92110
+ "description" : "Successful response",
91928
92111
  "attributes" : [ ]
91929
92112
  }, {
91930
92113
  "code" : {
@@ -91935,6 +92118,15 @@
91935
92118
  "type" : "unit",
91936
92119
  "description" : "Authorization failed",
91937
92120
  "attributes" : [ ]
92121
+ }, {
92122
+ "code" : {
92123
+ "integer" : {
92124
+ "value" : 404
92125
+ }
92126
+ },
92127
+ "type" : "unit",
92128
+ "description" : "Resource was not found",
92129
+ "attributes" : [ ]
91938
92130
  }, {
91939
92131
  "code" : {
91940
92132
  "integer" : {
@@ -91946,14 +92138,10 @@
91946
92138
  "attributes" : [ ]
91947
92139
  } ],
91948
92140
  "attributes" : [ ],
91949
- "description" : "Creates a new payment request bundle",
91950
- "body" : {
91951
- "type" : "payment_request_bundle_form",
91952
- "attributes" : [ ]
91953
- }
92141
+ "description" : "Reverses the authorization hold if the authorization is not captured yet otherwise refunds the payment entirely."
91954
92142
  }, {
91955
- "method" : "GET",
91956
- "path" : "/:organization/payment/request/bundles/:id",
92143
+ "method" : "POST",
92144
+ "path" : "/:organization/payment/requests/:id/reversal",
91957
92145
  "parameters" : [ {
91958
92146
  "name" : "organization",
91959
92147
  "type" : "string",
@@ -91973,7 +92161,7 @@
91973
92161
  "value" : 200
91974
92162
  }
91975
92163
  },
91976
- "type" : "payment_request_bundle",
92164
+ "type" : "payment_request",
91977
92165
  "description" : "Successful response",
91978
92166
  "attributes" : [ ]
91979
92167
  }, {
@@ -91994,12 +92182,25 @@
91994
92182
  "type" : "unit",
91995
92183
  "description" : "Resource was not found",
91996
92184
  "attributes" : [ ]
92185
+ }, {
92186
+ "code" : {
92187
+ "integer" : {
92188
+ "value" : 422
92189
+ }
92190
+ },
92191
+ "type" : "generic_error",
92192
+ "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.",
92193
+ "attributes" : [ ]
91997
92194
  } ],
91998
92195
  "attributes" : [ ],
91999
- "description" : "Returns information about a specific payment request bundle"
92196
+ "description" : "Reverses payment authorization",
92197
+ "body" : {
92198
+ "type" : "payment_reversal_form",
92199
+ "attributes" : [ ]
92200
+ }
92000
92201
  }, {
92001
- "method" : "PUT",
92002
- "path" : "/:organization/payment/request/bundles/:id",
92202
+ "method" : "POST",
92203
+ "path" : "/:organization/payment/requests/:id/reverse",
92003
92204
  "parameters" : [ {
92004
92205
  "name" : "organization",
92005
92206
  "type" : "string",
@@ -92019,7 +92220,7 @@
92019
92220
  "value" : 200
92020
92221
  }
92021
92222
  },
92022
- "type" : "payment_request_bundle",
92223
+ "type" : "payment_request",
92023
92224
  "description" : "Successful response",
92024
92225
  "attributes" : [ ]
92025
92226
  }, {
@@ -92051,9 +92252,12 @@
92051
92252
  "attributes" : [ ]
92052
92253
  } ],
92053
92254
  "attributes" : [ ],
92054
- "description" : "Updates payment request bundle",
92255
+ "description" : "Reverses payment authorization",
92256
+ "deprecation" : {
92257
+ "description" : "Use POST /:id/reversal"
92258
+ },
92055
92259
  "body" : {
92056
- "type" : "payment_request_bundle_form",
92260
+ "type" : "payment_reversal_form",
92057
92261
  "attributes" : [ ]
92058
92262
  }
92059
92263
  } ],
@@ -92063,61 +92267,69 @@
92063
92267
  "module" : "general"
92064
92268
  }
92065
92269
  } ],
92066
- "path" : "/:organization/payment/request/bundles"
92270
+ "path" : "/:organization/payment/requests"
92067
92271
  }, {
92068
- "type" : "pending_transaction",
92069
- "plural" : "pending_transactions",
92272
+ "type" : "payment_request_bundle",
92273
+ "plural" : "payment_request_bundles",
92070
92274
  "operations" : [ {
92071
- "method" : "GET",
92072
- "path" : "/:organization/billing/pending/transactions",
92275
+ "method" : "POST",
92276
+ "path" : "/:organization/payment/request/bundles",
92073
92277
  "parameters" : [ {
92074
92278
  "name" : "organization",
92075
92279
  "type" : "string",
92076
92280
  "location" : "Path",
92077
92281
  "required" : true,
92078
92282
  "description" : "Refers to your organization's account identifier"
92283
+ } ],
92284
+ "responses" : [ {
92285
+ "code" : {
92286
+ "integer" : {
92287
+ "value" : 201
92288
+ }
92289
+ },
92290
+ "type" : "payment_request_bundle",
92291
+ "description" : "Operation succeeded and the resource was created",
92292
+ "attributes" : [ ]
92079
92293
  }, {
92080
- "name" : "id",
92081
- "type" : "[string]",
92082
- "location" : "Query",
92083
- "required" : false,
92084
- "description" : "Filter by one or more IDs of this resource",
92085
- "maximum" : 100
92086
- }, {
92087
- "name" : "since",
92088
- "type" : "date-time-iso8601",
92089
- "location" : "Query",
92090
- "required" : false,
92091
- "description" : "If specified, we return all transactions where created_at >= the provided timestamp"
92092
- }, {
92093
- "name" : "updated_since",
92094
- "type" : "date-time-iso8601",
92095
- "location" : "Query",
92096
- "required" : false,
92097
- "description" : "If specified, we return all transactions where updated_at >= the provided timestamp"
92098
- }, {
92099
- "name" : "limit",
92100
- "type" : "long",
92101
- "location" : "Query",
92102
- "required" : true,
92103
- "description" : "The maximum number of results to return",
92104
- "default" : "25",
92105
- "minimum" : 1,
92106
- "maximum" : 100
92294
+ "code" : {
92295
+ "integer" : {
92296
+ "value" : 401
92297
+ }
92298
+ },
92299
+ "type" : "unit",
92300
+ "description" : "Authorization failed",
92301
+ "attributes" : [ ]
92107
92302
  }, {
92108
- "name" : "offset",
92109
- "type" : "long",
92110
- "location" : "Query",
92303
+ "code" : {
92304
+ "integer" : {
92305
+ "value" : 422
92306
+ }
92307
+ },
92308
+ "type" : "generic_error",
92309
+ "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.",
92310
+ "attributes" : [ ]
92311
+ } ],
92312
+ "attributes" : [ ],
92313
+ "description" : "Creates a new payment request bundle",
92314
+ "body" : {
92315
+ "type" : "payment_request_bundle_form",
92316
+ "attributes" : [ ]
92317
+ }
92318
+ }, {
92319
+ "method" : "GET",
92320
+ "path" : "/:organization/payment/request/bundles/:id",
92321
+ "parameters" : [ {
92322
+ "name" : "organization",
92323
+ "type" : "string",
92324
+ "location" : "Path",
92111
92325
  "required" : true,
92112
- "description" : "The number of results to skip before returning results",
92113
- "default" : "0",
92114
- "minimum" : 0
92326
+ "description" : "Refers to your organization's account identifier"
92115
92327
  }, {
92116
- "name" : "sort",
92328
+ "name" : "id",
92117
92329
  "type" : "string",
92118
- "location" : "Query",
92330
+ "location" : "Path",
92119
92331
  "required" : true,
92120
- "default" : "-created_at"
92332
+ "description" : "Filter by one or more IDs of this resource"
92121
92333
  } ],
92122
92334
  "responses" : [ {
92123
92335
  "code" : {
@@ -92125,7 +92337,7 @@
92125
92337
  "value" : 200
92126
92338
  }
92127
92339
  },
92128
- "type" : "[pending_transaction]",
92340
+ "type" : "payment_request_bundle",
92129
92341
  "description" : "Successful response",
92130
92342
  "attributes" : [ ]
92131
92343
  }, {
@@ -92146,36 +92358,12 @@
92146
92358
  "type" : "unit",
92147
92359
  "description" : "Resource was not found",
92148
92360
  "attributes" : [ ]
92149
- }, {
92150
- "code" : {
92151
- "integer" : {
92152
- "value" : 422
92153
- }
92154
- },
92155
- "type" : "generic_error",
92156
- "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.",
92157
- "attributes" : [ ]
92158
92361
  } ],
92159
- "attributes" : [ {
92160
- "name" : "sort",
92161
- "value" : {
92162
- "values" : [ {
92163
- "value" : "id"
92164
- }, {
92165
- "value" : "created_at"
92166
- }, {
92167
- "value" : "updated_at"
92168
- } ]
92169
- }
92170
- }, {
92171
- "name" : "linter",
92172
- "value" : {
92173
- "ignore" : [ "versions" ]
92174
- }
92175
- } ]
92362
+ "attributes" : [ ],
92363
+ "description" : "Returns information about a specific payment request bundle"
92176
92364
  }, {
92177
- "method" : "GET",
92178
- "path" : "/:organization/billing/pending/transactions/:id",
92365
+ "method" : "PUT",
92366
+ "path" : "/:organization/payment/request/bundles/:id",
92179
92367
  "parameters" : [ {
92180
92368
  "name" : "organization",
92181
92369
  "type" : "string",
@@ -92195,7 +92383,7 @@
92195
92383
  "value" : 200
92196
92384
  }
92197
92385
  },
92198
- "type" : "pending_transaction",
92386
+ "type" : "payment_request_bundle",
92199
92387
  "description" : "Successful response",
92200
92388
  "attributes" : [ ]
92201
92389
  }, {
@@ -92226,7 +92414,12 @@
92226
92414
  "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.",
92227
92415
  "attributes" : [ ]
92228
92416
  } ],
92229
- "attributes" : [ ]
92417
+ "attributes" : [ ],
92418
+ "description" : "Updates payment request bundle",
92419
+ "body" : {
92420
+ "type" : "payment_request_bundle_form",
92421
+ "attributes" : [ ]
92422
+ }
92230
92423
  } ],
92231
92424
  "attributes" : [ {
92232
92425
  "name" : "docs",
@@ -92234,8 +92427,7 @@
92234
92427
  "module" : "general"
92235
92428
  }
92236
92429
  } ],
92237
- "path" : "/:organization/billing/pending/transactions",
92238
- "description" : "A transaction that is pending payout."
92430
+ "path" : "/:organization/payment/request/bundles"
92239
92431
  }, {
92240
92432
  "type" : "permission_check",
92241
92433
  "plural" : "permission_checks",