ddx_interactions_api 0.1.0.pre.1

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 (65) hide show
  1. checksums.yaml +7 -0
  2. data/README.md +160 -0
  3. data/lib/ddx_interactions_api/api/authentication_details_api.rb +85 -0
  4. data/lib/ddx_interactions_api/api/interactions_api.rb +386 -0
  5. data/lib/ddx_interactions_api/api_client.rb +437 -0
  6. data/lib/ddx_interactions_api/api_error.rb +58 -0
  7. data/lib/ddx_interactions_api/configuration.rb +396 -0
  8. data/lib/ddx_interactions_api/models/accepted_interaction_dto.rb +226 -0
  9. data/lib/ddx_interactions_api/models/accepted_interactions_dto.rb +228 -0
  10. data/lib/ddx_interactions_api/models/activist_code.rb +252 -0
  11. data/lib/ddx_interactions_api/models/activist_code_outcome_details.rb +276 -0
  12. data/lib/ddx_interactions_api/models/address.rb +284 -0
  13. data/lib/ddx_interactions_api/models/address_channel_details.rb +269 -0
  14. data/lib/ddx_interactions_api/models/canvasser_details.rb +278 -0
  15. data/lib/ddx_interactions_api/models/committee_details.rb +278 -0
  16. data/lib/ddx_interactions_api/models/communication_consent.rb +243 -0
  17. data/lib/ddx_interactions_api/models/communication_consent_outcome_details.rb +276 -0
  18. data/lib/ddx_interactions_api/models/communication_consent_status.rb +40 -0
  19. data/lib/ddx_interactions_api/models/contact_info.rb +291 -0
  20. data/lib/ddx_interactions_api/models/contact_method.rb +53 -0
  21. data/lib/ddx_interactions_api/models/dynamic_channel_details.rb +238 -0
  22. data/lib/ddx_interactions_api/models/dynamic_outcome_details.rb +258 -0
  23. data/lib/ddx_interactions_api/models/event_details.rb +278 -0
  24. data/lib/ddx_interactions_api/models/event_role.rb +217 -0
  25. data/lib/ddx_interactions_api/models/event_signup.rb +253 -0
  26. data/lib/ddx_interactions_api/models/event_signup_outcome_details.rb +276 -0
  27. data/lib/ddx_interactions_api/models/event_signup_status.rb +255 -0
  28. data/lib/ddx_interactions_api/models/event_signup_status_value.rb +47 -0
  29. data/lib/ddx_interactions_api/models/exchange_interaction_status.rb +43 -0
  30. data/lib/ddx_interactions_api/models/exchange_interaction_status_dto.rb +278 -0
  31. data/lib/ddx_interactions_api/models/exchange_interaction_status_dto_cursor_paginated_response_dto.rb +237 -0
  32. data/lib/ddx_interactions_api/models/external_api_key_status.rb +40 -0
  33. data/lib/ddx_interactions_api/models/external_api_key_type.rb +39 -0
  34. data/lib/ddx_interactions_api/models/external_transaction_status.rb +45 -0
  35. data/lib/ddx_interactions_api/models/initiative_dto.rb +239 -0
  36. data/lib/ddx_interactions_api/models/interaction_dto.rb +513 -0
  37. data/lib/ddx_interactions_api/models/interaction_dto_channel.rb +56 -0
  38. data/lib/ddx_interactions_api/models/interaction_dto_outcomes_detailed_inner.rb +61 -0
  39. data/lib/ddx_interactions_api/models/interaction_error_dto.rb +223 -0
  40. data/lib/ddx_interactions_api/models/interaction_van_fields_dto.rb +227 -0
  41. data/lib/ddx_interactions_api/models/interactions_batch_result_dto.rb +244 -0
  42. data/lib/ddx_interactions_api/models/interactions_dto.rb +216 -0
  43. data/lib/ddx_interactions_api/models/interactions_external_api_transaction_dto.rb +279 -0
  44. data/lib/ddx_interactions_api/models/interactions_external_api_transaction_dto_get_response_dto.rb +225 -0
  45. data/lib/ddx_interactions_api/models/interactions_external_api_transaction_log_dto.rb +238 -0
  46. data/lib/ddx_interactions_api/models/mercury_destination_van_api_key_dto.rb +246 -0
  47. data/lib/ddx_interactions_api/models/minerva_metadata_dto.rb +215 -0
  48. data/lib/ddx_interactions_api/models/outcome.rb +58 -0
  49. data/lib/ddx_interactions_api/models/outcome_detail_operation.rb +41 -0
  50. data/lib/ddx_interactions_api/models/person_identifier.rb +278 -0
  51. data/lib/ddx_interactions_api/models/problem_details.rb +255 -0
  52. data/lib/ddx_interactions_api/models/rejected_interaction_dto.rb +238 -0
  53. data/lib/ddx_interactions_api/models/rejected_interactions_dto.rb +228 -0
  54. data/lib/ddx_interactions_api/models/simple_destination_dto.rb +243 -0
  55. data/lib/ddx_interactions_api/models/simple_movement_app_dto.rb +237 -0
  56. data/lib/ddx_interactions_api/models/simple_workspace_dto.rb +277 -0
  57. data/lib/ddx_interactions_api/models/survey_response.rb +299 -0
  58. data/lib/ddx_interactions_api/models/survey_response_outcome_details.rb +276 -0
  59. data/lib/ddx_interactions_api/models/van_api_key_dto.rb +319 -0
  60. data/lib/ddx_interactions_api/models/van_database_mode.rb +40 -0
  61. data/lib/ddx_interactions_api/models/who_am_i_api_key_dto.rb +286 -0
  62. data/lib/ddx_interactions_api/models/workspace_type_dto.rb +40 -0
  63. data/lib/ddx_interactions_api/version.rb +15 -0
  64. data/lib/ddx_interactions_api.rb +96 -0
  65. metadata +175 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: fb9a4cbb3a46aa0a6f6b89897920c8fda71bd1cb33c527237e425ecc5bc68c0b
4
+ data.tar.gz: 748b6e31a1ccec21f4be591583da8d8372c47ed14da75e76eae60afc42b8a322
5
+ SHA512:
6
+ metadata.gz: 8abba7ccf8e1492105a9779d5928f2ed9aa06f6822b5ea98df25160d96e8a5be21e6e04a001969b40c3bf94c34772fd26d1d70c2ab67d511b893c14f1c53880c
7
+ data.tar.gz: '0384e10435dbaf36fa6a05c67b784bf5b129ad86e43ea1ed018e86c91ef2dc5f715377001d3eaca46cf6b154f6ea49528373c7172fdc9bbd69952565da9a8c1c'
data/README.md ADDED
@@ -0,0 +1,160 @@
1
+ # ddx_interactions_api
2
+ Interactions API documentation
3
+
4
+ Ruby client for the DDx Interactions API, generated from its OpenAPI
5
+ specification.
6
+
7
+ - API version: v1
8
+ - Gem version: 0.1.0
9
+ - Generator version: 7.10.0
10
+
11
+ For more information, please visit [https://demexchange.com/](https://demexchange.com/).
12
+
13
+ For support for this package or the DDx Interactions API please contact us
14
+ at <api@demexchange.com>
15
+
16
+ ## Requirements
17
+
18
+ Ruby >= 3.0
19
+
20
+ ## Installation
21
+
22
+ ```shell
23
+ gem install ddx_interactions_api
24
+ ```
25
+
26
+ Every published version is currently a prerelease (`X.Y.Z.pre.N`), and both
27
+ `gem install` and Bundler skip prereleases unless asked. Add `--pre` to take
28
+ the most recent one:
29
+
30
+ ```shell
31
+ gem install ddx_interactions_api --pre
32
+ ```
33
+
34
+ In a Gemfile, pin the exact version. A pessimistic constraint (`~>`) will not
35
+ select a prerelease:
36
+
37
+ gem 'ddx_interactions_api', '0.1.0.pre.<build>'
38
+
39
+ [RubyGems](https://rubygems.org/gems/ddx_interactions_api/versions) lists what is
40
+ published.
41
+
42
+ ## Changelog
43
+
44
+ API changes are recorded in the
45
+ [changelog](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/CHANGELOG.md),
46
+ regenerated from a diff of the OpenAPI specification on each sync. Entries
47
+ marked **breaking** require a change on the consumer side.
48
+
49
+ ## Reporting issues
50
+
51
+ This gem is generated; edits to it are overwritten on the next spec sync.
52
+ Report problems against the API specification rather than the generated code.
53
+
54
+ ## Getting Started
55
+
56
+ Validating an integration end to end? The [UAT guide](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/docs/RubyUat.md)
57
+ walks through install, authentication, submitting an interaction, and confirming
58
+ it reached the Exchange.
59
+
60
+ ```ruby
61
+ require 'ddx_interactions_api'
62
+
63
+ config = DdxInteractionsApi::Configuration.new
64
+ # HTTP basic auth, with the API key in the password field and an empty
65
+ # username. `config.host` defaults to the production API.
66
+ config.username = ''
67
+ config.password = ENV.fetch('DDX_API_KEY')
68
+
69
+ client = DdxInteractionsApi::ApiClient.new(config)
70
+
71
+ begin
72
+ me = DdxInteractionsApi::AuthenticationDetailsApi.new(client).vversion_auth_me_get('1')
73
+ p me
74
+ rescue DdxInteractionsApi::ApiError => e
75
+ # The exception message is only the status line; the body says why.
76
+ warn "Interactions API returned #{e.code}: #{e.response_body}"
77
+ end
78
+ ```
79
+
80
+ ## Documentation for API Endpoints
81
+
82
+ All URIs are relative to *https://api.movementinfrastructure.org*
83
+
84
+ Class | Method | HTTP request | Description
85
+ ------------ | ------------- | ------------- | -------------
86
+ *DdxInteractionsApi::AuthenticationDetailsApi* | [**vversion_auth_me_get**](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/AuthenticationDetailsApi.md#vversion_auth_me_get) | **GET** /v{version}/auth/me | Get authentication context
87
+ *DdxInteractionsApi::InteractionsApi* | [**vversion_interactions_exchange_status_get**](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/InteractionsApi.md#vversion_interactions_exchange_status_get) | **GET** /v{version}/interactions/exchange-status | Get Exchange pipeline statuses by correlation or interaction ID
88
+ *DdxInteractionsApi::InteractionsApi* | [**vversion_interactions_exchange_status_range_get**](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/InteractionsApi.md#vversion_interactions_exchange_status_range_get) | **GET** /v{version}/interactions/exchange-status/range | Get Exchange pipeline statuses by date range
89
+ *DdxInteractionsApi::InteractionsApi* | [**vversion_interactions_interaction_id_transactions_get**](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/InteractionsApi.md#vversion_interactions_interaction_id_transactions_get) | **GET** /v{version}/interactions/{interactionId}/transactions | Get external API transactions by interactionId
90
+ *DdxInteractionsApi::InteractionsApi* | [**vversion_interactions_post**](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/InteractionsApi.md#vversion_interactions_post) | **POST** /v{version}/interactions | Post interactions data
91
+ *DdxInteractionsApi::InteractionsApi* | [**vversion_interactions_transactions_get**](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/InteractionsApi.md#vversion_interactions_transactions_get) | **GET** /v{version}/interactions/transactions | Get external API transaction logs by date range
92
+
93
+
94
+ ## Documentation for Models
95
+
96
+ - [DdxInteractionsApi::AcceptedInteractionDto](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/AcceptedInteractionDto.md)
97
+ - [DdxInteractionsApi::AcceptedInteractionsDto](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/AcceptedInteractionsDto.md)
98
+ - [DdxInteractionsApi::ActivistCode](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/ActivistCode.md)
99
+ - [DdxInteractionsApi::ActivistCodeOutcomeDetails](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/ActivistCodeOutcomeDetails.md)
100
+ - [DdxInteractionsApi::Address](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/Address.md)
101
+ - [DdxInteractionsApi::AddressChannelDetails](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/AddressChannelDetails.md)
102
+ - [DdxInteractionsApi::CanvasserDetails](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/CanvasserDetails.md)
103
+ - [DdxInteractionsApi::CommitteeDetails](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/CommitteeDetails.md)
104
+ - [DdxInteractionsApi::CommunicationConsent](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/CommunicationConsent.md)
105
+ - [DdxInteractionsApi::CommunicationConsentOutcomeDetails](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/CommunicationConsentOutcomeDetails.md)
106
+ - [DdxInteractionsApi::CommunicationConsentStatus](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/CommunicationConsentStatus.md)
107
+ - [DdxInteractionsApi::ContactInfo](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/ContactInfo.md)
108
+ - [DdxInteractionsApi::ContactMethod](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/ContactMethod.md)
109
+ - [DdxInteractionsApi::DynamicChannelDetails](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/DynamicChannelDetails.md)
110
+ - [DdxInteractionsApi::DynamicOutcomeDetails](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/DynamicOutcomeDetails.md)
111
+ - [DdxInteractionsApi::EventDetails](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/EventDetails.md)
112
+ - [DdxInteractionsApi::EventRole](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/EventRole.md)
113
+ - [DdxInteractionsApi::EventSignup](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/EventSignup.md)
114
+ - [DdxInteractionsApi::EventSignupOutcomeDetails](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/EventSignupOutcomeDetails.md)
115
+ - [DdxInteractionsApi::EventSignupStatus](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/EventSignupStatus.md)
116
+ - [DdxInteractionsApi::EventSignupStatusValue](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/EventSignupStatusValue.md)
117
+ - [DdxInteractionsApi::ExchangeInteractionStatus](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/ExchangeInteractionStatus.md)
118
+ - [DdxInteractionsApi::ExchangeInteractionStatusDto](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/ExchangeInteractionStatusDto.md)
119
+ - [DdxInteractionsApi::ExchangeInteractionStatusDtoCursorPaginatedResponseDto](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/ExchangeInteractionStatusDtoCursorPaginatedResponseDto.md)
120
+ - [DdxInteractionsApi::ExternalApiKeyStatus](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/ExternalApiKeyStatus.md)
121
+ - [DdxInteractionsApi::ExternalApiKeyType](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/ExternalApiKeyType.md)
122
+ - [DdxInteractionsApi::ExternalTransactionStatus](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/ExternalTransactionStatus.md)
123
+ - [DdxInteractionsApi::InitiativeDto](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/InitiativeDto.md)
124
+ - [DdxInteractionsApi::InteractionDto](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/InteractionDto.md)
125
+ - [DdxInteractionsApi::InteractionDtoChannel](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/InteractionDtoChannel.md)
126
+ - [DdxInteractionsApi::InteractionDtoOutcomesDetailedInner](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/InteractionDtoOutcomesDetailedInner.md)
127
+ - [DdxInteractionsApi::InteractionErrorDto](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/InteractionErrorDto.md)
128
+ - [DdxInteractionsApi::InteractionVanFieldsDto](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/InteractionVanFieldsDto.md)
129
+ - [DdxInteractionsApi::InteractionsBatchResultDto](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/InteractionsBatchResultDto.md)
130
+ - [DdxInteractionsApi::InteractionsDto](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/InteractionsDto.md)
131
+ - [DdxInteractionsApi::InteractionsExternalApiTransactionDto](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/InteractionsExternalApiTransactionDto.md)
132
+ - [DdxInteractionsApi::InteractionsExternalApiTransactionDtoGetResponseDto](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/InteractionsExternalApiTransactionDtoGetResponseDto.md)
133
+ - [DdxInteractionsApi::InteractionsExternalApiTransactionLogDto](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/InteractionsExternalApiTransactionLogDto.md)
134
+ - [DdxInteractionsApi::MercuryDestinationVanApiKeyDto](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/MercuryDestinationVanApiKeyDto.md)
135
+ - [DdxInteractionsApi::MinervaMetadataDto](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/MinervaMetadataDto.md)
136
+ - [DdxInteractionsApi::Outcome](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/Outcome.md)
137
+ - [DdxInteractionsApi::OutcomeDetailOperation](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/OutcomeDetailOperation.md)
138
+ - [DdxInteractionsApi::PersonIdentifier](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/PersonIdentifier.md)
139
+ - [DdxInteractionsApi::ProblemDetails](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/ProblemDetails.md)
140
+ - [DdxInteractionsApi::RejectedInteractionDto](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/RejectedInteractionDto.md)
141
+ - [DdxInteractionsApi::RejectedInteractionsDto](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/RejectedInteractionsDto.md)
142
+ - [DdxInteractionsApi::SimpleDestinationDto](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/SimpleDestinationDto.md)
143
+ - [DdxInteractionsApi::SimpleMovementAppDto](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/SimpleMovementAppDto.md)
144
+ - [DdxInteractionsApi::SimpleWorkspaceDto](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/SimpleWorkspaceDto.md)
145
+ - [DdxInteractionsApi::SurveyResponse](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/SurveyResponse.md)
146
+ - [DdxInteractionsApi::SurveyResponseOutcomeDetails](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/SurveyResponseOutcomeDetails.md)
147
+ - [DdxInteractionsApi::VanApiKeyDto](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/VanApiKeyDto.md)
148
+ - [DdxInteractionsApi::VanDatabaseMode](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/VanDatabaseMode.md)
149
+ - [DdxInteractionsApi::WhoAmIApiKeyDto](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/WhoAmIApiKeyDto.md)
150
+ - [DdxInteractionsApi::WorkspaceTypeDto](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/ruby/v1/docs/WorkspaceTypeDto.md)
151
+
152
+
153
+ ## Documentation for Authorization
154
+
155
+
156
+ Authentication schemes defined for the API:
157
+ ### Basic
158
+
159
+ - **Type**: HTTP basic authentication
160
+
@@ -0,0 +1,85 @@
1
+ =begin
2
+ #Interactions API
3
+
4
+ #Interactions API documentation
5
+
6
+ The version of the OpenAPI document: v1
7
+ Contact: api@demexchange.com
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.10.0
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module DdxInteractionsApi
16
+ class AuthenticationDetailsApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Get authentication context
23
+ # Returns details about the authenticated API key including vendor, organization, committee, and state information.
24
+ # @param version [String]
25
+ # @param [Hash] opts the optional parameters
26
+ # @return [WhoAmIApiKeyDto]
27
+ def vversion_auth_me_get(version, opts = {})
28
+ data, _status_code, _headers = vversion_auth_me_get_with_http_info(version, opts)
29
+ data
30
+ end
31
+
32
+ # Get authentication context
33
+ # Returns details about the authenticated API key including vendor, organization, committee, and state information.
34
+ # @param version [String]
35
+ # @param [Hash] opts the optional parameters
36
+ # @return [Array<(WhoAmIApiKeyDto, Integer, Hash)>] WhoAmIApiKeyDto data, response status code and response headers
37
+ def vversion_auth_me_get_with_http_info(version, opts = {})
38
+ if @api_client.config.debugging
39
+ @api_client.config.logger.debug 'Calling API: AuthenticationDetailsApi.vversion_auth_me_get ...'
40
+ end
41
+ # verify the required parameter 'version' is set
42
+ if @api_client.config.client_side_validation && version.nil?
43
+ fail ArgumentError, "Missing the required parameter 'version' when calling AuthenticationDetailsApi.vversion_auth_me_get"
44
+ end
45
+ # resource path
46
+ local_var_path = '/v{version}/auth/me'.sub('{' + 'version' + '}', CGI.escape(version.to_s))
47
+
48
+ # query parameters
49
+ query_params = opts[:query_params] || {}
50
+
51
+ # header parameters
52
+ header_params = opts[:header_params] || {}
53
+ # HTTP header 'Accept' (if needed)
54
+ header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json']) unless header_params['Accept']
55
+
56
+ # form parameters
57
+ form_params = opts[:form_params] || {}
58
+
59
+ # http body (model)
60
+ post_body = opts[:debug_body]
61
+
62
+ # return_type
63
+ return_type = opts[:debug_return_type] || 'WhoAmIApiKeyDto'
64
+
65
+ # auth_names
66
+ auth_names = opts[:debug_auth_names] || ['Basic']
67
+
68
+ new_options = opts.merge(
69
+ :operation => :"AuthenticationDetailsApi.vversion_auth_me_get",
70
+ :header_params => header_params,
71
+ :query_params => query_params,
72
+ :form_params => form_params,
73
+ :body => post_body,
74
+ :auth_names => auth_names,
75
+ :return_type => return_type
76
+ )
77
+
78
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
79
+ if @api_client.config.debugging
80
+ @api_client.config.logger.debug "API called: AuthenticationDetailsApi#vversion_auth_me_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
81
+ end
82
+ return data, status_code, headers
83
+ end
84
+ end
85
+ end
@@ -0,0 +1,386 @@
1
+ =begin
2
+ #Interactions API
3
+
4
+ #Interactions API documentation
5
+
6
+ The version of the OpenAPI document: v1
7
+ Contact: api@demexchange.com
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.10.0
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module DdxInteractionsApi
16
+ class InteractionsApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Get Exchange pipeline statuses by correlation or interaction ID
23
+ # Returns Exchange pipeline statuses filtered by either correlationId or interactionId. Supports cursor-based pagination.
24
+ # @param version [String]
25
+ # @param [Hash] opts the optional parameters
26
+ # @option opts [String] :correlation_id The correlation ID returned from the initial publish response.
27
+ # @option opts [String] :interaction_id The interaction&#39;s unique identifier (GUID).
28
+ # @option opts [String] :cursor Opaque pagination token from a previous response&#39;s nextCursor field.
29
+ # @option opts [Integer] :limit Maximum number of results to return (default 100, max 1000).
30
+ # @return [ExchangeInteractionStatusDtoCursorPaginatedResponseDto]
31
+ def vversion_interactions_exchange_status_get(version, opts = {})
32
+ data, _status_code, _headers = vversion_interactions_exchange_status_get_with_http_info(version, opts)
33
+ data
34
+ end
35
+
36
+ # Get Exchange pipeline statuses by correlation or interaction ID
37
+ # Returns Exchange pipeline statuses filtered by either correlationId or interactionId. Supports cursor-based pagination.
38
+ # @param version [String]
39
+ # @param [Hash] opts the optional parameters
40
+ # @option opts [String] :correlation_id The correlation ID returned from the initial publish response.
41
+ # @option opts [String] :interaction_id The interaction&#39;s unique identifier (GUID).
42
+ # @option opts [String] :cursor Opaque pagination token from a previous response&#39;s nextCursor field.
43
+ # @option opts [Integer] :limit Maximum number of results to return (default 100, max 1000).
44
+ # @return [Array<(ExchangeInteractionStatusDtoCursorPaginatedResponseDto, Integer, Hash)>] ExchangeInteractionStatusDtoCursorPaginatedResponseDto data, response status code and response headers
45
+ def vversion_interactions_exchange_status_get_with_http_info(version, opts = {})
46
+ if @api_client.config.debugging
47
+ @api_client.config.logger.debug 'Calling API: InteractionsApi.vversion_interactions_exchange_status_get ...'
48
+ end
49
+ # verify the required parameter 'version' is set
50
+ if @api_client.config.client_side_validation && version.nil?
51
+ fail ArgumentError, "Missing the required parameter 'version' when calling InteractionsApi.vversion_interactions_exchange_status_get"
52
+ end
53
+ # resource path
54
+ local_var_path = '/v{version}/interactions/exchange-status'.sub('{' + 'version' + '}', CGI.escape(version.to_s))
55
+
56
+ # query parameters
57
+ query_params = opts[:query_params] || {}
58
+ query_params[:'correlationId'] = opts[:'correlation_id'] if !opts[:'correlation_id'].nil?
59
+ query_params[:'interactionId'] = opts[:'interaction_id'] if !opts[:'interaction_id'].nil?
60
+ query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
61
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
62
+
63
+ # header parameters
64
+ header_params = opts[:header_params] || {}
65
+ # HTTP header 'Accept' (if needed)
66
+ header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json']) unless header_params['Accept']
67
+
68
+ # form parameters
69
+ form_params = opts[:form_params] || {}
70
+
71
+ # http body (model)
72
+ post_body = opts[:debug_body]
73
+
74
+ # return_type
75
+ return_type = opts[:debug_return_type] || 'ExchangeInteractionStatusDtoCursorPaginatedResponseDto'
76
+
77
+ # auth_names
78
+ auth_names = opts[:debug_auth_names] || ['Basic']
79
+
80
+ new_options = opts.merge(
81
+ :operation => :"InteractionsApi.vversion_interactions_exchange_status_get",
82
+ :header_params => header_params,
83
+ :query_params => query_params,
84
+ :form_params => form_params,
85
+ :body => post_body,
86
+ :auth_names => auth_names,
87
+ :return_type => return_type
88
+ )
89
+
90
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
91
+ if @api_client.config.debugging
92
+ @api_client.config.logger.debug "API called: InteractionsApi#vversion_interactions_exchange_status_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
93
+ end
94
+ return data, status_code, headers
95
+ end
96
+
97
+ # Get Exchange pipeline statuses by date range
98
+ # Returns Exchange pipeline statuses for interactions published within the specified date range. Supports cursor-based pagination. Maximum date range is 30 days.
99
+ # @param version [String]
100
+ # @param [Hash] opts the optional parameters
101
+ # @option opts [Time] :start_date Beginning of date range (inclusive, UTC).
102
+ # @option opts [Time] :end_date End of date range (inclusive, UTC). Defaults to current UTC time.
103
+ # @option opts [String] :cursor Opaque pagination token from a previous response&#39;s nextCursor field.
104
+ # @option opts [Integer] :limit Maximum number of results to return (default 100, max 1000).
105
+ # @return [ExchangeInteractionStatusDtoCursorPaginatedResponseDto]
106
+ def vversion_interactions_exchange_status_range_get(version, opts = {})
107
+ data, _status_code, _headers = vversion_interactions_exchange_status_range_get_with_http_info(version, opts)
108
+ data
109
+ end
110
+
111
+ # Get Exchange pipeline statuses by date range
112
+ # Returns Exchange pipeline statuses for interactions published within the specified date range. Supports cursor-based pagination. Maximum date range is 30 days.
113
+ # @param version [String]
114
+ # @param [Hash] opts the optional parameters
115
+ # @option opts [Time] :start_date Beginning of date range (inclusive, UTC).
116
+ # @option opts [Time] :end_date End of date range (inclusive, UTC). Defaults to current UTC time.
117
+ # @option opts [String] :cursor Opaque pagination token from a previous response&#39;s nextCursor field.
118
+ # @option opts [Integer] :limit Maximum number of results to return (default 100, max 1000).
119
+ # @return [Array<(ExchangeInteractionStatusDtoCursorPaginatedResponseDto, Integer, Hash)>] ExchangeInteractionStatusDtoCursorPaginatedResponseDto data, response status code and response headers
120
+ def vversion_interactions_exchange_status_range_get_with_http_info(version, opts = {})
121
+ if @api_client.config.debugging
122
+ @api_client.config.logger.debug 'Calling API: InteractionsApi.vversion_interactions_exchange_status_range_get ...'
123
+ end
124
+ # verify the required parameter 'version' is set
125
+ if @api_client.config.client_side_validation && version.nil?
126
+ fail ArgumentError, "Missing the required parameter 'version' when calling InteractionsApi.vversion_interactions_exchange_status_range_get"
127
+ end
128
+ # resource path
129
+ local_var_path = '/v{version}/interactions/exchange-status/range'.sub('{' + 'version' + '}', CGI.escape(version.to_s))
130
+
131
+ # query parameters
132
+ query_params = opts[:query_params] || {}
133
+ query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
134
+ query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
135
+ query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
136
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
137
+
138
+ # header parameters
139
+ header_params = opts[:header_params] || {}
140
+ # HTTP header 'Accept' (if needed)
141
+ header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json']) unless header_params['Accept']
142
+
143
+ # form parameters
144
+ form_params = opts[:form_params] || {}
145
+
146
+ # http body (model)
147
+ post_body = opts[:debug_body]
148
+
149
+ # return_type
150
+ return_type = opts[:debug_return_type] || 'ExchangeInteractionStatusDtoCursorPaginatedResponseDto'
151
+
152
+ # auth_names
153
+ auth_names = opts[:debug_auth_names] || ['Basic']
154
+
155
+ new_options = opts.merge(
156
+ :operation => :"InteractionsApi.vversion_interactions_exchange_status_range_get",
157
+ :header_params => header_params,
158
+ :query_params => query_params,
159
+ :form_params => form_params,
160
+ :body => post_body,
161
+ :auth_names => auth_names,
162
+ :return_type => return_type
163
+ )
164
+
165
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
166
+ if @api_client.config.debugging
167
+ @api_client.config.logger.debug "API called: InteractionsApi#vversion_interactions_exchange_status_range_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
168
+ end
169
+ return data, status_code, headers
170
+ end
171
+
172
+ # Get external API transactions by interactionId
173
+ # Get all external API transaction records for the specified interaction.
174
+ # @param interaction_id [String] ID of the interaction to retrieve records for.
175
+ # @param version [String]
176
+ # @param [Hash] opts the optional parameters
177
+ # @option opts [Boolean] :show_only_failed_transactions When true, will return only transactions with Failed, Invalid, or Duplicate status. True by default. (default to true)
178
+ # @return [InteractionsExternalApiTransactionDtoGetResponseDto]
179
+ def vversion_interactions_interaction_id_transactions_get(interaction_id, version, opts = {})
180
+ data, _status_code, _headers = vversion_interactions_interaction_id_transactions_get_with_http_info(interaction_id, version, opts)
181
+ data
182
+ end
183
+
184
+ # Get external API transactions by interactionId
185
+ # Get all external API transaction records for the specified interaction.
186
+ # @param interaction_id [String] ID of the interaction to retrieve records for.
187
+ # @param version [String]
188
+ # @param [Hash] opts the optional parameters
189
+ # @option opts [Boolean] :show_only_failed_transactions When true, will return only transactions with Failed, Invalid, or Duplicate status. True by default. (default to true)
190
+ # @return [Array<(InteractionsExternalApiTransactionDtoGetResponseDto, Integer, Hash)>] InteractionsExternalApiTransactionDtoGetResponseDto data, response status code and response headers
191
+ def vversion_interactions_interaction_id_transactions_get_with_http_info(interaction_id, version, opts = {})
192
+ if @api_client.config.debugging
193
+ @api_client.config.logger.debug 'Calling API: InteractionsApi.vversion_interactions_interaction_id_transactions_get ...'
194
+ end
195
+ # verify the required parameter 'interaction_id' is set
196
+ if @api_client.config.client_side_validation && interaction_id.nil?
197
+ fail ArgumentError, "Missing the required parameter 'interaction_id' when calling InteractionsApi.vversion_interactions_interaction_id_transactions_get"
198
+ end
199
+ # verify the required parameter 'version' is set
200
+ if @api_client.config.client_side_validation && version.nil?
201
+ fail ArgumentError, "Missing the required parameter 'version' when calling InteractionsApi.vversion_interactions_interaction_id_transactions_get"
202
+ end
203
+ # resource path
204
+ local_var_path = '/v{version}/interactions/{interactionId}/transactions'.sub('{' + 'interactionId' + '}', CGI.escape(interaction_id.to_s)).sub('{' + 'version' + '}', CGI.escape(version.to_s))
205
+
206
+ # query parameters
207
+ query_params = opts[:query_params] || {}
208
+ query_params[:'showOnlyFailedTransactions'] = opts[:'show_only_failed_transactions'] if !opts[:'show_only_failed_transactions'].nil?
209
+
210
+ # header parameters
211
+ header_params = opts[:header_params] || {}
212
+ # HTTP header 'Accept' (if needed)
213
+ header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json']) unless header_params['Accept']
214
+
215
+ # form parameters
216
+ form_params = opts[:form_params] || {}
217
+
218
+ # http body (model)
219
+ post_body = opts[:debug_body]
220
+
221
+ # return_type
222
+ return_type = opts[:debug_return_type] || 'InteractionsExternalApiTransactionDtoGetResponseDto'
223
+
224
+ # auth_names
225
+ auth_names = opts[:debug_auth_names] || ['Basic']
226
+
227
+ new_options = opts.merge(
228
+ :operation => :"InteractionsApi.vversion_interactions_interaction_id_transactions_get",
229
+ :header_params => header_params,
230
+ :query_params => query_params,
231
+ :form_params => form_params,
232
+ :body => post_body,
233
+ :auth_names => auth_names,
234
+ :return_type => return_type
235
+ )
236
+
237
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
238
+ if @api_client.config.debugging
239
+ @api_client.config.logger.debug "API called: InteractionsApi#vversion_interactions_interaction_id_transactions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
240
+ end
241
+ return data, status_code, headers
242
+ end
243
+
244
+ # Post interactions data
245
+ # This endpoint is used to post interactions data to the Interactions API that will be published to Pub/Sub. A maximum of 100 interactions can be submitted per request.
246
+ # @param version [String]
247
+ # @param [Hash] opts the optional parameters
248
+ # @option opts [InteractionsDto] :interactions_dto
249
+ # @return [InteractionsBatchResultDto]
250
+ def vversion_interactions_post(version, opts = {})
251
+ data, _status_code, _headers = vversion_interactions_post_with_http_info(version, opts)
252
+ data
253
+ end
254
+
255
+ # Post interactions data
256
+ # This endpoint is used to post interactions data to the Interactions API that will be published to Pub/Sub. A maximum of 100 interactions can be submitted per request.
257
+ # @param version [String]
258
+ # @param [Hash] opts the optional parameters
259
+ # @option opts [InteractionsDto] :interactions_dto
260
+ # @return [Array<(InteractionsBatchResultDto, Integer, Hash)>] InteractionsBatchResultDto data, response status code and response headers
261
+ def vversion_interactions_post_with_http_info(version, opts = {})
262
+ if @api_client.config.debugging
263
+ @api_client.config.logger.debug 'Calling API: InteractionsApi.vversion_interactions_post ...'
264
+ end
265
+ # verify the required parameter 'version' is set
266
+ if @api_client.config.client_side_validation && version.nil?
267
+ fail ArgumentError, "Missing the required parameter 'version' when calling InteractionsApi.vversion_interactions_post"
268
+ end
269
+ # resource path
270
+ local_var_path = '/v{version}/interactions'.sub('{' + 'version' + '}', CGI.escape(version.to_s))
271
+
272
+ # query parameters
273
+ query_params = opts[:query_params] || {}
274
+
275
+ # header parameters
276
+ header_params = opts[:header_params] || {}
277
+ # HTTP header 'Accept' (if needed)
278
+ header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json']) unless header_params['Accept']
279
+ # HTTP header 'Content-Type'
280
+ content_type = @api_client.select_header_content_type(['application/json', 'text/json', 'application/*+json'])
281
+ if !content_type.nil?
282
+ header_params['Content-Type'] = content_type
283
+ end
284
+
285
+ # form parameters
286
+ form_params = opts[:form_params] || {}
287
+
288
+ # http body (model)
289
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'interactions_dto'])
290
+
291
+ # return_type
292
+ return_type = opts[:debug_return_type] || 'InteractionsBatchResultDto'
293
+
294
+ # auth_names
295
+ auth_names = opts[:debug_auth_names] || ['Basic']
296
+
297
+ new_options = opts.merge(
298
+ :operation => :"InteractionsApi.vversion_interactions_post",
299
+ :header_params => header_params,
300
+ :query_params => query_params,
301
+ :form_params => form_params,
302
+ :body => post_body,
303
+ :auth_names => auth_names,
304
+ :return_type => return_type
305
+ )
306
+
307
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
308
+ if @api_client.config.debugging
309
+ @api_client.config.logger.debug "API called: InteractionsApi#vversion_interactions_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
310
+ end
311
+ return data, status_code, headers
312
+ end
313
+
314
+ # Get external API transaction logs by date range
315
+ # Get all external API transaction records within the date range specified, for a maximum of up to a 30 day span.
316
+ # @param version [String]
317
+ # @param [Hash] opts the optional parameters
318
+ # @option opts [Time] :start_date Beginning of date range to show transactions for (inclusive). Must be provided in UTC, and be within 30 days of endDate.
319
+ # @option opts [Time] :end_date End of date range to show transactions for (inclusive). Defaults to current date/time if not provided. Must be provided in UTC if specified, and be within 30 days of startDate.
320
+ # @option opts [Boolean] :show_only_failed_transactions When true, will return only transactions with Failed, Invalid, or Duplicate status. True by default. (default to true)
321
+ # @return [InteractionsExternalApiTransactionDtoGetResponseDto]
322
+ def vversion_interactions_transactions_get(version, opts = {})
323
+ data, _status_code, _headers = vversion_interactions_transactions_get_with_http_info(version, opts)
324
+ data
325
+ end
326
+
327
+ # Get external API transaction logs by date range
328
+ # Get all external API transaction records within the date range specified, for a maximum of up to a 30 day span.
329
+ # @param version [String]
330
+ # @param [Hash] opts the optional parameters
331
+ # @option opts [Time] :start_date Beginning of date range to show transactions for (inclusive). Must be provided in UTC, and be within 30 days of endDate.
332
+ # @option opts [Time] :end_date End of date range to show transactions for (inclusive). Defaults to current date/time if not provided. Must be provided in UTC if specified, and be within 30 days of startDate.
333
+ # @option opts [Boolean] :show_only_failed_transactions When true, will return only transactions with Failed, Invalid, or Duplicate status. True by default. (default to true)
334
+ # @return [Array<(InteractionsExternalApiTransactionDtoGetResponseDto, Integer, Hash)>] InteractionsExternalApiTransactionDtoGetResponseDto data, response status code and response headers
335
+ def vversion_interactions_transactions_get_with_http_info(version, opts = {})
336
+ if @api_client.config.debugging
337
+ @api_client.config.logger.debug 'Calling API: InteractionsApi.vversion_interactions_transactions_get ...'
338
+ end
339
+ # verify the required parameter 'version' is set
340
+ if @api_client.config.client_side_validation && version.nil?
341
+ fail ArgumentError, "Missing the required parameter 'version' when calling InteractionsApi.vversion_interactions_transactions_get"
342
+ end
343
+ # resource path
344
+ local_var_path = '/v{version}/interactions/transactions'.sub('{' + 'version' + '}', CGI.escape(version.to_s))
345
+
346
+ # query parameters
347
+ query_params = opts[:query_params] || {}
348
+ query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
349
+ query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
350
+ query_params[:'showOnlyFailedTransactions'] = opts[:'show_only_failed_transactions'] if !opts[:'show_only_failed_transactions'].nil?
351
+
352
+ # header parameters
353
+ header_params = opts[:header_params] || {}
354
+ # HTTP header 'Accept' (if needed)
355
+ header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json']) unless header_params['Accept']
356
+
357
+ # form parameters
358
+ form_params = opts[:form_params] || {}
359
+
360
+ # http body (model)
361
+ post_body = opts[:debug_body]
362
+
363
+ # return_type
364
+ return_type = opts[:debug_return_type] || 'InteractionsExternalApiTransactionDtoGetResponseDto'
365
+
366
+ # auth_names
367
+ auth_names = opts[:debug_auth_names] || ['Basic']
368
+
369
+ new_options = opts.merge(
370
+ :operation => :"InteractionsApi.vversion_interactions_transactions_get",
371
+ :header_params => header_params,
372
+ :query_params => query_params,
373
+ :form_params => form_params,
374
+ :body => post_body,
375
+ :auth_names => auth_names,
376
+ :return_type => return_type
377
+ )
378
+
379
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
380
+ if @api_client.config.debugging
381
+ @api_client.config.logger.debug "API called: InteractionsApi#vversion_interactions_transactions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
382
+ end
383
+ return data, status_code, headers
384
+ end
385
+ end
386
+ end