trinsic_api 2.2.0 → 2.3.0.pre.alpha1

data/docs/VerificationProfilesApi.md

@@ -0,0 +1,231 @@
+# TrinsicApi::VerificationProfilesApi
+
+All URIs are relative to *https://api.trinsic.id*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_verification_profile**](VerificationProfilesApi.md#create_verification_profile) | **POST** /api/valpha/verification-profiles | Create Verification Profile |
+| [**get_verification_profile_by_id**](VerificationProfilesApi.md#get_verification_profile_by_id) | **GET** /api/valpha/verification-profiles/{id} | Get Verification Profile |
+| [**list_verification_profiles**](VerificationProfilesApi.md#list_verification_profiles) | **GET** /api/valpha/verification-profiles | List Verification Profiles |
+
+
+## create_verification_profile
+
+> <CreateVerificationProfileResponse> create_verification_profile(_alias, brand_name, opts)
+
+Create Verification Profile
+
+Creates a new verification profile within your organization.
+
+### Examples
+
+```ruby
+require 'time'
+require 'trinsic_api'
+# setup authorization
+TrinsicApi.configure do |config|
+  # Configure Bearer authorization: Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = TrinsicApi::VerificationProfilesApi.new
+_alias = '_alias_example' # String | An alias of the verification profile shown to developers and administrators.
+brand_name = 'brand_name_example' # String | The brand name of the verification profile shown to end-users.
+opts = {
+  primary_color: 'primary_color_example', # String | The primary color of the verification profile. Must be a 6-character hex string prefixed with a '#' character. Example: #000000
+  providers: ['inner_example'], # Array<String> | The list of providers you'd like to select for this profile. We will not currently enable any providers.
+  logo: File.new('/path/to/some/file') # File | The logo of the verification profile.
+}
+
+begin
+  # Create Verification Profile
+  result = api_instance.create_verification_profile(_alias, brand_name, opts)
+  p result
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling VerificationProfilesApi->create_verification_profile: #{e}"
+end
+```
+
+#### Using the create_verification_profile_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateVerificationProfileResponse>, Integer, Hash)> create_verification_profile_with_http_info(_alias, brand_name, opts)
+
+```ruby
+begin
+  # Create Verification Profile
+  data, status_code, headers = api_instance.create_verification_profile_with_http_info(_alias, brand_name, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateVerificationProfileResponse>
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling VerificationProfilesApi->create_verification_profile_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_alias** | **String** | An alias of the verification profile shown to developers and administrators. |  |
+| **brand_name** | **String** | The brand name of the verification profile shown to end-users. |  |
+| **primary_color** | **String** | The primary color of the verification profile. Must be a 6-character hex string prefixed with a &#39;#&#39; character. Example: #000000 | [optional] |
+| **providers** | [**Array&lt;String&gt;**](String.md) | The list of providers you&#39;d like to select for this profile. We will not currently enable any providers. | [optional] |
+| **logo** | **File** | The logo of the verification profile. | [optional] |
+
+### Return type
+
+[**CreateVerificationProfileResponse**](CreateVerificationProfileResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: multipart/form-data
+- **Accept**: text/plain, application/json, text/json, application/problem+json
+
+
+## get_verification_profile_by_id
+
+> <VerificationProfileResponse> get_verification_profile_by_id(id)
+
+Get Verification Profile
+
+Gets a specific verification profile by ID.
+
+### Examples
+
+```ruby
+require 'time'
+require 'trinsic_api'
+# setup authorization
+TrinsicApi.configure do |config|
+  # Configure Bearer authorization: Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = TrinsicApi::VerificationProfilesApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+
+begin
+  # Get Verification Profile
+  result = api_instance.get_verification_profile_by_id(id)
+  p result
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling VerificationProfilesApi->get_verification_profile_by_id: #{e}"
+end
+```
+
+#### Using the get_verification_profile_by_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<VerificationProfileResponse>, Integer, Hash)> get_verification_profile_by_id_with_http_info(id)
+
+```ruby
+begin
+  # Get Verification Profile
+  data, status_code, headers = api_instance.get_verification_profile_by_id_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <VerificationProfileResponse>
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling VerificationProfilesApi->get_verification_profile_by_id_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**VerificationProfileResponse**](VerificationProfileResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain, application/json, text/json, application/problem+json
+
+
+## list_verification_profiles
+
+> <ListVerificationProfilesResponse> list_verification_profiles(opts)
+
+List Verification Profiles
+
+List the verification profiles for the current organization and environment.
+
+### Examples
+
+```ruby
+require 'time'
+require 'trinsic_api'
+# setup authorization
+TrinsicApi.configure do |config|
+  # Configure Bearer authorization: Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = TrinsicApi::VerificationProfilesApi.new
+opts = {
+  page: 56, # Integer | 
+  page_size: 56 # Integer | Size of the list to be returned. Accepted range from 1 to 100
+}
+
+begin
+  # List Verification Profiles
+  result = api_instance.list_verification_profiles(opts)
+  p result
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling VerificationProfilesApi->list_verification_profiles: #{e}"
+end
+```
+
+#### Using the list_verification_profiles_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListVerificationProfilesResponse>, Integer, Hash)> list_verification_profiles_with_http_info(opts)
+
+```ruby
+begin
+  # List Verification Profiles
+  data, status_code, headers = api_instance.list_verification_profiles_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListVerificationProfilesResponse>
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling VerificationProfilesApi->list_verification_profiles_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** |  | [optional][default to 1] |
+| **page_size** | **Integer** | Size of the list to be returned. Accepted range from 1 to 100 | [optional][default to 20] |
+
+### Return type
+
+[**ListVerificationProfilesResponse**](ListVerificationProfilesResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain, application/json, text/json, application/problem+json
+

data/lib/trinsic_api/api/environment_redirect_uris_api.rb

@@ -0,0 +1,228 @@
+=begin
+#Trinsic API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: v1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.13.0
+
+=end
+
+require 'cgi'
+
+module TrinsicApi
+  class EnvironmentRedirectUrisApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Add Redirect URI
+    # Add a new redirect uri to the environment.
+    # @param [Hash] opts the optional parameters
+    # @option opts [EnvironmentRedirectUrisAddRequest] :environment_redirect_uris_add_request Request for uri to add to the environment. Must be absolute, not relative. Wildcard \"*\" accepted.
+    # @return [AddRedirectUriResponse]
+    def add(opts = {})
+      data, _status_code, _headers = add_with_http_info(opts)
+      data
+    end
+
+    # Add Redirect URI
+    # Add a new redirect uri to the environment.
+    # @param [Hash] opts the optional parameters
+    # @option opts [EnvironmentRedirectUrisAddRequest] :environment_redirect_uris_add_request Request for uri to add to the environment. Must be absolute, not relative. Wildcard \"*\" accepted.
+    # @return [Array<(AddRedirectUriResponse, Integer, Hash)>] AddRedirectUriResponse data, response status code and response headers
+    def add_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EnvironmentRedirectUrisApi.add ...'
+      end
+      # resource path
+      local_var_path = '/api/valpha/environments/redirect-uris'
+
+      # 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(['text/plain', 'application/json', 'text/json', 'application/problem+json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json', '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[:'environment_redirect_uris_add_request'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AddRedirectUriResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['Bearer']
+
+      new_options = opts.merge(
+        :operation => :"EnvironmentRedirectUrisApi.add",
+        :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: EnvironmentRedirectUrisApi#add\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete Redirect URI
+    # Delete a redirect uri from the environment.
+    # @param id [String] The id of the redirect uri to delete.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete(id, opts = {})
+      delete_with_http_info(id, opts)
+      nil
+    end
+
+    # Delete Redirect URI
+    # Delete a redirect uri from the environment.
+    # @param id [String] The id of the redirect uri to delete.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EnvironmentRedirectUrisApi.delete ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling EnvironmentRedirectUrisApi.delete"
+      end
+      # resource path
+      local_var_path = '/api/valpha/environments/redirect-uris/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # 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/problem+json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['Bearer']
+
+      new_options = opts.merge(
+        :operation => :"EnvironmentRedirectUrisApi.delete",
+        :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(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EnvironmentRedirectUrisApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List Redirect URIs
+    # List redirect URIs within the environment.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Number of pages of uris to return. (default to 1)
+    # @option opts [Integer] :page_size Size of the list to be returned. Accepted range from 1 to 100 (default to 20)
+    # @return [ListEnvironmentRedirectUrisResponse]
+    def list(opts = {})
+      data, _status_code, _headers = list_with_http_info(opts)
+      data
+    end
+
+    # List Redirect URIs
+    # List redirect URIs within the environment.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Number of pages of uris to return. (default to 1)
+    # @option opts [Integer] :page_size Size of the list to be returned. Accepted range from 1 to 100 (default to 20)
+    # @return [Array<(ListEnvironmentRedirectUrisResponse, Integer, Hash)>] ListEnvironmentRedirectUrisResponse data, response status code and response headers
+    def list_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EnvironmentRedirectUrisApi.list ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] > 2147483647
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling EnvironmentRedirectUrisApi.list, must be smaller than or equal to 2147483647.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling EnvironmentRedirectUrisApi.list, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling EnvironmentRedirectUrisApi.list, must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling EnvironmentRedirectUrisApi.list, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/api/valpha/environments/redirect-uris'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/problem+json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ListEnvironmentRedirectUrisResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['Bearer']
+
+      new_options = opts.merge(
+        :operation => :"EnvironmentRedirectUrisApi.list",
+        :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: EnvironmentRedirectUrisApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end