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,90 @@
|
|
|
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 CookieDeclarationApi
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client = ApiClient.default)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
# Read the public cookie declaration
|
|
23
|
+
# Public on every plan. Returns latest completed scan metadata, never values. Invalid keys return 404 before the 300/minute per-key limiter.
|
|
24
|
+
# @param publishable_key [String] Workspace publishable key from the customer page source; pk_live_ followed by 32 alphanumeric characters.
|
|
25
|
+
# @param [Hash] opts the optional parameters
|
|
26
|
+
# @return [CookieDeclaration]
|
|
27
|
+
def get_cookie_declaration(publishable_key, opts = {})
|
|
28
|
+
data, _status_code, _headers = get_cookie_declaration_with_http_info(publishable_key, opts)
|
|
29
|
+
data
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# Read the public cookie declaration
|
|
33
|
+
# Public on every plan. Returns latest completed scan metadata, never values. Invalid keys return 404 before the 300/minute per-key limiter.
|
|
34
|
+
# @param publishable_key [String] Workspace publishable key from the customer page source; pk_live_ followed by 32 alphanumeric characters.
|
|
35
|
+
# @param [Hash] opts the optional parameters
|
|
36
|
+
# @return [Array<(CookieDeclaration, Integer, Hash)>] CookieDeclaration data, response status code and response headers
|
|
37
|
+
def get_cookie_declaration_with_http_info(publishable_key, opts = {})
|
|
38
|
+
if @api_client.config.debugging
|
|
39
|
+
@api_client.config.logger.debug 'Calling API: CookieDeclarationApi.get_cookie_declaration ...'
|
|
40
|
+
end
|
|
41
|
+
# verify the required parameter 'publishable_key' is set
|
|
42
|
+
if @api_client.config.client_side_validation && publishable_key.nil?
|
|
43
|
+
fail ArgumentError, "Missing the required parameter 'publishable_key' when calling CookieDeclarationApi.get_cookie_declaration"
|
|
44
|
+
end
|
|
45
|
+
pattern = Regexp.new(/^pk_live_[A-Za-z0-9]{32}$/)
|
|
46
|
+
if @api_client.config.client_side_validation && publishable_key !~ pattern
|
|
47
|
+
fail ArgumentError, "invalid value for 'publishable_key' when calling CookieDeclarationApi.get_cookie_declaration, must conform to the pattern #{pattern}."
|
|
48
|
+
end
|
|
49
|
+
|
|
50
|
+
# resource path
|
|
51
|
+
local_var_path = '/cookie-declarations/{publishableKey}'.sub('{publishableKey}', CGI.escape(publishable_key.to_s))
|
|
52
|
+
|
|
53
|
+
# query parameters
|
|
54
|
+
query_params = opts[:query_params] || {}
|
|
55
|
+
|
|
56
|
+
# header parameters
|
|
57
|
+
header_params = opts[:header_params] || {}
|
|
58
|
+
# HTTP header 'Accept' (if needed)
|
|
59
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
60
|
+
|
|
61
|
+
# form parameters
|
|
62
|
+
form_params = opts[:form_params] || {}
|
|
63
|
+
|
|
64
|
+
# http body (model)
|
|
65
|
+
post_body = opts[:debug_body]
|
|
66
|
+
|
|
67
|
+
# return_type
|
|
68
|
+
return_type = opts[:debug_return_type] || 'CookieDeclaration'
|
|
69
|
+
|
|
70
|
+
# auth_names
|
|
71
|
+
auth_names = opts[:debug_auth_names] || []
|
|
72
|
+
|
|
73
|
+
new_options = opts.merge(
|
|
74
|
+
:operation => :"CookieDeclarationApi.get_cookie_declaration",
|
|
75
|
+
:header_params => header_params,
|
|
76
|
+
:query_params => query_params,
|
|
77
|
+
:form_params => form_params,
|
|
78
|
+
:body => post_body,
|
|
79
|
+
:auth_names => auth_names,
|
|
80
|
+
:return_type => return_type
|
|
81
|
+
)
|
|
82
|
+
|
|
83
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
84
|
+
if @api_client.config.debugging
|
|
85
|
+
@api_client.config.logger.debug "API called: CookieDeclarationApi#get_cookie_declaration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
86
|
+
end
|
|
87
|
+
return data, status_code, headers
|
|
88
|
+
end
|
|
89
|
+
end
|
|
90
|
+
end
|
|
@@ -0,0 +1,181 @@
|
|
|
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 CreativeApi
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client = ApiClient.default)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
# Upload a creative
|
|
23
|
+
# Store a creative in the credential-bound workspace. Set generator, generator_job and parent_creative tags for output from an outside tool.
|
|
24
|
+
# @param workspace [Integer] The workspace ID
|
|
25
|
+
# @param file [File] JPEG, PNG, MP4 or QuickTime bytes, at most 4 GiB.
|
|
26
|
+
# @param [Hash] opts the optional parameters
|
|
27
|
+
# @option opts [StoreCreativeRequestTags] :tags
|
|
28
|
+
# @option opts [String] :source_ref
|
|
29
|
+
# @return [CreativeIntakeRead]
|
|
30
|
+
def store_creative(workspace, file, opts = {})
|
|
31
|
+
data, _status_code, _headers = store_creative_with_http_info(workspace, file, opts)
|
|
32
|
+
data
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
# Upload a creative
|
|
36
|
+
# Store a creative in the credential-bound workspace. Set generator, generator_job and parent_creative tags for output from an outside tool.
|
|
37
|
+
# @param workspace [Integer] The workspace ID
|
|
38
|
+
# @param file [File] JPEG, PNG, MP4 or QuickTime bytes, at most 4 GiB.
|
|
39
|
+
# @param [Hash] opts the optional parameters
|
|
40
|
+
# @option opts [StoreCreativeRequestTags] :tags
|
|
41
|
+
# @option opts [String] :source_ref
|
|
42
|
+
# @return [Array<(CreativeIntakeRead, Integer, Hash)>] CreativeIntakeRead data, response status code and response headers
|
|
43
|
+
def store_creative_with_http_info(workspace, file, opts = {})
|
|
44
|
+
if @api_client.config.debugging
|
|
45
|
+
@api_client.config.logger.debug 'Calling API: CreativeApi.store_creative ...'
|
|
46
|
+
end
|
|
47
|
+
# verify the required parameter 'workspace' is set
|
|
48
|
+
if @api_client.config.client_side_validation && workspace.nil?
|
|
49
|
+
fail ArgumentError, "Missing the required parameter 'workspace' when calling CreativeApi.store_creative"
|
|
50
|
+
end
|
|
51
|
+
# verify the required parameter 'file' is set
|
|
52
|
+
if @api_client.config.client_side_validation && file.nil?
|
|
53
|
+
fail ArgumentError, "Missing the required parameter 'file' when calling CreativeApi.store_creative"
|
|
54
|
+
end
|
|
55
|
+
if @api_client.config.client_side_validation && !opts[:'source_ref'].nil? && opts[:'source_ref'].to_s.length > 255
|
|
56
|
+
fail ArgumentError, 'invalid value for "opts[:"source_ref"]" when calling CreativeApi.store_creative, the character length must be smaller than or equal to 255.'
|
|
57
|
+
end
|
|
58
|
+
|
|
59
|
+
# resource path
|
|
60
|
+
local_var_path = '/workspaces/{workspace}/admin/creatives'.sub('{workspace}', CGI.escape(workspace.to_s))
|
|
61
|
+
|
|
62
|
+
# query parameters
|
|
63
|
+
query_params = opts[:query_params] || {}
|
|
64
|
+
|
|
65
|
+
# header parameters
|
|
66
|
+
header_params = opts[:header_params] || {}
|
|
67
|
+
# HTTP header 'Accept' (if needed)
|
|
68
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
69
|
+
# HTTP header 'Content-Type'
|
|
70
|
+
content_type = @api_client.select_header_content_type(['multipart/form-data'])
|
|
71
|
+
if !content_type.nil?
|
|
72
|
+
header_params['Content-Type'] = content_type
|
|
73
|
+
end
|
|
74
|
+
|
|
75
|
+
# form parameters
|
|
76
|
+
form_params = opts[:form_params] || {}
|
|
77
|
+
form_params['file'] = file
|
|
78
|
+
form_params['tags'] = opts[:'tags'] if !opts[:'tags'].nil?
|
|
79
|
+
form_params['source_ref'] = opts[:'source_ref'] if !opts[:'source_ref'].nil?
|
|
80
|
+
|
|
81
|
+
# http body (model)
|
|
82
|
+
post_body = opts[:debug_body]
|
|
83
|
+
|
|
84
|
+
# return_type
|
|
85
|
+
return_type = opts[:debug_return_type] || 'CreativeIntakeRead'
|
|
86
|
+
|
|
87
|
+
# auth_names
|
|
88
|
+
auth_names = opts[:debug_auth_names] || ['creativeWriter']
|
|
89
|
+
|
|
90
|
+
new_options = opts.merge(
|
|
91
|
+
:operation => :"CreativeApi.store_creative",
|
|
92
|
+
:header_params => header_params,
|
|
93
|
+
:query_params => query_params,
|
|
94
|
+
:form_params => form_params,
|
|
95
|
+
:body => post_body,
|
|
96
|
+
:auth_names => auth_names,
|
|
97
|
+
:return_type => return_type
|
|
98
|
+
)
|
|
99
|
+
|
|
100
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
101
|
+
if @api_client.config.debugging
|
|
102
|
+
@api_client.config.logger.debug "API called: CreativeApi#store_creative\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
103
|
+
end
|
|
104
|
+
return data, status_code, headers
|
|
105
|
+
end
|
|
106
|
+
|
|
107
|
+
# Store a creative from a URL
|
|
108
|
+
# Store a creative in the credential-bound workspace. Set generator, generator_job and parent_creative tags for output from an outside tool.
|
|
109
|
+
# @param workspace [Integer] The workspace ID
|
|
110
|
+
# @param store_creative_from_url_request [StoreCreativeFromUrlRequest]
|
|
111
|
+
# @param [Hash] opts the optional parameters
|
|
112
|
+
# @return [CreativeIntakeRead]
|
|
113
|
+
def store_creative_from_url(workspace, store_creative_from_url_request, opts = {})
|
|
114
|
+
data, _status_code, _headers = store_creative_from_url_with_http_info(workspace, store_creative_from_url_request, opts)
|
|
115
|
+
data
|
|
116
|
+
end
|
|
117
|
+
|
|
118
|
+
# Store a creative from a URL
|
|
119
|
+
# Store a creative in the credential-bound workspace. Set generator, generator_job and parent_creative tags for output from an outside tool.
|
|
120
|
+
# @param workspace [Integer] The workspace ID
|
|
121
|
+
# @param store_creative_from_url_request [StoreCreativeFromUrlRequest]
|
|
122
|
+
# @param [Hash] opts the optional parameters
|
|
123
|
+
# @return [Array<(CreativeIntakeRead, Integer, Hash)>] CreativeIntakeRead data, response status code and response headers
|
|
124
|
+
def store_creative_from_url_with_http_info(workspace, store_creative_from_url_request, opts = {})
|
|
125
|
+
if @api_client.config.debugging
|
|
126
|
+
@api_client.config.logger.debug 'Calling API: CreativeApi.store_creative_from_url ...'
|
|
127
|
+
end
|
|
128
|
+
# verify the required parameter 'workspace' is set
|
|
129
|
+
if @api_client.config.client_side_validation && workspace.nil?
|
|
130
|
+
fail ArgumentError, "Missing the required parameter 'workspace' when calling CreativeApi.store_creative_from_url"
|
|
131
|
+
end
|
|
132
|
+
# verify the required parameter 'store_creative_from_url_request' is set
|
|
133
|
+
if @api_client.config.client_side_validation && store_creative_from_url_request.nil?
|
|
134
|
+
fail ArgumentError, "Missing the required parameter 'store_creative_from_url_request' when calling CreativeApi.store_creative_from_url"
|
|
135
|
+
end
|
|
136
|
+
# resource path
|
|
137
|
+
local_var_path = '/workspaces/{workspace}/admin/creatives/from-url'.sub('{workspace}', CGI.escape(workspace.to_s))
|
|
138
|
+
|
|
139
|
+
# query parameters
|
|
140
|
+
query_params = opts[:query_params] || {}
|
|
141
|
+
|
|
142
|
+
# header parameters
|
|
143
|
+
header_params = opts[:header_params] || {}
|
|
144
|
+
# HTTP header 'Accept' (if needed)
|
|
145
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
146
|
+
# HTTP header 'Content-Type'
|
|
147
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
148
|
+
if !content_type.nil?
|
|
149
|
+
header_params['Content-Type'] = content_type
|
|
150
|
+
end
|
|
151
|
+
|
|
152
|
+
# form parameters
|
|
153
|
+
form_params = opts[:form_params] || {}
|
|
154
|
+
|
|
155
|
+
# http body (model)
|
|
156
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(store_creative_from_url_request)
|
|
157
|
+
|
|
158
|
+
# return_type
|
|
159
|
+
return_type = opts[:debug_return_type] || 'CreativeIntakeRead'
|
|
160
|
+
|
|
161
|
+
# auth_names
|
|
162
|
+
auth_names = opts[:debug_auth_names] || ['creativeWriter']
|
|
163
|
+
|
|
164
|
+
new_options = opts.merge(
|
|
165
|
+
:operation => :"CreativeApi.store_creative_from_url",
|
|
166
|
+
:header_params => header_params,
|
|
167
|
+
:query_params => query_params,
|
|
168
|
+
:form_params => form_params,
|
|
169
|
+
:body => post_body,
|
|
170
|
+
:auth_names => auth_names,
|
|
171
|
+
:return_type => return_type
|
|
172
|
+
)
|
|
173
|
+
|
|
174
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
175
|
+
if @api_client.config.debugging
|
|
176
|
+
@api_client.config.logger.debug "API called: CreativeApi#store_creative_from_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
177
|
+
end
|
|
178
|
+
return data, status_code, headers
|
|
179
|
+
end
|
|
180
|
+
end
|
|
181
|
+
end
|
|
@@ -0,0 +1,306 @@
|
|
|
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 DeploymentPlanApi
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client = ApiClient.default)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
# Copy a failed plan to a new draft
|
|
23
|
+
# Copy failed plan content and stored integer budgets into a fresh draft. History stays unchanged; validate budgets and submit again with a new intent.
|
|
24
|
+
# @param workspace [Integer] The workspace ID
|
|
25
|
+
# @param deployment_plan [String]
|
|
26
|
+
# @param [Hash] opts the optional parameters
|
|
27
|
+
# @return [PlanCopyRead]
|
|
28
|
+
def launch_plans_copy(workspace, deployment_plan, opts = {})
|
|
29
|
+
data, _status_code, _headers = launch_plans_copy_with_http_info(workspace, deployment_plan, opts)
|
|
30
|
+
data
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
# Copy a failed plan to a new draft
|
|
34
|
+
# Copy failed plan content and stored integer budgets into a fresh draft. History stays unchanged; validate budgets and submit again with a new intent.
|
|
35
|
+
# @param workspace [Integer] The workspace ID
|
|
36
|
+
# @param deployment_plan [String]
|
|
37
|
+
# @param [Hash] opts the optional parameters
|
|
38
|
+
# @return [Array<(PlanCopyRead, Integer, Hash)>] PlanCopyRead data, response status code and response headers
|
|
39
|
+
def launch_plans_copy_with_http_info(workspace, deployment_plan, opts = {})
|
|
40
|
+
if @api_client.config.debugging
|
|
41
|
+
@api_client.config.logger.debug 'Calling API: DeploymentPlanApi.launch_plans_copy ...'
|
|
42
|
+
end
|
|
43
|
+
# verify the required parameter 'workspace' is set
|
|
44
|
+
if @api_client.config.client_side_validation && workspace.nil?
|
|
45
|
+
fail ArgumentError, "Missing the required parameter 'workspace' when calling DeploymentPlanApi.launch_plans_copy"
|
|
46
|
+
end
|
|
47
|
+
# verify the required parameter 'deployment_plan' is set
|
|
48
|
+
if @api_client.config.client_side_validation && deployment_plan.nil?
|
|
49
|
+
fail ArgumentError, "Missing the required parameter 'deployment_plan' when calling DeploymentPlanApi.launch_plans_copy"
|
|
50
|
+
end
|
|
51
|
+
# resource path
|
|
52
|
+
local_var_path = '/workspaces/{workspace}/admin/plans/{deployment_plan}/copy'.sub('{workspace}', CGI.escape(workspace.to_s)).sub('{deployment_plan}', CGI.escape(deployment_plan.to_s))
|
|
53
|
+
|
|
54
|
+
# query parameters
|
|
55
|
+
query_params = opts[:query_params] || {}
|
|
56
|
+
|
|
57
|
+
# header parameters
|
|
58
|
+
header_params = opts[:header_params] || {}
|
|
59
|
+
# HTTP header 'Accept' (if needed)
|
|
60
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
61
|
+
|
|
62
|
+
# form parameters
|
|
63
|
+
form_params = opts[:form_params] || {}
|
|
64
|
+
|
|
65
|
+
# http body (model)
|
|
66
|
+
post_body = opts[:debug_body]
|
|
67
|
+
|
|
68
|
+
# return_type
|
|
69
|
+
return_type = opts[:debug_return_type] || 'PlanCopyRead'
|
|
70
|
+
|
|
71
|
+
# auth_names
|
|
72
|
+
auth_names = opts[:debug_auth_names] || ['planWriter']
|
|
73
|
+
|
|
74
|
+
new_options = opts.merge(
|
|
75
|
+
:operation => :"DeploymentPlanApi.launch_plans_copy",
|
|
76
|
+
:header_params => header_params,
|
|
77
|
+
:query_params => query_params,
|
|
78
|
+
:form_params => form_params,
|
|
79
|
+
:body => post_body,
|
|
80
|
+
:auth_names => auth_names,
|
|
81
|
+
:return_type => return_type
|
|
82
|
+
)
|
|
83
|
+
|
|
84
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
85
|
+
if @api_client.config.debugging
|
|
86
|
+
@api_client.config.logger.debug "API called: DeploymentPlanApi#launch_plans_copy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
87
|
+
end
|
|
88
|
+
return data, status_code, headers
|
|
89
|
+
end
|
|
90
|
+
|
|
91
|
+
# Execute a deployment plan
|
|
92
|
+
# Create or replay a governed Launch intent using the reviewed plan's review_version. Changed versions are refused before intent creation or staging.
|
|
93
|
+
# @param workspace [Integer] The workspace ID
|
|
94
|
+
# @param deployment_plan [String]
|
|
95
|
+
# @param execute_deployment_plan_request [ExecuteDeploymentPlanRequest]
|
|
96
|
+
# @param [Hash] opts the optional parameters
|
|
97
|
+
# @return [LaunchIntentRead]
|
|
98
|
+
def launch_plans_execute(workspace, deployment_plan, execute_deployment_plan_request, opts = {})
|
|
99
|
+
data, _status_code, _headers = launch_plans_execute_with_http_info(workspace, deployment_plan, execute_deployment_plan_request, opts)
|
|
100
|
+
data
|
|
101
|
+
end
|
|
102
|
+
|
|
103
|
+
# Execute a deployment plan
|
|
104
|
+
# Create or replay a governed Launch intent using the reviewed plan's review_version. Changed versions are refused before intent creation or staging.
|
|
105
|
+
# @param workspace [Integer] The workspace ID
|
|
106
|
+
# @param deployment_plan [String]
|
|
107
|
+
# @param execute_deployment_plan_request [ExecuteDeploymentPlanRequest]
|
|
108
|
+
# @param [Hash] opts the optional parameters
|
|
109
|
+
# @return [Array<(LaunchIntentRead, Integer, Hash)>] LaunchIntentRead data, response status code and response headers
|
|
110
|
+
def launch_plans_execute_with_http_info(workspace, deployment_plan, execute_deployment_plan_request, opts = {})
|
|
111
|
+
if @api_client.config.debugging
|
|
112
|
+
@api_client.config.logger.debug 'Calling API: DeploymentPlanApi.launch_plans_execute ...'
|
|
113
|
+
end
|
|
114
|
+
# verify the required parameter 'workspace' is set
|
|
115
|
+
if @api_client.config.client_side_validation && workspace.nil?
|
|
116
|
+
fail ArgumentError, "Missing the required parameter 'workspace' when calling DeploymentPlanApi.launch_plans_execute"
|
|
117
|
+
end
|
|
118
|
+
# verify the required parameter 'deployment_plan' is set
|
|
119
|
+
if @api_client.config.client_side_validation && deployment_plan.nil?
|
|
120
|
+
fail ArgumentError, "Missing the required parameter 'deployment_plan' when calling DeploymentPlanApi.launch_plans_execute"
|
|
121
|
+
end
|
|
122
|
+
# verify the required parameter 'execute_deployment_plan_request' is set
|
|
123
|
+
if @api_client.config.client_side_validation && execute_deployment_plan_request.nil?
|
|
124
|
+
fail ArgumentError, "Missing the required parameter 'execute_deployment_plan_request' when calling DeploymentPlanApi.launch_plans_execute"
|
|
125
|
+
end
|
|
126
|
+
# resource path
|
|
127
|
+
local_var_path = '/workspaces/{workspace}/admin/plans/{deployment_plan}/execute'.sub('{workspace}', CGI.escape(workspace.to_s)).sub('{deployment_plan}', CGI.escape(deployment_plan.to_s))
|
|
128
|
+
|
|
129
|
+
# query parameters
|
|
130
|
+
query_params = opts[:query_params] || {}
|
|
131
|
+
|
|
132
|
+
# header parameters
|
|
133
|
+
header_params = opts[:header_params] || {}
|
|
134
|
+
# HTTP header 'Accept' (if needed)
|
|
135
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
136
|
+
# HTTP header 'Content-Type'
|
|
137
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
138
|
+
if !content_type.nil?
|
|
139
|
+
header_params['Content-Type'] = content_type
|
|
140
|
+
end
|
|
141
|
+
|
|
142
|
+
# form parameters
|
|
143
|
+
form_params = opts[:form_params] || {}
|
|
144
|
+
|
|
145
|
+
# http body (model)
|
|
146
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(execute_deployment_plan_request)
|
|
147
|
+
|
|
148
|
+
# return_type
|
|
149
|
+
return_type = opts[:debug_return_type] || 'LaunchIntentRead'
|
|
150
|
+
|
|
151
|
+
# auth_names
|
|
152
|
+
auth_names = opts[:debug_auth_names] || ['planWriter']
|
|
153
|
+
|
|
154
|
+
new_options = opts.merge(
|
|
155
|
+
:operation => :"DeploymentPlanApi.launch_plans_execute",
|
|
156
|
+
:header_params => header_params,
|
|
157
|
+
:query_params => query_params,
|
|
158
|
+
:form_params => form_params,
|
|
159
|
+
:body => post_body,
|
|
160
|
+
:auth_names => auth_names,
|
|
161
|
+
:return_type => return_type
|
|
162
|
+
)
|
|
163
|
+
|
|
164
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
165
|
+
if @api_client.config.debugging
|
|
166
|
+
@api_client.config.logger.debug "API called: DeploymentPlanApi#launch_plans_execute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
167
|
+
end
|
|
168
|
+
return data, status_code, headers
|
|
169
|
+
end
|
|
170
|
+
|
|
171
|
+
# List deployment plans
|
|
172
|
+
# Read plans for the approved ad account with their current review_version. Pass the version from the plan you reviewed when executing.
|
|
173
|
+
# @param workspace [Integer] The workspace ID
|
|
174
|
+
# @param [Hash] opts the optional parameters
|
|
175
|
+
# @option opts [Integer] :per_page (default to 25)
|
|
176
|
+
# @return [LaunchPlansIndex200Response]
|
|
177
|
+
def launch_plans_index(workspace, opts = {})
|
|
178
|
+
data, _status_code, _headers = launch_plans_index_with_http_info(workspace, opts)
|
|
179
|
+
data
|
|
180
|
+
end
|
|
181
|
+
|
|
182
|
+
# List deployment plans
|
|
183
|
+
# Read plans for the approved ad account with their current review_version. Pass the version from the plan you reviewed when executing.
|
|
184
|
+
# @param workspace [Integer] The workspace ID
|
|
185
|
+
# @param [Hash] opts the optional parameters
|
|
186
|
+
# @option opts [Integer] :per_page (default to 25)
|
|
187
|
+
# @return [Array<(LaunchPlansIndex200Response, Integer, Hash)>] LaunchPlansIndex200Response data, response status code and response headers
|
|
188
|
+
def launch_plans_index_with_http_info(workspace, opts = {})
|
|
189
|
+
if @api_client.config.debugging
|
|
190
|
+
@api_client.config.logger.debug 'Calling API: DeploymentPlanApi.launch_plans_index ...'
|
|
191
|
+
end
|
|
192
|
+
# verify the required parameter 'workspace' is set
|
|
193
|
+
if @api_client.config.client_side_validation && workspace.nil?
|
|
194
|
+
fail ArgumentError, "Missing the required parameter 'workspace' when calling DeploymentPlanApi.launch_plans_index"
|
|
195
|
+
end
|
|
196
|
+
# resource path
|
|
197
|
+
local_var_path = '/workspaces/{workspace}/admin/plans'.sub('{workspace}', CGI.escape(workspace.to_s))
|
|
198
|
+
|
|
199
|
+
# query parameters
|
|
200
|
+
query_params = opts[:query_params] || {}
|
|
201
|
+
query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
|
|
202
|
+
|
|
203
|
+
# header parameters
|
|
204
|
+
header_params = opts[:header_params] || {}
|
|
205
|
+
# HTTP header 'Accept' (if needed)
|
|
206
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
207
|
+
|
|
208
|
+
# form parameters
|
|
209
|
+
form_params = opts[:form_params] || {}
|
|
210
|
+
|
|
211
|
+
# http body (model)
|
|
212
|
+
post_body = opts[:debug_body]
|
|
213
|
+
|
|
214
|
+
# return_type
|
|
215
|
+
return_type = opts[:debug_return_type] || 'LaunchPlansIndex200Response'
|
|
216
|
+
|
|
217
|
+
# auth_names
|
|
218
|
+
auth_names = opts[:debug_auth_names] || ['planReader']
|
|
219
|
+
|
|
220
|
+
new_options = opts.merge(
|
|
221
|
+
:operation => :"DeploymentPlanApi.launch_plans_index",
|
|
222
|
+
:header_params => header_params,
|
|
223
|
+
:query_params => query_params,
|
|
224
|
+
:form_params => form_params,
|
|
225
|
+
:body => post_body,
|
|
226
|
+
:auth_names => auth_names,
|
|
227
|
+
:return_type => return_type
|
|
228
|
+
)
|
|
229
|
+
|
|
230
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
231
|
+
if @api_client.config.debugging
|
|
232
|
+
@api_client.config.logger.debug "API called: DeploymentPlanApi#launch_plans_index\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
233
|
+
end
|
|
234
|
+
return data, status_code, headers
|
|
235
|
+
end
|
|
236
|
+
|
|
237
|
+
# Read a deployment plan
|
|
238
|
+
# Read plans for the approved ad account with their current review_version. Pass the version from the plan you reviewed when executing.
|
|
239
|
+
# @param workspace [Integer] The workspace ID
|
|
240
|
+
# @param deployment_plan [String]
|
|
241
|
+
# @param [Hash] opts the optional parameters
|
|
242
|
+
# @return [LaunchPlansShow200Response]
|
|
243
|
+
def launch_plans_show(workspace, deployment_plan, opts = {})
|
|
244
|
+
data, _status_code, _headers = launch_plans_show_with_http_info(workspace, deployment_plan, opts)
|
|
245
|
+
data
|
|
246
|
+
end
|
|
247
|
+
|
|
248
|
+
# Read a deployment plan
|
|
249
|
+
# Read plans for the approved ad account with their current review_version. Pass the version from the plan you reviewed when executing.
|
|
250
|
+
# @param workspace [Integer] The workspace ID
|
|
251
|
+
# @param deployment_plan [String]
|
|
252
|
+
# @param [Hash] opts the optional parameters
|
|
253
|
+
# @return [Array<(LaunchPlansShow200Response, Integer, Hash)>] LaunchPlansShow200Response data, response status code and response headers
|
|
254
|
+
def launch_plans_show_with_http_info(workspace, deployment_plan, opts = {})
|
|
255
|
+
if @api_client.config.debugging
|
|
256
|
+
@api_client.config.logger.debug 'Calling API: DeploymentPlanApi.launch_plans_show ...'
|
|
257
|
+
end
|
|
258
|
+
# verify the required parameter 'workspace' is set
|
|
259
|
+
if @api_client.config.client_side_validation && workspace.nil?
|
|
260
|
+
fail ArgumentError, "Missing the required parameter 'workspace' when calling DeploymentPlanApi.launch_plans_show"
|
|
261
|
+
end
|
|
262
|
+
# verify the required parameter 'deployment_plan' is set
|
|
263
|
+
if @api_client.config.client_side_validation && deployment_plan.nil?
|
|
264
|
+
fail ArgumentError, "Missing the required parameter 'deployment_plan' when calling DeploymentPlanApi.launch_plans_show"
|
|
265
|
+
end
|
|
266
|
+
# resource path
|
|
267
|
+
local_var_path = '/workspaces/{workspace}/admin/plans/{deployment_plan}'.sub('{workspace}', CGI.escape(workspace.to_s)).sub('{deployment_plan}', CGI.escape(deployment_plan.to_s))
|
|
268
|
+
|
|
269
|
+
# query parameters
|
|
270
|
+
query_params = opts[:query_params] || {}
|
|
271
|
+
|
|
272
|
+
# header parameters
|
|
273
|
+
header_params = opts[:header_params] || {}
|
|
274
|
+
# HTTP header 'Accept' (if needed)
|
|
275
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
276
|
+
|
|
277
|
+
# form parameters
|
|
278
|
+
form_params = opts[:form_params] || {}
|
|
279
|
+
|
|
280
|
+
# http body (model)
|
|
281
|
+
post_body = opts[:debug_body]
|
|
282
|
+
|
|
283
|
+
# return_type
|
|
284
|
+
return_type = opts[:debug_return_type] || 'LaunchPlansShow200Response'
|
|
285
|
+
|
|
286
|
+
# auth_names
|
|
287
|
+
auth_names = opts[:debug_auth_names] || ['planReader']
|
|
288
|
+
|
|
289
|
+
new_options = opts.merge(
|
|
290
|
+
:operation => :"DeploymentPlanApi.launch_plans_show",
|
|
291
|
+
:header_params => header_params,
|
|
292
|
+
:query_params => query_params,
|
|
293
|
+
:form_params => form_params,
|
|
294
|
+
:body => post_body,
|
|
295
|
+
:auth_names => auth_names,
|
|
296
|
+
:return_type => return_type
|
|
297
|
+
)
|
|
298
|
+
|
|
299
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
300
|
+
if @api_client.config.debugging
|
|
301
|
+
@api_client.config.logger.debug "API called: DeploymentPlanApi#launch_plans_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
302
|
+
end
|
|
303
|
+
return data, status_code, headers
|
|
304
|
+
end
|
|
305
|
+
end
|
|
306
|
+
end
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
|
-
#
|
|
2
|
+
#Plainrouter Conversion API
|
|
3
3
|
|
|
4
|
-
#
|
|
4
|
+
#Plainrouter public Signals Conversion API.
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 0.5.0
|
|
7
7
|
|
|
@@ -20,10 +20,10 @@ module PlainRouter::OpenAPI
|
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
22
|
# Submit a conversion event
|
|
23
|
-
# Accepts a consent-aware server-side conversion event
|
|
24
|
-
# @param create_event_request [CreateEventRequest]
|
|
23
|
+
# Accepts a consent-aware server-side conversion event and uses event_id or Idempotency-Key to make retries idempotent.
|
|
24
|
+
# @param create_event_request [CreateEventRequest] Authenticated callers using the Server secret may supply client_ip_address and client_user_agent in user_data; browser traffic using the Publishable key takes those fields only from the configured edge.
|
|
25
25
|
# @param [Hash] opts the optional parameters
|
|
26
|
-
# @option opts [String] :idempotency_key Optional idempotency key. When event_id is omitted,
|
|
26
|
+
# @option opts [String] :idempotency_key Optional idempotency key. When event_id is omitted, Plainrouter uses this value as event_id. If both are supplied, they must match.
|
|
27
27
|
# @return [CreateEvent200Response]
|
|
28
28
|
def create_event(create_event_request, opts = {})
|
|
29
29
|
data, _status_code, _headers = create_event_with_http_info(create_event_request, opts)
|
|
@@ -31,10 +31,10 @@ module PlainRouter::OpenAPI
|
|
|
31
31
|
end
|
|
32
32
|
|
|
33
33
|
# Submit a conversion event
|
|
34
|
-
# Accepts a consent-aware server-side conversion event
|
|
35
|
-
# @param create_event_request [CreateEventRequest]
|
|
34
|
+
# Accepts a consent-aware server-side conversion event and uses event_id or Idempotency-Key to make retries idempotent.
|
|
35
|
+
# @param create_event_request [CreateEventRequest] Authenticated callers using the Server secret may supply client_ip_address and client_user_agent in user_data; browser traffic using the Publishable key takes those fields only from the configured edge.
|
|
36
36
|
# @param [Hash] opts the optional parameters
|
|
37
|
-
# @option opts [String] :idempotency_key Optional idempotency key. When event_id is omitted,
|
|
37
|
+
# @option opts [String] :idempotency_key Optional idempotency key. When event_id is omitted, Plainrouter uses this value as event_id. If both are supplied, they must match.
|
|
38
38
|
# @return [Array<(CreateEvent200Response, Integer, Hash)>] CreateEvent200Response data, response status code and response headers
|
|
39
39
|
def create_event_with_http_info(create_event_request, opts = {})
|
|
40
40
|
if @api_client.config.debugging
|
|
@@ -71,7 +71,7 @@ module PlainRouter::OpenAPI
|
|
|
71
71
|
return_type = opts[:debug_return_type] || 'CreateEvent200Response'
|
|
72
72
|
|
|
73
73
|
# auth_names
|
|
74
|
-
auth_names = opts[:debug_auth_names] || ['
|
|
74
|
+
auth_names = opts[:debug_auth_names] || ['workspaceSecret']
|
|
75
75
|
|
|
76
76
|
new_options = opts.merge(
|
|
77
77
|
:operation => :"EventApi.create_event",
|
|
@@ -91,7 +91,7 @@ module PlainRouter::OpenAPI
|
|
|
91
91
|
end
|
|
92
92
|
|
|
93
93
|
# Get an event and delivery trace
|
|
94
|
-
# Returns one retained customer-readable event with lineage and destination delivery state.
|
|
94
|
+
# Returns one retained customer-readable event with lineage and destination delivery state for scoped troubleshooting and acceptance checks.
|
|
95
95
|
# @param event [String]
|
|
96
96
|
# @param [Hash] opts the optional parameters
|
|
97
97
|
# @return [GetEvent200Response]
|
|
@@ -101,7 +101,7 @@ module PlainRouter::OpenAPI
|
|
|
101
101
|
end
|
|
102
102
|
|
|
103
103
|
# Get an event and delivery trace
|
|
104
|
-
# Returns one retained customer-readable event with lineage and destination delivery state.
|
|
104
|
+
# Returns one retained customer-readable event with lineage and destination delivery state for scoped troubleshooting and acceptance checks.
|
|
105
105
|
# @param event [String]
|
|
106
106
|
# @param [Hash] opts the optional parameters
|
|
107
107
|
# @return [Array<(GetEvent200Response, Integer, Hash)>] GetEvent200Response data, response status code and response headers
|
|
@@ -134,7 +134,7 @@ module PlainRouter::OpenAPI
|
|
|
134
134
|
return_type = opts[:debug_return_type] || 'GetEvent200Response'
|
|
135
135
|
|
|
136
136
|
# auth_names
|
|
137
|
-
auth_names = opts[:debug_auth_names] || ['
|
|
137
|
+
auth_names = opts[:debug_auth_names] || ['workspaceSecret']
|
|
138
138
|
|
|
139
139
|
new_options = opts.merge(
|
|
140
140
|
:operation => :"EventApi.get_event",
|
|
@@ -154,7 +154,7 @@ module PlainRouter::OpenAPI
|
|
|
154
154
|
end
|
|
155
155
|
|
|
156
156
|
# Verify server-side Signal ingestion
|
|
157
|
-
#
|
|
157
|
+
# Records one idempotent, identity-free modeled event to confirm workspace-scoped ingestion. It does not count as real arrival evidence or complete onboarding.
|
|
158
158
|
# @param [Hash] opts the optional parameters
|
|
159
159
|
# @return [CreateEvent200Response]
|
|
160
160
|
def verify_signal_ingestion(opts = {})
|
|
@@ -163,7 +163,7 @@ module PlainRouter::OpenAPI
|
|
|
163
163
|
end
|
|
164
164
|
|
|
165
165
|
# Verify server-side Signal ingestion
|
|
166
|
-
#
|
|
166
|
+
# Records one idempotent, identity-free modeled event to confirm workspace-scoped ingestion. It does not count as real arrival evidence or complete onboarding.
|
|
167
167
|
# @param [Hash] opts the optional parameters
|
|
168
168
|
# @return [Array<(CreateEvent200Response, Integer, Hash)>] CreateEvent200Response data, response status code and response headers
|
|
169
169
|
def verify_signal_ingestion_with_http_info(opts = {})
|
|
@@ -191,7 +191,7 @@ module PlainRouter::OpenAPI
|
|
|
191
191
|
return_type = opts[:debug_return_type] || 'CreateEvent200Response'
|
|
192
192
|
|
|
193
193
|
# auth_names
|
|
194
|
-
auth_names = opts[:debug_auth_names] || ['
|
|
194
|
+
auth_names = opts[:debug_auth_names] || ['workspaceSecret']
|
|
195
195
|
|
|
196
196
|
new_options = opts.merge(
|
|
197
197
|
:operation => :"EventApi.verify_signal_ingestion",
|