primary_connect_client 1.12.0 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc7c8d64d34288e19f3be0333f90299472f061ac3479970b6de8bf5a62d15f4b
-  data.tar.gz: abadc44e5964ac49d732947e68d9b12231c617c549d57960d55bf2e8031a8549
+  metadata.gz: 6aa696f97be55a4e2eff939984ea8379dd7f1365601a934bfe150f00a3cc05a3
+  data.tar.gz: ee004bc59cffb65da2049acc9c97d557d5dc03f85cebb1b552f003c9a730bb16
 SHA512:
-  metadata.gz: 4390f1caf05f6341f6717d4998aac5bd50d85aa3e0db39fafcf315ad039afde47a568a0ad87e2749001ae9a4af95fa006c422d72b0a70270916bed2f3bf3902d
-  data.tar.gz: 2368fb916550e41c397a39c85ebaa1191ec7178cd5dd8aa490144462bdde681d1583845ee74a58ec4ac69799f0a284075fe899b6659a0c908305a65a1571ada8
+  metadata.gz: aed7c6835ee808f9208a4dc471b3acc10d441f44ed9c847e8b3940942b7f9e0de2535e4519f163e397d656e459b7255c01809b7ca2c70a4b2e3325ccc9580da2
+  data.tar.gz: 73b80491f7a8eed883da692e5199799c231f2f10f7351bc0caee23b52703b9f793be921805b90385443ff22bda3ec62a21f93667216b1b222f0ae391b03c7616

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## 1.13.0
+
+- Added Queries API
+
 ## 1.12.0
 
 - Updated dependency on `primary_connect_proto` 0.24.0

data/README.md

@@ -7,7 +7,7 @@ Client Library to interface with Primary Connect
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: v1
-- Package version: 1.12.0
+- Package version: 1.13.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -23,16 +23,16 @@ gem build primary_connect_client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./primary_connect_client-1.12.0.gem
+gem install ./primary_connect_client-1.13.0.gem
 ```
 
-(for development, run `gem install --dev ./primary_connect_client-1.12.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./primary_connect_client-1.13.0.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'primary_connect_client', '~> 1.12.0'
+    gem 'primary_connect_client', '~> 1.13.0'
 
 ### Install from Git
 
@@ -97,6 +97,7 @@ Class | Method | HTTP request | Description
 *PrimaryConnectClient::DefaultApi* | [**list_results**](docs/DefaultApi.md#list_results) | **GET** /api/v1/orders/{order_id}/results | list results
 *PrimaryConnectClient::DefaultApi* | [**reroute_order**](docs/DefaultApi.md#reroute_order) | **POST** /api/v1/orders/reroute | reroute Order identified in the payload
 *PrimaryConnectClient::DefaultApi* | [**reroute_order_by_ulid**](docs/DefaultApi.md#reroute_order_by_ulid) | **POST** /api/v1/orders/{id}/reroute | Reroute order by ULID
+*PrimaryConnectClient::DefaultApi* | [**send_query**](docs/DefaultApi.md#send_query) | **POST** /api/v1/queries | send query
 *PrimaryConnectClient::DefaultApi* | [**update_order**](docs/DefaultApi.md#update_order) | **PUT** /api/v1/orders/{id} | update order
 
 
@@ -105,6 +106,7 @@ Class | Method | HTTP request | Description
  - [PrimaryConnectClient::Accession](docs/Accession.md)
  - [PrimaryConnectClient::AccessionOrder](docs/AccessionOrder.md)
  - [PrimaryConnectClient::Address](docs/Address.md)
+ - [PrimaryConnectClient::Candidates](docs/Candidates.md)
  - [PrimaryConnectClient::CodedValue](docs/CodedValue.md)
  - [PrimaryConnectClient::Demographics](docs/Demographics.md)
  - [PrimaryConnectClient::Device](docs/Device.md)
@@ -114,6 +116,7 @@ Class | Method | HTTP request | Description
  - [PrimaryConnectClient::Events](docs/Events.md)
  - [PrimaryConnectClient::Identifier](docs/Identifier.md)
  - [PrimaryConnectClient::Ids](docs/Ids.md)
+ - [PrimaryConnectClient::Immunizations](docs/Immunizations.md)
  - [PrimaryConnectClient::Location](docs/Location.md)
  - [PrimaryConnectClient::Measurement](docs/Measurement.md)
  - [PrimaryConnectClient::Medication](docs/Medication.md)
@@ -140,6 +143,7 @@ Class | Method | HTTP request | Description
  - [PrimaryConnectClient::Patient](docs/Patient.md)
  - [PrimaryConnectClient::PhoneNumber](docs/PhoneNumber.md)
  - [PrimaryConnectClient::Provider](docs/Provider.md)
+ - [PrimaryConnectClient::Query](docs/Query.md)
  - [PrimaryConnectClient::Result](docs/Result.md)
  - [PrimaryConnectClient::ResultIds](docs/ResultIds.md)
  - [PrimaryConnectClient::ResultReferenceRange](docs/ResultReferenceRange.md)

data/docs/Candidates.md

@@ -0,0 +1,18 @@
+# PrimaryConnectClient::Candidates
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **candidates** | [**Array<Patient>**](Patient.md) | List of possible matches for the query | [optional] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::Candidates.new(
+  candidates: null
+)
+```
+

data/docs/CodedValue.md

@@ -7,6 +7,12 @@
 | **value** | **String** | E.g. 260373001 (SCT), 3006F (CPT), etc. | [optional] |
 | **code_set** | **String** | E.g. SCT, LN, NDC, CPT, CVX, etc. | [optional] |
 | **description** | **String** |  | [optional] |
+| **alt_value** | **String** |  | [optional] |
+| **alt_code_set** | **String** |  | [optional] |
+| **alt_description** | **String** |  | [optional] |
+| **code_set_version** | **String** |  | [optional] |
+| **alt_code_set_version** | **String** |  | [optional] |
+| **original_text** | **String** |  | [optional] |
 
 ## Example
 
@@ -16,7 +22,13 @@ require 'primary_connect_client'
 instance = PrimaryConnectClient::CodedValue.new(
   value: 260373001,
   code_set: SCT,
-  description: null
+  description: null,
+  alt_value: null,
+  alt_code_set: null,
+  alt_description: null,
+  code_set_version: null,
+  alt_code_set_version: null,
+  original_text: null
 )
 ```
 

data/docs/DefaultApi.md

@@ -18,6 +18,7 @@ All URIs are relative to *https://connect.primary.health*
 | [**list_results**](DefaultApi.md#list_results) | **GET** /api/v1/orders/{order_id}/results | list results |
 | [**reroute_order**](DefaultApi.md#reroute_order) | **POST** /api/v1/orders/reroute | reroute Order identified in the payload |
 | [**reroute_order_by_ulid**](DefaultApi.md#reroute_order_by_ulid) | **POST** /api/v1/orders/{id}/reroute | Reroute order by ULID |
+| [**send_query**](DefaultApi.md#send_query) | **POST** /api/v1/queries | send query |
 | [**update_order**](DefaultApi.md#update_order) | **PUT** /api/v1/orders/{id} | update order |
 
 
@@ -723,7 +724,10 @@ api_instance = PrimaryConnectClient::DefaultApi.new
 opts = {
   last_order_id: '01FGD30NTPNNZE9MKGMWZGHGTZ', # String | Paginate orders with order id. 26 character, sortable id.
   state: 'new,resulted', # String | Filter orders by state, comma delimited.[new, updated, delivered, processing, resulted, errored, canceled, unprocessable]
-  specimen_id: 'PB1234567' # String | Find an order by specimen/accession id. If found, will redirect to show order endpoint.
+  specimen_id: 'PB1234567', # String | Find an order by specimen/accession id. If found, will redirect to show order endpoint.
+  without_order_body: true, # Boolean | Exclude order body from the response
+  sent_only: true, # Boolean | Filter orders sent by the current entity
+  received_only: true # Boolean | Filter orders received by the current entity
 }
 
 begin
@@ -760,6 +764,9 @@ end
 | **last_order_id** | **String** | Paginate orders with order id. 26 character, sortable id. | [optional] |
 | **state** | **String** | Filter orders by state, comma delimited.[new, updated, delivered, processing, resulted, errored, canceled, unprocessable] | [optional] |
 | **specimen_id** | **String** | Find an order by specimen/accession id. If found, will redirect to show order endpoint. | [optional] |
+| **without_order_body** | **Boolean** | Exclude order body from the response | [optional] |
+| **sent_only** | **Boolean** | Filter orders sent by the current entity | [optional] |
+| **received_only** | **Boolean** | Filter orders received by the current entity | [optional] |
 
 ### Return type
 
@@ -980,6 +987,75 @@ nil (empty response body)
 - **Accept**: Not defined
 
 
+## send_query
+
+> <Immunizations> send_query(opts)
+
+send query
+
+### Examples
+
+```ruby
+require 'time'
+require 'primary_connect_client'
+# setup authorization
+PrimaryConnectClient.configure do |config|
+  # Configure Bearer authorization: bearer_auth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = PrimaryConnectClient::DefaultApi.new
+opts = {
+  query: PrimaryConnectClient::Query.new # Query | 
+}
+
+begin
+  # send query
+  result = api_instance.send_query(opts)
+  p result
+rescue PrimaryConnectClient::ApiError => e
+  puts "Error when calling DefaultApi->send_query: #{e}"
+end
+```
+
+#### Using the send_query_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Immunizations>, Integer, Hash)> send_query_with_http_info(opts)
+
+```ruby
+begin
+  # send query
+  data, status_code, headers = api_instance.send_query_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Immunizations>
+rescue PrimaryConnectClient::ApiError => e
+  puts "Error when calling DefaultApi->send_query_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **query** | [**Query**](Query.md) |  | [optional] |
+
+### Return type
+
+[**Immunizations**](Immunizations.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## update_order
 
 > <OrderIds> update_order(id, opts)

data/docs/Immunizations.md

@@ -0,0 +1,18 @@
+# PrimaryConnectClient::Immunizations
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **immunizations** | [**Array<MedicationAdministration>**](MedicationAdministration.md) | List of Immunizations | [optional] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::Immunizations.new(
+  immunizations: null
+)
+```
+

data/docs/Query.md

@@ -0,0 +1,20 @@
+# PrimaryConnectClient::Query
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **meta** | [**Meta**](Meta.md) |  | [optional] |
+| **subject** | [**Subject**](Subject.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'primary_connect_client'
+
+instance = PrimaryConnectClient::Query.new(
+  meta: null,
+  subject: null
+)
+```
+

data/lib/primary_connect_client/api/default_api.rb

@@ -647,6 +647,9 @@ module PrimaryConnectClient
     # @option opts [String] :last_order_id Paginate orders with order id. 26 character, sortable id.
     # @option opts [String] :state Filter orders by state, comma delimited.[new, updated, delivered, processing, resulted, errored, canceled, unprocessable]
     # @option opts [String] :specimen_id Find an order by specimen/accession id. If found, will redirect to show order endpoint.
+    # @option opts [Boolean] :without_order_body Exclude order body from the response
+    # @option opts [Boolean] :sent_only Filter orders sent by the current entity
+    # @option opts [Boolean] :received_only Filter orders received by the current entity
     # @return [Orders]
     def list_orders(opts = {})
       data, _status_code, _headers = list_orders_with_http_info(opts)
@@ -658,6 +661,9 @@ module PrimaryConnectClient
     # @option opts [String] :last_order_id Paginate orders with order id. 26 character, sortable id.
     # @option opts [String] :state Filter orders by state, comma delimited.[new, updated, delivered, processing, resulted, errored, canceled, unprocessable]
     # @option opts [String] :specimen_id Find an order by specimen/accession id. If found, will redirect to show order endpoint.
+    # @option opts [Boolean] :without_order_body Exclude order body from the response
+    # @option opts [Boolean] :sent_only Filter orders sent by the current entity
+    # @option opts [Boolean] :received_only Filter orders received by the current entity
     # @return [Array<(Orders, Integer, Hash)>] Orders data, response status code and response headers
     def list_orders_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -671,6 +677,9 @@ module PrimaryConnectClient
       query_params[:'last_order_id'] = opts[:'last_order_id'] if !opts[:'last_order_id'].nil?
       query_params[:'state'] = opts[:'state'] if !opts[:'state'].nil?
       query_params[:'specimen_id'] = opts[:'specimen_id'] if !opts[:'specimen_id'].nil?
+      query_params[:'without_order_body'] = opts[:'without_order_body'] if !opts[:'without_order_body'].nil?
+      query_params[:'sent_only'] = opts[:'sent_only'] if !opts[:'sent_only'].nil?
+      query_params[:'received_only'] = opts[:'received_only'] if !opts[:'received_only'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -893,6 +902,68 @@ module PrimaryConnectClient
       return data, status_code, headers
     end
 
+    # send query
+    # @param [Hash] opts the optional parameters
+    # @option opts [Query] :query 
+    # @return [Immunizations]
+    def send_query(opts = {})
+      data, _status_code, _headers = send_query_with_http_info(opts)
+      data
+    end
+
+    # send query
+    # @param [Hash] opts the optional parameters
+    # @option opts [Query] :query 
+    # @return [Array<(Immunizations, Integer, Hash)>] Immunizations data, response status code and response headers
+    def send_query_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.send_query ...'
+      end
+      # resource path
+      local_var_path = '/api/v1/queries'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'query'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Immunizations'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer_auth']
+
+      new_options = opts.merge(
+        :operation => :"DefaultApi.send_query",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#send_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # update order
     # @param id [String] Order ID
     # @param [Hash] opts the optional parameters

data/lib/primary_connect_client/models/candidates.rb

@@ -0,0 +1,221 @@
+=begin
+#Primary Connect API V1
+
+#Client Library to interface with Primary Connect
+
+The version of the OpenAPI document: v1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.3.0
+
+=end
+
+require 'date'
+require 'time'
+
+module PrimaryConnectClient
+  class Candidates
+    # List of possible matches for the query
+    attr_accessor :candidates
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'candidates' => :'candidates'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'candidates' => :'Array<Patient>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `PrimaryConnectClient::Candidates` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `PrimaryConnectClient::Candidates`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'candidates')
+        if (value = attributes[:'candidates']).is_a?(Array)
+          self.candidates = value
+        end
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          candidates == o.candidates
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [candidates].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = PrimaryConnectClient.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end