@openroam/sdk 0.1.0-rc.4 → 0.1.0-rc.5

package/README.md

@@ -6,7 +6,7 @@ Works on Node 18+, edge runtimes and browsers (never put your API key in a brows
 ## Install
 
 ```bash
-npm install @openroam/sdk@0.1.0-rc.4
+npm install @openroam/sdk@0.1.0-rc.5
 ```
 
 > This is a **release candidate**: install it by its exact version, as above; a plain install does not pick it up. Before 1.0 the API can change between minor versions; every change is listed in the [changelog](https://openroamhq.github.io/openroam-sdks/changelog/).

package/dist/apis/AirtimeApi.d.ts

@@ -10,14 +10,14 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import { type AirtimeCatalogResponse } from '../models/AirtimeCatalogResponse';
-import { type AirtimeCreateOrder200Response } from '../models/AirtimeCreateOrder200Response';
-import { type AirtimeNumberLookupResponse } from '../models/AirtimeNumberLookupResponse';
-import { type AirtimeOperatorItem } from '../models/AirtimeOperatorItem';
-import { type AirtimeOperatorsResponse } from '../models/AirtimeOperatorsResponse';
+import { type AirtimeCatalogPage } from '../models/AirtimeCatalogPage';
+import { type AirtimeNumberLookup } from '../models/AirtimeNumberLookup';
+import { type AirtimeOperator } from '../models/AirtimeOperator';
+import { type AirtimeOperatorList } from '../models/AirtimeOperatorList';
+import { type AirtimeOrder } from '../models/AirtimeOrder';
 import { type AirtimeOrderRequest } from '../models/AirtimeOrderRequest';
-import { type AirtimeQuoteResponse } from '../models/AirtimeQuoteResponse';
-import { type AirtimeSearchResponse } from '../models/AirtimeSearchResponse';
+import { type AirtimeQuote } from '../models/AirtimeQuote';
+import { type AirtimeSearchResult } from '../models/AirtimeSearchResult';
 export interface AirtimeCatalogRequest {
     /**
      * Optional ISO 3166-1 alpha-2 country filter, in either case; every country when omitted. A blank or invalid value gives 400 / 10001.
@@ -166,12 +166,12 @@ export interface AirtimeApiInterface {
      * @throws {RequiredError}
      * @memberof AirtimeApiInterface
      */
-    airtimeCatalogRaw(requestParameters: AirtimeCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AirtimeCatalogResponse>>;
+    airtimeCatalogRaw(requestParameters: AirtimeCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AirtimeCatalogPage>>;
     /**
      * Returns the operator directory, page by page, for partner inventory.  Returns `{ items: [{ id, name, countryCode, category, logoUrl }], nextCursor }`, ordered by operator ID. Pass `nextCursor` back as `cursor` with the same `countryCode` until it is null; a page can hold fewer items than `limit`, and the cursor does not expire. A cursor reused with another `countryCode`, or a blank or invalid `countryCode`, gives 400 / 10001. Offers are not exported: they depend on whether the operator is detected or chosen, so read them with `operators/{id}?phoneNumber=`.
      * Airtime catalog
      */
-    airtimeCatalog(requestParameters: AirtimeCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AirtimeCatalogResponse>;
+    airtimeCatalog(requestParameters: AirtimeCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AirtimeCatalogPage>;
     /**
      * Creates request options for airtimeCreateOrder without sending the request
      * @param {string} idempotencyKey UUID idempotency key for safe retries of this operation.
@@ -189,12 +189,12 @@ export interface AirtimeApiInterface {
      * @throws {RequiredError}
      * @memberof AirtimeApiInterface
      */
-    airtimeCreateOrderRaw(requestParameters: AirtimeCreateOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AirtimeCreateOrder200Response>>;
+    airtimeCreateOrderRaw(requestParameters: AirtimeCreateOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AirtimeOrder>>;
     /**
      * Places an airtime top-up order and returns the accepted order.  Takes the same body as quote and needs the `manage` order permission (403 / 10003 without it). An `Idempotency-Key` header with a new UUID is required for every purchase: a retry with the same key and body returns the order already accepted, 202 / 12002 with `Retry-After` while it is still being accepted, and a changed body gives 409 / 12001. The number\'s operator is looked up again, as in quote; item errors are named at `items[i]`, and a current price above `inputs.maxPrice` gives 409 / 11002 before anything is charged. Track fulfillment with the order routes or the `order.fulfillment.updated` webhook.
      * Order airtime
      */
-    airtimeCreateOrder(requestParameters: AirtimeCreateOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AirtimeCreateOrder200Response>;
+    airtimeCreateOrder(requestParameters: AirtimeCreateOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AirtimeOrder>;
     /**
      * Creates request options for airtimeGetOperator without sending the request
      * @param {string} id The operator ID from the operator list, the catalog or search.
@@ -226,12 +226,12 @@ export interface AirtimeApiInterface {
      * @throws {RequiredError}
      * @memberof AirtimeApiInterface
      */
-    airtimeGetOperatorRaw(requestParameters: AirtimeGetOperatorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AirtimeOperatorItem>>;
+    airtimeGetOperatorRaw(requestParameters: AirtimeGetOperatorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AirtimeOperator>>;
     /**
      * Returns one operator with its offers for a phone number of its country (manual flow, step 2).  Returns the operator in the item shape that search returns, without a carrier lookup. A number of another country than the operator\'s gives 400 / 10001 with `COUNTRY_MISMATCH` at `phoneNumber`. An unknown or unparseable ID, or an operator without an orderable offer, gives 404 / 10004. Offer filters that match none of the operator\'s offers leave `offers` empty. A manual choice is not checked against the number\'s carrier, so have the customer confirm the operator before ordering.
      * Get an airtime operator
      */
-    airtimeGetOperator(requestParameters: AirtimeGetOperatorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AirtimeOperatorItem>;
+    airtimeGetOperator(requestParameters: AirtimeGetOperatorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AirtimeOperator>;
     /**
      * Creates request options for airtimeGetOperators without sending the request
      * @param {string} countryCode Required ISO 3166-1 alpha-2 country code, in either case, for example the &#x60;details.phoneLookup.countryCode&#x60; of a search.
@@ -247,12 +247,12 @@ export interface AirtimeApiInterface {
      * @throws {RequiredError}
      * @memberof AirtimeApiInterface
      */
-    airtimeGetOperatorsRaw(requestParameters: AirtimeGetOperatorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AirtimeOperatorsResponse>>;
+    airtimeGetOperatorsRaw(requestParameters: AirtimeGetOperatorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AirtimeOperatorList>>;
     /**
      * Lists the operators of a country that the customer can choose manually (manual flow, step 1).  Returns the complete list, without paging or prices, as `{ items: [{ id, name, countryCode, category, logoUrl }] }`, ordered by name. Only operators with an offer that can be sold for a chosen operator are listed. An invalid `countryCode` gives 400 / 10001. Continue with `operators/{id}?phoneNumber=`.
      * List airtime operators
      */
-    airtimeGetOperators(requestParameters: AirtimeGetOperatorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AirtimeOperatorsResponse>;
+    airtimeGetOperators(requestParameters: AirtimeGetOperatorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AirtimeOperatorList>;
     /**
      * Creates request options for airtimeLookupNumber without sending the request
      * @param {string} phoneNumber The number in international format, starting with + or 00; spaces, hyphens and parentheses are allowed.
@@ -268,12 +268,12 @@ export interface AirtimeApiInterface {
      * @throws {RequiredError}
      * @memberof AirtimeApiInterface
      */
-    airtimeLookupNumberRaw(requestParameters: AirtimeLookupNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AirtimeNumberLookupResponse>>;
+    airtimeLookupNumberRaw(requestParameters: AirtimeLookupNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AirtimeNumberLookup>>;
     /**
      * Describes a phone number and returns its carrier from a carrier lookup when the number is valid.  Describes the number from numbering-plan data and, for a valid number, adds carrier information from a live carrier lookup. A number without the international shape gives 400 / 10001; a number its country does not assign returns 200 with `isValid: false` and `carrier: null`, without a carrier lookup. Returns 503 / 10007 when the carrier lookup is unavailable. The carrier is for display only and nothing is stored; use search to find a sellable operator.
      * Look up a phone number
      */
-    airtimeLookupNumber(requestParameters: AirtimeLookupNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AirtimeNumberLookupResponse>;
+    airtimeLookupNumber(requestParameters: AirtimeLookupNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AirtimeNumberLookup>;
     /**
      * Creates request options for airtimeQuote without sending the request
      * @param {AirtimeOrderRequest} [airtimeOrderRequest]
@@ -289,12 +289,12 @@ export interface AirtimeApiInterface {
      * @throws {RequiredError}
      * @memberof AirtimeApiInterface
      */
-    airtimeQuoteRaw(requestParameters: AirtimeQuoteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AirtimeQuoteResponse>>;
+    airtimeQuoteRaw(requestParameters: AirtimeQuoteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AirtimeQuote>>;
     /**
      * Prices the order body with current prices, without placing an order.  Takes the same body as order and resolves the number\'s operator as the order does, with a carrier lookup per item. Each item is priced on its own, in request order; the first failing item aborts the quote and is named at `items[i]`, for example 409 / 11002 at `items[i].inputs.maxPrice` when the current price is above it. 409 / 20000 means the lookup shows that the offer\'s operator cannot be the number\'s: search again. A carrier lookup that fails gives 503 / 10007. A quote reserves nothing and does not expire; to hold the quoted price, send it as `inputs.maxPrice` in the order.
      * Quote airtime
      */
-    airtimeQuote(requestParameters: AirtimeQuoteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AirtimeQuoteResponse>;
+    airtimeQuote(requestParameters: AirtimeQuoteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AirtimeQuote>;
     /**
      * Creates request options for airtimeSearch without sending the request
      * @param {string} phoneNumber The recipient\&#39;s number in international format, starting with + or 00; spaces, hyphens and parentheses are allowed.
@@ -328,12 +328,12 @@ export interface AirtimeApiInterface {
      * @throws {RequiredError}
      * @memberof AirtimeApiInterface
      */
-    airtimeSearchRaw(requestParameters: AirtimeSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AirtimeSearchResponse>>;
+    airtimeSearchRaw(requestParameters: AirtimeSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AirtimeSearchResult>>;
     /**
      * Searches for a phone number\'s operator by carrier lookup and returns it with its offers (detected flow).  Returns `{ items, pagination, details: { phoneLookup: { status, carrierName, countryCode } } }`. `items` holds at most the detected operator with its offers. It is empty when `status` is not `detected` or no offer remains after the filters; then let the customer choose the operator with `GET operators?countryCode=`, using `details.phoneLookup.countryCode`. Each call makes exactly one carrier lookup and returns at most one item, so `page` must be 1. A `phoneNumber` that is not in international format gives 400 / 10001; a carrier lookup that fails gives 503 / 10007, retry later.
      * Search airtime by phone number
      */
-    airtimeSearch(requestParameters: AirtimeSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AirtimeSearchResponse>;
+    airtimeSearch(requestParameters: AirtimeSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AirtimeSearchResult>;
 }
 /**
  *
@@ -347,12 +347,12 @@ export declare class AirtimeApi extends runtime.BaseAPI implements AirtimeApiInt
      * Returns the operator directory, page by page, for partner inventory.  Returns `{ items: [{ id, name, countryCode, category, logoUrl }], nextCursor }`, ordered by operator ID. Pass `nextCursor` back as `cursor` with the same `countryCode` until it is null; a page can hold fewer items than `limit`, and the cursor does not expire. A cursor reused with another `countryCode`, or a blank or invalid `countryCode`, gives 400 / 10001. Offers are not exported: they depend on whether the operator is detected or chosen, so read them with `operators/{id}?phoneNumber=`.
      * Airtime catalog
      */
-    airtimeCatalogRaw(requestParameters: AirtimeCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AirtimeCatalogResponse>>;
+    airtimeCatalogRaw(requestParameters: AirtimeCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AirtimeCatalogPage>>;
     /**
      * Returns the operator directory, page by page, for partner inventory.  Returns `{ items: [{ id, name, countryCode, category, logoUrl }], nextCursor }`, ordered by operator ID. Pass `nextCursor` back as `cursor` with the same `countryCode` until it is null; a page can hold fewer items than `limit`, and the cursor does not expire. A cursor reused with another `countryCode`, or a blank or invalid `countryCode`, gives 400 / 10001. Offers are not exported: they depend on whether the operator is detected or chosen, so read them with `operators/{id}?phoneNumber=`.
      * Airtime catalog
      */
-    airtimeCatalog(requestParameters?: AirtimeCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AirtimeCatalogResponse>;
+    airtimeCatalog(requestParameters?: AirtimeCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AirtimeCatalogPage>;
     /**
      * Creates request options for airtimeCreateOrder without sending the request
      */
@@ -361,12 +361,12 @@ export declare class AirtimeApi extends runtime.BaseAPI implements AirtimeApiInt
      * Places an airtime top-up order and returns the accepted order.  Takes the same body as quote and needs the `manage` order permission (403 / 10003 without it). An `Idempotency-Key` header with a new UUID is required for every purchase: a retry with the same key and body returns the order already accepted, 202 / 12002 with `Retry-After` while it is still being accepted, and a changed body gives 409 / 12001. The number\'s operator is looked up again, as in quote; item errors are named at `items[i]`, and a current price above `inputs.maxPrice` gives 409 / 11002 before anything is charged. Track fulfillment with the order routes or the `order.fulfillment.updated` webhook.
      * Order airtime
      */
-    airtimeCreateOrderRaw(requestParameters: AirtimeCreateOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AirtimeCreateOrder200Response>>;
+    airtimeCreateOrderRaw(requestParameters: AirtimeCreateOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AirtimeOrder>>;
     /**
      * Places an airtime top-up order and returns the accepted order.  Takes the same body as quote and needs the `manage` order permission (403 / 10003 without it). An `Idempotency-Key` header with a new UUID is required for every purchase: a retry with the same key and body returns the order already accepted, 202 / 12002 with `Retry-After` while it is still being accepted, and a changed body gives 409 / 12001. The number\'s operator is looked up again, as in quote; item errors are named at `items[i]`, and a current price above `inputs.maxPrice` gives 409 / 11002 before anything is charged. Track fulfillment with the order routes or the `order.fulfillment.updated` webhook.
      * Order airtime
      */
-    airtimeCreateOrder(requestParameters: AirtimeCreateOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AirtimeCreateOrder200Response>;
+    airtimeCreateOrder(requestParameters: AirtimeCreateOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AirtimeOrder>;
     /**
      * Creates request options for airtimeGetOperator without sending the request
      */
@@ -375,12 +375,12 @@ export declare class AirtimeApi extends runtime.BaseAPI implements AirtimeApiInt
      * Returns one operator with its offers for a phone number of its country (manual flow, step 2).  Returns the operator in the item shape that search returns, without a carrier lookup. A number of another country than the operator\'s gives 400 / 10001 with `COUNTRY_MISMATCH` at `phoneNumber`. An unknown or unparseable ID, or an operator without an orderable offer, gives 404 / 10004. Offer filters that match none of the operator\'s offers leave `offers` empty. A manual choice is not checked against the number\'s carrier, so have the customer confirm the operator before ordering.
      * Get an airtime operator
      */
-    airtimeGetOperatorRaw(requestParameters: AirtimeGetOperatorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AirtimeOperatorItem>>;
+    airtimeGetOperatorRaw(requestParameters: AirtimeGetOperatorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AirtimeOperator>>;
     /**
      * Returns one operator with its offers for a phone number of its country (manual flow, step 2).  Returns the operator in the item shape that search returns, without a carrier lookup. A number of another country than the operator\'s gives 400 / 10001 with `COUNTRY_MISMATCH` at `phoneNumber`. An unknown or unparseable ID, or an operator without an orderable offer, gives 404 / 10004. Offer filters that match none of the operator\'s offers leave `offers` empty. A manual choice is not checked against the number\'s carrier, so have the customer confirm the operator before ordering.
      * Get an airtime operator
      */
-    airtimeGetOperator(requestParameters: AirtimeGetOperatorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AirtimeOperatorItem>;
+    airtimeGetOperator(requestParameters: AirtimeGetOperatorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AirtimeOperator>;
     /**
      * Creates request options for airtimeGetOperators without sending the request
      */
@@ -389,12 +389,12 @@ export declare class AirtimeApi extends runtime.BaseAPI implements AirtimeApiInt
      * Lists the operators of a country that the customer can choose manually (manual flow, step 1).  Returns the complete list, without paging or prices, as `{ items: [{ id, name, countryCode, category, logoUrl }] }`, ordered by name. Only operators with an offer that can be sold for a chosen operator are listed. An invalid `countryCode` gives 400 / 10001. Continue with `operators/{id}?phoneNumber=`.
      * List airtime operators
      */
-    airtimeGetOperatorsRaw(requestParameters: AirtimeGetOperatorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AirtimeOperatorsResponse>>;
+    airtimeGetOperatorsRaw(requestParameters: AirtimeGetOperatorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AirtimeOperatorList>>;
     /**
      * Lists the operators of a country that the customer can choose manually (manual flow, step 1).  Returns the complete list, without paging or prices, as `{ items: [{ id, name, countryCode, category, logoUrl }] }`, ordered by name. Only operators with an offer that can be sold for a chosen operator are listed. An invalid `countryCode` gives 400 / 10001. Continue with `operators/{id}?phoneNumber=`.
      * List airtime operators
      */
-    airtimeGetOperators(requestParameters: AirtimeGetOperatorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AirtimeOperatorsResponse>;
+    airtimeGetOperators(requestParameters: AirtimeGetOperatorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AirtimeOperatorList>;
     /**
      * Creates request options for airtimeLookupNumber without sending the request
      */
@@ -403,12 +403,12 @@ export declare class AirtimeApi extends runtime.BaseAPI implements AirtimeApiInt
      * Describes a phone number and returns its carrier from a carrier lookup when the number is valid.  Describes the number from numbering-plan data and, for a valid number, adds carrier information from a live carrier lookup. A number without the international shape gives 400 / 10001; a number its country does not assign returns 200 with `isValid: false` and `carrier: null`, without a carrier lookup. Returns 503 / 10007 when the carrier lookup is unavailable. The carrier is for display only and nothing is stored; use search to find a sellable operator.
      * Look up a phone number
      */
-    airtimeLookupNumberRaw(requestParameters: AirtimeLookupNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AirtimeNumberLookupResponse>>;
+    airtimeLookupNumberRaw(requestParameters: AirtimeLookupNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AirtimeNumberLookup>>;
     /**
      * Describes a phone number and returns its carrier from a carrier lookup when the number is valid.  Describes the number from numbering-plan data and, for a valid number, adds carrier information from a live carrier lookup. A number without the international shape gives 400 / 10001; a number its country does not assign returns 200 with `isValid: false` and `carrier: null`, without a carrier lookup. Returns 503 / 10007 when the carrier lookup is unavailable. The carrier is for display only and nothing is stored; use search to find a sellable operator.
      * Look up a phone number
      */
-    airtimeLookupNumber(requestParameters: AirtimeLookupNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AirtimeNumberLookupResponse>;
+    airtimeLookupNumber(requestParameters: AirtimeLookupNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AirtimeNumberLookup>;
     /**
      * Creates request options for airtimeQuote without sending the request
      */
@@ -417,12 +417,12 @@ export declare class AirtimeApi extends runtime.BaseAPI implements AirtimeApiInt
      * Prices the order body with current prices, without placing an order.  Takes the same body as order and resolves the number\'s operator as the order does, with a carrier lookup per item. Each item is priced on its own, in request order; the first failing item aborts the quote and is named at `items[i]`, for example 409 / 11002 at `items[i].inputs.maxPrice` when the current price is above it. 409 / 20000 means the lookup shows that the offer\'s operator cannot be the number\'s: search again. A carrier lookup that fails gives 503 / 10007. A quote reserves nothing and does not expire; to hold the quoted price, send it as `inputs.maxPrice` in the order.
      * Quote airtime
      */
-    airtimeQuoteRaw(requestParameters: AirtimeQuoteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AirtimeQuoteResponse>>;
+    airtimeQuoteRaw(requestParameters: AirtimeQuoteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AirtimeQuote>>;
     /**
      * Prices the order body with current prices, without placing an order.  Takes the same body as order and resolves the number\'s operator as the order does, with a carrier lookup per item. Each item is priced on its own, in request order; the first failing item aborts the quote and is named at `items[i]`, for example 409 / 11002 at `items[i].inputs.maxPrice` when the current price is above it. 409 / 20000 means the lookup shows that the offer\'s operator cannot be the number\'s: search again. A carrier lookup that fails gives 503 / 10007. A quote reserves nothing and does not expire; to hold the quoted price, send it as `inputs.maxPrice` in the order.
      * Quote airtime
      */
-    airtimeQuote(requestParameters?: AirtimeQuoteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AirtimeQuoteResponse>;
+    airtimeQuote(requestParameters?: AirtimeQuoteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AirtimeQuote>;
     /**
      * Creates request options for airtimeSearch without sending the request
      */
@@ -431,12 +431,12 @@ export declare class AirtimeApi extends runtime.BaseAPI implements AirtimeApiInt
      * Searches for a phone number\'s operator by carrier lookup and returns it with its offers (detected flow).  Returns `{ items, pagination, details: { phoneLookup: { status, carrierName, countryCode } } }`. `items` holds at most the detected operator with its offers. It is empty when `status` is not `detected` or no offer remains after the filters; then let the customer choose the operator with `GET operators?countryCode=`, using `details.phoneLookup.countryCode`. Each call makes exactly one carrier lookup and returns at most one item, so `page` must be 1. A `phoneNumber` that is not in international format gives 400 / 10001; a carrier lookup that fails gives 503 / 10007, retry later.
      * Search airtime by phone number
      */
-    airtimeSearchRaw(requestParameters: AirtimeSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AirtimeSearchResponse>>;
+    airtimeSearchRaw(requestParameters: AirtimeSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AirtimeSearchResult>>;
     /**
      * Searches for a phone number\'s operator by carrier lookup and returns it with its offers (detected flow).  Returns `{ items, pagination, details: { phoneLookup: { status, carrierName, countryCode } } }`. `items` holds at most the detected operator with its offers. It is empty when `status` is not `detected` or no offer remains after the filters; then let the customer choose the operator with `GET operators?countryCode=`, using `details.phoneLookup.countryCode`. Each call makes exactly one carrier lookup and returns at most one item, so `page` must be 1. A `phoneNumber` that is not in international format gives 400 / 10001; a carrier lookup that fails gives 503 / 10007, retry later.
      * Search airtime by phone number
      */
-    airtimeSearch(requestParameters: AirtimeSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AirtimeSearchResponse>;
+    airtimeSearch(requestParameters: AirtimeSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AirtimeSearchResult>;
 }
 /**
  * @export

package/dist/apis/AirtimeApi.js

@@ -24,14 +24,14 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AirtimeSearchValueTypeEnum = exports.AirtimeGetOperatorValueTypeEnum = exports.AirtimeApi = void 0;
 const runtime = require("../runtime");
-const AirtimeCatalogResponse_1 = require("../models/AirtimeCatalogResponse");
-const AirtimeCreateOrder200Response_1 = require("../models/AirtimeCreateOrder200Response");
-const AirtimeNumberLookupResponse_1 = require("../models/AirtimeNumberLookupResponse");
-const AirtimeOperatorItem_1 = require("../models/AirtimeOperatorItem");
-const AirtimeOperatorsResponse_1 = require("../models/AirtimeOperatorsResponse");
+const AirtimeCatalogPage_1 = require("../models/AirtimeCatalogPage");
+const AirtimeNumberLookup_1 = require("../models/AirtimeNumberLookup");
+const AirtimeOperator_1 = require("../models/AirtimeOperator");
+const AirtimeOperatorList_1 = require("../models/AirtimeOperatorList");
+const AirtimeOrder_1 = require("../models/AirtimeOrder");
 const AirtimeOrderRequest_1 = require("../models/AirtimeOrderRequest");
-const AirtimeQuoteResponse_1 = require("../models/AirtimeQuoteResponse");
-const AirtimeSearchResponse_1 = require("../models/AirtimeSearchResponse");
+const AirtimeQuote_1 = require("../models/AirtimeQuote");
+const AirtimeSearchResult_1 = require("../models/AirtimeSearchResult");
 /**
  *
  */
@@ -72,7 +72,7 @@ class AirtimeApi extends runtime.BaseAPI {
         return __awaiter(this, void 0, void 0, function* () {
             const requestOptions = yield this.airtimeCatalogRequestOpts(requestParameters);
             const response = yield this.request(requestOptions, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => (0, AirtimeCatalogResponse_1.AirtimeCatalogResponseFromJSON)(jsonValue));
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, AirtimeCatalogPage_1.AirtimeCatalogPageFromJSON)(jsonValue));
         });
     }
     /**
@@ -120,7 +120,7 @@ class AirtimeApi extends runtime.BaseAPI {
         return __awaiter(this, void 0, void 0, function* () {
             const requestOptions = yield this.airtimeCreateOrderRequestOpts(requestParameters);
             const response = yield this.request(requestOptions, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => (0, AirtimeCreateOrder200Response_1.AirtimeCreateOrder200ResponseFromJSON)(jsonValue));
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, AirtimeOrder_1.AirtimeOrderFromJSON)(jsonValue));
         });
     }
     /**
@@ -191,7 +191,7 @@ class AirtimeApi extends runtime.BaseAPI {
         return __awaiter(this, void 0, void 0, function* () {
             const requestOptions = yield this.airtimeGetOperatorRequestOpts(requestParameters);
             const response = yield this.request(requestOptions, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => (0, AirtimeOperatorItem_1.AirtimeOperatorItemFromJSON)(jsonValue));
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, AirtimeOperator_1.AirtimeOperatorFromJSON)(jsonValue));
         });
     }
     /**
@@ -237,7 +237,7 @@ class AirtimeApi extends runtime.BaseAPI {
         return __awaiter(this, void 0, void 0, function* () {
             const requestOptions = yield this.airtimeGetOperatorsRequestOpts(requestParameters);
             const response = yield this.request(requestOptions, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => (0, AirtimeOperatorsResponse_1.AirtimeOperatorsResponseFromJSON)(jsonValue));
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, AirtimeOperatorList_1.AirtimeOperatorListFromJSON)(jsonValue));
         });
     }
     /**
@@ -283,7 +283,7 @@ class AirtimeApi extends runtime.BaseAPI {
         return __awaiter(this, void 0, void 0, function* () {
             const requestOptions = yield this.airtimeLookupNumberRequestOpts(requestParameters);
             const response = yield this.request(requestOptions, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => (0, AirtimeNumberLookupResponse_1.AirtimeNumberLookupResponseFromJSON)(jsonValue));
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, AirtimeNumberLookup_1.AirtimeNumberLookupFromJSON)(jsonValue));
         });
     }
     /**
@@ -325,7 +325,7 @@ class AirtimeApi extends runtime.BaseAPI {
         return __awaiter(this, void 0, void 0, function* () {
             const requestOptions = yield this.airtimeQuoteRequestOpts(requestParameters);
             const response = yield this.request(requestOptions, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => (0, AirtimeQuoteResponse_1.AirtimeQuoteResponseFromJSON)(jsonValue));
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, AirtimeQuote_1.AirtimeQuoteFromJSON)(jsonValue));
         });
     }
     /**
@@ -398,7 +398,7 @@ class AirtimeApi extends runtime.BaseAPI {
         return __awaiter(this, void 0, void 0, function* () {
             const requestOptions = yield this.airtimeSearchRequestOpts(requestParameters);
             const response = yield this.request(requestOptions, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => (0, AirtimeSearchResponse_1.AirtimeSearchResponseFromJSON)(jsonValue));
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, AirtimeSearchResult_1.AirtimeSearchResultFromJSON)(jsonValue));
         });
     }
     /**

package/dist/apis/CommonApi.d.ts

@@ -10,8 +10,8 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import { type CountryListResponse } from '../models/CountryListResponse';
-import { type MobileNetworkListResponse } from '../models/MobileNetworkListResponse';
+import { type CountryList } from '../models/CountryList';
+import { type MobileNetworkList } from '../models/MobileNetworkList';
 export interface CommonGetMobileNetworksRequest {
     /**
      * Only networks of this country: an ISO 3166-1 alpha-2 code, in either case.
@@ -42,12 +42,12 @@ export interface CommonApiInterface {
      * @throws {RequiredError}
      * @memberof CommonApiInterface
      */
-    commonGetCountriesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CountryListResponse>>;
+    commonGetCountriesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CountryList>>;
     /**
      * Lists every country and territory with its codes, English name, calling code and flag.  Returns `{ items }`, the whole list ordered by `countryCode`, without paging. `countryCode` is the ISO 3166-1 alpha-2 code every service filters and reports by. The endpoint takes no query parameters; an unknown parameter returns `400` with code `10001`.
      * List countries
      */
-    commonGetCountries(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CountryListResponse>;
+    commonGetCountries(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CountryList>;
     /**
      * Creates request options for commonGetMobileNetworks without sending the request
      * @param {string} [countryCode] Only networks of this country: an ISO 3166-1 alpha-2 code, in either case.
@@ -65,12 +65,12 @@ export interface CommonApiInterface {
      * @throws {RequiredError}
      * @memberof CommonApiInterface
      */
-    commonGetMobileNetworksRaw(requestParameters: CommonGetMobileNetworksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MobileNetworkListResponse>>;
+    commonGetMobileNetworksRaw(requestParameters: CommonGetMobileNetworksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MobileNetworkList>>;
     /**
      * Lists mobile network codes (MCC/MNC) with their operator, country and calling code.  Returns `{ items }` ordered by `mcc` then `mnc`, without paging. Optional filters: `countryCode` (ISO 3166-1 alpha-2, either case) and `mcc` (3 digits); both together return the networks matching both. A malformed filter or an unknown query parameter returns `400` with code `10001`.
      * List mobile networks
      */
-    commonGetMobileNetworks(requestParameters: CommonGetMobileNetworksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MobileNetworkListResponse>;
+    commonGetMobileNetworks(requestParameters: CommonGetMobileNetworksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MobileNetworkList>;
 }
 /**
  *
@@ -84,12 +84,12 @@ export declare class CommonApi extends runtime.BaseAPI implements CommonApiInter
      * Lists every country and territory with its codes, English name, calling code and flag.  Returns `{ items }`, the whole list ordered by `countryCode`, without paging. `countryCode` is the ISO 3166-1 alpha-2 code every service filters and reports by. The endpoint takes no query parameters; an unknown parameter returns `400` with code `10001`.
      * List countries
      */
-    commonGetCountriesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CountryListResponse>>;
+    commonGetCountriesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CountryList>>;
     /**
      * Lists every country and territory with its codes, English name, calling code and flag.  Returns `{ items }`, the whole list ordered by `countryCode`, without paging. `countryCode` is the ISO 3166-1 alpha-2 code every service filters and reports by. The endpoint takes no query parameters; an unknown parameter returns `400` with code `10001`.
      * List countries
      */
-    commonGetCountries(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CountryListResponse>;
+    commonGetCountries(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CountryList>;
     /**
      * Creates request options for commonGetMobileNetworks without sending the request
      */
@@ -98,10 +98,10 @@ export declare class CommonApi extends runtime.BaseAPI implements CommonApiInter
      * Lists mobile network codes (MCC/MNC) with their operator, country and calling code.  Returns `{ items }` ordered by `mcc` then `mnc`, without paging. Optional filters: `countryCode` (ISO 3166-1 alpha-2, either case) and `mcc` (3 digits); both together return the networks matching both. A malformed filter or an unknown query parameter returns `400` with code `10001`.
      * List mobile networks
      */
-    commonGetMobileNetworksRaw(requestParameters: CommonGetMobileNetworksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MobileNetworkListResponse>>;
+    commonGetMobileNetworksRaw(requestParameters: CommonGetMobileNetworksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MobileNetworkList>>;
     /**
      * Lists mobile network codes (MCC/MNC) with their operator, country and calling code.  Returns `{ items }` ordered by `mcc` then `mnc`, without paging. Optional filters: `countryCode` (ISO 3166-1 alpha-2, either case) and `mcc` (3 digits); both together return the networks matching both. A malformed filter or an unknown query parameter returns `400` with code `10001`.
      * List mobile networks
      */
-    commonGetMobileNetworks(requestParameters?: CommonGetMobileNetworksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MobileNetworkListResponse>;
+    commonGetMobileNetworks(requestParameters?: CommonGetMobileNetworksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MobileNetworkList>;
 }

package/dist/apis/CommonApi.js

@@ -24,8 +24,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CommonApi = void 0;
 const runtime = require("../runtime");
-const CountryListResponse_1 = require("../models/CountryListResponse");
-const MobileNetworkListResponse_1 = require("../models/MobileNetworkListResponse");
+const CountryList_1 = require("../models/CountryList");
+const MobileNetworkList_1 = require("../models/MobileNetworkList");
 /**
  *
  */
@@ -57,7 +57,7 @@ class CommonApi extends runtime.BaseAPI {
         return __awaiter(this, void 0, void 0, function* () {
             const requestOptions = yield this.commonGetCountriesRequestOpts();
             const response = yield this.request(requestOptions, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => (0, CountryListResponse_1.CountryListResponseFromJSON)(jsonValue));
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, CountryList_1.CountryListFromJSON)(jsonValue));
         });
     }
     /**
@@ -103,7 +103,7 @@ class CommonApi extends runtime.BaseAPI {
         return __awaiter(this, void 0, void 0, function* () {
             const requestOptions = yield this.commonGetMobileNetworksRequestOpts(requestParameters);
             const response = yield this.request(requestOptions, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => (0, MobileNetworkListResponse_1.MobileNetworkListResponseFromJSON)(jsonValue));
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, MobileNetworkList_1.MobileNetworkListFromJSON)(jsonValue));
         });
     }
     /**

package/dist/apis/CurrenciesApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import { type GetB2BAllCurrenciesCommandResponse } from '../models/GetB2BAllCurrenciesCommandResponse';
+import { type CurrencyList } from '../models/CurrencyList';
 /**
  * CurrenciesApi - interface
  *
@@ -31,12 +31,12 @@ export interface CurrenciesApiInterface {
      * @throws {RequiredError}
      * @memberof CurrenciesApiInterface
      */
-    currenciesGetAllRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetB2BAllCurrenciesCommandResponse>>;
+    currenciesGetAllRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CurrencyList>>;
     /**
      * Lists every supported currency with its current rate to USD.  Returns `{ currencies }`, the whole list without paging. Use a currency\'s `code` wherever a request takes a `currency`, and its `id` as `currencyId` when creating a wallet. `rateToUsd` is the USD value of one unit of the currency, as of `rateDate`.
      * List currencies
      */
-    currenciesGetAll(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetB2BAllCurrenciesCommandResponse>;
+    currenciesGetAll(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CurrencyList>;
 }
 /**
  *
@@ -50,10 +50,10 @@ export declare class CurrenciesApi extends runtime.BaseAPI implements Currencies
      * Lists every supported currency with its current rate to USD.  Returns `{ currencies }`, the whole list without paging. Use a currency\'s `code` wherever a request takes a `currency`, and its `id` as `currencyId` when creating a wallet. `rateToUsd` is the USD value of one unit of the currency, as of `rateDate`.
      * List currencies
      */
-    currenciesGetAllRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetB2BAllCurrenciesCommandResponse>>;
+    currenciesGetAllRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CurrencyList>>;
     /**
      * Lists every supported currency with its current rate to USD.  Returns `{ currencies }`, the whole list without paging. Use a currency\'s `code` wherever a request takes a `currency`, and its `id` as `currencyId` when creating a wallet. `rateToUsd` is the USD value of one unit of the currency, as of `rateDate`.
      * List currencies
      */
-    currenciesGetAll(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetB2BAllCurrenciesCommandResponse>;
+    currenciesGetAll(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CurrencyList>;
 }

package/dist/apis/CurrenciesApi.js

@@ -24,7 +24,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CurrenciesApi = void 0;
 const runtime = require("../runtime");
-const GetB2BAllCurrenciesCommandResponse_1 = require("../models/GetB2BAllCurrenciesCommandResponse");
+const CurrencyList_1 = require("../models/CurrencyList");
 /**
  *
  */
@@ -56,7 +56,7 @@ class CurrenciesApi extends runtime.BaseAPI {
         return __awaiter(this, void 0, void 0, function* () {
             const requestOptions = yield this.currenciesGetAllRequestOpts();
             const response = yield this.request(requestOptions, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetB2BAllCurrenciesCommandResponse_1.GetB2BAllCurrenciesCommandResponseFromJSON)(jsonValue));
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, CurrencyList_1.CurrencyListFromJSON)(jsonValue));
         });
     }
     /**