@flowio/api-mock-generator 6.17.89 → 6.17.91

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 +308 -1796
  2. package/package.json +2 -2
  3. package/src/api.json +308 -1796
package/dist/api.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "apidoc": {
3
- "version": "0.19.10"
3
+ "version": "0.19.16"
4
4
  },
5
5
  "name": "API",
6
6
  "organization": {
@@ -10,7 +10,7 @@
10
10
  "key": "api"
11
11
  },
12
12
  "namespace": "io.flow.v0",
13
- "version": "0.19.10",
13
+ "version": "0.19.16",
14
14
  "info": {
15
15
  "license": {
16
16
  "name": "MIT",
@@ -46,7 +46,7 @@
46
46
  "application": {
47
47
  "key": "apple-pay"
48
48
  },
49
- "version": "0.3.76",
49
+ "version": "0.3.83",
50
50
  "enums": ["apple_pay_contact_field", "apple_pay_line_item_type", "apple_pay_merchant_capability", "apple_pay_shipping_type", "apple_pay_supported_networks"],
51
51
  "interfaces": [],
52
52
  "unions": [],
@@ -61,7 +61,7 @@
61
61
  "application": {
62
62
  "key": "google-pay"
63
63
  },
64
- "version": "0.3.76",
64
+ "version": "0.3.83",
65
65
  "enums": ["auth_method", "billing_address_format", "card_gateway", "card_network", "payment_method_type", "tokenization_type", "total_price_status"],
66
66
  "interfaces": [],
67
67
  "unions": ["payment_method_token"],
@@ -76,7 +76,7 @@
76
76
  "application": {
77
77
  "key": "shopify-external"
78
78
  },
79
- "version": "0.3.76",
79
+ "version": "0.3.83",
80
80
  "enums": ["cancel_reason", "discount_status", "discount_type", "discrepancy_reason", "event", "financial_status_type", "format", "fulfillment_service", "fulfillment_status_type", "graphql_weight_unit", "inventory_behaviour", "inventory_management", "inventory_policy", "kind_type", "localized_price", "order_status_type", "price_rule_allocation_method", "price_rule_customer_selection", "price_rule_target_selection", "price_rule_target_type", "price_rule_value_type", "published_scope", "restock_type", "shopify_customer_state", "shopify_discount_pagination_direction", "shopify_gift_card_status", "shopify_plan_name", "shopify_processing_method_type", "shopify_transaction_error_code", "shopify_transaction_status", "topic", "value_type", "weight_unit"],
81
81
  "interfaces": [],
82
82
  "unions": [],
@@ -91,7 +91,7 @@
91
91
  "application": {
92
92
  "key": "ben-test-internal"
93
93
  },
94
- "version": "0.24.55",
94
+ "version": "0.24.84",
95
95
  "enums": [],
96
96
  "interfaces": ["generate_load"],
97
97
  "unions": ["generate_load"],
@@ -1416,12 +1416,6 @@
1416
1416
  }, {
1417
1417
  "name": "customer_address_book_contact_deleted",
1418
1418
  "attributes": []
1419
- }, {
1420
- "name": "email_notification_upserted",
1421
- "attributes": []
1422
- }, {
1423
- "name": "email_notification_deleted",
1424
- "attributes": []
1425
1419
  }, {
1426
1420
  "name": "available_promotions_upserted",
1427
1421
  "attributes": []
@@ -2598,17 +2592,6 @@
2598
2592
  "description": "Value-Added Tax"
2599
2593
  }],
2600
2594
  "attributes": []
2601
- }, {
2602
- "name": "levy_inclusion",
2603
- "plural": "levy_inclusions",
2604
- "values": [{
2605
- "name": "tax",
2606
- "attributes": []
2607
- }, {
2608
- "name": "duty",
2609
- "attributes": []
2610
- }],
2611
- "attributes": []
2612
2595
  }, {
2613
2596
  "name": "levy_strategy",
2614
2597
  "plural": "levy_strategies",
@@ -4691,6 +4674,47 @@
4691
4674
  "attributes": []
4692
4675
  }],
4693
4676
  "attributes": []
4677
+ }, {
4678
+ "name": "shipping_label_error_code",
4679
+ "plural": "shipping_label_error_codes",
4680
+ "values": [{
4681
+ "name": "generic_error",
4682
+ "attributes": []
4683
+ }, {
4684
+ "name": "cancelled_order",
4685
+ "attributes": []
4686
+ }, {
4687
+ "name": "carrier_outage",
4688
+ "attributes": []
4689
+ }, {
4690
+ "name": "catalog_issue",
4691
+ "attributes": []
4692
+ }, {
4693
+ "name": "invalid_destination",
4694
+ "attributes": []
4695
+ }, {
4696
+ "name": "invalid_origin",
4697
+ "attributes": []
4698
+ }, {
4699
+ "name": "invalid_shipping_parameters",
4700
+ "attributes": []
4701
+ }, {
4702
+ "name": "merchant_error",
4703
+ "attributes": []
4704
+ }, {
4705
+ "name": "order_not_found",
4706
+ "attributes": []
4707
+ }, {
4708
+ "name": "order_processing",
4709
+ "attributes": []
4710
+ }, {
4711
+ "name": "restricted_item",
4712
+ "attributes": []
4713
+ }, {
4714
+ "name": "unsupported_lane",
4715
+ "attributes": []
4716
+ }],
4717
+ "attributes": []
4694
4718
  }, {
4695
4719
  "name": "shopify_grant",
4696
4720
  "plural": "shopify_grants",
@@ -4883,94 +4907,6 @@
4883
4907
  "description": "In all scenarios a customer should pay tax within the Flow system."
4884
4908
  }],
4885
4909
  "attributes": []
4886
- }, {
4887
- "name": "tax_duty_calculator_validation_error_code",
4888
- "plural": "tax_duty_calculator_validation_error_codes",
4889
- "values": [{
4890
- "name": "generic_error",
4891
- "attributes": []
4892
- }, {
4893
- "name": "destination_country_not_defined",
4894
- "attributes": [],
4895
- "description": "Destination address including at minimum a country must be included to properly generate a tax quote"
4896
- }, {
4897
- "name": "destination_address_iso3166_unrecognized",
4898
- "attributes": [],
4899
- "description": "Destination address country is not recognized as a destination country in ISO 3166"
4900
- }, {
4901
- "name": "line_item_shipfrom_shipto_country_invalid",
4902
- "attributes": [],
4903
- "description": "This is a cross-border calculator. No line's ship from country can be the same as the destination country"
4904
- }, {
4905
- "name": "line_item_ship_from_invalid",
4906
- "attributes": [],
4907
- "description": "Every line's ship from address must include a country to properly generate a tax quote"
4908
- }, {
4909
- "name": "line_item_currency_iso4217_unrecognized",
4910
- "attributes": [],
4911
- "description": "Line item provided currency is not recognized as a calculation currency in ISO 4217"
4912
- }, {
4913
- "name": "line_quantity_invalid",
4914
- "attributes": [],
4915
- "description": "Order must contain at least one line of ordered goods"
4916
- }, {
4917
- "name": "line_item_quantity_invalid",
4918
- "attributes": [],
4919
- "description": "Line item quantity must be greater than 0"
4920
- }, {
4921
- "name": "line_item_unit_price_precision_invalid",
4922
- "attributes": [],
4923
- "description": "Provided value for unit amount is more precise than the maximum allowed for this currency"
4924
- }, {
4925
- "name": "line_item_unit_price_negative",
4926
- "attributes": [],
4927
- "description": "Line Item Unit amount must be greater than or equal to 0"
4928
- }, {
4929
- "name": "line_item_discount_amount_precision_invalid",
4930
- "attributes": [],
4931
- "description": "Line item Unit discount amount is more precise than the maximum allowed for this currency"
4932
- }, {
4933
- "name": "line_item_discount_amount_positive",
4934
- "attributes": [],
4935
- "description": "Line item Unit discount must be less than or equal to 0"
4936
- }, {
4937
- "name": "line_item_country_of_origin_iso3166_unrecognized",
4938
- "attributes": [],
4939
- "description": "Line item country of origin is not recognized as a country of origin in ISO 3166"
4940
- }, {
4941
- "name": "line_item_hs_code_invalid",
4942
- "attributes": [],
4943
- "description": "Line item does not appear to contain a properly formed hs code. Please provide a 6 digit code or a 4-14 digit code specific to the destination country"
4944
- }, {
4945
- "name": "line_item_duty_provider_invalid",
4946
- "attributes": [],
4947
- "description": "Line item country of origin and shipto country resulted in inability to calculate duty."
4948
- }, {
4949
- "name": "shipping_unit_price_precision_invalid",
4950
- "attributes": [],
4951
- "description": "Shipping amount is more precise than the maximum allowed for this currency"
4952
- }, {
4953
- "name": "shipping_unit_price_negative",
4954
- "attributes": [],
4955
- "description": "Shipping amount must be greater than or equal to 0"
4956
- }, {
4957
- "name": "shipping_discount_amount_precision_invalid",
4958
- "attributes": [],
4959
- "description": "Shipping discount amount is more precise than the maximum allowed for this currency"
4960
- }, {
4961
- "name": "shipping_discount_amount_invalid",
4962
- "attributes": [],
4963
- "description": "Shipping discount must be less than or equal to 0"
4964
- }, {
4965
- "name": "merchant_of_record_invalid",
4966
- "attributes": [],
4967
- "description": "Only 'Flow' is supported as Merchant of Record"
4968
- }, {
4969
- "name": "wrong_unit_specified",
4970
- "attributes": [],
4971
- "description": "Only weight units may be specified for a unit weight."
4972
- }],
4973
- "attributes": []
4974
4910
  }, {
4975
4911
  "name": "tax_report_type",
4976
4912
  "plural": "tax_report_types",
@@ -5587,52 +5523,6 @@
5587
5523
  "description": "Show the word `FREE` in the label"
5588
5524
  }],
5589
5525
  "attributes": []
5590
- }, {
5591
- "name": "zero_levy_reason_code",
5592
- "plural": "zero_levy_reason_codes",
5593
- "values": [{
5594
- "name": "zero_basis",
5595
- "attributes": [],
5596
- "description": "When all the applicable components of an item price were added up, the result was a $0 basis"
5597
- }, {
5598
- "name": "zero_rate_on_goods",
5599
- "attributes": [],
5600
- "description": "A general 0% rate is defined for items of this type (such as medical devices or children's clothing)"
5601
- }, {
5602
- "name": "value_rounds_to_zero",
5603
- "attributes": [],
5604
- "description": "A tax rate was applied, but the result rounded to zero."
5605
- }, {
5606
- "name": "order_below_de_minimis_threshold",
5607
- "attributes": [],
5608
- "description": "The order is below the de minimis threshold"
5609
- }, {
5610
- "name": "amount_below_de_minimis_threshold",
5611
- "attributes": [],
5612
- "description": "The amount owed is below the de minimis threshold"
5613
- }, {
5614
- "name": "delivered_unpaid",
5615
- "attributes": [],
5616
- "description": "The consumer has selected not to prepay tax, and thus we have not computed the tax they will owe"
5617
- }, {
5618
- "name": "duty_free_domestic",
5619
- "attributes": [],
5620
- "description": "This cross-border tax or duty is not owed because the sale is domestic"
5621
- }, {
5622
- "name": "duty_free_intra_community",
5623
- "attributes": [],
5624
- "description": "This cross-border tax or duty is not owed because the sale is within the borders of a customs union"
5625
- }, {
5626
- "name": "duty_free_reimport",
5627
- "attributes": [],
5628
- "description": "When previously exported goods are re-imported back to the country of manufacture, they might be able to enter duty free."
5629
- }, {
5630
- "name": "duty_free_by_trade_agreement",
5631
- "attributes": [],
5632
- "description": "This cross-border tax or duty is not owed due to a certified trade agreement"
5633
- }],
5634
- "attributes": [],
5635
- "description": "Describes the reason for a $0 liability amount."
5636
5526
  }],
5637
5527
  "interfaces": [{
5638
5528
  "name": "abandoned_order_promotion_details",
@@ -6660,41 +6550,6 @@
6660
6550
  "annotations": []
6661
6551
  }],
6662
6552
  "attributes": []
6663
- }, {
6664
- "name": "tax_duty_quote_levy_value",
6665
- "plural": "tax_duty_quote_levy_values",
6666
- "fields": [{
6667
- "name": "amount",
6668
- "type": "decimal",
6669
- "required": true,
6670
- "attributes": [],
6671
- "annotations": [],
6672
- "minimum": 0,
6673
- "maximum": 1
6674
- }, {
6675
- "name": "rate",
6676
- "type": "decimal",
6677
- "required": true,
6678
- "attributes": [],
6679
- "annotations": [],
6680
- "minimum": 0,
6681
- "maximum": 1
6682
- }, {
6683
- "name": "description",
6684
- "type": "string",
6685
- "required": true,
6686
- "attributes": [],
6687
- "annotations": [],
6688
- "description": "Description of the levies included cf `VAT`, `GST + PST`, `SALT`, `Erga Omnes Duties`, `Fall Back Rate Duties`"
6689
- }, {
6690
- "name": "zero_levy_reason",
6691
- "type": "[zero_levy_reason_code]",
6692
- "required": false,
6693
- "attributes": [],
6694
- "annotations": [],
6695
- "description": "When no levy is owed, this enum explains why that would be. There can be more than one reason for a 0 levy, such as no basis and a 0% rate."
6696
- }],
6697
- "attributes": []
6698
6553
  }, {
6699
6554
  "name": "token_detail_interface",
6700
6555
  "plural": "token_detail_interfaces",
@@ -7557,14 +7412,6 @@
7557
7412
  "type": "customer_address_book_contact_deleted",
7558
7413
  "attributes": [],
7559
7414
  "discriminator_value": "customer_address_book_contact_deleted"
7560
- }, {
7561
- "type": "email_notification_upserted",
7562
- "attributes": [],
7563
- "discriminator_value": "email_notification_upserted"
7564
- }, {
7565
- "type": "email_notification_deleted",
7566
- "attributes": [],
7567
- "discriminator_value": "email_notification_deleted"
7568
7415
  }, {
7569
7416
  "type": "available_promotions_upserted",
7570
7417
  "attributes": [],
@@ -9519,18 +9366,6 @@
9519
9366
  "attributes": [],
9520
9367
  "interfaces": [],
9521
9368
  "discriminator": "discriminator"
9522
- }, {
9523
- "name": "tax_duty_quote_levy_value",
9524
- "plural": "tax_duty_quote_levy_values",
9525
- "types": [{
9526
- "type": "tax_duty_quote_simple_levy_value",
9527
- "attributes": [],
9528
- "discriminator_value": "tax_duty_quote_simple_levy_value"
9529
- }],
9530
- "attributes": [],
9531
- "interfaces": ["tax_duty_quote_levy_value"],
9532
- "discriminator": "discriminator",
9533
- "description": "The quoted value for a tax or duty, with supporting information."
9534
9369
  }, {
9535
9370
  "name": "tax_setting",
9536
9371
  "plural": "tax_settings",
@@ -18307,50 +18142,6 @@
18307
18142
  "attributes": [],
18308
18143
  "interfaces": [],
18309
18144
  "description": "Defines structured fields for a contact person. Typically used for specifying contact person for an account, shipment, or organization representative"
18310
- }, {
18311
- "name": "context",
18312
- "plural": "contexts",
18313
- "fields": [{
18314
- "name": "id",
18315
- "type": "string",
18316
- "required": true,
18317
- "attributes": [],
18318
- "annotations": [],
18319
- "description": "Globally unique identifier"
18320
- }, {
18321
- "name": "experiments",
18322
- "type": "[session_context_experiment]",
18323
- "required": true,
18324
- "attributes": [],
18325
- "annotations": []
18326
- }],
18327
- "attributes": [],
18328
- "interfaces": []
18329
- }, {
18330
- "name": "context_form",
18331
- "plural": "context_forms",
18332
- "fields": [{
18333
- "name": "experiments",
18334
- "type": "[session_context_experiment]",
18335
- "required": true,
18336
- "attributes": [],
18337
- "annotations": []
18338
- }],
18339
- "attributes": [],
18340
- "interfaces": []
18341
- }, {
18342
- "name": "context_reference",
18343
- "plural": "context_references",
18344
- "fields": [{
18345
- "name": "id",
18346
- "type": "string",
18347
- "required": true,
18348
- "attributes": [],
18349
- "annotations": [],
18350
- "description": "Globally unique identifier"
18351
- }],
18352
- "attributes": [],
18353
- "interfaces": []
18354
18145
  }, {
18355
18146
  "name": "country",
18356
18147
  "plural": "countries",
@@ -22248,37 +22039,6 @@
22248
22039
  "attributes": [],
22249
22040
  "interfaces": [],
22250
22041
  "description": "Sends an refund confirmation email to the customer (using the order.customer.email as the recipient)."
22251
- }, {
22252
- "name": "email_notification_deleted",
22253
- "plural": "email_notification_deleteds",
22254
- "fields": [{
22255
- "name": "event_id",
22256
- "type": "string",
22257
- "required": true,
22258
- "attributes": [],
22259
- "annotations": []
22260
- }, {
22261
- "name": "timestamp",
22262
- "type": "date-time-iso8601",
22263
- "required": true,
22264
- "attributes": [],
22265
- "annotations": []
22266
- }, {
22267
- "name": "organization",
22268
- "type": "string",
22269
- "required": true,
22270
- "attributes": [],
22271
- "annotations": [],
22272
- "description": "Refers to your organization's account identifier"
22273
- }, {
22274
- "name": "notification",
22275
- "type": "email_notification",
22276
- "required": true,
22277
- "attributes": [],
22278
- "annotations": ["personal_data", "consumer"]
22279
- }],
22280
- "attributes": [],
22281
- "interfaces": []
22282
22042
  }, {
22283
22043
  "name": "email_notification_form",
22284
22044
  "plural": "email_notification_forms",
@@ -22303,37 +22063,6 @@
22303
22063
  }],
22304
22064
  "attributes": [],
22305
22065
  "interfaces": []
22306
- }, {
22307
- "name": "email_notification_upserted",
22308
- "plural": "email_notification_upserteds",
22309
- "fields": [{
22310
- "name": "event_id",
22311
- "type": "string",
22312
- "required": true,
22313
- "attributes": [],
22314
- "annotations": []
22315
- }, {
22316
- "name": "timestamp",
22317
- "type": "date-time-iso8601",
22318
- "required": true,
22319
- "attributes": [],
22320
- "annotations": []
22321
- }, {
22322
- "name": "organization",
22323
- "type": "string",
22324
- "required": true,
22325
- "attributes": [],
22326
- "annotations": [],
22327
- "description": "Refers to your organization's account identifier"
22328
- }, {
22329
- "name": "notification",
22330
- "type": "email_notification",
22331
- "required": true,
22332
- "attributes": [],
22333
- "annotations": ["personal_data", "consumer"]
22334
- }],
22335
- "attributes": [],
22336
- "interfaces": []
22337
22066
  }, {
22338
22067
  "name": "email_payment_summary",
22339
22068
  "plural": "email_payment_summaries",
@@ -23922,19 +23651,6 @@
23922
23651
  }],
23923
23652
  "attributes": [],
23924
23653
  "interfaces": []
23925
- }, {
23926
- "name": "experiment_variant",
23927
- "plural": "experiment_variants",
23928
- "fields": [{
23929
- "name": "key",
23930
- "type": "string",
23931
- "required": true,
23932
- "attributes": [],
23933
- "annotations": []
23934
- }],
23935
- "attributes": [],
23936
- "interfaces": [],
23937
- "description": "Experiment variant. Control or variant"
23938
23654
  }, {
23939
23655
  "name": "expiration",
23940
23656
  "plural": "expirations",
@@ -30145,12 +29861,6 @@
30145
29861
  "required": true,
30146
29862
  "attributes": [],
30147
29863
  "annotations": []
30148
- }, {
30149
- "name": "experiment",
30150
- "type": "session_experiment",
30151
- "required": false,
30152
- "attributes": [],
30153
- "annotations": []
30154
29864
  }],
30155
29865
  "attributes": [],
30156
29866
  "interfaces": [],
@@ -36270,18 +35980,6 @@
36270
35980
  "required": false,
36271
35981
  "attributes": [],
36272
35982
  "annotations": []
36273
- }, {
36274
- "name": "experiment",
36275
- "type": "session_experiment",
36276
- "required": false,
36277
- "attributes": [],
36278
- "annotations": []
36279
- }, {
36280
- "name": "context",
36281
- "type": "context_reference",
36282
- "required": false,
36283
- "attributes": [],
36284
- "annotations": []
36285
35983
  }],
36286
35984
  "attributes": [],
36287
35985
  "interfaces": [],
@@ -46412,25 +46110,6 @@
46412
46110
  "attributes": [],
46413
46111
  "interfaces": [],
46414
46112
  "description": "Authorize a request using a session id"
46415
- }, {
46416
- "name": "session_context_experiment",
46417
- "plural": "session_context_experiments",
46418
- "fields": [{
46419
- "name": "key",
46420
- "type": "string",
46421
- "required": true,
46422
- "attributes": [],
46423
- "annotations": []
46424
- }, {
46425
- "name": "variant",
46426
- "type": "experiment_variant",
46427
- "required": false,
46428
- "attributes": [],
46429
- "annotations": []
46430
- }],
46431
- "attributes": [],
46432
- "interfaces": [],
46433
- "description": "Experiment for A/B testing"
46434
46113
  }, {
46435
46114
  "name": "session_currency_format",
46436
46115
  "plural": "session_currency_formats",
@@ -46449,74 +46128,6 @@
46449
46128
  }],
46450
46129
  "attributes": [],
46451
46130
  "interfaces": []
46452
- }, {
46453
- "name": "session_experiment",
46454
- "plural": "session_experiments",
46455
- "fields": [{
46456
- "name": "key",
46457
- "type": "string",
46458
- "required": true,
46459
- "attributes": [],
46460
- "annotations": []
46461
- }, {
46462
- "name": "variant",
46463
- "type": "session_experiment_variant",
46464
- "required": false,
46465
- "attributes": [],
46466
- "annotations": []
46467
- }],
46468
- "attributes": [],
46469
- "interfaces": [],
46470
- "description": "Experiment for A/B testing"
46471
- }, {
46472
- "name": "session_experiment_form",
46473
- "plural": "session_experiment_forms",
46474
- "fields": [{
46475
- "name": "key",
46476
- "type": "string",
46477
- "required": true,
46478
- "attributes": [],
46479
- "annotations": []
46480
- }, {
46481
- "name": "variant",
46482
- "type": "session_experiment_variant_form",
46483
- "required": false,
46484
- "attributes": [],
46485
- "annotations": []
46486
- }],
46487
- "attributes": [],
46488
- "interfaces": []
46489
- }, {
46490
- "name": "session_experiment_variant",
46491
- "plural": "session_experiment_variants",
46492
- "fields": [{
46493
- "name": "key",
46494
- "type": "string",
46495
- "required": true,
46496
- "attributes": [],
46497
- "annotations": []
46498
- }, {
46499
- "name": "name",
46500
- "type": "string",
46501
- "required": true,
46502
- "attributes": [],
46503
- "annotations": []
46504
- }],
46505
- "attributes": [],
46506
- "interfaces": [],
46507
- "description": "Experiment variant. Control or variant"
46508
- }, {
46509
- "name": "session_experiment_variant_form",
46510
- "plural": "session_experiment_variant_forms",
46511
- "fields": [{
46512
- "name": "key",
46513
- "type": "string",
46514
- "required": true,
46515
- "attributes": [],
46516
- "annotations": []
46517
- }],
46518
- "attributes": [],
46519
- "interfaces": []
46520
46131
  }, {
46521
46132
  "name": "session_expiration_config",
46522
46133
  "plural": "session_expiration_configs",
@@ -47605,6 +47216,30 @@
47605
47216
  "attributes": [],
47606
47217
  "interfaces": [],
47607
47218
  "description": "Output data or downloadable links for shipping label documents such as labels or commercial invoices"
47219
+ }, {
47220
+ "name": "shipping_label_error",
47221
+ "plural": "shipping_label_errors",
47222
+ "fields": [{
47223
+ "name": "code",
47224
+ "type": "shipping_label_error_code",
47225
+ "required": true,
47226
+ "attributes": [],
47227
+ "annotations": []
47228
+ }, {
47229
+ "name": "messages",
47230
+ "type": "[string]",
47231
+ "required": true,
47232
+ "attributes": [],
47233
+ "annotations": [],
47234
+ "minimum": 1
47235
+ }],
47236
+ "attributes": [{
47237
+ "name": "linter",
47238
+ "value": {
47239
+ "error_version": "1"
47240
+ }
47241
+ }],
47242
+ "interfaces": []
47608
47243
  }, {
47609
47244
  "name": "shipping_label_hop_cost_itemized_estimate",
47610
47245
  "plural": "shipping_label_hop_cost_itemized_estimates",
@@ -50100,45 +49735,6 @@
50100
49735
  }],
50101
49736
  "attributes": [],
50102
49737
  "interfaces": []
50103
- }, {
50104
- "name": "street_address",
50105
- "plural": "street_addresses",
50106
- "fields": [{
50107
- "name": "streets",
50108
- "type": "[string]",
50109
- "required": false,
50110
- "attributes": [],
50111
- "annotations": ["personal_data"],
50112
- "description": "Array for street line 1, street line 2, etc., in order"
50113
- }, {
50114
- "name": "city",
50115
- "type": "string",
50116
- "required": false,
50117
- "attributes": [],
50118
- "annotations": []
50119
- }, {
50120
- "name": "province",
50121
- "type": "string",
50122
- "required": false,
50123
- "attributes": [],
50124
- "annotations": []
50125
- }, {
50126
- "name": "postal",
50127
- "type": "string",
50128
- "required": false,
50129
- "attributes": [],
50130
- "annotations": []
50131
- }, {
50132
- "name": "country",
50133
- "type": "string",
50134
- "required": false,
50135
- "attributes": [],
50136
- "annotations": [],
50137
- "description": "The ISO 3166-3 country code. Case insensitive. See https://api.flow.io/reference/countries",
50138
- "example": "CAN"
50139
- }],
50140
- "attributes": [],
50141
- "interfaces": []
50142
49738
  }, {
50143
49739
  "name": "stripe_authentication_data",
50144
49740
  "plural": "stripe_authentication_data",
@@ -51112,482 +50708,6 @@
51112
50708
  "attributes": [],
51113
50709
  "interfaces": [],
51114
50710
  "description": "Represents a simple model of taxes that apply to a given item / destination."
51115
- }, {
51116
- "name": "tax_duty_calculator_validation_error",
51117
- "plural": "tax_duty_calculator_validation_errors",
51118
- "fields": [{
51119
- "name": "code",
51120
- "type": "tax_duty_calculator_validation_error_code",
51121
- "required": true,
51122
- "attributes": [],
51123
- "annotations": [],
51124
- "description": "Code representing the first error encountered when validating a request."
51125
- }, {
51126
- "name": "messages",
51127
- "type": "[string]",
51128
- "required": true,
51129
- "attributes": [],
51130
- "annotations": [],
51131
- "description": "A human readable summary of the errors encountered when processing a request.",
51132
- "minimum": 1
51133
- }],
51134
- "attributes": [{
51135
- "name": "linter",
51136
- "value": {
51137
- "error_version": "1"
51138
- }
51139
- }],
51140
- "interfaces": []
51141
- }, {
51142
- "name": "tax_duty_quote",
51143
- "plural": "tax_duty_quotes",
51144
- "fields": [{
51145
- "name": "id",
51146
- "type": "string",
51147
- "required": true,
51148
- "attributes": [],
51149
- "annotations": [],
51150
- "description": "Unique external identifier for this quote."
51151
- }, {
51152
- "name": "primary_identifier",
51153
- "type": "string",
51154
- "required": true,
51155
- "attributes": [],
51156
- "annotations": [],
51157
- "description": "A user supplied identifier that can be used to retrieve multiple requests in a single call. Examples include an order number or a cart or checkout identifier."
51158
- }, {
51159
- "name": "attributes",
51160
- "type": "map[string]",
51161
- "required": false,
51162
- "attributes": [],
51163
- "annotations": [],
51164
- "description": "A set of key/value pairs that will be preserved in any responses to this request. Useful for secondary identifiers.",
51165
- "default": "{}"
51166
- }, {
51167
- "name": "merchant_of_record",
51168
- "type": "merchant_of_record",
51169
- "required": true,
51170
- "attributes": [],
51171
- "annotations": [],
51172
- "default": "flow"
51173
- }, {
51174
- "name": "delivered_duty",
51175
- "type": "delivered_duty",
51176
- "required": true,
51177
- "attributes": [],
51178
- "annotations": [],
51179
- "default": "paid"
51180
- }, {
51181
- "name": "destination",
51182
- "type": "street_address",
51183
- "required": true,
51184
- "attributes": [],
51185
- "annotations": [],
51186
- "description": "Shipping address"
51187
- }, {
51188
- "name": "quote_date",
51189
- "type": "date-time-iso8601",
51190
- "required": true,
51191
- "attributes": [],
51192
- "annotations": [],
51193
- "description": "Time to use for any rate locks and/or to qualify any tax rules for this calculation"
51194
- }, {
51195
- "name": "currency",
51196
- "type": "string",
51197
- "required": true,
51198
- "attributes": [],
51199
- "annotations": [],
51200
- "description": "ISO-4217-3 code for the local currency."
51201
- }, {
51202
- "name": "lines",
51203
- "type": "[tax_duty_quote_line_item]",
51204
- "required": true,
51205
- "attributes": [],
51206
- "annotations": []
51207
- }, {
51208
- "name": "shipping",
51209
- "type": "[tax_duty_quote_simple_shipping]",
51210
- "required": true,
51211
- "attributes": [],
51212
- "annotations": [],
51213
- "description": "Shipping charge(s) in local currency"
51214
- }, {
51215
- "name": "total_values",
51216
- "type": "tax_duty_quote_values",
51217
- "required": true,
51218
- "attributes": [],
51219
- "annotations": [],
51220
- "description": "Total of all values. Base price and discount will be the sum of all unit values. Tax and duty may be recalculated and thus off by pennies due to rounding."
51221
- }],
51222
- "attributes": [],
51223
- "interfaces": [],
51224
- "description": "An order to have tax and duty calculated. Quote will provide all values in the local currency."
51225
- }, {
51226
- "name": "tax_duty_quote_fee_value",
51227
- "plural": "tax_duty_quote_fee_values",
51228
- "fields": [{
51229
- "name": "amount",
51230
- "type": "decimal",
51231
- "required": true,
51232
- "attributes": [],
51233
- "annotations": [],
51234
- "minimum": 0
51235
- }, {
51236
- "name": "description",
51237
- "type": "string",
51238
- "required": true,
51239
- "attributes": [],
51240
- "annotations": [],
51241
- "description": "Description of the fee."
51242
- }, {
51243
- "name": "amount_refundable_on_return",
51244
- "type": "decimal",
51245
- "required": true,
51246
- "attributes": [],
51247
- "annotations": [],
51248
- "description": "The amount that can be refunded after a completed shipment to a consumer. This will exclude one-time taxes, duties and fees paid to customs, which are generally not refunded by governements.",
51249
- "minimum": 0
51250
- }],
51251
- "attributes": [],
51252
- "interfaces": [],
51253
- "description": "Value of a fee associated with customs or import."
51254
- }, {
51255
- "name": "tax_duty_quote_form",
51256
- "plural": "tax_duty_quote_forms",
51257
- "fields": [{
51258
- "name": "primary_identifier",
51259
- "type": "string",
51260
- "required": true,
51261
- "attributes": [],
51262
- "annotations": [],
51263
- "description": "A user supplied identifier that can be used to retrieve multiple requests in a single call. Examples include an order number or a cart or checkout identifier."
51264
- }, {
51265
- "name": "attributes",
51266
- "type": "map[string]",
51267
- "required": false,
51268
- "attributes": [],
51269
- "annotations": [],
51270
- "description": "A set of key/value pairs that will be preserved in any responses to this request. Useful for secondary identifiers.",
51271
- "default": "{}"
51272
- }, {
51273
- "name": "delivered_duty",
51274
- "type": "delivered_duty",
51275
- "required": true,
51276
- "attributes": [],
51277
- "annotations": [],
51278
- "default": "paid"
51279
- }, {
51280
- "name": "destination",
51281
- "type": "street_address",
51282
- "required": true,
51283
- "attributes": [],
51284
- "annotations": [],
51285
- "description": "Shipping address. At minimum country is required; depending on the jurisdiction, province, postal code and streets may also be required."
51286
- }, {
51287
- "name": "currency",
51288
- "type": "string",
51289
- "required": true,
51290
- "attributes": [],
51291
- "annotations": [],
51292
- "description": "ISO-4217-3 code for the local currency. This is the currency the consumer will be paying in."
51293
- }, {
51294
- "name": "lines",
51295
- "type": "[tax_duty_quote_line_item_form]",
51296
- "required": true,
51297
- "attributes": [],
51298
- "annotations": [],
51299
- "minimum": 1
51300
- }, {
51301
- "name": "shipping",
51302
- "type": "[tax_duty_quote_simple_shipping_form]",
51303
- "required": true,
51304
- "attributes": [],
51305
- "annotations": []
51306
- }, {
51307
- "name": "includes",
51308
- "type": "[levy_inclusion]",
51309
- "required": false,
51310
- "attributes": [],
51311
- "annotations": [],
51312
- "description": "Indicators for tax and duty inclusive pricing.",
51313
- "default": "[]"
51314
- }],
51315
- "attributes": [],
51316
- "interfaces": [],
51317
- "description": "Calculates tax and duty in two currencies, representing consumer and client values for an MoR sale. Preserves de minimis and LVG calculations from the consumer sale."
51318
- }, {
51319
- "name": "tax_duty_quote_line_item",
51320
- "plural": "tax_duty_quote_line_items",
51321
- "fields": [{
51322
- "name": "primary_identifier",
51323
- "type": "string",
51324
- "required": true,
51325
- "attributes": [],
51326
- "annotations": [],
51327
- "description": "A user supplied identifier that can be used to correlate a quote request line with a quote response line. Examples include an item number, variant id, line number or."
51328
- }, {
51329
- "name": "attributes",
51330
- "type": "map[string]",
51331
- "required": false,
51332
- "attributes": [],
51333
- "annotations": [],
51334
- "description": "A set of key/value pairs that will be preserved in any responses to this request. Useful for secondary identifiers.",
51335
- "default": "{}"
51336
- }, {
51337
- "name": "ship_from",
51338
- "type": "street_address",
51339
- "required": true,
51340
- "attributes": [],
51341
- "annotations": [],
51342
- "description": "Ship-from address for this line."
51343
- }, {
51344
- "name": "quantity",
51345
- "type": "long",
51346
- "required": true,
51347
- "attributes": [],
51348
- "annotations": [],
51349
- "minimum": 1
51350
- }, {
51351
- "name": "unit_values",
51352
- "type": "tax_duty_quote_values",
51353
- "required": true,
51354
- "attributes": [],
51355
- "annotations": [],
51356
- "description": "The unit values for this line item. Multiply each by quantity to calculate the total values for this line"
51357
- }, {
51358
- "name": "country_of_origin",
51359
- "type": "string",
51360
- "required": true,
51361
- "attributes": [],
51362
- "annotations": [],
51363
- "description": "ISO-3166-3 code for the country of manufacture for these goods"
51364
- }, {
51365
- "name": "hs_code",
51366
- "type": "string",
51367
- "required": true,
51368
- "attributes": [],
51369
- "annotations": [],
51370
- "description": "HTS code for these goods"
51371
- }],
51372
- "attributes": [],
51373
- "interfaces": [],
51374
- "description": "An ordered quantity of goods for tax and duty calculation."
51375
- }, {
51376
- "name": "tax_duty_quote_line_item_form",
51377
- "plural": "tax_duty_quote_line_item_forms",
51378
- "fields": [{
51379
- "name": "primary_identifier",
51380
- "type": "string",
51381
- "required": true,
51382
- "attributes": [],
51383
- "annotations": [],
51384
- "description": "A user supplied identifier that can be used to correlate a quote request line with a quote response line. Examples include an item number, variant id, line number or."
51385
- }, {
51386
- "name": "attributes",
51387
- "type": "map[string]",
51388
- "required": false,
51389
- "attributes": [],
51390
- "annotations": [],
51391
- "description": "A set of key/value pairs that will be preserved in any responses to this request. Useful for secondary identifiers.",
51392
- "default": "{}"
51393
- }, {
51394
- "name": "ship_from",
51395
- "type": "street_address",
51396
- "required": true,
51397
- "attributes": [],
51398
- "annotations": [],
51399
- "description": "Ship-from address for this line. Usually the address of the DC from which an order will be sourced. Country is required."
51400
- }, {
51401
- "name": "quantity",
51402
- "type": "long",
51403
- "required": true,
51404
- "attributes": [],
51405
- "annotations": [],
51406
- "minimum": 1
51407
- }, {
51408
- "name": "unit_price",
51409
- "type": "decimal",
51410
- "required": true,
51411
- "attributes": [],
51412
- "annotations": [],
51413
- "description": "The unit price of this line, in the local currency from the tax_duty_quote_form",
51414
- "minimum": 0
51415
- }, {
51416
- "name": "unit_weight",
51417
- "type": "measurement",
51418
- "required": false,
51419
- "attributes": [],
51420
- "annotations": [],
51421
- "description": "Packaged weight of one unit. Optional but strongly encouraged to ensure correct calculation. Must use a unit of weight; `kilogram` is suggested"
51422
- }, {
51423
- "name": "country_of_origin",
51424
- "type": "string",
51425
- "required": false,
51426
- "attributes": [],
51427
- "annotations": [],
51428
- "description": "ISO-3166-3 code for the country of manufacture for these goods. If left blank, country of origin will be inferred using organization settings."
51429
- }, {
51430
- "name": "hs_code",
51431
- "type": "string",
51432
- "required": false,
51433
- "attributes": [],
51434
- "annotations": [],
51435
- "description": "HTS code for these goods",
51436
- "minimum": 4
51437
- }, {
51438
- "name": "includes",
51439
- "type": "[levy_inclusion]",
51440
- "required": true,
51441
- "attributes": [],
51442
- "annotations": [],
51443
- "deprecation": {
51444
- "description": "Replace with usage of 'includes' at the top level"
51445
- },
51446
- "default": "[]"
51447
- }],
51448
- "attributes": [],
51449
- "interfaces": [],
51450
- "description": "An ordered quantity of goods for tax and duty calculation. At least one of line_number, line_id, item_number or sku is required."
51451
- }, {
51452
- "name": "tax_duty_quote_simple_levy_value",
51453
- "plural": "tax_duty_quote_simple_levy_values",
51454
- "fields": [{
51455
- "name": "amount",
51456
- "type": "decimal",
51457
- "required": true,
51458
- "attributes": [],
51459
- "annotations": [],
51460
- "minimum": 0
51461
- }, {
51462
- "name": "rate",
51463
- "type": "decimal",
51464
- "required": true,
51465
- "attributes": [],
51466
- "annotations": [],
51467
- "minimum": 0,
51468
- "maximum": 1
51469
- }, {
51470
- "name": "description",
51471
- "type": "string",
51472
- "required": true,
51473
- "attributes": [],
51474
- "annotations": [],
51475
- "description": "Description of the levies included cf `VAT`, `GST + PST`, `SALT`, `Erga Omnes duty`, `Fall Back Rate duty`"
51476
- }, {
51477
- "name": "zero_levy_reason",
51478
- "type": "[zero_levy_reason_code]",
51479
- "required": false,
51480
- "attributes": [],
51481
- "annotations": [],
51482
- "description": "When no levy is owed, this enum explains why. There can be more than one reason for a 0 levy, such as no basis and a 0% rate.",
51483
- "minimum": 0
51484
- }, {
51485
- "name": "amount_refundable_on_return",
51486
- "type": "decimal",
51487
- "required": true,
51488
- "attributes": [],
51489
- "annotations": [],
51490
- "description": "The amount that can be refunded after a completed shipment to a consumer. This will exclude one-time taxes, duties and fees paid to customs, which are generally not refunded by governements.",
51491
- "minimum": 0
51492
- }],
51493
- "attributes": [],
51494
- "interfaces": ["tax_duty_quote_levy_value"],
51495
- "description": "Value of a levy (tax or duty) with no additional detail."
51496
- }, {
51497
- "name": "tax_duty_quote_simple_shipping",
51498
- "plural": "tax_duty_quote_simple_shippings",
51499
- "fields": [{
51500
- "name": "values",
51501
- "type": "tax_duty_quote_values",
51502
- "required": true,
51503
- "attributes": [],
51504
- "annotations": []
51505
- }, {
51506
- "name": "ship_from",
51507
- "type": "street_address",
51508
- "required": true,
51509
- "attributes": [],
51510
- "annotations": [],
51511
- "description": "The ship-from address associated with this shipping charge. If omitted, this shipping charge will be assumed to apply to the first ship-from country in the list of items."
51512
- }],
51513
- "attributes": [],
51514
- "interfaces": [],
51515
- "description": "An ordered quantity of goods for tax and duty calculation."
51516
- }, {
51517
- "name": "tax_duty_quote_simple_shipping_form",
51518
- "plural": "tax_duty_quote_simple_shipping_forms",
51519
- "fields": [{
51520
- "name": "price",
51521
- "type": "decimal",
51522
- "required": true,
51523
- "attributes": [],
51524
- "annotations": [],
51525
- "description": "Shipping charge displayed to consumer in their local currency",
51526
- "minimum": 0
51527
- }, {
51528
- "name": "includes",
51529
- "type": "[levy_inclusion]",
51530
- "required": true,
51531
- "attributes": [],
51532
- "annotations": [],
51533
- "deprecation": {
51534
- "description": "Replace with usage of 'includes' at the top level"
51535
- },
51536
- "default": "[]"
51537
- }, {
51538
- "name": "ship_from",
51539
- "type": "street_address",
51540
- "required": false,
51541
- "attributes": [],
51542
- "annotations": [],
51543
- "description": "The ship-from address associated with this shipping charge. If omitted, this shipping charge will be assumed to apply to the first ship-from country in the list of items."
51544
- }],
51545
- "attributes": [],
51546
- "interfaces": [],
51547
- "description": "Shipping revenue paid by the consumer for a single shipping charge. If a shipping revenue line is not provided for any ship_from location, it will be assumed no shipping was collected for shipments from this location."
51548
- }, {
51549
- "name": "tax_duty_quote_values",
51550
- "plural": "tax_duty_quote_values",
51551
- "fields": [{
51552
- "name": "price",
51553
- "type": "decimal",
51554
- "required": true,
51555
- "attributes": [],
51556
- "annotations": [],
51557
- "description": "The calculated price exclusive of discounts.",
51558
- "minimum": 0
51559
- }, {
51560
- "name": "duty",
51561
- "type": "tax_duty_quote_simple_levy_value",
51562
- "required": true,
51563
- "attributes": [],
51564
- "annotations": [],
51565
- "description": "duty calculated on discounted price"
51566
- }, {
51567
- "name": "tax",
51568
- "type": "tax_duty_quote_simple_levy_value",
51569
- "required": true,
51570
- "attributes": [],
51571
- "annotations": [],
51572
- "description": "Total tax calculated on discounted base price and duty on discounted price."
51573
- }, {
51574
- "name": "fees",
51575
- "type": "tax_duty_quote_fee_value",
51576
- "required": true,
51577
- "attributes": [],
51578
- "annotations": [],
51579
- "description": "Total tax calculated on discounted base price and duty on discounted price."
51580
- }, {
51581
- "name": "total",
51582
- "type": "decimal",
51583
- "required": true,
51584
- "attributes": [],
51585
- "annotations": [],
51586
- "description": "The calculated total.",
51587
- "minimum": 0
51588
- }],
51589
- "attributes": [],
51590
- "interfaces": []
51591
50711
  }, {
51592
50712
  "name": "tax_registration",
51593
50713
  "plural": "tax_registrations",
@@ -52711,6 +51831,12 @@
52711
51831
  "required": false,
52712
51832
  "attributes": [],
52713
51833
  "annotations": []
51834
+ }, {
51835
+ "name": "created_at",
51836
+ "type": "date-time-iso8601",
51837
+ "required": false,
51838
+ "attributes": [],
51839
+ "annotations": []
52714
51840
  }],
52715
51841
  "attributes": [],
52716
51842
  "interfaces": []
@@ -55223,12 +54349,6 @@
55223
54349
  "location": "Query",
55224
54350
  "required": false,
55225
54351
  "maximum": 100
55226
- }, {
55227
- "name": "context",
55228
- "type": "string",
55229
- "location": "Query",
55230
- "required": false,
55231
- "description": "The session context"
55232
54352
  }],
55233
54353
  "responses": [{
55234
54354
  "code": {
@@ -56244,12 +55364,6 @@
56244
55364
  "location": "Path",
56245
55365
  "required": true,
56246
55366
  "description": "Refers to your organization's account identifier"
56247
- }, {
56248
- "name": "context",
56249
- "type": "string",
56250
- "location": "Query",
56251
- "required": false,
56252
- "description": "The session context"
56253
55367
  }],
56254
55368
  "responses": [{
56255
55369
  "code": {
@@ -56353,12 +55467,6 @@
56353
55467
  "location": "Path",
56354
55468
  "required": true,
56355
55469
  "description": "Filter by one or more IDs of this resource"
56356
- }, {
56357
- "name": "context",
56358
- "type": "string",
56359
- "location": "Query",
56360
- "required": false,
56361
- "description": "The session context"
56362
55470
  }],
56363
55471
  "responses": [{
56364
55472
  "code": {
@@ -56497,12 +55605,6 @@
56497
55605
  "description": "The number of results to skip before returning results",
56498
55606
  "default": "0",
56499
55607
  "minimum": 0
56500
- }, {
56501
- "name": "context",
56502
- "type": "string",
56503
- "location": "Query",
56504
- "required": false,
56505
- "description": "The session context"
56506
55608
  }],
56507
55609
  "responses": [{
56508
55610
  "code": {
@@ -56672,12 +55774,6 @@
56672
55774
  "minimum": 0,
56673
55775
  "maximum": 1,
56674
55776
  "example": "order"
56675
- }, {
56676
- "name": "context",
56677
- "type": "string",
56678
- "location": "Query",
56679
- "required": false,
56680
- "description": "The session context"
56681
55777
  }],
56682
55778
  "responses": [{
56683
55779
  "code": {
@@ -56795,72 +55891,20 @@
56795
55891
  "description": "Resource was not found",
56796
55892
  "attributes": []
56797
55893
  }],
56798
- "attributes": [{
56799
- "name": "sort",
56800
- "value": {
56801
- "values": [{
56802
- "value": "id"
56803
- }, {
56804
- "value": "key"
56805
- }, {
56806
- "value": "journal_timestamp"
56807
- }]
56808
- }
56809
- }]
56810
- }, {
56811
- "method": "GET",
56812
- "path": "/:organization/credit/payments/:key",
56813
- "parameters": [{
56814
- "name": "organization",
56815
- "type": "string",
56816
- "location": "Path",
56817
- "required": true,
56818
- "description": "Refers to your organization's account identifier"
56819
- }, {
56820
- "name": "key",
56821
- "type": "string",
56822
- "location": "Path",
56823
- "required": true
56824
- }, {
56825
- "name": "expand",
56826
- "type": "[string]",
56827
- "location": "Query",
56828
- "required": false,
56829
- "minimum": 0,
56830
- "maximum": 1,
56831
- "example": "order"
56832
- }],
56833
- "responses": [{
56834
- "code": {
56835
- "integer": {
56836
- "value": 200
56837
- }
56838
- },
56839
- "type": "credit_payment",
56840
- "description": "Successful response",
56841
- "attributes": []
56842
- }, {
56843
- "code": {
56844
- "integer": {
56845
- "value": 401
56846
- }
56847
- },
56848
- "type": "unit",
56849
- "description": "Authorization failed",
56850
- "attributes": []
56851
- }, {
56852
- "code": {
56853
- "integer": {
56854
- "value": 404
56855
- }
56856
- },
56857
- "type": "unit",
56858
- "description": "Resource was not found",
56859
- "attributes": []
56860
- }],
56861
- "attributes": []
55894
+ "attributes": [{
55895
+ "name": "sort",
55896
+ "value": {
55897
+ "values": [{
55898
+ "value": "id"
55899
+ }, {
55900
+ "value": "key"
55901
+ }, {
55902
+ "value": "journal_timestamp"
55903
+ }]
55904
+ }
55905
+ }]
56862
55906
  }, {
56863
- "method": "PUT",
55907
+ "method": "GET",
56864
55908
  "path": "/:organization/credit/payments/:key",
56865
55909
  "parameters": [{
56866
55910
  "name": "organization",
@@ -56881,12 +55925,58 @@
56881
55925
  "minimum": 0,
56882
55926
  "maximum": 1,
56883
55927
  "example": "order"
55928
+ }],
55929
+ "responses": [{
55930
+ "code": {
55931
+ "integer": {
55932
+ "value": 200
55933
+ }
55934
+ },
55935
+ "type": "credit_payment",
55936
+ "description": "Successful response",
55937
+ "attributes": []
55938
+ }, {
55939
+ "code": {
55940
+ "integer": {
55941
+ "value": 401
55942
+ }
55943
+ },
55944
+ "type": "unit",
55945
+ "description": "Authorization failed",
55946
+ "attributes": []
56884
55947
  }, {
56885
- "name": "context",
55948
+ "code": {
55949
+ "integer": {
55950
+ "value": 404
55951
+ }
55952
+ },
55953
+ "type": "unit",
55954
+ "description": "Resource was not found",
55955
+ "attributes": []
55956
+ }],
55957
+ "attributes": []
55958
+ }, {
55959
+ "method": "PUT",
55960
+ "path": "/:organization/credit/payments/:key",
55961
+ "parameters": [{
55962
+ "name": "organization",
55963
+ "type": "string",
55964
+ "location": "Path",
55965
+ "required": true,
55966
+ "description": "Refers to your organization's account identifier"
55967
+ }, {
55968
+ "name": "key",
56886
55969
  "type": "string",
55970
+ "location": "Path",
55971
+ "required": true
55972
+ }, {
55973
+ "name": "expand",
55974
+ "type": "[string]",
56887
55975
  "location": "Query",
56888
55976
  "required": false,
56889
- "description": "The session context"
55977
+ "minimum": 0,
55978
+ "maximum": 1,
55979
+ "example": "order"
56890
55980
  }],
56891
55981
  "responses": [{
56892
55982
  "code": {
@@ -56953,12 +56043,6 @@
56953
56043
  "type": "string",
56954
56044
  "location": "Path",
56955
56045
  "required": true
56956
- }, {
56957
- "name": "context",
56958
- "type": "string",
56959
- "location": "Query",
56960
- "required": false,
56961
- "description": "The session context"
56962
56046
  }],
56963
56047
  "responses": [{
56964
56048
  "code": {
@@ -57366,12 +56450,6 @@
57366
56450
  "type": "string",
57367
56451
  "location": "Query",
57368
56452
  "required": false
57369
- }, {
57370
- "name": "context",
57371
- "type": "string",
57372
- "location": "Query",
57373
- "required": false,
57374
- "description": "The session context"
57375
56453
  }, {
57376
56454
  "name": "limit",
57377
56455
  "type": "long",
@@ -57462,12 +56540,6 @@
57462
56540
  "location": "Path",
57463
56541
  "required": true,
57464
56542
  "description": "Refers to your organization's account identifier"
57465
- }, {
57466
- "name": "context",
57467
- "type": "string",
57468
- "location": "Query",
57469
- "required": false,
57470
- "description": "The session context"
57471
56543
  }],
57472
56544
  "responses": [{
57473
56545
  "code": {
@@ -57555,12 +56627,6 @@
57555
56627
  "location": "Query",
57556
56628
  "required": false,
57557
56629
  "description": "If specified, the provided base amount will be converted to and formatted in this currency."
57558
- }, {
57559
- "name": "context",
57560
- "type": "string",
57561
- "location": "Query",
57562
- "required": false,
57563
- "description": "The session context"
57564
56630
  }],
57565
56631
  "responses": [{
57566
56632
  "code": {
@@ -57657,12 +56723,6 @@
57657
56723
  "required": false,
57658
56724
  "description": "ISO 639 2 language code as defined in https://api.flow.io/reference/languages If specified, translate content to this language (where available)",
57659
56725
  "example": "en"
57660
- }, {
57661
- "name": "context",
57662
- "type": "string",
57663
- "location": "Query",
57664
- "required": false,
57665
- "description": "The session context"
57666
56726
  }, {
57667
56727
  "name": "limit",
57668
56728
  "type": "long",
@@ -57780,12 +56840,6 @@
57780
56840
  "required": false,
57781
56841
  "description": "ISO 639 2 language code as defined in https://api.flow.io/reference/languages",
57782
56842
  "example": "en"
57783
- }, {
57784
- "name": "context",
57785
- "type": "string",
57786
- "location": "Query",
57787
- "required": false,
57788
- "description": "The session context"
57789
56843
  }],
57790
56844
  "responses": [{
57791
56845
  "code": {
@@ -57901,12 +56955,6 @@
57901
56955
  "location": "Query",
57902
56956
  "required": false,
57903
56957
  "maximum": 100
57904
- }, {
57905
- "name": "context",
57906
- "type": "string",
57907
- "location": "Query",
57908
- "required": false,
57909
- "description": "The session context"
57910
56958
  }, {
57911
56959
  "name": "limit",
57912
56960
  "type": "long",
@@ -57988,12 +57036,6 @@
57988
57036
  "type": "string",
57989
57037
  "location": "Path",
57990
57038
  "required": true
57991
- }, {
57992
- "name": "context",
57993
- "type": "string",
57994
- "location": "Query",
57995
- "required": false,
57996
- "description": "The session context"
57997
57039
  }],
57998
57040
  "responses": [{
57999
57041
  "code": {
@@ -58038,12 +57080,6 @@
58038
57080
  "type": "string",
58039
57081
  "location": "Path",
58040
57082
  "required": true
58041
- }, {
58042
- "name": "context",
58043
- "type": "string",
58044
- "location": "Query",
58045
- "required": false,
58046
- "description": "The session context"
58047
57083
  }],
58048
57084
  "responses": [{
58049
57085
  "code": {
@@ -58114,12 +57150,6 @@
58114
57150
  "location": "Query",
58115
57151
  "required": false,
58116
57152
  "description": "Iso 4217 3 currency code as defined in https://api.flow.io/reference/currencies If specified, translate the pricing to this currency. Translation occurs using the current spot rate for this currency from the base currency in the experience. If not specified, the item is returned in the currency of the experience."
58117
- }, {
58118
- "name": "context",
58119
- "type": "string",
58120
- "location": "Query",
58121
- "required": false,
58122
- "description": "The session context"
58123
57153
  }],
58124
57154
  "responses": [{
58125
57155
  "code": {
@@ -58649,12 +57679,6 @@
58649
57679
  "description": "The number of results to skip before returning results",
58650
57680
  "default": "0",
58651
57681
  "minimum": 0
58652
- }, {
58653
- "name": "context",
58654
- "type": "string",
58655
- "location": "Query",
58656
- "required": false,
58657
- "description": "The session context"
58658
57682
  }],
58659
57683
  "responses": [{
58660
57684
  "code": {
@@ -58730,12 +57754,6 @@
58730
57754
  "location": "Query",
58731
57755
  "required": false,
58732
57756
  "description": "Required if amount is specified"
58733
- }, {
58734
- "name": "context",
58735
- "type": "string",
58736
- "location": "Query",
58737
- "required": false,
58738
- "description": "The session context"
58739
57757
  }],
58740
57758
  "responses": [{
58741
57759
  "code": {
@@ -58803,12 +57821,6 @@
58803
57821
  "type": "string",
58804
57822
  "location": "Path",
58805
57823
  "required": true
58806
- }, {
58807
- "name": "context",
58808
- "type": "string",
58809
- "location": "Query",
58810
- "required": false,
58811
- "description": "The session context"
58812
57824
  }],
58813
57825
  "responses": [{
58814
57826
  "code": {
@@ -58848,188 +57860,13 @@
58848
57860
  "attributes": []
58849
57861
  }],
58850
57862
  "attributes": [],
58851
- "description": "Change the ordering or payment tags for an experience. Every post must include one entry for each payment method offered by Flow.",
58852
- "body": {
58853
- "type": "[experience_payment_method_rule_form]",
58854
- "attributes": []
58855
- }
58856
- }, {
58857
- "method": "GET",
58858
- "path": "/:organization/experiences/:experience_key/price/books",
58859
- "parameters": [{
58860
- "name": "organization",
58861
- "type": "string",
58862
- "location": "Path",
58863
- "required": true,
58864
- "description": "Refers to your organization's account identifier"
58865
- }, {
58866
- "name": "experience_key",
58867
- "type": "string",
58868
- "location": "Path",
58869
- "required": true
58870
- }, {
58871
- "name": "id",
58872
- "type": "[string]",
58873
- "location": "Query",
58874
- "required": false,
58875
- "description": "Filter by one or more IDs of this resource",
58876
- "maximum": 100
58877
- }, {
58878
- "name": "price_book_key",
58879
- "type": "[string]",
58880
- "location": "Query",
58881
- "required": false,
58882
- "maximum": 100
58883
- }, {
58884
- "name": "limit",
58885
- "type": "long",
58886
- "location": "Query",
58887
- "required": true,
58888
- "description": "The maximum number of results to return",
58889
- "default": "25",
58890
- "minimum": 1,
58891
- "maximum": 100
58892
- }, {
58893
- "name": "offset",
58894
- "type": "long",
58895
- "location": "Query",
58896
- "required": true,
58897
- "description": "The number of results to skip before returning results",
58898
- "default": "0",
58899
- "minimum": 0
58900
- }, {
58901
- "name": "sort",
58902
- "type": "string",
58903
- "location": "Query",
58904
- "required": true,
58905
- "default": "position"
58906
- }],
58907
- "responses": [{
58908
- "code": {
58909
- "integer": {
58910
- "value": 200
58911
- }
58912
- },
58913
- "type": "[experience_price_book_mapping]",
58914
- "description": "Successful response",
58915
- "attributes": []
58916
- }, {
58917
- "code": {
58918
- "integer": {
58919
- "value": 401
58920
- }
58921
- },
58922
- "type": "unit",
58923
- "description": "Authorization failed",
58924
- "attributes": []
58925
- }, {
58926
- "code": {
58927
- "integer": {
58928
- "value": 404
58929
- }
58930
- },
58931
- "type": "unit",
58932
- "description": "Resource was not found",
58933
- "attributes": []
58934
- }, {
58935
- "code": {
58936
- "integer": {
58937
- "value": 422
58938
- }
58939
- },
58940
- "type": "generic_error",
58941
- "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.",
58942
- "attributes": []
58943
- }],
58944
- "attributes": [{
58945
- "name": "sort",
58946
- "value": {
58947
- "values": [{
58948
- "value": "created_at"
58949
- }, {
58950
- "value": "position"
58951
- }]
58952
- }
58953
- }, {
58954
- "name": "linter",
58955
- "value": {
58956
- "ignore": ["get", "sort_parameter_default", "versions"]
58957
- }
58958
- }]
58959
- }, {
58960
- "method": "POST",
58961
- "path": "/:organization/experiences/:experience_key/price/books",
58962
- "parameters": [{
58963
- "name": "organization",
58964
- "type": "string",
58965
- "location": "Path",
58966
- "required": true,
58967
- "description": "Refers to your organization's account identifier"
58968
- }, {
58969
- "name": "experience_key",
58970
- "type": "string",
58971
- "location": "Path",
58972
- "required": true
58973
- }, {
58974
- "name": "context",
58975
- "type": "string",
58976
- "location": "Query",
58977
- "required": false,
58978
- "description": "The session context"
58979
- }],
58980
- "responses": [{
58981
- "code": {
58982
- "integer": {
58983
- "value": 200
58984
- }
58985
- },
58986
- "type": "experience_price_book_mapping",
58987
- "description": "Successful response",
58988
- "attributes": []
58989
- }, {
58990
- "code": {
58991
- "integer": {
58992
- "value": 201
58993
- }
58994
- },
58995
- "type": "experience_price_book_mapping",
58996
- "description": "Operation succeeded and the resource was created",
58997
- "attributes": []
58998
- }, {
58999
- "code": {
59000
- "integer": {
59001
- "value": 401
59002
- }
59003
- },
59004
- "type": "unit",
59005
- "description": "Authorization failed",
59006
- "attributes": []
59007
- }, {
59008
- "code": {
59009
- "integer": {
59010
- "value": 404
59011
- }
59012
- },
59013
- "type": "unit",
59014
- "description": "Resource was not found",
59015
- "attributes": []
59016
- }, {
59017
- "code": {
59018
- "integer": {
59019
- "value": 422
59020
- }
59021
- },
59022
- "type": "generic_error",
59023
- "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.",
59024
- "attributes": []
59025
- }],
59026
- "attributes": [],
57863
+ "description": "Change the ordering or payment tags for an experience. Every post must include one entry for each payment method offered by Flow.",
59027
57864
  "body": {
59028
- "type": "experience_price_book_mapping_form",
57865
+ "type": "[experience_payment_method_rule_form]",
59029
57866
  "attributes": []
59030
57867
  }
59031
57868
  }, {
59032
- "method": "PUT",
57869
+ "method": "GET",
59033
57870
  "path": "/:organization/experiences/:experience_key/price/books",
59034
57871
  "parameters": [{
59035
57872
  "name": "organization",
@@ -59043,11 +57880,174 @@
59043
57880
  "location": "Path",
59044
57881
  "required": true
59045
57882
  }, {
59046
- "name": "context",
59047
- "type": "string",
57883
+ "name": "id",
57884
+ "type": "[string]",
59048
57885
  "location": "Query",
59049
57886
  "required": false,
59050
- "description": "The session context"
57887
+ "description": "Filter by one or more IDs of this resource",
57888
+ "maximum": 100
57889
+ }, {
57890
+ "name": "price_book_key",
57891
+ "type": "[string]",
57892
+ "location": "Query",
57893
+ "required": false,
57894
+ "maximum": 100
57895
+ }, {
57896
+ "name": "limit",
57897
+ "type": "long",
57898
+ "location": "Query",
57899
+ "required": true,
57900
+ "description": "The maximum number of results to return",
57901
+ "default": "25",
57902
+ "minimum": 1,
57903
+ "maximum": 100
57904
+ }, {
57905
+ "name": "offset",
57906
+ "type": "long",
57907
+ "location": "Query",
57908
+ "required": true,
57909
+ "description": "The number of results to skip before returning results",
57910
+ "default": "0",
57911
+ "minimum": 0
57912
+ }, {
57913
+ "name": "sort",
57914
+ "type": "string",
57915
+ "location": "Query",
57916
+ "required": true,
57917
+ "default": "position"
57918
+ }],
57919
+ "responses": [{
57920
+ "code": {
57921
+ "integer": {
57922
+ "value": 200
57923
+ }
57924
+ },
57925
+ "type": "[experience_price_book_mapping]",
57926
+ "description": "Successful response",
57927
+ "attributes": []
57928
+ }, {
57929
+ "code": {
57930
+ "integer": {
57931
+ "value": 401
57932
+ }
57933
+ },
57934
+ "type": "unit",
57935
+ "description": "Authorization failed",
57936
+ "attributes": []
57937
+ }, {
57938
+ "code": {
57939
+ "integer": {
57940
+ "value": 404
57941
+ }
57942
+ },
57943
+ "type": "unit",
57944
+ "description": "Resource was not found",
57945
+ "attributes": []
57946
+ }, {
57947
+ "code": {
57948
+ "integer": {
57949
+ "value": 422
57950
+ }
57951
+ },
57952
+ "type": "generic_error",
57953
+ "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.",
57954
+ "attributes": []
57955
+ }],
57956
+ "attributes": [{
57957
+ "name": "sort",
57958
+ "value": {
57959
+ "values": [{
57960
+ "value": "created_at"
57961
+ }, {
57962
+ "value": "position"
57963
+ }]
57964
+ }
57965
+ }, {
57966
+ "name": "linter",
57967
+ "value": {
57968
+ "ignore": ["get", "sort_parameter_default", "versions"]
57969
+ }
57970
+ }]
57971
+ }, {
57972
+ "method": "POST",
57973
+ "path": "/:organization/experiences/:experience_key/price/books",
57974
+ "parameters": [{
57975
+ "name": "organization",
57976
+ "type": "string",
57977
+ "location": "Path",
57978
+ "required": true,
57979
+ "description": "Refers to your organization's account identifier"
57980
+ }, {
57981
+ "name": "experience_key",
57982
+ "type": "string",
57983
+ "location": "Path",
57984
+ "required": true
57985
+ }],
57986
+ "responses": [{
57987
+ "code": {
57988
+ "integer": {
57989
+ "value": 200
57990
+ }
57991
+ },
57992
+ "type": "experience_price_book_mapping",
57993
+ "description": "Successful response",
57994
+ "attributes": []
57995
+ }, {
57996
+ "code": {
57997
+ "integer": {
57998
+ "value": 201
57999
+ }
58000
+ },
58001
+ "type": "experience_price_book_mapping",
58002
+ "description": "Operation succeeded and the resource was created",
58003
+ "attributes": []
58004
+ }, {
58005
+ "code": {
58006
+ "integer": {
58007
+ "value": 401
58008
+ }
58009
+ },
58010
+ "type": "unit",
58011
+ "description": "Authorization failed",
58012
+ "attributes": []
58013
+ }, {
58014
+ "code": {
58015
+ "integer": {
58016
+ "value": 404
58017
+ }
58018
+ },
58019
+ "type": "unit",
58020
+ "description": "Resource was not found",
58021
+ "attributes": []
58022
+ }, {
58023
+ "code": {
58024
+ "integer": {
58025
+ "value": 422
58026
+ }
58027
+ },
58028
+ "type": "generic_error",
58029
+ "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.",
58030
+ "attributes": []
58031
+ }],
58032
+ "attributes": [],
58033
+ "body": {
58034
+ "type": "experience_price_book_mapping_form",
58035
+ "attributes": []
58036
+ }
58037
+ }, {
58038
+ "method": "PUT",
58039
+ "path": "/:organization/experiences/:experience_key/price/books",
58040
+ "parameters": [{
58041
+ "name": "organization",
58042
+ "type": "string",
58043
+ "location": "Path",
58044
+ "required": true,
58045
+ "description": "Refers to your organization's account identifier"
58046
+ }, {
58047
+ "name": "experience_key",
58048
+ "type": "string",
58049
+ "location": "Path",
58050
+ "required": true
59051
58051
  }],
59052
58052
  "responses": [{
59053
58053
  "code": {
@@ -59221,12 +58221,6 @@
59221
58221
  "type": "string",
59222
58222
  "location": "Path",
59223
58223
  "required": true
59224
- }, {
59225
- "name": "context",
59226
- "type": "string",
59227
- "location": "Query",
59228
- "required": false,
59229
- "description": "The session context"
59230
58224
  }],
59231
58225
  "responses": [{
59232
58226
  "code": {
@@ -59272,12 +58266,6 @@
59272
58266
  "type": "string",
59273
58267
  "location": "Path",
59274
58268
  "required": true
59275
- }, {
59276
- "name": "context",
59277
- "type": "string",
59278
- "location": "Query",
59279
- "required": false,
59280
- "description": "The session context"
59281
58269
  }],
59282
58270
  "responses": [{
59283
58271
  "code": {
@@ -59345,12 +58333,6 @@
59345
58333
  "type": "string",
59346
58334
  "location": "Path",
59347
58335
  "required": true
59348
- }, {
59349
- "name": "context",
59350
- "type": "string",
59351
- "location": "Query",
59352
- "required": false,
59353
- "description": "The session context"
59354
58336
  }],
59355
58337
  "responses": [{
59356
58338
  "code": {
@@ -59396,12 +58378,6 @@
59396
58378
  "type": "string",
59397
58379
  "location": "Path",
59398
58380
  "required": true
59399
- }, {
59400
- "name": "context",
59401
- "type": "string",
59402
- "location": "Query",
59403
- "required": false,
59404
- "description": "The session context"
59405
58381
  }],
59406
58382
  "responses": [{
59407
58383
  "code": {
@@ -59558,12 +58534,6 @@
59558
58534
  "location": "Query",
59559
58535
  "required": false,
59560
58536
  "description": "If specified, indicates the currency of the returned prices."
59561
- }, {
59562
- "name": "context",
59563
- "type": "string",
59564
- "location": "Query",
59565
- "required": false,
59566
- "description": "The session context"
59567
58537
  }],
59568
58538
  "responses": [{
59569
58539
  "code": {
@@ -59609,12 +58579,6 @@
59609
58579
  "type": "string",
59610
58580
  "location": "Path",
59611
58581
  "required": true
59612
- }, {
59613
- "name": "context",
59614
- "type": "string",
59615
- "location": "Query",
59616
- "required": false,
59617
- "description": "The session context"
59618
58582
  }],
59619
58583
  "responses": [{
59620
58584
  "code": {
@@ -59660,12 +58624,6 @@
59660
58624
  "type": "string",
59661
58625
  "location": "Path",
59662
58626
  "required": true
59663
- }, {
59664
- "name": "context",
59665
- "type": "string",
59666
- "location": "Query",
59667
- "required": false,
59668
- "description": "The session context"
59669
58627
  }],
59670
58628
  "responses": [{
59671
58629
  "code": {
@@ -59808,12 +58766,6 @@
59808
58766
  "type": "string",
59809
58767
  "location": "Path",
59810
58768
  "required": true
59811
- }, {
59812
- "name": "context",
59813
- "type": "string",
59814
- "location": "Query",
59815
- "required": false,
59816
- "description": "The session context"
59817
58769
  }],
59818
58770
  "responses": [{
59819
58771
  "code": {
@@ -59864,12 +58816,6 @@
59864
58816
  "type": "string",
59865
58817
  "location": "Path",
59866
58818
  "required": true
59867
- }, {
59868
- "name": "context",
59869
- "type": "string",
59870
- "location": "Query",
59871
- "required": false,
59872
- "description": "The session context"
59873
58819
  }],
59874
58820
  "responses": [{
59875
58821
  "code": {
@@ -59940,12 +58886,6 @@
59940
58886
  "type": "string",
59941
58887
  "location": "Path",
59942
58888
  "required": true
59943
- }, {
59944
- "name": "context",
59945
- "type": "string",
59946
- "location": "Query",
59947
- "required": false,
59948
- "description": "The session context"
59949
58889
  }],
59950
58890
  "responses": [{
59951
58891
  "code": {
@@ -59990,12 +58930,6 @@
59990
58930
  "type": "string",
59991
58931
  "location": "Path",
59992
58932
  "required": true
59993
- }, {
59994
- "name": "context",
59995
- "type": "string",
59996
- "location": "Query",
59997
- "required": false,
59998
- "description": "The session context"
59999
58933
  }],
60000
58934
  "responses": [{
60001
58935
  "code": {
@@ -60064,12 +58998,6 @@
60064
58998
  "type": "string",
60065
58999
  "location": "Query",
60066
59000
  "required": false
60067
- }, {
60068
- "name": "context",
60069
- "type": "string",
60070
- "location": "Query",
60071
- "required": false,
60072
- "description": "The session context"
60073
59001
  }],
60074
59002
  "responses": [{
60075
59003
  "code": {
@@ -60171,12 +59099,6 @@
60171
59099
  "type": "string",
60172
59100
  "location": "Path",
60173
59101
  "required": true
60174
- }, {
60175
- "name": "context",
60176
- "type": "string",
60177
- "location": "Query",
60178
- "required": false,
60179
- "description": "The session context"
60180
59102
  }],
60181
59103
  "responses": [{
60182
59104
  "code": {
@@ -61355,12 +60277,6 @@
61355
60277
  "description": "Fields on the order to romanize. For example, if 'destination' is passed, then destination addresses in Chinese characters will be transliterated to the romanized form in pinyin",
61356
60278
  "maximum": 100,
61357
60279
  "example": "destination"
61358
- }, {
61359
- "name": "context",
61360
- "type": "string",
61361
- "location": "Query",
61362
- "required": false,
61363
- "description": "The session context"
61364
60280
  }, {
61365
60281
  "name": "limit",
61366
60282
  "type": "long",
@@ -61491,12 +60407,6 @@
61491
60407
  "description": "Fields on the order to romanize. For example, if 'destination' is passed, then destination addresses in Chinese characters will be transliterated to the romanized form in pinyin",
61492
60408
  "maximum": 100,
61493
60409
  "example": "destination"
61494
- }, {
61495
- "name": "context",
61496
- "type": "string",
61497
- "location": "Query",
61498
- "required": false,
61499
- "description": "The session context"
61500
60410
  }],
61501
60411
  "responses": [{
61502
60412
  "code": {
@@ -61571,12 +60481,6 @@
61571
60481
  "description": "Fields on the order to romanize. For example, if 'destination' is passed, then destination addresses in Chinese characters will be transliterated to the romanized form in pinyin",
61572
60482
  "maximum": 100,
61573
60483
  "example": "destination"
61574
- }, {
61575
- "name": "context",
61576
- "type": "string",
61577
- "location": "Query",
61578
- "required": false,
61579
- "description": "The session context"
61580
60484
  }],
61581
60485
  "responses": [{
61582
60486
  "code": {
@@ -61644,12 +60548,6 @@
61644
60548
  "location": "Query",
61645
60549
  "required": false,
61646
60550
  "description": "Flag to indicate whether to only show delivery options that are selected. Only the delivery options with ids in the selections list would be shown."
61647
- }, {
61648
- "name": "context",
61649
- "type": "string",
61650
- "location": "Query",
61651
- "required": false,
61652
- "description": "The session context"
61653
60551
  }],
61654
60552
  "responses": [{
61655
60553
  "code": {
@@ -61810,12 +60708,6 @@
61810
60708
  "description": "Fields on the order to romanize. For example, if 'destination' is passed, then destination addresses in Chinese characters will be transliterated to the romanized form in pinyin",
61811
60709
  "maximum": 100,
61812
60710
  "example": "destination"
61813
- }, {
61814
- "name": "context",
61815
- "type": "string",
61816
- "location": "Query",
61817
- "required": false,
61818
- "description": "The session context"
61819
60711
  }],
61820
60712
  "responses": [{
61821
60713
  "code": {
@@ -61909,12 +60801,6 @@
61909
60801
  "description": "Fields on the order to romanize. For example, if 'destination' is passed, then destination addresses in Chinese characters will be transliterated to the romanized form in pinyin",
61910
60802
  "maximum": 100,
61911
60803
  "example": "destination"
61912
- }, {
61913
- "name": "context",
61914
- "type": "string",
61915
- "location": "Query",
61916
- "required": false,
61917
- "description": "The session context"
61918
60804
  }],
61919
60805
  "responses": [{
61920
60806
  "code": {
@@ -62126,12 +61012,6 @@
62126
61012
  "type": "string",
62127
61013
  "location": "Path",
62128
61014
  "required": true
62129
- }, {
62130
- "name": "context",
62131
- "type": "string",
62132
- "location": "Query",
62133
- "required": false,
62134
- "description": "The session context"
62135
61015
  }],
62136
61016
  "responses": [{
62137
61017
  "code": {
@@ -62181,12 +61061,6 @@
62181
61061
  "type": "string",
62182
61062
  "location": "Path",
62183
61063
  "required": true
62184
- }, {
62185
- "name": "context",
62186
- "type": "string",
62187
- "location": "Query",
62188
- "required": false,
62189
- "description": "The session context"
62190
61064
  }],
62191
61065
  "responses": [{
62192
61066
  "code": {
@@ -62254,12 +61128,6 @@
62254
61128
  "type": "string",
62255
61129
  "location": "Path",
62256
61130
  "required": true
62257
- }, {
62258
- "name": "context",
62259
- "type": "string",
62260
- "location": "Query",
62261
- "required": false,
62262
- "description": "The session context"
62263
61131
  }],
62264
61132
  "responses": [{
62265
61133
  "code": {
@@ -62393,12 +61261,6 @@
62393
61261
  "minimum": 0,
62394
61262
  "maximum": 1,
62395
61263
  "example": "order"
62396
- }, {
62397
- "name": "context",
62398
- "type": "string",
62399
- "location": "Query",
62400
- "required": false,
62401
- "description": "The session context"
62402
61264
  }],
62403
61265
  "responses": [{
62404
61266
  "code": {
@@ -62647,12 +61509,6 @@
62647
61509
  "minimum": 0,
62648
61510
  "maximum": 1,
62649
61511
  "example": "experience"
62650
- }, {
62651
- "name": "context",
62652
- "type": "string",
62653
- "location": "Query",
62654
- "required": false,
62655
- "description": "The session context"
62656
61512
  }],
62657
61513
  "responses": [{
62658
61514
  "code": {
@@ -62721,12 +61577,6 @@
62721
61577
  "type": "string",
62722
61578
  "location": "Path",
62723
61579
  "required": true
62724
- }, {
62725
- "name": "context",
62726
- "type": "string",
62727
- "location": "Query",
62728
- "required": false,
62729
- "description": "The session context"
62730
61580
  }],
62731
61581
  "responses": [{
62732
61582
  "code": {
@@ -62971,12 +61821,6 @@
62971
61821
  "minimum": 0,
62972
61822
  "maximum": 1,
62973
61823
  "example": "experience"
62974
- }, {
62975
- "name": "context",
62976
- "type": "string",
62977
- "location": "Query",
62978
- "required": false,
62979
- "description": "The session context"
62980
61824
  }],
62981
61825
  "responses": [{
62982
61826
  "code": {
@@ -63080,12 +61924,6 @@
63080
61924
  "minimum": 0,
63081
61925
  "maximum": 1,
63082
61926
  "example": "experience"
63083
- }, {
63084
- "name": "context",
63085
- "type": "string",
63086
- "location": "Query",
63087
- "required": false,
63088
- "description": "The session context"
63089
61927
  }],
63090
61928
  "responses": [{
63091
61929
  "code": {
@@ -63165,12 +62003,6 @@
63165
62003
  "description": "Fields on the order to romanize. For example, if 'destination' is passed, then destination addresses in Chinese characters will be transliterated to the romanized form in pinyin",
63166
62004
  "maximum": 100,
63167
62005
  "example": "destination"
63168
- }, {
63169
- "name": "context",
63170
- "type": "string",
63171
- "location": "Query",
63172
- "required": false,
63173
- "description": "The session context"
63174
62006
  }],
63175
62007
  "responses": [{
63176
62008
  "code": {
@@ -63256,12 +62088,6 @@
63256
62088
  "minimum": 0,
63257
62089
  "maximum": 1,
63258
62090
  "example": "experience"
63259
- }, {
63260
- "name": "context",
63261
- "type": "string",
63262
- "location": "Query",
63263
- "required": false,
63264
- "description": "The session context"
63265
62091
  }],
63266
62092
  "responses": [{
63267
62093
  "code": {
@@ -63333,12 +62159,6 @@
63333
62159
  "minimum": 0,
63334
62160
  "maximum": 1,
63335
62161
  "example": "experience"
63336
- }, {
63337
- "name": "context",
63338
- "type": "string",
63339
- "location": "Query",
63340
- "required": false,
63341
- "description": "The session context"
63342
62162
  }],
63343
62163
  "responses": [{
63344
62164
  "code": {
@@ -63401,12 +62221,6 @@
63401
62221
  "minimum": 0,
63402
62222
  "maximum": 1,
63403
62223
  "example": "experience"
63404
- }, {
63405
- "name": "context",
63406
- "type": "string",
63407
- "location": "Query",
63408
- "required": false,
63409
- "description": "The session context"
63410
62224
  }],
63411
62225
  "responses": [{
63412
62226
  "code": {
@@ -63469,12 +62283,6 @@
63469
62283
  "minimum": 0,
63470
62284
  "maximum": 1,
63471
62285
  "example": "experience"
63472
- }, {
63473
- "name": "context",
63474
- "type": "string",
63475
- "location": "Query",
63476
- "required": false,
63477
- "description": "The session context"
63478
62286
  }],
63479
62287
  "responses": [{
63480
62288
  "code": {
@@ -63537,12 +62345,6 @@
63537
62345
  "minimum": 0,
63538
62346
  "maximum": 1,
63539
62347
  "example": "experience"
63540
- }, {
63541
- "name": "context",
63542
- "type": "string",
63543
- "location": "Query",
63544
- "required": false,
63545
- "description": "The session context"
63546
62348
  }],
63547
62349
  "responses": [{
63548
62350
  "code": {
@@ -63605,12 +62407,6 @@
63605
62407
  "minimum": 0,
63606
62408
  "maximum": 1,
63607
62409
  "example": "experience"
63608
- }, {
63609
- "name": "context",
63610
- "type": "string",
63611
- "location": "Query",
63612
- "required": false,
63613
- "description": "The session context"
63614
62410
  }],
63615
62411
  "responses": [{
63616
62412
  "code": {
@@ -63673,12 +62469,6 @@
63673
62469
  "minimum": 0,
63674
62470
  "maximum": 1,
63675
62471
  "example": "experience"
63676
- }, {
63677
- "name": "context",
63678
- "type": "string",
63679
- "location": "Query",
63680
- "required": false,
63681
- "description": "The session context"
63682
62472
  }],
63683
62473
  "responses": [{
63684
62474
  "code": {
@@ -64110,12 +62900,6 @@
64110
62900
  "minimum": 0,
64111
62901
  "maximum": 1,
64112
62902
  "example": "experience"
64113
- }, {
64114
- "name": "context",
64115
- "type": "string",
64116
- "location": "Query",
64117
- "required": false,
64118
- "description": "The session context"
64119
62903
  }],
64120
62904
  "responses": [{
64121
62905
  "code": {
@@ -64178,12 +62962,6 @@
64178
62962
  "minimum": 0,
64179
62963
  "maximum": 1,
64180
62964
  "example": "experience"
64181
- }, {
64182
- "name": "context",
64183
- "type": "string",
64184
- "location": "Query",
64185
- "required": false,
64186
- "description": "The session context"
64187
62965
  }],
64188
62966
  "responses": [{
64189
62967
  "code": {
@@ -64294,12 +63072,6 @@
64294
63072
  "description": "Fields on the order to romanize. For example, if 'destination' is passed, then destination addresses in Chinese characters will be transliterated to the romanized form in pinyin",
64295
63073
  "maximum": 100,
64296
63074
  "example": "destination"
64297
- }, {
64298
- "name": "context",
64299
- "type": "string",
64300
- "location": "Query",
64301
- "required": false,
64302
- "description": "The session context"
64303
63075
  }],
64304
63076
  "responses": [{
64305
63077
  "code": {
@@ -64374,12 +63146,6 @@
64374
63146
  "description": "Fields on the order to romanize. For example, if 'destination' is passed, then destination addresses in Chinese characters will be transliterated to the romanized form in pinyin",
64375
63147
  "maximum": 100,
64376
63148
  "example": "destination"
64377
- }, {
64378
- "name": "context",
64379
- "type": "string",
64380
- "location": "Query",
64381
- "required": false,
64382
- "description": "The session context"
64383
63149
  }],
64384
63150
  "responses": [{
64385
63151
  "code": {
@@ -64472,12 +63238,6 @@
64472
63238
  "description": "Fields on the order to romanize. For example, if 'destination' is passed, then destination addresses in Chinese characters will be transliterated to the romanized form in pinyin",
64473
63239
  "maximum": 100,
64474
63240
  "example": "destination"
64475
- }, {
64476
- "name": "context",
64477
- "type": "string",
64478
- "location": "Query",
64479
- "required": false,
64480
- "description": "The session context"
64481
63241
  }],
64482
63242
  "responses": [{
64483
63243
  "code": {
@@ -65283,12 +64043,6 @@
65283
64043
  "description": "If specified, countries will be filtered from experiences with this status. If not provided, defaults to active.",
65284
64044
  "default": "[]",
65285
64045
  "maximum": 4
65286
- }, {
65287
- "name": "context",
65288
- "type": "string",
65289
- "location": "Query",
65290
- "required": false,
65291
- "description": "The session context"
65292
64046
  }],
65293
64047
  "responses": [{
65294
64048
  "code": {
@@ -66135,12 +64889,6 @@
66135
64889
  "location": "Query",
66136
64890
  "required": false,
66137
64891
  "description": "If provided, will be used to help pick the experience if the country or experience key are not provided."
66138
- }, {
66139
- "name": "context",
66140
- "type": "string",
66141
- "location": "Query",
66142
- "required": false,
66143
- "description": "The session context"
66144
64892
  }, {
66145
64893
  "name": "limit",
66146
64894
  "type": "long",
@@ -66251,12 +64999,6 @@
66251
64999
  "location": "Query",
66252
65000
  "required": false,
66253
65001
  "description": "If provided, will be used to help pick the experience if the country or experience key are not provided."
66254
- }, {
66255
- "name": "context",
66256
- "type": "string",
66257
- "location": "Query",
66258
- "required": false,
66259
- "description": "The session context"
66260
65002
  }, {
66261
65003
  "name": "limit",
66262
65004
  "type": "long",
@@ -66367,12 +65109,6 @@
66367
65109
  "description": "The number of results to skip before returning results",
66368
65110
  "default": "0",
66369
65111
  "minimum": 0
66370
- }, {
66371
- "name": "context",
66372
- "type": "string",
66373
- "location": "Query",
66374
- "required": false,
66375
- "description": "The session context"
66376
65112
  }],
66377
65113
  "responses": [{
66378
65114
  "code": {
@@ -72015,12 +70751,6 @@
72015
70751
  "location": "Query",
72016
70752
  "required": false,
72017
70753
  "example": "12"
72018
- }, {
72019
- "name": "context",
72020
- "type": "string",
72021
- "location": "Query",
72022
- "required": false,
72023
- "description": "The session context"
72024
70754
  }],
72025
70755
  "responses": [{
72026
70756
  "code": {
@@ -72097,12 +70827,6 @@
72097
70827
  "description": "The number of results to skip before returning results",
72098
70828
  "default": "0",
72099
70829
  "minimum": 0
72100
- }, {
72101
- "name": "context",
72102
- "type": "string",
72103
- "location": "Query",
72104
- "required": false,
72105
- "description": "The session context"
72106
70830
  }],
72107
70831
  "responses": [{
72108
70832
  "code": {
@@ -72967,12 +71691,6 @@
72967
71691
  "location": "Path",
72968
71692
  "required": true,
72969
71693
  "description": "Refers to your organization's account identifier"
72970
- }, {
72971
- "name": "context",
72972
- "type": "string",
72973
- "location": "Query",
72974
- "required": false,
72975
- "description": "The session context"
72976
71694
  }],
72977
71695
  "responses": [{
72978
71696
  "code": {
@@ -73446,12 +72164,6 @@
73446
72164
  "location": "Query",
73447
72165
  "required": false,
73448
72166
  "description": "The datetime on which to base an estimate"
73449
- }, {
73450
- "name": "context",
73451
- "type": "string",
73452
- "location": "Query",
73453
- "required": false,
73454
- "description": "The session context"
73455
72167
  }],
73456
72168
  "responses": [{
73457
72169
  "code": {
@@ -73515,12 +72227,6 @@
73515
72227
  "location": "Path",
73516
72228
  "required": true,
73517
72229
  "description": "Refers to your organization's account identifier"
73518
- }, {
73519
- "name": "context",
73520
- "type": "string",
73521
- "location": "Query",
73522
- "required": false,
73523
- "description": "The session context"
73524
72230
  }],
73525
72231
  "responses": [{
73526
72232
  "code": {
@@ -75706,12 +74412,6 @@
75706
74412
  "type": "boolean",
75707
74413
  "location": "Query",
75708
74414
  "required": false
75709
- }, {
75710
- "name": "context",
75711
- "type": "string",
75712
- "location": "Query",
75713
- "required": false,
75714
- "description": "The session context"
75715
74415
  }, {
75716
74416
  "name": "force_new",
75717
74417
  "type": "boolean",
@@ -75773,7 +74473,7 @@
75773
74473
  "value": 422
75774
74474
  }
75775
74475
  },
75776
- "type": "generic_error",
74476
+ "type": "shipping_label_error",
75777
74477
  "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.",
75778
74478
  "attributes": []
75779
74479
  }],
@@ -79422,110 +78122,6 @@
79422
78122
  }],
79423
78123
  "path": "/reference/regions",
79424
78124
  "description": "A region represents a geographic area of the world. Regions can be countries, continents or other political areas (like the Eurozone). See https://api.flow.io/reference/regions"
79425
- }, {
79426
- "type": "tax_duty_quote",
79427
- "plural": "tax_duty_quotes",
79428
- "operations": [{
79429
- "method": "POST",
79430
- "path": "/channel/:channel_id/organization/:organization_id/levy/quotes",
79431
- "parameters": [{
79432
- "name": "channel_id",
79433
- "type": "string",
79434
- "location": "Path",
79435
- "required": true
79436
- }, {
79437
- "name": "organization_id",
79438
- "type": "string",
79439
- "location": "Path",
79440
- "required": true
79441
- }],
79442
- "responses": [{
79443
- "code": {
79444
- "integer": {
79445
- "value": 201
79446
- }
79447
- },
79448
- "type": "tax_duty_quote",
79449
- "description": "Operation succeeded and the resource was created",
79450
- "attributes": []
79451
- }, {
79452
- "code": {
79453
- "integer": {
79454
- "value": 401
79455
- }
79456
- },
79457
- "type": "unit",
79458
- "description": "Authorization failed",
79459
- "attributes": []
79460
- }, {
79461
- "code": {
79462
- "integer": {
79463
- "value": 422
79464
- }
79465
- },
79466
- "type": "tax_duty_calculator_validation_error",
79467
- "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.",
79468
- "attributes": []
79469
- }],
79470
- "attributes": [],
79471
- "description": "Create and return a new tax duty quote.",
79472
- "body": {
79473
- "type": "tax_duty_quote_form",
79474
- "attributes": []
79475
- }
79476
- }, {
79477
- "method": "POST",
79478
- "path": "/:organization/levy/quotes",
79479
- "parameters": [{
79480
- "name": "organization",
79481
- "type": "string",
79482
- "location": "Path",
79483
- "required": true,
79484
- "description": "Refers to your organization's account identifier"
79485
- }],
79486
- "responses": [{
79487
- "code": {
79488
- "integer": {
79489
- "value": 201
79490
- }
79491
- },
79492
- "type": "tax_duty_quote",
79493
- "description": "Operation succeeded and the resource was created",
79494
- "attributes": []
79495
- }, {
79496
- "code": {
79497
- "integer": {
79498
- "value": 401
79499
- }
79500
- },
79501
- "type": "unit",
79502
- "description": "Authorization failed",
79503
- "attributes": []
79504
- }, {
79505
- "code": {
79506
- "integer": {
79507
- "value": 422
79508
- }
79509
- },
79510
- "type": "tax_duty_calculator_validation_error",
79511
- "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.",
79512
- "attributes": []
79513
- }],
79514
- "attributes": [],
79515
- "description": "Create and return a new tax duty quote.",
79516
- "body": {
79517
- "type": "tax_duty_quote_form",
79518
- "attributes": []
79519
- }
79520
- }],
79521
- "attributes": [{
79522
- "name": "docs",
79523
- "value": {
79524
- "module": "calculator"
79525
- }
79526
- }],
79527
- "path": "",
79528
- "description": "An order to have tax and duty calculated. Quote will provide all values in the local currency."
79529
78125
  }, {
79530
78126
  "type": "abandoned_order_promotion",
79531
78127
  "plural": "abandoned_order_promotions",
@@ -82814,12 +81410,6 @@
82814
81410
  "location": "Path",
82815
81411
  "required": true,
82816
81412
  "description": "Refers to your organization's account identifier"
82817
- }, {
82818
- "name": "context",
82819
- "type": "string",
82820
- "location": "Query",
82821
- "required": false,
82822
- "description": "The session context"
82823
81413
  }],
82824
81414
  "responses": [{
82825
81415
  "code": {
@@ -93992,12 +92582,6 @@
93992
92582
  "location": "Path",
93993
92583
  "required": true,
93994
92584
  "description": "Refers to your organization's account identifier"
93995
- }, {
93996
- "name": "context",
93997
- "type": "string",
93998
- "location": "Query",
93999
- "required": false,
94000
- "description": "The session context"
94001
92585
  }],
94002
92586
  "responses": [{
94003
92587
  "code": {
@@ -94072,12 +92656,6 @@
94072
92656
  "type": "string",
94073
92657
  "location": "Path",
94074
92658
  "required": true
94075
- }, {
94076
- "name": "context",
94077
- "type": "string",
94078
- "location": "Query",
94079
- "required": false,
94080
- "description": "The session context"
94081
92659
  }],
94082
92660
  "responses": [{
94083
92661
  "code": {
@@ -94215,12 +92793,6 @@
94215
92793
  "location": "Path",
94216
92794
  "required": true,
94217
92795
  "description": "Refers to your organization's account identifier"
94218
- }, {
94219
- "name": "context",
94220
- "type": "string",
94221
- "location": "Query",
94222
- "required": false,
94223
- "description": "The session context"
94224
92796
  }],
94225
92797
  "responses": [{
94226
92798
  "code": {
@@ -94260,12 +92832,6 @@
94260
92832
  "type": "string",
94261
92833
  "location": "Path",
94262
92834
  "required": true
94263
- }, {
94264
- "name": "context",
94265
- "type": "string",
94266
- "location": "Query",
94267
- "required": false,
94268
- "description": "The session context"
94269
92835
  }],
94270
92836
  "responses": [{
94271
92837
  "code": {
@@ -94674,12 +93240,6 @@
94674
93240
  "type": "string",
94675
93241
  "location": "Path",
94676
93242
  "required": true
94677
- }, {
94678
- "name": "context",
94679
- "type": "string",
94680
- "location": "Query",
94681
- "required": false,
94682
- "description": "The session context"
94683
93243
  }],
94684
93244
  "responses": [{
94685
93245
  "code": {
@@ -94711,12 +93271,6 @@
94711
93271
  "location": "Path",
94712
93272
  "required": true,
94713
93273
  "description": "Filter by one or more IDs of this resource"
94714
- }, {
94715
- "name": "context",
94716
- "type": "string",
94717
- "location": "Query",
94718
- "required": false,
94719
- "description": "The session context"
94720
93274
  }],
94721
93275
  "responses": [{
94722
93276
  "code": {
@@ -94748,12 +93302,6 @@
94748
93302
  "location": "Path",
94749
93303
  "required": true,
94750
93304
  "description": "Filter by one or more IDs of this resource"
94751
- }, {
94752
- "name": "context",
94753
- "type": "string",
94754
- "location": "Query",
94755
- "required": false,
94756
- "description": "The session context"
94757
93305
  }],
94758
93306
  "responses": [{
94759
93307
  "code": {
@@ -94785,12 +93333,6 @@
94785
93333
  "location": "Path",
94786
93334
  "required": true,
94787
93335
  "description": "Filter by one or more IDs of this resource"
94788
- }, {
94789
- "name": "context",
94790
- "type": "string",
94791
- "location": "Query",
94792
- "required": false,
94793
- "description": "The session context"
94794
93336
  }],
94795
93337
  "responses": [{
94796
93338
  "code": {
@@ -94844,12 +93386,6 @@
94844
93386
  "location": "Path",
94845
93387
  "required": true,
94846
93388
  "description": "Filter by one or more IDs of this resource"
94847
- }, {
94848
- "name": "context",
94849
- "type": "string",
94850
- "location": "Query",
94851
- "required": false,
94852
- "description": "The session context"
94853
93389
  }],
94854
93390
  "responses": [{
94855
93391
  "code": {
@@ -94903,12 +93439,6 @@
94903
93439
  "location": "Path",
94904
93440
  "required": true,
94905
93441
  "description": "Filter by one or more IDs of this resource"
94906
- }, {
94907
- "name": "context",
94908
- "type": "string",
94909
- "location": "Query",
94910
- "required": false,
94911
- "description": "The session context"
94912
93442
  }],
94913
93443
  "responses": [{
94914
93444
  "code": {
@@ -95011,12 +93541,6 @@
95011
93541
  "location": "Path",
95012
93542
  "required": true,
95013
93543
  "description": "Filter by one or more IDs of this resource"
95014
- }, {
95015
- "name": "context",
95016
- "type": "string",
95017
- "location": "Query",
95018
- "required": false,
95019
- "description": "The session context"
95020
93544
  }],
95021
93545
  "responses": [{
95022
93546
  "code": {
@@ -95078,12 +93602,6 @@
95078
93602
  "minimum": 0,
95079
93603
  "maximum": 1,
95080
93604
  "example": "experience"
95081
- }, {
95082
- "name": "context",
95083
- "type": "string",
95084
- "location": "Query",
95085
- "required": false,
95086
- "description": "The session context"
95087
93605
  }],
95088
93606
  "responses": [{
95089
93607
  "code": {
@@ -95158,12 +93676,6 @@
95158
93676
  "minimum": 0,
95159
93677
  "maximum": 1,
95160
93678
  "example": "experience"
95161
- }, {
95162
- "name": "context",
95163
- "type": "string",
95164
- "location": "Query",
95165
- "required": false,
95166
- "description": "The session context"
95167
93679
  }],
95168
93680
  "responses": [{
95169
93681
  "code": {