@mailodds/[email protected]

A TypeScript SDK client for the api.mailodds.com API.

Usage

First, install the SDK from npm.

npm install @mailodds/sdk --save

Next, try it out.

import {
  Configuration,
  BulkValidationApi,
} from '@mailodds/sdk';
import type { CancelJobRequest } from '@mailodds/sdk';

async function example() {
  console.log("🚀 Testing @mailodds/sdk SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: BearerAuth
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new BulkValidationApi(config);

  const body = {
    // string
    jobId: jobId_example,
  } satisfies CancelJobRequest;

  try {
    const data = await api.cancelJob(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Documentation

API Endpoints

All URIs are relative to https://api.mailodds.com/v1

| Class | Method | HTTP request | Description | ----- | ------ | ------------ | ------------- BulkValidationApi | cancelJob | POST /v1/jobs/{job_id}/cancel | Cancel a job BulkValidationApi | createJob | POST /v1/jobs | Create bulk validation job (JSON) BulkValidationApi | createJobFromS3 | POST /v1/jobs/upload/s3 | Create job from S3 upload BulkValidationApi | createJobUpload | POST /v1/jobs/upload | Create bulk validation job (file upload) BulkValidationApi | deleteJob | DELETE /v1/jobs/{job_id} | Delete a job BulkValidationApi | getJob | GET /v1/jobs/{job_id} | Get job status BulkValidationApi | getJobResults | GET /v1/jobs/{job_id}/results | Get job results BulkValidationApi | getPresignedUpload | POST /v1/jobs/upload/presigned | Get S3 presigned upload URL BulkValidationApi | listJobs | GET /v1/jobs | List validation jobs EmailValidationApi | validateBatch | POST /v1/validate/batch | Validate multiple emails (sync) EmailValidationApi | validateEmail | POST /v1/validate | Validate single email SuppressionListsApi | addSuppression | POST /v1/suppression | Add suppression entries SuppressionListsApi | checkSuppression | POST /v1/suppression/check | Check suppression status SuppressionListsApi | getSuppressionStats | GET /v1/suppression/stats | Get suppression statistics SuppressionListsApi | listSuppression | GET /v1/suppression | List suppression entries SuppressionListsApi | removeSuppression | DELETE /v1/suppression | Remove suppression entries SystemApi | getTelemetrySummary | GET /v1/telemetry/summary | Get validation telemetry SystemApi | healthCheck | GET /health | Health check ValidationPoliciesApi | addPolicyRule | POST /v1/policies/{policy_id}/rules | Add rule to policy ValidationPoliciesApi | createPolicy | POST /v1/policies | Create policy ValidationPoliciesApi | createPolicyFromPreset | POST /v1/policies/from-preset | Create policy from preset ValidationPoliciesApi | deletePolicy | DELETE /v1/policies/{policy_id} | Delete policy ValidationPoliciesApi | deletePolicyRule | DELETE /v1/policies/{policy_id}/rules/{rule_id} | Delete rule ValidationPoliciesApi | getPolicy | GET /v1/policies/{policy_id} | Get policy ValidationPoliciesApi | getPolicyPresets | GET /v1/policies/presets | Get policy presets ValidationPoliciesApi | listPolicies | GET /v1/policies | List policies ValidationPoliciesApi | testPolicy | POST /v1/policies/test | Test policy evaluation ValidationPoliciesApi | updatePolicy | PUT /v1/policies/{policy_id} | Update policy

Models

• AddPolicyRule201Response
• AddSuppressionRequest
• AddSuppressionRequestEntriesInner
• AddSuppressionResponse
• CheckSuppressionRequest
• CreateJobFromS3Request
• CreateJobRequest
• CreatePolicyFromPresetRequest
• CreatePolicyRequest
• DeleteJob200Response
• DeletePolicy200Response
• DeletePolicyRule200Response
• ErrorResponse
• GetPresignedUploadRequest
• HealthCheck200Response
• Job
• JobListResponse
• JobResponse
• JobSummary
• Pagination
• Policy
• PolicyListResponse
• PolicyListResponseLimits
• PolicyPresetsResponse
• PolicyPresetsResponsePresetsInner
• PolicyResponse
• PolicyRule
• PolicyRuleAction
• PolicyTestResponse
• PresignedUploadResponse
• PresignedUploadResponseUpload
• RemoveSuppression200Response
• RemoveSuppressionRequest
• ResultsResponse
• SuppressionCheckResponse
• SuppressionEntry
• SuppressionListResponse
• SuppressionStatsResponse
• SuppressionStatsResponseByType
• TelemetrySummary
• TelemetrySummaryRates
• TelemetrySummaryTopDomainsInner
• TelemetrySummaryTopReasonsInner
• TelemetrySummaryTotals
• TestPolicyRequest
• TestPolicyRequestTestResult
• UpdatePolicyRequest
• ValidateBatch200Response
• ValidateBatch200ResponseSummary
• ValidateBatchRequest
• ValidateRequest
• ValidationResponse
• ValidationResponsePolicyApplied
• ValidationResponseSuppressionMatch
• ValidationResult

Authorization

Authentication schemes defined for the API:

BearerAuth

• Type: HTTP Bearer Token authentication

About

This TypeScript SDK client supports the Fetch API and is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.0
• Generator version: 7.19.0
• Build package: org.openapitools.codegen.languages.TypeScriptFetchClientCodegen

The generated npm module supports the following:

• Environments
  • Node.js
  • Webpack
  • Browserify
• Language levels
  • ES5 - you must have a Promises/A+ library installed
  • ES6
• Module systems
  • CommonJS
  • ES6 module system

For more information, please visit https://mailodds.com/contact

Development

Building

To build the TypeScript source code, you need to have Node.js and npm installed. After cloning the repository, navigate to the project directory and run:

npm install
npm run build

Publishing

Once you've built the package, you can publish it to npm:

npm publish

License

Proprietary