primary_connect_client 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4309e09dce97c79a423855e4868eb6c5d0b787d885bab942e1f1ce5aeabf0c2c
-  data.tar.gz: d5e06f08ac02237659e68c2faed491bbccccd9fb426b2c5f4f059ab9e1ad84e9
+  metadata.gz: 8e0055d5e48142beffc8ab7495ddc20d455c2f9c4b0dbccb34ba3e71abd7c752
+  data.tar.gz: 496b7bc07a672a590c32e7ef4f54ffe545ebf4a300d557a264fd217ccfbdce78
 SHA512:
-  metadata.gz: 53475026d49473fb26ae7adc65ab02fe735ccf81d7d042d524ca0e95fa1af189ac8ae7093d1085faec9ddc9e003e9acb215716419b8553e36a7f98158b11da9c
-  data.tar.gz: 2e5b7ca32fbfea38708e76d012fc56acd37268d91187225304ac5d9a2459cdf501f184d5707132c54737d7eae97ad27a159c099bf28562c8b73c1c17a60f7c6c
+  metadata.gz: b4e3c8339be5d814559b62ed300dd503b6ae7503334b86bf3dbf57399679b3c45193fc3745413f7c93e8a8f82150f7608e180206decd9dfafe42f230a4465dc0
+  data.tar.gz: 588ccf17788e6ead3147345242a419f066f96634e43756cba7dabbc305f2d44088231f8f1e9b2cc5cdbb56cee124ff12a7ff4f31d7638d119f8c9c33929296a8

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## 1.1.0
+
+- Added cancel_order
+
 ## 1.0.1
 
 - Updated models to use camelCased keys

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.0.1
+- Package version: 1.1.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.0.1.gem
+gem install ./primary_connect_client-1.1.0.gem
 ```
 
-(for development, run `gem install --dev ./primary_connect_client-1.0.1.gem` to install the development dependencies)
+(for development, run `gem install --dev ./primary_connect_client-1.1.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.0.1'
+    gem 'primary_connect_client', '~> 1.1.0'
 
 ### Install from Git
 
@@ -63,16 +63,13 @@ PrimaryConnectClient.configure do |config|
 end
 
 api_instance = PrimaryConnectClient::DefaultApi.new
-opts = {
-  order: PrimaryConnectClient::Order.new # Order | 
-}
+id = '01FGD44Q6MVCG2VNSMC4ZMOTQM' # String | Order ID
 
 begin
-  #create order
-  result = api_instance.create_order(opts)
-  p result
+  #cancel order
+  api_instance.cancel_order(id)
 rescue PrimaryConnectClient::ApiError => e
-  puts "Exception when calling DefaultApi->create_order: #{e}"
+  puts "Exception when calling DefaultApi->cancel_order: #{e}"
 end
 
 ```
@@ -83,6 +80,7 @@ All URIs are relative to *https://connect.primary.health*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
+*PrimaryConnectClient::DefaultApi* | [**cancel_order**](docs/DefaultApi.md#cancel_order) | **DELETE** /api/v1/orders/{id} | cancel order
 *PrimaryConnectClient::DefaultApi* | [**create_order**](docs/DefaultApi.md#create_order) | **POST** /api/v1/orders | create order
 *PrimaryConnectClient::DefaultApi* | [**create_result**](docs/DefaultApi.md#create_result) | **POST** /api/v1/orders/{order_id}/results | create result
 *PrimaryConnectClient::DefaultApi* | [**get_lab_report**](docs/DefaultApi.md#get_lab_report) | **GET** /api/v1/results/{result_id}/lab_report | show lab report

data/docs/DefaultApi.md

@@ -4,6 +4,7 @@ All URIs are relative to *https://connect.primary.health*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
+| [**cancel_order**](DefaultApi.md#cancel_order) | **DELETE** /api/v1/orders/{id} | cancel order |
 | [**create_order**](DefaultApi.md#create_order) | **POST** /api/v1/orders | create order |
 | [**create_result**](DefaultApi.md#create_result) | **POST** /api/v1/orders/{order_id}/results | create result |
 | [**get_lab_report**](DefaultApi.md#get_lab_report) | **GET** /api/v1/results/{result_id}/lab_report | show lab report |
@@ -14,6 +15,72 @@ All URIs are relative to *https://connect.primary.health*
 | [**update_order**](DefaultApi.md#update_order) | **PUT** /api/v1/orders/{id} | update order |
 
 
+## cancel_order
+
+> cancel_order(id)
+
+cancel order
+
+### 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
+id = '01FGD44Q6MVCG2VNSMC4ZMOTQM' # String | Order ID
+
+begin
+  # cancel order
+  api_instance.cancel_order(id)
+rescue PrimaryConnectClient::ApiError => e
+  puts "Error when calling DefaultApi->cancel_order: #{e}"
+end
+```
+
+#### Using the cancel_order_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> cancel_order_with_http_info(id)
+
+```ruby
+begin
+  # cancel order
+  data, status_code, headers = api_instance.cancel_order_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue PrimaryConnectClient::ApiError => e
+  puts "Error when calling DefaultApi->cancel_order_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Order ID |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## create_order
 
 > <OrderIds> create_order(opts)
@@ -238,7 +305,7 @@ PrimaryConnectClient.configure do |config|
 end
 
 api_instance = PrimaryConnectClient::DefaultApi.new
-id = 'id_example' # String | id
+id = '01FGD44Q6MVCG2VNSMC4ZMOTQM' # String | Order ID
 
 begin
   # show order
@@ -271,7 +338,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** | id |  |
+| **id** | **String** | Order ID |  |
 
 ### Return type
 
@@ -514,7 +581,7 @@ PrimaryConnectClient.configure do |config|
 end
 
 api_instance = PrimaryConnectClient::DefaultApi.new
-id = 'id_example' # String | id
+id = '01FGD44Q6MVCG2VNSMC4ZMOTQM' # String | Order ID
 opts = {
   order: PrimaryConnectClient::Order.new # Order | 
 }
@@ -550,7 +617,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** | id |  |
+| **id** | **String** | Order ID |  |
 | **order** | [**Order**](Order.md) |  | [optional] |
 
 ### Return type

data/lib/primary_connect_client/api/default_api.rb

@@ -19,6 +19,67 @@ module PrimaryConnectClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # cancel order
+    # @param id [String] Order ID
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def cancel_order(id, opts = {})
+      cancel_order_with_http_info(id, opts)
+      nil
+    end
+
+    # cancel order
+    # @param id [String] Order ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def cancel_order_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.cancel_order ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling DefaultApi.cancel_order"
+      end
+      # resource path
+      local_var_path = '/api/v1/orders/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer_auth']
+
+      new_options = opts.merge(
+        :operation => :"DefaultApi.cancel_order",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#cancel_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # create order
     # @param [Hash] opts the optional parameters
     # @option opts [Order] :order 
@@ -211,7 +272,7 @@ module PrimaryConnectClient
     end
 
     # show order
-    # @param id [String] id
+    # @param id [String] Order ID
     # @param [Hash] opts the optional parameters
     # @return [OrderWithEventErrors]
     def get_order(id, opts = {})
@@ -220,7 +281,7 @@ module PrimaryConnectClient
     end
 
     # show order
-    # @param id [String] id
+    # @param id [String] Order ID
     # @param [Hash] opts the optional parameters
     # @return [Array<(OrderWithEventErrors, Integer, Hash)>] OrderWithEventErrors data, response status code and response headers
     def get_order_with_http_info(id, opts = {})
@@ -455,7 +516,7 @@ module PrimaryConnectClient
     end
 
     # update order
-    # @param id [String] id
+    # @param id [String] Order ID
     # @param [Hash] opts the optional parameters
     # @option opts [Order] :order 
     # @return [OrderIds]
@@ -465,7 +526,7 @@ module PrimaryConnectClient
     end
 
     # update order
-    # @param id [String] id
+    # @param id [String] Order ID
     # @param [Hash] opts the optional parameters
     # @option opts [Order] :order 
     # @return [Array<(OrderIds, Integer, Hash)>] OrderIds data, response status code and response headers

data/lib/primary_connect_client/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 5.3.0
 =end
 
 module PrimaryConnectClient
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

data/spec/api/default_api_spec.rb

@@ -32,6 +32,17 @@ describe 'DefaultApi' do
     end
   end
 
+  # unit tests for cancel_order
+  # cancel order
+  # @param id Order ID
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'cancel_order test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for create_order
   # create order
   # @param [Hash] opts the optional parameters
@@ -68,7 +79,7 @@ describe 'DefaultApi' do
 
   # unit tests for get_order
   # show order
-  # @param id id
+  # @param id Order ID
   # @param [Hash] opts the optional parameters
   # @return [OrderWithEventErrors]
   describe 'get_order test' do
@@ -114,7 +125,7 @@ describe 'DefaultApi' do
 
   # unit tests for update_order
   # update order
-  # @param id id
+  # @param id Order ID
   # @param [Hash] opts the optional parameters
   # @option opts [Order] :order 
   # @return [OrderIds]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: primary_connect_client
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - OpenAPI-Generator
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-20 00:00:00.000000000 Z
+date: 2022-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus