cybrid_api_organization_ruby 0.57.31 → 0.57.33
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +4 -4
- data/README.md +5 -5
- data/cybrid_api_organization_ruby.gemspec +1 -1
- data/lib/cybrid_api_organization_ruby/api/organizations_organization_api.rb +1 -1
- data/lib/cybrid_api_organization_ruby/api_client.rb +1 -1
- data/lib/cybrid_api_organization_ruby/api_error.rb +1 -1
- data/lib/cybrid_api_organization_ruby/configuration.rb +1 -1
- data/lib/cybrid_api_organization_ruby/models/error_response_organization_model.rb +1 -1
- data/lib/cybrid_api_organization_ruby/models/organization_organization_model.rb +1 -1
- data/lib/cybrid_api_organization_ruby/models/patch_organization_organization_model.rb +1 -1
- data/lib/cybrid_api_organization_ruby/version.rb +2 -2
- data/lib/cybrid_api_organization_ruby.rb +1 -1
- data/spec/api/organizations_organization_api_spec.rb +1 -1
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/error_response_organization_model_spec.rb +1 -1
- data/spec/models/organization_organization_model_spec.rb +1 -1
- data/spec/models/patch_organization_organization_model_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- data/vendor/bundle/ruby/3.1.0/cache/pry-0.14.2.gem +0 -0
- data/vendor/bundle/ruby/3.1.0/cache/rspec-expectations-3.12.2.gem +0 -0
- data/vendor/bundle/ruby/3.1.0/cache/rspec-mocks-3.12.2.gem +0 -0
- data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0/byebug-11.1.3/gem_make.out +4 -4
- data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0/ffi-1.15.5/gem_make.out +4 -4
- data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0/jaro_winkler-1.5.4/gem_make.out +4 -4
- data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0/psych-5.0.1/gem_make.out +4 -4
- data/vendor/bundle/ruby/3.1.0/extensions/x86_64-linux/3.1.0/stringio-3.0.4/gem_make.out +4 -4
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/CHANGELOG.md +31 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/LICENSE +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/README.md +36 -22
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/bin/pry +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/basic_object.rb +1 -1
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/block_command.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/class_command.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/cli.rb +2 -2
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/code/code_file.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/code/code_range.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/code/loc.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/code.rb +0 -8
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/code_object.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/color_printer.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/command.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/command_set.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/command_state.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/amend_line.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/bang.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/bang_pry.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/cat/abstract_formatter.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/cat/exception_formatter.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/cat/file_formatter.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/cat/input_expression_formatter.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/cat.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/cd.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/change_inspector.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/change_prompt.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/clear_screen.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/code_collector.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/disable_pry.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/easter_eggs.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/edit/exception_patcher.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/edit/file_and_line_locator.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/edit.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/exit.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/exit_all.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/exit_program.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/find_method.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/fix_indent.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/help.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/hist.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/import_set.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/jump_to.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/list_inspectors.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/ls/constants.rb +2 -2
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/ls/formatter.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/ls/globals.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/ls/grep.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/ls/instance_vars.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/ls/interrogatable.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/ls/jruby_hacks.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/ls/local_names.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/ls/local_vars.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/ls/ls_entity.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/ls/methods.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/ls/methods_helper.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/ls/self_methods.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/ls.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/nesting.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/play.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/pry_backtrace.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/pry_version.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/raise_up.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/reload_code.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/reset.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/ri.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/save_file.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/shell_command.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/shell_mode.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/show_doc.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/show_info.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/show_input.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/show_source.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/stat.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/switch_to.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/toggle_color.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/watch_expression/expression.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/watch_expression.rb +1 -1
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/whereami.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/commands/wtf.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/config/attributable.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/config/lazy_value.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/config/memoized_value.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/config/value.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/config.rb +8 -11
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/control_d_handler.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/core_extensions.rb +1 -1
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/editor.rb +3 -1
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/env.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/exception_handler.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/exceptions.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/forwardable.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/helpers/base_helpers.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/helpers/command_helpers.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/helpers/documentation_helpers.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/helpers/options_helpers.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/helpers/platform.rb +1 -6
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/helpers/table.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/helpers/text.rb +5 -5
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/helpers.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/history.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/hooks.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/indent.rb +7 -7
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/input_completer.rb +1 -1
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/input_lock.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/inspector.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/last_exception.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/method/disowned.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/method/patcher.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/method/weird_method_locator.rb +1 -1
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/method.rb +3 -2
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/object_path.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/output.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/pager.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/prompt.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/pry_class.rb +14 -1
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/pry_instance.rb +1 -1
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/repl.rb +1 -2
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/repl_file_loader.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/ring.rb +1 -1
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/slop/LICENSE +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/slop/commands.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/slop/option.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/slop.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/syntax_highlighter.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/system_command_handler.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/testable/evalable.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/testable/mockable.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/testable/pry_tester.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/testable/utility.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/testable/variables.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/testable.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/version.rb +1 -1
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/warning.rb +3 -10
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/wrapped_module/candidate.rb +9 -8
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry/wrapped_module.rb +2 -7
- data/vendor/bundle/ruby/3.1.0/gems/{pry-0.14.1 → pry-0.14.2}/lib/pry.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/.document +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/.yardopts +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/Changelog.md +8 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/LICENSE.md +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/README.md +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/expectations/block_snippet_extractor.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/expectations/configuration.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/expectations/expectation_target.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/expectations/fail_with.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/expectations/failure_aggregator.rb +1 -1
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/expectations/handler.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/expectations/minitest_integration.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/expectations/syntax.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/expectations/version.rb +1 -1
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/expectations.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/matchers/aliased_matcher.rb +3 -3
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/matchers/built_in/all.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/matchers/built_in/base_matcher.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/matchers/built_in/be.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/matchers/built_in/be_between.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/matchers/built_in/be_instance_of.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/matchers/built_in/be_kind_of.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/matchers/built_in/be_within.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/matchers/built_in/change.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/matchers/built_in/compound.rb +1 -1
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/matchers/built_in/contain_exactly.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/matchers/built_in/count_expectation.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/matchers/built_in/cover.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/matchers/built_in/eq.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/matchers/built_in/eql.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/matchers/built_in/equal.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/matchers/built_in/exist.rb +1 -1
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/matchers/built_in/has.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/matchers/built_in/have_attributes.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/matchers/built_in/include.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/matchers/built_in/match.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/matchers/built_in/operators.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/matchers/built_in/output.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/matchers/built_in/raise_error.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/matchers/built_in/respond_to.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/matchers/built_in/satisfy.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/matchers/built_in/start_or_end_with.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/matchers/built_in/throw_symbol.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/matchers/built_in/yield.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/matchers/built_in.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/matchers/composable.rb +1 -1
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/matchers/dsl.rb +7 -7
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/matchers/english_phrasing.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/matchers/expecteds_for_multiple_diffs.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/matchers/fail_matchers.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/matchers/generated_descriptions.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/matchers/matcher_delegator.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/matchers/matcher_protocol.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-expectations-3.12.1 → rspec-expectations-3.12.2}/lib/rspec/matchers.rb +1 -1
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/.document +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/.yardopts +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/Changelog.md +10 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/LICENSE.md +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/README.md +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/lib/rspec/mocks/any_instance/chain.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/lib/rspec/mocks/any_instance/error_generator.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/lib/rspec/mocks/any_instance/expect_chain_chain.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/lib/rspec/mocks/any_instance/expectation_chain.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/lib/rspec/mocks/any_instance/message_chains.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/lib/rspec/mocks/any_instance/proxy.rb +1 -1
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/lib/rspec/mocks/any_instance/recorder.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/lib/rspec/mocks/any_instance/stub_chain.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/lib/rspec/mocks/any_instance/stub_chain_chain.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/lib/rspec/mocks/any_instance.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/lib/rspec/mocks/argument_list_matcher.rb +3 -1
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/lib/rspec/mocks/argument_matchers.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/lib/rspec/mocks/configuration.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/lib/rspec/mocks/error_generator.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/lib/rspec/mocks/example_methods.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/lib/rspec/mocks/instance_method_stasher.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/lib/rspec/mocks/marshal_extension.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/lib/rspec/mocks/matchers/expectation_customization.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/lib/rspec/mocks/matchers/have_received.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/lib/rspec/mocks/matchers/receive.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/lib/rspec/mocks/matchers/receive_message_chain.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/lib/rspec/mocks/matchers/receive_messages.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/lib/rspec/mocks/message_chain.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/lib/rspec/mocks/message_expectation.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/lib/rspec/mocks/method_double.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/lib/rspec/mocks/method_reference.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/lib/rspec/mocks/minitest_integration.rb +1 -1
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/lib/rspec/mocks/mutate_const.rb +1 -1
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/lib/rspec/mocks/object_reference.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/lib/rspec/mocks/order_group.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/lib/rspec/mocks/proxy.rb +1 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/lib/rspec/mocks/space.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/lib/rspec/mocks/standalone.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/lib/rspec/mocks/syntax.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/lib/rspec/mocks/targets.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/lib/rspec/mocks/test_double.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/lib/rspec/mocks/verifying_double.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/lib/rspec/mocks/verifying_message_expectation.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/lib/rspec/mocks/verifying_proxy.rb +4 -3
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/lib/rspec/mocks/version.rb +1 -1
- data/vendor/bundle/ruby/3.1.0/gems/{rspec-mocks-3.12.1 → rspec-mocks-3.12.2}/lib/rspec/mocks.rb +0 -0
- data/vendor/bundle/ruby/3.1.0/specifications/{pry-0.14.1.gemspec → pry-0.14.2.gemspec} +4 -4
- data/vendor/bundle/ruby/3.1.0/specifications/{rspec-expectations-3.12.1.gemspec → rspec-expectations-3.12.2.gemspec} +5 -5
- data/vendor/bundle/ruby/3.1.0/specifications/{rspec-mocks-3.12.1.gemspec → rspec-mocks-3.12.2.gemspec} +5 -5
- metadata +246 -246
- data/vendor/bundle/ruby/3.1.0/cache/pry-0.14.1.gem +0 -0
- data/vendor/bundle/ruby/3.1.0/cache/rspec-expectations-3.12.1.gem +0 -0
- data/vendor/bundle/ruby/3.1.0/cache/rspec-mocks-3.12.1.gem +0 -0
data/spec/api_client_spec.rb
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
## Cybrid API documentation Welcome to Cybrid, an all-in-one crypto platform that enables you to easily **build** and **launch** white-label crypto products or services. In these documents, you'll find details on how our REST API operates and generally how our platform functions. If you're looking for our UI SDK Widgets for Web or Mobile (iOS/Android), generated API clients, or demo applications, head over to our [Github repo](https://github.com/Cybrid-app). 💡 We recommend bookmarking the [Cybrid LinkTree](https://linktr.ee/cybridtechnologies) which contains many helpful links to platform resources. ## Getting Started This is Cybrid's public interactive API documentation, which allows you to fully test our APIs. If you'd like to use a different tool to exercise our APIs, you can download the [Open API 3.0 yaml](https://bank.demo.cybrid.app/api/schema/v1/swagger.yaml) for import. If you're new to our APIs and the Cybrid Platform, follow the below guides to get set up and familiar with the platform: 1. [Getting Started in the Cybrid Sandbox](https://www.cybrid.xyz/guides/getting-started) 2. [Getting Ready for Trading](https://www.cybrid.xyz/guides/getting-ready-for-trading) 3. [Running the Web Demo App](https://www.cybrid.xyz/guides/running-the-cybrid-web-demo-crypto-app) (or, alternatively, [Testing with Hosted Web Demo App](https://www.cybrid.xyz/guides/testing-with-the-web-demo-crypo-app)) In [Getting Started in the Cybrid Sandbox](https://www.cybrid.xyz/guides/getting-started), we walk you through how to use the [Cybrid Sandbox](https://id.demo.cybrid.app/) to create a test bank, generate API keys, and set banks fees. In [Getting Ready for Trading](https://www.cybrid.xyz/guides/getting-ready-for-trading), we walk through creating customers, customer identities, accounts, as well as executing quotes and trades. If you've already run through the first two guides, you can follow the [Running the Web Demo App](https://www.cybrid.xyz/guides/running-the-cybrid-web-demo-crypto-app) guide to test our web SDK with your sandbox `bank` and `customer`. ## Working with the Cybrid Platform There are three primary ways you can interact with the Cybrid platform: 1. Directly via our RESTful API (this documentation) 2. Using our API clients available in a variety of languages ([Angular](https://github.com/Cybrid-app/cybrid-api-bank-angular), [Java](https://github.com/Cybrid-app/cybrid-api-bank-java), [Kotlin](https://github.com/Cybrid-app/cybrid-api-bank-kotlin), [Python](https://github.com/Cybrid-app/cybrid-api-bank-python), [Ruby](https://github.com/Cybrid-app/cybrid-api-bank-ruby), [Swift](https://github.com/Cybrid-app/cybrid-api-bank-swift) or [Typescript](https://github.com/Cybrid-app/cybrid-api-bank-typescript)) 3. Integrating a platform specific SDK ([Web](https://github.com/Cybrid-app/cybrid-sdk-web), [Android](https://github.com/Cybrid-app/cybrid-sdk-android), [iOS](https://github.com/Cybrid-app/cybrid-sdk-ios)) Our complete set of APIs allows you to manage resources across three distinct areas: your `Organization`, your `Banks` and your `Identities`. For most of your testing and interaction you'll be using the `Bank` API, which is where the majority of APIs reside. *The complete set of APIs can be found on the following pages:* | API | Description | |------------------------------------------------------------------|-------------------------------------------------------------| | [Organization API](https://organization.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage organization and bank identities | For questions please contact [Support](mailto:support@cybrid.xyz) at any time for assistance, or contact the [Product Team](mailto:product@cybrid.xyz) for product suggestions. ## Authenticating with the API The Cybrid Platform uses OAuth 2.0 Bearer Tokens to authenticate requests to the platform. Credentials to create `Organization` and `Bank` tokens can be generated via the [Cybrid Sandbox](https://id.demo.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.demo.cybrid.app) as well. An `Organization` access token applies broadly to the whole Organization and all of its `Banks`, whereas, a `Bank` access token is specific to an individual Bank. `Customer` tokens, similarly, are scoped to a specific customer in a bank. Both `Organization` and `Bank` tokens can be created using the OAuth Client Credential Grant flow. Each Organization and Bank has its own unique `Client ID` and `Secret` that allows for machine-to-machine authentication. A `Bank` can then generate `Customer` access tokens via API using our [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui). <font color=\"orange\">**⚠️ Never share your Client ID or Secret publicly or in your source code repository.**</font> Your `Client ID` and `Secret` can be exchanged for a time-limited `Bearer Token` by interacting with the Cybrid Identity Provider or through interacting with the **Authorize** button in this document. The following curl command can be used to quickly generate a `Bearer Token` for use in testing the API or demo applications. ``` curl -X POST https://id.demo.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"banks:read banks:write accounts:read accounts:execute customers:read customers:write customers:execute prices:read quotes:execute trades:execute trades:read\" }' -H \"Content-Type: application/json\" ``` <font color=\"orange\">**⚠️ Note: The above curl will create a bearer token with full scope access. Delete scopes if you'd like to restrict access.**</font> ## Authentication Scopes The Cybrid platform supports the use of scopes to control the level of access a token is limited to. Scopes do not grant access to resources; instead, they provide limits, in support of the least privilege principal. The following scopes are available on the platform and can be requested when generating either an Organization, Bank or Customer token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource. | Resource | Read scope (Token Type) | Write scope (Token Type) | Execute scope (Token Type) | |------------------------|------------------------------------------------------------|-----------------------------------------------|-------------------------------------------------| | Organizations | organizations:read (Organization) | organizations:write (Organization) | | | Banks | banks:read (Organization, Bank) | banks:write (Organization, Bank) | banks:execute (Organization) | | Customers | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) | | Accounts | accounts:read (Organization, Bank, Customer) | | accounts:execute (Bank, Customer) | | Prices | prices:read (Bank, Customer) | | | | Quotes | quotes:read (Organization, Bank, Customer) | | quotes:execute (Bank, Customer) | | Trades | trades:read (Organization, Bank, Customer) | | trades:execute (Bank, Customer) | | Rewards | rewards:read (Bank, Customer) | | rewards:execute (Bank) | | External bank accounts | external_bank_accounts:read (Organization, Bank, Customer) | external_bank_accounts:write (Bank, Customer) | external_bank_accounts:execute (Bank, Customer) | | Workflows | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | | Transfers | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.demo.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.demo.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.demo.cybrid.app/api/schema/swagger-ui) API services are listed below: | API Service | Model | API Endpoint Path | Description | |--------------|----------------------|--------------------------------|---------------------------------------------------------------------------------------------------| | Identity | Bank | /api/bank_applications | Create and list banks | | Identity | Organization | /api/organization_applications | Create and list organizations | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Organization | Organization | /api/organizations | APIs to retrieve and update organization name | | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) | | Bank | VerificationKey | /api/bank_verification_keys | Create, list and retrive verification keys, used for signing identities | | Bank | Banks | /api/banks | Create, update and list banks, the parent to customers, accounts, etc | | Bank | FeeConfiguration | /api/fee_configurations | Create and list bank fees (spread or fixed) | | Bank | Customers | /api/customers | Create and list customers | | Bank | IdentityRecord | /api/identity_records | Create and list identity records, which are attached to customers for KYC | | Bank | Accounts | /api/accounts | Create and list accounts, which hold a specific asset for a customers | | Bank | Symbols | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) | | Bank | Prices | /api/prices | Get the current prices for assets on the platform | | Bank | Quotes | /api/quotes | Create and list quotes, which are required to execute trades | | Bank | Trades | /api/trades | Create and list trades, which buy or sell cryptocurrency | | Bank | Rewards | /api/rewards | Create a new reward (automates quote/trade for simplicity) | | Bank | ExternalBankAccounts | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform | | Bank | Workflows | /api/workflows | Create, get and list workflows | | Bank | Transfers | /api/transfers | Create, get and list transfers (e.g., funding, book) | ## Understanding Object Models & Endpoints **Organizations** An `Organization` is meant to represent the organization partnering with Cybrid to use our platform. An `Organization` does not directly interact with `customers`. Instead, an Organization has one or more `banks`, which encompass the financial service offerings of the platform. **Banks** A `Bank` is owned by an `Organization` and can be thought of as an environment or container for `customers` and product offerings. Banks are created in either `Sandbox` or `Production` mode, where `Sandbox` is the environment that you would test, prototype and build in prior to moving to `Production`. An `Organization` can have multiple `banks`, in either `Sandbox` or `Production` environments. A `Sandbox Bank` will be backed by stubbed data and process flows. For instance, funding source transfer processes as well as trades will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amount of simulated fiat currency for testing purposes. **Customers** `Customers` represent your banking users on the platform. At present, we offer support for `Individuals` as Customers. `Customers` must be verified (i.e., KYC'd) in our system before they can play any part on the platform, which means they must have an associated and valid `Identity Record`. See the Identity Records section for more details on how a customer can be verified. `Customers` must also have an `Account` to be able to transact, in the desired asset class. See the Accounts APIs for more details on setting up accounts for the customer.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: v0.57.
|
6
|
+
The version of the OpenAPI document: v0.57.33
|
7
7
|
Contact: support@cybrid.app
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 6.0.0
|
data/spec/configuration_spec.rb
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
## Cybrid API documentation Welcome to Cybrid, an all-in-one crypto platform that enables you to easily **build** and **launch** white-label crypto products or services. In these documents, you'll find details on how our REST API operates and generally how our platform functions. If you're looking for our UI SDK Widgets for Web or Mobile (iOS/Android), generated API clients, or demo applications, head over to our [Github repo](https://github.com/Cybrid-app). 💡 We recommend bookmarking the [Cybrid LinkTree](https://linktr.ee/cybridtechnologies) which contains many helpful links to platform resources. ## Getting Started This is Cybrid's public interactive API documentation, which allows you to fully test our APIs. If you'd like to use a different tool to exercise our APIs, you can download the [Open API 3.0 yaml](https://bank.demo.cybrid.app/api/schema/v1/swagger.yaml) for import. If you're new to our APIs and the Cybrid Platform, follow the below guides to get set up and familiar with the platform: 1. [Getting Started in the Cybrid Sandbox](https://www.cybrid.xyz/guides/getting-started) 2. [Getting Ready for Trading](https://www.cybrid.xyz/guides/getting-ready-for-trading) 3. [Running the Web Demo App](https://www.cybrid.xyz/guides/running-the-cybrid-web-demo-crypto-app) (or, alternatively, [Testing with Hosted Web Demo App](https://www.cybrid.xyz/guides/testing-with-the-web-demo-crypo-app)) In [Getting Started in the Cybrid Sandbox](https://www.cybrid.xyz/guides/getting-started), we walk you through how to use the [Cybrid Sandbox](https://id.demo.cybrid.app/) to create a test bank, generate API keys, and set banks fees. In [Getting Ready for Trading](https://www.cybrid.xyz/guides/getting-ready-for-trading), we walk through creating customers, customer identities, accounts, as well as executing quotes and trades. If you've already run through the first two guides, you can follow the [Running the Web Demo App](https://www.cybrid.xyz/guides/running-the-cybrid-web-demo-crypto-app) guide to test our web SDK with your sandbox `bank` and `customer`. ## Working with the Cybrid Platform There are three primary ways you can interact with the Cybrid platform: 1. Directly via our RESTful API (this documentation) 2. Using our API clients available in a variety of languages ([Angular](https://github.com/Cybrid-app/cybrid-api-bank-angular), [Java](https://github.com/Cybrid-app/cybrid-api-bank-java), [Kotlin](https://github.com/Cybrid-app/cybrid-api-bank-kotlin), [Python](https://github.com/Cybrid-app/cybrid-api-bank-python), [Ruby](https://github.com/Cybrid-app/cybrid-api-bank-ruby), [Swift](https://github.com/Cybrid-app/cybrid-api-bank-swift) or [Typescript](https://github.com/Cybrid-app/cybrid-api-bank-typescript)) 3. Integrating a platform specific SDK ([Web](https://github.com/Cybrid-app/cybrid-sdk-web), [Android](https://github.com/Cybrid-app/cybrid-sdk-android), [iOS](https://github.com/Cybrid-app/cybrid-sdk-ios)) Our complete set of APIs allows you to manage resources across three distinct areas: your `Organization`, your `Banks` and your `Identities`. For most of your testing and interaction you'll be using the `Bank` API, which is where the majority of APIs reside. *The complete set of APIs can be found on the following pages:* | API | Description | |------------------------------------------------------------------|-------------------------------------------------------------| | [Organization API](https://organization.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage organization and bank identities | For questions please contact [Support](mailto:support@cybrid.xyz) at any time for assistance, or contact the [Product Team](mailto:product@cybrid.xyz) for product suggestions. ## Authenticating with the API The Cybrid Platform uses OAuth 2.0 Bearer Tokens to authenticate requests to the platform. Credentials to create `Organization` and `Bank` tokens can be generated via the [Cybrid Sandbox](https://id.demo.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.demo.cybrid.app) as well. An `Organization` access token applies broadly to the whole Organization and all of its `Banks`, whereas, a `Bank` access token is specific to an individual Bank. `Customer` tokens, similarly, are scoped to a specific customer in a bank. Both `Organization` and `Bank` tokens can be created using the OAuth Client Credential Grant flow. Each Organization and Bank has its own unique `Client ID` and `Secret` that allows for machine-to-machine authentication. A `Bank` can then generate `Customer` access tokens via API using our [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui). <font color=\"orange\">**⚠️ Never share your Client ID or Secret publicly or in your source code repository.**</font> Your `Client ID` and `Secret` can be exchanged for a time-limited `Bearer Token` by interacting with the Cybrid Identity Provider or through interacting with the **Authorize** button in this document. The following curl command can be used to quickly generate a `Bearer Token` for use in testing the API or demo applications. ``` curl -X POST https://id.demo.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"banks:read banks:write accounts:read accounts:execute customers:read customers:write customers:execute prices:read quotes:execute trades:execute trades:read\" }' -H \"Content-Type: application/json\" ``` <font color=\"orange\">**⚠️ Note: The above curl will create a bearer token with full scope access. Delete scopes if you'd like to restrict access.**</font> ## Authentication Scopes The Cybrid platform supports the use of scopes to control the level of access a token is limited to. Scopes do not grant access to resources; instead, they provide limits, in support of the least privilege principal. The following scopes are available on the platform and can be requested when generating either an Organization, Bank or Customer token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource. | Resource | Read scope (Token Type) | Write scope (Token Type) | Execute scope (Token Type) | |------------------------|------------------------------------------------------------|-----------------------------------------------|-------------------------------------------------| | Organizations | organizations:read (Organization) | organizations:write (Organization) | | | Banks | banks:read (Organization, Bank) | banks:write (Organization, Bank) | banks:execute (Organization) | | Customers | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) | | Accounts | accounts:read (Organization, Bank, Customer) | | accounts:execute (Bank, Customer) | | Prices | prices:read (Bank, Customer) | | | | Quotes | quotes:read (Organization, Bank, Customer) | | quotes:execute (Bank, Customer) | | Trades | trades:read (Organization, Bank, Customer) | | trades:execute (Bank, Customer) | | Rewards | rewards:read (Bank, Customer) | | rewards:execute (Bank) | | External bank accounts | external_bank_accounts:read (Organization, Bank, Customer) | external_bank_accounts:write (Bank, Customer) | external_bank_accounts:execute (Bank, Customer) | | Workflows | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | | Transfers | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.demo.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.demo.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.demo.cybrid.app/api/schema/swagger-ui) API services are listed below: | API Service | Model | API Endpoint Path | Description | |--------------|----------------------|--------------------------------|---------------------------------------------------------------------------------------------------| | Identity | Bank | /api/bank_applications | Create and list banks | | Identity | Organization | /api/organization_applications | Create and list organizations | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Organization | Organization | /api/organizations | APIs to retrieve and update organization name | | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) | | Bank | VerificationKey | /api/bank_verification_keys | Create, list and retrive verification keys, used for signing identities | | Bank | Banks | /api/banks | Create, update and list banks, the parent to customers, accounts, etc | | Bank | FeeConfiguration | /api/fee_configurations | Create and list bank fees (spread or fixed) | | Bank | Customers | /api/customers | Create and list customers | | Bank | IdentityRecord | /api/identity_records | Create and list identity records, which are attached to customers for KYC | | Bank | Accounts | /api/accounts | Create and list accounts, which hold a specific asset for a customers | | Bank | Symbols | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) | | Bank | Prices | /api/prices | Get the current prices for assets on the platform | | Bank | Quotes | /api/quotes | Create and list quotes, which are required to execute trades | | Bank | Trades | /api/trades | Create and list trades, which buy or sell cryptocurrency | | Bank | Rewards | /api/rewards | Create a new reward (automates quote/trade for simplicity) | | Bank | ExternalBankAccounts | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform | | Bank | Workflows | /api/workflows | Create, get and list workflows | | Bank | Transfers | /api/transfers | Create, get and list transfers (e.g., funding, book) | ## Understanding Object Models & Endpoints **Organizations** An `Organization` is meant to represent the organization partnering with Cybrid to use our platform. An `Organization` does not directly interact with `customers`. Instead, an Organization has one or more `banks`, which encompass the financial service offerings of the platform. **Banks** A `Bank` is owned by an `Organization` and can be thought of as an environment or container for `customers` and product offerings. Banks are created in either `Sandbox` or `Production` mode, where `Sandbox` is the environment that you would test, prototype and build in prior to moving to `Production`. An `Organization` can have multiple `banks`, in either `Sandbox` or `Production` environments. A `Sandbox Bank` will be backed by stubbed data and process flows. For instance, funding source transfer processes as well as trades will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amount of simulated fiat currency for testing purposes. **Customers** `Customers` represent your banking users on the platform. At present, we offer support for `Individuals` as Customers. `Customers` must be verified (i.e., KYC'd) in our system before they can play any part on the platform, which means they must have an associated and valid `Identity Record`. See the Identity Records section for more details on how a customer can be verified. `Customers` must also have an `Account` to be able to transact, in the desired asset class. See the Accounts APIs for more details on setting up accounts for the customer.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: v0.57.
|
6
|
+
The version of the OpenAPI document: v0.57.33
|
7
7
|
Contact: support@cybrid.app
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 6.0.0
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
## Cybrid API documentation Welcome to Cybrid, an all-in-one crypto platform that enables you to easily **build** and **launch** white-label crypto products or services. In these documents, you'll find details on how our REST API operates and generally how our platform functions. If you're looking for our UI SDK Widgets for Web or Mobile (iOS/Android), generated API clients, or demo applications, head over to our [Github repo](https://github.com/Cybrid-app). 💡 We recommend bookmarking the [Cybrid LinkTree](https://linktr.ee/cybridtechnologies) which contains many helpful links to platform resources. ## Getting Started This is Cybrid's public interactive API documentation, which allows you to fully test our APIs. If you'd like to use a different tool to exercise our APIs, you can download the [Open API 3.0 yaml](https://bank.demo.cybrid.app/api/schema/v1/swagger.yaml) for import. If you're new to our APIs and the Cybrid Platform, follow the below guides to get set up and familiar with the platform: 1. [Getting Started in the Cybrid Sandbox](https://www.cybrid.xyz/guides/getting-started) 2. [Getting Ready for Trading](https://www.cybrid.xyz/guides/getting-ready-for-trading) 3. [Running the Web Demo App](https://www.cybrid.xyz/guides/running-the-cybrid-web-demo-crypto-app) (or, alternatively, [Testing with Hosted Web Demo App](https://www.cybrid.xyz/guides/testing-with-the-web-demo-crypo-app)) In [Getting Started in the Cybrid Sandbox](https://www.cybrid.xyz/guides/getting-started), we walk you through how to use the [Cybrid Sandbox](https://id.demo.cybrid.app/) to create a test bank, generate API keys, and set banks fees. In [Getting Ready for Trading](https://www.cybrid.xyz/guides/getting-ready-for-trading), we walk through creating customers, customer identities, accounts, as well as executing quotes and trades. If you've already run through the first two guides, you can follow the [Running the Web Demo App](https://www.cybrid.xyz/guides/running-the-cybrid-web-demo-crypto-app) guide to test our web SDK with your sandbox `bank` and `customer`. ## Working with the Cybrid Platform There are three primary ways you can interact with the Cybrid platform: 1. Directly via our RESTful API (this documentation) 2. Using our API clients available in a variety of languages ([Angular](https://github.com/Cybrid-app/cybrid-api-bank-angular), [Java](https://github.com/Cybrid-app/cybrid-api-bank-java), [Kotlin](https://github.com/Cybrid-app/cybrid-api-bank-kotlin), [Python](https://github.com/Cybrid-app/cybrid-api-bank-python), [Ruby](https://github.com/Cybrid-app/cybrid-api-bank-ruby), [Swift](https://github.com/Cybrid-app/cybrid-api-bank-swift) or [Typescript](https://github.com/Cybrid-app/cybrid-api-bank-typescript)) 3. Integrating a platform specific SDK ([Web](https://github.com/Cybrid-app/cybrid-sdk-web), [Android](https://github.com/Cybrid-app/cybrid-sdk-android), [iOS](https://github.com/Cybrid-app/cybrid-sdk-ios)) Our complete set of APIs allows you to manage resources across three distinct areas: your `Organization`, your `Banks` and your `Identities`. For most of your testing and interaction you'll be using the `Bank` API, which is where the majority of APIs reside. *The complete set of APIs can be found on the following pages:* | API | Description | |------------------------------------------------------------------|-------------------------------------------------------------| | [Organization API](https://organization.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage organization and bank identities | For questions please contact [Support](mailto:support@cybrid.xyz) at any time for assistance, or contact the [Product Team](mailto:product@cybrid.xyz) for product suggestions. ## Authenticating with the API The Cybrid Platform uses OAuth 2.0 Bearer Tokens to authenticate requests to the platform. Credentials to create `Organization` and `Bank` tokens can be generated via the [Cybrid Sandbox](https://id.demo.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.demo.cybrid.app) as well. An `Organization` access token applies broadly to the whole Organization and all of its `Banks`, whereas, a `Bank` access token is specific to an individual Bank. `Customer` tokens, similarly, are scoped to a specific customer in a bank. Both `Organization` and `Bank` tokens can be created using the OAuth Client Credential Grant flow. Each Organization and Bank has its own unique `Client ID` and `Secret` that allows for machine-to-machine authentication. A `Bank` can then generate `Customer` access tokens via API using our [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui). <font color=\"orange\">**⚠️ Never share your Client ID or Secret publicly or in your source code repository.**</font> Your `Client ID` and `Secret` can be exchanged for a time-limited `Bearer Token` by interacting with the Cybrid Identity Provider or through interacting with the **Authorize** button in this document. The following curl command can be used to quickly generate a `Bearer Token` for use in testing the API or demo applications. ``` curl -X POST https://id.demo.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"banks:read banks:write accounts:read accounts:execute customers:read customers:write customers:execute prices:read quotes:execute trades:execute trades:read\" }' -H \"Content-Type: application/json\" ``` <font color=\"orange\">**⚠️ Note: The above curl will create a bearer token with full scope access. Delete scopes if you'd like to restrict access.**</font> ## Authentication Scopes The Cybrid platform supports the use of scopes to control the level of access a token is limited to. Scopes do not grant access to resources; instead, they provide limits, in support of the least privilege principal. The following scopes are available on the platform and can be requested when generating either an Organization, Bank or Customer token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource. | Resource | Read scope (Token Type) | Write scope (Token Type) | Execute scope (Token Type) | |------------------------|------------------------------------------------------------|-----------------------------------------------|-------------------------------------------------| | Organizations | organizations:read (Organization) | organizations:write (Organization) | | | Banks | banks:read (Organization, Bank) | banks:write (Organization, Bank) | banks:execute (Organization) | | Customers | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) | | Accounts | accounts:read (Organization, Bank, Customer) | | accounts:execute (Bank, Customer) | | Prices | prices:read (Bank, Customer) | | | | Quotes | quotes:read (Organization, Bank, Customer) | | quotes:execute (Bank, Customer) | | Trades | trades:read (Organization, Bank, Customer) | | trades:execute (Bank, Customer) | | Rewards | rewards:read (Bank, Customer) | | rewards:execute (Bank) | | External bank accounts | external_bank_accounts:read (Organization, Bank, Customer) | external_bank_accounts:write (Bank, Customer) | external_bank_accounts:execute (Bank, Customer) | | Workflows | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | | Transfers | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.demo.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.demo.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.demo.cybrid.app/api/schema/swagger-ui) API services are listed below: | API Service | Model | API Endpoint Path | Description | |--------------|----------------------|--------------------------------|---------------------------------------------------------------------------------------------------| | Identity | Bank | /api/bank_applications | Create and list banks | | Identity | Organization | /api/organization_applications | Create and list organizations | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Organization | Organization | /api/organizations | APIs to retrieve and update organization name | | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) | | Bank | VerificationKey | /api/bank_verification_keys | Create, list and retrive verification keys, used for signing identities | | Bank | Banks | /api/banks | Create, update and list banks, the parent to customers, accounts, etc | | Bank | FeeConfiguration | /api/fee_configurations | Create and list bank fees (spread or fixed) | | Bank | Customers | /api/customers | Create and list customers | | Bank | IdentityRecord | /api/identity_records | Create and list identity records, which are attached to customers for KYC | | Bank | Accounts | /api/accounts | Create and list accounts, which hold a specific asset for a customers | | Bank | Symbols | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) | | Bank | Prices | /api/prices | Get the current prices for assets on the platform | | Bank | Quotes | /api/quotes | Create and list quotes, which are required to execute trades | | Bank | Trades | /api/trades | Create and list trades, which buy or sell cryptocurrency | | Bank | Rewards | /api/rewards | Create a new reward (automates quote/trade for simplicity) | | Bank | ExternalBankAccounts | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform | | Bank | Workflows | /api/workflows | Create, get and list workflows | | Bank | Transfers | /api/transfers | Create, get and list transfers (e.g., funding, book) | ## Understanding Object Models & Endpoints **Organizations** An `Organization` is meant to represent the organization partnering with Cybrid to use our platform. An `Organization` does not directly interact with `customers`. Instead, an Organization has one or more `banks`, which encompass the financial service offerings of the platform. **Banks** A `Bank` is owned by an `Organization` and can be thought of as an environment or container for `customers` and product offerings. Banks are created in either `Sandbox` or `Production` mode, where `Sandbox` is the environment that you would test, prototype and build in prior to moving to `Production`. An `Organization` can have multiple `banks`, in either `Sandbox` or `Production` environments. A `Sandbox Bank` will be backed by stubbed data and process flows. For instance, funding source transfer processes as well as trades will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amount of simulated fiat currency for testing purposes. **Customers** `Customers` represent your banking users on the platform. At present, we offer support for `Individuals` as Customers. `Customers` must be verified (i.e., KYC'd) in our system before they can play any part on the platform, which means they must have an associated and valid `Identity Record`. See the Identity Records section for more details on how a customer can be verified. `Customers` must also have an `Account` to be able to transact, in the desired asset class. See the Accounts APIs for more details on setting up accounts for the customer.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: v0.57.
|
6
|
+
The version of the OpenAPI document: v0.57.33
|
7
7
|
Contact: support@cybrid.app
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 6.0.0
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
## Cybrid API documentation Welcome to Cybrid, an all-in-one crypto platform that enables you to easily **build** and **launch** white-label crypto products or services. In these documents, you'll find details on how our REST API operates and generally how our platform functions. If you're looking for our UI SDK Widgets for Web or Mobile (iOS/Android), generated API clients, or demo applications, head over to our [Github repo](https://github.com/Cybrid-app). 💡 We recommend bookmarking the [Cybrid LinkTree](https://linktr.ee/cybridtechnologies) which contains many helpful links to platform resources. ## Getting Started This is Cybrid's public interactive API documentation, which allows you to fully test our APIs. If you'd like to use a different tool to exercise our APIs, you can download the [Open API 3.0 yaml](https://bank.demo.cybrid.app/api/schema/v1/swagger.yaml) for import. If you're new to our APIs and the Cybrid Platform, follow the below guides to get set up and familiar with the platform: 1. [Getting Started in the Cybrid Sandbox](https://www.cybrid.xyz/guides/getting-started) 2. [Getting Ready for Trading](https://www.cybrid.xyz/guides/getting-ready-for-trading) 3. [Running the Web Demo App](https://www.cybrid.xyz/guides/running-the-cybrid-web-demo-crypto-app) (or, alternatively, [Testing with Hosted Web Demo App](https://www.cybrid.xyz/guides/testing-with-the-web-demo-crypo-app)) In [Getting Started in the Cybrid Sandbox](https://www.cybrid.xyz/guides/getting-started), we walk you through how to use the [Cybrid Sandbox](https://id.demo.cybrid.app/) to create a test bank, generate API keys, and set banks fees. In [Getting Ready for Trading](https://www.cybrid.xyz/guides/getting-ready-for-trading), we walk through creating customers, customer identities, accounts, as well as executing quotes and trades. If you've already run through the first two guides, you can follow the [Running the Web Demo App](https://www.cybrid.xyz/guides/running-the-cybrid-web-demo-crypto-app) guide to test our web SDK with your sandbox `bank` and `customer`. ## Working with the Cybrid Platform There are three primary ways you can interact with the Cybrid platform: 1. Directly via our RESTful API (this documentation) 2. Using our API clients available in a variety of languages ([Angular](https://github.com/Cybrid-app/cybrid-api-bank-angular), [Java](https://github.com/Cybrid-app/cybrid-api-bank-java), [Kotlin](https://github.com/Cybrid-app/cybrid-api-bank-kotlin), [Python](https://github.com/Cybrid-app/cybrid-api-bank-python), [Ruby](https://github.com/Cybrid-app/cybrid-api-bank-ruby), [Swift](https://github.com/Cybrid-app/cybrid-api-bank-swift) or [Typescript](https://github.com/Cybrid-app/cybrid-api-bank-typescript)) 3. Integrating a platform specific SDK ([Web](https://github.com/Cybrid-app/cybrid-sdk-web), [Android](https://github.com/Cybrid-app/cybrid-sdk-android), [iOS](https://github.com/Cybrid-app/cybrid-sdk-ios)) Our complete set of APIs allows you to manage resources across three distinct areas: your `Organization`, your `Banks` and your `Identities`. For most of your testing and interaction you'll be using the `Bank` API, which is where the majority of APIs reside. *The complete set of APIs can be found on the following pages:* | API | Description | |------------------------------------------------------------------|-------------------------------------------------------------| | [Organization API](https://organization.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage organization and bank identities | For questions please contact [Support](mailto:support@cybrid.xyz) at any time for assistance, or contact the [Product Team](mailto:product@cybrid.xyz) for product suggestions. ## Authenticating with the API The Cybrid Platform uses OAuth 2.0 Bearer Tokens to authenticate requests to the platform. Credentials to create `Organization` and `Bank` tokens can be generated via the [Cybrid Sandbox](https://id.demo.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.demo.cybrid.app) as well. An `Organization` access token applies broadly to the whole Organization and all of its `Banks`, whereas, a `Bank` access token is specific to an individual Bank. `Customer` tokens, similarly, are scoped to a specific customer in a bank. Both `Organization` and `Bank` tokens can be created using the OAuth Client Credential Grant flow. Each Organization and Bank has its own unique `Client ID` and `Secret` that allows for machine-to-machine authentication. A `Bank` can then generate `Customer` access tokens via API using our [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui). <font color=\"orange\">**⚠️ Never share your Client ID or Secret publicly or in your source code repository.**</font> Your `Client ID` and `Secret` can be exchanged for a time-limited `Bearer Token` by interacting with the Cybrid Identity Provider or through interacting with the **Authorize** button in this document. The following curl command can be used to quickly generate a `Bearer Token` for use in testing the API or demo applications. ``` curl -X POST https://id.demo.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"banks:read banks:write accounts:read accounts:execute customers:read customers:write customers:execute prices:read quotes:execute trades:execute trades:read\" }' -H \"Content-Type: application/json\" ``` <font color=\"orange\">**⚠️ Note: The above curl will create a bearer token with full scope access. Delete scopes if you'd like to restrict access.**</font> ## Authentication Scopes The Cybrid platform supports the use of scopes to control the level of access a token is limited to. Scopes do not grant access to resources; instead, they provide limits, in support of the least privilege principal. The following scopes are available on the platform and can be requested when generating either an Organization, Bank or Customer token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource. | Resource | Read scope (Token Type) | Write scope (Token Type) | Execute scope (Token Type) | |------------------------|------------------------------------------------------------|-----------------------------------------------|-------------------------------------------------| | Organizations | organizations:read (Organization) | organizations:write (Organization) | | | Banks | banks:read (Organization, Bank) | banks:write (Organization, Bank) | banks:execute (Organization) | | Customers | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) | | Accounts | accounts:read (Organization, Bank, Customer) | | accounts:execute (Bank, Customer) | | Prices | prices:read (Bank, Customer) | | | | Quotes | quotes:read (Organization, Bank, Customer) | | quotes:execute (Bank, Customer) | | Trades | trades:read (Organization, Bank, Customer) | | trades:execute (Bank, Customer) | | Rewards | rewards:read (Bank, Customer) | | rewards:execute (Bank) | | External bank accounts | external_bank_accounts:read (Organization, Bank, Customer) | external_bank_accounts:write (Bank, Customer) | external_bank_accounts:execute (Bank, Customer) | | Workflows | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | | Transfers | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.demo.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.demo.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.demo.cybrid.app/api/schema/swagger-ui) API services are listed below: | API Service | Model | API Endpoint Path | Description | |--------------|----------------------|--------------------------------|---------------------------------------------------------------------------------------------------| | Identity | Bank | /api/bank_applications | Create and list banks | | Identity | Organization | /api/organization_applications | Create and list organizations | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Organization | Organization | /api/organizations | APIs to retrieve and update organization name | | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) | | Bank | VerificationKey | /api/bank_verification_keys | Create, list and retrive verification keys, used for signing identities | | Bank | Banks | /api/banks | Create, update and list banks, the parent to customers, accounts, etc | | Bank | FeeConfiguration | /api/fee_configurations | Create and list bank fees (spread or fixed) | | Bank | Customers | /api/customers | Create and list customers | | Bank | IdentityRecord | /api/identity_records | Create and list identity records, which are attached to customers for KYC | | Bank | Accounts | /api/accounts | Create and list accounts, which hold a specific asset for a customers | | Bank | Symbols | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) | | Bank | Prices | /api/prices | Get the current prices for assets on the platform | | Bank | Quotes | /api/quotes | Create and list quotes, which are required to execute trades | | Bank | Trades | /api/trades | Create and list trades, which buy or sell cryptocurrency | | Bank | Rewards | /api/rewards | Create a new reward (automates quote/trade for simplicity) | | Bank | ExternalBankAccounts | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform | | Bank | Workflows | /api/workflows | Create, get and list workflows | | Bank | Transfers | /api/transfers | Create, get and list transfers (e.g., funding, book) | ## Understanding Object Models & Endpoints **Organizations** An `Organization` is meant to represent the organization partnering with Cybrid to use our platform. An `Organization` does not directly interact with `customers`. Instead, an Organization has one or more `banks`, which encompass the financial service offerings of the platform. **Banks** A `Bank` is owned by an `Organization` and can be thought of as an environment or container for `customers` and product offerings. Banks are created in either `Sandbox` or `Production` mode, where `Sandbox` is the environment that you would test, prototype and build in prior to moving to `Production`. An `Organization` can have multiple `banks`, in either `Sandbox` or `Production` environments. A `Sandbox Bank` will be backed by stubbed data and process flows. For instance, funding source transfer processes as well as trades will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amount of simulated fiat currency for testing purposes. **Customers** `Customers` represent your banking users on the platform. At present, we offer support for `Individuals` as Customers. `Customers` must be verified (i.e., KYC'd) in our system before they can play any part on the platform, which means they must have an associated and valid `Identity Record`. See the Identity Records section for more details on how a customer can be verified. `Customers` must also have an `Account` to be able to transact, in the desired asset class. See the Accounts APIs for more details on setting up accounts for the customer.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: v0.57.
|
6
|
+
The version of the OpenAPI document: v0.57.33
|
7
7
|
Contact: support@cybrid.app
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 6.0.0
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
## Cybrid API documentation Welcome to Cybrid, an all-in-one crypto platform that enables you to easily **build** and **launch** white-label crypto products or services. In these documents, you'll find details on how our REST API operates and generally how our platform functions. If you're looking for our UI SDK Widgets for Web or Mobile (iOS/Android), generated API clients, or demo applications, head over to our [Github repo](https://github.com/Cybrid-app). 💡 We recommend bookmarking the [Cybrid LinkTree](https://linktr.ee/cybridtechnologies) which contains many helpful links to platform resources. ## Getting Started This is Cybrid's public interactive API documentation, which allows you to fully test our APIs. If you'd like to use a different tool to exercise our APIs, you can download the [Open API 3.0 yaml](https://bank.demo.cybrid.app/api/schema/v1/swagger.yaml) for import. If you're new to our APIs and the Cybrid Platform, follow the below guides to get set up and familiar with the platform: 1. [Getting Started in the Cybrid Sandbox](https://www.cybrid.xyz/guides/getting-started) 2. [Getting Ready for Trading](https://www.cybrid.xyz/guides/getting-ready-for-trading) 3. [Running the Web Demo App](https://www.cybrid.xyz/guides/running-the-cybrid-web-demo-crypto-app) (or, alternatively, [Testing with Hosted Web Demo App](https://www.cybrid.xyz/guides/testing-with-the-web-demo-crypo-app)) In [Getting Started in the Cybrid Sandbox](https://www.cybrid.xyz/guides/getting-started), we walk you through how to use the [Cybrid Sandbox](https://id.demo.cybrid.app/) to create a test bank, generate API keys, and set banks fees. In [Getting Ready for Trading](https://www.cybrid.xyz/guides/getting-ready-for-trading), we walk through creating customers, customer identities, accounts, as well as executing quotes and trades. If you've already run through the first two guides, you can follow the [Running the Web Demo App](https://www.cybrid.xyz/guides/running-the-cybrid-web-demo-crypto-app) guide to test our web SDK with your sandbox `bank` and `customer`. ## Working with the Cybrid Platform There are three primary ways you can interact with the Cybrid platform: 1. Directly via our RESTful API (this documentation) 2. Using our API clients available in a variety of languages ([Angular](https://github.com/Cybrid-app/cybrid-api-bank-angular), [Java](https://github.com/Cybrid-app/cybrid-api-bank-java), [Kotlin](https://github.com/Cybrid-app/cybrid-api-bank-kotlin), [Python](https://github.com/Cybrid-app/cybrid-api-bank-python), [Ruby](https://github.com/Cybrid-app/cybrid-api-bank-ruby), [Swift](https://github.com/Cybrid-app/cybrid-api-bank-swift) or [Typescript](https://github.com/Cybrid-app/cybrid-api-bank-typescript)) 3. Integrating a platform specific SDK ([Web](https://github.com/Cybrid-app/cybrid-sdk-web), [Android](https://github.com/Cybrid-app/cybrid-sdk-android), [iOS](https://github.com/Cybrid-app/cybrid-sdk-ios)) Our complete set of APIs allows you to manage resources across three distinct areas: your `Organization`, your `Banks` and your `Identities`. For most of your testing and interaction you'll be using the `Bank` API, which is where the majority of APIs reside. *The complete set of APIs can be found on the following pages:* | API | Description | |------------------------------------------------------------------|-------------------------------------------------------------| | [Organization API](https://organization.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage organization and bank identities | For questions please contact [Support](mailto:support@cybrid.xyz) at any time for assistance, or contact the [Product Team](mailto:product@cybrid.xyz) for product suggestions. ## Authenticating with the API The Cybrid Platform uses OAuth 2.0 Bearer Tokens to authenticate requests to the platform. Credentials to create `Organization` and `Bank` tokens can be generated via the [Cybrid Sandbox](https://id.demo.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.demo.cybrid.app) as well. An `Organization` access token applies broadly to the whole Organization and all of its `Banks`, whereas, a `Bank` access token is specific to an individual Bank. `Customer` tokens, similarly, are scoped to a specific customer in a bank. Both `Organization` and `Bank` tokens can be created using the OAuth Client Credential Grant flow. Each Organization and Bank has its own unique `Client ID` and `Secret` that allows for machine-to-machine authentication. A `Bank` can then generate `Customer` access tokens via API using our [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui). <font color=\"orange\">**⚠️ Never share your Client ID or Secret publicly or in your source code repository.**</font> Your `Client ID` and `Secret` can be exchanged for a time-limited `Bearer Token` by interacting with the Cybrid Identity Provider or through interacting with the **Authorize** button in this document. The following curl command can be used to quickly generate a `Bearer Token` for use in testing the API or demo applications. ``` curl -X POST https://id.demo.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"banks:read banks:write accounts:read accounts:execute customers:read customers:write customers:execute prices:read quotes:execute trades:execute trades:read\" }' -H \"Content-Type: application/json\" ``` <font color=\"orange\">**⚠️ Note: The above curl will create a bearer token with full scope access. Delete scopes if you'd like to restrict access.**</font> ## Authentication Scopes The Cybrid platform supports the use of scopes to control the level of access a token is limited to. Scopes do not grant access to resources; instead, they provide limits, in support of the least privilege principal. The following scopes are available on the platform and can be requested when generating either an Organization, Bank or Customer token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource. | Resource | Read scope (Token Type) | Write scope (Token Type) | Execute scope (Token Type) | |------------------------|------------------------------------------------------------|-----------------------------------------------|-------------------------------------------------| | Organizations | organizations:read (Organization) | organizations:write (Organization) | | | Banks | banks:read (Organization, Bank) | banks:write (Organization, Bank) | banks:execute (Organization) | | Customers | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) | | Accounts | accounts:read (Organization, Bank, Customer) | | accounts:execute (Bank, Customer) | | Prices | prices:read (Bank, Customer) | | | | Quotes | quotes:read (Organization, Bank, Customer) | | quotes:execute (Bank, Customer) | | Trades | trades:read (Organization, Bank, Customer) | | trades:execute (Bank, Customer) | | Rewards | rewards:read (Bank, Customer) | | rewards:execute (Bank) | | External bank accounts | external_bank_accounts:read (Organization, Bank, Customer) | external_bank_accounts:write (Bank, Customer) | external_bank_accounts:execute (Bank, Customer) | | Workflows | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | | Transfers | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.demo.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.demo.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.demo.cybrid.app/api/schema/swagger-ui) API services are listed below: | API Service | Model | API Endpoint Path | Description | |--------------|----------------------|--------------------------------|---------------------------------------------------------------------------------------------------| | Identity | Bank | /api/bank_applications | Create and list banks | | Identity | Organization | /api/organization_applications | Create and list organizations | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Organization | Organization | /api/organizations | APIs to retrieve and update organization name | | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) | | Bank | VerificationKey | /api/bank_verification_keys | Create, list and retrive verification keys, used for signing identities | | Bank | Banks | /api/banks | Create, update and list banks, the parent to customers, accounts, etc | | Bank | FeeConfiguration | /api/fee_configurations | Create and list bank fees (spread or fixed) | | Bank | Customers | /api/customers | Create and list customers | | Bank | IdentityRecord | /api/identity_records | Create and list identity records, which are attached to customers for KYC | | Bank | Accounts | /api/accounts | Create and list accounts, which hold a specific asset for a customers | | Bank | Symbols | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) | | Bank | Prices | /api/prices | Get the current prices for assets on the platform | | Bank | Quotes | /api/quotes | Create and list quotes, which are required to execute trades | | Bank | Trades | /api/trades | Create and list trades, which buy or sell cryptocurrency | | Bank | Rewards | /api/rewards | Create a new reward (automates quote/trade for simplicity) | | Bank | ExternalBankAccounts | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform | | Bank | Workflows | /api/workflows | Create, get and list workflows | | Bank | Transfers | /api/transfers | Create, get and list transfers (e.g., funding, book) | ## Understanding Object Models & Endpoints **Organizations** An `Organization` is meant to represent the organization partnering with Cybrid to use our platform. An `Organization` does not directly interact with `customers`. Instead, an Organization has one or more `banks`, which encompass the financial service offerings of the platform. **Banks** A `Bank` is owned by an `Organization` and can be thought of as an environment or container for `customers` and product offerings. Banks are created in either `Sandbox` or `Production` mode, where `Sandbox` is the environment that you would test, prototype and build in prior to moving to `Production`. An `Organization` can have multiple `banks`, in either `Sandbox` or `Production` environments. A `Sandbox Bank` will be backed by stubbed data and process flows. For instance, funding source transfer processes as well as trades will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amount of simulated fiat currency for testing purposes. **Customers** `Customers` represent your banking users on the platform. At present, we offer support for `Individuals` as Customers. `Customers` must be verified (i.e., KYC'd) in our system before they can play any part on the platform, which means they must have an associated and valid `Identity Record`. See the Identity Records section for more details on how a customer can be verified. `Customers` must also have an `Account` to be able to transact, in the desired asset class. See the Accounts APIs for more details on setting up accounts for the customer.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: v0.57.
|
6
|
+
The version of the OpenAPI document: v0.57.33
|
7
7
|
Contact: support@cybrid.app
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 6.0.0
|
data/spec/spec_helper.rb
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
## Cybrid API documentation Welcome to Cybrid, an all-in-one crypto platform that enables you to easily **build** and **launch** white-label crypto products or services. In these documents, you'll find details on how our REST API operates and generally how our platform functions. If you're looking for our UI SDK Widgets for Web or Mobile (iOS/Android), generated API clients, or demo applications, head over to our [Github repo](https://github.com/Cybrid-app). 💡 We recommend bookmarking the [Cybrid LinkTree](https://linktr.ee/cybridtechnologies) which contains many helpful links to platform resources. ## Getting Started This is Cybrid's public interactive API documentation, which allows you to fully test our APIs. If you'd like to use a different tool to exercise our APIs, you can download the [Open API 3.0 yaml](https://bank.demo.cybrid.app/api/schema/v1/swagger.yaml) for import. If you're new to our APIs and the Cybrid Platform, follow the below guides to get set up and familiar with the platform: 1. [Getting Started in the Cybrid Sandbox](https://www.cybrid.xyz/guides/getting-started) 2. [Getting Ready for Trading](https://www.cybrid.xyz/guides/getting-ready-for-trading) 3. [Running the Web Demo App](https://www.cybrid.xyz/guides/running-the-cybrid-web-demo-crypto-app) (or, alternatively, [Testing with Hosted Web Demo App](https://www.cybrid.xyz/guides/testing-with-the-web-demo-crypo-app)) In [Getting Started in the Cybrid Sandbox](https://www.cybrid.xyz/guides/getting-started), we walk you through how to use the [Cybrid Sandbox](https://id.demo.cybrid.app/) to create a test bank, generate API keys, and set banks fees. In [Getting Ready for Trading](https://www.cybrid.xyz/guides/getting-ready-for-trading), we walk through creating customers, customer identities, accounts, as well as executing quotes and trades. If you've already run through the first two guides, you can follow the [Running the Web Demo App](https://www.cybrid.xyz/guides/running-the-cybrid-web-demo-crypto-app) guide to test our web SDK with your sandbox `bank` and `customer`. ## Working with the Cybrid Platform There are three primary ways you can interact with the Cybrid platform: 1. Directly via our RESTful API (this documentation) 2. Using our API clients available in a variety of languages ([Angular](https://github.com/Cybrid-app/cybrid-api-bank-angular), [Java](https://github.com/Cybrid-app/cybrid-api-bank-java), [Kotlin](https://github.com/Cybrid-app/cybrid-api-bank-kotlin), [Python](https://github.com/Cybrid-app/cybrid-api-bank-python), [Ruby](https://github.com/Cybrid-app/cybrid-api-bank-ruby), [Swift](https://github.com/Cybrid-app/cybrid-api-bank-swift) or [Typescript](https://github.com/Cybrid-app/cybrid-api-bank-typescript)) 3. Integrating a platform specific SDK ([Web](https://github.com/Cybrid-app/cybrid-sdk-web), [Android](https://github.com/Cybrid-app/cybrid-sdk-android), [iOS](https://github.com/Cybrid-app/cybrid-sdk-ios)) Our complete set of APIs allows you to manage resources across three distinct areas: your `Organization`, your `Banks` and your `Identities`. For most of your testing and interaction you'll be using the `Bank` API, which is where the majority of APIs reside. *The complete set of APIs can be found on the following pages:* | API | Description | |------------------------------------------------------------------|-------------------------------------------------------------| | [Organization API](https://organization.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage organization and bank identities | For questions please contact [Support](mailto:support@cybrid.xyz) at any time for assistance, or contact the [Product Team](mailto:product@cybrid.xyz) for product suggestions. ## Authenticating with the API The Cybrid Platform uses OAuth 2.0 Bearer Tokens to authenticate requests to the platform. Credentials to create `Organization` and `Bank` tokens can be generated via the [Cybrid Sandbox](https://id.demo.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.demo.cybrid.app) as well. An `Organization` access token applies broadly to the whole Organization and all of its `Banks`, whereas, a `Bank` access token is specific to an individual Bank. `Customer` tokens, similarly, are scoped to a specific customer in a bank. Both `Organization` and `Bank` tokens can be created using the OAuth Client Credential Grant flow. Each Organization and Bank has its own unique `Client ID` and `Secret` that allows for machine-to-machine authentication. A `Bank` can then generate `Customer` access tokens via API using our [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui). <font color=\"orange\">**⚠️ Never share your Client ID or Secret publicly or in your source code repository.**</font> Your `Client ID` and `Secret` can be exchanged for a time-limited `Bearer Token` by interacting with the Cybrid Identity Provider or through interacting with the **Authorize** button in this document. The following curl command can be used to quickly generate a `Bearer Token` for use in testing the API or demo applications. ``` curl -X POST https://id.demo.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"banks:read banks:write accounts:read accounts:execute customers:read customers:write customers:execute prices:read quotes:execute trades:execute trades:read\" }' -H \"Content-Type: application/json\" ``` <font color=\"orange\">**⚠️ Note: The above curl will create a bearer token with full scope access. Delete scopes if you'd like to restrict access.**</font> ## Authentication Scopes The Cybrid platform supports the use of scopes to control the level of access a token is limited to. Scopes do not grant access to resources; instead, they provide limits, in support of the least privilege principal. The following scopes are available on the platform and can be requested when generating either an Organization, Bank or Customer token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource. | Resource | Read scope (Token Type) | Write scope (Token Type) | Execute scope (Token Type) | |------------------------|------------------------------------------------------------|-----------------------------------------------|-------------------------------------------------| | Organizations | organizations:read (Organization) | organizations:write (Organization) | | | Banks | banks:read (Organization, Bank) | banks:write (Organization, Bank) | banks:execute (Organization) | | Customers | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) | | Accounts | accounts:read (Organization, Bank, Customer) | | accounts:execute (Bank, Customer) | | Prices | prices:read (Bank, Customer) | | | | Quotes | quotes:read (Organization, Bank, Customer) | | quotes:execute (Bank, Customer) | | Trades | trades:read (Organization, Bank, Customer) | | trades:execute (Bank, Customer) | | Rewards | rewards:read (Bank, Customer) | | rewards:execute (Bank) | | External bank accounts | external_bank_accounts:read (Organization, Bank, Customer) | external_bank_accounts:write (Bank, Customer) | external_bank_accounts:execute (Bank, Customer) | | Workflows | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | | Transfers | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.demo.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.demo.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.demo.cybrid.app/api/schema/swagger-ui) API services are listed below: | API Service | Model | API Endpoint Path | Description | |--------------|----------------------|--------------------------------|---------------------------------------------------------------------------------------------------| | Identity | Bank | /api/bank_applications | Create and list banks | | Identity | Organization | /api/organization_applications | Create and list organizations | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Organization | Organization | /api/organizations | APIs to retrieve and update organization name | | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) | | Bank | VerificationKey | /api/bank_verification_keys | Create, list and retrive verification keys, used for signing identities | | Bank | Banks | /api/banks | Create, update and list banks, the parent to customers, accounts, etc | | Bank | FeeConfiguration | /api/fee_configurations | Create and list bank fees (spread or fixed) | | Bank | Customers | /api/customers | Create and list customers | | Bank | IdentityRecord | /api/identity_records | Create and list identity records, which are attached to customers for KYC | | Bank | Accounts | /api/accounts | Create and list accounts, which hold a specific asset for a customers | | Bank | Symbols | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) | | Bank | Prices | /api/prices | Get the current prices for assets on the platform | | Bank | Quotes | /api/quotes | Create and list quotes, which are required to execute trades | | Bank | Trades | /api/trades | Create and list trades, which buy or sell cryptocurrency | | Bank | Rewards | /api/rewards | Create a new reward (automates quote/trade for simplicity) | | Bank | ExternalBankAccounts | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform | | Bank | Workflows | /api/workflows | Create, get and list workflows | | Bank | Transfers | /api/transfers | Create, get and list transfers (e.g., funding, book) | ## Understanding Object Models & Endpoints **Organizations** An `Organization` is meant to represent the organization partnering with Cybrid to use our platform. An `Organization` does not directly interact with `customers`. Instead, an Organization has one or more `banks`, which encompass the financial service offerings of the platform. **Banks** A `Bank` is owned by an `Organization` and can be thought of as an environment or container for `customers` and product offerings. Banks are created in either `Sandbox` or `Production` mode, where `Sandbox` is the environment that you would test, prototype and build in prior to moving to `Production`. An `Organization` can have multiple `banks`, in either `Sandbox` or `Production` environments. A `Sandbox Bank` will be backed by stubbed data and process flows. For instance, funding source transfer processes as well as trades will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amount of simulated fiat currency for testing purposes. **Customers** `Customers` represent your banking users on the platform. At present, we offer support for `Individuals` as Customers. `Customers` must be verified (i.e., KYC'd) in our system before they can play any part on the platform, which means they must have an associated and valid `Identity Record`. See the Identity Records section for more details on how a customer can be verified. `Customers` must also have an `Account` to be able to transact, in the desired asset class. See the Accounts APIs for more details on setting up accounts for the customer.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: v0.57.
|
6
|
+
The version of the OpenAPI document: v0.57.33
|
7
7
|
Contact: support@cybrid.app
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 6.0.0
|
Binary file
|
Binary file
|
Binary file
|
@@ -3,12 +3,12 @@ current directory: /home/circleci/project/api-service-clients/api-platform-organ
|
|
3
3
|
creating Makefile
|
4
4
|
|
5
5
|
current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/byebug-11.1.3/ext/byebug
|
6
|
-
make DESTDIR\= sitearchdir\=./.gem.
|
6
|
+
make DESTDIR\= sitearchdir\=./.gem.20230109-3906-9y9yln sitelibdir\=./.gem.20230109-3906-9y9yln clean
|
7
7
|
make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/byebug-11.1.3/ext/byebug'
|
8
8
|
make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/byebug-11.1.3/ext/byebug'
|
9
9
|
|
10
10
|
current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/byebug-11.1.3/ext/byebug
|
11
|
-
make DESTDIR\= sitearchdir\=./.gem.
|
11
|
+
make DESTDIR\= sitearchdir\=./.gem.20230109-3906-9y9yln sitelibdir\=./.gem.20230109-3906-9y9yln
|
12
12
|
make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/byebug-11.1.3/ext/byebug'
|
13
13
|
compiling breakpoint.c
|
14
14
|
compiling byebug.c
|
@@ -39,7 +39,7 @@ linking shared-object byebug/byebug.so
|
|
39
39
|
make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/byebug-11.1.3/ext/byebug'
|
40
40
|
|
41
41
|
current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/byebug-11.1.3/ext/byebug
|
42
|
-
make DESTDIR\= sitearchdir\=./.gem.
|
42
|
+
make DESTDIR\= sitearchdir\=./.gem.20230109-3906-9y9yln sitelibdir\=./.gem.20230109-3906-9y9yln install
|
43
43
|
make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/byebug-11.1.3/ext/byebug'
|
44
|
-
/usr/bin/install -c -m 0755 byebug.so ./.gem.
|
44
|
+
/usr/bin/install -c -m 0755 byebug.so ./.gem.20230109-3906-9y9yln/byebug
|
45
45
|
make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/byebug-11.1.3/ext/byebug'
|
@@ -9,12 +9,12 @@ creating extconf.h
|
|
9
9
|
creating Makefile
|
10
10
|
|
11
11
|
current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/ffi-1.15.5/ext/ffi_c
|
12
|
-
make DESTDIR\= sitearchdir\=./.gem.
|
12
|
+
make DESTDIR\= sitearchdir\=./.gem.20230109-3906-zxby88 sitelibdir\=./.gem.20230109-3906-zxby88 clean
|
13
13
|
make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/ffi-1.15.5/ext/ffi_c'
|
14
14
|
make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/ffi-1.15.5/ext/ffi_c'
|
15
15
|
|
16
16
|
current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/ffi-1.15.5/ext/ffi_c
|
17
|
-
make DESTDIR\= sitearchdir\=./.gem.
|
17
|
+
make DESTDIR\= sitearchdir\=./.gem.20230109-3906-zxby88 sitelibdir\=./.gem.20230109-3906-zxby88
|
18
18
|
make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/ffi-1.15.5/ext/ffi_c'
|
19
19
|
compiling AbstractMemory.c
|
20
20
|
compiling ArrayType.c
|
@@ -43,7 +43,7 @@ linking shared-object ffi_c.so
|
|
43
43
|
make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/ffi-1.15.5/ext/ffi_c'
|
44
44
|
|
45
45
|
current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/ffi-1.15.5/ext/ffi_c
|
46
|
-
make DESTDIR\= sitearchdir\=./.gem.
|
46
|
+
make DESTDIR\= sitearchdir\=./.gem.20230109-3906-zxby88 sitelibdir\=./.gem.20230109-3906-zxby88 install
|
47
47
|
make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/ffi-1.15.5/ext/ffi_c'
|
48
|
-
/usr/bin/install -c -m 0755 ffi_c.so ./.gem.
|
48
|
+
/usr/bin/install -c -m 0755 ffi_c.so ./.gem.20230109-3906-zxby88
|
49
49
|
make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/ffi-1.15.5/ext/ffi_c'
|
@@ -3,12 +3,12 @@ current directory: /home/circleci/project/api-service-clients/api-platform-organ
|
|
3
3
|
creating Makefile
|
4
4
|
|
5
5
|
current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/jaro_winkler-1.5.4/ext/jaro_winkler
|
6
|
-
make DESTDIR\= sitearchdir\=./.gem.
|
6
|
+
make DESTDIR\= sitearchdir\=./.gem.20230109-3906-h75wyh sitelibdir\=./.gem.20230109-3906-h75wyh clean
|
7
7
|
make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/jaro_winkler-1.5.4/ext/jaro_winkler'
|
8
8
|
make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/jaro_winkler-1.5.4/ext/jaro_winkler'
|
9
9
|
|
10
10
|
current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/jaro_winkler-1.5.4/ext/jaro_winkler
|
11
|
-
make DESTDIR\= sitearchdir\=./.gem.
|
11
|
+
make DESTDIR\= sitearchdir\=./.gem.20230109-3906-h75wyh sitelibdir\=./.gem.20230109-3906-h75wyh
|
12
12
|
make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/jaro_winkler-1.5.4/ext/jaro_winkler'
|
13
13
|
compiling adj_matrix.c
|
14
14
|
adj_matrix.c: In function ‘adj_matrix_default’:
|
@@ -63,7 +63,7 @@ linking shared-object jaro_winkler/jaro_winkler_ext.so
|
|
63
63
|
make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/jaro_winkler-1.5.4/ext/jaro_winkler'
|
64
64
|
|
65
65
|
current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/jaro_winkler-1.5.4/ext/jaro_winkler
|
66
|
-
make DESTDIR\= sitearchdir\=./.gem.
|
66
|
+
make DESTDIR\= sitearchdir\=./.gem.20230109-3906-h75wyh sitelibdir\=./.gem.20230109-3906-h75wyh install
|
67
67
|
make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/jaro_winkler-1.5.4/ext/jaro_winkler'
|
68
|
-
/usr/bin/install -c -m 0755 jaro_winkler_ext.so ./.gem.
|
68
|
+
/usr/bin/install -c -m 0755 jaro_winkler_ext.so ./.gem.20230109-3906-h75wyh/jaro_winkler
|
69
69
|
make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/jaro_winkler-1.5.4/ext/jaro_winkler'
|
@@ -5,7 +5,7 @@ checking for yaml_get_version() in -lyaml... yes
|
|
5
5
|
creating Makefile
|
6
6
|
|
7
7
|
current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-5.0.1/ext/psych
|
8
|
-
make DESTDIR\= sitearchdir\=./.gem.
|
8
|
+
make DESTDIR\= sitearchdir\=./.gem.20230109-3906-589lbd sitelibdir\=./.gem.20230109-3906-589lbd clean
|
9
9
|
make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-5.0.1/ext/psych'
|
10
10
|
cd libyaml && make clean
|
11
11
|
/bin/sh: 1: cd: can't cd to libyaml
|
@@ -13,7 +13,7 @@ make[1]: [Makefile:282: clean-so] Error 2 (ignored)
|
|
13
13
|
make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-5.0.1/ext/psych'
|
14
14
|
|
15
15
|
current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-5.0.1/ext/psych
|
16
|
-
make DESTDIR\= sitearchdir\=./.gem.
|
16
|
+
make DESTDIR\= sitearchdir\=./.gem.20230109-3906-589lbd sitelibdir\=./.gem.20230109-3906-589lbd
|
17
17
|
make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-5.0.1/ext/psych'
|
18
18
|
compiling psych.c
|
19
19
|
compiling psych_emitter.c
|
@@ -24,7 +24,7 @@ linking shared-object psych.so
|
|
24
24
|
make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-5.0.1/ext/psych'
|
25
25
|
|
26
26
|
current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-5.0.1/ext/psych
|
27
|
-
make DESTDIR\= sitearchdir\=./.gem.
|
27
|
+
make DESTDIR\= sitearchdir\=./.gem.20230109-3906-589lbd sitelibdir\=./.gem.20230109-3906-589lbd install
|
28
28
|
make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-5.0.1/ext/psych'
|
29
|
-
/usr/bin/install -c -m 0755 psych.so ./.gem.
|
29
|
+
/usr/bin/install -c -m 0755 psych.so ./.gem.20230109-3906-589lbd
|
30
30
|
make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/psych-5.0.1/ext/psych'
|
@@ -4,19 +4,19 @@ checking for rb_io_extract_modeenc() in ruby/io.h... yes
|
|
4
4
|
creating Makefile
|
5
5
|
|
6
6
|
current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/stringio-3.0.4/ext/stringio
|
7
|
-
make DESTDIR\= sitearchdir\=./.gem.
|
7
|
+
make DESTDIR\= sitearchdir\=./.gem.20230109-3906-4igdvv sitelibdir\=./.gem.20230109-3906-4igdvv clean
|
8
8
|
make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/stringio-3.0.4/ext/stringio'
|
9
9
|
make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/stringio-3.0.4/ext/stringio'
|
10
10
|
|
11
11
|
current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/stringio-3.0.4/ext/stringio
|
12
|
-
make DESTDIR\= sitearchdir\=./.gem.
|
12
|
+
make DESTDIR\= sitearchdir\=./.gem.20230109-3906-4igdvv sitelibdir\=./.gem.20230109-3906-4igdvv
|
13
13
|
make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/stringio-3.0.4/ext/stringio'
|
14
14
|
compiling stringio.c
|
15
15
|
linking shared-object stringio.so
|
16
16
|
make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/stringio-3.0.4/ext/stringio'
|
17
17
|
|
18
18
|
current directory: /home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/stringio-3.0.4/ext/stringio
|
19
|
-
make DESTDIR\= sitearchdir\=./.gem.
|
19
|
+
make DESTDIR\= sitearchdir\=./.gem.20230109-3906-4igdvv sitelibdir\=./.gem.20230109-3906-4igdvv install
|
20
20
|
make[1]: Entering directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/stringio-3.0.4/ext/stringio'
|
21
|
-
/usr/bin/install -c -m 0755 stringio.so ./.gem.
|
21
|
+
/usr/bin/install -c -m 0755 stringio.so ./.gem.20230109-3906-4igdvv
|
22
22
|
make[1]: Leaving directory '/home/circleci/project/api-service-clients/api-platform-organization/ruby/vendor/bundle/ruby/3.1.0/gems/stringio-3.0.4/ext/stringio'
|
@@ -1,5 +1,36 @@
|
|
1
1
|
### master
|
2
2
|
|
3
|
+
### [v0.14.2][v0.14.2] (January 9, 2023)
|
4
|
+
|
5
|
+
#### Features
|
6
|
+
|
7
|
+
* Configure `code` as a supported editor on Pry::Editor
|
8
|
+
([#2236](https://github.com/pry/pry/pull/2236))
|
9
|
+
* Added support for Ruby 3.2
|
10
|
+
([#2263](https://github.com/pry/pry/pull/2263))
|
11
|
+
* Added support for Ruby 3.1
|
12
|
+
([#2228](https://github.com/pry/pry/pull/2228))
|
13
|
+
|
14
|
+
#### Bug fixes
|
15
|
+
|
16
|
+
* Short circuit eval regexes in finding module definition
|
17
|
+
([#2253](https://github.com/pry/pry/pull/2253))
|
18
|
+
* Revert "Escape non-printing characters"
|
19
|
+
([#2235](https://github.com/pry/pry/pull/2235))
|
20
|
+
* Fixed bug where WeirdMethodLocator would fail to find the source of a method breaking whereami
|
21
|
+
([#2244](https://github.com/pry/pry/pull/2244))
|
22
|
+
* Fixed bug where pry would throw an FrozenError when dealing with incomplete tokens
|
23
|
+
([#2136](https://github.com/pry/pry/pull/2136))
|
24
|
+
* Restore --no-history CLI flag functionality
|
25
|
+
([#2196](https://github.com/pry/pry/pull/2196))
|
26
|
+
* Fixed bug where reading from the `_out_` sticky local variable could return
|
27
|
+
wrong results ([#2201](https://github.com/pry/pry/pull/2201))
|
28
|
+
|
29
|
+
#### Breaking Changes
|
30
|
+
|
31
|
+
* Remove support for Ruby 1.9 and JRuby < 9.0
|
32
|
+
([#2239](https://github.com/pry/pry/pull/2239))
|
33
|
+
|
3
34
|
### [v0.14.1][v0.14.1] (April 12, 2021)
|
4
35
|
|
5
36
|
#### Bug fixes
|
File without changes
|
@@ -1,7 +1,7 @@
|
|
1
1
|
Pry
|
2
2
|
===
|
3
3
|
|
4
|
-
[![
|
4
|
+
[![Pry Build Status](https://github.com/pry/pry/workflows/pry/badge.svg)](https://github.com/pry/pry/actions)
|
5
5
|
[![Code Climate](https://codeclimate.com/github/pry/pry.svg)](https://codeclimate.com/github/pry/pry)
|
6
6
|
[![Gem Version](https://badge.fury.io/rb/pry.svg)](https://badge.fury.io/rb/pry)
|
7
7
|
[![Documentation Status](https://inch-ci.org/github/pry/pry.svg?branch=master)](https://inch-ci.org/github/pry/pry)
|
@@ -21,7 +21,7 @@ Pry
|
|
21
21
|
|
22
22
|
**Links:**
|
23
23
|
|
24
|
-
* https://pry.github.
|
24
|
+
* https://pry.github.io/
|
25
25
|
* [YARD API documentation](https://www.rubydoc.info/gems/pry)
|
26
26
|
* [Wiki](https://github.com/pry/pry/wiki)
|
27
27
|
|
@@ -38,7 +38,6 @@ Table of Contents
|
|
38
38
|
* [Command Shell Integration](#command-shell-integration)
|
39
39
|
* [Code Browsing](#code-browsing)
|
40
40
|
* [Documentation Browsing](#documentation-browsing)
|
41
|
-
* [Gist integration](#gist-integration)
|
42
41
|
* [Edit methods](#edit-methods)
|
43
42
|
* [Live Help System](#live-help-system)
|
44
43
|
* [Use Pry as your Rails Console](#use-pry-as-your-rails-console)
|
@@ -208,7 +207,7 @@ hello world!
|
|
208
207
|
pry(main)> def a.goodbye
|
209
208
|
pry(main)* puts "goodbye cruel world!"
|
210
209
|
pry(main)* end
|
211
|
-
=>
|
210
|
+
=> :goodbye
|
212
211
|
pry(main)> a.goodbye
|
213
212
|
goodbye cruel world!
|
214
213
|
=> nil
|
@@ -266,23 +265,26 @@ syntax and also simply the name of a method that's in scope. You can optionally
|
|
266
265
|
pass the `-l` option to `show-source` to include line numbers in the output.
|
267
266
|
|
268
267
|
In the following example we will enter the `Pry` class, list the instance
|
269
|
-
methods beginning with '
|
268
|
+
methods beginning with 'se' and display the source code for the `set_last_result` method:
|
270
269
|
|
271
270
|
```ruby
|
272
271
|
pry(main)> cd Pry
|
273
|
-
pry(Pry):1> ls -M --grep
|
274
|
-
Pry#methods:
|
275
|
-
pry(Pry):1> show-source
|
276
|
-
|
277
|
-
From: /home/john/ruby/projects/pry/lib/pry/pry_instance.rb:
|
272
|
+
pry(Pry):1> ls -M --grep se
|
273
|
+
Pry#methods: raise_up raise_up! raise_up_common reset_eval_string select_prompt set_last_result
|
274
|
+
pry(Pry):1> show-source set_last_result -l
|
275
|
+
|
276
|
+
From: /home/john/ruby/projects/pry/lib/pry/pry_instance.rb:405:
|
277
|
+
Owner: Pry
|
278
|
+
Visibility: public
|
279
|
+
Signature: set_last_result(result, code=?)
|
278
280
|
Number of lines: 6
|
279
281
|
|
280
|
-
|
281
|
-
|
282
|
-
|
283
|
-
|
284
|
-
|
285
|
-
|
282
|
+
405: def set_last_result(result, code = "")
|
283
|
+
406: @last_result_is_exception = false
|
284
|
+
407: @output_ring << result
|
285
|
+
408:
|
286
|
+
409: self.last_result = result unless code =~ /\A\s*\z/
|
287
|
+
410: end
|
286
288
|
```
|
287
289
|
|
288
290
|
Note that we can also view C methods (from Ruby Core) using the
|
@@ -317,7 +319,7 @@ rb_ary_select(VALUE ary)
|
|
317
319
|
One use-case for Pry is to explore a program at run-time by `cd`-ing in and out
|
318
320
|
of objects and viewing and invoking methods. In the course of exploring it may
|
319
321
|
be useful to read the documentation for a specific method that you come
|
320
|
-
across.
|
322
|
+
across. `show-source` command supports two syntaxes - the
|
321
323
|
normal `ri` syntax as well as accepting the name of any method that is currently
|
322
324
|
in scope.
|
323
325
|
|
@@ -339,14 +341,26 @@ In our example we will enter the `Gem` class and view the documentation for the
|
|
339
341
|
|
340
342
|
```ruby
|
341
343
|
pry(main)> cd Gem
|
342
|
-
pry(Gem):1> show-
|
344
|
+
pry(Gem):1> show-source try_activate -d
|
343
345
|
|
344
|
-
From: /Users/john
|
345
|
-
|
346
|
+
From: /Users/john/rbenv/versions/2.7.1/lib/ruby/2.7.0/rubygems.rb:194:
|
347
|
+
Owner: #<Class:Gem>
|
348
|
+
Visibility: public
|
349
|
+
Signature: try_activate(path)
|
350
|
+
Number of lines: 28
|
346
351
|
|
347
352
|
Try to activate a gem containing path. Returns true if
|
348
353
|
activation succeeded or wasn't needed because it was already
|
349
354
|
activated. Returns false if it can't find the path in a gem.
|
355
|
+
|
356
|
+
def self.try_activate(path)
|
357
|
+
# finds the _latest_ version... regardless of loaded specs and their deps
|
358
|
+
# if another gem had a requirement that would mean we shouldn't
|
359
|
+
# activate the latest version, then either it would already be activated
|
360
|
+
# or if it was ambiguous (and thus unresolved) the code in our custom
|
361
|
+
# require will try to activate the more specific version.
|
362
|
+
|
363
|
+
spec = Gem::Specification.find_by_path path
|
350
364
|
pry(Gem):1>
|
351
365
|
```
|
352
366
|
|
@@ -427,8 +441,8 @@ putting the line `Pry.color = false` in your `pryrc` file.
|
|
427
441
|
Supported Rubies
|
428
442
|
----------------
|
429
443
|
|
430
|
-
* CRuby >=
|
431
|
-
* JRuby >=
|
444
|
+
* CRuby >= 2.0.0
|
445
|
+
* JRuby >= 9.0
|
432
446
|
|
433
447
|
Contact
|
434
448
|
-------
|
File without changes
|
File without changes
|
File without changes
|