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.
Files changed (127) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/lib/plainrouter/client.rb +73 -1
  4. data/lib/plainrouter/openapi/api/action_dry_run_api_api.rb +96 -0
  5. data/lib/plainrouter/openapi/api/action_proposal_api_api.rb +96 -0
  6. data/lib/plainrouter/openapi/api/action_read_api_api.rb +404 -0
  7. data/lib/plainrouter/openapi/api/event_api.rb +15 -15
  8. data/lib/plainrouter/openapi/api/operations_api.rb +24 -28
  9. data/lib/plainrouter/openapi/api/sandbox_api.rb +74 -17
  10. data/lib/plainrouter/openapi/api_client.rb +2 -2
  11. data/lib/plainrouter/openapi/api_error.rb +2 -2
  12. data/lib/plainrouter/openapi/api_model_base.rb +2 -2
  13. data/lib/plainrouter/openapi/configuration.rb +10 -3
  14. data/lib/plainrouter/openapi/models/action_batch_read.rb +164 -0
  15. data/lib/plainrouter/openapi/models/action_batch_read_data.rb +450 -0
  16. data/lib/plainrouter/openapi/models/action_current_disposition.rb +294 -0
  17. data/lib/plainrouter/openapi/models/action_decision_receipt_read.rb +244 -0
  18. data/lib/plainrouter/openapi/models/action_decision_receipt_read_chain_entry.rb +190 -0
  19. data/lib/plainrouter/openapi/models/action_detail_read.rb +164 -0
  20. data/lib/plainrouter/openapi/models/action_dry_run_read.rb +164 -0
  21. data/lib/plainrouter/openapi/models/action_dry_run_read_dry_run.rb +166 -0
  22. data/lib/plainrouter/openapi/models/action_dry_run_read_dry_run_actions_inner.rb +103 -0
  23. data/lib/plainrouter/openapi/models/action_dry_run_read_dry_run_actions_inner_any_of.rb +376 -0
  24. data/lib/plainrouter/openapi/models/action_dry_run_read_dry_run_actions_inner_any_of1.rb +268 -0
  25. data/lib/plainrouter/openapi/models/action_dry_run_read_dry_run_actions_inner_any_of_diff.rb +162 -0
  26. data/lib/plainrouter/openapi/models/action_dry_run_read_dry_run_actions_inner_any_of_target_entity.rb +199 -0
  27. data/lib/plainrouter/openapi/models/action_list_read.rb +192 -0
  28. data/lib/plainrouter/openapi/models/action_list_read_meta.rb +242 -0
  29. data/lib/plainrouter/openapi/models/action_policy_read.rb +164 -0
  30. data/lib/plainrouter/openapi/models/action_policy_read_data.rb +380 -0
  31. data/lib/plainrouter/openapi/models/action_proposal_input.rb +378 -0
  32. data/lib/plainrouter/openapi/models/action_proposal_input_actions_inner.rb +115 -0
  33. data/lib/plainrouter/openapi/models/action_proposal_input_actions_inner_any_of.rb +303 -0
  34. data/lib/plainrouter/openapi/models/action_proposal_input_actions_inner_any_of1.rb +303 -0
  35. data/lib/plainrouter/openapi/models/action_proposal_input_actions_inner_any_of10.rb +303 -0
  36. data/lib/plainrouter/openapi/models/action_proposal_input_actions_inner_any_of10_params.rb +356 -0
  37. data/lib/plainrouter/openapi/models/action_proposal_input_actions_inner_any_of11.rb +303 -0
  38. data/lib/plainrouter/openapi/models/action_proposal_input_actions_inner_any_of11_params.rb +173 -0
  39. data/lib/plainrouter/openapi/models/action_proposal_input_actions_inner_any_of12.rb +303 -0
  40. data/lib/plainrouter/openapi/models/action_proposal_input_actions_inner_any_of12_params.rb +188 -0
  41. data/lib/plainrouter/openapi/models/action_proposal_input_actions_inner_any_of13.rb +303 -0
  42. data/lib/plainrouter/openapi/models/action_proposal_input_actions_inner_any_of13_params.rb +259 -0
  43. data/lib/plainrouter/openapi/models/action_proposal_input_actions_inner_any_of2.rb +303 -0
  44. data/lib/plainrouter/openapi/models/action_proposal_input_actions_inner_any_of3.rb +303 -0
  45. data/lib/plainrouter/openapi/models/action_proposal_input_actions_inner_any_of4.rb +303 -0
  46. data/lib/plainrouter/openapi/models/action_proposal_input_actions_inner_any_of4_target_entity.rb +253 -0
  47. data/lib/plainrouter/openapi/models/action_proposal_input_actions_inner_any_of5.rb +303 -0
  48. data/lib/plainrouter/openapi/models/action_proposal_input_actions_inner_any_of6.rb +303 -0
  49. data/lib/plainrouter/openapi/models/action_proposal_input_actions_inner_any_of7.rb +303 -0
  50. data/lib/plainrouter/openapi/models/action_proposal_input_actions_inner_any_of8.rb +303 -0
  51. data/lib/plainrouter/openapi/models/action_proposal_input_actions_inner_any_of9.rb +303 -0
  52. data/lib/plainrouter/openapi/models/action_proposal_input_actions_inner_any_of_params.rb +173 -0
  53. data/lib/plainrouter/openapi/models/action_proposal_input_actions_inner_any_of_target_entity.rb +264 -0
  54. data/lib/plainrouter/openapi/models/action_proposal_input_evidence_inner.rb +262 -0
  55. data/lib/plainrouter/openapi/models/action_proposal_read.rb +164 -0
  56. data/lib/plainrouter/openapi/models/action_proposal_read_proposal.rb +452 -0
  57. data/lib/plainrouter/openapi/models/action_proposal_read_proposal_actions_inner.rb +386 -0
  58. data/lib/plainrouter/openapi/models/action_proposal_read_proposal_actions_inner_params.rb +103 -0
  59. data/lib/plainrouter/openapi/models/action_proposal_read_proposal_proposed_by.rb +202 -0
  60. data/lib/plainrouter/openapi/models/action_read_item.rb +516 -0
  61. data/lib/plainrouter/openapi/models/create_event200_response.rb +2 -2
  62. data/lib/plainrouter/openapi/models/create_event202_response.rb +218 -0
  63. data/lib/plainrouter/openapi/models/create_event202_response_warnings_inner.rb +240 -0
  64. data/lib/plainrouter/openapi/models/create_event_request.rb +2 -2
  65. data/lib/plainrouter/openapi/models/create_event_request_any_of.rb +2 -2
  66. data/lib/plainrouter/openapi/models/create_event_request_any_of1.rb +2 -2
  67. data/lib/plainrouter/openapi/models/create_event_request_any_of_event_time.rb +2 -2
  68. data/lib/plainrouter/openapi/models/create_event_request_any_of_value_data.rb +2 -2
  69. data/lib/plainrouter/openapi/models/delete_user_data200_response.rb +2 -2
  70. data/lib/plainrouter/openapi/models/delete_user_data_request.rb +35 -36
  71. data/lib/plainrouter/openapi/models/delivery_status.rb +2 -2
  72. data/lib/plainrouter/openapi/models/destination.rb +30 -3
  73. data/lib/plainrouter/openapi/models/destination_credential_source.rb +3 -4
  74. data/lib/plainrouter/openapi/models/destination_status.rb +2 -2
  75. data/lib/plainrouter/openapi/models/destination_type.rb +2 -2
  76. data/lib/plainrouter/openapi/models/emq_snapshot.rb +30 -3
  77. data/lib/plainrouter/openapi/models/error_message.rb +2 -2
  78. data/lib/plainrouter/openapi/models/event.rb +89 -45
  79. data/lib/plainrouter/openapi/models/get_emq_report200_response.rb +2 -2
  80. data/lib/plainrouter/openapi/models/get_emq_report200_response_snapshots_inner.rb +30 -3
  81. data/lib/plainrouter/openapi/models/get_event200_response.rb +2 -2
  82. data/lib/plainrouter/openapi/models/get_event200_response_deliveries_inner.rb +30 -3
  83. data/lib/plainrouter/openapi/models/get_event200_response_event.rb +31 -4
  84. data/lib/plainrouter/openapi/models/get_event200_response_event_consent.rb +2 -2
  85. data/lib/plainrouter/openapi/models/get_event200_response_event_deliveries_inner.rb +30 -3
  86. data/lib/plainrouter/openapi/models/get_event200_response_event_user_data_hashed.rb +104 -0
  87. data/lib/plainrouter/openapi/models/get_event200_response_lineage.rb +2 -2
  88. data/lib/plainrouter/openapi/models/get_event200_response_lineage_children_inner.rb +31 -4
  89. data/lib/plainrouter/openapi/models/get_event200_response_lineage_parent.rb +31 -4
  90. data/lib/plainrouter/openapi/models/get_reconciliation_report200_response.rb +2 -2
  91. data/lib/plainrouter/openapi/models/get_reconciliation_report200_response_reports_inner.rb +30 -3
  92. data/lib/plainrouter/openapi/models/get_reconciliation_report200_response_reports_inner_buckets_value.rb +2 -2
  93. data/lib/plainrouter/openapi/models/get_reconciliation_report200_response_reports_inner_event_counts.rb +2 -2
  94. data/lib/plainrouter/openapi/models/get_reconciliation_report200_response_reports_inner_event_counts_accepted.rb +2 -2
  95. data/lib/plainrouter/openapi/models/get_sandbox200_response.rb +2 -2
  96. data/lib/plainrouter/openapi/models/get_sandbox200_response_self_serve_key.rb +32 -6
  97. data/lib/plainrouter/openapi/models/{create_sandbox_key201_response.rb → get_sandbox200_response_self_serve_key_issued_key.rb} +6 -6
  98. data/lib/plainrouter/openapi/models/{create_sandbox_key201_response_use.rb → get_sandbox200_response_self_serve_key_issued_key_use.rb} +5 -5
  99. data/lib/plainrouter/openapi/models/get_sandbox200_response_try.rb +2 -2
  100. data/lib/plainrouter/openapi/models/get_sandbox200_response_try_body.rb +2 -2
  101. data/lib/plainrouter/openapi/models/get_sandbox200_response_try_body_value_data.rb +2 -2
  102. data/lib/plainrouter/openapi/models/ingestion_warning_code.rb +39 -0
  103. data/lib/plainrouter/openapi/models/jurisdiction_policy_class.rb +2 -2
  104. data/lib/plainrouter/openapi/models/list_events200_response.rb +2 -2
  105. data/lib/plainrouter/openapi/models/list_events200_response_events.rb +2 -2
  106. data/lib/plainrouter/openapi/models/list_events200_response_events_links_inner.rb +2 -2
  107. data/lib/plainrouter/openapi/models/list_events200_response_metrics.rb +2 -2
  108. data/lib/plainrouter/openapi/models/list_events_by_cursor200_response.rb +2 -2
  109. data/lib/plainrouter/openapi/models/list_events_by_cursor200_response_events.rb +2 -2
  110. data/lib/plainrouter/openapi/models/reconciliation_report.rb +31 -3
  111. data/lib/plainrouter/openapi/models/replay_deliveries202_response.rb +2 -2
  112. data/lib/plainrouter/openapi/models/replay_deliveries_request.rb +2 -2
  113. data/lib/plainrouter/openapi/models/send_test_purchase200_response.rb +2 -2
  114. data/lib/plainrouter/openapi/models/send_test_purchase422_response.rb +2 -2
  115. data/lib/plainrouter/openapi/models/send_test_purchase_request.rb +2 -2
  116. data/lib/plainrouter/openapi/models/set_destination_test_mode200_response.rb +2 -2
  117. data/lib/plainrouter/openapi/models/set_destination_test_mode200_response_destination.rb +30 -3
  118. data/lib/plainrouter/openapi/models/set_destination_test_mode_request.rb +2 -2
  119. data/lib/plainrouter/openapi/models/traffic_class.rb +2 -2
  120. data/lib/plainrouter/openapi/models/validate_sandbox_event200_response.rb +2 -2
  121. data/lib/plainrouter/openapi/models/validate_sandbox_event_request.rb +2 -2
  122. data/lib/plainrouter/openapi/models/validate_sandbox_event_request_value_data.rb +2 -2
  123. data/lib/plainrouter/openapi/models/validation_error.rb +2 -2
  124. data/lib/plainrouter/openapi/version.rb +3 -3
  125. data/lib/plainrouter/openapi.rb +58 -4
  126. data/lib/plainrouter/version.rb +1 -1
  127. metadata +64 -10
@@ -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
@@ -1,7 +1,7 @@
1
1
  =begin
2
- #PlainRouter Conversion API
2
+ #Plainrouter Conversion API
3
3
 
4
- #PlainRouter public Signals Conversion API.
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. Supply either event_id in the JSON body or Idempotency-Key in the request headers to make retries idempotent.
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, PlainRouter uses this value as event_id. If both are supplied, they must match.
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. Supply either event_id in the JSON body or Idempotency-Key in the request headers to make retries idempotent.
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, PlainRouter uses this value as event_id. If both are supplied, they must match.
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] || ['signalTrackerSecret']
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] || ['signalTrackerSecret']
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
- # Writes one identity-free verification event for onboarding and returns the existing event on retry.
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
- # Writes one identity-free verification event for onboarding and returns the existing event on retry.
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] || ['signalTrackerSecret']
194
+ auth_names = opts[:debug_auth_names] || ['workspaceSecret']
195
195
 
196
196
  new_options = opts.merge(
197
197
  :operation => :"EventApi.verify_signal_ingestion",