@zavudev/sdk 0.16.0 → 0.18.0
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.
- package/CHANGELOG.md +16 -0
- package/client.d.mts +11 -5
- package/client.d.mts.map +1 -1
- package/client.d.ts +11 -5
- package/client.d.ts.map +1 -1
- package/client.js +7 -1
- package/client.js.map +1 -1
- package/client.mjs +7 -1
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/addresses.d.mts +104 -0
- package/resources/addresses.d.mts.map +1 -0
- package/resources/addresses.d.ts +104 -0
- package/resources/addresses.d.ts.map +1 -0
- package/resources/addresses.js +72 -0
- package/resources/addresses.js.map +1 -0
- package/resources/addresses.mjs +68 -0
- package/resources/addresses.mjs.map +1 -0
- package/resources/broadcasts/broadcasts.d.mts +27 -5
- package/resources/broadcasts/broadcasts.d.mts.map +1 -1
- package/resources/broadcasts/broadcasts.d.ts +27 -5
- package/resources/broadcasts/broadcasts.d.ts.map +1 -1
- package/resources/broadcasts/broadcasts.js +15 -0
- package/resources/broadcasts/broadcasts.js.map +1 -1
- package/resources/broadcasts/broadcasts.mjs +15 -0
- package/resources/broadcasts/broadcasts.mjs.map +1 -1
- package/resources/broadcasts/index.d.mts +1 -1
- package/resources/broadcasts/index.d.mts.map +1 -1
- package/resources/broadcasts/index.d.ts +1 -1
- package/resources/broadcasts/index.d.ts.map +1 -1
- package/resources/broadcasts/index.js.map +1 -1
- package/resources/broadcasts/index.mjs.map +1 -1
- package/resources/index.d.mts +5 -3
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +5 -3
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +6 -2
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +3 -1
- package/resources/index.mjs.map +1 -1
- package/resources/phone-numbers.d.mts +67 -1
- package/resources/phone-numbers.d.mts.map +1 -1
- package/resources/phone-numbers.d.ts +67 -1
- package/resources/phone-numbers.d.ts.map +1 -1
- package/resources/phone-numbers.js +15 -0
- package/resources/phone-numbers.js.map +1 -1
- package/resources/phone-numbers.mjs +15 -0
- package/resources/phone-numbers.mjs.map +1 -1
- package/resources/regulatory-documents.d.mts +114 -0
- package/resources/regulatory-documents.d.mts.map +1 -0
- package/resources/regulatory-documents.d.ts +114 -0
- package/resources/regulatory-documents.d.ts.map +1 -0
- package/resources/regulatory-documents.js +84 -0
- package/resources/regulatory-documents.js.map +1 -0
- package/resources/regulatory-documents.mjs +80 -0
- package/resources/regulatory-documents.mjs.map +1 -0
- package/resources/senders/agent/agent.d.mts +230 -0
- package/resources/senders/agent/agent.d.mts.map +1 -0
- package/resources/senders/agent/agent.d.ts +230 -0
- package/resources/senders/agent/agent.d.ts.map +1 -0
- package/resources/senders/agent/agent.js +105 -0
- package/resources/senders/agent/agent.js.map +1 -0
- package/resources/senders/agent/agent.mjs +100 -0
- package/resources/senders/agent/agent.mjs.map +1 -0
- package/resources/senders/agent/executions.d.mts +32 -0
- package/resources/senders/agent/executions.d.mts.map +1 -0
- package/resources/senders/agent/executions.d.ts +32 -0
- package/resources/senders/agent/executions.d.ts.map +1 -0
- package/resources/senders/agent/executions.js +27 -0
- package/resources/senders/agent/executions.js.map +1 -0
- package/resources/senders/agent/executions.mjs +23 -0
- package/resources/senders/agent/executions.mjs.map +1 -0
- package/resources/senders/agent/flows.d.mts +301 -0
- package/resources/senders/agent/flows.d.mts.map +1 -0
- package/resources/senders/agent/flows.d.ts +301 -0
- package/resources/senders/agent/flows.d.ts.map +1 -0
- package/resources/senders/agent/flows.js +135 -0
- package/resources/senders/agent/flows.js.map +1 -0
- package/resources/senders/agent/flows.mjs +131 -0
- package/resources/senders/agent/flows.mjs.map +1 -0
- package/resources/senders/agent/index.d.mts +6 -0
- package/resources/senders/agent/index.d.mts.map +1 -0
- package/resources/senders/agent/index.d.ts +6 -0
- package/resources/senders/agent/index.d.ts.map +1 -0
- package/resources/senders/agent/index.js +15 -0
- package/resources/senders/agent/index.js.map +1 -0
- package/resources/senders/agent/index.mjs +7 -0
- package/resources/senders/agent/index.mjs.map +1 -0
- package/resources/senders/agent/knowledge-bases/documents.d.mts +86 -0
- package/resources/senders/agent/knowledge-bases/documents.d.mts.map +1 -0
- package/resources/senders/agent/knowledge-bases/documents.d.ts +86 -0
- package/resources/senders/agent/knowledge-bases/documents.d.ts.map +1 -0
- package/resources/senders/agent/knowledge-bases/documents.js +70 -0
- package/resources/senders/agent/knowledge-bases/documents.js.map +1 -0
- package/resources/senders/agent/knowledge-bases/documents.mjs +66 -0
- package/resources/senders/agent/knowledge-bases/documents.mjs.map +1 -0
- package/resources/senders/agent/knowledge-bases/index.d.mts +3 -0
- package/resources/senders/agent/knowledge-bases/index.d.mts.map +1 -0
- package/resources/senders/agent/knowledge-bases/index.d.ts +3 -0
- package/resources/senders/agent/knowledge-bases/index.d.ts.map +1 -0
- package/resources/senders/agent/knowledge-bases/index.js +9 -0
- package/resources/senders/agent/knowledge-bases/index.js.map +1 -0
- package/resources/senders/agent/knowledge-bases/index.mjs +4 -0
- package/resources/senders/agent/knowledge-bases/index.mjs.map +1 -0
- package/resources/senders/agent/knowledge-bases/knowledge-bases.d.mts +147 -0
- package/resources/senders/agent/knowledge-bases/knowledge-bases.d.mts.map +1 -0
- package/resources/senders/agent/knowledge-bases/knowledge-bases.d.ts +147 -0
- package/resources/senders/agent/knowledge-bases/knowledge-bases.d.ts.map +1 -0
- package/resources/senders/agent/knowledge-bases/knowledge-bases.js +106 -0
- package/resources/senders/agent/knowledge-bases/knowledge-bases.js.map +1 -0
- package/resources/senders/agent/knowledge-bases/knowledge-bases.mjs +101 -0
- package/resources/senders/agent/knowledge-bases/knowledge-bases.mjs.map +1 -0
- package/resources/senders/agent/knowledge-bases.d.mts +2 -0
- package/resources/senders/agent/knowledge-bases.d.mts.map +1 -0
- package/resources/senders/agent/knowledge-bases.d.ts +2 -0
- package/resources/senders/agent/knowledge-bases.d.ts.map +1 -0
- package/resources/senders/agent/knowledge-bases.js +6 -0
- package/resources/senders/agent/knowledge-bases.js.map +1 -0
- package/resources/senders/agent/knowledge-bases.mjs +3 -0
- package/resources/senders/agent/knowledge-bases.mjs.map +1 -0
- package/resources/senders/agent/tools.d.mts +242 -0
- package/resources/senders/agent/tools.d.mts.map +1 -0
- package/resources/senders/agent/tools.d.ts +242 -0
- package/resources/senders/agent/tools.d.ts.map +1 -0
- package/resources/senders/agent/tools.js +126 -0
- package/resources/senders/agent/tools.js.map +1 -0
- package/resources/senders/agent/tools.mjs +122 -0
- package/resources/senders/agent/tools.mjs.map +1 -0
- package/resources/senders/agent.d.mts +2 -0
- package/resources/senders/agent.d.mts.map +1 -0
- package/resources/senders/agent.d.ts +2 -0
- package/resources/senders/agent.d.ts.map +1 -0
- package/resources/senders/agent.js +6 -0
- package/resources/senders/agent.js.map +1 -0
- package/resources/senders/agent.mjs +3 -0
- package/resources/senders/agent.mjs.map +1 -0
- package/resources/senders/index.d.mts +3 -0
- package/resources/senders/index.d.mts.map +1 -0
- package/resources/senders/index.d.ts +3 -0
- package/resources/senders/index.d.ts.map +1 -0
- package/resources/senders/index.js +9 -0
- package/resources/senders/index.js.map +1 -0
- package/resources/senders/index.mjs +4 -0
- package/resources/senders/index.mjs.map +1 -0
- package/resources/senders/senders.d.mts +342 -0
- package/resources/senders/senders.d.mts.map +1 -0
- package/resources/senders/senders.d.ts +342 -0
- package/resources/senders/senders.d.ts.map +1 -0
- package/resources/senders/senders.js +150 -0
- package/resources/senders/senders.js.map +1 -0
- package/resources/senders/senders.mjs +145 -0
- package/resources/senders/senders.mjs.map +1 -0
- package/resources/senders.d.mts +1 -337
- package/resources/senders.d.mts.map +1 -1
- package/resources/senders.d.ts +1 -337
- package/resources/senders.d.ts.map +1 -1
- package/resources/senders.js +2 -138
- package/resources/senders.js.map +1 -1
- package/resources/senders.mjs +1 -136
- package/resources/senders.mjs.map +1 -1
- package/src/client.ts +79 -17
- package/src/resources/addresses.ts +160 -0
- package/src/resources/broadcasts/broadcasts.ts +37 -4
- package/src/resources/broadcasts/index.ts +2 -0
- package/src/resources/index.ts +29 -1
- package/src/resources/phone-numbers.ts +97 -0
- package/src/resources/regulatory-documents.ts +184 -0
- package/src/resources/senders/agent/agent.ts +417 -0
- package/src/resources/senders/agent/executions.ts +48 -0
- package/src/resources/senders/agent/flows.ts +409 -0
- package/src/resources/senders/agent/index.ts +60 -0
- package/src/resources/senders/agent/knowledge-bases/documents.ts +133 -0
- package/src/resources/senders/agent/knowledge-bases/index.ts +24 -0
- package/src/resources/senders/agent/knowledge-bases/knowledge-bases.ts +251 -0
- package/src/resources/senders/agent/knowledge-bases.ts +3 -0
- package/src/resources/senders/agent/tools.ts +334 -0
- package/src/resources/senders/agent.ts +3 -0
- package/src/resources/senders/index.ts +32 -0
- package/src/resources/senders/senders.ts +506 -0
- package/src/resources/senders.ts +1 -476
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/resources/index.d.ts
CHANGED
|
@@ -1,8 +1,10 @@
|
|
|
1
|
-
export {
|
|
1
|
+
export { Addresses, type Address, type AddressStatus, type AddressCreateResponse, type AddressRetrieveResponse, type AddressCreateParams, type AddressListParams, type AddressesCursor, } from "./addresses.js";
|
|
2
|
+
export { Broadcasts, type Broadcast, type BroadcastChannel, type BroadcastContact, type BroadcastContactStatus, type BroadcastContent, type BroadcastMessageType, type BroadcastProgress, type BroadcastStatus, type BroadcastCreateResponse, type BroadcastRetrieveResponse, type BroadcastUpdateResponse, type BroadcastCancelResponse, type BroadcastRescheduleResponse, type BroadcastSendResponse, type BroadcastCreateParams, type BroadcastUpdateParams, type BroadcastListParams, type BroadcastRescheduleParams, type BroadcastSendParams, type BroadcastContactsCursor, type BroadcastsCursor, } from "./broadcasts/broadcasts.js";
|
|
2
3
|
export { Contacts, type Contact, type ContactUpdateParams, type ContactListParams, type ContactsCursor, } from "./contacts.js";
|
|
3
4
|
export { Introspect, type LineType, type IntrospectValidatePhoneResponse, type IntrospectValidatePhoneParams, } from "./introspect.js";
|
|
4
5
|
export { Messages, type Channel, type Message, type MessageContent, type MessageResponse, type MessageStatus, type MessageType, type MessageListParams, type MessageReactParams, type MessageSendParams, type MessagesCursor, } from "./messages.js";
|
|
5
|
-
export { PhoneNumbers, type AvailablePhoneNumber, type OwnedPhoneNumber, type OwnedPhoneNumberPricing, type PhoneNumberCapabilities, type PhoneNumberPricing, type PhoneNumberStatus, type PhoneNumberType, type PhoneNumberRetrieveResponse, type PhoneNumberUpdateResponse, type PhoneNumberPurchaseResponse, type PhoneNumberSearchAvailableResponse, type PhoneNumberUpdateParams, type PhoneNumberListParams, type PhoneNumberPurchaseParams, type PhoneNumberSearchAvailableParams, type OwnedPhoneNumbersCursor, } from "./phone-numbers.js";
|
|
6
|
-
export {
|
|
6
|
+
export { PhoneNumbers, type AvailablePhoneNumber, type OwnedPhoneNumber, type OwnedPhoneNumberPricing, type PhoneNumberCapabilities, type PhoneNumberPricing, type PhoneNumberStatus, type PhoneNumberType, type Requirement, type RequirementAcceptanceCriteria, type RequirementFieldType, type RequirementType, type PhoneNumberRetrieveResponse, type PhoneNumberUpdateResponse, type PhoneNumberPurchaseResponse, type PhoneNumberRequirementsResponse, type PhoneNumberSearchAvailableResponse, type PhoneNumberUpdateParams, type PhoneNumberListParams, type PhoneNumberPurchaseParams, type PhoneNumberRequirementsParams, type PhoneNumberSearchAvailableParams, type OwnedPhoneNumbersCursor, } from "./phone-numbers.js";
|
|
7
|
+
export { RegulatoryDocuments, type RegulatoryDocument, type RegulatoryDocumentCreateResponse, type RegulatoryDocumentRetrieveResponse, type RegulatoryDocumentUploadURLResponse, type RegulatoryDocumentCreateParams, type RegulatoryDocumentListParams, type RegulatoryDocumentsCursor, } from "./regulatory-documents.js";
|
|
8
|
+
export { Senders, type Sender, type SenderWebhook, type WebhookEvent, type WebhookSecretResponse, type WhatsappBusinessProfile, type WhatsappBusinessProfileResponse, type WhatsappBusinessProfileVertical, type SenderUpdateProfileResponse, type SenderUploadProfilePictureResponse, type SenderCreateParams, type SenderUpdateParams, type SenderListParams, type SenderUpdateProfileParams, type SenderUploadProfilePictureParams, type SendersCursor, } from "./senders/senders.js";
|
|
7
9
|
export { Templates, type Template, type WhatsappCategory, type TemplateCreateParams, type TemplateListParams, type TemplateSubmitParams, type TemplatesCursor, } from "./templates.js";
|
|
8
10
|
//# sourceMappingURL=index.d.ts.map
|
package/resources/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"OAEO,EACL,UAAU,EACV,KAAK,SAAS,EACd,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,sBAAsB,EAC3B,KAAK,gBAAgB,EACrB,KAAK,oBAAoB,EACzB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,uBAAuB,EAC5B,KAAK,yBAAyB,EAC9B,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EACxB,KAAK,uBAAuB,EAC5B,KAAK,gBAAgB,GACtB;OACM,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,cAAc,GACpB;OACM,EACL,UAAU,EACV,KAAK,QAAQ,EACb,KAAK,+BAA+B,EACpC,KAAK,6BAA6B,GACnC;OACM,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,OAAO,EACZ,KAAK,cAAc,EACnB,KAAK,eAAe,EACpB,KAAK,aAAa,EAClB,KAAK,WAAW,EAChB,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EACvB,KAAK,iBAAiB,EACtB,KAAK,cAAc,GACpB;OACM,EACL,YAAY,EACZ,KAAK,oBAAoB,EACzB,KAAK,gBAAgB,EACrB,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,kBAAkB,EACvB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,2BAA2B,EAChC,KAAK,yBAAyB,EAC9B,KAAK,2BAA2B,EAChC,KAAK,kCAAkC,EACvC,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,yBAAyB,EAC9B,KAAK,gCAAgC,EACrC,KAAK,uBAAuB,GAC7B;OACM,EACL,OAAO,EACP,KAAK,MAAM,EACX,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,EAC5B,KAAK,+BAA+B,EACpC,KAAK,+BAA+B,EACpC,KAAK,2BAA2B,EAChC,KAAK,kCAAkC,EACvC,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,yBAAyB,EAC9B,KAAK,gCAAgC,EACrC,KAAK,aAAa,GACnB;OACM,EACL,SAAS,EACT,KAAK,QAAQ,EACb,KAAK,gBAAgB,EACrB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EACzB,KAAK,eAAe,GACrB"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"OAEO,EACL,SAAS,EACT,KAAK,OAAO,EACZ,KAAK,aAAa,EAClB,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,EAC5B,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,eAAe,GACrB;OACM,EACL,UAAU,EACV,KAAK,SAAS,EACd,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,sBAAsB,EAC3B,KAAK,gBAAgB,EACrB,KAAK,oBAAoB,EACzB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,uBAAuB,EAC5B,KAAK,yBAAyB,EAC9B,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,2BAA2B,EAChC,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,yBAAyB,EAC9B,KAAK,mBAAmB,EACxB,KAAK,uBAAuB,EAC5B,KAAK,gBAAgB,GACtB;OACM,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,cAAc,GACpB;OACM,EACL,UAAU,EACV,KAAK,QAAQ,EACb,KAAK,+BAA+B,EACpC,KAAK,6BAA6B,GACnC;OACM,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,OAAO,EACZ,KAAK,cAAc,EACnB,KAAK,eAAe,EACpB,KAAK,aAAa,EAClB,KAAK,WAAW,EAChB,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EACvB,KAAK,iBAAiB,EACtB,KAAK,cAAc,GACpB;OACM,EACL,YAAY,EACZ,KAAK,oBAAoB,EACzB,KAAK,gBAAgB,EACrB,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,kBAAkB,EACvB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,WAAW,EAChB,KAAK,6BAA6B,EAClC,KAAK,oBAAoB,EACzB,KAAK,eAAe,EACpB,KAAK,2BAA2B,EAChC,KAAK,yBAAyB,EAC9B,KAAK,2BAA2B,EAChC,KAAK,+BAA+B,EACpC,KAAK,kCAAkC,EACvC,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,yBAAyB,EAC9B,KAAK,6BAA6B,EAClC,KAAK,gCAAgC,EACrC,KAAK,uBAAuB,GAC7B;OACM,EACL,mBAAmB,EACnB,KAAK,kBAAkB,EACvB,KAAK,gCAAgC,EACrC,KAAK,kCAAkC,EACvC,KAAK,mCAAmC,EACxC,KAAK,8BAA8B,EACnC,KAAK,4BAA4B,EACjC,KAAK,yBAAyB,GAC/B;OACM,EACL,OAAO,EACP,KAAK,MAAM,EACX,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,EAC5B,KAAK,+BAA+B,EACpC,KAAK,+BAA+B,EACpC,KAAK,2BAA2B,EAChC,KAAK,kCAAkC,EACvC,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,yBAAyB,EAC9B,KAAK,gCAAgC,EACrC,KAAK,aAAa,GACnB;OACM,EACL,SAAS,EACT,KAAK,QAAQ,EACb,KAAK,gBAAgB,EACrB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EACzB,KAAK,eAAe,GACrB"}
|
package/resources/index.js
CHANGED
|
@@ -1,7 +1,9 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
-
exports.Templates = exports.Senders = exports.PhoneNumbers = exports.Messages = exports.Introspect = exports.Contacts = exports.Broadcasts = void 0;
|
|
4
|
+
exports.Templates = exports.Senders = exports.RegulatoryDocuments = exports.PhoneNumbers = exports.Messages = exports.Introspect = exports.Contacts = exports.Broadcasts = exports.Addresses = void 0;
|
|
5
|
+
var addresses_1 = require("./addresses.js");
|
|
6
|
+
Object.defineProperty(exports, "Addresses", { enumerable: true, get: function () { return addresses_1.Addresses; } });
|
|
5
7
|
var broadcasts_1 = require("./broadcasts/broadcasts.js");
|
|
6
8
|
Object.defineProperty(exports, "Broadcasts", { enumerable: true, get: function () { return broadcasts_1.Broadcasts; } });
|
|
7
9
|
var contacts_1 = require("./contacts.js");
|
|
@@ -12,7 +14,9 @@ var messages_1 = require("./messages.js");
|
|
|
12
14
|
Object.defineProperty(exports, "Messages", { enumerable: true, get: function () { return messages_1.Messages; } });
|
|
13
15
|
var phone_numbers_1 = require("./phone-numbers.js");
|
|
14
16
|
Object.defineProperty(exports, "PhoneNumbers", { enumerable: true, get: function () { return phone_numbers_1.PhoneNumbers; } });
|
|
15
|
-
var
|
|
17
|
+
var regulatory_documents_1 = require("./regulatory-documents.js");
|
|
18
|
+
Object.defineProperty(exports, "RegulatoryDocuments", { enumerable: true, get: function () { return regulatory_documents_1.RegulatoryDocuments; } });
|
|
19
|
+
var senders_1 = require("./senders/senders.js");
|
|
16
20
|
Object.defineProperty(exports, "Senders", { enumerable: true, get: function () { return senders_1.Senders; } });
|
|
17
21
|
var templates_1 = require("./templates.js");
|
|
18
22
|
Object.defineProperty(exports, "Templates", { enumerable: true, get: function () { return templates_1.Templates; } });
|
package/resources/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,4CASqB;AARnB,sGAAA,SAAS,OAAA;AASX,yDAuBiC;AAtB/B,wGAAA,UAAU,OAAA;AAuBZ,0CAMoB;AALlB,oGAAA,QAAQ,OAAA;AAMV,8CAKsB;AAJpB,wGAAA,UAAU,OAAA;AAKZ,0CAYoB;AAXlB,oGAAA,QAAQ,OAAA;AAYV,oDAwByB;AAvBvB,6GAAA,YAAY,OAAA;AAwBd,kEASgC;AAR9B,2HAAA,mBAAmB,OAAA;AASrB,gDAiB2B;AAhBzB,kGAAA,OAAO,OAAA;AAiBT,4CAQqB;AAPnB,sGAAA,SAAS,OAAA"}
|
package/resources/index.mjs
CHANGED
|
@@ -1,9 +1,11 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
export { Addresses, } from "./addresses.mjs";
|
|
2
3
|
export { Broadcasts, } from "./broadcasts/broadcasts.mjs";
|
|
3
4
|
export { Contacts, } from "./contacts.mjs";
|
|
4
5
|
export { Introspect, } from "./introspect.mjs";
|
|
5
6
|
export { Messages, } from "./messages.mjs";
|
|
6
7
|
export { PhoneNumbers, } from "./phone-numbers.mjs";
|
|
7
|
-
export {
|
|
8
|
+
export { RegulatoryDocuments, } from "./regulatory-documents.mjs";
|
|
9
|
+
export { Senders, } from "./senders/senders.mjs";
|
|
8
10
|
export { Templates, } from "./templates.mjs";
|
|
9
11
|
//# sourceMappingURL=index.mjs.map
|
package/resources/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,UAAU,
|
|
1
|
+
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,SAAS,GAQV;OACM,EACL,UAAU,GAsBX;OACM,EACL,QAAQ,GAKT;OACM,EACL,UAAU,GAIX;OACM,EACL,QAAQ,GAWT;OACM,EACL,YAAY,GAuBb;OACM,EACL,mBAAmB,GAQpB;OACM,EACL,OAAO,GAgBR;OACM,EACL,SAAS,GAOV"}
|
|
@@ -60,6 +60,19 @@ export declare class PhoneNumbers extends APIResource {
|
|
|
60
60
|
* ```
|
|
61
61
|
*/
|
|
62
62
|
release(phoneNumberID: string, options?: RequestOptions): APIPromise<void>;
|
|
63
|
+
/**
|
|
64
|
+
* Get regulatory requirements for purchasing phone numbers in a specific country.
|
|
65
|
+
* Some countries require additional documentation (addresses, identity documents)
|
|
66
|
+
* before phone numbers can be activated.
|
|
67
|
+
*
|
|
68
|
+
* @example
|
|
69
|
+
* ```ts
|
|
70
|
+
* const response = await client.phoneNumbers.requirements({
|
|
71
|
+
* countryCode: 'xx',
|
|
72
|
+
* });
|
|
73
|
+
* ```
|
|
74
|
+
*/
|
|
75
|
+
requirements(query: PhoneNumberRequirementsParams, options?: RequestOptions): APIPromise<PhoneNumberRequirementsResponse>;
|
|
63
76
|
/**
|
|
64
77
|
* Search for available phone numbers to purchase by country and type.
|
|
65
78
|
*
|
|
@@ -138,6 +151,46 @@ export interface PhoneNumberPricing {
|
|
|
138
151
|
}
|
|
139
152
|
export type PhoneNumberStatus = 'active' | 'suspended' | 'pending';
|
|
140
153
|
export type PhoneNumberType = 'local' | 'mobile' | 'tollFree';
|
|
154
|
+
/**
|
|
155
|
+
* A group of requirements for a specific country/phone type combination.
|
|
156
|
+
*/
|
|
157
|
+
export interface Requirement {
|
|
158
|
+
id: string;
|
|
159
|
+
action: string;
|
|
160
|
+
countryCode: string;
|
|
161
|
+
phoneNumberType: string;
|
|
162
|
+
requirementTypes: Array<RequirementType>;
|
|
163
|
+
}
|
|
164
|
+
/**
|
|
165
|
+
* Acceptance criteria for a requirement.
|
|
166
|
+
*/
|
|
167
|
+
export interface RequirementAcceptanceCriteria {
|
|
168
|
+
allowedValues?: Array<string> | null;
|
|
169
|
+
maxLength?: number | null;
|
|
170
|
+
minLength?: number | null;
|
|
171
|
+
regexPattern?: string | null;
|
|
172
|
+
}
|
|
173
|
+
/**
|
|
174
|
+
* Type of requirement field.
|
|
175
|
+
*/
|
|
176
|
+
export type RequirementFieldType = 'textual' | 'address' | 'document' | 'action';
|
|
177
|
+
/**
|
|
178
|
+
* A specific requirement type within a requirement group.
|
|
179
|
+
*/
|
|
180
|
+
export interface RequirementType {
|
|
181
|
+
id: string;
|
|
182
|
+
description: string;
|
|
183
|
+
name: string;
|
|
184
|
+
/**
|
|
185
|
+
* Type of requirement field.
|
|
186
|
+
*/
|
|
187
|
+
type: RequirementFieldType;
|
|
188
|
+
/**
|
|
189
|
+
* Acceptance criteria for a requirement.
|
|
190
|
+
*/
|
|
191
|
+
acceptanceCriteria?: RequirementAcceptanceCriteria;
|
|
192
|
+
example?: string | null;
|
|
193
|
+
}
|
|
141
194
|
export interface PhoneNumberRetrieveResponse {
|
|
142
195
|
phoneNumber: OwnedPhoneNumber;
|
|
143
196
|
}
|
|
@@ -147,6 +200,9 @@ export interface PhoneNumberUpdateResponse {
|
|
|
147
200
|
export interface PhoneNumberPurchaseResponse {
|
|
148
201
|
phoneNumber: OwnedPhoneNumber;
|
|
149
202
|
}
|
|
203
|
+
export interface PhoneNumberRequirementsResponse {
|
|
204
|
+
items: Array<Requirement>;
|
|
205
|
+
}
|
|
150
206
|
export interface PhoneNumberSearchAvailableResponse {
|
|
151
207
|
items: Array<AvailablePhoneNumber>;
|
|
152
208
|
}
|
|
@@ -176,6 +232,16 @@ export interface PhoneNumberPurchaseParams {
|
|
|
176
232
|
*/
|
|
177
233
|
name?: string;
|
|
178
234
|
}
|
|
235
|
+
export interface PhoneNumberRequirementsParams {
|
|
236
|
+
/**
|
|
237
|
+
* Two-letter ISO country code.
|
|
238
|
+
*/
|
|
239
|
+
countryCode: string;
|
|
240
|
+
/**
|
|
241
|
+
* Type of phone number (local, mobile, tollFree).
|
|
242
|
+
*/
|
|
243
|
+
type?: PhoneNumberType;
|
|
244
|
+
}
|
|
179
245
|
export interface PhoneNumberSearchAvailableParams {
|
|
180
246
|
/**
|
|
181
247
|
* Two-letter ISO country code.
|
|
@@ -195,6 +261,6 @@ export interface PhoneNumberSearchAvailableParams {
|
|
|
195
261
|
type?: PhoneNumberType;
|
|
196
262
|
}
|
|
197
263
|
export declare namespace PhoneNumbers {
|
|
198
|
-
export { type AvailablePhoneNumber as AvailablePhoneNumber, type OwnedPhoneNumber as OwnedPhoneNumber, type OwnedPhoneNumberPricing as OwnedPhoneNumberPricing, type PhoneNumberCapabilities as PhoneNumberCapabilities, type PhoneNumberPricing as PhoneNumberPricing, type PhoneNumberStatus as PhoneNumberStatus, type PhoneNumberType as PhoneNumberType, type PhoneNumberRetrieveResponse as PhoneNumberRetrieveResponse, type PhoneNumberUpdateResponse as PhoneNumberUpdateResponse, type PhoneNumberPurchaseResponse as PhoneNumberPurchaseResponse, type PhoneNumberSearchAvailableResponse as PhoneNumberSearchAvailableResponse, type OwnedPhoneNumbersCursor as OwnedPhoneNumbersCursor, type PhoneNumberUpdateParams as PhoneNumberUpdateParams, type PhoneNumberListParams as PhoneNumberListParams, type PhoneNumberPurchaseParams as PhoneNumberPurchaseParams, type PhoneNumberSearchAvailableParams as PhoneNumberSearchAvailableParams, };
|
|
264
|
+
export { type AvailablePhoneNumber as AvailablePhoneNumber, type OwnedPhoneNumber as OwnedPhoneNumber, type OwnedPhoneNumberPricing as OwnedPhoneNumberPricing, type PhoneNumberCapabilities as PhoneNumberCapabilities, type PhoneNumberPricing as PhoneNumberPricing, type PhoneNumberStatus as PhoneNumberStatus, type PhoneNumberType as PhoneNumberType, type Requirement as Requirement, type RequirementAcceptanceCriteria as RequirementAcceptanceCriteria, type RequirementFieldType as RequirementFieldType, type RequirementType as RequirementType, type PhoneNumberRetrieveResponse as PhoneNumberRetrieveResponse, type PhoneNumberUpdateResponse as PhoneNumberUpdateResponse, type PhoneNumberPurchaseResponse as PhoneNumberPurchaseResponse, type PhoneNumberRequirementsResponse as PhoneNumberRequirementsResponse, type PhoneNumberSearchAvailableResponse as PhoneNumberSearchAvailableResponse, type OwnedPhoneNumbersCursor as OwnedPhoneNumbersCursor, type PhoneNumberUpdateParams as PhoneNumberUpdateParams, type PhoneNumberListParams as PhoneNumberListParams, type PhoneNumberPurchaseParams as PhoneNumberPurchaseParams, type PhoneNumberRequirementsParams as PhoneNumberRequirementsParams, type PhoneNumberSearchAvailableParams as PhoneNumberSearchAvailableParams, };
|
|
199
265
|
}
|
|
200
266
|
//# sourceMappingURL=phone-numbers.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"phone-numbers.d.mts","sourceRoot":"","sources":["../src/resources/phone-numbers.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,MAAM,EAAE,KAAK,YAAY,EAAE,WAAW,EAAE;OAE1C,EAAE,cAAc,EAAE;AAGzB,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;OASG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,2BAA2B,CAAC;IAIlG;;;;;;;;;;OAUG;IACH,MAAM,CACJ,aAAa,EAAE,MAAM,EACrB,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAIxC;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,uBAAuB,EAAE,gBAAgB,CAAC;IAIzD;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;IAI1C;;;;;;;OAOG;IACH,OAAO,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO1E;;;;;;;;;OASG;IACH,eAAe,CACb,KAAK,EAAE,gCAAgC,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kCAAkC,CAAC;CAGlD;AAED,MAAM,MAAM,uBAAuB,GAAG,MAAM,CAAC,gBAAgB,CAAC,CAAC;AAE/D,MAAM,WAAW,oBAAoB;IACnC,YAAY,EAAE,uBAAuB,CAAC;IAEtC,WAAW,EAAE,MAAM,CAAC;IAEpB,OAAO,EAAE,kBAAkB,CAAC;IAE5B,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAC;IAEX,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE5B,SAAS,EAAE,MAAM,CAAC;IAElB,WAAW,EAAE,MAAM,CAAC;IAEpB,OAAO,EAAE,uBAAuB,CAAC;IAEjC,MAAM,EAAE,iBAAiB,CAAC;IAE1B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,uBAAuB;IACtC,GAAG,CAAC,EAAE,OAAO,CAAC;IAEd,GAAG,CAAC,EAAE,OAAO,CAAC;IAEd,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,MAAM,iBAAiB,GAAG,QAAQ,GAAG,WAAW,GAAG,SAAS,CAAC;AAEnE,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,QAAQ,GAAG,UAAU,CAAC;AAE9D,MAAM,WAAW,2BAA2B;IAC1C,WAAW,EAAE,gBAAgB,CAAC;CAC/B;AAED,MAAM,WAAW,yBAAyB;IACxC,WAAW,EAAE,gBAAgB,CAAC;CAC/B;AAED,MAAM,WAAW,2BAA2B;IAC1C,WAAW,EAAE,gBAAgB,CAAC;CAC/B;AAED,MAAM,WAAW,kCAAkC;IACjD,KAAK,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,qBAAsB,SAAQ,YAAY;IACzD;;OAEG;IACH,MAAM,CAAC,EAAE,iBAAiB,CAAC;CAC5B;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,eAAe,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,gCAAgC,IAAI,gCAAgC,GAC1E,CAAC;CACH"}
|
|
1
|
+
{"version":3,"file":"phone-numbers.d.mts","sourceRoot":"","sources":["../src/resources/phone-numbers.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,MAAM,EAAE,KAAK,YAAY,EAAE,WAAW,EAAE;OAE1C,EAAE,cAAc,EAAE;AAGzB,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;OASG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,2BAA2B,CAAC;IAIlG;;;;;;;;;;OAUG;IACH,MAAM,CACJ,aAAa,EAAE,MAAM,EACrB,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAIxC;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,uBAAuB,EAAE,gBAAgB,CAAC;IAIzD;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;IAI1C;;;;;;;OAOG;IACH,OAAO,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO1E;;;;;;;;;;;OAWG;IACH,YAAY,CACV,KAAK,EAAE,6BAA6B,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+BAA+B,CAAC;IAI9C;;;;;;;;;OASG;IACH,eAAe,CACb,KAAK,EAAE,gCAAgC,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kCAAkC,CAAC;CAGlD;AAED,MAAM,MAAM,uBAAuB,GAAG,MAAM,CAAC,gBAAgB,CAAC,CAAC;AAE/D,MAAM,WAAW,oBAAoB;IACnC,YAAY,EAAE,uBAAuB,CAAC;IAEtC,WAAW,EAAE,MAAM,CAAC;IAEpB,OAAO,EAAE,kBAAkB,CAAC;IAE5B,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAC;IAEX,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE5B,SAAS,EAAE,MAAM,CAAC;IAElB,WAAW,EAAE,MAAM,CAAC;IAEpB,OAAO,EAAE,uBAAuB,CAAC;IAEjC,MAAM,EAAE,iBAAiB,CAAC;IAE1B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,uBAAuB;IACtC,GAAG,CAAC,EAAE,OAAO,CAAC;IAEd,GAAG,CAAC,EAAE,OAAO,CAAC;IAEd,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,MAAM,iBAAiB,GAAG,QAAQ,GAAG,WAAW,GAAG,SAAS,CAAC;AAEnE,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,QAAQ,GAAG,UAAU,CAAC;AAE9D;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IAEX,MAAM,EAAE,MAAM,CAAC;IAEf,WAAW,EAAE,MAAM,CAAC;IAEpB,eAAe,EAAE,MAAM,CAAC;IAExB,gBAAgB,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAErC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,SAAS,GAAG,SAAS,GAAG,UAAU,GAAG,QAAQ,CAAC;AAEjF;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAC;IAEX,WAAW,EAAE,MAAM,CAAC;IAEpB,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,oBAAoB,CAAC;IAE3B;;OAEG;IACH,kBAAkB,CAAC,EAAE,6BAA6B,CAAC;IAEnD,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,WAAW,2BAA2B;IAC1C,WAAW,EAAE,gBAAgB,CAAC;CAC/B;AAED,MAAM,WAAW,yBAAyB;IACxC,WAAW,EAAE,gBAAgB,CAAC;CAC/B;AAED,MAAM,WAAW,2BAA2B;IAC1C,WAAW,EAAE,gBAAgB,CAAC;CAC/B;AAED,MAAM,WAAW,+BAA+B;IAC9C,KAAK,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;CAC3B;AAED,MAAM,WAAW,kCAAkC;IACjD,KAAK,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,qBAAsB,SAAQ,YAAY;IACzD;;OAEG;IACH,MAAM,CAAC,EAAE,iBAAiB,CAAC;CAC5B;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,eAAe,CAAC;CACxB;AAED,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,eAAe,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,gCAAgC,IAAI,gCAAgC,GAC1E,CAAC;CACH"}
|
|
@@ -60,6 +60,19 @@ export declare class PhoneNumbers extends APIResource {
|
|
|
60
60
|
* ```
|
|
61
61
|
*/
|
|
62
62
|
release(phoneNumberID: string, options?: RequestOptions): APIPromise<void>;
|
|
63
|
+
/**
|
|
64
|
+
* Get regulatory requirements for purchasing phone numbers in a specific country.
|
|
65
|
+
* Some countries require additional documentation (addresses, identity documents)
|
|
66
|
+
* before phone numbers can be activated.
|
|
67
|
+
*
|
|
68
|
+
* @example
|
|
69
|
+
* ```ts
|
|
70
|
+
* const response = await client.phoneNumbers.requirements({
|
|
71
|
+
* countryCode: 'xx',
|
|
72
|
+
* });
|
|
73
|
+
* ```
|
|
74
|
+
*/
|
|
75
|
+
requirements(query: PhoneNumberRequirementsParams, options?: RequestOptions): APIPromise<PhoneNumberRequirementsResponse>;
|
|
63
76
|
/**
|
|
64
77
|
* Search for available phone numbers to purchase by country and type.
|
|
65
78
|
*
|
|
@@ -138,6 +151,46 @@ export interface PhoneNumberPricing {
|
|
|
138
151
|
}
|
|
139
152
|
export type PhoneNumberStatus = 'active' | 'suspended' | 'pending';
|
|
140
153
|
export type PhoneNumberType = 'local' | 'mobile' | 'tollFree';
|
|
154
|
+
/**
|
|
155
|
+
* A group of requirements for a specific country/phone type combination.
|
|
156
|
+
*/
|
|
157
|
+
export interface Requirement {
|
|
158
|
+
id: string;
|
|
159
|
+
action: string;
|
|
160
|
+
countryCode: string;
|
|
161
|
+
phoneNumberType: string;
|
|
162
|
+
requirementTypes: Array<RequirementType>;
|
|
163
|
+
}
|
|
164
|
+
/**
|
|
165
|
+
* Acceptance criteria for a requirement.
|
|
166
|
+
*/
|
|
167
|
+
export interface RequirementAcceptanceCriteria {
|
|
168
|
+
allowedValues?: Array<string> | null;
|
|
169
|
+
maxLength?: number | null;
|
|
170
|
+
minLength?: number | null;
|
|
171
|
+
regexPattern?: string | null;
|
|
172
|
+
}
|
|
173
|
+
/**
|
|
174
|
+
* Type of requirement field.
|
|
175
|
+
*/
|
|
176
|
+
export type RequirementFieldType = 'textual' | 'address' | 'document' | 'action';
|
|
177
|
+
/**
|
|
178
|
+
* A specific requirement type within a requirement group.
|
|
179
|
+
*/
|
|
180
|
+
export interface RequirementType {
|
|
181
|
+
id: string;
|
|
182
|
+
description: string;
|
|
183
|
+
name: string;
|
|
184
|
+
/**
|
|
185
|
+
* Type of requirement field.
|
|
186
|
+
*/
|
|
187
|
+
type: RequirementFieldType;
|
|
188
|
+
/**
|
|
189
|
+
* Acceptance criteria for a requirement.
|
|
190
|
+
*/
|
|
191
|
+
acceptanceCriteria?: RequirementAcceptanceCriteria;
|
|
192
|
+
example?: string | null;
|
|
193
|
+
}
|
|
141
194
|
export interface PhoneNumberRetrieveResponse {
|
|
142
195
|
phoneNumber: OwnedPhoneNumber;
|
|
143
196
|
}
|
|
@@ -147,6 +200,9 @@ export interface PhoneNumberUpdateResponse {
|
|
|
147
200
|
export interface PhoneNumberPurchaseResponse {
|
|
148
201
|
phoneNumber: OwnedPhoneNumber;
|
|
149
202
|
}
|
|
203
|
+
export interface PhoneNumberRequirementsResponse {
|
|
204
|
+
items: Array<Requirement>;
|
|
205
|
+
}
|
|
150
206
|
export interface PhoneNumberSearchAvailableResponse {
|
|
151
207
|
items: Array<AvailablePhoneNumber>;
|
|
152
208
|
}
|
|
@@ -176,6 +232,16 @@ export interface PhoneNumberPurchaseParams {
|
|
|
176
232
|
*/
|
|
177
233
|
name?: string;
|
|
178
234
|
}
|
|
235
|
+
export interface PhoneNumberRequirementsParams {
|
|
236
|
+
/**
|
|
237
|
+
* Two-letter ISO country code.
|
|
238
|
+
*/
|
|
239
|
+
countryCode: string;
|
|
240
|
+
/**
|
|
241
|
+
* Type of phone number (local, mobile, tollFree).
|
|
242
|
+
*/
|
|
243
|
+
type?: PhoneNumberType;
|
|
244
|
+
}
|
|
179
245
|
export interface PhoneNumberSearchAvailableParams {
|
|
180
246
|
/**
|
|
181
247
|
* Two-letter ISO country code.
|
|
@@ -195,6 +261,6 @@ export interface PhoneNumberSearchAvailableParams {
|
|
|
195
261
|
type?: PhoneNumberType;
|
|
196
262
|
}
|
|
197
263
|
export declare namespace PhoneNumbers {
|
|
198
|
-
export { type AvailablePhoneNumber as AvailablePhoneNumber, type OwnedPhoneNumber as OwnedPhoneNumber, type OwnedPhoneNumberPricing as OwnedPhoneNumberPricing, type PhoneNumberCapabilities as PhoneNumberCapabilities, type PhoneNumberPricing as PhoneNumberPricing, type PhoneNumberStatus as PhoneNumberStatus, type PhoneNumberType as PhoneNumberType, type PhoneNumberRetrieveResponse as PhoneNumberRetrieveResponse, type PhoneNumberUpdateResponse as PhoneNumberUpdateResponse, type PhoneNumberPurchaseResponse as PhoneNumberPurchaseResponse, type PhoneNumberSearchAvailableResponse as PhoneNumberSearchAvailableResponse, type OwnedPhoneNumbersCursor as OwnedPhoneNumbersCursor, type PhoneNumberUpdateParams as PhoneNumberUpdateParams, type PhoneNumberListParams as PhoneNumberListParams, type PhoneNumberPurchaseParams as PhoneNumberPurchaseParams, type PhoneNumberSearchAvailableParams as PhoneNumberSearchAvailableParams, };
|
|
264
|
+
export { type AvailablePhoneNumber as AvailablePhoneNumber, type OwnedPhoneNumber as OwnedPhoneNumber, type OwnedPhoneNumberPricing as OwnedPhoneNumberPricing, type PhoneNumberCapabilities as PhoneNumberCapabilities, type PhoneNumberPricing as PhoneNumberPricing, type PhoneNumberStatus as PhoneNumberStatus, type PhoneNumberType as PhoneNumberType, type Requirement as Requirement, type RequirementAcceptanceCriteria as RequirementAcceptanceCriteria, type RequirementFieldType as RequirementFieldType, type RequirementType as RequirementType, type PhoneNumberRetrieveResponse as PhoneNumberRetrieveResponse, type PhoneNumberUpdateResponse as PhoneNumberUpdateResponse, type PhoneNumberPurchaseResponse as PhoneNumberPurchaseResponse, type PhoneNumberRequirementsResponse as PhoneNumberRequirementsResponse, type PhoneNumberSearchAvailableResponse as PhoneNumberSearchAvailableResponse, type OwnedPhoneNumbersCursor as OwnedPhoneNumbersCursor, type PhoneNumberUpdateParams as PhoneNumberUpdateParams, type PhoneNumberListParams as PhoneNumberListParams, type PhoneNumberPurchaseParams as PhoneNumberPurchaseParams, type PhoneNumberRequirementsParams as PhoneNumberRequirementsParams, type PhoneNumberSearchAvailableParams as PhoneNumberSearchAvailableParams, };
|
|
199
265
|
}
|
|
200
266
|
//# sourceMappingURL=phone-numbers.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"phone-numbers.d.ts","sourceRoot":"","sources":["../src/resources/phone-numbers.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,MAAM,EAAE,KAAK,YAAY,EAAE,WAAW,EAAE;OAE1C,EAAE,cAAc,EAAE;AAGzB,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;OASG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,2BAA2B,CAAC;IAIlG;;;;;;;;;;OAUG;IACH,MAAM,CACJ,aAAa,EAAE,MAAM,EACrB,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAIxC;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,uBAAuB,EAAE,gBAAgB,CAAC;IAIzD;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;IAI1C;;;;;;;OAOG;IACH,OAAO,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO1E;;;;;;;;;OASG;IACH,eAAe,CACb,KAAK,EAAE,gCAAgC,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kCAAkC,CAAC;CAGlD;AAED,MAAM,MAAM,uBAAuB,GAAG,MAAM,CAAC,gBAAgB,CAAC,CAAC;AAE/D,MAAM,WAAW,oBAAoB;IACnC,YAAY,EAAE,uBAAuB,CAAC;IAEtC,WAAW,EAAE,MAAM,CAAC;IAEpB,OAAO,EAAE,kBAAkB,CAAC;IAE5B,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAC;IAEX,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE5B,SAAS,EAAE,MAAM,CAAC;IAElB,WAAW,EAAE,MAAM,CAAC;IAEpB,OAAO,EAAE,uBAAuB,CAAC;IAEjC,MAAM,EAAE,iBAAiB,CAAC;IAE1B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,uBAAuB;IACtC,GAAG,CAAC,EAAE,OAAO,CAAC;IAEd,GAAG,CAAC,EAAE,OAAO,CAAC;IAEd,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,MAAM,iBAAiB,GAAG,QAAQ,GAAG,WAAW,GAAG,SAAS,CAAC;AAEnE,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,QAAQ,GAAG,UAAU,CAAC;AAE9D,MAAM,WAAW,2BAA2B;IAC1C,WAAW,EAAE,gBAAgB,CAAC;CAC/B;AAED,MAAM,WAAW,yBAAyB;IACxC,WAAW,EAAE,gBAAgB,CAAC;CAC/B;AAED,MAAM,WAAW,2BAA2B;IAC1C,WAAW,EAAE,gBAAgB,CAAC;CAC/B;AAED,MAAM,WAAW,kCAAkC;IACjD,KAAK,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,qBAAsB,SAAQ,YAAY;IACzD;;OAEG;IACH,MAAM,CAAC,EAAE,iBAAiB,CAAC;CAC5B;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,eAAe,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,gCAAgC,IAAI,gCAAgC,GAC1E,CAAC;CACH"}
|
|
1
|
+
{"version":3,"file":"phone-numbers.d.ts","sourceRoot":"","sources":["../src/resources/phone-numbers.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,MAAM,EAAE,KAAK,YAAY,EAAE,WAAW,EAAE;OAE1C,EAAE,cAAc,EAAE;AAGzB,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;OASG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,2BAA2B,CAAC;IAIlG;;;;;;;;;;OAUG;IACH,MAAM,CACJ,aAAa,EAAE,MAAM,EACrB,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAIxC;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,uBAAuB,EAAE,gBAAgB,CAAC;IAIzD;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;IAI1C;;;;;;;OAOG;IACH,OAAO,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO1E;;;;;;;;;;;OAWG;IACH,YAAY,CACV,KAAK,EAAE,6BAA6B,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+BAA+B,CAAC;IAI9C;;;;;;;;;OASG;IACH,eAAe,CACb,KAAK,EAAE,gCAAgC,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kCAAkC,CAAC;CAGlD;AAED,MAAM,MAAM,uBAAuB,GAAG,MAAM,CAAC,gBAAgB,CAAC,CAAC;AAE/D,MAAM,WAAW,oBAAoB;IACnC,YAAY,EAAE,uBAAuB,CAAC;IAEtC,WAAW,EAAE,MAAM,CAAC;IAEpB,OAAO,EAAE,kBAAkB,CAAC;IAE5B,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAC;IAEX,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE5B,SAAS,EAAE,MAAM,CAAC;IAElB,WAAW,EAAE,MAAM,CAAC;IAEpB,OAAO,EAAE,uBAAuB,CAAC;IAEjC,MAAM,EAAE,iBAAiB,CAAC;IAE1B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,uBAAuB;IACtC,GAAG,CAAC,EAAE,OAAO,CAAC;IAEd,GAAG,CAAC,EAAE,OAAO,CAAC;IAEd,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,MAAM,iBAAiB,GAAG,QAAQ,GAAG,WAAW,GAAG,SAAS,CAAC;AAEnE,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,QAAQ,GAAG,UAAU,CAAC;AAE9D;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IAEX,MAAM,EAAE,MAAM,CAAC;IAEf,WAAW,EAAE,MAAM,CAAC;IAEpB,eAAe,EAAE,MAAM,CAAC;IAExB,gBAAgB,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAErC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,SAAS,GAAG,SAAS,GAAG,UAAU,GAAG,QAAQ,CAAC;AAEjF;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAC;IAEX,WAAW,EAAE,MAAM,CAAC;IAEpB,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,oBAAoB,CAAC;IAE3B;;OAEG;IACH,kBAAkB,CAAC,EAAE,6BAA6B,CAAC;IAEnD,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,WAAW,2BAA2B;IAC1C,WAAW,EAAE,gBAAgB,CAAC;CAC/B;AAED,MAAM,WAAW,yBAAyB;IACxC,WAAW,EAAE,gBAAgB,CAAC;CAC/B;AAED,MAAM,WAAW,2BAA2B;IAC1C,WAAW,EAAE,gBAAgB,CAAC;CAC/B;AAED,MAAM,WAAW,+BAA+B;IAC9C,KAAK,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;CAC3B;AAED,MAAM,WAAW,kCAAkC;IACjD,KAAK,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,qBAAsB,SAAQ,YAAY;IACzD;;OAEG;IACH,MAAM,CAAC,EAAE,iBAAiB,CAAC;CAC5B;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,eAAe,CAAC;CACxB;AAED,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,eAAe,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,gCAAgC,IAAI,gCAAgC,GAC1E,CAAC;CACH"}
|
|
@@ -77,6 +77,21 @@ class PhoneNumbers extends resource_1.APIResource {
|
|
|
77
77
|
headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
|
|
78
78
|
});
|
|
79
79
|
}
|
|
80
|
+
/**
|
|
81
|
+
* Get regulatory requirements for purchasing phone numbers in a specific country.
|
|
82
|
+
* Some countries require additional documentation (addresses, identity documents)
|
|
83
|
+
* before phone numbers can be activated.
|
|
84
|
+
*
|
|
85
|
+
* @example
|
|
86
|
+
* ```ts
|
|
87
|
+
* const response = await client.phoneNumbers.requirements({
|
|
88
|
+
* countryCode: 'xx',
|
|
89
|
+
* });
|
|
90
|
+
* ```
|
|
91
|
+
*/
|
|
92
|
+
requirements(query, options) {
|
|
93
|
+
return this._client.get('/v1/phone-numbers/requirements', { query, ...options });
|
|
94
|
+
}
|
|
80
95
|
/**
|
|
81
96
|
* Search for available phone numbers to purchase by country and type.
|
|
82
97
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"phone-numbers.js","sourceRoot":"","sources":["../src/resources/phone-numbers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAA4E;AAC5E,oDAAmD;AAEnD,oDAA8C;AAE9C,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;;;;;;OASG;IACH,QAAQ,CAAC,aAAqB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,qBAAqB,aAAa,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CACJ,aAAqB,EACrB,IAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,qBAAqB,aAAa,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mBAAmB,EAAE,CAAA,mBAAwB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,IAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CAAC,aAAqB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,qBAAqB,aAAa,EAAE,EAAE;YACnE,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,eAAe,CACb,KAAuC,EACvC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,6BAA6B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;CACF;
|
|
1
|
+
{"version":3,"file":"phone-numbers.js","sourceRoot":"","sources":["../src/resources/phone-numbers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAA4E;AAC5E,oDAAmD;AAEnD,oDAA8C;AAE9C,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;;;;;;OASG;IACH,QAAQ,CAAC,aAAqB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,qBAAqB,aAAa,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CACJ,aAAqB,EACrB,IAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,qBAAqB,aAAa,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mBAAmB,EAAE,CAAA,mBAAwB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,IAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CAAC,aAAqB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,qBAAqB,aAAa,EAAE,EAAE;YACnE,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,YAAY,CACV,KAAoC,EACpC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gCAAgC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;;OASG;IACH,eAAe,CACb,KAAuC,EACvC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,6BAA6B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;CACF;AAzHD,oCAyHC"}
|
|
@@ -74,6 +74,21 @@ export class PhoneNumbers extends APIResource {
|
|
|
74
74
|
headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
|
|
75
75
|
});
|
|
76
76
|
}
|
|
77
|
+
/**
|
|
78
|
+
* Get regulatory requirements for purchasing phone numbers in a specific country.
|
|
79
|
+
* Some countries require additional documentation (addresses, identity documents)
|
|
80
|
+
* before phone numbers can be activated.
|
|
81
|
+
*
|
|
82
|
+
* @example
|
|
83
|
+
* ```ts
|
|
84
|
+
* const response = await client.phoneNumbers.requirements({
|
|
85
|
+
* countryCode: 'xx',
|
|
86
|
+
* });
|
|
87
|
+
* ```
|
|
88
|
+
*/
|
|
89
|
+
requirements(query, options) {
|
|
90
|
+
return this._client.get('/v1/phone-numbers/requirements', { query, ...options });
|
|
91
|
+
}
|
|
77
92
|
/**
|
|
78
93
|
* Search for available phone numbers to purchase by country and type.
|
|
79
94
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"phone-numbers.mjs","sourceRoot":"","sources":["../src/resources/phone-numbers.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,MAAM,EAAkC;OAC1C,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;OASG;IACH,QAAQ,CAAC,aAAqB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,qBAAqB,aAAa,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CACJ,aAAqB,EACrB,IAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,qBAAqB,aAAa,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mBAAmB,EAAE,CAAA,MAAwB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,IAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CAAC,aAAqB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,qBAAqB,aAAa,EAAE,EAAE;YACnE,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,eAAe,CACb,KAAuC,EACvC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,6BAA6B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;CACF"}
|
|
1
|
+
{"version":3,"file":"phone-numbers.mjs","sourceRoot":"","sources":["../src/resources/phone-numbers.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,MAAM,EAAkC;OAC1C,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;OASG;IACH,QAAQ,CAAC,aAAqB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,qBAAqB,aAAa,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CACJ,aAAqB,EACrB,IAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,qBAAqB,aAAa,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mBAAmB,EAAE,CAAA,MAAwB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,IAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CAAC,aAAqB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,qBAAqB,aAAa,EAAE,EAAE;YACnE,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,YAAY,CACV,KAAoC,EACpC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gCAAgC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;;OASG;IACH,eAAe,CACb,KAAuC,EACvC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,6BAA6B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;CACF"}
|
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.mjs";
|
|
2
|
+
import { APIPromise } from "../core/api-promise.mjs";
|
|
3
|
+
import { Cursor, type CursorParams, PagePromise } from "../core/pagination.mjs";
|
|
4
|
+
import { RequestOptions } from "../internal/request-options.mjs";
|
|
5
|
+
export declare class RegulatoryDocuments extends APIResource {
|
|
6
|
+
/**
|
|
7
|
+
* Create a regulatory document record after uploading the file. Use the upload-url
|
|
8
|
+
* endpoint first to get an upload URL.
|
|
9
|
+
*
|
|
10
|
+
* @example
|
|
11
|
+
* ```ts
|
|
12
|
+
* const regulatoryDocument =
|
|
13
|
+
* await client.regulatoryDocuments.create({
|
|
14
|
+
* documentType: 'passport',
|
|
15
|
+
* fileSize: 102400,
|
|
16
|
+
* mimeType: 'image/jpeg',
|
|
17
|
+
* name: 'Passport Scan',
|
|
18
|
+
* storageId: 'kg2abc123...',
|
|
19
|
+
* });
|
|
20
|
+
* ```
|
|
21
|
+
*/
|
|
22
|
+
create(body: RegulatoryDocumentCreateParams, options?: RequestOptions): APIPromise<RegulatoryDocumentCreateResponse>;
|
|
23
|
+
/**
|
|
24
|
+
* Get a specific regulatory document.
|
|
25
|
+
*
|
|
26
|
+
* @example
|
|
27
|
+
* ```ts
|
|
28
|
+
* const regulatoryDocument =
|
|
29
|
+
* await client.regulatoryDocuments.retrieve('documentId');
|
|
30
|
+
* ```
|
|
31
|
+
*/
|
|
32
|
+
retrieve(documentID: string, options?: RequestOptions): APIPromise<RegulatoryDocumentRetrieveResponse>;
|
|
33
|
+
/**
|
|
34
|
+
* List regulatory documents for this project.
|
|
35
|
+
*
|
|
36
|
+
* @example
|
|
37
|
+
* ```ts
|
|
38
|
+
* // Automatically fetches more pages as needed.
|
|
39
|
+
* for await (const regulatoryDocument of client.regulatoryDocuments.list()) {
|
|
40
|
+
* // ...
|
|
41
|
+
* }
|
|
42
|
+
* ```
|
|
43
|
+
*/
|
|
44
|
+
list(query?: RegulatoryDocumentListParams | null | undefined, options?: RequestOptions): PagePromise<RegulatoryDocumentsCursor, RegulatoryDocument>;
|
|
45
|
+
/**
|
|
46
|
+
* Delete a regulatory document. Cannot delete verified documents.
|
|
47
|
+
*
|
|
48
|
+
* @example
|
|
49
|
+
* ```ts
|
|
50
|
+
* await client.regulatoryDocuments.delete('documentId');
|
|
51
|
+
* ```
|
|
52
|
+
*/
|
|
53
|
+
delete(documentID: string, options?: RequestOptions): APIPromise<void>;
|
|
54
|
+
/**
|
|
55
|
+
* Get a presigned URL to upload a document file. After uploading, use the
|
|
56
|
+
* storageId to create the document record.
|
|
57
|
+
*
|
|
58
|
+
* @example
|
|
59
|
+
* ```ts
|
|
60
|
+
* const response =
|
|
61
|
+
* await client.regulatoryDocuments.uploadURL();
|
|
62
|
+
* ```
|
|
63
|
+
*/
|
|
64
|
+
uploadURL(options?: RequestOptions): APIPromise<RegulatoryDocumentUploadURLResponse>;
|
|
65
|
+
}
|
|
66
|
+
export type RegulatoryDocumentsCursor = Cursor<RegulatoryDocument>;
|
|
67
|
+
/**
|
|
68
|
+
* A regulatory document for phone number requirements.
|
|
69
|
+
*/
|
|
70
|
+
export interface RegulatoryDocument {
|
|
71
|
+
id: string;
|
|
72
|
+
createdAt: string;
|
|
73
|
+
documentType: 'passport' | 'national_id' | 'drivers_license' | 'utility_bill' | 'tax_id' | 'business_registration' | 'proof_of_address' | 'other';
|
|
74
|
+
name: string;
|
|
75
|
+
status: 'pending' | 'uploaded' | 'verified' | 'rejected';
|
|
76
|
+
fileSize?: number;
|
|
77
|
+
mimeType?: string;
|
|
78
|
+
rejectionReason?: string | null;
|
|
79
|
+
updatedAt?: string;
|
|
80
|
+
}
|
|
81
|
+
export interface RegulatoryDocumentCreateResponse {
|
|
82
|
+
/**
|
|
83
|
+
* A regulatory document for phone number requirements.
|
|
84
|
+
*/
|
|
85
|
+
document: RegulatoryDocument;
|
|
86
|
+
}
|
|
87
|
+
export interface RegulatoryDocumentRetrieveResponse {
|
|
88
|
+
/**
|
|
89
|
+
* A regulatory document for phone number requirements.
|
|
90
|
+
*/
|
|
91
|
+
document: RegulatoryDocument;
|
|
92
|
+
}
|
|
93
|
+
export interface RegulatoryDocumentUploadURLResponse {
|
|
94
|
+
/**
|
|
95
|
+
* Pre-signed URL for uploading the file.
|
|
96
|
+
*/
|
|
97
|
+
uploadUrl: string;
|
|
98
|
+
}
|
|
99
|
+
export interface RegulatoryDocumentCreateParams {
|
|
100
|
+
documentType: 'passport' | 'national_id' | 'drivers_license' | 'utility_bill' | 'tax_id' | 'business_registration' | 'proof_of_address' | 'other';
|
|
101
|
+
fileSize: number;
|
|
102
|
+
mimeType: string;
|
|
103
|
+
name: string;
|
|
104
|
+
/**
|
|
105
|
+
* Storage ID from the upload-url endpoint.
|
|
106
|
+
*/
|
|
107
|
+
storageId: string;
|
|
108
|
+
}
|
|
109
|
+
export interface RegulatoryDocumentListParams extends CursorParams {
|
|
110
|
+
}
|
|
111
|
+
export declare namespace RegulatoryDocuments {
|
|
112
|
+
export { type RegulatoryDocument as RegulatoryDocument, type RegulatoryDocumentCreateResponse as RegulatoryDocumentCreateResponse, type RegulatoryDocumentRetrieveResponse as RegulatoryDocumentRetrieveResponse, type RegulatoryDocumentUploadURLResponse as RegulatoryDocumentUploadURLResponse, type RegulatoryDocumentsCursor as RegulatoryDocumentsCursor, type RegulatoryDocumentCreateParams as RegulatoryDocumentCreateParams, type RegulatoryDocumentListParams as RegulatoryDocumentListParams, };
|
|
113
|
+
}
|
|
114
|
+
//# sourceMappingURL=regulatory-documents.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"regulatory-documents.d.mts","sourceRoot":"","sources":["../src/resources/regulatory-documents.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,MAAM,EAAE,KAAK,YAAY,EAAE,WAAW,EAAE;OAE1C,EAAE,cAAc,EAAE;AAGzB,qBAAa,mBAAoB,SAAQ,WAAW;IAClD;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CACJ,IAAI,EAAE,8BAA8B,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gCAAgC,CAAC;IAI/C;;;;;;;;OAQG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kCAAkC,CAAC;IAItG;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,4BAA4B,GAAG,IAAI,GAAG,SAAc,EAC3D,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,yBAAyB,EAAE,kBAAkB,CAAC;IAI7D;;;;;;;OAOG;IACH,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOtE;;;;;;;;;OASG;IACH,SAAS,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mCAAmC,CAAC;CAGrF;AAED,MAAM,MAAM,yBAAyB,GAAG,MAAM,CAAC,kBAAkB,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAC;IAEX,SAAS,EAAE,MAAM,CAAC;IAElB,YAAY,EACR,UAAU,GACV,aAAa,GACb,iBAAiB,GACjB,cAAc,GACd,QAAQ,GACR,uBAAuB,GACvB,kBAAkB,GAClB,OAAO,CAAC;IAEZ,IAAI,EAAE,MAAM,CAAC;IAEb,MAAM,EAAE,SAAS,GAAG,UAAU,GAAG,UAAU,GAAG,UAAU,CAAC;IAEzD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,QAAQ,EAAE,kBAAkB,CAAC;CAC9B;AAED,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,QAAQ,EAAE,kBAAkB,CAAC;CAC9B;AAED,MAAM,WAAW,mCAAmC;IAClD;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,8BAA8B;IAC7C,YAAY,EACR,UAAU,GACV,aAAa,GACb,iBAAiB,GACjB,cAAc,GACd,QAAQ,GACR,uBAAuB,GACvB,kBAAkB,GAClB,OAAO,CAAC;IAEZ,QAAQ,EAAE,MAAM,CAAC;IAEjB,QAAQ,EAAE,MAAM,CAAC;IAEjB,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,4BAA6B,SAAQ,YAAY;CAAG;AAErE,MAAM,CAAC,OAAO,WAAW,mBAAmB,CAAC;IAC3C,OAAO,EACL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
|
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.js";
|
|
2
|
+
import { APIPromise } from "../core/api-promise.js";
|
|
3
|
+
import { Cursor, type CursorParams, PagePromise } from "../core/pagination.js";
|
|
4
|
+
import { RequestOptions } from "../internal/request-options.js";
|
|
5
|
+
export declare class RegulatoryDocuments extends APIResource {
|
|
6
|
+
/**
|
|
7
|
+
* Create a regulatory document record after uploading the file. Use the upload-url
|
|
8
|
+
* endpoint first to get an upload URL.
|
|
9
|
+
*
|
|
10
|
+
* @example
|
|
11
|
+
* ```ts
|
|
12
|
+
* const regulatoryDocument =
|
|
13
|
+
* await client.regulatoryDocuments.create({
|
|
14
|
+
* documentType: 'passport',
|
|
15
|
+
* fileSize: 102400,
|
|
16
|
+
* mimeType: 'image/jpeg',
|
|
17
|
+
* name: 'Passport Scan',
|
|
18
|
+
* storageId: 'kg2abc123...',
|
|
19
|
+
* });
|
|
20
|
+
* ```
|
|
21
|
+
*/
|
|
22
|
+
create(body: RegulatoryDocumentCreateParams, options?: RequestOptions): APIPromise<RegulatoryDocumentCreateResponse>;
|
|
23
|
+
/**
|
|
24
|
+
* Get a specific regulatory document.
|
|
25
|
+
*
|
|
26
|
+
* @example
|
|
27
|
+
* ```ts
|
|
28
|
+
* const regulatoryDocument =
|
|
29
|
+
* await client.regulatoryDocuments.retrieve('documentId');
|
|
30
|
+
* ```
|
|
31
|
+
*/
|
|
32
|
+
retrieve(documentID: string, options?: RequestOptions): APIPromise<RegulatoryDocumentRetrieveResponse>;
|
|
33
|
+
/**
|
|
34
|
+
* List regulatory documents for this project.
|
|
35
|
+
*
|
|
36
|
+
* @example
|
|
37
|
+
* ```ts
|
|
38
|
+
* // Automatically fetches more pages as needed.
|
|
39
|
+
* for await (const regulatoryDocument of client.regulatoryDocuments.list()) {
|
|
40
|
+
* // ...
|
|
41
|
+
* }
|
|
42
|
+
* ```
|
|
43
|
+
*/
|
|
44
|
+
list(query?: RegulatoryDocumentListParams | null | undefined, options?: RequestOptions): PagePromise<RegulatoryDocumentsCursor, RegulatoryDocument>;
|
|
45
|
+
/**
|
|
46
|
+
* Delete a regulatory document. Cannot delete verified documents.
|
|
47
|
+
*
|
|
48
|
+
* @example
|
|
49
|
+
* ```ts
|
|
50
|
+
* await client.regulatoryDocuments.delete('documentId');
|
|
51
|
+
* ```
|
|
52
|
+
*/
|
|
53
|
+
delete(documentID: string, options?: RequestOptions): APIPromise<void>;
|
|
54
|
+
/**
|
|
55
|
+
* Get a presigned URL to upload a document file. After uploading, use the
|
|
56
|
+
* storageId to create the document record.
|
|
57
|
+
*
|
|
58
|
+
* @example
|
|
59
|
+
* ```ts
|
|
60
|
+
* const response =
|
|
61
|
+
* await client.regulatoryDocuments.uploadURL();
|
|
62
|
+
* ```
|
|
63
|
+
*/
|
|
64
|
+
uploadURL(options?: RequestOptions): APIPromise<RegulatoryDocumentUploadURLResponse>;
|
|
65
|
+
}
|
|
66
|
+
export type RegulatoryDocumentsCursor = Cursor<RegulatoryDocument>;
|
|
67
|
+
/**
|
|
68
|
+
* A regulatory document for phone number requirements.
|
|
69
|
+
*/
|
|
70
|
+
export interface RegulatoryDocument {
|
|
71
|
+
id: string;
|
|
72
|
+
createdAt: string;
|
|
73
|
+
documentType: 'passport' | 'national_id' | 'drivers_license' | 'utility_bill' | 'tax_id' | 'business_registration' | 'proof_of_address' | 'other';
|
|
74
|
+
name: string;
|
|
75
|
+
status: 'pending' | 'uploaded' | 'verified' | 'rejected';
|
|
76
|
+
fileSize?: number;
|
|
77
|
+
mimeType?: string;
|
|
78
|
+
rejectionReason?: string | null;
|
|
79
|
+
updatedAt?: string;
|
|
80
|
+
}
|
|
81
|
+
export interface RegulatoryDocumentCreateResponse {
|
|
82
|
+
/**
|
|
83
|
+
* A regulatory document for phone number requirements.
|
|
84
|
+
*/
|
|
85
|
+
document: RegulatoryDocument;
|
|
86
|
+
}
|
|
87
|
+
export interface RegulatoryDocumentRetrieveResponse {
|
|
88
|
+
/**
|
|
89
|
+
* A regulatory document for phone number requirements.
|
|
90
|
+
*/
|
|
91
|
+
document: RegulatoryDocument;
|
|
92
|
+
}
|
|
93
|
+
export interface RegulatoryDocumentUploadURLResponse {
|
|
94
|
+
/**
|
|
95
|
+
* Pre-signed URL for uploading the file.
|
|
96
|
+
*/
|
|
97
|
+
uploadUrl: string;
|
|
98
|
+
}
|
|
99
|
+
export interface RegulatoryDocumentCreateParams {
|
|
100
|
+
documentType: 'passport' | 'national_id' | 'drivers_license' | 'utility_bill' | 'tax_id' | 'business_registration' | 'proof_of_address' | 'other';
|
|
101
|
+
fileSize: number;
|
|
102
|
+
mimeType: string;
|
|
103
|
+
name: string;
|
|
104
|
+
/**
|
|
105
|
+
* Storage ID from the upload-url endpoint.
|
|
106
|
+
*/
|
|
107
|
+
storageId: string;
|
|
108
|
+
}
|
|
109
|
+
export interface RegulatoryDocumentListParams extends CursorParams {
|
|
110
|
+
}
|
|
111
|
+
export declare namespace RegulatoryDocuments {
|
|
112
|
+
export { type RegulatoryDocument as RegulatoryDocument, type RegulatoryDocumentCreateResponse as RegulatoryDocumentCreateResponse, type RegulatoryDocumentRetrieveResponse as RegulatoryDocumentRetrieveResponse, type RegulatoryDocumentUploadURLResponse as RegulatoryDocumentUploadURLResponse, type RegulatoryDocumentsCursor as RegulatoryDocumentsCursor, type RegulatoryDocumentCreateParams as RegulatoryDocumentCreateParams, type RegulatoryDocumentListParams as RegulatoryDocumentListParams, };
|
|
113
|
+
}
|
|
114
|
+
//# sourceMappingURL=regulatory-documents.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"regulatory-documents.d.ts","sourceRoot":"","sources":["../src/resources/regulatory-documents.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,MAAM,EAAE,KAAK,YAAY,EAAE,WAAW,EAAE;OAE1C,EAAE,cAAc,EAAE;AAGzB,qBAAa,mBAAoB,SAAQ,WAAW;IAClD;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CACJ,IAAI,EAAE,8BAA8B,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gCAAgC,CAAC;IAI/C;;;;;;;;OAQG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kCAAkC,CAAC;IAItG;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,4BAA4B,GAAG,IAAI,GAAG,SAAc,EAC3D,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,yBAAyB,EAAE,kBAAkB,CAAC;IAI7D;;;;;;;OAOG;IACH,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOtE;;;;;;;;;OASG;IACH,SAAS,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mCAAmC,CAAC;CAGrF;AAED,MAAM,MAAM,yBAAyB,GAAG,MAAM,CAAC,kBAAkB,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAC;IAEX,SAAS,EAAE,MAAM,CAAC;IAElB,YAAY,EACR,UAAU,GACV,aAAa,GACb,iBAAiB,GACjB,cAAc,GACd,QAAQ,GACR,uBAAuB,GACvB,kBAAkB,GAClB,OAAO,CAAC;IAEZ,IAAI,EAAE,MAAM,CAAC;IAEb,MAAM,EAAE,SAAS,GAAG,UAAU,GAAG,UAAU,GAAG,UAAU,CAAC;IAEzD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,QAAQ,EAAE,kBAAkB,CAAC;CAC9B;AAED,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,QAAQ,EAAE,kBAAkB,CAAC;CAC9B;AAED,MAAM,WAAW,mCAAmC;IAClD;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,8BAA8B;IAC7C,YAAY,EACR,UAAU,GACV,aAAa,GACb,iBAAiB,GACjB,cAAc,GACd,QAAQ,GACR,uBAAuB,GACvB,kBAAkB,GAClB,OAAO,CAAC;IAEZ,QAAQ,EAAE,MAAM,CAAC;IAEjB,QAAQ,EAAE,MAAM,CAAC;IAEjB,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,4BAA6B,SAAQ,YAAY;CAAG;AAErE,MAAM,CAAC,OAAO,WAAW,mBAAmB,CAAC;IAC3C,OAAO,EACL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
|