xbim_identity 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 112705db62b705ebe866f2c899affad313dd4aac363480cb2012e580387e2544
+  data.tar.gz: b878ba1c57d098f9d6ecc70f4b250800d999595e1fe85b699c78cc55ebef33fa
+SHA512:
+  metadata.gz: 64fda6cdee34215b67fd15ab756415fff0060a1de6a35a5ec55f28e1631bd0aaebdadbf6f5355f1b519c62b23f0f07ef5b63da6e125a1dbbc979bf3c4a4cb39f
+  data.tar.gz: a1723f61c4abcfe57c87dfe23c0f8c5d70df43b9830f44f14c3283cf18b6a629b626a56bb8d066f86608046f70ff815461871cad8b4cc3de828d2642f516ca77

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -0,0 +1,174 @@
+# xbim_identity
+
+XbimIdentity - the Ruby gem for the Xbim Flex Identity API 2.0
+
+Communication centralised around construction data
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 2.0
+- Package version: 1.0.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+For more information, please visit [https://xbim.net](https://xbim.net)
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build xbim_identity.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./xbim_identity-1.0.0.gem
+```
+
+(for development, run `gem install --dev ./xbim_identity-1.0.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'xbim_identity', '~> 1.0.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'xbim_identity', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'xbim_identity'
+
+api_instance = XbimIdentity::AuthenticationApi.new
+client_id = 'client_id_example' # String | Client ID
+client_secret = 'client_secret_example' # String | Client secret (password)
+grant_type = 'grant_type_example' # String | Grant type must be 'master'
+scope = 'scope_example' # String | Required API scopes
+opts = {
+  user_id: 'user_id_example', # String | Xbim Flex user ID
+  idp_id: 'idp_id_example' # String | External identity provider user ID
+}
+
+begin
+  #Post Authentication get authorization token
+  result = api_instance.get_authorization_token(client_id, client_secret, grant_type, scope, opts)
+  p result
+rescue XbimIdentity::ApiError => e
+  puts "Exception when calling AuthenticationApi->get_authorization_token: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://apis.xbim-dev.net*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*XbimIdentity::AuthenticationApi* | [**get_authorization_token**](docs/AuthenticationApi.md#get_authorization_token) | **POST** /id/2.0/tokens | Post Authentication get authorization token
+*XbimIdentity::ClientApplicationsApi* | [**id20_client_applications_client_id_endpoints_get**](docs/ClientApplicationsApi.md#id20_client_applications_client_id_endpoints_get) | **GET** /id/2.0/ClientApplications('{clientId}')/Endpoints | Gets Endpointsfor the given client
+*XbimIdentity::ClientApplicationsApi* | [**id20_client_applications_client_id_endpoints_post**](docs/ClientApplicationsApi.md#id20_client_applications_client_id_endpoints_post) | **POST** /id/2.0/ClientApplications('{clientId}')/Endpoints | Adds an Endpoints to the given client
+*XbimIdentity::ClientApplicationsApi* | [**id20_client_applications_client_id_get**](docs/ClientApplicationsApi.md#id20_client_applications_client_id_get) | **GET** /id/2.0/ClientApplications('{clientId}') | Gets the specified Client Application by its client id
+*XbimIdentity::ClientApplicationsApi* | [**id20_client_applications_get**](docs/ClientApplicationsApi.md#id20_client_applications_get) | **GET** /id/2.0/ClientApplications | Operations to query a set of data
+*XbimIdentity::InvitationsApi* | [**id20_tenants_tenant_id_invitations_get**](docs/InvitationsApi.md#id20_tenants_tenant_id_invitations_get) | **GET** /id/2.0/Tenants({tenantId})/Invitations | Operations to query the invitations
+*XbimIdentity::InvitationsApi* | [**id20_tenants_tenant_id_invitations_invitation_id_despatch_post**](docs/InvitationsApi.md#id20_tenants_tenant_id_invitations_invitation_id_despatch_post) | **POST** /id/2.0/Tenants({tenantId})/Invitations({invitationId})/Despatch | Sends or Resends an Invitation Email.
+*XbimIdentity::InvitationsApi* | [**id20_tenants_tenant_id_invitations_invitation_id_get**](docs/InvitationsApi.md#id20_tenants_tenant_id_invitations_invitation_id_get) | **GET** /id/2.0/Tenants({tenantId})/Invitations({invitationId}) | Gets the specified Invitation by its key
+*XbimIdentity::InvitationsApi* | [**id20_tenants_tenant_id_invitations_invitation_id_patch**](docs/InvitationsApi.md#id20_tenants_tenant_id_invitations_invitation_id_patch) | **PATCH** /id/2.0/Tenants({tenantId})/Invitations({invitationId}) | Amend an existing invitation and send an email
+*XbimIdentity::InvitationsApi* | [**id20_tenants_tenant_id_invitations_invitation_id_revoke_post**](docs/InvitationsApi.md#id20_tenants_tenant_id_invitations_invitation_id_revoke_post) | **POST** /id/2.0/Tenants({tenantId})/Invitations({invitationId})/Revoke | Revokes an Invitation.
+*XbimIdentity::InvitationsApi* | [**id20_tenants_tenant_id_invitations_post**](docs/InvitationsApi.md#id20_tenants_tenant_id_invitations_post) | **POST** /id/2.0/Tenants({tenantId})/Invitations | Creates a new Invitation. The Invitation will only be sent if 'DraftOnly' is false
+*XbimIdentity::MeApi* | [**id20_me_get**](docs/MeApi.md#id20_me_get) | **GET** /id/2.0/Me | Gets details of the current logged in user
+*XbimIdentity::MeApi* | [**id20_me_regions_get**](docs/MeApi.md#id20_me_regions_get) | **GET** /id/2.0/Me/Regions | Gets a list of regions where current user has access to any tenancy (workspace)
+*XbimIdentity::MembersApi* | [**id20_tenants_tenant_id_members_get**](docs/MembersApi.md#id20_tenants_tenant_id_members_get) | **GET** /id/2.0/Tenants({tenantId})/Members | Team members
+*XbimIdentity::MembersApi* | [**id20_tenants_tenant_id_members_post**](docs/MembersApi.md#id20_tenants_tenant_id_members_post) | **POST** /id/2.0/Tenants({tenantId})/Members | Creates a new Team member adding an existing user to the tenant
+*XbimIdentity::MembersApi* | [**id20_tenants_tenant_id_members_user_id_delete**](docs/MembersApi.md#id20_tenants_tenant_id_members_user_id_delete) | **DELETE** /id/2.0/Tenants({tenantId})/Members({userId}) | Revokes a user from this Tenant. Requires the Administrator Tenant Role
+*XbimIdentity::MembersApi* | [**id20_tenants_tenant_id_members_user_id_get**](docs/MembersApi.md#id20_tenants_tenant_id_members_user_id_get) | **GET** /id/2.0/Tenants({tenantId})/Members({userId}) | Gets the specified Tenant Member by their userId
+*XbimIdentity::MembersApi* | [**id20_tenants_tenant_id_members_user_id_patch**](docs/MembersApi.md#id20_tenants_tenant_id_members_user_id_patch) | **PATCH** /id/2.0/Tenants({tenantId})/Members({userId}) | Amend an existing team member's team details
+*XbimIdentity::RegistrationApi* | [**id20_registration_acceptinvitation_post**](docs/RegistrationApi.md#id20_registration_acceptinvitation_post) | **POST** /id/2.0/registration/acceptinvitation | Accepts a user's invitation to join a Tenant
+*XbimIdentity::TenantsApi* | [**get_tenant_by_identifier**](docs/TenantsApi.md#get_tenant_by_identifier) | **GET** /id/2.0/Tenants/GetById(identifier='{identifier}') | Gets the specified Tenant by its unique identifier
+*XbimIdentity::TenantsApi* | [**id20_tenants_demo_get**](docs/TenantsApi.md#id20_tenants_demo_get) | **GET** /id/2.0/Tenants/Demo | Registers user in the 'Demo' tenancy
+*XbimIdentity::TenantsApi* | [**id20_tenants_demo_tenant_id_get**](docs/TenantsApi.md#id20_tenants_demo_tenant_id_get) | **GET** /id/2.0/Tenants/DemoTenantId | Gets publickly known demo tenant id
+*XbimIdentity::TenantsApi* | [**id20_tenants_get**](docs/TenantsApi.md#id20_tenants_get) | **GET** /id/2.0/Tenants | Operations to query a set of data
+*XbimIdentity::TenantsApi* | [**id20_tenants_is_identifier_available_idid_get**](docs/TenantsApi.md#id20_tenants_is_identifier_available_idid_get) | **GET** /id/2.0/Tenants/IsIdentifierAvailable(id='{id}') | Checks the availability of a Tenant identifier
+*XbimIdentity::TenantsApi* | [**id20_tenants_post**](docs/TenantsApi.md#id20_tenants_post) | **POST** /id/2.0/Tenants | Creates a new Tenant for the current user
+*XbimIdentity::TenantsApi* | [**id20_tenants_tenant_id_delete**](docs/TenantsApi.md#id20_tenants_tenant_id_delete) | **DELETE** /id/2.0/Tenants({tenantId}) | Delete the tenant
+*XbimIdentity::TenantsApi* | [**id20_tenants_tenant_id_get**](docs/TenantsApi.md#id20_tenants_tenant_id_get) | **GET** /id/2.0/Tenants({tenantId}) | Gets the specified Tenant by its key
+*XbimIdentity::TenantsApi* | [**id20_tenants_tenant_id_patch**](docs/TenantsApi.md#id20_tenants_tenant_id_patch) | **PATCH** /id/2.0/Tenants({tenantId}) | Patch tenant
+*XbimIdentity::TenantsApi* | [**id20_tenants_tenant_id_subscription_get**](docs/TenantsApi.md#id20_tenants_tenant_id_subscription_get) | **GET** /id/2.0/Tenants({tenantId})/Subscription | Gets Tenant Subscription Plans
+*XbimIdentity::UsersApi* | [**id20_users_get**](docs/UsersApi.md#id20_users_get) | **GET** /id/2.0/Users | Get Users
+*XbimIdentity::UsersApi* | [**id20_users_get_by_external_id_external_idexternal_id_get**](docs/UsersApi.md#id20_users_get_by_external_id_external_idexternal_id_get) | **GET** /id/2.0/Users/GetByExternalId(externalId='{externalId}') | Gets the specified User by their key
+*XbimIdentity::UsersApi* | [**id20_users_post**](docs/UsersApi.md#id20_users_post) | **POST** /id/2.0/Users | Post Users
+*XbimIdentity::UsersApi* | [**id20_users_user_id_get**](docs/UsersApi.md#id20_users_user_id_get) | **GET** /id/2.0/Users({userId}) | Gets the specified User by their key
+
+
+## Documentation for Models
+
+ - [XbimIdentity::ApplicationType](docs/ApplicationType.md)
+ - [XbimIdentity::ClientApp](docs/ClientApp.md)
+ - [XbimIdentity::ClientAppEndpoint](docs/ClientAppEndpoint.md)
+ - [XbimIdentity::DraftInvitation](docs/DraftInvitation.md)
+ - [XbimIdentity::Invitation](docs/Invitation.md)
+ - [XbimIdentity::InvitationCreate](docs/InvitationCreate.md)
+ - [XbimIdentity::InvitationEdit](docs/InvitationEdit.md)
+ - [XbimIdentity::InviteStatus](docs/InviteStatus.md)
+ - [XbimIdentity::Master](docs/Master.md)
+ - [XbimIdentity::MasterBase](docs/MasterBase.md)
+ - [XbimIdentity::MasterSubscription](docs/MasterSubscription.md)
+ - [XbimIdentity::ODataBoolean](docs/ODataBoolean.md)
+ - [XbimIdentity::ODataClientAppEndpointList](docs/ODataClientAppEndpointList.md)
+ - [XbimIdentity::ODataClientAppList](docs/ODataClientAppList.md)
+ - [XbimIdentity::ODataInvitationList](docs/ODataInvitationList.md)
+ - [XbimIdentity::ODataString](docs/ODataString.md)
+ - [XbimIdentity::ODataTenantList](docs/ODataTenantList.md)
+ - [XbimIdentity::ODataTenantUserList](docs/ODataTenantUserList.md)
+ - [XbimIdentity::ODataUserList](docs/ODataUserList.md)
+ - [XbimIdentity::ProblemDetails](docs/ProblemDetails.md)
+ - [XbimIdentity::Region](docs/Region.md)
+ - [XbimIdentity::RegionInfo](docs/RegionInfo.md)
+ - [XbimIdentity::Subscription](docs/Subscription.md)
+ - [XbimIdentity::TeamMemberCreate](docs/TeamMemberCreate.md)
+ - [XbimIdentity::TeamMemberEdit](docs/TeamMemberEdit.md)
+ - [XbimIdentity::TenancyType](docs/TenancyType.md)
+ - [XbimIdentity::Tenant](docs/Tenant.md)
+ - [XbimIdentity::TenantCreate](docs/TenantCreate.md)
+ - [XbimIdentity::TenantEdit](docs/TenantEdit.md)
+ - [XbimIdentity::TenantRole](docs/TenantRole.md)
+ - [XbimIdentity::TenantUser](docs/TenantUser.md)
+ - [XbimIdentity::TokenErrResponse](docs/TokenErrResponse.md)
+ - [XbimIdentity::TokenResponse](docs/TokenResponse.md)
+ - [XbimIdentity::User](docs/User.md)
+ - [XbimIdentity::UserCreate](docs/UserCreate.md)
+ - [XbimIdentity::UserTenant](docs/UserTenant.md)
+
+
+## Documentation for Authorization
+
+
+### oauth2
+
+
+- **Type**: OAuth
+- **Flow**: implicit
+- **Authorization URL**: https://apis.xbim-dev.net/connect/authorize
+- **Scopes**: 
+  - api.read: Access read operations
+  - api.write: Access write operations
+  - api.admin: Access Super User operations
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/lib/xbim_identity/api/authentication_api.rb

@@ -0,0 +1,118 @@
+=begin
+#Xbim Flex Identity API 2.0
+
+#Communication centralised around construction data
+
+The version of the OpenAPI document: 2.0
+Contact: info@xbim.net
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.4.0
+
+=end
+
+require 'cgi'
+
+module XbimIdentity
+  class AuthenticationApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Post Authentication get authorization token
+    # <span style='font-size: 17px;'>Summary:</span>Gets an access token using a non-interactive flow. Only available for clients with secrets and owning Master. When no user ID is supplied, master owner user is logged in. Client can only sign in a user created in the same Master..<br/>Return Type: <b>TokenResponse</b><br/><br/>
+    # @param client_id [String] Client ID
+    # @param client_secret [String] Client secret (password)
+    # @param grant_type [String] Grant type must be &#39;master&#39;
+    # @param scope [String] Required API scopes
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :user_id Xbim Flex user ID
+    # @option opts [String] :idp_id External identity provider user ID
+    # @return [TokenResponse]
+    def get_authorization_token(client_id, client_secret, grant_type, scope, opts = {})
+      data, _status_code, _headers = get_authorization_token_with_http_info(client_id, client_secret, grant_type, scope, opts)
+      data
+    end
+
+    # Post Authentication get authorization token
+    # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Gets an access token using a non-interactive flow. Only available for clients with secrets and owning Master. When no user ID is supplied, master owner user is logged in. Client can only sign in a user created in the same Master..&lt;br/&gt;Return Type: &lt;b&gt;TokenResponse&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
+    # @param client_id [String] Client ID
+    # @param client_secret [String] Client secret (password)
+    # @param grant_type [String] Grant type must be &#39;master&#39;
+    # @param scope [String] Required API scopes
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :user_id Xbim Flex user ID
+    # @option opts [String] :idp_id External identity provider user ID
+    # @return [Array<(TokenResponse, Integer, Hash)>] TokenResponse data, response status code and response headers
+    def get_authorization_token_with_http_info(client_id, client_secret, grant_type, scope, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthenticationApi.get_authorization_token ...'
+      end
+      # verify the required parameter 'client_id' is set
+      if @api_client.config.client_side_validation && client_id.nil?
+        fail ArgumentError, "Missing the required parameter 'client_id' when calling AuthenticationApi.get_authorization_token"
+      end
+      # verify the required parameter 'client_secret' is set
+      if @api_client.config.client_side_validation && client_secret.nil?
+        fail ArgumentError, "Missing the required parameter 'client_secret' when calling AuthenticationApi.get_authorization_token"
+      end
+      # verify the required parameter 'grant_type' is set
+      if @api_client.config.client_side_validation && grant_type.nil?
+        fail ArgumentError, "Missing the required parameter 'grant_type' when calling AuthenticationApi.get_authorization_token"
+      end
+      # verify the required parameter 'scope' is set
+      if @api_client.config.client_side_validation && scope.nil?
+        fail ArgumentError, "Missing the required parameter 'scope' when calling AuthenticationApi.get_authorization_token"
+      end
+      # resource path
+      local_var_path = '/id/2.0/tokens'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['client_id'] = client_id
+      form_params['client_secret'] = client_secret
+      form_params['grant_type'] = grant_type
+      form_params['scope'] = scope
+      form_params['user_id'] = opts[:'user_id'] if !opts[:'user_id'].nil?
+      form_params['idp_id'] = opts[:'idp_id'] if !opts[:'idp_id'].nil?
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'TokenResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"AuthenticationApi.get_authorization_token",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AuthenticationApi#get_authorization_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/xbim_identity/api/client_applications_api.rb

@@ -0,0 +1,315 @@
+=begin
+#Xbim Flex Identity API 2.0
+
+#Communication centralised around construction data
+
+The version of the OpenAPI document: 2.0
+Contact: info@xbim.net
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.4.0
+
+=end
+
+require 'cgi'
+
+module XbimIdentity
+  class ClientApplicationsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Gets Endpointsfor the given client
+    # <span style='font-size: 17px;'>Summary:</span>Gets Endpointsfor the given client.<br/>Return Type: <b>ODataClientAppEndpointList</b><br/>For more information about OData responses <a href='https://www.odata.org/getting-started/understand-odata-in-6-steps/'>link</a>.<br/><br/>
+    # @param client_id [String] The client Id
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :expand Indicates the related entities to be represented inline. The maximum depth is 2.
+    # @option opts [String] :filter Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.
+    # @option opts [String] :select Limits the properties returned in the result.
+    # @option opts [String] :orderby Specifies the order in which items are returned. The maximum number of expressions is 5.
+    # @option opts [Integer] :top Limits the number of items returned from a collection.
+    # @option opts [Integer] :skip Excludes the specified number of items of the queried collection from the result.
+    # @option opts [Boolean] :count Indicates whether the total count of items within a collection are returned in the result.
+    # @return [ODataClientAppEndpointList]
+    def id20_client_applications_client_id_endpoints_get(client_id, opts = {})
+      data, _status_code, _headers = id20_client_applications_client_id_endpoints_get_with_http_info(client_id, opts)
+      data
+    end
+
+    # Gets Endpointsfor the given client
+    # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Gets Endpointsfor the given client.&lt;br/&gt;Return Type: &lt;b&gt;ODataClientAppEndpointList&lt;/b&gt;&lt;br/&gt;For more information about OData responses &lt;a href&#x3D;&#39;https://www.odata.org/getting-started/understand-odata-in-6-steps/&#39;&gt;link&lt;/a&gt;.&lt;br/&gt;&lt;br/&gt;
+    # @param client_id [String] The client Id
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :expand Indicates the related entities to be represented inline. The maximum depth is 2.
+    # @option opts [String] :filter Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.
+    # @option opts [String] :select Limits the properties returned in the result.
+    # @option opts [String] :orderby Specifies the order in which items are returned. The maximum number of expressions is 5.
+    # @option opts [Integer] :top Limits the number of items returned from a collection.
+    # @option opts [Integer] :skip Excludes the specified number of items of the queried collection from the result.
+    # @option opts [Boolean] :count Indicates whether the total count of items within a collection are returned in the result.
+    # @return [Array<(ODataClientAppEndpointList, Integer, Hash)>] ODataClientAppEndpointList data, response status code and response headers
+    def id20_client_applications_client_id_endpoints_get_with_http_info(client_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ClientApplicationsApi.id20_client_applications_client_id_endpoints_get ...'
+      end
+      # resource path
+      local_var_path = '/id/2.0/ClientApplications({clientId})/Endpoints'.sub('{' + 'clientId' + '}', CGI.escape(client_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
+      query_params[:'$filter'] = opts[:'filter'] if !opts[:'filter'].nil?
+      query_params[:'$select'] = opts[:'select'] if !opts[:'select'].nil?
+      query_params[:'$orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
+      query_params[:'$top'] = opts[:'top'] if !opts[:'top'].nil?
+      query_params[:'$skip'] = opts[:'skip'] if !opts[:'skip'].nil?
+      query_params[:'$count'] = opts[:'count'] if !opts[:'count'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ODataClientAppEndpointList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"ClientApplicationsApi.id20_client_applications_client_id_endpoints_get",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ClientApplicationsApi#id20_client_applications_client_id_endpoints_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Adds an Endpoints to the given client
+    # <span style='font-size: 17px;'>Summary:</span>Adds an Endpoints to the given client.<br/>Return Type: <b></b><br/><br/>
+    # @param client_id [String] The client Id
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :expand Indicates the related entities to be represented inline. The maximum depth is 2.
+    # @option opts [String] :select Limits the properties returned in the result.
+    # @option opts [ClientAppEndpoint] :client_app_endpoint 
+    # @return [nil]
+    def id20_client_applications_client_id_endpoints_post(client_id, opts = {})
+      id20_client_applications_client_id_endpoints_post_with_http_info(client_id, opts)
+      nil
+    end
+
+    # Adds an Endpoints to the given client
+    # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Adds an Endpoints to the given client.&lt;br/&gt;Return Type: &lt;b&gt;&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
+    # @param client_id [String] The client Id
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :expand Indicates the related entities to be represented inline. The maximum depth is 2.
+    # @option opts [String] :select Limits the properties returned in the result.
+    # @option opts [ClientAppEndpoint] :client_app_endpoint 
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def id20_client_applications_client_id_endpoints_post_with_http_info(client_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ClientApplicationsApi.id20_client_applications_client_id_endpoints_post ...'
+      end
+      # resource path
+      local_var_path = '/id/2.0/ClientApplications({clientId})/Endpoints'.sub('{' + 'clientId' + '}', CGI.escape(client_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
+      query_params[:'$select'] = opts[:'select'] if !opts[:'select'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json', 'application/xml', 'text/json', 'application/*+json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'client_app_endpoint'])
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"ClientApplicationsApi.id20_client_applications_client_id_endpoints_post",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ClientApplicationsApi#id20_client_applications_client_id_endpoints_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Gets the specified Client Application by its client id
+    # <span style='font-size: 17px;'>Summary:</span>Gets the specified Client Application by its client id.<br/>Return Type: <b>ClientApp</b><br/><br/>
+    # @param client_id [String] The client Id.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :expand Indicates the related entities to be represented inline. The maximum depth is 5.
+    # @option opts [String] :select Limits the properties returned in the result.
+    # @return [ClientApp]
+    def id20_client_applications_client_id_get(client_id, opts = {})
+      data, _status_code, _headers = id20_client_applications_client_id_get_with_http_info(client_id, opts)
+      data
+    end
+
+    # Gets the specified Client Application by its client id
+    # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Gets the specified Client Application by its client id.&lt;br/&gt;Return Type: &lt;b&gt;ClientApp&lt;/b&gt;&lt;br/&gt;&lt;br/&gt;
+    # @param client_id [String] The client Id.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :expand Indicates the related entities to be represented inline. The maximum depth is 5.
+    # @option opts [String] :select Limits the properties returned in the result.
+    # @return [Array<(ClientApp, Integer, Hash)>] ClientApp data, response status code and response headers
+    def id20_client_applications_client_id_get_with_http_info(client_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ClientApplicationsApi.id20_client_applications_client_id_get ...'
+      end
+      # resource path
+      local_var_path = '/id/2.0/ClientApplications({clientId})'.sub('{' + 'clientId' + '}', CGI.escape(client_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
+      query_params[:'$select'] = opts[:'select'] if !opts[:'select'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ClientApp'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"ClientApplicationsApi.id20_client_applications_client_id_get",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ClientApplicationsApi#id20_client_applications_client_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Operations to query a set of data
+    # <span style='font-size: 17px;'>Summary:</span>Operations to query a set of data.<br/>Queries support: $filter, $orderby, $select, $expand(including nested filters, selects and expands), $top, $skip.<br/>Return Type: <b>ODataClientAppList</b><br/>For more information about OData responses <a href='https://www.odata.org/getting-started/understand-odata-in-6-steps/'>link</a>.<br/><br/>
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :expand Indicates the related entities to be represented inline. The maximum depth is 5.
+    # @option opts [String] :filter Restricts the set of items returned. The maximum number of expressions is 1000. The allowed functions are: allfunctions.
+    # @option opts [String] :select Limits the properties returned in the result.
+    # @option opts [String] :orderby Specifies the order in which items are returned. The maximum number of expressions is 5.
+    # @option opts [Integer] :top Limits the number of items returned from a collection. The maximum value is 1000.
+    # @option opts [Integer] :skip Excludes the specified number of items of the queried collection from the result.
+    # @option opts [Boolean] :count Indicates whether the total count of items within a collection are returned in the result.
+    # @return [ODataClientAppList]
+    def id20_client_applications_get(opts = {})
+      data, _status_code, _headers = id20_client_applications_get_with_http_info(opts)
+      data
+    end
+
+    # Operations to query a set of data
+    # &lt;span style&#x3D;&#39;font-size: 17px;&#39;&gt;Summary:&lt;/span&gt;Operations to query a set of data.&lt;br/&gt;Queries support: $filter, $orderby, $select, $expand(including nested filters, selects and expands), $top, $skip.&lt;br/&gt;Return Type: &lt;b&gt;ODataClientAppList&lt;/b&gt;&lt;br/&gt;For more information about OData responses &lt;a href&#x3D;&#39;https://www.odata.org/getting-started/understand-odata-in-6-steps/&#39;&gt;link&lt;/a&gt;.&lt;br/&gt;&lt;br/&gt;
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :expand Indicates the related entities to be represented inline. The maximum depth is 5.
+    # @option opts [String] :filter Restricts the set of items returned. The maximum number of expressions is 1000. The allowed functions are: allfunctions.
+    # @option opts [String] :select Limits the properties returned in the result.
+    # @option opts [String] :orderby Specifies the order in which items are returned. The maximum number of expressions is 5.
+    # @option opts [Integer] :top Limits the number of items returned from a collection. The maximum value is 1000.
+    # @option opts [Integer] :skip Excludes the specified number of items of the queried collection from the result.
+    # @option opts [Boolean] :count Indicates whether the total count of items within a collection are returned in the result.
+    # @return [Array<(ODataClientAppList, Integer, Hash)>] ODataClientAppList data, response status code and response headers
+    def id20_client_applications_get_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ClientApplicationsApi.id20_client_applications_get ...'
+      end
+      # resource path
+      local_var_path = '/id/2.0/ClientApplications'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'$expand'] = opts[:'expand'] if !opts[:'expand'].nil?
+      query_params[:'$filter'] = opts[:'filter'] if !opts[:'filter'].nil?
+      query_params[:'$select'] = opts[:'select'] if !opts[:'select'].nil?
+      query_params[:'$orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
+      query_params[:'$top'] = opts[:'top'] if !opts[:'top'].nil?
+      query_params[:'$skip'] = opts[:'skip'] if !opts[:'skip'].nil?
+      query_params[:'$count'] = opts[:'count'] if !opts[:'count'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ODataClientAppList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"ClientApplicationsApi.id20_client_applications_get",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ClientApplicationsApi#id20_client_applications_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end