plainrouter-sdk 0.1.1 → 0.5.0
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.
- checksums.yaml +4 -4
- data/README.md +11 -4
- data/lib/plainrouter/client.rb +75 -2
- data/lib/plainrouter/openapi/api/action_dry_run_api_api.rb +96 -0
- data/lib/plainrouter/openapi/api/action_proposal_api_api.rb +96 -0
- data/lib/plainrouter/openapi/api/action_read_api_api.rb +404 -0
- data/lib/plainrouter/openapi/api/ad_test_api_api.rb +259 -0
- data/lib/plainrouter/openapi/api/cookie_declaration_api.rb +90 -0
- data/lib/plainrouter/openapi/api/creative_api.rb +181 -0
- data/lib/plainrouter/openapi/api/deployment_plan_api.rb +306 -0
- data/lib/plainrouter/openapi/api/event_api.rb +15 -15
- data/lib/plainrouter/openapi/api/meta_inventory_exposure_api.rb +121 -0
- data/lib/plainrouter/openapi/api/operations_api.rb +24 -28
- data/lib/plainrouter/openapi/api/sandbox_api.rb +74 -17
- data/lib/plainrouter/openapi/api_client.rb +2 -2
- data/lib/plainrouter/openapi/api_error.rb +2 -2
- data/lib/plainrouter/openapi/api_model_base.rb +2 -2
- data/lib/plainrouter/openapi/configuration.rb +52 -3
- data/lib/plainrouter/openapi/models/action_batch_read.rb +164 -0
- data/lib/plainrouter/openapi/models/action_batch_read_data.rb +450 -0
- data/lib/plainrouter/openapi/models/action_current_disposition.rb +306 -0
- data/lib/plainrouter/openapi/models/action_current_disposition_outcome_payload.rb +238 -0
- data/lib/plainrouter/openapi/models/action_current_disposition_outcome_payload_baseline.rb +103 -0
- data/lib/plainrouter/openapi/models/action_current_disposition_outcome_payload_baseline_any_of.rb +245 -0
- data/lib/plainrouter/openapi/models/action_current_disposition_outcome_payload_inverse.rb +206 -0
- data/lib/plainrouter/openapi/models/action_current_disposition_outcome_payload_metrics.rb +103 -0
- data/lib/plainrouter/openapi/models/action_current_disposition_outcome_payload_metrics_any_of.rb +276 -0
- data/lib/plainrouter/openapi/models/action_decision_receipt_read.rb +244 -0
- data/lib/plainrouter/openapi/models/action_decision_receipt_read_chain_entry.rb +190 -0
- data/lib/plainrouter/openapi/models/action_detail_read.rb +164 -0
- data/lib/plainrouter/openapi/models/action_dry_run_read.rb +164 -0
- data/lib/plainrouter/openapi/models/action_dry_run_read_dry_run.rb +166 -0
- data/lib/plainrouter/openapi/models/action_dry_run_read_dry_run_actions_inner.rb +103 -0
- data/lib/plainrouter/openapi/models/action_dry_run_read_dry_run_actions_inner_any_of.rb +376 -0
- data/lib/plainrouter/openapi/models/action_dry_run_read_dry_run_actions_inner_any_of1.rb +268 -0
- data/lib/plainrouter/openapi/models/action_dry_run_read_dry_run_actions_inner_any_of_diff.rb +162 -0
- data/lib/plainrouter/openapi/models/action_dry_run_read_dry_run_actions_inner_any_of_target_entity.rb +199 -0
- data/lib/plainrouter/openapi/models/action_list_read.rb +192 -0
- data/lib/plainrouter/openapi/models/action_list_read_meta.rb +242 -0
- data/lib/plainrouter/openapi/models/action_policy_read.rb +164 -0
- data/lib/plainrouter/openapi/models/action_policy_read_data.rb +278 -0
- data/lib/plainrouter/openapi/models/action_policy_result.rb +374 -0
- data/lib/plainrouter/openapi/models/action_proposal_input.rb +406 -0
- data/lib/plainrouter/openapi/models/action_proposal_input_actions_inner.rb +115 -0
- data/lib/plainrouter/openapi/models/action_proposal_input_actions_inner_any_of.rb +303 -0
- data/lib/plainrouter/openapi/models/action_proposal_input_actions_inner_any_of1.rb +303 -0
- data/lib/plainrouter/openapi/models/action_proposal_input_actions_inner_any_of10.rb +303 -0
- data/lib/plainrouter/openapi/models/action_proposal_input_actions_inner_any_of10_params.rb +356 -0
- data/lib/plainrouter/openapi/models/action_proposal_input_actions_inner_any_of11.rb +303 -0
- data/lib/plainrouter/openapi/models/action_proposal_input_actions_inner_any_of11_params.rb +173 -0
- data/lib/plainrouter/openapi/models/action_proposal_input_actions_inner_any_of12.rb +303 -0
- data/lib/plainrouter/openapi/models/action_proposal_input_actions_inner_any_of12_params.rb +188 -0
- data/lib/plainrouter/openapi/models/action_proposal_input_actions_inner_any_of13.rb +303 -0
- data/lib/plainrouter/openapi/models/action_proposal_input_actions_inner_any_of13_params.rb +259 -0
- data/lib/plainrouter/openapi/models/action_proposal_input_actions_inner_any_of2.rb +303 -0
- data/lib/plainrouter/openapi/models/action_proposal_input_actions_inner_any_of3.rb +303 -0
- data/lib/plainrouter/openapi/models/action_proposal_input_actions_inner_any_of4.rb +303 -0
- data/lib/plainrouter/openapi/models/action_proposal_input_actions_inner_any_of4_target_entity.rb +253 -0
- data/lib/plainrouter/openapi/models/action_proposal_input_actions_inner_any_of5.rb +303 -0
- data/lib/plainrouter/openapi/models/action_proposal_input_actions_inner_any_of6.rb +303 -0
- data/lib/plainrouter/openapi/models/action_proposal_input_actions_inner_any_of7.rb +303 -0
- data/lib/plainrouter/openapi/models/action_proposal_input_actions_inner_any_of8.rb +303 -0
- data/lib/plainrouter/openapi/models/action_proposal_input_actions_inner_any_of9.rb +303 -0
- data/lib/plainrouter/openapi/models/action_proposal_input_actions_inner_any_of_params.rb +173 -0
- data/lib/plainrouter/openapi/models/action_proposal_input_actions_inner_any_of_target_entity.rb +264 -0
- data/lib/plainrouter/openapi/models/action_proposal_input_evidence_inner.rb +262 -0
- data/lib/plainrouter/openapi/models/action_proposal_read.rb +164 -0
- data/lib/plainrouter/openapi/models/action_proposal_read_proposal.rb +452 -0
- data/lib/plainrouter/openapi/models/action_proposal_read_proposal_actions_inner.rb +386 -0
- data/lib/plainrouter/openapi/models/action_proposal_read_proposal_actions_inner_params.rb +103 -0
- data/lib/plainrouter/openapi/models/action_proposal_read_proposal_proposed_by.rb +202 -0
- data/lib/plainrouter/openapi/models/action_read_item.rb +574 -0
- data/lib/plainrouter/openapi/models/action_read_item_evidence.rb +105 -0
- data/lib/plainrouter/openapi/models/action_read_item_evidence_any_of.rb +190 -0
- data/lib/plainrouter/openapi/models/action_read_item_evidence_any_of1.rb +242 -0
- data/lib/plainrouter/openapi/models/action_read_item_evidence_any_of2.rb +217 -0
- data/lib/plainrouter/openapi/models/action_read_item_evidence_any_of_outcome.rb +238 -0
- data/lib/plainrouter/openapi/models/action_read_item_proposer.rb +198 -0
- data/lib/plainrouter/openapi/models/actions_api_dry_run401_response.rb +103 -0
- data/lib/plainrouter/openapi/models/actions_tests_api_index404_response.rb +103 -0
- data/lib/plainrouter/openapi/models/actions_tests_api_store_request.rb +467 -0
- data/lib/plainrouter/openapi/models/actions_tests_api_store_request_maximum_spend_minor.rb +104 -0
- data/lib/plainrouter/openapi/models/ad_test.rb +552 -0
- data/lib/plainrouter/openapi/models/ad_test_create_read.rb +164 -0
- data/lib/plainrouter/openapi/models/ad_test_create_read_test.rb +675 -0
- data/lib/plainrouter/openapi/models/ad_test_create_read_test_members_inner.rb +232 -0
- data/lib/plainrouter/openapi/models/ad_test_create_read_test_pause_proposals_inner.rb +286 -0
- data/lib/plainrouter/openapi/models/ad_test_create_read_test_verdict.rb +336 -0
- data/lib/plainrouter/openapi/models/ad_test_create_read_test_verdict_daily_facts_inner.rb +374 -0
- data/lib/plainrouter/openapi/models/ad_test_create_read_test_verdict_halt_details.rb +285 -0
- data/lib/plainrouter/openapi/models/ad_test_create_read_test_verdict_halt_details_baseline.rb +190 -0
- data/lib/plainrouter/openapi/models/ad_test_create_read_test_verdict_halt_details_observed_destinations_inner.rb +216 -0
- data/lib/plainrouter/openapi/models/ad_test_create_read_test_verdict_members_inner.rb +349 -0
- data/lib/plainrouter/openapi/models/ad_test_daily_fact_read.rb +374 -0
- data/lib/plainrouter/openapi/models/ad_test_event_choice.rb +190 -0
- data/lib/plainrouter/openapi/models/ad_test_list_read.rb +218 -0
- data/lib/plainrouter/openapi/models/ad_test_list_read_observed_conversion_events_inner.rb +190 -0
- data/lib/plainrouter/openapi/models/ad_test_list_read_tests.rb +396 -0
- data/lib/plainrouter/openapi/models/ad_test_read.rb +675 -0
- data/lib/plainrouter/openapi/models/ad_test_show_read.rb +164 -0
- data/lib/plainrouter/openapi/models/ad_test_verdict_member_read.rb +349 -0
- data/lib/plainrouter/openapi/models/ad_test_verdict_read.rb +336 -0
- data/lib/plainrouter/openapi/models/agent_credential_error.rb +214 -0
- data/lib/plainrouter/openapi/models/api_route_not_found.rb +216 -0
- data/lib/plainrouter/openapi/models/api_route_not_found_error.rb +240 -0
- data/lib/plainrouter/openapi/models/api_route_not_found_request.rb +190 -0
- data/lib/plainrouter/openapi/models/api_route_not_found_resources.rb +190 -0
- data/lib/plainrouter/openapi/models/cookie_declaration.rb +177 -0
- data/lib/plainrouter/openapi/models/cookie_declaration_categories.rb +268 -0
- data/lib/plainrouter/openapi/models/cookie_declaration_categories_necessary.rb +194 -0
- data/lib/plainrouter/openapi/models/cookie_declaration_item.rb +280 -0
- data/lib/plainrouter/openapi/models/create_event200_response.rb +2 -2
- data/lib/plainrouter/openapi/models/create_event202_response.rb +218 -0
- data/lib/plainrouter/openapi/models/create_event202_response_warnings_inner.rb +240 -0
- data/lib/plainrouter/openapi/models/create_event_request.rb +2 -2
- data/lib/plainrouter/openapi/models/create_event_request_any_of.rb +3 -3
- data/lib/plainrouter/openapi/models/create_event_request_any_of1.rb +3 -3
- data/lib/plainrouter/openapi/models/create_event_request_any_of_event_time.rb +2 -2
- data/lib/plainrouter/openapi/models/create_event_request_any_of_value_data.rb +2 -2
- data/lib/plainrouter/openapi/models/creative_intake_read.rb +164 -0
- data/lib/plainrouter/openapi/models/creative_intake_read_creative.rb +451 -0
- data/lib/plainrouter/openapi/models/creative_intake_read_creative_tags.rb +104 -0
- data/lib/plainrouter/openapi/models/creative_intake_rejected.rb +164 -0
- data/lib/plainrouter/openapi/models/creative_intake_rejected_error.rb +190 -0
- data/lib/plainrouter/openapi/models/creative_intake_tags.rb +257 -0
- data/lib/plainrouter/openapi/models/delete_user_data200_response.rb +2 -2
- data/lib/plainrouter/openapi/models/delete_user_data_request.rb +35 -36
- data/lib/plainrouter/openapi/models/delivery_status.rb +2 -2
- data/lib/plainrouter/openapi/models/deployment_plan.rb +593 -0
- data/lib/plainrouter/openapi/models/deployment_plan_read.rb +268 -0
- data/lib/plainrouter/openapi/models/deployment_plan_read_copy.rb +266 -0
- data/lib/plainrouter/openapi/models/deployment_plan_read_creatives_inner.rb +320 -0
- data/lib/plainrouter/openapi/models/deployment_plan_read_creatives_inner_copy.rb +267 -0
- data/lib/plainrouter/openapi/models/destination.rb +30 -3
- data/lib/plainrouter/openapi/models/destination_credential_source.rb +3 -4
- data/lib/plainrouter/openapi/models/destination_status.rb +2 -2
- data/lib/plainrouter/openapi/models/destination_type.rb +4 -3
- data/lib/plainrouter/openapi/models/emq_snapshot.rb +30 -3
- data/lib/plainrouter/openapi/models/error_message.rb +2 -2
- data/lib/plainrouter/openapi/models/event.rb +89 -45
- data/lib/plainrouter/openapi/models/execute_deployment_plan_request.rb +200 -0
- data/lib/plainrouter/openapi/models/get_cookie_declaration404_response.rb +103 -0
- data/lib/plainrouter/openapi/models/get_emq_report200_response.rb +2 -2
- data/lib/plainrouter/openapi/models/get_emq_report200_response_snapshots_inner.rb +30 -3
- data/lib/plainrouter/openapi/models/get_event200_response.rb +2 -2
- data/lib/plainrouter/openapi/models/get_event200_response_deliveries_inner.rb +30 -3
- data/lib/plainrouter/openapi/models/get_event200_response_event.rb +31 -4
- data/lib/plainrouter/openapi/models/get_event200_response_event_consent.rb +2 -2
- data/lib/plainrouter/openapi/models/get_event200_response_event_deliveries_inner.rb +30 -3
- data/lib/plainrouter/openapi/models/get_event200_response_event_user_data_hashed.rb +104 -0
- data/lib/plainrouter/openapi/models/get_event200_response_lineage.rb +2 -2
- data/lib/plainrouter/openapi/models/get_event200_response_lineage_children_inner.rb +31 -4
- data/lib/plainrouter/openapi/models/get_event200_response_lineage_parent.rb +31 -4
- data/lib/plainrouter/openapi/models/get_inventory_metrics200_response.rb +324 -0
- data/lib/plainrouter/openapi/models/get_inventory_metrics200_response_account.rb +264 -0
- data/lib/plainrouter/openapi/models/get_inventory_metrics200_response_changes_inner.rb +304 -0
- data/lib/plainrouter/openapi/models/get_inventory_metrics200_response_effective_range.rb +190 -0
- data/lib/plainrouter/openapi/models/get_inventory_metrics200_response_metrics_inner.rb +492 -0
- data/lib/plainrouter/openapi/models/get_inventory_metrics200_response_object_metrics_inner.rb +304 -0
- data/lib/plainrouter/openapi/models/get_inventory_metrics200_response_object_metrics_inner_meta.rb +268 -0
- data/lib/plainrouter/openapi/models/get_inventory_metrics200_response_staleness.rb +200 -0
- data/lib/plainrouter/openapi/models/get_inventory_metrics200_response_sync.rb +186 -0
- data/lib/plainrouter/openapi/models/get_reconciliation_report200_response.rb +2 -2
- data/lib/plainrouter/openapi/models/get_reconciliation_report200_response_reports_inner.rb +30 -3
- data/lib/plainrouter/openapi/models/get_reconciliation_report200_response_reports_inner_buckets_value.rb +2 -2
- data/lib/plainrouter/openapi/models/get_reconciliation_report200_response_reports_inner_event_counts.rb +2 -2
- data/lib/plainrouter/openapi/models/get_reconciliation_report200_response_reports_inner_event_counts_accepted.rb +2 -2
- data/lib/plainrouter/openapi/models/get_sandbox200_response.rb +2 -2
- data/lib/plainrouter/openapi/models/get_sandbox200_response_self_serve_key.rb +32 -6
- data/lib/plainrouter/openapi/models/{create_sandbox_key201_response.rb → get_sandbox200_response_self_serve_key_issued_key.rb} +6 -6
- data/lib/plainrouter/openapi/models/{create_sandbox_key201_response_use.rb → get_sandbox200_response_self_serve_key_issued_key_use.rb} +5 -5
- data/lib/plainrouter/openapi/models/get_sandbox200_response_try.rb +2 -2
- data/lib/plainrouter/openapi/models/get_sandbox200_response_try_body.rb +2 -2
- data/lib/plainrouter/openapi/models/get_sandbox200_response_try_body_value_data.rb +2 -2
- data/lib/plainrouter/openapi/models/ingestion_warning_code.rb +40 -0
- data/lib/plainrouter/openapi/models/jurisdiction_policy_class.rb +2 -2
- data/lib/plainrouter/openapi/models/launch_intent_read.rb +164 -0
- data/lib/plainrouter/openapi/models/launch_intent_read_intent.rb +330 -0
- data/lib/plainrouter/openapi/models/launch_intent_read_intent_actions_inner.rb +238 -0
- data/lib/plainrouter/openapi/models/launch_intent_status.rb +46 -0
- data/lib/plainrouter/openapi/models/launch_plans_copy403_response.rb +103 -0
- data/lib/plainrouter/openapi/models/launch_plans_copy404_response.rb +103 -0
- data/lib/plainrouter/openapi/models/launch_plans_execute422_response.rb +103 -0
- data/lib/plainrouter/openapi/models/launch_plans_index200_response.rb +164 -0
- data/lib/plainrouter/openapi/models/launch_plans_index200_response_plans.rb +244 -0
- data/lib/plainrouter/openapi/models/launch_plans_show200_response.rb +164 -0
- data/lib/plainrouter/openapi/models/list_events200_response.rb +2 -2
- data/lib/plainrouter/openapi/models/list_events200_response_events.rb +2 -2
- data/lib/plainrouter/openapi/models/list_events200_response_events_links_inner.rb +2 -2
- data/lib/plainrouter/openapi/models/list_events200_response_metrics.rb +2 -2
- data/lib/plainrouter/openapi/models/list_events_by_cursor200_response.rb +2 -2
- data/lib/plainrouter/openapi/models/list_events_by_cursor200_response_events.rb +2 -2
- data/lib/plainrouter/openapi/models/plan_copy_forbidden.rb +164 -0
- data/lib/plainrouter/openapi/models/plan_copy_forbidden_error.rb +214 -0
- data/lib/plainrouter/openapi/models/plan_copy_not_found.rb +164 -0
- data/lib/plainrouter/openapi/models/plan_copy_not_found_error.rb +214 -0
- data/lib/plainrouter/openapi/models/plan_copy_read.rb +164 -0
- data/lib/plainrouter/openapi/models/plan_copy_read_plan.rb +347 -0
- data/lib/plainrouter/openapi/models/plan_copy_rejected.rb +164 -0
- data/lib/plainrouter/openapi/models/plan_copy_rejected_error.rb +214 -0
- data/lib/plainrouter/openapi/models/plan_execute_conflict.rb +164 -0
- data/lib/plainrouter/openapi/models/plan_execute_conflict_error.rb +214 -0
- data/lib/plainrouter/openapi/models/plan_execute_rejected.rb +164 -0
- data/lib/plainrouter/openapi/models/plan_execute_rejected_error.rb +214 -0
- data/lib/plainrouter/openapi/models/proposal_replay_conflict.rb +214 -0
- data/lib/plainrouter/openapi/models/proposal_replay_conflict_errors.rb +178 -0
- data/lib/plainrouter/openapi/models/reconciliation_report.rb +31 -3
- data/lib/plainrouter/openapi/models/replay_deliveries202_response.rb +2 -2
- data/lib/plainrouter/openapi/models/replay_deliveries_request.rb +2 -2
- data/lib/plainrouter/openapi/models/send_test_purchase200_response.rb +2 -2
- data/lib/plainrouter/openapi/models/send_test_purchase422_response.rb +2 -2
- data/lib/plainrouter/openapi/models/send_test_purchase_request.rb +2 -2
- data/lib/plainrouter/openapi/models/set_destination_test_mode200_response.rb +2 -2
- data/lib/plainrouter/openapi/models/set_destination_test_mode200_response_destination.rb +30 -3
- data/lib/plainrouter/openapi/models/set_destination_test_mode_request.rb +2 -2
- data/lib/plainrouter/openapi/models/store_creative403_response.rb +103 -0
- data/lib/plainrouter/openapi/models/store_creative413_response.rb +103 -0
- data/lib/plainrouter/openapi/models/store_creative422_response.rb +103 -0
- data/lib/plainrouter/openapi/models/store_creative_from_url_request.rb +208 -0
- data/lib/plainrouter/openapi/models/store_creative_from_url_request_tags.rb +257 -0
- data/lib/plainrouter/openapi/models/store_creative_request.rb +219 -0
- data/lib/plainrouter/openapi/models/store_creative_request_tags.rb +257 -0
- data/lib/plainrouter/openapi/models/traffic_class.rb +2 -2
- data/lib/plainrouter/openapi/models/validate_sandbox_event200_response.rb +2 -2
- data/lib/plainrouter/openapi/models/validate_sandbox_event_request.rb +2 -2
- data/lib/plainrouter/openapi/models/validate_sandbox_event_request_value_data.rb +2 -2
- data/lib/plainrouter/openapi/models/validation_error.rb +2 -2
- data/lib/plainrouter/openapi/models/workspace_lock_timeout.rb +164 -0
- data/lib/plainrouter/openapi/models/workspace_lock_timeout_error.rb +214 -0
- data/lib/plainrouter/openapi/version.rb +3 -3
- data/lib/plainrouter/openapi.rb +164 -4
- data/lib/plainrouter/version.rb +1 -1
- metadata +167 -7
|
@@ -0,0 +1,404 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Plainrouter Conversion API
|
|
3
|
+
|
|
4
|
+
#Plainrouter public Signals Conversion API.
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 0.5.0
|
|
7
|
+
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.25.0
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'cgi'
|
|
14
|
+
|
|
15
|
+
module PlainRouter::OpenAPI
|
|
16
|
+
class ActionReadApiApi
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client = ApiClient.default)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
# Get action batch
|
|
23
|
+
# Read persisted Actions data for an account available to this workspace key. An unbound key selects account_id; a bound key stays limited to its own account.
|
|
24
|
+
# @param workspace [Integer] The workspace ID
|
|
25
|
+
# @param action_batch [String]
|
|
26
|
+
# @param [Hash] opts the optional parameters
|
|
27
|
+
# @option opts [Integer] :account_id Optional positive account ID. A bound key may name only its own account; any other value returns 422. An unbound key may name only an active account with an active connection in its workspace, and must name one when the workspace has more than one.
|
|
28
|
+
# @return [ActionBatchRead]
|
|
29
|
+
def actions_api_batch(workspace, action_batch, opts = {})
|
|
30
|
+
data, _status_code, _headers = actions_api_batch_with_http_info(workspace, action_batch, opts)
|
|
31
|
+
data
|
|
32
|
+
end
|
|
33
|
+
|
|
34
|
+
# Get action batch
|
|
35
|
+
# Read persisted Actions data for an account available to this workspace key. An unbound key selects account_id; a bound key stays limited to its own account.
|
|
36
|
+
# @param workspace [Integer] The workspace ID
|
|
37
|
+
# @param action_batch [String]
|
|
38
|
+
# @param [Hash] opts the optional parameters
|
|
39
|
+
# @option opts [Integer] :account_id Optional positive account ID. A bound key may name only its own account; any other value returns 422. An unbound key may name only an active account with an active connection in its workspace, and must name one when the workspace has more than one.
|
|
40
|
+
# @return [Array<(ActionBatchRead, Integer, Hash)>] ActionBatchRead data, response status code and response headers
|
|
41
|
+
def actions_api_batch_with_http_info(workspace, action_batch, opts = {})
|
|
42
|
+
if @api_client.config.debugging
|
|
43
|
+
@api_client.config.logger.debug 'Calling API: ActionReadApiApi.actions_api_batch ...'
|
|
44
|
+
end
|
|
45
|
+
# verify the required parameter 'workspace' is set
|
|
46
|
+
if @api_client.config.client_side_validation && workspace.nil?
|
|
47
|
+
fail ArgumentError, "Missing the required parameter 'workspace' when calling ActionReadApiApi.actions_api_batch"
|
|
48
|
+
end
|
|
49
|
+
# verify the required parameter 'action_batch' is set
|
|
50
|
+
if @api_client.config.client_side_validation && action_batch.nil?
|
|
51
|
+
fail ArgumentError, "Missing the required parameter 'action_batch' when calling ActionReadApiApi.actions_api_batch"
|
|
52
|
+
end
|
|
53
|
+
if @api_client.config.client_side_validation && !opts[:'account_id'].nil? && opts[:'account_id'] < 1
|
|
54
|
+
fail ArgumentError, 'invalid value for "opts[:"account_id"]" when calling ActionReadApiApi.actions_api_batch, must be greater than or equal to 1.'
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
# resource path
|
|
58
|
+
local_var_path = '/agent/workspaces/{workspace}/action-batches/{actionBatch}'.sub('{workspace}', CGI.escape(workspace.to_s)).sub('{actionBatch}', CGI.escape(action_batch.to_s))
|
|
59
|
+
|
|
60
|
+
# query parameters
|
|
61
|
+
query_params = opts[:query_params] || {}
|
|
62
|
+
query_params[:'account_id'] = opts[:'account_id'] if !opts[:'account_id'].nil?
|
|
63
|
+
|
|
64
|
+
# header parameters
|
|
65
|
+
header_params = opts[:header_params] || {}
|
|
66
|
+
# HTTP header 'Accept' (if needed)
|
|
67
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
68
|
+
|
|
69
|
+
# form parameters
|
|
70
|
+
form_params = opts[:form_params] || {}
|
|
71
|
+
|
|
72
|
+
# http body (model)
|
|
73
|
+
post_body = opts[:debug_body]
|
|
74
|
+
|
|
75
|
+
# return_type
|
|
76
|
+
return_type = opts[:debug_return_type] || 'ActionBatchRead'
|
|
77
|
+
|
|
78
|
+
# auth_names
|
|
79
|
+
auth_names = opts[:debug_auth_names] || ['workspaceActionKey']
|
|
80
|
+
|
|
81
|
+
new_options = opts.merge(
|
|
82
|
+
:operation => :"ActionReadApiApi.actions_api_batch",
|
|
83
|
+
:header_params => header_params,
|
|
84
|
+
:query_params => query_params,
|
|
85
|
+
:form_params => form_params,
|
|
86
|
+
:body => post_body,
|
|
87
|
+
:auth_names => auth_names,
|
|
88
|
+
:return_type => return_type
|
|
89
|
+
)
|
|
90
|
+
|
|
91
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
92
|
+
if @api_client.config.debugging
|
|
93
|
+
@api_client.config.logger.debug "API called: ActionReadApiApi#actions_api_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
94
|
+
end
|
|
95
|
+
return data, status_code, headers
|
|
96
|
+
end
|
|
97
|
+
|
|
98
|
+
# Get decision receipt
|
|
99
|
+
# Read persisted Actions data for an account available to this workspace key. An unbound key selects account_id; a bound key stays limited to its own account.
|
|
100
|
+
# @param workspace [Integer] The workspace ID
|
|
101
|
+
# @param action [String]
|
|
102
|
+
# @param [Hash] opts the optional parameters
|
|
103
|
+
# @option opts [Integer] :account_id Optional positive account ID. A bound key may name only its own account; any other value returns 422. An unbound key may name only an active account with an active connection in its workspace, and must name one when the workspace has more than one.
|
|
104
|
+
# @return [ActionDecisionReceiptRead]
|
|
105
|
+
def actions_api_decision_receipt(workspace, action, opts = {})
|
|
106
|
+
data, _status_code, _headers = actions_api_decision_receipt_with_http_info(workspace, action, opts)
|
|
107
|
+
data
|
|
108
|
+
end
|
|
109
|
+
|
|
110
|
+
# Get decision receipt
|
|
111
|
+
# Read persisted Actions data for an account available to this workspace key. An unbound key selects account_id; a bound key stays limited to its own account.
|
|
112
|
+
# @param workspace [Integer] The workspace ID
|
|
113
|
+
# @param action [String]
|
|
114
|
+
# @param [Hash] opts the optional parameters
|
|
115
|
+
# @option opts [Integer] :account_id Optional positive account ID. A bound key may name only its own account; any other value returns 422. An unbound key may name only an active account with an active connection in its workspace, and must name one when the workspace has more than one.
|
|
116
|
+
# @return [Array<(ActionDecisionReceiptRead, Integer, Hash)>] ActionDecisionReceiptRead data, response status code and response headers
|
|
117
|
+
def actions_api_decision_receipt_with_http_info(workspace, action, opts = {})
|
|
118
|
+
if @api_client.config.debugging
|
|
119
|
+
@api_client.config.logger.debug 'Calling API: ActionReadApiApi.actions_api_decision_receipt ...'
|
|
120
|
+
end
|
|
121
|
+
# verify the required parameter 'workspace' is set
|
|
122
|
+
if @api_client.config.client_side_validation && workspace.nil?
|
|
123
|
+
fail ArgumentError, "Missing the required parameter 'workspace' when calling ActionReadApiApi.actions_api_decision_receipt"
|
|
124
|
+
end
|
|
125
|
+
# verify the required parameter 'action' is set
|
|
126
|
+
if @api_client.config.client_side_validation && action.nil?
|
|
127
|
+
fail ArgumentError, "Missing the required parameter 'action' when calling ActionReadApiApi.actions_api_decision_receipt"
|
|
128
|
+
end
|
|
129
|
+
if @api_client.config.client_side_validation && !opts[:'account_id'].nil? && opts[:'account_id'] < 1
|
|
130
|
+
fail ArgumentError, 'invalid value for "opts[:"account_id"]" when calling ActionReadApiApi.actions_api_decision_receipt, must be greater than or equal to 1.'
|
|
131
|
+
end
|
|
132
|
+
|
|
133
|
+
# resource path
|
|
134
|
+
local_var_path = '/agent/workspaces/{workspace}/actions/{action}/decision-receipt'.sub('{workspace}', CGI.escape(workspace.to_s)).sub('{action}', CGI.escape(action.to_s))
|
|
135
|
+
|
|
136
|
+
# query parameters
|
|
137
|
+
query_params = opts[:query_params] || {}
|
|
138
|
+
query_params[:'account_id'] = opts[:'account_id'] if !opts[:'account_id'].nil?
|
|
139
|
+
|
|
140
|
+
# header parameters
|
|
141
|
+
header_params = opts[:header_params] || {}
|
|
142
|
+
# HTTP header 'Accept' (if needed)
|
|
143
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
144
|
+
|
|
145
|
+
# form parameters
|
|
146
|
+
form_params = opts[:form_params] || {}
|
|
147
|
+
|
|
148
|
+
# http body (model)
|
|
149
|
+
post_body = opts[:debug_body]
|
|
150
|
+
|
|
151
|
+
# return_type
|
|
152
|
+
return_type = opts[:debug_return_type] || 'ActionDecisionReceiptRead'
|
|
153
|
+
|
|
154
|
+
# auth_names
|
|
155
|
+
auth_names = opts[:debug_auth_names] || ['workspaceActionKey']
|
|
156
|
+
|
|
157
|
+
new_options = opts.merge(
|
|
158
|
+
:operation => :"ActionReadApiApi.actions_api_decision_receipt",
|
|
159
|
+
:header_params => header_params,
|
|
160
|
+
:query_params => query_params,
|
|
161
|
+
:form_params => form_params,
|
|
162
|
+
:body => post_body,
|
|
163
|
+
:auth_names => auth_names,
|
|
164
|
+
:return_type => return_type
|
|
165
|
+
)
|
|
166
|
+
|
|
167
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
168
|
+
if @api_client.config.debugging
|
|
169
|
+
@api_client.config.logger.debug "API called: ActionReadApiApi#actions_api_decision_receipt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
170
|
+
end
|
|
171
|
+
return data, status_code, headers
|
|
172
|
+
end
|
|
173
|
+
|
|
174
|
+
# List actions
|
|
175
|
+
# Read persisted Actions data for an account available to this workspace key. An unbound key selects account_id; a bound key stays limited to its own account.
|
|
176
|
+
# @param workspace [Integer] The workspace ID
|
|
177
|
+
# @param [Hash] opts the optional parameters
|
|
178
|
+
# @option opts [String] :status
|
|
179
|
+
# @option opts [Integer] :page
|
|
180
|
+
# @option opts [Integer] :account_id Optional positive account ID. A bound key may name only its own account; any other value returns 422. An unbound key may name only an active account with an active connection in its workspace, and must name one when the workspace has more than one.
|
|
181
|
+
# @return [ActionListRead]
|
|
182
|
+
def actions_api_index(workspace, opts = {})
|
|
183
|
+
data, _status_code, _headers = actions_api_index_with_http_info(workspace, opts)
|
|
184
|
+
data
|
|
185
|
+
end
|
|
186
|
+
|
|
187
|
+
# List actions
|
|
188
|
+
# Read persisted Actions data for an account available to this workspace key. An unbound key selects account_id; a bound key stays limited to its own account.
|
|
189
|
+
# @param workspace [Integer] The workspace ID
|
|
190
|
+
# @param [Hash] opts the optional parameters
|
|
191
|
+
# @option opts [String] :status
|
|
192
|
+
# @option opts [Integer] :page
|
|
193
|
+
# @option opts [Integer] :account_id Optional positive account ID. A bound key may name only its own account; any other value returns 422. An unbound key may name only an active account with an active connection in its workspace, and must name one when the workspace has more than one.
|
|
194
|
+
# @return [Array<(ActionListRead, Integer, Hash)>] ActionListRead data, response status code and response headers
|
|
195
|
+
def actions_api_index_with_http_info(workspace, opts = {})
|
|
196
|
+
if @api_client.config.debugging
|
|
197
|
+
@api_client.config.logger.debug 'Calling API: ActionReadApiApi.actions_api_index ...'
|
|
198
|
+
end
|
|
199
|
+
# verify the required parameter 'workspace' is set
|
|
200
|
+
if @api_client.config.client_side_validation && workspace.nil?
|
|
201
|
+
fail ArgumentError, "Missing the required parameter 'workspace' when calling ActionReadApiApi.actions_api_index"
|
|
202
|
+
end
|
|
203
|
+
allowable_values = ["pending", "approved_without_execution", "rejected", "executing", "executed_pending_verification", "compensating", "measuring", "verified", "failed", "execution_uncertain", "rolled_back", "blocked"]
|
|
204
|
+
if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
|
|
205
|
+
fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
|
|
206
|
+
end
|
|
207
|
+
if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
|
|
208
|
+
fail ArgumentError, 'invalid value for "opts[:"page"]" when calling ActionReadApiApi.actions_api_index, must be greater than or equal to 1.'
|
|
209
|
+
end
|
|
210
|
+
|
|
211
|
+
if @api_client.config.client_side_validation && !opts[:'account_id'].nil? && opts[:'account_id'] < 1
|
|
212
|
+
fail ArgumentError, 'invalid value for "opts[:"account_id"]" when calling ActionReadApiApi.actions_api_index, must be greater than or equal to 1.'
|
|
213
|
+
end
|
|
214
|
+
|
|
215
|
+
# resource path
|
|
216
|
+
local_var_path = '/agent/workspaces/{workspace}/actions'.sub('{workspace}', CGI.escape(workspace.to_s))
|
|
217
|
+
|
|
218
|
+
# query parameters
|
|
219
|
+
query_params = opts[:query_params] || {}
|
|
220
|
+
query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
|
|
221
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
|
222
|
+
query_params[:'account_id'] = opts[:'account_id'] if !opts[:'account_id'].nil?
|
|
223
|
+
|
|
224
|
+
# header parameters
|
|
225
|
+
header_params = opts[:header_params] || {}
|
|
226
|
+
# HTTP header 'Accept' (if needed)
|
|
227
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
228
|
+
|
|
229
|
+
# form parameters
|
|
230
|
+
form_params = opts[:form_params] || {}
|
|
231
|
+
|
|
232
|
+
# http body (model)
|
|
233
|
+
post_body = opts[:debug_body]
|
|
234
|
+
|
|
235
|
+
# return_type
|
|
236
|
+
return_type = opts[:debug_return_type] || 'ActionListRead'
|
|
237
|
+
|
|
238
|
+
# auth_names
|
|
239
|
+
auth_names = opts[:debug_auth_names] || ['workspaceActionKey']
|
|
240
|
+
|
|
241
|
+
new_options = opts.merge(
|
|
242
|
+
:operation => :"ActionReadApiApi.actions_api_index",
|
|
243
|
+
:header_params => header_params,
|
|
244
|
+
:query_params => query_params,
|
|
245
|
+
:form_params => form_params,
|
|
246
|
+
:body => post_body,
|
|
247
|
+
:auth_names => auth_names,
|
|
248
|
+
:return_type => return_type
|
|
249
|
+
)
|
|
250
|
+
|
|
251
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
252
|
+
if @api_client.config.debugging
|
|
253
|
+
@api_client.config.logger.debug "API called: ActionReadApiApi#actions_api_index\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
254
|
+
end
|
|
255
|
+
return data, status_code, headers
|
|
256
|
+
end
|
|
257
|
+
|
|
258
|
+
# Get action policy
|
|
259
|
+
# Read persisted Actions data for an account available to this workspace key. An unbound key selects account_id; a bound key stays limited to its own account.
|
|
260
|
+
# @param workspace [Integer] The workspace ID
|
|
261
|
+
# @param [Hash] opts the optional parameters
|
|
262
|
+
# @option opts [Integer] :account_id Optional positive account ID. A bound key may name only its own account; any other value returns 422. An unbound key may name only an active account with an active connection in its workspace, and must name one when the workspace has more than one.
|
|
263
|
+
# @return [ActionPolicyRead]
|
|
264
|
+
def actions_api_policy(workspace, opts = {})
|
|
265
|
+
data, _status_code, _headers = actions_api_policy_with_http_info(workspace, opts)
|
|
266
|
+
data
|
|
267
|
+
end
|
|
268
|
+
|
|
269
|
+
# Get action policy
|
|
270
|
+
# Read persisted Actions data for an account available to this workspace key. An unbound key selects account_id; a bound key stays limited to its own account.
|
|
271
|
+
# @param workspace [Integer] The workspace ID
|
|
272
|
+
# @param [Hash] opts the optional parameters
|
|
273
|
+
# @option opts [Integer] :account_id Optional positive account ID. A bound key may name only its own account; any other value returns 422. An unbound key may name only an active account with an active connection in its workspace, and must name one when the workspace has more than one.
|
|
274
|
+
# @return [Array<(ActionPolicyRead, Integer, Hash)>] ActionPolicyRead data, response status code and response headers
|
|
275
|
+
def actions_api_policy_with_http_info(workspace, opts = {})
|
|
276
|
+
if @api_client.config.debugging
|
|
277
|
+
@api_client.config.logger.debug 'Calling API: ActionReadApiApi.actions_api_policy ...'
|
|
278
|
+
end
|
|
279
|
+
# verify the required parameter 'workspace' is set
|
|
280
|
+
if @api_client.config.client_side_validation && workspace.nil?
|
|
281
|
+
fail ArgumentError, "Missing the required parameter 'workspace' when calling ActionReadApiApi.actions_api_policy"
|
|
282
|
+
end
|
|
283
|
+
if @api_client.config.client_side_validation && !opts[:'account_id'].nil? && opts[:'account_id'] < 1
|
|
284
|
+
fail ArgumentError, 'invalid value for "opts[:"account_id"]" when calling ActionReadApiApi.actions_api_policy, must be greater than or equal to 1.'
|
|
285
|
+
end
|
|
286
|
+
|
|
287
|
+
# resource path
|
|
288
|
+
local_var_path = '/agent/workspaces/{workspace}/actions/policy'.sub('{workspace}', CGI.escape(workspace.to_s))
|
|
289
|
+
|
|
290
|
+
# query parameters
|
|
291
|
+
query_params = opts[:query_params] || {}
|
|
292
|
+
query_params[:'account_id'] = opts[:'account_id'] if !opts[:'account_id'].nil?
|
|
293
|
+
|
|
294
|
+
# header parameters
|
|
295
|
+
header_params = opts[:header_params] || {}
|
|
296
|
+
# HTTP header 'Accept' (if needed)
|
|
297
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
298
|
+
|
|
299
|
+
# form parameters
|
|
300
|
+
form_params = opts[:form_params] || {}
|
|
301
|
+
|
|
302
|
+
# http body (model)
|
|
303
|
+
post_body = opts[:debug_body]
|
|
304
|
+
|
|
305
|
+
# return_type
|
|
306
|
+
return_type = opts[:debug_return_type] || 'ActionPolicyRead'
|
|
307
|
+
|
|
308
|
+
# auth_names
|
|
309
|
+
auth_names = opts[:debug_auth_names] || ['workspaceActionKey']
|
|
310
|
+
|
|
311
|
+
new_options = opts.merge(
|
|
312
|
+
:operation => :"ActionReadApiApi.actions_api_policy",
|
|
313
|
+
:header_params => header_params,
|
|
314
|
+
:query_params => query_params,
|
|
315
|
+
:form_params => form_params,
|
|
316
|
+
:body => post_body,
|
|
317
|
+
:auth_names => auth_names,
|
|
318
|
+
:return_type => return_type
|
|
319
|
+
)
|
|
320
|
+
|
|
321
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
322
|
+
if @api_client.config.debugging
|
|
323
|
+
@api_client.config.logger.debug "API called: ActionReadApiApi#actions_api_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
324
|
+
end
|
|
325
|
+
return data, status_code, headers
|
|
326
|
+
end
|
|
327
|
+
|
|
328
|
+
# Get action
|
|
329
|
+
# Read persisted Actions data for an account available to this workspace key. An unbound key selects account_id; a bound key stays limited to its own account.
|
|
330
|
+
# @param workspace [Integer] The workspace ID
|
|
331
|
+
# @param action [String]
|
|
332
|
+
# @param [Hash] opts the optional parameters
|
|
333
|
+
# @option opts [Integer] :account_id Optional positive account ID. A bound key may name only its own account; any other value returns 422. An unbound key may name only an active account with an active connection in its workspace, and must name one when the workspace has more than one.
|
|
334
|
+
# @return [ActionDetailRead]
|
|
335
|
+
def actions_api_show(workspace, action, opts = {})
|
|
336
|
+
data, _status_code, _headers = actions_api_show_with_http_info(workspace, action, opts)
|
|
337
|
+
data
|
|
338
|
+
end
|
|
339
|
+
|
|
340
|
+
# Get action
|
|
341
|
+
# Read persisted Actions data for an account available to this workspace key. An unbound key selects account_id; a bound key stays limited to its own account.
|
|
342
|
+
# @param workspace [Integer] The workspace ID
|
|
343
|
+
# @param action [String]
|
|
344
|
+
# @param [Hash] opts the optional parameters
|
|
345
|
+
# @option opts [Integer] :account_id Optional positive account ID. A bound key may name only its own account; any other value returns 422. An unbound key may name only an active account with an active connection in its workspace, and must name one when the workspace has more than one.
|
|
346
|
+
# @return [Array<(ActionDetailRead, Integer, Hash)>] ActionDetailRead data, response status code and response headers
|
|
347
|
+
def actions_api_show_with_http_info(workspace, action, opts = {})
|
|
348
|
+
if @api_client.config.debugging
|
|
349
|
+
@api_client.config.logger.debug 'Calling API: ActionReadApiApi.actions_api_show ...'
|
|
350
|
+
end
|
|
351
|
+
# verify the required parameter 'workspace' is set
|
|
352
|
+
if @api_client.config.client_side_validation && workspace.nil?
|
|
353
|
+
fail ArgumentError, "Missing the required parameter 'workspace' when calling ActionReadApiApi.actions_api_show"
|
|
354
|
+
end
|
|
355
|
+
# verify the required parameter 'action' is set
|
|
356
|
+
if @api_client.config.client_side_validation && action.nil?
|
|
357
|
+
fail ArgumentError, "Missing the required parameter 'action' when calling ActionReadApiApi.actions_api_show"
|
|
358
|
+
end
|
|
359
|
+
if @api_client.config.client_side_validation && !opts[:'account_id'].nil? && opts[:'account_id'] < 1
|
|
360
|
+
fail ArgumentError, 'invalid value for "opts[:"account_id"]" when calling ActionReadApiApi.actions_api_show, must be greater than or equal to 1.'
|
|
361
|
+
end
|
|
362
|
+
|
|
363
|
+
# resource path
|
|
364
|
+
local_var_path = '/agent/workspaces/{workspace}/actions/{action}'.sub('{workspace}', CGI.escape(workspace.to_s)).sub('{action}', CGI.escape(action.to_s))
|
|
365
|
+
|
|
366
|
+
# query parameters
|
|
367
|
+
query_params = opts[:query_params] || {}
|
|
368
|
+
query_params[:'account_id'] = opts[:'account_id'] if !opts[:'account_id'].nil?
|
|
369
|
+
|
|
370
|
+
# header parameters
|
|
371
|
+
header_params = opts[:header_params] || {}
|
|
372
|
+
# HTTP header 'Accept' (if needed)
|
|
373
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
374
|
+
|
|
375
|
+
# form parameters
|
|
376
|
+
form_params = opts[:form_params] || {}
|
|
377
|
+
|
|
378
|
+
# http body (model)
|
|
379
|
+
post_body = opts[:debug_body]
|
|
380
|
+
|
|
381
|
+
# return_type
|
|
382
|
+
return_type = opts[:debug_return_type] || 'ActionDetailRead'
|
|
383
|
+
|
|
384
|
+
# auth_names
|
|
385
|
+
auth_names = opts[:debug_auth_names] || ['workspaceActionKey']
|
|
386
|
+
|
|
387
|
+
new_options = opts.merge(
|
|
388
|
+
:operation => :"ActionReadApiApi.actions_api_show",
|
|
389
|
+
:header_params => header_params,
|
|
390
|
+
:query_params => query_params,
|
|
391
|
+
:form_params => form_params,
|
|
392
|
+
:body => post_body,
|
|
393
|
+
:auth_names => auth_names,
|
|
394
|
+
:return_type => return_type
|
|
395
|
+
)
|
|
396
|
+
|
|
397
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
398
|
+
if @api_client.config.debugging
|
|
399
|
+
@api_client.config.logger.debug "API called: ActionReadApiApi#actions_api_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
400
|
+
end
|
|
401
|
+
return data, status_code, headers
|
|
402
|
+
end
|
|
403
|
+
end
|
|
404
|
+
end
|
|
@@ -0,0 +1,259 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Plainrouter Conversion API
|
|
3
|
+
|
|
4
|
+
#Plainrouter public Signals Conversion API.
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 0.5.0
|
|
7
|
+
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.25.0
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'cgi'
|
|
14
|
+
|
|
15
|
+
module PlainRouter::OpenAPI
|
|
16
|
+
class AdTestApiApi
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client = ApiClient.default)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
# List Tests and observed conversion event choices
|
|
23
|
+
# Lists scoped Tests, their loser pause candidate status and reasons, and observed conversion event choices with last-30-day recorded counts.
|
|
24
|
+
# @param workspace [Integer] The workspace ID
|
|
25
|
+
# @param [Hash] opts the optional parameters
|
|
26
|
+
# @option opts [Integer] :page
|
|
27
|
+
# @option opts [Integer] :per_page
|
|
28
|
+
# @return [AdTestListRead]
|
|
29
|
+
def actions_tests_api_index(workspace, opts = {})
|
|
30
|
+
data, _status_code, _headers = actions_tests_api_index_with_http_info(workspace, opts)
|
|
31
|
+
data
|
|
32
|
+
end
|
|
33
|
+
|
|
34
|
+
# List Tests and observed conversion event choices
|
|
35
|
+
# Lists scoped Tests, their loser pause candidate status and reasons, and observed conversion event choices with last-30-day recorded counts.
|
|
36
|
+
# @param workspace [Integer] The workspace ID
|
|
37
|
+
# @param [Hash] opts the optional parameters
|
|
38
|
+
# @option opts [Integer] :page
|
|
39
|
+
# @option opts [Integer] :per_page
|
|
40
|
+
# @return [Array<(AdTestListRead, Integer, Hash)>] AdTestListRead data, response status code and response headers
|
|
41
|
+
def actions_tests_api_index_with_http_info(workspace, opts = {})
|
|
42
|
+
if @api_client.config.debugging
|
|
43
|
+
@api_client.config.logger.debug 'Calling API: AdTestApiApi.actions_tests_api_index ...'
|
|
44
|
+
end
|
|
45
|
+
# verify the required parameter 'workspace' is set
|
|
46
|
+
if @api_client.config.client_side_validation && workspace.nil?
|
|
47
|
+
fail ArgumentError, "Missing the required parameter 'workspace' when calling AdTestApiApi.actions_tests_api_index"
|
|
48
|
+
end
|
|
49
|
+
if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
|
|
50
|
+
fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AdTestApiApi.actions_tests_api_index, must be greater than or equal to 1.'
|
|
51
|
+
end
|
|
52
|
+
|
|
53
|
+
if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
|
|
54
|
+
fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling AdTestApiApi.actions_tests_api_index, must be smaller than or equal to 100.'
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
|
|
58
|
+
fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling AdTestApiApi.actions_tests_api_index, must be greater than or equal to 1.'
|
|
59
|
+
end
|
|
60
|
+
|
|
61
|
+
# resource path
|
|
62
|
+
local_var_path = '/agent/workspaces/{workspace}/tests'.sub('{workspace}', CGI.escape(workspace.to_s))
|
|
63
|
+
|
|
64
|
+
# query parameters
|
|
65
|
+
query_params = opts[:query_params] || {}
|
|
66
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
|
67
|
+
query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
|
|
68
|
+
|
|
69
|
+
# header parameters
|
|
70
|
+
header_params = opts[:header_params] || {}
|
|
71
|
+
# HTTP header 'Accept' (if needed)
|
|
72
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
73
|
+
|
|
74
|
+
# form parameters
|
|
75
|
+
form_params = opts[:form_params] || {}
|
|
76
|
+
|
|
77
|
+
# http body (model)
|
|
78
|
+
post_body = opts[:debug_body]
|
|
79
|
+
|
|
80
|
+
# return_type
|
|
81
|
+
return_type = opts[:debug_return_type] || 'AdTestListRead'
|
|
82
|
+
|
|
83
|
+
# auth_names
|
|
84
|
+
auth_names = opts[:debug_auth_names] || ['testReader']
|
|
85
|
+
|
|
86
|
+
new_options = opts.merge(
|
|
87
|
+
:operation => :"AdTestApiApi.actions_tests_api_index",
|
|
88
|
+
:header_params => header_params,
|
|
89
|
+
:query_params => query_params,
|
|
90
|
+
:form_params => form_params,
|
|
91
|
+
:body => post_body,
|
|
92
|
+
:auth_names => auth_names,
|
|
93
|
+
:return_type => return_type
|
|
94
|
+
)
|
|
95
|
+
|
|
96
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
97
|
+
if @api_client.config.debugging
|
|
98
|
+
@api_client.config.logger.debug "API called: AdTestApiApi#actions_tests_api_index\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
99
|
+
end
|
|
100
|
+
return data, status_code, headers
|
|
101
|
+
end
|
|
102
|
+
|
|
103
|
+
# Read a Test, verdict, and pause candidates
|
|
104
|
+
# Reads a scoped Test, its stored daily facts and verdict, and loser pause candidate status and reason; recorded counts rank members only within this Test.
|
|
105
|
+
# @param workspace [Integer] The workspace ID
|
|
106
|
+
# @param ad_test [String]
|
|
107
|
+
# @param [Hash] opts the optional parameters
|
|
108
|
+
# @return [AdTestShowRead]
|
|
109
|
+
def actions_tests_api_show(workspace, ad_test, opts = {})
|
|
110
|
+
data, _status_code, _headers = actions_tests_api_show_with_http_info(workspace, ad_test, opts)
|
|
111
|
+
data
|
|
112
|
+
end
|
|
113
|
+
|
|
114
|
+
# Read a Test, verdict, and pause candidates
|
|
115
|
+
# Reads a scoped Test, its stored daily facts and verdict, and loser pause candidate status and reason; recorded counts rank members only within this Test.
|
|
116
|
+
# @param workspace [Integer] The workspace ID
|
|
117
|
+
# @param ad_test [String]
|
|
118
|
+
# @param [Hash] opts the optional parameters
|
|
119
|
+
# @return [Array<(AdTestShowRead, Integer, Hash)>] AdTestShowRead data, response status code and response headers
|
|
120
|
+
def actions_tests_api_show_with_http_info(workspace, ad_test, opts = {})
|
|
121
|
+
if @api_client.config.debugging
|
|
122
|
+
@api_client.config.logger.debug 'Calling API: AdTestApiApi.actions_tests_api_show ...'
|
|
123
|
+
end
|
|
124
|
+
# verify the required parameter 'workspace' is set
|
|
125
|
+
if @api_client.config.client_side_validation && workspace.nil?
|
|
126
|
+
fail ArgumentError, "Missing the required parameter 'workspace' when calling AdTestApiApi.actions_tests_api_show"
|
|
127
|
+
end
|
|
128
|
+
# verify the required parameter 'ad_test' is set
|
|
129
|
+
if @api_client.config.client_side_validation && ad_test.nil?
|
|
130
|
+
fail ArgumentError, "Missing the required parameter 'ad_test' when calling AdTestApiApi.actions_tests_api_show"
|
|
131
|
+
end
|
|
132
|
+
if @api_client.config.client_side_validation && ad_test.to_s.length > 26
|
|
133
|
+
fail ArgumentError, 'invalid value for "ad_test" when calling AdTestApiApi.actions_tests_api_show, the character length must be smaller than or equal to 26.'
|
|
134
|
+
end
|
|
135
|
+
|
|
136
|
+
if @api_client.config.client_side_validation && ad_test.to_s.length < 26
|
|
137
|
+
fail ArgumentError, 'invalid value for "ad_test" when calling AdTestApiApi.actions_tests_api_show, the character length must be greater than or equal to 26.'
|
|
138
|
+
end
|
|
139
|
+
|
|
140
|
+
pattern = Regexp.new(/^[0-7][0-9a-hjkmnp-tv-z]{25}$/)
|
|
141
|
+
if @api_client.config.client_side_validation && ad_test !~ pattern
|
|
142
|
+
fail ArgumentError, "invalid value for 'ad_test' when calling AdTestApiApi.actions_tests_api_show, must conform to the pattern #{pattern}."
|
|
143
|
+
end
|
|
144
|
+
|
|
145
|
+
# resource path
|
|
146
|
+
local_var_path = '/agent/workspaces/{workspace}/tests/{ad_test}'.sub('{workspace}', CGI.escape(workspace.to_s)).sub('{ad_test}', CGI.escape(ad_test.to_s))
|
|
147
|
+
|
|
148
|
+
# query parameters
|
|
149
|
+
query_params = opts[:query_params] || {}
|
|
150
|
+
|
|
151
|
+
# header parameters
|
|
152
|
+
header_params = opts[:header_params] || {}
|
|
153
|
+
# HTTP header 'Accept' (if needed)
|
|
154
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
155
|
+
|
|
156
|
+
# form parameters
|
|
157
|
+
form_params = opts[:form_params] || {}
|
|
158
|
+
|
|
159
|
+
# http body (model)
|
|
160
|
+
post_body = opts[:debug_body]
|
|
161
|
+
|
|
162
|
+
# return_type
|
|
163
|
+
return_type = opts[:debug_return_type] || 'AdTestShowRead'
|
|
164
|
+
|
|
165
|
+
# auth_names
|
|
166
|
+
auth_names = opts[:debug_auth_names] || ['testReader']
|
|
167
|
+
|
|
168
|
+
new_options = opts.merge(
|
|
169
|
+
:operation => :"AdTestApiApi.actions_tests_api_show",
|
|
170
|
+
:header_params => header_params,
|
|
171
|
+
:query_params => query_params,
|
|
172
|
+
:form_params => form_params,
|
|
173
|
+
:body => post_body,
|
|
174
|
+
:auth_names => auth_names,
|
|
175
|
+
:return_type => return_type
|
|
176
|
+
)
|
|
177
|
+
|
|
178
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
179
|
+
if @api_client.config.debugging
|
|
180
|
+
@api_client.config.logger.debug "API called: AdTestApiApi#actions_tests_api_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
181
|
+
end
|
|
182
|
+
return data, status_code, headers
|
|
183
|
+
end
|
|
184
|
+
|
|
185
|
+
# Create a judging Test
|
|
186
|
+
# Creates a judging Test with frozen event, settings, axis, and 2 to 4 ads from one mirrored ad set; it creates no proposal or Meta write.
|
|
187
|
+
# @param workspace [Integer] The workspace ID
|
|
188
|
+
# @param actions_tests_api_store_request [ActionsTestsApiStoreRequest] A Test using ads present in the selected mirrored Meta ad set.
|
|
189
|
+
# @param [Hash] opts the optional parameters
|
|
190
|
+
# @return [AdTestCreateRead]
|
|
191
|
+
def actions_tests_api_store(workspace, actions_tests_api_store_request, opts = {})
|
|
192
|
+
data, _status_code, _headers = actions_tests_api_store_with_http_info(workspace, actions_tests_api_store_request, opts)
|
|
193
|
+
data
|
|
194
|
+
end
|
|
195
|
+
|
|
196
|
+
# Create a judging Test
|
|
197
|
+
# Creates a judging Test with frozen event, settings, axis, and 2 to 4 ads from one mirrored ad set; it creates no proposal or Meta write.
|
|
198
|
+
# @param workspace [Integer] The workspace ID
|
|
199
|
+
# @param actions_tests_api_store_request [ActionsTestsApiStoreRequest] A Test using ads present in the selected mirrored Meta ad set.
|
|
200
|
+
# @param [Hash] opts the optional parameters
|
|
201
|
+
# @return [Array<(AdTestCreateRead, Integer, Hash)>] AdTestCreateRead data, response status code and response headers
|
|
202
|
+
def actions_tests_api_store_with_http_info(workspace, actions_tests_api_store_request, opts = {})
|
|
203
|
+
if @api_client.config.debugging
|
|
204
|
+
@api_client.config.logger.debug 'Calling API: AdTestApiApi.actions_tests_api_store ...'
|
|
205
|
+
end
|
|
206
|
+
# verify the required parameter 'workspace' is set
|
|
207
|
+
if @api_client.config.client_side_validation && workspace.nil?
|
|
208
|
+
fail ArgumentError, "Missing the required parameter 'workspace' when calling AdTestApiApi.actions_tests_api_store"
|
|
209
|
+
end
|
|
210
|
+
# verify the required parameter 'actions_tests_api_store_request' is set
|
|
211
|
+
if @api_client.config.client_side_validation && actions_tests_api_store_request.nil?
|
|
212
|
+
fail ArgumentError, "Missing the required parameter 'actions_tests_api_store_request' when calling AdTestApiApi.actions_tests_api_store"
|
|
213
|
+
end
|
|
214
|
+
# resource path
|
|
215
|
+
local_var_path = '/agent/workspaces/{workspace}/tests'.sub('{workspace}', CGI.escape(workspace.to_s))
|
|
216
|
+
|
|
217
|
+
# query parameters
|
|
218
|
+
query_params = opts[:query_params] || {}
|
|
219
|
+
|
|
220
|
+
# header parameters
|
|
221
|
+
header_params = opts[:header_params] || {}
|
|
222
|
+
# HTTP header 'Accept' (if needed)
|
|
223
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
224
|
+
# HTTP header 'Content-Type'
|
|
225
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
226
|
+
if !content_type.nil?
|
|
227
|
+
header_params['Content-Type'] = content_type
|
|
228
|
+
end
|
|
229
|
+
|
|
230
|
+
# form parameters
|
|
231
|
+
form_params = opts[:form_params] || {}
|
|
232
|
+
|
|
233
|
+
# http body (model)
|
|
234
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(actions_tests_api_store_request)
|
|
235
|
+
|
|
236
|
+
# return_type
|
|
237
|
+
return_type = opts[:debug_return_type] || 'AdTestCreateRead'
|
|
238
|
+
|
|
239
|
+
# auth_names
|
|
240
|
+
auth_names = opts[:debug_auth_names] || ['testWriter']
|
|
241
|
+
|
|
242
|
+
new_options = opts.merge(
|
|
243
|
+
:operation => :"AdTestApiApi.actions_tests_api_store",
|
|
244
|
+
:header_params => header_params,
|
|
245
|
+
:query_params => query_params,
|
|
246
|
+
:form_params => form_params,
|
|
247
|
+
:body => post_body,
|
|
248
|
+
:auth_names => auth_names,
|
|
249
|
+
:return_type => return_type
|
|
250
|
+
)
|
|
251
|
+
|
|
252
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
253
|
+
if @api_client.config.debugging
|
|
254
|
+
@api_client.config.logger.debug "API called: AdTestApiApi#actions_tests_api_store\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
255
|
+
end
|
|
256
|
+
return data, status_code, headers
|
|
257
|
+
end
|
|
258
|
+
end
|
|
259
|
+
end
|