plainrouter-sdk 0.1.0 → 0.2.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 +2 -2
- data/lib/plainrouter/client.rb +73 -1
- 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/event_api.rb +15 -15
- 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 +10 -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 +294 -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 +380 -0
- data/lib/plainrouter/openapi/models/action_proposal_input.rb +378 -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 +516 -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 +2 -2
- data/lib/plainrouter/openapi/models/create_event_request_any_of1.rb +2 -2
- 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/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/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 +2 -2
- 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/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_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 +39 -0
- data/lib/plainrouter/openapi/models/jurisdiction_policy_class.rb +2 -2
- 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/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/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/version.rb +3 -3
- data/lib/plainrouter/openapi.rb +58 -4
- data/lib/plainrouter/version.rb +1 -1
- metadata +64 -10
|
@@ -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
|
|
|
@@ -19,8 +19,8 @@ module PlainRouter::OpenAPI
|
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
|
-
# Delete user data by
|
|
23
|
-
# Idempotently removes retained user data
|
|
22
|
+
# Delete user data by verified identifier
|
|
23
|
+
# Idempotently removes retained user data using a verified raw identifier or legacy SHA-256 digest, scoped and keyed to the authenticated workspace.
|
|
24
24
|
# @param delete_user_data_request [DeleteUserDataRequest]
|
|
25
25
|
# @param [Hash] opts the optional parameters
|
|
26
26
|
# @return [DeleteUserData200Response]
|
|
@@ -29,8 +29,8 @@ module PlainRouter::OpenAPI
|
|
|
29
29
|
data
|
|
30
30
|
end
|
|
31
31
|
|
|
32
|
-
# Delete user data by
|
|
33
|
-
# Idempotently removes retained user data
|
|
32
|
+
# Delete user data by verified identifier
|
|
33
|
+
# Idempotently removes retained user data using a verified raw identifier or legacy SHA-256 digest, scoped and keyed to the authenticated workspace.
|
|
34
34
|
# @param delete_user_data_request [DeleteUserDataRequest]
|
|
35
35
|
# @param [Hash] opts the optional parameters
|
|
36
36
|
# @return [Array<(DeleteUserData200Response, Integer, Hash)>] DeleteUserData200Response data, response status code and response headers
|
|
@@ -38,10 +38,6 @@ module PlainRouter::OpenAPI
|
|
|
38
38
|
if @api_client.config.debugging
|
|
39
39
|
@api_client.config.logger.debug 'Calling API: OperationsApi.delete_user_data ...'
|
|
40
40
|
end
|
|
41
|
-
# verify the required parameter 'delete_user_data_request' is set
|
|
42
|
-
if @api_client.config.client_side_validation && delete_user_data_request.nil?
|
|
43
|
-
fail ArgumentError, "Missing the required parameter 'delete_user_data_request' when calling OperationsApi.delete_user_data"
|
|
44
|
-
end
|
|
45
41
|
# resource path
|
|
46
42
|
local_var_path = '/user-data'
|
|
47
43
|
|
|
@@ -68,7 +64,7 @@ module PlainRouter::OpenAPI
|
|
|
68
64
|
return_type = opts[:debug_return_type] || 'DeleteUserData200Response'
|
|
69
65
|
|
|
70
66
|
# auth_names
|
|
71
|
-
auth_names = opts[:debug_auth_names] || ['
|
|
67
|
+
auth_names = opts[:debug_auth_names] || ['workspaceSecret']
|
|
72
68
|
|
|
73
69
|
new_options = opts.merge(
|
|
74
70
|
:operation => :"OperationsApi.delete_user_data",
|
|
@@ -88,7 +84,7 @@ module PlainRouter::OpenAPI
|
|
|
88
84
|
end
|
|
89
85
|
|
|
90
86
|
# Get Event Match Quality history
|
|
91
|
-
# Returns recent Meta Event Match Quality snapshots for the authenticated
|
|
87
|
+
# Returns recent Meta Event Match Quality snapshots for the authenticated Signals workspace so callers can inspect measured quality changes over time.
|
|
92
88
|
# @param [Hash] opts the optional parameters
|
|
93
89
|
# @return [GetEmqReport200Response]
|
|
94
90
|
def get_emq_report(opts = {})
|
|
@@ -97,7 +93,7 @@ module PlainRouter::OpenAPI
|
|
|
97
93
|
end
|
|
98
94
|
|
|
99
95
|
# Get Event Match Quality history
|
|
100
|
-
# Returns recent Meta Event Match Quality snapshots for the authenticated
|
|
96
|
+
# Returns recent Meta Event Match Quality snapshots for the authenticated Signals workspace so callers can inspect measured quality changes over time.
|
|
101
97
|
# @param [Hash] opts the optional parameters
|
|
102
98
|
# @return [Array<(GetEmqReport200Response, Integer, Hash)>] GetEmqReport200Response data, response status code and response headers
|
|
103
99
|
def get_emq_report_with_http_info(opts = {})
|
|
@@ -125,7 +121,7 @@ module PlainRouter::OpenAPI
|
|
|
125
121
|
return_type = opts[:debug_return_type] || 'GetEmqReport200Response'
|
|
126
122
|
|
|
127
123
|
# auth_names
|
|
128
|
-
auth_names = opts[:debug_auth_names] || ['
|
|
124
|
+
auth_names = opts[:debug_auth_names] || ['workspaceSecret']
|
|
129
125
|
|
|
130
126
|
new_options = opts.merge(
|
|
131
127
|
:operation => :"OperationsApi.get_emq_report",
|
|
@@ -145,7 +141,7 @@ module PlainRouter::OpenAPI
|
|
|
145
141
|
end
|
|
146
142
|
|
|
147
143
|
# Get a reconciliation report
|
|
148
|
-
# Returns stored delivery-versus-platform reconciliation results for one
|
|
144
|
+
# Returns stored delivery-versus-platform reconciliation results for one date. Dates before the workspace read bound return 422.
|
|
149
145
|
# @param date [Date]
|
|
150
146
|
# @param [Hash] opts the optional parameters
|
|
151
147
|
# @return [GetReconciliationReport200Response]
|
|
@@ -155,7 +151,7 @@ module PlainRouter::OpenAPI
|
|
|
155
151
|
end
|
|
156
152
|
|
|
157
153
|
# Get a reconciliation report
|
|
158
|
-
# Returns stored delivery-versus-platform reconciliation results for one
|
|
154
|
+
# Returns stored delivery-versus-platform reconciliation results for one date. Dates before the workspace read bound return 422.
|
|
159
155
|
# @param date [Date]
|
|
160
156
|
# @param [Hash] opts the optional parameters
|
|
161
157
|
# @return [Array<(GetReconciliationReport200Response, Integer, Hash)>] GetReconciliationReport200Response data, response status code and response headers
|
|
@@ -189,7 +185,7 @@ module PlainRouter::OpenAPI
|
|
|
189
185
|
return_type = opts[:debug_return_type] || 'GetReconciliationReport200Response'
|
|
190
186
|
|
|
191
187
|
# auth_names
|
|
192
|
-
auth_names = opts[:debug_auth_names] || ['
|
|
188
|
+
auth_names = opts[:debug_auth_names] || ['workspaceSecret']
|
|
193
189
|
|
|
194
190
|
new_options = opts.merge(
|
|
195
191
|
:operation => :"OperationsApi.get_reconciliation_report",
|
|
@@ -209,7 +205,7 @@ module PlainRouter::OpenAPI
|
|
|
209
205
|
end
|
|
210
206
|
|
|
211
207
|
# List recent events
|
|
212
|
-
# Returns retained customer-readable events and aggregate destination-delivery acceptance metrics.
|
|
208
|
+
# Returns retained customer-readable events with stable pagination and aggregate destination-delivery acceptance metrics for the workspace.
|
|
213
209
|
# @param [Hash] opts the optional parameters
|
|
214
210
|
# @option opts [Integer] :per_page Events per page, capped at 100. (default to 25)
|
|
215
211
|
# @return [ListEvents200Response]
|
|
@@ -219,7 +215,7 @@ module PlainRouter::OpenAPI
|
|
|
219
215
|
end
|
|
220
216
|
|
|
221
217
|
# List recent events
|
|
222
|
-
# Returns retained customer-readable events and aggregate destination-delivery acceptance metrics.
|
|
218
|
+
# Returns retained customer-readable events with stable pagination and aggregate destination-delivery acceptance metrics for the workspace.
|
|
223
219
|
# @param [Hash] opts the optional parameters
|
|
224
220
|
# @option opts [Integer] :per_page Events per page, capped at 100. (default to 25)
|
|
225
221
|
# @return [Array<(ListEvents200Response, Integer, Hash)>] ListEvents200Response data, response status code and response headers
|
|
@@ -249,7 +245,7 @@ module PlainRouter::OpenAPI
|
|
|
249
245
|
return_type = opts[:debug_return_type] || 'ListEvents200Response'
|
|
250
246
|
|
|
251
247
|
# auth_names
|
|
252
|
-
auth_names = opts[:debug_auth_names] || ['
|
|
248
|
+
auth_names = opts[:debug_auth_names] || ['workspaceSecret']
|
|
253
249
|
|
|
254
250
|
new_options = opts.merge(
|
|
255
251
|
:operation => :"OperationsApi.list_events",
|
|
@@ -312,7 +308,7 @@ module PlainRouter::OpenAPI
|
|
|
312
308
|
return_type = opts[:debug_return_type] || 'ListEventsByCursor200Response'
|
|
313
309
|
|
|
314
310
|
# auth_names
|
|
315
|
-
auth_names = opts[:debug_auth_names] || ['
|
|
311
|
+
auth_names = opts[:debug_auth_names] || ['workspaceSecret']
|
|
316
312
|
|
|
317
313
|
new_options = opts.merge(
|
|
318
314
|
:operation => :"OperationsApi.list_events_by_cursor",
|
|
@@ -332,7 +328,7 @@ module PlainRouter::OpenAPI
|
|
|
332
328
|
end
|
|
333
329
|
|
|
334
330
|
# Replay eligible deliveries
|
|
335
|
-
# Evaluates retained failed deliveries
|
|
331
|
+
# Evaluates retained failed deliveries, queues the eligible subset for another delivery attempt, and reports which records were accepted or rejected.
|
|
336
332
|
# @param [Hash] opts the optional parameters
|
|
337
333
|
# @option opts [ReplayDeliveriesRequest] :replay_deliveries_request
|
|
338
334
|
# @return [ReplayDeliveries202Response]
|
|
@@ -342,7 +338,7 @@ module PlainRouter::OpenAPI
|
|
|
342
338
|
end
|
|
343
339
|
|
|
344
340
|
# Replay eligible deliveries
|
|
345
|
-
# Evaluates retained failed deliveries
|
|
341
|
+
# Evaluates retained failed deliveries, queues the eligible subset for another delivery attempt, and reports which records were accepted or rejected.
|
|
346
342
|
# @param [Hash] opts the optional parameters
|
|
347
343
|
# @option opts [ReplayDeliveriesRequest] :replay_deliveries_request
|
|
348
344
|
# @return [Array<(ReplayDeliveries202Response, Integer, Hash)>] ReplayDeliveries202Response data, response status code and response headers
|
|
@@ -376,7 +372,7 @@ module PlainRouter::OpenAPI
|
|
|
376
372
|
return_type = opts[:debug_return_type] || 'ReplayDeliveries202Response'
|
|
377
373
|
|
|
378
374
|
# auth_names
|
|
379
|
-
auth_names = opts[:debug_auth_names] || ['
|
|
375
|
+
auth_names = opts[:debug_auth_names] || ['workspaceSecret']
|
|
380
376
|
|
|
381
377
|
new_options = opts.merge(
|
|
382
378
|
:operation => :"OperationsApi.replay_deliveries",
|
|
@@ -446,7 +442,7 @@ module PlainRouter::OpenAPI
|
|
|
446
442
|
return_type = opts[:debug_return_type] || 'SendTestPurchase200Response'
|
|
447
443
|
|
|
448
444
|
# auth_names
|
|
449
|
-
auth_names = opts[:debug_auth_names] || ['
|
|
445
|
+
auth_names = opts[:debug_auth_names] || ['workspaceSecret']
|
|
450
446
|
|
|
451
447
|
new_options = opts.merge(
|
|
452
448
|
:operation => :"OperationsApi.send_test_purchase",
|
|
@@ -466,7 +462,7 @@ module PlainRouter::OpenAPI
|
|
|
466
462
|
end
|
|
467
463
|
|
|
468
464
|
# Configure destination test mode
|
|
469
|
-
# Enables or disables Meta Test Events mode for a destination owned by the authenticated
|
|
465
|
+
# Enables or disables Meta Test Events mode for a destination owned by the authenticated Signals workspace.
|
|
470
466
|
# @param destination [String] The destination ID
|
|
471
467
|
# @param set_destination_test_mode_request [SetDestinationTestModeRequest]
|
|
472
468
|
# @param [Hash] opts the optional parameters
|
|
@@ -477,7 +473,7 @@ module PlainRouter::OpenAPI
|
|
|
477
473
|
end
|
|
478
474
|
|
|
479
475
|
# Configure destination test mode
|
|
480
|
-
# Enables or disables Meta Test Events mode for a destination owned by the authenticated
|
|
476
|
+
# Enables or disables Meta Test Events mode for a destination owned by the authenticated Signals workspace.
|
|
481
477
|
# @param destination [String] The destination ID
|
|
482
478
|
# @param set_destination_test_mode_request [SetDestinationTestModeRequest]
|
|
483
479
|
# @param [Hash] opts the optional parameters
|
|
@@ -520,7 +516,7 @@ module PlainRouter::OpenAPI
|
|
|
520
516
|
return_type = opts[:debug_return_type] || 'SetDestinationTestMode200Response'
|
|
521
517
|
|
|
522
518
|
# auth_names
|
|
523
|
-
auth_names = opts[:debug_auth_names] || ['
|
|
519
|
+
auth_names = opts[:debug_auth_names] || ['workspaceSecret']
|
|
524
520
|
|
|
525
521
|
new_options = opts.merge(
|
|
526
522
|
:operation => :"OperationsApi.set_destination_test_mode",
|
|
@@ -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
|
|
|
@@ -19,19 +19,19 @@ module PlainRouter::OpenAPI
|
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
|
-
# Create a
|
|
23
|
-
# Issues a short-lived
|
|
22
|
+
# Create a Sandbox key
|
|
23
|
+
# Issues a short-lived Sandbox key without an account, human approval, or production access. It is valid for synthetic events only.
|
|
24
24
|
# @param [Hash] opts the optional parameters
|
|
25
|
-
# @return [
|
|
25
|
+
# @return [GetSandbox200ResponseSelfServeKeyIssuedKey]
|
|
26
26
|
def create_sandbox_key(opts = {})
|
|
27
27
|
data, _status_code, _headers = create_sandbox_key_with_http_info(opts)
|
|
28
28
|
data
|
|
29
29
|
end
|
|
30
30
|
|
|
31
|
-
# Create a
|
|
32
|
-
# Issues a short-lived
|
|
31
|
+
# Create a Sandbox key
|
|
32
|
+
# Issues a short-lived Sandbox key without an account, human approval, or production access. It is valid for synthetic events only.
|
|
33
33
|
# @param [Hash] opts the optional parameters
|
|
34
|
-
# @return [Array<(
|
|
34
|
+
# @return [Array<(GetSandbox200ResponseSelfServeKeyIssuedKey, Integer, Hash)>] GetSandbox200ResponseSelfServeKeyIssuedKey data, response status code and response headers
|
|
35
35
|
def create_sandbox_key_with_http_info(opts = {})
|
|
36
36
|
if @api_client.config.debugging
|
|
37
37
|
@api_client.config.logger.debug 'Calling API: SandboxApi.create_sandbox_key ...'
|
|
@@ -54,7 +54,7 @@ module PlainRouter::OpenAPI
|
|
|
54
54
|
post_body = opts[:debug_body]
|
|
55
55
|
|
|
56
56
|
# return_type
|
|
57
|
-
return_type = opts[:debug_return_type] || '
|
|
57
|
+
return_type = opts[:debug_return_type] || 'GetSandbox200ResponseSelfServeKeyIssuedKey'
|
|
58
58
|
|
|
59
59
|
# auth_names
|
|
60
60
|
auth_names = opts[:debug_auth_names] || []
|
|
@@ -77,7 +77,7 @@ module PlainRouter::OpenAPI
|
|
|
77
77
|
end
|
|
78
78
|
|
|
79
79
|
# Discover the zero-auth sandbox
|
|
80
|
-
# Returns a ready-to-run synthetic event example
|
|
80
|
+
# Returns a ready-to-run synthetic event example that needs no account or key and cannot persist data or contact an advertising provider.
|
|
81
81
|
# @param [Hash] opts the optional parameters
|
|
82
82
|
# @return [GetSandbox200Response]
|
|
83
83
|
def get_sandbox(opts = {})
|
|
@@ -86,7 +86,7 @@ module PlainRouter::OpenAPI
|
|
|
86
86
|
end
|
|
87
87
|
|
|
88
88
|
# Discover the zero-auth sandbox
|
|
89
|
-
# Returns a ready-to-run synthetic event example
|
|
89
|
+
# Returns a ready-to-run synthetic event example that needs no account or key and cannot persist data or contact an advertising provider.
|
|
90
90
|
# @param [Hash] opts the optional parameters
|
|
91
91
|
# @return [Array<(GetSandbox200Response, Integer, Hash)>] GetSandbox200Response data, response status code and response headers
|
|
92
92
|
def get_sandbox_with_http_info(opts = {})
|
|
@@ -133,8 +133,65 @@ module PlainRouter::OpenAPI
|
|
|
133
133
|
return data, status_code, headers
|
|
134
134
|
end
|
|
135
135
|
|
|
136
|
+
# Get a Sandbox key
|
|
137
|
+
# Returns a short-lived Sandbox key over GET so a read-only agent can obtain working credentials without issuing a write request.
|
|
138
|
+
# @param [Hash] opts the optional parameters
|
|
139
|
+
# @return [GetSandbox200ResponseSelfServeKeyIssuedKey]
|
|
140
|
+
def get_sandbox_key(opts = {})
|
|
141
|
+
data, _status_code, _headers = get_sandbox_key_with_http_info(opts)
|
|
142
|
+
data
|
|
143
|
+
end
|
|
144
|
+
|
|
145
|
+
# Get a Sandbox key
|
|
146
|
+
# Returns a short-lived Sandbox key over GET so a read-only agent can obtain working credentials without issuing a write request.
|
|
147
|
+
# @param [Hash] opts the optional parameters
|
|
148
|
+
# @return [Array<(GetSandbox200ResponseSelfServeKeyIssuedKey, Integer, Hash)>] GetSandbox200ResponseSelfServeKeyIssuedKey data, response status code and response headers
|
|
149
|
+
def get_sandbox_key_with_http_info(opts = {})
|
|
150
|
+
if @api_client.config.debugging
|
|
151
|
+
@api_client.config.logger.debug 'Calling API: SandboxApi.get_sandbox_key ...'
|
|
152
|
+
end
|
|
153
|
+
# resource path
|
|
154
|
+
local_var_path = '/sandbox/keys'
|
|
155
|
+
|
|
156
|
+
# query parameters
|
|
157
|
+
query_params = opts[:query_params] || {}
|
|
158
|
+
|
|
159
|
+
# header parameters
|
|
160
|
+
header_params = opts[:header_params] || {}
|
|
161
|
+
# HTTP header 'Accept' (if needed)
|
|
162
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
163
|
+
|
|
164
|
+
# form parameters
|
|
165
|
+
form_params = opts[:form_params] || {}
|
|
166
|
+
|
|
167
|
+
# http body (model)
|
|
168
|
+
post_body = opts[:debug_body]
|
|
169
|
+
|
|
170
|
+
# return_type
|
|
171
|
+
return_type = opts[:debug_return_type] || 'GetSandbox200ResponseSelfServeKeyIssuedKey'
|
|
172
|
+
|
|
173
|
+
# auth_names
|
|
174
|
+
auth_names = opts[:debug_auth_names] || []
|
|
175
|
+
|
|
176
|
+
new_options = opts.merge(
|
|
177
|
+
:operation => :"SandboxApi.get_sandbox_key",
|
|
178
|
+
:header_params => header_params,
|
|
179
|
+
:query_params => query_params,
|
|
180
|
+
:form_params => form_params,
|
|
181
|
+
:body => post_body,
|
|
182
|
+
:auth_names => auth_names,
|
|
183
|
+
:return_type => return_type
|
|
184
|
+
)
|
|
185
|
+
|
|
186
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
187
|
+
if @api_client.config.debugging
|
|
188
|
+
@api_client.config.logger.debug "API called: SandboxApi#get_sandbox_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
189
|
+
end
|
|
190
|
+
return data, status_code, headers
|
|
191
|
+
end
|
|
192
|
+
|
|
136
193
|
# Validate a synthetic event
|
|
137
|
-
# Validates and immediately discards one identity-free synthetic event. It requires no account or
|
|
194
|
+
# Validates and immediately discards one identity-free synthetic event. It requires no account or key and never writes to the ledger or contacts Meta.
|
|
138
195
|
# @param validate_sandbox_event_request [ValidateSandboxEventRequest]
|
|
139
196
|
# @param [Hash] opts the optional parameters
|
|
140
197
|
# @return [ValidateSandboxEvent200Response]
|
|
@@ -144,7 +201,7 @@ module PlainRouter::OpenAPI
|
|
|
144
201
|
end
|
|
145
202
|
|
|
146
203
|
# Validate a synthetic event
|
|
147
|
-
# Validates and immediately discards one identity-free synthetic event. It requires no account or
|
|
204
|
+
# Validates and immediately discards one identity-free synthetic event. It requires no account or key and never writes to the ledger or contacts Meta.
|
|
148
205
|
# @param validate_sandbox_event_request [ValidateSandboxEventRequest]
|
|
149
206
|
# @param [Hash] opts the optional parameters
|
|
150
207
|
# @return [Array<(ValidateSandboxEvent200Response, Integer, Hash)>] ValidateSandboxEvent200Response data, response status code and response headers
|
|
@@ -201,8 +258,8 @@ module PlainRouter::OpenAPI
|
|
|
201
258
|
return data, status_code, headers
|
|
202
259
|
end
|
|
203
260
|
|
|
204
|
-
# Validate a synthetic event with a
|
|
205
|
-
# Validates a synthetic event
|
|
261
|
+
# Validate a synthetic event with a Sandbox key
|
|
262
|
+
# Validates a synthetic event with a short-lived Sandbox key, then discards it without persisting data or contacting an advertising provider.
|
|
206
263
|
# @param validate_sandbox_event_request [ValidateSandboxEventRequest]
|
|
207
264
|
# @param [Hash] opts the optional parameters
|
|
208
265
|
# @return [ValidateSandboxEvent200Response]
|
|
@@ -211,8 +268,8 @@ module PlainRouter::OpenAPI
|
|
|
211
268
|
data
|
|
212
269
|
end
|
|
213
270
|
|
|
214
|
-
# Validate a synthetic event with a
|
|
215
|
-
# Validates a synthetic event
|
|
271
|
+
# Validate a synthetic event with a Sandbox key
|
|
272
|
+
# Validates a synthetic event with a short-lived Sandbox key, then discards it without persisting data or contacting an advertising provider.
|
|
216
273
|
# @param validate_sandbox_event_request [ValidateSandboxEventRequest]
|
|
217
274
|
# @param [Hash] opts the optional parameters
|
|
218
275
|
# @return [Array<(ValidateSandboxEvent200Response, Integer, Hash)>] ValidateSandboxEvent200Response data, response status code and response headers
|
|
@@ -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
|
|
|
@@ -248,7 +248,7 @@ module PlainRouter::OpenAPI
|
|
|
248
248
|
# Returns Auth Settings hash for api client.
|
|
249
249
|
def auth_settings
|
|
250
250
|
{
|
|
251
|
-
'
|
|
251
|
+
'workspaceSecret' =>
|
|
252
252
|
{
|
|
253
253
|
type: 'bearer',
|
|
254
254
|
in: 'header',
|
|
@@ -262,6 +262,13 @@ module PlainRouter::OpenAPI
|
|
|
262
262
|
key: 'Authorization',
|
|
263
263
|
value: "Bearer #{access_token_with_refresh}"
|
|
264
264
|
},
|
|
265
|
+
'workspaceActionKey' =>
|
|
266
|
+
{
|
|
267
|
+
type: 'bearer',
|
|
268
|
+
in: 'header',
|
|
269
|
+
key: 'Authorization',
|
|
270
|
+
value: "Bearer #{access_token_with_refresh}"
|
|
271
|
+
},
|
|
265
272
|
}
|
|
266
273
|
end
|
|
267
274
|
|
|
@@ -0,0 +1,164 @@
|
|
|
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 'date'
|
|
14
|
+
require 'time'
|
|
15
|
+
|
|
16
|
+
module PlainRouter::OpenAPI
|
|
17
|
+
class ActionBatchRead < ApiModelBase
|
|
18
|
+
attr_accessor :data
|
|
19
|
+
|
|
20
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
|
21
|
+
def self.attribute_map
|
|
22
|
+
{
|
|
23
|
+
:'data' => :'data'
|
|
24
|
+
}
|
|
25
|
+
end
|
|
26
|
+
|
|
27
|
+
# Returns attribute mapping this model knows about
|
|
28
|
+
def self.acceptable_attribute_map
|
|
29
|
+
attribute_map
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# Returns all the JSON keys this model knows about
|
|
33
|
+
def self.acceptable_attributes
|
|
34
|
+
acceptable_attribute_map.values
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
# Attribute type mapping.
|
|
38
|
+
def self.openapi_types
|
|
39
|
+
{
|
|
40
|
+
:'data' => :'ActionBatchReadData'
|
|
41
|
+
}
|
|
42
|
+
end
|
|
43
|
+
|
|
44
|
+
# List of attributes with nullable: true
|
|
45
|
+
def self.openapi_nullable
|
|
46
|
+
Set.new([
|
|
47
|
+
])
|
|
48
|
+
end
|
|
49
|
+
|
|
50
|
+
# Initializes the object
|
|
51
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
52
|
+
def initialize(attributes = {})
|
|
53
|
+
if (!attributes.is_a?(Hash))
|
|
54
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `PlainRouter::OpenAPI::ActionBatchRead` initialize method"
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
|
58
|
+
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
59
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
60
|
+
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
61
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `PlainRouter::OpenAPI::ActionBatchRead`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
62
|
+
end
|
|
63
|
+
h[k.to_sym] = v
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
if attributes.key?(:'data')
|
|
67
|
+
self.data = attributes[:'data']
|
|
68
|
+
else
|
|
69
|
+
self.data = nil
|
|
70
|
+
end
|
|
71
|
+
end
|
|
72
|
+
|
|
73
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
|
74
|
+
# @return Array for valid properties with the reasons
|
|
75
|
+
def list_invalid_properties
|
|
76
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
|
77
|
+
invalid_properties = Array.new
|
|
78
|
+
if @data.nil?
|
|
79
|
+
invalid_properties.push('invalid value for "data", data cannot be nil.')
|
|
80
|
+
end
|
|
81
|
+
|
|
82
|
+
invalid_properties
|
|
83
|
+
end
|
|
84
|
+
|
|
85
|
+
# Check to see if the all the properties in the model are valid
|
|
86
|
+
# @return true if the model is valid
|
|
87
|
+
def valid?
|
|
88
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
89
|
+
return false if @data.nil?
|
|
90
|
+
true
|
|
91
|
+
end
|
|
92
|
+
|
|
93
|
+
# Custom attribute writer method with validation
|
|
94
|
+
# @param [Object] data Value to be assigned
|
|
95
|
+
def data=(data)
|
|
96
|
+
if data.nil?
|
|
97
|
+
fail ArgumentError, 'data cannot be nil'
|
|
98
|
+
end
|
|
99
|
+
|
|
100
|
+
@data = data
|
|
101
|
+
end
|
|
102
|
+
|
|
103
|
+
# Checks equality by comparing each attribute.
|
|
104
|
+
# @param [Object] Object to be compared
|
|
105
|
+
def ==(o)
|
|
106
|
+
return true if self.equal?(o)
|
|
107
|
+
self.class == o.class &&
|
|
108
|
+
data == o.data
|
|
109
|
+
end
|
|
110
|
+
|
|
111
|
+
# @see the `==` method
|
|
112
|
+
# @param [Object] Object to be compared
|
|
113
|
+
def eql?(o)
|
|
114
|
+
self == o
|
|
115
|
+
end
|
|
116
|
+
|
|
117
|
+
# Calculates hash code according to all attributes.
|
|
118
|
+
# @return [Integer] Hash code
|
|
119
|
+
def hash
|
|
120
|
+
[data].hash
|
|
121
|
+
end
|
|
122
|
+
|
|
123
|
+
# Builds the object from hash
|
|
124
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
125
|
+
# @return [Object] Returns the model itself
|
|
126
|
+
def self.build_from_hash(attributes)
|
|
127
|
+
return nil unless attributes.is_a?(Hash)
|
|
128
|
+
attributes = attributes.transform_keys(&:to_sym)
|
|
129
|
+
transformed_hash = {}
|
|
130
|
+
openapi_types.each_pair do |key, type|
|
|
131
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
|
132
|
+
transformed_hash["#{key}"] = nil
|
|
133
|
+
elsif type =~ /\AArray<(.*)>/i
|
|
134
|
+
# check to ensure the input is an array given that the attribute
|
|
135
|
+
# is documented as an array but the input is not
|
|
136
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
|
137
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
|
138
|
+
end
|
|
139
|
+
elsif !attributes[attribute_map[key]].nil?
|
|
140
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
|
141
|
+
end
|
|
142
|
+
end
|
|
143
|
+
new(transformed_hash)
|
|
144
|
+
end
|
|
145
|
+
|
|
146
|
+
# Returns the object in the form of hash
|
|
147
|
+
# @return [Hash] Returns the object in the form of hash
|
|
148
|
+
def to_hash
|
|
149
|
+
hash = {}
|
|
150
|
+
self.class.attribute_map.each_pair do |attr, param|
|
|
151
|
+
value = self.send(attr)
|
|
152
|
+
if value.nil?
|
|
153
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
154
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
155
|
+
end
|
|
156
|
+
|
|
157
|
+
hash[param] = _to_hash(value)
|
|
158
|
+
end
|
|
159
|
+
hash
|
|
160
|
+
end
|
|
161
|
+
|
|
162
|
+
end
|
|
163
|
+
|
|
164
|
+
end
|