@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://localhost:8080

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- CustomersApi | createCustomerChatChannel | POST /v1/platform/{platformId}/customers/{customerId}/chat-channel | Create chat channel CustomersApi | createCustomerDataDeletionRequest | POST /v1/platform/{platformId}/customers/{customerId}/data-deletion-request | Create data deletion request CustomersApi | exportCustomers | GET /v1/platform/{platformId}/customers/export | Export customers CustomersApi | getCustomer | GET /v1/platform/{platformId}/customers/{customerId} | Get customer CustomersApi | getCustomerDataDeletionRequest | GET /v1/platform/{platformId}/customers/{customerId}/data-deletion-request | Get data deletion request CustomersApi | listCustomerTags | GET /v1/platform/{platformId}/customers/tags | List customer tags CustomersApi | listCustomers | GET /v1/platform/{platformId}/customers | List customers CustomersApi | updateCustomer | PATCH /v1/platform/{platformId}/customers/{customerId} | Update the customer with the given customer ID DashboardApi | getDashboard | GET /v1/platform/{platformId}/dashboard | Get the platform's dashboard DashboardApi | saveDashboard | PUT /v1/platform/{platformId}/dashboard | Save the platform's dashboard EnquiriesApi | createCustomerEnquiryChatChannel | POST /v1/platform/{platformId}/customers/enquiries/{enquiryId}/chat-channel | Create chat channel EnquiriesApi | getCustomerEnquiry | GET /v1/platform/{platformId}/customers/enquiries/{enquiryId} | Get customer enquiry EnquiriesApi | listCustomerEnquiries | GET /v1/platform/{platformId}/customers/enquiries | List customer enquiries EnquiriesApi | listCustomerEnquiryLogs | GET /v1/platform/{platformId}/customers/enquiries/{enquiryId}/logs | List customer enquiry Logs EnquiriesApi | updateCustomerEnquiry | PATCH /v1/platform/{platformId}/customers/enquiries/{enquiryId} | Update customer enquiry ModerationApi | updateModerationItem | PATCH /v1/platform/moderate/{moderationItemId} | Update a moderation item OrdersApi | amendOrder | PATCH /v1/platform/{platformId}/orders/{orderId}/amend | Amend the contents of an order OrdersApi | confirmOrder | POST /v1/platform/{platformId}/orders/{orderId}/confirm | Confirm order OrdersApi | createOrder | POST /v1/platform/{platformId}/orders | Create order OrdersApi | createOrderChatChannel | POST /v1/platform/{platformId}/orders/{orderId}/chat-channel | Create chat channel OrdersApi | exportOrders | GET /v1/platform/{platformId}/orders/export | Export orders OrdersApi | getFulfillment | GET /v1/platform/{platformId}/fulfillments/{fulfillmentId} | Get fulfillment OrdersApi | getOrder | GET /v1/platform/{platformId}/orders/{orderId} | Get order OrdersApi | getOrderReceipt | GET /v1/platform/{platformId}/orders/{orderId}/receipt | Get order receipt OrdersApi | listAvailableFulfillers | GET /v1/platform/{platformId}/fulfillments/{fulfillmentId}/available-fulfillers | List available fulfillers OrdersApi | listOrders | GET /v1/platform/{platformId}/orders | List orders OrdersApi | retryPlatformPayment | POST /v1/platform/{platformId}/orders/{orderId}/retryPlatformPayment | Retry OrdersApi | returnOrder | PATCH /v1/platform/{platformId}/orders/{orderId}/return | Return the contents of an order for a refund or exchange OrdersApi | sendOrderReceipt | POST /v1/platform/{platformId}/orders/{orderId}/receipt/send | Send order receipt OrdersApi | updateFulfillment | PATCH /v1/platform/{platformId}/fulfillments/{fulfillmentId} | Update fulfillment OrdersApi | updateOrder | PATCH /v1/platform/{platformId}/orders/{orderId} | Update order OrdersApi | updatePlatformFulfillmentStyleApplication | PATCH /v1/platform/{platformId}/styles/{styleId}/applications/{applicationId} | Update platform fulfillment style application PaymentApi | authorizeStripe | GET /v1/platform/payment/stripe/authorize | Authorize Stripe PaymentApi | deauthorizeStripe | DELETE /v1/platform/payment/stripe/deauthorize | Deauthorize Stripe PaymentApi | getStripePaymentAccount | GET /v1/platform/payment/stripe | Get Stripe Payment Account PixelsApi | createPixel | POST /v1/platform/{platformId}/pixels | Create a pixel PixelsApi | deletePixel | DELETE /v1/platform/{platformId}/pixels/{pixelId} | Delete a pixel PixelsApi | getPixel | GET /v1/platform/{platformId}/pixels/{pixelId} | Get pixel PixelsApi | listPixels | GET /v1/platform/{platformId}/pixels | List pixels PixelsApi | updatePixel | PUT /v1/platform/{platformId}/pixels/{pixelId} | Update a pixel PlatformApi | createClientDomain | POST /v1/platform/client/domains | Create a platform client domain PlatformApi | createDomain | POST /v1/platform/domains | Create a platform domain PlatformApi | deleteClientDomain | DELETE /v1/platform/client/domains/{domain} | Delete a platform client domain PlatformApi | deleteDomain | DELETE /v1/platform/domains/{domain} | Delete a platform domain PlatformApi | getPlatform | GET /v1/platform | Get platform details PlatformApi | listClientDomains | GET /v1/platform/client/domains | List platform client domains PlatformApi | listDomains | GET /v1/platform/domains | List platform domains PlatformApi | updatePlatform | PATCH /v1/platform | Update platform ReviewsApi | createReview | POST /v1/platform/{platformId}/reviews | Create a review ReviewsApi | exportReviews | GET /v1/platform/{platformId}/reviews/export | Export reviews ReviewsApi | getReview | GET /v1/platform/{platformId}/reviews/{reviewId} | Get review ReviewsApi | listReviews | GET /v1/platform/{platformId}/reviews | List reviews ReviewsApi | moderateReview | PATCH /v1/platform/{platformId}/reviews/{reviewId}/moderate | Moderate review TermsApi | getTerms | GET /v1/platform/{platformId}/terms | Get the platform's terms TermsApi | saveTerms | POST /v1/platform/{platformId}/terms | Save the platform's terms

Documentation For Models

• Address
• AmendOrderRequest
• AmendOrderRequestAmendmentsInner
• AmendOrderRequestAmendmentsInnerReason
• AmendmentLog
• ApiError
• Application
• AttachedFile
• AuthorizeStripe200Response
• BulkCreateReviewPayload
• BulkCreatedReviews
• Client
• ConfirmOrderFulfillment
• ConfirmOrderFulfillmentShipment
• ConfirmOrderRequest
• ContactInformation
• Coupon
• CreateDomainRequest
• CreateOrder
• CreateOrderChatChannel200Response
• CreateOrderContactInformation
• CreateOrderPaymentMethod
• CreatePixelRequest
• CreatePixelRequestFilters
• CreateReview201Response
• CreateReviewPayload
• CreateReviewPayloadAuthor
• CreateReviewRequest
• Customer
• CustomersResponse
• CustomsInformation
• DashboardItem
• DataDeletionRequest
• DeliveryEstimates
• Domain
• Enquiry
• EnquiryExtraInputsInner
• EnquiryExtraInputsInnerValue
• EnquiryTracking
• ExportOrders202Response
• Fulfiller
• FulfillerLocation
• FulfillersResponse
• Fulfillment
• FulfillmentItem
• GetDashboardResponse
• Image
• ListCustomerEnquiries200Response
• ListCustomerEnquiryLogs200Response
• ListCustomerEnquiryLogs200ResponseLogsInner
• ListCustomerEnquiryLogs200ResponseLogsInnerCustomer
• ListCustomerTags200Response
• ListDomains200Response
• ModerateReviewRequest
• Option
• Order
• OrderItem
• OrderItem1
• OrderItem1RecipientCost
• OrderPaymentMethod
• OrderStatus
• OrderTracking
• OrdersResponse
• Origin
• PaymentAccount
• PaymentAttempt
• Pixel
• PixelsResponse
• Platform
• PlatformLogo
• Price
• PrintArea
• PriorityLevel
• Project
• ReturnOrderRequest
• ReturnOrderRequestReturnsInner
• ReturnOrderRequestReturnsInnerReason
• Review
• ReviewAuthor
• ReviewImagesInner
• ReviewProduct
• ReviewReply
• ReviewReplyAuthor
• ReviewsResponse
• SaveDashboardRequest
• SaveTermsRequest
• ShippingMethod
• Statistics
• StatusHistoryItem
• Terms
• UpdateCustomerEnquiryRequest
• UpdateCustomerRequest
• UpdateFulfillmentRequest
• UpdateModerationItemRequest
• UpdateOrderRequest
• UpdatePlatformFulfillmentStyleApplicationRequest
• UpdatePlatformRequest
• ValidationError
• Variant

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