test-test-sink-test-test 0.0.2.pre.alpha.0

data/lib/sink/resources/body_params.rb

@@ -0,0 +1,630 @@
+# frozen_string_literal: true
+
+module Sink
+  module Resources
+    class BodyParams
+      # @return [Sink::Resources::BodyParams::Objects]
+      attr_reader :objects
+
+      # @return [Sink::Resources::BodyParams::Unions]
+      attr_reader :unions
+
+      # @param client [Sink::Client]
+      def initialize(client:)
+        @client = client
+        @objects = Sink::Resources::BodyParams::Objects.new(client: client)
+        @unions = Sink::Resources::BodyParams::Unions.new(client: client)
+      end
+
+      # Endpoint with a `requestBody` that has an `type: string` schema and content
+      #   `application/octet-stream` that is defined as a model in the config.
+      #
+      # @param params [Hash{Symbol => Object}] Attributes to send in this request.
+      #   @option params [String] :binary_string_body
+      #
+      # @param opts [Hash, Sink::RequestOptions] Options to specify HTTP behaviour for this request.
+      #
+      # @return [nil]
+      def binary_string_type(params = {}, opts = {})
+        req = {
+          method: :post,
+          path: "/body_params/binary_string_type",
+          body: params[:binary_string_body],
+          headers: {"Content-Type" => "application/octet-stream"},
+          model: NilClass
+        }
+        @client.request(req, opts)
+      end
+
+      # An edge case where there are nested sub-properties of the same name with
+      #   possible clashes.
+      #
+      # @param params [Hash{Symbol => Object}] Attributes to send in this request.
+      #   @option params [Baz, nil] :baz
+      #   @option params [Foo, nil] :foo
+      #   @option params [FooBar, nil] :foo_bar
+      #   @option params [Mapping, nil] :mapping
+      #   @option params [Array<Mapping>, nil] :mappings
+      #
+      # @param opts [Hash, Sink::RequestOptions] Options to specify HTTP behaviour for this request.
+      #
+      # @return [Sink::Models::ModelWithNestedModel]
+      def duplicate_subproperty(params = {}, opts = {})
+        req = {
+          method: :post,
+          path: "/body_params/with_duplicate_subproperty",
+          body: params,
+          headers: {"Content-Type" => "application/json"},
+          model: Sink::Models::ModelWithNestedModel
+        }
+        @client.request(req, opts)
+      end
+
+      # Endpoint with a `requestBody` with various enums properties
+      #
+      # @param params [Hash{Symbol => Object}] Attributes to send in this request.
+      #   @option params [Integer, nil] :code
+      #   @option params [Float, nil] :cost
+      #   @option params [Boolean, nil] :enabled
+      #   @option params [Symbol, Kind, nil] :kind
+      #
+      # @param opts [Hash, Sink::RequestOptions] Options to specify HTTP behaviour for this request.
+      #
+      # @return [nil]
+      def enum_properties(params = {}, opts = {})
+        req = {
+          method: :post,
+          path: "/body_params/enum_properties",
+          body: params,
+          headers: {"Content-Type" => "application/json"},
+          model: NilClass
+        }
+        @client.request(req, opts)
+      end
+
+      # Should return a ModelWithNestedModel object with a `properties` field that we
+      #   can rename in the Stainless config to a prettier name.
+      #
+      # @param params [Hash{Symbol => Object}] Attributes to send in this request.
+      #   @option params [Sink::Models::NestedRequestModelA, nil] :data
+      #
+      # @param opts [Hash, Sink::RequestOptions] Options to specify HTTP behaviour for this request.
+      #
+      # @return [Sink::Models::ModelWithNestedModel]
+      def nested_request_models(params = {}, opts = {})
+        req = {
+          method: :post,
+          path: "/body_params/with_nested_models",
+          body: params,
+          headers: {"Content-Type" => "application/json"},
+          model: Sink::Models::ModelWithNestedModel
+        }
+        @client.request(req, opts)
+      end
+
+      # Endpoint with a `requestBody` that has an `type: null` schema that is defined as
+      #   a model in the config.
+      #
+      # @param params [Hash{Symbol => Object}] Attributes to send in this request.
+      #   @option params [String] :name
+      #   @option params [nil] :null_type_prop
+      #
+      # @param opts [Hash, Sink::RequestOptions] Options to specify HTTP behaviour for this request.
+      #
+      # @return [nil]
+      def null_type(params = {}, opts = {})
+        req = {
+          method: :post,
+          path: "/body_params/null_type",
+          body: params,
+          headers: {"Content-Type" => "application/json"},
+          model: NilClass
+        }
+        @client.request(req, opts)
+      end
+
+      # Endpoint with a `requestBody` that has an `additionalProperties` object schema
+      #   that is defined as a model in the config.
+      #
+      # @param params [Hash{Symbol => Object}] Attributes to send in this request.
+      #   @option params [Hash] :model_ref
+      #   @option params [String] :name
+      #
+      # @param opts [Hash, Sink::RequestOptions] Options to specify HTTP behaviour for this request.
+      #
+      # @return [nil]
+      def object_map_model_ref(params = {}, opts = {})
+        req = {
+          method: :post,
+          path: "/body_params/object_map_model_ref",
+          body: params,
+          headers: {"Content-Type" => "application/json"},
+          model: NilClass
+        }
+        @client.request(req, opts)
+      end
+
+      # Endpoint with an object `requestBody` that has an array property with `object`
+      #   items.
+      #
+      # @param params [Hash{Symbol => Object}] Attributes to send in this request.
+      #   @option params [Array<ArrayProp>, nil] :array_prop
+      #
+      # @param opts [Hash, Sink::RequestOptions] Options to specify HTTP behaviour for this request.
+      #
+      # @return [nil]
+      def object_with_array_of_objects(params = {}, opts = {})
+        req = {
+          method: :post,
+          path: "/body_params/object_with_array_of_objects",
+          body: params,
+          headers: {"Content-Type" => "application/json"},
+          model: NilClass
+        }
+        @client.request(req, opts)
+      end
+
+      # Endpoint with an object `requestBody` that has properties with union types.
+      #
+      # @param params [Hash{Symbol => Object}] Attributes to send in this request.
+      #   @option params [Bar::UnnamedTypeWithunionParent8, Sink::Models::SimpleObject] :bar
+      #   @option params [Boolean, Float, Object, String] :foo
+      #
+      # @param opts [Hash, Sink::RequestOptions] Options to specify HTTP behaviour for this request.
+      #
+      # @return [nil]
+      def object_with_union_properties(params = {}, opts = {})
+        req = {
+          method: :post,
+          path: "/body_params/object_with_union_properties",
+          body: params,
+          headers: {"Content-Type" => "application/json"},
+          model: NilClass
+        }
+        @client.request(req, opts)
+      end
+
+      # Endpoint with a `requestBody` that only has `readOnly` properties
+      #
+      # @param opts [Hash, Sink::RequestOptions] Options to specify HTTP behaviour for this request.
+      #
+      # @return [nil]
+      def only_read_only_properties(opts = {})
+        req = {
+          method: :patch,
+          path: "/body_params/only_read_only_properties",
+          headers: {"Content-Type" => "application/json"},
+          model: NilClass
+        }
+        @client.request(req, opts)
+      end
+
+      # Endpoint with a `requestBody` that has a schema that is defined as a model in
+      #   the config with "param" in the name.
+      #
+      # @param params [Hash{Symbol => Object}] Attributes to send in this request.
+      #   @option params [Hash] :model_ref
+      #   @option params [String] :name
+      #
+      # @param opts [Hash, Sink::RequestOptions] Options to specify HTTP behaviour for this request.
+      #
+      # @return [nil]
+      def param_in_model_name_ref(params = {}, opts = {})
+        req = {
+          method: :post,
+          path: "/body_params/param_in_model_name_ref",
+          body: params,
+          headers: {"Content-Type" => "application/json"},
+          model: NilClass
+        }
+        @client.request(req, opts)
+      end
+
+      # Endpoint with a `requestBody` that has a property that is defined as a model in
+      #   the config.
+      #
+      # @param params [Hash{Symbol => Object}] Attributes to send in this request.
+      #   @option params [Sink::Models::MyModel] :model_ref
+      #   @option params [String] :name
+      #
+      # @param opts [Hash, Sink::RequestOptions] Options to specify HTTP behaviour for this request.
+      #
+      # @return [nil]
+      def property_model_ref(params = {}, opts = {})
+        req = {
+          method: :post,
+          path: "/body_params/property_model_ref",
+          body: params,
+          headers: {"Content-Type" => "application/json"},
+          model: NilClass
+        }
+        @client.request(req, opts)
+      end
+
+      # Endpoint with a `requestBody` that has a property that is a union type of
+      #   complex types.
+      #
+      # @param params [Hash{Symbol => Object}] Attributes to send in this request.
+      #   @option params [String] :name
+      #   @option params [Unions::UnnamedTypeWithunionParent10, Unions::UnnamedTypeWithunionParent9] :unions This is an object with required properties
+      #
+      # @param opts [Hash, Sink::RequestOptions] Options to specify HTTP behaviour for this request.
+      #
+      # @return [nil]
+      def property_with_complex_union(params = {}, opts = {})
+        req = {
+          method: :post,
+          path: "/body_params/property_with_complex_union",
+          body: params,
+          headers: {"Content-Type" => "application/json"},
+          model: NilClass
+        }
+        @client.request(req, opts)
+      end
+
+      # Endpoint with a `requestBody` that has a property that is a union type of
+      #   complex types with a lot of nesting.
+      #
+      # @param params [Hash{Symbol => Object}] Attributes to send in this request.
+      #   @option params [Array<Filter::UnnamedTypeWithunionParent11, Filter::UnnamedTypeWithunionParent12>, nil] :filters
+      #
+      # @param opts [Hash, Sink::RequestOptions] Options to specify HTTP behaviour for this request.
+      #
+      # @return [nil]
+      def property_with_heavily_nested_complex_union(params = {}, opts = {})
+        req = {
+          method: :post,
+          path: "/body_params/property_with_heavily_nested_complex_union",
+          body: params,
+          headers: {"Content-Type" => "application/json"},
+          model: NilClass
+        }
+        @client.request(req, opts)
+      end
+
+      # Endpoint with a `requestBody` that sets `readOnly` to `true` on top level
+      #   properties
+      #
+      # @param params [Hash{Symbol => Object}] Attributes to send in this request.
+      #   @option params [Boolean, nil] :in_both
+      #
+      # @param opts [Hash, Sink::RequestOptions] Options to specify HTTP behaviour for this request.
+      #
+      # @return [nil]
+      def read_only_properties(params = {}, opts = {})
+        req = {
+          method: :post,
+          path: "/body_params/read_only_properties",
+          body: params,
+          headers: {"Content-Type" => "application/json"},
+          model: NilClass
+        }
+        @client.request(req, opts)
+      end
+
+      # Endpoint with a `requestBody` that has an `additionalProperties` string schema
+      #   that is defined as a model in the config.
+      #
+      # @param params [Hash{Symbol => Object}] Attributes to send in this request.
+      #   @option params [Hash] :model_ref
+      #   @option params [String] :name
+      #
+      # @param opts [Hash, Sink::RequestOptions] Options to specify HTTP behaviour for this request.
+      #
+      # @return [nil]
+      def string_map_model_ref(params = {}, opts = {})
+        req = {
+          method: :post,
+          path: "/body_params/string_map_model_ref",
+          body: params,
+          headers: {"Content-Type" => "application/json"},
+          model: NilClass
+        }
+        @client.request(req, opts)
+      end
+
+      # Endpoint with a `requestBody` making use of allOf.
+      #
+      # @param params [Hash{Symbol => Object}] Attributes to send in this request.
+      #   @option params [Boolean] :is_foo
+      #   @option params [Symbol, Kind] :kind
+      #
+      # @param opts [Hash, Sink::RequestOptions] Options to specify HTTP behaviour for this request.
+      #
+      # @return [Sink::Models::BodyParamTopLevelAllOfResponse]
+      def top_level_all_of(params = {}, opts = {})
+        req = {
+          method: :post,
+          path: "/body_params/top_level_allOf",
+          body: params,
+          headers: {"Content-Type" => "application/json"},
+          model: Sink::Models::BodyParamTopLevelAllOfResponse
+        }
+        @client.request(req, opts)
+      end
+
+      # Endpoint with a `requestBody` making use of allOf where one of the properties is
+      #   an object type.
+      #
+      # @param params [Hash{Symbol => Object}] Attributes to send in this request.
+      #   @option params [Symbol, Kind] :kind
+      #   @option params [NestedObj, nil] :nested_obj This is an object with required properties
+      #
+      # @param opts [Hash, Sink::RequestOptions] Options to specify HTTP behaviour for this request.
+      #
+      # @return [nil]
+      def top_level_all_of_nested_object(params = {}, opts = {})
+        req = {
+          method: :post,
+          path: "/body_params/top_level_allOf_nested_object",
+          body: params,
+          headers: {"Content-Type" => "application/json"},
+          model: NilClass
+        }
+        @client.request(req, opts)
+      end
+
+      # Endpoint with a `requestBody` making use of anyOf.
+      #
+      # @param params [Hash{Symbol => Object}] Attributes to send in this request.
+      #   @option params [Symbol, Kind] :kind
+      #   @option params [Boolean] :is_foo
+      #
+      # @param opts [Hash, Sink::RequestOptions] Options to specify HTTP behaviour for this request.
+      #
+      # @return [Sink::Models::BodyParamTopLevelAnyOfResponse::UnnamedTypeWithunionParent13, Sink::Models::BodyParamTopLevelAnyOfResponse::UnnamedTypeWithunionParent14]
+      def top_level_any_of(params = {}, opts = {})
+        req = {
+          method: :post,
+          path: "/body_params/top_level_anyOf",
+          body: params,
+          headers: {"Content-Type" => "application/json"},
+          model: Sink::Unknown
+        }
+        @client.request(req, opts)
+      end
+
+      # Endpoint with a `requestBody` pointing to a $ref'd schema that is an `anyOf`.
+      #
+      # @param params [Hash{Symbol => Object}] Attributes to send in this request.
+      #   @option params [Symbol, Kind] :kind
+      #   @option params [Boolean] :is_foo
+      #
+      # @param opts [Hash, Sink::RequestOptions] Options to specify HTTP behaviour for this request.
+      #
+      # @return [Sink::Models::BasicSharedModelObject]
+      def top_level_any_of_with_ref(params = {}, opts = {})
+        req = {
+          method: :post,
+          path: "/body_params/top_level_anyOf_with_ref",
+          body: params,
+          headers: {"Content-Type" => "application/json"},
+          model: Sink::Models::BasicSharedModelObject
+        }
+        @client.request(req, opts)
+      end
+
+      # Endpoint with a `requestBody` that is an `array` type.
+      #
+      # @param params [Hash{Symbol => Object}] Attributes to send in this request.
+      #   @option params [Array<Sink::Models::BasicSharedModelObject>] :items
+      #
+      # @param opts [Hash, Sink::RequestOptions] Options to specify HTTP behaviour for this request.
+      #
+      # @return [nil]
+      def top_level_array(params = {}, opts = {})
+        req = {
+          method: :post,
+          path: "/body_params/top_level_array",
+          body: params[:items],
+          headers: {"Content-Type" => "application/json"},
+          model: NilClass
+        }
+        @client.request(req, opts)
+      end
+
+      # Endpoint with a `requestBody` that is an `array` type with non-model children.
+      #
+      # @param params [Hash{Symbol => Object}] Attributes to send in this request.
+      #   @option params [Array<Item>] :items
+      #
+      # @param opts [Hash, Sink::RequestOptions] Options to specify HTTP behaviour for this request.
+      #
+      # @return [nil]
+      def top_level_array_with_children(params = {}, opts = {})
+        req = {
+          method: :post,
+          path: "/body_params/top_level_array_with_children",
+          body: params[:items],
+          headers: {"Content-Type" => "application/json"},
+          model: NilClass
+        }
+        @client.request(req, opts)
+      end
+
+      # Endpoint with a `requestBody` that is an `array` type.
+      #
+      # @param params [Hash{Symbol => Object}] Attributes to send in this request.
+      #   @option params [String] :id Query param:
+      #   @option params [Array<Sink::Models::BasicSharedModelObject>] :items Body param:
+      #
+      # @param opts [Hash, Sink::RequestOptions] Options to specify HTTP behaviour for this request.
+      #
+      # @return [nil]
+      def top_level_array_with_other_params(params = {}, opts = {})
+        req = {
+          method: :post,
+          path: "/body_params/top_level_array_with_other_params",
+          body: params[:items],
+          query: params.except(:items),
+          headers: {"Content-Type" => "application/json"},
+          model: NilClass
+        }
+        @client.request(req, opts)
+      end
+
+      # Endpoint with a `requestBody` making use of oneOf.
+      #
+      # @param params [Hash{Symbol => Object}] Attributes to send in this request.
+      #   @option params [Symbol, Kind] :kind
+      #   @option params [Boolean] :is_foo
+      #
+      # @param opts [Hash, Sink::RequestOptions] Options to specify HTTP behaviour for this request.
+      #
+      # @return [Sink::Models::BodyParamTopLevelOneOfResponse::UnnamedTypeWithunionParent15, Sink::Models::BodyParamTopLevelOneOfResponse::UnnamedTypeWithunionParent16]
+      def top_level_one_of(params = {}, opts = {})
+        req = {
+          method: :post,
+          path: "/body_params/top_level_oneOf",
+          body: params,
+          headers: {"Content-Type" => "application/json"},
+          model: Sink::Unknown
+        }
+        @client.request(req, opts)
+      end
+
+      # Endpoint with a `requestBody` making use of oneOf but only contains one entry in
+      #   the union.
+      #
+      # @param params [Hash{Symbol => Object}] Attributes to send in this request.
+      #   @option params [Symbol, Kind] :kind
+      #
+      # @param opts [Hash, Sink::RequestOptions] Options to specify HTTP behaviour for this request.
+      #
+      # @return [nil]
+      def top_level_one_of_one_entry(params = {}, opts = {})
+        req = {
+          method: :post,
+          path: "/body_params/top_level_oneOf_one_entry",
+          body: params,
+          headers: {"Content-Type" => "application/json"},
+          model: NilClass
+        }
+        @client.request(req, opts)
+      end
+
+      # The request body being set to a $ref that is a shared type in the stainless
+      #   config correctly references it.
+      #
+      # @param params [Hash{Symbol => Object}] Attributes to send in this request.
+      #   @option params [Sink::Models::SimpleObject, nil] :bar
+      #   @option params [String, nil] :foo
+      #
+      # @param opts [Hash, Sink::RequestOptions] Options to specify HTTP behaviour for this request.
+      #
+      # @return [nil]
+      def top_level_shared_type(params = {}, opts = {})
+        req = {
+          method: :post,
+          path: "/body_params/top_level_shared_type",
+          body: params,
+          headers: {"Content-Type" => "application/json"},
+          model: NilClass
+        }
+        @client.request(req, opts)
+      end
+
+      # Endpoint with a `requestBody` making use of anyOf where the same property is
+      #   defined in both variants.
+      #
+      # @param params [Hash{Symbol => Object}] Attributes to send in this request.
+      #   @option params [Boolean, nil] :foo FOO 2
+      #
+      # @param opts [Hash, Sink::RequestOptions] Options to specify HTTP behaviour for this request.
+      #
+      # @return [Sink::Models::BodyParamUnionOverlappingPropResponse]
+      def union_overlapping_prop(params = {}, opts = {})
+        req = {
+          method: :post,
+          path: "/body_params/top_level_anyOf_overlapping_property",
+          body: params,
+          headers: {"Content-Type" => "application/json"},
+          model: Sink::Models::BodyParamUnionOverlappingPropResponse
+        }
+        @client.request(req, opts)
+      end
+
+      # Endpoint with a `requestBody` that has an untyped object schema that is defined
+      #   as a model in the config.
+      #
+      # @param params [Hash{Symbol => Object}] Attributes to send in this request.
+      #   @option params [String] :name
+      #   @option params [Object] :unknown_object_prop
+      #
+      # @param opts [Hash, Sink::RequestOptions] Options to specify HTTP behaviour for this request.
+      #
+      # @return [nil]
+      def unknown_object(params = {}, opts = {})
+        req = {
+          method: :post,
+          path: "/body_params/unknown_object",
+          body: params,
+          headers: {"Content-Type" => "application/json"},
+          model: NilClass
+        }
+        @client.request(req, opts)
+      end
+
+      # Endpoint with an optional request property that has a default value set.
+      #
+      # @param params [Hash{Symbol => Object}] Attributes to send in this request.
+      #   @option params [String, nil] :my_version_body_param
+      #   @option params [Boolean, nil] :normal_param
+      #
+      # @param opts [Hash, Sink::RequestOptions] Options to specify HTTP behaviour for this request.
+      #
+      # @return [nil]
+      def with_default_body_param_optional(params = {}, opts = {})
+        req = {
+          method: :post,
+          path: "/body_params/with_default_body_param_optional",
+          body: params,
+          headers: {"Content-Type" => "application/json"},
+          model: NilClass
+        }
+        @client.request(req, opts)
+      end
+
+      # Endpoint with a required request property that has a default value set.
+      #
+      # @param params [Hash{Symbol => Object}] Attributes to send in this request.
+      #   @option params [String] :my_version_body_param
+      #   @option params [Boolean] :normal_param
+      #
+      # @param opts [Hash, Sink::RequestOptions] Options to specify HTTP behaviour for this request.
+      #
+      # @return [nil]
+      def with_default_body_param_required(params = {}, opts = {})
+        req = {
+          method: :post,
+          path: "/body_params/with_default_body_param_required",
+          body: params,
+          headers: {"Content-Type" => "application/json"},
+          model: NilClass
+        }
+        @client.request(req, opts)
+      end
+
+      # Endpoint with a request body that contains a property that points to a model
+      #   reference.
+      #
+      # @param params [Hash{Symbol => Object}] Attributes to send in this request.
+      #   @option params [String, nil] :foo
+      #   @option params [Sink::Models::MyModel, nil] :my_model
+      #
+      # @param opts [Hash, Sink::RequestOptions] Options to specify HTTP behaviour for this request.
+      #
+      # @return [nil]
+      def with_model_property(params = {}, opts = {})
+        req = {
+          method: :post,
+          path: "/body_params/with_model_property",
+          body: params,
+          headers: {"Content-Type" => "application/json"},
+          model: NilClass
+        }
+        @client.request(req, opts)
+      end
+    end
+  end
+end