pingram 1.0.12 → 1.0.13-alpha.1197

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.
Files changed (26) hide show
  1. package/dist/generated/src/apis/NumbersApi.d.ts +53 -9
  2. package/dist/generated/src/apis/NumbersApi.js +108 -4
  3. package/dist/generated/src/apis/index.d.ts +1 -1
  4. package/dist/generated/src/models/A2pRegistration.d.ts +1 -1
  5. package/dist/generated/src/models/ListPhoneNumbersResponse.d.ts +1 -1
  6. package/dist/generated/src/models/ListPhoneNumbersResponseNumbersInner.d.ts +60 -1
  7. package/dist/generated/src/models/ListPhoneNumbersResponseNumbersInner.js +46 -2
  8. package/dist/generated/src/models/ListReleasedPhoneNumbersResponse.d.ts +33 -0
  9. package/dist/generated/src/models/ListReleasedPhoneNumbersResponse.js +51 -0
  10. package/dist/generated/src/models/OrderPhoneNumberRequest.d.ts +1 -1
  11. package/dist/generated/src/models/OrderPhoneNumberResponse.d.ts +1 -1
  12. package/dist/generated/src/models/OrganizationUsage.d.ts +7 -1
  13. package/dist/generated/src/models/OrganizationUsage.js +4 -0
  14. package/dist/generated/src/models/OrganizationUsageHistoryItemsInner.d.ts +7 -1
  15. package/dist/generated/src/models/OrganizationUsageHistoryItemsInner.js +4 -0
  16. package/dist/generated/src/models/ReleasePhoneNumberResponse.d.ts +44 -0
  17. package/dist/generated/src/models/ReleasePhoneNumberResponse.js +56 -0
  18. package/dist/generated/src/models/SearchAvailablePhoneNumbersResponse.d.ts +1 -1
  19. package/dist/generated/src/models/SearchAvailablePhoneNumbersResponseNumbersInner.d.ts +6 -0
  20. package/dist/generated/src/models/SearchAvailablePhoneNumbersResponseNumbersInner.js +6 -2
  21. package/dist/generated/src/models/SendSmsRequest.d.ts +1 -8
  22. package/dist/generated/src/models/SendSmsRequest.js +2 -7
  23. package/dist/generated/src/models/index.d.ts +2 -0
  24. package/dist/generated/src/models/index.js +2 -0
  25. package/dist/src/client.js +1 -1
  26. package/package.json +1 -1
@@ -10,10 +10,13 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import type { ListPhoneNumbersResponse, OrderPhoneNumberRequest, OrderPhoneNumberResponse, SearchAvailablePhoneNumbersResponse } from '../models/index';
13
+ import type { ListPhoneNumbersResponse, ListReleasedPhoneNumbersResponse, OrderPhoneNumberRequest, OrderPhoneNumberResponse, ReleasePhoneNumberResponse, SearchAvailablePhoneNumbersResponse } from '../models/index';
14
14
  export interface OrderNumberRequest {
15
15
  orderPhoneNumberRequest: OrderPhoneNumberRequest;
16
16
  }
17
+ export interface ReleaseNumberRequest {
18
+ phoneNumber: string;
19
+ }
17
20
  export interface SearchAvailableRequest {
18
21
  countryCode: string;
19
22
  features?: string;
@@ -29,19 +32,31 @@ export interface SearchAvailableRequest {
29
32
  export interface NumbersApiInterface {
30
33
  /**
31
34
  *
32
- * @summary List all phone numbers registered for the account
35
+ * @summary List active phone numbers registered for the account
33
36
  * @param {*} [options] Override http request option.
34
37
  * @throws {RequiredError}
35
38
  * @memberof NumbersApiInterface
36
39
  */
37
40
  listRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListPhoneNumbersResponse>>;
38
41
  /**
39
- * List all phone numbers registered for the account
42
+ * List active phone numbers registered for the account
40
43
  */
41
44
  list(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListPhoneNumbersResponse>;
42
45
  /**
43
46
  *
44
- * @summary Purchase a phone number for the authenticated account
47
+ * @summary List released phone numbers. Released numbers may be purchased again with 2 weeks of being released. Released numbers may be removed from released list after 2 weeks.
48
+ * @param {*} [options] Override http request option.
49
+ * @throws {RequiredError}
50
+ * @memberof NumbersApiInterface
51
+ */
52
+ listReleasedRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListReleasedPhoneNumbersResponse>>;
53
+ /**
54
+ * List released phone numbers. Released numbers may be purchased again with 2 weeks of being released. Released numbers may be removed from released list after 2 weeks.
55
+ */
56
+ listReleased(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListReleasedPhoneNumbersResponse>;
57
+ /**
58
+ *
59
+ * @summary Purchase a phone number for the authenticated account, or reactivate a released number owned by the account (preserves original createdAt).
45
60
  * @param {OrderPhoneNumberRequest} orderPhoneNumberRequest
46
61
  * @param {*} [options] Override http request option.
47
62
  * @throws {RequiredError}
@@ -49,9 +64,22 @@ export interface NumbersApiInterface {
49
64
  */
50
65
  orderNumberRaw(requestParameters: OrderNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderPhoneNumberResponse>>;
51
66
  /**
52
- * Purchase a phone number for the authenticated account
67
+ * Purchase a phone number for the authenticated account, or reactivate a released number owned by the account (preserves original createdAt).
53
68
  */
54
69
  orderNumber(orderPhoneNumberRequest: OrderPhoneNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderPhoneNumberResponse>;
70
+ /**
71
+ *
72
+ * @summary Release a phone number from the account. No refund for the current billing month.
73
+ * @param {string} phoneNumber E.164 phone number to release
74
+ * @param {*} [options] Override http request option.
75
+ * @throws {RequiredError}
76
+ * @memberof NumbersApiInterface
77
+ */
78
+ releaseNumberRaw(requestParameters: ReleaseNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReleasePhoneNumberResponse>>;
79
+ /**
80
+ * Release a phone number from the account. No refund for the current billing month.
81
+ */
82
+ releaseNumber(phoneNumber: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReleasePhoneNumberResponse>;
55
83
  /**
56
84
  *
57
85
  * @summary Search for available phone numbers
@@ -74,21 +102,37 @@ export interface NumbersApiInterface {
74
102
  */
75
103
  export declare class NumbersApi extends runtime.BaseAPI implements NumbersApiInterface {
76
104
  /**
77
- * List all phone numbers registered for the account
105
+ * List active phone numbers registered for the account
78
106
  */
79
107
  listRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListPhoneNumbersResponse>>;
80
108
  /**
81
- * List all phone numbers registered for the account
109
+ * List active phone numbers registered for the account
82
110
  */
83
111
  list(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListPhoneNumbersResponse>;
84
112
  /**
85
- * Purchase a phone number for the authenticated account
113
+ * List released phone numbers. Released numbers may be purchased again with 2 weeks of being released. Released numbers may be removed from released list after 2 weeks.
114
+ */
115
+ listReleasedRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListReleasedPhoneNumbersResponse>>;
116
+ /**
117
+ * List released phone numbers. Released numbers may be purchased again with 2 weeks of being released. Released numbers may be removed from released list after 2 weeks.
118
+ */
119
+ listReleased(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListReleasedPhoneNumbersResponse>;
120
+ /**
121
+ * Purchase a phone number for the authenticated account, or reactivate a released number owned by the account (preserves original createdAt).
86
122
  */
87
123
  orderNumberRaw(requestParameters: OrderNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderPhoneNumberResponse>>;
88
124
  /**
89
- * Purchase a phone number for the authenticated account
125
+ * Purchase a phone number for the authenticated account, or reactivate a released number owned by the account (preserves original createdAt).
90
126
  */
91
127
  orderNumber(orderPhoneNumberRequest: OrderPhoneNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderPhoneNumberResponse>;
128
+ /**
129
+ * Release a phone number from the account. No refund for the current billing month.
130
+ */
131
+ releaseNumberRaw(requestParameters: ReleaseNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReleasePhoneNumberResponse>>;
132
+ /**
133
+ * Release a phone number from the account. No refund for the current billing month.
134
+ */
135
+ releaseNumber(phoneNumber: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReleasePhoneNumberResponse>;
92
136
  /**
93
137
  * Search for available phone numbers
94
138
  */
@@ -54,7 +54,7 @@ const index_1 = require("../models/index");
54
54
  */
55
55
  class NumbersApi extends runtime.BaseAPI {
56
56
  /**
57
- * List all phone numbers registered for the account
57
+ * List active phone numbers registered for the account
58
58
  */
59
59
  async listRaw(initOverrides) {
60
60
  const queryParameters = {};
@@ -97,14 +97,64 @@ class NumbersApi extends runtime.BaseAPI {
97
97
  return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ListPhoneNumbersResponseFromJSON)(jsonValue));
98
98
  }
99
99
  /**
100
- * List all phone numbers registered for the account
100
+ * List active phone numbers registered for the account
101
101
  */
102
102
  async list(initOverrides) {
103
103
  const response = await this.listRaw(initOverrides);
104
104
  return await response.value();
105
105
  }
106
106
  /**
107
- * Purchase a phone number for the authenticated account
107
+ * List released phone numbers. Released numbers may be purchased again with 2 weeks of being released. Released numbers may be removed from released list after 2 weeks.
108
+ */
109
+ async listReleasedRaw(initOverrides) {
110
+ const queryParameters = {};
111
+ const headerParameters = {};
112
+ if (this.configuration &&
113
+ (this.configuration.username !== undefined ||
114
+ this.configuration.password !== undefined)) {
115
+ headerParameters['Authorization'] =
116
+ 'Basic ' +
117
+ btoa(this.configuration.username + ':' + this.configuration.password);
118
+ }
119
+ if (this.configuration &&
120
+ (this.configuration.username !== undefined ||
121
+ this.configuration.password !== undefined)) {
122
+ headerParameters['Authorization'] =
123
+ 'Basic ' +
124
+ btoa(this.configuration.username + ':' + this.configuration.password);
125
+ }
126
+ if (this.configuration && this.configuration.accessToken) {
127
+ const token = this.configuration.accessToken;
128
+ const tokenString = await token('apiKey', []);
129
+ if (tokenString) {
130
+ headerParameters['Authorization'] = `Bearer ${tokenString}`;
131
+ }
132
+ }
133
+ if (this.configuration &&
134
+ (this.configuration.username !== undefined ||
135
+ this.configuration.password !== undefined)) {
136
+ headerParameters['Authorization'] =
137
+ 'Basic ' +
138
+ btoa(this.configuration.username + ':' + this.configuration.password);
139
+ }
140
+ let urlPath = `/numbers/released`;
141
+ const response = await this.request({
142
+ path: urlPath,
143
+ method: 'GET',
144
+ headers: headerParameters,
145
+ query: queryParameters
146
+ }, initOverrides);
147
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ListReleasedPhoneNumbersResponseFromJSON)(jsonValue));
148
+ }
149
+ /**
150
+ * List released phone numbers. Released numbers may be purchased again with 2 weeks of being released. Released numbers may be removed from released list after 2 weeks.
151
+ */
152
+ async listReleased(initOverrides) {
153
+ const response = await this.listReleasedRaw(initOverrides);
154
+ return await response.value();
155
+ }
156
+ /**
157
+ * Purchase a phone number for the authenticated account, or reactivate a released number owned by the account (preserves original createdAt).
108
158
  */
109
159
  async orderNumberRaw(requestParameters, initOverrides) {
110
160
  if (requestParameters['orderPhoneNumberRequest'] == null) {
@@ -152,12 +202,66 @@ class NumbersApi extends runtime.BaseAPI {
152
202
  return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.OrderPhoneNumberResponseFromJSON)(jsonValue));
153
203
  }
154
204
  /**
155
- * Purchase a phone number for the authenticated account
205
+ * Purchase a phone number for the authenticated account, or reactivate a released number owned by the account (preserves original createdAt).
156
206
  */
157
207
  async orderNumber(orderPhoneNumberRequest, initOverrides) {
158
208
  const response = await this.orderNumberRaw({ orderPhoneNumberRequest: orderPhoneNumberRequest }, initOverrides);
159
209
  return await response.value();
160
210
  }
211
+ /**
212
+ * Release a phone number from the account. No refund for the current billing month.
213
+ */
214
+ async releaseNumberRaw(requestParameters, initOverrides) {
215
+ if (requestParameters['phoneNumber'] == null) {
216
+ throw new runtime.RequiredError('phoneNumber', 'Required parameter "phoneNumber" was null or undefined when calling releaseNumber().');
217
+ }
218
+ const queryParameters = {};
219
+ const headerParameters = {};
220
+ if (this.configuration &&
221
+ (this.configuration.username !== undefined ||
222
+ this.configuration.password !== undefined)) {
223
+ headerParameters['Authorization'] =
224
+ 'Basic ' +
225
+ btoa(this.configuration.username + ':' + this.configuration.password);
226
+ }
227
+ if (this.configuration &&
228
+ (this.configuration.username !== undefined ||
229
+ this.configuration.password !== undefined)) {
230
+ headerParameters['Authorization'] =
231
+ 'Basic ' +
232
+ btoa(this.configuration.username + ':' + this.configuration.password);
233
+ }
234
+ if (this.configuration && this.configuration.accessToken) {
235
+ const token = this.configuration.accessToken;
236
+ const tokenString = await token('apiKey', []);
237
+ if (tokenString) {
238
+ headerParameters['Authorization'] = `Bearer ${tokenString}`;
239
+ }
240
+ }
241
+ if (this.configuration &&
242
+ (this.configuration.username !== undefined ||
243
+ this.configuration.password !== undefined)) {
244
+ headerParameters['Authorization'] =
245
+ 'Basic ' +
246
+ btoa(this.configuration.username + ':' + this.configuration.password);
247
+ }
248
+ let urlPath = `/numbers/{phoneNumber}`;
249
+ urlPath = urlPath.replace(`{${'phoneNumber'}}`, encodeURIComponent(String(requestParameters['phoneNumber'])));
250
+ const response = await this.request({
251
+ path: urlPath,
252
+ method: 'DELETE',
253
+ headers: headerParameters,
254
+ query: queryParameters
255
+ }, initOverrides);
256
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ReleasePhoneNumberResponseFromJSON)(jsonValue));
257
+ }
258
+ /**
259
+ * Release a phone number from the account. No refund for the current billing month.
260
+ */
261
+ async releaseNumber(phoneNumber, initOverrides) {
262
+ const response = await this.releaseNumberRaw({ phoneNumber: phoneNumber }, initOverrides);
263
+ return await response.value();
264
+ }
161
265
  /**
162
266
  * Search for available phone numbers
163
267
  */
@@ -28,7 +28,7 @@ export type { GetLogsRequest, GetLogsByTrackingIdsRequest, GetLogsQueryResultReq
28
28
  export { LogsApi } from './LogsApi';
29
29
  export type { GetAutoJoinRequest, InviteMemberRequest, ListMembersRequest, RemoveMemberRequest, SetAutoJoinRequest, UpdateRequest, MembersApiInterface } from './MembersApi';
30
30
  export { MembersApi } from './MembersApi';
31
- export type { OrderNumberRequest, SearchAvailableRequest, NumbersApiInterface } from './NumbersApi';
31
+ export type { OrderNumberRequest, ReleaseNumberRequest, SearchAvailableRequest, NumbersApiInterface } from './NumbersApi';
32
32
  export { NumbersApi } from './NumbersApi';
33
33
  export type { GetUsageHistoryRequest, OrganizationApiInterface } from './OrganizationApi';
34
34
  export { OrganizationApi } from './OrganizationApi';
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * Public response type for A2P registration - excludes internal Telnyx IDs
13
+ * Public response type for A2P registration
14
14
  * @export
15
15
  * @interface A2pRegistration
16
16
  */
@@ -11,7 +11,7 @@
11
11
  */
12
12
  import type { ListPhoneNumbersResponseNumbersInner } from './ListPhoneNumbersResponseNumbersInner';
13
13
  /**
14
- * Response for GET /numbers/list
14
+ *
15
15
  * @export
16
16
  * @interface ListPhoneNumbersResponse
17
17
  */
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * One phone number owned by the account
13
+ * Represents a phone number in the account
14
14
  * @export
15
15
  * @interface ListPhoneNumbersResponseNumbersInner
16
16
  */
@@ -33,6 +33,65 @@ export interface ListPhoneNumbersResponseNumbersInner {
33
33
  * @memberof ListPhoneNumbersResponseNumbersInner
34
34
  */
35
35
  createdAt: string;
36
+ /**
37
+ * ISO 3166-1 alpha-2 country code
38
+ * @type {string}
39
+ * @memberof ListPhoneNumbersResponseNumbersInner
40
+ */
41
+ countryCode: string;
42
+ /**
43
+ * e.g. local, toll_free
44
+ * @type {string}
45
+ * @memberof ListPhoneNumbersResponseNumbersInner
46
+ */
47
+ numberType: string;
48
+ /**
49
+ * active or released
50
+ * @type {string}
51
+ * @memberof ListPhoneNumbersResponseNumbersInner
52
+ */
53
+ billingStatus: ListPhoneNumbersResponseNumbersInnerBillingStatusEnum;
54
+ /**
55
+ * YYYY-MM-DD next monthly rent charge
56
+ * @type {string}
57
+ * @memberof ListPhoneNumbersResponseNumbersInner
58
+ */
59
+ nextBillingDate: string;
60
+ /**
61
+ * Monthly cost in USD
62
+ * @type {number}
63
+ * @memberof ListPhoneNumbersResponseNumbersInner
64
+ */
65
+ monthlyPrice: number;
66
+ /**
67
+ * US 10DLC readiness derived from stored campaign assignment
68
+ * @type {string}
69
+ * @memberof ListPhoneNumbersResponseNumbersInner
70
+ */
71
+ a2pStatus?: ListPhoneNumbersResponseNumbersInnerA2pStatusEnum;
72
+ /**
73
+ * ISO timestamp when the number was released (released numbers only)
74
+ * @type {string}
75
+ * @memberof ListPhoneNumbersResponseNumbersInner
76
+ */
77
+ releasedAt?: string;
78
+ }
79
+ /**
80
+ * @export
81
+ * @enum {string}
82
+ */
83
+ export declare enum ListPhoneNumbersResponseNumbersInnerBillingStatusEnum {
84
+ ACTIVE = "active",
85
+ RELEASED = "released"
86
+ }
87
+ /**
88
+ * @export
89
+ * @enum {string}
90
+ */
91
+ export declare enum ListPhoneNumbersResponseNumbersInnerA2pStatusEnum {
92
+ PENDING = "pending",
93
+ TESTING = "testing",
94
+ APPROVED = "approved"
36
95
  }
37
96
  /**
38
97
  * Check if a given object implements the ListPhoneNumbersResponseNumbersInner interface.
@@ -13,11 +13,31 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.ListPhoneNumbersResponseNumbersInnerA2pStatusEnum = exports.ListPhoneNumbersResponseNumbersInnerBillingStatusEnum = void 0;
16
17
  exports.instanceOfListPhoneNumbersResponseNumbersInner = instanceOfListPhoneNumbersResponseNumbersInner;
17
18
  exports.ListPhoneNumbersResponseNumbersInnerFromJSON = ListPhoneNumbersResponseNumbersInnerFromJSON;
18
19
  exports.ListPhoneNumbersResponseNumbersInnerFromJSONTyped = ListPhoneNumbersResponseNumbersInnerFromJSONTyped;
19
20
  exports.ListPhoneNumbersResponseNumbersInnerToJSON = ListPhoneNumbersResponseNumbersInnerToJSON;
20
21
  exports.ListPhoneNumbersResponseNumbersInnerToJSONTyped = ListPhoneNumbersResponseNumbersInnerToJSONTyped;
22
+ /**
23
+ * @export
24
+ * @enum {string}
25
+ */
26
+ var ListPhoneNumbersResponseNumbersInnerBillingStatusEnum;
27
+ (function (ListPhoneNumbersResponseNumbersInnerBillingStatusEnum) {
28
+ ListPhoneNumbersResponseNumbersInnerBillingStatusEnum["ACTIVE"] = "active";
29
+ ListPhoneNumbersResponseNumbersInnerBillingStatusEnum["RELEASED"] = "released";
30
+ })(ListPhoneNumbersResponseNumbersInnerBillingStatusEnum || (exports.ListPhoneNumbersResponseNumbersInnerBillingStatusEnum = ListPhoneNumbersResponseNumbersInnerBillingStatusEnum = {}));
31
+ /**
32
+ * @export
33
+ * @enum {string}
34
+ */
35
+ var ListPhoneNumbersResponseNumbersInnerA2pStatusEnum;
36
+ (function (ListPhoneNumbersResponseNumbersInnerA2pStatusEnum) {
37
+ ListPhoneNumbersResponseNumbersInnerA2pStatusEnum["PENDING"] = "pending";
38
+ ListPhoneNumbersResponseNumbersInnerA2pStatusEnum["TESTING"] = "testing";
39
+ ListPhoneNumbersResponseNumbersInnerA2pStatusEnum["APPROVED"] = "approved";
40
+ })(ListPhoneNumbersResponseNumbersInnerA2pStatusEnum || (exports.ListPhoneNumbersResponseNumbersInnerA2pStatusEnum = ListPhoneNumbersResponseNumbersInnerA2pStatusEnum = {}));
21
41
  /**
22
42
  * Check if a given object implements the ListPhoneNumbersResponseNumbersInner interface.
23
43
  */
@@ -26,6 +46,16 @@ function instanceOfListPhoneNumbersResponseNumbersInner(value) {
26
46
  return false;
27
47
  if (!('createdAt' in value) || value['createdAt'] === undefined)
28
48
  return false;
49
+ if (!('countryCode' in value) || value['countryCode'] === undefined)
50
+ return false;
51
+ if (!('numberType' in value) || value['numberType'] === undefined)
52
+ return false;
53
+ if (!('billingStatus' in value) || value['billingStatus'] === undefined)
54
+ return false;
55
+ if (!('nextBillingDate' in value) || value['nextBillingDate'] === undefined)
56
+ return false;
57
+ if (!('monthlyPrice' in value) || value['monthlyPrice'] === undefined)
58
+ return false;
29
59
  return true;
30
60
  }
31
61
  function ListPhoneNumbersResponseNumbersInnerFromJSON(json) {
@@ -38,7 +68,14 @@ function ListPhoneNumbersResponseNumbersInnerFromJSONTyped(json, ignoreDiscrimin
38
68
  return {
39
69
  phoneNumber: json['phoneNumber'],
40
70
  label: json['label'] == null ? undefined : json['label'],
41
- createdAt: json['createdAt']
71
+ createdAt: json['createdAt'],
72
+ countryCode: json['countryCode'],
73
+ numberType: json['numberType'],
74
+ billingStatus: json['billingStatus'],
75
+ nextBillingDate: json['nextBillingDate'],
76
+ monthlyPrice: json['monthlyPrice'],
77
+ a2pStatus: json['a2pStatus'] == null ? undefined : json['a2pStatus'],
78
+ releasedAt: json['releasedAt'] == null ? undefined : json['releasedAt']
42
79
  };
43
80
  }
44
81
  function ListPhoneNumbersResponseNumbersInnerToJSON(json) {
@@ -51,6 +88,13 @@ function ListPhoneNumbersResponseNumbersInnerToJSONTyped(value, ignoreDiscrimina
51
88
  return {
52
89
  phoneNumber: value['phoneNumber'],
53
90
  label: value['label'],
54
- createdAt: value['createdAt']
91
+ createdAt: value['createdAt'],
92
+ countryCode: value['countryCode'],
93
+ numberType: value['numberType'],
94
+ billingStatus: value['billingStatus'],
95
+ nextBillingDate: value['nextBillingDate'],
96
+ monthlyPrice: value['monthlyPrice'],
97
+ a2pStatus: value['a2pStatus'],
98
+ releasedAt: value['releasedAt']
55
99
  };
56
100
  }
@@ -0,0 +1,33 @@
1
+ /**
2
+ * Pingram
3
+ * Internal API for notification delivery and management
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { ListPhoneNumbersResponseNumbersInner } from './ListPhoneNumbersResponseNumbersInner';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface ListReleasedPhoneNumbersResponse
17
+ */
18
+ export interface ListReleasedPhoneNumbersResponse {
19
+ /**
20
+ *
21
+ * @type {Array<ListPhoneNumbersResponseNumbersInner>}
22
+ * @memberof ListReleasedPhoneNumbersResponse
23
+ */
24
+ numbers: Array<ListPhoneNumbersResponseNumbersInner>;
25
+ }
26
+ /**
27
+ * Check if a given object implements the ListReleasedPhoneNumbersResponse interface.
28
+ */
29
+ export declare function instanceOfListReleasedPhoneNumbersResponse(value: object): value is ListReleasedPhoneNumbersResponse;
30
+ export declare function ListReleasedPhoneNumbersResponseFromJSON(json: any): ListReleasedPhoneNumbersResponse;
31
+ export declare function ListReleasedPhoneNumbersResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListReleasedPhoneNumbersResponse;
32
+ export declare function ListReleasedPhoneNumbersResponseToJSON(json: any): ListReleasedPhoneNumbersResponse;
33
+ export declare function ListReleasedPhoneNumbersResponseToJSONTyped(value?: ListReleasedPhoneNumbersResponse | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,51 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Pingram
6
+ * Internal API for notification delivery and management
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfListReleasedPhoneNumbersResponse = instanceOfListReleasedPhoneNumbersResponse;
17
+ exports.ListReleasedPhoneNumbersResponseFromJSON = ListReleasedPhoneNumbersResponseFromJSON;
18
+ exports.ListReleasedPhoneNumbersResponseFromJSONTyped = ListReleasedPhoneNumbersResponseFromJSONTyped;
19
+ exports.ListReleasedPhoneNumbersResponseToJSON = ListReleasedPhoneNumbersResponseToJSON;
20
+ exports.ListReleasedPhoneNumbersResponseToJSONTyped = ListReleasedPhoneNumbersResponseToJSONTyped;
21
+ const ListPhoneNumbersResponseNumbersInner_1 = require("./ListPhoneNumbersResponseNumbersInner");
22
+ /**
23
+ * Check if a given object implements the ListReleasedPhoneNumbersResponse interface.
24
+ */
25
+ function instanceOfListReleasedPhoneNumbersResponse(value) {
26
+ if (!('numbers' in value) || value['numbers'] === undefined)
27
+ return false;
28
+ return true;
29
+ }
30
+ function ListReleasedPhoneNumbersResponseFromJSON(json) {
31
+ return ListReleasedPhoneNumbersResponseFromJSONTyped(json, false);
32
+ }
33
+ function ListReleasedPhoneNumbersResponseFromJSONTyped(json, ignoreDiscriminator) {
34
+ if (json == null) {
35
+ return json;
36
+ }
37
+ return {
38
+ numbers: json['numbers'].map(ListPhoneNumbersResponseNumbersInner_1.ListPhoneNumbersResponseNumbersInnerFromJSON)
39
+ };
40
+ }
41
+ function ListReleasedPhoneNumbersResponseToJSON(json) {
42
+ return ListReleasedPhoneNumbersResponseToJSONTyped(json, false);
43
+ }
44
+ function ListReleasedPhoneNumbersResponseToJSONTyped(value, ignoreDiscriminator = false) {
45
+ if (value == null) {
46
+ return value;
47
+ }
48
+ return {
49
+ numbers: (value['numbers'] ?? []).map(ListPhoneNumbersResponseNumbersInner_1.ListPhoneNumbersResponseNumbersInnerToJSON)
50
+ };
51
+ }
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * Request body for POST /numbers/order
13
+ *
14
14
  * @export
15
15
  * @interface OrderPhoneNumberRequest
16
16
  */
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * Response for POST /numbers/order
13
+ *
14
14
  * @export
15
15
  * @interface OrderPhoneNumberResponse
16
16
  */
@@ -22,7 +22,7 @@ export interface OrganizationUsage {
22
22
  */
23
23
  messageUsage: number;
24
24
  /**
25
- * Total budget usage in USD (cost_SMS + cost_CALL)
25
+ * Total budget usage in USD (cost_SMS + cost_CALL + cost_NUMBER)
26
26
  * @type {number}
27
27
  * @memberof OrganizationUsage
28
28
  */
@@ -39,6 +39,12 @@ export interface OrganizationUsage {
39
39
  * @memberof OrganizationUsage
40
40
  */
41
41
  costCall: number;
42
+ /**
43
+ * Phone number rent in USD
44
+ * @type {number}
45
+ * @memberof OrganizationUsage
46
+ */
47
+ costNumber: number;
42
48
  /**
43
49
  * Per-channel usage breakdown
44
50
  * @type {{ [key: string]: number; }}
@@ -30,6 +30,8 @@ function instanceOfOrganizationUsage(value) {
30
30
  return false;
31
31
  if (!('costCall' in value) || value['costCall'] === undefined)
32
32
  return false;
33
+ if (!('costNumber' in value) || value['costNumber'] === undefined)
34
+ return false;
33
35
  if (!('channelUsages' in value) || value['channelUsages'] === undefined)
34
36
  return false;
35
37
  if (!('billingCycleStart' in value) ||
@@ -51,6 +53,7 @@ function OrganizationUsageFromJSONTyped(json, ignoreDiscriminator) {
51
53
  budgetUsage: json['budgetUsage'],
52
54
  costSms: json['costSms'],
53
55
  costCall: json['costCall'],
56
+ costNumber: json['costNumber'],
54
57
  channelUsages: json['channelUsages'],
55
58
  billingCycleStart: json['billingCycleStart'],
56
59
  billingCycleEnd: json['billingCycleEnd']
@@ -68,6 +71,7 @@ function OrganizationUsageToJSONTyped(value, ignoreDiscriminator = false) {
68
71
  budgetUsage: value['budgetUsage'],
69
72
  costSms: value['costSms'],
70
73
  costCall: value['costCall'],
74
+ costNumber: value['costNumber'],
71
75
  channelUsages: value['channelUsages'],
72
76
  billingCycleStart: value['billingCycleStart'],
73
77
  billingCycleEnd: value['billingCycleEnd']
@@ -28,7 +28,7 @@ export interface OrganizationUsageHistoryItemsInner {
28
28
  */
29
29
  messageUsage: number;
30
30
  /**
31
- * Total budget usage in USD (cost_SMS + cost_CALL)
31
+ * Total budget usage in USD (cost_SMS + cost_CALL + cost_NUMBER)
32
32
  * @type {number}
33
33
  * @memberof OrganizationUsageHistoryItemsInner
34
34
  */
@@ -45,6 +45,12 @@ export interface OrganizationUsageHistoryItemsInner {
45
45
  * @memberof OrganizationUsageHistoryItemsInner
46
46
  */
47
47
  costCall: number;
48
+ /**
49
+ * Phone number rent in USD
50
+ * @type {number}
51
+ * @memberof OrganizationUsageHistoryItemsInner
52
+ */
53
+ costNumber: number;
48
54
  /**
49
55
  * Per-channel usage breakdown
50
56
  * @type {{ [key: string]: number; }}
@@ -32,6 +32,8 @@ function instanceOfOrganizationUsageHistoryItemsInner(value) {
32
32
  return false;
33
33
  if (!('costCall' in value) || value['costCall'] === undefined)
34
34
  return false;
35
+ if (!('costNumber' in value) || value['costNumber'] === undefined)
36
+ return false;
35
37
  if (!('channelUsages' in value) || value['channelUsages'] === undefined)
36
38
  return false;
37
39
  return true;
@@ -49,6 +51,7 @@ function OrganizationUsageHistoryItemsInnerFromJSONTyped(json, ignoreDiscriminat
49
51
  budgetUsage: json['budgetUsage'],
50
52
  costSms: json['costSms'],
51
53
  costCall: json['costCall'],
54
+ costNumber: json['costNumber'],
52
55
  channelUsages: json['channelUsages']
53
56
  };
54
57
  }
@@ -65,6 +68,7 @@ function OrganizationUsageHistoryItemsInnerToJSONTyped(value, ignoreDiscriminato
65
68
  budgetUsage: value['budgetUsage'],
66
69
  costSms: value['costSms'],
67
70
  costCall: value['costCall'],
71
+ costNumber: value['costNumber'],
68
72
  channelUsages: value['channelUsages']
69
73
  };
70
74
  }
@@ -0,0 +1,44 @@
1
+ /**
2
+ * Pingram
3
+ * Internal API for notification delivery and management
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface ReleasePhoneNumberResponse
16
+ */
17
+ export interface ReleasePhoneNumberResponse {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof ReleasePhoneNumberResponse
22
+ */
23
+ phoneNumber: string;
24
+ /**
25
+ *
26
+ * @type {boolean}
27
+ * @memberof ReleasePhoneNumberResponse
28
+ */
29
+ released: boolean;
30
+ /**
31
+ * ISO timestamp when the number was released
32
+ * @type {string}
33
+ * @memberof ReleasePhoneNumberResponse
34
+ */
35
+ releasedAt?: string;
36
+ }
37
+ /**
38
+ * Check if a given object implements the ReleasePhoneNumberResponse interface.
39
+ */
40
+ export declare function instanceOfReleasePhoneNumberResponse(value: object): value is ReleasePhoneNumberResponse;
41
+ export declare function ReleasePhoneNumberResponseFromJSON(json: any): ReleasePhoneNumberResponse;
42
+ export declare function ReleasePhoneNumberResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReleasePhoneNumberResponse;
43
+ export declare function ReleasePhoneNumberResponseToJSON(json: any): ReleasePhoneNumberResponse;
44
+ export declare function ReleasePhoneNumberResponseToJSONTyped(value?: ReleasePhoneNumberResponse | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,56 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Pingram
6
+ * Internal API for notification delivery and management
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfReleasePhoneNumberResponse = instanceOfReleasePhoneNumberResponse;
17
+ exports.ReleasePhoneNumberResponseFromJSON = ReleasePhoneNumberResponseFromJSON;
18
+ exports.ReleasePhoneNumberResponseFromJSONTyped = ReleasePhoneNumberResponseFromJSONTyped;
19
+ exports.ReleasePhoneNumberResponseToJSON = ReleasePhoneNumberResponseToJSON;
20
+ exports.ReleasePhoneNumberResponseToJSONTyped = ReleasePhoneNumberResponseToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the ReleasePhoneNumberResponse interface.
23
+ */
24
+ function instanceOfReleasePhoneNumberResponse(value) {
25
+ if (!('phoneNumber' in value) || value['phoneNumber'] === undefined)
26
+ return false;
27
+ if (!('released' in value) || value['released'] === undefined)
28
+ return false;
29
+ return true;
30
+ }
31
+ function ReleasePhoneNumberResponseFromJSON(json) {
32
+ return ReleasePhoneNumberResponseFromJSONTyped(json, false);
33
+ }
34
+ function ReleasePhoneNumberResponseFromJSONTyped(json, ignoreDiscriminator) {
35
+ if (json == null) {
36
+ return json;
37
+ }
38
+ return {
39
+ phoneNumber: json['phoneNumber'],
40
+ released: json['released'],
41
+ releasedAt: json['releasedAt'] == null ? undefined : json['releasedAt']
42
+ };
43
+ }
44
+ function ReleasePhoneNumberResponseToJSON(json) {
45
+ return ReleasePhoneNumberResponseToJSONTyped(json, false);
46
+ }
47
+ function ReleasePhoneNumberResponseToJSONTyped(value, ignoreDiscriminator = false) {
48
+ if (value == null) {
49
+ return value;
50
+ }
51
+ return {
52
+ phoneNumber: value['phoneNumber'],
53
+ released: value['released'],
54
+ releasedAt: value['releasedAt']
55
+ };
56
+ }
@@ -11,7 +11,7 @@
11
11
  */
12
12
  import type { SearchAvailablePhoneNumbersResponseNumbersInner } from './SearchAvailablePhoneNumbersResponseNumbersInner';
13
13
  /**
14
- * Response for GET /numbers/available
14
+ *
15
15
  * @export
16
16
  * @interface SearchAvailablePhoneNumbersResponse
17
17
  */
@@ -45,6 +45,12 @@ export interface SearchAvailablePhoneNumbersResponseNumbersInner {
45
45
  * @memberof SearchAvailablePhoneNumbersResponseNumbersInner
46
46
  */
47
47
  features?: Array<string>;
48
+ /**
49
+ * Monthly cost in USD
50
+ * @type {number}
51
+ * @memberof SearchAvailablePhoneNumbersResponseNumbersInner
52
+ */
53
+ monthlyPrice: number;
48
54
  }
49
55
  /**
50
56
  * Check if a given object implements the SearchAvailablePhoneNumbersResponseNumbersInner interface.
@@ -24,6 +24,8 @@ exports.SearchAvailablePhoneNumbersResponseNumbersInnerToJSONTyped = SearchAvail
24
24
  function instanceOfSearchAvailablePhoneNumbersResponseNumbersInner(value) {
25
25
  if (!('phoneNumber' in value) || value['phoneNumber'] === undefined)
26
26
  return false;
27
+ if (!('monthlyPrice' in value) || value['monthlyPrice'] === undefined)
28
+ return false;
27
29
  return true;
28
30
  }
29
31
  function SearchAvailablePhoneNumbersResponseNumbersInnerFromJSON(json) {
@@ -40,7 +42,8 @@ function SearchAvailablePhoneNumbersResponseNumbersInnerFromJSONTyped(json, igno
40
42
  ? undefined
41
43
  : json['administrativeArea'],
42
44
  phoneNumberType: json['phoneNumberType'] == null ? undefined : json['phoneNumberType'],
43
- features: json['features'] == null ? undefined : json['features']
45
+ features: json['features'] == null ? undefined : json['features'],
46
+ monthlyPrice: json['monthlyPrice']
44
47
  };
45
48
  }
46
49
  function SearchAvailablePhoneNumbersResponseNumbersInnerToJSON(json) {
@@ -55,6 +58,7 @@ function SearchAvailablePhoneNumbersResponseNumbersInnerToJSONTyped(value, ignor
55
58
  locality: value['locality'],
56
59
  administrativeArea: value['administrativeArea'],
57
60
  phoneNumberType: value['phoneNumberType'],
58
- features: value['features']
61
+ features: value['features'],
62
+ monthlyPrice: value['monthlyPrice']
59
63
  };
60
64
  }
@@ -9,7 +9,6 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- import type { SenderPostBodySmsAutoReply } from './SenderPostBodySmsAutoReply';
13
12
  /**
14
13
  * Request body for `POST /sms` (send SMS without a template).
15
14
  * @export
@@ -41,17 +40,11 @@ export interface SendSmsRequest {
41
40
  */
42
41
  schedule?: string;
43
42
  /**
44
- * Override the sender phone number. Must be a verified number in your Telnyx account.
43
+ * Override the sender phone number. Must be a dedicated number on your Pingram account.
45
44
  * @type {string}
46
45
  * @memberof SendSmsRequest
47
46
  */
48
47
  from?: string;
49
- /**
50
- *
51
- * @type {SenderPostBodySmsAutoReply}
52
- * @memberof SendSmsRequest
53
- */
54
- autoReply?: SenderPostBodySmsAutoReply;
55
48
  }
56
49
  /**
57
50
  * Check if a given object implements the SendSmsRequest interface.
@@ -18,7 +18,6 @@ exports.SendSmsRequestFromJSON = SendSmsRequestFromJSON;
18
18
  exports.SendSmsRequestFromJSONTyped = SendSmsRequestFromJSONTyped;
19
19
  exports.SendSmsRequestToJSON = SendSmsRequestToJSON;
20
20
  exports.SendSmsRequestToJSONTyped = SendSmsRequestToJSONTyped;
21
- const SenderPostBodySmsAutoReply_1 = require("./SenderPostBodySmsAutoReply");
22
21
  /**
23
22
  * Check if a given object implements the SendSmsRequest interface.
24
23
  */
@@ -43,10 +42,7 @@ function SendSmsRequestFromJSONTyped(json, ignoreDiscriminator) {
43
42
  to: json['to'],
44
43
  message: json['message'],
45
44
  schedule: json['schedule'] == null ? undefined : json['schedule'],
46
- from: json['from'] == null ? undefined : json['from'],
47
- autoReply: json['autoReply'] == null
48
- ? undefined
49
- : (0, SenderPostBodySmsAutoReply_1.SenderPostBodySmsAutoReplyFromJSON)(json['autoReply'])
45
+ from: json['from'] == null ? undefined : json['from']
50
46
  };
51
47
  }
52
48
  function SendSmsRequestToJSON(json) {
@@ -61,7 +57,6 @@ function SendSmsRequestToJSONTyped(value, ignoreDiscriminator = false) {
61
57
  to: value['to'],
62
58
  message: value['message'],
63
59
  schedule: value['schedule'],
64
- from: value['from'],
65
- autoReply: (0, SenderPostBodySmsAutoReply_1.SenderPostBodySmsAutoReplyToJSON)(value['autoReply'])
60
+ from: value['from']
66
61
  };
67
62
  }
@@ -118,6 +118,7 @@ export * from './IntercomWebhookDataItemAnyOfSourceAuthor';
118
118
  export * from './InvitePostResponse';
119
119
  export * from './ListPhoneNumbersResponse';
120
120
  export * from './ListPhoneNumbersResponseNumbersInner';
121
+ export * from './ListReleasedPhoneNumbersResponse';
121
122
  export * from './LogQueryPostBody';
122
123
  export * from './LogsBulkRequest';
123
124
  export * from './LogsGetResponse';
@@ -150,6 +151,7 @@ export * from './PostSendersRequestBody';
150
151
  export * from './PostUserRequest';
151
152
  export * from './PushSettingsFCMPutRequest';
152
153
  export * from './PushSettingsFCMResponse';
154
+ export * from './ReleasePhoneNumberResponse';
153
155
  export * from './SearchAvailablePhoneNumbersResponse';
154
156
  export * from './SearchAvailablePhoneNumbersResponseNumbersInner';
155
157
  export * from './SendEmailApiResponse';
@@ -136,6 +136,7 @@ __exportStar(require("./IntercomWebhookDataItemAnyOfSourceAuthor"), exports);
136
136
  __exportStar(require("./InvitePostResponse"), exports);
137
137
  __exportStar(require("./ListPhoneNumbersResponse"), exports);
138
138
  __exportStar(require("./ListPhoneNumbersResponseNumbersInner"), exports);
139
+ __exportStar(require("./ListReleasedPhoneNumbersResponse"), exports);
139
140
  __exportStar(require("./LogQueryPostBody"), exports);
140
141
  __exportStar(require("./LogsBulkRequest"), exports);
141
142
  __exportStar(require("./LogsGetResponse"), exports);
@@ -168,6 +169,7 @@ __exportStar(require("./PostSendersRequestBody"), exports);
168
169
  __exportStar(require("./PostUserRequest"), exports);
169
170
  __exportStar(require("./PushSettingsFCMPutRequest"), exports);
170
171
  __exportStar(require("./PushSettingsFCMResponse"), exports);
172
+ __exportStar(require("./ReleasePhoneNumberResponse"), exports);
171
173
  __exportStar(require("./SearchAvailablePhoneNumbersResponse"), exports);
172
174
  __exportStar(require("./SearchAvailablePhoneNumbersResponseNumbersInner"), exports);
173
175
  __exportStar(require("./SendEmailApiResponse"), exports);
@@ -8,7 +8,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
8
8
  exports.Pingram = void 0;
9
9
  const src_1 = require("../generated/src");
10
10
  // SDK version for User-Agent header (injected at codegen time)
11
- const SDK_VERSION = '1.0.12';
11
+ const SDK_VERSION = '1.0.13';
12
12
  const USER_AGENT = `pingram-node/${SDK_VERSION}`;
13
13
  const src_2 = require("../generated/src");
14
14
  const src_3 = require("../generated/src");
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "pingram",
3
- "version": "1.0.12",
3
+ "version": "1.0.13-alpha.1197",
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",