@teemill/[email protected]

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

• Node.js
• Webpack
• Browserify

Language level

• ES5 - you must have a Promises/A+ library installed
• ES6

Module system

• CommonJS
• ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install @teemill/[email protected] --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

All URIs are relative to https://api.localhost:8080

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- CampaignsApi | cancelCampaign | POST /v1/mail/campaigns/{campaignId}/cancel | Cancel a campaign CampaignsApi | createCampaign | POST /v1/mail/campaigns | Create a new campaign CampaignsApi | getCampaign | GET /v1/mail/campaigns/{campaignId} | Retrieve a campaign for a project CampaignsApi | listCampaigns | GET /v1/mail/campaigns | List project campaigns CampaignsApi | updateCampaign | PATCH /v1/mail/campaigns/{campaignId} | Update a campaign DraftsApi | deleteDraft | DELETE /v1/mail/drafts/{draftId} | Delete a draft DraftsApi | duplicateDraft | POST /v1/mail/drafts/{draftId}/duplicate | Duplicate a draft DraftsApi | getDraft | GET /v1/mail/drafts/{draftId} | Retrieve a draft for a project DraftsApi | listDrafts | GET /v1/mail/drafts | List project drafts LabelsApi | createLabel | POST /v1/mail/labels | Create a new label LabelsApi | deleteLabel | DELETE /v1/mail/labels/{id} | Delete a label LabelsApi | getLabel | GET /v1/mail/labels/{id} | Retrieve a label LabelsApi | listLabels | GET /v1/mail/labels | List project subscriber labels LabelsApi | updateLabel | PATCH /v1/mail/labels/{id} | Update a label MailingListsApi | getMailingList | GET /v1/mail/mailing-lists/{mailingListId} | Retrieve a mailing list for a project MailingListsApi | listMailingLists | GET /v1/mail/mailing-lists | List project mailing lists SegmentsApi | createSegment | POST /v1/mail/segments | Create a new segment SegmentsApi | deleteSegment | DELETE /v1/mail/segments/{segmentId} | Delete a segment SegmentsApi | getSegment | GET /v1/mail/segments/{segmentId} | Retrieve a segment SegmentsApi | listSegments | GET /v1/mail/segments | List project segments SegmentsApi | querySegments | POST /v1/mail/segments/query | Query subscriber segments SegmentsApi | updateSegment | PUT /v1/mail/segments/{segmentId} | Update a segment SubscribersApi | createSubscriber | POST /v1/mail/subscribers | Create a new subscriber SubscribersApi | deleteSubscriber | DELETE /v1/mail/subscribers/{subscriberId} | Delete a subscriber SubscribersApi | getSubscriber | GET /v1/mail/subscribers/{subscriberId} | Retrieve a subscriber SubscribersApi | importSubscribers | POST /v1/mail/subscribers/import | Import subscribers SubscribersApi | listSubscribers | GET /v1/mail/subscribers | List project subscribers SubscribersApi | updateSubscriber | PUT /v1/mail/subscribers/{subscriberId} | Update a subscriber

Documentation For Models

• ApiError
• BooleanOperator
• Campaign
• Condition
• ConditionInput
• ConditionInputValue
• ConditionInputValueOneOfInner
• CreateCampaignRequest
• DateOperator
• Draft
• FormConfiguration
• FormConfiguration1
• Image
• ImportSubscribers202Response
• InputConfiguration
• InputConfiguration1
• InputType
• Label
• LabelCreate
• LabelDataType
• LabelMetadata
• LabelMetadataInput
• LabelOption
• LabelUpdate
• ListCampaigns200Response
• ListDrafts200Response
• ListLabels200Response
• ListMailingLists200Response
• ListSegments200Response
• ListSubscribers200Response
• LogicalOperator
• MailingList
• Metadata
• MetadataMetrics
• NumberOperator
• Operator
• OperatorsConfiguration
• OperatorsConfiguration1
• OptionsConfiguration
• OptionsConfiguration1
• QuerySegments200Response
• QuerySegmentsRequest
• Segment
• SegmentCreate
• SegmentGroup
• SegmentGroupConditionsInner
• SegmentGroupInput
• SegmentGroupInputConditionsInner
• SegmentUpdate
• StringOperator
• Subscriber
• SubscriberCreate
• SubscriberLabel
• SubscriberStatus
• SubscriberUpdate
• UpdateCampaignRequest

Documentation For Authorization

Authentication schemes defined for the API:

api-key

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

session-oauth

• Type: OAuth
• Flow: password
• Authorization URL:
• Scopes: N/A