smspva-sdk 0.1.0-alpha.2 → 0.1.0-alpha.4

package/METHODS.md

@@ -1,6 +1,6 @@
 # SDK method index
 
-All six packages cover these same 56 methods. Both Python clients use the Python names. PHP and Java use the JavaScript camelCase method names, with their own resource access syntax. Go capitalizes the first letter (for example, `GetBalance`); C# also appends `Async` (`GetBalanceAsync`). See each package README for request types and working usage. Parameters retain their API spelling.
+All six packages cover these same 61 methods. Both Python clients use the Python names. PHP and Java use the JavaScript camelCase method names, with their own resource access syntax. Go capitalizes the first letter (for example, `GetBalance`); C# also appends `Async` (`GetBalanceAsync`). See each package README for request types and working usage. Parameters retain their API spelling.
 
 ## activation
 
@@ -13,12 +13,17 @@ All six packages cover these same 56 methods. Both Python clients use the Python
 | `client.activation.get_message_type_settings` | `client.activation.getMessageTypeSettings` | `GET /activation/countryservicesettings` |
 | `client.activation.get_all_number_counts` | `client.activation.getAllNumberCounts` | `GET /activation/countnumbers` |
 | `client.activation.get_country_number_counts` | `client.activation.getCountryNumberCounts` | `GET /activation/countnumbers/{country}` |
+| `client.activation.get_all_number_counts_compact` | `client.activation.getAllNumberCountsCompact` | `GET /activation/countnumberscompact` |
+| `client.activation.get_country_number_counts_compact` | `client.activation.getCountryNumberCountsCompact` | `GET /activation/countnumberscompact/{country}` |
 | `client.activation.get_service_price` | `client.activation.getServicePrice` | `GET /activation/serviceprice/{country}/{service}` |
 | `client.activation.get_country_operator_prices` | `client.activation.getCountryOperatorPrices` | `GET /activation/serviceprice/{country}` |
 | `client.activation.get_service_prices` | `client.activation.getServicePrices` | `GET /activation/serviceprices/{service}` |
 | `client.activation.get_all_service_prices` | `client.activation.getAllServicePrices` | `GET /activation/servicesprices` |
 | `client.activation.get_number` | `client.activation.getNumber` | `GET /activation/number/{country}/{service}` |
 | `client.activation.get_number_by_operator` | `client.activation.getNumberByOperator` | `GET /activation/number/{country}/{service}/{operator}` |
+| `client.activation.repeat_number` | `client.activation.repeatNumber` | `POST /activation/repeatnumber/{number}/{service}` |
+| `client.activation.get_phone_status` | `client.activation.getPhoneStatus` | `GET /activation/statusphone/{orderid}` |
+| `client.activation.start_sms` | `client.activation.startSms` | `PUT /activation/startsms/{orderid}` |
 | `client.activation.receive_sms` | `client.activation.receiveSms` | `GET /activation/sms/{orderid}` |
 | `client.activation.get_orders` | `client.activation.getOrders` | `GET /activation/orders` |
 | `client.activation.get_number_status` | `client.activation.getNumberStatus` | `GET /activation/numberstatus/{number}/{service}` |

package/README.md

@@ -16,7 +16,7 @@ npm install smspva-sdk@0.1.0-alpha.2
 
 ## API coverage
 
-The SDK provides 56 methods across three APIs:
+The SDK provides 61 methods across three APIs:
 
 | API | Methods | Use it to |
 | --- | --- | --- |
@@ -139,3 +139,22 @@ For account, billing or service questions, visit the [SMSPVA help center](https:
 ## License
 
 MIT. See [LICENSE](https://github.com/SMSPVA/smspva-js/blob/main/LICENSE).
+
+## Compact number counts and operator ratings
+
+Using an already configured client:
+
+```ts
+const allCounts = await client.activation.getAllNumberCountsCompact();
+const uaCounts = await client.activation.getCountryNumberCountsCompact({ country: "ua" });
+```
+
+Both requests use GET and the account API key in the `apikey` header. Country codes are case-insensitive; an unknown country returns `data: []`. No extra query parameters are required. Results are cached by the API for 60 seconds, independently for all countries and for each country.
+
+The SDK preserves `Operator`, `Country`, `Services`, `Rating` and `ServiceRatings` exactly as returned, including negative counts and missing or invalid ratings. It does not insert computed rating fields. For non-`Donor*` operators, the effective rating is 1. For `Donor*` operators, use a service rating if it is an integer from 1 to 10, then a valid overall rating; otherwise the rating is undefined. Lower is better.
+
+## Receive another SMS on a previously used number
+
+Call the Activation methods in this order: `repeatNumber`, `getPhoneStatus`, `startSms`, `receiveSms`. Use a number previously paid for on the same service and carry the new order ID through the remaining calls. Request a new code in the target service after starting SMS reception.
+
+HTTP 202 with NUMBER_NOT_READY includes retryAfter in seconds. For PHONE_NOT_READY, wait five seconds. Wait 30 seconds between SMS checks while the order is active. Receiving a new paid SMS can incur a charge. If the number request has an uncertain outcome, inspect current orders before retrying.

package/dist/cjs/contracts.cjs

@@ -127,6 +127,43 @@ exports.operations = {
         "noStock": false,
         "stateful": false
     },
+    "activation.getAllNumberCountsCompact": {
+        "family": "activation",
+        "jsName": "getAllNumberCountsCompact",
+        "pyName": "get_all_number_counts_compact",
+        "slug": "countnumberscompact",
+        "path": "/activation/countnumberscompact",
+        "method": "GET",
+        "baseUrl": "https://api.smspva.com",
+        "auth": "required",
+        "params": [],
+        "pending": false,
+        "noStock": false,
+        "stateful": false
+    },
+    "activation.getCountryNumberCountsCompact": {
+        "family": "activation",
+        "jsName": "getCountryNumberCountsCompact",
+        "pyName": "get_country_number_counts_compact",
+        "slug": "country-countnumberscompact",
+        "path": "/activation/countnumberscompact/{country}",
+        "method": "GET",
+        "baseUrl": "https://api.smspva.com",
+        "auth": "required",
+        "params": [
+            {
+                "name": "country",
+                "in": "path",
+                "required": true,
+                "schema": {
+                    "type": "string"
+                }
+            }
+        ],
+        "pending": false,
+        "noStock": false,
+        "stateful": false
+    },
     "activation.getServicePrice": {
         "family": "activation",
         "jsName": "getServicePrice",
@@ -374,6 +411,89 @@ exports.operations = {
         "noStock": false,
         "stateful": true
     },
+    "activation.repeatNumber": {
+        "family": "activation",
+        "jsName": "repeatNumber",
+        "pyName": "repeat_number",
+        "slug": "repeat-number",
+        "path": "/activation/repeatnumber/{number}/{service}",
+        "method": "POST",
+        "baseUrl": "https://api.smspva.com",
+        "auth": "required",
+        "params": [
+            {
+                "name": "number",
+                "in": "path",
+                "required": true,
+                "schema": {
+                    "type": "string",
+                    "pattern": "^[0-9]{5,15}$",
+                    "minLength": 5,
+                    "maxLength": 15
+                }
+            },
+            {
+                "name": "service",
+                "in": "path",
+                "required": true,
+                "schema": {
+                    "type": "string",
+                    "minLength": 1
+                }
+            }
+        ],
+        "pending": true,
+        "pendingType": "NUMBER_NOT_READY",
+        "noStock": false,
+        "stateful": true
+    },
+    "activation.getPhoneStatus": {
+        "family": "activation",
+        "jsName": "getPhoneStatus",
+        "pyName": "get_phone_status",
+        "slug": "phone-readiness",
+        "path": "/activation/statusphone/{orderid}",
+        "method": "GET",
+        "baseUrl": "https://api.smspva.com",
+        "auth": "required",
+        "params": [
+            {
+                "name": "orderid",
+                "in": "path",
+                "required": true,
+                "schema": {
+                    "type": "integer"
+                }
+            }
+        ],
+        "pending": true,
+        "pendingType": "PHONE_NOT_READY",
+        "noStock": false,
+        "stateful": false
+    },
+    "activation.startSms": {
+        "family": "activation",
+        "jsName": "startSms",
+        "pyName": "start_sms",
+        "slug": "start-sms",
+        "path": "/activation/startsms/{orderid}",
+        "method": "PUT",
+        "baseUrl": "https://api.smspva.com",
+        "auth": "required",
+        "params": [
+            {
+                "name": "orderid",
+                "in": "path",
+                "required": true,
+                "schema": {
+                    "type": "integer"
+                }
+            }
+        ],
+        "pending": false,
+        "noStock": false,
+        "stateful": true
+    },
     "activation.receiveSms": {
         "family": "activation",
         "jsName": "receiveSms",