@flowio/api-internal-mock-generator 5.31.30 → 5.31.32

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 +1343 -1334
  2. package/package.json +2 -2
  3. package/src/api-internal.json +1343 -1334
package/dist/api-internal.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "apidoc": {
3
- "version": "0.15.70"
3
+ "version": "1.0.0"
4
4
  },
5
5
  "name": "API Internal",
6
6
  "organization": {
@@ -10,7 +10,7 @@
10
10
  "key": "api-internal"
11
11
  },
12
12
  "namespace": "io.flow.internal.v0",
13
- "version": "0.16.59",
13
+ "version": "0.16.67",
14
14
  "info": {
15
15
  "license": {
16
16
  "name": "MIT",
@@ -31,7 +31,7 @@
31
31
  "application": {
32
32
  "key": "error"
33
33
  },
34
- "version": "0.16.59",
34
+ "version": "0.16.62",
35
35
  "enums": ["generic_error_code"],
36
36
  "interfaces": [],
37
37
  "unions": [],
@@ -46,7 +46,7 @@
46
46
  "application": {
47
47
  "key": "common"
48
48
  },
49
- "version": "0.16.59",
49
+ "version": "0.16.62",
50
50
  "enums": ["attribute_data_type", "availability_status", "calendar", "capability", "change_type", "currency_label_formatter", "currency_symbol_format", "day_of_week", "delivered_duty", "discount_target", "entity_identifier_type", "environment", "exception_type", "goods_supply", "holiday_calendar", "included_levy_key", "incoterm", "input_specification_type", "margin_type", "measurement_system", "merchant_of_record", "order_merchant_of_record", "organization_status", "price_book_status", "role", "rounding_method", "rounding_type", "schedule_exception_status", "sort_direction", "unit_of_measurement", "unit_of_time", "user_status", "value_added_service", "visibility"],
51
51
  "interfaces": ["id_reference"],
52
52
  "unions": ["discount_offer", "expandable_organization", "expandable_user", "input_specification_limitation", "price_source", "repeat_schedule"],
@@ -61,7 +61,7 @@
61
61
  "application": {
62
62
  "key": "session"
63
63
  },
64
- "version": "0.16.59",
64
+ "version": "0.16.62",
65
65
  "enums": [],
66
66
  "interfaces": [],
67
67
  "unions": ["session", "session_authorization"],
@@ -76,7 +76,7 @@
76
76
  "application": {
77
77
  "key": "reference"
78
78
  },
79
- "version": "0.16.59",
79
+ "version": "0.16.62",
80
80
  "enums": ["payment_method_capability", "payment_method_type", "postal_type", "province_type"],
81
81
  "interfaces": [],
82
82
  "unions": [],
@@ -91,7 +91,7 @@
91
91
  "application": {
92
92
  "key": "query-builder"
93
93
  },
94
- "version": "0.16.59",
94
+ "version": "0.16.62",
95
95
  "enums": ["available_filter_format"],
96
96
  "interfaces": [],
97
97
  "unions": ["available_filter", "query_builder_form", "query_filter", "query_filter_form"],
@@ -106,7 +106,7 @@
106
106
  "application": {
107
107
  "key": "experience"
108
108
  },
109
- "version": "0.16.59",
109
+ "version": "0.16.62",
110
110
  "enums": ["address_field_name", "credit_payment_error_code", "delivered_duty_display_type", "discount_rule_status", "discount_rule_subsidy_target", "experience_clone_status", "experience_country_status", "experience_payment_method_tag", "experience_status", "order_error_code", "order_payment_type", "order_refund_summary_includes", "order_refund_summary_partial_charged", "order_status", "order_storage", "order_type", "organization_payment_method_tag", "payment_method_rule_content_key", "price_facet_boundary", "promotion_trigger_type"],
111
111
  "interfaces": ["allocation_component", "allocation_detail", "allocation_line_summary_fields", "expandable_experience", "expandable_order"],
112
112
  "unions": ["allocation_component", "allocation_detail", "discount_rule_entitlement", "expandable_experience", "expandable_order", "order_number_generator", "order_promotion", "order_promotion_form", "order_refund_summary_form", "payment_method_tag", "promotion"],
@@ -121,7 +121,7 @@
121
121
  "application": {
122
122
  "key": "field-validation"
123
123
  },
124
- "version": "0.16.59",
124
+ "version": "0.16.62",
125
125
  "enums": [],
126
126
  "interfaces": [],
127
127
  "unions": ["field_validation_rule"],
@@ -136,7 +136,7 @@
136
136
  "application": {
137
137
  "key": "fulfillment"
138
138
  },
139
- "version": "0.16.59",
139
+ "version": "0.16.62",
140
140
  "enums": ["center_capability", "delivery_option_cost_detail_component_key", "delivery_option_cost_detail_source", "delivery_window_component_source", "delivery_window_location", "item_availability_status", "lane_direction", "lane_preselect_preference", "lane_strategy", "physical_delivery_special_serivce", "quote_error_code", "ratecard_owner", "shipment_integration_type", "shipping_configuration_type", "strategy", "surcharge_responsible_party", "tier_availability", "tier_estimate_type", "tier_strategy", "zero_amount_indicator"],
141
141
  "interfaces": ["delivery"],
142
142
  "unions": ["delivery", "expandable_center", "partner_center_fee", "tier_rule_outcome", "tier_rule_outcome_form"],
@@ -151,7 +151,7 @@
151
151
  "application": {
152
152
  "key": "payment"
153
153
  },
154
- "version": "0.16.59",
154
+ "version": "0.16.63",
155
155
  "enums": ["authorization_decline_code", "authorization_option", "authorization_result_action_type", "authorization_status", "avs_code", "capture_decline_code", "capture_status", "card_error_code", "card_type", "cvv_code", "payment_error_code", "payment_source_confirmation_action_type", "refund_decline_code", "refund_status", "reversal_error_code", "reversal_status", "three_d_secure_code", "threeds_two_challenge_viewport", "token_type"],
156
156
  "interfaces": ["authorization", "payment"],
157
157
  "unions": ["adyen_native_data", "authorization", "authorization_form", "authorization_payload_parameters", "authorization_result_action", "authorization_result_action_details", "browser_action_configuration", "confirmation_details", "expandable_card", "expandable_payment_processor", "gateway_authentication_data", "gateway_authentication_data_form", "inline_action_configuration", "online_authorization_details", "payment", "payment_form", "payment_order_reference", "payment_source", "payment_source_form", "threeds_challenge_action", "threeds_identify_action"],
@@ -166,7 +166,7 @@
166
166
  "application": {
167
167
  "key": "merchant-onboarding"
168
168
  },
169
- "version": "0.16.59",
169
+ "version": "0.16.62",
170
170
  "enums": ["onboarding_application_status", "onboarding_trade_sector", "region_type"],
171
171
  "interfaces": [],
172
172
  "unions": ["merchant_application", "merchant_application_form", "merchant_application_put_form", "merchant_applications_summary"],
@@ -181,7 +181,7 @@
181
181
  "application": {
182
182
  "key": "ratecard"
183
183
  },
184
- "version": "0.16.59",
184
+ "version": "0.16.62",
185
185
  "enums": [],
186
186
  "interfaces": ["common_hop_estimate", "ratecard_estimate"],
187
187
  "unions": ["ratecard_estimate", "ratecard_fee", "service_fee"],
@@ -196,7 +196,7 @@
196
196
  "application": {
197
197
  "key": "inventory"
198
198
  },
199
- "version": "0.16.59",
199
+ "version": "0.16.62",
200
200
  "enums": ["aggregate", "inventory_status", "update_type"],
201
201
  "interfaces": [],
202
202
  "unions": ["inventory_strategy", "reservation_error"],
@@ -211,7 +211,7 @@
211
211
  "application": {
212
212
  "key": "token"
213
213
  },
214
- "version": "0.16.59",
214
+ "version": "0.16.62",
215
215
  "enums": [],
216
216
  "interfaces": ["token_detail_interface"],
217
217
  "unions": ["token", "token_reference"],
@@ -226,7 +226,7 @@
226
226
  "application": {
227
227
  "key": "price"
228
228
  },
229
- "version": "0.16.59",
229
+ "version": "0.16.62",
230
230
  "enums": ["levy_component", "levy_strategy", "price_accuracy", "price_detail_component_key", "price_detail_key", "pricing_levy_setting"],
231
231
  "interfaces": [],
232
232
  "unions": ["deminimis"],
@@ -241,7 +241,7 @@
241
241
  "application": {
242
242
  "key": "session-context"
243
243
  },
244
- "version": "0.16.59",
244
+ "version": "0.16.62",
245
245
  "enums": [],
246
246
  "interfaces": [],
247
247
  "unions": [],
@@ -256,7 +256,7 @@
256
256
  "application": {
257
257
  "key": "checkout"
258
258
  },
259
- "version": "0.16.59",
259
+ "version": "0.16.62",
260
260
  "enums": [],
261
261
  "interfaces": [],
262
262
  "unions": ["checkout_token_form"],
@@ -271,7 +271,7 @@
271
271
  "application": {
272
272
  "key": "customer"
273
273
  },
274
- "version": "0.16.59",
274
+ "version": "0.16.62",
275
275
  "enums": ["customer_address_type"],
276
276
  "interfaces": [],
277
277
  "unions": [],
@@ -286,7 +286,7 @@
286
286
  "application": {
287
287
  "key": "shopify"
288
288
  },
289
- "version": "0.16.59",
289
+ "version": "0.16.62",
290
290
  "enums": ["shopify_grant", "shopify_localization_method", "shopify_sync_check"],
291
291
  "interfaces": [],
292
292
  "unions": ["shopify_cart_add_form", "shopify_event_bucket"],
@@ -301,7 +301,7 @@
301
301
  "application": {
302
302
  "key": "harmonization"
303
303
  },
304
- "version": "0.16.59",
304
+ "version": "0.16.62",
305
305
  "enums": ["tax_applicability", "tax_verification_result"],
306
306
  "interfaces": [],
307
307
  "unions": [],
@@ -316,7 +316,7 @@
316
316
  "application": {
317
317
  "key": "shopify-external"
318
318
  },
319
- "version": "0.2.88",
319
+ "version": "0.2.93",
320
320
  "enums": ["cancel_reason", "discount_status", "discount_type", "discrepancy_reason", "event", "financial_status_type", "format", "fulfillment_service", "fulfillment_status_type", "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_processing_method_type", "shopify_transaction_error_code", "shopify_transaction_status", "topic", "value_type", "weight_unit"],
321
321
  "interfaces": [],
322
322
  "unions": [],
@@ -331,7 +331,7 @@
331
331
  "application": {
332
332
  "key": "shopify-markets"
333
333
  },
334
- "version": "0.2.88",
334
+ "version": "0.2.93",
335
335
  "enums": ["cancel_reason", "fulfillment_order_delivery_method_type", "incoterm_duties", "shopify_discrepancy_reason", "shopify_order_cancel_reason", "shopify_order_discount_allocation_method", "shopify_order_discount_application_target_selection", "shopify_order_discount_application_target_type", "shopify_order_discount_application_type", "shopify_order_discount_application_value_type", "shopify_order_discount_type", "shopify_order_financial_status_type", "shopify_order_fulfillment_order_request_status", "shopify_order_fulfillment_order_status", "shopify_order_fulfillment_shipment_status", "shopify_order_fulfillment_status", "shopify_order_fulfillment_status_type", "shopify_order_inventory_behaviour", "shopify_order_kind_type", "shopify_order_processing_method_type", "shopify_order_restock_type", "shopify_order_status_type", "shopify_order_transaction_error_code", "shopify_order_transaction_status", "shopify_order_value_type", "shopify_webhook_format", "shopify_webhook_topic"],
336
336
  "interfaces": [],
337
337
  "unions": [],
@@ -346,7 +346,7 @@
346
346
  "application": {
347
347
  "key": "catalog"
348
348
  },
349
- "version": "0.16.59",
349
+ "version": "0.16.62",
350
350
  "enums": ["adjustment_reason_key", "attribute_intent", "fulfillment_method_type", "fulfillment_method_value", "image_tag", "return_item_status", "subcatalog_item_status", "taxability_type", "taxability_value", "update_policy"],
351
351
  "interfaces": ["localized_price"],
352
352
  "unions": ["expandable_subcatalog", "localized_price"],
@@ -361,7 +361,7 @@
361
361
  "application": {
362
362
  "key": "adyen"
363
363
  },
364
- "version": "0.2.88",
364
+ "version": "0.2.93",
365
365
  "enums": ["channel", "contract", "device_channel", "event_code", "http_redirect_method", "operation", "payment_method", "recurring_processing_model", "result_code", "shopper_interaction", "threeds_completion_indicator"],
366
366
  "interfaces": [],
367
367
  "unions": ["browser_info", "payment_method_data"],
@@ -376,7 +376,7 @@
376
376
  "application": {
377
377
  "key": "bitpay"
378
378
  },
379
- "version": "0.2.88",
379
+ "version": "0.2.93",
380
380
  "enums": ["exception_status", "invoice_status", "refund_status", "transaction_speed", "webhook_event_name"],
381
381
  "interfaces": [],
382
382
  "unions": [],
@@ -391,7 +391,7 @@
391
391
  "application": {
392
392
  "key": "crypto"
393
393
  },
394
- "version": "0.2.88",
394
+ "version": "0.2.93",
395
395
  "enums": ["error_type", "payment_status", "reason_type", "refund_status", "webhook_event_name", "webhook_object_type"],
396
396
  "interfaces": [],
397
397
  "unions": [],
@@ -406,7 +406,7 @@
406
406
  "application": {
407
407
  "key": "payment-gateway"
408
408
  },
409
- "version": "0.16.59",
409
+ "version": "0.16.62",
410
410
  "enums": ["inline_window_viewport_size", "payment_action_type", "payment_failure_code", "payment_method_data_option_type", "payment_status", "payment_type"],
411
411
  "interfaces": ["action", "device_details", "payment_method_summary"],
412
412
  "unions": ["action", "card_authorization_action_result", "card_number", "device_details", "device_fingerprint_details", "order_information", "payment_capture_option", "payment_method_card", "payment_method_data", "payment_method_data_authorize_klarna_result", "payment_method_data_option_logo", "payment_method_summary", "sdk_adyen_v3_authentication_token"],
@@ -421,7 +421,7 @@
421
421
  "application": {
422
422
  "key": "payment-request-bundle"
423
423
  },
424
- "version": "0.16.59",
424
+ "version": "0.16.62",
425
425
  "enums": [],
426
426
  "interfaces": [],
427
427
  "unions": [],
@@ -436,7 +436,7 @@
436
436
  "application": {
437
437
  "key": "paypal"
438
438
  },
439
- "version": "0.2.88",
439
+ "version": "0.2.93",
440
440
  "enums": ["adjudication_type", "affected_party", "allowed_payment_method", "cancellation_mode", "carrier_name", "dispute_channel", "dispute_life_cycle_stage", "dispute_merchant_contacted_mode", "dispute_merchant_contacted_outcome", "dispute_outcome_code", "dispute_reason", "dispute_status", "evidence_type", "failure_reason", "grant_type", "http_method", "intent", "issue_type", "message_poster", "money_movement_reason", "money_movement_type", "offer_type", "other_means_payment_method", "payer_status", "payment_method", "payment_pattern", "product_received", "refund_state", "return_acknowledgement_type", "return_mode", "service_started", "shipping_display_preference", "state", "sub_reason", "supporting_info_source", "transaction_status", "user_action_prompt"],
441
441
  "interfaces": [],
442
442
  "unions": [],
@@ -451,7 +451,7 @@
451
451
  "application": {
452
452
  "key": "stripe"
453
453
  },
454
- "version": "0.2.88",
454
+ "version": "0.2.93",
455
455
  "enums": ["account_type", "cancellation_reason", "capture_method", "card_brand", "card_error_code", "card_funding_type", "check_outcome", "code_verification_status", "confirmation_method", "decline_code", "error_type", "event_type", "klarna_payment_method_category_type", "klarna_product", "network_status", "next_action_type", "order_item_type", "payment_intent_status", "payment_method_type", "payment_outcome_type", "payment_status", "refund_failure_reason", "refund_reason", "refund_status", "request_three_d_secure_type", "requested_capabilities", "setup_future_usage", "source_flow", "source_status", "source_type", "source_usage_type", "three_d_secure_support", "token_type", "use_stripe_sdk_type"],
456
456
  "interfaces": [],
457
457
  "unions": [],
@@ -466,7 +466,7 @@
466
466
  "application": {
467
467
  "key": "svb"
468
468
  },
469
- "version": "0.2.88",
469
+ "version": "0.2.93",
470
470
  "enums": ["clearing_type", "notification_type", "transaction_type"],
471
471
  "interfaces": [],
472
472
  "unions": [],
@@ -481,7 +481,7 @@
481
481
  "application": {
482
482
  "key": "channel"
483
483
  },
484
- "version": "0.16.59",
484
+ "version": "0.16.62",
485
485
  "enums": ["channel_currency_capability"],
486
486
  "interfaces": [],
487
487
  "unions": [],
@@ -496,7 +496,7 @@
496
496
  "application": {
497
497
  "key": "brickftp"
498
498
  },
499
- "version": "0.2.88",
499
+ "version": "0.2.93",
500
500
  "enums": ["authentication_method", "behavior_type", "grant_permission_setting", "ssl_required_setting", "webhook_event_action", "webhook_event_interface", "webhook_event_type"],
501
501
  "interfaces": [],
502
502
  "unions": ["file_form", "node"],
@@ -511,7 +511,7 @@
511
511
  "application": {
512
512
  "key": "fraud"
513
513
  },
514
- "version": "0.16.59",
514
+ "version": "0.16.62",
515
515
  "enums": ["fraud_email_rule_decision", "fraud_liability", "fraud_status"],
516
516
  "interfaces": [],
517
517
  "unions": ["fraud_order_reference"],
@@ -526,7 +526,7 @@
526
526
  "application": {
527
527
  "key": "permission"
528
528
  },
529
- "version": "0.16.59",
529
+ "version": "0.16.62",
530
530
  "enums": ["authentication_technique", "flow_behavior", "flow_role", "permitted_http_method"],
531
531
  "interfaces": [],
532
532
  "unions": [],
@@ -541,7 +541,7 @@
541
541
  "application": {
542
542
  "key": "order-management-event"
543
543
  },
544
- "version": "0.16.59",
544
+ "version": "0.16.62",
545
545
  "enums": [],
546
546
  "interfaces": [],
547
547
  "unions": ["order_management_event"],
@@ -556,7 +556,7 @@
556
556
  "application": {
557
557
  "key": "organization"
558
558
  },
559
- "version": "0.16.59",
559
+ "version": "0.16.62",
560
560
  "enums": ["country_picker_source", "ecommerce_platform_type", "invitation_error_code"],
561
561
  "interfaces": [],
562
562
  "unions": [],
@@ -571,7 +571,7 @@
571
571
  "application": {
572
572
  "key": "label"
573
573
  },
574
- "version": "0.16.59",
574
+ "version": "0.16.62",
575
575
  "enums": ["direction", "shipment_recipient", "tracking_number_type"],
576
576
  "interfaces": [],
577
577
  "unions": ["shipping_label_form", "shipping_notification_form"],
@@ -586,7 +586,7 @@
586
586
  "application": {
587
587
  "key": "return"
588
588
  },
589
- "version": "0.16.59",
589
+ "version": "0.16.62",
590
590
  "enums": ["return_status", "return_tracking_status"],
591
591
  "interfaces": [],
592
592
  "unions": ["return_source"],
@@ -601,7 +601,7 @@
601
601
  "application": {
602
602
  "key": "tracking"
603
603
  },
604
- "version": "0.16.59",
604
+ "version": "0.16.62",
605
605
  "enums": ["tracking_status"],
606
606
  "interfaces": [],
607
607
  "unions": [],
@@ -616,7 +616,7 @@
616
616
  "application": {
617
617
  "key": "export"
618
618
  },
619
- "version": "0.16.59",
619
+ "version": "0.16.62",
620
620
  "enums": ["export_status", "item_identifier"],
621
621
  "interfaces": ["csv_price_book_item_export_row"],
622
622
  "unions": ["export_delivery", "export_type"],
@@ -631,7 +631,7 @@
631
631
  "application": {
632
632
  "key": "pricing-indicator-internal-event"
633
633
  },
634
- "version": "0.16.59",
634
+ "version": "0.16.67",
635
635
  "enums": ["pricing_indicator_status", "service_name"],
636
636
  "interfaces": [],
637
637
  "unions": ["pricing_indicator_event"],
@@ -646,7 +646,7 @@
646
646
  "application": {
647
647
  "key": "flexe"
648
648
  },
649
- "version": "0.2.88",
649
+ "version": "0.2.93",
650
650
  "enums": ["flexe_attachment_type", "flexe_notification", "flexe_shipment_type", "flexe_status"],
651
651
  "interfaces": [],
652
652
  "unions": [],
@@ -661,7 +661,7 @@
661
661
  "application": {
662
662
  "key": "order-management"
663
663
  },
664
- "version": "0.16.59",
664
+ "version": "0.16.62",
665
665
  "enums": ["cancel_reason", "fulfillment_item_quantity_status", "order_change_source"],
666
666
  "interfaces": [],
667
667
  "unions": [],
@@ -676,7 +676,7 @@
676
676
  "application": {
677
677
  "key": "catalog-exclusion"
678
678
  },
679
- "version": "0.16.59",
679
+ "version": "0.16.62",
680
680
  "enums": ["exclusion_rule_state"],
681
681
  "interfaces": [],
682
682
  "unions": [],
@@ -691,7 +691,7 @@
691
691
  "application": {
692
692
  "key": "catalog-return"
693
693
  },
694
- "version": "0.16.59",
694
+ "version": "0.16.62",
695
695
  "enums": ["return_policy_state"],
696
696
  "interfaces": [],
697
697
  "unions": [],
@@ -706,7 +706,7 @@
706
706
  "application": {
707
707
  "key": "ftp"
708
708
  },
709
- "version": "0.16.59",
709
+ "version": "0.16.62",
710
710
  "enums": ["ftp_file_source"],
711
711
  "interfaces": [],
712
712
  "unions": [],
@@ -4407,6 +4407,19 @@
4407
4407
  "attributes": []
4408
4408
  }],
4409
4409
  "attributes": []
4410
+ }, {
4411
+ "name": "order_transaction_type",
4412
+ "plural": "order_transaction_types",
4413
+ "values": [{
4414
+ "name": "adjustment",
4415
+ "attributes": [],
4416
+ "description": "Indicates this transaction is an adjustment to another order transaction. See transaction adjustments to find which transction this modified"
4417
+ }, {
4418
+ "name": "order_service",
4419
+ "attributes": [],
4420
+ "description": "Indicates this transaction is created in response to the order having been submitted and now needing to be serviced"
4421
+ }],
4422
+ "attributes": []
4410
4423
  }, {
4411
4424
  "name": "organization_capability",
4412
4425
  "plural": "organization_capabilities",
@@ -5315,6 +5328,9 @@
5315
5328
  "values": [{
5316
5329
  "name": "billing_account",
5317
5330
  "attributes": []
5331
+ }, {
5332
+ "name": "carrier_account",
5333
+ "attributes": []
5318
5334
  }],
5319
5335
  "attributes": []
5320
5336
  }, {
@@ -5507,6 +5523,43 @@
5507
5523
  "annotations": []
5508
5524
  }],
5509
5525
  "attributes": []
5526
+ }, {
5527
+ "name": "billing_statement",
5528
+ "plural": "billing_statements",
5529
+ "fields": [{
5530
+ "name": "id",
5531
+ "type": "string",
5532
+ "required": true,
5533
+ "attributes": [],
5534
+ "annotations": [],
5535
+ "description": "Globally unique identifier",
5536
+ "example": "xxxx-1234"
5537
+ }, {
5538
+ "name": "account",
5539
+ "type": "account_reference",
5540
+ "required": true,
5541
+ "attributes": [],
5542
+ "annotations": []
5543
+ }, {
5544
+ "name": "period",
5545
+ "type": "io.flow.common.v0.models.datetime_range",
5546
+ "required": true,
5547
+ "attributes": [],
5548
+ "annotations": []
5549
+ }, {
5550
+ "name": "totals",
5551
+ "type": "billing_statement_totals",
5552
+ "required": true,
5553
+ "attributes": [],
5554
+ "annotations": []
5555
+ }, {
5556
+ "name": "attachments",
5557
+ "type": "[billing_statement_attachment]",
5558
+ "required": true,
5559
+ "attributes": [],
5560
+ "annotations": []
5561
+ }],
5562
+ "attributes": []
5510
5563
  }, {
5511
5564
  "name": "checkout",
5512
5565
  "plural": "checkouts",
@@ -6527,10 +6580,12 @@
6527
6580
  "types": [{
6528
6581
  "type": "adjustment_amount_percentage",
6529
6582
  "attributes": [],
6583
+ "default": false,
6530
6584
  "discriminator_value": "percentage"
6531
6585
  }, {
6532
6586
  "type": "adjustment_amount_fixed",
6533
6587
  "attributes": [],
6588
+ "default": false,
6534
6589
  "discriminator_value": "fixed"
6535
6590
  }],
6536
6591
  "attributes": [],
@@ -6715,10 +6770,12 @@
6715
6770
  "types": [{
6716
6771
  "type": "channel_rate_metadata_identity",
6717
6772
  "attributes": [],
6773
+ "default": false,
6718
6774
  "discriminator_value": "channel_rate_metadata_identity"
6719
6775
  }, {
6720
6776
  "type": "channel_rate_metadata_rate",
6721
6777
  "attributes": [],
6778
+ "default": false,
6722
6779
  "discriminator_value": "channel_rate_metadata_rate"
6723
6780
  }],
6724
6781
  "attributes": [],
@@ -10168,18 +10225,22 @@
10168
10225
  "types": [{
10169
10226
  "type": "platform_fee_pause",
10170
10227
  "attributes": [],
10228
+ "default": false,
10171
10229
  "discriminator_value": "platform_fee_pause"
10172
10230
  }, {
10173
10231
  "type": "platform_fee_flat",
10174
10232
  "attributes": [],
10233
+ "default": false,
10175
10234
  "discriminator_value": "platform_fee_flat"
10176
10235
  }, {
10177
10236
  "type": "platform_fee_percentage",
10178
10237
  "attributes": [],
10238
+ "default": false,
10179
10239
  "discriminator_value": "platform_fee_percentage"
10180
10240
  }, {
10181
10241
  "type": "platform_fee_disabled",
10182
10242
  "attributes": [],
10243
+ "default": false,
10183
10244
  "discriminator_value": "platform_fee_disabled"
10184
10245
  }],
10185
10246
  "attributes": [],
@@ -10481,10 +10542,12 @@
10481
10542
  "types": [{
10482
10543
  "type": "spot_rate_metadata_identity",
10483
10544
  "attributes": [],
10545
+ "default": false,
10484
10546
  "discriminator_value": "spot_rate_metadata_identity"
10485
10547
  }, {
10486
10548
  "type": "spot_rate_metadata_rate",
10487
10549
  "attributes": [],
10550
+ "default": false,
10488
10551
  "discriminator_value": "spot_rate_metadata_rate"
10489
10552
  }],
10490
10553
  "attributes": [],
@@ -10585,46 +10648,57 @@
10585
10648
  "types": [{
10586
10649
  "type": "invoice_transaction",
10587
10650
  "attributes": [],
10651
+ "default": false,
10588
10652
  "discriminator_value": "invoice_transaction"
10589
10653
  }, {
10590
10654
  "type": "manual_transaction",
10591
10655
  "attributes": [],
10656
+ "default": false,
10592
10657
  "discriminator_value": "manual_transaction"
10593
10658
  }, {
10594
10659
  "type": "processing_transaction",
10595
10660
  "attributes": [],
10661
+ "default": false,
10596
10662
  "discriminator_value": "processing_transaction"
10597
10663
  }, {
10598
10664
  "type": "subscription_transaction",
10599
10665
  "attributes": [],
10666
+ "default": false,
10600
10667
  "discriminator_value": "subscription_transaction"
10601
10668
  }, {
10602
10669
  "type": "tax_remittance_transaction",
10603
10670
  "attributes": [],
10671
+ "default": false,
10604
10672
  "discriminator_value": "tax_remittance_transaction"
10605
10673
  }, {
10606
10674
  "type": "transfer_transaction",
10607
10675
  "attributes": [],
10676
+ "default": false,
10608
10677
  "discriminator_value": "transfer_transaction"
10609
10678
  }, {
10610
10679
  "type": "virtual_card_transaction",
10611
10680
  "attributes": [],
10681
+ "default": false,
10612
10682
  "discriminator_value": "virtual_card_transaction"
10613
10683
  }, {
10614
10684
  "type": "dispute_transaction",
10615
10685
  "attributes": [],
10686
+ "default": false,
10616
10687
  "discriminator_value": "dispute_transaction"
10617
10688
  }, {
10618
10689
  "type": "channel_transaction",
10619
10690
  "attributes": [],
10691
+ "default": false,
10620
10692
  "discriminator_value": "channel_transaction"
10621
10693
  }, {
10622
10694
  "type": "label_transaction",
10623
10695
  "attributes": [],
10696
+ "default": false,
10624
10697
  "discriminator_value": "label_transaction"
10625
10698
  }, {
10626
10699
  "type": "order_transaction",
10627
10700
  "attributes": [],
10701
+ "default": false,
10628
10702
  "discriminator_value": "order_transaction"
10629
10703
  }],
10630
10704
  "attributes": [],
@@ -14478,6 +14552,12 @@
14478
14552
  "required": false,
14479
14553
  "attributes": [],
14480
14554
  "annotations": []
14555
+ }, {
14556
+ "name": "identifiers",
14557
+ "type": "map[string]",
14558
+ "required": false,
14559
+ "attributes": [],
14560
+ "annotations": []
14481
14561
  }, {
14482
14562
  "name": "destination",
14483
14563
  "type": "billing_order_destination",
@@ -14796,44 +14876,6 @@
14796
14876
  }],
14797
14877
  "attributes": [],
14798
14878
  "interfaces": []
14799
- }, {
14800
- "name": "billing_statement",
14801
- "plural": "billing_statements",
14802
- "fields": [{
14803
- "name": "id",
14804
- "type": "string",
14805
- "required": true,
14806
- "attributes": [],
14807
- "annotations": [],
14808
- "description": "Globally unique identifier",
14809
- "example": "xxxx-1234"
14810
- }, {
14811
- "name": "account",
14812
- "type": "account_reference",
14813
- "required": true,
14814
- "attributes": [],
14815
- "annotations": []
14816
- }, {
14817
- "name": "period",
14818
- "type": "io.flow.common.v0.models.datetime_range",
14819
- "required": true,
14820
- "attributes": [],
14821
- "annotations": []
14822
- }, {
14823
- "name": "totals",
14824
- "type": "billing_statement_totals",
14825
- "required": true,
14826
- "attributes": [],
14827
- "annotations": []
14828
- }, {
14829
- "name": "attachments",
14830
- "type": "[billing_statement_attachment]",
14831
- "required": true,
14832
- "attributes": [],
14833
- "annotations": []
14834
- }],
14835
- "attributes": [],
14836
- "interfaces": []
14837
14879
  }, {
14838
14880
  "name": "billing_statement_attachment",
14839
14881
  "plural": "billing_statement_attachments",
@@ -14914,7 +14956,7 @@
14914
14956
  "annotations": []
14915
14957
  }, {
14916
14958
  "name": "statement",
14917
- "type": "billing_statement",
14959
+ "type": "billing_statement_summary",
14918
14960
  "required": true,
14919
14961
  "attributes": [],
14920
14962
  "annotations": []
@@ -14984,6 +15026,44 @@
14984
15026
  }],
14985
15027
  "attributes": [],
14986
15028
  "interfaces": []
15029
+ }, {
15030
+ "name": "billing_statement_summary",
15031
+ "plural": "billing_statement_summaries",
15032
+ "fields": [{
15033
+ "name": "id",
15034
+ "type": "string",
15035
+ "required": true,
15036
+ "attributes": [],
15037
+ "annotations": [],
15038
+ "description": "Globally unique identifier",
15039
+ "example": "xxxx-1234"
15040
+ }, {
15041
+ "name": "account",
15042
+ "type": "account_reference",
15043
+ "required": true,
15044
+ "attributes": [],
15045
+ "annotations": []
15046
+ }, {
15047
+ "name": "period",
15048
+ "type": "io.flow.common.v0.models.datetime_range",
15049
+ "required": true,
15050
+ "attributes": [],
15051
+ "annotations": []
15052
+ }, {
15053
+ "name": "totals",
15054
+ "type": "billing_statement_totals",
15055
+ "required": true,
15056
+ "attributes": [],
15057
+ "annotations": []
15058
+ }, {
15059
+ "name": "attachments",
15060
+ "type": "[billing_statement_attachment]",
15061
+ "required": true,
15062
+ "attributes": [],
15063
+ "annotations": []
15064
+ }],
15065
+ "attributes": [],
15066
+ "interfaces": ["billing_statement"]
14987
15067
  }, {
14988
15068
  "name": "billing_statement_totals",
14989
15069
  "plural": "billing_statement_totalses",
@@ -15133,7 +15213,7 @@
15133
15213
  "annotations": []
15134
15214
  }, {
15135
15215
  "name": "statement",
15136
- "type": "billing_statement",
15216
+ "type": "billing_statement_summary",
15137
15217
  "required": true,
15138
15218
  "attributes": [],
15139
15219
  "annotations": []
@@ -16203,6 +16283,40 @@
16203
16283
  "attributes": [],
16204
16284
  "interfaces": [],
16205
16285
  "description": "List of payment methods available for every context."
16286
+ }, {
16287
+ "name": "by_rule_snapshot",
16288
+ "plural": "by_rule_snapshots",
16289
+ "fields": [{
16290
+ "name": "id",
16291
+ "type": "string",
16292
+ "required": true,
16293
+ "attributes": [],
16294
+ "annotations": [],
16295
+ "description": "the id of the rule"
16296
+ }, {
16297
+ "name": "name",
16298
+ "type": "string",
16299
+ "required": true,
16300
+ "attributes": [],
16301
+ "annotations": []
16302
+ }, {
16303
+ "name": "open_decision_count",
16304
+ "type": "long",
16305
+ "required": true,
16306
+ "attributes": [],
16307
+ "annotations": [],
16308
+ "description": "The number of products with current rule in in_review or escalated"
16309
+ }, {
16310
+ "name": "restricted_product_count",
16311
+ "type": "long",
16312
+ "required": true,
16313
+ "attributes": [],
16314
+ "annotations": [],
16315
+ "description": "The number of products with current rule restricted"
16316
+ }],
16317
+ "attributes": [],
16318
+ "interfaces": [],
16319
+ "description": "Snapshot of organizations with restriction data we are interested to see in data analytics"
16206
16320
  }, {
16207
16321
  "name": "calculated_tax_amount",
16208
16322
  "plural": "calculated_tax_amounts",
@@ -16813,6 +16927,44 @@
16813
16927
  }],
16814
16928
  "attributes": [],
16815
16929
  "interfaces": []
16930
+ }, {
16931
+ "name": "channel_billing_statement",
16932
+ "plural": "channel_billing_statements",
16933
+ "fields": [{
16934
+ "name": "id",
16935
+ "type": "string",
16936
+ "required": true,
16937
+ "attributes": [],
16938
+ "annotations": [],
16939
+ "description": "Globally unique identifier",
16940
+ "example": "xxxx-1234"
16941
+ }, {
16942
+ "name": "account",
16943
+ "type": "account_reference",
16944
+ "required": true,
16945
+ "attributes": [],
16946
+ "annotations": []
16947
+ }, {
16948
+ "name": "period",
16949
+ "type": "io.flow.common.v0.models.datetime_range",
16950
+ "required": true,
16951
+ "attributes": [],
16952
+ "annotations": []
16953
+ }, {
16954
+ "name": "totals",
16955
+ "type": "billing_statement_totals",
16956
+ "required": true,
16957
+ "attributes": [],
16958
+ "annotations": []
16959
+ }, {
16960
+ "name": "attachments",
16961
+ "type": "[billing_statement_attachment]",
16962
+ "required": true,
16963
+ "attributes": [],
16964
+ "annotations": []
16965
+ }],
16966
+ "attributes": [],
16967
+ "interfaces": ["billing_statement"]
16816
16968
  }, {
16817
16969
  "name": "channel_currency_form",
16818
16970
  "plural": "channel_currency_forms",
@@ -41954,6 +42106,51 @@
41954
42106
  }],
41955
42107
  "attributes": [],
41956
42108
  "interfaces": []
42109
+ }, {
42110
+ "name": "onboarding_audit_snapshot",
42111
+ "plural": "onboarding_audit_snapshots",
42112
+ "fields": [{
42113
+ "name": "id",
42114
+ "type": "string",
42115
+ "required": true,
42116
+ "attributes": [],
42117
+ "annotations": [],
42118
+ "description": "Globally unique identifier"
42119
+ }, {
42120
+ "name": "organization",
42121
+ "type": "io.flow.common.v0.models.organization",
42122
+ "required": true,
42123
+ "attributes": [],
42124
+ "annotations": [],
42125
+ "description": "Refers to your organization's account identifier"
42126
+ }, {
42127
+ "name": "result",
42128
+ "type": "onboarding_audit_result",
42129
+ "required": true,
42130
+ "attributes": [],
42131
+ "annotations": []
42132
+ }, {
42133
+ "name": "theme_reports",
42134
+ "type": "[onboarding_audit_theme_report]",
42135
+ "required": true,
42136
+ "attributes": [],
42137
+ "annotations": [],
42138
+ "minimum": 1
42139
+ }, {
42140
+ "name": "requested_by",
42141
+ "type": "io.flow.common.v0.models.user",
42142
+ "required": true,
42143
+ "attributes": [],
42144
+ "annotations": []
42145
+ }, {
42146
+ "name": "requested_at",
42147
+ "type": "date-time-iso8601",
42148
+ "required": true,
42149
+ "attributes": [],
42150
+ "annotations": []
42151
+ }],
42152
+ "attributes": [],
42153
+ "interfaces": []
41957
42154
  }, {
41958
42155
  "name": "onboarding_audit_theme_report",
41959
42156
  "plural": "onboarding_audit_theme_reports",
@@ -43207,14 +43404,40 @@
43207
43404
  "name": "organization_billing_statement",
43208
43405
  "plural": "organization_billing_statements",
43209
43406
  "fields": [{
43210
- "name": "placeholder",
43407
+ "name": "id",
43211
43408
  "type": "string",
43212
43409
  "required": true,
43213
43410
  "attributes": [],
43411
+ "annotations": [],
43412
+ "description": "Globally unique identifier",
43413
+ "example": "xxxx-1234"
43414
+ }, {
43415
+ "name": "account",
43416
+ "type": "account_reference",
43417
+ "required": true,
43418
+ "attributes": [],
43419
+ "annotations": []
43420
+ }, {
43421
+ "name": "period",
43422
+ "type": "io.flow.common.v0.models.datetime_range",
43423
+ "required": true,
43424
+ "attributes": [],
43425
+ "annotations": []
43426
+ }, {
43427
+ "name": "totals",
43428
+ "type": "billing_statement_totals",
43429
+ "required": true,
43430
+ "attributes": [],
43431
+ "annotations": []
43432
+ }, {
43433
+ "name": "attachments",
43434
+ "type": "[billing_statement_attachment]",
43435
+ "required": true,
43436
+ "attributes": [],
43214
43437
  "annotations": []
43215
43438
  }],
43216
43439
  "attributes": [],
43217
- "interfaces": []
43440
+ "interfaces": ["billing_statement"]
43218
43441
  }, {
43219
43442
  "name": "organization_boolean_value",
43220
43443
  "plural": "organization_boolean_values",
@@ -43657,6 +43880,79 @@
43657
43880
  }],
43658
43881
  "attributes": [],
43659
43882
  "interfaces": []
43883
+ }, {
43884
+ "name": "organization_restriction_snapshot",
43885
+ "plural": "organization_restriction_snapshots",
43886
+ "fields": [{
43887
+ "name": "organization_id",
43888
+ "type": "string",
43889
+ "required": true,
43890
+ "attributes": [],
43891
+ "annotations": []
43892
+ }, {
43893
+ "name": "organization_channel_id",
43894
+ "type": "string",
43895
+ "required": true,
43896
+ "attributes": [],
43897
+ "annotations": [],
43898
+ "description": "If this is a channel organization"
43899
+ }, {
43900
+ "name": "organization_status",
43901
+ "type": "string",
43902
+ "required": true,
43903
+ "attributes": [],
43904
+ "annotations": []
43905
+ }, {
43906
+ "name": "product_count",
43907
+ "type": "long",
43908
+ "required": true,
43909
+ "attributes": [],
43910
+ "annotations": [],
43911
+ "description": "The total number of products given an organization"
43912
+ }, {
43913
+ "name": "open_decision_count",
43914
+ "type": "long",
43915
+ "required": true,
43916
+ "attributes": [],
43917
+ "annotations": [],
43918
+ "description": "The number of products with at least one restriction under in_review or escalated"
43919
+ }, {
43920
+ "name": "restricted_product_count",
43921
+ "type": "long",
43922
+ "required": true,
43923
+ "attributes": [],
43924
+ "annotations": [],
43925
+ "description": "The number of products with at least one restriction applied(restricted)"
43926
+ }, {
43927
+ "name": "count_by_rule",
43928
+ "type": "[by_rule_snapshot]",
43929
+ "required": true,
43930
+ "attributes": [],
43931
+ "annotations": [],
43932
+ "description": "All catalog item numbers aligned with a product"
43933
+ }, {
43934
+ "name": "earliest_pending_decision_date",
43935
+ "type": "date-time-iso8601",
43936
+ "required": true,
43937
+ "attributes": [],
43938
+ "annotations": []
43939
+ }, {
43940
+ "name": "earliest_product_receipt_date",
43941
+ "type": "date-time-iso8601",
43942
+ "required": true,
43943
+ "attributes": [],
43944
+ "annotations": []
43945
+ }, {
43946
+ "name": "date",
43947
+ "type": "date-time-iso8601",
43948
+ "required": true,
43949
+ "attributes": [],
43950
+ "annotations": [],
43951
+ "description": "The current date when this snapshot is created"
43952
+ }],
43953
+ "attributes": [],
43954
+ "interfaces": [],
43955
+ "description": "Snapshot of organizations with restriction data we are interested to see in data analytics"
43660
43956
  }, {
43661
43957
  "name": "organization_restriction_summary",
43662
43958
  "plural": "organization_restriction_summaries",
@@ -56590,11 +56886,11 @@
56590
56886
  "responses": [{
56591
56887
  "code": {
56592
56888
  "integer": {
56593
- "value": 200
56889
+ "value": 404
56594
56890
  }
56595
56891
  },
56596
- "type": "billing_statement_review",
56597
- "description": "Successful response",
56892
+ "type": "unit",
56893
+ "description": "Resource was not found",
56598
56894
  "attributes": []
56599
56895
  }, {
56600
56896
  "code": {
@@ -56608,29 +56904,29 @@
56608
56904
  }, {
56609
56905
  "code": {
56610
56906
  "integer": {
56611
- "value": 401
56907
+ "value": 422
56612
56908
  }
56613
56909
  },
56614
- "type": "unit",
56615
- "description": "Authorization failed",
56910
+ "type": "io.flow.error.v0.models.generic_error",
56911
+ "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.",
56616
56912
  "attributes": []
56617
56913
  }, {
56618
56914
  "code": {
56619
56915
  "integer": {
56620
- "value": 404
56916
+ "value": 401
56621
56917
  }
56622
56918
  },
56623
56919
  "type": "unit",
56624
- "description": "Resource was not found",
56920
+ "description": "Authorization failed",
56625
56921
  "attributes": []
56626
56922
  }, {
56627
56923
  "code": {
56628
56924
  "integer": {
56629
- "value": 422
56925
+ "value": 200
56630
56926
  }
56631
56927
  },
56632
- "type": "io.flow.error.v0.models.generic_error",
56633
- "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.",
56928
+ "type": "billing_statement_review",
56929
+ "description": "Successful response",
56634
56930
  "attributes": []
56635
56931
  }],
56636
56932
  "attributes": [],
@@ -58250,11 +58546,11 @@
58250
58546
  "responses": [{
58251
58547
  "code": {
58252
58548
  "integer": {
58253
- "value": 200
58549
+ "value": 404
58254
58550
  }
58255
58551
  },
58256
- "type": "account",
58257
- "description": "Successful response",
58552
+ "type": "unit",
58553
+ "description": "Resource was not found",
58258
58554
  "attributes": []
58259
58555
  }, {
58260
58556
  "code": {
@@ -58268,29 +58564,29 @@
58268
58564
  }, {
58269
58565
  "code": {
58270
58566
  "integer": {
58271
- "value": 401
58567
+ "value": 422
58272
58568
  }
58273
58569
  },
58274
- "type": "unit",
58275
- "description": "Authorization failed",
58570
+ "type": "io.flow.error.v0.models.generic_error",
58571
+ "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.",
58276
58572
  "attributes": []
58277
58573
  }, {
58278
58574
  "code": {
58279
58575
  "integer": {
58280
- "value": 404
58576
+ "value": 401
58281
58577
  }
58282
58578
  },
58283
58579
  "type": "unit",
58284
- "description": "Resource was not found",
58580
+ "description": "Authorization failed",
58285
58581
  "attributes": []
58286
58582
  }, {
58287
58583
  "code": {
58288
58584
  "integer": {
58289
- "value": 422
58585
+ "value": 200
58290
58586
  }
58291
58587
  },
58292
- "type": "io.flow.error.v0.models.generic_error",
58293
- "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.",
58588
+ "type": "account",
58589
+ "description": "Successful response",
58294
58590
  "attributes": []
58295
58591
  }],
58296
58592
  "attributes": [],
@@ -58315,46 +58611,46 @@
58315
58611
  "responses": [{
58316
58612
  "code": {
58317
58613
  "integer": {
58318
- "value": 204
58614
+ "value": 404
58319
58615
  }
58320
58616
  },
58321
58617
  "type": "unit",
58322
- "description": "Operation succeeded. No content is returned",
58618
+ "description": "Resource was not found",
58323
58619
  "attributes": []
58324
58620
  }, {
58325
58621
  "code": {
58326
58622
  "integer": {
58327
- "value": 409
58623
+ "value": 422
58328
58624
  }
58329
58625
  },
58330
58626
  "type": "io.flow.error.v0.models.generic_error",
58627
+ "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.",
58331
58628
  "attributes": []
58332
58629
  }, {
58333
58630
  "code": {
58334
58631
  "integer": {
58335
- "value": 401
58632
+ "value": 409
58336
58633
  }
58337
58634
  },
58338
- "type": "unit",
58339
- "description": "Authorization failed",
58635
+ "type": "io.flow.error.v0.models.generic_error",
58340
58636
  "attributes": []
58341
58637
  }, {
58342
58638
  "code": {
58343
58639
  "integer": {
58344
- "value": 404
58640
+ "value": 204
58345
58641
  }
58346
58642
  },
58347
58643
  "type": "unit",
58348
- "description": "Resource was not found",
58644
+ "description": "Operation succeeded. No content is returned",
58349
58645
  "attributes": []
58350
58646
  }, {
58351
58647
  "code": {
58352
58648
  "integer": {
58353
- "value": 422
58649
+ "value": 401
58354
58650
  }
58355
58651
  },
58356
- "type": "io.flow.error.v0.models.generic_error",
58357
- "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.",
58652
+ "type": "unit",
58653
+ "description": "Authorization failed",
58358
58654
  "attributes": []
58359
58655
  }],
58360
58656
  "attributes": []
@@ -58483,12 +58779,17 @@
58483
58779
  }],
58484
58780
  "path": ""
58485
58781
  }, {
58486
- "type": "channel_currency_setting",
58487
- "plural": "channel_currency_settings",
58782
+ "type": "channel_billing_statement",
58783
+ "plural": "channel_billing_statements",
58488
58784
  "operations": [{
58489
58785
  "method": "GET",
58490
- "path": "/internal/channel/currency/settings",
58786
+ "path": "/channel/:channel_id/account/statements",
58491
58787
  "parameters": [{
58788
+ "name": "channel_id",
58789
+ "type": "string",
58790
+ "location": "Path",
58791
+ "required": true
58792
+ }, {
58492
58793
  "name": "id",
58493
58794
  "type": "[string]",
58494
58795
  "location": "Query",
@@ -58496,16 +58797,16 @@
58496
58797
  "description": "Filter by one or more IDs of this resource",
58497
58798
  "maximum": 100
58498
58799
  }, {
58499
- "name": "channel",
58800
+ "name": "account_id",
58500
58801
  "type": "string",
58501
58802
  "location": "Query",
58502
- "required": false
58803
+ "required": false,
58804
+ "maximum": 100
58503
58805
  }, {
58504
- "name": "target",
58806
+ "name": "currency",
58505
58807
  "type": "string",
58506
58808
  "location": "Query",
58507
- "required": false,
58508
- "description": "Filter by the (case-insensitive) target currency's ISO 4217 3-character code as defined in https://api.flow.io/reference/currencies"
58809
+ "required": false
58509
58810
  }, {
58510
58811
  "name": "limit",
58511
58812
  "type": "long",
@@ -58528,7 +58829,7 @@
58528
58829
  "type": "string",
58529
58830
  "location": "Query",
58530
58831
  "required": true,
58531
- "default": "-created_at"
58832
+ "default": "-period_to"
58532
58833
  }],
58533
58834
  "responses": [{
58534
58835
  "code": {
@@ -58536,7 +58837,7 @@
58536
58837
  "value": 200
58537
58838
  }
58538
58839
  },
58539
- "type": "[channel_currency_setting]",
58840
+ "type": "[channel_billing_statement]",
58540
58841
  "description": "Successful response",
58541
58842
  "attributes": []
58542
58843
  }, {
@@ -58548,6 +58849,15 @@
58548
58849
  "type": "unit",
58549
58850
  "description": "Authorization failed",
58550
58851
  "attributes": []
58852
+ }, {
58853
+ "code": {
58854
+ "integer": {
58855
+ "value": 404
58856
+ }
58857
+ },
58858
+ "type": "unit",
58859
+ "description": "Resource was not found",
58860
+ "attributes": []
58551
58861
  }, {
58552
58862
  "code": {
58553
58863
  "integer": {
@@ -58564,104 +58874,30 @@
58564
58874
  "values": [{
58565
58875
  "value": "id"
58566
58876
  }, {
58567
- "value": "target"
58877
+ "value": "currency"
58878
+ }, {
58879
+ "value": "period_to"
58880
+ }, {
58881
+ "value": "period_from"
58568
58882
  }, {
58569
58883
  "value": "created_at"
58570
58884
  }]
58571
58885
  }
58572
- }],
58573
- "description": "Search channel currency settings. Always paginated."
58574
- }, {
58575
- "method": "POST",
58576
- "path": "/internal/channel/currency/settings",
58577
- "parameters": [],
58578
- "responses": [{
58579
- "code": {
58580
- "integer": {
58581
- "value": 201
58582
- }
58583
- },
58584
- "type": "channel_currency_setting",
58585
- "description": "Operation succeeded and the resource was created",
58586
- "attributes": []
58587
- }, {
58588
- "code": {
58589
- "integer": {
58590
- "value": 401
58591
- }
58592
- },
58593
- "type": "unit",
58594
- "description": "Authorization failed",
58595
- "attributes": []
58596
- }, {
58597
- "code": {
58598
- "integer": {
58599
- "value": 404
58600
- }
58601
- },
58602
- "type": "unit",
58603
- "description": "Resource was not found",
58604
- "attributes": []
58605
58886
  }, {
58606
- "code": {
58607
- "integer": {
58608
- "value": 422
58609
- }
58610
- },
58611
- "type": "io.flow.error.v0.models.generic_error",
58612
- "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.",
58613
- "attributes": []
58614
- }],
58615
- "attributes": [],
58616
- "description": "Create channel currency settings.",
58617
- "body": {
58618
- "type": "channel_currency_setting_form",
58619
- "attributes": []
58620
- }
58887
+ "name": "linter",
58888
+ "value": {
58889
+ "ignore": ["sort_parameter_default", "versions"]
58890
+ }
58891
+ }]
58621
58892
  }, {
58622
58893
  "method": "GET",
58623
- "path": "/internal/channel/currency/settings/:id",
58894
+ "path": "/channel/:channel_id/account/statements/:id",
58624
58895
  "parameters": [{
58625
- "name": "id",
58896
+ "name": "channel_id",
58626
58897
  "type": "string",
58627
58898
  "location": "Path",
58628
- "required": true,
58629
- "description": "Filter by one or more IDs of this resource"
58630
- }],
58631
- "responses": [{
58632
- "code": {
58633
- "integer": {
58634
- "value": 200
58635
- }
58636
- },
58637
- "type": "channel_currency_setting",
58638
- "description": "Successful response",
58639
- "attributes": []
58640
- }, {
58641
- "code": {
58642
- "integer": {
58643
- "value": 401
58644
- }
58645
- },
58646
- "type": "unit",
58647
- "description": "Authorization failed",
58648
- "attributes": []
58899
+ "required": true
58649
58900
  }, {
58650
- "code": {
58651
- "integer": {
58652
- "value": 404
58653
- }
58654
- },
58655
- "type": "unit",
58656
- "description": "Resource was not found",
58657
- "attributes": []
58658
- }],
58659
- "attributes": [],
58660
- "description": "Get channel currency settings."
58661
- }, {
58662
- "method": "PUT",
58663
- "path": "/internal/channel/currency/settings/:id",
58664
- "parameters": [{
58665
58901
  "name": "id",
58666
58902
  "type": "string",
58667
58903
  "location": "Path",
@@ -58674,7 +58910,7 @@
58674
58910
  "value": 200
58675
58911
  }
58676
58912
  },
58677
- "type": "channel_currency_setting",
58913
+ "type": "channel_billing_statement",
58678
58914
  "description": "Successful response",
58679
58915
  "attributes": []
58680
58916
  }, {
@@ -58695,26 +58931,17 @@
58695
58931
  "type": "unit",
58696
58932
  "description": "Resource was not found",
58697
58933
  "attributes": []
58698
- }, {
58699
- "code": {
58700
- "integer": {
58701
- "value": 422
58702
- }
58703
- },
58704
- "type": "io.flow.error.v0.models.generic_error",
58705
- "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.",
58706
- "attributes": []
58707
58934
  }],
58708
- "attributes": [],
58709
- "description": "Update an existing channel currency settings.",
58710
- "body": {
58711
- "type": "channel_currency_setting_form",
58712
- "attributes": []
58713
- }
58935
+ "attributes": []
58714
58936
  }, {
58715
58937
  "method": "DELETE",
58716
- "path": "/internal/channel/currency/settings/:id",
58938
+ "path": "/channel/:channel_id/account/statements/:id",
58717
58939
  "parameters": [{
58940
+ "name": "channel_id",
58941
+ "type": "string",
58942
+ "location": "Path",
58943
+ "required": true
58944
+ }, {
58718
58945
  "name": "id",
58719
58946
  "type": "string",
58720
58947
  "location": "Path",
@@ -58759,6 +58986,64 @@
58759
58986
  "attributes": []
58760
58987
  }],
58761
58988
  "attributes": []
58989
+ }, {
58990
+ "method": "POST",
58991
+ "path": "/channel/:channel_id/account/statements/:id/email",
58992
+ "parameters": [{
58993
+ "name": "channel_id",
58994
+ "type": "string",
58995
+ "location": "Path",
58996
+ "required": true
58997
+ }, {
58998
+ "name": "id",
58999
+ "type": "string",
59000
+ "location": "Path",
59001
+ "required": true,
59002
+ "description": "Filter by one or more IDs of this resource"
59003
+ }],
59004
+ "responses": [{
59005
+ "code": {
59006
+ "integer": {
59007
+ "value": 204
59008
+ }
59009
+ },
59010
+ "type": "unit",
59011
+ "description": "Operation succeeded. No content is returned",
59012
+ "attributes": []
59013
+ }, {
59014
+ "code": {
59015
+ "integer": {
59016
+ "value": 401
59017
+ }
59018
+ },
59019
+ "type": "unit",
59020
+ "description": "Authorization failed",
59021
+ "attributes": []
59022
+ }, {
59023
+ "code": {
59024
+ "integer": {
59025
+ "value": 404
59026
+ }
59027
+ },
59028
+ "type": "unit",
59029
+ "description": "Resource was not found",
59030
+ "attributes": []
59031
+ }, {
59032
+ "code": {
59033
+ "integer": {
59034
+ "value": 422
59035
+ }
59036
+ },
59037
+ "type": "io.flow.error.v0.models.generic_error",
59038
+ "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.",
59039
+ "attributes": []
59040
+ }],
59041
+ "attributes": [],
59042
+ "description": "Generates and sends an email about this statement",
59043
+ "body": {
59044
+ "type": "email_form",
59045
+ "attributes": []
59046
+ }
58762
59047
  }],
58763
59048
  "attributes": [{
58764
59049
  "name": "docs",
@@ -58766,13 +59051,13 @@
58766
59051
  "module": "general"
58767
59052
  }
58768
59053
  }],
58769
- "path": "/internal/channel/currency/settings"
59054
+ "path": "/channel/:channel_id/account/statements"
58770
59055
  }, {
58771
- "type": "channel_membership",
58772
- "plural": "channel_memberships",
59056
+ "type": "channel_currency_setting",
59057
+ "plural": "channel_currency_settings",
58773
59058
  "operations": [{
58774
59059
  "method": "GET",
58775
- "path": "/internal/channel/memberships",
59060
+ "path": "/internal/channel/currency/settings",
58776
59061
  "parameters": [{
58777
59062
  "name": "id",
58778
59063
  "type": "[string]",
@@ -58780,27 +59065,17 @@
58780
59065
  "required": false,
58781
59066
  "description": "Filter by one or more IDs of this resource",
58782
59067
  "maximum": 100
58783
- }, {
58784
- "name": "user",
58785
- "type": "string",
58786
- "location": "Query",
58787
- "required": false,
58788
- "description": "Find memberships for this user id",
58789
- "maximum": 100
58790
59068
  }, {
58791
59069
  "name": "channel",
58792
59070
  "type": "string",
58793
59071
  "location": "Query",
58794
- "required": false,
58795
- "description": "Find memberships for this channel id",
58796
- "maximum": 100
59072
+ "required": false
58797
59073
  }, {
58798
- "name": "role",
58799
- "type": "[string]",
59074
+ "name": "target",
59075
+ "type": "string",
58800
59076
  "location": "Query",
58801
59077
  "required": false,
58802
- "description": "Find memberships with ANY of these roles.",
58803
- "maximum": 100
59078
+ "description": "Filter by the (case-insensitive) target currency's ISO 4217 3-character code as defined in https://api.flow.io/reference/currencies"
58804
59079
  }, {
58805
59080
  "name": "limit",
58806
59081
  "type": "long",
@@ -58824,14 +59099,6 @@
58824
59099
  "location": "Query",
58825
59100
  "required": true,
58826
59101
  "default": "-created_at"
58827
- }, {
58828
- "name": "expand",
58829
- "type": "[string]",
58830
- "location": "Query",
58831
- "required": false,
58832
- "minimum": 0,
58833
- "maximum": 1,
58834
- "example": "user"
58835
59102
  }],
58836
59103
  "responses": [{
58837
59104
  "code": {
@@ -58839,7 +59106,7 @@
58839
59106
  "value": 200
58840
59107
  }
58841
59108
  },
58842
- "type": "[channel_membership]",
59109
+ "type": "[channel_currency_setting]",
58843
59110
  "description": "Successful response",
58844
59111
  "attributes": []
58845
59112
  }, {
@@ -58867,20 +59134,16 @@
58867
59134
  "values": [{
58868
59135
  "value": "id"
58869
59136
  }, {
58870
- "value": "user"
58871
- }, {
58872
- "value": "channel"
58873
- }, {
58874
- "value": "role"
59137
+ "value": "target"
58875
59138
  }, {
58876
59139
  "value": "created_at"
58877
59140
  }]
58878
59141
  }
58879
59142
  }],
58880
- "description": "Search memberships. Always paginated."
59143
+ "description": "Search channel currency settings. Always paginated."
58881
59144
  }, {
58882
59145
  "method": "POST",
58883
- "path": "/internal/channel/memberships",
59146
+ "path": "/internal/channel/currency/settings",
58884
59147
  "parameters": [],
58885
59148
  "responses": [{
58886
59149
  "code": {
@@ -58888,7 +59151,7 @@
58888
59151
  "value": 201
58889
59152
  }
58890
59153
  },
58891
- "type": "channel_membership",
59154
+ "type": "channel_currency_setting",
58892
59155
  "description": "Operation succeeded and the resource was created",
58893
59156
  "attributes": []
58894
59157
  }, {
@@ -58920,14 +59183,14 @@
58920
59183
  "attributes": []
58921
59184
  }],
58922
59185
  "attributes": [],
58923
- "description": "Create a new membership.",
59186
+ "description": "Create channel currency settings.",
58924
59187
  "body": {
58925
- "type": "channel_membership_form",
59188
+ "type": "channel_currency_setting_form",
58926
59189
  "attributes": []
58927
59190
  }
58928
59191
  }, {
58929
59192
  "method": "GET",
58930
- "path": "/internal/channel/memberships/:id",
59193
+ "path": "/internal/channel/currency/settings/:id",
58931
59194
  "parameters": [{
58932
59195
  "name": "id",
58933
59196
  "type": "string",
@@ -58941,7 +59204,7 @@
58941
59204
  "value": 200
58942
59205
  }
58943
59206
  },
58944
- "type": "channel_membership",
59207
+ "type": "channel_currency_setting",
58945
59208
  "description": "Successful response",
58946
59209
  "attributes": []
58947
59210
  }, {
@@ -58964,10 +59227,10 @@
58964
59227
  "attributes": []
58965
59228
  }],
58966
59229
  "attributes": [],
58967
- "description": "Returns information about a specific membership."
59230
+ "description": "Get channel currency settings."
58968
59231
  }, {
58969
59232
  "method": "PUT",
58970
- "path": "/internal/channel/memberships/:id",
59233
+ "path": "/internal/channel/currency/settings/:id",
58971
59234
  "parameters": [{
58972
59235
  "name": "id",
58973
59236
  "type": "string",
@@ -58981,7 +59244,7 @@
58981
59244
  "value": 200
58982
59245
  }
58983
59246
  },
58984
- "type": "channel_membership",
59247
+ "type": "channel_currency_setting",
58985
59248
  "description": "Successful response",
58986
59249
  "attributes": []
58987
59250
  }, {
@@ -59013,14 +59276,14 @@
59013
59276
  "attributes": []
59014
59277
  }],
59015
59278
  "attributes": [],
59016
- "description": "Change the role for a specific membership record.",
59279
+ "description": "Update an existing channel currency settings.",
59017
59280
  "body": {
59018
- "type": "channel_membership_put_form",
59281
+ "type": "channel_currency_setting_form",
59019
59282
  "attributes": []
59020
59283
  }
59021
59284
  }, {
59022
59285
  "method": "DELETE",
59023
- "path": "/internal/channel/memberships/:id",
59286
+ "path": "/internal/channel/currency/settings/:id",
59024
59287
  "parameters": [{
59025
59288
  "name": "id",
59026
59289
  "type": "string",
@@ -59073,14 +59336,13 @@
59073
59336
  "module": "general"
59074
59337
  }
59075
59338
  }],
59076
- "path": "/internal/channel/memberships",
59077
- "description": "Represents the users that are part of this channel. Primary purpose is to manage which users have access to the channel's token(s)."
59339
+ "path": "/internal/channel/currency/settings"
59078
59340
  }, {
59079
- "type": "channel_order_acceptance",
59080
- "plural": "channel_order_acceptances",
59341
+ "type": "channel_membership",
59342
+ "plural": "channel_memberships",
59081
59343
  "operations": [{
59082
59344
  "method": "GET",
59083
- "path": "/internal/shopify/markets/orders/acceptance",
59345
+ "path": "/internal/channel/memberships",
59084
59346
  "parameters": [{
59085
59347
  "name": "id",
59086
59348
  "type": "[string]",
@@ -59089,37 +59351,26 @@
59089
59351
  "description": "Filter by one or more IDs of this resource",
59090
59352
  "maximum": 100
59091
59353
  }, {
59092
- "name": "channel_id",
59093
- "type": "string",
59094
- "location": "Query",
59095
- "required": false
59096
- }, {
59097
- "name": "organization_id",
59098
- "type": "string",
59099
- "location": "Query",
59100
- "required": false
59101
- }, {
59102
- "name": "number",
59354
+ "name": "user",
59103
59355
  "type": "string",
59104
59356
  "location": "Query",
59105
59357
  "required": false,
59106
- "description": "order number"
59107
- }, {
59108
- "name": "external_order_reference",
59109
- "type": "string",
59110
- "location": "Query",
59111
- "required": false
59358
+ "description": "Find memberships for this user id",
59359
+ "maximum": 100
59112
59360
  }, {
59113
- "name": "payment_request_id",
59361
+ "name": "channel",
59114
59362
  "type": "string",
59115
59363
  "location": "Query",
59116
- "required": false
59364
+ "required": false,
59365
+ "description": "Find memberships for this channel id",
59366
+ "maximum": 100
59117
59367
  }, {
59118
- "name": "status",
59119
- "type": "channel_order_acceptance_status",
59368
+ "name": "role",
59369
+ "type": "[string]",
59120
59370
  "location": "Query",
59121
59371
  "required": false,
59122
- "description": "current order acceptance status"
59372
+ "description": "Find memberships with ANY of these roles.",
59373
+ "maximum": 100
59123
59374
  }, {
59124
59375
  "name": "limit",
59125
59376
  "type": "long",
@@ -59143,6 +59394,14 @@
59143
59394
  "location": "Query",
59144
59395
  "required": true,
59145
59396
  "default": "-created_at"
59397
+ }, {
59398
+ "name": "expand",
59399
+ "type": "[string]",
59400
+ "location": "Query",
59401
+ "required": false,
59402
+ "minimum": 0,
59403
+ "maximum": 1,
59404
+ "example": "user"
59146
59405
  }],
59147
59406
  "responses": [{
59148
59407
  "code": {
@@ -59150,7 +59409,7 @@
59150
59409
  "value": 200
59151
59410
  }
59152
59411
  },
59153
- "type": "[channel_order_acceptance]",
59412
+ "type": "[channel_membership]",
59154
59413
  "description": "Successful response",
59155
59414
  "attributes": []
59156
59415
  }, {
@@ -59162,15 +59421,6 @@
59162
59421
  "type": "unit",
59163
59422
  "description": "Authorization failed",
59164
59423
  "attributes": []
59165
- }, {
59166
- "code": {
59167
- "integer": {
59168
- "value": 404
59169
- }
59170
- },
59171
- "type": "unit",
59172
- "description": "Resource was not found",
59173
- "attributes": []
59174
59424
  }, {
59175
59425
  "code": {
59176
59426
  "integer": {
@@ -59185,41 +59435,30 @@
59185
59435
  "name": "sort",
59186
59436
  "value": {
59187
59437
  "values": [{
59188
- "value": "channel_id"
59438
+ "value": "id"
59189
59439
  }, {
59190
- "value": "organization_id"
59440
+ "value": "user"
59191
59441
  }, {
59192
- "value": "status"
59442
+ "value": "channel"
59443
+ }, {
59444
+ "value": "role"
59445
+ }, {
59446
+ "value": "created_at"
59193
59447
  }]
59194
59448
  }
59195
59449
  }],
59196
- "description": "Retrieves acceptance status of shopify markets orders. Always paginated."
59450
+ "description": "Search memberships. Always paginated."
59197
59451
  }, {
59198
- "method": "PUT",
59199
- "path": "/internal/shopify/markets/orders/acceptance/:id",
59200
- "parameters": [{
59201
- "name": "id",
59202
- "type": "string",
59203
- "location": "Path",
59204
- "required": true,
59205
- "description": "Filter by one or more IDs of this resource"
59206
- }],
59452
+ "method": "POST",
59453
+ "path": "/internal/channel/memberships",
59454
+ "parameters": [],
59207
59455
  "responses": [{
59208
- "code": {
59209
- "integer": {
59210
- "value": 200
59211
- }
59212
- },
59213
- "type": "channel_order_acceptance",
59214
- "description": "Successful response",
59215
- "attributes": []
59216
- }, {
59217
59456
  "code": {
59218
59457
  "integer": {
59219
59458
  "value": 201
59220
59459
  }
59221
59460
  },
59222
- "type": "channel_order_acceptance",
59461
+ "type": "channel_membership",
59223
59462
  "description": "Operation succeeded and the resource was created",
59224
59463
  "attributes": []
59225
59464
  }, {
@@ -59251,40 +59490,29 @@
59251
59490
  "attributes": []
59252
59491
  }],
59253
59492
  "attributes": [],
59254
- "description": "Enable reviewers to update the channel order acceptance status.",
59493
+ "description": "Create a new membership.",
59255
59494
  "body": {
59256
- "type": "channel_order_acceptance_form",
59495
+ "type": "channel_membership_form",
59257
59496
  "attributes": []
59258
59497
  }
59259
- }],
59260
- "attributes": [{
59261
- "name": "docs",
59262
- "value": {
59263
- "module": "general"
59264
- }
59265
- }],
59266
- "path": "/internal/shopify/markets/orders/acceptance",
59267
- "description": "Support Shopify order acceptance workflow."
59268
- }, {
59269
- "type": "channel_organization_shopify",
59270
- "plural": "channel_organization_shopify",
59271
- "operations": [{
59272
- "method": "POST",
59273
- "path": "/channel/:channel_id/organizations/shopify/install",
59498
+ }, {
59499
+ "method": "GET",
59500
+ "path": "/internal/channel/memberships/:id",
59274
59501
  "parameters": [{
59275
- "name": "channel_id",
59502
+ "name": "id",
59276
59503
  "type": "string",
59277
59504
  "location": "Path",
59278
- "required": true
59505
+ "required": true,
59506
+ "description": "Filter by one or more IDs of this resource"
59279
59507
  }],
59280
59508
  "responses": [{
59281
59509
  "code": {
59282
59510
  "integer": {
59283
- "value": 201
59511
+ "value": 200
59284
59512
  }
59285
59513
  },
59286
- "type": "channel_organization_shopify",
59287
- "description": "Operation succeeded and the resource was created",
59514
+ "type": "channel_membership",
59515
+ "description": "Successful response",
59288
59516
  "attributes": []
59289
59517
  }, {
59290
59518
  "code": {
@@ -59304,34 +59532,18 @@
59304
59532
  "type": "unit",
59305
59533
  "description": "Resource was not found",
59306
59534
  "attributes": []
59307
- }, {
59308
- "code": {
59309
- "integer": {
59310
- "value": 422
59311
- }
59312
- },
59313
- "type": "io.flow.error.v0.models.generic_error",
59314
- "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.",
59315
- "attributes": []
59316
59535
  }],
59317
59536
  "attributes": [],
59318
- "body": {
59319
- "type": "channel_organization_shopify_post_form",
59320
- "attributes": []
59321
- }
59537
+ "description": "Returns information about a specific membership."
59322
59538
  }, {
59323
59539
  "method": "PUT",
59324
- "path": "/channel/:channel_id/organizations/shopify/install/:key",
59540
+ "path": "/internal/channel/memberships/:id",
59325
59541
  "parameters": [{
59326
- "name": "channel_id",
59327
- "type": "string",
59328
- "location": "Path",
59329
- "required": true
59330
- }, {
59331
- "name": "key",
59542
+ "name": "id",
59332
59543
  "type": "string",
59333
59544
  "location": "Path",
59334
- "required": true
59545
+ "required": true,
59546
+ "description": "Filter by one or more IDs of this resource"
59335
59547
  }],
59336
59548
  "responses": [{
59337
59549
  "code": {
@@ -59339,18 +59551,376 @@
59339
59551
  "value": 200
59340
59552
  }
59341
59553
  },
59342
- "type": "channel_organization_shopify",
59554
+ "type": "channel_membership",
59343
59555
  "description": "Successful response",
59344
59556
  "attributes": []
59345
- }, {
59346
- "code": {
59347
- "integer": {
59348
- "value": 201
59349
- }
59350
- },
59351
- "type": "channel_organization_shopify",
59352
- "description": "Operation succeeded and the resource was created",
59353
- "attributes": []
59557
+ }, {
59558
+ "code": {
59559
+ "integer": {
59560
+ "value": 401
59561
+ }
59562
+ },
59563
+ "type": "unit",
59564
+ "description": "Authorization failed",
59565
+ "attributes": []
59566
+ }, {
59567
+ "code": {
59568
+ "integer": {
59569
+ "value": 404
59570
+ }
59571
+ },
59572
+ "type": "unit",
59573
+ "description": "Resource was not found",
59574
+ "attributes": []
59575
+ }, {
59576
+ "code": {
59577
+ "integer": {
59578
+ "value": 422
59579
+ }
59580
+ },
59581
+ "type": "io.flow.error.v0.models.generic_error",
59582
+ "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.",
59583
+ "attributes": []
59584
+ }],
59585
+ "attributes": [],
59586
+ "description": "Change the role for a specific membership record.",
59587
+ "body": {
59588
+ "type": "channel_membership_put_form",
59589
+ "attributes": []
59590
+ }
59591
+ }, {
59592
+ "method": "DELETE",
59593
+ "path": "/internal/channel/memberships/:id",
59594
+ "parameters": [{
59595
+ "name": "id",
59596
+ "type": "string",
59597
+ "location": "Path",
59598
+ "required": true,
59599
+ "description": "Filter by one or more IDs of this resource"
59600
+ }],
59601
+ "responses": [{
59602
+ "code": {
59603
+ "integer": {
59604
+ "value": 204
59605
+ }
59606
+ },
59607
+ "type": "unit",
59608
+ "description": "Operation succeeded. No content is returned",
59609
+ "attributes": []
59610
+ }, {
59611
+ "code": {
59612
+ "integer": {
59613
+ "value": 401
59614
+ }
59615
+ },
59616
+ "type": "unit",
59617
+ "description": "Authorization failed",
59618
+ "attributes": []
59619
+ }, {
59620
+ "code": {
59621
+ "integer": {
59622
+ "value": 404
59623
+ }
59624
+ },
59625
+ "type": "unit",
59626
+ "description": "Resource was not found",
59627
+ "attributes": []
59628
+ }, {
59629
+ "code": {
59630
+ "integer": {
59631
+ "value": 422
59632
+ }
59633
+ },
59634
+ "type": "io.flow.error.v0.models.generic_error",
59635
+ "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.",
59636
+ "attributes": []
59637
+ }],
59638
+ "attributes": []
59639
+ }],
59640
+ "attributes": [{
59641
+ "name": "docs",
59642
+ "value": {
59643
+ "module": "general"
59644
+ }
59645
+ }],
59646
+ "path": "/internal/channel/memberships",
59647
+ "description": "Represents the users that are part of this channel. Primary purpose is to manage which users have access to the channel's token(s)."
59648
+ }, {
59649
+ "type": "channel_order_acceptance",
59650
+ "plural": "channel_order_acceptances",
59651
+ "operations": [{
59652
+ "method": "GET",
59653
+ "path": "/internal/shopify/markets/orders/acceptance",
59654
+ "parameters": [{
59655
+ "name": "id",
59656
+ "type": "[string]",
59657
+ "location": "Query",
59658
+ "required": false,
59659
+ "description": "Filter by one or more IDs of this resource",
59660
+ "maximum": 100
59661
+ }, {
59662
+ "name": "channel_id",
59663
+ "type": "string",
59664
+ "location": "Query",
59665
+ "required": false
59666
+ }, {
59667
+ "name": "organization_id",
59668
+ "type": "string",
59669
+ "location": "Query",
59670
+ "required": false
59671
+ }, {
59672
+ "name": "number",
59673
+ "type": "string",
59674
+ "location": "Query",
59675
+ "required": false,
59676
+ "description": "order number"
59677
+ }, {
59678
+ "name": "external_order_reference",
59679
+ "type": "string",
59680
+ "location": "Query",
59681
+ "required": false
59682
+ }, {
59683
+ "name": "payment_request_id",
59684
+ "type": "string",
59685
+ "location": "Query",
59686
+ "required": false
59687
+ }, {
59688
+ "name": "status",
59689
+ "type": "channel_order_acceptance_status",
59690
+ "location": "Query",
59691
+ "required": false,
59692
+ "description": "current order acceptance status"
59693
+ }, {
59694
+ "name": "limit",
59695
+ "type": "long",
59696
+ "location": "Query",
59697
+ "required": true,
59698
+ "description": "The maximum number of results to return",
59699
+ "default": "25",
59700
+ "minimum": 1,
59701
+ "maximum": 100
59702
+ }, {
59703
+ "name": "offset",
59704
+ "type": "long",
59705
+ "location": "Query",
59706
+ "required": true,
59707
+ "description": "The number of results to skip before returning results",
59708
+ "default": "0",
59709
+ "minimum": 0
59710
+ }, {
59711
+ "name": "sort",
59712
+ "type": "string",
59713
+ "location": "Query",
59714
+ "required": true,
59715
+ "default": "-created_at"
59716
+ }],
59717
+ "responses": [{
59718
+ "code": {
59719
+ "integer": {
59720
+ "value": 200
59721
+ }
59722
+ },
59723
+ "type": "[channel_order_acceptance]",
59724
+ "description": "Successful response",
59725
+ "attributes": []
59726
+ }, {
59727
+ "code": {
59728
+ "integer": {
59729
+ "value": 401
59730
+ }
59731
+ },
59732
+ "type": "unit",
59733
+ "description": "Authorization failed",
59734
+ "attributes": []
59735
+ }, {
59736
+ "code": {
59737
+ "integer": {
59738
+ "value": 404
59739
+ }
59740
+ },
59741
+ "type": "unit",
59742
+ "description": "Resource was not found",
59743
+ "attributes": []
59744
+ }, {
59745
+ "code": {
59746
+ "integer": {
59747
+ "value": 422
59748
+ }
59749
+ },
59750
+ "type": "io.flow.error.v0.models.generic_error",
59751
+ "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.",
59752
+ "attributes": []
59753
+ }],
59754
+ "attributes": [{
59755
+ "name": "sort",
59756
+ "value": {
59757
+ "values": [{
59758
+ "value": "channel_id"
59759
+ }, {
59760
+ "value": "organization_id"
59761
+ }, {
59762
+ "value": "status"
59763
+ }]
59764
+ }
59765
+ }],
59766
+ "description": "Retrieves acceptance status of shopify markets orders. Always paginated."
59767
+ }, {
59768
+ "method": "PUT",
59769
+ "path": "/internal/shopify/markets/orders/acceptance/:id",
59770
+ "parameters": [{
59771
+ "name": "id",
59772
+ "type": "string",
59773
+ "location": "Path",
59774
+ "required": true,
59775
+ "description": "Filter by one or more IDs of this resource"
59776
+ }],
59777
+ "responses": [{
59778
+ "code": {
59779
+ "integer": {
59780
+ "value": 200
59781
+ }
59782
+ },
59783
+ "type": "channel_order_acceptance",
59784
+ "description": "Successful response",
59785
+ "attributes": []
59786
+ }, {
59787
+ "code": {
59788
+ "integer": {
59789
+ "value": 201
59790
+ }
59791
+ },
59792
+ "type": "channel_order_acceptance",
59793
+ "description": "Operation succeeded and the resource was created",
59794
+ "attributes": []
59795
+ }, {
59796
+ "code": {
59797
+ "integer": {
59798
+ "value": 401
59799
+ }
59800
+ },
59801
+ "type": "unit",
59802
+ "description": "Authorization failed",
59803
+ "attributes": []
59804
+ }, {
59805
+ "code": {
59806
+ "integer": {
59807
+ "value": 404
59808
+ }
59809
+ },
59810
+ "type": "unit",
59811
+ "description": "Resource was not found",
59812
+ "attributes": []
59813
+ }, {
59814
+ "code": {
59815
+ "integer": {
59816
+ "value": 422
59817
+ }
59818
+ },
59819
+ "type": "io.flow.error.v0.models.generic_error",
59820
+ "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.",
59821
+ "attributes": []
59822
+ }],
59823
+ "attributes": [],
59824
+ "description": "Enable reviewers to update the channel order acceptance status.",
59825
+ "body": {
59826
+ "type": "channel_order_acceptance_form",
59827
+ "attributes": []
59828
+ }
59829
+ }],
59830
+ "attributes": [{
59831
+ "name": "docs",
59832
+ "value": {
59833
+ "module": "general"
59834
+ }
59835
+ }],
59836
+ "path": "/internal/shopify/markets/orders/acceptance",
59837
+ "description": "Support Shopify order acceptance workflow."
59838
+ }, {
59839
+ "type": "channel_organization_shopify",
59840
+ "plural": "channel_organization_shopify",
59841
+ "operations": [{
59842
+ "method": "POST",
59843
+ "path": "/channel/:channel_id/organizations/shopify/install",
59844
+ "parameters": [{
59845
+ "name": "channel_id",
59846
+ "type": "string",
59847
+ "location": "Path",
59848
+ "required": true
59849
+ }],
59850
+ "responses": [{
59851
+ "code": {
59852
+ "integer": {
59853
+ "value": 201
59854
+ }
59855
+ },
59856
+ "type": "channel_organization_shopify",
59857
+ "description": "Operation succeeded and the resource was created",
59858
+ "attributes": []
59859
+ }, {
59860
+ "code": {
59861
+ "integer": {
59862
+ "value": 401
59863
+ }
59864
+ },
59865
+ "type": "unit",
59866
+ "description": "Authorization failed",
59867
+ "attributes": []
59868
+ }, {
59869
+ "code": {
59870
+ "integer": {
59871
+ "value": 404
59872
+ }
59873
+ },
59874
+ "type": "unit",
59875
+ "description": "Resource was not found",
59876
+ "attributes": []
59877
+ }, {
59878
+ "code": {
59879
+ "integer": {
59880
+ "value": 422
59881
+ }
59882
+ },
59883
+ "type": "io.flow.error.v0.models.generic_error",
59884
+ "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.",
59885
+ "attributes": []
59886
+ }],
59887
+ "attributes": [],
59888
+ "body": {
59889
+ "type": "channel_organization_shopify_post_form",
59890
+ "attributes": []
59891
+ }
59892
+ }, {
59893
+ "method": "PUT",
59894
+ "path": "/channel/:channel_id/organizations/shopify/install/:key",
59895
+ "parameters": [{
59896
+ "name": "channel_id",
59897
+ "type": "string",
59898
+ "location": "Path",
59899
+ "required": true
59900
+ }, {
59901
+ "name": "key",
59902
+ "type": "string",
59903
+ "location": "Path",
59904
+ "required": true
59905
+ }],
59906
+ "responses": [{
59907
+ "code": {
59908
+ "integer": {
59909
+ "value": 200
59910
+ }
59911
+ },
59912
+ "type": "channel_organization_shopify",
59913
+ "description": "Successful response",
59914
+ "attributes": []
59915
+ }, {
59916
+ "code": {
59917
+ "integer": {
59918
+ "value": 201
59919
+ }
59920
+ },
59921
+ "type": "channel_organization_shopify",
59922
+ "description": "Operation succeeded and the resource was created",
59923
+ "attributes": []
59354
59924
  }, {
59355
59925
  "code": {
59356
59926
  "integer": {
@@ -76059,6 +76629,94 @@
76059
76629
  }
76060
76630
  }],
76061
76631
  "path": "/internal/:organization_id/onboarding/audit"
76632
+ }, {
76633
+ "type": "onboarding_audit_snapshot",
76634
+ "plural": "onboarding_audit_snapshots",
76635
+ "operations": [{
76636
+ "method": "GET",
76637
+ "path": "/internal/:organization_id/onboarding/audit/snapshots",
76638
+ "parameters": [{
76639
+ "name": "organization_id",
76640
+ "type": "string",
76641
+ "location": "Path",
76642
+ "required": true
76643
+ }, {
76644
+ "name": "id",
76645
+ "type": "[string]",
76646
+ "location": "Query",
76647
+ "required": false,
76648
+ "description": "Filter by one or more IDs of this resource",
76649
+ "maximum": 100
76650
+ }, {
76651
+ "name": "limit",
76652
+ "type": "long",
76653
+ "location": "Query",
76654
+ "required": true,
76655
+ "description": "The maximum number of results to return",
76656
+ "default": "25",
76657
+ "minimum": 1,
76658
+ "maximum": 100
76659
+ }, {
76660
+ "name": "offset",
76661
+ "type": "long",
76662
+ "location": "Query",
76663
+ "required": true,
76664
+ "description": "The number of results to skip before returning results",
76665
+ "default": "0",
76666
+ "minimum": 0
76667
+ }],
76668
+ "responses": [{
76669
+ "code": {
76670
+ "integer": {
76671
+ "value": 200
76672
+ }
76673
+ },
76674
+ "type": "[onboarding_audit_snapshot]",
76675
+ "description": "Successful response",
76676
+ "attributes": []
76677
+ }, {
76678
+ "code": {
76679
+ "integer": {
76680
+ "value": 401
76681
+ }
76682
+ },
76683
+ "type": "unit",
76684
+ "description": "Authorization failed",
76685
+ "attributes": []
76686
+ }, {
76687
+ "code": {
76688
+ "integer": {
76689
+ "value": 404
76690
+ }
76691
+ },
76692
+ "type": "unit",
76693
+ "description": "Resource was not found",
76694
+ "attributes": []
76695
+ }, {
76696
+ "code": {
76697
+ "integer": {
76698
+ "value": 422
76699
+ }
76700
+ },
76701
+ "type": "io.flow.error.v0.models.generic_error",
76702
+ "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.",
76703
+ "attributes": []
76704
+ }],
76705
+ "attributes": [{
76706
+ "name": "linter",
76707
+ "value": {
76708
+ "ignore": ["sort"]
76709
+ }
76710
+ }],
76711
+ "description": "Returns historical organization audit snapshots sorted by created_at desc."
76712
+ }],
76713
+ "attributes": [{
76714
+ "name": "docs",
76715
+ "value": {
76716
+ "module": "general"
76717
+ }
76718
+ }],
76719
+ "path": "/internal/:organization_id/onboarding/audit/snapshots"
76062
76720
  }, {
76063
76721
  "type": "optin_attribute",
76064
76722
  "plural": "optin_attributes",
@@ -77592,11 +78250,11 @@
77592
78250
  "responses": [{
77593
78251
  "code": {
77594
78252
  "integer": {
77595
- "value": 200
78253
+ "value": 404
77596
78254
  }
77597
78255
  },
77598
- "type": "account",
77599
- "description": "Successful response",
78256
+ "type": "unit",
78257
+ "description": "Resource was not found",
77600
78258
  "attributes": []
77601
78259
  }, {
77602
78260
  "code": {
@@ -77610,29 +78268,29 @@
77610
78268
  }, {
77611
78269
  "code": {
77612
78270
  "integer": {
77613
- "value": 401
78271
+ "value": 422
77614
78272
  }
77615
78273
  },
77616
- "type": "unit",
77617
- "description": "Authorization failed",
78274
+ "type": "io.flow.error.v0.models.generic_error",
78275
+ "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.",
77618
78276
  "attributes": []
77619
78277
  }, {
77620
78278
  "code": {
77621
78279
  "integer": {
77622
- "value": 404
78280
+ "value": 401
77623
78281
  }
77624
78282
  },
77625
78283
  "type": "unit",
77626
- "description": "Resource was not found",
78284
+ "description": "Authorization failed",
77627
78285
  "attributes": []
77628
78286
  }, {
77629
78287
  "code": {
77630
78288
  "integer": {
77631
- "value": 422
78289
+ "value": 200
77632
78290
  }
77633
78291
  },
77634
- "type": "io.flow.error.v0.models.generic_error",
77635
- "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.",
78292
+ "type": "account",
78293
+ "description": "Successful response",
77636
78294
  "attributes": []
77637
78295
  }],
77638
78296
  "attributes": [],
@@ -77656,32 +78314,6 @@
77656
78314
  "required": true
77657
78315
  }],
77658
78316
  "responses": [{
77659
- "code": {
77660
- "integer": {
77661
- "value": 204
77662
- }
77663
- },
77664
- "type": "unit",
77665
- "description": "Operation succeeded. No content is returned",
77666
- "attributes": []
77667
- }, {
77668
- "code": {
77669
- "integer": {
77670
- "value": 409
77671
- }
77672
- },
77673
- "type": "io.flow.error.v0.models.generic_error",
77674
- "attributes": []
77675
- }, {
77676
- "code": {
77677
- "integer": {
77678
- "value": 401
77679
- }
77680
- },
77681
- "type": "unit",
77682
- "description": "Authorization failed",
77683
- "attributes": []
77684
- }, {
77685
78317
  "code": {
77686
78318
  "integer": {
77687
78319
  "value": 404
@@ -77699,88 +78331,15 @@
77699
78331
  "type": "io.flow.error.v0.models.generic_error",
77700
78332
  "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.",
77701
78333
  "attributes": []
77702
- }],
77703
- "attributes": []
77704
- }, {
77705
- "method": "POST",
77706
- "path": "/internal/:organization/accounts/:currency/transactions/manual",
77707
- "parameters": [{
77708
- "name": "organization",
77709
- "type": "string",
77710
- "location": "Path",
77711
- "required": true,
77712
- "description": "Refers to your organization's account identifier"
77713
- }, {
77714
- "name": "currency",
77715
- "type": "string",
77716
- "location": "Path",
77717
- "required": true
77718
- }],
77719
- "responses": [{
77720
- "code": {
77721
- "integer": {
77722
- "value": 201
77723
- }
77724
- },
77725
- "type": "manual_transaction",
77726
- "description": "Operation succeeded and the resource was created",
77727
- "attributes": []
77728
- }, {
77729
- "code": {
77730
- "integer": {
77731
- "value": 401
77732
- }
77733
- },
77734
- "type": "unit",
77735
- "description": "Authorization failed",
77736
- "attributes": []
77737
- }, {
77738
- "code": {
77739
- "integer": {
77740
- "value": 404
77741
- }
77742
- },
77743
- "type": "unit",
77744
- "description": "Resource was not found",
77745
- "attributes": []
77746
78334
  }, {
77747
78335
  "code": {
77748
78336
  "integer": {
77749
- "value": 422
78337
+ "value": 409
77750
78338
  }
77751
78339
  },
77752
78340
  "type": "io.flow.error.v0.models.generic_error",
77753
- "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.",
77754
78341
  "attributes": []
77755
- }],
77756
- "attributes": [],
77757
- "description": "Creates a manual transaction for this account",
77758
- "body": {
77759
- "type": "manual_transaction_form",
77760
- "attributes": []
77761
- }
77762
- }, {
77763
- "method": "DELETE",
77764
- "path": "/internal/:organization/accounts/:currency/transactions/manual/:id",
77765
- "parameters": [{
77766
- "name": "organization",
77767
- "type": "string",
77768
- "location": "Path",
77769
- "required": true,
77770
- "description": "Refers to your organization's account identifier"
77771
78342
  }, {
77772
- "name": "currency",
77773
- "type": "string",
77774
- "location": "Path",
77775
- "required": true
77776
- }, {
77777
- "name": "id",
77778
- "type": "string",
77779
- "location": "Path",
77780
- "required": true,
77781
- "description": "Filter by one or more IDs of this resource"
77782
- }],
77783
- "responses": [{
77784
78343
  "code": {
77785
78344
  "integer": {
77786
78345
  "value": 204
@@ -77798,81 +78357,180 @@
77798
78357
  "type": "unit",
77799
78358
  "description": "Authorization failed",
77800
78359
  "attributes": []
77801
- }, {
77802
- "code": {
77803
- "integer": {
77804
- "value": 404
77805
- }
77806
- },
77807
- "type": "unit",
77808
- "description": "Resource was not found",
77809
- "attributes": []
77810
- }, {
77811
- "code": {
77812
- "integer": {
77813
- "value": 422
77814
- }
77815
- },
77816
- "type": "io.flow.error.v0.models.generic_error",
77817
- "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.",
77818
- "attributes": []
77819
78360
  }],
77820
- "attributes": [],
77821
- "description": "Deletes a manual transaction for this account, if not associated with a billing statement."
78361
+ "attributes": []
77822
78362
  }, {
77823
- "method": "GET",
77824
- "path": "/:organization/accounts",
78363
+ "method": "POST",
78364
+ "path": "/internal/:organization/accounts/:currency/transactions/manual",
77825
78365
  "parameters": [{
77826
78366
  "name": "organization",
77827
78367
  "type": "string",
77828
78368
  "location": "Path",
77829
78369
  "required": true,
77830
78370
  "description": "Refers to your organization's account identifier"
77831
- }, {
77832
- "name": "id",
77833
- "type": "[string]",
77834
- "location": "Query",
77835
- "required": false,
77836
- "description": "Filter by one or more IDs of this resource",
77837
- "maximum": 100
77838
78371
  }, {
77839
78372
  "name": "currency",
77840
- "type": "[string]",
77841
- "location": "Query",
77842
- "required": false,
77843
- "maximum": 100
77844
- }, {
77845
- "name": "limit",
77846
- "type": "long",
77847
- "location": "Query",
77848
- "required": true,
77849
- "description": "The maximum number of results to return",
77850
- "default": "25",
77851
- "minimum": 1,
77852
- "maximum": 100
77853
- }, {
77854
- "name": "offset",
77855
- "type": "long",
77856
- "location": "Query",
77857
- "required": true,
77858
- "description": "The number of results to skip before returning results",
77859
- "default": "0",
77860
- "minimum": 0
77861
- }, {
77862
- "name": "sort",
77863
78373
  "type": "string",
77864
- "location": "Query",
77865
- "required": true,
77866
- "default": "currency"
78374
+ "location": "Path",
78375
+ "required": true
77867
78376
  }],
77868
78377
  "responses": [{
77869
78378
  "code": {
77870
78379
  "integer": {
77871
- "value": 200
78380
+ "value": 201
77872
78381
  }
77873
78382
  },
77874
- "type": "[account]",
77875
- "description": "Successful response",
78383
+ "type": "manual_transaction",
78384
+ "description": "Operation succeeded and the resource was created",
78385
+ "attributes": []
78386
+ }, {
78387
+ "code": {
78388
+ "integer": {
78389
+ "value": 401
78390
+ }
78391
+ },
78392
+ "type": "unit",
78393
+ "description": "Authorization failed",
78394
+ "attributes": []
78395
+ }, {
78396
+ "code": {
78397
+ "integer": {
78398
+ "value": 404
78399
+ }
78400
+ },
78401
+ "type": "unit",
78402
+ "description": "Resource was not found",
78403
+ "attributes": []
78404
+ }, {
78405
+ "code": {
78406
+ "integer": {
78407
+ "value": 422
78408
+ }
78409
+ },
78410
+ "type": "io.flow.error.v0.models.generic_error",
78411
+ "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.",
78412
+ "attributes": []
78413
+ }],
78414
+ "attributes": [],
78415
+ "description": "Creates a manual transaction for this account",
78416
+ "body": {
78417
+ "type": "manual_transaction_form",
78418
+ "attributes": []
78419
+ }
78420
+ }, {
78421
+ "method": "DELETE",
78422
+ "path": "/internal/:organization/accounts/:currency/transactions/manual/:id",
78423
+ "parameters": [{
78424
+ "name": "organization",
78425
+ "type": "string",
78426
+ "location": "Path",
78427
+ "required": true,
78428
+ "description": "Refers to your organization's account identifier"
78429
+ }, {
78430
+ "name": "currency",
78431
+ "type": "string",
78432
+ "location": "Path",
78433
+ "required": true
78434
+ }, {
78435
+ "name": "id",
78436
+ "type": "string",
78437
+ "location": "Path",
78438
+ "required": true,
78439
+ "description": "Filter by one or more IDs of this resource"
78440
+ }],
78441
+ "responses": [{
78442
+ "code": {
78443
+ "integer": {
78444
+ "value": 204
78445
+ }
78446
+ },
78447
+ "type": "unit",
78448
+ "description": "Operation succeeded. No content is returned",
78449
+ "attributes": []
78450
+ }, {
78451
+ "code": {
78452
+ "integer": {
78453
+ "value": 401
78454
+ }
78455
+ },
78456
+ "type": "unit",
78457
+ "description": "Authorization failed",
78458
+ "attributes": []
78459
+ }, {
78460
+ "code": {
78461
+ "integer": {
78462
+ "value": 404
78463
+ }
78464
+ },
78465
+ "type": "unit",
78466
+ "description": "Resource was not found",
78467
+ "attributes": []
78468
+ }, {
78469
+ "code": {
78470
+ "integer": {
78471
+ "value": 422
78472
+ }
78473
+ },
78474
+ "type": "io.flow.error.v0.models.generic_error",
78475
+ "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.",
78476
+ "attributes": []
78477
+ }],
78478
+ "attributes": [],
78479
+ "description": "Deletes a manual transaction for this account, if not associated with a billing statement."
78480
+ }, {
78481
+ "method": "GET",
78482
+ "path": "/:organization/accounts",
78483
+ "parameters": [{
78484
+ "name": "organization",
78485
+ "type": "string",
78486
+ "location": "Path",
78487
+ "required": true,
78488
+ "description": "Refers to your organization's account identifier"
78489
+ }, {
78490
+ "name": "id",
78491
+ "type": "[string]",
78492
+ "location": "Query",
78493
+ "required": false,
78494
+ "description": "Filter by one or more IDs of this resource",
78495
+ "maximum": 100
78496
+ }, {
78497
+ "name": "currency",
78498
+ "type": "[string]",
78499
+ "location": "Query",
78500
+ "required": false,
78501
+ "maximum": 100
78502
+ }, {
78503
+ "name": "limit",
78504
+ "type": "long",
78505
+ "location": "Query",
78506
+ "required": true,
78507
+ "description": "The maximum number of results to return",
78508
+ "default": "25",
78509
+ "minimum": 1,
78510
+ "maximum": 100
78511
+ }, {
78512
+ "name": "offset",
78513
+ "type": "long",
78514
+ "location": "Query",
78515
+ "required": true,
78516
+ "description": "The number of results to skip before returning results",
78517
+ "default": "0",
78518
+ "minimum": 0
78519
+ }, {
78520
+ "name": "sort",
78521
+ "type": "string",
78522
+ "location": "Query",
78523
+ "required": true,
78524
+ "default": "currency"
78525
+ }],
78526
+ "responses": [{
78527
+ "code": {
78528
+ "integer": {
78529
+ "value": 200
78530
+ }
78531
+ },
78532
+ "type": "[account]",
78533
+ "description": "Successful response",
77876
78534
  "attributes": []
77877
78535
  }, {
77878
78536
  "code": {
@@ -78547,7 +79205,7 @@
78547
79205
  "value": 200
78548
79206
  }
78549
79207
  },
78550
- "type": "[billing_statement]",
79208
+ "type": "[organization_billing_statement]",
78551
79209
  "description": "Successful response",
78552
79210
  "attributes": []
78553
79211
  }, {
@@ -78621,7 +79279,7 @@
78621
79279
  "value": 200
78622
79280
  }
78623
79281
  },
78624
- "type": "billing_statement",
79282
+ "type": "organization_billing_statement",
78625
79283
  "description": "Successful response",
78626
79284
  "attributes": []
78627
79285
  }, {
@@ -82973,21 +83631,9 @@
82973
83631
  }
82974
83632
  }],
82975
83633
  "description": "Returns all valid filters (categories, keywords) for an given organization and all restrictions in system"
82976
- }],
82977
- "attributes": [{
82978
- "name": "docs",
82979
- "value": {
82980
- "module": "general"
82981
- }
82982
- }],
82983
- "path": "/jailhouse/restriction/:organization/filters",
82984
- "description": "all valid filters, including categories and keywords given a organization and all restrictions regardless of organization"
82985
- }, {
82986
- "type": "restriction_item",
82987
- "plural": "restriction_items",
82988
- "operations": [{
83634
+ }, {
82989
83635
  "method": "GET",
82990
- "path": "/jailhouse/restriction/:organization/items",
83636
+ "path": "/jailhouse/restriction/:organization/filters/catalog",
82991
83637
  "parameters": [{
82992
83638
  "name": "organization",
82993
83639
  "type": "string",
@@ -82995,48 +83641,67 @@
82995
83641
  "required": true,
82996
83642
  "description": "Refers to your organization's account identifier"
82997
83643
  }, {
82998
- "name": "status",
82999
- "type": "restriction_status",
83000
- "location": "Query",
83001
- "required": false,
83002
- "description": "Overwrites `statuses` if both are present",
83003
- "example": "in_review"
83004
- }, {
83005
- "name": "statuses",
83006
- "type": "[restriction_status]",
83007
- "location": "Query",
83008
- "required": false,
83009
- "maximum": 5
83010
- }, {
83011
- "name": "rule_ids",
83012
- "type": "[string]",
83013
- "location": "Query",
83014
- "required": false,
83015
- "maximum": 100
83016
- }, {
83017
- "name": "categories",
83018
- "type": "[string]",
83644
+ "name": "limit",
83645
+ "type": "long",
83019
83646
  "location": "Query",
83020
- "required": false,
83647
+ "required": true,
83648
+ "description": "The maximum number of results to return",
83649
+ "default": "25",
83650
+ "minimum": 1,
83021
83651
  "maximum": 100
83022
83652
  }, {
83023
- "name": "product_name_query",
83024
- "type": "string",
83653
+ "name": "offset",
83654
+ "type": "long",
83025
83655
  "location": "Query",
83026
- "required": false,
83027
- "maximum": 100
83656
+ "required": true,
83657
+ "description": "The number of results to skip before returning results",
83658
+ "default": "0",
83659
+ "minimum": 0
83660
+ }],
83661
+ "responses": [{
83662
+ "code": {
83663
+ "integer": {
83664
+ "value": 200
83665
+ }
83666
+ },
83667
+ "type": "restriction_filter",
83668
+ "description": "Successful response",
83669
+ "attributes": []
83028
83670
  }, {
83029
- "name": "positive_keywords",
83030
- "type": "[string]",
83031
- "location": "Query",
83032
- "required": false,
83033
- "maximum": 100
83671
+ "code": {
83672
+ "integer": {
83673
+ "value": 401
83674
+ }
83675
+ },
83676
+ "type": "unit",
83677
+ "description": "Authorization failed",
83678
+ "attributes": []
83034
83679
  }, {
83035
- "name": "negative_keywords",
83036
- "type": "[string]",
83037
- "location": "Query",
83038
- "required": false,
83039
- "maximum": 100
83680
+ "code": {
83681
+ "integer": {
83682
+ "value": 422
83683
+ }
83684
+ },
83685
+ "type": "io.flow.error.v0.models.generic_error",
83686
+ "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.",
83687
+ "attributes": []
83688
+ }],
83689
+ "attributes": [{
83690
+ "name": "linter",
83691
+ "value": {
83692
+ "ignore": ["get", "id", "sort"]
83693
+ }
83694
+ }],
83695
+ "description": "Returns all valid filters (categories, keywords, updated by users) for an given organization and all restrictions in system"
83696
+ }, {
83697
+ "method": "GET",
83698
+ "path": "/jailhouse/restriction/:organization/filters/pending_reviews",
83699
+ "parameters": [{
83700
+ "name": "organization",
83701
+ "type": "string",
83702
+ "location": "Path",
83703
+ "required": true,
83704
+ "description": "Refers to your organization's account identifier"
83040
83705
  }, {
83041
83706
  "name": "limit",
83042
83707
  "type": "long",
@@ -83054,12 +83719,6 @@
83054
83719
  "description": "The number of results to skip before returning results",
83055
83720
  "default": "0",
83056
83721
  "minimum": 0
83057
- }, {
83058
- "name": "sort",
83059
- "type": "string",
83060
- "location": "Query",
83061
- "required": true,
83062
- "default": "created_at"
83063
83722
  }],
83064
83723
  "responses": [{
83065
83724
  "code": {
@@ -83067,7 +83726,7 @@
83067
83726
  "value": 200
83068
83727
  }
83069
83728
  },
83070
- "type": "[restriction_item]",
83729
+ "type": "restriction_filter",
83071
83730
  "description": "Successful response",
83072
83731
  "attributes": []
83073
83732
  }, {
@@ -83094,180 +83753,23 @@
83094
83753
  "value": {
83095
83754
  "ignore": ["get", "id", "sort"]
83096
83755
  }
83097
- }, {
83098
- "name": "sort",
83099
- "value": {
83100
- "values": [{
83101
- "value": "created_at"
83102
- }, {
83103
- "value": "updated_at"
83104
- }, {
83105
- "value": "name"
83106
- }]
83107
- }
83108
- }],
83109
- "description": "Returns a list of item restriction decisions for an organization"
83110
- }, {
83111
- "method": "POST",
83112
- "path": "/jailhouse/restriction/:organization/items",
83113
- "parameters": [{
83114
- "name": "organization",
83115
- "type": "string",
83116
- "location": "Path",
83117
- "required": true,
83118
- "description": "Refers to your organization's account identifier"
83119
- }],
83120
- "responses": [{
83121
- "code": {
83122
- "integer": {
83123
- "value": 201
83124
- }
83125
- },
83126
- "type": "restriction_item",
83127
- "description": "Operation succeeded and the resource was created",
83128
- "attributes": []
83129
- }, {
83130
- "code": {
83131
- "integer": {
83132
- "value": 401
83133
- }
83134
- },
83135
- "type": "unit",
83136
- "description": "Authorization failed",
83137
- "attributes": []
83138
- }, {
83139
- "code": {
83140
- "integer": {
83141
- "value": 422
83142
- }
83143
- },
83144
- "type": "io.flow.error.v0.models.generic_error",
83145
- "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.",
83146
- "attributes": []
83147
- }],
83148
- "attributes": [],
83149
- "description": "Set the restriction decision for a product item",
83150
- "body": {
83151
- "type": "restriction_item_review_decision_form",
83152
- "attributes": []
83153
- }
83154
- }, {
83155
- "method": "GET",
83156
- "path": "/jailhouse/restriction/:organization/items/:id",
83157
- "parameters": [{
83158
- "name": "organization",
83159
- "type": "string",
83160
- "location": "Path",
83161
- "required": true,
83162
- "description": "Refers to your organization's account identifier"
83163
- }, {
83164
- "name": "id",
83165
- "type": "string",
83166
- "location": "Path",
83167
- "required": true,
83168
- "description": "Filter by one or more IDs of this resource"
83169
- }],
83170
- "responses": [{
83171
- "code": {
83172
- "integer": {
83173
- "value": 200
83174
- }
83175
- },
83176
- "type": "restriction_item",
83177
- "description": "Successful response",
83178
- "attributes": []
83179
- }, {
83180
- "code": {
83181
- "integer": {
83182
- "value": 401
83183
- }
83184
- },
83185
- "type": "unit",
83186
- "description": "Authorization failed",
83187
- "attributes": []
83188
- }, {
83189
- "code": {
83190
- "integer": {
83191
- "value": 404
83192
- }
83193
- },
83194
- "type": "unit",
83195
- "description": "Resource was not found",
83196
- "attributes": []
83197
- }],
83198
- "attributes": [],
83199
- "description": "Returns a restriction product item by id"
83200
- }, {
83201
- "method": "PUT",
83202
- "path": "/jailhouse/restriction/:organization/items/:id",
83203
- "parameters": [{
83204
- "name": "organization",
83205
- "type": "string",
83206
- "location": "Path",
83207
- "required": true,
83208
- "description": "Refers to your organization's account identifier"
83209
- }, {
83210
- "name": "id",
83211
- "type": "string",
83212
- "location": "Path",
83213
- "required": true,
83214
- "description": "Filter by one or more IDs of this resource"
83215
- }],
83216
- "responses": [{
83217
- "code": {
83218
- "integer": {
83219
- "value": 200
83220
- }
83221
- },
83222
- "type": "restriction_item",
83223
- "description": "Successful response",
83224
- "attributes": []
83225
- }, {
83226
- "code": {
83227
- "integer": {
83228
- "value": 201
83229
- }
83230
- },
83231
- "type": "restriction_item",
83232
- "description": "Operation succeeded and the resource was created",
83233
- "attributes": []
83234
- }, {
83235
- "code": {
83236
- "integer": {
83237
- "value": 401
83238
- }
83239
- },
83240
- "type": "unit",
83241
- "description": "Authorization failed",
83242
- "attributes": []
83243
- }, {
83244
- "code": {
83245
- "integer": {
83246
- "value": 404
83247
- }
83248
- },
83249
- "type": "unit",
83250
- "description": "Resource was not found",
83251
- "attributes": []
83252
- }, {
83253
- "code": {
83254
- "integer": {
83255
- "value": 422
83256
- }
83257
- },
83258
- "type": "io.flow.error.v0.models.generic_error",
83259
- "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.",
83260
- "attributes": []
83261
83756
  }],
83262
- "attributes": [],
83263
- "description": "Update the restriction decision for a product item",
83264
- "body": {
83265
- "type": "restriction_item_review_decision_form",
83266
- "attributes": []
83757
+ "description": "Returns all valid filters (categories, keywords, restrictions) for an given organization"
83758
+ }],
83759
+ "attributes": [{
83760
+ "name": "docs",
83761
+ "value": {
83762
+ "module": "general"
83267
83763
  }
83268
- }, {
83764
+ }],
83765
+ "path": "/jailhouse/restriction/:organization/filters",
83766
+ "description": "all valid filters, including categories and keywords given a organization and all restrictions regardless of organization"
83767
+ }, {
83768
+ "type": "restriction_item",
83769
+ "plural": "restriction_items",
83770
+ "operations": [{
83269
83771
  "method": "GET",
83270
- "path": "/internal/restriction/:organization/items",
83772
+ "path": "/jailhouse/restriction/:organization/items",
83271
83773
  "parameters": [{
83272
83774
  "name": "organization",
83273
83775
  "type": "string",
@@ -83389,7 +83891,7 @@
83389
83891
  "description": "Returns a list of item restriction decisions for an organization"
83390
83892
  }, {
83391
83893
  "method": "POST",
83392
- "path": "/internal/restriction/:organization/items",
83894
+ "path": "/jailhouse/restriction/:organization/items",
83393
83895
  "parameters": [{
83394
83896
  "name": "organization",
83395
83897
  "type": "string",
@@ -83433,7 +83935,7 @@
83433
83935
  }
83434
83936
  }, {
83435
83937
  "method": "GET",
83436
- "path": "/internal/restriction/:organization/items/:id",
83938
+ "path": "/jailhouse/restriction/:organization/items/:id",
83437
83939
  "parameters": [{
83438
83940
  "name": "organization",
83439
83941
  "type": "string",
@@ -83479,7 +83981,7 @@
83479
83981
  "description": "Returns a restriction product item by id"
83480
83982
  }, {
83481
83983
  "method": "PUT",
83482
- "path": "/internal/restriction/:organization/items/:id",
83984
+ "path": "/jailhouse/restriction/:organization/items/:id",
83483
83985
  "parameters": [{
83484
83986
  "name": "organization",
83485
83987
  "type": "string",
@@ -83774,12 +84276,30 @@
83774
84276
  "type": "[restriction_status]",
83775
84277
  "location": "Query",
83776
84278
  "required": false,
84279
+ "deprecation": {
84280
+ "description": "This parameter is deprecated. Please use the 'restricted_rules' or 'accepted_rules'"
84281
+ },
83777
84282
  "maximum": 5
83778
84283
  }, {
83779
84284
  "name": "rule_ids",
83780
84285
  "type": "[string]",
83781
84286
  "location": "Query",
83782
84287
  "required": false,
84288
+ "deprecation": {
84289
+ "description": "This parameter is deprecated. Please use the 'restricted_rules' or 'accepted_rules'"
84290
+ },
84291
+ "maximum": 100
84292
+ }, {
84293
+ "name": "restricted_rules",
84294
+ "type": "[string]",
84295
+ "location": "Query",
84296
+ "required": false,
84297
+ "maximum": 100
84298
+ }, {
84299
+ "name": "accepted_rules",
84300
+ "type": "[string]",
84301
+ "location": "Query",
84302
+ "required": false,
83783
84303
  "maximum": 100
83784
84304
  }, {
83785
84305
  "name": "positive_keywords",
@@ -83974,45 +84494,33 @@
83974
84494
  "type": "restriction_product_decision_form",
83975
84495
  "attributes": []
83976
84496
  }
83977
- }, {
84497
+ }],
84498
+ "attributes": [{
84499
+ "name": "docs",
84500
+ "value": {
84501
+ "module": "general"
84502
+ }
84503
+ }],
84504
+ "path": "/jailhouse/restriction/:organization/products",
84505
+ "description": "A product, which may compose multiple product variants and catalog items, and information about all restriction rules it was evaluated against"
84506
+ }, {
84507
+ "type": "restriction_rule",
84508
+ "plural": "restriction_rules",
84509
+ "operations": [{
83978
84510
  "method": "GET",
83979
- "path": "/internal/restriction/:organization/products",
84511
+ "path": "/jailhouse/restriction/rules",
83980
84512
  "parameters": [{
83981
- "name": "organization",
83982
- "type": "string",
83983
- "location": "Path",
83984
- "required": true,
83985
- "description": "Refers to your organization's account identifier"
83986
- }, {
83987
- "name": "statuses",
83988
- "type": "[restriction_status]",
83989
- "location": "Query",
83990
- "required": false,
83991
- "maximum": 5
83992
- }, {
83993
- "name": "rule_ids",
83994
- "type": "[string]",
83995
- "location": "Query",
83996
- "required": false,
83997
- "maximum": 100
83998
- }, {
83999
- "name": "positive_keywords",
84000
- "type": "[string]",
84001
- "location": "Query",
84002
- "required": false,
84003
- "maximum": 100
84004
- }, {
84005
- "name": "negative_keywords",
84513
+ "name": "id",
84006
84514
  "type": "[string]",
84007
84515
  "location": "Query",
84008
84516
  "required": false,
84517
+ "description": "Filter by one or more IDs of this resource",
84009
84518
  "maximum": 100
84010
84519
  }, {
84011
- "name": "user_ids",
84012
- "type": "[string]",
84520
+ "name": "name",
84521
+ "type": "string",
84013
84522
  "location": "Query",
84014
- "required": false,
84015
- "maximum": 100
84523
+ "required": false
84016
84524
  }, {
84017
84525
  "name": "limit",
84018
84526
  "type": "long",
@@ -84035,7 +84543,7 @@
84035
84543
  "type": "string",
84036
84544
  "location": "Query",
84037
84545
  "required": true,
84038
- "default": "created_at"
84546
+ "default": "name"
84039
84547
  }],
84040
84548
  "responses": [{
84041
84549
  "code": {
@@ -84043,7 +84551,7 @@
84043
84551
  "value": 200
84044
84552
  }
84045
84553
  },
84046
- "type": "[restriction_product]",
84554
+ "type": "[restriction_rule]",
84047
84555
  "description": "Successful response",
84048
84556
  "attributes": []
84049
84557
  }, {
@@ -84066,33 +84574,19 @@
84066
84574
  "attributes": []
84067
84575
  }],
84068
84576
  "attributes": [{
84069
- "name": "linter",
84070
- "value": {
84071
- "ignore": ["get", "id", "sort"]
84072
- }
84073
- }, {
84074
84577
  "name": "sort",
84075
84578
  "value": {
84076
84579
  "values": [{
84077
- "value": "created_at"
84078
- }, {
84079
- "value": "updated_at"
84080
- }, {
84081
84580
  "value": "name"
84581
+ }, {
84582
+ "value": "created_at"
84082
84583
  }]
84083
84584
  }
84084
- }],
84085
- "description": "Returns a list of products and their restriction information for an organization"
84585
+ }]
84086
84586
  }, {
84087
84587
  "method": "GET",
84088
- "path": "/internal/restriction/:organization/products/:id",
84588
+ "path": "/jailhouse/restriction/rules/:id",
84089
84589
  "parameters": [{
84090
- "name": "organization",
84091
- "type": "string",
84092
- "location": "Path",
84093
- "required": true,
84094
- "description": "Refers to your organization's account identifier"
84095
- }, {
84096
84590
  "name": "id",
84097
84591
  "type": "string",
84098
84592
  "location": "Path",
@@ -84105,195 +84599,7 @@
84105
84599
  "value": 200
84106
84600
  }
84107
84601
  },
84108
- "type": "restriction_product",
84109
- "description": "Successful response",
84110
- "attributes": []
84111
- }, {
84112
- "code": {
84113
- "integer": {
84114
- "value": 401
84115
- }
84116
- },
84117
- "type": "unit",
84118
- "description": "Authorization failed",
84119
- "attributes": []
84120
- }, {
84121
- "code": {
84122
- "integer": {
84123
- "value": 404
84124
- }
84125
- },
84126
- "type": "unit",
84127
- "description": "Resource was not found",
84128
- "attributes": []
84129
- }],
84130
- "attributes": [],
84131
- "description": "Returns a product by id"
84132
- }, {
84133
- "method": "POST",
84134
- "path": "/internal/restriction/:organization/products/:id/decisions",
84135
- "parameters": [{
84136
- "name": "organization",
84137
- "type": "string",
84138
- "location": "Path",
84139
- "required": true,
84140
- "description": "Refers to your organization's account identifier"
84141
- }, {
84142
- "name": "id",
84143
- "type": "string",
84144
- "location": "Path",
84145
- "required": true,
84146
- "description": "Filter by one or more IDs of this resource"
84147
- }],
84148
- "responses": [{
84149
- "code": {
84150
- "integer": {
84151
- "value": 200
84152
- }
84153
- },
84154
- "type": "restriction_product",
84155
- "description": "Successful response",
84156
- "attributes": []
84157
- }, {
84158
- "code": {
84159
- "integer": {
84160
- "value": 401
84161
- }
84162
- },
84163
- "type": "unit",
84164
- "description": "Authorization failed",
84165
- "attributes": []
84166
- }, {
84167
- "code": {
84168
- "integer": {
84169
- "value": 404
84170
- }
84171
- },
84172
- "type": "unit",
84173
- "description": "Resource was not found",
84174
- "attributes": []
84175
- }, {
84176
- "code": {
84177
- "integer": {
84178
- "value": 422
84179
- }
84180
- },
84181
- "type": "io.flow.error.v0.models.generic_error",
84182
- "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.",
84183
- "attributes": []
84184
- }],
84185
- "attributes": [],
84186
- "description": "Updates restriction decisions on a given product",
84187
- "body": {
84188
- "type": "restriction_product_decision_form",
84189
- "attributes": []
84190
- }
84191
- }],
84192
- "attributes": [{
84193
- "name": "docs",
84194
- "value": {
84195
- "module": "general"
84196
- }
84197
- }],
84198
- "path": "/jailhouse/restriction/:organization/products",
84199
- "description": "A product, which may compose multiple product variants and catalog items, and information about all restriction rules it was evaluated against"
84200
- }, {
84201
- "type": "restriction_rule",
84202
- "plural": "restriction_rules",
84203
- "operations": [{
84204
- "method": "GET",
84205
- "path": "/jailhouse/restriction/rules",
84206
- "parameters": [{
84207
- "name": "id",
84208
- "type": "[string]",
84209
- "location": "Query",
84210
- "required": false,
84211
- "description": "Filter by one or more IDs of this resource",
84212
- "maximum": 100
84213
- }, {
84214
- "name": "name",
84215
- "type": "string",
84216
- "location": "Query",
84217
- "required": false
84218
- }, {
84219
- "name": "limit",
84220
- "type": "long",
84221
- "location": "Query",
84222
- "required": true,
84223
- "description": "The maximum number of results to return",
84224
- "default": "25",
84225
- "minimum": 1,
84226
- "maximum": 100
84227
- }, {
84228
- "name": "offset",
84229
- "type": "long",
84230
- "location": "Query",
84231
- "required": true,
84232
- "description": "The number of results to skip before returning results",
84233
- "default": "0",
84234
- "minimum": 0
84235
- }, {
84236
- "name": "sort",
84237
- "type": "string",
84238
- "location": "Query",
84239
- "required": true,
84240
- "default": "name"
84241
- }],
84242
- "responses": [{
84243
- "code": {
84244
- "integer": {
84245
- "value": 200
84246
- }
84247
- },
84248
- "type": "[restriction_rule]",
84249
- "description": "Successful response",
84250
- "attributes": []
84251
- }, {
84252
- "code": {
84253
- "integer": {
84254
- "value": 401
84255
- }
84256
- },
84257
- "type": "unit",
84258
- "description": "Authorization failed",
84259
- "attributes": []
84260
- }, {
84261
- "code": {
84262
- "integer": {
84263
- "value": 422
84264
- }
84265
- },
84266
- "type": "io.flow.error.v0.models.generic_error",
84267
- "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.",
84268
- "attributes": []
84269
- }],
84270
- "attributes": [{
84271
- "name": "sort",
84272
- "value": {
84273
- "values": [{
84274
- "value": "name"
84275
- }, {
84276
- "value": "created_at"
84277
- }]
84278
- }
84279
- }]
84280
- }, {
84281
- "method": "GET",
84282
- "path": "/jailhouse/restriction/rules/:id",
84283
- "parameters": [{
84284
- "name": "id",
84285
- "type": "string",
84286
- "location": "Path",
84287
- "required": true,
84288
- "description": "Filter by one or more IDs of this resource"
84289
- }],
84290
- "responses": [{
84291
- "code": {
84292
- "integer": {
84293
- "value": 200
84294
- }
84295
- },
84296
- "type": "restriction_rule",
84602
+ "type": "restriction_rule",
84297
84603
  "description": "Successful response",
84298
84604
  "attributes": []
84299
84605
  }, {
@@ -84399,303 +84705,6 @@
84399
84705
  }
84400
84706
  }],
84401
84707
  "description": "Returns the list of restriction rules currently applicable for an organization"
84402
- }, {
84403
- "method": "GET",
84404
- "path": "/internal/restriction/rules",
84405
- "parameters": [{
84406
- "name": "id",
84407
- "type": "[string]",
84408
- "location": "Query",
84409
- "required": false,
84410
- "description": "Filter by one or more IDs of this resource",
84411
- "maximum": 100
84412
- }, {
84413
- "name": "name",
84414
- "type": "string",
84415
- "location": "Query",
84416
- "required": false
84417
- }, {
84418
- "name": "limit",
84419
- "type": "long",
84420
- "location": "Query",
84421
- "required": true,
84422
- "description": "The maximum number of results to return",
84423
- "default": "25",
84424
- "minimum": 1,
84425
- "maximum": 100
84426
- }, {
84427
- "name": "offset",
84428
- "type": "long",
84429
- "location": "Query",
84430
- "required": true,
84431
- "description": "The number of results to skip before returning results",
84432
- "default": "0",
84433
- "minimum": 0
84434
- }, {
84435
- "name": "sort",
84436
- "type": "string",
84437
- "location": "Query",
84438
- "required": true,
84439
- "default": "name"
84440
- }],
84441
- "responses": [{
84442
- "code": {
84443
- "integer": {
84444
- "value": 200
84445
- }
84446
- },
84447
- "type": "[restriction_rule]",
84448
- "description": "Successful response",
84449
- "attributes": []
84450
- }, {
84451
- "code": {
84452
- "integer": {
84453
- "value": 401
84454
- }
84455
- },
84456
- "type": "unit",
84457
- "description": "Authorization failed",
84458
- "attributes": []
84459
- }, {
84460
- "code": {
84461
- "integer": {
84462
- "value": 422
84463
- }
84464
- },
84465
- "type": "io.flow.error.v0.models.generic_error",
84466
- "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.",
84467
- "attributes": []
84468
- }],
84469
- "attributes": [{
84470
- "name": "sort",
84471
- "value": {
84472
- "values": [{
84473
- "value": "name"
84474
- }, {
84475
- "value": "created_at"
84476
- }]
84477
- }
84478
- }]
84479
- }, {
84480
- "method": "POST",
84481
- "path": "/internal/restriction/rules",
84482
- "parameters": [],
84483
- "responses": [{
84484
- "code": {
84485
- "integer": {
84486
- "value": 201
84487
- }
84488
- },
84489
- "type": "restriction_rule",
84490
- "description": "Operation succeeded and the resource was created",
84491
- "attributes": []
84492
- }, {
84493
- "code": {
84494
- "integer": {
84495
- "value": 401
84496
- }
84497
- },
84498
- "type": "unit",
84499
- "description": "Authorization failed",
84500
- "attributes": []
84501
- }, {
84502
- "code": {
84503
- "integer": {
84504
- "value": 422
84505
- }
84506
- },
84507
- "type": "io.flow.error.v0.models.generic_error",
84508
- "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.",
84509
- "attributes": []
84510
- }],
84511
- "attributes": [],
84512
- "body": {
84513
- "type": "restriction_rule_form",
84514
- "attributes": []
84515
- }
84516
- }, {
84517
- "method": "GET",
84518
- "path": "/internal/restriction/rules/:id",
84519
- "parameters": [{
84520
- "name": "id",
84521
- "type": "string",
84522
- "location": "Path",
84523
- "required": true,
84524
- "description": "Filter by one or more IDs of this resource"
84525
- }],
84526
- "responses": [{
84527
- "code": {
84528
- "integer": {
84529
- "value": 200
84530
- }
84531
- },
84532
- "type": "restriction_rule",
84533
- "description": "Successful response",
84534
- "attributes": []
84535
- }, {
84536
- "code": {
84537
- "integer": {
84538
- "value": 401
84539
- }
84540
- },
84541
- "type": "unit",
84542
- "description": "Authorization failed",
84543
- "attributes": []
84544
- }, {
84545
- "code": {
84546
- "integer": {
84547
- "value": 404
84548
- }
84549
- },
84550
- "type": "unit",
84551
- "description": "Resource was not found",
84552
- "attributes": []
84553
- }],
84554
- "attributes": []
84555
- }, {
84556
- "method": "PUT",
84557
- "path": "/internal/restriction/rules/:id",
84558
- "parameters": [{
84559
- "name": "id",
84560
- "type": "string",
84561
- "location": "Path",
84562
- "required": true,
84563
- "description": "Filter by one or more IDs of this resource"
84564
- }],
84565
- "responses": [{
84566
- "code": {
84567
- "integer": {
84568
- "value": 200
84569
- }
84570
- },
84571
- "type": "restriction_rule",
84572
- "description": "Successful response",
84573
- "attributes": []
84574
- }, {
84575
- "code": {
84576
- "integer": {
84577
- "value": 201
84578
- }
84579
- },
84580
- "type": "restriction_rule",
84581
- "description": "Operation succeeded and the resource was created",
84582
- "attributes": []
84583
- }, {
84584
- "code": {
84585
- "integer": {
84586
- "value": 401
84587
- }
84588
- },
84589
- "type": "unit",
84590
- "description": "Authorization failed",
84591
- "attributes": []
84592
- }, {
84593
- "code": {
84594
- "integer": {
84595
- "value": 404
84596
- }
84597
- },
84598
- "type": "unit",
84599
- "description": "Resource was not found",
84600
- "attributes": []
84601
- }, {
84602
- "code": {
84603
- "integer": {
84604
- "value": 422
84605
- }
84606
- },
84607
- "type": "io.flow.error.v0.models.generic_error",
84608
- "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.",
84609
- "attributes": []
84610
- }],
84611
- "attributes": [],
84612
- "body": {
84613
- "type": "restriction_rule_form",
84614
- "attributes": []
84615
- }
84616
- }, {
84617
- "method": "GET",
84618
- "path": "/internal/restriction/rules/:organization/:status",
84619
- "parameters": [{
84620
- "name": "organization",
84621
- "type": "string",
84622
- "location": "Path",
84623
- "required": true,
84624
- "description": "Refers to your organization's account identifier"
84625
- }, {
84626
- "name": "status",
84627
- "type": "restriction_status",
84628
- "location": "Path",
84629
- "required": true,
84630
- "example": "in_review"
84631
- }, {
84632
- "name": "id",
84633
- "type": "[string]",
84634
- "location": "Query",
84635
- "required": false,
84636
- "description": "Filter by one or more IDs of this resource",
84637
- "maximum": 100
84638
- }, {
84639
- "name": "limit",
84640
- "type": "long",
84641
- "location": "Query",
84642
- "required": true,
84643
- "description": "The maximum number of results to return",
84644
- "default": "25",
84645
- "minimum": 1,
84646
- "maximum": 100
84647
- }, {
84648
- "name": "offset",
84649
- "type": "long",
84650
- "location": "Query",
84651
- "required": true,
84652
- "description": "The number of results to skip before returning results",
84653
- "default": "0",
84654
- "minimum": 0
84655
- }, {
84656
- "name": "sort",
84657
- "type": "string",
84658
- "location": "Query",
84659
- "required": true,
84660
- "default": "name"
84661
- }],
84662
- "responses": [{
84663
- "code": {
84664
- "integer": {
84665
- "value": 200
84666
- }
84667
- },
84668
- "type": "[restriction_rule_summary]",
84669
- "description": "Successful response",
84670
- "attributes": []
84671
- }, {
84672
- "code": {
84673
- "integer": {
84674
- "value": 401
84675
- }
84676
- },
84677
- "type": "unit",
84678
- "description": "Authorization failed",
84679
- "attributes": []
84680
- }, {
84681
- "code": {
84682
- "integer": {
84683
- "value": 422
84684
- }
84685
- },
84686
- "type": "io.flow.error.v0.models.generic_error",
84687
- "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.",
84688
- "attributes": []
84689
- }],
84690
- "attributes": [{
84691
- "name": "sort",
84692
- "value": {
84693
- "values": [{
84694
- "value": "name"
84695
- }]
84696
- }
84697
- }],
84698
- "description": "Returns the list of restriction rules currently applicable for an organization"
84699
84708
  }],
84700
84709
  "attributes": [{
84701
84710
  "name": "docs",