@flowio/api-mock-generator 6.17.41 → 6.17.42
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 +1223 -435
- package/package.json +2 -2
- package/src/api.json +1223 -435
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.
|
|
13
|
+
"version" : "0.17.14",
|
|
14
14
|
"info" : {
|
|
15
15
|
"license" : {
|
|
16
16
|
"name" : "MIT",
|
|
@@ -1195,6 +1195,9 @@
|
|
|
1195
1195
|
"name" : "event_type",
|
|
1196
1196
|
"plural" : "event_types",
|
|
1197
1197
|
"values" : [ {
|
|
1198
|
+
"name" : "test_upserted",
|
|
1199
|
+
"attributes" : [ ]
|
|
1200
|
+
}, {
|
|
1198
1201
|
"name" : "transaction_upserted",
|
|
1199
1202
|
"attributes" : [ ]
|
|
1200
1203
|
}, {
|
|
@@ -3447,6 +3450,80 @@
|
|
|
3447
3450
|
} ],
|
|
3448
3451
|
"attributes" : [ ],
|
|
3449
3452
|
"description" : "The payment method type defines at a high level different user experiences that are required to accept payment of this type. By enabling a payment method type, you are specifying that you have completed the integration and all payment methods of this type become available for offer to your users."
|
|
3453
|
+
}, {
|
|
3454
|
+
"name" : "payment_request_review_check_status",
|
|
3455
|
+
"plural" : "payment_request_review_check_statuses",
|
|
3456
|
+
"values" : [ {
|
|
3457
|
+
"name" : "passed",
|
|
3458
|
+
"attributes" : [ ],
|
|
3459
|
+
"description" : "The check has passed."
|
|
3460
|
+
}, {
|
|
3461
|
+
"name" : "failed",
|
|
3462
|
+
"attributes" : [ ],
|
|
3463
|
+
"description" : "The check has failed."
|
|
3464
|
+
} ],
|
|
3465
|
+
"attributes" : [ ],
|
|
3466
|
+
"description" : "The status of a payment check."
|
|
3467
|
+
}, {
|
|
3468
|
+
"name" : "payment_request_review_check_type",
|
|
3469
|
+
"plural" : "payment_request_review_check_types",
|
|
3470
|
+
"values" : [ {
|
|
3471
|
+
"name" : "restricted_party_screening",
|
|
3472
|
+
"attributes" : [ ],
|
|
3473
|
+
"description" : "The customer is on the restricted party list."
|
|
3474
|
+
}, {
|
|
3475
|
+
"name" : "fraud_suspicious_behavior",
|
|
3476
|
+
"attributes" : [ ],
|
|
3477
|
+
"description" : "Suspicious behavior such as irregular behavioral data signals."
|
|
3478
|
+
}, {
|
|
3479
|
+
"name" : "fraud_suspicious_past_activity",
|
|
3480
|
+
"attributes" : [ ],
|
|
3481
|
+
"description" : "The customer is associated with past suspicious behavior on the partner network. For example, association with a past chargeback at your store or another merchant in our partner network, suspicious use of payment methods, shipping addresses, etc."
|
|
3482
|
+
}, {
|
|
3483
|
+
"name" : "fraud_risky_velocity",
|
|
3484
|
+
"attributes" : [ ],
|
|
3485
|
+
"description" : "The purchase frequency or amount are unusually high given previous reputation, and is a high risk of fraud."
|
|
3486
|
+
}, {
|
|
3487
|
+
"name" : "fraud_previous_chargebacks",
|
|
3488
|
+
"attributes" : [ ],
|
|
3489
|
+
"description" : "Previous transactions on the account have received fraud chargebacks."
|
|
3490
|
+
}, {
|
|
3491
|
+
"name" : "order_restricted_goods",
|
|
3492
|
+
"attributes" : [ ],
|
|
3493
|
+
"description" : "The order contains restricted goods."
|
|
3494
|
+
}, {
|
|
3495
|
+
"name" : "order_unsupported_destination",
|
|
3496
|
+
"attributes" : [ ],
|
|
3497
|
+
"description" : "The destination is not supported."
|
|
3498
|
+
}, {
|
|
3499
|
+
"name" : "order_missing_information",
|
|
3500
|
+
"attributes" : [ ],
|
|
3501
|
+
"description" : "The order is missing information."
|
|
3502
|
+
}, {
|
|
3503
|
+
"name" : "order_domestic",
|
|
3504
|
+
"attributes" : [ ],
|
|
3505
|
+
"description" : "The order is a domestic order."
|
|
3506
|
+
} ],
|
|
3507
|
+
"attributes" : [ ],
|
|
3508
|
+
"description" : "The type of check that was performed."
|
|
3509
|
+
}, {
|
|
3510
|
+
"name" : "payment_request_review_status",
|
|
3511
|
+
"plural" : "payment_request_review_statuses",
|
|
3512
|
+
"values" : [ {
|
|
3513
|
+
"name" : "pending",
|
|
3514
|
+
"attributes" : [ ],
|
|
3515
|
+
"description" : "The payment request is pending review."
|
|
3516
|
+
}, {
|
|
3517
|
+
"name" : "approved",
|
|
3518
|
+
"attributes" : [ ],
|
|
3519
|
+
"description" : "The payment request has been approved."
|
|
3520
|
+
}, {
|
|
3521
|
+
"name" : "rejected",
|
|
3522
|
+
"attributes" : [ ],
|
|
3523
|
+
"description" : "The payment request has been rejected."
|
|
3524
|
+
} ],
|
|
3525
|
+
"attributes" : [ ],
|
|
3526
|
+
"description" : "The status of the payment request review."
|
|
3450
3527
|
}, {
|
|
3451
3528
|
"name" : "payment_source_confirmation_action_type",
|
|
3452
3529
|
"plural" : "payment_source_confirmation_action_types",
|
|
@@ -5219,6 +5296,12 @@
|
|
|
5219
5296
|
"attributes" : [ ],
|
|
5220
5297
|
"annotations" : [ ],
|
|
5221
5298
|
"description" : "Globally unique identifier"
|
|
5299
|
+
}, {
|
|
5300
|
+
"name" : "key",
|
|
5301
|
+
"type" : "string",
|
|
5302
|
+
"required" : true,
|
|
5303
|
+
"attributes" : [ ],
|
|
5304
|
+
"annotations" : [ ]
|
|
5222
5305
|
}, {
|
|
5223
5306
|
"name" : "last4",
|
|
5224
5307
|
"type" : "string",
|
|
@@ -5493,12 +5576,6 @@
|
|
|
5493
5576
|
"required" : false,
|
|
5494
5577
|
"attributes" : [ ],
|
|
5495
5578
|
"annotations" : [ ]
|
|
5496
|
-
}, {
|
|
5497
|
-
"name" : "statement",
|
|
5498
|
-
"type" : "billing_channel_statement_reference",
|
|
5499
|
-
"required" : false,
|
|
5500
|
-
"attributes" : [ ],
|
|
5501
|
-
"annotations" : [ ]
|
|
5502
5579
|
}, {
|
|
5503
5580
|
"name" : "payment_request",
|
|
5504
5581
|
"type" : "billing_channel_payment_request_reference",
|
|
@@ -5740,6 +5817,13 @@
|
|
|
5740
5817
|
"required" : true,
|
|
5741
5818
|
"attributes" : [ ],
|
|
5742
5819
|
"annotations" : [ ]
|
|
5820
|
+
}, {
|
|
5821
|
+
"name" : "bank_account",
|
|
5822
|
+
"type" : "bank_account_summary",
|
|
5823
|
+
"required" : false,
|
|
5824
|
+
"attributes" : [ ],
|
|
5825
|
+
"annotations" : [ ],
|
|
5826
|
+
"description" : "The bank account to which we sent this payout if known"
|
|
5743
5827
|
}, {
|
|
5744
5828
|
"name" : "amount",
|
|
5745
5829
|
"type" : "decimal",
|
|
@@ -6170,6 +6254,10 @@
|
|
|
6170
6254
|
"type" : "threeds_challenge_action_details",
|
|
6171
6255
|
"attributes" : [ ],
|
|
6172
6256
|
"discriminator_value" : "threeds_challenge_action_details"
|
|
6257
|
+
}, {
|
|
6258
|
+
"type" : "applepay_sdk_authorization_result_action_details",
|
|
6259
|
+
"attributes" : [ ],
|
|
6260
|
+
"discriminator_value" : "applepay_sdk_authorization_result_action_details"
|
|
6173
6261
|
}, {
|
|
6174
6262
|
"type" : "klarna_sdk_authorization_result_action_details",
|
|
6175
6263
|
"attributes" : [ ],
|
|
@@ -6432,6 +6520,10 @@
|
|
|
6432
6520
|
"name" : "event",
|
|
6433
6521
|
"plural" : "events",
|
|
6434
6522
|
"types" : [ {
|
|
6523
|
+
"type" : "test_upserted",
|
|
6524
|
+
"attributes" : [ ],
|
|
6525
|
+
"discriminator_value" : "test_upserted"
|
|
6526
|
+
}, {
|
|
6435
6527
|
"type" : "transaction_upserted",
|
|
6436
6528
|
"attributes" : [ ],
|
|
6437
6529
|
"discriminator_value" : "transaction_upserted"
|
|
@@ -10480,6 +10572,25 @@
|
|
|
10480
10572
|
} ],
|
|
10481
10573
|
"attributes" : [ ],
|
|
10482
10574
|
"interfaces" : [ ]
|
|
10575
|
+
}, {
|
|
10576
|
+
"name" : "applepay_sdk_authorization_result_action_details",
|
|
10577
|
+
"plural" : "applepay_sdk_authorization_result_action_detailses",
|
|
10578
|
+
"fields" : [ {
|
|
10579
|
+
"name" : "merchant_identifier",
|
|
10580
|
+
"type" : "string",
|
|
10581
|
+
"required" : true,
|
|
10582
|
+
"attributes" : [ ],
|
|
10583
|
+
"annotations" : [ ]
|
|
10584
|
+
}, {
|
|
10585
|
+
"name" : "payment_data_request",
|
|
10586
|
+
"type" : "object",
|
|
10587
|
+
"required" : true,
|
|
10588
|
+
"attributes" : [ ],
|
|
10589
|
+
"annotations" : [ ]
|
|
10590
|
+
} ],
|
|
10591
|
+
"attributes" : [ ],
|
|
10592
|
+
"interfaces" : [ ],
|
|
10593
|
+
"description" : "Provides details for Apple Pay authorizations."
|
|
10483
10594
|
}, {
|
|
10484
10595
|
"name" : "at_cost",
|
|
10485
10596
|
"plural" : "at_costs",
|
|
@@ -11933,13 +12044,6 @@
|
|
|
11933
12044
|
"name" : "bank_account_form",
|
|
11934
12045
|
"plural" : "bank_account_forms",
|
|
11935
12046
|
"fields" : [ {
|
|
11936
|
-
"name" : "last4",
|
|
11937
|
-
"type" : "string",
|
|
11938
|
-
"required" : true,
|
|
11939
|
-
"attributes" : [ ],
|
|
11940
|
-
"annotations" : [ ],
|
|
11941
|
-
"description" : "The last four digits of the bank account number"
|
|
11942
|
-
}, {
|
|
11943
12047
|
"name" : "info",
|
|
11944
12048
|
"type" : "bank_account_info",
|
|
11945
12049
|
"required" : true,
|
|
@@ -11979,6 +12083,18 @@
|
|
|
11979
12083
|
} ],
|
|
11980
12084
|
"attributes" : [ ],
|
|
11981
12085
|
"interfaces" : [ ]
|
|
12086
|
+
}, {
|
|
12087
|
+
"name" : "bank_account_summary",
|
|
12088
|
+
"plural" : "bank_account_summaries",
|
|
12089
|
+
"fields" : [ {
|
|
12090
|
+
"name" : "last4",
|
|
12091
|
+
"type" : "string",
|
|
12092
|
+
"required" : true,
|
|
12093
|
+
"attributes" : [ ],
|
|
12094
|
+
"annotations" : [ ]
|
|
12095
|
+
} ],
|
|
12096
|
+
"attributes" : [ ],
|
|
12097
|
+
"interfaces" : [ ]
|
|
11982
12098
|
}, {
|
|
11983
12099
|
"name" : "behavior_audit",
|
|
11984
12100
|
"plural" : "behavior_audits",
|
|
@@ -14520,8 +14636,8 @@
|
|
|
14520
14636
|
"attributes" : [ ],
|
|
14521
14637
|
"interfaces" : [ ]
|
|
14522
14638
|
}, {
|
|
14523
|
-
"name" : "
|
|
14524
|
-
"plural" : "
|
|
14639
|
+
"name" : "channel_bank_account",
|
|
14640
|
+
"plural" : "channel_bank_accounts",
|
|
14525
14641
|
"fields" : [ {
|
|
14526
14642
|
"name" : "id",
|
|
14527
14643
|
"type" : "string",
|
|
@@ -14530,107 +14646,23 @@
|
|
|
14530
14646
|
"annotations" : [ ],
|
|
14531
14647
|
"description" : "Globally unique identifier"
|
|
14532
14648
|
}, {
|
|
14533
|
-
"name" : "
|
|
14534
|
-
"type" : "string",
|
|
14535
|
-
"required" : true,
|
|
14536
|
-
"attributes" : [ ],
|
|
14537
|
-
"annotations" : [ ]
|
|
14538
|
-
}, {
|
|
14539
|
-
"name" : "channel",
|
|
14540
|
-
"type" : "channel_reference",
|
|
14541
|
-
"required" : true,
|
|
14542
|
-
"attributes" : [ ],
|
|
14543
|
-
"annotations" : [ ]
|
|
14544
|
-
}, {
|
|
14545
|
-
"name" : "capabilities",
|
|
14546
|
-
"type" : "[channel_currency_capability]",
|
|
14547
|
-
"required" : true,
|
|
14548
|
-
"attributes" : [ ],
|
|
14549
|
-
"annotations" : [ ],
|
|
14550
|
-
"minimum" : 0
|
|
14551
|
-
} ],
|
|
14552
|
-
"attributes" : [ ],
|
|
14553
|
-
"interfaces" : [ ]
|
|
14554
|
-
}, {
|
|
14555
|
-
"name" : "channel_currency_deleted",
|
|
14556
|
-
"plural" : "channel_currency_deleteds",
|
|
14557
|
-
"fields" : [ {
|
|
14558
|
-
"name" : "event_id",
|
|
14559
|
-
"type" : "string",
|
|
14560
|
-
"required" : true,
|
|
14561
|
-
"attributes" : [ ],
|
|
14562
|
-
"annotations" : [ ]
|
|
14563
|
-
}, {
|
|
14564
|
-
"name" : "timestamp",
|
|
14565
|
-
"type" : "date-time-iso8601",
|
|
14566
|
-
"required" : true,
|
|
14567
|
-
"attributes" : [ ],
|
|
14568
|
-
"annotations" : [ ],
|
|
14569
|
-
"description" : "The date/time of the request"
|
|
14570
|
-
}, {
|
|
14571
|
-
"name" : "id",
|
|
14572
|
-
"type" : "string",
|
|
14573
|
-
"required" : true,
|
|
14574
|
-
"attributes" : [ ],
|
|
14575
|
-
"annotations" : [ ],
|
|
14576
|
-
"description" : "Globally unique identifier"
|
|
14577
|
-
} ],
|
|
14578
|
-
"attributes" : [ ],
|
|
14579
|
-
"interfaces" : [ ]
|
|
14580
|
-
}, {
|
|
14581
|
-
"name" : "channel_currency_upserted",
|
|
14582
|
-
"plural" : "channel_currency_upserteds",
|
|
14583
|
-
"fields" : [ {
|
|
14584
|
-
"name" : "event_id",
|
|
14649
|
+
"name" : "key",
|
|
14585
14650
|
"type" : "string",
|
|
14586
14651
|
"required" : true,
|
|
14587
14652
|
"attributes" : [ ],
|
|
14588
14653
|
"annotations" : [ ]
|
|
14589
14654
|
}, {
|
|
14590
|
-
"name" : "
|
|
14591
|
-
"type" : "date-time-iso8601",
|
|
14592
|
-
"required" : true,
|
|
14593
|
-
"attributes" : [ ],
|
|
14594
|
-
"annotations" : [ ],
|
|
14595
|
-
"description" : "The date/time of the request"
|
|
14596
|
-
}, {
|
|
14597
|
-
"name" : "channel_currency",
|
|
14598
|
-
"type" : "channel_currency",
|
|
14599
|
-
"required" : true,
|
|
14600
|
-
"attributes" : [ ],
|
|
14601
|
-
"annotations" : [ ]
|
|
14602
|
-
} ],
|
|
14603
|
-
"attributes" : [ ],
|
|
14604
|
-
"interfaces" : [ ]
|
|
14605
|
-
}, {
|
|
14606
|
-
"name" : "channel_deleted",
|
|
14607
|
-
"plural" : "channel_deleteds",
|
|
14608
|
-
"fields" : [ {
|
|
14609
|
-
"name" : "event_id",
|
|
14655
|
+
"name" : "last4",
|
|
14610
14656
|
"type" : "string",
|
|
14611
14657
|
"required" : true,
|
|
14612
14658
|
"attributes" : [ ],
|
|
14613
14659
|
"annotations" : [ ]
|
|
14614
|
-
}, {
|
|
14615
|
-
"name" : "timestamp",
|
|
14616
|
-
"type" : "date-time-iso8601",
|
|
14617
|
-
"required" : true,
|
|
14618
|
-
"attributes" : [ ],
|
|
14619
|
-
"annotations" : [ ],
|
|
14620
|
-
"description" : "The date/time of the request"
|
|
14621
|
-
}, {
|
|
14622
|
-
"name" : "id",
|
|
14623
|
-
"type" : "string",
|
|
14624
|
-
"required" : true,
|
|
14625
|
-
"attributes" : [ ],
|
|
14626
|
-
"annotations" : [ ],
|
|
14627
|
-
"description" : "Globally unique identifier"
|
|
14628
14660
|
} ],
|
|
14629
14661
|
"attributes" : [ ],
|
|
14630
|
-
"interfaces" : [ ]
|
|
14662
|
+
"interfaces" : [ "bank_account" ]
|
|
14631
14663
|
}, {
|
|
14632
|
-
"name" : "
|
|
14633
|
-
"plural" : "
|
|
14664
|
+
"name" : "channel_currency",
|
|
14665
|
+
"plural" : "channel_currencies",
|
|
14634
14666
|
"fields" : [ {
|
|
14635
14667
|
"name" : "id",
|
|
14636
14668
|
"type" : "string",
|
|
@@ -14639,14 +14671,7 @@
|
|
|
14639
14671
|
"annotations" : [ ],
|
|
14640
14672
|
"description" : "Globally unique identifier"
|
|
14641
14673
|
}, {
|
|
14642
|
-
"name" : "
|
|
14643
|
-
"type" : "organization_reference",
|
|
14644
|
-
"required" : true,
|
|
14645
|
-
"attributes" : [ ],
|
|
14646
|
-
"annotations" : [ ],
|
|
14647
|
-
"description" : "Refers to your organization's account identifier"
|
|
14648
|
-
}, {
|
|
14649
|
-
"name" : "key",
|
|
14674
|
+
"name" : "currency",
|
|
14650
14675
|
"type" : "string",
|
|
14651
14676
|
"required" : true,
|
|
14652
14677
|
"attributes" : [ ],
|
|
@@ -14658,66 +14683,201 @@
|
|
|
14658
14683
|
"attributes" : [ ],
|
|
14659
14684
|
"annotations" : [ ]
|
|
14660
14685
|
}, {
|
|
14661
|
-
"name" : "
|
|
14662
|
-
"type" : "
|
|
14686
|
+
"name" : "capabilities",
|
|
14687
|
+
"type" : "[channel_currency_capability]",
|
|
14663
14688
|
"required" : true,
|
|
14664
14689
|
"attributes" : [ ],
|
|
14665
|
-
"annotations" : [ ]
|
|
14666
|
-
}, {
|
|
14667
|
-
"name" : "slug",
|
|
14668
|
-
"type" : "string",
|
|
14669
|
-
"required" : false,
|
|
14670
|
-
"attributes" : [ ],
|
|
14671
14690
|
"annotations" : [ ],
|
|
14672
|
-
"
|
|
14673
|
-
}, {
|
|
14674
|
-
"name" : "defaults",
|
|
14675
|
-
"type" : "organization_defaults",
|
|
14676
|
-
"required" : true,
|
|
14677
|
-
"attributes" : [ ],
|
|
14678
|
-
"annotations" : [ ]
|
|
14679
|
-
}, {
|
|
14680
|
-
"name" : "attributes",
|
|
14681
|
-
"type" : "map[string]",
|
|
14682
|
-
"required" : false,
|
|
14683
|
-
"attributes" : [ ],
|
|
14684
|
-
"annotations" : [ ]
|
|
14685
|
-
} ],
|
|
14686
|
-
"attributes" : [ ],
|
|
14687
|
-
"interfaces" : [ ]
|
|
14688
|
-
}, {
|
|
14689
|
-
"name" : "channel_organization_authorization",
|
|
14690
|
-
"plural" : "channel_organization_authorizations",
|
|
14691
|
-
"fields" : [ {
|
|
14692
|
-
"name" : "placeholder",
|
|
14693
|
-
"type" : "string",
|
|
14694
|
-
"required" : false,
|
|
14695
|
-
"attributes" : [ ],
|
|
14696
|
-
"annotations" : [ ]
|
|
14697
|
-
} ],
|
|
14698
|
-
"attributes" : [ ],
|
|
14699
|
-
"interfaces" : [ ]
|
|
14700
|
-
}, {
|
|
14701
|
-
"name" : "channel_organization_authorization_form",
|
|
14702
|
-
"plural" : "channel_organization_authorization_forms",
|
|
14703
|
-
"fields" : [ {
|
|
14704
|
-
"name" : "channel_id",
|
|
14705
|
-
"type" : "string",
|
|
14706
|
-
"required" : true,
|
|
14707
|
-
"attributes" : [ ],
|
|
14708
|
-
"annotations" : [ ]
|
|
14709
|
-
}, {
|
|
14710
|
-
"name" : "organization_id",
|
|
14711
|
-
"type" : "string",
|
|
14712
|
-
"required" : true,
|
|
14713
|
-
"attributes" : [ ],
|
|
14714
|
-
"annotations" : [ ]
|
|
14691
|
+
"minimum" : 0
|
|
14715
14692
|
} ],
|
|
14716
14693
|
"attributes" : [ ],
|
|
14717
14694
|
"interfaces" : [ ]
|
|
14718
14695
|
}, {
|
|
14719
|
-
"name" : "
|
|
14720
|
-
"plural" : "
|
|
14696
|
+
"name" : "channel_currency_deleted",
|
|
14697
|
+
"plural" : "channel_currency_deleteds",
|
|
14698
|
+
"fields" : [ {
|
|
14699
|
+
"name" : "event_id",
|
|
14700
|
+
"type" : "string",
|
|
14701
|
+
"required" : true,
|
|
14702
|
+
"attributes" : [ ],
|
|
14703
|
+
"annotations" : [ ]
|
|
14704
|
+
}, {
|
|
14705
|
+
"name" : "timestamp",
|
|
14706
|
+
"type" : "date-time-iso8601",
|
|
14707
|
+
"required" : true,
|
|
14708
|
+
"attributes" : [ ],
|
|
14709
|
+
"annotations" : [ ],
|
|
14710
|
+
"description" : "The date/time of the request"
|
|
14711
|
+
}, {
|
|
14712
|
+
"name" : "id",
|
|
14713
|
+
"type" : "string",
|
|
14714
|
+
"required" : true,
|
|
14715
|
+
"attributes" : [ ],
|
|
14716
|
+
"annotations" : [ ],
|
|
14717
|
+
"description" : "Globally unique identifier"
|
|
14718
|
+
} ],
|
|
14719
|
+
"attributes" : [ ],
|
|
14720
|
+
"interfaces" : [ ]
|
|
14721
|
+
}, {
|
|
14722
|
+
"name" : "channel_currency_upserted",
|
|
14723
|
+
"plural" : "channel_currency_upserteds",
|
|
14724
|
+
"fields" : [ {
|
|
14725
|
+
"name" : "event_id",
|
|
14726
|
+
"type" : "string",
|
|
14727
|
+
"required" : true,
|
|
14728
|
+
"attributes" : [ ],
|
|
14729
|
+
"annotations" : [ ]
|
|
14730
|
+
}, {
|
|
14731
|
+
"name" : "timestamp",
|
|
14732
|
+
"type" : "date-time-iso8601",
|
|
14733
|
+
"required" : true,
|
|
14734
|
+
"attributes" : [ ],
|
|
14735
|
+
"annotations" : [ ],
|
|
14736
|
+
"description" : "The date/time of the request"
|
|
14737
|
+
}, {
|
|
14738
|
+
"name" : "channel_currency",
|
|
14739
|
+
"type" : "channel_currency",
|
|
14740
|
+
"required" : true,
|
|
14741
|
+
"attributes" : [ ],
|
|
14742
|
+
"annotations" : [ ]
|
|
14743
|
+
} ],
|
|
14744
|
+
"attributes" : [ ],
|
|
14745
|
+
"interfaces" : [ ]
|
|
14746
|
+
}, {
|
|
14747
|
+
"name" : "channel_default_bank_account",
|
|
14748
|
+
"plural" : "channel_default_bank_accounts",
|
|
14749
|
+
"fields" : [ {
|
|
14750
|
+
"name" : "id",
|
|
14751
|
+
"type" : "string",
|
|
14752
|
+
"required" : true,
|
|
14753
|
+
"attributes" : [ ],
|
|
14754
|
+
"annotations" : [ ],
|
|
14755
|
+
"description" : "Globally unique identifier"
|
|
14756
|
+
}, {
|
|
14757
|
+
"name" : "bank_account",
|
|
14758
|
+
"type" : "bank_account_reference",
|
|
14759
|
+
"required" : true,
|
|
14760
|
+
"attributes" : [ ],
|
|
14761
|
+
"annotations" : [ ]
|
|
14762
|
+
} ],
|
|
14763
|
+
"attributes" : [ ],
|
|
14764
|
+
"interfaces" : [ "default_bank_account" ]
|
|
14765
|
+
}, {
|
|
14766
|
+
"name" : "channel_deleted",
|
|
14767
|
+
"plural" : "channel_deleteds",
|
|
14768
|
+
"fields" : [ {
|
|
14769
|
+
"name" : "event_id",
|
|
14770
|
+
"type" : "string",
|
|
14771
|
+
"required" : true,
|
|
14772
|
+
"attributes" : [ ],
|
|
14773
|
+
"annotations" : [ ]
|
|
14774
|
+
}, {
|
|
14775
|
+
"name" : "timestamp",
|
|
14776
|
+
"type" : "date-time-iso8601",
|
|
14777
|
+
"required" : true,
|
|
14778
|
+
"attributes" : [ ],
|
|
14779
|
+
"annotations" : [ ],
|
|
14780
|
+
"description" : "The date/time of the request"
|
|
14781
|
+
}, {
|
|
14782
|
+
"name" : "id",
|
|
14783
|
+
"type" : "string",
|
|
14784
|
+
"required" : true,
|
|
14785
|
+
"attributes" : [ ],
|
|
14786
|
+
"annotations" : [ ],
|
|
14787
|
+
"description" : "Globally unique identifier"
|
|
14788
|
+
} ],
|
|
14789
|
+
"attributes" : [ ],
|
|
14790
|
+
"interfaces" : [ ]
|
|
14791
|
+
}, {
|
|
14792
|
+
"name" : "channel_organization",
|
|
14793
|
+
"plural" : "channel_organizations",
|
|
14794
|
+
"fields" : [ {
|
|
14795
|
+
"name" : "id",
|
|
14796
|
+
"type" : "string",
|
|
14797
|
+
"required" : true,
|
|
14798
|
+
"attributes" : [ ],
|
|
14799
|
+
"annotations" : [ ],
|
|
14800
|
+
"description" : "Globally unique identifier"
|
|
14801
|
+
}, {
|
|
14802
|
+
"name" : "organization",
|
|
14803
|
+
"type" : "organization_reference",
|
|
14804
|
+
"required" : true,
|
|
14805
|
+
"attributes" : [ ],
|
|
14806
|
+
"annotations" : [ ],
|
|
14807
|
+
"description" : "Refers to your organization's account identifier"
|
|
14808
|
+
}, {
|
|
14809
|
+
"name" : "key",
|
|
14810
|
+
"type" : "string",
|
|
14811
|
+
"required" : true,
|
|
14812
|
+
"attributes" : [ ],
|
|
14813
|
+
"annotations" : [ ]
|
|
14814
|
+
}, {
|
|
14815
|
+
"name" : "channel",
|
|
14816
|
+
"type" : "channel_reference",
|
|
14817
|
+
"required" : true,
|
|
14818
|
+
"attributes" : [ ],
|
|
14819
|
+
"annotations" : [ ]
|
|
14820
|
+
}, {
|
|
14821
|
+
"name" : "name",
|
|
14822
|
+
"type" : "string",
|
|
14823
|
+
"required" : true,
|
|
14824
|
+
"attributes" : [ ],
|
|
14825
|
+
"annotations" : [ ]
|
|
14826
|
+
}, {
|
|
14827
|
+
"name" : "slug",
|
|
14828
|
+
"type" : "string",
|
|
14829
|
+
"required" : false,
|
|
14830
|
+
"attributes" : [ ],
|
|
14831
|
+
"annotations" : [ ],
|
|
14832
|
+
"description" : "If specified, the slug is used as part of the id of the flow organization we create. If not specified, defaults to the id"
|
|
14833
|
+
}, {
|
|
14834
|
+
"name" : "defaults",
|
|
14835
|
+
"type" : "organization_defaults",
|
|
14836
|
+
"required" : true,
|
|
14837
|
+
"attributes" : [ ],
|
|
14838
|
+
"annotations" : [ ]
|
|
14839
|
+
}, {
|
|
14840
|
+
"name" : "attributes",
|
|
14841
|
+
"type" : "map[string]",
|
|
14842
|
+
"required" : false,
|
|
14843
|
+
"attributes" : [ ],
|
|
14844
|
+
"annotations" : [ ]
|
|
14845
|
+
} ],
|
|
14846
|
+
"attributes" : [ ],
|
|
14847
|
+
"interfaces" : [ ]
|
|
14848
|
+
}, {
|
|
14849
|
+
"name" : "channel_organization_authorization",
|
|
14850
|
+
"plural" : "channel_organization_authorizations",
|
|
14851
|
+
"fields" : [ {
|
|
14852
|
+
"name" : "placeholder",
|
|
14853
|
+
"type" : "string",
|
|
14854
|
+
"required" : false,
|
|
14855
|
+
"attributes" : [ ],
|
|
14856
|
+
"annotations" : [ ]
|
|
14857
|
+
} ],
|
|
14858
|
+
"attributes" : [ ],
|
|
14859
|
+
"interfaces" : [ ]
|
|
14860
|
+
}, {
|
|
14861
|
+
"name" : "channel_organization_authorization_form",
|
|
14862
|
+
"plural" : "channel_organization_authorization_forms",
|
|
14863
|
+
"fields" : [ {
|
|
14864
|
+
"name" : "channel_id",
|
|
14865
|
+
"type" : "string",
|
|
14866
|
+
"required" : true,
|
|
14867
|
+
"attributes" : [ ],
|
|
14868
|
+
"annotations" : [ ]
|
|
14869
|
+
}, {
|
|
14870
|
+
"name" : "organization_id",
|
|
14871
|
+
"type" : "string",
|
|
14872
|
+
"required" : true,
|
|
14873
|
+
"attributes" : [ ],
|
|
14874
|
+
"annotations" : [ ]
|
|
14875
|
+
} ],
|
|
14876
|
+
"attributes" : [ ],
|
|
14877
|
+
"interfaces" : [ ]
|
|
14878
|
+
}, {
|
|
14879
|
+
"name" : "channel_organization_deleted",
|
|
14880
|
+
"plural" : "channel_organization_deleteds",
|
|
14721
14881
|
"fields" : [ {
|
|
14722
14882
|
"name" : "event_id",
|
|
14723
14883
|
"type" : "string",
|
|
@@ -14856,6 +15016,13 @@
|
|
|
14856
15016
|
"required" : true,
|
|
14857
15017
|
"attributes" : [ ],
|
|
14858
15018
|
"annotations" : [ ]
|
|
15019
|
+
}, {
|
|
15020
|
+
"name" : "bank_account",
|
|
15021
|
+
"type" : "bank_account_summary",
|
|
15022
|
+
"required" : false,
|
|
15023
|
+
"attributes" : [ ],
|
|
15024
|
+
"annotations" : [ ],
|
|
15025
|
+
"description" : "The bank account to which we sent this payout if known"
|
|
14859
15026
|
}, {
|
|
14860
15027
|
"name" : "amount",
|
|
14861
15028
|
"type" : "decimal",
|
|
@@ -15113,6 +15280,12 @@
|
|
|
15113
15280
|
"name" : "channel_transaction",
|
|
15114
15281
|
"plural" : "channel_transactions",
|
|
15115
15282
|
"fields" : [ {
|
|
15283
|
+
"name" : "statement",
|
|
15284
|
+
"type" : "billing_channel_statement_reference",
|
|
15285
|
+
"required" : false,
|
|
15286
|
+
"attributes" : [ ],
|
|
15287
|
+
"annotations" : [ ]
|
|
15288
|
+
}, {
|
|
15116
15289
|
"name" : "id",
|
|
15117
15290
|
"type" : "string",
|
|
15118
15291
|
"required" : true,
|
|
@@ -15125,12 +15298,6 @@
|
|
|
15125
15298
|
"required" : false,
|
|
15126
15299
|
"attributes" : [ ],
|
|
15127
15300
|
"annotations" : [ ]
|
|
15128
|
-
}, {
|
|
15129
|
-
"name" : "statement",
|
|
15130
|
-
"type" : "billing_channel_statement_reference",
|
|
15131
|
-
"required" : false,
|
|
15132
|
-
"attributes" : [ ],
|
|
15133
|
-
"annotations" : [ ]
|
|
15134
15301
|
}, {
|
|
15135
15302
|
"name" : "payment_request",
|
|
15136
15303
|
"type" : "billing_channel_payment_request_reference",
|
|
@@ -33595,6 +33762,12 @@
|
|
|
33595
33762
|
"attributes" : [ ],
|
|
33596
33763
|
"annotations" : [ ],
|
|
33597
33764
|
"description" : "Globally unique identifier"
|
|
33765
|
+
}, {
|
|
33766
|
+
"name" : "key",
|
|
33767
|
+
"type" : "string",
|
|
33768
|
+
"required" : true,
|
|
33769
|
+
"attributes" : [ ],
|
|
33770
|
+
"annotations" : [ ]
|
|
33598
33771
|
}, {
|
|
33599
33772
|
"name" : "last4",
|
|
33600
33773
|
"type" : "string",
|
|
@@ -34009,6 +34182,13 @@
|
|
|
34009
34182
|
"required" : true,
|
|
34010
34183
|
"attributes" : [ ],
|
|
34011
34184
|
"annotations" : [ ]
|
|
34185
|
+
}, {
|
|
34186
|
+
"name" : "bank_account",
|
|
34187
|
+
"type" : "bank_account_summary",
|
|
34188
|
+
"required" : false,
|
|
34189
|
+
"attributes" : [ ],
|
|
34190
|
+
"annotations" : [ ],
|
|
34191
|
+
"description" : "The bank account to which we sent this payout if known"
|
|
34012
34192
|
}, {
|
|
34013
34193
|
"name" : "amount",
|
|
34014
34194
|
"type" : "decimal",
|
|
@@ -36985,6 +37165,13 @@
|
|
|
36985
37165
|
"annotations" : [ ],
|
|
36986
37166
|
"description" : "What capture option will be used to capture payment. See `payment_capture_option` for more details on each option.",
|
|
36987
37167
|
"example" : "0"
|
|
37168
|
+
}, {
|
|
37169
|
+
"name" : "review",
|
|
37170
|
+
"type" : "payment_request_review",
|
|
37171
|
+
"required" : false,
|
|
37172
|
+
"attributes" : [ ],
|
|
37173
|
+
"annotations" : [ ],
|
|
37174
|
+
"description" : "The result of the checks run against an order and its payment"
|
|
36988
37175
|
} ],
|
|
36989
37176
|
"attributes" : [ ],
|
|
36990
37177
|
"interfaces" : [ ]
|
|
@@ -37165,6 +37352,44 @@
|
|
|
37165
37352
|
} ],
|
|
37166
37353
|
"attributes" : [ ],
|
|
37167
37354
|
"interfaces" : [ ]
|
|
37355
|
+
}, {
|
|
37356
|
+
"name" : "payment_request_review",
|
|
37357
|
+
"plural" : "payment_request_reviews",
|
|
37358
|
+
"fields" : [ {
|
|
37359
|
+
"name" : "status",
|
|
37360
|
+
"type" : "payment_request_review_status",
|
|
37361
|
+
"required" : true,
|
|
37362
|
+
"attributes" : [ ],
|
|
37363
|
+
"annotations" : [ ],
|
|
37364
|
+
"description" : "The overall status of the review."
|
|
37365
|
+
}, {
|
|
37366
|
+
"name" : "checks",
|
|
37367
|
+
"type" : "[payment_request_review_check]",
|
|
37368
|
+
"required" : true,
|
|
37369
|
+
"attributes" : [ ],
|
|
37370
|
+
"annotations" : [ ],
|
|
37371
|
+
"description" : "The list of checks for this review."
|
|
37372
|
+
} ],
|
|
37373
|
+
"attributes" : [ ],
|
|
37374
|
+
"interfaces" : [ ]
|
|
37375
|
+
}, {
|
|
37376
|
+
"name" : "payment_request_review_check",
|
|
37377
|
+
"plural" : "payment_request_review_checks",
|
|
37378
|
+
"fields" : [ {
|
|
37379
|
+
"name" : "type",
|
|
37380
|
+
"type" : "payment_request_review_check_type",
|
|
37381
|
+
"required" : true,
|
|
37382
|
+
"attributes" : [ ],
|
|
37383
|
+
"annotations" : [ ]
|
|
37384
|
+
}, {
|
|
37385
|
+
"name" : "status",
|
|
37386
|
+
"type" : "payment_request_review_check_status",
|
|
37387
|
+
"required" : true,
|
|
37388
|
+
"attributes" : [ ],
|
|
37389
|
+
"annotations" : [ ]
|
|
37390
|
+
} ],
|
|
37391
|
+
"attributes" : [ ],
|
|
37392
|
+
"interfaces" : [ ]
|
|
37168
37393
|
}, {
|
|
37169
37394
|
"name" : "payment_request_upserted",
|
|
37170
37395
|
"plural" : "payment_request_upserteds",
|
|
@@ -37448,6 +37673,104 @@
|
|
|
37448
37673
|
} ],
|
|
37449
37674
|
"attributes" : [ ],
|
|
37450
37675
|
"interfaces" : [ ]
|
|
37676
|
+
}, {
|
|
37677
|
+
"name" : "payout_transaction",
|
|
37678
|
+
"plural" : "payout_transactions",
|
|
37679
|
+
"fields" : [ {
|
|
37680
|
+
"name" : "id",
|
|
37681
|
+
"type" : "string",
|
|
37682
|
+
"required" : true,
|
|
37683
|
+
"attributes" : [ ],
|
|
37684
|
+
"annotations" : [ ],
|
|
37685
|
+
"description" : "Globally unique identifier"
|
|
37686
|
+
}, {
|
|
37687
|
+
"name" : "order",
|
|
37688
|
+
"type" : "billing_channel_order_summary",
|
|
37689
|
+
"required" : false,
|
|
37690
|
+
"attributes" : [ ],
|
|
37691
|
+
"annotations" : [ ]
|
|
37692
|
+
}, {
|
|
37693
|
+
"name" : "payment_request",
|
|
37694
|
+
"type" : "billing_channel_payment_request_reference",
|
|
37695
|
+
"required" : false,
|
|
37696
|
+
"attributes" : [ ],
|
|
37697
|
+
"annotations" : [ ]
|
|
37698
|
+
}, {
|
|
37699
|
+
"name" : "currency",
|
|
37700
|
+
"type" : "string",
|
|
37701
|
+
"required" : true,
|
|
37702
|
+
"attributes" : [ ],
|
|
37703
|
+
"annotations" : [ ]
|
|
37704
|
+
}, {
|
|
37705
|
+
"name" : "source",
|
|
37706
|
+
"type" : "transaction_source",
|
|
37707
|
+
"required" : true,
|
|
37708
|
+
"attributes" : [ ],
|
|
37709
|
+
"annotations" : [ ]
|
|
37710
|
+
}, {
|
|
37711
|
+
"name" : "parent",
|
|
37712
|
+
"type" : "parent_transaction_summary",
|
|
37713
|
+
"required" : false,
|
|
37714
|
+
"attributes" : [ ],
|
|
37715
|
+
"annotations" : [ ]
|
|
37716
|
+
}, {
|
|
37717
|
+
"name" : "gross",
|
|
37718
|
+
"type" : "decimal",
|
|
37719
|
+
"required" : true,
|
|
37720
|
+
"attributes" : [ ],
|
|
37721
|
+
"annotations" : [ ]
|
|
37722
|
+
}, {
|
|
37723
|
+
"name" : "fees",
|
|
37724
|
+
"type" : "[fee_deduction]",
|
|
37725
|
+
"required" : true,
|
|
37726
|
+
"attributes" : [ ],
|
|
37727
|
+
"annotations" : [ ],
|
|
37728
|
+
"default" : "[]"
|
|
37729
|
+
}, {
|
|
37730
|
+
"name" : "withholdings",
|
|
37731
|
+
"type" : "[withholding_deduction]",
|
|
37732
|
+
"required" : true,
|
|
37733
|
+
"attributes" : [ ],
|
|
37734
|
+
"annotations" : [ ],
|
|
37735
|
+
"default" : "[]"
|
|
37736
|
+
}, {
|
|
37737
|
+
"name" : "discounts",
|
|
37738
|
+
"type" : "[billing_discount]",
|
|
37739
|
+
"required" : true,
|
|
37740
|
+
"attributes" : [ ],
|
|
37741
|
+
"annotations" : [ ],
|
|
37742
|
+
"default" : "[]"
|
|
37743
|
+
}, {
|
|
37744
|
+
"name" : "net",
|
|
37745
|
+
"type" : "decimal",
|
|
37746
|
+
"required" : true,
|
|
37747
|
+
"attributes" : [ ],
|
|
37748
|
+
"annotations" : [ ],
|
|
37749
|
+
"description" : "net = gross -fees - withholdings"
|
|
37750
|
+
}, {
|
|
37751
|
+
"name" : "identifiers",
|
|
37752
|
+
"type" : "map[string]",
|
|
37753
|
+
"required" : true,
|
|
37754
|
+
"attributes" : [ ],
|
|
37755
|
+
"annotations" : [ ],
|
|
37756
|
+
"description" : "We serialize any transaction level identifiers as key/value pairs here",
|
|
37757
|
+
"default" : "{}"
|
|
37758
|
+
}, {
|
|
37759
|
+
"name" : "created_at",
|
|
37760
|
+
"type" : "date-time-iso8601",
|
|
37761
|
+
"required" : true,
|
|
37762
|
+
"attributes" : [ ],
|
|
37763
|
+
"annotations" : [ ]
|
|
37764
|
+
}, {
|
|
37765
|
+
"name" : "updated_at",
|
|
37766
|
+
"type" : "date-time-iso8601",
|
|
37767
|
+
"required" : true,
|
|
37768
|
+
"attributes" : [ ],
|
|
37769
|
+
"annotations" : [ ]
|
|
37770
|
+
} ],
|
|
37771
|
+
"attributes" : [ ],
|
|
37772
|
+
"interfaces" : [ "generic_transaction" ],
|
|
37773
|
+
"description" : "Note there is no statement on the payout transaction. We intend to deprecate the statement field once payouts are fully rolled out"
|
|
37451
37774
|
}, {
|
|
37452
37775
|
"name" : "paypal_authorization_details",
|
|
37453
37776
|
"plural" : "paypal_authorization_detailses",
|
|
@@ -43910,7 +44233,7 @@
|
|
|
43910
44233
|
"fields" : [ {
|
|
43911
44234
|
"name" : "third_party_logistics_guid",
|
|
43912
44235
|
"type" : "string",
|
|
43913
|
-
"required" :
|
|
44236
|
+
"required" : false,
|
|
43914
44237
|
"attributes" : [ ],
|
|
43915
44238
|
"annotations" : [ ]
|
|
43916
44239
|
} ],
|
|
@@ -48748,6 +49071,50 @@
|
|
|
48748
49071
|
} ],
|
|
48749
49072
|
"attributes" : [ ],
|
|
48750
49073
|
"interfaces" : [ ]
|
|
49074
|
+
}, {
|
|
49075
|
+
"name" : "test",
|
|
49076
|
+
"plural" : "tests",
|
|
49077
|
+
"fields" : [ {
|
|
49078
|
+
"name" : "id",
|
|
49079
|
+
"type" : "string",
|
|
49080
|
+
"required" : true,
|
|
49081
|
+
"attributes" : [ ],
|
|
49082
|
+
"annotations" : [ ],
|
|
49083
|
+
"description" : "Globally unique identifier"
|
|
49084
|
+
} ],
|
|
49085
|
+
"attributes" : [ ],
|
|
49086
|
+
"interfaces" : [ ]
|
|
49087
|
+
}, {
|
|
49088
|
+
"name" : "test_upserted",
|
|
49089
|
+
"plural" : "test_upserteds",
|
|
49090
|
+
"fields" : [ {
|
|
49091
|
+
"name" : "event_id",
|
|
49092
|
+
"type" : "string",
|
|
49093
|
+
"required" : true,
|
|
49094
|
+
"attributes" : [ ],
|
|
49095
|
+
"annotations" : [ ]
|
|
49096
|
+
}, {
|
|
49097
|
+
"name" : "timestamp",
|
|
49098
|
+
"type" : "date-time-iso8601",
|
|
49099
|
+
"required" : true,
|
|
49100
|
+
"attributes" : [ ],
|
|
49101
|
+
"annotations" : [ ]
|
|
49102
|
+
}, {
|
|
49103
|
+
"name" : "organization",
|
|
49104
|
+
"type" : "string",
|
|
49105
|
+
"required" : true,
|
|
49106
|
+
"attributes" : [ ],
|
|
49107
|
+
"annotations" : [ ],
|
|
49108
|
+
"description" : "Refers to your organization's account identifier"
|
|
49109
|
+
}, {
|
|
49110
|
+
"name" : "test",
|
|
49111
|
+
"type" : "test",
|
|
49112
|
+
"required" : true,
|
|
49113
|
+
"attributes" : [ ],
|
|
49114
|
+
"annotations" : [ ]
|
|
49115
|
+
} ],
|
|
49116
|
+
"attributes" : [ ],
|
|
49117
|
+
"interfaces" : [ ]
|
|
48751
49118
|
}, {
|
|
48752
49119
|
"name" : "third_party_logistics_partner",
|
|
48753
49120
|
"plural" : "third_party_logistics_partners",
|
|
@@ -50276,6 +50643,12 @@
|
|
|
50276
50643
|
"name" : "transaction",
|
|
50277
50644
|
"plural" : "transactions",
|
|
50278
50645
|
"fields" : [ {
|
|
50646
|
+
"name" : "statement",
|
|
50647
|
+
"type" : "billing_channel_statement_reference",
|
|
50648
|
+
"required" : false,
|
|
50649
|
+
"attributes" : [ ],
|
|
50650
|
+
"annotations" : [ ]
|
|
50651
|
+
}, {
|
|
50279
50652
|
"name" : "id",
|
|
50280
50653
|
"type" : "string",
|
|
50281
50654
|
"required" : true,
|
|
@@ -50288,12 +50661,6 @@
|
|
|
50288
50661
|
"required" : false,
|
|
50289
50662
|
"attributes" : [ ],
|
|
50290
50663
|
"annotations" : [ ]
|
|
50291
|
-
}, {
|
|
50292
|
-
"name" : "statement",
|
|
50293
|
-
"type" : "billing_channel_statement_reference",
|
|
50294
|
-
"required" : false,
|
|
50295
|
-
"attributes" : [ ],
|
|
50296
|
-
"annotations" : [ ]
|
|
50297
50664
|
}, {
|
|
50298
50665
|
"name" : "payment_request",
|
|
50299
50666
|
"type" : "billing_channel_payment_request_reference",
|
|
@@ -77777,55 +78144,676 @@
|
|
|
77777
78144
|
"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.",
|
|
77778
78145
|
"attributes" : [ ]
|
|
77779
78146
|
} ],
|
|
77780
|
-
"attributes" : [ ],
|
|
77781
|
-
"description" : "Creates an export of the b2b invoices",
|
|
77782
|
-
"body" : {
|
|
77783
|
-
"type" : "invoice_export_form",
|
|
77784
|
-
"attributes" : [ ]
|
|
77785
|
-
}
|
|
77786
|
-
}, {
|
|
77787
|
-
"method" : "GET",
|
|
77788
|
-
"path" : "/:organization/b2b/invoices/:key",
|
|
77789
|
-
"parameters" : [ {
|
|
77790
|
-
"name" : "organization",
|
|
77791
|
-
"type" : "string",
|
|
77792
|
-
"location" : "Path",
|
|
77793
|
-
"required" : true,
|
|
77794
|
-
"description" : "Refers to your organization's account identifier"
|
|
77795
|
-
}, {
|
|
77796
|
-
"name" : "key",
|
|
77797
|
-
"type" : "string",
|
|
77798
|
-
"location" : "Path",
|
|
77799
|
-
"required" : true
|
|
77800
|
-
} ],
|
|
77801
|
-
"responses" : [ {
|
|
77802
|
-
"code" : {
|
|
77803
|
-
"integer" : {
|
|
77804
|
-
"value" : 200
|
|
77805
|
-
}
|
|
77806
|
-
},
|
|
77807
|
-
"type" : "b2b_invoice",
|
|
77808
|
-
"description" : "Successful response",
|
|
77809
|
-
"attributes" : [ ]
|
|
77810
|
-
}, {
|
|
77811
|
-
"code" : {
|
|
77812
|
-
"integer" : {
|
|
77813
|
-
"value" : 401
|
|
77814
|
-
}
|
|
77815
|
-
},
|
|
77816
|
-
"type" : "unit",
|
|
77817
|
-
"description" : "Authorization failed",
|
|
77818
|
-
"attributes" : [ ]
|
|
77819
|
-
}, {
|
|
77820
|
-
"code" : {
|
|
77821
|
-
"integer" : {
|
|
77822
|
-
"value" : 404
|
|
77823
|
-
}
|
|
77824
|
-
},
|
|
77825
|
-
"type" : "unit",
|
|
77826
|
-
"description" : "Resource was not found",
|
|
77827
|
-
"attributes" : [ ]
|
|
77828
|
-
} ],
|
|
78147
|
+
"attributes" : [ ],
|
|
78148
|
+
"description" : "Creates an export of the b2b invoices",
|
|
78149
|
+
"body" : {
|
|
78150
|
+
"type" : "invoice_export_form",
|
|
78151
|
+
"attributes" : [ ]
|
|
78152
|
+
}
|
|
78153
|
+
}, {
|
|
78154
|
+
"method" : "GET",
|
|
78155
|
+
"path" : "/:organization/b2b/invoices/:key",
|
|
78156
|
+
"parameters" : [ {
|
|
78157
|
+
"name" : "organization",
|
|
78158
|
+
"type" : "string",
|
|
78159
|
+
"location" : "Path",
|
|
78160
|
+
"required" : true,
|
|
78161
|
+
"description" : "Refers to your organization's account identifier"
|
|
78162
|
+
}, {
|
|
78163
|
+
"name" : "key",
|
|
78164
|
+
"type" : "string",
|
|
78165
|
+
"location" : "Path",
|
|
78166
|
+
"required" : true
|
|
78167
|
+
} ],
|
|
78168
|
+
"responses" : [ {
|
|
78169
|
+
"code" : {
|
|
78170
|
+
"integer" : {
|
|
78171
|
+
"value" : 200
|
|
78172
|
+
}
|
|
78173
|
+
},
|
|
78174
|
+
"type" : "b2b_invoice",
|
|
78175
|
+
"description" : "Successful response",
|
|
78176
|
+
"attributes" : [ ]
|
|
78177
|
+
}, {
|
|
78178
|
+
"code" : {
|
|
78179
|
+
"integer" : {
|
|
78180
|
+
"value" : 401
|
|
78181
|
+
}
|
|
78182
|
+
},
|
|
78183
|
+
"type" : "unit",
|
|
78184
|
+
"description" : "Authorization failed",
|
|
78185
|
+
"attributes" : [ ]
|
|
78186
|
+
}, {
|
|
78187
|
+
"code" : {
|
|
78188
|
+
"integer" : {
|
|
78189
|
+
"value" : 404
|
|
78190
|
+
}
|
|
78191
|
+
},
|
|
78192
|
+
"type" : "unit",
|
|
78193
|
+
"description" : "Resource was not found",
|
|
78194
|
+
"attributes" : [ ]
|
|
78195
|
+
} ],
|
|
78196
|
+
"attributes" : [ ]
|
|
78197
|
+
} ],
|
|
78198
|
+
"attributes" : [ {
|
|
78199
|
+
"name" : "docs",
|
|
78200
|
+
"value" : {
|
|
78201
|
+
"module" : "general"
|
|
78202
|
+
}
|
|
78203
|
+
} ],
|
|
78204
|
+
"path" : "/:organization/b2b/invoices",
|
|
78205
|
+
"description" : "The b2b invoice represents a transaction between Flow and one of our clients (e.g. Flow purchasing inventory to resell to a consumer)."
|
|
78206
|
+
}, {
|
|
78207
|
+
"type" : "bank_account_form",
|
|
78208
|
+
"plural" : "bank_account_forms",
|
|
78209
|
+
"operations" : [ {
|
|
78210
|
+
"method" : "PUT",
|
|
78211
|
+
"path" : "/:organization/shopify/merchant/config/bank/account",
|
|
78212
|
+
"parameters" : [ {
|
|
78213
|
+
"name" : "organization",
|
|
78214
|
+
"type" : "string",
|
|
78215
|
+
"location" : "Path",
|
|
78216
|
+
"required" : true,
|
|
78217
|
+
"description" : "Refers to your organization's account identifier"
|
|
78218
|
+
} ],
|
|
78219
|
+
"responses" : [ {
|
|
78220
|
+
"code" : {
|
|
78221
|
+
"integer" : {
|
|
78222
|
+
"value" : 200
|
|
78223
|
+
}
|
|
78224
|
+
},
|
|
78225
|
+
"type" : "organization_bank_account",
|
|
78226
|
+
"description" : "Successful response",
|
|
78227
|
+
"attributes" : [ ]
|
|
78228
|
+
}, {
|
|
78229
|
+
"code" : {
|
|
78230
|
+
"integer" : {
|
|
78231
|
+
"value" : 401
|
|
78232
|
+
}
|
|
78233
|
+
},
|
|
78234
|
+
"type" : "unit",
|
|
78235
|
+
"description" : "Authorization failed",
|
|
78236
|
+
"attributes" : [ ]
|
|
78237
|
+
}, {
|
|
78238
|
+
"code" : {
|
|
78239
|
+
"integer" : {
|
|
78240
|
+
"value" : 404
|
|
78241
|
+
}
|
|
78242
|
+
},
|
|
78243
|
+
"type" : "unit",
|
|
78244
|
+
"description" : "Resource was not found",
|
|
78245
|
+
"attributes" : [ ]
|
|
78246
|
+
}, {
|
|
78247
|
+
"code" : {
|
|
78248
|
+
"integer" : {
|
|
78249
|
+
"value" : 422
|
|
78250
|
+
}
|
|
78251
|
+
},
|
|
78252
|
+
"type" : "generic_error",
|
|
78253
|
+
"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.",
|
|
78254
|
+
"attributes" : [ ]
|
|
78255
|
+
} ],
|
|
78256
|
+
"attributes" : [ ],
|
|
78257
|
+
"body" : {
|
|
78258
|
+
"type" : "bank_account_form",
|
|
78259
|
+
"attributes" : [ ]
|
|
78260
|
+
}
|
|
78261
|
+
} ],
|
|
78262
|
+
"attributes" : [ {
|
|
78263
|
+
"name" : "docs",
|
|
78264
|
+
"value" : {
|
|
78265
|
+
"module" : "general"
|
|
78266
|
+
}
|
|
78267
|
+
} ],
|
|
78268
|
+
"path" : "/:organization/shopify/merchant/config/bank/account"
|
|
78269
|
+
}, {
|
|
78270
|
+
"type" : "catalog_price_book_item_document",
|
|
78271
|
+
"plural" : "catalog_price_book_item_documents",
|
|
78272
|
+
"operations" : [ {
|
|
78273
|
+
"method" : "GET",
|
|
78274
|
+
"path" : "/:organization/search/price/books/items",
|
|
78275
|
+
"parameters" : [ {
|
|
78276
|
+
"name" : "organization",
|
|
78277
|
+
"type" : "string",
|
|
78278
|
+
"location" : "Path",
|
|
78279
|
+
"required" : true,
|
|
78280
|
+
"description" : "Refers to your organization's account identifier"
|
|
78281
|
+
}, {
|
|
78282
|
+
"name" : "price_book_key",
|
|
78283
|
+
"type" : "[string]",
|
|
78284
|
+
"location" : "Query",
|
|
78285
|
+
"required" : false,
|
|
78286
|
+
"maximum" : 100
|
|
78287
|
+
}, {
|
|
78288
|
+
"name" : "q",
|
|
78289
|
+
"type" : "string",
|
|
78290
|
+
"location" : "Query",
|
|
78291
|
+
"required" : false
|
|
78292
|
+
}, {
|
|
78293
|
+
"name" : "limit",
|
|
78294
|
+
"type" : "long",
|
|
78295
|
+
"location" : "Query",
|
|
78296
|
+
"required" : true,
|
|
78297
|
+
"description" : "The maximum number of results to return",
|
|
78298
|
+
"default" : "25",
|
|
78299
|
+
"minimum" : 1,
|
|
78300
|
+
"maximum" : 100
|
|
78301
|
+
}, {
|
|
78302
|
+
"name" : "offset",
|
|
78303
|
+
"type" : "long",
|
|
78304
|
+
"location" : "Query",
|
|
78305
|
+
"required" : true,
|
|
78306
|
+
"description" : "The number of results to skip before returning results",
|
|
78307
|
+
"default" : "0",
|
|
78308
|
+
"minimum" : 0
|
|
78309
|
+
} ],
|
|
78310
|
+
"responses" : [ {
|
|
78311
|
+
"code" : {
|
|
78312
|
+
"integer" : {
|
|
78313
|
+
"value" : 200
|
|
78314
|
+
}
|
|
78315
|
+
},
|
|
78316
|
+
"type" : "[catalog_price_book_item_document]",
|
|
78317
|
+
"description" : "Successful response",
|
|
78318
|
+
"attributes" : [ ]
|
|
78319
|
+
}, {
|
|
78320
|
+
"code" : {
|
|
78321
|
+
"integer" : {
|
|
78322
|
+
"value" : 401
|
|
78323
|
+
}
|
|
78324
|
+
},
|
|
78325
|
+
"type" : "unit",
|
|
78326
|
+
"description" : "Authorization failed",
|
|
78327
|
+
"attributes" : [ ]
|
|
78328
|
+
}, {
|
|
78329
|
+
"code" : {
|
|
78330
|
+
"integer" : {
|
|
78331
|
+
"value" : 404
|
|
78332
|
+
}
|
|
78333
|
+
},
|
|
78334
|
+
"type" : "unit",
|
|
78335
|
+
"description" : "Resource was not found",
|
|
78336
|
+
"attributes" : [ ]
|
|
78337
|
+
} ],
|
|
78338
|
+
"attributes" : [ {
|
|
78339
|
+
"name" : "linter",
|
|
78340
|
+
"value" : {
|
|
78341
|
+
"ignore" : [ "get", "versions" ]
|
|
78342
|
+
}
|
|
78343
|
+
} ],
|
|
78344
|
+
"description" : "Returns price book item documents based on the search criteria"
|
|
78345
|
+
} ],
|
|
78346
|
+
"attributes" : [ {
|
|
78347
|
+
"name" : "docs",
|
|
78348
|
+
"value" : {
|
|
78349
|
+
"module" : "general"
|
|
78350
|
+
}
|
|
78351
|
+
} ],
|
|
78352
|
+
"path" : "/:organization/search/price/books/items",
|
|
78353
|
+
"description" : "Represents the returned information for searching particular price book items"
|
|
78354
|
+
}, {
|
|
78355
|
+
"type" : "channel_authorization",
|
|
78356
|
+
"plural" : "channel_authorizations",
|
|
78357
|
+
"operations" : [ {
|
|
78358
|
+
"method" : "POST",
|
|
78359
|
+
"path" : "/channel/authorizations",
|
|
78360
|
+
"parameters" : [ ],
|
|
78361
|
+
"responses" : [ {
|
|
78362
|
+
"code" : {
|
|
78363
|
+
"integer" : {
|
|
78364
|
+
"value" : 201
|
|
78365
|
+
}
|
|
78366
|
+
},
|
|
78367
|
+
"type" : "channel_authorization",
|
|
78368
|
+
"description" : "Operation succeeded and the resource was created",
|
|
78369
|
+
"attributes" : [ ]
|
|
78370
|
+
}, {
|
|
78371
|
+
"code" : {
|
|
78372
|
+
"integer" : {
|
|
78373
|
+
"value" : 401
|
|
78374
|
+
}
|
|
78375
|
+
},
|
|
78376
|
+
"type" : "unit",
|
|
78377
|
+
"description" : "Authorization failed",
|
|
78378
|
+
"attributes" : [ ]
|
|
78379
|
+
}, {
|
|
78380
|
+
"code" : {
|
|
78381
|
+
"integer" : {
|
|
78382
|
+
"value" : 404
|
|
78383
|
+
}
|
|
78384
|
+
},
|
|
78385
|
+
"type" : "unit",
|
|
78386
|
+
"description" : "Resource was not found",
|
|
78387
|
+
"attributes" : [ ]
|
|
78388
|
+
}, {
|
|
78389
|
+
"code" : {
|
|
78390
|
+
"integer" : {
|
|
78391
|
+
"value" : 422
|
|
78392
|
+
}
|
|
78393
|
+
},
|
|
78394
|
+
"type" : "generic_error",
|
|
78395
|
+
"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.",
|
|
78396
|
+
"attributes" : [ ]
|
|
78397
|
+
} ],
|
|
78398
|
+
"attributes" : [ ],
|
|
78399
|
+
"body" : {
|
|
78400
|
+
"type" : "channel_authorization_form",
|
|
78401
|
+
"attributes" : [ ]
|
|
78402
|
+
}
|
|
78403
|
+
} ],
|
|
78404
|
+
"attributes" : [ {
|
|
78405
|
+
"name" : "docs",
|
|
78406
|
+
"value" : {
|
|
78407
|
+
"module" : "general"
|
|
78408
|
+
}
|
|
78409
|
+
} ],
|
|
78410
|
+
"path" : "/channel/authorizations"
|
|
78411
|
+
}, {
|
|
78412
|
+
"type" : "channel_bank_account",
|
|
78413
|
+
"plural" : "channel_bank_accounts",
|
|
78414
|
+
"operations" : [ {
|
|
78415
|
+
"method" : "GET",
|
|
78416
|
+
"path" : "/channel/:channel/bank/accounts",
|
|
78417
|
+
"parameters" : [ {
|
|
78418
|
+
"name" : "channel",
|
|
78419
|
+
"type" : "string",
|
|
78420
|
+
"location" : "Path",
|
|
78421
|
+
"required" : true
|
|
78422
|
+
}, {
|
|
78423
|
+
"name" : "id",
|
|
78424
|
+
"type" : "[string]",
|
|
78425
|
+
"location" : "Query",
|
|
78426
|
+
"required" : false,
|
|
78427
|
+
"description" : "Filter by one or more IDs of this resource",
|
|
78428
|
+
"maximum" : 100
|
|
78429
|
+
}, {
|
|
78430
|
+
"name" : "key",
|
|
78431
|
+
"type" : "string",
|
|
78432
|
+
"location" : "Query",
|
|
78433
|
+
"required" : false,
|
|
78434
|
+
"maximum" : 100
|
|
78435
|
+
}, {
|
|
78436
|
+
"name" : "limit",
|
|
78437
|
+
"type" : "long",
|
|
78438
|
+
"location" : "Query",
|
|
78439
|
+
"required" : true,
|
|
78440
|
+
"description" : "The maximum number of results to return",
|
|
78441
|
+
"default" : "25",
|
|
78442
|
+
"minimum" : 1,
|
|
78443
|
+
"maximum" : 100
|
|
78444
|
+
}, {
|
|
78445
|
+
"name" : "offset",
|
|
78446
|
+
"type" : "long",
|
|
78447
|
+
"location" : "Query",
|
|
78448
|
+
"required" : true,
|
|
78449
|
+
"description" : "The number of results to skip before returning results",
|
|
78450
|
+
"default" : "0",
|
|
78451
|
+
"minimum" : 0
|
|
78452
|
+
}, {
|
|
78453
|
+
"name" : "sort",
|
|
78454
|
+
"type" : "string",
|
|
78455
|
+
"location" : "Query",
|
|
78456
|
+
"required" : true,
|
|
78457
|
+
"default" : "-created_at"
|
|
78458
|
+
} ],
|
|
78459
|
+
"responses" : [ {
|
|
78460
|
+
"code" : {
|
|
78461
|
+
"integer" : {
|
|
78462
|
+
"value" : 200
|
|
78463
|
+
}
|
|
78464
|
+
},
|
|
78465
|
+
"type" : "[channel_bank_account]",
|
|
78466
|
+
"description" : "Successful response",
|
|
78467
|
+
"attributes" : [ ]
|
|
78468
|
+
}, {
|
|
78469
|
+
"code" : {
|
|
78470
|
+
"integer" : {
|
|
78471
|
+
"value" : 401
|
|
78472
|
+
}
|
|
78473
|
+
},
|
|
78474
|
+
"type" : "unit",
|
|
78475
|
+
"description" : "Authorization failed",
|
|
78476
|
+
"attributes" : [ ]
|
|
78477
|
+
}, {
|
|
78478
|
+
"code" : {
|
|
78479
|
+
"integer" : {
|
|
78480
|
+
"value" : 404
|
|
78481
|
+
}
|
|
78482
|
+
},
|
|
78483
|
+
"type" : "unit",
|
|
78484
|
+
"description" : "Resource was not found",
|
|
78485
|
+
"attributes" : [ ]
|
|
78486
|
+
}, {
|
|
78487
|
+
"code" : {
|
|
78488
|
+
"integer" : {
|
|
78489
|
+
"value" : 422
|
|
78490
|
+
}
|
|
78491
|
+
},
|
|
78492
|
+
"type" : "generic_error",
|
|
78493
|
+
"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.",
|
|
78494
|
+
"attributes" : [ ]
|
|
78495
|
+
} ],
|
|
78496
|
+
"attributes" : [ {
|
|
78497
|
+
"name" : "sort",
|
|
78498
|
+
"value" : {
|
|
78499
|
+
"values" : [ {
|
|
78500
|
+
"value" : "id"
|
|
78501
|
+
}, {
|
|
78502
|
+
"value" : "created_at"
|
|
78503
|
+
} ]
|
|
78504
|
+
}
|
|
78505
|
+
}, {
|
|
78506
|
+
"name" : "linter",
|
|
78507
|
+
"value" : {
|
|
78508
|
+
"ignore" : [ "versions" ]
|
|
78509
|
+
}
|
|
78510
|
+
} ]
|
|
78511
|
+
}, {
|
|
78512
|
+
"method" : "GET",
|
|
78513
|
+
"path" : "/channel/:channel/bank/accounts/:key",
|
|
78514
|
+
"parameters" : [ {
|
|
78515
|
+
"name" : "channel",
|
|
78516
|
+
"type" : "string",
|
|
78517
|
+
"location" : "Path",
|
|
78518
|
+
"required" : true
|
|
78519
|
+
}, {
|
|
78520
|
+
"name" : "key",
|
|
78521
|
+
"type" : "string",
|
|
78522
|
+
"location" : "Path",
|
|
78523
|
+
"required" : true
|
|
78524
|
+
} ],
|
|
78525
|
+
"responses" : [ {
|
|
78526
|
+
"code" : {
|
|
78527
|
+
"integer" : {
|
|
78528
|
+
"value" : 200
|
|
78529
|
+
}
|
|
78530
|
+
},
|
|
78531
|
+
"type" : "channel_bank_account",
|
|
78532
|
+
"description" : "Successful response",
|
|
78533
|
+
"attributes" : [ ]
|
|
78534
|
+
}, {
|
|
78535
|
+
"code" : {
|
|
78536
|
+
"integer" : {
|
|
78537
|
+
"value" : 401
|
|
78538
|
+
}
|
|
78539
|
+
},
|
|
78540
|
+
"type" : "unit",
|
|
78541
|
+
"description" : "Authorization failed",
|
|
78542
|
+
"attributes" : [ ]
|
|
78543
|
+
}, {
|
|
78544
|
+
"code" : {
|
|
78545
|
+
"integer" : {
|
|
78546
|
+
"value" : 404
|
|
78547
|
+
}
|
|
78548
|
+
},
|
|
78549
|
+
"type" : "unit",
|
|
78550
|
+
"description" : "Resource was not found",
|
|
78551
|
+
"attributes" : [ ]
|
|
78552
|
+
}, {
|
|
78553
|
+
"code" : {
|
|
78554
|
+
"integer" : {
|
|
78555
|
+
"value" : 422
|
|
78556
|
+
}
|
|
78557
|
+
},
|
|
78558
|
+
"type" : "generic_error",
|
|
78559
|
+
"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.",
|
|
78560
|
+
"attributes" : [ ]
|
|
78561
|
+
} ],
|
|
78562
|
+
"attributes" : [ ]
|
|
78563
|
+
}, {
|
|
78564
|
+
"method" : "PUT",
|
|
78565
|
+
"path" : "/channel/:channel/bank/accounts/:key",
|
|
78566
|
+
"parameters" : [ {
|
|
78567
|
+
"name" : "channel",
|
|
78568
|
+
"type" : "string",
|
|
78569
|
+
"location" : "Path",
|
|
78570
|
+
"required" : true
|
|
78571
|
+
}, {
|
|
78572
|
+
"name" : "key",
|
|
78573
|
+
"type" : "string",
|
|
78574
|
+
"location" : "Path",
|
|
78575
|
+
"required" : true
|
|
78576
|
+
} ],
|
|
78577
|
+
"responses" : [ {
|
|
78578
|
+
"code" : {
|
|
78579
|
+
"integer" : {
|
|
78580
|
+
"value" : 200
|
|
78581
|
+
}
|
|
78582
|
+
},
|
|
78583
|
+
"type" : "channel_bank_account",
|
|
78584
|
+
"description" : "Successful response",
|
|
78585
|
+
"attributes" : [ ]
|
|
78586
|
+
}, {
|
|
78587
|
+
"code" : {
|
|
78588
|
+
"integer" : {
|
|
78589
|
+
"value" : 201
|
|
78590
|
+
}
|
|
78591
|
+
},
|
|
78592
|
+
"type" : "channel_bank_account",
|
|
78593
|
+
"description" : "Operation succeeded and the resource was created",
|
|
78594
|
+
"attributes" : [ ]
|
|
78595
|
+
}, {
|
|
78596
|
+
"code" : {
|
|
78597
|
+
"integer" : {
|
|
78598
|
+
"value" : 401
|
|
78599
|
+
}
|
|
78600
|
+
},
|
|
78601
|
+
"type" : "unit",
|
|
78602
|
+
"description" : "Authorization failed",
|
|
78603
|
+
"attributes" : [ ]
|
|
78604
|
+
}, {
|
|
78605
|
+
"code" : {
|
|
78606
|
+
"integer" : {
|
|
78607
|
+
"value" : 422
|
|
78608
|
+
}
|
|
78609
|
+
},
|
|
78610
|
+
"type" : "generic_error",
|
|
78611
|
+
"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.",
|
|
78612
|
+
"attributes" : [ ]
|
|
78613
|
+
} ],
|
|
78614
|
+
"attributes" : [ ],
|
|
78615
|
+
"body" : {
|
|
78616
|
+
"type" : "bank_account_form",
|
|
78617
|
+
"attributes" : [ ]
|
|
78618
|
+
}
|
|
78619
|
+
}, {
|
|
78620
|
+
"method" : "DELETE",
|
|
78621
|
+
"path" : "/channel/:channel/bank/accounts/:key",
|
|
78622
|
+
"parameters" : [ {
|
|
78623
|
+
"name" : "channel",
|
|
78624
|
+
"type" : "string",
|
|
78625
|
+
"location" : "Path",
|
|
78626
|
+
"required" : true
|
|
78627
|
+
}, {
|
|
78628
|
+
"name" : "key",
|
|
78629
|
+
"type" : "string",
|
|
78630
|
+
"location" : "Path",
|
|
78631
|
+
"required" : true
|
|
78632
|
+
} ],
|
|
78633
|
+
"responses" : [ {
|
|
78634
|
+
"code" : {
|
|
78635
|
+
"integer" : {
|
|
78636
|
+
"value" : 204
|
|
78637
|
+
}
|
|
78638
|
+
},
|
|
78639
|
+
"type" : "unit",
|
|
78640
|
+
"description" : "Operation succeeded. No content is returned",
|
|
78641
|
+
"attributes" : [ ]
|
|
78642
|
+
}, {
|
|
78643
|
+
"code" : {
|
|
78644
|
+
"integer" : {
|
|
78645
|
+
"value" : 401
|
|
78646
|
+
}
|
|
78647
|
+
},
|
|
78648
|
+
"type" : "unit",
|
|
78649
|
+
"description" : "Authorization failed",
|
|
78650
|
+
"attributes" : [ ]
|
|
78651
|
+
}, {
|
|
78652
|
+
"code" : {
|
|
78653
|
+
"integer" : {
|
|
78654
|
+
"value" : 404
|
|
78655
|
+
}
|
|
78656
|
+
},
|
|
78657
|
+
"type" : "unit",
|
|
78658
|
+
"description" : "Resource was not found",
|
|
78659
|
+
"attributes" : [ ]
|
|
78660
|
+
}, {
|
|
78661
|
+
"code" : {
|
|
78662
|
+
"integer" : {
|
|
78663
|
+
"value" : 422
|
|
78664
|
+
}
|
|
78665
|
+
},
|
|
78666
|
+
"type" : "generic_error",
|
|
78667
|
+
"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.",
|
|
78668
|
+
"attributes" : [ ]
|
|
78669
|
+
} ],
|
|
78670
|
+
"attributes" : [ ]
|
|
78671
|
+
} ],
|
|
78672
|
+
"attributes" : [ {
|
|
78673
|
+
"name" : "docs",
|
|
78674
|
+
"value" : {
|
|
78675
|
+
"module" : "general"
|
|
78676
|
+
}
|
|
78677
|
+
} ],
|
|
78678
|
+
"path" : "/channel/:channel/bank/accounts"
|
|
78679
|
+
}, {
|
|
78680
|
+
"type" : "channel_default_bank_account",
|
|
78681
|
+
"plural" : "channel_default_bank_accounts",
|
|
78682
|
+
"operations" : [ {
|
|
78683
|
+
"method" : "GET",
|
|
78684
|
+
"path" : "/channel/:channel/default/bank/accounts",
|
|
78685
|
+
"parameters" : [ {
|
|
78686
|
+
"name" : "channel",
|
|
78687
|
+
"type" : "string",
|
|
78688
|
+
"location" : "Path",
|
|
78689
|
+
"required" : true
|
|
78690
|
+
} ],
|
|
78691
|
+
"responses" : [ {
|
|
78692
|
+
"code" : {
|
|
78693
|
+
"integer" : {
|
|
78694
|
+
"value" : 200
|
|
78695
|
+
}
|
|
78696
|
+
},
|
|
78697
|
+
"type" : "channel_default_bank_account",
|
|
78698
|
+
"description" : "Successful response",
|
|
78699
|
+
"attributes" : [ ]
|
|
78700
|
+
}, {
|
|
78701
|
+
"code" : {
|
|
78702
|
+
"integer" : {
|
|
78703
|
+
"value" : 401
|
|
78704
|
+
}
|
|
78705
|
+
},
|
|
78706
|
+
"type" : "unit",
|
|
78707
|
+
"description" : "Authorization failed",
|
|
78708
|
+
"attributes" : [ ]
|
|
78709
|
+
}, {
|
|
78710
|
+
"code" : {
|
|
78711
|
+
"integer" : {
|
|
78712
|
+
"value" : 404
|
|
78713
|
+
}
|
|
78714
|
+
},
|
|
78715
|
+
"type" : "unit",
|
|
78716
|
+
"description" : "Resource was not found",
|
|
78717
|
+
"attributes" : [ ]
|
|
78718
|
+
} ],
|
|
78719
|
+
"attributes" : [ ]
|
|
78720
|
+
}, {
|
|
78721
|
+
"method" : "PUT",
|
|
78722
|
+
"path" : "/channel/:channel/default/bank/accounts",
|
|
78723
|
+
"parameters" : [ {
|
|
78724
|
+
"name" : "channel",
|
|
78725
|
+
"type" : "string",
|
|
78726
|
+
"location" : "Path",
|
|
78727
|
+
"required" : true
|
|
78728
|
+
} ],
|
|
78729
|
+
"responses" : [ {
|
|
78730
|
+
"code" : {
|
|
78731
|
+
"integer" : {
|
|
78732
|
+
"value" : 200
|
|
78733
|
+
}
|
|
78734
|
+
},
|
|
78735
|
+
"type" : "channel_default_bank_account",
|
|
78736
|
+
"description" : "Successful response",
|
|
78737
|
+
"attributes" : [ ]
|
|
78738
|
+
}, {
|
|
78739
|
+
"code" : {
|
|
78740
|
+
"integer" : {
|
|
78741
|
+
"value" : 201
|
|
78742
|
+
}
|
|
78743
|
+
},
|
|
78744
|
+
"type" : "channel_default_bank_account",
|
|
78745
|
+
"description" : "Operation succeeded and the resource was created",
|
|
78746
|
+
"attributes" : [ ]
|
|
78747
|
+
}, {
|
|
78748
|
+
"code" : {
|
|
78749
|
+
"integer" : {
|
|
78750
|
+
"value" : 401
|
|
78751
|
+
}
|
|
78752
|
+
},
|
|
78753
|
+
"type" : "unit",
|
|
78754
|
+
"description" : "Authorization failed",
|
|
78755
|
+
"attributes" : [ ]
|
|
78756
|
+
}, {
|
|
78757
|
+
"code" : {
|
|
78758
|
+
"integer" : {
|
|
78759
|
+
"value" : 422
|
|
78760
|
+
}
|
|
78761
|
+
},
|
|
78762
|
+
"type" : "generic_error",
|
|
78763
|
+
"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.",
|
|
78764
|
+
"attributes" : [ ]
|
|
78765
|
+
} ],
|
|
78766
|
+
"attributes" : [ ],
|
|
78767
|
+
"body" : {
|
|
78768
|
+
"type" : "default_bank_account_form",
|
|
78769
|
+
"attributes" : [ ]
|
|
78770
|
+
}
|
|
78771
|
+
}, {
|
|
78772
|
+
"method" : "DELETE",
|
|
78773
|
+
"path" : "/channel/:channel/default/bank/accounts",
|
|
78774
|
+
"parameters" : [ {
|
|
78775
|
+
"name" : "channel",
|
|
78776
|
+
"type" : "string",
|
|
78777
|
+
"location" : "Path",
|
|
78778
|
+
"required" : true
|
|
78779
|
+
} ],
|
|
78780
|
+
"responses" : [ {
|
|
78781
|
+
"code" : {
|
|
78782
|
+
"integer" : {
|
|
78783
|
+
"value" : 204
|
|
78784
|
+
}
|
|
78785
|
+
},
|
|
78786
|
+
"type" : "unit",
|
|
78787
|
+
"description" : "Operation succeeded. No content is returned",
|
|
78788
|
+
"attributes" : [ ]
|
|
78789
|
+
}, {
|
|
78790
|
+
"code" : {
|
|
78791
|
+
"integer" : {
|
|
78792
|
+
"value" : 401
|
|
78793
|
+
}
|
|
78794
|
+
},
|
|
78795
|
+
"type" : "unit",
|
|
78796
|
+
"description" : "Authorization failed",
|
|
78797
|
+
"attributes" : [ ]
|
|
78798
|
+
}, {
|
|
78799
|
+
"code" : {
|
|
78800
|
+
"integer" : {
|
|
78801
|
+
"value" : 404
|
|
78802
|
+
}
|
|
78803
|
+
},
|
|
78804
|
+
"type" : "unit",
|
|
78805
|
+
"description" : "Resource was not found",
|
|
78806
|
+
"attributes" : [ ]
|
|
78807
|
+
}, {
|
|
78808
|
+
"code" : {
|
|
78809
|
+
"integer" : {
|
|
78810
|
+
"value" : 422
|
|
78811
|
+
}
|
|
78812
|
+
},
|
|
78813
|
+
"type" : "generic_error",
|
|
78814
|
+
"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.",
|
|
78815
|
+
"attributes" : [ ]
|
|
78816
|
+
} ],
|
|
77829
78817
|
"attributes" : [ ]
|
|
77830
78818
|
} ],
|
|
77831
78819
|
"attributes" : [ {
|
|
@@ -77834,213 +78822,7 @@
|
|
|
77834
78822
|
"module" : "general"
|
|
77835
78823
|
}
|
|
77836
78824
|
} ],
|
|
77837
|
-
"path" : "/:
|
|
77838
|
-
"description" : "The b2b invoice represents a transaction between Flow and one of our clients (e.g. Flow purchasing inventory to resell to a consumer)."
|
|
77839
|
-
}, {
|
|
77840
|
-
"type" : "bank_account_form",
|
|
77841
|
-
"plural" : "bank_account_forms",
|
|
77842
|
-
"operations" : [ {
|
|
77843
|
-
"method" : "PUT",
|
|
77844
|
-
"path" : "/:organization/shopify/merchant/config/bank/account",
|
|
77845
|
-
"parameters" : [ {
|
|
77846
|
-
"name" : "organization",
|
|
77847
|
-
"type" : "string",
|
|
77848
|
-
"location" : "Path",
|
|
77849
|
-
"required" : true,
|
|
77850
|
-
"description" : "Refers to your organization's account identifier"
|
|
77851
|
-
} ],
|
|
77852
|
-
"responses" : [ {
|
|
77853
|
-
"code" : {
|
|
77854
|
-
"integer" : {
|
|
77855
|
-
"value" : 200
|
|
77856
|
-
}
|
|
77857
|
-
},
|
|
77858
|
-
"type" : "organization_bank_account",
|
|
77859
|
-
"description" : "Successful response",
|
|
77860
|
-
"attributes" : [ ]
|
|
77861
|
-
}, {
|
|
77862
|
-
"code" : {
|
|
77863
|
-
"integer" : {
|
|
77864
|
-
"value" : 401
|
|
77865
|
-
}
|
|
77866
|
-
},
|
|
77867
|
-
"type" : "unit",
|
|
77868
|
-
"description" : "Authorization failed",
|
|
77869
|
-
"attributes" : [ ]
|
|
77870
|
-
}, {
|
|
77871
|
-
"code" : {
|
|
77872
|
-
"integer" : {
|
|
77873
|
-
"value" : 404
|
|
77874
|
-
}
|
|
77875
|
-
},
|
|
77876
|
-
"type" : "unit",
|
|
77877
|
-
"description" : "Resource was not found",
|
|
77878
|
-
"attributes" : [ ]
|
|
77879
|
-
}, {
|
|
77880
|
-
"code" : {
|
|
77881
|
-
"integer" : {
|
|
77882
|
-
"value" : 422
|
|
77883
|
-
}
|
|
77884
|
-
},
|
|
77885
|
-
"type" : "generic_error",
|
|
77886
|
-
"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.",
|
|
77887
|
-
"attributes" : [ ]
|
|
77888
|
-
} ],
|
|
77889
|
-
"attributes" : [ ],
|
|
77890
|
-
"body" : {
|
|
77891
|
-
"type" : "bank_account_form",
|
|
77892
|
-
"attributes" : [ ]
|
|
77893
|
-
}
|
|
77894
|
-
} ],
|
|
77895
|
-
"attributes" : [ {
|
|
77896
|
-
"name" : "docs",
|
|
77897
|
-
"value" : {
|
|
77898
|
-
"module" : "general"
|
|
77899
|
-
}
|
|
77900
|
-
} ],
|
|
77901
|
-
"path" : "/:organization/shopify/merchant/config/bank/account"
|
|
77902
|
-
}, {
|
|
77903
|
-
"type" : "catalog_price_book_item_document",
|
|
77904
|
-
"plural" : "catalog_price_book_item_documents",
|
|
77905
|
-
"operations" : [ {
|
|
77906
|
-
"method" : "GET",
|
|
77907
|
-
"path" : "/:organization/search/price/books/items",
|
|
77908
|
-
"parameters" : [ {
|
|
77909
|
-
"name" : "organization",
|
|
77910
|
-
"type" : "string",
|
|
77911
|
-
"location" : "Path",
|
|
77912
|
-
"required" : true,
|
|
77913
|
-
"description" : "Refers to your organization's account identifier"
|
|
77914
|
-
}, {
|
|
77915
|
-
"name" : "price_book_key",
|
|
77916
|
-
"type" : "[string]",
|
|
77917
|
-
"location" : "Query",
|
|
77918
|
-
"required" : false,
|
|
77919
|
-
"maximum" : 100
|
|
77920
|
-
}, {
|
|
77921
|
-
"name" : "q",
|
|
77922
|
-
"type" : "string",
|
|
77923
|
-
"location" : "Query",
|
|
77924
|
-
"required" : false
|
|
77925
|
-
}, {
|
|
77926
|
-
"name" : "limit",
|
|
77927
|
-
"type" : "long",
|
|
77928
|
-
"location" : "Query",
|
|
77929
|
-
"required" : true,
|
|
77930
|
-
"description" : "The maximum number of results to return",
|
|
77931
|
-
"default" : "25",
|
|
77932
|
-
"minimum" : 1,
|
|
77933
|
-
"maximum" : 100
|
|
77934
|
-
}, {
|
|
77935
|
-
"name" : "offset",
|
|
77936
|
-
"type" : "long",
|
|
77937
|
-
"location" : "Query",
|
|
77938
|
-
"required" : true,
|
|
77939
|
-
"description" : "The number of results to skip before returning results",
|
|
77940
|
-
"default" : "0",
|
|
77941
|
-
"minimum" : 0
|
|
77942
|
-
} ],
|
|
77943
|
-
"responses" : [ {
|
|
77944
|
-
"code" : {
|
|
77945
|
-
"integer" : {
|
|
77946
|
-
"value" : 200
|
|
77947
|
-
}
|
|
77948
|
-
},
|
|
77949
|
-
"type" : "[catalog_price_book_item_document]",
|
|
77950
|
-
"description" : "Successful response",
|
|
77951
|
-
"attributes" : [ ]
|
|
77952
|
-
}, {
|
|
77953
|
-
"code" : {
|
|
77954
|
-
"integer" : {
|
|
77955
|
-
"value" : 401
|
|
77956
|
-
}
|
|
77957
|
-
},
|
|
77958
|
-
"type" : "unit",
|
|
77959
|
-
"description" : "Authorization failed",
|
|
77960
|
-
"attributes" : [ ]
|
|
77961
|
-
}, {
|
|
77962
|
-
"code" : {
|
|
77963
|
-
"integer" : {
|
|
77964
|
-
"value" : 404
|
|
77965
|
-
}
|
|
77966
|
-
},
|
|
77967
|
-
"type" : "unit",
|
|
77968
|
-
"description" : "Resource was not found",
|
|
77969
|
-
"attributes" : [ ]
|
|
77970
|
-
} ],
|
|
77971
|
-
"attributes" : [ {
|
|
77972
|
-
"name" : "linter",
|
|
77973
|
-
"value" : {
|
|
77974
|
-
"ignore" : [ "get", "versions" ]
|
|
77975
|
-
}
|
|
77976
|
-
} ],
|
|
77977
|
-
"description" : "Returns price book item documents based on the search criteria"
|
|
77978
|
-
} ],
|
|
77979
|
-
"attributes" : [ {
|
|
77980
|
-
"name" : "docs",
|
|
77981
|
-
"value" : {
|
|
77982
|
-
"module" : "general"
|
|
77983
|
-
}
|
|
77984
|
-
} ],
|
|
77985
|
-
"path" : "/:organization/search/price/books/items",
|
|
77986
|
-
"description" : "Represents the returned information for searching particular price book items"
|
|
77987
|
-
}, {
|
|
77988
|
-
"type" : "channel_authorization",
|
|
77989
|
-
"plural" : "channel_authorizations",
|
|
77990
|
-
"operations" : [ {
|
|
77991
|
-
"method" : "POST",
|
|
77992
|
-
"path" : "/channel/authorizations",
|
|
77993
|
-
"parameters" : [ ],
|
|
77994
|
-
"responses" : [ {
|
|
77995
|
-
"code" : {
|
|
77996
|
-
"integer" : {
|
|
77997
|
-
"value" : 201
|
|
77998
|
-
}
|
|
77999
|
-
},
|
|
78000
|
-
"type" : "channel_authorization",
|
|
78001
|
-
"description" : "Operation succeeded and the resource was created",
|
|
78002
|
-
"attributes" : [ ]
|
|
78003
|
-
}, {
|
|
78004
|
-
"code" : {
|
|
78005
|
-
"integer" : {
|
|
78006
|
-
"value" : 401
|
|
78007
|
-
}
|
|
78008
|
-
},
|
|
78009
|
-
"type" : "unit",
|
|
78010
|
-
"description" : "Authorization failed",
|
|
78011
|
-
"attributes" : [ ]
|
|
78012
|
-
}, {
|
|
78013
|
-
"code" : {
|
|
78014
|
-
"integer" : {
|
|
78015
|
-
"value" : 404
|
|
78016
|
-
}
|
|
78017
|
-
},
|
|
78018
|
-
"type" : "unit",
|
|
78019
|
-
"description" : "Resource was not found",
|
|
78020
|
-
"attributes" : [ ]
|
|
78021
|
-
}, {
|
|
78022
|
-
"code" : {
|
|
78023
|
-
"integer" : {
|
|
78024
|
-
"value" : 422
|
|
78025
|
-
}
|
|
78026
|
-
},
|
|
78027
|
-
"type" : "generic_error",
|
|
78028
|
-
"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.",
|
|
78029
|
-
"attributes" : [ ]
|
|
78030
|
-
} ],
|
|
78031
|
-
"attributes" : [ ],
|
|
78032
|
-
"body" : {
|
|
78033
|
-
"type" : "channel_authorization_form",
|
|
78034
|
-
"attributes" : [ ]
|
|
78035
|
-
}
|
|
78036
|
-
} ],
|
|
78037
|
-
"attributes" : [ {
|
|
78038
|
-
"name" : "docs",
|
|
78039
|
-
"value" : {
|
|
78040
|
-
"module" : "general"
|
|
78041
|
-
}
|
|
78042
|
-
} ],
|
|
78043
|
-
"path" : "/channel/authorizations"
|
|
78825
|
+
"path" : "/channel/:channel/default/bank/accounts"
|
|
78044
78826
|
}, {
|
|
78045
78827
|
"type" : "channel_organization",
|
|
78046
78828
|
"plural" : "channel_organizations",
|
|
@@ -86929,6 +87711,12 @@
|
|
|
86929
87711
|
"required" : false,
|
|
86930
87712
|
"description" : "Filter by one or more IDs of this resource",
|
|
86931
87713
|
"maximum" : 100
|
|
87714
|
+
}, {
|
|
87715
|
+
"name" : "key",
|
|
87716
|
+
"type" : "string",
|
|
87717
|
+
"location" : "Query",
|
|
87718
|
+
"required" : false,
|
|
87719
|
+
"maximum" : 100
|
|
86932
87720
|
}, {
|
|
86933
87721
|
"name" : "limit",
|
|
86934
87722
|
"type" : "long",
|