Telnyx Numbers Compliance - JavaScript

<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. -->

Telnyx Numbers Compliance - JavaScript

Installation

npm install telnyx

Setup

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

All examples below assume client is already initialized as shown above.

Retrieve Bundles

Get all allowed bundles.

GET /​bundle_pricing/​billing_bundles

// Automatically fetches more pages as needed.
for await (const billingBundleSummary of client.bundlePricing.billingBundles.list()) {
  console.log(billingBundleSummary.id);
}

Get Bundle By Id

Get a single bundle by ID.

GET /​bundle_pricing/​billing_bundles/​{bundle_id}

const billingBundle = await client.bundlePricing.billingBundles.retrieve(
  '8661948c-a386-4385-837f-af00f40f111a',
);

console.log(billingBundle.data);

Get User Bundles

Get a paginated list of user bundles.

GET /​bundle_pricing/​user_bundles

// Automatically fetches more pages as needed.
for await (const userBundle of client.bundlePricing.userBundles.list()) {
  console.log(userBundle.id);
}

Create User Bundles

Creates multiple user bundles for the user.

POST /​bundle_pricing/​user_bundles/​bulk

const userBundle = await client.bundlePricing.userBundles.create();

console.log(userBundle.data);

Get Unused User Bundles

Returns all user bundles that aren't in use.

GET /​bundle_pricing/​user_bundles/​unused

const response = await client.bundlePricing.userBundles.listUnused();

console.log(response.data);

Get User Bundle by Id

Retrieves a user bundle by its ID.

GET /​bundle_pricing/​user_bundles/​{user_bundle_id}

const userBundle = await client.bundlePricing.userBundles.retrieve(
  'ca1d2263-d1f1-43ac-ba53-248e7a4bb26a',
);

console.log(userBundle.data);

Deactivate User Bundle

Deactivates a user bundle by its ID.

DELETE /​bundle_pricing/​user_bundles/​{user_bundle_id}

const response = await client.bundlePricing.userBundles.deactivate(
  'ca1d2263-d1f1-43ac-ba53-248e7a4bb26a',
);

console.log(response.data);

Get User Bundle Resources

Retrieves the resources of a user bundle by its ID.

GET /​bundle_pricing/​user_bundles/​{user_bundle_id}/​resources

const response = await client.bundlePricing.userBundles.listResources(
  'ca1d2263-d1f1-43ac-ba53-248e7a4bb26a',
);

console.log(response.data);

List all document links

List all documents links ordered by created_at descending.

GET /​document_links

// Automatically fetches more pages as needed.
for await (const documentLinkListResponse of client.documentLinks.list()) {
  console.log(documentLinkListResponse.id);
}

List all documents

List all documents ordered by created_at descending.

GET /​documents

// Automatically fetches more pages as needed.
for await (const docServiceDocument of client.documents.list()) {
  console.log(docServiceDocument.id);
}

Upload a document

Upload a document.<br /><br />Uploaded files must be linked to a service within 30 minutes or they will be automatically deleted.

POST /​documents

const response = await client.documents.uploadJson({ document: {} });

console.log(response.data);

Retrieve a document

Retrieve a document.

GET /​documents/​{id}

const document = await client.documents.retrieve('6a09cdc3-8948-47f0-aa62-74ac943d6c58');

console.log(document.data);

Update a document

Update a document.

PATCH /​documents/​{id}

const document = await client.documents.update('6a09cdc3-8948-47f0-aa62-74ac943d6c58');

console.log(document.data);

Delete a document

Delete a document.<br /><br />A document can only be deleted if it's not linked to a service.

DELETE /​documents/​{id}

const document = await client.documents.delete('6a09cdc3-8948-47f0-aa62-74ac943d6c58');

console.log(document.data);

Download a document

Download a document.

GET /​documents/​{id}/​download

const response = await client.documents.download('6a09cdc3-8948-47f0-aa62-74ac943d6c58');

console.log(response);

const content = await response.blob();
console.log(content);

Generate a temporary download link for a document

Generates a temporary pre-signed URL that can be used to download the document directly from the storage backend without authentication.

GET /​documents/​{id}/​download_link

const response = await client.documents.generateDownloadLink(
  '550e8400-e29b-41d4-a716-446655440000',
);

console.log(response.data);

List all requirements

List all requirements with filtering, sorting, and pagination

GET /​requirements

// Automatically fetches more pages as needed.
for await (const requirementListResponse of client.requirements.list()) {
  console.log(requirementListResponse.id);
}

Retrieve a document requirement

Retrieve a document requirement record

GET /​requirements/​{id}

const requirement = await client.requirements.retrieve('a9dad8d5-fdbd-49d7-aa23-39bb08a5ebaa');

console.log(requirement.data);

List all requirement types

List all requirement types ordered by created_at descending

GET /​requirement_types

const requirementTypes = await client.requirementTypes.list();

console.log(requirementTypes.data);

Retrieve a requirement types

Retrieve a requirement type by id

GET /​requirement_types/​{id}

const requirementType = await client.requirementTypes.retrieve(
  'a38c217a-8019-48f8-bff6-0fdd9939075b',
);

console.log(requirementType.data);

Retrieve regulatory requirements

GET /​regulatory_requirements

const regulatoryRequirement = await client.regulatoryRequirements.retrieve();

console.log(regulatoryRequirement.data);

List requirement groups

GET /​requirement_groups

const requirementGroups = await client.requirementGroups.list();

console.log(requirementGroups);

Create a new requirement group

POST /​requirement_groups — Required: country_code, phone_number_type, action

const requirementGroup = await client.requirementGroups.create({
  action: 'ordering',
  country_code: 'US',
  phone_number_type: 'local',
});

console.log(requirementGroup.id);

Get a single requirement group by ID

GET /​requirement_groups/​{id}

const requirementGroup = await client.requirementGroups.retrieve('id');

console.log(requirementGroup.id);

Update requirement values in requirement group

PATCH /​requirement_groups/​{id}

const requirementGroup = await client.requirementGroups.update('id');

console.log(requirementGroup.id);

Delete a requirement group by ID

DELETE /​requirement_groups/​{id}

const requirementGroup = await client.requirementGroups.delete('id');

console.log(requirementGroup.id);

Submit a Requirement Group for Approval

POST /​requirement_groups/​{id}/​submit_for_approval

const requirementGroup = await client.requirementGroups.submitForApproval('id');

console.log(requirementGroup.id);

List all Verified Numbers

Gets a paginated list of Verified Numbers.

GET /​verified_numbers

// Automatically fetches more pages as needed.
for await (const verifiedNumber of client.verifiedNumbers.list()) {
  console.log(verifiedNumber.phone_number);
}

Request phone number verification

Initiates phone number verification procedure.

POST /​verified_numbers — Required: phone_number, verification_method

const verifiedNumber = await client.verifiedNumbers.create({
  phone_number: '+15551234567',
  verification_method: 'sms',
});

console.log(verifiedNumber.phone_number);

Retrieve a verified number

GET /​verified_numbers/​{phone_number}

const verifiedNumberDataWrapper = await client.verifiedNumbers.retrieve('+15551234567');

console.log(verifiedNumberDataWrapper.data);

Delete a verified number

DELETE /​verified_numbers/​{phone_number}

const verifiedNumberDataWrapper = await client.verifiedNumbers.delete('+15551234567');

console.log(verifiedNumberDataWrapper.data);

Submit verification code

POST /​verified_numbers/​{phone_number}/​actions/​verify — Required: verification_code

const verifiedNumberDataWrapper = await client.verifiedNumbers.actions.submitVerificationCode(
  '+15551234567',
  { verification_code: '123456' },
);

console.log(verifiedNumberDataWrapper.data);