freeclimb 4.4.0 → 4.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c62186a01842ffd5a506080f7fd007c27758b7aa1a5abc3705e6f4bcc953293
-  data.tar.gz: 2cba7d489cec288291e7d21b250ef5776d08905f6072c62eacbdefb875f5a704
+  metadata.gz: db9320429d36b3f663d298ae587eead1e91973547e6e3c5d7e417f12486b6bef
+  data.tar.gz: ae733cdfe86044191a60de4c7d6146d0ccb987cb337147681614c4b94a97fc8b
 SHA512:
-  metadata.gz: 65817741e4f0073be329a506115607c2d29a3d521de37106257ec3f13783607b80401c4bbf5e40bca09f7921525632cddb7c9d7e78ea62735c2545b054867283
-  data.tar.gz: ad689450010a9953547b8aee0b9dee0ac4576b40be5ac3a9bcebe9422d91b21ec4a41829a5eb591bd2e026cdb6e4ff35e55f5f03eebbe3f18e48f00c95ebd23c
+  metadata.gz: 49aa55f8327fa56a2e3ee0d28d47cb08c221e08358efda1d480b53f3ec524af69f4248c9164104e882df21cbf033aac8c80b28e9492487e5df76908463fc8752
+  data.tar.gz: 7fa2a51a646414c9949a6b3d3a25bbc748e7add32bb81562fc8469f3dbea845d1fd1c8a69dff31a768a0318cb4e85ba4dc0ac2da65d2324eb2c2b281e6bc6277

data/CHANGELOG.md

@@ -9,13 +9,19 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 None
 
-<a name="4.4.0"></a>
+<a name="4.4.1"></a>
+
+## [4.4.1] - 2023-07-19
+
+### Added
+
+- Unit testing for Ruby SDK
 
 ## [4.4.0] - 2023-06-08
 
 ### Added
 
-- Number management feature for python sdk including methods, properties, and testing
+- Number management feature for ruby sdk including methods, properties, and testing
 
 <a name="4.3.0"></a>
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    freeclimb (4.4.0)
+    freeclimb (4.4.1)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM

data/README.md

@@ -7,7 +7,7 @@ FreeClimb is a cloud-based application programming interface (API) that puts the
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 1.0.0
-- Package version: 4.4.0
+- Package version: 4.4.1
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [https://www.freeclimb.com/support/](https://www.freeclimb.com/support/)
 
@@ -15,7 +15,7 @@ For more information, please visit [https://www.freeclimb.com/support/](https://
 
 Add this to the Gemfile:
 
-    gem 'freeclimb', '~> 4.4.0'
+    gem 'freeclimb', '~> 4.4.1'
 
 and run from your terminal
 
@@ -44,9 +44,9 @@ gem build freeclimb.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./freeclimb-4.4.0.gem
+gem install ./freeclimb-4.4.1.gem
 ```
-(for development, run `gem install --dev ./freeclimb-4.4.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./freeclimb-4.4.1.gem` to install the development dependencies)
 
 ## Getting Started
 

data/docs/SMSTenDLCCampaign.md

@@ -72,7 +72,7 @@ instance = Freeclimb::SMSTenDLCCampaign.new(
   help_message: null,
   reference_id: null,
   mock: null,
-  next_renewal_or_expiration_date: Fri Dec 31 19:00:00 EST 1999
+  next_renewal_or_expiration_date: Fri Dec 31 18:00:00 CST 1999
 )
 ```
 

data/lib/freeclimb/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 5.4.0
 =end
 
 module Freeclimb
-  VERSION = '4.4.0'
+  VERSION = '4.4.1'
 end

data/openapi.json

@@ -85,6 +85,7 @@
         "type": "string",
         "enum": ["closed", "suspended", "active"],
         "x-enum-varnames": ["CLOSED", "SUSPENDED", "ACTIVE"],
+        "x-enum": true,
         "description": "The status of this account. It is one of: active, suspended, or closed.",
         "nullable": true
       },
@@ -92,6 +93,7 @@
         "type": "string",
         "description": "The type of this account. It is one of: trial or full.",
         "enum": ["trial", "full"],
+        "x-enum": true,
         "x-enum-varnames": ["TRIAL", "FULL"],
         "nullable": true
       },
@@ -100,6 +102,7 @@
         "nullable": true,
         "enum": ["human", "machine"],
         "x-enum-varnames": ["HUMAN", "MACHINE"],
+        "x-enum": true,
         "description": "If this Call was initiated with answering machine detection, either `human` or `machine`. Empty otherwise."
       },
       "CallDirection": {
@@ -107,6 +110,7 @@
         "nullable": true,
         "enum": ["inbound", "outboundAPI", "outboundDial"],
         "x-enum-varnames": ["INBOUND", "OUTBOUND_API", "OUTBOUND_DIAL"],
+        "x-enum": true,
         "description": "Direction of the Call. `inbound` for Calls into FreeClimb, `outboundAPI` for Calls initiated via the REST API,  `outboundDial` for Calls initiated by the `OutDial` PerCL command."
       },
       "CallStatus": {
@@ -132,6 +136,7 @@
           "BUSY",
           "NO_ANSWER"
         ],
+        "x-enum": true,
         "description": "* `queued` – Call is ready and waiting in line before going out. * `ringing` – Call is currently ringing. * `inProgress` – Call was answered and is currently in progress. * `canceled` – Call was hung up while it was queued or ringing. * `completed` – Call was answered and has ended normally. * `busy` – Caller received a busy signal. * `failed` – Call could not be completed as dialed, most likely because the phone number was non-existent. * `noAnswer` – Call ended without being answered."
       },
       "ConferenceStatus": {
@@ -139,6 +144,7 @@
         "nullable": true,
         "enum": ["empty", "populated", "inProgress", "terminated"],
         "x-enum-varnames": ["EMPTY", "POPULATED", "IN_PROGRESS", "TERMINATED"],
+        "x-enum": true,
         "description": "The status of the Conference. One of: creating, empty, populated, inProgress, or terminated."
       },
       "GetSpeechReason": {
@@ -158,7 +164,9 @@
           "NO_INPUT",
           "NO_MATCH",
           "RECOGNITION"
-        ]
+        ],
+        "x-enum": true
+
       },
       "GrammarFileBuiltIn": {
         "type": "string",
@@ -195,19 +203,22 @@
           "DIG11",
           "UP_TO_20_DIGIT_SEQUENCE",
           "VERSAY_YESNO"
-        ]
+        ],
+        "x-enum": true
       },
       "GrammarType": {
         "type": "string",
         "enum": ["URL", "BUILTIN"],
         "nullable": true,
         "x-enum-varnames": ["URL", "BUILT_IN"],
+        "x-enum": true,
         "description": "The grammar file type to use for speech recognition. A value of 'URL' indicates the grammarFile attribute specifies a URL that points to the grammar file. A value of `BUILTIN` indicates the grammarFile attribute specifies the name of one of the platform built-in grammar files."
       },
       "IfMachine": {
         "type": "string",
         "enum": ["redirect", "hangup"],
         "x-enum-varnames": ["REDIRECT", "HANGUP"],
+        "x-enum": true,
         "description": "Specifies how FreeClimb should handle this OutDial if an answering machine answers the Call. Valid values: `redirect` invokes the ifMachineUrl for instructions. `hangup` hangs up the Call. The ifMachineUrl will not be invoked."
       },
       "Language": {
@@ -267,24 +278,28 @@
           "CHINESE_CN",
           "CHINESE_HK",
           "CHINESE_TW"
-        ]
+        ],
+        "x-enum": true
       },
       "LogLevel": {
         "type": "string",
         "enum": ["info", "warning", "error"],
         "nullable": true,
         "x-enum-varnames": ["INFO", "WARNING", "ERROR"],
+        "x-enum": true,
         "description": "Level of the log. Possible values are info, warning, and error."
       },
       "MachineType": {
         "type": "string",
         "enum": ["answeringMachine", "faxMachine"],
-        "x-enum-varnames": ["ANSWERING_MACHINE", "FAX_MACHINE"]
+        "x-enum-varnames": ["ANSWERING_MACHINE", "FAX_MACHINE"],
+        "x-enum": true
       },
       "MessageDirection": {
         "type": "string",
         "enum": ["inbound", "outbound"],
-        "x-enum-varnames": ["INBOUND", "OUTBOUND"]
+        "x-enum-varnames": ["INBOUND", "OUTBOUND"],
+        "x-enum": true
       },
       "MessageStatus": {
         "type": "string",
@@ -315,13 +330,15 @@
           "EXPIRED",
           "DELETED",
           "UNKNOWN"
-        ]
+        ],
+        "x-enum": true
       },
       "PlayBeep": {
         "type": "string",
         "nullable": true,
         "enum": ["always", "never", "entryOnly", "exitOnly"],
         "x-enum-varnames": ["ALWAYS", "NEVER", "ENTRY_ONLY", "EXIT_ONLY"],
+        "x-enum": true,
         "description": "Indicates whether to play a beep when a Participant enters or leaves the Conference. either `always`, `never`, `entryOnly`, or `exitOnly`. Leaving this unset will make conference default to `always` ",
         "default": "always",
         "x-enum-default-attr": "ALWAYS"
@@ -329,12 +346,14 @@
       "QueueResultStatus": {
         "type": "string",
         "enum": ["queueFull", "dequeued", "hangup", "systemError"],
-        "x-enum-varnames": ["QUEUE_FULL", "DEQUEUED", "HANGUP", "SYSTEM_ERROR"]
+        "x-enum-varnames": ["QUEUE_FULL", "DEQUEUED", "HANGUP", "SYSTEM_ERROR"],
+        "x-enum": true
       },
       "RecordUtteranceTermReason": {
         "type": "string",
         "enum": ["finishKey", "timeout", "hangup", "maxLength"],
-        "x-enum-varnames": ["FINISH_KEY", "TIMEOUT", "HANGUP", "MAX_LENGTH"]
+        "x-enum-varnames": ["FINISH_KEY", "TIMEOUT", "HANGUP", "MAX_LENGTH"],
+        "x-enum": true
       },
       "RequestType": {
         "type": "string",
@@ -387,18 +406,21 @@
           "CONFERENCE_CALL_CONTROL",
           "MESSAGE_DELIVERY",
           "MESSAGE_STATUS"
-        ]
+        ],
+        "x-enum": true
       },
       "UpdateCallRequestStatus": {
         "type": "string",
         "enum": ["canceled", "completed"],
         "x-enum-varnames": ["CANCELED", "COMPLETED"],
+        "x-enum": true,
         "description": "Either `canceled` or `completed`.  Specifying `canceled` attempts to hang up calls that are queued without affecting calls already in progress. Specifying `completed` attempts to hang up a call already in progress."
       },
       "UpdateConferenceRequestStatus": {
         "type": "string",
         "enum": ["empty", "terminated"],
         "x-enum-varnames": ["EMPTY", "TERMINATED"],
+        "x-enum": true,
         "description": "New status of the conference. Valid values: `empty` or `terminated`. For more information, see **Status Parameter** below.**"
       },
       "PerclScript": {
@@ -551,6 +573,7 @@
       "Dequeue": {
         "description": "The `Dequeue` command transfers control of a Call that is in a Queue so that the waiting caller exits the Queue. Execution continues with the first command in the PerCL script returned by the `actionUrl` specified in the `Enqueue` command.",
         "x-percl-command": true,
+        "x-no-properties": true,
         "allOf": [
           {
             "$ref": "#/components/schemas/PerclCommand"
@@ -1130,6 +1153,7 @@
       "StartRecordCall": {
         "description": "The `StartRecordCall` command records the current call and returns the URL of a file containing the audio recording when recording completes. `StartRecordCall` is non-blocking. After recording of the current call begins, control of the call moves to the PerCL command that follows `StartRecordCall` in the current PerCL script.",
         "x-percl-command": true,
+        "x-no-properties": true,
         "allOf": [
           {
             "$ref": "#/components/schemas/PerclCommand"
@@ -1161,6 +1185,7 @@
       "Unpark": {
         "description": "The `Unpark` command resumes a parked call.  Execution continues with the first command in the PerCL scripted returned by the actionUrl specified in the Park command as long as the call is still in progress.  If the call is no longer in progress, any returned PerCL will not be executed. Unpark is a terminal command -- any commands following it in the same script are not executed.",
         "x-percl-command": true,
+        "x-no-properties": true,
         "allOf": [
           {
             "$ref": "#/components/schemas/PerclCommand"
@@ -1235,6 +1260,7 @@
         "description": "Details for which features this number may be used.",
         "type": "object",
         "required": ["voice", "sms", "tollFree", "tenDLC", "shortCode"],
+        "x-is-object": true,
         "properties": {
           "voice": {
             "description": "Indicates whether a number can be used for voice calls. Replaces voiceEnabled.",
@@ -1502,7 +1528,7 @@
             "type": "object",
             "properties": {
               "capabilities": {
-                "$ref": "#/components/schemas/Capabilities"
+                "$ref": "#/components/schemas/Capabilities"              
               },
               "campaignId": {
                 "type": "string",
@@ -2370,22 +2396,26 @@
           },
           "resellerId": {
             "maxLength": 8,
+            "x-max-length-8": true,
             "type": "string",
             "nullable": true,
             "description": "Alphanumeric identifier of the reseller that you want to associate with this campaign."
           },
           "status": {
             "type": "string",
+            "x-has-writer": true,
             "description": "Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status. ",
             "enum": [
               "ACTIVE",
               "EXPIRED"
-            ]
+            ],
+            "x-enum-varnames": ["ACTIVE", "EXPIRED"]
           },
           "createDate": {
             "type": "string",
             "description": "Unix timestamp when campaign was created.",
-            "format": "date-time"
+            "format": "date-time",
+            "x-is-date-time": true
           },
           "autoRenewal": {
             "type": "boolean",
@@ -2395,10 +2425,12 @@
             "type": "string",
             "description": "Campaign recent billed date.",
             "format": "date-time",
+            "x-is-date-time": true,
             "nullable": true
           },
           "brandId": {
             "maxLength": 8,
+            "x-max-length-8": true,
             "type": "string",
             "description": "Alphanumeric identifier of the brand associated with this campaign."
           },
@@ -2518,6 +2550,7 @@
             "nullable": true,
             "description": "When the campaign would be due for its next renew/bill date.",
             "format": "date",
+            "x-is-date": true,
             "example": "2000-01-01"
           }
         }
@@ -2595,19 +2628,23 @@
           },
           "status": {
             "type": "string",
+            "x-has-writer": true,
             "description": "Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status. ",
             "enum": [
               "ACTIVE",
               "EXPIRED"
-            ]
+            ],
+            "x-enum-varnames": ["ACTIVE", "EXPIRED"]
           },
           "createDate": {
             "type": "string",
             "description": "Unix timestamp when campaign was created.",
-            "format": "date-time"
+            "format": "date-time",
+            "x-is-date-time": true
           },
           "brandId": {
             "maxLength": 8,
+            "x-max-length-8": true,
             "type": "string",
             "description": "Alphanumeric identifier of the brand associated with this campaign."
           },
@@ -2729,7 +2766,8 @@
             "description": "Subscriber opt-out message."
           },
           "brand": {
-            "$ref": "#/components/schemas/SMSTenDLCPartnerCampaignBrand"
+            "$ref": "#/components/schemas/SMSTenDLCPartnerCampaignBrand",
+            "x-partner-campaign-brand": true
           }
         },
         "example": {
@@ -2781,6 +2819,7 @@
           "phone"
         ],
         "type": "object",
+        "x-is-object": true,
         "properties": {
           "accountId": {
             "type": "string",
@@ -2835,6 +2874,7 @@
           },
           "optionalAttributes": {
             "type": "object",
+            "x-is-hash": true,
             "additionalProperties": {
               "type": "object",
               "description": "Optional brand attributes. Please refer to GET /enum/optionalAttributeNames for dictionary of optional attribute names."
@@ -2888,6 +2928,7 @@
           "entityType": {
             "maxLength": 20,
             "type": "string",
+            "x-has-writer": true,
             "description": "Entity type behind the brand. This is the form of business establishment.",
             "enum": [
               "PRIVATE_PROFIT",
@@ -2895,7 +2936,13 @@
               "NON_PROFIT",
               "GOVERNMENT",
               "SOLE_PROPRIETOR"
-            ]
+            ],
+            "x-enum-varnames": ["PRIVATE_PROFIT",
+              "PUBLIC_PROFIT",
+              "NON_PROFIT",
+              "GOVERNMENT",
+              "SOLE_PROPRIETOR"
+          ]
           },
           "cspId": {
             "type": "string",
@@ -2941,7 +2988,8 @@
             "maxLength": 2,
             "type": "string",
             "description": "ISO2 2 characters country code. Example: US - United States",
-            "example": "US"
+            "example": "US",
+            "x-max-length-2": true
           },
           "phone": {
             "maxLength": 20,
@@ -2969,12 +3017,14 @@
           },
           "postalCode": {
             "maxLength": 10,
+            "x-max-length-10": true,
             "type": "string",
             "description": "Postal codes. Use 5 digit zipcode for United States",
             "example": "10001"
           },
           "country": {
             "maxLength": 2,
+            "x-max-length-2": true,
             "type": "string",
             "description": "ISO2 2 characters country code. Example: US - United States",
             "example": "US"
@@ -2986,12 +3036,14 @@
           },
           "stockSymbol": {
             "maxLength": 10,
+            "x-max-length-10": true,
             "type": "string",
             "description": "(Required for public company) stock symbol.",
             "example": "ABC"
           },
           "stockExchange": {
             "type": "string",
+            "x-has-writer": true,
             "description": "(Required for public company) stock exchange.",
             "example": "NASDAQ",
             "enum": [
@@ -3022,6 +3074,35 @@
               "TWSE",
               "VSE",
               "OTHER"
+            ],
+            "x-enum-varnames": [
+              "NONE",
+              "NASDAQ",
+              "NYSE",
+              "AMEX",
+              "AMX",
+              "ASX",
+              "B3",
+              "BME",
+              "BSE",
+              "FRA",
+              "ICEX",
+              "JPX",
+              "JSE",
+              "KRX",
+              "LON",
+              "NSE",
+              "OMX",
+              "SEHK",
+              "SGX",
+              "SSE",
+              "STO",
+              "SWX",
+              "SZSE",
+              "TSX",
+              "TWSE",
+              "VSE",
+              "OTHER"
             ]
           },
           "ipAddress": {
@@ -3037,6 +3118,7 @@
           },
           "brandRelationship": {
             "type": "string",
+            "x-has-writer": true,
             "description": "Brand relationship to the CSP",
             "enum": [
               "BASIC_ACCOUNT",
@@ -3044,6 +3126,13 @@
               "MEDIUM_ACCOUNT",
               "LARGE_ACCOUNT",
               "KEY_ACCOUNT"
+            ],
+            "x-enum-varnames": [
+              "BASIC_ACCOUNT",
+              "SMALL_ACCOUNT",
+              "MEDIUM_ACCOUNT",
+              "LARGE_ACCOUNT",
+              "KEY_ACCOUNT"
             ]
           },
           "vertical": {
@@ -3058,12 +3147,19 @@
           },
           "altBusinessIdType": {
             "type": "string",
+            "x-has-writer": true,
             "enum": [
               "NONE",
               "DUNS",
               "GIIN",
               "LEI"
             ],
+            "x-enum-varnames": [
+              "NONE",
+              "DUNS",
+              "GIIN",
+              "LEI"
+            ],
             "description": "The type of the Alternative business identifier"
           },
           "universalEin": {
@@ -3078,6 +3174,7 @@
           },
           "optionalAttributes": {
             "type": "object",
+            "x-is-hash": true,
             "additionalProperties": {
               "type": "object",
               "description": "Optional brand attributes. Please refer to GET /enum/optionalAttributeNames for dictionary of optional attribute names."
@@ -3090,18 +3187,26 @@
           },
           "identityStatus": {
             "type": "string",
+            "x-has-writer": true,
             "description": "TCR assessment of the brand identification status.",
             "enum": [
               "SELF_DECLARED",
               "UNVERIFIED",
               "VERIFIED",
               "VETTED_VERIFIED"
+            ],
+            "x-enum-varnames": [
+              "SELF_DECLARED",
+              "UNVERIFIED",
+              "VERIFIED",
+              "VETTED_VERIFIED"
             ]
           },
           "createDate": {
             "type": "string",
             "description": "Unix timestamp when brand was created.",
-            "format": "date-time"
+            "format": "date-time",
+            "x-is-date-time": true
           }
         },
         "description": "A brand is a business identity behind the campaign.",