Method: Sink::Client#initialize

Defined in:

lib/sink/client.rb

#initialize(environment: nil, base_url: nil, user_token: nil, api_key_header: nil, api_key_query: nil, username: nil, client_id: nil, client_secret: nil, some_boolean_arg: nil, some_integer_arg: nil, some_number_arg: nil, some_number_arg_required: nil, some_number_arg_required_no_default: nil, some_number_arg_required_no_default_no_env: nil, required_arg_no_env: nil, required_arg_no_env_with_default: nil, client_path_param: nil, camel_case_path: nil, client_query_param: nil, client_path_or_query_param: nil, max_retries: DEFAULT_MAX_RETRIES, timeout: 60) ⇒ Sink::Client

Creates and returns a new client for interacting with the API.

Parameters:

• environment ("production", "sandbox", nil) (defaults to: nil) —

  Specifies the environment to use for the API.

  Each environment maps to a different base URL:

  • ‘production` corresponds to `demo.stainlessapi.com/`

  • ‘sandbox` corresponds to `demo-sanbox.stainlessapi.com/`

• base_url (String, nil) (defaults to: nil) —

  Override the default base URL for the API, e.g., ‘“api.example.com/v2/”`

• user_token (String, nil) (defaults to: nil) —

  The API Key for the SINK API, sent as a bearer token Defaults to ‘ENV`

• api_key_header (String, nil) (defaults to: nil) —

  The API Key for the SINK API, sent as an api key header Defaults to ‘ENV`

• api_key_query (String, nil) (defaults to: nil) —

  The API Key for the SINK API, sent as an api key query Defaults to ‘ENV`

• username (String, nil) (defaults to: nil) —

  Defaults to ‘ENV`

• client_id (String, nil) (defaults to: nil) —

  Defaults to ‘ENV`

• client_secret (String, nil) (defaults to: nil) —

  Defaults to ‘ENV`

• some_boolean_arg (Boolean, nil) (defaults to: nil) —

  Defaults to ‘ENV`

• some_integer_arg (Integer, nil) (defaults to: nil) —

  Defaults to ‘ENV`

• some_number_arg (Float, nil) (defaults to: nil) —

  Defaults to ‘ENV`

• some_number_arg_required (Float, nil) (defaults to: nil) —

  Defaults to ‘ENV`

• some_number_arg_required_no_default (Float, nil) (defaults to: nil) —

  Defaults to ‘ENV`

• some_number_arg_required_no_default_no_env (Float, nil) (defaults to: nil)
• required_arg_no_env (String, nil) (defaults to: nil)
• required_arg_no_env_with_default (String, nil) (defaults to: nil)
• client_path_param (String, nil) (defaults to: nil)
• camel_case_path (String, nil) (defaults to: nil)
• client_query_param (String, nil) (defaults to: nil)
• client_path_or_query_param (String, nil) (defaults to: nil)
• max_retries (Integer) (defaults to: DEFAULT_MAX_RETRIES) —

  Max number of retries to attempt after a failed retryable request.

# File 'lib/sink/client.rb', line 236

def initialize(
  environment: nil,
  base_url: nil,
  user_token: nil,
  api_key_header: nil,
  api_key_query: nil,
  username: nil,
  client_id: nil,
  client_secret: nil,
  some_boolean_arg: nil,
  some_integer_arg: nil,
  some_number_arg: nil,
  some_number_arg_required: nil,
  some_number_arg_required_no_default: nil,
  some_number_arg_required_no_default_no_env: nil,
  required_arg_no_env: nil,
  required_arg_no_env_with_default: nil,
  client_path_param: nil,
  camel_case_path: nil,
  client_query_param: nil,
  client_path_or_query_param: nil,
  max_retries: DEFAULT_MAX_RETRIES,
  timeout: 60
)
  environments = {"production" => "https://demo.stainlessapi.com/", "sandbox" => "https://demo-sanbox.stainlessapi.com/"}
  if environment && base_url
    raise ArgumentError, "both environment and base_url given, expected only one"
  elsif environment
    if !environments.key?(environment.to_s)
      raise ArgumentError, "environment must be one of #{environments.keys}, got #{environment}"
    end
    base_url = environments[environment.to_s]
  elsif !base_url
    base_url = "https://demo.stainlessapi.com/"
  end

  username_header = [username, ENV["SINK_USER"]].find { |v| !v.nil? }
  if username_header.nil?
    raise ArgumentError, "username is required"
  end
  client_secret_header = [client_secret, ENV["SINK_CLIENT_SECRET"], "hellosecret"].find { |v| !v.nil? }
  some_integer_arg_header = [some_integer_arg, ENV["SINK_SOME_INTEGER_ARG"], 123].find { |v| !v.nil? }
  headers = {
    "My-Api-Version" => "11",
    "X-Enable-Metrics" => "1",
    "X-Client-UserName" => username_header,
    "X-Client-Secret" => client_secret_header,
    "X-Integer" => some_integer_arg_header
  }

  idempotency_header = "Idempotency-Key"

  @user_token = [user_token, ENV["SINK_CUSTOM_API_KEY_ENV"]].find { |v| !v.nil? }
  @api_key_header = [api_key_header, ENV["SINK_CUSTOM_API_KEY_HEADER_ENV"]].find { |v| !v.nil? }
  @api_key_query = [api_key_query, ENV["SINK_CUSTOM_API_KEY_QUERY_ENV"]].find { |v| !v.nil? }
  @client_id = [client_id, ENV["SINK_CLIENT_ID"]].find { |v| !v.nil? }
  @some_boolean_arg = [some_boolean_arg, ENV["SINK_SOME_BOOLEAN_ARG"], true].find { |v| !v.nil? }
  @some_number_arg = [some_number_arg, ENV["SINK_SOME_NUMBER_ARG"], 1.2].find { |v| !v.nil? }
  @some_number_arg_required = [some_number_arg_required, ENV["SINK_SOME_NUMBER_ARG"], 1.2].find do |v|
    !v.nil?
  end
  @some_number_arg_required_no_default = [
    some_number_arg_required_no_default,
    ENV["SINK_SOME_NUMBER_ARG"]
  ].find do |v|
    !v.nil?
  end
  if @some_number_arg_required_no_default.nil?
    raise ArgumentError, "some_number_arg_required_no_default is required"
  end
  @some_number_arg_required_no_default_no_env = some_number_arg_required_no_default_no_env
  if @some_number_arg_required_no_default_no_env.nil?
    raise ArgumentError, "some_number_arg_required_no_default_no_env is required"
  end
  @required_arg_no_env = required_arg_no_env
  if @required_arg_no_env.nil?
    raise ArgumentError, "required_arg_no_env is required"
  end
  @required_arg_no_env_with_default = [required_arg_no_env_with_default, "hi!"].find { |v| !v.nil? }
  @client_query_param = client_query_param

  super(
    base_url: base_url,
    max_retries: max_retries,
    timeout: timeout,
    headers: headers,
    idempotency_header: idempotency_header
  )

  @testing = Sink::Resources::Testing.new(client: self)
  @complex_queries = Sink::Resources::ComplexQueries.new(client: self)
  @casing = Sink::Resources::Casing.new(client: self)
  @tools = Sink::Resources::Tools.new(client: self)
  @undocumented_resource = Sink::Resources::UndocumentedResource.new(client: self)
  @method_config = Sink::Resources::MethodConfig.new(client: self)
  @streaming = Sink::Resources::Streaming.new(client: self)
  @pagination_tests = Sink::Resources::PaginationTests.new(client: self)
  @docstrings = Sink::Resources::Docstrings.new(client: self)
  @invalid_schemas = Sink::Resources::InvalidSchemas.new(client: self)
  @resource_refs = Sink::Resources::ResourceRefs.new(client: self)
  @cards = Sink::Resources::Cards.new(client: self)
  @files = Sink::Resources::Files.new(client: self)
  @resources = Sink::Resources::Resources.new(client: self)
  @config_tools = Sink::Resources::ConfigTools.new(client: self)
  @company = Sink::Resources::Company.new(client: self)
  @openapi_formats = Sink::Resources::OpenAPIFormats.new(client: self)
  @parent = Sink::Resources::Parent.new(client: self)
  @envelopes = Sink::Resources::Envelopes.new(client: self)
  @types = Sink::Resources::Types.new(client: self)
  @clients = Sink::Resources::Clients.new(client: self)
  @names = Sink::Resources::Names.new(client: self)
  @widgets = Sink::Resources::Widgets.new(client: self)
  @responses = Sink::Resources::Responses.new(client: self)
  @path_params = Sink::Resources::PathParams.new(client: self)
  @positional_params = Sink::Resources::PositionalParams.new(client: self)
  @empty_body = Sink::Resources::EmptyBody.new(client: self)
  @query_params = Sink::Resources::QueryParams.new(client: self)
  @body_params = Sink::Resources::BodyParams.new(client: self)
  @header_params = Sink::Resources::HeaderParams.new(client: self)
  @mixed_params = Sink::Resources::MixedParams.new(client: self)
  @make_ambiguous_schemas_looser = Sink::Resources::MakeAmbiguousSchemasLooser.new(client: self)
  @make_ambiguous_schemas_explicit = Sink::Resources::MakeAmbiguousSchemasExplicit.new(client: self)
  @decorator_tests = Sink::Resources::DecoratorTests.new(client: self)
  @tests = Sink::Resources::Tests.new(client: self)
  @deeply_nested = Sink::Resources::DeeplyNested.new(client: self)
  @version_1_30_names = Sink::Resources::Version1_30Names.new(client: self)
  @recursion = Sink::Resources::Recursion.new(client: self)
  @shared_query_params = Sink::Resources::SharedQueryParams.new(client: self)
  @model_referenced_in_parent_and_child = Sink::Resources::ModelReferencedInParentAndChild.new(client: self)
end