@flowio/api-internal-mock-generator 5.31.7 → 5.31.8

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-internal.json +247 -143
  2. package/package.json +2 -2
  3. package/src/api-internal.json +247 -143
package/dist/api-internal.json CHANGED
@@ -10,7 +10,7 @@
10
10
  "key": "api-internal"
11
11
  },
12
12
  "namespace": "io.flow.internal.v0",
13
- "version": "0.15.88",
13
+ "version": "0.15.89",
14
14
  "info": {
15
15
  "license": {
16
16
  "name": "MIT",
@@ -616,7 +616,7 @@
616
616
  "application": {
617
617
  "key": "pricing-indicator-internal-event"
618
618
  },
619
- "version": "0.15.88",
619
+ "version": "0.15.89",
620
620
  "enums": ["pricing_indicator_status", "service_name"],
621
621
  "interfaces": [],
622
622
  "unions": ["pricing_indicator_event"],
@@ -4604,23 +4604,6 @@
4604
4604
  }],
4605
4605
  "attributes": [],
4606
4606
  "description": "Whether a processor account or merchant is active and able to receive traffic."
4607
- }, {
4608
- "name": "product_restriction_status",
4609
- "plural": "product_restriction_statuses",
4610
- "values": [{
4611
- "name": "pending",
4612
- "attributes": []
4613
- }, {
4614
- "name": "in_review",
4615
- "attributes": []
4616
- }, {
4617
- "name": "accepted",
4618
- "attributes": []
4619
- }, {
4620
- "name": "restricted",
4621
- "attributes": []
4622
- }],
4623
- "attributes": []
4624
4607
  }, {
4625
4608
  "name": "prompt_action",
4626
4609
  "plural": "prompt_actions",
@@ -4810,6 +4793,23 @@
4810
4793
  "description": "A product may be rejected due to a rule."
4811
4794
  }],
4812
4795
  "attributes": []
4796
+ }, {
4797
+ "name": "restriction_status",
4798
+ "plural": "restriction_statuses",
4799
+ "values": [{
4800
+ "name": "pending",
4801
+ "attributes": []
4802
+ }, {
4803
+ "name": "in_review",
4804
+ "attributes": []
4805
+ }, {
4806
+ "name": "accepted",
4807
+ "attributes": []
4808
+ }, {
4809
+ "name": "restricted",
4810
+ "attributes": []
4811
+ }],
4812
+ "attributes": []
4813
4813
  }, {
4814
4814
  "name": "risk_check",
4815
4815
  "plural": "risk_checks",
@@ -11331,26 +11331,45 @@
11331
11331
  "attributes": [],
11332
11332
  "annotations": [],
11333
11333
  "description": "If specified and true, we withhold freight based on the estimated cost of each label used. Otherwise we withhold freight based on the order.",
11334
- "default": "false",
11335
- "minimum": 0
11334
+ "default": "false"
11336
11335
  }, {
11337
11336
  "name": "transaction_posting_method",
11338
11337
  "type": "transaction_posting_method",
11339
- "required": false,
11338
+ "required": true,
11340
11339
  "attributes": [],
11341
- "annotations": []
11340
+ "annotations": [],
11341
+ "default": "time"
11342
11342
  }, {
11343
11343
  "name": "statement_transfer_transaction_location",
11344
11344
  "type": "statement_transfer_transaction_location",
11345
- "required": false,
11345
+ "required": true,
11346
11346
  "attributes": [],
11347
- "annotations": []
11347
+ "annotations": [],
11348
+ "default": "transactions_file"
11348
11349
  }, {
11349
11350
  "name": "fees_source",
11350
11351
  "type": "fees_source",
11351
- "required": false,
11352
+ "required": true,
11352
11353
  "attributes": [],
11353
- "annotations": []
11354
+ "annotations": [],
11355
+ "description": "Determines what the source of fees is for each transaction. Values are 'settings' (which mean the fees come from these settings) or 'authorization_bundle' (take the fees from the billing object in the related 'authorization_bundle')",
11356
+ "default": "settings"
11357
+ }, {
11358
+ "name": "require_payment_request",
11359
+ "type": "boolean",
11360
+ "required": true,
11361
+ "attributes": [],
11362
+ "annotations": [],
11363
+ "description": "If true, we require a payment request before creating a processing transaction. This payment request will then be written into the processing_transactions table. When enabled, we wait for the payment request id to come from the authorization_bundle from payment service",
11364
+ "default": "false"
11365
+ }, {
11366
+ "name": "round_individual_transactions",
11367
+ "type": "boolean",
11368
+ "required": true,
11369
+ "attributes": [],
11370
+ "annotations": [],
11371
+ "description": "If true, we will round each individual transaction for this account to currency precision. We added this feature to support Shopify that required transactions in cents - and thus needed rounding to ensure accuracy between the two systems. Otherwise our preference is to NOT round individual transactions - we just round the final transfers we make to organizations",
11372
+ "default": "false"
11354
11373
  }],
11355
11374
  "attributes": [],
11356
11375
  "interfaces": []
@@ -46013,7 +46032,10 @@
46013
46032
  "minimum": 0
46014
46033
  }],
46015
46034
  "attributes": [],
46016
- "interfaces": []
46035
+ "interfaces": [],
46036
+ "deprecation": {
46037
+ "description": "To be removed"
46038
+ }
46017
46039
  }, {
46018
46040
  "name": "product_restriction_decision",
46019
46041
  "plural": "product_restriction_decisions",
@@ -46025,7 +46047,7 @@
46025
46047
  "annotations": []
46026
46048
  }, {
46027
46049
  "name": "status",
46028
- "type": "product_restriction_status",
46050
+ "type": "restriction_status",
46029
46051
  "required": true,
46030
46052
  "attributes": [],
46031
46053
  "annotations": []
@@ -47698,13 +47720,19 @@
47698
47720
  "required": true,
47699
47721
  "attributes": [],
47700
47722
  "annotations": [],
47701
- "description": "The product ID"
47723
+ "description": "Globally unique identifier"
47702
47724
  }, {
47703
47725
  "name": "organization_id",
47704
47726
  "type": "string",
47705
47727
  "required": true,
47706
47728
  "attributes": [],
47707
47729
  "annotations": []
47730
+ }, {
47731
+ "name": "product_id",
47732
+ "type": "string",
47733
+ "required": true,
47734
+ "attributes": [],
47735
+ "annotations": []
47708
47736
  }, {
47709
47737
  "name": "name",
47710
47738
  "type": "string",
@@ -47713,38 +47741,82 @@
47713
47741
  "annotations": [],
47714
47742
  "description": "The product name"
47715
47743
  }, {
47716
- "name": "thumbnail",
47717
- "type": "io.flow.catalog.v0.models.image",
47744
+ "name": "images",
47745
+ "type": "[io.flow.catalog.v0.models.image]",
47718
47746
  "required": true,
47719
47747
  "attributes": [],
47720
- "annotations": []
47748
+ "annotations": [],
47749
+ "default": "[]"
47721
47750
  }, {
47722
- "name": "keywords",
47723
- "type": "restriction_keywords",
47751
+ "name": "thumbnails",
47752
+ "type": "[io.flow.catalog.v0.models.image]",
47724
47753
  "required": true,
47725
47754
  "attributes": [],
47726
47755
  "annotations": [],
47727
- "description": "Matching positive and negative keywords matching a rule"
47756
+ "default": "[]"
47757
+ }, {
47758
+ "name": "review",
47759
+ "type": "restriction_item_review",
47760
+ "required": true,
47761
+ "attributes": [],
47762
+ "annotations": []
47728
47763
  }, {
47764
+ "name": "updated_at",
47765
+ "type": "date-time-iso8601",
47766
+ "required": true,
47767
+ "attributes": [],
47768
+ "annotations": [],
47769
+ "description": "Date the product was last updated in the catalog"
47770
+ }],
47771
+ "attributes": [],
47772
+ "interfaces": []
47773
+ }, {
47774
+ "name": "restriction_item_review",
47775
+ "plural": "restriction_item_reviews",
47776
+ "fields": [{
47729
47777
  "name": "rule",
47730
47778
  "type": "restriction_rule_summary",
47731
47779
  "required": true,
47732
47780
  "attributes": [],
47733
- "annotations": [],
47734
- "description": "The restriction rule applied to this product item"
47781
+ "annotations": []
47735
47782
  }, {
47736
47783
  "name": "status",
47737
- "type": "product_restriction_status",
47784
+ "type": "restriction_status",
47738
47785
  "required": true,
47739
47786
  "attributes": [],
47740
47787
  "annotations": []
47741
47788
  }, {
47742
- "name": "updated_at",
47743
- "type": "date-time-iso8601",
47789
+ "name": "keywords",
47790
+ "type": "restriction_keywords",
47744
47791
  "required": true,
47745
47792
  "attributes": [],
47746
47793
  "annotations": [],
47747
- "description": "Date the product was last updated in the catalog"
47794
+ "description": "Matching positive and negative keywords matching a rule"
47795
+ }, {
47796
+ "name": "date",
47797
+ "type": "date-time-iso8601",
47798
+ "required": false,
47799
+ "attributes": [],
47800
+ "annotations": [],
47801
+ "description": "Date of review"
47802
+ }],
47803
+ "attributes": [],
47804
+ "interfaces": []
47805
+ }, {
47806
+ "name": "restriction_item_review_decision_form",
47807
+ "plural": "restriction_item_review_decision_forms",
47808
+ "fields": [{
47809
+ "name": "restriction_item_id",
47810
+ "type": "string",
47811
+ "required": true,
47812
+ "attributes": [],
47813
+ "annotations": []
47814
+ }, {
47815
+ "name": "decision",
47816
+ "type": "restriction_decision",
47817
+ "required": true,
47818
+ "attributes": [],
47819
+ "annotations": []
47748
47820
  }],
47749
47821
  "attributes": [],
47750
47822
  "interfaces": []
@@ -47757,14 +47829,16 @@
47757
47829
  "required": true,
47758
47830
  "attributes": [],
47759
47831
  "annotations": [],
47760
- "description": "Matching positive keywords"
47832
+ "description": "Matching positive keywords",
47833
+ "default": "[]"
47761
47834
  }, {
47762
47835
  "name": "negative_keywords",
47763
47836
  "type": "[string]",
47764
47837
  "required": true,
47765
47838
  "attributes": [],
47766
47839
  "annotations": [],
47767
- "description": "Matching negative keywords indicating possible false positives"
47840
+ "description": "Matching negative keywords indicating possible false positives",
47841
+ "default": "[]"
47768
47842
  }],
47769
47843
  "attributes": [],
47770
47844
  "interfaces": []
@@ -47790,14 +47864,13 @@
47790
47864
  "name": "restriction_product",
47791
47865
  "plural": "restriction_products",
47792
47866
  "fields": [{
47793
- "name": "id",
47867
+ "name": "organization_id",
47794
47868
  "type": "string",
47795
47869
  "required": true,
47796
47870
  "attributes": [],
47797
- "annotations": [],
47798
- "description": "The product ID"
47871
+ "annotations": []
47799
47872
  }, {
47800
- "name": "organization_id",
47873
+ "name": "product_id",
47801
47874
  "type": "string",
47802
47875
  "required": true,
47803
47876
  "attributes": [],
@@ -47817,22 +47890,22 @@
47817
47890
  "annotations": [],
47818
47891
  "description": "The complete raw product description including formatting tags"
47819
47892
  }, {
47820
- "name": "images",
47821
- "type": "[io.flow.catalog.v0.models.image]",
47893
+ "name": "categories",
47894
+ "type": "[string]",
47822
47895
  "required": true,
47823
47896
  "attributes": [],
47824
47897
  "annotations": [],
47825
47898
  "default": "[]"
47826
47899
  }, {
47827
- "name": "thumbnails",
47900
+ "name": "images",
47828
47901
  "type": "[io.flow.catalog.v0.models.image]",
47829
47902
  "required": true,
47830
47903
  "attributes": [],
47831
47904
  "annotations": [],
47832
47905
  "default": "[]"
47833
47906
  }, {
47834
- "name": "categories",
47835
- "type": "[string]",
47907
+ "name": "thumbnails",
47908
+ "type": "[io.flow.catalog.v0.models.image]",
47836
47909
  "required": true,
47837
47910
  "attributes": [],
47838
47911
  "annotations": [],
@@ -47846,45 +47919,16 @@
47846
47919
  "description": "Date the product was last updated in the catalog"
47847
47920
  }, {
47848
47921
  "name": "restrictions",
47849
- "type": "[restriction_review]",
47922
+ "type": "[restriction_item_review]",
47850
47923
  "required": true,
47851
47924
  "attributes": [],
47852
47925
  "annotations": []
47853
47926
  }],
47854
47927
  "attributes": [],
47855
- "interfaces": []
47856
- }, {
47857
- "name": "restriction_review",
47858
- "plural": "restriction_reviews",
47859
- "fields": [{
47860
- "name": "rule",
47861
- "type": "restriction_rule_summary",
47862
- "required": true,
47863
- "attributes": [],
47864
- "annotations": []
47865
- }, {
47866
- "name": "status",
47867
- "type": "product_restriction_status",
47868
- "required": true,
47869
- "attributes": [],
47870
- "annotations": []
47871
- }, {
47872
- "name": "keywords",
47873
- "type": "restriction_keywords",
47874
- "required": true,
47875
- "attributes": [],
47876
- "annotations": [],
47877
- "description": "Matching positive and negative keywords matching a rule"
47878
- }, {
47879
- "name": "date",
47880
- "type": "date-time-iso8601",
47881
- "required": false,
47882
- "attributes": [],
47883
- "annotations": [],
47884
- "description": "Date of review"
47885
- }],
47886
- "attributes": [],
47887
- "interfaces": []
47928
+ "interfaces": [],
47929
+ "deprecation": {
47930
+ "description": "To be removed"
47931
+ }
47888
47932
  }, {
47889
47933
  "name": "restriction_rule",
47890
47934
  "plural": "restriction_rules",
@@ -80641,7 +80685,7 @@
80641
80685
  }],
80642
80686
  "description": "Returns the list of product restrictions",
80643
80687
  "deprecation": {
80644
- "description": "to be replaced by new UI resources"
80688
+ "description": "To be removed"
80645
80689
  }
80646
80690
  }, {
80647
80691
  "method": "POST",
@@ -80719,7 +80763,10 @@
80719
80763
  "attributes": []
80720
80764
  }],
80721
80765
  "attributes": [],
80722
- "description": "Returns a restriction by product id"
80766
+ "description": "Returns a restriction by product id",
80767
+ "deprecation": {
80768
+ "description": "To be removed"
80769
+ }
80723
80770
  }, {
80724
80771
  "method": "PUT",
80725
80772
  "path": "/internal/product/restrictions/:product_id",
@@ -81311,16 +81358,9 @@
81311
81358
  "location": "Path",
81312
81359
  "required": true,
81313
81360
  "description": "Refers to your organization's account identifier"
81314
- }, {
81315
- "name": "id",
81316
- "type": "[string]",
81317
- "location": "Query",
81318
- "required": false,
81319
- "description": "Filter by one or more IDs of this resource",
81320
- "maximum": 100
81321
81361
  }, {
81322
81362
  "name": "status",
81323
- "type": "product_restriction_status",
81363
+ "type": "restriction_status",
81324
81364
  "location": "Query",
81325
81365
  "required": true,
81326
81366
  "default": "in_review"
@@ -81347,12 +81387,6 @@
81347
81387
  "description": "The number of results to skip before returning results",
81348
81388
  "default": "0",
81349
81389
  "minimum": 0
81350
- }, {
81351
- "name": "sort",
81352
- "type": "string",
81353
- "location": "Query",
81354
- "required": true,
81355
- "default": "name"
81356
81390
  }],
81357
81391
  "responses": [{
81358
81392
  "code": {
@@ -81383,18 +81417,56 @@
81383
81417
  "attributes": []
81384
81418
  }],
81385
81419
  "attributes": [{
81386
- "name": "sort",
81420
+ "name": "linter",
81387
81421
  "value": {
81388
- "values": [{
81389
- "value": "organization_id"
81390
- }, {
81391
- "value": "name"
81392
- }, {
81393
- "value": "updated_at"
81394
- }]
81422
+ "ignore": ["get", "id", "sort"]
81395
81423
  }
81396
81424
  }],
81397
81425
  "description": "Returns a list of product items for an organization"
81426
+ }, {
81427
+ "method": "POST",
81428
+ "path": "/internal/restriction/:organization/items",
81429
+ "parameters": [{
81430
+ "name": "organization",
81431
+ "type": "string",
81432
+ "location": "Path",
81433
+ "required": true,
81434
+ "description": "Refers to your organization's account identifier"
81435
+ }],
81436
+ "responses": [{
81437
+ "code": {
81438
+ "integer": {
81439
+ "value": 201
81440
+ }
81441
+ },
81442
+ "type": "restriction_item",
81443
+ "description": "Operation succeeded and the resource was created",
81444
+ "attributes": []
81445
+ }, {
81446
+ "code": {
81447
+ "integer": {
81448
+ "value": 401
81449
+ }
81450
+ },
81451
+ "type": "unit",
81452
+ "description": "Authorization failed",
81453
+ "attributes": []
81454
+ }, {
81455
+ "code": {
81456
+ "integer": {
81457
+ "value": 422
81458
+ }
81459
+ },
81460
+ "type": "io.flow.error.v0.models.generic_error",
81461
+ "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.",
81462
+ "attributes": []
81463
+ }],
81464
+ "attributes": [],
81465
+ "description": "Set the restriction decision for a product item",
81466
+ "body": {
81467
+ "type": "restriction_item_review_decision_form",
81468
+ "attributes": []
81469
+ }
81398
81470
  }, {
81399
81471
  "method": "GET",
81400
81472
  "path": "/internal/restriction/:organization/items/rules",
@@ -81472,6 +81544,52 @@
81472
81544
  }
81473
81545
  }],
81474
81546
  "description": "Returns the list of restriction rules currently applicable for an organizations products in review"
81547
+ }, {
81548
+ "method": "GET",
81549
+ "path": "/internal/restriction/:organization/items/:id",
81550
+ "parameters": [{
81551
+ "name": "organization",
81552
+ "type": "string",
81553
+ "location": "Path",
81554
+ "required": true,
81555
+ "description": "Refers to your organization's account identifier"
81556
+ }, {
81557
+ "name": "id",
81558
+ "type": "string",
81559
+ "location": "Path",
81560
+ "required": true,
81561
+ "description": "Filter by one or more IDs of this resource"
81562
+ }],
81563
+ "responses": [{
81564
+ "code": {
81565
+ "integer": {
81566
+ "value": 200
81567
+ }
81568
+ },
81569
+ "type": "restriction_item",
81570
+ "description": "Successful response",
81571
+ "attributes": []
81572
+ }, {
81573
+ "code": {
81574
+ "integer": {
81575
+ "value": 401
81576
+ }
81577
+ },
81578
+ "type": "unit",
81579
+ "description": "Authorization failed",
81580
+ "attributes": []
81581
+ }, {
81582
+ "code": {
81583
+ "integer": {
81584
+ "value": 404
81585
+ }
81586
+ },
81587
+ "type": "unit",
81588
+ "description": "Resource was not found",
81589
+ "attributes": []
81590
+ }],
81591
+ "attributes": [],
81592
+ "description": "Returns a restriction product item by id"
81475
81593
  }],
81476
81594
  "attributes": [{
81477
81595
  "name": "docs",
@@ -81487,28 +81605,21 @@
81487
81605
  "method": "GET",
81488
81606
  "path": "/internal/restriction/products",
81489
81607
  "parameters": [{
81490
- "name": "id",
81491
- "type": "[string]",
81492
- "location": "Query",
81493
- "required": false,
81494
- "description": "Filter by one or more IDs of this resource",
81495
- "maximum": 100
81496
- }, {
81497
81608
  "name": "organization_id",
81498
81609
  "type": "string",
81499
81610
  "location": "Query",
81500
81611
  "required": false
81612
+ }, {
81613
+ "name": "status",
81614
+ "type": "restriction_status",
81615
+ "location": "Query",
81616
+ "required": false
81501
81617
  }, {
81502
81618
  "name": "rule_ids",
81503
81619
  "type": "[string]",
81504
81620
  "location": "Query",
81505
81621
  "required": false,
81506
81622
  "maximum": 100
81507
- }, {
81508
- "name": "status",
81509
- "type": "product_restriction_status",
81510
- "location": "Query",
81511
- "required": false
81512
81623
  }, {
81513
81624
  "name": "limit",
81514
81625
  "type": "long",
@@ -81526,12 +81637,6 @@
81526
81637
  "description": "The number of results to skip before returning results",
81527
81638
  "default": "0",
81528
81639
  "minimum": 0
81529
- }, {
81530
- "name": "sort",
81531
- "type": "string",
81532
- "location": "Query",
81533
- "required": true,
81534
- "default": "name"
81535
81640
  }],
81536
81641
  "responses": [{
81537
81642
  "code": {
@@ -81562,27 +81667,23 @@
81562
81667
  "attributes": []
81563
81668
  }],
81564
81669
  "attributes": [{
81565
- "name": "sort",
81670
+ "name": "linter",
81566
81671
  "value": {
81567
- "values": [{
81568
- "value": "organization_id"
81569
- }, {
81570
- "value": "updated_at"
81571
- }, {
81572
- "value": "name"
81573
- }]
81672
+ "ignore": ["get", "id", "sort"]
81574
81673
  }
81575
81674
  }],
81576
- "description": "Returns a list of products for an organization"
81675
+ "description": "Returns a list of products for an organization",
81676
+ "deprecation": {
81677
+ "description": "To be removed"
81678
+ }
81577
81679
  }, {
81578
81680
  "method": "GET",
81579
- "path": "/internal/restriction/products/:id",
81681
+ "path": "/internal/restriction/products/:product_id",
81580
81682
  "parameters": [{
81581
- "name": "id",
81683
+ "name": "product_id",
81582
81684
  "type": "string",
81583
81685
  "location": "Path",
81584
- "required": true,
81585
- "description": "Filter by one or more IDs of this resource"
81686
+ "required": true
81586
81687
  }],
81587
81688
  "responses": [{
81588
81689
  "code": {
@@ -81613,7 +81714,10 @@
81613
81714
  "attributes": []
81614
81715
  }],
81615
81716
  "attributes": [],
81616
- "description": "Returns a restriction product by product id"
81717
+ "description": "Returns a restriction product by product id",
81718
+ "deprecation": {
81719
+ "description": "To be removed"
81720
+ }
81617
81721
  }],
81618
81722
  "attributes": [{
81619
81723
  "name": "docs",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@flowio/api-internal-mock-generator",
3
- "version": "5.31.7",
3
+ "version": "5.31.8",
4
4
  "description": "A mock data generator based on our internal API specifications for JavaScript",
5
5
  "keywords": [
6
6
  "flowcommerce",
@@ -29,5 +29,5 @@
29
29
  "apibuilder-js": "0.0.13",
30
30
  "apibuilder-mock-generator": "0.0.13"
31
31
  },
32
- "gitHead": "08dbb863b30de4a9e729a484030de6d634c196cf"
32
+ "gitHead": "4d9a6eed8c7fdc587e0035ed1e48d14ee5f22e88"
33
33
  }
package/src/api-internal.json CHANGED
@@ -10,7 +10,7 @@
10
10
  "key" : "api-internal"
11
11
  },
12
12
  "namespace" : "io.flow.internal.v0",
13
- "version" : "0.15.88",
13
+ "version" : "0.15.89",
14
14
  "info" : {
15
15
  "license" : {
16
16
  "name" : "MIT",
@@ -616,7 +616,7 @@
616
616
  "application" : {
617
617
  "key" : "pricing-indicator-internal-event"
618
618
  },
619
- "version" : "0.15.88",
619
+ "version" : "0.15.89",
620
620
  "enums" : [ "pricing_indicator_status", "service_name" ],
621
621
  "interfaces" : [ ],
622
622
  "unions" : [ "pricing_indicator_event" ],
@@ -4604,23 +4604,6 @@
4604
4604
  } ],
4605
4605
  "attributes" : [ ],
4606
4606
  "description" : "Whether a processor account or merchant is active and able to receive traffic."
4607
- }, {
4608
- "name" : "product_restriction_status",
4609
- "plural" : "product_restriction_statuses",
4610
- "values" : [ {
4611
- "name" : "pending",
4612
- "attributes" : [ ]
4613
- }, {
4614
- "name" : "in_review",
4615
- "attributes" : [ ]
4616
- }, {
4617
- "name" : "accepted",
4618
- "attributes" : [ ]
4619
- }, {
4620
- "name" : "restricted",
4621
- "attributes" : [ ]
4622
- } ],
4623
- "attributes" : [ ]
4624
4607
  }, {
4625
4608
  "name" : "prompt_action",
4626
4609
  "plural" : "prompt_actions",
@@ -4810,6 +4793,23 @@
4810
4793
  "description" : "A product may be rejected due to a rule."
4811
4794
  } ],
4812
4795
  "attributes" : [ ]
4796
+ }, {
4797
+ "name" : "restriction_status",
4798
+ "plural" : "restriction_statuses",
4799
+ "values" : [ {
4800
+ "name" : "pending",
4801
+ "attributes" : [ ]
4802
+ }, {
4803
+ "name" : "in_review",
4804
+ "attributes" : [ ]
4805
+ }, {
4806
+ "name" : "accepted",
4807
+ "attributes" : [ ]
4808
+ }, {
4809
+ "name" : "restricted",
4810
+ "attributes" : [ ]
4811
+ } ],
4812
+ "attributes" : [ ]
4813
4813
  }, {
4814
4814
  "name" : "risk_check",
4815
4815
  "plural" : "risk_checks",
@@ -11331,26 +11331,45 @@
11331
11331
  "attributes" : [ ],
11332
11332
  "annotations" : [ ],
11333
11333
  "description" : "If specified and true, we withhold freight based on the estimated cost of each label used. Otherwise we withhold freight based on the order.",
11334
- "default" : "false",
11335
- "minimum" : 0
11334
+ "default" : "false"
11336
11335
  }, {
11337
11336
  "name" : "transaction_posting_method",
11338
11337
  "type" : "transaction_posting_method",
11339
- "required" : false,
11338
+ "required" : true,
11340
11339
  "attributes" : [ ],
11341
- "annotations" : [ ]
11340
+ "annotations" : [ ],
11341
+ "default" : "time"
11342
11342
  }, {
11343
11343
  "name" : "statement_transfer_transaction_location",
11344
11344
  "type" : "statement_transfer_transaction_location",
11345
- "required" : false,
11345
+ "required" : true,
11346
11346
  "attributes" : [ ],
11347
- "annotations" : [ ]
11347
+ "annotations" : [ ],
11348
+ "default" : "transactions_file"
11348
11349
  }, {
11349
11350
  "name" : "fees_source",
11350
11351
  "type" : "fees_source",
11351
- "required" : false,
11352
+ "required" : true,
11352
11353
  "attributes" : [ ],
11353
- "annotations" : [ ]
11354
+ "annotations" : [ ],
11355
+ "description" : "Determines what the source of fees is for each transaction. Values are 'settings' (which mean the fees come from these settings) or 'authorization_bundle' (take the fees from the billing object in the related 'authorization_bundle')",
11356
+ "default" : "settings"
11357
+ }, {
11358
+ "name" : "require_payment_request",
11359
+ "type" : "boolean",
11360
+ "required" : true,
11361
+ "attributes" : [ ],
11362
+ "annotations" : [ ],
11363
+ "description" : "If true, we require a payment request before creating a processing transaction. This payment request will then be written into the processing_transactions table. When enabled, we wait for the payment request id to come from the authorization_bundle from payment service",
11364
+ "default" : "false"
11365
+ }, {
11366
+ "name" : "round_individual_transactions",
11367
+ "type" : "boolean",
11368
+ "required" : true,
11369
+ "attributes" : [ ],
11370
+ "annotations" : [ ],
11371
+ "description" : "If true, we will round each individual transaction for this account to currency precision. We added this feature to support Shopify that required transactions in cents - and thus needed rounding to ensure accuracy between the two systems. Otherwise our preference is to NOT round individual transactions - we just round the final transfers we make to organizations",
11372
+ "default" : "false"
11354
11373
  } ],
11355
11374
  "attributes" : [ ],
11356
11375
  "interfaces" : [ ]
@@ -46013,7 +46032,10 @@
46013
46032
  "minimum" : 0
46014
46033
  } ],
46015
46034
  "attributes" : [ ],
46016
- "interfaces" : [ ]
46035
+ "interfaces" : [ ],
46036
+ "deprecation" : {
46037
+ "description" : "To be removed"
46038
+ }
46017
46039
  }, {
46018
46040
  "name" : "product_restriction_decision",
46019
46041
  "plural" : "product_restriction_decisions",
@@ -46025,7 +46047,7 @@
46025
46047
  "annotations" : [ ]
46026
46048
  }, {
46027
46049
  "name" : "status",
46028
- "type" : "product_restriction_status",
46050
+ "type" : "restriction_status",
46029
46051
  "required" : true,
46030
46052
  "attributes" : [ ],
46031
46053
  "annotations" : [ ]
@@ -47698,13 +47720,19 @@
47698
47720
  "required" : true,
47699
47721
  "attributes" : [ ],
47700
47722
  "annotations" : [ ],
47701
- "description" : "The product ID"
47723
+ "description" : "Globally unique identifier"
47702
47724
  }, {
47703
47725
  "name" : "organization_id",
47704
47726
  "type" : "string",
47705
47727
  "required" : true,
47706
47728
  "attributes" : [ ],
47707
47729
  "annotations" : [ ]
47730
+ }, {
47731
+ "name" : "product_id",
47732
+ "type" : "string",
47733
+ "required" : true,
47734
+ "attributes" : [ ],
47735
+ "annotations" : [ ]
47708
47736
  }, {
47709
47737
  "name" : "name",
47710
47738
  "type" : "string",
@@ -47713,38 +47741,82 @@
47713
47741
  "annotations" : [ ],
47714
47742
  "description" : "The product name"
47715
47743
  }, {
47716
- "name" : "thumbnail",
47717
- "type" : "io.flow.catalog.v0.models.image",
47744
+ "name" : "images",
47745
+ "type" : "[io.flow.catalog.v0.models.image]",
47718
47746
  "required" : true,
47719
47747
  "attributes" : [ ],
47720
- "annotations" : [ ]
47748
+ "annotations" : [ ],
47749
+ "default" : "[]"
47721
47750
  }, {
47722
- "name" : "keywords",
47723
- "type" : "restriction_keywords",
47751
+ "name" : "thumbnails",
47752
+ "type" : "[io.flow.catalog.v0.models.image]",
47724
47753
  "required" : true,
47725
47754
  "attributes" : [ ],
47726
47755
  "annotations" : [ ],
47727
- "description" : "Matching positive and negative keywords matching a rule"
47756
+ "default" : "[]"
47757
+ }, {
47758
+ "name" : "review",
47759
+ "type" : "restriction_item_review",
47760
+ "required" : true,
47761
+ "attributes" : [ ],
47762
+ "annotations" : [ ]
47728
47763
  }, {
47764
+ "name" : "updated_at",
47765
+ "type" : "date-time-iso8601",
47766
+ "required" : true,
47767
+ "attributes" : [ ],
47768
+ "annotations" : [ ],
47769
+ "description" : "Date the product was last updated in the catalog"
47770
+ } ],
47771
+ "attributes" : [ ],
47772
+ "interfaces" : [ ]
47773
+ }, {
47774
+ "name" : "restriction_item_review",
47775
+ "plural" : "restriction_item_reviews",
47776
+ "fields" : [ {
47729
47777
  "name" : "rule",
47730
47778
  "type" : "restriction_rule_summary",
47731
47779
  "required" : true,
47732
47780
  "attributes" : [ ],
47733
- "annotations" : [ ],
47734
- "description" : "The restriction rule applied to this product item"
47781
+ "annotations" : [ ]
47735
47782
  }, {
47736
47783
  "name" : "status",
47737
- "type" : "product_restriction_status",
47784
+ "type" : "restriction_status",
47738
47785
  "required" : true,
47739
47786
  "attributes" : [ ],
47740
47787
  "annotations" : [ ]
47741
47788
  }, {
47742
- "name" : "updated_at",
47743
- "type" : "date-time-iso8601",
47789
+ "name" : "keywords",
47790
+ "type" : "restriction_keywords",
47744
47791
  "required" : true,
47745
47792
  "attributes" : [ ],
47746
47793
  "annotations" : [ ],
47747
- "description" : "Date the product was last updated in the catalog"
47794
+ "description" : "Matching positive and negative keywords matching a rule"
47795
+ }, {
47796
+ "name" : "date",
47797
+ "type" : "date-time-iso8601",
47798
+ "required" : false,
47799
+ "attributes" : [ ],
47800
+ "annotations" : [ ],
47801
+ "description" : "Date of review"
47802
+ } ],
47803
+ "attributes" : [ ],
47804
+ "interfaces" : [ ]
47805
+ }, {
47806
+ "name" : "restriction_item_review_decision_form",
47807
+ "plural" : "restriction_item_review_decision_forms",
47808
+ "fields" : [ {
47809
+ "name" : "restriction_item_id",
47810
+ "type" : "string",
47811
+ "required" : true,
47812
+ "attributes" : [ ],
47813
+ "annotations" : [ ]
47814
+ }, {
47815
+ "name" : "decision",
47816
+ "type" : "restriction_decision",
47817
+ "required" : true,
47818
+ "attributes" : [ ],
47819
+ "annotations" : [ ]
47748
47820
  } ],
47749
47821
  "attributes" : [ ],
47750
47822
  "interfaces" : [ ]
@@ -47757,14 +47829,16 @@
47757
47829
  "required" : true,
47758
47830
  "attributes" : [ ],
47759
47831
  "annotations" : [ ],
47760
- "description" : "Matching positive keywords"
47832
+ "description" : "Matching positive keywords",
47833
+ "default" : "[]"
47761
47834
  }, {
47762
47835
  "name" : "negative_keywords",
47763
47836
  "type" : "[string]",
47764
47837
  "required" : true,
47765
47838
  "attributes" : [ ],
47766
47839
  "annotations" : [ ],
47767
- "description" : "Matching negative keywords indicating possible false positives"
47840
+ "description" : "Matching negative keywords indicating possible false positives",
47841
+ "default" : "[]"
47768
47842
  } ],
47769
47843
  "attributes" : [ ],
47770
47844
  "interfaces" : [ ]
@@ -47790,14 +47864,13 @@
47790
47864
  "name" : "restriction_product",
47791
47865
  "plural" : "restriction_products",
47792
47866
  "fields" : [ {
47793
- "name" : "id",
47867
+ "name" : "organization_id",
47794
47868
  "type" : "string",
47795
47869
  "required" : true,
47796
47870
  "attributes" : [ ],
47797
- "annotations" : [ ],
47798
- "description" : "The product ID"
47871
+ "annotations" : [ ]
47799
47872
  }, {
47800
- "name" : "organization_id",
47873
+ "name" : "product_id",
47801
47874
  "type" : "string",
47802
47875
  "required" : true,
47803
47876
  "attributes" : [ ],
@@ -47817,22 +47890,22 @@
47817
47890
  "annotations" : [ ],
47818
47891
  "description" : "The complete raw product description including formatting tags"
47819
47892
  }, {
47820
- "name" : "images",
47821
- "type" : "[io.flow.catalog.v0.models.image]",
47893
+ "name" : "categories",
47894
+ "type" : "[string]",
47822
47895
  "required" : true,
47823
47896
  "attributes" : [ ],
47824
47897
  "annotations" : [ ],
47825
47898
  "default" : "[]"
47826
47899
  }, {
47827
- "name" : "thumbnails",
47900
+ "name" : "images",
47828
47901
  "type" : "[io.flow.catalog.v0.models.image]",
47829
47902
  "required" : true,
47830
47903
  "attributes" : [ ],
47831
47904
  "annotations" : [ ],
47832
47905
  "default" : "[]"
47833
47906
  }, {
47834
- "name" : "categories",
47835
- "type" : "[string]",
47907
+ "name" : "thumbnails",
47908
+ "type" : "[io.flow.catalog.v0.models.image]",
47836
47909
  "required" : true,
47837
47910
  "attributes" : [ ],
47838
47911
  "annotations" : [ ],
@@ -47846,45 +47919,16 @@
47846
47919
  "description" : "Date the product was last updated in the catalog"
47847
47920
  }, {
47848
47921
  "name" : "restrictions",
47849
- "type" : "[restriction_review]",
47922
+ "type" : "[restriction_item_review]",
47850
47923
  "required" : true,
47851
47924
  "attributes" : [ ],
47852
47925
  "annotations" : [ ]
47853
47926
  } ],
47854
47927
  "attributes" : [ ],
47855
- "interfaces" : [ ]
47856
- }, {
47857
- "name" : "restriction_review",
47858
- "plural" : "restriction_reviews",
47859
- "fields" : [ {
47860
- "name" : "rule",
47861
- "type" : "restriction_rule_summary",
47862
- "required" : true,
47863
- "attributes" : [ ],
47864
- "annotations" : [ ]
47865
- }, {
47866
- "name" : "status",
47867
- "type" : "product_restriction_status",
47868
- "required" : true,
47869
- "attributes" : [ ],
47870
- "annotations" : [ ]
47871
- }, {
47872
- "name" : "keywords",
47873
- "type" : "restriction_keywords",
47874
- "required" : true,
47875
- "attributes" : [ ],
47876
- "annotations" : [ ],
47877
- "description" : "Matching positive and negative keywords matching a rule"
47878
- }, {
47879
- "name" : "date",
47880
- "type" : "date-time-iso8601",
47881
- "required" : false,
47882
- "attributes" : [ ],
47883
- "annotations" : [ ],
47884
- "description" : "Date of review"
47885
- } ],
47886
- "attributes" : [ ],
47887
- "interfaces" : [ ]
47928
+ "interfaces" : [ ],
47929
+ "deprecation" : {
47930
+ "description" : "To be removed"
47931
+ }
47888
47932
  }, {
47889
47933
  "name" : "restriction_rule",
47890
47934
  "plural" : "restriction_rules",
@@ -80641,7 +80685,7 @@
80641
80685
  } ],
80642
80686
  "description" : "Returns the list of product restrictions",
80643
80687
  "deprecation" : {
80644
- "description" : "to be replaced by new UI resources"
80688
+ "description" : "To be removed"
80645
80689
  }
80646
80690
  }, {
80647
80691
  "method" : "POST",
@@ -80719,7 +80763,10 @@
80719
80763
  "attributes" : [ ]
80720
80764
  } ],
80721
80765
  "attributes" : [ ],
80722
- "description" : "Returns a restriction by product id"
80766
+ "description" : "Returns a restriction by product id",
80767
+ "deprecation" : {
80768
+ "description" : "To be removed"
80769
+ }
80723
80770
  }, {
80724
80771
  "method" : "PUT",
80725
80772
  "path" : "/internal/product/restrictions/:product_id",
@@ -81311,16 +81358,9 @@
81311
81358
  "location" : "Path",
81312
81359
  "required" : true,
81313
81360
  "description" : "Refers to your organization's account identifier"
81314
- }, {
81315
- "name" : "id",
81316
- "type" : "[string]",
81317
- "location" : "Query",
81318
- "required" : false,
81319
- "description" : "Filter by one or more IDs of this resource",
81320
- "maximum" : 100
81321
81361
  }, {
81322
81362
  "name" : "status",
81323
- "type" : "product_restriction_status",
81363
+ "type" : "restriction_status",
81324
81364
  "location" : "Query",
81325
81365
  "required" : true,
81326
81366
  "default" : "in_review"
@@ -81347,12 +81387,6 @@
81347
81387
  "description" : "The number of results to skip before returning results",
81348
81388
  "default" : "0",
81349
81389
  "minimum" : 0
81350
- }, {
81351
- "name" : "sort",
81352
- "type" : "string",
81353
- "location" : "Query",
81354
- "required" : true,
81355
- "default" : "name"
81356
81390
  } ],
81357
81391
  "responses" : [ {
81358
81392
  "code" : {
@@ -81383,18 +81417,56 @@
81383
81417
  "attributes" : [ ]
81384
81418
  } ],
81385
81419
  "attributes" : [ {
81386
- "name" : "sort",
81420
+ "name" : "linter",
81387
81421
  "value" : {
81388
- "values" : [ {
81389
- "value" : "organization_id"
81390
- }, {
81391
- "value" : "name"
81392
- }, {
81393
- "value" : "updated_at"
81394
- } ]
81422
+ "ignore" : [ "get", "id", "sort" ]
81395
81423
  }
81396
81424
  } ],
81397
81425
  "description" : "Returns a list of product items for an organization"
81426
+ }, {
81427
+ "method" : "POST",
81428
+ "path" : "/internal/restriction/:organization/items",
81429
+ "parameters" : [ {
81430
+ "name" : "organization",
81431
+ "type" : "string",
81432
+ "location" : "Path",
81433
+ "required" : true,
81434
+ "description" : "Refers to your organization's account identifier"
81435
+ } ],
81436
+ "responses" : [ {
81437
+ "code" : {
81438
+ "integer" : {
81439
+ "value" : 201
81440
+ }
81441
+ },
81442
+ "type" : "restriction_item",
81443
+ "description" : "Operation succeeded and the resource was created",
81444
+ "attributes" : [ ]
81445
+ }, {
81446
+ "code" : {
81447
+ "integer" : {
81448
+ "value" : 401
81449
+ }
81450
+ },
81451
+ "type" : "unit",
81452
+ "description" : "Authorization failed",
81453
+ "attributes" : [ ]
81454
+ }, {
81455
+ "code" : {
81456
+ "integer" : {
81457
+ "value" : 422
81458
+ }
81459
+ },
81460
+ "type" : "io.flow.error.v0.models.generic_error",
81461
+ "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.",
81462
+ "attributes" : [ ]
81463
+ } ],
81464
+ "attributes" : [ ],
81465
+ "description" : "Set the restriction decision for a product item",
81466
+ "body" : {
81467
+ "type" : "restriction_item_review_decision_form",
81468
+ "attributes" : [ ]
81469
+ }
81398
81470
  }, {
81399
81471
  "method" : "GET",
81400
81472
  "path" : "/internal/restriction/:organization/items/rules",
@@ -81472,6 +81544,52 @@
81472
81544
  }
81473
81545
  } ],
81474
81546
  "description" : "Returns the list of restriction rules currently applicable for an organizations products in review"
81547
+ }, {
81548
+ "method" : "GET",
81549
+ "path" : "/internal/restriction/:organization/items/:id",
81550
+ "parameters" : [ {
81551
+ "name" : "organization",
81552
+ "type" : "string",
81553
+ "location" : "Path",
81554
+ "required" : true,
81555
+ "description" : "Refers to your organization's account identifier"
81556
+ }, {
81557
+ "name" : "id",
81558
+ "type" : "string",
81559
+ "location" : "Path",
81560
+ "required" : true,
81561
+ "description" : "Filter by one or more IDs of this resource"
81562
+ } ],
81563
+ "responses" : [ {
81564
+ "code" : {
81565
+ "integer" : {
81566
+ "value" : 200
81567
+ }
81568
+ },
81569
+ "type" : "restriction_item",
81570
+ "description" : "Successful response",
81571
+ "attributes" : [ ]
81572
+ }, {
81573
+ "code" : {
81574
+ "integer" : {
81575
+ "value" : 401
81576
+ }
81577
+ },
81578
+ "type" : "unit",
81579
+ "description" : "Authorization failed",
81580
+ "attributes" : [ ]
81581
+ }, {
81582
+ "code" : {
81583
+ "integer" : {
81584
+ "value" : 404
81585
+ }
81586
+ },
81587
+ "type" : "unit",
81588
+ "description" : "Resource was not found",
81589
+ "attributes" : [ ]
81590
+ } ],
81591
+ "attributes" : [ ],
81592
+ "description" : "Returns a restriction product item by id"
81475
81593
  } ],
81476
81594
  "attributes" : [ {
81477
81595
  "name" : "docs",
@@ -81487,28 +81605,21 @@
81487
81605
  "method" : "GET",
81488
81606
  "path" : "/internal/restriction/products",
81489
81607
  "parameters" : [ {
81490
- "name" : "id",
81491
- "type" : "[string]",
81492
- "location" : "Query",
81493
- "required" : false,
81494
- "description" : "Filter by one or more IDs of this resource",
81495
- "maximum" : 100
81496
- }, {
81497
81608
  "name" : "organization_id",
81498
81609
  "type" : "string",
81499
81610
  "location" : "Query",
81500
81611
  "required" : false
81612
+ }, {
81613
+ "name" : "status",
81614
+ "type" : "restriction_status",
81615
+ "location" : "Query",
81616
+ "required" : false
81501
81617
  }, {
81502
81618
  "name" : "rule_ids",
81503
81619
  "type" : "[string]",
81504
81620
  "location" : "Query",
81505
81621
  "required" : false,
81506
81622
  "maximum" : 100
81507
- }, {
81508
- "name" : "status",
81509
- "type" : "product_restriction_status",
81510
- "location" : "Query",
81511
- "required" : false
81512
81623
  }, {
81513
81624
  "name" : "limit",
81514
81625
  "type" : "long",
@@ -81526,12 +81637,6 @@
81526
81637
  "description" : "The number of results to skip before returning results",
81527
81638
  "default" : "0",
81528
81639
  "minimum" : 0
81529
- }, {
81530
- "name" : "sort",
81531
- "type" : "string",
81532
- "location" : "Query",
81533
- "required" : true,
81534
- "default" : "name"
81535
81640
  } ],
81536
81641
  "responses" : [ {
81537
81642
  "code" : {
@@ -81562,27 +81667,23 @@
81562
81667
  "attributes" : [ ]
81563
81668
  } ],
81564
81669
  "attributes" : [ {
81565
- "name" : "sort",
81670
+ "name" : "linter",
81566
81671
  "value" : {
81567
- "values" : [ {
81568
- "value" : "organization_id"
81569
- }, {
81570
- "value" : "updated_at"
81571
- }, {
81572
- "value" : "name"
81573
- } ]
81672
+ "ignore" : [ "get", "id", "sort" ]
81574
81673
  }
81575
81674
  } ],
81576
- "description" : "Returns a list of products for an organization"
81675
+ "description" : "Returns a list of products for an organization",
81676
+ "deprecation" : {
81677
+ "description" : "To be removed"
81678
+ }
81577
81679
  }, {
81578
81680
  "method" : "GET",
81579
- "path" : "/internal/restriction/products/:id",
81681
+ "path" : "/internal/restriction/products/:product_id",
81580
81682
  "parameters" : [ {
81581
- "name" : "id",
81683
+ "name" : "product_id",
81582
81684
  "type" : "string",
81583
81685
  "location" : "Path",
81584
- "required" : true,
81585
- "description" : "Filter by one or more IDs of this resource"
81686
+ "required" : true
81586
81687
  } ],
81587
81688
  "responses" : [ {
81588
81689
  "code" : {
@@ -81613,7 +81714,10 @@
81613
81714
  "attributes" : [ ]
81614
81715
  } ],
81615
81716
  "attributes" : [ ],
81616
- "description" : "Returns a restriction product by product id"
81717
+ "description" : "Returns a restriction product by product id",
81718
+ "deprecation" : {
81719
+ "description" : "To be removed"
81720
+ }
81617
81721
  } ],
81618
81722
  "attributes" : [ {
81619
81723
  "name" : "docs",