@flowio/api-internal-mock-generator 5.31.31 → 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.
@@ -10,7 +10,7 @@
10
10
  "key" : "api-internal"
11
11
  },
12
12
  "namespace" : "io.flow.internal.v0",
13
- "version" : "0.16.64",
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.60",
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.60",
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.60",
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.60",
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.60",
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.60",
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.60",
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.60",
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.60",
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.60",
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.60",
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.60",
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.60",
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.60",
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.60",
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.60",
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.60",
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.60",
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.60",
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.92",
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.92",
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.60",
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,11 +361,11 @@
361
361
  "application" : {
362
362
  "key" : "adyen"
363
363
  },
364
- "version" : "0.2.92",
365
- "enums" : [ "channel", "contract", "device_channel", "event_code", "method", "operation", "payment_method", "recurring_processing_model", "result_code", "shopper_interaction", "threeds_completion_indicator" ],
364
+ "version" : "0.2.93",
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" ],
368
- "models" : [ "address", "amount", "authentication", "authorize_request", "authorize_request_3d", "authorize_request_3ds2", "authorize_response", "bank_account", "browser_info_3ds1", "browser_info_3ds2", "cancel_request", "cancel_response", "card", "challenge_shopper_additional_data", "chargeback_notification_additional_data", "error", "identify_shopper_additional_data", "inner_notification_request_item", "modification_request", "modification_response", "notification_request", "notification_response", "origin_keys_request", "origin_keys_response", "outer_notification_request_item", "payment_details", "payment_request", "payment_response", "payment_response_additional_data", "recurring", "redirect", "redirect_data", "request_for_information_additional_data", "scheme", "three_d_secure_data", "threeds2_request_data", "threeds2_result", "threeds_additional_data" ],
368
+ "models" : [ "address", "amount", "applepay", "authentication", "authorize_request", "authorize_request_3d", "authorize_request_3ds2", "authorize_response", "bank_account", "browser_info_3ds1", "browser_info_3ds2", "cancel_request", "cancel_response", "card", "challenge_shopper_additional_data", "chargeback_notification_additional_data", "error", "identify_shopper_additional_data", "inner_notification_request_item", "modification_request", "modification_response", "notification_request", "notification_response", "origin_keys_request", "origin_keys_response", "outer_notification_request_item", "payment_details", "payment_details_v66_3ds2_challenge", "payment_details_v66_3ds2_fingerprint", "payment_request", "payment_response", "payment_response_additional_data", "recurring", "redirect", "redirect_data", "request_for_information_additional_data", "scheme", "sdk_v3_on_complete_data", "sdk_v3_on_complete_result", "three_d_secure_data", "threeds2_request_data", "threeds2_result", "threeds_additional_data" ],
369
369
  "annotations" : [ ]
370
370
  }, {
371
371
  "uri" : "https://app.apibuilder.io/flow/bitpay/latest/service.json",
@@ -376,7 +376,7 @@
376
376
  "application" : {
377
377
  "key" : "bitpay"
378
378
  },
379
- "version" : "0.2.92",
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.92",
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.60",
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.60",
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.92",
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.92",
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.92",
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.60",
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.92",
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.60",
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.60",
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.60",
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.60",
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.60",
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.60",
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.60",
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.60",
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.64",
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.92",
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" : [ ],
@@ -14552,6 +14552,12 @@
14552
14552
  "required" : false,
14553
14553
  "attributes" : [ ],
14554
14554
  "annotations" : [ ]
14555
+ }, {
14556
+ "name" : "identifiers",
14557
+ "type" : "map[string]",
14558
+ "required" : false,
14559
+ "attributes" : [ ],
14560
+ "annotations" : [ ]
14555
14561
  }, {
14556
14562
  "name" : "destination",
14557
14563
  "type" : "billing_order_destination",
@@ -16277,6 +16283,40 @@
16277
16283
  "attributes" : [ ],
16278
16284
  "interfaces" : [ ],
16279
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"
16280
16320
  }, {
16281
16321
  "name" : "calculated_tax_amount",
16282
16322
  "plural" : "calculated_tax_amounts",
@@ -43840,6 +43880,79 @@
43840
43880
  } ],
43841
43881
  "attributes" : [ ],
43842
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"
43843
43956
  }, {
43844
43957
  "name" : "organization_restriction_summary",
43845
43958
  "plural" : "organization_restriction_summaries",
@@ -83934,43 +84047,257 @@
83934
84047
  "type" : "restriction_item_review_decision_form",
83935
84048
  "attributes" : [ ]
83936
84049
  }
83937
- }, {
84050
+ } ],
84051
+ "attributes" : [ {
84052
+ "name" : "docs",
84053
+ "value" : {
84054
+ "module" : "general"
84055
+ }
84056
+ } ],
84057
+ "path" : "/jailhouse/restriction/:organization/items",
84058
+ "description" : "An individual review done on a specific product for a specific restriction rule, includes additional data about the product"
84059
+ }, {
84060
+ "type" : "restriction_organization",
84061
+ "plural" : "restriction_organizations",
84062
+ "operations" : [ {
83938
84063
  "method" : "GET",
83939
- "path" : "/internal/restriction/:organization/items",
84064
+ "path" : "/jailhouse/search/restriction/organizations",
83940
84065
  "parameters" : [ {
83941
- "name" : "organization",
84066
+ "name" : "q",
83942
84067
  "type" : "string",
83943
- "location" : "Path",
84068
+ "location" : "Query",
84069
+ "required" : false,
84070
+ "description" : "Query an organization by name returning all partial matches containing query`"
84071
+ }, {
84072
+ "name" : "ids",
84073
+ "type" : "[string]",
84074
+ "location" : "Query",
84075
+ "required" : false,
84076
+ "description" : "Find organizations by exact match on id",
84077
+ "maximum" : 100
84078
+ }, {
84079
+ "name" : "environment",
84080
+ "type" : "io.flow.common.v0.enums.environment",
84081
+ "location" : "Query",
84082
+ "required" : false,
84083
+ "description" : "Retrieve all organizations in the specified environment. If none is specified it will default to all environments.",
84084
+ "example" : "sandbox"
84085
+ }, {
84086
+ "name" : "limit",
84087
+ "type" : "long",
84088
+ "location" : "Query",
83944
84089
  "required" : true,
83945
- "description" : "Refers to your organization's account identifier"
84090
+ "description" : "The maximum number of results to return",
84091
+ "default" : "25",
84092
+ "minimum" : 1,
84093
+ "maximum" : 100
83946
84094
  }, {
83947
- "name" : "status",
83948
- "type" : "restriction_status",
84095
+ "name" : "offset",
84096
+ "type" : "long",
84097
+ "location" : "Query",
84098
+ "required" : true,
84099
+ "description" : "The number of results to skip before returning results",
84100
+ "default" : "0",
84101
+ "minimum" : 0
84102
+ } ],
84103
+ "responses" : [ {
84104
+ "code" : {
84105
+ "integer" : {
84106
+ "value" : 200
84107
+ }
84108
+ },
84109
+ "type" : "[restriction_organization]",
84110
+ "description" : "Successful response",
84111
+ "attributes" : [ ]
84112
+ }, {
84113
+ "code" : {
84114
+ "integer" : {
84115
+ "value" : 401
84116
+ }
84117
+ },
84118
+ "type" : "unit",
84119
+ "description" : "Authorization failed",
84120
+ "attributes" : [ ]
84121
+ }, {
84122
+ "code" : {
84123
+ "integer" : {
84124
+ "value" : 422
84125
+ }
84126
+ },
84127
+ "type" : "io.flow.error.v0.models.generic_error",
84128
+ "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.",
84129
+ "attributes" : [ ]
84130
+ } ],
84131
+ "attributes" : [ {
84132
+ "name" : "linter",
84133
+ "value" : {
84134
+ "ignore" : [ "get", "id", "sort" ]
84135
+ }
84136
+ } ],
84137
+ "description" : "Returns organizations onboarded into the restrictions platform"
84138
+ } ],
84139
+ "attributes" : [ {
84140
+ "name" : "docs",
84141
+ "value" : {
84142
+ "module" : "general"
84143
+ }
84144
+ } ],
84145
+ "path" : "/jailhouse/search",
84146
+ "description" : "The view of an organization from a restriction perspective - may have its own state machine in the context of the onboarding workflow in the future"
84147
+ }, {
84148
+ "type" : "restriction_organization_decision_summary",
84149
+ "plural" : "restriction_organization_decision_summaries",
84150
+ "operations" : [ {
84151
+ "method" : "GET",
84152
+ "path" : "/jailhouse/restriction/organization/decision/summaries",
84153
+ "parameters" : [ {
84154
+ "name" : "environment",
84155
+ "type" : "io.flow.common.v0.enums.environment",
83949
84156
  "location" : "Query",
83950
84157
  "required" : false,
83951
- "description" : "Overwrites `statuses` if both are present",
83952
- "example" : "in_review"
84158
+ "description" : "Retrieve all organizations in the specified environment. If none is specified it will default to all environments.",
84159
+ "example" : "sandbox"
84160
+ }, {
84161
+ "name" : "rule_ids",
84162
+ "type" : "[string]",
84163
+ "location" : "Query",
84164
+ "required" : false,
84165
+ "maximum" : 100
84166
+ }, {
84167
+ "name" : "earliest_pending_date_before",
84168
+ "type" : "date-time-iso8601",
84169
+ "location" : "Query",
84170
+ "required" : false
84171
+ }, {
84172
+ "name" : "earliest_pending_date_after",
84173
+ "type" : "date-time-iso8601",
84174
+ "location" : "Query",
84175
+ "required" : false,
84176
+ "description" : "Treated as on_or_after"
84177
+ }, {
84178
+ "name" : "limit",
84179
+ "type" : "long",
84180
+ "location" : "Query",
84181
+ "required" : true,
84182
+ "description" : "The maximum number of results to return",
84183
+ "default" : "25",
84184
+ "minimum" : 1,
84185
+ "maximum" : 100
84186
+ }, {
84187
+ "name" : "offset",
84188
+ "type" : "long",
84189
+ "location" : "Query",
84190
+ "required" : true,
84191
+ "description" : "The number of results to skip before returning results",
84192
+ "default" : "0",
84193
+ "minimum" : 0
84194
+ }, {
84195
+ "name" : "sort",
84196
+ "type" : "string",
84197
+ "location" : "Query",
84198
+ "required" : true,
84199
+ "default" : "earliest_pending_date"
84200
+ } ],
84201
+ "responses" : [ {
84202
+ "code" : {
84203
+ "integer" : {
84204
+ "value" : 200
84205
+ }
84206
+ },
84207
+ "type" : "[restriction_organization_decision_summary]",
84208
+ "description" : "Successful response",
84209
+ "attributes" : [ ]
84210
+ }, {
84211
+ "code" : {
84212
+ "integer" : {
84213
+ "value" : 401
84214
+ }
84215
+ },
84216
+ "type" : "unit",
84217
+ "description" : "Authorization failed",
84218
+ "attributes" : [ ]
84219
+ }, {
84220
+ "code" : {
84221
+ "integer" : {
84222
+ "value" : 422
84223
+ }
84224
+ },
84225
+ "type" : "io.flow.error.v0.models.generic_error",
84226
+ "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.",
84227
+ "attributes" : [ ]
84228
+ } ],
84229
+ "attributes" : [ {
84230
+ "name" : "linter",
84231
+ "value" : {
84232
+ "ignore" : [ "get", "id", "sort" ]
84233
+ }
84234
+ }, {
84235
+ "name" : "sort",
84236
+ "value" : {
84237
+ "values" : [ {
84238
+ "value" : "earliest_pending_date"
84239
+ }, {
84240
+ "value" : "organization.name"
84241
+ }, {
84242
+ "value" : "organization.created_at"
84243
+ }, {
84244
+ "value" : "count"
84245
+ }, {
84246
+ "value" : "statuses.in_review.count"
84247
+ }, {
84248
+ "value" : "statuses.escalated.count"
84249
+ } ]
84250
+ }
84251
+ } ],
84252
+ "description" : "Returns summaries about restriction decisions for items"
84253
+ } ],
84254
+ "attributes" : [ {
84255
+ "name" : "docs",
84256
+ "value" : {
84257
+ "module" : "general"
84258
+ }
84259
+ } ],
84260
+ "path" : "/jailhouse/restriction/organization/decision/summaries",
84261
+ "description" : "Aggregate counts for individual restriction decisions"
84262
+ }, {
84263
+ "type" : "restriction_product",
84264
+ "plural" : "restriction_products",
84265
+ "operations" : [ {
84266
+ "method" : "GET",
84267
+ "path" : "/jailhouse/restriction/:organization/products",
84268
+ "parameters" : [ {
84269
+ "name" : "organization",
84270
+ "type" : "string",
84271
+ "location" : "Path",
84272
+ "required" : true,
84273
+ "description" : "Refers to your organization's account identifier"
83953
84274
  }, {
83954
84275
  "name" : "statuses",
83955
84276
  "type" : "[restriction_status]",
83956
84277
  "location" : "Query",
83957
84278
  "required" : false,
84279
+ "deprecation" : {
84280
+ "description" : "This parameter is deprecated. Please use the 'restricted_rules' or 'accepted_rules'"
84281
+ },
83958
84282
  "maximum" : 5
83959
84283
  }, {
83960
84284
  "name" : "rule_ids",
83961
84285
  "type" : "[string]",
83962
84286
  "location" : "Query",
83963
84287
  "required" : false,
84288
+ "deprecation" : {
84289
+ "description" : "This parameter is deprecated. Please use the 'restricted_rules' or 'accepted_rules'"
84290
+ },
83964
84291
  "maximum" : 100
83965
84292
  }, {
83966
- "name" : "categories",
84293
+ "name" : "restricted_rules",
83967
84294
  "type" : "[string]",
83968
84295
  "location" : "Query",
83969
84296
  "required" : false,
83970
84297
  "maximum" : 100
83971
84298
  }, {
83972
- "name" : "product_name_query",
83973
- "type" : "string",
84299
+ "name" : "accepted_rules",
84300
+ "type" : "[string]",
83974
84301
  "location" : "Query",
83975
84302
  "required" : false,
83976
84303
  "maximum" : 100
@@ -83982,488 +84309,12 @@
83982
84309
  "maximum" : 100
83983
84310
  }, {
83984
84311
  "name" : "negative_keywords",
83985
- "type" : "[string]",
83986
- "location" : "Query",
83987
- "required" : false,
83988
- "maximum" : 100
83989
- }, {
83990
- "name" : "limit",
83991
- "type" : "long",
83992
- "location" : "Query",
83993
- "required" : true,
83994
- "description" : "The maximum number of results to return",
83995
- "default" : "25",
83996
- "minimum" : 1,
83997
- "maximum" : 100
83998
- }, {
83999
- "name" : "offset",
84000
- "type" : "long",
84001
- "location" : "Query",
84002
- "required" : true,
84003
- "description" : "The number of results to skip before returning results",
84004
- "default" : "0",
84005
- "minimum" : 0
84006
- }, {
84007
- "name" : "sort",
84008
- "type" : "string",
84009
- "location" : "Query",
84010
- "required" : true,
84011
- "default" : "created_at"
84012
- } ],
84013
- "responses" : [ {
84014
- "code" : {
84015
- "integer" : {
84016
- "value" : 200
84017
- }
84018
- },
84019
- "type" : "[restriction_item]",
84020
- "description" : "Successful response",
84021
- "attributes" : [ ]
84022
- }, {
84023
- "code" : {
84024
- "integer" : {
84025
- "value" : 401
84026
- }
84027
- },
84028
- "type" : "unit",
84029
- "description" : "Authorization failed",
84030
- "attributes" : [ ]
84031
- }, {
84032
- "code" : {
84033
- "integer" : {
84034
- "value" : 422
84035
- }
84036
- },
84037
- "type" : "io.flow.error.v0.models.generic_error",
84038
- "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.",
84039
- "attributes" : [ ]
84040
- } ],
84041
- "attributes" : [ {
84042
- "name" : "linter",
84043
- "value" : {
84044
- "ignore" : [ "get", "id", "sort" ]
84045
- }
84046
- }, {
84047
- "name" : "sort",
84048
- "value" : {
84049
- "values" : [ {
84050
- "value" : "created_at"
84051
- }, {
84052
- "value" : "updated_at"
84053
- }, {
84054
- "value" : "name"
84055
- } ]
84056
- }
84057
- } ],
84058
- "description" : "Returns a list of item restriction decisions for an organization"
84059
- }, {
84060
- "method" : "POST",
84061
- "path" : "/internal/restriction/:organization/items",
84062
- "parameters" : [ {
84063
- "name" : "organization",
84064
- "type" : "string",
84065
- "location" : "Path",
84066
- "required" : true,
84067
- "description" : "Refers to your organization's account identifier"
84068
- } ],
84069
- "responses" : [ {
84070
- "code" : {
84071
- "integer" : {
84072
- "value" : 201
84073
- }
84074
- },
84075
- "type" : "restriction_item",
84076
- "description" : "Operation succeeded and the resource was created",
84077
- "attributes" : [ ]
84078
- }, {
84079
- "code" : {
84080
- "integer" : {
84081
- "value" : 401
84082
- }
84083
- },
84084
- "type" : "unit",
84085
- "description" : "Authorization failed",
84086
- "attributes" : [ ]
84087
- }, {
84088
- "code" : {
84089
- "integer" : {
84090
- "value" : 422
84091
- }
84092
- },
84093
- "type" : "io.flow.error.v0.models.generic_error",
84094
- "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.",
84095
- "attributes" : [ ]
84096
- } ],
84097
- "attributes" : [ ],
84098
- "description" : "Set the restriction decision for a product item",
84099
- "body" : {
84100
- "type" : "restriction_item_review_decision_form",
84101
- "attributes" : [ ]
84102
- }
84103
- }, {
84104
- "method" : "GET",
84105
- "path" : "/internal/restriction/:organization/items/:id",
84106
- "parameters" : [ {
84107
- "name" : "organization",
84108
- "type" : "string",
84109
- "location" : "Path",
84110
- "required" : true,
84111
- "description" : "Refers to your organization's account identifier"
84112
- }, {
84113
- "name" : "id",
84114
- "type" : "string",
84115
- "location" : "Path",
84116
- "required" : true,
84117
- "description" : "Filter by one or more IDs of this resource"
84118
- } ],
84119
- "responses" : [ {
84120
- "code" : {
84121
- "integer" : {
84122
- "value" : 200
84123
- }
84124
- },
84125
- "type" : "restriction_item",
84126
- "description" : "Successful response",
84127
- "attributes" : [ ]
84128
- }, {
84129
- "code" : {
84130
- "integer" : {
84131
- "value" : 401
84132
- }
84133
- },
84134
- "type" : "unit",
84135
- "description" : "Authorization failed",
84136
- "attributes" : [ ]
84137
- }, {
84138
- "code" : {
84139
- "integer" : {
84140
- "value" : 404
84141
- }
84142
- },
84143
- "type" : "unit",
84144
- "description" : "Resource was not found",
84145
- "attributes" : [ ]
84146
- } ],
84147
- "attributes" : [ ],
84148
- "description" : "Returns a restriction product item by id"
84149
- }, {
84150
- "method" : "PUT",
84151
- "path" : "/internal/restriction/:organization/items/:id",
84152
- "parameters" : [ {
84153
- "name" : "organization",
84154
- "type" : "string",
84155
- "location" : "Path",
84156
- "required" : true,
84157
- "description" : "Refers to your organization's account identifier"
84158
- }, {
84159
- "name" : "id",
84160
- "type" : "string",
84161
- "location" : "Path",
84162
- "required" : true,
84163
- "description" : "Filter by one or more IDs of this resource"
84164
- } ],
84165
- "responses" : [ {
84166
- "code" : {
84167
- "integer" : {
84168
- "value" : 200
84169
- }
84170
- },
84171
- "type" : "restriction_item",
84172
- "description" : "Successful response",
84173
- "attributes" : [ ]
84174
- }, {
84175
- "code" : {
84176
- "integer" : {
84177
- "value" : 201
84178
- }
84179
- },
84180
- "type" : "restriction_item",
84181
- "description" : "Operation succeeded and the resource was created",
84182
- "attributes" : [ ]
84183
- }, {
84184
- "code" : {
84185
- "integer" : {
84186
- "value" : 401
84187
- }
84188
- },
84189
- "type" : "unit",
84190
- "description" : "Authorization failed",
84191
- "attributes" : [ ]
84192
- }, {
84193
- "code" : {
84194
- "integer" : {
84195
- "value" : 404
84196
- }
84197
- },
84198
- "type" : "unit",
84199
- "description" : "Resource was not found",
84200
- "attributes" : [ ]
84201
- }, {
84202
- "code" : {
84203
- "integer" : {
84204
- "value" : 422
84205
- }
84206
- },
84207
- "type" : "io.flow.error.v0.models.generic_error",
84208
- "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.",
84209
- "attributes" : [ ]
84210
- } ],
84211
- "attributes" : [ ],
84212
- "description" : "Update the restriction decision for a product item",
84213
- "body" : {
84214
- "type" : "restriction_item_review_decision_form",
84215
- "attributes" : [ ]
84216
- }
84217
- } ],
84218
- "attributes" : [ {
84219
- "name" : "docs",
84220
- "value" : {
84221
- "module" : "general"
84222
- }
84223
- } ],
84224
- "path" : "/jailhouse/restriction/:organization/items",
84225
- "description" : "An individual review done on a specific product for a specific restriction rule, includes additional data about the product"
84226
- }, {
84227
- "type" : "restriction_organization",
84228
- "plural" : "restriction_organizations",
84229
- "operations" : [ {
84230
- "method" : "GET",
84231
- "path" : "/jailhouse/search/restriction/organizations",
84232
- "parameters" : [ {
84233
- "name" : "q",
84234
- "type" : "string",
84235
- "location" : "Query",
84236
- "required" : false,
84237
- "description" : "Query an organization by name returning all partial matches containing query`"
84238
- }, {
84239
- "name" : "ids",
84240
- "type" : "[string]",
84241
- "location" : "Query",
84242
- "required" : false,
84243
- "description" : "Find organizations by exact match on id",
84244
- "maximum" : 100
84245
- }, {
84246
- "name" : "environment",
84247
- "type" : "io.flow.common.v0.enums.environment",
84248
- "location" : "Query",
84249
- "required" : false,
84250
- "description" : "Retrieve all organizations in the specified environment. If none is specified it will default to all environments.",
84251
- "example" : "sandbox"
84252
- }, {
84253
- "name" : "limit",
84254
- "type" : "long",
84255
- "location" : "Query",
84256
- "required" : true,
84257
- "description" : "The maximum number of results to return",
84258
- "default" : "25",
84259
- "minimum" : 1,
84260
- "maximum" : 100
84261
- }, {
84262
- "name" : "offset",
84263
- "type" : "long",
84264
- "location" : "Query",
84265
- "required" : true,
84266
- "description" : "The number of results to skip before returning results",
84267
- "default" : "0",
84268
- "minimum" : 0
84269
- } ],
84270
- "responses" : [ {
84271
- "code" : {
84272
- "integer" : {
84273
- "value" : 200
84274
- }
84275
- },
84276
- "type" : "[restriction_organization]",
84277
- "description" : "Successful response",
84278
- "attributes" : [ ]
84279
- }, {
84280
- "code" : {
84281
- "integer" : {
84282
- "value" : 401
84283
- }
84284
- },
84285
- "type" : "unit",
84286
- "description" : "Authorization failed",
84287
- "attributes" : [ ]
84288
- }, {
84289
- "code" : {
84290
- "integer" : {
84291
- "value" : 422
84292
- }
84293
- },
84294
- "type" : "io.flow.error.v0.models.generic_error",
84295
- "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.",
84296
- "attributes" : [ ]
84297
- } ],
84298
- "attributes" : [ {
84299
- "name" : "linter",
84300
- "value" : {
84301
- "ignore" : [ "get", "id", "sort" ]
84302
- }
84303
- } ],
84304
- "description" : "Returns organizations onboarded into the restrictions platform"
84305
- } ],
84306
- "attributes" : [ {
84307
- "name" : "docs",
84308
- "value" : {
84309
- "module" : "general"
84310
- }
84311
- } ],
84312
- "path" : "/jailhouse/search",
84313
- "description" : "The view of an organization from a restriction perspective - may have its own state machine in the context of the onboarding workflow in the future"
84314
- }, {
84315
- "type" : "restriction_organization_decision_summary",
84316
- "plural" : "restriction_organization_decision_summaries",
84317
- "operations" : [ {
84318
- "method" : "GET",
84319
- "path" : "/jailhouse/restriction/organization/decision/summaries",
84320
- "parameters" : [ {
84321
- "name" : "environment",
84322
- "type" : "io.flow.common.v0.enums.environment",
84323
- "location" : "Query",
84324
- "required" : false,
84325
- "description" : "Retrieve all organizations in the specified environment. If none is specified it will default to all environments.",
84326
- "example" : "sandbox"
84327
- }, {
84328
- "name" : "rule_ids",
84329
- "type" : "[string]",
84330
- "location" : "Query",
84331
- "required" : false,
84332
- "maximum" : 100
84333
- }, {
84334
- "name" : "earliest_pending_date_before",
84335
- "type" : "date-time-iso8601",
84336
- "location" : "Query",
84337
- "required" : false
84338
- }, {
84339
- "name" : "earliest_pending_date_after",
84340
- "type" : "date-time-iso8601",
84341
- "location" : "Query",
84342
- "required" : false,
84343
- "description" : "Treated as on_or_after"
84344
- }, {
84345
- "name" : "limit",
84346
- "type" : "long",
84347
- "location" : "Query",
84348
- "required" : true,
84349
- "description" : "The maximum number of results to return",
84350
- "default" : "25",
84351
- "minimum" : 1,
84352
- "maximum" : 100
84353
- }, {
84354
- "name" : "offset",
84355
- "type" : "long",
84356
- "location" : "Query",
84357
- "required" : true,
84358
- "description" : "The number of results to skip before returning results",
84359
- "default" : "0",
84360
- "minimum" : 0
84361
- }, {
84362
- "name" : "sort",
84363
- "type" : "string",
84364
- "location" : "Query",
84365
- "required" : true,
84366
- "default" : "earliest_pending_date"
84367
- } ],
84368
- "responses" : [ {
84369
- "code" : {
84370
- "integer" : {
84371
- "value" : 200
84372
- }
84373
- },
84374
- "type" : "[restriction_organization_decision_summary]",
84375
- "description" : "Successful response",
84376
- "attributes" : [ ]
84377
- }, {
84378
- "code" : {
84379
- "integer" : {
84380
- "value" : 401
84381
- }
84382
- },
84383
- "type" : "unit",
84384
- "description" : "Authorization failed",
84385
- "attributes" : [ ]
84386
- }, {
84387
- "code" : {
84388
- "integer" : {
84389
- "value" : 422
84390
- }
84391
- },
84392
- "type" : "io.flow.error.v0.models.generic_error",
84393
- "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.",
84394
- "attributes" : [ ]
84395
- } ],
84396
- "attributes" : [ {
84397
- "name" : "linter",
84398
- "value" : {
84399
- "ignore" : [ "get", "id", "sort" ]
84400
- }
84401
- }, {
84402
- "name" : "sort",
84403
- "value" : {
84404
- "values" : [ {
84405
- "value" : "earliest_pending_date"
84406
- }, {
84407
- "value" : "organization.name"
84408
- }, {
84409
- "value" : "organization.created_at"
84410
- }, {
84411
- "value" : "count"
84412
- }, {
84413
- "value" : "statuses.in_review.count"
84414
- }, {
84415
- "value" : "statuses.escalated.count"
84416
- } ]
84417
- }
84418
- } ],
84419
- "description" : "Returns summaries about restriction decisions for items"
84420
- } ],
84421
- "attributes" : [ {
84422
- "name" : "docs",
84423
- "value" : {
84424
- "module" : "general"
84425
- }
84426
- } ],
84427
- "path" : "/jailhouse/restriction/organization/decision/summaries",
84428
- "description" : "Aggregate counts for individual restriction decisions"
84429
- }, {
84430
- "type" : "restriction_product",
84431
- "plural" : "restriction_products",
84432
- "operations" : [ {
84433
- "method" : "GET",
84434
- "path" : "/jailhouse/restriction/:organization/products",
84435
- "parameters" : [ {
84436
- "name" : "organization",
84437
- "type" : "string",
84438
- "location" : "Path",
84439
- "required" : true,
84440
- "description" : "Refers to your organization's account identifier"
84441
- }, {
84442
- "name" : "statuses",
84443
- "type" : "[restriction_status]",
84444
- "location" : "Query",
84445
- "required" : false,
84446
- "maximum" : 5
84447
- }, {
84448
- "name" : "rule_ids",
84449
- "type" : "[string]",
84450
- "location" : "Query",
84451
- "required" : false,
84452
- "maximum" : 100
84453
- }, {
84454
- "name" : "positive_keywords",
84455
- "type" : "[string]",
84456
- "location" : "Query",
84457
- "required" : false,
84458
- "maximum" : 100
84459
- }, {
84460
- "name" : "negative_keywords",
84461
- "type" : "[string]",
84462
- "location" : "Query",
84463
- "required" : false,
84464
- "maximum" : 100
84465
- }, {
84466
- "name" : "user_ids",
84312
+ "type" : "[string]",
84313
+ "location" : "Query",
84314
+ "required" : false,
84315
+ "maximum" : 100
84316
+ }, {
84317
+ "name" : "user_ids",
84467
84318
  "type" : "[string]",
84468
84319
  "location" : "Query",
84469
84320
  "required" : false,
@@ -84643,220 +84494,6 @@
84643
84494
  "type" : "restriction_product_decision_form",
84644
84495
  "attributes" : [ ]
84645
84496
  }
84646
- }, {
84647
- "method" : "GET",
84648
- "path" : "/internal/restriction/:organization/products",
84649
- "parameters" : [ {
84650
- "name" : "organization",
84651
- "type" : "string",
84652
- "location" : "Path",
84653
- "required" : true,
84654
- "description" : "Refers to your organization's account identifier"
84655
- }, {
84656
- "name" : "statuses",
84657
- "type" : "[restriction_status]",
84658
- "location" : "Query",
84659
- "required" : false,
84660
- "maximum" : 5
84661
- }, {
84662
- "name" : "rule_ids",
84663
- "type" : "[string]",
84664
- "location" : "Query",
84665
- "required" : false,
84666
- "maximum" : 100
84667
- }, {
84668
- "name" : "positive_keywords",
84669
- "type" : "[string]",
84670
- "location" : "Query",
84671
- "required" : false,
84672
- "maximum" : 100
84673
- }, {
84674
- "name" : "negative_keywords",
84675
- "type" : "[string]",
84676
- "location" : "Query",
84677
- "required" : false,
84678
- "maximum" : 100
84679
- }, {
84680
- "name" : "user_ids",
84681
- "type" : "[string]",
84682
- "location" : "Query",
84683
- "required" : false,
84684
- "maximum" : 100
84685
- }, {
84686
- "name" : "limit",
84687
- "type" : "long",
84688
- "location" : "Query",
84689
- "required" : true,
84690
- "description" : "The maximum number of results to return",
84691
- "default" : "25",
84692
- "minimum" : 1,
84693
- "maximum" : 100
84694
- }, {
84695
- "name" : "offset",
84696
- "type" : "long",
84697
- "location" : "Query",
84698
- "required" : true,
84699
- "description" : "The number of results to skip before returning results",
84700
- "default" : "0",
84701
- "minimum" : 0
84702
- }, {
84703
- "name" : "sort",
84704
- "type" : "string",
84705
- "location" : "Query",
84706
- "required" : true,
84707
- "default" : "created_at"
84708
- } ],
84709
- "responses" : [ {
84710
- "code" : {
84711
- "integer" : {
84712
- "value" : 200
84713
- }
84714
- },
84715
- "type" : "[restriction_product]",
84716
- "description" : "Successful response",
84717
- "attributes" : [ ]
84718
- }, {
84719
- "code" : {
84720
- "integer" : {
84721
- "value" : 401
84722
- }
84723
- },
84724
- "type" : "unit",
84725
- "description" : "Authorization failed",
84726
- "attributes" : [ ]
84727
- }, {
84728
- "code" : {
84729
- "integer" : {
84730
- "value" : 422
84731
- }
84732
- },
84733
- "type" : "io.flow.error.v0.models.generic_error",
84734
- "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.",
84735
- "attributes" : [ ]
84736
- } ],
84737
- "attributes" : [ {
84738
- "name" : "linter",
84739
- "value" : {
84740
- "ignore" : [ "get", "id", "sort" ]
84741
- }
84742
- }, {
84743
- "name" : "sort",
84744
- "value" : {
84745
- "values" : [ {
84746
- "value" : "created_at"
84747
- }, {
84748
- "value" : "updated_at"
84749
- }, {
84750
- "value" : "name"
84751
- } ]
84752
- }
84753
- } ],
84754
- "description" : "Returns a list of products and their restriction information for an organization"
84755
- }, {
84756
- "method" : "GET",
84757
- "path" : "/internal/restriction/:organization/products/:id",
84758
- "parameters" : [ {
84759
- "name" : "organization",
84760
- "type" : "string",
84761
- "location" : "Path",
84762
- "required" : true,
84763
- "description" : "Refers to your organization's account identifier"
84764
- }, {
84765
- "name" : "id",
84766
- "type" : "string",
84767
- "location" : "Path",
84768
- "required" : true,
84769
- "description" : "Filter by one or more IDs of this resource"
84770
- } ],
84771
- "responses" : [ {
84772
- "code" : {
84773
- "integer" : {
84774
- "value" : 200
84775
- }
84776
- },
84777
- "type" : "restriction_product",
84778
- "description" : "Successful response",
84779
- "attributes" : [ ]
84780
- }, {
84781
- "code" : {
84782
- "integer" : {
84783
- "value" : 401
84784
- }
84785
- },
84786
- "type" : "unit",
84787
- "description" : "Authorization failed",
84788
- "attributes" : [ ]
84789
- }, {
84790
- "code" : {
84791
- "integer" : {
84792
- "value" : 404
84793
- }
84794
- },
84795
- "type" : "unit",
84796
- "description" : "Resource was not found",
84797
- "attributes" : [ ]
84798
- } ],
84799
- "attributes" : [ ],
84800
- "description" : "Returns a product by id"
84801
- }, {
84802
- "method" : "POST",
84803
- "path" : "/internal/restriction/:organization/products/:id/decisions",
84804
- "parameters" : [ {
84805
- "name" : "organization",
84806
- "type" : "string",
84807
- "location" : "Path",
84808
- "required" : true,
84809
- "description" : "Refers to your organization's account identifier"
84810
- }, {
84811
- "name" : "id",
84812
- "type" : "string",
84813
- "location" : "Path",
84814
- "required" : true,
84815
- "description" : "Filter by one or more IDs of this resource"
84816
- } ],
84817
- "responses" : [ {
84818
- "code" : {
84819
- "integer" : {
84820
- "value" : 200
84821
- }
84822
- },
84823
- "type" : "restriction_product",
84824
- "description" : "Successful response",
84825
- "attributes" : [ ]
84826
- }, {
84827
- "code" : {
84828
- "integer" : {
84829
- "value" : 401
84830
- }
84831
- },
84832
- "type" : "unit",
84833
- "description" : "Authorization failed",
84834
- "attributes" : [ ]
84835
- }, {
84836
- "code" : {
84837
- "integer" : {
84838
- "value" : 404
84839
- }
84840
- },
84841
- "type" : "unit",
84842
- "description" : "Resource was not found",
84843
- "attributes" : [ ]
84844
- }, {
84845
- "code" : {
84846
- "integer" : {
84847
- "value" : 422
84848
- }
84849
- },
84850
- "type" : "io.flow.error.v0.models.generic_error",
84851
- "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.",
84852
- "attributes" : [ ]
84853
- } ],
84854
- "attributes" : [ ],
84855
- "description" : "Updates restriction decisions on a given product",
84856
- "body" : {
84857
- "type" : "restriction_product_decision_form",
84858
- "attributes" : [ ]
84859
- }
84860
84497
  } ],
84861
84498
  "attributes" : [ {
84862
84499
  "name" : "docs",
@@ -85068,303 +84705,6 @@
85068
84705
  }
85069
84706
  } ],
85070
84707
  "description" : "Returns the list of restriction rules currently applicable for an organization"
85071
- }, {
85072
- "method" : "GET",
85073
- "path" : "/internal/restriction/rules",
85074
- "parameters" : [ {
85075
- "name" : "id",
85076
- "type" : "[string]",
85077
- "location" : "Query",
85078
- "required" : false,
85079
- "description" : "Filter by one or more IDs of this resource",
85080
- "maximum" : 100
85081
- }, {
85082
- "name" : "name",
85083
- "type" : "string",
85084
- "location" : "Query",
85085
- "required" : false
85086
- }, {
85087
- "name" : "limit",
85088
- "type" : "long",
85089
- "location" : "Query",
85090
- "required" : true,
85091
- "description" : "The maximum number of results to return",
85092
- "default" : "25",
85093
- "minimum" : 1,
85094
- "maximum" : 100
85095
- }, {
85096
- "name" : "offset",
85097
- "type" : "long",
85098
- "location" : "Query",
85099
- "required" : true,
85100
- "description" : "The number of results to skip before returning results",
85101
- "default" : "0",
85102
- "minimum" : 0
85103
- }, {
85104
- "name" : "sort",
85105
- "type" : "string",
85106
- "location" : "Query",
85107
- "required" : true,
85108
- "default" : "name"
85109
- } ],
85110
- "responses" : [ {
85111
- "code" : {
85112
- "integer" : {
85113
- "value" : 200
85114
- }
85115
- },
85116
- "type" : "[restriction_rule]",
85117
- "description" : "Successful response",
85118
- "attributes" : [ ]
85119
- }, {
85120
- "code" : {
85121
- "integer" : {
85122
- "value" : 401
85123
- }
85124
- },
85125
- "type" : "unit",
85126
- "description" : "Authorization failed",
85127
- "attributes" : [ ]
85128
- }, {
85129
- "code" : {
85130
- "integer" : {
85131
- "value" : 422
85132
- }
85133
- },
85134
- "type" : "io.flow.error.v0.models.generic_error",
85135
- "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.",
85136
- "attributes" : [ ]
85137
- } ],
85138
- "attributes" : [ {
85139
- "name" : "sort",
85140
- "value" : {
85141
- "values" : [ {
85142
- "value" : "name"
85143
- }, {
85144
- "value" : "created_at"
85145
- } ]
85146
- }
85147
- } ]
85148
- }, {
85149
- "method" : "POST",
85150
- "path" : "/internal/restriction/rules",
85151
- "parameters" : [ ],
85152
- "responses" : [ {
85153
- "code" : {
85154
- "integer" : {
85155
- "value" : 201
85156
- }
85157
- },
85158
- "type" : "restriction_rule",
85159
- "description" : "Operation succeeded and the resource was created",
85160
- "attributes" : [ ]
85161
- }, {
85162
- "code" : {
85163
- "integer" : {
85164
- "value" : 401
85165
- }
85166
- },
85167
- "type" : "unit",
85168
- "description" : "Authorization failed",
85169
- "attributes" : [ ]
85170
- }, {
85171
- "code" : {
85172
- "integer" : {
85173
- "value" : 422
85174
- }
85175
- },
85176
- "type" : "io.flow.error.v0.models.generic_error",
85177
- "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.",
85178
- "attributes" : [ ]
85179
- } ],
85180
- "attributes" : [ ],
85181
- "body" : {
85182
- "type" : "restriction_rule_form",
85183
- "attributes" : [ ]
85184
- }
85185
- }, {
85186
- "method" : "GET",
85187
- "path" : "/internal/restriction/rules/:id",
85188
- "parameters" : [ {
85189
- "name" : "id",
85190
- "type" : "string",
85191
- "location" : "Path",
85192
- "required" : true,
85193
- "description" : "Filter by one or more IDs of this resource"
85194
- } ],
85195
- "responses" : [ {
85196
- "code" : {
85197
- "integer" : {
85198
- "value" : 200
85199
- }
85200
- },
85201
- "type" : "restriction_rule",
85202
- "description" : "Successful response",
85203
- "attributes" : [ ]
85204
- }, {
85205
- "code" : {
85206
- "integer" : {
85207
- "value" : 401
85208
- }
85209
- },
85210
- "type" : "unit",
85211
- "description" : "Authorization failed",
85212
- "attributes" : [ ]
85213
- }, {
85214
- "code" : {
85215
- "integer" : {
85216
- "value" : 404
85217
- }
85218
- },
85219
- "type" : "unit",
85220
- "description" : "Resource was not found",
85221
- "attributes" : [ ]
85222
- } ],
85223
- "attributes" : [ ]
85224
- }, {
85225
- "method" : "PUT",
85226
- "path" : "/internal/restriction/rules/:id",
85227
- "parameters" : [ {
85228
- "name" : "id",
85229
- "type" : "string",
85230
- "location" : "Path",
85231
- "required" : true,
85232
- "description" : "Filter by one or more IDs of this resource"
85233
- } ],
85234
- "responses" : [ {
85235
- "code" : {
85236
- "integer" : {
85237
- "value" : 200
85238
- }
85239
- },
85240
- "type" : "restriction_rule",
85241
- "description" : "Successful response",
85242
- "attributes" : [ ]
85243
- }, {
85244
- "code" : {
85245
- "integer" : {
85246
- "value" : 201
85247
- }
85248
- },
85249
- "type" : "restriction_rule",
85250
- "description" : "Operation succeeded and the resource was created",
85251
- "attributes" : [ ]
85252
- }, {
85253
- "code" : {
85254
- "integer" : {
85255
- "value" : 401
85256
- }
85257
- },
85258
- "type" : "unit",
85259
- "description" : "Authorization failed",
85260
- "attributes" : [ ]
85261
- }, {
85262
- "code" : {
85263
- "integer" : {
85264
- "value" : 404
85265
- }
85266
- },
85267
- "type" : "unit",
85268
- "description" : "Resource was not found",
85269
- "attributes" : [ ]
85270
- }, {
85271
- "code" : {
85272
- "integer" : {
85273
- "value" : 422
85274
- }
85275
- },
85276
- "type" : "io.flow.error.v0.models.generic_error",
85277
- "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.",
85278
- "attributes" : [ ]
85279
- } ],
85280
- "attributes" : [ ],
85281
- "body" : {
85282
- "type" : "restriction_rule_form",
85283
- "attributes" : [ ]
85284
- }
85285
- }, {
85286
- "method" : "GET",
85287
- "path" : "/internal/restriction/rules/:organization/:status",
85288
- "parameters" : [ {
85289
- "name" : "organization",
85290
- "type" : "string",
85291
- "location" : "Path",
85292
- "required" : true,
85293
- "description" : "Refers to your organization's account identifier"
85294
- }, {
85295
- "name" : "status",
85296
- "type" : "restriction_status",
85297
- "location" : "Path",
85298
- "required" : true,
85299
- "example" : "in_review"
85300
- }, {
85301
- "name" : "id",
85302
- "type" : "[string]",
85303
- "location" : "Query",
85304
- "required" : false,
85305
- "description" : "Filter by one or more IDs of this resource",
85306
- "maximum" : 100
85307
- }, {
85308
- "name" : "limit",
85309
- "type" : "long",
85310
- "location" : "Query",
85311
- "required" : true,
85312
- "description" : "The maximum number of results to return",
85313
- "default" : "25",
85314
- "minimum" : 1,
85315
- "maximum" : 100
85316
- }, {
85317
- "name" : "offset",
85318
- "type" : "long",
85319
- "location" : "Query",
85320
- "required" : true,
85321
- "description" : "The number of results to skip before returning results",
85322
- "default" : "0",
85323
- "minimum" : 0
85324
- }, {
85325
- "name" : "sort",
85326
- "type" : "string",
85327
- "location" : "Query",
85328
- "required" : true,
85329
- "default" : "name"
85330
- } ],
85331
- "responses" : [ {
85332
- "code" : {
85333
- "integer" : {
85334
- "value" : 200
85335
- }
85336
- },
85337
- "type" : "[restriction_rule_summary]",
85338
- "description" : "Successful response",
85339
- "attributes" : [ ]
85340
- }, {
85341
- "code" : {
85342
- "integer" : {
85343
- "value" : 401
85344
- }
85345
- },
85346
- "type" : "unit",
85347
- "description" : "Authorization failed",
85348
- "attributes" : [ ]
85349
- }, {
85350
- "code" : {
85351
- "integer" : {
85352
- "value" : 422
85353
- }
85354
- },
85355
- "type" : "io.flow.error.v0.models.generic_error",
85356
- "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.",
85357
- "attributes" : [ ]
85358
- } ],
85359
- "attributes" : [ {
85360
- "name" : "sort",
85361
- "value" : {
85362
- "values" : [ {
85363
- "value" : "name"
85364
- } ]
85365
- }
85366
- } ],
85367
- "description" : "Returns the list of restriction rules currently applicable for an organization"
85368
84708
  } ],
85369
84709
  "attributes" : [ {
85370
84710
  "name" : "docs",