Skip to content

mydatamyconsent/ruby-sdk

BranchesTags

Repository files navigation

mydatamyconsent

MyDataMyConsent - the Ruby gem for the My Data My Consent - Developer API

Unleashing the power of consent by establishing trust. The Platform Core Developer API defines a set of capabilities that can be used to request, issue, manage and update data, documents and credentials by organizations. The API can be used to request, manage and update Decentralised Identifiers, Financial Data, Health Data issue Documents, Credentials directly or using OpenID Connect flows, and verify Messages signed with DIDs and much more.

This SDK is automatically generated by the OpenAPI Generator project:

Installation

Build a gem

To build the Ruby code into a gem:

gem build mydatamyconsent.gemspec

Then either install the gem locally:

gem install ./mydatamyconsent-0.0.1.gem

(for development, run gem install --dev ./mydatamyconsent-0.0.1.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'mydatamyconsent', '~> 0.0.1'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/mydatamyconsent/ruby-sdk, then add the following in the Gemfile:

gem 'mydatamyconsent', :git => 'https://github.com/mydatamyconsent/ruby-sdk.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'mydatamyconsent'

# Setup authorization
MyDataMyConsent.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2ClientCredentials
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = MyDataMyConsent::DataProcessingAgreementsApi.new
opts = {
  page_no: 56, # Integer | 
  page_size: 56 # Integer | 
}

begin
  #Get paginated data processing agreements.
  result = api_instance.v1_data_agreements_get(opts)
  p result
rescue MyDataMyConsent::ApiError => e
  puts "Exception when calling DataProcessingAgreementsApi->v1_data_agreements_get: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.mydatamyconsent.com

Class Method HTTP request Description
MyDataMyConsent::DataProcessingAgreementsApi v1_data_agreements_get GET /v1/data-agreements Get paginated data processing agreements.
MyDataMyConsent::DataProcessingAgreementsApi v1_data_agreements_id_delete DELETE /v1/data-agreements/{id} Delete a data processing agreement this will not delete a published or a agreement in use with consents.
MyDataMyConsent::DataProcessingAgreementsApi v1_data_agreements_id_get GET /v1/data-agreements/{id} Get data processing agreement by id.
MyDataMyConsent::DataProcessingAgreementsApi v1_data_agreements_id_terminate_put PUT /v1/data-agreements/{id}/terminate Terminate a data processing agreement by id.
MyDataMyConsent::DataProvidersDiscoveryApi v1_data_providers_get GET /v1/data-providers Discover all data providers in my data my consent by country and filters.
MyDataMyConsent::DataProvidersDiscoveryApi v1_data_providers_id_get GET /v1/data-providers/{id} Get a data provider details by provider id.
MyDataMyConsent::IndividualsApi issuer_issuedoc1_xml_post POST /issuer/issuedoc/1/xml Digilocker compatible endpoint to issue document.
MyDataMyConsent::IndividualsApi v1_individuals_consent_requests_get GET /v1/individuals/consent-requests Get all consent requests sent to Individuals.
MyDataMyConsent::IndividualsApi v1_individuals_consent_requests_post POST /v1/individuals/consent-requests Create individual consent request.
MyDataMyConsent::IndividualsApi v1_individuals_consent_requests_request_id_cancel_put PUT /v1/individuals/consent-requests/{request_id}/cancel Cancel the Individual data request by id.
MyDataMyConsent::IndividualsApi v1_individuals_consent_requests_request_id_get GET /v1/individuals/consent-requests/{request_id} Get Individual data consent request by id.
MyDataMyConsent::IndividualsApi v1_individuals_consent_templates_get GET /v1/individuals/consent-templates Get the paginated list of individual consent templates.
MyDataMyConsent::IndividualsApi v1_individuals_consent_templates_template_id_get GET /v1/individuals/consent-templates/{template_id} Get Individual consent template details by consent id.
MyDataMyConsent::IndividualsApi v1_individuals_consents_consent_id_documents_document_id_download_get GET /v1/individuals/consents/{consent_id}/documents/{document_id}/download Download Individual consented document by document id.
MyDataMyConsent::IndividualsApi v1_individuals_consents_consent_id_documents_document_id_get GET /v1/individuals/consents/{consent_id}/documents/{document_id} Get Individual consented document by document id.
MyDataMyConsent::IndividualsApi v1_individuals_consents_consent_id_documents_get GET /v1/individuals/consents/{consent_id}/documents Get Individual consented document by consent id.
MyDataMyConsent::IndividualsApi v1_individuals_consents_consent_id_financial_accounts_account_id_get GET /v1/individuals/consents/{consent_id}/financial-accounts/{account_id} Get individual consented financial account details.
MyDataMyConsent::IndividualsApi v1_individuals_consents_consent_id_financial_accounts_account_id_transactions_get GET /v1/individuals/consents/{consent_id}/financial-accounts/{account_id}/transactions Get individual consented financial account transactions.
MyDataMyConsent::IndividualsApi v1_individuals_consents_consent_id_financial_accounts_get GET /v1/individuals/consents/{consent_id}/financial-accounts Get all individual consented financial accounts.
MyDataMyConsent::IndividualsApi v1_individuals_consents_consent_id_get GET /v1/individuals/consents/{consent_id} Get Individuals consent details by consent id.
MyDataMyConsent::IndividualsApi v1_individuals_consents_consent_id_health_fhir_bundle_get GET /v1/individuals/consents/{consent_id}/health/fhir/bundle Get Individual consented Health Records by consent id.
MyDataMyConsent::IndividualsApi v1_individuals_consents_get GET /v1/individuals/consents Get the paginated list of Individual consents.
MyDataMyConsent::IndividualsApi v1_individuals_documents_issue_issue_request_id_upload_post POST /v1/individuals/documents/issue/{issue_request_id}/upload Upload a document for issuance request of individual.
MyDataMyConsent::IndividualsApi v1_individuals_documents_issue_post POST /v1/individuals/documents/issue Issue a new document to an individual user.
MyDataMyConsent::IndividualsApi v1_individuals_documents_issued_document_id_get GET /v1/individuals/documents/issued/{document_id} Get issued document.
MyDataMyConsent::IndividualsApi v1_individuals_documents_issued_get GET /v1/individuals/documents/issued Get paginated list of issued documents of given document type.
MyDataMyConsent::IndividualsApi v1_individuals_documents_types_get GET /v1/individuals/documents/types Get paginated list of registered document types.
MyDataMyConsent::OrganizationsApi v1_organizations_consent_requests_get GET /v1/organizations/consent-requests Get all consent requests sent to Organizations.
MyDataMyConsent::OrganizationsApi v1_organizations_consent_requests_post POST /v1/organizations/consent-requests Create consent request for an Organization.
MyDataMyConsent::OrganizationsApi v1_organizations_consent_requests_request_id_cancel_put PUT /v1/organizations/consent-requests/{request_id}/cancel Cancel the Organization data request by id.
MyDataMyConsent::OrganizationsApi v1_organizations_consent_requests_request_id_get GET /v1/organizations/consent-requests/{request_id} Get Organization data request by id.
MyDataMyConsent::OrganizationsApi v1_organizations_consent_templates_get GET /v1/organizations/consent-templates Get the paginated list of organization consent templates.
MyDataMyConsent::OrganizationsApi v1_organizations_consent_templates_template_id_get GET /v1/organizations/consent-templates/{template_id} Get Organization consent template details by consent id.
MyDataMyConsent::OrganizationsApi v1_organizations_consents_consent_id_documents_document_id_download_get GET /v1/organizations/consents/{consent_id}/documents/{document_id}/download Download Organization consent document by document id.
MyDataMyConsent::OrganizationsApi v1_organizations_consents_consent_id_documents_document_id_get GET /v1/organizations/consents/{consent_id}/documents/{document_id} Get Organization consent document based on document id and consent id.
MyDataMyConsent::OrganizationsApi v1_organizations_consents_consent_id_documents_get GET /v1/organizations/consents/{consent_id}/documents Get Organization consent document by consent id.
MyDataMyConsent::OrganizationsApi v1_organizations_consents_consent_id_financial_accounts_account_id_get GET /v1/organizations/consents/{consent_id}/financial-accounts/{account_id} Get organization consented financial account details.
MyDataMyConsent::OrganizationsApi v1_organizations_consents_consent_id_financial_accounts_account_id_transactions_get GET /v1/organizations/consents/{consent_id}/financial-accounts/{account_id}/transactions Get organization consented financial account transactions.
MyDataMyConsent::OrganizationsApi v1_organizations_consents_consent_id_financial_accounts_get GET /v1/organizations/consents/{consent_id}/financial-accounts Get all organization consented financial accounts.
MyDataMyConsent::OrganizationsApi v1_organizations_consents_consent_id_get GET /v1/organizations/consents/{consent_id} Get Organization consent request details by consent id.
MyDataMyConsent::OrganizationsApi v1_organizations_consents_get GET /v1/organizations/consents Get the paginated list of Organization consents.
MyDataMyConsent::OrganizationsApi v1_organizations_documents_issue_post POST /v1/organizations/documents/issue Issue a new document to an organization.
MyDataMyConsent::OrganizationsApi v1_organizations_documents_issue_upload_issue_request_id_post POST /v1/organizations/documents/issue/upload/{issue_request_id} Upload a document for issuance request of Organization.
MyDataMyConsent::OrganizationsApi v1_organizations_documents_issued_document_id_get GET /v1/organizations/documents/issued/{document_id} Get issued document.
MyDataMyConsent::OrganizationsApi v1_organizations_documents_issued_get GET /v1/organizations/documents/issued Get paginated list of issued documents of given document type.
MyDataMyConsent::OrganizationsApi v1_organizations_documents_types_get GET /v1/organizations/documents/types Get paginated list of registered document types.
MyDataMyConsent::SupportedIdentifiersApi v1_supported_identifiers_country_iso2_code_get GET /v1/supported-identifiers/{country_iso2_code} Get all supported identifiers by country.

Documentation for Models

Documentation for Authorization

OAuth2ClientCredentials

  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes:
    • SupportedIdentifiers:Read: Read SupportedIdentifiers.
    • DataProviders:Read: Read DataProviders.
    • DataProcessingAgreements:Read: Read DataProcessingAgreements.
    • DataProcessingAgreements:Write: Read & Write DataProcessingAgreements.
    • Individuals:DocumentTypes:Read: Read Individual DocumentTypes.
    • Individuals:Documents:Read: Read Individual Issued Documents.
    • Individuals:Documents:Issue: Issue Individual Documents.
    • Organizations:DocumentTypes:Read: Read Organization DocumentTypes.
    • Organizations:Documents:Read: Read Organization Issued Documents.
    • Organizations:Documents:Issue: Issue Organization Documents.
    • Individuals:ConsentRequests:Request: Request Individual Consent requests.
    • Individuals:ConsentRequests:Cancel: Cancel Individual Consent requests.
    • Individuals:ConsentRequests:Read: Read Individual Consent requests.
    • Organizations:ConsentRequests:Request: Request Organization Consent requests.
    • Organizations:ConsentRequests:Cancel: Cancel Organization Consent requests.
    • Organizations:ConsentRequests:Read: Read Organization Consent requests.
    • Individuals:Consents:Read: Read Individual Consents.
    • Organizations:Consents:Read: Read Organization Consents.
    • Individuals:ConsentRequestTemplates:Read: Read Individual Consent Request templates.
    • Organizations:ConsentRequestTemplates:Read: Read Organization Consent Request templates.

About

No description, website, or topics provided.

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages