pingram 1.0.43-alpha.1750 → 1.0.43-alpha.1752

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -22,6 +22,10 @@ export interface SearchAvailableRequest {
22
22
  features?: string;
23
23
  areaCode?: string;
24
24
  limit?: number;
25
+ startsWith?: string;
26
+ endsWith?: string;
27
+ contains?: string;
28
+ city?: string;
25
29
  }
26
30
  /**
27
31
  * NumbersApi - interface
@@ -85,22 +89,26 @@ export interface NumbersApiInterface {
85
89
  */
86
90
  releaseNumber(phoneNumber: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReleasePhoneNumberResponse>;
87
91
  /**
88
- * Search for available phone numbers to purchase. Requires `countryCode` (e.g. US, CA). Use before ordering a number.
92
+ * Search for available phone numbers to purchase. Requires `countryCode` (e.g. US, CA). Narrow the results with an area code, a city, or digits the number should start with, end with, or contain. Use before ordering a number.
89
93
  * @summary Search for available phone numbers to purchase
90
94
  * @param {string} countryCode ISO 3166-1 alpha-2 country code (e.g., US, CA)
91
95
  * @param {string} [features] Comma-separated
92
96
  * @param {string} [areaCode] National destination / area code filter
93
97
  * @param {number} [limit] Max results (default 10, max 50)
98
+ * @param {string} [startsWith] Digits the number starts with, 1 to 7 digits. Do not include the country code. When &#x60;areaCode&#x60; is set, omit those digits here.
99
+ * @param {string} [endsWith] Digits the number must end with, 1 to 7 digits. Use this to find a number close to one you already have.
100
+ * @param {string} [contains] Digits to find in the number, in that order, 1 to 7 digits.
101
+ * @param {string} [city] City to search in, such as San Francisco.
94
102
  * @param {*} [options] Override http request option.
95
103
  * @throws {RequiredError}
96
104
  * @memberof NumbersApiInterface
97
105
  */
98
106
  searchAvailableRaw(requestParameters: SearchAvailableRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchAvailablePhoneNumbersResponse>>;
99
107
  /**
100
- * Search for available phone numbers to purchase. Requires `countryCode` (e.g. US, CA). Use before ordering a number.
108
+ * Search for available phone numbers to purchase. Requires `countryCode` (e.g. US, CA). Narrow the results with an area code, a city, or digits the number should start with, end with, or contain. Use before ordering a number.
101
109
  * Search for available phone numbers to purchase
102
110
  */
103
- searchAvailable(countryCode: string, features?: string, areaCode?: string, limit?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchAvailablePhoneNumbersResponse>;
111
+ searchAvailable(countryCode: string, features?: string, areaCode?: string, limit?: number, startsWith?: string, endsWith?: string, contains?: string, city?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchAvailablePhoneNumbersResponse>;
104
112
  }
105
113
  /**
106
114
  *
@@ -147,13 +155,13 @@ export declare class NumbersApi extends runtime.BaseAPI implements NumbersApiInt
147
155
  */
148
156
  releaseNumber(phoneNumber: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReleasePhoneNumberResponse>;
149
157
  /**
150
- * Search for available phone numbers to purchase. Requires `countryCode` (e.g. US, CA). Use before ordering a number.
158
+ * Search for available phone numbers to purchase. Requires `countryCode` (e.g. US, CA). Narrow the results with an area code, a city, or digits the number should start with, end with, or contain. Use before ordering a number.
151
159
  * Search for available phone numbers to purchase
152
160
  */
153
161
  searchAvailableRaw(requestParameters: SearchAvailableRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchAvailablePhoneNumbersResponse>>;
154
162
  /**
155
- * Search for available phone numbers to purchase. Requires `countryCode` (e.g. US, CA). Use before ordering a number.
163
+ * Search for available phone numbers to purchase. Requires `countryCode` (e.g. US, CA). Narrow the results with an area code, a city, or digits the number should start with, end with, or contain. Use before ordering a number.
156
164
  * Search for available phone numbers to purchase
157
165
  */
158
- searchAvailable(countryCode: string, features?: string, areaCode?: string, limit?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchAvailablePhoneNumbersResponse>;
166
+ searchAvailable(countryCode: string, features?: string, areaCode?: string, limit?: number, startsWith?: string, endsWith?: string, contains?: string, city?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchAvailablePhoneNumbersResponse>;
159
167
  }
@@ -271,7 +271,7 @@ class NumbersApi extends runtime.BaseAPI {
271
271
  return await response.value();
272
272
  }
273
273
  /**
274
- * Search for available phone numbers to purchase. Requires `countryCode` (e.g. US, CA). Use before ordering a number.
274
+ * Search for available phone numbers to purchase. Requires `countryCode` (e.g. US, CA). Narrow the results with an area code, a city, or digits the number should start with, end with, or contain. Use before ordering a number.
275
275
  * Search for available phone numbers to purchase
276
276
  */
277
277
  async searchAvailableRaw(requestParameters, initOverrides) {
@@ -291,6 +291,18 @@ class NumbersApi extends runtime.BaseAPI {
291
291
  if (requestParameters['limit'] != null) {
292
292
  queryParameters['limit'] = requestParameters['limit'];
293
293
  }
294
+ if (requestParameters['startsWith'] != null) {
295
+ queryParameters['startsWith'] = requestParameters['startsWith'];
296
+ }
297
+ if (requestParameters['endsWith'] != null) {
298
+ queryParameters['endsWith'] = requestParameters['endsWith'];
299
+ }
300
+ if (requestParameters['contains'] != null) {
301
+ queryParameters['contains'] = requestParameters['contains'];
302
+ }
303
+ if (requestParameters['city'] != null) {
304
+ queryParameters['city'] = requestParameters['city'];
305
+ }
294
306
  const headerParameters = {};
295
307
  if (this.configuration &&
296
308
  (this.configuration.username !== undefined ||
@@ -330,15 +342,19 @@ class NumbersApi extends runtime.BaseAPI {
330
342
  return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.SearchAvailablePhoneNumbersResponseFromJSON)(jsonValue));
331
343
  }
332
344
  /**
333
- * Search for available phone numbers to purchase. Requires `countryCode` (e.g. US, CA). Use before ordering a number.
345
+ * Search for available phone numbers to purchase. Requires `countryCode` (e.g. US, CA). Narrow the results with an area code, a city, or digits the number should start with, end with, or contain. Use before ordering a number.
334
346
  * Search for available phone numbers to purchase
335
347
  */
336
- async searchAvailable(countryCode, features, areaCode, limit, initOverrides) {
348
+ async searchAvailable(countryCode, features, areaCode, limit, startsWith, endsWith, contains, city, initOverrides) {
337
349
  const response = await this.searchAvailableRaw({
338
350
  countryCode: countryCode,
339
351
  features: features,
340
352
  areaCode: areaCode,
341
- limit: limit
353
+ limit: limit,
354
+ startsWith: startsWith,
355
+ endsWith: endsWith,
356
+ contains: contains,
357
+ city: city
342
358
  }, initOverrides);
343
359
  return await response.value();
344
360
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "pingram",
3
- "version": "1.0.43-alpha.1750",
3
+ "version": "1.0.43-alpha.1752",
4
4
  "description": "Official Node.js SDK for Pingram - Send notifications via Email, SMS, Push, In-App, and more",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.js",