Merge pull request #24 from FreeClimbAPI/VCSWP-18112

Add offnet compatibility

Author: ngarg-vail

CHANGELOG.md

@@ -6,6 +6,13 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ## [Unreleased]
 None
+<a name="4.0.5"></a>
+
+## [4.0.5] - 2022-11-01
+### Added
+- Add `offnet` property in IncomingNumber resource
+- Add `offnet` query parameter for listIncomingNumbers
+
 <a name="4.0.4"></a>
 ## [4.0.4] - 2022-10-07
 ### Added

README.md

@@ -4,7 +4,7 @@ FreeClimb is a cloud-based application programming interface (API) that puts the
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 1.0.0
-- Package version: 4.0.4
+- Package version: 4.0.5
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 For more information, please visit [https://www.freeclimb.com/support/](https://www.freeclimb.com/support/)
 

docs/DefaultApi.md

@@ -2574,6 +2574,7 @@ with freeclimb.ApiClient(configuration) as api_client:
     capabilities_toll_free = True # bool |  (optional)
     capabilities_ten_dlc = True # bool |  (optional)
     capabilities_short_code = True # bool |  (optional)
+    offnet = True # bool | Indication of whether the phone number was registered as an offnet number. This field will be rendered only for requests to the IncomingPhone number resource. (optional)
 
     # example passing only required values which don't have defaults set
     try:
@@ -2587,7 +2588,7 @@ with freeclimb.ApiClient(configuration) as api_client:
     # and optional values
     try:
         # List Incoming Numbers
-        api_response = api_instance.list_incoming_numbers(account_id, phone_number=phone_number, alias=alias, region=region, country=country, application_id=application_id, has_application=has_application, voice_enabled=voice_enabled, sms_enabled=sms_enabled, capabilities_voice=capabilities_voice, capabilities_sms=capabilities_sms, capabilities_toll_free=capabilities_toll_free, capabilities_ten_dlc=capabilities_ten_dlc, capabilities_short_code=capabilities_short_code)
+        api_response = api_instance.list_incoming_numbers(account_id, phone_number=phone_number, alias=alias, region=region, country=country, application_id=application_id, has_application=has_application, voice_enabled=voice_enabled, sms_enabled=sms_enabled, capabilities_voice=capabilities_voice, capabilities_sms=capabilities_sms, capabilities_toll_free=capabilities_toll_free, capabilities_ten_dlc=capabilities_ten_dlc, capabilities_short_code=capabilities_short_code, offnet=offnet)
         pprint(api_response)
     except freeclimb.ApiException as e:
         print("Exception when calling DefaultApi->list_incoming_numbers: %s\n" % e)
@@ -2612,6 +2613,7 @@ Name | Type | Description  | Notes
  **capabilities_toll_free** | **bool**|  | [optional]
  **capabilities_ten_dlc** | **bool**|  | [optional]
  **capabilities_short_code** | **bool**|  | [optional]
+ **offnet** | **bool**| Indication of whether the phone number was registered as an offnet number. This field will be rendered only for requests to the IncomingPhone number resource. | [optional]
 
 ### Return type
 

docs/IncomingNumberResult.md

@@ -18,6 +18,7 @@ Name | Type | Description | Notes
 **country** | **str, none_type** | Country of this phone number. | [optional] 
 **voice_enabled** | **bool, none_type** | Indicates whether the phone number can handle Calls. Typically set to true for all numbers. | [optional] 
 **sms_enabled** | **bool, none_type** | Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers. | [optional] 
+**offnet** | **bool, none_type** | The offnet field is a boolean representing whether the number is offnet registered or not. This field will be rendered only for requests to the IncomingPhone number resource. | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

docs/IncomingNumberResultAllOf.md

@@ -14,6 +14,7 @@ Name | Type | Description | Notes
 **country** | **str, none_type** | Country of this phone number. | [optional] 
 **voice_enabled** | **bool, none_type** | Indicates whether the phone number can handle Calls. Typically set to true for all numbers. | [optional] 
 **sms_enabled** | **bool, none_type** | Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers. | [optional] 
+**offnet** | **bool, none_type** | The offnet field is a boolean representing whether the number is offnet registered or not. This field will be rendered only for requests to the IncomingPhone number resource. | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

freeclimb/__init__.py

@@ -11,7 +11,7 @@
 """
 
 
-__version__ = "4.0.4"
+__version__ = "4.0.5"
 
 # import ApiClient
 from freeclimb.api_client import ApiClient

freeclimb/api/default_api.py

@@ -1893,6 +1893,7 @@ def __init__(self, api_client=None, account_id=None):
                     'capabilities_toll_free',
                     'capabilities_ten_dlc',
                     'capabilities_short_code',
+                    'offnet',
                 ],
                 'required': [
                     'account_id',
@@ -1938,6 +1939,8 @@ def __init__(self, api_client=None, account_id=None):
                         (bool,),
                     'capabilities_short_code':
                         (bool,),
+                    'offnet':
+                        (bool,),
                 },
                 'attribute_map': {
                     'account_id': 'accountId',
@@ -1954,6 +1957,7 @@ def __init__(self, api_client=None, account_id=None):
                     'capabilities_toll_free': 'capabilities.tollFree',
                     'capabilities_ten_dlc': 'capabilities.tenDLC',
                     'capabilities_short_code': 'capabilities.shortCode',
+                    'offnet': 'offnet',
                 },
                 'location_map': {
                     'account_id': 'path',
@@ -1970,6 +1974,7 @@ def __init__(self, api_client=None, account_id=None):
                     'capabilities_toll_free': 'query',
                     'capabilities_ten_dlc': 'query',
                     'capabilities_short_code': 'query',
+                    'offnet': 'query',
                 },
                 'collection_format_map': {
                 }
@@ -5533,6 +5538,7 @@ def list_incoming_numbers(
             capabilities_toll_free (bool): [optional]
             capabilities_ten_dlc (bool): [optional]
             capabilities_short_code (bool): [optional]
+            offnet (bool): Indication of whether the phone number was registered as an offnet number. This field will be rendered only for requests to the IncomingPhone number resource.. [optional]
             _return_http_data_only (bool): response data without head status
                 code and headers. Default is True.
             _preload_content (bool): if False, the urllib3.HTTPResponse object

freeclimb/api_client.py

@@ -77,7 +77,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None,
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'OpenAPI-Generator/4.0.4/python'
+        self.user_agent = 'OpenAPI-Generator/4.0.5/python'
 
     def __enter__(self):
         return self

freeclimb/configuration.py

@@ -405,7 +405,7 @@ def to_debug_report(self):
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 1.0.0\n"\
-               "SDK Package Version: 4.0.4".\
+               "SDK Package Version: 4.0.5".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

freeclimb/model/incoming_number_result.py

@@ -107,6 +107,7 @@ def openapi_types():
             'country': (str, none_type,),  # noqa: E501
             'voice_enabled': (bool, none_type,),  # noqa: E501
             'sms_enabled': (bool, none_type,),  # noqa: E501
+            'offnet': (bool, none_type,),  # noqa: E501
         }
 
     @cached_property
@@ -130,6 +131,7 @@ def discriminator():
         'country': 'country',  # noqa: E501
         'voice_enabled': 'voiceEnabled',  # noqa: E501
         'sms_enabled': 'smsEnabled',  # noqa: E501
+        'offnet': 'offnet',  # noqa: E501
     }
 
     read_only_vars = {
@@ -186,6 +188,7 @@ def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
             country (str, none_type): Country of this phone number.. [optional]  # noqa: E501
             voice_enabled (bool, none_type): Indicates whether the phone number can handle Calls. Typically set to true for all numbers.. [optional]  # noqa: E501
             sms_enabled (bool, none_type): Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers.. [optional]  # noqa: E501
+            offnet (bool, none_type): The offnet field is a boolean representing whether the number is offnet registered or not. This field will be rendered only for requests to the IncomingPhone number resource.. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -300,6 +303,7 @@ def __init__(self, *args, **kwargs):  # noqa: E501
             country (str, none_type): Country of this phone number.. [optional]  # noqa: E501
             voice_enabled (bool, none_type): Indicates whether the phone number can handle Calls. Typically set to true for all numbers.. [optional]  # noqa: E501
             sms_enabled (bool, none_type): Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers.. [optional]  # noqa: E501
+            offnet (bool, none_type): The offnet field is a boolean representing whether the number is offnet registered or not. This field will be rendered only for requests to the IncomingPhone number resource.. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)

freeclimb/model/incoming_number_result_all_of.py

@@ -100,6 +100,7 @@ def openapi_types():
             'country': (str, none_type,),  # noqa: E501
             'voice_enabled': (bool, none_type,),  # noqa: E501
             'sms_enabled': (bool, none_type,),  # noqa: E501
+            'offnet': (bool, none_type,),  # noqa: E501
         }
 
     @cached_property
@@ -119,6 +120,7 @@ def discriminator():
         'country': 'country',  # noqa: E501
         'voice_enabled': 'voiceEnabled',  # noqa: E501
         'sms_enabled': 'smsEnabled',  # noqa: E501
+        'offnet': 'offnet',  # noqa: E501
     }
 
     read_only_vars = {
@@ -173,6 +175,7 @@ def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
             country (str, none_type): Country of this phone number.. [optional]  # noqa: E501
             voice_enabled (bool, none_type): Indicates whether the phone number can handle Calls. Typically set to true for all numbers.. [optional]  # noqa: E501
             sms_enabled (bool, none_type): Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers.. [optional]  # noqa: E501
+            offnet (bool, none_type): The offnet field is a boolean representing whether the number is offnet registered or not. This field will be rendered only for requests to the IncomingPhone number resource.. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -265,6 +268,7 @@ def __init__(self, *args, **kwargs):  # noqa: E501
             country (str, none_type): Country of this phone number.. [optional]  # noqa: E501
             voice_enabled (bool, none_type): Indicates whether the phone number can handle Calls. Typically set to true for all numbers.. [optional]  # noqa: E501
             sms_enabled (bool, none_type): Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers.. [optional]  # noqa: E501
+            offnet (bool, none_type): The offnet field is a boolean representing whether the number is offnet registered or not. This field will be rendered only for requests to the IncomingPhone number resource.. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)

setup.py

@@ -12,7 +12,7 @@
 from setuptools import setup, find_packages  # noqa: H301
 
 NAME = "FreeClimb"
-VERSION = "4.0.4"
+VERSION = "4.0.5"
 # To install the library, run the following
 #
 # python setup.py install

test/helpers.py

@@ -55,6 +55,8 @@ def build_query_param(param):
             return 'empty'
         if param == 'direction':
             return 'inbound'
+        if param == 'offnet':
+            return True
         return 'TEST_' + param.upper()
 
     @staticmethod